Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(coderd): improve workspace tests #15069

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.

Sign up for GitHub

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 5 commits into from
Oct 15, 2024
Merged

fix(coderd): improve workspace tests #15069

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64be8c9
fix: coderd workspace tests
defelmnq Oct 14, 2024
ea2a20c
fix: coderd workspace tests
defelmnq Oct 14, 2024
74d5e9f
fix: coderd workspace tests
defelmnq Oct 14, 2024
583d1a3
fix: coderd workspace tests
defelmnq Oct 14, 2024
deeb101
fix: coderd workspace tests
defelmnq Oct 15, 2024
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
fix: coderd workspace tests
  • Loading branch information
@defelmnq
defelmnq committed Oct 14, 2024
commit 583d1a3bd17a135bb5139f77414e509c70ef1a4c
372 changes: 187 additions & 185 deletions coderd/workspacebuilds_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
"github.com/coder/coder/v2/coderd/coderdtest/oidctest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
"github.com/coder/coder/v2/coderd/database/dbgen"
"github.com/coder/coder/v2/coderd/database/dbtestutil"
"github.com/coder/coder/v2/coderd/database/dbtime"
"github.com/coder/coder/v2/coderd/externalauth"
"github.com/coder/coder/v2/coderd/rbac"
Expand Down Expand Up @@ -1181,188 +1183,188 @@
})
}

// func TestWorkspaceBuildTimings(t *testing.T) {
// // t.Parallel()

// // Setup the test environment with a template and version
// db, pubsub := dbtestutil.NewDB(t)
// client := coderdtest.New(t, &coderdtest.Options{
// Database: db,
// Pubsub: pubsub,
// })
// owner := coderdtest.CreateFirstUser(t, client)
// file := dbgen.File(t, db, database.File{
// CreatedBy: owner.UserID,
// })
// versionJob := dbgen.ProvisionerJob(t, db, pubsub, database.ProvisionerJob{
// OrganizationID: owner.OrganizationID,
// InitiatorID: owner.UserID,
// FileID: file.ID,
// Tags: database.StringMap{
// "custom": "true",
// },
// })
// version := dbgen.TemplateVersion(t, db, database.TemplateVersion{
// OrganizationID: owner.OrganizationID,
// JobID: versionJob.ID,
// CreatedBy: owner.UserID,
// })
// template := dbgen.Template(t, db, database.Template{
// OrganizationID: owner.OrganizationID,
// ActiveVersionID: version.ID,
// CreatedBy: owner.UserID,
// })
// ws := dbgen.Workspace(t, db, database.Workspace{
// OwnerID: owner.UserID,
// OrganizationID: owner.OrganizationID,
// TemplateID: template.ID,
// })

// // Create a build to attach timings
// var buildNumber int32
// makeBuild := func() database.WorkspaceBuild {
// buildNumber++
// jobID := uuid.New()
// job := dbgen.ProvisionerJob(t, db, pubsub, database.ProvisionerJob{
// ID: jobID,
// OrganizationID: owner.OrganizationID,
// Tags: database.StringMap{jobID.String(): "true"},
// })
// return dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{
// WorkspaceID: ws.ID,
// TemplateVersionID: version.ID,
// InitiatorID: owner.UserID,
// JobID: job.ID,
// BuildNumber: buildNumber,
// })
// }

// t.Run("NonExistentBuild", func(t *testing.T) {
// t.Parallel()

// // When: fetching an inexistent build
// buildID := uuid.New()
// ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
// t.Cleanup(cancel)
// _, err := client.WorkspaceBuildTimings(ctx, buildID)

// // 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()
// ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
// t.Cleanup(cancel)
// res, err := client.WorkspaceBuildTimings(ctx, 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 := dbgen.ProvisionerJobTimings(t, db, build, 5)

// // Then: return a response with the expected timings
// ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
// t.Cleanup(cancel)
// res, err := client.WorkspaceBuildTimings(ctx, 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,
// })
// agent := dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{
// ResourceID: resource.ID,
// })
// script := dbgen.WorkspaceAgentScript(t, db, database.WorkspaceAgentScript{
// WorkspaceAgentID: agent.ID,
// })
// agentScriptTimings := dbgen.WorkspaceAgentScriptTimings(t, db, script, 5)

