testaro 28.2.3 → 28.2.5

package/CONTRIBUTING.md

@@ -12,7 +12,6 @@ Testaro can benefit from contributions of various types, such as:
 
 Tools that may merit consideration include:
 - Arc (by TPGi). Costs $0.05 per page tested, and requires each user to have an account with the tool maker and to allow the tool maker to charge a charge account for payment.
-- Aslint (by Essential Accessibility). Apparently requires using a bundle file that is in the repository but is also listed in the `.gitignore` file and is missing from the published package, so would need to be physically included in the Testaro code rather than referenced as a dependency.
 
 ## Improving execution speed
 
@@ -24,13 +23,13 @@ To come.
 
 ## Implementing new rules
 
-Testaro has about 50 of its own rules, in addition to the approximately 600 rules of the other tools that it integrates. According to the issue classifications in the [Testilo](https://www.npmjs.com/package/testilo) package, these 650 or so rules can be classified into about 260 accessibility _issues_, because some rules of some tools at least approximately duplicate some rules of other tools.
+Testaro has about 50 of its own rules, in addition to the approximately 900 rules of the other tools that it integrates. According to the issue classifications in the [Testilo](https://www.npmjs.com/package/testilo) package, these 950 or so rules can be classified into about 290 accessibility _issues_, because some rules of some tools at least approximately duplicate some rules of other tools.
 
 However, many other significant accessibility issues exist that are not covered by any of the existing rules. Thus, Testaro welcomes contributions of new rules for such issues.
 
 ### Step 1
 
-The first step in contributing a new rule to Testaro is to satisfy yourself that it will not duplicate existing rules. The `procs/score/tic35.js` file in the Testilo package should be helpful here.
+The first step in contributing a new rule to Testaro is to satisfy yourself that it will not duplicate existing rules. The `procs/score/tic36.js` file in the Testilo package should be helpful here.
 
 ### Step 2
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "28.2.3",
+  "version": "28.2.5",
   "description": "Run 960 web accessibility tests from 9 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/procs/tellServer.js

@@ -0,0 +1,28 @@
+/*
+  tellServer
+  Notify the server.
+*/
+
+// CONSTANTS
+
+const httpClient = require('http');
+const httpsClient = require('https');
+const agent = process.env.AGENT;
+
+// FUNCTIONS
+
+exports.tellServer = (report, messageParams, logMessage) => {
+  const observer = report.sources.sendReportTo.replace(/report$/, 'granular');
+  const whoParams = `agent=${agent}&jobID=${report.id || ''}`;
+  const wholeURL = `${observer}?${whoParams}&${messageParams}`;
+  const client = wholeURL.startsWith('https://') ? httpsClient : httpClient;
+  const request = client.request(wholeURL);
+  // If the notification threw an error:
+  request.on('error', error => {
+    // Report the error.
+    const errorMessage = 'ERROR notifying the server';
+    console.log(`${errorMessage} (${error.message})`);
+  });
+  request.end();
+  console.log(`${logMessage} (server notified)`);
+};

package/run.js

@@ -13,9 +13,8 @@ const {actSpecs} = require('./actSpecs');
 const {browserClose, getNonce, goTo, launch} = require('./procs/nav');
 // Module to standardize report formats.
 const {standardize} = require('./procs/standardize');
-// HTTP and HTTPS clients.
-const http = require('http');
-const https = require('https');
+// Module to send a notice to the server.
+const {tellServer} = require('./procs/tellServer');
 
 // ########## CONSTANTS
 
@@ -48,10 +47,6 @@ const tests = {
   testaro: 'Testaro',
   wave: 'WAVE',
 };
-// Observation items.
-const httpClient = require('http');
-const httpsClient = require('https');
-const agent = process.env.AGENT;
 
 // ########## VARIABLES
 
@@ -118,7 +113,7 @@ const hasSubtype = (variable, subtype) => {
       return tests[variable];
     }
     else if (subtype === 'isWaitable') {
-      return waitables.includes(variable);
+      return ['url', 'title', 'body'].includes(variable);
     }
     else if (subtype === 'areNumbers') {
       return areNumbers(variable);
@@ -469,26 +464,12 @@ const doActs = async (report, actIndex, page) => {
           actInfo = act.which;
         }
       }
-      const whichSuffix = actInfo ? ` (${actInfo})` : '';
       // If granular reporting has been specified:
-      let granularSuffix = '';
       if (report.observe) {
         // Notify the server of the act.
-        const observer = report.sources.sendReportTo.replace(/report$/, 'granular');
-        const whoParams = `agent=${agent}&jobID=${report.id || ''}`;
-        const actParams = `act=${act.type}&which=${act.which || ''}`;
-        const wholeURL = `${observer}?${whoParams}&${actParams}`;
-        const client = wholeURL.startsWith('https://') ? httpsClient : httpClient;
-        const request = client.request(wholeURL);
-        // If the notification threw an error:
-        request.on('error', error => {
-          // Report the error.
-          const errorMessage = `ERROR notifying the server of an act`;
-          console.log(`${errorMessage} (${error.message})`);
-        });
-        request.end();
-        granularSuffix = ' with notice to server';
-        console.log(`>>>> ${act.type}${whichSuffix}${granularSuffix}`);
+        const whichParam = act.which ? `&which=${act.which}` : '';
+        const messageParams = `act=${act.type}${whichParam}`;
+        tellServer(report, messageParams, `>>>> ${act.type}: ${actInfo}`);
       }
       // Increment the count of acts performed.
       actCount++;
@@ -582,12 +563,12 @@ const doActs = async (report, actIndex, page) => {
               addError(act, 'badRedirection', 'ERROR: Navigation illicitly redirected');
               await abortActs();
             }
-          }
-          // If the visit failed:
-          if (response.error) {
-            // Report this and quit.
-            addError(act, 'failure', 'ERROR: Visits failed');
-            await abortActs();
+            // Otherwise, i.e. if the visit failed:
+            else {
+              // Report this and quit.
+              addError(act, 'failure', 'ERROR: Visit failed');
+              await abortActs();
+            }
           }
         }
         // Otherwise, if the act is a wait for text:
