compose/de.mannodermaus.junit5.compose/AndroidComposeExtension

AndroidComposeExtension

class AndroidComposeExtension<A : ComponentActivity> : ComposeExtension, BeforeEachCallback, BeforeTestExecutionCallback, AfterTestExecutionCallback, AfterEachCallback, ParameterResolver

A JUnit 5 Extension that allows you to test and control Composables and application using Compose. The functionality of testing Compose is provided by means of the runComposeTest method, which receives a ComposeContext from which the test can be orchestrated. The test will block until the app or composable is idle, to ensure the tests are deterministic.

This extension can be added to any JUnit 5 class using the ExtendWith annotation, or registered globally through a configuration file. Alternatively, you can instantiate the extension in a field within the test class using any of the createComposeExtension or createAndroidComposeExtension factory methods.

Properties

activity

val activity: A

scenario

val scenario: ActivityScenario<A>

Functions

afterEach

open override fun afterEach(context: ExtensionContext)

afterTestExecution

open override fun afterTestExecution(context: ExtensionContext)

beforeEach

open override fun beforeEach(context: ExtensionContext)

beforeTestExecution

open override fun beforeTestExecution(context: ExtensionContext)

getTestInstantiationExtensionContextScope

@API(status = API.Status.EXPERIMENTAL, since = "5.12")

open fun getTestInstantiationExtensionContextScope(rootContext: ExtensionContext): TestInstantiationAwareExtension.ExtensionContextScope

resolveParameter

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

runComposeTest

open fun ~~runComposeTest~~(block: ComposeContext.() -> Unit)

supportsParameter

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

use

open override fun use(block: ComposeContext.() -> Unit)

Set up and drive the execution of a Compose test within the provided block. Depending on the time this is called, it will either queue up a preparatory action for the test (e.g. in @BeforeEach) The receive of this block is a ComposeContext, through which you can access all sorts of utilities to drive the execution of the test, such as driving the clock or executing actions on the UI thread. The main purpose is provided through ComposeContext.setContent, however: With this function, you can pass an arbitrary composable tree to the extension and evaluate it afterwards.