forked from MIT-Emerging-Talent/ET6-practice-code-review
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #63 from MIT-Emerging-Talent/docs/update-tests-readme
Docs/update tests readme
- Loading branch information
Showing
1 changed file
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,29 @@ | ||
# Tests | ||
# **Tests** | ||
|
||
This folder contains unit tests for verifying the correctness of the solutions | ||
provided in the `solutions/` folder. | ||
The tests are written using the **unittest** framework to cover a variety | ||
of cases, including: | ||
|
||
- ✅ Standard cases | ||
- ✅ Edge cases | ||
- ✅ Defensive cases | ||
|
||
## **Folder Structure** | ||
|
||
The `tests/` folder mirrors the structure of the `solutions/` folder, with each | ||
test file named to correspond with the solution it verifies. For example: | ||
|
||
## **How to Run Tests** | ||
|
||
To run all unit tests, navigate to the root directory of the repository and use | ||
the following command: | ||
|
||
```bash | ||
python3 -m unittest -v | ||
``` | ||
|
||
The `-v` flag stands for **verbose mode**, which provides detailed information | ||
about each test case. It will display the **name of each test**, along with its | ||
**status** (pass/fail), and any **error messages** if a test fails. | ||
Using verbose mode makes it easier to **debug and understand test results**. |