ci.yml

name: continuos integration

on: 
  pull_request:
    branches:
      - develop
      - main
  push:
    branches:
      - main

env:
  LOCAL: false
  REPOSITORY_DIRS: ''

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@v4
      - name: Set up python
        id: setup-python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.6.1
          virtualenvs-create: true
          virtualenvs-in-project: true
          installer-parallel: true

      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v4
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      # - name: Install project
      #   run: poetry install --no-interaction
      #----------------------------------------------
      #              run test suite
      #----------------------------------------------
      - name: Run tests
        run: poetry run pytest --cov --cov-report=xml
      #----------------------------------------------
      #              run linters
      # (requires .code_quality folder in root of repository)
      # .code_quality folder should contain:
      # - .flake8
      # - mypy.ini
      # - .pylintrc
      #----------------------------------------------
      - name: Get python modules name
        run: |
          REPOSITORY_DIRS=$(ls -d */ | sort -u | tr '\n' ' ')
          echo "REPOSITORY_DIRS=$REPOSITORY_DIRS" >> "$GITHUB_ENV"
      - name: Check if env REPOSITORY_DIRS variable was set
        run: echo "REPOSITORY_DIRS=${{ env.REPOSITORY_DIRS }}"
      - name: Run flake8
        run: poetry run flake8 --config .code_quality/.flake8 ${{ env.REPOSITORY_DIRS }}
      - name: Run mypy
        run: poetry run mypy --config-file .code_quality/mypy.ini --explicit-package-bases ${{ env.REPOSITORY_DIRS }}
      - name: Run pylint
        run: poetry run pylint --rcfile .code_quality/.pylintrc ${{ env.REPOSITORY_DIRS }}
      #----------------------------------------------
      #             Set LOCAL env variable
      # LOCAL is set to true if running locally. 
      # If running locally, coverage stats are not uploaded in the next step
      # Note: 
      # - LOCAL value depends on the ACT env variable.
      # - ACT is a env variable created by "act" tool used to run github actions locally
      #----------------------------------------------
      - name: Set LOCAL env variable
        run: |
          if [[ $ACT == 'true' ]]; then
            echo "LOCAL=true" >> "$GITHUB_ENV"
          else
            echo "LOCAL=false" >> "$GITHUB_ENV"
          fi
      - name: Check if env LOCAL variable was set
        run: echo "LOCAL=${{ env.LOCAL }}"
      #----------------------------------------------
      #             upload coverage stats
      # (requires CODECOV_TOKEN in repository secrets)
      #----------------------------------------------
      - name: Upload coverage
        if: ${{ env.LOCAL == 'false' }}
        uses: codecov/codecov-action@v4
        with:
          file: ./coverage.xml
          fail_ci_if_error: true
          token: ${{ secrets.CODECOV_TOKEN }}