Skip to content
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.

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

Improved E2E test instructions #1000

Merged
merged 2 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ celerybeat.pid
*.sage.py

# Environments
.env*
.env
.venv*
env/
venv/
Expand Down
11 changes: 11 additions & 0 deletions docs/DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
4 changes: 4 additions & 0 deletions e2e_tests/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These must be populated before running E2E tests
E2E_ENVIRONMENT=
E2E_API_KEY=
E2E_TEAM=
3 changes: 0 additions & 3 deletions e2e_tests/.env.sample

This file was deleted.

5 changes: 0 additions & 5 deletions e2e_tests/e2e_test.md

This file was deleted.