Function TestWatchAllWorkspaceBuilds

coderd/workspaces_test.go:3975–4080

(t *testing.T)

}

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

	// Enable the workspace build updates experiment.
	client, closer := coderdtest.NewWithProvisionerCloser(t, &coderdtest.Options{
		IncludeProvisionerDaemon: true,
		DeploymentValues: coderdtest.DeploymentValues(t, func(dv *codersdk.DeploymentValues) {
			dv.Experiments = []string{string(codersdk.ExperimentWorkspaceBuildUpdates)}
		}),
	})
	defer closer.Close()
	user := coderdtest.CreateFirstUser(t, client)

	// Create a simple template version.
	version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
		Parse:         echo.ParseComplete,
		ProvisionPlan: echo.PlanComplete,
		ProvisionGraph: []*proto.Response{{
			Type: &proto.Response_Graph{
				Graph: &proto.GraphComplete{
					Resources: []*proto.Resource{{
						Name: "example",
						Type: "aws_instance",
					}},
				},
			},
		}},
	})
	coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
	template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
	defer cancel()

	// Subscribe to all workspace build updates via SSE BEFORE creating workspaces
	// so we can use it to wait for the initial builds.
	decoder, err := client.WatchAllWorkspaceBuilds(ctx)
	require.NoError(t, err)
	defer decoder.Close()

	updates := decoder.Chan()
	logger := testutil.Logger(t).Named(t.Name())

	// Helper to wait for a specific update.
	waitForUpdate := func(event string, workspaceID uuid.UUID, expectedTransition, expectedStatus string) codersdk.WorkspaceBuildUpdate {
		t.Helper()
		for {
			select {
			case <-ctx.Done():
				require.FailNow(t, "timed out waiting for event", event)
				return codersdk.WorkspaceBuildUpdate{}
			case update, ok := <-updates:
				if !ok {
					require.FailNow(t, "updates channel closed", event)
					return codersdk.WorkspaceBuildUpdate{}
				}
				logger.Info(ctx, "received workspace build update",
					slog.F("event", event),