testilo 36.0.1 → 37.0.0

package/README.md

@@ -205,16 +205,15 @@ Here is a script:
   timeLimit: 80,
   creationTimeStamp: ''
   executionTimeStamp: '',
+  sendReportTo: 'https://abccorp.com/api/report',
+  target: {
+    what: '',
+    url: ''
+  },
   sources: {
     script: 'ts99',
     batch: '',
-    target: {
-      what: '',
-      url: ''
-    },
-    lastTarget: false,
     mergeID: '',
-    sendReportTo: 'https://abccorp.com/api/report',
     requester: 'anama@abccorp.com'
   },
   acts: [
@@ -254,8 +253,9 @@ A script has several properties that specify facts about the jobs to be created.
 - `browserID`: This specifies the default browser type (`'chromium'`, `'firefox'`, or `'webkit'`) of the job.
 - `lowMotion`: This is true if the browser is to create tabs with the `reduce-motion` option set to `reduce` instead of `no-preference`. This makes the browser act as if the user has chosen a [motion-reduction option in the settings of the operating system or browser](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion#user_preferences). Motions on pages are, however, often immune to this setting.
 - `creationTimeStamp` and `executionTimeStamp`: These properties will have values assigned to them when jobs are created from the script.
-- `sources.script`: This preserves the ID of the script after the `id` property is replaced with a job ID.
-- `sources.sendReportTo`: This (if not `''`) is the URL to which a Testaro agent is to send its report after it performs a job derived from the script.
+- `sendReportTo`: This is a URL that Testaro is to send its job reports to, or `''` if the jobs will not be network jobs.
+- `target`: This object contains blank `url` and `what` properties, which will be populated each time the script is converted to a job.
+- `sources.script`: This preserves the ID of the script. The `id` property may be revised to a job ID when the script is converted to a job.
 - `sources.requester`: This is the email address to which a message announcing the completion of the job is to be sent, if any.
 - `acts`: an array of acts.
 
@@ -310,8 +310,6 @@ If you specify issue options, the script will prescribe the tests for all evalua
 
 For example, one issue in the `tic43.js` file is `mainNot1`. Four rules are classified as belonging to that issue: rule `main_element_only_one` of the `aslint` tool and 3 more rules defined by 3 other tools. You can also create custom classifications and save them in a `score` subdirectory of the `FUNCTIONDIR` directory.
 
-The `script()` function will populate the `sources.sendReportTo` property with the value, if any, of the environment variable `SEND_REPORT_TO`, and populate the `sources.requester` property with the value, if any, of the environment variable `REQUESTER`.
-
 #### Invocation
 
 There are two ways to use the `script` module.
@@ -368,6 +366,9 @@ When the `script` module creates a script for you, it does not ask you for all o
 - `browserID`: `'webkit'`
 - `lowMotion`: `false`
 - `timeLimit`: 50 plus 30 per tool
+- `sendReportTo`: `process.env.SEND_REPORT_TO`, or `''` if none
+- `sources.id`: script ID
+- `sources.requester`: `process.env.REQUESTER`, or `''` if none
 - `axe` test act: `detailLevel` = 2
 - `ibm` test act: `withItems` = `true`, `withNewContent` = `false`
 - `qualWeb` test act: `withNewContent` = `false`
@@ -394,8 +395,8 @@ A module can invoke `merge()` in this way:
 const {merge} = require('testilo/merge');
 const script = …;
 const batch = …;
-const timeStamp = '241215T1200';
-const jobs = merge(script, batch, timeStamp);
+const executionTimeStamp = '241215T1200';
+const jobs = merge(script, batch, executionTimeStamp);
 ```
 
 The first two arguments are a script and a batch obtained from files or from prior calls to `script()` and `batch()`.
@@ -434,17 +435,15 @@ A Testaro job produced by `merge` will be identical to the script from which it
     …
     creationTimeStamp: '241229T0537',
     executionTimeStamp: '250110T1200',
+    target: {
+      what: 'Real Estate Management',
+      url: 'https://abccorp.com/mgmt/realproperty.html'
+    },
     sources: {
-      script: 'ts99',
+      …,
       batch: 'departments',
       mergeID: '7f',
-      sendReportTo: 'https://abccorp.com/api/report',
-      requester: 'malavu@abccorp.com'
-      target: {
-        what: 'Real Estate Management',
-        url: 'https://abccorp.com/mgmt/realproperty.html'
-      },
-      lastTarget: false,
+      …
     },
     …
     ```
@@ -863,7 +862,7 @@ To test the `compare` module, in the project directory you can execute the state
 
 ### Track
 
-The `track` module of Testilo selects, organizes, and presents data from summaries to show changes over time in total scores. The module produces a web page, showing changes in a table and a line graph. The line graph contains a line for each target (namely, each value of the `sources.target.what` property).
+The `track` module of Testilo selects, organizes, and presents data from summaries to show changes over time in total scores. The module produces a web page, showing changes in a table and a line graph. The line graph contains a line for each target (namely, each value of the `target.what` property).
 
 A typical use case for tracking is monitoring, i.e. periodic auditing of one or more web pages.
 

package/call.js

@@ -424,9 +424,7 @@ const callTrack = async (trackerID, what, selector, targetWhat) => {
     // Remove unwanted results, if any, from it.
     if (targetWhat) {
       summaryReport.summaries = summaryReport.summaries.filter(
-        result => result.sources
-        && result.sources.target
-        && result.sources.target.what === targetWhat
+        result => result.target && result.target.what === targetWhat
       );
     }
     // If any results remain:

package/merge.js

@@ -109,7 +109,7 @@ exports.merge = (script, batch, executionTimeStamp) => {
     if (actGroups && url) {
       // Initialize a job.
       const job = JSON.parse(JSON.stringify(protoJob));
-      const {sources} = job;
+      const {sources, target} = job;
       // Make the job ID unique.
       const targetSuffix = alphaNumOf(index);
       job.id = `${executionTimeStamp}-${sources.mergeID}-${targetSuffix}`;
@@ -119,8 +119,8 @@ exports.merge = (script, batch, executionTimeStamp) => {
         sources.lastTarget = true;
       }
       // Populate the target-specific properties of the job.
-      sources.target.what = what;
-      sources.target.url = url;
+      target.what = what;
+      target.url = url;
       // Replace each placeholder object in the job with the named act group of the target.
       let {acts} = job;
       for (const actIndex in acts) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "36.0.1",
+  "version": "37.0.0",
   "description": "Prepares Testaro jobs and processes Testaro reports",
   "main": "call.js",
   "scripts": {

package/procs/difgest/tfp40/index.js

@@ -75,8 +75,7 @@ const populateQuery = (reportA, reportB, query) => {
   [reportA, reportB].forEach((report, index) => {
     // Add report-specific synopsis parameters to the query.
     const suffix = ['A', 'B'][index];
-    const {id, sources, jobData, score} = report;
-    const {target} = sources;
+    const {id, jobData, score, target} = report;
     const {summary, details} = score;
     query[`org${suffix}`] = target.what;
     query[`url${suffix}`] = target.which;

package/procs/digest/tdp40/index.js

@@ -51,8 +51,8 @@ const getIssueScoreRow = (summary, wcag, score, tools) => {
 };
 // Adds parameters to a query for a digest.
 const populateQuery = (report, query) => {
-  const {id, sources, score} = report;
-  const {script, target, requester} = sources;
+  const {id, score, sources, target} = report;
+  const {script, requester} = sources;
   const {scoreProcID, summary, details} = score;
   query.ts = script;
   query.sp = scoreProcID;

package/procs/digest/tdp43e/index.js

@@ -57,8 +57,8 @@ const getIssueScoreRow = (issueConstants, issueDetails) => {
 };
 // Adds parameters to a query for a digest.
 const populateQuery = (report, query) => {
-  const {browserID, deviceID, id, isolate, lowMotion, score, sources, standard, strict} = report;
-  const {agent, script, target, requester} = sources;
+  const {browserID, deviceID, id, isolate, lowMotion, score, sources, standard, strict, target} = report;
+  const {agent, requester, script} = sources;
   const {scoreProcID, summary, details} = score;
   query.ts = script;
   query.sp = scoreProcID;

package/procs/track/ttp40/index.js

@@ -58,7 +58,7 @@ const populateQuery = async (id, what, summaryReport, query) => {
   // Get an array of target descriptions and assign to each an ID.
   const rows = [];
   const targets = Array
-  .from(new Set(summaries.map(result => result.sources.target.what)))
+  .from(new Set(summaries.map(result => result.target.what)))
   .sort()
   .map((targetWhat, index) => [alphaNumOf(index), targetWhat]);
   const targetIDs = {};
@@ -70,13 +70,13 @@ const populateQuery = async (id, what, summaryReport, query) => {
   query.legendItems = legendItems.join('\n        ');
   // For each result:
   summaries.forEach(result => {
+    const {id, score, target} = result;
     // Create a date-time cell.
     const timeCell = `<td>${result.endTime}</td>`;
     // Create a score cell.
     const digestLinkDestination = digestURL.replace('__id__', result.id);
     const scoreCell = `<td><a href=${digestLinkDestination}>${result.score}</a></td>`;
     // Create a target cell.
-    const {target} = result.sources;
     const targetLink = `<a href="${target.url}">${target.what}</a>`;
     const targetCell = `<td>${targetIDs[target.what]}: ${targetLink}</td>`;
     const row = `<tr>${[timeCell, scoreCell, targetCell].join('')}</tr>`;

package/script.js

@@ -124,16 +124,15 @@ exports.script = (id, what, options = {}) => {
     timeLimit: Math.round(50 + 30 * Object.keys(toolsRulesData).length),
     creationTimeStamp: '',
     executionTimeStamp: '',
+    sendReportTo: process.env.SEND_REPORT_TO || '',
+    target: {
+      what: '',
+      url: ''
+    },
     sources: {
       script: id,
       batch: '',
-      target: {
-        what: '',
-        url: ''
-      },
-      lastTarget: false,
       mergeID: '',
-      sendReportTo: process.env.SEND_REPORT_TO || '',
       requester: process.env.REQUESTER || ''
     },
       acts: [

package/validation/compare/comparer.js

@@ -30,7 +30,7 @@
 // Adds parameters to a query for a comparison.
 exports.comparer = (reports, query) => {
   const entries = reports.map(report => ({
-    target: report.sources.target.what,
+    target: report.target.what,
     score: report.score.total
   }));
   const entriesHTML = entries

package/validation/digest/digester.js

@@ -29,6 +29,6 @@
 
 // Adds parameters to a query for a digest.
 exports.digester = (report, query) => {
-  query.target = report.sources.target.what;
+  query.target = report.target.what;
   query.testCount = report.score.testCount;
 };

package/validation/merge/validate.js

@@ -66,7 +66,7 @@ const validate = async () => {
   if (jobArrays.every(array => [0, 1].every(
     jobIndex => {
       const job = array[jobIndex];
-      return job.id === `${job.timeStamp}-${job.sources.script}-${job.sources.target.id}`;
+      return job.id === `${job.timeStamp}-${job.sources.script}-${job.target.id}`;
     }
   ))) {
     console.log('Success: Every job has a correct ID');
@@ -117,21 +117,21 @@ const validate = async () => {
     return;
   }
   if (jobArrays.every(array => [0, 1].every(
-    jobIndex => array[jobIndex].sources.target.id === batch.targets[jobIndex].id
+    jobIndex => array[jobIndex].target.id === batch.targets[jobIndex].id
   ))) {
-    console.log('Success: Every job has a correct sources.target.id property');
+    console.log('Success: Every job has a correct target.id property');
   }
   else {
-    console.log('ERROR: A job does not have a correct sources.target.id property');
+    console.log('ERROR: A job does not have a correct target.id property');
     return;
   }
   if (jobArrays.every(array => [0, 1].every(
-    jobIndex => array[jobIndex].sources.target.what === batch.targets[jobIndex].what
+    jobIndex => array[jobIndex].target.what === batch.targets[jobIndex].what
   ))) {
-    console.log('Success: Every job has a correct sources.target.what property');
+    console.log('Success: Every job has a correct target.what property');
   }
   else {
-    console.log('ERROR: A job does not have a correct sources.target.what property');
+    console.log('ERROR: A job does not have a correct target.what property');
     return;
   }
   if (jobArrays.every(