testilo 12.2.2 → 12.3.1

package/README.md

@@ -196,6 +196,8 @@ Testilo classifies issues. The built-in issue classifications are located in the
 
 If you want Testaro to test targets for particular issues, you can name those issues and use the Testilo `script` module to create a script.
 
+If you want Testaro to test targets for **all** the rules of all the available tools, without regard to any issue classification, you can use the `script` module to create a script that does not impose any issue restrictions.
+
 #### Invocation
 
 There are two ways to use the `script` module.
@@ -216,6 +218,13 @@ This invocation references `scriptID`, `issueClasses`, and `issueID` variables.
 
 The `script()` function of the `script` module generates a script and returns it as an object. The invoking module can further dispose of the script as needed.
 
+To create a script without issue restrictions, a module can use this invocation:
+
+```javaScript
+const {script} = require('testilo/script');
+const scriptObj = script(scriptID);
+```
+
 ##### By a user
 
 A user can invoke `script` in this way: In the Testilo project directory, execute the statement `node call script s c i0 i1 i2 i3 …`.
@@ -229,6 +238,8 @@ The `call` module will retrieve the named classification from its directory.
 The `script` module will create a script.
 The `call` module will save the script as a JSON file in the `scripts` subdirectory of the `process.env.SPECDIR` directory.
 
+To create a script without any issue restrictions, a user can execute the statement `node call script s`.
+
 #### Options
 
 When the `script` module creates a script for you, it does not ask you for all of the options that the script may require. Instead, it chooses options. After you invoke `script`, you can edit the script that it creates to revise options.

package/call.js

@@ -55,9 +55,11 @@ const callBatch = async (listID, what) => {
   console.log(`Target list ${listID} converted to a batch and saved in ${specDir}/batches`);
 };
 // Fulfills a script-creation request.
-const callScript = async (scriptID, classificationID, ... issueIDs) => {
-  // Get the issue classification.
-  const {issueClasses} = require(`${functionDir}/score/${classificationID}`);
+const callScript = async (scriptID, classificationID = null, ... issueIDs) => {
+  // Get any issue classification.
+  const issueClasses = classificationID
+  ? require(`${functionDir}/score/${classificationID}`)
+  : null;
   // Create a script.
   const scriptObj = script(scriptID, issueClasses, ... issueIDs);
   // Save the script.
@@ -176,7 +178,7 @@ else if (fn === 'batch' && fnArgs.length === 2) {
     console.log('Execution completed');
   });
 }
