forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_scope.py
More file actions
1075 lines (826 loc) · 33.8 KB
/
Copy pathtest_scope.py
File metadata and controls
1075 lines (826 loc) · 33.8 KB
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import copy
import os
from unittest import mock
import pytest
import sentry_sdk
from sentry_sdk import (
capture_exception,
isolation_scope,
new_scope,
)
from sentry_sdk.client import Client, NonRecordingClient
from sentry_sdk.scope import (
Scope,
ScopeType,
register_external_propagation_context,
remove_external_propagation_context,
should_send_default_pii,
use_isolation_scope,
use_scope,
)
def test_copying():
s1 = Scope()
s1.fingerprint = {}
s1.set_tag("foo", "bar")
s2 = copy.copy(s1)
assert "foo" in s2._tags
s1.set_tag("bam", "baz")
assert "bam" in s1._tags
assert "bam" not in s2._tags
assert s1._fingerprint is s2._fingerprint
def test_all_slots_copied():
scope = Scope()
scope_copy = copy.copy(scope)
# Check all attributes are copied
for attr in set(Scope.__slots__):
assert getattr(scope_copy, attr) == getattr(scope, attr)
def test_scope_flags_copy():
# Assert forking creates a deepcopy of the flag buffer. The new
# scope is free to mutate without consequence to the old scope. The
# old scope is free to mutate without consequence to the new scope.
old_scope = Scope()
old_scope.flags.set("a", True)
new_scope = old_scope.fork()
new_scope.flags.set("a", False)
old_scope.flags.set("b", True)
new_scope.flags.set("c", True)
assert old_scope.flags.get() == [
{"flag": "a", "result": True},
{"flag": "b", "result": True},
]
assert new_scope.flags.get() == [
{"flag": "a", "result": False},
{"flag": "c", "result": True},
]
def test_merging(sentry_init, capture_events):
sentry_init()
s = Scope()
s.set_user({"id": "42"})
events = capture_events()
capture_exception(NameError(), scope=s)
(event,) = events
assert event["user"] == {"id": "42"}
def test_common_args():
s = Scope()
s.update_from_kwargs(
user={"id": 23},
level="warning",
extras={"k": "v"},
contexts={"os": {"name": "Blafasel"}},
tags={"x": "y"},
fingerprint=["foo"],
)
s2 = Scope()
s2.set_extra("foo", "bar")
s2.set_tag("a", "b")
s2.set_context("device", {"a": "b"})
s2.update_from_scope(s)
assert s._user == {"id": 23}
assert s._level == "warning"
assert s._extras == {"k": "v"}
assert s._contexts == {"os": {"name": "Blafasel"}}
assert s._tags == {"x": "y"}
assert s._fingerprint == ["foo"]
assert s._user == s2._user
assert s._level == s2._level
assert s._fingerprint == s2._fingerprint
assert s2._extras == {"k": "v", "foo": "bar"}
assert s2._tags == {"a": "b", "x": "y"}
assert s2._contexts == {"os": {"name": "Blafasel"}, "device": {"a": "b"}}
BAGGAGE_VALUE = (
"other-vendor-value-1=foo;bar;baz, sentry-trace_id=771a43a4192642f0b136d5159a501700, "
"sentry-public_key=49d0f7386ad645858ae85020e393bef3, sentry-sample_rate=0.01337, "
"sentry-user_id=Am%C3%A9lie, other-vendor-value-2=foo;bar;"
)
SENTRY_TRACE_VALUE = "771a43a4192642f0b136d5159a501700-1234567890abcdef-1"
@pytest.mark.parametrize(
"env,excepted_value",
[
(
{
"SENTRY_TRACE": SENTRY_TRACE_VALUE,
},
{
"sentry-trace": SENTRY_TRACE_VALUE,
},
),
(
{
"SENTRY_BAGGAGE": BAGGAGE_VALUE,
},
{
"baggage": BAGGAGE_VALUE,
},
),
(
{
"SENTRY_TRACE": SENTRY_TRACE_VALUE,
"SENTRY_BAGGAGE": BAGGAGE_VALUE,
},
{
"sentry-trace": SENTRY_TRACE_VALUE,
"baggage": BAGGAGE_VALUE,
},
),
(
{
"SENTRY_USE_ENVIRONMENT": "",
"SENTRY_TRACE": SENTRY_TRACE_VALUE,
"SENTRY_BAGGAGE": BAGGAGE_VALUE,
},
{
"sentry-trace": SENTRY_TRACE_VALUE,
"baggage": BAGGAGE_VALUE,
},
),
(
{
"SENTRY_USE_ENVIRONMENT": "True",
"SENTRY_TRACE": SENTRY_TRACE_VALUE,
"SENTRY_BAGGAGE": BAGGAGE_VALUE,
},
{
"sentry-trace": SENTRY_TRACE_VALUE,
"baggage": BAGGAGE_VALUE,
},
),
(
{
"SENTRY_USE_ENVIRONMENT": "no",
"SENTRY_TRACE": SENTRY_TRACE_VALUE,
"SENTRY_BAGGAGE": BAGGAGE_VALUE,
},
None,
),
(
{
"SENTRY_USE_ENVIRONMENT": "True",
"MY_OTHER_VALUE": "asdf",
"SENTRY_RELEASE": "1.0.0",
},
None,
),
],
)
def test_load_trace_data_from_env(env, excepted_value):
new_env = os.environ.copy()
new_env.update(env)
with mock.patch.dict(os.environ, new_env):
s = Scope()
incoming_trace_data = s._load_trace_data_from_env()
assert incoming_trace_data == excepted_value
def test_scope_client():
scope = Scope(ty="test_something")
assert scope._type == "test_something"
assert scope.client is not None
assert scope.client.__class__ == NonRecordingClient
custom_client = Client()
scope = Scope(ty="test_more", client=custom_client)
assert scope._type == "test_more"
assert scope.client is not None
assert scope.client.__class__ == Client
assert scope.client == custom_client
def test_get_current_scope():
scope = Scope.get_current_scope()
assert scope is not None
assert scope.__class__ == Scope
assert scope._type == ScopeType.CURRENT
def test_get_isolation_scope():
scope = Scope.get_isolation_scope()
assert scope is not None
assert scope.__class__ == Scope
assert scope._type == ScopeType.ISOLATION
def test_get_global_scope():
scope = Scope.get_global_scope()
assert scope is not None
assert scope.__class__ == Scope
assert scope._type == ScopeType.GLOBAL
def test_get_client():
client = Scope.get_client()
assert client is not None
assert client.__class__ == NonRecordingClient
assert not client.is_active()
def test_set_client():
client1 = Client()
client2 = Client()
client3 = Client()
current_scope = Scope.get_current_scope()
isolation_scope = Scope.get_isolation_scope()
global_scope = Scope.get_global_scope()
current_scope.set_client(client1)
isolation_scope.set_client(client2)
global_scope.set_client(client3)
client = Scope.get_client()
assert client == client1
current_scope.set_client(None)
isolation_scope.set_client(client2)
global_scope.set_client(client3)
client = Scope.get_client()
assert client == client2
current_scope.set_client(None)
isolation_scope.set_client(None)
global_scope.set_client(client3)
client = Scope.get_client()
assert client == client3
def test_fork():
scope = Scope()
forked_scope = scope.fork()
assert scope != forked_scope
def test_get_global_scope_tags():
global_scope1 = Scope.get_global_scope()
global_scope2 = Scope.get_global_scope()
assert global_scope1 == global_scope2
assert global_scope1.client.__class__ == NonRecordingClient
assert not global_scope1.client.is_active()
assert global_scope2.client.__class__ == NonRecordingClient
assert not global_scope2.client.is_active()
global_scope1.set_tag("tag1", "value")
tags_scope1 = global_scope1._tags
tags_scope2 = global_scope2._tags
assert tags_scope1 == tags_scope2 == {"tag1": "value"}
assert global_scope1.client.__class__ == NonRecordingClient
assert not global_scope1.client.is_active()
assert global_scope2.client.__class__ == NonRecordingClient
assert not global_scope2.client.is_active()
def test_get_global_with_scope():
original_global_scope = Scope.get_global_scope()
with new_scope() as scope:
in_with_global_scope = Scope.get_global_scope()
assert scope is not in_with_global_scope
assert in_with_global_scope is original_global_scope
after_with_global_scope = Scope.get_global_scope()
assert after_with_global_scope is original_global_scope
def test_get_global_with_isolation_scope():
original_global_scope = Scope.get_global_scope()
with isolation_scope() as scope:
in_with_global_scope = Scope.get_global_scope()
assert scope is not in_with_global_scope
assert in_with_global_scope is original_global_scope
after_with_global_scope = Scope.get_global_scope()
assert after_with_global_scope is original_global_scope
def test_get_isolation_scope_tags():
isolation_scope1 = Scope.get_isolation_scope()
isolation_scope2 = Scope.get_isolation_scope()
assert isolation_scope1 == isolation_scope2
assert isolation_scope1.client.__class__ == NonRecordingClient
assert not isolation_scope1.client.is_active()
assert isolation_scope2.client.__class__ == NonRecordingClient
assert not isolation_scope2.client.is_active()
isolation_scope1.set_tag("tag1", "value")
tags_scope1 = isolation_scope1._tags
tags_scope2 = isolation_scope2._tags
assert tags_scope1 == tags_scope2 == {"tag1": "value"}
assert isolation_scope1.client.__class__ == NonRecordingClient
assert not isolation_scope1.client.is_active()
assert isolation_scope2.client.__class__ == NonRecordingClient
assert not isolation_scope2.client.is_active()
def test_get_current_scope_tags():
scope1 = Scope.get_current_scope()
scope2 = Scope.get_current_scope()
assert id(scope1) == id(scope2)
assert scope1.client.__class__ == NonRecordingClient
assert not scope1.client.is_active()
assert scope2.client.__class__ == NonRecordingClient
assert not scope2.client.is_active()
scope1.set_tag("tag1", "value")
tags_scope1 = scope1._tags
tags_scope2 = scope2._tags
assert tags_scope1 == tags_scope2 == {"tag1": "value"}
assert scope1.client.__class__ == NonRecordingClient
assert not scope1.client.is_active()
assert scope2.client.__class__ == NonRecordingClient
assert not scope2.client.is_active()
def test_with_isolation_scope():
original_current_scope = Scope.get_current_scope()
original_isolation_scope = Scope.get_isolation_scope()
with isolation_scope() as scope:
assert scope._type == ScopeType.ISOLATION
in_with_current_scope = Scope.get_current_scope()
in_with_isolation_scope = Scope.get_isolation_scope()
assert scope is in_with_isolation_scope
assert in_with_current_scope is not original_current_scope
assert in_with_isolation_scope is not original_isolation_scope
after_with_current_scope = Scope.get_current_scope()
after_with_isolation_scope = Scope.get_isolation_scope()
assert after_with_current_scope is original_current_scope
assert after_with_isolation_scope is original_isolation_scope
def test_with_isolation_scope_data():
"""
When doing `with isolation_scope()` the isolation *and* the current scope are forked,
to prevent that by setting tags on the current scope in the context manager, data
bleeds to the outer current scope.
"""
isolation_scope_before = Scope.get_isolation_scope()
current_scope_before = Scope.get_current_scope()
isolation_scope_before.set_tag("before_isolation_scope", 1)
current_scope_before.set_tag("before_current_scope", 1)
with isolation_scope() as scope:
assert scope._type == ScopeType.ISOLATION
isolation_scope_in = Scope.get_isolation_scope()
current_scope_in = Scope.get_current_scope()
assert isolation_scope_in._tags == {"before_isolation_scope": 1}
assert current_scope_in._tags == {"before_current_scope": 1}
assert scope._tags == {"before_isolation_scope": 1}
scope.set_tag("in_with_scope", 1)
assert isolation_scope_in._tags == {
"before_isolation_scope": 1,
"in_with_scope": 1,
}
assert current_scope_in._tags == {"before_current_scope": 1}
assert scope._tags == {"before_isolation_scope": 1, "in_with_scope": 1}
isolation_scope_in.set_tag("in_with_isolation_scope", 1)
assert isolation_scope_in._tags == {
"before_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {"before_current_scope": 1}
assert scope._tags == {
"before_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
current_scope_in.set_tag("in_with_current_scope", 1)
assert isolation_scope_in._tags == {
"before_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {
"before_current_scope": 1,
"in_with_current_scope": 1,
}
assert scope._tags == {
"before_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
isolation_scope_after = Scope.get_isolation_scope()
current_scope_after = Scope.get_current_scope()
isolation_scope_after.set_tag("after_isolation_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"after_isolation_scope": 1,
}
assert current_scope_after._tags == {"before_current_scope": 1}
current_scope_after.set_tag("after_current_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"after_isolation_scope": 1,
}
assert current_scope_after._tags == {
"before_current_scope": 1,
"after_current_scope": 1,
}
def test_with_use_isolation_scope():
original_isolation_scope = Scope.get_isolation_scope()
original_current_scope = Scope.get_current_scope()
custom_isolation_scope = Scope()
with use_isolation_scope(custom_isolation_scope) as scope:
assert scope._type is None # our custom scope has not type set
in_with_isolation_scope = Scope.get_isolation_scope()
in_with_current_scope = Scope.get_current_scope()
assert scope is custom_isolation_scope
assert scope is in_with_isolation_scope
assert scope is not in_with_current_scope
assert scope is not original_isolation_scope
assert scope is not original_current_scope
assert in_with_isolation_scope is not original_isolation_scope
assert in_with_current_scope is not original_current_scope
after_with_current_scope = Scope.get_current_scope()
after_with_isolation_scope = Scope.get_isolation_scope()
assert after_with_isolation_scope is original_isolation_scope
assert after_with_current_scope is original_current_scope
assert after_with_isolation_scope is not custom_isolation_scope
assert after_with_current_scope is not custom_isolation_scope
def test_with_use_isolation_scope_data():
isolation_scope_before = Scope.get_isolation_scope()
current_scope_before = Scope.get_current_scope()
custom_isolation_scope = Scope()
isolation_scope_before.set_tag("before_isolation_scope", 1)
current_scope_before.set_tag("before_current_scope", 1)
custom_isolation_scope.set_tag("before_custom_isolation_scope", 1)
with use_isolation_scope(custom_isolation_scope) as scope:
assert scope._type is None # our custom scope has not type set
isolation_scope_in = Scope.get_isolation_scope()
current_scope_in = Scope.get_current_scope()
assert isolation_scope_in._tags == {"before_custom_isolation_scope": 1}
assert current_scope_in._tags == {"before_current_scope": 1}
assert scope._tags == {"before_custom_isolation_scope": 1}
scope.set_tag("in_with_scope", 1)
assert isolation_scope_in._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
}
assert current_scope_in._tags == {"before_current_scope": 1}
assert scope._tags == {"before_custom_isolation_scope": 1, "in_with_scope": 1}
isolation_scope_in.set_tag("in_with_isolation_scope", 1)
assert isolation_scope_in._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {"before_current_scope": 1}
assert scope._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
current_scope_in.set_tag("in_with_current_scope", 1)
assert isolation_scope_in._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {
"before_current_scope": 1,
"in_with_current_scope": 1,
}
assert scope._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
assert custom_isolation_scope._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
isolation_scope_after = Scope.get_isolation_scope()
current_scope_after = Scope.get_current_scope()
isolation_scope_after.set_tag("after_isolation_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"after_isolation_scope": 1,
}
assert current_scope_after._tags == {"before_current_scope": 1}
assert custom_isolation_scope._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
current_scope_after.set_tag("after_current_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"after_isolation_scope": 1,
}
assert current_scope_after._tags == {
"before_current_scope": 1,
"after_current_scope": 1,
}
assert custom_isolation_scope._tags == {
"before_custom_isolation_scope": 1,
"in_with_scope": 1,
"in_with_isolation_scope": 1,
}
def test_with_new_scope():
original_current_scope = Scope.get_current_scope()
original_isolation_scope = Scope.get_isolation_scope()
with new_scope() as scope:
assert scope._type == ScopeType.CURRENT
in_with_current_scope = Scope.get_current_scope()
in_with_isolation_scope = Scope.get_isolation_scope()
assert scope is in_with_current_scope
assert in_with_current_scope is not original_current_scope
assert in_with_isolation_scope is original_isolation_scope
after_with_current_scope = Scope.get_current_scope()
after_with_isolation_scope = Scope.get_isolation_scope()
assert after_with_current_scope is original_current_scope
assert after_with_isolation_scope is original_isolation_scope
def test_with_new_scope_data():
"""
When doing `with new_scope()` the current scope is forked but the isolation
scope stays untouched.
"""
isolation_scope_before = Scope.get_isolation_scope()
current_scope_before = Scope.get_current_scope()
isolation_scope_before.set_tag("before_isolation_scope", 1)
current_scope_before.set_tag("before_current_scope", 1)
with new_scope() as scope:
assert scope._type == ScopeType.CURRENT
isolation_scope_in = Scope.get_isolation_scope()
current_scope_in = Scope.get_current_scope()
assert isolation_scope_in._tags == {"before_isolation_scope": 1}
assert current_scope_in._tags == {"before_current_scope": 1}
assert scope._tags == {"before_current_scope": 1}
scope.set_tag("in_with_scope", 1)
assert isolation_scope_in._tags == {"before_isolation_scope": 1}
assert current_scope_in._tags == {"before_current_scope": 1, "in_with_scope": 1}
assert scope._tags == {"before_current_scope": 1, "in_with_scope": 1}
isolation_scope_in.set_tag("in_with_isolation_scope", 1)
assert isolation_scope_in._tags == {
"before_isolation_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {"before_current_scope": 1, "in_with_scope": 1}
assert scope._tags == {"before_current_scope": 1, "in_with_scope": 1}
current_scope_in.set_tag("in_with_current_scope", 1)
assert isolation_scope_in._tags == {
"before_isolation_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {
"before_current_scope": 1,
"in_with_scope": 1,
"in_with_current_scope": 1,
}
assert scope._tags == {
"before_current_scope": 1,
"in_with_scope": 1,
"in_with_current_scope": 1,
}
isolation_scope_after = Scope.get_isolation_scope()
current_scope_after = Scope.get_current_scope()
isolation_scope_after.set_tag("after_isolation_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"in_with_isolation_scope": 1,
"after_isolation_scope": 1,
}
assert current_scope_after._tags == {"before_current_scope": 1}
current_scope_after.set_tag("after_current_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"in_with_isolation_scope": 1,
"after_isolation_scope": 1,
}
assert current_scope_after._tags == {
"before_current_scope": 1,
"after_current_scope": 1,
}
def test_with_use_scope_data():
isolation_scope_before = Scope.get_isolation_scope()
current_scope_before = Scope.get_current_scope()
custom_current_scope = Scope()
isolation_scope_before.set_tag("before_isolation_scope", 1)
current_scope_before.set_tag("before_current_scope", 1)
custom_current_scope.set_tag("before_custom_current_scope", 1)
with use_scope(custom_current_scope) as scope:
assert scope._type is None # our custom scope has not type set
isolation_scope_in = Scope.get_isolation_scope()
current_scope_in = Scope.get_current_scope()
assert isolation_scope_in._tags == {"before_isolation_scope": 1}
assert current_scope_in._tags == {"before_custom_current_scope": 1}
assert scope._tags == {"before_custom_current_scope": 1}
scope.set_tag("in_with_scope", 1)
assert isolation_scope_in._tags == {"before_isolation_scope": 1}
assert current_scope_in._tags == {
"before_custom_current_scope": 1,
"in_with_scope": 1,
}
assert scope._tags == {"before_custom_current_scope": 1, "in_with_scope": 1}
isolation_scope_in.set_tag("in_with_isolation_scope", 1)
assert isolation_scope_in._tags == {
"before_isolation_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {
"before_custom_current_scope": 1,
"in_with_scope": 1,
}
assert scope._tags == {"before_custom_current_scope": 1, "in_with_scope": 1}
current_scope_in.set_tag("in_with_current_scope", 1)
assert isolation_scope_in._tags == {
"before_isolation_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_in._tags == {
"before_custom_current_scope": 1,
"in_with_scope": 1,
"in_with_current_scope": 1,
}
assert scope._tags == {
"before_custom_current_scope": 1,
"in_with_scope": 1,
"in_with_current_scope": 1,
}
assert custom_current_scope._tags == {
"before_custom_current_scope": 1,
"in_with_scope": 1,
"in_with_current_scope": 1,
}
isolation_scope_after = Scope.get_isolation_scope()
current_scope_after = Scope.get_current_scope()
isolation_scope_after.set_tag("after_isolation_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"after_isolation_scope": 1,
"in_with_isolation_scope": 1,
}
assert current_scope_after._tags == {"before_current_scope": 1}
assert custom_current_scope._tags == {
"before_custom_current_scope": 1,
"in_with_scope": 1,
"in_with_current_scope": 1,
}
current_scope_after.set_tag("after_current_scope", 1)
assert isolation_scope_after._tags == {
"before_isolation_scope": 1,
"in_with_isolation_scope": 1,
"after_isolation_scope": 1,
}
assert current_scope_after._tags == {
"before_current_scope": 1,
"after_current_scope": 1,
}
assert custom_current_scope._tags == {
"before_custom_current_scope": 1,
"in_with_scope": 1,
"in_with_current_scope": 1,
}
def test_nested_scopes_with_tags(sentry_init, capture_envelopes):
sentry_init(traces_sample_rate=1.0)
envelopes = capture_envelopes()
with sentry_sdk.isolation_scope() as scope1:
scope1.set_tag("isolation_scope1", 1)
with sentry_sdk.new_scope() as scope2:
scope2.set_tag("current_scope2", 1)
with sentry_sdk.start_transaction(name="trx") as trx:
trx.set_tag("trx", 1)
with sentry_sdk.start_span(op="span1") as span1:
span1.set_tag("a", 1)
with new_scope() as scope3:
scope3.set_tag("current_scope3", 1)
with sentry_sdk.start_span(op="span2") as span2:
span2.set_tag("b", 1)
(envelope,) = envelopes
transaction = envelope.items[0].get_transaction_event()
assert transaction["tags"] == {"isolation_scope1": 1, "current_scope2": 1, "trx": 1}
assert transaction["spans"][0]["tags"] == {"a": 1}
assert transaction["spans"][1]["tags"] == {"b": 1}
def test_should_send_default_pii_true(sentry_init):
sentry_init(send_default_pii=True)
assert should_send_default_pii() is True
def test_should_send_default_pii_false(sentry_init):
sentry_init(send_default_pii=False)
assert should_send_default_pii() is False
def test_should_send_default_pii_default_false(sentry_init):
sentry_init()
assert should_send_default_pii() is False
def test_should_send_default_pii_false_with_dsn_and_spotlight(sentry_init):
sentry_init(dsn="http://key@localhost/1", spotlight=True)
assert should_send_default_pii() is False
def test_should_send_default_pii_true_without_dsn_and_spotlight(sentry_init):
sentry_init(spotlight=True)
assert should_send_default_pii() is True
def test_set_tags():
scope = Scope()
scope.set_tags({"tag1": "value1", "tag2": "value2"})
event = scope.apply_to_event({}, {})
assert event["tags"] == {"tag1": "value1", "tag2": "value2"}, "Setting tags failed"
scope.set_tags({"tag2": "updated", "tag3": "new"})
event = scope.apply_to_event({}, {})
assert event["tags"] == {
"tag1": "value1",
"tag2": "updated",
"tag3": "new",
}, "Updating tags failed"
scope.set_tags({})
event = scope.apply_to_event({}, {})
assert event["tags"] == {
"tag1": "value1",
"tag2": "updated",
"tag3": "new",
}, "Updating tags with empty dict changed tags"
def test_last_event_id(sentry_init):
sentry_init(traces_sample_rate=1.0)
assert Scope.last_event_id() is None
sentry_sdk.capture_exception(Exception("test"))
assert Scope.last_event_id() is not None
def test_last_event_id_transaction(sentry_init):
sentry_init(traces_sample_rate=1.0)
assert Scope.last_event_id() is None
with sentry_sdk.start_transaction(name="test"):
pass
assert Scope.last_event_id() is None, "Transaction should not set last_event_id"
def test_last_event_id_cleared(sentry_init):
sentry_init(traces_sample_rate=1.0)
# Make sure last_event_id is set
sentry_sdk.capture_exception(Exception("test"))
assert Scope.last_event_id() is not None
# Clearing the isolation scope should clear the last_event_id
Scope.get_isolation_scope().clear()
assert Scope.last_event_id() is None, "last_event_id should be cleared"
@pytest.mark.tests_internal_exceptions
@pytest.mark.parametrize("error_cls", [LookupError, ValueError])
@pytest.mark.parametrize(
"scope_manager",
[
new_scope,
use_scope,
],
)
def test_handle_error_on_token_reset_current_scope(error_cls, scope_manager):
with mock.patch("sentry_sdk.scope.capture_internal_exception") as mock_capture:
with mock.patch("sentry_sdk.scope._current_scope") as mock_token_var:
mock_token_var.reset.side_effect = error_cls()
mock_token = mock.Mock()
mock_token_var.set.return_value = mock_token
try:
if scope_manager == use_scope:
with scope_manager(Scope()):
pass
else:
with scope_manager():
pass
except Exception:
pytest.fail(f"Context manager should handle {error_cls} gracefully")
mock_capture.assert_called_once()
mock_token_var.reset.assert_called_once_with(mock_token)
@pytest.mark.tests_internal_exceptions
@pytest.mark.parametrize("error_cls", [LookupError, ValueError])
@pytest.mark.parametrize(
"scope_manager",
[
isolation_scope,
use_isolation_scope,
],
)
def test_handle_error_on_token_reset_isolation_scope(error_cls, scope_manager):
with mock.patch("sentry_sdk.scope.capture_internal_exception") as mock_capture:
with mock.patch("sentry_sdk.scope._current_scope") as mock_current_scope:
with mock.patch(
"sentry_sdk.scope._isolation_scope"
) as mock_isolation_scope:
mock_isolation_scope.reset.side_effect = error_cls()
mock_current_token = mock.Mock()
mock_current_scope.set.return_value = mock_current_token
try:
if scope_manager == use_isolation_scope:
with scope_manager(Scope()):
pass
else:
with scope_manager():
pass
except Exception:
pytest.fail(f"Context manager should handle {error_cls} gracefully")
mock_capture.assert_called_once()
mock_current_scope.reset.assert_called_once_with(mock_current_token)
def test_trace_context_tracing(sentry_init):
sentry_init(traces_sample_rate=1.0)
with sentry_sdk.start_transaction(name="trx") as transaction:
with sentry_sdk.start_span(op="span1"):
with sentry_sdk.start_span(op="span2") as span:
trace_context = sentry_sdk.get_current_scope().get_trace_context()
assert trace_context["trace_id"] == transaction.trace_id
assert trace_context["span_id"] == span.span_id
assert trace_context["parent_span_id"] == span.parent_span_id
assert "dynamic_sampling_context" in trace_context
def test_trace_context_external_tracing(sentry_init):
sentry_init()
def external_propagation_context():
return ("trace_id_foo", "span_id_bar")
register_external_propagation_context(external_propagation_context)