chore: unit tests around protocol usage (#48)

* chore: removing unused protocol

* improve naming

* Add the default

* Improve based on feedback

Author: WilliamBergamin

slack_cli_hooks/hooks/check_update.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 import json
 from http.client import HTTPResponse
+import sys
 from types import ModuleType
 from typing import Any, Dict, List, Optional
 from urllib import request
@@ -99,5 +100,5 @@ def build_output(dependencies: List[ModuleType] = DEPENDENCIES) -> Dict[str, Any
 
 
 if __name__ == "__main__":
-    PROTOCOL = build_protocol()
+    PROTOCOL = build_protocol(argv=sys.argv)
     PROTOCOL.respond(json.dumps(build_output()))

slack_cli_hooks/hooks/doctor.py

@@ -1,11 +1,9 @@
 #!/usr/bin/env python
 import json
 import platform
+import sys
 
-from slack_cli_hooks.protocol import (
-    Protocol,
-    build_protocol,
-)
+from slack_cli_hooks.protocol import Protocol, build_protocol
 
 PROTOCOL: Protocol
 
@@ -28,5 +26,5 @@
 }
 
 if __name__ == "__main__":
-    PROTOCOL = build_protocol()
+    PROTOCOL = build_protocol(argv=sys.argv)
     PROTOCOL.respond(json.dumps(doctor_payload))

slack_cli_hooks/hooks/get_hooks.py

@@ -1,12 +1,8 @@
 #!/usr/bin/env python
 import json
 import sys
-from slack_cli_hooks.protocol import (
-    Protocol,
-    MessageBoundaryProtocol,
-    DefaultProtocol,
-    build_protocol,
-)
+
+from slack_cli_hooks.protocol import DefaultProtocol, MessageBoundaryProtocol, Protocol, build_protocol
 
 PROTOCOL: Protocol
 
@@ -30,5 +26,5 @@
 }
 
 if __name__ == "__main__":
-    PROTOCOL = build_protocol()
+    PROTOCOL = build_protocol(argv=sys.argv)
     PROTOCOL.respond(json.dumps(hooks_payload))

slack_cli_hooks/hooks/get_manifest.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 import os
 import re
+import sys
 from typing import List
 
 from slack_cli_hooks.error import CliError
@@ -46,5 +47,5 @@ def get_manifest(working_directory: str) -> str:
 
 
 if __name__ == "__main__":
-    PROTOCOL = build_protocol()
+    PROTOCOL = build_protocol(argv=sys.argv)
     PROTOCOL.respond(get_manifest(os.getcwd()))

slack_cli_hooks/hooks/start.py

@@ -40,5 +40,5 @@ def start(working_directory: str) -> None:
 
 
 if __name__ == "__main__":
-    PROTOCOL = build_protocol()
+    PROTOCOL = build_protocol(argv=sys.argv)
     start(os.getcwd())

slack_cli_hooks/protocol/__init__.py

@@ -1,23 +1,19 @@
 import argparse
-import sys
 from typing import List
+
 from .default_protocol import DefaultProtocol
 from .message_boundary_protocol import MessageBoundaryProtocol
 from .protocol import Protocol
 
-__all__ = [
-    "DefaultProtocol",
-    "MessageBoundaryProtocol",
-    "Protocol",
-]
+__all__ = ["DefaultProtocol", "MessageBoundaryProtocol", "Protocol"]
 
 
-def build_protocol(argv: List[str] = sys.argv[1:]) -> Protocol:
+def build_protocol(argv: List[str]) -> Protocol:
     parser = argparse.ArgumentParser()
     parser.add_argument("--protocol", type=str, required=False)
     parser.add_argument("--boundary", type=str, required=False)
 
-    args, unknown = parser.parse_known_args(args=argv)
+    args, unknown = parser.parse_known_args(args=argv[1:])
 
     if args.protocol == MessageBoundaryProtocol.name:
         return MessageBoundaryProtocol(boundary=args.boundary)

slack_cli_hooks/protocol/message_boundary_protocol.py

@@ -1,4 +1,5 @@
 import logging
+
 from .protocol import Protocol
 
 

tests/mock_protocol.py

@@ -0,0 +1,38 @@
+from unittest.mock import Mock
+
+from slack_cli_hooks.protocol.protocol import Protocol
+
+
+def debug(self, msg: str, *args, **kwargs):
+    """This is a mock"""
+    pass
+
+
+def info(self, msg: str, *args, **kwargs):
+    """This is a mock"""
+    pass
+
+
+def warning(self, msg: str, *args, **kwargs):
+    """This is a mock"""
+    pass
+
+
+def error(self, msg: str, *args, **kwargs):
+    """This is a mock"""
+    pass
+
+
+def respond(self, data: str):
+    """This is a mock"""
+    pass
+
+
+class MockProtocol(Protocol):
+    name: str = "MockProtocol"
+
+    debug = Mock(spec=debug, return_value=None)
+    info = Mock(spec=info, return_value=None)
+    warning = Mock(spec=warning, return_value=None)
+    error = Mock(spec=error, return_value=None)
+    respond = Mock(spec=respond, return_value=None)

tests/mock_socket_mode_server.py

@@ -1,9 +1,10 @@
 import json
 import threading
 import time
-from urllib.request import urlopen
-from urllib.error import URLError
 from unittest import TestCase
+from urllib.error import URLError
+from urllib.request import urlopen
+
 from flask import Flask
 from gevent import pywsgi
 from geventwebsocket.handler import WebSocketHandler

tests/mock_web_api_server.py

@@ -5,7 +5,7 @@
 from http.server import HTTPServer, SimpleHTTPRequestHandler
 from typing import Type
 from unittest import TestCase
-from urllib.parse import urlparse, ParseResult
+from urllib.parse import ParseResult, urlparse
 
 
 class MockHandler(SimpleHTTPRequestHandler):