# ==================================================================================================================== # # Authors: # # Patrick Lehmann # # Unai Martinez-Corral # # # # ==================================================================================================================== # # Copyright 2020-2024 The pyTooling Authors # # # # Licensed under the Apache License, Version 2.0 (the "License"); # # you may not use this file except in compliance with the License. # # You may obtain a copy of the License at # # # # http://www.apache.org/licenses/LICENSE-2.0 # # # # Unless required by applicable law or agreed to in writing, software # # distributed under the License is distributed on an "AS IS" BASIS, # # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # # See the License for the specific language governing permissions and # # limitations under the License. # # # # SPDX-License-Identifier: Apache-2.0 # # ==================================================================================================================== # name: Coverage Collection on: workflow_call: inputs: ubuntu_image_version: description: 'Ubuntu image version.' required: false default: '24.04' type: string python_version: description: 'Python version.' required: false default: '3.11' type: string requirements: description: 'Python dependencies to be installed through pip.' required: false default: '-r tests/requirements.txt' type: string tests_directory: description: 'Path to the directory containing tests (test working directory).' required: false default: 'tests' type: string unittest_directory: description: 'Path to the directory containing unit tests (relative to tests_directory).' required: false default: 'unit' type: string coverage_config: description: 'Path to the .coveragerc file. Use pyproject.toml by default.' required: false default: 'pyproject.toml' type: string artifact: description: 'Name of the coverage artifact.' required: true type: string secrets: codacy_token: description: 'Token to push result to codacy.' required: true jobs: Coverage: name: 📈 Collect Coverage Data using Python ${{ inputs.python_version }} runs-on: "ubuntu-${{ inputs.ubuntu_image_version }}" steps: - name: '❗ Deprecation message' run: echo "::warning title=Deprecated::'CoverageCollection.yml' is not maintained anymore. Please switch to 'UnitTesting.yml', 'PublishCoverageResults.yml' and 'PublishTestResults.yml'." - name: ⏬ Checkout repository uses: actions/checkout@v4 with: lfs: true submodules: true - name: 🐍 Setup Python ${{ inputs.python_version }} uses: actions/setup-python@v5 with: python-version: ${{ inputs.python_version }} - name: 🗂 Install dependencies run: | python -m pip install --disable-pip-version-check tomli python -m pip install --disable-pip-version-check ${{ inputs.requirements }} - name: 🔁 Extract configurations from pyproject.toml id: getVariables shell: python run: | from os import getenv from pathlib import Path from tomli import load as tomli_load from textwrap import dedent htmlDirectory = 'htmlcov' xmlFile = './coverage.xml' coverageRC = "${{ inputs.coverage_config }}".strip() # Read output paths from 'pyproject.toml' file if coverageRC == "pyproject.toml": pyProjectFile = Path("pyproject.toml") if pyProjectFile.exists(): with pyProjectFile.open("rb") as file: pyProjectSettings = tomli_load(file) htmlDirectory = pyProjectSettings["tool"]["coverage"]["html"]["directory"] xmlFile = pyProjectSettings["tool"]["coverage"]["xml"]["output"] else: print(f"File '{pyProjectFile}' not found.") print(f"::error title=FileNotFoundError::File '{pyProjectFile}' not found.") exit(1) # Read output paths from '.coveragerc' file elif len(coverageRC) > 0: coverageRCFile = Path(coverageRC) if coverageRCFile.exists(): with coverageRCFile.open("rb") as file: coverageRCSettings = tomli_load(file) htmlDirectory = coverageRCSettings["html"]["directory"] xmlFile = coverageRCSettings["xml"]["output"] else: print(f"File '{coverageRCFile}' not found.") print(f"::error title=FileNotFoundError::File '{coverageRCFile}' not found.") exit(1) # Write jobs to special file github_output = Path(getenv("GITHUB_OUTPUT")) print(f"GITHUB_OUTPUT: {github_output}") with github_output.open("a+", encoding="utf-8") as f: f.write(dedent(f"""\ coverage_report_html_directory={htmlDirectory} coverage_report_xml={xmlFile} """)) print(f"DEBUG:\n html={htmlDirectory}\n xml={xmlFile}") - name: Collect coverage continue-on-error: true run: | export ENVIRONMENT_NAME="Linux (x86-64)" export PYTHONPATH=$(pwd) ABSDIR=$(pwd) cd "${{ inputs.tests_directory || '.' }}" [ -n '${{ inputs.coverage_config }}' ] && PYCOV_ARGS="--cov-config=${ABSDIR}/${{ inputs.coverage_config }}" || unset PYCOV_ARGS echo "python -m pytest -rA --cov=${ABSDIR} ${PYCOV_ARGS} ${{ inputs.unittest_directory }} --color=yes" python -m pytest -rA --cov=${ABSDIR} $PYCOV_ARGS ${{ inputs.unittest_directory }} --color=yes - name: Convert to cobertura format run: coverage xml --data-file=${{ inputs.tests_directory || '.' }}/.coverage - name: Convert to HTML format run: | coverage html --data-file=${{ inputs.tests_directory || '.' }}/.coverage -d ${{ steps.getVariables.outputs.coverage_report_html_directory }} rm ${{ steps.getVariables.outputs.coverage_report_html_directory }}/.gitignore - name: 📤 Upload 'Coverage Report' artifact continue-on-error: true uses: pyTooling/upload-artifact@v4 with: name: ${{ inputs.artifact }} path: ${{ steps.getVariables.outputs.coverage_report_html_directory }} if-no-files-found: error retention-days: 1 - name: 📊 Publish coverage at CodeCov continue-on-error: true uses: codecov/codecov-action@v3 with: files: ${{ steps.getVariables.outputs.coverage_report_xml }} flags: unittests env_vars: PYTHON - name: 📉 Publish coverage at Codacy continue-on-error: true uses: codacy/codacy-coverage-reporter-action@v1 with: project-token: ${{ secrets.codacy_token }} coverage-reports: ${{ steps.getVariables.outputs.coverage_report_xml }}