testilo 7.0.5 → 7.0.7

package/README.md

@@ -107,7 +107,7 @@ Execution by a module:
 
 ```javaScript
 const {merge} = require('testilo/merge');
-merge('tp25', 'weborgs')
+merge('tp25', 'weborgs', 'developer@w3.org')
 .then(() => {
   console.log('Merger complete');
 });
@@ -116,10 +116,10 @@ merge('tp25', 'weborgs')
 Execution by a user:
 
 ```bash
-node call merge tp25 weborgs
+node call merge tp25 weborgs developer@w3.org
 ```
 
-In these examples, a copy of the script file named `tp25.json` in the `SCRIPTDIR` directory is aimed at all the hosts in the batch file named `weborgs.json` in the `BATCHDIR` directory, and the resulting host-specific scripts are saved in the `JOBDIR` directory.
+In these examples, a copy of the script file named `tp25.json` in the `SCRIPTDIR` directory is aimed at all the hosts in the batch file named `weborgs.json` in the `BATCHDIR` directory, and the resulting jobs are saved in the `JOBDIR` directory. Each job has a `sources` property that identifies an email address to be notified after the job has been run.
 
 ### `score`
 

package/aim.js

@@ -1,6 +1,11 @@
 /*
   aim.js
   Module for aiming a script at a host.
+  Arguments:
+    0. script object.
+    1. host object.
+    2. email address to be notified of completion.
+    3?. time stamp.
 */
 
 // ########## FUNCTIONS
@@ -8,7 +13,7 @@
 // Returns a string representing the date and time.
 const nowString = () => (new Date()).toISOString().slice(0, 19);
 // Returns a script, aimed at a host, as a job.
-exports.aim = (script, host, requester) => {
+exports.aim = (script, host, requester, timeStamp = '') => {
   // Initialize a job based on the script.
   const job = JSON.parse(JSON.stringify(script));
   // Make all url commands in the script visit the host.
@@ -22,11 +27,13 @@ exports.aim = (script, host, requester) => {
   // Add source information to the script.
   job.sources = {
     script: script.id,
+    batch: '',
     host,
     requester
   }
-  // Create a job-creation time stamp.
-  const timeStamp = Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
+  // Create a job-creation time stamp, if not specified.
+  
+  timeStamp = timeStamp || Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
   // Change the script ID to a job ID.
   job.id = `${timeStamp}-${script.id}-${host.id}`;
   // Add the job-creation time to the script.

package/call.js

@@ -71,8 +71,8 @@ const callAim = async (scriptName, hostURL, hostName, hostID, requester) => {
   console.log(`Script ${scriptID} aimed at ${hostName} saved as job ${jobID}.json in ${jobDir}`);
 };
 // Fulfills a merger request.
-const callMerge = async (scriptName, batchName) => {
-  await merge(scriptName, batchName);
+const callMerge = async (scriptName, batchName, requester) => {
+  await merge(scriptName, batchName, requester);
   console.log(`Batch ${batchName}.json merged into script ${scriptName} in ${jobDir}`);
 };
 // Fulfills a scoring request.
@@ -117,34 +117,12 @@ const callScore = async (scoreProcID, reportIDStart = '') => {
 };
 // Fulfills a multiple-report scoring request.
 const callMultiScore = async scoreProcID => {
-  // Identify all the raw reports.
-  const rawFileNames = await fs.readdir(rawDir);
-  const rawReportNames = rawFileNames.filter(fileName => fileName.endsWith('.json'));
-  // If any exist:
-  if (rawReportNames.length) {
-    // For each of them:
-    const {scorer} = require(`${scoreProcDir}/${scoreProcID}.js`);
-    for (const rawReportName of rawReportNames) {
-      // Score it.
-      const rawReportJSON = await fs.readFile(`${rawDir}/${rawReportName}.json`);
-      const rawReport = JSON.parse(rawReportJSON);
-      const scoredReport = score(scorer, rawReport);
-      // Save it, scored.
-      await fs.writeFile(
-        `${scoredDir}/${scoredReport.id}.json`, JSON.stringify(scoredReport, null, 2)
-      );
-      console.log(`Report ${rawReport.id} scored and saved in ${scoredDir}`);
-    }
-  }
-  // Otherwise, i.e. if no raw report exists:
-  else {
-    // Report this.
-    console.log('ERROR: No raw report found');
-  }
+  // Score all raw reports.
+  await multiScore(scoreProcID);
 };
 // Prepares to fulfill a digesting request.
 const digestPrep = async digestProcID => {
-  const {digest} = require('testilo/digest');
+  const {digest} = require('./digest');
   const {makeQuery} = require(`${digestProcDir}/${digestProcID}/index`);
   const digestTemplate = await fs.readFile(`${digestProcDir}/${digestProcID}/index.html`, 'utf8');
   // Identify the scored reports.
@@ -162,12 +140,12 @@ const digestPrep = async digestProcID => {
 // Digests and saves a report.
 const digestReport = async (scoredReportName, prepData) => {
   // Digest the specified report.
-  const scoredReportJSON = await fs.readFile(`${scoredDir}/${scoredReportName}.json`, 'utf8');
+  const scoredReportJSON = await fs.readFile(`${scoredDir}/${scoredReportName}`, 'utf8');
   const scoredReport = JSON.parse(scoredReportJSON);
   const digestedReport = digest(prepData.digestTemplate, prepData.makeQuery, scoredReport);
   // Save it, digested.
-  await fs.writeFile(`${digestedDir}/${digestedReport.id}.html`, digestedReport);
-  console.log(`Report ${scoredReport.id} digested and saved in ${digestedDir}`);
+  await fs.writeFile(`${digestedDir}/${scoredReport.job.id}.html`, digestedReport);
+  console.log(`Digested report ${scoredReport.job.id} saved in ${digestedDir}`);
 };
 // Fulfills a digesting request.
 const callDigest = async (digestProcID, reportIDStart = '') => {
@@ -218,14 +196,14 @@ const callMultiDigest = async digestProcID => {
     console.log('ERROR: No raw report found');
   }
   console.log(
-    `Digesting completed. Digest proc: ${digestProcID}. Report count: ${prepData.scoredReportNames.length}. Directory: ${digestedDir}`
+    `Digesting completed. Digest proc: ${digestProcID}. Report count: ${prepData.scoredReportNames.length}. Directory: ${digestedDir}.`
   );
 };
 // Fulfills a comparison request.
 const callCompare = async (compareProcID, comparisonNameBase) => {
   await compare(compareProcID, comparisonNameBase);
   console.log(
-    `Comparison completed. Comparison proc: ${compareProcID}. Directory: ${comparisonDir}`
+    `Comparison completed. Comparison proc: ${compareProcID}. Directory: ${comparisonDir}.`
   );
 };
 
@@ -238,7 +216,7 @@ if (fn === 'aim' && fnArgs.length === 5) {
     console.log('Execution completed');
   });
 }
-else if (fn === 'merge' && fnArgs.length === 2) {
+else if (fn === 'merge' && fnArgs.length === 3) {
   callMerge(... fnArgs)
   .then(() => {
     console.log('Execution completed');

package/digest.js

@@ -20,6 +20,6 @@ exports.digest = (digestTemplate, digestProc, scoredReport) => {
   // Use it to replace the placeholders in the template.
   const digest = replaceHolders(digestTemplate, query);
   // Return the digest.
-  console.log(`Report ${scoredReport.id} digested`);
+  console.log(`Report ${scoredReport.job.id} digested`);
   return digest;
 };

package/merge.js

@@ -1,12 +1,13 @@
 /*
   merge.js
-  Merges a batch and a script to produce host-specific scripts.
+  Merges a batch and a script to produce jobs.
   Arguments:
     0. base of name of script located in process.env.SCRIPTDIR.
     1. base of name of batch located in process.env.BATCHDIR.
+    2. email address to be notified of completion.
   Usage example:
-    node merge tp18 weborgs
-  Note: The subdirectory for host-specific scripts will be created if it does not exist.
+    node merge tp25 weborgs developer@w3.org
+  Note: The subdirectory for jobs will be created if it does not exist.
 */
 
 // ########## IMPORTS
@@ -15,6 +16,8 @@
 require('dotenv').config();
 // Module to read and write files.
 const fs = require('fs/promises');
+// Module to aim a script at a host.
+const {aim} = require('./aim');
 
 // ########## CONSTANTS
 
@@ -24,46 +27,25 @@ const jobDir = process.env.JOBDIR || 'watch';
 
 // ########## FUNCTIONS
 
-// Returns a string representing the date and time.
-const nowString = () => (new Date()).toISOString().slice(0, 19);
-// Merges a batch into a script and writes host-specific scripts.
-exports.merge = async (scriptName, batchName) => {
+// Merges a batch into a script and writes jobs.
+exports.merge = async (scriptName, batchName, requester) => {
+  // Get the script and the batch.
   const scriptJSON = await fs.readFile(`${scriptDir}/${scriptName}.json`, 'utf8');
   const batchJSON = await fs.readFile(`${batchDir}/${batchName}.json`, 'utf8');
   const script = JSON.parse(scriptJSON);
   const batch = JSON.parse(batchJSON);
-  // Create the watch directory if it does not exist.
-  await fs.mkdir(jobDir, {recursive: true});
-  // Create a job-creation time stamp.
   const timeStamp = Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
+  // Create the job directory if it does not exist.
+  await fs.mkdir(jobDir, {recursive: true});
   // For each host in the batch:
   const {hosts} = batch;
-  const newScripts = hosts.map(host => {
-    // Copy the script.
-    const newScript = JSON.parse(JSON.stringify(script));
-    // In the copy, make all url commands visit the host.
-    newScript.commands.forEach(command => {
-      if (command.type === 'url') {
-        command.id = host.id;
-        command.which = host.which;
-        command.what = host.what;
-      }
-    });
-    // Add source information to the script.
-    newScript.sources = {
-      script: script.id,
-      batch: batch.id
-    }
-    // Add the job-creation time to the script.
-    newScript.jobCreationTime = nowString();
-    // Change the script ID to a job ID.
-    newScript.id = `${timeStamp}-${newScript.id}-${host.id}`;
-    // Return the host-specific script.
-    return newScript;
-  });
-  // Write the host-specific scripts.
-  for (const newScript of newScripts) {
-    await fs.writeFile(`${jobDir}/${newScript.id}.json`, JSON.stringify(newScript, null, 2));
+  for (const host of hosts) {
+    // Aim the script at the host.
+    const job = await aim(script, host, requester, timeStamp);
+    // Add the batch name to the job.
+    job.sources.batch = batchName;
+    // Save the job.
+    await fs.writeFile(`${jobDir}/${job.id}.json`, JSON.stringify(job, null, 2));
   };
-  console.log(`Merger completed. Script count: ${hosts.length}. Time stamp: ${timeStamp}`);
+  console.log(`Merger completed. Job count: ${hosts.length}. Time stamp ${timeStamp}.`);
 };

package/multiScore.js

@@ -14,6 +14,8 @@
 require('dotenv').config();
 // Module to read and write files.
 const fs = require('fs/promises');
+// Module to score reports.
+const {score} = require('./score');
 
 // ########## CONSTANTS
 
@@ -25,21 +27,22 @@ const scoreProcDir = process.env.SCOREPROCDIR || `${__dirname}/procs/score`;
 
 // Score the specified reports and return their count.
 exports.multiScore = async scoreProcID => {
+  // Get the score proc.
+  const {scorer} = require(`${scoreProcDir}/${scoreProcID}`);
   // Identify the reports to be scored.
   let reportFileNames = await fs.readdir(reportDirRaw);
   reportFileNames = reportFileNames.filter(fileName => fileName.endsWith('.json'));
   // For each of them:
-  const {scorer} = require(`${scoreProcDir}/${scoreProcID}`);
   for (const fileName of reportFileNames) {
     // Score it.
-    const reportJSON = await fs.readFile(`${reportDirRaw}/${fileName}`, 'utf8');
-    const report = JSON.parse(reportJSON);
-    await scorer(report);
-    report.scoreProcID = scoreProcID;
+    const rawReportJSON = await fs.readFile(`${reportDirRaw}/${fileName}`, 'utf8');
+    const rawReport = JSON.parse(rawReportJSON);
+    const scoredReport = await score(scorer, rawReport);
     // Write it to a file.
-    const scoredReportJSON = JSON.stringify(report, null, 2);
+    const scoredReportJSON = JSON.stringify(scoredReport, null, 2);
     await fs.writeFile(`${reportDirScored}/${fileName}`, `${scoredReportJSON}\n`);
-    console.log(`Report ${fileName.slice(0, -5)} scored and saved`);
   };
-  return reportFileNames.length;
+  console.log(
+    `Scored reports saved in ${reportDirScored}. Report count: ${reportFileNames.length}.`
+  );
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "7.0.5",
+  "version": "7.0.7",
   "description": "Client that scores and digests Testaro reports",
   "main": "aim.js",
   "scripts": {

package/score.js

@@ -9,11 +9,11 @@
 // ########## FUNCTIONS
 
 // Score the specified raw report and return it, scored.
-exports.score = async (scoreProc, rawReport) => {
+exports.score = async (scorer, rawReport) => {
   // Initialize a scored report.
   const scoredReport = JSON.parse(JSON.stringify(rawReport));
   // Score it.
-  await scoreProc(scoredReport);
+  await scorer(scoredReport);
   console.log(`Report ${rawReport.job.id} scored`);
   return scoredReport;
 };