testaro 64.9.1 → 64.9.3

package/package.json

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

package/procs/getLocatorData.js

@@ -103,16 +103,15 @@ exports.getLocatorData = async loc => {
 };
 // Returns location data from the extract of a standard instance.
 exports.getLocationData = async (page, excerpt) => {
-  const testaroIDArray = excerpt.match(/data-testaro-id="(\d+)#"/);
-  // If the excerpt contains a Testaro identifier:
+  const testaroIDArray = excerpt.match(/data-testaro-id="(\d+)#([^"]*)"/);
+  // If the extract contains a Testaro identifier:
   if (testaroIDArray) {
-    const testaroID = testaroIDArray[1];
-    // Return location data for the element.
+    const testaroID = `${testaroIDArray[1]}#${testaroIDArray[2]}`;
     return await page.evaluate(testaroID => {
-      const element = document.querySelector(`[data-testaro-id="${testaroID}#"]`);
+      const element = document.querySelector(`[data-testaro-id="${testaroID}"]`);
       // If any element has that identifier:
       if (element) {
-        // Get box and path IDs for the element.
+        // Get a box ID for the element.
         const box = {};
         let boxID = '';
         const boundingBox = element.getBoundingClientRect() || {};
@@ -124,15 +123,32 @@ exports.getLocationData = async (page, excerpt) => {
         if (typeof box.x === 'number') {
           boxID = Object.values(box).join(':');
         }
-        const pathID = window.getXPath(element) || '';
-        // Return them.
+        // Get a path ID for the element.
+        let pathID = testaroID.replace(/^.*?#/, '');
+        if (! pathID) {
+          pathID = window.getXPath(element);
+        }
+        // Return the box and path IDs.
         return {
           boxID,
           pathID
         };
       }
-      // Otherwise, i.e. if no element has it, return empty location data.
-      return {};
+      // Otherwise, if no element has it but the identifier includes an XPath:
+      else if (testaroIDArray[2]) {
+        // Return an empty box ID and that XPath as a path ID.
+        return {
+          notInDOM: true,
+          boxID: '',
+          pathID: testaroIDArray[2]
+        };
+      }
+      // Otherwise, return empty location properties.
+      return {
+        notInDOM: true,
+        boxID: '',
+        pathID: ''
+      };
     }, testaroID);
   }
   // Otherwise, i.e. if the extract contains no Testaro identifier:

package/procs/standardize.js

@@ -42,8 +42,8 @@ const getIdentifiers = code => {
     const tagNameArray = startTagData[1].match(/^[A-Za-z0-9]+/);
     const tagName = tagNameArray ? tagNameArray[0].toUpperCase() : '';
     // Get the value of the id attribute, if any.
-    const idData = startTagData[1].match(/ id="([^"]+)"/);
-    const id = idData ? idData[1] : '';
+    const identifierData = startTagData[1].match(/ id="([^"]+)"/);
+    const id = identifierData ? identifierData[1] : '';
     // Return the tag name and the value of the id attribute, if any.
     return [tagName, id];
   }
@@ -175,7 +175,9 @@ const doAxe = (result, standardResult, certainty) => {
             type: 'selector',
             spec: node.target && node.target.length ? node.target[0] : ''
           },
-          excerpt: cap(node.html)
+          excerpt: cap(node.html),
+          boxID: '',
+          pathID: ''
         };
         standardResult.instances.push(instance);
       });
@@ -311,7 +313,9 @@ const doQualWeb = (result, standardResult, ruleClassName) => {
               type: 'selector',
               spec: element.pointer
             },
-            excerpt: cap(htmlCode)
+            excerpt: cap(htmlCode),
+            boxID: element.locationData?.boxID || '',
+            pathID: element.locationData?.pathID || ''
           };
           standardResult.instances.push(instance);
         });
@@ -365,7 +369,9 @@ const doWAVE = (result, standardResult, categoryName) => {
               type: 'selector',
               spec: violationFacts[0] || 'html'
             },
-            excerpt: violationFacts[1]
+            excerpt: violationFacts[1],
+            boxID: '',
+            pathID: ''
           };
           // Add it to the standard result.
           standardResult.instances.push(instance);
@@ -406,7 +412,9 @@ const convert = (toolName, data, result, standardResult) => {
             type: 'xpath',
             spec: target.path
           },
-          excerpt: cap(code)
+          excerpt: cap(code),
+          boxID: '',
+          pathID: ''
         };
         standardResult.instances.push(instance);
       }
@@ -438,7 +446,9 @@ const convert = (toolName, data, result, standardResult) => {
               type: 'xpath',
               spec: target.path
             },
