# ==================================================================================================================== #
# Authors:                                                                                                             #
#   Patrick Lehmann                                                                                                    #
#   Unai Martinez-Corral                                                                                               #
#                                                                                                                      #
# ==================================================================================================================== #
# Copyright 2020-2021 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:
      python_version:
        description: 'Python version.'
        required: false
        default: '3.10'
        type: string
      requirements:
        description: 'Python dependencies to be installed through pip.'
        required: false
        default: '-r tests/requirements.txt'
        type: string
      unittest_directory:
        description: 'Path to the directory containing unit tests.'
        required: false
        default: 'tests/unit'
        type: string
      coverage_config:
        description: 'Path to the .coveragerc file. Use pyproject.toml if empty.'
        required: false
        default: ''
        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-latest

    steps:
      - name: ⏬ Checkout repository
        uses: actions/checkout@v2

      - name: 🔁 Extract configurations from pyproject.toml
        id: getVariables
        run: |
          function ReadToml() {
            state=0;
            RegExp="$2 = \"(.*)\""
            while IFS=$'\r\n' read -r Line; do
                if [[ $state -eq 0 && "$Line" == "[$1]" ]]; then
                    state=1;
                elif [[ $state -eq 1 && "$Line" =~ $RegExp ]]; then
                    echo "${BASH_REMATCH[1]}";
                    break;
                fi
            done < <(cat "pyproject.toml")
          }
          
          # write to step outputs
          echo ::set-output name=coverage_report_html_directory::$(ReadToml "tool.coverage.html" "directory")
          echo ::set-output name=coverage_report_xml::$(ReadToml "tool.coverage.xml" "output")

      - name: 🐍 Setup Python ${{ inputs.python_version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ inputs.python_version }}

      - name: 🗂 Install dependencies
        run: |
          python -m pip install -U pip
          python -m pip install ${{ inputs.requirements }}

      - name: Collect coverage
        continue-on-error: true
        run: |
          [ 'x${{ inputs.coverage_config }}' != 'x' ] && PYCOV_ARGS='--cov-config=${{ inputs.coverage_config }}' || unset PYCOV_ARGS
          python -m pytest -rA --cov=.. $PYCOV_ARGS ${{ inputs.unittest_directory }} --color=yes

      - name: Convert to cobertura format
        run: coverage xml

      - name: Convert to HTML format
        run: |
          coverage html
          rm ${{ steps.getVariables.outputs.coverage_report_html_directory }}/.gitignore

      - name: 📤 Upload 'Coverage Report' artifact
        continue-on-error: true
        uses: actions/upload-artifact@v2
        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@v1
        with:
          file: ${{ 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@master
        with:
          project-token: ${{ secrets.codacy_token }}
          coverage-reports: ${{ steps.getVariables.outputs.coverage_report_xml }}