testaro 35.0.4 → 35.0.6

package/README.md

@@ -718,12 +718,6 @@ The validity criterion named in item 2 may be any of these:
 
 Testaro can be called by modules and by users.
 
-### Functions
-
-Testaro contains these modules that export executable functions:
-- `run.js` exports `doJob` for immediate execution.
-- `watch.js` exports `cycle` for watch-triggered execution.
-
 #### Imports
 
 Before a module can execute a Testaro function, it must import that function from the module that exports it. A Testaro module can import function `f` from module `m` with the statement

package/dirWatch.js

@@ -59,12 +59,13 @@ const writeDirReport = async report => {
     try {
       const reportJSON = JSON.stringify(report, null, 2);
       const reportName = `${jobID}.json`;
-      await fs.mkdir(`${reportDir}/raw`, {recursive: true});
-      await fs.writeFile(`${reportDir}/raw/${reportName}`, `${reportJSON}\n`);
-      console.log(`Report ${jobID} saved in ${reportDir}/raw`);
+      const rawDir = `${reportDir}/raw`;
+      await fs.mkdir(rawDir, {recursive: true});
+      await fs.writeFile(`${rawDir}/${reportName}`, `${reportJSON}\n`);
+      console.log(`Report ${jobID} saved in ${rawDir}`);
     }
     catch(error) {
-      console.log(`ERROR: Failed to save report ${jobID} in ${reportDir}/raw (${error.message})`);
+      console.log(`ERROR: Failed to save report ${jobID} in ${rawDir} (${error.message})`);
     }
   }
   else {
@@ -76,14 +77,15 @@ const archiveJob = async (job, isFile) => {
   // Save the job in the done subdirectory.
   const {id} = job;
   const jobJSON = JSON.stringify(job, null, 2);
-  await fs.mkdir(`${jobDir}/done`, {recursive: true});
-  await fs.writeFile(`${jobDir}/done/${id}.json`, `${jobJSON}\n`);
+  const doneDir = `${jobDir}/done`;
+  await fs.mkdir(doneDir, {recursive: true});
+  await fs.writeFile(`${doneDir}/${id}.json`, `${jobJSON}\n`);
   // If the job had been saved as a file in the todo subdirectory:
   if (isFile) {
     // Delete the file.
     await fs.rm(`${jobDir}/todo/${id}.json`);
   }
-  console.log(`Job ${id} archived in ${jobDir}/done (${nowString()})`);
+  console.log(`Job ${id} archived in ${doneDir} (${nowString()})`);
 };
 // Waits.
 const wait = ms => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "35.0.4",
+  "version": "35.0.6",
   "description": "Run 1000 web accessibility tests from 10 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/testaro/focVis.js

@@ -1,5 +1,5 @@
 /*
-  © 2022–2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2022–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
@@ -40,25 +40,30 @@ exports.reporter = async (page, withItems) => {
   // For each locator:
   for (const loc of all.allLocs) {
     // Get how its element violates the rule, if it does.
-    const isBad = await loc.evaluate(el => {
-      const isAbove = el.offsetTop + el.offsetHeight <= 0;
-      const isLeft = el.offsetLeft + el.offsetWidth <= 0;
-      return [isAbove, isLeft];
-    });
-    // If it does:
-    if (isBad[0] || isBad[1]) {
-      // Add the locator to the array of violators.
-      let param;
-      if (isBad[0] && isBad[1]) {
-        param = 'above and to the left of';
+    try {
+      const isBad = await loc.evaluate(el => {
+        const isAbove = el.offsetTop + el.offsetHeight <= 0;
+        const isLeft = el.offsetLeft + el.offsetWidth <= 0;
+        return [isAbove, isLeft];
+      }, {timeout: 500});
+      // If it does:
+      if (isBad[0] || isBad[1]) {
+        // Add the locator to the array of violators.
+        let param;
+        if (isBad[0] && isBad[1]) {
+          param = 'above and to the left of';
+        }
+        else if (isBad[0]) {
+          param = 'above';
+        }
+        else {
+          param = 'to the left of';
+        }
+        all.locs.push([loc, param]);
       }
-      else if (isBad[0]) {
-        param = 'above';
-      }
-      else {
-        param = 'to the left of';
-      }
-      all.locs.push([loc, param]);
+    }
+    catch(error) {
+      console.log(`ERROR analyzing locator for focVis (${error.message})`);
     }
   }
   // Populate and return the result.

package/tests/aslint.js

@@ -1,5 +1,5 @@
 /*
-  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2023–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

package/tests/ed11y.js

@@ -1,5 +1,5 @@
 /*
-  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2023–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

package/tests/wave.js

@@ -1,5 +1,5 @@
 /*
-  © 2021–2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2021–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

package/watch-old.js

@@ -1,77 +0,0 @@
-/*
-  © 2023 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.
-*/
-
-/*
-  dirWatch.js
-  Module for launching a one-time directory watch.
-  Argument:
-    1: interval in seconds from a no-job check to the next check.
-*/
-
-// ########## IMPORTS
-
-// Module to spawn a child process.
-const {spawn} = require('node:child_process');
-
-// ########## CONSTANTS
-
-const repeat = process.argv[2];
-const interval = process.argv[3];
-
-// ########## FUNCTIONS
-
-// Spawns a one-time directory watch.
-const spawnWatch = () => spawn(
-  'node', 'dirWatch', 'false', interval, {stdio: ['inherit', 'inherit', 'pipe']}
-);
-// Repeatedly spawns a one-time directory watch.
-const reWatch = () => {
-  const watcher = spawnWatch('node', ['call', 'dirWatch', 'false', interval]);
-  let error = '';
-  watcher.stderr.on('data', data => {
-    error += data.toString();
-  });
-  watcher.on('close', async code => {
-    if (error) {
-      if (error.startsWith('Navigation timeout of 30000 ms exceeded')) {
-        console.log('ERROR: Playwright claims 30-second timeout exceeded');
-      }
-      else {
-        console.log(`ERROR watching: ${error.slice(0, 200)}`);
-      }
-    }
-    if (! error && code === 0) {
-      console.log('Watcher exited successfully\n');
-      reWatch();
-    }
-    else if (code) {
-      console.log(`Watcher exited with error code ${code}`);
-    }
-    else {
-      console.log('Watch aborted');
-    }
-  });
-};
-
-// ########## OPERATION
-
-reWatch();

package/watch.js

@@ -1,396 +0,0 @@
-/*
-  © 2022–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.
-*/
-
-/*
-  watch.js
-  Module for watching for a job and running it when found.
-*/
-
-// ########## IMPORTS
-
-// Module to keep secrets.
-require('dotenv').config();
-// Module to read and write files.
-const fs = require('fs/promises');
-// Module to make requests to servers.
-const httpClient = require('http');
-const httpsClient = require('https');
-// Module to perform jobs.
-const {doJob} = require('./run');
-
-// CONSTANTS
-
-const jobDir = process.env.JOBDIR;
-const jobURLs = process.env.JOB_URLS;
-const reportDir = process.env.REPORTDIR;
-const agent = process.env.AGENT;
-
-// ########## FUNCTIONS
-
-// Returns a string representing the date and time.
-const nowString = () => (new Date()).toISOString().slice(2, 16);
-// Waits.
-const wait = ms => {
-  return new Promise(resolve => {
-    setTimeout(() => {
-      resolve('');
-    }, ms);
-  });
-};
-// Serves an object in JSON format.
-const serveObject = (object, response) => {
-  response.setHeader('Content-Type', 'application/json; charset=utf-8');
-  response.end(JSON.stringify(object));
-};
-// Writes a directory report.
-const writeDirReport = async report => {
-  const jobID = report && report.id;
-  if (jobID) {
-    try {
-      const reportJSON = JSON.stringify(report, null, 2);
-      const reportName = `${jobID}.json`;
-      await fs.mkdir(reportDir, {recursive: true});
-      await fs.writeFile(`${reportDir}/${reportName}`, reportJSON);
-      console.log(`Report ${reportName} saved in ${reportDir}`);
-    }
-    catch(error) {
-      console.log(`ERROR: Failed to write report ${jobID} in ${reportDir} (${error.message})`);
-    }
-  }
-  else {
-    console.log('ERROR: Job has no ID');
-  }
-};
-// Archives a job.
-const archiveJob = async (job, isFile) => {
-  // Save the job in the done subdirectory.
-  const {id} = job;
-  const jobJSON = JSON.stringify(job, null, 2);
-  await fs.mkdir(`${jobDir}/done`, {recursive: true});
-  await fs.writeFile(`${jobDir}/done/${id}.json`, jobJSON);
-  // If the job had been saved as a file in the todo subdirectory:
-  if (isFile) {
-    // Delete the file.
-    await fs.rm(`${jobDir}/todo/${id}.json`);
-  }
-};
-// Checks for a directory job and, if found, performs and reports it, once or repeatedly.
-const checkDirJob = async (isForever, interval) => {
-  try {
-    // If there are any jobs in the watched directory:
-    const toDoFileNames = await fs.readdir(`${jobDir}/todo`);
-    const jobFileNames = toDoFileNames.filter(fileName => fileName.endsWith('.json'));
-    if (jobFileNames.length) {
-      // If the first one is ready to do:
-      const firstJobTime = jobFileNames[0].replace(/-.+$/, '');
-      if (Date.now() > dateOf(firstJobTime)) {
-        // Perform it.
-        const jobJSON = await fs.readFile(`${jobDir}/todo/${jobFileNames[0]}`, 'utf8');
-        try {
-          const job = JSON.parse(jobJSON, null, 2);
-          const {id} = job;
-          console.log(`Directory job ${id} found (${nowString()})`);
-          await doJob(job);
-          console.log(`Job ${id} finished (${nowString()})`);
-          // Report it.
-          await writeDirReport(job);
-          // Archive it.
-          await archiveJob(job, true);
-          console.log(`Job ${id} archived in ${jobDir} (${nowString()})`);
-          // If watching is repetitive:
-          if (isForever) {
-            // Wait 2 seconds.
-            await wait(2000);
-            // Check the directory again.
-            checkDirJob(true, interval);
-          }
-        }
-        catch(error) {
-          console.log(`ERROR processing directory job (${error.message})`);
-        }
-      }
-      // Otherwise, i.e. if the first one is not yet ready to do:
-      else {
-        // Report this.
-        console.log(`All jobs in ${jobDir} not yet ready to do (${nowString()})`);
-        // Wait for the specified interval.
-        await wait(1000 * interval);
-        // Check the directory again.
-        await checkDirJob(true, interval);
-      }
-    }
-    // Otherwise, i.e. if there are no more jobs in the watched directory:
-    else {
-      console.log(`No job in ${jobDir} (${nowString()})`);
-      // Wait for the specified interval.
-      await wait(1000 * interval);
-      // Check the directory again.
-      await checkDirJob(true, interval);
-    }
-  }
-  catch(error) {
-    console.log(`ERROR: Directory watching failed (${error.message})`);
-  }
-};
-// Checks servers for a network job.
-const checkNetJob = async (servers, serverIndex, isForever, interval, noJobCount) => {
-  // If all servers are jobless:
-  if (noJobCount === servers.length) {
-    // Wait for the specified interval.
-    await wait(1000 * interval);
-    // Reset the count of jobless servers.
-    noJobCount = 0;
-  }
-  // Otherwise, i.e. if any server may still have a job:
-  else {
-    // Wait 2 seconds.
-    await wait(2000);
-  }
-  // If the last server has been checked:
-  serverIndex = serverIndex % servers.length;
-  if (serverIndex === 0) {
-    // Report this.
-    console.log('--');
-  }
-  // Check the next server.
-  const server = servers[serverIndex];
-  const client = server.startsWith('https://') ? httpsClient : httpClient;
-  const fullURL = `${server}?agent=${agent}`;
-  const logStart = `Requested job from server ${server} and got `;
-  // Tolerate unrecognized certificate authorities if the environment specifies.
-  const ruOpt = process.env.REJECT_UNAUTHORIZED === 'false' ? {rejectUnauthorized: false} : {};
-  client.request(fullURL, ruOpt, response => {
-    const chunks = [];
-    response
-    // If the response to the job request threw an error:
-    .on('error', async error => {
-      // Report it.
-      console.log(`${logStart}error message ${error.message}`);
-      // Check the next server.
-      await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-    })
-    .on('data', chunk => {
-      chunks.push(chunk);
-    })
-    // When the response arrives:
-    .on('end', async () => {
-      const content = chunks.join('');
-      try {
-        // If there was no job to do:
-        let contentObj = JSON.parse(content);
-        if (! Object.keys(contentObj).length) {
-          // Report this.
-          console.log(`No job to do at ${server}`);
-          // Check the next server.
-          await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-        }
-        // Otherwise, i.e. if there was a job or a message:
-        else {
-          const {id, message, sendReportTo, sources} = contentObj;
-          // If the server sent a message, not a job:
-          if (message) {
-            // Report it.
-            console.log(`${logStart}${message}`);
-            // Check the next server.
-            await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-          }
-          // Otherwise, if the server sent a valid job:
-          else if (id && sources && sources.target && sources.target.which) {
-            // Add the agent to it.
-            sources.agent = agent;
-            // If the job specifies a report destination:
-            if (sendReportTo) {
-              // Perform the job, adding result data to it.
-              const testee = sources.target.which;
-              console.log(
-                `${logStart}job ${id} (${nowString()})\n>> It will test ${testee}\n>> It will send report to ${sendReportTo}\n`
-              );
-              await doJob(contentObj);
-              let reportJSON = JSON.stringify(contentObj, null, 2);
-              console.log(`Job ${id} finished (${nowString()})`);
-              // Send the report to the specified server.
-              console.log(`Sending report ${id} to ${sendReportTo}`);
-              const reportClient = sendReportTo.startsWith('https://') ? httpsClient : httpClient;
-              const reportLogStart = `Sent report ${id} to ${sendReportTo} and got `;
-              reportClient.request(sendReportTo, {method: 'POST'}, repResponse => {
-                const chunks = [];
-                repResponse
-                // If the response to the report threw an error:
-                .on('error', async error => {
-                  // Report this.
-                  console.log(`${reportLogStart}error message ${error.message}\n`);
-                  // Check the next server.
-                  await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-                })
-                .on('data', chunk => {
-                  chunks.push(chunk);
-                })
-                // When the response arrives:
-                .on('end', async () => {
-                  const content = chunks.join('');
-                  try {
-                    // If the server sent a message, as expected:
-                    const ackObj = JSON.parse(content);
-                    const {message} = ackObj;
-                    if (message) {
-                      // Report it.
-                      console.log(`${reportLogStart}${message}\n`);
-                      // Free the memory used by the report.
-                      reportJSON = '';
-                      contentObj = {};
-                      // Check the next server.
-                      await checkNetJob(servers, serverIndex + 1, isForever, interval, 0);
-                    }
-                    // Otherwise, i.e. if the server sent anything else:
-                    else {
-                      // Report it.
-                      console.log(
-                        `ERROR: ${reportLogStart}status ${repResponse.statusCode} and error message ${JSON.stringify(ackObj, null, 2)}\n`
-                      );
-                      // Check the next server, disregarding the failed job.
-                      await checkNetJob(
-                        servers, serverIndex + 1, isForever, interval, noJobCount + 1
-                      );
-                    }
-                  }
-                  // If processing the report threw an error:
-                  catch(error) {
-                    // Report it.
-                    console.log(
-                      `ERROR: ${reportLogStart}status ${repResponse.statusCode}, error message ${error.message}, and response ${content.slice(0, 1000)}\n`
-                    );
-                    // Check the next server, disregarding the failed job.
-                    await checkNetJob(
-                      servers, serverIndex + 1, isForever, interval, noJobCount + 1
-                    );
-                  }
-                });
-              })
-              // If the report submission throws an error:
-              .on('error', async error => {
-                // Report this.
-                console.log(`ERROR: ${reportLogStart}error message ${error.message}\n`);
-                // Check the next server, disregarding the failed job.
-                await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-              })
-              // Finish submitting the report.
-              .end(reportJSON);
-            }
-            // Otherwise, i.e. if the job specifies no report destination:
-            else {
-              // Report this.
-              const message = `ERROR: ${logStart}job with no report destination`;
-              serveObject({message}, response);
-              console.log(message);
-              // Check the next server, disregarding the defective job.
-              await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-            }
-          }
-          // Otherwise, if the server sent an invalid job:
-          else {
-            // Report this.
-            const message
-            = `ERROR: ${logStart}invalid job:\n${JSON.stringify(contentObj, null, 2)}`;
-            console.log(message);
-            serveObject({message}, response);
-            // Check the next server, disregarding the defective job.
-            await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-          }
-        }
-      }
-      // If an error is thrown:
-      catch(error) {
-        // Report this.
-        console.log(`ERROR: ${error.message} (response ${content.slice(0, 1000)})`);
-        // Check the next server.
-        await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-      }
-    });
-  })
-  // If the job request throws an error:
-  .on('error', async error => {
-    // If it was a refusal to connect:
-    const {message} = error;
-    if (message.includes('ECONNREFUSED')) {
-      // Report this.
-      console.log(`${logStart}no connection`);
-      // Check the next server.
-      await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-    }
-    // Otherwise, if it was a DNS failure:
-    else if (message.includes('ENOTFOUND')) {
-      // Report this.
-      console.log(`${logStart}no domain name resolution`);
-      // Check the next server.
-      await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-    }
-    // Otherwise, i.e. if it was any other error:
-    else {
-      // Report this.
-      console.log(
-        `ERROR: ${logStart}no response, but got error message ${error.message.slice(0, 200)}`
-      );
-      // Check the next server.
-      await checkNetJob(servers, serverIndex + 1, isForever, interval, noJobCount + 1);
-    }
-  })
-  // Finish sending the request.
-  .end();
-};
-// Composes an interval description.
-const intervalSpec = interval => {
-  if (interval > -1) {
-    return `repeatedly, with ${interval}-second intervals `;
-  }
-  else {
-    return '';
-  }
-};
-// Checks for a directory job, performs it, and submits a report, once or repeatedly.
-exports.dirWatch = async (isForever, interval = 300) => {
-  console.log(`Directory watching started ${intervalSpec(interval)}(${nowString()})\n`);
-  // Start the checking.
-  await checkDirJob(isForever, interval);
-};
-// Checks for a network job, performs it, and submits a report, once or repeatedly.
-exports.netWatch = async (isForever, interval = 300) => {
-  console.log('Starting netWatch');
-  // If the servers to be checked are valid:
-  const servers = jobURLs
-  .split('+')
-  .map(url => [Math.random(), url])
-  .sort((a, b) => a[0] - b[0])
-  .map(pair => pair[1]);
-  if (
-    servers
-    && servers.length
-    && servers
-    .every(server => ['http://', 'https://'].some(prefix => server.startsWith(prefix)))
-  ) {
-    console.log(`Network watching started ${intervalSpec(interval)}(${nowString()})\n`);
-    // Start checking.
-    await checkNetJob(servers, 0, isForever, interval, 0);
-  }
-  else {
-    console.log('ERROR: List of job URLs invalid');
-  }
-};