@@ -712,7 +693,9 @@ const doActs = async (report, actIndex, page) => {
             act.what = tests[act.which];
             // Initialize the options argument.
             const options = {
+              report,
               act,
+              granular: report.observe,
               scriptNonce: report.jobData.lastScriptNonce || ''
             };
             // Add any specified arguments to it.

package/tests/testaro.js

@@ -9,21 +9,27 @@
 const {init, report} = require('../procs/testaro');
 // Module to handle files.
 const fs = require('fs/promises');
+// Module to send a notice to the server.
+const {tellServer} = require('../procs/tellServer');
 
 // ######## CONSTANTS
 
-const futureEvalRules = {
-  adbID: 'elements with ambiguous or missing referenced descriptions',
+/*
+const futureEvalRulesTraining = {
   altScheme: 'img elements with alt attributes having URLs as their entire values',
   captionLoc: 'caption elements that are not first children of table elements',
   datalistRef: 'elements with ambiguous or missing referenced datalist elements',
+  secHeading: 'headings that violate the logical level order in their sectioning containers',
+  textSem: 'semantically vague elements i, b, and/or small'
+};
+const futureEvalRulesCleanRoom = {
+  adbID: 'elements with ambiguous or missing referenced descriptions',
   imageLink: 'links with image files as their destinations',
   legendLoc: 'legend elements that are not first children of fieldset elements',
   optRoleSel: 'Non-option elements with option roles that have no aria-selected attributes',
-  phOnly: 'input elements with placeholders but no accessible names',
-  secHeading: 'headings that violate the logical level order in their sectioning containers',
-  textSem: 'semantically vague elements i, b, and/or small',
+  phOnly: 'input elements with placeholders but no accessible names'
 };
+*/
 const evalRules = {
   allCaps: 'leaf elements with entirely upper-case text longer than 7 characters',
   allHidden: 'page that is entirely or mostly hidden',
@@ -95,7 +101,7 @@ const jsonTest = async (ruleID, ruleArgs) => {
 };
 // Conducts and reports Testaro tests.
 exports.reporter = async (page, options) => {
-  const {withItems, stopOnFail, args} = options;
+  const {withItems, stopOnFail, granular, args} = options;
   const argRules = args ? Object.keys(args) : null;
   const rules = options.rules || ['y', ... Object.keys(evalRules)];
   // Initialize the data.
@@ -129,13 +135,21 @@ exports.reporter = async (page, options) => {
           // Add them to the argument array.
           ruleArgs.push(... args[rule]);
         }
-        // Test the page.
+        // If granular reporting is specified:
         const what = evalRules[rule] || etcRules[rule];
+        if (granular) {
+          // Report the rule to the server.
+          tellServer(
+            options.report,
+            `act=test&which=testaro&rule=${rule}&ruleWhat=${what}`,
+            `>>>>>> ${rule} (${what})`
+          );
+        }
+        // Test the page.
         if (! data.rules[rule]) {
           data.rules[rule] = {};
         }
         data.rules[rule].what = what;
-        console.log(`>>>>>> ${rule} (${what})`);
         try {
           const startTime = Date.now();
           const ruleReport = isJS