Merge pull request #45 from networktocode/dga-issue-23

Add support for default status

Author: dgarros

README.md

@@ -39,8 +39,9 @@ The plugin behavior can be controlled with the following list of settings
 - `create_device_type_if_missing` boolean (default True), If True, a new device type object will be created if the model discovered by Napalm do not match an existing device type.
 - `create_manufacturer_if_missing` boolean (default True), If True, a new manufacturer object will be created if the manufacturer discovered by Napalm is do not match an existing manufacturer, this option is only valid if `create_device_type_if_missing` is True as well.
 - `create_device_role_if_missing` boolean (default True), If True, a new device role object will be created if the device role provided was not provided as part of the onboarding and if the `default_device_role` do not already exist. 
+- `default_device_status` string (default "active"), status assigned to a new device by default (must be lowercase).
 - `default_device_role` string (default "network")
-- `default_device_role_color` string (default FF0000) color assigned to the device role if it needs to be created.
+- `default_device_role_color` string (default FF0000), color assigned to the device role if it needs to be created.
 - `default_management_interface` string (default "PLACEHOLDER"), name of the management interface that will be created, if one can't be identified on the device.
 - `default_management_prefix_length` integer ( default 0), length of the prefix that will be used for the management IP address, if the IP can't be found.
 

netbox_onboarding/__init__.py

@@ -36,6 +36,7 @@ class OnboardingConfig(PluginConfig):
         "default_device_role_color": "FF0000",
         "default_management_interface": "PLACEHOLDER",
         "default_management_prefix_length": 0,
+        "default_device_status": "active",
     }
     caching_config = {}
 

netbox_onboarding/onboard.py

@@ -422,17 +422,24 @@ def ensure_device_role(
         self.netdev.ot.save()
         return
 
-    def ensure_device_instance(self):
-        """Ensure that the device instance exists in NetBox and is assigned the provided device role or DEFAULT_ROLE."""
-        # TODO: this can create duplicate entries in NetBox...
-        device, _ = Device.objects.get_or_create(
-            name=self.netdev.hostname,
-            device_type=self.device_type,
-            device_role=self.netdev.ot.role,
-            platform=self.netdev.ot.platform,
-            site=self.netdev.ot.site,
-        )
+    def ensure_device_instance(self, default_status=PLUGIN_SETTINGS["default_device_status"]):
+        """Ensure that the device instance exists in NetBox and is assigned the provided device role or DEFAULT_ROLE.
 
+        Args:
+          default_status (str) : status assigned to a new device by default.
+        """
+        try:
+            device = Device.objects.get(name=self.netdev.hostname, site=self.netdev.ot.site)
+        except Device.DoesNotExist:
+            device = Device.objects.create(
+                name=self.netdev.hostname,
+                site=self.netdev.ot.site,
+                device_type=self.device_type,
+                device_role=self.netdev.ot.role,
+                status=default_status,
+            )
+
+        device.platform = self.netdev.ot.platform
         device.serial = self.netdev.serial_number
         device.save()
 

netbox_onboarding/tests/test_onboard.py

@@ -119,11 +119,34 @@ def test_ensure_device_instance_not_exist(self):
         nbk.device_type = self.device_type1
         nbk.netdev.ot = self.onboarding_task3
 
-        nbk.ensure_device_instance()
+        nbk.ensure_device_instance(default_status="planned")
         self.assertIsInstance(nbk.device, Device)
+        self.assertEqual(nbk.device.status, "planned")
+        self.assertEqual(nbk.device.platform, self.platform1)
         self.assertEqual(nbk.device, nbk.netdev.ot.created_device)
         self.assertEqual(nbk.device.serial, "123456")
 
+    def test_ensure_device_instance_exist(self):
+        """Verify ensure_device_instance function."""
+        device = Device.objects.create(
+            name=self.ndk2.hostname,
+            site=self.site1,
+            device_type=self.device_type1,
+            device_role=self.device_role1,
+            status="planned",
+            serial="987654",
+        )
+
+        nbk = NetboxKeeper(self.ndk2)
+        nbk.netdev.ot = self.onboarding_task3
+        self.assertEqual(nbk.device, None)
+        nbk.ensure_device_instance(default_status="active")
+        self.assertIsInstance(nbk.device, Device)
+        self.assertEqual(nbk.device.status, "planned")
+        self.assertEqual(nbk.device.platform, self.platform1)
+        self.assertEqual(nbk.device, device)
+        self.assertEqual(nbk.device.serial, "123456")
+
     def test_ensure_interface_not_exist(self):
         """Verify ensure_interface function when the interface do not exist."""
         nbk = NetboxKeeper(self.ndk2)