Skip to content

axiomantic/python-tripwire

tripwire

CI PyPI Python 3.10+ License: MIT

"Let me tell you why you're here. You're here because you know something. What you know you can't explain, but you feel it. You've felt it your entire life, that there's something wrong with the world. You don't know what it is, but it's there, like a splinter in your mind, driving you mad." -- Morpheus, The Matrix (1999)

You've had tests pass in CI and then watched the thing they were supposedly testing break in production. You go back and look at the test, and it turns out the mock was wrong, or incomplete, or your production code was making a call the test didn't even know about. The green checkmark was meaningless.

This is what testing with unittest.mock is like. It gives you the tools to mock things, but it's entirely on you to remember to assert every call, verify every argument, and notice when production code starts making calls your tests don't account for. Most of the time, you won't. Not because you're careless, but because unittest.mock is designed around silence -- if you forget to check something, it has no way of telling you.

tripwire replaces unittest.mock with mocking that actually enforces correctness.

pip install python-tripwire[all]

The three guarantees

tripwire intercepts every external call your code makes and enforces three rules that unittest.mock leaves entirely to you:

  1. Every call must be pre-authorized. Code makes a call with no registered mock? UnmockedInteractionError, immediately.
  2. Every recorded interaction must be explicitly asserted. Forget to assert an interaction? UnassertedInteractionsError at teardown.
  3. Every registered mock must actually be triggered. Register a mock that never fires? UnusedMocksError at teardown.

What this looks like in practice

# unittest.mock -- this test passes, but proves nothing
from unittest.mock import patch

@patch("myapp.payments.httpx.post")
def test_payment(mock_post):
    mock_post.return_value.json.return_value = {"id": "ch_123"}
    create_charge(5000)
    # Forgot assert_called_with? Test passes.
    # Called with wrong amount? Test passes.
    # Added a second HTTP call? Test passes.

# tripwire -- every interaction is accounted for
def test_payment():
    tripwire.http.mock_response("POST", "https://api.stripe.com/v1/charges",
                               json={"id": "ch_123"}, status=200)

    with tripwire:
        result = create_charge(5000)

    # MUST assert this or test fails at teardown
    tripwire.http.assert_request(
        "POST", "https://api.stripe.com/v1/charges",
        headers=IsInstance(dict), body='{"amount": 5000}',
    ).assert_response(200, IsInstance(dict), '{"id": "ch_123"}')
    assert result["id"] == "ch_123"
Scenario unittest.mock tripwire
Mocked function is never called Passes silently UnusedMocksError
Wrong arguments Only caught if you add assert_called_with InteractionMismatchError
Real HTTP/DB/Redis call leaks through Goes to production UnmockedInteractionError
Forgot to assert a call Passes silently UnassertedInteractionsError
MagicMock returns wrong type Auto-generates attributes forever You declare explicit return values
Production code adds a new external call Existing tests still pass UnmockedInteractionError forces you to handle it

Firewall mode

Firewall mode is on by default. When your test session starts, tripwire installs interceptors that catch any real I/O call happening outside a sandbox.

In "error" mode (the default since 0.20.0), an accidental call raises GuardedCallError and stops the test on the spot. Set guard = "warn" under [tool.tripwire] in your pyproject.toml for the legacy non-blocking behavior, where calls emit a GuardedCallWarning and proceed.

from tripwire import M

# Selectively permit real calls within a scope
with tripwire.allow("dns", "socket"):
    ...

# Or via marker for an entire test
@pytest.mark.allow("dns", "socket")

# Granular patterns
with tripwire.allow(M(protocol="http", host="*.example.com")):
    ...

# Set a ceiling that inner blocks cannot widen
with tripwire.restrict("http", "subprocess"):
    ...

Configure project-wide allow/deny rules in [tool.tripwire.firewall] in your pyproject.toml.

Override the guard level for a single test with @pytest.mark.guard(...). The marker accepts a level string ("error", "warn", "off") or a dict matching the per-protocol shape from [tool.tripwire.guard].

@pytest.mark.guard("error")
def test_strict():
    ...

