add coverage to workflows (#93)

* add coverage to workflows

* adapt licenses

* exclude proto files from coverage

Author: MP91

.github/workflows/ci.yaml

@@ -44,10 +44,10 @@ jobs:
       - name: Initialize python
         uses: actions/setup-python@v4
         with:
-            python-version: ${{ matrix.python-version }}
-            cache: "pip"
-            cache-dependency-path: |
-              **/requirements*.txt
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+          cache-dependency-path: |
+            **/requirements*.txt
 
       - name: Install Dependencies
         run: |
@@ -69,6 +69,29 @@ jobs:
       - name: Run unit and integration tests
         run: tox
 
+      - name: Publish Unit Test Results
+        uses: mikepenz/action-junit-report@v3
+        if: always()
+        with:
+          report_paths: ./results/UnitTest/junit.xml
+          summary: true
+          update_check: true
+          annotate_only: true
+
+      - name: ReportGenerator
+        uses: danielpalme/[email protected]
+        with:
+          reports: "./results/CodeCoverage/cobertura-coverage.xml" # REQUIRED # The coverage reports that should be parsed (separated by semicolon). Globbing is supported.
+          targetdir: "." # REQUIRED # The directory where the generated report should be saved.
+          reporttypes: "MarkdownSummaryGithub" # The output formats and scope (separated by semicolon) Values: Badges, Clover, Cobertura, OpenCover, CsvSummary, Html, Html_Dark, Html_Light, Html_BlueRed, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlInline_AzurePipelines_Light, HtmlSummary, JsonSummary, Latex, LatexSummary, lcov, MarkdownSummary, MarkdownSummaryGithub, MarkdownDeltaSummary, MHtml, PngChart, SonarQube, TeamCitySummary, TextSummary, TextDeltaSummary, Xml, XmlSummary
+          sourcedirs: "./sdv" # Optional directories which contain the corresponding source code (separated by semicolon). The source directories are used if coverage report contains classes without path information.
+          verbosity: "Info" # The verbosity level of the log messages. Values: Verbose, Info, Warning, Error, Off
+          title: "Coverage" # Optional title.
+          tag: "${{ github.run_number }}_${{ github.run_id }}" # Optional tag or build version.
+
+      - run: |
+          cat SummaryGithub.md >> $GITHUB_STEP_SUMMARY
+
       - name: Test setup.cfg execution
         run: |
           python3 setup.py sdist

NOTICE-3RD-PARTY-CONTENT.md

@@ -55,7 +55,7 @@
 |paho-mqtt|1.6.1|OSI Approved|
 |pathspec|0.11.1|Mozilla Public License 2.0 (MPL 2.0)|
 |pbr|5.11.1|Apache 2.0|
-|pip|23.1.2|MIT|
+|pip|23.2.1|MIT|
 |pip-tools|6.12.3|BSD|
 |platformdirs|3.2.0|MIT|
 |pluggy|1.0.0|MIT|
@@ -99,5 +99,7 @@
 |actions/setup-java|v1.4.4|MIT License|
 |actions/setup-python|v4|MIT License|
 |actions/upload-artifact|v3|MIT License|
+|danielpalme/ReportGenerator-GitHub-Action|5.1.23|Apache License 2.0|
 |github/codeql-action|v2|MIT License|
+|mikepenz/action-junit-report|v3|Apache License 2.0|
 |softprops/action-gh-release|v1|MIT License|

tox.ini

@@ -15,8 +15,10 @@ python =
 [testenv]
 deps = -rrequirements.txt
 commands =
-    pytest
-
+    pytest --override-ini junit_family=xunit1 --junit-xml=./results/UnitTest/junit.xml \
+          --cov ./sdv \
+          --cov-report=xml:results/CodeCoverage/cobertura-coverage.xml \
+          --cov-branch ./tests
 [testenv:type]
 basepython = python3
 usedevelop = False
@@ -25,3 +27,7 @@ commands =
     mypy --config-file setup.cfg sdv
 commands_pre =
     pip3 install -e {toxinidir}/
+
+[coverage:run]
+omit =
+    sdv/proto/*