tests.yml

name: Tests

on: [push, pull_request, workflow_dispatch]

jobs:
  run_test_site:
    name: ${{ matrix.os }}-py${{ matrix.PYTHON_VERSION }}${{ matrix.LABEL }}
    runs-on: ${{ matrix.os }}-latest
    timeout-minutes: 30
    env:
      MPLBACKEND: agg
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu, windows, macos]
        PYTHON_VERSION: ['3.9', '3.10']
        LABEL: ['']
        include:
          # test oldest supported version of main dependencies on python 3.8
          - os: ubuntu
            PYTHON_VERSION: '3.8'
            # Set pillow and scikit-image version to be compatible with imageio and scipy
            # matplotlib needs 3.5 to support markers in hyperspy 2.0 (requires `collection.set_offset_transform`)
            DEPENDENCIES: matplotlib==3.5 numpy==1.20.0 imagecodecs==2020.1.31 tifffile==2020.2.16 dask[array]==2021.3.1 numba==0.52 imageio==2.16 pillow==8.3.2 scikit-image==0.18.0
            LABEL: '-oldest'
          # test minimum requirement
          - os: ubuntu
            PYTHON_VERSION: '3.9'
            LABEL: '-minimum'
          - os: ubuntu
            PYTHON_VERSION: '3.12'
            LABEL: '-minimum-without-hyperspy'
          - os: ubuntu
            PYTHON_VERSION: '3.9'
            LABEL: '-without-hyperspy'
          - os: ubuntu
            PYTHON_VERSION: '3.8'
          - os: ubuntu
            PYTHON_VERSION: '3.11'

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: get repository name
        shell: bash
        run: echo "REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV

      - name: Fetch tags upstream
        if: ${{ github.repository_owner != 'hyperspy' }}
        # Needs to fetch the tags from upstream to get the
        # correct version with setuptools_scm
        run: |
          git remote add upstream https://github.com/hyperspy/${{ env.REPOSITORY_NAME }}.git
          git fetch upstream --tags

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

      - name: Set Environment Variable
        shell: bash
        # Set PIP_SELECTOR environment variable according to matrix.LABEL
        run: |
          if [[ -n "${{ matrix.LABEL }}" && "${{ matrix.LABEL }}" == *"minimum"* ]]; then
            PIP_SELECTOR="[tests]"
          else
            PIP_SELECTOR="[all, tests]"
          fi
          echo "PIP_SELECTOR=${PIP_SELECTOR}" >> $GITHUB_ENV

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

      - name: Install oldest supported version
        if: contains(matrix.LABEL, 'oldest')
        run: |
          pip install ${{ matrix.DEPENDENCIES }}

      - name: Install (HyperSpy dev)
        if: ${{ ! contains(matrix.LABEL, 'without-hyperspy') }}
        # Need to install hyperspy dev until hyperspy 2.0 is released
        run: |
          pip install git+https://github.com/hyperspy/hyperspy.git@RELEASE_next_major

      - name: Install (exspy)
        if: ${{ ! contains(matrix.LABEL, '-minimum') && ! contains(matrix.LABEL, 'without-hyperspy') }}
        run: |
          pip install git+https://github.com/hyperspy/exspy.git

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

      - name: Pip list
        run: |
          pip list

      - name: Run test suite
        run: |
          pytest --pyargs rsciio --reruns 3 -n 2 --cov=. --cov-report=xml

      - name: Upload coverage to Codecov
        if: ${{ always() }}
        uses: codecov/codecov-action@v3