Fix #3300: Add check for accessibility label for activities

.github/workflows/static_checks.yml

@@ -118,3 +118,8 @@ jobs:
         if: always()
         run: |
           bazel run //scripts:test_file_check -- $(pwd)
+
+      - name: Accessibility label Check
+        if: always()
+        run: |
+          bazel run //scripts:accessibility_label_check -- $(pwd) scripts/assets/accessibility_label_exemptions.pb app/src/main/AndroidManifest.xml

scripts/BUILD.bazel

@@ -5,6 +5,7 @@ Kotlin-based scripts to help developers or perform continuous integration tasks.
 load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_jvm_binary", "kt_jvm_library")
 load(
     "//scripts:script_assets.bzl",
+    "generate_accessibility_label_assets_list_from_text_protos",
     "generate_maven_assets_list_from_text_protos",
     "generate_regex_assets_list_from_text_protos",
     "generate_test_file_assets_list_from_text_protos",
@@ -115,3 +116,18 @@ kt_jvm_binary(
     main_class = "org.oppia.android.scripts.maven.GenerateMavenDependenciesListKt",
     runtime_deps = ["//scripts/src/java/org/oppia/android/scripts/maven:generate_maven_dependencies_list_lib"],
 )
+
+ACCESSIBILITY_LABEL_EXEMPTION_ASSETS = generate_accessibility_label_assets_list_from_text_protos(
+    name = "accessibility_label_exemption_assets",
+    accessibility_label_exemptions_name = ["accessibility_label_exemptions"],
+)
+
+kt_jvm_binary(
+    name = "accessibility_label_check",
+    testonly = True,
+    data = ACCESSIBILITY_LABEL_EXEMPTION_ASSETS,
+    main_class = "org.oppia.android.scripts.label.AccessibilityLabelCheckKt",
+    runtime_deps = [
+        "//scripts/src/java/org/oppia/android/scripts/label:accessibility_label_check_lib",
+    ],
+)

scripts/assets/accessibility_label_exemptions.textproto

@@ -0,0 +1,27 @@
+exempted_activity: "app/src/main/java/org/oppia/android/app/home/HomeActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/home/recentlyplayed/RecentlyPlayedActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/mydownloads/MyDownloadsActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/player/state/testing/StateFragmentTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/profileprogress/ProfilePictureActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/settings/profile/ProfileEditActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/splash/SplashActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/AudioFragmentTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/BindableAdapterTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/ConceptCardFragmentTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/DragDropTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/ExplorationInjectionActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/ExplorationTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/HomeFragmentTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/HomeTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/HtmlParserTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/ImageRegionSelectionTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/InputInteractionViewTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/LessonThumbnailImageViewTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/NavigationDrawerTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/ProfileChooserFragmentTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/SplashTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/TestFontScaleConfigurationUtilActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/TopicRevisionTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/TopicTestActivity"
+exempted_activity: "app/src/main/java/org/oppia/android/app/testing/TopicTestActivityForStory"
+exempted_activity: "app/src/main/java/org/oppia/android/app/walkthrough/WalkthroughActivity"

scripts/script_assets.bzl

@@ -47,15 +47,15 @@ def generate_test_file_assets_list_from_text_protos(
 
     Args:
         name: str. The name of this generation instance. This will be a prefix for derived targets.
-        test_file_exemptions_name: list of str. The list of test file exemptions file names.
+        test_file_exemptions_name: list of str. The list of test file exemptions file name.
 
     Returns:
         list of str. The list of new proto binary asset files that were generated.
     """
     return generate_proto_binary_assets(
         name = name,
         names = test_file_exemptions_name,
-        proto_dep_name = "test_file_exemptions",
+        proto_dep_name = "script_exemptions",
         proto_type_name = "TestFileExemptions",
         name_prefix = name,
         asset_dir = "assets",
@@ -87,3 +87,28 @@ def generate_maven_assets_list_from_text_protos(
         proto_dep_bazel_target_prefix = "//scripts/src/java/org/oppia/android/scripts/proto",
         proto_package = "proto",
     )
+
+def generate_accessibility_label_assets_list_from_text_protos(
+        name,
+        accessibility_label_exemptions_name):
+    """
+    Converts a single list of text proto assets to binary.
+
+    Args:
+        name: str. The name of this generation instance. This will be a prefix for derived targets.
+        accessibility_label_exemptions_name: list of str. The list of accessibility label exemptions
+         file name.
+
+    Returns:
+        list of str. The list of new proto binary asset files that were generated.
+    """
+    return generate_proto_binary_assets(
+        name = name,
+        names = accessibility_label_exemptions_name,
+        proto_dep_name = "script_exemptions",
+        proto_type_name = "AccessibilityLabelExemptions",
+        name_prefix = name,
+        asset_dir = "assets",
+        proto_dep_bazel_target_prefix = "//scripts/src/java/org/oppia/android/scripts/proto",
+        proto_package = "proto",
+    )

scripts/src/java/org/oppia/android/scripts/label/AccessibilityLabelCheck.kt

@@ -0,0 +1,203 @@
+package org.oppia.android.scripts.label
+
+import org.oppia.android.scripts.proto.AccessibilityLabelExemptions
+import org.w3c.dom.Node
+import org.w3c.dom.NodeList
+import java.io.File
+import java.io.FileInputStream
+import javax.xml.parsers.DocumentBuilderFactory
+
+/**
+ * Script for ensuring that all the Activities in the codebase are defined with accessibility
+ * labels.
+ *
+ * Usage:
+ *   bazel run //scripts:accessibility_label_check -- <path_to_directory_root>
+ *   <path_to_proto_binary> [paths to manifest files...]
+ *
+ * Arguments:
+ * - path_to_directory_root: directory path to the root of the Oppia Android repository.
+ * - path_to_proto_binary: relative path to the exemption .pb file.
+ * - paths to manifest files: paths leading to the manifest files.
+ *
+ * Example:
+ *   bazel run //scripts:accessibility_label_check -- $(pwd) app/src/main/AndroidManifest.xml
+ *    scripts/assets/accessibility_label_exemptions.pb
+ */
+fun main(vararg args: String) {
+  val repoPath = "${args[0]}/"
+
+  val pathToProtoBinary = args[1]
+
+  val accessibilityLabelExemptionTextProtoFilePath = "scripts/assets/accessibility_label_exemptions"
+
+  val accessibilityLabelExemptionList = loadAccessibilityLabelExemptionsProto(pathToProtoBinary)
+    .getExemptedActivityList()
+
+  val manifestPaths = args.drop(2)
+
+  val activityPathPrefix = "app/src/main/java/"
+
+  val builderFactory = DocumentBuilderFactory.newInstance()
+
+  val repoRoot = File(repoPath)
+
+  val missingAccessibilityLabelActivities = manifestPaths.flatMap { relativePath ->
+    val file = File(repoRoot, relativePath)
+    val docBuilder = builderFactory.newDocumentBuilder()
+    val doc = docBuilder.parse(file)
+    // Normalisation results in the removal of redundancies such as whitespaces, line breaks and
+    // comments.
+    doc.getDocumentElement().normalize()
+    val packageName = doc.getDocumentElement().getAttribute("package")
+    return@flatMap doc.getElementsByTagName("activity").toListOfNodes().mapNotNull { activityNode ->
+      computeFailureActivityPath(
+        activityNode = activityNode,
+        activityPathPrefix = activityPathPrefix,
+        packageName = packageName
+      )
+    }
+  }
+
+  val redundantExemptions = accessibilityLabelExemptionList - missingAccessibilityLabelActivities
+
+  val failureActivitiesAfterExemption = missingAccessibilityLabelActivities -
+    accessibilityLabelExemptionList
+
+  logRedundantExemptions(redundantExemptions, accessibilityLabelExemptionTextProtoFilePath)
+
+  logFailures(failureActivitiesAfterExemption, accessibilityLabelExemptionTextProtoFilePath)
+
+  if (failureActivitiesAfterExemption.isNotEmpty() || redundantExemptions.isNotEmpty()) {
+    throw Exception("ACCESSIBILITY LABEL CHECK FAILED")
+  } else {
+    println("ACCESSIBILITY LABEL CHECK PASSED")
+  }
+}
+
+/**
+ * Computes path of the activity which fails the accesssibility label check.
+ *
+ * @param activityNode the activity node
+ * @param activityPathPrefix the path prefix for the activities
+ * @param packageName the package attribute value of the manifest element
+ * @return path of the failing activity relative to the root repository. This returns null if the
+ *     activity has an accessibility label present.
+ */
+private fun computeFailureActivityPath(
+  activityNode: Node,
+  activityPathPrefix: String,
+  packageName: String
+): String? {
+  val attributesList = activityNode.getAttributes()
+  val activityName = attributesList.getNamedItem("android:name").getNodeValue()
+  val activityPath = computeActivityPathFromName(
+    activityPathPrefix = activityPathPrefix,
+    activityName = activityName,
+    packageName = packageName
+  )
+  if (attributesList.getNamedItem("android:label") != null) {
+    return null
+  }
+  return activityPath
+}
+
+/**
+ * Computes the activity path from the name attribute value of the activity element.
+ *
+ * @param activityPathPrefix the path prefix for the activities
+ * @param activityName the name attribute value of the activity element
+ * @param packageName the package attribute value of the manifest element
+ * @return the activity path relative to the root repository
+ */
+private fun computeActivityPathFromName(
+  activityPathPrefix: String,
+  activityName: String,
+  packageName: String
+): String {
+  if (activityName.startsWith(".")) {
+    return activityPathPrefix + (packageName + activityName).replace(".", "/")
+  } else {
+    return activityPathPrefix + activityName.replace(".", "/")
+  }
+}
+
+/**
+ * Converts [NodeList] to list of nodes, since [NodeList] is not iterable.
+ *
+ * @return the list of nodes
+ */
+private fun NodeList.toListOfNodes(): List<Node> = (0 until getLength()).map(this::item)
+
+/**
+ * Logs the failures for accessibility label check.
+ *
+ * @param missingAccessibilityLabelActivities list of Activities missing accessibility label
+ * @param accessibilityLabelExemptionTextProtoFilePath the location of the accessibility label
+ *     exemption textproto file.
+ */
+private fun logFailures(
+  missingAccessibilityLabelActivities: List<String>,
+  accessibilityLabelExemptionTextProtoFilePath: String
+) {
+  if (missingAccessibilityLabelActivities.isNotEmpty()) {
+    println("Accessibility label missing for Activities:")
+    missingAccessibilityLabelActivities.sorted().forEach { activityPath ->
+      println("- $activityPath")
+    }
+    println()
+    println(
+      "If this is correct, please update $accessibilityLabelExemptionTextProtoFilePath.textproto"
+    )
+    println(
+      "Note that, in general, all Activities should have labels. If you choose to add an" +
+        " exemption, please specifically call this out in your PR description."
+    )
+    println()
+  }
+}
+
+/**
+ * Logs the redundant exemptions.
+ *
+ * @param redundantExemptions list of redundant exemptions
+ * @param accessibilityLabelExemptionTextProtoFilePath the location of the accessibility label
+ *     exemption textproto file.
+ */
+private fun logRedundantExemptions(
+  redundantExemptions: List<String>,
+  accessibilityLabelExemptionTextProtoFilePath: String
+) {
+  if (redundantExemptions.isNotEmpty()) {
+    println("Redundant exemptions:")
+    redundantExemptions.sorted().forEach { exemption ->
+      println("- $exemption")
+    }
+    println(
+      "Please remove them from $accessibilityLabelExemptionTextProtoFilePath.textproto"
+    )
+    println()
+  }
+}
+
+/**
+ * Loads the test file exemptions list to proto.
+ *
+ * @param pathToProtoBinary path to the pb file to be parsed
+ * @return proto class from the parsed textproto file
+ */
+private fun loadAccessibilityLabelExemptionsProto(
+  pathToProtoBinary: String
+): AccessibilityLabelExemptions {
+  val protoBinaryFile = File(pathToProtoBinary)
+  val builder = AccessibilityLabelExemptions.getDefaultInstance().newBuilderForType()
+
+  // This cast is type-safe since proto guarantees type consistency from mergeFrom(),
+  // and this method is bounded by the generic type T.
+  @Suppress("UNCHECKED_CAST")
+  val protoObj: AccessibilityLabelExemptions =
+    FileInputStream(protoBinaryFile).use {
+      builder.mergeFrom(it)
+    }.build() as AccessibilityLabelExemptions
+  return protoObj
+}

scripts/src/java/org/oppia/android/scripts/label/BUILD.bazel

@@ -0,0 +1,17 @@
+"""
+Libraries corresponding to accessibility label check that ensures all the activities in the codebase
+are defined with labels.
+"""
+
+load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_jvm_library")
+
+kt_jvm_library(
+    name = "accessibility_label_check_lib",
+    testonly = True,
+    srcs = ["AccessibilityLabelCheck.kt"],
+    visibility = ["//scripts:oppia_script_binary_visibility"],
+    deps = [
+        "//scripts/src/java/org/oppia/android/scripts/common:repository_file",
+        "//scripts/src/java/org/oppia/android/scripts/proto:script_exemptions_java_proto_lite",
+    ],
+)

scripts/src/java/org/oppia/android/scripts/proto/BUILD.bazel

@@ -34,15 +34,15 @@ java_lite_proto_library(
 )
 
 proto_library(
-    name = "test_file_exemptions_proto",
+    name = "script_exemptions_proto",
     srcs = ["script_exemptions.proto"],
     visibility = ["//scripts:oppia_script_binary_visibility"],
 )
 
 java_lite_proto_library(
-    name = "test_file_exemptions_java_proto_lite",
+    name = "script_exemptions_java_proto_lite",
     visibility = ["//scripts:oppia_script_library_visibility"],
-    deps = [":test_file_exemptions_proto"],
+    deps = [":script_exemptions_proto"],
 )
 
 proto_library(

scripts/src/java/org/oppia/android/scripts/proto/script_exemptions.proto

@@ -19,3 +19,19 @@ message TestFileExemptions {
   // at the correct lexicographical position in the textproto file.
   repeated string exempted_file_path = 1;
 }
+
+// Exemptions for the accessibility label check. Exemptions indicate Activities for which we should
+// not check for the presence of an accessibility label.
+message AccessibilityLabelExemptions {
+  // List of all the Activities which should be exempted for the accessibility label check.
+  // For exempting any Activity, provide its relative path to root in
+  // 'script/assets/accessibility_label_exemptions.textproto'
+  // Also, note that the exemptions in the textproto file are maintained in lexicographical order.
+  // While adding any new Activity, please add it only at the correct lexicographical position,
+  // so that the list remains sorted.
+  //
+  // For example if we want to add the 'RecentlyPlayedActivity' to the exemption list, add:
+  // 'exempted_activity: "app/src/main/java/org/oppia/android/app/home/HomeActivity"'
+  // at the correct lexicographical position in the textproto file.
+  repeated string exempted_activity = 1;
+}

scripts/src/java/org/oppia/android/scripts/testfile/BUILD.bazel

@@ -12,6 +12,6 @@ kt_jvm_library(
     visibility = ["//scripts:oppia_script_binary_visibility"],
     deps = [
         "//scripts/src/java/org/oppia/android/scripts/common:repository_file",
-        "//scripts/src/java/org/oppia/android/scripts/proto:test_file_exemptions_java_proto_lite",
+        "//scripts/src/java/org/oppia/android/scripts/proto:script_exemptions_java_proto_lite",
     ],
 )