support dry-run (#219)

oren-codefresh · web-flow · commit ad11263a4326 · 2021-01-25T15:32:12.000+02:00
* support dry-run

* wip
diff --git a/venona/VERSION b/venona/VERSION
@@ -1 +1 @@
-1.5.15
+1.5.16
diff --git a/venonactl/VERSION b/venonactl/VERSION
@@ -1 +1 @@
-1.5.15
+1.5.16
diff --git a/venonactl/cmd/attach.go b/venonactl/cmd/attach.go
@@ -43,6 +43,7 @@ var attachRuntimeCmdOptions struct {
 	templateValues     []string
 	templateFileValues []string
 	templateValueFiles []string
+	dryRun             bool
 }
 
 var attachRuntimeCmd = &cobra.Command{
@@ -104,18 +105,20 @@ var attachRuntimeCmd = &cobra.Command{
 			RuntimeClusterName:    attachRuntimeCmdOptions.kube.namespace,
 			RuntimeServiceAccount: attachRuntimeCmdOptions.kube.serviceAccount,
 			RestartAgent:          attachRuntimeCmdOptions.restartAgent,
+			DryRun:                attachRuntimeCmdOptions.dryRun,
 		}
 
 		// runtime
 		var runtimeInCluster bool
 		mergeValueBool(templateValuesMap, "RuntimeInCluster", &runtimeInCluster)
-		builderInstallOpt.KubeBuilder = getKubeClientBuilder(attachRuntimeCmdOptions.kube.context, attachRuntimeCmdOptions.kube.namespace, attachRuntimeCmdOptions.kube.kubePath, runtimeInCluster)
+		builderInstallOpt.KubeBuilder = getKubeClientBuilder(attachRuntimeCmdOptions.kube.context, attachRuntimeCmdOptions.kube.namespace, attachRuntimeCmdOptions.kube.kubePath, runtimeInCluster, attachRuntimeCmdOptions.dryRun)
 
 		// agent
 		builderInstallOpt.AgentKubeBuilder = getKubeClientBuilder(attachRuntimeCmdOptions.kubeVenona.context,
 			attachRuntimeCmdOptions.kubeVenona.namespace,
 			attachRuntimeCmdOptions.kubeVenona.kubePath,
-			false)
+			false,
+			attachRuntimeCmdOptions.dryRun)
 
 		builder.Add(plugins.RuntimeAttachType)
 
@@ -151,6 +154,7 @@ func init() {
 	attachRuntimeCmd.Flags().StringVar(&attachRuntimeCmdOptions.kubeVenona.context, "kube-context-name-agent", viper.GetString("kube-context-agent"), "Name of the kubernetes context on which venona is installed (default is current-context) [$KUBE_CONTEXT]")
 	attachRuntimeCmd.Flags().StringVar(&attachRuntimeCmdOptions.kubeVenona.kubePath, "kube-config-path-agent", viper.GetString("kubeconfig-agent"), "Path to kubeconfig file (default is $HOME/.kube/config) for agent [$KUBECONFIG]")
 	attachRuntimeCmd.Flags().BoolVar(&attachRuntimeCmdOptions.restartAgent, "restart-agent", viper.GetBool("restart-agent"), "Restart agent after attach operation")
+	attachRuntimeCmd.Flags().BoolVar(&attachRuntimeCmdOptions.dryRun, "dry-run", false, "Set to true to simulate installation")
 
 	attachRuntimeCmd.Flags().StringArrayVar(&attachRuntimeCmdOptions.templateValues, "set-value", []string{}, "Set values for templates --set-value agentId=12345")
 	attachRuntimeCmd.Flags().StringArrayVar(&attachRuntimeCmdOptions.templateFileValues, "set-file", []string{}, "Set values for templates from file")
diff --git a/venonactl/cmd/cmdutils.go b/venonactl/cmd/cmdutils.go
@@ -165,12 +165,13 @@ func createTable() *tablewriter.Table {
 	return table
 }
 
-func getKubeClientBuilder(context string, namespace string, path string, inCluster bool) kube.Kube {
+func getKubeClientBuilder(context string, namespace string, path string, inCluster bool, dryRun bool) kube.Kube {
 	return kube.New(&kube.Options{
 		ContextName:      context,
 		Namespace:        namespace,
 		PathToKubeConfig: path,
 		InCluster:        inCluster,
+		DryRun:           dryRun,
 	})
 }
 
@@ -317,4 +318,4 @@ func mergeValueMSI(valuesMap map[string]interface{}, key string, param *map[stri
 	}
 	val := mapX.Get(key).MSI(defaultValue...)
 	*param = val
-}
+}
diff --git a/venonactl/cmd/install-agent.go b/venonactl/cmd/install-agent.go
@@ -137,8 +137,11 @@ var installAgentCmd = &cobra.Command{
 		s.KubernetesAPI.NodeSelector = installAgentCmdOptions.kube.nodeSelector
 
 		builderInstallOpt.ClusterName = s.KubernetesAPI.ContextName
-		builderInstallOpt.KubeBuilder = getKubeClientBuilder(builderInstallOpt.ClusterName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)
+		builderInstallOpt.KubeBuilder = getKubeClientBuilder(builderInstallOpt.ClusterName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath,
+			s.KubernetesAPI.InCluster,
+			installAgentCmdOptions.dryRun)
 		builderInstallOpt.ClusterNamespace = s.KubernetesAPI.Namespace
+		builderInstallOpt.DryRun = installAgentCmdOptions.dryRun
 
 		builder.Add(plugins.VenonaPluginType)
 
diff --git a/venonactl/cmd/install-app-proxy.go b/venonactl/cmd/install-app-proxy.go
@@ -86,7 +86,7 @@ var installAppProxyCmd = &cobra.Command{
 		}
 
 		builderInstallOpt.ClusterName = s.KubernetesAPI.ContextName
-		builderInstallOpt.KubeBuilder = getKubeClientBuilder(builderInstallOpt.ClusterName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)
+		builderInstallOpt.KubeBuilder = getKubeClientBuilder(builderInstallOpt.ClusterName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, builderInstallOpt.DryRun)
 		builderInstallOpt.ClusterNamespace = s.KubernetesAPI.Namespace
 		builder.Add(plugins.AppProxyPluginType)
 
diff --git a/venonactl/cmd/install-monitor.go b/venonactl/cmd/install-monitor.go
@@ -87,7 +87,7 @@ var installMonitorAgentCmd = &cobra.Command{
 			DryRun:           installMonitorAgentCmdOptions.dryRun,
 		}
 
-		builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)
+		builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, installMonitorAgentCmdOptions.dryRun)
 
 		if installMonitorAgentCmdOptions.clusterId == "" {
 			dieOnError(fmt.Errorf("Cluster id is required in order to install monitor"))
diff --git a/venonactl/cmd/install-runtime.go b/venonactl/cmd/install-runtime.go
@@ -153,7 +153,9 @@ var installRuntimeCmd = &cobra.Command{
 			lgr.Info("Custom StorageClass is set, skipping installation of default volume provisioner")
 		}
 
-		builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)
+		builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath,
+			s.KubernetesAPI.InCluster,
+			installRuntimeCmdOptions.dryRun)
 		values := s.BuildValues()
 		values = mergeMaps(values, templateValuesMap)
 
