New module: module_type (#887)

rodvand · web-flow · commit dcd867284336 · 2022-11-28T00:14:28.000+01:00
diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -45,6 +45,7 @@ action_groups:
     - netbox_l2vpn
     - netbox_location
     - netbox_manufacturer
+    - netbox_module_type
     - netbox_platform
     - netbox_power_feed
     - netbox_power_outlet
diff --git a/plugins/module_utils/netbox_dcim.py b/plugins/module_utils/netbox_dcim.py
@@ -31,6 +31,7 @@
 NB_INVENTORY_ITEM_ROLES = "inventory_item_roles"
 NB_LOCATIONS = "locations"
 NB_MANUFACTURERS = "manufacturers"
+NB_MODULE_TYPES = "module_types"
 NB_PLATFORMS = "platforms"
 NB_POWER_FEEDS = "power_feeds"
 NB_POWER_OUTLETS = "power_outlets"
diff --git a/plugins/module_utils/netbox_utils.py b/plugins/module_utils/netbox_utils.py
@@ -58,6 +58,7 @@
         "inventory_item_roles",
         "locations",
         "manufacturers",
+        "module_types",
         "platforms",
         "power_feeds",
         "power_outlets",
@@ -133,6 +134,7 @@
     l2vpn="name",
     location="slug",
     manufacturer="slug",
+    module_type="model",
     nat_inside="address",
     nat_outside="address",
     parent_contact_group="name",
@@ -315,6 +317,7 @@
     "l2vpns": "l2vpn",
     "locations": "location",
     "manufacturers": "manufacturer",
+    "module_types": "module_type",
     "platforms": "platform",
     "power_feeds": "power_feed",
     "power_outlets": "power_outlet",
@@ -419,6 +422,7 @@
     "l2vpn": set(["name"]),
     "lag": set(["name"]),
     "location": set(["slug"]),
+    "module_type": set(["model"]),
     "manufacturer": set(["slug"]),
     "master": set(["name"]),
     "nat_inside": set(["vrf", "address"]),
diff --git a/plugins/modules/netbox_module_type.py b/plugins/modules/netbox_module_type.py
@@ -0,0 +1,159 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2022, Martin Rødvand (@rodvand) <martin@rodvand.net>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = r"""
+---
+module: netbox_module_type
+short_description: Create, update or delete module types within NetBox
+description:
+  - Creates, updates or removes module types from NetBox
+notes:
+  - Tags should be defined as a YAML list
+  - This should be ran with connection C(local) and hosts C(localhost)
+author:
+  - Martin Rødvand (@rodvand)
+requirements:
+  - pynetbox
+version_added: '3.10.0'
+extends_documentation_fragment:
+  - netbox.netbox.common
+options:
+  data:
+    description:
+      - Defines the device type configuration
+    suboptions:
+      manufacturer:
+        description:
+          - The manufacturer of the module type
+        required: false
+        type: raw
+      model:
+        description:
+          - The model of the module type
+        required: true
+        type: raw      
+      part_number:
+        description:
+          - The part number of the module type
+        required: false
+        type: str      
+      comments:
+        description:
+          - Comments that may include additional information in regards to the module type
+        required: false
+        type: str
+      tags:
+        description:
+          - Any tags that the module type may need to be associated with
+        required: false
+        type: list
+        elements: raw
+      custom_fields:
+        description:
+          - must exist in NetBox
+        required: false
+        type: dict
+    required: true
+    type: dict
+"""
+
+EXAMPLES = r"""
+- name: "Test NetBox modules"
+  connection: local
+  hosts: localhost
+  gather_facts: False
+
+  tasks:
+    - name: Create module type within NetBox with only required information
+      netbox.netbox.netbox_module_type:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:          
+          model: ws-test-3750
+          manufacturer: Test Manufacturer
+        state: present
+
+    - name: Create module type within NetBox
+      netbox.netbox.netbox_module_type:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:          
+          model: ws-test-3750
+          manufacturer: Test Manufacturer
+          part_number: ws-3750g-v2          
+        state: present
+
+    - name: Delete module type within netbox
+      netbox.netbox.netbox_module_type:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          model: ws-test-3750
+        state: absent
+"""
+
+RETURN = r"""
+module_type:
+  description: Serialized object as created or already existent within NetBox
+  returned: success (when I(state=present))
+  type: dict
+msg:
+  description: Message indicating failure or info about what has been achieved
+  returned: always
+  type: str
+"""
+
+from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
+)
+from ansible_collections.netbox.netbox.plugins.module_utils.netbox_dcim import (
+    NetboxDcimModule,
+    NB_MODULE_TYPES,
+)
+from copy import deepcopy
+
+
+def main():
+    """
+    Main entry point for module execution
+    """
+    argument_spec = deepcopy(NETBOX_ARG_SPEC)
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    manufacturer=dict(required=False, type="raw"),
+                    model=dict(required=True, type="raw"),
+                    part_number=dict(required=False, type="str"),
+                    comments=dict(required=False, type="str"),
+                    tags=dict(required=False, type="list", elements="raw"),
+                    custom_fields=dict(required=False, type="dict"),
+                ),
+            ),
+        )
+    )
+
+    required_if = [
+        ("state", "present", ["model", "manufacturer"]),
+        ("state", "absent", ["model"]),
+    ]
+
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
+
+    netbox_device_type = NetboxDcimModule(module, NB_MODULE_TYPES)
+    netbox_device_type.run()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()
diff --git a/tests/integration/targets/v3.3/tasks/main.yml b/tests/integration/targets/v3.3/tasks/main.yml
@@ -254,4 +254,13 @@
       tags:
         - netbox_inventory_item_role
   tags:
-    - netbox_inventory_item_role
+    - netbox_inventory_item_role
+
+- name: "NETBOX_MODULE_TYPE TESTS"
+  include_tasks: 
+    file: "netbox_module_type.yml"
+    apply:
+      tags:
+        - netbox_module_type
+  tags:
+    - netbox_module_type
diff --git a/tests/integration/targets/v3.3/tasks/netbox_module_type.yml b/tests/integration/targets/v3.3/tasks/netbox_module_type.yml
@@ -0,0 +1,97 @@
+---
+##
+##
+### NETBOX_MODULE_TYPE
+##
+##
+- name: "MODULE_TYPE 1: Necessary info creation"
+  netbox.netbox.netbox_module_type:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:      
+      model: ws-test-3750
+      manufacturer: Test Manufacturer
+    state: present
+  register: test_one
+
+- name: "MODULE_TYPE 1: ASSERT - Necessary info creation"
+  assert:
+    that:
+      - test_one is changed
+      - test_one['diff']['before']['state'] == "absent"
+      - test_one['diff']['after']['state'] == "present"      
+      - test_one['module_type']['model'] == "ws-test-3750"
+      - test_one['module_type']['manufacturer'] == 3
+      - test_one['msg'] == "module_type ws-test-3750 created"
+
+- name: "MODULE_TYPE 2: Create duplicate"
+  netbox.netbox.netbox_module_type:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:      
+      model: "ws-test-3750"
+      manufacturer: Test Manufacturer
+    state: present
+  register: test_two
+
+- name: "MODULE_TYPE 2: ASSERT - Create duplicate"
+  assert:
+    that:
+      - not test_two['changed']      
+      - test_one['module_type']['model'] == "ws-test-3750"
+      - test_one['module_type']['manufacturer'] == 3
+      - test_two['msg'] == "module_type ws-test-3750 already exists"
+
+- name: "MODULE_TYPE 3: ASSERT - Update"
+  netbox.netbox.netbox_module_type:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:      
+      model: ws-test-3750
+      manufacturer: Test Manufacturer
+      part_number: ws-3750g-v2      
+    state: present
+  register: test_three
+
+- name: "MODULE_TYPE 3: ASSERT - Update"
+  assert:
+    that:
+      - test_three is changed      
+      - test_three['diff']['after']['part_number'] == "ws-3750g-v2"            
+      - test_three['module_type']['model'] == "ws-test-3750"
+      - test_three['module_type']['manufacturer'] == 3
+      - test_three['module_type']['part_number'] == "ws-3750g-v2"      
+      - test_three['msg'] == "module_type ws-test-3750 updated"
+
+- name: "MODULE_TYPE 4: ASSERT - Delete"
+  netbox.netbox.netbox_module_type:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      model: ws-test-3750
+    state: absent
+  register: test_four
+
+- name: "MODULE_TYPE 4: ASSERT - Delete"
+  assert:
+    that:
+      - test_four is changed
+      - test_four['diff']['before']['state'] == "present"
+      - test_four['diff']['after']['state'] == "absent"
+      - test_four['msg'] == "module_type ws-test-3750 deleted"
+
+- name: "MODULE_TYPE 5: ASSERT - Delete non existing"
+  netbox.netbox.netbox_module_type:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      model: "Test Module Type"
+    state: absent
+  register: test_five
+
+- name: "MODULE_TYPE 5: ASSERT - Delete non existing`"
+  assert:
+    that:
+      - not test_five['changed']
+      - test_five['module_type'] == None
+      - test_five['msg'] == "module_type Test Module Type already absent"
