testaro 5.18.1 → 6.0.0

package/run.js

@@ -38,6 +38,7 @@ const tests = {
   docType: 'document without a doctype property',
   elements: 'data on specified elements',
   embAc: 'active elements embedded in links or buttons',
+  filter: 'filter styles on elements',
   focAll: 'focusable and Tab-focused elements',
   focInd: 'focus indicators',
   focOp: 'focusability and operability',
@@ -1548,7 +1549,7 @@ const injectLaunches = acts => {
   }
 };
 // Handles a request.
-exports.handleRequest = async report => {
+exports.doJob = async report => {
   // If the report object is valid:
   if(isValidReport(report)) {
     // Add a start time to the log.

package/{runHost.js → runScript.js}

@@ -1,25 +1,24 @@
 /*
-  runHost.js
-  Runs a host job and writes a report file.
+  runScript.js
+  Runs a script and writes a report file.
 */
 
 // ########## IMPORTS
 
-const {handleRequest} = require('./run');
+const {doJob} = require('./run');
 
 // ########## FUNCTIONS
 
-// Runs one script and sends the report to the parent.
-const runHost = async (id, scriptJSON, hostJSON) => {
+// Runs a script and returns the report.
+const runScript = async (id, scriptJSON) => {
   const report = {
     id,
-    host: JSON.parse(hostJSON),
     log: [],
     script: JSON.parse(scriptJSON),
     acts: []
   };
   let reportJSON = JSON.stringify(report, null, 2);
-  await handleRequest(report);
+  await doJob(report);
   report.acts.forEach(act => {
     try {
       JSON.stringify(act);
@@ -37,15 +36,13 @@ const runHost = async (id, scriptJSON, hostJSON) => {
   });
   try {
     reportJSON = JSON.stringify(report, null, 2);
+    return reportJSON;
   }
   catch(error) {
     console.log(`ERROR: report for host ${id} not JSON (${error.message})`);
+    return '';
   }
-  process.send(reportJSON, () => {
-    process.disconnect();
-    process.exit();
-  });
 };
 
 // ########## OPERATION
-runHost(... process.argv.slice(2));
+runScript(... process.argv.slice(2));

package/samples/{scripts/simple.json → simple.json}

@@ -2,6 +2,7 @@
   "id": "simple",
   "what": "Test example.com with bulk",
   "strict": true,
+  "timeLimit": 10,
   "commands": [
     {
       "type": "launch",

package/samples/{scripts/tp16.json → tp18.json}

@@ -1,6 +1,6 @@
 {
-  "id": "tp16",
-  "what": "Alfa, Axe, Continuum, HTML CodeSniffer, IBM, Nu Html Checker, Tenon, WAVE, and 19 custom tests",
+  "id": "tp18",
+  "what": "Alfa, Axe, Continuum, HTML CodeSniffer, IBM, Nu Html Checker, Tenon, WAVE, and 22 custom tests",
   "strict": true,
   "timeLimit": 500,
   "commands": [
@@ -11,7 +11,7 @@
     },
     {
       "type": "url",
-      "which": "https://*",
+      "which": "https://example.com/",
       "what": "any page"
     },
     {
@@ -35,7 +35,7 @@
     },
     {
       "type": "url",
-      "which": "https://*",
+      "which": "https://example.com/",
       "what": "any page"
     },
     {
@@ -59,6 +59,12 @@
       "withItems": true,
       "what": "active elements incorrectly embedded in each other"
     },
+    {
+      "type": "test",
+      "which": "filter",
+      "withItems": true,
+      "what": "filter styles"
+    },
     {
       "type": "test",
       "which": "focAll",

package/tests/filter.js

@@ -0,0 +1,47 @@
+/*
+  filter
+  This test reports elements whose styles include filter. The filter style property is considered
+  inherently inaccessible, because it modifies the rendering of content, overriding user settings,
+  and requires the user to apply custom styles to neutralize it, which is difficult or impossible
+  in some user environments.
+*/
+// Runs the test and returns the results.
+exports.reporter = async (page, withItems) => {
+  // Identify the elements with filter style properties.
+  const data = await page.evaluate(withItems => {
+    // Returns a space-minimized copy of a string.
+    const compact = string => string.replace(/[\t\n]/g, '').replace(/\s{2,}/g, ' ').trim();
+    // Get all elements in the body.
+    const elements = Array.from(document.body.querySelectorAll('*'));
+    // Get those that have filter styles.
+    const filterElements = elements.filter(element => {
+      const elementStyles = window.getComputedStyle(element);
+      return elementStyles.filter !== 'none';
+    });
+    const filterData = filterElements.map(element => ({
+      element,
+      impact: element.querySelectorAll('*').length
+    }));
+    // Initialize the result.
+    const data = {
+      totals: {
+        styledElements: filterElements.length,
+        impactedElements: filterData.reduce((total, current) => total + current.impact, 0)
+      }
+    };
+    // If itemization is required:
+    if (withItems) {
+      // Add it to the result.
+      data.items = [];
+      filterData.forEach(filterDatum => {
+        data.items.push({
+          tagName: filterDatum.element.tagName,
+          text: compact(filterDatum.element.textContent),
+          impact: filterDatum.impact
+        });
+      });
+    }
+    return data;
+  }, withItems);
+  return {result: data};
+};

package/tests/titledEl.js

@@ -11,8 +11,8 @@ exports.reporter = async (page, withItems) => {
       // FUNCTION DEFINITION START
       // Returns a space-minimized copy of a string.
       const compact = string => string
-      ? string.replace(/[\t\n]/g, '').replace(/\s{2,}/g, ' ').trim()
-      : '';
+        ? string.replace(/[\t\n]/g, '').replace(/\s{2,}/g, ' ').trim()
+        : '';
       // FUNCTION DEFINITION END
       return badTitleElements.map(element => ({
         tagName: element.tagName,

package/validation/executors/debug.js

@@ -2,7 +2,7 @@
 // Validator for Testaro tests.
 
 const fs = require('fs').promises;
-const {handleRequest} = require(`${__dirname}/../../run`);
+const {doJob} = require(`${__dirname}/../../run`);
 const validateTests = async () => {
   const totals = {
     attempts: 0,
@@ -18,7 +18,7 @@ const validateTests = async () => {
     const report = {script};
     report.log = [];
     report.acts = [];
-    await handleRequest(report);
+    await doJob(report);
     const {log, acts} = report;
     if (log.length === 2 && log[1].event === 'endTime' && /^\d{4}-.+$/.test(log[1].value)) {
       console.log('Success: Log has been correctly populated');

package/validation/executors/high.js

@@ -0,0 +1,57 @@
+// high.js
+// Validator for high-level invocation of Testaro.
+
+// ########## IMPORTS
+
+const fs = require('fs/promises');
+
+// ########## CONSTANTS
+
+const projectRoot = `${__dirname}/../..`;
+process.env.REPORTDIR = `${projectRoot}/temp`;
+const reportDir = process.env.REPORTDIR;
+process.env.SCRIPTDIR = `${projectRoot}/samples`;
+
+// ########## OPERATION
+
+// Run the simple script and write a report.
+const {runJob} = require(`${projectRoot}/high`);
+runJob('simple')
+.then(
+  // When the report has been written:
+  async () => {
+    // Open it.
+    const fileNames = await fs.readdir(reportDir);
+    const reportNames = fileNames.filter(name => name.endsWith('-simple.json'));
+    if (reportNames.length) {
+      try {
+        // Check its log and act lengths against expectations.
+        const reportJSON = await fs.readFile(`${reportDir}/${reportNames[0]}`);
+        const report = JSON.parse(reportJSON);
+        const {log, acts} = report;
+        if (log.length !== 2) {
+          console.log(
+            `Failure: log length is ${log.length} instead of 2 (see temp/${reportNames[0]}})`
+          );
+        }
+        else if (acts.length !== 3) {
+          console.log(
+            `Failure: acts length is ${acts.length} instead of 3 (see temp/${reportNames[0]}})`
+          );
+        }
+        else {
+          console.log(`Success (report is in temp/${reportNames[0]})`);
+        }
+      }
+      catch(error) {
+        console.log(`ERROR: ${error.message}`);
+      }
+    }
+    else {
+      console.log('ERROR: report not found');
+    }
+  },
+  error => {
+    console.log(`ERROR running script (${error.message})`);
+  }
+);

package/validation/executors/low.js

@@ -13,8 +13,8 @@ const validate = async () => {
     log: [],
     acts: []
   };
-  const {handleRequest} = require('../../run');
-  await handleRequest(report);
+  const {doJob} = require('../../run');
+  await doJob(report);
   const {log, acts} = report;
   if (log.length !== 2) {
     console.log(`Failure: log length is ${log.length} instead of 2`);

package/validation/executors/tenon.js

@@ -2,7 +2,7 @@
 // Test executor for tenon sample script.
 
 const fs = require('fs');
-const {handleRequest} = require('../../run');
+const {doJob} = require('../../run');
 const scriptJSON = fs.readFileSync('samples/scripts/tenon.json', 'utf8');
 const script = JSON.parse(scriptJSON);
 const report = {
@@ -12,7 +12,7 @@ const report = {
   acts: []
 };
 (async () => {
-  await handleRequest(report);
+  await doJob(report);
   console.log(`Report log:\n${JSON.stringify(report.log, null, 2)}\n`);
   console.log(`Report acts:\n${JSON.stringify(report.acts, null, 2)}`);
 })();

package/validation/executors/test.js

@@ -3,7 +3,7 @@
 // Execution example: node validation/executors/test focOp
 
 const fs = require('fs').promises;
-const {handleRequest} = require(`${__dirname}/../../run`);
+const {doJob} = require(`${__dirname}/../../run`);
 const test = process.argv[2];
 const validateTests = async () => {
   const scriptFileNames = await fs.readdir(`${__dirname}/../tests/scripts`);
@@ -16,7 +16,7 @@ const validateTests = async () => {
     const report = {script};
     report.log = [];
     report.acts = [];
-    await handleRequest(report);
+    await doJob(report);
     const {log, acts} = report;
     if (log.length === 2 && log[1].event === 'endTime' && /^\d{4}-.+$/.test(log[1].value)) {
       console.log('Success: Log has been correctly populated');

package/validation/executors/tests.js

@@ -2,7 +2,7 @@
 // Validator for Testaro tests.
 
 const fs = require('fs').promises;
-const {handleRequest} = require(`${__dirname}/../../run`);
+const {doJob} = require(`${__dirname}/../../run`);
 const validateTests = async () => {
   const totals = {
     attempts: 0,
@@ -18,7 +18,7 @@ const validateTests = async () => {
     const report = {script};
     report.log = [];
     report.acts = [];
-    await handleRequest(report);
+    await doJob(report);
     const {log, acts} = report;
     if (log.length === 2 && log[1].event === 'endTime' && /^\d{4}-.+$/.test(log[1].value)) {
       console.log('Success: Log has been correctly populated');

package/validation/tests/scripts/filter.json

@@ -0,0 +1,46 @@
+{
+  "what": "validation of filter test",
+  "strict": true,
+  "commands": [
+    {
+      "type": "launch",
+      "which": "chromium",
+      "what": "usual browser"
+    },
+    {
+      "type": "url",
+      "which": "__targets__/filter/good.html",
+      "what": "page with no filter styles"
+    },
+    {
+      "type": "test",
+      "which": "filter",
+      "what": "filter",
+      "withItems": true,
+      "expect": [
+        ["totals.styledElements", "=", 0],
+        ["totals.impactedElements", "=", 0]
+      ]
+    },
+    {
+      "type": "url",
+      "which": "__targets__/filter/bad.html",
+      "what": "page with filter styles"
+    },
+    {
+      "type": "test",
+      "which": "filter",
+      "what": "filter",
+      "withItems": true,
+      "expect": [
+        ["totals.styledElements", "=", 2],
+        ["totals.impactedElements", "=", 7],
+        ["items.0.tagName", "=", "MAIN"],
+        ["items.1.tagName", "=", "UL"],
+        ["items.1.text", "i", "Item"],
+        ["items.0.impact", "=", 5],
+        ["items.1.impact", "=", 2]
+      ]
+    }
+  ]
+}

package/validation/tests/scripts/zIndex.json

@@ -24,7 +24,7 @@
     {
       "type": "url",
       "which": "__targets__/zIndex/bad.html",
-      "what": "page with explicit z-index attributes roles"
+      "what": "page with explicit z-index attributes"
     },
     {
       "type": "test",

package/validation/tests/targets/filter/bad.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <title>Page with filter styles</title>
+    <meta name="description" content="tester">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <style>
+      main {
+        filter: blur(5px);
+      }
+      ul {
+        filter: opacity(20%);
+      }
+    </style>
+  </head>
+  <body>
+    <main>
+      <h1>Page with filter styles</h1>
+      <p>This is a paragraph.</p>
+      <ul>
+        <li>Item 1</li>
+        <li>Item 2</li>
+      </ul>
+    </main>
+  </body>
+</html>

package/validation/tests/targets/filter/good.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <title>Page without filter styles</title>
+    <meta name="description" content="tester">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+  </head>
+  <body>
+    <main>
+      <h1>Page without filter styles</h1>
+      <p>This is a paragraph.</p>
+      <ul>
+        <li>Item 1</li>
+        <li>Item 2</li>
+      </ul>
+    </main>
+  </body>
+</html>

package/watch.js

@@ -1,6 +1,6 @@
 /*
   watch.js
-  Watches for jobs and runs them.
+  Watches for a script and runs it.
 */
 
 // ########## IMPORTS
@@ -11,7 +11,7 @@ require('dotenv').config();
 // Module to read and write files.
 const fs = require('fs/promises');
 // Module to perform tests.
-const {handleRequest} = require('./run');
+const {doJob} = require('./run');
 // Module to convert a script and a batch to a batch-based array of scripts.
 const {batchify} = require('./batchify');
 
@@ -162,7 +162,7 @@ const runHost = async (jobID, timeStamp, id, script) => {
     script,
     acts: []
   };
-  await handleRequest(report);
+  await doJob(report);
   if (watchType === 'dir') {
     return await writeDirReport(report);
   }

package/batchify.js

@@ -1,25 +0,0 @@
-/*
-  batchify.js
-  Creates a set of scripts from a script and a batch.
-*/
-
-// Converts a script to a batch-based array of scripts.
-exports.batchify = (script, batch, timeStamp) => {
-  const {hosts} = batch;
-  const specs = hosts.map(host => {
-    const newScript = JSON.parse(JSON.stringify(script));
-    newScript.commands.forEach(command => {
-      if (command.type === 'url') {
-        command.which = host.which;
-        command.what = host.what;
-      }
-    });
-    const spec = {
-      id: `${timeStamp}-${host.id}`,
-      host,
-      script: newScript
-    };
-    return spec;
-  });
-  return specs;
-};

package/create.js

@@ -1,172 +0,0 @@
-/*
-  create.js
-  Creates and runs a file-based job and writes a report file.
-*/
-
-// ########## IMPORTS
-
-// Module to keep secrets.
-require('dotenv').config();
-// Module to read and write files.
-const fs = require('fs/promises');
-const {fork} = require('child_process');
-const {handleRequest} = require('./run');
-// Module to convert a script and a batch to a batch-based array of scripts.
-const {batchify} = require('./batchify');
-
-// ########## CONSTANTS
-
-const scriptDir = process.env.SCRIPTDIR;
-const batchDir = process.env.BATCHDIR;
-const reportDir = process.env.REPORTDIR;
-const successHosts = [];
-const crashHosts = [];
-const timeoutHosts = [];
-
-// ########## VARIABLES
-
-let healthy = true;
-// Set 5 minutes as a default time limit per host script.
-let timeLimit = 300;
-let reportCount = 0;
-let specCount = Infinity;
-
-// ########## FUNCTIONS
-
-// Runs one script with no batch and writes a report file.
-const runHost = async (id, script) => {
-  const report = {
-    id,
-    host: {},
-    log: [],
-    script,
-    acts: []
-  };
-  await handleRequest(report);
-  const reportJSON = JSON.stringify(report, null, 2);
-  await fs.writeFile(`${reportDir}/${id}.json`, reportJSON);
-};
-// Recursively runs host scripts.
-const runHosts = async (timeStamp, specs) => {
-  if (specs.length >= specCount) {
-    console.log(`ERROR: Tried to run again with host count ${specs.length}`);
-    return;
-  }
-  else {
-    specCount = specs.length;
-  }
-  // If any host scripts remain to be run and the process has not been interrupted:
-  if (specs.length && healthy) {
-    // Remove the first host script from the list.
-    const spec = specs.shift();
-    const {id, host, script} = spec;
-    // Fork a child process to run that host script.
-    const subprocess = fork(
-      'runHost', [id, JSON.stringify(script), JSON.stringify(host)],
-      {
-        detached: true,
-        stdio: [0, 1, 'ignore', 'ipc']
-      }
-    );
-    let runMoreTimer = null;
-    // Let it run until it ends or, if the script or default time limit expires:
-    const timer = setTimeout(async () => {
-      clearTimeout(timer);
-      // Record the host script as timed out.
-      timeoutHosts.push(id);
-      // Kill the child process.
-      subprocess.kill('SIGKILL');
-      console.log(`Script for host ${id} took more than ${timeLimit} seconds, so was killed`);
-      // Wait 10 seconds. Then:
-      runMoreTimer = setTimeout(async () => {
-        clearTimeout(runMoreTimer);
-        // If the timeout did not coincide with the termination of the script:
-        if (! (successHosts.includes(id) || crashHosts.includes(id))) {
-          // Run the remaining host scripts.
-          console.log('Continuing with the remaining host scripts');
-          await runHosts(timeStamp, specs);
-        }
-      }, 10000);
-    }, 1000 * (script.timeLimit || timeLimit));
-    // If the child process succeeds:
-    subprocess.on('message', async message => {
-      clearTimeout(runMoreTimer);
-      clearTimeout(timer);
-      // Save its report as a file.
-      await fs.writeFile(`${reportDir}/${id}.json`, message);
-      console.log(`Report ${id}.json saved in ${reportDir}`);
-      reportCount++;
-      successHosts.push(id);
-      // Run the remaining host scripts.
-      await runHosts(timeStamp, specs);
-    });
-    // If the child process ends:
-    subprocess.on('exit', async () => {
-      // Wait 5 seconds, then:
-      const postExitTimer = setTimeout(async () => {
-        clearTimeout(postExitTimer);
-        // If its end was not due to success or a timeout:
-        if (! (successHosts.includes(id) || timeoutHosts.includes(id))) {
-          clearTimeout(runMoreTimer);
-          clearTimeout(timer);
-          // Record the host as having crashed.
-          crashHosts.push(id);
-          console.log(`Script for host ${id} crashed`);
-          // Run the remaining host scripts.
-          await runHosts(timeStamp, specs);
-        }
-      }, 5000);
-    });
-  }
-  // Otherwise, i.e. if no more host scripts are to be run:
-  else {
-    // Report the metadata.
-    console.log(`Count of ${timeStamp}- reports saved in ${reportDir}: ${reportCount}`);
-    if (timeoutHosts.length) {
-      console.log(`Hosts timed out:\n${JSON.stringify(timeoutHosts, null, 2)}`);
-    }
-    if (crashHosts.length) {
-      console.log(`Hosts crashed:\n${JSON.stringify(crashHosts, null, 2)}`);
-    }
-    return '';
-  }
-};
-// Runs a file-based job and writes a report file for the script or each host.
-exports.runJob = async (scriptID, batchID) => {
-  process.on('SIGINT', () => {
-    console.log('ERROR: Terminal interrupted runJob');
-    healthy = false;
-  });
-  if (scriptID) {
-    try {
-      const scriptJSON = await fs.readFile(`${scriptDir}/${scriptID}.json`, 'utf8');
-      const script = JSON.parse(scriptJSON);
-      // Get the time limit of the script or, if none, set it to 5 minutes.
-      timeLimit = script.timeLimit || timeLimit;
-      // Identify the start time and a timestamp.
-      const timeStamp = Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
-      // If there is a batch:
-      let batch = null;
-      if (batchID) {
-        // Convert the script to a batch-based set of host scripts.
-        const batchJSON = await fs.readFile(`${batchDir}/${batchID}.json`, 'utf8');
-        batch = JSON.parse(batchJSON);
-        const specs = batchify(script, batch, timeStamp);
-        // Recursively run each host script and save the reports.
-        await runHosts(timeStamp, specs);
-      }
-      // Otherwise, i.e. if there is no batch:
-      else {
-        // Run the script and save the result with a timestamp ID.
-        await runHost(timeStamp, script);
-        console.log(`Report ${timeStamp}.json in ${process.env.REPORTDIR}`);
-      }
-    }
-    catch(error) {
-      console.log(`ERROR running job (${error.message})\n${error.stack}`);
-    }
-  }
-  else {
-    console.log('ERROR: no script specified');
-  }
-};

package/samples/batches/eurail.json

@@ -1,11 +0,0 @@
-{
-  "id": "eurail",
-  "what": "Eurail",
-  "hosts": [
-    {
-      "id": "eurail",
-      "which": "https://www.eurail.com/en",
-      "what": "Eurail"
-    }
-  ]
-}

package/samples/batches/railpass.json

@@ -1,11 +0,0 @@
-{
-  "id": "railpass",
-  "what": "Railpass",
-  "hosts": [
-    {
-      "id": "railpass",
-      "which": "https://www.railpass.com/",
-      "what": "Railpass"
-    }
-  ]
-}