state: add VolumeGroupSnapshot APIs

Author: nixpanic

pkg/state/state.go

@@ -58,12 +58,21 @@ type Volume struct {
 }
 
 type Snapshot struct {
+	Name            string
+	Id              string
+	VolID           string
+	Path            string
+	CreationTime    *timestamp.Timestamp
+	SizeBytes       int64
+	ReadyToUse      bool
+	GroupSnapshotID string
+}
+
+type GroupSnapshot struct {
 	Name         string
 	Id           string
-	VolID        string
-	Path         string
+	SnapshotIDs  []string
 	CreationTime *timestamp.Timestamp
-	SizeBytes    int64
 	ReadyToUse   bool
 }
 
@@ -112,11 +121,32 @@ type State interface {
 	// snapshot ID. It is not an error when such a snapshot
 	// does not exist.
 	DeleteSnapshot(snapshotID string) error
+
+	// GetGroupSnapshotByID retrieves a groupsnapshot by its unique ID or
+	// returns an error including that ID when not found.
+	GetGroupSnapshotByID(vgsID string) (GroupSnapshot, error)
+
+	// GetGroupSnapshotByName retrieves a groupsnapshot by its name or
+	// returns an error including that name when not found.
+	GetGroupSnapshotByName(volName string) (GroupSnapshot, error)
+
+	// GetGroupSnapshots returns all currently existing groupsnapshots.
+	GetGroupSnapshots() []GroupSnapshot
+
+	// UpdateGroupSnapshot updates the existing hostpath groupsnapshot,
+	// identified by its snapshot ID, or adds it if it does not exist yet.
+	UpdateGroupSnapshot(snapshot GroupSnapshot) error
+
+	// DeleteGroupSnapshot deletes the groupsnapshot with the given
+	// groupsnapshot ID. It is not an error when such a groupsnapshot does
+	// not exist.
+	DeleteGroupSnapshot(groupSnapshotID string) error
 }
 
 type resources struct {
-	Volumes   []Volume
-	Snapshots []Snapshot
+	Volumes        []Volume
+	Snapshots      []Snapshot
+	GroupSnapshots []GroupSnapshot
 }
 
 type state struct {
@@ -257,3 +287,50 @@ func (s *state) DeleteSnapshot(snapshotID string) error {
 	}
 	return nil
 }
+
+func (s *state) GetGroupSnapshotByID(groupSnapshotID string) (GroupSnapshot, error) {
+	for _, groupSnapshot := range s.GroupSnapshots {
+		if groupSnapshot.Id == groupSnapshotID {
+			return groupSnapshot, nil
+		}
+	}
+	return GroupSnapshot{}, status.Errorf(codes.NotFound, "groupsnapshot id %s does not exist in the groupsnapshots list", groupSnapshotID)
+}
+
+func (s *state) GetGroupSnapshotByName(name string) (GroupSnapshot, error) {
+	for _, groupSnapshot := range s.GroupSnapshots {
+		if groupSnapshot.Name == name {
+			return groupSnapshot, nil
+		}
+	}
+	return GroupSnapshot{}, status.Errorf(codes.NotFound, "groupsnapshot name %s does not exist in the groupsnapshots list", name)
+}
+
+func (s *state) GetGroupSnapshots() []GroupSnapshot {
+	groupSnapshots := make([]GroupSnapshot, len(s.GroupSnapshots))
+	for i, groupSnapshot := range s.GroupSnapshots {
+		groupSnapshots[i] = groupSnapshot
+	}
+	return groupSnapshots
+}
+
+func (s *state) UpdateGroupSnapshot(update GroupSnapshot) error {
+	for i, groupSnapshot := range s.GroupSnapshots {
+		if groupSnapshot.Id == update.Id {
+			s.GroupSnapshots[i] = update
+			return s.dump()
+		}
+	}
+	s.GroupSnapshots = append(s.GroupSnapshots, update)
+	return s.dump()
+}
+
+func (s *state) DeleteGroupSnapshot(groupSnapshotID string) error {
+	for i, groupSnapshot := range s.GroupSnapshots {
+		if groupSnapshot.Id == groupSnapshotID {
+			s.GroupSnapshots = append(s.GroupSnapshots[:i], s.GroupSnapshots[i+1:]...)
+			return s.dump()
+		}
+	}
+	return nil
+}

pkg/state/state_test.go

@@ -124,3 +124,34 @@ func TestSnapshotsFromSameSource(t *testing.T) {
 	_, err = s.GetSnapshotByName("bar-name")
 	require.NoError(t, err, "get existing snapshot by name 'bar-name'")
 }
+
+func TestVolumeGroupSnapshots(t *testing.T) {
+	tmp := t.TempDir()
+	statefileName := path.Join(tmp, "state.json")
+
+	s, err := New(statefileName)
+	require.NoError(t, err, "construct state")
+	require.Empty(t, s.GetGroupSnapshots(), "initial groupsnapshots")
+
+	_, err = s.GetGroupSnapshotByID("foo")
+	require.Equal(t, codes.NotFound, status.Convert(err).Code(), "GetSnapshotByID of non-existent groupsnapshot")
+	require.Contains(t, status.Convert(err).Message(), "foo")
+
+	err = s.UpdateGroupSnapshot(GroupSnapshot{Id: "foo", Name: "bar"})
+	require.NoError(t, err, "add groupsnapshot")
+
+	s, err = New(statefileName)
+	require.NoError(t, err, "reconstruct state")
+	_, err = s.GetGroupSnapshotByID("foo")
+	require.NoError(t, err, "get existing groupsnapshot by ID")
+	_, err = s.GetGroupSnapshotByName("bar")
+	require.NoError(t, err, "get existing groupsnapshot by name")
+
+	err = s.DeleteGroupSnapshot("foo")
+	require.NoError(t, err, "delete existing groupsnapshot")
+
+	err = s.DeleteGroupSnapshot("foo")
+	require.NoError(t, err, "delete non-existent groupsnapshot")
+
+	require.Empty(t, s.GetGroupSnapshots(), "final groupsnapshots")
+}