Add tests

seratch · seratch · commit b76c8ebdefd0 · 2021-01-10T02:16:25.000+09:00
diff --git a/codecov.yml b/codecov.yml
@@ -2,7 +2,7 @@ coverage:
   status:
     project:
       default:
-        threshold: 0.3%
+        threshold: 2.0%
     patch:
       default:
         target: 50%
diff --git a/setup.py b/setup.py
@@ -16,6 +16,7 @@
     "pytest-cov>=2,<3",
     "pytest-asyncio<1",  # for async
     "aiohttp>=3,<4",  # for async
+    "Flask-Sockets>=0.2,<1",
     "black==20.8b1",
 ]
 
@@ -33,7 +34,7 @@
         exclude=["examples", "integration_tests", "tests", "tests.*",]
     ),
     include_package_data=True,  # MANIFEST.in
-    install_requires=["slack_sdk>=3.2.0b6,<3.3",],
+    install_requires=["slack_sdk>=3.2.0b7,<3.3",],
     setup_requires=["pytest-runner==5.2"],
     tests_require=test_dependencies,
     test_suite="tests",
diff --git a/slack_bolt/adapter/socket_mode/async_internals.py b/slack_bolt/adapter/socket_mode/async_internals.py
@@ -37,7 +37,8 @@ async def send_async_response(
         else:
             await client.send_socket_mode_response(
                 SocketModeResponse(
-                    envelope_id=req.envelope_id, payload={"text": bolt_resp.body},
+                    envelope_id=req.envelope_id,
+                    payload={"text": bolt_resp.body},
                 )
             )
         if client.logger.level <= logging.DEBUG:
diff --git a/slack_bolt/version.py b/slack_bolt/version.py
@@ -1 +1 @@
-__version__ = "1.2.0b3"
+__version__ = "1.2.0b4  "
diff --git a/tests/adapter_tests/socket_mode/__init__.py b/tests/adapter_tests/socket_mode/__init__.py
diff --git a/tests/adapter_tests/socket_mode/mock_socket_mode_server.py b/tests/adapter_tests/socket_mode/mock_socket_mode_server.py
@@ -0,0 +1,42 @@
+import logging
+from typing import List
+
+socket_mode_envelopes = [
+    """{"envelope_id":"57d6a792-4d35-4d0b-b6aa-3361493e1caf","payload":{"type":"shortcut","token":"xxx","action_ts":"1610198080.300836","team":{"id":"T111","domain":"seratch"},"user":{"id":"U111","username":"seratch","team_id":"T111"},"is_enterprise_install":false,"enterprise":null,"callback_id":"do-something","trigger_id":"111.222.xxx"},"type":"interactive","accepts_response_payload":false}""",
+    """{"envelope_id":"1d3c79ab-0ffb-41f3-a080-d19e85f53649","payload":{"token":"xxx","team_id":"T111","team_domain":"xxx","channel_id":"C111","channel_name":"random","user_id":"U111","user_name":"seratch","command":"/hello-socket-mode","text":"","api_app_id":"A111","response_url":"https://hooks.slack.com/commands/T111/111/xxx","trigger_id":"111.222.xxx"},"type":"slash_commands","accepts_response_payload":true}""",
+    """{"envelope_id":"08cfc559-d933-402e-a5c1-79e135afaae4","payload":{"token":"xxx","team_id":"T111","api_app_id":"A111","event":{"client_msg_id":"c9b466b5-845c-49c6-a371-57ae44359bf1","type":"message","text":"<@W111>","user":"U111","ts":"1610197986.000300","team":"T111","blocks":[{"type":"rich_text","block_id":"1HBPc","elements":[{"type":"rich_text_section","elements":[{"type":"user","user_id":"U111"}]}]}],"channel":"C111","event_ts":"1610197986.000300","channel_type":"channel"},"type":"event_callback","event_id":"Ev111","event_time":1610197986,"authorizations":[{"enterprise_id":null,"team_id":"T111","user_id":"U111","is_bot":true,"is_enterprise_install":false}],"is_ext_shared_channel":false,"event_context":"1-message-T111-C111"},"type":"events_api","accepts_response_payload":false,"retry_attempt":1,"retry_reason":"timeout"}""",
+]
+
+from flask import Flask
+from flask_sockets import Sockets
+
+
+def start_socket_mode_server(self, port: int):
+    def _start_socket_mode_server():
+        logger = logging.getLogger(__name__)
+        app: Flask = Flask(__name__)
+        sockets: Sockets = Sockets(app)
+
+        envelopes_to_consume: List[str] = list(socket_mode_envelopes)
+
+        @sockets.route("/link")
+        def link(ws):
+            while not ws.closed:
+                message = ws.read_message()
+                if message is not None:
+                    if len(envelopes_to_consume) > 0:
+                        e = envelopes_to_consume.pop(0)
+                        logger.debug(f"Send an envelope: {e}")
+                        ws.send(e)
+
+                    logger.debug(f"Server received a message: {message}")
+                    ws.send(message)
+
+        from gevent import pywsgi
+        from geventwebsocket.handler import WebSocketHandler
+
+        server = pywsgi.WSGIServer(("", port), app, handler_class=WebSocketHandler)
+        self.server = server
+        server.serve_forever(stop_timeout=1)
+
+    return _start_socket_mode_server
diff --git a/tests/adapter_tests/socket_mode/mock_web_api_server.py b/tests/adapter_tests/socket_mode/mock_web_api_server.py
@@ -0,0 +1,153 @@
+import json
+import logging
+import re
+import threading
+from http import HTTPStatus
+from http.server import HTTPServer, SimpleHTTPRequestHandler
+from typing import Type
+from unittest import TestCase
+from urllib.parse import urlparse, parse_qs
+
+
+class MockHandler(SimpleHTTPRequestHandler):
+    protocol_version = "HTTP/1.1"
+    default_request_version = "HTTP/1.1"
+    logger = logging.getLogger(__name__)
+
+    pattern_for_language = re.compile("python/(\\S+)", re.IGNORECASE)
+    pattern_for_package_identifier = re.compile("slackclient/(\\S+)")
+
+    def is_valid_user_agent(self):
+        user_agent = self.headers["User-Agent"]
+        return self.pattern_for_language.search(
+            user_agent
+        ) and self.pattern_for_package_identifier.search(user_agent)
+
+    def is_valid_token(self):
+        if self.path.startswith("oauth"):
+            return True
+        return "Authorization" in self.headers and (
+            str(self.headers["Authorization"]).startswith("Bearer xoxb-")
+            or str(self.headers["Authorization"]).startswith("Bearer xapp-")
+        )
+
+    def set_common_headers(self):
+        self.send_header("content-type", "application/json;charset=utf-8")
+        self.send_header("connection", "close")
+        self.end_headers()
+
+    invalid_auth = {
+        "ok": False,
+        "error": "invalid_auth",
+    }
+
+    not_found = {
+        "ok": False,
+        "error": "test_data_not_found",
+    }
+
+    def _handle(self):
+        try:
+            if self.is_valid_token() and self.is_valid_user_agent():
+                parsed_path = urlparse(self.path)
+
+                len_header = self.headers.get("Content-Length") or 0
+                content_len = int(len_header)
+                post_body = self.rfile.read(content_len)
+                request_body = None
+                if post_body:
+                    try:
+                        post_body = post_body.decode("utf-8")
+                        if post_body.startswith("{"):
+                            request_body = json.loads(post_body)
+                        else:
+                            request_body = {
+                                k: v[0] for k, v in parse_qs(post_body).items()
+                            }
+                    except UnicodeDecodeError:
+                        pass
+                else:
+                    if parsed_path and parsed_path.query:
+                        request_body = {
+                            k: v[0] for k, v in parse_qs(parsed_path.query).items()
+                        }
+
+                body = {"ok": False, "error": "internal_error"}
+                if self.path == "/auth.test":
+                    body = {
+                        "ok": True,
+                        "url": "https://xyz.slack.com/",
+                        "team": "Testing Workspace",
+                        "user": "bot-user",
+                        "team_id": "T111",
+                        "user_id": "W11",
+                        "bot_id": "B111",
+                        "enterprise_id": "E111",
+                        "is_enterprise_install": False,
+                    }
+                if self.path == "/apps.connections.open":
+                    body = {
+                        "ok": True,
+                        "url": "ws://localhost:3011/link/?ticket=xxx&app_id=yyy",
+                    }
+                if self.path == "/api.test" and request_body:
+                    body = {"ok": True, "args": request_body}
+            else:
+                body = self.invalid_auth
+
+            if not body:
+                body = self.not_found
+
+            self.send_response(HTTPStatus.OK)
+            self.set_common_headers()
+            self.wfile.write(json.dumps(body).encode("utf-8"))
+            self.wfile.close()
+
+        except Exception as e:
+            self.logger.error(str(e), exc_info=True)
+            raise
+
+    def do_GET(self):
+        self._handle()
+
+    def do_POST(self):
+        self._handle()
+
+
+class MockServerThread(threading.Thread):
+    def __init__(
+        self, test: TestCase, handler: Type[SimpleHTTPRequestHandler] = MockHandler
+    ):
+        threading.Thread.__init__(self)
+        self.handler = handler
+        self.test = test
+
+    def run(self):
+        self.server = HTTPServer(("localhost", 8888), self.handler)
+        self.test.server_url = "http://localhost:8888"
+        self.test.host, self.test.port = self.server.socket.getsockname()
+        self.test.server_started.set()  # threading.Event()
+
+        self.test = None
+        try:
+            self.server.serve_forever()
+        finally:
+            self.server.server_close()
+
+    def stop(self):
+        self.server.shutdown()
+        self.join()
+
+
+def setup_mock_web_api_server(test: TestCase):
+    test.server_started = threading.Event()
+    test.thread = MockServerThread(test)
+    test.thread.start()
+
+    test.server_started.wait()
+
+
+def cleanup_mock_web_api_server(test: TestCase):
+    test.thread.stop()
+
+    test.thread = None
diff --git a/tests/adapter_tests/socket_mode/test_interactions_builtin.py b/tests/adapter_tests/socket_mode/test_interactions_builtin.py
@@ -0,0 +1,75 @@
+import logging
+import time
+from threading import Thread
+
+from slack_sdk import WebClient
+
+from slack_bolt import App
+from slack_bolt.adapter.socket_mode import SocketModeHandler
+from .mock_socket_mode_server import (
+    start_socket_mode_server,
+)
+from .mock_web_api_server import (
+    setup_mock_web_api_server,
+    cleanup_mock_web_api_server,
+)
+from ...utils import remove_os_env_temporarily, restore_os_env
+
+
+class TestSocketModeBuiltin:
+    logger = logging.getLogger(__name__)
+
+    def setup_method(self):
+        self.old_os_env = remove_os_env_temporarily()
+        setup_mock_web_api_server(self)
+        self.web_client = WebClient(
+            token="xoxb-api_test",
+            base_url="http://localhost:8888",
+        )
+
+    def teardown_method(self):
+        cleanup_mock_web_api_server(self)
+        restore_os_env(self.old_os_env)
+
+    def test_interactions(self):
+        t = Thread(target=start_socket_mode_server(self, 3011))
+        t.daemon = True
+        t.start()
+        time.sleep(2)  # wait for the server
+
+        app = App(client=self.web_client)
+
+        result = {"shortcut": False, "command": False}
+
+        @app.shortcut("do-something")
+        def shortcut_handler(ack):
+            result["shortcut"] = True
+            ack()
+
+        @app.command("/hello-socket-mode")
+        def command_handler(ack):
+            result["command"] = True
+            ack()
+
+        handler = SocketModeHandler(
+            app_token="xapp-A111-222-xyz",
+            app=app,
+            trace_enabled=True,
+        )
+        try:
+            handler.client.ping_pong_trace_enabled = True
+            handler.client.wss_uri = "ws://127.0.0.1:3011/link"
+
+            handler.connect()
+            assert handler.client.is_connected() is True
+            time.sleep(2)  # wait for the message receiver
+
+            handler.client.send_message("foo")
+
+            time.sleep(2)
+            assert result["shortcut"] is True
+            assert result["command"] is True
+        finally:
+            handler.client.close()
+            self.server.stop()
+            self.server.close()
diff --git a/tests/adapter_tests/socket_mode/test_interactions_web_client.py b/tests/adapter_tests/socket_mode/test_interactions_web_client.py
@@ -0,0 +1,74 @@
+import logging
+import time
+from threading import Thread
+
+from slack_sdk import WebClient
+
+from slack_bolt import App
+from slack_bolt.adapter.socket_mode.websocket_client import SocketModeHandler
+from .mock_socket_mode_server import (
+    start_socket_mode_server,
+)
+from .mock_web_api_server import (
+    setup_mock_web_api_server,
+    cleanup_mock_web_api_server,
+)
+from ...utils import remove_os_env_temporarily, restore_os_env
+
+
+class TestSocketModeWebsocketClient:
+    logger = logging.getLogger(__name__)
+
+    def setup_method(self):
+        self.old_os_env = remove_os_env_temporarily()
+        setup_mock_web_api_server(self)
+        self.web_client = WebClient(
+            token="xoxb-api_test",
+            base_url="http://localhost:8888",
+        )
+
+    def teardown_method(self):
+        cleanup_mock_web_api_server(self)
+        restore_os_env(self.old_os_env)
+
+    def test_interactions(self):
+        t = Thread(target=start_socket_mode_server(self, 3012))
+        t.daemon = True
+        t.start()
+        time.sleep(1)  # wait for the server
+
+        app = App(client=self.web_client)
+
+        result = {"shortcut": False, "command": False}
+
+        @app.shortcut("do-something")
+        def shortcut_handler(ack):
+            result["shortcut"] = True
+            ack()
+
+        @app.command("/hello-socket-mode")
+        def command_handler(ack):
+            result["command"] = True
+            ack()
+
+        handler = SocketModeHandler(
+            app_token="xapp-A111-222-xyz",
+            app=app,
+            trace_enabled=True,
+        )
+        try:
+            handler.client.wss_uri = "ws://localhost:3012/link"
+
+            handler.connect()
+            assert handler.client.is_connected() is True
+            time.sleep(2)  # wait for the message receiver
+
+            handler.client.send_message("foo")
+
+            time.sleep(2)
+            assert result["shortcut"] is True
+            assert result["command"] is True
+        finally:
+            handler.client.close()
+            self.server.stop()
+            self.server.close()
diff --git a/tests/adapter_tests_async/socket_mode/__init__.py b/tests/adapter_tests_async/socket_mode/__init__.py
diff --git a/tests/adapter_tests_async/socket_mode/test_async_aiohttp.py b/tests/adapter_tests_async/socket_mode/test_async_aiohttp.py
diff --git a/tests/adapter_tests_async/socket_mode/test_async_websockets.py b/tests/adapter_tests_async/socket_mode/test_async_websockets.py

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,8 @@ async def send_async_response(`
`37`	`37`	`else:`
`38`	`38`	`await client.send_socket_mode_response(`
`39`	`39`	`SocketModeResponse(`
`40`		`- envelope_id=req.envelope_id, payload={"text": bolt_resp.body},`
	`40`	`+ envelope_id=req.envelope_id,`
	`41`	`+ payload={"text": bolt_resp.body},`
`41`	`42`	`)`
`42`	`43`	`)`
`43`	`44`	`if client.logger.level <= logging.DEBUG:`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "1.2.0b3"`
	`1`	`+__version__ = "1.2.0b4 "`