test: android test for MultimediaFragment intents

[criticalAY]

Purpose / Description

Test for multimedia activity intents i.e. camera, gallery & drawing

Approach

Use libs.androidx.espresso.intents to check if the intents are there or not, this will be useful to test other components too I.e cropper, audio recorder, etc

How Has This Been Tested?

Tested locally using ./gradlew connectedplayDebugAndroidTest

Checklist

Please, go through these checks before submitting the PR.

• You have a descriptive commit message with a short title (first line, max 50 chars).
• You have commented your code, particularly in hard-to-understand areas
• You have performed a self-review of your own code
• UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
• UI Changes: You have tested your change using the Google Accessibility Scanner

[lukstbit]

Check the android test failures they seem related to your changes.

[david-allison]

@criticalAY with apologies for the delay on this one, is Needs Author Reply Waiting for a reply from the original author still valid, or is this open for review?

[criticalAY]

Up for review

[david-allison]

Take it or leave it. I'm happy either way, and CI is happy. I'm more than happy with more tests 😁

Let me know if you want an explanation on anything here.

Index: AnkiDroid/src/androidTest/java/com/ichi2/anki/MultimediaTest.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/AnkiDroid/src/androidTest/java/com/ichi2/anki/MultimediaTest.kt b/AnkiDroid/src/androidTest/java/com/ichi2/anki/MultimediaTest.kt
--- a/AnkiDroid/src/androidTest/java/com/ichi2/anki/MultimediaTest.kt	(revision cf2ad33710b66061e3a276d57334cdaf3afeb135)
+++ b/AnkiDroid/src/androidTest/java/com/ichi2/anki/MultimediaTest.kt	(date 1733658217414)
@@ -19,6 +19,7 @@
 
 import android.content.Context
 import android.content.Intent
+import androidx.fragment.app.Fragment
 import androidx.test.core.app.ActivityScenario
 import androidx.test.espresso.Espresso.onView
 import androidx.test.espresso.assertion.ViewAssertions.matches
@@ -38,7 +39,6 @@
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.Parameterized
-import kotlin.test.DefaultAsserter.assertEquals
 import kotlin.test.assertEquals
 
 @RunWith(Parameterized::class)
@@ -50,15 +50,22 @@
 
     @JvmField
     @Parameterized.Parameter(1)
