Add AriesAgentController test. Improve AriesAgentControllerBase tests

Author: morrieinmaas

.coverage

@@ -63,7 +63,10 @@ async def listen_webhooks(self):
             await self.webhook_server.listen_webhooks()
             logger.info("Webhook server started.")
         except AttributeError:
-            logger.warning("Webhook server not initialised.")
+            warning = "Webhook server not initialised."
+            logger.warning(warning)
+            raise AttributeError(warning)
         except Exception as exc:
             logger.warning(
                 f"Listening webhooks failed! {exc!r} occurred.")
+            raise Exception(f"{exc!r}")

libs/aries-basic-controller/aries_basic_controller/aries_controller.py

@@ -238,6 +238,7 @@ async def listen_webhooks(self):
 
     async def terminate(self):
         await self.client_session.close()
+        logger.info("Client Session closed.")
         try:
             await self.webhook_server.terminate()
         except AttributeError:

libs/aries-basic-controller/aries_basic_controller/aries_controller_base.py

@@ -108,6 +108,7 @@ async def terminate(self):
         """Terminate the controller client session and webhook listeners"""
         try:
             await self.webhook_site.stop()
+            logger.info("Webhook server terminated.")
         except AttributeError:
             # Do nothing if no webhook site server is running
             return

libs/aries-basic-controller/aries_basic_controller/aries_webhook_server.py

@@ -0,0 +1,84 @@
+import logging
+import pytest
+import pytest_asyncio
+from aiohttp import (
+    web,
+    ClientSession,
+)
+
+from ..aries_webhook_server import AriesWebhookServer
+from ..controllers.multitenant import MultitenancyController
+
+from ..aries_controller import AriesAgentController
+
+LOGGER = logging.getLogger(__name__)
+
+
+class TestAriesAgentControllerBase():
+
+    admin_url = "0.0.0.0"
+    webhook_host = ""
+    webhook_port = 8000
+    webhook_base = ""
+
+    @pytest.mark.asyncio
+    async def test_init_args_missing(self):
+        with pytest.raises(TypeError) as te:
+            AriesAgentController()
+            assert "__init__() missing 1 required positional argument: 'admin_url'" \
+                in str(tf.value)
+
+    @pytest.mark.asyncio
+    async def test_init_args_multi_default(self):
+        ac = AriesAgentController(admin_url=self.admin_url)
+        assert ac.is_multitenant == False
+
+    @pytest.mark.asyncio
+    async def test_init_args_multi_true(self):
+        ac = AriesAgentController(admin_url=self.admin_url, is_multitenant=True)
+        assert ac.is_multitenant == True
+        assert type(ac.multitenant) == MultitenancyController
+        assert ac.multitenant.admin_url == self.admin_url
+        assert ac.multitenant.client_session.headers == {}
+        await ac.terminate()
+
+    @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
+        )
+        assert type(ac.webhook_server) == AriesWebhookServer
+        assert ac.webhook_server.webhook_base == self.webhook_base
+        assert ac.webhook_server.webhook_port == self.webhook_port
+        assert ac.webhook_server.webhook_host == self.webhook_host
+        assert ac.webhook_server.is_multitenant == True  
+        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()
+
+    @pytest.mark.asyncio
+    async def test_init_webhook_server(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
+        res = await ac.webhook_server.terminate()
+        assert "Webhook server terminated." in caplog.text
+        assert res == None
+        await ac.terminate()

libs/aries-basic-controller/aries_basic_controller/tests/test_aries_controller.py

@@ -1,3 +1,4 @@
+import logging
 import pytest
 import pytest_asyncio
 from aiohttp import (
@@ -20,18 +21,17 @@
 from ..controllers.action_menu import ActionMenuController
 from ..controllers.revocation import RevocationController
 
-# @pytest.fixture()
-# def base_controller(**kwargs):
-#     return AriesAgentControllerBase(**kwargs)
+LOGGER = logging.getLogger(__name__)
+
 
 class TestAriesAgentControllerBase():
 
     @pytest.mark.asyncio
     async def test_init_args_missing(self):
         with pytest.raises(TypeError) as te:
-            AriesAgentControllerBase()
+            ac = AriesAgentControllerBase()
             assert "__init__() missing 1 required positional argument: 'admin_url'" \
-                in str(tf.value)
+                in str(te.value)
 
     @pytest.mark.asyncio
     async def test_default_args(self):
@@ -124,9 +124,11 @@ async def test_listen_webhooks(self):
         await ac.terminate()
 
     @pytest.mark.asyncio
-    async def test_terminate(self):
+    async def test_terminate(self, caplog):
+        caplog.set_level(logging.INFO)
         ac = AriesAgentControllerBase(admin_url="0.0.0.0")
         await ac.terminate()
+        assert "Client Session closed." in caplog.text
         assert ac.client_session.closed == True
         with pytest.raises(AttributeError):
             assert ac.webhook_server == None

libs/aries-basic-controller/aries_basic_controller/tests/test_aries_controller_base.py

@@ -7,4 +7,5 @@ python-dotenv
 termcolor
 pillow
 qrcode
-beautifulsoup4
+beautifulsoup4
+pytest~=6.2.3