SONARHTML-332 S6819 Skip non-standard html components (#491)

Author: zglicz

.github/workflows/build.yml

@@ -108,6 +108,9 @@ jobs:
           ARTIFACTORY_ACCESS_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).ARTIFACTORY_ACCESS_TOKEN }}
         run: |
           mvn -f its/ruling/pom.xml verify -Pqa -Dsonar.runtimeVersion=LATEST_RELEASE -Dmaven.test.redirectTestOutputToFile=false -B -e -V
+      - name: Show ruling differences
+        if: failure()
+        run: ./tools/ruling-debug-script.sh
 
   promote:
     needs: [build, build-windows, qa, ruling]

its/ruling/src/test/resources/expected/Web-S6819.json

@@ -20,9 +20,6 @@
 59,
 127
 ],
-"project:voten/resources/views/auth/register.blade.php": [
-56
-],
 "project:voten/resources/views/passport/index.blade.php": [
 26,
 27

sonar-html-plugin/src/main/java/org/sonar/plugins/html/checks/accessibility/PreferTagOverRoleCheck.java

@@ -25,12 +25,14 @@
 import org.sonar.plugins.html.checks.AbstractPageCheck;
 import org.sonar.plugins.html.node.TagNode;
 
+import static org.sonar.plugins.html.api.HtmlConstants.hasKnownHTMLTag;
+
 @Rule(key = "S6819")
 public class PreferTagOverRoleCheck extends AbstractPageCheck {
   @Override
   public void startElement(TagNode element) {
     var roleAttr = element.getPropertyValue("role");
-    if (roleAttr == null) {
+    if (roleAttr == null || !hasKnownHTMLTag(element)) {
       return;
     }
 

sonar-html-plugin/src/test/java/org/sonar/plugins/html/checks/accessibility/PreferTagOverRoleCheckTest.java

@@ -34,17 +34,14 @@ void html() {
     HtmlSourceCode sourceCode = TestHelper.scan(
       new File("src/test/resources/checks/PreferTagOverRoleCheck.html"),
       new PreferTagOverRoleCheck());
-    var issues = sourceCode.getIssues();
-    assertThat(issues).hasSize(8);
     checkMessagesVerifier.verify(sourceCode.getIssues())
       .next().atLine(1).withMessage("Use <input> instead of the checkbox role to ensure accessibility across all devices.")
       .next().atLine(2).withMessage("Use <button> or <input> instead of the button role to ensure accessibility across all devices.")
       .next().atLine(3).withMessage("Use <h1> or <h2> or <h3> or <h4> or <h5> or <h6> instead of the heading role to ensure accessibility across all devices.")
       .next().atLine(4).withMessage("Use <a> or <area> instead of the link role to ensure accessibility across all devices.")
       .next().atLine(5).withMessage("Use <tbody> or <tfoot> or <thead> instead of the rowgroup role to ensure accessibility across all devices.")
       .next().atLine(6).withMessage("Use <input> instead of the checkbox role to ensure accessibility across all devices.")
-      .next().atLine(7).withMessage("Use <input> instead of the checkbox role to ensure accessibility across all devices.")
-      .next().atLine(8).withMessage("Use <header> instead of the banner role to ensure accessibility across all devices.")
+      .next().atLine(7).withMessage("Use <header> instead of the banner role to ensure accessibility across all devices.")
       .consume();
   }
 }

sonar-html-plugin/src/test/resources/checks/PreferTagOverRoleCheck.html

@@ -4,12 +4,13 @@
 <div role="link" />               <!-- Noncompliant -->
 <div role="rowgroup" />           <!-- Noncompliant -->
 <span role="checkbox" />          <!-- Noncompliant -->
-<other role="checkbox" />         <!-- Noncompliant -->
 <div role="banner" />             <!-- Noncompliant -->
 
 <div />
 <div role="unknown" />
 <div role="also unknown" />
 <other />
 <img role="img" />
-<input role="checkbox" />
+<input role="checkbox" />
+<other role="checkbox" />         <!-- Compliant as using non-standard html tag -->
+<mat-card role="region" aria-labelledby="reportsHeading" appearance="outlined" /> <!-- Compliant as using non-standard html tag -->

tools/ruling-debug-script.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+default_actual_dir="its/ruling/target/actual"
+
+expected_dir="its/ruling/src/test/resources/expected"
+actual_dir="${1:-$default_actual_dir}"
+
+# Differing files
+diff -rq "$expected_dir" "$actual_dir" | grep "differ" | while read -r line; do
+    file1=$(echo "$line" | awk '{print $2}')
+    file2=$(echo "$line" | awk '{print $4}')
+    echo "Differences in: $file1"
+    diff -u "$file1" "$file2"
+    echo "----------------------------------------"
+done
+
+# Files only in one directory
+diff -rq "$expected_dir" "$actual_dir" | grep "Only in" | while read -r line; do
+    dir=$(echo "$line" | awk '{print $3}' | sed 's/://')
+    file=$(echo "$line" | awk '{print $4}')
+    full_path="$dir/$file"
+    if [ -f "$full_path" ]; then
+      echo "File only in $dir: $file"
+      cat "$full_path"
+      echo "----------------------------------------"
+    fi
+done