cli/ssh_internal_test.go

Rama main · réplica de lectura del repositorio original.

package cli

import (
	"context"
	"encoding/json"
	"fmt"
	"io"
	"net"
	"net/http"
	"net/http/httptest"
	"net/url"
	"os"
	"sync"
	"testing"
	"time"

	gliderssh "github.com/gliderlabs/ssh"
	"github.com/google/uuid"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"golang.org/x/crypto/ssh"
	"golang.org/x/xerrors"

	"cdr.dev/slog/v3"
	"cdr.dev/slog/v3/sloggers/slogtest"
	"github.com/coder/coder/v2/codersdk"
	"github.com/coder/coder/v2/testutil"
	"github.com/coder/quartz"
)

const (
	fakeOwnerName     = "fake-owner-name"
	fakeServerURL     = "https://fake-foo-url"
	fakeWorkspaceName = "fake-workspace-name"
)

func TestVerifyWorkspaceOutdated(t *testing.T) {
	t.Parallel()

	serverURL, err := url.Parse(fakeServerURL)
	require.NoError(t, err)

	client := codersdk.Client{URL: serverURL}

	t.Run("Up-to-date", func(t *testing.T) {
		t.Parallel()

		workspace := codersdk.Workspace{Name: fakeWorkspaceName, OwnerName: fakeOwnerName}

		_, outdated := verifyWorkspaceOutdated(&client, workspace)

		assert.False(t, outdated, "workspace should be up-to-date")
	})
	t.Run("Outdated", func(t *testing.T) {
		t.Parallel()

		workspace := codersdk.Workspace{Name: fakeWorkspaceName, OwnerName: fakeOwnerName, Outdated: true}

		updateWorkspaceBanner, outdated := verifyWorkspaceOutdated(&client, workspace)

		assert.True(t, outdated, "workspace should be outdated")
		assert.NotEmpty(t, updateWorkspaceBanner, "workspace banner should be present")
	})
}

func TestBuildWorkspaceLink(t *testing.T) {
	t.Parallel()

	serverURL, err := url.Parse(fakeServerURL)
	require.NoError(t, err)

	workspace := codersdk.Workspace{Name: fakeWorkspaceName, OwnerName: fakeOwnerName}
	workspaceLink := buildWorkspaceLink(serverURL, workspace)

	assert.Equal(t, workspaceLink.String(), fakeServerURL+"/@"+fakeOwnerName+"/"+fakeWorkspaceName)
}

func TestCloserStack_Mainline(t *testing.T) {
	t.Parallel()
	ctx := testutil.Context(t, testutil.WaitShort)
	logger := testutil.Logger(t)
	uut := newCloserStack(ctx, logger, quartz.NewMock(t))
	closes := new([]*fakeCloser)
	fc0 := &fakeCloser{closes: closes}
	fc1 := &fakeCloser{closes: closes}

	func() {
		defer uut.close(nil)
		err := uut.push("fc0", fc0)
		require.NoError(t, err)
		err = uut.push("fc1", fc1)
		require.NoError(t, err)
	}()
	// order reversed
	require.Equal(t, []*fakeCloser{fc1, fc0}, *closes)
}

func TestCloserStack_Empty(t *testing.T) {
	t.Parallel()
	ctx := testutil.Context(t, testutil.WaitShort)
	logger := testutil.Logger(t)
	uut := newCloserStack(ctx, logger, quartz.NewMock(t))

	closed := make(chan struct{})
	go func() {
		defer close(closed)
		uut.close(nil)
	}()
	testutil.TryReceive(ctx, t, closed)
}

