Added new template for application testing based on unit testing.

.github/workflows/ApplicationTesting.yml

@@ -0,0 +1,221 @@
+# ==================================================================================================================== #
+# Authors:                                                                                                             #
+#   Patrick Lehmann                                                                                                    #
+#   Unai Martinez-Corral                                                                                               #
+#                                                                                                                      #
+# ==================================================================================================================== #
+# Copyright 2020-2023 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: Application Testing
+
+on:
+  workflow_call:
+    inputs:
+      jobs:
+        description: 'JSON list with environment fields, telling the system and Python versions to run tests with.'
+        required: true
+        type: string
+      wheel:
+        description: "Wheel package as input artifact."
+        required: false
+        default: ''
+        type: string
+      requirements:
+        description: 'Python dependencies to be installed through pip.'
+        required: false
+        default: '-r tests/requirements.txt'
+        type: string
+      pacboy:
+        description: 'MSYS2 dependencies to be installed through pacboy (pacman).'
+        required: false
+        default: ""
+        type: string
+      mingw_requirements:
+        description: 'Override Python dependencies to be installed through pip on MSYS2 (MINGW64) only.'
+        required: false
+        default: ''
+        type: string
+      tests_directory:
+        description: 'Path to the directory containing tests (test working directory).'
+        required: false
+        default: 'tests'
+        type: string
+      apptest_directory:
+        description: 'Path to the directory containing application tests (relative to tests_directory).'
+        required: false
+        default: 'app'
+        type: string
+      artifact:
+        description: "Generate application test report with junitxml and upload results as an artifact."
+        required: false
+        default: ''
+        type: string
+
+jobs:
+
+  ApplicationTesting:
+    name: ${{ matrix.sysicon }} ${{ matrix.pyicon }} Application Tests using Python ${{ matrix.python }}
+    runs-on: ${{ matrix.runs-on }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include: ${{ fromJson(inputs.jobs) }}
+
+    defaults:
+      run:
+        shell: ${{ matrix.shell }}
+
+    steps:
+      - name: ⏬ Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Compute pacman/pacboy packages
+        id: pacboy
+        if: matrix.system == 'msys2'
+        shell: python
+        run: |
+          from os      import getenv
+          from pathlib import Path
+          from re      import compile
+
+          def loadRequirementsFile(requirementsFile: Path):
+            requirements = []
+            with requirementsFile.open("r") as file:
+              for line in file.readlines():
+                line = line.strip()
+                if line.startswith("#") or line.startswith("https") or line == "":
+                  continue
+                elif line.startswith("-r"):
+                  # Remove the first word/argument (-r)
+                  requirements += loadRequirementsFile(requirementsFile.parent / line[2:].lstrip())
+                else:
+                  requirements.append(line)
+
+            return requirements
+
+          requirements = "${{ inputs.requirements }}"
+          if requirements.startswith("-r"):
+            requirementsFile = Path(requirements[2:].lstrip())
+            dependencies = loadRequirementsFile(requirementsFile)
+          else:
+            dependencies = [req.strip() for req in requirements.split(" ")]
+
+          packages = {
+            "pip":         "python-pip:p",
+            "wheel":       "python-wheel:p",
+            "coverage":    "python-coverage:p",
+            "lxml":        "python-lxml:p",
+            "ruamel.yaml": "python-ruamel-yaml:p python-ruamel.yaml.clib:p",
+            "numpy":       "python-numpy:p",
+            "igraph":      "igraph:p",
+          }
+          subPackages = {
+            "pyTooling": {
+              "yaml":      "python-ruamel-yaml:p python-ruamel.yaml.clib:p",
+            }
+          }
+
+          regExp = compile(r"(?P<PackageName>[\w_\-\.]+)(?:\[(?P<SubPackages>(?:\w+)(?:,\w+)*)\])?(?:\s*(?P<Comperator>[<>=]+)\s*)(?P<Version>\d+(?:\.\d+)*)(?:-(?P<VersionExtension>\w+))?")
+
+          pacboyPackages = set(("python-pip:p", "python-wheel:p"))
+          print(f"Processing dependencies ({len(dependencies)}):")
+          for dependency in dependencies:
+            print(f"  {dependency}")
+
+            match = regExp.match(dependency)
+            if not match:
+              print(f"    Wrong format: {dependency}")
+              print(f"::error title=Identifying Pacboy Packages::Unrecognized dependency format '{dependency}'")
+              continue
+
+            package = match["PackageName"]
+            if package in packages:
+              rewrite = packages[package]
+              print(f"    Found rewrite rule for '{package}': {rewrite}")
+              pacboyPackages.add(rewrite)
+
+            if match["SubPackages"] and package in subPackages:
+              for subPackage in match["SubPackages"].split(","):
+                if subPackage in subPackages[package]:
+                  rewrite = subPackages[package][subPackage]
+                  print(f"    Found rewrite rule for '{package}[..., {subPackage}, ...]': {rewrite}")
+                  pacboyPackages.add(rewrite)
+
+          # Write jobs to special file
+          github_output = Path(getenv("GITHUB_OUTPUT"))
+          print(f"GITHUB_OUTPUT: {github_output}")
+          with github_output.open("a+") as f:
+            f.write(f"pacboy_packages={' '.join(pacboyPackages)}\n")
+
+      - name: '🟦 Setup MSYS2 for ${{ matrix.runtime }}'
+        if: matrix.system == 'msys2'
+        uses: msys2/setup-msys2@v2
+        with:
+          msystem: ${{ matrix.runtime }}
+          update: true
+          pacboy: >-
+            ${{ steps.pacboy.outputs.pacboy_packages }}
+            ${{ inputs.pacboy }}
+
+      - name: 🐍 Setup Python ${{ matrix.python }}
+        if: matrix.system != 'msys2'
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: 🔧 Install wheel and pip dependencies (native)
+        if: matrix.system != 'msys2'
+        run: |
+          python -m pip install --disable-pip-version-check -U wheel
+          python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
+
+      - name: 🔧 Install pip dependencies (MSYS2)
+        if: matrix.system == 'msys2'
+        run: |
+          if [ -n '${{ inputs.mingw_requirements }}' ]; then
+            python -m pip install --disable-pip-version-check ${{ inputs.mingw_requirements }}
+          else
+            python -m pip install --disable-pip-version-check ${{ inputs.requirements }}
+          fi
+
+      - name: ☑ Run application tests (Windows)
+        if: matrix.system == 'windows'
+        run: |
+          $env:ENVIRONMENT_NAME = "${{ matrix.envname }}"
+          cd "${{ inputs.tests_directory || '.' }}"
+          $PYTEST_ARGS = if ("${{ inputs.artifact }}") { "--junitxml=TestReportSummary.xml" } else { "" }
+          python -m pytest -rA ${{ inputs.apptest_directory }} $PYTEST_ARGS --color=yes
+
+      - name: ☑ Run application tests (Ubuntu/macOS)
+        if: matrix.system != 'windows'
+        run: |
+          export ENVIRONMENT_NAME="${{ matrix.envname }}"
+          ABSDIR=$(pwd)
+          cd "${{ inputs.tests_directory || '.' }}"
+          [ -n '${{ inputs.coverage_config }}' ] && PYCOV_ARGS="--cov-config=${ABSDIR}/${{ inputs.coverage_config }}" || unset PYCOV_ARGS
+          [ -n '${{ inputs.artifact }}' ] && PYTEST_ARGS='--junitxml=TestReportSummary.xml' || unset PYTEST_ARGS
+          python -m pytest -rA ${{ inputs.apptest_directory }} $PYTEST_ARGS --color=yes
+
+      - name: 📤 Upload 'TestReportSummary.xml' artifact
+        if: inputs.artifact != ''
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ inputs.artifact }}-${{ matrix.system }}-${{ matrix.python }}
+          path: ${{ inputs.tests_directory || '.' }}/TestReportSummary.xml
+          if-no-files-found: error
+          retention-days: 1