pytest-testpulse

A pytest plugin that reports test results into TestPulse via its JUnit-XML import API, matching each test to an existing case by key.

Install

pip install pytest-testpulse

Usage

Mark a test with the case key it corresponds to in TestPulse:

import pytest

@pytest.mark.testpulse("LOGIN-42", platform="linux", tags=["smoke"])
def test_login_succeeds():
    ...

Run with --junitxml — the plugin reads pytest's own JUnit XML output rather than generating it itself, so this flag is required whenever the marker (or --testpulse-dry-run) is in use:

pytest --junitxml=report.xml

You'll see a PytestWarning: record_property is incompatible with junit_family 'xunit2' on every marked test — this is pytest's own built-in warning about the mechanism the plugin relies on (record_property), and is harmless: the property is still written and read correctly against junit_family's default. Silence it with a filterwarnings entry in your pytest config if it's too noisy for your CI logs.

At the end of the session, the plugin submits report.xml to POST /api/v1/projects/{project}/imports and prints a summary. A suite with no marked tests and no --testpulse-dry-run needs no configuration at all — the plugin does nothing.

Configuration

Each setting resolves in this order: CLI flag › environment variable › pytest.ini/pyproject.toml option — the first one present wins.

TESTPULSE_URL/TESTPULSE_TOKEN match the env var names TestPulse's own docs already use for the raw conftest.py snippet, so migrating from that snippet to this plugin doesn't require renaming CI secrets. Put your token in an env var or CI secret — not in a committed ini-option.

testpulse_fail_on_unmatched (env var and ini-option) accepts 1/true/yes (case-insensitive) as true; anything else, including unset, is false. --testpulse-no-fail-on-unmatched overrides an ini-option or env var set to true, for a single local run.

Exit-code behavior

Dry run

--testpulse-dry-run previews which annotated case keys would match, via a read-only fetch of the project's cases — it never calls the import endpoint, never creates a run, and never affects the exit code:

pytest --junitxml=report.xml --testpulse-dry-run

Attachments

Call the testpulse_attach fixture from inside a marked test to attach a screenshot to its case — images only (PNG, JPEG, or WebP; TestPulse's import API doesn't accept other file types):

@pytest.mark.testpulse("LOGIN-42")
def test_login_succeeds(testpulse_attach):
    ...
    testpulse_attach("failure.png")

Calling it on a test with no @pytest.mark.testpulse marker, or with a file whose content type isn't one of those three image types, drops the attachment with a warning rather than risking the whole submission — there's no case key to attach it to in the first case, and an unsupported file would otherwise get the entire import rejected in the second. If a marked test's case comes back unmatched in a 207 response, its attachment is named separately in the warning output, distinct from the plain unmatched-case listing.

License

MIT