testaro 67.0.0 → 67.1.0

package/package.json

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

package/procs/getElementData.js

@@ -0,0 +1,117 @@
+/*
+  © 2023–2024 CVS Health and/or one of its affiliates. All rights reserved.
+
+  Licensed under the MIT License. See LICENSE file at the project root or
+  https://opensource.org/license/mit/ for details.
+
+  SPDX-License-Identifier: MIT
+*/
+
+// Returns properties of an element with an excerpt when Testaro identifiers have been added.
+exports.getElementData = async (page, excerpt) => {
+  // Initialize the properties.
+  let data = {
+    tagName: '',
+    id: '',
+    text: '',
+    notInDOM: true,
+    boxID: '',
+    pathID: '',
+    originalExcerpt: excerpt,
+  };
+  let elementProperties = {};
+  const testaroIDArray = excerpt.match(/data-testaro-id="(\d+)#([^"]*)"/);
+  // If the excerpt contains a Testaro identifier:
+  if (testaroIDArray) {
+    // Remove the identifier.
+    originalExcerpt = excerpt.replace(/ data-testaro-id="\d+#[^" ]+"?/, '');
+    elementProperties = await page.evaluate(testaroIDArray => {
+      let tagName = '';
+      let id = '';
+      const text = [];
+      let notInDOM = false;
+      let boxID = '';
+      let pathID = '';
+      const testaroID = `${testaroIDArray[1]}#${testaroIDArray[2]}`;
+      const element = document.querySelector(`[data-testaro-id="${testaroID}"]`);
+      // If any element has the identifier:
+      if (element) {
+        // Get properties of the element.
+        ({tagName, id} = element);
+        const segments = element
+          .innerText
+          ?.trim()
+          .split(/[\t\n]+/)
+          .filter(segment => segment.length);
+        if (segments?.length) {
+          if (segments.length > 1) {
+            text.push(segments[0], segments[segments.length - 1]);
+          }
+          else {
+            text.push(segments[0]);
+          }
+        }
+        const boundingBox = element.getBoundingClientRect() ?? {};
+        const box = {};
+        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(':');
+        }
+        // Get a path ID from the identifier or, if necessary, the element.
+        pathID = testaroIDArray[2];
+        if (! pathID) {
+          pathID = window.getXPath(element);
+        }
+      }
+      // Otherwise, i.e. if no element has the identifier:
+      else {
+        // Report this.
+        notInDOM = true;
+      }
+      // Report the properties.
+      return {
+        tagName,
+        id,
+        text,
+        notInDOM,
+        boxID,
+        pathID
+      };
+    }, testaroIDArray);
+    // Populate the data with any properties obtained from the element.
+    Object.assign(data, elementProperties);
+  }
+  // Otherwise, i.e. if the excerpt contains no Testaro identifier:
+  else {
+    // Get properties of the element that are gettable from the excerpt.
+    const tagNameArray = excerpt.match(/<([-a-z]+)/);
+    data.tagName = tagNameArray?.[1] ?? '';
+    const idArray = excerpt.match(/ id="([^"]*)"/);
+    data.id = idArray?.[1] ?? '';
+  }
+  // Return the properties.
+  return data;
+};
+// Returns a tag name and the value of an id attribute from a substring of HTML code.
+exports.getIdentifiers = exports.getIdentifiers = code => {
+  // Normalize the code.
+  code = code.replace(/\s+/g, ' ').replace(/\\"/g, '"');
+  // Get the first start tag of an element, if any.
+  const startTagData = code.match(/^.*?<([a-zA-][^>]*)/);
+  // If there is any:
+  if (startTagData) {
+    // Get the tag name.
+    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 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];
+  }
+  return ['', ''];
+};

package/procs/getLocatorData.js

@@ -101,92 +101,3 @@ exports.getLocatorData = async loc => {
     return null;
   }
 };
