testilo 5.0.0 → 6.0.0

package/aim.js

@@ -1,14 +1,6 @@
 /*
   aim.js
-  Returns a script aimed at a host.
-  Arguments:
-    0. base of name of script located in process.env.SCRIPTDIR.
-    1. ID of the host.
-    2. URL of the host.
-    3. Name of the host.
-    4. ID of the requester.
-  Usage example:
-    node aim tp18 w3c https://www.w3.org/ 'World Wide Web Consortium' 
+  Module for aiming a script at a host.
 */
 
 // ########## IMPORTS

package/compare.js

@@ -28,7 +28,7 @@ const comparisonNameBase = process.argv[3];
 const replaceHolders = (content, query) => content
 .replace(/__([a-zA-Z]+)__/g, (ph, qp) => query[qp]);
 // Creates and saves a web page containing a comparative table.
-const compare = async () => {
+exports.compare = async () => {
   const comparisonDirAbs = `${__dirname}/${comparisonDir}`;
   const {getQuery} = require(`./procs/compare/${compareProcID}/index`);
   const query = await getQuery();
@@ -37,7 +37,3 @@ const compare = async () => {
   await fs.writeFile(`${comparisonDirAbs}/${comparisonNameBase}.html`, page);
   console.log(`Page ${comparisonNameBase}.html created and saved`);
 };
-
-// ########## OPERATION
-
-compare();

package/digest.js

@@ -21,8 +21,6 @@ const fs = require('fs/promises');
 
 const reportDirScored = process.env.REPORTDIR_SCORED || 'reports/scored';
 const reportDirDigested = process.env.REPORTDIR_DIGESTED || 'reports/digested';
-const digesterID = process.argv[2];
-const reportIDStart = process.argv[3];
 
 // ########## FUNCTIONS
 
@@ -30,7 +28,7 @@ const reportIDStart = process.argv[3];
 const replaceHolders = (content, query) => content
 .replace(/__([a-zA-Z]+)__/g, (ph, qp) => query[qp]);
 // Creates digests.
-const digest = async () => {
+exports.digest = async (digesterID, reportIDStart) => {
   const reportDirScoredAbs = `${__dirname}/${reportDirScored}`;
   let reportFileNames = await fs.readdir(reportDirScoredAbs);
   reportFileNames = reportFileNames.filter(fileName => fileName.endsWith('.json'));
@@ -52,7 +50,3 @@ const digest = async () => {
     console.log(`Report ${fileNameBase} digested and saved`);
   };
 };
-
-// ########## OPERATION
-
-digest();

package/do.js

@@ -0,0 +1,94 @@
+/*
+  do.js
+  Invokes Testilo modules with arguments.
+  This is the universal module for use of Testilo from a command line.
+  Arguments:
+    0. function to execute.
+    1+. arguments to pass to the function.
+  Usage examples:
+    node do aim script454 https://www.w3c.org/ 'World Wide Web Consortium' w3c
+    node do merge script454 webOrgs
+    node do score sp25a (to score all reports in REPORTDIR_RAW)
+    node do score sp25a 8ep9f- (same, but only if names start with 8ep9f-)
+    node do digest dp25a (to digest all reports in REPORTDIR_SCORED)
+    node do digest dp25a 8ep9f- (same, but only if names start with 8ep9f-)
+    node do compare cp25a weborgs (to write weborgs.html, comparing all reports in REPORTDIR_SCORED)
+*/
+
+// ########## IMPORTS
+
+// Module to keep secrets.
+require('dotenv').config();
+// Function to process a script aiming.
+const {aim} = require('./aim');
+// Function to process a script-batch merger.
+const {merge} = require('./merge');
+// Function to score reports.
+const {score} = require('./score');
+// Function to digest reports.
+const {digest} = require('./digest');
+// Function to compare scores.
+const {compare} = require('./compare');
+
+// ########## CONSTANTS
+
+const watchDir = process.env.WATCHDIR;
+const rawDir = process.env.REPORTDIR_RAW;
+const scoredDir = process.env.REPORTDIR_SCORED;
+const digestedDir = process.env.REPORTDIR_DIGESTED;
+const comparisonDir = process.env.COMPARISONDIR;
+
+// ########## FUNCTIONS
+
+// Fulfills a high-level testing request.
+const doAim = async (scriptName, hostURL, hostName, hostID, notifyee) => {
+  await aim(
+    scriptName,
+    {
+      id: hostID,
+      which: hostURL,
+      what: hostName
+    }, 
+    notifyee
+  );
+  console.log(`Request for aiming ${scriptID}.json at ${hostName} completed`);
+};
+// Fulfills a merger request.
+const doMerge = async (scriptName, batchName) => {
+  await merge(scriptName, batchName);
+  console.log(`Batch ${batchName}.json merged into script ${scriptName} in ${watchDir}`);
+};
+// Fulfills a scoring request.
+const doScore = async (scoreProcID, reportIDStart) => {
+  const reportCount = await score(scoreProcID, reportIDStart);
+  console.log(
+    `Scoring completed. Score proc: ${scoreProcID}. Report count: ${reportCount}. Directory: ${scoredDir}`
+  );
+};
+// Starts a watch.
+const doWatch = async (isDirWatch, isForever, interval) => {
+  console.log(
+    `Starting a ${isForever ? 'repeating' : 'one-time'} ${isDirWatch ? 'directory' : 'network'} watch`
+  );
+  await cycle(isDirWatch, isForever, interval);
+  console.log('Watching ended');
+};
+
+// ########## OPERATION
+
+// Execute the requested function.
+if (fn === 'high' && fnArgs.length === 1) {
+  doHigh(fnArgs)
+  .then(() => {
+    console.log('Execution completed');
+  });
+}
+else if (fn === 'watch' && fnArgs.length === 3) {
+  doWatch(... fnArgs)
+  .then(() => {
+    console.log('Execution completed');
+  });
+}
+else {
+  console.log('ERROR: Invalid statement');
+}

package/merge.js

@@ -21,15 +21,17 @@ const fs = require('fs/promises');
 const scriptDir = process.env.SCRIPTDIR || 'scripts';
 const batchDir = process.env.BATCHDIR || 'batches';
 const watchDir = process.env.WATCHDIR || 'watch';
-const scriptName = process.argv[2];
-const batchName = process.argv[3];
 
 // ########## 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.
-const merge = async (script, batch) => {
+exports.merge = async (scriptName, batchName) => {
+  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(watchDir, {recursive: true});
   // Create a job-creation time stamp.
@@ -52,8 +54,6 @@ const merge = async (script, batch) => {
       script: script.id,
       batch: batch.id
     }
-    // Add a job-creation time stamp to the script.
-    newScript.timeStamp = timeStamp;
     // Add the job-creation time to the script.
     newScript.jobCreationTime = nowString();
     // Change the script id property to include the time stamp and the host ID.
@@ -67,15 +67,3 @@ const merge = async (script, batch) => {
   };
   console.log(`Merger completed. Script count: ${hosts.length}. Time stamp: ${timeStamp}`);
 };
-
-// ########## OPERATION
-
-fs.readFile(`${scriptDir}/${scriptName}.json`, 'utf8')
-.then(scriptFile => {
-  fs.readFile(`${batchDir}/${batchName}.json`, 'utf8')
-  .then(async batchFile => {
-    const script = JSON.parse(scriptFile);
-    const batch = JSON.parse(batchFile);
-    await merge(script, batch);
-  });
-});

package/package.json

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

package/score.js

@@ -21,13 +21,11 @@ const fs = require('fs/promises');
 
 const reportDirRaw = process.env.REPORTDIR_RAW || 'reports/raw';
 const reportDirScored = process.env.REPORTDIR_SCORED || 'reports/scored';
-const scoreProcID = process.argv[2];
-const reportIDStart = process.argv[3];
 
 // ########## FUNCTIONS
 
-// Score the specified reports.
-const score = async () => {
+// Score the specified reports and return their count.
+exports.score = async (scoreProcID, reportIDStart) => {
   // Identify the reports to be scored.
   const reportDirRawAbs = `${__dirname}/${reportDirRaw}`;
   let reportFileNames = await fs.readdir(reportDirRawAbs);
@@ -48,8 +46,5 @@ const score = async () => {
     await fs.writeFile(`${__dirname}/${reportDirScored}/${fileName}`, `${scoredReportJSON}\n`);
     console.log(`Report ${fileName.slice(0, -5)} scored and saved`);
   };
+  return reportFileNames.length;
 };
-
-// ########## OPERATION
-
-score();