testaro 67.0.0 → 68.0.0

package/tests/aslint.js

@@ -1,6 +1,6 @@
 /*
   © 2023–2024 CVS Health and/or one of its affiliates. All rights reserved.
-  © 2025 Jonathan Robert Pool.
+  © 2025–2026 Jonathan Robert Pool.
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -15,16 +15,8 @@
 
 // IMPORTS
 
-// Function to add unique identifiers to the elements in the page.
-const {addTestaroIDs} = require('../procs/testaro');
-// Module to simplify strings.
-const {cap, tidy} = require('../procs/job');
-// Module to handle files.
 const fs = require('fs/promises');
-// Function to get location data with a Testaro identifier.
-const {getElementData} = require('../procs/getLocatorData');
-// Function to normalize an XPath.
-const {getNormalizedXPath} = require('../procs/identify');
+const {getNormalizedXPath, getXPathCatalogIndex} = require('../procs/xPath');
 
 // CONSTANTS
 
@@ -130,8 +122,6 @@ const aslintData = {
 
 // Conducts and reports the ASLint tests.
 exports.reporter = async (page, report, actIndex) => {
-  // Add unique Testaro identifiers to the elements in the page.
-  await addTestaroIDs(page);
   // Initialize the act report.
   let data = {};
   const result = {
@@ -232,6 +222,7 @@ exports.reporter = async (page, report, actIndex) => {
         }
         // If standard results are to be reported:
         if (standard) {
+          const {catalog} = report;
           const ruleIDs = Object.keys(rules);
           // For each violated rule:
           for (let ruleID of ruleIDs) {
@@ -240,57 +231,33 @@ exports.reporter = async (page, report, actIndex) => {
             // For each violation:
             for (const result of results) {
               const {message, element} = result;
+              // Get a description of the violated rule.
               const what = message?.actual?.description ?? '';
-              // Get the values of the properties required for a standard result.
-              if (ruleID) {
-                const changer = aslintData[ruleID]?.find(
-                  specs => specs.slice(0, -1).every(matcher => what.includes(matcher))
-                );
-                if (changer) {
-                  ruleID = changer[changer.length - 1];
-                }
+              const changer = aslintData[ruleID]?.find(
+                specs => specs.slice(0, -1).every(matcher => what.includes(matcher))
+              );
+              // If the rule ID is differentiatable:
+              if (changer) {
+                // Differentiate it.
+                ruleID = changer[changer.length - 1];
               }
+              // Get the ordinal severity of the violation.
               const ordinalSeverity = issueType === 'warning' ? 1 : 2;
-              const {html, xpath} = element;
-              const excerpt = html?.replace(/\s+/g, ' ') ?? '';
-              let tagName = '';
-              let id = '';
-              let text = [];
-              let notInDOM = false;
-              let boxID = '';
-              let pathID = '';
-              if (excerpt) {
-                const elementData = await getElementData(page, excerpt);
-                ({tagName, id, text, notInDOM, boxID, pathID, originalExcerpt} = elementData);
-              }
-              if (! pathID) {
-                pathID = getNormalizedXPath(xpath);
-              }
-              if (pathID && ! tagName) {
-                tagName = pathID?.replace(/[^-\w].*$/, '').toUpperCase() ?? '';
-              }
-              if (ruleID.endsWith('_svg') && ! tagName) {
-                tagName = 'SVG';
-              }
+              // Get the pathID of the element.
+              const {xpath} = element;
+              const pathID = getNormalizedXPath(xpath);
+              // Use it to get the index of the element in the catalog.
+              const catalogIndex = getXPathCatalogIndex(catalog, pathID);
               // Add an instance to the standard result.
               standardResult.instances.push({
                 ruleID,
                 what,
                 ordinalSeverity,
                 count: 1,
-                tagName,
-                id,
-                location: {
-                  notInDOM,
-                  doc: 'dom',
-                  type: 'xpath',
-                  spec: pathID
-                },
-                excerpt: cap(tidy(originalExcerpt)),
-                text,
-                boxID,
-                pathID
+                catalogIndex
               });
+              // Increment the standard total.
+              standardResult.totals[ordinalSeverity]++;
             }
           }
         }

package/tests/axe.js

@@ -1,6 +1,6 @@
 /*
   © 2021–2024 CVS Health and/or one of its affiliates. All rights reserved.
-  © 2025 Jonathan Robert Pool.
+  © 2025–2026 Jonathan Robert Pool.
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -17,11 +17,11 @@
   The detailLevel argument specifies how many result categories are to be included in the
   details. 0 = none; 1 = violations; 2 = violations and incomplete; 3 = violations, incomplete,
   and passes; 4 = violations, incomplete, passes, and inapplicable. Regardless of the value of this
-  argument, Axe-core is instructed to report all nodes with violation or incomplete results, but only
-  1 node per rule found to be passed or inapplicable. Therefore, from the results of this test it
-  is possible to count the rules passed and the inapplicable rules, but not the nodes for which each
-  rule is passed or inapplicable. To count those nodes, one would need to revise the 'resultTypes'
-  property of the 'axeOptions' object.
+  argument, Axe-core is instructed to report all nodes with violation or incomplete results, but
+  only 1 node per rule found to be passed or inapplicable. Therefore, from the results of this test
+  it is possible to count the rules passed and the inapplicable rules, but not the nodes for which
+  each rule is passed or inapplicable. To count those nodes, one would need to revise the
+  'resultTypes' property of the 'axeOptions' object.
 
   The report of this test shows rule totals by result category and, within the violation and
   incomplete categories, node totals by severity. It does not show rule or node totals by test
@@ -32,17 +32,41 @@
 // IMPORTS
 
 const axePlaywright = require('axe-playwright');
+const {getAttributeXPath, getXPathCatalogIndex} = require('../procs/xPath');
+
+// CONSTANTS
+
 const {injectAxe} = axePlaywright;
+const severityWeights = {
+  minor: 0,
+  moderate: 0,
+  serious: 1,
+  critical: 1
+};
 
 // FUNCTIONS
 
 // Conducts and reports the Axe tests.
-exports.reporter = async (page, report, actIndex, timeLimit) => {
+exports.reporter = async (page, report, actIndex) => {
   const act = report.acts[actIndex];
   const {detailLevel, rules} = act;
   // Initialize the act report.
   let data = {};
-  let result = {};
+  const result = {
+    nativeResult: {},
+    standardResult: {}
+  };
+  const standard = report.standard !== 'no';
+  // If standard results are to be reported:
+  if (standard) {
+    // Initialize the standard result.
+    result.standardResult = {
+      prevented: false,
+      totals: [0, 0, 0, 0],
+      instances: []
+    };
+  }
+  const {nativeResult, standardResult} = result;
   // Inject axe-core into the page.
   await injectAxe(page)
   .catch(error => {
@@ -66,8 +90,8 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
     const {inapplicable, passes, incomplete, violations} = axeReport;
     // If the test succeeded:
     if (violations) {
-      // Initialize the result.
-      result.totals = {
+      // Initialize the native result.
+      nativeResult.totals = {
         rulesNA: 0,
         rulesPassed: 0,
         rulesWarned: 0,
@@ -85,9 +109,9 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
           critical: 0
         }
       };
-      result.details = axeReport;
-      // Populate the totals.
-      const {totals} = result;
+      nativeResult.details = axeReport;
+      // Populate the native-result totals.
+      const {totals} = nativeResult;
       totals.rulesNA = inapplicable.length;
       totals.rulesPassed = passes.length;
       incomplete.forEach(rule => {
@@ -108,12 +132,51 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
       irrelevants.forEach(irrelevant => {
         delete axeReport[irrelevant];
       });
+      // If standard results are to be reported and there are any suspicions:
+      if (standard && (totals.rulesViolated || totals.rulesWarned)) {
+        // For each certainty type:
+        ['incomplete', 'violations'].forEach(certainty => {
+          // If there are any suspicions of this type:
+          if (nativeResult?.details?.[certainty]) {
+            // For each rule with any suspicions:
+            nativeResult.details[certainty].forEach(rule => {
+              // For each element suspected of violating the rule:
+              rule.nodes.forEach(node => {
+                // Get descriptions of the rule.
+                const whatSet = new Set([
+                  rule.help,
+                  ... node.any.map(anyItem => anyItem.message),
+                  ... node.all.map(allItem => allItem.message)
+                ]);
+                // Get the ordinal severity of the suspicion.
+                const ordinalSeverity = severityWeights[node.impact]
+                + (certainty === 'violations' ? 2 : 0);
+                // Get the XPath of the suspected element from its data-xpath attribute.
+                const xPath = getAttributeXPath(node.html);
+                // Get the catalog index of the suspected element from its XPath.
+                const catalogIndex = getXPathCatalogIndex(report.catalog, xPath) ?? '';
+                const instance = {
+                  ruleID: rule.id,
+                  what: Array.from(whatSet.values()).join('; '),
+                  ordinalSeverity,
+                  count: 1,
+                  catalogIndex
+                };
+                standardResult.instances.push(instance);
+              });
+            });
+          }
+        });
+      }
     }
     // Otherwise, i.e. if the test failed:
     else {
       // Report this.
       data.prevented = true;
       data.error = 'ERROR: Act failed';
+      if (standard) {
+        standardResult.prevented = true;
+      }
     }
   }
   // Return the result.

package/tests/ed11y.js

@@ -1,6 +1,6 @@
 /*
   © 2023–2024 CVS Health and/or one of its affiliates. All rights reserved.
-  © 2025 Jonathan Robert Pool.
+  © 2025–2026 Jonathan Robert Pool.
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -15,115 +15,59 @@
 
 // IMPORTS
 
-// 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');
+const {getXPathCatalogIndex} = require('../procs/xPath');
 
 // FUNCTIONS
 
 // Performs and reports the Editoria11y tests.
-exports.reporter = async (page, report, actIndex, timeLimit) => {
+exports.reporter = async (page, report, actIndex) => {
   // Get the nonce, if any.
   const act = report.acts[actIndex];
   const {jobData} = report;
   const scriptNonce = jobData && jobData.lastScriptNonce;
+  // Initialize the act report.
+  let data = {};
+  const result = {
+    nativeResult: {},
+    standardResult: {}
+  };
+  const standard = report.standard !== 'no';
+  // If standard results are to be reported:
+  if (standard) {
+    // Initialize the standard result.
+    result.standardResult = {
+      prevented: false,
+      totals: [0, 0, 0, 0],
+      instances: []
+    };
+  }
   // Get the tool script.
   const script = await fs.readFile(`${__dirname}/../ed11y/editoria11y.min.js`, 'utf8');
-  // Perform the tests and get the violating elements and violation facts.
-  const reportJSHandle = await page.evaluateHandle(args => new Promise(async resolve => {
-    const {scriptNonce, script, rulesToTest, timeLimit} = args;
-    // If the report is incomplete after the time limit:
-    const timer = setTimeout(() => {
-      // Return this as the report.
-      resolve({
-        result: {
-          prevented: true,
-          error: `ed11y timed out at ${timeLimit} seconds`
-        }
-      });
-    }, 1000 * timeLimit);
+  // Perform the specified tests and populate the native result.
+  result.nativeResult = await page.evaluate(args => new Promise(async resolve => {
+    const {scriptNonce, script, rulesToTest} = args;
     // When the script has been executed, creating data in an Ed11y object:
-    document.addEventListener('ed11yResults', () => {
-      // Initialize a report containing violating elements and violation facts.
-      const report = {
-        elements: [],
-        facts:  {}
-      };
-      const {elements, facts} = report;
-      // Populate the global facts.
-      [
-        'version',
-        'options',
-        'mediaCount',
-        'errorCount',
-        'warningCount',
-        'dismissedCount',
-        'totalCount'
-      ]
-      .forEach(key => {
-        try {
-          facts[key] = Ed11y[key];
-        }
-        catch(error) {
-          console.log(`ERROR: invalid value of ${key} property of Ed11y (${error.message})`);
-        }
-      });
-      // Get data on violating text alternatives of images from Ed11y.
-      facts.imageAlts = Ed11y
-      .imageAlts
-      .filter(item => item[3] !== 'pass')
-      .map(item => item.slice(1));
-      // Delete useless facts.
-      delete facts.options.sleekTheme;
-      delete facts.options.darkTheme;
-      delete facts.options.lightTheme;
-      // Initialize the violation facts.
-      facts.violations = [];
-      // For each rule violation by an element:
-      Ed11y.results.forEach(violation => {
-        // If rules were not selected or they were and include the violated rule:
-        if (! rulesToTest || rulesToTest.includes(violation.test)) {
-          const violationFacts = {};
-          violationFacts.test = violation.test || '';
-          // If the element is in the page:
-          if (violation.content) {
-            violationFacts.content = violation.content.replace(/\s+/g, ' ');
-          }
-          const {element} = violation;
-          if (element.outerHTML) {
-            // Add the element to the report.
-            elements.push(element);
-            // Add its violation facts to the report.
-            violationFacts.tagName = element.tagName || '';
-            violationFacts.id = element.id || '';
-            violationFacts.loc = {};
-            const locRect = element.getBoundingClientRect();
-            if (locRect) {
-              ['x', 'y', 'width', 'height'].forEach(dim => {
-                violationFacts.loc[dim] = Math.round(locRect[dim], 0);
-              });
-            }
-            let elText = element.textContent.replace(/\s+/g, ' ').trim();
-            if (! elText) {
-              elText = element.outerHTML;
-            }
-            if (elText.length > 400) {
-              elText = `${elText.slice(0, 300)}…${elText.slice(-200)}`;
-            }
-            violationFacts.excerpt = elText.replace(/\s+/g, ' ');
-            violationFacts.boxID = ['x', 'y', 'width', 'height']
-            .map(dim => violationFacts.loc[dim])
-            .join(':');
-            facts.violations.push(violationFacts);
-          }
-        }
+    document.addEventListener('ed11yResults', async () => {
+      let {results} = Ed11y;
+      // If rules were selected:
+      if (rulesToTest) {
+        // Remove results of other rules.
+        results = results.filter(result => rulesToTest.includes(result.test));
+      }
+      // Return the native result.
+      resolve({
+        resultCount: results.length,
+        errorCount: Ed11y.errorCount,
+        warningCount: Ed11y.warningCount,
+        results: results.map(result => ({
+          test: result.test,
+          content: result.content.replace(/\s+/g, ' ').trim(),
+          dismissalKey: result.dismissalKey,
+          html: result.element.outerHTML.slice(0, 500),
+          xPath: window.getXPath(result.element)
+        }))
       });
-      // Return the report.
-      clearTimeout(timer);
-      resolve(report);
     });
     // Add the tool script to the page.
     const toolScript = document.createElement('script');
@@ -141,55 +85,39 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
     }
     catch(error) {
       resolve({
-        result: {
-          prevented: true,
-          error: error.message
-        }
+        prevented: true,
+        error: error.message
       });
     };
   }), {
     scriptNonce,
     script,
-    rulesToTest: act.rules,
-    timeLimit
+    rulesToTest: act.rules
   });
-  // Initialize the result as the violation facts.
-  const resultJSHandle = await reportJSHandle.getProperty('facts');
-  const result = await resultJSHandle.jsonValue();
-  // If there were any violation facts:
-  if (result) {
-    // Get the violations from them.
-    const {violations} = result;
-    // If any exist:
-    if (violations && violations.length) {
-      // Get the violating elements.
-      const elementsJSHandle = await reportJSHandle.getProperty('elements');
-      const elementJSHandles = await elementsJSHandle.getProperties();
-      // For each violation:
-      for (const index in violations) {
-        // Get its Playwright path ID from the identically indexed element.
-        const elementHandle = elementJSHandles.get(index).asElement();
-        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.
-    const data = {};
-    if (result.prevented) {
-      data.prevented = true;
-    }
-    return {
-      data,
-      result
-    };
-  }
-  // Otherwise, i.e. if there were no violation facts:
-  else {
-    // Return this.
-    return {
-      data: {},
-      result: {}
-    }
+  // If a standard result is to be reported:
+  if (standard) {
+    const {standardResult} = result;
+    const {warningCount, errorCount, results} = result.nativeResult;
+    // Populate the standard-result totals.
+    standardResult.totals = [warningCount, 0, errorCount, 0];
+    // For each native-result instance:
+    results.forEach(nativeInstance => {
+      // Create a standard-result instance.
+      const {test, content, dismissalKey, xPath} = nativeInstance;
+      const instance = {};
+      instance.ruleID = test;
+      instance.what = content;
+      instance.ordinalSeverity = dismissalKey ? 0 : 2;
+      instance.count = 1;
+      instance.catalogIndex = getXPathCatalogIndex(report.catalog, xPath);
+      if (! instance.catalogIndex) {
+        instance.pathID = xPath;
+      }
+      standardResult.instances.push(instance);
+    });
   }
+  return {
+    data,
+    result
+  };
 };