testilo 7.1.1 → 9.0.0

package/validation/digest/validate.js

@@ -0,0 +1,64 @@
+/*
+  validate.js
+  Validates digest module.
+*/
+
+// ########## IMPORTS
+
+// Function to process files.
+const fs = require('fs/promises');
+// Function to digest reports.
+const {digest} = require('../../digest');
+// Digesting function.
+const {digester} = require('./digester');
+
+// ########## FUNCTIONS
+
+// Validates the digest module.
+const validate = async () => {
+  // Get the report.
+  const reportJSON = await fs.readFile(`${__dirname}/report.json`, 'utf8');
+  const scoredReport = JSON.parse(reportJSON);
+  // Get the digest template.
+  const digestTemplate = await fs.readFile(`${__dirname}/digest.html`, 'utf8');
+  // Perform the digesting.
+  const digests = digest(digestTemplate, digester, [scoredReport]);
+  // Validate the digest.
+  if (Array.isArray(digests) && digests.length === 1) {
+    console.log('Success: The count of digests is correct');
+  }
+  else {
+    console.log('ERROR: The digests are not an array of length 1');
+    return;
+  }
+  const digestedReport = digests[0];
+  if (typeof digestedReport === 'string') {
+    console.log('Success: Digesting left the digest a string');
+  }
+  else {
+    console.log('ERROR: Digesting changed the digest type');
+    return;
+  }
+  if (digestedReport.includes('<h2>Introduction</h2>')) {
+    console.log('Success: Digesting left the static template content unchanged');
+  }
+  else {
+    console.log('ERROR: Digesting changed the static template content');
+    return;
+  }
+  if (digestedReport.includes('the web page of Example')) {
+    console.log('Success: Digesting interpolated the target correctly');
+  }
+  else {
+    console.log('ERROR: Digesting did not interpolate the target correctly');
+    return;
+  }
+  if (digestedReport.includes('count of tests was 1')) {
+    console.log('Success: Digesting interpolated the score correctly');
+  }
+  else {
+    console.log('ERROR: Digesting did not interpolate the score correctly');
+    return;
+  }
+};
+validate();

package/validation/merge/batch.json

@@ -0,0 +1,43 @@
+{
+  "id": "batch",
+  "what": "merge validation",
+  "targets": [
+    {
+      "id": "example",
+      "what": "Example",
+      "acts": {
+        "main": [
+          {
+            "type": "launch"
+          },
+          {
+            "type": "url",
+            "which": "https://example.com",
+            "what": "example"
+          }
+        ]
+      }
+    },
+    {
+      "id": "accordionexample",
+      "what": "Example of expanded accordion",
+      "acts": {
+        "main": [
+          {
+            "type": "launch"
+          },
+          {
+            "type": "url",
+            "which": "https://www.w3.org/WAI/ARIA/apg/example-index/accordion/accordion",
+            "what": "Accordion Example"
+          },
+          {
+            "type": "button",
+            "which": "Billing Address",
+            "what": "expand accordion"
+          }
+        ]
+      }
+    }
+  ]
+}

package/validation/merge/script.json

@@ -0,0 +1,33 @@
+{
+  "id": "script",
+  "what": "merge validation",
+  "strict": false,
+  "timeLimit": 40,
+  "acts": [
+    {
+      "type": "placeholder",
+      "which": "main",
+      "launch": "webkit"
+    },
+    {
+      "type": "test",
+      "which": "continuum",
+      "what": "Continuum"
+    },
+    {
+      "type": "placeholder",
+      "which": "main",
+      "launch": "chromium"
+    },
+    {
+      "type": "test",
+      "which": "focAll",
+      "what": "Tab-focusability"
+    },
+    {
+      "type": "test",
+      "which": "bulk",
+      "what": "count of visible elements"
+    }
+  ]
+}

package/validation/merge/validate.js

@@ -0,0 +1,179 @@
+/*
+  validate.js
+  Validates merge module.
+*/
+
+// ########## IMPORTS
+
+// Function to process files.
+const fs = require('fs/promises');
+// Function to merge a batch and a script.
+const {merge} = require('../../merge');
+
+// ########## FUNCTIONS
+
+// Validates the merge module.
+const validate = async () => {
+  // Get the script and the batch.
+  const scriptJSON = await fs.readFile(`${__dirname}/script.json`, 'utf8');
+  const script = JSON.parse(scriptJSON);
+  const batchJSON = await fs.readFile(`${__dirname}/batch.json`);
+  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 jobArrays = [jobsNoIsolation, jobsYesIsolation];
+  // Validate the jobs.
+  if (jobsNoIsolation && jobsYesIsolation) {
+    console.log('Success: Both job arrays exist');
+  }
+  else {
+    console.log('ERROR: A job array does not exist');
+    return;
+  }
+  if (
+    jobArrays.every(array => [0, 1].every(jobIndex => Object.keys(array[jobIndex]).length === 8))
+  ) {
+    console.log('Success: Every job has 8 properties');
+  }
+  else {
+    console.log('ERROR: A job does not have 8 properties');
+    return;
+  }
+  if (jobArrays.every(array => [0, 1].every(
+    jobIndex => {
+      const job = array[jobIndex];
+      return job.id === `${job.timeStamp}-${job.sources.script}-${job.sources.target.id}`;
+    }
+  ))) {
+    console.log('Success: Every job has a correct ID');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct ID');
+    return;
+  }
+  if (jobArrays.every(array => [0, 1].every(jobIndex => array[jobIndex].what === script.what))) {
+    console.log('Success: Every job has a correct what property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct what property');
+    return;
+  }
+  if (jobArrays.every(array => [0, 1].every(jobIndex => array[jobIndex].strict === script.strict))) {
+    console.log('Success: Every job has a correct strict property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct strict property');
+    return;
+  }
+  if (jobArrays.every(
+    array => [0, 1].every(jobIndex => array[jobIndex].timeLimit === script.timeLimit)
+  )) {
+    console.log('Success: Every job has a correct timeLimit property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct timeLimit property');
+    return;
+  }
+  if (jobArrays.every(
+    array => [0, 1].every(jobIndex => array[jobIndex].sources.script === script.id)
+  )) {
+    console.log('Success: Every job has a correct sources.script property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct sources.script property');
+    return;
+  }
+  if (jobArrays.every(
+    array => [0, 1].every(jobIndex => array[jobIndex].sources.batch === batch.id)
+  )) {
+    console.log('Success: Every job has a correct sources.batch property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct sources.batch property');
+    return;
+  }
+  if (jobArrays.every(array => [0, 1].every(
+    jobIndex => array[jobIndex].sources.target.id === batch.targets[jobIndex].id
+  ))) {
+    console.log('Success: Every job has a correct sources.target.id property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct sources.target.id property');
+    return;
+  }
+  if (jobArrays.every(array => [0, 1].every(
+    jobIndex => array[jobIndex].sources.target.what === batch.targets[jobIndex].what
+  ))) {
+    console.log('Success: Every job has a correct sources.target.what property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct sources.target.what property');
+    return;
+  }
+  if (jobArrays.every(
+    array => [0, 1].every(jobIndex => array[jobIndex].sources.requester === requester)
+  )) {
+    console.log('Success: Every job has a correct sources.requester property');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct sources.requester property');
+    return;
+  }
+  if (jobArrays.every(array => [0, 1].every(
+    jobIndex => /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$/.test(array[jobIndex].creationTime)
+  ))) {
+    console.log('Success: Every job has a valid creationTime property');
+  }
+  else {
+    console.log('ERROR: A job does not have a valid creationTime property');
+    return;
+  }
+  if (
+    jobArrays[0][0].acts.length === 7
+    && jobArrays[0][1].acts.length === 9
+    && jobArrays[1][0].acts.length === 9
+    && jobArrays[1][1].acts.length === 12
+  ) {
+    console.log('Success: Every job has a correct act count');
+  }
+  else {
+    console.log('ERROR: A job does not have a correct act count');
+    return;
+  }
+  const job00Act0 = jobArrays[0][0].acts[0];
+  if (
+    job00Act0.type === 'launch'
+    && job00Act0.which === script.acts[0].launch
+  ) {
+    console.log('Success: Job 0 of array 0 has a correct act 0');
+  }
+  else {
+    console.log('ERROR: Job 0 of array 0 has an incorrect act 0');
+    return;
+  }
+  const job01Act3 = jobArrays[0][1].acts[3];
+  if (
+    job01Act3.type === 'test'
+    && job01Act3.which === 'continuum'
+  ) {
+    console.log('Success: Job 1 of array 0 has correct act 3 type and which properties');
+  }
+  else {
+    console.log('ERROR: Job 1 of array 0 has an incorrect act 3 type or which property');
+    return;
+  }
+  const job10Act7 = jobArrays[1][0].acts[7];
+  if (
+    job10Act7.type === 'url'
+    && job10Act7.what === 'example'
+  ) {
+    console.log('Success: Job 0 of array 1 has correct act 7 type and what properties');
+  }
+  else {
+    console.log('ERROR: Job 1 of array 0 has an incorrect act 7 type or what property');
+    return;
+  }
+};
+validate();

