fix(restore): fix original metadata restoration (#1827)

Fix original metadata restoration

---------

Signed-off-by: Isteb4k <dmitry.rakitin@flant.com>
(cherry picked from commit 6d8d3eb)

Author: Isteb4k

api/core/v1alpha2/events.go

@@ -105,8 +105,6 @@ const (
 	// ReasonVIStorageClassNotFound is event reason that VIStorageClass not found.
 	ReasonVIStorageClassNotFound = "VirtualImageStorageClassNotFound"
 
-	// ReasonMetadataSyncStarted is event reason that Metadata sync is started.
-	ReasonMetadataSyncStarted = "MetadataSyncStarted"
 	// ReasonDataSourceSyncStarted is event reason that DataSource sync is started.
 	ReasonDataSourceSyncStarted = "DataSourceImportStarted"
 	// ReasonDataSourceSyncInProgress is event reason that DataSource sync is in progress.

images/virtualization-artifact/pkg/controller/service/restorer/snapshot_resources.go

@@ -18,15 +18,18 @@ package restorer
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 
+	vsv1 "github.com/kubernetes-csi/external-snapshotter/client/v6/apis/volumesnapshot/v1"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	"github.com/deckhouse/virtualization-controller/pkg/common/annotations"
 	"github.com/deckhouse/virtualization-controller/pkg/common/object"
 	"github.com/deckhouse/virtualization-controller/pkg/controller/service/restorer/common"
 	restorer "github.com/deckhouse/virtualization-controller/pkg/controller/service/restorer/restorers"
@@ -363,6 +366,11 @@ func getVirtualDisks(ctx context.Context, client client.Client, vmSnapshot *v1al
 			},
 		}
 
+		err = AddOriginalMetadata(ctx, &vd, vdSnapshot, client)
+		if err != nil {
+			return nil, fmt.Errorf("add original metadata: %w", err)
+		}
+
 		vds = append(vds, &vd)
 	}
 
