testilo 33.4.0 → 33.5.0

package/README.md

@@ -58,7 +58,7 @@ Testilo can, however, make job preparation more efficient in these scenarios:
 
 ### Target lists
 
-The simplest version of a list of targets is a _target list_. It is an array of arrays defining 1 or more targets. It can be stored as a text file.
+The simplest version of a list of targets is a _target list_. It is an array of arrays defining 1 or more targets.
 
 A target is defined by 2 items:
 - A description
@@ -73,12 +73,7 @@ For example, a target list might be:
 ]
 ```
 
-If this target list were stored as a file, its content would be this, with vertical bars separating the URLs from the descriptions:
-
-```text
-World Wide Web Consortium|https://www.w3.org/
-Mozilla Foundation|https://foundation.mozilla.org/en/
-```
+A target list can be represented by a text file, in which each target is specified on a line with a Tab character delimiting its description and its URL, which are not quoted.
 
 ### Batches
 
@@ -791,7 +786,7 @@ When a user invokes `summarize` in this example, the `call` module:
 - gets all the reports in the `scored` subdirectory of the `REPORTDIR` directory, or (if the third argument is present) all those whose file names begin with `2411`.
 - creates a summary of each report.
 - combines the summaries into an array.
-- creates a _summary report_, an object containing three properties: an ID, a description (here `'divisions'`), and the array of summaries.
+- creates a _summary report_, an object containing three properties: `id` (an ID), `what` (a description, such as `'divisions'`), and `summaries` (the array of summaries).
 - writes the summary report in JSON format to the `summarized` subdirectory of the `REPORTDIR` directory, using the ID as the base of the file name.
 
 #### Summary reports
@@ -917,8 +912,7 @@ A module can invoke `credit()` in this way:
 ```javaScript
 const {credit} = require('testilo/credit');
 const reportScores = […];
