testaro 5.19.0 → 6.0.1

package/run.js

@@ -1549,7 +1549,7 @@ const injectLaunches = acts => {
   }
 };
 // Handles a request.
-exports.handleRequest = async report => {
+exports.doJob = async report => {
   // If the report object is valid:
   if(isValidReport(report)) {
     // Add a start time to the log.

package/{runHost.js → runScript.js}

@@ -1,25 +1,24 @@
 /*
-  runHost.js
-  Runs a host job and writes a report file.
+  runScript.js
+  Runs a script and writes a report file.
 */
 
 // ########## IMPORTS
 
-const {handleRequest} = require('./run');
+const {doJob} = require('./run');
 
 // ########## FUNCTIONS
 
-// Runs one script and sends the report to the parent.
-const runHost = async (id, scriptJSON, hostJSON) => {
+// Runs a script and returns the report.
+const runScript = async (id, scriptJSON) => {
   const report = {
     id,
-    host: JSON.parse(hostJSON),
     log: [],
     script: JSON.parse(scriptJSON),
     acts: []
   };
   let reportJSON = JSON.stringify(report, null, 2);
-  await handleRequest(report);
+  await doJob(report);
   report.acts.forEach(act => {
     try {
       JSON.stringify(act);
@@ -37,15 +36,13 @@ const runHost = async (id, scriptJSON, hostJSON) => {
   });
   try {
     reportJSON = JSON.stringify(report, null, 2);
+    return reportJSON;
   }
   catch(error) {
     console.log(`ERROR: report for host ${id} not JSON (${error.message})`);
+    return '';
   }
-  process.send(reportJSON, () => {
-    process.disconnect();
-    process.exit();
-  });
 };
 
 // ########## OPERATION
-runHost(... process.argv.slice(2));
+runScript(... process.argv.slice(2));

package/samples/{scripts/simple.json → simple.json}

@@ -2,6 +2,7 @@
   "id": "simple",
   "what": "Test example.com with bulk",
   "strict": true,
+  "timeLimit": 10,
   "commands": [
     {
       "type": "launch",

package/samples/{scripts/tp18.json → tp18.json}

@@ -1,5 +1,5 @@
 {
-  "id": "tp16",
+  "id": "tp18",
   "what": "Alfa, Axe, Continuum, HTML CodeSniffer, IBM, Nu Html Checker, Tenon, WAVE, and 22 custom tests",
   "strict": true,
   "timeLimit": 500,
@@ -11,7 +11,7 @@
     },
     {
       "type": "url",
-      "which": "https://*",
+      "which": "https://example.com/",
       "what": "any page"
     },
     {
@@ -35,7 +35,7 @@
     },
     {
       "type": "url",
-      "which": "https://*",
+      "which": "https://example.com/",
       "what": "any page"
     },
     {

package/tests/titledEl.js

@@ -11,8 +11,8 @@ exports.reporter = async (page, withItems) => {
       // FUNCTION DEFINITION START
       // Returns a space-minimized copy of a string.
       const compact = string => string
-      ? string.replace(/[\t\n]/g, '').replace(/\s{2,}/g, ' ').trim()
-      : '';
+        ? string.replace(/[\t\n]/g, '').replace(/\s{2,}/g, ' ').trim()
+        : '';
       // FUNCTION DEFINITION END
       return badTitleElements.map(element => ({
         tagName: element.tagName,

package/validation/executors/debug.js

@@ -2,7 +2,7 @@
 // Validator for Testaro tests.
 
 const fs = require('fs').promises;
-const {handleRequest} = require(`${__dirname}/../../run`);
+const {doJob} = require(`${__dirname}/../../run`);
 const validateTests = async () => {
   const totals = {
     attempts: 0,
@@ -18,7 +18,7 @@ const validateTests = async () => {
     const report = {script};
     report.log = [];
     report.acts = [];
-    await handleRequest(report);
+    await doJob(report);
     const {log, acts} = report;
     if (log.length === 2 && log[1].event === 'endTime' && /^\d{4}-.+$/.test(log[1].value)) {
       console.log('Success: Log has been correctly populated');

package/validation/executors/high.js

@@ -0,0 +1,57 @@
+// high.js
+// Validator for high-level invocation of Testaro.
+
+// ########## IMPORTS
+
+const fs = require('fs/promises');
+
+// ########## CONSTANTS
+
+const projectRoot = `${__dirname}/../..`;
+process.env.REPORTDIR = `${projectRoot}/temp`;
+const reportDir = process.env.REPORTDIR;
+process.env.SCRIPTDIR = `${projectRoot}/samples`;
+
+// ########## OPERATION
+
+// Run the simple script and write a report.
+const {runJob} = require(`${projectRoot}/high`);
+runJob('simple')
+.then(
+  // When the report has been written:
+  async () => {
+    // Open it.
+    const fileNames = await fs.readdir(reportDir);
+    const reportNames = fileNames.filter(name => name.endsWith('-simple.json'));
+    if (reportNames.length) {
+      try {
+        // Check its log and act lengths against expectations.
+        const reportJSON = await fs.readFile(`${reportDir}/${reportNames[0]}`);
+        const report = JSON.parse(reportJSON);
+        const {log, acts} = report;
+        if (log.length !== 2) {
+          console.log(
+            `Failure: log length is ${log.length} instead of 2 (see temp/${reportNames[0]}})`
+          );
+        }
+        else if (acts.length !== 3) {
+          console.log(
+            `Failure: acts length is ${acts.length} instead of 3 (see temp/${reportNames[0]}})`
+          );
+        }
+        else {
+          console.log(`Success (report is in temp/${reportNames[0]})`);
+        }
+      }
+      catch(error) {
+        console.log(`ERROR: ${error.message}`);
+      }
+    }
+    else {
+      console.log('ERROR: report not found');
+    }
+  },
+  error => {
+    console.log(`ERROR running script (${error.message})`);
+  }
+);

package/validation/executors/low.js

@@ -13,8 +13,8 @@ const validate = async () => {
     log: [],
     acts: []
   };
-  const {handleRequest} = require('../../run');
-  await handleRequest(report);
+  const {doJob} = require('../../run');
+  await doJob(report);
   const {log, acts} = report;
   if (log.length !== 2) {
     console.log(`Failure: log length is ${log.length} instead of 2`);

package/validation/executors/tenon.js

@@ -2,7 +2,7 @@
 // Test executor for tenon sample script.
 
 const fs = require('fs');
-const {handleRequest} = require('../../run');
+const {doJob} = require('../../run');
 const scriptJSON = fs.readFileSync('samples/scripts/tenon.json', 'utf8');
 const script = JSON.parse(scriptJSON);
 const report = {
@@ -12,7 +12,7 @@ const report = {
   acts: []
 };
 (async () => {
-  await handleRequest(report);
+  await doJob(report);
   console.log(`Report log:\n${JSON.stringify(report.log, null, 2)}\n`);
   console.log(`Report acts:\n${JSON.stringify(report.acts, null, 2)}`);
 })();

package/validation/executors/test.js

@@ -3,7 +3,7 @@
 // Execution example: node validation/executors/test focOp
 
 const fs = require('fs').promises;
-const {handleRequest} = require(`${__dirname}/../../run`);
+const {doJob} = require(`${__dirname}/../../run`);
 const test = process.argv[2];
 const validateTests = async () => {
   const scriptFileNames = await fs.readdir(`${__dirname}/../tests/scripts`);
@@ -16,7 +16,7 @@ const validateTests = async () => {
     const report = {script};
     report.log = [];
     report.acts = [];
-    await handleRequest(report);
+    await doJob(report);
     const {log, acts} = report;
     if (log.length === 2 && log[1].event === 'endTime' && /^\d{4}-.+$/.test(log[1].value)) {
       console.log('Success: Log has been correctly populated');

package/validation/executors/tests.js

@@ -2,7 +2,7 @@
 // Validator for Testaro tests.
 
 const fs = require('fs').promises;
-const {handleRequest} = require(`${__dirname}/../../run`);
+const {doJob} = require(`${__dirname}/../../run`);
 const validateTests = async () => {
   const totals = {
     attempts: 0,
@@ -18,7 +18,7 @@ const validateTests = async () => {
     const report = {script};
     report.log = [];
     report.acts = [];
-    await handleRequest(report);
+    await doJob(report);
     const {log, acts} = report;
     if (log.length === 2 && log[1].event === 'endTime' && /^\d{4}-.+$/.test(log[1].value)) {
       console.log('Success: Log has been correctly populated');

package/watch.js

@@ -1,54 +1,53 @@
 /*
   watch.js
-  Watches for jobs and runs them.
+  Watches for a script and runs it.
+  Arguments:
+    0. Watch type: 'dir' or 'net'.
+    1. How long to watch: 'once' or 'forever'.
+    2. How often to check in seconds.
+  Usage example: node watch dir once 15
 */
 
 // ########## IMPORTS
 
 // Module to keep secrets local.
-// require('dotenv').config({override: true});
 require('dotenv').config();
 // Module to read and write files.
 const fs = require('fs/promises');
 // Module to perform tests.
-const {handleRequest} = require('./run');
-// Module to convert a script and a batch to a batch-based array of scripts.
-const {batchify} = require('./batchify');
+const {doJob} = require('./run');
 
 // ########## CONSTANTS
 
-const watchType = process.env.WATCH_TYPE;
+const watchType = process.argv[2];
+const watchForever = process.argv[3] === 'forever';
+const interval = Number.parseInt(process.argv[4]);
 let client;
 if (watchType === 'net') {
   client = require(process.env.PROTOCOL || 'https');
 }
 const jobURL = process.env.JOB_URL;
-const authCode = process.env.AUTH_CODE;
-const jobDir = process.env.JOBDIR;
-const exJobDir = process.env.EXJOBDIR;
+const worker = process.env.WORKER;
+const watchDir = process.env.WATCHDIR;
+const doneDir = process.env.DONEDIR;
 const reportURL = process.env.REPORT_URL;
 const reportDir = process.env.REPORTDIR;
-const interval = process.env.INTERVAL;
-// Values of process.env properties are coerced to strings.
-const watchForever = process.env.WATCH_FOREVER == 'true';
 
 // ########## FUNCTIONS
 
 // Checks for a directory job.
 const checkDirJob = async () => {
-  const jobDirFileNames = await fs.readdir(jobDir);
+  const jobDirFileNames = await fs.readdir(watchDir);
   const jobFileNames = jobDirFileNames.filter(fileName => fileName.endsWith('.json'));
   if (jobFileNames.length) {
-    const firstJobID = jobFileNames[0].slice(0, -5);
-    const jobJSON = await fs.readFile(`${jobDir}/${jobFileNames[0]}`, 'utf8');
+    const scriptJSON = await fs.readFile(`${watchDir}/${jobFileNames[0]}`, 'utf8');
     try {
-      const job = JSON.parse(jobJSON, null, 2);
-      job.jobID = firstJobID;
-      return job;
+      const script = JSON.parse(scriptJSON, null, 2);
+      return script;
     }
     catch(error) {
       return {
-        error: 'ERROR: Job was not JSON',
+        error: 'ERROR: Script was not JSON',
         message: error.message
       };
     }
@@ -59,8 +58,8 @@ const checkDirJob = async () => {
 };
 // Checks for a network job.
 const checkNetJob = async () => {
-  const job = await new Promise(resolve => {
-    const wholeURL = `${process.env.PROTOCOL}://${jobURL}?authCode=${authCode}`;
+  const script = await new Promise(resolve => {
+    const wholeURL = `${process.env.PROTOCOL}://${jobURL}?worker=${worker}`;
     const request = client.request(wholeURL, response => {
       const chunks = [];
       response.on('data', chunk => {
@@ -68,18 +67,10 @@ const checkNetJob = async () => {
       });
       response.on('end', () => {
         try {
-          const jobJSON = chunks.join('');
-          const job = JSON.parse(jobJSON);
-          // If a qualifying job was received:
-          if (job.jobID) {
-            // Return it.
-            resolve(job);
-          }
-          // Otherwise, i.e. if there was no qualifying job:
-          else {
-            // Return this.
-            resolve({});
-          }
+          const scriptJSON = chunks.join('');
+          const script = JSON.parse(scriptJSON);
+          // Return it.
+          resolve(script);
         }
         catch(error) {
           resolve({
@@ -92,20 +83,21 @@ const checkNetJob = async () => {
     });
     request.end();
   });
-  return job;
+  return script;
 };
 // Writes a directory report.
 const writeDirReport = async report => {
-  const {id, jobID} = report;
-  if (id && jobID) {
-    const reportJSON = JSON.stringify(report, null, 2);
+  const scriptID = report && report.script && report.script.id;
+  if (scriptID) {
     try {
-      await fs.writeFile(`${reportDir}/${id}.json`, reportJSON);
-      console.log(`Report ${id}.json saved`);
+      const reportJSON = JSON.stringify(report, null, 2);
+      const reportName = `${report.timeStamp}-${scriptID}.json`;
+      await fs.writeFile(`${reportDir}/${reportName}`, reportJSON);
+      console.log(`Report ${reportName} saved`);
       return true;
     }
     catch(error) {
-      console.log(`ERROR: Failed to write report ${id} for job ${jobID}`);
+      console.log(`ERROR: Failed to write report (${error.message})`);
       return false;
     }
   }
@@ -113,7 +105,7 @@ const writeDirReport = async report => {
 // Submits a network report.
 const writeNetReport = async report => {
   const ack = await new Promise(resolve => {
-    const wholeURL = `${process.env.PROTOCOL}://${reportURL}?authCode=${authCode}`;
+    const wholeURL = `${process.env.PROTOCOL}://${reportURL}?worker=${worker}`;
     const request = client.request(wholeURL, {method: 'POST'}, response => {
       const chunks = [];
       response.on('data', chunk => {
@@ -134,15 +126,15 @@ const writeNetReport = async report => {
     });
     request.write(JSON.stringify(report, null, 2));
     request.end();
-    console.log(`Report with ID ${report.id} submitted`);
+    console.log(`Report ${report.timeStamp}-${report.script.id} submitted`);
   });
   return ack;
 };
 // Archives a job.
-const exifyJob = async (job) => {
-  const jobJSON = JSON.stringify(job, null, 2);
-  await fs.writeFile(`${exJobDir}/${job.timeStamp}.json`, jobJSON);
-  await fs.rm(`${jobDir}/${job.jobID}.json`);
+const archiveJob = async script => {
+  const jobJSON = JSON.stringify(script, null, 2);
+  await fs.writeFile(`${doneDir}/${script.timeStamp}-${script.id}.json`, jobJSON);
+  await fs.rm(`${watchDir}/${script.id}.json`);
 };
 // Waits.
 const wait = ms => {
@@ -152,117 +144,84 @@ const wait = ms => {
     }, ms);
   });
 };
-// Runs one script and writes or sends a report.
-const runHost = async (jobID, timeStamp, id, script) => {
-  const report = {
-    jobID,
-    timeStamp,
-    id,
-    log: [],
-    script,
-    acts: []
-  };
-  await handleRequest(report);
-  if (watchType === 'dir') {
-    return await writeDirReport(report);
-  }
-  else {
-    const ack = await writeNetReport(report);
-    if (ack.error) {
-      console.log(JSON.stringify(ack, null, 2));
-      return false;
-    }
-    else {
-      return true;
-    }
-  }
-};
-// Runs a job and returns a report file for the script or each host.
-const runJob = async job => {
-  const {jobID, script, batch} = job;
-  if (jobID) {
-    if (script) {
-      try {
-        // Identify the start time and a time stamp.
-        const timeStamp = Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
-        job.timeStamp = timeStamp;
-        // If there is a batch:
-        if (batch) {
-          // Convert the script to a set of host scripts.
-          const specs = batchify(script, batch, timeStamp);
-          // For each host script:
-          let success = true;
-          while (specs.length && success) {
-            // Run it and write or submit a report with a host-suffixed time-stamp ID.
-            const spec = specs.shift();
-            const {id} = spec;
-            const hostScript = spec.script;
-            success = await runHost(jobID, timeStamp, id, hostScript);
-          }
-          return success;
+// Runs a script, time-stamps it, and returns a report.
+const runJob = async script => {
+  const {id} = script;
+  if (id) {
+    try {
+      // Identify the start time and a time stamp.
+      const timeStamp = Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
+      script.timeStamp = timeStamp;
+      // Initialize a report.
+      const report = {
+        log: [],
+        script,
+        acts: []
+      };
+      await doJob(report);
+      if (watchType === 'dir') {
+        return await writeDirReport(report);
+      }
+      else {
+        const ack = await writeNetReport(report);
+        if (ack.error) {
+          console.log(JSON.stringify(ack, null, 2));
+          return false;
         }
-        // Otherwise, i.e. if there is no batch:
         else {
-          // Run the script and submit a report with a timestamp ID.
-          return await runHost(jobID, timeStamp, timeStamp, script);
+          return true;
         }
       }
-      catch(error) {
-        console.log(`ERROR: ${error.message}\n${error.stack}`);
-        return {
-          error: `ERROR: ${error.message}\n${error.stack}`
-        };
-      }
     }
-    else {
-      console.log('ERROR: no script specified');
+    catch(error) {
+      console.log(`ERROR: ${error.message}\n${error.stack}`);
       return {
-        error: 'ERROR: no script specified'
+        error: `ERROR: ${error.message}\n${error.stack}`
       };
     }
   }
   else {
-    console.log('ERROR: no job ID property in job');
+    console.log('ERROR: script has no id');
     return {
-      error: 'ERROR: no job ID property in job'
+      error: 'ERROR: script has no id'
     };
   }
 };
-// Repeatedly checks for jobs, runs them, and submits reports.
+// Checks for a job, performs it, and submits a report, once or repeatedly.
 const cycle = async forever => {
-  const intervalMS = Number.parseInt(interval);
+  const intervalMS = 1000 * Number.parseInt(interval);
   let statusOK = true;
   let empty = false;
   console.log(`Watching started with intervals of ${interval} seconds when idle`);
   while (statusOK) {
     if (empty) {
-      await wait(1000 * intervalMS);
+      await wait(intervalMS);
     }
     // Check for a job.
-    let job;
+    let script;
     if (watchType === 'dir') {
-      job = await checkDirJob();
+      script = await checkDirJob();
     }
     else if (watchType === 'net') {
-      job = await checkNetJob();
+      script = await checkNetJob();
     }
     else {
-      job = {};
+      script = {};
       console.log('ERROR: invalid WATCH_TYPE environment variable');
       statusOK = false;
     }
     // If there was one:
-    if (job.jobID) {
-      // Run it.
-      console.log(`Running job ${job.jobID}`);
-      statusOK = await runJob(job);
-      console.log(`Job ${job.jobID} finished with time stamp ${job.timeStamp}`);
+    if (script.id) {
+      // Run it, add a timestamp to it, and save a report.
+      console.log(`Running script ${script.id}`);
+      statusOK = await runJob(script);
+      console.log(`Job ${script.id} finished with time stamp ${script.timeStamp}`);
       if (statusOK) {
-        // If the job was a file:
+        // If the script was in a directory:
         if (watchType === 'dir') {
-          // Archive it.
-          await exifyJob(job);
-          console.log(`Job archived as ${job.timeStamp}.json`);
+          // Archive the script.
+          await archiveJob(script);
+          console.log(`Script ${script.id}.json archived as ${script.timeStamp}-${script.id}.json`);
         }
         // If watching was specified for only 1 job, stop.
         statusOK = forever;

package/batchify.js

@@ -1,25 +0,0 @@
-/*
-  batchify.js
-  Creates a set of scripts from a script and a batch.
-*/
-
-// Converts a script to a batch-based array of scripts.
-exports.batchify = (script, batch, timeStamp) => {
-  const {hosts} = batch;
-  const specs = hosts.map(host => {
-    const newScript = JSON.parse(JSON.stringify(script));
-    newScript.commands.forEach(command => {
-      if (command.type === 'url') {
-        command.which = host.which;
-        command.what = host.what;
-      }
-    });
-    const spec = {
-      id: `${timeStamp}-${host.id}`,
-      host,
-      script: newScript
-    };
-    return spec;
-  });
-  return specs;
-};