Repository navigation
Expand file tree
/
Copy pathtest_asb_transport.py
More file actions
622 lines (492 loc) · 26.9 KB
/
Copy pathtest_asb_transport.py
File metadata and controls
622 lines (492 loc) · 26.9 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
"""Azure Service Bus transport tests.
The native projection and the ``attempts = DeliveryCount - 1`` reconciliation run with no
broker and no ``azure-servicebus`` (the transport's azure import is lazy). The publish flow,
which builds a real ``ServiceBusMessage``, is skipped unless ``azure-servicebus`` is installed.
"""
from __future__ import annotations
import unittest
from unittest import mock
from urllib.parse import quote
from babelqueue import BabelQueue, EnvelopeCodec
from babelqueue.asb_transport import AsbTransport
from babelqueue.transport import Abandoner, ReceivedMessage, Rewinder, make_transport
try:
import azure.servicebus # noqa: F401
HAVE_ASB = True
except ImportError:
HAVE_ASB = False
URN = "urn:babel:orders:created"
def body(attempts: int = 0) -> str:
env = EnvelopeCodec.decode(
EnvelopeCodec.encode(EnvelopeCodec.make(URN, {"order_id": 1042}, queue="orders"))
)
env["attempts"] = attempts
return EnvelopeCodec.encode(env)
def _with_forbidden_key(raw: str) -> str:
"""``raw`` plus a forbidden top-level key (message-envelope.md §10), as a legacy producer sends."""
return raw[:-1] + ',"timestamp":1}'
def _assert_no_codec_warnings(case: unittest.TestCase, fn) -> None:
"""Run ``fn`` and assert the codec logged nothing (``assertNoLogs`` needs Python 3.10+)."""
import logging
with case.assertLogs("babelqueue.codec", level="WARNING") as cm:
fn()
logging.getLogger("babelqueue.codec").warning("sentinel")
case.assertEqual(cm.output, ["WARNING:babelqueue.codec:sentinel"])
class FakeReceived:
"""Duck-typed ServiceBusReceivedMessage (the real one has no public constructor)."""
def __init__(self, raw: str, delivery_count: int = 1, application_properties=None) -> None:
self._raw = raw
self.delivery_count = delivery_count
self.application_properties = application_properties
def __str__(self) -> str:
return self._raw
class FakeSender:
def __init__(self) -> None:
self.sent: list = []
def send_messages(self, message) -> None:
self.sent.append(message)
class FakeReceiver:
def __init__(self, messages=()) -> None:
self._messages = list(messages)
self.completed: list = []
self.dead_lettered: list = [] # (message, reason, error_description)
self.abandoned: list = []
def dead_letter_message(self, message, reason=None, error_description=None) -> None:
self.dead_lettered.append((message, reason, error_description))
def abandon_message(self, message) -> None:
self.abandoned.append(message)
def receive_messages(self, max_message_count: int = 1, max_wait_time=None):
batch = self._messages[:max_message_count]
del self._messages[:max_message_count]
return batch
def complete_message(self, message) -> None:
self.completed.append(message)
class FakeClient:
def __init__(self, sender=None, receiver=None) -> None:
self.sender = sender if sender is not None else FakeSender()
self.receiver = receiver if receiver is not None else FakeReceiver()
def get_queue_sender(self, queue: str):
return self.sender
def get_queue_receiver(self, queue: str):
return self.receiver
class AsbProjectionTest(unittest.TestCase):
def test_projection_maps_native_fields_and_properties(self):
raw = body()
env = EnvelopeCodec.decode(raw)
proj = AsbTransport._projection(raw)
self.assertEqual(proj["subject"], URN)
self.assertEqual(proj["correlation_id"], env["trace_id"])
self.assertEqual(proj["message_id"], env["meta"]["id"])
self.assertEqual(proj["content_type"], "application/json")
props = proj["application_properties"]
self.assertEqual(props["bq-schema-version"], env["meta"]["schema_version"])
self.assertEqual(props["bq-source-lang"], env["meta"]["lang"])
self.assertEqual(props["bq-created-at"], env["meta"]["created_at"])
def test_reconcile_attempts_is_delivery_count_minus_one(self):
out = AsbTransport._reconcile(body(0), 3)
self.assertEqual(EnvelopeCodec.decode(out)["attempts"], 2)
def test_reconcile_first_delivery_is_zero(self):
out = AsbTransport._reconcile(body(0), 1)
self.assertEqual(EnvelopeCodec.decode(out)["attempts"], 0)
def test_reconcile_ignores_garbage_count(self):
raw = body(5)
self.assertEqual(AsbTransport._reconcile(raw, "not-a-number"), raw)
def test_reconcile_never_lowers_runtime_count(self):
# The runtime retries by republishing with attempts+1 (DeliveryCount back to 1),
# so a higher body count must win over a lower native one.
raw = body(5)
self.assertEqual(int(EnvelopeCodec.decode(AsbTransport._reconcile(raw, 2))["attempts"]), 5)
def test_projection_does_not_log_a_forbidden_key_drop(self):
# The body is sent unchanged, so the native-field projection must not claim a drop.
raw = _with_forbidden_key(body())
out: dict = {}
_assert_no_codec_warnings(self, lambda: out.update(AsbTransport._projection(raw)))
self.assertEqual(out["subject"], URN)
class AsbConsumeTest(unittest.TestCase):
def test_pop_reconciles_attempts_and_returns_handle(self):
received = FakeReceived(body(0), delivery_count=3)
tr = AsbTransport(client=FakeClient(receiver=FakeReceiver([received])))
msg = tr.pop("orders")
self.assertIsNotNone(msg)
self.assertEqual(msg.queue, "orders")
self.assertIs(msg.handle, received)
self.assertEqual(EnvelopeCodec.decode(msg.body)["attempts"], 2)
def test_pop_empty_returns_none(self):
tr = AsbTransport(client=FakeClient(receiver=FakeReceiver([])))
self.assertIsNone(tr.pop("orders"))
def test_ack_completes_the_reserved_message(self):
received = FakeReceived(body(), delivery_count=1)
receiver = FakeReceiver([received])
tr = AsbTransport(client=FakeClient(receiver=receiver))
tr.ack(tr.pop("orders"))
self.assertEqual(receiver.completed, [received])
def test_ack_noop_without_handle(self):
tr = AsbTransport(client=FakeClient())
tr.ack(ReceivedMessage(body="", queue="orders", handle=None)) # no error
def test_make_transport_routes_sb_scheme(self):
if HAVE_ASB:
self.skipTest("azure installed — building a real client would need credentials")
with self.assertRaises(ImportError):
make_transport("sb://ns.servicebus.windows.net")
class AsbSchemaVersionGateTest(unittest.TestCase):
"""The ``bq-schema-version`` pre-decode gate (broker-bindings.md §4.7 step 3)."""
PREFIX = "babelqueue:unsupported-schema-version:"
def _pop(self, raw, properties, delivery_count=1):
receiver = FakeReceiver([FakeReceived(raw, delivery_count, properties)])
return AsbTransport(client=FakeClient(receiver=receiver)).pop("orders")
def test_missing_or_blank_version_decodes_normally(self):
# blank = empty or only ASCII whitespace (space, \t, \n, \v, \f, \r), identical in every SDK
blanks = ("", " ", "\u000b", "\f", " \t\n\u000b\f\r")
for properties in (None, {}, {"other": "x"}) + tuple({"bq-schema-version": v} for v in blanks):
with self.subTest(properties=properties):
got = self._pop(body(), properties, delivery_count=3)
self.assertEqual(got.route_urn, "")
self.assertEqual(EnvelopeCodec.decode(got.body)["attempts"], 2) # reconciled
def test_supported_version_is_delivered(self):
# the transport itself publishes the integer 1; other SDKs and the portal send "1"
for value in ("1", 1, b"1"):
with self.subTest(value=value):
got = self._pop(body(), {"bq-schema-version": value}, delivery_count=2)
self.assertEqual(got.route_urn, "")
self.assertEqual(EnvelopeCodec.decode(got.body)["attempts"], 1)
def test_bytes_keys_and_values_are_decoded(self):
got = self._pop(body(), {b"bq-schema-version": b"1"})
self.assertEqual(got.route_urn, "")
got = self._pop("{not json", {b"bq-schema-version": b"2"})
self.assertEqual(got.route_urn, self.PREFIX + "2")
def test_long_rejected_version_is_truncated_in_the_route(self):
got = self._pop("{not json", {"bq-schema-version": "9" * 100})
self.assertEqual(got.route_urn, self.PREFIX + "9" * 64 + "...")
def test_route_percent_escapes_the_rejected_version(self):
got = self._pop("{not json", {"bq-schema-version": "2&x=?bq-job=%"})
self.assertEqual(got.route_urn, self.PREFIX + "2%26x%3D%3Fbq-job%3D%25")
def test_unsupported_version_returns_the_route_without_decoding(self):
garbage = "{not json"
values = ("2", "x", "01", " 1", "1.0", "-1", "\u00a0", "\u001c", "\u0085", "\ufeff", "\u3000")
for value in values:
with self.subTest(value=value):
with mock.patch.object(
EnvelopeCodec, "decode", side_effect=AssertionError("decode must not run")
) as decode:
got = self._pop(garbage, {"bq-schema-version": value})
decode.assert_not_called()
self.assertEqual(got.route_urn, self.PREFIX + quote(value, safe=""))
self.assertEqual(got.body, garbage)
self.assertIsNotNone(got.handle)
def test_numeric_and_other_typed_values_follow_the_integer_rule(self):
# int 1 is the supported version; every other number, a bool (an int in Python) and any
# other type is rejected
for value, want_route in (
(1, None),
(2, self.PREFIX + "2"),
(0, self.PREFIX + "0"),
(-1, self.PREFIX + "-1"),
(1.5, self.PREFIX + "1.5"),
(1.0, self.PREFIX + "1.0"),
(True, self.PREFIX + "True"),
(False, self.PREFIX + "False"),
([1], self.PREFIX + "%5B1%5D"),
):
with self.subTest(value=value):
got = self._pop(body(), {"bq-schema-version": value})
self.assertEqual(got.route_urn, want_route or "")
def test_gate_does_not_decode_a_valid_body_either(self):
raw = body()
with mock.patch.object(
EnvelopeCodec, "decode", side_effect=AssertionError("decode must not run")
):
got = self._pop(raw, {"bq-schema-version": "2"}, delivery_count=5)
self.assertEqual(got.body, raw) # not reconciled, byte-identical
self.assertEqual(got.route_urn, self.PREFIX + "2")
def test_gate_logs_a_warning_naming_the_version_and_queue(self):
with self.assertLogs("babelqueue.asb", level="WARNING") as logs:
self._pop("{not json", {"bq-schema-version": "2"})
self.assertIn("'2'", logs.output[0])
self.assertIn("'orders'", logs.output[0])
def test_supported_version_does_not_log(self):
from babelqueue import asb_transport
with mock.patch.object(asb_transport._logger, "warning") as warn:
self._pop(body(), {"bq-schema-version": 1})
self._pop(body(), None)
warn.assert_not_called()
def test_gated_message_is_completed_through_its_handle(self):
receiver = FakeReceiver([FakeReceived(body(), 1, {"bq-schema-version": "2"})])
tr = AsbTransport(client=FakeClient(receiver=receiver))
got = tr.pop("orders")
tr.ack(got)
self.assertEqual(receiver.completed, [got.handle])
def test_settle_native_dead_letters_with_reason_and_description(self):
receiver = FakeReceiver([FakeReceived("{not json", 1, {"bq-schema-version": "2"})])
tr = AsbTransport(client=FakeClient(receiver=receiver))
got = tr.pop("orders")
tr.settle_native(got, "unsupported schema version", "declares version 2")
self.assertEqual(
receiver.dead_lettered, [(got.handle, "unsupported schema version", "declares version 2")]
)
self.assertEqual(receiver.completed, [])
self.assertEqual(receiver.abandoned, [])
def test_settle_native_abandons_when_the_receiver_cannot_dead_letter(self):
class AbandonOnly:
def __init__(self, inner):
self.inner = inner
def receive_messages(self, **kwargs):
return self.inner.receive_messages(**kwargs)
def abandon_message(self, message):
self.inner.abandon_message(message)
inner = FakeReceiver([FakeReceived("{not json", 1, {"bq-schema-version": "2"})])
tr = AsbTransport(client=FakeClient(receiver=AbandonOnly(inner)))
got = tr.pop("orders")
tr.settle_native(got, "poison", "x")
self.assertEqual(inner.abandoned, [got.handle])
self.assertEqual(inner.completed, [])
def test_abandon_releases_the_lock_and_never_completes(self):
receiver = FakeReceiver([FakeReceived(body(), 1, {"bq-schema-version": "2"})])
tr = AsbTransport(client=FakeClient(receiver=receiver))
got = tr.pop("orders")
self.assertIsInstance(tr, Abandoner)
tr.abandon(got)
self.assertEqual(receiver.abandoned, [got.handle])
self.assertEqual(receiver.completed, [])
self.assertEqual(receiver.dead_lettered, [])
def test_abandon_is_a_noop_without_a_handle(self):
receiver = FakeReceiver()
tr = AsbTransport(client=FakeClient(receiver=receiver))
tr.abandon(ReceivedMessage(body="x", queue="orders", handle=None))
self.assertEqual(receiver.abandoned, [])
def test_a_failed_dlq_write_for_a_gated_message_abandons_it(self):
receiver = FakeReceiver([FakeReceived(body(), 1, {"bq-schema-version": "2"})])
app = BabelQueue(
transport=AsbTransport(client=FakeClient(receiver=receiver)), max_attempts=5, dead_letter=True
)
app._rewind_pause = 0 # noqa: SLF001
with mock.patch.object(AsbTransport, "publish", side_effect=RuntimeError("dlq unavailable")):
with self.assertLogs("babelqueue.app", level="ERROR"):
app.consume(queue="orders", max_messages=1)
self.assertEqual(len(receiver.abandoned), 1)
self.assertEqual(receiver.completed, [])
def test_a_failed_dlq_write_for_a_poison_body_is_not_abandoned(self):
# Only the version-gate unsettled branch abandons (owner decision 2026-10-25).
receiver = FakeReceiver([FakeReceived("not json", 1)])
app = BabelQueue(
transport=AsbTransport(client=FakeClient(receiver=receiver)), max_attempts=5, dead_letter=True
)
app._rewind_pause = 0 # noqa: SLF001
with mock.patch.object(AsbTransport, "publish", side_effect=RuntimeError("dlq unavailable")):
with self.assertLogs("babelqueue.app", level="ERROR"):
app.consume(queue="orders", max_messages=1)
self.assertEqual((receiver.abandoned, receiver.completed), ([], []))
def test_asb_is_not_a_rewinder_so_shutdown_and_retry_paths_keep_their_old_handling(self):
self.assertNotIsInstance(AsbTransport(client=FakeClient()), Rewinder)
def test_graceful_shutdown_release_republishes_a_copy_and_completes(self):
# A message whose handler never completed at shutdown: copy re-publish + Complete, no Abandon.
raw = body()
received = FakeReceived(raw, 1)
receiver = FakeReceiver([received])
tr = AsbTransport(client=FakeClient(receiver=receiver))
app = BabelQueue(transport=tr, max_attempts=5)
msg = tr.pop("orders")
with mock.patch.object(AsbTransport, "publish") as publish:
app._release_unprocessed(msg) # noqa: SLF001
publish.assert_called_once_with("orders", raw)
self.assertEqual(receiver.completed, [received])
self.assertEqual((receiver.abandoned, receiver.dead_lettered), ([], []))
def test_a_failed_retry_republish_is_left_unsettled_without_abandon(self):
received = FakeReceived(body(), 1)
receiver = FakeReceiver([received])
app = BabelQueue(transport=AsbTransport(client=FakeClient(receiver=receiver)), max_attempts=5)
app._rewind_pause = 0 # noqa: SLF001
@app.handler(URN)
def _boom(data, meta):
raise RuntimeError("handler failed")
with mock.patch.object(AsbTransport, "publish", side_effect=RuntimeError("broker down")):
with self.assertLogs("babelqueue.app", level="ERROR"):
app.consume(queue="orders", max_messages=1)
self.assertEqual((receiver.abandoned, receiver.completed, receiver.dead_lettered), ([], [], []))
def test_settle_native_is_a_noop_without_a_handle(self):
receiver = FakeReceiver()
tr = AsbTransport(client=FakeClient(receiver=receiver))
tr.settle_native(ReceivedMessage(body="x", queue="orders", handle=None), "poison", "x")
self.assertEqual(receiver.dead_lettered, [])
def test_app_without_dead_letter_dead_letters_natively_not_completes(self):
# ADR-0037 decision 1 rule 3: DLQ off + default fail -> explicit native DeadLetter.
for kwargs in ({}, {"on_unknown_urn": "release"}):
with self.subTest(**kwargs):
receiver = FakeReceiver([FakeReceived(body(), 1, {"bq-schema-version": "2"})])
app = BabelQueue(
transport=AsbTransport(client=FakeClient(receiver=receiver)), max_attempts=5, **kwargs
)
seen: list = []
@app.handler(URN)
def _on(data, meta):
seen.append(data)
with self.assertLogs("babelqueue.app", level="WARNING"):
app.consume(queue="orders", max_messages=1)
self.assertEqual(seen, [])
self.assertEqual(receiver.completed, [])
self.assertEqual([r for _, r, _ in receiver.dead_lettered], ["unsupported schema version"])
def test_delete_strategy_completes_a_gated_message_without_dead_letter(self):
receiver = FakeReceiver([FakeReceived(body(), 1, {"bq-schema-version": "2"})])
app = BabelQueue(
transport=AsbTransport(client=FakeClient(receiver=receiver)),
max_attempts=5,
on_unknown_urn="delete",
)
app.consume(queue="orders", max_messages=1)
self.assertEqual(len(receiver.completed), 1)
self.assertEqual(receiver.dead_lettered, [])
def test_app_dead_letters_unsupported_version_without_reaching_a_handler(self):
# max_attempts > 1: a gated message is dead-lettered directly, never retried
for value in ("2", "x", 2, "2&x=%"):
with self.subTest(value=value):
incoming = body()
receiver = FakeReceiver([FakeReceived(incoming, 1, {"bq-schema-version": value})])
app = BabelQueue(
transport=AsbTransport(client=FakeClient(receiver=receiver)),
max_attempts=5,
dead_letter=True,
)
seen: list = []
@app.handler(URN)
def _on(data, meta):
seen.append(data)
# publish() builds an azure ServiceBusMessage; capture it so no SDK is needed
with mock.patch.object(AsbTransport, "publish") as publish:
app.consume(queue="orders", max_messages=1)
self.assertEqual(seen, [])
self.assertEqual(len(receiver.completed), 1)
publish.assert_called_once()
queue, dead_body = publish.call_args.args
self.assertEqual(queue, "orders.dlq")
# rejected without decoding: the DLQ record is the incoming body, byte-identical
self.assertEqual(dead_body, incoming)
self.assertNotIn("dead_letter", dead_body)
@unittest.skipUnless(HAVE_ASB, "azure-servicebus not installed")
class AsbPublishTest(unittest.TestCase):
def test_publish_builds_message_with_native_projection(self):
raw = body()
env = EnvelopeCodec.decode(raw)
sender = FakeSender()
tr = AsbTransport(client=FakeClient(sender=sender))
tr.publish("orders", raw)
self.assertEqual(len(sender.sent), 1)
sent = sender.sent[0]
self.assertEqual(sent.subject, URN)
self.assertEqual(sent.correlation_id, env["trace_id"])
self.assertEqual(sent.message_id, env["meta"]["id"])
self.assertEqual(sent.content_type, "application/json")
self.assertEqual(EnvelopeCodec.urn(EnvelopeCodec.decode(str(sent))), URN)
def test_publish_encodes_ms_created_at_as_amqp_long(self):
from azure.servicebus._pyamqp import _encode
sender = FakeSender()
AsbTransport(client=FakeClient(sender=sender)).publish("orders", body())
props = sender.sent[0].application_properties
out = bytearray()
# a bare int > int32 raises "Value supplied for int invalid" here
_encode.encode_value(out, _encode.encode_application_properties(props))
self.assertIn(b"bq-created-at\x81", bytes(out))
self.assertIn(b"bq-schema-version\x54\x01", bytes(out))
TRACEPARENT = "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
class AsbTraceparentConsumeTest(unittest.TestCase):
def test_pop_surfaces_out_of_band_properties_without_the_bq_projection(self):
props = {
"bq-schema-version": "1",
"bq-source-lang": "python",
"bq-created-at": 1761900000000,
b"traceparent": TRACEPARENT.encode("utf-8"), # the AMQP client may hand bytes over
"bq-replay-bypass": "1",
}
received = FakeReceived(body(), application_properties=props)
tr = AsbTransport(client=FakeClient(receiver=FakeReceiver([received])))
msg = tr.pop("orders")
self.assertEqual(msg.headers, {"traceparent": TRACEPARENT, "bq-replay-bypass": "1"})
def test_pop_without_properties_has_no_headers(self):
tr = AsbTransport(client=FakeClient(receiver=FakeReceiver([FakeReceived(body())])))
self.assertEqual(tr.pop("orders").headers, {})
@unittest.skipUnless(HAVE_ASB, "azure-servicebus not installed")
class AsbTraceparentPublishTest(unittest.TestCase):
def test_publish_with_headers_adds_application_properties_beside_the_projection(self):
raw = body()
plain_sender, sender = FakeSender(), FakeSender()
AsbTransport(client=FakeClient(sender=plain_sender)).publish("orders", raw)
AsbTransport(client=FakeClient(sender=sender)).publish_with_headers(
"orders",
raw,
{"traceparent": TRACEPARENT, "bq-source-lang": "evil", "bq-replay-bypass": "1"},
)
sent, plain = sender.sent[0], plain_sender.sent[0]
self.assertEqual(sent.application_properties["traceparent"], TRACEPARENT)
self.assertEqual(sent.application_properties["bq-replay-bypass"], "1")
self.assertEqual(
sent.application_properties["bq-source-lang"],
plain.application_properties["bq-source-lang"],
) # the projection wins a collision
self.assertEqual(str(sent), str(plain)) # body byte-identical
self.assertEqual(str(sent), raw)
self.assertEqual(sent.subject, plain.subject)
self.assertEqual(sent.correlation_id, plain.correlation_id)
self.assertEqual(sent.message_id, plain.message_id)
def test_publish_with_headers_keeps_ms_created_at_an_amqp_long(self):
from azure.servicebus._pyamqp import _encode
sender = FakeSender()
AsbTransport(client=FakeClient(sender=sender)).publish_with_headers(
"orders", body(), {"traceparent": TRACEPARENT}
)
out = bytearray()
_encode.encode_value(out, _encode.encode_application_properties(sender.sent[0].application_properties))
self.assertIn(b"bq-created-at\x81", bytes(out))
def test_round_trip_through_the_runtime(self):
from babelqueue import BabelQueue, headers_from_context
sender = FakeSender()
app = BabelQueue(transport=AsbTransport(client=FakeClient(sender=sender)), queue="orders")
app.publish_with_headers(URN, {"order_id": 1}, {"traceparent": TRACEPARENT})
sent = sender.sent[0]
received = FakeReceived(str(sent), application_properties=dict(sent.application_properties))
seen = {}
app2 = BabelQueue(
transport=AsbTransport(client=FakeClient(receiver=FakeReceiver([received]))), queue="orders"
)
app2.register(URN, lambda data, meta: seen.update(headers=dict(headers_from_context())))
app2.consume("orders", max_messages=1, timeout=0)
self.assertEqual(seen["headers"], {"traceparent": TRACEPARENT})
class AsbNativeDeadLetterVariantTest(unittest.TestCase):
"""``settle_native_dead_letter`` (ADR-0039 section 5.1): same settle as ``settle_native``, plus
whether the message really went to ``$DeadLetterQueue``."""
def test_returns_true_when_dead_letter_message_was_called(self):
received = FakeReceived(body())
receiver = FakeReceiver([received])
tr = AsbTransport(client=FakeClient(receiver=receiver))
msg = tr.pop("orders")
self.assertIs(tr.settle_native_dead_letter(msg, "poison", "bad body"), True)
self.assertEqual(receiver.dead_lettered, [(received, "poison", "bad body")])
self.assertEqual(receiver.abandoned, [])
self.assertEqual(receiver.completed, [])
def test_returns_false_when_it_fell_back_to_abandon(self):
class AbandonOnlyReceiver:
def __init__(self, messages):
self._messages = list(messages)
self.abandoned = []
def receive_messages(self, max_message_count=1, max_wait_time=None):
batch, self._messages = self._messages[:max_message_count], self._messages[max_message_count:]
return batch
def abandon_message(self, message):
self.abandoned.append(message)
received = FakeReceived(body())
receiver = AbandonOnlyReceiver([received])
tr = AsbTransport(client=FakeClient(receiver=receiver))
msg = tr.pop("orders")
self.assertIs(tr.settle_native_dead_letter(msg, "poison", "bad body"), False)
self.assertEqual(receiver.abandoned, [received])
def test_returns_false_without_a_handle_and_settles_nothing(self):
receiver = FakeReceiver()
tr = AsbTransport(client=FakeClient(receiver=receiver))
msg = ReceivedMessage(body="", queue="orders", handle=None)
self.assertIs(tr.settle_native_dead_letter(msg, "poison", "x"), False)
self.assertEqual((receiver.dead_lettered, receiver.abandoned), ([], []))
def test_settle_native_is_unchanged(self):
received = FakeReceived(body())
receiver = FakeReceiver([received])
tr = AsbTransport(client=FakeClient(receiver=receiver))
self.assertIsNone(tr.settle_native(tr.pop("orders"), "poison", "bad body"))
self.assertEqual(receiver.dead_lettered, [(received, "poison", "bad body")])
if __name__ == "__main__":
unittest.main()