Feat: Support specifying publishVersion when creating or updating oam applications

addon/metadata.yaml

@@ -1,5 +1,5 @@
 name: velaux
-version: v1.8.0-rc.3
+version: v1.8.0-rc.4
 description: KubeVela User Experience (UX). An extensible, application-oriented delivery and management Platform.
 icon: https://static.kubevela.net/images/logos/KubeVela%20-03.png
 url: https://kubevela.io

e2e-test/oam_application_test.go

@@ -127,4 +127,36 @@ var _ = Describe("Test oam application rest api", func() {
 			defer res.Body.Close()
 		}, time.Minute).Should(Succeed())
 	})
+
+	It("Test dryRun create and update oam app with publishVersion parameter", func() {
+		defer GinkgoRecover()
+		By("test dryRun create app with publishVersion")
+
+		Expect(common.ReadYamlToObject("./testdata/dryrun-app.yaml", &app)).Should(BeNil())
+		req := apiv1.ApplicationRequest{
+			Components: app.Spec.Components,
+			Policies:   app.Spec.Policies,
+			Workflow:   app.Spec.Workflow,
+		}
+		publishVersion := time.Now().Format(appName + "20060102150405")
+		res := post(fmt.Sprintf("/v1/namespaces/%s/applications/%s?dryRun=All&publishVersion=%s", namespace, appName+"-dryrun", publishVersion), req)
+		Expect(res).ShouldNot(BeNil())
+		Expect(cmp.Diff(res.StatusCode, 200)).Should(BeEmpty())
+		Expect(res.Body).ShouldNot(BeNil())
+		defer res.Body.Close()
+
+		time.Sleep(time.Second)
+		By("test dryRun update app with publishVersion")
+		updateReq := apiv1.ApplicationRequest{
+			Components: app.Spec.Components[1:],
+		}
+		publishVersion = time.Now().Format(appName + "20060102150405")
+		Eventually(func(g Gomega) {
+			res = post(fmt.Sprintf("/v1/namespaces/%s/applications/%s?dryRun=All&publishVersion=%s", namespace, appName+"-dryrun", publishVersion), updateReq)
+			g.Expect(res).ShouldNot(BeNil())
+			g.Expect(cmp.Diff(res.StatusCode, 200)).Should(BeEmpty())
+			g.Expect(res.Body).ShouldNot(BeNil())
+			defer res.Body.Close()
+		}, time.Minute).Should(Succeed())
+	})
 })

pkg/server/domain/service/oam_application.go

@@ -34,10 +34,10 @@
 
 // OAMApplicationService oam_application service
 type OAMApplicationService interface {
-	CreateOrUpdateOAMApplication(context.Context, apisv1.ApplicationRequest, string, string) error
+	CreateOrUpdateOAMApplication(context.Context, apisv1.ApplicationRequest, string, string, string) error
 	GetOAMApplication(context.Context, string, string) (*apisv1.ApplicationResponse, error)
 	DeleteOAMApplication(context.Context, string, string) error
-	DryRunOAMApplication(context.Context, apisv1.ApplicationRequest, string, string) error
+	DryRunOAMApplication(context.Context, apisv1.ApplicationRequest, string, string, string) error
 }
 
 // NewOAMApplicationService new oam_application service
@@ -51,7 +51,7 @@
 }
 
 // CreateOrUpdateOAMApplication create or update application
-func (o oamApplicationServiceImpl) CreateOrUpdateOAMApplication(ctx context.Context, request apisv1.ApplicationRequest, name, namespace string) error {
+func (o oamApplicationServiceImpl) CreateOrUpdateOAMApplication(ctx context.Context, request apisv1.ApplicationRequest, name, namespace string, publishVersion string) error {
 	ns := new(v1.Namespace)
 	err := o.KubeClient.Get(ctx, client.ObjectKey{Name: namespace}, ns)
 	if kerrors.IsNotFound(err) {
@@ -61,10 +61,16 @@
 		}
 	}
 
+	annotations := map[string]string{}
+	if publishVersion != "" {
+		annotations["app.oam.dev/publishVersion"] = publishVersion
+	}
+
 	app := &v1beta1.Application{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      name,
-			Namespace: namespace,
+			Name:        name,
+			Namespace:   namespace,
+			Annotations: annotations,
 		},
 		Spec: v1beta1.ApplicationSpec{
 			Components: request.Components,
@@ -83,6 +89,7 @@
 	}
 
 	existApp.Spec = app.Spec
+	existApp.ObjectMeta.Annotations = annotations
 	return o.KubeClient.Update(ctx, existApp)
 }
 
