ci: Instrumentation tests coverage in ci.

.gitea/workflows/common_coverage.yml

@@ -0,0 +1,65 @@
+name: Coverage
+on:
+  workflow_call:
+
+jobs:
+  BuildAndTestAndCoverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Fetch tags
+        run: git fetch --tags -p
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: gradle
+      - uses: gradle/actions/setup-gradle@v3
+      - uses: android-actions/setup-android@v3
+      - name: Configure gradle...
+        run: mkdir -p ~/.gradle && echo "ignoreGitVersion=true" >> ~/.gradle/gradle.properties
+      - uses: KengoTODA/actions-setup-docker-compose@v1
+        with:
+          version: "2.23.3"
+      - name: run selfoss
+        run: |
+          docker compose -f .gitea/workflows/assets/docker-compose.yml up -d
+      - name: Set env url
+        run: |
+          export SELFOSS_URL=172.17.0.1:8888
+      # https://github.com/ReactiveCircus/android-emulator-runner/issues/385
+      - name: Kill crashpad_handler processes
+        if: always()
+        run: |
+          pkill -SIGTERM crashpad_handler || true
+          sleep 5
+          pkill -SIGKILL crashpad_handler || true
+      - name: Tests
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 29
+          script: |
+            ./gradlew androidApp:connectedAndroidTest
+            killall -INT crashpad_handler || true
+      - uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: failure-espresso
+          path: build/reports/androidTests/connected/screenshots
+          retention-days: 2
+          overwrite: true
+          include-hidden-files: true
+      - uses: actions/upload-artifact@v3
+        with:
+          name: coverage-espresso
+          path: build/reports/coverage/androidTest/githubConfig/debug/connected
+          retention-days: 1
+          overwrite: true
+          include-hidden-files: true
+      - name: Clean
+        if: always()
+        run: |
+          docker compose -f .gitea/workflows/assets/docker-compose.yml stop

.gitea/workflows/on_pr.yml

@@ -3,89 +3,160 @@ on:
   pull_request:
     branches:
       - master
-      - chore-crowdin-ci
 
 jobs:
-  Lint:
+  BuildAndTestAndCoverage:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
-        with:
-          distribution: 'temurin'
-          java-version: '17'
-          cache: gradle
-      - name: Install klint
-        run: curl -sSLO https://github.com/pinterest/ktlint/releases/download/1.5.0/ktlint && chmod a+x ktlint && mv ktlint /usr/local/bin/
-      - name: Install detekt
-        run: curl -sSLO https://github.com/detekt/detekt/releases/download/v1.23.7/detekt-cli-1.23.7.zip && unzip detekt-cli-1.23.7.zip
-      - name: Linting...
-        run: ktlint 'shared/**/*.kt' 'androidApp/**/*.kt' '!shared/build'
-      - name: Detecting...
-        run: ./detekt-cli-1.23.7/bin/detekt-cli -c detekt.yml --excludes '**/shared/build/**/*.kt'
-  translations:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: "Check translations changes"
+      - name: Fetch tags
-        id: check-translations-changes
+        run: git fetch --tags -p
-        uses: tj-actions/changed-files@v45
+      - uses: actions/setup-java@v4
         with:
-          files: |
+          distribution: 'temurin'
-            androidApp/src/main/res/values/strings.xml
+          java-version: '17'
-      - name: upload translation sources
+      - uses: gradle/actions/setup-gradle@v3
-        if: steps.check-api-changes.outputs.any_modified == 'true'
+      - uses: android-actions/setup-android@v3
-        uses: crowdin/github-action@v2
+      - name: Configure gradle...
+        run: mkdir -p ~/.gradle && echo "ignoreGitVersion=true" >> ~/.gradle/gradle.properties
+      - uses: KengoTODA/actions-setup-docker-compose@v1
         with:
-          config: './.gitea/workflows/assets/crowdin.yml'
+          version: "2.23.3"
-          upload_sources: true
+      - name: run selfoss
-          upload_translations: false
-          download_translations: false
-          create_pull_request: false
-          push_translations: false
-        env:
-          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
-          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
-      - name: wait
-        if: steps.check-api-changes.outputs.any_modified == 'true'
-        run: sleep 10s
-      - name: download translations
-        if: steps.check-api-changes.outputs.any_modified == 'true'
-        uses: crowdin/github-action@v2
-        with:
-          config: './.gitea/workflows/assets/crowdin.yml'
-          upload_sources: false
-          upload_translations: false
-          download_translations: true
-          create_pull_request: false
-          push_translations: false
-        env:
-          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
-          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
-      - name: Check for uncommitted changes
-        if: steps.check-api-changes.outputs.any_modified == 'true'
-        id: check-changes
-        uses: mskri/check-uncommitted-changes-action@v1.0.1
-      - name: Commit Changes
-        if: steps.check-api-changes.outputs.any_modified == 'true' && steps.check-changes.outputs.changes != ''
         run: |
