#2487: Added API tests

netbox/virtualization/api/serializers.py

@@ -169,7 +169,8 @@ class InterfaceSerializer(TaggitSerializer, ValidatedModelSerializer):
 
 class NestedInterfaceSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:interface-detail')
+    virtual_machine = NestedVirtualMachineSerializer(read_only=True)
 
     class Meta:
         model = Interface
-        fields = ['id', 'url', 'name']
+        fields = ['id', 'url', 'virtual_machine', 'name']

netbox/virtualization/api/views.py

@@ -56,6 +56,11 @@ class VirtualMachineViewSet(CustomFieldModelViewSet):
         """
         if self.action == 'retrieve':
             return serializers.VirtualMachineWithConfigContextSerializer
+
+        request = self.get_serializer_context()['request']
+        if request.query_params.get('brief', False):
+            return serializers.NestedVirtualMachineSerializer
+
         return serializers.VirtualMachineSerializer
 
 
@@ -65,3 +70,10 @@ class InterfaceViewSet(ModelViewSet):
     ).select_related('virtual_machine').prefetch_related('tags')
     serializer_class = serializers.InterfaceSerializer
     filter_class = filters.InterfaceFilter
+
+    def get_serializer_class(self):
+        request = self.get_serializer_context()['request']
+        if request.query_params.get('brief', False):
+            # Override get_serializer_for_model(), which will return the DCIM NestedInterfaceSerializer
+            return serializers.NestedInterfaceSerializer
+        return serializers.InterfaceSerializer

netbox/virtualization/tests/test_api.py

@@ -35,6 +35,16 @@ class ClusterTypeTest(APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_clustertypes_brief(self):
+
+        url = reverse('virtualization-api:clustertype-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['id', 'name', 'slug', 'url']
+        )
+
     def test_create_clustertype(self):
 
         data = {
@@ -126,6 +136,16 @@ class ClusterGroupTest(APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_clustergroups_brief(self):
+
+        url = reverse('virtualization-api:clustergroup-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['id', 'name', 'slug', 'url']
+        )
+
     def test_create_clustergroup(self):
 
         data = {
@@ -220,6 +240,16 @@ class ClusterTest(APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_clusters_brief(self):
+
+        url = reverse('virtualization-api:cluster-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['id', 'name', 'url']
+        )
+
     def test_create_cluster(self):
 
         data = {
@@ -324,6 +354,16 @@ class VirtualMachineTest(APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_virtualmachines_brief(self):
+
+        url = reverse('virtualization-api:virtualmachine-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['id', 'name', 'url']
+        )
+
     def test_create_virtualmachine(self):
 
         data = {
@@ -447,6 +487,16 @@ class InterfaceTest(APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_interfaces_brief(self):
+
+        url = reverse('virtualization-api:interface-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['id', 'name', 'url', 'virtual_machine']
+        )
+
     def test_create_interface(self):
 
         data = {