Skip to content

chore: remove dbfake.WorkspaceBuild in favor of builder pattern #10814

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 1 commit into from
Nov 22, 2023
Merged

chore: remove dbfake.WorkspaceBuild in favor of builder pattern #10814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions cli/agent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,15 @@ func TestWorkspaceAgent(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: user.UserID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "somename",
Type: "someinstance",
Agents: []*proto.Agent{{
Auth: &proto.Agent_InstanceId{
InstanceId: instanceID,
},
}},
})
}).Do()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestion, perhaps we could rename this s/Do/Build, since a Builder Build's. I mean, the BuildBuilder is a bit unfortunate 😅, so I know, right, suggesting to add one more. But typically this naming goes Doer Do(), Builder Build(), etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I wanted to avoid Build() as it might be confusing with WorkspaceBuild.

Eventually I want the whole package to use the builder pattern and we can drop Builder from the function names. So you be like

r := dbfake.Workspace(t, db).Do()


inv, _ := clitest.New(t, "agent", "--auth", "azure-instance-identity", "--agent-url", client.URL.String())
inv = inv.WithContext(
Expand Down Expand Up @@ -112,15 +112,15 @@ func TestWorkspaceAgent(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: user.UserID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "somename",
Type: "someinstance",
Agents: []*proto.Agent{{
Auth: &proto.Agent_InstanceId{
InstanceId: instanceID,
},
}},
})
}).Do()

inv, _ := clitest.New(t, "agent", "--auth", "aws-instance-identity", "--agent-url", client.URL.String())
inv = inv.WithContext(
Expand Down Expand Up @@ -156,15 +156,15 @@ func TestWorkspaceAgent(t *testing.T) {
OrganizationID: owner.OrganizationID,
OwnerID: memberUser.ID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "somename",
Type: "someinstance",
Agents: []*proto.Agent{{
Auth: &proto.Agent_InstanceId{
InstanceId: instanceID,
},
}},
})
}).Do()
inv, cfg := clitest.New(t, "agent", "--auth", "google-instance-identity", "--agent-url", client.URL.String())
clitest.SetupConfig(t, member, cfg)

Expand Down
2 changes: 1 addition & 1 deletion cli/configssh_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -696,7 +696,7 @@ func TestConfigSSH_Hostnames(t *testing.T) {
OrganizationID: owner.OrganizationID,
OwnerID: memberUser.ID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, resources...)
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(resources...).Do()
sshConfigFile := sshConfigFileName(t)

