Fix folder_template_from_vm test failure

elsapassaro commented 3 months ago

SUMMARY

When running vmware_folder_template_from_vm integration test in Jenkins CI on real vcenter, the test is failing when trying to create the template with the following error:

Traceback (most recent call last):
  File "/root/.ansible/tmp/ansible-tmp-1722237961.4638362-112-170133260483632/AnsiballZ_folder_template_from_vm.py", line 107, in <module>
    _ansiballz_main()
  File "/root/.ansible/tmp/ansible-tmp-1722237961.4638362-112-170133260483632/AnsiballZ_folder_template_from_vm.py", line 99, in _ansiballz_main
    invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)
  File "/root/.ansible/tmp/ansible-tmp-1722237961.4638362-112-170133260483632/AnsiballZ_folder_template_from_vm.py", line 47, in invoke_module
    runpy.run_module(mod_name='ansible_collections.vmware.vmware.plugins.modules.folder_template_from_vm', init_globals=dict(_module_fqn='ansible_collections.vmware.vmware.plugins.modules.folder_template_from_vm', _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 "/tmp/ansible_vmware.vmware.folder_template_from_vm_payload_zoujjh6r/ansible_vmware.vmware.folder_template_from_vm_payload.zip/ansible_collections/vmware/vmware/plugins/modules/folder_template_from_vm.py", line 312, in <module>
  File "/tmp/ansible_vmware.vmware.folder_template_from_vm_payload_zoujjh6r/ansible_vmware.vmware.folder_template_from_vm_payload.zip/ansible_collections/vmware/vmware/plugins/modules/folder_template_from_vm.py", line 298, in main
  File "/tmp/ansible_vmware.vmware.folder_template_from_vm_payload_zoujjh6r/ansible_vmware.vmware.folder_template_from_vm_payload.zip/ansible_collections/vmware/vmware/plugins/modules/folder_template_from_vm.py", line 177, in check_if_template_exists
  File "/tmp/ansible_vmware.vmware.folder_template_from_vm_payload_zoujjh6r/ansible_vmware.vmware.folder_template_from_vm_payload.zip/ansible_collections/vmware/vmware/plugins/module_utils/vmware.py", line 330, in get_vm_using_params
  File "/tmp/ansible_vmware.vmware.folder_template_from_vm_payload_zoujjh6r/ansible_vmware.vmware.folder_template_from_vm_payload.zip/ansible_collections/vmware/vmware/plugins/module_utils/vmware.py", line 250, in get_objs_by_name_or_moid
  File "/usr/local/lib/python3.11/site-packages/pyVmomi/VmomiSupport.py", line 608, in __call__
    return self.f(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/pyVmomi/VmomiSupport.py", line 396, in _InvokeAccessor
    return self._stub.InvokeAccessor(self, info)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/pyVmomi/StubAdapterAccessorImpl.py", line 57, in InvokeAccessor
    return self.InvokeMethod(mo, info, (prop, ))
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/pyVmomi/SoapAdapter.py", line 1472, in InvokeMethod
    raise obj  # pylint: disable-msg=E0702
    ^^^^^^^^^
pyVmomi.VmomiSupport.vmodl.fault.ManagedObjectNotFound: (vmodl.fault.ManagedObjectNotFound) {
   dynamicType = <unset>,
   dynamicProperty = (vmodl.DynamicProperty) [],
   msg = "The object 'vim.VirtualMachine:vm-13537' has already been deleted or has not been completely created",
   faultCause = <unset>,
   faultMessage = (vmodl.LocalizableMessage) [],
   obj = 'vim.VirtualMachine:vm-13537'
}

I tried to add a previous task that checks that the VM is created using the community.vmware.vmware_guest_info module:

    - name: Get info on VM {{ vm_name }}
      community.vmware.vmware_guest_info:
        validate_certs: false
        hostname: "{{ vcenter_hostname }}"
        username: "{{ vcenter_username }}"
        password: "{{ vcenter_password }}"
        datacenter: "{{ vcenter_datacenter }}"
        folder: "{{ vm_folder }}"
        port: "{{ vcenter_port }}"
        name: "{{ vm_name }}"
      register: vm_info
      retries: 5
      delay: 10
      until: vm_info.failed == false

but this is not solving the issue because this task successfully retrieves the VM info but the folder_template_from_vm module still fails with the same error.

It seems to work if we set the VM state to poweredon at VM creation and we power it off afterwards (link to Jenkins run)

mikemorency commented 3 months ago

has not been completely created

I wonder if the VM needs vmware tools installed on it so it needs to be powered on once. Or if its just taking awhile to be created and unless the state is 'poweredon', the task completes too fast if state is just 'present'

mariolenz commented 3 months ago

has not been completely created

I wonder if the VM needs vmware tools installed on it so it needs to be powered on once. Or if its just taking awhile to be created and unless the state is 'poweredon', the task completes too fast if state is just 'present'

I didn't have a closer look at the problem, but I tend to a timing problem here: Creating the VM hasn't been completed yet when trying to clone the VM into a template. I could test this manually tomorrow if you want me to, but I'm 100% sure you don't need VMware Tools in a VM to clone it into a template. Actually, I'm 100% sure you don't even need an OS installed. And you can't install VMware Tools on top of a non-existing OS ;-)

elsapassaro commented 3 months ago

@mariolenz right, the VM created in this test doesn't have an OS installed (so VMware Tools is not running). Since sometimes the test was passing it indeed indicates a timing issue

ansible-collections / vmware.vmware

Fix folder_template_from_vm test failure #53

SUMMARY