govc: add volume.rm -keep flag to retain backing disk

dougm · dougm · commit 29fe42fa4f5a · 2025-03-10T14:24:26.000-07:00
vcsim: don't delete backing disk in CnsDeleteVolume when DeleteDisk==false

Signed-off-by: Doug MacEachern &lt;dougm@broadcom.com&gt;
diff --git a/cli/volume/rm.go b/cli/volume/rm.go
@@ -17,6 +17,8 @@ import (
 
 type rm struct {
 	*flags.ClientFlag
+
+	keep bool
 }
 
 func init() {
@@ -26,6 +28,8 @@ func init() {
 func (cmd *rm) Register(ctx context.Context, f *flag.FlagSet) {
 	cmd.ClientFlag, ctx = flags.NewClientFlag(ctx)
 	cmd.ClientFlag.Register(ctx, f)
+
+	f.BoolVar(&cmd.keep, "keep", false, "Keep backing disk")
 }
 
 func (cmd *rm) Usage() string {
@@ -55,7 +59,7 @@ func (cmd *rm) Run(ctx context.Context, f *flag.FlagSet) error {
 
 	ids := []types.CnsVolumeId{{Id: f.Arg(0)}}
 
-	task, err := c.DeleteVolume(ctx, ids, true)
+	task, err := c.DeleteVolume(ctx, ids, !cmd.keep)
 	if err != nil {
 		return err
 	}
diff --git a/cns/simulator/simulator.go b/cns/simulator/simulator.go
@@ -331,13 +331,22 @@ func (m *CnsVolumeManager) CnsDeleteVolume(ctx *simulator.Context, req *cnstypes
 	vsom := vctx.Map.VStorageObjectManager()
 
 	task := simulator.CreateTask(m, "CnsDeleteVolume", func(*simulator.Task) (vim25types.AnyType, vim25types.BaseMethodFault) {
-		operationResult := []cnstypes.BaseCnsVolumeOperationResult{}
-		for _, volumeId := range req.VolumeIds {
-			for ds, dsVolumes := range m.volumes {
-				res := &cnstypes.CnsVolumeOperationResult{
-					VolumeId: volumeId,
-				}
-				if _, ok := dsVolumes[volumeId]; ok {
+		if len(req.VolumeIds) != 1 {
+			return nil, &vim25types.InvalidArgument{InvalidProperty: "InputSpec"} // Same as real VC, currently
+		}
+
+		found := false
+		volumeId := req.VolumeIds[0]
+		res := &cnstypes.CnsVolumeOperationResult{
+			VolumeId: volumeId,
+		}
+
+		for ds, volumes := range m.volumes {
+			if _, ok := volumes[volumeId]; ok {
+				found = true
+				delete(m.volumes[ds], volumeId)
+
+				if req.DeleteDisk {
 					val := vsom.DeleteVStorageObjectTask(vctx, &vim25types.DeleteVStorageObject_Task{
 						This:      vsom.Self,
 						Id:        vim25types.ID(volumeId),
@@ -349,17 +358,17 @@ func (m *CnsVolumeManager) CnsDeleteVolume(ctx *simulator.Context, req *cnstypes
 					task.Wait()
 					if task.Info.Error != nil {
 						res.Fault = task.Info.Error
-					} else {
-						delete(m.volumes[ds], volumeId)
 					}
-				} else {
-					res.Fault = &vim25types.LocalizedMethodFault{Fault: new(vim25types.NotFound)}
 				}
-				operationResult = append(operationResult, res)
 			}
 		}
+
+		if !found {
+			res.Fault = &vim25types.LocalizedMethodFault{Fault: new(vim25types.NotFound)}
+		}
+
 		return &cnstypes.CnsVolumeOperationBatchResult{
-			VolumeResults: operationResult,
+			VolumeResults: []cnstypes.BaseCnsVolumeOperationResult{res},
 		}, nil
 	})
 
diff --git a/govc/USAGE.md b/govc/USAGE.md
@@ -7691,6 +7691,7 @@ Examples:
   govc volume.rm f75989dc-95b9-4db7-af96-8583f24bc59d
 
 Options:
+  -keep=false            Keep backing disk
 ```
 
 ## volume.snapshot.create
diff --git a/govc/test/volume.bats b/govc/test/volume.bats
@@ -133,11 +133,15 @@ load test_helper
 @test "volume.rm" {
   vcsim_env
 
-  run env GOVC_SHOW_UNRELEASED=true govc volume.create \
-      -cluster-id my-cluster my-volume
+  export GOVC_SHOW_UNRELEASED=true
+
+  run govc volume.create -cluster-id my-cluster my-volume
   assert_success
   id="$output"
 
+  run govc disk.ls "$id"
+  assert_success
+
   run govc volume.rm invalid
   assert_failure
 
@@ -146,6 +150,19 @@ load test_helper
 
   run govc volume.rm "$id"
   assert_failure
+
+  run govc disk.ls "$id"
+  assert_failure
+
+  run govc volume.create -cluster-id my-cluster my-volume
+  assert_success
+  id="$output"
+
+  run govc volume.rm -keep "$id"
+  assert_success
+
+  run govc disk.ls "$id"
+  assert_success
 }
 
 @test "volume.snapshot" {
