Active Development. This product is in active development; breaking changes as well as major refactors should be expected. As with all software, make sure the project works for you before using it.
Verification Report Generation for Clinical and Non-Clinical Systems.
Verification Reporter is a testing framework that can test a web-based system programmatically and output a report for inclusion in validation documentation. The purpose of Verification Reporter is to help automate the validation process encountered in clinical systems, especially regressive validations. Verification Reporter can reduce the time it takes for groups with regulatory requirements to introduce new software versions into their pipelines/workflows.
Verification Reporter is a Docker-based project that uses test scenarios to based in cucumberjs and nightwatch (with the great library nightwatch-cucumber) to produce an html report.
To use Verification Reporter, you should first be familiar with [Docker] (https://www.docker.com/).
- Clone the application:
> git clone https://github.com/CodeBiosys/verification-reporter
> cd verification-reporter
- Provision a new Docker machine called
verification-reporter:
> docker-machine create -d virtualbox verification-reporter
> eval $(docker-machine env verification-reporter)
> docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM DOCKER ERRORS
verification-reporter * virtualbox Running tcp://192.168.99.100:2376 v17.06.0-ce
Note the asterisk in the "ACTIVE" column.
- Update the docker-compose.yml: Either use the docker-compose.yml example included, or update your own docker-compose to include a selenium_hub, and the verify service. Selenium details [https://hub.docker.com/r/selenium/hub/]
You will need to make the following updates to the docker-compose file. Environment variables:
-
TEST_URL=http://www
Test url needs to point to the system under test. You can use a docker internal url, or an external url that you control. Using automated test frameworks on sites you do not own is considered bad form.
Volumes:
-
./example:/app/custom The following directories are expected to be mapped by Docker to /app/custom:
-
./features
The Gherkin features to test your application
-
./pages
Where [nightwatch page objects (https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API) are located which can be used in the features
-
./output
This is where reports will be placed when they are generated.
-
./steps
This is where steps specific to your system under test will be accessed. Example steps include building out your database, or logging into your system.
- Build the application stack and start the services:
> docker-compose build
> docker-compose up -d
- Run the tests:
> docker-compose run verify yarn run verify
- Generate the report:
> docker-compose run verify yarn run report
You should now see a report in your mounted output volume.
Custom Gherkin steps needed for your application should be placed in the ./steps directory.
For debug purposes, you can watch the chrome selenium by entering the docker-machine ip, port 5900 in safari. Example: vnc://192.168.99.100:5900 The password is 'secret'.
TBD
TBD
Verification-Reporter will programmatically reproduce the process of verifying a web application, and produce a report for teams interested in a report that is usable by non-developers to prove the validity of the system under test.
- Test Dockerized environments.
- List available Gherkin statements.
- Generate a report for review.
- Generate a PDF version of the report.
- Include version information of system used for testing.
Configuration options are set through Docker environment variables and
can be seen in /src/constants.js.
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome.
This project is Copyright 2017, CodeBiosys, Inc. under the MIT license.
The specifics can be found in LICENSE.md.