testaro 8.5.2 → 9.0.1

package/validation/tests/jobs/embAc.json

@@ -2,7 +2,8 @@
   "id": "embAcVal",
   "what": "validation of embAc test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -48,6 +49,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/filter.json

@@ -2,7 +2,8 @@
   "id": "filterVal",
   "what": "validation of filter test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -49,6 +50,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/focAll.json

@@ -2,7 +2,8 @@
   "id": "focAllVal",
   "what": "validation of focAll test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -62,6 +63,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/focInd.json

@@ -2,7 +2,8 @@
   "id": "focIndVal",
   "what": "validation of focInd test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -63,6 +64,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/focOp.json

@@ -2,7 +2,8 @@
   "id": "focOpVal",
   "what": "validation of focOp test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -56,6 +57,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/focVis.json

@@ -2,7 +2,8 @@
   "id": "focVisVal",
   "what": "validation of focVis test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -29,6 +30,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/hover.json

@@ -2,7 +2,8 @@
   "id": "hoverVal",
   "what": "validation of hover test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -112,6 +113,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/labClash.json

@@ -2,7 +2,8 @@
   "id": "labClashVal",
   "what": "validation of labClash test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -46,6 +47,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/linkTo.json

@@ -2,7 +2,8 @@
   "id": "linkToVal",
   "what": "validation of linkTo test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -29,6 +30,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/linkUl.json

@@ -2,7 +2,8 @@
   "id": "linkUlVal",
   "what": "validation of linkUl test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -65,6 +66,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/menuNav.json

@@ -2,7 +2,8 @@
   "id": "menuNavVal",
   "what": "validation of menuNav test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -100,6 +101,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/miniText.json

@@ -2,7 +2,8 @@
   "id": "miniTextVal",
   "what": "validation of miniText test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -30,6 +31,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/motion.json

@@ -2,7 +2,8 @@
   "id": "motionVal",
   "what": "validation of motion test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "webkit",
@@ -56,6 +57,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/nonTable.json

@@ -2,7 +2,8 @@
   "id": "nonTableVal",
   "what": "validation of nonTable test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -31,6 +32,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/radioSet.json

@@ -2,7 +2,8 @@
   "id": "radioSetVal",
   "what": "validation of radioSet test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -46,6 +47,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/role.json

@@ -2,7 +2,8 @@
   "id": "roleVal",
   "what": "validation of role test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -54,6 +55,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/styleDiff.json

@@ -2,7 +2,8 @@
   "id": "styleDiffVal",
   "what": "validation of styleDiff test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -65,6 +66,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/tabNav.json

@@ -2,7 +2,8 @@
   "id": "tabNavVal",
   "what": "validation of tabNav test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -100,6 +101,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/textNodes.json

@@ -2,7 +2,8 @@
   "id": "elementsVal",
   "what": "validation of elements test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -92,6 +93,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/title.json

@@ -2,7 +2,8 @@
   "id": "titleVal",
   "what": "validation of title test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -40,6 +41,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/titledEl.json

@@ -2,7 +2,8 @@
   "id": "titledElVal",
   "what": "validation of titledEl test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -31,6 +32,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/tests/jobs/zIndex.json

@@ -2,7 +2,8 @@
   "id": "zIndexVal",
   "what": "validation of zIndex test",
   "strict": true,
-  "commands": [
+  "timeLimit": 20,
+  "acts": [
     {
       "type": "launch",
       "which": "chromium",
@@ -43,6 +44,6 @@
     "host": {},
     "requester": ""
   },
-  "jobCreationTime": "2002-11-12T09:31:00",
+  "creationTime": "2002-11-12T09:31:00",
   "timeStamp": "00000"
 }

package/validation/validateTest.js

@@ -2,18 +2,13 @@
 // Validator for one Testaro test.
 
 const fs = require('fs').promises;
-const {doJob} = require(`${__dirname}/../run`);
+const {doJob} = require('../run');
 exports.validateTest = async testID => {
   const jobFileNames = await fs.readdir(`${__dirname}/tests/jobs`);
   for (const jobFileName of jobFileNames.filter(fileName => fileName === `${testID}.json`)) {
     const rawJobJSON = await fs.readFile(`${__dirname}/tests/jobs/${jobFileName}`, 'utf8');
     const jobJSON = rawJobJSON.replace(/__targets__/g, 'file://validation/tests/targets');
-    const job = JSON.parse(jobJSON);
-    const report = {
-      job,
-      acts: [],
-      jobData: {}
-    };
+    const report = JSON.parse(jobJSON);
     await doJob(report);
     const {acts, jobData} = report;
     if (jobData.endTime && /^\d{4}-.+$/.test(jobData.endTime)) {
@@ -24,7 +19,7 @@ exports.validateTest = async testID => {
     }
     const testActs = acts.filter(act => act.type && act.type === 'test');
     if (
-      testActs.length === job.commands.filter(cmd => cmd.type === 'test').length
+      testActs.length === report.acts.filter(act => act.type === 'test').length
       && testActs.every(testAct => testAct.result && testAct.result.failureCount !== undefined)
     ) {
       console.log('Success: Reports have been correctly populated');

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,13 +88,14 @@ 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`);
+      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})`);
@@ -129,7 +129,7 @@ const writeNetReport = async report => {
         }
       });
     });
-    report.agent = agent;
+    report.jobData.agent = agent;
     request.on('error', error => {
       console.log(`ERROR submitting job report (${error.message})`);
       resolve({
@@ -140,7 +140,7 @@ const writeNetReport = async report => {
     // 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;
@@ -148,8 +148,8 @@ const writeNetReport = async report => {
 // 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 => {
@@ -159,29 +159,23 @@ const wait = ms => {
     }, ms);
   });
 };
-// Runs a job and returns the page.
+// 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.
-        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));
         }
@@ -222,7 +216,7 @@ exports.cycle = async (isDirWatch, isForever, interval) => {
     if (job.id) {
       // Run it and save a report.
       console.log(`Running job ${job.id}`);
-      await runJob(job, isDirWatch);
+      await runJob(JSON.parse(JSON.stringify(job)), isDirWatch);
       console.log(`Job ${job.id} finished`);
       // If a directory was watched:
       if (isDirWatch) {

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})`);
-  }
-);