@@ -111,7 +118,7 @@
 }
 
 // DryRunOAMApplication dryRun create or update application
-func (o oamApplicationServiceImpl) DryRunOAMApplication(ctx context.Context, request apisv1.ApplicationRequest, name, namespace string) error {
+func (o oamApplicationServiceImpl) DryRunOAMApplication(ctx context.Context, request apisv1.ApplicationRequest, name, namespace string, publishVersion string) error {
 	ns := new(v1.Namespace)
 	err := o.KubeClient.Get(ctx, client.ObjectKey{Name: namespace}, ns)
 	if kerrors.IsNotFound(err) {
@@ -121,14 +128,20 @@
 		}
 	}
 
+	annotations := map[string]string{}
+	if publishVersion != "" {
+		annotations["app.oam.dev/publishVersion"] = publishVersion
+	}
+
 	app := &v1beta1.Application{
 		TypeMeta: metav1.TypeMeta{
 			Kind:       "Application",
 			APIVersion: "core.oam.dev/v1beta1",
 		},
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      name,
-			Namespace: namespace,
+			Name:        name,
+			Namespace:   namespace,
+			Annotations: annotations,
 		},
 		Spec: v1beta1.ApplicationSpec{
 			Components: request.Components,
@@ -157,5 +170,6 @@
 	}
 
 	existApp.Spec = app.Spec
+	existApp.ObjectMeta.Annotations = annotations
 	return o.KubeClient.Update(ctx, existApp, client.DryRunAll)
 }

pkg/server/domain/service/oam_application_test.go

@@ -80,7 +80,7 @@ var _ = Describe("Test oam application service function", func() {
 			Policies:   baseApp.Spec.Policies,
 			Workflow:   baseApp.Spec.Workflow,
 		}
-		Expect(oamAppService.CreateOrUpdateOAMApplication(ctx, req, appName, appNs)).Should(BeNil())
+		Expect(oamAppService.CreateOrUpdateOAMApplication(ctx, req, appName, appNs, "")).Should(BeNil())
 
 		app := new(v1beta1.Application)
 		Expect(k8sClient.Get(ctx, client.ObjectKey{Namespace: appNs, Name: appName}, app)).Should(BeNil())
@@ -92,7 +92,7 @@ var _ = Describe("Test oam application service function", func() {
 		updateReq := apiv1.ApplicationRequest{
 			Components: baseApp.Spec.Components[1:],
 		}
-		Expect(oamAppService.CreateOrUpdateOAMApplication(ctx, updateReq, appName, appNs)).Should(BeNil())
+		Expect(oamAppService.CreateOrUpdateOAMApplication(ctx, updateReq, appName, appNs, "")).Should(BeNil())
 
 		updatedApp := new(v1beta1.Application)
 		Expect(k8sClient.Get(ctx, client.ObjectKey{Namespace: appNs, Name: appName}, updatedApp)).Should(BeNil())
@@ -137,13 +137,40 @@ var _ = Describe("Test oam application service function", func() {
 			Policies:   newApp.Spec.Policies,
 			Workflow:   newApp.Spec.Workflow,
 		}
-		Expect(oamAppService.DryRunOAMApplication(ctx, req, appName, appNs)).Should(BeNil())
+		Expect(oamAppService.DryRunOAMApplication(ctx, req, appName, appNs, "")).Should(BeNil())
 
 		By("test dryRun update application")
 		updateReq := apiv1.ApplicationRequest{
 			Components: newApp.Spec.Components[1:],
 		}
-		Expect(oamAppService.DryRunOAMApplication(ctx, updateReq, appName, appNs)).Should(BeNil())
+		Expect(oamAppService.DryRunOAMApplication(ctx, updateReq, appName, appNs, "")).Should(BeNil())
+
+	})
+
+	It("Test DryRunOAMApplication function with publishVersion", func() {
+		By("test dryRun create application")
+		appName := "test-new-app"
+		appNs := randomNamespaceName("test-new-app")
+		publishVersion := time.Now().Format(appName + "20060102150405")
+		var newApp v1beta1.Application
+		Expect(common.ReadYamlToObject("./testdata/dryrun-app.yaml", &newApp)).Should(BeNil())
+		newApp.SetNamespace(namespace)
+		Eventually(func() error {
+			return k8sClient.Create(ctx, &newApp)
+		}, time.Second*3, time.Microsecond*300).Should(SatisfyAny(BeNil(), &util.AlreadyExistMatcher{}))
+
+		req := apiv1.ApplicationRequest{
+			Components: newApp.Spec.Components,
+			Policies:   newApp.Spec.Policies,
+			Workflow:   newApp.Spec.Workflow,
+		}
+		Expect(oamAppService.DryRunOAMApplication(ctx, req, appName, appNs, publishVersion)).Should(BeNil())
+
+		By("test dryRun update application")
+		updateReq := apiv1.ApplicationRequest{
+			Components: newApp.Spec.Components[1:],
+		}
+		Expect(oamAppService.DryRunOAMApplication(ctx, updateReq, appName, appNs, publishVersion)).Should(BeNil())
 
 	})
 })

