testaro 8.4.7 → 9.0.0

package/validation/watch/todo/README.md

@@ -0,0 +1,3 @@
+# jobs
+
+Directory watched by executor `watchDir`.

package/watch.js

@@ -19,7 +19,6 @@ const client = require(protocol);
 const jobURL = process.env.JOB_URL;
 const agent = process.env.AGENT;
 const jobDir = process.env.JOBDIR;
-const doneDir = process.env.DONEDIR;
 const reportURL = process.env.REPORT_URL;
 const reportDir = process.env.REPORTDIR;
 
@@ -28,11 +27,11 @@ const reportDir = process.env.REPORTDIR;
 // Checks for a directory job.
 const checkDirJob = async () => {
   try {
-    const jobDirFileNames = await fs.readdir(jobDir);
-    const jobFileNames = jobDirFileNames.filter(fileName => fileName.endsWith('.json'));
+    const toDoDirFileNames = await fs.readdir(`${jobDir}/todo`);
+    const jobFileNames = toDoDirFileNames.filter(fileName => fileName.endsWith('.json'));
     if (jobFileNames.length) {
       console.log('Directory job found');
-      const jobJSON = await fs.readFile(`${jobDir}/${jobFileNames[0]}`, 'utf8');
+      const jobJSON = await fs.readFile(`${jobDir}/todo/${jobFileNames[0]}`, 'utf8');
       try {
         const job = JSON.parse(jobJSON, null, 2);
         return job;
@@ -89,26 +88,24 @@ const checkNetJob = async () => {
 };
 // Writes a directory report.
 const writeDirReport = async report => {
-  const jobID = report && report.job && report.job.id;
+  const jobID = report && report.id;
   if (jobID) {
     try {
       const reportJSON = JSON.stringify(report, null, 2);
       const reportName = `${jobID}.json`;
-      await fs.writeFile(`${reportDir}/${reportName}`, reportJSON);
-      console.log(`Report ${reportName} saved`);
-      return true;
+      const rawDir = `${reportDir}/raw`;
+      await fs.writeFile(`${rawDir}/${reportName}`, reportJSON);
+      console.log(`Report ${reportName} saved in ${rawDir}`);
     }
     catch(error) {
       console.log(`ERROR: Failed to write report (${error.message})`);
-      return false;
     }
   }
   else {
     console.log('ERROR: Job has no ID');
-    return false;
   }
 };
-// Submits a network report.
+// Submits a network report to a server and returns the server response.
 const writeNetReport = async report => {
   const ack = await new Promise(resolve => {
     const wholeURL = `${process.env.PROTOCOL}://${reportURL}`;
@@ -132,22 +129,27 @@ const writeNetReport = async report => {
         }
       });
     });
-    report.agent = agent;
+    report.jobData.agent = agent;
     request.on('error', error => {
       console.log(`ERROR submitting job report (${error.message})`);
-      resolve({});
+      resolve({
+        error: 'ERROR: Job report submission failed',
+        message: error.message
+      });
     });
+    // Send the report to the server.
     request.write(JSON.stringify(report, null, 2));
     request.end();
-    console.log(`Report ${report.job.id} submitted`);
+    console.log(`Report ${report.id} submitted`);
   });
+  // Return the server response.
   return ack;
 };
 // Archives a job.
 const archiveJob = async job => {
   const jobJSON = JSON.stringify(job, null, 2);
-  await fs.writeFile(`${doneDir}/${job.id}.json`, jobJSON);
-  await fs.rm(`${jobDir}/${job.id}.json`);
+  await fs.writeFile(`${jobDir}/done/${job.id}.json`, jobJSON);
+  await fs.rm(`${jobDir}/todo/${job.id}.json`);
 };
 // Waits.
 const wait = ms => {
@@ -157,49 +159,38 @@ const wait = ms => {
     }, ms);
   });
 };
