code refactor

move out the dependency on store from inner packages
add new logger, removed logrus
more...

Author: Oleg Sucharevich

.gitignore

@@ -14,3 +14,4 @@ yarn-error.log
 .idea/*
 telepresence.log
 venonactl/dist/*
+venonalog.json

package.json

@@ -1,6 +1,6 @@
 {
   "name": "venona",
-  "version": "0.17.2",
+  "version": "0.18.0",
   "description": "Codefresh agent to run on Codefresh's runtime environment and execute pipeline",
   "main": "index.js",
   "scripts": {

venonactl/cmd/cmdutils.go

@@ -10,10 +10,11 @@ import (
 	"github.com/codefresh-io/go-sdk/pkg/codefresh"
 	sdkUtils "github.com/codefresh-io/go-sdk/pkg/utils"
 	"github.com/codefresh-io/venona/venonactl/pkg/certs"
+	"github.com/codefresh-io/venona/venonactl/pkg/kube"
+	"github.com/codefresh-io/venona/venonactl/pkg/logger"
 	"github.com/codefresh-io/venona/venonactl/pkg/plugins"
 	"github.com/codefresh-io/venona/venonactl/pkg/store"
 	"github.com/olekukonko/tablewriter"
-	"github.com/sirupsen/logrus"
 )
 
 var (
@@ -36,7 +37,7 @@ var (
 	skipVerionCheck bool
 )
 
-func buildBasicStore() {
+func buildBasicStore(logger logger.Logger) {
 	s := store.GetStore()
 	s.Version = &store.Version{
 		Current: &store.CurrentVersion{
@@ -62,13 +63,10 @@ func buildBasicStore() {
 			IsDefault: true,
 		}
 		s.Version.Latest = latestVersion
-		logrus.WithFields(logrus.Fields{
-			"Default-Version": store.DefaultVersion,
-			"Image-Tag":       s.Version.Current.Version,
-		}).Debug("Skipping version check")
+		logger.Debug("Skipping version check")
 	} else {
 		latestVersion := &store.LatestVersion{
-			Version:   store.GetLatestVersion(),
+			Version:   store.GetLatestVersion(logger),
 			IsDefault: false,
 		}
 		s.Image.Tag = latestVersion.Version
@@ -77,15 +75,14 @@ func buildBasicStore() {
 		// the local version and the latest version not match
 		// make sure the command is no venonactl version
 		if !res {
-			logrus.WithFields(logrus.Fields{
-				"Local-Version":  s.Version.Current.Version,
-				"Latest-Version": s.Version.Latest.Version,
-			}).Info("New version is avaliable, please update")
+			logger.Info("New version is avaliable, please update",
+				"Local-Version", s.Version.Current.Version,
+				"Latest-Version", s.Version.Latest.Version)
 		}
 	}
 }
 
-func extendStoreWithCodefershClient() error {
+func extendStoreWithCodefershClient(logger logger.Logger) error {
 	s := store.GetStore()
 	if configPath == "" {
 		configPath = fmt.Sprintf("%s/.cfconfig", os.Getenv("HOME"))
@@ -98,13 +95,9 @@ func extendStoreWithCodefershClient() error {
 		}
 		cfAPIHost = context.URL
 		cfAPIToken = context.Token
-
-		logrus.WithFields(logrus.Fields{
-			"Context-Name":   context.Name,
-			"Codefresh-Host": cfAPIHost,
-		}).Debug("Using codefresh context")
+		logger.Debug("Using codefresh context", "Context-Name", context.Name, "Host", cfAPIHost)
 	} else {
-		logrus.Debug("Using creentials from environment variables")
+		logger.Debug("Reading creentials from environment variables")
 	}
 
 	client := codefresh.New(&codefresh.ClientOptions{
@@ -122,15 +115,13 @@ func extendStoreWithCodefershClient() error {
 	return nil
 }
 
-func extendStoreWithKubeClient() {
+func extendStoreWithKubeClient(logger logger.Logger) {
 	s := store.GetStore()
 	if kubeConfigPath == "" {
 		currentUser, _ := user.Current()
 		if currentUser != nil {
 			kubeConfigPath = path.Join(currentUser.HomeDir, ".kube", "config")
-			logrus.WithFields(logrus.Fields{
-				"Kube-Config-Path": kubeConfigPath,
-			}).Debug("Path to kubeconfig not set, using default")
+			logger.Debug("Path to kubeconfig not set, using default")
 		}
 	}
 
@@ -139,12 +130,6 @@ func extendStoreWithKubeClient() {
 	}
 }
 
-func prepareLogger() {
-	if verbose == true {
-		logrus.SetLevel(logrus.DebugLevel)
-	}
-}
-
 func isUsingDefaultStorageClass(sc string) bool {
 	if sc == "" {
 		return true
@@ -154,7 +139,7 @@ func isUsingDefaultStorageClass(sc string) bool {
 
 func dieOnError(err error) {
 	if err != nil {
-		logrus.Error(err)
+		fmt.Printf("Error: %s", err.Error())
 		os.Exit(1)
 	}
 }
@@ -170,3 +155,22 @@ func createTable() *tablewriter.Table {
 	table.SetColWidth(100)
 	return table
 }
+
+func getKubeClientBuilder(context string, namespace string, path string, inCluster bool) kube.Kube {
+	return kube.New(&kube.Options{
+		ContextName:      context,
+		Namespace:        namespace,
+		PathToKubeConfig: path,
+		InCluster:        inCluster,
+	})
+}
+
+func createLogger(command string, verbose bool) logger.Logger {
+	logFile := "venonalog.json"
+	os.Remove(logFile)
+	return logger.New(&logger.Options{
+		Command:   command,
+		Verbose:   verbose,
+		LogToFile: logFile,
+	})
+}

venonactl/cmd/delete.go

@@ -18,10 +18,10 @@ limitations under the License.
 
 import (
 	"errors"
+	"fmt"
 	"os"
 
 	"github.com/codefresh-io/venona/venonactl/pkg/store"
-	"github.com/sirupsen/logrus"
 
 	"github.com/codefresh-io/venona/venonactl/pkg/plugins"
 	"github.com/spf13/cobra"
@@ -53,14 +53,14 @@ var deleteCmd = &cobra.Command{
 	},
 	Run: func(cmd *cobra.Command, args []string) {
 		s := store.GetStore()
-		prepareLogger()
-		buildBasicStore()
-		extendStoreWithCodefershClient()
-		extendStoreWithKubeClient()
+		lgr := createLogger("Delete", verbose)
+		buildBasicStore(lgr)
+		extendStoreWithCodefershClient(lgr)
+		extendStoreWithKubeClient(lgr)
 		var errors []DeletionError
 		s.KubernetesAPI.InCluster = deleteCmdOptions.kube.inCluster
 		for _, name := range args {
-			builder := plugins.NewBuilder()
+			builder := plugins.NewBuilder(lgr)
 
 			re, err := s.CodefreshAPI.Client.RuntimeEnvironments().Get(name)
 			errors = collectError(errors, err, name)
@@ -71,7 +71,7 @@ var deleteCmd = &cobra.Command{
 			}
 			deleted, err := s.CodefreshAPI.Client.RuntimeEnvironments().Delete(name)
 			errors = collectError(errors, err, name)
-
+			deleteOptions := &plugins.DeleteOptions{}
 			if deleted {
 				contextName := re.RuntimeScheduler.Cluster.ClusterProvider.Selector
 				if contextName != "" {
@@ -89,25 +89,25 @@ var deleteCmd = &cobra.Command{
 					builder.Add(plugins.VenonaPluginType)
 				}
 
+				deleteOptions.KubeBuilder = getKubeClientBuilder(contextName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)
+				deleteOptions.ClusterNamespace = re.RuntimeScheduler.Cluster.Namespace
 				for _, p := range builder.Get() {
-					err := p.Delete(nil)
+					err := p.Delete(deleteOptions, s.BuildValues())
 					collectError(errors, err, name)
 				}
 
-				logrus.Infof("Deleted %s", name)
+				lgr.Info("Deletion completed", "Name", name)
 			}
 
 		}
 
 		if len(errors) > 0 {
 			for _, e := range errors {
-				logrus.WithFields(logrus.Fields{
-					"runtime-environment": e.name,
-				}).Errorf("Failed during operation %s with error %s", e.operation, e.err.Error())
+				lgr.Error(fmt.Sprintf("Error %s", e.err.Error()), "Name", e.name, "Operation", e.operation)
 			}
 			os.Exit(1)
 		}
-		logrus.Info("Deletion completed")
+		lgr.Info("Deletion completed")
 	},
 }
 

venonactl/cmd/install.go

@@ -19,7 +19,6 @@ limitations under the License.
 import (
 	"fmt"
 
-	"github.com/sirupsen/logrus"
 	"k8s.io/client-go/tools/clientcmd"
 
 	"github.com/codefresh-io/venona/venonactl/pkg/store"
@@ -53,21 +52,21 @@ var installCmd = &cobra.Command{
 	Short: "Install Codefresh's runtime-environment",
 	Run: func(cmd *cobra.Command, args []string) {
 		s := store.GetStore()
-		prepareLogger()
-		buildBasicStore()
-		extendStoreWithCodefershClient()
-		extendStoreWithKubeClient()
+		lgr := createLogger("Install", verbose)
+		buildBasicStore(lgr)
+		extendStoreWithCodefershClient(lgr)
+		extendStoreWithKubeClient(lgr)
 
-		builder := plugins.NewBuilder()
+		builder := plugins.NewBuilder(lgr)
 		isDefault := isUsingDefaultStorageClass(installCmdOptions.storageClass)
 
 		builderInstallOpt := &plugins.InstallOptions{
 			CodefreshHost:         s.CodefreshAPI.Host,
 			CodefreshToken:        s.CodefreshAPI.Token,
-			ClusterNamespace:      s.KubernetesAPI.Namespace,
 			MarkAsDefault:         installCmdOptions.setDefaultRuntime,
 			StorageClass:          installCmdOptions.storageClass,
 			IsDefaultStorageClass: isDefault,
+			DryRun:                installCmdOptions.dryRun,
 		}
 		if isDefault {
 			builderInstallOpt.StorageClass = plugins.DefaultStorageClassNamePrefix
@@ -76,9 +75,7 @@ var installCmd = &cobra.Command{
 		if installCmdOptions.kube.context == "" {
 			config := clientcmd.GetConfigFromFileOrDie(s.KubernetesAPI.ConfigPath)
 			installCmdOptions.kube.context = config.CurrentContext
-			logrus.WithFields(logrus.Fields{
-				"Kube-Context-Name": installCmdOptions.kube.context,
-			}).Debug("Kube Context is not set, using current context")
+			lgr.Debug("Kube Context is not set, using current context", "Kube-Context-Name", installCmdOptions.kube.context)
 		}
 		if installCmdOptions.kube.namespace == "" {
 			installCmdOptions.kube.namespace = "default"
@@ -91,13 +88,11 @@ var installCmd = &cobra.Command{
 
 		if installCmdOptions.dryRun {
 			s.DryRun = installCmdOptions.dryRun
-			logrus.Info("Running in dry-run mode")
+			lgr.Info("Running in dry-run mode")
 		}
 		if installCmdOptions.venona.version != "" {
 			version := installCmdOptions.venona.version
-			logrus.WithFields(logrus.Fields{
-				"venona-Version": version,
-			}).Info("venona version set by user")
+			lgr.Info("Version set manually", "version", version)
 			s.Image.Tag = version
 			s.Version.Latest.Version = version
 		}
@@ -112,7 +107,7 @@ var installCmd = &cobra.Command{
 				dieOnError(fmt.Errorf("runtime-environment flag is required when using flag skip-runtime-installation"))
 			}
 			s.RuntimeEnvironment = installCmdOptions.runtimeEnvironmentName
-			logrus.Info("Skipping installation of runtime environment, installing venona only")
+			lgr.Info("Skipping installation of runtime environment, installing venona only")
 			builder.Add(plugins.VenonaPluginType)
 		} else {
 			builder.
@@ -122,7 +117,7 @@ var installCmd = &cobra.Command{
 		if isDefault {
 			builder.Add(plugins.VolumeProvisionerPluginType)
 		} else {
-			logrus.Info("Custom StorageClass is set, skipping installation of default volume provisioner")
+			lgr.Info("Custom StorageClass is set, skipping installation of default volume provisioner")
 		}
 
 		builderInstallOpt.ClusterName = s.KubernetesAPI.ContextName
@@ -131,13 +126,18 @@ var installCmd = &cobra.Command{
 			builderInstallOpt.ClusterName = s.ClusterInCodefresh
 			builderInstallOpt.RegisterWithAgent = false
 		}
+		builderInstallOpt.KubeBuilder = getKubeClientBuilder(builderInstallOpt.ClusterName, s.KubernetesAPI.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster)
+		builderInstallOpt.ClusterNamespace = s.KubernetesAPI.Namespace
 
+		values := s.BuildValues()
+		var err error
 		for _, p := range builder.Get() {
-			if err := p.Install(builderInstallOpt); err != nil {
+			values, err = p.Install(builderInstallOpt, values)
+			if err != nil {
 				dieOnError(err)
 			}
 		}
-		logrus.Info("Installation completed Successfully\n")
+		lgr.Info("Installation completed Successfully")
 	},
 }
 

venonactl/cmd/status.go

@@ -19,9 +19,8 @@ limitations under the License.
 import (
 	"fmt"
 
-	"github.com/sirupsen/logrus"
-
 	"github.com/codefresh-io/go-sdk/pkg/codefresh"
+	"github.com/codefresh-io/venona/venonactl/pkg/logger"
 	"github.com/codefresh-io/venona/venonactl/pkg/plugins"
 	"github.com/codefresh-io/venona/venonactl/pkg/store"
 	humanize "github.com/dustin/go-humanize"
@@ -42,11 +41,11 @@ var statusCmd = &cobra.Command{
 	Short: "Get status of Codefresh's runtime-environment",
 	Long:  "Pass the name of the runtime environment to see more details information about the underlying resources",
 	Run: func(cmd *cobra.Command, args []string) {
-		prepareLogger()
-		buildBasicStore()
-		extendStoreWithCodefershClient()
-		extendStoreWithKubeClient()
+		lgr := createLogger("Status", verbose)
 
+		buildBasicStore(lgr)
+		extendStoreWithCodefershClient(lgr)
+		extendStoreWithKubeClient(lgr)
 		s := store.GetStore()
 		table := createTable()
 		// When requested status for specific runtime
@@ -68,9 +67,9 @@ var statusCmd = &cobra.Command{
 				table.Append([]string{re.Metadata.Name, message, time})
 				table.Render()
 				fmt.Println()
-				printTableWithKubernetesRelatedResources(re, statusCmdOpt.kube.context)
+				printTableWithKubernetesRelatedResources(re, statusCmdOpt.kube.context, lgr)
 			} else {
-				logrus.Warnf("Runtime-Environment %s has not Venona's agent", name)
+				lgr.Debug("Runtime-Environment has not Venona's agent", "Name", name)
 			}
 			return
 		}
@@ -97,8 +96,8 @@ var statusCmd = &cobra.Command{
 	},
 }
 
-func printTableWithKubernetesRelatedResources(re *codefresh.RuntimeEnvironment, context string) {
-	builder := plugins.NewBuilder()
+func printTableWithKubernetesRelatedResources(re *codefresh.RuntimeEnvironment, context string, logger logger.Logger) {
+	builder := plugins.NewBuilder(logger)
 
 	table := createTable()
 	table.SetHeader([]string{"Kind", "Name", "Status"})
@@ -113,9 +112,12 @@ func printTableWithKubernetesRelatedResources(re *codefresh.RuntimeEnvironment,
 			Add(plugins.RuntimeEnvironmentPluginType).
 			Add(plugins.VenonaPluginType).
 			Add(plugins.VolumeProvisionerPluginType)
-
+		statusOpt := &plugins.StatusOptions{
+			KubeBuilder:      getKubeClientBuilder(context, re.RuntimeScheduler.Cluster.Namespace, s.KubernetesAPI.ConfigPath, s.KubernetesAPI.InCluster),
+			ClusterNamespace: s.KubernetesAPI.Namespace,
+		}
 		for _, p := range builder.Get() {
-			rows, err := p.Status(nil)
+			rows, err := p.Status(statusOpt, s.BuildValues())
 			dieOnError(err)
 			table.AppendBulk(rows)
 		}