Repository navigation
Expand file tree
/
Copy pathtest_behaviour_conformance.py
More file actions
1860 lines (1557 loc) · 85.5 KB
/
Copy pathtest_behaviour_conformance.py
File metadata and controls
1860 lines (1557 loc) · 85.5 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
"""Runs the behavioural sections of the shared cross-SDK conformance suite
(``roundtrip``, ``extension_write``, ``encode_reject``, ``data_shape``, ``forbidden_keys``,
``payload_schema_unicode``) and the conformance 1.5.0 / 1.6.0 sections (``trim``, ``job_type``,
``traceparent``, ``redis_layout``, ``redis_delay``, ``delay``, ``backoff``, ``retry_backoff``,
``kafka_poison``) plus the previously unexercised ``idempotency``, ``redis`` and ``rabbitmq``
blocks. ``redis_layout`` drives the real Lua scripts: it needs a real Redis (``BQ_REQUIRE_REDIS``;
CI) and falls back to the in-process fakeredis + lupa emulator only when none is required.
These sections are mandatory: unlike the optional broker sections, a missing section fails
the run instead of skipping it. Pointers are RFC 6901 and equality is type-strict and deep
(``true`` never equals ``1``, ``{}`` never equals ``[]``) — the shared runner contract.
"""
from __future__ import annotations
import base64
import contextlib
import inspect
import json
import logging
import re
import time
import unittest
from importlib.util import find_spec
from unittest import mock
from pathlib import Path
from typing import Any, Callable, Dict, Iterator, List, Mapping, Optional, Tuple
import redis_backend
from test_kafka_transport import FakeConsumer, FakeProducer, OffsetConsumer, OffsetMessage, ReportingProducer
from test_kafka_transport import transport as poison_transport
from test_pulsar_transport import FakeMessage as PulsarFakeMessage
from test_pulsar_transport import Timeout as PulsarTimeout
from test_sqs_transport import FakeSQS
from babelqueue import BabelQueue, BabelQueueError, EnvelopeCodec
from babelqueue.app import retry_delay
from babelqueue.dead_letter import annotate
from babelqueue.exceptions import EnvelopeKeyError
from babelqueue.idempotency import InMemoryStore
from babelqueue.idempotency import wrap as idempotency_wrap
from babelqueue._poison_record import build_poison_record
from babelqueue.kafka_transport import DEFAULT_RETRY_TIERS_MS, POISON_ROUTE, KafkaTransport, retry_topic
from babelqueue.pika_transport import PikaTransport
from babelqueue.pulsar_transport import PulsarTransport
from babelqueue.redis_transport import RedisTransport, _LegacyHandle
from babelqueue.schema import validate_schema
from babelqueue.sqs_transport import SqsTransport
from babelqueue.transport import NON_NUMERIC_ATTEMPTS_ROUTE, PoisonRoute, ReceivedMessage, Transport
SUITE = Path(__file__).parent / "conformance"
MANIFEST = json.loads((SUITE / "manifest.json").read_text(encoding="utf-8"))
_MISSING = object()
def _has_module(name: str) -> bool:
try:
return find_spec(name) is not None
except ModuleNotFoundError: # the parent package itself is absent
return False
_HAS_OTEL = _has_module("opentelemetry.trace")
def _pointer(doc: Any, pointer: str) -> Any:
"""Resolve an RFC 6901 JSON pointer; returns ``_MISSING`` when it does not resolve."""
if pointer == "":
return doc
if not pointer.startswith("/"):
raise ValueError(f"invalid JSON pointer {pointer!r}")
current = doc
for token in pointer[1:].split("/"):
token = token.replace("~1", "/").replace("~0", "~")
if isinstance(current, dict):
if token not in current:
return _MISSING
current = current[token]
elif isinstance(current, list):
if not token.isdigit() or int(token) >= len(current):
return _MISSING
current = current[int(token)]
else:
return _MISSING
return current
def _strict_equal(a: Any, b: Any) -> bool:
"""Deep JSON equality that also compares JSON types (Python's ``True == 1``)."""
if isinstance(a, bool) or isinstance(b, bool):
return isinstance(a, bool) and isinstance(b, bool) and a is b
if isinstance(a, dict) or isinstance(b, dict):
return (
isinstance(a, dict)
and isinstance(b, dict)
and a.keys() == b.keys()
and all(_strict_equal(a[k], b[k]) for k in a)
)
if isinstance(a, list) or isinstance(b, list):
return (
isinstance(a, list)
and isinstance(b, list)
and len(a) == len(b)
and all(_strict_equal(x, y) for x, y in zip(a, b))
)
if isinstance(a, (int, float)) and isinstance(b, (int, float)):
return a == b
return type(a) is type(b) and a == b
def _section(name: str) -> dict:
section = MANIFEST.get(name)
if not isinstance(section, dict) or not section.get("cases"):
raise AssertionError(f"conformance section {name!r} is missing or empty")
return section
def _retry_once(raw: str) -> str:
"""Drive ``raw`` through the runtime's real retry path (decode -> attempts+1 -> encode)
and return the re-emitted body."""
env = EnvelopeCodec.decode(raw)
urn = EnvelopeCodec.urn(env)
app = BabelQueue("memory://", queue="conformance", max_attempts=1_000_000)
def fail(data: Any, meta: Any) -> None:
raise RuntimeError("force a retry")
app.register(urn, fail)
app.transport.publish("conformance", raw)
processed = app.consume(max_messages=1, timeout=0, handle_signals=False)
assert processed == 1, "the fixture must be consumed"
received = app.transport.pop("conformance", timeout=0)
assert received is not None, "the retry must re-emit the message"
return received.body
@contextlib.contextmanager
def _captured_warnings() -> Iterator[List[str]]:
"""Collect every WARNING+ record of ``babelqueue.codec`` (``assertNoLogs`` needs Python 3.10)."""
records: List[str] = []
class _Collector(logging.Handler):
def emit(self, record: logging.LogRecord) -> None:
records.append(record.getMessage())
target = logging.getLogger("babelqueue.codec")
handler = _Collector(level=logging.WARNING)
previous = target.level
target.addHandler(handler)
target.setLevel(logging.WARNING)
try:
yield records
finally:
target.removeHandler(handler)
target.setLevel(previous)
def _preserved_violations(out: Any, expected: Mapping[str, Any]) -> List[str]:
"""Pointers of ``expected`` that are missing from ``out`` or hold a different value/type."""
problems: List[str] = []
for pointer, value in expected.items():
actual = _pointer(out, pointer)
if actual is _MISSING:
problems.append(f"{pointer} was dropped")
elif not _strict_equal(actual, value):
problems.append(f"{pointer}: {actual!r} != {value!r}")
return problems
def _absent_violations(out: Any, pointers: List[str]) -> List[str]:
"""Pointers of ``pointers`` that DO exist in ``out`` (they must be absent)."""
return [f"{pointer} re-emitted" for pointer in pointers if _pointer(out, pointer) is not _MISSING]
def _roundtrip_violations(case: Mapping[str, Any], out: Any) -> List[str]:
"""Every check of a ``roundtrip`` case, evaluated on ``out`` (the re-encoded document, or the
dead-letter copy when ``apply_dead_letter`` was applied). Empty list = the case holds."""
problems: List[str] = []
if not _strict_equal(out.get("attempts"), case["expect_attempts"]):
problems.append(f"/attempts: {out.get('attempts')!r} != {case['expect_attempts']!r}")
problems += _preserved_violations(out, case.get("expect_preserved", {}))
problems += _absent_violations(out, case.get("expect_absent_after_reencode", []))
if "apply_dead_letter" in case and "expect_dead_letter" in case:
block = out.get("dead_letter")
if not isinstance(block, dict):
problems.append("dead_letter block is missing")
else:
for field, value in case["expect_dead_letter"].items():
if field not in block or not _strict_equal(block[field], value):
problems.append(f"dead_letter.{field}: {block.get(field)!r} != {value!r}")
return problems
def _forbidden_violations(case: Mapping[str, Any], out: Any) -> List[str]:
"""Post-re-encode checks of a ``forbidden_keys`` case."""
return _absent_violations(out, case["expect_absent_after_reencode"]) + _preserved_violations(
out, case.get("expect_preserved", {})
)
def _run_roundtrip(case: Mapping[str, Any]) -> Tuple[Dict[str, Any], List[str]]:
"""Drive a ``roundtrip`` case: decode -> attempts+1 -> encode (-> SDK DLQ helper when the case
carries ``apply_dead_letter``). Returns the document the checks run on and the decode warnings."""
raw = (SUITE / case["file"]).read_text(encoding="utf-8")
with _captured_warnings() as warnings:
decoded = EnvelopeCodec.decode(raw)
accepted = EnvelopeCodec.accepts(decoded)
body = _retry_once(raw)
assert accepted, "must be accepted"
out = json.loads(body)
apply = case.get("apply_dead_letter")
if apply is not None:
out = json.loads(
EnvelopeCodec.encode(
annotate(
out,
apply["reason"],
apply["original_queue"],
out["attempts"],
error="forced failure",
exception="RuntimeError",
)
)
)
return out, warnings
class HelperTest(unittest.TestCase):
def test_strict_equal_is_type_aware(self) -> None:
self.assertFalse(_strict_equal(True, 1))
self.assertFalse(_strict_equal({}, []))
self.assertFalse(_strict_equal("1", 1))
self.assertTrue(_strict_equal({"a": [1, {"b": None}]}, {"a": [1, {"b": None}]}))
def test_pointer_resolves_escapes_and_misses(self) -> None:
doc = {"a/b": {"m~n": [10, 20]}}
self.assertEqual(_pointer(doc, "/a~1b/m~0n/1"), 20)
self.assertIs(_pointer(doc, "/missing"), _MISSING)
self.assertIs(_pointer(doc, "/a~1b/m~0n/9"), _MISSING)
class RoundtripConformanceTest(unittest.TestCase):
def test_roundtrip_cases(self) -> None:
for case in _section("roundtrip")["cases"]:
with self.subTest(case=case["name"]):
out, warnings = _run_roundtrip(case)
self.assertEqual([], warnings, "decode must emit no warning")
self.assertEqual([], _roundtrip_violations(case, out))
def test_dead_letter_case_really_goes_through_the_dlq_helper(self) -> None:
case = next(c for c in _section("roundtrip")["cases"] if "apply_dead_letter" in c)
out, _ = _run_roundtrip(case)
self.assertEqual(case["apply_dead_letter"]["reason"], out["dead_letter"]["reason"])
self.assertEqual(case["apply_dead_letter"]["original_queue"], out["dead_letter"]["original_queue"])
self.assertEqual(out["attempts"], out["dead_letter"]["attempts"])
class RunnerSelfTest(unittest.TestCase):
"""The runner must REPORT violations, not just stay green: synthetic cases prove that
``expect_absent_after_reencode``, ``expect_preserved`` and ``expect_dead_letter`` are evaluated."""
OUT = {
"job": "urn:acme:a",
"attempts": 1,
"meta": {"queue": "orders", "flag": True},
"urn": "urn:acme:a",
"dead_letter": {"reason": "failed", "original_queue": "orders"},
}
def test_absent_pointer_that_exists_is_reported(self) -> None:
case = {"expect_attempts": 1, "expect_absent_after_reencode": ["/urn"]}
self.assertEqual(["/urn re-emitted"], _roundtrip_violations(case, self.OUT))
self.assertEqual([], _roundtrip_violations({**case, "expect_absent_after_reencode": ["/nope"]}, self.OUT))
def test_preserved_missing_or_different_or_retyped_is_reported(self) -> None:
base = {"expect_attempts": 1}
for expected, fragment in (
({"/meta/missing": 1}, "dropped"),
({"/meta/queue": "other"}, "!="),
({"/meta/flag": 1}, "!="), # true != 1
):
with self.subTest(expected=expected):
problems = _roundtrip_violations({**base, "expect_preserved": expected}, self.OUT)
self.assertEqual(1, len(problems))
self.assertIn(fragment, problems[0])
self.assertEqual([], _roundtrip_violations({**base, "expect_preserved": {"/meta/flag": True}}, self.OUT))
def test_wrong_attempts_is_reported(self) -> None:
self.assertEqual(1, len(_roundtrip_violations({"expect_attempts": 2}, self.OUT)))
def test_expect_dead_letter_is_evaluated_only_with_apply_dead_letter(self) -> None:
apply = {"reason": "failed", "original_queue": "orders"}
case = {"expect_attempts": 1, "apply_dead_letter": apply}
self.assertEqual([], _roundtrip_violations({**case, "expect_dead_letter": apply}, self.OUT))
wrong = {"reason": "poison", "original_queue": "orders"}
self.assertEqual(1, len(_roundtrip_violations({**case, "expect_dead_letter": wrong}, self.OUT)))
no_block = {k: v for k, v in self.OUT.items() if k != "dead_letter"}
self.assertEqual(
["dead_letter block is missing"],
_roundtrip_violations({**case, "expect_dead_letter": apply}, no_block),
)
# without apply_dead_letter the field is ignored (plain roundtrip)
self.assertEqual([], _roundtrip_violations({"expect_attempts": 1, "expect_dead_letter": wrong}, self.OUT))
def test_forbidden_case_reports_present_and_changed_pointers(self) -> None:
case = {"expect_absent_after_reencode": ["/urn"], "expect_preserved": {"/job": "urn:acme:other"}}
self.assertEqual(2, len(_forbidden_violations(case, self.OUT)))
ok = {"expect_absent_after_reencode": ["/timestamp"], "expect_preserved": {"/job": "urn:acme:a"}}
self.assertEqual([], _forbidden_violations(ok, self.OUT))
def test_real_cases_fail_when_their_expectations_are_tampered_with(self) -> None:
cases = {c["name"]: c for c in _section("roundtrip")["cases"]}
out, _ = _run_roundtrip(cases["urn-only-roundtrip"])
tampered = {**cases["urn-only-roundtrip"], "expect_absent_after_reencode": ["/job"]}
self.assertEqual(["/job re-emitted"], _roundtrip_violations(tampered, out))
tampered = {**cases["urn-only-roundtrip"], "expect_preserved": {"/job": "urn:acme:zzz"}}
self.assertEqual(1, len(_roundtrip_violations(tampered, out)))
out, _ = _run_roundtrip(cases["dead-letter-roundtrip"])
tampered = {**cases["dead-letter-roundtrip"], "expect_dead_letter": {"reason": "poison"}}
self.assertEqual(1, len(_roundtrip_violations(tampered, out)))
def test_tracked_fields_exist_in_the_vendored_manifest(self) -> None:
# a manifest without the v1.4.0 fields would make the runner checks above vacuous
rt = _section("roundtrip")["cases"]
self.assertTrue(any("expect_absent_after_reencode" in c for c in rt))
self.assertTrue(any("apply_dead_letter" in c and "expect_dead_letter" in c for c in rt))
self.assertTrue(any("expect_preserved" in c for c in _section("forbidden_keys")["cases"]))
class ExtensionWriteConformanceTest(unittest.TestCase):
def test_extension_write_cases(self) -> None:
for case in _section("extension_write")["cases"]:
with self.subTest(case=case["name"]):
env = EnvelopeCodec.make(case["urn"], case["data"], queue=case["queue"], meta=case["meta"])
encoded = EnvelopeCodec.encode(env)
self.assertEqual([], _preserved_violations(json.loads(encoded), case["expect_envelope"]))
# re-emit chain: decode -> attempts+1 -> encode keeps the extension keys
again = json.loads(_retry_once(encoded))
self.assertEqual(1, again["attempts"])
self.assertEqual([], _preserved_violations(again, case["expect_envelope"]))
class EncodeRejectConformanceTest(unittest.TestCase):
def test_encode_reject_cases(self) -> None:
ran = 0
for case in _section("encode_reject")["cases"]:
with self.subTest(case=case["name"]):
self.assertEqual("reject", case["expect"])
if "meta_entries" in case:
continue # a repeated key is inexpressible in a single mapping (Go-only case)
with self.assertRaises(EnvelopeKeyError) as caught:
env = EnvelopeCodec.make(
case["urn"], case["data"], queue=case["queue"], meta=case.get("meta")
)
# preserved extras of an inbound message, placed straight into the dict
env.update(case.get("extras_top", {}))
env["meta"].update(case.get("extras_meta", {}))
EnvelopeCodec.encode(env)
self.assertEqual(case["offending_key"], caught.exception.pointer)
self.assertIn(case["offending_key"], str(caught.exception))
ran += 1
self.assertGreater(ran, 0)
class ProducerMetaTest(unittest.TestCase):
def test_forbidden_meta_key_is_rejected(self) -> None:
with self.assertRaises(EnvelopeKeyError):
EnvelopeCodec.make("urn:acme:a", {}, queue="q", meta={"ts": 1})
def test_core_meta_key_collision_is_rejected(self) -> None:
for key in ("id", "queue", "lang", "schema_version", "created_at"):
with self.subTest(key=key), self.assertRaises(EnvelopeKeyError) as caught:
EnvelopeCodec.make("urn:acme:a", {}, queue="q", meta={key: "x"})
self.assertEqual("/meta/" + key, caught.exception.pointer)
def test_non_mapping_meta_is_rejected(self) -> None:
with self.assertRaises(Exception):
EnvelopeCodec.make("urn:acme:a", {}, queue="q", meta=[("ext", 1)]) # type: ignore[arg-type]
def test_meta_is_keyword_only(self) -> None:
with self.assertRaises(TypeError):
EnvelopeCodec.make("urn:acme:a", {}, "q", None, {"ext": 1}) # type: ignore[misc]
def test_ext_block_survives_a_round_trip_and_input_is_not_mutated(self) -> None:
meta = {"ext": {"acme": 1}}
env = EnvelopeCodec.make("urn:acme:a", {"n": 1}, queue="q", meta=meta)
self.assertEqual({"ext": {"acme": 1}}, meta)
self.assertEqual({"acme": 1}, env["meta"]["ext"])
self.assertEqual(env, EnvelopeCodec.decode(EnvelopeCodec.encode(env)))
again = json.loads(_retry_once(EnvelopeCodec.encode(env)))
self.assertEqual({"acme": 1}, again["meta"]["ext"])
def test_encode_of_a_forbidden_key_dict_raises(self) -> None:
base = EnvelopeCodec.make("urn:acme:a", {}, queue="q")
for container, key in (
(None, "timestamp"),
("meta", "max_retries"),
("meta", "attempts"),
("meta", "source"),
("meta", "ts"),
(None, "urn"),
):
with self.subTest(container=container, key=key):
env = {**base, "meta": dict(base["meta"])}
(env if container is None else env["meta"])[key] = 1
with self.assertRaises(EnvelopeKeyError):
EnvelopeCodec.encode(env)
class BlankJobTest(unittest.TestCase):
def _raw(self, **fields: Any) -> str:
base = EnvelopeCodec.make("urn:acme:x", {"n": 1}, queue="q", trace_id="t-1")
del base["job"]
base.update(fields)
return json.dumps(base, ensure_ascii=False)
def test_each_ascii_whitespace_char_makes_job_blank(self) -> None:
for blank in ("", " ", "\t", "\n", "\u000b", "\u000c", "\r", " \t\n\u000b\u000c\r "):
with self.subTest(job=repr(blank)):
with _captured_warnings() as warnings:
env = EnvelopeCodec.decode(self._raw(job=blank, urn="urn:acme:b"))
self.assertEqual([], warnings)
self.assertEqual("urn:acme:b", env["job"])
self.assertNotIn("urn", env)
self.assertTrue(EnvelopeCodec.accepts(env))
# the same fallback for a raw (not decoded) dict
self.assertEqual("urn:acme:b", EnvelopeCodec.urn({"job": blank, "urn": "urn:acme:b"}))
def test_urn_only_becomes_job_without_a_warning(self) -> None:
with _captured_warnings() as warnings:
env = EnvelopeCodec.decode(self._raw(urn="urn:acme:b"))
self.assertEqual([], warnings)
self.assertEqual("urn:acme:b", env["job"])
self.assertNotIn("urn", env)
def test_unicode_space_job_is_not_blank(self) -> None:
with self.assertLogs("babelqueue.codec", level=logging.WARNING) as logs:
env = EnvelopeCodec.decode(self._raw(job="\u2003", urn="urn:acme:b"))
self.assertEqual("\u2003", env["job"])
self.assertNotIn("urn", env)
self.assertTrue(any("/urn" in line for line in logs.output))
self.assertEqual("\u2003", EnvelopeCodec.urn({"job": "\u2003", "urn": "urn:acme:b"}))
def test_job_wins_over_urn_with_a_warning_naming_the_pointer(self) -> None:
with self.assertLogs("babelqueue.codec", level=logging.WARNING) as logs:
env = EnvelopeCodec.decode(self._raw(job="urn:acme:a", urn="urn:acme:b"))
self.assertEqual("urn:acme:a", env["job"])
self.assertNotIn("urn", env)
self.assertEqual(1, len(logs.output))
self.assertIn("Dropped forbidden envelope key /urn from the envelope", logs.output[0])
def test_blank_job_without_urn_is_rejected(self) -> None:
# ADR-0032 section 6: neither a valid job nor a valid urn -> decode raises.
with self.assertRaises(BabelQueueError):
EnvelopeCodec.decode(self._raw(job=" "))
def test_decode_raises_when_there_is_no_valid_identity(self) -> None:
shapes = (
{},
{"job": None},
{"job": 0},
{"job": False, "urn": 0},
{"job": [], "urn": []},
{"job": {}, "urn": {}},
{"job": " ", "urn": "\t\n"},
{"job": 7, "urn": ["urn:acme:b"]},
{"urn": True},
)
for fields in shapes:
with self.subTest(fields=repr(fields)):
with self.assertRaises(BabelQueueError):
EnvelopeCodec.decode(self._raw(**fields))
def test_decode_still_returns_empty_for_unreadable_input(self) -> None:
for raw in ("not-json", "[]", "7", "null", ""):
with self.subTest(raw=raw):
self.assertEqual({}, EnvelopeCodec.decode(raw))
def test_decode_lenient_keeps_the_identity_less_envelope_instead_of_raising(self) -> None:
env = EnvelopeCodec.decode_lenient(self._raw(job=0))
self.assertEqual("", EnvelopeCodec.urn(env))
self.assertFalse(EnvelopeCodec.accepts(env))
self.assertEqual({}, EnvelopeCodec.decode_lenient("not-json"))
ok = EnvelopeCodec.decode_lenient(self._raw(job=0, urn="urn:acme:b"))
self.assertEqual("urn:acme:b", ok["job"])
def test_non_string_job_warning_only_claims_a_fallback_when_a_urn_exists(self) -> None:
with _captured_warnings() as with_urn:
EnvelopeCodec.decode(self._raw(job=0, urn="urn:acme:b"))
self.assertEqual(1, len(with_urn))
self.assertIn("falling back to urn", with_urn[0])
with _captured_warnings() as without_urn:
EnvelopeCodec.decode_lenient(self._raw(job=0))
self.assertEqual(1, len(without_urn))
self.assertNotIn("falling back", without_urn[0])
self.assertIn("/job", without_urn[0])
def test_trim_is_linear_on_a_huge_ascii_whitespace_input(self) -> None:
# Regression lock: a regex / char loop with backtracking would blow up here. The bound is
# deliberately generous (measured ~3 ms each) so it never flakes on a slow runner.
pad = " " * 200_000
started = time.perf_counter()
env = EnvelopeCodec.make(f"{pad}urn:acme:a{pad}", {"n": 1}, trace_id=f"{pad}t-1{pad}")
self.assertEqual("urn:acme:a", env["job"])
self.assertEqual("t-1", env["trace_id"])
self.assertTrue(EnvelopeCodec.accepts(env))
decoded = EnvelopeCodec.decode(self._raw(job=pad, urn="urn:acme:b", trace_id=pad))
self.assertEqual("urn:acme:b", decoded["job"])
self.assertFalse(EnvelopeCodec.accepts(decoded))
self.assertLess(time.perf_counter() - started, 5.0)
def test_falsy_non_string_job_is_never_a_urn(self) -> None:
for bad in (False, 0, [], {}, 1, True, ["urn:acme:a"]):
with self.subTest(job=repr(bad)):
self.assertEqual("", EnvelopeCodec.urn({"job": bad}))
env = EnvelopeCodec.make("urn:acme:a", {"n": 1}, queue="q", trace_id="t-1")
env["job"] = bad
self.assertFalse(EnvelopeCodec.accepts(env))
def test_falsy_non_string_job_falls_back_to_a_string_urn_alias(self) -> None:
for bad in (False, 0, [], {}):
with self.subTest(job=repr(bad)):
self.assertEqual("urn:acme:b", EnvelopeCodec.urn({"job": bad, "urn": "urn:acme:b"}))
# ADR-0032 section 6: the non-string job is ignored AND the decoder warns.
with _captured_warnings() as warnings:
env = EnvelopeCodec.decode(self._raw(job=bad, urn="urn:acme:b"))
self.assertEqual(1, len(warnings))
self.assertIn("/job", warnings[0])
self.assertEqual("urn:acme:b", env["job"])
self.assertTrue(EnvelopeCodec.accepts(env))
def test_non_string_urn_alias_is_never_a_urn(self) -> None:
for bad in (1, True, ["urn:acme:b"], {"k": 1}):
with self.subTest(urn=repr(bad)):
self.assertEqual("", EnvelopeCodec.urn({"urn": bad}))
def test_unicode_space_is_not_trimmed_by_make(self) -> None:
# ADR-0032 section 5: only the ASCII set is whitespace; U+00A0 / U+2003 / U+3000 stay.
for ch in ("\u00a0", "\u2003", "\u3000"):
with self.subTest(char=hex(ord(ch))):
env = EnvelopeCodec.make(f"{ch}urn:acme:a{ch}", {"n": 1}, trace_id=f"{ch}t-1{ch}")
self.assertEqual(f"{ch}urn:acme:a{ch}", env["job"])
self.assertEqual(f"{ch}t-1{ch}", env["trace_id"])
self.assertTrue(EnvelopeCodec.accepts(env))
def test_ascii_whitespace_is_trimmed_by_make_but_unicode_next_to_it_is_kept(self) -> None:
env = EnvelopeCodec.make(" \t\u00a0urn:acme:a\u3000\n ", {"n": 1}, trace_id=" \vt-1\f")
self.assertEqual("\u00a0urn:acme:a\u3000", env["job"])
self.assertEqual("t-1", env["trace_id"])
def test_reencode_of_a_decoded_envelope_never_raises(self) -> None:
env = EnvelopeCodec.decode(self._raw(job="urn:acme:a", urn="urn:acme:b", timestamp=1))
EnvelopeCodec.encode(env)
class DataShapeConformanceTest(unittest.TestCase):
def test_data_shape_cases(self) -> None:
cases = _section("data_shape")["cases"]
self.assertEqual({c["mode"] for c in cases}, {"encode", "decode"})
for case in cases:
with self.subTest(case=case["name"]):
if case["mode"] == "encode":
env = EnvelopeCodec.make(case["urn"], case["data"], queue=case["queue"])
encoded = EnvelopeCodec.encode(env)
# Re-serialise the emitted `data` value compactly: a dict prints `{...}`,
# a list `[...]`, so `{}` vs `[]` is preserved exactly.
data_json = json.dumps(
json.loads(encoded)["data"], ensure_ascii=False, separators=(",", ":")
)
self.assertEqual(data_json, case["expect_encoded_data_json"])
self.assertIn('"data":' + case["expect_encoded_data_json"], encoded)
elif case["mode"] == "decode":
raw = (SUITE / case["file"]).read_text(encoding="utf-8")
verdict = EnvelopeCodec.accepts(EnvelopeCodec.decode(raw))
self.assertEqual(verdict, case["valid"], case.get("reason"))
else: # pragma: no cover - guards against a new, unhandled mode
self.fail(f"unknown data_shape mode {case['mode']!r}")
class ForbiddenKeysConformanceTest(unittest.TestCase):
def test_forbidden_key_cases(self) -> None:
cases = _section("forbidden_keys")["cases"]
for case in cases:
with self.subTest(case=case["name"]):
raw = (SUITE / case["file"]).read_text(encoding="utf-8")
self.assertEqual(case["expect"], "warn")
self.assertIsNot(_pointer(json.loads(raw), case["forbidden_key"]), _MISSING)
with self.assertLogs("babelqueue.codec", level=logging.WARNING) as logs:
env = EnvelopeCodec.decode(raw)
self.assertNotEqual(env, {}, "decode must succeed")
self.assertTrue(EnvelopeCodec.accepts(env), "decode must not reject")
self.assertTrue(
any(case["forbidden_key"] in line for line in logs.output),
f"no warning naming {case['forbidden_key']}: {logs.output}",
)
out = json.loads(EnvelopeCodec.encode(env))
self.assertEqual([], _forbidden_violations(case, out))
def test_all_five_contract_keys_are_covered(self) -> None:
covered = {c["forbidden_key"] for c in _section("forbidden_keys")["cases"]}
expected = {"/timestamp", "/meta/max_retries", "/meta/attempts", "/meta/source", "/meta/ts"}
# a subset check: conformance 1.4.0 adds "/urn" cases on top of the five §10 keys
self.assertLessEqual(expected, covered)
class PayloadSchemaUnicodeConformanceTest(unittest.TestCase):
def test_unicode_length_cases(self) -> None:
section = _section("payload_schema_unicode")
results: List[Tuple[str, bool]] = []
for case in section["cases"]:
with self.subTest(case=case["name"]):
valid = validate_schema(section["schema"], case["data"]) is None
results.append((case["name"], valid))
self.assertEqual(case["valid"], valid, f"case {case['name']}")
self.assertEqual(len(results), len(section["cases"]))
# --------------------------------------------------------------------------------------------
# Case ids, case-level skips and the sections added by conformance 1.5.0 (ADR-0032).
# --------------------------------------------------------------------------------------------
_NOT_CASES = ("description", "schema")
def iter_cases(manifest: Mapping[str, Any], section: str) -> List[Tuple[str, Any]]:
"""Every ``(case id, case body)`` of a manifest section (ADR-0032 case-id rule).
A section's ``cases`` array gives one case per element, identified by its ``name`` or else
``<section>#<index>``; a sub-key with its own ``cases`` array gives ``<sub-key>/<name>`` (or
``<sub-key>/<index>``); any other object sub-key is a single case keyed by the sub-key;
``description`` and ``schema`` are never cases. The manifest top-level ``cases`` array is
the section named ``cases`` (the value is a plain list there).
"""
value = manifest[section]
found: List[Tuple[str, Any]] = []
if isinstance(value, list):
for index, case in enumerate(value):
found.append((str(case.get("name") or f"{section}#{index}"), case))
return found
cases = value.get("cases")
if isinstance(cases, list):
for index, case in enumerate(cases):
found.append((str(case.get("name") or f"{section}#{index}"), case))
for key, sub in value.items():
if key in _NOT_CASES or key == "cases" or not isinstance(sub, dict):
continue
sub_cases = sub.get("cases")
if isinstance(sub_cases, list):
for index, case in enumerate(sub_cases):
found.append((f"{key}/{case.get('name') or index}", case))
else:
found.append((key, sub))
return found
KNOWN_GAPS_FILE = Path(__file__).resolve().parents[1] / "conformance-known-gaps.json"
def _known_gaps() -> Dict[str, Dict[str, str]]:
"""Known gaps: ``section -> case id -> reason``, read from ``conformance-known-gaps.json``.
A known gap is an honest ``fail`` in ``results.json``, never a ``skip``. The case is still
RUN: ``_run_cases`` records the real outcome in :data:`GAP_RESULTS` instead of failing the
unit test, ``run_section`` reports it from there, and a gap case that now passes is a failing
subtest ("stale gap") as well as a ``pass`` the completeness gate
(``scripts/check_conformance_results.py``) rejects. A fail is accepted only when listed here.
"""
document = json.loads(KNOWN_GAPS_FILE.read_text(encoding="utf-8"))
gaps: Dict[str, Dict[str, str]] = {}
for entry in document["gaps"]:
gaps.setdefault(entry["section"], {})[entry["case"]] = entry["reason"]
return gaps
KNOWN_GAPS: Dict[str, Dict[str, str]] = _known_gaps()
#: ``(section, case id) -> None`` when a known-gap case passed, else the observed failure message.
#: Filled by :func:`_run_cases`; read by ``run_section`` in ``test_conformance.py``.
GAP_RESULTS: Dict[Tuple[str, str], Optional[str]] = {}
def _ensure(condition: bool, message: str) -> None:
if not condition:
raise AssertionError(message)
def _identity(raw: str) -> Tuple[Any, List[str]]:
"""Decode ``raw`` and return ``(resolved urn or None, decode warnings)``.
``None`` means decode raised :class:`BabelQueueError` — ADR-0032 section 6: neither a valid
``job`` nor a valid ``urn``. Nothing else is accepted as "no identity": a decode that returns
an identity-less envelope is a failure of the rule, not a pass.
"""
with _captured_warnings() as warnings:
try:
env = EnvelopeCodec.decode(raw)
except BabelQueueError:
return None, warnings
_ensure(env != {}, "decode of a readable object must not yield an empty envelope")
return EnvelopeCodec.urn(env), warnings
def _eval_trim(case: Mapping[str, Any]) -> None:
mode = case["mode"]
if mode == "make":
extra = {"trace_id": case["trace_id"]} if "trace_id" in case else {}
if case["expect"] == "reject":
try:
EnvelopeCodec.make(case["urn"], {}, **extra)
except BabelQueueError:
return
raise AssertionError("make must reject a URN that is empty after ASCII trim")
env = EnvelopeCodec.make(case["urn"], {}, **extra)
for field, expected in case["expect"].items():
_ensure(_strict_equal(env[field], expected), f"{field}: {env[field]!r} != {expected!r}")
elif mode == "decode":
raw = (SUITE / case["file"]).read_text(encoding="utf-8")
urn, warnings = _identity(raw)
if case["valid"]:
_ensure(urn == case["expect"]["urn"], f"urn: {urn!r} != {case['expect']['urn']!r}")
_ensure(
bool(warnings) == case["expect_warning"],
f"warning expected={case['expect_warning']} got={warnings}",
)
else:
_ensure(urn is None, f"no valid identity expected, resolved {urn!r}")
elif mode == "accepts":
raw = (SUITE / case["file"]).read_text(encoding="utf-8")
env = EnvelopeCodec.decode(raw)
if case.get("expect_decode_ok"):
_ensure(env != {}, "decode must still succeed")
verdict = EnvelopeCodec.accepts(env)
_ensure(verdict == case["expect_accepts"], f"accepts: {verdict} != {case['expect_accepts']}")
elif mode == "reemit":
raw = (SUITE / case["file"]).read_text(encoding="utf-8")
out = json.loads(_retry_once(raw))
_ensure(
_strict_equal(out.get("attempts"), case["expect_attempts"]),
f"/attempts: {out.get('attempts')!r} != {case['expect_attempts']!r}",
)
problems = _preserved_violations(out, case["expect_preserved"])
_ensure(not problems, "; ".join(problems))
else: # pragma: no cover - guards against a new, unhandled mode
raise AssertionError(f"unknown trim mode {mode!r}")
def _eval_job_type(case: Mapping[str, Any]) -> None:
raw = (SUITE / case["file"]).read_text(encoding="utf-8")
urn, warnings = _identity(raw)
if case["valid"]:
_ensure(urn == case["expect"]["urn"], f"urn: {urn!r} != {case['expect']['urn']!r}")
_ensure(
bool(warnings) == case["expect_warning"],
f"warning expected={case['expect_warning']} got={warnings}",
)
else:
_ensure(urn is None, f"no valid identity expected, resolved {urn!r}")
def _eval_traceparent(case: Mapping[str, Any]) -> None:
from opentelemetry.trace import get_current_span
from babelqueue import otel
from babelqueue.headers import _headers_scope
header = case["traceparent"]
with _headers_scope({} if header is None else {otel.HEADER_TRACEPARENT: header}):
ctx = otel._remote_parent_from_headers()
source = "traceparent"
if ctx is None:
source = "trace_id"
ctx = otel._parent_context(case["trace_id"])
span_context = get_current_span(ctx).get_span_context()
actual: Dict[str, Any] = {
"source": source,
"trace_id_hex": format(span_context.trace_id, "032x"),
}
expect = case["expect"]
if source == "traceparent":
actual["parent_span_id"] = format(span_context.span_id, "016x")
actual["flags"] = format(int(span_context.trace_flags), "02x")
for field, expected in expect.items():
_ensure(actual.get(field) == expected, f"{field}: {actual.get(field)!r} != {expected!r}")
class _KeyRecorder:
"""A client stub that records the KEYS of every Lua script the transport evaluates.
The key-name cases need no broker: ``RedisTransport`` never imports ``redis`` when it is
given a client, and only the key names it hands to ``eval`` are under test.
"""
def __init__(self) -> None:
self.eval_keys: List[List[str]] = []
def eval(self, script: Any, numkeys: Any, *args: Any) -> None:
self.eval_keys.append([str(k) for k in args[:numkeys]])
def _eval_redis_key_names(case: Mapping[str, Any]) -> None:
client = _KeyRecorder()
transport = RedisTransport(
"redis://x", client=client, laravel_compat=True, key_prefix=case["key_prefix"]
)
queue = case["queue"]
body = EnvelopeCodec.encode(EnvelopeCodec.make("urn:acme:a", {"n": 1}))
transport.publish(queue, body)
transport.release(ReceivedMessage(body=body, queue=queue, handle=body), 30)
# publish evals [ready, notify]; release evals [delayed, reserved].
publish_keys, release_keys = client.eval_keys[0], client.eval_keys[-1]
actual = {
"ready": publish_keys[0],
"notify": publish_keys[1],
"delayed": release_keys[0],
"reserved": release_keys[1],
}
for name, expected in case["expect"].items():
_ensure(actual[name] == expected, f"{name} key: {actual[name]!r} != {expected!r}")
def _eval_redis_delay(case: Mapping[str, Any]) -> None:
transport = RedisTransport("redis://x", client=object(), laravel_compat=True, clock=lambda: case["now"])
actual = transport._available_at(case["delay"]) # noqa: SLF001 - the SDK's score function
_ensure(actual == case["expect_score"], f"score: {actual!r} != {case['expect_score']!r}")
_DEADLINE_ANY = "<any>"
def _score_of(value: Any) -> float:
return float("inf") if value == "+inf" else float(value)
def _redis_for_layout() -> Any:
client, _kind = redis_backend.connect()
if client is None:
if redis_backend.require_real_redis():
raise AssertionError(
f"BQ_REQUIRE_REDIS is set but no real Redis is reachable at {redis_backend.REDIS_URL}"
)
raise unittest.SkipTest("redis_layout needs a Redis (real, or fakeredis + lupa): none available")
return client
def _entry_matches(member: str, score: float, expected: Mapping[str, Any]) -> bool:
"""Does one ``(member, score)`` of a zset match one expected ``{member|member_json|body_json|token+raw, score}``?"""
if score != _score_of(expected["score"]):
return False
if "member" in expected:
return member == expected["member"]
if "token" in expected:
if expected["token"] == _DEADLINE_ANY:
return re.fullmatch(r"[0-9a-f]{32}:" + re.escape(expected["raw"]), member) is not None
return member == f"{expected['token']}:{expected['raw']}"
want = expected["member_json"] if "member_json" in expected else expected["body_json"]
try:
return _strict_equal(json.loads(member), want)
except ValueError:
return False
def _zset_violation(label: str, actual: List[Tuple[str, float]], expected: List[Mapping[str, Any]]) -> Optional[str]:
remaining = list(actual)
for want in expected:
for index, (member, score) in enumerate(remaining):
if _entry_matches(member, score, want):
del remaining[index]
break
else:
return f"{label}: no entry matches {want!r} in {actual!r}"
if remaining:
return f"{label}: unexpected entries {remaining!r}"
return None
class _LayoutScenario:
"""One ``redis_layout`` behavioural case against a Redis: state, steps, per-step expectations."""
def __init__(self, case: Mapping[str, Any]) -> None:
self.case = case
self.client = _redis_for_layout()
self.queue = redis_backend.unique_queue("bqlayout")
self.zset = case["layout"] == "zset"
self.now = [0.0]
options: Dict[str, Any] = {}
if "retry_after" in case: # JSON null is ``None``: the deadline is +inf
options["retry_after"] = case["retry_after"]
if "migration_batch_size" in case:
options["migration_batch_size"] = case["migration_batch_size"]
self.transport = RedisTransport(
"redis://x", client=self.client, laravel_compat=self.zset, clock=lambda: self.now[0], **options
)
self.held: Dict[str, Optional[ReceivedMessage]] = {}
self.last: Optional[ReceivedMessage] = None
# -- keys
@property
def ready_key(self) -> str:
return f"queues:{self.queue}" if self.zset else self.queue
def key(self, name: str) -> str:
return {
"delayed": f"{self.ready_key}:delayed",
"reserved": f"{self.ready_key}:reserved",
"notify": f"{self.ready_key}:notify",
"processing": f"{self.queue}:processing",
"deadlines": f"{self.queue}:processing:deadlines",
}[name]
def zrange(self, key: str) -> List[Tuple[str, float]]:
return [(str(m), float(sc)) for m, sc in self.client.zrange(key, 0, -1, withscores=True)]
# -- state
def seed(self) -> None:
state = self.case["state"]
for member in state.get("ready", []):
self.client.rpush(self.ready_key, member)
for member in state.get("processing", []):
self.client.rpush(self.key("processing"), member)
for name in ("delayed", "reserved", "deadlines"):
for entry in state.get(name, []):
member = entry["member"] if "member" in entry else f"{entry['token']}:{entry['raw']}"
self.client.zadd(self.key(name), {member: _score_of(entry["score"])})
generate = state.get("delayed_generate")
if generate:
for i in range(generate["count"]):
self.client.zadd(self.key("delayed"), {generate["member"] % i: _score_of(generate["score"])})
for _ in range(state.get("notify", 0)):
self.client.rpush(self.key("notify"), "1")
# -- steps
def reservation(self, ref: Any) -> ReceivedMessage:
if isinstance(ref, str):
held = self.held.get(ref)
_ensure(held is not None, f"reservation {ref!r} is not held")
assert held is not None
return held
return ReceivedMessage(body=ref["raw"], queue=self.queue, handle=_LegacyHandle(ref["raw"], ref["token"]))
def run_step(self, step: Mapping[str, Any]) -> Dict[str, Any]:
self.now[0] = step["now"]
op = step["op"]
observed: Dict[str, Any] = {}
if op == "reserve":
message = self.transport.pop(self.queue, timeout=0)
self.last = message
if "as" in step:
self.held[step["as"]] = message
observed["message"] = message
elif op == "push_delayed":
self.transport.publish_delayed(self.queue, step["body"], step["delay"])
elif op == "migrate":
self.transport._migrate(self.ready_key) # noqa: SLF001 - the contract names the script, not an API
elif op == "sweep":
self.transport._sweep(self.queue) # noqa: SLF001
elif op == "release":
self.transport.release(self.reservation(step["reservation"]), step["delay"])
elif op == "ack":
self.transport.ack(self.reservation(step["reservation"]))
elif op == "dead_letter":
message = self.reservation(step["reservation"])
self.transport.dead_letter(message, f"{self.queue}.dlq", message.body)
else:
raise AssertionError(f"unknown redis_layout op {op!r}")
return observed
# -- expectations
def check(self, expect: Mapping[str, Any], observed: Mapping[str, Any]) -> None:
message: Optional[ReceivedMessage] = observed.get("message")
if "outcome" in expect:
if message is None:
actual = "empty"
elif message.route_urn == NON_NUMERIC_ATTEMPTS_ROUTE:
actual = "poison"
else:
actual = "delivered"
_ensure(actual == expect["outcome"], f"outcome: {actual!r} != {expect['outcome']!r}")
if "handler_body" in expect:
_ensure(message is not None, "handler_body expected but nothing was reserved")
assert message is not None
_ensure(message.body == expect["handler_body"], f"handler body: {message.body!r} != {expect['handler_body']!r}")
if "reported_attempts" in expect:
_ensure(message is not None, "reported_attempts expected but nothing was reserved")
assert message is not None
reported = json.loads(message.handle)["attempts"]
_ensure(reported == expect["reported_attempts"], f"attempts: {reported!r} != {expect['reported_attempts']!r}")
if "ready" in expect:
actual_ready = list(self.client.lrange(self.ready_key, 0, -1))
_ensure(actual_ready == expect["ready"], f"ready: {actual_ready!r} != {expect['ready']!r}")
if "ready_generate" in expect:
wanted = [expect["ready_generate"]["member"] % i for i in range(expect["ready_generate"]["count"])]
actual_ready = list(self.client.lrange(self.ready_key, 0, -1))
_ensure(actual_ready == wanted, f"ready (generated): {actual_ready[:3]!r}... != {wanted[:3]!r}...")
if "ready_count" in expect:
count = self.client.llen(self.queue)