use delegating shard tasks for connectedCheck

These shard tasks collectively depend upon all Android `connectedCheck` tasks in the entire project.

Each shard depends upon the `connectedCheck` tasks of some subset of Android projects.
Projects are assigned to a shard by counting the number of `@Test` annotations within their
`androidTest` directory, then associating those projects to a shard in a round-robin fashion.

These shards are invoked in CI using a GitHub Actions matrix. If the number of shards changes,
the `connectedCheckShardMatrixYamlUpdate` task can automatically update the workflow file so
that they're all invoked.

The shard tasks are invoked as:

```shell
# roughly 1/3 of the tests
./gradlew connectedCheckShard1
# the second third
./gradlew connectedCheckShard2
# the last third
./gradlew connectedCheckShard3
```

The task filtering we currently use in CI (`./gradlew fooShard1 -x :my-project:foo`) will still work here, however the "cost" of the excluded task's tests is still accounted for when the sharding is performed.

Author: RBusarow

.github/workflows/kotlin.yml

@@ -14,22 +14,22 @@ concurrency :
 
 jobs :
 
-  build-all:
-    name: Build all
-    runs-on: macos-latest
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: main build
-        uses: ./.github/actions/gradle-task
-        with:
-          task: compileKotlin compileDebugKotlin
-          write-cache-key: main-build-artifacts
+  build-all :
+    name : Build all
+    runs-on : macos-latest
+    steps :
+      - uses : actions/checkout@v3
+
+      - name : main build
+        uses : ./.github/actions/gradle-task
+        with :
+          task : compileKotlin assembleDebug
+          write-cache-key : main-build-artifacts
 
   dokka :
     name : Assemble & Dokka
     runs-on : ubuntu-latest
-    needs: build-all
+    needs : build-all
     steps :
       - uses : actions/checkout@v3
 
@@ -39,6 +39,19 @@ jobs :
           task : siteDokka
           write-cache-key : main-build-artifacts
 
+  shards-and-version :
+    name : Shard Matrix Yaml
+    runs-on : ubuntu-latest
+    steps :
+      - uses : actions/checkout@v3
+
+      - name : check published artifacts
+        uses : ./.github/actions/gradle-task-with-commit
+        with :
+          check-task : connectedCheckShardMatrixYamlCheck checkVersionIsSnapshot
+          fix-task : connectedCheckShardMatrixYamlUpdate checkVersionIsSnapshot
+          write-cache-key : build-logic
+
   artifacts-check :
     name : ArtifactsCheck
     # the `artifactsCheck` task has to run on macOS in order to see the iOS KMP artifacts
@@ -101,7 +114,7 @@ jobs :
   android-lint :
     name : Android Lint
     runs-on : ubuntu-latest
-    needs: build-all
+    needs : build-all
     timeout-minutes : 20
     steps :
       - uses : actions/checkout@v3
@@ -114,17 +127,16 @@ jobs :
   check :
     name : Check
     runs-on : ubuntu-latest
-    needs: build-all
+    needs : build-all
     timeout-minutes : 20
     steps :
       - uses : actions/checkout@v3
       - name : Check with Gradle
         uses : ./.github/actions/gradle-task
         with :
           task : |
-            checkVersionIsSnapshot
             allTests
-            test 
+            test
             --continue
           restore-cache-key : build-logic
           write-cache-key : main-build-artifacts