-          git config --global user.email aminecmi+giteadrone@pm.me
+          docker compose -f .gitea/workflows/assets/docker-compose.yml up -d
-          git config --global user.name giteadrone
+      # https://github.com/ReactiveCircus/android-emulator-runner/issues/385
-          git add ./androidApp/src/main/res/*
+      - name: Kill crashpad_handler processes
-          git commit -m "translation: translation files"
+        if: always()
-      - name: Push changes
+        run: |
-        if: steps.check-api-changes.outputs.any_modified == 'true' && steps.check-changes.outputs.changes != ''
+          pkill -SIGTERM crashpad_handler || true
-        uses: appleboy/git-push-action@v1.0.0
+          sleep 5
+          pkill -SIGKILL crashpad_handler || true
+      - name: Change url until I find a better way to do it
+        run: |
+          sed -i "s/val defaultUrl = \"http:\/\/10\.0\.2\.2\:8888\"/val defaultUrl = \"http:\/\/172\.17\.0\.1\:8888\"/g" ./androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/CommonTests.kt
+      - name: Tests
+        uses: reactivecircus/android-emulator-runner@v2
         with:
-          author_name: giteadrone
+          api-level: 29
-          author_email: aminecmi+giteadrone@pm.me
+          script: |
-          remote: ${{ secrets.REMOTE_URL }}
+            ./gradlew androidApp:clearScreenshotsTask || true
-          ssh_key: ${{ secrets.PRIVATE_KEY }}
+            ./gradlew androidApp:createScreenshotDirectory
-          branch: ${{ github.head_ref || github.ref_name }}
+            adb logcat -G 16M
-  build:
+            ./gradlew JacocoDebugCodeCoverage || true
-    needs: Lint
+            ./gradlew androidApp:fetchScreenshots
-    uses: ./.gitea/workflows/common_build.yml
+            adb logcat 'InputReader:S' 'chatty:S' 'audio_hw_generic:S' '*:I' -d > ./androidApp/build/reports/androidTests/connected/screenshots/logs.txt
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: screenshot-espresso
+          path: androidApp/build/reports/androidTests/connected/screenshots
+          retention-days: 2
+          overwrite: true
+          include-hidden-files: true
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: result-espresso
+          path: androidApp/build/reports/androidTests/connected/debug/flavors/githubConfig
+          retention-days: 1
+          overwrite: true
+          include-hidden-files: true
+      - uses: actions/upload-artifact@v3
+        with:
+          name: coverage-espresso
+          path: androidApp/build/reports/jacoco/JacocoDebugCodeCoverage
+          retention-days: 1
+          overwrite: true
+          include-hidden-files: true
+      - name: Clean
+        if: always()
+        run: |
+          docker compose -f .gitea/workflows/assets/docker-compose.yml stop
+
+#  Lint:
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: Check out repository code
+#        uses: actions/checkout@v4
+#      - uses: actions/setup-java@v4
+#        with:
+#          distribution: 'temurin'
+#          java-version: '17'
+#          cache: gradle
+#      - name: Install klint
+#        run: curl -sSLO https://github.com/pinterest/ktlint/releases/download/1.5.0/ktlint && chmod a+x ktlint && mv ktlint /usr/local/bin/
+#      - name: Install detekt
+#        run: curl -sSLO https://github.com/detekt/detekt/releases/download/v1.23.7/detekt-cli-1.23.7.zip && unzip detekt-cli-1.23.7.zip
+#      - name: Linting...
+#        run: ktlint 'shared/**/*.kt' 'androidApp/**/*.kt' '!shared/build'
+#      - name: Detecting...
+#        run: ./detekt-cli-1.23.7/bin/detekt-cli -c detekt.yml --excludes '**/shared/build/**/*.kt'
+#  translations:
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: Check out repository code
+#        uses: actions/checkout@v4
+#        with:
+#          fetch-depth: 0
+#      - name: "Check translations changes"
+#        id: check-translations-changes
+#        uses: tj-actions/changed-files@v45
+#        with:
+#          files: |
+#            androidApp/src/main/res/values/strings.xml
+#      - name: upload translation sources
+#        if: steps.check-api-changes.outputs.any_modified == 'true'
+#        uses: crowdin/github-action@v2
+#        with:
+#          config: './.gitea/workflows/assets/crowdin.yml'
+#          upload_sources: true
+#          upload_translations: false
+#          download_translations: false
+#          create_pull_request: false
+#          push_translations: false
+#        env:
+#          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+#          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+#      - name: wait
+#        if: steps.check-api-changes.outputs.any_modified == 'true'
+#        run: sleep 10s
+#      - name: download translations
+#        if: steps.check-api-changes.outputs.any_modified == 'true'
+#        uses: crowdin/github-action@v2
+#        with:
+#          config: './.gitea/workflows/assets/crowdin.yml'
+#          upload_sources: false
+#          upload_translations: false
+#          download_translations: true
+#          create_pull_request: false
+#          push_translations: false
+#        env:
+#          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+#          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
+#      - name: Check for uncommitted changes
+#        if: steps.check-api-changes.outputs.any_modified == 'true'
+#        id: check-changes
+#        uses: mskri/check-uncommitted-changes-action@v1.0.1
+#      - name: Commit Changes
+#        if: steps.check-api-changes.outputs.any_modified == 'true' && steps.check-changes.outputs.changes != ''
+#        run: |
+#          git config --global user.email aminecmi+giteadrone@pm.me
+#          git config --global user.name giteadrone
+#          git add ./androidApp/src/main/res/*
+#          git commit -m "translation: translation files"
+#      - name: Push changes
+#        if: steps.check-api-changes.outputs.any_modified == 'true' && steps.check-changes.outputs.changes != ''
+#        uses: appleboy/git-push-action@v1.0.0
+#        with:
+#          author_name: giteadrone
+#          author_email: aminecmi+giteadrone@pm.me
+#          remote: ${{ secrets.REMOTE_URL }}
+#          ssh_key: ${{ secrets.PRIVATE_KEY }}
+#          branch: ${{ github.head_ref || github.ref_name }}
+#  build:
+#    needs: Lint
+#    uses: ./.gitea/workflows/common_build.yml

