Merge branch 'main' into staging

Author: morrieinmaas

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

@@ -1,8 +1,7 @@
-name: 'CI'
+name: 'Create release and changelog'
 on:
-  push:
-    tags:
-      - 'v.*'
+  release:
+    types: [created]
 
 jobs:
   release:

.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-test-publish.yml

@@ -6,12 +6,8 @@ name: Upload Python Package
 on:
   # Trigger the workflow on push or pull request,
   # but only for the main branch
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
+  release:
+    types: [created]
 
 jobs:
   deploy:

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

@@ -0,0 +1,23 @@
+name: Run Python Tests
+on:
+  release:
+    types: [created]
+  pull_request:
+    branches:
+      - staging
+
+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/controllers/issuer.py

@@ -135,8 +135,10 @@ async def issue_credential(self, cred_ex_id, comment, attributes):
         )
 
     # 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

tests/README.md

@@ -0,0 +1,7 @@
+### Running tests locally
+
+In order to run the tests locally, e.g. for development, make sure you have installed the requirements by running `pip install -r requirements.txt` in the root of the project. 
+
+You can now run all tests py running `pytest` in the root of the project. in order to run specific tests you can specifying the test file to run, e.g. `pytest tests/path/to/your/testfile.py`. You can also run individual tests only using the `-k` flag of pytest `pytest tests/path/to/your/testfile.py -k 'test_your_whatever'` where `test_your_whatever` is the name of the test definition. For more information, please, refer to the [pytest docs](https://docs.pytest.org/en/).
+
+It is recommended to run the tests locally (and to add tests to your chnages and code additions). Tests will automatically run when trying to merge into or push to master. The merge or push will be rejected if any test fails.

tests/models/test_proof_request.py

@@ -0,0 +1,213 @@
+import pytest
+import json
+import logging
+
+from aries_cloudcontroller.models.proof_request import ProofRequest
+
+LOGGER = logging.getLogger(__name__)
+
+pytest.proof_keys = [
+    "connection_id",
+    "version",
+    "name",
+    "requested_attributes",
+    "requested_predicates",
+]
+
+# From sample in https://github.com/hyperledger/aries-cloudagent-python/issues/175
+pytest.valid_proof_request = json.dumps(
+    {
+        "connection_id": "d965bd54-affb-4e11-ba8e-ea54a3214123",
+        "version": "1.0.0",
+        "name": "Proof of Name",
+        "requested_attributes": [
+            {
+                "name": "name",
+                "restrictions": [
+                    {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                    {"value": "Alice Jones"},
+                ],
+            }
+        ],
+        "requested_predicates": [],
+    }
+)
+
+pytest.multi_attrs = json.dumps(
+    {
+        "connection_id": "d965bd54-affb-4e11-ba8e-ea54a3214123",
+        "version": "1.0.0",
+        "name": "Proof of Name",
+        "requested_attributes": [
+            {
+                "name": "name",
+                "restrictions": [
+                    {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                    {"value": "Alice Jones"},
+                ],
+            },
+            {
+                "name": "name",
+                "restrictions": [
+                    {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                    {"value": "Alice Jones"},
+                ],
+            },
+        ],
+        "requested_predicates": [],
+    }
+)
+
+pytest.multi_predicates = json.dumps(
+    {
+        "connection_id": "d965bd54-affb-4e11-ba8e-ea54a3214123",
+        "version": "1.0.0",
+        "name": "Proof of Name",
+        "requested_attributes": [],
+        "requested_predicates": [
+            {
+                "name": "name",
+                "restrictions": [
+                    {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                    {"value": "Alice Jones"},
+                ],
+            },
+            {
+                "name": "name",
+                "restrictions": [
+                    {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                    {"value": "Alice Jones"},
+                ],
+            },
+        ],
+    }
+)
+
+pytest.not_json = 123456
+
+pytest.invalid_proof_request = json.dumps({"abc": "1234"})
+
+pytest.no_requested_attrs = json.dumps(
+    {
+        "connection_id": "d965bd54-affb-4e11-ba8e-ea54a3214123",
+        "version": "1.0.0",
+        "name": "Proof of Name",
+        "requested_attributes": [],
+        "requested_predicates": [],
+    }
+)
+
+
+def test_init_valid():
+    proof = ProofRequest(pytest.valid_proof_request)
+    assert proof.json_data == json.loads(pytest.valid_proof_request)
+
+
+def test_init_invalid():
+    with pytest.raises(AssertionError, match="Missing key"):
+        ProofRequest(pytest.invalid_proof_request)
+
+
+def test_init_not_json(caplog):
+    error_msg = "the JSON object must be str, bytes or bytearray, not int"
+    with pytest.raises(TypeError, match=error_msg):
+        ProofRequest(pytest.not_json)
+    assert "Failed to load proof request JSON" in caplog.text
+
+
+# check for each possibly missing key whether the correct error is raised
+@pytest.mark.parametrize("key", pytest.proof_keys)
+def test_validate_presentation_json(key):
+    proof = pytest.valid_proof_request
+    proof_obj = ProofRequest(proof)
+    with pytest.raises(AssertionError, match=f"Missing key {key}"):
+        del proof_obj.json_data[key]
+        proof_obj.validate_proof_request_json(json.dumps(proof_obj.json_data))
+
+
+def test_requested_attributes_empty(caplog):
+    requested_attrs = ProofRequest(pytest.no_requested_attrs).get_requested_attributes()
+    assert requested_attrs == []
+
+
+def test_requested_predicates_empty(caplog):
+    requested_predicates = ProofRequest(
+        pytest.valid_proof_request
+    ).get_requested_predicates()
+    assert requested_predicates == []
+
+
+def test_requested_attributes(caplog):
+    expected = [
+        {
+            "name": "name",
+            "restrictions": [
+                {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                {"value": "Alice Jones"},
+            ],
+        }
+    ]
+    requested_attrs = ProofRequest(
+        pytest.valid_proof_request
+    ).get_requested_attributes()
+    assert requested_attrs == expected
+
+
+def test_multi_attributes(caplog):
+    expected = [
+        {
+            "name": "name",
+            "restrictions": [
+                {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                {"value": "Alice Jones"},
+            ],
+        },
+        {
+            "name": "name",
+            "restrictions": [
+                {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                {"value": "Alice Jones"},
+            ],
+        },
+    ]
+    requested_attrs = ProofRequest(pytest.multi_attrs).get_requested_attributes()
+    assert requested_attrs == expected
+
+
+def test_multi_preds(caplog):
+    expected = [
+        {
+            "name": "name",
+            "restrictions": [
+                {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                {"value": "Alice Jones"},
+            ],
+        },
+        {
+            "name": "name",
+            "restrictions": [
+                {"cred_def_id": "3avoBCqDMFHFaKUHug9s8W:3:CL:13:default"},
+                {"value": "Alice Jones"},
+            ],
+        },
+    ]
+    requested_attrs = ProofRequest(pytest.multi_predicates).get_requested_predicates()
+    assert requested_attrs == expected
+
+
+def test_get_connection_id():
+    expected = "d965bd54-affb-4e11-ba8e-ea54a3214123"
+    connection_id = ProofRequest(pytest.valid_proof_request).get_connection_id()
+    assert connection_id == expected
+
+
+def test_get_version():
+    expected = "1.0.0"
+    version = ProofRequest(pytest.valid_proof_request).get_version()
+    assert version == expected
+
+
+def test_get_name():
+    expected = "Proof of Name"
+    name = ProofRequest(pytest.valid_proof_request).get_name()
+    assert name == expected