BitvUnit is an open source accessibility testing library that makes it easy to automate accessibility checking for pages and applications that run in your browser. It integrates well with Selenium Webdriver and HtmlUnit and provides Hamcrest matchers.
BitvUnit is free, open source software licensed under the Apache License, Version 2.0.
BitvUnit is available from the Maven Central Repository. To include and use this library from your Maven project put the following dependency into the <dependencies/> section of your project pom.xml and you are already set up to get started:
<dependency>
<groupId>de.codescape.bitvunit</groupId>
<artifactId>bitvunit-core</artifactId>
<version>0.10.0</version>
<scope>test</scope>
</dependency>
Inside your test you can use the Hamcrest matcher to verify your website against the rules provided by the library or in combination with your own rules.
@Test
public void checkBitvUnitHomepageAgainstAllRules() {
HtmlPage pageUnderTest = new WebClient().getPage("http://bitvunit.codescape.de");
assertThat(pageUnderTest, is(compliantTo(new XmlRuleSet("/rulesets/all-rules.xml"))));
}
To learn about other ways of using BitvUnit have a look at the tests inside the bitvunit-samples project that are written to show other ways of testing against the rules of this library.
There are many ways to support this project. Here is an incomplete list of ways how to contribute:
- fork the project and contribute your code (e.g. new rules) with a pull request
- raise an issue for new rules or improvements of the library
- contact me and tell me about your experiences with the library
- write a blog post, send a tweet or promote this project
- use the library for your project and tell others about it
BitvUnit is open source and every kind of contribution is welcome!
Adding functionality, building the software or doing some housekeeping should be easy. So here is a list of common tasks and how to perform them:
To build the latest version of the library checkout the sources and run mvn clean install on your local machine. This will create and install the latest version of the library to your local maven repository.
To implement a new rule you can run the Groovy based wizard with the command groovy bitvunit.groovy create-rule from the root folder of the project. It prompts for your full name to be listed in the JavaDoc and the name for your new rule. Valid names must start with an uppercase letter, contain only characters and end with the word Rule.
After that you can choose from one of the existing rule categories and the wizard will set everything up. You are ready to implement the test cases and the rule itself!
Run mvn versions:display-dependency-updates to produce a list of all dependencies where a newer versions exists. Update POMs to use new dependency versions where accurate. Release candidates and milestone releases should be used carefully. After that run mvn verify to make sure everything works fine with the new versions of the dependencies.
To release a new version the the Central Maven Repository first run mvn clean verify and check that all test are running. After a successful build run mvn release:clean release:prepare and answer the prompts for release version (e.g.: 0.11), the SCM tag (e.g.: v0.11) and the development version (e.g.: 0.12-SNAPSHOT).
Verify the results and run mvn release:perform if everything is looking fine. The nexus-staging-maven-plugin will do the rest and close the release in the Sonatype OSSRH and synchronization to Maven Central will pick up the new version.
Any changes applied to the library should be documented in the changelog markdown document on the root level of the project. Please make sure to add all changes that are worth mentioning to the changelog.md file.