fix default value

sreya · sreya · commit 0531bd341148 · 2024-01-30T01:26:44.000Z
diff --git a/cli/root.go b/cli/root.go
@@ -835,9 +835,14 @@ func (r *RootCmd) checkVersions(i *clibase.Invocation, client *codersdk.Client,
 	}
 
 	if !buildinfo.VersionsMatch(clientVersion, serverInfo.Version) {
+		upgradeMessage := defaultUpgradeMessage()
+		if serverInfo.UpgradeMessage != "" {
+			upgradeMessage = serverInfo.UpgradeMessage
+		}
+
 		fmtWarningText := "version mismatch: client %s, server %s\n%s"
 		fmtWarn := pretty.Sprint(cliui.DefaultStyles.Warn, fmtWarningText)
-		warning := fmt.Sprintf(fmtWarn, clientVersion, strings.TrimPrefix(serverInfo.CanonicalVersion(), "v"), serverInfo.UpgradeMessage)
+		warning := fmt.Sprintf(fmtWarn, clientVersion, strings.TrimPrefix(serverInfo.CanonicalVersion(), "v"), upgradeMessage)
 
 		_, _ = fmt.Fprint(i.Stderr, warning)
 		_, _ = fmt.Fprintln(i.Stderr)
@@ -1212,3 +1217,13 @@ func SlimUnsupported(w io.Writer, cmd string) {
 	//nolint:revive
 	os.Exit(1)
 }
+
+func defaultUpgradeMessage() string {
+	// Our installation script doesn't work on Windows, so instead we direct the user
+	// to the GitHub release page to download the latest installer.
+	version := buildinfo.Version()
+	if runtime.GOOS == "windows" {
+		return fmt.Sprintf("download the server version from: https://github.com/coder/coder/releases/v%s", version)
+	}
+	return fmt.Sprintf("download the server version with: 'curl -L https://coder.com/install.sh | sh -s -- --version %s'", version)
+}
diff --git a/cli/root_internal_test.go b/cli/root_internal_test.go
@@ -100,7 +100,7 @@ func TestMain(m *testing.M) {
 func Test_checkVersions(t *testing.T) {
 	t.Parallel()
 
-	t.Run("CustomInstallMessage", func(t *testing.T) {
+	t.Run("CustomUpgradeMessage", func(t *testing.T) {
 		t.Parallel()
 
 		var (
@@ -141,4 +141,43 @@ func Test_checkVersions(t *testing.T) {
 		expectedOutput := fmt.Sprintln(pretty.Sprint(cliui.DefaultStyles.Warn, fmtOutput))
 		require.Equal(t, expectedOutput, buf.String())
 	})
+
+	t.Run("DefaultUpgradeMessage", func(t *testing.T) {
+		t.Parallel()
+
+		srv := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+			httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.BuildInfoResponse{
+				ExternalURL: buildinfo.ExternalURL(),
+				// Provide a version that will not match
+				Version:         "v1.0.0",
+				AgentAPIVersion: coderd.AgentAPIVersionREST,
+				// does not matter what the url is
+				DashboardURL:   "https://example.com",
+				WorkspaceProxy: false,
+				UpgradeMessage: "",
+			})
+		}))
+		defer srv.Close()
+		surl, err := url.Parse(srv.URL)
+		require.NoError(t, err)
+
+		client := codersdk.New(surl)
+
+		r := &RootCmd{}
+
+		cmd, err := r.Command(nil)
+		require.NoError(t, err)
+
+		var buf bytes.Buffer
+		inv := cmd.Invoke()
+		inv.Stderr = &buf
+
+		err = r.checkVersions(inv, client, "v2.0.0")
+		require.NoError(t, err)
+
+		fmtOutput := fmt.Sprintf("version mismatch: client v2.0.0, server 1.0.0\n%s", defaultUpgradeMessage())
+		expectedOutput := fmt.Sprintln(pretty.Sprint(cliui.DefaultStyles.Warn, fmtOutput))
+		require.Equal(t, expectedOutput, buf.String())
+	})
+
 }
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -4,11 +4,9 @@ import (
 	"context"
 	"encoding/json"
 	"flag"
-	"fmt"
 	"net/http"
 	"os"
 	"path/filepath"
-	"runtime"
 	"strconv"
 	"strings"
 	"time"
@@ -1791,7 +1789,6 @@ when required by your organization's security policy.`,
 			YAML:        "cliUpgradeMessage",
 			Group:       &deploymentGroupClient,
 			Value:       &c.CLIUpgradeMessage,
-			Default:     defaultUpgradeMessage(),
 			Hidden:      false,
 		},
 		{
@@ -2305,13 +2302,3 @@ func (c *Client) SSHConfiguration(ctx context.Context) (SSHConfigResponse, error
 	var sshConfig SSHConfigResponse
 	return sshConfig, json.NewDecoder(res.Body).Decode(&sshConfig)
 }
-
-func defaultUpgradeMessage() string {
-	// Our installation script doesn't work on Windows, so instead we direct the user
-	// to the GitHub release page to download the latest installer.
-	version := buildinfo.Version()
-	if runtime.GOOS == "windows" {
-		return fmt.Sprintf("download the server version from: https://github.com/coder/coder/releases/v%s", version)
-	}
-	return fmt.Sprintf("download the server version with: 'curl -L https://coder.com/install.sh | sh -s -- --version %s'", version)
-}
