WorkManagerTestInitHelper
class WorkManagerTestInitHelper
Helps initialize androidx.work.WorkManager for testing.
Summary
Nested types |
|---|
|
Modes that control which executors are used in tests. |
Public functions |
|
|---|---|
java-static Unit |
Closes internal |
java-static TestDriver? |
This function is deprecated. Call |
java-static TestDriver? |
getTestDriver(context: Context) |
java-static Unit |
initializeTestWorkManager(context: Context)Initializes a test |
java-static Unit |
initializeTestWorkManager(context: Context, configuration: Configuration)Initializes a test |
java-static Unit |
initializeTestWorkManager(Initializes a test |
java-static Unit |
initializeTestWorkManager(Initializes a test |
Public functions
closeWorkDatabase
java-static fun closeWorkDatabase(): Unit
Closes internal androidx.work.WorkManager's database.
It could be helpful to avoid warnings by CloseGuard in testing infra. You need to be make sure that WorkManager finished all operations and won't touch database anymore. Meaning that both getTaskExecutor and getExecutor are idle.
It shouldn't be called from getTaskExecutor because this method will block until all internal work is complete after cancellation. To complete this work getTaskExecutor could be require and blocking it may lead to deadlocks.
java-static fungetTestDriver(): TestDriver?
| Returns | |
|---|---|
TestDriver? |
An instance of |
getTestDriver
java-static fun getTestDriver(context: Context): TestDriver?
| Returns | |
|---|---|
TestDriver? |
An instance of |
initializeTestWorkManager
java-static fun initializeTestWorkManager(context: Context): Unit
Initializes a test androidx.work.WorkManager with a SynchronousExecutor.
initializeTestWorkManager
java-static fun initializeTestWorkManager(context: Context, configuration: Configuration): Unit
Initializes a test androidx.work.WorkManager with a user-specified androidx.work.Configuration, but using SynchronousExecutor instead of main thread.
| Parameters | |
|---|---|
context: Context |
The application |
configuration: Configuration |
initializeTestWorkManager
java-static fun initializeTestWorkManager(
context: Context,
executorsMode: WorkManagerTestInitHelper.ExecutorsMode
): Unit
Initializes a test androidx.work.WorkManager that can be controlled via TestDriver.
| Parameters | |
|---|---|
context: Context |
The application |
executorsMode: WorkManagerTestInitHelper.ExecutorsMode |
mode controlling executors used by WorkManager in tests. See documentation of modes in |
initializeTestWorkManager
java-static fun initializeTestWorkManager(
context: Context,
configuration: Configuration,
executorsMode: WorkManagerTestInitHelper.ExecutorsMode
): Unit
Initializes a test androidx.work.WorkManager that can be controlled via TestDriver.
| Parameters | |
|---|---|
context: Context |
The application |
configuration: Configuration |
test configuration of WorkManager |
executorsMode: WorkManagerTestInitHelper.ExecutorsMode |
mode controlling executors used by WorkManager in tests. See documentation of modes in |