Skip to content

Commit 27de43a

Browse files
docs: add test report summary templates (#12)
1 parent cdd69b5 commit 27de43a

5 files changed

Lines changed: 39 additions & 1 deletion

File tree

courseProjectDocs/project-proposal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ While many examples are provided for the data structure algorithms, the followin
6161

6262
#### Test Coverage
6363

64-
The repository does not include dedicated test coverage scripts, so an accurate coverage percentage could not be determined.
64+
For test summary and coverage reports check [[here](https://github.com/SWEN-777/TheAlgorithms-Python/blob/master/courseProjectDocs/setup/report.md)].

courseProjectDocs/setup/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# How to Run Tests
2+
3+
For the purpose of this assignment, we will be diving into the **[Data Structures](https://github.com/SWEN-777/TheAlgorithms-Python/tree/master/data_structures)** folder's testing. Since there is no proper test setup in place, the team has included a script to help run the tests in this folder and generate a test coverage report.
4+
5+
To reproduce the test results and summary, please follow the listed steps.
6+
7+
1. Naviagte to the testing script from root:
8+
9+
```
10+
cd courseProjectDocs/setup
11+
```
12+
13+
2. Run the testing script:
14+
15+
```
16+
python test_coverage.py
17+
```
18+
19+
3. The output you see on your terminal will match the [coverage screenshot](https://github.com/SWEN-777/TheAlgorithms-Python/blob/master/courseProjectDocs/setup/testCoverage.png) and [test results](https://github.com/SWEN-777/TheAlgorithms-Python/blob/master/courseProjectDocs/setup/testResults.pdf)

courseProjectDocs/setup/report.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Environment Setup and Test Report
2+
3+
## Environment Setup
4+
5+
### **Dependencies Installed:**
6+
7+
1. Install requirements for the repository by running the following command:
8+
9+
```bash
10+
pip install -r requirements.txt
11+
```
12+
13+
## Test Report
14+
15+
### Test Suite Summary
16+
17+
### Coverage Metrics
18+
19+
### Observations
709 KB
Loading
403 KB
Binary file not shown.

0 commit comments

Comments
 (0)