func TestCloserStack_Context(t *testing.T) {
	t.Parallel()
	ctx := testutil.Context(t, testutil.WaitShort)
	ctx, cancel := context.WithCancel(ctx)
	defer cancel()
	logger := testutil.Logger(t)
	uut := newCloserStack(ctx, logger, quartz.NewMock(t))
	closes := new([]*fakeCloser)
	fc0 := &fakeCloser{closes: closes}
	fc1 := &fakeCloser{closes: closes}

	err := uut.push("fc0", fc0)
	require.NoError(t, err)
	err = uut.push("fc1", fc1)
	require.NoError(t, err)
	cancel()
	require.Eventually(t, func() bool {
		uut.Lock()
		defer uut.Unlock()
		return uut.closed
	}, testutil.WaitShort, testutil.IntervalFast)
}

func TestCloserStack_PushAfterClose(t *testing.T) {
	t.Parallel()
	ctx := testutil.Context(t, testutil.WaitShort)
	logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug)
	uut := newCloserStack(ctx, logger, quartz.NewMock(t))
	closes := new([]*fakeCloser)
	fc0 := &fakeCloser{closes: closes}
	fc1 := &fakeCloser{closes: closes}

	err := uut.push("fc0", fc0)
	require.NoError(t, err)

	exErr := xerrors.New("test")
	uut.close(exErr)
	require.Equal(t, []*fakeCloser{fc0}, *closes)

	err = uut.push("fc1", fc1)
	require.ErrorIs(t, err, exErr)
	require.Equal(t, []*fakeCloser{fc1, fc0}, *closes, "should close fc1")
}

func TestCloserStack_CloseAfterContext(t *testing.T) {
	t.Parallel()
	testCtx := testutil.Context(t, testutil.WaitShort)
	ctx, cancel := context.WithCancel(testCtx)
	defer cancel()
	logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug)
	uut := newCloserStack(ctx, logger, quartz.NewMock(t))
	ac := newAsyncCloser(testCtx, t)
	defer ac.unblock()
	err := uut.push("async", ac)
	require.NoError(t, err)
	cancel()
	testutil.TryReceive(testCtx, t, ac.started)

	closed := make(chan struct{})
	go func() {
		defer close(closed)
		uut.close(nil)
	}()

	// since the asyncCloser is still waiting, we shouldn't complete uut.close()
	select {
	case <-time.After(testutil.IntervalFast):
		// OK!
	case <-closed:
		t.Fatal("closed before stack was finished")
	}

	ac.unblock()
	testutil.TryReceive(testCtx, t, closed)
	testutil.TryReceive(testCtx, t, ac.done)
}

func TestCloserStack_Timeout(t *testing.T) {
	t.Parallel()
	ctx := testutil.Context(t, testutil.WaitShort)
	logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug)
	mClock := quartz.NewMock(t)
	trap := mClock.Trap().TickerFunc("closerStack")
	defer trap.Close()
	uut := newCloserStack(ctx, logger, mClock)
	var ac [3]*asyncCloser
	for i := range ac {
		ac[i] = newAsyncCloser(ctx, t)
		err := uut.push(fmt.Sprintf("async %d", i), ac[i])
		require.NoError(t, err)
	}
	defer func() {
		for _, a := range ac {
			a.unblock()
			testutil.TryReceive(ctx, t, a.done) // ensure we don't race with context cancellation
		}
	}()

	closed := make(chan struct{})
	go func() {
		defer close(closed)
		uut.close(nil)
	}()
	trap.MustWait(ctx).MustRelease(ctx)
	// top starts right away, but it hangs
	testutil.TryReceive(ctx, t, ac[2].started)
	// timer pops and we start the middle one
	mClock.Advance(gracefulShutdownTimeout).MustWait(ctx)
	testutil.TryReceive(ctx, t, ac[1].started)

	// middle one finishes
	ac[1].unblock()
	// bottom starts, but also hangs
	testutil.TryReceive(ctx, t, ac[0].started)

	// timer has to pop twice to time out.
	mClock.Advance(gracefulShutdownTimeout).MustWait(ctx)
	mClock.Advance(gracefulShutdownTimeout).MustWait(ctx)
	testutil.TryReceive(ctx, t, closed)
}

