Merge branch 'main' into YOMA-257/extra_admin_APIs

Author: morrieinmaas

.github/workflows/create-release-changelog.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   release:
-    if: startsWith(github.ref, 'refs/tags/')
+    if: ${{ startsWith(github.ref, 'refs/tags/') && github.event.base_ref == 'refs/heads/main' }}
     runs-on: ubuntu-latest
     steps:
       - name: Build Changelog

.github/workflows/python-publish.yml

@@ -9,9 +9,8 @@ on:
 
 jobs:
   deploy:
-
+    if: ${{ startsWith(github.ref, 'refs/tags/') && github.event.base_ref == 'refs/heads/main' }}
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python

aries_cloudcontroller/aries_controller.py

@@ -5,8 +5,9 @@
 from .controllers.multitenant import MultitenancyController
 
 import logging
+import ipaddress
 
-logger = logging.getLogger("aries_controller")
+logger = logging.getLogger(__name__)
 
 
 @dataclass
@@ -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}")

aries_cloudcontroller/aries_controller_base.py

@@ -23,7 +23,7 @@
 
 import logging
 
-logger = logging.getLogger("aries_controller")
+logger = logging.getLogger(__name__)
 
 
 @dataclass
@@ -158,8 +158,8 @@ def add_listener(self, listener):
             "topic":"topicname" key-value pairs
         """
         try:
-            pub_topic_path = listener["topic"]
-            print("Subscribing too: " + pub_topic_path)
+            pub_topic_path = listener['topic']
+            logger.INFO("Subscribing too: " + pub_topic_path)
             pub.subscribe(listener["handler"], pub_topic_path)
             logger.debug("Lister added for topic : ", pub_topic_path)
         except Exception as exc:

aries_cloudcontroller/aries_tenant_controller.py

@@ -5,7 +5,7 @@
 
 import logging
 
-logger = logging.getLogger("aries_tenant_controller")
+logger = logging.getLogger(__name__)
 
 _required = object()
 

aries_cloudcontroller/aries_webhook_server.py

@@ -6,7 +6,7 @@
 from pubsub import pub
 import logging
 
-logger = logging.getLogger("aries_webhook_server")
+logger = logging.getLogger(__name__)
 
 
 @dataclass

aries_cloudcontroller/controllers/base.py

@@ -14,7 +14,7 @@
 
 from ..helpers.utils import log_msg
 
-EVENT_LOGGER = logging.getLogger("event")
+EVENT_LOGGER = logging.getLogger("__name__")
 
 
 class repr_json:

aries_cloudcontroller/controllers/connections.py

@@ -77,6 +77,7 @@ async def create_invitation(
         auto_accept: bool = None,
         public: str = None,
         multi_use: str = None,
+        invite_options: {} = None,
     ):
         params = {}
         if alias:
@@ -87,10 +88,29 @@ async def create_invitation(
             params["public"] = public
         if multi_use:
             params["multi_use"] = multi_use
-
-        invite_details = await self.admin_POST(
-            "/connections/create-invitation", params=params
-        )
+        if invite_options:
+            """A dictionary of the form:
+            {
+                "mediation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+                "metadata": {},
+                "recipient_keys": [
+                    "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
+                ],
+                "routing_keys": [
+                    "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
+                ],
+                "service_endpoint": "http://192.168.56.102:8020"
+            }
+            """
+            invite_details = await self.admin_POST(
+                "/connections/create-invitation",
+                params=params,
+                json_data=invite_options,
+            )
+        else:
+            invite_details = await self.admin_POST(
+                "/connections/create-invitation", params=params
+            )
         connection = Connection(invite_details["connection_id"], "invitation")
         self.connections.append(connection)
         return invite_details

aries_cloudcontroller/controllers/issuer.py

@@ -126,13 +126,19 @@ async def send_request_for_record(self, cred_ex_id):
 
     # Send holder a credential
     async def issue_credential(self, cred_ex_id, comment, attributes):
-        body = {
-            "comment": comment,
-            "credential_preview": {"@type": CRED_PREVIEW, "attributes": attributes},
-        }
-        return await self.admin_POST(
-            f"{self.base_url}/records/{cred_ex_id}/issue", json_data=body
-        )
+        try:
+            body = {
+                "comment": comment,
+                "credential_preview": {"@type": CRED_PREVIEW, "attributes": attributes},
+            }
+            return await self.admin_POST(
+                f"{self.base_url}/records/{cred_ex_id}/issue", json_data=body
+            )
+        except Exception as e:
+            exc_msg = f"Could not issue credentials: {e!r}"
+            logger.warn(exc_msg)
+            self.send_problem_report(pres_ex_id=self.pres_ex_id, explanation=f"{e!r}")
+            raise e(exc_msg)
 
     # Store a received credential
     async def store_credential(self, cred_ex_id, credential_id: str = None):
@@ -161,7 +167,7 @@ async def remove_record(self, cred_ex_id):
         return await self.admin_DELETE(f"{self.base_url}/records/{cred_ex_id}")
 
     # Send a problem report for a credential exchange
-    async def problem_report(self, cred_ex_id, explanation: str):
+    async def send_problem_report(self, cred_ex_id, explanation: str):
         body = {"explain_ltxt": explanation}
 
         return await self.admin_POST(

aries_cloudcontroller/controllers/proof.py

@@ -80,9 +80,11 @@ async def get_presentation_credentials(
         )
 
     # Send a problem report for presentation exchange
-    async def send_problem_report(self, pres_ex_id, request):
+    async def send_problem_report(self, pres_ex_id, explanation: str):
+        body = {"explain_ltxt": explanation}
         return await self.admin_POST(
-            f"{self.base_url}/records/{pres_ex_id}/problem-report", json_data=request
+            f"{self.base_url}/records/{pres_ex_id}/problem-report",
+            json_data=body,
         )
 
     # Sends a proof presentation

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