README.md

Selenium A11y

This is the UI test automation for Accessibility Testing of OSF. It uses Selenium WebDriver and Pytest to create tests and the axe-core test engine to evaluate accessibility rules.

Setting up

Prerequisites

You'll need the webdriver of your choice and Python3.

Installing a webdriver:

In order for Selenium to be able to control your local browser, you will need to install drivers for any browsers in which you desire to run these tests. Start with a driver such as GekoDriver (firefox) or ChromeDriver. (Note: IE is not supported. Safari is only partially supported -- running the tests in Safari is not recommended).

Go to any of the driver links above, install the applicable driver for your system, and move the executable into your PATH, e. g., place it in /usr/bin or /usr/local/bin.

Installing Python3:

For MacOSX users:

brew install python3

For Ubuntu users:

apt-get install python3

It is also suggested you use a virtual environment. After completing the installation of Python3, this can be done with the following commands:

pip install virtualenv
pip install virtualenvwrapper
mkvirtualenv --python=python3 selenium-a11y

Installing

Now you can install the requirements:

pip install -r requirements.txt

And you should be good to go!

Running tests

In order to run the whole test suite simply use pytest:

pytest

You can run specific test classes:

pytest tests/test_a11y_registries.py::TestSubmittedRegistrationPages

Or specific tests:

pytest tests/test_a11y_registries.py::TestSubmittedRegistrationPages::test_accessibility_files_list_page

You can even run tests using custom markers. For example, here's how to run all the accessibility tests for Ember pages:

pytest -m ember_page

Or, here's how to run all the accessibility tests for Legacy pages:

pytest -m legacy_page

There are also some helpful custom fixtures:

With "--write_files" you can turn off the default behavior of writing out the accessibility results to files in the "a11y_results" folder. For example:

pytest --write_files false

Also "--exclude_best_practice" allows you to ignore any accessibility rules that axe classifies as "Best Practice" amd only test with WCAG compliant rules. For example:

pytest --exclude_best_practice true

See the pytest documentation for more information on usage.