feat: [TKC-1887]add on prem installer as the testkube command (#5345)

* feat: add on prem installer as the testkube command

* fix: add breaks and uncomment context confirmation

* fix: add telemetry

* feat(installer): polish init demo

* Update lint.yaml

* fix: fix linter

* fix(installer): Testkube OSS should be the default init

---------

Co-authored-by: Delnat Wito <wito.delnat@gmail.com>
Co-authored-by: Wito <WitoDelnat@users.noreply.github.com>
# Conflicts:
#	cmd/kubectl-testkube/commands/dashboard.go
#	go.mod
#	go.sum

cmd/kubectl-testkube/commands/dashboard.go

@@ -1,34 +1,58 @@
 package commands
 
 import (
+	"context"
 	"fmt"
+	"net"
+	"os"
+	"os/signal"
+	"syscall"
 
+	"github.com/pkg/errors"
 	"github.com/skratchdot/open-golang/open"
 	"github.com/spf13/cobra"
 
 	"github.com/kubeshop/testkube/cmd/kubectl-testkube/config"
+	"github.com/kubeshop/testkube/pkg/k8sclient"
 	"github.com/kubeshop/testkube/pkg/ui"
 )
 
+const maxPortNumber = 65535
+
 // NewDashboardCmd is a method to create new dashboard command
 func NewDashboardCmd() *cobra.Command {
+	var namespace string
+	var verbose bool
+
 	cmd := &cobra.Command{
 		Use:     "dashboard",
-		Aliases: []string{"d", "open-dashboard"},
-		Short:   "Open Testkube Pro dashboard",
-		Long:    `Open Testkube Pro dashboard`,
+		Aliases: []string{"d", "open-dashboard", "ui"},
+		Short:   "Open Testkube dashboard",
+		Long:    `Open Testkube dashboard`,
 		Run: func(cmd *cobra.Command, args []string) {
 			cfg, err := config.Load()
 			ui.ExitOnError("loading config file", err)
 
+			if namespace == "" {
+				namespace = cfg.Namespace
+			}
+
 			if cfg.ContextType != config.ContextTypeCloud {
-				ui.Warn("As of 1.17 the dashboard is no longer included with Testkube OSS - please refer to https://bit.ly/tk-dashboard for more info")
+				isDashboardRunning, _ := k8sclient.IsPodOfServiceRunning(context.Background(), cfg.Namespace, config.EnterpriseUiName)
+				if isDashboardRunning {
+					openOnPremDashboard(cmd, cfg, verbose)
+				} else {
+					ui.Warn("No dashboard found. Is it running in the " + namespace + " namespace?")
+				}
 			} else {
 				openCloudDashboard(cfg)
 			}
 		},
 	}
 
+	cmd.Flags().BoolVarP(&verbose, "verbose", "", false, "show additional debug messages")
+	cmd.Flags().StringVarP(&namespace, "namespace", "n", "", "Namespace to install "+demoInstallationName)
+
 	return cmd
 }
 
@@ -38,3 +62,52 @@ func openCloudDashboard(cfg config.Data) {
 	err := open.Run(uri)
 	ui.PrintOnError("openning dashboard", err)
 }
+
+func openOnPremDashboard(cmd *cobra.Command, cfg config.Data, verbose bool) {
+	uiLocalPort, err := getDashboardLocalPort(config.EnterpriseApiForwardingPort)
+	ui.PrintOnError("getting an ui forwarding available port", err)
+	uri := fmt.Sprintf("http://localhost:%d", uiLocalPort)
+
+	ctx, cancel := context.WithCancel(context.Background())
+	err = k8sclient.PortForward(ctx, cfg.Namespace, config.EnterpriseApiName, config.EnterpriseApiPort, config.EnterpriseApiForwardingPort, verbose)
+	ui.PrintOnError("port forwarding api", err)
+	err = k8sclient.PortForward(ctx, cfg.Namespace, config.EnterpriseUiName, config.EnterpriseUiPort, uiLocalPort, verbose)
+	ui.PrintOnError("port forwarding ui", err)
+	err = k8sclient.PortForward(ctx, cfg.Namespace, config.EnterpriseDexName, config.EnterpriseDexPort, config.EnterpriseDexForwardingPort, verbose)
+	ui.PrintOnError("port forwarding dex", err)
+
+	err = open.Run(uri)
+	ui.ExitOnError("opening dashboard in browser", err)
+	c := make(chan os.Signal, 1)
+	signal.Notify(c, os.Interrupt, syscall.SIGTERM)
+
+	ui.Success("The dashboard is accessible here:", uri)
+	ui.Success("Port forwarding the necessary services, hit Ctrl+c (or Cmd+c) to stop")
+	<-c
+	cancel()
+
+}
+
+func localPortCheck(port int) error {
+	ln, err := net.Listen("tcp", ":"+fmt.Sprint(port))
+	if err != nil {
+		return err
+	}
+
+	ln.Close()
+	return nil
+}
+
+func getDashboardLocalPort(apiServerPort int) (int, error) {
+	for port := DashboardLocalPort; port <= maxPortNumber; port++ {
+		if port == apiServerPort {
+			continue
+		}
+
+		if localPortCheck(port) == nil {
+			return port, nil
+		}
+	}
+
+	return 0, errors.New("no available local port")
+}

cmd/kubectl-testkube/commands/init.go

@@ -1,48 +1,76 @@
 package commands
 
 import (
+	"fmt"
+	"os/exec"
+	"strings"
+
+	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 
 	"github.com/kubeshop/testkube/cmd/kubectl-testkube/commands/common"
+	"github.com/kubeshop/testkube/cmd/kubectl-testkube/config"
+	"github.com/kubeshop/testkube/pkg/process"
+	"github.com/kubeshop/testkube/pkg/telemetry"
 	"github.com/kubeshop/testkube/pkg/ui"
 )
 
+const (
+	defaultNamespace       = "testkube"
+	standaloneAgentProfile = "standalone-agent"
+	demoProfile            = "demo"
+	agentProfile           = "agent"
+
+	standaloneInstallationName = "Testkube OSS"
+	demoInstallationName       = "Testkube On-Prem demo"
+	agentInstallationName      = "Testkube Agent"
+	licenseFormat              = "XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX-V3"
+)
+
 func NewInitCmd() *cobra.Command {
+	standaloneCmd := NewInitCmdStandalone()
+
+	cmd := &cobra.Command{
+		Use:     "init <profile>",
+		Aliases: []string{"g"},
+		Short:   "Init Testkube profiles(" + standaloneAgentProfile + "|" + demoProfile + "|" + agentProfile + ")",
+		Long: "Init installs the Testkube in your cluster as follows:\n" +
+			"\t" + standaloneAgentProfile + " -> " + standaloneInstallationName + "\n" +
+			"\t" + demoProfile + " -> " + demoInstallationName + "\n" +
+			"\t" + agentProfile + " -> " + agentInstallationName,
+		Run: func(cmd *cobra.Command, args []string) {
+			standaloneCmd.Run(cmd, args)
+		},
+	}
+
+	cmd.AddCommand(standaloneCmd)
+	cmd.AddCommand(NewInitCmdDemo())
+
+	return cmd
+}
+
+func NewInitCmdStandalone() *cobra.Command {
 	var options common.HelmOptions
 
 	cmd := &cobra.Command{
-		Use:     "init",
-		Short:   "Install Helm chart registry in current kubectl context and update dependencies",
+		Use:     standaloneAgentProfile,
+		Short:   "Install " + standaloneInstallationName + " in your current context",
 		Aliases: []string{"install"},
 		Run: func(cmd *cobra.Command, args []string) {
-			ui.Info("WELCOME TO")
 			ui.Logo()
-
+			ui.Info("Welcome to the installer for " + standaloneInstallationName + ".")
 			ui.NL()
 
-			if !options.NoConfirm {
-				ui.Warn("This will install Testkube to the latest version. This may take a few minutes.")
-				ui.Warn("Please be sure you're on valid kubectl context before continuing!")
-				ui.NL()
-
-				currentContext, err := common.GetCurrentKubernetesContext()
-				ui.ExitOnError("getting current context", err)
-				ui.Alert("Current kubectl context:", currentContext)
-				ui.NL()
-
-				ok := ui.Confirm("Do you want to continue?")
-				if !ok {
-					ui.Errf("Testkube installation cancelled")
-					return
-				}
+			if !isContextApproved(options.NoConfirm, standaloneInstallationName) {
+				return
 			}
 
 			common.ProcessMasterFlags(cmd, &options, nil)
 
 			err := common.HelmUpgradeOrInstalTestkube(options)
-			ui.ExitOnError("Installing testkube", err)
+			ui.ExitOnError("Cannot install Testkube", err)
 
-			ui.Info(`To help improve the quality of Testkube, we collect anonymous basic telemetry data.  Head out to https://docs.testkube.io/articles/telemetry to read our policy or feel free to:`)
+			ui.Info(`To help improve the quality of Testkube, we collect anonymous basic telemetry data. Head out to https://docs.testkube.io/articles/telemetry to read our policy or feel free to:`)
 
 			ui.NL()
 			ui.ShellCommand("disable telemetry by typing", "testkube disable telemetry")
@@ -59,3 +87,180 @@ func NewInitCmd() *cobra.Command {
 
 	return cmd
 }
+
+func NewInitCmdDemo() *cobra.Command {
+	var noConfirm, dryRun bool
+	var license, namespace string
+
+	cmd := &cobra.Command{
+		Use:     demoProfile,
+		Short:   "Install " + demoInstallationName + " Helm chart registry in current kubectl context and update dependencies",
+		Aliases: []string{"on-premise-demo", "on-prem-demo", "enterprise-demo"},
+		Run: func(cmd *cobra.Command, args []string) {
+			ui.Logo()
+			ui.Info("Welcome to the installer for " + demoInstallationName + ".")
+			ui.NL()
+
+			cfg, err := config.Load()
+			ui.ExitOnError("loading config file", err)
+
+			kubecontext, err := common.GetCurrentKubernetesContext()
+			if err != nil {
+				ui.Failf("kubeconfig not found")
+			}
+
+			if namespace == "" {
+				if noConfirm {
+					namespace = defaultNamespace
+				} else {
+					response, err := pterm.DefaultInteractiveTextInput.WithDefaultValue("testkube").Show("Enter namespace for this installation")
+					namespace = response
+					ui.ExitOnError("cannot read namespace", err)
+				}
+			}
+
+			if license == "" {
+				response, err := pterm.DefaultInteractiveTextInput.Show("Enter license key")
+				license = response
+				ui.ExitOnError("cannot read license", err)
+			}
+
+			if len(license) != len(licenseFormat) {
+				ui.Failf("license malformed, expected license of format: " + licenseFormat)
+			}
+
+			ui.NL()
+			ui.Warn("Installation is about to start and may take a several minutes:")
+			ui.NL()
+			ui.Warn("- Testkube will be installed in the " + kubecontext + " context.")
+			ui.Warn("- Testkube services will be applied to the " + namespace + " namespace.")
+			ui.Warn("- Testkube CRDs and cluster roles will be applied to your cluster.")
+			ui.NL()
+
+			if ok := ui.Confirm("Do you want to continue"); !ok {
+				sendErrTelemetry(cmd, cfg, "install_cancelled", license, err)
+				return
+			}
+
+			sendAttemptTelemetry(cmd, cfg, license)
+			err = helmInstallDemo(license, namespace, dryRun)
+			if err != nil {
+				sendErrTelemetry(cmd, cfg, "install_failed", license, err)
+			}
+			ui.ExitOnError("Cannot install Testkube", err)
+
+			if err == nil {
+				cfg.Namespace = namespace
+				err = config.Save(cfg)
+				if err != nil {
+					ui.Debug("Cannot save config")
+				}
+			}
+
+			ui.Info("Your initial admin credentials are: admin@example.com / password")
+			ui.Info("Make sure to copy these credentials now as you will not be able to see this again.")
+			ui.NL()
+			ok := ui.Confirm("Do you want to continue?")
+
+			ui.Info("You can use `testkube dashboard` to access Testkube without exposing services.")
+			ui.NL()
+
+			if !ok {
+				return
+			}
+
+			if ok := ui.Confirm("Do you want to open the dashboard?"); ok {
+				cfg, err := config.Load()
+				ui.ExitOnError("Cannot open dashboard", err)
+				openOnPremDashboard(nil, cfg, false)
+			}
+		},
+	}
+
+	cmd.Flags().BoolVarP(&noConfirm, "export", "", false, "Export the values.yaml")
+	cmd.Flags().BoolVarP(&noConfirm, "no-confirm", "y", false, "Skip confirmation")
+	cmd.Flags().StringVarP(&license, "license", "l", "", "License key")
+	cmd.Flags().BoolVarP(&dryRun, "dry-run", "", false, "Dry run")
+	cmd.Flags().StringVarP(&namespace, "namespace", "n", "", "Namespace to install "+demoInstallationName)
+
+	return cmd
+}
+
+func isContextApproved(isNoConfirm bool, installedComponent string) bool {
+	if !isNoConfirm {
+		ui.Warn("This will install " + installedComponent + " to the latest version. This may take a few minutes.")
+		ui.Warn("Please be sure you're on valid kubectl context before continuing!")
+		ui.NL()
+
+		currentContext, err := common.GetCurrentKubernetesContext()
+		ui.ExitOnError("getting current context", err)
+		ui.Alert("Current kubectl context:", currentContext)
+		ui.NL()
+
+		ok := ui.Confirm("Do you want to continue?")
+		if !ok {
+			ui.Errf("Installation cancelled")
+			return false
+		}
+	}
+	return true
+}
+
+func helmInstallDemo(license, namespace string, dryRun bool) error {
+	helmPath, err := exec.LookPath("helm")
+	if err != nil {
+		return err
+	}
+
+	ui.Info("Installing Testkube… ")
+
+	args := []string{"repo", "add", "testkubeenterprise", "https://kubeshop.github.io/testkube-cloud-charts"}
+	_, err = process.ExecuteWithOptions(process.Options{Command: helmPath, Args: args, DryRun: dryRun})
+	if err != nil && !strings.Contains(err.Error(), "Error: repository name (kubeshop) already exists, please specify a different name") {
+		return err
+	}
+
+	_, err = process.ExecuteWithOptions(process.Options{Command: helmPath, Args: []string{"repo", "update"}, DryRun: dryRun})
+	if err != nil {
+		return err
+	}
+
+	args = []string{"upgrade", "--install",
+		"--create-namespace",
+		"--namespace", namespace,
+		"--set", "global.enterpriseLicense=" + license,
+		"--values", "https://raw.githubusercontent.com/kubeshop/testkube-cloud-charts/main/charts/testkube-enterprise/profiles/values.demo.yaml",
+		"--wait",
+		"testkube", "testkubeenterprise/testkube-enterprise"}
+
+	ui.Debug("Helm command: ", helmPath+" "+strings.Join(args, " "))
+	out, err := process.ExecuteWithOptions(process.Options{Command: helmPath, Args: args, DryRun: dryRun})
+	if err != nil {
+		return err
+	}
+	ui.Debug("Helm command output: ", string(out))
+	ui.NL()
+	return nil
+}
+
+func sendErrTelemetry(cmd *cobra.Command, clientCfg config.Data, errType, license string, errorLogs error) {
+	errorStackTrace := fmt.Sprintf("%+v", errorLogs)
+	if clientCfg.TelemetryEnabled {
+		out, err := telemetry.SendCmdErrorEventWithLicense(cmd, common.Version, errType, license, errorStackTrace)
+		if ui.Verbose && err != nil {
+			ui.Err(err)
+		}
+
+		ui.Debug("telemetry send event response", out)
+	}
+}
+
+func sendAttemptTelemetry(cmd *cobra.Command, clientCfg config.Data, license string) {
+	if clientCfg.TelemetryEnabled {
+		out, err := telemetry.SendCmdAttempWithLicenseEvent(cmd, common.Version, license)
+		if ui.Verbose && err != nil {
+			ui.Err(err)
+		}
+		ui.Debug("telemetry send event response", out)
+	}
+}