Merge pull request #2232 from leancodepl/add-dart-define-from-file

Add dart define from file

Author: pdenert

README.md

@@ -153,6 +153,21 @@ abstract class NativeAutomator<IOSServer, AndroidServer, DartClient> {
 
 3. Run `gen_from_schema` script, few files will be updated
 
+## Develop patrol_cli
+
+If you have previously activated patrol_cli run:
+
+```bash
+dart pub global deactivate patrol_cli
+```
+
+then
+
+```bash
+cd packages/patrol_cli
+flutter pub global activate -s path .
+```
+
 [patrol_badge]: https://img.shields.io/pub/v/patrol?label=patrol
 [patrol_finders_badge]: https://img.shields.io/pub/v/patrol_finders?label=patrol_finders
 [patrol_cli_badge]: https://img.shields.io/pub/v/patrol_cli?label=patrol_cli

dev/e2e_app/defines_1.json

@@ -0,0 +1,4 @@
+{
+    "FIRST_KEY": "First key from defines_1.json",
+    "SECOND_KEY": "Second key from defines_1.json"
+}

dev/e2e_app/defines_2.json

@@ -0,0 +1,5 @@
+{
+    "SECOND_KEY": "Second key from defines_2.json",
+    "THIRD_KEY": "Third key from defines_2.json",
+    "FOURTH_KEY": "Fourth key from defines_2.json"
+}

dev/e2e_app/defines_3.env

@@ -0,0 +1 @@
+FIFTH_KEY="Fifth key from defines_3.env"

dev/e2e_app/integration_test/define_test.dart

@@ -0,0 +1,17 @@
+import 'package:e2e_app/main.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:patrol/patrol.dart';
+
+/// Run this test with command:
+/// patrol test -t integration_test/define_test.dart --dart-define-from-file=defines_1.json --dart-define-from-file=defines_2.json --dart-define-from-file=defines_3.env --verbose
+
+void main() {
+  patrolTest('check dart-define-from-file', ($) async {
+    await $.pumpWidgetAndSettle(const ExampleApp());
+
+    expect($('FIRST_KEY: First key from defines_1.json'), findsOneWidget);
+    expect($('SECOND_KEY: Second key from defines_2.json'), findsOneWidget);
+    expect($('THIRD_KEY: Third key from defines_2.json'), findsOneWidget);
+    expect($('FIFTH_KEY: Fifth key from defines_3.env'), findsOneWidget);
+  });
+}

dev/e2e_app/lib/main.dart

@@ -94,6 +94,12 @@ class _ExampleHomePageState extends State<ExampleHomePage> {
         padding: EdgeInsets.all(8),
         key: const Key('listViewKey'),
         children: [
+          const Text('FIRST_KEY: ${const String.fromEnvironment('FIRST_KEY')}'),
+          const Text(
+            'SECOND_KEY: ${const String.fromEnvironment('SECOND_KEY')}',
+          ),
+          const Text('THIRD_KEY: ${const String.fromEnvironment('THIRD_KEY')}'),
+          const Text('FIFTH_KEY: ${const String.fromEnvironment('FIFTH_KEY')}'),
           const Text(
             'You have pushed the button this many times:',
           ),

packages/patrol_cli/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+- Add support for --dart-define-from-file (#2232).
+
 ## 2.7.0
 
 - Add support for custom flutter commands (#2124).

packages/patrol_cli/lib/src/commands/build_android.dart

@@ -4,6 +4,7 @@ import 'package:patrol_cli/src/analytics/analytics.dart';
 import 'package:patrol_cli/src/android/android_test_backend.dart';
 import 'package:patrol_cli/src/base/extensions/core.dart';
 import 'package:patrol_cli/src/base/logger.dart';
+import 'package:patrol_cli/src/commands/dart_define_utils.dart';
 import 'package:patrol_cli/src/crossplatform/app_options.dart';
 import 'package:patrol_cli/src/dart_defines_reader.dart';
 import 'package:patrol_cli/src/pubspec_reader.dart';
@@ -31,6 +32,7 @@ class BuildAndroidCommand extends PatrolCommand {
     usesBuildModeOption();
     usesFlavorOption();
     usesDartDefineOption();
+    usesDartDefineFromFileOption();
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
@@ -121,12 +123,21 @@ class BuildAndroidCommand extends PatrolCommand {
       );
     }
 
+    final dartDefineFromFilePaths = stringsArg('dart-define-from-file');
+
+    final mergedDartDefines = mergeDartDefines(
+      dartDefineFromFilePaths,
+      dartDefines,
+      _dartDefinesReader,
+    );
+
     final flutterOpts = FlutterAppOptions(
       command: flutterCommand,
       target: entrypoint.path,
       flavor: flavor,
       buildMode: buildMode,
-      dartDefines: dartDefines,
+      dartDefines: mergedDartDefines,
+      dartDefineFromFilePaths: dartDefineFromFilePaths,
     );
     final androidOpts = AndroidAppOptions(
       flutter: flutterOpts,

packages/patrol_cli/lib/src/commands/build_ios.dart

@@ -32,6 +32,7 @@ class BuildIOSCommand extends PatrolCommand {
     usesBuildModeOption();
     usesFlavorOption();
     usesDartDefineOption();
+    usesDartDefineFromFileOption();
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
@@ -128,12 +129,15 @@ class BuildIOSCommand extends PatrolCommand {
       );
     }
 
+    final dartDefineFromFilePaths = stringsArg('dart-define-from-file');
+
     final flutterOpts = FlutterAppOptions(
       command: flutterCommand,
       target: entrypoint.path,
       flavor: flavor,
       buildMode: buildMode,
       dartDefines: dartDefines,
+      dartDefineFromFilePaths: dartDefineFromFilePaths,
     );
 
     final iosOpts = IOSAppOptions(

packages/patrol_cli/lib/src/commands/build_macos.dart

@@ -32,6 +32,7 @@ class BuildMacOSCommand extends PatrolCommand {
     usesBuildModeOption();
     usesFlavorOption();
     usesDartDefineOption();
+    usesDartDefineFromFileOption();
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
@@ -124,12 +125,15 @@ class BuildMacOSCommand extends PatrolCommand {
       );
     }
 
+    final dartDefineFromFilePaths = stringsArg('dart-define-from-file');
+
     final flutterOpts = FlutterAppOptions(
       command: flutterCommand,
       target: entrypoint.path,
       flavor: flavor,
       buildMode: buildMode,
       dartDefines: dartDefines,
+      dartDefineFromFilePaths: dartDefineFromFilePaths,
     );
 
     final macosOpts = MacOSAppOptions(