Merge branch 'main' into YOMA-181-build-pipeline

Author: morrieinmaas

.coverage

@@ -1 +1,4 @@
-from aries_cloudcontroller.aries_controller import AriesAgentController
+from aries_cloudcontroller.aries_controller import AriesAgentController
+from aries_cloudcontroller.aries_controller_base import AriesAgentControllerBase
+from aries_cloudcontroller.aries_tenant_controller import AriesTenantController
+from aries_cloudcontroller.aries_webhook_server import AriesWebhookServer

aries_cloudcontroller/__init__.py

@@ -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}")

aries_cloudcontroller/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:

aries_cloudcontroller/aries_controller_base.py

@@ -71,16 +71,19 @@ def add_listener(self, listener):
             "topic":"topicname" key-value pairs
         """
         try:
+            assert (type(wallet_id) is str), "wallet_id must be a string"
+            assert (wallet_id.__ne__("")), "Cannot add listener for empty wallet_id."
             pub_topic_path_base = listener['topic']
             pub_topic_path = f"{self.wallet_id}.{pub_topic_path_base}"
             pub.subscribe(listener["handler"], pub_topic_path)
             logger.debug("Lister added for topic : ", pub_topic_path)
-        except self.wallet_id == "":
-            logger.error(
-                "Cannot add listener for empty wallet_id.")
+        except AssertionError as err:
+            logger.error(err)
+            raise
         except Exception as exc:
             logger.warning(
                 f"Adding webhooks listener failed! {exc!r} occurred.")
+            raise
 
     def update_wallet_id(self, wallet_id: str):
         """This wallet_id is used to register for webhooks
@@ -92,9 +95,12 @@ def update_wallet_id(self, wallet_id: str):
             The tenant wallet identifier
         """
         try:
+            assert (type(wallet_id) is str), "wallet_id must be a string" 
+            assert (wallet_id.__ne__("")), "wallet_id must not be empty"
             self.wallet_id = wallet_id
-        except wallet_id == "":
-            raise Exception("wallet_id must not be empty")
+        except AssertionError as err:
+            logger.info(f"{err!r}")
+            raise
 
     def update_tenant_jwt(self, tenant_jwt: str, wallet_id: str):
         """Update the tenant JW token attribute and the header
@@ -107,18 +113,22 @@ def update_tenant_jwt(self, tenant_jwt: str, wallet_id: str):
             The tenant wallet identifier
         """
         try:
+            assert (type(tenant_jwt) is str), "tenant_jwt must be a string" 
+            assert (tenant_jwt.__ne__("")), "tenant_jwt must not be empty"
             self.tenant_jwt = tenant_jwt
             self.update_wallet_id(wallet_id)
             self.headers.update(
                 {'Authorization': 'Bearer ' + tenant_jwt,
                     'content-type': "application/json"})
             self.client_session.headers.update(self.headers)
-        except tenant_jwt == "":
-            raise Exception("tenant_jwt must not be empty")
+        except AssertionError as err:
+            logger.info(f"{err!r}")
+            raise
         except Exception as exc:
             logger.warning(
                 (f"Updating tenant JW token"
                     f" failed! {exc!r} occurred."))
+            raise
 
     def remove_tenant_jwt(self):
         """Removes the tenant's JW Token attribute and corresponding
@@ -134,3 +144,4 @@ def remove_tenant_jwt(self):
         except Exception as exc:
             logger.warning(
                 f"Removing JW token failed! {exc!r} occurred.")
+            raise

aries_cloudcontroller/aries_tenant_controller.py

@@ -51,8 +51,11 @@ async def listen_webhooks(self):
                 self.webhook_host,
                 self.webhook_port)
             await self.webhook_site.start()
+            logger.info(
+                f"Listening Webhooks on {self.webhook_host}:{self.webhook_port}")
         except Exception as exc:
             logger.warning(f"Listening webhooks failed! {exc!r} occurred.")
+            raise
 
     async def _receive_webhook(self, request: ClientRequest):
         """Helper to receive webhooks by requesting it
@@ -79,6 +82,7 @@ async def _receive_webhook(self, request: ClientRequest):
             return web.Response(status=200)
         except Exception as exc:
             logger.warning(f"Receiving webhooks failed! {exc!r} occurred.")
+            raise
 
     async def _handle_webhook(self, wallet_id, topic, payload):
         """Helper handling a webhook
@@ -103,14 +107,17 @@ async def _handle_webhook(self, wallet_id, topic, payload):
             logger.warning(
                 (f"Handling webhooks failed! {exc!r} occurred"
                     f" when trying to handle this topic: {topic}"))
+            raise
 
     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
         except Exception as exc:
             logger.warning(
                 f"Terminating webhooks listener failed! {exc!r} occurred.")
+            raise

aries_cloudcontroller/aries_webhook_server.py

