From 9bd380a0795121dc52bc216214cb29f552518c33 Mon Sep 17 00:00:00 2001
From: per1234 <accounts@perglass.com>
Date: Thu, 18 Jan 2024 12:22:33 -0800
Subject: [PATCH] Generate standard code coverage report data file in
 `python:test` task

The `coverage run` command used to run the Python unit tests generates a `.coverage` data file. This file can not be
consumed directly by the "codecov/codecov-action" GitHub Actions action that uploads the coverage data to Codecov. A
separate `coverage xml` command must be used to generate the appropriate file.

Previously this `coverage xml` command was ran directly in the test runner GitHub Actions workflow. However, the file is
also required by contributors running tests on their local machines in some cases (e.g., displaying coverage in the VS
Code editor via the popular "Coverage Gutters" extension, which does not support the `.coverage` file). For this reason,
it is best to move the `coverage xml` command invocation to the taskfile. The time required to generate the file is
insignificant so it is added to the `python:test` task rather than adding a separate task the contributor would be
required to run after the `python:test` task.
---
 .github/workflows/test-python-poetry-task.yml | 13 +------------
 .gitignore                                    |  1 +
 Taskfile.yml                                  |  3 +++
 3 files changed, 5 insertions(+), 12 deletions(-)

diff --git a/.github/workflows/test-python-poetry-task.yml b/.github/workflows/test-python-poetry-task.yml
index a8b20c9..9a07336 100644
--- a/.github/workflows/test-python-poetry-task.yml
+++ b/.github/workflows/test-python-poetry-task.yml
@@ -72,9 +72,6 @@ jobs:
     permissions:
       contents: read
 
-    env:
-      COVERAGE_DATA_FILENAME: coverage.xml
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -102,14 +99,6 @@ jobs:
       - name: Display code coverage report
         run: task python:coverage-report
 
-      # codecov/codecov-action only makes the conversion if the `coverage` package is installed in the global runner
-      # environment
-      - name: Convert code coverage report to format required by Codecov
-        run: |
-          poetry run \
-            coverage xml \
-              -o "${{ github.workspace }}/${{ env.COVERAGE_DATA_FILENAME }}"
-
       # A token is used to avoid intermittent spurious job failures caused by rate limiting.
       - name: Set up Codecov upload token
         run: |
@@ -128,5 +117,5 @@ jobs:
         uses: codecov/codecov-action@v3
         with:
           fail_ci_if_error: true
-          file: ${{ env.COVERAGE_DATA_FILENAME }}
+          file: coverage.xml
           token: ${{ env.CODECOV_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 6484186..b9597c0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 /node_modules/
 __pycache__/
 .coverage
+/coverage.xml
diff --git a/Taskfile.yml b/Taskfile.yml
index 5bd239c..58c6b76 100644
--- a/Taskfile.yml
+++ b/Taskfile.yml
@@ -272,6 +272,9 @@ tasks:
             --source="{{.PYTHON_PROJECT_PATH}}" \
             --module \
               pytest "{{.PYTHON_PROJECT_PATH}}/tests"
+      - |
+        poetry run \
+          coverage xml
 
   # Make a temporary file named according to the passed TEMPLATE variable and print the path passed to stdout
   # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/windows-task/Taskfile.yml