Merge branch 'main' into improvement/test_controllers

Author: morrieinmaas

.gitignore

@@ -4,7 +4,8 @@ dist
 *.egg-info
 build
 .env
-.ipynb_checkpoints/
 .venv
-.vscode/
+.pytest_cache/*
 __pycache__/
+.vscode/
+.coverage

aries_cloudcontroller/aries_controller.py

@@ -33,14 +33,12 @@ def __post_init__(self):
 
         if self.is_multitenant:
             self.multitenant = MultitenancyController(
-                self.admin_url,
-                self.client_session)
+                self.admin_url, self.client_session
+            )
 
     def init_webhook_server(
-                        self,
-                        webhook_host: str = None,
-                        webhook_port: int = None,
-                        webhook_base: str = ""):
+        self, webhook_host: str = None, webhook_port: int = None, webhook_base: str = ""
+    ):
         """Create a webhooklisteners
 
         Args:
@@ -56,7 +54,8 @@ def init_webhook_server(
             webhook_host=webhook_host,
             webhook_port=webhook_port,
             webhook_base=webhook_base,
-            is_multitenant=self.is_multitenant)
+            is_multitenant=self.is_multitenant,
+        )
 
     async def listen_webhooks(self):
         try:
@@ -67,6 +66,5 @@ async def listen_webhooks(self):
             logger.warning(warning)
             raise AttributeError(warning)
         except Exception as exc:
-            logger.warning(
-                f"Listening webhooks failed! {exc!r} occurred.")
+            logger.warning(f"Listening webhooks failed! {exc!r} occurred.")
             raise Exception(f"{exc!r}")

aries_cloudcontroller/aries_controller_base.py

@@ -57,69 +57,42 @@ def __post_init__(self):
         if self.api_key:
             self.headers.update({"X-API-Key": self.api_key})
 
-        self.client_session: ClientSession = ClientSession(
-            headers=self.headers)
+        self.client_session: ClientSession = ClientSession(headers=self.headers)
 
         # Instantiate controllers
-        self.connections = ConnectionsController(
-            self.admin_url,
-            self.client_session)
+        self.connections = ConnectionsController(self.admin_url, self.client_session)
 
-        self.messaging = MessagingController(
-            self.admin_url,
-            self.client_session)
+        self.messaging = MessagingController(self.admin_url, self.client_session)
 
-        self.proofs = ProofController(
-            self.admin_url,
-            self.client_session)
+        self.proofs = ProofController(self.admin_url, self.client_session)
 
-        self.ledger = LedgerController(
-            self.admin_url,
-            self.client_session)
+        self.ledger = LedgerController(self.admin_url, self.client_session)
 
-        self.credentials = CredentialController(
-            self.admin_url,
-            self.client_session)
+        self.credentials = CredentialController(self.admin_url, self.client_session)
 
-        self.server = ServerController(
-            self.admin_url,
-            self.client_session)
+        self.server = ServerController(self.admin_url, self.client_session)
 
-        self.oob = OOBController(
-            self.admin_url,
-            self.client_session)
+        self.oob = OOBController(self.admin_url, self.client_session)
 
-        self.mediation = MediationController(
-            self.admin_url,
-            self.client_session)
+        self.mediation = MediationController(self.admin_url, self.client_session)
 
-        self.schema = SchemaController(
-            self.admin_url,
-            self.client_session)
+        self.schema = SchemaController(self.admin_url, self.client_session)
 
-        self.wallet = WalletController(
-            self.admin_url,
-            self.client_session)
+        self.wallet = WalletController(self.admin_url, self.client_session)
 
-        self.definitions = DefinitionsController(
-            self.admin_url,
-            self.client_session)
+        self.definitions = DefinitionsController(self.admin_url, self.client_session)
 
         self.issuer = IssuerController(
             self.admin_url,
             self.client_session,
             self.connections,
             self.wallet,
-            self.definitions)
+            self.definitions,
+        )
 
-        self.action_menu = ActionMenuController(
-            self.admin_url,
-            self.client_session)
+        self.action_menu = ActionMenuController(self.admin_url, self.client_session)
 
-        self.revocations = RevocationController(
-            self.admin_url,
-            self.client_session
-        )
+        self.revocations = RevocationController(self.admin_url, self.client_session)
 
     def init_webhook_server(self):
         raise NotImplementedError
@@ -140,9 +113,9 @@ def remove_api_key(self):
         """Removes the API key attribute and corresponding headers
         from the Client Session"""
         self.api_key = None
-        if 'X-API-Key' in self.client_session.headers:
-            del self.client_session.headers['X-API-Key']
-            del self.headers['X-API-Key']
+        if "X-API-Key" in self.client_session.headers:
+            del self.client_session.headers["X-API-Key"]
+            del self.headers["X-API-Key"]
 
     def register_listeners(self, listeners, defaults=True):
         """Registers the webhook listners
@@ -161,23 +134,16 @@ def register_listeners(self, listeners, defaults=True):
             # If so lets do it consistently
             if defaults:
                 if self.connections:
-                    pub.subscribe(
-                        self.connections.default_handler,
-                        "connections")
+                    pub.subscribe(self.connections.default_handler, "connections")
                 if self.messaging:
-                    pub.subscribe(
-                        self.messaging.default_handler,
-                        "basicmessages")
+                    pub.subscribe(self.messaging.default_handler, "basicmessages")
                 if self.proofs:
-                    pub.subscribe(
-                        self.proofs.default_handler,
-                        "present_proof")
+                    pub.subscribe(self.proofs.default_handler, "present_proof")
 
             for listener in listeners:
                 self.add_listener(listener)
         except Exception as exc:
-            logger.warning(
-                f"Register webhooks listeners failed! {exc!r} occurred.")
+            logger.warning(f"Register webhooks listeners failed! {exc!r} occurred.")
 
     def add_listener(self, listener):
         """Subscribe to a listeners for a topic
@@ -189,13 +155,12 @@ def add_listener(self, listener):
             "topic":"topicname" key-value pairs
         """
         try:
-            pub_topic_path = listener['topic']
+            pub_topic_path = listener["topic"]
             print("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:
-            logger.warning(
-                f"Adding webhooks listener failed! {exc!r} occurred.")
+            logger.warning(f"Adding webhooks listener failed! {exc!r} occurred.")
 
     def remove_listener(self, listener):
         """Remove a listener for a topic
@@ -212,8 +177,7 @@ def remove_listener(self, listener):
             else:
                 logger.debug("Listener not subscribed", listener)
         except Exception as exc:
-            logger.warning(
-                f"Removing webhooks listener failed! {exc!r} occurred.")
+            logger.warning(f"Removing webhooks listener failed! {exc!r} occurred.")
 
     def remove_all_listeners(self, topic: str = None):
         """Remove all listeners for one or all topics
@@ -230,8 +194,7 @@ def remove_all_listeners(self, topic: str = None):
         try:
             pub.unsubAll(topicName=topic)
         except Exception as exc:
-            logger.warning(
-                f"Removing all webhooks listeners failed! {exc!r} occurred.")
+            logger.warning(f"Removing all webhooks listeners failed! {exc!r} occurred.")
 
     async def listen_webhooks(self):
         raise NotImplementedError
@@ -246,4 +209,5 @@ async def terminate(self):
             return
         except Exception as exc:
             logger.warning(
-                f"Terminate webhooks listener exception!\n {exc!r} occurred.")
+                f"Terminate webhooks listener exception!\n {exc!r} occurred."
+            )

aries_cloudcontroller/aries_tenant_controller.py

@@ -32,31 +32,40 @@ def __post_init__(self):
         and logic defined by attributes set during instantiation
         """
 
-        if (self.wallet_id is _required):
+        if self.wallet_id is _required:
             raise TypeError("__init__ missing required wallet_id (str)")
 
-        if (self.tenant_jwt is _required):
+        if self.tenant_jwt is _required:
             raise TypeError("__init__ missing required tenant_jwt (str)")
 
         super().__post_init__()
 
         if self.tenant_jwt:
             self.headers.update(
-                {'Authorization': 'Bearer ' + self.tenant_jwt,
-                    'content-type': "application/json"})
+                {
+                    "Authorization": "Bearer " + self.tenant_jwt,
+                    "content-type": "application/json",
+                }
+            )
 
         # Update the current client session instantiated in the parent class
         self.client_session.headers.update(self.headers)
 
     def init_webhook_server(self):
         raise NotImplementedError(
-            ("Please, use an AriesAgentController to start a webhook server\n"
-                "Webhook server fct is disallowed for tenant controllers."))
+            (
+                "Please, use an AriesAgentController to start a webhook server\n"
+                "Webhook server fct is disallowed for tenant controllers."
+            )
+        )
 
     def listen_webhooks(self):
         raise NotImplementedError(
-            ("Please, use an AriesAgentController to start a webhook server\n"
-                "Webhook server fct is disallowed for tenant controllers."))
+            (
+                "Please, use an AriesAgentController to start a webhook server\n"
+                "Webhook server fct is disallowed for tenant controllers."
+            )
+        )
 
     def add_listener(self, listener):
         """Subscribe to a listeners for a topic
@@ -71,18 +80,17 @@ 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']
+            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 AssertionError as err:
             logger.error(err)
             raise
         except Exception as exc:
-            logger.warning(
-                f"Adding webhooks listener failed! {exc!r} occurred.")
+            logger.warning(f"Adding webhooks listener failed! {exc!r} occurred.")
             raise
 
     def update_wallet_id(self, wallet_id: str):
@@ -95,8 +103,8 @@ 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"
+            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 AssertionError as err:
             logger.info(f"{err!r}")
@@ -113,35 +121,35 @@ 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"
+            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"})
+                {
+                    "Authorization": "Bearer " + tenant_jwt,
+                    "content-type": "application/json",
+                }
+            )
             self.client_session.headers.update(self.headers)
         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."))
+            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
         headers from the Client Session"""
         try:
             self.tenant_jwt = None
-            if 'Authorization' in self.client_session.headers:
-                del self.client_session.headers['Authorization']
-                del self.headers['Authorization']
-            if 'content-type' in self.client_session.headers:
-                del self.client_session.headers['content-type']
-                del self.headers['content-type']
+            if "Authorization" in self.client_session.headers:
+                del self.client_session.headers["Authorization"]
+                del self.headers["Authorization"]
+            if "content-type" in self.client_session.headers:
+                del self.client_session.headers["content-type"]
+                del self.headers["content-type"]
         except Exception as exc:
-            logger.warning(
-                f"Removing JW token failed! {exc!r} occurred.")
+            logger.warning(f"Removing JW token failed! {exc!r} occurred.")
             raise