Improved E2E test instructions (#1000)

v7labs · Feb 4, 2025 · 6620fa9 · 6620fa9
1 parent f708da1
commit 6620fa9
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 9 deletions.
diff --git 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
@@ -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
@@ -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
diff --git a/e2e_tests/e2e_test.md b/e2e_tests/e2e_test.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -124,7 +124,7 @@ celerybeat.pid @@
     *.sage.py
     # Environments
-    .env*
+    .env
     .venv*
     env/
     venv/
@@ Expand Down @@