caiquecoelho/robot-axe-library

A RobotFramework Library wrapper for axe-selenium-python package. This library can help you catch any accessibility issue in your web page or app.

Robot Axe Library

This project is a RobotFramework Library wrapper for axe-selenium-python package. In this project we abstracted the entire library setup for use in robotframework and also implemented the entire interface for communicating with the AXE library allowing to define specific filters to look for accessibility issues in addition to allowing the necessary assertions on the test side, for your your test passes or fails depending on the configuration you want, allowing a maximum number of issues, excluding elements you don't want to analyze, and allowing you to define specific accessibility rules, levels, tags and impact.

How to install

pip install robot-axelibrary==0.1.8

How to use

*** Settings ***
Library     SeleniumLibrary
Library     RobotAxeLibrary

*** Test Cases ***
Default Check Pass

   Open Browser                        https://retrospective-twitter.web.app/  chrome
   Wait Until Page Contains            Faça o login com a sua conta do twitter
   Check for accessibility issues
   Should Not Exceed Maximum Issues    2

Keywords Documentation

Click Here

Glossary

• Violation: A violation is a type of accessibility problem, for example a color-contrast problem or a missing aria-label
• Issue: An issue is the occurrence of a violation in one element or more, for example we can get 2 issues from the type color-contrast and 1 from aria-label

Feature Request

If you have any feature request just open an issue describing your request or feel free with your feature! Any pull pull request are welcome!

Found an issue?

Register the issue here and wait for us to solve it as soon as possible. In addition, any contribution is welcome, so feel free to make a pull request if you want to solve any problem :happy:

License

MIT

Project Inspiration

robotframework-axelibrary by @adiralashiva8

robot-axe-library's Issues

Allow a max number of issues per element

Why
Sometimes we want to allow a maximum number of issues in a specific element

How
We should be able to pass a maximum number of issues in one or more specific elements in the keyword, and only return from the python code other elements with issues or the element passed if the total issues are greater than the maximum passed

Allow a max number of issues per violation

Why
Sometimes we want to allow a maximum number of issues per violation, for example, we should only get 2 buttons with a color contrast problem, if we get 3 we will return an error.

How
We should be able to pass a maximum number of issues allowed per violation in the keyword, and only return from the python code an error if the total of issues is greater than the maximum allowed

Filter issues by impact

Why
All violations have a type of impact. Sometimes we want to get only the serious or dangerous.

How
We should be able to pass the type of impact we want to get in the keyword, and only return from the python code the issues with the impact selected