{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathtest_client.py
More file actions
2943 lines (2497 loc) · 116 KB
/
Copy pathtest_client.py
File metadata and controls
2943 lines (2497 loc) · 116 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 2013-present 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 mongo_client module."""
from __future__ import annotations
import _thread as thread
import asyncio
import base64
import contextlib
import copy
import datetime
import gc
import logging
import os
import re
import signal
import socket
import struct
import subprocess
import sys
import time
import uuid
from collections.abc import Iterable
from typing import Any, no_type_check
from unittest import mock, skipIf
from unittest.mock import patch
import pytest
from bson.binary import CSHARP_LEGACY, JAVA_LEGACY, PYTHON_LEGACY, Binary, UuidRepresentation
from pymongo.operations import _Op
sys.path[0:0] = [""]
import bson
import pymongo
from bson import encode
from bson.codec_options import (
CodecOptions,
DatetimeConversion,
TypeEncoder,
TypeRegistry,
)
from bson.son import SON
from bson.tz_util import utc
from pymongo import event_loggers, message, monitoring, network_layer
from pymongo.client_options import ClientOptions
from pymongo.common import _UUID_REPRESENTATIONS, CONNECT_TIMEOUT, MIN_SUPPORTED_WIRE_VERSION, has_c
from pymongo.compression_support import (
SnappyContext,
ZlibContext,
ZstdContext,
_have_snappy,
_have_zstd,
)
from pymongo.driver_info import DriverInfo
from pymongo.errors import (
AutoReconnect,
ConfigurationError,
ConnectionFailure,
InvalidName,
InvalidOperation,
InvalidURI,
NetworkTimeout,
OperationFailure,
ServerSelectionTimeoutError,
WaitQueueTimeoutError,
WriteConcernError,
)
from pymongo.monitoring import ServerHeartbeatListener, ServerHeartbeatStartedEvent
from pymongo.pool_options import _MAX_METADATA_SIZE, _METADATA, ENV_VAR_K8S, PoolOptions
from pymongo.read_preferences import ReadPreference
from pymongo.server_description import ServerDescription
from pymongo.server_selectors import readable_server_selector, writable_server_selector
from pymongo.server_type import SERVER_TYPE
from pymongo.synchronous.command_cursor import CommandCursor
from pymongo.synchronous.cursor import Cursor, CursorType
from pymongo.synchronous.database import Database
from pymongo.synchronous.helpers import next
from pymongo.synchronous.mongo_client import MongoClient, _ClientCheckout
from pymongo.synchronous.pool import (
Connection,
)
from pymongo.topology_description import TOPOLOGY_TYPE, TopologyDescription
from pymongo.topology_shared import _ErrorContext
from pymongo.write_concern import WriteConcern
from test import (
HAVE_IPADDRESS,
IntegrationTest,
MockClientTest,
SkipTest,
UnitTest,
client_context,
client_knobs,
connected,
db_pwd,
db_user,
remove_all_users,
unittest,
)
from test.helpers import ExceptionCatchingTask
from test.pymongo_mocks import MockClient
from test.test_binary import BinaryData
from test.utils import (
assertRaisesExactly,
get_pool,
wait_until,
)
from test.utils_shared import (
NTHREADS,
CMAPListener,
FunctionCallRecorder,
delay,
gevent_monkey_patched,
is_greenthread_patched,
lazy_client_trial,
one,
)
_IS_SYNC = True
class ClientUnitTest(UnitTest):
"""MongoClient tests that don't require a server."""
client: MongoClient
def setUp(self) -> None:
self.client = self.rs_or_single_client(connect=False, serverSelectionTimeoutMS=100)
@pytest.fixture(autouse=True)
def inject_fixtures(self, caplog):
self._caplog = caplog
def test_keyword_arg_defaults(self):
client = self.simple_client(
socketTimeoutMS=None,
connectTimeoutMS=20000,
waitQueueTimeoutMS=None,
replicaSet=None,
read_preference=ReadPreference.PRIMARY,
ssl=False,
tlsCertificateKeyFile=None,
tlsAllowInvalidCertificates=True,
tlsCAFile=None,
connect=False,
serverSelectionTimeoutMS=12000,
)
options = client.options
pool_opts = options.pool_options
self.assertEqual(None, pool_opts.socket_timeout)
# socket.Socket.settimeout takes a float in seconds
self.assertEqual(20.0, pool_opts.connect_timeout)
self.assertEqual(None, pool_opts.wait_queue_timeout)
self.assertEqual(None, pool_opts._ssl_context)
self.assertEqual(None, options.replica_set_name)
self.assertEqual(ReadPreference.PRIMARY, client.read_preference)
self.assertAlmostEqual(12, client.options.server_selection_timeout)
def test_connect_timeout(self):
client = self.simple_client(connect=False, connectTimeoutMS=None, socketTimeoutMS=None)
pool_opts = client.options.pool_options
self.assertEqual(None, pool_opts.socket_timeout)
self.assertEqual(None, pool_opts.connect_timeout)
client = self.simple_client(connect=False, connectTimeoutMS=0, socketTimeoutMS=0)
pool_opts = client.options.pool_options
self.assertEqual(None, pool_opts.socket_timeout)
self.assertEqual(None, pool_opts.connect_timeout)
client = self.simple_client(
"mongodb://localhost/?connectTimeoutMS=0&socketTimeoutMS=0", connect=False
)
pool_opts = client.options.pool_options
self.assertEqual(None, pool_opts.socket_timeout)
self.assertEqual(None, pool_opts.connect_timeout)
def test_types(self):
self.assertRaises(TypeError, MongoClient, 1)
self.assertRaises(TypeError, MongoClient, 1.14)
self.assertRaises(TypeError, MongoClient, "localhost", "27017")
self.assertRaises(TypeError, MongoClient, "localhost", 1.14)
self.assertRaises(TypeError, MongoClient, "localhost", [])
self.assertRaises(ConfigurationError, MongoClient, [])
def test_repr_redacts_aws_session_token(self):
token = "SECRET_AWS_SESSION_TOKEN"
client = MongoClient(
"mongodb://AKIA:SECRET@localhost:27017/"
f"?authMechanism=MONGODB-AWS&authMechanismProperties=AWS_SESSION_TOKEN:{token}",
connect=False,
)
the_repr = repr(client)
self.assertNotIn(token, the_repr)
self.assertIn("'AWS_SESSION_TOKEN': '<redacted>'", the_repr)
def test_repr_redacts_secret_auth_mechanism_properties(self):
token = "SECRET_AWS_SESSION_TOKEN"
api_key = "SECRET_API_KEY"
client = MongoClient(
"mongodb://AKIA:SECRET@localhost:27017/",
authMechanism="MONGODB-AWS",
authMechanismProperties={
"aws_session_token": token,
"CUSTOM_API_KEY": api_key,
"TOKEN_RESOURCE": "mongodb://cluster.example",
},
connect=False,
)
the_repr = repr(client)
self.assertNotIn(token, the_repr)
self.assertNotIn(api_key, the_repr)
self.assertIn("'aws_session_token': '<redacted>'", the_repr)
self.assertIn("'CUSTOM_API_KEY': '<redacted>'", the_repr)
self.assertIn("'TOKEN_RESOURCE': 'mongodb://cluster.example'", the_repr)
def test_max_pool_size_zero(self):
self.simple_client(maxPoolSize=0)
def test_uri_detection(self):
self.assertRaises(ConfigurationError, MongoClient, "/foo")
self.assertRaises(ConfigurationError, MongoClient, "://")
self.assertRaises(ConfigurationError, MongoClient, "foo/")
def test_get_db(self):
def make_db(base, name):
return base[name]
self.assertRaises(InvalidName, make_db, self.client, "")
self.assertRaises(InvalidName, make_db, self.client, "te$t")
self.assertRaises(InvalidName, make_db, self.client, "te.t")
self.assertRaises(InvalidName, make_db, self.client, "te\\t")
self.assertRaises(InvalidName, make_db, self.client, "te/t")
self.assertRaises(InvalidName, make_db, self.client, "te st")
self.assertIsInstance(self.client.test, Database)
self.assertEqual(self.client.test, self.client["test"])
self.assertEqual(self.client.test, Database(self.client, "test"))
def test_get_database(self):
codec_options = CodecOptions(tz_aware=True)
write_concern = WriteConcern(w=2, j=True)
db = self.client.get_database("foo", codec_options, ReadPreference.SECONDARY, write_concern)
self.assertEqual("foo", db.name)
self.assertEqual(codec_options, db.codec_options)
self.assertEqual(ReadPreference.SECONDARY, db.read_preference)
self.assertEqual(write_concern, db.write_concern)
def test_getattr(self):
self.assertIsInstance(self.client["_does_not_exist"], Database)
with self.assertRaises(AttributeError) as context:
self.client._does_not_exist
# Message should be:
# "AttributeError: MongoClient has no attribute '_does_not_exist'. To
# access the _does_not_exist database, use client['_does_not_exist']".
self.assertIn("has no attribute '_does_not_exist'", str(context.exception))
def test_iteration(self):
client = self.client
msg = "'MongoClient' object is not iterable"
# Iteration fails
with self.assertRaisesRegex(TypeError, msg):
for _ in client: # type: ignore[misc] # error: "None" not callable [misc]
break
# Index fails
with self.assertRaises(TypeError):
_ = client[0]
# next fails
with self.assertRaisesRegex(TypeError, "'MongoClient' object is not iterable"):
_ = next(client)
# .next() fails
with self.assertRaisesRegex(TypeError, "'MongoClient' object is not iterable"):
_ = client.next()
# Do not implement typing.Iterable.
self.assertNotIsInstance(client, Iterable)
def test_get_default_database(self):
c = self.rs_or_single_client(
"mongodb://%s:%d/foo" % (client_context.host, client_context.port),
connect=False,
)
self.assertEqual(Database(c, "foo"), c.get_default_database())
# Test that default doesn't override the URI value.
self.assertEqual(Database(c, "foo"), c.get_default_database("bar"))
codec_options = CodecOptions(tz_aware=True)
write_concern = WriteConcern(w=2, j=True)
db = c.get_default_database(None, codec_options, ReadPreference.SECONDARY, write_concern)
self.assertEqual("foo", db.name)
self.assertEqual(codec_options, db.codec_options)
self.assertEqual(ReadPreference.SECONDARY, db.read_preference)
self.assertEqual(write_concern, db.write_concern)
c = self.rs_or_single_client(
"mongodb://%s:%d/" % (client_context.host, client_context.port),
connect=False,
)
self.assertEqual(Database(c, "foo"), c.get_default_database("foo"))
def test_get_default_database_error(self):
# URI with no database.
c = self.rs_or_single_client(
"mongodb://%s:%d/" % (client_context.host, client_context.port),
connect=False,
)
self.assertRaises(ConfigurationError, c.get_default_database)
def test_get_default_database_with_authsource(self):
# Ensure we distinguish database name from authSource.
uri = "mongodb://%s:%d/foo?authSource=src" % (
client_context.host,
client_context.port,
)
c = self.rs_or_single_client(uri, connect=False)
self.assertEqual(Database(c, "foo"), c.get_default_database())
def test_get_database_default(self):
c = self.rs_or_single_client(
"mongodb://%s:%d/foo" % (client_context.host, client_context.port),
connect=False,
)
self.assertEqual(Database(c, "foo"), c.get_database())
def test_get_database_default_error(self):
# URI with no database.
c = self.rs_or_single_client(
"mongodb://%s:%d/" % (client_context.host, client_context.port),
connect=False,
)
self.assertRaises(ConfigurationError, c.get_database)
def test_get_database_default_with_authsource(self):
# Ensure we distinguish database name from authSource.
uri = "mongodb://%s:%d/foo?authSource=src" % (
client_context.host,
client_context.port,
)
c = self.rs_or_single_client(uri, connect=False)
self.assertEqual(Database(c, "foo"), c.get_database())
def test_primary_read_pref_with_tags(self):
# No tags allowed with "primary".
with self.assertRaises(ConfigurationError):
self.single_client("mongodb://host/?readpreferencetags=dc:east")
with self.assertRaises(ConfigurationError):
self.single_client("mongodb://host/?readpreference=primary&readpreferencetags=dc:east")
def test_read_preference(self):
c = self.rs_or_single_client(
"mongodb://host", connect=False, readpreference=ReadPreference.NEAREST.mongos_mode
)
self.assertEqual(c.read_preference, ReadPreference.NEAREST)
def test_metadata(self):
metadata = copy.deepcopy(_METADATA)
if has_c():
metadata["driver"]["name"] = "PyMongo|c"
else:
metadata["driver"]["name"] = "PyMongo"
metadata["application"] = {"name": "foobar"}
client = self.simple_client("mongodb://foo:27017/?appname=foobar&connect=false")
options = client.options
self.assertEqual(options.pool_options.metadata, metadata)
client = self.simple_client("foo", 27017, appname="foobar", connect=False)
options = client.options
self.assertEqual(options.pool_options.metadata, metadata)
# No error
self.simple_client(appname="x" * 128)
with self.assertRaises(ValueError):
self.simple_client(appname="x" * 129)
# Bad "driver" options.
self.assertRaises(TypeError, DriverInfo, "Foo", 1, "a")
self.assertRaises(TypeError, DriverInfo, version="1", platform="a")
self.assertRaises(TypeError, DriverInfo)
with self.assertRaises(TypeError):
self.simple_client(driver=1)
with self.assertRaises(TypeError):
self.simple_client(driver="abc")
with self.assertRaises(TypeError):
self.simple_client(driver=("Foo", "1", "a"))
# Test appending to driver info.
if has_c():
metadata["driver"]["name"] = "PyMongo|c|FooDriver"
else:
metadata["driver"]["name"] = "PyMongo|FooDriver"
metadata["driver"]["version"] = "{}|1.2.3".format(_METADATA["driver"]["version"])
client = self.simple_client(
"foo",
27017,
appname="foobar",
driver=DriverInfo("FooDriver", "1.2.3", None),
connect=False,
)
options = client.options
self.assertEqual(options.pool_options.metadata, metadata)
metadata["platform"] = "{}|FooPlatform".format(_METADATA["platform"])
client = self.simple_client(
"foo",
27017,
appname="foobar",
driver=DriverInfo("FooDriver", "1.2.3", "FooPlatform"),
connect=False,
)
options = client.options
self.assertEqual(options.pool_options.metadata, metadata)
# Test truncating driver info metadata.
client = self.simple_client(
driver=DriverInfo(name="s" * _MAX_METADATA_SIZE),
connect=False,
)
options = client.options
self.assertLessEqual(
len(bson.encode(options.pool_options.metadata)),
_MAX_METADATA_SIZE,
)
client = self.simple_client(
driver=DriverInfo(name="s" * _MAX_METADATA_SIZE, version="s" * _MAX_METADATA_SIZE),
connect=False,
)
options = client.options
self.assertLessEqual(
len(bson.encode(options.pool_options.metadata)),
_MAX_METADATA_SIZE,
)
@mock.patch.dict("os.environ", {ENV_VAR_K8S: "1"})
def test_container_metadata(self):
metadata = copy.deepcopy(_METADATA)
metadata["driver"]["name"] = "PyMongo"
metadata["env"] = {}
metadata["env"]["container"] = {"orchestrator": "kubernetes"}
client = self.simple_client("mongodb://foo:27017/?appname=foobar&connect=false")
options = client.options
self.assertEqual(options.pool_options.metadata["env"], metadata["env"])
def test_kwargs_codec_options(self):
class MyFloatType:
def __init__(self, x):
self.__x = x
@property
def x(self):
return self.__x
class MyFloatAsIntEncoder(TypeEncoder):
python_type = MyFloatType
def transform_python(self, value):
return int(value)
# Ensure codec options are passed in correctly
document_class: type[SON] = SON
type_registry = TypeRegistry([MyFloatAsIntEncoder()])
tz_aware = True
uuid_representation_label = "javaLegacy"
unicode_decode_error_handler = "ignore"
tzinfo = utc
c = self.simple_client(
document_class=document_class,
type_registry=type_registry,
tz_aware=tz_aware,
uuidrepresentation=uuid_representation_label,
unicode_decode_error_handler=unicode_decode_error_handler,
tzinfo=tzinfo,
connect=False,
)
self.assertEqual(c.codec_options.document_class, document_class)
self.assertEqual(c.codec_options.type_registry, type_registry)
self.assertEqual(c.codec_options.tz_aware, tz_aware)
self.assertEqual(
c.codec_options.uuid_representation,
_UUID_REPRESENTATIONS[uuid_representation_label],
)
self.assertEqual(c.codec_options.unicode_decode_error_handler, unicode_decode_error_handler)
self.assertEqual(c.codec_options.tzinfo, tzinfo)
def test_uri_codec_options(self):
# Ensure codec options are passed in correctly
uuid_representation_label = "javaLegacy"
unicode_decode_error_handler = "ignore"
datetime_conversion = "DATETIME_CLAMP"
uri = (
"mongodb://%s:%d/foo?tz_aware=true&uuidrepresentation="
"%s&unicode_decode_error_handler=%s"
"&datetime_conversion=%s"
% (
client_context.host,
client_context.port,
uuid_representation_label,
unicode_decode_error_handler,
datetime_conversion,
)
)
c = self.simple_client(uri, connect=False)
self.assertEqual(c.codec_options.tz_aware, True)
self.assertEqual(
c.codec_options.uuid_representation,
_UUID_REPRESENTATIONS[uuid_representation_label],
)
self.assertEqual(c.codec_options.unicode_decode_error_handler, unicode_decode_error_handler)
self.assertEqual(
c.codec_options.datetime_conversion, DatetimeConversion[datetime_conversion]
)
# Change the passed datetime_conversion to a number and re-assert.
uri = uri.replace(datetime_conversion, f"{int(DatetimeConversion[datetime_conversion])}")
c = self.simple_client(uri, connect=False)
self.assertEqual(
c.codec_options.datetime_conversion, DatetimeConversion[datetime_conversion]
)
def test_uri_option_precedence(self):
# Ensure kwarg options override connection string options.
uri = "mongodb://localhost/?ssl=true&replicaSet=name&readPreference=primary"
c = self.simple_client(
uri, ssl=False, replicaSet="newname", readPreference="secondaryPreferred"
)
clopts = c.options
opts = clopts._options
self.assertEqual(opts["tls"], False)
self.assertEqual(clopts.replica_set_name, "newname")
self.assertEqual(clopts.read_preference, ReadPreference.SECONDARY_PREFERRED)
def test_connection_timeout_ms_propagates_to_DNS_resolver(self):
# Patch the resolver.
from pymongo.synchronous.srv_resolver import _resolve
patched_resolver = FunctionCallRecorder(_resolve)
pymongo.synchronous.srv_resolver._resolve = patched_resolver
def reset_resolver():
pymongo.synchronous.srv_resolver._resolve = _resolve
self.addCleanup(reset_resolver)
# Setup.
base_uri = "mongodb+srv://test5.test.build.10gen.cc"
connectTimeoutMS = 5000
expected_kw_value = 5.0
uri_with_timeout = base_uri + "/?connectTimeoutMS=6000"
expected_uri_value = 6.0
def test_scenario(args, kwargs, expected_value):
patched_resolver.reset()
self.simple_client(*args, **kwargs)
for _, kw in patched_resolver.call_list():
self.assertAlmostEqual(kw["lifetime"], expected_value)
# No timeout specified.
test_scenario((base_uri,), {}, CONNECT_TIMEOUT)
# Timeout only specified in connection string.
test_scenario((uri_with_timeout,), {}, expected_uri_value)
# Timeout only specified in keyword arguments.
kwarg = {"connectTimeoutMS": connectTimeoutMS}
test_scenario((base_uri,), kwarg, expected_kw_value)
# Timeout specified in both kwargs and connection string.
test_scenario((uri_with_timeout,), kwarg, expected_kw_value)
def test_uri_security_options(self):
# Ensure that we don't silently override security-related options.
with self.assertRaises(InvalidURI):
self.simple_client("mongodb://localhost/?ssl=true", tls=False, connect=False)
# Matching SSL and TLS options should not cause errors.
c = self.simple_client("mongodb://localhost/?ssl=false", tls=False, connect=False)
self.assertEqual(c.options._options["tls"], False)
# Conflicting tlsInsecure options should raise an error.
with self.assertRaises(InvalidURI):
self.simple_client(
"mongodb://localhost/?tlsInsecure=true",
connect=False,
tlsAllowInvalidHostnames=True,
)
# Conflicting legacy tlsInsecure options should also raise an error.
with self.assertRaises(InvalidURI):
self.simple_client(
"mongodb://localhost/?tlsInsecure=true",
connect=False,
tlsAllowInvalidCertificates=False,
)
# Conflicting kwargs should raise InvalidURI
with self.assertRaises(InvalidURI):
self.simple_client(ssl=True, tls=False)
def test_event_listeners(self):
c = self.simple_client(event_listeners=[], connect=False)
self.assertEqual(c.options.event_listeners, [])
listeners = [
event_loggers.CommandLogger(),
event_loggers.HeartbeatLogger(),
event_loggers.ServerLogger(),
event_loggers.TopologyLogger(),
event_loggers.ConnectionPoolLogger(),
]
c = self.simple_client(event_listeners=listeners, connect=False)
self.assertEqual(c.options.event_listeners, listeners)
def test_client_options(self):
c = self.simple_client(connect=False)
self.assertIsInstance(c.options, ClientOptions)
self.assertIsInstance(c.options.pool_options, PoolOptions)
self.assertEqual(c.options.server_selection_timeout, 30)
self.assertEqual(c.options.pool_options.max_idle_time_seconds, None)
self.assertIsInstance(c.options.retry_writes, bool)
self.assertIsInstance(c.options.retry_reads, bool)
def test_validate_suggestion(self):
"""Validate kwargs in constructor."""
for typo in ["auth", "Auth", "AUTH"]:
expected = f"Unknown option: {typo}. Did you mean one of (authsource, authmechanism, authoidcallowedhosts) or maybe a camelCase version of one? Refer to docstring."
expected = re.escape(expected)
with self.assertRaisesRegex(ConfigurationError, expected):
MongoClient(**{typo: "standard"}) # type: ignore[arg-type]
@patch("pymongo.synchronous.srv_resolver._SrvResolver.get_hosts")
def test_detected_environment_logging(self, mock_get_hosts):
normal_hosts = [
"normal.host.com",
"host.cosmos.azure.com",
"host.docdb.amazonaws.com",
"host.docdb-elastic.amazonaws.com",
]
srv_hosts = ["mongodb+srv://<test>:<test>@" + s for s in normal_hosts]
multi_host = (
"host.cosmos.azure.com,host.docdb.amazonaws.com,host.docdb-elastic.amazonaws.com"
)
with self.assertLogs("pymongo", level="INFO") as cm:
for host in normal_hosts:
MongoClient(host, connect=False)
for host in srv_hosts:
mock_get_hosts.return_value = [(host, 1)]
MongoClient(host, connect=False)
MongoClient(multi_host, connect=False)
logs = [record.getMessage() for record in cm.records if record.name == "pymongo.client"]
self.assertEqual(len(logs), 7)
@skipIf(os.environ.get("DEBUG_LOG"), "Enabling debug logs breaks this test")
@patch("pymongo.synchronous.srv_resolver._SrvResolver.get_hosts")
def test_detected_environment_warning(self, mock_get_hosts):
with self._caplog.at_level(logging.WARN):
normal_hosts = [
"host.cosmos.azure.com",
"host.docdb.amazonaws.com",
"host.docdb-elastic.amazonaws.com",
]
srv_hosts = ["mongodb+srv://<test>:<test>@" + s for s in normal_hosts]
multi_host = (
"host.cosmos.azure.com,host.docdb.amazonaws.com,host.docdb-elastic.amazonaws.com"
)
for host in normal_hosts:
with self.assertWarns(UserWarning):
self.simple_client(host)
for host in srv_hosts:
mock_get_hosts.return_value = [(host, 1)]
with self.assertWarns(UserWarning):
self.simple_client(host)
with self.assertWarns(UserWarning):
self.simple_client(multi_host)
def test_max_adaptive_retries(self):
# Assert that max adaptive retries defaults to 2.
c = self.simple_client(connect=False)
self.assertEqual(c.options.max_adaptive_retries, 2)
# Assert that max adaptive retries can be configured through connection or client options.
c = self.simple_client(connect=False, max_adaptive_retries=10)
self.assertEqual(c.options.max_adaptive_retries, 10)
c = self.simple_client(connect=False, maxAdaptiveRetries=10)
self.assertEqual(c.options.max_adaptive_retries, 10)
c = self.simple_client(host="mongodb://localhost/?maxAdaptiveRetries=10", connect=False)
self.assertEqual(c.options.max_adaptive_retries, 10)
def test_enable_overload_retargeting(self):
# Assert that overload retargeting defaults to false.
c = self.simple_client(connect=False)
self.assertFalse(c.options.enable_overload_retargeting)
# Assert that overload retargeting can be enabled through connection or client options.
c = self.simple_client(connect=False, enable_overload_retargeting=True)
self.assertTrue(c.options.enable_overload_retargeting)
c = self.simple_client(connect=False, enableOverloadRetargeting=True)
self.assertTrue(c.options.enable_overload_retargeting)
c = self.simple_client(
host="mongodb://localhost/?enableOverloadRetargeting=true", connect=False
)
self.assertTrue(c.options.enable_overload_retargeting)
class TestClient(IntegrationTest):
def test_multiple_uris(self):
with self.assertRaises(ConfigurationError):
MongoClient(
host=[
"mongodb+srv://cluster-a.abc12.mongodb.net",
"mongodb+srv://cluster-b.abc12.mongodb.net",
"mongodb+srv://cluster-c.abc12.mongodb.net",
]
)
def test_max_idle_time_reaper_default(self):
with client_knobs(kill_cursor_frequency=0.1):
# Assert reaper doesn't remove connections when maxIdleTimeMS not set
client = self.rs_or_single_client()
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
with server._pool.checkout() as conn:
pass
self.assertEqual(1, len(server._pool.conns))
self.assertIn(conn, server._pool.conns)
def test_max_idle_time_reaper_removes_stale_minPoolSize(self):
with client_knobs(kill_cursor_frequency=0.1):
# Assert reaper removes idle socket and replaces it with a new one
client = self.rs_or_single_client(maxIdleTimeMS=500, minPoolSize=1)
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
with server._pool.checkout() as conn:
pass
# When the reaper runs at the same time as the get_socket, two
# connections could be created and checked into the pool.
self.assertGreaterEqual(len(server._pool.conns), 1)
wait_until(lambda: conn not in server._pool.conns, "remove stale socket")
wait_until(lambda: len(server._pool.conns) >= 1, "replace stale socket")
def test_max_idle_time_reaper_does_not_exceed_maxPoolSize(self):
with client_knobs(kill_cursor_frequency=0.1):
# Assert reaper respects maxPoolSize when adding new connections.
client = self.rs_or_single_client(maxIdleTimeMS=500, minPoolSize=1, maxPoolSize=1)
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
with server._pool.checkout() as conn:
pass
# When the reaper runs at the same time as the get_socket,
# maxPoolSize=1 should prevent two connections from being created.
self.assertEqual(1, len(server._pool.conns))
wait_until(lambda: conn not in server._pool.conns, "remove stale socket")
wait_until(lambda: len(server._pool.conns) == 1, "replace stale socket")
def test_max_idle_time_reaper_removes_stale(self):
with client_knobs(kill_cursor_frequency=0.1):
# Assert reaper has removed idle socket and NOT replaced it
client = self.rs_or_single_client(maxIdleTimeMS=500)
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
with server._pool.checkout() as conn_one:
pass
# Assert that the pool does not close connections prematurely.
time.sleep(0.300)
with server._pool.checkout() as conn_two:
pass
self.assertIs(conn_one, conn_two)
wait_until(
lambda: len(server._pool.conns) == 0,
"stale socket reaped and new one NOT added to the pool",
)
def test_min_pool_size(self):
with client_knobs(kill_cursor_frequency=0.1):
client = self.rs_or_single_client()
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
self.assertEqual(0, len(server._pool.conns))
# Assert that pool started up at minPoolSize
client = self.rs_or_single_client(minPoolSize=10)
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
wait_until(
lambda: len(server._pool.conns) == 10,
"pool initialized with 10 connections",
)
# Assert that if a socket is closed, a new one takes its place
with server._pool.checkout() as conn:
conn.close_conn(None)
wait_until(
lambda: len(server._pool.conns) == 10,
"a closed socket gets replaced from the pool",
)
self.assertNotIn(conn, server._pool.conns)
def test_max_idle_time_checkout(self):
# Use high frequency to test _get_socket_no_auth.
with client_knobs(kill_cursor_frequency=99999999):
client = self.rs_or_single_client(maxIdleTimeMS=500)
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
with server._pool.checkout() as conn:
pass
self.assertEqual(1, len(server._pool.conns))
time.sleep(1) # Sleep so that the socket becomes stale.
with server._pool.checkout() as new_con:
self.assertNotEqual(conn, new_con)
self.assertEqual(1, len(server._pool.conns))
self.assertNotIn(conn, server._pool.conns)
self.assertIn(new_con, server._pool.conns)
# Test that connections are reused if maxIdleTimeMS is not set.
client = self.rs_or_single_client()
server = (client._get_topology()).select_server(readable_server_selector, _Op.TEST)
with server._pool.checkout() as conn:
pass
self.assertEqual(1, len(server._pool.conns))
time.sleep(1)
with server._pool.checkout() as new_con:
self.assertEqual(conn, new_con)
self.assertEqual(1, len(server._pool.conns))
def test_client_checkout_setup_failure_returns_connection(self):
# Verify that the connection is returned to the pool when an exception
# is raised during _ClientCheckout.__enter__ post-checkout setup
# (e.g. session pinning or the auto-encryption wire-version check).
# Use a subclass to override contribute_socket because __slots__ prevents
# instance-level patching of methods.
class _BrokenSetupCheckout(_ClientCheckout):
def contribute_socket(self, conn, completed_handshake=True):
raise RuntimeError("simulated failure in post-checkout setup")
client = self.rs_or_single_client()
server = (client._get_topology()).select_server(writable_server_selector, _Op.TEST)
pool = server.pool
with self.assertRaises(RuntimeError):
with _BrokenSetupCheckout(client, server, None):
pass
# Connection was returned to pool, not leaked.
self.assertEqual(0, pool.active_sockets)
def test_client_checkout_setup_failure_unpins_session(self):
# Verify that session._unpin() is called when an exception is raised
# during _ClientCheckout.__enter__ after session._pin() has run (e.g.
# the auto-encryption wire-version check).
class _PinThenFailCheckout(_ClientCheckout):
def contribute_socket(self, conn, completed_handshake=True):
# Simulate session._pin() having already been called, then fail.
if self.session:
self.session._pin(self._server, conn)
raise RuntimeError("simulated post-pin failure")
client = self.rs_or_single_client()
server = (client._get_topology()).select_server(writable_server_selector, _Op.TEST)
with client.start_session() as session:
session.start_transaction()
with self.assertRaises(RuntimeError):
with _PinThenFailCheckout(client, server, session):
pass
# Session must be unpinned so future operations don't route to a stale
# server address or attempt a double-checkin through conn_mgr.
self.assertIsNone(session._transaction.pinned_address)
self.assertIsNone(session._transaction.conn_mgr)
def test_constants(self):
"""This test uses MongoClient explicitly to make sure that host and
port are not overloaded.
"""
host, port = client_context.host, client_context.port
kwargs: dict = client_context.default_client_options.copy()
if client_context.auth_enabled:
kwargs["username"] = db_user
kwargs["password"] = db_pwd
# Set bad defaults.
MongoClient.HOST = "somedomainthatdoesntexist.org"
MongoClient.PORT = 123456789
with self.assertRaises(AutoReconnect):
c = self.simple_client(serverSelectionTimeoutMS=10, **kwargs)
connected(c)
c = self.simple_client(host, port, **kwargs)
# Override the defaults. No error.
connected(c)
# Set good defaults.
MongoClient.HOST = host
MongoClient.PORT = port
# No error.
c = self.simple_client(**kwargs)
connected(c)
def test_init_disconnected(self):
host, port = client_context.host, client_context.port
c = self.rs_or_single_client(connect=False)
# is_primary causes client to block until connected
self.assertIsInstance(c.is_primary, bool)
c = self.rs_or_single_client(connect=False)
self.assertIsInstance(c.is_mongos, bool)
c = self.rs_or_single_client(connect=False)
self.assertIsInstance(c.options.pool_options.max_pool_size, int)
self.assertIsInstance(c.nodes, frozenset)
c = self.rs_or_single_client(connect=False)
self.assertEqual(c.codec_options, CodecOptions())
c = self.rs_or_single_client(connect=False)
self.assertFalse(c.primary)
self.assertFalse(c.secondaries)
c = self.rs_or_single_client(connect=False)
self.assertIsInstance(c.topology_description, TopologyDescription)
self.assertEqual(c.topology_description, c._topology._description)
if client_context.is_rs:
# The primary's host and port are from the replica set config.
self.assertIsNotNone(c.address)
else:
self.assertEqual(c.address, (host, port))
bad_host = "somedomainthatdoesntexist.org"
c = self.simple_client(bad_host, port, connectTimeoutMS=1, serverSelectionTimeoutMS=10)
with self.assertRaises(ConnectionFailure):
c.pymongo_test.coll.find_one()
def test_init_disconnected_with_auth(self):
uri = "mongodb://user:pass@somedomainthatdoesntexist"
c = self.simple_client(uri, connectTimeoutMS=1, serverSelectionTimeoutMS=10)
with self.assertRaises(ConnectionFailure):
c.pymongo_test.coll.find_one()
@client_context.require_replica_set
@client_context.require_no_load_balancer
@client_context.require_tls
def test_init_disconnected_with_srv(self):
c = self.rs_or_single_client(
"mongodb+srv://test1.test.build.10gen.cc", connect=False, tlsInsecure=True
)
# nodes returns an empty set if not connected
self.assertEqual(c.nodes, frozenset())
# topology_description returns the initial seed description if not connected
topology_description = c.topology_description
self.assertEqual(topology_description.topology_type, TOPOLOGY_TYPE.Unknown)
self.assertEqual(
{
("test1.test.build.10gen.cc", None): ServerDescription(
("test1.test.build.10gen.cc", None)
)
},
topology_description.server_descriptions(),
)
# address causes client to block until connected
self.assertIsNotNone(c.address)
# Initial seed topology and connected topology have the same ID
self.assertEqual(
c._topology._topology_id, topology_description._topology_settings._topology_id
)
c.close()
c = self.rs_or_single_client(
"mongodb+srv://test1.test.build.10gen.cc", connect=False, tlsInsecure=True
)
# primary causes client to block until connected
c.primary
self.assertIsNotNone(c._topology)
c.close()
c = self.rs_or_single_client(
"mongodb+srv://test1.test.build.10gen.cc", connect=False, tlsInsecure=True
)
# secondaries causes client to block until connected
c.secondaries
self.assertIsNotNone(c._topology)
c.close()
c = self.rs_or_single_client(
"mongodb+srv://test1.test.build.10gen.cc", connect=False, tlsInsecure=True
)
# arbiters causes client to block until connected
c.arbiters
self.assertIsNotNone(c._topology)
def test_equality(self):
seed = "{}:{}".format(*list(self.client._topology_settings.seeds)[0])
You can’t perform that action at this time.