Merge pull request #276 from cybozu-go/fix-expire

Fix expire not running when target PVC is deleted before backup expires

Author: molpako

internal/ceph/ceph.go

@@ -45,6 +45,11 @@ type RBDSnapshot struct {
 	Timestamp RBDTimeStamp `json:"timestamp,omitzero"`
 }
 
+type RBDTrashInfo struct {
+	ID   string `json:"id"`
+	Name string `json:"name"`
+}
+
 type CephCmd interface {
 	RBDClone(pool, srcImage, srcSnap, dstImage, features string) error
 	RBDInfo(pool, image string) (*RBDImageInfo, error)
@@ -54,10 +59,12 @@ type CephCmd interface {
 	RBDLockRm(pool, image string, lock *RBDLock) error
 	RBDRm(pool, image string) error
 	RBDTrashMv(pool, image string) error
+	RBDTrashLs(pool string) ([]*RBDTrashInfo, error)
 	CephRBDTaskAddTrashRemove(pool, image string) error
 	RBDSnapCreate(pool, image, snap string) error
 	RBDSnapLs(pool, image string) ([]RBDSnapshot, error)
-	RBDSnapRm(pool, image, snap string) error
+	RBDSnapLsByID(pool, imageID string) ([]RBDSnapshot, error)
+	RBDSnapRm(pool, imageID, snap string) error
 }
 
 type cephCmdImpl struct {

internal/ceph/ceph_mock.go

@@ -109,6 +109,22 @@ func (c *cephCmdImpl) RBDTrashMv(pool, image string) error {
 	return nil
 }
 
+// RBDTrashLs lists RBD images in trash.
+func (c *cephCmdImpl) RBDTrashLs(pool string) ([]*RBDTrashInfo, error) {
+	stdout, stderr, err := c.command.execute("rbd", "trash", "ls", "-p", pool, "--format", "json")
+	if err != nil {
+		return nil, fmt.Errorf("failed to list RBD images in trash: %w, stderr: %s", err, string(stderr))
+	}
+
+	var trashInfos []*RBDTrashInfo
+	err = json.Unmarshal(stdout, &trashInfos)
+	if err != nil {
+		return nil, fmt.Errorf("failed to unmarshal RBD trash info: %w, stdout: %s", err, stdout)
+	}
+
+	return trashInfos, nil
+}
+
 // CephRBDTaskTrashRemove adds a task to remove the image from trash.
 func (c *cephCmdImpl) CephRBDTaskAddTrashRemove(pool, imageID string) error {
 	_, stderr, err := c.command.execute("ceph", "rbd", "task", "add", "trash", "remove", fmt.Sprintf("%s/%s", pool, imageID))
@@ -145,9 +161,25 @@ func (c *cephCmdImpl) RBDSnapLs(pool, image string) ([]RBDSnapshot, error) {
 	return snapshots, nil
 }
 
+// RBDSnapLsByID lists RBD snapshots of an image by image ID.
+func (c *cephCmdImpl) RBDSnapLsByID(pool, imageID string) ([]RBDSnapshot, error) {
+	stdout, stderr, err := c.command.execute("rbd", "snap", "ls", "-p", pool, "--image-id", imageID, "--format", "json")
+	if err != nil {
+		return nil, fmt.Errorf("failed to list RBD snapshots: %w, stderr: %s", err, string(stderr))
+	}
+
+	var snapshots []RBDSnapshot
+	err = json.Unmarshal(stdout, &snapshots)
+	if err != nil {
+		return nil, fmt.Errorf("failed to unmarshal RBD snapshots: %w, stdout: %s", err, stdout)
+	}
+
+	return snapshots, nil
+}
+
 // RBDSnapRm removes an RBD snapshot.
-func (c *cephCmdImpl) RBDSnapRm(pool, image, snap string) error {
-	_, stderr, err := c.command.execute("rbd", "snap", "rm", fmt.Sprintf("%s/%s@%s", pool, image, snap))
+func (c *cephCmdImpl) RBDSnapRm(pool, imageID, snap string) error {
+	_, stderr, err := c.command.execute("rbd", "snap", "rm", "-p", pool, "--image-id", imageID, "--snap", snap)
 	if err != nil {
 		return fmt.Errorf("failed to remove RBD snapshot: %w, stderr: %s", err, string(stderr))
 	}

internal/ceph/rbd.go

@@ -309,6 +309,59 @@ var _ = Describe("CephCmd.RBDRm", func() {
 	})
 })
 
+var _ = Describe("CephCmd.RBDTrashLs", func() {
+	var t reporter
+
+	It("should return the correct list of trashed images", func() {
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		m := NewMockcommand(ctrl)
+		m.EXPECT().
+			execute("rbd", "trash", "ls", "-p", "pool", "--format", "json").
+			Return([]byte(`[
+				{"id": "abc123", "name": "csi-vol-d2556cc0-5ba6-4e70-b966-56522225bdc5"},
+				{"id": "def456", "name": "csi-vol-f2a83492-3cf2-48e7-8500-804754c42ce6"}
+			]`), []byte{}, nil)
+
+		cmd := mockedCephCmd(m)
+		infos, err := cmd.RBDTrashLs("pool")
+		Expect(err).ToNot(HaveOccurred())
+		Expect(infos).To(HaveLen(2))
+		Expect(infos[0].ID).To(Equal("abc123"))
+		Expect(infos[0].Name).To(Equal("csi-vol-d2556cc0-5ba6-4e70-b966-56522225bdc5"))
+		Expect(infos[1].ID).To(Equal("def456"))
+		Expect(infos[1].Name).To(Equal("csi-vol-f2a83492-3cf2-48e7-8500-804754c42ce6"))
+	})
+
+	It("should return empty list, if trash is empty", func() {
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		m := NewMockcommand(ctrl)
+		m.EXPECT().
+			execute("rbd", "trash", "ls", "-p", "pool", "--format", "json").
+			Return([]byte(`[]`), []byte{}, nil)
+
+		cmd := mockedCephCmd(m)
+		infos, err := cmd.RBDTrashLs("pool")
+		Expect(err).ToNot(HaveOccurred())
+		Expect(infos).To(BeEmpty())
+	})
+
+	It("should return an error, if the command failed", func() {
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		m := NewMockcommand(ctrl)
+		m.EXPECT().execute(gomock.Any()).Return([]byte{}, []byte("error!"), errors.New("error"))
+
+		cmd := mockedCephCmd(m)
+		_, err := cmd.RBDTrashLs("pool")
+		Expect(err).To(HaveOccurred())
+	})
+})
+
 var _ = Describe("CephCmd.RBDSnapCreate", func() {
 	var t reporter
 
@@ -378,6 +431,45 @@ var _ = Describe("CephCmd.RBDSnapLs", func() {
 	})
 })
 
+var _ = Describe("CephCmd.RBDSnapLsByID", func() {
+	var t reporter
+
+	It("should return the correct RBDSnapshot", func() {
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		m := NewMockcommand(ctrl)
+		m.EXPECT().
+			execute("rbd", "snap", "ls", "-p", "pool", "--image-id", "image-id", "--format", "json").
+			Return([]byte(`
+		[{"id":4,"name":"test","size":10737418240,"protected":"false","timestamp":"Tue Oct  1 10:11:31 2024"}]
+		`), []byte{}, nil)
+
+		cmd := mockedCephCmd(m)
+		snaps, err := cmd.RBDSnapLsByID("pool", "image-id")
+		Expect(err).ToNot(HaveOccurred())
+		Expect(snaps).To(HaveLen(1))
+		snap := snaps[0]
+		Expect(snap.Id).To(Equal(int(4)))
+		Expect(snap.Name).To(Equal("test"))
+		Expect(snap.Size).To(Equal(int64(10737418240)))
+		Expect(snap.Protected).To(BeFalse())
+		Expect(snap.Timestamp).To(Equal(NewRBDTimeStamp(time.Date(2024, 10, 1, 10, 11, 31, 0, time.UTC))))
+	})
+
+	It("should return an error, if the command failed", func() {
+		ctrl := gomock.NewController(t)
+		defer ctrl.Finish()
+
+		m := NewMockcommand(ctrl)
+		m.EXPECT().execute(gomock.Any()).Return([]byte{}, []byte("error!"), errors.New("error"))
+
+		cmd := mockedCephCmd(m)
+		_, err := cmd.RBDSnapLsByID("pool", "image-id")
+		Expect(err).To(HaveOccurred())
+	})
+})
+
 var _ = Describe("CephCmd.RBDSnapRm", func() {
 	var t reporter
 
@@ -387,11 +479,11 @@ var _ = Describe("CephCmd.RBDSnapRm", func() {
 
 		m := NewMockcommand(ctrl)
 		m.EXPECT().
-			execute("rbd", "snap", "rm", "pool/image@snap").
+			execute("rbd", "snap", "rm", "-p", "pool", "--image-id", "image-id", "--snap", "snap").
 			Return([]byte{}, []byte{}, nil)
 
 		cmd := mockedCephCmd(m)
-		err := cmd.RBDSnapRm("pool", "image", "snap")
+		err := cmd.RBDSnapRm("pool", "image-id", "snap")
 		Expect(err).ToNot(HaveOccurred())
 	})
 
@@ -403,7 +495,7 @@ var _ = Describe("CephCmd.RBDSnapRm", func() {
 		m.EXPECT().execute(gomock.Any()).Return([]byte{}, []byte("error!"), errors.New("error"))
 
 		cmd := mockedCephCmd(m)
-		err := cmd.RBDSnapRm("pool", "image", "snap")
+		err := cmd.RBDSnapRm("pool", "image-id", "snap")
 		Expect(err).To(HaveOccurred())
 	})
 })