Skip to content

fix: Fix cleanup in test helpers, prefer defer in tests #3113

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 7 commits into from
Jul 25, 2022
Merged

fix: Fix cleanup in test helpers, prefer defer in tests #3113

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9a5db33
fix: Change uses of t.Cleanup -> defer in test bodies
mafredri Jul 22, 2022
628d9f2
fix: Ensure t.Cleanup is not aborted by require
mafredri Jul 22, 2022
2334d8a
chore: Add helper annotations
mafredri Jul 22, 2022
d263af2
fix: Revert bad change
mafredri Jul 22, 2022
7b356b3
fix: Bad placement
mafredri Jul 22, 2022
f245f64
fix: Run ctx cancel first in t.Cleanup
mafredri Jul 22, 2022
b624871
fix: Revert bad cleanup changes
mafredri Jul 22, 2022
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
Next Next commit
fix: Change uses of t.Cleanup -> defer in test bodies 
Mixing t.Cleanup and defer can lead to unexpected order of execution.
  • Loading branch information
@mafredri
mafredri committed Jul 25, 2022
commit 9a5db339d1af1025b194dee92a9cc3f9ceebb886
8 changes: 4 additions & 4 deletions cli/configssh_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,19 +109,19 @@ func TestConfigSSH(t *testing.T) {
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
Logger: slogtest.Make(t, nil),
})
t.Cleanup(func() {
defer func() {
_ = agentCloser.Close()
})
}()
resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)
agentConn, err := client.DialWorkspaceAgent(context.Background(), resources[0].Agents[0].ID, nil)
require.NoError(t, err)
defer agentConn.Close()

