WIP Proposed new design for initialising webhook server on an AriesAgentController

* Init webhook server starts directly via init_webhook_server and listens
* listen_webhooks no longer separate method
* checks for valid input types and non empty IP address
* tests passing

Author: morrieinmaas

aries_cloudcontroller/aries_controller.py

@@ -36,7 +36,7 @@ def __post_init__(self):
                 self.admin_url, self.client_session
             )
 
-    def init_webhook_server(
+    async def init_webhook_server(
         self, webhook_host: str, webhook_port: int, webhook_base: str = ""
     ):
         """Create a webhooklisteners
@@ -53,21 +53,15 @@ def init_webhook_server(
         assert type(webhook_host) is str
         assert webhook_host != ""
         assert type(webhook_port) is int
-        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):
         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)
         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

@@ -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
@@ -54,36 +56,33 @@ async def test_init_webhook_server(self):
     async def test_init_webhook_server_args_host_type(self):
         with pytest.raises(AssertionError):
             ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
-            ac.init_webhook_server(webhook_host=1234, webhook_port=1234, webhook_base=self.webhook_base)
+            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_args_host_non_empty(self):
         with pytest.raises(AssertionError):
             ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
-            ac.init_webhook_server(webhook_host="", webhook_port=1234, webhook_base=self.webhook_base)
+            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)
-            ac.init_webhook_server(webhook_host="", webhook_port="1234", webhook_base=self.webhook_base)
-
-    @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()
+            await ac.init_webhook_server(
+                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()
+        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