tests.yml

name: Tests

on: [push, pull_request]

jobs:
  run_test_site:
    name: ${{ matrix.os }}-py${{ matrix.PYTHON_VERSION }}${{ matrix.LABEL }}
    runs-on: ${{ matrix.os }}-latest
    timeout-minutes: 30
    env:
      MPLBACKEND: agg
      PIP_ARGS: --upgrade -e
      PYTEST_ARGS: --pyargs hyperspy --reruns 3 -n 2 --instafail
      PYTEST_ARGS_COVERAGE:
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu, windows, macos]
        PYTHON_VERSION: ['3.8', '3.9']
        PIP_SELECTOR: ['[all, tests]']
        include:
          # test oldest supported version of main dependencies on python 3.6
          - os: ubuntu
            PYTHON_VERSION: '3.7'
            OLDEST_SUPPORTED_VERSION: true
            DEPENDENCIES: matplotlib==3.1.3 numpy==1.17.1 scipy==1.1 imagecodecs==2020.1.31 tifffile==2020.2.16 dask==2.11.0 distributed==2.11.0 scikit-image==0.15 numba==0.52
            PIP_SELECTOR: '[all, tests, coverage]'
            # Hang at the end of the test suite run...
            #PYTEST_ARGS_COVERAGE: --cov=. --cov-report=xml
            LABEL: -oldest
          # test minimum requirement
          - os: ubuntu
            PYTHON_VERSION: '3.8'
            PIP_SELECTOR: '[tests]'
            LABEL: -minimum
          # Run coverage
          - os: ubuntu
            PYTHON_VERSION: '3.8'
            PIP_SELECTOR: '[all, tests, coverage]'
            PYTEST_ARGS_COVERAGE: --cov=. --cov-report=xml
            LABEL: -coverage
          - os: ubuntu
            PYTHON_VERSION: '3.7'
            PIP_SELECTOR: '[all, tests]'
          - os: ubuntu
            PYTHON_VERSION: '3.10'
            PIP_SELECTOR: '[all, tests]'
        exclude:
          # redundant build (same as coverage)
          - os: ubuntu
            PYTHON_VERSION: '3.8'

    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-python@v3
        name: Install Python
        with:
          python-version: ${{ matrix.PYTHON_VERSION }}

      - name: Display version
        run: |
          python --version
          pip --version

      - name: Install oldest supported version
        if: ${{ matrix.OLDEST_SUPPORTED_VERSION }}
        run: |
          pip install ${{ matrix.DEPENDENCIES }}

      - name: Install
        shell: bash
        run: |
          pip install ${{ env.PIP_ARGS }} .'${{ matrix.PIP_SELECTOR }}'

      - name: Pip list
        run: |
          pip list

      - name: Run test suite
        run: |
          pytest ${{ env.PYTEST_ARGS }} ${{ matrix.PYTEST_ARGS_COVERAGE }}

      - name: Upload coverage to Codecov
        if: ${{ always() }} && ${{ matrix.PYTEST_ARGS_COVERAGE }}
        uses: codecov/codecov-action@v2