testaro 28.2.5 → 29.1.0

package/README.md

@@ -221,7 +221,7 @@ Testaro helps overcome this format diversity by offering to represent the main f
 
 In the conceptual scheme underlying the format standardization of Testaro, each tool has its own set of _rules_, where a rule is an algorithm for evaluating a target and determining whether instances of some kind of problem exist in it. With standardization, Testaro reports, in a uniform way, the outcomes from the application of rules by tools to a target.
 
-If the `STANDARD` environment variable has the value `also` (which it has by default) or `only`, Testaro converts some data in each tool report to the standard format. That permits you to ignore the format idiosyncrasies of the tools. If `STANDARD` has the value `also`, the job report includes both formats. If the value is `only`, the job report includes only the standard format. If the value is `no`, the job report includes only the original format of each tool report.
+Each job can specify how Testaro is to handle report standardization. A job can contain a `standard` property. If the value of that property is `'also'` or `'only'`, Testaro converts some data in each tool report to the standard format. That permits you to ignore the format idiosyncrasies of the tools. If `standard` has the value `'also'`, the job report includes both formats. If the value is `'only'`, the job report includes only the standard format. If the value is `'no'` (or anything else, or there is no `standard` property), the job report includes only the original format of each tool report.
 
 The standard format of each tool report has these properties:
 - `prevented`: `true` if the tool failed to run on the page, or otherwise omitted.

package/data/template.js

