1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
from dataclasses import asdict, dataclass
from typing import Optional, List
from sentry_sdk.tracing_utils import _should_be_included, Baggage
import pytest
def id_function(val):
# type: (object) -> str
if isinstance(val, ShouldBeIncludedTestCase):
return val.id
@dataclass(frozen=True)
class ShouldBeIncludedTestCase:
id: str
is_sentry_sdk_frame: bool
namespace: Optional[str] = None
in_app_include: Optional[List[str]] = None
in_app_exclude: Optional[List[str]] = None
abs_path: Optional[str] = None
project_root: Optional[str] = None
@pytest.mark.parametrize(
"test_case, expected",
[
(
ShouldBeIncludedTestCase(
id="Frame from Sentry SDK",
is_sentry_sdk_frame=True,
),
False,
),
(
ShouldBeIncludedTestCase(
id="Frame from Django installed in virtualenv inside project root",
is_sentry_sdk_frame=False,
abs_path="/home/username/some_project/.venv/lib/python3.12/site-packages/django/db/models/sql/compiler",
project_root="/home/username/some_project",
namespace="django.db.models.sql.compiler",
in_app_include=["django"],
),
True,
),
(
ShouldBeIncludedTestCase(
id="Frame from project",
is_sentry_sdk_frame=False,
abs_path="/home/username/some_project/some_project/__init__.py",
project_root="/home/username/some_project",
namespace="some_project",
),
True,
),
(
ShouldBeIncludedTestCase(
id="Frame from project module in `in_app_exclude`",
is_sentry_sdk_frame=False,
abs_path="/home/username/some_project/some_project/exclude_me/some_module.py",
project_root="/home/username/some_project",
namespace="some_project.exclude_me.some_module",
in_app_exclude=["some_project.exclude_me"],
),
False,
),
(
ShouldBeIncludedTestCase(
id="Frame from system-wide installed Django",
is_sentry_sdk_frame=False,
abs_path="/usr/lib/python3.12/site-packages/django/db/models/sql/compiler",
project_root="/home/username/some_project",
namespace="django.db.models.sql.compiler",
),
False,
),
(
ShouldBeIncludedTestCase(
id="Frame from system-wide installed Django with `django` in `in_app_include`",
is_sentry_sdk_frame=False,
abs_path="/usr/lib/python3.12/site-packages/django/db/models/sql/compiler",
project_root="/home/username/some_project",
namespace="django.db.models.sql.compiler",
in_app_include=["django"],
),
True,
),
],
ids=id_function,
)
def test_should_be_included(test_case, expected):
# type: (ShouldBeIncludedTestCase, bool) -> None
"""Checking logic, see: https://github.com/getsentry/sentry-python/issues/3312"""
kwargs = asdict(test_case)
kwargs.pop("id")
assert _should_be_included(**kwargs) == expected
@pytest.mark.parametrize(
("header", "expected"),
(
("", ""),
("foo=bar", "foo=bar"),
(" foo=bar, baz = qux ", " foo=bar, baz = qux "),
("sentry-trace_id=123", ""),
(" sentry-trace_id = 123 ", ""),
("sentry-trace_id=123,sentry-public_key=456", ""),
("foo=bar,sentry-trace_id=123", "foo=bar"),
("foo=bar,sentry-trace_id=123,baz=qux", "foo=bar,baz=qux"),
(
"foo=bar,sentry-trace_id=123,baz=qux,sentry-public_key=456",
"foo=bar,baz=qux",
),
),
)
def test_strip_sentry_baggage(header, expected):
assert Baggage.strip_sentry_baggage(header) == expected
@pytest.mark.parametrize(
("baggage", "expected_repr"),
(
(Baggage(sentry_items={}), '<Baggage "", mutable=True>'),
(Baggage(sentry_items={}, mutable=False), '<Baggage "", mutable=False>'),
(
Baggage(sentry_items={"foo": "bar"}),
'<Baggage "sentry-foo=bar,", mutable=True>',
),
(
Baggage(sentry_items={"foo": "bar"}, mutable=False),
'<Baggage "sentry-foo=bar,", mutable=False>',
),
(
Baggage(sentry_items={"foo": "bar"}, third_party_items="asdf=1234,"),
'<Baggage "sentry-foo=bar,asdf=1234,", mutable=True>',
),
(
Baggage(
sentry_items={"foo": "bar"},
third_party_items="asdf=1234,",
mutable=False,
),
'<Baggage "sentry-foo=bar,asdf=1234,", mutable=False>',
),
),
)
def test_baggage_repr(baggage, expected_repr):
assert repr(baggage) == expected_repr
|
