Feat: vela dry-run render results should be affected by override poli…

…cy and deploy workflowstep (#4815)

* [Feature] vela dry-run render results should be affected by override policy and deploy workflowstep

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

* multiple input files support; policy,workflow support; new flag: merge orphan policy or workflow

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

* add more tests

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

* fix comment issues

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

* add tests

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

* fix e2e

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

* fix tests

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

Signed-off-by: cezhang <c1zhang.dev@gmail.com>

pkg/appfile/dryrun/diff_test.go

@@ -23,8 +23,6 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-	corev1 "k8s.io/api/core/v1"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/yaml"
@@ -167,7 +165,6 @@ var _ = Describe("Test Live-Diff", func() {
 			Expect(k8sClient.Create(context.Background(), un)).Should(Succeed())
 		}
 		ctx := context.Background()
-		Expect(k8sClient.Create(ctx, &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "vela-system"}})).Should(Succeed())
 		applyFile("diff-input-app-with-externals.yaml", "default")
 		applyFile("diff-apprevision.yaml", "default")
 		app := &v1beta1.Application{}
@@ -190,7 +187,6 @@ var _ = Describe("Test Live-Diff", func() {
 		Expect(runDiff()).Should(ContainSubstring("\"myworker\" not found"))
 		applyFile("td-myingress.yaml", "vela-system")
 		applyFile("cd-myworker.yaml", "vela-system")
-		applyFile("wd-deploy.yaml", "vela-system")
 		applyFile("wd-ref-objects.yaml", "vela-system")
 		Expect(runDiff()).Should(ContainSubstring("\"deploy-livediff-demo\" not found"))
 		applyFile("external-workflow.yaml", "default")

pkg/appfile/dryrun/dryrun.go

@@ -24,6 +24,11 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/oam-dev/kubevela/apis/core.oam.dev/v1alpha1"
+	"github.com/oam-dev/kubevela/pkg/policy/envbinding"
+	"github.com/oam-dev/kubevela/pkg/utils"
+	"github.com/oam-dev/kubevela/pkg/workflow/step"
+
 	"github.com/pkg/errors"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -143,6 +148,7 @@ func (d *Option) ExecuteDryRun(ctx context.Context, application *v1beta1.Applica
 	if appFile.Namespace == "" {
 		appFile.Namespace = corev1.NamespaceDefault
 	}
+
 	comps, err := appFile.GenerateComponentManifests()
 	if err != nil {
 		return nil, nil, errors.WithMessage(err, "cannot generate manifests from components and traits")
@@ -206,3 +212,120 @@ func (d *Option) PrintDryRun(buff *bytes.Buffer, appName string, comps []*types.
 	}
 	return nil
 }
+
+// ExecuteDryRunWithPolicies is similar to ExecuteDryRun func, but considers deploy workflow step and topology+override policies
+func (d *Option) ExecuteDryRunWithPolicies(ctx context.Context, application *v1beta1.Application, buff *bytes.Buffer) error {
+
+	app := application.DeepCopy()
+	if app.Namespace == "" {
+		app.Namespace = corev1.NamespaceDefault
+	} else {
+		ctx = oamutil.SetNamespaceInCtx(ctx, app.Namespace)
+	}
+	parser := appfile.NewDryRunApplicationParser(d.Client, d.DiscoveryMapper, d.PackageDiscover, d.Auxiliaries)
+	af, err := parser.GenerateAppFileFromApp(ctx, app)
+	if err != nil {
+		return err
+	}
+
+	deployWorkflowCount := 0
+	for _, wfs := range af.WorkflowSteps {
+		if wfs.Type == step.DeployWorkflowStep {
+			deployWorkflowCount++
+			deployWorkflowStepSpec := &step.DeployWorkflowStepSpec{}
+			if err := utils.StrictUnmarshal(wfs.Properties.Raw, deployWorkflowStepSpec); err != nil {
+				return err
+			}
+
+			topologyPolicies, overridePolicies, err := filterPolicies(af.Policies, deployWorkflowStepSpec.Policies)
+			if err != nil {
+				return err
+			}
+			if len(topologyPolicies) > 0 {
+				for _, tp := range topologyPolicies {
+					patchedApp, err := patchApp(app, overridePolicies)
+					if err != nil {
+						return err
+					}
+					comps, pms, err := d.ExecuteDryRun(ctx, patchedApp)
+					if err != nil {
+						return err
+					}
+					err = d.PrintDryRun(buff, fmt.Sprintf("%s with topology %s", patchedApp.Name, tp.Name), comps, pms)
+					if err != nil {
+						return err
+					}
+				}
+			} else {
+				patchedApp, err := patchApp(app, overridePolicies)
+				if err != nil {
+					return err
+				}
+				comps, pms, err := d.ExecuteDryRun(ctx, patchedApp)
+				if err != nil {
+					return err
+				}
+				err = d.PrintDryRun(buff, fmt.Sprintf("%s only with override policies", patchedApp.Name), comps, pms)
+				if err != nil {
+					return err
+				}
+			}
+		}
+	}
+
+	if deployWorkflowCount == 0 {
+		comps, pms, err := d.ExecuteDryRun(ctx, app)
+		if err != nil {
+			return err
+		}
+		err = d.PrintDryRun(buff, app.Name, comps, pms)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func filterPolicies(policies []v1beta1.AppPolicy, policyNames []string) ([]v1beta1.AppPolicy, []v1beta1.AppPolicy, error) {
+	policyMap := make(map[string]v1beta1.AppPolicy)
+	for _, policy := range policies {
+		policyMap[policy.Name] = policy
+	}
+	var topologyPolicies []v1beta1.AppPolicy
+	var overridePolicies []v1beta1.AppPolicy
+	for _, policyName := range policyNames {
+		if policy, found := policyMap[policyName]; found {
+			switch policy.Type {
+			case v1alpha1.TopologyPolicyType:
+				topologyPolicies = append(topologyPolicies, policy)
+			case v1alpha1.OverridePolicyType:
+				overridePolicies = append(overridePolicies, policy)
+			}
+		} else {
+			return nil, nil, errors.Errorf("policy %s not found", policyName)
+		}
+	}
+	return topologyPolicies, overridePolicies, nil
+}
+
+func patchApp(application *v1beta1.Application, overridePolicies []v1beta1.AppPolicy) (*v1beta1.Application, error) {
+	app := application.DeepCopy()
+	for _, policy := range overridePolicies {
+
+		if policy.Properties == nil {
+			return nil, fmt.Errorf("override policy %s must not have empty properties", policy.Name)
+		}
+		overrideSpec := &v1alpha1.OverridePolicySpec{}
+		if err := utils.StrictUnmarshal(policy.Properties.Raw, overrideSpec); err != nil {
+			return nil, errors.Wrapf(err, "failed to parse override policy %s", policy.Name)
+		}
+		overrideComps, err := envbinding.PatchComponents(app.Spec.Components, overrideSpec.Components, overrideSpec.Selector)
+		if err != nil {
+			return nil, errors.Wrapf(err, "failed to apply override policy %s", policy.Name)
+		}
+		app.Spec.Components = overrideComps
+	}
+
+	return app, nil
+}

pkg/appfile/dryrun/dryrun_test.go

@@ -17,8 +17,11 @@ limitations under the License.
 package dryrun
 
 import (
+	"bytes"
 	"context"
 	"encoding/json"
+	"os"
+	"strings"
 
 	"github.com/oam-dev/kubevela/apis/types"
 
@@ -59,3 +62,108 @@ var _ = Describe("Test DryRun", func() {
 		Expect(diff).Should(BeEmpty())
 	})
 })
+
+var _ = Describe("Test dry run with policies", func() {
+	It("Test dry run with override policy", func() {
+
+		webservice, err := os.ReadFile("../../../charts/vela-core/templates/defwithtemplate/webservice.yaml")
+		Expect(err).Should(BeNil())
+		webserviceYAML := strings.Replace(string(webservice), "{{ include \"systemDefinitionNamespace\" . }}", types.DefaultKubeVelaNS, 1)
+		wwd := v1beta1.ComponentDefinition{}
+		Expect(yaml.Unmarshal([]byte(webserviceYAML), &wwd)).Should(BeNil())
+		Expect(k8sClient.Create(context.TODO(), &wwd)).Should(BeNil())
+
+		scaler, err := os.ReadFile("../../../charts/vela-core/templates/defwithtemplate/scaler.yaml")
+		Expect(err).Should(BeNil())
+		scalerYAML := strings.Replace(string(scaler), "{{ include \"systemDefinitionNamespace\" . }}", types.DefaultKubeVelaNS, 1)
+		var td v1beta1.TraitDefinition
+		Expect(yaml.Unmarshal([]byte(scalerYAML), &td)).Should(BeNil())
+		Expect(k8sClient.Create(context.TODO(), &td)).Should(BeNil())
+
+		appYAML := readDataFromFile("./testdata/testing-dry-run-1.yaml")
+		app := &v1beta1.Application{}
+		Expect(yaml.Unmarshal([]byte(appYAML), &app)).Should(BeNil())
+
+		var buff = bytes.Buffer{}
+		err = dryrunOpt.ExecuteDryRunWithPolicies(context.TODO(), app, &buff)
+		Expect(err).Should(BeNil())
+		Expect(buff.String()).Should(ContainSubstring("# Application(testing-app with topology target-default)"))
+		Expect(buff.String()).Should(ContainSubstring("# Application(testing-app with topology target-prod)"))
+		Expect(buff.String()).Should(ContainSubstring("name: testing-dryrun"))
+		Expect(buff.String()).Should(ContainSubstring("kind: Deployment"))
+		Expect(buff.String()).Should(ContainSubstring("replicas: 1"))
+		Expect(buff.String()).Should(ContainSubstring("replicas: 3"))
+		Expect(buff.String()).Should(ContainSubstring("kind: Service"))
+	})
+
+	It("Test dry run only with override policy", func() {
+
+		appYAML := readDataFromFile("./testdata/testing-dry-run-2.yaml")
+		app := &v1beta1.Application{}
+		Expect(yaml.Unmarshal([]byte(appYAML), &app)).Should(BeNil())
+
+		var buff = bytes.Buffer{}
+		err := dryrunOpt.ExecuteDryRunWithPolicies(context.TODO(), app, &buff)
+		Expect(err).Should(BeNil())
+		Expect(buff.String()).Should(ContainSubstring("# Application(testing-app only with override policies)"))
+		Expect(buff.String()).Should(ContainSubstring("name: testing-dryrun"))
+		Expect(buff.String()).Should(ContainSubstring("kind: Deployment"))
+		Expect(buff.String()).Should(ContainSubstring("replicas: 3"))
+		Expect(buff.String()).Should(ContainSubstring("kind: Service"))
+	})
+
+	It("Test dry run without deploy workflow", func() {
+
+		appYAML := readDataFromFile("./testdata/testing-dry-run-3.yaml")
+		app := &v1beta1.Application{}
+		Expect(yaml.Unmarshal([]byte(appYAML), &app)).Should(BeNil())
+
+		var buff = bytes.Buffer{}
+		err := dryrunOpt.ExecuteDryRunWithPolicies(context.TODO(), app, &buff)
+		Expect(err).Should(BeNil())
+		Expect(buff.String()).Should(ContainSubstring("# Application(testing-app)"))
+		Expect(buff.String()).Should(ContainSubstring("name: testing-dryrun"))
+		Expect(buff.String()).Should(ContainSubstring("kind: Deployment"))
+	})
+
+	It("Test dry run without custom policy", func() {
+
+		topo, err := os.ReadFile("./testdata/pd-mypolicy.yaml")
+		Expect(err).Should(BeNil())
+		var pd v1beta1.PolicyDefinition
+		Expect(yaml.Unmarshal([]byte(topo), &pd)).Should(BeNil())
+		Expect(k8sClient.Create(context.TODO(), &pd)).Should(BeNil())
+
+		appYAML := readDataFromFile("./testdata/testing-dry-run-4.yaml")
+		app := &v1beta1.Application{}
+		Expect(yaml.Unmarshal([]byte(appYAML), &app)).Should(BeNil())
+
+		var buff = bytes.Buffer{}
+		err = dryrunOpt.ExecuteDryRunWithPolicies(context.TODO(), app, &buff)
+		Expect(err).Should(BeNil())
+		Expect(buff.String()).Should(ContainSubstring("# Application(testing-app) -- Component(testing-dryrun)"))
+		Expect(buff.String()).Should(ContainSubstring("# Application(testing-app) -- Policy(mypolicy)"))
+		Expect(buff.String()).Should(ContainSubstring("name: my-policy"))
+	})
+
+	It("Test dry run with trait", func() {
+
+		nocalhost, err := os.ReadFile("../../../charts/vela-core/templates/defwithtemplate/nocalhost.yaml")
+		Expect(err).Should(BeNil())
+		nocalhostYAML := strings.Replace(string(nocalhost), "{{ include \"systemDefinitionNamespace\" . }}", types.DefaultKubeVelaNS, 1)
+		var td v1beta1.TraitDefinition
+		Expect(yaml.Unmarshal([]byte(nocalhostYAML), &td)).Should(BeNil())
+		Expect(k8sClient.Create(context.TODO(), &td)).Should(BeNil())
+
+		appYAML := readDataFromFile("./testdata/testing-dry-run-5.yaml")
+		app := &v1beta1.Application{}
+		Expect(yaml.Unmarshal([]byte(appYAML), &app)).Should(BeNil())
+
+		var buff = bytes.Buffer{}
+		err = dryrunOpt.ExecuteDryRunWithPolicies(context.TODO(), app, &buff)
+		Expect(err).Should(BeNil())
+		Expect(buff.String()).Should(ContainSubstring("# Application(testing-app) -- Component(testing-dryrun)"))
+		Expect(buff.String()).Should(ContainSubstring("## From the trait nocalhost"))
+		Expect(buff.String()).Should(ContainSubstring("trait.oam.dev/type: nocalhost"))
+	})
+})

pkg/appfile/dryrun/suit_test.go

@@ -17,11 +17,19 @@ limitations under the License.
 package dryrun
 
 import (
+	"context"
 	"os"
 	"path/filepath"
 	"testing"
 	"time"
 
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/yaml"
+
+	"github.com/oam-dev/kubevela/apis/core.oam.dev/v1beta1"
+	"github.com/oam-dev/kubevela/apis/types"
+
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 
@@ -103,6 +111,16 @@ var _ = BeforeSuite(func(done Done) {
 	tdMyIngress, err := oamutil.Object2Unstructured(myingressDef)
 	Expect(err).Should(BeNil())
 
+	// create vela-system ns
+	Expect(k8sClient.Create(context.TODO(), &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: types.DefaultKubeVelaNS}})).Should(Succeed())
+	// create deploy workflow step definition
+	deploy, err := os.ReadFile("./testdata/wd-deploy.yaml")
+	Expect(err).Should(BeNil())
+	var wfsd v1beta1.WorkflowStepDefinition
+	Expect(yaml.Unmarshal([]byte(deploy), &wfsd)).Should(BeNil())
+	wfsd.SetNamespace(types.DefaultKubeVelaNS)
+	Expect(k8sClient.Create(context.TODO(), &wfsd)).Should(BeNil())
+
 	dryrunOpt = NewDryRunOption(k8sClient, cfg, dm, pd, []oam.Object{cdMyWorker, tdMyIngress}, false)
 	diffOpt = &LiveDiffOption{DryRun: dryrunOpt, Parser: appfile.NewApplicationParser(k8sClient, dm, pd)}
 

pkg/appfile/dryrun/testdata/pd-mypolicy.yaml

@@ -0,0 +1,22 @@
+# Code generated by KubeVela templates. DO NOT EDIT. Please edit the original cue file.
+# Definition source cue file: vela-templates/definitions/internal/topology.cue
+apiVersion: core.oam.dev/v1beta1
+kind: PolicyDefinition
+metadata:
+  name: mypolicy
+  namespace: vela-system
+spec:
+  schematic:
+    cue:
+      template: |
+        output: {
+            apiVersion: "testing/v1"
+        	kind:       "Policy"
+        	policy: {
+        	    name: parameter.name
+        	}
+        }
+
+        parameter: {
+        	name: string
+        }

pkg/appfile/dryrun/testdata/testing-dry-run-1.yaml

@@ -0,0 +1,48 @@
+apiVersion: core.oam.dev/v1beta1
+kind: Application
+metadata:
+  name: testing-app
+  namespace: default
+spec:
+  components:
+    - name: testing-dryrun
+      type: webservice
+      properties:
+        image: oamdev/hello-world:v1
+        ports:
+        - port: 8000
+          expose: true
+      traits:
+        - type: scaler
+          properties:
+            replicas: 1
+  policies:
+    - name: target-default
+      type: topology
+      properties:
+        clusters: [ "local" ]
+        namespace: "default"
+    - name: target-prod
+      type: topology
+      properties:
+        clusters: [ "local" ]
+        namespace: "prod"
+    - name: deploy-ha
+      type: override
+      properties:
+        components:
+          - type: webservice
+            traits:
+              - type: scaler
+                properties:
+                  replicas: 3
+  workflow:
+    steps:
+      - name: deploy2default
+        type: deploy
+        properties:
+          policies: [ "target-default" ]
+      - name: deploy2prod
+        type: deploy
+        properties:
+          policies: [ "target-prod", "deploy-ha" ]