force string comparison for ease of use with UUIDField

Author: mlclay

src/shipchain_common/test_utils/json_asserter.py

@@ -201,7 +201,8 @@ def _vnd_assertions(response_data, entity_ref):
         assert response_data['type'] == entity_ref.resource, f'Invalid Resource Type in {response_data}'
 
     if entity_ref.pk:
-        assert response_data['id'] == entity_ref.pk, f'Invalid ID in {response_data}'
+        # entity_ref.pk can be a CharField or a UUIDField. Force string comparison for ease of use with UUIDField.
+        assert response_data['id'] == str(entity_ref.pk), f'Invalid ID in {response_data}'
 
     if entity_ref.attributes:
         _vnd_assert_attributes(response_data, entity_ref.attributes)

tests/test_json_asserter.py

@@ -1,4 +1,5 @@
 from unittest.mock import Mock
+import uuid
 
 import pytest
 from rest_framework import status
@@ -735,6 +736,13 @@ def test_entity_list_non_list_response(self, vnd_single):
             AssertionHelper.HTTP_200(response, entity_refs=[AssertionHelper.EntityRef()])
         assert 'entity_refs should not be a list for a non-list response' in str(err.value)
 
+    def test_vnd_entity_uuid_pk(self, vnd_single):
+        response = self.build_response(vnd_single)
+        AssertionHelper.HTTP_200(response, entity_refs=AssertionHelper.EntityRef(
+            resource=EXAMPLE_RESOURCE['type'],
+            pk=uuid.UUID(EXAMPLE_RESOURCE['id'])
+        ))
+
     def test_vnd_entity_full_match(self, vnd_single):
         response = self.build_response(vnd_single)
         AssertionHelper.HTTP_200(response, entity_refs=AssertionHelper.EntityRef(