@jrpool/kilotest 24.0.4

package/rules/index.js

@@ -0,0 +1,71 @@
+/*
+  index.js
+  Answers the issue-rules question.
+*/
+
+// IMPORTS
+
+const {
+  getWeightName,
+  htmlSafe,
+  tools
+} = require('../util');
+const {issues} = require('testilo/procs/score/tic');
+const fs = require('fs/promises');
+const path = require('path');
+
+// FUNCTIONS
+
+// Adds parameters to a query for the answer page.
+const populateQuery = async (issueID, query) => {
+  // Add facts about the issue to the query.
+  query.issue = issues[issueID].summary;
+  const issue = issues[issueID];
+  const {wcag, weight, why} = issue;
+  query.why = why;
+  query.priority = getWeightName(weight);
+  query.wcag = wcag;
+  // Initialize the lines.
+  const lines = [];
+  const margin = ' '.repeat(6);
+  // For each tool with any rules belonging to the issue:
+  Object.keys(issue.tools).forEach(toolID => {
+    // Add a line.
+    lines.push(`${margin}<li><h3>${tools[toolID][0]} rules</h3>`);
+    lines.push(`${margin}  <ul>`);
+    const tool = issue.tools[toolID];
+    // For each rule of the tool belonging to the issue:
+    Object.keys(tool).forEach(ruleID => {
+      const rule = tool[ruleID];
+      const {what} = rule;
+      // Add facts about the rule.
+      if (what === ruleID) {
+        lines.push(`${margin}    <li><code>${htmlSafe(ruleID)}</code></li>`);
+      }
+      else {
+        lines.push(`${margin}    <li><code>${htmlSafe(ruleID)}</code>: ${htmlSafe(what)}</li>`);
+      }
+    });
+    lines.push(`${margin}  </ul>`);
+    lines.push(`${margin}</li>`);
+  });
+  // Add the lines to the query.
+  query.rules = lines.join('\n');
+};
+// Returns a page answering the violators question.
+exports.answer = async issueID => {
+  const query = {};
+  // Create a query to replace the placeholders.
+  await populateQuery(issueID, query);
+  // Get the template.
+  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
+  // Replace its placeholders.
+  Object.keys(query).forEach(param => {
+    answerPage = answerPage.replace(new RegExp(`__${param}__`, 'g'), query[param]);
+  });
+  // Return the populated page.
+  return {
+    status: 'ok',
+    answerPage
+  };
+};

package/style.css

