vmware_guest_info - Make "datacenter" property optional

[PfurtschellerP]

SUMMARY

We run a big VMware environment featuring multiple vCenters and multiple datacenters within them.
When automating the deployment of VMs at the moment we search for existing machines with the name of the to be deployed machine in order to perform clean-up activities. At the moment we use the guest find module, but it's slow.
Therefore we looked into the guest_info module and found that if the VM is unique, the datacenter property is never actually used as it is only relevant in case multiple VMs have been found.

In case multiple VMs are found, the folder and datacenter attributes are used to decide on "the right one".
Therefore, the datacenter property could as well be an optional parameter on the module and it could simply fail in case there is more than one VM matching and "datacenter" as well as "folder" are required.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

• vmware_guest_info.py
• vmware.py

ADDITIONAL INFORMATION

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/384182c752814458b5981db376656b33

✔️ ansible-tox-linters SUCCESS in 4m 38s
✔️ build-ansible-collection SUCCESS in 7m 28s
✔️ ansible-test-cloud-integration-vcenter7_only-stable217 SUCCESS in 16m 41s
❌ ansible-test-cloud-integration-vcenter7_2esxi-stable217 FAILURE in 16m 49s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_1_of_2 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 7m 11s

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/a14938ecd83e406c999638dfad11eb44

✔️ ansible-tox-linters SUCCESS in 4m 17s
✔️ build-ansible-collection SUCCESS in 7m 27s
✔️ ansible-test-cloud-integration-vcenter7_only-stable217 SUCCESS in 21m 25s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable217 SUCCESS in 21m 09s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_1_of_2 SUCCESS in 56m 08s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_2_of_2 SUCCESS in 1h 11m 30s
✔️ ansible-galaxy-importer SUCCESS in 4m 46s

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/5d3cb7ad9b554916963966f28f6c26c4

✔️ ansible-tox-linters SUCCESS in 4m 28s
✔️ build-ansible-collection SUCCESS in 7m 22s
✔️ ansible-test-cloud-integration-vcenter7_only-stable217 SUCCESS in 23m 28s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable217 SUCCESS in 19m 08s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_1_of_2 SUCCESS in 56m 34s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_2_of_2 SUCCESS in 1h 09m 05s
✔️ ansible-galaxy-importer SUCCESS in 4m 16s

[mariolenz]

The code you've changed in plugins/module_utils/vmware.py is used by a quite a lot of modules:

$ grep -r 'get_vm(' plugins/modules/ | cut -d ':' -f 1 | sort | uniq 
plugins/modules/vmware_content_deploy_ovf_template.py
plugins/modules/vmware_content_deploy_template.py
plugins/modules/vmware_deploy_ovf.py
plugins/modules/vmware_export_ovf.py
plugins/modules/vmware_guest_boot_info.py
plugins/modules/vmware_guest_boot_manager.py
plugins/modules/vmware_guest_controller.py
plugins/modules/vmware_guest_cross_vc_clone.py
plugins/modules/vmware_guest_custom_attributes.py
plugins/modules/vmware_guest_disk_info.py
plugins/modules/vmware_guest_disk.py
plugins/modules/vmware_guest_info.py
plugins/modules/vmware_guest_move.py
plugins/modules/vmware_guest_network.py
plugins/modules/vmware_guest_powerstate.py
plugins/modules/vmware_guest.py
plugins/modules/vmware_guest_register_operation.py
plugins/modules/vmware_guest_screenshot.py
plugins/modules/vmware_guest_sendkey.py
plugins/modules/vmware_guest_serial_port.py
plugins/modules/vmware_guest_snapshot_info.py
plugins/modules/vmware_guest_snapshot.py
plugins/modules/vmware_guest_storage_policy.py
plugins/modules/vmware_guest_tools_info.py
plugins/modules/vmware_guest_tools_upgrade.py
plugins/modules/vmware_guest_tools_wait.py
plugins/modules/vmware_guest_tpm.py
plugins/modules/vmware_guest_vgpu_info.py
plugins/modules/vmware_guest_vgpu.py
plugins/modules/vmware_guest_video.py
plugins/modules/vmware_host_auto_start.py
plugins/modules/vmware_vmotion.py

So we'll have to make sure that it's really safe and we don't break anything by accident. Apropos of breaking things, this might be considered a breaking change because people are used to the current behavior. And that means we might have to wait for the next major release to implement this.

[PfurtschellerP]

@mariolenz Okay, what would be the best approach here going foreward?

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/8f0b0ea5f15b4ce484d6789cfdd70420

✔️ ansible-tox-linters SUCCESS in 4m 35s
✔️ build-ansible-collection SUCCESS in 7m 58s
⚠️ ansible-test-cloud-integration-vcenter7_only-stable218 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 CANCELED
❌ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 FAILURE in 15m 07s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 5m 48s

[mariolenz]

Okay, what would be the best approach here going foreward?

I've had a look at those other modules and think that your changes should be OK. Let's give it a try! Although we might revert this in a future minor or bugfix release if it turns out to be problematic later.

There's just one minor thing I see in the error message. I should say it hasn't been that great before, but maybe we should improve it a bit while we're at it.

cc @ihumster

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/9f56c01100b8477db7bc52bcb89b7926

✔️ ansible-tox-linters SUCCESS in 4m 46s
✔️ build-ansible-collection SUCCESS in 7m 52s
⚠️ ansible-test-cloud-integration-vcenter7_only-stable218 CANCELED
❌ ansible-test-cloud-integration-vcenter7_2esxi-stable218 FAILURE in 19m 46s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 3m 08s

[ihumster]

@mariolenz I looked at the vmware.py library code and I think the changes Patrick made are pretty safe for the modules to function. And indeed, if something goes wrong, we will release a rollback fix.

[mariolenz]

recheck

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/3b81e5bc19524d559c625ba5f8e0d6f4

✔️ ansible-tox-linters SUCCESS in 4m 57s
✔️ build-ansible-collection SUCCESS in 7m 23s
⚠️ ansible-test-cloud-integration-vcenter7_only-stable218 CANCELED
⚠️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 CANCELED
❌ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 FAILURE in 14m 09s
⚠️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 CANCELED
✔️ ansible-galaxy-importer SUCCESS in 5m 16s

[mariolenz]

recheck

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/f50a06274c054fd3bd6e87785b5fa023

✔️ ansible-tox-linters SUCCESS in 4m 37s
✔️ build-ansible-collection SUCCESS in 8m 30s
✔️ ansible-test-cloud-integration-vcenter7_only-stable218 SUCCESS in 20m 52s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 SUCCESS in 18m 04s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 SUCCESS in 1h 10m 17s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 SUCCESS in 59m 57s
✔️ ansible-galaxy-importer SUCCESS in 4m 22s

[mariolenz]

LGTM

Thanks @PfurtschellerP!

Thanks for reviewing @ihumster!

[softwarefactory-project-zuul]

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/0de8d710e6194f23b7e037cf4d7531f0

✔️ ansible-tox-linters SUCCESS in 4m 36s
✔️ build-ansible-collection SUCCESS in 7m 15s
✔️ ansible-galaxy-importer SUCCESS in 3m 12s