Skip to content
Plugin for pytest that makes it simple to work with Azure Pipelines
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests
.gitignore
HISTORY.rst
LICENSE
MANIFEST.in
README.rst
azure-pipelines.yml
pytest_azurepipelines.py
screenshot.png
setup.py

README.rst

pytest-azurepipelines

Build status PyPI version Python versions PyPI download month

Making Pytest easier to use with Microsoft Azure Pipelines.

Just run pytest with this plugin and see your test results in the Azure Pipelines UI!


Features:

  • Formats the PyTest output to show test docstrings and module names instead of just test case names in the Azure Pipelines UI.
  • Overloads the --junit-xml flag on execution with a default value
  • Uploads test results automatically, no need for a seperate test results upload command
  • Displays the number of failed tests if there were failures as an error message in the UI
  • Automatically formats code coverage and uploads coverage data if pytest-cov is installed

https://github.com/tonybaloney/pytest-azurepipelines/raw/master/screenshot.png

Installation

You can install "pytest-azurepipelines" via pip from PyPI:

$ pip install pytest-azurepipelines

Usage

This plugin requires no configuration.

Here is an example of installing the plugin and running the tests.

- script: |
    python -m pip install --upgrade pip
    pip install pytest pytest-azurepipelines
    pip install -e .
  displayName: 'Install dependencies'

- script: |
    python -m pytest tests/
  displayName: 'pytest'

If you want to change the Azure Pipelines "Test Run Title", you can provide the --test-run-title flag with the run title.

- script: |
    pip install pytest pytest-azurepipelines
    pytest tests/ --test-run-title="Windows Test with junitxml"
  displayName: 'pytest with junitxml flag'

If you have long docstrings in your functions and want them to be shortened, you can use the --napoleon-docstrings flag:

- script: |
   pip install pytest pytest-azurepipelines
   pytest tests/ --test-run-title="Windows Test with junitxml" --napoleon-docstrings

Using the automatic code coverage upload

From version 0.6.0, pytest will upload successful coverage data into a format that Azure supports and package the htmlcov directory into a ZIP file as an artifact for the build.

To use this feature, add the --cov flag with (optional, but required) path to your code files and also ensure you add --cov-report html as an option.

- script: |
   pip install pytest pytest-azurepipelines pytest-cov
   pytest tests/ --cov my_project --cov-report html

Contributing

Contributions are very welcome.

License

Distributed under the terms of the MIT license, "pytest-azurepipelines" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

You can’t perform that action at this time.