ProviderTestRule

public class ProviderTestRule
extends Object implements TestRule

A TestRule to test ContentProviders, with additional APIs to enable easy initialization such as restoring database from a file, running database commands passed in as a String or a file. By default, all permissions are granted when they are checked in ContentProviders under test, method revokePermission(String) can be used to revoke specific permissions to test the cases when they are denied in ContentProviders.

Note: The database related methods setDatabaseFile(String, File), setDatabaseCommands(String, String...), setDatabaseCommandsFile(String, File) and runDatabaseCommands(String, String...) should only be used when ContentProvider under test is implemented based on SQLiteDatabase.

If more than one database related methods are used for a ContentProvider under test, the execution order of restoring database from file and running database commands are independent of the order those methods are called. If all methods are used, when setting up the ContentProvider for test, the execution order is as follows:

1. Restore database from file passed in via setDatabaseFile(String, File)
2. Run database commands passed in via setDatabaseCommands(String, String...)
3. Run database commands from file passed in via setDatabaseCommandsFile(String, File)

If the ContentProvider under test is not implemented based on SQLiteDatabase, or is implemented based on SQLiteDatabase but no extra database initialization workloads are needed, the rule can be created by simply using Builder(Class,String).

Usage example:

 @Rule
 public ProviderTestRule mProviderRule =
     new ProviderTestRule.Builder(MyContentProvider.class, MyContentProvider.AUTHORITY).build();

 @Test
 public void verifyContentProviderContractWorks() {
     ContentResolver resolver = mProviderRule.getResolver();
     // perform some database (or other) operations
     Uri uri = resolver.insert(testUrl, testContentValues);
     // perform some assertions on the resulting URI
     assertNotNull(uri);
 }
 

Alternatively, if the ContentProvider under test is based on SQLiteDatabase, then all database related methods can be used. However, the database name argument passed in via these methods must match the actual database name used by the ContentProvider under test.

Usage example:

 @Rule
 public ProviderTestRule mProviderRule =
     new ProviderTestRule.Builder(MyContentProvider.class, MyContentProvider.AUTHORITY)
         .setDatabaseCommands(DATABASE_NAME, INSERT_ONE_ENTRY_CMD, INSERT_ANOTHER_ENTRY_CMD)
         .build();

 @Test
 public void verifyTwoEntriesInserted() {
     ContentResolver mResolver = mProviderRule.getResolver();
     // two entries are already inserted by rule, we can directly perform assertions to verify
     Cursor c = null;
     try {
       c = mResolver.query(URI_TO_QUERY_ALL, null, null, null, null);
       assertNotNull(c);
       assertEquals(2, c.getCount());
     } finally {
       if (c != null && !c.isClosed()) {
         c.close();
       }
     }
 }
 

This API is currently in beta.

Summary

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface org.junit.rules.TestRule abstract Statement apply(Statement arg0, Description arg1)

Public methods

Statement apply (Statement base, 
                Description description)

ContentResolver getResolver ()

void revokePermission (String permission)

void runDatabaseCommands (String dbName, 
                String... dbCmds)

Protected methods

void afterProviderCleanedUp ()

void beforeProviderSetup ()