azure-pipelines.yml

pr:
  branches:
    include:
    - main
    - stable

variables:
- group: default-variables
- name: pip_cache_dir
  value: $(Pipeline.Workspace)/.pip


stages:

- stage: code_quality
  displayName: Check code quality

  jobs:
  - job: flake8
    displayName: Run all flake8 checks

    pool:
      vmImage: 'Ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.12'

    - task: Cache@2
      inputs:
        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
        restoreKeys: |
          pip | "$(Agent.OS)"
        path: $(pip_cache_dir)
      displayName: Cache pip

    - script: pip install -U tox
      displayName: Install tox

    - script: pip install -r requirements-dev.txt
      displayName: Install full dev requirements (CI & flake8)

    - script: pytest -k flake8 --flake8_ext
      displayName: Confirm all plugins active

    - script: tox -e flake8
      displayName: Lint the codebase


  - job: interrogate
    displayName: Run interrogate docstrings check

    pool:
      vmImage: 'Ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.12'

    - task: Cache@2
      inputs:
        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
        restoreKeys: |
          pip | "$(Agent.OS)"
        path: $(pip_cache_dir)
      displayName: Cache pip

    - script: pip install interrogate
      displayName: Install interrogate

    - script: interrogate -vv -f 100 src tests conftest.py
      displayName: Run interrogate


- stage: main_tests
  displayName: Run main code tests

  jobs:
  - template: azure-coretest.yml
    parameters:
      pythons:
        py39:
          spec: '3.9'
        py310:
          spec: '3.10'
        py311:
          spec: '3.11'
        py312:
          spec: '3.12'
        py313:
          spec: '3.13'
        pypy3:
          spec: 'pypy3'
      platforms: [linux]

  - template: azure-coretest.yml
    parameters:
      pythons:
        py39:
          spec: '3.9'
        py310:
          spec: '3.10'
        py311:
          spec: '3.11'
        py312:
          spec: '3.12'
        py313:
          spec: '3.13'
      platforms: [windows, macOs]

  - template: azure-sdisttest.yml


- stage: aux_tests
  displayName: Run auxiliary tests

  jobs:
  - job: docs_build
    displayName: Check for doc build warnings

    pool:
      vmImage: 'Ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.12'

    - task: Cache@2
      inputs:
        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
        restoreKeys: |
          pip | "$(Agent.OS)"
        path: $(pip_cache_dir)
      displayName: Cache pip

    - script: pip install . -r requirements-rtd.txt
      displayName: Install project, plus docs requirements

    - script: cd doc; make html -Wn --keep-going
      displayName: Build docs with warnings as errors


  - job: doctest
    displayName: Run doctest suite

    pool:
      vmImage: 'Ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.12'

    - task: Cache@2
      inputs:
        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
        restoreKeys: |
          pip | "$(Agent.OS)"
        path: $(pip_cache_dir)
      displayName: Cache pip

    - script: pip install -r requirements-dev.txt
      displayName: Install full dev requirements

    - script: cd doc; make doctest
      displayName: Run doctests


  - job: readme
    displayName: Run README doctests

    pool:
      vmImage: 'Ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.12'

    - script: pip install -r requirements-ci.txt
      displayName: Install CI requirements

    - task: Cache@2
      inputs:
        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
        restoreKeys: |
          pip | "$(Agent.OS)"
        path: $(pip_cache_dir)
      displayName: Cache pip

    - script: cd doc; make html
      displayName: Build docs

    - script: pytest -k readme --doctest-glob="README.md"
      displayName: Run README doctests


  - job: testdir_coverage
    displayName: Confirm all test code was executed

    pool:
      vmImage: 'Ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.12'

    - task: Cache@2
      inputs:
        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
        restoreKeys: |
          pip | "$(Agent.OS)"
        path: $(pip_cache_dir)
      displayName: Cache pip

    - script: pip install -r requirements-dev.txt
      displayName: Install full dev requirements

    - script: cd doc; make html; mkdir scratch
      displayName: Build docset

    - script: pytest --cov=. --nonloc --flake8_ext
      displayName: Run pytest with coverage on the entire project tree

    - script: coverage report --include="tests/*" --fail-under=100
      displayName: Check 100% test execution


  - job: noqa_info
    displayName: Report flake8-noqa results for info (never fails)

    pool:
      vmImage: 'Ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      inputs:
        versionSpec: '3.12'

    - task: Cache@2
      inputs:
        key: 'pip | "$(Agent.OS)" | requirements-dev.txt | requirements-flake8.txt'
        restoreKeys: |
          pip | "$(Agent.OS)"
        path: $(pip_cache_dir)
      displayName: Cache pip

    - script: pip install tox flake8-noqa -r requirements-flake8.txt
      displayName: Install requirements

    - script: tox -e flake8-noqa
      displayName: Run never-fail flake8 with noqa check