testaro 4.1.0 → 4.1.1

package/README.md

@@ -454,25 +454,23 @@ You may store these environment variables in an untracked `.env` file if you wis
 
 ### Samples
 
-The `samples` directory contains scripts and a batch that you can use to test Testaro with with the high-level, by giving `SCRIPTDIR` the value `'samples/scripts'` and `BATCHDIR` the value `'samples/batches'`. Do to this, you must also define `REPORTDIR`.
+The `samples` directory contains scripts and a batch that you can use to test Testaro with with the high-level method, by giving `SCRIPTDIR` the value `'samples/scripts'` and `BATCHDIR` the value `'samples/batches'`. Do to this, you must also define `REPORTDIR`. Then execute `node job simple` or `node job simple weborgs` to run the `simple` script alone or with the `weborgs` batch.
 
 ### Validators
 
-_Executors_ for Testaro validation are located in the `validation` directory.
+Testaro can be validated with the _executors_ located in the `validation/executors` directory. Executors are modules that run Testaro with the low-level method and write the results to the standard output.
 
-A basic executor is the `test.js` file. It uses the low-level method to run Testaro with the `simple.js` sample script and outputs the log and the acts to the standard output.
+The executors are:
 
-The other executors are commonJS JavaScript modules that run Testaro and report whether the results are correct.
-
-The other executors are:
-- `app.js`: Reports whether Testaro runs correctly with a script.
-- `tests.js`: Runs Testaro with each custom test and reports whether the results are correct.
+- `app`: reports whether Testaro runs correctly with a script
+- `test`: runs the `simple` sample script
+- `tests`: makes Testaro perform each custom test and reports whether the results are correct
 
 There are no executors for validating the test packages.
 
-To execute any executor `xyz.js`, call it with the statement `node validation/executors/xyz`. The results will appear in the standard output.
+To execute any executor `xyz`, call it with the statement `node validation/executors/xyz`.
 
-The `tests.js` executor makes use of the scripts in the `validation/tests/scripts` directory, and they, in turn, run tests on HTML files in the `validation/tests/targets` directory.
+The `tests` executor makes use of the scripts in the `validation/tests/scripts` directory, and they, in turn, run tests on HTML files in the `validation/tests/targets` directory.
 
 ## Contribution
 

package/job.js

@@ -9,7 +9,7 @@
 require('dotenv').config();
 // Module to read and write files.
 const fs = require('fs/promises');
-const { handleRequest } = require('./run');
+const {handleRequest} = require('./run');
 
 // ########## CONSTANTS
 const scriptDir = process.env.SCRIPTDIR;
@@ -45,12 +45,12 @@ const runHost = async (id, script) => {
     script,
     acts: []
   };
-  await require('./run').handleRequest(report);
+  await handleRequest(report);
   const reportJSON = JSON.stringify(report, null, 2);
   await fs.writeFile(`${reportDir}/${id}.json`, reportJSON);
 };
 // Runs a job.
-exports.handleRequest = async (scriptID, batchID) => {
+exports.job = async (scriptID, batchID) => {
   if (scriptID) {
     try {
       const scriptJSON = await fs.readFile(`${scriptDir}/${scriptID}.json`, 'utf8');
@@ -89,4 +89,4 @@ exports.handleRequest = async (scriptID, batchID) => {
 
 // ########## OPERATION
 
-handleRequest(process.argv[2], process.argv[3]);
+exports.job(process.argv[2], process.argv[3]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "Automation of accessibility testing",
   "main": "index.js",
   "scripts": {

package/run.js

@@ -7,7 +7,6 @@
 require('dotenv').config();
 // Requirements for commands.
 const {commands} = require('./commands');
-const { handleRequest } = require('./job');
 // ########## CONSTANTS
 // Set DEBUG environment variable to 'true' to add debugging features.
 const debug = process.env.TESTARO_DEBUG === 'true';
@@ -1256,7 +1255,3 @@ exports.handleRequest = async report => {
     console.log('ERROR: options missing or invalid');
   }
 };
-
-// ########## OPERATION
-
-handleRequest(process.argv[2]);

package/validation/executors/app.js

@@ -3,6 +3,7 @@
 
 const report = {
   script: {
+    id: 'script0',
     what: 'Sample Testaro executor with 1 test',
     strict: true,
     commands: [
@@ -31,7 +32,7 @@ const report = {
   log: [],
   acts: []
 };
-const {handleRequest} = require(`${__dirname}/../../index`);
+const {handleRequest} = require(`${__dirname}/../../run`);
 handleRequest(report)
 .then(
   () => {

package/validation/executors/tenon.js

@@ -2,7 +2,7 @@
 // Test executor for tenon sample script.
 
 const fs = require('fs');
-const {handleRequest} = require('../../index');
+const {handleRequest} = require('../../run');
 const scriptJSON = fs.readFileSync('samples/scripts/tenon.json', 'utf8');
 const script = JSON.parse(scriptJSON);
 const report = {

package/validation/executors/test.js

@@ -2,8 +2,8 @@
 // Test executor.
 
 const fs = require('fs');
-const {handleRequest} = require('../../index');
-const scriptJSON = fs.readFileSync('samples/scripts/simple.json', 'utf8');
+const {handleRequest} = require(`${__dirname}/../../run`);
+const scriptJSON = fs.readFileSync(`${__dirname}/../../samples/scripts/simple.json`, 'utf8');
 const script = JSON.parse(scriptJSON);
 const report = {
   id: '',
@@ -11,8 +11,38 @@ const report = {
   log: [],
   acts: []
 };
-(async () => {
-  await handleRequest(report);
-  console.log(`Report log:\n${JSON.stringify(report.log, null, 2)}\n`);
-  console.log(`Report acts:\n${JSON.stringify(report.acts, null, 2)}`);
-})();
+handleRequest(report)
+.then(
+  () => {
+    const {log, acts} = report;
+    if (
+      log.length === 2
+      && log[1].event === 'endTime'
+      && /^\d{4}-.+$/.test(log[0].value)
+      && log[1].value >= log[0].value
+    ) {
+      console.log('Success: Log has been correctly populated');
+    }
+    else {
+      console.log('Failure: Log empty or invalid');
+      console.log(JSON.stringify(log, null, 2));
+    }
+    if (
+      acts.length === 3
+      && acts[0]
+      && acts[0].type === 'launch'
+      && acts[2].result
+      && acts[2].result.visibleElements
+      && typeof acts[2].result.visibleElements === 'number'
+    ) {
+      console.log('Success: Acts have been correctly populated');
+    }
+    else {
+      console.log('Failure: Acts empty or invalid');
+      console.log(JSON.stringify(acts, null, 2));
+    }
+  },
+  rejection => {
+    console.log(`Failure: ${rejection}`);
+  }
+);

package/validation/executors/tests.js

@@ -2,7 +2,7 @@
 // Validator for Testaro tests.
 
 const fs = require('fs').promises;
-const {handleRequest} = require(`${__dirname}/../../index`);
+const {handleRequest} = require(`${__dirname}/../../run`);
 const validateTests = async () => {
   const totals = {
     attempts: 0,