use delegating shard tasks for connectedCheck

These shard tasks which 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/actions/gradle-task/action.yml

@@ -26,8 +26,8 @@ runs :
     - name : Set up JDK
       uses : actions/setup-java@v3
       with :
-        distribution : ${{ inputs.distribution }}
-        java-version : ${{ inputs.java-version }}
+        distribution : ${{inputs.distribution}}
+        java-version : ${{inputs.java-version}}
 
     - name : Set Gradle Args for runner OS
       id : gradle-args
@@ -44,42 +44,41 @@ runs :
     # This step's "cache_hit" output will only be true if an exact match was found.
     - name: restore cache for ${{inputs.write-cache-key}}
       id: restore-write-cache
-      if: ${{inputs.write-cache-key}} != ''
+      if: ${{inputs.write-cache-key}}
       uses: actions/cache/restore@v3
       with:
         path: |
           ~/.gradle/caches/build-cache-1
           ~/.gradle/wrapper
-        key: ${{inputs.write-cache-key}}-${{ hashFiles('**/*.gradle.kt*') }}-${{ hashFiles('**/libs.versions.toml') }}-${{ hashFiles('**/gradle.properties') }}
+        key: ${{inputs.write-cache-key}}-${{hashFiles('**/*.gradle.kt*')}}-${{hashFiles('**/libs.versions.toml')}}-${{hashFiles('**/gradle.properties')}}
         restore-keys: ${{inputs.write-cache-key}}
         enableCrossOsArchive: true
-        lookup-only: true
 
     # Attempt to restore from the restore-cache-key, or fall back to a partial match for the restore key.
     # Skipped if the restore-cache-key wasn't set, or if the write-cache-key restore had an exact match.
     - name: restore cache for ${{inputs.restore-cache-key}}
-      if: ${{inputs.restore-cache-key}} != '' && steps.restore-write-cache.outputs.cache-hit != 'true'
+      if: ${{inputs.restore-cache-key}} && steps.restore-write-cache.outputs.cache-hit != 'true'
       uses: actions/cache/restore@v3
       with:
         path: |
           ~/.gradle/caches/build-cache-1
           ~/.gradle/wrapper
-        key: ${{inputs.restore-cache-key}}-${{ hashFiles('**/*.gradle.kt*') }}-${{ hashFiles('**/libs.versions.toml') }}-${{ hashFiles('**/gradle.properties') }}
+        key: ${{inputs.restore-cache-key}}-${{hashFiles('**/*.gradle.kt*')}}-${{hashFiles('**/libs.versions.toml')}}-${{hashFiles('**/gradle.properties')}}
         restore-keys: ${{inputs.restore-cache-key}}
         enableCrossOsArchive: true
 
     - uses: gradle/wrapper-validation-action@v1
 
     # Run the actual task.  Note that this still uses gradle-build-action for more fine-grained caching.
-    - name : Run ${{ inputs.task }}
+    - name : Run ${{inputs.task}}
       uses : gradle/gradle-build-action@v2
       with :
         # These arguments need to be on a single line. If they're defined with wrapping (using `|`),
         # something along the way to the actual CLI invocation gets confused and the jvmargs list
         # winds up getting parsed as a single argument.
-        arguments : ${{ steps.gradle-args.outputs.gradle-property-args }} ${{ inputs.task }} '-Dorg.gradle.jvmargs=${{ steps.gradle-args.outputs.gradle-jvm-args }}'
+        arguments : ${{steps.gradle-args.outputs.gradle-property-args}} ${{inputs.task}} '-Dorg.gradle.jvmargs=${{steps.gradle-args.outputs.gradle-jvm-args}}'
         cache-read-only : false
-        build-root-directory : ${{ inputs.build-root-directory }}
+        build-root-directory : ${{inputs.build-root-directory}}
         gradle-home-cache-cleanup : true
 
     # Save the build cache to `write-cache-key`.
@@ -89,16 +88,16 @@ runs :
     - name: save the '${{inputs.write-cache-key}}' cache
       uses: actions/cache/save@v3
       id: save-write-cache-key
-      if: ${{inputs.write-cache-key}} != '' && steps.restore-write-cache.outputs.cache-hit != 'true' && runner.os != 'Windows'
+      if: ${{inputs.write-cache-key}} && steps.restore-write-cache.outputs.cache-hit != 'true' && runner.os != 'Windows'
       with:
         path: |
           ~/.gradle/caches/build-cache-1
           ~/.gradle/wrapper
-        key: ${{inputs.write-cache-key}}-${{ hashFiles('**/*.gradle.kt*') }}-${{ hashFiles('**/libs.versions.toml') }}-${{ hashFiles('**/gradle.properties') }}
+        key: ${{inputs.write-cache-key}}-${{hashFiles('**/*.gradle.kt*')}}-${{hashFiles('**/libs.versions.toml')}}-${{hashFiles('**/gradle.properties')}}
 
     - name : Upload heap dump
       if : failure()
       uses : actions/upload-artifact@v3
       with :
         name : heap-dump
-        path : ${{ github.workspace }}/**/*{.hprof,.log}
+        path : ${{github.workspace}}/**/*{.hprof,.log}

.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 compileDebugKotlin
+          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
@@ -289,7 +301,7 @@ jobs :
   build-instrumentation-tests :
     name : Build Instrumentation tests
     runs-on : macos-latest
-    needs: build-all
+    needs : build-all
     timeout-minutes : 45
     steps :
       - uses : actions/checkout@v3
@@ -303,21 +315,24 @@ jobs :
 
   instrumentation-tests :
     name : Instrumentation tests
-    needs: build-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 :
@@ -333,104 +348,34 @@ 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
-
-      - name : Upload results
-        if : ${{ always() }}
-        uses : actions/upload-artifact@v3
-        with :
-          name : instrumentation-test-results-${{ matrix.api-level }}
-          path : ./**/build/reports/androidTests/connected/**
-
-  conflate-renderings-instrumentation-tests :
-    name : 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
-
-      ## 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
+          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/**
 
-  stateChange-runtime-instrumentation-tests :
-    name : Render on State Change Only Instrumentation tests
+  build-runtime-instrumentation-tests :
+    name : Build Instrumented tests for ${{ matrix.runtime }}
     runs-on : macos-latest
-    timeout-minutes : 45
+    timeout-minutes : 35
     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
+        runtime : [ conflate, baseline-stateChange, conflate-stateChange ]
     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
+          task : assembleDebugAndroidTest -Pworkflow.runtime=${{matrix.runtime}}
+          write-cache-key : androidTest-build-artifacts-${{matrix.runtime}}
 
-      ## 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
+  runtime-instrumentation-tests :
+    name : Conflate Stale Renderings Instrumentation tests
+    needs : build-runtime-instrumentation-tests
     runs-on : macos-latest
     timeout-minutes : 45
     strategy :
@@ -439,23 +384,19 @@ 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
-      - 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}}
+          read-cache-key : androidTest-build-artifacts-${{matrix.runtime}}
 
       ## Actual task
       - name : Instrumentation Tests
@@ -466,13 +407,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 +424,6 @@ jobs :
       - api-check
       - artifacts-check
       - check
-      - conflate-renderings-instrumentation-tests
-      - conflate-stateChange-runtime-instrumentation-tests
       - dependency-guard
       - dokka
       - instrumentation-tests
@@ -495,7 +434,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)
 }