testaro 64.9.3 → 64.9.5

package/package.json

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

package/procs/getLocatorData.js

@@ -106,8 +106,8 @@ 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 await page.evaluate(testaroID => {
+    return await page.evaluate(testaroIDArray => {
+      const testaroID = `${testaroIDArray[1]}#${testaroIDArray[2]}`;
       const element = document.querySelector(`[data-testaro-id="${testaroID}"]`);
       // If any element has that identifier:
       if (element) {
@@ -123,8 +123,8 @@ exports.getLocationData = async (page, excerpt) => {
         if (typeof box.x === 'number') {
           boxID = Object.values(box).join(':');
         }
-        // Get a path ID for the element.
-        let pathID = testaroID.replace(/^.*?#/, '');
+        // Get a path ID from the Testaro identifier or, if necessary, the element.
+        let pathID = testaroIDArray[2];
         if (! pathID) {
           pathID = window.getXPath(element);
         }
@@ -149,7 +149,7 @@ exports.getLocationData = async (page, excerpt) => {
         boxID: '',
         pathID: ''
       };
-    }, testaroID);
+    }, testaroIDArray);
   }
   // Otherwise, i.e. if the extract contains no Testaro identifier:
   else {

package/procs/identify.js

@@ -54,6 +54,21 @@ const boxToString = exports.boxToString = box => {
     return '';
   }
 };
+// Normalizes an XPath.
+const getNormalizedXPath = exports.getNormalizedXPath = xPath => {
+  xPath = xPath.replace(/^\.\/\//, '/');
+  const segments = xPath.split('/');
+  const normalizedSegments = [];
+  segments.forEach(segment => {
+    if (segment === '' || ['html', 'body'].includes(segment) || segment.endsWith(']')) {
+      normalizedSegments.push(segment);
+    }
+    else {
+      normalizedSegments.push(`${segment}[1]`);
+    }
+  });
+  return normalizedSegments.join('/');
+};
 // Adds a box ID and a path ID to an object.
 const addIDs = async (locator, recipient) => {
   const locatorCount = await locator.count();
@@ -84,20 +99,7 @@ const addIDs = async (locator, recipient) => {
       }
     }
     // Normalize the path ID.
-    const xPathSegments = recipient.pathID.split('/');
-    const normalizedSegments = xPathSegments.map(segment => {
-      if (segment === '') {
-        return '';
-      }
-      if (['html', 'body'].includes(segment)) {
-        return segment;
-      }
-      if (segment.endsWith(']')) {
-        return segment;
-      }
-      return `${segment}[1]`;
-    });
-    recipient.pathID = normalizedSegments.join('/');
+    recipient.pathID = getNormalizedXPath(recipient.pathID);
   }
 };
 // Sanitizes a tag name.

package/procs/standardize.js

@@ -13,6 +13,10 @@
   Converts test results to the standard format.
 */
 
+// IMPORTS
+
+const {getNormalizedXPath} = require('./identify');
+
 // FUNCTIONS
 
 // Limits the length of and unilinearizes a string.
@@ -485,19 +489,30 @@ const convert = (toolName, data, result, standardResult) => {
                   finalRuleID = changer[changer.length - 1];
                 }
               }
-              // Get the instance properties.
-              const xpath = ruleResult.element && ruleResult.element.xpath || '';
-              let tagName = xpath
-              && xpath.replace(/^.*\//, '').replace(/[^-\w].*$/, '').toUpperCase()
+              // Initialize the path ID of the violating element as any normalized reported XPath.
+              let pathID = getNormalizedXPath(ruleResult.element && ruleResult.element.xpath) || '';
+              const {locationData} = ruleResult;
+              // If an XPath was obtained from the excerpt:
+              if (locationData && locationData.pathID) {
+                // Replace the path ID with it, because some ASLint-reported XPaths are abbreviated.
+                ({pathID} = locationData);
+              }
+              // Get and normalize the reported excerpt.
+              const excerpt = ruleResult.element
+              && ruleResult.element.html
+              && ruleResult.element.html.replace(/\s+/g, ' ')
               || '';
+              // Get the tag name from the XPath, if possible.
+              let tagName = pathID && pathID.replace(/[^-\w].*$/, '').toUpperCase() || '';
               if (! tagName && finalRuleID.endsWith('_svg')) {
                 tagName = 'SVG';
               }
-              const excerpt = ruleResult.element && ruleResult.element.html.replace(/\s+/g, ' ')
-              || '';
+              // If that was impossible but there is a tag name in the excerpt:
               if (! tagName && /^<[a-z]+[ >]/.test(excerpt)) {
+                // Get it.
                 tagName = excerpt.slice(1).replace(/[ >].+/, '').toUpperCase();
               }
+              // Get the ID, if any.
               const idDraft = excerpt && excerpt.replace(/^[^[>]+id="/, 'id=').replace(/".*$/, '');
               const idFinal = idDraft && idDraft.length > 3 && idDraft.startsWith('id=')
                 ? idDraft.slice(3)
@@ -512,9 +527,11 @@ const convert = (toolName, data, result, standardResult) => {
                 location: {
                   doc: 'dom',
                   type: 'xpath',
-                  spec: xpath
+                  spec: pathID
                 },
-                excerpt
+                excerpt,
+                boxID: '',
+                pathID
               };
               standardResult.instances.push(instance);
             }

package/run.js

@@ -412,7 +412,7 @@ const launch = exports.launch = async (
           get: () => ['en-US', 'en']
         });
       });
