Skip to main content

automatically capture test & fixture stdout/stderr to files

Project description

Pytest Autocap

Pytest Autocap, if enabled, will automatically capture the output written to stdout and stderr, writing it down into an output directory of your choosing.

Each test is assigned a unique output directory in a way closely following how pytest refers to tests, e.g. tests/package_b/test_module_b.py::TestModBClass::test_two[2] is located in tests/package_b/test_module_b/TestModBClass/test_two[2] inside the output directory. See pytest-autocap-example if you want to try this out in practice, or want to read a detailed example.

Having all test output recorded automatically is helpful in case Pytest is driving long-running integration- or full-spectrum systems tests. Likewise, having a well-defined scheme for storing additional data generated as part of running these tests, can help splitting the test execution, which in case of systems tests may be significant, from subsequent analysis.

How to use

Installation

Install pytest-autocap:

pip install pytest-autocap

Capture test output

... define some tests and add the --autocap-dir argument to pytest when running to capture output:

pytest --autocap-dir=/tmp/my-test-output -s .

Note, -s is equivalent to --capture=no and is required for autocap to capture test output. However, autocap will raise an error if you provide --autocap-dir, but fail to also set -s/--capture=no.

Storing additional files in the test output directory

If a test generates additional data you wish to keep, use the autocap_dir fixture, which returns a pathlib.Path object. For example:

def test_function_test(autocap_dir):
    with open(autocap_dir / "stuff.txt", "w") as fh:
        fh.write("hello, world\n")
    pass

How it works

Autocap re-uses the capture fixture code which the various capture fixtures uses.

To capture output with plain Pytest, one of these capture fixtures (capfd, capfdbinary, capsys, capsysbinary) must be referenced in the argument list of a test function or function-scoped fixture. However, these fixtures do not support capturing output for fixtures with a longer life-time, i.e. fixtures with session-, module- or class-wide scope.

To circumvent this requirement, and to track which fixture generates what output, autocap manually intializes capture fixtures using various pytest hooks and fixture finalizers. All output is then stored until the test run is completed, at which point all fixtures have run their tear-down logic, and all output is finally written to the chosen output directory. To see a detailed example, see pytest-autocap-example.

Limitations

  • You cannot mix autocap with the standard capture fixtures (capfd, capfdbinary, capsys, capsysbinary), or fixtures depending on those capture fixtures.
    • In case you do by mistake, pytest will exit with a helpful error message, pointing out which test or fixture caused the issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-autocap-0.0.1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

pytest_autocap-0.0.1-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-autocap-0.0.1.tar.gz.

File metadata

  • Download URL: pytest-autocap-0.0.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for pytest-autocap-0.0.1.tar.gz
Algorithm Hash digest
SHA256 dcb319e89350d43542a8e287f6b8d2962ba575dc5c701ef2ec1aca6ee18ff6ed
MD5 d4aa16c847393ed423c50b953ce01b6d
BLAKE2b-256 f0af0815412ef8649ca5d220510bb6b82639652fd0ba1ea87c3511e1a523ba88

See more details on using hashes here.

File details

Details for the file pytest_autocap-0.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_autocap-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 917c26e39fb26f8e23f8038ee293951d29cad0e4237570e530bce0ebbb9ce620
MD5 fa6e31e3163438b8aa58de7ee30ac466
BLAKE2b-256 258a2fbf972d6b8e954b9ed31807959c966bef61827594ed430f068a96eea873

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page