testaro 46.2.2 → 47.0.0

package/README.md

@@ -520,11 +520,11 @@ The `wax` tool imposes a limit on the size of a page to be tested. If the page e
 
 #### WAVE
 
-If a `wave` test act is included in the job, an environment variable named `WAVE_KEY` must exist, with your WAVE API key as its value. You can get it from [WebAIM](https://wave.webaim.org/api/).
+If a `wave` test act is included in the job, the WAVE tests will be performed either by the subscription API or by the stand-alone API.
 
-The `wave` API does not accept a transmitted document for testing. WAVE must be given only a URL, which it then visits to perform its tests. Therefore, you cannot manipulate a page and then have WAVE test it, or ask WAVE to test a page that cannot be reached directly with a URL.
+If you want the subscription API to perform the tests, you must get a WAVE API key from [WebAIM](https://wave.webaim.org/api/) and assign it as the value of an environment variable named `WAVE_KEY`. The subscription API does not accept a transmitted document for testing. WAVE must be given only a URL, which it then visits to perform its tests. Therefore, you cannot manipulate a page and then have WAVE test it, or ask WAVE to test a page that cannot be reached directly with a URL.
 
-This limitation of WAVE may be overcome in a future version of Testaro by means of the invocation of the WAVE Chrome extension with Playwright.
+If you want the stand-alone API to perform the tests, you need to have that API installed and running, and the `wave` test act needs to define the URL of your stand-alone API. The test act can also define a `prescript` script and/or a `postscript` script.
 
 ### Browser types
 

package/actSpecs.js

@@ -205,7 +205,10 @@ exports.actSpecs = {
     wave: [
       'Perform WAVE tests',
       {
-        reportType: [true, 'number', '', 'WAVE report type (1, 2, 3, or 4)']
+        reportType: [true, 'number', '', 'WAVE report type (1, 2, 3, or 4)'],
+        url: [false, 'isURL', '', 'URL of stand-alone WAVE API'],
+        prescript: [false, 'string', '', 'content of pre-load script, if any'],
+        postscript: [false, 'string', '', 'content of post-load script, if any']
       }
     ]
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "46.2.2",
+  "version": "47.0.0",
   "description": "Run 1000 web accessibility tests from 10 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/tests/wave.js

@@ -23,8 +23,7 @@
 /*
   wave
   This test implements the WebAIM WAVE ruleset for accessibility. The 'reportType' argument
-  specifies a WAVE report type: 1, 2, 3, or 4. The larger the number, the more detailed (and
-  expensive) the report.
+  specifies a WAVE report type: 1, 2, 3, or 4.
 */
 
 // CONSTANTS
@@ -37,8 +36,29 @@ const https = require('https');
 // Conducts and reports the WAVE tests.
 exports.reporter = async (page, report, actIndex) => {
   const act = report.acts[actIndex];
-  const {reportType, rules} = act;
+  const {reportType, url, prescript, postscript, rules} = act;
   const waveKey = process.env.WAVE_KEY;
+  const waveKeyParam = waveKey ? `key=${waveKey}` : '';
+  let host = 'wave.webaim.org';
+  let scheme = 'https';
+  if (url && url.startsWith('http')) {
+    if (url.startsWith('http://')) {
+      scheme = 'http';
+    }
+    host = url.replace(/^https?:\/\//, '');
+  }
+  let prescriptParam = prescript ? `prescript=${prescript}` : '';
+  let postscriptParam = postscript ? `postscript=${postscript}` : '';
+  const wavePath = '/api/request';
+  const queryParams = [
+    waveKeyParam,
+    `url=${page.url()}`,
+    `reporttype=${reportType}`,
+    prescriptParam,
+    postscriptParam
+  ];
+  const query = queryParams.filter(param => param).join('&');
+  const path = [wavePath, query].join('?');
   // Initialize the results.
   const data = {};
   let result = {};
@@ -47,8 +67,8 @@ exports.reporter = async (page, report, actIndex) => {
       // Get the test results.
       https.get(
         {
-          host: 'wave.webaim.org',
-          path: `/api/request?key=${waveKey}&url=${page.url()}&reporttype=${reportType}`
+          host,
+          path
         },
         response => {
           let rawReport = '';
@@ -113,7 +133,6 @@ exports.reporter = async (page, report, actIndex) => {
             }
             catch(error) {
               console.log(`ERROR parsing tool report: ${error.message}`);
-              console.log(`rawReport: ${rawReport}`);
               data.prevented = true;
               data.error = error.message;
               resolve(result);