testsuite.yml

name: TestSuite

on: [push, pull_request]

jobs:
  get_python_versions:
    name: "Determine Python versions"
    runs-on: ubuntu-latest
    outputs:
      min-python: ${{ steps.nep29.outputs.min-python }}
      max-python: ${{ steps.nep29.outputs.max-python }}
    steps:
      - name: "calculate versions according to NEP29"
        id: nep29
        uses: mstimberg/github-calc-nep29@v0.7
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

  pre-commit:
    name: Run linters with pre-commit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          persist-credentials: false
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
          cache: 'pip'
          cache-dependency-path: .devcontainer/dev-requirements.txt
      - name: Install deps
        run: pip3 install -r .devcontainer/dev-requirements.txt
      - name: Run pre-commit hooks
        run: pre-commit run --all-files --show-diff-on-failure

  testing:
    needs: [get_python_versions, pre-commit]
    name: "Python ${{ matrix.python-version }} on ${{ matrix.os.image }} (standalone: ${{ matrix.standalone }}, 32bit: ${{ matrix.float_dtype_32 }})"
    runs-on: ${{ matrix.os.image }}
    strategy:
      fail-fast: false
      matrix:
        os: [{image: ubuntu-24.04, triplet: x64-linux},
             {image: windows-2022, triplet: x64-windows},
             {image: macOS-13, triplet: x64-osx},
             {image: macOS-14, triplet: arm64-osx}]
        standalone: [false, true]
        float_dtype_32: [false, true]
        python-version: ["${{ needs.get_python_versions.outputs.max-python }}"]
        include:
          - os: {image: ubuntu-24.04, triplet: x64-linux}
            standalone: false
            python-version: "${{ needs.get_python_versions.outputs.min-python }}"
            float_dtype_32: false
          - os: {image: ubuntu-24.04, triplet: x64-linux}
            standalone: true
            python-version: "${{ needs.get_python_versions.outputs.min-python }}"
            float_dtype_32: false

    defaults:
      run:
        shell: bash -l {0}
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          persist-credentials: false
      - name: Install GSL
        uses: johnwason/vcpkg-action@v6
        id: vcpkg
        with:
          pkgs: gsl
          triplet: ${{ matrix.os.triplet }}
          cache-key: gsl-${{ matrix.os.triplet }}
          revision: master
          token: ${{ github.token }}
      - name: Set GSL preference for vcpkg
        shell: bash
        run: |
          mkdir ~/.brian/
          # Replaces backslashes with forward slashes
          echo "GSL.directory=\"${{ github.workspace }}\\vcpkg\\installed\${{ matrix.os.triplet }}\\include"\" | tr '\\' '/' > ~/.brian/user_preferences
          cat ~/.brian/user_preferences
      - name: Install Python
        id: python
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          python-version: ${{ matrix.python-version }}
      - name: Install Brian2 and dependencies
        env:
          PYTHON_BINARY: ${{ steps.python.outputs.python-path }}
        run: |
          "$PYTHON_BINARY" -m pip install .[test]
      
      - name: Determine Cython cache dir
        id: cython-cache
        run: |
          CACHE_DIR=$(python -c 'import os; from Cython.Utils import get_cython_cache_dir; print(os.path.join(get_cython_cache_dir(), "brian_extensions"))')
          echo "Cython cache dir: $CACHE_DIR"
          echo "cachedir=$CACHE_DIR" >> "$GITHUB_OUTPUT"

      - name: restore Cython cache
        uses: actions/cache@v4
        if: ${{ ! matrix.standalone }}
        with:
          key: cython-extensions-${{ matrix.os.image }}-${{ matrix.python-version }}-32bit-${{ matrix.float_dtype_32 }}
          path: ${{ steps.cython-cache.outputs.cachedir }}

      - name: Run Tests      
        run: |
          cd  $GITHUB_WORKSPACE/.. # move out of the workspace to avoid direct import
          "$PYTHON_BINARY" $GITHUB_WORKSPACE/$SCRIPT_NAME
          cp coverage.xml $GITHUB_WORKSPACE/
        env:
          SCRIPT_NAME: dev/continuous-integration/run_test_suite.py
          SPHINX_DIR: ${{ github.workspace }}/docs_sphinx
          AGENT_OS: ${{runner.os}}
          STANDALONE: ${{ matrix.standalone }}
          FLOAT_DTYPE_32: ${{ matrix.float_dtype_32 }}
          PYTHON_BINARY: ${{ steps.python.outputs.python-path }}
          DO_NOT_RESET_PREFERENCES: true  # Make sure that GSL setting is used
      - name: Send coverage to Coveralls (parallel)
        if: ${{ startsWith(matrix.os.image, 'ubuntu-') && matrix.python-version == needs.get_python_versions.outputs.max-python }}
        uses: coverallsapp/github-action@v2.3.6
        with:
          parallel: true
          flag-name: run ${{ join(matrix.*, ' - ') }}

  coveralls:
    name: Indicate completion to coveralls.io
    needs: testing
    runs-on: ubuntu-latest
    steps:
      - name: Close parallel build
        uses: coverallsapp/github-action@v2.3.6
        with:
          parallel-finished: true

  test_doc_build:
    needs: get_python_versions
    name: Test building the documentation
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}
    steps:
    - name: Checkout Repository
      uses: actions/checkout@v4
      with:
        fetch-depth: 0
        persist-credentials: false
        submodules: true

    - name: Setup Conda and Python
      uses: conda-incubator/setup-miniconda@v3
      with:
        auto-update-conda: true
        auto-activate-base: false
        miniforge-version: latest
        activate-environment: 'test_env'
        python-version: "${{ needs.get_python_versions.outputs.max-python }}"

    - name: Install dependencies
      run: pip install -r rtd-requirements.txt

    - name: Install brian2
      run: pip install .

    - name: Build HTML documentation
      run: |
        cd docs_sphinx
        sphinx-build -b html . ../docs
      env:
        READTHEDOCS: True