Python testreszabása az Azure Pipelineshoz

  • Cikk

Az Azure Pipelines használatával anélkül hozhat létre Python-alkalmazásokat, hogy saját infrastruktúrát kellene beállítania. A Python-alkalmazások – például a pip – létrehozásához, teszteléséhez és futtatásához gyakran használt eszközök előre telepítve lesznek a Microsoft által üzemeltetett ügynökökre az Azure Pipelinesban.

Az első folyamat Pythonnal való létrehozásához tekintse meg a Python rövid útmutatóját.

Adott Python-verzió használata

A Python egy adott verziójának a folyamatban való használatához adja hozzá a Python-verzió használata feladatot az azure-pipelines.yml fájlhoz. Ez a kódrészlet a Python 3.11 használatára állítja be a folyamatot:

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

Több Python-verzió használata

Ha több Python-verzióval rendelkező folyamatot szeretne futtatni, például egy csomagot tesztelni az adott verziókon, definiáljon egy job Python-verziót matrix . Ezután állítsa be a UsePythonVersion feladatot úgy, hogy a matrix változóra hivatkozzon.

jobs:
- job: 'Test'
  pool:
    vmImage: 'ubuntu-latest' # other options: 'macOS-latest', 'windows-latest'
  strategy:
    matrix:
      Python38:
        python.version: '3.8'
      Python39:
        python.version: '3.9'
      Python310:
        python.version: '3.10'

  steps:
  - task: UsePythonVersion@0
    inputs:
      versionSpec: '$(python.version)'

A mátrix minden Python-verziójával futtatható feladatokat adhat hozzá.

Python-szkriptek futtatása

Python-szkriptek adattárban való futtatásához használjon egy script elemet, és adjon meg egy fájlnevet. Például:

- script: python src/example.py

Beágyazott Python-szkripteket is futtathat a Python-szkript feladattal:

- task: PythonScript@0
  inputs:
    scriptSource: 'inline'
    script: |
      print('Hello world 1')
      print('Hello world 2')

A szkript végrehajtásának paraméterezéséhez használja a PythonScript feladatot értékekkel arguments , hogy argumentumokat adjon át a végrehajtási folyamatnak. Az argumentumok elemzéséhez használhatja sys.argv vagy a kifinomultabb argparse kódtárat.

- task: PythonScript@0
  inputs:
    scriptSource: inline
    script: |
      import sys
      print ('Executing script file is:', str(sys.argv[0]))
      print ('The arguments are:', str(sys.argv))
      import argparse
      parser = argparse.ArgumentParser()
      parser.add_argument("--world", help="Provide the name of the world to greet.")
      args = parser.parse_args()
      print ('Hello ', args.world)
    arguments: --world Venus

Függőségek telepítése

Szkriptek használatával telepíthet adott PyPI-csomagokat a paranccsal pip. Ez a YAML például telepíti vagy frissíti a és wheel a setuptools csomagokatpip.

- script: python -m pip install --upgrade pip setuptools wheel
  displayName: 'Install tools'

Telepítési követelmények

A frissítés és a barátok frissítése pip után egy tipikus következő lépés a függőségek telepítése requirements.txt:

- script: pip install -r requirements.txt
  displayName: 'Install requirements'

Tesztek futtatása

Szkriptek használatával különböző teszteket telepíthet és futtathat a folyamatban.

Lint tesztek futtatása flake8-mal

A linttesztek telepítéséhez vagy frissítéséhez flake8 és használatához használja ezt a YAML-t:

- script: |
    python -m pip install flake8
    flake8 .
  displayName: 'Run lint tests'

Tesztelés pytesttel és lefedettségi metrikák gyűjtése pytest-cov használatával

Ezzel a YAML-lel telepíthet pytest és pytest-covfuttathat teszteket, kimeneti teszteredményeket JUnit formátumban, és kimeneti kódlefedettségi eredményeket Cobertura XML formátumban:

- script: |
    pip install pytest pytest-azurepipelines
    pip install pytest-cov
    pytest --doctest-modules --junitxml=junit/test-results.xml --cov=. --cov-report=xml
  displayName: 'pytest'

Tesztek futtatása a Tox használatával

Az Azure Pipelines párhuzamos Tox-tesztfeladatokat futtathat a munka felosztásához. Egy fejlesztői számítógépen sorozatban kell futtatnia a tesztkörnyezeteket. Ez a minta a Python aktuális feladathoz aktív verziójának futtatására használható tox -e py .

- job:

  pool:
    vmImage: 'ubuntu-latest'
  strategy:
    matrix:
      Python38:
        python.version: '3.8'
      Python39:
        python.version: '3.9'
      Python310:
        python.version: '3.10'

  steps:
  - task: UsePythonVersion@0
    displayName: 'Use Python $(python.version)'
    inputs:
      versionSpec: '$(python.version)'

  - script: pip install tox
    displayName: 'Install Tox'

  - script: tox -e py
    displayName: 'Run Tox'

Teszteredmények közzététele

Adja hozzá a Teszteredmények közzététele feladatot a JUnit- vagy xUnit-teszteredmények kiszolgálón való közzétételéhez:

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

Kódlefedettségi eredmények közzététele

Adja hozzá a Kódlefedettségi eredmények közzététele feladatot , hogy közzétegye a kódlefedettségi eredményeket a kiszolgálón. A lefedettségi metrikákat a build összegzésében tekintheti meg, és html-jelentéseket tölthet le további elemzés céljából.

- task: PublishCodeCoverageResults@1
  inputs:
    codeCoverageTool: Cobertura
    summaryFileLocation: '$(System.DefaultWorkingDirectory)/**/coverage.xml'

Kód csomagolása és kézbesítése

A használatával twinetörténő hitelesítéshez használja a Twine Authentication feladatot a hitelesítési hitelesítő adatok tárolásához a PYPIRC_PATH környezeti változóban.

- task: TwineAuthenticate@0
  inputs:
    artifactFeed: '<Azure Artifacts feed name>'
    pythonUploadServiceConnection: '<twine service connection from external organization>'

Ezután adjon hozzá egy egyéni szkriptet , amely a csomagok közzétételére használható twine .

- script: |
   twine upload -r "<feed or service connection name>" --config-file $(PYPIRC_PATH) <package path/files>

Az Azure Pipelines használatával lemezképet is létrehozhat a Python-alkalmazáshoz, és leküldheti azt egy tárolóregisztrációs adatbázisba.