Skip to content

PYTHON-4651: Migrate test_client_context.py to async #1819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions test/asynchronous/test_client_context.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Copyright 2018-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 os
import sys

sys.path[0:0] = [""]

from test.asynchronous import AsyncUnitTest, SkipTest, async_client_context, unittest

_IS_SYNC = False


class TestAsyncClientContext(AsyncUnitTest):
@classmethod
async def _setup_class(cls):
pass
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove _setup_class since it's just a pass?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AsyncUnitTest assumes that _setup_class would be implemented..without this the code would infinitely recurse and eventually error.

To my knowledge this is the first time that a class inherits from AsyncUnitTest that doesn't "need" a _setup_class. I don't know if we want to change AsyncUnitTest to accommodate this class's use case or not...

Copy link
Member

@ShaneHarvey ShaneHarvey Aug 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The AsyncUnitTest methods should pass instead of trying to recursively call itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That work's too, don't know why i didn't think of that earlier! Just changed :)


@classmethod
async def _tearDown_class(cls):
pass

def test_must_connect(self):
if "PYMONGO_MUST_CONNECT" not in os.environ:
raise SkipTest("PYMONGO_MUST_CONNECT is not set")

self.assertTrue(
async_client_context.connected,
"client context must be connected when "
"PYMONGO_MUST_CONNECT is set. Failed attempts:\n{}".format(
async_client_context.connection_attempt_info()
),
)

def test_serverless(self):
if "TEST_SERVERLESS" not in os.environ:
raise SkipTest("TEST_SERVERLESS is not set")

self.assertTrue(
async_client_context.connected and async_client_context.serverless,
"client context must be connected to serverless when "
f"TEST_SERVERLESS is set. Failed attempts:\n{async_client_context.connection_attempt_info()}",
)

def test_enableTestCommands_is_disabled(self):
if "PYMONGO_DISABLE_TEST_COMMANDS" not in os.environ:
raise SkipTest("PYMONGO_DISABLE_TEST_COMMANDS is not set")

self.assertFalse(
async_client_context.test_commands_enabled,
"enableTestCommands must be disabled when PYMONGO_DISABLE_TEST_COMMANDS is set.",
)

def test_setdefaultencoding_worked(self):
if "SETDEFAULTENCODING" not in os.environ:
raise SkipTest("SETDEFAULTENCODING is not set")

self.assertEqual(sys.getdefaultencoding(), os.environ["SETDEFAULTENCODING"])


if __name__ == "__main__":
unittest.main()
14 changes: 12 additions & 2 deletions test/test_client_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,20 @@

sys.path[0:0] = [""]

from test import SkipTest, client_context, unittest
from test import SkipTest, UnitTest, client_context, unittest

_IS_SYNC = True


class TestClientContext(UnitTest):
@classmethod
def _setup_class(cls):
pass

@classmethod
def _tearDown_class(cls):
pass

class TestClientContext(unittest.TestCase):
def test_must_connect(self):
if "PYMONGO_MUST_CONNECT" not in os.environ:
raise SkipTest("PYMONGO_MUST_CONNECT is not set")
Expand Down
1 change: 1 addition & 0 deletions tools/synchro.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@
"test_logger.py",
"test_session.py",
"test_transactions.py",
"test_client_context.py",
]

sync_test_files = [
Expand Down
Loading