Skip to content

Run the cleanup routines even if the main goroutine panics #882

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
richvdh merged 2 commits into from
Jun 20, 2026
Merged

Run the cleanup routines even if the main goroutine panics #882

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd4b63b
Run the cleanup routines even if the main goroutine panics
richvdh Jun 19, 2026
9d9a72f
Apply suggestion from @richvdh
richvdh Jun 20, 2026
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
18 changes: 13 additions & 5 deletions test_main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,20 @@ func TestMain(m *testing.M, namespace string, customOpts ...opt) {
fmt.Printf("Error: %s", err)
os.Exit(1)
}
exitCode := m.Run()
if opts.cleanup != nil {
opts.cleanup(testPackage.Config)

// Run the cleanup functions even on panic.
Comment thread
richvdh marked this conversation as resolved.
// Note that deferred functions aren't run on `os.Exit`, so we need to put the `defer` calls
// inside a new `func()`.
runAndCleanup := func() int {
defer testPackage.Cleanup()
if opts.cleanup != nil {
defer opts.cleanup(testPackage.Config)
}

return m.Run()
}
testPackage.Cleanup()
os.Exit(exitCode)

os.Exit(runAndCleanup())
Comment on lines +80 to +92

@MadLittleMods MadLittleMods Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Would this also work? (less layers)

Suggested change
// Run the cleanup functions even on panic.
runAndCleanup := func() int {
defer testPackage.Cleanup()
if opts.cleanup != nil {
defer opts.cleanup(testPackage.Config)
}
return m.Run()
}
testPackage.Cleanup()
os.Exit(exitCode)
os.Exit(runAndCleanup())
defer testPackage.Cleanup()
if opts.cleanup != nil {
defer opts.cleanup(testPackage.Config)
}
exitCode := m.Run()
os.Exit(exitCode)

@richvdh richvdh Jun 20, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I don't think so. Per https://pkg.go.dev/os#Exit, deferred functions are not run on os.Exit. The extra layer gives the deferred functions a chance to run.

I'll add a comment to clarify this.

}

// Deploy will deploy the given blueprint or terminate the test.
Expand Down
Loading