testilo 3.6.1 → 3.6.2

package/digest.js

@@ -15,8 +15,8 @@ const fs = require('fs/promises');
 
 const reportDirScored = process.env.REPORTDIR_SCORED || 'reports/scored';
 const reportDirDigested = process.env.REPORTDIR_DIGESTED || 'reports/digested';
-const reportIDStart = process.argv[2];
-const digesterID = process.argv[3];
+const digesterID = process.argv[2];
+const reportIDStart = process.argv[3];
 
 // ########## FUNCTIONS
 
@@ -26,11 +26,14 @@ const replaceHolders = (content, query) => content
 // Creates a digest.
 const digest = async () => {
   const reportDirScoredAbs = `${__dirname}/${reportDirScored}`;
-  const allReportFileNames = await fs.readdir(reportDirScoredAbs);
-  const sourceReportFileNames = allReportFileNames
-  .filter(fileName => fileName.startsWith(reportIDStart) && fileName.endsWith('.json'));
+  let reportFileNames = await fs.readdir(reportDirScoredAbs);
+  reportFileNames = reportFileNames.filter(fileName => fileName.endsWith('.json'));
+  if (reportIDStart) {
+    reportFileNames = reportFileNames
+    .filter(fileName => fileName.startsWith(reportIDStart));
+  }
   const {makeQuery} = require(`${__dirname}/procs/digest/${digesterID}/index.js`);
-  for (const fileName of sourceReportFileNames) {
+  for (const fileName of reportFileNames) {
     const reportJSON = await fs.readFile(`${reportDirScoredAbs}/${fileName}`, 'utf8');
     const report = JSON.parse(reportJSON);
     const query = {};

package/package.json

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

package/procs/digest/dp11a/index.js

@@ -6,14 +6,14 @@
 
 // CONSTANTS
 
-  // Newlines with indentations.
-  const joiner = '\n      ';
-  const innerJoiner = '\n        ';
-  const specialMessages = {
-    log: 'This is based on the amount of browser logging during the tests. Browsers usually log messages only when pages contain erroneous code.',
-    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.'
-  };
+// Newlines with indentations.
+const joiner = '\n      ';
+const innerJoiner = '\n        ';
+const specialMessages = {
+  log: 'This is based on the amount of browser logging during the tests. Browsers usually log messages only when pages contain erroneous code.',
+  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
 
@@ -26,11 +26,11 @@ const htmlEscape = textOrNumber => textOrNumber
 const getScoreRow = (component, score) => `<tr><th>${component}</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]}.`;
+  `<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 host report to the query to be appended to the digest.
-  const {script, host, score} = report;
+  const { script, host, score } = report;
   const reportJSON = JSON.stringify(report, null, 2);
   const reportJSONSafe = htmlEscape(reportJSON);
   query.report = reportJSONSafe;
@@ -52,7 +52,7 @@ exports.makeQuery = (report, query) => {
       return;
     }
   }
-  const {groupDetails, summary} = score;
+  const { groupDetails, summary } = score;
   if (typeof summary.total === 'number') {
     query.totalScore = summary.total;
   }
@@ -69,7 +69,7 @@ exports.makeQuery = (report, query) => {
     }
   });
   // Add the group rows of the score-summary table to the query.
-  const {groups} = summary;
+  const { groups } = summary;
   const groupIDs = Object.keys(groups);
   groupIDs.sort((a, b) => groups[b] - groups[a]);
   groupIDs.forEach(groupID => {
@@ -89,7 +89,7 @@ exports.makeQuery = (report, query) => {
   // Otherwise, i.e. if the score has no special components:
   else {
     // Add a paragraph stating this for the issue summary to the query.
-    query.specialSummary = '<p>No special issues contributed to the score.</p>'
+    query.specialSummary = '<p>No special issues contributed to the score.</p>';
   }
   // If the score has any classified issues as components:
   if (groupIDs.length) {
@@ -104,7 +104,7 @@ exports.makeQuery = (report, query) => {
         const testIDs = Object.keys(groupData[packageID]);
         testIDs.forEach(testID => {
           const testData = groupData[packageID][testID];
-          const {issueCount} = testData;
+          const { issueCount } = testData;
           const issueNoun = issueCount !== 1 ? 'issues' : 'issue';
           const listItem = `<li>${issueCount} ${issueNoun} reported by package <code>${packageID}</code>, test <code>${testID}</code> (${testData.what})</li>`;
           groupListItems.push(listItem);
@@ -122,6 +122,6 @@ exports.makeQuery = (report, query) => {
   // Otherwise, i.e. if the score has no classified issues as components:
   else {
     // Add a paragraph stating this for the group summary to the query.
-    query.groupSummary = '<p>No classified issues contributed to the score.</p>'
+    query.groupSummary = '<p>No classified issues contributed to the score.</p>';
   }
 };

package/procs/digest/dp12a/index.html

@@ -0,0 +1,78 @@
+<!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 test digest</title>
+    <link rel="icon" href="favicon.png">
+    <link rel="stylesheet" href="style.css">
+  </head>
+  <body>
+    <main>
+      <header>
+        <h1>Accessibility test digest</h1>
+        <h2>Synopsis</h2>
+        <div id="synopsis">
+          <p><strong>Page</strong>: __org__</p>
+          <p><strong>URL</strong>: __url__</p>
+          <p><strong>Score</strong>: __totalScore__</p>
+          <p><strong>Tested by</strong>: Testaro, procedure <code>tp12</code></p>
+          <p><strong>Scored by</strong>: Testilo, procedure <code>sp12a</code></p>
+          <p><strong>Digested by</strong>: Testilo, procedure <code>dp12a</code></p>
+        </div>
+      </header>
+      <h2>Introduction</h2>
+      <p>The <a href="https://www.npmjs.com/package/testaro">Testaro</a> application used its <code>tp12</code> testing procedure to test the <a href="https://www.w3.org/WAI/fundamentals/accessibility-intro/"><dfn>accessibility</dfn></a> (barrier-free design and coding) of the __org__ web page at <a href="__url__">__url__</a> on __dateSlash__. The procedure performed 808 tests. Of these, 16 are custom tests defined by Testaro, and the others belong to these six other packages (programs that perform collections of tests):</p>
+      <ul>
+        <li><a href="https://github.com/Siteimprove/alfa">Alfa</a> by Siteimprove</li>
+        <li><a href="https://www.npmjs.com/package/axe-core">Axe-core</a> by Deque</li>
+        <li>
+          <a href="https://www.npmjs.com/package/html_codesniffer">HTML CodeSniffer</a> by Squiz Labs
+        </li>
+        <li><a href="https://github.com/IBMa/equal-access">Equal Access</a> by IBM</li>
+        <li><a href="https://tenon.io/documentation/apiv2.php">Tenon</a> by Level Access</li>
+        <li><a href="https://wave.webaim.org/api/">WAVE</a> by WebAIM</li>
+      </ul>
+      <p>Testaro produced a report enumerating the test results.</p>
+      <p><a href="https://www.npmjs.com/package/testilo">Testilo</a> processed the report and used the <code>sp12a</code> scoring procedure to compute partial and total scores for the page. The total score is __totalScore__ (where 0 is the best possible score). The scored report is appended below.</p>
+      <p>Finally, Testilo used procedure <code>dp12a</code> to produce this digest, briefly explaining how <code>sp12a</code> computed the scores.</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>
+      __groupSummary__
+      <h2>Discussion</h2>
+      <p>Although there are widely accepted <a href="https://www.w3.org/WAI/standards-guidelines/">accessibility standards</a>, there is no unanimity about how to define, test, and quantify accessibility. The failures reported in this digest merit investigation as potential opportunities for improved accessibility. Investigation may lead you to conclude that some of the reported failures do not actually harm accessibility. Conversely, some substantial accessibility faults can escape detection by any of these tests. You may question the attempt to assign an accessibility score to a web page, or you may prefer weightings and formulas different from those used by <code>sp12a</code>. You can modify and extend Testaro and Testilo to fit other theories and priorities.</p>
+      <p>Here, in brief, is how <code>sp12a</code> computes a score for a page.</p>
+      <ul>
+        <li>It finds all the defects and warnings (let&rsquo;s call them <q>issues</q>) recorded in the report.</li>
+        <li>It classifies them according to type. For example, a link that looks like the text around it is one issue category, while a video that has no captions is another issue category.</li>
+        <li>It also classifies the issues according to severity. For example, an issue that prevents a transaction is more severe than an issue that only complicates the transaction, and a warning about a possible issue is less severe than a definite finding of an issue. (Some packages rate the severity of each issue; for the other packages, <code>sp12a</code> assigns a severity weight to the issue type and uses that weight.)</li>
+        <li>It assigns quality ratings to particular tests that are judged abnormally reliable or unreliable.</li>
+        <li>It assigns a score to each issue reported by each test of each package.</li>
+        <li>It aggregates the issue scores, weighting them by severity, test quality, and redundancy. Redundancy occurs, and causes downweighting, when two or more packages contain tests that are designed to discover the same or mostly the same issues. So the score for a category is not simply the sum of the scores of the tests in that category.</li>
+        <li>It assigns a score for issues in the page logged by the browser.</li>
+        <li>It assigns an estimated score each time the page prevents one of the packages or one of the Testaro tests from being run on the page.</li>
+        <li>It adds the scores together to obtain a total score.</li>
+      </ul>
+      <p>The precise rules of <code>sp12a</code> are found in the <a href="https://github.com/jrpool/testilo/blob/main/procs/score/sp12a.js">code itself</a>.</p>
+      <h2>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/dp12a/index.js

@@ -0,0 +1,126 @@
+/*
+  index: digester for scoring procedure sp12a.
+  Creator of parameters for substitution into index.html.
+  Usage example for selected files: node digest dp12a 35k1r
+  Usage example for all files in REPORTDIR_SCORED: node digest dp12a
+*/
+
+// CONSTANTS
+
+  // 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
+
+// Makes strings HTML-safe.
+const htmlEscape = textOrNumber => textOrNumber
+.toString()
+.replace(/&/g, '&')
+.replace(/</g, '&lt;');
+// Gets a row of the score-summary table.
+const getScoreRow = (component, score) => `<tr><th>${component}</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 host report to the query to be appended to the digest.
+  const {script, host, score} = report;
+  const reportJSON = JSON.stringify(report, null, 2);
+  const reportJSONSafe = htmlEscape(reportJSON);
+  query.report = reportJSONSafe;
+  // Add the job data to the query.
+  query.dateISO = report.endTime.slice(0, 10);
+  query.dateSlash = query.dateISO.replace(/-/g, '/');
+  if (host && host.what && host.which) {
+    query.org = host.what;
+    query.url = host.which;
+  }
+  else {
+    const firstURLCommand = script.commands.find(command => command.type === 'url');
+    if (firstURLCommand && firstURLCommand.what && firstURLCommand.which) {
+      query.org = firstURLCommand.what;
+      query.url = firstURLCommand.which;
+    }
+    else {
+      console.log('ERROR: host missing or invalid');
+      return;
+    }
+  }
+  const {groupDetails, summary} = score;
+  const {total, groups} = summary;
+  if (typeof total === 'number') {
+    query.totalScore = total;
+  }
+  else {
+    console.log('ERROR: missing or invalid total score');
+    return;
+  }
+  // Add the total and any special 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]));
+    }
+  });
+  // Add the group rows of the score-summary table to the query.
+  groups.forEach(group => {
+    scoreRows.push(getScoreRow(`${group.groupName}`, group.score));
+  });
+  query.scoreRows = scoreRows.join(innerJoiner);
+  // If the score has any special components:
+  const scoredSpecialIDs = specialComponentIDs.filter(item => summary[item]);
+  if (scoredSpecialIDs.length) {
+    // Add paragraphs about them for the issue summary to the query.
+    const specialPs = [];
+    scoredSpecialIDs.forEach(id => {
+      specialPs.push(`${getSpecialPStart(summary, id)} ${specialMessages[id]}`);
+    });
+    query.specialSummary = specialPs.join(joiner);
+  }
+  // Otherwise, i.e. if the score has no special components:
+  else {
+    // Add a paragraph stating this for the issue summary to the query.
+    query.specialSummary = '<p>No special issues contributed to the score.</p>'
+  }
+  // If the score has any classified issues as components:
+  if (groups.length) {
+    // Add paragraphs about them for the special summary to the query.
+    const groupSummaryItems = [];
+    groups.forEach(group => {
+      const {groupName, score} = group;
+      const groupP = `<p><span class="componentID">${groupName}</span>: Score ${score}. Issues reported by tests in this category:</p>`;
+      const groupListItems = [];
+      const groupData = groupDetails.groups[groupName];
+      const packageIDs = Object.keys(groupData);
+      packageIDs.forEach(packageID => {
+        const testIDs = Object.keys(groupData[packageID]);
+        testIDs.forEach(testID => {
+          const testData = groupData[packageID][testID];
+          const {score, what} = testData;
+          const listItem = `<li>Package <code>${packageID}</code>, test <code>${testID}</code>, score ${score} (${what})</li>`;
+          groupListItems.push(listItem);
+        });
+      });
+      const groupList = [
+        '<ul>',
+        groupListItems.join('\n  '),
+        '</ul>'
+      ].join(joiner);
+      groupSummaryItems.push(groupP, groupList);
+    });
+    query.groupSummary = groupSummaryItems.join(joiner);
+  }
+  // Otherwise, i.e. if the score has no classified issues as components:
+  else {
+    // Add a paragraph stating this for the group summary to the query.
+    query.groupSummary = '<p>No classified issues contributed to the score.</p>'
+  }
+};

