Bugfix: Type for termination_a_type and circuits.circuittermination (#367)

Author: FragmentedPacket

plugins/module_utils/netbox_utils.py

@@ -137,7 +137,7 @@
     "circuit": "circuits",
     "circuit_type": "circuit_types",
     "circuit_termination": "circuit_terminations",
-    "circuit.circuittermination": "circuit_terminations",
+    "circuits.circuittermination": "circuit_terminations",
     "cluster": "clusters",
     "cluster_group": "cluster_groups",
     "cluster_type": "cluster_types",
@@ -257,7 +257,7 @@
     "circuit": set(["cid"]),
     "circuit_type": set(["slug"]),
     "circuit_termination": set(["circuit", "term_side"]),
-    "circuit.circuittermination": set(["circuit", "term_side"]),
+    "circuits.circuittermination": set(["circuit", "term_side"]),
     "cluster": set(["name", "type"]),
     "cluster_group": set(["slug"]),
     "cluster_type": set(["slug"]),
@@ -622,6 +622,12 @@ def _build_query_params(
         :params child(dict): This is used within `_find_ids` and passes the inner dictionary
         to build the appropriate `query_dict` for the parent
         """
+        # This is to change the parent key to use the proper ALLOWED_QUERY_PARAMS below for termination searches.
+        if parent == "termination_a" and module_data.get("termination_a_type"):
+            parent = module_data["termination_a_type"]
+        elif parent == "termination_b" and module_data.get("termination_b_type"):
+            parent = module_data["termination_b_type"]
+
         query_dict = dict()
         if user_query_params:
             query_params = set(user_query_params)

tests/integration/netbox-deploy.py

@@ -5,18 +5,40 @@
 __metaclass__ = type
 
 import os
+import sys
 import pynetbox
 
 # NOTE: If anything depends on specific versions of NetBox, can check INTEGRATION_TESTS in env
 # os.environ["INTEGRATION_TESTS"]
 
 
 # Set nb variable to connect to Netbox and use the veriable in future calls
-nb = pynetbox.api("http://localhost:32768", "0123456789abcdef0123456789abcdef01234567")
+nb_host = os.getenv("NETBOX_HOST", "http://localhost:32768")
+nb_token = os.getenv("NETBOX_TOKEN", "0123456789abcdef0123456789abcdef01234567")
+nb = pynetbox.api(nb_host, nb_token)
 version = float(nb.version)
 
-# Create tags used in future tests
+ERRORS = False
+
+
+def make_netbox_calls(endpoint, payload):
+    """Make the necessary calls to create endpoints, and pass any errors.
+
+    Args:
+        endpoint (obj): pynetbox endpoint object.
+        payload (list): List of endpoint objects.
+    """
+    try:
+        created = endpoint.create(payload)
+    except pynetbox.RequestError as e:
+        print(e.error)
+        ERRORS = True
+        return
+
+    return created
 
+
+# Create tags used in future tests
 if version >= 2.9:
     create_tags = nb.extras.tags.create(
         [
@@ -37,14 +59,14 @@
 
 ## Create TENANTS
 tenants = [{"name": "Test Tenant", "slug": "test-tenant"}]
-created_tenants = nb.tenancy.tenants.create(tenants)
+created_tenants = make_netbox_calls(nb.tenancy.tenants, tenants)
 ### Test Tenant to be used later on
 test_tenant = nb.tenancy.tenants.get(slug="test-tenant")
 
 
 ## Create TENANT GROUPS
 tenant_groups = [{"name": "Test Tenant Group", "slug": "test-tenant-group"}]
-created_tenant_groups = nb.tenancy.tenant_groups.create(tenant_groups)
+created_tenant_groups = make_netbox_calls(nb.tenancy.tenant_groups, tenant_groups)
 
 
 ## Create Regions
@@ -53,7 +75,7 @@
     {"name": "Parent Region", "slug": "parent-region"},
     {"name": "Other Region", "slug": "other-region"},
 ]
-created_regions = nb.dcim.regions.create(regions)
+created_regions = make_netbox_calls(nb.dcim.regions, regions)
 ### Region variables to be used later on
 parent_region = nb.dcim.regions.get(slug="parent-region")
 test_region = nb.dcim.regions.get(slug="test-region")
@@ -73,23 +95,23 @@
     },
     {"name": "Test Site2", "slug": "test-site2"},
 ]
-created_sites = nb.dcim.sites.create(sites)
+created_sites = make_netbox_calls(nb.dcim.sites, sites)
 ### Site variables to be used later on
 test_site = nb.dcim.sites.get(slug="test-site")
 test_site2 = nb.dcim.sites.get(slug="test-site2")
 
 
 ## Create VRFs
 vrfs = [{"name": "Test VRF", "rd": "1:1"}]
-created_vrfs = nb.ipam.vrfs.create(vrfs)
+created_vrfs = make_netbox_calls(nb.ipam.vrfs, vrfs)
 
 
 ## Create PREFIXES
 prefixes = [
     {"prefix": "192.168.100.0/24", "site": test_site2.id},
     {"prefix": "10.10.0.0/16"},
 ]
-created_prefixes = nb.ipam.prefixes.create(prefixes)
+created_prefixes = make_netbox_calls(nb.ipam.prefixes, prefixes)
 
 
 ## Create VLAN GROUPS
@@ -101,7 +123,7 @@
         "tenant": test_tenant.id,
     }
 ]
-created_vlan_groups = nb.ipam.vlan_groups.create(vlan_groups)
+created_vlan_groups = make_netbox_calls(nb.ipam.vlan_groups, vlan_groups)
 ## VLAN Group variables to be used later on
 test_vlan_group = nb.ipam.vlan_groups.get(slug="test-vlan-group")
 
@@ -119,12 +141,12 @@
         "group": test_vlan_group.id,
     },
 ]
-created_vlans = nb.ipam.vlans.create(vlans)
+created_vlans = make_netbox_calls(nb.ipam.vlans, vlans)
 
 
 ## Create IPAM Roles
 ipam_roles = [{"name": "Network of care", "slug": "network-of-care"}]
-create_ipam_roles = nb.ipam.roles.create(ipam_roles)
+create_ipam_roles = make_netbox_calls(nb.ipam.roles, ipam_roles)
 
 
 ## Create Manufacturers
@@ -133,7 +155,7 @@
     {"name": "Arista", "slug": "arista"},
     {"name": "Test Manufactuer", "slug": "test-manufacturer"},
 ]
-created_manufacturers = nb.dcim.manufacturers.create(manufacturers)
+created_manufacturers = make_netbox_calls(nb.dcim.manufacturers, manufacturers)
 ### Manufacturer variables to be used later on
 cisco_manu = nb.dcim.manufacturers.get(slug="cisco")
 arista_manu = nb.dcim.manufacturers.get(slug="arista")
@@ -169,7 +191,7 @@
         temp_dt.append(dt_type)
     device_types = temp_dt
 
-created_device_types = nb.dcim.device_types.create(device_types)
+created_device_types = make_netbox_calls(nb.dcim.device_types, device_types)
 ### Device type variables to be used later on
 cisco_test = nb.dcim.device_types.get(slug="cisco-test")
 arista_test = nb.dcim.device_types.get(slug="arista-test")
@@ -192,7 +214,7 @@
         "vm_role": True,
     },
 ]
-created_device_roles = nb.dcim.device_roles.create(device_roles)
+created_device_roles = make_netbox_calls(nb.dcim.device_roles, device_roles)
 ### Device role variables to be used later on
 core_switch = nb.dcim.device_roles.get(slug="core-switch")
 
@@ -202,15 +224,15 @@
     {"name": "Test Rack Group", "slug": "test-rack-group", "site": test_site.id},
     {"name": "Parent Rack Group", "slug": "parent-rack-group", "site": test_site.id},
 ]
-created_rack_groups = nb.dcim.rack_groups.create(rack_groups)
+created_rack_groups = make_netbox_calls(nb.dcim.rack_groups, rack_groups)
 
 ### Create Rack Group Parent relationship
 created_rack_groups[0].parent = created_rack_groups[1]
 created_rack_groups[0].save()
 
 ## Create Rack Roles
 rack_roles = [{"name": "Test Rack Role", "slug": "test-rack-role", "color": "4287f5"}]
-created_rack_roles = nb.dcim.rack_roles.create(rack_roles)
+created_rack_roles = make_netbox_calls(nb.dcim.rack_roles, rack_roles)
 
 ## Create Racks
 racks = [
@@ -221,7 +243,7 @@
     },
     {"name": "Test Rack", "site": test_site.id, "group": created_rack_groups[0].id},
 ]
-created_racks = nb.dcim.racks.create(racks)
+created_racks = make_netbox_calls(nb.dcim.racks, racks)
 test_rack = nb.dcim.racks.get(name="Test Rack")  # racks don't have slugs
 test_rack_site2 = nb.dcim.racks.get(name="Test Rack Site 2")
 
@@ -262,12 +284,12 @@
         "site": test_site.id,
     },
 ]
-created_devices = nb.dcim.devices.create(devices)
+created_devices = make_netbox_calls(nb.dcim.devices, devices)
 ### Device variables to be used later on
 test100 = nb.dcim.devices.get(name="test100")
 
 # Create VC, assign member, create initial interface
-created_vcs = nb.dcim.virtual_chassis.create({"name": "VC1", "master": 4})
+created_vcs = make_netbox_calls(nb.dcim.virtual_chassis, {"name": "VC1", "master": 4})
 nexus_child = nb.dcim.devices.get(5)
 nexus_child.update({"virtual_chassis": 1, "vc_position": 2})
 nexus = nb.dcim.devices.get(4)
@@ -276,14 +298,14 @@
     {"device": nexus.id, "name": "Ethernet1/1", "type": "1000base-t"},
     {"device": nexus_child.id, "name": "Ethernet2/1", "type": "1000base-t"},
 ]
-created_nexus_interfaces = nb.dcim.interfaces.create(nexus_interfaces)
+created_nexus_interfaces = make_netbox_calls(nb.dcim.interfaces, nexus_interfaces)
 
 ## Create Interfaces
 dev_interfaces = [
     {"name": "GigabitEthernet1", "device": test100.id, "type": "1000base-t"},
     {"name": "GigabitEthernet2", "device": test100.id, "type": "1000base-t"},
 ]
-created_interfaces = nb.dcim.interfaces.create(dev_interfaces)
+created_interfaces = make_netbox_calls(nb.dcim.interfaces, dev_interfaces)
 ## Interface variables to be used later on
 test100_gi1 = nb.dcim.interfaces.get(name="GigabitEthernet1", device_id=1)
 test100_gi2 = nb.dcim.interfaces.get(name="GigabitEthernet2", device_id=1)
@@ -305,21 +327,25 @@
             ip["assigned_object_type"] = "dcim.interface"
         temp_ips.append(ip)
 
-created_ip_addresses = nb.ipam.ip_addresses.create(ip_addresses)
+created_ip_addresses = make_netbox_calls(nb.ipam.ip_addresses, ip_addresses)
 
 
 ## Create RIRs
 rirs = [{"name": "Example RIR", "slug": "example-rir"}]
-created_rirs = nb.ipam.rirs.create(rirs)
+created_rirs = make_netbox_calls(nb.ipam.rirs, rirs)
 
 ## Create Cluster Group
 cluster_groups = [{"name": "Test Cluster Group", "slug": "test-cluster-group"}]
-created_cluster_groups = nb.virtualization.cluster_groups.create(cluster_groups)
+created_cluster_groups = make_netbox_calls(
+    nb.virtualization.cluster_groups, 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"}]
-created_cluster_types = nb.virtualization.cluster_types.create(cluster_types)
+created_cluster_types = make_netbox_calls(
+    nb.virtualization.cluster_types, cluster_types
+)
 test_cluster_type = nb.virtualization.cluster_types.get(slug="test-cluster-type")
 
 ## Create Cluster
@@ -332,7 +358,7 @@
     },
     {"name": "Test Cluster 2", "type": test_cluster_type.id,},
 ]
-created_clusters = nb.virtualization.clusters.create(clusters)
+created_clusters = make_netbox_calls(nb.virtualization.clusters, clusters)
 test_cluster = nb.virtualization.clusters.get(name="Test Cluster")
 test_cluster2 = nb.virtualization.clusters.get(name="Test Cluster 2")
 
@@ -345,7 +371,9 @@
     {"name": "test104-vm", "cluster": test_cluster2.id},
     {"name": "Test VM With Spaces", "cluster": test_cluster2.id},
 ]
-created_virtual_machines = nb.virtualization.virtual_machines.create(virtual_machines)
+created_virtual_machines = make_netbox_calls(
+    nb.virtualization.virtual_machines, virtual_machines
+)
 test100_vm = nb.virtualization.virtual_machines.get(name="test100-vm")
 test101_vm = nb.virtualization.virtual_machines.get(name="test101-vm")
 test_spaces_vm = nb.virtualization.virtual_machines.get(name="Test VM With Spaces")
@@ -368,8 +396,8 @@
     {"name": "Eth0", "virtual_machine": test_spaces_vm.id},
     {"name": "Eth1", "virtual_machine": test_spaces_vm.id},
 ]
-created_virtual_machines_intfs = nb.virtualization.interfaces.create(
-    virtual_machines_intfs
+created_virtual_machines_intfs = make_netbox_calls(
+    nb.virtualization.interfaces, virtual_machines_intfs
 )
 
 
@@ -391,21 +419,45 @@
         "protocol": "tcp",
     },
 ]
-created_services = nb.ipam.services.create(services)
+created_services = make_netbox_calls(nb.ipam.services, services)
 
 
 ## Create Circuit Provider
 providers = [{"name": "Test Provider", "slug": "test-provider"}]
-created_providers = nb.circuits.providers.create(providers)
+created_providers = make_netbox_calls(nb.circuits.providers, providers)
 test_provider = nb.circuits.providers.get(slug="test-provider")
 
 ## Create Circuit Type
 circuit_types = [{"name": "Test Circuit Type", "slug": "test-circuit-type"}]
-created_circuit_types = nb.circuits.circuit_types.create(circuit_types)
+created_circuit_types = make_netbox_calls(nb.circuits.circuit_types, circuit_types)
 test_circuit_type = nb.circuits.circuit_types.get(slug="test-circuit-type")
 
 ## Create Circuit
 circuits = [
-    {"cid": "Test Circuit", "provider": test_provider.id, "type": test_circuit_type.id}
+    {"cid": "Test Circuit", "provider": test_provider.id, "type": test_circuit_type.id},
+    {
+        "cid": "Test Circuit Two",
+        "provider": test_provider.id,
+        "type": test_circuit_type.id,
+    },
+]
+created_circuits = make_netbox_calls(nb.circuits.circuits, circuits)
+test_circuit_two = nb.circuits.circuits.get(cid="Test Circuit Two")
+
+## Create Circuit Termination
+circuit_terms = [
+    {
+        "circuit": test_circuit_two.id,
+        "term_side": "A",
+        "port_speed": 10000,
+        "site": test_site.id,
+    }
 ]
-created_circuits = nb.circuits.circuits.create(circuits)
+created_circuit_terms = make_netbox_calls(
+    nb.circuits.circuit_terminations, circuit_terms
+)
+
+if ERRORS:
+    sys.exit(
+        "Errors have occurred when creating objects, and should have been printed out. Check previous output."
+    )

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

@@ -156,3 +156,31 @@
       - test_five['cable']['termination_b_type'] == "dcim.consoleport"
       - test_five['cable']['termination_b_id'] == 1
       - test_five['msg'] == "cable dcim.consoleserverport Console Server Port <> dcim.consoleport Console Port created"
+
+- name: "CABLE 6: Circuits Termination as side A"
+  netbox.netbox.netbox_cable:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      termination_a_type: circuits.circuittermination
+      termination_a:
+        circuit: "Test Circuit Two"
+        term_side: "A"
+      termination_b_type: dcim.interface
+      termination_b:
+        device: "test100"
+        name: "GigabitEthernet2"
+    state: present
+  register: test_six
+
+- name: "CABLE 6: ASSERT - Circuits Termination as side A"
+  assert:
+    that:
+      - test_six is changed
+      - test_six['diff']['before']['state'] == "absent"
+      - test_six['diff']['after']['state'] == "present"
+      - test_six['cable']['termination_a_type'] == "circuits.circuittermination"
+      - test_six['cable']['termination_a_id'] == 1
+      - test_six['cable']['termination_b_type'] == "dcim.interface"
+      - test_six['cable']['termination_b_id'] == 4
+      - test_six['msg'] == "cable circuits.circuittermination 1 <> dcim.interface GigabitEthernet2 created"