implement automatic screenshot generation

.github/workflows/screenshots.yml

@@ -0,0 +1,115 @@
+on:
+  push:
+    branches:
+      - '*'
+
+name: Generate Screenshots
+
+jobs:
+
+  screenshot:
+    name: Generate screenshots
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        device:
+          - profile: pixel_6
+            api-level: 34
+            display_size: 1080x2336  # subtracted the 64px bottom navigation bar
+            type: phone
+          - profile: pixel_tablet
+            api-level: 34
+            display_size: 2560x1488  # subtracted the 64px navigation bar and 48px status bar
+            type: tenInch
+    env:
+      ANDROID_USER_HOME: /home/runner/.android
+    steps:
+      - name: Enable KVM group perms
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Retrieve debug keystore
+        env:
+          DEBUG_KEYSTORE_BASE64: ${{ secrets.DEBUG_KEYSTORE_BASE64 }}
+        run: |
+          mkdir ~/.config/.android
+          echo $DEBUG_KEYSTORE_BASE64 | base64 --decode >  ~/.config/.android/debug.keystore
+
+      - name: Set up Java environment
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'zulu'
+          cache: 'gradle'
+
+      - name: Setup Android SDK
+        run: |
+          $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install "cmdline-tools;latest"
+          rm -r $ANDROID_HOME/cmdline-tools/latest
+          mv $ANDROID_HOME/cmdline-tools/latest-2 $ANDROID_HOME/cmdline-tools/latest
+          $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --version
+
+      - name: AVD cache
+        uses: actions/cache@v3
+        id: avd-cache
+        with:
+          path: |
+            ~/.android/avd/*
+            ~/.android/adb*
+          key: ${{ runner.os }}-avd-api${{ matrix.device.api-level }}-${{ matrix.device.profile }}
+
+      - name: create AVD and generate snapshot for caching
+        if: steps.avd-cache.outputs.cache-hit != 'true'
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: ${{ matrix.device.api-level }}
+          target: google_atd
+          arch: x86_64
+          profile: ${{ matrix.device.profile }}
+          force-avd-creation: false
+          ram-size: 2048M
+          disk-size: 4096M
+          emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none -no-metrics
+          disable-animations: true
+          script: echo "Generated AVD snapshot for caching."
+
+      - name: Build app
+        run: ./gradlew assembleGoogleNormalDebug assembleGoogleNormalAndroidTest
+        env:
+          GOINGELECTRIC_API_KEY: ${{ secrets.GOINGELECTRIC_API_KEY }}
+          OPENCHARGEMAP_API_KEY: ${{ secrets.OPENCHARGEMAP_API_KEY }}
+          MAPBOX_API_KEY: ${{ secrets.MAPBOX_API_KEY }}
+          GOOGLE_MAPS_API_KEY: ${{ secrets.GOOGLE_MAPS_API_KEY }}
+          FRONYX_API_KEY: ${{ secrets.FRONYX_API_KEY }}
+          ACRA_CRASHREPORT_CREDENTIALS: ${{ secrets.ACRA_CRASHREPORT_CREDENTIALS }}
+
+      - name: Run emulator and generate screenshots
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: ${{ matrix.device.api-level }}
+          target: google_atd
+          arch: x86_64
+          profile: ${{ matrix.device.profile }}
+          force-avd-creation: false
+          ram-size: 2048M
+          disk-size: 4096M
+          emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none -no-metrics
+          disable-animations: true
+          script: |
+            adb shell pm clear net.vonforst.evmap.debug || true
+            adb shell wm size ${{ matrix.device.display_size }}
+            adb logcat -c
+
+            adb logcat *:E &            
+            fastlane screengrab --app_apk_path app/build/outputs/apk/googleNormal/debug/app-google-normal-debug.apk  --test_apk_path app/build/outputs/apk/androidTest/googleNormal/debug/app-google-normal-debug-androidTest.apk --tests_package_name=net.vonforst.evmap.debug.test --app_package_name net.vonforst.evmap.debug -p net.vonforst.evmap.screenshot --use_timestamp_suffix false --clear_previous_screenshots true --device_type=${{ matrix.device.type }} -q en-US,de-DE,fr-FR,nb-rNO,nl-NL,pt-PT,ro-RO
+
+      - name: Upload screenshots as artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: screenshots-${{ matrix.device.profile }}-${{ matrix.device.api-level }}
+          path: fastlane/metadata/android

app/build.gradle.kts

@@ -325,6 +325,7 @@ dependencies {
     debugImplementation("com.facebook.flipper:flipper:0.238.0")
     debugImplementation("com.facebook.soloader:soloader:0.10.5")
     debugImplementation("com.facebook.flipper:flipper-network-plugin:0.238.0")
+    debugImplementation("androidx.test.espresso:espresso-idling-resource:3.5.1")
 
     // testing
     testImplementation("junit:junit:4.13.2")
@@ -335,11 +336,14 @@ dependencies {
     testImplementation("androidx.test:core:1.5.0")
     testImplementation("androidx.arch.core:core-testing:2.2.0")
     testImplementation("androidx.car.app:app-testing:$carAppVersion")
-    testImplementation("androidx.test:core:1.5.0")
 
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
+    androidTestImplementation("androidx.test.uiautomator:uiautomator:2.2.0")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+    androidTestImplementation("androidx.test.espresso:espresso-contrib:3.5.1")
+    androidTestImplementation("androidx.test:rules:1.5.0")
     androidTestImplementation("androidx.arch.core:core-testing:2.2.0")
+    androidTestImplementation("tools.fastlane:screengrab:2.1.1")
 
     kapt("com.squareup.moshi:moshi-kotlin-codegen:1.15.0")
 

app/src/androidTest/java/net/vonforst/evmap/screenshot/DataBindingIdlingResource.kt

@@ -0,0 +1,112 @@
+/*
+ * Copyright (C) 2019 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.vonforst.evmap.screenshot
+
+import android.view.View
+import androidx.databinding.DataBindingUtil
+import androidx.databinding.ViewDataBinding
+import androidx.fragment.app.FragmentActivity
+import androidx.test.core.app.ActivityScenario
+import androidx.test.espresso.IdlingResource
+import androidx.test.ext.junit.rules.ActivityScenarioRule
+import java.util.UUID
+
+/**
+ * An espresso idling resource implementation that reports idle status for all data binding
+ * layouts. Data Binding uses a mechanism to post messages which Espresso doesn't track yet.
+ *
+ * Since this application only uses fragments, the resource only checks the fragments and their
+ * children instead of the whole view tree.
+ *
+ * Tracking bug: https://github.com/android/android-test/issues/317
+ */
+class DataBindingIdlingResource(
+    activityScenarioRule: ActivityScenarioRule<out FragmentActivity>
+) : IdlingResource {
+    // list of registered callbacks
+    private val idlingCallbacks = mutableListOf<IdlingResource.ResourceCallback>()
+
+    // give it a unique id to workaround an espresso bug where you cannot register/unregister
+    // an idling resource w/ the same name.
+    private val id = UUID.randomUUID().toString()
+
+    // holds whether isIdle is called and the result was false. We track this to avoid calling
+    // onTransitionToIdle callbacks if Espresso never thought we were idle in the first place.
+    private var wasNotIdle = false
+
+    lateinit var activity: FragmentActivity
+
+    override fun getName() = "DataBinding $id"
+
+    init {
+        monitorActivity(activityScenarioRule.scenario)
+    }
+
+    override fun isIdleNow(): Boolean {
+        val idle = !getBindings().any { it.hasPendingBindings() }
+        @Suppress("LiftReturnOrAssignment")
+        if (idle) {
+            if (wasNotIdle) {
+                // notify observers to avoid espresso race detector
+                idlingCallbacks.forEach { it.onTransitionToIdle() }
+            }
+            wasNotIdle = false
+        } else {
+            wasNotIdle = true
+            // check next frame
+            activity.findViewById<View>(android.R.id.content).postDelayed({
+                isIdleNow
+            }, 16)
+        }
+        return idle
+    }
+
+    override fun registerIdleTransitionCallback(callback: IdlingResource.ResourceCallback) {
+        idlingCallbacks.add(callback)
+    }
+
+    /**
+     * Sets the activity from an [ActivityScenario] to be used from [DataBindingIdlingResource].
+     */
+    private fun monitorActivity(
+        activityScenario: ActivityScenario<out FragmentActivity>
+    ) {
+        activityScenario.onActivity {
+            this.activity = it
+        }
+    }
+
+    /**
+     * Find all binding classes in all currently available fragments.
+     */
+    private fun getBindings(): List<ViewDataBinding> {
+        val fragments = (activity as? FragmentActivity)
+            ?.supportFragmentManager
+            ?.fragments
+
+        val bindings =
+            fragments?.mapNotNull {
+                it.view?.getBinding()
+            } ?: emptyList()
+        val childrenBindings = fragments?.flatMap { it.childFragmentManager.fragments }
+            ?.mapNotNull { it.view?.getBinding() } ?: emptyList()
+
+        return bindings + childrenBindings
+    }
+}
+
+private fun View.getBinding(): ViewDataBinding? = DataBindingUtil.getBinding(this)