testilo 2.0.0 → 2.1.0

package/README.md

@@ -9,6 +9,8 @@ This application is designed to be installed on a Windows or Macintosh host and
 
 ## Dependencies
 
+The `dotenv` dependency lets you set environment variables in an untracked `.env` file.
+
 The Testaro dependency has some dependencies in the @siteimprove scope that are Github Packages. In order to execute `npm install` successfully, you need the `.npmrc` file in your project directory with this content, unless an `.npmrc` file in your home directory or elsewhere provides the same content:
 
 ```bash
@@ -76,10 +78,16 @@ Given that statement, Testilo replaces the hosts in the script with the first ho
 
 When you execute a `node index …` statement, Testilo begins populating the object argument by giving its `id` property a value. If there is no batch, the value of that property is a string encoding the date and time when you executed the statement (e.g., `eh9q7r`). If there is a batch, the value is the same, except that it is suffixed with a hyphen-minus character followed by the `id` value of the host (e.g., `eh9q7r-wikimedia`).
 
-Testaro delivers its results by populating the `log` and `acts` arrays of the object argument. Testilo waits for Testaro to finish performing the script and then saves the object argument in JSON format as a file in the `reports` directory.
+Testaro delivers its results by populating the `log` and `acts` arrays of the object argument. Testilo waits for Testaro to finish performing the script and then saves the object argument in JSON format as a file in the `reports` directory. The name of the file is the `id` value of the object, suffixed with `.json`.
 
 ## Configuration
 
 ### `ibm` test
 
 Testaro can perform the `ibm` test. That test requires the `aceconfig.js` configuration file in the root directory of the Testilo project.
+
+### Environment variables
+
+If a `wave` test is included in a script, an environment variable named `TESTARO_WAVE_KEY` must exist, with your WAVE API key as its value.
+
+Before executing a Testaro script, you can optionally also set the environment variables `TESTARO_DEBUG` (to `'true'` or anything else) and/or `TESTARO_WAITS` (to a non-negative integer). The effects of these variables are described in the Testaro `index.js` file.

package/index.js

@@ -6,6 +6,7 @@
 // ########## IMPORTS
 
 // Module to perform tests.
+require('dotenv').config();
 const {handleRequest} = require('testaro');
 const fs = require('fs').promises;
 
@@ -44,16 +45,16 @@ const callTestaro = async (id, script) => {
 };
 // Runs a job.
 const run = async () => {
-  const scriptName = process.argv[2];
+  const scriptID = process.argv[2];
   const batchName = process.argv[3];
-  if (scriptName) {
+  if (scriptID) {
     try {
-      const scriptJSON = await fs.readFile(`scripts/${scriptName}.json`, 'utf8');
+      const scriptJSON = await fs.readFile(`scripts/${scriptID}.json`, 'utf8');
       const script = JSON.parse(scriptJSON);
-      let batch = null;
       // Identify the start time and a timestamp.
       const timeStamp = Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
       // If there is a batch:
+      let batch = null;
       if (batchName) {
         // Convert the script to a batch-based set of scripts.
         const batchJSON = await fs.readFile(`batches/${batchName}.json`, 'utf8');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Client that runs Testaro tests to fulfill Aorta jobs",
   "main": "index.js",
   "scripts": {
@@ -18,6 +18,7 @@
   },
   "homepage": "https://github.com/jrpool/testilo",
   "dependencies": {
+    "dotenv": "*",
     "testaro": "*"
   },
   "devDependencies": {