listener, err := net.Listen("tcp", "127.0.0.1:0")
require.NoError(t, err)
t.Cleanup(func() {
defer func() {
_ = listener.Close()
})
}()
go func() {
for {
conn, err := listener.Accept()
Expand Down
12 changes: 6 additions & 6 deletions cli/logout_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,19 +152,19 @@ func TestLogout(t *testing.T) {
err = os.Chmod(string(config), 0500)
require.NoError(t, err)
}
t.Cleanup(func() {
defer func() {
if runtime.GOOS == "windows" {
// Closing the opened files for cleanup.
err = urlFile.Close()
require.NoError(t, err)
assert.NoError(t, err)
Copy link
Member Author

Choose a reason for hiding this comment

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

Assert here, to avoid interrupting Close below.

Copy link
Member

Choose a reason for hiding this comment

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

Should comment this in the file so it doesn't get reverted

Copy link
Member Author

Choose a reason for hiding this comment

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

I kind of agree, but I'm less worried about this old code changing than new (incorrect) code going in. This is something everyone using require must be very aware of (it halts execution flow).

err = sessionFile.Close()
require.NoError(t, err)
assert.NoError(t, err)
} else {
// Setting the permissions back for cleanup.
err = os.Chmod(string(config), 0700)
require.NoError(t, err)
err = os.Chmod(string(config), 0o700)
assert.NoError(t, err)
}
})
}()

logoutChan := make(chan struct{})
logout, _ := clitest.New(t, "logout", "--global-config", string(config))
Expand Down
9 changes: 4 additions & 5 deletions cli/portforward_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,11 +394,7 @@ func runAgent(t *testing.T, client *codersdk.Client, userID uuid.UUID) ([]coders
clitest.SetupConfig(t, client, root)
errC := make(chan error)
agentCtx, agentCancel := context.WithCancel(ctx)
t.Cleanup(func() {
agentCancel()
err := <-errC
require.NoError(t, err)
})
defer agentCancel()
go func() {
errC <- cmd.ExecuteContext(agentCtx)
}()
Expand All @@ -407,6 +403,9 @@ func runAgent(t *testing.T, client *codersdk.Client, userID uuid.UUID) ([]coders
resources, err := client.WorkspaceResourcesByBuild(context.Background(), workspace.LatestBuild.ID)
require.NoError(t, err)

err := <-errC
require.NoError(t, err)

return resources, workspace
}

Expand Down
2 changes: 1 addition & 1 deletion cli/server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ func TestServer(t *testing.T) {
snapshot <- ss
})
server := httptest.NewServer(r)
t.Cleanup(server.Close)
defer server.Close()

root, _ := clitest.New(t, "server", "--in-memory", "--address", ":0", "--telemetry", "--telemetry-url", server.URL)
errC := make(chan error)
Expand Down
2 changes: 1 addition & 1 deletion coderd/provisionerjobs_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func TestProvisionerJobLogs_Unit(t *testing.T) {
}
api := New(&opts)
server := httptest.NewServer(api.Handler)
t.Cleanup(server.Close)
defer server.Close()
userID := uuid.New()
keyID, keySecret, err := generateAPIKeyIDSecret()
require.NoError(t, err)
Expand Down
4 changes: 2 additions & 2 deletions coderd/provisionerjobs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func TestProvisionerJobLogs(t *testing.T) {
coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)

ctx, cancelFunc := context.WithCancel(context.Background())
t.Cleanup(cancelFunc)
defer cancelFunc()
logs, err := client.WorkspaceBuildLogsAfter(ctx, workspace.LatestBuild.ID, before)
require.NoError(t, err)
for {
Expand Down Expand Up @@ -77,7 +77,7 @@ func TestProvisionerJobLogs(t *testing.T) {
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
before := database.Now()
ctx, cancelFunc := context.WithCancel(context.Background())
t.Cleanup(cancelFunc)
defer cancelFunc()
logs, err := client.WorkspaceBuildLogsAfter(ctx, workspace.LatestBuild.ID, before)
require.NoError(t, err)
for {
Expand Down
2 changes: 1 addition & 1 deletion coderd/templateversions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ func TestTemplateVersionLogs(t *testing.T) {
}},
})
ctx, cancelFunc := context.WithCancel(context.Background())
t.Cleanup(cancelFunc)
defer cancelFunc()
logs, err := client.TemplateVersionLogsAfter(ctx, version.ID, before)
require.NoError(t, err)
for {
Expand Down
20 changes: 10 additions & 10 deletions coderd/workspaceagents_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,15 @@ func TestWorkspaceAgentListen(t *testing.T) {
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
Logger: slogtest.Make(t, nil).Named("agent").Leveled(slog.LevelDebug),
})
t.Cleanup(func() {
defer func() {
_ = agentCloser.Close()
})
}()
resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)
conn, err := client.DialWorkspaceAgent(context.Background(), resources[0].Agents[0].ID, nil)
require.NoError(t, err)
t.Cleanup(func() {
defer func() {
_ = conn.Close()
})
}()
_, err = conn.Ping()
require.NoError(t, err)
})
Expand Down Expand Up @@ -233,9 +233,9 @@ func TestWorkspaceAgentTURN(t *testing.T) {
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
Logger: slogtest.Make(t, nil),
})
t.Cleanup(func() {
defer func() {
_ = agentCloser.Close()
})
}()
resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)
opts := &peer.ConnOptions{
Logger: slogtest.Make(t, nil).Named("client"),
Expand All @@ -244,9 +244,9 @@ func TestWorkspaceAgentTURN(t *testing.T) {
opts.SettingEngine.SetNetworkTypes([]webrtc.NetworkType{webrtc.NetworkTypeTCP4})
conn, err := client.DialWorkspaceAgent(context.Background(), resources[0].Agents[0].ID, opts)
require.NoError(t, err)
t.Cleanup(func() {
defer func() {
_ = conn.Close()
})
}()
_, err = conn.Ping()
require.NoError(t, err)
}
Expand Down Expand Up @@ -294,9 +294,9 @@ func TestWorkspaceAgentPTY(t *testing.T) {
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
Logger: slogtest.Make(t, nil),
})
t.Cleanup(func() {
defer func() {
_ = agentCloser.Close()
})
}()
resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)

conn, err := client.WorkspaceAgentReconnectingPTY(context.Background(), resources[0].Agents[0].ID, uuid.New(), 80, 80, "/bin/bash")
Expand Down
12 changes: 6 additions & 6 deletions coderd/workspaceapps_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ func TestWorkspaceAppsProxyPath(t *testing.T) {
// #nosec
ln, err := net.Listen("tcp", ":0")
require.NoError(t, err)
defer func() {
_ = ln.Close()
}()
server := http.Server{
Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
}),
}
t.Cleanup(func() {
_ = server.Close()
_ = ln.Close()
})
go server.Serve(ln)
defer server.Close()
tcpAddr, _ := ln.Addr().(*net.TCPAddr)

