Adding resource name in cloudevent (#139)

We need this so work agent can handle
unmanaged manifestwork correctly.

Signed-off-by: Jian Qiu <jqiu@redhat.com>

Author: qiujian16

pkg/cloudevents/clients/work/agent/codec/manifestbundle.go

@@ -62,6 +62,7 @@ func (c *ManifestBundleCodec) Encode(source string, eventType types.CloudEventsT
 	evt := types.NewEventBuilder(source, eventType).
 		WithResourceID(string(work.UID)).
 		WithStatusUpdateSequenceID(sequenceGenerator.Generate().String()).
+		WithResourceName(work.Name).
 		WithResourceVersion(resourceVersion).
 		WithClusterName(work.Namespace).
 		WithOriginalSource(originalSource).
@@ -104,6 +105,17 @@ func (c *ManifestBundleCodec) Decode(evt *cloudevents.Event) (*workv1.ManifestWo
 		return nil, fmt.Errorf("failed to get resourceid extension: %v", err)
 	}
 
+	var resourceName string
+	if v, ok := evtExtensions[types.ExtensionResourceName]; ok {
+		resourceName, err = cloudeventstypes.ToString(v)
+		if err != nil {
+			return nil, fmt.Errorf("failed to get resourcename extension: %v", err)
+		}
+	} else {
+		// fall back to set resourceName to resourceID
+		resourceName = resourceID
+	}
+
 	resourceVersion, err := cloudeventstypes.ToInteger(evtExtensions[types.ExtensionResourceVersion])
 	if err != nil {
 		return nil, fmt.Errorf("failed to get resourceversion extension: %v", err)
@@ -123,7 +135,7 @@ func (c *ManifestBundleCodec) Decode(evt *cloudevents.Event) (*workv1.ManifestWo
 			UID:             kubetypes.UID(resourceID),
 			Generation:      int64(resourceVersion),
 			ResourceVersion: fmt.Sprintf("%d", resourceVersion),
-			Name:            resourceID,
+			Name:            resourceName,
 			Namespace:       clusterName,
 			Labels: map[string]string{
 				common.CloudEventsOriginalSourceLabelKey: evt.Source(),

pkg/cloudevents/clients/work/agent/codec/manifestbundle_test.go

@@ -159,6 +159,7 @@ func TestManifestBundleDecode(t *testing.T) {
 				evt.SetType("io.open-cluster-management.works.v1alpha1.manifestbundles.spec.test")
 				evt.SetExtension("resourceid", "test")
 				evt.SetExtension("resourceversion", "13")
+				evt.SetExtension("resourcename", "work1")
 				return &evt
 			}(),
 			expectedErr: true,
@@ -171,6 +172,7 @@ func TestManifestBundleDecode(t *testing.T) {
 				evt.SetType("io.open-cluster-management.works.v1alpha1.manifestbundles.spec.test")
 				evt.SetExtension("resourceid", "test")
 				evt.SetExtension("resourceversion", "13")
+				evt.SetExtension("resourcename", "work1")
 				return &evt
 			}(),
 			expectedErr: true,
@@ -184,6 +186,7 @@ func TestManifestBundleDecode(t *testing.T) {
 				evt.SetExtension("resourceid", "test")
 				evt.SetExtension("resourceversion", "13")
 				evt.SetExtension("clustername", "cluster1")
+				evt.SetExtension("resourcename", "work1")
 				evt.SetExtension("deletiontimestamp", "1985-04-12T23:20:50.52Z")
 				return &evt
 			}(),
@@ -197,6 +200,7 @@ func TestManifestBundleDecode(t *testing.T) {
 				evt.SetExtension("resourceid", "test")
 				evt.SetExtension("resourceversion", "13")
 				evt.SetExtension("clustername", "cluster1")
+				evt.SetExtension("resourcename", "work1")
 				if err := evt.SetData(cloudevents.ApplicationJSON, &payload.ManifestBundle{}); err != nil {
 					t.Fatal(err)
 				}
@@ -206,6 +210,30 @@ func TestManifestBundleDecode(t *testing.T) {
 		},
 		{
 			name: "decode a cloudevent",
+			event: func() *cloudevents.Event {
+				evt := cloudevents.NewEvent()
+				evt.SetSource("source1")
+				evt.SetType("io.open-cluster-management.works.v1alpha1.manifestbundles.spec.test")
+				evt.SetExtension("resourceid", "test")
+				evt.SetExtension("resourceversion", "13")
+				evt.SetExtension("clustername", "cluster1")
+				evt.SetExtension("resourcename", "work1")
+				if err := evt.SetData(cloudevents.ApplicationJSON, &payload.ManifestBundle{
+					Manifests: []workv1.Manifest{
+						{
+							RawExtension: runtime.RawExtension{
+								Raw: toConfigMap(t),
+							},
+						},
+					},
+				}); err != nil {
+					t.Fatal(err)
+				}
+				return &evt
+			}(),
+		},
+		{
+			name: "decode a cloudevent with empty resourceName",
 			event: func() *cloudevents.Event {
 				evt := cloudevents.NewEvent()
 				evt.SetSource("source1")

pkg/cloudevents/clients/work/source/codec/manifestbundle.go

@@ -47,6 +47,7 @@ func (c *ManifestBundleCodec) Encode(source string, eventType types.CloudEventsT
 	evt := types.NewEventBuilder(source, eventType).
 		WithClusterName(work.Namespace).
 		WithResourceID(string(work.UID)).
+		WithResourceName(work.Name).
 		WithResourceVersion(int64(resourceVersion)).
 		NewEvent()
 
@@ -92,6 +93,17 @@ func (c *ManifestBundleCodec) Decode(evt *cloudevents.Event) (*workv1.ManifestWo
 		return nil, fmt.Errorf("failed to get resourceid extension: %v", err)
 	}
 
+	var resourceName string
+	if v, ok := evtExtensions[types.ExtensionResourceName]; ok {
+		resourceName, err = cloudeventstypes.ToString(v)
+		if err != nil {
+			return nil, fmt.Errorf("failed to get resourcename extension: %v", err)
+		}
+	} else {
+		// fall back to set resourceName to resourceID
+		resourceName = resourceID
+	}
+
 	resourceVersion, err := cloudeventstypes.ToInteger(evtExtensions[types.ExtensionResourceVersion])
 	if err != nil {
 		return nil, fmt.Errorf("failed to get resourceversion extension: %v", err)
@@ -119,6 +131,7 @@ func (c *ManifestBundleCodec) Decode(evt *cloudevents.Event) (*workv1.ManifestWo
 	}
 
 	metaObj.UID = kubetypes.UID(resourceID)
+	metaObj.Name = resourceName
 	metaObj.ResourceVersion = fmt.Sprintf("%d", resourceVersion)
 	if metaObj.Annotations == nil {
 		metaObj.Annotations = map[string]string{}

pkg/cloudevents/clients/work/source/codec/manifestbundle_test.go

@@ -123,6 +123,46 @@ func TestManifestBundleDecode(t *testing.T) {
 			}(),
 			expectedErr: true,
 		},
+		{
+			name: "decode a manifestbundle status cloudevent with unset resourceName",
+			event: func() *cloudevents.Event {
+				evt := cloudevents.NewEvent()
+				evt.SetSource("source1")
+				evt.SetType("io.open-cluster-management.works.v1alpha1.manifestbundles.status.test")
+				evt.SetExtension("resourceid", "test")
+				evt.SetExtension("resourceversion", "13")
+				evt.SetExtension("sequenceid", "1834773391719010304")
+				if err := evt.SetData(cloudevents.ApplicationJSON, &payload.ManifestBundleStatus{
+					Conditions: []metav1.Condition{
+						{
+							Type:   "Test",
+							Status: metav1.ConditionTrue,
+						},
+					},
+				}); err != nil {
+					t.Fatal(err)
+				}
+				return &evt
+			}(),
+			expectedWork: &workv1.ManifestWork{
+				ObjectMeta: metav1.ObjectMeta{
+					UID:             kubetypes.UID("test"),
+					ResourceVersion: "13",
+					Annotations: map[string]string{
+						"cloudevents.open-cluster-management.io/sequenceid": "1834773391719010304",
+					},
+					Name: "test",
+				},
+				Status: workv1.ManifestWorkStatus{
+					Conditions: []metav1.Condition{
+						{
+							Type:   "Test",
+							Status: metav1.ConditionTrue,
+						},
+					},
+				},
+			},
+		},
 		{
 			name: "decode a manifestbundle status cloudevent",
 			event: func() *cloudevents.Event {
@@ -131,6 +171,7 @@ func TestManifestBundleDecode(t *testing.T) {
 				evt.SetType("io.open-cluster-management.works.v1alpha1.manifestbundles.status.test")
 				evt.SetExtension("resourceid", "test")
 				evt.SetExtension("resourceversion", "13")
+				evt.SetExtension("resourcename", "work1")
 				evt.SetExtension("sequenceid", "1834773391719010304")
 				if err := evt.SetData(cloudevents.ApplicationJSON, &payload.ManifestBundleStatus{
 					Conditions: []metav1.Condition{
@@ -151,6 +192,7 @@ func TestManifestBundleDecode(t *testing.T) {
 					Annotations: map[string]string{
 						"cloudevents.open-cluster-management.io/sequenceid": "1834773391719010304",
 					},
+					Name: "work1",
 				},
 				Status: workv1.ManifestWorkStatus{
 					Conditions: []metav1.Condition{
@@ -181,6 +223,7 @@ func TestManifestBundleDecode(t *testing.T) {
 				evt.SetSource("source1")
 				evt.SetType("io.open-cluster-management.works.v1alpha1.manifestbundles.status.test")
 				evt.SetExtension("resourceid", "test")
+				evt.SetExtension("resourcename", "work1")
 				evt.SetExtension("resourceversion", "13")
 				evt.SetExtension("metadata", string(metaJson))
 				evt.SetExtension("sequenceid", "1834773391719010304")
@@ -224,7 +267,7 @@ func TestManifestBundleDecode(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					UID:             kubetypes.UID("test"),
 					ResourceVersion: "13",
-					Name:            "test",
+					Name:            "work1",
 					Namespace:       "cluster1",
 					Labels:          map[string]string{"test1": "test1"},
 					Annotations: map[string]string{

pkg/cloudevents/generic/types/types.go

@@ -57,6 +57,9 @@ const (
 	// ExtensionResourceID is the cloud event extension key of the resource ID.
 	ExtensionResourceID = "resourceid"
 
+	// ExtensionResourceName is the cloud event extension key of the resource name.
+	ExtensionResourceName = "resourcename"
+
 	// ExtensionResourceVersion is the cloud event extension key of the resource version.
 	ExtensionResourceVersion = "resourceversion"
 
@@ -228,6 +231,7 @@ type EventBuilder struct {
 	clusterName       string
 	originalSource    string
 	resourceID        string
+	resourceName      string
 	sequenceID        string
 	resourceVersion   *int64
 	eventType         CloudEventsType
@@ -246,6 +250,11 @@ func (b *EventBuilder) WithResourceID(resourceID string) *EventBuilder {
 	return b
 }
 
+func (b *EventBuilder) WithResourceName(resourceName string) *EventBuilder {
+	b.resourceName = resourceName
+	return b
+}
+
 func (b *EventBuilder) WithResourceVersion(resourceVersion int64) *EventBuilder {
 	b.resourceVersion = &resourceVersion
 	return b
@@ -285,6 +294,13 @@ func (b *EventBuilder) NewEvent() cloudevents.Event {
 		evt.SetExtension(ExtensionResourceID, b.resourceID)
 	}
 
+	if len(b.resourceName) != 0 {
+		evt.SetExtension(ExtensionResourceName, b.resourceName)
+	} else {
+		// if resourceName is not set, uses resourceID as the resourceName
+		evt.SetExtension(ExtensionResourceName, b.resourceID)
+	}
+
 	if b.resourceVersion != nil {
 		evt.SetExtension(ExtensionResourceVersion, *b.resourceVersion)
 	}

test/integration/cloudevents/garbagecollector_test.go

@@ -18,8 +18,6 @@ import (
 
 	workv1informers "open-cluster-management.io/api/client/work/informers/externalversions/work/v1"
 
-	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/common"
-	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/utils"
 	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work"
 	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work/agent/codec"
 	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work/garbagecollector"
@@ -161,21 +159,19 @@ var _ = ginkgo.Describe("Garbage Collector Test", func() {
 			ginkgo.By("agent update the work status", func() {
 				gomega.Eventually(func() error {
 					workClient := agentClientHolder.ManifestWorks(clusterName)
-					workID1 := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, workName1)
-					if err := util.AddWorkFinalizer(ctx, workClient, workID1); err != nil {
+					if err := util.AddWorkFinalizer(ctx, workClient, workName1); err != nil {
 						return err
 					}
 
-					if err := util.UpdateWorkStatus(ctx, workClient, workID1, util.WorkCreatedCondition); err != nil {
+					if err := util.UpdateWorkStatus(ctx, workClient, workName1, util.WorkCreatedCondition); err != nil {
 						return err
 					}
 
-					workID2 := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, workName2)
-					if err := util.AddWorkFinalizer(ctx, workClient, workID2); err != nil {
+					if err := util.AddWorkFinalizer(ctx, workClient, workName2); err != nil {
 						return err
 					}
 
-					return util.UpdateWorkStatus(ctx, workClient, workID2, util.WorkCreatedCondition)
+					return util.UpdateWorkStatus(ctx, workClient, workName2, util.WorkCreatedCondition)
 				}, 10*time.Second, 1*time.Second).Should(gomega.Succeed())
 			})
 
@@ -198,8 +194,7 @@ var _ = ginkgo.Describe("Garbage Collector Test", func() {
 
 			ginkgo.By("agent delete the first work with single owner", func() {
 				gomega.Eventually(func() error {
-					workID1 := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, workName1)
-					return util.RemoveWorkFinalizer(ctx, agentClientHolder.ManifestWorks(clusterName), workID1)
+					return util.RemoveWorkFinalizer(ctx, agentClientHolder.ManifestWorks(clusterName), workName1)
 				}, 30*time.Second, 1*time.Second).Should(gomega.Succeed())
 			})
 
@@ -230,8 +225,7 @@ var _ = ginkgo.Describe("Garbage Collector Test", func() {
 
 			ginkgo.By("agent delete the work with two owners", func() {
 				gomega.Eventually(func() error {
-					workID2 := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, workName2)
-					return util.RemoveWorkFinalizer(ctx, agentClientHolder.ManifestWorks(clusterName), workID2)
+					return util.RemoveWorkFinalizer(ctx, agentClientHolder.ManifestWorks(clusterName), workName2)
 				}, 30*time.Second, 1*time.Second).Should(gomega.Succeed())
 			})
 

test/integration/cloudevents/manifestworkclients_informer_test.go

@@ -12,8 +12,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/rand"
 
-	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/common"
-	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/utils"
 	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work"
 	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work/agent/codec"
 	"open-cluster-management.io/sdk-go/test/integration/cloudevents/agent"
@@ -104,13 +102,12 @@ func crudManifestWork(
 	ginkgo.By("agent update the work status", func() {
 		gomega.Eventually(func() error {
 			workClient := agentClientHolder.ManifestWorks(clusterName)
-			workID := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, workName)
 
-			if err := util.AddWorkFinalizer(ctx, workClient, workID); err != nil {
+			if err := util.AddWorkFinalizer(ctx, workClient, workName); err != nil {
 				return err
 			}
 
-			return util.UpdateWorkStatus(ctx, workClient, workID, util.WorkCreatedCondition)
+			return util.UpdateWorkStatus(ctx, workClient, workName, util.WorkCreatedCondition)
 		}, 10*time.Second, 1*time.Second).Should(gomega.Succeed())
 	})
 
@@ -128,12 +125,11 @@ func crudManifestWork(
 	ginkgo.By("agent update the work status again", func() {
 		gomega.Eventually(func() error {
 			workClient := agentClientHolder.ManifestWorks(clusterName)
-			workID := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, workName)
-			if err := util.AssertUpdatedWork(ctx, workClient, workID); err != nil {
+			if err := util.AssertUpdatedWork(ctx, workClient, workName); err != nil {
 				return err
 			}
 
-			return util.UpdateWorkStatus(ctx, workClient, workID, util.WorkUpdatedCondition)
+			return util.UpdateWorkStatus(ctx, workClient, workName, util.WorkUpdatedCondition)
 		}, 10*time.Second, 1*time.Second).Should(gomega.Succeed())
 	})
 
@@ -150,9 +146,8 @@ func crudManifestWork(
 
 	ginkgo.By("agent delete the work", func() {
 		gomega.Eventually(func() error {
-			workID := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, workName)
 			workClient := agentClientHolder.ManifestWorks(clusterName)
-			return util.RemoveWorkFinalizer(ctx, workClient, workID)
+			return util.RemoveWorkFinalizer(ctx, workClient, workName)
 		}, 10*time.Second, 1*time.Second).Should(gomega.Succeed())
 	})
 

test/integration/cloudevents/manifestworkclients_reync_test.go

@@ -46,16 +46,18 @@ var _ = ginkgo.Describe("ManifestWork Clients Test - Resync", func() {
 
 			// add two works in the agent cache
 			store := informer.Informer().GetStore()
-			work1UID := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, fmt.Sprintf("%s-1", workNamePrefix))
-			work1 := util.NewManifestWorkWithStatus(clusterName, work1UID)
+			work1Name := fmt.Sprintf("%s-1", workNamePrefix)
+			work1UID := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, work1Name)
+			work1 := util.NewManifestWorkWithStatus(clusterName, work1Name)
 			work1.UID = apitypes.UID(work1UID)
 			work1.ResourceVersion = "1"
 			work1.Labels = map[string]string{common.CloudEventsOriginalSourceLabelKey: sourceID}
 			work1.Annotations = map[string]string{common.CloudEventsDataTypeAnnotationKey: payload.ManifestBundleEventDataType.String()}
 			gomega.Expect(store.Add(work1)).ToNot(gomega.HaveOccurred())
 
-			work2UID := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, fmt.Sprintf("%s-2", workNamePrefix))
-			work2 := util.NewManifestWorkWithStatus(clusterName, work2UID)
+			work2Name := fmt.Sprintf("%s-2", workNamePrefix)
+			work2UID := utils.UID(sourceID, common.ManifestWorkGR.String(), clusterName, work2Name)
+			work2 := util.NewManifestWorkWithStatus(clusterName, work2Name)
 			work2.UID = apitypes.UID(work2UID)
 			work2.ResourceVersion = "1"
 			work2.Labels = map[string]string{common.CloudEventsOriginalSourceLabelKey: sourceID}