Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
mongo-python-driver/test/helpers_shared.py at main · mongodb/mongo-python-driver · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
mongodb
/
mongo-python-driver
Public
Notifications
You must be signed in to change notification settings
Fork
1.2k
Star
4.4k
Code
Pull requests
16
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
mongo-python-driver
/
test
/
helpers_shared.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
271 lines (226 loc) · 8.52 KB
main
Breadcrumbs
mongo-python-driver
/
test
/
helpers_shared.py
Copy path
Top
File metadata and controls
Code
Blame
271 lines (226 loc) · 8.52 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
# Copyright 2019-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.
from
__future__
import
annotations
import
base64
import
gc
import
os
import
socket
import
subprocess
import
sys
import
traceback
import
unittest
from
pathlib
import
Path
try
:
import
ipaddress
HAVE_IPADDRESS
=
True
except
ImportError
:
HAVE_IPADDRESS
=
False
from
functools
import
wraps
from
typing
import
no_type_check
from
unittest
import
SkipTest
from
bson
.
son
import
SON
from
pymongo
import
message
from
pymongo
.
ssl_support
import
HAVE_SSL
,
_ssl
# type:ignore[attr-defined]
from
pymongo
.
synchronous
.
uri_parser
import
parse_uri
if
HAVE_SSL
:
import
ssl
# Enable debug output for uncollectable objects. PyPy does not have set_debug.
if
hasattr
(
gc
,
"set_debug"
):
gc
.
set_debug
(
gc
.
DEBUG_UNCOLLECTABLE
|
getattr
(
gc
,
"DEBUG_OBJECTS"
,
0
)
|
getattr
(
gc
,
"DEBUG_INSTANCES"
,
0
)
)
# The host and port of a single mongod or mongos, or the seed host
# for a replica set.
host
=
os
.
environ
.
get
(
"DB_IP"
,
"localhost"
)
port
=
int
(
os
.
environ
.
get
(
"DB_PORT"
,
27017
))
IS_SRV
=
"mongodb+srv"
in
host
db_user
=
os
.
environ
.
get
(
"DB_USER"
,
"user"
)
db_pwd
=
os
.
environ
.
get
(
"DB_PASSWORD"
,
"password"
)
HERE
=
Path
(
__file__
).
absolute
()
CERT_PATH
=
str
(
HERE
.
parent
/
"certificates"
)
CLIENT_PEM
=
os
.
environ
.
get
(
"CLIENT_PEM"
,
os
.
path
.
join
(
CERT_PATH
,
"client.pem"
))
CA_PEM
=
os
.
environ
.
get
(
"CA_PEM"
,
os
.
path
.
join
(
CERT_PATH
,
"ca.pem"
))
TLS_OPTIONS
:
dict
=
{
"tls"
:
True
}
if
CLIENT_PEM
:
TLS_OPTIONS
[
"tlsCertificateKeyFile"
]
=
CLIENT_PEM
if
CA_PEM
:
TLS_OPTIONS
[
"tlsCAFile"
]
=
CA_PEM
COMPRESSORS
=
os
.
environ
.
get
(
"COMPRESSORS"
)
MONGODB_API_VERSION
=
os
.
environ
.
get
(
"MONGODB_API_VERSION"
)
TEST_LOADBALANCER
=
bool
(
os
.
environ
.
get
(
"TEST_LOAD_BALANCER"
))
SINGLE_MONGOS_LB_URI
=
os
.
environ
.
get
(
"SINGLE_MONGOS_LB_URI"
)
MULTI_MONGOS_LB_URI
=
os
.
environ
.
get
(
"MULTI_MONGOS_LB_URI"
)
if
TEST_LOADBALANCER
:
res
=
parse_uri
(
SINGLE_MONGOS_LB_URI
or
""
)
host
,
port
=
res
[
"nodelist"
][
0
]
db_user
=
res
[
"username"
]
or
db_user
db_pwd
=
res
[
"password"
]
or
db_pwd
# Shared KMS data.
LOCAL_MASTER_KEY
=
base64
.
b64decode
(
b"Mng0NCt4ZHVUYUJCa1kxNkVyNUR1QURhZ2h2UzR2d2RrZzh0cFBwM3R6NmdWMDFBMUN3YkQ"
b"5aXRRMkhGRGdQV09wOGVNYUMxT2k3NjZKelhaQmRCZGJkTXVyZG9uSjFk"
)
AWS_CREDS
=
{
"accessKeyId"
:
os
.
environ
.
get
(
"FLE_AWS_KEY"
,
""
),
"secretAccessKey"
:
os
.
environ
.
get
(
"FLE_AWS_SECRET"
,
""
),
}
AWS_CREDS_2
=
{
"accessKeyId"
:
os
.
environ
.
get
(
"FLE_AWS_KEY2"
,
""
),
"secretAccessKey"
:
os
.
environ
.
get
(
"FLE_AWS_SECRET2"
,
""
),
}
AZURE_CREDS
=
{
"tenantId"
:
os
.
environ
.
get
(
"FLE_AZURE_TENANTID"
,
""
),
"clientId"
:
os
.
environ
.
get
(
"FLE_AZURE_CLIENTID"
,
""
),
"clientSecret"
:
os
.
environ
.
get
(
"FLE_AZURE_CLIENTSECRET"
,
""
),
}
GCP_CREDS
=
{
"email"
:
os
.
environ
.
get
(
"FLE_GCP_EMAIL"
,
""
),
"privateKey"
:
os
.
environ
.
get
(
"FLE_GCP_PRIVATEKEY"
,
""
),
}
KMIP_CREDS
=
{
"endpoint"
:
os
.
environ
.
get
(
"FLE_KMIP_ENDPOINT"
,
"localhost:5698"
)}
AWS_TEMP_CREDS
=
{
"accessKeyId"
:
os
.
environ
.
get
(
"CSFLE_AWS_TEMP_ACCESS_KEY_ID"
,
""
),
"secretAccessKey"
:
os
.
environ
.
get
(
"CSFLE_AWS_TEMP_SECRET_ACCESS_KEY"
,
""
),
"sessionToken"
:
os
.
environ
.
get
(
"CSFLE_AWS_TEMP_SESSION_TOKEN"
,
""
),
}
ALL_KMS_PROVIDERS
=
dict
(
aws
=
AWS_CREDS
,
azure
=
AZURE_CREDS
,
gcp
=
GCP_CREDS
,
local
=
dict
(
key
=
LOCAL_MASTER_KEY
),
kmip
=
KMIP_CREDS
,
)
DEFAULT_KMS_TLS
=
dict
(
kmip
=
dict
(
tlsCAFile
=
CA_PEM
,
tlsCertificateKeyFile
=
CLIENT_PEM
))
# Ensure Evergreen metadata doesn't result in truncation
os
.
environ
.
setdefault
(
"MONGOB_LOG_MAX_DOCUMENT_LENGTH"
,
"2000"
)
def
is_server_resolvable
():
"""Returns True if 'server' is resolvable."""
socket_timeout
=
socket
.
getdefaulttimeout
()
socket
.
setdefaulttimeout
(
1
)
try
:
try
:
socket
.
gethostbyname
(
"server"
)
return
True
except
OSError
:
return
False
finally
:
socket
.
setdefaulttimeout
(
socket_timeout
)
def
_create_user
(
authdb
,
user
,
pwd
=
None
,
roles
=
None
,
**
kwargs
):
cmd
=
SON
([(
"createUser"
,
user
)])
# X509 doesn't use a password
if
pwd
:
cmd
[
"pwd"
]
=
pwd
cmd
[
"roles"
]
=
roles
or
[
"root"
]
cmd
.
update
(
**
kwargs
)
return
authdb
.
command
(
cmd
)
def
_all_users
(
db
):
return
{
u
[
"user"
]
for
u
in
db
.
command
(
"usersInfo"
).
get
(
"users"
, [])}
def
sanitize_cmd
(
cmd
):
cp
=
cmd
.
copy
()
cp
.
pop
(
"$clusterTime"
,
None
)
cp
.
pop
(
"$db"
,
None
)
cp
.
pop
(
"$readPreference"
,
None
)
cp
.
pop
(
"lsid"
,
None
)
if
MONGODB_API_VERSION
:
# Stable API parameters
cp
.
pop
(
"apiVersion"
,
None
)
# OP_MSG encoding may move the payload type one field to the
# end of the command. Do the same here.
name
=
next
(
iter
(
cp
))
try
:
identifier
=
message
.
_FIELD_MAP
[
name
]
docs
=
cp
.
pop
(
identifier
)
cp
[
identifier
]
=
docs
except
KeyError
:
pass
return
cp
def
sanitize_reply
(
reply
):
cp
=
reply
.
copy
()
cp
.
pop
(
"$clusterTime"
,
None
)
cp
.
pop
(
"operationTime"
,
None
)
return
cp
def
print_thread_tracebacks
()
->
None
:
"""Print all Python thread tracebacks."""
for
thread_id
,
frame
in
sys
.
_current_frames
().
items
():
sys
.
stderr
.
write
(
f"
\n
--- Traceback for thread
{
thread_id
}
---
\n
"
)
traceback
.
print_stack
(
frame
,
file
=
sys
.
stderr
)
def
print_thread_stacks
(
pid
:
int
)
->
None
:
"""Print all C-level thread stacks for a given process id."""
if
sys
.
platform
==
"darwin"
:
cmd
=
[
"lldb"
,
"--attach-pid"
,
f"
{
pid
}
"
,
"--batch"
,
"--one-line"
,
'"thread backtrace all"'
]
else
:
cmd
=
[
"gdb"
,
f"--pid=
{
pid
}
"
,
"--batch"
,
'--eval-command="thread apply all bt"'
]
try
:
res
=
subprocess
.
run
(
cmd
,
stdout
=
subprocess
.
PIPE
,
stderr
=
subprocess
.
STDOUT
,
encoding
=
"utf-8"
)
except
Exception
as
exc
:
sys
.
stderr
.
write
(
f"Could not print C-level thread stacks because
{
cmd
[
0
]
}
failed:
{
exc
}
"
)
else
:
sys
.
stderr
.
write
(
res
.
stdout
)
def
_get_executors
(
topology
):
executors
=
[]
for
server
in
topology
.
_servers
.
values
():
# Some MockMonitor do not have an _executor.
if
hasattr
(
server
.
_monitor
,
"_executor"
):
executors
.
append
(
server
.
_monitor
.
_executor
)
if
hasattr
(
server
.
_monitor
,
"_rtt_monitor"
):
executors
.
append
(
server
.
_monitor
.
_rtt_monitor
.
_executor
)
executors
.
append
(
topology
.
_Topology__events_executor
)
if
topology
.
_srv_monitor
:
executors
.
append
(
topology
.
_srv_monitor
.
_executor
)
return
[
e
for
e
in
executors
if
e
is
not
None
]
def
print_running_topology
(
topology
):
running
=
[
e
for
e
in
_get_executors
(
topology
)
if
not
e
.
_stopped
]
if
running
:
print
(
"WARNING: found Topology with running threads:
\n
"
f" Threads:
{
running
}
\n
"
f" Topology:
{
topology
}
\n
"
f" Creation traceback:
\n
{
topology
.
_settings
.
_stack
}
"
)
def
test_cases
(
suite
):
"""Iterator over all TestCases within a TestSuite."""
for
suite_or_case
in
suite
.
_tests
:
if
isinstance
(
suite_or_case
,
unittest
.
TestCase
):
# unittest.TestCase
yield
suite_or_case
else
:
# unittest.TestSuite
yield
from
test_cases
(
suite_or_case
)
# Helper method to workaround https://bugs.python.org/issue21724
def
clear_warning_registry
():
"""Clear the __warningregistry__ for all modules."""
for
_
,
module
in
list
(
sys
.
modules
.
items
()):
if
hasattr
(
module
,
"__warningregistry__"
):
module
.
__warningregistry__
=
{}
# type:ignore[attr-defined]
class
SystemCertsPatcher
:
def
__init__
(
self
,
ca_certs
):
if
(
ssl
.
OPENSSL_VERSION
.
lower
().
startswith
(
"libressl"
)
and
sys
.
platform
==
"darwin"
and
not
_ssl
.
IS_PYOPENSSL
):
raise
SkipTest
(
"LibreSSL on OSX doesn't support setting CA certificates "
"using SSL_CERT_FILE environment variable."
)
self
.
original_certs
=
os
.
environ
.
get
(
"SSL_CERT_FILE"
)
# Tell OpenSSL where CA certificates live.
os
.
environ
[
"SSL_CERT_FILE"
]
=
ca_certs
def
disable
(
self
):
if
self
.
original_certs
is
None
:
os
.
environ
.
pop
(
"SSL_CERT_FILE"
)
else
:
os
.
environ
[
"SSL_CERT_FILE"
]
=
self
.
original_certs
You can’t perform that action at this time.