@jrpool/kilotest 46.0.5 → 46.0.7

package/index.js

@@ -861,6 +861,10 @@ const requestHandler = async (request, response) => {
   }
 };
 
+// EXPORTS
+
+exports.requestHandler = requestHandler;
+
 // SERVER
 
 const serve = async (protocolModule, options) => {
@@ -879,23 +883,25 @@ const serve = async (protocolModule, options) => {
 
 // EXECUTION
 
-if (protocol === 'http') {
-  console.log('Starting HTTP server');
-  serve(http, {});
-}
-else if (protocol === 'https') {
-  console.log('Starting HTTPS server');
-  fs.readFile(process.env.KEY, 'utf8')
-  .then(
-    key => {
-      fs.readFile(process.env.CERT, 'utf8')
-      .then(
-        cert => {
-          serve(https, {key, cert});
-        },
-        error => console.log(error.message)
-      );
-    },
-    error => console.log(error.message)
-  );
+if (require.main === module) {
+  if (protocol === 'http') {
+    console.log('Starting HTTP server');
+    serve(http, {});
+  }
+  else if (protocol === 'https') {
+    console.log('Starting HTTPS server');
+    fs.readFile(process.env.KEY, 'utf8')
+    .then(
+      key => {
+        fs.readFile(process.env.CERT, 'utf8')
+        .then(
+          cert => {
+            serve(https, {key, cert});
+          },
+          error => console.log(error.message)
+        );
+      },
+      error => console.log(error.message)
+    );
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrpool/kilotest",
-  "version": "46.0.5",
+  "version": "46.0.7",
   "description": "Ensemble testing for front-end web quality",
   "main": "index.js",
   "engines": {
@@ -10,7 +10,6 @@
     "start": "node index",
     "lint": "npx eslint && npx markdownlint-cli2",
     "test": "c8 node --test",
-    "test:api": "node api/testSuite",
     "generate:openapi": "node scripts/generate-openapi"
   },
   "repository": {
@@ -49,6 +48,7 @@
     "globals": "*",
     "js-yaml": "*",
     "markdownlint-cli2": "*",
+    "node-html-parser": "*",
     "zod-openapi": "*"
   },
   "allowScripts": {

package/routing.test.js

@@ -0,0 +1,77 @@
+/*
+  routing.test.js
+  Integration tests for HTTP routing in index.js, verifying that POST-only API services reject GET requests.
+*/
+
+// IMPORTS
+
+const {test, before, after} = require('node:test');
+const assert = require('node:assert/strict');
+const path = require('node:path');
+const http = require('node:http');
+const {requestHandler} = require('./index');
+
+// CONSTANTS
+
+const port = 3999;
+
+// SETUP AND TEARDOWN
+
+const savedDBDir = process.env.DB_DIR;
+let server;
+
+before(async () => {
+  process.env.DB_DIR = path.join(__dirname, 'test', 'fixtures', 'db');
+  server = http.createServer(requestHandler);
+  await new Promise(resolve => server.listen(port, resolve));
+});
+
+after(async () => {
+  if (savedDBDir !== undefined) {
+    process.env.DB_DIR = savedDBDir;
+  }
+  else {
+    delete process.env.DB_DIR;
+  }
+  await new Promise(resolve => server.close(() => resolve()));
+});
+
+// HELPERS
+
+// Sends a GET request and returns the response body as a string.
+const get = requestPath => new Promise((resolve, reject) => {
+  http.request({method: 'GET', host: 'localhost', port, path: requestPath}, response => {
+    const chunks = [];
+    response.on('data', chunk => chunks.push(chunk));
+    response.on('end', () => {
+      resolve({statusCode: response.statusCode, body: chunks.join('')});
+    });
+  })
+  .on('error', reject)
+  .end();
+});
+
+// TESTS
+
+test('GET /api/requestTest returns an error, not a test-request response', async () => {
+  const result = await get('/api/requestTest');
+  assert.ok(result.body.includes('Invalid service request'));
+});
+
+test('GET /api/requestRetest returns an error, not a retest-request response', async () => {
+  const result = await get('/api/requestRetest/260101T0001/ct');
+  assert.ok(result.body.includes('Invalid service request'));
+});
+
+test('GET /api/requestFeature returns an error, not a feature-request response', async () => {
+  const result = await get('/api/requestFeature');
+  assert.ok(result.body.includes('Invalid service request'));
+});
+
+test('GET /api/listReports returns a valid JSON response', async () => {
+  const result = await get('/api/listReports');
+  const body = JSON.parse(result.body);
+  assert.equal(body['tool name'], 'listReports');
+  const reports = body['response content']['basics about all available reports'];
+  assert.equal(reports.length, 6);
+});

package/util.js

@@ -641,11 +641,11 @@ exports.getPageDataStrings = async (timeStamp, jobID, pageData) => {
 };
 // Returns the creation time and size of a report.
 const getReportStats = exports.getReportStats = async (timeStamp, jobID) => {
-  const reportStat = await fs.stat(
-    path.join(reportsPath(), `${timeStamp}-${jobID}.json`),
-    {throwIfNoEntry: false}
-  );
-  if (!reportStat) {
+  let reportStat;
+  try {
+    reportStat = await fs.stat(path.join(reportsPath(), `${timeStamp}-${jobID}.json`));
+  }
+  catch {
     return null;
   }
   const reportTime = reportStat.birthtime;

package/web/listDiagnoses/listDiagnoses.test.js

@@ -0,0 +1,74 @@
+/*
+  listDiagnoses.test.js
+  UI tests for web/listDiagnoses/index.js using the fixture corpus.
+*/
+
+// IMPORTS
+
+const {test, before, after} = require('node:test');
+const assert = require('node:assert/strict');
+const path = require('node:path');
+const {parse} = require('node-html-parser');
+const {answer} = require('./index');
+
+// SETUP AND TEARDOWN
+
+const savedDBDir = process.env.DB_DIR;
+
+before(() => {
+  process.env.DB_DIR = path.join(__dirname, '..', '..', 'test', 'fixtures', 'db');
+});
+
+after(() => {
+  if (savedDBDir !== undefined) {
+    process.env.DB_DIR = savedDBDir;
+  }
+  else {
+    delete process.env.DB_DIR;
+  }
+});
+
+// TESTS
+
+test('listDiagnoses returns an ok status with valid HTML for catalogIndex 0, linkNoText, in the mixed report', async () => {
+  const result = await answer('linkNoText/260101T0000/mix/0');
+  assert.equal(result.status, 'ok');
+  assert.ok(result.answerPage);
+  const html = parse(result.answerPage);
+  assert.ok(html.querySelector('title'));
+});
+
+test('listDiagnoses includes the issue summary in the HTML', async () => {
+  const result = await answer('linkNoText/260101T0000/mix/0');
+  assert.ok(result.answerPage.includes('link not named'));
+});
+
+test('listDiagnoses includes the element tag name and text from the catalog', async () => {
+  const result = await answer('linkNoText/260101T0000/mix/0');
+  assert.ok(result.answerPage.includes('About Us'));
+});
+
+test('listDiagnoses includes diagnosis descriptions from the rule engines', async () => {
+  const result = await answer('linkNoText/260101T0000/mix/0');
+  assert.ok(result.answerPage.includes('The link does not have an accessible name'));
+});
+
+test('listDiagnoses returns an error status for a hidden report', async () => {
+  const result = await answer('linkNoText/260101T0007/hid/0');
+  assert.equal(result.status, 'error');
+});
+
+test('listDiagnoses returns an error status for a nonexistent report', async () => {
+  const result = await answer('linkNoText/999999T9999/xyz/0');
+  assert.equal(result.status, 'error');
+});
+
+test('listDiagnoses returns ok with no diagnoses for a nonexistent catalog index', async () => {
+  const result = await answer('linkNoText/260101T0000/mix/999');
+  assert.equal(result.status, 'ok');
+  const html = parse(result.answerPage);
+  const diagnosisItems = html.querySelectorAll('li');
+  // The page may have other li elements, but none should contain diagnosis descriptions.
+  const diagnosisTexts = diagnosisItems.map(li => li.text);
+  assert.ok(!diagnosisTexts.some(t => t.includes('The link does not have an accessible name')));
+});

package/web/listIssues/index.js

@@ -64,9 +64,9 @@ const getIssuesData = async (timeStamp, jobID) => {
         const instances = result?.standardResult?.instances ?? [];
         // For each of its standard instances:
         instances.forEach(instance => {
-          const {catalogIndex, issueID} = instance;
-          // If the instance identifies its rule as belonging to a non-ignorable issue:
-          if (issueID && issueID !== 'ignorable') {
+          const {catalogIndex, issueID, outcome} = instance;
+          // If the instance reports a violation and identifies a non-ignorable issue:
+          if (outcome !== 'cantTell' && issueID && issueID !== 'ignorable') {
             const issueClassification = issueSpecs[issueID];
             // If the issue has a current weighted classification:
             if (issueClassification && [1, 2, 3, 4].includes(issueClassification.weight)) {

package/web/listIssues/listIssues.test.js

@@ -0,0 +1,80 @@
+/*
+  listIssues.test.js
+  UI tests for web/listIssues/index.js using the fixture corpus.
+*/
+
+// IMPORTS
+
+const {test, before, after} = require('node:test');
+const assert = require('node:assert/strict');
+const path = require('node:path');
+const {parse} = require('node-html-parser');
+const {answer} = require('./index');
+
+// SETUP AND TEARDOWN
+
+const savedDBDir = process.env.DB_DIR;
+
+before(() => {
+  process.env.DB_DIR = path.join(__dirname, '..', '..', 'test', 'fixtures', 'db');
+});
+
+after(() => {
+  if (savedDBDir !== undefined) {
+    process.env.DB_DIR = savedDBDir;
+  }
+  else {
+    delete process.env.DB_DIR;
+  }
+});
+
+// TESTS
+
+test('listIssues returns an ok status with valid HTML for the mixed report', async () => {
+  const result = await answer('260101T0000/mix');
+  assert.equal(result.status, 'ok');
+  assert.ok(result.answerPage);
+  const html = parse(result.answerPage);
+  assert.ok(html.querySelector('title'));
+});
+
+test('listIssues includes the page description in the HTML for the mixed report', async () => {
+  const result = await answer('260101T0000/mix');
+  assert.ok(result.answerPage.includes('Mixed Outcomes Page'));
+});
+
+test('listIssues includes links to listViolators for issues in the mixed report', async () => {
+  const result = await answer('260101T0000/mix');
+  const html = parse(result.answerPage);
+  const violatorLinks = html.querySelectorAll('a[href*="listViolators.html"]');
+  assert.ok(violatorLinks.length >= 2);
+  const hrefs = violatorLinks.map(a => a.getAttribute('href'));
+  assert.ok(hrefs.some(href => href.includes('linkNoText')));
+  assert.ok(hrefs.some(href => href.includes('allCaps')));
+});
+
+test('listIssues returns an error status for a hidden report', async () => {
+  const result = await answer('260101T0007/hid');
+  assert.equal(result.status, 'error');
+});
+
+test('listIssues returns an error status for a nonexistent report', async () => {
+  const result = await answer('999999T9999/xyz');
+  assert.equal(result.status, 'error');
+});
+
+test('listIssues for the all-cantTell report shows no issue links', async () => {
+  const result = await answer('260101T0001/ct');
+  assert.equal(result.status, 'ok');
+  const html = parse(result.answerPage);
+  const violatorLinks = html.querySelectorAll('a[href*="listViolators.html"]');
+  assert.equal(violatorLinks.length, 0);
+});
+
+test('listIssues for the empty report shows no issue links', async () => {
+  const result = await answer('260101T0005/emp');
+  assert.equal(result.status, 'ok');
+  const html = parse(result.answerPage);
+  const violatorLinks = html.querySelectorAll('a[href*="listViolators.html"]');
+  assert.equal(violatorLinks.length, 0);
+});

package/web/listReports/listReports.test.js

@@ -0,0 +1,84 @@
+/*
+  listReports.test.js
+  UI tests for web/listReports/index.js using the fixture corpus.
+*/
+
+// IMPORTS
+
+const {test, before, after} = require('node:test');
+const assert = require('node:assert/strict');
+const path = require('node:path');
+const {parse} = require('node-html-parser');
+const {answer} = require('./index');
+
+// SETUP AND TEARDOWN
+
+const savedDBDir = process.env.DB_DIR;
+
+before(() => {
+  process.env.DB_DIR = path.join(__dirname, '..', '..', 'test', 'fixtures', 'db');
+});
+
+after(() => {
+  if (savedDBDir !== undefined) {
+    process.env.DB_DIR = savedDBDir;
+  }
+  else {
+    delete process.env.DB_DIR;
+  }
+});
+
+// TESTS
+
+test('listReports returns an ok status with valid HTML', async () => {
+  const result = await answer();
+  assert.equal(result.status, 'ok');
+  assert.ok(result.answerPage);
+  const html = parse(result.answerPage);
+  assert.equal(html.querySelector('title').text, 'Pages tested | Kilotest');
+});
+
+test('listReports includes the 6 non-hidden fixture reports as details elements', async () => {
+  const result = await answer();
+  const html = parse(result.answerPage);
+  const details = html.querySelectorAll('details');
+  assert.equal(details.length, 6);
+});
+
+test('listReports includes the page descriptions in summary elements', async () => {
+  const result = await answer();
+  const html = parse(result.answerPage);
+  const summaries = html.querySelectorAll('details > summary').map(s => s.text);
+  assert.ok(summaries.some(s => s.startsWith('Mixed Outcomes Page')));
+  assert.ok(summaries.some(s => s.startsWith('All CantTell Page')));
+  assert.ok(summaries.some(s => s.startsWith('No Outcomes Page')));
+  assert.ok(summaries.some(s => s.startsWith('Empty Results Page')));
+  assert.ok(summaries.some(s => s.startsWith('Prevented Page')));
+});
+
+test('listReports does not include the hidden report', async () => {
+  const result = await answer();
+  assert.ok(!result.answerPage.includes('Hidden Page'));
+});
+
+test('listReports includes links to listIssues for reports with issues', async () => {
+  const result = await answer();
+  const html = parse(result.answerPage);
+  const issueLinks = html.querySelectorAll('a[href*="listIssues.html"]');
+  assert.ok(issueLinks.length > 0);
+  const hrefs = issueLinks.map(a => a.getAttribute('href'));
+  assert.ok(hrefs.some(href => href.includes('260101T0000/mix')));
+});
+
+test('listReports includes the page URLs in the report details', async () => {
+  const result = await answer();
+  assert.ok(result.answerPage.includes('https://example.com/mixed'));
+  assert.ok(result.answerPage.includes('https://example.com/canttell'));
+});
+
+test('listReports includes a link to request testing a new page', async () => {
+  const result = await answer();
+  const html = parse(result.answerPage);
+  const testLink = html.querySelector('a[href="requestTestForm.html"]');
+  assert.ok(testLink);
+});

package/web/listViolators/listViolators.test.js

@@ -0,0 +1,66 @@
+/*
+  listViolators.test.js
+  UI tests for web/listViolators/index.js using the fixture corpus.
+*/
+
+// IMPORTS
+
+const {test, before, after} = require('node:test');
+const assert = require('node:assert/strict');
+const path = require('node:path');
+const {parse} = require('node-html-parser');
+const {answer} = require('./index');
+
+// SETUP AND TEARDOWN
+
+const savedDBDir = process.env.DB_DIR;
+
+before(() => {
+  process.env.DB_DIR = path.join(__dirname, '..', '..', 'test', 'fixtures', 'db');
+});
+
+after(() => {
+  if (savedDBDir !== undefined) {
+    process.env.DB_DIR = savedDBDir;
+  }
+  else {
+    delete process.env.DB_DIR;
+  }
+});
+
+// TESTS
+
+test('listViolators returns an ok status with valid HTML for linkNoText in the mixed report', async () => {
+  const result = await answer('linkNoText/260101T0000/mix');
+  assert.equal(result.status, 'ok');
+  assert.ok(result.answerPage);
+  const html = parse(result.answerPage);
+  assert.ok(html.querySelector('title'));
+});
+
+test('listViolators includes the issue summary in the HTML', async () => {
+  const result = await answer('linkNoText/260101T0000/mix');
+  assert.ok(result.answerPage.includes('link not named'));
+});
+
+test('listViolators includes links to listDiagnoses for violators', async () => {
+  const result = await answer('linkNoText/260101T0000/mix');
+  const html = parse(result.answerPage);
+  const diagnosisLinks = html.querySelectorAll('a[href*="listDiagnoses.html"]');
+  assert.ok(diagnosisLinks.length > 0);
+});
+
+test('listViolators returns an error status for a hidden report', async () => {
+  const result = await answer('linkNoText/260101T0007/hid');
+  assert.equal(result.status, 'error');
+});
+
+test('listViolators returns an error status for a nonexistent report', async () => {
+  const result = await answer('linkNoText/999999T9999/xyz');
+  assert.equal(result.status, 'error');
+});
+
+test('listViolators returns an error status for an unknown issue', async () => {
+  const result = await answer('nonexistentIssue/260101T0000/mix');
+  assert.equal(result.status, 'error');
+});