goleak: go.uber.org/goleak Index | Files | Directories

package goleak

import "go.uber.org/goleak"

Package goleak is a Goroutine leak detector.

Index

Package Files

doc.go leaks.go options.go testmain.go

func Find Uses

func Find(options ...Option) error

Find looks for extra goroutines, and returns a descriptive error if any are found.

func VerifyNone Uses

func VerifyNone(t TestingT, options ...Option)

VerifyNone marks the given TestingT as failed if any extra goroutines are found by Find. This is a helper method to make it easier to integrate in tests by doing:

defer VerifyNone(t)

func VerifyTestMain Uses

func VerifyTestMain(m TestingM, options ...Option)

VerifyTestMain can be used in a TestMain function for package tests to verify that there were no goroutine leaks. To use it, your TestMain function should look like:

func TestMain(m *testing.M) {
  goleak.VerifyTestMain(m)
}

See https://golang.org/pkg/testing/#hdr-Main for more details.

This will run all tests as per normal, and if they were successful, look for any goroutine leaks and fail the tests if any leaks were found.

type Option Uses

type Option interface {
    // contains filtered or unexported methods
}

Option lets users specify custom verifications.

func IgnoreTopFunction Uses

func IgnoreTopFunction(f string) Option

IgnoreTopFunction ignores any goroutines where the specified function is at the top of the stack. The function name should be fully qualified, e.g., go.uber.org/goleak.IgnoreTopFunction

type TestingM Uses

type TestingM interface {
    Run() int
}

TestingM is the minimal subset of testing.M that we use.

type TestingT Uses

type TestingT interface {
    Error(...interface{})
}

TestingT is the minimal subset of testing.TB that we use.

Directories

PathSynopsis
internal/stack

Package goleak imports 6 packages (graph). Updated 2018-11-19. Refresh now. Tools for package owners.