Add tags support

leancodepl · Aug 1, 2024 · 5fe120a · 5fe120a
1 parent 4f67159
commit 5fe120a
Show file tree

Hide file tree

Showing 23 changed files with 114 additions and 25 deletions.
diff --git a/dev/e2e_app/integration_test/common.dart b/dev/e2e_app/integration_test/common.dart
@@ -19,6 +19,7 @@ void patrol(
   String description,
   Future<void> Function(PatrolIntegrationTester) callback, {
   bool? skip,
+  List<String> tags = const [],
   NativeAutomatorConfig? nativeAutomatorConfig,
   LiveTestWidgetsFlutterBindingFramePolicy framePolicy =
       LiveTestWidgetsFlutterBindingFramePolicy.fadePointers,
@@ -30,5 +31,6 @@ void patrol(
     framePolicy: framePolicy,
     skip: skip,
     callback,
+    tags: tags,
   );
 }
diff --git a/dev/e2e_app/integration_test/example_test.dart b/dev/e2e_app/integration_test/example_test.dart
@@ -29,4 +29,27 @@ void main() {
       expect($('Hello, Flutter!'), findsOneWidget);
     },
   );
+
+  patrol(
+    'counter state is the same after going to Home and switching apps with tag',
+    tags: ['smoke'],
+    ($) async {
+      await createApp($);
+
+      await $(FloatingActionButton).tap();
+      expect($(#counterText).text, '1');
+
+      await $(#textField).enterText('Hello, Flutter!');
+      expect($('Hello, Flutter!'), findsOneWidget);
+
+      await $.native.pressHome();
+      await $.native.openApp();
+
+      expect($(#counterText).text, '1');
+      await $(FloatingActionButton).tap();
+
+      expect($(#counterText).text, '2');
+      expect($('Hello, Flutter!'), findsOneWidget);
+    },
+  );
 }
diff --git a/dev/e2e_app/pubspec.lock b/dev/e2e_app/pubspec.lock
@@ -446,7 +446,7 @@ packages:
       path: "../../packages/patrol"
       relative: true
     source: path
-    version: "3.9.0"
+    version: "3.10.0"
   patrol_finders:
     dependency: transitive
     description:

diff --git a/packages/patrol/android/src/main/kotlin/pl/leancode/patrol/contracts/Contracts.kt b/packages/patrol/android/src/main/kotlin/pl/leancode/patrol/contracts/Contracts.kt
diff --git a/packages/patrol/darwin/Classes/AutomatorServer/Contracts.swift b/packages/patrol/darwin/Classes/AutomatorServer/Contracts.swift
@@ -123,6 +123,7 @@ public struct DartGroupEntry: Codable {
   public var type: GroupEntryType
   public var entries: [DartGroupEntry]
   public var skip: Bool
+  public var tags: [String]
 }
 
 public struct ListDartTestsResponse: Codable {

diff --git a/packages/patrol/lib/src/common.dart b/packages/patrol/lib/src/common.dart
@@ -169,12 +169,14 @@ DartGroupEntry createDartTestGroup(
   String name = '',
   int level = 0,
   int maxTestCaseLength = global_state.maxTestLength,
+  List<String> tags = const [],
 }) {
   final groupDTO = DartGroupEntry(
     name: name,
     type: GroupEntryType.group,
     entries: [],
     skip: parentGroup.metadata.skip,
+    tags: parentGroup.metadata.tags.toList(),
   );
 
   for (final entry in parentGroup.entries) {
@@ -203,21 +205,28 @@ DartGroupEntry createDartTestGroup(
           throw StateError('Test is not allowed to be defined at level $level');
         }
 
-        groupDTO.entries.add(
-          DartGroupEntry(
-            name: name,
-            type: GroupEntryType.test,
-            entries: [],
-            skip: entry.metadata.skip,
-          ),
-        );
+        final addTest = tags.isEmpty || tags.any(entry.metadata.tags.contains);
+
+        if (addTest) {
+          groupDTO.entries.add(
+            DartGroupEntry(
+              name: name,
+              type: GroupEntryType.test,
+              entries: [],
+              skip: entry.metadata.skip,
+              tags: entry.metadata.tags.toList(),
+            ),
+          );
+        }
+
       case Group _:
         groupDTO.entries.add(
           createDartTestGroup(
             entry,
             name: name,
             level: level + 1,
             maxTestCaseLength: maxTestCaseLength,
+            tags: tags,
           ),
         );
     }

diff --git a/packages/patrol/lib/src/native/contracts/contracts.dart b/packages/patrol/lib/src/native/contracts/contracts.dart
diff --git a/packages/patrol/lib/src/native/contracts/contracts.g.dart b/packages/patrol/lib/src/native/contracts/contracts.g.dart
diff --git a/packages/patrol/pubspec.yaml b/packages/patrol/pubspec.yaml
@@ -2,7 +2,7 @@ name: patrol
 description: >
   Powerful Flutter-native UI testing framework overcoming limitations of
   existing Flutter testing tools. Ready for action!
-version: 3.9.0
+version: 3.10.0
 homepage: https://patrol.leancode.co
 repository: https://github.com/leancodepl/patrol/tree/master/packages/patrol
 issue_tracker: https://github.com/leancodepl/patrol/issues

diff --git a/packages/patrol/test/internals_test.dart b/packages/patrol/test/internals_test.dart
@@ -63,16 +63,19 @@ void main() {
             name: '',
             type: GroupEntryType.group,
             skip: false,
+            tags: [],
             entries: [
               DartGroupEntry(
                 name: 'example_test',
                 type: GroupEntryType.group,
                 skip: false,
+                tags: [],
                 entries: [
                   DartGroupEntry(
                     name: 'alpha',
                     type: GroupEntryType.group,
                     skip: false,
+                    tags: [],
                     entries: [
                       _testEntry('first'),
                       _testEntry('second'),
@@ -82,6 +85,7 @@ void main() {
                     name: 'bravo',
                     type: GroupEntryType.group,
                     skip: false,
+                    tags: [],
                     entries: [
                       _testEntry('first'),
                       _testEntry('second'),
@@ -93,6 +97,7 @@ void main() {
                 name: 'open_app_test',
                 type: GroupEntryType.group,
                 skip: false,
+                tags: [],
                 entries: [
                   _testEntry('open maps'),
                   _testEntry('open browser'),
@@ -137,17 +142,20 @@ void main() {
             name: '',
             type: GroupEntryType.group,
             skip: false,
+            tags: [],
             entries: [
               DartGroupEntry(
                 name: 'example_test',
                 type: GroupEntryType.group,
                 skip: false,
+                tags: [],
                 entries: [
                   _testEntry('alpha'),
                   DartGroupEntry(
                     name: 'bravo',
                     type: GroupEntryType.group,
                     skip: false,
+                    tags: [],
                     entries: [
                       _testEntry('first'),
                       _testEntry('second'),
@@ -158,6 +166,7 @@ void main() {
                     name: 'delta',
                     type: GroupEntryType.group,
                     skip: false,
+                    tags: [],
                     entries: [
                       _testEntry('first'),
                       _testEntry('second'),
@@ -199,11 +208,13 @@ void main() {
             name: '',
             type: GroupEntryType.group,
             skip: false,
+            tags: [],
             entries: [
               DartGroupEntry(
                 name: 'example_test',
                 type: GroupEntryType.group,
                 skip: false,
+                tags: [],
                 entries: [
                   _testEntry('alpha'),
                   _testEntry('zielony'),
@@ -234,7 +245,7 @@ void main() {
   });
 
   group('skip group of tests', () {
-    test('skip test', () {
+    test('skip test param should be passed in DartGroupEntry', () {
       // given
       final topLevelGroup = Group.root([
         LocalTest('patrol_test_explorer', Metadata.empty, () {}),
@@ -267,41 +278,53 @@ void main() {
           DartGroupEntry(
             name: '',
             type: GroupEntryType.group,
+            skip: false,
+            tags: [],
             entries: [
               DartGroupEntry(
                 name: 'example_test',
                 type: GroupEntryType.group,
+                skip: true,
+                tags: [],
                 entries: [
                   _testEntry('alpha'),
                 ],
-                skip: true,
               ),
               DartGroupEntry(
                 name: 'example2_test',
                 type: GroupEntryType.group,
+                skip: false,
+                tags: [],
                 entries: [
                   _testEntry('alpha'),
                   _testEntry('bravo first'),
                   _testEntry('bravo second'),
                 ],
-                skip: false,
               ),
             ],
-            skip: false,
           ),
         ),
       );
     });
   });
+
+  // group('test with tags', () {
+  //   final topLevelGroup
+  // })
 }
 
 LocalTest _localTest(String name) => LocalTest(name, Metadata.empty, () {});
 
-DartGroupEntry _testEntry(String name, {bool skip = false}) {
+DartGroupEntry _testEntry(
+  String name, {
+  bool skip = false,
+  List<String> tags = const [],
+}) {
   return DartGroupEntry(
     name: name,
     type: GroupEntryType.test,
     entries: [],
     skip: skip,
+    tags: tags,
   );
 }
diff --git a/packages/patrol_cli/lib/src/base/constants.dart b/packages/patrol_cli/lib/src/base/constants.dart
@@ -1,3 +1,3 @@
 /// Version of Patrol CLI. Must be kept in sync with pubspec.yaml.
 /// If you update this, make sure that compatibility-table.mdx is updated (if needed)
-const version = '3.0.1';
+const version = '3.0.2';
diff --git a/packages/patrol_cli/lib/src/commands/build_android.dart b/packages/patrol_cli/lib/src/commands/build_android.dart
@@ -36,6 +36,7 @@ class BuildAndroidCommand extends PatrolCommand {
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
+    usesTagsOption();
 
     usesAndroidOptions();
   }
@@ -83,9 +84,10 @@ class BuildAndroidCommand extends PatrolCommand {
       _logger.detail('Received test target: $t');
     }
 
+    final tags = stringsArg('tags');
     final entrypoint = _testBundler.bundledTestFile;
     if (boolArg('generate-bundle')) {
-      _testBundler.createTestBundle(targets);
+      _testBundler.createTestBundle(targets, tags);
     }
 
     final flavor = stringArg('flavor') ?? config.android.flavor;

diff --git a/packages/patrol_cli/lib/src/commands/build_ios.dart b/packages/patrol_cli/lib/src/commands/build_ios.dart
@@ -36,6 +36,7 @@ class BuildIOSCommand extends PatrolCommand {
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
+    usesTagsOption();
 
     usesIOSOptions();
     argParser.addFlag(
@@ -87,9 +88,10 @@ class BuildIOSCommand extends PatrolCommand {
       _logger.detail('Received test target: $t');
     }
 
+    final tags = stringsArg('tags');
     final entrypoint = _testBundler.bundledTestFile;
     if (boolArg('generate-bundle')) {
-      _testBundler.createTestBundle(targets);
+      _testBundler.createTestBundle(targets, tags);
     }
 
     final flavor = stringArg('flavor') ?? config.ios.flavor;

diff --git a/packages/patrol_cli/lib/src/commands/build_macos.dart b/packages/patrol_cli/lib/src/commands/build_macos.dart
@@ -36,6 +36,7 @@ class BuildMacOSCommand extends PatrolCommand {
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
+    usesTagsOption();
 
     usesMacOSOptions();
   }
@@ -83,9 +84,10 @@ class BuildMacOSCommand extends PatrolCommand {
       _logger.detail('Received test target: $t');
     }
 
+    final tags = stringsArg('tags');
     final entrypoint = _testBundler.bundledTestFile;
     if (boolArg('generate-bundle')) {
-      _testBundler.createTestBundle(targets);
+      _testBundler.createTestBundle(targets, tags);
     }
 
     final flavor = stringArg('flavor') ?? config.ios.flavor;

diff --git a/packages/patrol_cli/lib/src/commands/develop.dart b/packages/patrol_cli/lib/src/commands/develop.dart
@@ -53,6 +53,7 @@ class DevelopCommand extends PatrolCommand {
     usesLabelOption();
     usesWaitOption();
     usesPortOptions();
+    usesTagsOption();
 
     usesUninstallOption();