Picking the right guard default

  • New projects: keep guard = "error" (the default since 0.20.0). Loud failures catch unmocked I/O early.

  • Legacy migration: set guard = "warn" temporarily while you add tripwire.allow and mocks to existing tests.

  • Mixed CI: use [tool.tripwire.guard] for per-protocol levels. Example:

    [tool.tripwire.guard]
    default = "warn"
    subprocess = "error"
    dns = "error"

Quick Start

import tripwire
from dirty_equals import IsInstance

def create_charge(amount):
    """Production code -- calls Stripe via httpx internally."""
    import httpx
    response = httpx.post("https://api.stripe.com/v1/charges",
                          json={"amount": amount})
    return response.json()

def test_payment_flow():
    tripwire.http.mock_response("POST", "https://api.stripe.com/v1/charges",
                               json={"id": "ch_123"}, status=200)

    with tripwire:
        result = create_charge(5000)

    tripwire.http.assert_request(
        "POST", "https://api.stripe.com/v1/charges",
        headers=IsInstance(dict), body='{"amount": 5000}',
    ).assert_response(200, IsInstance(dict), '{"id": "ch_123"}')
    assert result["id"] == "ch_123"

If you forget the assert_request() call, tripwire fails the test at teardown:

E   tripwire._errors.UnassertedInteractionsError: 1 interaction was not asserted.
E
E       http.assert_request(
E           "POST",
E           "https://api.stripe.com/v1/charges",
E           headers={'host': 'api.stripe.com', ...},
E           body='{"amount":5000}',
E           require_response=True,
E       ).assert_response(
E           status=200,
E           headers={'content-type': 'application/json'},
E           body='{"id": "ch_123"}',
E       )
E       # ^ [sequence=0] [HttpPlugin] POST https://api.stripe.com/v1/charges (status=200)

The error output includes every field with its actual value, so you can usually just copy it directly into your test as the assertion.

How it works

  1. Register mocks before the sandbox (mock_response, mock_run, returns, etc.)
  2. Open the sandbox with with tripwire: (or async with tripwire:)
  3. Code runs normally inside the sandbox, but external calls are intercepted and recorded
  4. Assert interactions after the sandbox closes, in order
  5. verify_all() runs automatically at test teardown via the pytest plugin

Since tripwire uses a module-level API, there are no fixtures to set up or inject. You just import it.

Concurrency boundaries

Sandbox state is carried via Python ContextVars, so it propagates through asyncio.to_thread, asyncio.create_task, loop.run_in_executor, asyncio.gather, and concurrent.futures.ThreadPoolExecutor.submit, so code dispatched into worker threads or tasks still hits the active verifier. ProcessPoolExecutor does not propagate with tripwire: state because each worker is a separate Python process with its own (empty) ContextVar set. To use tripwire across process pools, enter with tripwire: inside the worker function itself.

Coming from unittest.mock

Concepts mapping

unittest.mock tripwire equivalent Notes
@patch("module.Class") tripwire.mock("module:Class") Colon-separated import path
@patch.object(obj, "attr") tripwire.mock.object(obj, "attr") Same idea, stricter enforcement
MagicMock() Plugin-specific mocks mock_response, mock_run, mock_command, etc.
mock.return_value = X .returns(X) Explicit, typed return values
mock.side_effect = Exception mock_error(..., raises=Exception) Explicit error mocking
mock.assert_called_with(...) plugin.assert_request(...) / spy.assert_call(...) Required, not optional
mock.assert_not_called() Not needed If it was not registered, it cannot be called
call_args_list Interaction log Automatic, exhaustive, shown on failure

Migration by example

Patching an HTTP call

# BEFORE: unittest.mock
from unittest.mock import patch, MagicMock

@patch("myapp.client.requests.get")
def test_fetch_user(mock_get):
    mock_get.return_value = MagicMock(
        status_code=200,
        json=MagicMock(return_value={"name": "Alice"}),
    )
    user = fetch_user(42)
    mock_get.assert_called_once_with("https://api.example.com/users/42")
    assert user["name"] == "Alice"

# AFTER: tripwire
from dirty_equals import IsInstance

