testilo 19.0.1 → 19.0.3

package/README.md

@@ -362,10 +362,10 @@ A module can invoke `merge` in this way:
 
 ```javaScript
 const {merge} = require('testilo/merge');
-const jobs = merge(script, batch, requester, 'only', false, true);
+const jobs = merge(script, batch, requester, true, 'only', false);
 ```
 
-This invocation references `script`, `batch`, and `requester` variables that the module must have already defined. The `script` and `batch` variables are a script object and a batch object, respectively. The `requester` variable is an email address. The fourth argument is a string that specifies the Testaro standardization option ('also', 'only', or 'no'). The fifth argument is a boolean, specifying whether Testaro will allow granular network watching of the job. The sixth argument is a boolean, specifying whether to perform test isolation; a missing sixth argument is equivalent to `false`. The `merge()` function of the `merge` module generates jobs and returns them in an array. The invoking module can further dispose of the jobs as needed.
+This invocation references `script`, `batch`, and `requester` variables that the module must have already defined. The `script` and `batch` variables are a script object and a batch object, respectively. The `requester` variable is an email address. The fourth argument is a boolean, specifying whether to perform test isolation. The fifth argument is a string that specifies the Testaro standardization option ('also', 'only', or 'no'). The sixth argument is a boolean, specifying whether Testaro will allow granular network watching of the job. The `merge()` function of the `merge` module generates jobs and returns them in an array. The invoking module can further dispose of the jobs as needed.
 
 ##### By a user
 
@@ -374,15 +374,15 @@ A user can invoke `merge` in this way:
 - Create a script and save it as a JSON file in the `scripts` subdirectory of the `process.env.SPECDIR` directory.
 - Create a batch and save it as a JSON file in the `batches` subdirectory of the `process.env.SPECDIR` directory.
 - In the Testilo project directory, execute this statement:
-    - `node call merge s b e o g i t`
+    - `node call merge s b e i f g t`
 
 In these statements, replace:
 - `s` with the base name of the script file
 - `b` with the base name of the batch file
 - `e` with an email address, or with an empty string if the environment variable `process.env.REQUESTER` exists and you want to use it
-- `o` with `'also'`, `'only'`, or `'no'` to specify the Testaro standardization option
-- `g` with `true` if you want Testaro to allow granular network watching or `false` if not.
 - `i` with `true` if you want test isolation or `false` if not
+- `f` with `'also'`, `'only'`, or `'no'` to specify the treatment of standard-format results.
+- `g` with `true` if reporting is to be granular, or `false` if not.
 - `t` with `true` if the job is to be saved in the `todo` subdirectory or `false` if it is to be saved in the `pending` subdirectory of the `process.env.JOBDIR` directory.
 
 The `call` module will retrieve the named script and batch from their respective directories.

package/call.js

@@ -70,14 +70,22 @@ const callScript = async (scriptID, classificationID = null, ... issueIDs) => {
   console.log(`Script ${scriptID} created and saved in ${specDir}/scripts`);
 };
 // Fulfills a merging request.
