From 41382aad2f3760b3060f25745a2e6f5aaa576f8d Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Sun, 18 Feb 2024 22:48:20 +0100 Subject: [PATCH 01/14] refactor(wyatt_type_utils)!: upgrade Result to prepare migration to sealed classes --- .../lib/src/either/either_base.dart | 49 ++- .../lib/src/either/option.dart | 4 +- .../lib/src/either/result.dart | 325 ---------------- .../src/extensions/iterable_extension.dart | 3 - .../lib/src/extensions/string_extension.dart | 3 - .../wyatt_type_utils/lib/src/pair/pair.dart | 2 + .../{either => result}/future_or_result.dart | 14 +- .../src/{either => result}/future_result.dart | 12 +- .../lib/src/result/result.dart | 346 ++++++++++++++++++ packages/wyatt_type_utils/lib/src/src.dart | 3 +- packages/wyatt_type_utils/pubspec.yaml | 7 +- .../wyatt_type_utils/test/result_test.dart | 116 +++--- 12 files changed, 452 insertions(+), 432 deletions(-) delete mode 100644 packages/wyatt_type_utils/lib/src/either/result.dart rename packages/wyatt_type_utils/lib/src/{either => result}/future_or_result.dart (96%) rename packages/wyatt_type_utils/lib/src/{either => result}/future_result.dart (96%) create mode 100644 packages/wyatt_type_utils/lib/src/result/result.dart diff --git a/packages/wyatt_type_utils/lib/src/either/either_base.dart b/packages/wyatt_type_utils/lib/src/either/either_base.dart index 2f06414e..aef28c3a 100644 --- a/packages/wyatt_type_utils/lib/src/either/either_base.dart +++ b/packages/wyatt_type_utils/lib/src/either/either_base.dart @@ -1,26 +1,21 @@ -// // Copyright (C) 2022 WYATT GROUP -// // Please see the AUTHORS file for details. -// // -// // This program is free software: you can redistribute it and/or modify -// // it under the terms of the GNU General Public License as published by -// // the Free Software Foundation, either version 3 of the License, or -// // any later version. -// // -// // This program is distributed in the hope that it will be useful, -// // but WITHOUT ANY WARRANTY; without even the implied warranty of -// // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// // GNU General Public License for more details. -// // -// // You should have received a copy of the GNU General Public License -// // along with this program. If not, see . - -// // ignore_for_file: avoid_positional_boolean_parameters +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . import 'dart:async'; -part 'future_result.dart'; -part 'future_or_result.dart'; -part 'result.dart'; part 'option.dart'; mixin _Left on _EitherBase {} @@ -35,7 +30,9 @@ class _EitherBaseException implements Exception { String toString() => '_EitherException: $message'; } +@Deprecated('Use Dart pattern matching instead') abstract class _EitherBase { + @Deprecated('Use Dart pattern matching instead') const _EitherBase(); bool get _isLeft => this is _Left; @@ -56,20 +53,20 @@ abstract class _EitherBase { if (U == LeftType) { return _fold( (value) => value, - (right) => throw const ResultException( + (right) => throw Exception( 'Illegal use. You should check left value before calling', ), ) as U; } if (U == RightType) { return _fold( - (left) => throw const ResultException( + (left) => throw Exception( 'Illegal use. You should check right value before calling', ), (value) => value, ) as U; } - throw ResultException( + throw Exception( 'Illegal use. You should use $LeftType or $RightType type', ); } @@ -78,20 +75,20 @@ abstract class _EitherBase { if (U == LeftType) { return _foldAsync( Future.value, - (right) => throw const ResultException( + (right) => throw Exception( 'Illegal use. You should check left value before calling', ), ) as Future; } if (U == RightType) { return _foldAsync( - (left) => throw const ResultException( + (left) => throw Exception( 'Illegal use. You should check right value before calling', ), Future.value, ) as Future; } - throw ResultException( + throw Exception( 'Illegal use. You should use $LeftType or $RightType type', ); } diff --git a/packages/wyatt_type_utils/lib/src/either/option.dart b/packages/wyatt_type_utils/lib/src/either/option.dart index 3502984f..f5bb8f89 100644 --- a/packages/wyatt_type_utils/lib/src/either/option.dart +++ b/packages/wyatt_type_utils/lib/src/either/option.dart @@ -1,4 +1,4 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. // // This program is free software: you can redistribute it and/or modify @@ -41,8 +41,10 @@ class OptionException extends _EitherBaseException { /// if value not present) and ifPresent() (execute a block of code if the /// value is present). /// {@endtemplate} +@Deprecated('Use Dart pattern matching instead') abstract class Option extends _EitherBase { /// {@macro option} + @Deprecated('Use Dart pattern matching instead') const Option._(); /// Represents the left side of [Option] class. diff --git a/packages/wyatt_type_utils/lib/src/either/result.dart b/packages/wyatt_type_utils/lib/src/either/result.dart deleted file mode 100644 index c4d03189..00000000 --- a/packages/wyatt_type_utils/lib/src/either/result.dart +++ /dev/null @@ -1,325 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -// ignore_for_file: avoid_positional_boolean_parameters - -part of 'either_base.dart'; - -/// {@template result_exception} -/// [ResultException] is sometimes threw by [Result] objects. -/// -/// ```dart -/// throw ResultException('Emergency failure!'); -/// ``` -/// {@endtemplate} -class ResultException extends _EitherBaseException { - /// {@macro result_exception} - const ResultException(super.message); - - @override - String toString() => 'ResultException: $message'; -} - -/// {@template result} -/// [Result] type is coming from functional languages where exceptions are -/// (rightfully) considered a side-effect, and therefore not appropriate to -/// pass domain errors. Mind the difference between different kinds of errors: -/// Some of them belong to domain, others don't. -/// -/// *E.g. null reference exception or index out of bounds -/// are not related to domain - they rather indicate a defect.* -/// -/// Either is defined as a generic type with two branches -/// - success with [T] -/// - failure with [E] -/// -/// It can appear in two forms, where -/// it contains an object of [Ok], or where it contains an object -/// of [Err]. It cannot appear in both states at once, or in none of them. -/// Therefore, if one possesses an [Result] instance, it either contains a -/// successfully produced result, or contains an error object. -/// {@endtemplate} -abstract class Result extends _EitherBase { - /// {@macro result} - const Result._(); - - /// Represents the left side of [Result] class. - bool get isOk => _isLeft; - - /// Represents the right side of [Result] class. - bool get isErr => _isRight; - - /// Get nullable [Ok] value, and discarding the error, if any. - T? get ok => _left; - - /// Get nullable [Err] value, and discarding the success value, if any. - E? get err => _right; - - /// Get [U] value, may throw an exception. - U unwrap() => _unwrap(); - - /// Get **async** [U] value, may throw an exception. - Future unwrapAsync() => _unwrapAsync(); - - /// Fold [Ok] and [Err] into the value of one type - U fold( - U Function(T value) valueTransformer, - U Function(E error) errorTransformer, - ) => - _fold( - (left) => valueTransformer(left), - (right) => errorTransformer(right), - ); - - /// Fold [Ok] and [Err] **asynchronously** into the value of one type - Future foldAsync( - Future Function(T value) valueTransformer, - Future Function(E error) errorTransformer, - ) => - _foldAsync( - (left) => valueTransformer(left), - (right) => errorTransformer(right), - ); - - /// Swap [Ok] and [Err] - Result swap() => fold(Err.new, Ok.new); - - /// Returns [res] if the [Result] is [Ok], otherwise returns - /// the [Err] value of this. - Result and(Result res) => _and(res) as Result; - - /// Returns [res] if the [Result] is [Err], otherwise returns - /// the [Ok] value of this. - Result or(Result res) => _or(res) as Result; - - /// Returns true if the result is an [Ok] or [Err] value containing - /// the given value/error. - bool contains(U x) => _contains(x); - - /// Returns the contained [Ok] value. Throw [ResultException] on [Err] with - /// its content. - T expect(String msg) => _expect(msg); - - /// Returns the contained [Err] value. Throw [ResultException] on [Ok] with - /// its content. - E expectErr(String msg) => _expectErr(msg); - - /// Maps a [Result] to [Result] by applying a function to a - /// contained [Ok] value, leaving an [Err] value untouched. - Result map(U Function(T value) mapper) => - _map(mapper) as Result; - - /// Maps a [Result] to [Result] by applying an **async** function - /// to a contained [Ok] value, leaving an [Err] value untouched. - Future> mapAsync(Future Function(T value) mapper) => - _mapAsync(mapper) as Future>; - - /// Maps a [Result] to [Result] by applying a function to a - /// contained [Err] value, leaving an [Ok] value untouched. - Result mapErr(F Function(E error) mapper) => - _mapErr(mapper) as Result; - - /// Maps a [Result] to [Result] by applying an **async** function - /// to a contained [Err] value, leaving an [Ok] value untouched. - Future> mapErrAsync(Future Function(E error) mapper) => - _mapErrAsync(mapper) as Future>; - - /// Transforms a [Result] to [Result] by applying functions to - /// contained [Ok] and [Err] values. - Result either( - U Function(T value) valueTransformer, - F Function(E error) errorTransformer, - ) => - _either(valueTransformer, errorTransformer) as Result; - - /// Transforms a [Result] to [Result] by applying **async** - /// functions to contained [Ok] and [Err] values. - Future> eitherAsync( - Future Function(T value) valueTransformer, - Future Function(E error) errorTransformer, - ) => - _eitherAsync(valueTransformer, errorTransformer) - as Future>; - - /// Constructs a new [Result] from a function that might throw - static Result tryCatch( - T Function() tryFn, - E Function(Error error) onError, - ) { - try { - return Ok(tryFn()); - } on Error catch (e) { - return Err(onError(e)); - } - } - - /// Constructs a new [Result] from an **async** function that might throw - static Future> tryCatchAsync( - Future Function() tryFn, - E Function(Error error) onError, - ) async { - try { - return Ok(await tryFn()); - } on Error catch (e) { - return Err(onError(e)); - } - } - - /// If the condition is satify then return [value] in - /// [Ok] else [error] in [Err] - static Result conditional( - bool test, - T value, - E error, - ) => - test ? Ok(value) : Err(error); - - /// If the condition is satify then return *command* [value] - /// in [Ok] else [error] in [Err] - static Result conditionalLazy( - bool test, - T Function() value, - E Function() error, - ) => - test ? Ok(value()) : Err(error()); -} - -/// {@template ok} -/// Contains the success value of a [Result] -/// -/// {@macro result} -/// {@endtemplate} -class Ok extends Result with _Left { - /// {@macro ok} - const Ok(this.value) : super._(); - final T value; - - @override - U _fold(U Function(T left) fnL, U Function(E right) fnR) => fnL(value); - - @override - Future _foldAsync( - Future Function(T left) fnL, - Future Function(E right) fnR, - ) => - fnL(value); - - @override - Result _and(_EitherBase res) => res as Result; - - @override - Result _or(_EitherBase res) => this as Result; - - @override - bool _contains(U x) => value == x; - - @override - T _expect(String msg) => value; - - @override - E _expectErr(String msg) => throw ResultException('$msg: $value'); - - @override - Result _map(U Function(T value) mapper) => Ok(mapper(value)); - - @override - Future> _mapAsync(Future Function(T value) mapper) => - mapper(value).then(Ok.new); - - @override - Result _mapErr(F Function(E error) mapper) => Ok(value); - - @override - Future> _mapErrAsync(Future Function(E error) mapper) => - Future.value(Ok(value)); - - @override - Result _either( - U Function(T value) fnL, - F Function(E error) fnR, - ) => - Ok(fnL(value)); - - @override - Future> _eitherAsync( - Future Function(T value) fnL, - Future Function(E error) fnR, - ) => - fnL(value).then(Ok.new); -} - -/// {@template err} -/// Contains the error value of a [Result] -/// -/// {@macro result} -/// {@endtemplate} -class Err extends Result with _Right { - /// {@macro err} - const Err(this.error) : super._(); - final E error; - - @override - U _fold(U Function(T left) fnL, U Function(E right) fnR) => fnR(error); - - @override - Future _foldAsync( - Future Function(T left) fnL, - Future Function(E right) fnR, - ) => - fnR(error); - - @override - Result _and(_EitherBase res) => this as Result; - @override - Result _or(_EitherBase res) => res as Result; - - @override - bool _contains(U x) => error == x; - - @override - T _expect(String msg) => throw ResultException('$msg: $error'); - - @override - E _expectErr(String msg) => error; - - @override - Result _map(U Function(T value) mapper) => Err(error); - - @override - Future> _mapAsync(Future Function(T value) mapper) => - Future.value(Err(error)); - - @override - Result _mapErr(F Function(E error) mapper) => Err(mapper(error)); - - @override - Future> _mapErrAsync(Future Function(E error) mapper) => - mapper(error).then(Err.new); - - @override - Result _either( - U Function(T value) fnL, - F Function(E error) fnR, - ) => - Err(fnR(error)); - - @override - Future> _eitherAsync( - Future Function(T value) fnL, - Future Function(E error) fnR, - ) => - fnR(error).then(Err.new); -} diff --git a/packages/wyatt_type_utils/lib/src/extensions/iterable_extension.dart b/packages/wyatt_type_utils/lib/src/extensions/iterable_extension.dart index 0d04c775..a0849875 100644 --- a/packages/wyatt_type_utils/lib/src/extensions/iterable_extension.dart +++ b/packages/wyatt_type_utils/lib/src/extensions/iterable_extension.dart @@ -37,13 +37,10 @@ extension IterableIntExtension on Iterable? { switch (to) { case Encoding.utf8: str = utf8.decode(this?.toList() ?? []); - break; case Encoding.utf16: str = String.fromCharCodes(this ?? []); - break; case Encoding.base64: str = base64.encode(this?.toList() ?? []); - break; case Encoding.base16: str = List.generate( (this ?? []).length, diff --git a/packages/wyatt_type_utils/lib/src/extensions/string_extension.dart b/packages/wyatt_type_utils/lib/src/extensions/string_extension.dart index db75dd62..9510340c 100644 --- a/packages/wyatt_type_utils/lib/src/extensions/string_extension.dart +++ b/packages/wyatt_type_utils/lib/src/extensions/string_extension.dart @@ -33,13 +33,10 @@ extension StringExtension on String? { switch (from) { case Encoding.utf8: bytes = utf8.encode(this ?? '').toTypedList(); - break; case Encoding.utf16: bytes = (this ?? '').runes.toList().toTypedList(); - break; case Encoding.base64: bytes = base64.decode(this ?? ''); - break; case Encoding.base16: assert( (this ?? '').length.isEven, diff --git a/packages/wyatt_type_utils/lib/src/pair/pair.dart b/packages/wyatt_type_utils/lib/src/pair/pair.dart index 2a2104f9..20af8733 100644 --- a/packages/wyatt_type_utils/lib/src/pair/pair.dart +++ b/packages/wyatt_type_utils/lib/src/pair/pair.dart @@ -21,8 +21,10 @@ extension PairExtension on Pair { /// {@template pair} /// [Pair] is a simple object which contains pair of two values. /// {@endtemplate} +@Deprecated('Use Dart built-in record type instead') class Pair { /// {@macro pair} + @Deprecated('Use Dart built-in record type instead') const Pair(this.left, this.right); final L? left; final R? right; diff --git a/packages/wyatt_type_utils/lib/src/either/future_or_result.dart b/packages/wyatt_type_utils/lib/src/result/future_or_result.dart similarity index 96% rename from packages/wyatt_type_utils/lib/src/either/future_or_result.dart rename to packages/wyatt_type_utils/lib/src/result/future_or_result.dart index 8cf0e652..971a7f78 100644 --- a/packages/wyatt_type_utils/lib/src/either/future_or_result.dart +++ b/packages/wyatt_type_utils/lib/src/result/future_or_result.dart @@ -1,4 +1,4 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. // // This program is free software: you can redistribute it and/or modify @@ -14,7 +14,9 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -part of 'either_base.dart'; +import 'dart:async'; + +import 'package:wyatt_type_utils/src/result/result.dart'; extension FutureOrResultExtension on FutureOr> { /// Represents the left side of [Result] class. @@ -72,13 +74,13 @@ extension FutureOrResultExtension on FutureOr> { Future contains(U x) => Future.value(this).then((result) => result.contains(x)); - /// Returns the contained [Ok] value. Throw [ResultException] on [Err] with - /// its content. + /// Returns the contained [Ok] value. Throw [ResultException] on + /// [Err] with its content. Future expect(String msg) => Future.value(this).then((result) => result.expect(msg)); - /// Returns the contained [Err] value. Throw [ResultException] on [Ok] with - /// its content. + /// Returns the contained [Err] value. Throw [ResultException] on + /// [Ok] with its content. Future expectErr(String msg) => Future.value(this).then((result) => result.expectErr(msg)); diff --git a/packages/wyatt_type_utils/lib/src/either/future_result.dart b/packages/wyatt_type_utils/lib/src/result/future_result.dart similarity index 96% rename from packages/wyatt_type_utils/lib/src/either/future_result.dart rename to packages/wyatt_type_utils/lib/src/result/future_result.dart index 9460b2b4..6358e70a 100644 --- a/packages/wyatt_type_utils/lib/src/either/future_result.dart +++ b/packages/wyatt_type_utils/lib/src/result/future_result.dart @@ -1,4 +1,4 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. // // This program is free software: you can redistribute it and/or modify @@ -14,7 +14,7 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -part of 'either_base.dart'; +import 'package:wyatt_type_utils/src/result/result.dart'; extension FutureResultExtension on Future> { /// Represents the left side of [Result] class. @@ -62,12 +62,12 @@ extension FutureResultExtension on Future> { /// the given value/error. Future contains(U x) => then((result) => result.contains(x)); - /// Returns the contained [Ok] value. Throw [ResultException] on [Err] with - /// its content. + /// Returns the contained [Ok] value. Throw [ResultException] on + /// [Err] with its content. Future expect(String msg) => then((result) => result.expect(msg)); - /// Returns the contained [Err] value. Throw [ResultException] on [Ok] with - /// its content. + /// Returns the contained [Err] value. Throw [ResultException] on + /// [Ok] with its content. Future expectErr(String msg) => then((result) => result.expectErr(msg)); /// Maps a [Result] to [Result] by applying a function to a diff --git a/packages/wyatt_type_utils/lib/src/result/result.dart b/packages/wyatt_type_utils/lib/src/result/result.dart new file mode 100644 index 00000000..918562ef --- /dev/null +++ b/packages/wyatt_type_utils/lib/src/result/result.dart @@ -0,0 +1,346 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +// ignore_for_file: avoid_equals_and_hash_code_on_mutable_classes + +import 'package:sealed_result/sealed_result.dart' as sealed; + +export 'future_or_result.dart'; +export 'future_result.dart'; + +class ResultException extends sealed.ResultException { + const ResultException(String super.message); +} + +/// {@template result} +/// [Result] type is coming from functional languages where exceptions are +/// (rightfully) considered a side-effect, and therefore not appropriate to +/// pass domain errors. Mind the difference between different kinds of errors: +/// Some of them belong to domain, others don't. +/// +/// *E.g. null reference exception or index out of bounds +/// are not related to domain - they rather indicate a defect.* +/// +/// Either is defined as a generic type with two branches +/// - success with [Success] +/// - failure with [Failure] +/// +/// It can appear in two forms, where +/// it contains an object of [Ok], or where it contains an object +/// of [Err]. It cannot appear in both states at once, or in none of them. +/// Therefore, if one possesses an [Result] instance, it either contains a +/// successfully produced result, or contains an error object. +/// {@endtemplate} +class Result { + /// {@macro result} + const Result._(this._result); + + factory Result.ok(Success value) => Ok(value); + factory Result.err(Failure value) => Err(value); + factory Result.error(Failure value) => Err(value); + factory Result.success(Success value) => Ok(value); + factory Result.failure(Failure value) => Err(value); + + final sealed.Result _result; + + /// Represents the left side of [Result] class. + bool get isOk => _result.isOk; + + /// Represents the right side of [Result] class. + bool get isErr => _result.isErr; + + /// Get nullable [Ok] value, and discarding the error, if any. + Success? get ok => _result.ok; + + /// Get nullable [Err] value, and discarding the success value, if any. + Failure? get err => _result.err; + + /// Get [U] value, may throw an exception. + U unwrap() { + if (U == Success) { + return fold( + (value) => value, + (right) => throw const ResultException( + 'Illegal use. You should check left value before calling', + ), + ) as U; + } + if (U == Failure) { + return fold( + (left) => throw const ResultException( + 'Illegal use. You should check right value before calling', + ), + (value) => value, + ) as U; + } + throw ResultException( + 'Illegal use. You should use $Success or $Failure type', + ); + } + + /// Get **async** [U] value, may throw an exception. + Future unwrapAsync() { + if (U == Success) { + return foldAsync( + Future.value, + (right) => throw const ResultException( + 'Illegal use. You should check left value before calling', + ), + ) as Future; + } + if (U == Failure) { + return foldAsync( + (left) => throw const ResultException( + 'Illegal use. You should check right value before calling', + ), + Future.value, + ) as Future; + } + throw ResultException( + 'Illegal use. You should use $Success or $Failure type', + ); + } + + /// Fold [Ok] and [Err] into the value of one type + U fold( + U Function(Success value) valueTransformer, + U Function(Failure error) errorTransformer, + ) => + _result.fold( + (ok) => valueTransformer(ok), + (err) => errorTransformer(err), + ); + + /// Fold [Ok] and [Err] **asynchronously** into the value of one type + Future foldAsync( + Future Function(Success value) valueTransformer, + Future Function(Failure error) errorTransformer, + ) => + _result.foldAsync( + (ok) => valueTransformer(ok), + (err) => errorTransformer(err), + ); + + /// Swap [Ok] and [Err] + Result swap() => fold( + Err.new, + Ok.new, + ); + + /// Returns [res] if the [Result] is [Ok], otherwise returns + /// the [Err] value of this. + Result and(Result res) => Result._( + _result.and(res._result), + ); + + /// Returns [res] if the [Result] is [Err], otherwise returns + /// the [Ok] value of this. + Result or(Result res) => Result._( + _result.or(res._result), + ); + + /// Returns true if the result is an [Ok] or [Err] value containing + /// the given value/error. + bool contains(U x) { + if (x is Success) { + return _result.contains(x); + } else if (x is Failure) { + return _result.containsErr(x); + } else { + throw ArgumentError('The value must be of type Success or Failure'); + } + } + + /// Returns the contained [Ok] value. Throw [ResultException] on [Err] + /// with its content. + Success expect(String msg) { + try { + return _result.expect(msg); + } on sealed.ResultException catch (e) { + throw ResultException(e.message.toString()); + } + } + + /// Returns the contained [Err] value. Throw [ResultException] on [Ok] + /// with its content. + Failure expectErr(String msg) { + try { + return _result.expectErr(msg); + } on sealed.ResultException catch (e) { + throw ResultException(e.message.toString()); + } + } + + /// Maps a [Result] to [Result] by applying a + /// function to a contained [Ok] value, leaving an [Err] value untouched. + Result map(U Function(Success value) mapper) => + Result._(_result.map(mapper)); + + /// Maps a [Result] to [Result] by applying + /// an **async** function to a contained [Ok] value, leaving an [Err] + /// value untouched. + Future> mapAsync( + Future Function(Success value) mapper, + ) async { + final result = await _result.mapAsync(mapper); + return Result._(result); + } + + /// Maps a [Result] to [Result] by applying a + /// function to a contained [Err] value, leaving an [Ok] value untouched. + Result mapErr(F Function(Failure error) mapper) => + Result._(_result.mapErr(mapper)); + + /// Maps a [Result] to [Result] by applying + /// an **async** function to a contained [Err] value, leaving an [Ok] + /// value untouched. + Future> mapErrAsync( + Future Function(Failure error) mapper, + ) async { + final result = await _result.mapErrAsync(mapper); + return Result._(result); + } + + /// Transforms a [Result] to [Result] by applying + /// functions to contained [Ok] and [Err] values. + Result either( + U Function(Success value) valueTransformer, + F Function(Failure error) errorTransformer, + ) => + Result._( + _result + .map( + valueTransformer, + ) + .mapErr( + errorTransformer, + ), + ); + + /// Transforms a [Result] to [Result] by + /// applying **async** functions to contained [Ok] and [Err] values. + Future> eitherAsync( + Future Function(Success value) valueTransformer, + Future Function(Failure error) errorTransformer, + ) => + _result + .mapAsync( + valueTransformer, + ) + .mapErrAsync( + errorTransformer, + ) + .then(Result._); + + /// Constructs a new [Result] from a function that might throw + static Result + tryCatch( + Success Function() tryFn, + Failure Function(Error error) onError, + ) { + try { + return Ok(tryFn()); + } on Error catch (e) { + return Err(onError(e)); + } + } + + /// Constructs a new [Result] from an **async** function that might throw + static Future> + tryCatchAsync( + Future Function() tryFn, + Failure Function(Error error) onError, + ) async { + try { + return Ok(await tryFn()); + } on Error catch (e) { + return Err(onError(e)); + } + } + + /// If the condition is satify then return [value] in + /// [Ok] else [error] in [Err] + static Result conditional( + Success value, + Failure error, { + required bool test, + }) => + test ? Ok(value) : Err(error); + + /// If the condition is satify then return *command* [value] + /// in [Ok] else [error] in [Err] + static Result conditionalLazy( + Success Function() value, + Failure Function() error, + bool Function() predicate, + ) => + predicate.call() ? Ok(value()) : Err(error()); + + @override + int get hashCode => _result.hashCode; + + @override + bool operator ==(Object other) { + if (identical(this, other)) { + return true; + } + return other is Result && other._result == _result; + } +} + +final class Ok extends Result { + Ok(this.ok) : super._(sealed.Ok(ok)); + + @override + final Success ok; + + @override + bool get isErr => false; + + @override + bool get isOk => true; + + @override + Failure? get err => null; + + @override + String toString() => switch (ok) { + null => 'Ok(null)', + Future() => 'Ok(${ok.runtimeType})', + _ => 'Ok($ok)', + }; +} + +final class Err extends Result { + Err(this.err) : super._(sealed.Err(err)); + + @override + final Failure err; + + @override + bool get isErr => true; + + @override + bool get isOk => false; + + @override + Success? get ok => null; + + @override + String toString() => switch (err) { + _ => 'Err($err)', + }; +} diff --git a/packages/wyatt_type_utils/lib/src/src.dart b/packages/wyatt_type_utils/lib/src/src.dart index c1d65c3c..61d12cb8 100644 --- a/packages/wyatt_type_utils/lib/src/src.dart +++ b/packages/wyatt_type_utils/lib/src/src.dart @@ -1,4 +1,4 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. // // This program is free software: you can redistribute it and/or modify @@ -17,3 +17,4 @@ export 'either/either_base.dart'; export 'extensions/extensions.dart'; export 'pair/pair.dart'; +export 'result/result.dart'; diff --git a/packages/wyatt_type_utils/pubspec.yaml b/packages/wyatt_type_utils/pubspec.yaml index 1c818afb..57e126a1 100644 --- a/packages/wyatt_type_utils/pubspec.yaml +++ b/packages/wyatt_type_utils/pubspec.yaml @@ -6,11 +6,14 @@ version: 0.0.5 publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub environment: - sdk: ">=2.17.0 <3.0.0" + sdk: "^3.0.0" + +dependencies: + sealed_result: ^3.0.0 dev_dependencies: test: ^1.22.0 wyatt_analysis: hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub - version: ^2.5.0 + version: ^2.6.1 diff --git a/packages/wyatt_type_utils/test/result_test.dart b/packages/wyatt_type_utils/test/result_test.dart index 53706fd5..bf7be242 100644 --- a/packages/wyatt_type_utils/test/result_test.dart +++ b/packages/wyatt_type_utils/test/result_test.dart @@ -21,85 +21,83 @@ void main() { group('Result', () { test('`isOk` returns true on Ok value', () { expect( - const Ok(null).isOk, + Ok(null).isOk, true, ); expect( - const Err(null).isOk, + Err(null).isOk, false, ); }); test('`isErr` returns true on Err value', () { expect( - const Ok(null).isErr, + Ok(null).isErr, false, ); expect( - const Err(null).isErr, + Err(null).isErr, true, ); }); test('`ok` returns value on Ok value', () { - const Result x = Ok(2); + final Result x = Ok(2); expect(x.ok, 2); expect(x.err, null); }); test('`err` returns error on Err value', () { - const Result x = Err('error'); + final Result x = Err('error'); expect(x.ok, null); expect(x.err, 'error'); }); test('unwrap() returns value on Ok value', () { - const Result x = Ok(2); + final Result x = Ok(2); expect(x.unwrap(), 2); expect(() => x.unwrap(), throwsA(isException)); }); test('unwrap() returns error on Err value', () { - const Result x = Err('error'); + final Result x = Err('error'); expect(x.unwrap(), 'error'); expect(() => x.unwrap(), throwsA(isException)); }); test('unwrapAsync() returns value on Ok value', () async { - const Result x = Ok(2); + final Result x = Ok(2); expect(await x.unwrapAsync(), 2); expect(() async => x.unwrapAsync(), throwsA(isException)); }); test('unwrapAsync() returns error on Err value', () async { - const Result x = Err('error'); + final Result x = Err('error'); expect(await x.unwrapAsync(), 'error'); expect(() async => x.unwrapAsync(), throwsA(isException)); }); test('fold() returns right value', () { expect( - const Ok('') - .fold((left) => true, (right) => false), + Ok('').fold((left) => true, (right) => false), true, ); expect( - const Err('') - .fold((left) => true, (right) => false), + Err('').fold((left) => true, (right) => false), false, ); }); test('foldAsync() returns right value', () async { expect( - await const Ok('').foldAsync( + await Ok('').foldAsync( (left) => Future.value(true), (right) => Future.value(false), ), true, ); expect( - await const Err('').foldAsync( + await Err('').foldAsync( (left) => Future.value(true), (right) => Future.value(false), ), @@ -108,7 +106,7 @@ void main() { }); test('swap() swaps values', () { - const Result x = Ok(10); + final Result x = Ok(10); expect(x.isOk, true); expect(x.isErr, false); expect(x.ok, 10); @@ -122,24 +120,24 @@ void main() { 'and() returns res if the result is `Ok`, otherwise ' 'returns the `Err` value of this.', () { - const Result x1 = Ok(2); - const Result y1 = Err('late error'); + final Result x1 = Ok(2); + final Result y1 = Err('late error'); expect(x1.and(y1), y1); - const Result x2 = Err('early error'); - const Result y2 = Ok('foo'); + final Result x2 = Err('early error'); + final Result y2 = Ok('foo'); expect(x2.and(y2), x2); - const Result x3 = Err('not a 2'); - const Result y3 = Err('late error'); + final Result x3 = Err('not a 2'); + final Result y3 = Err('late error'); expect(x3.and(y3), x3); - const Result x4 = Ok(2); - const Result y4 = Ok('different result type'); + final Result x4 = Ok(2); + final Result y4 = Ok('different result type'); expect(x4.and(y4), y4); - const Result x5 = Ok(2); - const Result y5 = Ok(5); + final Result x5 = Ok(2); + final Result y5 = Ok(5); expect(x5.and(y5), y5); }, ); @@ -148,24 +146,24 @@ void main() { 'or() returns res if the result is `Err`, otherwise ' 'returns the `Ok` value of this.', () { - const Result x1 = Ok(2); - const Result y1 = Err('late error'); + final Result x1 = Ok(2); + final Result y1 = Err('late error'); expect(x1.or(y1), x1); - const Result x2 = Err('early error'); - const Result y2 = Ok('foo'); + final Result x2 = Err('early error'); + final Result y2 = Ok('foo'); expect(x2.or(y2), y2); - const Result x3 = Err('not a 2'); - const Result y3 = Err('late error'); + final Result x3 = Err('not a 2'); + final Result y3 = Err('late error'); expect(x3.or(y3), y3); - const Result x4 = Ok(2); - const Result y4 = Ok('different result type'); + final Result x4 = Ok(2); + final Result y4 = Ok('different result type'); expect(x4.or(y4), x4); - const Result x5 = Ok(2); - const Result y5 = Ok(5); + final Result x5 = Ok(2); + final Result y5 = Ok(5); expect(x5.or(y5), x5); }, ); @@ -174,10 +172,10 @@ void main() { 'contains() returns true if the result is an Ok value ' 'containing the given value.', () { - const Result x1 = Ok(2); + final Result x1 = Ok(2); expect(x1.contains(2), true); expect(x1.contains(3), false); - const Result x2 = Err('Some error message'); + final Result x2 = Err('Some error message'); expect(x2.contains(2), false); }, ); @@ -186,10 +184,10 @@ void main() { 'expect() return value if the result is an Ok value ' 'else throw Exception', () { - const Result x1 = Ok(2); + final Result x1 = Ok(2); expect(x1.expect('Testing expect'), 2); - const Result x2 = Err('emergency failure'); + final Result x2 = Err('emergency failure'); expect( () => x2.expect('Testing expect'), throwsA( @@ -205,10 +203,10 @@ void main() { 'expectErr() return value if the result is an Err value ' 'else throw Exception', () { - const Result x1 = Err(2); + final Result x1 = Err(2); expect(x1.expectErr('Testing expect err'), 2); - const Result x2 = Ok('success value'); + final Result x2 = Ok('success value'); expect( () => x2.expectErr('Testing expect err'), throwsA( @@ -223,12 +221,12 @@ void main() { test( 'map() transforms Ok value.', () { - const Result x1 = Ok(true); + final Result x1 = Ok(true); expect(x1.ok, true); expect(x1.map((value) => false).ok, false); - const Result x2 = Err('oops'); + final Result x2 = Err('oops'); expect(x2.map((value) => false).isErr, true); }, @@ -237,11 +235,11 @@ void main() { test( 'mapErr() transforms Err value.', () { - const Result x1 = Ok(true); + final Result x1 = Ok(true); expect(x1.mapErr((value) => false).isOk, true); - const Result x2 = Err('oops'); + final Result x2 = Err('oops'); expect(x2.err, 'oops'); expect(x2.mapErr((error) => 'failure').err, 'failure'); @@ -251,12 +249,12 @@ void main() { test( 'mapAsync() transforms Ok value.', () async { - const Result x1 = Ok(true); + final Result x1 = Ok(true); expect(x1.ok, true); expect((await x1.mapAsync((value) => Future.value(false))).ok, false); - const Result x2 = Err('oops'); + final Result x2 = Err('oops'); expect((await x2.mapAsync((value) => Future.value(false))).isErr, true); }, @@ -265,14 +263,14 @@ void main() { test( 'mapErrAsync() transforms Err value.', () async { - const Result x1 = Ok(true); + final Result x1 = Ok(true); expect( (await x1.mapErrAsync((value) => Future.value(false))).isOk, true, ); - const Result x2 = Err('oops'); + final Result x2 = Err('oops'); expect(x2.err, 'oops'); expect( @@ -285,14 +283,14 @@ void main() { test( 'either() transforms values.', () { - const Result x1 = Ok(true); + final Result x1 = Ok(true); final Result y1 = x1.either((value) => 1, (error) => 'error'); expect(y1.isOk, true); expect(y1.ok, 1); - const Result x2 = Err(true); + final Result x2 = Err(true); final Result y2 = x2.either((value) => 1, (error) => 'error'); @@ -304,7 +302,7 @@ void main() { test( 'eitherAsync() transforms values.', () async { - const Result x1 = Ok(true); + final Result x1 = Ok(true); final Result y1 = await x1.eitherAsync( (value) => Future.value(1), (error) => Future.value('error'), @@ -313,7 +311,7 @@ void main() { expect(y1.isOk, true); expect(y1.ok, 1); - const Result x2 = Err(true); + final Result x2 = Err(true); final Result y2 = await x2.eitherAsync( (value) => Future.value(1), (error) => Future.value('error'), @@ -370,9 +368,9 @@ void main() { 'conditional() returns Result on true test', () { final Result x1 = Result.conditional( - false, 2, 'error', + test: false, ); expect( x1.isErr, @@ -382,9 +380,9 @@ void main() { expect(x1.err, 'error'); final Result x2 = Result.conditional( - true, 2, 'error', + test: true, ); expect( x2.isOk, @@ -399,9 +397,9 @@ void main() { 'conditionalLazy() returns Result on true test', () { final Result x1 = Result.conditionalLazy( - false, () => 2, () => 'error', + () => false, ); expect( x1.isErr, @@ -411,9 +409,9 @@ void main() { expect(x1.err, 'error'); final Result x2 = Result.conditionalLazy( - true, () => 2, () => 'error', + () => true, ); expect( x2.isOk, -- 2.47.2 From 59bca9045e98f930ce90eade6995f28a491a99a9 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Sun, 18 Feb 2024 22:49:11 +0100 Subject: [PATCH 02/14] refactor(wyatt_architecture): upgrade usecases to add NoParams --- .../repositories/photo_repository_impl.dart | 4 +- .../local/favorite_local_data_source.dart | 2 +- .../remote/album_remote_data_source.dart | 2 +- .../remote/photo_remote_data_source.dart | 2 +- .../photos/add_photo_to_favorites.dart | 15 +- .../check_if_photo_is_in_favorites.dart | 15 +- .../usecases/photos/display_favorites.dart | 6 +- .../domain/usecases/photos/display_photo.dart | 15 +- .../domain/usecases/photos/open_album.dart | 15 +- .../photos/remove_photo_from_favorites.dart | 15 +- .../usecases/photos/retrieve_all_albums.dart | 15 +- .../wyatt_architecture/lib/src/core/core.dart | 2 + .../lib/src/core/exceptions/exceptions.dart | 4 +- .../extensions/object_extension.dart} | 12 +- .../usecases => core/mixins}/observers.dart | 34 ++-- .../base_data_source.dart | 2 +- .../{repositories => }/base_repository.dart | 0 .../local/base_local_data_source.dart | 26 --- .../src/domain/data_sources/local/local.dart | 17 -- .../remote/base_remote_data_source.dart | 26 --- .../domain/data_sources/remote/remote.dart | 17 -- .../lib/src/domain/domain.dart | 15 +- .../lib/src/domain/entities/entities.dart | 17 -- .../lib/src/domain/{entities => }/entity.dart | 0 .../src/domain/repositories/repositories.dart | 17 -- .../lib/src/domain/usecase.dart | 153 ++++++++++++++++++ .../lib/src/domain/usecases/no_param.dart | 26 --- .../lib/src/domain/usecases/usecase.dart | 100 ------------ .../lib/src/domain/usecases/usecases.dart | 19 --- packages/wyatt_architecture/lib/src/src.dart | 1 + packages/wyatt_architecture/pubspec.yaml | 11 +- 31 files changed, 220 insertions(+), 385 deletions(-) rename packages/wyatt_architecture/lib/src/{domain/data_sources/data_sources.dart => core/extensions/object_extension.dart} (71%) rename packages/wyatt_architecture/lib/src/{domain/usecases => core/mixins}/observers.dart (51%) rename packages/wyatt_architecture/lib/src/{domain/data_sources => data}/base_data_source.dart (96%) rename packages/wyatt_architecture/lib/src/domain/{repositories => }/base_repository.dart (100%) delete mode 100644 packages/wyatt_architecture/lib/src/domain/data_sources/local/base_local_data_source.dart delete mode 100644 packages/wyatt_architecture/lib/src/domain/data_sources/local/local.dart delete mode 100644 packages/wyatt_architecture/lib/src/domain/data_sources/remote/base_remote_data_source.dart delete mode 100644 packages/wyatt_architecture/lib/src/domain/data_sources/remote/remote.dart delete mode 100644 packages/wyatt_architecture/lib/src/domain/entities/entities.dart rename packages/wyatt_architecture/lib/src/domain/{entities => }/entity.dart (100%) delete mode 100644 packages/wyatt_architecture/lib/src/domain/repositories/repositories.dart create mode 100644 packages/wyatt_architecture/lib/src/domain/usecase.dart delete mode 100644 packages/wyatt_architecture/lib/src/domain/usecases/no_param.dart delete mode 100644 packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart delete mode 100644 packages/wyatt_architecture/lib/src/domain/usecases/usecases.dart diff --git a/packages/wyatt_architecture/example/lib/data/repositories/photo_repository_impl.dart b/packages/wyatt_architecture/example/lib/data/repositories/photo_repository_impl.dart index 274502f1..1ab0279b 100644 --- a/packages/wyatt_architecture/example/lib/data/repositories/photo_repository_impl.dart +++ b/packages/wyatt_architecture/example/lib/data/repositories/photo_repository_impl.dart @@ -88,8 +88,8 @@ class PhotoRepositoryImpl extends PhotoRepository { } return Ok(response); } catch (_) { - return const Err( - ClientException('Cannot retrieve all photos from favorites.'), + return Err( + const ClientException('Cannot retrieve all photos from favorites.'), ); } } diff --git a/packages/wyatt_architecture/example/lib/domain/data_sources/local/favorite_local_data_source.dart b/packages/wyatt_architecture/example/lib/domain/data_sources/local/favorite_local_data_source.dart index 587a99ee..eddb1e4d 100644 --- a/packages/wyatt_architecture/example/lib/domain/data_sources/local/favorite_local_data_source.dart +++ b/packages/wyatt_architecture/example/lib/domain/data_sources/local/favorite_local_data_source.dart @@ -17,7 +17,7 @@ import 'package:architecture_example/domain/entities/photo.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; -abstract class FavoriteLocalDataSource extends BaseLocalDataSource { +abstract class FavoriteLocalDataSource extends BaseDataSource { Future addPhotoToFavorites(Photo photo); Future deletePhotoFromFavorites(int id); Future> getAllPhotosFromFavorites(); diff --git a/packages/wyatt_architecture/example/lib/domain/data_sources/remote/album_remote_data_source.dart b/packages/wyatt_architecture/example/lib/domain/data_sources/remote/album_remote_data_source.dart index fbef7f9a..a886c6ab 100644 --- a/packages/wyatt_architecture/example/lib/domain/data_sources/remote/album_remote_data_source.dart +++ b/packages/wyatt_architecture/example/lib/domain/data_sources/remote/album_remote_data_source.dart @@ -17,7 +17,7 @@ import 'package:architecture_example/domain/entities/album.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; -abstract class AlbumRemoteDataSource extends BaseRemoteDataSource { +abstract class AlbumRemoteDataSource extends BaseDataSource { Future getAlbum(int id); Future> getAllAlbums({int? start, int? limit}); } diff --git a/packages/wyatt_architecture/example/lib/domain/data_sources/remote/photo_remote_data_source.dart b/packages/wyatt_architecture/example/lib/domain/data_sources/remote/photo_remote_data_source.dart index 81d03a9a..2f5d3a5c 100644 --- a/packages/wyatt_architecture/example/lib/domain/data_sources/remote/photo_remote_data_source.dart +++ b/packages/wyatt_architecture/example/lib/domain/data_sources/remote/photo_remote_data_source.dart @@ -17,7 +17,7 @@ import 'package:architecture_example/domain/entities/photo.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; -abstract class PhotoRemoteDataSource extends BaseRemoteDataSource { +abstract class PhotoRemoteDataSource extends BaseDataSource { Future getPhoto(int id); Future> getAllPhotos({int? start, int? limit}); Future> getPhotosFromAlbum(int albumId, {int? start, int? limit}); diff --git a/packages/wyatt_architecture/example/lib/domain/usecases/photos/add_photo_to_favorites.dart b/packages/wyatt_architecture/example/lib/domain/usecases/photos/add_photo_to_favorites.dart index ef8a0ec9..7a65835b 100644 --- a/packages/wyatt_architecture/example/lib/domain/usecases/photos/add_photo_to_favorites.dart +++ b/packages/wyatt_architecture/example/lib/domain/usecases/photos/add_photo_to_favorites.dart @@ -14,26 +14,17 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'dart:async'; - import 'package:architecture_example/domain/entities/photo.dart'; import 'package:architecture_example/domain/repositories/photo_repository.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; class AddPhotoToFavorites extends AsyncUseCase> { - AddPhotoToFavorites(this._photoRepository); + const AddPhotoToFavorites(this._photoRepository); final PhotoRepository _photoRepository; @override - FutureOrResult> execute(Photo? params) async { - await _photoRepository.addPhotoToFavorites(params!); + FutureOrResult> execute(Photo params) async { + await _photoRepository.addPhotoToFavorites(params); return _photoRepository.getAllPhotosFromFavorites(); } - - @override - FutureOr onStart(Photo? params) { - if (params == null) { - throw const ClientException('Photo cannot be null'); - } - } } diff --git a/packages/wyatt_architecture/example/lib/domain/usecases/photos/check_if_photo_is_in_favorites.dart b/packages/wyatt_architecture/example/lib/domain/usecases/photos/check_if_photo_is_in_favorites.dart index f0dcfa5c..a9c082df 100644 --- a/packages/wyatt_architecture/example/lib/domain/usecases/photos/check_if_photo_is_in_favorites.dart +++ b/packages/wyatt_architecture/example/lib/domain/usecases/photos/check_if_photo_is_in_favorites.dart @@ -14,23 +14,14 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'dart:async'; - import 'package:architecture_example/domain/repositories/photo_repository.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; class CheckIfPhotoIsInFavorites extends AsyncUseCase { - CheckIfPhotoIsInFavorites(this._photoRepository); + const CheckIfPhotoIsInFavorites(this._photoRepository); final PhotoRepository _photoRepository; @override - FutureOrResult execute(int? params) async => - _photoRepository.checkIfPhotoIsInFavorites(params!); - - @override - FutureOr onStart(int? params) { - if (params == null) { - throw const ClientException('id cannot be null'); - } - } + FutureOrResult execute(int params) async => + _photoRepository.checkIfPhotoIsInFavorites(params); } diff --git a/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_favorites.dart b/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_favorites.dart index 8bdf027f..61296d12 100644 --- a/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_favorites.dart +++ b/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_favorites.dart @@ -18,12 +18,12 @@ import 'package:architecture_example/domain/entities/photo.dart'; import 'package:architecture_example/domain/repositories/photo_repository.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; -class DisplayFavorites extends AsyncUseCase> { - DisplayFavorites(this._photoRepository); +class DisplayFavorites extends NoParamsAsyncUseCase> { + const DisplayFavorites(this._photoRepository); final PhotoRepository _photoRepository; @override - FutureOrResult> execute(void params) { + FutureOrResult> execute() { final photos = _photoRepository.getAllPhotosFromFavorites(); return photos; } diff --git a/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_photo.dart b/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_photo.dart index 79a06b8a..94697367 100644 --- a/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_photo.dart +++ b/packages/wyatt_architecture/example/lib/domain/usecases/photos/display_photo.dart @@ -14,26 +14,17 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'dart:async'; - import 'package:architecture_example/domain/entities/photo.dart'; import 'package:architecture_example/domain/repositories/photo_repository.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; class DisplayPhoto extends AsyncUseCase { - DisplayPhoto(this._photoRepository); + const DisplayPhoto(this._photoRepository); final PhotoRepository _photoRepository; @override - FutureOrResult execute(int? params) { - final photo = _photoRepository.getPhoto(params!); + FutureOrResult execute(int params) { + final photo = _photoRepository.getPhoto(params); return photo; } - - @override - FutureOr onStart(int? params) { - if (params == null) { - throw const ClientException('id cannot be null'); - } - } } diff --git a/packages/wyatt_architecture/example/lib/domain/usecases/photos/open_album.dart b/packages/wyatt_architecture/example/lib/domain/usecases/photos/open_album.dart index 358e86a2..49ad971a 100644 --- a/packages/wyatt_architecture/example/lib/domain/usecases/photos/open_album.dart +++ b/packages/wyatt_architecture/example/lib/domain/usecases/photos/open_album.dart @@ -14,32 +14,23 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'dart:async'; - import 'package:architecture_example/domain/entities/photo.dart'; import 'package:architecture_example/domain/repositories/photo_repository.dart'; import 'package:architecture_example/domain/usecases/photos/params/query_parameters.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; class OpenAlbum extends AsyncUseCase> { - OpenAlbum(this._photoRepository); + const OpenAlbum(this._photoRepository); final PhotoRepository _photoRepository; @override - FutureOrResult> execute(QueryParameters? params) { + FutureOrResult> execute(QueryParameters params) { final photos = _photoRepository.getPhotosFromAlbum( - params!.albumId, + params.albumId, start: params.start, limit: params.limit, ); return photos; } - - @override - FutureOr onStart(QueryParameters? params) { - if (params == null) { - throw const ClientException('params cannot be null'); - } - } } diff --git a/packages/wyatt_architecture/example/lib/domain/usecases/photos/remove_photo_from_favorites.dart b/packages/wyatt_architecture/example/lib/domain/usecases/photos/remove_photo_from_favorites.dart index e73206b3..99ce521a 100644 --- a/packages/wyatt_architecture/example/lib/domain/usecases/photos/remove_photo_from_favorites.dart +++ b/packages/wyatt_architecture/example/lib/domain/usecases/photos/remove_photo_from_favorites.dart @@ -14,26 +14,17 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'dart:async'; - import 'package:architecture_example/domain/entities/photo.dart'; import 'package:architecture_example/domain/repositories/photo_repository.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; class RemovePhotoFromFavorites extends AsyncUseCase> { - RemovePhotoFromFavorites(this._photoRepository); + const RemovePhotoFromFavorites(this._photoRepository); final PhotoRepository _photoRepository; @override - FutureOrResult> execute(int? params) async { - await _photoRepository.deletePhotoFromFavorites(params!); + FutureOrResult> execute(int params) async { + await _photoRepository.deletePhotoFromFavorites(params); return _photoRepository.getAllPhotosFromFavorites(); } - - @override - FutureOr onStart(int? params) { - if (params == null) { - throw const ClientException('id cannot be null'); - } - } } diff --git a/packages/wyatt_architecture/example/lib/domain/usecases/photos/retrieve_all_albums.dart b/packages/wyatt_architecture/example/lib/domain/usecases/photos/retrieve_all_albums.dart index e88f8a12..08ae48ff 100644 --- a/packages/wyatt_architecture/example/lib/domain/usecases/photos/retrieve_all_albums.dart +++ b/packages/wyatt_architecture/example/lib/domain/usecases/photos/retrieve_all_albums.dart @@ -14,30 +14,21 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'dart:async'; - import 'package:architecture_example/domain/entities/album.dart'; import 'package:architecture_example/domain/repositories/photo_repository.dart'; import 'package:architecture_example/domain/usecases/photos/params/query_parameters.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; class RetrieveAllAlbums extends AsyncUseCase> { - RetrieveAllAlbums(this._photoRepository); + const RetrieveAllAlbums(this._photoRepository); final PhotoRepository _photoRepository; @override - FutureOrResult> execute(QueryParameters? params) { + FutureOrResult> execute(QueryParameters params) { final albums = _photoRepository.getAllAlbums( - start: params!.start, + start: params.start, limit: params.limit, ); return albums; } - - @override - FutureOr onStart(QueryParameters? params) { - if (params == null) { - throw const ClientException('params cannot be null'); - } - } } diff --git a/packages/wyatt_architecture/lib/src/core/core.dart b/packages/wyatt_architecture/lib/src/core/core.dart index 122e2dfa..2d68b527 100644 --- a/packages/wyatt_architecture/lib/src/core/core.dart +++ b/packages/wyatt_architecture/lib/src/core/core.dart @@ -15,3 +15,5 @@ // along with this program. If not, see . export 'exceptions/exceptions.dart'; +export 'extensions/object_extension.dart'; +export 'mixins/observers.dart'; diff --git a/packages/wyatt_architecture/lib/src/core/exceptions/exceptions.dart b/packages/wyatt_architecture/lib/src/core/exceptions/exceptions.dart index e1fa8e9a..7bbda2ab 100644 --- a/packages/wyatt_architecture/lib/src/core/exceptions/exceptions.dart +++ b/packages/wyatt_architecture/lib/src/core/exceptions/exceptions.dart @@ -14,8 +14,6 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'package:wyatt_type_utils/wyatt_type_utils.dart'; - /// {@template app_exception} /// [AppException] is a base class for all exceptions in the wyatt architecture. /// {@endtemplate} @@ -27,7 +25,7 @@ abstract class AppException implements Exception { @override String toString() { - if (message.isNotNullOrEmpty) { + if (message?.isNotEmpty ?? false) { return '$runtimeType: $message'; } else { return '$runtimeType: An exception occured'; diff --git a/packages/wyatt_architecture/lib/src/domain/data_sources/data_sources.dart b/packages/wyatt_architecture/lib/src/core/extensions/object_extension.dart similarity index 71% rename from packages/wyatt_architecture/lib/src/domain/data_sources/data_sources.dart rename to packages/wyatt_architecture/lib/src/core/extensions/object_extension.dart index 17ffc5c8..b0ea8174 100644 --- a/packages/wyatt_architecture/lib/src/domain/data_sources/data_sources.dart +++ b/packages/wyatt_architecture/lib/src/core/extensions/object_extension.dart @@ -1,4 +1,4 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. // // This program is free software: you can redistribute it and/or modify @@ -14,6 +14,10 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -export 'base_data_source.dart'; -export 'local/local.dart'; -export 'remote/remote.dart'; +import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart'; + +extension ObjectExtension on Object? { + AppException toException() => this is AppException + ? this! as AppException + : ClientException(this?.toString()); +} diff --git a/packages/wyatt_architecture/lib/src/domain/usecases/observers.dart b/packages/wyatt_architecture/lib/src/core/mixins/observers.dart similarity index 51% rename from packages/wyatt_architecture/lib/src/domain/usecases/observers.dart rename to packages/wyatt_architecture/lib/src/core/mixins/observers.dart index a1925577..62e87b91 100644 --- a/packages/wyatt_architecture/lib/src/domain/usecases/observers.dart +++ b/packages/wyatt_architecture/lib/src/core/mixins/observers.dart @@ -1,4 +1,4 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. // // This program is free software: you can redistribute it and/or modify @@ -16,30 +16,26 @@ import 'dart:async'; -import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart'; +import 'package:wyatt_architecture/src/domain/usecase.dart'; /// Usecase observers -mixin Observer { +mixin Observer { /// Called before usecase is runned. /// Useful to check the preconditions - FutureOr onStart(Parameters? params) {} - - /// Called when error occures during main scenario - /// Useful to run alternative scenario - FutureOr onError(AppException? error) {} + FutureOr onStart(I? params) {} } -/// Specific observer for classic usecase -mixin AsyncObserver { - /// Called when usecase is completed - FutureOr onComplete(ReturnType? data) {} +/// Exception observer +mixin ExceptionObserver { + /// Called on error + /// Useful to handle exceptions + FutureOr onError(AppException e) {} } -/// Specific observer for stream case usecase -mixin StreamObserver { - /// Replaces the data event handler of this subscription. - void onDone() {} - - /// Replaces the done event handler of this subscription. - void onData(ReturnType? data) {} +/// Completer observer +mixin CompleterObserver { + /// Called after usecase is runned. + /// Useful to log the result + FutureOr onComplete(Res? result) {} } diff --git a/packages/wyatt_architecture/lib/src/domain/data_sources/base_data_source.dart b/packages/wyatt_architecture/lib/src/data/base_data_source.dart similarity index 96% rename from packages/wyatt_architecture/lib/src/domain/data_sources/base_data_source.dart rename to packages/wyatt_architecture/lib/src/data/base_data_source.dart index f5002603..0b73575b 100644 --- a/packages/wyatt_architecture/lib/src/domain/data_sources/base_data_source.dart +++ b/packages/wyatt_architecture/lib/src/data/base_data_source.dart @@ -1,4 +1,4 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. // // This program is free software: you can redistribute it and/or modify diff --git a/packages/wyatt_architecture/lib/src/domain/repositories/base_repository.dart b/packages/wyatt_architecture/lib/src/domain/base_repository.dart similarity index 100% rename from packages/wyatt_architecture/lib/src/domain/repositories/base_repository.dart rename to packages/wyatt_architecture/lib/src/domain/base_repository.dart diff --git a/packages/wyatt_architecture/lib/src/domain/data_sources/local/base_local_data_source.dart b/packages/wyatt_architecture/lib/src/domain/data_sources/local/base_local_data_source.dart deleted file mode 100644 index b091a13f..00000000 --- a/packages/wyatt_architecture/lib/src/domain/data_sources/local/base_local_data_source.dart +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -import 'package:wyatt_architecture/src/domain/data_sources/base_data_source.dart'; - -/// {@template base_local_data_source} -/// [BaseLocalDataSource] is a base class for all local data sources in the -/// wyatt architecture. -/// {@endtemplate} -abstract class BaseLocalDataSource extends BaseDataSource { - /// {@macro base_local_data_source} - const BaseLocalDataSource(); -} diff --git a/packages/wyatt_architecture/lib/src/domain/data_sources/local/local.dart b/packages/wyatt_architecture/lib/src/domain/data_sources/local/local.dart deleted file mode 100644 index e45c6a57..00000000 --- a/packages/wyatt_architecture/lib/src/domain/data_sources/local/local.dart +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -export 'base_local_data_source.dart'; diff --git a/packages/wyatt_architecture/lib/src/domain/data_sources/remote/base_remote_data_source.dart b/packages/wyatt_architecture/lib/src/domain/data_sources/remote/base_remote_data_source.dart deleted file mode 100644 index 8ed880c4..00000000 --- a/packages/wyatt_architecture/lib/src/domain/data_sources/remote/base_remote_data_source.dart +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -import 'package:wyatt_architecture/src/domain/data_sources/base_data_source.dart'; - -/// {@template base_remote_data_source} -/// [BaseRemoteDataSource] is a base class for all remote data sources in the -/// wyatt architecture. -/// {@endtemplate} -abstract class BaseRemoteDataSource extends BaseDataSource { - /// {@macro base_remote_data_source} - const BaseRemoteDataSource(); -} diff --git a/packages/wyatt_architecture/lib/src/domain/data_sources/remote/remote.dart b/packages/wyatt_architecture/lib/src/domain/data_sources/remote/remote.dart deleted file mode 100644 index 7403e595..00000000 --- a/packages/wyatt_architecture/lib/src/domain/data_sources/remote/remote.dart +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -export 'base_remote_data_source.dart'; diff --git a/packages/wyatt_architecture/lib/src/domain/domain.dart b/packages/wyatt_architecture/lib/src/domain/domain.dart index 35c41307..4b157e93 100644 --- a/packages/wyatt_architecture/lib/src/domain/domain.dart +++ b/packages/wyatt_architecture/lib/src/domain/domain.dart @@ -1,20 +1,19 @@ -// Copyright (C) 2022 WYATT GROUP +// Copyright (C) 2024 WYATT GROUP // Please see the AUTHORS file for details. -// +// // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // any later version. -// +// // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. -// +// // You should have received a copy of the GNU General Public License // along with this program. If not, see . -export 'data_sources/data_sources.dart'; -export 'entities/entities.dart'; -export 'repositories/repositories.dart'; -export 'usecases/usecases.dart'; +export 'base_repository.dart'; +export 'entity.dart'; +export 'usecase.dart'; diff --git a/packages/wyatt_architecture/lib/src/domain/entities/entities.dart b/packages/wyatt_architecture/lib/src/domain/entities/entities.dart deleted file mode 100644 index 937b195e..00000000 --- a/packages/wyatt_architecture/lib/src/domain/entities/entities.dart +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -export 'entity.dart'; diff --git a/packages/wyatt_architecture/lib/src/domain/entities/entity.dart b/packages/wyatt_architecture/lib/src/domain/entity.dart similarity index 100% rename from packages/wyatt_architecture/lib/src/domain/entities/entity.dart rename to packages/wyatt_architecture/lib/src/domain/entity.dart diff --git a/packages/wyatt_architecture/lib/src/domain/repositories/repositories.dart b/packages/wyatt_architecture/lib/src/domain/repositories/repositories.dart deleted file mode 100644 index bac1ea4c..00000000 --- a/packages/wyatt_architecture/lib/src/domain/repositories/repositories.dart +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -export 'base_repository.dart'; diff --git a/packages/wyatt_architecture/lib/src/domain/usecase.dart b/packages/wyatt_architecture/lib/src/domain/usecase.dart new file mode 100644 index 00000000..08c0db10 --- /dev/null +++ b/packages/wyatt_architecture/lib/src/domain/usecase.dart @@ -0,0 +1,153 @@ +// Copyright (C) 2022 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:generic_usecase/generic_usecase.dart' as generic; +import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart'; +import 'package:wyatt_architecture/src/core/extensions/object_extension.dart'; +import 'package:wyatt_architecture/src/core/mixins/observers.dart'; +import 'package:wyatt_type_utils/wyatt_type_utils.dart'; + +typedef Res = Result; +typedef FutureOrResult = FutureOr>; +typedef StreamResult = Stream>; + +/// A wrapper around [Result] to make it easier to use with AppException. +Future> unsafe(FutureOr Function() fn) => + Result.tryCatchAsync( + () => Future.sync(fn), + (e) => e.toException(), + ); + +abstract class AsyncUseCase extends generic.Usecase> + with Observer, ExceptionObserver, CompleterObserver { + const AsyncUseCase() : super(); + + @override + FutureOr checkPreconditions(I? params) async { + try { + await onStart(params); + return generic.ConditionsResult(isValid: true); + } catch (e) { + return generic.ConditionsResult(isValid: false, message: e.toString()); + } + } + + @override + FutureOr checkPostconditions(Res? result) async { + try { + await onComplete(result); + return generic.ConditionsResult(isValid: true); + } catch (e) { + return generic.ConditionsResult(isValid: false, message: e.toString()); + } + } + + @override + FutureOrResult onException(Object e) async { + final exception = e.toException(); + await onError(exception); + + return Err(exception); + } +} + +abstract class NoParamsAsyncUseCase extends generic.NoParamsUsecase> + with ExceptionObserver, CompleterObserver { + const NoParamsAsyncUseCase() : super(); + + @override + FutureOr checkPostconditions(Res? result) async { + try { + await onComplete(result); + return generic.ConditionsResult(isValid: true); + } catch (e) { + return generic.ConditionsResult(isValid: false, message: e.toString()); + } + } + + @override + FutureOrResult onException(Object e) async { + final exception = e.toException(); + await onError(exception); + + return Err(exception); + } +} + +abstract class StreamUseCase extends generic.StreamUsecase> + with Observer, ExceptionObserver { + const StreamUseCase() : super(); + + @override + FutureOr checkPreconditions(I? params) async { + try { + await onStart(params); + return generic.ConditionsResult(isValid: true); + } catch (e) { + return generic.ConditionsResult(isValid: false, message: e.toString()); + } + } + + StreamSubscription> listen( + I params, + void Function(Res)? onData, { + Function? onError, + void Function()? onDone, + bool? cancelOnError, + }) => + super.call(params).listen( + onData, + onError: onError, + onDone: onDone, + cancelOnError: cancelOnError, + ); + + @override + FutureOrResult onException(Object e) async { + final exception = e.toException(); + await onError(exception); + + return Err(exception); + } +} + +abstract class NoParamsStreamUseCase + extends generic.NoParamsStreamUsecase> with ExceptionObserver { + const NoParamsStreamUseCase() : super(); + + StreamSubscription> listen( + void Function(Res)? onData, { + Function? onError, + void Function()? onDone, + bool? cancelOnError, + }) => + super.call().listen( + onData, + onError: onError, + onDone: onDone, + cancelOnError: cancelOnError, + ); + + @override + FutureOrResult onException(Object e) async { + final exception = e.toException(); + await onError(exception); + + return Err(exception); + } +} diff --git a/packages/wyatt_architecture/lib/src/domain/usecases/no_param.dart b/packages/wyatt_architecture/lib/src/domain/usecases/no_param.dart deleted file mode 100644 index 4509bd59..00000000 --- a/packages/wyatt_architecture/lib/src/domain/usecases/no_param.dart +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -import 'package:wyatt_architecture/src/domain/entities/entity.dart'; - -/// {@template no_param} -/// [NoParam] is a class that is used when a use case does not require any -/// parameters. -/// {@endtemplate} -class NoParam extends Entity { - /// {@macro no_param} - const NoParam(); -} diff --git a/packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart b/packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart deleted file mode 100644 index 75c4c905..00000000 --- a/packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart +++ /dev/null @@ -1,100 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -import 'dart:async'; - -import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart'; -import 'package:wyatt_architecture/src/domain/usecases/observers.dart'; -import 'package:wyatt_type_utils/wyatt_type_utils.dart'; - -typedef FutureOrResult = FutureOr>; -typedef StreamResult = Stream>; - -/// {@template base_usecase} -/// Abstract class of any use case. -/// {@endtemplate} -abstract class BaseUseCase { - /// {@macro base_usecase} - const BaseUseCase(); - - /// Run use case scenarios - ReturnType call(Parameters parameters); - - /// Private function to implement main scenario - /// of your usecase. - ReturnType execute(Parameters params); -} - -/// {@template usecase} -/// Abstract class of a use case that deals specifically -/// with the response and its state. -/// {@endtemplate} -abstract class UseCase - extends BaseUseCase> - with Observer { - /// {@macro usecase} - const UseCase(); - - FutureOr _onSuccess(ReturnType data); - - /// Supports the result of the main scenario and integrates - /// some alternative scenarios if necessary. - @override - FutureOrResult call(Parameters? parameters) async { - try { - await onStart(parameters); - final response = await execute(parameters); - if (response.isErr) { - await onError(response.err); - } else if (response.isOk && response.ok != null) { - await _onSuccess(response.ok as ReturnType); - } - return response; - } catch (e) { - return Err(ClientException(e.toString())); - } - } -} - -/// {@template async_usecase} -/// Abtstract classic usecase bases on futures -/// {@endtemplate} -abstract class AsyncUseCase - extends UseCase with AsyncObserver { - /// {@macro async_usecase} - const AsyncUseCase(); - - @override - FutureOr _onSuccess(ReturnType data) => onComplete(data); -} - -/// {@template stream_usecase} -/// Abstract specific usecase bases on streams -/// {@endtemplate} -abstract class StreamUseCase - extends UseCase> - with StreamObserver { - /// {@macro stream_usecase} - const StreamUseCase(); - - @override - FutureOr _onSuccess(Stream data) { - data.listen( - onData, - onDone: onDone, - ); - } -} diff --git a/packages/wyatt_architecture/lib/src/domain/usecases/usecases.dart b/packages/wyatt_architecture/lib/src/domain/usecases/usecases.dart deleted file mode 100644 index 445b2682..00000000 --- a/packages/wyatt_architecture/lib/src/domain/usecases/usecases.dart +++ /dev/null @@ -1,19 +0,0 @@ -// Copyright (C) 2022 WYATT GROUP -// Please see the AUTHORS file for details. -// -// This program is free software: you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation, either version 3 of the License, or -// any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program. If not, see . - -export 'no_param.dart'; -export 'observers.dart'; -export 'usecase.dart'; diff --git a/packages/wyatt_architecture/lib/src/src.dart b/packages/wyatt_architecture/lib/src/src.dart index 2a39a026..cda1aa95 100644 --- a/packages/wyatt_architecture/lib/src/src.dart +++ b/packages/wyatt_architecture/lib/src/src.dart @@ -15,4 +15,5 @@ // along with this program. If not, see . export 'core/core.dart'; +export 'data/base_data_source.dart'; export 'domain/domain.dart'; diff --git a/packages/wyatt_architecture/pubspec.yaml b/packages/wyatt_architecture/pubspec.yaml index e3379349..4f6dacba 100644 --- a/packages/wyatt_architecture/pubspec.yaml +++ b/packages/wyatt_architecture/pubspec.yaml @@ -1,16 +1,16 @@ # Copyright (C) 2023 WYATT GROUP # Please see the AUTHORS file for details. -# +# # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # any later version. -# +# # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. -# +# # You should have received a copy of the GNU General Public License # along with this program. If not, see . @@ -22,9 +22,10 @@ version: 0.2.0+1 publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub environment: - sdk: ">=2.17.0 <3.0.0" + sdk: "^3.0.0" dependencies: + generic_usecase: ^3.0.0 wyatt_type_utils: hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub version: ^0.0.5 @@ -32,4 +33,4 @@ dependencies: dev_dependencies: wyatt_analysis: hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub - version: ^2.5.0 + version: ^2.6.1 -- 2.47.2 From 08218f70802f708d12095b5ebf69d820ddc50ba9 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Sun, 18 Feb 2024 22:49:47 +0100 Subject: [PATCH 03/14] chore(wyatt_cd): add wyatt continuous deployment package --- .../wyatt_continuous_deployment/.gitignore | 7 + .../.vscode/launch.json | 34 + .../.vscode/settings.json | 72 ++ packages/wyatt_continuous_deployment/AUTHORS | 8 + .../wyatt_continuous_deployment/CHANGELOG.md | 3 + packages/wyatt_continuous_deployment/LICENSE | 674 ++++++++++++++++++ .../wyatt_continuous_deployment/README.md | 56 ++ .../analysis_options.yaml | 27 + .../example/.gitignore | 44 ++ .../example/.metadata | 30 + .../example/README.md | 16 + .../example/analysis_options.yaml | 7 + .../example/lib/main.dart | 27 + .../example/pubspec.yaml | 31 + .../example/test/widget_test.dart | 1 + .../lib/src/core/constants/app_constants.dart | 30 + .../src/core/injection/injectable.config.dart | 96 +++ .../lib/src/core/injection/injectable.dart | 73 ++ .../lib/src/core/utils/logging.dart | 19 + .../lib/src/domain/domain.dart | 18 + .../entities/config/android_config.dart | 65 ++ .../entities/config/android_config.g.dart | 46 ++ .../config/appstore_connect_config.dart | 65 ++ .../config/init_config_parameters.dart | 28 + .../domain/entities/config/ios_config.dart | 94 +++ .../domain/entities/config/ios_config.g.dart | 77 ++ .../entities/decrypt_keys_parameters.dart | 25 + .../lib/src/domain/entities/entities.dart | 27 + .../lib/src/domain/entities/fastlane.dart | 68 ++ .../fastlane_create_keychain_parameters.dart | 38 + .../fastlane_deploy_pilot_parameters.dart | 49 ++ .../fastlane_deploy_supply_parameters.dart | 48 ++ .../fastlane_get_certificates_parameters.dart | 51 ++ .../lib/src/domain/entities/flutter.dart | 59 ++ .../config/get_android_config_usecase.dart | 40 ++ .../config/get_ios_config_usecase.dart | 40 ++ .../usecases/config/init_config_usecase.dart | 72 ++ .../decrypt_keys/decrypt_keys_usecase.dart | 95 +++ .../fastlane_create_keychain_usecase.dart | 49 ++ .../fastlane_deploy_pilot_usecase.dart | 55 ++ .../fastlane_deploy_supply_usecase.dart | 45 ++ .../fastlane_get_certificates_usecase.dart | 49 ++ .../usecases/find_last_ipa_file_usecase.dart | 50 ++ .../flutter_build_app_bundle_usecase.dart | 43 ++ .../flutter/flutter_build_ipa_usecase.dart | 43 ++ .../flutter_build_xcarchive_usecase.dart | 40 ++ .../flutter/flutter_clean_usecase.dart | 40 ++ .../flutter/flutter_pub_get_usecase.dart | 37 + .../src/domain/usecases/process_usecase.dart | 93 +++ .../check_config_file_usecase.dart | 35 + .../requirements/check_tools_usecase.dart | 50 ++ .../lib/src/domain/usecases/usecases.dart | 33 + .../lib/src/wyatt_continuous_deployment.dart | 23 + .../lib/wyatt_continuous_deployment.dart | 20 + .../wyatt_continuous_deployment/pubspec.yaml | 36 + .../wyatt_continuous_deployment_test.dart | 1 + 56 files changed, 3002 insertions(+) create mode 100644 packages/wyatt_continuous_deployment/.gitignore create mode 100644 packages/wyatt_continuous_deployment/.vscode/launch.json create mode 100644 packages/wyatt_continuous_deployment/.vscode/settings.json create mode 100644 packages/wyatt_continuous_deployment/AUTHORS create mode 100644 packages/wyatt_continuous_deployment/CHANGELOG.md create mode 100644 packages/wyatt_continuous_deployment/LICENSE create mode 100644 packages/wyatt_continuous_deployment/README.md create mode 100644 packages/wyatt_continuous_deployment/analysis_options.yaml create mode 100644 packages/wyatt_continuous_deployment/example/.gitignore create mode 100644 packages/wyatt_continuous_deployment/example/.metadata create mode 100644 packages/wyatt_continuous_deployment/example/README.md create mode 100644 packages/wyatt_continuous_deployment/example/analysis_options.yaml create mode 100644 packages/wyatt_continuous_deployment/example/lib/main.dart create mode 100644 packages/wyatt_continuous_deployment/example/pubspec.yaml create mode 100644 packages/wyatt_continuous_deployment/example/test/widget_test.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.config.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/domain.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.g.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/config/appstore_connect_config.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/config/init_config_parameters.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.g.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/decrypt_keys_parameters.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/entities.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_create_keychain_parameters.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_pilot_parameters.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_supply_parameters.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_create_keychain_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_pilot_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_supply_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_app_bundle_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_ipa_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_xcarchive_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_clean_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_pub_get_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecases.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart create mode 100644 packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart create mode 100644 packages/wyatt_continuous_deployment/pubspec.yaml create mode 100644 packages/wyatt_continuous_deployment/test/wyatt_continuous_deployment_test.dart diff --git a/packages/wyatt_continuous_deployment/.gitignore b/packages/wyatt_continuous_deployment/.gitignore new file mode 100644 index 00000000..3cceda55 --- /dev/null +++ b/packages/wyatt_continuous_deployment/.gitignore @@ -0,0 +1,7 @@ +# https://dart.dev/guides/libraries/private-files +# Created by `dart pub` +.dart_tool/ + +# Avoid committing pubspec.lock for library packages; see +# https://dart.dev/guides/libraries/private-files#pubspeclock. +pubspec.lock diff --git a/packages/wyatt_continuous_deployment/.vscode/launch.json b/packages/wyatt_continuous_deployment/.vscode/launch.json new file mode 100644 index 00000000..653eabc8 --- /dev/null +++ b/packages/wyatt_continuous_deployment/.vscode/launch.json @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2023 WYATT GROUP + * Please see the AUTHORS file for details. + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Launch Example", + "request": "launch", + "type": "dart", + "cwd": "example/", + "program": "lib/main.dart", + "flutterMode": "debug" + }, + ] +} \ No newline at end of file diff --git a/packages/wyatt_continuous_deployment/.vscode/settings.json b/packages/wyatt_continuous_deployment/.vscode/settings.json new file mode 100644 index 00000000..a29d370a --- /dev/null +++ b/packages/wyatt_continuous_deployment/.vscode/settings.json @@ -0,0 +1,72 @@ +{ + "dart.runPubGetOnPubspecChanges": "never", + "bloc.newCubitTemplate.type": "equatable", + "psi-header.changes-tracking": { + "isActive": true + }, + "psi-header.config": { + "blankLinesAfter": 1, + "forceToTop": true + }, + "psi-header.lang-config": [ + { + "beforeHeader": [ + "# -*- coding:utf-8 -*-", + "#!/usr/bin/env python3" + ], + "begin": "###", + "end": "###", + "language": "python", + "prefix": "# " + }, + { + "beforeHeader": [ + "#!/usr/bin/env sh", + "" + ], + "language": "shellscript", + "begin": "", + "end": "", + "prefix": "# " + }, + { + "begin": "", + "end": "", + "language": "dart", + "prefix": "// " + }, + { + "begin": "", + "end": "", + "language": "yaml", + "prefix": "# " + }, + { + "begin": "", + "language": "markdown", + }, + ], + "psi-header.templates": [ + { + "language": "*", + "template": [ + "Copyright (C) <> WYATT GROUP", + "Please see the AUTHORS file for details.", + "", + "This program is free software: you can redistribute it and/or modify", + "it under the terms of the GNU General Public License as published by", + "the Free Software Foundation, either version 3 of the License, or", + "any later version.", + "", + "This program is distributed in the hope that it will be useful,", + "but WITHOUT ANY WARRANTY; without even the implied warranty of", + "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the", + "GNU General Public License for more details.", + "", + "You should have received a copy of the GNU General Public License", + "along with this program. If not, see ." + ], + } + ], +} diff --git a/packages/wyatt_continuous_deployment/AUTHORS b/packages/wyatt_continuous_deployment/AUTHORS new file mode 100644 index 00000000..b40f74ca --- /dev/null +++ b/packages/wyatt_continuous_deployment/AUTHORS @@ -0,0 +1,8 @@ +# Below is a list of people and organizations that have contributed +# to this project. Names should be added to the list like so: +# +# Name/Organization + +Wyatt Group S.A.S +Hugo Pointcheval +Malo Léon \ No newline at end of file diff --git a/packages/wyatt_continuous_deployment/CHANGELOG.md b/packages/wyatt_continuous_deployment/CHANGELOG.md new file mode 100644 index 00000000..effe43c8 --- /dev/null +++ b/packages/wyatt_continuous_deployment/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- Initial version. diff --git a/packages/wyatt_continuous_deployment/LICENSE b/packages/wyatt_continuous_deployment/LICENSE new file mode 100644 index 00000000..e72bfdda --- /dev/null +++ b/packages/wyatt_continuous_deployment/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/packages/wyatt_continuous_deployment/README.md b/packages/wyatt_continuous_deployment/README.md new file mode 100644 index 00000000..ef538290 --- /dev/null +++ b/packages/wyatt_continuous_deployment/README.md @@ -0,0 +1,56 @@ + + + + + + +# Dart - Wyatt Continuous Deployment + +

