Loading...
Loading...
Use this skill to enable Espresso's `AccessibilityValidator` against the Compose semantics tree via `enableAccessibilityChecks(...)` from `androidx.compose.ui:ui-test-accessibility` (for `ComposeUiTest`) or `androidx.compose.ui:ui-test-junit4-accessibility` (for `ComposeTestRule` / `AndroidComposeTestRule`). Covers the API surface, the auto-check after every UI-mutating action (`performMultiModalInput` is the lone exception), the manual `tryPerformAccessibilityChecks()` entry point, sharing the validator with Espresso via `AccessibilityChecks.enable()`, the API 34+ requirement, and the Robolectric inconclusive behavior (logs a `Log.w` warning and still installs the validator, but Robolectric does not faithfully drive accessibility services — b/332778271). Use when the developer asks "how do I enable a11y checks in a Compose test", "AccessibilityChecks.enable", "AccessibilityValidator throws on click", "robolectric a11y not supported", or "ComposeTestRule IllegalStateException".
npx skill4agent add skydoves/android-testing-skills enabling-accessibility-checksAccessibilityValidatorAccessibilityValidatorcom.google.android.apps.common.testing.accessibility.framework.integrations.espressoperformClickperformScrollTo*performTextInputComposeUiTestComposeTestRuleLog.wAccessibilityValidatorLog.w../printing-the-semantics-tree/SKILL.mdcompose/ui/ui-test-accessibility/src/androidMain/kotlin/androidx/compose/ui/test/accessibility/ComposeUiTestExt.android.kt:50-53androidDeviceTest../../setup/setting-up-host-vs-device-tests/SKILL.md@RequiresApi(34)@SdkSuppress(minSdkVersion = 34)../../assertions/asserting-node-state-and-text/SKILL.mdandroidx.compose.ui:ui-test-accessibilityandroidTestImplementationComposeUiTest@RequiresApi(34) @ExperimentalTestApi@OptIn(ExperimentalTestApi::class)androidx.compose.ui:ui-test-junit4-accessibilityandroidTestImplementationAndroidComposeTestRuleComposeTestRule@RequiresApi(34)../../patterns/structuring-a-compose-test/SKILL.md@BeforeAndroidComposeTestRuleimport androidx.compose.ui.test.junit4.accessibility.enableAccessibilityChecks
import com.google.android.apps.common.testing.accessibility.framework.integrations.espresso.AccessibilityValidator
@Before
fun before() {
rule.enableAccessibilityChecks() // default: AccessibilityValidator().setRunChecksFromRootView(true)
}compose/ui/ui-test-junit4-accessibility/src/androidMain/kotlin/androidx/compose/ui/test/junit4/accessibility/AndroidComposeTestRuleExt.android.kt:44-49@RequiresApi(34)
public fun <R : TestRule, A : ComponentActivity> AndroidComposeTestRule<R, A>.enableAccessibilityChecks(
accessibilityValidator: AccessibilityValidator =
AccessibilityValidator().setRunChecksFromRootView(true),
)ComposeUiTestrunComposeUiTest { }androidx.compose.ui.test.accessibility@OptIn(ExperimentalTestApi::class)@OptIn(ExperimentalTestApi::class)
@Test
fun runs() = runAndroidComposeUiTest<ComponentActivity> {
enableAccessibilityChecks()
onNodeWithText("Submit").performClick()
}compose/ui/ui-test-accessibility/samples/src/main/java/androidx/compose/ui/test/accessibility/samples/AccessibilityChecksSamples.kt:42-61AccessibilityValidatorval validator = AccessibilityValidator().apply {
setThrowExceptionFor(AccessibilityCheckResultType.ERROR)
}
rule.enableAccessibilityChecks(validator)AccessibilityChecksSamples.kt:68-82compose/ui/ui-test/src/commonMain/kotlin/androidx/compose/ui/test/Actions.kt:79, 160, 189, 236, 402, 451, 496, 535, 697, 780, 948tryPerformAccessibilityChecks()performClickperformScrollToperformScrollToIndex/Key/NodeperformTouchInputperformMouseInputperformKeyInputperformTrackpadInputperformRotaryScrollInputperformIndirectPointerInputperformFirstLinkClickperformMultiModalInputActions.kt:582tryPerformAccessibilityChecks()requestFocus()performSemanticsActiontryPerformAccessibilityChecks()performMultiModalInputrule.onRoot().tryPerformAccessibilityChecks()AccessibilityChecksSamples.kt:53AccessibilityChecks.enable()import androidx.test.espresso.accessibility.AccessibilityChecks
@OptIn(ExperimentalTestApi::class)
@Test
fun hybrid() = runAndroidComposeUiTest<ComponentActivity> {
val validator = AccessibilityChecks.enable()
enableAccessibilityChecks(validator)
}AccessibilityChecksSamples.kt:88-98rule.disableAccessibilityChecks()AndroidComposeTestRuleExt.android.kt:71-75ComposeTestRuleAndroidComposeTestRulecompose/ui/ui-test-junit4-accessibility/src/androidMain/kotlin/androidx/compose/ui/test/junit4/accessibility/ComposeTestRuleExt.android.kt:38-49NotImplementedErrorEnabling accessibility checks is currently only supported for AndroidComposeTestRule.
If you have a custom ComposeTestRule implementation that wraps an AndroidComposeTestRule,
directly call enableAccessibilityChecks on the AndroidComposeTestRule instead// WRONG (assertion is meaningless under Robolectric)
@Config(sdk = [34])
@RunWith(RobolectricTestRunner::class)
class MyA11yTest {
@get:Rule val rule = createComposeRule(StandardTestDispatcher())
@Test fun checks() {
rule.enableAccessibilityChecks() // logs Log.w; validator IS installed
rule.setContent { /* contrast violation */ }
rule.onNodeWithTag("submit").performClick() // may PASS, may FAIL — inconclusive
}
}
// WRONG because: HasRobolectricFingerprint = (Build.FINGERPRINT.lowercase() == "robolectric")
// triggers a Log.w but the validator is STILL installed (ComposeUiTestExt.android.kt:50-61
// AND AndroidComposeTestRuleExt.android.kt:50-64). Robolectric does not faithfully drive
// the accessibility services, so any result is inconclusive. Tracking bug: b/332778271.
// Run accessibility checks ONLY on a real device API 34+ for trustworthy results.// RIGHT — move the test to androidDeviceTest and run on a real device API 34+
@MediumTest
@RunWith(AndroidJUnit4::class)
@SdkSuppress(minSdkVersion = 34)
class MyA11yTest {
@get:Rule val rule = createComposeRule(StandardTestDispatcher())
@Before fun before() { rule.enableAccessibilityChecks() }
@Test fun submitPassesA11y() {
rule.setContent { MyScreen() }
rule.onNodeWithTag("submit").performClick()
}
}performMultiModalInput// WRONG
@Test
fun multiModal() {
rule.enableAccessibilityChecks()
rule.setContent { MyScreen() }
rule.onNodeWithTag("canvas").performMultiModalInput {
touch { down(center); up() }
key { pressKey(Key.Enter) }
}
// No a11y check ran for this action — Actions.kt:582 omits tryPerformAccessibilityChecks().
}// RIGHT
@Test
fun multiModal() {
rule.enableAccessibilityChecks()
rule.setContent { MyScreen() }
rule.onNodeWithTag("canvas").performMultiModalInput { … }
rule.onRoot().tryPerformAccessibilityChecks() // explicit
}ComposeTestRule// WRONG
val rule: ComposeTestRule = MyCustomRuleThatWrapsAndroid()
rule.enableAccessibilityChecks() // throws NotImplementedError
// WRONG because: only AndroidComposeTestRule is supported. Cited at
// ComposeTestRuleExt.android.kt:38-49.// RIGHT — call on the underlying AndroidComposeTestRule
val rule = AndroidComposeTestRule(/* … */)
rule.enableAccessibilityChecks()// RIGHT
@OptIn(ExperimentalTestApi::class)
@Test
fun shared() = runAndroidComposeUiTest<ComponentActivity> {
val validator = AccessibilityChecks.enable().apply {
setThrowExceptionFor(AccessibilityCheckResultType.ERROR)
}
enableAccessibilityChecks(validator)
onNodeWithText("Submit").performClick()
}enableAccessibilityChecksBuild.FINGERPRINT.lowercase() == "robolectric"Log.w("...", "Accessibility checks are currently not supported by Robolectric")ComposeUiTestExt.android.kt:50-53AndroidComposeTestRuleExt.android.kt:50-56androidx.compose.ui:ui-test-junit4-accessibility@OptIn(ExperimentalTestApi::class)androidx.compose.ui:ui-test-accessibilityComposeUiTesttryPerformAccessibilityChecks()performMultiModalInput { … }requestFocus()Actions.kt:582performMultiModalInputrequestFocus()performSemanticsActionenableAccessibilityChecksComposeTestRuleAndroidComposeTestRuleNotImplementedErrorComposeTestRuleExt.android.kt:38-49AccessibilityCheckResultType.ERRORAccessibilityValidator().setThrowExceptionFor(...)AccessibilityValidatorAccessibilityChecks.enable()AccessibilityChecksSamples.kt:88-98@SdkSuppress(minSdkVersion = 34)Log.wandroidTestImplementationandroidx.compose.ui:ui-test-junit4-accessibilityandroidx.compose.ui:ui-test-accessibility@OptIn(ExperimentalTestApi::class)ComposeUiTestenableAccessibilityChecks(...)@BeforedisableAccessibilityChecks()performMultiModalInput { … }rule.onRoot().tryPerformAccessibilityChecks()AccessibilityChecks.enable()enableAccessibilityChecks(validator)enableAccessibilityChecksAndroidComposeTestRuleenableAccessibilityCheckscompose/ui/ui-test-junit4-accessibility/src/androidMain/kotlin/androidx/compose/ui/test/junit4/accessibility/AndroidComposeTestRuleExt.android.kt:44-75ComposeTestRulecompose/ui/ui-test-junit4-accessibility/src/androidMain/kotlin/androidx/compose/ui/test/junit4/accessibility/ComposeTestRuleExt.android.kt:38-66enableAccessibilityCheckscompose/ui/ui-test-accessibility/src/androidMain/kotlin/androidx/compose/ui/test/accessibility/ComposeUiTestExt.android.kt:44-77ComposeUiTestExt.android.kt:50-61AndroidComposeTestRuleExt.android.kt:50-64Actions.ktcompose/ui/ui-test/src/commonMain/kotlin/androidx/compose/ui/test/Actions.kt:79, 160, 189, 236, 402, 451, 496, 535, 582 (omitted), 697, 780, 948compose/ui/ui-test-accessibility/samples/src/main/java/androidx/compose/ui/test/accessibility/samples/AccessibilityChecksSamples.kt:42-98