ProviderTestCase2.javaAPI DocAndroid 5.1 API9779Thu Mar 12 22:22:42 GMT 2015android.test


public abstract class ProviderTestCase2 extends AndroidTestCase
This test case class provides a framework for testing a single {@link ContentProvider} and for testing your app code with an isolated content provider. Instead of using the system map of providers that is based on the manifests of other applications, the test case creates its own internal map. It then uses this map to resolve providers given an authority. This allows you to inject test providers and to null out providers that you do not want to use.

This test case also sets up the following mock objects:

  • An {@link android.test.IsolatedContext} that stubs out Context methods that might affect the rest of the running system, while allowing tests to do real file and database work.
  • A {@link android.test.mock.MockContentResolver} that provides the functionality of a regular content resolver, but uses {@link IsolatedContext}. It stubs out {@link ContentResolver#notifyChange(Uri, ContentObserver, boolean)} to prevent the test from affecting the running system.
  • An instance of the provider under test, running in an {@link IsolatedContext}.

This framework is set up automatically by the base class' {@link #setUp()} method. If you override this method, you must call the super method as the first statement in your override.

In order for their tests to be run, concrete subclasses must provide their own constructor with no arguments. This constructor must call {@link #ProviderTestCase2(Class, String)} as its first operation.

For more information on content provider testing, please see Content Provider Testing.

Fields Summary
private IsolatedContext
private android.test.mock.MockContentResolver
private T
Constructors Summary
public ProviderTestCase2(Class providerClass, String providerAuthority)

providerClass The class name of the provider under test
providerAuthority The provider's authority string

        mProviderClass = providerClass;
        mProviderAuthority = providerAuthority;
Methods Summary
static TcreateProviderForTest(android.content.Context context, java.lang.Class providerClass, java.lang.String authority)
Creates and sets up a new instance of the provider.

        T instance = providerClass.newInstance();
        ProviderInfo providerInfo = new ProviderInfo();
        providerInfo.authority = authority;
        instance.attachInfoForTesting(context, providerInfo);
        return instance;
public android.test.mock.MockContentResolvergetMockContentResolver()
Gets the {@link MockContentResolver} created by this class during initialization. You must use the methods of this resolver to access the provider under test.

A {@link MockContentResolver} instance.

        return mResolver;
public IsolatedContextgetMockContext()
Gets the {@link IsolatedContext} created by this class during initialization.

The {@link IsolatedContext} instance

        return mProviderContext;
public TgetProvider()
Returns the content provider created by this class in the {@link #setUp()} method.

T An instance of the provider class given as a parameter to the test case class.

        return mProvider;
public static android.content.ContentResolvernewResolverWithContentProviderFromSql(android.content.Context targetContext, java.lang.String filenamePrefix, java.lang.Class providerClass, java.lang.String authority, java.lang.String databaseName, int databaseVersion, java.lang.String sql)

Creates a new content provider of the same type as that passed to the test case class, with an authority name set to the authority parameter, and using an SQLite database as the underlying data source. The SQL statement parameter is used to create the database. This method also creates a new {@link MockContentResolver} and adds the provider to it.

Both the new provider and the new resolver are put into an {@link IsolatedContext} that uses the targetContext parameter for file operations and a {@link MockContext} for everything else. The IsolatedContext prepends the filenamePrefix parameter to file, database, and directory names.

This is a convenience method for creating a "mock" provider that can contain test data.

targetContext The context to use as the basis of the IsolatedContext
filenamePrefix A string that is prepended to file, database, and directory names
providerClass The type of the provider being tested
authority The authority string to associated with the test provider
databaseName The name assigned to the database
databaseVersion The version assigned to the database
sql A string containing the SQL statements that are needed to create the desired database and its tables. The format is the same as that generated by the sqlite3 tool's .dump command.
ContentResolver A new {@link MockContentResolver} linked to the provider

        MockContentResolver resolver = new MockContentResolver();
        RenamingDelegatingContext targetContextWrapper = new RenamingDelegatingContext(
                new MockContext(), // The context that most methods are delegated to
                targetContext, // The context that file methods are delegated to
        Context context = new IsolatedContext(resolver, targetContextWrapper);
        DatabaseUtils.createDbFromSqlStatements(context, databaseName, databaseVersion, sql);

        T provider = createProviderForTest(context, providerClass, authority);
        resolver.addProvider(authority, provider);

        return resolver;
protected voidsetUp()
Sets up the environment for the test fixture.

Creates a new {@link android.test.mock.MockContentResolver}, a new IsolatedContext that isolates the provider's file operations, and a new instance of the provider under test within the isolated environment.



        mResolver = new MockContentResolver();
        final String filenamePrefix = "test.";
        RenamingDelegatingContext targetContextWrapper = new
                new MockContext2(), // The context that most methods are
                                    //delegated to
                getContext(), // The context that file methods are delegated to
        mProviderContext = new IsolatedContext(mResolver, targetContextWrapper);
        mProvider = createProviderForTest(mProviderContext, mProviderClass, mProviderAuthority);
        mResolver.addProvider(mProviderAuthority, getProvider());
protected voidtearDown()
Tears down the environment for the test fixture.

Calls {@link android.content.ContentProvider#shutdown()} on the {@link android.content.ContentProvider} represented by mProvider.