mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:mongodb/mongo-python-driver

Browse Source
This commit is contained in:
Steven Silvester 2024-10-14 06:30:50 -05:00
commit bd12579bd8
No known key found for this signature in database
GPG Key ID: B1BF5EC3A8B32F91
3 changed files with 179 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

159
test/asynchronous/test_comment.py Normal file
View File

@ -0,0 +1,159 @@
# Copyright 2022-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 keyword argument 'comment' in various helpers."""
from __future__ import annotations
import inspect
import sys
sys.path[0:0] = [""]
from asyncio import iscoroutinefunction
from test.asynchronous import AsyncIntegrationTest, async_client_context, unittest
from test.utils import OvertCommandListener
from bson.dbref import DBRef
from pymongo.asynchronous.command_cursor import AsyncCommandCursor
from pymongo.operations import IndexModel
_IS_SYNC = False
class AsyncTestComment(AsyncIntegrationTest):
async def _test_ops(
self,
helpers,
already_supported,
listener,
):
for h, args in helpers:
c = "testing comment with " + h.__name__
with self.subTest("collection-" + h.__name__ + "-comment"):
for cc in [c, {"key": c}, ["any", 1]]:
listener.reset()
kwargs = {"comment": cc}
try:
maybe_cursor = await h(*args, **kwargs)
except Exception:
maybe_cursor = None
self.assertIn(
"comment",
inspect.signature(h).parameters,
msg="Could not find 'comment' in the "
"signature of function %s" % (h.__name__),
)
self.assertEqual(
inspect.signature(h).parameters["comment"].annotation, "Optional[Any]"
)
if isinstance(maybe_cursor, AsyncCommandCursor):
await maybe_cursor.close()
cmd = listener.started_events[0]
self.assertEqual(cc, cmd.command.get("comment"), msg=cmd)
if h.__name__ != "aggregate_raw_batches":
self.assertIn(
":param comment:",
h.__doc__,
)
if h not in already_supported:
self.assertIn(
"Added ``comment`` parameter",
h.__doc__,
)
else:
self.assertNotIn(
"Added ``comment`` parameter",
h.__doc__,
)
listener.reset()
@async_client_context.require_version_min(4, 7, -1)
@async_client_context.require_replica_set
async def test_database_helpers(self):
listener = OvertCommandListener()
db = (await self.async_rs_or_single_client(event_listeners=[listener])).db
helpers = [
(db.watch, []),
(db.command, ["hello"]),
(db.list_collections, []),
(db.list_collection_names, []),
(db.drop_collection, ["hello"]),
(db.validate_collection, ["test"]),
(db.dereference, [DBRef("collection", 1)]),
]
already_supported = [db.command, db.list_collections, db.list_collection_names]
await self._test_ops(helpers, already_supported, listener)
@async_client_context.require_version_min(4, 7, -1)
@async_client_context.require_replica_set
async def test_client_helpers(self):
listener = OvertCommandListener()
cli = await self.async_rs_or_single_client(event_listeners=[listener])
helpers = [
(cli.watch, []),
(cli.list_databases, []),
(cli.list_database_names, []),
(cli.drop_database, ["test"]),
]
already_supported = [
cli.list_databases,
]
await self._test_ops(helpers, already_supported, listener)
@async_client_context.require_version_min(4, 7, -1)
async def test_collection_helpers(self):
listener = OvertCommandListener()
db = (await self.async_rs_or_single_client(event_listeners=[listener]))[self.db.name]
coll = db.get_collection("test")
helpers = [
(coll.list_indexes, []),
(coll.drop, []),
(coll.index_information, []),
(coll.options, []),
(coll.aggregate, [[{"$set": {"x": 1}}]]),
(coll.aggregate_raw_batches, [[{"$set": {"x": 1}}]]),
(coll.rename, ["temp_temp_temp"]),
(coll.distinct, ["_id"]),
(coll.find_one_and_delete, [{}]),
(coll.find_one_and_replace, [{}, {}]),
(coll.find_one_and_update, [{}, {"$set": {"a": 1}}]),
(coll.estimated_document_count, []),
(coll.count_documents, [{}]),
(coll.create_indexes, [[IndexModel("a")]]),
(coll.create_index, ["a"]),
(coll.drop_index, [[("a", 1)]]),
(coll.drop_indexes, []),
]
already_supported = [
coll.estimated_document_count,
coll.count_documents,
coll.create_indexes,
coll.drop_indexes,
coll.options,
coll.find_one_and_replace,
coll.drop_index,
coll.rename,
coll.distinct,
coll.find_one_and_delete,
coll.find_one_and_update,
]
await self._test_ops(helpers, already_supported, listener)
if __name__ == "__main__":
unittest.main()