-// Returns properties of an element with an excerpt when Testaro identifiers have been added.
-exports.getElementData = async (page, excerpt) => {
-  // Initialize the properties.
-  let data = {
-    tagName: '',
-    id: '',
-    text: '',
-    notInDOM: true,
-    boxID: '',
-    pathID: '',
-    originalExcerpt: excerpt,
-  };
-  let elementProperties = {};
-  const testaroIDArray = excerpt.match(/data-testaro-id="(\d+)#([^"]*)"/);
-  // If the excerpt contains a Testaro identifier:
-  if (testaroIDArray) {
-    // Remove the identifier.
-    originalExcerpt = excerpt.replace(/ data-testaro-id="\d+#[^" ]+"?/, '');
-    elementProperties = await page.evaluate(testaroIDArray => {
-      let tagName = '';
-      let id = '';
-      const text = [];
-      let notInDOM = false;
-      let boxID = '';
-      let pathID = '';
-      const testaroID = `${testaroIDArray[1]}#${testaroIDArray[2]}`;
-      const element = document.querySelector(`[data-testaro-id="${testaroID}"]`);
-      // If any element has the identifier:
-      if (element) {
-        // Get properties of the element.
-        ({tagName, id} = element);
-        const segments = element
-          .innerText
-          ?.trim()
-          .split(/[\t\n]+/)
-          .filter(segment => segment.length);
-        if (segments?.length) {
-          if (segments.length > 1) {
-            text.push(segments[0], segments[segments.length - 1]);
-          }
-          else {
-            text.push(segments[0]);
-          }
-        }
-        const boundingBox = element.getBoundingClientRect() ?? {};
-        const box = {};
-        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(':');
-        }
-        // Get a path ID from the identifier or, if necessary, the element.
-        pathID = testaroIDArray[2];
-        if (! pathID) {
-          pathID = window.getXPath(element);
-        }
-      }
-      // Otherwise, i.e. if no element has the identifier:
-      else {
-        // Report this.
-        notInDOM = true;
-      }
-      // Report the properties.
-      return {
-        tagName,
-        id,
-        text,
-        notInDOM,
-        boxID,
-        pathID
-      };
-    }, testaroIDArray);
-    // Populate the data with any properties obtained from the element.
-    Object.assign(data, elementProperties);
-  }
-  // Otherwise, i.e. if the excerpt contains no Testaro identifier:
-  else {
-    // Get properties of the element that are gettable from the excerpt.
-    const tagNameArray = excerpt.match(/<([-a-z]+)/);
-    data.tagName = tagNameArray?.[1] ?? '';
-    const idArray = excerpt.match(/ id="([^"]*)"/);
-    data.id = idArray?.[1] ?? '';
-  }
-  // Return the properties.
-  return data;
-};

package/procs/nu.js

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

package/procs/standardize.js

@@ -40,44 +40,6 @@ const getIdentifiers = exports.getIdentifiers = code => {
   }
   return ['', ''];
 };
-// Converts issue instances at an axe certainty level.
-const doAxe = (result, standardResult, certainty) => {
-  if (result.details && result.details[certainty]) {
-    result.details[certainty].forEach(rule => {
-      rule.nodes.forEach(node => {
-        const whatSet = new Set([
-          rule.help,
-          ... node.any.map(anyItem => anyItem.message),
-          ... node.all.map(allItem => allItem.message)
-        ]);
-        const severityWeights = {
-          minor: 0,
-          moderate: 0,
-          serious: 1,
-          critical: 1
-        };
-        const ordinalSeverity = severityWeights[node.impact] + (certainty === 'violations' ? 2 : 0);
-        const identifiers = getIdentifiers(node.html);
-        const instance = {
-          ruleID: rule.id,
-          what: Array.from(whatSet.values()).join('; '),
-          ordinalSeverity,
-          tagName: identifiers[0],
-          id: identifiers[1],
-          location: {
-            doc: 'dom',
-            type: 'selector',
-            spec: node.target && node.target.length ? node.target[0] : ''
-          },
-          excerpt: cap(node.html),
-          boxID: '',
-          pathID: ''
-        };
-        standardResult.instances.push(instance);
-      });
-    });
-  }
-};
 // Converts issue instances at an htmlcs severity level.
 const doHTMLCS = (result, standardResult, severity) => {
   if (result[severity]) {
@@ -282,23 +244,13 @@ const convert = (toolName, data, result, standardResult) => {
     standardResult.prevented = true;
   }
   // alfa, aslint
-  else if (['alfa', 'aslint'].includes(toolName) && result.standardResult) {
+  else if (['alfa', 'aslint', 'axe'].includes(toolName) && result.standardResult) {
     // Move the results to standard locations.
     Object.assign(result, result.nativeResult);
     Object.assign(standardResult, result.standardResult);
     delete result.nativeResult;
     delete result.standardResult;
   }
-  // axe
-  else if (
-    toolName === 'axe'
-    && result
-    && result.totals
-    && (result.totals.rulesWarned || result.totals.rulesViolated)
-  ) {
-    doAxe(result, standardResult, 'incomplete');
-    doAxe(result, standardResult, 'violations');
-  }
   // ed11y
   else if (
     toolName === 'ed11y'

package/run.js

@@ -1794,11 +1794,11 @@ const doActs = async (report, opts = {}) => {
                 excerpt && ! ['<', '>', '=', '#'].some(markupChar => excerpt.includes(markupChar))
               ) {
                 // Add the excerpt (up to any ellipsis) to the text property.
-                instance.text = excerpt.split(/ … | *\.\.\./)[0];
+                instance.text = [excerpt.split(/ … | *\.\.\./)[0]];
               }
               // Otherwise, i.e. if it has no markup-free excerpt but has a non-empty path ID:
               else if (pathID) {
-                // Initialize a text string.
+                // Initialize a text property.
                 let text = '';
                 // Get the element if it has text content.
                 const elementLoc = page.locator(`xpath=${pathID}`, {hasText: /.+/});
@@ -1812,17 +1812,18 @@ const doActs = async (report, opts = {}) => {
                       elementClone
                       .querySelectorAll('noscript')
                       .forEach(noscript => noscript.remove());
-                      return elementClone.textContent;
+                      return elementClone.innerText;
                     });
                   }
                   // Otherwise, i.e. if it contains no noscript element:
                   else {
                     // Change the text string to the text content of the element.
-                    text = await elementLoc.textContent();
+                    text = await elementLoc.innerText();
                   }
                 }
                 // Add the text string, truncated if necessary, to the instance.
-                instance.text = text.trim().replace(/\s+/g, ' ').slice(0, 300);
+                const textArray = [text.trim().replace(/\s+/g, ' ').slice(0, 300)];
+                instance.text = textArray.filter(segment => segment.length);
               }
             }
           };

