Migrate Android Tests to Unit Tests

Author: MGaetan89

.github/workflows/quality.yml

@@ -167,42 +167,3 @@ jobs:
           cache-encryption-key: ${{ secrets.GRADLE_CACHE_ENCRYPTION_KEY }}
       - name: Generate documentation
         run: ./gradlew :dokkaGenerate
-
-  android-tests:
-    name: Android Tests
-    runs-on: ubuntu-latest
-    env:
-      USERNAME: ${{ github.actor }}
-      GITHUB_TOKEN: ${{ github.token }}
-    strategy:
-      matrix:
-        api-level: [ 26 ]
-    steps:
-      - name: Enable KVM
-        # https://github.blog/changelog/2023-02-23-hardware-accelerated-android-virtualization-on-actions-windows-and-linux-larger-hosted-runners/
-        run: |
-          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
-          sudo udevadm control --reload-rules
-          sudo udevadm trigger --name-match=kvm
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up Java
-        uses: actions/setup-java@v4
-        with:
-          java-version: '17'
-          distribution: 'temurin'
-      - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@v4
-        with:
-          cache-encryption-key: ${{ secrets.GRADLE_CACHE_ENCRYPTION_KEY }}
-      - name: Run Android Tests
-        uses: reactivecircus/android-emulator-runner@v2
-        with:
-          api-level: ${{ matrix.api-level }}
-          arch: x86_64
-          # Supported tasks per module
-          # :pillarbox-analytics:connectedDebugAndroidTest
-          # :pillarbox-core-business:connectedDebugAndroidTest
-          # :pillarbox-player:connectedDebugAndroidTest
-          # :pillarbox-ui:connectedDebugAndroidTest
-          script: ./gradlew :pillarbox-player:connectedDebugAndroidTest

gradle/libs.versions.toml

@@ -12,7 +12,6 @@ androidx-paging = "3.3.6"
 androidx-test-core = "1.6.1"
 androidx-test-ext-junit = "1.2.1"
 androidx-test-monitor = "1.7.2"
-androidx-test-runner = "1.6.2"
 androidx-tv-material = "1.0.0"
 coil = "3.2.0"
 comscore = "6.11.1"
