Fix VMDK upload failure on ESXi host using vspshere_file resource.

[sumitmaggo]

Description

Fixes issues where vsphere_file resource fails to upload VMDK file to ESXi host datastore.

VMDK disk upload has been tested with Terraform 0.13 version on ESXi.

Release Note

vsphere_file resource: Fix upload of VMDK to datastore on ESXi host. [GH-1409]

References

Closes #1296
Closes #1243

[sumitmaggo]

@bill-rich @koikonom @aareet @sumitAgrawal007 Can you guys please look into this PR and provide your comments? Thanks in advance.

[sumitmaggo]

@bill-rich @koikonom @aareet @sumitAgrawal007 Can anyone please review this PR? Its been pending for too long and we are blocked because of it and not able to pick the latest vsphere provider version for ESXi.

[sumitmaggo]

@bill-rich @koikonom Can you please help getting this PR reviewed and merged? We need to move to the latest version of vsphere provider and this issue is blocking that.

[sumitmaggo]

@redeux Can you please check and review if this fix can also be added as a candidate for next release? This is also needed in addition to #1408 PR changes to move to the latest version of vsphere provider for ESXi deployment. Thanks in advance.

[sumitmaggo]

@appilon Can you please review and merge this PR as well? This is also needed in addition to #1408 to allow launching VM on ESXi server.

[tenthirtyam]

@sumitmaggo Can you update the description with "Closes #1296' to link the pull request to your issue using the keyword?

Ryan

[sumitmaggo]

Thanks @tenthirtyam, updated the description to link it with the issue.

[tenthirtyam]

@sumitmaggo - I found the issue and will submit a fix to your branch soon.

[tenthirtyam]

@appilon - I've updated @sumitmaggo's pull request to address a failure seen after a successful upload.

A destroy would complete as a false positive when deleting a .vmdk and would leave the file since the DeleteDatastoreFile_Task could not delete a VMDK.

This change updates the methods used in the deleteFile function.

• If the source file is a .vmdk, the Delete method uses the correct DeleteVirtualDisk_Task.
• If the source file is not a .vmdk, the Delete method uses the correct DeleteDatastoreFile_Task.

terraform-provider-vsphere/vsphere/resource_vsphere_file.go

Lines 394 to 439 in 86a38bb

	func deleteFile(client *govmomi.Client, f *file) error {
	dc, err := getDatacenter(client, f.datacenter)
	if err != nil {
	return err
	}
	finder := find.NewFinder(client.Client, true)
	finder = finder.SetDatacenter(dc)
	ds, err := getDatastore(finder, f.datastore)
	if err != nil {
	return fmt.Errorf("error %s", err)
	}
	// If the source file is a VMDK, the Delete method uses the correct DeleteVirtualDisk_Task
	if path.Ext(f.destinationFile) == ".vmdk" {
	vdm := object.NewVirtualDiskManager(client.Client)
	task, err := vdm.DeleteVirtualDisk(context.TODO(), ds.Path(f.destinationFile), dc)
	if err != nil {
	return err
	}
	_, err = task.WaitForResult(context.TODO(), nil)
	if err != nil {
	return err
	}
	return nil
	} else {
	// If the source file is not a VMDK, the Delete method uses the correct DeleteDatastoreFile_Task
	fm := object.NewFileManager(client.Client)
	task, err := fm.DeleteDatastoreFile(context.TODO(), ds.Path(f.destinationFile), dc)
	if err != nil {
	return err
	}
	_, err = task.WaitForResult(context.TODO(), nil)
	if err != nil {
	return err
	}
	return nil
	}
	}

The same method is used in the vsphere_virtual_disk resource:

terraform-provider-vsphere/vsphere/resource_vsphere_virtual_disk.go

Lines 347 to 354 in c33786d

	diskPath := ds.Path(vDisk.vmdkPath)
	virtualDiskManager := object.NewVirtualDiskManager(client.Client)
	task, err := virtualDiskManager.DeleteVirtualDisk(context.TODO(), diskPath, dc)
	if err != nil {
	return err
	}

I've successfully tested these changes on vSphere v7.0.3(c) and v6.7.2, testing the following:

✅ Create vsphere_file resource for a .vmdk; check exists.
✅ Destroy a vsphere_file resource for a .vmdk; check does not exist.
✅ Create vsphere_file resource for a .iso; check exists.
✅ Destroy a vsphere_file resource for a .iso; check does not exist.

Ryan

[sumitmaggo]

Thanks @appilon and @tenthirtyam for the review and merge of this PR.
When can we expect the next vsphere plugin 2.0.3 release?

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.