Add RemoveDynamicDisk action

It will delete the symlink to real device path in
/var/vcap/data/dynamic_disks

Author: mariash

agent/action/concrete_factory.go

@@ -86,6 +86,7 @@ func NewFactory(
 			"add_persistent_disk":    NewAddPersistentDiskAction(settingsService),
 			"remove_persistent_disk": NewRemovePersistentDiskAction(settingsService),
 			"add_dynamic_disk":       NewAddDynamicDiskAction(settingsService, platform),
+			"remove_dynamic_disk":    NewRemoveDynamicDiskAction(platform),
 
 			// ARP cache management
 			"delete_arp_entries": NewDeleteARPEntries(platform),

agent/action/remove_dynamic_disk.go

@@ -0,0 +1,46 @@
+package action
+
+import (
+	"errors"
+
+	boshplatform "github.com/cloudfoundry/bosh-agent/v2/platform"
+	bosherr "github.com/cloudfoundry/bosh-utils/errors"
+)
+
+type RemoveDynamicDiskAction struct {
+	platform boshplatform.Platform
+}
+
+func NewRemoveDynamicDiskAction(platform boshplatform.Platform) RemoveDynamicDiskAction {
+	return RemoveDynamicDiskAction{
+		platform: platform,
+	}
+}
+
+func (a RemoveDynamicDiskAction) Run(diskCID string) (interface{}, error) {
+	if err := a.platform.CleanupDynamicDisk(diskCID); err != nil {
+		return "", bosherr.WrapError(err, "Setting up dynamic disk")
+	}
+
+	return map[string]string{}, nil
+}
+
+func (a RemoveDynamicDiskAction) IsAsynchronous(_ ProtocolVersion) bool {
+	return true
+}
+
+func (a RemoveDynamicDiskAction) IsPersistent() bool {
+	return false
+}
+
+func (a RemoveDynamicDiskAction) IsLoggable() bool {
+	return true
+}
+
+func (a RemoveDynamicDiskAction) Resume() (interface{}, error) {
+	return nil, errors.New("not supported")
+}
+
+func (a RemoveDynamicDiskAction) Cancel() error {
+	return errors.New("not supported")
+}

agent/action/remove_dynamic_disk_test.go

@@ -0,0 +1,41 @@
+package action
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	"github.com/pkg/errors"
+
+	"github.com/cloudfoundry/bosh-agent/v2/platform/platformfakes"
+)
+
+var _ = Describe("RemoveDynamicDiskAction", func() {
+	var (
+		action   RemoveDynamicDiskAction
+		platform *platformfakes.FakePlatform
+	)
+
+	BeforeEach(func() {
+		platform = &platformfakes.FakePlatform{}
+		action = NewRemoveDynamicDiskAction(platform)
+	})
+
+	It("cleans up dynamic disk", func() {
+		result, err := action.Run("diskCID")
+
+		Expect(err).ToNot(HaveOccurred())
+		Expect(result).To(Equal(map[string]string{}))
+		Expect(platform.CleanupDynamicDiskCallCount()).To(Equal(1))
+		Expect(platform.CleanupDynamicDiskArgsForCall(0)).To(Equal("diskCID"))
+	})
+
+	Context("when cleaning up dynamic disk fails", func() {
+		BeforeEach(func() {
+			platform.CleanupDynamicDiskReturns(errors.New("Could not setup"))
+		})
+
+		It("should raise error", func() {
+			_, err := action.Run("diskCID")
+			Expect(err).To(HaveOccurred())
+		})
+	})
+})

platform/dummy_platform.go

@@ -226,6 +226,10 @@ func (p dummyPlatform) SetupDynamicDisk(diskSetting boshsettings.DiskSettings) (
 	return
 }
 
