fix: resolve server initialization race condition in TestWorkspaceAgent/GoogleCloud

sreya · sreya · commit f204a8942742 · 2025-07-21T16:55:02.000Z
The test was flaky due to a race condition where the agent CLI would start and attempt authentication before the HTTP server's handler was fully initialized. The test server starts immediately but the handler is set asynchronously, creating a window where requests return 404. This fix waits for the server to be ready by making a test request to /api/v2/buildinfo before starting the agent, ensuring the HTTP handler is properly set up. Fixes: coder/internal#778
diff --git a/cli/agent_test.go b/cli/agent_test.go
@@ -159,6 +159,18 @@ func TestWorkspaceAgent(t *testing.T) {
 			return agents
 		}).Do()
 
+		// Wait for the server to be ready to handle requests.
+		// This prevents a race condition where the agent tries to authenticate
+		// before the server's HTTP handler is fully set up.
+		require.Eventually(t, func() bool {
+			resp, err := client.Request(context.Background(), "GET", "/api/v2/buildinfo", nil)
+			if err != nil {
+				return false
+			}
+			defer resp.Body.Close()
+			return resp.StatusCode == http.StatusOK
+		}, testutil.WaitMedium, testutil.IntervalFast)
+
 		inv, cfg := clitest.New(t, "agent", "--auth", "google-instance-identity", "--agent-url", client.URL.String())
 		clitest.SetupConfig(t, member, cfg)
 