-      const xPathNeeders = ['testaro', 'htmlcs', 'nuVal', 'nuVnu', 'qualWeb', 'wax'];
+      const xPathNeeders = ['aslint', 'htmlcs', 'nuVal', 'nuVnu', 'qualWeb', 'testaro', 'wax'];
       const needsXPath = act.type === 'test' && xPathNeeders.includes(act.which);
       // If the launch is for a test act that requires XPaths:
       if (needsXPath) {

package/tests/aslint.js

@@ -15,13 +15,19 @@
 
 // IMPORTS
 
+// Function to add unique identifiers to the elements in the page.
+const {addTestaroIDs} = require('../procs/testaro');
 // Module to handle files.
 const fs = require('fs/promises');
+// Function to get location data from an element.
+const {getLocationData} = require('../procs/getLocatorData');
 
 // FUNCTIONS
 
 // Conducts and reports the ASLint tests.
 exports.reporter = async (page, report, actIndex, timeLimit) => {
+  // Add unique identifiers to the elements in the page.
+  await addTestaroIDs(page);
   // Initialize the act report.
   let data = {};
   let result = {};
@@ -82,13 +88,11 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
   if (! data.prevented) {
     // Get their text.
     const actReport = await reportLoc.textContent();
-    // Populate the act report.
     result = JSON.parse(actReport);
     // If any rules were reported violated:
     if (result.rules) {
       // For each such rule:
-      Object.keys(result.rules).forEach(ruleID => {
-        // If the rule was passed or skipped or rules to be tested were specified and exclude it:
+      for (const ruleID of Object.keys(result.rules)) {
         const excluded = act.rules && ! act.rules.includes(ruleID);
         const instanceType = result.rules[ruleID].status.type;
         // If rules to be tested were specified and exclude it or the rule was passed or skipped:
@@ -96,7 +100,22 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
           // Delete the rule report.
           delete result.rules[ruleID];
         }
-      });
+        // Otherwise, i.e. if the rule was violated:
+        else {
+          const ruleResults = result.rules[ruleID].results;
+          // For each violation:
+          for (const ruleResult of ruleResults) {
+            const excerpt = ruleResult.element
+            && ruleResult.element.html.replace(/\s+/g, ' ')
+            || '';
+            // If an element excerpt was reported:
+            if (excerpt) {
+              // Use it to add location data to the violation data in the result.
+              ruleResult.locationData = await getLocationData(page, excerpt);
+            }
+          };
+        }
+      };
     }
   }
   // Return the act report.

package/tests/ed11y.js

@@ -17,6 +17,8 @@
 
 // Module to handle files.
 const fs = require('fs/promises');
+// Module to normalize XPaths.
+const {getNormalizedXPath} = require('../procs/identify');
 // Module to get the XPath of an element.
 const {xPath} = require('playwright-dompath');
 
@@ -109,7 +111,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
               elText = element.outerHTML;
             }
             if (elText.length > 400) {
-              elText = `${elText.slice(0, 200)}…${elText.slice(-200)}`;
+              elText = `${elText.slice(0, 300)}…${elText.slice(-200)}`;
             }
             violationFacts.excerpt = elText.replace(/\s+/g, ' ');
             violationFacts.boxID = ['x', 'y', 'width', 'height']
@@ -165,11 +167,11 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
       const elementJSHandles = await elementsJSHandle.getProperties();
       // For each violation:
       for (const index in violations) {
-        // Get its path ID from the identically indexed element.
+        // Get its Playwright path ID from the identically indexed element.
         const elementHandle = elementJSHandles.get(index).asElement();
-        const pathID = await xPath(elementHandle);
-        // Add the path ID to the violation facts of the result.
-        violations[index].pathID = pathID;
+        const pwPathID = await xPath(elementHandle);
+        // Add the normalized path ID to the violation facts of the result.
+        violations[index].pathID = getNormalizedXPath(pwPathID);
       };
     }
     // Return the data and result, discarding the separate element data.

package/tests/wax.js

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