+func (p dummyPlatform) CleanupDynamicDisk(diskCID string) (err error) {
+	return
+}
+
 func (p dummyPlatform) SetupDataDir(_ boshsettings.JobDir, _ boshsettings.RunDir) error {
 	dataDir := p.dirProvider.DataDir()
 

platform/linux_platform.go

@@ -781,15 +781,24 @@ func (p linux) SetupRawEphemeralDisks(devices []boshsettings.DiskSettings) (err
 func (p linux) SetupDynamicDisk(diskSetting boshsettings.DiskSettings) error {
 	devicePath, timedOut, err := p.devicePathResolver.GetRealDevicePath(diskSetting)
 	if err != nil {
-		return bosherr.WrapError(err, "Getting real device path")
+		return bosherr.WrapError(err, "Getting dynamic disk real device path")
 	}
 	if timedOut {
 		return bosherr.WrapErrorf(err, "Timed out resolving device path for %s", diskSetting.ID)
 	}
 
 	symlinkDestination := filepath.Join(p.dirProvider.DataDynamicDisksDir(), diskSetting.ID)
 	if err := p.fs.Symlink(devicePath, symlinkDestination); err != nil {
-		return bosherr.WrapError(err, "Symlinking real device path")
+		return bosherr.WrapError(err, "Symlinking dynamic disk real device path")
+	}
+
+	return nil
+}
+
+func (p linux) CleanupDynamicDisk(diskCID string) error {
+	symlinkDestination := filepath.Join(p.dirProvider.DataDynamicDisksDir(), diskCID)
+	if err := p.fs.RemoveAll(symlinkDestination); err != nil {
+		return bosherr.WrapError(err, "Removing dynamic disk symlink")
 	}
 
 	return nil

platform/linux_platform_test.go

@@ -996,6 +996,25 @@ fake-base-path/data/sys/log/*.log fake-base-path/data/sys/log/.*.log fake-base-p
 		})
 	})
 
+	Describe("CleanupDynamicDisk", func() {
+		BeforeEach(func() {
+			devicePathResolver.GetRealDevicePathStub = func(diskSettings boshsettings.DiskSettings) (string, bool, error) {
+				return diskSettings.Path, false, nil
+			}
+		})
+
+		It("removes dynamic disk symlink", func() {
+			err := platform.SetupDynamicDisk(boshsettings.DiskSettings{ID: "diskID", Path: "/dev/sdb"})
+			Expect(err).NotTo(HaveOccurred())
+
+			err = platform.CleanupDynamicDisk("diskID")
+			Expect(err).NotTo(HaveOccurred())
+
+			sysStats := fs.GetFileTestStat("/fake-dir/data/dynamic_disks/diskID")
+			Expect(sysStats).To(BeNil())
+		})
+	})
+
 	Describe("SetupEphemeralDiskWithPath", func() {
 		var (
 			labelPrefix         string

platform/platform_interface.go

@@ -89,6 +89,7 @@ type Platform interface {
 	IsPersistentDiskMountable(diskSettings boshsettings.DiskSettings) (bool, error)
 	AssociateDisk(name string, settings boshsettings.DiskSettings) error
 	SetupDynamicDisk(diskSetting boshsettings.DiskSettings) error
+	CleanupDynamicDisk(diskCID string) error
 
 	GetFileContentsFromCDROM(filePath string) (contents []byte, err error)
 	GetFilesContentsFromDisk(diskPath string, fileNames []string) (contents [][]byte, err error)

platform/platformfakes/fake_platform.go

@@ -552,6 +552,10 @@ func (p WindowsPlatform) SetupDynamicDisk(diskSetting boshsettings.DiskSettings)
 	return
 }
 
+func (p WindowsPlatform) CleanupDynamicDisk(diskID string) (err error) {
+	return
+}
+
 func (p WindowsPlatform) SetupDataDir(_ boshsettings.JobDir, _ boshsettings.RunDir) error {
 	dataDir := p.dirProvider.DataDir()
 	sysDataDir := filepath.Join(dataDir, "sys")