Testing improvements (#49)

* Incremental improvement of test_dcim.py

* Greatly reduce code duplication in tests, make test data *marginally* more realistic for Nautobot

* Remove more unneeded six.PY3 checks

* Update CHANGELOG

CHANGELOG.md

@@ -1,13 +1,14 @@
 # Changelog
 
-## v1.1.0
+## v1.1.1
 
 ### Bug Fixes
 
+(#43) Incorrect attribute (**display_name**) set for VirtualChassis in `__str__` method of record. Changed to **display**.
 (#44) Incorrect method signatures for new `api_version` argument causing data to be set as `api_version`.
-(#46) Incorrect attribute (**display_name**) set for VirtualChassis in `__str__` method of record. Changed to **display**.
+(#46) Added assert_called_with() checks to several unit tests; various test refactoring
 
-## v1.1.0
+## v1.1.0 (YANKED)
 
 (#36) Add api_version argument [@timizuoebideri1]
 

tests/__init__.py

@@ -0,0 +1,101 @@
+import unittest
+from unittest.mock import patch
+
+import pynautobot
+
+from .util import Response
+
+api = pynautobot.api("http://localhost:8000", token="abc123",)
+
+HEADERS = {
+    "accept": "application/json;",
+    "authorization": "Token abc123",
+}
+
+POST_HEADERS = {
+    "Content-Type": "application/json;",
+    "authorization": "Token abc123",
+}
+
+
+class Generic:
+    class Tests(unittest.TestCase):
+        ret = pynautobot.core.response.Record
+
+        app = ""  # to be set by subclasses
+        name = ""  # to be set by subclasses
+        name_singular = ""  # to be optionally set by subclasses
+        uuid = "5b39ba88-e5ab-4be2-89f5-5a016473b53c"
+
+        @property
+        def bulk_uri(self):
+            return f"http://localhost:8000/api/{self.app}/{self.name.replace('_', '-')}/"
+
+        @property
+        def detail_uri(self):
+            return f"http://localhost:8000/api/{self.app}/{self.name.replace('_', '-')}/{self.uuid}/"
+
+        def setUp(self):
+            self.nb = getattr(api, self.app)
+            self.endpoint = getattr(self.nb, self.name)
+            if not self.name_singular:
+                self.name_singular = self.name[:-1]
+
+        #
+        # Generic test cases for the given app/name
+        #
+
+        def test_get_all(self):
+            with patch(
+                "requests.sessions.Session.get", return_value=Response(fixture=f"{self.app}/{self.name}.json"),
+            ) as mock:
+                ret = self.endpoint.all()
+                self.assertIsInstance(ret, list)
+                self.assertIsInstance(ret[0], self.ret)
+                mock.assert_called_with(self.bulk_uri, params={}, json=None, headers=HEADERS)
+
+        def test_filter(self):
+            with patch(
+                "requests.sessions.Session.get", return_value=Response(fixture=f"{self.app}/{self.name}.json"),
+            ) as mock:
+                ret = self.endpoint.filter(name="test")
+                self.assertIsInstance(ret, list)
+                self.assertIsInstance(ret[0], self.ret)
+                mock.assert_called_with(self.bulk_uri, params={"name": "test"}, json=None, headers=HEADERS)
+
+        def test_get(self):
+            with patch(
+                "requests.sessions.Session.get", return_value=Response(fixture=f"{self.app}/{self.name_singular}.json"),
+            ) as mock:
+                ret = self.endpoint.get(self.uuid)
+                self.assertIsInstance(ret, self.ret)
+                self.assertEqual(ret.id, self.uuid)
+                self.assertIsInstance(str(ret), str)
+                self.assertIsInstance(dict(ret), dict)
+                mock.assert_called_with(self.detail_uri, params={}, json=None, headers=HEADERS)
+
+        def test_delete(self):
+            with patch(
+                "requests.sessions.Session.get", return_value=Response(fixture=f"{self.app}/{self.name_singular}.json"),
+            ) as mock, patch("requests.sessions.Session.delete") as delete:
+                ret = self.endpoint.get(self.uuid)
+                # get() was already tested more thoroughly above, not repeated here
+                self.assertTrue(ret.delete())
+                mock.assert_called_with(self.detail_uri, params={}, json=None, headers=HEADERS)
+                delete.assert_called_with(self.detail_uri, params={}, json=None, headers=HEADERS)
+
+        def test_diff(self):
+            with patch(
+                "requests.sessions.Session.get", return_value=Response(fixture=f"{self.app}/{self.name_singular}.json"),
+            ):
+                ret = self.endpoint.get(self.uuid)
+                self.assertTrue(ret)
+                self.assertEqual(ret._diff(), set())
+
+        def test_serialize(self):
+            with patch(
+                "requests.sessions.Session.get", return_value=Response(fixture=f"{self.app}/{self.name_singular}.json"),
+            ):
+                ret = self.endpoint.get(self.uuid)
+                self.assertTrue(ret)
+                self.assertTrue(ret.serialize())

tests/fixtures/circuits/circuit.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "cid": "123456",
     "provider": {
         "id": 1,
@@ -19,4 +19,4 @@
     "description": "",
     "comments": "",
     "custom_fields": {}
-}
+}

tests/fixtures/circuits/circuit_termination.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "circuit": {
         "id": 1,
         "url": "http://localhost:8000/api/circuits/circuits/1/",
@@ -36,4 +36,4 @@
     "upstream_speed": null,
     "xconnect_id": "",
     "pp_info": ""
-}
+}

tests/fixtures/circuits/circuit_type.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "name": "Transit",
     "slug": "transit"
-}
+}

tests/fixtures/circuits/provider.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "name": "TEST",
     "slug": "test",
     "asn": null,
@@ -9,4 +9,4 @@
     "admin_contact": "",
     "comments": "",
     "custom_fields": {}
-}
+}