package/validation/score/report.json

@@ -0,0 +1,75 @@
+{
+  "id": "report",
+  "what": "Report for scoring validation",
+  "strict": true,
+  "timeLimit": 10,
+  "acts": [
+    {
+      "type": "launch",
+      "which": "chromium",
+      "what": "Chromium browser",
+      "startTime": 1662474496075,
+      "endTime": 1662474496453
+    },
+    {
+      "type": "url",
+      "which": "https://example.com",
+      "what": "Example of web page",
+      "startTime": 1662474496453,
+      "result": "https://example.com",
+      "endTime": 1662474501684
+    },
+    {
+      "type": "test",
+      "which": "bulk",
+      "what": "count of visible elements",
+      "startTime": 1662474501684,
+      "url": "https://example.com",
+      "result": {
+        "visibleElements": 100,
+        "success": true
+      },
+      "endTime": 1662474501866
+    }
+  ],
+  "sources": {
+    "script": "script",
+    "batch": "batch",
+    "target": {
+      "id": "example",
+      "what": "Example of web page"
+    },
+    "requester": "user@domain.tld"
+  },
+  "creationTime": "2023-11-20T15:50:27",
+  "timeStamp": "cc3pl",
+  "jobData": {
+    "log": [
+      {
+        "event": "startTime",
+        "value": "2022-09-06T14:27:55"
+      },
+      {
+        "event": "endTime",
+        "value": "2022-09-06T14:30:47"
+      }
+    ],
+    "timeStamp": "5lezg",
+    "testTimes": [
+      [
+        "bulk",
+        0
+      ]
+    ],
+    "logCount": 10,
+    "logSize": 100,
+    "errorLogCount": 1,
+    "errorLogSize": 10,
+    "prohibitedCount": 0,
+    "visitTimeoutCount": 0,
+    "visitRejectionCount": 0,
+    "visitLatency": 3,
+    "endTime": "2022-09-06T14:30:47",
+    "elapsedSeconds": 5
+  }
+}

package/validation/score/scorer.js

@@ -0,0 +1,17 @@
+/*
+  scorer
+  score validation
+*/
+
+// Scores a report.
+exports.scorer = report => {
+  // If there are any acts in the report:
+  const {acts} = report;
+  if (Array.isArray(acts)) {
+    // Add a score, consisting of the test count.
+    const testActs = acts.filter(act => act.type === 'test');
+    report.score = {
+      testCount: testActs.length
+    };
+  }
+};

package/validation/score/validate.js

@@ -0,0 +1,62 @@
+/*
+  validate.js
+  Validates score module.
+*/
+
+// ########## IMPORTS
+
+// Function to process files.
+const fs = require('fs/promises');
+// Function to score reports.
+const {score} = require('../../score');
+// Scoring function.
+const {scorer} = require('./scorer');
+
+// ########## FUNCTIONS
+
+// Validates the score module.
+const validate = async () => {
+  // Get the report.
+  const reportJSON = await fs.readFile(`${__dirname}/report.json`, 'utf8');
+  const rawReport = JSON.parse(reportJSON);
+  // Perform the scoring.
+  const scoredReports = score(scorer, [rawReport]);
+  // Validate the scored report.
+  if (Array.isArray(scoredReports) && scoredReports.length === 1) {
+    console.log('Success: The count of scored reports is correct');
+  }
+  else {
+    console.log('ERROR: The scored reports are not an array of length 1');
+    return;
+  }
+  const report = scoredReports[0];
+  if (report.timeLimit === 10) {
+    console.log('Success: Scoring left the time limit unchanged');
+  }
+  else {
+    console.log('ERROR: Scoring changed or deleted the time limit');
+    return;
+  }
+  if (report.acts && Array.isArray(report.acts) && report.acts.length === 3) {
+    console.log('Success: Scoring left the act count unchanged');
+  }
+  else {
+    console.log('ERROR: Scoring changed the act count or deleted or retyped the acts');
+    return;
+  }
+  if (report.acts[2].result && report.acts[2].result.visibleElements === 100) {
+    console.log('Success: Scoring left the bulk test result unchanged');
+  }
+  else {
+    console.log('ERROR: Scoring changed the bulk test result');
+    return;
+  }
+  if (report.score && report.score.testCount === 1) {
+    console.log('Success: The score was correctly added to the report');
+  }
+  else {
+    console.log('ERROR: The score was not correctly added to the report');
+    return;
+  }
+};
+validate();

