testaro 12.0.0 → 12.1.1

package/README.md

@@ -380,6 +380,10 @@ The changes in `htmlcs/HTMLCS.js` are:
 >       );
 ```
 
+###### QualWeb
+
+A `qualWeb` test act performs the ACT rules, WCAG Techniques, and best-practices tests of QualWeb. Only failures and warnings are included in the report. The EARL report of QualWeb is not generated, because it is equivalent to the report of the ACT rules tests.
+
 ###### Tenon
 
 Most tools require only one act, but the `tenon` tool requires two acts:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "12.0.0",
+  "version": "12.1.1",
   "description": "Automation of accessibility testing",
   "main": "index.js",
   "scripts": {

package/tests/qualWeb.js

@@ -3,7 +3,7 @@
   This test implements the QualWeb ruleset for accessibility.
 */
 // IMPORTS
-const {QualWeb, generateEARLReport} = require('@qualweb/core');
+const {QualWeb} = require('@qualweb/core');
 // CONSTANTS
 const qualweb = new QualWeb({});
 const clusterOptions = {
@@ -52,24 +52,43 @@ exports.reporter = async (page, rules = null) => {
   }
   // Get the report.
   const reports = await qualweb.evaluate(qualwebOptions);
-  // Trim it.
+  // Prepare to trim its ACT rules and WCAG Techniques section.
   delete reports.customHtml.system.page.dom;
-  const {assertions} = reports.customHtml.modules['act-rules'];
-  const ruleIDs = Object.keys(assertions);
-  ruleIDs.forEach(ruleID => {
-    assertions[ruleID].results = assertions[ruleID]
-    .results
-    .filter(result => result.verdict !== 'passed');
+  ['act-rules', 'wcag-techniques', 'best-practices'].forEach(module => {
+    const {assertions} = reports.customHtml.modules[module];
+    const ruleIDs = Object.keys(assertions);
+    ruleIDs.forEach(ruleID => {
+      // Remove passing customHtml results.
+      const ruleAssertions = assertions[ruleID];
+      const {metadata} = ruleAssertions;
+      if (metadata) {
+        if (metadata.warning === 0 && metadata.failed === 0) {
+          delete assertions[ruleID];
+        }
+        else {
+          if (ruleAssertions.results) {
+            ruleAssertions.results = ruleAssertions.results.filter(
+              result => result.verdict !== 'passed'
+            );
+          }
+        }
+      }
+      // Shorten long HTML codes of elements.
+      const {results} = ruleAssertions;
+      results.forEach(result => {
+        const {elements} = result;
+        if (elements && elements.length) {
+          elements.forEach(element => {
+            if (element.htmlCode && element.htmlCode.length > 700) {
+              element.htmlCode = `${element.htmlCode.slice(0, 700)} …`;
+            }
+          });
+        }
+      });
+    });
   });
   // Stop the QualWeb core engine.
   await qualweb.stop();
-  // Specify the EARL options.
-  const earlOptions = {};
-  // Get the EARL report.
-  const earlReports = generateEARLReport(reports, earlOptions);
-  // Add the reports to the data.
-  data.reports = reports;
-  data.earlReports = earlReports;
   // Return the result.
   try {
     JSON.stringify(data);
@@ -81,5 +100,5 @@ exports.reporter = async (page, rules = null) => {
       error: `ERROR: qualWeb result cannot be made JSON (${error.message})`
     };
   }
-  return {result: data};
+  return {result: reports};
 };

package/samples/00000-ts18-example.json

@@ -1,231 +0,0 @@
-{
-  "id": "00000-ts18-example",
-  "what": "Alfa, Axe, Continuum, HTML CodeSniffer, IBM, Nu Html Checker, Tenon, WAVE, and 22 custom tests",
-  "strict": true,
-  "timeLimit": 500,
-  "commands": [
-    {
-      "type": "launch",
-      "which": "webkit",
-      "what": "Webkit browser"
-    },
-    {
-      "type": "url",
-      "which": "https://example.edu",
-      "what": "Example.com",
-      "id": "example"
-    },
-    {
-      "type": "tenonRequest",
-      "id": "a",
-      "withNewContent": true,
-      "what": "Tenon API version 2 test request"
-    },
-    {
-      "type": "test",
-      "which": "motion",
-      "what": "spontaneous change of content; requires webkit",
-      "delay": 2500,
-      "interval": 2500,
-      "count": 5
-    },
-    {
-      "type": "launch",
-      "which": "chromium",
-      "what": "Chromium browser"
-    },
-    {
-      "type": "url",
-      "which": "https://example.edu",
-      "what": "Example.com",
-      "id": "example"
-    },
-    {
-      "type": "test",
-      "which": "allHidden",
-      "what": "document entirely or mainly hidden"
-    },
-    {
-      "type": "test",
-      "which": "bulk",
-      "what": "count of visible elements"
-    },
-    {
-      "type": "test",
-      "which": "docType",
-      "what": "missing or invalid doctype declaration"
-    },
-    {
-      "type": "test",
-      "which": "embAc",
-      "withItems": true,
-      "what": "active elements incorrectly embedded in each other"
-    },
-    {
-      "type": "test",
-      "which": "filter",
-      "withItems": true,
-      "what": "filter styles"
-    },
-    {
-      "type": "test",
-      "which": "focAll",
-      "what": "Tab-focusability"
-    },
-    {
-      "type": "test",
-      "which": "focInd",
-      "revealAll": false,
-      "allowedDelay": 250,
-      "withItems": true,
-      "what": "focus indicators"
-    },
-    {
-      "type": "test",
-      "which": "focOp",
-      "withItems": true,
-      "what": "focusability and operability of elements"
-    },
-    {
-      "type": "test",
-      "which": "focVis",
-      "withItems": true,
-      "what": "links outside display when focused"
-    },
-    {
-      "type": "test",
-      "which": "hover",
-      "sampleSize": 20,
-      "withItems": true,
-      "what": "hover impacts"
-    },
-    {
-      "type": "test",
-      "which": "labClash",
-      "withItems": true,
-      "what": "unlabeled and mislabeled form controls"
-    },
-    {
-      "type": "test",
-      "which": "linkTo",
-      "withItems": true,
-      "what": "links without destinations"
-    },
-    {
-      "type": "test",
-      "which": "linkUl",
-      "withItems": true,
-      "what": "underlining of inline links"
-    },
-    {
-      "type": "test",
-      "which": "miniText",
-      "withItems": true,
-      "what": "small text"
-    },
-    {
-      "type": "test",
-      "which": "menuNav",
-      "withItems": true,
-      "what": "keyboard navigation within true-focus menus"
-    },
-    {
-      "type": "test",
-      "which": "nonTable",
-      "withItems": true,
-      "what": "tables used for layout"
-    },
-    {
-      "type": "test",
-      "which": "radioSet",
-      "withItems": true,
-      "what": "grouping of radio buttons in fieldsets"
-    },
-    {
-      "type": "test",
-      "which": "role",
-      "what": "validity and necessity of role assignments"
-    },
-    {
-      "type": "test",
-      "which": "styleDiff",
-      "withItems": true,
-      "what": "style consistency of headings, buttons, and links"
-    },
-    {
-      "type": "test",
-      "which": "tabNav",
-      "withItems": true,
-      "what": "keyboard navigation within tab lists"
-    },
-    {
-      "type": "test",
-      "which": "titledEl",
-      "withItems": true,
-      "what": "title attributes on inappropriate elements"
-    },
-    {
-      "type": "test",
-      "which": "zIndex",
-      "withItems": true,
-      "what": "elements with non-auto z indexes"
-    },
-    {
-      "type": "test",
-      "which": "alfa",
-      "what": "Siteimprove alfa"
-    },
-    {
-      "type": "test",
-      "which": "axe",
-      "detailLevel": 2,
-      "rules": [],
-      "what": "Axe core, all rules"
-    },
-    {
-      "type": "test",
-      "which": "continuum",
-      "what": "Continuum"
-    },
-    {
-      "type": "test",
-      "which": "htmlcs",
-      "what": "HTML CodeSniffer"
-    },
-    {
-      "type": "test",
-      "which": "ibm",
-      "withItems": true,
-      "what": "IBM Accessibility Checker, with page content and again with URL"
-    },
-    {
-      "type": "test",
-      "which": "nuVal",
-      "what": "Nu Html Checker"
-    },
-    {
-      "type": "test",
-      "which": "wave",
-      "reportType": 4,
-      "what": "WAVE, report-type 4"
-    },
-    {
-      "type": "test",
-      "which": "tenon",
-      "id": "a",
-      "what": "Tenon API version 2 result retrieval"
-    }
-  ],
-  "sources": {
-    "script": "ts18",
-    "batch": "",
-    "host": {
-      "id": "example",
-      "which": "https://example.edu",
-      "what": "Example.com"
-    },
-    "requester": "user@domain.tld"
-  },
-  "jobCreationTime": "2022-11-12T22:51:45",
-  "timeStamp": "00000"
-}