testaro 32.4.0 → 33.0.0

package/netWatch.js

@@ -64,6 +64,7 @@ const serveObject = (object, response) => {
   Arguments:
   0. whether to continue watching after a job is run.
   1: interval in seconds from a cycle of no-job checks to the next cycle.
+  2. whether to ignore unknown-certificate errors from watched servers.
 */
 exports.netWatch = async (isForever, intervalInSeconds, isCertTolerant = true) => {
   const urls = jobURLSpec

package/package.json

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

package/procs/standardize.js

@@ -440,6 +440,7 @@ const convert = (toolName, data, result, standardResult) => {
   // axe
   else if (
     toolName === 'axe'
+    && result
     && result.totals
     && (result.totals.rulesWarned || result.totals.rulesViolated)
   ) {
@@ -453,6 +454,44 @@ const convert = (toolName, data, result, standardResult) => {
     doAxe(result, standardResult, 'incomplete');
     doAxe(result, standardResult, 'violations');
   }
+  // ed11y
+  else if (
+    toolName === 'ed11y'
+    && result
+    && ['results', 'errorCount', 'warningCount'].every(key => result[key] !== undefined)
+  ) {
+    // Populate the totals of the standard result.
+    const {results, errorCount, warningCount} = result;
+    standardResult.totals = [warningCount, 0, errorCount, 0];
+    // For each result:
+    results.forEach(result => {
+      const {test, content, tagName, id, loc, excerpt} = result;
+      if (['test', 'content'].every(key => result[key])) {
+        // Standardize the what property.
+        let what = '';
+        if (content.includes('<p>This')) {
+          what = content.replace(/^.*?<p>(This.+?)<\/p> *<p>(.*?)<\/p>.*/, '$1 $2');
+        }
+        else {
+          what = content.replace(/^.*?<p>(.+?)<\/p>.*/, '$1');
+        }
+        // Add a standard instance to the standard result.
+        standardResult.instances.push({
+          ruleID: test,
+          what,
+          ordinalSeverity: 0,
+          tagName,
+          id,
+          location: {
+            doc: 'dom',
+            type: 'box',
+            spec: loc
+          },
+          excerpt
+        });
+      }
+    });
+  }
   // htmlcs
   else if (toolName === 'htmlcs' && result) {
     doHTMLCS(result, standardResult, 'Warning');

package/run.js

@@ -58,6 +58,7 @@ const tools = {
   alfa: 'alfa',
   aslint: 'ASLint',
   axe: 'Axe',
+  ed11y: 'Editoria11y',
   htmlcs: 'HTML CodeSniffer WCAG 2.1 AA ruleset',
   ibm: 'IBM Accessibility Checker',
   nuVal: 'Nu Html Checker',
@@ -1568,7 +1569,7 @@ exports.doJob = async report => {
   // If the report is valid:
   const reportInvalidity = isValidReport(report);
   if (reportInvalidity) {
-    console.log(reportInvalidity);
+    console.log(`ERROR: ${reportInvalidity}`);
   }
   else {
     // Add initialized job data to the report.

package/tests/alfa.js

@@ -33,7 +33,7 @@ let alfaRules = require('@siteimprove/alfa-rules').default;
 
 // FUNCTIONS
 
-// Conducts and reports an alfa test.
+// Conducts and reports the alfa tests.
 exports.reporter = async (page, options) => {
   const {rules} = options;
   // If only some rules are to be employed:

package/tests/aslint.js

@@ -32,7 +32,7 @@ const fs = require('fs/promises');
 
 // FUNCTIONS
 
-// Conducts and reports an ASLint test.
+// Conducts and reports the ASLint tests.
 exports.reporter = async (page, options) => {
   // Initialize the act report.
   let data = {};

package/tests/axe.js

@@ -47,7 +47,7 @@ const {injectAxe, getAxeResults} = require('axe-playwright');
 
 // FUNCTIONS
 
-// Conducts and reports an Axe test.
+// Conducts and reports the Axe tests.
 exports.reporter = async (page, options) => {
   const {detailLevel, rules} = options;
   // Initialize the act report.

package/tests/ed11y.js

@@ -0,0 +1,142 @@
+/*
+  © 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.
+*/
+
+/*
+  ed11y
+  This test implements the Editoria11y ruleset for accessibility.
+*/
+
+// IMPORTS
+
+// Module to handle files.
+const fs = require('fs/promises');
+
+// FUNCTIONS
+
+// Conducts and reports the Editoria11y tests.
+exports.reporter = async (page, options) => {
+  // Get the nonce, if any.
+  const {report} = options;
+  const {jobData} = report;
+  const scriptNonce = jobData && jobData.lastScriptNonce;
+  // Get the test script.
+  const script = await fs.readFile(`${__dirname}/../ed11y/editoria11y.min.js`, 'utf8');
+  const rawResultJSON = await page.evaluate(args => new Promise(async resolve => {
+    const {scriptNonce, script} = args;
+    // When the script is executed:
+    document.addEventListener('ed11yResults', () => {
+      // Get the result.
+      const resultObj = {};
+      [
+        'version',
+        'options',
+        'mediaCount',
+        'errorCount',
+        'warningCount',
+        'dismissedCount',
+        'totalCount'
+      ]
+      .forEach(key => {
+        try {
+          resultObj[key] = Ed11y[key];
+        }
+        catch(error) {
+          console.log(`ERROR: invalid value of ${key} property of Ed11y (${error.message})`);
+        }
+      });
+      // Get data on the text alternatives of images from the result.
+      resultObj.imageAlts = Ed11y
+      .imageAlts
+      .filter(item => item[3] !== 'pass')
+      .map(item => item.slice(1));
+      // Delete useless properties from the result.
+      delete resultObj.options.sleekTheme;
+      delete resultObj.options.darkTheme;
+      delete resultObj.options.lightTheme;
+      // Initialize the element results.
+      const results = resultObj.results = [];
+      // Populate them and add them to the result.
+      Ed11y.results.forEach(elResult => {
+        const result = {};
+        result.test = elResult.test || '';
+        if (elResult.content) {
+          result.content = elResult.content.replace(/\s+/g, ' ');
+        }
+        if (elResult.element) {
+          const{element} = elResult;
+          result.tagName = element.tagName || '';
+          result.id = element.id || '';
+          result.loc = {};
+          const locRect = element.getBoundingClientRect();
+          if (locRect) {
+            ['x', 'y', 'width', 'height'].forEach(dim => {
+              result.loc[dim] = Math.round(locRect[dim]);
+            });
+          }
+          let elText = element.textContent.replace(/\s+/g, ' ').trim();
+          if (! elText) {
+            elText = element.outerHTML;
+          }
+          if (elText.length > 400) {
+            elText = `${elText.slice(0, 200)}…${elText.slice(-200)}`;
+          }
+          result.excerpt = elText.replace(/\s+/g, ' ');
+        }
+        results.push(result);
+      });
+      // Return the result.
+      try {
+        const resultJSON = JSON.stringify(resultObj);
+        resolve(resultJSON);
+      }
+      catch(error) {
+        console.log(`ERROR stringifying result object (${error.message})`);
+        resolve('{}');
+      }
+    });
+    // Add the test script to the page.
+    const testScript = document.createElement('script');
+    if (scriptNonce) {
+      testScript.nonce = scriptNonce;
+      console.log(`Added nonce ${scriptNonce} to script`);
+    }
+    testScript.textContent = script;
+    document.body.insertAdjacentElement('beforeend', testScript);
+    // Run the script.
+    try {
+      await new Ed11y({
+        alertMode: 'headless'
+      });
+    }
+    catch(error) {
+      console.log(`ERROR creating Ed11y (${error.message})`);
+      resolve(JSON.stringify({error: error.message}));
+    };
+  }), {scriptNonce, script});
+  const result = JSON.parse(rawResultJSON);
+  let data = {};
+  // Return the act report.
+  return {
+    data,
+    result
+  };
+};

package/tests/htmlcs.js

@@ -32,7 +32,7 @@ const fs = require('fs/promises');
 
 // FUNCTIONS
 
-// Runs HTML CodeSniffer on the page and returns an act report.
+// Conducts and reports the HTML CodeSniffer tests.
 exports.reporter = async (page, options) => {
   const {report, rules} = options;
   const data = {};

package/tests/ibm.js

@@ -176,7 +176,7 @@ const doTest = async (content, withItems, timeLimit, rules) => {
     };
   }
 };
-// Performs ibm tests and returns an act report.
+// Conducts and reports the IBM Equal Access tests.
 exports.reporter = async (page, options) => {
   const {withItems, withNewContent, rules} = options;
   const contentType = withNewContent ? 'new' : 'existing';

package/tests/nuVal.js

@@ -38,6 +38,7 @@ const fs = require('fs/promises');
 
 // ########## FUNCTIONS
 
+// Conducts and reports the Nu Html Checker tests.
 exports.reporter = async (page, options) => {
   const {rules} = options;
   // Get the browser-parsed page.

package/tests/qualWeb.js

@@ -38,7 +38,7 @@ const clusterOptions = {
 
 // FUNCTIONS
 
-// Conducts and reports a QualWeb test.
+// Conducts and reports the QualWeb tests.
 exports.reporter = async (page, options) => {
   const {withNewContent, rules} = options;
   const data = {};

package/tests/testaro.js

@@ -129,7 +129,7 @@ const wait = ms => {
     }, ms);
   });
 };
-// Conducts and reports Testaro tests.
+// Conducts and reports the Testaro tests.
 exports.reporter = async (page, options) => {
   const {report, withItems, stopOnFail, args} = options;
   const argRules = args ? Object.keys(args) : null;

package/tests/wave.js

@@ -26,8 +26,15 @@
   specifies a WAVE report type: 1, 2, 3, or 4. The larger the number, the more detailed (and
   expensive) the report.
 */
+
+// CONSTANTS
+
 const fs = require('fs/promises');
 const https = require('https');
+
+// FUNCTIONS
+
+// Conducts and reports the WAVE tests.
 exports.reporter = async (page, options) => {
   const {reportType, rules} = options;
   const waveKey = process.env.WAVE_KEY;