ProviderTestRule.Builder

Kotlin |Java

public class ProviderTestRule.Builder

A Builder to ease ProviderTestRule creation. Users can input one or more ContentProviders and their corresponding authority for tests. It also allows to specify the prefix to use when renaming test files for isolation by setPrefix. If the ContentProvider under test is implemented based on SQLiteDatabase, users can also pass in database file to restore or database commands to run before tests.

Summary

Public constructors
`<T extends ContentProvider> Builder( @NonNull Class<T> providerClass, @NonNull String providerAuth )` The basic builder to use when creating a `ProviderTestRule`, which allows to specify one `ContentProvider` and the corresponding `authority` for tests.

Public methods
`ProviderTestRule.Builder`	`<T extends ContentProvider> addProvider( @NonNull Class<T> providerClass, @NonNull String providerAuth )` Allows to add additional ContentProvider and the corresponding authority for testing.
`ProviderTestRule`	`build()`
`ProviderTestRule.Builder`	`setDatabaseCommands(@NonNull String dbName, @NonNull String[] dbCmds)` Allows to pass in specific SQL commands to run against the database with a given name.
`ProviderTestRule.Builder`	`setDatabaseCommandsFile(@NonNull String dbName, @NonNull File dbCmdFile)` Allows to pass in a file containing commands to run against the database with a given name.
`ProviderTestRule.Builder`	`setDatabaseFile(@NonNull String dbName, @NonNull File dbDataFile)` Allows to pass in a SQLite database file containing the intended initial data to restore.
`ProviderTestRule.Builder`	`setPrefix(@NonNull String prefix)` Enables users to specify the prefix to use when renaming test files for isolation.

Public constructors

Builder

public <T extends ContentProvider> Builder(
    @NonNull Class<T> providerClass,
    @NonNull String providerAuth
)

The basic builder to use when creating a ProviderTestRule, which allows to specify one ContentProvider and the corresponding authority for tests.

Parameters
`@NonNull Class<T> providerClass`	The class of ContentProvider under test.
`@NonNull String providerAuth`	The authority defined for ContentProvider under test.

Public methods

addProvider

public ProviderTestRule.Builder <T extends ContentProvider> addProvider(
    @NonNull Class<T> providerClass,
    @NonNull String providerAuth
)

Allows to add additional ContentProvider and the corresponding authority for testing. Similarly, setDatabaseFile, setDatabaseCommands, setDatabaseCommandsFile, and runDatabaseCommands can be used for this ContentProvider.

Parameters
`@NonNull Class<T> providerClass`	The class of the added ContentProvider under test.
`@NonNull String providerAuth`	The authority defined for the added ContentProvider under test.

build

public ProviderTestRule build()

setDatabaseCommands

public ProviderTestRule.Builder setDatabaseCommands(@NonNull String dbName, @NonNull String[] dbCmds)

Allows to pass in specific SQL commands to run against the database with a given name.

Note: The passed in commands are executed before any sql commands execution in SQLiteOpenHelper's onCreate method defined in ContentProvider under test, also before executing commands, if any, passed in via setDatabaseCommandsFile, but after restoring the database file, if any, passed in via setDatabaseFile.

Parameters
`@NonNull String dbName`	The name of the underlying database used by the ContentProvider under test.
`@NonNull String[] dbCmds`	The SQL commands to run. Each command will be passed to `execSQL` to execute.

setDatabaseCommandsFile

public ProviderTestRule.Builder setDatabaseCommandsFile(@NonNull String dbName, @NonNull File dbCmdFile)

Allows to pass in a file containing commands to run against the database with a given name.

Note: Commands in the file are executed before any sql commands execution in SQLiteOpenHelper's onCreate method defined in ContentProvider under test, but after restoring the database file, if any, passed in via setDatabaseFile and executing commands, if any, passed in via setDatabaseCommands.

Parameters
`@NonNull String dbName`	The name of the underlying database used by the ContentProvider under test.
`@NonNull File dbCmdFile`	The file that contains line separated database commands to run. Each line will be treated as a separate command and passed to `execSQL` to execute.

setDatabaseFile

public ProviderTestRule.Builder setDatabaseFile(@NonNull String dbName, @NonNull File dbDataFile)

Allows to pass in a SQLite database file containing the intended initial data to restore.

Note: Restoring the database from the file are executed before any sql commands execution in SQLiteOpenHelper's onCreate method defined in ContentProvider under test, also before running the database commands, if any, passed in via setDatabaseCommands and setDatabaseCommandsFile.

In the case of the database file with prefixed name already exists, the database restoration will overwrite existing file.

Parameters
`@NonNull String dbName`	The name of the underlying database used by the ContentProvider under test.
`@NonNull File dbDataFile`	The SQLite database file that contains the data to restore.

setPrefix

public ProviderTestRule.Builder setPrefix(@NonNull String prefix)

Enables users to specify the prefix to use when renaming test files for isolation. If not used, this rule will use "#DEFAULT_PREFIX" by default.

Parameters
`@NonNull String prefix`	The non-empty prefix to append to test files.