androidx.glance.appwidget.testing.unit

inline fun <T : ActionCallback> hasRunCallbackClickAction(
    parameters: ActionParameters = actionParametersOf()
): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that runs a callback.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

inline fun <T : BroadcastReceiver> hasSendBroadcastAction(): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that sends a broadcast.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun hasSendBroadcastAction(componentName: ComponentName): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that sends a broadcast.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun hasSendBroadcastAction(intent: Intent): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that sends a broadcast.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun hasSendBroadcastAction(
    intentAction: String,
    componentName: ComponentName? = null
): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that sends a broadcast.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun hasStartActivityClickAction(
    intent: Intent,
    parameters: ActionParameters = actionParametersOf(),
    activityOptions: Bundle? = null
): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that starts an activity.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

inline fun <T : Service> hasStartServiceAction(isForegroundService: Boolean = false): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that starts a service.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun hasStartServiceAction(intent: Intent, isForegroundService: Boolean = false): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node has a clickable set with action that starts a service.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun isChecked(): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node is checkable (e.g. radio button, switch, checkbox) and is checked.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun isIndeterminateCircularProgressIndicator(): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a given node is an indeterminate circular progress indicator.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun isIndeterminateLinearProgressIndicator(): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a given node is an indeterminate progress bar.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun isLinearProgressIndicator(progress: Float): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a given node is a linear progress indicator with given progress value.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun isNotChecked(): GlanceNodeMatcher<MappedNode>

Returns a matcher that matches if a node is checkable (e.g. radio button, switch, checkbox) but is not checked.

This can be passed in GlanceNodeAssertionsProvider.onNode and GlanceNodeAssertionsProvider.onAllNodes functions on assertion providers to filter out matching node(s) or in assertions to validate that node(s) satisfy the condition.

fun runGlanceAppWidgetUnitTest(
    timeout: Duration = DEFAULT_TIMEOUT,
    block: GlanceAppWidgetUnitTest.() -> Unit
): Unit

Sets up the test environment and runs the given unit test block. Use the methods on GlanceAppWidgetUnitTest in the test to provide Glance composable content, find Glance elements and make assertions on them.

Test your individual Glance composable functions in isolation to verify that your logic outputs right elements. For example: if input data is 'x', an image 'y' was outputted. In sample below, the test class has a separate test for the header and the status row.

Tests can be run on JVM as these don't involve rendering the UI. If your logic depends on Context or other android APIs, tests can be run on Android unit testing frameworks such as Robolectric.

Note: Keeping a reference to the GlanceAppWidgetUnitTest outside of this function is an error.

import androidx.compose.runtime.Composable
import androidx.compose.ui.unit.DpSize
import androidx.compose.ui.unit.dp
import androidx.glance.GlanceModifier
import androidx.glance.LocalSize
import androidx.glance.appwidget.testing.unit.runGlanceAppWidgetUnitTest
import androidx.glance.layout.Column
import androidx.glance.layout.Row
import androidx.glance.layout.Spacer
import androidx.glance.layout.fillMaxSize
import androidx.glance.layout.width
import androidx.glance.semantics.semantics
import androidx.glance.semantics.testTag
import androidx.glance.testing.unit.hasTestTag
import androidx.glance.testing.unit.hasText
import androidx.glance.text.Text

class TestSample {
    @Test
    fun statusContent_statusFalse_outputsPending() = runGlanceAppWidgetUnitTest {
        provideComposable {
            StatusRow(
                status = false
            )
        }

        onNode(hasTestTag("status-text"))
            .assert(hasText("Pending"))
    }

    @Test
    fun statusContent_statusTrue_outputsFinished() = runGlanceAppWidgetUnitTest {
        provideComposable {
            StatusRow(
                status = true
            )
        }

        onNode(hasTestTag("status-text"))
            .assert(hasText("Finished"))
    }

    @Test
    fun header_smallSize_showsShortHeaderText() = runGlanceAppWidgetUnitTest {
        setAppWidgetSize(DpSize(width = 50.dp, height = 100.dp))

        provideComposable {
            StatusRow(
                status = false
            )
        }

        onNode(hasTestTag("header-text"))
            .assert(hasText("MyApp"))
    }

    @Test
    fun header_largeSize_showsLongHeaderText() = runGlanceAppWidgetUnitTest {
        setAppWidgetSize(DpSize(width = 150.dp, height = 100.dp))

        provideComposable {
            StatusRow(
                status = false
            )
        }

        onNode(hasTestTag("header-text"))
            .assert(hasText("MyApp (Last order)"))
    }

    @Composable
    fun WidgetContent(status: Boolean) {
        Column {
            Header()
            Spacer()
            StatusRow(status)
        }
    }

    @Composable
    fun Header() {
        val width = LocalSize.current.width
        Row(modifier = GlanceModifier.fillMaxSize()) {
            Text(
                text = if (width > 50.dp) {
                    "MyApp (Last order)"
                } else {
                    "MyApp"
                },
                modifier = GlanceModifier.semantics { testTag = "header-text" }
            )
        }
    }

    @Composable
    fun StatusRow(status: Boolean) {
        Row(modifier = GlanceModifier.fillMaxSize()) {
            Text(
                text = "Status",
            )
            Spacer(modifier = GlanceModifier.width(10.dp))
            Text(
                text = if (status) {
                    "Pending"
                } else {
                    "Finished"
                },
                modifier = GlanceModifier.semantics { testTag = "status-text" }
            )
        }
    }
}

inline fun <T : ActionCallback> GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasRunCallbackClickAction(
    parameters: ActionParameters = actionParametersOf()
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that runs a callback.

inline fun <T : BroadcastReceiver> GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasSendBroadcastClickAction(

): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that sends a broadcast.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasSendBroadcastClickAction(
    componentName: ComponentName
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that sends a broadcast.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasSendBroadcastClickAction(
    intent: Intent
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that sends a broadcast.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasSendBroadcastClickAction(
    intentAction: String,
    componentName: ComponentName? = null
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that sends a broadcast.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasStartActivityClickAction(
    intent: Intent,
    parameters: ActionParameters = actionParametersOf(),
    activityOptions: Bundle? = null
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that starts an activity.

inline fun <T : Service> GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasStartServiceClickAction(
    isForegroundService: Boolean = false
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that starts a service.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasStartServiceClickAction(
    componentName: ComponentName,
    isForegroundService: Boolean = false
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that starts a service.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertHasStartServiceClickAction(
    intent: Intent,
    isForegroundService: Boolean = false
): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node has a clickable set with action that starts a service.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertIsChecked(): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node is checkable and is checked.

fun GlanceNodeAssertion<MappedNode, GlanceMappedNode>.assertIsNotChecked(): GlanceNodeAssertion<MappedNode, GlanceMappedNode>

Asserts that a given node is checkable and is not checked.