testaro 5.0.0 → 5.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "5.0.0",
+  "version": "5.1.1",
   "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/samples/scripts/tp12.json

@@ -0,0 +1,162 @@
+{
+  "id": "tp12",
+  "what": "Alfa, Axe, HTML CodeSniffer, IBM, Tenon, WAVE, and 16 custom tests",
+  "strict": true,
+  "commands": [
+    {
+      "type": "launch",
+      "which": "webkit",
+      "what": "Webkit browser"
+    },
+    {
+      "type": "url",
+      "which": "https://*",
+      "what": "any page"
+    },
+    {
+      "type": "tenonRequest",
+      "id": "a",
+      "withNewContent": true,
+      "what": "Tenon API version 2 test request"
+    },
+    {
+      "type": "test",
+      "which": "motion",
+      "what": "spontaneous change of content; requires webkit",
+      "delay": 2500,
+      "interval": 2500,
+      "count": 5
+    },
+    {
+      "type": "launch",
+      "which": "chromium",
+      "what": "Chromium browser"
+    },
+    {
+      "type": "url",
+      "which": "https://*",
+      "what": "any page"
+    },
+    {
+      "type": "test",
+      "which": "bulk",
+      "what": "count of visible elements"
+    },
+    {
+      "type": "test",
+      "which": "embAc",
+      "withItems": true,
+      "what": "active elements incorrectly embedded in each other"
+    },
+    {
+      "type": "test",
+      "which": "focAll",
+      "what": "Tab-focusability"
+    },
+    {
+      "type": "test",
+      "which": "focInd",
+      "revealAll": false,
+      "allowedDelay": 250,
+      "withItems": true,
+      "what": "focus indicators"
+    },
+    {
+      "type": "test",
+      "which": "focOp",
+      "withItems": true,
+      "what": "focusability and operability of elements"
+    },
+    {
+      "type": "test",
+      "which": "hover",
+      "headSize": 20,
+      "headSampleSize": 20,
+      "tailSampleSize": 15,
+      "withItems": true,
+      "what": "hover impacts"
+    },
+    {
+      "type": "test",
+      "which": "labClash",
+      "withItems": true,
+      "what": "unlabeled and mislabeled form controls"
+    },
+    {
+      "type": "test",
+      "which": "linkUl",
+      "withItems": true,
+      "what": "underlining of inline links"
+    },
+    {
+      "type": "test",
+      "which": "menuNav",
+      "withItems": true,
+      "what": "keyboard navigation within true-focus menus"
+    },
+    {
+      "type": "test",
+      "which": "radioSet",
+      "withItems": true,
+      "what": "grouping of radio buttons in fieldsets"
+    },
+    {
+      "type": "test",
+      "which": "role",
+      "what": "validity and necessity of role assignments"
+    },
+    {
+      "type": "test",
+      "which": "styleDiff",
+      "withItems": true,
+      "what": "style consistency of headings, buttons, and links"
+    },
+    {
+      "type": "test",
+      "which": "tabNav",
+      "withItems": true,
+      "what": "keyboard navigation within tab lists"
+    },
+    {
+      "type": "test",
+      "which": "zIndex",
+      "withItems": true,
+      "what": "elements with non-auto z indexes"
+    },
+    {
+      "type": "test",
+      "which": "alfa",
+      "what": "Siteimprove alfa"
+    },
+    {
+      "type": "test",
+      "which": "axe",
+      "detailLevel": 2,
+      "rules": [],
+      "what": "Axe core, all rules"
+    },
+    {
+      "type": "test",
+      "which": "htmlcs",
+      "what": "HTML CodeSniffer"
+    },
+    {
+      "type": "test",
+      "which": "ibm",
+      "withItems": true,
+      "what": "IBM Accessibility Checker, with page content and again with URL"
+    },
+    {
+      "type": "test",
+      "which": "tenon",
+      "id": "a",
+      "what": "Tenon API version 2 result retrieval"
+    },
+    {
+      "type": "test",
+      "which": "wave",
+      "reportType": 4,
+      "what": "WAVE, report-type 4"
+    }
+  ]
+}

package/tests/htmlcs.js

@@ -6,45 +6,57 @@
 // 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 (! result.prevented) {
+    let messageStrings = [];
+    for (const standard of ['WCAG2AA']) {
+      const nextIssues = await page.evaluate(standard => HTMLCS_RUNNER.run(standard), standard);
+      messageStrings.push(... nextIssues);
     }
-    // If it is an error or a warning (not a notice):
-    else if (['Error', 'Warning'].includes(parts[0])) {
-      // Add the issue to the result.
-      if (! result[parts[0]][parts[1]]) {
-        result[parts[0]][parts[1]] = {
-          description: parts[4],
-          issues: []
-        };
+    // 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`);
       }
-      result[parts[0]][parts[1]].issues.push({
-        tagName: parts[2],
-        id: parts[3],
-        code: parts[5]
-      });
-    }
-  });
+      // 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};
 };