diff --git a/.gitignore b/.gitignore index fccfeb8d7..5aaf6f18c 100644 --- a/.gitignore +++ b/.gitignore @@ -124,7 +124,7 @@ celerybeat.pid *.sage.py # Environments -.env* +.env .venv* env/ venv/ diff --git a/docs/DEV.md b/docs/DEV.md index 601b8a309..0e25e506f 100644 --- a/docs/DEV.md +++ b/docs/DEV.md @@ -40,6 +40,17 @@ Can also force poetry commands without being in a shell environment by prependin `poetry run python -m darwin.cli` +### Testing +To run unit tests locally: +``` +pytest +``` + +To run end-to-end tests locally, copy `e2e_tests/.env.example` to `.env` and populate all variables. Then run: +``` +pytest e2e_tests +``` + ## Useful Aliases Aliases can be helpful for testing and development. Add them to your shell configuration file .bashrc .zshrc etc for ease of use and development ``` diff --git a/e2e_tests/.env.example b/e2e_tests/.env.example new file mode 100644 index 000000000..b9475ff3b --- /dev/null +++ b/e2e_tests/.env.example @@ -0,0 +1,4 @@ +# These must be populated before running E2E tests +E2E_ENVIRONMENT= +E2E_API_KEY= +E2E_TEAM= diff --git a/e2e_tests/.env.sample b/e2e_tests/.env.sample deleted file mode 100644 index 17361097b..000000000 --- a/e2e_tests/.env.sample +++ /dev/null @@ -1,3 +0,0 @@ -# Because this is intended to be run in a CI environment, this will normally be unnecessary. -E2E_ENVIRONMENT= -E2E_API_KEY= diff --git a/e2e_tests/e2e_test.md b/e2e_tests/e2e_test.md deleted file mode 100644 index 5d98af56c..000000000 --- a/e2e_tests/e2e_test.md +++ /dev/null @@ -1,5 +0,0 @@ -# End to end tests module - -This module is setup in `pytest.ini` to _not run_. If you want to run the E2E tests, -you will need to run `pytest e2e_tests` rather than `pytest`. -