testaro 30.0.8 → 32.0.1

package/tests/aslint.js

@@ -1,3 +1,25 @@
+/*
+  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
 /*
   aslint
   This test implements the ASLint ruleset for accessibility.
@@ -12,15 +34,18 @@ const fs = require('fs/promises');
 
 // Conducts and reports an ASLint test.
 exports.reporter = async (page, options) => {
-  // Initialize the report.
+  // Initialize the act report.
   let data = {};
+  let result = {};
   // Get the ASLint runner and bundle scripts.
   const aslintRunner = await fs.readFile(`${__dirname}/../procs/aslint.js`, 'utf8');
   const aslintBundle = await fs.readFile(
     `${__dirname}/../node_modules/aslint-testaro/aslint.bundle.js`, 'utf8'
   );
   // Get the nonce, if any.
-  const {scriptNonce} = options;
+  const {report} = options;
+  const {jobData} = report;
+  const scriptNonce = jobData && jobData.lastScriptNonce;
   // Inject the ASLint bundle and runner into the page.
   await page.evaluate(args => {
     const {scriptNonce, aslintBundle, aslintRunner} = args;
@@ -43,41 +68,54 @@ exports.reporter = async (page, options) => {
     document.body.insertAdjacentElement('beforeend', runnerEl);
   }, {scriptNonce, aslintBundle, aslintRunner})
   .catch(error => {
-    console.log(`ERROR: ASLint injection failed (${error.message.slice(0, 400)})`);
+    const message = `ERROR: ASLint injection failed (${error.message.slice(0, 400)})`;
+    console.log(message);
     data.prevented = true;
-    data.error = 'ERROR: ASLint injection failed';
+    data.error = message;
   });
   // If the injection succeeded:
+  const reportLoc = page.locator('#aslintResult');
   if (! data.prevented) {
     // Wait for the test results.
-    const reportLoc = page.locator('#aslintResult');
     await reportLoc.waitFor({
       state: 'attached',
-      timeout: 10000
+      timeout: 30000
+    })
+    .catch(error => {
+      const message = `ERROR: Results timed out (${error.message.slice(0, 400)})`;
+      console.log(message);
+      data.prevented = true;
+      data.error = message;
     });
+  }
+  // If the results arrived in time:
+  if (! data.prevented) {
     // Get them.
-    const report = await reportLoc.textContent();
-    // Populate the tool report.
-    data = JSON.parse(report);
+    const actReport = await reportLoc.textContent();
+    // Populate the act report.
+    result = JSON.parse(actReport);
     // Delete irrelevant properties from the tool report details.
-    if (data.rules) {
-      Object.keys(data.rules).forEach(ruleID => {
-        if (['passed', 'skipped'].includes(data.rules[ruleID].status.type)) {
-          delete data.rules[ruleID];
+    if (result.rules) {
+      Object.keys(result.rules).forEach(ruleID => {
+        if (['passed', 'skipped'].includes(result.rules[ruleID].status.type)) {
+          delete result.rules[ruleID];
         }
       });
     }
   }
-  // Return the result.
+  // Return the act report.
   try {
     JSON.stringify(data);
   }
   catch(error) {
-    console.log(`ERROR: ASLint result cannot be made JSON (${error.message.slice(0, 200)})`);
+    const message = `ERROR: ASLint result cannot be made JSON (${error.message.slice(0, 200)})`;
     data = {
       prevented: true,
-      error: `ERROR: ASLint result cannot be made JSON (${error.message.slice(0, 200)})`
+      error: message
     };
   }
-  return {result: data};
+  return {
+    data,
+    result
+  };
 };

package/tests/axe.js

@@ -1,3 +1,25 @@
+/*
+  © 2021–2023 CVS Health and/or one of its affiliates. All rights reserved.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
 /*
   axe
   This test implements the axe-core ruleset for accessibility.
@@ -28,8 +50,9 @@ const {injectAxe, getAxeResults} = require('axe-playwright');
 // Conducts and reports an Axe test.
 exports.reporter = async (page, options) => {
   const {detailLevel, rules} = options;
-  // Initialize the report.
+  // Initialize the act report.
   let data = {};
+  let result = {};
   // Inject axe-core into the page.
   await injectAxe(page)
   .catch(error => {
@@ -58,7 +81,7 @@ exports.reporter = async (page, options) => {
     const {inapplicable, passes, incomplete, violations} = axeReport;
     if (violations) {
       // Initialize the result.
-      data.totals = {
+      result.totals = {
         rulesNA: 0,
         rulesPassed: 0,
         rulesWarned: 0,
@@ -76,9 +99,9 @@ exports.reporter = async (page, options) => {
           critical: 0
         }
       };
-      data.details = axeReport;
+      result.details = axeReport;
       // Populate the totals.
-      const {totals} = data;
+      const {totals} = result;
       totals.rulesNA = inapplicable.length;
       totals.rulesPassed = passes.length;
       incomplete.forEach(rule => {
@@ -104,8 +127,7 @@ exports.reporter = async (page, options) => {
     else {
       // Report this.
       data.prevented = true;
-      data.error = 'ERROR: axe failed';
-      console.log('ERROR: axe failed');
+      data.error = 'ERROR: Act failed';
     }
   }
   // Return the result.
@@ -113,11 +135,15 @@ exports.reporter = async (page, options) => {
     JSON.stringify(data);
   }
   catch(error) {
-    console.log(`ERROR: axe result cannot be made JSON (${error.message})`);
+    const message = `ERROR: Axe result cannot be made JSON (${error.message})`;
+    console.log(message);
     data = {
       prevented: true,
-      error: `ERROR: axe result cannot be made JSON (${error.message})`
+      error: message
     };
   }
-  return {result: data};
+  return {
+    data,
+    result
+  };
 };

package/tests/htmlcs.js

@@ -1,94 +1,125 @@
+/*
+  © 2022–2023 CVS Health and/or one of its affiliates. All rights reserved.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
 /*
   htmlcs
   This test implements the HTML CodeSniffer ruleset.
 */
 
