fix: resolve race condition in TestWorkspaceAgent/GoogleCloud

sreya · sreya · commit 57a24fa05800 · 2025-07-21T16:01:21.000Z
The test was flaky due to a race condition where the agent CLI would start and attempt Google Cloud instance identity authentication before the agent was fully inserted into the database. This fix adds a synchronization point that waits for the agent to be properly inserted into the database before starting the agent CLI, eliminating the race condition. Fixes: coder/internal#778
diff --git a/cli/agent_test.go b/cli/agent_test.go
@@ -20,6 +20,7 @@ import (
 	"github.com/coder/coder/v2/coderd"
 	"github.com/coder/coder/v2/coderd/coderdtest"
 	"github.com/coder/coder/v2/coderd/database"
+	"github.com/coder/coder/v2/coderd/database/dbauthz"
 	"github.com/coder/coder/v2/coderd/database/dbfake"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/codersdk/workspacesdk"
@@ -159,6 +160,15 @@ func TestWorkspaceAgent(t *testing.T) {
 			return agents
 		}).Do()
 
+		// Wait for the agent to be properly inserted into the database before starting the CLI.
+		// This prevents a race condition where the agent tries to authenticate before
+		// the database has been updated with the agent's instance ID.
+		require.Eventually(t, func() bool {
+			ctx := dbauthz.AsSystemRestricted(context.Background())
+			_, err := db.GetWorkspaceAgentByInstanceID(ctx, instanceID)
+			return err == nil
+		}, testutil.WaitMedium, testutil.IntervalFast)
+
 		inv, cfg := clitest.New(t, "agent", "--auth", "google-instance-identity", "--agent-url", client.URL.String())
 		clitest.SetupConfig(t, member, cfg)
 