tests/fixtures/dcim/cable.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "termination_a_type": "dcim.consoleport",
     "termination_a_id": 1,
     "termination_a": {
@@ -37,4 +37,4 @@
     "color": "",
     "length": null,
     "length_unit": null
-}
+}

tests/fixtures/dcim/console_port.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device": {
         "id": 1,
         "url": "http://localhost:8000/api/dcim/devices/1/",
@@ -19,4 +19,4 @@
         "connected_console": 1
     },
     "connection_status": true
-}
+}

tests/fixtures/dcim/console_port_template.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device_type": {
         "id": 1,
         "url": "http://localhost:8000/api/dcim/device-types/1/",
@@ -13,4 +13,4 @@
         "slug": "mx960"
     },
     "name": "Console (RE0)"
-}
+}

tests/fixtures/dcim/console_server_port.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device": {
         "id": 9,
         "url": "http://localhost:8000/api/dcim/devices/9/",
@@ -8,4 +8,4 @@
     },
     "name": "Port 1",
     "connected_console": 3
-}
+}

tests/fixtures/dcim/console_server_port_template.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device_type": {
         "id": 3,
         "url": "http://localhost:8000/api/dcim/device-types/3/",
@@ -13,4 +13,4 @@
         "slug": "qfx5100-24q"
     },
     "name": "Console"
-}
+}

tests/fixtures/dcim/device.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "name": "test1-edge1",
     "display_name": "test1-edge1",
     "device_type": {

tests/fixtures/dcim/device_bay.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device": {
         "id": 13,
         "url": "http://localhost:8000/api/dcim/devices/13/",
@@ -8,4 +8,4 @@
     },
     "name": "thing-1",
     "installed_device": null
-}
+}

tests/fixtures/dcim/device_bay_template.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device_type": {
         "id": 7,
         "url": "http://localhost:8000/api/dcim/device-types/7/",
@@ -13,4 +13,4 @@
         "slug": "mothership"
     },
     "name": "thing-1"
-}
+}

tests/fixtures/dcim/device_role.json

@@ -1,6 +1,6 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "name": "Router",
     "slug": "router",
     "color": "purple"
-}
+}

tests/fixtures/dcim/device_type.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "manufacturer": {
         "id": 1,
         "url": "http://localhost:8000/api/dcim/manufacturers/1/",
@@ -22,4 +22,4 @@
     "comments": "",
     "custom_fields": {},
     "instance_count": 2
-}
+}

tests/fixtures/dcim/interface.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device": {
         "id": 2,
         "url": "http://localhost:8000/api/dcim/devices/2/",
@@ -57,11 +57,11 @@
     },
     "tagged_vlans": [
         {
-            "id": 3,
+            "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
             "url": "http://localhost:8000/api/ipam/vlans/248/",
             "vid": 1210,
             "name": "v1210",
             "display_name": "1210 (v1210)"
         }
     ]
-}
+}

tests/fixtures/dcim/interface_connection.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "interface_a": {
         "id": 99,
         "url": "http://localhost:8000/api/dcim/interfaces/99/",

tests/fixtures/dcim/interface_template.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device_type": {
         "id": 1,
         "url": "http://localhost:8000/api/dcim/device-types/1/",
@@ -18,4 +18,4 @@
         "label": "1000BASE-T (1GE)"
     },
     "mgmt_only": true
-}
+}

tests/fixtures/dcim/manufacturer.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "name": "Juniper",
     "slug": "juniper"
-}
+}

tests/fixtures/dcim/platform.json

@@ -1,6 +1,6 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "name": "Juniper Junos",
     "slug": "juniper-junos",
     "rpc_client": "juniper-junos"
-}
+}

tests/fixtures/dcim/power_outlet.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device": {
         "id": 11,
         "url": "http://localhost:8000/api/dcim/devices/11/",
@@ -8,4 +8,4 @@
     },
     "name": "AA1",
     "connected_port": 1
-}
+}

tests/fixtures/dcim/power_outlet_template.json

@@ -1,5 +1,5 @@
 {
-    "id": 1,
+    "id": "5b39ba88-e5ab-4be2-89f5-5a016473b53c",
     "device_type": {
         "id": 6,
         "url": "http://localhost:8000/api/dcim/device-types/6/",
@@ -13,4 +13,4 @@
         "slug": "cwg-24vym415c9"
     },
     "name": "AA1"
-}
+}