npm - testilo - Versions diffs - 41.3.0 → 41.4.0 - Mend

testilo 41.3.0 → 41.4.0

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 (3) hide show

package/package.json +1 -1
package/procs/digest/tdp49/index.html +161 -0
package/procs/digest/tdp49/index.js +240 -0

package/package.json CHANGED Viewed

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

package/procs/digest/tdp49/index.html ADDED Viewed

@@ -0,0 +1,161 @@
+<!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">
+    <script id="script" type="module">
+      const sortByA = document.getElementById('sortByA');
+      const sortByB = document.getElementById('sortByB');
+      const sortBasisSpan = document.getElementById('sortBasis');
+      const sortBasisASpan = document.getElementById('sortBasisA');
+      const sortBasisBSpan = document.getElementById('sortBasisB');
+      const sumBody = document.getElementById('sumBody');
+      const rows = Array.from(sumBody.children);
+      const sortBases = {
+        WCAG: {
+          col: 1,
+          A: 'weight',
+          B: 'score'
+        },
+        weight: {
+          col: 2,
+          A: 'WCAG',
+          B: 'score'
+        },
+        score: {
+          col: 3,
+          A: 'WCAG',
+          B: 'weight'
+        }
+      };
+      // FUNCTION DEFINITION START
+      const sortRowsBy = basis => {
+        if (basis === 'WCAG') {
+          rows.sort((a, b) => {
+            const sorters = [a, b].map(row => {
+              const wcagParts = row.children[sortBases[basis].col].textContent.split('.');
+              const wcagNums = wcagParts.map(part => Number.parseInt(part, 10));
+              return 100 * (wcagNums[0] || 0) + 20 * (wcagNums[1] || 0) + (wcagNums[2] || 0);
+            });
+            return sorters[0] - sorters[1];
+          });
+        }
+        else if (basis === 'weight') {
+          rows.sort((a, b) => {
+            const sorters = [a, b].map(row => row.children[sortBases[basis].col].textContent);
+            return sorters[1] - sorters[0];
+          });
+        }
+        else if (basis === 'score') {
+          rows.sort((a, b) => {
+            const sorters = [a, b]
+            .map(row => Number.parseInt(row.children[sortBases[basis].col].textContent));
+            return sorters[1] - sorters[0];
+          });
+        }
+        sumBody.textContent = '';
+        rows.forEach(row => {
+          sumBody.appendChild(row);
+        });
+      };
+      // FUNCTION DEFINITION END
+      // When a sort button is activated:
+      document.getElementById('sortButtons').addEventListener('click', event => {
+        const whichButton = event.target.id.slice(-1);
+        const oldBasis = sortBasisSpan.textContent;
+        const newBasis = sortBases[oldBasis][whichButton];
+        // Re-sort the table.
+        sortRowsBy(newBasis);
+        // Revise the variable texts.
+        sortBasisSpan.textContent = newBasis;
+        sortBasisASpan.textContent = sortBases[newBasis].A;
+        sortBasisBSpan.textContent = sortBases[newBasis].B;
+      });
+    </script>
+  </head>
+  <body>
+    <main>
+      <header>
+        <h1>Accessibility digest</h1>
+        <h2>Contents</h2>
+        <ul>
+          <li><a href="#intro">Introduction</a></li>
+          <li><a href="#summary">Issue summary</a></li>
+          <li><a href="#itemization">Itemized issues</a></li>
+          <li><a href="#elements">Elements with issues</a></li>
+        </ul>
+        <table class="allBorder">
+          <caption>Synopsis</caption>
+          <tr><th>Page</th><td>__org__</td></tr>
+          <tr><th>URL</th><td>__url__</td></tr>
+          <tr><th>Test date</th><td>__dateSlash__</td></tr>
+          <tr><th>Score</th><td>__total__</td></tr>
+        </table>
+        <table class="allBorder">
+          <caption>Configuration</caption>
+          <tr><th>Redirections</th><td>__redirections__</td></tr>
+          <tr><th>Tool isolation</th><td>__isolation__</td></tr>
+          <tr><th>Report format(s)</th><td>__standard__</td></tr>
+          <tr><th>Requester</th><td>__requester__</td></tr>
+          <tr><th>Device</th><td>__device__</td></tr>
+          <tr><th>Browser type</th><td>__browser__</td></tr>
+          <tr><th>Reduced motion</th><td>__motion__</td></tr>
+          <tr><th>Tested by</th><td>Testaro__agent__, 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 id="intro">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, __element__ for the count of violating elements, __prevention__ for the page preventing tools from running, __log__ for browser warnings, and __latency__ for delayed page responses.</p>
+      <h2 id="summary">Issue summary</h2>
+      <h3>Details about this summary</h3>
+      <ul>
+        <li>This table shows the numbers of rule violations (<q>instances</q>) reported by one or more tools, classified by issue.</li>
+        <li>Tools often disagree on instance counts, because of non-equivalent rules or invalid tests. You can inspect the <a href="__reportURL__">full report</a> to diagnose differences.</li>
+        <li>The <q>WCAG</q> value is the principle, guideline, or success criterion of the <a href="https://www.w3.org/TR/WCAG22/">Web Content Accessibility Guidelines</a> most relevant to the issue.</li>
+        <li>The <q>Weight</q> value estimates the importance of an instance of the issue, from 1 (minor or advisory) to 4 (serious).</li>
+        <li>The <q>Score</q> value is the contribution of the instances of the issue to the page score.</li>
+        <li>An instance count of 0 means the tool has a rule belonging to the issue but reported no violations of that rule, although at least one tool reported at least one violation.</li>
+        <li>You can sort this table by WCAG, weight, or score.</li>
+      </ul>
+      <h3>The summary</h3>
+      <p role="status">Sorting is by <span id="sortBasis">score</span>.</p>
+      <p id="sortButtons">
+        <button id="sortButtonA" type="button">Sort by <span id="sortBasisA">WCAG</span></button>
+        <button id="sortButtonB" type="button">Sort by <span id="sortBasisB">weight</span></button>
+      </p>
+      <table class="allBorder thirdCellRight">
+        <caption>How many violations each tool reported, by issue</caption>
+        <thead>
+          <tr><th>Issue</th><th>WCAG</th><th>Weight</th><th>Score</th><th>Instance counts</th></tr>
+        </thead>
+        <tbody id="sumBody" class="headersLeft">
+          __issueRows__
+        </tbody>
+      </table>
+      <h2 id="itemization">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__
+      <h2 id="elements">Elements with issues</h2>
+      <p>Elements exhibiting issues:</p>
+      __elementRows__
+      <footer>
+        <p class="date">Produced <time itemprop="datePublished" datetime="__dateISO__">__dateSlash__</time></p>
+      </footer>
+    </main>
+  </body>
+</html>

