vmware_guest: Fix vApp property handling

[ppmathis]

SUMMARY

The vmware_guest module did not properly handle setting vApp properties if the VmConfigSpec never contained an active vAppConfig. This resulted in an exception due to incorrectly trying to access property on None.

This PR changes the behaviour to default the current list of vApp properties to an empty list if there has never been any vAppConfig.

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

vmware_guest

ADDITIONAL INFORMATION

A simple reproducer would be a to attempt to use community.vmware.vmware_guest like this:

- name: Configure vApp options
  community.vmware.vmware_guest:
    state: present
    hostname: xxx
    username: xxx
    password: xxx
    name: reproducer-vm
    vapp_properties:
      - id: name
        type: string
        label: This is a test
        category: Test
  delegate_to: localhost
  become: false
  run_once: true

Doing so on any VM within vSphere that has its vApp options disabled, meaning that no current vApp properties exist, leads to this exception:

fatal: [test-host -> localhost]: FAILED! =>
changed: false
module_stderr: |-
    Traceback (most recent call last):
      File "/Users/xxx/.ansible/tmp/ansible-tmp-1729754011.0982752-47065-171137552843633/AnsiballZ_vmware_guest.py", line 107, in <module>
        _ansiballz_main()
      File "/Users/xxx/.ansible/tmp/ansible-tmp-1729754011.0982752-47065-171137552843633/AnsiballZ_vmware_guest.py", line 99, in _ansiballz_main
        invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)
      File "/Users/xxx/.ansible/tmp/ansible-tmp-1729754011.0982752-47065-171137552843633/AnsiballZ_vmware_guest.py", line 47, in invoke_module
        runpy.run_module(mod_name='ansible_collections.community.vmware.plugins.modules.vmware_guest', init_globals=dict(_module_fqn='ansible_collections.community.vmware.plugins.modules.vmware_guest', _modlib_path=modlib_path),
      File "<frozen runpy>", line 226, in run_module
      File "<frozen runpy>", line 98, in _run_module_code
      File "<frozen runpy>", line 88, in _run_code
      File "/var/folders/lb/q308qwkx1gggdlfxx_xqj9n00000gq/T/ansible_community.vmware.vmware_guest_payload_zwjpusr8/ansible_community.vmware.vmware_guest_payload.zip/ansible_collections/community/vmware/plugins/modules/vmware_guest.py", line 3640, in <module>
      File "/var/folders/lb/q308qwkx1gggdlfxx_xqj9n00000gq/T/ansible_community.vmware.vmware_guest_payload_zwjpusr8/ansible_community.vmware.vmware_guest_payload.zip/ansible_collections/community/vmware/plugins/modules/vmware_guest.py", line 3579, in main
      File "/var/folders/lb/q308qwkx1gggdlfxx_xqj9n00000gq/T/ansible_community.vmware.vmware_guest_payload_zwjpusr8/ansible_community.vmware.vmware_guest_payload.zip/ansible_collections/community/vmware/plugins/modules/vmware_guest.py", line 3195, in reconfigure_vm
      File "/var/folders/lb/q308qwkx1gggdlfxx_xqj9n00000gq/T/ansible_community.vmware.vmware_guest_payload_zwjpusr8/ansible_community.vmware.vmware_guest_payload.zip/ansible_collections/community/vmware/plugins/modules/vmware_guest.py", line 2071, in configure_vapp_properties
    AttributeError: 'NoneType' object has no attribute 'property'
module_stdout: ''
msg: |-
    MODULE FAILURE
    See stdout/stderr for the exact error
rc: 1

With the fix from this commit applied, the situation where vAppConfig equals None is gracefully handled and the vApp properties can be successfully set.

[softwarefactory-project-zuul]

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/5a92f7a6320d445894109757b4e7a365

✔️ ansible-tox-linters SUCCESS in 4m 18s
✔️ build-ansible-collection SUCCESS in 7m 24s
✔️ ansible-test-cloud-integration-vcenter7_only-stable217 SUCCESS in 17m 17s
❌ ansible-test-cloud-integration-vcenter7_2esxi-stable217 FAILURE in 20m 15s
⚠️ 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 4m 09s

[ppmathis]

I've just checked out the CI logs, but to the best of my knowledge they are not related to this MR and rather a form of flaky tests, as they do not mess with vApp properties and the configure_vapp_properties method bails out for vapp_properties: [] before any changed code runs.

[mariolenz]

recheck

[softwarefactory-project-zuul]

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

✔️ ansible-tox-linters SUCCESS in 4m 18s
✔️ build-ansible-collection SUCCESS in 8m 01s
✔️ ansible-test-cloud-integration-vcenter7_only-stable217 SUCCESS in 17m 55s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable217 SUCCESS in 15m 33s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_1_of_2 SUCCESS in 52m 31s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_2_of_2 SUCCESS in 1h 00m 13s
✔️ ansible-galaxy-importer SUCCESS in 5m 01s

[mariolenz]

@ppmathis FYI You, as the author of this PR, should also be able to re-run the CI again by simply commenting recheck like I did.

Sorry, I didn't have the time to look at this. Although what I can say at the spur of the moment, you have to add a changelog fragment.

[softwarefactory-project-zuul]

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

✔️ ansible-tox-linters SUCCESS in 4m 26s
✔️ build-ansible-collection SUCCESS in 7m 30s
✔️ ansible-test-cloud-integration-vcenter7_only-stable217 SUCCESS in 22m 12s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable217 SUCCESS in 17m 26s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_1_of_2 SUCCESS in 51m 50s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable217_2_of_2 SUCCESS in 58m 02s
✔️ ansible-galaxy-importer SUCCESS in 5m 16s

[ppmathis]

@mariolenz Thanks a lot for your guidance! I've just added a bugfix changelog fragment as asked.

[mariolenz]

There have been some problems in the CI and also some changes to vmware_guest meanwhile, so I'll close and re-open this PR to trigger a new clean CI run. I'm not sure if a recheck would be really enough.

[softwarefactory-project-zuul]

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

✔️ ansible-tox-linters SUCCESS in 4m 32s
✔️ build-ansible-collection SUCCESS in 7m 17s
✔️ ansible-test-cloud-integration-vcenter7_only-stable218 SUCCESS in 17m 04s
✔️ ansible-test-cloud-integration-vcenter7_2esxi-stable218 SUCCESS in 13m 19s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_1_of_2 SUCCESS in 53m 07s
✔️ ansible-test-cloud-integration-vcenter7_1esxi-stable218_2_of_2 SUCCESS in 1h 08m 22s
✔️ ansible-galaxy-importer SUCCESS in 4m 04s

[ppmathis]

Hi @mariolenz,

Is there anything I can do to assist with the review of this MR? It would be great to see this upstreamed and released, as it would allow me to stop relying on a fork due to this specific bug. Please let me know if there's anything further I can provide to help move this forward.

Thanks!

[mariolenz]

I'm sorry, I didn't find much time to work on this collection during the last weeks. I hope I'm able to review this PR soon.

[mariolenz]

I wasn't able to test this, but the code LGTM.

Thanks @ppmathis

[softwarefactory-project-zuul]

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

✔️ ansible-tox-linters SUCCESS in 4m 56s
✔️ build-ansible-collection SUCCESS in 5m 44s
✔️ ansible-galaxy-importer SUCCESS in 4m 44s

[softwarefactory-project-zuul]

Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry.