Change the cluster started summary

* Directly add the link to the webconsole. No more indirection with crc
console.
* Better display credentials
* Include a small how-to for the oc command line

Author: guillaumerose

cmd/crc/cmd/oc_env.go

@@ -39,7 +39,7 @@ func runOcEnv(args []string) error {
 		fmt.Println(shell.GetEnvString(userShell, "HTTPS_PROXY", proxyConfig.HTTPSProxy))
 		fmt.Println(shell.GetEnvString(userShell, "NO_PROXY", proxyConfig.GetNoProxyString()))
 	}
-	fmt.Println(shell.GenerateUsageHint(userShell, "crc oc-env"))
+	fmt.Println(shell.GenerateUsageHintWithComment(userShell, "crc oc-env"))
 	return nil
 }
 

cmd/crc/cmd/podman_env.go

@@ -40,7 +40,7 @@ func RunPodmanEnv(args []string) error {
 	fmt.Println(shell.GetEnvString(userShell, "PODMAN_HOST", ip))
 	fmt.Println(shell.GetEnvString(userShell, "PODMAN_IDENTITY_FILE", constants.GetPrivateKeyPath()))
 	fmt.Println(shell.GetEnvString(userShell, "PODMAN_IGNORE_HOSTS", "1"))
-	fmt.Println(shell.GenerateUsageHint(userShell, "crc podman-env"))
+	fmt.Println(shell.GenerateUsageHintWithComment(userShell, "crc podman-env"))
 	return nil
 }
 

cmd/crc/cmd/start.go

@@ -6,7 +6,9 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"runtime"
 	"strings"
+	"text/template"
 
 	cmdConfig "github.com/code-ready/crc/cmd/crc/cmd/config"
 	"github.com/code-ready/crc/pkg/crc/cluster"
@@ -18,6 +20,7 @@ import (
 	"github.com/code-ready/crc/pkg/crc/telemetry"
 	"github.com/code-ready/crc/pkg/crc/validation"
 	crcversion "github.com/code-ready/crc/pkg/crc/version"
+	"github.com/code-ready/crc/pkg/os/shell"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 )
@@ -143,24 +146,18 @@ func (s *startResult) prettyPrintTo(writer io.Writer) error {
 		return errors.New("either Error or ClusterConfig are needed")
 	}
 
