Skip to content

Commit b25e5dc

Browse files
spikecurtisspikecurtis
authored
chore: remove dbfake.WorkspaceBuild in favor of builder pattern (#10814)
I'd like to convert dbfake into a builder pattern to prevent a proliferation of XXXWithYYY methods. This is one step of the way by removing the Non-builder function.
1 parent b73d9d7 commit b25e5dc

File tree

5 files changed

+37
-46
lines changed

5 files changed

+37
-46
lines changed

‎cli/agent_test.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ func TestWorkspaceAgent(t *testing.T) {
6969
OrganizationID: user.OrganizationID,
7070
OwnerID: user.UserID,
7171
})
72-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
72+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
7373
Name: "somename",
7474
Type: "someinstance",
7575
Agents: []*proto.Agent{{
7676
Auth: &proto.Agent_InstanceId{
7777
InstanceId: instanceID,
7878
},
7979
}},
80-
})
80+
}).Do()
8181

8282
inv, _ := clitest.New(t, "agent", "--auth", "azure-instance-identity", "--agent-url", client.URL.String())
8383
inv = inv.WithContext(
@@ -112,15 +112,15 @@ func TestWorkspaceAgent(t *testing.T) {
112112
OrganizationID: user.OrganizationID,
113113
OwnerID: user.UserID,
114114
})
115-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
115+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
116116
Name: "somename",
117117
Type: "someinstance",
118118
Agents: []*proto.Agent{{
119119
Auth: &proto.Agent_InstanceId{
120120
InstanceId: instanceID,
121121
},
122122
}},
123-
})
123+
}).Do()
124124

125125
inv, _ := clitest.New(t, "agent", "--auth", "aws-instance-identity", "--agent-url", client.URL.String())
126126
inv = inv.WithContext(
@@ -156,15 +156,15 @@ func TestWorkspaceAgent(t *testing.T) {
156156
OrganizationID: owner.OrganizationID,
157157
OwnerID: memberUser.ID,
158158
})
159-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
159+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
160160
Name: "somename",
161161
Type: "someinstance",
162162
Agents: []*proto.Agent{{
163163
Auth: &proto.Agent_InstanceId{
164164
InstanceId: instanceID,
165165
},
166166
}},
167-
})
167+
}).Do()
168168
inv, cfg := clitest.New(t, "agent", "--auth", "google-instance-identity", "--agent-url", client.URL.String())
169169
clitest.SetupConfig(t, member, cfg)
170170

‎cli/configssh_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ func TestConfigSSH_Hostnames(t *testing.T) {
696696
OrganizationID: owner.OrganizationID,
697697
OwnerID: memberUser.ID,
698698
})
699-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, resources...)
699+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(resources...).Do()
700700
sshConfigFile := sshConfigFileName(t)
701701

702702
inv, root := clitest.New(t, "config-ssh", "--ssh-config-file", sshConfigFile)