-const callMerge = async (scriptID, batchID, requester, withIsolation, todo) => {
+const callMerge = async (
+  scriptID,
+  batchID,
+  requester,
+  withIsolation,
+  standard,
+  isGranular,
+  todo
+) => {
   // Get the script and the batch.
   const scriptJSON = await fs.readFile(`${specDir}/scripts/${scriptID}.json`, 'utf8');
   const script = JSON.parse(scriptJSON);
   const batchJSON = await fs.readFile(`${specDir}/batches/${batchID}.json`, 'utf8');
   const batch = JSON.parse(batchJSON);
   // Merge them into an array of jobs.
-  const jobs = merge(script, batch, requester, withIsolation);
+  const jobs = merge(script, batch, requester, withIsolation, standard, isGranular);
   // Save the jobs.
   const destination = todo === 'true' ? 'todo' : 'pending';
   for (const job of jobs) {
@@ -237,7 +245,7 @@ else if (fn === 'script' && fnArgs.length) {
     console.log('Execution completed');
   });
 }
-else if (fn === 'merge' && fnArgs.length === 5) {
+else if (fn === 'merge' && fnArgs.length === 7) {
   callMerge(... fnArgs)
   .then(() => {
     console.log('Execution completed');

package/merge.js

@@ -5,9 +5,9 @@
     0. script
     1. batch
     2. requester
-    3. value of the standard property
-    4. value of the granularity property
-    5. whether to provide test isolation (no if omitted)
+    3. whether to provide test isolation
+    4. value of the standard property
+    5. whether reporting is to be granular
 */
 
 // ########## IMPORTS
@@ -31,7 +31,7 @@ const contaminantNames = new Set([
 // ########## FUNCTIONS
 
 // Merges a script and a batch and returns jobs.
-exports.merge = (script, batch, requester, standard, granular, isolate = false) => {
+exports.merge = (script, batch, requester, isolate, standard, isGranular) => {
   if (isolate === 'false') {
     isolate = false;
   }
@@ -61,7 +61,7 @@ exports.merge = (script, batch, requester, standard, granular, isolate = false)
   protoJob.creationTime = creationTime;
   protoJob.timeStamp = timeStamp;
   protoJob.standard = standard || 'only';
-  protoJob.observe = granular || false;
+  protoJob.observe = isGranular || false;
   // If isolation was requested:
   if (isolate) {
     // Perform it.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "19.0.1",
+  "version": "19.0.3",
   "description": "Prepares and processes Testaro reports",
   "main": "aim.js",
   "scripts": {

package/procs/digest/tdp37/index.html

@@ -0,0 +1,72 @@
+<!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>__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. Nine different tools (Alfa, ASLint, Axe, 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 960 rules, which are classified here into about 290 accessibility issues. The results were interpreted to yield a score. If the page passed every test, its score would be 0. The score for this page was __total__.</p>
+      <h2>Total score</h2>
+      <p>The total score is the sum of five components.</p>
+      <table class="allBorder secondCellRight">
+        <caption>Score summary</caption>
+        <thead>
+          <tr><th>Component</th><th>Score</th><th>Description</th></tr>
+        </thead>
+        <tbody class="headersLeft">
+          <tr><th>issue</th><td>__issue__</td><td>Severity and number of reported defects</td></tr>
+          <tr><th>tool</th><td>__tool__</td><td>Tool-by-tool defect ratings</td></tr>
+          <tr><th>prevention</th><td>__prevention__</td><td>Failed attempts by tools to test the page</td></tr>
+          <tr><th>log</th><td>__log__</td><td>Browser warnings about the page</td></tr>
+          <tr><th>latency</th><td>__latency__</td><td>Abnormal delay in page responses</td></tr>
+        </tbody>
+        <tfoot>
+          <tr><th>total</th><td>__total__</td><td>Sum of the component scores</td></tr>
+        </tfoot>
+      </table>
+      <h2>Issue scores</h2>
+      <p>The score on an issue depends on the <dfn>severity</dfn> (user impact and certainty) of the issue and on how many instances were reported (by one or more tools).</p>
+      <table class="allBorder thirdCellRight">
+        <caption>Issue scores</caption>
+        <thead>
+          <tr><th>Issue</th><th>WCAG</th><th>Score</th><th>Tools Reporting the Issue</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/tdp37/index.js

@@ -0,0 +1,99 @@
+// index: digester for scoring procedure tsp36.
+
+// IMPORTS
+
+// Module to classify tool rules into issues
+const {issues} = require('../../score/tic37');
+// Module to process files.
+const fs = require('fs/promises');
+
+// CONSTANTS
+
+// Digester ID.
+const id = 'tdp37';
+// 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 = (issueID, wcag, score, [tools]) => {
+  const toolList = tools.join(', ');
+  return `<tr><th>${issueID}</th><td>${wcag}<td>${score}</td><td>${toolList}</tr>`;
+};
+// Adds parameters to a query for a digest.
+const populateQuery = (report, query) => {
+  const {sources, jobData, score} = report;
+  const {script, target, requester} = sources;
+  const {scoreProcID, summary, details} = 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.org = target.what;
+  query.url = target.which;
+  query.requester = requester;
+  query.reportURL = `report?jobID=${report.id}`;
+  // Add values for the score-summary table to the query.
+  const rows = {
+    summaryRows: [],
+    issueRows: []
+  };
+  ['total', 'issue', '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 => {
+    const {score, tools} = details.issue[issueID];
+    rows.issueRows.push(
+      getIssueScoreRow(issueID, issues[issueID].wcag, score, Object.keys(tools))
+    );
+  });
+  // 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 <code>${issueID}</code></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;
+};