cleaned up some more

Author: Noah418

module/netbox/object_classes.py

@@ -659,7 +659,6 @@ def update(self, data=None, read_from_netbox=False, source=None):
                                                      max_len=self.data_model.get("slug"))
 
         # update all data items
-        log.debug2(f"Updating {self.name} '{display_name}' with data: {parsed_data.items()}")
         data_updated = False
         for key, new_value in parsed_data.items():
 
@@ -751,8 +750,7 @@ def update(self, data=None, read_from_netbox=False, source=None):
                 new_value_str = new_value_str.replace("\n", " ")
                 log.info(f"{self.name.capitalize()} '{display_name}' attribute '{key}' changed from "
                          f"'{current_value_str}' to '{new_value_str}'")
-            log.debug2(f"Updating {self.name} '{display_name}' attribute '{key}' from "
-                      f"'{current_value_str}' to '{new_value_str}'")
+            
             self.data[key] = new_value
             self.updated_items.append(key)
             data_updated = True
@@ -1873,6 +1871,7 @@ class NBCluster(NetBoxObject):
 
     def __init__(self, *args, **kwargs):
         self.mapping = NetBoxMappings()
+        # scope types allowed for clusters
         self.scopes = [
             NBSite, NBSiteGroup, NBLocation, NBRegion
         ]
@@ -1883,7 +1882,9 @@ def __init__(self, *args, **kwargs):
             "tenant": NBTenant,
             "group": NBClusterGroup,
             "scope_type": self.mapping.scopes_object_types(self.scopes),
+            # supports scoped clusters
             "scope_id": NetBoxObject,
+            # supports pre4.2.0 clusters with site
             "site": NBSite,
             "tags": NBTagList
         }

module/sources/vmware/config.py

@@ -163,7 +163,7 @@ def __init__(self):
                                                key: defines a cluster name as regex
                                                value: defines the NetBox scope id (use quotes if name contains commas)
                                              """,
-                                             config_example="Cluster_NYC = New York, Cluster_FFM.* = Data Centers, Cluster_BER = Building 1"),
+                                             config_example="Cluster_NYC = 1, Cluster_FFM.* = 2, Cluster_BER = 7"),
                                 ConfigOption("cluster_tenant_relation",
                                              str,
                                              description="""\

module/sources/vmware/connection.py

@@ -469,7 +469,7 @@ def get_site_name(self, object_type, object_name, cluster_name=""):
         if object_type not in [NBCluster, NBDevice]:
             raise ValueError(f"Object must be a '{NBCluster.name}' or '{NBDevice.name}'.")
 
-        log.debug(f"Trying to find site name for {object_type.name} '{object_name}'")
+        log.debug2(f"Trying to find site name for {object_type.name} '{object_name}'")
 
         # check if site was provided in config
         relation_name = "host_site_relation" if object_type == NBDevice else "cluster_site_relation"
@@ -525,24 +525,28 @@ def get_scope_type(self, object_type, object_name):
         if object_type != NBCluster:
             raise ValueError(f"Object type must be '{NBCluster.name}'.")
 
+        # get scope type from relation config
         relation_name = "cluster_scope_type_relation"
         scope_type = self.get_object_relation(object_name, relation_name)
         log.debug(f"Retrieved scope type '{scope_type}' for {object_type.name} '{object_name}' from relation '{relation_name}'.")
 
+        # if the scope_type is a list, use the first element
         if scope_type is not None and type(scope_type) is list:
             scope_type_list = scope_type
             scope_type = scope_type_list[0] if len(scope_type_list) > 0 else None
             log.debug(f"Scope type for {object_type.name} '{object_name}' is a list, using first element: '{scope_type}'")
 
+        # if scope_type is not a str, return None
         if type(scope_type) is not str:
             log.debug(f"scope_type is type: {type(scope_type)}, not str")
             return None
 
+        # set scope_type to None if it is configured as "<NONE>"
         if scope_type == "<NONE>":
             log.debug(f"Scope type for {object_type.name} '{object_name}' is set to None")
             return None
 
-        log.debug(f"Returning scope type '{scope_type}' for {object_type.name} '{object_name}'. End of method.")
+        log.debug2(f"Returning scope type '{scope_type}' for {object_type.name} '{object_name}'.")
         return scope_type
 
     def get_scope_id(self, object_type, object_name):
@@ -567,21 +571,19 @@ def get_scope_id(self, object_type, object_name):
         if object_type != NBCluster:
             raise ValueError(f"Object type must be '{NBCluster.name}'.")
 
-
+        # get scope id from relation config
         relation_name = "cluster_scope_id_relation"
-        
         scope_id = self.get_object_relation(object_name, relation_name)
 
+        # return None if scope_id is None or not a string
         if scope_id is None:
-            scope_id = object_name
-            if scope_id is None:
-                log.debug(f"No scope id found for {object_name}.") 
-                return None
+            log.debug(f"No scope id found for {object_name}.") 
+            return None
         if type(scope_id) is not str:
             log.debug(f"scope_id is type: {type(scope_id)}, not str")
             return None
 
-        log.debug(f"Retrieved scope id '{scope_id}' for {object_type.name} '{object_name}' from relation '{relation_name}'. End of method.")
+        log.debug2(f"Retrieved scope id '{scope_id}' for {object_type.name} '{object_name}' from relation '{relation_name}'. End of method.")
 
         return scope_id
 
@@ -1472,8 +1474,9 @@ def add_cluster(self, obj):
                                       self.settings.cluster_include_filter,
                                       self.settings.cluster_exclude_filter) is False:
             return
-        log.debug(f"Cluster '{name}' passes include and exclude filters. Continuing.")
+        log.debug2(f"Cluster '{name}' passes include and exclude filters. Continuing.")
 
+        # get scope type and id, or site name
         scope_type = self.get_scope_type(NBCluster, full_cluster_name)
         if scope_type is None:
             scope_type = self.get_scope_type(NBCluster, name)
@@ -1504,7 +1507,7 @@ def add_cluster(self, obj):
             else:
                 log.debug(f"Cluster '{full_cluster_name}' has no scope type or scope id.")
         else:
-            # set site_name in the pre-4.2.0 NetBox versions is one is found
+            # set site_name in the pre-4.2.0 NetBox versions if one is found
             if site_name is not None:
                 data["site"] = {"name": site_name}