Miss any of our Open RFC calls?Watch the recordings here! »

intern-a11y

0.1.2 • Public • Published

intern-a11y

Accessibility testing for Intern

How it works

Accessibility testing works by having a scanner check a page or page fragment for rule violations. The most commonly used rules are defined in the W3C's Web Content Accessibility Guidelines (WCAG) and the GSA's Section 508 Standards. There are twelve general WCAG guidelines at three levels of success criteria: A, AA, and AAA. Scanners can check for violations at any of the levels, and can typically be configured to only check a subset of rules.

intern-a11y is an addon for Intern that lets users write tests targeting various accessibility testing systems. Currently it supports two scanners, aXe and Tenon. aXe is a JavaScript application that must be injected into the page being tested. The application is configured and executed, returning a report describing the test results. Tenon is a cloud-based testing service; a user requests that the service test a particular URL or page source, and the service returns a report of the results.

Both scanners are able to test entire pages and document fragments (or portions of a full page). In all cases, though, the scanners operate on a fully styled DOM. This means that if a user needs to test a single commponent in isolation, they'll need to create a test page with all the styles and supporting code required by the component, and use that page to run accessibility tests on the component.

Note that because aXe must be injected into a loaded page, it must be used with Intern's WebDriver test runner (intern-runner). Tenon makes HTTP calls to an external service, and it will work with the Node test client (intern-client) or intern-runner.

Installation

The intern-a11y module should be installed as a peer of Intern.

$ npm install intern
$ npm install intern-a11y

Getting started

Using either the aXe or Tenon modules is straightforward. The service modules can be accessed from the services property on the intern-a11y module.

import { services } from 'intern-a11y';
const axe = services.axe;

or

var axe = require('intern-a11y').services.axe;

The simplest Tenon test looks like:

'check accessibility': function () {
    return tenon.check({
        source: 'http://mypage.com'
    });
}

Similarly, the simplest aXe test looks like:

'check accessibility': function () {
    return aXe.check({
        // aXe tests must be run in functional test suites
        remote: this.remote,
        source: require.toUrl('../data/page.html')
    });
}

aXe may also be used inline in a Leadfoot Command chain:

'check accessibility': function () {
    return this.remote
        .get(require.toUrl('../data/page.html'))
        .then(aXe.createChecker());
}

In all cases, the check is asynchronous and Promise-based. If the check fails (i.e., accessibility violations are detected), the returned Promise is rejected.

Examples

The repository contains two example projects that use intern-a11y, one written in JavaScript and one written in TypeScript.

JavaScript

  1. cd into examples/js
  2. Run npm install
  3. Run TENON_API_KEY=<your key> npm test and/or npm test runner

TypeScript

  1. cd into examples/ts
  2. Run npm install
  3. Run npm run build
  4. Run TENON_API_KEY=<your key> npm test and/or npm test runner

API

Importing the intern-a11y module will return an object with tenon and axe properties.

axe

The aXe checker must be injected into the page being analyzed, and therefore can only be used in functional test suites. These must be run using Intern's WebDriver runner, intern-runner (or intern run -w with intern-cli). The aXe checker provides two functions, check and createChecker.

check

The check function performs an accessibility analysis on a given URL using a given Command object (typically this.remote).

check({
    /** LeadFoot Command object */
    remote: Command<any>,
 
    /** URL to load for testing */
    source: string,
 
    /** Number of milliseconds to wait before starting test */
    waitFor?: number,
 
    /** A selector to confine analysis to */
    context?: string 
 
    /** aXe-specific configuration */
    config?: Object,
})Promise<AxeResults>

The two required parameters are remote and source. remote is a Leadfoot Command object, generally this.remote in a test. source is the URL that will be analyzed.

There are three optional parameters. waitFor is a number of milliseconds to wait after a page has loaded before starting the accessibility analysis. context is a CSS selector (ID or class name) that can be used to confine analysis to a specific part of a page. The config paramter contains aXe configuration options.

createChecker

The createChecker function returns a Leadfoot Command helper (a then callback). It assumes that a page has already been loaded and is ready to be tested, so it doesn't need a source or Command object.

createChecker({
    /** aXe-specific configuration */
    config?: Object,
 
    /** aXe plugin definitions */
    plugins?: Object 
})Function

tenon

The Tenon checker works by making requests to a remote cloud service. It can be used in functional or unit test suites. When used in unit test suites, the Tenon checker must be used with Intern's Node client, intern-client (or intern run with intern-cli).

check

The tenon check function works the same way as the axe module's, and takes a similar argument object.

check({
    /** An external URL, file name, or a data string */
    source: string,
 
    /** tenon.io API key */
    apiKey?: string,
 
    /** Number of milliseconds to wait before starting test */
    waitFor?: number,
 
    /** Tenon configuration options */
    config?: TenonConfig 
})Promise<TenonResults>

A11yReporter

The A11yReporter class is an Intern reporter that will write test failure detail reports to a file or directory. The check methods will fail if accessibility failures are present, regardless of whether the A11yReporter reporter is in use. This reporter simply outputs more detailed information for any failures that are detected.

The reporter is configured in the same way as other Intern reporters, via a reporter configuration object in the intern Test config:

reporters: [
    {
        id: 'intern/dojo/node!intern-a11y/src/A11yReporter',
 
        // If this is a filename, all failures will be written to the given
        // file. If it's a directory name (no extension), each test failure
        // report will be written to an individual file in the given directory.
        filename: 'somereport.html'
    }
]

The A11yReporter class also exposes a writeReport static method. This method allows accessibility test results to be explicitly written to a file rather than relying on the reporter:

return axe.check({ ... })
    .catch(function (error) {
        var results = axe.toA11yResults(error.results);
        return A11yReporter.writeReport('some_file.html', results);
    })

Development

First, clone this repo. Then:

$ npm install
$ npm run build

Output will be generated in the build/ directory. To clean up, run

$ npm run clean

To really clean things up, run

$ npm run clean all

This will remove everything that's not tracked by git, with the exception of tests/intern-local.ts.

To run tests:

$ npm test [mode] [arg [arg [...]]]

The optional mode argument can be 'node', 'webdriver', 'all', or 'local'. The default is node. The first three modes correspond directly to Intern test runners ("node" = "client", "webdriver" = "runner", or both) and use the tests/intern config. local mode will run both the node and WebDriver tests using a tests/intern-local config if one is present. You can also provide standard Intern arguments like 'grep=xyz'.

When using node or when not specifying a mode, you must provide a Tenon API key to be able to run the Tenon tests.

$ TENON_API_KEY=<your key> npm test

License

Intern-a11y is offered under the New BSD license.

© SitePen, Inc. and its contributors

Install

npm i intern-a11y

DownloadsWeekly Downloads

20

Version

0.1.2

License

BSD-3-Clause

Last publish

Collaborators

  • avatar
  • avatar