NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-22 12:06:53 -06:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Finish work on improved custom fields API tests

Browse Source
This commit is contained in:
Jeremy Stretch 2020-03-04 09:53:49 -05:00
parent 4611536ca9
commit 57b6ac7cb1
1 changed files with 112 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

169
netbox/extras/tests/test_customfields.py
View File

@ -103,7 +103,6 @@ class CustomFieldAPITest(APITestCase):
@classmethod @classmethod
def setUpTestData(cls): def setUpTestData(cls):
content_type = ContentType.objects.get_for_model(Site) content_type = ContentType.objects.get_for_model(Site)
# Text custom field # Text custom field
@ -145,56 +144,70 @@ class CustomFieldAPITest(APITestCase):
cls.cf_select.default = cls.cf_select_choice1.value cls.cf_select.default = cls.cf_select_choice1.value
cls.cf_select.save() cls.cf_select.save()
# def test_get_obj_without_custom_fields(self): # Create some sites
# cls.sites = (
# url = reverse('dcim-api:site-detail', kwargs={'pk': self.site.pk}) Site(name='Site 1', slug='site-1'),
# response = self.client.get(url, **self.header) Site(name='Site 2', slug='site-2'),
# )
# self.assertEqual(response.data['name'], self.site.name) Site.objects.bulk_create(cls.sites)
# self.assertEqual(response.data['custom_fields'], {
# 'text_field': None,
# 'number_field': None,
# 'boolean_field': None,
# 'date_field': None,
# 'url_field': None,
# 'choice_field': None,
# })
# def test_get_single_object_with_custom_fields(self): # Assign custom field values for site 2
# site2_cfvs = {
# CUSTOM_FIELD_VALUES = [ cls.cf_text: 'bar',
# (self.cf_text, 'Test string'), cls.cf_integer: 456,
# (self.cf_integer, 1234), cls.cf_boolean: True,
# (self.cf_boolean, True), cls.cf_date: '2020-01-02',
# (self.cf_date, date(2016, 6, 23)), cls.cf_url: 'http://example.com/2',
# (self.cf_url, 'http://example.com/'), cls.cf_select: cls.cf_select_choice2.pk,
# (self.cf_select, self.cf_select_choice1.pk), }
# ] for field, value in site2_cfvs.items():
# for field, value in CUSTOM_FIELD_VALUES: cfv = CustomFieldValue(field=field, obj=cls.sites[1])
# cfv = CustomFieldValue(field=field, obj=self.site) cfv.value = value
# cfv.value = value cfv.save()
# cfv.save()
# def test_get_single_object_without_custom_field_values(self):
# url = reverse('dcim-api:site-detail', kwargs={'pk': self.site.pk}) """
# response = self.client.get(url, **self.header) Validate that custom fields are present on an object even if it has no values defined.
# """
# self.assertEqual(response.data['name'], self.site.name) url = reverse('dcim-api:site-detail', kwargs={'pk': self.sites[0].pk})
# self.assertEqual(response.data['custom_fields'].get('text_field'), CUSTOM_FIELD_VALUES[0][1]) response = self.client.get(url, **self.header)
# self.assertEqual(response.data['custom_fields'].get('number_field'), CUSTOM_FIELD_VALUES[1][1])
# self.assertEqual(response.data['custom_fields'].get('boolean_field'), CUSTOM_FIELD_VALUES[2][1]) self.assertEqual(response.data['name'], self.sites[0].name)
# self.assertEqual(response.data['custom_fields'].get('date_field'), CUSTOM_FIELD_VALUES[3][1]) self.assertEqual(response.data['custom_fields'], {
# self.assertEqual(response.data['custom_fields'].get('url_field'), CUSTOM_FIELD_VALUES[4][1]) 'text_field': None,
# self.assertEqual(response.data['custom_fields'].get('choice_field'), { 'number_field': None,
# 'value': self.cf_select_choice1.pk, 'label': 'Foo' 'boolean_field': None,
# }) 'date_field': None,
'url_field': None,
'choice_field': None,
})
def test_get_single_object_with_custom_field_values(self):
"""
Validate that custom fields are present and correctly set for an object with values defined.
"""
site2_cfvs = {
cfv.field.name: cfv.value for cfv in self.sites[1].custom_field_values.all()
}
url = reverse('dcim-api:site-detail', kwargs={'pk': self.sites[1].pk})
response = self.client.get(url, **self.header)
self.assertEqual(response.data['name'], self.sites[1].name)
self.assertEqual(response.data['custom_fields']['text_field'], site2_cfvs['text_field'])
self.assertEqual(response.data['custom_fields']['number_field'], site2_cfvs['number_field'])
self.assertEqual(response.data['custom_fields']['boolean_field'], site2_cfvs['boolean_field'])
self.assertEqual(response.data['custom_fields']['date_field'], site2_cfvs['date_field'])
self.assertEqual(response.data['custom_fields']['url_field'], site2_cfvs['url_field'])
self.assertEqual(response.data['custom_fields']['choice_field']['label'], self.cf_select_choice2.value)
def test_create_single_object_with_defaults(self): def test_create_single_object_with_defaults(self):
""" """
Create a new site and check that it received the default custom field values. Create a new site with no specified custom field values and check that it received the default values.
""" """
data = { data = {
'name': 'Site 2', 'name': 'Site 3',
'slug': 'site-2', 'slug': 'site-3',
} }
url = reverse('dcim-api:site-list') url = reverse('dcim-api:site-list')
@ -227,8 +240,8 @@ class CustomFieldAPITest(APITestCase):
Create a single new site with a value for each type of custom field. Create a single new site with a value for each type of custom field.
""" """
data = { data = {
'name': 'Site 2', 'name': 'Site 3',
'slug': 'site-2', 'slug': 'site-3',
'custom_fields': { 'custom_fields': {
'text_field': 'bar', 'text_field': 'bar',
'number_field': 456, 'number_field': 456,
@ -267,13 +280,10 @@ class CustomFieldAPITest(APITestCase):
def test_create_multiple_objects_with_defaults(self): def test_create_multiple_objects_with_defaults(self):
""" """
Create three news sites and check that each received the default custom field values. Create three news sites with no specified custom field values and check that each received
the default custom field values.
""" """
data = ( data = (
{
'name': 'Site 2',
'slug': 'site-2',
},
{ {
'name': 'Site 3', 'name': 'Site 3',
'slug': 'site-3', 'slug': 'site-3',
@ -282,6 +292,10 @@ class CustomFieldAPITest(APITestCase):
'name': 'Site 4', 'name': 'Site 4',
'slug': 'site-4', 'slug': 'site-4',
}, },
{
'name': 'Site 5',
'slug': 'site-5',
},
) )
url = reverse('dcim-api:site-list') url = reverse('dcim-api:site-list')
@ -325,11 +339,6 @@ class CustomFieldAPITest(APITestCase):
'choice_field': self.cf_select_choice2.pk, 'choice_field': self.cf_select_choice2.pk,
} }
data = ( data = (
{
'name': 'Site 2',
'slug': 'site-2',
'custom_fields': custom_field_data,
},
{ {
'name': 'Site 3', 'name': 'Site 3',
'slug': 'site-3', 'slug': 'site-3',
@ -340,6 +349,11 @@ class CustomFieldAPITest(APITestCase):
'slug': 'site-4', 'slug': 'site-4',
'custom_fields': custom_field_data, 'custom_fields': custom_field_data,
}, },
{
'name': 'Site 5',
'slug': 'site-5',
'custom_fields': custom_field_data,
},
) )
url = reverse('dcim-api:site-list') url = reverse('dcim-api:site-list')
@ -370,6 +384,47 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(cfvs['url_field'], custom_field_data['url_field']) self.assertEqual(cfvs['url_field'], custom_field_data['url_field'])
self.assertEqual(cfvs['choice_field'].pk, custom_field_data['choice_field']) self.assertEqual(cfvs['choice_field'].pk, custom_field_data['choice_field'])
def test_update_single_object_with_values(self):
"""
Update an object with existing custom field values. Ensure that only the updated custom field values are
modified.
"""
site2_original_cfvs = {
cfv.field.name: cfv.value for cfv in self.sites[1].custom_field_values.all()
}
data = {
'custom_fields': {
'text_field': 'ABCD',
'number_field': 1234,
},
}
url = reverse('dcim-api:site-detail', kwargs={'pk': self.sites[1].pk})
response = self.client.patch(url, data, format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK)
# Validate response data
response_cf = response.data['custom_fields']
data_cf = data['custom_fields']
self.assertEqual(response_cf['text_field'], data_cf['text_field'])
self.assertEqual(response_cf['number_field'], data_cf['number_field'])
# TODO: Non-updated fields are missing from the response data
# self.assertEqual(response_cf['boolean_field'], site2_original_cfvs['boolean_field'])
# self.assertEqual(response_cf['date_field'], site2_original_cfvs['date_field'])
# self.assertEqual(response_cf['url_field'], site2_original_cfvs['url_field'])
# self.assertEqual(response_cf['choice_field']['label'], site2_original_cfvs['choice_field'].value)
# Validate database data
site2_updated_cfvs = {
cfv.field.name: cfv.value for cfv in self.sites[1].custom_field_values.all()
}
self.assertEqual(site2_updated_cfvs['text_field'], data_cf['text_field'])
self.assertEqual(site2_updated_cfvs['number_field'], data_cf['number_field'])
self.assertEqual(site2_updated_cfvs['boolean_field'], site2_original_cfvs['boolean_field'])
self.assertEqual(site2_updated_cfvs['date_field'], site2_original_cfvs['date_field'])
self.assertEqual(site2_updated_cfvs['url_field'], site2_original_cfvs['url_field'])
self.assertEqual(site2_updated_cfvs['choice_field'], site2_original_cfvs['choice_field'])
class CustomFieldChoiceAPITest(APITestCase): class CustomFieldChoiceAPITest(APITestCase):
def setUp(self): def setUp(self):