# ==================================================================================================================== # # Authors: # # Patrick Lehmann # # # # ==================================================================================================================== # # Copyright 2020-2025 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: Extract Configuration 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.13' type: string package_namespace: description: 'Name of the tool''s namespace.' required: false default: '' type: string package_name: description: 'Name of the tool''s package.' required: true type: string coverage_config: description: 'Path to the .coveragerc file. Use pyproject.toml by default.' required: false default: 'pyproject.toml' type: string outputs: package_fullname: description: "" value: ${{ jobs.Extract.outputs.package_fullname }} package_directory: description: "" value: ${{ jobs.Extract.outputs.package_directory }} unittest_report_xml_directory: description: "" value: ${{ jobs.Extract.outputs.unittest_report_xml_directory }} unittest_report_xml_filename: description: "" value: ${{ jobs.Extract.outputs.unittest_report_xml_filename }} unittest_report_xml: description: "" value: ${{ jobs.Extract.outputs.unittest_report_xml }} unittest_merged_report_xml_directory: description: "" value: ${{ jobs.Extract.outputs.unittest_merged_report_xml_directory }} unittest_merged_report_xml_filename: description: "" value: ${{ jobs.Extract.outputs.unittest_merged_report_xml_filename }} unittest_merged_report_xml: description: "" value: ${{ jobs.Extract.outputs.unittest_merged_report_xml }} coverage_report_html_directory: description: "" value: ${{ jobs.Extract.outputs.coverage_report_html_directory }} coverage_report_xml_directory: description: "" value: ${{ jobs.Extract.outputs.coverage_report_xml_directory }} coverage_report_xml_filename: description: "" value: ${{ jobs.Extract.outputs.coverage_report_xml_filename }} coverage_report_xml: description: "" value: ${{ jobs.Extract.outputs.coverage_report_xml }} coverage_report_json_directory: description: "" value: ${{ jobs.Extract.outputs.coverage_report_json_directory }} coverage_report_json_filename: description: "" value: ${{ jobs.Extract.outputs.coverage_report_json_filename }} coverage_report_json: description: "" value: ${{ jobs.Extract.outputs.coverage_report_json }} typing_report_cobertura_directory: description: "" value: ${{ jobs.Extract.outputs.typing_report_cobertura_directory }} typing_report_cobertura_file: description: "" value: ${{ jobs.Extract.outputs.typing_report_cobertura_file }} typing_report_junit_directory: description: "" value: ${{ jobs.Extract.outputs.typing_report_junit_directory }} typing_report_junit_file: description: "" value: ${{ jobs.Extract.outputs.typing_report_junit_file }} typing_report_html_directory: description: "" value: ${{ jobs.Extract.outputs.typing_report_html_directory }} jobs: Extract: name: 📓 Extract configurations from pyproject.toml runs-on: "ubuntu-${{ inputs.ubuntu_image_version }}" outputs: package_fullname: ${{ steps.getPackageName.outputs.package_fullname }} package_directory: ${{ steps.getPackageName.outputs.package_directory }} unittest_report_xml_directory: ${{ steps.getVariables.outputs.unittest_report_xml_directory }} unittest_report_xml_filename: ${{ steps.getVariables.outputs.unittest_report_xml_filename }} unittest_report_xml: ${{ steps.getVariables.outputs.unittest_report_xml }} unittest_merged_report_xml_directory: ${{ steps.getVariables.outputs.unittest_merged_report_xml_directory }} unittest_merged_report_xml_filename: ${{ steps.getVariables.outputs.unittest_merged_report_xml_filename }} unittest_merged_report_xml: ${{ steps.getVariables.outputs.unittest_merged_report_xml }} coverage_report_html_directory: ${{ steps.getVariables.outputs.coverage_report_html_directory }} coverage_report_xml_directory: ${{ steps.getVariables.outputs.coverage_report_xml_directory }} coverage_report_xml_filename: ${{ steps.getVariables.outputs.coverage_report_xml_filename }} coverage_report_xml: ${{ steps.getVariables.outputs.coverage_report_xml }} coverage_report_json_directory: ${{ steps.getVariables.outputs.coverage_report_json_directory }} coverage_report_json_filename: ${{ steps.getVariables.outputs.coverage_report_json_filename }} coverage_report_json: ${{ steps.getVariables.outputs.coverage_report_json }} typing_report_cobertura_directory: ${{ steps.getVariables.outputs.typing_report_cobertura_directory }} typing_report_cobertura_file: ${{ steps.getVariables.outputs.typing_report_cobertura_file }} typing_report_junit_directory: ${{ steps.getVariables.outputs.typing_report_junit_directory }} typing_report_junit_file: ${{ steps.getVariables.outputs.typing_report_junit_file }} typing_report_html_directory: ${{ steps.getVariables.outputs.typing_report_html_directory }} steps: - name: ⏬ Checkout repository uses: actions/checkout@v5 - name: 🐍 Setup Python ${{ inputs.python_version }} uses: actions/setup-python@v6 with: python-version: ${{ inputs.python_version }} - name: 🔧 Install wheel,tomli and pip dependencies (native) run: | python -m pip install --disable-pip-version-check -U wheel tomli - name: 🔁 Full package name and directory id: getPackageName shell: python run: | from os import getenv from pathlib import Path from textwrap import dedent namespace = "${{ inputs.package_namespace }}".strip() name = "${{ inputs.package_name }}".strip() print(dedent(f"""\ INPUTS: package_namespace: {namespace} package_name: {name} """)) if namespace == "" or namespace == ".": fullname = f"{name}" directory = f"{name}" else: fullname = f"{namespace}.{name}" directory = f"{namespace}/{name}" print(dedent(f"""\ OUTPUTS: package_fullname: {fullname} package_directory: {directory} """)) 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"""\ package_fullname={fullname} package_directory={directory} """)) - name: 🔁 Extract configurations from pyproject.toml id: getVariables shell: python run: | from os import getenv from pathlib import Path from sys import version from textwrap import dedent print(f"Python: {version}") from tomli import load as tomli_load unittestXMLFile = Path("./unittest.xml") coverageHTMLDirectory = Path("htmlcov") coverageXMLFile = Path("./coverage.xml") coverageJSONFile = Path("./coverage.json") coverageRC = "${{ inputs.coverage_config }}".strip() typingCoberturaFile = Path("report/typing/cobertura.xml") typingJUnitFile = Path("report/typing/StaticTypingSummary.xml") typingHTMLDirectory = Path("htmlmypy") # 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) unittestXMLFile = Path(pyProjectSettings["tool"]["pytest"]["junit_xml"]) mergedUnittestXMLFile = Path(pyProjectSettings["tool"]["pyedaa-reports"]["junit_xml"]) coverageHTMLDirectory = Path(pyProjectSettings["tool"]["coverage"]["html"]["directory"]) coverageXMLFile = Path(pyProjectSettings["tool"]["coverage"]["xml"]["output"]) coverageJSONFile= Path(pyProjectSettings["tool"]["coverage"]["json"]["output"]) typingCoberturaFile = Path(pyProjectSettings["tool"]["mypy"]["cobertura_xml_report"]) / "cobertura.xml" typingJUnitFile = Path(pyProjectSettings["tool"]["mypy"]["junit_xml"]) typingHTMLDirectory = Path(pyProjectSettings["tool"]["mypy"]["html_report"]) 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: print(f"::warning title=Deprecated::Using '{coverageRCFile}' is deprecated. Please use 'pyproject.toml'.") coverageRCFile = Path(coverageRC) if coverageRCFile.exists(): with coverageRCFile.open("rb") as file: coverageRCSettings = tomli_load(file) coverageHTMLDirectory = Path(coverageRCSettings["html"]["directory"]) coverageXMLFile = Path(coverageRCSettings["xml"]["output"]) coverageJSONFile = Path(coverageRCSettings["json"]["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"""\ unittest_report_xml_directory={unittestXMLFile.parent.as_posix()} unittest_report_xml_filename={unittestXMLFile.name} unittest_report_xml={unittestXMLFile.as_posix()} unittest_merged_report_xml_directory={mergedUnittestXMLFile.parent.as_posix()} unittest_merged_report_xml_filename={mergedUnittestXMLFile.name} unittest_merged_report_xml={mergedUnittestXMLFile.as_posix()} coverage_report_html_directory={coverageHTMLDirectory.as_posix()} coverage_report_xml_directory={coverageXMLFile.parent.as_posix()} coverage_report_xml_filename={coverageXMLFile.name} coverage_report_xml={coverageXMLFile.as_posix()} coverage_report_json_directory={coverageJSONFile.parent.as_posix()} coverage_report_json_filename={coverageJSONFile.name} coverage_report_json={coverageJSONFile.as_posix()} typing_report_cobertura_directory={typingCoberturaFile.parent.as_posix()} typing_report_cobertura_file={typingCoberturaFile.name} typing_report_junit_directory={typingJUnitFile.parent.as_posix()} typing_report_junit_file={typingJUnitFile.name} typing_report_html_directory={typingHTMLDirectory.as_posix()} """)) print(dedent(f"""\ DEBUG: unittest xml: {unittestXMLFile} merged unittest xml: {mergedUnittestXMLFile} coverage html: {coverageHTMLDirectory} coverage xml: {coverageXMLFile} coverage json: {coverageJSONFile} typing cobertura: {typingCoberturaFile} typing junit: {typingJUnitFile} typing html: {typingHTMLDirectory} """))