ci.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
#
name: CI

env:
  PRIMARY_PYTHON_VERSION: '3.12'
  PRIMARY_PLATFORM: 'ubuntu-latest'
  PYTEST_CMD: >-
    python -m pytest 
    --junitxml=pytest.xml 
    --cov-report=term-missing:skip-covered 
    --cov=src
    --verbose
    tests/

on:
  push:
    branches: [ master, main ]
  pull_request:
    branches: [ master, main ]

permissions:
  pull-requests: write
  contents: write

jobs:
  # Test compatibility with the matrix of Python versions and platforms
  matrix-build:
    strategy:
      matrix:
        python-version: ["3.10", 3.11, 3.12]
        platform: [ubuntu-latest, macos-latest]
    runs-on: ${{ matrix.platform }}

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}


    - name: Install uv environment
      uses: andgineer/uv-venv@v1

    - name: Install dependencies
      run: uv pip install -r requirements.dev.txt

    - name: Test with pytest
      run: ${{ env.PYTEST_CMD }}

# Build with publishing Allure report, coverage report
  primary-build:
    runs-on: ubuntu-latest
    concurrency:
      group: github-pages
      cancel-in-progress: false

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python ${{ env.PRIMARY_PYTHON_VERSION }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ env.PRIMARY_PYTHON_VERSION }}


    - name: Install uv environment
      uses: andgineer/uv-venv@v1

    - name: Install dependencies
      run: uv pip install -r requirements.dev.txt

    - name: Test with pytest and Allure report
      run: "${{ env.PYTEST_CMD }} --alluredir=./allure-results"

    - name: Load Allure test report history
      uses: actions/checkout@v4
      if: always()
      continue-on-error: true
      with:
        ref: gh-pages
        path: gh-pages-dir

    - name: Generate Allure test report
      uses: andgineer/allure-report@v3.3
      id: allure-report
      if: always()
      with:
        allure-results: allure-results
        website: gh-pages-dir
        reports-site-path: builds/tests

    - name: Publish Allure test report
      uses: peaceiris/actions-gh-pages@v3
      if: ${{ always() && (steps.allure-report.outcome == 'success') }}
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_branch: gh-pages
        publish_dir: ${{ steps.allure-report.outputs.reports-site }}
        destination_dir: ${{ steps.allure-report.outputs.reports-site-path }}

    - name: Coverage comment
      id: coverage_comment
      if: always()
      uses: py-cov-action/python-coverage-comment-action@v3
      with:
        GITHUB_TOKEN: ${{ github.token }}
        MINIMUM_GREEN: 85
        MINIMUM_ORANGE: 70

    - name: Store Pull Request comment to be posted
      uses: actions/upload-artifact@v3
      if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
      with:
        name: python-coverage-comment-action
        path: python-coverage-comment-action.txt

    - name: Upload coverage data to coveralls.io
      if: always()
      uses: coverallsapp/github-action@v2

    - name: Upload Coverage to Codecov
      if: always()
      run: |
        curl -Os https://cli.codecov.io/latest/linux/codecov
        chmod +x codecov
        ./codecov --verbose upload-process --fail-on-error -t ${{ secrets.CODECOV_TOKEN }} -n 'service'-${{ github.run_id }} -F service -f coverage-service.xml