-	_, err := fmt.Fprintln(writer, strings.Join([]string{
-		"Started the OpenShift cluster",
-		"",
-		"To access the cluster, first set up your environment by following the instructions returned by executing 'crc oc-env'.",
-		fmt.Sprintf("Then you can access your cluster by running 'oc login -u %s -p %s %s'.", s.ClusterConfig.DeveloperCredentials.Username, s.ClusterConfig.DeveloperCredentials.Password, s.ClusterConfig.URL),
-		fmt.Sprintf("To login as a cluster admin, run 'oc login -u %s -p %s %s'.", s.ClusterConfig.AdminCredentials.Username, s.ClusterConfig.AdminCredentials.Password, s.ClusterConfig.URL),
-		"",
-		"You can also run 'crc console' and use the above credentials to access the OpenShift web console.",
-		"The console will open in your default browser.",
-	}, "\n"))
+	if err := writeTemplatedMessage(writer, s); err != nil {
+		return err
+	}
 	if crcversion.IsOkdBuild() {
-		fmt.Fprintln(writer, strings.Join([]string{
-			"\n",
+		_, err := fmt.Fprintln(writer, strings.Join([]string{
+			"",
 			"NOTE:",
 			"This cluster was built from OKD - The Community Distribution of Kubernetes that powers Red Hat OpenShift.",
 			"If you find an issue, please report it at https://github.com/openshift/okd"}, "\n"))
+		return err
 	}
-	return err
+	return nil
 }
 
 func isDebugLog() bool {
@@ -203,3 +200,54 @@ func checkIfNewVersionAvailable(noUpdateCheck bool) {
 	}
 	logging.Debugf("No new version available. The latest version is %s", newVersion)
 }
+
+const startTemplate = `Started the OpenShift cluster.
+
+The server is accessible via web console at:
+  {{ .ClusterConfig.WebConsoleURL }}
+
+Log in as administrator:
+  Username: {{ .ClusterConfig.AdminCredentials.Username }}
+  Password: {{ .ClusterConfig.AdminCredentials.Password }}
+
+Log in as user:
+  Username: {{ .ClusterConfig.DeveloperCredentials.Username }}
+  Password: {{ .ClusterConfig.DeveloperCredentials.Password }}
+
+Use the 'oc' command line interface:
+  {{ .CommandLinePrefix }} {{ .EvalCommandLine }}
+  {{ .CommandLinePrefix }} oc login {{ .ClusterConfig.URL }}
+`
+
+type templateVariables struct {
+	ClusterConfig     *clusterConfig
+	EvalCommandLine   string
+	CommandLinePrefix string
+}
+
+func writeTemplatedMessage(writer io.Writer, s *startResult) error {
+	parsed, err := template.New("template").Parse(startTemplate)
+	if err != nil {
+		return err
+	}
+
+	userShell, err := shell.GetShell("")
+	if err != nil {
+		userShell = ""
+	}
+	return parsed.Execute(writer, &templateVariables{
+		ClusterConfig:     s.ClusterConfig,
+		EvalCommandLine:   shell.GenerateUsageHint(userShell, "crc oc-env"),
+		CommandLinePrefix: commandLinePrefix(userShell),
+	})
+}
+
+func commandLinePrefix(shell string) string {
+	if runtime.GOOS == "windows" {
+		if shell == "powershell" {
+			return "PS>"
+		}
+		return ">"
+	}
+	return "$"
+}

cmd/crc/cmd/start_test.go

@@ -3,10 +3,12 @@ package cmd
 import (
 	"bytes"
 	"errors"
+	"runtime"
 	"testing"
 
 	"github.com/code-ready/crc/pkg/crc/constants"
 	crcErrors "github.com/code-ready/crc/pkg/crc/errors"
+	"github.com/code-ready/crc/pkg/os/shell"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -15,7 +17,8 @@ func TestRenderActionPlainSuccess(t *testing.T) {
 	assert.NoError(t, render(&startResult{
 		Success: true,
 		ClusterConfig: &clusterConfig{
-			URL: constants.DefaultAPIURL,
+			URL:           constants.DefaultAPIURL,
+			WebConsoleURL: constants.DefaultWebConsoleURL,
 			AdminCredentials: credentials{
 				Username: "kubeadmin",
 				Password: "secret",
@@ -26,15 +29,10 @@ func TestRenderActionPlainSuccess(t *testing.T) {
 			},
 		},
 	}, out, ""))
-	assert.Equal(t, `Started the OpenShift cluster
-
-To access the cluster, first set up your environment by following the instructions returned by executing 'crc oc-env'.
-Then you can access your cluster by running 'oc login -u developer -p developer https://api.crc.testing:6443'.
-To login as a cluster admin, run 'oc login -u kubeadmin -p secret https://api.crc.testing:6443'.
 
-You can also run 'crc console' and use the above credentials to access the OpenShift web console.
-The console will open in your default browser.
-`, out.String())
+	userShell, err := shell.GetShell("")
+	assert.NoError(t, err)
+	assert.Equal(t, expectedTemplate(userShell), out.String())
 }
 
 func TestRenderActionPlainFailure(t *testing.T) {
@@ -91,3 +89,67 @@ func TestRenderActionJSONFailure(t *testing.T) {
 	}, out, jsonFormat))
 	assert.JSONEq(t, `{"success": false, "error": "broken"}`, out.String())
 }
+
+const unixTemplate = `Started the OpenShift cluster.
+
+The server is accessible via web console at:
+  https://console-openshift-console.apps-crc.testing
+
+Log in as administrator:
+  Username: kubeadmin
+  Password: secret
+
+Log in as user:
+  Username: developer
+  Password: developer
+
+Use the 'oc' command line interface:
+  $ eval $(crc oc-env)
+  $ oc login https://api.crc.testing:6443
+`
+
+const powershellTemplate = `Started the OpenShift cluster.
+
+The server is accessible via web console at:
+  https://console-openshift-console.apps-crc.testing
+
+Log in as administrator:
+  Username: kubeadmin
+  Password: secret
+
+Log in as user:
+  Username: developer
+  Password: developer
+
+Use the 'oc' command line interface:
+  PS> & crc oc-env | Invoke-Expression
+  PS> oc login https://api.crc.testing:6443
+`
+
+const cmdTemplate = `Started the OpenShift cluster.
+
+The server is accessible via web console at:
+  https://console-openshift-console.apps-crc.testing
+
+Log in as administrator:
+  Username: kubeadmin
+  Password: secret
+
+Log in as user:
+  Username: developer
+  Password: developer
+
+Use the 'oc' command line interface:
+  > @FOR /f "tokens=*" %i IN ('crc oc-env') DO @call %i
+  > oc login https://api.crc.testing:6443
+`
+
+func expectedTemplate(shell string) string {
+	if runtime.GOOS == "windows" {
+		if shell == "powershell" {
+			return powershellTemplate
+		}
+		return cmdTemplate
+	}
+	return unixTemplate
+}

pkg/os/shell/shell.go

@@ -31,23 +31,31 @@ func isSupportedShell(userShell string) bool {
 	return false
 }
 
-func GenerateUsageHint(userShell, cmdLine string) string {
-	cmd := ""
-	comment := "#"
+func GenerateUsageHintWithComment(userShell, cmdLine string) string {
+	return fmt.Sprintf("%s Run this command to configure your shell:\n%s %s",
+		comment(userShell),
+		comment(userShell),
+		GenerateUsageHint(userShell, cmdLine))
+}
 
+func comment(userShell string) string {
+	if userShell == "cmd" {
+		return "REM"
+	}
+	return "#"
+}
+
+func GenerateUsageHint(userShell, cmdLine string) string {
 	switch userShell {
 	case "fish":
-		cmd = fmt.Sprintf("eval (%s)", cmdLine)
+		return fmt.Sprintf("eval (%s)", cmdLine)
 	case "powershell":
-		cmd = fmt.Sprintf("& %s | Invoke-Expression", cmdLine)
+		return fmt.Sprintf("& %s | Invoke-Expression", cmdLine)
 	case "cmd":
-		cmd = fmt.Sprintf("\t@FOR /f \"tokens=*\" %%i IN ('%s') DO @call %%i", cmdLine)
-		comment = "REM"
+		return fmt.Sprintf("@FOR /f \"tokens=*\" %%i IN ('%s') DO @call %%i", cmdLine)
 	default:
-		cmd = fmt.Sprintf("eval $(%s)", cmdLine)
+		return fmt.Sprintf("eval $(%s)", cmdLine)
 	}
-
-	return fmt.Sprintf("%s Run this command to configure your shell:\n%s %s", comment, comment, cmd)
 }
 
 func GetEnvString(userShell string, envName string, envValue string) string {

test/e2e/features/basic.feature

@@ -97,8 +97,8 @@ Feature: Basic test
         When starting CRC with default bundle succeeds
         Then stdout should contain "Started the OpenShift cluster"
         # Check if user can copy-paste login details for developer and kubeadmin users
-        And stdout should match "(?s)(.*)oc login -u developer -p developer https:\/\/api\.crc\.testing:6443(.*)$"
-        And stdout should match "(?s)(.*)oc login -u kubeadmin -p ([a-zA-Z0-9]{5}-){3}[a-zA-Z0-9]{5} https:\/\/api\.crc\.testing:6443(.*)$"
+        And stdout should match "(?s)(.*)oc login https:\/\/api\.crc\.testing:6443(.*)$"
+        And stdout should match "(?s)(.*)https:\/\/console-openshift-console\.apps-crc\.testing(.*)$"
 
     @darwin @linux @windows
     Scenario: CRC status and disk space check