Skip to content

Commit

Permalink
Added doc on how to run tests locally
Browse files Browse the repository at this point in the history
  • Loading branch information
osundwajeff committed Sep 21, 2024
1 parent 5c65149 commit dfa6350
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Testing

To run the tests locally, ensure you have a Python virtual environment and Docker set up.

## Steps to Run Tests

1. **Open Terminal**:
- Navigate to the root directory of the project.
- Ensure the files `admin.py` and `run-tests.sh` are present.

2. **Build the Test Directory**:
- Run the following command in your terminal:
```sh
python admin.py build --tests
```
- This will create a `build` directory with all the project files, including a `test` directory.

3. **Run the Tests**:
- Execute the script to run the tests:
```sh
./run-tests.sh
```
- This script will spin up a Docker container to run the tests.

0 comments on commit dfa6350

Please sign in to comment.