2ab8af4093
This is in its own separate package so that it will be a separate test binary that runs thus isolating the go runtime from other tests and allowing accurate go routine leak checking. This test would ideally use goleak.VerifyTestMain but that will fail 100% of the time due to some architectural things (blocking queries and net/rpc uncancellability). This test is not comprehensive. We should enable/exercise more features and more cluster configurations. However its a start.
81 lines
2.5 KiB
Go
81 lines
2.5 KiB
Go
// Copyright (c) 2017 Uber Technologies, Inc.
|
|
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package goleak
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"go.uber.org/goleak/internal/stack"
|
|
)
|
|
|
|
// TestingT is the minimal subset of testing.TB that we use.
|
|
type TestingT interface {
|
|
Error(...interface{})
|
|
}
|
|
|
|
// filterStacks will filter any stacks excluded by the given opts.
|
|
// filterStacks modifies the passed in stacks slice.
|
|
func filterStacks(stacks []stack.Stack, skipID int, opts *opts) []stack.Stack {
|
|
filtered := stacks[:0]
|
|
for _, stack := range stacks {
|
|
// Always skip the running goroutine.
|
|
if stack.ID() == skipID {
|
|
continue
|
|
}
|
|
// Run any default or user-specified filters.
|
|
if opts.filter(stack) {
|
|
continue
|
|
}
|
|
filtered = append(filtered, stack)
|
|
}
|
|
return filtered
|
|
}
|
|
|
|
// Find looks for extra goroutines, and returns a descriptive error if
|
|
// any are found.
|
|
func Find(options ...Option) error {
|
|
cur := stack.Current().ID()
|
|
|
|
opts := buildOpts(options...)
|
|
var stacks []stack.Stack
|
|
retry := true
|
|
for i := 0; retry; i++ {
|
|
stacks = filterStacks(stack.All(), cur, opts)
|
|
|
|
if len(stacks) == 0 {
|
|
return nil
|
|
}
|
|
retry = opts.retry(i)
|
|
}
|
|
|
|
return fmt.Errorf("found unexpected goroutines:\n%s", stacks)
|
|
}
|
|
|
|
// 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 VerifyNone(t TestingT, options ...Option) {
|
|
if err := Find(options...); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|