+ Style: Wyatt Analysis + SDK: Dart & Flutter +

+ + + +Wyatt c d + +## Features + +TODO: List what your package can do. Maybe include images, gifs, or videos. + +## Getting started + +TODO: List prerequisites and provide or point to information on how to +start using the package. + +## Usage + +TODO: Include short and useful examples for package users. Add longer examples +to `/example` folder. + +```dart +const like = 'sample'; +``` + +## Additional information + +TODO: Tell users more about the package: where to find more information, how to +contribute to the package, how to file issues, what response they can expect +from the package authors, and more. diff --git a/packages/wyatt_continuous_deployment/analysis_options.yaml b/packages/wyatt_continuous_deployment/analysis_options.yaml new file mode 100644 index 00000000..33e0e952 --- /dev/null +++ b/packages/wyatt_continuous_deployment/analysis_options.yaml @@ -0,0 +1,27 @@ +include: package:wyatt_analysis/analysis_options.yaml + +analyzer: + plugins: + - dart_code_linter + +dart_code_linter: + anti-patterns: + - long-method + - long-parameter-list + metrics: + cyclomatic-complexity: 20 + maximum-nesting-level: 5 + number-of-parameters: 10 + source-lines-of-code: 400 + metrics-exclude: + - test/** + rules: + - newline-before-return + - no-boolean-literal-compare + - no-empty-block + - prefer-trailing-comma + - prefer-conditional-expressions + - no-equal-then-else + - avoid-border-all + - prefer-const-border-radius + - prefer-using-list-view diff --git a/packages/wyatt_continuous_deployment/example/.gitignore b/packages/wyatt_continuous_deployment/example/.gitignore new file mode 100644 index 00000000..24476c5d --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/.gitignore @@ -0,0 +1,44 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +/build/ + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/packages/wyatt_continuous_deployment/example/.metadata b/packages/wyatt_continuous_deployment/example/.metadata new file mode 100644 index 00000000..30e0d3ce --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/.metadata @@ -0,0 +1,30 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled. + +version: + revision: b06b8b2710955028a6b562f5aa6fe62941d6febf + channel: stable + +project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf + base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf + - platform: web + create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf + base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf + + # User provided section + + # List of Local paths (relative to this file) that should be + # ignored by the migrate tool. + # + # Files that are not part of the templates will be ignored by default. + unmanaged_files: + - 'lib/main.dart' + - 'ios/Runner.xcodeproj/project.pbxproj' diff --git a/packages/wyatt_continuous_deployment/example/README.md b/packages/wyatt_continuous_deployment/example/README.md new file mode 100644 index 00000000..2b3fce4c --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/README.md @@ -0,0 +1,16 @@ +# example + +A new Flutter project. + +## Getting Started + +This project is a starting point for a Flutter application. + +A few resources to get you started if this is your first Flutter project: + +- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) +- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) + +For help getting started with Flutter development, view the +[online documentation](https://docs.flutter.dev/), which offers tutorials, +samples, guidance on mobile development, and a full API reference. diff --git a/packages/wyatt_continuous_deployment/example/analysis_options.yaml b/packages/wyatt_continuous_deployment/example/analysis_options.yaml new file mode 100644 index 00000000..50ed209d --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/analysis_options.yaml @@ -0,0 +1,7 @@ + + + +include: package:wyatt_analysis/analysis_options.yaml + + + diff --git a/packages/wyatt_continuous_deployment/example/lib/main.dart b/packages/wyatt_continuous_deployment/example/lib/main.dart new file mode 100644 index 00000000..d3342cf8 --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/lib/main.dart @@ -0,0 +1,27 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/wyatt_continuous_deployment.dart'; + +class WyattContinuousDeploymentExample { + static Future run(List args) async { + const useCase = CheckToolsUsecase(); + + final result = await useCase(); + + result.fold((value) => print('Success'), (error) => print('Error: $error')); + } +} diff --git a/packages/wyatt_continuous_deployment/example/pubspec.yaml b/packages/wyatt_continuous_deployment/example/pubspec.yaml new file mode 100644 index 00000000..2f1b5564 --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/pubspec.yaml @@ -0,0 +1,31 @@ +name: wyatt_continuous_deployment_example +description: A new Flutter project. +version: 1.0.0 + +publish_to: 'none' + +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + + + + wyatt_continuous_deployment: + path: "../" + +dev_dependencies: + + + + test: ^1.21.0 + + + + + wyatt_analysis: + hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub + version: ^2.6.1 + + + diff --git a/packages/wyatt_continuous_deployment/example/test/widget_test.dart b/packages/wyatt_continuous_deployment/example/test/widget_test.dart new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/test/widget_test.dart @@ -0,0 +1 @@ + diff --git a/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart b/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart new file mode 100644 index 00000000..350c2708 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart @@ -0,0 +1,30 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +abstract class AppConstants { + static const configFileName = 'wyatt.yaml'; + static const requiredTools = ['fastlane', 'flutter', 'unzip', 'gpg']; + + static const androidFolder = 'android'; + static const androidBundleBuildPath = + 'build/app/outputs/bundle/release/app-release.aab'; + static const androidKeysSecretPassphrase = 'ANDROID_KEYS_SECRET_PASSPHRASE'; + static const androidConfigKey = 'android'; + + static const iosFolder = 'ios'; + static const iosKeysSecretPassphrase = 'IOS_KEYS_SECRET_PASSPHRASE'; + static const iosConfigKey = 'ios'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.config.dart b/packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.config.dart new file mode 100644 index 00000000..d38dd2fb --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.config.dart @@ -0,0 +1,96 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +// ************************************************************************** +// InjectableConfigGenerator +// ************************************************************************** + +// ignore_for_file: type=lint +// coverage:ignore-file + +// ignore_for_file: no_leading_underscores_for_library_prefixes +import 'package:get_it/get_it.dart' as _i1; +import 'package:injectable/injectable.dart' as _i2; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart' + as _i21; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane.dart' + as _i6; +import 'package:wyatt_continuous_deployment/src/domain/entities/flutter.dart' + as _i12; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/get_android_config_usecase.dart' + as _i18; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/get_ios_config_usecase.dart' + as _i19; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/init_config_usecase.dart' + as _i20; +import 'package:wyatt_continuous_deployment/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart' + as _i5; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_create_keychain_usecase.dart' + as _i7; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_deploy_pilot_usecase.dart' + as _i8; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_deploy_supply_usecase.dart' + as _i9; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart' + as _i10; +import 'package:wyatt_continuous_deployment/src/domain/usecases/find_last_ipa_file_usecase.dart' + as _i11; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_build_app_bundle_usecase.dart' + as _i13; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_build_ipa_usecase.dart' + as _i14; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_build_xcarchive_usecase.dart' + as _i15; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_clean_usecase.dart' + as _i16; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_pub_get_usecase.dart' + as _i17; +import 'package:wyatt_continuous_deployment/src/domain/usecases/requirements/check_config_file_usecase.dart' + as _i3; +import 'package:wyatt_continuous_deployment/src/domain/usecases/requirements/check_tools_usecase.dart' + as _i4; + +extension GetItInjectableX on _i1.GetIt { +// initializes the registration of main-scope dependencies inside of GetIt + _i1.GetIt init({ + String? environment, + _i2.EnvironmentFilter? environmentFilter, + }) { + final gh = _i2.GetItHelper( + this, + environment, + environmentFilter, + ); + final registerModule = _$RegisterModule(); + gh.singleton<_i3.CheckConfigFileUsecase>( + const _i3.CheckConfigFileUsecase()); + gh.singleton<_i4.CheckToolsUsecase>(const _i4.CheckToolsUsecase()); + gh.singleton<_i5.DecryptKeysUsecase>(const _i5.DecryptKeysUsecase()); + gh.lazySingleton<_i6.Fastlane>(() => registerModule.fastlane); + gh.singleton<_i7.FastlaneCreateKeychainUsecase>( + _i7.FastlaneCreateKeychainUsecase()); + gh.singleton<_i8.FastlaneDeployPilotUsecase>( + _i8.FastlaneDeployPilotUsecase()); + gh.singleton<_i9.FastlaneDeploySupplyUsecase>( + _i9.FastlaneDeploySupplyUsecase()); + gh.singleton<_i10.FastlaneGetCertificateUsecase>( + _i10.FastlaneGetCertificateUsecase()); + gh.singleton<_i11.FindLastIpaFileUsecase>( + const _i11.FindLastIpaFileUsecase()); + gh.lazySingleton<_i12.Flutter>(() => registerModule.flutter); + gh.singleton<_i13.FlutterBuildAppBundleUsecase>( + const _i13.FlutterBuildAppBundleUsecase()); + gh.singleton<_i14.FlutterBuildIpaUsecase>( + const _i14.FlutterBuildIpaUsecase()); + gh.singleton<_i15.FlutterBuildXcarchiveUsecase>( + const _i15.FlutterBuildXcarchiveUsecase()); + gh.singleton<_i16.FlutterCleanUsecase>(const _i16.FlutterCleanUsecase()); + gh.singleton<_i17.FlutterPubGetUsecase>(const _i17.FlutterPubGetUsecase()); + gh.singleton<_i18.GetAndroidConfigUsecase>( + const _i18.GetAndroidConfigUsecase()); + gh.singleton<_i19.GetIosConfigUsecase>(const _i19.GetIosConfigUsecase()); + gh.singleton<_i20.InitConfigUsecase>(const _i20.InitConfigUsecase()); + return this; + } +} + +class _$RegisterModule extends _i21.RegisterModule {} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.dart b/packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.dart new file mode 100644 index 00000000..103032fa --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/injection/injectable.dart @@ -0,0 +1,73 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:get_it/get_it.dart'; +import 'package:injectable/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.config.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/flutter.dart'; + +final getIt = GetIt.instance; + +@InjectableInit( + initializerName: 'init', + preferRelativeImports: false, + asExtension: true, +) +abstract final class Injectable { + static Future configureDependencies() => getIt.init().allReady(); +} + +@module +abstract class RegisterModule { + @lazySingleton + Flutter get flutter => Flutter(); + + @lazySingleton + Fastlane get fastlane => Fastlane(); +} + +class UsecaseInjectable extends Singleton { + const UsecaseInjectable({ + super.as, + super.env, + super.dispose, + super.scope, + super.order, + }); +} + +const usecase = UsecaseInjectable(); + +class RepositoryInjectable extends Singleton { + const RepositoryInjectable({ + super.as, + super.env, + super.dispose, + super.scope, + super.order, + }); +} + +class DataSourceInjectable extends Singleton { + const DataSourceInjectable({ + super.as, + super.env, + super.dispose, + super.scope, + super.order, + }); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart b/packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart new file mode 100644 index 00000000..b3050073 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart @@ -0,0 +1,19 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/wyatt_continuous_deployment.dart'; + +final logger = WyattContinuousDeployment.logger; diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/domain.dart b/packages/wyatt_continuous_deployment/lib/src/domain/domain.dart new file mode 100644 index 00000000..6d8da814 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/domain.dart @@ -0,0 +1,18 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +export 'entities/entities.dart'; +export 'usecases/usecases.dart'; diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.dart new file mode 100644 index 00000000..5ede4da5 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.dart @@ -0,0 +1,65 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:json_annotation/json_annotation.dart'; + +part 'android_config.g.dart'; + +@JsonSerializable( + anyMap: true, + fieldRename: FieldRename.snake, + checked: true, +) +class AndroidConfig { + const AndroidConfig({ + required this.flutterArgs, + required this.encryptedKeyFileName, + required this.googleServiceAccountFileName, + required this.releaseStatus, + required this.androidFolderPath, + required this.track, + this.packageName, + }); + + factory AndroidConfig.fromJson(Map json) => + _$AndroidConfigFromJson(json); + + Map toJson() => _$AndroidConfigToJson(this); + + static const defaultValues = AndroidConfig( + flutterArgs: '', + encryptedKeyFileName: 'android_keys.zip.gpg', + googleServiceAccountFileName: 'service_account_key.json', + releaseStatus: 'draft', + track: 'internal', + androidFolderPath: 'android', + ); + + final String? packageName; + final String flutterArgs; + final String encryptedKeyFileName; + final String googleServiceAccountFileName; + final String androidFolderPath; + final String releaseStatus; + final String track; + + File get encryptedKeyFile => File('$androidFolderPath/$encryptedKeyFileName'); + File get googleServiceAccountFile => + File('$androidFolderPath/$googleServiceAccountFileName'); + Directory get androidDirectory => Directory(androidFolderPath); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.g.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.g.dart new file mode 100644 index 00000000..c9dc76c7 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/android_config.g.dart @@ -0,0 +1,46 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'android_config.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +AndroidConfig _$AndroidConfigFromJson(Map json) => $checkedCreate( + 'AndroidConfig', + json, + ($checkedConvert) { + final val = AndroidConfig( + flutterArgs: $checkedConvert('flutter_args', (v) => v as String), + encryptedKeyFileName: + $checkedConvert('encrypted_key_file_name', (v) => v as String), + googleServiceAccountFileName: $checkedConvert( + 'google_service_account_file_name', (v) => v as String), + releaseStatus: $checkedConvert('release_status', (v) => v as String), + androidFolderPath: + $checkedConvert('android_folder_path', (v) => v as String), + track: $checkedConvert('track', (v) => v as String), + packageName: $checkedConvert('package_name', (v) => v as String?), + ); + return val; + }, + fieldKeyMap: const { + 'flutterArgs': 'flutter_args', + 'encryptedKeyFileName': 'encrypted_key_file_name', + 'googleServiceAccountFileName': 'google_service_account_file_name', + 'releaseStatus': 'release_status', + 'androidFolderPath': 'android_folder_path', + 'packageName': 'package_name' + }, + ); + +Map _$AndroidConfigToJson(AndroidConfig instance) => + { + 'package_name': instance.packageName, + 'flutter_args': instance.flutterArgs, + 'encrypted_key_file_name': instance.encryptedKeyFileName, + 'google_service_account_file_name': instance.googleServiceAccountFileName, + 'android_folder_path': instance.androidFolderPath, + 'release_status': instance.releaseStatus, + 'track': instance.track, + }; diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/appstore_connect_config.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/appstore_connect_config.dart new file mode 100644 index 00000000..9928934a --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/appstore_connect_config.dart @@ -0,0 +1,65 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/domain/entities/config/ios_config.dart'; + +class AppStoreConnectConfig { + AppStoreConnectConfig({ + required this.keyId, + required this.issuerId, + required this.keyFilePath, + required this.isKeyContentBase64, + required this.duration, + required this.inHouse, + }); + + factory AppStoreConnectConfig.fromJson(Map json) => + AppStoreConnectConfig( + keyId: json['apple_key_id']?.toString(), + issuerId: json['apple_issuer_id']?.toString(), + keyFilePath: json['apple_key_content']?.toString(), + isKeyContentBase64: false, + duration: 500, + inHouse: false, + ); + + factory AppStoreConnectConfig.fromConfig(IosConfig config) => + AppStoreConnectConfig( + keyId: config.appleKeyId, + issuerId: config.appleIssuerId, + keyFilePath: + '${config.iosFolderPath}/${config.appleApiPrivateKeyFileName}', + isKeyContentBase64: false, + duration: 500, + inHouse: false, + ); + + final String? keyId; + final String? issuerId; + final String? keyFilePath; + final bool? isKeyContentBase64; + final int? duration; + final bool? inHouse; + + Map toJson(String key) => { + 'key_id': keyId, + 'issuer_id': issuerId, + 'key': key, + 'is_key_content_base64': isKeyContentBase64, + 'duration': duration, + 'in_house': inHouse, + }; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/init_config_parameters.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/init_config_parameters.dart new file mode 100644 index 00000000..da922bd7 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/init_config_parameters.dart @@ -0,0 +1,28 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +class InitConfigParameters { + const InitConfigParameters({ + required this.path, + required this.force, + }); + + final String path; + final bool force; + + @override + String toString() => 'InitConfigParameters(path: $path, force: $force)'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.dart new file mode 100644 index 00000000..87b4c954 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.dart @@ -0,0 +1,94 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:json_annotation/json_annotation.dart'; + +part 'ios_config.g.dart'; + +@JsonSerializable( + anyMap: true, + fieldRename: FieldRename.snake, + checked: true, +) +class IosConfig { + const IosConfig({ + required this.appleApiPrivateKeyFileName, + required this.gitCertsPrivateKeyFileName, + required this.iosFolderPath, + required this.encryptedKeyFileName, + required this.developerAppIdentifier, + required this.teamName, + required this.appleIssuerId, + required this.gitUrl, + required this.gitPassphrase, + required this.developerAppId, + required this.userName, + required this.appleKeyId, + required this.teamId, + required this.provisionningProfiles, + required this.flutterArgs, + required this.iosKeysFileName, + }); + + factory IosConfig.fromJson(Map json) => + _$IosConfigFromJson(json); + + Map toJson() => _$IosConfigToJson(this); + + static const defaultValues = IosConfig( + iosFolderPath: 'ios', + encryptedKeyFileName: 'ios_keys.zip.gpg', + iosKeysFileName: 'ios_keys.json', + appleApiPrivateKeyFileName: 'key.p8', + gitCertsPrivateKeyFileName: '', + developerAppIdentifier: 'git-key', + teamName: '', + appleIssuerId: '', + gitUrl: '', + gitPassphrase: 'match-password', + developerAppId: '', + userName: '', + appleKeyId: '', + teamId: '', + provisionningProfiles: {}, + flutterArgs: '', + ); + + final String flutterArgs; + final String iosFolderPath; + final String encryptedKeyFileName; + final String appleApiPrivateKeyFileName; + final String gitCertsPrivateKeyFileName; + + final String iosKeysFileName; + final String developerAppId; + final String developerAppIdentifier; + final String teamId; + final String teamName; + final String userName; + + final String appleIssuerId; + final String appleKeyId; + + final String gitPassphrase; + final String gitUrl; + final Map provisionningProfiles; + + File get encryptedKeyFile => File('$iosFolderPath/$encryptedKeyFileName'); + Directory get iosDirectory => Directory(iosFolderPath); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.g.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.g.dart new file mode 100644 index 00000000..763035b3 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/config/ios_config.g.dart @@ -0,0 +1,77 @@ +// GENERATED CODE - DO NOT MODIFY BY HAND + +part of 'ios_config.dart'; + +// ************************************************************************** +// JsonSerializableGenerator +// ************************************************************************** + +IosConfig _$IosConfigFromJson(Map json) => $checkedCreate( + 'IosConfig', + json, + ($checkedConvert) { + final val = IosConfig( + appleApiPrivateKeyFileName: $checkedConvert( + 'apple_api_private_key_file_name', (v) => v as String), + gitCertsPrivateKeyFileName: $checkedConvert( + 'git_certs_private_key_file_name', (v) => v as String), + iosFolderPath: $checkedConvert('ios_folder_path', (v) => v as String), + encryptedKeyFileName: + $checkedConvert('encrypted_key_file_name', (v) => v as String), + developerAppIdentifier: + $checkedConvert('developer_app_identifier', (v) => v as String), + teamName: $checkedConvert('team_name', (v) => v as String), + appleIssuerId: $checkedConvert('apple_issuer_id', (v) => v as String), + gitUrl: $checkedConvert('git_url', (v) => v as String), + gitPassphrase: $checkedConvert('git_passphrase', (v) => v as String), + developerAppId: + $checkedConvert('developer_app_id', (v) => v as String), + userName: $checkedConvert('user_name', (v) => v as String), + appleKeyId: $checkedConvert('apple_key_id', (v) => v as String), + teamId: $checkedConvert('team_id', (v) => v as String), + provisionningProfiles: $checkedConvert('provisionning_profiles', + (v) => Map.from(v as Map)), + flutterArgs: $checkedConvert('flutter_args', (v) => v as String), + iosKeysFileName: + $checkedConvert('ios_keys_file_name', (v) => v as String), + ); + return val; + }, + fieldKeyMap: const { + 'appleApiPrivateKeyFileName': 'apple_api_private_key_file_name', + 'gitCertsPrivateKeyFileName': 'git_certs_private_key_file_name', + 'iosFolderPath': 'ios_folder_path', + 'encryptedKeyFileName': 'encrypted_key_file_name', + 'developerAppIdentifier': 'developer_app_identifier', + 'teamName': 'team_name', + 'appleIssuerId': 'apple_issuer_id', + 'gitUrl': 'git_url', + 'gitPassphrase': 'git_passphrase', + 'developerAppId': 'developer_app_id', + 'userName': 'user_name', + 'appleKeyId': 'apple_key_id', + 'teamId': 'team_id', + 'provisionningProfiles': 'provisionning_profiles', + 'flutterArgs': 'flutter_args', + 'iosKeysFileName': 'ios_keys_file_name' + }, + ); + +Map _$IosConfigToJson(IosConfig instance) => { + 'flutter_args': instance.flutterArgs, + 'ios_folder_path': instance.iosFolderPath, + 'encrypted_key_file_name': instance.encryptedKeyFileName, + 'apple_api_private_key_file_name': instance.appleApiPrivateKeyFileName, + 'git_certs_private_key_file_name': instance.gitCertsPrivateKeyFileName, + 'ios_keys_file_name': instance.iosKeysFileName, + 'developer_app_id': instance.developerAppId, + 'developer_app_identifier': instance.developerAppIdentifier, + 'team_id': instance.teamId, + 'team_name': instance.teamName, + 'user_name': instance.userName, + 'apple_issuer_id': instance.appleIssuerId, + 'apple_key_id': instance.appleKeyId, + 'git_passphrase': instance.gitPassphrase, + 'git_url': instance.gitUrl, + 'provisionning_profiles': instance.provisionningProfiles, + }; diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/decrypt_keys_parameters.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/decrypt_keys_parameters.dart new file mode 100644 index 00000000..44e578bf --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/decrypt_keys_parameters.dart @@ -0,0 +1,25 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +class DecryptKeysParameters { + const DecryptKeysParameters({ + required this.encryptedFilePath, + required this.passphrase, + }); + + final String encryptedFilePath; + final String passphrase; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/entities.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/entities.dart new file mode 100644 index 00000000..8e36ad6d --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/entities.dart @@ -0,0 +1,27 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +export 'config/android_config.dart'; +export 'config/appstore_connect_config.dart'; +export 'config/init_config_parameters.dart'; +export 'config/ios_config.dart'; +export 'decrypt_keys_parameters.dart'; +export 'fastlane.dart'; +export 'fastlane/fastlane_create_keychain_parameters.dart'; +export 'fastlane/fastlane_deploy_pilot_parameters.dart'; +export 'fastlane/fastlane_deploy_supply_parameters.dart'; +export 'fastlane/fastlane_get_certificates_parameters.dart'; +export 'flutter.dart'; diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane.dart new file mode 100644 index 00000000..22a280a9 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane.dart @@ -0,0 +1,68 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_create_keychain_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_deploy_pilot_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_deploy_supply_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_create_keychain_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_deploy_pilot_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_deploy_supply_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart'; + +class Fastlane { + factory Fastlane() => Fastlane._( + createKeychainUsecase: getIt(), + deployPilotUsecase: getIt(), + deploySupplyUsecase: getIt(), + getCertificateUsecase: getIt(), + ); + + Fastlane._({ + required FastlaneCreateKeychainUsecase createKeychainUsecase, + required FastlaneDeployPilotUsecase deployPilotUsecase, + required FastlaneDeploySupplyUsecase deploySupplyUsecase, + required FastlaneGetCertificateUsecase getCertificateUsecase, + }) : _createKeychainUsecase = createKeychainUsecase, + _deployPilotUsecase = deployPilotUsecase, + _deploySupplyUsecase = deploySupplyUsecase, + _getCertificateUsecase = getCertificateUsecase; + + final FastlaneCreateKeychainUsecase _createKeychainUsecase; + final FastlaneDeployPilotUsecase _deployPilotUsecase; + final FastlaneDeploySupplyUsecase _deploySupplyUsecase; + final FastlaneGetCertificateUsecase _getCertificateUsecase; + + FutureOrResult createKeychain( + FastlaneCreateKeychainParameters params, + ) => + _createKeychainUsecase(params); + + FutureOrResult deployAppStore(FastlaneDeployPilotParameters params) => + _deployPilotUsecase(params); + + FutureOrResult deployGooglePlay( + FastlaneDeploySupplyParameters params, + ) => + _deploySupplyUsecase(params); + + FutureOrResult getCertificates( + FastlaneGetCertificatesParameters params, + ) => + _getCertificateUsecase(params); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_create_keychain_parameters.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_create_keychain_parameters.dart new file mode 100644 index 00000000..eb02d8b5 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_create_keychain_parameters.dart @@ -0,0 +1,38 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +class FastlaneCreateKeychainParameters { + const FastlaneCreateKeychainParameters({ + required this.name, + required this.password, + required this.gitPassphrase, + this.unlock = false, + this.timeout = 0, + }); + + final String name; + final String password; + final String gitPassphrase; + final bool unlock; + final int timeout; + + List toList() => [ + 'name:$name', + 'password:$password', + 'unlock:$unlock', + 'timeout:$timeout', + ]; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_pilot_parameters.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_pilot_parameters.dart new file mode 100644 index 00000000..414c3027 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_pilot_parameters.dart @@ -0,0 +1,49 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/domain/entities/config/appstore_connect_config.dart'; + +class FastlaneDeployPilotParameters { + const FastlaneDeployPilotParameters({ + required this.appStoreConnectConfig, + required this.developerAppId, + required this.developerAppIdentifier, + required this.ipaPath, + this.skipWaitingForBuildProcessing = true, + this.skipSubmission = true, + this.distributeExternal = false, + this.notifyExternalTesters = false, + }); + + final AppStoreConnectConfig appStoreConnectConfig; + final String developerAppId; + final String developerAppIdentifier; + final String ipaPath; + final bool skipWaitingForBuildProcessing; + final bool skipSubmission; + final bool distributeExternal; + final bool notifyExternalTesters; + + List toList() => [ + 'apple_id:$developerAppId', + 'app_identifier:$developerAppIdentifier', + 'ipa:$ipaPath', + 'skip_waiting_for_build_processing:$skipWaitingForBuildProcessing', + 'skip_submission:$skipSubmission', + 'distribute_external:$distributeExternal', + 'notify_external_testers:$notifyExternalTesters', + ]; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_supply_parameters.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_supply_parameters.dart new file mode 100644 index 00000000..a8485185 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_deploy_supply_parameters.dart @@ -0,0 +1,48 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +class FastlaneDeploySupplyParameters { + const FastlaneDeploySupplyParameters({ + required this.track, + required this.serviceAccountPath, + required this.appBundlePath, + required this.releaseStatus, + required this.packageName, + this.skipUploadMetadata = true, + this.skipUploadImages = true, + this.skipUploadScreenshots = true, + }); + + final String track; + final String packageName; + final String serviceAccountPath; + final String appBundlePath; + final String releaseStatus; + final bool skipUploadMetadata; + final bool skipUploadImages; + final bool skipUploadScreenshots; + + List toList() => [ + 'track:$track', + 'json_key:$serviceAccountPath', + 'aab:$appBundlePath', + 'release_status:$releaseStatus', + 'package_name:$packageName', + 'skip_upload_metadata:$skipUploadMetadata', + 'skip_upload_images:$skipUploadImages', + 'skip_upload_screenshots:$skipUploadScreenshots', + ]; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart new file mode 100644 index 00000000..1018de6e --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart @@ -0,0 +1,51 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +class FastlaneGetCertificatesParameters { + const FastlaneGetCertificatesParameters({ + required this.gitPrivateKey, + required this.appIdentifier, + required this.keychainName, + required this.keychainPassword, + required this.userName, + required this.teamId, + required this.teamName, + required this.gitUrl, + required this.gitPassphrase, + }); + + final String gitPrivateKey; + final String appIdentifier; + final String keychainName; + final String keychainPassword; + final String userName; + final String teamId; + final String teamName; + final String gitUrl; + final String gitPassphrase; + + List toList() => [ + 'app_identifier:$appIdentifier', + 'git_private_key:$gitPrivateKey', + 'keychain_name:$keychainName', + 'keychain_password:$keychainPassword', + 'username:$userName', + 'team_id:$teamId', + 'team_name:$teamName', + 'git_url:$gitUrl', + 'storage_mode:git', + ]; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart new file mode 100644 index 00000000..9d912310 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart @@ -0,0 +1,59 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_build_app_bundle_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_build_ipa_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_build_xcarchive_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_clean_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/flutter/flutter_pub_get_usecase.dart'; + +class Flutter { + factory Flutter() => Flutter._( + flutterCleanUsecase: getIt(), + flutterPubGetUsecase: getIt(), + flutterBuildXcarchiveUsecase: getIt(), + flutterBuildIpaUsecase: getIt(), + flutterBuildAppBundleUsecase: getIt(), + ); + + Flutter._({ + required FlutterCleanUsecase flutterCleanUsecase, + required FlutterPubGetUsecase flutterPubGetUsecase, + required FlutterBuildXcarchiveUsecase flutterBuildXcarchiveUsecase, + required FlutterBuildIpaUsecase flutterBuildIpaUsecase, + required FlutterBuildAppBundleUsecase flutterBuildAppBundleUsecase, + }) : _flutterCleanUsecase = flutterCleanUsecase, + _flutterPubGetUsecase = flutterPubGetUsecase, + _flutterBuildXcarchiveUsecase = flutterBuildXcarchiveUsecase, + _flutterBuildIpaUsecase = flutterBuildIpaUsecase, + _flutterBuildAppBundleUsecase = flutterBuildAppBundleUsecase; + + final FlutterCleanUsecase _flutterCleanUsecase; + final FlutterPubGetUsecase _flutterPubGetUsecase; + final FlutterBuildXcarchiveUsecase _flutterBuildXcarchiveUsecase; + final FlutterBuildIpaUsecase _flutterBuildIpaUsecase; + final FlutterBuildAppBundleUsecase _flutterBuildAppBundleUsecase; + + FutureOrResult clean() => _flutterCleanUsecase(); + FutureOrResult getDependencies() => _flutterPubGetUsecase(); + FutureOrResult createXcArchive() => _flutterBuildXcarchiveUsecase(); + FutureOrResult buildIpa(List args) => + _flutterBuildIpaUsecase(args); + FutureOrResult buildAppBundle(List args) => + _flutterBuildAppBundleUsecase(args); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart new file mode 100644 index 00000000..688824c1 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart @@ -0,0 +1,40 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:checked_yaml/checked_yaml.dart'; +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/config/android_config.dart'; +import 'package:yaml/yaml.dart'; + +@usecase +class GetAndroidConfigUsecase extends AsyncUseCase { + const GetAndroidConfigUsecase() : super(); + + @override + FutureOr> execute(String params) => unsafe(() { + final file = File(params); + final content = file.readAsStringSync(); + + return checkedYamlDecode( + content, + (json) => AndroidConfig.fromJson(json!['android'] as YamlMap), + ); + }); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart new file mode 100644 index 00000000..c7d0766b --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart @@ -0,0 +1,40 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:checked_yaml/checked_yaml.dart'; +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/config/ios_config.dart'; +import 'package:yaml/yaml.dart'; + +@usecase +class GetIosConfigUsecase extends AsyncUseCase { + const GetIosConfigUsecase() : super(); + + @override + FutureOr> execute(String params) => unsafe(() { + final file = File(params); + final content = file.readAsStringSync(); + + return checkedYamlDecode( + content, + (json) => IosConfig.fromJson(json!['ios'] as YamlMap), + ); + }); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart new file mode 100644 index 00000000..87ba935e --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart @@ -0,0 +1,72 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/config/android_config.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/config/init_config_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/config/ios_config.dart'; +import 'package:yaml_edit/yaml_edit.dart'; + +@usecase +class InitConfigUsecase extends AsyncUseCase { + const InitConfigUsecase() : super(); + + @override + FutureOr> execute(InitConfigParameters params) => unsafe(() async { + final file = File(params.path); + if (!file.existsSync()) { + logger.detail('Creating config file at `${params.path}`'); + file.createSync(); + } else { + if (!params.force) { + throw ClientException( + 'Config file already exists at `${params.path}`', + ); + } else { + logger.detail('Forced to create config file at `${params.path}`'); + file + ..deleteSync() + ..createSync(); + } + } + + const androidConfig = AndroidConfig.defaultValues; + + logger.detail( + 'Writing default android config: ${androidConfig.toJson()}', + ); + + const iosConfig = IosConfig.defaultValues; + + logger.detail( + 'Writing default ios config: ${iosConfig.toJson()}', + ); + + final yamlEditor = YamlEditor('') + ..update([], { + AppConstants.androidConfigKey: androidConfig.toJson(), + AppConstants.iosConfigKey: iosConfig.toJson(), + }); + + file.writeAsStringSync(yamlEditor.toString()); + }); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart new file mode 100644 index 00000000..c96d667e --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart @@ -0,0 +1,95 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/decrypt_keys_parameters.dart'; + +@usecase +class DecryptKeysUsecase extends AsyncUseCase { + const DecryptKeysUsecase() : super(); + + @override + FutureOr onStart(DecryptKeysParameters? params) { + if (params == null) { + throw const ClientException('DecryptKeysParameters is null'); + } + if (params.encryptedFilePath.isEmpty) { + throw const ClientException('Encrypted file path is empty'); + } + if (!params.encryptedFilePath.endsWith('.gpg')) { + throw const ClientException('Enncrypted file is not a .gpg file'); + } + } + + @override + FutureOr> execute(DecryptKeysParameters params) => unsafe(() async { + // Define gpg command + final gpgFilePath = + params.encryptedFilePath.replaceAll(RegExp(r'\.gpg$'), ''); + final outputGpgFilePath = + gpgFilePath.endsWith('.zip') ? gpgFilePath : '$gpgFilePath.zip'; + + final gpgCommand = 'gpg --quiet --batch --yes --decrypt ' + '--passphrase=${params.passphrase} ' + '--output $outputGpgFilePath ${params.encryptedFilePath}'; + + logger.detail( + '''DecryptKeysUsecase: Decrypting the file with the command: ${gpgCommand.replaceAll(params.passphrase, '*' * params.passphrase.length)}''', + ); + + final progress = logger.progress('Decrypting keys...'); + + // Verify if the command was executed successfully + final gpgResult = await Process.run('sh', ['-c', gpgCommand]); + + logger.detail(gpgResult.stdout.toString()); + + if (gpgResult.exitCode == 0) { + // Move the extracted files to the current directory + final folder = Directory(outputGpgFilePath.replaceAll('.zip', '')); + + progress.update('Unzipping...'); + + final unzipResult = await Process.run('sh', [ + '-c', + 'unzip -o $outputGpgFilePath -d ${folder.parent.path} && mv ${folder.path}/* ${folder.parent.path}', + ]); + + logger.detail(unzipResult.stdout.toString()); + + if (unzipResult.exitCode != 0) { + progress.fail('Error during the unzip of the file'); + throw ClientException( + 'DecryptKeysUsecase: Error during the unzip ' + 'of the file : ${unzipResult.stderr}', + ); + } + + return progress.complete('Keys decrypted!'); + } else { + progress.fail('Error during the decryption of the GPG file'); + throw ClientException( + 'DecryptKeysUsecase: Error during the decryption ' + 'of the GPG file : ${gpgResult.stderr}', + ); + } + }); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_create_keychain_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_create_keychain_usecase.dart new file mode 100644 index 00000000..b3270636 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_create_keychain_usecase.dart @@ -0,0 +1,49 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_create_keychain_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FastlaneCreateKeychainUsecase + extends ProcessUsecase { + @override + String get onCompletedMessage => 'Keychain created!'; + + @override + String get onErrorMessage => 'Error creating keychain!'; + + @override + String get onStartedMessage => 'Creating keychain...'; + + @override + Future run(FastlaneCreateKeychainParameters param) => + Process.run( + 'fastlane', + [ + 'run', + 'create_keychain', + ...param.toList(), + ], + environment: { + 'MATCH_PASSWORD': param.gitPassphrase, + }, + ); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_pilot_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_pilot_usecase.dart new file mode 100644 index 00000000..6d18670c --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_pilot_usecase.dart @@ -0,0 +1,55 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:convert'; +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_deploy_pilot_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FastlaneDeployPilotUsecase + extends ProcessUsecase { + @override + String get onCompletedMessage => 'Ipa deployed!'; + + @override + String get onErrorMessage => 'Error deploying ipa!'; + + @override + String get onStartedMessage => 'Deploying ipa...'; + + @override + Future run(FastlaneDeployPilotParameters param) async { + final file = File(param.appStoreConnectConfig.keyFilePath!); + final content = file.readAsBytesSync(); + final key = utf8.decode(content); + + const executable = 'fastlane'; + final args = [ + 'run', + 'pilot', + 'api_key:${jsonEncode(param.appStoreConnectConfig.toJson(key))}', + ...param.toList(), + ]; + + logger.detail('Running: $executable ${args.join(' ')}'); + + return Process.run(executable, args); + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_supply_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_supply_usecase.dart new file mode 100644 index 00000000..68e53e67 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_deploy_supply_usecase.dart @@ -0,0 +1,45 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_deploy_supply_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FastlaneDeploySupplyUsecase + extends ProcessUsecase { + @override + String get onCompletedMessage => 'Aab deployed!'; + + @override + String get onErrorMessage => 'Error deploying aab!'; + + @override + String get onStartedMessage => 'Deploying aab...'; + + @override + Future run(FastlaneDeploySupplyParameters param) => + Process.run( + 'fastlane', + [ + 'run', + 'supply', + ...param.toList(), + ], + ); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart new file mode 100644 index 00000000..0141f84c --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart @@ -0,0 +1,49 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FastlaneGetCertificateUsecase + extends ProcessUsecase { + @override + String get onCompletedMessage => 'Certificates fetched!'; + + @override + String get onErrorMessage => 'Error fetching certificates!'; + + @override + String get onStartedMessage => 'Fetching certificates...'; + + @override + Future run(FastlaneGetCertificatesParameters param) => + Process.run( + 'fastlane', + [ + 'run', + 'match', + 'type:appstore', + ...param.toList(), + ], + environment: { + 'MATCH_PASSWORD': param.gitPassphrase, + }, + ); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart new file mode 100644 index 00000000..8e19fdc4 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart @@ -0,0 +1,50 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; +import 'package:wyatt_type_utils/wyatt_type_utils.dart'; + +@usecase +class FindLastIpaFileUsecase extends AsyncUseCase { + const FindLastIpaFileUsecase() : super(); + + @override + FutureOrResult execute(String params) { + final Directory directory = Directory(params); + + if (!directory.existsSync()) { + logger.detail('No IPA file found in $params'); + return Err(ClientException('Directory not found: $params')); + } + + final List files = directory.listSync() + ..sort((a, b) => b.statSync().modified.compareTo(a.statSync().modified)); + + for (final FileSystemEntity file in files) { + if (file.path.endsWith('.ipa')) { + logger.detail('Found IPA file: ${file.path}'); + return Ok(file.path); + } + } + + logger.detail('No IPA file found in $params'); + return Err(ClientException('No IPA file found in $params')); + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_app_bundle_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_app_bundle_usecase.dart new file mode 100644 index 00000000..d2691980 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_app_bundle_usecase.dart @@ -0,0 +1,43 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FlutterBuildAppBundleUsecase extends ProcessUsecase> { + const FlutterBuildAppBundleUsecase(); + + @override + String get onCompletedMessage => 'App bundle built!'; + + @override + String get onErrorMessage => 'Error building app bundle!'; + + @override + String get onStartedMessage => 'Building app bundle...'; + + @override + Future run( + List param, + ) => + Process.run( + 'flutter', + ['build', 'appbundle', '--release', ...param], + ); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_ipa_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_ipa_usecase.dart new file mode 100644 index 00000000..1b651e27 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_ipa_usecase.dart @@ -0,0 +1,43 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FlutterBuildIpaUsecase extends ProcessUsecase> { + const FlutterBuildIpaUsecase(); + + @override + String get onCompletedMessage => 'Ipa built!'; + + @override + String get onErrorMessage => 'Error building ipa!'; + + @override + String get onStartedMessage => 'Building ipa...'; + + @override + Future run( + List param, + ) => + Process.run( + 'flutter', + ['build', 'ipa', '--release', ...param], + ); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_xcarchive_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_xcarchive_usecase.dart new file mode 100644 index 00000000..4ff93d58 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_build_xcarchive_usecase.dart @@ -0,0 +1,40 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FlutterBuildXcarchiveUsecase extends ProcessNoParamsUsecase { + const FlutterBuildXcarchiveUsecase(); + + @override + String get onCompletedMessage => 'Xcarchive built!'; + + @override + String get onErrorMessage => 'Error building xcarchive!'; + + @override + String get onStartedMessage => 'Building xcarchive...'; + + @override + Future run() => Process.run( + 'flutter', + ['build', 'xcarchive', '--no-codesign', '-v'], + ); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_clean_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_clean_usecase.dart new file mode 100644 index 00000000..c3177ace --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_clean_usecase.dart @@ -0,0 +1,40 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FlutterCleanUsecase extends ProcessNoParamsUsecase { + const FlutterCleanUsecase(); + + @override + String get onCompletedMessage => 'Project cleaned!'; + + @override + String get onErrorMessage => 'Error cleaning project!'; + + @override + String get onStartedMessage => 'Cleaning project...'; + + @override + Future run() => Process.run( + 'flutter', + ['clean'], + ); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_pub_get_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_pub_get_usecase.dart new file mode 100644 index 00000000..8372d761 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/flutter/flutter_pub_get_usecase.dart @@ -0,0 +1,37 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/process_usecase.dart'; + +@usecase +class FlutterPubGetUsecase extends ProcessNoParamsUsecase { + const FlutterPubGetUsecase(); + + @override + String get onCompletedMessage => 'Dependencies got!'; + + @override + String get onErrorMessage => 'Error getting dependencies!'; + + @override + String get onStartedMessage => 'Getting dependencies...'; + + @override + Future run() => Process.run('flutter', ['pub', 'get']); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart new file mode 100644 index 00000000..2632e8bb --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart @@ -0,0 +1,93 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; + +abstract class ProcessUsecase extends AsyncUseCase { + const ProcessUsecase(); + + /// If true, the process will not throw an exception if the exit + /// code is not 0. + /// This is useful for commands that may return a non-zero exit code. + /// For example, `git diff` returns 1 if there are differences. + bool get ignoreOnFailure => false; + + String get onStartedMessage; + + String get onCompletedMessage; + + String get onErrorMessage; + + @override + FutureOr> execute(T params) async { + final progress = logger.progress(onStartedMessage); + final processResult = await run(params); + if (processResult != null) { + if (processResult.exitCode != 0) { + progress.fail(onErrorMessage); + } + if (processResult.exitCode != 0 && !ignoreOnFailure) { + throw ClientException(processResult.stderr.toString()); + } + } + progress.complete(onCompletedMessage); + logger.detail(processResult?.stdout.toString().trim()); + return Res.ok(null); + } + + /// Run the process with the given parameters. + Future run(T param); +} + +abstract class ProcessNoParamsUsecase extends NoParamsAsyncUseCase { + const ProcessNoParamsUsecase() : super(); + + /// If true, the process will not throw an exception if the exit + /// code is not 0. + /// This is useful for commands that may return a non-zero exit code. + /// For example, `git diff` returns 1 if there are differences. + bool get ignoreOnFailure => false; + + String get onStartedMessage; + + String get onCompletedMessage; + + String get onErrorMessage; + + @override + FutureOr> execute() async { + final progress = logger.progress(onStartedMessage); + final processResult = await run(); + if (processResult != null) { + if (processResult.exitCode != 0) { + progress.fail(onErrorMessage); + } + if (processResult.exitCode != 0 && !ignoreOnFailure) { + throw ClientException(processResult.stderr.toString()); + } + } + progress.complete(onCompletedMessage); + logger.detail(processResult?.stdout.toString().trim()); + return Res.ok(null); + } + + /// Run the process with no parameters. + Future run(); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart new file mode 100644 index 00000000..c6d11b54 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart @@ -0,0 +1,35 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; + +@usecase +class CheckConfigFileUsecase extends AsyncUseCase { + const CheckConfigFileUsecase() : super(); + + @override + FutureOrResult execute(String params) => unsafe(() { + final configFile = File(params); + if (!configFile.existsSync()) { + throw ClientException( + 'CheckConfigFileUsecase: Cannot find $params', + ); + } + }); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart new file mode 100644 index 00000000..b826b2f6 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart @@ -0,0 +1,50 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; + +@usecase +class CheckToolsUsecase extends NoParamsAsyncUseCase { + const CheckToolsUsecase() : super(); + + @override + FutureOr> execute() async => unsafe(() async { + final missingTools = []; + for (final tool in AppConstants.requiredTools) { + final isInstalled = await checkToolInstalled(tool); + if (!isInstalled) { + missingTools.add(tool); + } + } + + if (missingTools.isNotEmpty) { + throw ClientException( + 'CheckToolsUsecase: Missing ${missingTools.join(' - ')}', + ); + } + }); + + Future checkToolInstalled(String tool) async { + final result = await Process.run('which', [tool]); + + return result.exitCode == 0 && (result.stdout as String).trim().isNotEmpty; + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecases.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecases.dart new file mode 100644 index 00000000..7308ff35 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecases.dart @@ -0,0 +1,33 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +export 'config/get_android_config_usecase.dart'; +export 'config/get_ios_config_usecase.dart'; +export 'config/init_config_usecase.dart'; +export 'decrypt_keys/decrypt_keys_usecase.dart'; +export 'fastlane/fastlane_create_keychain_usecase.dart'; +export 'fastlane/fastlane_deploy_pilot_usecase.dart'; +export 'fastlane/fastlane_deploy_supply_usecase.dart'; +export 'fastlane/fastlane_get_certificates_usecase.dart'; +export 'find_last_ipa_file_usecase.dart'; +export 'flutter/flutter_build_app_bundle_usecase.dart'; +export 'flutter/flutter_build_ipa_usecase.dart'; +export 'flutter/flutter_build_xcarchive_usecase.dart'; +export 'flutter/flutter_clean_usecase.dart'; +export 'flutter/flutter_pub_get_usecase.dart'; +export 'process_usecase.dart'; +export 'requirements/check_config_file_usecase.dart'; +export 'requirements/check_tools_usecase.dart'; diff --git a/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart new file mode 100644 index 00000000..f3f484ce --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart @@ -0,0 +1,23 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:mason_logger/mason_logger.dart'; + +export 'domain/domain.dart'; + +abstract class WyattContinuousDeployment { + static Logger logger = Logger(); +} diff --git a/packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart b/packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart new file mode 100644 index 00000000..fc963fd9 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart @@ -0,0 +1,20 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +/// Wyatt CD +library wyatt_continuous_deployment; + +export 'src/wyatt_continuous_deployment.dart'; diff --git a/packages/wyatt_continuous_deployment/pubspec.yaml b/packages/wyatt_continuous_deployment/pubspec.yaml new file mode 100644 index 00000000..5398fb8b --- /dev/null +++ b/packages/wyatt_continuous_deployment/pubspec.yaml @@ -0,0 +1,36 @@ +name: wyatt_continuous_deployment +description: Wyatt CD. +repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_continuous_deployment +version: 1.0.0 + +publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub + +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + checked_yaml: ^2.0.3 + get_it: ^7.6.7 + injectable: ^2.3.2 + json_annotation: ^4.8.1 + mason_logger: ^0.2.12 + wyatt_architecture: + hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/ + version: ^0.2.0+1 + wyatt_type_utils: + hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub + version: ^0.0.5 + yaml: ^3.1.2 + yaml_edit: ^2.1.1 + +dev_dependencies: + build_runner: ^2.4.8 + dart_code_linter: ^1.1.1 + + injectable_generator: ^2.4.1 + json_serializable: ^6.7.1 + test: ^1.21.0 + + wyatt_analysis: + hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub + version: ^2.6.1 diff --git a/packages/wyatt_continuous_deployment/test/wyatt_continuous_deployment_test.dart b/packages/wyatt_continuous_deployment/test/wyatt_continuous_deployment_test.dart new file mode 100644 index 00000000..3a06c0e1 --- /dev/null +++ b/packages/wyatt_continuous_deployment/test/wyatt_continuous_deployment_test.dart @@ -0,0 +1 @@ +// TODO(wyatt): add some tests -- 2.47.2 From 1492745e54faebcfc2ad869d7821c14d25b01118 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Sun, 18 Feb 2024 23:00:01 +0100 Subject: [PATCH 04/14] docs(wyatt_architecture): update readme --- packages/wyatt_architecture/README.md | 58 ++++++++++++++++++--------- 1 file changed, 39 insertions(+), 19 deletions(-) diff --git a/packages/wyatt_architecture/README.md b/packages/wyatt_architecture/README.md index e077fbec..657355cb 100644 --- a/packages/wyatt_architecture/README.md +++ b/packages/wyatt_architecture/README.md @@ -50,10 +50,10 @@ class Photo extends Entity { } ``` -Then create the data sources by extending `BaseLocalDataSource` or `BaseRemoteDataSource` depending the type of data source. +Then create the data sources by extending `BaseDataSource` : ```dart -abstract class PhotoRemoteDataSource extends BaseRemoteDataSource { +abstract class PhotoRemoteDataSource extends BaseDataSource { Future getPhoto(int id); Future> getAllPhotos({int? start, int? limit}); } @@ -78,14 +78,31 @@ Several use cases are supported : * Classic usecase : ```dart -class Test extends AsyncUseCase>> { +class RetrieveAllAlbums extends AsyncUseCase> { + const RetrieveAllAlbums(this._photoRepository); + final PhotoRepository _photoRepository; @override - FuturOrResult>> call(QueryParameters? params) { - final photos = _photoRepository.getAllPhotos( + FutureOrResult> execute(QueryParameters params) { + final albums = _photoRepository.getAllAlbums( start: params.start, limit: params.limit, ); + return albums; + } +} +``` + +* No parameter usecase : + +```dart +class DisplayFavorites extends NoParamsAsyncUseCase> { + const DisplayFavorites(this._photoRepository); + final PhotoRepository _photoRepository; + + @override + FutureOrResult> execute() { + final photos = _photoRepository.getAllPhotosFromFavorites(); return photos; } } @@ -94,48 +111,51 @@ class Test extends AsyncUseCase>> { You can add alternatve scenarios and check pre/post conditions using our extensions : ```dart -class SearchPhotos extends AsyncUseCase>> { +class RetrieveAllAlbums extends AsyncUseCase> { + const RetrieveAllAlbums(this._photoRepository); + final PhotoRepository _photoRepository; @override - FutureOrResult>> call(QueryParameters? params) { - final photos = _photoRepository.getAllPhotos( + FutureOrResult> execute(QueryParameters params) { + final albums = _photoRepository.getAllAlbums( start: params.start, limit: params.limit, ); - return photos; + return albums; } @override FutureOr onStart(QueryParameters? params) { - if(params.start == null || params.limit == null){ - throw ClientException('Préconndition non valides'); + if (params.start < 0) { + throw const ClientException('Invalid start parameter'); } } - } ``` -You can implement error scenarios overriding `onError` , or check postconditions by overriding `onComplete` . +You can implement error scenarios overriding `onException` , or check postconditions by overriding `onComplete` . * Stream usecase : ```dart -class SearchPhotos extends StreamUseCase>> { +class RetrieveAllAlbums extends AsyncUseCase> { + const RetrieveAllAlbums(this._photoRepository); + final PhotoRepository _photoRepository; @override - FutureOrResult>>> call(QueryParameters? params) { - final photos = _photoRepository.getAllPhotos( + FutureOrResult> execute(QueryParameters params) { + final albums = _photoRepository.getAllAlbums( start: params.start, limit: params.limit, ); - return photos; + return albums; } + @override + FutureOrResult> onException(Object e) => Ok([]); } ``` -On this case, observers allow you to add alternative scenarios when data changed, overriding `onData` or `onDone` . - Please note that to use handlers, call `call` method and not `execute` . > In fact, here we need a new parameter object, so let's create it: -- 2.47.2 From 995e122c1b19de579d407c6b2ec8443f9d913d4f Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Sun, 18 Feb 2024 23:20:30 +0100 Subject: [PATCH 05/14] fix(wyatt_cd): make getIt initializable --- .../lib/src/wyatt_continuous_deployment.dart | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart index f3f484ce..dc040b78 100644 --- a/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart +++ b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart @@ -14,10 +14,23 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . +import 'package:get_it/get_it.dart'; import 'package:mason_logger/mason_logger.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; export 'domain/domain.dart'; abstract class WyattContinuousDeployment { + /// The logger used by the package static Logger logger = Logger(); + + /// The service locator used by the package + static GetIt getIt = GetIt.instance; + + /// Configure the dependencies + /// This method should be called before WyattContinuousDeployment.getIt + /// to ensure that all dependencies are registered + static Future configureDependencies() async { + await Injectable.configureDependencies(); + } } -- 2.47.2 From 3706ab8f1c0f1ea63710b06f26f9390c8d796eaa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Malo=20L=C3=A9on?= Date: Mon, 19 Feb 2024 12:57:59 +0000 Subject: [PATCH 06/14] chore(wyatt_continuous_deployment): migrate the all CLI as package --- .../example/lib/main.dart | 2 +- .../lib/src/bootstrap.dart | 26 ++++ .../build_and_deploy_app_command.dart | 36 +++++ .../build_and_deploy_android_app_command.dart | 32 +++++ .../build_and_deploy_android_app_task.dart | 50 +++++++ .../build_and_deploy_ios_app_command.dart | 31 ++++ .../build_and_deploy_ios_app_task.dart | 50 +++++++ .../commands/build_app/build_app_command.dart | 35 +++++ .../commands/build_app/build_app_states.dart | 32 +++++ .../commands/build_app/build_app_task.dart | 57 ++++++++ .../build_app_bundle_command.dart | 31 ++++ .../build_app_bundle_state.dart | 32 +++++ .../build_app_bundle_task.dart | 91 ++++++++++++ .../commands/build_ipa/build_ipa_command.dart | 31 ++++ .../commands/build_ipa/build_ipa_state.dart | 47 +++++++ .../commands/build_ipa/build_ipa_task.dart | 133 ++++++++++++++++++ .../lib/src/core/commands/commands.dart | 20 +++ .../deploy_android_command.dart | 31 ++++ .../deploy_android/deploy_android_state.dart | 27 ++++ .../deploy_android/deploy_android_task.dart | 84 +++++++++++ .../deploy_ios/deploy_ios_command.dart | 31 ++++ .../commands/deploy_ios/deploy_ios_state.dart | 42 ++++++ .../commands/deploy_ios/deploy_ios_task.dart | 118 ++++++++++++++++ .../deploy_app/deploy_app_command.dart | 35 +++++ .../init_project/init_project_command.dart | 39 +++++ .../init_project/init_project_state.dart | 28 ++++ .../init_project/init_project_task.dart | 85 +++++++++++ .../lib/src/core/commands/task_command.dart | 80 +++++++++++ .../lib/src/core/constants/app_constants.dart | 7 + .../lib/src/core/core.dart | 17 +++ .../lib/src/core/enums/flag.dart | 50 +++++++ .../src/core/extensions/object_extension.dart | 23 +++ .../lib/src/core/task/task_cubit.dart | 90 ++++++++++++ .../lib/src/core/task/task_state.dart | 85 +++++++++++ .../lib/src/core/utils/logging.dart | 5 +- .../lib/src/core/utils/task_observer.dart | 36 +++++ .../lib/src/domain/entities/context.dart | 33 +++++ .../lib/src/domain/entities/flutter.dart | 6 +- .../config/get_android_config_usecase.dart | 14 +- .../config/get_ios_config_usecase.dart | 12 +- .../usecases/config/init_config_usecase.dart | 15 +- .../decrypt_keys/decrypt_keys_usecase.dart | 18 ++- .../usecases/find_last_ipa_file_usecase.dart | 14 +- .../src/domain/usecases/process_usecase.dart | 19 ++- .../check_config_file_usecase.dart | 15 +- .../requirements/check_tools_usecase.dart | 3 +- .../lib/src/domain/usecases/usecase.dart | 34 +++++ .../lib/src/version.dart | 1 + .../lib/src/wyatt_continuous_deployment.dart | 22 +-- ..._continuous_deployment_command_runner.dart | 110 +++++++++++++++ .../lib/wyatt_continuous_deployment.dart | 3 +- .../wyatt_continuous_deployment/pubspec.yaml | 4 + 52 files changed, 1924 insertions(+), 48 deletions(-) create mode 100644 packages/wyatt_continuous_deployment/lib/src/bootstrap.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/build_and_deploy_app_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_states.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_state.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_state.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/commands.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_state.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_state.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/deploy_app_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_state.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/commands/task_command.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/core.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/enums/flag.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/extensions/object_extension.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/task/task_state.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/core/utils/task_observer.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/entities/context.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/version.dart create mode 100644 packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment_command_runner.dart diff --git a/packages/wyatt_continuous_deployment/example/lib/main.dart b/packages/wyatt_continuous_deployment/example/lib/main.dart index d3342cf8..6eb17eda 100644 --- a/packages/wyatt_continuous_deployment/example/lib/main.dart +++ b/packages/wyatt_continuous_deployment/example/lib/main.dart @@ -20,7 +20,7 @@ class WyattContinuousDeploymentExample { static Future run(List args) async { const useCase = CheckToolsUsecase(); - final result = await useCase(); + final result = await useCase(null); result.fold((value) => print('Success'), (error) => print('Error: $error')); } diff --git a/packages/wyatt_continuous_deployment/lib/src/bootstrap.dart b/packages/wyatt_continuous_deployment/lib/src/bootstrap.dart new file mode 100644 index 00000000..33660195 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/bootstrap.dart @@ -0,0 +1,26 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:bloc/bloc.dart'; +import 'package:mason_logger/mason_logger.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/task_observer.dart'; + +Future bootstrap([Logger? logger]) async { + getIt.registerSingleton(logger ?? Logger()); + await Injectable.configureDependencies(); + Bloc.observer = TaskObserver(); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/build_and_deploy_app_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/build_and_deploy_app_command.dart new file mode 100644 index 00000000..e95b779d --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/build_and_deploy_app_command.dart @@ -0,0 +1,36 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:args/command_runner.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_command.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_command.dart'; + +class BuildAndDeployAppCommand extends Command { + BuildAndDeployAppCommand() { + addSubcommand(BuildAndDeployIosAppCommand()); + addSubcommand(BuildAndDeployAndroidAppCommand()); + } + + @override + String get description => 'Build and deploy app. ' + 'Same as running `build` and `deploy` commands separately.'; + + @override + String get name => 'build-deploy'; + + @override + List get aliases => ['bd']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_command.dart new file mode 100644 index 00000000..8aeb749c --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_command.dart @@ -0,0 +1,32 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/task_command.dart'; + +class BuildAndDeployAndroidAppCommand extends TaskCommand { + BuildAndDeployAndroidAppCommand() + : super(task: BuildAndDeployAndroidAppTask()); + + @override + String get description => 'Build and deploy Android app'; + + @override + String get name => 'android'; + + @override + List get aliases => ['a', 'playstore']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_task.dart new file mode 100644 index 00000000..e52cd52d --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_android_app/build_and_deploy_android_app_task.dart @@ -0,0 +1,50 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/deploy_app/commands/deploy_android/deploy_android_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; + +class BuildAndDeployAndroidAppTask extends TaskCubit { + factory BuildAndDeployAndroidAppTask() => BuildAndDeployAndroidAppTask._( + checkToolsUsecase: getIt(), + checkConfigFileUsecase: getIt(), + ); + + BuildAndDeployAndroidAppTask._({ + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }); + + @override + Future onRun(Context ctx) async { + // 1. Build Android app + final buildAppBundleTask = BuildAppBundleTask(); + await buildAppBundleTask.onRun(ctx); + if (buildAppBundleTask.status != 0) { + return emit(buildAppBundleTask.state); + } + + // 2. Deploy it + final deployAndroidTask = DeployAndroidTask(); + await deployAndroidTask.onRun(ctx); + if (deployAndroidTask.status != 0) { + return emit(deployAndroidTask.state); + } + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_command.dart new file mode 100644 index 00000000..8b9b7dcd --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_command.dart @@ -0,0 +1,31 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/task_command.dart'; + +class BuildAndDeployIosAppCommand extends TaskCommand { + BuildAndDeployIosAppCommand() : super(task: BuildAndDeployIosAppTask()); + + @override + String get description => 'Build and deploy IOS app'; + + @override + String get name => 'ios'; + + @override + List get aliases => ['i', 'appstore']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_task.dart new file mode 100644 index 00000000..3cb656b1 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_and_deploy_app/commands/build_and_deploy_ios_app/build_and_deploy_ios_app_task.dart @@ -0,0 +1,50 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; + +class BuildAndDeployIosAppTask extends TaskCubit { + factory BuildAndDeployIosAppTask() => BuildAndDeployIosAppTask._( + checkToolsUsecase: getIt(), + checkConfigFileUsecase: getIt(), + ); + + BuildAndDeployIosAppTask._({ + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }); + + @override + Future onRun(Context ctx) async { + // 1. Build ipa + final buildIpaTask = BuildIpaTask(); + await buildIpaTask.onRun(ctx); + if (buildIpaTask.status != 0) { + return emit(buildIpaTask.state); + } + + // 2. Deploy it + final deployIosTask = DeployIosTask(); + await deployIosTask.onRun(ctx); + if (deployIosTask.status != 0) { + return emit(deployIosTask.state); + } + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_command.dart new file mode 100644 index 00000000..18c626f7 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_command.dart @@ -0,0 +1,35 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:args/command_runner.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_command.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/commands/build_ipa/build_ipa_command.dart'; + +class BuildAppCommand extends Command { + BuildAppCommand() { + addSubcommand(BuildAppBundleCommand()); + addSubcommand(BuildIpaCommand()); + } + + @override + String get description => 'Build the app'; + + @override + String get name => 'build'; + + @override + List get aliases => ['b']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_states.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_states.dart new file mode 100644 index 00000000..34adf766 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_states.dart @@ -0,0 +1,32 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +part of 'build_app_task.dart'; + +class BuildAppTaskFlutterClean extends TaskStateRunning { + @override + String get description => 'Clean flutter workspace'; +} + +class BuildAppTaskFlutterPubGet extends TaskStateRunning { + @override + String get description => 'Get dependencies'; +} + +class BuildAppTaskBuildApp extends TaskStateRunning { + @override + String get description => 'Build app'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_task.dart new file mode 100644 index 00000000..6e42d086 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/build_app_task.dart @@ -0,0 +1,57 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/flutter.dart'; + +part 'build_app_states.dart'; + +abstract class BuildAppTask extends TaskCubit { + BuildAppTask({ + required this.flutter, + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }); + + final Flutter flutter; + + FutureOr buildApp(Context ctx); + + @override + Future onRun(Context ctx) async { + emit(BuildAppTaskFlutterClean()); + + final flutterCleanResult = await flutter.clean(); + if (flutterCleanResult.isErr) { + return emit(TaskStateError(message: flutterCleanResult.err.toString())); + } + + emit(BuildAppTaskFlutterPubGet()); + + final flutterGetDependenciesResult = await flutter.getDependencies(); + if (flutterGetDependenciesResult.isErr) { + return emit( + TaskStateError(message: flutterGetDependenciesResult.err.toString()), + ); + } + + emit(BuildAppTaskBuildApp()); + await buildApp(ctx); + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_command.dart new file mode 100644 index 00000000..2f86db8d --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_command.dart @@ -0,0 +1,31 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/task_command.dart'; + +class BuildAppBundleCommand extends TaskCommand { + BuildAppBundleCommand() : super(task: BuildAppBundleTask()); + + @override + String get description => 'Build the Android app bundle'; + + @override + String get name => 'appbundle'; + + @override + List get aliases => ['a', 'aab', 'android']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_state.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_state.dart new file mode 100644 index 00000000..952af2ff --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_state.dart @@ -0,0 +1,32 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +part of 'build_app_bundle_task.dart'; + +class BuildAppBundleStateGetAndroidConfig extends TaskStateRunning { + @override + String get description => 'Get android config'; +} + +class BuildAppBundleStateDecryptAndroidKeys extends TaskStateRunning { + @override + String get description => 'Decrypt android keys'; +} + +class BuildAppBundleStateBuildAppBundle extends TaskStateRunning { + @override + String get description => 'Build App Bundle'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_task.dart new file mode 100644 index 00000000..bd821b74 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_app_bundle/build_app_bundle_task.dart @@ -0,0 +1,91 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/build_app_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/decrypt_keys_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/get_android_config_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart'; + +part 'build_app_bundle_state.dart'; + +class BuildAppBundleTask extends BuildAppTask { + factory BuildAppBundleTask() => BuildAppBundleTask._( + flutter: getIt(), + decryptKeysUsecase: getIt(), + getAndroidConfigUsecase: getIt(), + checkToolsUsecase: getIt(), + checkConfigFileUsecase: getIt(), + ); + + BuildAppBundleTask._({ + required DecryptKeysUsecase decryptKeysUsecase, + required GetAndroidConfigUsecase getAndroidConfigUsecase, + required super.flutter, + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }) : _decryptKeysUsecase = decryptKeysUsecase, + _getAndroidConfigUsecase = getAndroidConfigUsecase; + + final DecryptKeysUsecase _decryptKeysUsecase; + final GetAndroidConfigUsecase _getAndroidConfigUsecase; + + @override + FutureOr buildApp(Context ctx) async { + emit(BuildAppBundleStateGetAndroidConfig()); + + // 1. Get Android config + final getAndroidConfigResult = + await _getAndroidConfigUsecase(ctx.configFile.path); + if (getAndroidConfigResult.isErr) { + return emit( + TaskStateError(message: getAndroidConfigResult.err.toString()), + ); + } + + // 2. Decrypt Android keys + emit(BuildAppBundleStateDecryptAndroidKeys()); + final decryptAndroidkeysResult = await _decryptKeysUsecase( + DecryptKeysParameters( + encryptedFilePath: getAndroidConfigResult.ok!.encryptedKeyFile.path, + passphrase: ctx.environment[AppConstants.androidKeysSecretPassphrase] + .toString(), + ), + ); + if (decryptAndroidkeysResult.isErr) { + return emit( + TaskStateError(message: decryptAndroidkeysResult.err.toString()), + ); + } + + // 3. Build Android App Bundle + emit(BuildAppBundleStateBuildAppBundle()); + final buildAppBundleResult = await flutter + .buildAppBundle(getAndroidConfigResult.ok!.flutterArgs.split(' ')); + if (buildAppBundleResult.isErr) { + return emit( + TaskStateError(message: decryptAndroidkeysResult.err.toString()), + ); + } + + emit(const TaskStateSucceed()); + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_command.dart new file mode 100644 index 00000000..814b6a2f --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_command.dart @@ -0,0 +1,31 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/task_command.dart'; + +class BuildIpaCommand extends TaskCommand { + BuildIpaCommand() : super(task: BuildIpaTask()); + + @override + String get description => 'Build the iOS IPA'; + + @override + String get name => 'ipa'; + + @override + List get aliases => ['i', 'ios']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_state.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_state.dart new file mode 100644 index 00000000..9c36dd03 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_state.dart @@ -0,0 +1,47 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +part of 'build_ipa_task.dart'; + +class BuildIpaStateGetIosConfig extends TaskStateRunning { + @override + String get description => 'Get iOS config'; +} + +class BuildIpaStateDecryptIosKey extends TaskStateRunning { + @override + String get description => 'Decrypt ios keys'; +} + +class BuildIpaStateRetrieveIosKey extends TaskStateRunning { + @override + String get description => 'Retrieve ios keys'; +} + +class BuildIpaStateCreateKeychain extends TaskStateRunning { + @override + String get description => 'Create new keychain'; +} + +class BuildIpaStateRetrieveCertificates extends TaskStateRunning { + @override + String get description => 'Retrieve match certificates'; +} + +class BuildIpaStateBuildIpa extends TaskStateRunning { + @override + String get description => 'Build ipa'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart new file mode 100644 index 00000000..bf7f9402 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart @@ -0,0 +1,133 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:wyatt_continuous_deployment/src/core/commands/build_app/build_app_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/decrypt_keys_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_create_keychain_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/get_ios_config_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart'; + +part 'build_ipa_state.dart'; + +class BuildIpaTask extends BuildAppTask { + factory BuildIpaTask() => BuildIpaTask._( + flutter: getIt(), + fastlane: getIt(), + decryptKeysUsecase: getIt(), + getIosConfigUsecase: getIt(), + checkToolsUsecase: getIt(), + checkConfigFileUsecase: getIt(), + ); + + BuildIpaTask._({ + required DecryptKeysUsecase decryptKeysUsecase, + required GetIosConfigUsecase getIosConfigUsecase, + required Fastlane fastlane, + required super.flutter, + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }) : _decryptKeysUsecase = decryptKeysUsecase, + _getIosConfigUsecase = getIosConfigUsecase, + _fastlane = fastlane; + + final DecryptKeysUsecase _decryptKeysUsecase; + final GetIosConfigUsecase _getIosConfigUsecase; + final Fastlane _fastlane; + + @override + FutureOr buildApp(Context ctx) async { + // 1. Get iOS Config + emit(BuildIpaStateGetIosConfig()); + final getIosConfigResult = await _getIosConfigUsecase(ctx.configFile.path); + if (getIosConfigResult.isErr) { + return emit( + TaskStateError(message: getIosConfigResult.err.toString()), + ); + } + + // 2. Decrypt iOS keys + emit(BuildIpaStateDecryptIosKey()); + final decryptIosKeyResult = await _decryptKeysUsecase( + DecryptKeysParameters( + encryptedFilePath: getIosConfigResult.ok!.encryptedKeyFile.path, + passphrase: + ctx.environment[AppConstants.iosKeysSecretPassphrase].toString(), + ), + ); + if (decryptIosKeyResult.isErr) { + return emit( + TaskStateError(message: decryptIosKeyResult.err.toString()), + ); + } + + // 5. Create Keychain + emit(BuildIpaStateCreateKeychain()); + final fastlaneCreateKeychainResult = await _fastlane.createKeychain( + FastlaneCreateKeychainParameters( + name: 'match', + password: 'flutter-cd-cli', + gitPassphrase: getIosConfigResult.ok!.gitPassphrase, + ), + ); + if (fastlaneCreateKeychainResult.isErr) { + return emit( + TaskStateError(message: fastlaneCreateKeychainResult.err.toString()), + ); + } + + // 6. Retrieve certificates + emit(BuildIpaStateRetrieveCertificates()); + final fastlaneGetCertificateResult = await _fastlane.getCertificates( + FastlaneGetCertificatesParameters( + appIdentifier: getIosConfigResult.ok!.developerAppIdentifier, + gitPrivateKey: + '${getIosConfigResult.ok!.iosFolderPath}/${getIosConfigResult.ok!.gitCertsPrivateKeyFileName}', + keychainName: 'match', + keychainPassword: 'flutter-cd-cli', + userName: getIosConfigResult.ok!.userName, + teamId: getIosConfigResult.ok!.teamId, + teamName: getIosConfigResult.ok!.teamName, + gitUrl: getIosConfigResult.ok!.gitUrl, + gitPassphrase: getIosConfigResult.ok!.gitPassphrase, + ), + ); + if (fastlaneGetCertificateResult.isErr) { + return emit( + TaskStateError(message: fastlaneGetCertificateResult.err.toString()), + ); + } + + // 7. Build IPA + emit(BuildIpaStateBuildIpa()); + final flutterBuildIpaResult = + await flutter.buildIpa(getIosConfigResult.ok!.flutterArgs.split(' ')); + if (flutterBuildIpaResult.isErr) { + return emit( + TaskStateError(message: flutterBuildIpaResult.err.toString()), + ); + } + + emit(const TaskStateSucceed()); + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/commands.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/commands.dart new file mode 100644 index 00000000..4bbeb7a8 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/commands.dart @@ -0,0 +1,20 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +export './build_and_deploy_app/build_and_deploy_app_command.dart'; +export './build_app/build_app_command.dart'; +export './deploy_app/deploy_app_command.dart'; +export './init_project/init_project_command.dart'; diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_command.dart new file mode 100644 index 00000000..6b2f97bd --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_command.dart @@ -0,0 +1,31 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/deploy_app/commands/deploy_android/deploy_android_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/task_command.dart'; + +class DeployAndroidCommand extends TaskCommand { + DeployAndroidCommand() : super(task: DeployAndroidTask()); + + @override + String get description => 'Deploy the android app on the play store'; + + @override + String get name => 'android'; + + @override + List get aliases => ['a', 'playstore']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_state.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_state.dart new file mode 100644 index 00000000..96f1a90e --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_state.dart @@ -0,0 +1,27 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +part of 'deploy_android_task.dart'; + +class DeployAndroidStateDeployToPlayStore extends TaskStateRunning { + @override + String get description => 'Upload appbundle to Play Store'; +} + +class DeployAndroidStateGetAndroidConfig extends TaskStateRunning { + @override + String get description => 'Get android options'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_task.dart new file mode 100644 index 00000000..9fd1b266 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_android/deploy_android_task.dart @@ -0,0 +1,84 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_deploy_supply_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/get_android_config_usecase.dart'; + +part 'deploy_android_state.dart'; + +class DeployAndroidTask extends TaskCubit { + factory DeployAndroidTask() => DeployAndroidTask._( + getAndroidConfigUsecase: getIt(), + fastlane: getIt(), + checkToolsUsecase: getIt(), + checkConfigFileUsecase: getIt(), + ); + + DeployAndroidTask._({ + required GetAndroidConfigUsecase getAndroidConfigUsecase, + required Fastlane fastlane, + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }) : _getAndroidConfigUsecase = getAndroidConfigUsecase, + _fastlane = fastlane; + + final GetAndroidConfigUsecase _getAndroidConfigUsecase; + final Fastlane _fastlane; + + @override + Future onRun(Context ctx) async { + // 1. Get Android Config + emit(DeployAndroidStateGetAndroidConfig()); + + final getAndroidConfigResult = + await _getAndroidConfigUsecase(ctx.configFile.path); + if (getAndroidConfigResult.isErr) { + return emit( + TaskStateError( + message: getAndroidConfigResult.err.toString(), + ), + ); + } + + // 2. Deploy to Play Store + emit(DeployAndroidStateDeployToPlayStore()); + final deploySupplyResult = await _fastlane.deployGooglePlay( + FastlaneDeploySupplyParameters( + packageName: getAndroidConfigResult.ok!.packageName.toString(), + track: getAndroidConfigResult.ok!.track, + serviceAccountPath: + '${getAndroidConfigResult.ok!.androidFolderPath}/${getAndroidConfigResult.ok!.googleServiceAccountFileName}', + appBundlePath: AppConstants.androidBundleBuildPath, + releaseStatus: getAndroidConfigResult.ok!.releaseStatus, + ), + ); + + if (deploySupplyResult.isErr) { + return emit( + TaskStateError( + message: deploySupplyResult.err.toString(), + ), + ); + } + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_command.dart new file mode 100644 index 00000000..72be263c --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_command.dart @@ -0,0 +1,31 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/task_command.dart'; + +class DeployIosCommand extends TaskCommand { + DeployIosCommand() : super(task: DeployIosTask()); + + @override + String get description => 'Deploy the ios app on the AppStore connect'; + + @override + String get name => 'ios'; + + @override + List get aliases => ['i', 'appstore']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_state.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_state.dart new file mode 100644 index 00000000..9bee3d42 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_state.dart @@ -0,0 +1,42 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +part of 'deploy_ios_task.dart'; + +class DeployIosStateGetIosConfig extends TaskStateRunning { + @override + String get description => 'Get iOS config'; +} + +class DeployIosStatedecryptIosKeys extends TaskStateRunning { + @override + String get description => 'Decrypt ios keys'; +} + +class DeployIosStateRetrieveIosKey extends TaskStateRunning { + @override + String get description => 'Retrieve ios keys'; +} + +class DeployIosStateCheckRequiredIosKey extends TaskStateRunning { + @override + String get description => 'Check if all required keys exist'; +} + +class DeployIosStateDeployToAppStoreConnect extends TaskStateRunning { + @override + String get description => 'Upload ipa to AppStore Connect'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_task.dart new file mode 100644 index 00000000..46ce7b67 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_task.dart @@ -0,0 +1,118 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/config/appstore_connect_config.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/decrypt_keys_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/fastlane/fastlane_deploy_pilot_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/get_ios_config_usecase.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart'; + +part 'deploy_ios_state.dart'; + +class DeployIosTask extends TaskCubit { + factory DeployIosTask() => DeployIosTask._( + getIosConfigUsecase: getIt(), + decryptKeysUsecase: getIt(), + fastlane: getIt(), + checkToolsUsecase: getIt(), + checkConfigFileUsecase: getIt(), + ); + + DeployIosTask._({ + required GetIosConfigUsecase getIosConfigUsecase, + required DecryptKeysUsecase decryptKeysUsecase, + required Fastlane fastlane, + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }) : _getIosConfigUsecase = getIosConfigUsecase, + _decryptKeysUsecase = decryptKeysUsecase, + _fastlane = fastlane; + + final GetIosConfigUsecase _getIosConfigUsecase; + final DecryptKeysUsecase _decryptKeysUsecase; + final Fastlane _fastlane; + + @override + Future onRun(Context ctx) async { + // 1. Get iOS config + emit(DeployIosStateGetIosConfig()); + final getIosConfigResult = await _getIosConfigUsecase(ctx.configFile.path); + if (getIosConfigResult.isErr) { + return emit( + TaskStateError(message: getIosConfigResult.err.toString()), + ); + } + + // 2. Decrypt iOS keys + emit(DeployIosStatedecryptIosKeys()); + final decryptIosKeyResult = await _decryptKeysUsecase( + DecryptKeysParameters( + encryptedFilePath: getIosConfigResult.ok!.encryptedKeyFile.path, + passphrase: + ctx.environment[AppConstants.iosKeysSecretPassphrase].toString(), + ), + ); + if (decryptIosKeyResult.isErr) { + return emit(TaskStateError(message: decryptIosKeyResult.err.toString())); + } + + // 5. Deploy to AppStore Connect + emit(DeployIosStateDeployToAppStoreConnect()); + final deployResult = await _fastlane.deployAppStore( + FastlaneDeployPilotParameters( + appStoreConnectConfig: AppStoreConnectConfig.fromConfig( + getIosConfigResult.ok!, + ), + developerAppId: getIosConfigResult.ok!.developerAppId, + developerAppIdentifier: getIosConfigResult.ok!.developerAppIdentifier, + ipaPath: _findFirstIpaFilePath('build/ios/ipa') ?? '', + ), + ); + if (deployResult.isErr) { + return emit(TaskStateError(message: deployResult.err.toString())); + } + } + + String? _findFirstIpaFilePath(String folderPath) { + final Directory directory = Directory(folderPath); + + if (!directory.existsSync()) { + logger.detail('No IPA file found in $folderPath'); + return null; + } + + final List files = directory.listSync(); + + for (final FileSystemEntity file in files) { + if (file is File && file.path.endsWith('.ipa')) { + logger.detail('Found IPA file: ${file.path}'); + return file.path; + } + } + + logger.detail('No IPA file found in $folderPath'); + return null; + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/deploy_app_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/deploy_app_command.dart new file mode 100644 index 00000000..e30c05e8 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/deploy_app/deploy_app_command.dart @@ -0,0 +1,35 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:args/command_runner.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/deploy_app/commands/deploy_android/deploy_android_command.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/deploy_app/commands/deploy_ios/deploy_ios_command.dart'; + +class DeployAppCommand extends Command { + DeployAppCommand() { + addSubcommand(DeployAndroidCommand()); + addSubcommand(DeployIosCommand()); + } + + @override + String get description => 'Deploy the app'; + + @override + String get name => 'deploy'; + + @override + List get aliases => ['d']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_command.dart new file mode 100644 index 00000000..a7be2ab7 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_command.dart @@ -0,0 +1,39 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_continuous_deployment/src/core/commands/init_project/init_project_task.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/task_command.dart'; +import 'package:wyatt_continuous_deployment/src/core/enums/flag.dart'; + +class InitProjectCommand extends TaskCommand { + InitProjectCommand() : super(task: InitProjectTask()) { + argParser.addFlag( + Flag.force.name, + abbr: Flag.force.abbr, + help: 'Force the initialization', + negatable: false, + ); + } + + @override + String get description => 'Initialize the project'; + + @override + String get name => 'init'; + + @override + List get aliases => ['i', 'initialize']; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_state.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_state.dart new file mode 100644 index 00000000..f80d2464 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_state.dart @@ -0,0 +1,28 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +part of 'init_project_task.dart'; + +class InitProjectState extends TaskStateRunning { + const InitProjectState({required this.path, required this.force}); + + final String path; + final bool force; + + @override + String get description => + 'Writing config file to `$path`${force ? ' (forced)' : ''}...'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart new file mode 100644 index 00000000..eb37bbc8 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart @@ -0,0 +1,85 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:wyatt_continuous_deployment/src/core/enums/flag.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/config/init_config_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/config/init_config_usecase.dart'; + +part 'init_project_state.dart'; + +class InitProjectTask extends TaskCubit { + factory InitProjectTask() => InitProjectTask._( + initConfigUsecase: getIt(), + checkToolsUsecase: getIt(), + checkConfigFileUsecase: getIt(), + ); + + InitProjectTask._({ + required InitConfigUsecase initConfigUsecase, + required super.checkToolsUsecase, + required super.checkConfigFileUsecase, + }) : _initConfigUsecase = initConfigUsecase; + + final InitConfigUsecase _initConfigUsecase; + + @override + bool get checks => false; // No need to check config file (not created yet) + + @override + Future onRun(Context ctx) async { + // 1. Init config + emit( + InitProjectState( + path: ctx.configFile.path, + force: ctx.flags.contains(Flag.force), + ), + ); + final initResult = await _initConfigUsecase( + InitConfigParameters( + path: ctx.configFile.path, + force: ctx.flags.contains(Flag.force), + ), + ); + + if (initResult.isErr) { + return emit(TaskStateError.fromRes(initResult)); + } + + // 2. Check tools + emit(TaskStateCheckTools()); + + final checkToolsResult = await checkToolsUsecase(null); + if (checkToolsResult.isErr) { + return emit(TaskStateError.fromRes(checkToolsResult)); + } + + // 3. Check config file + emit(TaskStateCheckConfigFile()); + + final checkConfigFileResult = + await checkConfigFileUsecase(ctx.configFile.path); + if (checkConfigFileResult.isErr) { + return emit(TaskStateError.fromRes(checkConfigFileResult)); + } + + return emit(const TaskStateSucceed(message: 'Project initialized')); + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/task_command.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/task_command.dart new file mode 100644 index 00000000..4504d9ae --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/task_command.dart @@ -0,0 +1,80 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; +import 'dart:io'; + +import 'package:args/args.dart'; +import 'package:args/command_runner.dart'; +import 'package:meta/meta.dart'; +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/enums/flag.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; + +abstract class TaskCommand extends Command { + TaskCommand({ + required this.task, + }); + + final TaskCubit task; + + /// [ArgResults] used for testing purposes only. + @visibleForTesting + ArgResults? testArgResults; + + /// [ArgResults] for the current command. + ArgResults get results => testArgResults ?? argResults!; + + /// Context object for the current command. + Context get context => Context( + currentDirectory: Directory.current, + configFile: () { + // Check if config flag is set. + final wyattPath = globalResults![AppConstants.configArg] as String?; + + final wyattFile = File(wyattPath ?? AppConstants.configFileName); + + return wyattFile; + }.call(), + flags: Flag.fromArgs(results: results, globalResults: globalResults!), + environment: () { + final env = {}..addAll(Platform.environment); + + // Load environment variables from the dot file. + final dotFile = File('.env'); + if (dotFile.existsSync()) { + final dotFileContent = dotFile.readAsStringSync(); + final lines = dotFileContent.split('\n'); + for (final line in lines) { + final parts = line.split('='); + if (parts.length == 2) { + env[parts[0].trim()] = parts[1].trim(); + } + } + } + + return env; + }.call(), + ); + + @override + FutureOr? run() async { + await task.run(context); + await task.awaitForFinished(); + return task.status; + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart b/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart index 350c2708..bb26b700 100644 --- a/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart +++ b/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart @@ -15,6 +15,9 @@ // along with this program. If not, see . abstract class AppConstants { + static const packageName = 'studio_cli'; + static const executableName = 'wyatt'; + static const configFileName = 'wyatt.yaml'; static const requiredTools = ['fastlane', 'flutter', 'unzip', 'gpg']; @@ -27,4 +30,8 @@ abstract class AppConstants { static const iosFolder = 'ios'; static const iosKeysSecretPassphrase = 'IOS_KEYS_SECRET_PASSPHRASE'; static const iosConfigKey = 'ios'; + + static const configArg = 'config'; + static const verboseArg = 'verbose'; + static const versionArg = 'version'; } diff --git a/packages/wyatt_continuous_deployment/lib/src/core/core.dart b/packages/wyatt_continuous_deployment/lib/src/core/core.dart new file mode 100644 index 00000000..4bee53ec --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/core.dart @@ -0,0 +1,17 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +export './commands/commands.dart'; diff --git a/packages/wyatt_continuous_deployment/lib/src/core/enums/flag.dart b/packages/wyatt_continuous_deployment/lib/src/core/enums/flag.dart new file mode 100644 index 00000000..2aa9025c --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/enums/flag.dart @@ -0,0 +1,50 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:args/args.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; + +enum Flag { + verbose('v'), + force('f'); + + const Flag(this.abbr); + + final String abbr; + + static List fromArgs({ + required ArgResults results, + required ArgResults globalResults, + }) { + final flags = []; + + for (final flag in Flag.values) { + if (results.options.contains(flag.name)) { + logger.detail('Flag: ${flag.name} was parsed in results'); + if (results[flag.name] as bool) { + flags.add(flag); + } + } else if (globalResults.options.contains(flag.name)) { + logger.detail('Flag: ${flag.name} was parsed in globalResults'); + if (globalResults[flag.name] as bool) { + flags.add(flag); + } + } + } + + return flags; + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/extensions/object_extension.dart b/packages/wyatt_continuous_deployment/lib/src/core/extensions/object_extension.dart new file mode 100644 index 00000000..252fadcb --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/extensions/object_extension.dart @@ -0,0 +1,23 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:wyatt_architecture/wyatt_architecture.dart'; + +extension ObjectExtension on Object? { + AppException toException() => this is AppException + ? this! as AppException + : ClientException(this?.toString()); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart b/packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart new file mode 100644 index 00000000..51a36466 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart @@ -0,0 +1,90 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:bloc/bloc.dart'; +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/domain/entities/context.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecases.dart'; +import 'package:wyatt_type_utils/wyatt_type_utils.dart'; + +part 'task_state.dart'; + +abstract class TaskCubit extends Cubit { + TaskCubit({ + required CheckToolsUsecase checkToolsUsecase, + required CheckConfigFileUsecase checkConfigFileUsecase, + }) : _checkToolsUsecase = checkToolsUsecase, + _checkConfigFileUsecase = checkConfigFileUsecase, + super(TaskStateInitial()); + + final CheckToolsUsecase _checkToolsUsecase; + final CheckConfigFileUsecase _checkConfigFileUsecase; + + int get status => switch (state) { + TaskStateFinished(:final exitCode) => exitCode, + _ => 0, + }; + + /// Whether to check the tools before running the task + bool get checks => true; + + CheckToolsUsecase get checkToolsUsecase => _checkToolsUsecase; + CheckConfigFileUsecase get checkConfigFileUsecase => _checkConfigFileUsecase; + + Future awaitForFinished() async { + if (state is TaskStateFinished) { + return; + } + + await for (final state in stream) { + if (state is TaskStateFinished) { + return; + } + } + } + + Future run(Context ctx) async { + if (checks) { + emit(TaskStateCheckTools()); + + final checkToolsResult = await _checkToolsUsecase(null); + if (checkToolsResult.isErr) { + return emit(TaskStateError.fromRes(checkToolsResult)); + } + + emit(TaskStateCheckConfigFile()); + + final checkConfigFileResult = + await _checkConfigFileUsecase(ctx.configFile.path); + if (checkConfigFileResult.isErr) { + return emit(TaskStateError.fromRes(checkConfigFileResult)); + } + } + + // Run the task + await onRun(ctx); + + if (state is! TaskStateError && state is! TaskStateSucceed) { + // If no error was emitted, and no success state was emitted, + // then emit a success state to indicate that the task has finished + return emit(const TaskStateSucceed()); + } + } + + Future onRun(Context ctx); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/task/task_state.dart b/packages/wyatt_continuous_deployment/lib/src/core/task/task_state.dart new file mode 100644 index 00000000..aea643bb --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/task/task_state.dart @@ -0,0 +1,85 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +part of 'task_cubit.dart'; + +abstract class TaskState { + const TaskState(); + + String get description; +} + +class TaskStateInitial extends TaskState { + @override + String get description => ''; +} + +class TaskStateCheckTools extends TaskState { + @override + String get description => 'Check that needed tools are installed'; +} + +class TaskStateCheckConfigFile extends TaskState { + @override + String get description => 'Check that config file exists'; +} + +class TaskStateRunning extends TaskState { + const TaskStateRunning(); + + @override + String get description => ''; +} + +abstract class TaskStateFinished extends TaskState { + const TaskStateFinished({ + this.exitCode = 0, + }); + + final int exitCode; +} + +class TaskStateError extends TaskStateFinished { + const TaskStateError({required String? message, super.exitCode = 1}) + : _message = message ?? 'Unknown error'; + + factory TaskStateError.unknown() => const TaskStateError(message: null); + + factory TaskStateError.fromException(AppException e, {int? exitCode}) => + TaskStateError(message: e.message, exitCode: exitCode ?? 1); + + factory TaskStateError.fromRes( + Result res, { + int? exitCode, + }) => + TaskStateError(message: res.err?.message, exitCode: exitCode ?? 1); + + final String _message; + + @override + String get description => + 'An error occured${_message.isNotEmpty ? ': $_message' : ''}'; +} + +class TaskStateSucceed extends TaskStateFinished { + const TaskStateSucceed({this.message, super.exitCode}); + + final String? message; + + @override + String get description => + message ?? 'The task ended with success (exit code: $exitCode)'; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart b/packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart index b3050073..234ac19e 100644 --- a/packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart +++ b/packages/wyatt_continuous_deployment/lib/src/core/utils/logging.dart @@ -14,6 +14,7 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'package:wyatt_continuous_deployment/wyatt_continuous_deployment.dart'; +import 'package:mason_logger/mason_logger.dart'; +import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; -final logger = WyattContinuousDeployment.logger; +final logger = getIt(); diff --git a/packages/wyatt_continuous_deployment/lib/src/core/utils/task_observer.dart b/packages/wyatt_continuous_deployment/lib/src/core/utils/task_observer.dart new file mode 100644 index 00000000..7b076367 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/core/utils/task_observer.dart @@ -0,0 +1,36 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'package:bloc/bloc.dart'; +import 'package:wyatt_continuous_deployment/src/core/task/task_cubit.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; + +class TaskObserver extends BlocObserver { + @override + void onChange(BlocBase bloc, Change change) { + super.onChange(bloc, change); + + return switch (change.nextState) { + TaskStateError(:final description) when description.isNotEmpty => + logger.err(description), + TaskStateSucceed(:final description) when description.isNotEmpty => + logger.success(description), + final TaskState taskState when taskState.description.isNotEmpty => + logger.detail(taskState.description), + _ => logger.detail(change.nextState.toString()), + }; + } +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/context.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/context.dart new file mode 100644 index 00000000..526a93da --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/context.dart @@ -0,0 +1,33 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment/src/core/enums/flag.dart'; + +class Context { + const Context({ + required this.currentDirectory, + required this.configFile, + required this.flags, + this.environment = const {}, + }); + + final Directory currentDirectory; + final File configFile; + final List flags; + final Map environment; +} diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart index 9d912310..d2c59a18 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart @@ -49,9 +49,9 @@ class Flutter { final FlutterBuildIpaUsecase _flutterBuildIpaUsecase; final FlutterBuildAppBundleUsecase _flutterBuildAppBundleUsecase; - FutureOrResult clean() => _flutterCleanUsecase(); - FutureOrResult getDependencies() => _flutterPubGetUsecase(); - FutureOrResult createXcArchive() => _flutterBuildXcarchiveUsecase(); + FutureOrResult clean() => _flutterCleanUsecase(null); + FutureOrResult getDependencies() => _flutterPubGetUsecase(null); + FutureOrResult createXcArchive() => _flutterBuildXcarchiveUsecase(null); FutureOrResult buildIpa(List args) => _flutterBuildIpaUsecase(args); FutureOrResult buildAppBundle(List args) => diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart index 688824c1..28ab950c 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_android_config_usecase.dart @@ -21,6 +21,7 @@ import 'package:checked_yaml/checked_yaml.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; import 'package:wyatt_continuous_deployment/src/domain/entities/config/android_config.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; import 'package:yaml/yaml.dart'; @usecase @@ -28,8 +29,17 @@ class GetAndroidConfigUsecase extends AsyncUseCase { const GetAndroidConfigUsecase() : super(); @override - FutureOr> execute(String params) => unsafe(() { - final file = File(params); + FutureOr onStart(String? params) { + if (params == null) { + throw const ClientException( + 'GetAndroidConfigUsecase: You must provide path', + ); + } + } + + @override + FutureOrResult execute(String? params) => unsafeAsync(() { + final file = File(params!); final content = file.readAsStringSync(); return checkedYamlDecode( diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart index c7d0766b..baed66b9 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/get_ios_config_usecase.dart @@ -21,6 +21,7 @@ import 'package:checked_yaml/checked_yaml.dart'; import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; import 'package:wyatt_continuous_deployment/src/domain/entities/config/ios_config.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; import 'package:yaml/yaml.dart'; @usecase @@ -28,8 +29,15 @@ class GetIosConfigUsecase extends AsyncUseCase { const GetIosConfigUsecase() : super(); @override - FutureOr> execute(String params) => unsafe(() { - final file = File(params); + FutureOr onStart(String? params) { + if (params == null) { + throw const ClientException('GetIosConfigUsecase: You must provide path'); + } + } + + @override + FutureOrResult execute(String? params) => unsafeAsync(() { + final file = File(params!); final content = file.readAsStringSync(); return checkedYamlDecode( diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart index 87ba935e..d4a751fd 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/config/init_config_usecase.dart @@ -24,6 +24,7 @@ import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; import 'package:wyatt_continuous_deployment/src/domain/entities/config/android_config.dart'; import 'package:wyatt_continuous_deployment/src/domain/entities/config/init_config_parameters.dart'; import 'package:wyatt_continuous_deployment/src/domain/entities/config/ios_config.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; import 'package:yaml_edit/yaml_edit.dart'; @usecase @@ -31,8 +32,18 @@ class InitConfigUsecase extends AsyncUseCase { const InitConfigUsecase() : super(); @override - FutureOr> execute(InitConfigParameters params) => unsafe(() async { - final file = File(params.path); + FutureOr onStart(InitConfigParameters? params) { + if (params == null) { + throw const ClientException( + 'InitConfigUsecase: You must provide parameter', + ); + } + } + + @override + FutureOrResult execute(InitConfigParameters? params) => + unsafeAsync(() async { + final file = File(params!.path); if (!file.existsSync()) { logger.detail('Creating config file at `${params.path}`'); file.createSync(); diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart index c96d667e..96b73b61 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/decrypt_keys/decrypt_keys_usecase.dart @@ -21,6 +21,7 @@ import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; import 'package:wyatt_continuous_deployment/src/domain/entities/decrypt_keys_parameters.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; @usecase class DecryptKeysUsecase extends AsyncUseCase { @@ -29,21 +30,28 @@ class DecryptKeysUsecase extends AsyncUseCase { @override FutureOr onStart(DecryptKeysParameters? params) { if (params == null) { - throw const ClientException('DecryptKeysParameters is null'); + throw const ClientException( + 'DecryptKeysUsecase: DecryptKeysParameters is null', + ); } if (params.encryptedFilePath.isEmpty) { - throw const ClientException('Encrypted file path is empty'); + throw const ClientException( + 'DecryptKeysUsecase: Encrypted file path is empty', + ); } if (!params.encryptedFilePath.endsWith('.gpg')) { - throw const ClientException('Enncrypted file is not a .gpg file'); + throw const ClientException( + 'DecryptKeysUsecase: Enncrypted file is not a .gpg file', + ); } } @override - FutureOr> execute(DecryptKeysParameters params) => unsafe(() async { + FutureOrResult execute(DecryptKeysParameters? params) => + unsafeAsync(() async { // Define gpg command final gpgFilePath = - params.encryptedFilePath.replaceAll(RegExp(r'\.gpg$'), ''); + params!.encryptedFilePath.replaceAll(RegExp(r'\.gpg$'), ''); final outputGpgFilePath = gpgFilePath.endsWith('.zip') ? gpgFilePath : '$gpgFilePath.zip'; diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart index 8e19fdc4..0634e0ef 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/find_last_ipa_file_usecase.dart @@ -14,6 +14,7 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . +import 'dart:async'; import 'dart:io'; import 'package:wyatt_architecture/wyatt_architecture.dart'; @@ -26,8 +27,17 @@ class FindLastIpaFileUsecase extends AsyncUseCase { const FindLastIpaFileUsecase() : super(); @override - FutureOrResult execute(String params) { - final Directory directory = Directory(params); + FutureOr onStart(String? params) { + if (params == null) { + throw const ClientException( + 'FindLastIpaFileUsecase: You must provide a path', + ); + } + } + + @override + FutureOrResult execute(String? params) { + final Directory directory = Directory(params!); if (!directory.existsSync()) { logger.detail('No IPA file found in $params'); diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart index 2632e8bb..99c8fc89 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart @@ -19,6 +19,8 @@ import 'dart:io'; import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; +import 'package:wyatt_type_utils/wyatt_type_utils.dart'; abstract class ProcessUsecase extends AsyncUseCase { const ProcessUsecase(); @@ -36,9 +38,16 @@ abstract class ProcessUsecase extends AsyncUseCase { String get onErrorMessage; @override - FutureOr> execute(T params) async { + FutureOr onStart(T? params) { + if (params == null) { + throw const ClientException('ProcessUsecase: You must provide a param'); + } + } + + @override + FutureOrResult execute(T? params) async { final progress = logger.progress(onStartedMessage); - final processResult = await run(params); + final processResult = await run(params as T); if (processResult != null) { if (processResult.exitCode != 0) { progress.fail(onErrorMessage); @@ -49,7 +58,7 @@ abstract class ProcessUsecase extends AsyncUseCase { } progress.complete(onCompletedMessage); logger.detail(processResult?.stdout.toString().trim()); - return Res.ok(null); + return const Ok(null); } /// Run the process with the given parameters. @@ -72,7 +81,7 @@ abstract class ProcessNoParamsUsecase extends NoParamsAsyncUseCase { String get onErrorMessage; @override - FutureOr> execute() async { + FutureOrResult execute(void params) async { final progress = logger.progress(onStartedMessage); final processResult = await run(); if (processResult != null) { @@ -85,7 +94,7 @@ abstract class ProcessNoParamsUsecase extends NoParamsAsyncUseCase { } progress.complete(onCompletedMessage); logger.detail(processResult?.stdout.toString().trim()); - return Res.ok(null); + return const Ok(null); } /// Run the process with no parameters. diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart index c6d11b54..ad317dfe 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_config_file_usecase.dart @@ -14,18 +14,29 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . +import 'dart:async'; import 'dart:io'; import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; @usecase class CheckConfigFileUsecase extends AsyncUseCase { const CheckConfigFileUsecase() : super(); @override - FutureOrResult execute(String params) => unsafe(() { - final configFile = File(params); + FutureOr onStart(String? params) { + if (params == null) { + throw const ClientException( + 'CheckConfigFileUsecase: You must provide path', + ); + } + } + + @override + FutureOrResult execute(String? params) => unsafeAsync(() { + final configFile = File(params!); if (!configFile.existsSync()) { throw ClientException( 'CheckConfigFileUsecase: Cannot find $params', diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart index b826b2f6..d4ba6dca 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart @@ -20,13 +20,14 @@ import 'dart:io'; import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; +import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; @usecase class CheckToolsUsecase extends NoParamsAsyncUseCase { const CheckToolsUsecase() : super(); @override - FutureOr> execute() async => unsafe(() async { + FutureOrResult execute(void params) async => unsafeAsync(() async { final missingTools = []; for (final tool in AppConstants.requiredTools) { final isInstalled = await checkToolInstalled(tool); diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart new file mode 100644 index 00000000..a458817f --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart @@ -0,0 +1,34 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:async'; + +import 'package:wyatt_architecture/wyatt_architecture.dart'; +import 'package:wyatt_continuous_deployment/src/core/extensions/object_extension.dart'; +import 'package:wyatt_type_utils/wyatt_type_utils.dart'; + +typedef Res = Result; + +/// A wrapper around [Result] to make it easier to use with AppException. +FutureOrResult unsafeAsync(FutureOr Function() fn) => + Result.tryCatchAsync( + () async => fn.call(), + (error) => error.toException(), + ); + +abstract class NoParamsAsyncUseCase extends AsyncUseCase { + const NoParamsAsyncUseCase(); +} diff --git a/packages/wyatt_continuous_deployment/lib/src/version.dart b/packages/wyatt_continuous_deployment/lib/src/version.dart new file mode 100644 index 00000000..af0834a9 --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/version.dart @@ -0,0 +1 @@ +const packageVersion = '0.0.1'; diff --git a/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart index dc040b78..8ac51f30 100644 --- a/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart +++ b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment.dart @@ -14,23 +14,5 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . -import 'package:get_it/get_it.dart'; -import 'package:mason_logger/mason_logger.dart'; -import 'package:wyatt_continuous_deployment/src/core/injection/injectable.dart'; - -export 'domain/domain.dart'; - -abstract class WyattContinuousDeployment { - /// The logger used by the package - static Logger logger = Logger(); - - /// The service locator used by the package - static GetIt getIt = GetIt.instance; - - /// Configure the dependencies - /// This method should be called before WyattContinuousDeployment.getIt - /// to ensure that all dependencies are registered - static Future configureDependencies() async { - await Injectable.configureDependencies(); - } -} +// TODO(mleon): export all layers +export ''; diff --git a/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment_command_runner.dart b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment_command_runner.dart new file mode 100644 index 00000000..51d6eb9b --- /dev/null +++ b/packages/wyatt_continuous_deployment/lib/src/wyatt_continuous_deployment_command_runner.dart @@ -0,0 +1,110 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:args/args.dart'; +import 'package:args/command_runner.dart'; +import 'package:cli_completion/cli_completion.dart'; +import 'package:mason_logger/mason_logger.dart'; +import 'package:wyatt_continuous_deployment/src/core/commands/commands.dart'; +import 'package:wyatt_continuous_deployment/src/core/constants/app_constants.dart'; +import 'package:wyatt_continuous_deployment/src/core/enums/flag.dart'; +import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; +import 'package:wyatt_continuous_deployment/src/version.dart'; + +class WyattContinuousDeploymentCommandRunner + extends CompletionCommandRunner { + WyattContinuousDeploymentCommandRunner() + : super( + AppConstants.executableName, + '🍺 Where all your dreams come to life', + ) { + argParser.addFlags(); + addCommand(InitProjectCommand()); + addCommand(BuildAppCommand()); + addCommand(DeployAppCommand()); + addCommand(BuildAndDeployAppCommand()); + } + + @override + Future run(Iterable args) async { + try { + final results = parse(args); + + logger.level = results['verbose'] == true ? Level.verbose : Level.info; + + return await runCommand(results) ?? ExitCode.success.code; + } on FormatException catch (e) { + logger + ..err(e.message) + ..info('') + ..info(usage); + return ExitCode.usage.code; + } on UsageException catch (e) { + logger + ..err(e.message) + ..info('') + ..info(e.usage); + return ExitCode.usage.code; + } on ProcessException catch (error) { + logger.err(error.message); + return ExitCode.unavailable.code; + } catch (error) { + logger.err('$error'); + return ExitCode.software.code; + } + } + + @override + Future runCommand(ArgResults topLevelResults) async { + if (topLevelResults.command?.name == 'completion') { + await super.runCommand(topLevelResults); + return ExitCode.success.code; + } + + int? exitCode = ExitCode.unavailable.code; + if (topLevelResults['version'] == true) { + logger.info(packageVersion); + exitCode = ExitCode.success.code; + } else { + exitCode = await super.runCommand(topLevelResults); + } + return exitCode; + } +} + +extension on ArgParser { + void addFlags() { + addFlag( + AppConstants.versionArg, + negatable: false, + help: 'Print the current version.', + ); + addFlag( + Flag.verbose.name, + abbr: Flag.verbose.abbr, + negatable: false, + help: 'Print verbose output.', + ); + addOption( + AppConstants.configArg, + abbr: 'c', + help: 'Path to the wyatt.yaml file.', + valueHelp: 'path', + ); + } +} diff --git a/packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart b/packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart index fc963fd9..40bef808 100644 --- a/packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart +++ b/packages/wyatt_continuous_deployment/lib/wyatt_continuous_deployment.dart @@ -17,4 +17,5 @@ /// Wyatt CD library wyatt_continuous_deployment; -export 'src/wyatt_continuous_deployment.dart'; +export './src/core/core.dart'; +export './src/domain/domain.dart'; diff --git a/packages/wyatt_continuous_deployment/pubspec.yaml b/packages/wyatt_continuous_deployment/pubspec.yaml index 5398fb8b..189d9466 100644 --- a/packages/wyatt_continuous_deployment/pubspec.yaml +++ b/packages/wyatt_continuous_deployment/pubspec.yaml @@ -9,11 +9,15 @@ environment: sdk: ">=3.0.0 <4.0.0" dependencies: + args: ^2.4.2 + bloc: ^8.1.3 checked_yaml: ^2.0.3 + cli_completion: ^0.5.0 get_it: ^7.6.7 injectable: ^2.3.2 json_annotation: ^4.8.1 mason_logger: ^0.2.12 + meta: ^1.12.0 wyatt_architecture: hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/ version: ^0.2.0+1 -- 2.47.2 From 3cebc34e468a00d961f30a1e9ae7ab5c0518f231 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Malo=20L=C3=A9on?= Date: Mon, 19 Feb 2024 15:07:37 +0000 Subject: [PATCH 07/14] refactor: rename default cd config file from wyatt.yaml to cd_config.yaml --- .../lib/src/core/constants/app_constants.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart b/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart index bb26b700..b24703e6 100644 --- a/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart +++ b/packages/wyatt_continuous_deployment/lib/src/core/constants/app_constants.dart @@ -18,7 +18,7 @@ abstract class AppConstants { static const packageName = 'studio_cli'; static const executableName = 'wyatt'; - static const configFileName = 'wyatt.yaml'; + static const configFileName = 'cd_config.yaml'; static const requiredTools = ['fastlane', 'flutter', 'unzip', 'gpg']; static const androidFolder = 'android'; -- 2.47.2 From dc9ce095b402b8a1d142cb2cb37f096108e3a510 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Malo=20L=C3=A9on?= Date: Thu, 29 Feb 2024 10:00:03 +0000 Subject: [PATCH 08/14] chore: version bin folder --- .../wyatt_continuous_deployment/.gitignore | 1 + .../bin/wyatt_continuous_deployment.dart | 20 +++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 packages/wyatt_continuous_deployment/bin/wyatt_continuous_deployment.dart diff --git a/packages/wyatt_continuous_deployment/.gitignore b/packages/wyatt_continuous_deployment/.gitignore index 3cceda55..78b10b11 100644 --- a/packages/wyatt_continuous_deployment/.gitignore +++ b/packages/wyatt_continuous_deployment/.gitignore @@ -5,3 +5,4 @@ # Avoid committing pubspec.lock for library packages; see # https://dart.dev/guides/libraries/private-files#pubspeclock. pubspec.lock +!bin/ \ No newline at end of file diff --git a/packages/wyatt_continuous_deployment/bin/wyatt_continuous_deployment.dart b/packages/wyatt_continuous_deployment/bin/wyatt_continuous_deployment.dart new file mode 100644 index 00000000..0f5f8c40 --- /dev/null +++ b/packages/wyatt_continuous_deployment/bin/wyatt_continuous_deployment.dart @@ -0,0 +1,20 @@ +import 'dart:io'; + +import 'package:mason_logger/mason_logger.dart'; +import 'package:wyatt_continuous_deployment/src/bootstrap.dart'; +import 'package:wyatt_continuous_deployment/src/wyatt_continuous_deployment_command_runner.dart'; + +Future main(List args) async { + await bootstrap(Logger()); + await flushThenExit(await WyattContinuousDeploymentCommandRunner().run(args)); +} + +/// Flushes the stdout and stderr streams, then exits the program with the given +/// status code. +/// +/// This returns a Future that will never complete, since the program will have +/// exited already. This is useful to prevent Future chains from proceeding +/// after you've decided to exit. +Future flushThenExit(int status) => + Future.wait([stdout.close(), stderr.close()]) + .then((_) => exit(status)); -- 2.47.2 From 48c5215c708e62cc275fd327c8a8e5b90506a2f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Malo=20L=C3=A9on?= Date: Thu, 29 Feb 2024 13:13:07 +0000 Subject: [PATCH 09/14] feat: fetch certs in read-only --- .../build_app/commands/build_ipa/build_ipa_task.dart | 3 --- .../fastlane/fastlane_get_certificates_parameters.dart | 9 --------- .../fastlane/fastlane_get_certificates_usecase.dart | 1 + 3 files changed, 1 insertion(+), 12 deletions(-) diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart index bf7f9402..a92c930f 100644 --- a/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/build_app/commands/build_ipa/build_ipa_task.dart @@ -105,9 +105,6 @@ class BuildIpaTask extends BuildAppTask { '${getIosConfigResult.ok!.iosFolderPath}/${getIosConfigResult.ok!.gitCertsPrivateKeyFileName}', keychainName: 'match', keychainPassword: 'flutter-cd-cli', - userName: getIosConfigResult.ok!.userName, - teamId: getIosConfigResult.ok!.teamId, - teamName: getIosConfigResult.ok!.teamName, gitUrl: getIosConfigResult.ok!.gitUrl, gitPassphrase: getIosConfigResult.ok!.gitPassphrase, ), diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart index 1018de6e..1b0ce1cf 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/fastlane/fastlane_get_certificates_parameters.dart @@ -20,9 +20,6 @@ class FastlaneGetCertificatesParameters { required this.appIdentifier, required this.keychainName, required this.keychainPassword, - required this.userName, - required this.teamId, - required this.teamName, required this.gitUrl, required this.gitPassphrase, }); @@ -31,9 +28,6 @@ class FastlaneGetCertificatesParameters { final String appIdentifier; final String keychainName; final String keychainPassword; - final String userName; - final String teamId; - final String teamName; final String gitUrl; final String gitPassphrase; @@ -42,9 +36,6 @@ class FastlaneGetCertificatesParameters { 'git_private_key:$gitPrivateKey', 'keychain_name:$keychainName', 'keychain_password:$keychainPassword', - 'username:$userName', - 'team_id:$teamId', - 'team_name:$teamName', 'git_url:$gitUrl', 'storage_mode:git', ]; diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart index 0141f84c..25175a33 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/fastlane/fastlane_get_certificates_usecase.dart @@ -40,6 +40,7 @@ class FastlaneGetCertificateUsecase 'run', 'match', 'type:appstore', + 'readonly:true', ...param.toList(), ], environment: { -- 2.47.2 From d217a202cbb359638cc860c76bfd6fe0e61c8bb5 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Fri, 29 Mar 2024 21:00:25 +0100 Subject: [PATCH 10/14] chore: update melos --- mason-lock.json | 2 +- pubspec.yaml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/mason-lock.json b/mason-lock.json index af1b8db1..839d5479 100644 --- a/mason-lock.json +++ b/mason-lock.json @@ -1 +1 @@ -{"bricks":{"wyatt_component_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_component_template","ref":"0d2605717add29556b12ad1145e4457d71f18c18"}},"wyatt_package_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_package_template","ref":"0d2605717add29556b12ad1145e4457d71f18c18"}}}} \ No newline at end of file +{"bricks":{"wyatt_component_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_component_template","ref":"1f3807adb548a7d65ead7f19e8b743462cb6be22"}},"wyatt_package_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_package_template","ref":"1f3807adb548a7d65ead7f19e8b743462cb6be22"}}}} \ No newline at end of file diff --git a/pubspec.yaml b/pubspec.yaml index a3991548..dd7dd2c3 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,7 +1,7 @@ name: wyatt_packages_workspace environment: - sdk: '>=2.18.0 <3.0.0' + sdk: '>=3.0.0 <4.0.0' dev_dependencies: - melos: ^3.0.1 + melos: ^5.2.2 -- 2.47.2 From 283bf80243723335dcd5d0780721055e0bbded1a Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Fri, 29 Mar 2024 21:01:19 +0100 Subject: [PATCH 11/14] fix(notification): port the new usecase syntax --- .../src/domain/usecases/init_cloud_messaging_use_case.dart | 4 ++-- .../src/domain/usecases/listen_notification_use_case.dart | 6 +++--- .../features/notifications/bloc/cloud_messaging_cubit.dart | 4 +--- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/init_cloud_messaging_use_case.dart b/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/init_cloud_messaging_use_case.dart index 12632716..79f73190 100644 --- a/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/init_cloud_messaging_use_case.dart +++ b/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/init_cloud_messaging_use_case.dart @@ -17,12 +17,12 @@ import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_cloud_messaging_bloc_base/src/domain/repositories/cloud_messaging_repository.dart'; -class InitCloudmessagingUseCase extends AsyncUseCase { +class InitCloudmessagingUseCase extends NoParamsAsyncUseCase { InitCloudmessagingUseCase({ required CloudMessagingRepository notificationRepository, }) : _notificationRepository = notificationRepository; final CloudMessagingRepository _notificationRepository; @override - FutureOrResult execute(NoParam? params) => + FutureOrResult execute() => _notificationRepository.init(); } diff --git a/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/listen_notification_use_case.dart b/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/listen_notification_use_case.dart index 3d670f5d..14738a03 100644 --- a/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/listen_notification_use_case.dart +++ b/packages/wyatt_cloud_messaging_bloc_base/lib/src/domain/usecases/listen_notification_use_case.dart @@ -24,13 +24,13 @@ import 'package:wyatt_cloud_messaging_bloc_base/src/domain/repositories/cloud_me import 'package:wyatt_type_utils/wyatt_type_utils.dart'; class ListenNotificationUseCase - extends StreamUseCase { + extends NoParamsAsyncUseCase> { ListenNotificationUseCase({ required CloudMessagingRepository notificationRepository, }) : _notificationRepository = notificationRepository; final CloudMessagingRepository _notificationRepository; @override - FutureOrResult> execute(NoParam? params) async { + FutureOrResult> execute() async { Stream? notificationStream; final notificationStreamResponse = @@ -66,7 +66,7 @@ class ListenNotificationUseCase } if (notificationStream == null) { - return const Err(NotificationException('Cannot listen notifications')); + return Err(const NotificationException('Cannot listen notifications')); } return Ok(notificationStream); diff --git a/packages/wyatt_cloud_messaging_bloc_base/lib/src/features/notifications/bloc/cloud_messaging_cubit.dart b/packages/wyatt_cloud_messaging_bloc_base/lib/src/features/notifications/bloc/cloud_messaging_cubit.dart index ed8eb0f5..96ad6edf 100644 --- a/packages/wyatt_cloud_messaging_bloc_base/lib/src/features/notifications/bloc/cloud_messaging_cubit.dart +++ b/packages/wyatt_cloud_messaging_bloc_base/lib/src/features/notifications/bloc/cloud_messaging_cubit.dart @@ -18,11 +18,9 @@ import 'dart:async'; import 'package:equatable/equatable.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; -import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_cloud_messaging_bloc_base/src/domain/entities/remote_notifications.dart'; import 'package:wyatt_cloud_messaging_bloc_base/src/domain/usecases/listen_notification_use_case.dart'; import 'package:wyatt_cloud_messaging_bloc_base/src/domain/usecases/subscribe_to_notification_topic_use_case.dart'; - import 'package:wyatt_cloud_messaging_bloc_base/src/domain/usecases/unsubscribe_from_notification_topic_use_case.dart'; part 'cloud_messaging_state.dart'; @@ -46,7 +44,7 @@ class CloudMessagingCubit extends Cubit { final OnNotification? handleNotification; Future listenNotification() async { - final notificaitons = await _listenNotification.execute(const NoParam()); + final notificaitons = await _listenNotification.execute(); if (notificaitons.isOk) { notificaitons.ok?.listen((notification) { emit(CloudmessagingState(notification)); -- 2.47.2 From cca7b29a6d12cf55c05347b4c604c9969dde4683 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Fri, 29 Mar 2024 21:02:06 +0100 Subject: [PATCH 12/14] fix(authentication)!: use correct usecase and result --- .../authentication/authentication_cubit.dart | 10 +++++----- .../sign_in/blocs/sign_in_cubit.dart | 6 +++--- .../sign_up/blocs/sign_up_cubit.dart | 2 +- .../edit_account/blocs/edit_account_cubit.dart | 4 ++-- .../authentication_cache_data_source.dart | 2 +- .../authentication_session_data_source.dart | 3 +-- .../authentication_remote_data_source.dart | 3 +-- .../edit_account/cubit/edit_account_cubit.dart | 4 ++-- .../features/sign_in/cubit/sign_in_cubit.dart | 6 +++--- .../features/sign_up/cubit/sign_up_cubit.dart | 2 +- .../authentication_cubit_test.dart | 16 ++++++++-------- .../email_verification_cubit_test.dart | 18 +++++++++--------- .../password_reset_cubit_test.dart | 6 +++--- .../test/sign_in/sign_in_cubit_test.dart | 4 ++-- .../test/sign_up/sign_up_cubit_test.dart | 2 +- 15 files changed, 43 insertions(+), 45 deletions(-) diff --git a/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/authentication_cubit.dart b/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/authentication_cubit.dart index 04153f31..b7607bb4 100644 --- a/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/authentication_cubit.dart +++ b/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/authentication_cubit.dart @@ -27,34 +27,34 @@ class ExampleAuthenticationCubit extends AuthenticationCubit { Result result) async { debugPrint('onReauthenticate'); - return const Ok(1); + return Ok(1); } @override FutureOrResult onRefresh(Result result) { debugPrint('onRefresh'); - return const Ok(1); + return Ok(1); } @override FutureOrResult onSignInFromCache(AuthenticationSession session) { debugPrint('onSignInFromCache'); - return const Ok(1); + return Ok(1); } @override FutureOrResult onSignOut() { debugPrint('onSignOut'); - return const Ok(null); + return Ok(null); } @override FutureOrResult onDelete() { debugPrint('onDelete'); - return const Ok(null); + return Ok(null); } } diff --git a/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_in/blocs/sign_in_cubit.dart b/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_in/blocs/sign_in_cubit.dart index 0b391624..07d412e8 100644 --- a/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_in/blocs/sign_in_cubit.dart +++ b/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_in/blocs/sign_in_cubit.dart @@ -30,7 +30,7 @@ class ExampleSignInCubit extends SignInCubit { Result result, WyattForm form) { debugPrint('onSignInWithEmailAndPassword: ${result.ok?.accessToken}'); - return const Ok(1); + return Ok(1); } @override @@ -38,7 +38,7 @@ class ExampleSignInCubit extends SignInCubit { Result result, WyattForm form) { debugPrint('onSignInAnonymously'); - return const Ok(1); + return Ok(1); } @override @@ -46,6 +46,6 @@ class ExampleSignInCubit extends SignInCubit { Result result, WyattForm form) { debugPrint('onSignInWithGoogle'); - return const Ok(1); + return Ok(1); } } diff --git a/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_up/blocs/sign_up_cubit.dart b/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_up/blocs/sign_up_cubit.dart index 93c4509e..051a094f 100644 --- a/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_up/blocs/sign_up_cubit.dart +++ b/packages/wyatt_authentication_bloc/example/lib/presentation/features/authentication/sign_up/blocs/sign_up_cubit.dart @@ -30,6 +30,6 @@ class ExampleSignUpCubit extends SignUpCubit { Result result, WyattForm form) async { debugPrint('onSignUpWithEmailAndPassword'); - return const Ok(1); + return Ok(1); } } diff --git a/packages/wyatt_authentication_bloc/example/lib/presentation/features/edit_account/blocs/edit_account_cubit.dart b/packages/wyatt_authentication_bloc/example/lib/presentation/features/edit_account/blocs/edit_account_cubit.dart index ae964202..cb13475f 100644 --- a/packages/wyatt_authentication_bloc/example/lib/presentation/features/edit_account/blocs/edit_account_cubit.dart +++ b/packages/wyatt_authentication_bloc/example/lib/presentation/features/edit_account/blocs/edit_account_cubit.dart @@ -28,7 +28,7 @@ class ExampleEditAccountCubit extends EditAccountCubit { Result result, WyattForm form) async { debugPrint('onEmailUpdated'); - return const Ok(1); + return Ok(1); } @override @@ -36,6 +36,6 @@ class ExampleEditAccountCubit extends EditAccountCubit { Result result, WyattForm form) async { debugPrint('onPasswordUpdated'); - return const Ok(1); + return Ok(1); } } diff --git a/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_cache_data_source.dart b/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_cache_data_source.dart index 911ec217..811c7ff4 100644 --- a/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_cache_data_source.dart +++ b/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_cache_data_source.dart @@ -20,7 +20,7 @@ import 'package:wyatt_authentication_bloc/src/domain/entities/account.dart'; /// {@template authentication_cache_data_source} /// A data source that manages the cache strategy. /// {@endtemplate} -abstract class AuthenticationCacheDataSource extends BaseLocalDataSource { +abstract class AuthenticationCacheDataSource extends BaseDataSource { /// {@macro authentication_cache_data_source} const AuthenticationCacheDataSource(); diff --git a/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_session_data_source.dart b/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_session_data_source.dart index c24d859a..24940fd7 100644 --- a/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_session_data_source.dart +++ b/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/local/authentication_session_data_source.dart @@ -20,8 +20,7 @@ import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart'; /// {@template authentication_session_data_source} /// A data source that manages the current session. /// {@endtemplate} -abstract class AuthenticationSessionDataSource - extends BaseLocalDataSource { +abstract class AuthenticationSessionDataSource extends BaseDataSource { /// {@macro authentication_session_data_source} const AuthenticationSessionDataSource(); diff --git a/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/remote/authentication_remote_data_source.dart b/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/remote/authentication_remote_data_source.dart index 8d9afab5..0d2b4a32 100644 --- a/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/remote/authentication_remote_data_source.dart +++ b/packages/wyatt_authentication_bloc/lib/src/domain/data_sources/remote/authentication_remote_data_source.dart @@ -22,8 +22,7 @@ import 'package:wyatt_authentication_bloc/src/domain/entities/account.dart'; /// It is responsible for all the external communication with the authentication /// providers. /// {@endtemplate} -abstract class AuthenticationRemoteDataSource - extends BaseRemoteDataSource { +abstract class AuthenticationRemoteDataSource extends BaseDataSource { /// {@macro authentication_remote_data_source} const AuthenticationRemoteDataSource(); diff --git a/packages/wyatt_authentication_bloc/lib/src/features/edit_account/cubit/edit_account_cubit.dart b/packages/wyatt_authentication_bloc/lib/src/features/edit_account/cubit/edit_account_cubit.dart index abc378cc..f054a33d 100644 --- a/packages/wyatt_authentication_bloc/lib/src/features/edit_account/cubit/edit_account_cubit.dart +++ b/packages/wyatt_authentication_bloc/lib/src/features/edit_account/cubit/edit_account_cubit.dart @@ -43,12 +43,12 @@ class EditAccountCubit extends BaseEditAccountCubit Result result, WyattForm form, ) => - const Ok(null); + Ok(null); @override FutureOrResult onPasswordUpdated( Result result, WyattForm form, ) => - const Ok(null); + Ok(null); } diff --git a/packages/wyatt_authentication_bloc/lib/src/features/sign_in/cubit/sign_in_cubit.dart b/packages/wyatt_authentication_bloc/lib/src/features/sign_in/cubit/sign_in_cubit.dart index fbde339c..01e3ea8c 100644 --- a/packages/wyatt_authentication_bloc/lib/src/features/sign_in/cubit/sign_in_cubit.dart +++ b/packages/wyatt_authentication_bloc/lib/src/features/sign_in/cubit/sign_in_cubit.dart @@ -48,19 +48,19 @@ class SignInCubit extends BaseSignInCubit Result result, WyattForm form, ) => - const Ok(null); + Ok(null); @override FutureOrResult onSignInWithEmailAndPassword( Result result, WyattForm form, ) => - const Ok(null); + Ok(null); @override FutureOrResult onSignInWithGoogle( Result result, WyattForm form, ) => - const Ok(null); + Ok(null); } diff --git a/packages/wyatt_authentication_bloc/lib/src/features/sign_up/cubit/sign_up_cubit.dart b/packages/wyatt_authentication_bloc/lib/src/features/sign_up/cubit/sign_up_cubit.dart index 09a76667..1eb50777 100644 --- a/packages/wyatt_authentication_bloc/lib/src/features/sign_up/cubit/sign_up_cubit.dart +++ b/packages/wyatt_authentication_bloc/lib/src/features/sign_up/cubit/sign_up_cubit.dart @@ -43,5 +43,5 @@ class SignUpCubit extends BaseSignUpCubit Result result, WyattForm form, ) => - const Ok(null); + Ok(null); } diff --git a/packages/wyatt_authentication_bloc/test/authentication/authentication_cubit_test.dart b/packages/wyatt_authentication_bloc/test/authentication/authentication_cubit_test.dart index 5469c51b..a99c6878 100644 --- a/packages/wyatt_authentication_bloc/test/authentication/authentication_cubit_test.dart +++ b/packages/wyatt_authentication_bloc/test/authentication/authentication_cubit_test.dart @@ -30,26 +30,26 @@ class TestAuthenticationCubit extends AuthenticationCubit { TestAuthenticationCubit({required super.authenticationRepository}); @override - FutureOrResult onDelete() async => const Ok(null); + FutureOrResult onDelete() async => Ok(null); @override FutureOrResult onReauthenticate( Result result, ) async => - const Ok(null); + Ok(null); @override FutureOrResult onRefresh(Result result) async => - const Ok(null); + Ok(null); @override FutureOrResult onSignInFromCache( AuthenticationSession session, ) async => - const Ok(null); + Ok(null); @override - FutureOrResult onSignOut() async => const Ok(null); + FutureOrResult onSignOut() async => Ok(null); } void main() { @@ -92,7 +92,7 @@ void main() { build: () => TestAuthenticationCubit( authenticationRepository: authenticationRepository, ), - seed: () => const AuthenticationState.unknown(), + seed: AuthenticationState.unknown, expect: () => [AuthenticationState.authenticated(session)], ); @@ -108,7 +108,7 @@ void main() { build: () => TestAuthenticationCubit( authenticationRepository: authenticationRepository, ), - seed: () => const AuthenticationState.unknown(), + seed: AuthenticationState.unknown, expect: () => [const AuthenticationState.unauthenticated()], ); }); @@ -119,7 +119,7 @@ void main() { setUp: () { when( () => authenticationRepository.signOut(), - ).thenAnswer((_) async => const Ok(null)); + ).thenAnswer((_) async => Ok(null)); }, build: () => TestAuthenticationCubit( authenticationRepository: authenticationRepository, diff --git a/packages/wyatt_authentication_bloc/test/email_verification/email_verification_cubit_test.dart b/packages/wyatt_authentication_bloc/test/email_verification/email_verification_cubit_test.dart index b7da3ae3..64363d00 100644 --- a/packages/wyatt_authentication_bloc/test/email_verification/email_verification_cubit_test.dart +++ b/packages/wyatt_authentication_bloc/test/email_verification/email_verification_cubit_test.dart @@ -84,7 +84,7 @@ void main() { 'invokes sendEmailVerification,', setUp: () { when(() => authenticationRepository.sendEmailVerification()) - .thenAnswer((_) async => const Ok(null)); + .thenAnswer((_) async => Ok(null)); }, build: () => EmailVerificationCubit( authenticationRepository: authenticationRepository, @@ -100,12 +100,12 @@ void main() { 'emits success', setUp: () { when(() => authenticationRepository.sendEmailVerification()) - .thenAnswer((_) async => const Ok(null)); + .thenAnswer((_) async => Ok(null)); }, build: () => EmailVerificationCubit( authenticationRepository: authenticationRepository, ), - seed: () => const EmailVerificationState(), + seed: EmailVerificationState.new, act: (cubit) => cubit.sendEmailVerification(), expect: () => [ const EmailVerificationState( @@ -121,12 +121,12 @@ void main() { 'emits failure', setUp: () { when(() => authenticationRepository.sendEmailVerification()) - .thenAnswer((_) async => const Err(ServerException('erreur'))); + .thenAnswer((_) async => Err(const ServerException('erreur'))); }, build: () => EmailVerificationCubit( authenticationRepository: authenticationRepository, ), - seed: () => const EmailVerificationState(), + seed: EmailVerificationState.new, act: (cubit) => cubit.sendEmailVerification(), expect: () => [ const EmailVerificationState( @@ -183,7 +183,7 @@ void main() { build: () => EmailVerificationCubit( authenticationRepository: authenticationRepository, ), - seed: () => const EmailVerificationState(), + seed: EmailVerificationState.new, act: (cubit) => cubit.checkEmailVerification(), expect: () => [ const EmailVerificationState( @@ -206,7 +206,7 @@ void main() { build: () => EmailVerificationCubit( authenticationRepository: authenticationRepository, ), - seed: () => const EmailVerificationState(), + seed: EmailVerificationState.new, act: (cubit) => cubit.checkEmailVerification(), expect: () => [ const EmailVerificationState( @@ -222,12 +222,12 @@ void main() { 'emits failure on refresh error', setUp: () { when(() => authenticationRepository.refresh()) - .thenAnswer((_) async => const Err(ServerException('erreur'))); + .thenAnswer((_) async => Err(const ServerException('erreur'))); }, build: () => EmailVerificationCubit( authenticationRepository: authenticationRepository, ), - seed: () => const EmailVerificationState(), + seed: EmailVerificationState.new, act: (cubit) => cubit.checkEmailVerification(), expect: () => [ const EmailVerificationState( diff --git a/packages/wyatt_authentication_bloc/test/password_reset/password_reset_cubit_test.dart b/packages/wyatt_authentication_bloc/test/password_reset/password_reset_cubit_test.dart index 704a816e..f84a3d05 100644 --- a/packages/wyatt_authentication_bloc/test/password_reset/password_reset_cubit_test.dart +++ b/packages/wyatt_authentication_bloc/test/password_reset/password_reset_cubit_test.dart @@ -57,7 +57,7 @@ void main() { () => authenticationRepository.sendPasswordResetEmail( email: any(named: 'email'), ), - ).thenAnswer((_) async => const Ok(null)); + ).thenAnswer((_) async => Ok(null)); when( () => authenticationRepository.formRepository, @@ -157,7 +157,7 @@ void main() { authenticationRepository: authenticationRepository, ), act: (cubit) => cubit.submit(), - expect: () => const [], + expect: () => [], ); blocTest, PasswordResetState>( @@ -272,7 +272,7 @@ void main() { () => authenticationRepository.sendPasswordResetEmail( email: any(named: 'email'), ), - ).thenAnswer((_) async => const Err(ServerException())); + ).thenAnswer((_) async => Err(const ServerException())); when( () => formRepository.accessForm(AuthFormName.passwordResetForm), ).thenAnswer( diff --git a/packages/wyatt_authentication_bloc/test/sign_in/sign_in_cubit_test.dart b/packages/wyatt_authentication_bloc/test/sign_in/sign_in_cubit_test.dart index 739f7664..f4cdaa06 100644 --- a/packages/wyatt_authentication_bloc/test/sign_in/sign_in_cubit_test.dart +++ b/packages/wyatt_authentication_bloc/test/sign_in/sign_in_cubit_test.dart @@ -435,7 +435,7 @@ void main() { email: any(named: 'email'), password: any(named: 'password'), ), - ).thenAnswer((_) async => const Err(ServerException())); + ).thenAnswer((_) async => Err(const ServerException())); when( () => formRepository.accessForm(AuthFormName.signInForm), ).thenAnswer( @@ -615,7 +615,7 @@ void main() { setUp: () { when( () => authenticationRepository.signInAnonymously(), - ).thenAnswer((_) async => const Err(ServerException())); + ).thenAnswer((_) async => Err(const ServerException())); }, build: () => SignInCubit( authenticationRepository: authenticationRepository, diff --git a/packages/wyatt_authentication_bloc/test/sign_up/sign_up_cubit_test.dart b/packages/wyatt_authentication_bloc/test/sign_up/sign_up_cubit_test.dart index 0f266022..06f40632 100644 --- a/packages/wyatt_authentication_bloc/test/sign_up/sign_up_cubit_test.dart +++ b/packages/wyatt_authentication_bloc/test/sign_up/sign_up_cubit_test.dart @@ -406,7 +406,7 @@ void main() { email: any(named: 'email'), password: any(named: 'password'), ), - ).thenAnswer((_) async => const Err(ServerException())); + ).thenAnswer((_) async => Err(const ServerException())); when( () => formRepository.accessForm(AuthFormName.signUpForm), ).thenAnswer( -- 2.47.2 From d69106adeb1f7e35f85f69545fc56def2dacdba0 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Fri, 29 Mar 2024 21:08:59 +0100 Subject: [PATCH 13/14] fix(cd): make cd use new usecases --- .../wyatt_continuous_deployment_example.dart | 23 +++++++++++++++++++ .../example/lib/main.dart | 2 +- .../init_project/init_project_task.dart | 2 +- .../lib/src/core/task/task_cubit.dart | 2 +- .../lib/src/domain/entities/flutter.dart | 6 ++--- .../src/domain/usecases/process_usecase.dart | 7 +++--- .../requirements/check_tools_usecase.dart | 2 +- .../lib/src/domain/usecases/usecase.dart | 5 ---- 8 files changed, 33 insertions(+), 16 deletions(-) create mode 100644 packages/wyatt_continuous_deployment/example/bin/wyatt_continuous_deployment_example.dart diff --git a/packages/wyatt_continuous_deployment/example/bin/wyatt_continuous_deployment_example.dart b/packages/wyatt_continuous_deployment/example/bin/wyatt_continuous_deployment_example.dart new file mode 100644 index 00000000..6b90a629 --- /dev/null +++ b/packages/wyatt_continuous_deployment/example/bin/wyatt_continuous_deployment_example.dart @@ -0,0 +1,23 @@ +// Copyright (C) 2024 WYATT GROUP +// Please see the AUTHORS file for details. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +import 'dart:io'; + +import 'package:wyatt_continuous_deployment_example/main.dart'; + +void main(List args) { + WyattContinuousDeploymentExample.run(args).then((_) => exit(0)); +} diff --git a/packages/wyatt_continuous_deployment/example/lib/main.dart b/packages/wyatt_continuous_deployment/example/lib/main.dart index 6eb17eda..d3342cf8 100644 --- a/packages/wyatt_continuous_deployment/example/lib/main.dart +++ b/packages/wyatt_continuous_deployment/example/lib/main.dart @@ -20,7 +20,7 @@ class WyattContinuousDeploymentExample { static Future run(List args) async { const useCase = CheckToolsUsecase(); - final result = await useCase(null); + final result = await useCase(); result.fold((value) => print('Success'), (error) => print('Error: $error')); } diff --git a/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart index eb37bbc8..0c917b4a 100644 --- a/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart +++ b/packages/wyatt_continuous_deployment/lib/src/core/commands/init_project/init_project_task.dart @@ -66,7 +66,7 @@ class InitProjectTask extends TaskCubit { // 2. Check tools emit(TaskStateCheckTools()); - final checkToolsResult = await checkToolsUsecase(null); + final checkToolsResult = await checkToolsUsecase(); if (checkToolsResult.isErr) { return emit(TaskStateError.fromRes(checkToolsResult)); } diff --git a/packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart b/packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart index 51a36466..c974052b 100644 --- a/packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart +++ b/packages/wyatt_continuous_deployment/lib/src/core/task/task_cubit.dart @@ -62,7 +62,7 @@ abstract class TaskCubit extends Cubit { if (checks) { emit(TaskStateCheckTools()); - final checkToolsResult = await _checkToolsUsecase(null); + final checkToolsResult = await _checkToolsUsecase(); if (checkToolsResult.isErr) { return emit(TaskStateError.fromRes(checkToolsResult)); } diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart b/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart index d2c59a18..9d912310 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/entities/flutter.dart @@ -49,9 +49,9 @@ class Flutter { final FlutterBuildIpaUsecase _flutterBuildIpaUsecase; final FlutterBuildAppBundleUsecase _flutterBuildAppBundleUsecase; - FutureOrResult clean() => _flutterCleanUsecase(null); - FutureOrResult getDependencies() => _flutterPubGetUsecase(null); - FutureOrResult createXcArchive() => _flutterBuildXcarchiveUsecase(null); + FutureOrResult clean() => _flutterCleanUsecase(); + FutureOrResult getDependencies() => _flutterPubGetUsecase(); + FutureOrResult createXcArchive() => _flutterBuildXcarchiveUsecase(); FutureOrResult buildIpa(List args) => _flutterBuildIpaUsecase(args); FutureOrResult buildAppBundle(List args) => diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart index 99c8fc89..4770374e 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/process_usecase.dart @@ -19,7 +19,6 @@ import 'dart:io'; import 'package:wyatt_architecture/wyatt_architecture.dart'; import 'package:wyatt_continuous_deployment/src/core/utils/logging.dart'; -import 'package:wyatt_continuous_deployment/src/domain/usecases/usecase.dart'; import 'package:wyatt_type_utils/wyatt_type_utils.dart'; abstract class ProcessUsecase extends AsyncUseCase { @@ -58,7 +57,7 @@ abstract class ProcessUsecase extends AsyncUseCase { } progress.complete(onCompletedMessage); logger.detail(processResult?.stdout.toString().trim()); - return const Ok(null); + return Ok(null); } /// Run the process with the given parameters. @@ -81,7 +80,7 @@ abstract class ProcessNoParamsUsecase extends NoParamsAsyncUseCase { String get onErrorMessage; @override - FutureOrResult execute(void params) async { + FutureOrResult execute() async { final progress = logger.progress(onStartedMessage); final processResult = await run(); if (processResult != null) { @@ -94,7 +93,7 @@ abstract class ProcessNoParamsUsecase extends NoParamsAsyncUseCase { } progress.complete(onCompletedMessage); logger.detail(processResult?.stdout.toString().trim()); - return const Ok(null); + return Ok(null); } /// Run the process with no parameters. diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart index d4ba6dca..21023bdb 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/requirements/check_tools_usecase.dart @@ -27,7 +27,7 @@ class CheckToolsUsecase extends NoParamsAsyncUseCase { const CheckToolsUsecase() : super(); @override - FutureOrResult execute(void params) async => unsafeAsync(() async { + FutureOrResult execute() async => unsafeAsync(() async { final missingTools = []; for (final tool in AppConstants.requiredTools) { final isInstalled = await checkToolInstalled(tool); diff --git a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart index a458817f..5015df15 100644 --- a/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart +++ b/packages/wyatt_continuous_deployment/lib/src/domain/usecases/usecase.dart @@ -17,7 +17,6 @@ import 'dart:async'; import 'package:wyatt_architecture/wyatt_architecture.dart'; -import 'package:wyatt_continuous_deployment/src/core/extensions/object_extension.dart'; import 'package:wyatt_type_utils/wyatt_type_utils.dart'; typedef Res = Result; @@ -28,7 +27,3 @@ FutureOrResult unsafeAsync(FutureOr Function() fn) => () async => fn.call(), (error) => error.toException(), ); - -abstract class NoParamsAsyncUseCase extends AsyncUseCase { - const NoParamsAsyncUseCase(); -} -- 2.47.2 From 6fd18e7aca3086ca89b5191c76448309abb53bbb Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Fri, 29 Mar 2024 21:15:07 +0100 Subject: [PATCH 14/14] chore: update melos config --- melos.yaml | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/melos.yaml b/melos.yaml index 8a043791..30c7f957 100644 --- a/melos.yaml +++ b/melos.yaml @@ -1,10 +1,13 @@ name: Wyatt-Packages -# repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages - -sdkPath: auto packages: - - packages/** + - "packages/**" + +ignore: + - "packages/**/example" + - "packages/**/.dart_tool/**" + +sdkPath: auto ide: intellij: @@ -16,7 +19,6 @@ command: linkToCommits: false # Gitea not yet supported workspaceChangelog: true includeCommitId: false # Generate error in Melos 3... - # branch: master # Since we are using rebasing, we don't need to specify the branch message: | chore(release): publish packages @@ -27,11 +29,6 @@ command: post: melos exec --flutter --concurrency=3 -- "flutter clean" scripts: - analyze: - run: | - melos exec --flutter --concurrency=1 -- flutter analyze --fatal-infos - description: Run `flutter analyze` for all flutter packages. - fix:apply: run: melos exec --concurrency=1 -- dart fix . --apply description: Run and apply `dart fix` for all packages. @@ -40,14 +37,6 @@ scripts: run: melos exec --concurrency=1 -- dart fix . --set-exit-if-changed description: Run `dart fix` checks for all packages. - format: - run: melos exec --concurrency=1 -- dart format . - description: Run `dart format` for all packages. - - lint:all: - run: melos run analyze && melos run format - description: Run all static analysis checks. - clean:deep: run: git clean -x -d -f -q description: Clean things very deeply with `git clean`. @@ -101,6 +90,3 @@ scripts: description: | Validate that all packages are ready to be published. Note: This will not actually publish anything. - - # publish: - # run: melos publish --diff="origin/$DRONE_COMMIT_BRANCH...HEAD" --no-dry-run --yes -- 2.47.2