package/procs/score/sp12a.js

@@ -319,7 +319,7 @@ const groups = {
         }
       },
       htmlcs: {
-        'e:H24': {
+        'e:AA.1_1_1.H24': {
           quality: 1,
           what: 'Area element in an image map missing an alt attribute'
         }
@@ -556,7 +556,7 @@ const groups = {
       htmlcs: {
         'e:AA.4_1_2.H91.Button.Name': {
           quality: 1,
-          what: 'button element has no accessible name'
+          what: 'Button element has no accessible name'
         }
       },
       wave: {
@@ -747,7 +747,7 @@ const groups = {
       axe: {
         'frame-title': {
           quality: 1,
-          what: 'Frames has no accessible name'
+          what: 'Frame has no accessible name'
         },
         'frame-title-unique': {
           quality: 1,
@@ -868,7 +868,7 @@ const groups = {
     }
   },
   autocompleteBad: {
-    weight: 2,
+    weight: 3,
     packages: {
       alfa: {
         r10: {
@@ -2120,7 +2120,11 @@ exports.scorer = async report => {
             weightedScore *= groups[groupName].packages[packageName][testID].quality;
             // Round the score, but not to less than 1.
             const roundedScore = Math.max(Math.round(weightedScore), 1);
-            groupDetails.groups[groupName][packageName][testID] = roundedScore;
+            // Add the rounded score and the test description to the group details.
+            groupDetails.groups[groupName][packageName][testID] = {
+              score: roundedScore,
+              what: groups[groupName].packages[packageName][testID].what
+            };
           }
           // Otherwise, i.e. if the test is solo:
           else {
@@ -2143,7 +2147,7 @@ exports.scorer = async report => {
         groupPackageData.forEach(packageObj => {
           // Get the sum of the scores of the tests of the package in the group.
           const scoreSum = Object.values(packageObj).reduce(
-            (sum, current) => sum + current,
+            (sum, current) => sum + current.score,
             0
           );
           // Add the sum to the list of package scores in the group.