mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Extend assertInstanceEqual to accept a list of data fields to exclude from comparison with the instance

Browse Source
This commit is contained in:
Jeremy Stretch
2020-11-25 11:44:44 -05:00
parent d250fd91a9
commit f8b523b97b
2 changed files with 22 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
netbox/utilities/testing/api.py
View File

@ -174,6 +174,7 @@ class APIViewTestCases:
class CreateObjectViewTestCase(APITestCase): class CreateObjectViewTestCase(APITestCase):
create_data = [] create_data = []
validation_excluded_fields = []
def test_create_object_without_permission(self): def test_create_object_without_permission(self):
""" """
@ -205,6 +206,7 @@ class APIViewTestCases:
self.assertInstanceEqual( self.assertInstanceEqual(
self._get_queryset().get(pk=response.data['id']), self._get_queryset().get(pk=response.data['id']),
self.create_data[0], self.create_data[0],
exclude=self.validation_excluded_fields,
api=True api=True
) )
@ -229,11 +231,13 @@ class APIViewTestCases:
self.assertInstanceEqual( self.assertInstanceEqual(
self._get_queryset().get(pk=obj['id']), self._get_queryset().get(pk=obj['id']),
self.create_data[i], self.create_data[i],
exclude=self.validation_excluded_fields,
api=True api=True
) )
class UpdateObjectViewTestCase(APITestCase): class UpdateObjectViewTestCase(APITestCase):
update_data = {} update_data = {}
validation_excluded_fields = []
def test_update_object_without_permission(self): def test_update_object_without_permission(self):
""" """
@ -266,7 +270,12 @@ class APIViewTestCases:
response = self.client.patch(url, update_data, format='json', **self.header) response = self.client.patch(url, update_data, format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK) self.assertHttpStatus(response, status.HTTP_200_OK)
instance.refresh_from_db() instance.refresh_from_db()
self.assertInstanceEqual(instance, update_data, api=True) self.assertInstanceEqual(
instance,
update_data,
exclude=self.validation_excluded_fields,
api=True
)
class DeleteObjectViewTestCase(APITestCase): class DeleteObjectViewTestCase(APITestCase):

19
netbox/utilities/testing/views.py
View File

@ -126,20 +126,25 @@ class TestCase(_TestCase):
err_message = f"Expected HTTP status {expected_status}; received {response.status_code}: {err}" err_message = f"Expected HTTP status {expected_status}; received {response.status_code}: {err}"
self.assertEqual(response.status_code, expected_status, err_message) self.assertEqual(response.status_code, expected_status, err_message)
def assertInstanceEqual(self, instance, data, api=False): def assertInstanceEqual(self, instance, data, exclude=None, api=False):
""" """
Compare a model instance to a dictionary, checking that its attribute values match those specified Compare a model instance to a dictionary, checking that its attribute values match those specified
in the dictionary. in the dictionary.
:instance: Python object instance :param instance: Python object instance
:data: Dictionary of test data used to define the instance :param data: Dictionary of test data used to define the instance
:api: Set to True is the data is a JSON representation of the instance :param exclude: List of fields to exclude from comparison (e.g. passwords, which get hashed)
:param api: Set to True is the data is a JSON representation of the instance
""" """
model_dict = self.model_to_dict(instance, fields=data.keys(), api=api) if exclude is None:
exclude = []
# Omit any dictionary keys which are not instance attributes fields = [k for k in data.keys() if k not in exclude]
model_dict = self.model_to_dict(instance, fields=fields, api=api)
# Omit any dictionary keys which are not instance attributes or have been excluded
relevant_data = { relevant_data = {
k: v for k, v in data.items() if hasattr(instance, k) k: v for k, v in data.items() if hasattr(instance, k) and k not in exclude
} }
self.assertDictEqual(model_dict, relevant_data) self.assertDictEqual(model_dict, relevant_data)