+// IMPORTS
+
+// Module to handle files.
+const fs = require('fs/promises');
+
 // FUNCTIONS
-// Runs HTML CodeSniffer on the page.
+
+// Runs HTML CodeSniffer on the page and returns an act report.
 exports.reporter = async (page, options) => {
-  const {rules} = options;
+  const {report, rules} = options;
+  const data = {};
   const result = {};
-  // Add the HTMLCS script to the page.
-  await page.addScriptTag({
-    path: `${__dirname}/../htmlcs/HTMLCS.js`
-  })
-  .catch(error => {
-    console.log(`ERROR adding the htmlcs script to the page (${error.message})`);
-    result.prevented = true;
-    result.error = 'ERROR adding the htmlcs script to the page';
-  });
-  if (! result.prevented) {
-    let messageStrings = [];
-    // Define the rules to be employed as those of WCAG 2 level AAA.
-    for (const standard of ['WCAG2AAA']) {
-      const nextIssues = await page.evaluate(args => {
-        const standard = args[0];
-        const rules = args[1];
-        // If only some rules are to be employed:
-        if (rules && Array.isArray(rules) && rules.length) {
-          // Redefine WCAG 2 AAA as including only them.
-          if (! window.HTMLCS_WCAG2AAA) {
-            window.HTMLCS_WCAG2AAA = {};
-          }
-          window.HTMLCS_WCAG2AAA.sniffs = rules;
+  // Get the HTMLCS script.
+  const scriptText = await fs.readFile(`${__dirname}/../htmlcs/HTMLCS.js`, 'utf8');
+  const scriptNonce = report.jobData && report.jobData.lastScriptNonce;
+  // Define the rules to be employed as those of WCAG 2 level AAA.
+  let messageStrings = [];
+  for (const actStandard of ['WCAG2AAA']) {
+    const nextIssues = await page.evaluate(args => {
+      // Add the HTMLCS script to the page.
+      const scriptText = args[2];
+      const scriptNonce = args[3];
+      const script = document.createElement('script');
+      script.nonce = scriptNonce;
+      script.textContent = scriptText;
+      document.head.insertAdjacentElement('beforeend', script);
+      // If only some rules are to be employed:
+      const actStandard = args[0];
+      const rules = args[1];
+      if (rules && Array.isArray(rules) && rules.length) {
+        // Redefine WCAG 2 AAA as including only them.
+        if (! window.HTMLCS_WCAG2AAA) {
+          window.HTMLCS_WCAG2AAA = {};
         }
-        // Run the tests.
-        let issues = null;
-        try {
-          issues = window.HTMLCS_RUNNER.run(standard);
-        }
-        catch(error) {
-          console.log(`ERROR executing HTMLCS_RUNNER on ${document.URL} (${error.message})`);
-        }
-        return issues;
-      }, [standard, rules]);
-      if (nextIssues && nextIssues.every(issue => typeof issue === 'string')) {
-        messageStrings.push(... nextIssues);
+        window.HTMLCS_WCAG2AAA.sniffs = rules;
       }
-      else {
-        result.prevented = true;
-        result.error = 'ERROR executing HTMLCS_RUNNER in the page';
-        break;
+      // Run the tests.
+      let issues = null;
+      try {
+        issues = window.HTMLCS_RUNNER.run(actStandard);
       }
+      catch(error) {
+        console.log(`ERROR executing HTMLCS_RUNNER on ${document.URL} (${error.message})`);
+      }
+      return issues;
+    }, [actStandard, rules, scriptText, scriptNonce]);
+    if (nextIssues && nextIssues.every(issue => typeof issue === 'string')) {
+      messageStrings.push(... nextIssues);
+    }
+    else {
+      data.prevented = true;
+      data.error = 'ERROR executing HTMLCS_RUNNER in the page';
+      break;
     }
-    if (! result.prevented) {
-      // Sort the issues by class and standard.
-      messageStrings.sort();
-      // Remove any duplicate issues.
-      messageStrings = [... new Set(messageStrings)];
-      // Initialize the result.
-      result.Error = {};
-      result.Warning = {};
-      // For each issue:
-      messageStrings.forEach(string => {
-        const parts = string.split(/\|/, 6);
-        const partCount = parts.length;
-        if (partCount < 6) {
-          console.log(`ERROR: Issue string ${string} has too few parts`);
+  }
+  if (! data.prevented) {
+    // Sort the issues by class and standard.
+    messageStrings.sort();
+    // Remove any duplicate issues.
+    messageStrings = [... new Set(messageStrings)];
+    // Initialize the result.
+    result.Error = {};
+    result.Warning = {};
+    // For each issue:
+    messageStrings.forEach(string => {
+      const parts = string.split(/\|/, 6);
+      const partCount = parts.length;
+      if (partCount < 6) {
+        console.log(`ERROR: Issue string ${string} has too few parts`);
+      }
+      // If it is an error or a warning (not a notice):
+      else if (['Error', 'Warning'].includes(parts[0])) {
+        /*
+          Add the issue to an issueClass.issueCode.description array in the result.
+          This saves space, because, although some descriptions are issue-specific, such as
+          descriptions that state the contrast ratio of an element, most descriptions are
+          generic, so typically many violations share a description.
+        */
+        const issueCode = parts[1].replace(/^WCAG2|\.Principle\d\.Guideline[\d_]+/g, '');
+        if (! result[parts[0]][issueCode]) {
+          result[parts[0]][issueCode] = {};
         }
-        // If it is an error or a warning (not a notice):
-        else if (['Error', 'Warning'].includes(parts[0])) {
-          /*
-            Add the issue to an issueClass.issueCode.description array in the result.
-            This saves space, because, although some descriptions are issue-specific, such as
-            descriptions that state the contrast ratio of an element, most descriptions are
-            generic, so typically many issues share a description.
-          */
-          const issueCode = parts[1].replace(/^WCAG2|\.Principle\d\.Guideline[\d_]+/g, '');
-          if (! result[parts[0]][issueCode]) {
-            result[parts[0]][issueCode] = {};
-          }
-          if (! result[parts[0]][issueCode][parts[4]]) {
-            result[parts[0]][issueCode][parts[4]] = [];
-          }
-          result[parts[0]][issueCode][parts[4]].push({
-            tagName: parts[2],
-            id: parts[3],
-            code: parts[5]
-          });
+        if (! result[parts[0]][issueCode][parts[4]]) {
+          result[parts[0]][issueCode][parts[4]] = [];
         }
-      });
-    }
+        result[parts[0]][issueCode][parts[4]].push({
+          tagName: parts[2],
+          id: parts[3],
+          code: parts[5]
+        });
+      }
+    });
   }
-  return {result};
+  return {
+    data,
+    result
+  };
 };

package/tests/ibm.js

@@ -1,19 +1,46 @@
+/*
+  © 2021–2023 CVS Health and/or one of its affiliates. All rights reserved.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
 /*
   ibm
   This test implements the IBM Equal Access ruleset for accessibility.
   The 'withNewContent' argument determines whether the test package should be
   given the URL of the page to be tested (true) or the page content (false).
-  
+
   This test depends on aceconfig.js.
 
   This tool is compatible with Windows only if the accessibility-checker package
   is revised. See README.md for details.
 */
-// Import required modules.
+
+// IMPORTS
+
 const fs = require('fs').promises;
 // Scanner. Importing and executing 'close' crashed the Node process.
 const {getCompliance} = require('accessibility-checker');
-// Runs the IBM test.
+
+// FUNCTIONS
+
+// Runs the IBM test and returns the result.
 const run = async (content, timeLimit) => {
   const nowLabel = (new Date()).toISOString().slice(0, 19);
   // Start the timeout clock.
@@ -37,11 +64,11 @@ const run = async (content, timeLimit) => {
     return null;
   }
 };
-// Revises report totals for any rule limitation.
-const limitRuleTotals = (report, rules) => {
+// Revises act-report totals for any rule limitation.
+const limitRuleTotals = (actReport, rules) => {
   if (rules && Array.isArray(rules) && rules.length) {
-    const totals = report.report.summary.counts;
-    const items = report.report.results;
+    const totals = actReport.summary.counts;
+    const items = actReport.results;
     totals.violation = totals.recommendation = 0;
     items.forEach(item => {
       if (rules.includes(item.ruleId)) {
@@ -51,21 +78,24 @@ const limitRuleTotals = (report, rules) => {
   }
 };
 // Trims an IBM report.
-const trimReport = (report, withItems, rules) => {
-  const data = {};
-  if (report && report.report && report.report.summary) {
-    limitRuleTotals(report, rules);
-    const totals = report.report.summary.counts;
+const trimActReport = (data, actReport, withItems, rules) => {
+  // If the act report includes a summary:
+  if (actReport && actReport.summary) {
+    // Remove excluded rules from the act report.
+    limitRuleTotals(actReport, rules);
+    // If the act report includes totals:
+    const totals = actReport.summary.counts;
     if (totals) {
-      data.totals = totals;
+      // If itemization is required:
       if (withItems) {
+        // Trim the items.
         if (rules && Array.isArray(rules) && rules.length) {
-          data.items = report.report.results.filter(item => rules.includes(item.ruleId));
+          actReport.items = actReport.results.filter(item => rules.includes(item.ruleId));
         }
         else {
-          data.items = report.report.results;
+          actReport.items = actReport.results;
         }
-        data.items.forEach(item => {
+        actReport.items.forEach(item => {
           delete item.apiArgs;
           delete item.category;
           delete item.ignored;
@@ -75,31 +105,43 @@ const trimReport = (report, withItems, rules) => {
           delete item.value;
         });
       }
+      // Return the act report, trimmed.
+      return {
+        totals,
+        items: actReport.items
+      };
     }
+    // Otherwise, i.e. if it excludes totals:
     else {
+      // Report this.
       data.prevented = true;
-      data.error = 'ERROR: ibm test delivered no totals';
+      data.error = 'ERROR: No totals reported';
+      // Return an empty act report.
+      return {
+        totals: {},
+        items: []
+      };
     }
   }
+  // Otherwise, i.e. if it excludes a summary:
   else {
+    // Report this.
     data.prevented = true;
-    data.error = 'ERROR: ibm test delivered no report summary';
+    data.error = 'ERROR: No summary reported';
+    // Return an empty act report.
+    return {
+      totals: {},
+      items: []
+    };
   }
-  return data;
 };
-// Performs the IBM tests and returns the result.
+// Performs the IBM tests and returns an act report.
 const doTest = async (content, withItems, timeLimit, rules) => {
   // Conduct the test and get the result.
-  let report;
+  const data = {};
   try {
-    report = await run(content, timeLimit);
-  }
-  catch(error) {
-    console.log(`ibm test failed ${error.message.slice(0, 100)}...`);
-    report = null;
-  }
-  // If the test did not crash or time out:
-  if (report) {
+    const runReport = await run(content, timeLimit);
+    const actReport = runReport && runReport.report;
     // Delete any report files.
     try {
       const reportNames = await fs.readdir('results');
@@ -108,37 +150,61 @@ const doTest = async (content, withItems, timeLimit, rules) => {
       }
     }
     catch(error) {
-      console.log('ibm test created no result files.');
+      console.log('No result files created');
     }
-    // Return the result.
-    const typeReport = trimReport(report, withItems, rules);
-    return typeReport;
+    // Return a trimmed act report.
+    const trimmedReport = trimActReport(data, actReport, withItems, rules);
+    return {
+      data,
+      result: trimmedReport
+    };
   }
-  else {
+  catch(error) {
+    const message = `Act failed (${error.message.slice(0, 200)})`;
+    console.log(message);
+    data.prevented = true;
+    data.error = message;
     return {
-      prevented: true,
-      error: 'ERROR: ibm test failed or timed out'
+      data,
+      result: {}
     };
   }
 };
-// Returns results of an IBM test.
+// Performs ibm tests and returns an act report.
 exports.reporter = async (page, options) => {
   const {withItems, withNewContent, rules} = options;
   const contentType = withNewContent ? 'new' : 'existing';
   console.log(`>>>>>> Content type: ${contentType}`);
-  let result;
   const timeLimit = 30;
   const typeContent = contentType === 'existing' ? await page.content() : await page.url();
   try {
-    result = await doTest(typeContent, withItems, timeLimit, rules);
-    if (result.prevented) {
-      console.log(`ERROR: Getting ibm test report timed out at ${timeLimit} seconds`);
+    const actReport = await doTest(typeContent, withItems, timeLimit, rules);
+    const {data, result} = actReport;
+    if (data && data.prevented) {
+      const message = `ERROR: Act failed or timed out at ${timeLimit} seconds`;
+      console.log(message);
+      data.error = data.error ? `${data.error}; ${message}` : message;
+      return {
+        data,
+        result: {}
+      };
+    }
+    else {
+      return {
+        data,
+        result
+      };
     }
   }
   catch(error) {
-    result.prevented = true;
-    console.log(`ERROR: ibm test crashed with error ${error.message.slice(0, 200)}`);
+    const message = `ERROR: Act crashed (${error.message.slice(0, 200)})`;
+    console.log(message);
+    return {
+      data: {
+        prevented: true,
+        error: message
+      },
+      result: {}
+    };
   }
-  // Return the result. Execution of close() crashed the Node process.
-  return {result};
 };