@@ -13,7 +13,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body a');
+  const all = await init(100, page, 'body a');
   // For each locator:
   for (const loc of all.allLocs) {
     // Get whether its element violates the rule.

package/package.json

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

package/procs/testaro.js

@@ -7,14 +7,10 @@ const {getSample} = require('../procs/sample');
 // Module to get locator data.
 const {getLocatorData} = require('../procs/getLocatorData');
 
-// ########## CONSTANTS
-
-const sampleMax = 100;
-
 // ########## FUNCTIONS
 
 // Initializes locators and a result.
-const init = async (page, locAllSelector, options = {}) => {
+const init = async (sampleMax, page, locAllSelector, options = {}) => {
   // Get locators for the specified elements.
   const locPop = page.locator(locAllSelector, options);
   const locPops = await locPop.all();
@@ -98,7 +94,7 @@ const simplify = async (page, withItems, ruleData) => {
     ruleID, selector, pruner, isDestructive, complaints, ordinalSeverity, summaryTagName
   } = ruleData;
   // Initialize the locators and result.
-  const all = await init(page, selector);
+  const all = await init(100, page, selector);
   // For each locator:
   for (const loc of all.allLocs) {
     // Get whether its element violates the rule.

package/run.js

@@ -22,8 +22,6 @@ const {tellServer} = require('./procs/tellServer');
 const debug = process.env.DEBUG === 'true';
 // Set WAITS environment variable to a positive number to insert delays (in ms).
 const waits = Number.parseInt(process.env.WAITS) || 0;
-// Set STANDARD environment variable to also if not set.
-process.env.STANDARD ??= 'also';
 // CSS selectors for targets of moves.
 const moves = {
   button: 'button, [role=button], input[type=submit]',
@@ -732,7 +730,7 @@ const doActs = async (report, actIndex, page) => {
             const resultCount = Object.keys(toolReport.result).length;
             act.result = resultCount ? toolReport.result : {success: false};
             // If a standard-format result is to be included in the report:
-            const standard = process.env.STANDARD;
+            const standard = report.standard || 'only';
             if (['also', 'only'].includes(standard)) {
               // Initialize it.
               act.standardResult = {
@@ -743,7 +741,11 @@ const doActs = async (report, actIndex, page) => {
               standardize(act);
               // If the original-format result is not to be included in the report:
               if (standard === 'only') {
-                // Remove it.
+                // Remove it, except any important property.
+                if (act.result.important) {
+                  act.data = act.result.important;
+                  console.log('>>>>>> Important result data protected from deletion');
+                }
                 delete act.result;
               }
               // If the test has expectations:

package/testaro/attVal.js

@@ -13,7 +13,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems, attributeName, areLicit, values) => {
   // Initialize the locators and result.
-  const all = await init(page, `[${attributeName}]`);
+  const all = await init(100, page, `[${attributeName}]`);
   // For each locator:
   for (const loc of all.allLocs) {
     // Get whether its element violates the rule.

package/testaro/autocomplete.js

@@ -21,7 +21,7 @@ exports.reporter = async (
   emailLabels = ['email']
 ) => {
   // Initialize the locators and result.
-  const all = await init(page, 'input[type=text], input[type=email], input:not([type])');
+  const all = await init(100, page, 'input[type=text], input[type=email], input:not([type])');
   // For each locator:
   const autoValues = {
     'given-name': givenLabels,

package/testaro/embAc.js

@@ -17,7 +17,9 @@ const {init, report} = require('../procs/testaro');
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
   const all = await init(
-    page, 'a a, a button, a input, a select, button a, button button, button input, button select'
+    100,
+    page,
+    'a a, a button, a input, a select, button a, button button, button input, button select'
   );
   // For each locator:
   for (const loc of all.allLocs) {

package/testaro/focInd.js

@@ -27,7 +27,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body *:visible');
+  const all = await init(100, page, 'body *:visible');
   all.result.data.focusableCount = 0;
   // For each locator:
   for (const loc of all.allLocs) {

package/testaro/focOp.js

@@ -22,7 +22,7 @@ const {isOperable} = require('../procs/operable');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body *');
+  const all = await init(100, page, 'body *');
   all.result.data.focusableCount = 0;
   // For each locator:
   for (const loc of all.allLocs) {

package/testaro/focVis.js

@@ -14,7 +14,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'a:visible');
+  const all = await init(100, page, 'a:visible');
   // For each locator:
   for (const loc of all.allLocs) {
     // Get how its element violates the rule, if it does.

package/testaro/hover.js

@@ -19,9 +19,10 @@ const {init, report} = require('../procs/testaro');
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
   const allTrigger = await init(
-    page, '[aria-controls], [aria-expanded], [aria-haspopup], [onmouseenter], [onmouseover]'
+    20, page, '[aria-controls], [aria-expanded], [aria-haspopup], [onmouseenter], [onmouseover]'
   );
   const allNonTrigger = await init(
+    30 - allTrigger.result.data.sampleSize,
     page,
     'body *:not([aria-controls], [aria-expanded], [aria-haspopup], [onmouseenter], [onmouseover])'
   );
@@ -64,8 +65,7 @@ exports.reporter = async (page, withItems) => {
         all.locs.push([loc, impact]);
       }
     }
-    catch(error) {
-    }
+    catch(error) {}
   }
   // Populate and return the result.
   const whats = [

package/testaro/labClash.js

@@ -13,7 +13,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'button, input:not([type=hidden]), select, textarea');
+  const all = await init(100, page, 'button, input:not([type=hidden]), select, textarea');
   // For each locator:
   for (const loc of all.allLocs) {
     // Get the label types of its element.

package/testaro/lineHeight.js

@@ -15,7 +15,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body *', {hasText: /[^\s]/});
+  const all = await init(100, page, 'body *', {hasText: /[^\s]/});
   // For each locator:
   for (const loc of all.allLocs) {
     // Get whether its element violates the rule.

package/testaro/linkAmb.js

@@ -15,7 +15,7 @@ const {getLocatorData} = require('../procs/getLocatorData');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'a[href]:visible');
+  const all = await init(100, page, 'a[href]:visible');
   const linkTexts = new Set();
   // For each locator:
   for (const loc of all.allLocs) {

package/testaro/miniText.js

@@ -13,7 +13,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body *:not(script, style):visible', {hasText: /[^\s]+/});
+  const all = await init(100, page, 'body *:not(script, style):visible', {hasText: /[^\s]+/});
   // For each locator:
   for (const loc of all.allLocs) {
     // Get the font size of its element if less than 11 pixels.

package/testaro/opFoc.js

@@ -22,7 +22,7 @@ const {isOperable} = require('../procs/operable');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body *');
+  const all = await init(100, page, 'body *');
   all.result.data.operableCount = 0;
   // For each locator:
   for (const loc of all.allLocs) {

package/testaro/pseudoP.js

@@ -15,7 +15,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body br + br');
+  const all = await init(100, page, 'body br + br');
   // For each locator:
   for (const loc of all.allLocs) {
     // Return whether the second br element violates the rule.

package/testaro/radioSet.js

@@ -15,7 +15,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'input[type=radio]');
+  const all = await init(100, page, 'input[type=radio]');
   const params = {
     nameLeak: 'shares a name with others outside its field set',
     fsMixed: 'shares a field set with others having different names',

package/testaro/targetSize.js

@@ -16,7 +16,7 @@ const {isInlineLink} = require('../procs/isInlineLink');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'a, button, input');
+  const all = await init(100, page, 'a, button, input');
   // For each locator:
   for (const loc of all.allLocs) {
     // Get the size of its element, if small.

package/testaro/zIndex.js

@@ -18,7 +18,7 @@ const {init, report} = require('../procs/testaro');
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
-  const all = await init(page, 'body *');
+  const all = await init(100, page, 'body *');
   // For each locator:
   for (const loc of all.allLocs) {
     // Get whether its element violates the rule.

package/tests/testaro.js

@@ -88,7 +88,7 @@ const jsonTest = async (ruleID, ruleArgs) => {
   const ruleJSON = await fs.readFile(`${__dirname}/../testaro/${ruleID}.json`, 'utf8');
   const ruleObj = JSON.parse(ruleJSON);
   // Initialize the locators and result.
-  const all = await init(page, ruleObj.selector);
+  const all = await init(100, page, ruleObj.selector);
   all.locs = all.allLocs;
   // Populate and return the result.
   const whats = [
@@ -107,9 +107,11 @@ exports.reporter = async (page, options) => {
   // Initialize the data.
   const data = {
     rules: {},
-    preventions: [],
-    invalid: [],
-    testTimes: {}
+    important: {
+      preventions: [],
+      invalid: [],
+      testTimes: {}
+    }
   };
   // If the rule specification is valid:
   if (
@@ -163,7 +165,7 @@ exports.reporter = async (page, options) => {
           });
           data.rules[rule].totals = data.rules[rule].totals.map(total => Math.round(total));
           if (ruleReport.prevented) {
-            data.preventions.push(rule);
+            data.important.preventions.push(rule);
           }
           // If testing is to stop after a failure and the page failed the test:
           if (stopOnFail && ruleReport.totals.some(total => total)) {
@@ -174,19 +176,19 @@ exports.reporter = async (page, options) => {
         // If an error is thrown by the test:
         catch(error) {
           // Report this.
-          data.preventions.push(rule);
+          data.important.preventions.push(rule);
           console.log(`ERROR: Test of testaro rule ${rule} prevented (${error.message})`);
         }
       }
       // Otherwise, i.e. if the rule is undefined or doubly defined:
       else {
         // Report this.
-        data.invalid.push(rule);
+        data.important.invalid.push(rule);
         console.log(`ERROR: Rule ${rule} not validly defined`);
       }
     }
     testTimes.sort((a, b) => b[1] - a[1]).forEach(pair => {
-      data.testTimes[pair[0]] = pair[1];
+      data.important.testTimes[pair[0]] = pair[1];
     });
   }
   // Otherwise, i.e. if the rule specification is invalid: