@jrpool/kilotest 46.0.7 → 46.0.11

package/routes.test.js

@@ -0,0 +1,69 @@
+/*
+  routes.test.js
+  Tests for the centralized routes table exported from index.js.
+*/
+
+// IMPORTS
+
+const {test} = require('node:test');
+const assert = require('node:assert/strict');
+const {routes} = require('./index');
+
+// TESTS
+
+test('routes has GET and POST arrays', () => {
+  assert.ok(Array.isArray(routes.GET));
+  assert.ok(Array.isArray(routes.POST));
+  assert.ok(routes.GET.length > 0);
+  assert.ok(routes.POST.length > 0);
+});
+
+test('routes GET includes all known GET paths', () => {
+  const required = [
+    '/mcp',
+    '/',
+    '/index.html',
+    '/robots.txt',
+    '/openapi.yaml',
+    '/openapi.json',
+    '/swagger.yaml',
+    '/swagger.json',
+    '/api-docs',
+    '/llms.txt',
+    '/llms-full.txt',
+    '/sitemap.xml',
+    '/style.css'
+  ];
+  for (const path of required) {
+    assert.ok(routes.GET.includes(path), `routes.GET missing ${path}`);
+  }
+});
+
+test('routes POST includes all known POST paths', () => {
+  const required = [
+    '/mcp',
+    '/requestTest.html',
+    '/recAction.html',
+    '/reannotate.html',
+    '/renewWCAG.html',
+    '/worker/job',
+    '/worker/report',
+    '/tutorialComment.html'
+  ];
+  for (const path of required) {
+    assert.ok(routes.POST.includes(path), `routes.POST missing ${path}`);
+  }
+});
+
+test('routes GET includes wildcard patterns for dynamic paths', () => {
+  assert.ok(routes.GET.some(p => p.includes('fullReport.json')));
+  assert.ok(routes.GET.some(p => p.includes('/api/')));
+  assert.ok(routes.GET.some(p => p.includes('tutorial/images')));
+  assert.ok(routes.GET.some(p => p.includes('favicon')));
+  assert.ok(routes.GET.some(p => p.includes('.html')));
+});
+
+test('routes POST includes wildcard patterns for dynamic paths', () => {
+  assert.ok(routes.POST.some(p => p.includes('requestRetest.html')));
+  assert.ok(routes.POST.some(p => p.includes('/api/')));
+});

package/routing.test.js

@@ -23,7 +23,7 @@ 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));
+  await new Promise(resolve => server.listen(port, () => resolve()));
 });
 
 after(async () => {
@@ -33,7 +33,17 @@ after(async () => {
   else {
     delete process.env.DB_DIR;
   }
-  await new Promise(resolve => server.close(() => resolve()));
+  server.closeAllConnections?.();
+  await new Promise(resolve => {
+    const timer = setTimeout(() => {
+      server.closeAllConnections?.();
+      resolve();
+    }, 1000);
+    server.close(() => {
+      clearTimeout(timer);
+      resolve();
+    });
+  });
 });
 
 // HELPERS
@@ -73,5 +83,5 @@ test('GET /api/listReports returns a valid JSON response', async () => {
   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);
+  assert.equal(reports.length, 8);
 });

package/smokeTest.js

@@ -0,0 +1,123 @@
+/*
+  smokeTest.js
+  Sends requests to all valid GET and POST paths on the deployed server and verifies that Caddy forwards them to Kilotest (i.e., the response is not a bare Caddy 404).
+*/
+
+// IMPORTS
+
+const https = require('https');
+const {routes} = require('./index');
+
+// CONSTANTS
+
+const host = process.env.SMOKE_HOST || 'kilotest.com';
+// Concrete paths matching each wildcard pattern in the routes table, for smoke testing.
+const concretePaths = {
+  GET: {
+    '/mcp': '/mcp',
+    '/': '/',
+    '/index.html': '/index.html',
+    '/robots.txt': '/robots.txt',
+    '/openapi.yaml': '/openapi.yaml',
+    '/openapi.json': '/openapi.json',
+    '/swagger.yaml': '/swagger.yaml',
+    '/swagger.json': '/swagger.json',
+    '/api-docs': '/api-docs',
+    '/llms.txt': '/llms.txt',
+    '/llms-full.txt': '/llms-full.txt',
+    '/sitemap.xml': '/sitemap.xml',
+    '/style.css': '/style.css',
+    '/fullReport.json/*': '/fullReport.json/260101T0000/mix',
+    '/api/*': '/api/listReports',
+    '/tutorial/images/*': '/tutorial/images/diagram.png',
+    '/favicon.*': '/favicon.ico',
+    '*.html*': '/listReports.html'
+  },
+  POST: {
+    '/mcp': '/mcp',
+    '/requestTest.html': '/requestTest.html',
+    '/requestRetest.html/*': '/requestRetest.html/260101T0001/ct',
+    '/recAction.html': '/recAction.html',
+    '/reannotate.html': '/reannotate.html',
+    '/renewWCAG.html': '/renewWCAG.html',
+    '/worker/job': '/worker/job',
+    '/worker/report': '/worker/report',
+    '/api/*': '/api/requestFeature',
+    '/tutorialComment.html': '/tutorialComment.html'
+  }
+};
+// Minimal POST bodies for paths that require them.
+const postBodies = {
+  '/api/requestFeature': {feature: 'smoke test'},
+  '/requestTest.html': {what: 'Smoke Test Page', url: 'https://smoketest.example.com', why: 'smoke test'},
+  '/requestRetest.html/260101T0001/ct': {why: 'smoke test'},
+  '/recAction.html': {target: 'https://smoketest.example.com\tSmoke Test Page', authCode: 'invalid'},
+  '/reannotate.html': {authCode: 'invalid'},
+  '/renewWCAG.html': {authCode: 'invalid'},
+  '/worker/job': {},
+  '/worker/report': {},
+  '/tutorialComment.html': {content: 'smoke test'},
+  '/mcp': {}
+};
+
+// FUNCTIONS
+
+// Sends an HTTPS request and returns the status code and body length.
+const sendRequest = (method, requestPath) => new Promise((resolve, reject) => {
+  const body = method === 'POST' ? JSON.stringify(postBodies[requestPath] || {}) : null;
+  const options = {
+    method,
+    host,
+    path: requestPath,
+    headers: body ? {
+      'content-type': 'application/json; charset=utf-8',
+      'content-length': Buffer.byteLength(body)
+    } : {}
+  };
+  const req = https.request(options, response => {
+    const chunks = [];
+    response.on('data', chunk => chunks.push(chunk));
+    response.on('end', () => {
+      const responseBody = chunks.join('');
+      resolve({statusCode: response.statusCode, bodyLength: responseBody.length});
+    });
+  });
+  req.on('error', reject);
+  req.end(body || '');
+});
+
+// Returns whether a response is a bare Caddy 404 (the failure this test detects).
+const isCaddy404 = result => result.statusCode === 404 && result.bodyLength === 0;
+
+// EXECUTION
+
+(async () => {
+  let failures = 0;
+  for (const method of ['GET', 'POST']) {
+    console.log(`\n=== ${method} paths ===`);
+    for (const pattern of routes[method]) {
+      const requestPath = concretePaths[method][pattern];
+      if (!requestPath) {
+        console.log(`FAIL: no concrete path defined for pattern ${pattern}`);
+        failures++;
+        continue;
+      }
+      try {
+        const result = await sendRequest(method, requestPath);
+        if (isCaddy404(result)) {
+          console.log(`FAIL: ${method} ${requestPath} -> Caddy 404 (path not forwarded)`);
+          failures++;
+        }
+        else {
+          console.log(`PASS: ${method} ${requestPath} -> ${result.statusCode} (body ${result.bodyLength} bytes)`);
+        }
+      }
+      catch (error) {
+        console.log(`FAIL: ${method} ${requestPath} -> error: ${error.message}`);
+        failures++;
+      }
+    }
+  }
+  console.log(`\n=== ${failures === 0 ? 'All paths forwarded' : `${failures} failure(s)`} ===`);
+  process.exit(failures === 0 ? 0 : 1);
+})();

package/test/fixtures/buildFixtures.js

@@ -233,6 +233,89 @@ const main = async () => {
     hiddenReport
   );
 
+  // Fixture 8: multiViolator. Three violators for the same issue: two with 1 reporter each (exercising the catalogIndex tiebreaker) and one with 2 reporters (exercising the reporter-count descending sort).
+  const multiViolatorCatalog = {
+    '0': catalogItem('A', 'Home', '/html/body/a[1]', '10:10:40:20'),
+    '1': catalogItem('A', 'Contact', '/html/body/a[2]', '10:40:40:20'),
+    '2': catalogItem('A', 'Help', '/html/body/a[3]', '10:70:40:20')
+  };
+  const multiViolatorActs = [
+    testAct(engineAxe, [
+      instance('r11', 'The link does not have an accessible name', 'failed',
+        issueLinkNoText, 0, 2, 1),
+      instance('r11', 'The link does not have an accessible name', 'failed',
+        issueLinkNoText, 2, 2, 1)
+    ]),
+    testAct(engineAlfa, [
+      instance('r11', 'The link does not have an accessible name', 'failed',
+        issueLinkNoText, 1, 2, 1),
+      instance('r11', 'The link does not have an accessible name', 'failed',
+        issueLinkNoText, 2, 2, 1)
+    ])
+  ];
+  await writeJSON(
+    path.join(reportsDir, '260101T0008-mul.json'),
+    report('260101T0008-mul', 'Multi Violator Page',
+      'https://example.com/multiviolator', multiViolatorActs, multiViolatorCatalog)
+  );
+
+  // Fixture 9: branchCoverage. Covers remaining branch gaps in listDiagnoses and listIssues: an issue with a short WCAG code (guideline layer), a catalog item with no tagName or text, an instance where ruleID equals what and count is missing, a test act with null instances, and an instance with no issueID.
+  const issueDuplicateID = 'duplicateID';
+  const branchCatalog = {
+    '0': catalogItem('DIV', '', '/html/body/div[1]', '0:0:100:50'),
+    '1': {id: '', startTag: '<div>', text: null, textLinkable: false, boxID: '5:5:90:40', pathID: '/html/body/div[2]', headingIndex: '', checkpoint: 0},
+    '2': {id: '', text: 'No tags', textLinkable: false, headingIndex: '', checkpoint: 0}
+  };
+  const branchActs = [
+    testAct(engineAxe, [
+      instance('r99', 'r99', 'failed',
+        issueDuplicateID, 0, 2, 1),
+      {
+        ruleID: 'r100',
+        what: 'Element has no role',
+        ordinalSeverity: 1,
+        outcome: 'failed',
+        catalogIndex: '1',
+        checkpoint: 0,
+        issueID: issueDuplicateID
+      },
+      instance('r101', 'Duplicate ID found', 'failed',
+        issueDuplicateID, 2, 2, 1),
+      instance('r102', 'Duplicate ID in orphan', 'failed',
+        issueDuplicateID, 3, 2, 1)
+    ]),
+    {
+      type: 'test',
+      which: engineAlfa,
+      startTime: '26-01-01T00:00',
+      endTime: '26-01-01T00:01',
+      result: {
+        standardResult: {}
+      }
+    },
+    testAct(engineIbm, [
+      {
+        ruleID: 'r50',
+        what: 'Link has no text',
+        ordinalSeverity: 2,
+        outcome: 'failed',
+        catalogIndex: '0',
+        checkpoint: 0
+      }
+    ])
+  ];
+  await writeJSON(
+    path.join(reportsDir, '260101T0009-brd.json'),
+    report('260101T0009-brd', 'Branch Coverage Page',
+      'https://example.com/branch', branchActs, branchCatalog)
+  );
+  // Remove preventions from the brd fixture to cover the preventions ?? {} branch in listIssues.
+  const brdReport = JSON.parse(
+    await fs.readFile(path.join(reportsDir, '260101T0009-brd.json'), 'utf8')
+  );
+  delete brdReport.jobData.preventions;
+  await writeJSON(path.join(reportsDir, '260101T0009-brd.json'), brdReport);
+
   // Write an empty recs.json so getRecs does not try to create one.
   await writeJSON(path.join(targetDir, 'jobs', 'recs.json'), {});
 

package/test/fixtures/db/reports/260101T0008-mul.json

@@ -0,0 +1,137 @@
+{
+  "id": "260101T0008-mul",
+  "what": "Multi Violator Page",
+  "strict": false,
+  "standard": "only",
+  "device": {
+    "id": "default"
+  },
+  "browserID": "chromium",
+  "creationTimeStamp": "260101T0008",
+  "executionTimeStamp": "260101T0008",
+  "target": {
+    "what": "Multi Violator Page",
+    "url": "https://example.com/multiviolator"
+  },
+  "sources": {
+    "worker": "test-worker"
+  },
+  "acts": [
+    {
+      "type": "test",
+      "which": "axe",
+      "startTime": "26-01-01T00:00",
+      "endTime": "26-01-01T00:01",
+      "result": {
+        "standardResult": {
+          "instances": [
+            {
+              "ruleID": "r11",
+              "what": "The link does not have an accessible name",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "0",
+              "checkpoint": 0,
+              "issueID": "linkNoText"
+            },
+            {
+              "ruleID": "r11",
+              "what": "The link does not have an accessible name",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "2",
+              "checkpoint": 0,
+              "issueID": "linkNoText"
+            }
+          ],
+          "outcomeTotals": {
+            "failed": 2,
+            "cantTell": 0
+          }
+        }
+      }
+    },
+    {
+      "type": "test",
+      "which": "alfa",
+      "startTime": "26-01-01T00:00",
+      "endTime": "26-01-01T00:01",
+      "result": {
+        "standardResult": {
+          "instances": [
+            {
+              "ruleID": "r11",
+              "what": "The link does not have an accessible name",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "1",
+              "checkpoint": 0,
+              "issueID": "linkNoText"
+            },
+            {
+              "ruleID": "r11",
+              "what": "The link does not have an accessible name",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "2",
+              "checkpoint": 0,
+              "issueID": "linkNoText"
+            }
+          ],
+          "outcomeTotals": {
+            "failed": 2,
+            "cantTell": 0
+          }
+        }
+      }
+    }
+  ],
+  "jobData": {
+    "startTime": "26-01-01T00:00",
+    "endTime": "26-01-01T00:10",
+    "elapsedSeconds": 600,
+    "preventions": {},
+    "issuelessRules": []
+  },
+  "catalog": {
+    "0": {
+      "tagName": "A",
+      "id": "",
+      "startTag": "<a>",
+      "text": "Home",
+      "textLinkable": false,
+      "boxID": "10:10:40:20",
+      "pathID": "/html/body/a[1]",
+      "headingIndex": "",
+      "checkpoint": 0
+    },
+    "1": {
+      "tagName": "A",
+      "id": "",
+      "startTag": "<a>",
+      "text": "Contact",
+      "textLinkable": false,
+      "boxID": "10:40:40:20",
+      "pathID": "/html/body/a[2]",
+      "headingIndex": "",
+      "checkpoint": 0
+    },
+    "2": {
+      "tagName": "A",
+      "id": "",
+      "startTag": "<a>",
+      "text": "Help",
+      "textLinkable": false,
+      "boxID": "10:70:40:20",
+      "pathID": "/html/body/a[3]",
+      "headingIndex": "",
+      "checkpoint": 0
+    }
+  },
+  "images": {},
+  "checkpoints": []
+}

package/test/fixtures/db/reports/260101T0009-brd.json

@@ -0,0 +1,147 @@
+{
+  "id": "260101T0009-brd",
+  "what": "Branch Coverage Page",
+  "strict": false,
+  "standard": "only",
+  "device": {
+    "id": "default"
+  },
+  "browserID": "chromium",
+  "creationTimeStamp": "260101T0009",
+  "executionTimeStamp": "260101T0009",
+  "target": {
+    "what": "Branch Coverage Page",
+    "url": "https://example.com/branch"
+  },
+  "sources": {
+    "worker": "test-worker"
+  },
+  "acts": [
+    {
+      "type": "test",
+      "which": "axe",
+      "startTime": "26-01-01T00:00",
+      "endTime": "26-01-01T00:01",
+      "result": {
+        "standardResult": {
+          "instances": [
+            {
+              "ruleID": "r99",
+              "what": "r99",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "0",
+              "checkpoint": 0,
+              "issueID": "duplicateID"
+            },
+            {
+              "ruleID": "r100",
+              "what": "Element has no role",
+              "ordinalSeverity": 1,
+              "outcome": "failed",
+              "catalogIndex": "1",
+              "checkpoint": 0,
+              "issueID": "duplicateID"
+            },
+            {
+              "ruleID": "r101",
+              "what": "Duplicate ID found",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "2",
+              "checkpoint": 0,
+              "issueID": "duplicateID"
+            },
+            {
+              "ruleID": "r102",
+              "what": "Duplicate ID in orphan",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "count": 1,
+              "catalogIndex": "3",
+              "checkpoint": 0,
+              "issueID": "duplicateID"
+            }
+          ],
+          "outcomeTotals": {
+            "failed": 4,
+            "cantTell": 0
+          }
+        }
+      }
+    },
+    {
+      "type": "test",
+      "which": "alfa",
+      "startTime": "26-01-01T00:00",
+      "endTime": "26-01-01T00:01",
+      "result": {
+        "standardResult": {}
+      }
+    },
+    {
+      "type": "test",
+      "which": "ibm",
+      "startTime": "26-01-01T00:00",
+      "endTime": "26-01-01T00:01",
+      "result": {
+        "standardResult": {
+          "instances": [
+            {
+              "ruleID": "r50",
+              "what": "Link has no text",
+              "ordinalSeverity": 2,
+              "outcome": "failed",
+              "catalogIndex": "0",
+              "checkpoint": 0
+            }
+          ],
+          "outcomeTotals": {
+            "failed": 1,
+            "cantTell": 0
+          }
+        }
+      }
+    }
+  ],
+  "jobData": {
+    "startTime": "26-01-01T00:00",
+    "endTime": "26-01-01T00:10",
+    "elapsedSeconds": 600,
+    "issuelessRules": []
+  },
+  "catalog": {
+    "0": {
+      "tagName": "DIV",
+      "id": "",
+      "startTag": "<div>",
+      "text": "",
+      "textLinkable": false,
+      "boxID": "0:0:100:50",
+      "pathID": "/html/body/div[1]",
+      "headingIndex": "",
+      "checkpoint": 0
+    },
+    "1": {
+      "id": "",
+      "startTag": "<div>",
+      "text": null,
+      "textLinkable": false,
+      "boxID": "5:5:90:40",
+      "pathID": "/html/body/div[2]",
+      "headingIndex": "",
+      "checkpoint": 0
+    },
+    "2": {
+      "id": "",
+      "text": "No tags",
+      "textLinkable": false,
+      "headingIndex": "",
+      "checkpoint": 0
+    }
+  },
+  "images": {},
+  "checkpoints": []
+}

package/test/setup.cjs

@@ -0,0 +1,14 @@
+/*
+  test/setup.cjs
+  Clears alert configuration env vars before any modules are required,
+  so that tests calling sendAlert indirectly never trigger real email alerts.
+  This file is loaded via --require before any test file runs.
+
+  The env vars are set to empty strings rather than deleted, because
+  dotenv does not override existing env vars. This prevents the .env
+  file loaded by index.js from re-arming the alert configuration.
+*/
+
+for (const key of ['MANAGER_EMAIL', 'ALERT_API_HOST', 'ALERT_API_PATH', 'ALERT_API_KEY', 'ALERT_FROM']) {
+  process.env[key] = '';
+}

package/util.js

@@ -142,11 +142,18 @@ const getJobNames = exports.getJobNames = async () => {
   const jobNames = {};
   let fileNames;
   for (const category of ['queue', 'claimed', 'failed']) {
+    const categoryPath = path.join(jobsPath(), category);
     try {
-      fileNames = await fs.readdir(path.join(jobsPath(), category));
+      fileNames = await fs.readdir(categoryPath);
     }
     catch(error) {
-      return `ERROR: Job directory ${category} not readable (${error.message})`;
+      if (error.code === 'ENOENT') {
+        await fs.mkdir(categoryPath, {recursive: true});
+        fileNames = [];
+      }
+      else {
+        return `ERROR: Job directory ${category} not readable (${error.message})`;
+      }
     }
     jobNames[category] = fileNames;
   }
@@ -220,6 +227,9 @@ exports.getPOSTData = request => new Promise(resolve => {
       const query = querystring.parse(body);
       resolve(query);
     }
+    else {
+      resolve(null);
+    }
   });
 });
 // Returns the waiting test and retest recommendations.
@@ -604,9 +614,9 @@ const getPageData = exports.getPageData = async (timeStamp, jobID) => {
     return report;
   }
   const {url, what} = report.target;
-  const reportStats = await getReportStats(timeStamp, jobID)
-  // Otherwise, i.e. if it succeeded, get the elapsed time in days since the report was created.
-  const daysAgo = getAgoDays(reportStats.reportTime);
+  // Get the elapsed time in days since the report was completed, using the
+  // report content rather than the file system birth time.
+  const daysAgo = getAgoDays(new Date(`20${report.jobData.endTime}Z`));
   // Return the data.
   return {
     what,
@@ -640,7 +650,7 @@ exports.getPageDataStrings = async (timeStamp, jobID, pageData) => {
   };
 };
 // Returns the creation time and size of a report.
-const getReportStats = exports.getReportStats = async (timeStamp, jobID) => {
+exports.getReportStats = async (timeStamp, jobID) => {
   let reportStat;
   try {
     reportStat = await fs.stat(path.join(reportsPath(), `${timeStamp}-${jobID}.json`));