func TestCloserStack_PushAfterClose_ConnClosed(t *testing.T) {
	t.Parallel()
	ctx := testutil.Context(t, testutil.WaitShort)
	logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug)
	uut := newCloserStack(ctx, logger, quartz.NewMock(t))

	uut.close(xerrors.New("canceled"))

	closes := new([]*fakeCloser)
	fc := &fakeCloser{closes: closes}
	err := uut.push("conn", fc)
	require.Error(t, err)
	require.Equal(t, []*fakeCloser{fc}, *closes, "should close conn on failed push")
}

func TestCoderConnectDialer_DefaultTimeout(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	dialer := testOrDefaultDialer(ctx)
	d, ok := dialer.(*net.Dialer)
	require.True(t, ok, "expected *net.Dialer")
	assert.Equal(t, 5*time.Second, d.Timeout)
	assert.Equal(t, 30*time.Second, d.KeepAlive)
}

func TestCoderConnectDialer_Overridden(t *testing.T) {
	t.Parallel()
	custom := &net.Dialer{Timeout: 99 * time.Second}
	ctx := WithTestOnlyCoderConnectDialer(context.Background(), custom)

	dialer := testOrDefaultDialer(ctx)
	assert.Equal(t, custom, dialer)
}

func TestCoderConnectStdio(t *testing.T) {
	t.Parallel()

	ctx := testutil.Context(t, testutil.WaitShort)
	logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
	stack := newCloserStack(ctx, logger, quartz.NewMock(t))

	clientOutput, clientInput := io.Pipe()
	serverOutput, serverInput := io.Pipe()
	defer func() {
		for _, c := range []io.Closer{clientOutput, clientInput, serverOutput, serverInput} {
			_ = c.Close()
		}
	}()

	sshSrv := newSSHServer("127.0.0.1:0")
	defer sshSrv.Close()

	sshLn, err := net.Listen("tcp", sshSrv.server.Addr)
	require.NoError(t, err)
	go func() {
		_ = sshSrv.Serve(sshLn)
	}()

	sshAddr, ok := sshLn.Addr().(*net.TCPAddr)
	require.True(t, ok)

	// Force using the fallback.
	httpSrv := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
		rw.WriteHeader(http.StatusNotFound)
	}))
	defer httpSrv.Close()

	httpAddr, ok := httpSrv.Listener.Addr().(*net.TCPAddr)
	require.True(t, ok)

	stdioDone := make(chan struct{})
	go func() {
		err = runCoderConnectStdio(ctx, coderConnectOpts{
			host:     "127.0.0.1",
			httpPort: uint16(httpAddr.Port), // nolint:gosec // ports fit within uint16
			tcpPort:  uint16(sshAddr.Port),  // nolint:gosec // ports fit within uint16
			stdin:    clientOutput,
			stdout:   serverInput,
			stack:    stack,
			logger:   logger,
		})
		assert.NoError(t, err)
		close(stdioDone)
	}()

	conn, channels, requests, err := ssh.NewClientConn(&testutil.ReaderWriterConn{
		Reader: serverOutput,
		Writer: clientInput,
	}, "", &ssh.ClientConfig{
		// #nosec
		HostKeyCallback: ssh.InsecureIgnoreHostKey(),
	})
	require.NoError(t, err)
	defer conn.Close()

	sshClient := ssh.NewClient(conn, channels, requests)
	session, err := sshClient.NewSession()
	require.NoError(t, err)
	defer session.Close()

	// We're not connected to a real shell
	err = session.Run("")
	require.NoError(t, err)
	err = sshClient.Close()
	require.NoError(t, err)
	_ = clientOutput.Close()

	<-stdioDone
}

type sshServer struct {
	server *gliderssh.Server
}

func newSSHServer(addr string) *sshServer {
	return &sshServer{
		server: &gliderssh.Server{
			Addr: addr,
			Handler: func(s gliderssh.Session) {
				_, _ = io.WriteString(s.Stderr(), "Connected!")
			},
		},
	}
}

