Function test_request_headers_local_is_scrubbed

tests/test_telemetry.py:146–170

The `headers` local in codeplain_REST_api.post_request holds the API key (X-API-Key); the whole variable must be filtered from stack traces.

(transport)

def test_request_headers_local_is_scrubbed(transport):
    """The `headers` local in codeplain_REST_api.post_request holds the API key
    (X-API-Key); the whole variable must be filtered from stack traces."""
    init_with_transport(transport)

    # Built at runtime so the secret never appears in the source-context lines
    # that Sentry attaches to stack frames.
    secret = "".join(["super", "-secret-", "key"])

    def crash_with_headers_local():
        headers = {"X-API-Key": secret, "Content-Type": "application/json"}  # noqa: F841
        raise KeyError("boom")

    try:
        crash_with_headers_local()
    except KeyError:
        exc_info = sys.exc_info()

    assert capture_crash(exc_info, None, make_args())
    sentry_sdk.flush(timeout=2)

    frames = transport.events[0]["exception"]["values"][0]["stacktrace"]["frames"]
    crash_frame_vars = frames[-1]["vars"]
    assert crash_frame_vars["headers"] == "[Filtered]"
    assert secret not in json.dumps(transport.events[0], default=str)


def test_nested_sensitive_keys_are_scrubbed(transport):