-            excerpt: cap(code)
+            excerpt: cap(code),
+            boxID: '',
+            pathID: ''
           };
         }
         standardResult.instances.push(instance);
@@ -588,7 +598,9 @@ const convert = (toolName, data, result, standardResult) => {
             type: 'xpath',
             spec: item.path.dom
           },
-          excerpt: cap(item.snippet)
+          excerpt: cap(item.snippet),
+          boxID: '',
+          pathID: ''
         };
         standardResult.instances.push(instance);
       });
@@ -653,7 +665,9 @@ const convert = (toolName, data, result, standardResult) => {
         tagName: '',
         id: '',
         location: '',
-        excerpt: ''
+        excerpt: '',
+        boxID: '',
+        pathID: ''
       });
     }
   }

package/procs/testaro.js

@@ -227,10 +227,13 @@ exports.getVisibleCountChange = async (
 };
 // Annotates every element on a page with a unique identifier.
 exports.addTestaroIDs = async page => {
+  // Wait for the page to be fully loaded.
+  await page.waitForLoadState('networkidle');
   await page.evaluate(() => {
     let serialID = 0;
     for (const element of Array.from(document.querySelectorAll('*'))) {
-      element.setAttribute('data-testaro-id', `${serialID++}#`);
+      const xPath = window.getXPath(element);
+      element.setAttribute('data-testaro-id', `${serialID++}#${xPath}`);
     }
   });
 };

package/run.js

