fix: Handle fm.MakeDirectory failing when creating parent directories

for a virtual disk

Author: skevir

vsphere/resource_vsphere_virtual_disk.go

@@ -13,6 +13,7 @@ import (
 	"path"
 	"strconv"
 	"strings"
+	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/vmware/govmomi"
@@ -172,16 +173,27 @@ func resourceVSphereVirtualDiskCreate(d *schema.ResourceData, meta interface{})
 		if directoryPathIndex > 0 {
 			vmdkPath := vDisk.vmdkPath[0:directoryPathIndex]
 			log.Printf("[DEBUG] Creating parent directories: %v", ds.Path(vmdkPath))
-			err = fm.MakeDirectory(context.TODO(), ds.Path(vmdkPath), dc, true)
-			if err != nil && !isAlreadyExists(err) {
-				log.Printf("[DEBUG] Failed to create parent directories:  %v", err)
-				return err
+			makeDirectoryErr := fm.MakeDirectory(context.TODO(), ds.Path(vmdkPath), dc, true)
+			if makeDirectoryErr != nil {
+				// MakeDirectory can fail with a number of different errors if the directory is
+				// already in the process of being created. To avoid the need to handle each of
+				// these errors individually, the error is not returned here and the call to
+				// searchForDirectory below is used to determine if the directory is present.
+				// If the directory is in the process of being created, that will need to complete
+				// in order for the search to find the new directory, so sleep for a couple of
+				// seconds to allow that.
+				log.Printf("[DEBUG] Error hit when creating parent directories:  %v", makeDirectoryErr)
+				time.Sleep(2 * time.Second)
 			}
 
 			err = searchForDirectory(client, vDisk.datacenter, vDisk.datastore, vmdkPath)
 			if err != nil {
 				log.Printf("[DEBUG] Failed to find newly created parent directories:  %v", err)
-				return err
+				if makeDirectoryErr != nil {
+					return makeDirectoryErr
+				} else {
+					return err
+				}
 			}
 		}
 	}
@@ -423,11 +435,6 @@ func resourceVSphereVirtualDiskDelete(d *schema.ResourceData, meta interface{})
 	return nil
 }
 
-func isAlreadyExists(err error) bool {
-	return strings.HasPrefix(err.Error(), "Cannot complete the operation because the file or folder") &&
-		strings.HasSuffix(err.Error(), "already exists")
-}
-
 // createHardDisk creates a new Hard Disk.
 func createHardDisk(client *govmomi.Client, size int, diskPath string, diskType string, adapterType string, dc string) error {
 	var vDiskType string