Skip to main content

Run your tests in Bubblewrap sandboxes

Project description

This pytest plugin allows running each test in its own bubblewrap sandbox.

This means each test runs in its own isolated environment, no test has any side-effects on any other.

Basic Usage

Just install the plugin:

$ pip install pytest-bwrap

Then run your tests as usual, with a single added option:

$ py.test --bwrap

Each test will be run in its own sandbox.

Sandbox details

The sandbox will have its own filesystem, layed out as follows:

  • network access is blocked by default; (see “Options”)

  • the following are mounted read-only from the host system:

    • /etc/hosts and /etc/resolv.conf

    • /usr (and the accompanying /bin, /lib, /sbin, with proper handling of /usr-merge)

  • the following are mounted from the host system:

    • /dev

    • /proc

    • the current directory (that is, the root of the project you are testing)

    • the active virtualenv, if running in one

  • /tmp is a new tmpfs;

Options

Network Access

Tests can optionally be granted network access, by decorating them with pytest_bwrap.decorators.network_enabled().

Additional Read-only Directories

It is sometimes useful to have read-only directories, for example when verifying error handling in the tested functions.

This can be achieved in one of two ways:

  • decorating the test function with pytest_bwrap.decorators.read_only('/path/to/ro-dir');

  • setting the extra-ro-dirs option in the pytest configuration;

Example

A full example of how to use this plugin for testing is included.

In particular, it shows how to use the decorators as well as the pytest configuration.

You should be able to switch to that directory, then run the tests:

$ pip install -r requirements.txt
$ py.test --bwrap

All the tests should pass.

License

This project is offered under the terms of the GNU Lesser General Public License, either version 3 or any later version, see the COPYING file for details.

0.1

Initial release, with a basic feature-set to run each test in its own sandbox:

  • host file system is mounted read-only, CWD is mounted read-write;

  • network access is disabled by default but can be enabled for selected tests;

  • additional directories can be made read-only;

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-bwrap-0.1.1.tar.gz (9.9 kB view details)

Uploaded Source

File details

Details for the file pytest-bwrap-0.1.1.tar.gz.

File metadata

  • Download URL: pytest-bwrap-0.1.1.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.1

File hashes

Hashes for pytest-bwrap-0.1.1.tar.gz
Algorithm Hash digest
SHA256 dfc7ea75dc77fb00107a964af09bbf7721954505c5812ffe8ef97bba4a00a998
MD5 4d4f5c74d64ad385d18cc975f2b491bc
BLAKE2b-256 f41ceea11970d09ce62c6ec04ecdec4bbccf5f10e5c350bf00b0cc38dbdf1fd3

See more details on using hashes here.

Supported by

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