# ProviderTestRule

Artifact: [androidx.test:rules](https://developer.android.com/jetpack/androidx/releases/test) [View Source](https://cs.android.com/search?q=file:androidx/test/rule/provider/ProviderTestRule.java+class:androidx.test.rule.provider.ProviderTestRule)

*** ** * ** ***


```
public class ProviderTestRule implements TestRule
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> relies on deprecated android.test.mock. Consider using a real provider, or implementing a fake ContentProvider specific to your use case.

A `https://junit.org/junit4/javadoc/latest/org/junit/rules/TestRule.html` to test `https://developer.android.com/reference/android/content/ContentProvider.html`s, 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 `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#revokePermission(java.lang.String)` can be used to revoke specific permissions to test the cases when they are denied in ContentProviders.

Note: The database related methods `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder#setDatabaseFile(java.lang.String,java.io.File)`, `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder#setDatabaseCommands(java.lang.String,java.lang.String...)`, `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder#setDatabaseCommandsFile(java.lang.String,java.io.File)` and `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#runDatabaseCommands(java.lang.String,java.lang.String...)` should only be used when ContentProvider under test is implemented based on `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html`.

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 `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder#setDatabaseFile(java.lang.String,java.io.File)`
2. Run database commands passed in via `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder#setDatabaseCommands(java.lang.String,java.lang.String...)`
3. Run database commands from file passed in via `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder#setDatabaseCommandsFile(java.lang.String,java.io.File)`

If the `https://developer.android.com/reference/android/content/ContentProvider.html` under test is not implemented based on `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html`, or is implemented based on `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html` but no extra database initialization workloads are needed, the rule can be created by simply using `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder`.

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 `https://developer.android.com/reference/android/content/ContentProvider.html` under test is based on `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html`, 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 `https://developer.android.com/reference/android/content/ContentProvider.html` 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 resolver = mProviderRule.getResolver();
    // two entries are already inserted by rule, we can directly perform assertions to verify
    Cursor c = null;
    try {
      c = resolver.query(URI_TO_QUERY_ALL, null, null, null, null);
      assertNotNull(c);
      assertEquals(2, c.getCount());
    } finally {
      if (c != null && !c.isClosed()) {
        c.close();
      }
    }
}
```

## Summary

| ### Nested types |
|---|
| `public class https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule.Builder` **This class is deprecated.** Consider using a real provider, or implementing a fake ContentProvider specific to your use case. <br /> |

| ### Public fields |
|---|---|
| `final https://developer.android.com/reference/android/content/ContentResolver.html` | `https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#resolver()` **This field is deprecated.** Deprecated in Java |

| ### Public methods |
|---|---|
| `https://junit.org/junit4/javadoc/latest/org/junit/runners/model/Statement.html` | `[apply](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#apply(org.junit.runners.model.Statement,org.junit.runner.Description))(https://junit.org/junit4/javadoc/latest/org/junit/runners/model/Statement.html base, https://junit.org/junit4/javadoc/latest/org/junit/runner/Description.html description)` **This method is deprecated.** Deprecated in Java |
| `https://developer.android.com/reference/android/content/ContentResolver.html` | `[getResolver](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#getResolver())()` **This method is deprecated.** Deprecated in Java |
| `void` | `[revokePermission](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#revokePermission(java.lang.String))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html permission)` **This method is deprecated.** Deprecated in Java |
| `void` | `[runDatabaseCommands](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#runDatabaseCommands(java.lang.String,java.lang.String...))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html dbName, @https://developer.android.com/reference/androidx/annotation/NonNull String[] dbCmds)` **This method is deprecated.** Deprecated in Java |

| ### Protected methods |
|---|---|
| `void` | `[afterProviderCleanedUp](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#afterProviderCleanedUp())()` **This method is deprecated.** Deprecated in Java |
| `void` | `[beforeProviderSetup](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#beforeProviderSetup())()` **This method is deprecated.** Deprecated in Java |

## Public fields

### resolver

```
public final ContentResolver resolver
```

> [!CAUTION]
> **This field is deprecated.**   
> Deprecated in Java

## Public methods

### apply

```
public Statement [apply](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#apply(org.junit.runners.model.Statement,org.junit.runner.Description))(Statement base, Description description)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

### getResolver

```
public ContentResolver [getResolver](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#getResolver())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Get the isolated `https://developer.android.com/reference/android/content/ContentResolver.html` that should be used for testing of the ContentProviders.

| Returns |
|---|---|
| `https://developer.android.com/reference/android/content/ContentResolver.html` | the isolated `https://developer.android.com/reference/android/content/ContentResolver.html` created by this `ProviderTestRule`. |

### revokePermission

```
public void [revokePermission](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#revokePermission(java.lang.String))(@NonNull String permission)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Revoke permission anytime during the tests. The default return value of the following methods is `PackageManager.PERMISSION_GRANTED`. After a specific permission is revoked, the value returned becomes `PackageManager.PERMISSION_DENIED` when calling the methods with the revoked permission. After a test, the return values are restored to `
PackageManager.PERMISSION_GRANTED`.

- `https://developer.android.com/reference/android/content/Context.html#checkPermission(java.lang.String, int, int)`
- `https://developer.android.com/reference/android/content/Context.html#checkCallingPermission(java.lang.String)`
- `https://developer.android.com/reference/android/content/Context.html#checkSelfPermission(java.lang.String)`
- `https://developer.android.com/reference/android/content/Context.html#checkCallingOrSelfPermission(java.lang.String)`

Consequentially, calling the following methods with the revoked permission will throw a `https://developer.android.com/reference/java/lang/SecurityException.html`.

- `https://developer.android.com/reference/android/content/Context.html#enforcePermission(java.lang.String, int, int, java.lang.String)`
- `https://developer.android.com/reference/android/content/Context.html#enforceCallingPermission(java.lang.String, java.lang.String)`
- `https://developer.android.com/reference/android/content/Context.html#enforceCallingOrSelfPermission(java.lang.String, java.lang.String)`

### runDatabaseCommands

```
public void [runDatabaseCommands](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#runDatabaseCommands(java.lang.String,java.lang.String...))(@NonNull String dbName, @NonNull String[] dbCmds)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Run database commands anytime during the tests, after the rule is created.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html dbName` | The name of the underlying database used by the ContentProvider under test. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull String[] dbCmds` | The SQL commands to run during tests. Each command will be passed to `https://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html#execSQL(java.lang.String)` to execute. |

## Protected methods

### afterProviderCleanedUp

```
protected void [afterProviderCleanedUp](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#afterProviderCleanedUp())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Override this method to execute any code that should run after provider is cleaned up. This method is called after each test method, including any method annotated with [`After`](http://junit.sourceforge.net/javadoc/org/junit/After.html).

### beforeProviderSetup

```
protected void [beforeProviderSetup](https://developer.android.com/reference/androidx/test/rule/provider/ProviderTestRule#beforeProviderSetup())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Override this method to execute any code that should run before provider is set up. This method is called before each test method, including any method annotated with [`Before`](http://junit.sourceforge.net/javadoc/org/junit/Before.html).