[Feature]: Adds the ability to assign a role to an inventory item via the netbox_inventory_item module (#1050)

aaron-iles · web-flow · commit f55f5671d041 · 2023-08-18T09:16:10.000+02:00
* 981 added ability to assign inventory item role at creation of inventory item
* adding integration tests for v3.3 and v3.4
diff --git a/plugins/module_utils/netbox_utils.py b/plugins/module_utils/netbox_utils.py
@@ -226,6 +226,7 @@
     "interface_a": "interfaces",
     "interface_b": "interfaces",
     "interface_template": "interface_templates",
+    "inventory_item_role": "inventory_item_roles",
     "ip_addresses": "ip_addresses",
     "ipaddresses": "ip_addresses",
     "location": "locations",
@@ -562,6 +563,7 @@
     "cluster_group": "group",
     "contact_group": "group",
     "fhrp_group": "group",
+    "inventory_item_role": "role",
     "parent_contact_group": "parent",
     "parent_location": "parent",
     "parent_interface": "parent",
diff --git a/plugins/modules/netbox_inventory_item.py b/plugins/modules/netbox_inventory_item.py
@@ -94,6 +94,11 @@
         required: false
         type: dict
         version_added: "3.4.0"
+      inventory_item_role:
+        description:
+          - Set the inventory item role
+        required: false
+        type: raw
     required: true
 """
 
@@ -124,6 +129,7 @@
           serial: "1234"
           asset_tag: "1234"
           description: "New SFP"
+          inventory_item_role: NIC
         state: present
         
     - name: Create inventory item with parent
@@ -193,6 +199,7 @@ def main():
                     discovered=dict(required=False, type="bool", default=False),
                     tags=dict(required=False, type="list", elements="raw"),
                     custom_fields=dict(required=False, type="dict"),
+                    inventory_item_role=dict(required=False, type="raw"),
                 ),
             ),
         )
diff --git a/tests/integration/targets/v3.3/tasks/netbox_inventory_item.yml b/tests/integration/targets/v3.3/tasks/netbox_inventory_item.yml
@@ -15,14 +15,14 @@
   register: test_one
 
 - name: "INVENTORY_ITEM 1: ASSERT - Necessary info creation"
-  assert:
+  ansible.builtin.assert:
     that:
       - test_one is changed
-      - test_one['diff']['before']['state'] == "absent"
-      - test_one['diff']['after']['state'] == "present"
-      - test_one['inventory_item']['name'] == "10G-SFP+"
-      - test_one['inventory_item']['device'] == 1
-      - test_one['msg'] == "inventory_item 10G-SFP+ created"
+      - test_one.diff.before.state == "absent"
+      - test_one.diff.after.state == "present"
+      - test_one.inventory_item.name == "10G-SFP+"
+      - test_one.inventory_item.device == 1
+      - test_one.msg == "inventory_item 10G-SFP+ created"
 
 - name: "INVENTORY_ITEM 2: Create duplicate"
   netbox.netbox.netbox_inventory_item:
@@ -35,14 +35,14 @@
   register: test_two
 
 - name: "INVENTORY_ITEM 2: ASSERT - Create duplicate"
-  assert:
+  ansible.builtin.assert:
     that:
-      - not test_two['changed']
-      - test_two['inventory_item']['name'] == "10G-SFP+"
-      - test_two['inventory_item']['device'] == 1
-      - test_two['msg'] == "inventory_item 10G-SFP+ already exists"
+      - not test_two.changed
+      - test_two.inventory_item.name == "10G-SFP+"
+      - test_two.inventory_item.device == 1
+      - test_two.msg == "inventory_item 10G-SFP+ already exists"
 
-- name: "INVENTORY_ITEM 3: ASSERT - Update"
+- name: "INVENTORY_ITEM 3: Update properties"
   netbox.netbox.netbox_inventory_item:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -61,28 +61,28 @@
   register: test_three
 
 - name: "INVENTORY_ITEM 3: ASSERT - Updated"
-  assert:
+  ansible.builtin.assert:
     that:
       - test_three is changed
-      - test_three['diff']['after']['asset_tag'] == "1234"
-      - test_three['diff']['after']['serial'] == "1234"
-      - test_three['diff']['after']['description'] == "New SFP"
-      - test_three['diff']['after']['manufacturer'] == 1
-      - test_three['diff']['after']['part_id'] == "10G-SFP+"
-      - test_three['diff']['after']['tags'][0] == 4
-      - test_three['diff']['after']['discovered'] == True
-      - test_three['inventory_item']['name'] == "10G-SFP+"
-      - test_three['inventory_item']['device'] == 1
-      - test_three['inventory_item']['asset_tag'] == "1234"
-      - test_three['inventory_item']['serial'] == "1234"
-      - test_three['inventory_item']['description'] == "New SFP"
-      - test_three['inventory_item']['manufacturer'] == 1
-      - test_three['inventory_item']['part_id'] == "10G-SFP+"
-      - test_three['inventory_item']['tags'][0] == 4
-      - test_three['inventory_item']['discovered'] == True
-      - test_three['msg'] == "inventory_item 10G-SFP+ updated"
+      - test_three.diff.after.asset_tag == "1234"
+      - test_three.diff.after.serial == "1234"
+      - test_three.diff.after.description == "New SFP"
+      - test_three.diff.after.manufacturer == 1
+      - test_three.diff.after.part_id == "10G-SFP+"
+      - test_three.diff.after.tags[0] == 4
+      - test_three.diff.after.discovered == True
+      - test_three.inventory_item.name == "10G-SFP+"
+      - test_three.inventory_item.device == 1
+      - test_three.inventory_item.asset_tag == "1234"
+      - test_three.inventory_item.serial == "1234"
+      - test_three.inventory_item.description == "New SFP"
+      - test_three.inventory_item.manufacturer == 1
+      - test_three.inventory_item.part_id == "10G-SFP+"
+      - test_three.inventory_item.tags[0] == 4
+      - test_three.inventory_item.discovered == True
+      - test_three.msg == "inventory_item 10G-SFP+ updated"
 
-- name: "INVENTORY_ITEM 4: ASSERT - Delete"
+- name: "INVENTORY_ITEM 4: Delete inventory item"
   netbox.netbox.netbox_inventory_item:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -93,15 +93,65 @@
   register: test_four
 
 - name: "INVENTORY_ITEM 4: ASSERT - Delete"
-  assert:
+  ansible.builtin.assert:
     that:
       - test_four is changed
-      - test_four['inventory_item']['name'] == "10G-SFP+"
-      - test_four['inventory_item']['device'] == 1
-      - test_four['inventory_item']['asset_tag'] == "1234"
-      - test_four['inventory_item']['serial'] == "1234"
-      - test_four['inventory_item']['description'] == "New SFP"
-      - test_four['inventory_item']['manufacturer'] == 1
-      - test_four['inventory_item']['part_id'] == "10G-SFP+"
-      - test_four['inventory_item']['tags'][0] == 4
-      - test_four['msg'] == "inventory_item 10G-SFP+ deleted"
+      - test_four.inventory_item.name == "10G-SFP+"
+      - test_four.inventory_item.device == 1
+      - test_four.inventory_item.asset_tag == "1234"
+      - test_four.inventory_item.serial == "1234"
+      - test_four.inventory_item.description == "New SFP"
+      - test_four.inventory_item.manufacturer == 1
+      - test_four.inventory_item.part_id == "10G-SFP+"
+      - test_four.inventory_item.tags[0] == 4
+      - test_four.msg == "inventory_item 10G-SFP+ deleted"
+
+- name: "INVENTORY_ITEM 5: PREWORK - Create inventory item role"
+  netbox.netbox.netbox_inventory_item_role:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Processor
+      color: FFFFFF
+    state: present
+  register: test_five_prework
+
+- name: "INVENTORY_ITEM 5: Create inventory item with role"
+  netbox.netbox.netbox_inventory_item:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      device: test100
+      name: test_processor
+      inventory_item_role: Processor
+    state: present
+  register: test_five
+
+- name: "INVENTORY_ITEM 5: ASSERT - Inventory item creation with role"
+  ansible.builtin.assert:
+    that:
+      - test_five is changed
+      - test_five.diff.before.state == "absent"
+      - test_five.diff.after.state == "present"
+      - test_five.inventory_item.name == "test_processor"
+      - test_five.inventory_item.role == test_five_prework.inventory_item_role.id
+      - test_five.inventory_item.device == 1
+      - test_five.msg == "inventory_item test_processor created"
+
+- name: "INVENTORY_ITEM 6: Create inventory item with missing role"
+  netbox.netbox.netbox_inventory_item:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      device: test100
+      name: test_processor
+      inventory_item_role: Foo
+    state: present
+  ignore_errors: true
+  register: test_six
+
+- name: "INVENTORY_ITEM 6: ASSERT - Inventory item creation with missing role"
+  ansible.builtin.assert:
+    that:
+      - test_six.failed
+      - test_six.msg == "Could not resolve id of inventory_item_role: Foo"
diff --git a/tests/integration/targets/v3.4/tasks/netbox_inventory_item.yml b/tests/integration/targets/v3.4/tasks/netbox_inventory_item.yml
@@ -15,14 +15,14 @@
   register: test_one
 
 - name: "INVENTORY_ITEM 1: ASSERT - Necessary info creation"
-  assert:
+  ansible.builtin.assert:
     that:
       - test_one is changed
-      - test_one['diff']['before']['state'] == "absent"
-      - test_one['diff']['after']['state'] == "present"
-      - test_one['inventory_item']['name'] == "10G-SFP+"
-      - test_one['inventory_item']['device'] == 1
-      - test_one['msg'] == "inventory_item 10G-SFP+ created"
+      - test_one.diff.before.state == "absent"
+      - test_one.diff.after.state == "present"
+      - test_one.inventory_item.name == "10G-SFP+"
+      - test_one.inventory_item.device == 1
+      - test_one.msg == "inventory_item 10G-SFP+ created"
 
 - name: "INVENTORY_ITEM 2: Create duplicate"
   netbox.netbox.netbox_inventory_item:
@@ -35,14 +35,14 @@
   register: test_two
 
 - name: "INVENTORY_ITEM 2: ASSERT - Create duplicate"
-  assert:
+  ansible.builtin.assert:
     that:
-      - not test_two['changed']
-      - test_two['inventory_item']['name'] == "10G-SFP+"
-      - test_two['inventory_item']['device'] == 1
-      - test_two['msg'] == "inventory_item 10G-SFP+ already exists"
+      - not test_two.changed
+      - test_two.inventory_item.name == "10G-SFP+"
+      - test_two.inventory_item.device == 1
+      - test_two.msg == "inventory_item 10G-SFP+ already exists"
 
-- name: "INVENTORY_ITEM 3: ASSERT - Update"
+- name: "INVENTORY_ITEM 3: Update properties"
   netbox.netbox.netbox_inventory_item:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -61,28 +61,28 @@
   register: test_three
 
 - name: "INVENTORY_ITEM 3: ASSERT - Updated"
-  assert:
+  ansible.builtin.assert:
     that:
       - test_three is changed
-      - test_three['diff']['after']['asset_tag'] == "1234"
-      - test_three['diff']['after']['serial'] == "1234"
-      - test_three['diff']['after']['description'] == "New SFP"
-      - test_three['diff']['after']['manufacturer'] == 1
-      - test_three['diff']['after']['part_id'] == "10G-SFP+"
-      - test_three['diff']['after']['tags'][0] == 4
-      - test_three['diff']['after']['discovered'] == True
-      - test_three['inventory_item']['name'] == "10G-SFP+"
-      - test_three['inventory_item']['device'] == 1
-      - test_three['inventory_item']['asset_tag'] == "1234"
-      - test_three['inventory_item']['serial'] == "1234"
-      - test_three['inventory_item']['description'] == "New SFP"
-      - test_three['inventory_item']['manufacturer'] == 1
-      - test_three['inventory_item']['part_id'] == "10G-SFP+"
-      - test_three['inventory_item']['tags'][0] == 4
-      - test_three['inventory_item']['discovered'] == True
-      - test_three['msg'] == "inventory_item 10G-SFP+ updated"
+      - test_three.diff.after.asset_tag == "1234"
+      - test_three.diff.after.serial == "1234"
+      - test_three.diff.after.description == "New SFP"
+      - test_three.diff.after.manufacturer == 1
+      - test_three.diff.after.part_id == "10G-SFP+"
+      - test_three.diff.after.tags[0] == 4
+      - test_three.diff.after.discovered == True
+      - test_three.inventory_item.name == "10G-SFP+"
+      - test_three.inventory_item.device == 1
+      - test_three.inventory_item.asset_tag == "1234"
+      - test_three.inventory_item.serial == "1234"
+      - test_three.inventory_item.description == "New SFP"
+      - test_three.inventory_item.manufacturer == 1
+      - test_three.inventory_item.part_id == "10G-SFP+"
+      - test_three.inventory_item.tags[0] == 4
+      - test_three.inventory_item.discovered == True
+      - test_three.msg == "inventory_item 10G-SFP+ updated"
 
-- name: "INVENTORY_ITEM 4: ASSERT - Delete"
+- name: "INVENTORY_ITEM 4: Delete inventory item"
   netbox.netbox.netbox_inventory_item:
     netbox_url: http://localhost:32768
     netbox_token: 0123456789abcdef0123456789abcdef01234567
@@ -93,15 +93,65 @@
   register: test_four
 
 - name: "INVENTORY_ITEM 4: ASSERT - Delete"
-  assert:
+  ansible.builtin.assert:
     that:
       - test_four is changed
-      - test_four['inventory_item']['name'] == "10G-SFP+"
-      - test_four['inventory_item']['device'] == 1
-      - test_four['inventory_item']['asset_tag'] == "1234"
-      - test_four['inventory_item']['serial'] == "1234"
-      - test_four['inventory_item']['description'] == "New SFP"
-      - test_four['inventory_item']['manufacturer'] == 1
-      - test_four['inventory_item']['part_id'] == "10G-SFP+"
-      - test_four['inventory_item']['tags'][0] == 4
-      - test_four['msg'] == "inventory_item 10G-SFP+ deleted"
+      - test_four.inventory_item.name == "10G-SFP+"
+      - test_four.inventory_item.device == 1
+      - test_four.inventory_item.asset_tag == "1234"
+      - test_four.inventory_item.serial == "1234"
+      - test_four.inventory_item.description == "New SFP"
+      - test_four.inventory_item.manufacturer == 1
+      - test_four.inventory_item.part_id == "10G-SFP+"
+      - test_four.inventory_item.tags[0] == 4
+      - test_four.msg == "inventory_item 10G-SFP+ deleted"
+
+- name: "INVENTORY_ITEM 5: PREWORK - Create inventory item role"
+  netbox.netbox.netbox_inventory_item_role:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Processor
+      color: FFFFFF
+    state: present
+  register: test_five_prework
+
+- name: "INVENTORY_ITEM 5: Create inventory item with role"
+  netbox.netbox.netbox_inventory_item:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      device: test100
+      name: test_processor
+      inventory_item_role: Processor
+    state: present
+  register: test_five
+
+- name: "INVENTORY_ITEM 5: ASSERT - Inventory item creation with role"
+  ansible.builtin.assert:
+    that:
+      - test_five is changed
+      - test_five.diff.before.state == "absent"
+      - test_five.diff.after.state == "present"
+      - test_five.inventory_item.name == "test_processor"
+      - test_five.inventory_item.role == test_five_prework.inventory_item_role.id
+      - test_five.inventory_item.device == 1
+      - test_five.msg == "inventory_item test_processor created"
+
+- name: "INVENTORY_ITEM 6: Create inventory item with missing role"
+  netbox.netbox.netbox_inventory_item:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      device: test100
+      name: test_processor
+      inventory_item_role: Foo
+    state: present
+  ignore_errors: true
+  register: test_six
+
+- name: "INVENTORY_ITEM 6: ASSERT - Inventory item creation with missing role"
+  ansible.builtin.assert:
+    that:
+      - test_six.failed
+      - test_six.msg == "Could not resolve id of inventory_item_role: Foo"
diff --git a/tests/integration/targets/v3.5/tasks/netbox_inventory_item.yml b/tests/integration/targets/v3.5/tasks/netbox_inventory_item.yml
