Merge pull request #350 from sklump/record-eq

Hush LGTM with equality comparison for exhange records, tiny bug fix …
openwallet-foundation · Jan 30, 2020 · 9e30014 · 9e30014
2 parents 59ac609 + 10de47f
commit 9e30014
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 2 deletions.
diff --git a/aries_cloudagent/messaging/models/base_record.py b/aries_cloudagent/messaging/models/base_record.py
@@ -109,8 +109,7 @@ def record_tags(self) -> dict:
         return {
             tag: getattr(self, prop)
             for (prop, tag) in self.get_tag_map().items()
-            if getattr(self, prop)
-            if not None
+            if getattr(self, prop) is not None
         }
 
     @property

diff --git a/aries_cloudagent/protocols/issue_credential/v1_0/models/credential_exchange.py b/aries_cloudagent/protocols/issue_credential/v1_0/models/credential_exchange.py
@@ -1,5 +1,7 @@
 """Aries#0036 v1.0 credential exchange information with non-secrets storage."""
 
+from typing import Any
+
 from marshmallow import fields
 from marshmallow.validate import OneOf
 
@@ -129,6 +131,10 @@ async def retrieve_by_connection_and_thread(
             await cls.set_cached_key(context, cache_key, record.credential_exchange_id)
         return record
 
+    def __eq__(self, other: Any) -> bool:
+        """Comparison between records."""
+        return super().__eq__(other)
+
 
 class V10CredentialExchangeSchema(BaseRecordSchema):
     """Schema to allow serialization/deserialization of credential exchange records."""

diff --git a/aries_cloudagent/protocols/issue_credential/v1_0/tests/test_manager.py b/aries_cloudagent/protocols/issue_credential/v1_0/tests/test_manager.py
@@ -34,6 +34,44 @@ async def setUp(self):
         self.context.injector.bind_instance(BaseLedger, self.ledger)
         self.manager = CredentialManager(self.context)
 
+    async def test_record_eq(self):
+        cred_def_id = "LjgpST2rjsoxYegQDRm7EL:3:CL:18:tag"
+        same = [
+            V10CredentialExchange(
+                credential_exchange_id="dummy-0",
+                thread_id="thread-0",
+                credential_definition_id=cred_def_id,
+                role=V10CredentialExchange.ROLE_ISSUER
+            )
+        ] * 2
+        diff = [
+            V10CredentialExchange(
+                credential_exchange_id="dummy-1",
+                credential_definition_id=cred_def_id,
+                role=V10CredentialExchange.ROLE_ISSUER
+            ),
+            V10CredentialExchange(
+                credential_exchange_id="dummy-0",
+                thread_id="thread-1",
+                credential_definition_id=cred_def_id,
+                role=V10CredentialExchange.ROLE_ISSUER
+            ),
+            V10CredentialExchange(
+                credential_exchange_id="dummy-1",
+                thread_id="thread-0",
+                credential_definition_id=f"{cred_def_id}_distinct_tag",
+                role=V10CredentialExchange.ROLE_ISSUER
+            )
+        ]
+
+        for i in range(len(same) - 1):
+            for j in range(i, len(same)):
+                assert same[i] == same[j]
+
+        for i in range(len(diff) - 1):
+            for j in range(i, len(diff)):
+                assert diff[i] == diff[j] if i == j else diff[i] != diff[j]
+
     async def test_prepare_send(self):
         schema_id = "LjgpST2rjsoxYegQDRm7EL:2:bc-reg:1.0"
         cred_def_id = "LjgpST2rjsoxYegQDRm7EL:3:CL:18:tag"

diff --git a/aries_cloudagent/protocols/present_proof/v1_0/models/presentation_exchange.py b/aries_cloudagent/protocols/present_proof/v1_0/models/presentation_exchange.py
@@ -1,5 +1,7 @@
 """Aries#0037 v1.0 presentation exchange information with non-secrets storage."""
 
+from typing import Any
+
 from marshmallow import fields
 from marshmallow.validate import OneOf
 
@@ -90,6 +92,10 @@ def record_value(self) -> dict:
             )
         }
 
+    def __eq__(self, other: Any) -> bool:
+        """Comparison between records."""
+        return super().__eq__(other)
+
 
 class V10PresentationExchangeSchema(BaseRecordSchema):
     """Schema for de/serialization of v1.0 presentation exchange records."""

diff --git a/aries_cloudagent/protocols/present_proof/v1_0/tests/test_manager.py b/aries_cloudagent/protocols/present_proof/v1_0/tests/test_manager.py
@@ -93,6 +93,39 @@ async def setUp(self):
 
         self.manager = PresentationManager(self.context)
 
+    async def test_record_eq(self):
+        same = [
+            V10PresentationExchange(
+                presentation_exchange_id="dummy-0",
+                thread_id="thread-0",
+                role=V10PresentationExchange.ROLE_PROVER
+            )
+        ] * 2
+        diff = [
+            V10PresentationExchange(
+                presentation_exchange_id="dummy-1",
+                role=V10PresentationExchange.ROLE_PROVER
+            ),
+            V10PresentationExchange(
+                presentation_exchange_id="dummy-0",
+                thread_id="thread-1",
+                role=V10PresentationExchange.ROLE_PROVER
+            ),
+            V10PresentationExchange(
+                presentation_exchange_id="dummy-1",
+                thread_id="thread-0",
+                role=V10PresentationExchange.ROLE_VERIFIER
+            )
+        ]
+
+        for i in range(len(same) - 1):
+            for j in range(i, len(same)):
+                assert same[i] == same[j]
+
+        for i in range(len(diff) - 1):
+            for j in range(i, len(diff)):
+                assert diff[i] == diff[j] if i == j else diff[i] != diff[j]
+
     async def test_create_exchange_for_proposal(self):
         self.context.connection_record = async_mock.MagicMock()
         self.context.connection_record.connection_id = CONN_ID