tests: update + enable check for leaked goroutines
Go 1.4 landed a new testing.M type [1][1] which allows for start-up and shutdown hooks when running tests. The standard library now uses this for checking for leaked goroutines in net/http [2][2]. This patch essentially re-ports the updated code from the net/http test (we were using an older version of it) - in detail: - updates the test to use `TestMain` instead of relying on `TestGoroutinesRunning` to be implicitly run after all other tests - adds a few new goroutines to the list of exceptions (the test itself, as well as the golang/glog package and pkg/log.MergeLogger, both of which spin off goroutines to handle log flushing/merging respectively) - removes a couple of TODOs in the test for extra goroutines that's run after individual tests (one of these re-enables the http package's `.readLoop` and the other was an out-of-date TODO) - re-enables the test [1]: https://golang.org/pkg/testing/#M [2]: https://github.com/golang/go/blob/release-branch.go1.4/src/net/http/main_test.go#L18
This commit is contained in:
@ -5,7 +5,9 @@
|
|||||||
package integration
|
package integration
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"os"
|
||||||
"runtime"
|
"runtime"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
@ -26,6 +28,9 @@ func interestingGoroutines() (gs []string) {
|
|||||||
strings.Contains(stack, "created by testing.RunTests") ||
|
strings.Contains(stack, "created by testing.RunTests") ||
|
||||||
strings.Contains(stack, "testing.Main(") ||
|
strings.Contains(stack, "testing.Main(") ||
|
||||||
strings.Contains(stack, "runtime.goexit") ||
|
strings.Contains(stack, "runtime.goexit") ||
|
||||||
|
strings.Contains(stack, "github.com/coreos/etcd/integration.interestingGoroutines") ||
|
||||||
|
strings.Contains(stack, "github.com/coreos/etcd/pkg/logutil.(*MergeLogger).outputLoop") ||
|
||||||
|
strings.Contains(stack, "github.com/golang/glog.(*loggingT).flushDaemon") ||
|
||||||
strings.Contains(stack, "created by runtime.gc") ||
|
strings.Contains(stack, "created by runtime.gc") ||
|
||||||
strings.Contains(stack, "runtime.MHeap_Scavenger") {
|
strings.Contains(stack, "runtime.MHeap_Scavenger") {
|
||||||
continue
|
continue
|
||||||
@ -37,11 +42,18 @@ func interestingGoroutines() (gs []string) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Verify the other tests didn't leave any goroutines running.
|
// Verify the other tests didn't leave any goroutines running.
|
||||||
// This is in a file named z_last_test.go so it sorts at the end.
|
func TestMain(m *testing.M) {
|
||||||
func TestGoroutinesRunning(t *testing.T) {
|
v := m.Run()
|
||||||
t.Skip("TODO: etcdserver.Sender may still dial closed remote endpoint and need some time to timeout.")
|
if v == 0 && goroutineLeaked() {
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
os.Exit(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
func goroutineLeaked() bool {
|
||||||
if testing.Short() {
|
if testing.Short() {
|
||||||
t.Skip("not counting goroutines for leakage in -short mode")
|
// not counting goroutines for leakage in -short mode
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
gs := interestingGoroutines()
|
gs := interestingGoroutines()
|
||||||
|
|
||||||
@ -52,13 +64,14 @@ func TestGoroutinesRunning(t *testing.T) {
|
|||||||
n++
|
n++
|
||||||
}
|
}
|
||||||
|
|
||||||
t.Logf("num goroutines = %d", n)
|
if n == 0 {
|
||||||
if n > 0 {
|
return false
|
||||||
t.Error("Too many goroutines.")
|
|
||||||
for stack, count := range stackCount {
|
|
||||||
t.Logf("%d instances of:\n%s", count, stack)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
fmt.Fprintf(os.Stderr, "Too many goroutines running after integration test(s).\n")
|
||||||
|
for stack, count := range stackCount {
|
||||||
|
fmt.Fprintf(os.Stderr, "%d instances of:\n%s\n", count, stack)
|
||||||
|
}
|
||||||
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func afterTest(t *testing.T) {
|
func afterTest(t *testing.T) {
|
||||||
@ -68,18 +81,12 @@ func afterTest(t *testing.T) {
|
|||||||
}
|
}
|
||||||
var bad string
|
var bad string
|
||||||
badSubstring := map[string]string{
|
badSubstring := map[string]string{
|
||||||
// TODO: there might exist a bug in http package, which will leave
|
").readLoop(": "a Transport",
|
||||||
// readLoop without writeLoop after close all idle connections.
|
|
||||||
// comment this line until we have time to dig into it.
|
|
||||||
// ").readLoop(": "a Transport",
|
|
||||||
").writeLoop(": "a Transport",
|
").writeLoop(": "a Transport",
|
||||||
"created by net/http/httptest.(*Server).Start": "an httptest.Server",
|
"created by net/http/httptest.(*Server).Start": "an httptest.Server",
|
||||||
"timeoutHandler": "a TimeoutHandler",
|
"timeoutHandler": "a TimeoutHandler",
|
||||||
// TODO: dial goroutines leaks even if the request is cancelled.
|
"net.(*netFD).connect(": "a timing out dial",
|
||||||
// It needs to wait dial timeout to recycle the goroutine.
|
").noteClientGone(": "a closenotifier sender",
|
||||||
// comment this line until we have time to dig into it.
|
|
||||||
"net.(*netFD).connect(": "a timing out dial",
|
|
||||||
").noteClientGone(": "a closenotifier sender",
|
|
||||||
}
|
}
|
||||||
var stacks string
|
var stacks string
|
||||||
for i := 0; i < 6; i++ {
|
for i := 0; i < 6; i++ {
|
Reference in New Issue
Block a user