BackupRestoreExtension

class BackupRestoreExtension : BeforeAllCallback, AfterAllCallback, BeforeEachCallback, AfterEachCallback, ParameterResolver

A JUnit 5 Jupiter extension that resolves BackupRestoreController test parameters.

It automatically initializes ADB sessions, selects an online Android device matching target API and serial constraints (specified via system properties or Device annotations), handles automatic APK installation for tested and test packages, proactively dismisses lockscreens/keyguards, and sets up data isolation (e.g. running pm clear) prior to test execution.

Each controller targets the app named by the test class's BackupRestoreConfig. Without one, it targets the tested app that the test suite properties name.

When a test fails, the extension saves the logs of each device that the test used while it ran, and names the saved files in the test failure. Logs aren't saved for aborted tests, such as a failed assumption. To also save them when a @BeforeAll or @AfterAll method fails, register the extension on the test class, with @ExtendWith or a static @RegisterExtension field. To turn off saving logs, set the system property androidx.test.backup.device.logs.enabled to false.

The files are in suite-details in the results directory of the test suite. Outside of a test suite, they are in a new temporary directory, which the extension keeps after the test run.

Summary

BackupRestoreExtension()

open fun afterAll(context: ExtensionContext): Unit

open fun afterEach(context: ExtensionContext): Unit

open fun beforeAll(context: ExtensionContext): Unit

open fun beforeEach(context: ExtensionContext): Unit

open fun resolveParameter(
    parameterContext: ParameterContext?,
    extensionContext: ExtensionContext?
): Any

open fun supportsParameter(
    parameterContext: ParameterContext?,
    extensionContext: ExtensionContext?
): Boolean