-    var title: Int? = null
+    var expectedTitleRes: Int? = null
+
+    @Suppress("unused") // used by "{2}"
+    @JvmField
+    @Parameterized.Parameter(2)
+    var testName: String = ""
+
+    private val expectedTitle
+        get() = testContext.getString(expectedTitleRes!!)
 
     @Test
     fun testFragmentTitle() {
-        ActivityScenario.launch<MultimediaActivity>(intentBuilder(testContext)).use { scenario ->
+        withMultimediaActivityScenario { scenario ->
             scenario.onActivity { activity ->
-                val fragment = activity.supportFragmentManager.findFragmentById(R.id.fragment_container) as MultimediaFragment
-                val titleString = title?.let { testContext.getString(it) }
-                assertEquals(titleString, fragment.title)
+                val actualFragmentTitle = (activity.fragmentContainer as MultimediaFragment).title
+                assertEquals(expectedTitle, actualFragmentTitle, message = "title")
             }
         }
     }
@@ -66,7 +73,7 @@
     @Test
     fun testImageFragmentDiscardDialogShown() {
         val validIntentBuilders = setOf(
-            { context: Context -> getImageFragment(context) },
+            { context: Context -> getCameraFragment(context) },
             { context: Context -> getGalleryFragment(context) },
             { context: Context -> getDrawingFragment(context) }
         )
@@ -75,11 +82,12 @@
             return
         }
 
-        ActivityScenario.launch<MultimediaActivity>(intentBuilder(testContext)).use { scenario ->
+        withMultimediaActivityScenario { scenario ->
             scenario.onActivity { activity ->
-                val fragment = activity.supportFragmentManager.findFragmentById(R.id.fragment_container) as MultimediaImageFragment
-                fragment.viewModel.updateCurrentMultimediaPath("test/path")
-                fragment.requireActivity().onBackPressedDispatcher.onBackPressed()
+                (activity.fragmentContainer as MultimediaImageFragment).apply {
+                    viewModel.updateCurrentMultimediaPath("test/path")
+                    requireActivity().onBackPressedDispatcher.onBackPressed()
+                }
             }
 
             onView(withText(CollectionManager.TR.addingDiscardCurrentInput()))
@@ -94,23 +102,32 @@
         }
     }
 
+    /** Runs [ActivityScenario.launch] with the result of the [intentBuilder] */
+    private fun withMultimediaActivityScenario(block: (ActivityScenario<MultimediaActivity>) -> Unit) {
+        ActivityScenario.launch<MultimediaActivity>(intentBuilder(testContext)).use { block(it) }
+    }
+
+    private val MultimediaActivity.fragmentContainer: Fragment
+        get() = this.supportFragmentManager.findFragmentById(R.id.fragment_container)!!
+
+
     companion object {
-        @Parameterized.Parameters(name = "{index}: {1}")
+        @Parameterized.Parameters(name = "{2}")
         @JvmStatic
         fun initParameters(): Collection<Array<out Any>> {
             return listOf(
-                arrayOf({ context: Context -> getImageFragment(context) }, R.string.multimedia_editor_popup_image),
-                arrayOf({ context: Context -> getGalleryFragment(context) }, R.string.multimedia_editor_popup_image),
-                arrayOf({ context: Context -> getDrawingFragment(context) }, R.string.multimedia_editor_popup_image),
-                arrayOf({ context: Context -> getAudioFragment(context) }, R.string.multimedia_editor_popup_audio_clip),
-                arrayOf({ context: Context -> getVideoFragment(context) }, R.string.multimedia_editor_popup_video_clip),
-                arrayOf({ context: Context -> getAudioRecordingFragment(context) }, R.string.multimedia_editor_field_editing_audio)
+                arrayOf({ context: Context -> getCameraFragment(context) }, R.string.multimedia_editor_popup_image, "Add image (Camera)"),
+                arrayOf({ context: Context -> getGalleryFragment(context) }, R.string.multimedia_editor_popup_image, "Add image (Gallery)"),
+                arrayOf({ context: Context -> getDrawingFragment(context) }, R.string.multimedia_editor_popup_image, "Add image (Drawing)"),
+                arrayOf({ context: Context -> getAudioFragment(context) }, R.string.multimedia_editor_popup_audio_clip, "Add audio clip"),
+                arrayOf({ context: Context -> getVideoFragment(context) }, R.string.multimedia_editor_popup_video_clip, "Add video clip"),
+                arrayOf({ context: Context -> getAudioRecordingFragment(context) }, R.string.multimedia_editor_field_editing_audio, "Record audio")
             )
         }
 
         private val multimediaActivityExtra = MultimediaActivityExtra(0, ImageField(), getTestMultimediaNote())
 
-        private fun getImageFragment(context: Context): Intent {
+        private fun getCameraFragment(context: Context): Intent {
             return MultimediaImageFragment.getIntent(
                 context,
                 multimediaActivityExtra,

[lukstbit]

Ok, I didn't had any issues with the code itself just with how useful I perceived it to be.

[criticalAY]

@david-allison thanks! applied the patch

[mikehardy]

com.ichi2.anki.MultimediaTest > testFragmentTitle[Add image (Camera)][emulator-5554 - 11] FAILED 
	java.lang.NullPointerException: Cannot run onActivity since Activity has been destroyed already
	at androidx.test.internal.util.Checks.checkNotNull(Checks.java:50)

That's not a good sign - adding a flaky test is worse than adding no test, this needs real investigation + real fix so it isn't flaky

[mikehardy]

flaky

[criticalAY]

I am reverting the patch and will run 20 iterations lets see then

[david-allison]

@criticalAY to confirm: we have a GitHub action you can run for the 20x testing

[criticalAY]

It is not poping up for emulated test but unit

[mikehardy]

The Flake Hammer (tm) was implemented unit test only
mikehardy@e524c8f

[criticalAY]

I have run emulated tests 16 times by manually triggering the CI, all green there