func (s *sshServer) Serve(ln net.Listener) error {
	return s.server.Serve(ln)
}

func (s *sshServer) Close() error {
	return s.server.Close()
}

type fakeCloser struct {
	closes *[]*fakeCloser
	err    error
}

func (c *fakeCloser) Close() error {
	*c.closes = append(*c.closes, c)
	return c.err
}

type asyncCloser struct {
	t           *testing.T
	ctx         context.Context
	started     chan struct{}
	done        chan struct{}
	isUnblocked chan struct{}
	unblockOnce sync.Once
}

func (c *asyncCloser) Close() error {
	close(c.started)
	defer close(c.done)
	select {
	case <-c.ctx.Done():
		c.t.Error("timed out")
		return c.ctx.Err()
	case <-c.isUnblocked:
		return nil
	}
}

func (c *asyncCloser) unblock() {
	c.unblockOnce.Do(func() { close(c.isUnblocked) })
}

func newAsyncCloser(ctx context.Context, t *testing.T) *asyncCloser {
	return &asyncCloser{
		t:           t,
		ctx:         ctx,
		isUnblocked: make(chan struct{}),
		started:     make(chan struct{}),
		done:        make(chan struct{}),
	}
}

func Test_getWorkspaceAgent(t *testing.T) {
	t.Parallel()

	createWorkspaceWithAgents := func(agents []codersdk.WorkspaceAgent) codersdk.Workspace {
		return codersdk.Workspace{
			Name: "test-workspace",
			LatestBuild: codersdk.WorkspaceBuild{
				Resources: []codersdk.WorkspaceResource{
					{
						Agents: agents,
					},
				},
			},
		}
	}

	createAgent := func(name string) codersdk.WorkspaceAgent {
		return codersdk.WorkspaceAgent{
			ID:   uuid.New(),
			Name: name,
		}
	}

	t.Run("SingleAgent_NoNameSpecified", func(t *testing.T) {
		t.Parallel()
		agent := createAgent("main")
		workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent})

		result, _, err := getWorkspaceAgent(workspace, "")
		require.NoError(t, err)
		assert.Equal(t, agent.ID, result.ID)
		assert.Equal(t, "main", result.Name)
	})

	t.Run("MultipleAgents_NoNameSpecified", func(t *testing.T) {
		t.Parallel()
		agent1 := createAgent("main1")
		agent2 := createAgent("main2")
		workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent1, agent2})

		_, _, err := getWorkspaceAgent(workspace, "")
		require.Error(t, err)
		assert.Contains(t, err.Error(), "multiple agents found")
		assert.Contains(t, err.Error(), "available agents: [main1 main2]")
	})

	t.Run("AgentNameSpecified_Found", func(t *testing.T) {
		t.Parallel()
		agent1 := createAgent("main1")
		agent2 := createAgent("main2")
		workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent1, agent2})

		result, other, err := getWorkspaceAgent(workspace, "main1")
		require.NoError(t, err)
		assert.Equal(t, agent1.ID, result.ID)
		assert.Equal(t, "main1", result.Name)
		assert.Len(t, other, 1)
		assert.Equal(t, agent2.ID, other[0].ID)
		assert.Equal(t, "main2", other[0].Name)
	})

	t.Run("AgentNameSpecified_NotFound", func(t *testing.T) {
		t.Parallel()
		agent1 := createAgent("main1")
		agent2 := createAgent("main2")
		workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent1, agent2})

		_, _, err := getWorkspaceAgent(workspace, "nonexistent")
		require.Error(t, err)
		assert.Contains(t, err.Error(), `agent not found by name "nonexistent"`)
		assert.Contains(t, err.Error(), "available agents: [main1 main2]")
	})

	t.Run("NoAgents", func(t *testing.T) {
		t.Parallel()
		workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{})

		_, _, err := getWorkspaceAgent(workspace, "")
		require.Error(t, err)
		assert.Contains(t, err.Error(), `workspace "test-workspace" has no agents`)
	})

	t.Run("AvailableAgentNames_SortedCorrectly", func(t *testing.T) {
		t.Parallel()
		// Define agents in non-alphabetical order.
		agent2 := createAgent("zod")
		agent1 := createAgent("clark")
		agent3 := createAgent("krypton")
		workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent2, agent1, agent3})

		_, _, err := getWorkspaceAgent(workspace, "nonexistent")
		require.Error(t, err)
		// Available agents should be sorted alphabetically.
		assert.Contains(t, err.Error(), "available agents: [clark krypton zod]")
	})
}