@@ -372,3 +380,72 @@ func getVirtualDisks(ctx context.Context, client client.Client, vmSnapshot *v1al
 func (r *SnapshotResources) GetObjectHandlers() []ObjectHandler {
 	return r.objectHandlers
 }
+
+func AddOriginalMetadata(ctx context.Context, vd *v1alpha2.VirtualDisk, vdSnapshot *v1alpha2.VirtualDiskSnapshot, client client.Client) error {
+	vsKey := types.NamespacedName{
+		Namespace: vdSnapshot.Namespace,
+		Name:      vdSnapshot.Status.VolumeSnapshotName,
+	}
+
+	vs, err := object.FetchObject(ctx, vsKey, client, &vsv1.VolumeSnapshot{})
+	if err != nil {
+		return fmt.Errorf("fetch the volume snapshot %q: %w", vsKey.Name, err)
+	}
+
+	if vs == nil {
+		return fmt.Errorf("the volume snapshot %q is nil, please report a bug", vsKey.Name)
+	}
+
+	return errors.Join(
+		setOriginalAnnotations(vd, vs),
+		setOriginalLabels(vd, vs),
+	)
+}
+
+func setOriginalAnnotations(vd *v1alpha2.VirtualDisk, vs *vsv1.VolumeSnapshot) error {
+	if vs == nil || vs.Annotations[annotations.AnnVirtualDiskOriginalAnnotations] == "" {
+		return nil
+	}
+
+	var annotationsMap map[string]string
+	err := json.Unmarshal([]byte(vs.Annotations[annotations.AnnVirtualDiskOriginalAnnotations]), &annotationsMap)
+	if err != nil {
+		return fmt.Errorf("failed to unmarshal the original annotations: %w", err)
+	}
+
+	if vd.Annotations == nil {
+		vd.Annotations = make(map[string]string)
+	}
+
+	for key, value := range annotationsMap {
+		if _, exists := vd.Annotations[key]; !exists {
+			vd.Annotations[key] = value
+		}
+	}
+
+	return nil
+}
+
+func setOriginalLabels(vd *v1alpha2.VirtualDisk, vs *vsv1.VolumeSnapshot) error {
+	if vs == nil || vs.Annotations[annotations.AnnVirtualDiskOriginalLabels] == "" {
+		return nil
+	}
+
+	var labelsMap map[string]string
+	err := json.Unmarshal([]byte(vs.Annotations[annotations.AnnVirtualDiskOriginalLabels]), &labelsMap)
+	if err != nil {
+		return fmt.Errorf("failed to unmarshal the original annotations: %w", err)
+	}
+
+	if vd.Labels == nil {
+		vd.Labels = make(map[string]string)
+	}
+
+	for key, value := range labelsMap {
+		if _, exists := vd.Labels[key]; !exists {
+			vd.Labels[key] = value
+		}
+	}
+
+	return nil
+}

images/virtualization-artifact/pkg/controller/vd/internal/source/object_ref_vdsnapshot.go

@@ -69,7 +69,6 @@ func (ds ObjectRefVirtualDiskSnapshot) Sync(ctx context.Context, vd *v1alpha2.Vi
 	return steptaker.NewStepTakers[*v1alpha2.VirtualDisk](
 		step.NewReadyStep(ds.diskService, pvc, cb),
 		step.NewTerminatingStep(pvc),
-		step.NewAddOriginalMetadataStep(ds.recorder, ds.client, cb),
 		step.NewCreatePVCFromVDSnapshotStep(pvc, ds.recorder, ds.client, cb),
 		step.NewWaitForPVCStep(pvc, ds.client, cb),
 	).Run(ctx, vd)

images/virtualization-artifact/pkg/controller/vd/internal/source/object_ref_vdsnapshot_test.go

@@ -18,7 +18,6 @@ package source
 
 import (
 	"context"
-	"fmt"
 	"log/slog"
 	"testing"
 
@@ -35,7 +34,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 	"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
 
-	"github.com/deckhouse/virtualization-controller/pkg/common/annotations"
 	"github.com/deckhouse/virtualization-controller/pkg/controller/conditions"
 	"github.com/deckhouse/virtualization-controller/pkg/controller/supplements"
 	"github.com/deckhouse/virtualization-controller/pkg/eventrecord"
@@ -275,30 +273,6 @@ var _ = Describe("ObjectRef VirtualDiskSnapshot", func() {
 			Expect(vd.Status.Target.PersistentVolumeClaim).NotTo(BeEmpty())
 		})
 	})
-
-	Context("Virtual disk has annotations and labels", func() {
-		It("checks that the restored virtual disk has its original metadata", func() {
-			key := "key"
-			value := "value"
-			originalMetadata := fmt.Sprintf("{\"%s\":\"%s\"}", key, value)
-
-			vs.Annotations = map[string]string{
-				annotations.AnnVirtualDiskOriginalAnnotations: originalMetadata,
-				annotations.AnnVirtualDiskOriginalLabels:      originalMetadata,
-			}
-
-			client := fake.NewClientBuilder().WithScheme(scheme).WithObjects(vdSnapshot, vs).Build()
-
-			syncer := NewObjectRefVirtualDiskSnapshot(recorder, svc, client)
-
-			res, err := syncer.Sync(ctx, vd)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(res.IsZero()).To(BeTrue())
-
-			Expect(vd.Annotations).To(HaveKeyWithValue(key, value))
-			Expect(vd.Labels).To(HaveKeyWithValue(key, value))
-		})
-	})
 })
 
 func ExpectStats(vd *v1alpha2.VirtualDisk) {

images/virtualization-artifact/pkg/controller/vd/internal/source/step/add_original_metadata_step.go

@@ -35,6 +35,7 @@ import (
 	"github.com/deckhouse/virtualization-controller/pkg/common/object"
 	"github.com/deckhouse/virtualization-controller/pkg/controller/conditions"
 	"github.com/deckhouse/virtualization-controller/pkg/controller/service"
+	svcrestorer "github.com/deckhouse/virtualization-controller/pkg/controller/service/restorer"
 	"github.com/deckhouse/virtualization-controller/pkg/controller/vmrestore/internal/restorer"
 	"github.com/deckhouse/virtualization-controller/pkg/eventrecord"
 	"github.com/deckhouse/virtualization/api/core/v1alpha2"
@@ -443,6 +444,11 @@ func (h LifeCycleHandler) getVirtualDisks(ctx context.Context, vmSnapshot *v1alp
 			},
 		}
 
+		err = svcrestorer.AddOriginalMetadata(ctx, &vd, vdSnapshot, h.client)
+		if err != nil {
+			return nil, fmt.Errorf("add original metadata: %w", err)
+		}
+
 		vds = append(vds, &vd)
 	}