npm - testilo - Versions diffs - 39.0.0 → 39.0.1 - Mend

testilo 39.0.0 → 39.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md +5 -1
package/package.json +1 -1
package/procs/track/ttp40/index.js +1 -1
package/procs/track/ttp43/index.html +116 -0
package/procs/track/ttp43/index.js +100 -0

package/README.md CHANGED Viewed

@@ -788,8 +788,12 @@ To test the `digest` module, in the project directory you can execute the statem
 The `summarize` module of Testilo can summarize a scored report. The summary is an object that contains these properties from the report: `id`, `endTime`, `targetWhat` (description of the target), `url` (of the target), `sources`, and `score` (only the value of the `score.total` property of the report).
+Report summaries make some operations more efficient by allowing other modules to get needed data from summaries instead of from reports. The size of a summary tends to be about 0.01% of the size of a report.
 #### Invocation
+The `summarize` module summarizes one report when invoked by a module, but the `call` module invoked by a user can call `summarize` multiple times to summarize multiple reports and combine those summaries into a file.
 ##### By a module
 A module can invoke `summarize()` in this way:
@@ -829,7 +833,7 @@ The `compare` module compares the scores in a summary report. The `compare()` fu
 The comparison function defines the rules for generating an HTML file comparing the scored reports. The Testilo package contains a `procs/compare` directory, in which there are subdirectories containing modules that export comparison functions. You can use one of those functions, or you can create your own.
-Summary reports suitable for comparisons are those that contain one result per target. If a summary report contains results from multiple times per target, tracking (described below) is appropriate, rather than comparison.
+The built-in comparison functions compare all of the scores in the summary report. Thus, if the summary report contains multiple scores for the same target, based on tests performed at various times, those scores will all appear in the comparison, labeled identically with the `what` description of the target. If you want only one score per target to appear, you can create a new summary report that includes only one summary per target in its `summaries` array.
 #### Invocation

package/package.json CHANGED Viewed

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

package/procs/track/ttp40/index.js CHANGED Viewed