@@ -0,0 +1,150 @@
+import json
+import logging
+
+logger = logging.getLogger("aries_controller.models.presentation")
+
+
+class Presentation():
+    def __init__(self, presentation_json):
+        try:
+            self.json_data = json.loads(presentation_json)
+        except Exception:
+            logger.error("Failed to load presentation JSON")
+            raise
+        self.validate_presentation_json(presentation_json)
+        if not self.is_verified():
+            logger.error('Presentation Object Verification not verified')
+            raise Exception('Presentation Object Verification not verified')
+
+    def get_self_attested_attrs(self):
+        if self.is_verified():
+            data = {}
+            for (name, val) in self.json_data['presentation']['requested_proof']['self_attested_attrs'].items():
+                data[name] = val['raw']
+            return json.dumps(data)
+
+    def get_revealed_attrs(self):
+        if self.is_verified():
+            data = {}
+            for (name, val) in self.json_data['presentation']['requested_proof']['revealed_attrs'].items():
+                data[name] = val['raw']
+            return json.dumps(data)
+
+    def get_unrevealed_attrs(self):
+        if self.is_verified():
+            data = {}
+            for (name, val) in self.json_data['presentation']['requested_proof']['unrevealed_attrs'].items():
+                data[name] = val['raw']
+            return json.dumps(data)
+
+    def get_predicates(self):
+        if self.is_verified():
+            data = {}
+            for (name, val) in self.json_data['presentation']['requested_proof']['predicates'].items():
+                data[name] = val['raw']
+            return json.dumps(data)
+
+    def get_identifiers(self):
+        if self.__has_identifiers():
+            data = {}
+            identifiers = []
+            for index in range(len(self.json_data['presentation']['identifiers'])):
+                identifiers.extend([self.json_data['presentation']['identifiers'][index]])
+            data['identifiers'] = identifiers
+            return json.dumps(data)
+
+    def get_schemas(self):
+        if self.__has_identifiers():
+            data = {}
+            creds = []
+            for index in range(len(self.json_data['presentation']['identifiers'])):
+                for key in self.json_data['presentation']['identifiers'][index]:
+                    if key == 'schema_id':
+                        creds.extend([self.json_data['presentation']['identifiers'][index][key]])
+            data['schema_id'] = creds
+            return json.dumps(data)
+
+    def get_cred_def_ids(self):
+        if self.__has_identifiers():
+            data = {}
+            creds = []
+            for index in range(len(self.json_data['presentation']['identifiers'])):
+                for key in self.json_data['presentation']['identifiers'][index]:
+                    if key == 'cred_def_id':
+                        creds.extend([self.json_data['presentation']['identifiers'][index][key]])
+            data['cred_def_id'] = creds
+            return json.dumps(data)
+
+    def get_rev_reg_ids(self):
+        if self.__has_identifiers():
+            data = {}
+            creds = []
+            for index in range(len(self.json_data['presentation']['identifiers'])):
+                for key in self.json_data['presentation']['identifiers'][index]:
+                    if key == 'rev_reg_id':
+                        creds.extend([self.json_data['presentation']['identifiers'][index][key]])
+            data['rev_reg_id'] = creds
+            return json.dumps(data)
+
+    def get_role(self):
+        return(self.json_data['role'])
+
+    def get_threadid(self):
+        return(self.json_data['thread_id'])
+
+    def get_presentation_request(self):
+        return(self.json_data['presentation_request'])
+
+    def get_verified_state(self):
+        return self.json_data['state']
+
+    def get_presxid(self):
+        return self.json_data['presentation_exchange_id']
+
+    def get_from_conn_id(self):
+        return self.json_data['connection_id']
+
+    def is_verified(self):
+        try:
+            assert self.json_data['verified'] == "true"
+        except AssertionError:
+            logger.debug('Verification Failed')
+            return False
+        return True
+
+    def validate_presentation_json(self, presentation_json):
+        try:
+            # Taken from sample response in swagger UI
+            # TODO Determine whether this is the minimal set of keys
+            presentation_keys = [
+                "auto_present",
+                "connection_id",
+                "created_at",
+                "error_msg",
+                "initiator",
+                "presentation",
+                "presentation_exchange_id",
+                "presentation_proposal_dict",
+                "presentation_request",
+                "presentation_request_dict",
+                "role",
+                "state",
+                "thread_id",
+                "trace",
+                "updated_at",
+                "verified"
+            ]
+            for key in presentation_keys:
+                assert key in json.loads(presentation_json),\
+                    f"Invalid presentation. Missing key {key}"
+        except AssertionError:
+            raise
+
+    def __has_identifiers(self):
+        try:
+            assert 'identifiers' in self.json_data['presentation'],\
+                "No key 'identifiers' in presentation"
+            return True
+        except AssertionError:
+            logger.warning("No key 'identifiers' in presentation")
+            raise

aries_cloudcontroller/models/presentation.py

@@ -7,4 +7,6 @@ python-dotenv
 termcolor
 pillow
 qrcode
-beautifulsoup4
+beautifulsoup4
+pytest~=6.2
+pytest_asyncio

requirements.txt

@@ -22,7 +22,7 @@ def parse_requirements(filename):
 if __name__ == "__main__":
     setup(
         name=PACKAGE_NAME,
-        version="0.1.3",
+        version="0.1.4",
         description="A simple python package for controlling an aries agent through the admin-api interface",
         long_description=long_description,
         long_description_content_type="text/markdown",