Method WaitFor

coderd/coderdtest/coderdtest.go:1343–1386

WaitFor waits for the given criteria and fails the test if they are not met before the waiter's context is canceled.

(criteria ...WaitForAgentFn)

// WaitFor waits for the given criteria and fails the test if they are not met before the
// waiter's context is canceled.
func (w WorkspaceAgentWaiter) WaitFor(criteria ...WaitForAgentFn) {
	w.t.Helper()

	agentNamesMap := make(map[string]struct{}, len(w.agentNames))
	for _, name := range w.agentNames {
		agentNamesMap[name] = struct{}{}
	}

	ctx := w.ctx
	if w.ctx == nil {
		ctx = testutil.Context(w.t, testutil.WaitLong)
	}

	w.t.Logf("waiting for workspace agents (workspace %s)", w.workspaceID)
	testutil.Eventually(ctx, w.t, func(ctx context.Context) bool {
		var err error
		workspace, err := w.client.Workspace(ctx, w.workspaceID)
		if err != nil {
			return false
		}
		if workspace.LatestBuild.Job.CompletedAt == nil {
			return false
		}
		if workspace.LatestBuild.Job.CompletedAt.IsZero() {
			return false
		}

		for _, resource := range workspace.LatestBuild.Resources {
			for _, agent := range resource.Agents {
				if len(w.agentNames) > 0 {
					if _, ok := agentNamesMap[agent.Name]; !ok {
						continue
					}
				}
				for _, criterium := range criteria {
					if !criterium(agent) {
						return false
					}
				}
			}
		}
		return true
	}, testutil.IntervalFast)
}

// Wait waits for the agent(s) to connect and fails the test if they do not connect before the
// waiter's context is canceled.