Skip to content

chore: Adapt more tests #7459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sentrivana merged 2 commits into from
Sep 10, 2026
Merged

chore: Adapt more tests #7459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92e6f1e
chore: Adapt more tests, set transaction name on scope
sentrivana Sep 10, 2026
315dad7
.
sentrivana Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
316 changes: 7 additions & 309 deletions tests/tracing/test_misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,177 +1,12 @@
from unittest import mock
from unittest.mock import MagicMock

import pytest

import sentry_sdk
from sentry_sdk import start_span, start_transaction
from sentry_sdk.consts import MATCH_ALL
from sentry_sdk.traces import StreamedSpan
from sentry_sdk.tracing import Span, Transaction
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import Dsn
from tests.conftest import ApproxDict


def test_span_trimming(sentry_init, capture_events):
sentry_init(traces_sample_rate=1.0, _experiments={"max_spans": 3})
events = capture_events()

with start_transaction(name="hi"):
for i in range(10):
with start_span(op="foo{}".format(i)):
pass

(event,) = events

assert len(event["spans"]) == 3

span1, span2, span3 = event["spans"]
assert span1["op"] == "foo0"
assert span2["op"] == "foo1"
assert span3["op"] == "foo2"

assert event["_meta"]["spans"][""]["len"] == 10
assert "_dropped_spans" not in event
assert "dropped_spans" not in event


def test_span_trimming_produces_client_report(
sentry_init, capture_events, capture_record_lost_event_calls
):
sentry_init(traces_sample_rate=1.0, _experiments={"max_spans": 3})
events = capture_events()
record_lost_event_calls = capture_record_lost_event_calls()

with start_transaction(name="hi"):
for i in range(10):
with start_span(op="foo{}".format(i)):
pass

(event,) = events

assert len(event["spans"]) == 3

# 7 spans were dropped (10 total - 3 kept = 7 dropped)
assert ("buffer_overflow", "span", None, 7) in record_lost_event_calls


def test_span_data_scrubbing_and_trimming(sentry_init, capture_events):
sentry_init(traces_sample_rate=1.0, _experiments={"max_spans": 3})
events = capture_events()

with start_transaction(name="hi"):
with start_span(op="foo", name="bar") as span:
span.set_data("password", "secret")
span.set_data("datafoo", "databar")

for i in range(10):
with start_span(op="foo{}".format(i)):
pass

(event,) = events
assert event["spans"][0]["data"] == ApproxDict(
{"password": "[Filtered]", "datafoo": "databar"}
)
assert event["_meta"]["spans"] == {
"0": {"data": {"password": {"": {"rem": [["!config", "s"]]}}}},
"": {"len": 11},
}


def test_transaction_naming(sentry_init, capture_events):
sentry_init(traces_sample_rate=1.0)
events = capture_events()

# default name in event if no name is passed
with start_transaction() as transaction:
pass
assert len(events) == 1
assert events[0]["transaction"] == "<unlabeled transaction>"

# the name can be set once the transaction's already started
with start_transaction() as transaction:
transaction.name = "name-known-after-transaction-started"
assert len(events) == 2
assert events[1]["transaction"] == "name-known-after-transaction-started"

# passing in a name works, too
with start_transaction(name="a"):
pass
assert len(events) == 3
assert events[2]["transaction"] == "a"


def test_transaction_data(sentry_init, capture_events):
sentry_init(traces_sample_rate=1.0)
events = capture_events()

with start_transaction(name="test-transaction"):
span_or_tx = sentry_sdk.get_current_span()
span_or_tx.set_data("foo", "bar")
with start_span(op="test-span") as span:
span.set_data("spanfoo", "spanbar")

assert len(events) == 1

transaction = events[0]
transaction_data = transaction["contexts"]["trace"]["data"]

assert "data" not in transaction.keys()
assert transaction_data.items() >= {"foo": "bar"}.items()

assert len(transaction["spans"]) == 1

span = transaction["spans"][0]
span_data = span["data"]