def test_fetch_user():
    tripwire.http.mock_response(
        "GET", "https://api.example.com/users/42",
        json={"name": "Alice"}, status=200,
    )
    with tripwire:
        user = fetch_user(42)

    tripwire.http.assert_request(
        "GET", "https://api.example.com/users/42",
        headers=IsInstance(dict), body=None,
    ).assert_response(200, IsInstance(dict), '{"name": "Alice"}')
    assert user["name"] == "Alice"

Patching a subprocess call

# BEFORE: unittest.mock
from unittest.mock import patch

@patch("myapp.deploy.subprocess.run")
def test_deploy(mock_run):
    mock_run.return_value.returncode = 0
    mock_run.return_value.stdout = "deployed"
    result = deploy("prod")
    mock_run.assert_called_once()

# AFTER: tripwire
def test_deploy():
    tripwire.subprocess.mock_run(
        ["kubectl", "apply", "-f", "prod.yaml"],
        returncode=0, stdout="deployed",
    )
    with tripwire:
        result = deploy("prod")

    tripwire.subprocess.assert_run(
        ["kubectl", "apply", "-f", "prod.yaml"],
        returncode=0, stdout="deployed",
    )

Patching an arbitrary object

# BEFORE: unittest.mock
from unittest.mock import patch

@patch("myapp.services.cache")
def test_cached_lookup(mock_cache):
    mock_cache.get.return_value = "cached_value"
    result = lookup("key")
    mock_cache.get.assert_called_once_with("key")

# AFTER: tripwire
def test_cached_lookup():
    cache_mock = tripwire.mock("myapp.services:cache")
    cache_mock.get.returns("cached_value")

    with tripwire:
        result = lookup("key")

    cache_mock.get.assert_call(args=("key",), kwargs={}, returned="cached_value")

Incremental adoption

You do not have to migrate your entire test suite at once. tripwire and unittest.mock can coexist in the same project:

  1. Start in warn mode. Install tripwire and set guard = "warn" in [tool.tripwire]; the suite keeps running while every real I/O call shows up as a GuardedCallWarning you can triage.
  2. Migrate test by test. Pick tests that touch HTTP, subprocess, or database calls first -- these benefit most from tripwire's strict enforcement.
  3. Drop the override. Once coverage is high, remove guard = "warn" to fall back to the 0.20.0 default of "error" and catch any remaining leaks.

Plugins

tripwire ships with 27 plugins covering the most common external dependencies:

Category Plugins Intercepts
General MockPlugin, LoggingPlugin Named mock proxies, logging module
HTTP HttpPlugin httpx, requests, urllib, aiohttp
Subprocess SubprocessPlugin, PopenPlugin, AsyncSubprocessPlugin subprocess.run, shutil.which, Popen, asyncio.create_subprocess_*
Database DatabasePlugin, Psycopg2Plugin, AsyncpgPlugin, MongoPlugin, ElasticsearchPlugin sqlite3, psycopg2, asyncpg, pymongo, elasticsearch
Cache RedisPlugin, MemcachePlugin redis, pymemcache
Network SmtpPlugin, SocketPlugin, AsyncWebSocketPlugin, SyncWebSocketPlugin, DnsPlugin, SshPlugin, GrpcPlugin smtplib, socket, websockets, websocket-client, DNS resolution, paramiko, grpcio
Cloud & Messaging Boto3Plugin, CeleryPlugin, PikaPlugin boto3 (AWS), celery tasks, pika (RabbitMQ)
Crypto & Auth JwtPlugin, CryptoPlugin PyJWT, cryptography
System FileIoPlugin, NativePlugin open, pathlib, os; ctypes, cffi
Plugin examples

Subprocess

tripwire.subprocess.mock_run(["git", "pull"], returncode=0, stdout="Up to date.\n")

Database (sqlite3)

tripwire.db.new_session() \
    .expect("connect", returns=None) \
    .expect("execute", returns=[]) \
    .expect("commit", returns=None) \
    .expect("close", returns=None)

Redis

tripwire.redis.mock_command("GET", returns=b"cached_value")

MongoDB

tripwire.mongo.mock_operation("find_one", returns={"_id": "abc", "name": "Alice"})

AWS (boto3)

tripwire.boto3.mock_api_call("s3", "GetObject", returns={"Body": b"file contents"})