inv, root := clitest.New(t, "config-ssh", "--ssh-config-file", sshConfigFile)
Expand Down
4 changes: 2 additions & 2 deletions cli/ssh_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ func TestSSH(t *testing.T) {
pty.WriteLine("echo hell'o'")
pty.ExpectMatchContext(ctx, "hello")

_ = dbfake.WorkspaceBuildBuilder(t, store, workspace).
_ = dbfake.NewWorkspaceBuildBuilder(t, store, workspace).
Seed(database.WorkspaceBuild{
Transition: database.WorkspaceTransitionStop,
BuildNumber: 2,
Expand Down Expand Up @@ -520,7 +520,7 @@ func TestSSH(t *testing.T) {
err = session.Shell()
require.NoError(t, err)

_ = dbfake.WorkspaceBuildBuilder(t, store, workspace).
_ = dbfake.NewWorkspaceBuildBuilder(t, store, workspace).
Seed(database.WorkspaceBuild{
Transition: database.WorkspaceTransitionStop,
BuildNumber: 2,
Expand Down
29 changes: 10 additions & 19 deletions coderd/database/dbfake/dbfake.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@ func WorkspaceWithAgent(
agents = m(agents)
}
ws := Workspace(t, db, seed)
WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &sdkproto.Resource{
NewWorkspaceBuildBuilder(t, db, ws).Resource(&sdkproto.Resource{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we do NewWorkspaceBuilder instead? Then the Build function would implicitly do what we expect as well.

Copy link
Member

@mafredri mafredri Nov 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered the same, then I wondered what we would call a "Builder" for a workspace, if we ever need one.. 😅

Edit: On second thought, perhaps you were suggesting something a bit different. Would you have one "Builder" for both workspace and workspacebuilds?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pattern I'm planning to follow is NewXxxxxBuilder() for the function that creates a builder (where Xxxxx is the resource type), so NewWorkspaceBuildBuilder() is the builder for a WorkspaceBuild.

I'd eventually like to convert everything in dbfake to a builder pattern, and then I think we could potentially drop the Builder suffix and the New prefix for the sake of readability. But while I'm changing things over, it's useful to be able tell what is and isn't a builder.

Name: "example",
Type: "aws_instance",
Agents: agents,
})
}).Do()
return ws, authToken
}

type BuildBuilder struct {
type WorkspaceBuildBuilder struct {
t testing.TB
db database.Store
ps pubsub.Pubsub
Expand All @@ -76,29 +76,29 @@ type BuildBuilder struct {
resources []*sdkproto.Resource
}

func WorkspaceBuildBuilder(t testing.TB, db database.Store, ws database.Workspace) BuildBuilder {
return BuildBuilder{t: t, db: db, ws: ws}
func NewWorkspaceBuildBuilder(t testing.TB, db database.Store, ws database.Workspace) WorkspaceBuildBuilder {
return WorkspaceBuildBuilder{t: t, db: db, ws: ws}
}

func (b BuildBuilder) Pubsub(ps pubsub.Pubsub) BuildBuilder {
func (b WorkspaceBuildBuilder) Pubsub(ps pubsub.Pubsub) WorkspaceBuildBuilder {
//nolint: revive // returns modified struct
b.ps = ps
return b
}

func (b BuildBuilder) Seed(seed database.WorkspaceBuild) BuildBuilder {
func (b WorkspaceBuildBuilder) Seed(seed database.WorkspaceBuild) WorkspaceBuildBuilder {
//nolint: revive // returns modified struct
b.seed = seed
return b
}

func (b BuildBuilder) Resource(resource *sdkproto.Resource) BuildBuilder {
func (b WorkspaceBuildBuilder) Resource(resource ...*sdkproto.Resource) WorkspaceBuildBuilder {
//nolint: revive // returns modified struct
b.resources = append(b.resources, resource)
b.resources = append(b.resources, resource...)
return b
}

func (b BuildBuilder) Do() database.WorkspaceBuild {
func (b WorkspaceBuildBuilder) Do() database.WorkspaceBuild {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity: wasn't that always Build()?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's usually Build() but I'm attempting to avoid a clash with WorkspaceBuild. I don't mind too much either way.

b.t.Helper()
jobID := uuid.New()
b.seed.ID = uuid.New()
Expand Down Expand Up @@ -177,15 +177,6 @@ func (b BuildBuilder) Do() database.WorkspaceBuild {
return build
}

// WorkspaceBuild inserts a build and a successful job into the database.
func WorkspaceBuild(t testing.TB, db database.Store, ws database.Workspace, seed database.WorkspaceBuild, resources ...*sdkproto.Resource) database.WorkspaceBuild {
b := WorkspaceBuildBuilder(t, db, ws).Seed(seed)
for _, r := range resources {
b = b.Resource(r)
}
return b.Do()
}

// ProvisionerJobResources inserts a series of resources into a provisioner job.
func ProvisionerJobResources(t testing.TB, db database.Store, job uuid.UUID, transition database.WorkspaceTransition, resources ...*sdkproto.Resource) {
t.Helper()
Expand Down
36 changes: 18 additions & 18 deletions coderd/workspaceagents_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ func TestWorkspaceAgent(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: anotherUser.ID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "aws_instance",
Agents: []*proto.Agent{{
Id: uuid.NewString(),
Directory: tmpDir,
}},
})
}).Do()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()
workspace, err := anotherClient.Workspace(ctx, ws.ID)
Expand All @@ -75,13 +75,13 @@ func TestWorkspaceAgent(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: user.UserID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "aws_instance",
Agents: []*proto.Agent{{
Id: uuid.NewString(),
Directory: tmpDir,
}},
})
}).Do()

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium)
defer cancel()
Expand All @@ -107,7 +107,7 @@ func TestWorkspaceAgent(t *testing.T) {
OwnerID: user.UserID,
OrganizationID: user.OrganizationID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "example",
Type: "aws_instance",
Agents: []*proto.Agent{{
Expand All @@ -119,7 +119,7 @@ func TestWorkspaceAgent(t *testing.T) {
ConnectionTimeoutSeconds: 1,
TroubleshootingUrl: wantTroubleshootingURL,
}},
})
}).Do()

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium)
defer cancel()
Expand Down Expand Up @@ -156,7 +156,7 @@ func TestWorkspaceAgent(t *testing.T) {
PortForwardingHelper: true,
SshHelper: true,
}
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Agents: []*proto.Agent{
{
Directory: tmpDir,
Expand All @@ -166,7 +166,7 @@ func TestWorkspaceAgent(t *testing.T) {
DisplayApps: apps,
},
},
})
}).Do()

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()
Expand Down Expand Up @@ -196,7 +196,7 @@ func TestWorkspaceAgent(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: user.UserID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Agents: []*proto.Agent{
{
Directory: tmpDir,
Expand All @@ -206,7 +206,7 @@ func TestWorkspaceAgent(t *testing.T) {
DisplayApps: apps,
},
},
})
}).Do()
workspace, err = client.Workspace(ctx, ws.ID)
require.NoError(t, err)

Expand Down Expand Up @@ -543,14 +543,14 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
OwnerID: user.UserID,
})
authToken := uuid.NewString()
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Agents: []*proto.Agent{{
Apps: apps,
Auth: &proto.Agent_Token{
Token: authToken,
},
}},
})
}).Do()
_ = agenttest.New(t, client.URL, authToken)
resources := coderdtest.AwaitWorkspaceAgents(t, client, ws.ID)
return client, uint16(coderdPort), resources[0].Agents[0].ID
Expand Down Expand Up @@ -776,7 +776,7 @@ func TestWorkspaceAgentAppHealth(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: user.UserID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "example",
Type: "aws_instance",
Agents: []*proto.Agent{{
Expand All @@ -786,7 +786,7 @@ func TestWorkspaceAgentAppHealth(t *testing.T) {
},
Apps: apps,
}},
})
}).Do()

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()
Expand Down Expand Up @@ -958,7 +958,7 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: user.UserID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "example",
Type: "aws_instance",
Agents: []*proto.Agent{{
Expand Down Expand Up @@ -990,7 +990,7 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
Token: authToken,
},
}},
})
}).Do()
workspace, err := client.Workspace(context.Background(), ws.ID)
require.NoError(t, err)
for _, res := range workspace.LatestBuild.Resources {
Expand Down Expand Up @@ -1141,7 +1141,7 @@ func TestWorkspaceAgent_Metadata_CatchMemoryLeak(t *testing.T) {
OrganizationID: user.OrganizationID,
OwnerID: user.UserID,
})
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
Name: "example",
Type: "aws_instance",
Agents: []*proto.Agent{{
Expand All @@ -1166,7 +1166,7 @@ func TestWorkspaceAgent_Metadata_CatchMemoryLeak(t *testing.T) {
Token: authToken,
},
}},
})
}).Do()
workspace, err := client.Workspace(context.Background(), ws.ID)
require.NoError(t, err)
for _, res := range workspace.LatestBuild.Resources {
Expand Down