Various 4.1 updates (#1316)

* Version check

* Logic

* Linting

* Fix filters

* Adjust for type/form_factor change in netbox_rack

* Adjust for rack type

* Fix sanity test

* Update test for virtual machine

* Update user test

* Adjust user group

* Adjust permission test

* Update netbox_token tests

* Update main.yml

* Add changelog

* Sanity

* pep8

Author: rodvand

changelogs/fragments/41_updates.yml

@@ -0,0 +1,3 @@
+minor_changes:
+      - Adjust tests for various modules
+      - Fix the form_factor option on netbox_rack

plugins/module_utils/netbox_dcim.py

@@ -125,6 +125,13 @@ def run(self):
 
         data = self.data
 
+        # Handle rack and form_factor
+        if endpoint_name == "rack":
+            if Version(self.full_version) >= Version("4.1.0"):
+                if "type" in data:
+                    data["form_factor"] = self._to_slug(data["type"])
+                    del data["type"]
+
         # Used for msg output
         if data.get("name"):
             name = data["name"]

plugins/module_utils/netbox_utils.py

@@ -1085,10 +1085,18 @@ def _build_query_params(
 
         elif parent == "rear_port_template" and self.endpoint == "front_port_templates":
             if isinstance(module_data.get("rear_port_template"), str):
-                rear_port_template = {
-                    "devicetype_id": module_data.get("device_type"),
-                    "name": module_data.get("rear_port_template"),
-                }
+                if self._version_check_greater(
+                    self.version, "4.0", greater_or_equal=True
+                ):
+                    rear_port_template = {
+                        "device_type_id": module_data.get("device_type"),
+                        "name": module_data.get("rear_port_template"),
+                    }
+                else:
+                    rear_port_template = {
+                        "devicetype_id": module_data.get("device_type"),
+                        "name": module_data.get("rear_port_template"),
+                    }
                 query_dict.update(rear_port_template)
 
         elif parent == "power_port" and self.endpoint == "power_outlets":
@@ -1104,10 +1112,18 @@ def _build_query_params(
             and self.endpoint == "power_outlet_templates"
         ):
             if isinstance(module_data.get("power_port_template"), str):
-                power_port_template = {
-                    "devicetype_id": module_data.get("device_type"),
-                    "name": module_data.get("power_port_template"),
-                }
+                if self._version_check_greater(
+                    self.version, "4.0", greater_or_equal=True
+                ):
+                    power_port_template = {
+                        "device_type_id": module_data.get("device_type"),
+                        "name": module_data.get("power_port_template"),
+                    }
+                else:
+                    power_port_template = {
+                        "devicetype_id": module_data.get("device_type"),
+                        "name": module_data.get("power_port_template"),
+                    }
                 query_dict.update(power_port_template)
         elif parent == "l2vpn_termination":
             query_param_mapping = {
@@ -1131,7 +1147,12 @@ def _build_query_params(
             )
         elif "_template" in parent:
             if query_dict.get("device_type"):
-                query_dict["devicetype_id"] = query_dict.pop("device_type")
+                if self._version_check_greater(
+                    self.version, "4.0", greater_or_equal=True
+                ):
+                    query_dict["device_type_id"] = query_dict.pop("device_type")
+                else:
+                    query_dict["devicetype_id"] = query_dict.pop("device_type")
 
         if not query_dict:
             provided_kwargs = child.keys() if child else module_data.keys()

tests/integration/targets/v4.1/tasks/main.yml

@@ -33,7 +33,13 @@
   ansible.builtin.include_tasks: netbox_tenant_group.yml
 
 - name: NETBOX_RACK TESTS
-  ansible.builtin.include_tasks: netbox_rack.yml
+  ansible.builtin.include_tasks:
+    file: netbox_rack.yml
+    apply:
+      tags:
+        - netbox_rack
+  tags:
+    - netbox_rack
 
 - name: NETBOX_RACK_ROLE TESTS
   ansible.builtin.include_tasks: netbox_rack_role.yml
@@ -84,7 +90,13 @@
   ansible.builtin.include_tasks: netbox_inventory_item.yml
 
 - name: NETBOX_VIRTUAL_MACHINE TESTS
-  ansible.builtin.include_tasks: netbox_virtual_machine.yml
+  ansible.builtin.include_tasks:
+    file: netbox_virtual_machine.yml
+    apply:
+      tags:
+        - netbox_virtual_machine
+  tags:
+    - netbox_virtual_machine
 
 - name: NETBOX_CLUSTER TESTS
   ansible.builtin.include_tasks: netbox_cluster.yml
@@ -158,17 +170,35 @@
 - name: NETBOX_VIRTUAL_CHASSIS TESTS
   ansible.builtin.include_tasks: netbox_virtual_chassis.yml
 
-- name: NETBOX_USER TESTS
-  ansible.builtin.include_tasks: netbox_user.yml
+- name: NETBOX_USER_TESTS
+  ansible.builtin.include_tasks:
+    file: netbox_user.yml
+    apply:
+      tags:
+        - netbox_user
+  tags:
+    - netbox_user
 
-- name: NETBOX_USER_GROUP TESTS
-  ansible.builtin.include_tasks: netbox_user_group.yml
+- name: NETBOX_USER_GROUP_TESTS
+  ansible.builtin.include_tasks:
+    file: netbox_user_group.yml
+    apply:
+      tags:
+        - netbox_user_group
+  tags:
+    - netbox_user_group
 
 - name: NETBOX_PERMISSION TESTS
   ansible.builtin.include_tasks: netbox_permission.yml
 
-- name: NETBOX_TOKEN TESTS
-  ansible.builtin.include_tasks: netbox_token.yml
+- name: NETBOX_TOKEN_TESTS
+  ansible.builtin.include_tasks:
+    file: netbox_token.yml
+    apply:
+      tags:
+        - netbox_token
+  tags:
+    - netbox_token
 
 # Module has to be updated for 3.3
 # - name: "NETBOX_CABLE TESTS"
@@ -337,7 +367,11 @@
     - netbox_config_template
 
 - name: NETBOX_VIRTUAL_DISK
-  ansible.builtin.include_tasks: netbox_virtual_disk.yml
+  ansible.builtin.include_tasks:
+    file: netbox_virtual_disk.yml
+    apply:
+      tags:
+        - netbox_virtual_disk
   tags:
     - netbox_virtual_disk
 

tests/integration/targets/v4.1/tasks/netbox_permission.yml

@@ -123,7 +123,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       username: TestUser
-      password: TestPassword
+      password: TestPassword2
       permissions:
         - Test Permission 2
     state: present

tests/integration/targets/v4.1/tasks/netbox_rack.yml

@@ -119,7 +119,7 @@
       - test_five['diff']['after']['status'] == "available"
       - test_five['diff']['after']['tenant'] == 1
       - test_five['diff']['after']['tags'][0] == 4
-      - test_five['diff']['after']['type'] == "2-post-frame"
+      - test_five['diff']['after']['form_factor'] == "2-post-frame"
       - test_five['diff']['after']['u_height'] == 48
       - test_five['diff']['after']['width'] == 23
       - test_five['rack']['name'] == "Test rack one"
@@ -136,7 +136,7 @@
       - test_five['rack']['status'] == "available"
       - test_five['rack']['tenant'] == 1
       - test_five['rack']['tags'][0] == 4
-      - test_five['rack']['type'] == "2-post-frame"
+      - test_five['rack']['form_factor'] == "2-post-frame"
       - test_five['rack']['u_height'] == 48
       - test_five['rack']['width'] == 23
       - test_five['msg'] == "rack Test rack one updated"
@@ -185,7 +185,7 @@
       - test_six['rack']['status'] == "available"
       - test_six['rack']['tenant'] == 1
       - test_six['rack']['tags'][0] == 4
-      - test_six['rack']['type'] == "2-post-frame"
+      - test_six['rack']['form_factor'] == "2-post-frame"
       - test_six['rack']['u_height'] == 48
       - test_six['rack']['width'] == 23
 

tests/integration/targets/v4.1/tasks/netbox_token.yml

@@ -10,7 +10,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       username: TestUser
-      password: TestPassword
+      password: TestPassword2
     state: present
 
 - name: "TOKEN 1: Necessary info creation"
@@ -48,30 +48,27 @@
       - not test_two['changed']
       - test_two['msg'] == "token ******** already exists"
 
-# TODO: https://github.com/netbox-community/netbox/issues/17279
-# TODO: A netbox bug is causing the key to change when updating tokens
-# TODO: just skip the update test for now
-# - name: "TOKEN 3: Update"
-#   netbox.netbox.netbox_token:
-#     netbox_url: http://localhost:32768
-#     netbox_token: "0123456789abcdef0123456789abcdef01234567"
-#     data:
-#       user: TestUser
-#       key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-#       description: The test token
-#       write_enabled: false
-#       expires: 2024-08-26T14:49:01.345000+00:00
-#     state: present
-#   register: test_three
-#
-# - name: "TOKEN 3: ASSERT - Update"
-#   ansible.builtin.assert:
-#     that:
-#       - test_three is changed
-#       - test_three['token']['description'] == "The test token"
-#       - test_three['token']['write_enabled'] == false
-#       - test_three['token']['expires'] == "2024-08-26T14:49:01.345000+00:00"
-#       - test_three['msg'] == "token ******** updated"
+- name: "TOKEN 3: Update"
+  netbox.netbox.netbox_token:
+    netbox_url: http://localhost:32768
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      user: TestUser
+      key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+      description: The test token
+      write_enabled: false
+      expires: 2024-08-26T14:49:01.345000+00:00
+    state: present
+  register: test_three
+
+- name: "TOKEN 3: ASSERT - Update"
+  ansible.builtin.assert:
+    that:
+      - test_three is changed
+      - test_three['token']['description'] == "The test token"
+      - test_three['token']['write_enabled'] == false
+      - test_three['token']['expires'] == "2024-08-26T14:49:01.345000+00:00"
+      - test_three['msg'] == "token ******** updated"
 
 - name: "TOKEN 4: Delete"
   netbox.netbox.netbox_token:

tests/integration/targets/v4.1/tasks/netbox_user.yml

@@ -10,7 +10,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       username: TestUser
-      password: TestPassword
+      password: TestPassword1
     state: present
   register: test_one
 
@@ -48,7 +48,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       username: TestUser
-      password: TestPassword
+      password: TestPassword1
       email: test@user.com
       first_name: Test
       last_name: User

tests/integration/targets/v4.1/tasks/netbox_user_group.yml

@@ -81,7 +81,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       username: TestUser
-      password: TestPassword
+      password: TestPassword2
       groups:
         - Test User Group
     state: present

tests/integration/targets/v4.1/tasks/netbox_virtual_machine.yml

@@ -49,6 +49,7 @@
     data:
       name: Test VM One
       cluster: Test Cluster
+      serial: 12345678
       vcpus: 8.5
       memory: 8
       status: Planned
@@ -66,13 +67,15 @@
       - test_three['diff']['after']['memory'] == 8
       - test_three['diff']['after']['status'] == "planned"
       - test_three['diff']['after']['role'] == 2
+      - test_three['diff']['after']['serial'] == "12345678"
       - test_three['diff']['after']['tags'][0] == 4
       - test_three['virtual_machine']['name'] == "Test VM One"
       - test_three['virtual_machine']['cluster'] == 1
       - test_three['virtual_machine']['vcpus'] == 8.5
       - test_three['virtual_machine']['memory'] == 8
       - test_three['virtual_machine']['status'] == "planned"
       - test_three['virtual_machine']['role'] == 2
+      - test_three['virtual_machine']['serial'] == "12345678"
       - test_three['virtual_machine']['tags'][0] == 4
       - test_three['msg'] == "virtual_machine Test VM One updated"