testaro 64.9.0 → 64.9.2

package/package.json

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

package/procs/getLocatorData.js

@@ -101,3 +101,77 @@ exports.getLocatorData = async loc => {
     return null;
   }
 };
+// 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 extract contains a Testaro identifier:
+  if (testaroIDArray) {
+    const testaroID = `${testaroIDArray[1]}#${testaroIDArray[2]}`;
+    // Return location data for the element.
+    return await page.evaluate(testaroID => {
+      const element = document.querySelector(`[data-testaro-id="${testaroID}"]`);
+      // If any element has that identifier:
+      if (element) {
+        // Get a box ID for the element.
+        const box = {};
+        let boxID = '';
+        const boundingBox = element.getBoundingClientRect() || {};
+        if (boundingBox.x) {
+          ['x', 'y', 'width', 'height'].forEach(coordinate => {
+            box[coordinate] = Math.round(boundingBox[coordinate]);
+          });
+        }
+        if (typeof box.x === 'number') {
+          boxID = Object.values(box).join(':');
+        }
+        const oldPathID = testaroID.replace(/^.*?#/, '');
+        const newPathID = window.getXPath(element);
+        let pathID = '';
+        // If the XPath of the element is the same as that in the identifier:
+        if (newPathID === oldPathID) {
+          // Use it as the path ID.
+          pathID = oldPathID;
+        }
+        // Otherwise, if both paths exist but differ:
+        else if (oldPathID && newPathID) {
+          // Use both as a path ID.
+          pathID = `${newPathID} (originally: ${oldPathID})`;
+        }
+        // Otherwise, i.e. if only one of them exists:
+        else {
+          // Use the existing one as the path ID.
+          pathID = newPathID || oldPathID;
+        }
+        // Return the box and path IDs.
+        return {
+          boxID,
+          pathID
+        };
+      }
+      // 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:
+  else {
+    // Return a non-DOM location.
+    return {
+      notInDOM: true,
+      boxID: '',
+      pathID: ''
+    };
+  }
+};

package/procs/nu.js

@@ -15,7 +15,9 @@
 // ########## IMPORTS
 
 // Module to add Testaro IDs to elements.
-const {addTestaroIDs, getLocationData} = require('./testaro');
+const {addTestaroIDs} = require('./testaro');
+// Module to get location data from an element.
+const {getLocationData} = require('./getLocatorData');
 // Module to get the document source.
 const {getSource} = require('./getSource');
 

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];
   }

package/procs/testaro.js

@@ -227,54 +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}`);
     }
   });
 };
-// 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:
-  if (testaroIDArray) {
-    const testaroID = testaroIDArray[1];
-    // Return location data for the element.
-    return await page.evaluate(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.
-        const box = {};
-        let boxID = '';
-        const boundingBox = element.getBoundingClientRect() || {};
-        if (boundingBox.x) {
-          ['x', 'y', 'width', 'height'].forEach(coordinate => {
-            box[coordinate] = Math.round(boundingBox[coordinate]);
-          });
-        }
-        if (typeof box.x === 'number') {
-          boxID = Object.values(box).join(':');
-        }
-        const pathID = window.getXPath(element) || '';
-        // Return them.
-        return {
-          boxID,
-          pathID
-        };
-      }
-      // Otherwise, i.e. if no element has it, return empty location data.
-      return {};
-    }, testaroID);
-  }
-  // Otherwise, i.e. if the extract contains no Testaro identifier:
-  else {
-    // Return a non-DOM location.
-    return {
-      notInDOM: true,
-      boxID: '',
-      pathID: ''
-    };
-  }
-};

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.
@@ -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/htmlcs.js

@@ -1,5 +1,6 @@
 /*
   © 2022–2024 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool.
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -15,7 +16,9 @@
 // IMPORTS
 
 // Module to add and use unique element IDs.
-const {addTestaroIDs, getLocationData} = require('../procs/testaro');
+const {addTestaroIDs} = require('../procs/testaro');
+// Module to get location data from an element.
+const {getLocationData} = require('../procs/getLocatorData');
 // Module to handle files.
 const fs = require('fs/promises');
 

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/wax.js

@@ -16,7 +16,9 @@
 // IMPORTS
 
 // Module to add and use unique element IDs.
-const {addTestaroIDs, getLocationData} = require('../procs/testaro');
+const {addTestaroIDs} = require('../procs/testaro');
+// Module to get location data from an element.
+const {getLocationData} = require('../procs/getLocatorData');
 // Modules to run WAX.
 const runWax = require('@wally-ax/wax-dev');
 const waxDev = {runWax};