forked from uber/tchannel-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
verify.go
91 lines (80 loc) · 2.68 KB
/
verify.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Copyright (c) 2015 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 goroutines
import (
"fmt"
"runtime"
"strings"
"testing"
"time"
)
// filterStacks will filter any stacks excluded by the given VerifyOpts.
func filterStacks(stacks []Stack, skipID int, opts *VerifyOpts) []Stack {
filtered := stacks[:0]
for _, stack := range stacks {
if stack.ID() == skipID || shouldIgnore(stack) {
continue
}
if opts.ShouldSkip(stack) {
continue
}
filtered = append(filtered, stack)
}
return filtered
}
func shouldIgnore(s Stack) bool {
switch funcName := s.firstFunction; funcName {
case "testing.RunTests", "testing.(*T).Run":
return strings.HasPrefix(s.State(), "chan receive")
case "runtime.goexit":
return strings.HasPrefix(s.State(), "syscall")
case "os/signal.signal_recv":
// The signal package automatically starts a goroutine when it's imported.
return true
default:
return false
}
}
// IdentifyLeaks looks for extra goroutines, and returns a descriptive error if
// it finds any.
func IdentifyLeaks(opts *VerifyOpts) error {
cur := GetCurrentStack().id
const maxAttempts = 50
var stacks []Stack
for i := 0; i < maxAttempts; i++ {
stacks = GetAll()
stacks = filterStacks(stacks, cur, opts)
if len(stacks) == 0 {
return nil
}
if i > maxAttempts/2 {
time.Sleep(time.Duration(i) * time.Millisecond)
} else {
runtime.Gosched()
}
}
return fmt.Errorf("found unexpected goroutines:\n%s", stacks)
}
// VerifyNoLeaks calls IdentifyLeaks and fails the test if it finds any leaked
// goroutines.
func VerifyNoLeaks(t testing.TB, opts *VerifyOpts) {
if err := IdentifyLeaks(opts); err != nil {
t.Error(err.Error())
}
}