assert "contexts" not in span.keys()
assert span_data.items() >= {"spanfoo": "spanbar"}.items()


def test_start_transaction(sentry_init):
sentry_init(traces_sample_rate=1.0)

# you can have it start a transaction for you
result1 = start_transaction(
name="/interactions/other-dogs/new-dog", op="greeting.sniff"
)
assert isinstance(result1, Transaction)
assert result1.name == "/interactions/other-dogs/new-dog"
assert result1.op == "greeting.sniff"

# or you can pass it an already-created transaction
preexisting_transaction = Transaction(
name="/interactions/other-dogs/new-dog", op="greeting.sniff"
)
result2 = start_transaction(preexisting_transaction)
assert result2 is preexisting_transaction


def test_finds_transaction_on_scope(sentry_init):
sentry_init(traces_sample_rate=1.0)

transaction = start_transaction(name="dogpark")

scope = sentry_sdk.get_current_scope()

# See note in Scope class re: getters and setters of the `transaction`
# property. For the moment, assigning to scope.transaction merely sets the
# transaction name, rather than putting the transaction on the scope, so we
# have to assign to _span directly.
scope._span = transaction

# Reading scope.property, however, does what you'd expect, and returns the
# transaction on the scope.
assert scope.transaction is not None
assert isinstance(scope.transaction, Transaction)
assert scope.transaction.name == "dogpark"

# If the transaction is also set as the span on the scope, it can be found
# by accessing _span, too.
assert scope._span is not None
assert isinstance(scope._span, Transaction)
assert scope._span.name == "dogpark"


def test_finds_segment_on_scope(sentry_init):
Expand All @@ -191,60 +26,7 @@ def test_finds_segment_on_scope(sentry_init):
assert scope._span.name == "dogpark"


def test_finds_transaction_when_descendent_span_is_on_scope(
sentry_init,
):
sentry_init(traces_sample_rate=1.0)

transaction = start_transaction(name="dogpark")
child_span = transaction.start_child(op="sniffing")

scope = sentry_sdk.get_current_scope()
scope._span = child_span

# this is the same whether it's the transaction itself or one of its
# decedents directly attached to the scope
assert scope.transaction is not None
assert isinstance(scope.transaction, Transaction)
assert scope.transaction.name == "dogpark"

# here we see that it is in fact the span on the scope, rather than the
# transaction itself
assert scope._span is not None
assert isinstance(scope._span, Span)
assert scope._span.op == "sniffing"


def test_finds_orphan_span_on_scope(sentry_init):
# this is deprecated behavior which may be removed at some point (along with
# the start_span function)
sentry_init(traces_sample_rate=1.0)

span = start_span(op="sniffing")

scope = sentry_sdk.get_current_scope()
scope._span = span

assert scope._span is not None
assert isinstance(scope._span, Span)
assert scope._span.op == "sniffing"


def test_finds_non_orphan_span_on_scope(sentry_init):
sentry_init(traces_sample_rate=1.0)

transaction = start_transaction(name="dogpark")
child_span = transaction.start_child(op="sniffing")

scope = sentry_sdk.get_current_scope()
scope._span = child_span

assert scope._span is not None
assert isinstance(scope._span, Span)
assert scope._span.op == "sniffing"


