testilo 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jonathan Pool
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# testilo
+Runner of Testaro tests
+
+## Introduction
+
+This application is designed to be installed on a Windows or Macintosh host and to operate as a runner of Testaro jobs.
+
+[Testaro](https://www.npmjs.com/package/testaro) is a dependency that performs digital accessibility tests on Web resources.
+
+## Dependencies
+
+The Testaro dependency has some dependencies in the @siteimprove scope that are Github Packages. In order to execute `npm install` successfully, you need the `.npmrc` file in your project directory with this content, unless an `.npmrc` file in your home directory or elsewhere provides the same content:
+
+```bash
+@siteimprove:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:username=abc
+//npm.pkg.github.com/:_authToken=def
+```
+
+In this content, replace `abc` with your Github username and `def` with a Github personal access token that has `read:packages` scope.
+
+## Operation
+
+### General
+
+Testilo orders a Testaro job by calling Testaro’s `handleRequest` function with an object argument. The argument has this structure:
+
+```javascript
+{
+  id,
+  script: {…},
+  log: [],
+  acts: []
+}
+```
+
+The `script` property has a Testaro script as its value. See the Testaro `README.md` file for documentation on scripts.
+
+If a script is represented as JSON in a file `scripts/scriptX.json`, you can incorporate it into the options object of a Testaro call by executing the statement
+
+```javascript
+node index scriptX
+```
+
+### Batches
+
+You may wish to have Testaro perform the same sequence of tests on multiple web pages. In that case, you can create a _batch_, with the following structure:
+
+```javascript
+{
+  what: 'Web leaders',
+  hosts: {
+    id: 'w3c',
+    which: 'https://www.w3.org/',
+    what: 'W3C'
+  },
+  {
+    id: 'wikimedia',
+    which: 'https://www.wikimedia.org/',
+    what: 'Wikimedia'
+  }
+}
+```
+
+With a batch, you can execute a single statement to call Testaro multiple times, one per host. On each call, Testilo takes one of the hosts in the batch and substitutes it for each host specified in a `url` command of the script. Testilo waits for each Testaro job to finish before calling the next Testaro job.
+
+If a batch is represented as a JSON file `batches/batchY.json`, you can use it to call a set of Testaro jobs with the statement
+
+```javascript
+node index scriptX batchY
+```
+
+Given that statement, Testilo replaces the hosts in the script with the first host in the batch and calls Testaro. When Testaro finishes performing that script, Testilo replaces the script hosts with the second batch host and calls Testaro again. And so on.
+
+### Reports
+
+When you execute a `node index …` statement, Testilo begins populating the object argument by giving its `id` property a value. If there is no batch, the value of that property is a string encoding the date and time when you executed the statement (e.g., `eh9q7r`). If there is a batch, the value is the same, except that it is suffixed with a hyphen-minus character followed by the `id` value of the host (e.g., `eh9q7r-wikimedia`).
+
+Testaro delivers its results by populating the `log` and `acts` arrays of the object argument. Testilo waits for Testaro to finish performing the script and then saves the object argument in JSON format as a file in the `reports` directory.
+
+## Configuration
+
+### `ibm` test
+
+Testaro can perform the `ibm` test. That test requires the `aceconfig.js` configuration file in the root directory of the Testilo project.

package/aceconfig.js

@@ -0,0 +1,6 @@
+module.exports = {
+  reportLevels: [
+    'violation',
+    'recommendation'
+  ]
+};

package/index.js

@@ -0,0 +1,87 @@
+/*
+  index.js
+  Testilo main script.
+*/
+
+// ########## IMPORTS
+
+// Module to perform tests.
+const {handleRequest} = require('testaro');
+const fs = require('fs').promises;
+
+// ########## FUNCTIONS
+
+// Converts a script to a batch-based array of scripts.
+const 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}`,
+      script: newScript
+    };
+    return spec;
+  });
+  return specs;
+};
+// Calls Testaro.
+const callTestaro = async (id, script) => {
+  const report = {
+    id,
+    log: [],
+    script,
+    acts: []
+  };
+  await handleRequest(report);
+  const reportJSON = JSON.stringify(report, null, 2);
+  await fs.writeFile(`reports/${id}.json`, reportJSON);
+};
+// Runs a job.
+const run = async () => {
+  const scriptName = process.argv[2];
+  const batchName = process.argv[3];
+  if (scriptName) {
+    try {
+      const scriptJSON = await fs.readFile(`scripts/${scriptName}.json`, 'utf8');
+      const script = JSON.parse(scriptJSON);
+      let batch = null;
+      // 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:
+      if (batchName) {
+        // Convert the script to a batch-based set of scripts.
+        const batchJSON = await fs.readFile(`batches/${batchName}.json`, 'utf8');
+        batch = JSON.parse(batchJSON);
+        const specs = batchify(script, batch, timeStamp);
+        // For each script:
+        while (specs.length) {
+          const spec = specs.shift();
+          const {id, script} = spec;
+          // Call Testaro on it and save the result with a host-suffixed ID.
+          await callTestaro(id, script);
+        }
+      }
+      // Otherwise, i.e. if there is no batch:
+      else {
+        // Call Testaro on the script and save the result with a timestamp ID.
+        await callTestaro(timeStamp, script);
+      }
+    }
+    catch(error) {
+      console.log(`ERROR: ${error.message}\n${error.stack}`);
+    }
+  }
+  else {
+    console.log('ERROR: no script specified');
+  }
+};
+
+// ########## OPERATION
+
+run();

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "testilo",
+  "version": "2.0.0",
+  "description": "Client that runs Testaro tests to fulfill Aorta jobs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jrpool/testilo"
+  },
+  "keywords": ["accessibility", "a11y", "testing"],
+  "author": "Jonathan Pool <pool@jpdev.pro>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jrpool/testilo/issues"
+  },
+  "homepage": "https://github.com/jrpool/testilo",
+  "dependencies": {
+    "testaro": "*"
+  },
+  "devDependencies": {
+    "eslint": "*"
+  }
+}