ci.yaml

name: CI

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

jobs:
  test_ubuntu:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

    - name: Cache pip
      uses: actions/cache@v4
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
        restore-keys: |
          ${{ runner.os }}-pip-

    - name: Install dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y xvfb
        python -m pip install --upgrade pip
        pip install -e .[test,dev]


    - name: Run pre-commit checks
      run: |
        pre-commit run --all-files

    - name: Run tests
      run: |
        pytest

    - name: Launch C-COMPASS
      # Ensure that we can open the GUI
      run: |
        Xvfb :99 -screen 0 1024x768x16 &
        export DISPLAY=:99
        python -c "import matplotlib.pyplot"  # let matplotlib build its font cache
        ccompass &
        echo $! > ccompass_pid.txt
        sleep 10
        kill $(cat ccompass_pid.txt)

  test_windows:
    runs-on: windows-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

    - name: Cache pip
      uses: actions/cache@v4
      with:
        path: ~\AppData\Local\pip\Cache
        key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
        restore-keys: |
          ${{ runner.os }}-pip-

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e .[test]

    - name: Run tests
      run: |
        pytest

    - name: Launch C-COMPASS
      # Ensure that we can open the GUI
      run: |
        python -c "import matplotlib.pyplot"  # let matplotlib build its font cache
        ccompass &
        echo $! > ccompass_pid.txt
        sleep 10
        kill $(cat ccompass_pid.txt)
      shell: bash

  test_macos:
    runs-on: macos-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

    - name: Cache pip
      uses: actions/cache@v4
      with:
        path: ~/Library/Caches/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
        restore-keys: |
          ${{ runner.os }}-pip-

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e .[test]

    - name: Run tests
      run: |
        pytest

    - name: Launch C-COMPASS
      # Ensure that we can open the GUI
      run: |
        python -c "import matplotlib.pyplot"  # let matplotlib build its font cache
        ccompass &
        echo $! > ccompass_pid.txt
        sleep 10
        kill $(cat ccompass_pid.txt)

  test_docs:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'

    - name: Cache tox
      uses: actions/cache@v4
      with:
        path: ~/.cache/tox
        key: ${{ runner.os }}-tox-${{ hashFiles('pyproject.toml') }}
        restore-keys: |
          ${{ runner.os }}-tox-

    - name: Install dependencies
      run: |
        pip install tox

    - name: Build documentation
      run: |
        tox -e doc