Adding missing field processing for custom_fields and object_permissions (#9)

Co-authored-by: Omri Abu <[email protected]>

Author: Omripresent

src/netbox_initializers/initializers/custom_fields.py

@@ -49,7 +49,69 @@ def load_data(self):
                 if cf_details.get("weight", -1) >= 0:
                     custom_field.weight = cf_details["weight"]
 
-                if cf_details.get("choices", False):
+                # object_type should only be applied when type is object, multiobject
+                if cf_details.get("object_type"):
+                    if cf_details.get("type") not in (
+                        "object",
+                        "multiobject",
+                    ):
+                        print(
+                            f"⚠️ Unable to create Custom Field '{cf_name}': object_type is "
+                            + "supported only for object and multiobject types"
+                        )
+                        custom_field.delete()
+                        continue
+                    custom_field.object_type = get_class_for_class_path(cf_details["object_type"])
+
+                # validation_regex should only be applied when type is text, longtext, url
+                if cf_details.get("validation_regex"):
+                    if cf_details.get("type") not in (
+                        "text",
+                        "longtext",
+                        "url",
+                    ):
+                        print(
+                            f"⚠️ Unable to create Custom Field '{cf_name}': validation_regex is "
+                            + "supported only for text, longtext and, url types"
+                        )
+                        custom_field.delete()
+                        continue
+                    custom_field.validation_regex = cf_details["validation_regex"]
+
+                # validation_minimum should only be applied when type is integer
+                if cf_details.get("validation_minimum"):
+                    if cf_details.get("type") not in ("integer",):
+                        print(
+                            f"⚠️ Unable to create Custom Field '{cf_name}': validation_minimum is "
+                            + "supported only for integer type"
+                        )
+                        custom_field.delete()
+                        continue
+                    custom_field.validation_minimum = cf_details["validation_minimum"]
+
+                # validation_maximum should only be applied when type is integer
+                if cf_details.get("validation_maximum"):
+                    if cf_details.get("type") not in ("integer",):
+                        print(
+                            f"⚠️ Unable to create Custom Field '{cf_name}': validation_maximum is "
+                            + "supported only for integer type"
+                        )
+                        custom_field.delete()
+                        continue
+                    custom_field.validation_maximum = cf_details["validation_maximum"]
+
+                # choices should only be applied when type is select, multiselect
+                if cf_details.get("choices"):
+                    if cf_details.get("type") not in (
+                        "select",
+                        "multiselect",
+                    ):
+                        print(
+                            f"⚠️ Unable to create Custom Field '{cf_name}': choices is supported only "
+                            + "for select and multiselect types"
+                        )
+                        custom_field.delete()
+                        continue
                     custom_field.choices = []
 
                     for choice_detail in cf_details.get("choices", []):

src/netbox_initializers/initializers/object_permissions.py

@@ -22,6 +22,9 @@ def load_data(self):
                 },
             )
 
+            if permission_details.get("constraints", 0):
+                object_permission.constraints = permission_details["constraints"]
+
             if permission_details.get("object_types", 0):
                 object_types = permission_details["object_types"]
 

src/netbox_initializers/initializers/yaml/custom_fields.yml

@@ -6,6 +6,9 @@
 ##   - date
 ##   - url
 ##   - select
+##   - multiselect
+##   - object
+##   - multiobject
 ##   filter_logic:
 ##   - disabled
 ##   - loose
@@ -34,6 +37,8 @@
 #   description: Enter numbers into an integer field.
 #   required: true
 #   filter_logic: loose
+#   validation_minimum: 0
+#   validation_maximum: 255
 #   weight: 10
 #   on_objects:
 #   - tenancy.models.Tenant
@@ -82,6 +87,7 @@
 #   description: Link to something nice.
 #   required: true
 #   filter_logic: disabled
+#   validation_regex: ^https://
 #   on_objects:
 #   - tenancy.models.Tenant
 # date_field:
@@ -91,3 +97,21 @@
 #   filter_logic: disabled
 #   on_objects:
 #   - dcim.models.Device
+# multiobject_field:
+#   type: multiobject
+#   label: Related Objects
+#   description: IP addresses that belong to this location
+#   required: true
+#   filter_logic: loose
+#   on_objects:
+#   - dcim.models.Location
+#   object_type: ipam.models.IPAddress
+# object_field:
+#   type: object
+#   label: ASN
+#   description: This device has an ASN now
+#   required: false
+#   filter_logic: loose
+#   on_objects:
+#   - dcim.models.Device
+#   object_type: ipam.models.ASN

src/netbox_initializers/initializers/yaml/object_permissions.yml

@@ -46,3 +46,15 @@
 #       - vlan
 #       - vlangroup
 #       - vrf
+# vips.change:
+#   actions:
+#     - change
+#   description: "Update VIP object permission"
+#   enabled: true
+#   object_types:
+#     ipam:
+#       - ipaddress
+#   groups:
+#     - devops
+#   constraints:
+#     role: vip