-credit('June 2025', reportScores)
-.then(creditReport => {…});
+const creditReport = credit('June 2025', reportScores);
 ```
 
 The first argument to `credit()` is a description to be included in the credit report. The second argument is an array of `score` properties of scored report objects. The `credit()` function returns a credit report. The invoking module can further dispose of the credit report as needed.

package/compare.js

@@ -2,8 +2,10 @@
   compare.js
   Creates a comparison from a summary report.
   Arguments:
-    0. Comparing function.
-    1. Summary report.
+    0. Comparison ID.
+    1. Comparison description.
+    2. Comparing function.
+    3. Summary report.
 */
 
 // ########## FUNCTIONS

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "33.4.0",
+  "version": "33.5.0",
   "description": "Prepares Testaro jobs and processes Testaro reports",
   "main": "call.js",
   "scripts": {

package/procs/compare/tcp40/index.js

@@ -21,7 +21,7 @@ const getMaxScore = summaryReport => summaryReport.summaries.reduce(
   (max, result) => Math.max(max, result.score), 0
 );
 // Converts summary report data to a table body.
-const getTableBody = async summaryReport => {
+const getTableBody = exports.getTableBody = async summaryReport => {
   const maxScore = getMaxScore(summaryReport);
   const rows = summaryReport.summaries
   .sort((a, b) => a.score - b.score)
@@ -39,7 +39,7 @@ const getTableBody = async summaryReport => {
   return rows.join(innestJoiner);
 };
 // Populates a query for a comparative table.
-const populateQuery = async (id, what, summaryReport, query) => {
+const populateQuery = exports.populateQuery = async (id, what, summaryReport, query) => {
   query.id = id;
   query.what = what;
   query.pageCount = summaryReport.summaries.length;

package/procs/digest/tdp40/index.js

@@ -29,7 +29,7 @@ const getIssueScoreRow = (summary, wcag, score, tools) => {
 };
 // Adds parameters to a query for a digest.
 const populateQuery = (report, query) => {
-  const {id, sources, jobData, score} = report;
+  const {id, sources, score} = report;
   const {script, target, requester} = sources;
   const {scoreProcID, summary, details} = score;
   query.ts = script;

package/procs/digest/tdp41/index.html

@@ -0,0 +1,59 @@
+<!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.ico">
+    <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>__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>
+          <tr>
+            <th>Full report</th>
+            <td><a href="__reportURL__"><code>__reportURL__</code></a></td>
+          </tr>
+        </table>
+      </header>
+      <h2>Introduction</h2>
+      <p>How <a href="https://www.w3.org/WAI/">accessible</a> is the __org__ web page at <a href="__url__"><code>__url__</code></a>?</p>
+      <p>This digest can help answer that question. Ten different tools (Alfa, ASLint, Axe, Editoria11y, Equal Access, HTML CodeSniffer, Nu Html Checker, QualWeb, Testaro, and WAVE) tested the page to check its compliance with their accessibility rules. In all, the tools define about 990 rules, which are classified here into about 310 accessibility issues.</p>
+      <p>The results were interpreted to yield a score, with 0 being ideal. The score for this page was __total__, the sum of __issueCount__ for the count of issues, __issue__ for specific issues, __solo__ for unclassified rule violations, __tool__ for tool-by-tool ratings, __prevention__ for the page preventing tools from running, __log__ for browser warnings, and __latency__ for delayed page responses.</p>
+      <h2>Issue summary</h2>
+      <p>This table shows the issues discovered by one or more tools. When an instance count is 0, that means the tool has a test for the issue but the page passed that test.</p>
+      <p>Why do instance counts differ among tools? Possibly because the tests are not really equivalent, or a test is unreliable. You can inspect the <a href="__reportURL__">full report</a> to diagnose differences.</p>
+      <table class="allBorder thirdCellRight">
+        <caption>Summary of issues</caption>
+        <thead>
+          <tr><th>Issue</th><th>WCAG</th><th>Score</th><th>Instance counts</th></tr>
+        </thead>
+        <tbody class="headersLeft">
+          __issueRows__
+        </tbody>
+      </table>
+      <h2>Itemized issues</h2>
+      <p>The reported rule violations are itemized below, issue by issue. Additional details can be inspected in the <a href="__reportURL__">full report</a>.</p>
+      __issueDetailRows__
+      <footer>
+        <p class="date">Produced <time itemprop="datePublished" datetime="__dateISO__">__dateSlash__</time></p>
+      </footer>
+    </main>
+  </body>
+</html>

package/procs/digest/tdp41/index.js

@@ -0,0 +1,111 @@
+// index: digester for scoring procedure tsp40.
+
+// IMPORTS
+
+// Module to keep secrets.
+require('dotenv').config();
+// Module to classify tool rules into issues
+const {issues} = require('../../score/tic40');
+// Module to process files.
+const fs = require('fs/promises');
+// Utility module.
+const {getNowDate, getNowDateSlash} = require('../../util');
+
+// CONSTANTS
+
+// Digester ID.
+const digesterID = 'tdp41';
+// Newline with indentations.
+const innerJoiner = '\n        ';
+
+// FUNCTIONS
+
+// Gets a row of the score-summary table.
+const getScoreRow = (componentName, score) => `<tr><th>${componentName}</th><td>${score}</td></tr>`;
+// Gets a row of the issue-score-summary table.
+const getIssueScoreRow = (issueConstants, issueDetails) => {
+  const {summary, wcag} = issueConstants;
+  const {instanceCounts, score} = issueDetails;
+  const toolList = Object
+  .keys(instanceCounts)
+  .map(tool => `<code>${tool}</code>:${instanceCounts[tool]}`)
+  .join(', ');
+  return `<tr><th>${summary}</th><td class="center">${wcag}<td class="right num">${score}</td><td>${toolList}</td></tr>`;
+};
+// Adds parameters to a query for a digest.
+const populateQuery = (report, query) => {
+  const {id, sources, score} = report;
+  const {script, target, requester} = sources;
+  const {scoreProcID, summary, details} = score;
+  query.ts = script;
+  query.sp = scoreProcID;
+  query.dp = digesterID;
+  // Add the job data to the query.
+  query.dateISO = getNowDate();
+  query.dateSlash = getNowDateSlash();
+  query.org = target.what;
+  query.url = target.which;
+  query.requester = requester;
+  query.reportURL = process.env.SCORED_REPORT_URL.replace('__id__', id);
+  // Add values for the score-summary table to the query.
+  const rows = {
+    summaryRows: [],
+    issueRows: []
+  };
+  ['total', 'issueCount', 'issue', 'solo', 'tool', 'prevention', 'log', 'latency']
+  .forEach(sumItem => {
+    query[sumItem] = summary[sumItem];
+    rows.summaryRows.push(getScoreRow(sumItem, query[sumItem]));
+  });
+  // Sort the issue IDs in descending score order.
+  const issueIDs = Object.keys(details.issue);
+  issueIDs.sort((a, b) => details.issue[b].score - details.issue[a].score);
+  // Get rows for the issue-score table.
+  issueIDs.forEach(issueID => {
+    if (issues[issueID]) {
+      rows.issueRows.push(getIssueScoreRow(issues[issueID], details.issue[issueID]));
+    }
+    else {
+      console.log(`ERROR: Issue ${issueID} not found`);
+    }
+  });
+  // Add the rows to the query.
+  ['summaryRows', 'issueRows'].forEach(rowType => {
+    query[rowType] = rows[rowType].join(innerJoiner);
+  });
+  // Add paragraph groups about the issue details to the query.
+  const issueDetailRows = [];
+  issueIDs.forEach(issueID => {
+    issueDetailRows.push(`<h3 class="bars">Issue: ${issues[issueID].summary}</h3>`);
+    issueDetailRows.push(`<p>Impact: ${issues[issueID].why || 'N/A'}</p>`);
+    issueDetailRows.push(`<p>WCAG: ${issues[issueID].wcag || 'N/A'}</p>`);
+    const issueData = details.issue[issueID];
+    issueDetailRows.push(`<p>Score: ${issueData.score}</p>`);
+    const toolIDs = Object.keys(issueData.tools);
+    toolIDs.forEach(toolID => {
+      issueDetailRows.push(`<h4>Violations of <code>${toolID}</code> rules</h5>`);
+      const ruleIDs = Object.keys(issueData.tools[toolID]);
+      ruleIDs.forEach(ruleID => {
+        const ruleData = issueData.tools[toolID][ruleID];
+        issueDetailRows.push(`<h5>Rule <code>${ruleID}</code></h5>`);
+        issueDetailRows.push(`<p>Description: ${ruleData.what}</p>`);
+        issueDetailRows.push(`<p>Count of instances: ${ruleData.complaints.countTotal}</p>`);
+      });
+    });
+  });
+  query.issueDetailRows = issueDetailRows.join(innerJoiner);
+};
+// Returns a digested report.
+exports.digester = async report => {
+  // Create a query to replace placeholders.
+  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;
+};