pkg/server/interfaces/api/oam_application.go

@@ -63,11 +63,15 @@
 		Param(ws.QueryParameter("dryRun", "When present, indicates that modifications should not be persisted. "+
 			"An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. "+
 			"Valid values are: - All: all dry run stages will be processed").DataType("string").Required(false)).
+		Param(ws.QueryParameter("publishVersion", "The publish version for deploying application."+
+			"if no specified, {application name}-v{the number of times it was published} (e.g.: demo-app-v13) will be used. "+
+			"the workflow record will use this value as the record identifier, so please ensure that this value is not duplicated "+
+			"if you specify it, otherwise the request will report an error").DataType("string").Required(false)).
 		Reads(apis.ApplicationRequest{}))
 
 	ws.Route(ws.DELETE("/namespaces/{namespace}/applications/{appname}").To(c.deleteApplication).
 		Operation("deleteOAMApplication").
-		Doc("create or update oam application in the specified namespace").
+		Doc("delete oam application in the specified namespace").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Filter(c.RbacService.CheckPerm("application", "delete")).
 		Param(ws.PathParameter("namespace", "identifier of the namespace").DataType("string")).
@@ -104,19 +108,20 @@
 		return
 	}
 
+	publishVersion := req.QueryParameter("publishVersion")
 	dryRun := req.QueryParameter("dryRun")
 	if len(dryRun) != 0 {
 		if dryRun != "All" {
 			bcode.ReturnError(req, res, bcode.ErrApplicationDryRunFailed.SetMessage("Invalid dryRun parameter. Must be 'All'"))
 			return
 		}
-		if err := c.OamApplicationService.DryRunOAMApplication(req.Request.Context(), createReq, appName, namespace); err != nil {
+		if err := c.OamApplicationService.DryRunOAMApplication(req.Request.Context(), createReq, appName, namespace, publishVersion); err != nil {
 			klog.Errorf("dryrun application failure %s", err.Error())
 			bcode.ReturnError(req, res, err)
 			return
 		}
 	} else {
-		if err := c.OamApplicationService.CreateOrUpdateOAMApplication(req.Request.Context(), createReq, appName, namespace); err != nil {
+		if err := c.OamApplicationService.CreateOrUpdateOAMApplication(req.Request.Context(), createReq, appName, namespace, publishVersion); err != nil {
 			klog.Errorf("create application failure %s", err.Error())
 			bcode.ReturnError(req, res, err)
 			return