- Notifications
You must be signed in to change notification settings - Fork928
feat(coderd): return agent script timings#14923
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from1 commit
Commits
Show all changes
18 commits Select commitHold shift + click to select a range
1b62a39 feat(coderd): return agent script timings
BrunoQuaresma3daab59 Apply initial suggestions and improvements
BrunoQuaresma1c6671e Merge branch 'main' of https://github.com/coder/coder into bq/feat-ag…
BrunoQuaresma15ca638 Move timings to build and improve tests
BrunoQuaresmaddde7a3 Fix lint and gen
BrunoQuaresma5abc511 Fix @Router notation
BrunoQuaresmabcd8b04 Improve tests intention
BrunoQuaresmaf4c3331 Fix date-time format
BrunoQuaresma2852164 Add dbauthz test
BrunoQuaresmab70628a Fix dbauthz test
BrunoQuaresma9e09c64 Fix policy
BrunoQuaresma7786166 Fix test again
BrunoQuaresmaed4cbd0 Fix asserts
BrunoQuaresma920e41d Fix order
BrunoQuaresma65aeeea Wrap errors and set timeout for tests
BrunoQuaresmac7ae412 Add back the workspace timings endpoint
BrunoQuaresmaaaedd1c Fix unique build number
BrunoQuaresmaa846eb7 Wait long
BrunoQuaresmaFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
Improve tests intention
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
commitbcd8b04a06bdf4418bbccbec7b2ef0fe27d04897
There are no files selected for viewing
240 changes: 149 additions & 91 deletionscoderd/workspacebuilds_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1216,6 +1216,32 @@ func TestWorkspaceBuildTimings(t *testing.T) { | ||
| CreatedBy: owner.UserID, | ||
| }) | ||
| // Create a build to attach timings | ||
| makeBuild := func() database.WorkspaceBuild { | ||
| ws := dbgen.Workspace(t, db, database.Workspace{ | ||
| OwnerID: owner.UserID, | ||
| OrganizationID: owner.OrganizationID, | ||
| TemplateID: template.ID, | ||
| // Generate unique name for the workspace | ||
| Name: "test-workspace-" + uuid.New().String(), | ||
| }) | ||
| jobID := uuid.New() | ||
| job := dbgen.ProvisionerJob(t, db, pubsub, database.ProvisionerJob{ | ||
| ID: jobID, | ||
| OrganizationID: owner.OrganizationID, | ||
| Type: database.ProvisionerJobTypeWorkspaceBuild, | ||
| Tags: database.StringMap{jobID.String(): "true"}, | ||
| }) | ||
| return dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{ | ||
| WorkspaceID: ws.ID, | ||
| TemplateVersionID: version.ID, | ||
| BuildNumber: 1, | ||
| Transition: database.WorkspaceTransitionStart, | ||
| InitiatorID: owner.UserID, | ||
| JobID: job.ID, | ||
| }) | ||
| } | ||
| makeProvisionerTimings := func(build database.WorkspaceBuild, count int) []database.ProvisionerJobTiming { | ||
| // Use the database.ProvisionerJobTiming struct to mock timings data instead | ||
| // of directly creating database.InsertProvisionerJobTimingsParams. This | ||
| @@ -1250,8 +1276,86 @@ func TestWorkspaceBuildTimings(t *testing.T) { | ||
| return dbgen.ProvisionerJobTimings(t, db, insertParams) | ||
| } | ||
| makeAgentScriptTimings := func(script database.WorkspaceAgentScript, count int) []database.WorkspaceAgentScriptTiming { | ||
| newTimings := make([]database.InsertWorkspaceAgentScriptTimingsParams, count) | ||
| now := time.Now() | ||
| for i := range count { | ||
| startedAt := now.Add(-time.Hour + time.Duration(i)*time.Minute) | ||
| endedAt := startedAt.Add(time.Minute) | ||
| newTimings[i] = database.InsertWorkspaceAgentScriptTimingsParams{ | ||
| StartedAt: startedAt, | ||
| EndedAt: endedAt, | ||
| Stage: database.WorkspaceAgentScriptTimingStageStart, | ||
| ScriptID: script.ID, | ||
| ExitCode: 0, | ||
| Status: database.WorkspaceAgentScriptTimingStatusOk, | ||
| } | ||
| } | ||
| timings := make([]database.WorkspaceAgentScriptTiming, 0) | ||
| for _, newTiming := range newTimings { | ||
| timing := dbgen.WorkspaceAgentScriptTiming(t, db, newTiming) | ||
| timings = append(timings, timing) | ||
| } | ||
| return timings | ||
| } | ||
| t.Run("NonExistentBuild", func(t *testing.T) { | ||
| t.Parallel() | ||
| // When: fetching an inexistent build | ||
| buildID := uuid.New() | ||
| _, err := client.WorkspaceBuildTimings(context.Background(), buildID) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Instead of using There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 👍 | ||
| // Then: expect a not found error | ||
| require.Error(t, err) | ||
| require.Contains(t, err.Error(), "not found") | ||
| }) | ||
| t.Run("EmptyTimings", func(t *testing.T) { | ||
| t.Parallel() | ||
| // When: fetching timings for a build with no timings | ||
| build := makeBuild() | ||
| res, err := client.WorkspaceBuildTimings(context.Background(), build.ID) | ||
| // Then: return a response with empty timings | ||
| require.NoError(t, err) | ||
| require.Empty(t, res.ProvisionerTimings) | ||
| require.Empty(t, res.AgentScriptTimings) | ||
| }) | ||
| t.Run("ProvisionerTimings", func(t *testing.T) { | ||
| t.Parallel() | ||
| // When: fetching timings for a build with provisioner timings | ||
| build := makeBuild() | ||
| provisionerTimings := makeProvisionerTimings(build, 5) | ||
| // Then: return a response with the expected timings | ||
| res, err := client.WorkspaceBuildTimings(context.Background(), build.ID) | ||
| require.NoError(t, err) | ||
| require.Len(t, res.ProvisionerTimings, 5) | ||
| for i := range res.ProvisionerTimings { | ||
| timingRes := res.ProvisionerTimings[i] | ||
| genTiming := provisionerTimings[i] | ||
| require.Equal(t, genTiming.Resource, timingRes.Resource) | ||
| require.Equal(t, genTiming.Action, timingRes.Action) | ||
| require.Equal(t, string(genTiming.Stage), timingRes.Stage) | ||
| require.Equal(t, genTiming.JobID.String(), timingRes.JobID.String()) | ||
| require.Equal(t, genTiming.Source, timingRes.Source) | ||
| require.Equal(t, genTiming.StartedAt.UnixMilli(), timingRes.StartedAt.UnixMilli()) | ||
| require.Equal(t, genTiming.EndedAt.UnixMilli(), timingRes.EndedAt.UnixMilli()) | ||
| } | ||
| }) | ||
| t.Run("AgentScriptTimings", func(t *testing.T) { | ||
| t.Parallel() | ||
| // When: fetching timings for a build with agent script timings | ||
| build := makeBuild() | ||
| resource := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{ | ||
| JobID: build.JobID, | ||
| }) | ||
| @@ -1276,101 +1380,55 @@ func TestWorkspaceBuildTimings(t *testing.T) { | ||
| uuid.New(), | ||
| }, | ||
| }) | ||
| agentScriptTimings := makeAgentScriptTimings(scripts[0], 5) | ||
| // Then: return a response with the expected timings | ||
| res, err:=client.WorkspaceBuildTimings(context.Background(), build.ID) | ||
| require.NoError(t, err) | ||
| require.Len(t, res.AgentScriptTimings, 5) | ||
| for i := range res.AgentScriptTimings{ | ||
| timingRes := res.AgentScriptTimings[i] | ||
| genTiming := agentScriptTimings[i] | ||
| require.Equal(t, genTiming.ExitCode, timingRes.ExitCode) | ||
| require.Equal(t, string(genTiming.Status), timingRes.Status) | ||
| require.Equal(t, string(genTiming.Stage), timingRes.Stage) | ||
| require.Equal(t, genTiming.StartedAt.UnixMilli(), timingRes.StartedAt.UnixMilli()) | ||
| require.Equal(t, genTiming.EndedAt.UnixMilli(), timingRes.EndedAt.UnixMilli()) | ||
| } | ||
| }) | ||
| t.Run("NoAgentScripts", func(t *testing.T) { | ||
| t.Parallel() | ||
| // When: fetching timings for a build with no agent scripts | ||
| build := makeBuild() | ||
| resource := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{ | ||
| JobID: build.JobID, | ||
| }) | ||
| dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{ | ||
| ResourceID: resource.ID, | ||
| }) | ||
| // Then: return a response with empty agent script timings | ||
| res, err := client.WorkspaceBuildTimings(context.Background(), build.ID) | ||
| require.NoError(t, err) | ||
| require.Empty(t, res.AgentScriptTimings) | ||
| }) | ||
| // Some workspaces might not have agents. It is improbable, but possible. | ||
| t.Run("NoAgents", func(t *testing.T) { | ||
| t.Parallel() | ||
| // When: fetching timings for a build with no agents | ||
| build := makeBuild() | ||
| dbgen.WorkspaceResource(t, db, database.WorkspaceResource{ | ||
| JobID: build.JobID, | ||
| }) | ||
| // Then: return a response with empty agent script timings | ||
| res, err := client.WorkspaceBuildTimings(context.Background(), build.ID) | ||
| require.NoError(t, err) | ||
| require.Empty(t, res.AgentScriptTimings) | ||
| }) | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.