60
test/test_comment.py
View File

@ -20,24 +20,15 @@ import inspect
import sys
sys.path[0:0] = [""]
from asyncio import iscoroutinefunction
from test import IntegrationTest, client_context, unittest
from test.utils import EventListener
from test.utils import OvertCommandListener
from bson.dbref import DBRef
from pymongo.operations import IndexModel
from pymongo.synchronous.command_cursor import CommandCursor
class Empty:
def __getattr__(self, item):
try:
self.__dict__[item]
except KeyError:
return self.empty
def empty(self, *args, **kwargs):
return Empty()
_IS_SYNC = True
class TestComment(IntegrationTest):
@ -46,8 +37,6 @@ class TestComment(IntegrationTest):
helpers,
already_supported,
listener,
db=Empty(), # noqa: B008
coll=Empty(), # noqa: B008
):
for h, args in helpers:
c = "testing comment with " + h.__name__
@ -55,19 +44,10 @@ class TestComment(IntegrationTest):
for cc in [c, {"key": c}, ["any", 1]]:
listener.reset()
kwargs = {"comment": cc}
if h == coll.rename:
_ = db.get_collection("temp_temp_temp").drop()
destruct_coll = db.get_collection("test_temp")
destruct_coll.insert_one({})
maybe_cursor = destruct_coll.rename(*args, **kwargs)
destruct_coll.drop()
elif h == db.validate_collection:
coll = db.get_collection("test")
coll.insert_one({})
maybe_cursor = db.validate_collection(*args, **kwargs)
else:
coll.create_index("a")
try:
maybe_cursor = h(*args, **kwargs)
except Exception:
maybe_cursor = None
self.assertIn(
"comment",
inspect.signature(h).parameters,
@ -79,15 +59,11 @@ class TestComment(IntegrationTest):
)
if isinstance(maybe_cursor, CommandCursor):
maybe_cursor.close()
tested = False
# For some reason collection.list_indexes creates two commands and the first
# one doesn't contain 'comment'.
for i in listener.started_events:
if cc == i.command.get("comment", ""):
self.assertEqual(cc, i.command["comment"])
tested = True
self.assertTrue(tested)
if h not in [coll.aggregate_raw_batches]:
cmd = listener.started_events[0]
self.assertEqual(cc, cmd.command.get("comment"), msg=cmd)
if h.__name__ != "aggregate_raw_batches":
self.assertIn(
":param comment:",
h.__doc__,
@ -108,8 +84,8 @@ class TestComment(IntegrationTest):
@client_context.require_version_min(4, 7, -1)
@client_context.require_replica_set
def test_database_helpers(self):
listener = EventListener()
db = self.rs_or_single_client(event_listeners=[listener]).db
listener = OvertCommandListener()
db = (self.rs_or_single_client(event_listeners=[listener])).db
helpers = [
(db.watch, []),
(db.command, ["hello"]),
@ -120,12 +96,12 @@ class TestComment(IntegrationTest):
(db.dereference, [DBRef("collection", 1)]),
]
already_supported = [db.command, db.list_collections, db.list_collection_names]
self._test_ops(helpers, already_supported, listener, db=db, coll=db.get_collection("test"))
self._test_ops(helpers, already_supported, listener)
@client_context.require_version_min(4, 7, -1)
@client_context.require_replica_set
def test_client_helpers(self):
listener = EventListener()
listener = OvertCommandListener()
cli = self.rs_or_single_client(event_listeners=[listener])
helpers = [
(cli.watch, []),
@ -140,8 +116,8 @@ class TestComment(IntegrationTest):
@client_context.require_version_min(4, 7, -1)
def test_collection_helpers(self):
listener = EventListener()
db = self.rs_or_single_client(event_listeners=[listener])[self.db.name]
listener = OvertCommandListener()
db = (self.rs_or_single_client(event_listeners=[listener]))[self.db.name]
coll = db.get_collection("test")
helpers = [
@ -176,7 +152,7 @@ class TestComment(IntegrationTest):
coll.find_one_and_delete,
coll.find_one_and_update,
]
self._test_ops(helpers, already_supported, listener, coll=coll, db=db)
self._test_ops(helpers, already_supported, listener)
if __name__ == "__main__":

2
tools/synchro.py
View File

@ -193,7 +193,9 @@ converted_tests = [
"test_collation.py",
"test_collection.py",
"test_command_logging.py",
"test_command_logging.py",
"test_command_monitoring.py",
"test_comment.py",
"test_common.py",
"test_connection_logging.py",
"test_connections_survive_primary_stepdown_spec.py",