func TestIsRetryableError(t *testing.T) {
	t.Parallel()

	tests := []struct {
		name      string
		err       error
		retryable bool
	}{
		{"Nil", nil, false},
		{"ContextCanceled", context.Canceled, false},
		{"ContextDeadlineExceeded", context.DeadlineExceeded, false},
		{"WrappedContextCanceled", xerrors.Errorf("wrapped: %w", context.Canceled), false},
		{"DNSError", &net.DNSError{Err: "no such host", Name: "example.com", IsNotFound: true}, true},
		{"OpError", &net.OpError{Op: "dial", Net: "tcp", Err: &os.SyscallError{}}, true},
		{"WrappedDNSError", xerrors.Errorf("connect: %w", &net.DNSError{Err: "no such host", Name: "example.com"}), true},
		{"SDKError_500", codersdk.NewTestError(http.StatusInternalServerError, "GET", "/api"), true},
		{"SDKError_502", codersdk.NewTestError(http.StatusBadGateway, "GET", "/api"), true},
		{"SDKError_503", codersdk.NewTestError(http.StatusServiceUnavailable, "GET", "/api"), true},
		{"SDKError_401", codersdk.NewTestError(http.StatusUnauthorized, "GET", "/api"), false},
		{"SDKError_403", codersdk.NewTestError(http.StatusForbidden, "GET", "/api"), false},
		{"SDKError_404", codersdk.NewTestError(http.StatusNotFound, "GET", "/api"), false},
		{"GenericError", xerrors.New("something went wrong"), false},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()
			assert.Equal(t, tt.retryable, isRetryableError(tt.err))
		})
	}

	// net.Dialer.Timeout produces *net.OpError that matches both
	// IsConnectionError and context.DeadlineExceeded. Verify it is retryable.
	t.Run("DialTimeout", func(t *testing.T) {
		t.Parallel()
		ctx, cancel := context.WithDeadline(context.Background(), time.Now())
		defer cancel()
		<-ctx.Done() // ensure deadline has fired
		_, err := (&net.Dialer{}).DialContext(ctx, "tcp", "127.0.0.1:1")
		require.Error(t, err)
		// Proves the ambiguity: this error matches BOTH checks.
		require.ErrorIs(t, err, context.DeadlineExceeded)
		require.ErrorAs(t, err, new(*net.OpError))
		assert.True(t, isRetryableError(err))
		// Also when wrapped, as runCoderConnectStdio does.
		assert.True(t, isRetryableError(xerrors.Errorf("dial coder connect: %w", err)))
	})
}

