testilo 12.3.1 → 13.2.0

package/README.md

@@ -181,8 +181,7 @@ The `batch()` function of the `batch` module generates a batch and returns it as
 A user can invoke `batch` in this way:
 
 - Create a target list and save it as a text file (with tab-delimited items in newline-delimited lines) in the `targetLists` subdirectory of the `process.env.SPECDIR` directory. Name the file `x.tsv`, where `x` is the list ID.
-- In the Testilo project directory, execute this statement:
-    - `node call batch i w`
+- In the Testilo project directory, execute the statement `node call batch i w`.
 
 In this statement, replace `i` with the list ID and `w` with a description of the batch.
 

package/call.js

@@ -58,7 +58,7 @@ const callBatch = async (listID, what) => {
 const callScript = async (scriptID, classificationID = null, ... issueIDs) => {
   // Get any issue classification.
   const issueClasses = classificationID
-  ? require(`${functionDir}/score/${classificationID}`)
+  ? require(`${functionDir}/score/${classificationID}`).issueClasses
   : null;
   // Create a script.
   const scriptObj = script(scriptID, issueClasses, ... issueIDs);
@@ -117,7 +117,8 @@ const callScore = async (scorerID, selector = '') => {
       // Save it.
       await fs.writeFile(`${scoredReportDir}/${report.id}.json`, JSON.stringify(report, null, 2));
     };
-  }
+    console.log(`Reports scored and saved in ${scoredReportDir}`);
+    }
   // Otherwise, i.e. if no raw reports are to be scored:
   else {
     // Report this.
@@ -132,17 +133,16 @@ const callDigest = async (digesterID, selector = '') => {
   if (reports.length) {
     const digesterDir = `${functionDir}/digest/${digesterID}`;
     // Get the digester.
-    const digester = require(`${digesterDir}/index`).makeQuery;
-    // Get the template.
-    const template = await fs.readFile(`${digesterDir}/index.html`, 'utf8');
+    const {digester} = require(`${digesterDir}/index`);
     // Digest the reports.
-    const digestedReports = digest(template, digester, reports);
+    const digestedReports = await digest(digester, reports);
     const digestedReportDir = `${reportDir}/digested`;
     // For each digested report:
     for (const reportID of Object.keys(digestedReports)) {
       // Save it.
       await fs.writeFile(`${digestedReportDir}/${reportID}.html`, digestedReports[reportID]);
     };
+    console.log(`Reports digested and saved in ${digestedReportDir}`);
   }
   // Otherwise, i.e. if no scored reports are to be digested:
   else {

package/digest.js

@@ -2,27 +2,19 @@
   digest.js
   Creates digests from a scored reports.
   Arguments:
-    0. Digest template.
-    1. Digesting function.
-    2. Array of scored reports.
+    0. Digesting function.
+    1. Array of scored reports.
 */
 
 // ########## FUNCTIONS
 
-// Replaces the placeholders in content with eponymous query parameters.
-const replaceHolders = (content, query) => content
-.replace(/__([a-zA-Z]+)__/g, (ph, qp) => query[qp]);
 // Digests the scored reports and returns them, digested.
-exports.digest = (digestTemplate, digester, reports) => {
+exports.digest = async (digester, reports) => {
   const digests = {};
-  // Create a query.
-  const query = {};
   // For each report:
   for (const report of reports) {
-    // Populate the query.
-    digester(report, query);
     // Use it to create a digest.
-    const digestedReport = replaceHolders(digestTemplate, query);
+    const digestedReport = await digester(report);
     // Add the digest to the array of digests.
     digests[report.id] = digestedReport;
     console.log(`Report ${report.id} digested`);

package/package.json

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

package/procs/digest/tdp27/index.html

@@ -22,28 +22,40 @@
           <tr><th>URL</th><td>__url__</td></tr>
           <tr><th>Requester</th><td>__requester__</td></tr>
           <tr><th>Test date</th><td>__dateSlash__</td></tr>
-          <tr><th>Score</th><td>__totalScore__</td></tr>
+          <tr><th>Score</th><td>__total__</td></tr>
           <tr><th>Tested by</th><td>Testaro, procedure <code>__ts__</code></td></tr>
           <tr><th>Scored by</th><td>Testilo, procedure <code>__sp__</code></td></tr>
           <tr><th>Digested by</th><td>Testilo, procedure <code>__dp__</code></td></tr>
         </table>
       </header>
       <h2>Introduction</h2>
-      <p>This is a digest of results from a battery of accessibility Tests.</p>
-      <p>The battery includes 1353 automated accessibility tests drawn from ten different packages: Alfa, Axe, Continuum, Equal Access, HTML CodeSniffer, Nu Html Checker, QualWeb, Tenon, Testaro, and WAVE.</p>
-      <p>These tests were run on the web page named above and gave the page a score of __totalScore__, where 0 would be <q>perfect</q>.</p>
-      <h2>Score summary</h2>
+      <p>This is a digest of results from a battery of accessibility tests.</p>
+      <p>The battery includes about 1350 tests drawn from ten different packages: Alfa, Axe, Continuum, Equal Access, HTML CodeSniffer, Nu Html Checker, QualWeb, Tenon, Testaro, and WAVE.</p>
+      <p>These tests were run on the web page named above and gave the page a score of __total__, where 0 would be <q>perfect</q>.</p>
+      <h2>Scores</h2>
       <table class="allBorder secondCellRight">
-        <caption>Score components</caption>
+        <caption>Score summary</caption>
+        <thead>
+          <tr><th>Component</th><th>Score</th></tr>
+        </thead>
         <tbody class="headersLeft">
-        __scoreRows__
+          <tr><th>total</th><td>__total__</td></tr>
+          <tr><th>issue</th><td>__issue__</td></tr>
+          <tr><th>tool</th><td>__tool__</td></tr>
+          <tr><th>prevention</th><td>__prevention__</td></tr>
+          <tr><th>log</th><td>__log__</td></tr>
+          <tr><th>latency</th><td>__latency__</td></tr>
+        </tbody>
+      </table>
+      <table class="allBorder secondCellRight">
+        <caption>Issue scores</caption>
+        <thead>
+          <tr><th>Issue</th><th>Score</th></tr>
+        </thead>
+        <tbody class="headersLeft">
+          __issueRows__
         </tbody>
       </table>
-      <h2>Issue summary</h2>
-      <h3>Special issues</h3>
-      __specialSummary__
-      <h3>Classified issues</h3>
-      __issueSummary__
       <h2>Complete report</h2>
       <pre>__report__</pre>
       <footer>

package/procs/digest/tdp27/index.js

@@ -1,11 +1,11 @@
-/*
-  index: digester for scoring procedure tsp24.
-  Creator of parameters for substitution into index.html.
-*/
+// index: digester for scoring procedure tsp27.
 
 // IMPORTS
 
+// Issue classification
 const {issueClasses} = require('../../score/tic27');
+// Function to process files.
+const fs = require('fs/promises');
 
 // CONSTANTS
 
@@ -21,21 +21,15 @@ const innerJoiner = '\n        ';
 const htmlEscape = textOrNumber => textOrNumber
 .toString()
 .replace(/&/g, '&')
-.replace(/</g, '&lt;');
+.replace(/</g, '&lt;')
+.replace(/"/g, '&quot;');
 // Gets a row of the score-summary table.
 const getScoreRow = (componentName, score) => `<tr><th>${componentName}</th><td>${score}</td></tr>`;
-// Gets the start of a paragraph about a special score.
-const getSpecialPStart = (summary, scoreID) =>
-`<p><span class="componentID">${scoreID}</span>: Score ${summary[scoreID]}.`;
 // Adds parameters to a query for a digest.
-exports.makeQuery = (report, query) => {
-  // Add an HTML-safe copy of the report to the query to be appended to the digest.
-  const {acts, sources, jobData, score} = report;
+const populateQuery = (report, query) => {
+  const {sources, jobData, score} = report;
   const {script, target, requester} = sources;
-  const reportJSON = JSON.stringify(report, null, 2);
-  const reportJSONSafe = htmlEscape(reportJSON);
-  query.report = reportJSONSafe;
-  const {scoreProcID, summary, issues} = score;
+  const {scoreProcID, summary, details} = score;
   const {total} = summary;
   query.ts = script;
   query.sp = scoreProcID;
@@ -46,37 +40,37 @@ exports.makeQuery = (report, query) => {
   query.org = target.what;
   query.url = target.which;
   query.requester = requester;
-  // Add the total score to the query.
-  if (typeof total === 'number') {
-    query.totalScore = total;
-  }
-  else {
-    console.log('ERROR: missing or invalid total score');
-    return;
-  }
-  // Get rows for a score-summary table.
-  const scoreRows = [];
+  // Add values for the score-summary table to the query.
+  ['total', 'issue', 'tool', 'prevention', 'log', 'latency'].forEach(sumItem => {
+    query[sumItem] = summary[sumItem];
+  });
+  const rows = {
+    summaryRows: [],
+    issueRows: []
+  };
   const componentIDs = ['issues', 'tools', 'preventions', 'log', 'latency'];
   ['total'].concat(componentIDs).forEach(itemID => {
     if (summary[itemID]) {
-      scoreRows.push(getScoreRow(itemID, summary[itemID]));
+      rows.summaryRows.push(getScoreRow(itemID, summary[itemID]));
     }
   });
-  // Add the issue rows to them.
-  Object.keys(issues).forEach(issueID => {
-    scoreRows.push(getScoreRow(issueID, issues[issueID]));
+  // Get rows for an issue-score table.
+  Object.keys(details.issue).forEach(issueID => {
+    rows.issueRows.push(getScoreRow(issueID, details.issue[issueID].score));
   });
   // Add the rows to the query.
-  query.scoreRows = scoreRows.join(innerJoiner);
-  // Add paragraphs about them for the issue summary to the query.
+  ['summaryRows', 'issueRows'].forEach(rowType => {
+    query[rowType] = rows[rowType].join(innerJoiner);
+  });
+  // Add paragraphs about the issues to the query.
   const issueSummaryItems = [];
-  Object.keys(issues).forEach(issueID => {
+  Object.keys(details.issue).forEach(issueID => {
     const issueHeading = `<h4>Issue ${issueID}</h4>`;
     const wcagP = `<p>WCAG: ${issueClasses[issueID].wcag || 'N/A'}</p>`;
-    const scoreP = `<p>Score: ${issues[issueID]}</p>`;
+    const scoreP = `<p>Score: ${details.issue[issueID]}</p>`;
     const issueIntroP = '<p>Issue reports in this category:</p>';
     const issueListItems = [];
-    const issueData = issueDetails.issues[issueName];
+    const issueData = details.issue[issueID];
     const toolIDs = Object.keys(issueData.tools);
     toolIDs.forEach(toolID => {
       const testIDs = Object.keys(issueData.tools[toolID]);
@@ -96,4 +90,22 @@ exports.makeQuery = (report, query) => {
     issueSummaryItems.push(issueHeading, wcagP, scoreP, issueIntroP, issueList);
   });
   query.issueSummary = issueSummaryItems.join(joiner);
+  // Add an HTML-safe copy of the report to the query to be appended to the digest.
+  const reportJSON = JSON.stringify(report, null, 2);
+  const reportJSONSafe = htmlEscape(reportJSON);
+  query.report = reportJSONSafe;
+};
+// Returns a digested report.
+exports.digester = async report => {
+  // Create a query to replace plateholders.
+  const query = {};
+  populateQuery(report, query);
+  // Get the template.
+  let template = await fs.readFile(`${__dirname}/index.html`, 'utf8');
+  // Replace its placeholders.
+  Object.keys(query).forEach(param => {
+    template = template.replace(new RegExp(`__${param}__`, 'g'), query[param]);
+  });
+  // Return the digest.
+  return template;
 };

package/procs/score/tic27.js

@@ -2577,13 +2577,6 @@ exports.issueClasses = {
           quality: 1,
           what: 'role attribute has an invalid value'
         }
-      },
-      testaro: {
-        'role-bad': {
-          variable: false,
-          quality: 0.5,
-          what: 'Nonexistent or implicit-overriding role'
-        }
       }
     }
   },
@@ -2621,10 +2614,10 @@ exports.issueClasses = {
         }
       },
       testaro: {
-        'role-redundant': {
+        'role': {
           variable: false,
           quality: 1,
-          what: 'Redundant role'
+          what: 'Invalid, native-replacing, or redundant role'
         }
       }
     }
@@ -4696,13 +4689,6 @@ exports.issueClasses = {
           what: 'Form control has no accessible name'
         }
       },
-      testaro: {
-        'labClash-unlabeled': {
-          variable: false,
-          quality: 1,
-          what: 'Button, input, select, or textarea is unlabeled'
-        }
-      },
       wave: {
         'label_missing': {
           variable: false,
@@ -4967,23 +4953,10 @@ exports.issueClasses = {
         }
       },
       testaro: {
-        'focInd-missing': {
+        'focInd': {
           variable: false,
           quality: 1,
-          what: 'Focused element displays no focus indicator'
-        }
-      }
-    }
-  },
-  focusIndicationBad: {
-    wcag: '2.4.7',
-    weight: 3,
-    tools: {
-      testaro: {
-        'focInd-nonoutline': {
-          variable: false,
-          quality: 1,
-          what: 'Focused element displays a nostandard focus indicator'
+          what: 'Focused element displays a nonstandard or no focus indicator'
         }
       }
     }
@@ -5438,15 +5411,10 @@ exports.issueClasses = {
     weight: 3,
     tools: {
       testaro: {
-        'focOp-focusable-inoperable': {
+        'focOp': {
           variable: false,
           quality: 1,
-          what: 'Tab-focusable elements that are inoperable'
-        },
-        'focOp-operable-nonfocusable': {
-          variable: false,
-          quality: 1,
-          what: 'Operable elements that cannot be Tab-focused'
+          what: 'Tab-focusable elements that are inoperable or operable elements that are not focusable'
         }
       }
     }
@@ -5645,12 +5613,12 @@ exports.issueClasses = {
       }
     }
   },
-  hoverImpact: {
+  hoverSurprise: {
     wcag: '1.4.13',
     weight: 3,
     tools: {
       testaro: {
-        'hover-impactTriggers': {
+        'hover': {
           variable: false,
           quality: 1,
           what: 'Hovering over element has unexpected effects'
@@ -5658,71 +5626,6 @@ exports.issueClasses = {
       }
     }
   },
-  unhoverable: {
-    wcag: '1.4.13',
-    weight: 3,
-    tools: {
-      testaro: {
-        'hover-unhoverables': {
-          variable: false,
-          quality: 1,
-          what: 'Operable element cannot be hovered over'
-        }
-      }
-    }
-  },
-  hoverNoCursor: {
-    wcag: '1.4.13',
-    weight: 3,
-    tools: {
-      testaro: {
-        'hover-noCursors': {
-          variable: false,
-          quality: 1,
-          what: 'Hoverable element hides the mouse cursor'
-        }
-      }
-    }
-  },
-  hoverBadCursor: {
-    wcag: '1.4.13',
-    weight: 2,
-    tools: {
-      testaro: {
-        'hover-badCursors': {
-          variable: false,
-          quality: 1,
-          what: 'Link or button makes the hovering mouse cursor nonstandard'
-        }
-      }
-    }
-  },
-  hoverNoIndicator: {
-    wcag: '1.4.13',
-    weight: 3,
-    tools: {
-      testaro: {
-        'hover-noCursors': {
-          variable: false,
-          quality: 1,
-          what: 'Button shows no indication of being hovered over'
-        }
-      }
-    }
-  },
-  hoverBadIndicator: {
-    wcag: '1.4.13',
-    weight: 2,
-    tools: {
-      testaro: {
-        'hover-noCursors': {
-          variable: false,
-          quality: 1,
-          what: 'List item changes when hovered over'
-        }
-      }
-    }
-  },
   labelClash: {
     wcag: '1.3.1',
     weight: 2,
@@ -5735,7 +5638,7 @@ exports.issueClasses = {
         }
       },
       testaro: {
-        'labClash-mislabeled': {
+        'labClash': {
           variable: false,
           quality: 1,
           what: 'Incompatible label types'

package/procs/score/tsp27.js

@@ -63,23 +63,32 @@ exports.scorer = report => {
         scoreProcID,
         summary: {
           total: 0,
-          issues: 0,
-          tools: 0,
-          preventions: 0,
+          issue: 0,
+          tool: 0,
+          prevention: 0,
           log: 0,
           latency: 0
         },
-        toolTotals: [0, 0, 0, 0],
-        issues: {},
-        tools: {},
-        preventions: {}
+        details: {
+          severity: {
+            total: [0, 0, 0, 0],
+            byTool: {}
+          },
+          prevention: {},
+          issue: {}
+        }
       };
-      const {summary, toolTotals, issues, tools, preventions} = score;
+      const {summary, details} = score;
       // For each test act:
       testActs.forEach(act => {
-        // If a successful standard result exists:
+        // If the page prevented the tool from operating:
         const {which, standardResult} = act;
-        if (
+        if (standardResult.prevented) {
+          // Add this to the score.
+          details.prevention[which] = preventionWeight;
+        }
+        // Otherwise, if a successful standard result exists:
+        else if (
           standardResult
           && standardResult.totals
           && standardResult.totals.length === 4
@@ -87,16 +96,11 @@ exports.scorer = report => {
         ) {
           // Add the severity totals of the tool to the score.
           const {totals} = standardResult;
-          tools[which] = totals;
-          toolTotals.forEach((total, index) => {
-            toolTotals[index] += totals[index];
-          });
-          // Update the issue totals for the tool.
-          const issueTotals = {};
-          let ruleID;
+          details.severity.byTool[which] = totals;
+          // Add the instance data of the tool to the score.
           standardResult.instances.forEach(instance => {
-            ruleID = issueIndex[which][instance.ruleID];
-            if (! ruleID) {
+            let {ruleID} = instance;
+            if (! issueIndex[which][ruleID]) {
               ruleID = issueMatcher.find(pattern => {
                 const patternRE = new RegExp(pattern);
                 return patternRE.test(instance.ruleID);
@@ -104,40 +108,92 @@ exports.scorer = report => {
             }
             if (ruleID) {
               const issueID = issueIndex[which][ruleID];
-              if (! issueTotals[issueID]) {
-                issueTotals[issueID] = 0;
+              if (! details.issue[issueID]) {
+                details.issue[issueID] = {
+                  score: 0,
+                  maxCount: 0,
+                  weight: issueClasses[issueID].weight,
+                  tools: {}
+                };
+              }
+              if (! details.issue[issueID].tools[which]) {
+                details.issue[issueID].tools[which] = {};
+              }
+              if (! details.issue[issueID].tools[which][ruleID]) {
+                details.issue[issueID].tools[which][ruleID] = {
+                  quality: issueClasses[issueID].tools[which][ruleID].quality,
+                  complaints: {
+                    countTotal: 0,
+                    texts: []
+                  }
+                };
+              }
+              details
+              .issue[issueID]
+              .tools[which][ruleID]
+              .complaints
+              .countTotal += instance.count || 1;
+              if (
+                ! details
+                .issue[issueID]
+                .tools[which][ruleID]
+                .complaints
+                .texts
+                .includes(instance.what)
+              ) {
+                details.issue[issueID].tools[which][ruleID].complaints.texts.push(instance.what);
               }
-              issueTotals[issueID] += instance.count || 1;
             }
             else {
               console.log(`ERROR: ${instance.ruleID} of ${which} not found in issueClasses`);
             }
           });
-          // Update the issue totals in the score.
-          Object.keys(issueTotals).forEach(issueID => {
-            issues[issueID] = Math.max(issues[id] || 0, issueTotals[issueID]);
-          });
-          summary.issues = Object.values(issues).reduce((total, current) => total + current);
         }
-        // Otherwise, i.e. if no no successful result exists:
+        // Otherwise, i.e. if no successful standard result exists:
         else {
-          // Add a prevented result to the act if not already there.
-          if (! act.result) {
-            act.result = {};
-          }
-          if (! act.result.prevented) {
-            act.result.prevented = true;
-          };
-          // Add the tool and the prevention score to the score.
-          preventions[which] = preventionWeight;
-          summary.preventions += preventionWeight;
+          // Add an inferred prevention to the score.
+          details.prevention[which] = preventionWeight;
         }
       });
-      // Add the weighted tool total to the score.
-      summary.tools = toolWeight * toolTotals.reduce(
-        (total, current, index) => total + current * severityWeights[index], 0
+      // For each issue with any complaints:
+      Object.keys(details.issue).forEach(issueID => {
+        const issueData = details.issue[issueID];
+        // For each tool with any complaints for the issue:
+        Object.keys(issueData.tools).forEach(toolID => {
+          // Get the sum of the weighted counts of its issue rules.
+          let weightedCount = 0;
+          Object.values(issueData.tools[toolID]).forEach(ruleData => {
+            weightedCount += ruleData.quality * ruleData.complaints.countTotal;
+          });
+          // If the sum exceeds the existing maximum weighted count for the issue:
+          if (weightedCount > issueData.maxCount) {
+            // Change the maximum count for the issue to the sum.
+            issueData.maxCount = weightedCount;
+          }
+        });
+        // Get the score for the issue.
+        issueData.score = issueData.weight * issueData.maxCount;
+      });
+      // Add the severity detail totals to the score.
+      details.severity.total = Object.keys(details.severity.byTool).reduce((severityTotals, toolID) => {
+        details.severity.byTool[toolID].forEach((severityScore, index) => {
+          severityTotals[index] += severityScore;
+        });
+        return severityTotals;
+      }, details.severity.total);
+      // Add the summary issue total to the score.
+      summary.issue = Object
+      .values(details.issue)
+      .reduce((total, current) => total + current.score, 0);
+      // Add the summary tool total to the score.
+      summary.tool = toolWeight * details.severity.total.reduce(
+        (total, current, index) => total + severityWeights[index] * current, 0
+      );
+      // Add the summary prevention total to the score.
+      summary.prevention = Object.values(details.prevention).reduce(
+        (total, current) => total + current, 0
       );
-      // Add the log score to the score.
+      // Add the summary log score to the score.
       const {jobData} = report;
       summary.log = Math.max(0, Math.round(
         logWeights.logCount * jobData.logCount
@@ -147,21 +203,21 @@ exports.scorer = report => {
         + logWeights.prohibitedCount * jobData.prohibitedCount +
         + logWeights.visitRejectionCount * jobData.visitRejectionCount
       ));
-      // Add the latency score to the score.
+      // Add the summary latency score to the score.
       summary.latency = Math.round(
         latencyWeight * (Math.max(0, jobData.visitLatency - normalLatency))
       );
-      // Round the scores.
+      // Round the unrounded scores.
       Object.keys(summary).forEach(summaryTypeName => {
         summary[summaryTypeName] = Math.round(summary[summaryTypeName]);
       });
-      toolTotals.forEach((severityTotal, index) => {
-        toolTotals[index] = Math.round(toolTotals[index]);
+      details.severity.total.forEach((severityTotal, index) => {
+        details.severity.total[index] = Math.round(severityTotal);
       });
-      // Add the total score to the score.
-      summary.total = summary.issues
-      + summary.tools
-      + summary.preventions
+      // Add the summary total score to the score.
+      summary.total = summary.issue
+      + summary.tool
+      + summary.prevention
       + summary.log
       + summary.latency;
       // Add the score to the report.