@@ -374,7 +374,6 @@ const launch = exports.launch = async (
         // If the page emits a message:
         page.on('console', msg => {
           const msgText = msg.text();
-          let indentedMsg = '';
           // If debugging is on:
           if (debug) {
             // Log the start of the message on the console.
@@ -413,8 +412,8 @@ const launch = exports.launch = async (
           get: () => ['en-US', 'en']
         });
       });
-      const needsXPath = act.type === 'test'
-      && ['testaro', 'htmlcs', 'nuVal', 'nuVnu', 'wax'].includes(act.which);
+      const xPathNeeders = ['testaro', 'htmlcs', 'nuVal', 'nuVnu', 'qualWeb', 'wax'];
+      const needsXPath = act.type === 'test' && xPathNeeders.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.
@@ -437,7 +436,7 @@ const launch = exports.launch = async (
               // Otherwise, get its parent node.
               const parent = element.parentNode;
               // If (abnormally) the parent node is not an element:
-              if (!parent || parent.nodeType !== Node.ELEMENT_NODE) {
+              if (! parent || parent.nodeType !== Node.ELEMENT_NODE) {
                 // Prepend the element (not the parent) to the segment array.
                 segments.unshift(tag);
                 // Stop traversing, leaving the segment array partial.
@@ -917,7 +916,7 @@ const doActs = async (report, opts = {}) => {
           child.on('close', code => {
             if (! closed) {
               closed = true;
-              resolve(code);
+              resolve(`Page closed with code ${code}`);
             }
           });
         });
@@ -1648,16 +1647,19 @@ const doActs = async (report, opts = {}) => {
           standardize(act);
           // For each of its standard instances:
           for (const instance of act.standardResult.instances) {
-            const elementID = await identify(instance, page);
-            // If a box ID is missing:
-            if (! instance.boxID) {
-              // Add one.
-              instance.boxID = elementID ? elementID.boxID : '';
-            }
-            // If a path ID is missing or different:
-            if (instance.pathID !== elementID.pathID) {
-              // Add a box ID and a path ID to each of its standard instances if missing.
-              instance.pathID = elementID.pathID;
+            // If the instance does not have both a box ID and a path ID:
+            if (! (instance.boxID && instance.pathID)) {
+              const elementID = await identify(instance, page);
+              // If it has no box ID but the element has a bounding box:
+              if (elementID.boxID && ! instance.boxID) {
+                // Add a box ID.
+                instance.boxID = elementID.boxID;
+              }
+              // If it has no path ID but the element has one:
+              if (elementID.pathID && ! instance.pathID) {
+                // Add a path ID.
+                instance.pathID = elementID.pathID;
+              }
             }
           };
           // If the original-format result is not to be included in the report:
@@ -1677,9 +1679,12 @@ const doActs = async (report, opts = {}) => {
     console.log('Standardization completed');
     const {acts} = report;
     const idData = {};
+    // For each act:
     for (const act of acts) {
+      // If it is a test act:
       if (act.type === 'test') {
         const {which} = act;
+        // Initialize an idData property for the tool if necessary.
         idData[which] ??= {
           instanceCount: 0,
           boxIDCount: 0,
@@ -1690,18 +1695,26 @@ const doActs = async (report, opts = {}) => {
         const actIDData = idData[which];
         const {standardResult} = act;
         const {instances} = standardResult;
+        // For each standard instance in the act:
         for (const instance of instances) {
           const {boxID, pathID} = instance;
+          // Increment the instance count.
           actIDData.instanceCount++;
+          // If the instance has a box ID:
           if (boxID) {
+            // Increment the box ID count.
             actIDData.boxIDCount++;
           }
+          // If the instance has a path ID:
           if (pathID) {
+            // Increment the path ID count.
             actIDData.pathIDCount++;
           }
         }
         const {instanceCount, boxIDCount, pathIDCount} = actIDData;
+        // If there are any instances:
         if (instanceCount) {
+          // Add the box ID and path ID percentages to the iData property.
           actIDData.boxIDPercent = Math.round(100 * boxIDCount / instanceCount);
           actIDData.pathIDPercent = Math.round(100 * pathIDCount / instanceCount);
         }

package/tests/nuVnu.js

@@ -33,7 +33,7 @@ const tmpDir = os.tmpdir();
 
 // Conducts and reports the Nu Html Checker tests.
 exports.reporter = async (page, report, actIndex) => {
-  // Get the vuVal act, if it exists.
+  // Get the nuVal act, if it exists.
   const nuValAct = report.acts.find(act => act.type === 'test' && act.which === 'nuVal');
   // If it does not exist or it exists but was prevented:
   if (! nuValAct || nuValAct.data?.prevented) {
@@ -70,6 +70,10 @@ exports.reporter = async (page, report, actIndex) => {
       await fs.unlink(pagePath);
       // Postprocess the result.
       result = await curate(page, data, nuData, rules);
+      return {
+        data,
+        result
+      };
     }
     // Otherwise, i.e. if the content was not obtained:
     else {
@@ -77,10 +81,6 @@ exports.reporter = async (page, report, actIndex) => {
       data.prevented = true;
       data.error = 'Content not obtained';
     }
-    return {
-      data,
-      result
-    };
   }
   // Otherwise, i.e. if the nuVal act exists and succeeded:
   else {

package/tests/qualWeb.js

@@ -19,6 +19,8 @@ const {QualWeb} = require('@qualweb/core');
 const {ACTRules} = require('@qualweb/act-rules');
 const {WCAGTechniques} = require('@qualweb/wcag-techniques');
 const {BestPractices} = require('@qualweb/best-practices');
+const {addTestaroIDs} = require('../procs/testaro');
+const {getLocationData} = require('../procs/getLocatorData');
 
 // CONSTANTS
 
@@ -43,6 +45,8 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
     timeout: timeLimit * 1000,
     monitor: false
   };
+  // Annotate all elements on the page with unique identifiers.
+  await addTestaroIDs(page);
   try {
     // Start the QualWeb core engine.
     await qualWeb.start(clusterOptions, {
@@ -177,7 +181,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
               if (assertions) {
                 const ruleIDs = Object.keys(assertions);
                 // For each rule:
-                ruleIDs.forEach(ruleID => {
+                for (const ruleID of ruleIDs) {
                   const ruleAssertions = assertions[ruleID];
                   const {metadata} = ruleAssertions;
                   // If result data exist for the rule:
@@ -190,6 +194,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
                     // Otherwise, i.e. if there was at least 1 warning or failure:
                     else {
                       if (ruleAssertions.results) {
+                        // Delete nonviolations from the results.
                         ruleAssertions.results = ruleAssertions.results.filter(
                           raResult => raResult.verdict !== 'passed'
                         );
@@ -198,17 +203,23 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
                   }
                   // Shorten long HTML codes of elements.
                   const {results} = ruleAssertions;
-                  results.forEach(raResult => {
+                  // For each test result:
+                  for (const raResult of results) {
                     const {elements} = raResult;
+                    // If any violations are reported:
                     if (elements && elements.length) {
-                      elements.forEach(element => {
+                      // For each violating element:
+                      for (const element of elements) {
+                        // Add location data from its excerpt to the element data.
+                        element.locationData = await getLocationData(page, element.htmlCode);
+                        // Limit the size of its reported excerpt.
                         if (element.htmlCode && element.htmlCode.length > 700) {
                           element.htmlCode = `${element.htmlCode.slice(0, 700)} …`;
                         }
-                      });
+                      };
                     }
-                  });
-                });
+                  };
+                };
               }
               else {
                 data.prevented = true;

package/tests/wax.js

@@ -60,7 +60,7 @@ exports.reporter = async (page, report, actIndex) => {
       }
       // Otherwise, i.e. if it is a successful report:
       else {
-        // Add location data to its excerpts.
+        // Add location data to its reported violations.
         for (const violation of actReport) {
           const {element} = violation;
           const elementLocation = await getLocationData(page, element);