diff options
| -rw-r--r-- | README.md | 36 |
1 files changed, 35 insertions, 1 deletions
@@ -1,11 +1,45 @@ -# e2e - end to end test suite for security analyzers +# e2e - End to end test suite for security analyzers ## Getting Started +You will need the following tools installed: + +* [Docker][docker] +* [asdf][asdf] +* [git][igt] + +This project uses submodules to track the many different +security product repositories. + +To get the project bootstrapped: + ```bash $ git clone --recursive git@gitlab.com:xlgmokha/e2e.git $ cd e2e $ asdf install $ ./bin/setup +``` + +To run the full test suite: + +```bash $ ./bin/test ``` + +To run a specific test: + +```bash +$ ./bin/test spec/integration/gemnasium_maven_spec.rb:14 +``` + +Export `DEBUG=true` to debug a specific test by lauching a shell in the Docker container: + +```bash +$ DEBUG=true ./bin/test spec/integration/gemnasium_maven_spec.rb:14 +``` + +Happy hacking! + +[asdf]: https://asdf-vm.com/ +[docker]: https://www.docker.com/ +[git]: https://git-scm.com/ |