Check-context-name (#313)

* added checks to kubeconfig access

* better print of kube context

* protect against non-existing kube contexts

Author: ATGardner

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog:
 
-* Fixed cluster-add script
+* Protect against invalid kube context

Makefile

@@ -1,4 +1,4 @@
-VERSION=v0.0.289
+VERSION=v0.0.290
 
 OUT_DIR=dist
 YEAR?=$(shell date +"%Y")

cmd/commands/common.go

@@ -36,7 +36,6 @@ import (
 
 	"github.com/manifoldco/promptui"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/client-go/tools/clientcmd"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
@@ -163,7 +162,7 @@ func getRepoFromUserInput(cmd *cobra.Command) error {
 func ensureRuntimeName(ctx context.Context, args []string) (string, error) {
 	var (
 		runtimeName string
-		err error
+		err         error
 	)
 
 	if len(args) > 0 {
@@ -379,6 +378,10 @@ func ensureKubeContextName(flag *pflag.Flag) (string, error) {
 func getKubeContextName(flag *pflag.Flag) (string, error) {
 	contextName := flag.Value.String()
 	if contextName != "" {
+		if !util.CheckExistingContext(contextName) {
+			return "", fmt.Errorf("kubeconfig file missing context \"%s\"", contextName)
+		}
+
 		return contextName, nil
 	}
 
@@ -393,36 +396,24 @@ func getKubeContextName(flag *pflag.Flag) (string, error) {
 	return contextName, flag.Value.Set(contextName)
 }
 
-func getKubeContextNameFromUserSelect() (string, error) {
-	configAccess := clientcmd.NewDefaultPathOptions()
-	conf, err := configAccess.GetStartingConfig()
-	if err != nil {
-		return "", err
-	}
-
-	contextsList := conf.Contexts
-	currentContext := conf.CurrentContext
-	contextsNamesToShowUser := []string{currentContext + " (current)"}
-	contextsIndex := []string{currentContext}
-
-	for key := range contextsList {
-		if key == currentContext {
-			continue
-		}
-
-		contextsIndex = append(contextsIndex, key)
-		contextsNamesToShowUser = append(contextsNamesToShowUser, key)
-	}
+type SelectItem struct {
+	Value string
+	Label string
+}
 
+func getKubeContextNameFromUserSelect() (string, error) {
+	contexts := util.KubeContexts()
 	templates := &promptui.SelectTemplates{
-		Selected: "{{ . | yellow }} ",
+		Active:   "▸ {{ .Name }} {{if .Current }}(current){{end}}",
+		Inactive: "  {{ .Name }} {{if .Current }}(current){{end}}",
+		Selected: "{{ .Name | yellow }}",
 	}
 
 	labelStr := fmt.Sprintf("%vSelect kube context%v", CYAN, COLOR_RESET)
 
 	prompt := promptui.Select{
 		Label:     labelStr,
-		Items:     contextsNamesToShowUser,
+		Items:     contexts,
 		Templates: templates,
 	}
 
@@ -431,7 +422,7 @@ func getKubeContextNameFromUserSelect() (string, error) {
 		return "", err
 	}
 
-	return contextsIndex[index], nil
+	return contexts[index].Name, nil
 }
 
 func validateIngressHost(ingressHost string) error {

cmd/commands/runtime.go

@@ -738,7 +738,7 @@ func runtimeInstallPreparations(opts *RuntimeInstallOptions) (*runtime.Runtime,
 		return nil, "", fmt.Errorf("failed to download runtime definition: %w", err)
 	}
 
-	server, err := util.CurrentServer()
+	server, err := util.KubeCurrentServer()
 	handleCliStep(reporter.InstallStepGetServerAddress, "Getting current server address", err, false, true)
 	if err != nil {
 		return nil, "", fmt.Errorf("failed to get current server address: %w", err)

docs/releases/release_notes.md

@@ -23,7 +23,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.289/cf-linux-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.290/cf-linux-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-linux-amd64 /usr/local/bin/cf
@@ -36,7 +36,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.289/cf-darwin-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.290/cf-darwin-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-darwin-amd64 /usr/local/bin/cf

manifests/add-cluster/helm/values.yaml

@@ -5,14 +5,13 @@ serviceAccountName: argocd-manager
 # example https://some.domain.name
 ingressUrl: <ingressUrl>
 
-# csdpToken is used to authenticate against the app-proxy
-# 
+# csdpToken is the user's Personal Access Token
 csdpToken: <csdpToken>
 
 # contextName is the name of the kube context (in the local kubeconfig file) that connects to the target cluster
 contextName: <contextName>
 
-# server is the
+# server is the k8s cluster API endpoint url
 # can be obtained by
 #   CONTEXT_NAME=<TARGET_CONTEXT_NAME>
 #   CLUSTER_NAME=$(kubectl config view --raw --flatten -o jsonpath='{.contexts[?(@.name == "'"${CONTEXT_NAME}"'")].context.cluster}')

manifests/runtime.yaml

@@ -5,7 +5,7 @@ metadata:
   namespace: "{{ namespace }}"
 spec:
   defVersion: 1.0.1
-  version: 0.0.289
+  version: 0.0.290
   bootstrapSpecifier: github.com/codefresh-io/cli-v2/manifests/argo-cd
   components:
     - name: events

pkg/util/util.go

@@ -20,6 +20,7 @@ import (
 	"os"
 	"os/signal"
 	"regexp"
+	"sort"
 	"strings"
 	"sync"
 	"time"
@@ -30,6 +31,7 @@ import (
 	"github.com/codefresh-io/cli-v2/pkg/store"
 
 	"k8s.io/client-go/tools/clientcmd"
+	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
 )
 
 const (
@@ -161,34 +163,63 @@ func EscapeAppsetFieldName(field string) string {
 	return appsetFieldRegexp.ReplaceAllString(field, "_")
 }
 
-func CurrentContext() (string, error) {
+func kubeConfig() *clientcmdapi.Config {
 	configAccess := clientcmd.NewDefaultPathOptions()
 	conf, err := configAccess.GetStartingConfig()
-	if err != nil {
-		return "", err
-	}
+	Die(err, "failed reading kubeconfig file")
+	return conf
+}
 
-	return conf.CurrentContext, nil
+type kubeContext struct {
+	Name string
+	Current bool
 }
 
-func CurrentServer() (string, error) {
-	configAccess := clientcmd.NewDefaultPathOptions()
-	conf, err := configAccess.GetStartingConfig()
-	if err != nil {
-		return "", err
+func KubeContexts() []kubeContext {
+	conf := kubeConfig()
+	contexts := make([]kubeContext, len(conf.Contexts))
+	i := 0
+	for key := range conf.Contexts {
+		contexts[i] = kubeContext{
+			Name: key,
+			Current: key == conf.CurrentContext,
+		}
+		i += 1
 	}
 
-	currentContext := conf.Contexts[conf.CurrentContext]
-	return conf.Clusters[currentContext.Cluster].Server, nil
+	sort.SliceStable(contexts, func(i, j int) bool {
+		c1 := contexts[i]
+		if c1.Current {
+			return true
+		}
+
+		c2 := contexts[j]
+		if c2.Current {
+			return true
+		}
+
+		return c1.Name < c2.Name
+	})
+
+	return contexts
 }
 
-func KubeContextNameByServer(server string) (string, error) {
-	configAccess := clientcmd.NewDefaultPathOptions()
-	conf, err := configAccess.GetStartingConfig()
-	if err != nil {
-		return "", err
+func CheckExistingContext(contextName string) bool {
+	for _, context := range KubeContexts() {
+		if context.Name == contextName {
+			return true
+		}
 	}
 
+	return false
+}
+
+func KubeCurrentServer() (string, error) {
+	return KubeServerByContextName("")
+}
+
+func KubeContextNameByServer(server string) (string, error) {
+	conf := kubeConfig()
 	for contextName, context := range conf.Contexts {
 		if cluster, ok := conf.Clusters[context.Cluster]; ok {
 			if cluster.Server == server {
@@ -201,14 +232,22 @@ func KubeContextNameByServer(server string) (string, error) {
 }
 
 func KubeServerByContextName(contextName string) (string, error) {
-	configAccess := clientcmd.NewDefaultPathOptions()
-	conf, err := configAccess.GetStartingConfig()
-	if err != nil {
-		return "", err
+	conf := kubeConfig()
+	if contextName == "" {
+		contextName = conf.CurrentContext
+	}
+
+	context := conf.Contexts[contextName]
+	if context == nil {
+		return "", fmt.Errorf("kubeconfig file missing context \"%s\"", contextName)
+	}
+
+	cluster := conf.Clusters[context.Cluster]
+	if cluster == nil {
+		return "", fmt.Errorf("kubeconfig file missing cluster \"%s\"", context.Cluster)
 	}
 
-	currentContext := conf.Contexts[contextName]
-	return conf.Clusters[currentContext.Cluster].Server, nil
+	return cluster.Server, nil
 }
 
 func DecorateErrorWithDocsLink(err error, link ...string) error {