androidApp/build.gradle.kts

@@ -10,6 +10,7 @@ plugins {
     id("com.mikepenz.aboutlibraries.plugin")
     id("org.jetbrains.kotlinx.kover")
     id("app.cash.sqldelight") version "2.0.2"
+    jacoco
 }
 
 fun Project.execWithOutput(
@@ -64,6 +65,15 @@ fun versionNameFromGit(): String {
     return gitVersion()
 }
 
+val exclusions =
+    listOf(
+        "**/R.class",
+        "**/R\$*.class",
+        "**/BuildConfig.*",
+        "**/Manifest*.*",
+        "**/*Test*.*",
+    )
+
 android {
     compileOptions {
         isCoreLibraryDesugaringEnabled = true
@@ -95,7 +105,7 @@ android {
 
         // tests
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
-        testInstrumentationRunnerArguments["clearPackageData"] = "true"
+        testInstrumentationRunnerArguments["useTestStorageService"] = "true"
     }
     packaging {
         resources {
@@ -109,6 +119,44 @@ android {
             proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
         }
         getByName("debug") {
+            isTestCoverageEnabled = true
+            enableAndroidTestCoverage = true
+            installation {
+                installOptions("-g", "-r")
+            }
+
+            val androidTests = "connectedAndroidTest"
+            tasks.register<JacocoReport>("JacocoDebugCodeCoverage") {
+                // Depend on unit tests and Android tests tasks
+                dependsOn(listOf(androidTests))
+                // Set task grouping and description
+                group = "Reporting"
+                description = "Execute UI and unit tests, generate and combine Jacoco coverage report"
+                // Configure reports to generate both XML and HTML formats
+                reports {
+                    xml.required.set(true)
+                    html.required.set(true)
+                }
+                // Set source directories to the main source directory
+                sourceDirectories.setFrom(layout.projectDirectory.dir("src/main"))
+                // Set class directories to compiled Java and Kotlin classes, excluding specified exclusions
+                classDirectories.setFrom(
+                    files(
+                        fileTree(layout.buildDirectory.dir("intermediates/javac/")) {
+                            exclude(exclusions)
+                        },
+                        fileTree(layout.buildDirectory.dir("tmp/kotlin-classes/")) {
+                            exclude(exclusions)
+                        },
+                    ),
+                )
+                // Collect execution data from .exec and .ec files generated during test execution
+                executionData.setFrom(
+                    files(
+                        fileTree(layout.buildDirectory) { include(listOf("**/*.exec", "**/*.ec")) },
+                    ),
+                )
+            }
         }
     }
     flavorDimensions.add("build")
@@ -121,7 +169,6 @@ android {
     namespace = "bou.amine.apps.readerforselfossv2.android"
     testOptions {
         animationsDisabled = true
-        execution = "ANDROIDX_TEST_ORCHESTRATOR"
         unitTests {
             isIncludeAndroidResources = true
         }
@@ -154,8 +201,8 @@ dependencies {
     implementation("androidx.multidex:multidex:2.0.1")
 
     // About
-    implementation("com.mikepenz:aboutlibraries-core:10.5.1")
+    implementation("com.mikepenz:aboutlibraries-core:11.6.3")
-    implementation("com.mikepenz:aboutlibraries:10.5.1")
+    implementation("com.mikepenz:aboutlibraries:11.6.3")
 
     // Material-ish things
     implementation("com.ashokvarma.android:bottom-navigation-bar:2.2.0")
@@ -197,14 +244,15 @@ dependencies {
     testImplementation("io.mockk:mockk:1.13.14")
     testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.1")
     implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.6.1")
-    androidTestImplementation("androidx.test:runner:1.6.2")
+    androidTestImplementation("androidx.test:runner:1.7.0-alpha01")
-    androidTestImplementation("androidx.test:rules:1.6.1")
+    androidTestImplementation("androidx.test:rules:1.7.0-alpha01")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.6.1")
     implementation("androidx.test.espresso:espresso-idling-resource:3.6.1")
     androidTestImplementation("androidx.test.ext:junit-ktx:1.2.1")
-    androidTestUtil("androidx.test:orchestrator:1.5.1")
+    androidTestUtil("androidx.test.services:test-services:1.6.0-alpha02")
     testImplementation("org.robolectric:robolectric:4.14.1")
-    testImplementation("androidx.test:core-ktx:1.6.1")
+    testImplementation("androidx.test:core-ktx:1.7.0-alpha01")
+    androidTestImplementation("androidx.test.uiautomator:uiautomator:2.3.0")
 
     implementation("ch.acra:acra-http:$acraVersion")
     implementation("ch.acra:acra-toast:$acraVersion")
@@ -224,9 +272,16 @@ tasks.withType<Test> {
             )
         showStandardStreams = true
     }
+    if (this.name == "connectedAndroidTest") {
+        configure<JacocoTaskExtension> {
+            isIncludeNoLocationClasses = true
+            excludes = listOf("jdk.internal.*")
+        }
+    }
 }
 
 aboutLibraries {
+    excludeFields = arrayOf("generated")
     offlineMode = true
     fetchRemoteLicense = false
     fetchRemoteFunding = false
@@ -235,3 +290,30 @@ aboutLibraries {
     duplicationMode = com.mikepenz.aboutlibraries.plugin.DuplicateMode.MERGE
     duplicationRule = com.mikepenz.aboutlibraries.plugin.DuplicateRule.GROUP
 }
+
+val clearScreenshotsTask =
+    tasks.register<Exec>("clearScreenshots") {
+        println("AMINE : clear")
+        commandLine = listOf("adb", "shell", "rm", "-r", "/storage/emulated/0/Pictures/selfoss_tests/screenshots/*")
+    }
+
+val createScreenshotDirectoryTask =
+    tasks.register<Exec>("createScreenshotDirectory") {
+        println("AMINE : create directory")
+        group = "reporting"
+        commandLine = listOf("adb", "shell", "mkdir", "-p", "/storage/emulated/0/Pictures/selfoss_tests/screenshots")
+    }
+
+tasks.register<Exec>("fetchScreenshots") {
+    val reportsDirectory = file("$buildDir/reports/androidTests/connected")
+    println("AMINE : fetch")
+    group = "reporting"
+    executable(android.adbExecutable.toString())
+    commandLine = listOf("adb", "pull", "/storage/emulated/0/Pictures/selfoss_tests/screenshots", reportsDirectory.toString())
+
+    finalizedBy(clearScreenshotsTask)
+
+    doFirst {
+        reportsDirectory.mkdirs()
+    }
+}

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/1-LoginActivityTest.kt

@@ -15,13 +15,17 @@ import androidx.test.filters.LargeTest
 import bou.amine.apps.readerforselfossv2.android.testing.CountingIdlingResourceSingleton
 import org.junit.After
 import org.junit.Before
+import org.junit.FixMethodOrder
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
+import org.junit.runners.MethodSorters
 
+@Suppress("ktlint:standard:class-naming", "detekt:ClassNaming")
 @RunWith(AndroidJUnit4::class)
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
 @LargeTest
-class LoginActivityTest {
+class `1-LoginActivityTest` : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
 
@@ -40,7 +44,7 @@ class LoginActivityTest {
     }
 
     @Test
-    fun viewIsInitialized() {
+    fun `1-viewIsInitialized`() {
         onView(withId(R.id.urlView)).check(matches(isDisplayed()))
         onView(withId(R.id.selfSigned))
             .check(matches(isDisplayed()))
@@ -57,28 +61,28 @@ class LoginActivityTest {
     }
 
     @Test
-    fun urlError() {
+    fun `2-urlError`() {
         performLogin("10.0.2.2:8888")
         onView(withId(R.id.urlView)).perform(click())
         onView(withId(R.id.urlView)).check(matches(withError(R.string.login_url_problem)))
     }