‎cli/ssh_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ func TestSSH(t *testing.T) {
151151
pty.WriteLine("echo hell'o'")
152152
pty.ExpectMatchContext(ctx, "hello")
153153

154-
_ = dbfake.WorkspaceBuildBuilder(t, store, workspace).
154+
_ = dbfake.NewWorkspaceBuildBuilder(t, store, workspace).
155155
Seed(database.WorkspaceBuild{
156156
Transition: database.WorkspaceTransitionStop,
157157
BuildNumber: 2,
@@ -520,7 +520,7 @@ func TestSSH(t *testing.T) {
520520
err = session.Shell()
521521
require.NoError(t, err)
522522

523-
_ = dbfake.WorkspaceBuildBuilder(t, store, workspace).
523+
_ = dbfake.NewWorkspaceBuildBuilder(t, store, workspace).
524524
Seed(database.WorkspaceBuild{
525525
Transition: database.WorkspaceTransitionStop,
526526
BuildNumber: 2,

‎coderd/database/dbfake/dbfake.go

+10-19
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ func WorkspaceWithAgent(
5959
agents = m(agents)
6060
}
6161
ws := Workspace(t, db, seed)
62-
WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &sdkproto.Resource{
62+
NewWorkspaceBuildBuilder(t, db, ws).Resource(&sdkproto.Resource{
6363
Name: "example",
6464
Type: "aws_instance",
6565
Agents: agents,
66-
})
66+
}).Do()
6767
return ws, authToken
6868
}
6969

70-
type BuildBuilder struct {
70+
type WorkspaceBuildBuilder struct {
7171
t testing.TB
7272
db database.Store
7373
ps pubsub.Pubsub
@@ -76,29 +76,29 @@ type BuildBuilder struct {
7676
resources []*sdkproto.Resource
7777
}
7878

79-
func WorkspaceBuildBuilder(t testing.TB, db database.Store, ws database.Workspace) BuildBuilder {
80-
return BuildBuilder{t: t, db: db, ws: ws}
79+
func NewWorkspaceBuildBuilder(t testing.TB, db database.Store, ws database.Workspace) WorkspaceBuildBuilder {
80+
return WorkspaceBuildBuilder{t: t, db: db, ws: ws}
8181
}
8282

83-
func (b BuildBuilder) Pubsub(ps pubsub.Pubsub) BuildBuilder {
83+
func (b WorkspaceBuildBuilder) Pubsub(ps pubsub.Pubsub) WorkspaceBuildBuilder {
8484
//nolint: revive // returns modified struct
8585
b.ps = ps
8686
return b
8787
}
8888

89-
func (b BuildBuilder) Seed(seed database.WorkspaceBuild) BuildBuilder {
89+
func (b WorkspaceBuildBuilder) Seed(seed database.WorkspaceBuild) WorkspaceBuildBuilder {
9090
//nolint: revive // returns modified struct
9191
b.seed = seed
9292
return b
9393
}
9494

95-
func (b BuildBuilder) Resource(resource *sdkproto.Resource) BuildBuilder {
95+
func (b WorkspaceBuildBuilder) Resource(resource ...*sdkproto.Resource) WorkspaceBuildBuilder {
9696
//nolint: revive // returns modified struct
97-
b.resources = append(b.resources, resource)
97+
b.resources = append(b.resources, resource...)
9898
return b
9999
}
100100

101-
func (b BuildBuilder) Do() database.WorkspaceBuild {
101+
func (b WorkspaceBuildBuilder) Do() database.WorkspaceBuild {
102102
b.t.Helper()
103103
jobID := uuid.New()
104104
b.seed.ID = uuid.New()
@@ -177,15 +177,6 @@ func (b BuildBuilder) Do() database.WorkspaceBuild {
177177
return build
178178
}
179179

180-
// WorkspaceBuild inserts a build and a successful job into the database.
181-
func WorkspaceBuild(t testing.TB, db database.Store, ws database.Workspace, seed database.WorkspaceBuild, resources ...*sdkproto.Resource) database.WorkspaceBuild {
182-
b := WorkspaceBuildBuilder(t, db, ws).Seed(seed)
183-
for _, r := range resources {
184-
b = b.Resource(r)
185-
}
186-
return b.Do()
187-
}
188-
189180
// ProvisionerJobResources inserts a series of resources into a provisioner job.
190181
func ProvisionerJobResources(t testing.TB, db database.Store, job uuid.UUID, transition database.WorkspaceTransition, resources ...*sdkproto.Resource) {
191182
t.Helper()

‎coderd/workspaceagents_test.go

+18-18
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ func TestWorkspaceAgent(t *testing.T) {
5050
OrganizationID: user.OrganizationID,
5151
OwnerID: anotherUser.ID,
5252
})
53-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
53+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
5454
Name: "aws_instance",
5555
Agents: []*proto.Agent{{
5656
Id: uuid.NewString(),
5757
Directory: tmpDir,
5858
}},
59-
})
59+
}).Do()
6060
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
6161
defer cancel()
6262
workspace, err := anotherClient.Workspace(ctx, ws.ID)
@@ -75,13 +75,13 @@ func TestWorkspaceAgent(t *testing.T) {
7575
OrganizationID: user.OrganizationID,
7676
OwnerID: user.UserID,
7777
})
78-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
78+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
7979
Name: "aws_instance",
8080
Agents: []*proto.Agent{{
8181
Id: uuid.NewString(),
8282
Directory: tmpDir,
8383
}},
84-
})
84+
}).Do()
8585

8686
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium)
8787
defer cancel()
@@ -107,7 +107,7 @@ func TestWorkspaceAgent(t *testing.T) {
107107
OwnerID: user.UserID,
108108
OrganizationID: user.OrganizationID,
109109
})
110-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
110+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
111111
Name: "example",
112112
Type: "aws_instance",
113113
Agents: []*proto.Agent{{
@@ -119,7 +119,7 @@ func TestWorkspaceAgent(t *testing.T) {
119119
ConnectionTimeoutSeconds: 1,
120120
TroubleshootingUrl: wantTroubleshootingURL,
121121
}},
122-
})
122+
}).Do()
123123

