Merge pull request #2286 from leancodepl/add-tags-from-skip-branch

Add tags and exclude-tags support

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,
   );
 }

dev/e2e_app/integration_test/example_test.dart

@@ -29,4 +29,31 @@ void main() {
       expect($('Hello, Flutter!'), findsOneWidget);
     },
   );
+
+  patrol(
+    'short test with two tags',
+    tags: ['smoke', 'fume'],
+    ($) async {
+      await createApp($);
+
+      await $(FloatingActionButton).tap();
+      expect($(#counterText).text, '1');
+      await $(FloatingActionButton).tap();
+      expect($(#counterText).text, '2');
+    },
+  );
+
+  patrol(
+    'short test with tag',
+    tags: ['smoke'],
+    ($) async {
+      await createApp($);
+
+      await $(FloatingActionButton).tap();
+      expect($(#counterText).text, '1');
+
+      await $(#textField).enterText('Hello, Flutter!');
+      expect($('Hello, Flutter!'), findsOneWidget);
+    },
+  );
 }

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:

docs/compatibility-table.mdx

@@ -13,7 +13,8 @@ the table below to assess which version you should use.
 
 |     patrol     |   patrol_cli   |
 | -------------- | -------------- |
-| 3.6.0 -        | 2.6.5 -        |
+| 3.10.0 -       | 3.1.0 -        |
+| 3.6.0 -        | 2.6.5 - 3.0.1  |
 | 3.4.0 - 3.5.2  | 2.6.0 - 2.6.4  |
 | 3.0.0 - 3.3.0  | 2.3.0 - 2.5.0  |
 | 2.3.0 - 2.3.2  | 2.2.0 - 2.2.2  |

packages/patrol/CHANGELOG.md

@@ -1,10 +1,11 @@
-## Unreleased
+## 3.10.0
 
 - Implement `enableBluetooth` and `disableBluetooth` methods for Android > 11. (#2254)
 - Implement `enableAirplaneMode` and `disableAirplaneMode` methods for Android. (#2254)
 - Implement `enableLocation` and `disableLocation` methods for Android. (#2259)
 - Fix opening settings app with clean state on iOS. (#2275)
 - Add native skip. (#2278)
+- Add `tags` and `exclude-tags`. (#2286)
 
 ## 3.9.0
 

packages/patrol/android/src/test/kotlin/pl/leancode/patrol/ContractsExtensionsTest.kt

@@ -9,11 +9,11 @@ fun dartTestGroup(
     name: String,
     entries: List<DartGroupEntry>,
 ): DartGroupEntry {
-    return DartGroupEntry(name, GroupEntryType.group, entries, false)
+    return DartGroupEntry(name, GroupEntryType.group, entries, false, listOf<String>())
 }
 
 fun dartTestCase(name: String): DartGroupEntry {
-    return DartGroupEntry(name, GroupEntryType.test, listOf(), false)
+    return DartGroupEntry(name, GroupEntryType.test, listOf(), false, listOf<String>())
 }
 
 class DartTestGroupExtensionsTest {

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 {

packages/patrol/lib/src/common.dart

@@ -1,5 +1,6 @@
 import 'dart:io' as io;
 
+import 'package:boolean_selector/boolean_selector.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:meta/meta.dart';
@@ -169,12 +170,15 @@ DartGroupEntry createDartTestGroup(
   String name = '',
   int level = 0,
   int maxTestCaseLength = global_state.maxTestLength,
+  String? tags,
+  String? excludeTags,
 }) {
   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 +207,43 @@ DartGroupEntry createDartTestGroup(
           throw StateError('Test is not allowed to be defined at level $level');
         }
 
+        if (tags != null) {
+          final includeTagsSelector = BooleanSelector.parse(tags);
+
+          // If the user provided tags, skip tests that don't match all of them.
+          if (!includeTagsSelector.evaluate(entry.metadata.tags.contains)) {
+            continue;
+          }
+        }
+
+        if (excludeTags != null) {
+          final excludeTagsSelector = BooleanSelector.parse(excludeTags);
+
+          // Skip tests that do match any tags the user wants to exclude.
+          if (excludeTagsSelector.evaluate(entry.metadata.tags.contains)) {
+            continue;
+          }
+        }
+
         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,
+            excludeTags: excludeTags,
           ),
         );
     }

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
@@ -17,6 +17,7 @@ environment:
   flutter: '>=3.22.0'
 
 dependencies:
+  boolean_selector: ^2.1.1
   equatable: ^2.0.5
   flutter:
     sdk: flutter