def test_finds_non_orphan_span_on_scope_span_streaming(sentry_init):
def test_finds_span_on_scope(sentry_init):
sentry_init(
traces_sample_rate=1.0,
trace_lifecycle="stream",
Expand Down Expand Up @@ -335,97 +117,13 @@ def test_should_propagate_trace_to_sentry(
assert should_propagate_trace(client, url) == expected_propagation_decision


def test_start_transaction_updates_scope_name_source(sentry_init):
sentry_init(traces_sample_rate=1.0)
def test_start_transaction_updates_scope_name(sentry_init):
sentry_init(traces_sample_rate=1.0, trace_lifecycle="stream")

scope = sentry_sdk.get_current_scope()

with start_transaction(name="foobar", source="route"):
with sentry_sdk.traces.start_span(
name="foobar", attributes={"sentry.segment.name.source": "test"}
):
assert scope._transaction == "foobar"
assert scope._transaction_info == {"source": "route"}


@pytest.mark.parametrize("sampled", (True, None))
def test_transaction_dropped_debug_not_started(sentry_init, sampled):
sentry_init(traces_sample_rate=1.0)

tx = Transaction(sampled=sampled)

with mock.patch("sentry_sdk.tracing.logger") as mock_logger:
with tx:
pass

mock_logger.debug.assert_any_call(
"Discarding transaction because it was not started with sentry_sdk.start_transaction"
)

with pytest.raises(AssertionError):
# We should NOT see the "sampled = False" message here
mock_logger.debug.assert_any_call(
"Discarding transaction because sampled = False"
)


def test_transaction_dropped_sampled_false(sentry_init):
sentry_init(traces_sample_rate=1.0)

tx = Transaction(sampled=False)

with mock.patch("sentry_sdk.tracing.logger") as mock_logger:
with sentry_sdk.start_transaction(tx):
pass

mock_logger.debug.assert_any_call("Discarding transaction because sampled = False")

with pytest.raises(AssertionError):
# We should not see the "not started" message here
mock_logger.debug.assert_any_call(
"Discarding transaction because it was not started with sentry_sdk.start_transaction"
)


def test_transaction_not_started_warning(sentry_init):
sentry_init(traces_sample_rate=1.0)

tx = Transaction()

with mock.patch("sentry_sdk.tracing.logger") as mock_logger:
with tx:
pass

mock_logger.debug.assert_any_call(
"Transaction was entered without being started with sentry_sdk.start_transaction."
"The transaction will not be sent to Sentry. To fix, start the transaction by"
"passing it to sentry_sdk.start_transaction."
)


def test_span_set_data_update_data(sentry_init, capture_events):
sentry_init(traces_sample_rate=1.0)

events = capture_events()

with sentry_sdk.start_transaction(name="test-transaction"):
with start_span(op="test-span") as span:
span.set_data("key0", "value0")
span.set_data("key1", "value1")

span.update_data(
{
"key1": "updated-value1",
"key2": "value2",
"key3": "value3",
}
)

(event,) = events
span = event["spans"][0]

assert span["data"] == {
"key0": "value0",
"key1": "updated-value1",
"key2": "value2",
"key3": "value3",
"thread.id": mock.ANY,
"thread.name": mock.ANY,
}
assert scope._transaction_info == {"source": "test"}
23 changes: 2 additions & 21 deletions tests/tracing/test_propagation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,7 @@ def test_span_in_span_iter_headers(sentry_init):
next(span_inner.iter_headers())


def test_span_in_transaction(sentry_init):
sentry_init(traces_sample_rate=1.0)

with sentry_sdk.start_transaction(op="test"):
with sentry_sdk.start_span(op="test2") as span:
# Ensure the headers are there
next(span.iter_headers())


def test_span_in_transaction_span_streaming(sentry_init):
def test_span_in_segment(sentry_init):
sentry_init(traces_sample_rate=1.0, trace_lifecycle="stream")

with sentry_sdk.traces.start_span(name="test"):
Expand All @@ -40,17 +31,7 @@ def test_span_in_transaction_span_streaming(sentry_init):
next(span._iter_headers())


def test_span_in_span_in_transaction(sentry_init):
sentry_init(traces_sample_rate=1.0)

with sentry_sdk.start_transaction(op="test"):
with sentry_sdk.start_span(op="test2"):
with sentry_sdk.start_span(op="test3") as span_inner:
# Ensure the headers are there
next(span_inner.iter_headers())


def test_span_in_span_in_transaction_span_streaming(sentry_init):
def test_span_in_span_in_segment(sentry_init):
sentry_init(traces_sample_rate=1.0, trace_lifecycle="stream")

with sentry_sdk.traces.start_span(name="test"):
Expand Down
Loading
Loading