TestUtils: add common method to initialize WorkManager for instrument…

…ation tests
bitfireAT · Dec 25, 2024 · 98578fe · 98578fe
1 parent 0762cc6
commit 98578fe
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 95 deletions.
diff --git a/app/src/androidTest/kotlin/at/bitfire/davdroid/TestUtils.kt b/app/src/androidTest/kotlin/at/bitfire/davdroid/TestUtils.kt
@@ -5,16 +5,14 @@
 package at.bitfire.davdroid
 
 import android.content.Context
-import androidx.lifecycle.LiveData
-import androidx.lifecycle.Observer
+import android.util.Log
+import androidx.work.Configuration
 import androidx.work.WorkInfo
 import androidx.work.WorkManager
 import androidx.work.WorkQuery
-import org.jetbrains.annotations.TestOnly
+import androidx.work.WorkerFactory
+import androidx.work.testing.WorkManagerTestInitHelper
 import org.junit.Assert.assertTrue
-import java.util.concurrent.CountDownLatch
-import java.util.concurrent.TimeUnit
-import java.util.concurrent.TimeoutException
 import kotlin.math.abs
 
 object TestUtils {
@@ -27,56 +25,34 @@ object TestUtils {
         )
     }
 
-    @TestOnly
+    /**
+     * Initializes WorkManager for instrumentation tests.
+     */
+    fun setUpWorkManager(context: Context, workerFactory: WorkerFactory? = null) {
+        val config = Configuration.Builder().setMinimumLoggingLevel(Log.DEBUG)
+        if (workerFactory != null)
+            config.setWorkerFactory(workerFactory)
+        WorkManagerTestInitHelper.initializeTestWorkManager(context, config.build())
+    }
+
+    fun workInStates(context: Context, workerName: String, states: List<WorkInfo.State>): Boolean =
+        WorkManager.getInstance(context).getWorkInfos(WorkQuery.Builder
+            .fromUniqueWorkNames(listOf(workerName))
+            .addStates(states)
+            .build()
+        ).get().isNotEmpty()
+
     fun workScheduledOrRunning(context: Context, workerName: String): Boolean =
         workInStates(context, workerName, listOf(
             WorkInfo.State.ENQUEUED,
             WorkInfo.State.RUNNING
         ))
 
-    @TestOnly
     fun workScheduledOrRunningOrSuccessful(context: Context, workerName: String): Boolean =
         workInStates(context, workerName, listOf(
             WorkInfo.State.ENQUEUED,
             WorkInfo.State.RUNNING,
             WorkInfo.State.SUCCEEDED
         ))
 
-    @TestOnly
-    fun workInStates(context: Context, workerName: String, states: List<WorkInfo.State>): Boolean =
-        WorkManager.getInstance(context).getWorkInfos(WorkQuery.Builder
-            .fromUniqueWorkNames(listOf(workerName))
-            .addStates(states)
-            .build()
-        ).get().isNotEmpty()
-
-
-    /* Copyright 2019 Google LLC.
-    SPDX-License-Identifier: Apache-2.0 */
-    @TestOnly
-    fun <T> LiveData<T>.getOrAwaitValue(
-        time: Long = 2,
-        timeUnit: TimeUnit = TimeUnit.SECONDS
-    ): T {
-        var data: T? = null
-        val latch = CountDownLatch(1)
-        val observer = object : Observer<T> {
-            override fun onChanged(value: T) {
-                data = value
-                latch.countDown()
-                this@getOrAwaitValue.removeObserver(this)
-            }
-        }
-
-        this.observeForever(observer)
-
-        // Don't wait indefinitely if the LiveData is not set.
-        if (!latch.await(time, timeUnit)) {
-            throw TimeoutException("LiveData value was never set.")
-        }
-
-        @Suppress("UNCHECKED_CAST")
-        return data as T
-    }
-
 }
diff --git a/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/SyncAdapterServicesTest.kt b/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/SyncAdapterServicesTest.kt
@@ -9,12 +9,10 @@ import android.content.Context
 import android.content.SyncResult
 import android.os.Bundle
 import android.provider.CalendarContract
-import android.util.Log
 import androidx.hilt.work.HiltWorkerFactory
-import androidx.work.Configuration
 import androidx.work.WorkInfo
 import androidx.work.WorkManager
-import androidx.work.testing.WorkManagerTestInitHelper
+import at.bitfire.davdroid.TestUtils
 import at.bitfire.davdroid.repository.DavCollectionRepository
 import at.bitfire.davdroid.repository.DavServiceRepository
 import at.bitfire.davdroid.settings.AccountSettings
@@ -31,6 +29,7 @@ import io.mockk.mockk
 import io.mockk.mockkObject
 import io.mockk.mockkStatic
 import io.mockk.unmockkAll
+import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.flow
@@ -44,7 +43,6 @@ import org.junit.Test
 import org.junit.rules.Timeout
 import java.util.logging.Logger
 import javax.inject.Inject
