testaro 8.1.8 → 8.1.10

package/README.md

@@ -119,7 +119,7 @@ Here is an example of a job:
 
 ```javascript
 {
-  id: 'be76p-tp25-w3c',
+  id: 'be76p-ts25-w3c',
   what: 'Test host with alfa',
   strict: true,
   timeLimit: 65,
@@ -161,7 +161,7 @@ This job contains three `commands`, telling Testaro to:
 1. perform the tests in the `alfa` package on that URL
 
 Job properties:
-- `id`: This is a string consisting of alphanumeric ASCII characters and hyphen-minus (-), intended to be unique. When this job is saved as a JSON file, the file name is `be76p-sp25-w3c.json`. Typically, a job is created from a _script_, and the job ID adds a timestamp prefix and a host suffix to the script ID. Here the script ID would have been `sp25`.
+- `id`: This is a string consisting of alphanumeric ASCII characters and hyphen-minus (-), intended to be unique. When this job is saved as a JSON file, the file name is `be76p-sp25-w3c.json`. Typically, a job is created from a _script_, and the job ID adds a timestamp prefix and a host suffix to the script ID. Here the script ID would have been `ts25`.
 - `what`: This is a description of the script.
 - `strict`: This is `true` or `false`, indicating whether _substantive redirections_ should be treated as failures. These are redirections that do more than add or subtract a final slash. For example, if `strict` is true, a redirection from `xyz.com` to `www.xyz.com` or to `xyz.com/en` will abort the job.
 - `timeLimit`: This optional property is the number of seconds allowed for the execution of the job. If omitted, Testaro sets a time limit of 300 seconds (5 minutes);
@@ -220,7 +220,7 @@ Here is an example of a newly initialized _report_.
 ```
 
 This report is an object produced by Testaro when it is about to run a job. The `job` property has the job as its value. The report also has two additional properties:
-- `acts`: This is an empty array. Testaro will copy the `job.commands` property into `acts` and then modify the array. Testaro can add more acts to the original ones. Testaro will also adds results to the acts.
+- `acts`: This is an empty array. Testaro will copy the `job.commands` property into `acts` and then modify the array. Testaro can add more acts to the original ones. Testaro will also add results to the acts.
 - `jobData`: Some results pertain to a job as a whole, not to any specific act. This property is an object where Testaro will record such job-level results.
 
 ### Commands

package/package.json

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

package/samples/{tp18.json → 00000-ts18-example.json}

@@ -1,5 +1,5 @@
 {
-  "id": "tp18",
+  "id": "00000-ts18-example",
   "what": "Alfa, Axe, Continuum, HTML CodeSniffer, IBM, Nu Html Checker, Tenon, WAVE, and 22 custom tests",
   "strict": true,
   "timeLimit": 500,
@@ -11,8 +11,9 @@
     },
     {
       "type": "url",
-      "which": "https://example.com/",
-      "what": "any page"
+      "which": "https://example.com",
+      "what": "Example.com",
+      "id": "example"
     },
     {
       "type": "tenonRequest",
@@ -35,8 +36,9 @@
     },
     {
       "type": "url",
-      "which": "https://example.com/",
-      "what": "any page"
+      "which": "https://example.com",
+      "what": "Example.com",
+      "id": "example"
     },
     {
       "type": "test",
@@ -213,5 +215,17 @@
       "id": "a",
       "what": "Tenon API version 2 result retrieval"
     }
-  ]
+  ],
+  "sources": {
+    "script": "ts18",
+    "batch": "",
+    "host": {
+      "id": "example",
+      "which": "https://example.com",
+      "what": "Example.com"
+    },
+    "requester": "user@domain.tld"
+  },
+  "jobCreationTime": "2022-11-12T22:51:45",
+  "timeStamp": "00000"
 }

package/validation/executors/high.js

@@ -8,46 +8,42 @@ 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('simple')
+runJob(jobID)
 .then(
   // When the report has been written:
   async () => {
-    // Open it.
-    const fileNames = await fs.readdir(reportDir);
-    const reportNames = fileNames.filter(name => name.endsWith('-simple.json'));
-    if (reportNames.length) {
-      try {
-        // Check its log and act lengths against expectations.
-        const reportJSON = await fs.readFile(`${reportDir}/${reportNames[0]}`);
-        const report = JSON.parse(reportJSON);
-        const {log, acts} = report;
-        if (log.length !== 2) {
-          console.log(
-            `Failure: log length is ${log.length} instead of 2 (see temp/${reportNames[0]}})`
-          );
-        }
-        else if (acts.length !== 3) {
-          console.log(
-            `Failure: acts length is ${acts.length} instead of 3 (see temp/${reportNames[0]}})`
-          );
-        }
-        else {
-          console.log(`Success (report is in temp/${reportNames[0]})`);
-        }
+    try {
+      // Check it against expectations.
+      const reportJSON = await fs.readFile(`${reportDir}/${jobID}.json`);
+      const report = JSON.parse(reportJSON);
+      const {job, acts, jobData} = report;
+      if (! job) {
+        console.log('Failure: Report omits job');
       }
-      catch(error) {
-        console.log(`ERROR: ${error.message}`);
+      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)`);
       }
     }
-    else {
-      console.log('ERROR: report not found');
+    catch(error) {
+      console.log(`ERROR: ${error.message}`);
     }
   },
   error => {

package/validation/jobs/00000-simple-example.json

@@ -0,0 +1,36 @@
+{
+  "id": "00000-simple-example",
+  "what": "Test example.com with bulk",
+  "strict": true,
+  "timeLimit": 10,
+  "commands": [
+    {
+      "type": "launch",
+      "which": "chromium",
+      "what": "Chromium browser"
+    },
+    {
+      "type": "url",
+      "which": "https://example.com/",
+      "what": "Example.com",
+      "id": "example"
+    },
+    {
+      "type": "test",
+      "which": "bulk",
+      "what": "count of visible elements"
+    }
+  ],
+  "sources": {
+    "script": "simple",
+    "batch": "",
+    "host": {
+      "id": "example",
+      "which": "https://example.com",
+      "what": "Example.com"
+    },
+    "requester": "user@domain.tld"
+  },
+  "jobCreationTime": "2022-11-12T22:51:45",
+  "timeStamp": "00000"
+}

package/samples/simple.json

@@ -1,23 +0,0 @@
-{
-  "id": "simple",
-  "what": "Test example.com with bulk",
-  "strict": true,
-  "timeLimit": 10,
-  "commands": [
-    {
-      "type": "launch",
-      "which": "chromium",
-      "what": "Chromium browser"
-    },
-    {
-      "type": "url",
-      "which": "https://example.com/",
-      "what": "page with a few accessibility defects"
-    },
-    {
-      "type": "test",
-      "which": "bulk",
-      "what": "bulk"
-    }
-  ]
-}