Inventory: add group_by options for cluster, cluster_type, and cluster_group (#188) (#191)

Author: DouglasHeriot

hacking/update_test_inventories.sh

@@ -13,6 +13,9 @@ set -e
 export ANSIBLE_COLLECTIONS_PATHS=.
 export OUTPUT_INVENTORY_JSON=tests/integration/targets/inventory/files
 
+# Remove local cache
+rm -rf /tmp/inventory_netbox/
+
 # Clean and install the built collection
 ./hacking/local-test.sh
 

plugins/inventory/nb_inventory.py

@@ -89,6 +89,9 @@
                 - platforms
                 - platform
                 - region
+                - cluster
+                - cluster_type
+                - cluster_group
             default: []
         group_names_raw:
             description: Will not add the group_by choice name to the group names
@@ -497,6 +500,9 @@ def group_extractors(self):
                 "interfaces": self.extract_interfaces,
                 "custom_fields": self.extract_custom_fields,
                 "region": self.extract_regions,
+                "cluster": self.extract_cluster,
+                "cluster_group": self.extract_cluster_group,
+                "cluster_type": self.extract_cluster_type,
             }
         else:
             return {
@@ -516,6 +522,9 @@ def group_extractors(self):
                 "interfaces": self.extract_interfaces,
                 "custom_fields": self.extract_custom_fields,
                 "region": self.extract_regions,
+                "cluster": self.extract_cluster,
+                "cluster_group": self.extract_cluster_group,
+                "cluster_type": self.extract_cluster_type,
             }
 
     def _pluralize(self, extracted_value):
@@ -719,6 +728,25 @@ def extract_regions(self, host):
 
         return regions
 
+    def extract_cluster(self, host):
+        try:
+            # cluster does not have a slug
+            return host["cluster"]["name"]
+        except Exception:
+            return
+
+    def extract_cluster_group(self, host):
+        try:
+            return self.clusters_group_lookup[host["cluster"]["id"]]
+        except Exception:
+            return
+
+    def extract_cluster_type(self, host):
+        try:
+            return self.clusters_type_lookup[host["cluster"]["id"]]
+        except Exception:
+            return
+
     def refresh_platforms_lookup(self):
         url = self.api_endpoint + "/api/dcim/platforms/?limit=0"
         platforms = self.get_resource_list(api_url=url)
@@ -791,6 +819,32 @@ def refresh_manufacturers_lookup(self):
             (manufacturer["id"], manufacturer["slug"]) for manufacturer in manufacturers
         )
 
+    def refresh_clusters_lookup(self):
+        url = self.api_endpoint + "/api/virtualization/clusters/?limit=0"
+        clusters = self.get_resource_list(api_url=url)
+
+        def get_cluster_type(cluster):
+            # Will fail if cluster does not have a type (required property so should always be true)
+            try:
+                return (cluster["id"], cluster["type"]["slug"])
+            except Exception:
+                return (cluster["id"], None)
+
+        def get_cluster_group(cluster):
+            # Will fail if cluster does not have a group (group is optional)
+            try:
+                return (cluster["id"], cluster["group"]["slug"])
+            except Exception:
+                return (cluster["id"], None)
+
+        self.clusters_type_lookup = dict(
+            filter(lambda x: x is not None, map(get_cluster_type, clusters))
+        )
+
+        self.clusters_group_lookup = dict(
+            filter(lambda x: x is not None, map(get_cluster_group, clusters))
+        )
+
     @property
     def lookup_processes(self):
         return [
@@ -802,6 +856,7 @@ def lookup_processes(self):
             self.refresh_platforms_lookup,
             self.refresh_device_types_lookup,
             self.refresh_manufacturers_lookup,
+            self.refresh_clusters_lookup,
         ]
 
     def refresh_lookups(self):

tests/integration/netbox-deploy.py

@@ -247,6 +247,7 @@
 ## Create Cluster Group
 cluster_groups = [{"name": "Test Cluster Group", "slug": "test-cluster-group"}]
 created_cluster_groups = nb.virtualization.cluster_groups.create(cluster_groups)
+test_cluster_group = nb.virtualization.cluster_groups.get(slug="test-cluster-group")
 
 ## Create Cluster Type
 cluster_types = [{"name": "Test Cluster Type", "slug": "test-cluster-type"}]
