rename flag, extra test

coder · ethanndickson · Apr 30, 2025 · Apr 28, 2025 · Apr 28, 2025 · Apr 28, 2025
commit 578ebb0b744d5db9cde72101412a4686dfcd931a
diff --git a/cli/ssh.go b/cli/ssh.go
@@ -665,8 +665,8 @@ func (r *RootCmd) ssh() *serpent.Command {
 			Hidden:      true, // Hidden until this features is at least in beta.
 		},
 		{
-			Flag:        "force-tunnel",
-			Description: "Force the use of a new tunnel to the workspace, even if the Coder Connect tunnel is available.",
+			Flag:        "force-new-tunnel",
+			Description: "Force the creation of a new tunnel to the workspace, even if the Coder Connect tunnel is available.",
 			Value:       serpent.BoolOf(&forceTunnel),
 		},
 		sshDisableAutostartOption(serpent.BoolOf(&disableAutostart)),

diff --git a/cli/ssh_test.go b/cli/ssh_test.go
@@ -2114,41 +2114,71 @@ func TestSSH_Container(t *testing.T) {
 func TestSSH_CoderConnect(t *testing.T) {
 	t.Parallel()
 
-	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
-	defer cancel()
+	t.Run("Enabled", func(t *testing.T) {
+		t.Parallel()
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
+		defer cancel()
 
-	fs := afero.NewMemMapFs()
-	//nolint:revive,staticcheck
-	ctx = context.WithValue(ctx, "fs", fs)
+		fs := afero.NewMemMapFs()
+		//nolint:revive,staticcheck
+		ctx = context.WithValue(ctx, "fs", fs)
 
-	client, workspace, agentToken := setupWorkspaceForAgent(t)
-	inv, root := clitest.New(t, "ssh", workspace.Name, "--network-info-dir", "/net", "--stdio")
-	clitest.SetupConfig(t, client, root)
-	_ = ptytest.New(t).Attach(inv)
+		client, workspace, agentToken := setupWorkspaceForAgent(t)
+		inv, root := clitest.New(t, "ssh", workspace.Name, "--network-info-dir", "/net", "--stdio")
+		clitest.SetupConfig(t, client, root)
+		_ = ptytest.New(t).Attach(inv)
 
-	errCh := make(chan error, 1)
-	tGo(t, func() {
-		err := inv.WithContext(withCoderConnectRunning(ctx)).Run()
-		errCh <- err
+		errCh := make(chan error, 1)
+		tGo(t, func() {
+			err := inv.WithContext(withCoderConnectRunning(ctx)).Run()
+			errCh <- err
+		})
+
+		_ = agenttest.New(t, client.URL, agentToken)
+		coderdtest.AwaitWorkspaceAgents(t, client, workspace.ID)
+
+		err := testutil.TryReceive(ctx, t, errCh)
+		// Making an SSH server available here is difficult, so we'll just check
+		// the command attempts to dial it.
+		require.ErrorContains(t, err, "dial coder connect host")
+		require.ErrorContains(t, err, "dev.myworkspace.myuser.coder")
+
+		// The network info file should be created since we passed `--stdio`
+		assert.Eventually(t, func() bool {
+			entries, err := afero.ReadDir(fs, "/net")
+			if err != nil {
+				return false
+			}
+			return len(entries) > 0
+		}, testutil.WaitLong, testutil.IntervalFast)
 	})
 
-	_ = agenttest.New(t, client.URL, agentToken)
-	coderdtest.AwaitWorkspaceAgents(t, client, workspace.ID)
+	t.Run("Disabled", func(t *testing.T) {
+		t.Parallel()
 
-	err := testutil.TryReceive(ctx, t, errCh)
-	// Making an SSH server available here is difficult, so we'll just check
-	// the command attempts to dial it.
-	require.ErrorContains(t, err, "dial coder connect host")
-	require.ErrorContains(t, err, "dev.myworkspace.myuser.coder")
-
-	// The network info file should be created since we passed `--stdio`
-	assert.Eventually(t, func() bool {
-		entries, err := afero.ReadDir(fs, "/net")
-		if err != nil {
-			return false
-		}
-		return len(entries) > 0
-	}, testutil.WaitLong, testutil.IntervalFast)
+		client, workspace, agentToken := setupWorkspaceForAgent(t)
+		inv, root := clitest.New(t, "ssh", workspace.Name, "--force-new-tunnel")
+		clitest.SetupConfig(t, client, root)
+		pty := ptytest.New(t).Attach(inv)
+
+		ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
+		defer cancel()
+
+		cmdDone := tGo(t, func() {
+			err := inv.WithContext(withCoderConnectRunning(ctx)).Run()
+			assert.NoError(t, err)
+		})
+		// Shouldn't fail to dial the coder connect host `--force-new-tunnel`
+		// is passed.
+		pty.ExpectMatch("Waiting")
+
+		_ = agenttest.New(t, client.URL, agentToken)
+		coderdtest.AwaitWorkspaceAgents(t, client, workspace.ID)
+
+		// Shells on Mac, Windows, and Linux all exit shells with the "exit" command.
+		pty.WriteLine("exit")
+		<-cmdDone
+	})
 }
 
 // tGoContext runs fn in a goroutine passing a context that will be

diff --git a/cli/testdata/coder_ssh_--help.golden b/cli/testdata/coder_ssh_--help.golden
@@ -12,8 +12,8 @@ OPTIONS:
   -e, --env string-array, $CODER_SSH_ENV
           Set environment variable(s) for session (key1=value1,key2=value2,...).
 
-          --force-tunnel bool
-          Force the use of a new tunnel to the workspace, even if the Coder
+      --force-new-tunnel bool
+          Force the creation of a new tunnel to the workspace, even if the Coder
           Connect tunnel is available.
 
   -A, --forward-agent bool, $CODER_SSH_FORWARD_AGENT

diff --git a/docs/reference/cli/ssh.md b/docs/reference/cli/ssh.md