rename manifest to payload

Signed-off-by: clyang82 <[email protected]>

cmd/maestro/server/grpc_server.go

@@ -226,11 +226,11 @@ func decode(eventDataType types.CloudEventsDataType, evt *ce.Event) (*api.Resour
 		resource.Meta.DeletedAt.Time = deletionTimestamp
 	}
 
-	manifest, err := api.CloudEventToJSONMap(evt)
+	payload, err := api.CloudEventToJSONMap(evt)
 	if err != nil {
-		return nil, fmt.Errorf("failed to convert cloudevent to resource manifest: %v", err)
+		return nil, fmt.Errorf("failed to convert cloudevent to resource payload: %v", err)
 	}
-	resource.Manifest = manifest
+	resource.Payload = payload
 
 	switch eventDataType {
 	case workpayload.ManifestEventDataType:

pkg/api/presenters/resource.go

@@ -14,7 +14,7 @@ import (
 
 // ConvertResource converts a resource from the API to the openapi representation.
 func ConvertResource(resource openapi.Resource) (*api.Resource, error) {
-	manifest, err := ConvertResourceManifest(resource.Manifest, resource.DeleteOption, resource.UpdateStrategy)
+	payload, err := ConvertResourceManifest(resource.Manifest, resource.DeleteOption, resource.UpdateStrategy)
 	if err != nil {
 		return nil, err
 	}
@@ -26,9 +26,9 @@ func ConvertResource(resource openapi.Resource) (*api.Resource, error) {
 		ConsumerName: util.NilToEmptyString(resource.ConsumerName),
 		Version:      util.NilToEmptyInt32(resource.Version),
 		// Set the default source ID for RESTful API calls and do not allow modification
-		Source:   constants.DefaultSourceID,
-		Type:     api.ResourceTypeSingle,
-		Manifest: manifest,
+		Source:  constants.DefaultSourceID,
+		Type:    api.ResourceTypeSingle,
+		Payload: payload,
 	}, nil
 }
 
@@ -39,7 +39,7 @@ func ConvertResourceManifest(manifest, deleteOption, updateStrategy map[string]i
 
 // PresentResource converts a resource from the API to the openapi representation.
 func PresentResource(resource *api.Resource) (*openapi.Resource, error) {
-	manifest, deleteOption, updateStrategy, err := api.DecodeManifest(resource.Manifest)
+	manifest, deleteOption, updateStrategy, err := api.DecodeManifest(resource.Payload)
 	if err != nil {
 		return nil, err
 	}
@@ -66,7 +66,7 @@ func PresentResource(resource *api.Resource) (*openapi.Resource, error) {
 
 // PresentResourceBundle converts a resource from the API to the openapi representation.
 func PresentResourceBundle(resource *api.Resource) (*openapi.ResourceBundle, error) {
-	manifestBundle, err := api.DecodeManifestBundle(resource.Manifest)
+	manifestBundle, err := api.DecodeManifestBundle(resource.Payload)
 	if err != nil {
 		return nil, err
 	}

pkg/api/resource_types.go

@@ -31,7 +31,7 @@ type Resource struct {
 	Source       string
 	ConsumerName string
 	Type         ResourceType
-	Manifest     datatypes.JSONMap
+	Payload      datatypes.JSONMap
 	Status       datatypes.JSONMap
 	// Name must be unique and not null, it can be treated as the resource external ID.
 	// The format of the name should be follow the RFC 1123 (same as the k8s namespace).

pkg/client/cloudevents/bundle_codec.go

@@ -23,9 +23,9 @@ func (codec *BundleCodec) EventDataType() cetypes.CloudEventsDataType {
 }
 
 func (codec *BundleCodec) Encode(source string, eventType cetypes.CloudEventsType, res *api.Resource) (*cloudevents.Event, error) {
-	evt, err := api.JSONMAPToCloudEvent(res.Manifest)
+	evt, err := api.JSONMAPToCloudEvent(res.Payload)
 	if err != nil {
-		return nil, fmt.Errorf("failed to convert resource manifest to cloudevent: %v", err)
+		return nil, fmt.Errorf("failed to convert resource payload to cloudevent: %v", err)
 	}
 
 	evt.SetSource(source)

pkg/client/cloudevents/codec.go

@@ -23,9 +23,9 @@ func (codec *Codec) EventDataType() cetypes.CloudEventsDataType {
 }
 
 func (codec *Codec) Encode(source string, eventType cetypes.CloudEventsType, res *api.Resource) (*cloudevents.Event, error) {
-	evt, err := api.JSONMAPToCloudEvent(res.Manifest)
+	evt, err := api.JSONMAPToCloudEvent(res.Payload)
 	if err != nil {
-		return nil, fmt.Errorf("failed to convert resource manifest to cloudevent: %v", err)
+		return nil, fmt.Errorf("failed to convert resource payload to cloudevent: %v", err)
 	}
 
 	evt.SetSource(source)

pkg/db/migrations/202311151850_add_resources.go

@@ -18,8 +18,8 @@ func addResources() *gormigrate.Migration {
 		// "Single" resource type for RESTful API calls,
 		// "Bundle" resource type mainly for gRPC calls.
 		Type string `gorm:"index"`
-		// Manifest holds the resource manifest in CloudEvent format (JSON representation).
-		Manifest datatypes.JSON `gorm:"type:json"`
+		// Payload is CloudEvent payload with CloudEvent format (JSON representation).
+		Payload datatypes.JSON `gorm:"type:json"`
 		// Status represents the resource status in CloudEvent format (JSON representation).
 		Status datatypes.JSON `gorm:"type:json"`
 	}

pkg/handlers/resource.go

@@ -70,15 +70,15 @@ func (h resourceHandler) Patch(w http.ResponseWriter, r *http.Request) {
 		func() (interface{}, *errors.ServiceError) {
 			ctx := r.Context()
 			id := mux.Vars(r)["id"]
-			manifest, err := presenters.ConvertResourceManifest(patch.Manifest, patch.DeleteOption, patch.UpdateStrategy)
+			payload, err := presenters.ConvertResourceManifest(patch.Manifest, patch.DeleteOption, patch.UpdateStrategy)
 			if err != nil {
 				return nil, errors.GeneralError("failed to convert resource manifest: %s", err)
 			}
 			resource, serviceErr := h.resource.Update(ctx, &api.Resource{
-				Meta:     api.Meta{ID: id},
-				Version:  *patch.Version,
-				Type:     api.ResourceTypeSingle,
-				Manifest: manifest,
+				Meta:    api.Meta{ID: id},
+				Version: *patch.Version,
+				Type:    api.ResourceTypeSingle,
+				Payload: payload,
 			})
 			if serviceErr != nil {
 				return nil, serviceErr

pkg/services/resource.go

@@ -70,7 +70,7 @@ func (s *sqlResourceService) Create(ctx context.Context, resource *api.Resource)
 			return nil, errors.Validation("the name in the resource is invalid, %v", err)
 		}
 	}
-	if err := ValidateManifest(resource.Type, resource.Manifest); err != nil {
+	if err := ValidateManifest(resource.Type, resource.Payload); err != nil {
 		return nil, errors.Validation("the manifest in the resource is invalid, %v", err)
 	}
 
@@ -113,17 +113,17 @@ func (s *sqlResourceService) Update(ctx context.Context, resource *api.Resource)
 	}
 
 	// New manifest is not changed, the update action is not needed.
-	if reflect.DeepEqual(resource.Manifest, found.Manifest) {
+	if reflect.DeepEqual(resource.Payload, found.Payload) {
 		return found, nil
 	}
 
-	if err := ValidateManifestUpdate(resource.Type, resource.Manifest, found.Manifest); err != nil {
+	if err := ValidateManifestUpdate(resource.Type, resource.Payload, found.Payload); err != nil {
 		return nil, errors.Validation("the new manifest in the resource is invalid, %v", err)
 	}
 
 	// Increase the current resource version and update its manifest.
 	found.Version = found.Version + 1
-	found.Manifest = resource.Manifest
+	found.Payload = resource.Payload
 
 	updated, err := s.resourceDao.Update(ctx, found)
 	if err != nil {

pkg/services/resource_test.go

@@ -23,13 +23,13 @@ func TestResourceFindByConsumerID(t *testing.T) {
 	const Breviceratops = "c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4"
 
 	resources := api.ResourceList{
-		&api.Resource{ConsumerName: Fukuisaurus, Type: api.ResourceTypeSingle, Manifest: newManifest(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
-		&api.Resource{ConsumerName: Fukuisaurus, Type: api.ResourceTypeBundle, Manifest: newManifest(t, "{\"id\":\"266a8cd2-2fab-4e89-9bf0-a56425ebcdf8\",\"time\":\"2024-02-05T17:31:05Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifestbundles.spec.create_request\",\"source\":\"grpc\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"resourceid\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"clustername\":\"b288a9da-8bfe-4c82-94cc-2b48e773fc46\",\"resourceversion\":1,\"data\":{\"manifests\":[{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"}},{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"},\"spec\":{\"replicas\":1,\"selector\":{\"matchLabels\":{\"app\":\"nginx\"}},\"template\":{\"spec\":{\"containers\":[{\"name\":\"nginx\",\"image\":\"nginxinc/nginx-unprivileged\"}]},\"metadata\":{\"labels\":{\"app\":\"nginx\"}}}}}],\"deleteOption\":{\"propagationPolicy\":\"Foreground\"},\"manifestConfigs\":[{\"updateStrategy\":{\"type\":\"ServerSideApply\"},\"resourceIdentifier\":{\"name\":\"nginx\",\"group\":\"apps\",\"resource\":\"deployments\",\"namespace\":\"default\"}}]}}")},
-		&api.Resource{ConsumerName: Fukuisaurus, Type: api.ResourceTypeSingle, Manifest: newManifest(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
-		&api.Resource{ConsumerName: Seismosaurus, Type: api.ResourceTypeSingle, Manifest: newManifest(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
-		&api.Resource{ConsumerName: Seismosaurus, Type: api.ResourceTypeBundle, Manifest: newManifest(t, "{\"id\":\"266a8cd2-2fab-4e89-9bf0-a56425ebcdf8\",\"time\":\"2024-02-05T17:31:05Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifestbundles.spec.create_request\",\"source\":\"grpc\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"resourceid\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"clustername\":\"e3eb7db1-b124-4a4d-8bb6-cc779c01b402\",\"resourceversion\":1,\"data\":{\"manifests\":[{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"}},{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"},\"spec\":{\"replicas\":1,\"selector\":{\"matchLabels\":{\"app\":\"nginx\"}},\"template\":{\"spec\":{\"containers\":[{\"name\":\"nginx\",\"image\":\"nginxinc/nginx-unprivileged\"}]},\"metadata\":{\"labels\":{\"app\":\"nginx\"}}}}}],\"deleteOption\":{\"propagationPolicy\":\"Foreground\"},\"manifestConfigs\":[{\"updateStrategy\":{\"type\":\"ServerSideApply\"},\"resourceIdentifier\":{\"name\":\"nginx\",\"group\":\"apps\",\"resource\":\"deployments\",\"namespace\":\"default\"}}]}}")},
-		&api.Resource{ConsumerName: Breviceratops, Type: api.ResourceTypeSingle, Manifest: newManifest(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
-		&api.Resource{ConsumerName: Breviceratops, Type: api.ResourceTypeBundle, Manifest: newManifest(t, "{\"id\":\"266a8cd2-2fab-4e89-9bf0-a56425ebcdf8\",\"time\":\"2024-02-05T17:31:05Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifestbundles.spec.create_request\",\"source\":\"grpc\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"resourceid\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"clustername\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"resourceversion\":1,\"data\":{\"manifests\":[{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"}},{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"},\"spec\":{\"replicas\":1,\"selector\":{\"matchLabels\":{\"app\":\"nginx\"}},\"template\":{\"spec\":{\"containers\":[{\"name\":\"nginx\",\"image\":\"nginxinc/nginx-unprivileged\"}]},\"metadata\":{\"labels\":{\"app\":\"nginx\"}}}}}],\"deleteOption\":{\"propagationPolicy\":\"Foreground\"},\"manifestConfigs\":[{\"updateStrategy\":{\"type\":\"ServerSideApply\"},\"resourceIdentifier\":{\"name\":\"nginx\",\"group\":\"apps\",\"resource\":\"deployments\",\"namespace\":\"default\"}}]}}")},
+		&api.Resource{ConsumerName: Fukuisaurus, Type: api.ResourceTypeSingle, Payload: newPayload(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
+		&api.Resource{ConsumerName: Fukuisaurus, Type: api.ResourceTypeBundle, Payload: newPayload(t, "{\"id\":\"266a8cd2-2fab-4e89-9bf0-a56425ebcdf8\",\"time\":\"2024-02-05T17:31:05Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifestbundles.spec.create_request\",\"source\":\"grpc\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"resourceid\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"clustername\":\"b288a9da-8bfe-4c82-94cc-2b48e773fc46\",\"resourceversion\":1,\"data\":{\"manifests\":[{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"}},{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"},\"spec\":{\"replicas\":1,\"selector\":{\"matchLabels\":{\"app\":\"nginx\"}},\"template\":{\"spec\":{\"containers\":[{\"name\":\"nginx\",\"image\":\"nginxinc/nginx-unprivileged\"}]},\"metadata\":{\"labels\":{\"app\":\"nginx\"}}}}}],\"deleteOption\":{\"propagationPolicy\":\"Foreground\"},\"manifestConfigs\":[{\"updateStrategy\":{\"type\":\"ServerSideApply\"},\"resourceIdentifier\":{\"name\":\"nginx\",\"group\":\"apps\",\"resource\":\"deployments\",\"namespace\":\"default\"}}]}}")},
+		&api.Resource{ConsumerName: Fukuisaurus, Type: api.ResourceTypeSingle, Payload: newPayload(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
+		&api.Resource{ConsumerName: Seismosaurus, Type: api.ResourceTypeSingle, Payload: newPayload(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
+		&api.Resource{ConsumerName: Seismosaurus, Type: api.ResourceTypeBundle, Payload: newPayload(t, "{\"id\":\"266a8cd2-2fab-4e89-9bf0-a56425ebcdf8\",\"time\":\"2024-02-05T17:31:05Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifestbundles.spec.create_request\",\"source\":\"grpc\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"resourceid\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"clustername\":\"e3eb7db1-b124-4a4d-8bb6-cc779c01b402\",\"resourceversion\":1,\"data\":{\"manifests\":[{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"}},{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"},\"spec\":{\"replicas\":1,\"selector\":{\"matchLabels\":{\"app\":\"nginx\"}},\"template\":{\"spec\":{\"containers\":[{\"name\":\"nginx\",\"image\":\"nginxinc/nginx-unprivileged\"}]},\"metadata\":{\"labels\":{\"app\":\"nginx\"}}}}}],\"deleteOption\":{\"propagationPolicy\":\"Foreground\"},\"manifestConfigs\":[{\"updateStrategy\":{\"type\":\"ServerSideApply\"},\"resourceIdentifier\":{\"name\":\"nginx\",\"group\":\"apps\",\"resource\":\"deployments\",\"namespace\":\"default\"}}]}}")},
+		&api.Resource{ConsumerName: Breviceratops, Type: api.ResourceTypeSingle, Payload: newPayload(t, "{\"id\":\"75479c10-b537-4261-8058-ca2e36bac384\",\"time\":\"2024-03-07T03:29:03.194843266Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifests.spec.create_request\",\"source\":\"maestro\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"data\":{\"manifest\":{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"test\",\"namespace\":\"test\"}}}}")},
+		&api.Resource{ConsumerName: Breviceratops, Type: api.ResourceTypeBundle, Payload: newPayload(t, "{\"id\":\"266a8cd2-2fab-4e89-9bf0-a56425ebcdf8\",\"time\":\"2024-02-05T17:31:05Z\",\"type\":\"io.open-cluster-management.works.v1alpha1.manifestbundles.spec.create_request\",\"source\":\"grpc\",\"specversion\":\"1.0\",\"datacontenttype\":\"application/json\",\"resourceid\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"clustername\":\"c4df9ff0-bfeb-5bc6-a0ab-4c9128d698b4\",\"resourceversion\":1,\"data\":{\"manifests\":[{\"apiVersion\":\"v1\",\"kind\":\"ConfigMap\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"}},{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\",\"metadata\":{\"name\":\"nginx\",\"namespace\":\"default\"},\"spec\":{\"replicas\":1,\"selector\":{\"matchLabels\":{\"app\":\"nginx\"}},\"template\":{\"spec\":{\"containers\":[{\"name\":\"nginx\",\"image\":\"nginxinc/nginx-unprivileged\"}]},\"metadata\":{\"labels\":{\"app\":\"nginx\"}}}}}],\"deleteOption\":{\"propagationPolicy\":\"Foreground\"},\"manifestConfigs\":[{\"updateStrategy\":{\"type\":\"ServerSideApply\"},\"resourceIdentifier\":{\"name\":\"nginx\",\"group\":\"apps\",\"resource\":\"deployments\",\"namespace\":\"default\"}}]}}")},
 	}
 	for _, resource := range resources {
 		_, err := resourceService.Create(context.Background(), resource)
@@ -55,7 +55,7 @@ func TestCreateInvalidResource(t *testing.T) {
 	events := NewEventService(mocks.NewEventDao())
 	resourceService := NewResourceService(dbmocks.NewMockAdvisoryLockFactory(), resourceDAO, events)
 
-	resource := &api.Resource{ConsumerName: "invalidation", Manifest: newManifest(t, "{}")}
+	resource := &api.Resource{ConsumerName: "invalidation", Payload: newPayload(t, "{}")}
 
 	_, svcErr := resourceService.Create(context.Background(), resource)
 	gm.Expect(svcErr).ShouldNot(gm.BeNil())