Revise CLI wizard to support access mode and git provider (#646)

* add git provider and access mode seletcion to cli wizard

* bump

* add doc to git tokens and try to determine access mode based on provided flags

* fix

Author: danielm-codefresh

Makefile

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

cmd/commands/common.go

@@ -30,6 +30,8 @@ import (
 	"github.com/codefresh-io/cli-v2/pkg/config"
 	cfgit "github.com/codefresh-io/cli-v2/pkg/git"
 	"github.com/codefresh-io/cli-v2/pkg/log"
+	"github.com/codefresh-io/cli-v2/pkg/reporter"
+	"github.com/codefresh-io/cli-v2/pkg/runtime"
 	"github.com/codefresh-io/cli-v2/pkg/store"
 	"github.com/codefresh-io/cli-v2/pkg/util"
 
@@ -323,7 +325,7 @@ func ensureGitUserToken(ctx context.Context, opts *RuntimeInstallOptions) error
 
 func getGitTokenFromUserInput(cmd *cobra.Command) error {
 	gitTokenPrompt := promptui.Prompt{
-		Label: "Runtime git api token",
+		Label: fmt.Sprintf("Runtime git token: (required scopes should be as described in: %s )", store.Get().GitTokensLink),
 		Mask:  '*',
 	}
 	gitTokenInput, err := gitTokenPrompt.Run()
@@ -396,6 +398,55 @@ func ensureKubeContextName(context, kubeconfig *pflag.Flag) (string, error) {
 	return contextName, nil
 }
 
+func ensureAccessMode(ctx context.Context, opts *RuntimeInstallOptions) error {
+	var err error
+
+	if opts.AccessMode == "" {
+		if opts.IngressClass != "" || opts.IngressHost != "" {
+			opts.AccessMode = platmodel.AccessModeIngress
+		} else if opts.TunnelSubdomain != "" {
+			opts.AccessMode = platmodel.AccessModeTunnel
+		} else {
+			if store.Get().Silent {
+				// Tunnel mode if the default
+				opts.AccessMode = platmodel.AccessModeTunnel
+			} else {
+				err = getAccessModeFromUserSelect(&opts.AccessMode)
+				if err != nil {
+					return err
+				}
+			}
+		}
+	}
+
+	if opts.AccessMode == platmodel.AccessModeTunnel {
+		handleCliStep(reporter.InstallStepPreCheckEnsureIngressClass, "-skipped (ingressless)-", nil, true, false)
+		handleCliStep(reporter.InstallStepPreCheckEnsureIngressHost, "-skipped (ingressless)-", nil, true, false)
+		opts.featuresToInstall = append(opts.featuresToInstall, runtime.InstallFeatureIngressless)
+		accountId, err := cfConfig.GetCurrentContext().GetAccountId(ctx)
+		if err != nil {
+			return fmt.Errorf("failed creating ingressHost for tunnel: %w", err)
+		}
+
+		opts.TunnelSubdomain = fmt.Sprintf("%s-%s", accountId, opts.RuntimeName)
+		opts.IngressHost = fmt.Sprintf("https://%s.%s", opts.TunnelSubdomain, opts.TunnelDomain)
+	} else {
+		err := ensureRoutingControllerSupported(ctx, opts)
+		handleCliStep(reporter.InstallStepPreCheckEnsureIngressClass, "Getting ingress class", err, true, false)
+		if err != nil {
+			return err
+		}
+
+		err = getIngressHost(ctx, opts)
+		handleCliStep(reporter.InstallStepPreCheckEnsureIngressHost, "Getting ingressHost", err, true, false)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
 func getKubeContextName(context, kubeconfig *pflag.Flag) (string, error) {
 	kubeconfigPath := kubeconfig.Value.String()
 
@@ -453,6 +504,34 @@ func getKubeContextNameFromUserSelect(kubeconfig string) (string, error) {
 	return contexts[index].Name, nil
 }
 
+func getAccessModeFromUserSelect(accessMode *platmodel.AccessMode) (error) {
+	templates := &promptui.SelectTemplates{
+		Selected: "{{ .Name | yellow }}",
+	}
+
+	labelStr := fmt.Sprintf("%vSelect access mode%v", CYAN, COLOR_RESET)
+
+	prompt := promptui.Select{
+		Label:     labelStr,
+		Items:     []string{"Codefresh Tunnel Based", "Ingress Based"},
+		Templates: templates,
+	}
+
+	index, _, err := prompt.Run()
+	if err != nil {
+		return err
+	}
+
+	switch index {
+	case 0:
+		*accessMode = platmodel.AccessModeTunnel
+	case 1:
+		*accessMode = platmodel.AccessModeIngress
+	}
+
+	return nil
+}
+
 func validateIngressHost(ingressHost string) error {
 	isValid, err := isValidIngressHost(ingressHost)
 	if err != nil {

cmd/commands/runtime_install.go

@@ -109,6 +109,7 @@ type (
 		IpsAllowList                   string
 		SkipIngress                    bool
 		BypassIngressClassCheck        bool
+		DownloadRuntimeDef             *runtime.Runtime
 
 		versionStr        string
 		kubeContext       string
@@ -195,9 +196,11 @@ func NewRuntimeInstallCommand() *cobra.Command {
 
 			createAnalyticsReporter(ctx, reporter.InstallFlow, installationOpts.DisableTelemetry)
 
-			installationOpts.AccessMode = platmodel.AccessMode(strings.ToUpper(accessMode))
-			if !installationOpts.AccessMode.IsValid() {
-				return fmt.Errorf("invalid access-mode %s, must be one of: ingress|tunnel", accessMode)
+			if (accessMode != "") {
+				installationOpts.AccessMode = platmodel.AccessMode(strings.ToUpper(accessMode))
+				if !installationOpts.AccessMode.IsValid() {
+					return fmt.Errorf("invalid access-mode %s, must be one of: ingress|tunnel", accessMode)
+				}
 			}
 
 			err := runtimeInstallCommandPreRunHandler(cmd, installationOpts)
@@ -262,7 +265,7 @@ func NewRuntimeInstallCommand() *cobra.Command {
 	cmd.Flags().StringToStringVar(&installationOpts.InternalIngressAnnotation, "internal-ingress-annotation", nil, "Add annotations to the internal ingress")
 	cmd.Flags().StringToStringVar(&installationOpts.ExternalIngressAnnotation, "external-ingress-annotation", nil, "Add annotations to the external ingress")
 	cmd.Flags().StringVar(&installationOpts.runtimeDef, "runtime-def", "", "Install runtime from a specific manifest")
-	cmd.Flags().StringVar(&accessMode, "access-mode", string(platmodel.AccessModeIngress), "The access mode to the cluster, one of: ingress|tunnel")
+	cmd.Flags().StringVar(&accessMode, "access-mode", "", "The access mode to the cluster, one of: ingress|tunnel")
 	cmd.Flags().StringVar(&installationOpts.TunnelRegisterHost, "tunnel-register-host", "register-tunnels.cf-cd.com", "The host name for registering a new tunnel")
 	cmd.Flags().StringVar(&installationOpts.TunnelDomain, "tunnel-domain", "tunnels.cf-cd.com", "The base domain for the tunnels")
 	cmd.Flags().StringVar(&installationOpts.IpsAllowList, "ips-allow-list", "", "lists the rules to configure which IP addresses (IPv4/IPv6) and subnet masks can access your client (e.g \"192.168.0.0/16, FE80:CD00:0000:0CDE:1257::/64\")")
@@ -301,6 +304,32 @@ func runtimeInstallCommandPreRunHandler(cmd *cobra.Command, opts *RuntimeInstall
 
 	err = validateVersionIfExists(opts.versionStr)
 	handleCliStep(reporter.InstallStepPreCheckValidateRuntimeVersion, "Validating runtime version", err, true, false)
+
+	if opts.runtimeDef == "" {
+		opts.runtimeDef = runtime.GetRuntimeDefURL(opts.versionStr)
+	}
+
+	runtimeDef := getRuntimeDef(opts.runtimeDef, opts.versionStr)
+	rt, err := runtime.Download(runtimeDef, opts.RuntimeName, opts.featuresToInstall)
+	handleCliStep(reporter.InstallStepRunPreCheckDownloadRuntimeDefinition, "Downloading runtime definition", err, true, true)
+	if err != nil {
+		return fmt.Errorf("failed to download runtime definition: %w", err)
+	}
+
+	if rt.Spec.DefVersion != nil {
+		if rt.Spec.DefVersion.GreaterThan(store.Get().MaxDefVersion) {
+			err = fmt.Errorf("your cli version is out of date. please upgrade to the latest version before installing")
+		} else if rt.Spec.DefVersion.LessThan(store.Get().MaxDefVersion) {
+			val := store.Get().DefVersionToLastCLIVersion[rt.Spec.DefVersion.String()]
+			err = fmt.Errorf("to install this version, please downgrade your cli to version %s", val)
+		}
+	} else {
+		err = runtime.CheckRuntimeVersionCompatible(rt.Spec.RequiredCLIVersion)
+	}
+	if err != nil {
+		return err
+	}
+
 	if opts.RuntimeName == "" {
 		if !store.Get().Silent {
 			opts.RuntimeName, err = getRuntimeNameFromUserInput()
@@ -325,29 +354,8 @@ func runtimeInstallCommandPreRunHandler(cmd *cobra.Command, opts *RuntimeInstall
 		return err
 	}
 
-	if opts.AccessMode == platmodel.AccessModeTunnel {
-		handleCliStep(reporter.InstallStepPreCheckEnsureIngressClass, "-skipped (ingressless)-", err, true, false)
-		handleCliStep(reporter.InstallStepPreCheckEnsureIngressHost, "-skipped (ingressless)-", err, true, false)
-		opts.featuresToInstall = append(opts.featuresToInstall, runtime.InstallFeatureIngressless)
-		accountId, err := cfConfig.GetCurrentContext().GetAccountId(ctx)
-		if err != nil {
-			return fmt.Errorf("failed creating ingressHost for tunnel: %w", err)
-		}
-
-		opts.TunnelSubdomain = fmt.Sprintf("%s-%s", accountId, opts.RuntimeName)
-		opts.IngressHost = fmt.Sprintf("https://%s.%s", opts.TunnelSubdomain, opts.TunnelDomain)
-	} else {
-		err = ensureRoutingControllerSupported(ctx, opts)
-		handleCliStep(reporter.InstallStepPreCheckEnsureIngressClass, "Getting ingress class", err, true, false)
-		if err != nil {
-			return err
-		}
-
-		err = getIngressHost(ctx, opts)
-		handleCliStep(reporter.InstallStepPreCheckEnsureIngressHost, "Getting ingressHost", err, true, false)
-		if err != nil {
-			return err
-		}
+	if err = ensureAccessMode(ctx, opts); err != nil {
+		return err
 	}
 
 	if err = ensureGitData(cmd, opts); err != nil {
@@ -384,12 +392,9 @@ func runtimeInstallCommandPreRunHandler(cmd *cobra.Command, opts *RuntimeInstall
 		log.G(ctx).Infof("using repo '%s' as shared config repo for this account", sharedConfigRepo)
 	}
 
-	if opts.runtimeDef == "" {
-		opts.runtimeDef = runtime.GetRuntimeDefURL(opts.versionStr)
-	}
-
 	opts.Insecure = true // installs argo-cd in insecure mode, we need this so that the eventsource can talk to the argocd-server with http
 	opts.CommonConfig = &runtime.CommonConfig{CodefreshBaseURL: cfConfig.GetCurrentContext().URL}
+	opts.DownloadRuntimeDef = rt
 
 	return nil
 }
@@ -1140,23 +1145,7 @@ func preInstallationChecks(ctx context.Context, opts *RuntimeInstallOptions) (*r
 		return nil, err
 	}
 
-	runtimeDef := getRuntimeDef(opts.runtimeDef, opts.versionStr)
-	rt, err := runtime.Download(runtimeDef, opts.RuntimeName, opts.featuresToInstall)
-	handleCliStep(reporter.InstallStepRunPreCheckDownloadRuntimeDefinition, "Downloading runtime definition", err, true, true)
-	if err != nil {
-		return nil, fmt.Errorf("failed to download runtime definition: %w", err)
-	}
-
-	if rt.Spec.DefVersion != nil {
-		if rt.Spec.DefVersion.GreaterThan(store.Get().MaxDefVersion) {
-			err = fmt.Errorf("your cli version is out of date. please upgrade to the latest version before installing")
-		} else if rt.Spec.DefVersion.LessThan(store.Get().MaxDefVersion) {
-			val := store.Get().DefVersionToLastCLIVersion[rt.Spec.DefVersion.String()]
-			err = fmt.Errorf("to install this version, please downgrade your cli to version %s", val)
-		}
-	} else {
-		err = runtime.CheckRuntimeVersionCompatible(rt.Spec.RequiredCLIVersion)
-	}
+	rt := opts.DownloadRuntimeDef
 
 	handleCliStep(reporter.InstallStepRunPreCheckEnsureCliVersion, "Checking CLI version", err, true, false)
 	if err != nil {

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.1.9/cf-linux-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.1.10/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.1.9/cf-darwin-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.1.10/cf-darwin-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-darwin-amd64 /usr/local/bin/cf

pkg/git/provider.go

@@ -21,10 +21,17 @@ import (
 	"strings"
 
 	apgit "github.com/argoproj-labs/argocd-autopilot/pkg/git"
+	"github.com/codefresh-io/cli-v2/pkg/store"
+	"github.com/manifoldco/promptui"
 )
 
 //go:generate mockgen -destination=./mocks/roundTripper.go -package=mocks net/http RoundTripper
 
+var (
+	CYAN        = "\033[36m"
+	COLOR_RESET = "\033[0m"
+)
+
 type (
 	ProviderType string
 
@@ -77,5 +84,44 @@ func GetProvider(providerType ProviderType, baseURL, certFile string) (Provider,
 		return NewBitbucketProvider(baseURL, client)
 	}
 
+	if !store.Get().Silent {
+		provider := getGitProviderFromUserSelect(baseURL, client)
+		if provider != nil {
+			return provider, nil
+		}
+	}
+
 	return nil, fmt.Errorf("failed getting provider for clone url %s", baseURL)
 }
+
+func getGitProviderFromUserSelect(baseURL string, client *http.Client) (Provider) {
+	var providers = map[string]func(string, *http.Client) (Provider, error){
+		"Bitbucket": NewBitbucketServerProvider,
+		"Github":    NewGithubProvider,
+		"Gitlab":    NewGitlabProvider,
+	}
+
+	templates := &promptui.SelectTemplates{
+		Selected: "{{ .Name | yellow }}",
+	}
+
+	labelStr := fmt.Sprintf("%vSelect git provider%v", CYAN, COLOR_RESET)
+
+	prompt := promptui.Select{
+		Label:     labelStr,
+		Items:     []string{"Github", "Gitlab", "Bitbucket"},
+		Templates: templates,
+	}
+
+	_, label, err := prompt.Run()
+	if err != nil {
+		return nil
+	}
+
+	if fn, ok := providers[label]; ok {
+		provider, _ := fn(baseURL, client)
+		return provider
+	}
+
+	return nil
+}

pkg/store/store.go

@@ -131,6 +131,7 @@ type Store struct {
 	AnalysisRunResourceName           string
 	WorkflowResourceName              string
 	RequirementsLink                  string
+	GitTokensLink                     string
 	DownloadCliLink                   string
 	RolloutReporterName               string
 	RolloutResourceName               string
@@ -249,6 +250,7 @@ func init() {
 	s.RolloutReporterName = "rollout-reporter"
 	s.RolloutReporterServiceAccount = "rollout-reporter-sa"
 	s.RequirementsLink = "https://codefresh.io/csdp-docs/docs/runtime/requirements/"
+	s.GitTokensLink = "https://codefresh.io/csdp-docs/docs/reference/git-tokens/"
 	s.DownloadCliLink = "https://codefresh.io/csdp-docs/docs/clients/csdp-cli/"
 	s.DefaultNamespace = "default"
 	s.NetworkTesterName = "cf-network-tester"