client := coderdtest.New(t, &coderdtest.Options{
Expand Down Expand Up @@ -78,9 +78,9 @@ func TestWorkspaceAppsProxyPath(t *testing.T) {
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
Logger: slogtest.Make(t, nil),
})
t.Cleanup(func() {
defer func() {
_ = agentCloser.Close()
})
}()
coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)
client.HTTPClient.CheckRedirect = func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
Expand Down
2 changes: 1 addition & 1 deletion coderd/workspacebuilds_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ func TestWorkspaceBuildLogs(t *testing.T) {
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
ctx, cancelFunc := context.WithCancel(context.Background())
t.Cleanup(cancelFunc)
defer cancelFunc()
logs, err := client.WorkspaceBuildLogsAfter(ctx, workspace.LatestBuild.ID, before.Add(-time.Hour))
require.NoError(t, err)
for {
Expand Down
26 changes: 13 additions & 13 deletions coderd/wsconncache/wsconncache_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ func TestCache(t *testing.T) {
cache := wsconncache.New(func(r *http.Request, id uuid.UUID) (*agent.Conn, error) {
return setupAgent(t, agent.Metadata{}, 0), nil
}, 0)
t.Cleanup(func() {
defer func() {
_ = cache.Close()
})
}()
conn1, _, err := cache.Acquire(httptest.NewRequest(http.MethodGet, "/", nil), uuid.Nil)
require.NoError(t, err)
conn2, _, err := cache.Acquire(httptest.NewRequest(http.MethodGet, "/", nil), uuid.Nil)
Expand All @@ -56,9 +56,9 @@ func TestCache(t *testing.T) {
called.Add(1)
return setupAgent(t, agent.Metadata{}, 0), nil
}, time.Microsecond)
t.Cleanup(func() {
defer func() {
_ = cache.Close()
})
}()
conn, release, err := cache.Acquire(httptest.NewRequest(http.MethodGet, "/", nil), uuid.Nil)
require.NoError(t, err)
release()
Expand All @@ -74,9 +74,9 @@ func TestCache(t *testing.T) {
cache := wsconncache.New(func(r *http.Request, id uuid.UUID) (*agent.Conn, error) {
return setupAgent(t, agent.Metadata{}, 0), nil
}, time.Microsecond)
t.Cleanup(func() {
defer func() {
_ = cache.Close()
})
}()
conn, release, err := cache.Acquire(httptest.NewRequest(http.MethodGet, "/", nil), uuid.Nil)
require.NoError(t, err)
time.Sleep(time.Millisecond)
Expand All @@ -87,9 +87,9 @@ func TestCache(t *testing.T) {
t.Parallel()
random, err := net.Listen("tcp", "127.0.0.1:0")
require.NoError(t, err)
t.Cleanup(func() {
defer func() {
_ = random.Close()
})
}()
tcpAddr, valid := random.Addr().(*net.TCPAddr)
require.True(t, valid)

Expand All @@ -98,17 +98,17 @@ func TestCache(t *testing.T) {
w.WriteHeader(http.StatusOK)
}),
}
t.Cleanup(func() {
defer func() {
_ = server.Close()
})
}()
go server.Serve(random)

cache := wsconncache.New(func(r *http.Request, id uuid.UUID) (*agent.Conn, error) {
return setupAgent(t, agent.Metadata{}, 0), nil
}, time.Microsecond)
t.Cleanup(func() {
defer func() {
_ = cache.Close()
})
}()

var wg sync.WaitGroup
// Perform many requests in parallel to simulate
Expand All @@ -132,7 +132,7 @@ func TestCache(t *testing.T) {
res := httptest.NewRecorder()
proxy.ServeHTTP(res, req)
res.Result().Body.Close()
require.Equal(t, http.StatusOK, res.Result().StatusCode)
assert.Equal(t, http.StatusOK, res.Result().StatusCode)
}()
}
wg.Wait()
Expand Down
4 changes: 2 additions & 2 deletions peerbroker/proxy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ func TestProxy(t *testing.T) {
Pubsub: pubsub,
})
require.NoError(t, err)
t.Cleanup(func() {
defer func() {
_ = proxyCloser.Close()
})
}()

var wg sync.WaitGroup
wg.Add(1)
Expand Down
4 changes: 2 additions & 2 deletions provisioner/echo/serve_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ func TestEcho(t *testing.T) {
// Create an in-memory provisioner to communicate with.
client, server := provisionersdk.TransportPipe()
ctx, cancelFunc := context.WithCancel(context.Background())
t.Cleanup(func() {
defer func() {
_ = client.Close()
_ = server.Close()
cancelFunc()
})
}()
go func() {
err := echo.Serve(ctx, fs, &provisionersdk.ServeOptions{
Listener: server,
Expand Down
4 changes: 2 additions & 2 deletions provisioner/terraform/parse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ func TestParse(t *testing.T) {
// Create an in-memory provisioner to communicate with.
client, server := provisionersdk.TransportPipe()
ctx, cancelFunc := context.WithCancel(context.Background())
t.Cleanup(func() {
defer func() {
_ = client.Close()
_ = server.Close()
cancelFunc()
})
}()
go func() {
err := terraform.Serve(ctx, &terraform.ServeOptions{
ServeOptions: &provisionersdk.ServeOptions{
Expand Down
2 changes: 1 addition & 1 deletion provisionersdk/agent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func TestAgentScript(t *testing.T) {
render.Status(r, http.StatusOK)
render.Data(rw, r, content)
}))
t.Cleanup(srv.Close)
defer srv.Close()
srvURL, err := url.Parse(srv.URL)
require.NoError(t, err)

Expand Down