testaro 16.0.0 → 16.2.0

package/actSpecs.js

@@ -184,7 +184,7 @@ exports.actSpecs = {
       'Perform Testaro tests',
       {
         withItems: [true, 'boolean', '', 'itemize'],
-        args: [false, 'object', 'areArrays', 'extra args (object; property names are rule IDs and values are arrays of additional argument values ({autocomplete: [["first name", "forename", "given name"], ["last name", "surname", "family name"], ["email"]], buttonMenu: {[]}, focInd: [false, 250], hover: [20], motion: [2500, 2500, 5]} by default'],
+        args: [false, 'object', 'areArrays', 'extra args (object; property names are rule IDs and values are arrays of additional argument values ({autocomplete: [["first name", "forename", "given name"], ["last name", "surname", "family name"], ["email"]], buttonMenu: [], focInd: [false, 250], hover: [20]}) by default'],
       }
     ],
     wave: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "16.0.0",
+  "version": "16.2.0",
   "description": "Automation of accessibility testing",
   "main": "index.js",
   "scripts": {

package/procs/visChange.js

@@ -0,0 +1,112 @@
+/*
+  visChange
+  This procedure reports a change in the visible content of a page between two times, optionally
+  hovering over a locator-defined element immediately after the first time.
+  WARNING: This test uses the Playwright page.screenshot method, which produces incorrect results
+  when the browser type is chromium and is not implemented for the firefox browser type. The only
+  browser type usable with this test is webkit.
+*/
+
+// IMPORTS
+
+const pixelmatch = require('pixelmatch');
+const {PNG} = require('pngjs');
+
+// FUNCTIONS
+
+// Creates and returns a screenshot.
+const shoot = async (page, exclusion = null) => {
+  // Make a screenshot as a buffer.
+  const options = {
+    fullPage: true,
+    omitBackground: true,
+    timeout: 2000
+  };
+  if (exclusion) {
+    const exclusionText = await exclusion.textContent();
+    options.mask = [exclusion];
+  }
+  return await page.screenshot(options)
+  .catch(error => {
+    console.log(`ERROR: Screenshot failed (${error.message})`);
+    return '';
+  });
+};
+exports.visChange = async (page, options = {}) => {
+  const {delayBefore, delayBetween, exclusion} = options;
+  // Wait, if required.
+  if (delayBefore) {
+    await page.waitForTimeout(delayBefore);
+  }
+  // If an exclusion was specified:
+  if (exclusion) {
+    // Hover over the upper-left corner of the page for test isolation.
+    const docLoc = page.locator('html');
+    await docLoc.hover({
+      position: {
+        x: 0,
+        y: 0
+      }
+    });
+  }
+  // Make a screenshot, excluding an element if specified.
+  const shot0 = await shoot(page, exclusion);
+  // If it succeeded:
+  if (shot0.length) {
+    // If an exclusion was specified:
+    if (exclusion) {
+      // Hover over it.
+      try {
+        await exclusion.hover({
+          timeout: 500,
+          noWaitAfter: true
+        });
+      }
+      catch(error) {
+        return {
+          success: false,
+          error: 'Hovering failed'
+        };
+      }
+    }
+    // Wait as specified, or 3 seconds.
+    await page.waitForTimeout(delayBetween || 3000);
+    // Make another screenshot.
+    const shot1 = await shoot(page, exclusion);
+    // If it succeeded:
+    if (shot1.length) {
+      // Get the shots as PNG images.
+      const pngs = [shot0, shot1].map(shot => PNG.sync.read(shot));
+      // Get their dimensions.
+      const {width, height} = pngs[0];
+      // Get the count of differing pixels between the shots.
+      const pixelChanges = pixelmatch(pngs[0].data, pngs[1].data, null, width, height);
+      // Get the ratio of differing to all pixels as a percentage.
+      const changePercent = 100 * pixelChanges / (width * height);
+      // Return this.
+      return {
+        success: true,
+        width,
+        height,
+        pixelChanges,
+        changePercent
+      };
+    }
+    // Otherwise, i.e. if the second screenshot failed:
+    else {
+      // Return this.
+      return {
+        success: false,
+        error: 'Second screenshot failed'
+      };
+    }
+  }
+  // Otherwise, i.e. if the screenshot failed:
+  else {
+    // Return this.
+    return {
+      success: false,
+      error: 'First screenshot failed'
+    };
+  }
+};