Add meta field to entity ref and to asserter

Author: jamesfneyer

src/shipchain_common/test_utils/json_asserter.py

@@ -21,11 +21,12 @@
 
 
 class EntityReferenceClass:
-    def __init__(self, resource=None, pk=None, attributes=None, relationships=None):
+    def __init__(self, resource=None, pk=None, attributes=None, relationships=None, meta=None):
         self.resource = resource
         self.pk = pk
         self.attributes = attributes
         self.relationships = relationships
+        self.meta = meta
 
     def __str__(self):
         return f'Type: {self.resource}; ID: {self.pk}; ' \
@@ -158,6 +159,21 @@ def _vnd_assert_relationships(response_data, relationships):
                             f'EntityRef ID `{relationship_ref.pk}` does not match {response_relationships}'
 
 
+def _vnd_assert_meta(response_data, meta_data):
+    """
+    Scan response data for meta data
+    """
+    assert 'meta' in response_data, f'Meta missing in {response_data}'
+    assert isinstance(meta_data, dict), f'Invalid format for meta data {type(meta_data)}, must be dict'
+
+    response_meta = response_data['meta']
+
+    for key, value in meta_data.items():
+        assert key in response_meta, f'Meta field `{key}` not found in {response_meta}'
+        assert response_meta[key] == value,\
+            f'Meta field `{key}` had value `{response_meta[key]}` not `{value}` as expected.'
+
+
 def _vnd_assert_include(response, included):
     """
     Scan a response for all included resources
@@ -187,6 +203,9 @@ def _vnd_assertions(response_data, entity_ref):
     if entity_ref.relationships:
         _vnd_assert_relationships(response_data, entity_ref.relationships)
 
+    if entity_ref.meta:
+        _vnd_assert_meta(response_data, entity_ref.meta)
+
 
 def _plain_assert_attributes_in_response(response, attributes):
     for key, value in attributes.items():

tests/test_json_asserter.py

@@ -105,6 +105,10 @@ def vnd_single():
                         }
                     ]
                 }
+            },
+            'meta': {
+                'key': 'value',
+                'other_key': 'other_value',
             }
         },
         'included': [
@@ -1080,3 +1084,58 @@ def test_plain_json_single_count(self, vnd_single):
         with pytest.raises(AssertionError) as err:
             AssertionHelper.HTTP_200(response, count=1)
         assert f'Count is only checked when response is list' in str(err.value)
+
+    def test_vnd_meta(self, vnd_single):
+        response = self.build_response(vnd_single)
+        AssertionHelper.HTTP_200(response, entity_refs=AssertionHelper.EntityRef(
+            resource=EXAMPLE_RESOURCE['type'],
+            meta={
+                'key': 'value',
+                'other_key': 'other_value'
+            },
+         ))
+
+    def test_vnd_meta_mismatch(self, vnd_single):
+        response = self.build_response(vnd_single)
+        with pytest.raises(AssertionError) as err:
+            AssertionHelper.HTTP_200(response, entity_refs=AssertionHelper.EntityRef(
+                resource=EXAMPLE_RESOURCE['type'],
+                meta={
+                    'key': 'different value'
+                },
+             ))
+        assert f'Meta field `key` had value `value` not `different value` as expected.' in str(err.value)
+
+    def test_vnd_meta_invalid_key(self, vnd_single):
+        response = self.build_response(vnd_single)
+        with pytest.raises(AssertionError) as err:
+            AssertionHelper.HTTP_200(response, entity_refs=AssertionHelper.EntityRef(
+                resource=EXAMPLE_RESOURCE['type'],
+                meta={
+                    'invalid_key': 'value'
+                },
+             ))
+        assert f'Meta field `invalid_key` not found' in str(err.value)
+
+    def test_vnd_no_meta(self, vnd_single):
+        vnd_single['data'].pop('meta')
+        response = self.build_response(vnd_single)
+        with pytest.raises(AssertionError) as err:
+            AssertionHelper.HTTP_200(response, entity_refs=AssertionHelper.EntityRef(
+                resource=EXAMPLE_RESOURCE['type'],
+                meta={
+                    'key': 'value'
+                },
+             ))
+        assert 'Meta missing' in str(err.value)
+
+    def test_vnd_invalid_meta_format(self, vnd_single):
+        response = self.build_response(vnd_single)
+        with pytest.raises(AssertionError) as err:
+            AssertionHelper.HTTP_200(response, entity_refs=AssertionHelper.EntityRef(
+                resource=EXAMPLE_RESOURCE['type'],
+                meta=[{
+                    'key': 'value'
+                }],
+             ))
+        assert 'Invalid format for meta data <class \'list\'>, must be dict' in str(err.value)