testaro 53.1.4 → 53.2.0

package/netWatch.js

@@ -31,8 +31,6 @@
 
 // Module to keep secrets.
 require('dotenv').config();
-// Module to perform file operations.
-const fs = require('fs/promises');
 // Module to validate jobs.
 const {isValidJob} = require('./procs/job');
 // Modules to make requests to servers.
@@ -65,14 +63,8 @@ const serveObject = (object, response) => {
   response.setHeader('Content-Type', 'application/json; charset=utf-8');
   response.end(JSON.stringify(object));
 };
-// Removes the query, if any, or otherwise the final segment, from a URL.
+// Removes the query if any, or otherwise the final segment, from a URL.
 const getURLBase = url => url.replace(/[?/][^?/.]+$/, '');
-// Saves a report.
-const rescueReport = async reportJSON => {
-  const reportDir = 'data/reports';
-  await fs.mkdir(reportDir, { recursive: true });
-  await fs.writeFile(reportDir, reportJSON);
-};
 /*
   Requests a network job and, when found, performs and reports it.
   Arguments:
@@ -161,7 +153,7 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
                   console.log(`${logStart}no job to do`);
                   resolve(true);
                 }
-                // Otherwise, i.e. if it is a job:
+                // Otherwise, if it is a job:
                 else if (id) {
                   // Check it for validity.
                   const jobInvalidity = isValidJob(contentObj);
@@ -199,15 +191,12 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
                       ? httpsClient
                       : httpClient;
                     const reportLogStart = `Submitted report ${id} to ${publicReportURL} and got `;
-                    const reportJSON = JSON.stringify(report, null, 2);
                     // Send the report to the server that assigned the job.
                     reportClient.request(reportURL, {method: 'POST'}, repResponse => {
                       const chunks = [];
                       repResponse
                       // If the response to the report threw an error:
                       .on('error', async error => {
-                        // Rescue the report.
-                        await rescueReport(reportJSON);
                         // Report this.
                         console.log(`${reportLogStart}error message ${error.message}\n`);
                         resolve(true);
@@ -228,8 +217,6 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
                         }
                         // Otherwise, i.e. if it is not JSON:
                         catch(error) {
-                          // Rescue the report.
-                          await rescueReport(reportJSON);
                           // Report this.
                           console.log(
                             `ERROR: ${reportLogStart}status ${repResponse.statusCode}, error message ${error.message}, and response ${content.slice(0, 1000)}\n`
@@ -243,8 +230,8 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
                     })
                     // If the report submission throws an error:
                     .on('error', async error => {
-                      // Rescue the report.
-                      await rescueReport(reportJSON);
+                      // Abort the watch.
+                      abort = true;
                       // Report this.
                       console.log(
                         `ERROR ${error.code} in report submission: ${reportLogStart}error message ${error.message}\n`
@@ -265,7 +252,7 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
               // Otherwise, i.e. if it is not JSON:
               catch(error) {
                 // Report this.
-                console.log(`ERROR: Job request got non-JSON response (${error.message})`);
+                console.log(`ERROR: ${logStart}status ${response.statusCode}, error message ${error.message}, and non-JSON response ${content.slice(0, 1000)}\n`);
                 resolve(true);
               };
             });
@@ -286,11 +273,15 @@ exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) =
             else if (error.message) {
               // Report this.
               console.log(`ERROR: ${logStart}got error message ${error.message.slice(0, 200)}`);
+              // Abort the watch.
+              abort = true;
             }
             // Otherwise, i.e. if it was any other error with no message:
             else {
               // Report this.
               console.log(`ERROR: ${logStart}got an error with no message`);
+              // Abort the watch.
+              abort = true;
             }
             resolve(true);
           })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "53.1.4",
+  "version": "53.2.0",
   "description": "Run 1000 web accessibility tests from 11 tools and get a standardized report",
   "main": "index.js",
   "scripts": {
@@ -27,7 +27,10 @@
   },
   "homepage": "https://github.com/cvs-health/testaro#readme",
   "dependencies": {
-    "@qualweb/core": "*",
+    "@qualweb/core": "0.0.0-develop-20241217135157",
+    "@qualweb/act-rules": "*",
+    "@qualweb/wcag-techniques": "*",
+    "@qualweb/best-practices": "*",
     "@siteimprove/alfa-act": "*",
     "@siteimprove/alfa-playwright": "*",
     "@siteimprove/alfa-rules": "*",

package/procs/doTestAct.js

@@ -1,5 +1,5 @@
 /*
-  © 2024 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2024–2025 CVS Health and/or one of its affiliates. All rights reserved.
 
   MIT License
 
@@ -47,10 +47,9 @@ const actIndex = Number.parseInt(process.argv[2]);
 // FUNCTIONS
 
 const doTestAct = async () => {
-  const tempReportDir = `${__dirname}/../temp`;
-  const tempReportPath = `${tempReportDir}/report.json`;
+  const reportPath = `${__dirname}/../temp/report.json`;
   // Get the saved report.
-  const reportJSON = await fs.readFile(tempReportPath, 'utf8');
+  const reportJSON = await fs.readFile(reportPath, 'utf8');
   const report = JSON.parse(reportJSON);
   // Get the act.
   const act = report.acts[actIndex];
@@ -68,7 +67,7 @@ const doTestAct = async () => {
   if (report.jobData && report.jobData.aborted) {
     // Save the revised report.
     const reportJSON = JSON.stringify(report);
-    await fs.writeFile(tempReportPath, `${reportJSON}\n`);
+    await fs.writeFile(reportPath, reportJSON);
     // Report this.
     process.send('ERROR: Job aborted');
   }
@@ -98,7 +97,7 @@ const doTestAct = async () => {
           }
           const reportJSON = JSON.stringify(report);
           // Save the revised report.
-          await fs.writeFile(tempReportPath, reportJSON);
+          await fs.writeFile(reportPath, reportJSON);
           // Send a completion message.
           process.send('Act completed');
         }
@@ -107,7 +106,7 @@ const doTestAct = async () => {
       catch(error) {
         // Save the revised report.
         const reportJSON = JSON.stringify(report);
-        await fs.writeFile(tempReportPath, reportJSON);
+        await fs.writeFile(reportPath, reportJSON);
         // Report the failure.
         const message = error.message.slice(0, 400);
         console.log(`ERROR: Test act ${act.which} failed (${message})`);
@@ -116,6 +115,7 @@ const doTestAct = async () => {
     }
     // Otherwise, i.e. if the page does not exist:
     else {
+      // Report this.
       process.send('ERROR: No page');
     }
   }

package/run.js

@@ -1,5 +1,5 @@
 /*
-  © 2021–2024 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2021–2025 CVS Health and/or one of its affiliates. All rights reserved.
 
   MIT License
 
@@ -166,7 +166,16 @@ const goTo = async (report, page, url, timeout, waitUntil) => {
         };
       }
     }
-    // Otherwise, i.e. if the response status was abnormal:
+    // Otherwise, if the response status was rejection of excessive requests:
+    else if (httpStatus === 429) {
+      // Return this.
+      console.log(`Visit to ${url} prevented by request frequency restriction (status 429)`);
+      return {
+        success: false,
+        error: 'status429'
+      };
+    }
+    // Otherwise, i.e. if the response status was otherwise abnormal:
     else {
       // Return an error.
       console.log(`ERROR: Visit to ${url} got status ${httpStatus}`);
@@ -197,6 +206,32 @@ const browserClose = async () => {
     browser = null;
   }
 };
+// Adds an error result to an act.
+const addError = (alsoLog, alsoAbort, report, actIndex, message) => {
+  // If the error is to be logged:
+  if (alsoLog) {
+    // Log it.
+    console.log(message);
+  }
+  // Add error data to the result.
+  const act = report.acts[actIndex];
+  act.result ??= {};
+  act.result.success ??= false;
+  act.result.error ??= message;
+  if (act.type === 'test') {
+    act.data ??= {};
+    act.data.success = false;
+    act.data.prevented = true;
+    act.data.error = message;
+    // Add prevention data to the job data.
+    report.jobData.preventions[act.which] = message;
+  }
+  // If the job is to be aborted:
+  if (alsoAbort) {
+    // Add this to the report.
+    abortActs(report, actIndex);
+  }
+};
 // Launches a browser and navigates to a URL.
 const launch = exports.launch = async (report, debug, waits, tempBrowserID, tempURL) => {
   const act = report.acts[actIndex];
@@ -307,16 +342,21 @@ const launch = exports.launch = async (report, debug, waits, tempBrowserID, temp
           report.jobData.lastScriptNonce = scriptNonce;
         }
       }
+      // Otherwise, i.e. if the navigation was prevented by a request frequency restriction:
+      else if (navResult.error === 'status429') {
+        // Report this.
+        addError(true, false, report, actIndex, 'status429');
+      }
       // Otherwise, i.e. if the launch or navigation failed:
       else {
-        // Report this and abort the job.
+        // Report this and nullify the page.
         addError(true, true, report, actIndex, `ERROR: Launch failed (${navResult.error})`);
         page = null;
       }
     }
     // If an error occurred:
     catch(error) {
-      // Report this and abort the job.
+      // Report this.
       addError(true, true, report, actIndex, `ERROR launching or navigating ${error.message}`);
       page = null;
     };
@@ -510,41 +550,13 @@ const abortActs = (report, actIndex) => {
   // Report that the job is aborted.
   console.log(`ERROR: Job aborted on act ${actIndex}`);
 };
-// Adds an error result to an act.
-const addError = (alsoLog, alsoAbort, report, actIndex, message) => {
-  // If the error is to be logged:
-  if (alsoLog) {
-    // Log it.
-    console.log(message);
-  }
-  // Add error data to the result.
-  const act = report.acts[actIndex];
-  act.result ??= {};
-  act.result.success ??= false;
-  act.result.error ??= message;
-  if (act.type === 'test') {
-    act.data ??= {};
-    act.data.success = false;
-    act.data.prevented = true;
-    act.data.error = message;
-    // Add prevention data to the job data.
-    report.jobData.preventions[act.which] = message;
-  }
-  // If the job is to be aborted:
-  if (alsoAbort) {
-    // Add this to the report.
-    abortActs(report, actIndex);
-  }
-};
 // Performs the acts in a report and adds the results to the report.
 const doActs = async (report) => {
   const {acts} = report;
   // Get the standardization specification.
   const standard = report.standard || 'only';
-  const tempReportDir = 'temp';
-  const tempReportPath = `${tempReportDir}/report.json`;
-  await fs.mkdir(tempReportDir, {recursive: true});
-  // For each act in the report:
+  const reportPath = 'temp/report.json';
+  // For each act in the report.
   for (const doActsIndex in acts) {
     actIndex = doActsIndex;
     // If the job has not been aborted:
@@ -628,7 +640,7 @@ const doActs = async (report) => {
         act.startTime = startTime;
         // Save the report.
         let reportJSON = JSON.stringify(report);
-        await fs.writeFile(tempReportPath, reportJSON);
+        await fs.writeFile(reportPath, reportJSON);
         // Create a process and wait for it to perform the act and add the result to the saved report.
         const actResult = await new Promise(resolve => {
           let closed = false;
@@ -649,7 +661,7 @@ const doActs = async (report) => {
           });
         });
         // Get the revised report.
-        reportJSON = await fs.readFile(tempReportPath, 'utf8');
+        reportJSON = await fs.readFile(reportPath, 'utf8');
         report = JSON.parse(reportJSON);
         // Get the revised act.
         act = report.acts[actIndex];
@@ -877,6 +889,9 @@ const doActs = async (report) => {
           act.actualURL = url;
           // If the act is a revelation:
           if (act.type === 'reveal') {
+            act.result = {
+              success: true
+            };
             // Make all elements in the page visible.
             await page.$$eval('body *', elements => {
               elements.forEach(element => {
@@ -888,15 +903,10 @@ const doActs = async (report) => {
                   element.style.visibility = 'inherit';
                 }
               });
-              act.result = {
-                success: true
-              };
             })
             .catch(error => {
               console.log(`ERROR making all elements visible (${error.message})`);
-              act.result = {
-                success: false
-              };
+              act.result.success = false;
             });
           }
           // Otherwise, if the act is a move:
@@ -1347,7 +1357,7 @@ const doActs = async (report) => {
   }
   console.log('Acts completed');
   await browserClose();
-  await fs.rm(tempReportPath, {force: true});
+  await fs.rm(reportPath, {force: true});
   return report;
 };
 /*

package/tests/qualWeb.js

@@ -30,14 +30,19 @@
 // IMPORTS
 
 const {QualWeb} = require('@qualweb/core');
-const {doBy} = require('../procs/job');
+const {ACTRules} = require('@qualweb/act-rules');
+const {WCAGTechniques} = require('@qualweb/wcag-techniques');
+const {BestPractices} = require('@qualweb/best-practices');
 
 // CONSTANTS
 
-const qualWeb = new QualWeb({});
-const clusterOptions = {
-  timeout: 25 * 1000
-};
+const qualWeb = new QualWeb({
+  adBlock: true,
+  stealth: true
+});
+const actRulesModule = new ACTRules({});
+const wcagModule = new WCAGTechniques({});
+const bpModule = new BestPractices({});
 
 // FUNCTIONS
 
@@ -47,8 +52,13 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
   const {withNewContent, rules} = act;
   const data = {};
   let result = {};
-  // Start the QualWeb core engine.
-  await qualWeb.start(clusterOptions);
+  const clusterOptions = {
+    maxConcurrency: 1,
+    timeout: timeLimit * 1000,
+    monitor: false
+  };
+    // Start the QualWeb core engine.
+  await qualWeb.start(clusterOptions, {headless: true});
   // Specify the invariant test options.
   const qualWebOptions = {
     log: {
@@ -57,13 +67,14 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
     crawlOptions: {
       maxDepth: 0,
       maxUrls: 1,
-      timeout: 25 * 1000,
+      timeout: timeLimit * 1000,
       maxParallelCrawls: 1,
       logging: true
     },
     execute: {
       counter: true
-    }
+    },
+    modules: []
   };
   // Specify a URL or provide the content.
   try {
@@ -73,7 +84,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
     else {
       qualWebOptions.html = await page.content();
     }
-    // Specify which rules to test for.
+    // Specify which rules to test for, adding a custom execute property for report processing.
     const actSpec = rules ? rules.find(typeRules => typeRules.startsWith('act:')) : null;
     const wcagSpec = rules ? rules.find(typeRules => typeRules.startsWith('wcag:')) : null;
     const bestSpec = rules ? rules.find(typeRules => typeRules.startsWith('best:')) : null;
@@ -84,6 +95,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
       else {
         const actRules = actSpec.slice(4).split(',').map(num => `QW-ACT-R${num}`);
         qualWebOptions['act-rules'] = {rules: actRules};
+        qualWebOptions.modules.push(actRulesModule);
         qualWebOptions.execute.act = true;
       }
     }
@@ -92,6 +104,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
         levels: ['A', 'AA', 'AAA'],
         principles: ['Perceivable', 'Operable', 'Understandable', 'Robust']
       };
+      qualWebOptions.modules.push(actRulesModule);
       qualWebOptions.execute.act = true;
     }
     if (wcagSpec) {
@@ -101,6 +114,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
       else {
         const wcagTechniques = wcagSpec.slice(5).split(',').map(num => `QW-WCAG-T${num}`);
         qualWebOptions['wcag-techniques'] = {techniques: wcagTechniques};
+        qualWebOptions.modules.push(wcagModule);
         qualWebOptions.execute.wcag = true;
       }
     }
@@ -109,6 +123,7 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
         levels: ['A', 'AA', 'AAA'],
         principles: ['Perceivable', 'Operable', 'Understandable', 'Robust']
       };
+      qualWebOptions.modules.push(wcagModule);
       qualWebOptions.execute.wcag = true;
     }
     if (bestSpec) {
@@ -118,11 +133,13 @@ exports.reporter = async (page, report, actIndex, timeLimit) => {
       else {
         const bestPractices = bestSpec.slice(5).split(',').map(num => `QW-BP${num}`);
         qualWebOptions['best-practices'] = {bestPractices};
+        qualWebOptions.modules.push(bpModule);
         qualWebOptions.execute.bp = true;
       }
     }
     else {
       qualWebOptions['best-practices'] = {};
+      qualWebOptions.modules.push(bpModule);
       qualWebOptions.execute.bp = true;
     }
     // Get the report.