feat: added cluster validation for save/update (#2467)

* updated validation

* updated error messaging

* added unit test case

* added integration test cases

* review changes

Author: kartik-579

pkg/cluster/ClusterService.go

@@ -21,7 +21,11 @@ import (
 	"context"
 	"fmt"
 	"io/ioutil"
+	"k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/client-go/kubernetes"
 	v12 "k8s.io/client-go/kubernetes/typed/core/v1"
+	"k8s.io/client-go/rest"
+	"net/url"
 	"os"
 	"time"
 
@@ -35,6 +39,8 @@ import (
 	"go.uber.org/zap"
 )
 
+const DEFAULT_CLUSTER = "default_cluster"
+
 type ClusterBean struct {
 	Id                      int                        `json:"id,omitempty" validate:"number"`
 	ClusterName             string                     `json:"cluster_name,omitempty" validate:"required"`
@@ -133,6 +139,11 @@ func (impl *ClusterServiceImpl) GetClusterConfig(cluster *ClusterBean) (*util.Cl
 }
 
 func (impl *ClusterServiceImpl) Save(parent context.Context, bean *ClusterBean, userId int32) (*ClusterBean, error) {
+	//validating config
+	err := impl.CheckIfConfigIsValid(bean)
+	if err != nil {
+		return nil, err
+	}
 	existingModel, err := impl.clusterRepository.FindOne(bean.ClusterName)
 	if err != nil && err != pg.ErrNoRows {
 		impl.logger.Error(err)
@@ -323,6 +334,11 @@ func (impl *ClusterServiceImpl) FindByIds(ids []int) ([]ClusterBean, error) {
 }
 
 func (impl *ClusterServiceImpl) Update(ctx context.Context, bean *ClusterBean, userId int32) (*ClusterBean, error) {
+	//validating config
+	err := impl.CheckIfConfigIsValid(bean)
+	if err != nil {
+		return nil, err
+	}
 	model, err := impl.clusterRepository.FindById(bean.Id)
 	if err != nil {
 		impl.logger.Error(err)
@@ -478,3 +494,43 @@ func (impl ClusterServiceImpl) DeleteFromDb(bean *ClusterBean, userId int32) err
 	}
 	return nil
 }
+
+func (impl ClusterServiceImpl) CheckIfConfigIsValid(cluster *ClusterBean) error {
+	configMap := cluster.Config
+	bearerToken := configMap["bearer_token"]
+	var restConfig *rest.Config
+	var err error
+	if cluster.ClusterName == DEFAULT_CLUSTER && len(bearerToken) == 0 {
+		restConfig, err = rest.InClusterConfig()
+		if err != nil {
+			impl.logger.Errorw("error in getting rest config for default cluster", "err", err)
+			return err
+		}
+	} else {
+		restConfig = &rest.Config{Host: cluster.ServerUrl, BearerToken: bearerToken, TLSClientConfig: rest.TLSClientConfig{Insecure: true}}
+	}
+	k8sClientSet, err := kubernetes.NewForConfig(restConfig)
+	if err != nil {
+		impl.logger.Errorw("error in getting client set by rest config", "err", err, "restConfig", restConfig)
+		return err
+	}
+	//using livez path as healthz path is deprecated
+	path := "/livez"
+	response, err := k8sClientSet.Discovery().RESTClient().Get().AbsPath(path).DoRaw(context.Background())
+	if err != nil {
+		if _, ok := err.(*url.Error); ok {
+			return fmt.Errorf("Incorrect server url : %v", err)
+		} else if statusError, ok := err.(*errors.StatusError); ok {
+			if statusError != nil {
+				return fmt.Errorf("%s : %s", statusError.ErrStatus.Reason, statusError.ErrStatus.Message)
+			} else {
+				return fmt.Errorf("Validation failed : %v", err)
+			}
+		} else {
+			return fmt.Errorf("Validation failed : %v", err)
+		}
+	} else if err == nil && string(response) != "ok" {
+		return fmt.Errorf("Validation failed with response : %s", string(response))
+	}
+	return nil
+}

pkg/cluster/ClusterServiceExtended.go

@@ -21,7 +21,7 @@ import (
 	"go.uber.org/zap"
 )
 
-//extends ClusterServiceImpl and enhances method of ClusterService with full mode specific errors
+// extends ClusterServiceImpl and enhances method of ClusterService with full mode specific errors
 type ClusterServiceImplExtended struct {
 	environmentRepository  repository.EnvironmentRepository
 	grafanaClient          grafana.GrafanaClient
@@ -126,12 +126,17 @@ func (impl *ClusterServiceImplExtended) FindAll() ([]*ClusterBean, error) {
 }
 
 func (impl *ClusterServiceImplExtended) Update(ctx context.Context, bean *ClusterBean, userId int32) (*ClusterBean, error) {
+	//validating config
+	err := impl.CheckIfConfigIsValid(bean)
+	if err != nil {
+		return nil, err
+	}
 	isGitOpsConfigured, err1 := impl.gitOpsRepository.IsGitOpsConfigured()
 	if err1 != nil {
 		return nil, err1
 	}
 
-	bean, err := impl.ClusterServiceImpl.Update(ctx, bean, userId)
+	bean, err = impl.ClusterServiceImpl.Update(ctx, bean, userId)
 	if err != nil {
 		return nil, err
 	}
@@ -299,6 +304,11 @@ func (impl *ClusterServiceImplExtended) CreateGrafanaDataSource(clusterBean *Clu
 }
 
 func (impl *ClusterServiceImplExtended) Save(ctx context.Context, bean *ClusterBean, userId int32) (*ClusterBean, error) {
+	//validating config
+	err := impl.CheckIfConfigIsValid(bean)
+	if err != nil {
+		return nil, err
+	}
 	isGitOpsConfigured, err := impl.gitOpsRepository.IsGitOpsConfigured()
 	if err != nil {
 		return nil, err

pkg/cluster/ClusterService_test.go

@@ -0,0 +1,70 @@
+package cluster
+
+import (
+	"github.com/devtron-labs/devtron/client/k8s/informer"
+	"github.com/devtron-labs/devtron/internal/util"
+	"github.com/devtron-labs/devtron/pkg/cluster/repository"
+	"go.uber.org/zap"
+	"testing"
+)
+
+func TestClusterServiceImpl_CheckIfConfigIsValid(t *testing.T) {
+	t.SkipNow()
+	type fields struct {
+		clusterRepository  repository.ClusterRepository
+		logger             *zap.SugaredLogger
+		K8sUtil            *util.K8sUtil
+		K8sInformerFactory informer.K8sInformerFactory
+	}
+	type args struct {
+		cluster *ClusterBean
+	}
+	tests := []struct {
+		name    string
+		fields  fields
+		args    args
+		wantErr bool
+	}{
+		{
+			//incorrect server config
+			args: args{
+				cluster: &ClusterBean{
+					Id:        4,
+					ServerUrl: "",
+					Config: map[string]string{
+						"bearer_token": "",
+					},
+				},
+			},
+			wantErr: true,
+		},
+		{
+			//correct server config
+			args: args{
+				cluster: &ClusterBean{
+					Id:        5,
+					ServerUrl: "",
+					Config: map[string]string{
+						"bearer_token": "",
+					},
+				},
+			},
+			wantErr: false,
+		},
+	}
+
+	logger, _ := util.NewSugardLogger()
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			impl := ClusterServiceImpl{
+				clusterRepository:  nil,
+				logger:             logger,
+				K8sUtil:            nil,
+				K8sInformerFactory: nil,
+			}
+			if err := impl.CheckIfConfigIsValid(tt.args.cluster); (err != nil) != tt.wantErr {
+				t.Errorf("ClusterServiceImpl.CheckIfConfigIsValid() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}