Merge pull request #117 from rveachkc/pytest-cov

pytest-cov inclusion by @nsano-rururu 

I added this to the circleci config, so coverage is available at https://app.circleci.com/pipelines/github/rveachkc/pymsteams

.circleci/config.yml

@@ -49,10 +49,12 @@ jobs:
             . venv/bin/activate
             python -m pip install --upgrade pip
             pip install -r dev-requirements.txt
-            mkdir -p /tmp/test-reports/pytest
+            mkdir -p /tmp/test-reports
+            mkdir -p /tmp/pytest
+            mkdir -p /tmp/htmlcov
       - run:
           name: pytest
-          command: venv/bin/pytest -v --junitxml=/tmp/test-reports/pytest/results.xml >> /tmp/test-reports/pytest.out
+          command: venv/bin/pytest -v --cov=pymsteams --cov-report html:/tmp/htmlcov --junitxml=/tmp/pytest/results.xml >> /tmp/test-reports/pytest.out
       - run:
           name: safety check
           command: |
@@ -66,9 +68,15 @@ jobs:
       - store_artifacts:
           path: /tmp/test-reports
           destination: test-reports
+      - store_artifacts:
+          path: /tmp/pytest
+          destination: pytest
+      - store_artifacts:
+          path: /tmp/htmlcov
+          destination: coverage
 
       - store_test_results:
-          path: /tmp/test-reports
+          path: /tmp/pytest
 
 
   deploy:

README.md

@@ -223,7 +223,9 @@ Then, from the root of the repo, install the requirements and run pytest.
 
 ```bash
 pip install -r dev-requirements.txt
-pytest
+MS_TEAMS_WEBHOOK=MicrosoftWebhookURL
+export MS_TEAMS_WEBHOOK
+pytest --cov=./pymsteams --cov-report=term-missing --cov-branch
 ```
 
 This will send two MS Teams messages describing how they are formatted.  Manually validate that the message comes through as expected.

dev-requirements.txt

@@ -34,6 +34,7 @@ Pygments>=2.7.4
 pylint>=2.5.3
 pyparsing>=2.4.0
 pytest>=5.0.1
+pytest-cov>=3.0.0
 PyYAML>=5.4
 readme-renderer>=26.0
 requests>=2.25.1