@@ -255,18 +256,25 @@
 
 ## Create Cluster
 clusters = [
-    {"name": "Test Cluster", "type": test_cluster_type.id, "site": test_site.id}
+    {
+        "name": "Test Cluster",
+        "type": test_cluster_type.id,
+        "group": test_cluster_group.id,
+        "site": test_site.id,
+    },
+    {"name": "Test Cluster 2", "type": test_cluster_type.id,},
 ]
 created_clusters = nb.virtualization.clusters.create(clusters)
 test_cluster = nb.virtualization.clusters.get(name="Test Cluster")
+test_cluster2 = nb.virtualization.clusters.get(name="Test Cluster 2")
 
 ## Create Virtual Machine
 virtual_machines = [
     {"name": "test100-vm", "cluster": test_cluster.id},
     {"name": "test101-vm", "cluster": test_cluster.id},
     {"name": "test102-vm", "cluster": test_cluster.id},
     {"name": "test103-vm", "cluster": test_cluster.id},
-    {"name": "test104-vm", "cluster": test_cluster.id},
+    {"name": "test104-vm", "cluster": test_cluster2.id},
 ]
 created_virtual_machines = nb.virtualization.virtual_machines.create(virtual_machines)
 test100_vm = nb.virtualization.virtual_machines.get(name="test100-vm")

tests/integration/targets/inventory/files/test-inventory-legacy.json

@@ -105,6 +105,9 @@
                 "tags": []
             },
             "test100-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -116,6 +119,9 @@
                 "tags": []
             },
             "test101-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -127,6 +133,9 @@
                 "tags": []
             },
             "test102-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -138,6 +147,9 @@
                 "tags": []
             },
             "test103-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -149,14 +161,10 @@
                 "tags": []
             },
             "test104-vm": {
+                "cluster": "Test Cluster 2",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
-                "regions": [
-                    "test-region",
-                    "parent-region"
-                ],
-                "sites": [
-                    "test-site"
-                ],
+                "regions": [],
                 "tags": []
             }
         }

tests/integration/targets/inventory/files/test-inventory-options.json

@@ -1,4 +1,17 @@
 {
+    "Test_Cluster": {
+        "hosts": [
+            "test100-vm",
+            "test101-vm",
+            "test102-vm",
+            "test103-vm"
+        ]
+    },
+    "Test_Cluster_2": {
+        "hosts": [
+            "test104-vm"
+        ]
+    },
     "Test_Rack": {
         "hosts": [
             "R1-Device"
@@ -71,6 +84,9 @@
                 "tags": []
             },
             "test100-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -80,6 +96,9 @@
                 "tags": []
             },
             "test101-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -89,6 +108,9 @@
                 "tags": []
             },
             "test102-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -98,6 +120,9 @@
                 "tags": []
             },
             "test103-vm": {
+                "cluster": "Test Cluster",
+                "cluster_group": "test-cluster-group",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
                 "regions": [
                     "test-region",
@@ -107,18 +132,18 @@
                 "tags": []
             },
             "test104-vm": {
+                "cluster": "Test Cluster 2",
+                "cluster_type": "test-cluster-type",
                 "custom_fields": {},
-                "regions": [
-                    "test-region",
-                    "parent-region"
-                ],
-                "site": "test-site",
+                "regions": [],
                 "tags": []
             }
         }
     },
     "all": {
         "children": [
+            "Test_Cluster",
+            "Test_Cluster_2",
             "Test_Rack",
             "cisco",
             "cisco_test",
@@ -128,6 +153,8 @@
             "nexus_parent",
             "other_region",
             "parent_region",
+            "test_cluster_group",
+            "test_cluster_type",
             "test_site2",
             "ungrouped"
         ]
@@ -179,6 +206,23 @@
             "test_region"
         ]
     },
+    "test_cluster_group": {
+        "hosts": [
+            "test100-vm",
+            "test101-vm",
+            "test102-vm",
+            "test103-vm"
+        ]
+    },
+    "test_cluster_type": {
+        "hosts": [
+            "test100-vm",
+            "test101-vm",
+            "test102-vm",
+            "test103-vm",
+            "test104-vm"
+        ]
+    },
     "test_region": {
         "children": [
             "test_site"
@@ -193,8 +237,7 @@
             "test100-vm",
             "test101-vm",
             "test102-vm",
-            "test103-vm",
-            "test104-vm"
+            "test103-vm"
         ]
     },
     "test_site2": {

tests/integration/targets/inventory/files/test-inventory-options.yml

@@ -26,6 +26,9 @@ group_by:
   - manufacturer
   - platform
   - region
+  - cluster
+  - cluster_group
+  - cluster_type
 
 query_filters: