testaro 2.0.2 → 2.0.5

package/README.md

@@ -413,33 +413,28 @@ A batch offers an efficient way to perform a uniform set of operations on every
 
 A no-batch script offers a way to carry out a complex operation, which can include navigating from one host to another, which is not possible with a batch. Any `url` commands are performed as-is, without changes to their URLs.
 
-## Reports
-
-Testaro writes reports as files in JSON format. They contain detailed results.
-
-Testaro also writes to standard output a list of the names of the files containing the reports.
-
 ## Execution
 
 ### Invocation
 
-To run Testaro, create an _invocation_ file like this:
+To run Testaro, create an options object like this:
 
 ```javascript
-const options = {
-  reports: `${__readdir}/path/to/reports/directory`,
-  batch: `${__readdir}/path/to/batch/file.json`,
-  script: `${__readdir}/path/to/script/file.json`
-};
-const {handleRequest} = require('testaro');
-handleRequest(options);
+{
+  log: [],
+  reports: [],
+  script: {abc},
+  batch: {def}
+}
 ```
 
-The `batch` option is optional. If there is no batch, omit it.
+Replace `{abc}` with a script object, like the example script shown above.
+
+Replace `{def}` with a batch object, like the example batch shown above, or omit the `batch` property if there is no batch.
 
-The paths are relative to the directory containing the file. So, if the script file is `script.json` and is in the same directory as the invocation file, the path would be `${__readdir}/script.json`.
+Then execute the statement `require('testaro').handleRequest(ghi)`, where `ghi` is replaced with the name of the options object. That statement will run Testaro.
 
-If the invocation file is named `runTestaro.js`, execute it with the statement `node runTestaro`.
+While it runs, Testaro will populate the `log` and `reports` arrays of the options object. When Testaro finishes, the `log` and `reports` arrays will contain its results.
 
 ### Environment variables
 

package/index.js

@@ -1068,10 +1068,13 @@ const doActs = async (report, actIndex, page) => {
     await doActs(report, actIndex + 1, page);
   }
 };
-// Performs the commands in a script and returns a report.
-const doScript = async report => {
+// Performs the commands in a script.
+const doScript = async (options, report) => {
   // Reinitialize the log statistics.
   logCount = logSize = prohibitedCount = visitTimeoutCount = visitRejectionCount= 0;
+  // Add the start time to the report.
+  const startTime = new Date();
+  report.startTime = startTime.toISOString().slice(0, 19);
   // Add initialized properties to the report.
   report.presses = 0;
   report.amountRead = 0;
@@ -1105,6 +1108,12 @@ const doScript = async report => {
       }
     }
   }
+  // Add the end time and duration to the report.
+  const endTime = new Date();
+  report.endTime = endTime.toISOString().slice(0, 19);
+  report.elapsedSeconds =  Math.floor((endTime - startTime) / 1000);
+  // Add the report to the reports array.
+  options.reports.push(report);
 };
 // Recursively performs commands on the hosts of a batch.
 const doBatch = async (options, reportTemplate, hostIndex = 0) => {
@@ -1122,7 +1131,7 @@ const doBatch = async (options, reportTemplate, hostIndex = 0) => {
       }
     });
     // Perform the commands on the host.
-    await doScript(hostReport);
+    await doScript(options, hostReport);
     // Process the remaining hosts.
     await doBatch(options, reportTemplate, hostIndex + 1);
   }
@@ -1139,7 +1148,7 @@ const doScriptOrBatch = async (options, reportTemplate) => {
   else {
     // Perform the script.
     console.log('Starting no-batch script');
-    await doScript(reportTemplate);
+    await doScript(options, reportTemplate);
   }
   // Add an end time to the log.
   options.log.push({
@@ -1189,7 +1198,7 @@ exports.handleRequest = async options => {
       },
       {
         event: 'timeStamp',
-        value: Math.floor((Date.now() - Date.UTC(2022, 3)) / 10000).toString(36)
+        value: Math.floor((Date.now() - Date.UTC(2022, 1)) / 10000).toString(36)
       }
     );
     // Add the batch size to the log if there is a batch.

package/package.json

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