Skip to content

Fix two idempotency issues when updating VMs. #859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 7, 2022
Merged

Fix two idempotency issues when updating VMs. #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89b5223
fix: make _version_check_greater return type consistent values
bvergnaud Nov 2, 2022
380e0b2
fix: typo in form_factor error message
bvergnaud Nov 2, 2022
f3979df
fix: make netbox_virtual_machine updates idempotent on netbox v2.10+
bvergnaud Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 27 additions & 11 deletions plugins/module_utils/netbox_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,6 +676,8 @@ def _version_check_greater(self, greater, lesser, greater_or_equal=False):
elif g_major == l_major and g_minor > l_minor:
return True

return False

def _connect_netbox_api(self, url, token, ssl_verify, cert):
try:
session = requests.Session()
Expand Down Expand Up @@ -1255,12 +1257,28 @@ def _update_netbox_object(self, data):
"""
serialized_nb_obj = self.nb_object.serialize()
updated_obj = serialized_nb_obj.copy()

if serialized_nb_obj.get("custom_fields"):
serialized_nb_obj["custom_fields"] = {
key: value
for key, value in serialized_nb_obj["custom_fields"].items()
if value is not None
}

if updated_obj.get("custom_fields"):
updated_obj["custom_fields"] = {
key: value
for key, value in updated_obj["custom_fields"].items()
if value is not None
}

updated_obj.update(data)

if serialized_nb_obj.get("tags") and data.get("tags"):
serialized_nb_obj["tags"] = set(serialized_nb_obj["tags"])
updated_obj["tags"] = set(data["tags"])

# Ensure idempotency for site and virtual machine on version pre-3.0
# Ensure idempotency for site on older netbox versions
version_pre_30 = self._version_check_greater("3.0", self.version)
if (
serialized_nb_obj.get("latitude")
Expand All @@ -1275,15 +1293,13 @@ def _update_netbox_object(self, data):
):
updated_obj["longitude"] = str(data["longitude"])

if serialized_nb_obj.get("vcpus") and data.get("vcpus") and version_pre_30:
updated_obj["vcpus"] = "{0:.2f}".format(data["vcpus"])

if serialized_nb_obj.get("custom_fields"):
serialized_nb_obj["custom_fields"] = {
key: value
for key, value in serialized_nb_obj["custom_fields"].items()
if value is not None
}
# Ensure idempotency for virtual machine on older netbox versions
version_pre_211 = self._version_check_greater("2.11", self.version)
if serialized_nb_obj.get("vcpus") and data.get("vcpus"):
if version_pre_211:
updated_obj["vcpus"] = int(data["vcpus"])
else:
updated_obj["vcpus"] = float(data["vcpus"])

if serialized_nb_obj == updated_obj:
return serialized_nb_obj, None
Expand All @@ -1296,7 +1312,7 @@ def _update_netbox_object(self, data):
data_after[key] = updated_obj[key]
except KeyError:
if key == "form_factor":
msg = "form_factor is not valid for NetBox 2.7 onword. Please use the type key instead."
msg = "form_factor is not valid for NetBox 2.7 onward. Please use the type key instead."
else:
msg = (
"%s does not exist on existing object. Check to make sure valid field."
Expand Down
53 changes: 41 additions & 12 deletions tests/integration/targets/v3.1/tasks/netbox_virtual_machine.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,53 @@
- test_three['virtual_machine']['tags'][0] == 4
- test_three['msg'] == "virtual_machine Test VM One updated"

- name: "VIRTUAL_MACHINE 4: Delete"
- name: "VIRTUAL_MACHINE 4: Test idempotence"
netbox.netbox.netbox_virtual_machine:
netbox_url: http://localhost:32768
netbox_token: 0123456789abcdef0123456789abcdef01234567
data:
name: "Test VM One"
cluster: "Test Cluster"
vcpus: 8.5
memory: 8
status: "Planned"
virtual_machine_role: "Test VM Role"
tags:
- "Schnozzberry"
state: present
register: test_four_idempotence

- name: "VIRTUAL_MACHINE 4: ASSERT - Not changed"
assert:
that:
- test_four_idempotence is not changed
- test_four_idempotence['virtual_machine']['name'] == "Test VM One"
- test_four_idempotence['virtual_machine']['cluster'] == 1
- test_four_idempotence['virtual_machine']['vcpus'] == 8.5
- test_four_idempotence['virtual_machine']['memory'] == 8
- test_four_idempotence['virtual_machine']['status'] == "planned"
- test_four_idempotence['virtual_machine']['role'] == 2
- test_four_idempotence['virtual_machine']['tags'][0] == 4
- test_four_idempotence['msg'] == "virtual_machine Test VM One already exists"

- name: "VIRTUAL_MACHINE 5: Delete"
netbox.netbox.netbox_virtual_machine:
netbox_url: http://localhost:32768
netbox_token: 0123456789abcdef0123456789abcdef01234567
data:
name: "Test VM One"
state: absent
register: test_four
register: test_five

- name: "VIRTUAL_MACHINE 4: ASSERT - Delete"
- name: "VIRTUAL_MACHINE 5: ASSERT - Delete"
assert:
that:
- test_four is changed
- test_four['virtual_machine']['name'] == "Test VM One"
- test_four['virtual_machine']['cluster'] == 1
- test_four['virtual_machine']['vcpus'] == 8.5
- test_four['virtual_machine']['memory'] == 8
- test_four['virtual_machine']['status'] == "planned"
- test_four['virtual_machine']['role'] == 2
- test_four['virtual_machine']['tags'][0] == 4
- test_four['msg'] == "virtual_machine Test VM One deleted"
- test_five is changed
- test_five['virtual_machine']['name'] == "Test VM One"
- test_five['virtual_machine']['cluster'] == 1
- test_five['virtual_machine']['vcpus'] == 8.5
- test_five['virtual_machine']['memory'] == 8
- test_five['virtual_machine']['status'] == "planned"
- test_five['virtual_machine']['role'] == 2
- test_five['virtual_machine']['tags'][0] == 4
- test_five['msg'] == "virtual_machine Test VM One deleted"
53 changes: 41 additions & 12 deletions tests/integration/targets/v3.2/tasks/netbox_virtual_machine.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,53 @@
- test_three['virtual_machine']['tags'][0] == 4
- test_three['msg'] == "virtual_machine Test VM One updated"

- name: "VIRTUAL_MACHINE 4: Delete"
- name: "VIRTUAL_MACHINE 4: Test idempotence"
netbox.netbox.netbox_virtual_machine:
netbox_url: http://localhost:32768
netbox_token: 0123456789abcdef0123456789abcdef01234567
data:
name: "Test VM One"
cluster: "Test Cluster"
vcpus: 8.5
memory: 8
status: "Planned"
virtual_machine_role: "Test VM Role"
tags:
- "Schnozzberry"
state: present
register: test_four_idempotence

- name: "VIRTUAL_MACHINE 4: ASSERT - Not changed"
assert:
that:
- test_four_idempotence is not changed
- test_four_idempotence['virtual_machine']['name'] == "Test VM One"
- test_four_idempotence['virtual_machine']['cluster'] == 1
- test_four_idempotence['virtual_machine']['vcpus'] == 8.5
- test_four_idempotence['virtual_machine']['memory'] == 8
- test_four_idempotence['virtual_machine']['status'] == "planned"
- test_four_idempotence['virtual_machine']['role'] == 2
- test_four_idempotence['virtual_machine']['tags'][0] == 4
- test_four_idempotence['msg'] == "virtual_machine Test VM One already exists"

- name: "VIRTUAL_MACHINE 5: Delete"
netbox.netbox.netbox_virtual_machine:
netbox_url: http://localhost:32768
netbox_token: 0123456789abcdef0123456789abcdef01234567
data:
name: "Test VM One"
state: absent
register: test_four
register: test_five

- name: "VIRTUAL_MACHINE 4: ASSERT - Delete"
- name: "VIRTUAL_MACHINE 5: ASSERT - Delete"
assert:
that:
- test_four is changed
- test_four['virtual_machine']['name'] == "Test VM One"
- test_four['virtual_machine']['cluster'] == 1
- test_four['virtual_machine']['vcpus'] == 8.5
- test_four['virtual_machine']['memory'] == 8
- test_four['virtual_machine']['status'] == "planned"
- test_four['virtual_machine']['role'] == 2
- test_four['virtual_machine']['tags'][0] == 4
- test_four['msg'] == "virtual_machine Test VM One deleted"
- test_five is changed
- test_five['virtual_machine']['name'] == "Test VM One"
- test_five['virtual_machine']['cluster'] == 1
- test_five['virtual_machine']['vcpus'] == 8.5
- test_five['virtual_machine']['memory'] == 8
- test_five['virtual_machine']['status'] == "planned"
- test_five['virtual_machine']['role'] == 2
- test_five['virtual_machine']['tags'][0] == 4
- test_five['msg'] == "virtual_machine Test VM One deleted"
53 changes: 41 additions & 12 deletions tests/integration/targets/v3.3/tasks/netbox_virtual_machine.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,53 @@
- test_three['virtual_machine']['tags'][0] == 4
- test_three['msg'] == "virtual_machine Test VM One updated"

- name: "VIRTUAL_MACHINE 4: Delete"
- name: "VIRTUAL_MACHINE 4: Test idempotence"
netbox.netbox.netbox_virtual_machine:
netbox_url: http://localhost:32768
netbox_token: 0123456789abcdef0123456789abcdef01234567
data:
name: "Test VM One"
cluster: "Test Cluster"
vcpus: 8.5
memory: 8
status: "Planned"
virtual_machine_role: "Test VM Role"
tags:
- "Schnozzberry"
state: present
register: test_four_idempotence

- name: "VIRTUAL_MACHINE 4: ASSERT - Not changed"
assert:
that:
- test_four_idempotence is not changed
- test_four_idempotence['virtual_machine']['name'] == "Test VM One"
- test_four_idempotence['virtual_machine']['cluster'] == 1
- test_four_idempotence['virtual_machine']['vcpus'] == 8.5
- test_four_idempotence['virtual_machine']['memory'] == 8
- test_four_idempotence['virtual_machine']['status'] == "planned"
- test_four_idempotence['virtual_machine']['role'] == 2
- test_four_idempotence['virtual_machine']['tags'][0] == 4
- test_four_idempotence['msg'] == "virtual_machine Test VM One already exists"

- name: "VIRTUAL_MACHINE 5: Delete"
netbox.netbox.netbox_virtual_machine:
netbox_url: http://localhost:32768
netbox_token: 0123456789abcdef0123456789abcdef01234567
data:
name: "Test VM One"
state: absent
register: test_four
register: test_five

- name: "VIRTUAL_MACHINE 4: ASSERT - Delete"
- name: "VIRTUAL_MACHINE 5: ASSERT - Delete"
assert:
that:
- test_four is changed
- test_four['virtual_machine']['name'] == "Test VM One"
- test_four['virtual_machine']['cluster'] == 1
- test_four['virtual_machine']['vcpus'] == 8.5
- test_four['virtual_machine']['memory'] == 8
- test_four['virtual_machine']['status'] == "planned"
- test_four['virtual_machine']['role'] == 2
- test_four['virtual_machine']['tags'][0] == 4
- test_four['msg'] == "virtual_machine Test VM One deleted"
- test_five is changed
- test_five['virtual_machine']['name'] == "Test VM One"
- test_five['virtual_machine']['cluster'] == 1
- test_five['virtual_machine']['vcpus'] == 8.5
- test_five['virtual_machine']['memory'] == 8
- test_five['virtual_machine']['status'] == "planned"
- test_five['virtual_machine']['role'] == 2
- test_five['virtual_machine']['tags'][0] == 4
- test_five['msg'] == "virtual_machine Test VM One deleted"