axe-selenium-python 0.0.32

Python library to integrate axe and selenium for web accessibility testing.

axe-selenium-python integrates aXe and selenium to enable automated web accessibility testing.

Requirements

You will need the following prerequisites in order to use axe-selenium-python:

• Python 2.7 or 3.6

• pytest-selenium >= 3.0.0

• tox

• geckodriver downloaded and added to your PATH

Installation

To install axe-selenium-python:

$ pip install axe-selenium-python

To install pytest-axe:

$ pip install pytest-axe

Usage

To run tests using pytest-selenium (a dependency of axe-selenium-python), tests must be marked with the non-destructive pytest decorator:

@pytest.mark.nondestructive
def test_my_test_function():
  assert true

Test suites using axe-selenium-python must import pytest and the Axe class.

pytest-selenium relies on the base_url fixture, which can be set in a configuration file, or as a command line argument.

Configuration File

[pytest]
 base_url = http://www.example.com

Command Line Argument

$ pytest --base-url http://www.example.com

Example Test Function

test_accessibility.py

import pytest
import axe_selenium_python
import pytest_axe

@pytest.mark.nondestructive
def test_accessibility(self, axe):

  response = axe.execute()

  assert len(response['violations']) == 0, axe.report()

Tests not using the axe pytest fixture must use the selenium pytest fixture:

test_accessibility.py

import pytest
from axe_selenium_python import Axe

@pytest.mark.nondestructive
def test_accessibility(self, selenium):

  axe = Axe(selenium)
  response = axe.execute()

  assert len(response['violations']) == 0, axe.report()

Resources

• Issue Tracker

• Code

• pytest-axe

CHANGELOG

version 0.0.3

• Added run method to Axe class to simplify the usage in existing test suites

• run method includes the ability to set what impact level to test for: ‘minor’, ‘moderate’, ‘severe’, ‘critical’

version 0.0.276

• Added pytest-axe usage example to README

version 0.0.275

• Added usage example to README

version 0.0.273

• Added selenium instance as a class attribute

• Changed file paths to OS independent structure

• Fixed file read operations to use with keyword

version 0.0.21

• Fixed include of aXe API file and references to it

• Updated README