func TestRetryWithInterval(t *testing.T) {
	t.Parallel()

	const interval = time.Millisecond
	const maxAttempts = 3

	dnsErr := &net.DNSError{Err: "no such host", Name: "example.com", IsNotFound: true}

	t.Run("Succeeds_FirstTry", func(t *testing.T) {
		t.Parallel()
		ctx := testutil.Context(t, testutil.WaitShort)
		logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)

		attempts := 0
		err := retryWithInterval(ctx, logger, interval, maxAttempts, func() error {
			attempts++
			return nil
		})
		require.NoError(t, err)
		assert.Equal(t, 1, attempts)
	})

	t.Run("Succeeds_AfterTransientFailures", func(t *testing.T) {
		t.Parallel()
		ctx := testutil.Context(t, testutil.WaitShort)
		logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)

		attempts := 0
		err := retryWithInterval(ctx, logger, interval, maxAttempts, func() error {
			attempts++
			if attempts < 3 {
				return dnsErr
			}
			return nil
		})
		require.NoError(t, err)
		assert.Equal(t, 3, attempts)
	})

	t.Run("Stops_NonRetryableError", func(t *testing.T) {
		t.Parallel()
		ctx := testutil.Context(t, testutil.WaitShort)
		logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)

		attempts := 0
		err := retryWithInterval(ctx, logger, interval, maxAttempts, func() error {
			attempts++
			return xerrors.New("permanent failure")
		})
		require.ErrorContains(t, err, "permanent failure")
		assert.Equal(t, 1, attempts)
	})

	t.Run("Stops_MaxAttemptsExhausted", func(t *testing.T) {
		t.Parallel()
		ctx := testutil.Context(t, testutil.WaitShort)
		logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)

		attempts := 0
		err := retryWithInterval(ctx, logger, interval, maxAttempts, func() error {
			attempts++
			return dnsErr
		})
		require.Error(t, err)
		assert.Equal(t, maxAttempts, attempts)
	})

	t.Run("Stops_ContextCanceled", func(t *testing.T) {
		t.Parallel()
		ctx, cancel := context.WithCancel(context.Background())
		logger := slogtest.Make(t, nil).Leveled(slog.LevelDebug)

		attempts := 0
		err := retryWithInterval(ctx, logger, interval, maxAttempts, func() error {
			attempts++
			cancel()
			return dnsErr
		})
		require.Error(t, err)
		assert.Equal(t, 1, attempts)
	})
}

func TestWatchAndCloseShutdownReason(t *testing.T) {
	t.Parallel()
	for _, transition := range []codersdk.WorkspaceTransition{codersdk.WorkspaceTransitionStop, codersdk.WorkspaceTransitionDelete} {
		t.Run(string(transition), func(t *testing.T) {
			t.Parallel()
			ctx := testutil.Context(t, testutil.WaitLong)
			watchCtx, cancel := context.WithCancel(ctx)
			defer cancel()
			events := make(chan codersdk.Workspace)
			srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
				w.Header().Set("Content-Type", "text/event-stream")
				w.WriteHeader(http.StatusOK)
				flusher := w.(http.Flusher)
				flusher.Flush()
				for {
					select {
					case event := <-events:
						data, err := json.Marshal(event)
						if err != nil {
							return
						}
						_, _ = fmt.Fprintf(w, "event: data\ndata: %s\n\n", data)
						flusher.Flush()
					case <-r.Context().Done():
						return
					}
				}
			}))
			t.Cleanup(srv.Close)
			t.Cleanup(cancel)
			serverURL, err := url.Parse(srv.URL)
			require.NoError(t, err)
			client := codersdk.New(serverURL)
			workspace := codersdk.Workspace{ID: uuid.New(), LatestBuild: codersdk.WorkspaceBuild{
				ID: uuid.New(), Transition: codersdk.WorkspaceTransitionStart,
			}}
			sink := testutil.NewFakeSink(t)
			clientSessionID := "0123456789abcdef0123456789abcdef"
			watchCtx = slog.With(watchCtx, slog.F("client_session_id", clientSessionID))
			closed := make(chan struct{})
			done := make(chan struct{})
			go func() {
				defer close(done)
				watchAndClose(watchCtx, func() error { close(closed); return nil },
					sink.Logger(), client, workspace, nil)
			}()
			t.Cleanup(func() { cancel(); testutil.TryReceive(ctx, t, done) })
			send := func(event codersdk.Workspace) {
				t.Helper()
				select {
				case events <- event:
				case <-ctx.Done():
					t.Fatal("workspace watcher did not receive event")
				}
			}
			send(workspace)
			shutdown := workspace
			shutdown.LatestBuild = codersdk.WorkspaceBuild{
				ID: uuid.New(), Transition: transition, Reason: codersdk.BuildReasonAutostop,
				Status: codersdk.WorkspaceStatusStopping,
				Job:    codersdk.ProvisionerJob{Status: codersdk.ProvisionerJobPending},
			}
			if transition == codersdk.WorkspaceTransitionDelete {
				shutdown.LatestBuild.Status = codersdk.WorkspaceStatusDeleting
			}
			// A queued job does not establish a shutdown cause.
			queued := shutdown
			queued.LatestBuild.ID = uuid.New()
			send(queued)
			shutdownLogs := func() []slog.SinkEntry {
				return sink.Entries(func(e slog.SinkEntry) bool { return e.Message == "workspace is shutting down" })
			}
			shutdown.LatestBuild.Job.Status = codersdk.ProvisionerJobRunning
			send(shutdown)
			require.Eventually(t, func() bool { return len(shutdownLogs()) == 1 }, testutil.WaitLong, testutil.IntervalFast)
			select {
			case <-closed:
				t.Fatal("shutdown notification closed SSH before the agent could stop gracefully")
			default:
			}
			// Repeated updates for the same build should not repeat the reason.
			shutdown.LatestBuild.Job.Status = codersdk.ProvisionerJobSucceeded
			send(shutdown)
			failed := shutdown
			failed.LatestBuild.ID = uuid.New()
			failed.LatestBuild.Job.Status = codersdk.ProvisionerJobFailed
			send(failed)
			// A new START build ends this watch, after preceding events are handled.
			restarted := workspace
			restarted.LatestBuild.ID = uuid.New()
			send(restarted)
			testutil.TryReceive(ctx, t, done)
			testutil.TryReceive(ctx, t, closed)
			entries := shutdownLogs()
			require.Len(t, entries, 1)
			for _, field := range []slog.Field{
				slog.F("client_session_id", clientSessionID), slog.F("workspace_id", workspace.ID),
				slog.F("build_id", shutdown.LatestBuild.ID), slog.F("build_reason", codersdk.BuildReasonAutostop),
				slog.F("transition", transition), codersdk.DisconnectReasonWorkspaceStopped.SlogField(),
			} {
				require.Contains(t, entries[0].Fields, field)
			}
		})
	}
}