@@ -56,7 +56,7 @@ const populateQuery = async (id, what, summaryReport, query) => {
   // Get an array of target descriptions and assign to each an ID.
   const rows = [];
   const targets = Array
-  .from(new Set(summaries.map(result => result.target.what)))
+  .from(new Set(summaries.map(result => result.targetWhat)))
   .sort()
   .map((targetWhat, index) => [alphaNumOf(index), targetWhat]);
   const targetIDs = {};

package/procs/track/ttp43/index.html ADDED Viewed

@@ -0,0 +1,116 @@
+<!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 web pages">
+    <meta name="keywords" content="accessibility a11y web testing">
+    <title>Accessibility tracking report</title>
+    <link rel="icon" href="favicon.ico">
+    <link rel="stylesheet" href="style.css">
+  </head>
+  <body>
+    <main>
+      <header>
+        <h1>Accessibility tracking report</h1>
+      </header>
+      <h2>Introduction</h2>
+      <p>This is tracking report <code>__id__</code>, for __what__.</p>
+      <p>It tracks accessibility scores over time. A perfect score is 0. The tracking was performed by Testilo procedure <code>__tp__</code>.</p>
+      <p>The results are presented first as a graph, and then as a table.</p>
+      <h2>Results as a graph</h2>
+      <h3>Legend</h3>
+      <ul id="legendItems">
+        __legendItems__
+      </ul>
+      <h3>Line graph</h3>
+      <figure id="graph">
+        <figcaption>Accessibility scores</figcaption>
+      </figure>
+      <script src="https://cdn.jsdelivr.net/npm/d3@7"></script>
+      <script src="https://cdn.jsdelivr.net/npm/@observablehq/plot@0.6"></script>
+      <script type="module" defer>
+        const summaryReportJSON = '__summaryReportJSON__';
+        const summaryReport = JSON.parse(summaryReportJSON);
+        const graphData = [];
+        const targetIDs = {};
+        Array.from(document.getElementById('legendItems').children).forEach(li => {
+          const targetData = li.textContent.split(': ');
+          targetIDs[targetData[1]] = targetData[0];
+        });
+        summaryReport.summaries.forEach(result => {
+          const {what} = result.sources.target;
+          graphData.push({
+            targetID: targetIDs[what],
+            targetWhat: what,
+            time: new Date(`20${result.endTime}Z`),
+            score: result.score
+          });
+        });
+        const svg = Plot.plot({
+          style: 'overflow: visible;',
+          height: 600,
+          y: {grid: true},
+          marks: [
+            Plot.ruleY([0]),
+            Plot.lineY(graphData, {
+              x: 'time',
+              y: 'score',
+              stroke: 'targetID'
+            }),
+            Plot.dot(graphData, {
+              x: 'time',
+              y: 'score',
+              z: 'targetID',
+              r: 9
+            }),
+            Plot.text(graphData, {
+              x: 'time',
+              y: 'score',
+              z: 'targetID',
+              text: 'targetID',
+              textAnchor: 'middle'
+            }),
+            Plot.text(graphData, Plot.selectFirst({
+              x: 'time',
+              y: 'score',
+              z: 'targetID',
+              text: 'targetWhat',
+              textAnchor: 'start',
+              dx: 15
+            })),
+            Plot.text(graphData, Plot.selectLast({
+              x: 'time',
+              y: 'score',
+              z: 'targetID',
+              text: 'targetWhat',
+              textAnchor: 'start',
+              dx: 15
+            }))
+          ]
+        });
+        document.getElementById('graph').insertAdjacentElement('beforeend', svg);
+      </script>
+      <h2>Results as a table</h2>
+      <table class="allBorder secondCellRight">
+        <caption>Accessibility scores</caption>
+        <thead>
+          <tr>
+            <th>Date and time</th>
+            <th>Score</th>
+            <th>Target</th>
+          </tr>
+        </thead>
+        <tbody>
+          __scoreRows__
+        </tbody>
+      </table>
+      <footer>
+        <p class="date">Produced <time itemprop="datePublished" datetime="__dateISO__">__dateSlash__</time></p>
+      </footer>
+    </main>
+  </body>
+</html>

package/procs/track/ttp43/index.js ADDED Viewed

@@ -0,0 +1,100 @@
+/*
+  © 2024 CVS Health and/or one of its affiliates. All rights reserved.
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+// index: tracker for tracking procedure ttp43.
+// IMPORTS
+// Module to keep secrets.
+require('dotenv').config();
+// Module to process files.
+const fs = require('fs/promises');
+// Utility module.
+const {alphaNumOf, getNowDate, getNowDateSlash} = require('../../util');
+// CONSTANTS
+// Tracker ID.
+const trackerID = 'ttp43';
+// Newline with indentations.
+const innerJoiner = '\n          ';
+// Digest URL.
+const digestURL = process.env.DIGEST_URL;
+// FUNCTIONS
+// Adds parameters to a query for a tracking report.
+const populateQuery = async (id, what, summaryReport, query) => {
+  // General parameters.
+  query.id = id;
+  query.what = what;
+  query.tp = trackerID;
+  query.dateISO = getNowDate();
+  query.dateSlash = getNowDateSlash();
+  // JSON of summary report.
+  const {summaries} = summaryReport;
+  query.summaryReportJSON = JSON.stringify(summaryReport);
+  // Get an array of target descriptions and assign to each an ID.
+  const rows = [];
+  const targets = Array
+  .from(new Set(summaries.map(result => result.targetWhat)))
+  .sort()
+  .map((targetWhat, index) => [alphaNumOf(index), targetWhat]);
+  const targetIDs = {};
+  targets.forEach(target => {
+    targetIDs[target[1]] = target[0];
+  });
+  // Add legend items to the query.
+  const legendItems = targets.map(target => `<li>${target[0]}: ${target[1]}</li>`);
+  query.legendItems = legendItems.join('\n        ');
+  // For each result:
+  summaries.forEach(result => {
+    const {endTime, id, score, targetWhat, url} = result;
+    // Create a date-time cell.
+    const timeCell = `<td>${endTime}</td>`;
+    // Create a score cell.
+    const digestLinkDestination = digestURL.replace('__id__', id);
+    const scoreCell = `<td><a href=${digestLinkDestination}>${score}</a></td>`;
+    // Create a target cell.
+    const targetLink = `<a href="${url}">${targetWhat}</a>`;
+    const targetCell = `<td>${targetIDs[targetWhat]}: ${targetLink}</td>`;
+    const row = `<tr>${[timeCell, scoreCell, targetCell].join('')}</tr>`;
+    // Add the row to the array of rows.
+    rows.push(row);
+  });
+  // Add the rows to the query.
+  query.scoreRows = rows.join(innerJoiner);
+};
+// Returns a tracking report.
+exports.tracker = async (id, what, summaryReport) => {
+  // Create a query to replace placeholders.
+  const query = {};
+  await populateQuery(id, what, summaryReport, 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 tracking report.
+  return template;
+};