feat: add test coverage

Author: ogiorgis

.github/workflows/test.yml

@@ -14,8 +14,35 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip pytest
+          python -m pip install --upgrade pip pytest pytest-cov
           pip install .
       - name: Test with pytest
         run: |
-          pytest tests
+          pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=git_hg_sync tests/ | tee pytest-coverage.txt
+      - name: Pytest coverage comment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: ./pytest-coverage.txt
+          junitxml-path: ./pytest.xml
+      - name: Check the output coverage
+        run: |
+          echo "Coverage Percentage - ${{ steps.coverageComment.outputs.coverage }}"
+          echo "Coverage Color - ${{ steps.coverageComment.outputs.color }}"
+          echo "Coverage Html - ${{ steps.coverageComment.outputs.coverageHtml }}"
+          echo "Coverage Warnings - ${{ steps.coverageComment.outputs.warnings }}"
+          echo "Coverage Errors - ${{ steps.coverageComment.outputs.errors }}"
+          echo "Coverage Failures - ${{ steps.coverageComment.outputs.failures }}"
+          echo "Coverage Skipped - ${{ steps.coverageComment.outputs.skipped }}"
+          echo "Coverage Tests - ${{ steps.coverageComment.outputs.tests }}"
+          echo "Coverage Time - ${{ steps.coverageComment.outputs.time }}"
+          echo "Not Success Test Info - ${{ steps.coverageComment.outputs.notSuccessTestInfo }}"
+      - name: Create the Badge
+        uses: schneegans/dynamic-badges-action@v1.7.0
+        with:
+          auth: ${{ secrets.PYTEST_COVERAGE_COMMENT }}
+          gistID: 5e90d640f8c212ab7bbac38f72323f80
+          filename: pytest-coverage-comment__main.json
+          label: Coverage Report
+          message: ${{ steps.coverageComment.outputs.coverage }}
+          color: ${{ steps.coverageComment.outputs.color }}
+          namedLogo: python

.gitignore

@@ -1,4 +1,5 @@
 clones
 .tox
 **/__pycache__/
-config.ini
+config.ini
+.coverage

tox.ini

@@ -8,8 +8,10 @@ setenv = PYTHONPATH = ""
 [testenv:pytest]
 changedir = tests
 passenv = PULSE_PASSWORD
-deps = pytest
-commands = pytest
+deps =
+     pytest
+     pytest-cov
+commands = pytest --cov=git_hg_sync --cov-report=html
 
 [testenv:lint]
 description = lint source code