azure-pipelines.yml

trigger:
  # start a new build for every push
  batch: false
  branches:
    include:
      - 'main'
      - 'maint/*'
pr:
  branches:
    include:
      - '*'  # must quote since "*" is a YAML reserved character; we want a string


stages:

  - stage: Check
    jobs:
      - job: Skip
        pool:
          vmImage: 'ubuntu-latest'
        variables:
          DECODE_PERCENTS: 'false'
          RET: 'true'
          BUILD_REASON: $(Build.Reason)
        steps:
          - bash: |
              git_log=`git log --format=oneline -n 1 --skip=1`
              echo "##vso[task.setvariable variable=log]$git_log"
          - bash: echo "##vso[task.setvariable variable=RET]false"
            condition: and(eq(variables.BUILD_REASON, 'PullRequest'), or(contains(variables.log, '[skip azp]'), contains(variables.log, '[azp skip]'), contains(variables.log, '[skip ci]'), contains(variables.log, '[ci skip]')))
          - bash: echo "##vso[task.setvariable variable=start_main;isOutput=true]$RET"
            name: result

  - stage: Style
    variables:
      AZURE_CI: 'true'
    jobs:
      - job: All
        pool:
          vmImage: 'ubuntu-latest'
        steps:
          - task: UsePythonVersion@0
            inputs:
              versionSpec: '3.14'
              architecture: 'x64'
              addToPath: true
            displayName: Get Python
          - bash: |
              set -eo pipefail
              python -m pip install --progress-bar off --upgrade pip build
              python -m pip install --only-binary=":all:" --progress-bar off -ve .[hdf5] --group=test
              python -m pip uninstall -yq pytest-qt  # don't want to set up display, etc. for this
              pre-commit install --install-hooks
            displayName: Install dependencies
          - bash: make pre-commit
            displayName: make pre-commit
            condition: always()
          - bash: make nesting
            displayName: make nesting
            condition: always()
          - bash: make check-readme
            displayName: make check-readme
            condition: always()
          - bash: mypy
            displayName: mypy
            condition: always()
          - bash: vulture
            displayName: vulture
            condition: always()

  - stage: Test
    condition: and(succeeded(), eq(dependencies.Check.outputs['Skip.result.start_main'], 'true'))
    dependsOn: ['Style', 'Check']
    variables:
      AZURE_CI: 'true'
    jobs:
      - job: Linux_Ultraslow_PG
        pool:
          vmImage: 'ubuntu-latest'
        variables:
          DISPLAY: ':99'
          OPENBLAS_NUM_THREADS: '1'
          OMP_NUM_THREADS: '1'
          MNE_TEST_ALLOW_SKIP: '^$'  # nothing
          MNE_BROWSER_PRECOMPUTE: 'false'
        steps:
          - bash: |
              set -xeo pipefail
              ./tools/setup_xvfb.sh
              sudo apt install -yq tcsh
            displayName: Install Ubuntu dependencies
          - bash: ./tools/get_minimal_commands.sh
            displayName: Get minimal commands
          - bash: |
              echo $PATH
              mne_surf2bem --version
              fsl_rigid_register --version
            displayName: Test minimal commands
          - task: UsePythonVersion@0
            inputs:
              versionSpec: '3.12'
              architecture: 'x64'
              addToPath: true
          - bash: |
              set -xeo pipefail
              python -m pip install --progress-bar off --upgrade pip
              python -m pip install --progress-bar off --upgrade --only-binary=":all:" -e . --group=test "mne-qt-browser @ https://github.com/mne-tools/mne-qt-browser/archive/refs/heads/main.zip" pyvista scikit-learn python-picard qtpy nibabel sphinx-gallery "PySide6!=6.8.0,!=6.8.0.1,!=6.8.1.1,!=6.9.1" pandas neo pymatreader antio defusedxml curryreader pymef
            displayName: Install dependencies with pip
          - bash: ./tools/check_qt_import.sh PySide6
            displayName: Check Qt import
          - bash: |
              set -xeo pipefail
              mne sys_info -pd
              mne sys_info -pd | grep "qtpy .*(PySide6=.*)$"
            displayName: Print config
          - bash: ./tools/get_testing_version.sh
            displayName: Get testing version
          - task: Cache@2
            inputs:
              key: $(testing_version)
              path: /home/vsts/mne_data
          - bash: ./tools/github_actions_download.sh
            displayName: Download testing data
          - script: pytest -m "ultraslowtest or pgtest" --tb=short --cov=mne --cov-report=xml -vv mne
            displayName: slow and mne-qt-browser tests
          - bash: bash <(curl -s https://codecov.io/bash)
            displayName: Codecov
            condition: succeededOrFailed()

      - job: Linux_Qt_Bindings
        pool:
          vmImage: 'ubuntu-latest'
        variables:
          DISPLAY: ':99'
          OPENBLAS_NUM_THREADS: '1'
          TEST_OPTIONS: "--tb=short --cov=mne --cov-report=xml --cov-append -vv mne/gui mne/viz/_brain mne/viz/backends mne/viz/tests/test_evoked.py mne/report"
          MNE_TEST_ALLOW_SKIP: '^$'  # nothing (can be overridden below)
        steps:
          - bash: ./tools/setup_xvfb.sh
            displayName: Setup up Xvfb
          - task: UsePythonVersion@0
            inputs:
              versionSpec: '3.14'
              architecture: 'x64'
              addToPath: true
          - bash: |
              set -xeo pipefail
              python -m pip install --progress-bar off --upgrade pip
              python -m pip install --progress-bar off --upgrade --only-binary=":all:" -e .[full-pyside6] --group=test_extra "mne-qt-browser @ https://github.com/mne-tools/mne-qt-browser/archive/refs/heads/main.zip"
              python -c "import vtk"
            displayName: Install dependencies with pip
          - bash: |
              set -xeo pipefail
              which mne
              mne sys_info -pd
              python ./tools/check_mne_location.py
            displayName: Print config
          - bash: ./tools/get_testing_version.sh
            displayName: Get testing version
          - task: Cache@2
            inputs:
              key: $(testing_version)
              path: /home/vsts/mne_data
          - bash: ./tools/github_actions_download.sh
            displayName: Download testing data
          - bash: ./tools/check_qt_import.sh PySide6
            displayName: Check Qt import
          - bash: |
              set -xeo pipefail
              mne sys_info -pd
              mne sys_info -pd | grep "qtpy .* (PySide6=.*)$"
              export MNE_TEST_ALLOW_SKIP="^.*PySide6 causes segfaults.*$"
              PYTEST_QT_API=PySide6 pytest -m "not ultraslowtest" ${TEST_OPTIONS}
              python -m pip uninstall -yq PySide6
            displayName: PySide6
          - bash: |
              set -xeo pipefail
              python -m pip install PyQt6
              mne sys_info -pd
              mne sys_info -pd | grep "qtpy .* (PyQt6=.*)$"
              PYTEST_QT_API=PyQt6 pytest -m "not ultraslowtest" ${TEST_OPTIONS}
              python -m pip uninstall -yq PyQt6 PyQt6-sip PyQt6-Qt6
            displayName: PyQt6
          # PyQt5 leaves cruft behind, so run it last
          - bash: |
              set -eo pipefail
              python -m pip install PyQt5
              mne sys_info -pd
              mne sys_info -pd | grep "qtpy .* (PyQt5=.*)$"
              PYTEST_QT_API=PyQt5 pytest -m "not ultraslowtest" ${TEST_OPTIONS}
              python -m pip uninstall -yq PyQt5 PyQt5-sip PyQt5-Qt5
            displayName: PyQt5
          - bash: bash <(curl -s https://codecov.io/bash)
            displayName: Codecov
            condition: succeededOrFailed()

      - job: Windows
        pool:
          vmImage: 'windows-latest'
        variables:
          MNE_LOGGING_LEVEL: 'warning'
          MNE_FORCE_SERIAL: 'true'
          OPENBLAS_NUM_THREADS: '2'
          OMP_DYNAMIC: 'false'
          PYTHONUNBUFFERED: 1
          AZURE_CI_WINDOWS: 'true'
          MNE_CI_KIND: $(TEST_MODE)
          MNE_TEST_ALLOW_SKIP: $(MNE_TEST_ALLOW_SKIP)
        timeoutInMinutes: 95
        strategy:
          maxParallel: 4
          matrix:
            3.11 pip:
              TEST_MODE: 'pip'
              PYTHON_VERSION: '3.11'
              MNE_TEST_ALLOW_SKIP: "^.*(Requires MNE-C|CUDA not| on Windows|MNE_FORCE_SERIAL|PySide6 causes segfaults).*$"
            3.13 pip pre:
              TEST_MODE: 'pip-pre'
              PYTHON_VERSION: '3.13'
              MNE_TEST_ALLOW_SKIP: "^.*(Requires (spm|brainstorm) dataset|Requires MNE-C|CUDA not|Numba not| on Windows|MNE_FORCE_SERIAL|PySide6 causes segfaults).*$"
        steps:
          - task: UsePythonVersion@0
            inputs:
              versionSpec: $(PYTHON_VERSION)
              architecture: 'x64'
              addToPath: true
          - bash: |
              set -xeo pipefail
              git clone --depth 1 https://github.com/pyvista/setup-headless-display-action.git
              MESA3D_VERSION=24.3.0 bash setup-headless-display-action/windows/install_opengl.sh
            displayName: Install OpenGL
          - bash: ./tools/azure_dependencies.sh
          - script: pip install --only-binary=":all:" -e .
            displayName: Install mne
          - script: mne sys_info -pd
            displayName: Print config
          - script: python -c "import numpy; numpy.show_config()"
            displayName: Print NumPy config
          - script: python -c "import numpy; import scipy.linalg; import sklearn.neighbors; from threadpoolctl import threadpool_info; from pprint import pprint; pprint(threadpool_info())"
            displayName: Print threadpoolctl info
          - bash: ./tools/get_testing_version.sh
          - task: Cache@2
            inputs:
              key: $(testing_version)
              path: C:\Users\VssAdministrator\mne_data
            displayName: Cache testing data
          - bash: ./tools/github_actions_download.sh
            displayName: Download testing data
          - script: pytest -m "not (slowtest or pgtest)" --tb=short --cov=mne --cov-report=xml -vv mne
            displayName: Run tests
          - bash: bash <(curl -s https://codecov.io/bash)
            displayName: Codecov
            condition: succeededOrFailed()