Skip to content

Latest commit

 

History

History
78 lines (62 loc) · 3.43 KB

README.md

File metadata and controls

78 lines (62 loc) · 3.43 KB
Raw

Roborazzi Acessibility Checks

Roborazzi Accessibility Checks is a library that integrates accessibility checks into Roborazzi. It uses Accessibility Test Framework to check accessibility.

How to use

Add dependencies

Description Dependencies
Accessibility Check testImplementation("io.github.takahirom.roborazzi:roborazzi-accessibility-check:[version]")

Configure in Junit Rule

  @get:Rule
  val roborazziRule = RoborazziRule(
    composeRule = composeTestRule,
    captureRoot = composeTestRule.onRoot(),
    options = Options(
      roborazziAccessibilityOptions = RoborazziATFAccessibilityCheckOptions(
        checker = RoborazziATFAccessibilityChecker(
          // You can also create your own checks. Please refer to the following test
          // https://github.com/takahirom/roborazzi/blob/52eef81d963bc73135e7b7a34834a56776259284/sample-android/src/test/java/com/github/takahirom/roborazzi/sample/ComposeA11yWithCustomCheckTest.kt#L65
          preset = AccessibilityCheckPreset.LATEST,
          suppressions = matchesElements(withTestTag("suppress"))
        ),
        failureLevel = RoborazziATFAccessibilityChecker.CheckLevel.Warning
      ),
      // If you want to automatically check accessibility after a test, use AccessibilityCheckAfterTestStrategy.
      accessibilityCheckStrategy = AccessibilityCheckAfterTestStrategy(),
    )
  )

Add accessibility checks

composeTestRule.onNodeWithTag("nothard").checkRoboAccessibility(
  // If you don't specify options, the options in RoborazziRule will be used.
  roborazziATFAccessibilityCheckOptions = RoborazziATFAccessibilityCheckOptions(
    checker = RoborazziATFAccessibilityChecker(
      preset = AccessibilityCheckPreset.LATEST,
    ),
    failureLevel = RoborazziATFAccessibilityChecker.CheckLevel.Warning
  )
)

Checking Log output

Particularly with failureLevel = CheckLevel.LogOnly the output log of each test will including a11y checks.

Error: [AccessibilityViewCheckResult check=AccessibilityHierarchyCheckResult ERROR SpeakableTextPresentCheck 4 [ViewHierarchyElement class=android.view.View bounds=Rect(474, 1074 - 606, 1206)] null num_answers:0 view=null]
Warning: [AccessibilityViewCheckResult check=AccessibilityHierarchyCheckResult WARNING TextContrastCheck 11 [ViewHierarchyElement class=android.widget.TextView text=Something hard to read bounds=Rect(403, 1002 - 678, 1092)] {KEY_BACKGROUND_COLOR=-12303292, KEY_CONTRAST_RATIO=1.02, KEY_FOREGROUND_COLOR=-12369085, KEY_REQUIRED_CONTRAST_RATIO=3.0} num_answers:0 view=null]

LICENSE

Copyright 2023 takahirom
Copyright 2019 Square, Inc.
Copyright The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.