ci: Instrumentation tests coverage in ci.

androidApp/build.gradle.kts

@@ -248,21 +248,21 @@ val reportsDirectory = file("$buildDir/reports/androidTests/connected")
 val clearScreenshotsTask =
     tasks.register<Exec>("clearScreenshots") {
         println("AMINE : clear")
-        commandLine = listOf("adb", "shell", "rm", "-r", "/storage/emulated/0//Pictures/selfoss_tests")
+        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", "/storage/emulated/0//Pictures/selfoss_tests")
+        commandLine = listOf("adb", "shell", "mkdir", "-p", "/sdcard/Pictures/selfoss_tests")
     }
 
 tasks.register<Exec>("fetchScreenshots") {
     println("AMINE : fetch")
     group = "reporting"
     executable(android.adbExecutable.toString())
-    commandLine = listOf("adb", "pull", "/storage/emulated/0//Pictures/selfoss_tests/.", reportsDirectory.toString())
+    commandLine = listOf("adb", "pull", "/sdcard/Pictures/selfoss_tests/.", reportsDirectory.toString())
 
     finalizedBy(clearScreenshotsTask)
     dependsOn(createScreenshotDirectoryTask)

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

@@ -18,6 +18,7 @@ import org.junit.Before
 import org.junit.FixMethodOrder
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
 
@@ -29,6 +30,13 @@ class `1-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/2-HomeActivityTest.kt

@@ -18,6 +18,7 @@ import org.hamcrest.CoreMatchers.not
 import org.junit.FixMethodOrder
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
 
@@ -29,6 +30,13 @@ class `2-HomeActivityTest` : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(HomeActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     @Test
     fun testMenu() {
         onView(withId(R.id.action_search)).check(matches(isDisplayed())).check(

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

@@ -15,6 +15,7 @@ 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)
@@ -24,6 +25,13 @@ class `3-SettingsActivityTest` : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(HomeActivity::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/4-SettingsActivityGeneralTest.kt

@@ -25,6 +25,7 @@ import org.junit.Before
 import org.junit.FixMethodOrder
 import org.junit.Rule
 import org.junit.Test
+import org.junit.rules.RuleChain
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
 
@@ -36,6 +37,13 @@ class `4-SettingsActivityGeneralTest` : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(HomeActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     @Before
     fun init() {
         openActionBarOverflowOrOptionsMenu(

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

@@ -19,6 +19,7 @@ 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
 
 @Suppress("ktlint:standard:class-naming", "detekt:ClassNaming")
@@ -28,6 +29,13 @@ class `5-SettingsActivityReaderTest` : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(SettingsActivity::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/6-SettingsActivityOfflineTest.kt

@@ -21,6 +21,7 @@ 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
 
 @Suppress("ktlint:standard:class-naming", "detekt:ClassNaming")
@@ -30,6 +31,13 @@ class `6-SettingsActivityOfflineTest` : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(SettingsActivity::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/7-SourcesActivityTest.kt

@@ -18,6 +18,7 @@ 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
 
@@ -28,6 +29,13 @@ class `7-SourcesActivityTest` : WithANRException() {
     @get:Rule
     val activityRule = ActivityScenarioRule(HomeActivity::class.java)
 
+    @JvmField
+    @Rule
+    val ruleChain: RuleChain =
+        RuleChain
+            .outerRule(activityRule)
+            .around(ScreenshotTakingRule())
+
     lateinit var sourceName: String
 
     @Before

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

@@ -1,7 +1,6 @@
 package bou.amine.apps.readerforselfossv2.android
 
 import android.content.Context
-import android.graphics.Bitmap
 import android.os.Environment.DIRECTORY_PICTURES
 import android.os.Environment.getExternalStoragePublicDirectory
 import android.util.Log
@@ -21,14 +20,16 @@ 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 java.io.BufferedOutputStream
+import org.junit.rules.TestWatcher
+import org.junit.runner.Description
 import java.io.File
-import java.io.FileOutputStream
 import java.io.IOException
 import java.util.Locale
 
@@ -141,8 +142,6 @@ fun testAddSourceWithUrl(
 @Suppress("detekt:UtilityClassWithPublicConstructor")
 open class WithANRException {
     companion object {
-        private var testNumber = 0
-
         // Running count of the number of Android Not Responding dialogues to prevent endless dismissal.
         private var anrCount = 0
 
@@ -168,28 +167,22 @@ open class WithANRException {
         fun setUpHandler() {
             Espresso.setFailureHandler { error, viewMatcher ->
 
-                takeScreenshot("test-failures/", testNumber.toString())
                 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)
                 }
-                testNumber++
             }
         }
     }
 }
 
-fun takeScreenshot(
+class MyScreenCaptureProcessor(
-    parentFolderPath: String = "",
+    parentFolderPath: String,
-    screenShotName: String,
+) : BasicScreenCaptureProcessor() {
-) {
+    init {
-    Log.d("Screenshots", "Taking screenshot of '$screenShotName'")
+        this.mDefaultScreenshotPath =
-    try {
-        val bitmap = getInstrumentation().uiAutomation.takeScreenshot()
-
-        val folder =
             File(
                 File(
                     getExternalStoragePublicDirectory(DIRECTORY_PICTURES),
@@ -197,27 +190,35 @@ fun takeScreenshot(
                 ).absolutePath,
                 "screenshots/$parentFolderPath",
             )
-        if (!folder.exists()) {
+    }
-            folder.mkdirs()
-        }
 
-        var out: BufferedOutputStream? = null
+    override fun getFilename(prefix: String): String = prefix
-        try {
+}
-            out = BufferedOutputStream(FileOutputStream(folder.path + "/" + screenShotName + ".png"))
+
-            bitmap.compress(Bitmap.CompressFormat.PNG, 100, out)
+fun takeScreenshot(
-            Log.d("Screenshots", "Screenshot taken")
+    parentFolderPath: String = "",
-        } catch (e: IOException) {
+    screenShotName: String,
-            Log.e("Screenshots", "Could not save the screenshot", e)
+) {
-        } finally {
+    Log.d("Screenshots", "Taking screenshot of '$screenShotName'")
-            if (out != null) {
+    val screenCapture = Screenshot.capture()
-                try {
+    val processors = setOf(MyScreenCaptureProcessor(parentFolderPath))
-                    out.close()
+    try {
-                } catch (e: IOException) {
+        screenCapture.apply {
-                    Log.e("Screenshots", "Could not save the screenshot", e)
+            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)
+    }
+}