@@ -286,43 +298,31 @@ jobs :
           name : renderpass-counting-results-${{ matrix.api-level }}
           path : ./**/build/reports/androidTests/connected/**
 
-  build-instrumentation-tests :
-    name : Build Instrumentation tests
-    runs-on : macos-latest
-    needs: build-all
-    timeout-minutes : 45
-    steps :
-      - uses : actions/checkout@v3
-
-      - name : Build instrumented tests
-        uses : ./.github/actions/gradle-task
-        with :
-          task : assembleDebugAndroidTest
-          restore-cache-key : main-build-artifacts
-          write-cache-key : androidTest-build-artifacts
-
   instrumentation-tests :
     name : Instrumentation tests
-    needs: build-instrumentation-tests
     runs-on : macos-latest
     timeout-minutes : 45
     strategy :
       # Allow tests to continue on other devices if they fail on one device.
       fail-fast : false
       matrix :
+        # Unclear that older versions actually honor command to disable animation.
+        # Newer versions are reputed to be too slow: https://github.com/ReactiveCircus/android-emulator-runner/issues/222
         api-level :
           - 29
-      # Unclear that older versions actually honor command to disable animation.
-      # Newer versions are reputed to be too slow: https://github.com/ReactiveCircus/android-emulator-runner/issues/222
+        ### <start-connected-check-shards>
+        shardNum : [ 1, 2, 3 ]
+        ### <end-connected-check-shards>
     steps :
       - uses : actions/checkout@v3
 
-      # This really just pulls the cache from the dependency job
+      ## Build before running tests, using cache.
       - name : Build instrumented tests
         uses : ./.github/actions/gradle-task
         with :
           task : assembleDebugAndroidTest
-          restore-cache-key : androidTest-build-artifacts
+          write-cache-key : androidTest-build-artifacts
+          restore-cache-key : main-build-artifacts
 
       ## Actual task
       - name : Instrumentation Tests
@@ -333,16 +333,16 @@ jobs :
           api-level : ${{ matrix.api-level }}
           arch : x86_64
           # Skip the benchmarks as this is running on emulators
-          script : ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck
+          script : ./gradlew connectedCheckShard${{ matrix.shardNum }} -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck
 
       - name : Upload results
         if : ${{ always() }}
         uses : actions/upload-artifact@v3
         with :
-          name : instrumentation-test-results-${{ matrix.api-level }}
+          name : instrumentation-test-results-${{ matrix.api-level }}-shard_${{ matrix.shardNum }}
           path : ./**/build/reports/androidTests/connected/**
 
-  conflate-renderings-instrumentation-tests :
+  runtime-instrumentation-tests :
     name : Conflate Stale Renderings Instrumentation tests
     runs-on : macos-latest
     timeout-minutes : 45
@@ -352,110 +352,20 @@ jobs :
       matrix :
         api-level :
           - 29
-      # Unclear that older versions actually honor command to disable animation.
-      # Newer versions are reputed to be too slow: https://github.com/ReactiveCircus/android-emulator-runner/issues/222
+        ### <start-connected-check-shards>
+        shardNum : [ 1, 2, 3 ]
+        ### <end-connected-check-shards>
+        runtime : [ conflate, baseline-stateChange, conflate-stateChange ]
     steps :
       - uses : actions/checkout@v3
 
-      ## Build before running tests, using cache.
-      - name : Build instrumented tests
-        uses : ./.github/actions/gradle-task
-        with :
-          # Unfortunately I don't think we can key this cache based on our project property so
-          # we clean and rebuild.
-          task : clean assembleDebugAndroidTest -Pworkflow.runtime=conflate
-
-      ## Actual task
-      - name : Instrumentation Tests
-        uses : reactivecircus/android-emulator-runner@v2
-        with :
-          # @ychescale9 suspects Galaxy Nexus is the fastest one
-          profile : Galaxy Nexus
-          api-level : ${{ matrix.api-level }}
-          arch : x86_64
-          # Skip the benchmarks as this is running on emulators
-          script : ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck -Pworkflow.runtime=conflate
-
-      - name : Upload results
-        if : ${{ always() }}
-        uses : actions/upload-artifact@v3
-        with :
-          name : instrumentation-test-results-${{ matrix.api-level }}
-          path : ./**/build/reports/androidTests/connected/**
-
-  stateChange-runtime-instrumentation-tests :
-    name : Render on State Change Only Instrumentation tests
-    runs-on : macos-latest
-    timeout-minutes : 45
-    strategy :
-      # Allow tests to continue on other devices if they fail on one device.
-      fail-fast : false
-      matrix :
-        api-level :
-          - 29
-      # Unclear that older versions actually honor command to disable animation.
-      # Newer versions are reputed to be too slow: https://github.com/ReactiveCircus/android-emulator-runner/issues/222
-    steps :
-      - uses : actions/checkout@v3
-      - name : set up JDK 11
-        uses : actions/setup-java@v3
-        with :
-          distribution : 'zulu'
-          java-version : 11
-
-      ## Build before running tests, using cache.
-      - name : Build instrumented tests
-        uses : ./.github/actions/gradle-task
-        with :
-          # Unfortunately I don't think we can key this cache based on our project property so
-          # we clean and rebuild.
-          task : clean assembleDebugAndroidTest -Pworkflow.runtime=baseline-stateChange
-
-      ## Actual task
-      - name : Instrumentation Tests
-        uses : reactivecircus/android-emulator-runner@v2
-        with :
-          # @ychescale9 suspects Galaxy Nexus is the fastest one
-          profile : Galaxy Nexus
-          api-level : ${{ matrix.api-level }}
-          arch : x86_64
-          # Skip the benchmarks as this is running on emulators
-          script : ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck -Pworkflow.runtime=baseline-stateChange
-
-      - name : Upload results
-        if : ${{ always() }}
-        uses : actions/upload-artifact@v3
-        with :
-          name : stateChange-instrumentation-test-results-${{ matrix.api-level }}
-          path : ./**/build/reports/androidTests/connected/**
-
-  conflate-stateChange-runtime-instrumentation-tests :
-    name : Render on State Change Only and Conflate Stale Renderings Instrumentation tests
-    runs-on : macos-latest
-    timeout-minutes : 45
-    strategy :
-      # Allow tests to continue on other devices if they fail on one device.
-      fail-fast : false
-      matrix :
-        api-level :
-          - 29
-      # Unclear that older versions actually honor command to disable animation.
-      # Newer versions are reputed to be too slow: https://github.com/ReactiveCircus/android-emulator-runner/issues/222
-    steps :
-      - uses : actions/checkout@v3
-      - name : set up JDK 11
-        uses : actions/setup-java@v3
-        with :
-          distribution : 'zulu'
-          java-version : 11
-
-      ## Build before running tests, using cache.
+      # This really just pulls the cache from the dependency job
       - name : Build instrumented tests
         uses : ./.github/actions/gradle-task
         with :
-          # Unfortunately I don't think we can key this cache based on our project property so
-          # we clean and rebuild.
-          task : clean assembleDebugAndroidTest -Pworkflow.runtime=conflate-stateChange
+          task : assembleDebugAndroidTest -Pworkflow.runtime=${{matrix.runtime}}
+          write-cache-key : androidTest-build-artifacts-${{matrix.runtime}}
+          restore-cache-key : main-build-artifacts
 
       ## Actual task
       - name : Instrumentation Tests
@@ -466,13 +376,13 @@ jobs :
           api-level : ${{ matrix.api-level }}
           arch : x86_64
           # Skip the benchmarks as this is running on emulators
-          script : ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck -Pworkflow.runtime=conflate-stateChange
+          script : ./gradlew connectedCheckShard${{ matrix.shardNum }} -Pworkflow.runtime=${{matrix.runtime}} -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck
 
       - name : Upload results
         if : ${{ always() }}
         uses : actions/upload-artifact@v3
         with :
-          name : conflate-stateChange-instrumentation-test-results-${{ matrix.api-level }}
+          name : conflate-instrumentation-test-results-${{ matrix.api-level }}-shard_${{ matrix.shardNum }}
           path : ./**/build/reports/androidTests/connected/**
 
   all-green :
@@ -483,8 +393,6 @@ jobs :
       - api-check
       - artifacts-check
       - check
-      - conflate-renderings-instrumentation-tests
-      - conflate-stateChange-runtime-instrumentation-tests
       - dependency-guard
       - dokka
       - instrumentation-tests
@@ -495,7 +403,8 @@ jobs :
       - jvm-stateChange-runtime-test
       - ktlint
       - performance-tests
-      - stateChange-runtime-instrumentation-tests
+      - runtime-instrumentation-tests
+      - shards-and-version
       - tutorials
 
     steps :

build-logic/build.gradle.kts

@@ -23,6 +23,7 @@ dependencies {
   implementation(libs.squareup.moshi)
   implementation(libs.squareup.moshi.adapters)
   implementation(libs.vanniktech.publish)
+  implementation(libs.java.diff.utils)
 
   ksp(libs.squareup.moshi.codegen)
 }

build-logic/src/main/java/com/squareup/workflow1/buildsrc/diff.kt

@@ -0,0 +1,56 @@
+package com.squareup.workflow1.buildsrc
+
+import com.github.difflib.text.DiffRow.Tag
+import com.github.difflib.text.DiffRowGenerator
+import com.squareup.workflow1.buildsrc.Color.Companion.colorized
+import com.squareup.workflow1.buildsrc.Color.LIGHT_GREEN
+import com.squareup.workflow1.buildsrc.Color.LIGHT_YELLOW
+
+fun diffString(oldStr: String, newStr: String): String {
+
+  return buildString {
+
+    val rows = DiffRowGenerator.create()
+      .showInlineDiffs(true)
+      .inlineDiffByWord(true)
+      .oldTag { _: Boolean? -> "" }
+      .newTag { _: Boolean? -> "" }
+      .build()
+      .generateDiffRows(oldStr.lines(), newStr.lines())
+
+    val linePadding = rows.size.toString().length + 1
+
+    rows.forEachIndexed { line, diffRow ->
+      if (diffRow.tag != Tag.EQUAL) {
+        append("line ${line.inc().toString().padEnd(linePadding)} ")
+      }
+
+      if (diffRow.tag == Tag.CHANGE || diffRow.tag == Tag.DELETE) {
+        appendLine("--  ${diffRow.oldLine}".colorized(LIGHT_YELLOW))
+      }
+      if (diffRow.tag == Tag.CHANGE) {
+        append("      " + " ".repeat(linePadding))
+      }
+      if (diffRow.tag == Tag.CHANGE || diffRow.tag == Tag.INSERT) {
+        appendLine("++  ${diffRow.newLine}".colorized(LIGHT_GREEN))
+      }
+    }
+  }
+}
+
+@Suppress("MagicNumber")
+internal enum class Color(val code: Int) {
+  LIGHT_GREEN(92),
+  LIGHT_YELLOW(93);
+
+  companion object {
+
+    private val supported = "win" !in System.getProperty("os.name").lowercase()
+
+    fun String.colorized(color: Color) = if (supported) {
+      "\u001B[${color.code}m$this\u001B[0m"
+    } else {
+      this
+    }
+  }
+}