Enchancement: add parent_tenant_group/description suboption for netbox_tenant_group (#460)

Author: pkorovin

plugins/module_utils/netbox_utils.py

@@ -105,6 +105,7 @@
     nat_inside="address",
     nat_outside="address",
     parent_region="slug",
+    parent_tenant_group="slug",
     power_panel="name",
     power_port="name",
     platform="slug",
@@ -170,6 +171,7 @@
     "nat_outside": "ip_addresses",
     "platform": "platforms",
     "parent_region": "regions",
+    "parent_tenant_group": "tenant_groups",
     "power_panel": "power_panels",
     "power_port": "power_ports",
     "prefix_role": "roles",
@@ -299,6 +301,7 @@
     "master": set(["name"]),
     "nat_inside": set(["vrf", "address"]),
     "parent_region": set(["slug"]),
+    "parent_tenant_group": set(["slug"]),
     "platform": set(["slug"]),
     "power_feed": set(["name", "power_panel"]),
     "power_outlet": set(["name", "device"]),
@@ -388,6 +391,7 @@
     "cluster_type": "type",
     "cluster_group": "group",
     "parent_region": "parent",
+    "parent_tenant_group": "parent",
     "prefix_role": "role",
     "rack_group": "group",
     "rack_role": "role",

plugins/modules/netbox_tenant_group.py

@@ -53,6 +53,16 @@
           - URL-friendly unique shorthand
         required: false
         type: str
+      parent_tenant_group:
+        description:
+          - Slug of the parent tenant group
+        required: false
+        type: str
+      description:
+        description:
+          - The description of the tenant group
+        required: false
+        type: str
     required: true
   state:
     description:
@@ -137,6 +147,8 @@ def main():
                 options=dict(
                     name=dict(required=True, type="str"),
                     slug=dict(required=False, type="str"),
+                    parent_tenant_group=dict(required=False, type="str"),
+                    description=dict(required=False, type="str"),
                 ),
             ),
         )

tests/integration/targets/latest/tasks/netbox_tenant_group.yml

@@ -55,7 +55,7 @@
       - test_three['diff']['after']['state'] == "absent"
       - test_three['msg'] == "tenant_group Test Tenant Group Two deleted"
 
-- name: "4 - Test another tenant group creation"
+- name: "4 - Test tenant group creation with custom slug"
   netbox.netbox.netbox_tenant_group:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -73,3 +73,57 @@
       - test_four['tenant_group']['name'] == "Test Tenant Group ABC"
       - test_four['tenant_group']['slug'] == "test_tenant_group_four"
       - test_four['msg'] == "tenant_group Test Tenant Group ABC created"
+
+- name: "5 - Test child tenant group creation"
+  netbox.netbox.netbox_tenant_group:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: "Child Test Tenant Group"
+      parent_tenant_group: "{{ test_four.tenant_group.slug }}"
+  register: test_five
+
+- name: "5 - ASSERT"
+  assert:
+    that:
+      - test_five is changed
+      - test_five['diff']['before']['state'] == "absent"
+      - test_five['diff']['after']['state'] == "present"
+      - test_five['tenant_group']['name'] == "Child Test Tenant Group"
+      - test_five['tenant_group']['parent'] == {{ test_four.tenant_group.id }}
+      - test_five['msg'] == "tenant_group Child Test Tenant Group created"
+
+- name: "6 - Test child tenant group deletion"
+  netbox.netbox.netbox_tenant_group:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: "Child Test Tenant Group"
+    state: "absent"
+  register: test_six
+
+- name: "6 - ASSERT"
+  assert:
+    that:
+      - test_six is changed
+      - test_six['diff']['before']['state'] == "present"
+      - test_six['diff']['after']['state'] == "absent"
+      - test_six['msg'] == "tenant_group Child Test Tenant Group deleted"
+
+- name: "7 - Test deletion of the tenant group with custom slug"
+  netbox.netbox.netbox_tenant_group:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: "Test Tenant Group ABC"
+      slug: "test_tenant_group_four"
+    state: "absent"
+  register: test_seven
+
+- name: "7 - ASSERT"
+  assert:
+    that:
+      - test_seven is changed
+      - test_seven['diff']['before']['state'] == "present"
+      - test_seven['diff']['after']['state'] == "absent"
+      - test_seven['msg'] == "tenant_group Test Tenant Group ABC deleted"

tests/integration/targets/v2.9/tasks/netbox_tenant_group.yml

@@ -55,7 +55,7 @@
       - test_three['diff']['after']['state'] == "absent"
       - test_three['msg'] == "tenant_group Test Tenant Group Two deleted"
 
-- name: "4 - Test another tenant group creation"
+- name: "4 - Test tenant group creation with custom slug"
   netbox.netbox.netbox_tenant_group:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -73,3 +73,57 @@
       - test_four['tenant_group']['name'] == "Test Tenant Group ABC"
       - test_four['tenant_group']['slug'] == "test_tenant_group_four"
       - test_four['msg'] == "tenant_group Test Tenant Group ABC created"
+
+- name: "5 - Test child tenant group creation"
+  netbox.netbox.netbox_tenant_group:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: "Child Test Tenant Group"
+      parent_tenant_group: "{{ test_four.tenant_group.slug }}"
+  register: test_five
+
+- name: "5 - ASSERT"
+  assert:
+    that:
+      - test_five is changed
+      - test_five['diff']['before']['state'] == "absent"
+      - test_five['diff']['after']['state'] == "present"
+      - test_five['tenant_group']['name'] == "Child Test Tenant Group"
+      - test_five['tenant_group']['parent'] == {{ test_four.tenant_group.id }}
+      - test_five['msg'] == "tenant_group Child Test Tenant Group created"
+
+- name: "6 - Test child tenant group deletion"
+  netbox.netbox.netbox_tenant_group:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: "Child Test Tenant Group"
+    state: "absent"
+  register: test_six
+
+- name: "6 - ASSERT"
+  assert:
+    that:
+      - test_six is changed
+      - test_six['diff']['before']['state'] == "present"
+      - test_six['diff']['after']['state'] == "absent"
+      - test_six['msg'] == "tenant_group Child Test Tenant Group deleted"
+
+- name: "7 - Test deletion of the tenant group with custom slug"
+  netbox.netbox.netbox_tenant_group:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: "Test Tenant Group ABC"
+      slug: "test_tenant_group_four"
+    state: "absent"
+  register: test_seven
+
+- name: "7 - ASSERT"
+  assert:
+    that:
+      - test_seven is changed
+      - test_seven['diff']['before']['state'] == "present"
+      - test_seven['diff']['after']['state'] == "absent"
+      - test_seven['msg'] == "tenant_group Test Tenant Group ABC deleted"