-// Runs a job and returns a report.
+// Runs a job.
 const runJob = async (job, isDirWatch) => {
+  // If the job has an ID:
   const {id} = job;
   if (id) {
     try {
-      // Initialize a report.
-      const report = {
-        job,
-        acts: [],
-        jobData: {}
-      };
       // Run the job, adding to the report.
-      await doJob(report);
+      await doJob(job);
       // If a directory was watched:
       if (isDirWatch) {
         // Save the report.
-        return await writeDirReport(report);
+        await writeDirReport(job);
       }
       // Otherwise, i.e. if the network was watched:
       else {
         // Send the report to the server.
-        const ack = await writeNetReport(report);
+        const ack = await writeNetReport(job);
         if (ack.error) {
           console.log(JSON.stringify(ack, null, 2));
-          return false;
-        }
-        else {
-          return true;
         }
       }
     }
+    // If the job failed:
     catch(error) {
+      // Report this.
       console.log(`ERROR: ${error.message}\n${error.stack}`);
-      return {
-        error: `ERROR: ${error.message}\n${error.stack}`
-      };
     }
   }
+  // Otherwise, i.e. if the job has no ID:
   else {
+    // Report this.
     console.log('ERROR: Job has no id');
-    return {
-      error: 'ERROR: Job has no id'
-    };
   }
 };
 // Checks for a job, performs it, and submits a report, once or repeatedly.
@@ -225,25 +216,24 @@ exports.cycle = async (isDirWatch, isForever, interval) => {
     if (job.id) {
       // Run it and save a report.
       console.log(`Running job ${job.id}`);
-      statusOK = await runJob(job, isDirWatch);
+      await runJob(JSON.parse(JSON.stringify(job)), isDirWatch);
       console.log(`Job ${job.id} finished`);
-      if (statusOK) {
-        // If a directory was watched:
-        if (isDirWatch) {
-          // Archive the job.
-          await archiveJob(job);
-          console.log(`Job ${job.id} archived`);
-        }
-        // If watching was specified for only 1 job, stop.
-        statusOK = isForever;
-        // Prevent a wait before the next iteration.
-        empty = false;
+      // If a directory was watched:
+      if (isDirWatch) {
+        // Archive the job.
+        await archiveJob(job);
+        console.log(`Job ${job.id} archived`);
       }
+      // If watching was specified for only 1 job, quit.
+      statusOK = isForever;
+      // Prevent a wait before the next iteration.
+      empty = false;
     }
+    // Otherwise, i.e. if no job was found:
     else {
+      // Cause a wait before the next check.
       empty = true;
     }
   }
   console.log('Watching ended');
-  return '';
 };

package/high.js

@@ -1,60 +0,0 @@
-/*
-  high.js
-  Invokes Testaro with the high-level method.
-  Usage example: node high tp25
-*/
-
-// ########## IMPORTS
-
-// Module to keep secrets.
-require('dotenv').config();
-// Module to read and write files.
-const fs = require('fs/promises');
-// Module to run jobs and report results.
-const {doJob} = require('./run');
-
-// ########## CONSTANTS
-
-const jobDir = process.env.JOBDIR;
-const reportDir = process.env.REPORTDIR;
-
-// ########## VARIABLES
-
-// Set 5 minutes as a default time limit.
-let timeLimit = 300;
-
-// ########## FUNCTIONS
-
-// Performs a file-based job and writes a report file.
-exports.runJob = async jobID => {
-  try {
-    // Get the job.
-    const jobJSON = await fs.readFile(`${jobDir}/${jobID}.json`, 'utf8');
-    const job = JSON.parse(jobJSON);
-    // If the job has no time limit, give it the default one.
-    if (! job.timeLimit) {
-      job.timeLimit = timeLimit;
-    }
-    // Initialize a report for the job.
-    const report = {
-      job,
-      acts: [],
-      jobData: {}
-    };
-    // If the initialized report is valid, run the job, adding the results to the report.
-    const done = await doJob(report);
-    if (done) {
-      const reportJSON = JSON.stringify(report, null, 2);
-      await fs.writeFile(`${reportDir}/${jobID}.json`, reportJSON);
-      console.log(`Report ${jobID}.json recorded in ${process.env.REPORTDIR}`);
-      return true;
-    }
-    else {
-      return false;
-    }
-  }
-  catch(error) {
-    console.log(`ERROR running job (${error.message})\n${error.stack}`);
-    return false;
-  }
-};

package/validation/executors/high.js

@@ -1,52 +0,0 @@
-// high.js
-// Validator for high-level invocation of Testaro.
-
-// ########## IMPORTS
-
-const fs = require('fs/promises');
-
-// ########## CONSTANTS
-
-const projectRoot = `${__dirname}/../..`;
-process.env.JOBDIR = `${projectRoot}/validation/jobs`;
-process.env.REPORTDIR = `${projectRoot}/temp`;
-const reportDir = process.env.REPORTDIR;
-const jobID = '00000-simple-example';
-
-// ########## OPERATION
-
-// Run the simple job and write a report.
-const {runJob} = require(`${projectRoot}/high`);
-runJob(jobID)
-.then(
-  // When the report has been written:
-  async () => {
-    try {
-      // Check it against expectations.
-      const reportJSON = await fs.readFile(`${reportDir}/${jobID}.json`, 'utf8');
-      const report = JSON.parse(reportJSON);
-      const {job, acts, jobData} = report;
-      if (! job) {
-        console.log('Failure: Report omits job');
-      }
-      else if (acts.length !== 3) {
-        console.log('Failure: Counts of acts is not 3');
-      }
-      else if (! jobData) {
-        console.log('Failure: Report omits jobData');
-      }
-      else if (jobData.endTime < jobData.startTime) {
-        console.log('Failure: End time precedes start time');
-      }
-      else {
-        console.log(`Success (report is in temp/${jobID}.json)`);
-      }
-    }
-    catch(error) {
-      console.log(`ERROR: ${error.message}`);
-    }
-  },
-  error => {
-    console.log(`ERROR running job (${error.message})`);
-  }
-);

package/validation/executors/low.js

@@ -1,53 +0,0 @@
-// low.js
-// Validator for low-level invocation of Testaro.
-
-// ########## IMPORTS
-
-const fs = require('fs/promises');
-
-// ########## CONSTANTS
-
-const projectRoot = `${__dirname}/../..`;
-const {doJob} = require(`${projectRoot}/run`);
-process.env.JOBDIR = `${projectRoot}/validation/jobs`;
-process.env.REPORTDIR = `${projectRoot}/temp`;
-const jobID = '00000-simple-example';
-
-// ########## OPERATION
-
-// Get the simple job.
-fs.readFile(`${process.env.JOBDIR}/${jobID}.json`)
-.then(async jobJSON => {
-  const job = JSON.parse(jobJSON);
-  const report = {
-    job,
-    acts: [],
-    jobData: {}
-  };
-  // Run it.
-  await doJob(report);
-  try {
-    // Check the report against expectations.
-    const reportJSON = await fs.readFile(`${process.env.REPORTDIR}/${jobID}.json`, 'utf8');
-    const report = JSON.parse(reportJSON);
-    const {job, acts, jobData} = report;
-    if (! job) {
-      console.log('Failure: Report omits job');
-    }
-    else if (acts.length !== 3) {
-      console.log('Failure: Counts of acts is not 3');
-    }
-    else if (! jobData) {
-      console.log('Failure: Report omits jobData');
-    }
-    else if (jobData.endTime < jobData.startTime) {
-      console.log('Failure: End time precedes start time');
-    }
-    else {
-      console.log(`Success (report is in temp/${jobID}.json)`);
-    }
-  }
-  catch(error) {
-    console.log(`ERROR: ${error.message}`);
-  }
-});