@@ -0,0 +1,196 @@
+*:focus {
+  outline: solid 0.2rem #00f;
+  outline-offset: 0.2rem;
+}
+a:hover {
+  background-color: #ddd;
+}
+body {
+  margin: 2rem;
+  font-size: large;
+}
+.bold, .componentID {
+  font-weight: 700;
+}
+button {
+  min-height: 44px;
+  min-width: 44px;
+  padding: 0.5rem;
+  border: solid 0.2rem #03a;
+  border-radius: 1rem;
+  font-size: inherit;
+  font-weight: 700;
+  color: #fff;
+  background-color: #03a;
+}
+button:disabled, button:disabled:hover {
+  color: #666;
+  background-color: #ccc;
+  border-color: #666;
+}
+button:hover {
+  color: #000;
+  background-color: #9df;
+}
+caption {
+  margin: 1rem 0;
+  font-weight: 700;
+  font-style: italic;
+}
+.center {
+  text-align: center;
+}
+code {
+  font-family: sans-serif;
+  color: #832703;
+}
+code.thin {
+  font-weight: 400;
+}
+details {
+  padding: rem;
+  border: solid #000 1px;
+}
+.error {
+  font-weight: 700;
+  color: #c00;
+}
+fieldset {
+  width: max-content;
+  margin-top: 1rem;
+}
+.firstCellRight td:nth-child(1) {
+  text-align: right;
+}
+form {
+  margin-top: 1rem;
+}
+h4, h5, h6 {
+  margin-top: 1rem;
+  margin-bottom: 0;
+}
+h2 {
+  font-size: 1.8rem;
+  margin: 1rem auto 0.5rem auto;
+  color: #006666;
+}
+h3 {
+  font-size: 1.6rem;
+  margin: 1rem auto 0.5rem auto;
+}
+h3.bars {
+  border-top: solid black 0.1rem;
+  padding-top: 1rem;
+}
+h3.priority {
+  display: inline;
+  margin: 0.5rem 0;
+}
+h4 {
+  font-size: 1.4rem;
+}
+h4.priority {
+  display: inline;
+  margin: 0.25rem 0;
+}
+h5 {
+  font-size: 1.2rem;
+}
+h6 {
+  font-size: 1rem;
+}
+input {
+  margin: 0.5rem 0;
+  font-size: inherit;
+}
+legend {
+  font-weight: 700;
+}
+li, p {
+  line-height: 1.5;
+}
+p {
+  margin: 0.5rem 0;
+}
+pre {
+  white-space: break-spaces;
+}
+.secondCellRight td:nth-child(2) {
+  text-align: right;
+}
+section:not(.wide) {
+  max-width: 36rem;
+}
+summary {
+  box-sizing: border-box;
+  min-height: 44px;
+  min-width: 44px;
+  padding: 0.75rem 0.5rem 0 0.5rem;
+}
+summary:focus, ul.nav > li > a:focus {
+  outline-offset: -6px;
+}
+summary:hover {
+  background-color: #ddd;
+}
+#synopsis > p {
+  margin: 0;
+  padding: 0;
+}
+table {
+  border-collapse: collapse;
+}
+table.allBorder th {
+  padding-bottom: 0;
+}
+table.allBorder th, table.allBorder td, tbody td {
+  border: 1px gray solid;
+}
+tbody th {
+  padding-right: 1rem;
+  text-align: right;
+}
+td, th {
+  padding: 0 0.5rem;
+}
+thead th {
+  padding-bottom: 1rem;
+}
+.thirdCellRight td:nth-child(3) {
+  text-align: right;
+}
+ul {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+ul.pseudoTopLevel {
+  list-style: disc;
+}
+ul.nav {
+  padding-inline-start: 0.25rem;
+}
+ul.nav > li, ul.headed > li {
+  list-style: none;
+}
+ul.nav > li > a {
+  display: block;
+  box-sizing: border-box;
+  min-height: 44px;
+  min-width: 44px;
+  margin-right: 1rem;
+  padding-left: 1rem;
+  padding-top: 0.5rem;
+}
+ul.whereList {
+  margin-left: 2rem;
+  padding-left: 0;
+}
+ul.xPathList {
+  margin-left: 0;
+  padding-left: 0;
+}
+ul.xPathList li {
+  margin-left: 1rem;
+  padding-left: 0;
+  overflow-wrap: break-word;
+}

package/targets/index.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="publisher" content="Jonathan Robert Pool">
+    <meta name="creator" content="Jonathan Robert Pool">
+    <meta name="keywords" content="report,accessibility,a11y">
+    <title>Pages tested | Kilotest</title>
+    <link rel="icon" href="/favicon.ico">
+    <link rel="stylesheet" href="/style.css">
+  </head>
+  <body>
+    <main>
+      <h1>Pages tested by <a href="/">Kilotest</a></h1>
+      <h2>Recommended for testing</h2>
+      <ol>
+        __recs__
+      </ol>
+      <p>__noRecs__</p>
+      <p>Should Kilotest <a href="testRecForm.html">test a page</a> that is not listed below?</p>
+      <h2>Queued for testing</h2>
+      <ol>
+        __queue__
+      </ol>
+      <p>__noQueued__</p>
+      <h2>Being tested now</h2>
+      <ul>
+        __claimed__
+      </ul>
+      <p>__noClaimed__</p>
+      <h2>Already tested</h2>
+      <p>Kilotest has tested __which__ pages.</p>
+      __testedPages__
+    </main>
+  </body>
+</html>

package/targets/index.js

@@ -0,0 +1,170 @@
+/*
+  index.js
+  Answers the targets question.
+*/
+
+// IMPORTS
+
+const {
+  getAgoDays,
+  getJobNames,
+  getObject,
+  getPageDataStrings,
+  getRecs,
+  getToolNamesString,
+  getLogs,
+  getTargetData,
+  isRecommendable,
+  jobsPath
+} = require('../util');
+const fs = require('fs/promises');
+const path = require('path');
+
+// FUNCTIONS
+
+// Returns a description of a tool count.
+const getToolCountString = toolCount => toolCount === 1 ? '1 tool' : `${toolCount} tools`;
+// Adds parameters to a query for the answer page.
+const populateQuery = async query => {
+  const margin = ' '.repeat(8);
+  // Initialize the classes of lines.
+  const lines = {
+    recs: [],
+    queue: [],
+    claimed: [],
+    tested: []
+  };
+  // Get the recommendations.
+  const recs = await getRecs();
+  // For each recommended URL:
+  Object.keys(recs).forEach(url => {
+    // For each of its recommendations:
+    recs[url].forEach(rec => {
+      const {what, why} = rec;
+      // Add a line.
+      lines.recs.push(`${margin}<li><code>${url}</code> (${what}): ${why}</li>`);
+    });
+  });
+  // Sort the lines in alphabetical order by URL and secondarily by proposed name.
+  lines.recs.sort();
+  // Add the lines to the query.
+  query.recs = lines.recs.join('\n');
+  // Add a no-recommendations message, if applicable, to the query.
+  query.noRecs = lines.recs.length
+  ? 'Kilotest managers can <a href="recActionForm.html">approve or reject a recommendation</a>.'
+  : 'No recommendations await approval now.';
+  // Get the file names of all queued and claimed jobs.
+  const jobFileNames = await getJobNames();
+  // For each job category:
+  for (const category of ['queue', 'claimed']) {
+    // For each job in the category:
+    for (const fileName of jobFileNames[category]) {
+      // Get the job.
+      const job = await getObject(path.join(jobsPath, category, fileName));
+      // Add a line.
+      lines[category].push(`${margin}<li><code>${job.target.url}</code> (${job.target.what})</li>`);
+    }
+    // Add the lines to the query.
+    query[category] = lines[category].join('\n');
+  }
+  // Add a no-queued message, if applicable, to the query.
+  query.noQueued = lines.queue.length ? '' : 'No pages are queued for testing.';
+  // Add a no-claimed message, if applicable, to the query.
+  query.noClaimed = lines.claimed.length ? '' : 'No pages are being tested now.';
+  // Get the logs of the reports.
+  const targetLogs = (await getLogs()).filter(log => ! log.hidden);
+  query.which = targetLogs.length ? 'the following' : 'no';
+  query.some = (targetLogs.length || jobFileNames.queue.length || jobFileNames.claimed.length)
+  ? 'another'
+  : 'a';
+  const multiReportTargets = new Set(targetLogs.filter(log => log.superseded).map(log => log.what));
+  // For each log that is not hidden:
+  for (const targetLog of targetLogs) {
+    const {jobName, url, what} = targetLog;
+    const [timeStamp, jobID] = jobName.split('-');
+    const reportData = await getTargetData(timeStamp, jobID);
+    const {issueSet, preventedTools, reporterSet, violatorSet} = reportData;
+    lines.tested.push(`${margin}<details>`);
+    const daysAgo = getAgoDays(timeStamp);
+    const pageDataStrings = await getPageDataStrings(timeStamp, jobID, {what, url, daysAgo});
+    const {urlLink, testInfo} = pageDataStrings;
+    const testText = multiReportTargets.has(what) ? ` (${testInfo.toLowerCase()})` : '';
+    lines.tested.push(`${margin}  <summary>${what}${testText}</summary>`);
+    lines.tested.push(`${margin}  <ul>`);
+    // Add the URL of the target to the lines.
+    lines.tested.push(`${margin}    <li>URL: ${urlLink}</li>`);
+    // Add facts about the report to the lines.
+    lines.tested.push(`${margin}    <li>${testInfo}</li>`);
+    // If the page prevented any tool from performing its tests:
+    if (preventedTools?.length) {
+      // Add this to the lines.
+      const preventedToolSet = new Set(preventedTools);
+      const toolCountString = getToolCountString(preventedToolSet.size);
+      const toolsString = getToolNamesString(preventedToolSet);
+      lines.tested.push(
+        `${margin}    <li>Page not testable by ${toolCountString} (${toolsString})</li>`,
+      );
+    }
+    // Add facts about the test results to the lines.
+    const reporterCount = reporterSet.size;
+    const reporterCountString = getToolCountString(reporterCount);
+    let reporterString = reporterCountString;
+    if (reporterCount) {
+      const reporterNamesString = getToolNamesString(reporterSet);
+      reporterString = `${reporterCountString} (${reporterNamesString})`;
+    }
+    const issueCountString = issueSet.size === 1 ? '1 issue was' : `${issueSet.size} issues were`;
+    const violatorString = violatorSet.size === 1
+    ? '1 violator was'
+    : `${violatorSet.size} violators were`;
+    lines.tested.push(`${margin}    <li>${reporterString} reported issues</li>`);
+    lines.tested.push(`${margin}    <li>${issueCountString} reported</li>`);
+    lines.tested.push(`${margin}    <li>${violatorString} reported</li>`);
+    lines.tested.push(`${margin}  </ul>`);
+    lines.tested.push(`${margin}<ul class="nav">`);
+    // If any issues were reported:
+    if (issueSet.size) {
+      // Add a question link about the reported issues to the lines.
+      const href = `href="reportIssues.html/${timeStamp}/${jobID}"`;
+      const label = `aria-label="What ${issueCountString} reported for the ${what} page?"`;
+      const questionString = issueSet.size === 1 ? 'was the issue' : 'were the issues';
+      const link = `<a ${href} ${label}>What ${questionString}?</a>`;
+      lines.tested.push(`${margin}    <li>${link}</li>`);
+    }
+    // Add the status of, and if necessary a question link about, retesting to the lines.
+    const status = await isRecommendable(url);
+    let retestString;
+    if (status === 'claimed') {
+      retestString = 'Currently being retested';
+    }
+    else if (status === 'queued') {
+      retestString = 'Currently in the queue for retesting';
+    }
+    else {
+      const href = `/retestRecForm.html/${timeStamp}/${jobID}`;
+      const retestContent = 'Should Kilotest retest the page?';
+      retestString = `<a href="${href}">${retestContent}</a>`;
+    }
+    lines.tested.push(`${margin}    <li>${retestString}</li>`);
+    lines.tested.push(`${margin}  </ul>`);
+    lines.tested.push(`${margin}</details>`);
+  }
+  query.testedPages = lines.tested.join('\n');
+};
+// Returns a page answering the targets question.
+exports.answer = async () => {
+  const query = {};
+  // Create a query to replace placeholders.
+  await populateQuery(query);
+  // Get the template.
+  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
+  // Replace its placeholders.
+  Object.keys(query).forEach(param => {
+    answerPage = answerPage.replace(new RegExp(`__${param}__`, 'g'), query[param]);
+  });
+  // Return the populated page.
+  return {
+    status: 'ok',
+    answerPage
+  };
+};

package/testOrder/index.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="publisher" content="Jonathan Robert Pool">
+    <meta name="creator" content="Jonathan Robert Pool">
+    <meta name="keywords" content="report,accessibility,a11y">
+    <title>Test order | Kilotest</title>
+    <link rel="icon" href="/favicon.ico">
+    <link rel="stylesheet" href="/style.css">
+  </head>
+  <body>
+    <main>
+      <h1><a href="/">Kilotest</a>: Test order for __target__</h1>
+      <p>A job that will test the __target__ page has been placed into the job queue.</p>
+      <p>The job name is <code>__jobName__</code>.</p>
+      <p>When Kilotest is not busy, a job is typically completed within about a day after submission.</p>
+      <p>Once the job has been completed, it will appear in the answer to the question, <q>Which web pages have been tested?</q>.</p>
+      <p>All recommendations for the retest of the __target__ page have been deleted.</p>
+    </main>
+  </body>
+</html>

package/testOrder/index.js

@@ -0,0 +1,62 @@
+/*
+  index.js
+  Implements a retest order.
+*/
+
+// IMPORTS
+
+const {getJSON, getNowStamp, getRecs, isURL} = require('../util');
+const fs = require('fs/promises');
+const path = require('path');
+
+// FUNCTIONS
+
+// Implements a test order and returns an acknowledgement page.
+exports.answer = async (url, what, authCode) => {
+  // If the arguments are valid:
+  if (isURL(url) && what && authCode === process.env.AUTH_CODE) {
+    // Get the job template.
+    const jobTemplateJSON = await fs.readFile(path.join(__dirname, '..', 'job.json'), 'utf8');
+    const job = JSON.parse(jobTemplateJSON);
+    const nowStamp = getNowStamp();
+    // Populate the template with job properties.
+    const jobIDSuffix = Date.now().toString(36).slice(5);
+    const jobName = `${nowStamp}-${jobIDSuffix}`;
+    job.id = jobName;
+    job.creationTimeStamp = nowStamp;
+    job.executionTimeStamp = nowStamp;
+    job.target.what = what;
+    job.target.url = url;
+    const query = {
+      target: what,
+      jobName
+    };
+    // Save the job in the queue.
+    await fs.writeFile(
+      path.join(__dirname, '..', 'jobs', 'queue', `${jobName}.json`), getJSON(job)
+    );
+    console.log(`Retest queued for ${what} as job ${jobName}`);
+    // Get the recommendations.
+    const recs = await getRecs();
+    // Delete the recommendations to retest the target.
+    delete recs[url];
+    // Save the revised recommendations.
+    await fs.writeFile(path.join(__dirname, '..', 'jobs', 'recs.json'), getJSON(recs));
+    // Get the answer template.
+    let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
+    // Replace its placeholders.
+    Object.keys(query).forEach(param => {
+      answerPage = answerPage.replace(new RegExp(`__${param}__`, 'g'), query[param]);
+    });
+    // Return the populated page.
+    return {
+      status: 'ok',
+      answerPage
+    };
+  }
+  // Otherwise, i.e. if the authorization code is invalid, return an error page.
+  return {
+    status: 'error',
+    error: 'Invalid authorization code'
+  };
+};

package/testRec/index.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="publisher" content="Jonathan Robert Pool">
+    <meta name="creator" content="Jonathan Robert Pool">
+    <meta name="keywords" content="report,accessibility,a11y">
+    <title>__target__ test recommendation received | Kilotest</title>
+    <link rel="icon" href="/favicon.ico">
+    <link rel="stylesheet" href="/style.css">
+  </head>
+  <body>
+    <main>
+      <h1><a href="/">Kilotest</a>: Test recommendation received for __target__</h1>
+      <p>Your recommendation to test the __target__ page has been received.</p>
+      <p>The reason for your recommendation has been recorded as <q>__why__</q>.</p>
+      <p>Thank you for your recommendation.</p>
+      <p>If a <a href="/recActionForm.html">Kilotest manager approves this recommendation</a>, a test order will be added to the queue.</p>
+      <p>In most cases, if you check Kilotest again in 1 day, you will find that the recommended job has been performed.</p>
+    </main>
+  </body>
+</html>

package/testRec/index.js

@@ -0,0 +1,25 @@
+/*
+  index.js
+  Processes a test recommendation.
+*/
+
+// IMPORTS
+
+const {isRecommendable, processRec} = require('../util');
+
+// FUNCTIONS
+
+// Records a test recommendation and returns an acknowledgement page.
+exports.answer = async (what, url, why) => {
+  const status = await isRecommendable(url);
+  // If the target is already claimed or queued and is thus not recommendable:
+  if (status) {
+    // Return an answer reporting this.
+    return {
+      status: 'error',
+      error: `Page is already ${status}`
+    };
+  }
+  // Otherwise, i.e. if it is recommendable, process the recommendation.
+  return await processRec('test', __dirname, what, url, why);
+};

package/testRecForm/index.html

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="publisher" content="Jonathan Robert Pool">
+    <meta name="creator" content="Jonathan Robert Pool">
+    <meta name="keywords" content="report,accessibility,a11y">
+    <title>Test recommendation | Kilotest</title>
+    <link rel="icon" href="/favicon.ico">
+    <link rel="stylesheet" href="/style.css">
+  </head>
+  <body>
+    <main>
+      <h1><a href="/">Kilotest</a>: Test recommendation</h1>
+      <p>You may recommend a web page for testing by submitting the following form. All answers are required.</p>
+      <form action="/testRec.html" method="post">
+        <p><label>
+          Propose a name for the page.<br>
+          <input size="50" maxlength="70" name="what" required>
+        </label></p>
+        <p><label>
+          What is the URL (starting with <code>https://</code>)?<br>
+          <input type="url" size="60" maxlength="80" name="url" pattern="https://.+\..+" required>
+        </label></p>
+        <p><label>
+          Why test the page?<br>
+          <input size="70" minlength="5" maxlength="100" name="why" required>
+        </label></p>
+        <p><button type="submit">Submit</button></p>
+      </form>
+    </main>
+  </body>
+</html>

package/testRecForm/index.js

@@ -0,0 +1,22 @@
+/*
+  index.js
+  Answers the test question.
+*/
+
+// IMPORTS
+
+const fs = require('fs/promises');
+const path = require('path');
+
+// FUNCTIONS
+
+// Returns a test recommendation form.
+exports.answer = async () => {
+  // Get the recommendation form template.
+  let answerPage = await fs.readFile(path.join(__dirname, 'index.html'), 'utf8');
+  // Return it.
+  return {
+    status: 'ok',
+    answerPage
+  };
+};