Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pytest-buildkite/pytest-buildkite
Plugin for pytest that automatically publishes coverage and pytest report annotations to Buildkite
https://github.com/pytest-buildkite/pytest-buildkite
pytest pytest-plugin python
Last synced: 12 days ago
JSON representation
Plugin for pytest that automatically publishes coverage and pytest report annotations to Buildkite
- Host: GitHub
- URL: https://github.com/pytest-buildkite/pytest-buildkite
- Owner: pytest-buildkite
- License: mit
- Created: 2019-07-01T10:12:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-24T21:51:37.000Z (over 2 years ago)
- Last Synced: 2024-06-11T17:12:53.675Z (5 months ago)
- Topics: pytest, pytest-plugin, python
- Language: Python
- Homepage:
- Size: 858 KB
- Stars: 6
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# pytest-buildkite
[](https://dev.azure.com/timgates/timgates/_build/latest?definitionId=11&branchName=master)
[](https://travis-ci.org/pytest-buildkite/pytest-buildkite)
[](https://ci.appveyor.com/project/pytest-buildkite/pytest-buildkite)
[](https://pypi.org/project/pytest-buildkite)
[](https://pypi.org/project/pytest-buildkite)
[](https://pypi.org/project/pytest-buildkite)
[](https://pytest-buildkite.readthedocs.io/en/latest/?badge=latest)
[](https://coveralls.io/github/pytest-buildkite/pytest-buildkite/)
[](https://github.com/psf/black)
Plugin for [pytest](https://github.com/pytest-dev/pytest)
that automatically publishes coverage and pytest report
[annotations](https://buildkite.com/docs/agent/v3/cli-annotate)
to BuildKite.
Note: This library was originally re-purposed from
[`tonybaloney's` pytest-azurepipelines](https://github.com/tonybaloney/pytest-azurepipelines)
Just run pytest with this plugin and see your test results in the BuildKite UI!
More details can be found in the
[Online Documentation.](https://pytest-buildkite.readthedocs.io/en/latest/)
# Installation
You can install pytest_buildkite for
[Python](https://www.python.org/) via
[pip](https://pypi.org/project/pip/)
from [PyPI](https://pypi.org/).
```
$ pip install pytest-buildkite
```
## Prerequisites:
- pipefish
- plumbum
## Download from PyPI.org
https://pypi.org/project/pytest-buildkite/
# Features:
- Overloads the `--junit-xml` flag on execution with a default value
- Uploads test results automatically, no need for a separate test results upload command
- Displays the number of failed tests if there were failures as an error message in the UI
- Displays summary of code coverage if pytest-cov is installed
# Running in Docker
To make the buildkite-agent available in docker make sure the agent is bind
mounted into the docker image (or installed in the container) and the
environment variables are passed down. A sample docker compose configuration
is show below.
```
environment:
- BUILDKITE
- BUILDKITE_AGENT_ACCESS_TOKEN
- BUILDKITE_ARTIFACT_UPLOAD_DESTINATION
- BUILDKITE_BRANCH
- BUILDKITE_BUILD_ID
- BUILDKITE_BUILD_NUMBER
- BUILDKITE_BUILD_URL
- BUILDKITE_COMMIT
- BUILDKITE_ENV_FILE
- BUILDKITE_JOB_ID
- BUILDKITE_LABEL
- BUILDKITE_MESSAGE
- BUILDKITE_ORGANIZATION_SLUG
- BUILDKITE_REPO
- BUILDKITE_S3_ACCESS_KEY_ID
- BUILDKITE_S3_ACCESS_URL
- BUILDKITE_S3_ACL
- BUILDKITE_S3_DEFAULT_REGION
- BUILDKITE_S3_SECRET_ACCESS_KEY
- BUILDKITE_TAG
- CI
volumes:
- type: bind
source: /usr/bin/buildkite-agent
target: /usr/bin/buildkite-agent
- type: bind
source: /usr/bin/buildkite-agent-original
target: /usr/bin/buildkite-agent-original
```
# Contributing
Contributions are very welcome, consider using the
[file an issue](https://github.com/pytest-buildkite/pytest-buildkite/issues)
to discuss the work before beginning, but if you already have a Pull Request
ready then this is no problem, please submit it and it will be very gratefully
considered. The [Contribution Guidelines](CONTRIBUTING.md)
outlines the pytest-buildkite commitment to ensuring all
contributions receive appropriate recognition.
# License
Distributed under the terms of the [MIT](http://opensource.org/licenses/MIT)
license, "pytest-buildkite" is free and open source software
# Issues
If you encounter any problems, please
[file an issue](https://github.com/pytest-buildkite/pytest-buildkite/issues)
along with a detailed description.
# Additional Documentation:
* [Online Documentation](https://pytest-buildkite.readthedocs.io/en/latest/)
* [News](NEWS.rst).
* [Template Updates](COOKIECUTTER_UPDATES.md).
* [Code of Conduct](CODE_OF_CONDUCT.md).
* [Contribution Guidelines](CONTRIBUTING.md).