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
|
import uuid
from unittest import mock
import pytest
import sentry_sdk
from sentry_sdk.crons import capture_checkin
@sentry_sdk.monitor(monitor_slug="abc123")
def _hello_world(name):
return "Hello, {}".format(name)
@sentry_sdk.monitor(monitor_slug="def456")
def _break_world(name):
1 / 0
return "Hello, {}".format(name)
def _hello_world_contextmanager(name):
with sentry_sdk.monitor(monitor_slug="abc123"):
return "Hello, {}".format(name)
def _break_world_contextmanager(name):
with sentry_sdk.monitor(monitor_slug="def456"):
1 / 0
return "Hello, {}".format(name)
@sentry_sdk.monitor(monitor_slug="abc123")
async def _hello_world_async(name):
return "Hello, {}".format(name)
@sentry_sdk.monitor(monitor_slug="def456")
async def _break_world_async(name):
1 / 0
return "Hello, {}".format(name)
async def my_coroutine():
return
async def _hello_world_contextmanager_async(name):
with sentry_sdk.monitor(monitor_slug="abc123"):
await my_coroutine()
return "Hello, {}".format(name)
async def _break_world_contextmanager_async(name):
with sentry_sdk.monitor(monitor_slug="def456"):
await my_coroutine()
1 / 0
return "Hello, {}".format(name)
@sentry_sdk.monitor(monitor_slug="ghi789", monitor_config=None)
def _no_monitor_config():
return
@sentry_sdk.monitor(
monitor_slug="ghi789",
monitor_config={
"schedule": {"type": "crontab", "value": "0 0 * * *"},
"failure_issue_threshold": 5,
},
)
def _with_monitor_config():
return
def test_decorator(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
result = _hello_world("Grace")
assert result == "Hello, Grace"
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="abc123", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "abc123"
assert fake_capture_checkin.call_args[1]["status"] == "ok"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
def test_decorator_error(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
with pytest.raises(ZeroDivisionError):
result = _break_world("Grace")
assert "result" not in locals()
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="def456", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "def456"
assert fake_capture_checkin.call_args[1]["status"] == "error"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
def test_contextmanager(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
result = _hello_world_contextmanager("Grace")
assert result == "Hello, Grace"
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="abc123", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "abc123"
assert fake_capture_checkin.call_args[1]["status"] == "ok"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
def test_contextmanager_error(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
with pytest.raises(ZeroDivisionError):
result = _break_world_contextmanager("Grace")
assert "result" not in locals()
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="def456", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "def456"
assert fake_capture_checkin.call_args[1]["status"] == "error"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
def test_capture_checkin_simple(sentry_init):
sentry_init()
check_in_id = capture_checkin(
monitor_slug="abc123",
check_in_id="112233",
status=None,
duration=None,
)
assert check_in_id == "112233"
def test_sample_rate_doesnt_affect_crons(sentry_init, capture_envelopes):
sentry_init(sample_rate=0)
envelopes = capture_envelopes()
capture_checkin(check_in_id="112233")
assert len(envelopes) == 1
check_in = envelopes[0].items[0].payload.json
assert check_in["check_in_id"] == "112233"
def test_capture_checkin_new_id(sentry_init):
sentry_init()
with mock.patch("uuid.uuid4") as mock_uuid:
mock_uuid.return_value = uuid.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
check_in_id = capture_checkin(
monitor_slug="abc123",
check_in_id=None,
status=None,
duration=None,
)
assert check_in_id == "a8098c1af86e11dabd1a00112444be1e"
def test_end_to_end(sentry_init, capture_envelopes):
sentry_init()
envelopes = capture_envelopes()
capture_checkin(
monitor_slug="abc123",
check_in_id="112233",
duration=123,
status="ok",
)
check_in = envelopes[0].items[0].payload.json
# Check for final checkin
assert check_in["check_in_id"] == "112233"
assert check_in["monitor_slug"] == "abc123"
assert check_in["status"] == "ok"
assert check_in["duration"] == 123
def test_monitor_config(sentry_init, capture_envelopes):
sentry_init()
envelopes = capture_envelopes()
monitor_config = {
"schedule": {"type": "crontab", "value": "0 0 * * *"},
"failure_issue_threshold": 5,
"recovery_threshold": 5,
}
capture_checkin(monitor_slug="abc123", monitor_config=monitor_config)
check_in = envelopes[0].items[0].payload.json
# Check for final checkin
assert check_in["monitor_slug"] == "abc123"
assert check_in["monitor_config"] == monitor_config
# Without passing a monitor_config the field is not in the checkin
capture_checkin(monitor_slug="abc123")
check_in = envelopes[1].items[0].payload.json
assert check_in["monitor_slug"] == "abc123"
assert "monitor_config" not in check_in
def test_decorator_monitor_config(sentry_init, capture_envelopes):
sentry_init()
envelopes = capture_envelopes()
_with_monitor_config()
assert len(envelopes) == 2
for check_in_envelope in envelopes:
assert len(check_in_envelope.items) == 1
check_in = check_in_envelope.items[0].payload.json
assert check_in["monitor_slug"] == "ghi789"
assert check_in["monitor_config"] == {
"schedule": {"type": "crontab", "value": "0 0 * * *"},
"failure_issue_threshold": 5,
}
def test_decorator_no_monitor_config(sentry_init, capture_envelopes):
sentry_init()
envelopes = capture_envelopes()
_no_monitor_config()
assert len(envelopes) == 2
for check_in_envelope in envelopes:
assert len(check_in_envelope.items) == 1
check_in = check_in_envelope.items[0].payload.json
assert check_in["monitor_slug"] == "ghi789"
assert "monitor_config" not in check_in
def test_capture_checkin_sdk_not_initialized():
# Tests that the capture_checkin does not raise an error when Sentry SDK is not initialized.
# sentry_init() is intentionally omitted.
check_in_id = capture_checkin(
monitor_slug="abc123",
check_in_id="112233",
status=None,
duration=None,
)
assert check_in_id == "112233"
def test_scope_data_in_checkin(sentry_init, capture_envelopes):
sentry_init()
envelopes = capture_envelopes()
valid_keys = [
# Mandatory event keys
"type",
"event_id",
"timestamp",
"platform",
# Optional event keys
"release",
"environment",
"server_name",
"sdk",
# Mandatory check-in specific keys
"check_in_id",
"monitor_slug",
"status",
# Optional check-in specific keys
"duration",
"monitor_config",
"contexts", # an event processor adds this
]
# Add some data to the scope
sentry_sdk.add_breadcrumb(message="test breadcrumb")
sentry_sdk.set_context("test_context", {"test_key": "test_value"})
sentry_sdk.set_extra("test_extra", "test_value")
sentry_sdk.set_level("warning")
sentry_sdk.set_tag("test_tag", "test_value")
capture_checkin(
monitor_slug="abc123",
check_in_id="112233",
status="ok",
duration=123,
)
(envelope,) = envelopes
check_in_event = envelope.items[0].payload.json
invalid_keys = []
for key in check_in_event.keys():
if key not in valid_keys:
invalid_keys.append(key)
assert len(invalid_keys) == 0, "Unexpected keys found in checkin: {}".format(
invalid_keys
)
@pytest.mark.asyncio
async def test_decorator_async(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
result = await _hello_world_async("Grace")
assert result == "Hello, Grace"
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="abc123", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "abc123"
assert fake_capture_checkin.call_args[1]["status"] == "ok"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
@pytest.mark.asyncio
async def test_decorator_error_async(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
with pytest.raises(ZeroDivisionError):
result = await _break_world_async("Grace")
assert "result" not in locals()
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="def456", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "def456"
assert fake_capture_checkin.call_args[1]["status"] == "error"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
@pytest.mark.asyncio
async def test_contextmanager_async(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
result = await _hello_world_contextmanager_async("Grace")
assert result == "Hello, Grace"
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="abc123", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "abc123"
assert fake_capture_checkin.call_args[1]["status"] == "ok"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
@pytest.mark.asyncio
async def test_contextmanager_error_async(sentry_init):
sentry_init()
with mock.patch(
"sentry_sdk.crons.decorator.capture_checkin"
) as fake_capture_checkin:
with pytest.raises(ZeroDivisionError):
result = await _break_world_contextmanager_async("Grace")
assert "result" not in locals()
# Check for initial checkin
fake_capture_checkin.assert_has_calls(
[
mock.call(
monitor_slug="def456", status="in_progress", monitor_config=None
),
]
)
# Check for final checkin
assert fake_capture_checkin.call_args[1]["monitor_slug"] == "def456"
assert fake_capture_checkin.call_args[1]["status"] == "error"
assert fake_capture_checkin.call_args[1]["duration"]
assert fake_capture_checkin.call_args[1]["check_in_id"]
|
