fix test flake

johnstcn · johnstcn · commit 522348911f06 · 2025-03-28T11:12:52.000Z
diff --git a/mcp/tools/tools_coder_test.go b/mcp/tools/tools_coder_test.go
@@ -25,8 +25,6 @@ import (
 // Running them in parallel is prone to racy behavior.
 // nolint:tparallel,paralleltest
 func TestCoderTools(t *testing.T) {
-	t.Parallel()
-
 	ctx := testutil.Context(t, testutil.WaitLong)
 	// Given: a coder server, workspace, and agent.
 	client, store := coderdtest.NewWithDatabase(t, nil)
@@ -39,12 +37,20 @@ func TestCoderTools(t *testing.T) {
 		OwnerID:        member.ID,
 	}).WithAgent().Do()
 
-	agt := agenttest.New(t, client.URL, r.AgentToken)
-	t.Cleanup(func() {
-		_ = agt.Close()
-	})
-	// Given: the workspace agent is connected
-	_ = coderdtest.NewWorkspaceAgentWaiter(t, client, r.Workspace.ID).Wait()
+	// Note: we want to test the list_workspaces tool before starting the
+	// workspace agent. Starting the workspace agent will modify the workspace
+	// state, which will affect the results of the list_workspaces tool.
+	listWorkspacesDone := make(chan struct{})
+	agentStarted := make(chan struct{})
+	go func() {
+		defer close(agentStarted)
+		<-listWorkspacesDone
+		agt := agenttest.New(t, client.URL, r.AgentToken)
+		t.Cleanup(func() {
+			_ = agt.Close()
+		})
+		_ = coderdtest.NewWorkspaceAgentWaiter(t, client, r.Workspace.ID).Wait()
+	}()
 
 	// Given: a MCP server listening on a pty.
 	pty := ptytest.New(t)
@@ -118,6 +124,7 @@ func TestCoderTools(t *testing.T) {
 	})
 
 	t.Run("coder_list_workspaces", func(t *testing.T) {
+		defer close(listWorkspacesDone)
 		// When: the coder_list_workspaces tool is called
 		ctr := makeJSONRPCRequest(t, "tools/call", "coder_list_workspaces", map[string]any{
 			"coder_url":           client.URL.String(),
@@ -158,7 +165,11 @@ func TestCoderTools(t *testing.T) {
 		testutil.RequireJSONEq(t, expected, actual)
 	})
 
+	// NOTE: this test runs after the list_workspaces tool is called.
 	t.Run("coder_workspace_exec", func(t *testing.T) {
+		// Given: the workspace agent is connected
+		<-agentStarted
+
 		// When: the coder_workspace_exec tools is called with a command
 		randString := testutil.GetRandomName(t)
 		ctr := makeJSONRPCRequest(t, "tools/call", "coder_workspace_exec", map[string]any{
@@ -198,7 +209,11 @@ func TestCoderTools(t *testing.T) {
 		testutil.RequireJSONEq(t, expected, actual)
 	})
 
+	// NOTE: this test runs after the list_workspaces tool is called.
 	t.Run("tool_and_command_restrictions", func(t *testing.T) {
+		// Given: the workspace agent is connected
+		<-agentStarted
+
 		// Given: a restricted MCP server with only allowed tools and commands
 		restrictedPty := ptytest.New(t)
 		allowedTools := []string{"coder_workspace_exec"}
