testaro 5.0.1 → 5.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "5.0.1",
+  "version": "5.1.2",
   "description": "Automation of accessibility testing",
   "main": "index.js",
   "scripts": {

package/run.js

@@ -37,7 +37,7 @@ const tests = {
   focInd: 'focus indicators',
   focOp: 'focusability and operability',
   hover: 'hover-caused content additions',
-  htmlcs: 'HTML CodeSniffer WCAG 2.1 A, AA, and AAA rulesets',
+  htmlcs: 'HTML CodeSniffer WCAG 2.1 AA ruleset',
   ibm: 'IBM Accessibility Checker',
   labClash: 'labeling inconsistencies',
   linkUl: 'adjacent-link underlining',
@@ -560,7 +560,7 @@ const visit = async (act, page, isStrict) => {
           // If the visit fails:
           if (response === 'error') {
             // Give up.
-            const errorMsg = `ERROR: Attemts to visit ${requestedURL} failed`;
+            const errorMsg = `ERROR: Attempts to visit ${requestedURL} failed`;
             console.log(errorMsg);
             act.result = errorMsg;
             await page.goto('about:blank')

package/tests/htmlcs.js

@@ -6,50 +6,75 @@
 // FUNCTIONS
 // Runs HTML CodeSniffer on the page.
 exports.reporter = async page => {
+  const result = {};
   await page.addScriptTag({
     path: `${__dirname}/../htmlcs/HTMLCS.js`
+  })
+  .catch(error => {
+    console.log(`ERROR adding the htmlcs script to the page (${error.message})`);
+    result.prevented = true;
+    result.error = 'ERROR adding the htmlcs script to the page';
   });
-  let messageStrings = [];
-  for (const standard of ['WCAG2A', 'WCAG2AA', 'WCAG2AAA']) {
-    const nextIssues = await page.evaluate(standard => HTMLCS_RUNNER.run(standard), standard);
-    messageStrings.push(... nextIssues);
-  }
-  // Sort the issues by class and standard.
-  messageStrings.sort();
-  // Remove any duplicate issues.
-  messageStrings = [... new Set(messageStrings)];
-  // Initialize the result.
-  const result = {
-    Error: {},
-    Warning: {}
-  };
-  // For each issue:
-  messageStrings.forEach(string => {
-    const parts = string.split(/\|/g);
-    const partCount = parts.length;
-    if (partCount !== 6) {
-      console.log(`ERROR: Issue string ${string} has too few or too many parts`);
-    }
-    // If it is an error or a warning (not a notice):
-    else if (['Error', 'Warning'].includes(parts[0])) {
-      /*
-        Add the issue to an issueClass.issueCode.description array in the result.
-        This saves space, because, although some descriptions are issue-specific, such as
-        descriptions that state the contrast ratio of an element, most descriptions are
-        generic, so typically many issues share a description.
-      */
-      if (! result[parts[0]][parts[1]]) {
-        result[parts[0]][parts[1]] = {};
+  if (! result.prevented) {
+    let messageStrings = [];
+    for (const standard of ['WCAG2AA']) {
+      const nextIssues = await page.evaluate(standard => {
+        let issues = null;
+        try {
+          issues = HTMLCS_RUNNER.run(standard);
+        }
+        catch(error) {
+          console.log(`ERROR executing HTMLCS_RUNNER on ${document.URL} (${error.message})`);
+        };
+        return issues;
+      }, standard);
+      if (nextIssues) {
+        messageStrings.push(... nextIssues);
       }
-      if (! result[parts[0]][parts[1]][parts[4]]) {
-        result[parts[0]][parts[1]][parts[4]] = [];
+      else {
+        result.prevented = true;
+        result.error = 'ERROR executing HTMLCS_RUNNER in the page';
+        break;
       }
-      result[parts[0]][parts[1]][parts[4]].push({
-        tagName: parts[2],
-        id: parts[3],
-        code: parts[5]
+    };
+    if (! result.prevented) {
+      // Sort the issues by class and standard.
+      messageStrings.sort();
+      // Remove any duplicate issues.
+      messageStrings = [... new Set(messageStrings)];
+      // Initialize the result.
+      result.Error = {};
+      result.Warning = {};
+      // For each issue:
+      messageStrings.forEach(string => {
+        const parts = string.split(/\|/, 6);
+        const partCount = parts.length;
+        if (partCount < 6) {
+          console.log(`ERROR: Issue string ${string} has too few parts`);
+        }
+        // If it is an error or a warning (not a notice):
+        else if (['Error', 'Warning'].includes(parts[0])) {
+          /*
+            Add the issue to an issueClass.issueCode.description array in the result.
+            This saves space, because, although some descriptions are issue-specific, such as
+            descriptions that state the contrast ratio of an element, most descriptions are
+            generic, so typically many issues share a description.
+          */
+          const issueCode = parts[1].replace(/^WCAG2|\.Principle\d\.Guideline[\d_]+/g, '');
+          if (! result[parts[0]][issueCode]) {
+            result[parts[0]][issueCode] = {};
+          }
+          if (! result[parts[0]][issueCode][parts[4]]) {
+            result[parts[0]][issueCode][parts[4]] = [];
+          }
+          result[parts[0]][issueCode][parts[4]].push({
+            tagName: parts[2],
+            id: parts[3],
+            code: parts[5]
+          });
+        }
       });
     }
-  });
+  }
   return {result};
 };