Skip to content

Commit dd5b05c

Browse files
Merge pull request #72 from sheepdestroyer/sheepdestroyer-patch-1
Update TESTING.md
2 parents abd585a + 3a15bc5 commit dd5b05c

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

TESTING.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
## Backend Testing
2-
32
The backend of SheepVibes is written in Python and uses the `pytest` framework for testing.
43

5-
### Setup for Local Testing
6-
4+
### I. Setup for Local Testing
75
1. Navigate to the backend directory. Install the necessary development dependencies within a Python virtual environment, including `pytest`:
86
```bash
97
cd backend
@@ -14,8 +12,7 @@ The backend of SheepVibes is written in Python and uses the `pytest` framework f
1412
```
1513

1614

17-
### Running Local Tests
18-
15+
### II. Running Local Tests
1916
The backend tests require a running Redis instance for caching checks.
2017

2118
1. **Start Redis**
@@ -42,24 +39,17 @@ The backend tests require a running Redis instance for caching checks.
4239
```
4340
4441
## Frontend Testing
45-
4642
Currently, there are no automated tests specifically for the frontend JavaScript code.
4743
4844
### Future Considerations
49-
5045
For a vanilla JavaScript application like this, End-to-End (E2E) testing would be a valuable addition. Suitable E2E testing tools include:
5146
5247
* **Playwright:** [https://playwright.dev/](https://playwright.dev/)
5348
* **Cypress:** [https://www.cypress.io/](https://www.cypress.io/)
5449
5550
## Automated Testing with GitHub Actions
56-
57-
To ensure code quality, the project uses a GitHub Actions workflow to run backend tests on every push and pull request. This workflow serves as the definitive guide for setting up an automated testing environment.
58-
59-
### Workflow File
60-
51+
To ensure code quality, the project uses a GitHub Actions workflow to run backend tests on every push and pull request. This workflow serves as the definitive guide for setting up an automated testing environment.
6152
The workflow is defined in `.github/workflows/run-tests.yml`.
6253
63-
### Recommendations for CI/CD and Automated Tools & Agents
64-
65-
Please refer to `AGENTS.md` for detailed instructions on how to configure and run the test suite in automated environments. The key is to replicate the setup found in our GitHub Actions workflow, paying close attention to the use of service containers and the `CACHE_REDIS_PORT` environment variable for dynamic port mapping.
54+
## Recommendations for CI/CD and Automated Tools & Agents
55+
The key is to follow the instructions given above, and replicate the setup found in our GitHub Actions workflow, paying close attention to the use of service containers and the `CACHE_REDIS_PORT` environment variable for dynamic port mapping.

0 commit comments

Comments
 (0)