xref: /aosp_15_r20/external/accessibility-test-framework/README.md (revision 24652f07b1b5a5b18a8d655a3a5543bcf39b475e)

# Accessibility Test Framework for Android

To help people with disabilities access Android apps, developers of those apps
need to consider how their apps will be presented to accessibility services.
Some good practices can be checked by automated tools, such as if a View has a
contentDescription. Other rules require human judgment, such as whether or not a
contentDescription makes sense to all users.

For more information about Mobile Accessibility, see
http://www.w3.org/WAI/mobile/.

This library collects various accessibility-related checks on View objects as
well as AccessibilityNodeInfo objects (which the Android framework derives from
Views and sends to AccessibilityServices).

## Building the Library

The supplied gradle wrapper and build.gradle file can be used to build the
Accessibility Test Framework or import the project into Android Studio.

```shell
$ ./gradlew build
```

## Sample Usage

Given a view, the following code runs all accessibility checks on all views in
the hierarchy rooted at that view and throws an exception if any errors are
found:

```java
ImmutableSet<AccessibilityHierarchyCheck> checks =
    AccessibilityCheckPreset.getAccessibilityHierarchyChecksForPreset(
        AccessibilityCheckPreset.LATEST);
AccessibilityHierarchyAndroid hierarchy = AccessibilityHierarchyAndroid.newBuilder(view).build();
List<AccessibilityHierarchyCheckResult> results = new ArrayList<>();
for (AccessibilityHierarchyCheck check : checks) {
  results.addAll(check.runCheckOnHierarchy(hierarchy));
}
List<AccessibilityHierarchyCheckResult> errors =
    AccessibilityCheckResultUtils.getResultsForType(
        results, AccessibilityCheckResultType.ERROR);
if (!errors.isEmpty()) {
  throw new RuntimeException(errors.get(0).getMessage().toString());
}
```