Merge pull request #10 from didx-xyz/issue_6/improve_webhook_server

Issue 6/improve webhook server

Author: wip-abramson

aries_cloudcontroller/aries_controller.py

@@ -5,6 +5,7 @@
 from .controllers.multitenant import MultitenancyController
 
 import logging
+import ipaddress
 
 logger = logging.getLogger("aries_controller")
 
@@ -36,35 +37,34 @@ def __post_init__(self):
                 self.admin_url, self.client_session
             )
 
-    def init_webhook_server(
-        self, webhook_host: str = None, webhook_port: int = None, webhook_base: str = ""
+    async def init_webhook_server(
+        self, webhook_host: str, webhook_port: int, webhook_base: str = ""
     ):
-        """Create a webhooklisteners
+        """Create a webhook listeners
 
         Args:
         ----
         webhook_host : str
-            The url of the webhook host (default is None)
+            The url of the webhook host
         webhook_port : int
-            The exposed port for webhooks on the host (default is None)
+            The exposed port for webhooks on the host
         webhook_base : str
             The base url for webhooks (default is "")
         """
-        self.webhook_server: AriesWebhookServer = AriesWebhookServer(
-            webhook_host=webhook_host,
-            webhook_port=webhook_port,
-            webhook_base=webhook_base,
-            is_multitenant=self.is_multitenant,
-        )
-
-    async def listen_webhooks(self):
+        assert type(webhook_host) is str
+        assert ipaddress.ip_address(webhook_host)
+        assert type(webhook_port) is int
         try:
+            self.webhook_server: AriesWebhookServer = AriesWebhookServer(
+                webhook_host=webhook_host,
+                webhook_port=webhook_port,
+                webhook_base=webhook_base,
+                is_multitenant=self.is_multitenant,
+            )
             await self.webhook_server.listen_webhooks()
-            logger.info("Webhook server started.")
-        except AttributeError:
-            warning = "Webhook server not initialised."
-            logger.warning(warning)
-            raise AttributeError(warning)
+            logger.info(
+                f"Webhook server started on {self.webhook_server.webhook_host}."
+            )
         except Exception as exc:
-            logger.warning(f"Listening webhooks failed! {exc!r} occurred.")
+            logger.error(f"Listening webhooks failed! {exc!r} occurred.")
             raise Exception(f"{exc!r}")

tests/test_aries_controller.py

@@ -11,7 +11,7 @@
 class TestAriesAgentController:
 
     admin_url = "0.0.0.0"
-    webhook_host = ""
+    webhook_host = "0.0.0.0"
     webhook_port = 8000
     webhook_base = ""
 
@@ -42,7 +42,9 @@ async def test_init_args_multi_true(self):
     @pytest.mark.asyncio
     async def test_init_webhook_server(self):
         ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
-        ac.init_webhook_server(self.webhook_host, self.webhook_port, self.webhook_base)
+        await ac.init_webhook_server(
+            self.webhook_host, self.webhook_port, self.webhook_base
+        )
         assert type(ac.webhook_server) == AriesWebhookServer
         assert ac.webhook_server.webhook_base == self.webhook_base
         assert ac.webhook_server.webhook_port == self.webhook_port
@@ -51,22 +53,53 @@ async def test_init_webhook_server(self):
         await ac.terminate()
 
     @pytest.mark.asyncio
-    async def test_listen_webhooks_error(self, caplog):
-        caplog.set_level(logging.WARNING)
-        ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
-        with pytest.raises(AttributeError) as ae:
-            await ac.listen_webhooks()
-        assert "Webhook server not initialised." in str(ae.value)
-        assert "Webhook server not initialised." in caplog.text
-        await ac.terminate()
+    async def test_init_webhook_server_args_host_type(self):
+        with pytest.raises(AssertionError):
+            ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
+            await ac.init_webhook_server(
+                webhook_host=1234, webhook_port=1234, webhook_base=self.webhook_base
+            )
+
+    @pytest.mark.asyncio
+    async def test_init_webhook_server_invalid_ip(self):
+        with pytest.raises(
+            ValueError, match="does not appear to be an IPv4 or IPv6 address"
+        ):
+            ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
+            await ac.init_webhook_server(
+                webhook_host="12345.123456.1234.0",
+                webhook_port=1234,
+                webhook_base=self.webhook_base,
+            )
+
+    @pytest.mark.asyncio
+    async def test_init_webhook_server_empty_invalid_ip(self):
+        with pytest.raises(
+            ValueError, match="does not appear to be an IPv4 or IPv6 address"
+        ):
+            ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
+            await ac.init_webhook_server(
+                webhook_host="", webhook_port=1234, webhook_base=self.webhook_base
+            )
+
+    @pytest.mark.asyncio
+    async def test_init_webhook_server_args_port(self):
+        with pytest.raises(AssertionError):
+            ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
+            await ac.init_webhook_server(
+                webhook_host=self.webhook_host,
+                webhook_port="1234",
+                webhook_base=self.webhook_base,
+            )
 
     @pytest.mark.asyncio
     async def test_init_webhook_server_terminate(self, caplog):
         caplog.set_level(logging.INFO)
         ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
-        ac.init_webhook_server(self.webhook_host, self.webhook_port, self.webhook_base)
-        await ac.listen_webhooks()
-        assert "Webhook server started." in caplog.text
+        await ac.init_webhook_server(
+            self.webhook_host, self.webhook_port, self.webhook_base
+        )
+        assert "Webhook server started" in caplog.text
         res = await ac.webhook_server.terminate()
         assert "Webhook server terminated." in caplog.text
         assert res is None