Add support for Dart-side group()s

.github/workflows/patrol-prepare.yaml

@@ -155,13 +155,14 @@ jobs:
       - name: Run unit tests
         working-directory: packages/patrol/example/ios
         run: |
+          set -o pipefail
           xcodebuild test \
             -workspace Runner.xcworkspace \
             -scheme Runner \
             -only-testing RunnerTests \
             -configuration Debug \
             -sdk iphoneos -destination 'platform=iOS Simulator,name=iPhone 14' \
-            -derivedDataPath ../build/ios_unit | xcbeautify
+            -derivedDataPath ../build/ios_unit | xcbeautify --renderer github-actions
 
   prepare-flutter:
     name: Flutter ${{ matrix.flutter-version }}

contracts.proto

@@ -9,17 +9,18 @@ service PatrolAppService {
 }
 
 message ListDartTestsResponse {
-  DartTestGroup group = 1;
+  DartGroupEntry group = 1;
 }
 
-message DartTestGroup {
+message DartGroupEntry {
   string name = 1;
-  repeated DartTestCase tests = 2;
-  repeated DartTestGroup groups = 3;
-}
+  GroupEntryType type = 3;
+  repeated DartGroupEntry entries = 4;
 
-message DartTestCase {
-  string name = 1;
+  enum GroupEntryType {
+    GROUP = 0;
+    TEST = 1;
+  }
 }
 
 message RunDartTestRequest {

dev/cli_tests/patrol_develop_test.dart

@@ -58,7 +58,7 @@ void main(List<String> args) async {
     [
       'develop',
       ...['--target', 'integration_test/example_test.dart'],
-      ...args
+      ...args,
     ],
     runInShell: true,
     workingDirectory: exampleAppDirectory.path,

packages/patrol/android/src/main/kotlin/pl/leancode/patrol/ContractsExtensions.kt

@@ -3,10 +3,11 @@ package pl.leancode.patrol
 import androidx.test.uiautomator.By
 import androidx.test.uiautomator.BySelector
 import androidx.test.uiautomator.UiSelector
-import pl.leancode.patrol.contracts.Contracts
-import pl.leancode.patrol.contracts.Contracts.DartTestGroup
+import pl.leancode.patrol.contracts.Contracts.DartGroupEntry
+import pl.leancode.patrol.contracts.Contracts.Selector
+import pl.leancode.patrol.contracts.copy
 
-private fun Contracts.Selector.isEmpty(): Boolean {
+private fun Selector.isEmpty(): Boolean {
     return (
         !hasText() &&
             !hasTextStartsWith() &&
@@ -23,7 +24,7 @@ private fun Contracts.Selector.isEmpty(): Boolean {
         )
 }
 
-fun Contracts.Selector.toUiSelector(): UiSelector {
+fun Selector.toUiSelector(): UiSelector {
     var selector = UiSelector()
 
     if (hasText()) {
@@ -77,7 +78,7 @@ fun Contracts.Selector.toUiSelector(): UiSelector {
     return selector
 }
 
-fun Contracts.Selector.toBySelector(): BySelector {
+fun Selector.toBySelector(): BySelector {
     if (isEmpty()) {
         throw PatrolException("Selector is empty")
     }
@@ -184,21 +185,28 @@ fun Contracts.Selector.toBySelector(): BySelector {
     return bySelector
 }
 
-fun DartTestGroup.listFlatDartFiles(): List<String> {
-    val files = mutableListOf<String>()
-    for (group in groupsList) {
-        files.addAll(group.listGroups())
-    }
-
-    return files
-}
-
-// Recursively lists groups in this group.
-private fun DartTestGroup.listGroups(): List<String> {
-    val groups = mutableListOf<String>(this.name)
-    for (group in groupsList) {
-        groups.addAll(group.listGroups())
-    }
-
-    return groups
+/**
+ * Flattens the structure of a DartTestSuite into a flat list of tests.
+ */
+fun DartGroupEntry.listTestsFlat(parentGroupName: String = ""): List<DartGroupEntry> {
+    val tests = mutableListOf<DartGroupEntry>()
+
+    for (test in entriesList) {
+        if (test.type == DartGroupEntry.GroupEntryType.TEST) {
+            if (parentGroupName.isEmpty()) {
+                // This case is invalid, because every test will have at least 1 named group - its filename.
+                throw IllegalStateException("Invariant violated: test $test has no named parent group")
+            }
+
+            tests.add(test.copy { name = "$parentGroupName ${test.name}" })
+        } else if (test.type == DartGroupEntry.GroupEntryType.GROUP) {
+            if (parentGroupName.isEmpty()) {
+                tests.addAll(test.listTestsFlat(parentGroupName = test.name))
+            } else {
+                tests.addAll(test.listTestsFlat(parentGroupName = "$parentGroupName ${test.name}"))
+            }
+        }
+    }
+
+    return tests
 }

packages/patrol/android/src/main/kotlin/pl/leancode/patrol/PatrolAppServiceClient.java

@@ -28,7 +28,7 @@ public PatrolAppServiceClient(String target) {
         blockingStub = PatrolAppServiceGrpc.newBlockingStub(channel);
     }
 
-    public DartTestGroup listDartTests() throws StatusRuntimeException {
+    public DartGroupEntry listDartTests() throws StatusRuntimeException {
         Empty request = Empty.newBuilder().build();
         ListDartTestsResponse response = blockingStub.listDartTests(request);
 

packages/patrol/android/src/main/kotlin/pl/leancode/patrol/PatrolJUnitRunner.java

@@ -11,11 +11,13 @@
 import androidx.test.platform.app.InstrumentationRegistry;
 import androidx.test.runner.AndroidJUnitRunner;
 import io.grpc.StatusRuntimeException;
-import pl.leancode.patrol.contracts.Contracts.DartTestGroup;
 
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.List;
 import java.util.concurrent.ExecutionException;
 
+import static pl.leancode.patrol.contracts.Contracts.DartGroupEntry;
 import static pl.leancode.patrol.contracts.Contracts.RunDartTestResponse;
 
 /**
@@ -53,7 +55,8 @@ public void onCreate(Bundle arguments) {
      * This default behavior doesn't work with Flutter apps. That's because in Flutter
      * apps, the tests are in the app itself, so running only the instrumentation
      * during the initial run is not enough.
-     * The app must also be run, and queried for Dart tests That's what this method does.
+     * The app must also be run, and queried for Dart tests.
+     * That's what this method does.
      * </p>
      */
     public void setUp(Class<?> activityClass) {
@@ -106,10 +109,15 @@ public Object[] listDartTests() {
         final String TAG = "PatrolJUnitRunner.listDartTests(): ";
 
         try {
-            final DartTestGroup dartTestGroup = patrolAppServiceClient.listDartTests();
-            Object[] dartTestFiles = ContractsExtensionsKt.listFlatDartFiles(dartTestGroup).toArray();
-            Logger.INSTANCE.i(TAG + "Got Dart tests: " + Arrays.toString(dartTestFiles));
-            return dartTestFiles;
+            final DartGroupEntry dartTestGroup = patrolAppServiceClient.listDartTests();
+            List<DartGroupEntry> dartTestCases = ContractsExtensionsKt.listTestsFlat(dartTestGroup, "");
+            List<String> dartTestCaseNamesList = new ArrayList<>();
+            for (DartGroupEntry dartTestCase : dartTestCases) {
+                dartTestCaseNamesList.add(dartTestCase.getName());
+            }
+            Object[] dartTestCaseNames = dartTestCaseNamesList.toArray();
+            Logger.INSTANCE.i(TAG + "Got Dart tests: " + Arrays.toString(dartTestCaseNames));
+            return dartTestCaseNames;
         } catch (StatusRuntimeException e) {
             Logger.INSTANCE.e(TAG + "Failed to list Dart tests: ", e);
             throw e;