add pytest coverage (#24)

Co-authored-by: Min Xu <m1n@fb.com>

add pytest coverage (#24)
Co-authored-by: Min Xu <m1n@fb.com>
4cd2590c · Min Xu · GitHub · 7f3c07bb · 4cd2590c · 4cd2590c
Unverified Commit 4cd2590c authored Aug 06, 2020 by Min Xu Committed by GitHub Aug 06, 2020
Hide whitespace changes
Inline Side-by-side

Showing with 11 additions and 0 deletions

.gitignore .gitignore +2 -0

CONTRIBUTING.md CONTRIBUTING.md +8 -0

requirements-test.txt requirements-test.txt +1 -0

No files found.
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,5 @@

 build/
 dist/
+
+.coverage*
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -65,6 +65,14 @@ mypy .

 ```
 pytest
+# single test
+python -m pytest tests/nn/data_parallel/test_oss_ddp.py::test_on_cpu
+```
+
+### Check test coverage
+
+```
+python -m pytest --cov-report term --cov=fairscale/nn/data_parallel  tests/nn/data_parallel/test_oss_ddp.py::test_on_cpu
 ```

 ### CircleCI status

--- a/requirements-test.txt
+++ b/requirements-test.txt
@@ -3,6 +3,7 @@ flake8 == 3.7.9
 isort == 4.3.21
 mypy == 0.770
 pytest == 5.4.1
+pytest-cov == 2.10.0
 torchtext == 0.6.0
 torch == 1.5.1
 # NOTE(msb) not a dependency but needed by torch