package/procs/digest/tdp49/index.js ADDED Viewed

@@ -0,0 +1,240 @@
+/*
+  © 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: digester for scoring procedure tsp43.
+// IMPORTS
+// Module to keep secrets.
+require('dotenv').config();
+// Module to classify tool rules into issues
+const {issues} = require('../../score/tic45');
+// Module to process files.
+const fs = require('fs/promises');
+// Utility module.
+const {getNowDate, getNowDateSlash} = require('../../util');
+// CONSTANTS
+// Digester ID.
+const digesterID = 'tdp48';
+// Newline with indentations.
+const innerJoiner = '\n        ';
+const outerJoiner = '\n      ';
+// Directory of WCAG links.
+const wcagPhrases = {};
+// FUNCTIONS
+// Gets a row of the score-summary table.
+const getScoreRow = (componentName, score) => `<tr><th>${componentName}</th><td>${score}</td></tr>`;
+// Gets a WCAG link or, if not obtainable, a numeric identifier.
+const getWCAGTerm = wcag => {
+  const wcagPhrase = wcagPhrases[wcag];
+  const wcagTerm = wcagPhrase
+  ? `<a href="https://www.w3.org/WAI/WCAG22/Understanding/${wcagPhrase}.html">${wcag}</a>`
+  : wcag;
+  return wcagTerm;
+};
+// Gets a row of the issue-score-summary table.
+const getIssueScoreRow = (issueConstants, issueDetails) => {
+  const {summary, wcag, weight} = issueConstants;
+  const wcagTerm = getWCAGTerm(wcag);
+  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">${wcagTerm}<td class="right num">${weight}</td><td class="right num">${score}</td><td>${toolList}</td></tr>`;
+};
+// Populates the directory of WCAG understanding verbal IDs.
+const getWCAGPhrases = async () => {
+  // Get the copy of file https://raw.githubusercontent.com/w3c/wcag/main/guidelines/wcag.json.
+  const wcagJSON = await fs.readFile(`${__dirname}/../../../wcag.json`, 'utf8');
+  const wcag = JSON.parse(wcagJSON);
+  const {principles} = wcag;
+  // For each principle in it:
+  principles.forEach(principle => {
+    // If it is usable:
+    if (principle.num && principle.id && principle.id.startsWith('WCAG2:')) {
+      // Add it to the directory.
+      wcagPhrases[principle.num] = principle.id.slice(6);
+      const {guidelines} = principle;
+      // For each guideline in the principle:
+      guidelines.forEach(guideline => {
+        // If it is usable:
+        if (guideline.num && guideline.id && guideline.id.startsWith('WCAG2:')) {
+          // Add it to the directory.
+          wcagPhrases[guideline.num] = guideline.id.slice(6);
+          const {successcriteria} = guideline;
+          // For each success criterion in the guideline:
+          successcriteria.forEach(successCriterion => {
+            // If it is usable:
+            if (
+              successCriterion.num
+              && successCriterion.id
+              && successCriterion.id.startsWith('WCAG2:')
+            ) {
+              // Add it to the directory.
+              wcagPhrases[successCriterion.num] = successCriterion.id.slice(6);
+            }
+          });
+        }
+      });
+    }
+  });
+};
+// Adds parameters to a query for a digest.
+const populateQuery = async (report, query) => {
+  const {
+    browserID, device, id, isolate, lowMotion, score, sources, standard, strict, target
+  } = report;
+  const {agent, requester, script} = 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.url;
+  query.redirections = strict ? 'prohibited' : 'permitted';
+  query.isolation = isolate ? 'yes' : 'no';
+  query.standard
+  = ['original', 'standard', 'original and standard'][['no', 'only', 'also'].indexOf(standard)];
+  query.motion = lowMotion ? 'requested' : 'not requested';
+  query.requester = requester;
+  query.device = device.id;
+  query.browser = browserID;
+  query.agent = agent ? ` on agent ${agent}` : '';
+  query.reportURL = process.env.SCORED_REPORT_URL.replace('__id__', id);
+  // Populate the WCAG phrase directory.
+  await getWCAGPhrases();
+  // Add values for the score-summary table to the query.
+  const rows = {
+    summaryRows: [],
+    issueRows: []
+  };
+  ['total', 'issueCount', 'issue', 'solo', 'tool', 'element', '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 => {
+    const issueSummary = issues[issueID].summary;
+    issueDetailRows.push(`<h3 class="bars">Issue: ${issueSummary}</h3>`);
+    issueDetailRows.push(`<p>Impact: ${issues[issueID].why || 'N/A'}</p>`);
+    const wcag = issues[issueID].wcag;
+    const wcagTerm = wcag ? getWCAGTerm(wcag) : 'N/A';
+    issueDetailRows.push(`<p>WCAG: ${wcagTerm}</p>`);
+    const issueData = details.issue[issueID];
+    issueDetailRows.push(`<p>Score: ${issueData.score}</p>`);
+    issueDetailRows.push('<h4>Elements</h4>');
+    const issuePaths = details.element[issueID];
+    if (issuePaths.length) {
+      issueDetailRows.push('<ul>');
+      issuePaths.forEach(pathID => {
+        issueDetailRows.push(`  <li>${pathID}</li>`);
+      });
+      issueDetailRows.push('</ul>');
+    }
+    else {
+      issueDetailRows.push('<p>None identified</p>');
+    }
+    const toolIDs = Object.keys(issueData.tools);
+    toolIDs.forEach(toolID => {
+      issueDetailRows.push(`<h4>Violations of <code>${toolID}</code> rules</h4>`);
+      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>`);
+        /*
+        This fails unless the caller handles such URLs and has compatible scored report URLs.
+        const href = `${query.reportURL}?tool=${toolID}&rule=${ruleID}`;
+        const detailLabel = `Issue ${issueSummary} tool ${toolID} rule ${ruleID} instance details`;
+        issueDetailRows.push(
+          `<p><a href="${href}" aria-label="${detailLabel}">Instance details</a></p>`
+        );
+        */
+      });
+    });
+  });
+  query.issueDetailRows = issueDetailRows.join(outerJoiner);
+  // Add paragraphs about the elements to the query.
+  const elementRows = [];
+  const issueElements = {};
+  Object.keys(details.element).forEach(issueID => {
+    const pathIDs = details.element[issueID];
+    pathIDs.forEach(pathID => {
+      issueElements[pathID] ??= [];
+      issueElements[pathID].push(issueID);
+    });
+  });
+  const sortedPathIDs = Object.keys(issueElements).sort();
+  sortedPathIDs.forEach(pathID => {
+    const elementIssues = issueElements[pathID];
+    if (elementIssues) {
+      elementRows.push(
+        `<h5>Element <code>${pathID}</code></h5>`,
+        '<ul>',
+        ... elementIssues.map(issueID => `  <li>${issues[issueID].summary}</li>`).sort(),
+        '</ul>'
+      );
+    }
+  });
+  query.elementRows = elementRows.join(outerJoiner);
+};
+// Returns a digested report.
+exports.digester = async report => {
+  // Create a query to replace placeholders.
+  const query = {};
+  await 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;
+};