{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathtest_change_stream.py
More file actions
1122 lines (973 loc) · 46 KB
/
Copy pathtest_change_stream.py
File metadata and controls
1122 lines (973 loc) · 46 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
# Copyright 2017 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Test the change_stream module."""
from __future__ import annotations
import asyncio
import os
import random
import string
import sys
import threading
import time
import uuid
from itertools import product
from typing import no_type_check
sys.path[0:0] = [""]
from bson import SON, ObjectId, Timestamp, encode
from bson.binary import ALL_UUID_REPRESENTATIONS, PYTHON_LEGACY, STANDARD, Binary
from bson.raw_bson import DEFAULT_RAW_BSON_OPTIONS, RawBSONDocument
from pymongo import MongoClient
from pymongo.errors import (
InvalidOperation,
OperationFailure,
ServerSelectionTimeoutError,
)
from pymongo.message import _CursorAddress
from pymongo.read_concern import ReadConcern
from pymongo.synchronous.command_cursor import CommandCursor
from pymongo.synchronous.helpers import next
from pymongo.write_concern import WriteConcern
from test import (
IntegrationTest,
PyMongoTestCase,
Version,
client_context,
unittest,
)
from test.unified_format import generate_test_classes, get_test_path
from test.utils_shared import (
AllowListEventListener,
EventListener,
OvertCommandListener,
wait_until,
)
_IS_SYNC = True
class TestChangeStreamBase(IntegrationTest):
RUN_ON_LOAD_BALANCER = True
def change_stream_with_client(self, client, *args, **kwargs):
"""Create a change stream using the given client and return it."""
raise NotImplementedError
def change_stream(self, *args, **kwargs):
"""Create a change stream using the default client and return it."""
return self.change_stream_with_client(self.client, *args, **kwargs)
def client_with_listener(self, *commands):
"""Return a client with a AllowListEventListener."""
listener = AllowListEventListener(*commands)
client = self.rs_or_single_client(event_listeners=[listener])
return client, listener
def watched_collection(self, *args, **kwargs):
"""Return a collection that is watched by self.change_stream()."""
# Construct a unique collection for each test.
collname = ".".join(self.id().rsplit(".", 2)[1:])
return self.db.get_collection(collname, *args, **kwargs)
def generate_invalidate_event(self, change_stream):
"""Cause a change stream invalidate event."""
raise NotImplementedError
def generate_unique_collnames(self, numcolls):
"""Generate numcolls collection names unique to a test."""
collnames = []
for idx in range(1, numcolls + 1):
collnames.append(self.id() + "_" + str(idx))
return collnames
def get_resume_token(self, invalidate=False):
"""Get a resume token to use for starting a change stream."""
# Ensure targeted collection exists before starting.
coll = self.watched_collection(write_concern=WriteConcern("majority"))
coll.insert_one({})
if invalidate:
with self.change_stream([{"$match": {"operationType": "invalidate"}}]) as cs:
if isinstance(cs._target, MongoClient):
self.skipTest("cluster-level change streams cannot be invalidated")
self.generate_invalidate_event(cs)
return (cs.next())["_id"]
else:
with self.change_stream() as cs:
coll.insert_one({"data": 1})
return (cs.next())["_id"]
def get_start_at_operation_time(self):
"""Get an operationTime. Advances the operation clock beyond the most
recently returned timestamp.
"""
optime = (self.client.admin.command("ping"))["operationTime"]
return Timestamp(optime.time, optime.inc + 1)
def insert_one_and_check(self, change_stream, doc):
"""Insert a document and check that it shows up in the change stream."""
raise NotImplementedError
def kill_change_stream_cursor(self, change_stream):
"""Cause a cursor not found error on the next getMore."""
cursor = change_stream._cursor
address = _CursorAddress(cursor.address, cursor._ns)
client = self.watched_collection().database.client
client._close_cursor_now(cursor.cursor_id, address)
class APITestsMixin:
@no_type_check
def test_watch(self):
with self.change_stream(
[{"$project": {"foo": 0}}],
full_document="updateLookup",
max_await_time_ms=1000,
batch_size=100,
) as change_stream:
self.assertEqual([{"$project": {"foo": 0}}], change_stream._pipeline)
self.assertEqual("updateLookup", change_stream._full_document)
self.assertEqual(1000, change_stream._max_await_time_ms)
self.assertEqual(100, change_stream._batch_size)
self.assertIsInstance(change_stream._cursor, CommandCursor)
self.assertEqual(1000, change_stream._cursor._max_await_time_ms)
self.watched_collection(write_concern=WriteConcern("majority")).insert_one({})
_ = change_stream.next()
resume_token = change_stream.resume_token
with self.assertRaises(TypeError):
self.change_stream(pipeline={})
with self.assertRaises(TypeError):
self.change_stream(full_document={})
# No Error.
with self.change_stream(resume_after=resume_token):
pass
@no_type_check
def test_try_next(self):
# ChangeStreams only read majority committed data so use w:majority.
coll = self.watched_collection().with_options(write_concern=WriteConcern("majority"))
coll.drop()
coll.insert_one({})
self.addCleanup(coll.drop)
with self.change_stream(max_await_time_ms=250) as stream:
self.assertIsNone(stream.try_next()) # No changes initially.
coll.insert_one({}) # Generate a change.
# On sharded clusters, even majority-committed changes only show
# up once an event that sorts after it shows up on the other
# shard. So, we wait on try_next to eventually return changes.
def _wait_until():
return stream.try_next() is not None
wait_until(_wait_until, "get change from try_next")
@no_type_check
def test_try_next_runs_one_getmore(self):
listener = OvertCommandListener()
client = self.rs_or_single_client(event_listeners=[listener])
# Connect to the cluster.
client.admin.command("ping")
listener.reset()
# ChangeStreams only read majority committed data so use w:majority.
coll = self.watched_collection().with_options(write_concern=WriteConcern("majority"))
coll.drop()
# Create the watched collection before starting the change stream to
# skip any "create" events.
coll.insert_one({"_id": 1})
self.addCleanup(coll.drop)
with self.change_stream_with_client(client, max_await_time_ms=250) as stream:
self.assertEqual(listener.started_command_names(), ["aggregate"])
listener.reset()
# Confirm that only a single getMore is run even when no documents
# are returned.
self.assertIsNone(stream.try_next())
self.assertEqual(listener.started_command_names(), ["getMore"])
listener.reset()
self.assertIsNone(stream.try_next())
self.assertEqual(listener.started_command_names(), ["getMore"])
listener.reset()
# Get at least one change before resuming.
coll.insert_one({"_id": 2})
def _wait_until():
return stream.try_next() is not None
wait_until(_wait_until, "get change from try_next")
listener.reset()
# Cause the next request to initiate the resume process.
self.kill_change_stream_cursor(stream)
listener.reset()
# The sequence should be:
# - getMore, fail
# - resume with aggregate command
# - no results, return immediately without another getMore
self.assertIsNone(stream.try_next())
self.assertEqual(listener.started_command_names(), ["getMore", "aggregate"])
listener.reset()
# Stream still works after a resume.
coll.insert_one({"_id": 3})
def _wait_until():
return stream.try_next() is not None
wait_until(_wait_until, "get change from try_next")
self.assertEqual(set(listener.started_command_names()), {"getMore"})
self.assertIsNone(stream.try_next())
@no_type_check
def test_batch_size_is_honored(self):
listener = OvertCommandListener()
client = self.rs_or_single_client(event_listeners=[listener])
# Connect to the cluster.
client.admin.command("ping")
listener.reset()
# ChangeStreams only read majority committed data so use w:majority.
coll = self.watched_collection().with_options(write_concern=WriteConcern("majority"))
coll.drop()
# Create the watched collection before starting the change stream to
# skip any "create" events.
coll.insert_one({"_id": 1})
self.addCleanup(coll.drop)
# Expected batchSize.
expected = {"batchSize": 23}
with self.change_stream_with_client(client, max_await_time_ms=250, batch_size=23) as stream:
# Confirm that batchSize is honored for initial batch.
cmd = listener.started_events[0].command
self.assertEqual(cmd["cursor"], expected)
listener.reset()
# Confirm that batchSize is honored by getMores.
self.assertIsNone(stream.try_next())
cmd = listener.started_events[0].command
key = next(iter(expected))
self.assertEqual(expected[key], cmd[key])
# $changeStream.startAtOperationTime was added in 4.0.0.
@no_type_check
def test_start_at_operation_time(self):
optime = self.get_start_at_operation_time()
coll = self.watched_collection(write_concern=WriteConcern("majority"))
ndocs = 3
coll.insert_many([{"data": i} for i in range(ndocs)])
with self.change_stream(start_at_operation_time=optime) as cs:
for _i in range(ndocs):
cs.next()
@no_type_check
def _test_full_pipeline(self, expected_cs_stage):
client, listener = self.client_with_listener("aggregate")
with self.change_stream_with_client(client, [{"$project": {"foo": 0}}]) as _:
pass
self.assertEqual(1, len(listener.started_events))
command = listener.started_events[0]
self.assertEqual("aggregate", command.command_name)
self.assertEqual(
[{"$changeStream": expected_cs_stage}, {"$project": {"foo": 0}}],
command.command["pipeline"],
)
@no_type_check
def test_full_pipeline(self):
"""$changeStream must be the first stage in a change stream pipeline
sent to the server.
"""
self._test_full_pipeline({})
@no_type_check
def test_iteration(self):
with self.change_stream(batch_size=2) as change_stream:
num_inserted = 10
self.watched_collection().insert_many([{} for _ in range(num_inserted)])
inserts_received = 0
for change in change_stream:
self.assertEqual(change["operationType"], "insert")
inserts_received += 1
if inserts_received == num_inserted:
break
self._test_invalidate_stops_iteration(change_stream)
@no_type_check
@client_context.require_sync
def _test_next_blocks(self, change_stream):
inserted_doc = {"_id": ObjectId()}
changes = []
t = threading.Thread(target=lambda: changes.append(change_stream.next()))
t.start()
# Sleep for a bit to prove that the call to next() blocks.
time.sleep(1)
self.assertTrue(t.is_alive())
self.assertFalse(changes)
self.watched_collection().insert_one(inserted_doc)
# Join with large timeout to give the server time to return the change,
# in particular for shard clusters.
t.join(30)
self.assertFalse(t.is_alive())
self.assertEqual(1, len(changes))
self.assertEqual(changes[0]["operationType"], "insert")
self.assertEqual(changes[0]["fullDocument"], inserted_doc)
@no_type_check
@client_context.require_sync
def test_next_blocks(self):
"""Test that next blocks until a change is readable"""
# Use a short wait time to speed up the test.
with self.change_stream(max_await_time_ms=250) as change_stream:
self._test_next_blocks(change_stream)
@no_type_check
@client_context.require_sync
def test_aggregate_cursor_blocks(self):
"""Test that an aggregate cursor blocks until a change is readable."""
with self.watched_collection().aggregate(
[{"$changeStream": {}}], maxAwaitTimeMS=250
) as change_stream:
self._test_next_blocks(change_stream)
@no_type_check
@client_context.require_sync
def test_concurrent_close(self):
"""Ensure a ChangeStream can be closed from another thread."""
# Use a short wait time to speed up the test.
with self.change_stream(max_await_time_ms=250) as change_stream:
def iterate_cursor():
try:
for _ in change_stream:
pass
except OperationFailure as e:
if e.code != 237: # CursorKilled error code
raise
t = threading.Thread(target=iterate_cursor)
t.start()
self.watched_collection().insert_one({})
time.sleep(1)
change_stream.close()
t.join(3)
self.assertFalse(t.is_alive())
@no_type_check
def test_unknown_full_document(self):
"""Must rely on the server to raise an error on unknown fullDocument."""
try:
with self.change_stream(full_document="notValidatedByPyMongo"):
pass
except OperationFailure:
pass
@no_type_check
def test_change_operations(self):
"""Test each operation type."""
expected_ns = {
"db": self.watched_collection().database.name,
"coll": self.watched_collection().name,
}
with self.change_stream() as change_stream:
# Insert.
inserted_doc = {"_id": ObjectId(), "foo": "bar"}
self.watched_collection().insert_one(inserted_doc)
change = change_stream.next()
self.assertTrue(change["_id"])
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["ns"], expected_ns)
self.assertEqual(change["fullDocument"], inserted_doc)
# Update.
update_spec = {"$set": {"new": 1}, "$unset": {"foo": 1}}
self.watched_collection().update_one(inserted_doc, update_spec)
change = change_stream.next()
self.assertTrue(change["_id"])
self.assertEqual(change["operationType"], "update")
self.assertEqual(change["ns"], expected_ns)
self.assertNotIn("fullDocument", change)
expected_update_description = {"updatedFields": {"new": 1}, "removedFields": ["foo"]}
if client_context.version.at_least(4, 5, 0):
expected_update_description["truncatedArrays"] = []
self.assertEqual(
expected_update_description,
{
k: v
for k, v in change["updateDescription"].items()
if k in expected_update_description
},
)
# Replace.
self.watched_collection().replace_one({"new": 1}, {"foo": "bar"})
change = change_stream.next()
self.assertTrue(change["_id"])
self.assertEqual(change["operationType"], "replace")
self.assertEqual(change["ns"], expected_ns)
self.assertEqual(change["fullDocument"], inserted_doc)
# Delete.
self.watched_collection().delete_one({"foo": "bar"})
change = change_stream.next()
self.assertTrue(change["_id"])
self.assertEqual(change["operationType"], "delete")
self.assertEqual(change["ns"], expected_ns)
self.assertNotIn("fullDocument", change)
# Invalidate.
self._test_get_invalidate_event(change_stream)
@no_type_check
def test_start_after(self):
resume_token = self.get_resume_token(invalidate=True)
# resume_after cannot resume after invalidate.
with self.assertRaises(OperationFailure):
self.change_stream(resume_after=resume_token)
# start_after can resume after invalidate.
with self.change_stream(start_after=resume_token) as change_stream:
self.watched_collection().insert_one({"_id": 2})
change = change_stream.next()
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["fullDocument"], {"_id": 2})
@no_type_check
def test_start_after_resume_process_with_changes(self):
resume_token = self.get_resume_token(invalidate=True)
with self.change_stream(start_after=resume_token, max_await_time_ms=250) as change_stream:
self.watched_collection().insert_one({"_id": 2})
change = change_stream.next()
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["fullDocument"], {"_id": 2})
self.assertIsNone(change_stream.try_next())
self.kill_change_stream_cursor(change_stream)
self.watched_collection().insert_one({"_id": 3})
change = change_stream.next()
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["fullDocument"], {"_id": 3})
@no_type_check
def test_start_after_resume_process_without_changes(self):
resume_token = self.get_resume_token(invalidate=True)
with self.change_stream(start_after=resume_token, max_await_time_ms=250) as change_stream:
self.assertIsNone(change_stream.try_next())
self.kill_change_stream_cursor(change_stream)
self.watched_collection().insert_one({"_id": 2})
change = change_stream.next()
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["fullDocument"], {"_id": 2})
class ProseSpecTestsMixin:
@no_type_check
def _client_with_listener(self, *commands):
listener = AllowListEventListener(*commands)
client = PyMongoTestCase.unmanaged_rs_or_single_client(event_listeners=[listener])
self.addCleanup(client.close)
return client, listener
@no_type_check
def _populate_and_exhaust_change_stream(self, change_stream, batch_size=3):
self.watched_collection().insert_many([{"data": k} for k in range(batch_size)])
for _ in range(batch_size):
change = next(change_stream)
return change
def _get_expected_resume_token_legacy(self, stream, listener, previous_change=None):
"""Predicts what the resume token should currently be for server
versions that don't support postBatchResumeToken. Assumes the stream
has never returned any changes if previous_change is None.
"""
if previous_change is None:
agg_cmd = listener.started_events[0]
stage = agg_cmd.command["pipeline"][0]["$changeStream"]
return stage.get("resumeAfter") or stage.get("startAfter")
return previous_change["_id"]
def _get_expected_resume_token(self, stream, listener, previous_change=None):
"""Predicts what the resume token should currently be for server
versions that support postBatchResumeToken. Assumes the stream has
never returned any changes if previous_change is None. Assumes
listener is a AllowListEventListener that listens for aggregate and
getMore commands.
"""
if previous_change is None or stream._cursor._has_next():
token = self._get_expected_resume_token_legacy(stream, listener, previous_change)
if token is not None:
return token
response = listener.succeeded_events[-1].reply
return response["cursor"]["postBatchResumeToken"]
@no_type_check
def _test_raises_error_on_missing_id(self, expected_exception):
"""ChangeStream will raise an exception if the server response is
missing the resume token.
"""
with self.change_stream([{"$project": {"_id": 0}}]) as change_stream:
self.watched_collection().insert_one({})
with self.assertRaises(expected_exception):
next(change_stream)
# The cursor should now be closed.
with self.assertRaises(StopIteration):
next(change_stream)
@no_type_check
def _test_update_resume_token(self, expected_rt_getter):
"""ChangeStream must continuously track the last seen resumeToken."""
client, listener = self._client_with_listener("aggregate", "getMore")
coll = self.watched_collection(write_concern=WriteConcern("majority"))
with self.change_stream_with_client(client) as change_stream:
self.assertEqual(
change_stream.resume_token, expected_rt_getter(change_stream, listener)
)
for _ in range(3):
coll.insert_one({})
change = next(change_stream)
self.assertEqual(
change_stream.resume_token, expected_rt_getter(change_stream, listener, change)
)
# Prose test no. 1
def test_update_resume_token(self):
self._test_update_resume_token(self._get_expected_resume_token)
# Prose test no. 2
def test_raises_error_on_missing_id_418plus(self):
# Server returns an error on 4.1.8+
self._test_raises_error_on_missing_id(OperationFailure)
# Prose test no. 3
@no_type_check
def test_resume_on_error(self):
with self.change_stream() as change_stream:
self.insert_one_and_check(change_stream, {"_id": 1})
# Cause a cursor not found error on the next getMore.
self.kill_change_stream_cursor(change_stream)
self.insert_one_and_check(change_stream, {"_id": 2})
# Prose test no. 4
@no_type_check
@client_context.require_failCommand_fail_point
def test_no_resume_attempt_if_aggregate_command_fails(self):
# Set non-retryable error on aggregate command.
fail_point = {"mode": {"times": 1}, "data": {"errorCode": 2, "failCommands": ["aggregate"]}}
client, listener = self._client_with_listener("aggregate", "getMore")
with self.fail_point(fail_point):
try:
_ = self.change_stream_with_client(client)
except OperationFailure:
pass
# Driver should have attempted aggregate command only once.
self.assertEqual(len(listener.started_events), 1)
self.assertEqual(listener.started_events[0].command_name, "aggregate")
# Prose test no. 5 - REMOVED
# Prose test no. 6 - SKIPPED
# Reason: readPreference is not configurable using the watch() helpers
# so we can skip this test. Also, PyMongo performs server selection for
# each operation which ensure compliance with this prose test.
# Prose test no. 7
@no_type_check
def test_initial_empty_batch(self):
with self.change_stream() as change_stream:
# The first batch should be empty.
self.assertFalse(change_stream._cursor._has_next())
cursor_id = change_stream._cursor.cursor_id
self.assertTrue(cursor_id)
self.insert_one_and_check(change_stream, {})
# Make sure we're still using the same cursor.
self.assertEqual(cursor_id, change_stream._cursor.cursor_id)
# Prose test no. 8
@no_type_check
def test_kill_cursors(self):
def raise_error():
raise ServerSelectionTimeoutError("mock error")
with self.change_stream() as change_stream:
self.insert_one_and_check(change_stream, {"_id": 1})
# Cause a cursor not found error on the next getMore.
cursor = change_stream._cursor
self.kill_change_stream_cursor(change_stream)
cursor.close = raise_error
self.insert_one_and_check(change_stream, {"_id": 2})
# Prose test no. 10 - SKIPPED
# This test is identical to prose test no. 3.
# Prose test no. 11
@no_type_check
def test_resumetoken_empty_batch(self):
client, listener = self._client_with_listener("getMore")
with self.change_stream_with_client(client) as change_stream:
self.assertIsNone(change_stream.try_next())
resume_token = change_stream.resume_token
response = listener.succeeded_events[0].reply
self.assertEqual(resume_token, response["cursor"]["postBatchResumeToken"])
# Prose test no. 11
@no_type_check
def test_resumetoken_exhausted_batch(self):
client, listener = self._client_with_listener("getMore")
with self.change_stream_with_client(client) as change_stream:
self._populate_and_exhaust_change_stream(change_stream)
resume_token = change_stream.resume_token
response = listener.succeeded_events[-1].reply
self.assertEqual(resume_token, response["cursor"]["postBatchResumeToken"])
# Prose test no. 13
@no_type_check
def test_resumetoken_partially_iterated_batch(self):
# When batch has been iterated up to but not including the last element.
# Resume token should be _id of previous change document.
with self.change_stream() as change_stream:
self.watched_collection(write_concern=WriteConcern("majority")).insert_many(
[{"data": k} for k in range(3)]
)
for _ in range(2):
change = next(change_stream)
resume_token = change_stream.resume_token
self.assertEqual(resume_token, change["_id"])
@no_type_check
def _test_resumetoken_uniterated_nonempty_batch(self, resume_option):
# When the batch is not empty and hasn't been iterated at all.
# Resume token should be same as the resume option used.
resume_point = self.get_resume_token()
# Insert some documents so that firstBatch isn't empty.
self.watched_collection(write_concern=WriteConcern("majority")).insert_many(
[{"a": 1}, {"b": 2}, {"c": 3}]
)
# Resume token should be same as the resume option.
with self.change_stream(**{resume_option: resume_point}) as change_stream:
self.assertTrue(change_stream._cursor._has_next())
resume_token = change_stream.resume_token
self.assertEqual(resume_token, resume_point)
# Prose test no. 14
@no_type_check
@client_context.require_no_mongos
def test_resumetoken_uniterated_nonempty_batch_resumeafter(self):
self._test_resumetoken_uniterated_nonempty_batch("resume_after")
# Prose test no. 14
@no_type_check
@client_context.require_no_mongos
def test_resumetoken_uniterated_nonempty_batch_startafter(self):
self._test_resumetoken_uniterated_nonempty_batch("start_after")
# Prose test no. 17
@no_type_check
def test_startafter_resume_uses_startafter_after_empty_getMore(self):
# Resume should use startAfter after no changes have been returned.
resume_point = self.get_resume_token()
client, listener = self._client_with_listener("aggregate")
with self.change_stream_with_client(client, start_after=resume_point) as change_stream:
self.assertFalse(change_stream._cursor._has_next()) # No changes
change_stream.try_next() # No changes
self.kill_change_stream_cursor(change_stream)
change_stream.try_next() # Resume attempt
response = listener.started_events[-1]
self.assertIsNone(response.command["pipeline"][0]["$changeStream"].get("resumeAfter"))
self.assertIsNotNone(response.command["pipeline"][0]["$changeStream"].get("startAfter"))
# Prose test no. 18
@no_type_check
def test_startafter_resume_uses_resumeafter_after_nonempty_getMore(self):
# Resume should use resumeAfter after some changes have been returned.
resume_point = self.get_resume_token()
client, listener = self._client_with_listener("aggregate")
with self.change_stream_with_client(client, start_after=resume_point) as change_stream:
self.assertFalse(change_stream._cursor._has_next()) # No changes
self.watched_collection().insert_one({})
next(change_stream) # Changes
self.kill_change_stream_cursor(change_stream)
change_stream.try_next() # Resume attempt
response = listener.started_events[-1]
self.assertIsNotNone(response.command["pipeline"][0]["$changeStream"].get("resumeAfter"))
self.assertIsNone(response.command["pipeline"][0]["$changeStream"].get("startAfter"))
# Prose test no. 19
@no_type_check
def test_split_large_change(self):
server_version = client_context.version
if not server_version.at_least(6, 0, 9):
self.skipTest("$changeStreamSplitLargeEvent requires MongoDB 6.0.9+")
if server_version.at_least(6, 1, 0) and server_version < Version(7, 0, 0):
self.skipTest("$changeStreamSplitLargeEvent is not available in 6.x rapid releases")
self.db.drop_collection("test_split_large_change")
coll = self.db.create_collection(
"test_split_large_change", changeStreamPreAndPostImages={"enabled": True}
)
coll.insert_one({"_id": 1, "value": "q" * 10 * 1024 * 1024})
with coll.watch(
[{"$changeStreamSplitLargeEvent": {}}], full_document_before_change="required"
) as change_stream:
coll.update_one({"_id": 1}, {"$set": {"value": "z" * 10 * 1024 * 1024}})
doc_1 = change_stream.next()
self.assertIn("splitEvent", doc_1)
self.assertEqual(doc_1["splitEvent"], {"fragment": 1, "of": 2})
doc_2 = change_stream.next()
self.assertIn("splitEvent", doc_2)
self.assertEqual(doc_2["splitEvent"], {"fragment": 2, "of": 2})
class TestClusterChangeStream(TestChangeStreamBase, APITestsMixin):
dbs: list
@client_context.require_change_streams # type:ignore[untyped-decorator]
def setUp(self) -> None:
super().setUp()
self.dbs = [self.db, self.client.pymongo_test_2]
def tearDown(self):
for db in self.dbs:
self.client.drop_database(db)
super().tearDown()
def change_stream_with_client(self, client, *args, **kwargs):
return client.watch(*args, **kwargs)
def generate_invalidate_event(self, change_stream):
self.skipTest("cluster-level change streams cannot be invalidated")
def _test_get_invalidate_event(self, change_stream):
# Cluster-level change streams don't get invalidated.
pass
def _test_invalidate_stops_iteration(self, change_stream):
# Cluster-level change streams don't get invalidated.
pass
def _insert_and_check(self, change_stream, db, collname, doc):
coll = db[collname]
coll.insert_one(doc)
change = next(change_stream)
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["ns"], {"db": db.name, "coll": collname})
self.assertEqual(change["fullDocument"], doc)
def insert_one_and_check(self, change_stream, doc):
db = random.choice(self.dbs)
collname = self.id()
self._insert_and_check(change_stream, db, collname, doc)
def test_simple(self):
collnames = self.generate_unique_collnames(3)
with self.change_stream() as change_stream:
for db, collname in product(self.dbs, collnames):
self._insert_and_check(change_stream, db, collname, {"_id": collname})
@client_context.require_sync
def test_aggregate_cursor_blocks(self):
"""Test that an aggregate cursor blocks until a change is readable."""
with self.client.admin.aggregate(
[{"$changeStream": {"allChangesForCluster": True}}], maxAwaitTimeMS=250
) as change_stream:
self._test_next_blocks(change_stream)
def test_full_pipeline(self):
"""$changeStream must be the first stage in a change stream pipeline
sent to the server.
"""
self._test_full_pipeline({"allChangesForCluster": True})
class TestDatabaseChangeStream(TestChangeStreamBase, APITestsMixin):
@client_context.require_change_streams # type:ignore[untyped-decorator]
def setUp(self) -> None:
super().setUp()
def change_stream_with_client(self, client, *args, **kwargs):
return client[self.db.name].watch(*args, **kwargs)
def generate_invalidate_event(self, change_stream):
# Dropping the database invalidates the change stream.
change_stream._client.drop_database(self.db.name)
def _test_get_invalidate_event(self, change_stream):
# Cache collection names.
dropped_colls = self.db.list_collection_names()
# Drop the watched database to get an invalidate event.
self.generate_invalidate_event(change_stream)
change = change_stream.next()
# 4.1+ returns "drop" events for each collection in dropped database
# and a "dropDatabase" event for the database itself.
if change["operationType"] == "drop":
self.assertTrue(change["_id"])
for _ in range(len(dropped_colls)):
ns = change["ns"]
self.assertEqual(ns["db"], change_stream._target.name)
self.assertIn(ns["coll"], dropped_colls)
change = change_stream.next()
self.assertEqual(change["operationType"], "dropDatabase")
self.assertTrue(change["_id"])
self.assertEqual(change["ns"], {"db": change_stream._target.name})
# Get next change.
change = change_stream.next()
self.assertTrue(change["_id"])
self.assertEqual(change["operationType"], "invalidate")
self.assertNotIn("ns", change)
self.assertNotIn("fullDocument", change)
# The ChangeStream should be dead.
with self.assertRaises(StopIteration):
change_stream.next()
def _test_invalidate_stops_iteration(self, change_stream):
# Drop the watched database to get an invalidate event.
change_stream._client.drop_database(self.db.name)
# Check drop and dropDatabase events.
for change in change_stream:
self.assertIn(change["operationType"], ("drop", "dropDatabase", "invalidate"))
# Last change must be invalidate.
self.assertEqual(change["operationType"], "invalidate")
# Change stream must not allow further iteration.
with self.assertRaises(StopIteration):
change_stream.next()
with self.assertRaises(StopIteration):
next(change_stream)
def _insert_and_check(self, change_stream, collname, doc):
coll = self.db[collname]
coll.insert_one(doc)
change = next(change_stream)
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["ns"], {"db": self.db.name, "coll": collname})
self.assertEqual(change["fullDocument"], doc)
def insert_one_and_check(self, change_stream, doc):
self._insert_and_check(change_stream, self.id(), doc)
def test_simple(self):
collnames = self.generate_unique_collnames(3)
with self.change_stream() as change_stream:
for collname in collnames:
self._insert_and_check(
change_stream, collname, {"_id": Binary.from_uuid(uuid.uuid4())}
)
def test_isolation(self):
# Ensure inserts to other dbs don't show up in our ChangeStream.
other_db = self.client.pymongo_test_temp
self.assertNotEqual(other_db, self.db, msg="Isolation must be tested on separate DBs")
collname = self.id()
with self.change_stream() as change_stream:
other_db[collname].insert_one({"_id": Binary.from_uuid(uuid.uuid4())})
self._insert_and_check(change_stream, collname, {"_id": Binary.from_uuid(uuid.uuid4())})
self.client.drop_database(other_db)
class TestCollectionChangeStream(TestChangeStreamBase, APITestsMixin, ProseSpecTestsMixin):
@client_context.require_change_streams
def setUp(self):
super().setUp()
# Use a new collection for each test.
self.watched_collection().drop()
self.db.create_collection(self.watched_collection().name)
def change_stream_with_client(self, client, *args, **kwargs):
return (
client[self.db.name]
.get_collection(self.watched_collection().name)
.watch(*args, **kwargs)
)
def generate_invalidate_event(self, change_stream):
# Dropping the collection invalidates the change stream.
change_stream._target.drop()
def _test_invalidate_stops_iteration(self, change_stream):
self.generate_invalidate_event(change_stream)
# Check drop and dropDatabase events.
for change in change_stream:
self.assertIn(change["operationType"], ("drop", "invalidate"))
# Last change must be invalidate.
self.assertEqual(change["operationType"], "invalidate")
# Change stream must not allow further iteration.
with self.assertRaises(StopIteration):
change_stream.next()
with self.assertRaises(StopIteration):
next(change_stream)
def _test_get_invalidate_event(self, change_stream):
# Drop the watched database to get an invalidate event.
change_stream._target.drop()
change = change_stream.next()
# 4.1+ returns a "drop" change document.
if change["operationType"] == "drop":
self.assertTrue(change["_id"])
self.assertEqual(
change["ns"],
{"db": change_stream._target.database.name, "coll": change_stream._target.name},
)
# Last change should be invalidate.
change = change_stream.next()
self.assertTrue(change["_id"])
self.assertEqual(change["operationType"], "invalidate")
self.assertNotIn("ns", change)
self.assertNotIn("fullDocument", change)
# The ChangeStream should be dead.
with self.assertRaises(StopIteration):
change_stream.next()
def insert_one_and_check(self, change_stream, doc):
self.watched_collection().insert_one(doc)
change = next(change_stream)
self.assertEqual(change["operationType"], "insert")
self.assertEqual(
change["ns"],
{"db": self.watched_collection().database.name, "coll": self.watched_collection().name},
)
self.assertEqual(change["fullDocument"], doc)
def test_raw(self):
"""Test with RawBSONDocument."""
raw_coll = self.watched_collection(codec_options=DEFAULT_RAW_BSON_OPTIONS)
with raw_coll.watch() as change_stream:
raw_doc = RawBSONDocument(encode({"_id": 1}))
self.watched_collection().insert_one(raw_doc)
change = next(change_stream)
self.assertIsInstance(change, RawBSONDocument)
self.assertEqual(change["operationType"], "insert")
self.assertEqual(change["ns"]["db"], self.watched_collection().database.name)
self.assertEqual(change["ns"]["coll"], self.watched_collection().name)
self.assertEqual(change["fullDocument"], raw_doc)
def test_uuid_representations(self):
"""Test with uuid document _ids and different uuid_representation."""
optime = (self.db.command("ping"))["operationTime"]
self.watched_collection().insert_many(
[
{"_id": Binary(uuid.uuid4().bytes, id_subtype)}
for id_subtype in (STANDARD, PYTHON_LEGACY)
]
)
for uuid_representation in ALL_UUID_REPRESENTATIONS:
options = self.watched_collection().codec_options.with_options(
uuid_representation=uuid_representation
)
coll = self.watched_collection(codec_options=options)
with coll.watch(start_at_operation_time=optime, max_await_time_ms=1) as change_stream:
_ = change_stream.next()
resume_token_1 = change_stream.resume_token
_ = change_stream.next()
resume_token_2 = change_stream.resume_token
# Should not error.
with coll.watch(resume_after=resume_token_1):
pass
with coll.watch(resume_after=resume_token_2):
pass
def test_document_id_order(self):
"""Test with document _ids that need their order preserved."""
random_keys = random.sample(string.ascii_letters, len(string.ascii_letters))
random_doc = {"_id": SON([(key, key) for key in random_keys])}
for document_class in (dict, SON, RawBSONDocument):
options = self.watched_collection().codec_options.with_options(
document_class=document_class
You can’t perform that action at this time.