testilo 22.0.5 → 22.1.0

package/README.md

@@ -379,10 +379,12 @@ A module can invoke `merge` in this way:
 
 ```javaScript
 const {merge} = require('testilo/merge');
-const jobs = merge(script, batch, requester, true, 'only', false, '240115T1200');
+const jobs = merge(script, batch, requester, true, 'only', false, '240115T1200', 'jobs/', '.json');
 ```
 
-This invocation references `script`, `batch`, and `requester` variables that the module must have already defined. The `script` and `batch` variables are a script object and a batch object, respectively. The `requester` variable is an email address. The fourth argument is a boolean, specifying whether to perform test isolation. The fifth argument is a string that specifies the Testaro standardization option ('also', 'only', or 'no'). The sixth argument is a boolean, specifying whether Testaro will allow granular network watching of the job. The `merge()` function of the `merge` module generates jobs and returns them in an array. The invoking module can further dispose of the jobs as needed.
+This invocation references `script`, `batch`, and `requester` variables that the module must have already defined. The `script` and `batch` variables are a script object and a batch object, respectively. The `requester` variable is an email address. The fourth argument is a boolean, specifying whether to perform test isolation. The fifth argument is a string that specifies the Testaro standardization option ('also', 'only', or 'no'). The sixth argument is a boolean, specifying whether Testaro will allow granular network observation of the job. The seventh and eights arguments are strings that contain the parts, before and after the job ID, respectively, of the absolute or relative URL for retrieving the job report. In this case, a job with ID `20240420T1426-R7T-archive` will produce a report that can be retrieved at the relative URL `jobs/20240420T1426-R7T-archive.json`.
+
+The `merge()` function of the `merge` module generates jobs and returns them in an array. The invoking module can further dispose of the jobs as needed.
 
 ##### By a user
 
@@ -391,16 +393,18 @@ A user can invoke `merge` in this way:
 - Create a script and save it as a JSON file in the `scripts` subdirectory of the `process.env.SPECDIR` directory.
 - Create a batch and save it as a JSON file in the `batches` subdirectory of the `process.env.SPECDIR` directory.
 - In the Testilo project directory, execute this statement:
-    - `node call merge s b e i f g t`
+    - `node call merge scriptName batchName email isolate standard granular todoDir pre post`
 
 In these statements, replace:
-- `s` with the base name of the script file
-- `b` with the base name of the batch file
-- `e` with an email address, or with an empty string if the environment variable `process.env.REQUESTER` exists and you want to use it
-- `i` with `true` if you want test isolation or `false` if not
-- `f` with `'also'`, `'only'`, or `'no'` to specify the treatment of standard-format results.
-- `g` with `true` if reporting is to be granular, or `false` if not.
-- `t` with `true` if the job is to be saved in the `todo` subdirectory or `false` if it is to be saved in the `pending` subdirectory of the `process.env.JOBDIR` directory.
+- `scriptName` with the base name of the script file
+- `batchName` with the base name of the batch file
+- `email` with an email address, or with an empty string if the environment variable `process.env.REQUESTER` exists and you want to use it
+- `isolate` with `true` if you want test isolation or `false` if not
+- `standard` with `'also'`, `'only'`, or `'no'` to specify the treatment of standard-format results.
+- `granular` with `true` if granular observation is to be permitted, or `false` if not.
+- `todoDir` with `true` if the job is to be saved in the `todo` subdirectory or `false` if it is to be saved in the `pending` subdirectory of the `process.env.JOBDIR` directory.
+- `pre` with the pre-ID part of the report URL.
+- `post` with the post-ID part of the report URL.
 
 The `call` module will retrieve the named script and batch from their respective directories.
 The `merge` module will create an array of jobs, with or without test isolation.

package/call.js

@@ -85,7 +85,9 @@ const callMerge = async (
   const batchJSON = await fs.readFile(`${specDir}/batches/${batchID}.json`, 'utf8');
   const batch = JSON.parse(batchJSON);
   // Merge them into an array of jobs.
-  const jobs = merge(script, batch, requester, withIsolation, standard, isGranular);
+  const jobs = merge(
+    script, batch, requester, withIsolation, standard, isGranular, null, urlPrefix, urlSuffix
+  );
   // Save the jobs.
   const destination = todo === 'true' ? 'todo' : 'pending';
   for (const job of jobs) {
@@ -245,7 +247,7 @@ else if (fn === 'script' && fnArgs.length) {
     console.log('Execution completed');
   });
 }
-else if (fn === 'merge' && fnArgs.length === 7) {
+else if (fn === 'merge' && fnArgs.length === 9) {
   callMerge(... fnArgs)
   .then(() => {
     console.log('Execution completed');

package/merge.js

@@ -71,7 +71,9 @@ const getRandomID = length => {
   return chars.join('');
 };
 // Merges a script and a batch and returns jobs.
-exports.merge = (script, batch, requester, isolate, standard, observe, timeStamp) => {
+exports.merge = (
+  script, batch, requester, isolate, standard, observe, timeStamp, urlPrefix, urlSuffix
+) => {
   if (isolate === 'false') {
     isolate = false;
   }
@@ -107,7 +109,8 @@ exports.merge = (script, batch, requester, isolate, standard, observe, timeStamp
       what: ''
     },
     requester,
-    sendReportTo: process.env.REPORT_URL || ''
+    sendReportTo: process.env.REPORT_URL || '',
+    url: ''
   };
   // Add properties to the job.
   protoJob.creationTime = creationTime;
@@ -149,10 +152,11 @@ exports.merge = (script, batch, requester, isolate, standard, observe, timeStamp
       const job = JSON.parse(JSON.stringify(protoJob));
       // Append the target ID to the job ID.
       job.id += target.id;
-      // Add data on the target to the sources property of the job.
+      // Add data to the sources property of the job.
       job.sources.target.id = target.id;
       job.sources.target.which = target.which;
       job.sources.target.what = target.what;
+      job.sources.url = `${urlPrefix}${job.id}${urlSuffix}`;
       // Replace each placeholder object in the job with the named replacer array of the target.
       let {acts} = job;
       for (const actIndex in acts) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "22.0.5",
+  "version": "22.1.0",
   "description": "Prepares and processes Testaro reports",
   "main": "aim.js",
   "scripts": {

package/validation/merge/validate.js

@@ -21,8 +21,8 @@ const validate = async () => {
   const batch = JSON.parse(batchJSON);
   const requester = 'me@mydomain.tld';
   // Perform the merger without and with isolation.
-  const jobsNoIsolation = merge(script, batch, requester, false);
-  const jobsYesIsolation = merge(script, batch, requester, true);
+  const jobsNoIsolation = merge(script, batch, requester, false, 'no', false, '', 'reports/', '');
+  const jobsYesIsolation = merge(script, batch, requester, true, 'no', false, '', 'reports/', '');
   const jobArrays = [jobsNoIsolation, jobsYesIsolation];
   // Validate the jobs.
   if (jobsNoIsolation && jobsYesIsolation) {