diff --git a/venonactl/cmd/migrate.go b/venonactl/cmd/migrate.go
@@ -54,7 +54,7 @@ var migrateCmd = &cobra.Command{
 			err := p.Migrate(&plugins.MigrateOptions{
 				ClusterNamespace: migrateCmdOpt.kube.namespace,
 				ClusterName:      migrateCmdOpt.kube.context,
-				KubeBuilder:      getKubeClientBuilder(migrateCmdOpt.kube.context, migrateCmdOpt.kube.namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster),
+				KubeBuilder:      getKubeClientBuilder(migrateCmdOpt.kube.context, migrateCmdOpt.kube.namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, false),
 			}, values)
 			if err != nil {
 				dieOnError(err)
diff --git a/venonactl/cmd/status.go b/venonactl/cmd/status.go
@@ -113,7 +113,7 @@ func printTableWithKubernetesRelatedResources(re *codefresh.RuntimeEnvironment,
 			Add(plugins.VenonaPluginType).
 			Add(plugins.VolumeProvisionerPluginType)
 		statusOpt := &plugins.StatusOptions{
-			KubeBuilder:      getKubeClientBuilder(context, re.RuntimeScheduler.Cluster.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster),
+			KubeBuilder:      getKubeClientBuilder(context, re.RuntimeScheduler.Cluster.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, false),
 			ClusterNamespace: s.KubernetesAPI.Namespace,
 		}
 		for _, p := range builder.Get() {
diff --git a/venonactl/cmd/test.go b/venonactl/cmd/test.go
@@ -102,7 +102,7 @@ var testCommand = &cobra.Command{
 		}
 
 		options := plugins.TestOptions{
-			KubeBuilder:      getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster),
+			KubeBuilder:      getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, false),
 			ClusterNamespace: s.KubernetesAPI.Namespace,
 		}
 
diff --git a/venonactl/cmd/uninstall-agent.go b/venonactl/cmd/uninstall-agent.go
@@ -62,7 +62,7 @@ var uninstallAgentCmd = &cobra.Command{
 		s.KubernetesAPI.Namespace = uninstallAgentCmdOptions.kube.namespace
 
 		builder.Add(plugins.VenonaPluginType)
-		deleteOptions.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, false)
+		deleteOptions.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, false, false)
 		deleteOptions.ClusterNamespace = uninstallAgentCmdOptions.kube.namespace
 
 		values := s.BuildValues()
diff --git a/venonactl/cmd/uninstall-app-proxy.go b/venonactl/cmd/uninstall-app-proxy.go
@@ -61,6 +61,7 @@ var uninstallAppProxytCmd = &cobra.Command{
 			uninstallAppProxyCmdOptions.kube.context,
 			uninstallAppProxyCmdOptions.kube.namespace,
 			kubeConfigPath,
+			false,
 			false)
 
 		builder.Add(plugins.AppProxyPluginType)
diff --git a/venonactl/cmd/uninstall-monitor.go b/venonactl/cmd/uninstall-monitor.go
@@ -71,6 +71,7 @@ var uninstallMonitorAgentCmd = &cobra.Command{
 		deleteOptions.KubeBuilder = getKubeClientBuilder(uninstallMonitorAgentCmdOptions.kube.context,
 			s.KubernetesAPI.Namespace,
 			uninstallMonitorAgentCmdOptions.kube.kubePath,
+			false,
 			false)
 
 		builder.Add(plugins.MonitorAgentPluginType)
diff --git a/venonactl/cmd/uninstall-runtime.go b/venonactl/cmd/uninstall-runtime.go
@@ -89,12 +89,14 @@ var uninstallRuntimeCmd = &cobra.Command{
 		deleteOptions.KubeBuilder = getKubeClientBuilder(uninstallRunimeCmdOptions.kube.context,
 			uninstallRunimeCmdOptions.kube.namespace,
 			uninstallRunimeCmdOptions.kube.kubePath,
+			false,
 			false)
 
 		// agent
 		deleteOptions.AgentKubeBuilder = getKubeClientBuilder(uninstallRunimeCmdOptions.kubeVenona.context,
 			uninstallRunimeCmdOptions.kubeVenona.namespace,
 			uninstallRunimeCmdOptions.kubeVenona.kubePath,
+			false,
 			false)
 
 		builder.Add(plugins.RuntimeEnvironmentPluginType)
diff --git a/venonactl/cmd/upgrade-app-proxy.go b/venonactl/cmd/upgrade-app-proxy.go
@@ -70,7 +70,7 @@ var upgradeAppProxyCmd = &cobra.Command{
 				Name:             store.AppProxyApplicationName,
 				ClusterNamespace: upgradeAppProxyCmdOptions.kube.namespace,
 				ClusterName:      upgradeAppProxyCmdOptions.kube.namespace,
-				KubeBuilder:      getKubeClientBuilder(upgradeAppProxyCmdOptions.kube.context, upgradeAppProxyCmdOptions.kube.namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster),
+				KubeBuilder:      getKubeClientBuilder(upgradeAppProxyCmdOptions.kube.context, upgradeAppProxyCmdOptions.kube.namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, false),
 			}, values)
 			if err != nil {
 				dieOnError(err)
diff --git a/venonactl/cmd/upgrade.go b/venonactl/cmd/upgrade.go
@@ -75,7 +75,7 @@ var upgradeCmd = &cobra.Command{
 				Name:             s.AppName,
 				ClusterNamespace: upgradeCmdOpt.kube.namespace,
 				ClusterName:      upgradeCmdOpt.kube.namespace,
-				KubeBuilder:      getKubeClientBuilder(upgradeCmdOpt.kube.context, upgradeCmdOpt.kube.namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster),
+				KubeBuilder:      getKubeClientBuilder(upgradeCmdOpt.kube.context, upgradeCmdOpt.kube.namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, false),
 			}, values)
 			if err != nil {
 				dieOnError(err)
diff --git a/venonactl/pkg/kube/kube.go b/venonactl/pkg/kube/kube.go
@@ -22,13 +22,15 @@ type (
 		namespace        string
 		pathToKubeConfig string
 		inCluster        bool
+		dryRun           bool
 	}
 
 	Options struct {
 		ContextName      string
 		Namespace        string
 		PathToKubeConfig string
 		InCluster        bool
+		DryRun           bool
 	}
 )
 
@@ -38,6 +40,7 @@ func New(o *Options) Kube {
 		namespace:        o.Namespace,
 		pathToKubeConfig: o.PathToKubeConfig,
 		inCluster:        o.InCluster,
+		dryRun:           o.DryRun,
 	}
 }
 
@@ -60,6 +63,9 @@ func (k *kube) BuildClient() (*kubernetes.Clientset, error) {
 }
 
 func (k *kube) EnsureNamespaceExists(cs *kubernetes.Clientset) error {
+	if k.dryRun == true {
+		return nil
+	}
 	_, err := cs.CoreV1().Namespaces().Get(k.namespace, v1.GetOptions{})
 	if err != nil {
 		nsSpec := &v1Core.Namespace{ObjectMeta: metav1.ObjectMeta{Name: k.namespace}}
diff --git a/venonactl/pkg/plugins/plugin.go b/venonactl/pkg/plugins/plugin.go
@@ -2,6 +2,8 @@ package plugins
 
 import (
 	"fmt"
+	"io/ioutil"
+	"os"
 
 	"github.com/codefresh-io/venona/venonactl/pkg/logger"
 	"github.com/codefresh-io/venona/venonactl/pkg/obj/kubeobj"
@@ -238,16 +240,28 @@ func build(t string, logger logger.Logger) Plugin {
 
 func install(opt *installOptions) error {
 
+	if opt.dryRun == true {
+		err := os.Mkdir("codefresh_manifests", 0755)
+		if err != nil {
+			opt.logger.Error("failed to create manifests folder", "File-Name", "Error", err)
+		}
+		parsedTemplates, err := ParseTemplates(opt.templates, opt.templateValues, opt.matchPattern, opt.logger)
+		for fileName, objStr := range parsedTemplates {
+			err = ioutil.WriteFile(fmt.Sprintf("./codefresh_manifests/%s", fileName), []byte(objStr), 0644)
+			if err != nil {
+				opt.logger.Error(fmt.Sprintf("failed to write file %v", objStr), "File-Name", fileName, "Error", err)
+			}
+		}
+		return nil
+	}
+
 	kubeObjects, err := KubeObjectsFromTemplates(opt.templates, opt.templateValues, opt.matchPattern, opt.logger)
 	if err != nil {
 		return err
 	}
 
-	for fileName, obj := range kubeObjects {
-		if opt.dryRun == true {
-			opt.logger.Debug(fmt.Sprintf("%v", obj), "File-Name", fileName)
-			continue
-		}
+	for _, obj := range kubeObjects {
+
 		var createErr error
 		var kind, name string
 		name, kind, createErr = kubeobj.CreateObject(opt.kubeClientSet, obj, opt.namespace)
diff --git a/venonactl/pkg/plugins/runtime-attach.go b/venonactl/pkg/plugins/runtime-attach.go
@@ -110,6 +110,9 @@ func readCurrentVenonaConf(agentKubeBuilder KubeClientBuilder, clusterNamespace
 }
 
 func (u *runtimeAttachPlugin) Install(opt *InstallOptions, v Values) (Values, error) {
+	if opt.DryRun == true {
+		return v, nil
+	}
 	cs, err := opt.AgentKubeBuilder.BuildClient() // on the agent cluster
 	if err != nil {
 		u.logger.Error(fmt.Sprintf("Cannot create kubernetes clientset: %v ", err))

Original file line number	Diff line number	Diff line change
`@@ -165,12 +165,13 @@ func createTable() *tablewriter.Table {`
`165`	`165`	`return table`
`166`	`166`	`}`
`167`	`167`
`168`		`-func getKubeClientBuilder(context string, namespace string, path string, inCluster bool) kube.Kube {`
	`168`	`+func getKubeClientBuilder(context string, namespace string, path string, inCluster bool, dryRun bool) kube.Kube {`
`169`	`169`	`return kube.New(&kube.Options{`
`170`	`170`	`ContextName: context,`
`171`	`171`	`Namespace: namespace,`
`172`	`172`	`PathToKubeConfig: path,`
`173`	`173`	`InCluster: inCluster,`
	`174`	`+ DryRun: dryRun,`
`174`	`175`	`})`
`175`	`176`	`}`
`176`	`177`
`@@ -317,4 +318,4 @@ func mergeValueMSI(valuesMap map[string]interface{}, key string, param *map[stri`
`317`	`318`	`}`
`318`	`319`	`val := mapX.Get(key).MSI(defaultValue...)`
`319`	`320`	`*param = val`
`320`		`-}`
	`321`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ var installAppProxyCmd = &cobra.Command{`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`builderInstallOpt.ClusterName = s.KubernetesAPI.ContextName`
`89`		`- builderInstallOpt.KubeBuilder = getKubeClientBuilder(builderInstallOpt.ClusterName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)`
	`89`	`+ builderInstallOpt.KubeBuilder = getKubeClientBuilder(builderInstallOpt.ClusterName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, builderInstallOpt.DryRun)`
`90`	`90`	`builderInstallOpt.ClusterNamespace = s.KubernetesAPI.Namespace`
`91`	`91`	`builder.Add(plugins.AppProxyPluginType)`
`92`	`92`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ var installMonitorAgentCmd = &cobra.Command{`
`87`	`87`	`DryRun: installMonitorAgentCmdOptions.dryRun,`
`88`	`88`	`}`
`89`	`89`
`90`		`- builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)`
	`90`	`+ builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, installMonitorAgentCmdOptions.dryRun)`
`91`	`91`
`92`	`92`	`if installMonitorAgentCmdOptions.clusterId == "" {`
`93`	`93`	`dieOnError(fmt.Errorf("Cluster id is required in order to install monitor"))`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,9 @@ var installRuntimeCmd = &cobra.Command{`
`153`	`153`	`lgr.Info("Custom StorageClass is set, skipping installation of default volume provisioner")`
`154`	`154`	`}`
`155`	`155`
`156`		`- builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)`
	`156`	`+ builderInstallOpt.KubeBuilder = getKubeClientBuilder(s.KubernetesAPI.ContextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath,`
	`157`	`+ s.KubernetesAPI.InCluster,`
	`158`	`+ installRuntimeCmdOptions.dryRun)`
`157`	`159`	`values := s.BuildValues()`
`158`	`160`	`values = mergeMaps(values, templateValuesMap)`
`159`	`161`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ func printTableWithKubernetesRelatedResources(re *codefresh.RuntimeEnvironment,`
`113`	`113`	`Add(plugins.VenonaPluginType).`
`114`	`114`	`Add(plugins.VolumeProvisionerPluginType)`
`115`	`115`	`statusOpt := &plugins.StatusOptions{`
`116`		`- KubeBuilder: getKubeClientBuilder(context, re.RuntimeScheduler.Cluster.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster),`
	`116`	`+ KubeBuilder: getKubeClientBuilder(context, re.RuntimeScheduler.Cluster.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster, false),`
`117`	`117`	`ClusterNamespace: s.KubernetesAPI.Namespace,`
`118`	`118`	`}`
`119`	`119`	`for _, p := range builder.Get() {`