124124
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium)
125125
defer cancel()
@@ -156,7 +156,7 @@ func TestWorkspaceAgent(t *testing.T) {
156156
PortForwardingHelper: true,
157157
SshHelper: true,
158158
}
159-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
159+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
160160
Agents: []*proto.Agent{
161161
{
162162
Directory: tmpDir,
@@ -166,7 +166,7 @@ func TestWorkspaceAgent(t *testing.T) {
166166
DisplayApps: apps,
167167
},
168168
},
169-
})
169+
}).Do()
170170

171171
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
172172
defer cancel()
@@ -196,7 +196,7 @@ func TestWorkspaceAgent(t *testing.T) {
196196
OrganizationID: user.OrganizationID,
197197
OwnerID: user.UserID,
198198
})
199-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
199+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
200200
Agents: []*proto.Agent{
201201
{
202202
Directory: tmpDir,
@@ -206,7 +206,7 @@ func TestWorkspaceAgent(t *testing.T) {
206206
DisplayApps: apps,
207207
},
208208
},
209-
})
209+
}).Do()
210210
workspace, err = client.Workspace(ctx, ws.ID)
211211
require.NoError(t, err)
212212

@@ -543,14 +543,14 @@ func TestWorkspaceAgentListeningPorts(t *testing.T) {
543543
OwnerID: user.UserID,
544544
})
545545
authToken := uuid.NewString()
546-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
546+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
547547
Agents: []*proto.Agent{{
548548
Apps: apps,
549549
Auth: &proto.Agent_Token{
550550
Token: authToken,
551551
},
552552
}},
553-
})
553+
}).Do()
554554
_ = agenttest.New(t, client.URL, authToken)
555555
resources := coderdtest.AwaitWorkspaceAgents(t, client, ws.ID)
556556
return client, uint16(coderdPort), resources[0].Agents[0].ID
@@ -776,7 +776,7 @@ func TestWorkspaceAgentAppHealth(t *testing.T) {
776776
OrganizationID: user.OrganizationID,
777777
OwnerID: user.UserID,
778778
})
779-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
779+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
780780
Name: "example",
781781
Type: "aws_instance",
782782
Agents: []*proto.Agent{{
@@ -786,7 +786,7 @@ func TestWorkspaceAgentAppHealth(t *testing.T) {
786786
},
787787
Apps: apps,
788788
}},
789-
})
789+
}).Do()
790790

791791
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
792792
defer cancel()
@@ -984,7 +984,7 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
984984
OrganizationID: user.OrganizationID,
985985
OwnerID: user.UserID,
986986
})
987-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
987+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
988988
Name: "example",
989989
Type: "aws_instance",
990990
Agents: []*proto.Agent{{
@@ -1016,7 +1016,7 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
10161016
Token: authToken,
10171017
},
10181018
}},
1019-
})
1019+
}).Do()
10201020
workspace, err := client.Workspace(context.Background(), ws.ID)
10211021
require.NoError(t, err)
10221022
for _, res := range workspace.LatestBuild.Resources {
@@ -1167,7 +1167,7 @@ func TestWorkspaceAgent_Metadata_CatchMemoryLeak(t *testing.T) {
11671167
OrganizationID: user.OrganizationID,
11681168
OwnerID: user.UserID,
11691169
})
1170-
dbfake.WorkspaceBuild(t, db, ws, database.WorkspaceBuild{}, &proto.Resource{
1170+
dbfake.NewWorkspaceBuildBuilder(t, db, ws).Resource(&proto.Resource{
11711171
Name: "example",
11721172
Type: "aws_instance",
11731173
Agents: []*proto.Agent{{
@@ -1192,7 +1192,7 @@ func TestWorkspaceAgent_Metadata_CatchMemoryLeak(t *testing.T) {
11921192
Token: authToken,
11931193
},
11941194
}},
1195-
})
1195+
}).Do()
11961196
workspace, err := client.Workspace(context.Background(), ws.ID)
11971197
require.NoError(t, err)
11981198
for _, res := range workspace.LatestBuild.Resources {

0 commit comments

Comments
 (0)