Buildkite Test Collector for Python

The official Python adapter for Buildkite Test Engine which collects information about your tests.

Supported Python versions: >=3.10

⚒ Supported test frameworks: pytest.

📦 Supported CI systems: Buildkite, GitHub Actions, CircleCI, and others via the BUILDKITE_ANALYTICS_* environment variables.

👉 Installing

1. Create a test suite, and copy the API token that it gives you.

2. Add buildkite-test-collector to your project dependencies

Using uv:

uv add --dev buildkite-test-collector

Or add it to your pyproject.toml:

[project.optional-dependencies]
dev = [
    "buildkite-test-collector"
]

3. Set up your API token

Add the BUILDKITE_ANALYTICS_TOKEN environment variable to your build system's environment.

4. Run your tests

Run your tests like normal. Note that we attempt to detect the presence of several common CI environments, however if this fails you can set the CI environment variable to any value and it will work.

uv run pytest

5. Verify that it works

If all is well, you should see the test run in the Test Engine section of the Buildkite dashboard.

🌏 Run metadata overrides

Non-empty values override detected run metadata; unset or empty values preserve the defaults.

Uploads sharing a key within a suite are grouped into one run. A custom key can lose automatic Buildkite build association, but the build URL remains independent.

🏷️ Filtering Tests by Tags

You can filter which tests to run based on execution tags using the --tag-filters option.

First, mark your tests with execution tags:

import pytest

@pytest.mark.execution_tag("color", "red")
def test_red_feature():
    assert True

@pytest.mark.execution_tag("color", "blue")
def test_blue_feature():
    assert True

Then filter tests by tag using the --tag-filters option with key:value format:

# Run only tests tagged with color:red
pytest --tag-filters "color:red"

# Run only tests tagged with color:blue
pytest --tag-filters "color:blue"

Note: The --tag-filters option performs exact key:value matching. Only tests with the specified tag will be selected.

🔁 Running batches with bktec pool exec

The package includes buildkite-pytest, a persistent runner for bktec pool exec. It starts pytest once and runs every batch bktec assigns in the same pytest process. Each test file is imported and collected the first time a batch needs it, and session-scoped fixtures are set up once per job. Module- and class-scoped fixtures are torn down after each batch.

pytest support in bktec pool exec requires bktec v3.4.0 or later (a pre-release at the time of writing); bktec v3.3.0 rejects it with pool planning requires rspec.

BUILDKITE_TEST_ENGINE_TEST_RUNNER=pytest bktec pool exec -- buildkite-pytest [pytest options]

bktec chooses which tests run and retries failures, so buildkite-pytest rejects test arguments and options that select, retry or stop tests, such as -k, -m, -x, --maxfail, --lf, --sw, -n (pytest-xdist), --reruns (pytest-rerunfailures), --json and --tag-filters. Run it from pytest's rootdir. Each batch's test executions are uploaded to Test Engine using BUILDKITE_ANALYTICS_TOKEN.

🎢 Tracing

Buildkite Test Engine has support for tracing potentially slow operations within your tests, and can collect span data of four types: http, sql, sleep and annotations. This is documented as part of our public JSON API so anyone can instrument any code to send this data.

This library supports the ability to transmit tracing information to your Test Engine output by using the new spans pytest fixture. See the SpanCollector documentation for more information.

You may also need to manually capture the data you wish to trace for your use case. For examples of how we've done this in our Ruby test collector, see:

• Instrumenting Rails to capture sql data
• Monkey patching to various libraries to capture http requests
• Monkey patching for sleep

Note: the Ruby test collector is the only Test Engine collector that automatically captures and transmits span data. This Python collector can transmit information, but data capture must be done manually at this time.

🔄 Pytest result reporting

• A test whose fixture teardown raises is uploaded as failed, with the teardown error as the reason. It used to be uploaded with the result from before teardown (passed or skipped), except under pytest-forked, which already uploaded it as failed. If the test had already failed, that failure now stays the reason and the teardown error is added as a further failure_expanded entry; under pytest-forked the teardown error used to replace the reason.
• With pytest-rerunfailures (--reruns), each attempt is uploaded as its own execution: an attempt pytest reports as rerun is failed, and the last attempt has its own result. Previously no result was uploaded for any test in a --reruns run, with a has no result set warning.
• Test locations use 1-based line numbers (tests/test_x.py:1 for a test on the first line). They were one line early. Test identity is unchanged.

🌏 Environment variables

Run metadata overrides are listed above and apply to both JSON and OpenTelemetry uploads.

🔭 OpenTelemetry submission (experimental)

The collector can send each test to Test Engine as an OpenTelemetry test.execution span over OTLP instead of the JSON upload, with your tests' own OpenTelemetry spans nested under it. Install the optional dependencies and switch it on:

pip install "buildkite-test-collector[otel]==1.10.0"
BUILDKITE_ANALYTICS_OTEL_ENABLED=true pytest

See docs/opentelemetry.md for what is sent, how child spans and the span filter work, and what the warnings mean.

🔜 Roadmap

See the GitHub 'enhancement' issues for planned features. Pull requests are always welcome, and we’ll give you feedback and guidance if you choose to contribute 💚

⚒ Developing

After cloning the repository, install uv if you haven't already:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then install the dependencies:

uv sync --all-extras

And run the tests:

uv run pytest

Useful resources for developing collectors include the Buildkite Test Engine docs and the RSpec and Minitest collectors.

👩‍💻 Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/buildkite/test-collector-python

🚀 Releasing

See the monorepo's collector release guide.

📜 License

The package is available as open source under the terms of the MIT License.

🤙 Thanks

Thanks to the folks at Alembic for building and maintaining this package.