feat: Do not create VM if system or bootstrap disks are marked for deletion (#492)

* refactor: Make available complete image info, instead of UUID only

We plan to make decisions based on some of the information.

* fixup! refactor: Make available complete image info, instead of UUID only

Refactor further; add unit tests with mocks

* fixup! refactor: Make available complete image info, instead of UUID only

Use longer name for receivers

* fixup! refactor: Make available complete image info, instead of UUID only

Add unit test for new String method

* fixup! refactor: Make available complete image info, instead of UUID only

Add envtest-based test for getDiskList. I adapted this from Ilya's work
in #493.

Co-authored-by: Ilya Alekseyev <[email protected]>

* fixup! refactor: Make available complete image info, instead of UUID only

Rename function from GetImageByNameOrUUID to GetImage

* fixup! refactor: Make available complete image info, instead of UUID only

Add and use IsName and IsUUID helpers

* fixup! refactor: Make available complete image info, instead of UUID only

Rename input parameter from image to id, for clarity

* fixup! refactor: Make available complete image info, instead of UUID only

As requested, do not use nested switch

* feat: Do not create VM if system or bootstrap disks are marked for deletion

* fixup! feat: Do not create VM if system or bootstrap disks are marked for deletion

Do not export function

* fixup! feat: Do not create VM if system or bootstrap disks are marked for deletion

Use constants for image state

* fixup! feat: Do not create VM if system or bootstrap disks are marked for deletion

Replace ginkgo with standard tests; cover failure cases

* fixup! feat: Do not create VM if system or bootstrap disks are marked for deletion

Export helper function, as requested

---------

Co-authored-by: Ilya Alekseyev <[email protected]>

Author: dlipovetsky

controllers/helpers.go

@@ -53,6 +53,9 @@ const (
 	gpuUnused = "UNUSED"
 
 	detachVGRequeueAfter = 30 * time.Second
+
+	ImageStateDeletePending    = "DELETE_PENDING"
+	ImageStateDeleteInProgress = "DELETE_IN_PROGRESS"
 )
 
 // DeleteVM deletes a VM and is invoked by the NutanixMachineReconciler
@@ -335,6 +338,11 @@ func GetImage(ctx context.Context, client *prismclientv3.Client, id infrav1.Nuta
 	}
 }
 
+func ImageMarkedForDeletion(image *prismclientv3.ImageIntentResponse) bool {
+	state := *image.Status.State
+	return state == ImageStateDeletePending || state == ImageStateDeleteInProgress
+}
+
 // HasTaskInProgress returns true if the given task is in progress
 func HasTaskInProgress(ctx context.Context, client *prismclientv3.Client, taskUUID string) (bool, error) {
 	log := ctrl.LoggerFrom(ctx)

controllers/nutanixmachine_controller.go

@@ -782,6 +782,15 @@ func getSystemDisk(rctx *nctx.MachineContext) (*prismclientv3.VMDisk, error) {
 		return nil, err
 	}
 
+	// Consider this a precaution. If the image is marked for deletion after we
+	// create the "VM create" task, then that task will fail. We will handle that
+	// failure separately.
+	if ImageMarkedForDeletion(nodeOSImage) {
+		err := fmt.Errorf("system disk image %s is being deleted", *nodeOSImage.Metadata.UUID)
+		rctx.SetFailureStatus(capierrors.CreateMachineError, err)
+		return nil, err
+	}
+
 	systemDiskSizeMib := GetMibValueOfQuantity(rctx.NutanixMachine.Spec.SystemDiskSize)
 	systemDisk, err := CreateSystemDiskSpec(*nodeOSImage.Metadata.UUID, systemDiskSizeMib)
 	if err != nil {
@@ -805,6 +814,15 @@ func getBootstrapDisk(rctx *nctx.MachineContext) (*prismclientv3.VMDisk, error)
 		return nil, err
 	}
 
+	// Consider this a precaution. If the image is marked for deletion after we
+	// create the "VM create" task, then that task will fail. We will handle that
+	// failure separately.
+	if ImageMarkedForDeletion(bootstrapImage) {
+		err := fmt.Errorf("bootstrap disk image %s is being deleted", *bootstrapImage.Metadata.UUID)
+		rctx.SetFailureStatus(capierrors.CreateMachineError, err)
+		return nil, err
+	}
+
 	bootstrapDisk := &prismclientv3.VMDisk{
 		DeviceProperties: &prismclientv3.VMDiskDeviceProperties{
 			DeviceType: ptr.To(deviceTypeCDROM),