testilo 12.1.0 → 12.2.0

package/package.json

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

package/procs/digest/tdp24/index.html

@@ -29,9 +29,9 @@
         </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>This is a digest of results from 1353 automated accessibility tests drawn from ten different tools: 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>
+      <p>The total score is based mainly on the severities and instance counts of issues discovered. Secondary components include obviousness (how many tools reported issues), incompatibility (how many tools the page interfered with), nonconformity (how much error and notice logging the page provoked), and unresponsiveness (how slowly the page loaded).</p>
       <h2>Score summary</h2>
       <table class="allBorder secondCellRight">
         <caption>Score components</caption>

package/procs/digest/tdp24/index.js

@@ -5,14 +5,10 @@
 
 // CONSTANTS
 
+  const id = 'tdp27';
   // Newlines with indentations.
   const joiner = '\n      ';
   const innerJoiner = '\n        ';
-  const specialMessages = {
-    log: 'This is based on the amount of browser error logging and miscellaneous logging during the tests.',
-    preventions: 'This is based on tests that the page did not allow to be run. That impedes accessibility progress and risks interfering with tools that users with disabilities need.',
-    solos: 'This is based on issues reported by unclassified tests. Details are in the report.'
-  };
 
 // FUNCTIONS
 
@@ -30,21 +26,22 @@ const getSpecialPStart = (summary, scoreID) =>
 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 {target, requester} = sources;
+  const {script, target, requester} = sources;
   const reportJSON = JSON.stringify(report, null, 2);
   const reportJSONSafe = htmlEscape(reportJSON);
   query.report = reportJSONSafe;
-  query.ts = 'ts24';
-  query.sp = 'tsp24';
-  query.dp = 'tdp24';
+  const {scoreProcID, summary, issues, tools, preventions} = score;
+  query.ts = script;
+  query.sp = scoreProcID;
+  query.dp = id;
   // Add the job data to the query.
   query.dateISO = jobData.endTime.slice(0, 10);
   query.dateSlash = query.dateISO.replace(/-/g, '/');
+  query.url = target.which;
   query.org = target.what;
-  query.url = acts && acts.length > 1 && acts[1].which;
   query.requester = requester;
-  const {issueDetails, summary} = score;
-  const {total, issues} = summary;
+  const {total} = summary;
+  const issueTotal = summary.issues;
   if (typeof total === 'number') {
     query.totalScore = total;
   }
@@ -52,17 +49,17 @@ exports.makeQuery = (report, query) => {
     console.log('ERROR: missing or invalid total score');
     return;
   }
-  // Add the total and any special rows of the score-summary table to the query.
+  // Add the total and the rows of the score-summary table to the query.
   const scoreRows = [];
-  const specialComponentIDs = ['log', 'preventions', 'solos'];
-  ['total'].concat(specialComponentIDs).forEach(item => {
-    if (summary[item]) {
-      scoreRows.push(getScoreRow(item, summary[item]));
+  const componentIDs = ['issues', 'tools', 'preventions', 'log', 'latency'];
+  ['total'].concat(componentIDs).forEach(itemID => {
+    if (summary[itemID]) {
+      scoreRows.push(getScoreRow(itemID, summary[itemID]));
     }
   });
-  // Add the group rows of the score-summary table to the query.
-  issues.forEach(issue => {
-    scoreRows.push(getScoreRow(`${issue.issueName}`, issue.score));
+  // Add the issue rows of the score-summary table to the query.
+  Object.keys(issues).forEach(issueID => {
+    scoreRows.push(getScoreRow(issueID, issues[issueID]));
   });
   query.scoreRows = scoreRows.join(innerJoiner);
   // If the score has any special components:

package/procs/digest/tdp27/index.html

@@ -0,0 +1,54 @@
+<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="author" content="Testilo">
+    <meta name="creator" content="Testilo">
+    <meta name="publisher" name="Testilo">
+    <meta name="description" content="report of accessibility testing of a web page">
+    <meta name="keywords" content="accessibility a11y web testing">
+    <title>Accessibility digest</title>
+    <link rel="icon" href="favicon.png">
+    <link rel="stylesheet" href="style.css">
+  </head>
+  <body>
+    <main>
+      <header>
+        <h1>Accessibility digest</h1>
+        <table class="allBorder">
+          <caption>Synopsis</caption>
+          <tr><th>Page</th><td>__org__</td></tr>
+          <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>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>
+      <table class="allBorder secondCellRight">
+        <caption>Score components</caption>
+        <tbody class="headersLeft">
+        __scoreRows__
+        </tbody>
+      </table>
+      <h2>Issue summary</h2>
+      <h3>Special issues</h3>
+      __specialSummary__
+      <h3>Classified issues</h3>
+      __issueSummary__
+      <h2>Complete report</h2>
+      <pre>__report__</pre>
+      <footer>
+        <p class="date">Produced <time itemprop="datePublished" datetime="__dateISO__">__dateSlash__</time></p>
+      </footer>
+    </main>
+  </body>
+</html>

package/procs/digest/tdp27/index.js

@@ -0,0 +1,99 @@
+/*
+  index: digester for scoring procedure tsp24.
+  Creator of parameters for substitution into index.html.
+*/
+
+// IMPORTS
+
+const {issueClasses} = require('./procs/score/tic27');
+
+// CONSTANTS
+
+// Digester ID.
+const id = 'tdp27';
+// Newlines with indentations.
+const joiner = '\n      ';
+const innerJoiner = '\n        ';
+
+// FUNCTIONS
+
+// Makes strings HTML-safe.
+const htmlEscape = textOrNumber => textOrNumber
+.toString()
+.replace(/&/g, '&')
+.replace(/</g, '&lt;');
+// 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 {script, target, requester} = sources;
+  const reportJSON = JSON.stringify(report, null, 2);
+  const reportJSONSafe = htmlEscape(reportJSON);
+  query.report = reportJSONSafe;
+  const {scoreProcID, summary, issues} = score;
+  const {total} = summary;
+  query.ts = script;
+  query.sp = scoreProcID;
+  query.dp = id;
+  // Add the job data to the query.
+  query.dateISO = jobData.endTime.slice(0, 10);
+  query.dateSlash = query.dateISO.replace(/-/g, '/');
+  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 = [];
+  const componentIDs = ['issues', 'tools', 'preventions', 'log', 'latency'];
+  ['total'].concat(componentIDs).forEach(itemID => {
+    if (summary[itemID]) {
+      scoreRows.push(getScoreRow(itemID, summary[itemID]));
+    }
+  });
+  // Add the issue rows to them.
+  Object.keys(issues).forEach(issueID => {
+    scoreRows.push(getScoreRow(issueID, issues[issueID]));
+  });
+  // Add the rows to the query.
+  query.scoreRows = scoreRows.join(innerJoiner);
+  // Add paragraphs about them for the issue summary to the query.
+  const issueSummaryItems = [];
+  Object.keys(issues).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 issueIntroP = '<p>Issue reports in this category:</p>';
+    const issueListItems = [];
+    const issueData = issueDetails.issues[issueName];
+    const toolIDs = Object.keys(issueData.tools);
+    toolIDs.forEach(toolID => {
+      const testIDs = Object.keys(issueData.tools[toolID]);
+      testIDs.forEach(testID => {
+        const testData = issueData.tools[toolID][testID];
+        const {score, what} = testData;
+        const listItem =
+          `<li>Package <code>${toolID}</code>, test <code>${testID}</code>, score ${score} (${what})</li>`;
+        issueListItems.push(listItem);
+      });
+    });
+    const issueList = [
+      '<ul>',
+      issueListItems.join('\n  '),
+      '</ul>'
+    ].join(joiner);
+    issueSummaryItems.push(issueHeading, wcagP, scoreP, issueIntroP, issueList);
+  });
+  query.issueSummary = issueSummaryItems.join(joiner);
+};

package/procs/score/tsp27.js

@@ -51,7 +51,7 @@ Object.keys(issueClasses).forEach(issueClassName => {
 
 // Scores a report.
 exports.scorer = report => {
-  console.log(report.id);
+  console.log(`Scoring report ${report.id}`);
   // If there are any acts in the report:
   const {acts} = report;
   if (Array.isArray(acts) && acts.length) {
@@ -77,53 +77,49 @@ exports.scorer = report => {
       const {summary, toolTotals, issues, tools, preventions} = score;
       // For each test act:
       testActs.forEach(act => {
-        // If a standard result with valid totals and instances exists:
+        // If a successful standard result exists:
         const {which, standardResult} = act;
         if (
           standardResult
           && standardResult.totals
           && standardResult.totals.length === 4
           && standardResult.instances
-          && standardResult.instances.length
         ) {
-          // Add the tool totals to the score.
+          // Add the severity totals of the tool to the score.
           const {totals} = standardResult;
           tools[which] = totals;
           toolTotals.forEach((total, index) => {
-            toolTotals[index] += toolWeight * totals[index];
-            summary.tools += toolWeight * totals[index] * severityWeights[index];
+            toolTotals[index] += totals[index];
           });
           // Update the issue totals for the tool.
           const issueTotals = {};
+          let ruleID;
           standardResult.instances.forEach(instance => {
-            const issueID = issueIndex[which][instance.issueID];
-            let indexIssueID;
-            if (issueID) {
-              indexIssueID = issueID;
-            }
-            else {
-              indexIssueID = issueMatcher.find(pattern => {
+            ruleID = issueIndex[which][instance.ruleID];
+            if (! ruleID) {
+              ruleID = issueMatcher.find(pattern => {
                 const patternRE = new RegExp(pattern);
-                return patternRE.test(instance.issueID);
+                return patternRE.test(instance.ruleID);
               });
             }
-            if (indexIssueID) {
-              if (! issueTotals[indexIssueID]) {
-                issueTotals[indexIssueID] = 0;
+            if (ruleID) {
+              const issueID = issueIndex[which][ruleID];
+              if (! issueTotals[issueID]) {
+                issueTotals[issueID] = 0;
               }
-              issueTotals[indexIssueID] += instance.count || 1;
+              issueTotals[issueID] += instance.count || 1;
             }
             else {
-              console.log(`ERROR: ${instance.issueID} not found in issueClasses`);
+              console.log(`ERROR: ${instance.ruleID} of ${which} not found in issueClasses`);
             }
           });
           // Update the issue totals in the score.
-          Object.keys(issueTotals).forEach(id => {
-            issues[id] = Math.max(issues[id] || 0, issueTotals[id]);
+          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 result with totals exists:
+        // Otherwise, i.e. if no no successful result exists:
         else {
           // Add a prevented result to the act if not already there.
           if (! act.result) {
@@ -133,10 +129,14 @@ exports.scorer = report => {
             act.result.prevented = true;
           };
           // Add the tool and the prevention score to the score.
-          score.preventions[which] = preventionWeight;
+          preventions[which] = preventionWeight;
           summary.preventions += preventionWeight;
         }
       });
+      // Add the weighted tool total to the score.
+      summary.tools = toolWeight * toolTotals.reduce(
+        (total, current, index) => total + current * severityWeights[index], 0
+      );
       // Add the log score to the score.
       const {jobData} = report;
       summary.log = Math.max(0, Math.round(
@@ -147,6 +147,7 @@ exports.scorer = report => {
         + logWeights.prohibitedCount * jobData.prohibitedCount +
         + logWeights.visitRejectionCount * jobData.visitRejectionCount
       ));
+      // Add the latency score to the score.
       summary.latency = Math.round(
         latencyWeight * (Math.max(0, jobData.visitLatency - normalLatency))
       );