package/tests/aslint.js

@@ -22,7 +22,7 @@ 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');
+const {getElementData} = require('../procs/getElementData');
 // Function to normalize an XPath.
 const {getNormalizedXPath} = require('../procs/identify');
 

package/tests/axe.js

@@ -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,43 @@
 // IMPORTS
 
 const axePlaywright = require('axe-playwright');
+// Module to simplify strings.
+const {cap} = require('../procs/job');
+const {getIdentifiers} = require('../procs/getElementData');
 const {injectAxe} = axePlaywright;
 
+// CONSTANTS
+
+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 +92,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 +111,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 +134,50 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
       irrelevants.forEach(irrelevant => {
         delete axeReport[irrelevant];
       });
+      // If standard results are to be reported and there are any violations:
+      if (standard && (totals.rulesViolated || totals.rulesWarned)) {
+        ['incomplete', 'violations'].forEach(certainty => {
+          if (nativeResult?.details?.[certainty]) {
+            nativeResult.details[certainty].forEach(rule => {
+              rule.nodes.forEach(node => {
+                const whatSet = new Set([
+                  rule.help,
+                  ... node.any.map(anyItem => anyItem.message),
+                  ... node.all.map(allItem => allItem.message)
+                ]);
+                const ordinalSeverity = severityWeights[node.impact]
+                + (certainty === 'violations' ? 2 : 0);
+                const identifiers = getIdentifiers(node.html);
+                const instance = {
+                  ruleID: rule.id,
+                  what: Array.from(whatSet.values()).join('; '),
+                  ordinalSeverity,
+                  tagName: identifiers[0],
+                  id: identifiers[1],
+                  location: {
+                    doc: 'dom',
+                    type: 'selector',
+                    spec: node.target && node.target.length ? node.target[0] : ''
+                  },
+                  excerpt: cap(node.html),
+                  boxID: '',
+                  pathID: ''
+                };
+                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/htmlcs.js

@@ -18,7 +18,7 @@
 // Module to add and use unique element IDs.
 const {addTestaroIDs} = require('../procs/testaro');
 // Module to get location data from an element.
-const {getElementData} = require('../procs/getLocatorData');
+const {getElementData} = require('../procs/getElementData');
 // Module to handle files.
 const fs = require('fs/promises');
 

package/tests/qualWeb.js

@@ -20,7 +20,7 @@ const {ACTRules} = require('@qualweb/act-rules');
 const {WCAGTechniques} = require('@qualweb/wcag-techniques');
 const {BestPractices} = require('@qualweb/best-practices');
 const {addTestaroIDs} = require('../procs/testaro');
-const {getElementData} = require('../procs/getLocatorData');
+const {getElementData} = require('../procs/getElementData');
 
 // CONSTANTS
 

package/tests/wax.js

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