on master help sign in
Merge pull request #40 from SKoschnicke/add_test_docs

Added documentation about running tests.

commit4fd3af22944ef388d6466331ad7d1f59ea3dcb39 authorDeni Bertovic <deni@denibertovic.com> dateWed 1 Nov 2017, 11:25 (9 years ago) parent0dcc6e9e26c195
1 file changed+11
README.md+11
README.md+11
@@ -24,6 +24,17 @@ website](https://docs.haskellstack.org/en/stable/install_and_upgrade/)). You
2424also need `make` to use the `Makefile` included in the project. Run `make help`
2525to see the available commands (for building, running the tests and releasing).
2626
27+### Tests
28+
29+Tests are located in the `tests` directory and can be run with `make test`. This
30+only runs the unit tests.
31+
32+To run integration tests, you need Docker installed and listening on Port `2375`
33+of `localhost` (docker only listens to a Unix socket by default, see the [Docker
34+documentation](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option)
35+for details). Set the environment variable `RUN_INTEGRATION_TESTS`, i.e.
36+`RUN_INTEGRATION_TESTS=1 make test`.
37+
2738## IRC
2839
2940If you have any questions or suggestions you can find the maintainers in `#docker-haskell`