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

Closes #8995: Enable arbitrary ordering of REST API results

Browse Source
This commit is contained in:
jeremystretch
2022-04-08 16:00:33 -04:00
parent 9b8de19fe6
commit 03535ce50b
4 changed files with 87 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
netbox/utilities/tests/test_api.py
View File

@@ -176,6 +176,64 @@ class APIPaginationTestCase(APITestCase):
self.assertEqual(len(response.data['results']), 100)
class APIOrderingTestCase(APITestCase):
user_permissions = ('dcim.view_site',)
@classmethod
def setUpTestData(cls):
cls.url = reverse('dcim-api:site-list')
sites = (
Site(name='Site 1', slug='site-1', facility='C', description='Z'),
Site(name='Site 2', slug='site-2', facility='C', description='Y'),
Site(name='Site 3', slug='site-3', facility='B', description='X'),
Site(name='Site 4', slug='site-4', facility='B', description='W'),
Site(name='Site 5', slug='site-5', facility='A', description='V'),
Site(name='Site 6', slug='site-6', facility='A', description='U'),
)
Site.objects.bulk_create(sites)
def test_default_order(self):
response = self.client.get(self.url, format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK)
self.assertEqual(response.data['count'], 6)
self.assertListEqual(
[s['name'] for s in response.data['results']],
['Site 1', 'Site 2', 'Site 3', 'Site 4', 'Site 5', 'Site 6']
)
def test_order_single_field(self):
response = self.client.get(f'{self.url}?ordering=description', format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK)
self.assertEqual(response.data['count'], 6)
self.assertListEqual(
[s['name'] for s in response.data['results']],
['Site 6', 'Site 5', 'Site 4', 'Site 3', 'Site 2', 'Site 1']
)
def test_order_reversed(self):
response = self.client.get(f'{self.url}?ordering=-name', format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK)
self.assertEqual(response.data['count'], 6)
self.assertListEqual(
[s['name'] for s in response.data['results']],
['Site 6', 'Site 5', 'Site 4', 'Site 3', 'Site 2', 'Site 1']
)
def test_order_multiple_fields(self):
response = self.client.get(f'{self.url}?ordering=facility,name', format='json', **self.header)
self.assertHttpStatus(response, status.HTTP_200_OK)
self.assertEqual(response.data['count'], 6)
self.assertListEqual(
[s['name'] for s in response.data['results']],
['Site 5', 'Site 6', 'Site 3', 'Site 4', 'Site 1', 'Site 2']
)
class APIDocsTestCase(TestCase):
def setUp(self):