Skip to content

fix: fix TestWorkspaceAutobuild/InactiveTTLOK flake #10965

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 1, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
check for both audit logs instead
  • Loading branch information
sreya committed Nov 30, 2023
commit 26fffdbff86c64e0ecb583e07fe483e19f45678f
45 changes: 28 additions & 17 deletions enterprise/coderd/workspaces_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -274,10 +274,8 @@ func TestWorkspaceAutobuild(t *testing.T) {
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)

ws := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)

coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, ws.LatestBuild.ID)
// Transition it to the stop state so we don't have to worry
// about the provisioner generating a workspace_build audit log.
ws = coderdtest.MustTransitionWorkspace(t, client, ws.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionStop)

// Reset the audit log so we can verify a log is generated.
auditRecorder.ResetLogs()
Expand All @@ -289,29 +287,42 @@ func TestWorkspaceAutobuild(t *testing.T) {
// failure TTL.
require.Len(t, stats.Transitions, 1)
require.Equal(t, stats.Transitions[ws.ID], database.WorkspaceTransitionStop)
require.Len(t, auditRecorder.AuditLogs(), 1)

auditLog := auditRecorder.AuditLogs()[0]
require.Equal(t, auditLog.Action, database.AuditActionWrite)

var fields audit.AdditionalFields
err := json.Unmarshal(auditLog.AdditionalFields, &fields)
require.NoError(t, err)
require.Equal(t, ws.Name, fields.WorkspaceName)
require.Equal(t, database.BuildReasonAutolock, fields.BuildReason)

// The workspace should be dormant.
ws = coderdtest.MustWorkspace(t, client, ws.ID)
require.NotNil(t, ws.DormantAt)
lastUsedAt := ws.LastUsedAt

err = client.UpdateWorkspaceDormancy(ctx, ws.ID, codersdk.UpdateWorkspaceDormancy{Dormant: false})
coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, ws.LatestBuild.ID)
// We should get 2 audit logs, one for stopping the workspace, and one for
// making it dormant.
alogs := auditRecorder.AuditLogs()
require.Len(t, alogs, 2)

for _, alog := range alogs {
require.Equal(t, int32(http.StatusOK), alog.StatusCode)

switch alog.Action {
case database.AuditActionWrite:
require.Equal(t, database.ResourceTypeWorkspace, alog.ResourceType)
case database.AuditActionStop:
var fields audit.AdditionalFields
err := json.Unmarshal(alog.AdditionalFields, &fields)
require.NoError(t, err)
require.Equal(t, ws.Name, fields.WorkspaceName)
require.Equal(t, database.BuildReasonAutolock, fields.BuildReason)

default:
t.Fatalf("unexpected audit log (%+v)", alog)
}
}

dormantLastUsedAt := ws.LastUsedAt
err := client.UpdateWorkspaceDormancy(ctx, ws.ID, codersdk.UpdateWorkspaceDormancy{Dormant: false})
require.NoError(t, err)

// Assert that we updated our last_used_at so that we don't immediately
// retrigger another lock action.
ws = coderdtest.MustWorkspace(t, client, ws.ID)
require.True(t, ws.LastUsedAt.After(lastUsedAt))
require.True(t, ws.LastUsedAt.After(dormantLastUsedAt))
})

// This test serves as a regression prevention for generating
Expand Down