RabbitMQ (pika)

tripwire.pika.new_session() \
    .expect("connect", returns=None) \
    .expect("channel", returns=None) \
    .expect("publish", returns=None) \
    .expect("close", returns=None)

SSH (paramiko)

tripwire.ssh.new_session() \
    .expect("connect", returns=None) \
    .expect("exec_command", returns=(b"", b"output\n", b"")) \
    .expect("close", returns=None)

SMTP

tripwire.smtp.new_session() \
    .expect("connect", returns=(220, b"OK")) \
    .expect("ehlo", returns=(250, b"OK")) \
    .expect("sendmail", returns={}) \
    .expect("quit", returns=(221, b"Bye"))

Logging

tripwire.log.assert_info("User logged in", "myapp")

Mock (general)

svc = tripwire.mock("myapp.payments:PaymentService")
svc.charge.returns({"status": "ok"})

Advanced Features

Concurrent assertions -- relax FIFO ordering for parallel requests:

with tripwire.in_any_order():
    tripwire.http.assert_request(method="GET", url=".../a", headers=IsInstance(dict), body=None,
                                require_response=False)
    tripwire.http.assert_request(method="GET", url=".../b", headers=IsInstance(dict), body=None,
                                require_response=False)

Mock / spy -- composable mocks with import-site patching:

# Mock a module-level attribute
cache_mock = tripwire.mock("myapp.services:cache")
cache_mock.get.returns("cached_value")

# Mock an attribute on a specific object
mock = tripwire.mock.object(my_module, "service")

# Spy on real implementation
spy = tripwire.spy("myapp.services:cache")

Context managers -- sandbox activates all mocks and enforces assertions:

# Sandbox activates all mocks, enforces assertions
with tripwire.sandbox():
    result = code_under_test()

# Individual activation (no assertion enforcement)
with cache_mock:
    setup_code()

Error mocking -- mock exceptions and assert error interactions:

# Mock errors
tripwire.http.mock_error("GET", url, raises=httpx.ConnectError("refused"))

# Assert errors
tripwire.http.assert_request("GET", url, headers=..., body="",
                            raised=IsInstance(httpx.ConnectError))

Spy observability -- assert return values and raised exceptions:

spy.assert_call(args=("key",), kwargs={}, returned="value")
spy.assert_call(args=("bad",), kwargs={}, raised=IsInstance(KeyError))

Pass-through -- delegate to the real service, still record and require assertion:

tripwire.http.pass_through("GET", url)

Configuration via pyproject.toml:

[tool.tripwire.http]
require_response = true  # This is the default; set to false to opt out

Per-call arguments override project-level settings. See the configuration guide.

Selective Installation

python-tripwire[all] installs everything. For a smaller footprint, pick only what you need:

pip install python-tripwire                       # Core plugins (no optional deps)
pip install python-tripwire[http]                 # + httpx, requests, urllib
pip install python-tripwire[aiohttp]              # + aiohttp
pip install python-tripwire[redis]                # + Redis
pip install python-tripwire[pymemcache]           # + Memcached
pip install python-tripwire[pymongo]              # + MongoDB
pip install python-tripwire[elasticsearch]        # + Elasticsearch/OpenSearch
pip install python-tripwire[psycopg2]             # + PostgreSQL (psycopg2)
pip install python-tripwire[asyncpg]              # + PostgreSQL (asyncpg)
pip install python-tripwire[boto3]                # + AWS SDK
pip install python-tripwire[pika]                 # + RabbitMQ
pip install python-tripwire[celery]               # + Celery tasks
pip install python-tripwire[grpc]                 # + gRPC
pip install python-tripwire[paramiko]             # + SSH
pip install python-tripwire[jwt]                  # + PyJWT
pip install python-tripwire[crypto]               # + cryptography
pip install python-tripwire[cffi]                 # + cffi (C FFI)
pip install python-tripwire[websockets]           # + async WebSocket
pip install python-tripwire[websocket-client]     # + sync WebSocket
pip install python-tripwire[matchers]             # + dirty-equals matchers

Documentation

Full API reference, plugin guides, and advanced usage: axiomantic.github.io/tripwire

License

MIT