Merge branch 'main' into issue_18/prob_report_endpoints

Author: morrieinmaas

.github/workflows/main.yml …b/workflows/create-release-changelog.yml.github/workflows/main.yml renamed to .github/workflows/create-release-changelog.yml .github/workflows/main.yml renamed to .github/workflows/create-release-changelog.yml

@@ -1,11 +1,11 @@
-name: 'CI'
+name: 'Create release and changelog'
 on:
   release:
     types: [created]
 
 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/lint-black.yml

@@ -0,0 +1,22 @@
+name: 'Run black linting'
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  PythonLinting:
+    name: Python linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Black Python linting
+        uses: lgeiger/black-action@master
+        with:
+          args: . --check

.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

.github/workflows/run-py-tests.yml

@@ -0,0 +1,22 @@
+name: Run Python Tests
+on:
+  pull_request:
+    branches:
+      - staging
+      - main
+
+jobs:
+  RunPytest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Python 3
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run tests with pytest
+        run: pytest 

aries_cloudcontroller/aries_controller.py

@@ -5,6 +5,7 @@
 from .controllers.multitenant import MultitenancyController
 
 import logging
+import ipaddress
 
 logger = logging.getLogger("aries_controller")
 
@@ -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/controllers/issuer.py

@@ -141,8 +141,10 @@ async def issue_credential(self, cred_ex_id, comment, attributes):
             raise e(exc_msg)
 
     # Store a received credential
-    async def store_credential(self, cred_ex_id, credential_id):
-        body = {"credential_id": credential_id}
+    async def store_credential(self, cred_ex_id, credential_id: str = None):
+        body = {}
+        if credential_id:
+            body["credential_id"] = credential_id
         return await self.admin_POST(
             f"{self.base_url}/records/{cred_ex_id}/store", json_data=body
         )

aries_cloudcontroller/controllers/messaging.py

@@ -21,8 +21,13 @@ async def send_message(self, connection_id, msg):
         )
         return response
 
-    async def trust_ping(self, connection_id: str, msg: str):
-        response = await self.admin_POST(
-            f"/connections/{connection_id}/send-ping", {"content": msg}
-        )
+    async def trust_ping(self, connection_id: str, comment_msg: str = None):
+        if comment_msg:
+            response = await self.admin_POST(
+                f"/connections/{connection_id}/send-ping", {"comment": comment_msg}
+            )
+        else:
+            response = await self.admin_POST(
+                f"/connections/{connection_id}/send-ping", {}
+            )
         return response

aries_cloudcontroller/models/proof_request.py

@@ -0,0 +1,47 @@
+import json
+import logging
+
+logger = logging.getLogger("aries_controller.models.proof_request")
+
+
+class ProofRequest:
+    def __init__(self, proof_request_json):
+        try:
+            self.json_data = json.loads(proof_request_json)
+        except Exception:
+            logger.error("Failed to load proof request JSON")
+            raise
+        self.validate_proof_request_json(proof_request_json)
+
+    def get_requested_attributes(self):
+        return self.json_data["requested_attributes"]
+
+    def get_requested_predicates(self):
+        return self.json_data["requested_predicates"]
+
+    def get_connection_id(self):
+        return self.json_data["connection_id"]
+
+    def get_version(self):
+        return self.json_data["version"]
+
+    def get_name(self):
+        return self.json_data["name"]
+
+    def validate_proof_request_json(self, presentation_json):
+        try:
+            # Taken from sample response in swagger UI
+            # TODO Determine whether this is the minimal set of keys
+            presentation_keys = [
+                "connection_id",
+                "version",
+                "name",
+                "requested_attributes",
+                "requested_predicates",
+            ]
+            for key in presentation_keys:
+                assert key in json.loads(
+                    presentation_json
+                ), f"Invalid proof request. Missing key {key}"
+        except AssertionError:
+            raise

requirements.txt

@@ -1,5 +1,6 @@
 aiohttp~=3.7.3
 asyncio
+black
 prompt_toolkit
 pygments
 PyPubSub