testaro 28.2.5 → 29.0.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/package.json

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

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/tests/testaro.js

@@ -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: