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

Author: SimonMarquis

.editorconfig

@@ -4,3 +4,4 @@
 [*.{kt,kts}]
 ij_kotlin_allow_trailing_comma=true
 ij_kotlin_allow_trailing_comma_on_call_site=true
+ktlint_function_naming_ignore_when_annotated_with=Composable, Test

.github/dependabot.yml

@@ -0,0 +1,26 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "gradle"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    registries: "*"
+    labels: [ "version update" ]
+    groups:
+      kotlin-ksp-compose:
+        patterns:
+          - "org.jetbrains.kotlin:*"
+          - "org.jetbrains.kotlin.jvm"
+          - "com.google.devtools.ksp"
+          - "androidx.compose.compiler:compiler"
+    open-pull-requests-limit: 10
+registries:
+  maven-google:
+    type: "maven-repository"
+    url: "https://maven.google.com"
+    replaces-base: true

.github/renovate.json

@@ -31,14 +31,17 @@ jobs:
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           java-version: 17
 
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
 
+      - name: Check build-logic
+        run: ./gradlew check -p build-logic
+
       - name: Check spotless
         run: ./gradlew spotlessCheck --init-script gradle/init.gradle.kts --no-configuration-cache
 
@@ -72,7 +75,7 @@ jobs:
       # Run local tests after screenshot tests to avoid wrong UP-TO-DATE. TODO: Ignore screenshots.
       - name: Run local tests
         if: always()
-        run: ./gradlew testDemoDebug testProdDebug :lint:test
+        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
@@ -88,14 +91,14 @@ jobs:
           -x collectProdNonMinifiedBenchmarkBaselineProfile
 
       - name: Upload build outputs (APKs)
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: APKs
           path: '**/build/outputs/apk/**/*.apk'
 
       - name: Upload test results (XML)
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: test-results
           path: '**/build/test-results/test*UnitTest/**.xml'
@@ -105,7 +108,7 @@ jobs:
 
       - name: Upload lint reports (HTML)
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: lint-reports
           path: '**/build/reports/lint-results-*.html'
@@ -128,7 +131,7 @@ jobs:
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           java-version: 17
@@ -151,7 +154,7 @@ jobs:
 
       - name: Upload test reports
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: test-reports-${{ matrix.api-level }}
           path: '**/build/reports/androidTests'

.github/workflows/Build.yaml

@@ -21,7 +21,7 @@ jobs:
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
       - name: Set up JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
           java-version: 17

.github/workflows/Release.yml

@@ -22,7 +22,7 @@ The app is currently in development. The `prodRelease` variant is [available on
 **Now in Android** displays content from the
 [Now in Android](https://developer.android.com/series/now-in-android) series. Users can browse for
 links to recent videos, articles and other content. Users can also follow topics they are interested
-in.
+in, and be notified when new content is published which matches interests they are following.
 
 ## Screenshots
 
@@ -109,12 +109,42 @@ Examples:
   manipulate the state of the `Test` repository and verify the resulting behavior, instead of
   checking that specific repository methods were called.
 
-## Screenshot tests
+To run the tests execute the following gradle tasks: 
+
+- `testDemoDebug` run all local tests against the `demoDebug` variant.
+- `connectedDemoDebugAndroidTest` run all instrumented tests against the `demoDebug` variant. 
 
-**Now In Android** uses [Roborazzi](https://github.com/takahirom/roborazzi) to do screenshot tests
-of certain screens and components. To run these tests, run the `verifyRoborazziDemoDebug` or
-`recordRoborazziDemoDebug` tasks. Note that screenshots are recorded on CI, using Linux, and other
-platforms might generate slightly different images, making the tests fail.
+**Note:** You should not run `./gradlew test` or `./gradlew connectedAndroidTest` as this will execute 
+tests against _all_ build variants which is both unecessary and will result in failures as only the
+`demoDebug` variant is supported. No other variants have any tests (although this might change in future). 
+
+## Screenshot tests
+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)
+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)). 
+
+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:
+
+- `verifyRoborazziDemoDebug` run all screenshot tests, verifying the screenshots against the known
+correct screenshots.
+- `recordRoborazziDemoDebug` record new "known correct" screenshots. Use this command when you have
+made changes to the UI and manually verified that they are rendered correctly. Screenshots will be
+stored in `modulename/src/test/screenshots`.
+- `compareRoborazziDemoDebug` create comparison images between failed tests and the known correct
+images. These can also be found in `modulename/src/test/screenshots`. 
+
+**Note:** The known correct screenshots stored in this repository are recorded on CI using Linux. Other
+platforms may (and probably will) generate slightly different images, making the screenshot tests fail. 
+When working on a non-Linux platform, a workaround to this is to run `recordRoborazziDemoDebug` on the
+`main` branch before starting work. After making changes, `verifyRoborazziDemoDebug` will identify only
+legitimate changes. 
+
+For more information about screenshot testing 
+[check out this talk](https://www.droidcon.com/2023/11/15/easy-screenshot-testing-with-compose/).
 
 # UI
 The app was designed using [Material 3 guidelines](https://m3.material.io/). Learn more about the design process and 

README.md

@@ -65,7 +65,12 @@ android {
 }
 
 dependencies {
+    implementation(libs.androidx.activity.compose)
+
     implementation(projects.core.designsystem)
     implementation(projects.core.ui)
-    implementation(libs.androidx.activity.compose)
+}
+
+dependencyGuard {
+    configuration("releaseRuntimeClasspath")
 }

app-nia-catalog/build.gradle.kts

@@ -0,0 +1,103 @@
+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.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.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.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.loader:loader:1.0.0
+androidx.metrics:metrics-performance:1.0.0-alpha04
+androidx.profileinstaller:profileinstaller:1.3.1
+androidx.savedstate:savedstate-ktx:1.2.1
+androidx.savedstate:savedstate:1.2.1
+androidx.startup:startup-runtime:1.1.1
+androidx.tracing:tracing:1.0.0
+androidx.vectordrawable:vectordrawable-animated:1.1.0
+androidx.vectordrawable:vectordrawable:1.1.0
+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.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
+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.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
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3
+org.jetbrains.kotlinx:kotlinx-datetime-jvm:0.5.0
+org.jetbrains.kotlinx:kotlinx-datetime:0.5.0
+org.jetbrains:annotations:23.0.0

app-nia-catalog/dependencies/releaseRuntimeClasspath.txt

@@ -25,6 +25,7 @@ plugins {
     alias(libs.plugins.nowinandroid.android.application.firebase)
     id("com.google.android.gms.oss-licenses-plugin")
     alias(libs.plugins.baselineprofile)
+    alias(libs.plugins.roborazzi)
 }
 
 android {
@@ -96,51 +97,49 @@ dependencies {
     implementation(projects.core.data)
     implementation(projects.core.model)
     implementation(projects.core.analytics)
-
     implementation(projects.sync.work)
 
-    androidTestImplementation(projects.core.testing)
-    androidTestImplementation(projects.core.datastoreTest)
-    androidTestImplementation(projects.core.dataTest)
-    androidTestImplementation(projects.core.network)
-    androidTestImplementation(libs.androidx.navigation.testing)
-    androidTestImplementation(libs.accompanist.testharness)
-    androidTestImplementation(kotlin("test"))
-    debugImplementation(libs.androidx.compose.ui.testManifest)
-    debugImplementation(projects.uiTestHiltManifest)
-
     implementation(libs.androidx.activity.compose)
-    implementation(libs.androidx.appcompat)
     implementation(libs.androidx.core.ktx)
     implementation(libs.androidx.core.splashscreen)
-    implementation(libs.androidx.compose.runtime)
+    implementation(libs.androidx.tracing.ktx)
     implementation(libs.androidx.lifecycle.runtimeCompose)
-    implementation(libs.androidx.compose.runtime.tracing)
     implementation(libs.androidx.compose.material3.windowSizeClass)
-    implementation(libs.androidx.hilt.navigation.compose)
     implementation(libs.androidx.navigation.compose)
-    implementation(libs.androidx.window.manager)
     implementation(libs.androidx.profileinstaller)
     implementation(libs.kotlinx.coroutines.guava)
     implementation(libs.coil.kt)
 
-    baselineProfile(project(":benchmarks"))
+    debugImplementation(libs.androidx.compose.ui.testManifest)
+    debugImplementation(projects.uiTestHiltManifest)
+
+    kspTest(libs.hilt.compiler)
 
-    // Core functions
-    testImplementation(projects.core.testing)
-    testImplementation(projects.core.datastoreTest)
     testImplementation(projects.core.dataTest)
-    testImplementation(projects.core.network)
-    testImplementation(libs.androidx.navigation.testing)
+    testImplementation(projects.core.testing)
     testImplementation(libs.accompanist.testharness)
+    testImplementation(libs.hilt.android.testing)
     testImplementation(libs.work.testing)
-    testImplementation(kotlin("test"))
-    kspTest(libs.hilt.compiler)
 
+    testDemoImplementation(libs.robolectric)
+    testDemoImplementation(libs.roborazzi)
+
+    androidTestImplementation(projects.core.testing)
+    androidTestImplementation(projects.core.dataTest)
+    androidTestImplementation(projects.core.datastoreTest)
+    androidTestImplementation(libs.androidx.navigation.testing)
+    androidTestImplementation(libs.accompanist.testharness)
+    androidTestImplementation(libs.hilt.android.testing)
+
+    baselineProfile(projects.benchmarks)
 }
 
 baselineProfile {
     // Don't build on every iteration of a full assemble.
     // Instead enable generation directly for the release build variant.
     automaticGenerationDuringBuild = false
 }
+
+dependencyGuard {
+    configuration("prodReleaseRuntimeClasspath")
+}