fix python 3.7 test issues

Author: WilliamBergamin

tests/slack_bolt/context/test_say_stream.py

@@ -1,82 +1,82 @@
-from unittest.mock import MagicMock
-
 import pytest
 from slack_sdk import WebClient
 
 from slack_bolt.context.say_stream.say_stream import SayStream
 from slack_bolt.warning import ExperimentalWarning
+from tests.mock_web_api_server import cleanup_mock_web_api_server, setup_mock_web_api_server
 
 
 class TestSayStream:
     def setup_method(self):
-        self.mock_client = MagicMock(spec=WebClient)
-        self.mock_client.chat_stream = MagicMock()
+        setup_mock_web_api_server(self)
+        valid_token = "xoxb-valid"
+        mock_api_server_base_url = "http://localhost:8888"
+        self.web_client = WebClient(token=valid_token, base_url=mock_api_server_base_url)
+
+    def teardown_method(self):
+        cleanup_mock_web_api_server(self)
 
     def test_missing_channel_raises(self):
-        say_stream = SayStream(client=self.mock_client, channel_id=None, thread_ts="111.222")
+        say_stream = SayStream(client=self.web_client, channel_id=None, thread_ts="111.222")
         with pytest.warns(ExperimentalWarning):
             with pytest.raises(ValueError, match="channel"):
                 say_stream()
 
     def test_missing_thread_ts_raises(self):
-        say_stream = SayStream(client=self.mock_client, channel_id="C111", thread_ts=None)
+        say_stream = SayStream(client=self.web_client, channel_id="C111", thread_ts=None)
         with pytest.warns(ExperimentalWarning):
             with pytest.raises(ValueError, match="thread_ts"):
                 say_stream()
 
     def test_default_params(self):
         say_stream = SayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
             team_id="T111",
             user_id="U111",
         )
-        say_stream()
+        stream = say_stream()
 
-        self.mock_client.chat_stream.assert_called_once_with(
-            channel="C111",
-            thread_ts="111.222",
-            recipient_team_id="T111",
-            recipient_user_id="U111",
-        )
+        assert stream._stream_args == {
+            "channel": "C111",
+            "thread_ts": "111.222",
+            "recipient_team_id": "T111",
+            "recipient_user_id": "U111",
+            "task_display_mode": None,
+        }
 
     def test_parameter_overrides(self):
         say_stream = SayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
             team_id="T111",
             user_id="U111",
         )
-        say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
+        stream = say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
 
-        self.mock_client.chat_stream.assert_called_once_with(
-            channel="C222",
-            thread_ts="333.444",
-            recipient_team_id="T222",
-            recipient_user_id="U222",
-        )
+        assert stream._stream_args == {
+            "channel": "C222",
+            "thread_ts": "333.444",
+            "recipient_team_id": "T222",
+            "recipient_user_id": "U222",
+            "task_display_mode": None,
+        }
 
     def test_buffer_size_passthrough(self):
         say_stream = SayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
         )
-        say_stream(buffer_size=100)
+        stream = say_stream(buffer_size=100)
 
-        self.mock_client.chat_stream.assert_called_once_with(
-            buffer_size=100,
-            channel="C111",
-            thread_ts="111.222",
-            recipient_team_id=None,
-            recipient_user_id=None,
-        )
+        assert stream._buffer_size == 100
 
     def test_experimental_warning(self):
         say_stream = SayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
         )

tests/slack_bolt_async/context/test_async_say_stream.py

@@ -1,88 +1,95 @@
-from unittest.mock import AsyncMock, MagicMock
-
 import pytest
 from slack_sdk.web.async_client import AsyncWebClient
 
 from slack_bolt.context.say_stream.async_say_stream import AsyncSayStream
 from slack_bolt.warning import ExperimentalWarning
+from tests.mock_web_api_server import (
+    cleanup_mock_web_api_server,
+    setup_mock_web_api_server,
+)
+from tests.utils import remove_os_env_temporarily, restore_os_env
 
 
 class TestAsyncSayStream:
-    def setup_method(self):
-        self.mock_client = MagicMock(spec=AsyncWebClient)
-        self.mock_client.chat_stream = AsyncMock()
+    @pytest.fixture(scope="function", autouse=True)
+    def setup_teardown(self):
+        old_os_env = remove_os_env_temporarily()
+        setup_mock_web_api_server(self)
+        valid_token = "xoxb-valid"
+        mock_api_server_base_url = "http://localhost:8888"
+        try:
+            self.web_client = AsyncWebClient(token=valid_token, base_url=mock_api_server_base_url)
+            yield  # run the test here
+        finally:
+            cleanup_mock_web_api_server(self)
+            restore_os_env(old_os_env)
 
     @pytest.mark.asyncio
     async def test_missing_channel_raises(self):
-        say_stream = AsyncSayStream(client=self.mock_client, channel_id=None, thread_ts="111.222")
+        say_stream = AsyncSayStream(client=self.web_client, channel_id=None, thread_ts="111.222")
         with pytest.warns(ExperimentalWarning):
             with pytest.raises(ValueError, match="channel"):
                 await say_stream()
 
     @pytest.mark.asyncio
     async def test_missing_thread_ts_raises(self):
-        say_stream = AsyncSayStream(client=self.mock_client, channel_id="C111", thread_ts=None)
+        say_stream = AsyncSayStream(client=self.web_client, channel_id="C111", thread_ts=None)
         with pytest.warns(ExperimentalWarning):
             with pytest.raises(ValueError, match="thread_ts"):
                 await say_stream()
 
     @pytest.mark.asyncio
     async def test_default_params(self):
         say_stream = AsyncSayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
             team_id="T111",
             user_id="U111",
         )
-        await say_stream()
-
-        self.mock_client.chat_stream.assert_called_once_with(
-            channel="C111",
-            thread_ts="111.222",
-            recipient_team_id="T111",
-            recipient_user_id="U111",
-        )
+        stream = await say_stream()
+        assert stream._stream_args == {
+            "channel": "C111",
+            "thread_ts": "111.222",
+            "recipient_team_id": "T111",
+            "recipient_user_id": "U111",
+            "task_display_mode": None,
+        }
 
     @pytest.mark.asyncio
     async def test_parameter_overrides(self):
         say_stream = AsyncSayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
             team_id="T111",
             user_id="U111",
         )
-        await say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
+        stream = await say_stream(channel="C222", thread_ts="333.444", recipient_team_id="T222", recipient_user_id="U222")
 
-        self.mock_client.chat_stream.assert_called_once_with(
-            channel="C222",
-            thread_ts="333.444",
-            recipient_team_id="T222",
-            recipient_user_id="U222",
-        )
+        assert stream._stream_args == {
+            "channel": "C222",
+            "thread_ts": "333.444",
+            "recipient_team_id": "T222",
+            "recipient_user_id": "U222",
+            "task_display_mode": None,
+        }
 
     @pytest.mark.asyncio
     async def test_buffer_size_passthrough(self):
         say_stream = AsyncSayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
         )
-        await say_stream(buffer_size=100)
+        stream = await say_stream(buffer_size=100)
 
-        self.mock_client.chat_stream.assert_called_once_with(
-            buffer_size=100,
-            channel="C111",
-            thread_ts="111.222",
-            recipient_team_id=None,
-            recipient_user_id=None,
-        )
+        assert stream._buffer_size == 100
 
     @pytest.mark.asyncio
     async def test_experimental_warning(self):
         say_stream = AsyncSayStream(
-            client=self.mock_client,
+            client=self.web_client,
             channel_id="C111",
             thread_ts="111.222",
         )