public final class

WorkManagerTestInitHelper

extends java.lang.Object

 java.lang.Object

↳androidx.work.testing.WorkManagerTestInitHelper

Gradle dependencies

compile group: 'androidx.work', name: 'work-testing', version: '2.8.0-alpha02'

  • groupId: androidx.work
  • artifactId: work-testing
  • version: 2.8.0-alpha02

Artifact androidx.work:work-testing:2.8.0-alpha02 it located at Google repository (https://maven.google.com/)

Overview

Helps initialize WorkManager for testing.

Summary

Methods
public static TestDrivergetTestDriver()

public static TestDrivergetTestDriver(Context context)

public static voidinitializeTestWorkManager(Context context)

Initializes a test WorkManager with a SynchronousExecutor.

public static voidinitializeTestWorkManager(Context context, Configuration configuration)

Initializes a test WorkManager with a user-specified Configuration.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods

public static void initializeTestWorkManager(Context context)

Initializes a test WorkManager with a SynchronousExecutor.

Parameters:

context: The application

public static void initializeTestWorkManager(Context context, Configuration configuration)

Initializes a test WorkManager with a user-specified Configuration.

Parameters:

context: The application
configuration: The Configuration

public static TestDriver getTestDriver()

Deprecated: Call WorkManagerTestInitHelper.getTestDriver(Context) instead.

Returns:

An instance of TestDriver. This exposes additional functionality that is useful in the context of testing when using WorkManager.

public static TestDriver getTestDriver(Context context)

Returns:

An instance of TestDriver. This exposes additional functionality that is useful in the context of testing when using WorkManager.

Source

/*
 * Copyright 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.work.testing;

import android.content.Context;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.work.Configuration;
import androidx.work.impl.WorkManagerImpl;


/**
 * Helps initialize {@link androidx.work.WorkManager} for testing.
 */
public final class WorkManagerTestInitHelper {
    /**
     * Initializes a test {@link androidx.work.WorkManager} with a {@link SynchronousExecutor}.
     *
     * @param context The application {@link Context}
     */
    public static void initializeTestWorkManager(@NonNull Context context) {
        SynchronousExecutor synchronousExecutor = new SynchronousExecutor();
        Configuration configuration = new Configuration.Builder()
                .setExecutor(synchronousExecutor)
                .setTaskExecutor(synchronousExecutor)
                .build();
        initializeTestWorkManager(context, configuration);
    }

    /**
     * Initializes a test {@link androidx.work.WorkManager} with a user-specified
     * {@link androidx.work.Configuration}.
     *
     * @param context The application {@link Context}
     * @param configuration The {@link androidx.work.Configuration}
     */
    public static void initializeTestWorkManager(
            @NonNull Context context,
            @NonNull Configuration configuration) {

        // Check if the configuration being used has overridden the task executor. If not,
        // swap to SynchronousExecutor. This is to preserve existing behavior.
        if (configuration.isUsingDefaultTaskExecutor()) {
            Configuration.Builder builder = new Configuration.Builder(configuration)
                    .setTaskExecutor(new SynchronousExecutor());
            configuration = builder.build();
        }

        WorkManagerImpl.setDelegate(new TestWorkManagerImpl(context, configuration));
    }

    /**
     * @return An instance of {@link TestDriver}. This exposes additional functionality that is
     * useful in the context of testing when using WorkManager.
     * @deprecated Call {@link WorkManagerTestInitHelper#getTestDriver(Context)} instead.
     */
    @Deprecated
    public static @Nullable TestDriver getTestDriver() {
        WorkManagerImpl workManager = WorkManagerImpl.getInstance();
        if (workManager == null) {
            return null;
        } else {
            return (TestWorkManagerImpl) workManager;
        }
    }

    /**
     * @return An instance of {@link TestDriver}. This exposes additional functionality that is
     * useful in the context of testing when using WorkManager.
     */
    public static @Nullable TestDriver getTestDriver(@NonNull Context context) {
        try {
            return (TestWorkManagerImpl) WorkManagerImpl.getInstance(context);
        } catch (IllegalStateException e) {
            return null;
        }
    }

    private WorkManagerTestInitHelper() {
    }
}