-else if (fn === 'script' && fnArgs.length > 2) {
+else if (fn === 'script' && fnArgs.length) {
   callScript(... fnArgs)
   .then(() => {
     console.log('Execution completed');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "12.2.2",
+  "version": "12.3.1",
   "description": "Client that scores and digests Testaro reports",
   "main": "aim.js",
   "scripts": {

package/script.js

@@ -1,6 +1,6 @@
 /*
   script.js
-  Creates and returns a script for specified issues.
+  Creates and returns a script.
   Arguments:
     0. issue classification
     1. issue IDs
@@ -11,57 +11,66 @@
 // Module to keep secrets.
 require('dotenv').config();
 
+// ########## VARIABLES
+
+let toolIDs = [
+  'alfa', 'axe', 'continuum', 'htmlcs', 'ibm', 'nuVal', 'qualWeb', 'tenon', 'testaro', 'wave'
+];
+
 // ########## FUNCTIONS
 
 // Creates and returns a script.
-exports.script = (id, issueClasses, ... issueIDs) => {
-  // Initialize data on the tests for the specified issues.
+exports.script = (id, issueClasses = null, ... issueIDs) => {
+  // Initialize data on the tools and rules for the specified issues.
   const neededTools = {};
-  // For each specified issue:
-  issueIDs.forEach(issueID => {
-    // If it exists in the classification:
-    const issueData = issueClasses[issueID];
-    if (issueData) {
-      // For each tool that tests for the issue:
-      const issueToolIDs = Object.keys(issueData.tools);
-      issueToolIDs.forEach(issueToolID => {
-        // For each of the rules of the tool for the issue:
-        if (! neededTools[issueToolID]) {
-          neededTools[issueToolID] = [];
-        }
-        Object.keys(issueData.tools[issueToolID]).forEach(ruleID => {
-          // Add data on the rule.
-          const ruleData = issueData.tools[issueToolID][ruleID];
-          if (issueToolID === 'nuVal') {
-            if (ruleData.variable) {
-              neededTools[issueToolID].push(`~${ruleID}`);
+  // If an issue classification and any issues were specified:
+  if (issueClasses && issueIDs.length) {
+    // For each specified issue:
+    issueIDs.forEach(issueID => {
+      // If it exists in the classification:
+      const issueData = issueClasses[issueID];
+      if (issueData) {
+        // For each tool that tests for the issue:
+        const issueToolIDs = Object.keys(issueData.tools);
+        issueToolIDs.forEach(issueToolID => {
+          // For each of the rules of the tool for the issue:
+          if (! neededTools[issueToolID]) {
+            neededTools[issueToolID] = [];
+          }
+          Object.keys(issueData.tools[issueToolID]).forEach(ruleID => {
+            // Add data on the rule.
+            const ruleData = issueData.tools[issueToolID][ruleID];
+            if (issueToolID === 'nuVal') {
+              if (ruleData.variable) {
+                neededTools[issueToolID].push(`~${ruleID}`);
+              }
+              else {
+                neededTools[issueToolID].push(`=${ruleID}`);
+              }
             }
             else {
-              neededTools[issueToolID].push(`=${ruleID}`);
+              neededTools[issueToolID].push(ruleID);
             }
-          }
-          else {
-            neededTools[issueToolID].push(ruleID);
-          }
+          });
         });
-      });
-    }
-    // Otherwise, i.e. if it does not exist in the classification:
-    else {
-      // Report this.
-      console.log(`ERROR: Issue ${issueID} not in issue classification`);
-      return {};
-    }
-  });
-  // If any tests have been identified:
-  const toolIDs = Object.keys(neededTools);
+        toolIDs = Object.keys(neededTools);
+      }
+      // Otherwise, i.e. if it does not exist in the classification:
+      else {
+        // Report this.
+        console.log(`ERROR: Issue ${issueID} not in issue classification`);
+        return {};
+      }
+    });
+  }
+  // If any rules have been identified:
   if (toolIDs.length) {
     // Initialize a script.
     const scriptObj = {
       id,
       what: `accessibility tests`,
       strict: true,
-      timeLimit: 30 + 2 * issueIDs.length,
+      timeLimit: 30 + (10 * issueIDs.length || 30 * toolIDs.length),
       acts: [
         {
           "type": "placeholder",
@@ -77,7 +86,7 @@ exports.script = (id, issueClasses, ... issueIDs) => {
         type: 'tenonRequest',
         id: 'a',
         withNewContent: false,
-        what: 'Tenon API version 2 test request, with URL'
+        what: 'Tenon API version 2 test request, with page content'
       });
     }
     // For each identified tool:
@@ -85,13 +94,17 @@ exports.script = (id, issueClasses, ... issueIDs) => {
       // Initialize a test act for it.
       const toolAct = {
         type: 'test',
-        which: toolID,
-        rules: neededTools[toolID]
+        which: toolID
       };
-      // If the tool is Testaro:
-      if (toolID === 'testaro') {
-        // Prepend the inclusion option to the rule array.
-        toolAct.rules.unshift('y');
+      // If rules were specified:
+      if (issueClasses && issueIDs.length) {
+        // Add a rules property to the act.
+        toolAct.rules = neededTools[toolID];
+        // If the tool is Testaro:
+        if (toolID === 'testaro') {
+          // Prepend the inclusion option to the rule array.
+          toolAct.rules.unshift('y');
+        }
       }
       // Add option specifications if necessary.
       if (toolID === 'axe') {
@@ -119,10 +132,10 @@ exports.script = (id, issueClasses, ... issueIDs) => {
     // Return the script.
     return scriptObj;
   }
-  // Otherwise, i.e. if no tests have been identified:
+  // Otherwise, i.e. if no rules have been identified:
   else {
     // Report this.
-    console.log(`ERROR: No tests for the specified issues found`);
+    console.log(`ERROR: No rules for the specified issues found`);
     return {};
   }
 };