WIP proposal new webhook server logic

* Assert passed IP address is a valid IP address
* unit test

Author: morrieinmaas

aries_cloudcontroller/aries_controller.py

@@ -5,6 +5,7 @@
 from .controllers.multitenant import MultitenancyController
 
 import logging
+import ipaddress
 
 logger = logging.getLogger("aries_controller")
 
@@ -51,7 +52,7 @@ async def init_webhook_server(
             The base url for webhooks (default is "")
         """
         assert type(webhook_host) is str
-        assert webhook_host != ""
+        assert ipaddress.ip_address(webhook_host)
         assert type(webhook_port) is int
         try:
             self.webhook_server: AriesWebhookServer = AriesWebhookServer(

tests/test_aries_controller.py

@@ -61,8 +61,22 @@ async def test_init_webhook_server_args_host_type(self):
             )
 
     @pytest.mark.asyncio
-    async def test_init_webhook_server_args_host_non_empty(self):
-        with pytest.raises(AssertionError):
+    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
@@ -73,7 +87,9 @@ 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="", webhook_port="1234", webhook_base=self.webhook_base
+                webhook_host=self.webhook_host,
+                webhook_port="1234",
+                webhook_base=self.webhook_base,
             )
 
     @pytest.mark.asyncio