@@ -61,7 +60,6 @@ androidx-paging-common = { module = "androidx.paging:paging-common", version.ref
 androidx-paging-compose = { module = "androidx.paging:paging-compose", version.ref = "androidx-paging" }
 androidx-test-core = { module = "androidx.test:core", version.ref = "androidx-test-core" }
 androidx-test-monitor = { module = "androidx.test:monitor", version.ref = "androidx-test-monitor" }
-androidx-test-runner = { module = "androidx.test:runner", version.ref = "androidx-test-runner" }
 androidx-tv-material = { module = "androidx.tv:tv-material", version.ref = "androidx-tv-material" }
 coil = { group = "io.coil-kt.coil3", name = "coil", version.ref = "coil" }
 coil-compose = { group = "io.coil-kt.coil3", name = "coil-compose", version.ref = "coil" }

pillarbox-player-testutils/src/main/java/ch/srgssr/pillarbox/player/test/utils/TestPillarboxRunHelper.kt

@@ -30,7 +30,7 @@ object TestPillarboxRunHelper {
      * Runs tasks of the main [Looper] until [Player.Listener.onEvents] matches the
      * expected state or a playback error occurs.
      *
-     * <p>If a playback error occurs it will be thrown wrapped in an [IllegalStateException].
+     * If a playback error occurs, it will be thrown wrapped in an [IllegalStateException].
      *
      * @param player The [Player].
      * @param expectedEvents The expected [Player.Event]. If empty, waits until the first [Player.Listener.onEvents].
@@ -62,7 +62,7 @@ object TestPillarboxRunHelper {
     /**
      * Runs tasks of the main Looper until [Player.Listener.onPlaybackParametersChanged] is called or a playback error occurs.
      *
-     * <p>If a playback error occurs it will be thrown wrapped in an {@link IllegalStateException}.
+     * If a playback error occurs, it will be thrown wrapped in an [IllegalStateException].
      *
      * @param player The [Player].
      * @throws TimeoutException If the [RobolectricUtil.DEFAULT_TIMEOUT_MS] is exceeded.
@@ -105,4 +105,36 @@ object TestPillarboxRunHelper {
             player.currentPosition >= position.inWholeMilliseconds
         }
     }
+
+    /**
+     * Run and wait until [Player.isPlaying] is [isPlaying].
+
+     * If a playback error occurs, it will be thrown wrapped in an [IllegalStateException].
+     *
+     * @param player The [Player].
+     * @param isPlaying The expected value of [Player.isPlaying].
+
+     * @throws TimeoutException If the [RobolectricUtil.DEFAULT_TIMEOUT_MS] is exceeded.
+     */
+    @Throws(TimeoutException::class)
+    fun runUntilIsPlaying(player: Player, isPlaying: Boolean) {
+        verifyMainTestThread(player)
+        if (player is ExoPlayer) {
+            verifyPlaybackThreadIsAlive(player)
+        }
+        val receivedCallback = AtomicBoolean(false)
+        val listener = object : Player.Listener {
+            override fun onIsPlayingChanged(actual: Boolean) {
+                if (actual == isPlaying) {
+                    receivedCallback.set(true)
+                }
+            }
+        }
+        player.addListener(listener)
+        RobolectricUtil.runMainLooperUntil { receivedCallback.get() || player.playerError != null }
+        player.removeListener(listener)
+        if (player.playerError != null) {
+            throw IllegalStateException(player.playerError)
+        }
+    }
 }

pillarbox-player/build.gradle.kts

@@ -19,16 +19,6 @@ android {
     buildFeatures {
         buildConfig = true
     }
-
-    // Mockk includes some licenses information, which may conflict with other license files. This block merges all licenses together.
-    // Mockk excludes all licenses instead:
-    // https://github.com/mockk/mockk/blob/f879502a044c83c2a5fd52992f20903209eb34f3/modules/mockk-android/build.gradle.kts#L14-L19
-    packaging {
-        resources {
-            merges += "META-INF/LICENSE.md"
-            merges += "META-INF/LICENSE-notice.md"
-        }
-    }
 }
 
 dependencies {
@@ -64,15 +54,8 @@ dependencies {
     testImplementation(libs.mockk)
     testImplementation(libs.mockk.dsl)
     testImplementation(libs.okio)
-    testRuntimeOnly(libs.robolectric)
+    testImplementation(libs.robolectric)
     testImplementation(libs.robolectric.annotations)
     testImplementation(libs.robolectric.shadows.framework)
     testImplementation(libs.turbine)
-
-    androidTestImplementation(libs.androidx.test.monitor)
-    androidTestRuntimeOnly(libs.androidx.test.runner)
-    androidTestImplementation(libs.junit)
-    androidTestImplementation(libs.kotlin.test)
-    androidTestRuntimeOnly(libs.kotlinx.coroutines.android)
-    androidTestImplementation(libs.mockk)
 }

pillarbox-player/src/androidTest/java/ch/srgssr/pillarbox/player/IsPlayingAllTypeOfContentTest.kt

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) SRG SSR. All rights reserved.
+ * License information is available from the LICENSE file.
+ */
+package ch.srgssr.pillarbox.player
+
+import android.net.Uri
+import android.os.Looper
+import androidx.media3.common.MediaItem
+import androidx.media3.common.Player
+import androidx.media3.test.utils.FakeClock
+import androidx.test.core.app.ApplicationProvider
+import ch.srgssr.pillarbox.player.test.utils.TestPillarboxRunHelper
+import org.junit.runner.RunWith
+import org.robolectric.ParameterizedRobolectricTestRunner
+import org.robolectric.ParameterizedRobolectricTestRunner.Parameters
+import org.robolectric.Shadows.shadowOf
+import kotlin.coroutines.EmptyCoroutineContext
+import kotlin.test.AfterTest
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertNotNull
+import kotlin.test.assertTrue
+
+@RunWith(ParameterizedRobolectricTestRunner::class)
+class IsPlayingAllTypeOfContentTest(
+    private val urlToTest: String,
+) {
+    private lateinit var player: PillarboxExoPlayer
+
+    @BeforeTest
+    fun setUp() {
+        player = PillarboxExoPlayer(
+            context = ApplicationProvider.getApplicationContext(),
+            type = Default,
+        ) {
+            clock(FakeClock(true))
+            coroutineContext(EmptyCoroutineContext)
+        }
+    }
+
+    @AfterTest
+    fun tearDown() {
+        player.release()
+
+        shadowOf(Looper.getMainLooper()).idle()
+    }
+
+    @Test
+    fun `is playing`() {
+        player.setMediaItem(MediaItem.fromUri(urlToTest))
+        player.prepare()
+        player.play()
+
+        TestPillarboxRunHelper.runUntilIsPlaying(player, isPlaying = true)
+
+        assertEquals(Player.STATE_READY, player.playbackState)
+        assertTrue(player.isPlaying)
+        assertNotNull(player.currentMediaItem)
+        assertEquals(player.currentMediaItem?.localConfiguration?.uri, Uri.parse(urlToTest))
+    }
+
+    companion object {
+        @JvmStatic
+        @Suppress("unused", "MaximumLineLength", "MaxLineLength")
+        @Parameters(name = "{index}: {0}")
+        fun parameters(): Iterable<Any> {
+            return listOf(
+                // From urn:swi:video:48940210
+                "https://cdn.prod.swi-services.ch/video-projects/141b30ce-3850-424b-9063-a20d5619d342/localised-videos/ENG/renditions/ENG.mp4",
+                "https://rts-vod-amd.akamaized.net/ww/14970442/da2b38fb-ca9f-3c76-80c6-e6fa7f3c2699/master.m3u8",
+                "https://storage.googleapis.com/wvmedia/clear/h264/tears/tears.mpd",
+                "https://storage.googleapis.com/wvmedia/clear/hevc/tears/tears.mpd",
+                "https://rtsc3video.akamaized.net/hls/live/2042837/c3video/3/playlist.m3u8?dw=0",
+                "https://rtsc3video.akamaized.net/hls/live/2042837/c3video/3/playlist.m3u8",
+                "https://download-media.srf.ch/world/audio/Echo_der_Zeit_radio/2025/01/Echo_der_Zeit_radio_AUDI20250119_RS_0069_8a020b8274994bfdbc724cb0c6ed520c.mp3",
+                "https://stream.srg-ssr.ch/m/la-1ere/mp3_128",
+                "https://lsaplus.swisstxt.ch/audio/couleur3_96.stream/playlist.m3u8",
+            )
+        }
+    }
+}