Merge branch 'main' into move-android-instrumented-test

Author: dturner

.github/pull_request_template.md

@@ -1,17 +1,25 @@
-Thanks for submitting a pull request. Please include the following information.
+**DO NOT CREATE A PULL REQUEST WITHOUT READING THESE INSTRUCTIONS**
 
-**What I have done and why**
-Include a summary of what your pull request contains, and why you have made these changes.
+## Instructions
+Thanks for submitting a pull request. To accept your pull request we need you do a few things: 
+
+**If this is your first pull request**
+
+- [Sign the contributors license agreement](https://cla.developers.google.com/)
+
+**Ensure tests pass and code is formatted correctly**
 
-Fixes #<issue_number_goes_here>
+- Run local tests on the `DemoDebug` variant by running `./gradlew testDemoDebug`
+- Fix code formatting: `./gradlew --init-script gradle/init.gradle.kts spotlessApply`
 
-**Do tests pass?**
-- [ ] Run local tests on `DemoDebug` variant: `./gradlew testDemoDebug`
-- [ ] Check formatting: `./gradlew --init-script gradle/init.gradle.kts spotlessApply`
+**Add a description**
 
-**Is this your first pull request?**
-- [ ] [Sign the CLA](https://cla.developers.google.com/)
-- [ ] Run `./tools/setup.sh`
-- [ ] Import the code formatting style as explained in [the setup script](/tools/setup.sh#L40).
+We need to know what you've done and why you've done it. Include a summary of what your pull request contains, and why you have made these changes. Include links to any relevant issues which it fixes.
 
+[Here's an example](https://github.com/android/nowinandroid/pull/1257).
+
+**NOW DELETE THIS LINE AND EVERYTHING ABOVE IT**
+
+**What I have done and why**
 
+\<add your PR description here\> 

.github/workflows/Build.yaml

@@ -17,6 +17,7 @@ jobs:
 
     permissions:
       contents: write
+      pull-requests: write
 
     timeout-minutes: 60
 
@@ -25,7 +26,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/wrapper-validation-action@v3
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
@@ -37,7 +38,7 @@ jobs:
           java-version: 17
 
       - name: Setup Gradle
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/gradle-build-action@v3
 
       - name: Check build-logic
         run: ./gradlew check -p build-logic
@@ -100,12 +101,13 @@ jobs:
           commit_message: "🤖 Updates screenshots"
 
       # Run local tests after screenshot tests to avoid wrong UP-TO-DATE. TODO: Ignore screenshots.
-      - name: Run local tests
+      - name: Run local tests and create report
         if: always()
         run: ./gradlew testDemoDebug :lint:test
       # Replace task exclusions with `-Pandroidx.baselineprofile.skipgeneration` when
       # https://android-review.googlesource.com/c/platform/frameworks/support/+/2602790 landed in a
       # release build
+
       - name: Build all build type and flavor permutations
         run: ./gradlew :app:assemble :benchmarks:assemble
           -x pixel6Api33ProdNonMinifiedReleaseAndroidTest
@@ -119,13 +121,20 @@ jobs:
           name: APKs
           path: '**/build/outputs/apk/**/*.apk'
 
-      - name: Upload test results (XML)
+      - name: Upload JVM local results (XML)
         if: always()
         uses: actions/upload-artifact@v4
         with:
-          name: test-results
+          name: local-test-results
           path: '**/build/test-results/test*UnitTest/**.xml'
 
+      - name: Upload screenshot results (PNG)
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: screenshot-test-results
+          path: '**/build/outputs/roborazzi/*_compare.png'
+
       - name: Check lint
         run: ./gradlew :app:lintProdRelease :app-nia-catalog:lintRelease :lint:lint
 
@@ -178,12 +187,9 @@ jobs:
           java-version: 17
 
       - name: Setup Gradle
-        uses: gradle/gradle-build-action@v2
-
-      - name: Build projects before running emulator
-        run: ./gradlew packageDemoDebug packageDemoDebugAndroidTest
+        uses: gradle/gradle-build-action@v3
 
-      - name: Run instrumentation tests
+      - name: Build projects and run instrumentation tests
         uses: reactivecircus/android-emulator-runner@v2
         with:
           api-level: ${{ matrix.api-level }}
@@ -193,9 +199,41 @@ jobs:
           heap-size: 600M
           script: ./gradlew connectedDemoDebugAndroidTest --daemon
 
+      - name: Run local tests (including Roborazzi) for the combined coverage report (only API 30)
+        if: matrix.api-level == 30
+        # There is no need to verify Roborazzi tests to generate coverage.
+        run: ./gradlew testDemoDebugUnitTest -Proborazzi.test.verify=false # Add Prod if we ever add JVM tests for prod
+
+      # Add `createProdDebugUnitTestCoverageReport` if we ever add JVM tests for prod
+      - name: Generate coverage reports for Debug variants (only API 30)
+        if: matrix.api-level == 30
+        run: ./gradlew createDemoDebugCombinedCoverageReport
+        
       - name: Upload test reports
         if: always()
         uses: actions/upload-artifact@v4
         with:
           name: test-reports-${{ matrix.api-level }}
           path: '**/build/reports/androidTests'
+
+      - name: Display local test coverage (only API 30)
+        if: matrix.api-level == 30
+        id: jacoco
+        uses: madrapps/[email protected]
+        with:
+          title: Combined test coverage report
+          min-coverage-overall: 40
+          min-coverage-changed-files: 60
+          paths: |
+            ${{ github.workspace }}/**/build/reports/jacoco/**/*Report.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+        
+      - name: Upload local coverage reports (XML + HTML) (only API 30)
+        if: matrix.api-level == 30
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-reports
+          if-no-files-found: error
+          compression-level: 1
+          overwrite: false
+          path: '**/build/reports/jacoco/'

.github/workflows/Release.yml

@@ -22,7 +22,7 @@ jobs:
         uses: actions/checkout@v4   
 
       - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
+        uses: gradle/wrapper-validation-action@v3
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties

README.md

@@ -122,9 +122,9 @@ tests against _all_ build variants which is both unecessary and will result in f
 A screenshot test takes a screenshot of a screen or a UI component within the app, and compares it 
 with a previously recorded screenshot which is known to be rendered correctly. 
 
-For example, Now in Android has [screenshot tests](https://github.com/android/nowinandroid/blob/main/app/src/testDemoDebug/kotlin/com/google/samples/apps/nowinandroid/ui/NiaAppScreenSizesScreenshotTests.kt)
+For example, Now in Android has [screenshot tests](https://github.com/android/nowinandroid/blob/main/app/src/testDemo/kotlin/com/google/samples/apps/nowinandroid/ui/NiaAppScreenSizesScreenshotTests.kt)
 to verify that the navigation is displayed correctly on different screen sizes 
-([known correct screenshots](https://github.com/android/nowinandroid/tree/main/app/src/testDemoDebug/screenshots)). 
+([known correct screenshots](https://github.com/android/nowinandroid/tree/main/app/src/testDemo/screenshots)). 
 
 Now In Android uses [Roborazzi](https://github.com/takahirom/roborazzi) to run screenshot tests
 of certain screens and UI components. When working with screenshot tests the following gradle tasks are useful:

app-nia-catalog/README.md

@@ -1,3 +1,3 @@
 # :app-nia-catalog module
-
-![Dependency graph](../docs/images/graphs/dep_graph_app_nia_catalog.png)
+## Dependency graph
+![Dependency graph](../docs/images/graphs/dep_graph_app_nia_catalog.svg)

app-nia-catalog/build.gradle.kts

@@ -59,7 +59,7 @@ android {
             // To publish on the Play store a private signing key is required, but to allow anyone
             // who clones the code to sign and run the release variant, use the debug signing key.
             // TODO: Abstract the signing configuration to a separate file to avoid hardcoding this.
-            signingConfig = signingConfigs.getByName("debug")
+            signingConfig = signingConfigs.named("debug").get()
         }
     }
 }

app-nia-catalog/dependencies/releaseRuntimeClasspath.txt

@@ -1,69 +1,72 @@
-androidx.activity:activity-compose:1.8.0
-androidx.activity:activity-ktx:1.8.0
-androidx.activity:activity:1.8.0
-androidx.annotation:annotation-experimental:1.3.1
-androidx.annotation:annotation-jvm:1.7.0
-androidx.annotation:annotation:1.7.0
+androidx.activity:activity-compose:1.8.2
+androidx.activity:activity-ktx:1.8.2
+androidx.activity:activity:1.8.2
+androidx.annotation:annotation-experimental:1.4.0
+androidx.annotation:annotation-jvm:1.7.1
+androidx.annotation:annotation:1.7.1
 androidx.appcompat:appcompat-resources:1.6.1
 androidx.arch.core:core-common:2.2.0
 androidx.arch.core:core-runtime:2.2.0
 androidx.autofill:autofill:1.0.0
-androidx.browser:browser:1.6.0
-androidx.collection:collection-jvm:1.3.0
-androidx.collection:collection:1.3.0
-androidx.compose.animation:animation-android:1.5.4
-androidx.compose.animation:animation-core-android:1.5.4
-androidx.compose.animation:animation-core:1.5.4
-androidx.compose.animation:animation:1.5.4
-androidx.compose.foundation:foundation-android:1.5.4
-androidx.compose.foundation:foundation-layout-android:1.5.4
-androidx.compose.foundation:foundation-layout:1.5.4
-androidx.compose.foundation:foundation:1.5.4
-androidx.compose.material3:material3:1.1.2
-androidx.compose.material:material-icons-core-android:1.5.4
-androidx.compose.material:material-icons-core:1.5.4
-androidx.compose.material:material-icons-extended-android:1.5.4
-androidx.compose.material:material-icons-extended:1.5.4
-androidx.compose.material:material-ripple-android:1.5.4
-androidx.compose.material:material-ripple:1.5.4
-androidx.compose.runtime:runtime-android:1.5.4
-androidx.compose.runtime:runtime-saveable-android:1.5.4
-androidx.compose.runtime:runtime-saveable:1.5.4
-androidx.compose.runtime:runtime:1.5.4
-androidx.compose.ui:ui-android:1.5.4
-androidx.compose.ui:ui-geometry-android:1.5.4
-androidx.compose.ui:ui-geometry:1.5.4
-androidx.compose.ui:ui-graphics-android:1.5.4
-androidx.compose.ui:ui-graphics:1.5.4
-androidx.compose.ui:ui-text-android:1.5.4
-androidx.compose.ui:ui-text:1.5.4
-androidx.compose.ui:ui-tooling-preview-android:1.5.4
-androidx.compose.ui:ui-tooling-preview:1.5.4
-androidx.compose.ui:ui-unit-android:1.5.4
-androidx.compose.ui:ui-unit:1.5.4
-androidx.compose.ui:ui-util-android:1.5.4
-androidx.compose.ui:ui-util:1.5.4
-androidx.compose.ui:ui:1.5.4
-androidx.compose:compose-bom:2023.10.01
+androidx.browser:browser:1.8.0
+androidx.collection:collection-jvm:1.4.0
+androidx.collection:collection-ktx:1.4.0
+androidx.collection:collection:1.4.0
+androidx.compose.animation:animation-android:1.6.3
+androidx.compose.animation:animation-core-android:1.6.3
+androidx.compose.animation:animation-core:1.6.3
+androidx.compose.animation:animation:1.6.3
+androidx.compose.foundation:foundation-android:1.6.3
+androidx.compose.foundation:foundation-layout-android:1.6.3
+androidx.compose.foundation:foundation-layout:1.6.3
+androidx.compose.foundation:foundation:1.6.3
+androidx.compose.material3:material3-android:1.2.1
+androidx.compose.material3:material3:1.2.1
+androidx.compose.material:material-icons-core-android:1.6.3
+androidx.compose.material:material-icons-core:1.6.3
+androidx.compose.material:material-icons-extended-android:1.6.3
+androidx.compose.material:material-icons-extended:1.6.3
+androidx.compose.material:material-ripple-android:1.6.3
+androidx.compose.material:material-ripple:1.6.3
+androidx.compose.runtime:runtime-android:1.6.3
+androidx.compose.runtime:runtime-saveable-android:1.6.3
+androidx.compose.runtime:runtime-saveable:1.6.3
+androidx.compose.runtime:runtime:1.6.3
+androidx.compose.ui:ui-android:1.6.3
+androidx.compose.ui:ui-geometry-android:1.6.3
+androidx.compose.ui:ui-geometry:1.6.3
+androidx.compose.ui:ui-graphics-android:1.6.3
+androidx.compose.ui:ui-graphics:1.6.3
+androidx.compose.ui:ui-text-android:1.6.3
+androidx.compose.ui:ui-text:1.6.3
+androidx.compose.ui:ui-tooling-preview-android:1.6.3
+androidx.compose.ui:ui-tooling-preview:1.6.3
+androidx.compose.ui:ui-unit-android:1.6.3
+androidx.compose.ui:ui-unit:1.6.3
+androidx.compose.ui:ui-util-android:1.6.3
+androidx.compose.ui:ui-util:1.6.3
+androidx.compose.ui:ui:1.6.3
+androidx.compose:compose-bom:2024.02.02
 androidx.concurrent:concurrent-futures:1.1.0
 androidx.core:core-ktx:1.12.0
 androidx.core:core:1.12.0
 androidx.customview:customview-poolingcontainer:1.0.0
 androidx.customview:customview:1.0.0
-androidx.emoji2:emoji2:1.4.0
-androidx.exifinterface:exifinterface:1.3.6
+androidx.emoji2:emoji2:1.3.0
+androidx.exifinterface:exifinterface:1.3.7
 androidx.fragment:fragment:1.5.1
 androidx.interpolator:interpolator:1.0.0
-androidx.lifecycle:lifecycle-common-java8:2.6.2
-androidx.lifecycle:lifecycle-common:2.6.2
-androidx.lifecycle:lifecycle-livedata-core:2.6.2
-androidx.lifecycle:lifecycle-livedata:2.6.2
-androidx.lifecycle:lifecycle-process:2.6.2
-androidx.lifecycle:lifecycle-runtime-ktx:2.6.2
-androidx.lifecycle:lifecycle-runtime:2.6.2
-androidx.lifecycle:lifecycle-viewmodel-ktx:2.6.2
-androidx.lifecycle:lifecycle-viewmodel-savedstate:2.6.2
-androidx.lifecycle:lifecycle-viewmodel:2.6.2
+androidx.lifecycle:lifecycle-common-java8:2.7.0
+androidx.lifecycle:lifecycle-common:2.7.0
+androidx.lifecycle:lifecycle-livedata-core-ktx:2.7.0
+androidx.lifecycle:lifecycle-livedata-core:2.7.0
+androidx.lifecycle:lifecycle-livedata:2.7.0
+androidx.lifecycle:lifecycle-process:2.7.0
+androidx.lifecycle:lifecycle-runtime-ktx:2.7.0
+androidx.lifecycle:lifecycle-runtime:2.7.0
+androidx.lifecycle:lifecycle-viewmodel-ktx:2.7.0
+androidx.lifecycle:lifecycle-viewmodel-savedstate:2.7.0
+androidx.lifecycle:lifecycle-viewmodel:2.7.0
 androidx.loader:loader:1.0.0
 androidx.metrics:metrics-performance:1.0.0-alpha04
 androidx.profileinstaller:profileinstaller:1.3.1
@@ -78,23 +81,23 @@ androidx.versionedparcelable:versionedparcelable:1.1.1
 androidx.viewpager:viewpager:1.0.0
 com.google.accompanist:accompanist-drawablepainter:0.32.0
 com.google.code.findbugs:jsr305:3.0.2
-com.google.dagger:dagger-lint-aar:2.50
-com.google.dagger:dagger:2.50
-com.google.dagger:hilt-android:2.50
-com.google.dagger:hilt-core:2.50
+com.google.dagger:dagger-lint-aar:2.51
+com.google.dagger:dagger:2.51
+com.google.dagger:hilt-android:2.51
+com.google.dagger:hilt-core:2.51
 com.google.guava:listenablefuture:1.0
 com.squareup.okhttp3:okhttp:4.12.0
-com.squareup.okio:okio-jvm:3.6.0
-com.squareup.okio:okio:3.6.0
-io.coil-kt:coil-base:2.5.0
-io.coil-kt:coil-compose-base:2.5.0
-io.coil-kt:coil-compose:2.5.0
-io.coil-kt:coil:2.5.0
+com.squareup.okio:okio-jvm:3.8.0
+com.squareup.okio:okio:3.8.0
+io.coil-kt:coil-base:2.6.0
+io.coil-kt:coil-compose-base:2.6.0
+io.coil-kt:coil-compose:2.6.0
+io.coil-kt:coil:2.6.0
 javax.inject:javax.inject:1
-org.jetbrains.kotlin:kotlin-stdlib-common:1.9.21
-org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.9.10
-org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.10
-org.jetbrains.kotlin:kotlin-stdlib:1.9.21
+org.jetbrains.kotlin:kotlin-stdlib-common:1.9.22
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.9.0
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.0
+org.jetbrains.kotlin:kotlin-stdlib:1.9.22
 org.jetbrains.kotlinx:kotlinx-coroutines-android:1.7.3
 org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.7.3
 org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.7.3

app/README.md

@@ -1,3 +1,3 @@
 # :app module
-
-![Dependency graph](../docs/images/graphs/dep_graph_app.png)
+## Dependency graph
+![Dependency graph](../docs/images/graphs/dep_graph_app.svg)