// // Then: return a response with the expected timings
// ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
// t.Cleanup(cancel)
// res, err := client.WorkspaceBuildTimings(ctx, 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
// ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
// t.Cleanup(cancel)
// res, err := client.WorkspaceBuildTimings(ctx, 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
// // trigger build
// ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
// t.Cleanup(cancel)
// res, err := client.WorkspaceBuildTimings(ctx, build.ID)
// require.NoError(t, err)
// require.Empty(t, res.AgentScriptTimings)
// })
// }
func TestWorkspaceBuildTimings(t *testing.T) {

Check failure on line 1186 in coderd/workspacebuilds_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestWorkspaceBuildTimings missing the call to method parallel (paralleltest)
// t.Parallel()

// Setup the test environment with a template and version
db, pubsub := dbtestutil.NewDB(t)
client := coderdtest.New(t, &coderdtest.Options{
Database: db,
Pubsub: pubsub,
})
owner := coderdtest.CreateFirstUser(t, client)
file := dbgen.File(t, db, database.File{
CreatedBy: owner.UserID,
})
versionJob := dbgen.ProvisionerJob(t, db, pubsub, database.ProvisionerJob{
OrganizationID: owner.OrganizationID,
InitiatorID: owner.UserID,
FileID: file.ID,
Tags: database.StringMap{
"custom": "true",
},
})
version := dbgen.TemplateVersion(t, db, database.TemplateVersion{
OrganizationID: owner.OrganizationID,
JobID: versionJob.ID,
CreatedBy: owner.UserID,
})
template := dbgen.Template(t, db, database.Template{
OrganizationID: owner.OrganizationID,
ActiveVersionID: version.ID,
CreatedBy: owner.UserID,
})
ws := dbgen.Workspace(t, db, database.Workspace{
OwnerID: owner.UserID,
OrganizationID: owner.OrganizationID,
TemplateID: template.ID,
})

// Create a build to attach timings
var buildNumber int32
makeBuild := func() database.WorkspaceBuild {
buildNumber++
jobID := uuid.New()
job := dbgen.ProvisionerJob(t, db, pubsub, database.ProvisionerJob{
ID: jobID,
OrganizationID: owner.OrganizationID,
Tags: database.StringMap{jobID.String(): "true"},
})
return dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{
WorkspaceID: ws.ID,
TemplateVersionID: version.ID,
InitiatorID: owner.UserID,
JobID: job.ID,
BuildNumber: buildNumber,
})
}

t.Run("NonExistentBuild", func(t *testing.T) {

Check failure on line 1242 in coderd/workspacebuilds_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestWorkspaceBuildTimings missing the call to method parallel in the test run (paralleltest)
// t.Parallel()

// When: fetching an inexistent build
buildID := uuid.New()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
_, err := client.WorkspaceBuildTimings(ctx, buildID)

// Then: expect a not found error
require.Error(t, err)
require.Contains(t, err.Error(), "not found")
})

t.Run("EmptyTimings", func(t *testing.T) {

Check failure on line 1256 in coderd/workspacebuilds_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestWorkspaceBuildTimings missing the call to method parallel in the test run (paralleltest)
// t.Parallel()

// When: fetching timings for a build with no timings
build := makeBuild()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
res, err := client.WorkspaceBuildTimings(ctx, 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) {

Check failure on line 1271 in coderd/workspacebuilds_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestWorkspaceBuildTimings missing the call to method parallel in the test run (paralleltest)
// t.Parallel()

// When: fetching timings for a build with provisioner timings
build := makeBuild()
provisionerTimings := dbgen.ProvisionerJobTimings(t, db, build, 5)

// Then: return a response with the expected timings
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
res, err := client.WorkspaceBuildTimings(ctx, 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) {

Check failure on line 1298 in coderd/workspacebuilds_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestWorkspaceBuildTimings missing the call to method parallel in the test run (paralleltest)
// t.Parallel()

// When: fetching timings for a build with agent script timings
build := makeBuild()
resource := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{
JobID: build.JobID,
})
agent := dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{
ResourceID: resource.ID,
})
script := dbgen.WorkspaceAgentScript(t, db, database.WorkspaceAgentScript{
WorkspaceAgentID: agent.ID,
})
agentScriptTimings := dbgen.WorkspaceAgentScriptTimings(t, db, script, 5)

// Then: return a response with the expected timings
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
res, err := client.WorkspaceBuildTimings(ctx, 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) {

Check failure on line 1332 in coderd/workspacebuilds_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestWorkspaceBuildTimings missing the call to method parallel in the test run (paralleltest)
// 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
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
res, err := client.WorkspaceBuildTimings(ctx, 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) {

Check failure on line 1353 in coderd/workspacebuilds_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestWorkspaceBuildTimings missing the call to method parallel in the test run (paralleltest)
// 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
// trigger build
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
t.Cleanup(cancel)
res, err := client.WorkspaceBuildTimings(ctx, build.ID)
require.NoError(t, err)
require.Empty(t, res.AgentScriptTimings)
})
}
Loading