Espresso test with screenshot compare

.github/workflows/pull-request.yml

@@ -9,13 +9,40 @@ on:
 
 jobs:
   androidBuild:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest ]
+        api: [ 34 ]
+        abi: [ x86_64 ]
+        emulatorApi: [ 14 ]
+        tag: [ 'google_apis' ]
+    #        include:
+    #          - os: macOS-latest
+    #            abi: x86_64
+    #            api: 28
+    #            emulatorApi: [ 9 ]
+    #            tag: 'default'
     steps:
-      - uses: actions/[email protected]
+      - name: kvm support
+        run: |
+          egrep -c '(vmx|svm)' /proc/cpuinfo
+          id
+          sudo adduser $USER kvm
+          sudo chown -R $USER /dev/kvm
+          id
+      - name: prepare
+        run: |
+          sudo apt-get update && sudo apt-get install -y exiftool imagemagick xdg-utils libimage-exiftool-perl zsh jq xorg
+      #          brew install exiftool imagemagick
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
       - name: set up JDK
         uses: actions/setup-java@v4
         with:
-          distribution: "adopt"
+          distribution: 'adopt'
           java-version: 17
 
       - name: assemble ViroCore
@@ -36,6 +63,60 @@ jobs:
             ./android/virocore/build/outputs/aar/*.aar
             ./android/viroreact/build/outputs/aar/*.aar
             ./android/viroar/build/outputs/aar/*.aar
+      - name: Android Emulator test
+        uses: hannesa2/action-android/[email protected]
+        with:
+          cmd: ./gradlew cAT --continue
+          api: ${{ matrix.api }}
+          tag: ${{ matrix.tag }}
+          abi: ${{ matrix.abi }}
+          cmdOptions: -noaudio -no-boot-anim -no-window -metrics-collection
+          bootTimeout: 720
+      - uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: Viro-Espresso-${{ matrix.api }}-${{ matrix.abi }}-report-${{ matrix.emulatorApi }}
+          path: |
+            ./**/build/reports/androidTests/connected
+            ./**/build/outputs/androidTest-results/connected
+      - name: Archive screenshots ${{ matrix.emulatorApi }}
+        uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: Viro-Screenshots-${{ matrix.api }}-${{ matrix.abi }}-${{ matrix.emulatorApi }}
+          path: |
+            basicSample/build/outputs/connected_android_test_additional_output/debugAndroidTest/connected
+            basicSample/build/outputs/androidTest-results/connected
+            mainSample/build/outputs/connected_android_test_additional_output/debugAndroidTest/connected
+            mainSample/build/outputs/androidTest-results/connected
+            serviceLibrary/build/outputs/connected_android_test_additional_output/debugAndroidTest/connected
+            serviceLibrary/build/outputs/androidTest-results/connected
+      - name: Compare screenshots
+        if: ${{ always() }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          emulatorApi: ${{ matrix.emulatorApi }}
+        run: |
+          ls -ls mainSample/build/outputs/connected_android_test_additional_output/debugAndroidTest/connected
+          cp mainSample/build/outputs/connected_android_test_additional_output/debugAndroidTest/connected/emulator-5554\ -\ ${{ matrix.emulatorApi }}/* screenshotsToCompare${{ matrix.emulatorApi }}
+          export DISPLAY=:99
+          sudo Xvfb -ac :99 -screen 0 1280x1024x24 > /dev/null 2>&1 &
+          echo ${{ env.resourceRunID }}
+          ./screenShotCompare.sh ${{ env.resourceRunID }}
+      - name: Archive screenshots diffs ${{ matrix.emulatorApi }}
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: Viro-Screenshots-diffs-${{ matrix.emulatorApi }}
+          path: |
+            screenshotDiffs
+            screenshotsToCompare${{ matrix.emulatorApi }}/view-*.png
+      - name: Show git status ${{ matrix.emulatorApi }}
+        if: ${{ always() }}
+        run: |
+          git add screenshotsToCompare${{ matrix.emulatorApi }}
+          git status
+          [ "$(git status -s -uno)" ] && exit 1 || exit 0
 
   AndroidCheck:
     name: Check

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "android/git-diff-image"]
+	path = android/git-diff-image
+	url = [email protected]:ewanmellor/git-diff-image.git

android/mainSample/build.gradle

@@ -17,6 +17,9 @@ android {
         versionName getTag()
         buildConfigField "String", 'GIT_REPOSITORY', "\"" + getGitOriginRemote() + "\""
         buildConfigField "String", 'VERSION', "\"" + getTag() + "\""
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        testInstrumentationRunnerArguments useTestStorageService: 'true'
     }
 
     buildTypes {
@@ -64,6 +67,11 @@ dependencies {
 
     implementation "org.jetbrains.kotlin:kotlin-stdlib:2.0.0"
     implementation "androidx.core:core-ktx:1.8.0"
+
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'com.github.AppDevNext:Moka:1.6'
+    androidTestImplementation "androidx.test.ext:junit-ktx:1.1.5"
+    androidTestUtil "androidx.test.services:test-services:1.4.2"
 }
 
 static def getTag() {

android/mainSample/src/androidTest/java/com/example/virosample/ExtendedMainTest.kt

@@ -0,0 +1,39 @@
+package com.example.virosample
+
+import android.view.Gravity
+import androidx.test.core.graphics.writeToTestStorage
+import androidx.test.espresso.Espresso
+import androidx.test.espresso.assertion.ViewAssertions.matches
+import androidx.test.espresso.contrib.DrawerActions
+import androidx.test.espresso.contrib.DrawerMatchers.isClosed
+import androidx.test.espresso.matcher.ViewMatchers
+import androidx.test.espresso.matcher.ViewMatchers.withId
+import androidx.test.espresso.screenshot.captureToBitmap
+import androidx.test.ext.junit.rules.activityScenarioRule
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.TestName
+import org.junit.runner.RunWith
+
+
+@RunWith(AndroidJUnit4::class)
+class ExtendedMainTest {
+
+    @get:Rule
+    var nameRule = TestName()
+
+    @get:Rule
+    val activityScenarioRule = activityScenarioRule<MLMainActivity>()
+
+    @Test
+    fun mainSmokeTest() {
+        Espresso.onView(withId(R.id.drawer_layout))
+            .check(matches(isClosed(Gravity.LEFT))) // Left Drawer should be closed.
+            .perform(DrawerActions.open())
+        Espresso.onView(ViewMatchers.isRoot())
+            .captureToBitmap()
+            .writeToTestStorage("${javaClass.simpleName}_${nameRule.methodName}-End")
+    }
+
+}

android/screenShotCompare.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+diffFiles=./screenshotDiffs
+mkdir $diffFiles
+set -x
+./git-diff-image/install.sh
+GIT_DIFF_IMAGE_OUTPUT_DIR=$diffFiles git diff-image
+
+source scripts/lib.sh
+
+PR=$(echo "$GITHUB_REF_NAME" | sed "s/\// /" | awk '{print $1}')
+echo pr=$PR
+brew install jq
+
+echo "delete all old comments, starting with Screenshot differs:$emulatorApi"
+oldComments=$(curl_gh -X GET https://api.github.com/repos/"$GITHUB_REPOSITORY"/issues/"$PR"/comments | jq '.[] | (.id |tostring) + "|" + (.user.login | test("github-actions") | tostring) + "|" + (.body | test("Screenshot differs:'$emulatorApi'.*") | tostring)' | grep "true|true" | tr -d "\"" | cut -f1 -d"|")
+echo "comments=$comments"
+echo "$oldComments" | while read comment; do
+  echo "delete comment=$comment"
+  curl_gh -X DELETE https://api.github.com/repos/"$GITHUB_REPOSITORY"/issues/comments/"$comment"
+done
+
+pushd $diffFiles
+body=""
+COUNTER=0
+ls -la
+
+# ignore an error, when no files where found https://unix.stackexchange.com/a/723909/201876
+setopt no_nomatch
+for f in *.png; do
+  if [[ ${f} == "*.png" ]]
+  then
+    echo "nothing found"
+  else
+    (( COUNTER++ ))
+
+    newName="$1-${f}"
+    mv "${f}" "$newName"
+    echo "==> Uploaded screenshot $newName"
+    curl -i -F "file=@$newName" https://www.mxtracks.info/github
+    echo "==> Add screenshot comment $PR"
+    body="$body ${f}![screenshot](https://www.mxtracks.info/github/uploads/$newName) <br/><br/>"
+  fi
+done
+
+if [ ! "$body" == "" ]; then
+  curl_gh -X POST https://api.github.com/repos/"$GITHUB_REPOSITORY"/issues/$PR/comments -d "{ \"body\" : \"Screenshot differs:$emulatorApi $COUNTER <br/><br/> $body \" }"
+fi
+
+popd 1>/dev/null
+
+# set error when diffs are there
+[ "$(ls -A $diffFiles)" ] && exit 1 || exit 0