Acceptance test (#112)

* add acceptance test during installation

Author: Oleg Sucharevich

package.json

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

venonactl/VERSION

@@ -1 +1 @@
-1.0.8
+1.1.0

venonactl/cmd/install-agent.go

@@ -37,10 +37,11 @@ var installAgentCmdOptions struct {
 	venona struct {
 		version string
 	}
-	agentToken           string
-	agentID              string
-	kubernetesRunnerType bool
-	tolerations          string
+	agentToken                string
+	agentID                   string
+	kubernetesRunnerType      bool
+	tolerations               string
+	skipClusterAcceptanceTest bool
 }
 
 var installAgentCmd = &cobra.Command{
@@ -54,12 +55,12 @@ var installAgentCmd = &cobra.Command{
 		extendStoreWithKubeClient(lgr)
 		fillCodefreshAPI(lgr)
 		builder := plugins.NewBuilder(lgr)
-
 		if cfAPIHost == "" {
 			cfAPIHost = "https://g.codefresh.io"
 		}
 		builderInstallOpt := &plugins.InstallOptions{
-			CodefreshHost: cfAPIHost,
+			CodefreshHost:      cfAPIHost,
+			SkipAcceptanceTest: installAgentCmdOptions.skipClusterAcceptanceTest,
 		}
 
 		if installAgentCmdOptions.agentToken == "" {
@@ -115,7 +116,6 @@ var installAgentCmd = &cobra.Command{
 			}
 		}
 		lgr.Info("Agent installation completed Successfully")
-
 	},
 }
 
@@ -135,6 +135,7 @@ func init() {
 	installAgentCmd.Flags().BoolVar(&installAgentCmdOptions.kube.inCluster, "in-cluster", false, "Set flag if venona is been installed from inside a cluster")
 	installAgentCmd.Flags().BoolVar(&installAgentCmdOptions.dryRun, "dry-run", false, "Set to true to simulate installation")
 	installAgentCmd.Flags().BoolVar(&installAgentCmdOptions.kubernetesRunnerType, "kubernetes-runner-type", false, "Set the runner type to kubernetes (alpha feature)")
+	installAgentCmd.Flags().BoolVar(&installAgentCmdOptions.skipClusterAcceptanceTest, "skip-cluster-test", false, "Do not run cluster acceptance test")
 }
 
 func fillCodefreshAPI(logger logger.Logger) {

venonactl/cmd/install-runtime.go

@@ -29,17 +29,18 @@ var installRuntimeCmdOptions struct {
 	codefreshToken string
 	dryRun         bool
 	kube           struct {
-		namespace string
-		inCluster bool
-		context   string
+		namespace    string
+		inCluster    bool
+		context      string
 		nodeSelector string
 	}
-	storageClass           string
-	runtimeEnvironmentName string
-	kubernetesRunnerType   bool
-	tolerations            string
-	templateValues         []string
-	templateFileValues     []string
+	storageClass              string
+	runtimeEnvironmentName    string
+	kubernetesRunnerType      bool
+	tolerations               string
+	templateValues            []string
+	templateFileValues        []string
+	skipClusterAcceptanceTest bool
 }
 
 var installRuntimeCmd = &cobra.Command{
@@ -99,6 +100,7 @@ var installRuntimeCmd = &cobra.Command{
 			CodefreshToken:        installRuntimeCmdOptions.codefreshToken,
 			RuntimeEnvironment:    installRuntimeCmdOptions.runtimeEnvironmentName,
 			ClusterNamespace:      installRuntimeCmdOptions.kube.namespace,
+			SkipAcceptanceTest:    installRuntimeCmdOptions.skipClusterAcceptanceTest,
 		}
 
 		if installRuntimeCmdOptions.kubernetesRunnerType {
@@ -176,5 +178,6 @@ func init() {
 
 	installRuntimeCmd.Flags().StringArrayVar(&installRuntimeCmdOptions.templateValues, "set-value", []string{}, "Set values for templates, example: --set-value LocalVolumesDir=/mnt/disks/ssd0/codefresh-volumes")
 	installRuntimeCmd.Flags().StringArrayVar(&installRuntimeCmdOptions.templateFileValues, "set-file", []string{}, "Set values for templates from file, example: --set-file Storage.GoogleServiceAccount=/path/to/service-account.json")
+	installRuntimeCmd.Flags().BoolVar(&installRuntimeCmdOptions.skipClusterAcceptanceTest, "skip-cluster-test", false, "Do not run cluster acceptance test")
 
 }

venonactl/pkg/plugins/helper.go

@@ -18,22 +18,40 @@ package plugins
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"html/template"
 	"regexp"
 	"strings"
 
 	// import all cloud providers auth clients
+	v1 "k8s.io/api/core/v1"
+	"k8s.io/client-go/kubernetes"
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 
 	"github.com/Masterminds/sprig"
 	"github.com/codefresh-io/venona/venonactl/pkg/logger"
 	templates "github.com/codefresh-io/venona/venonactl/pkg/templates/kubernetes"
 
+	"k8s.io/apimachinery/pkg/api/resource"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/kubernetes/scheme"
 )
 
+type (
+	validationResult struct {
+		isValid bool
+		message []string
+	}
+
+	validationRequest struct {
+		cpu                  string
+		localDiskMinimumSize string
+		momorySize           string
+	}
+)
+
 func unescape(s string) template.HTML {
 	return template.HTML(s)
 }
@@ -42,7 +60,7 @@ func unescape(s string) template.HTML {
 func nodeSelectorParamToYaml(ns string) string {
 	nodeSelectorParts := strings.Split(ns, ",")
 	var nodeSelectorYaml string
-	for _, p := range(nodeSelectorParts){
+	for _, p := range nodeSelectorParts {
 		pSplit := strings.Split(p, "=")
 		if len(pSplit) != 2 {
 			continue
@@ -59,9 +77,9 @@ func nodeSelectorParamToYaml(ns string) string {
 // ExecuteTemplate - executes templates in tpl str with config as values
 func ExecuteTemplate(tplStr string, data interface{}) (string, error) {
 	funcMap := template.FuncMap{
-		          "unescape": unescape,
-							"nodeSelectorParamToYaml": nodeSelectorParamToYaml,
-             }
+		"unescape":                unescape,
+		"nodeSelectorParamToYaml": nodeSelectorParamToYaml,
+	}
 	template, err := template.New("base").Funcs(sprig.FuncMap()).Funcs(funcMap).Parse(tplStr)
 	if err != nil {
 		return "", err
@@ -130,3 +148,68 @@ func getKubeObjectsFromTempalte(values map[string]interface{}, pattern string, l
 	templatesMap := templates.TemplatesMap()
 	return KubeObjectsFromTemplates(templatesMap, values, pattern, logger)
 }
+
+func ensureClusterRequirements(client *kubernetes.Clientset, req validationRequest) (validationResult, error) {
+	result := validationResult{}
+	nodes, err := client.CoreV1().Nodes().List(metav1.ListOptions{})
+	if err != nil {
+		return result, err
+	}
+	if nodes == nil {
+		return result, errors.New("Nodes not found")
+	}
+
+	result.isValid = true
+	if len(nodes.Items) == 0 {
+		result.message = append(result.message, "No nodes in cluster")
+		result.isValid = false
+	}
+
+	atLeastOneMet := false
+	for _, n := range nodes.Items {
+		res := testNode(n, req)
+		if len(res) > 0 {
+			result.message = append(result.message, res...)
+		} else {
+			atLeastOneMet = true
+		}
+	}
+	if !atLeastOneMet {
+		result.isValid = false
+		return result, nil
+	}
+	return result, nil
+}
+
+func testNode(n v1.Node, req validationRequest) []string {
+	result := []string{}
+
+	if req.cpu != "" {
+		requiredCPU, err := resource.ParseQuantity(req.cpu)
+		if err != nil {
+			result = append(result, err.Error())
+			return result
+		}
+		cpu := n.Status.Capacity.Cpu()
+
+		if cpu != nil && cpu.Cmp(requiredCPU) == -1 {
+			msg := fmt.Sprintf("Insufficiant CPU on node %s, current: %s - required: %s", n.GetObjectMeta().GetName(), cpu.String(), requiredCPU.String())
+			result = append(result, msg)
+		}
+	}
+
+	if req.momorySize != "" {
+		requiredMemory, err := resource.ParseQuantity(req.momorySize)
+		if err != nil {
+			result = append(result, err.Error())
+			return result
+		}
+		memory := n.Status.Capacity.Memory()
+		if memory != nil && memory.Cmp(requiredMemory) == -1 {
+			msg := fmt.Sprintf("Insufficiant Memory on node %s, current: %s - required: %s", n.GetObjectMeta().GetName(), memory.String(), requiredMemory.String())
+			result = append(result, msg)
+		}
+	}
+
+	return result
+}

venonactl/pkg/plugins/plugin.go

@@ -17,7 +17,7 @@ const (
 	VolumeProvisionerPluginType   = "volume-provisioner"
 	EnginePluginType              = "engine"
 	DefaultStorageClassNamePrefix = "dind-local-volumes-venona"
-	RuntimeAttachType			  = "runtime-attach"
+	RuntimeAttachType             = "runtime-attach"
 )
 
 type (
@@ -56,35 +56,34 @@ type (
 		KubeBuilder           interface {
 			BuildClient() (*kubernetes.Clientset, error)
 			BuildConfig() clientcmd.ClientConfig
-			EnsureNamespaceExists(cs *kubernetes.Clientset) (error)
-			
+			EnsureNamespaceExists(cs *kubernetes.Clientset) error
 		}
-		AgentKubeBuilder	  interface {
+		AgentKubeBuilder interface {
 			BuildClient() (*kubernetes.Clientset, error)
-			EnsureNamespaceExists(cs *kubernetes.Clientset) (error)
+			EnsureNamespaceExists(cs *kubernetes.Clientset) error
 		}
-		DryRun               bool
-		KubernetesRunnerType bool
-		BuildNodeSelector    map[string]string
-		Annotations          map[string]string
-		RuntimeEnvironment   string
-		RuntimeClusterName   string
+		DryRun                bool
+		KubernetesRunnerType  bool
+		BuildNodeSelector     map[string]string
+		Annotations           map[string]string
+		RuntimeEnvironment    string
+		RuntimeClusterName    string
 		RuntimeServiceAccount string
-		RestartAgent        bool
+		RestartAgent          bool
+		SkipAcceptanceTest    bool
 	}
 
 	DeleteOptions struct {
 		KubeBuilder interface {
 			BuildClient() (*kubernetes.Clientset, error)
 		}
-		AgentKubeBuilder	  interface {
+		AgentKubeBuilder interface {
 			BuildClient() (*kubernetes.Clientset, error)
 		}
-		ClusterNamespace string // runtime
-		AgentNamespace   string // agent
-		RuntimeEnvironment   string
-		RestartAgent        bool
-
+		ClusterNamespace   string // runtime
+		AgentNamespace     string // agent
+		RuntimeEnvironment string
+		RestartAgent       bool
 	}
 
 	UpgradeOptions struct {

venonactl/pkg/plugins/runtime-environment.go

@@ -18,6 +18,7 @@ package plugins
 
 import (
 	"encoding/base64"
+	"errors"
 	"fmt"
 
 	"github.com/codefresh-io/venona/venonactl/pkg/codefresh"
@@ -40,7 +41,7 @@ func (u *runtimeEnvironmentPlugin) Install(opt *InstallOptions, v Values) (Value
 	if err != nil {
 		return nil, fmt.Errorf("Cannot create kubernetes clientset: %v ", err)
 	}
-	
+
 	err = opt.KubeBuilder.EnsureNamespaceExists(cs)
 	if err != nil {
 		u.logger.Error(fmt.Sprintf("Cannot ensure namespace exists: %v", err))
@@ -83,6 +84,27 @@ func (u *runtimeEnvironmentPlugin) Install(opt *InstallOptions, v Values) (Value
 		return nil, err
 	}
 
+	if !opt.SkipAcceptanceTest {
+		u.logger.Debug("Running acceptance tests")
+		res, err := ensureClusterRequirements(cs, validationRequest{
+			cpu:        "1",
+			momorySize: "1Gi",
+		})
+		if err != nil {
+			return nil, err
+		}
+		if !res.isValid {
+			for _, m := range res.message {
+				u.logger.Error(m)
+			}
+			return nil, errors.New("Failed to run acceptance test on cluster")
+		}
+
+		for _, m := range res.message {
+			u.logger.Warn(m)
+		}
+	}
+
 	v["RuntimeEnvironment"] = opt.RuntimeEnvironment
 	err = install(&installOptions{
 		logger:         u.logger,

venonactl/pkg/plugins/venona.go

@@ -18,6 +18,7 @@ package plugins
 
 import (
 	"encoding/base64"
+	"errors"
 	"fmt"
 	"time"
 
@@ -39,7 +40,7 @@ const (
 
 // Install venona agent
 func (u *venonaPlugin) Install(opt *InstallOptions, v Values) (Values, error) {
-	if  v["AgentToken"] == "" {
+	if v["AgentToken"] == "" {
 		u.logger.Debug("Generating token for agent")
 		tokenName := fmt.Sprintf("generated-%s", time.Now().Format("20060102150405"))
 		u.logger.Debug(fmt.Sprintf("Token candidate name: %s", tokenName))
@@ -72,6 +73,27 @@ func (u *venonaPlugin) Install(opt *InstallOptions, v Values) (Values, error) {
 		u.logger.Error(fmt.Sprintf("Cannot ensure namespace exists: %v", err))
 		return nil, err
 	}
+	if !opt.SkipAcceptanceTest {
+		u.logger.Debug("Running acceptance tests")
+		res, err := ensureClusterRequirements(cs, validationRequest{
+			cpu:        "500m",
+			momorySize: "1Gi",
+		})
+		if err != nil {
+			return nil, err
+		}
+		if !res.isValid {
+			for _, m := range res.message {
+				u.logger.Error(m)
+			}
+			return nil, errors.New("Failed to run acceptance test on cluster")
+		}
+
+		for _, m := range res.message {
+			u.logger.Warn(m)
+		}
+	}
+
 	return v, install(&installOptions{
 		logger:         u.logger,
 		templates:      templates.TemplatesMap(),