func Test_agentSSHSuggestion(t *testing.T) {
	t.Parallel()

	ws := codersdk.Workspace{Name: "dogfood", OwnerName: "alice"}
	agent := codersdk.WorkspaceAgent{Name: "dev"}

	for _, tc := range []struct {
		name         string
		config       codersdk.SSHConfigResponse
		includeOwner bool
		want         string
	}{
		{
			// Invoked directly, so no OpenSSH host entry exists for the
			// agent and the suggestion must use coder ssh.
			name: "NoPrefixOrSuffix",
			want: "$ coder ssh dogfood.dev",
		},
		{
			name:         "NoPrefixOrSuffix_IncludeOwner",
			includeOwner: true,
			want:         "$ coder ssh alice/dogfood.dev",
		},
		{
			name:   "HostnameSuffix",
			config: codersdk.SSHConfigResponse{HostnameSuffix: "coder"},
			want:   "$ ssh dev.dogfood.alice.coder",
		},
		{
			name:   "HostnamePrefix",
			config: codersdk.SSHConfigResponse{HostnamePrefix: "coder."},
			want:   "$ ssh coder.dev.dogfood.alice",
		},
	} {
		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()
			assert.Equal(t, tc.want, agentSSHSuggestion(tc.config, ws, agent, tc.includeOwner))
		})
	}
}

func Test_suggestWithOwner(t *testing.T) {
	t.Parallel()

	ws := codersdk.Workspace{ID: uuid.New(), Name: "dogfood", OwnerName: "alice"}
	assert.False(t, suggestWithOwner("dogfood", ws))
	assert.True(t, suggestWithOwner("alice/dogfood", ws))
	// A workspace ID can refer to anyone's workspace.
	assert.True(t, suggestWithOwner(ws.ID.String(), ws))
}