testaro 12.1.0 → 12.2.0

package/actSpecs.js

@@ -308,6 +308,7 @@ exports.actSpecs = {
     qualWeb: [
       'Perform a qualWeb test',
       {
+        withNewContent: [true, 'boolean', '', 'whether to use a URL instead of page content'],
         rules: [false, 'array', 'areStrings', 'QualWeb or ACT IDs of ACT rules to include, if not all']
       }
     ],

package/package.json

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

package/tests/qualWeb.js

@@ -5,21 +5,18 @@
 // IMPORTS
 const {QualWeb} = require('@qualweb/core');
 // CONSTANTS
-const qualweb = new QualWeb({});
+const qualWeb = new QualWeb({});
 const clusterOptions = {
   timeout: 25 * 1000
 };
 // FUNCTIONS
 // Conducts and reports a QualWeb test.
-exports.reporter = async (page, rules = null) => {
+exports.reporter = async (page, withNewContent, rules = null) => {
   // Initialize the report.
-  let data = {};
   // Start the QualWeb core engine.
-  await qualweb.start(clusterOptions);
+  await qualWeb.start(clusterOptions);
   // Specify the page.
-  const html = await page.content();
-  const qualwebOptions = {
-    html,
+  const qualWebOptions = {
     log: {
       console: true
     },
@@ -41,24 +38,33 @@ exports.reporter = async (page, rules = null) => {
       exclude: []
     }
   };
+  if (withNewContent) {
+    qualWebOptions.url = page.url();
+  }
+  else {
+    qualWebOptions.html = await page.content();
+  }
   if (rules) {
-    qualwebOptions['act-rules'].rules = rules;
+    qualWebOptions['act-rules'].rules = rules;
   }
   else {
-    qualwebOptions['act-rules'].levels = ['A', 'AA', 'AAA'];
-    qualwebOptions['act-rules'].principles = [
+    qualWebOptions['act-rules'].levels = ['A', 'AA', 'AAA'];
+    qualWebOptions['act-rules'].principles = [
       'Perceivable', 'Operable', 'Understandable', 'Robust'
     ];
   }
   // Get the report.
-  const reports = await qualweb.evaluate(qualwebOptions);
-  // Prepare to trim its ACT rules and WCAG Techniques section.
-  delete reports.customHtml.system.page.dom;
+  let reports = await qualWeb.evaluate(qualWebOptions);
+  // Remove the copy of the DOM from it.
+  let report = reports[withNewContent ? qualWebOptions.url : 'customHtml'];
+  delete report.system.page.dom;
+  // For each section of the report:
   ['act-rules', 'wcag-techniques', 'best-practices'].forEach(module => {
-    const {assertions} = reports.customHtml.modules[module];
+    // For each test:
+    const {assertions} = report.modules[module];
     const ruleIDs = Object.keys(assertions);
     ruleIDs.forEach(ruleID => {
-      // Remove passing customHtml results.
+      // Remove passing results.
       const ruleAssertions = assertions[ruleID];
       const {metadata} = ruleAssertions;
       if (metadata) {
@@ -88,17 +94,17 @@ exports.reporter = async (page, rules = null) => {
     });
   });
   // Stop the QualWeb core engine.
-  await qualweb.stop();
+  await qualWeb.stop();
   // Return the result.
   try {
-    JSON.stringify(data);
+    JSON.stringify(reports);
   }
   catch(error) {
     console.log(`ERROR: qualWeb result cannot be made JSON (${error.message})`);
-    data = {
+    report = {
       prevented: true,
       error: `ERROR: qualWeb result cannot be made JSON (${error.message})`
     };
   }
-  return {result: reports};
+  return {result: report};
 };

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"
-}