npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

assistive-webdriver

v0.1.1

Published

Assistive-Webdriver is a tool to automate end-to-end web application tests with a screen reader.

Downloads

79

Readme

Assistive-Webdriver

npm

Presentation

This package contains the implementation of a webdriver server that allows testing web applications with a screen reader (such as NVDA or JAWS) and checking that the screen reader says what is expected.

This requires two main features that are not natively supported by webdriver:

  • being able to send keystrokes at a low level so that the screen reader can receive them. This is achieved by using either Virtual Box or QEMU and sending low level events with their API.
  • being able to capture the text read by the screen reader. This is achieved by using text-to-socket-engine and tcp-web-listener inside the virtual machine.

When a client connects to create a session, the server clones and starts the virtual machine specified in the capabilities.

Then all requests linked to that session are forwarded to the selenium server that is supposed to be running inside the virtual machine that was started for that session.

When the session is destroyed the server stops and destroys the virtual machine.

Here is a schema describing the architecture of Assistive-Webdriver:

Architecture of Assistive-Webdriver

Getting started

  • Make sure you have the following software installed on the host machine:

  • Make sure you have a VirtualBox or QEMU virtual machine properly configured. To configure the virtual machine, you can follow this step-by-step guide. The virtual machine should be configured with:

  • Install Assistive-Webdriver globally:

npm install -g assistive-webdriver
  • Create a configuration file which, for example, describes how to create a VM with the jaws configuration:
{
  "jaws": {
    "vmSettings": {
      "type": "virtualbox",
      "vm": "VMNameInVirtualBox",
      "snapshot": "SeleniumJaws"
    },
    "screenReader": true
  }
}

There can be multiple virtual machine configurations. All configuration options are documented here.

  • Start the server, referencing the previous configuration file:
assistive-webdriver --vm-configs myConfigFile.json
  • In another console, start vboxwebsrv (without authentication):
vboxwebsrv --authentication null
  • Look at the samples in the samples directory.

  • Create or adapt a test and start it. Do not forget to make sure the name of the configuration (here, it is jaws) is correctly specified in the test (with the awd:vm-config capability).

node ariatemplates.js

The ariatemplates.js test checks that the Aria Templates datepicker works as expected with Jaws and Internet Explorer.

The API documentation is available here