name: Tests

on:

  # On which repository actions to trigger the build.
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

  # Allow job to be triggered manually.
  workflow_dispatch:

# Cancel in-progress jobs when pushing to the same branch.
concurrency:
  cancel-in-progress: true
  group: ${{ github.workflow }}-${{ github.ref }}

jobs:

  tests:

    runs-on: ${{ matrix.os }}
    strategy:

      # Run all jobs to completion (false), or cancel
      # all jobs once the first one fails (true).
      fail-fast: true

      matrix:
        os: [
          "ubuntu-latest",
          # "macos-latest",
          # "windows-latest",
        ]
        python-version: [
          "3.6", "3.7", "3.8", "3.9", "3.10", "3.11-dev",
          "pypy3.6", "pypy3.7", "pypy3.8", "pypy3.9",
        ]
        bare: [false]

        # Add another single item to the test matrix. It is the `bare` environment,
        # where `all-plugin-requirements.txt` will NOT be installed, in order to
        # verify the application also works well without those optional dependencies.
        include:
          - os: "ubuntu-latest"
            python-version: "3.10"
            bare: true

    env:
      OS: ${{ matrix.os }}
      PYTHON: ${{ matrix.python-version }}
      BARE: ${{ matrix.bare }}

    name: Python ${{ matrix.python-version }} on ${{ matrix.os }} (bare=${{ matrix.bare }})
    steps:

    - name: Acquire sources
      uses: actions/checkout@v3

    - name: Install prerequisites (Linux)
      if: runner.os == 'Linux'
      run: |
        sudo apt-get install libdbus-1-dev

    - name: Setup Python
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}
        architecture: x64
        cache: 'pip'
        cache-dependency-path: |
          setup.py
          requirements.txt
          dev-requirements.txt
          all-plugin-requirements.txt
          win-requirements.txt

    - name: Install project dependencies (Baseline)
      run: |
        pip install wheel
        pip install -r requirements.txt -r dev-requirements.txt

    - name: Install project dependencies (All plugins)
      if: matrix.bare != true
      run: |
        pip install -r all-plugin-requirements.txt
        
        # Installing `dbus-python` will croak on PyPy, so skip it.
        [[ $PYTHON != 'pypy'* ]] && pip install dbus-python || true

    - name: Install project dependencies (Windows)
      if: runner.os == 'Windows'
      run: |
        pip install -r win-requirements.txt

    # Install package in editable mode,
    # and run project-specific tasks.
    - name: Setup project
      run: |
        pip install --editable=.
        python setup.py compile_catalog

    # For saving resources, code style checking is
    # only invoked within the `bare` environment.
    - name: Check code style
      if: matrix.bare == true
      run: |
        flake8 . --count --show-source --statistics

    - name: Run tests
      run: |
        coverage run -m pytest

    - name: Process coverage data
      run: |
        coverage combine
        coverage xml
        coverage report

    - name: Upload coverage data
      uses: codecov/codecov-action@v3
      with:
        files: ./coverage.xml
        flags: unittests
        env_vars: OS,PYTHON,BARE
        name: codecov-umbrella
        fail_ci_if_error: false