Add coverage comment workflow.

Author: MarcoSteinacher

.github/workflows/coverage.yml

@@ -0,0 +1,36 @@
+name: Post coverage comment
+
+on:
+  workflow_run:
+    workflows: ["Django Tests on PR"]
+    types:
+      - completed
+
+jobs:
+  test:
+    name: Run tests & display coverage
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+      # Gives the action the necessary permissions for looking up the
+      # workflow that launched this workflow, and download the related
+      # artifact that contains the comment to be published
+      actions: read
+    steps:
+      # DO NOT run actions/checkout here, for security reasons
+      # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          COVERAGE_PATH: django
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}
+          # Update those if you changed the default values:
+          # COMMENT_ARTIFACT_NAME: python-coverage-comment-action
+          # COMMENT_FILENAME: python-coverage-comment-action.txt

.github/workflows/test-django.yml

@@ -2,14 +2,17 @@ name: Django Tests on PR
 
 # trigger: every pull-request
 on:
-  push: ## FOR TESTING PURPOSES ONLY
-    branches: [fix/ci_test]
+  push:
   pull_request:
-    branches: [develop]
+    branches:
+      - main
+      - develop
+      - fix/ci_test
   workflow_dispatch: # allow manual trigger
 
 permissions:
-  contents: read
+  pull-requests: write
+  contents: write
 
 jobs:
   test:
@@ -71,10 +74,56 @@ jobs:
         run: |
           set -e
           cd django
+          touch .coverage
           docker run --rm \
             --network host \
             -e GITHUB_ACTIONS=true \
             -e COVERAGE=true \
+            -v ./.coverage:/cohiva/.coverage_output_for_github_action \
+            -v ./htmlcov:/cohiva/htmlcov \
             cohiva:test \
             sh -c "cp /cohiva/cohiva/base_config_for_tests.py /cohiva/cohiva/base_config.py && /cohiva/setup.py --use-default-certs && /cohiva/run-tests.sh"
           exit $?
+
+      - name: Coverage comment
+        id: coverage_comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          COVERAGE_PATH: django
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Store Pull Request comment to be posted
+        uses: actions/upload-artifact@v4
+        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+        with:
+          # If you use a different name, update COMMENT_ARTIFACT_NAME accordingly
+          name: python-coverage-comment-action
+          # If you use a different name, update COMMENT_FILENAME accordingly
+          path: python-coverage-comment-action.txt
+
+
+#      - name: Upload coverage to Codecov
+#        uses: codecov/codecov-action@v3.1.0
+#        with:
+#          files: ./django/coverage.xml
+#          fail_ci_if_error: true
+#          verbose: true
+#          flags: unittests
+#          name: codecov-umbrella
+#          token: ${{ secrets.CODECOV_TOKEN }}
+#          directory: ./django/
+#          workdir: ./django/
+#
+#      - name: Upload coverage html report
+#        #uses: actions/upload-artifact@v3
+#        uses: actions/upload-pages-artifact@v3
+#        with:
+#          #name: coverage-html-report
+#          path: ./django/htmlcov/
+#
+#
+#      - name: Publish to GitHub pages
+#        #uses: peaceiris/actions-gh-pages@v3
+#        uses: actions/deploy-pages@v3
+#        #with:
+#        #  artifact_name: coverage-html-report

django/requirements-docker.txt

@@ -92,7 +92,7 @@ defusedxml==0.7.1
     #   willow
 dj-rest-auth==7.0.1
     # via -r requirements.in
-django==4.2.26
+django==4.2.27
     # via
     #   -r requirements.in
     #   dj-rest-auth

django/run-tests.sh

@@ -21,7 +21,13 @@ COVERAGE_OPTS=()
 #COVERAGE_OPTS=(--source "$INSTALL_DIR/django")
 #COVERAGE_OPTS=(--append)
 if [ -n "$GITHUB_ACTIONS" ] ; then
-    COVERAGE_OPTS=(--source "/cohiva/")
+    #COVERAGE_OPTS=(--source "/cohiva/")
+    cat <<EOT >.coveragerc
+[run]
+source = /cohiva/
+relative_files = True
+EOT
+
 fi
 
 if [ -n "$COVERAGE" ] ; then
@@ -40,7 +46,7 @@ TEST_OPTS=""
 ## Select test to run (leave emtpy to run all tests)
 SELECTED_TESTS=""
 # Examples:
-#SELECTED_TESTS="finance.tests geno.tests.test_documents.DocumentSendTest.test_send_member_bill"
+SELECTED_TESTS="finance.tests geno.tests.test_documents.DocumentSendTest.test_send_member_bill"
 
 ## Full test suite incl. migrations
 # Run tests and capture the exit code of the test runner even though output is piped to tee.
@@ -52,11 +58,12 @@ set -e
 
 if [ -n "$COVERAGE_CMD" ] ; then
   if [ -n "$GITHUB_ACTIONS" ] ; then
-    coverage html 2>&1 | tee coverage.log
-    echo "TODO: Publish coverage report to GitHub"
-  else
     #coverage html 2>&1 | tee coverage.log
-    coverage report
+    # Copy the output to the mounted docker host file
+    cp .coverage .coverage_output_for_github_action
+  else
+    coverage html 2>&1 | tee coverage.log
+    #coverage report
   fi
 fi