Skip to content

README.md: How to run tests locally #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jrunu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.md: How to run tests locally #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,17 @@ To build a wheel from the sources:
3. `pip3 install dist/XXX.whl`


## How to run tests locally
The following commands create a local envrionment to run the python client test against a IRIS instance created with docker compose.
It requires [pytest](https://docs.pytest.org/en/stable/) for running the tests.

1. Clone [iris-web](https://github.com/dfir-iris/iris-web) and [iris-client](https://github.com/dfir-iris/iris-client)
2. Copy the test .env over: `cp iris-client/dfir_iris_client/tests/resources/.env iris-web/.env`
3. Start the IRIS instance `docker compose -f iris-web/docker-compose.dev.yml up -d`
4. Read the .env into the shell environment to access the token: `set -a && source iris-web/.env && set +a`
5. Run the tests: `pytest iris-client/dfir_iris_client/tests/`
6. Tear down and remove volumes: `docker compose -f iris-web/docker-compose.dev.yml down --volumes`

## Examples
Some examples are available [here](https://github.com/dfir-iris/iris-client/tree/master/examples).

Expand Down