azure-pipelines.yml

# Add steps that analyze code, save build artifacts, deploy, and more:
# https://docs.microsoft.com/azure/devops/pipelines/languages/python
#
# NOTES:
#
# Display name of each step should be prefixed with one of the following:
#   CR-QC: for quality control measures.
#   CR-BUILD: for build-related tasks.
#   CR-DEPLOY: for publication or deployment.
#   [no prefix]: for unrelated CI setup/tooling.
#
# Use PowerShell Core for any utility scripts so they are re-usable across
# Windows, macOS, and Linux.
#


trigger:
  - main


stages:
- stage: Unit_Tests
  displayName: Unit Tests

  jobs:
  - job: pytest
    displayName: pytest
    pool:
      vmImage: 'ubuntu-latest'
    strategy:
      matrix:
        py3.6:
          PYTHON_VERSION: '3.6'
        py3.7:
          PYTHON_VERSION: '3.7'
        py3.8:
          PYTHON_VERSION: '3.8'
        py3.9:
          PYTHON_VERSION: '3.9'

    steps:
    - task: UsePythonVersion@0
      displayName: 'Use Python version'
      inputs:
        versionSpec: '$(PYTHON_VERSION)'
        architecture: 'x64'

    - script: python -m pip install -r requirements-dev.txt
      displayName: 'CR-QC: Install from local repo'

    - script: pytest ./testproject/
      displayName: 'CR-QC: Run unit tests'

    - task: PublishTestResults@2
      displayName: 'Publish unit test report'
      condition: succeededOrFailed()
      inputs:
        testResultsFiles: '**/test-*.xml'
        testRunTitle: 'Publish test results for Python $(python.version)'

    - task: PublishCodeCoverageResults@1
      displayName: 'Publish code coverage report'
      condition: succeededOrFailed()
      inputs:
        codeCoverageTool: Cobertura
        summaryFileLocation: '$(System.DefaultWorkingDirectory)/coverage.xml'


- stage: Static_Analysis
  displayName: Static Analysis
  dependsOn: Unit_Tests
  condition: succeeded('Unit_Tests')
  jobs:
  - job: lint
    displayName: Linters
    pool:
      vmImage: 'ubuntu-latest'

    steps:
    - task: UsePythonVersion@0
      displayName: 'Use Python version'
      inputs:
        versionSpec: '3.9'
        architecture: 'x64'

    - script: python -m pip install -r requirements-dev.txt
      displayName: 'CR-QC: Install from local repo'

    - script: flake8 .
      displayName: 'CR-QC: Static analysis (flake8)'

    - script: black --check .
      displayName: 'CR-QC: Format check'

    - script: mypy .
      displayName: 'CR-QC: Type check (mypy)'

  - job: codecov
    displayName: Code Coverage
    pool:
      vmImage: 'ubuntu-latest'

    steps:
    - task: DownloadPipelineArtifact@2
      displayName: 'Download code coverage from current build'
      inputs:
        source: 'current'
        path: '$(Agent.WorkFolder)/current-artifacts'
        project: '$(System.TeamProjectId)'
        pipeline: '$(System.DefinitionId)'

    - pwsh: ./ci/compare-codecov.ps1 -wd $Env:WorkDir
      displayName: 'CR-QC: Compare code coverage'
      env:
        WorkDir: $(Agent.WorkFolder)