A tool to search for specification violations. Requires Python 3.
Usage:
$ python3 -m venv conform
$ source conform/bin/activate
(conform) $ pip install -e . -r requirements.txt
(conform) $ openregister-conformance --api-version version-number --register register-name https://{register-name}.register.gov.uk
Example of running tests against localhost:
openregister-conformance --no-https --register country --register-domain openregister.local:8080 --api-version 1 http://localhost:8080/v1/
The api-version option should be set to the version of the specification you want to test against. For example, to test against version 2, run:
openregister-conformance --no-https --register country --register-domain openregister.org:8080 --api-version 2 http://localhost:8080/next/
There may be tests for future work that has not been implemented yet.
These are marked with xfail annotations. The
openregister-conformance script currently runs these tests but does
not worry if they fail. To force these tests to run, run them with
py.test using the --runxfail parameter:
py.test --runxfail --endpoint 'http://localhost:8080' --api-version 1 --register school --register-domain 'openregister.org:8080' -m 'not https'
Note that passing all of the tests does not guarantee that you have a fully-conformant implementation.
Unless stated otherwise, this codebase is released under the MIT license.