-import kotlin.coroutines.cancellation.CancellationException
 
 @HiltAndroidTest
 class SyncAdapterServicesTest {
@@ -84,15 +82,9 @@ class SyncAdapterServicesTest {
     @Before
     fun setUp() {
         hiltRule.inject()
+        TestUtils.setUpWorkManager(context, workerFactory)
 
         account = TestAccountAuthenticator.create()
-
-        // Initialize WorkManager for instrumentation tests.
-        val config = Configuration.Builder()
-            .setMinimumLoggingLevel(Log.DEBUG)
-            .setWorkerFactory(workerFactory)
-            .build()
-        WorkManagerTestInitHelper.initializeTestWorkManager(context, config)
     }
 
     @After

diff --git a/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/SyncManagerTest.kt b/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/SyncManagerTest.kt
@@ -6,15 +6,13 @@ package at.bitfire.davdroid.sync
 
 import android.accounts.Account
 import android.content.Context
-import android.util.Log
 import androidx.core.app.NotificationManagerCompat
 import androidx.hilt.work.HiltWorkerFactory
-import androidx.work.Configuration
-import androidx.work.testing.WorkManagerTestInitHelper
 import at.bitfire.dav4jvm.PropStat
 import at.bitfire.dav4jvm.Response
 import at.bitfire.dav4jvm.Response.HrefRelation
 import at.bitfire.dav4jvm.property.webdav.GetETag
+import at.bitfire.davdroid.TestUtils
 import at.bitfire.davdroid.TestUtils.assertWithin
 import at.bitfire.davdroid.db.Collection
 import at.bitfire.davdroid.db.SyncState
@@ -78,13 +76,7 @@ class SyncManagerTest {
     @Before
     fun setUp() {
         hiltRule.inject()
-
-        // Initialize WorkManager for instrumentation tests.
-        val config = Configuration.Builder()
-            .setMinimumLoggingLevel(Log.DEBUG)
-            .setWorkerFactory(workerFactory)
-            .build()
-        WorkManagerTestInitHelper.initializeTestWorkManager(context, config)
+        TestUtils.setUpWorkManager(context, workerFactory)
 
         account = TestAccountAuthenticator.create()
 

diff --git a/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/account/AccountsCleanupWorkerTest.kt b/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/account/AccountsCleanupWorkerTest.kt
@@ -4,14 +4,12 @@ import android.accounts.Account
 import android.accounts.AccountManager
 import android.content.Context
 import android.os.Bundle
-import android.util.Log
 import androidx.hilt.work.HiltWorkerFactory
-import androidx.work.Configuration
 import androidx.work.WorkerFactory
 import androidx.work.WorkerParameters
 import androidx.work.testing.TestListenableWorkerBuilder
-import androidx.work.testing.WorkManagerTestInitHelper
 import at.bitfire.davdroid.R
+import at.bitfire.davdroid.TestUtils
 import at.bitfire.davdroid.db.AppDatabase
 import at.bitfire.davdroid.db.Service
 import at.bitfire.davdroid.resource.LocalAddressBook
@@ -61,6 +59,7 @@ class AccountsCleanupWorkerTest {
     @Before
     fun setUp() {
         hiltRule.inject()
+        TestUtils.setUpWorkManager(context, workerFactory)
 
         service = createTestService(Service.TYPE_CARDDAV)
 
@@ -71,13 +70,6 @@ class AccountsCleanupWorkerTest {
             "Fancy address book account",
             addressBookAccountType
         )
-
-        // Initialize WorkManager for instrumentation tests.
-        val config = Configuration.Builder()
-            .setMinimumLoggingLevel(Log.DEBUG)
-            .setWorkerFactory(workerFactory)
-            .build()
-        WorkManagerTestInitHelper.initializeTestWorkManager(context, config)
     }
 
     @After

diff --git a/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/worker/PeriodicSyncWorkerTest.kt b/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/worker/PeriodicSyncWorkerTest.kt
@@ -7,16 +7,14 @@ package at.bitfire.davdroid.sync.worker
 import android.accounts.Account
 import android.content.Context
 import android.provider.CalendarContract
-import android.util.Log
 import androidx.test.platform.app.InstrumentationRegistry
-import androidx.work.Configuration
 import androidx.work.ListenableWorker
 import androidx.work.WorkManager
 import androidx.work.WorkerFactory
 import androidx.work.WorkerParameters
 import androidx.work.testing.TestListenableWorkerBuilder
-import androidx.work.testing.WorkManagerTestInitHelper
 import androidx.work.workDataOf
+import at.bitfire.davdroid.TestUtils
 import at.bitfire.davdroid.sync.account.TestAccountAuthenticator
 import at.bitfire.davdroid.test.R
 import dagger.hilt.android.qualifiers.ApplicationContext
@@ -51,12 +49,7 @@ class PeriodicSyncWorkerTest {
     @Before
     fun setUp() {
         hiltRule.inject()
-
-        // Initialize WorkManager for instrumentation tests.
-        val config = Configuration.Builder()
-            .setMinimumLoggingLevel(Log.DEBUG)
-            .build()
-        WorkManagerTestInitHelper.initializeTestWorkManager(context, config)
+        TestUtils.setUpWorkManager(context)
 
         account = TestAccountAuthenticator.create()
     }

diff --git a/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/worker/SyncWorkerManagerTest.kt b/app/src/androidTest/kotlin/at/bitfire/davdroid/sync/worker/SyncWorkerManagerTest.kt
@@ -7,10 +7,7 @@ package at.bitfire.davdroid.sync.worker
 import android.accounts.Account
 import android.content.Context
 import android.provider.CalendarContract
-import android.util.Log
 import androidx.hilt.work.HiltWorkerFactory
-import androidx.work.Configuration
-import androidx.work.testing.WorkManagerTestInitHelper
 import at.bitfire.davdroid.TestUtils
 import at.bitfire.davdroid.TestUtils.workScheduledOrRunning
 import at.bitfire.davdroid.sync.account.TestAccountAuthenticator
@@ -47,13 +44,7 @@ class SyncWorkerManagerTest {
     @Before
     fun setUp() {
         hiltRule.inject()
-
-        // Initialize WorkManager for instrumentation tests.
-        val config = Configuration.Builder()
-            .setMinimumLoggingLevel(Log.DEBUG)
-            .setWorkerFactory(workerFactory)
-            .build()
-        WorkManagerTestInitHelper.initializeTestWorkManager(context, config)
+        TestUtils.setUpWorkManager(context, workerFactory)
 
         account = TestAccountAuthenticator.create()
     }