package/aim.js

@@ -1,45 +0,0 @@
-/*
-  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
-
-// 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, 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.
-  job.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.
-  job.sources = {
-    script: script.id,
-    batch: '',
-    host,
-    requester
-  }
-  // 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.
-  job.jobCreationTime = nowString();
-  // Add the time stamp to the job.
-  job.timeStamp = timeStamp;
-  // Return the job.
-  return job;
-};

package/multiDigest.js

@@ -1,51 +0,0 @@
-/*
-  multiDigest.js
-  Creates digests from scored reports.
-  Reads all reports in process.env.REPORTDIR_SCORED and outputs them, digested, into
-  process.env.REPORTDIR_DIGESTED.
-  Argument:
-    0. Base of name of digest proc located in process.env.DIGESTPROCDIR.
-  Usage example: node digest dp25a
-*/
-
-// ########## IMPORTS
-
-// Module to keep secrets.
-require('dotenv').config();
-// Module to read and write files.
-const fs = require('fs/promises');
-
-// ########## CONSTANTS
-
-const reportDirScored = process.env.REPORTDIR_SCORED || 'reports/scored';
-const reportDirDigested = process.env.REPORTDIR_DIGESTED || 'reports/digested';
-const digestProcDir = process.env.DIGESTPROCDIR || `${__dirname}/procs/digest`;
-
-// ########## FUNCTIONS
-
-// Replaces the placeholders in content with eponymous query parameters.
-const replaceHolders = (content, query) => content
-.replace(/__([a-zA-Z]+)__/g, (ph, qp) => query[qp]);
-// Creates digests.
-exports.multiDigest = async (digesterID, reportIDStart) => {
-  // Identify the reports to be digested.
-  let reportFileNames = await fs.readdir(reportDirScored);
-  reportFileNames = reportFileNames.filter(fileName => fileName.endsWith('.json'));
-  // For each report:
-  const {makeQuery} = require(`${digestProcDir}/${digesterID}/index.js`);
-  for (const fileName of reportFileNames) {
-    const reportJSON = await fs.readFile(`${reportDirScored}/${fileName}`, 'utf8');
-    const report = JSON.parse(reportJSON);
-    // Define its replacements for the placeholders in the digest template.
-    const query = {};
-    makeQuery(report, query);
-    // Replace the placeholders.
-    const template = await fs.readFile(`${digestProcDir}/${digesterID}/index.html`, 'utf8');
-    const digest = replaceHolders(template, query);
-    // Write its digest.
-    const fileNameBase = fileName.slice(0, -5);
-    await fs.writeFile(`${reportDirDigested}/${fileNameBase}.html`, digest);
-    console.log(`Report ${fileNameBase} digested and saved`);
-  };
-  return reportFileNames.length;
-};

package/multiScore.js

@@ -1,48 +0,0 @@
-/*
-  multiScore.js
-  Scores multiple Testaro reports.
-  Reads all reports in process.env.REPORTDIR_RAW and outputs them, scored, into
-  process.env.REPORTDIR_SCORED.
-  Arguments:
-    0. Base of name of score proc located in process.env.SCOREPROCDIR.
-  Usage example: node score sp18a
-*/
-
-// ########## IMPORTS
-
-// Module to keep secrets.
-require('dotenv').config();
-// Module to read and write files.
-const fs = require('fs/promises');
-// Module to score reports.
-const {score} = require('./score');
-
-// ########## CONSTANTS
-
-const reportDirRaw = process.env.REPORTDIR_RAW || 'reports/raw';
-const reportDirScored = process.env.REPORTDIR_SCORED || 'reports/scored';
-const scoreProcDir = process.env.SCOREPROCDIR || `${__dirname}/procs/score`;
-
-// ########## FUNCTIONS
-
-// 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:
-  for (const fileName of reportFileNames) {
-    // Score it.
-    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(scoredReport, null, 2);
-    await fs.writeFile(`${reportDirScored}/${fileName}`, `${scoredReportJSON}\n`);
-  };
-  console.log(
-    `Scored reports saved in ${reportDirScored}. Report count: ${reportFileNames.length}.`
-  );
-};