testaro 64.6.0 → 64.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "64.6.0",
+  "version": "64.7.0",
   "description": "Run 1000 web accessibility tests from 11 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/procs/standardize.js

@@ -13,7 +13,7 @@
   Converts test results to the standard format.
 */
 
-// ########## FUNCTIONS
+// FUNCTIONS
 
 // Limits the length of and unilinearizes a string.
 const cap = rawString => {
@@ -327,11 +327,11 @@ const doWAVE = (result, standardResult, categoryName) => {
     const {items} = category;
     if (items) {
       Object.keys(items).forEach(ruleID => {
-        items[ruleID].selectors.forEach(selector => {
+        items[ruleID].selectors.forEach(violationFacts => {
           let tagName = '';
           let id = '';
-          if (typeof selector === 'string') {
-            const finalTerm = selector.replace(/^.+\s/, '');
+          if (typeof violationFacts[0] === 'string') {
+            const finalTerm = violationFacts[0].replace(/^.+\s/, '');
             if (finalTerm.includes('#')) {
               const finalArray = finalTerm.split('#');
               tagName = finalArray[0].replace(/:.*/, '');
@@ -350,9 +350,9 @@ const doWAVE = (result, standardResult, categoryName) => {
             location: {
               doc: 'dom',
               type: 'selector',
-              spec: selector
+              spec: violationFacts[0]
             },
-            excerpt: ''
+            excerpt: violationFacts[1]
           };
           standardResult.instances.push(instance);
         });
@@ -667,13 +667,18 @@ const convert = (toolName, data, result, standardResult) => {
     result.violations.forEach(violation => {
       // Get its standard instance properties.
       const element = violation.element.replace(/\s+/g, ' ');
-      const {message, description, severity} = violation;
+      const {boxID, description, message, notInDOM, pathID, severity} = violation;
       const ordinalSeverity = ['Minor', 'Moderate', '', 'Severe'].indexOf(severity);
       const tagNameCandidate = element.replace(/^<| .*$/g, '');
       const tagName = /^[a-zA-Z0-9]+$/.test(tagNameCandidate) ? tagNameCandidate.toUpperCase() : '';
       let id = '';
       const location = {};
-      if (tagName) {
+      if (notInDOM) {
+        location.doc = 'notInDOM';
+        location.type = '';
+        location.spec = '';
+      }
+      else if (tagName) {
         const idTerm = element
         .replace(/>.*$/, '')
         .split(' ')
@@ -696,7 +701,9 @@ const convert = (toolName, data, result, standardResult) => {
         tagName,
         id,
         location,
-        excerpt: element
+        excerpt: element,
+        boxID,
+        pathID
       };
       // Add the instance to the standard result.
       standardResult.instances.push(instance);

package/procs/testaro.js

@@ -235,9 +235,9 @@ exports.addTestaroIDs = async page => {
   });
 };
 // Returns location data from the extract of a standard instance.
-exports.getLocationData = async (page, extract) => {
-  const testaroIDArray = extract.match(/data-testaro-id="(\d+)#"/);
-  // If the extract contains a Testaro identifier:
+exports.getLocationData = async (page, excerpt) => {
+  const testaroIDArray = excerpt.match(/data-testaro-id="(\d+)#"/);
+  // If the excerpt contains a Testaro identifier:
   if (testaroIDArray) {
     const testaroID = testaroIDArray[1];
     // Return location data for the element.

package/run.js

@@ -413,11 +413,10 @@ const launch = exports.launch = async (
           get: () => ['en-US', 'en']
         });
       });
-      const isTestaroTest = act.type === 'test' && act.which === 'testaro';
-      const isHTMLCSTest = act.type === 'test' && act.which === 'htmlcs';
-      const isNuTest = act.type === 'test' && (['nuVal', 'nuVnu'].some(id => act.which === id));
-      // If the launch is for a testaro,3 htmlcs, or Nu test act:
-      if (isTestaroTest || isHTMLCSTest || isNuTest) {
+      const needsXPath = act.type === 'test'
+      && ['testaro', 'htmlcs', 'nuVal', 'nuVnu', 'wax'].includes(act.which);
+      // If the launch is for a test act that requires XPaths:
+      if (needsXPath) {
         // Add a script to the page to add a window method to get the XPath of an element.
         await page.addInitScript(() => {
           window.getXPath = element => {
@@ -466,7 +465,7 @@ const launch = exports.launch = async (
         });
       }
       // If the launch is for a testaro test act:
-      if (isTestaroTest) {
+      if (act.type === 'test' && act.which === 'testaro') {
         // Add a script to the page to compute the accessible name of an element.
         await page.addInitScript({path: require.resolve('./dist/nameComputation.js')});
         // Add a script to the page to:
@@ -478,7 +477,7 @@ const launch = exports.launch = async (
             && typeof window.computeAccessibleName === 'function';
             return nameIsComputable ? window.computeAccessibleName(element) : '';
           };
-          // Add a window method to return an instance.
+          // Add a window method to return a standard instance.
           window.getInstance = (
             element, ruleID, what, count = 1, ordinalSeverity, summaryTagName = ''
           ) => {
@@ -494,7 +493,7 @@ const launch = exports.launch = async (
               const rawExcerpt = (element.textContent.trim() || element.outerHTML.trim())
               .replace(/\s+/g, ' ');
               const excerpt = rawExcerpt.slice(0, 200);
-              // Return an itemized instance.
+              // Return an itemized standard instance.
               return {
                 ruleID,
                 what,

package/tests/htmlcs.js

@@ -14,7 +14,7 @@
 
 // IMPORTS
 
-// Module to add Testaro IDs to elements.
+// Module to add and use unique element IDs.
 const {addTestaroIDs, getLocationData} = require('../procs/testaro');
 // Module to handle files.
 const fs = require('fs/promises');
@@ -81,7 +81,7 @@ exports.reporter = async (page, report, actIndex) => {
     result.Error = {};
     result.Warning = {};
     // For each violation:
-    messageStrings.forEach(async string => {
+    for (const string of messageStrings) {
       // Split its message into severity class, rule ID, tagname, ID, rule description, and excerpt.
       const parts = string.split(/\|/, 6);
       const partCount = parts.length;
@@ -110,7 +110,7 @@ exports.reporter = async (page, report, actIndex) => {
           pathID
         });
       }
-    });
+    }
   }
   return {
     data,

package/tests/wave.js

@@ -96,30 +96,55 @@ exports.reporter = async (page, report, actIndex) => {
               // Add WCAG information from the WAVE documentation.
               const waveDocJSON = await fs.readFile('procs/wavedoc.json', 'utf8');
               const waveDoc = JSON.parse(waveDocJSON);
-              Object.keys(categories).forEach(categoryName => {
+              // For each rule category:
+              for (const categoryName of Object.keys(categories)) {
                 const category = categories[categoryName];
-                // If any violations were reported:
+                // If any violations were reported in the category:
                 if (
                   category
                   && category.items
                   && Object.keys(category.items).length
                 ) {
                   const {items} = category;
-                  Object.keys(items).forEach(issueName => {
-                    const issueDoc = waveDoc.find((issue => issue.name === issueName));
-                    const {guidelines} = issueDoc;
-                    items[issueName].wcag = guidelines;
-                  });
+                  // For each rule violated (named item by WAVE):
+                  for (const ruleName of Object.keys(items)) {
+                    const ruleDoc = waveDoc.find((rule => rule.name === ruleName));
+                    const {guidelines} = ruleDoc;
+                    const rule = items[ruleName];
+                    // Add WCAG information to the rule data.
+                    rule.wcag = guidelines;
+                    // For each violation:
+                    for (const index in rule.selectors) {
+                      const selector = rule.selectors[index];
+                      // Get an excerpt of the element.
+                      const excerpt = await page.evaluate(selector => {
+                        const element = document.querySelector(selector);
+                        // If the selector matches an element:
+                        if (element) {
+                          // Get an excerpt of the element.
+                          const rawExcerpt = element.textContent.trim() || element.outerHTML.trim();
+                          const normalizedExcerpt = rawExcerpt.replace(/\s+/g, ' ');
+                          return normalizedExcerpt.slice(0, 300);
+                        }
+                        else {
+                          return '';
+                        }
+                      }, selector);
+                      // Convert the violation selector to a selector-excerpt pair.
+                      rule.selectors[index] = [selector, excerpt];
+                    }
+                  }
                 }
-              });
+              };
               // Add important data to the result.
               if (statistics) {
                 data.pageTitle = statistics.pagetitle || '';
                 data.pageURL = statistics.pageurl || '';
-                data.time = statistics.time || null;
+                data.elapsedSeconds = statistics.time || null;
                 data.creditsRemaining = statistics.creditsremaining || null;
                 data.allItemCount = statistics.allitemcount || null;
                 data.totalElements = statistics.totalelements || null;
+                data.waveURL = statistics.waveurl || '';
               }
               // Return the result.
               resolve(actResult);

package/tests/wax.js

@@ -15,7 +15,9 @@
 
 // IMPORTS
 
-// WAX
+// Module to add and use unique element IDs.
+const {addTestaroIDs, getLocationData} = require('../procs/testaro');
+// Modules to run WAX.
 const runWax = require('@wally-ax/wax-dev');
 const waxDev = {runWax};
 
@@ -26,15 +28,17 @@ exports.reporter = async (page, report, actIndex) => {
   // Initialize the act report.
   let data = {};
   let result = {};
-  // Run WAX.
   const act = report.acts[actIndex];
   const rules = act.rules || [];
+  // Annotate all elements on the page with unique identifiers.
+  await addTestaroIDs(page);
   const pageCode = await page.content();
   const waxOptions = {
     rules,
     apiKey: process.env.WAX_KEY || ''
   };
   try {
+    // Run WAX.
     const actReport = await waxDev.runWax(pageCode, waxOptions);
     // If WAX failed with a string report:
     if (typeof actReport === 'string') {
@@ -54,6 +58,12 @@ exports.reporter = async (page, report, actIndex) => {
       }
       // Otherwise, i.e. if it is a successful report:
       else {
+        // Add location data to its excerpts.
+        for (const violation of actReport) {
+          const {element} = violation;
+          const elementLocation = await getLocationData(page, element);
+          Object.assign(violation, elementLocation);
+        }
         // Populate the act report.
         result = {
           violations: actReport
@@ -81,7 +91,6 @@ exports.reporter = async (page, report, actIndex) => {
         data.error = 'wax failure';
       }
     }
-    // Return the results.
     try {
       JSON.stringify(data);
     }
@@ -92,6 +101,7 @@ exports.reporter = async (page, report, actIndex) => {
         error: message
       };
     }
+    // Return the results.
     return {
       data,
       result