tests: add tests to ensure web client is copyable (#1682)

Author: WilliamBergamin

tests/helpers.py

@@ -1,5 +1,8 @@
 import asyncio
+import copy
 import os
+import sys
+from typing import Any
 
 
 def async_test(coro):
@@ -24,3 +27,19 @@ def remove_os_env_temporarily() -> dict:
 
 def restore_os_env(old_env: dict) -> None:
     os.environ.update(old_env)
+
+
+def create_copy(original: Any) -> Any:
+    if sys.version_info.major == 3 and sys.version_info.minor <= 6:
+        # NOTE: Unfortunately, copy.deepcopy doesn't work in Python 3.6.5.
+        # --------------------
+        # >     rv = reductor(4)
+        # E     TypeError: can't pickle _thread.RLock objects
+        # ../../.pyenv/versions/3.6.10/lib/python3.6/copy.py:169: TypeError
+        # --------------------
+        # As a workaround, this operation uses shallow copies in Python 3.6.
+        # If your code modifies the shared data in threads / async functions, race conditions may arise.
+        # Please consider upgrading Python major version to 3.7+ if you encounter some issues due to this.
+        return copy.copy(original)
+    else:
+        return copy.deepcopy(original)

tests/slack_sdk/web/test_web_client_logger.py

@@ -3,15 +3,16 @@
 
 from slack_sdk import WebClient
 from slack_sdk.web import base_client
+from tests.helpers import create_copy
+from tests.mock_web_api_server import cleanup_mock_web_api_server, setup_mock_web_api_server
 from tests.slack_sdk.web.mock_web_api_handler import MockHandler
-from tests.mock_web_api_server import setup_mock_web_api_server, cleanup_mock_web_api_server
 
 
 class TestWebClientLogger(unittest.TestCase):
     test_logger: logging.Logger
 
     def setUp(self):
-        self.test_logger = logging.Logger("test-logger")
+        self.test_logger = logging.getLogger("test-logger")
         setup_mock_web_api_server(self, MockHandler)
 
     def tearDown(self):
@@ -36,3 +37,13 @@ def test_logger_property_has_no_setter(self):
         )
         with self.assertRaises(AttributeError):
             client.logger = self.test_logger
+
+    def test_ensure_web_client_with_logger_is_copyable(self):
+        client = WebClient(
+            base_url="http://localhost:8888",
+            token="xoxb-api_test",
+            logger=self.test_logger,
+        )
+        client_copy = create_copy(client)
+        self.assertEqual(client.logger, self.test_logger)
+        self.assertEqual(client_copy.logger, self.test_logger)

tests/slack_sdk_async/web/test_async_web_client_logger.py

@@ -3,6 +3,7 @@
 
 from slack_sdk.web.async_client import AsyncWebClient
 from slack_sdk.web import async_base_client
+from tests.helpers import create_copy
 from tests.slack_sdk.web.mock_web_api_handler import MockHandler
 from tests.mock_web_api_server import setup_mock_web_api_server_async, cleanup_mock_web_api_server_async
 
@@ -11,7 +12,7 @@ class TestAsyncWebClientLogger(unittest.TestCase):
     test_logger: logging.Logger
 
     def setUp(self):
-        self.test_logger = logging.Logger("test-logger")
+        self.test_logger = logging.getLogger("test-logger")
         setup_mock_web_api_server_async(self, MockHandler)
 
     def tearDown(self):
@@ -36,3 +37,13 @@ def test_logger_property_has_no_setter(self):
         )
         with self.assertRaises(AttributeError):
             client.logger = self.test_logger
+
+    def test_ensure_async_web_client_with_logger_is_copyable(self):
+        client = AsyncWebClient(
+            base_url="http://localhost:8888",
+            token="xoxb-api_test",
+            logger=self.test_logger,
+        )
+        client_copy = create_copy(client)
+        self.assertEqual(client.logger, self.test_logger)
+        self.assertEqual(client_copy.logger, self.test_logger)