ci: Instrumentation tests coverage in ci.

androidApp/build.gradle.kts

@@ -96,6 +96,7 @@ android {
         // tests
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
         testInstrumentationRunnerArguments["clearPackageData"] = "true"
+        testInstrumentationRunnerArguments["useTestStorageService"] = "true"
     }
     packaging {
         resources {
@@ -109,6 +110,11 @@ android {
             proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
         }
         getByName("debug") {
+            isTestCoverageEnabled = true
+            enableAndroidTestCoverage = true
+            installation {
+                installOptions("-g", "-r")
+            }
         }
     }
     flavorDimensions.add("build")
@@ -197,14 +203,16 @@ 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:rules:1.6.1")
+    androidTestImplementation("androidx.test:runner:1.7.0-alpha01")
+    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:orchestrator:1.6.0-alpha02")
+    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")
@@ -227,6 +235,7 @@ tasks.withType<Test> {
 }
 
 aboutLibraries {
+    excludeFields = arrayOf("generated")
     offlineMode = true
     fetchRemoteLicense = false
     fetchRemoteFunding = false
@@ -235,3 +244,40 @@ aboutLibraries {
     duplicationMode = com.mikepenz.aboutlibraries.plugin.DuplicateMode.MERGE
     duplicationRule = com.mikepenz.aboutlibraries.plugin.DuplicateRule.GROUP
 }
+
+// Screenshot failure handling
+val reportsDirectory = file("$buildDir/reports/androidTests/connected")
+
+val clearScreenshotsTask =
+    tasks.register<Exec>("clearScreenshots") {
+        println("AMINE : clear")
+        commandLine = listOf("adb", "shell", "rm", "-r", "/sdcard/Pictures/selfoss_tests")
+    }
+
+val createScreenshotDirectoryTask =
+    tasks.register<Exec>("createScreenshotDirectory") {
+        println("AMINE : create directory")
+        group = "reporting"
+        commandLine = listOf("adb", "shell", "mkdir", "-p", "/sdcard/Pictures/selfoss_tests")
+    }
+
+val fetchScreenshotsTask =
+    tasks.register<Exec>("fetchScreenshots") {
+        println("AMINE : fetch")
+        group = "reporting"
+        executable(android.adbExecutable.toString())
+        commandLine = listOf("adb", "pull", "/sdcard/Pictures/selfoss_tests/.", reportsDirectory.toString())
+
+        finalizedBy(clearScreenshotsTask)
+        dependsOn(createScreenshotDirectoryTask)
+
+        doFirst {
+            reportsDirectory.mkdirs()
+        }
+    }
+
+tasks.whenTaskAdded {
+    if (this.name == "connectedAndroidTest") {
+        this.finalizedBy(fetchScreenshotsTask)
+    }
+}

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/CommonTests.kt

@@ -1,7 +1,11 @@
 package bou.amine.apps.readerforselfossv2.android
 
 import android.content.Context
+import android.os.Environment.DIRECTORY_PICTURES
+import android.os.Environment.getExternalStoragePublicDirectory
+import android.util.Log
 import androidx.annotation.ArrayRes
+import androidx.test.espresso.Espresso
 import androidx.test.espresso.Espresso.onData
 import androidx.test.espresso.Espresso.onView
 import androidx.test.espresso.action.ViewActions.click
@@ -9,13 +13,25 @@ import androidx.test.espresso.action.ViewActions.replaceText
 import androidx.test.espresso.action.ViewActions.typeTextIntoFocusedView
 import androidx.test.espresso.assertion.ViewAssertions.doesNotExist
 import androidx.test.espresso.assertion.ViewAssertions.matches
+import androidx.test.espresso.base.DefaultFailureHandler
 import androidx.test.espresso.matcher.ViewMatchers.isChecked
 import androidx.test.espresso.matcher.ViewMatchers.isDisplayed
 import androidx.test.espresso.matcher.ViewMatchers.isNotChecked
 import androidx.test.espresso.matcher.ViewMatchers.withId
 import androidx.test.espresso.matcher.ViewMatchers.withText
+import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
+import androidx.test.runner.screenshot.BasicScreenCaptureProcessor
+import androidx.test.runner.screenshot.Screenshot
+import androidx.test.uiautomator.UiDevice
+import androidx.test.uiautomator.UiSelector
 import org.hamcrest.CoreMatchers.allOf
 import org.hamcrest.Matchers.hasToString
+import org.junit.BeforeClass
+import org.junit.rules.TestWatcher
+import org.junit.runner.Description
+import java.io.File
+import java.io.IOException
+import java.util.Locale
 
 fun performLogin(someUrl: String? = null) {
     onView(withId(R.id.urlView)).perform(click()).perform(
@@ -119,3 +135,86 @@ fun testAddSourceWithUrl(
         .perform(click())
     onView(withText(sourceName)).check(matches(isDisplayed()))
 }
+
+open class WithANRException {
+    companion object {
+        // Running count of the number of Android Not Responding dialogues to prevent endless dismissal.
+        private var anrCount = 0
+
+        // `RootViewWithoutFocusException` class is private, need to match the message (instead of using type matching).
+        private val rootViewWithoutFocusExceptionMsg =
+            java.lang.String.format(
+                Locale.ROOT,
+                "Waited for the root of the view hierarchy to have " +
+                    "window focus and not request layout for 10 seconds. If you specified a non " +
+                    "default root matcher, it may be picking a root that never takes focus. " +
+                    "Root:",
+            )
+
+        private fun handleAnrDialogue() {
+            val device = UiDevice.getInstance(getInstrumentation())
+            // If running the device in English Locale
+            val waitButton = device.findObject(UiSelector().textContains("wait"))
+            if (waitButton.exists()) waitButton.click()
+        }
+
+        @JvmStatic
+        @BeforeClass
+        fun setUpHandler() {
+            Espresso.setFailureHandler { error, viewMatcher ->
+
+                if (error.message!!.contains(rootViewWithoutFocusExceptionMsg) && anrCount < 3) {
+                    anrCount++
+                    handleAnrDialogue()
+                } else { // chain all failures down to the default espresso handler
+                    DefaultFailureHandler(getInstrumentation().targetContext).handle(error, viewMatcher)
+                }
+            }
+        }
+    }
+}
+
+class MyScreenCaptureProcessor(
+    parentFolderPath: String,
+) : BasicScreenCaptureProcessor() {
+    init {
+        this.mDefaultScreenshotPath =
+            File(
+                File(
+                    getExternalStoragePublicDirectory(DIRECTORY_PICTURES),
+                    "selfoss_tests",
+                ).absolutePath,
+                "screenshots/$parentFolderPath",
+            )
+    }
+
+    override fun getFilename(prefix: String): String = prefix
+}
+
+fun takeScreenshot(
+    parentFolderPath: String = "",
+    screenShotName: String,
+) {
+    Log.d("Screenshots", "Taking screenshot of '$screenShotName'")
+    val screenCapture = Screenshot.capture()
+    val processors = setOf(MyScreenCaptureProcessor(parentFolderPath))
+    try {
+        screenCapture.apply {
+            name = screenShotName
+            process(processors)
+        }
+        Log.d("Screenshots", "Screenshot taken")
+    } catch (ex: IOException) {
+        Log.e("Screenshots", "Could not take the screenshot", ex)
+    }
+}
+
+class ScreenshotTakingRule : TestWatcher() {
+    override fun failed(
+        e: Throwable?,
+        description: Description,
+    ) {
+        val parentFolderPath = "failures/${description.className}"
+        takeScreenshot(parentFolderPath = parentFolderPath, screenShotName = description.methodName)
+    }
+}

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/HomeActivityTest.kt

@@ -18,14 +18,22 @@ import org.hamcrest.CoreMatchers.not
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 @LargeTest
-class HomeActivityTest {
+class HomeActivityTest : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     @Before
     fun init() {
         loginAndInitHome()
@@ -33,7 +41,7 @@ class HomeActivityTest {
 
     @Test
     fun testMenu() {
-        onView(withId(R.id.action_search)).check(matches(isDisplayed())).check(
+        onView(withId(R.id.action_search)).check(matches(not(isDisplayed()))).check(
             matches(
                 isClickable(),
             ),

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

@@ -17,14 +17,22 @@ import org.junit.After
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 @LargeTest
-class LoginActivityTest {
+class LoginActivityTest : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     @Before
     fun registerIdlingResource() {
         IdlingRegistry

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/SettingsActivityGeneralTest.kt

@@ -24,14 +24,22 @@ import org.hamcrest.CoreMatchers.not
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 @LargeTest
-class SettingsActivityGeneralTest {
+class SettingsActivityGeneralTest : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     @Before
     fun init() {
         loginAndInitHome()

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/SettingsActivityOfflineTest.kt

@@ -19,14 +19,22 @@ import org.hamcrest.CoreMatchers.not
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 @LargeTest
-class SettingsActivityOfflineTest {
+class SettingsActivityOfflineTest : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     lateinit var context: Context
 
     @Before

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/SettingsActivityReaderTest.kt

@@ -17,14 +17,22 @@ import org.hamcrest.CoreMatchers.not
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 @LargeTest
-class SettingsActivityReaderTest {
+class SettingsActivityReaderTest : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     lateinit var context: Context
 
     @Before

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/SettingsActivityTest.kt

@@ -15,13 +15,22 @@ import org.hamcrest.CoreMatchers.not
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 @LargeTest
-class SettingsActivityTest {
+class SettingsActivityTest : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
+
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     lateinit var context: Context
 
     @Before

androidApp/src/androidTest/kotlin/bou/amine/apps/readerforselfossv2/android/SourcesActivityTest.kt

@@ -18,15 +18,23 @@ import org.junit.After
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 import java.util.UUID
 
 @RunWith(AndroidJUnit4::class)
 @LargeTest
-class SourcesActivityTest {
+class SourcesActivityTest : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(LoginActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     lateinit var sourceName: String
 
     @Before