v4.0.0

.github/dependabot.yml

@@ -10,9 +10,7 @@ updates:
       - Dependencies
     assignees:
       - Paebbels
-      - umarcor
     reviewers:
       - Paebbels
-      - umarcor
     schedule:
       interval: "daily"    # Checks on Monday trough Friday.

.github/workflows/ApplicationTesting.yml

@@ -231,10 +231,10 @@ jobs:
           cd "${{ inputs.root_directory || '.' }}"
           [ -n '${{ inputs.apptest_xml_artifact }}' ] && PYTEST_ARGS='--junitxml=report/unit/TestReportSummary.xml' || unset PYTEST_ARGS
           if [ -n '${{ inputs.coverage_config }}' ]; then
-            echo "coverage run --data-file=.coverage --rcfile=pyproject.toml -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
+            printf "%s\n" "coverage run --data-file=.coverage --rcfile=pyproject.toml -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
             coverage run --data-file=.coverage --rcfile=pyproject.toml -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}
           else
-            echo "python -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
+            printf "%s\n" "python -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}"
             python -m pytest -raP $PYTEST_ARGS --color=yes ${{ inputs.tests_directory || '.' }}/${{ inputs.apptest_directory }}
           fi
 

.github/workflows/BuildTheDocs.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
       - name: '❗ Deprecation message'
-        run: echo "::warning title=Deprecated::'BuildTheDocs.yml' is not maintained anymore. Please switch to 'SphinxDocumentation.yml', 'LaTeXDocumentation.yml' and 'ExtractConfiguration.yml'."
+        run: printf "%s\n" "::warning title=Deprecated::'BuildTheDocs.yml' is not maintained anymore. Please switch to 'SphinxDocumentation.yml', 'LaTeXDocumentation.yml' and 'ExtractConfiguration.yml'."
 
       - name: ⏬ Checkout repository
         uses: actions/checkout@v4

.github/workflows/CheckDocumentation.yml

@@ -59,14 +59,14 @@ jobs:
 
       - name: 🔧 Install wheel,tomli and pip dependencies (native)
         run: |
-          python -m pip install --disable-pip-version-check -U docstr_coverage interrogate
+          python -m pip install --disable-pip-version-check -U docstr_coverage interrogate[png]
 
       - name: Run 'interrogate' Documentation Coverage Check
         continue-on-error: true
         run: |
-          interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} && echo "::error title=interrogate::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
+          interrogate -c pyproject.toml --fail-under=${{ inputs.fail_under }} && printf "%s\n" "::error title=interrogate::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
 
       - name: Run 'docstr_coverage' Documentation Coverage Check
         continue-on-error: true
         run: |
-          docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} && echo "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"
+          docstr-coverage -v 2 --fail-under=${{ inputs.fail_under }} ${{ inputs.directory }} && printf "%s\n" "::error title=docstr-coverage::Insufficient documentation quality (goal: ${{ inputs.fail_under }})"

.github/workflows/CompletePipeline.yml

@@ -135,13 +135,17 @@ jobs:
   UnitTesting:
     uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@main
     needs:
+      - ConfigParams
       - UnitTestingParams
     with:
       jobs: ${{ needs.UnitTestingParams.outputs.python_jobs }}
       requirements: "-r tests/unit/requirements.txt"
 #      pacboy: "msys/git python-lxml:p"
-      unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
-      coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
+      unittest_report_xml_directory:  ${{ needs.ConfigParams.outputs.unittest_report_xml_directory }}
+      unittest_report_xml_filename:   ${{ needs.ConfigParams.outputs.unittest_report_xml_filename }}
+      coverage_report_html_directory: ${{ needs.ConfigParams.outputs.coverage_report_html_directory }}
+      unittest_xml_artifact:          ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
+      coverage_sqlite_artifact:       ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
 
   StaticTypeCheck:
     uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@main
@@ -205,6 +209,7 @@ jobs:
       - UnitTestingParams
       - UnitTesting
     with:
+      additional_merge_args: '-d "--pytest=rewrite-dunder-init;reduce-depth:pytest.tests.unit"'
       merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
 
 #  VerifyDocs:

.github/workflows/CoverageCollection.yml

@@ -72,7 +72,7 @@ jobs:
 
     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'."
+        run: printf "%s\n" "::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
@@ -150,7 +150,7 @@ jobs:
           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"
+          printf "%s\n" "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

.github/workflows/ExtractConfiguration.yml

@@ -59,18 +59,33 @@ on:
       mypy_prepare_command:
         description: ""
         value: ${{ jobs.Extract.outputs.mypy_prepare_command }}
+      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 }}
       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 }}
@@ -83,10 +98,15 @@ jobs:
       package_fullname:               ${{ steps.getPackageName.outputs.package_fullname }}
       package_directory:              ${{ steps.getPackageName.outputs.package_directory }}
       mypy_prepare_command:           ${{ steps.getPackageName.outputs.mypy_prepare_command }}
+      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 }}
       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 }}
 
     steps:
@@ -144,10 +164,11 @@ jobs:
 
           from tomli import load as tomli_load
 
-          htmlDirectory = Path("htmlcov")
-          xmlFile =  Path("./coverage.xml")
-          jsonFile = Path("./coverage.json")
-          coverageRC = "${{ inputs.coverage_config }}".strip()
+          unittestXMLFile =       Path("./unittest.xml")
+          coverageHTMLDirectory = Path("htmlcov")
+          coverageXMLFile =       Path("./coverage.xml")
+          coverageJSONFile =      Path("./coverage.json")
+          coverageRC =            "${{ inputs.coverage_config }}".strip()
 
           # Read output paths from 'pyproject.toml' file
           if coverageRC == "pyproject.toml":
@@ -156,9 +177,10 @@ jobs:
               with pyProjectFile.open("rb") as file:
                 pyProjectSettings = tomli_load(file)
 
-              htmlDirectory = Path(pyProjectSettings["tool"]["coverage"]["html"]["directory"])
-              xmlFile       = Path(pyProjectSettings["tool"]["coverage"]["xml"]["output"])
-              jsonFile      = Path(pyProjectSettings["tool"]["coverage"]["json"]["output"])
+              unittestXMLFile =       Path(pyProjectSettings["tool"]["pytest"]["junit_xml"])
+              coverageHTMLDirectory = Path(pyProjectSettings["tool"]["coverage"]["html"]["directory"])
+              coverageXMLFile =       Path(pyProjectSettings["tool"]["coverage"]["xml"]["output"])
+              coverageJSONFile=       Path(pyProjectSettings["tool"]["coverage"]["json"]["output"])
             else:
               print(f"File '{pyProjectFile}' not found.")
               print(f"::error title=FileNotFoundError::File '{pyProjectFile}' not found.")
@@ -171,9 +193,9 @@ jobs:
               with coverageRCFile.open("rb") as file:
                 coverageRCSettings = tomli_load(file)
 
-              htmlDirectory = Path(coverageRCSettings["html"]["directory"])
-              xmlFile       = Path(coverageRCSettings["xml"]["output"])
-              jsonFile      = Path(coverageRCSettings["json"]["output"])
+              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.")
@@ -184,11 +206,16 @@ jobs:
           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.as_posix()}
-              coverage_report_xml_directory={xmlFile.parent.as_posix()}
-              coverage_report_xml={xmlFile.as_posix()}
-              coverage_report_json_directory={jsonFile.parent.as_posix()}
-              coverage_report_json={jsonFile.as_posix()}
+              unittest_report_xml_directory={unittestXMLFile.parent.as_posix()}
+              unittest_report_xml_filename={unittestXMLFile.name}
+              unittest_report_xml={unittestXMLFile.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()}
             """))
 
-          print(f"DEBUG:\n  html={htmlDirectory}\n  xml={xmlFile}\n  json={jsonFile}")
+          print(f"DEBUG:\n  unittest xml:  {unittestXMLFile}\n  coverage html: {coverageHTMLDirectory}\n  coverage xml:  {coverageXMLFile}\n  coverage json: {coverageJSONFile}")

.github/workflows/LaTeXDocumentation.yml

@@ -55,17 +55,28 @@ jobs:
           name: ${{ inputs.latex_artifact }}
           path: latex
 
-      - name: Compile LaTeX document
-        uses: xu-cheng/latex-action@master
+      - name: Debug
+        run: |
+          tree -pash .
+
+      - name: Build LaTeX document using 'pytooling/miktex:sphinx'
+        uses: addnab/docker-run-action@v3
         with:
-          working_directory: latex
-          root_file: ${{ inputs.document }}.tex
+          image: pytooling/miktex:sphinx
+          options: -v ${{ github.workspace }}/latex:/latex --workdir /latex
+          run: |
+            which pdflatex
+            pwd
+            ls -lAh
+
+            latexmk -xelatex ${{ inputs.document }}.tex
 
       - name: 📤 Upload 'PDF Documentation' artifact
         uses: pyTooling/upload-artifact@v4
         if: inputs.pdf_artifact != ''
         with:
           name: ${{ inputs.pdf_artifact }}
+          working-directory: latex
           path: ${{ inputs.document }}.pdf
           if-no-files-found: error
           retention-days: 1