Accessibility Test Framework v3.0

Major updates:
 - 'uielement' package for generic UI representation
 - 'checks' package and AccessibilityHierarchyCheck for consolidated evaluation logic
 - New check: ClassNameCheck
 - New check: TraversalOrderCheck
 - Localized result strings
 - Protocol buffer representations for UI hierarchy, results, and Android constructs
 - Build switched to gradle

Author: caseyburkhardt

README

@@ -7,30 +7,37 @@ 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/
+https://www.w3.org/WAI/mobile/
+
+For more information about accessibility testing for Android applications, see:
+https://developer.android.com/training/accessibility/testing.html
 
 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
 --------------------
-Use maven to build the library. You will need to install Android 5.0 (API 21) 
-or higher to build the library. We used the Maven Android SDK Deployer to build:
-https://github.com/mosabua/maven-android-sdk-deployer
+The supplied build.gradle file can be used to build the Accessibility Test
+Framework with gradle. The build.gradle file can also be used to import the
+project to Android Studio.
 
 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:
 
-Set<AccessibilityViewHierarchyCheck> checks = getViewChecksForPreset(LATEST);
-List<AccessibilityViewCheckResult> results = new LinkedList<AccessibilityViewCheckResult>();
-for (AccessibilityViewHierarchyCheck check : checks) {
-  results.addAll(check.runCheckOnViewHierarchy(rootView));
+Set<AccessibilityHierarchyCheck> checks =
+    AccessibilityCheckPreset.getAccessibilityHierarchyChecksForPreset(
+        AccessibilityCheckPreset.LATEST);
+AccessibilityHierarchy hierarchy = AccessibilityHierarchy.newBuilder(node, context).build();
+List<AccessibilityHierarchyCheckResult> results = new ArrayList<>();
+for (AccessibilityHierarchyCheck check : checks) {
+  results.addAll(check.runCheckOnHierarchy(hierarchy));
 }
-List<AccessibilityViewCheckResult> errors = AccessibilityCheckResultUtils.getResultsForType(
+List<AccessibilityHierarchyCheckResult> errors =
+    AccessibilityCheckResultUtils.getResultsForType(
         results, AccessibilityCheckResultType.ERROR);
 if (errors.size() > 0) {
   throw new RuntimeException(errors.get(0).getMessage().toString());
-}
+}

build.gradle

@@ -0,0 +1,79 @@
+buildscript {
+    repositories {
+        jcenter()
+        google()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:3.0.1'
+        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.4'
+    }
+}
+
+
+allprojects {
+    repositories {
+        jcenter()
+        google()
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'com.google.protobuf'
+
+android {
+    compileSdkVersion "android-27"
+    buildToolsVersion '27.0.3'
+    defaultConfig {
+        minSdkVersion 14
+        targetSdkVersion 27
+    }
+    sourceSets {
+        main {
+            manifest.srcFile 'src/main/java/com/google/android/apps/common/testing/accessibility/framework/AndroidManifest.xml'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        targetCompatibility 1.8
+        sourceCompatibility 1.8
+    }
+}
+
+protobuf {
+    protoc {
+        artifact = 'com.google.protobuf:protoc:3.5.1'
+    }
+    plugins {
+        javalite {
+            // The codegen for lite comes as a separate artifact
+            artifact = 'com.google.protobuf:protoc-gen-javalite:3.0.0'
+        }
+    }
+    generateProtoTasks {
+        all().each { task ->
+            task.builtins {
+                // In most cases you don't need the full Java output
+                // if you use the lite output.
+                remove java
+            }
+            task.plugins {
+                javalite {}
+            }
+        }
+    }
+}
+
+dependencies {
+    compile 'com.google.protobuf:protobuf-lite:3.0.1'
+    compile 'com.android.support:support-v4:27.1.0'
+    compile 'com.google.guava:guava:24.0-android'
+    compile 'org.checkerframework:checker:2.3.2'
+    compile 'org.hamcrest:hamcrest-library:1.3'
+    compile 'org.hamcrest:hamcrest-core:1.3'
+}
+
+clean {
+    delete 'src/main/generated'
+}

pom.xml

@@ -17,13 +17,39 @@
 package com.google.android.apps.common.testing.accessibility.framework;
 
 /**
- * Abstract base class for all accessibility checks. Abstract subclasses include
- * {@code AccessibilityViewCheck}, the base class for all that run against {@code View}s, and
- * {@code AccessibilityInfoCheck}, the base class for checks that run against
- * {@code AccessibilityNodeInfo}s.
+ * Abstract base class for all accessibility checks. Abstract subclasses include:
+ * <ul>
+ *   <li>{@link AccessibilityHierarchyCheck} - the base class for all checks that run against
+ *   {@code AccessibilityHierarchy}</li>
+ *   <li>{@link AccessibilityEventCheck} - the base class for all checks that that run against
+ *   {@code AccessibilityEvent}</li>
+ *   <li>Deprecated {@link AccessibilityViewHierarchyCheck} - the base class for all checks that run
+ *   against {@code View}s</li>
+ *   <li>Deprecated {@link AccessibilityInfoHierarchyCheck} - the base class for all checks that run
+ *   against {@code AccessibilityNodeInfo}s</li>
+ * </ul>
  *
  * <p>Classes extending this one must implement {@code runCheck...} that return {@code List}s of
  * a subclass of {@code AccessibilityCheckResult}.
  */
 public abstract class AccessibilityCheck {
+
+  /** Categories of accessibility checks. */
+  public enum Category {
+
+    /** Checks for controls whose content labels are missing or confusing. */
+    CONTENT_LABELING,
+
+    /** Checks for touch targets that could cause difficulty for users with motor impairments. */
+    TOUCH_TARGET_SIZE,
+
+    /** Checks for elements that may be difficult to see due to low contrast. */
+    LOW_CONTRAST,
+
+    /**
+     * Checks for conditions that impact accessibility due to the way a UI presents itself to
+     * accessibility services.
+     */
+    IMPLEMENTATION;
+  }
 }