Merge pull request #1672 from ydb-platform/check-goroutines-leak

added internal/xtest.CheckGoroutinesLeak

Author: asmyasnikov

internal/xtest/leak.go

@@ -0,0 +1,74 @@
+package xtest
+
+import (
+	"regexp"
+	"runtime"
+	"strings"
+	"testing"
+)
+
+func checkGoroutinesLeak(onLeak func(goroutines []string)) {
+	var bb []byte
+	for size := 1 << 16; ; size *= 2 {
+		bb = make([]byte, size)
+		if n := runtime.Stack(bb, true); n < size {
+			bb = bb[:n]
+
+			break
+		}
+	}
+	goroutines := strings.Split(string(bb), "\n\n")
+	unexpectedGoroutines := make([]string, 0, len(goroutines))
+
+	for i, g := range goroutines {
+		if i == 0 {
+			continue
+		}
+		stack := strings.Split(g, "\n")
+		firstFunction := stack[1]
+		state := strings.Trim(
+			regexp.MustCompile(`\[.*\]`).FindString(
+				regexp.MustCompile(`^goroutine \d+ \[.*\]`).FindString(stack[0]),
+			), "[]",
+		)
+		switch {
+		case strings.HasPrefix(firstFunction, "testing.RunTests"),
+			strings.HasPrefix(firstFunction, "testing.(*T).Run"),
+			strings.HasPrefix(firstFunction, "testing.(*T).Parallel"),
+			strings.HasPrefix(firstFunction, "testing.runFuzzing"),
+			strings.HasPrefix(firstFunction, "testing.runFuzzTests"):
+			if strings.Contains(state, "chan receive") {
+				continue
+			}
+
+		case strings.HasPrefix(firstFunction, "runtime.goexit"):
+			switch state {
+			case "syscall", "runnable":
+				continue
+			}
+
+		case strings.HasPrefix(firstFunction, "os/signal.signal_recv"),
+			strings.HasPrefix(firstFunction, "os/signal.loop"):
+			continue
+
+		case strings.Contains(g, "runtime.ensureSigM"):
+			continue
+
+		case strings.Contains(g, "runtime.ReadTrace"):
+			continue
+		}
+
+		unexpectedGoroutines = append(unexpectedGoroutines, g)
+	}
+	if l := len(unexpectedGoroutines); l > 0 {
+		onLeak(goroutines)
+	}
+}
+
+func CheckGoroutinesLeak(tb testing.TB) {
+	tb.Helper()
+	checkGoroutinesLeak(func(goroutines []string) {
+		tb.Helper()
+		tb.Errorf("found %d unexpected goroutines:\n%s", len(goroutines), strings.Join(goroutines, "\n"))
+	})
+}

internal/xtest/leak_test.go

@@ -0,0 +1,40 @@
+package xtest
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestCheckGoroutinesLeak(t *testing.T) {
+	t.Run("Leak", func(t *testing.T) {
+		TestManyTimes(t, func(t testing.TB) {
+			ch := make(chan struct{})
+			require.Panics(t, func() {
+				defer checkGoroutinesLeak(func([]string) {
+					panic("test")
+				})
+				go func() {
+					<-ch
+				}()
+			})
+			close(ch)
+		})
+	})
+	t.Run("NoLeak", func(t *testing.T) {
+		TestManyTimes(t, func(t testing.TB) {
+			require.NotPanics(t, func() {
+				defer checkGoroutinesLeak(func([]string) {
+					panic("test")
+				})
+				ch := make(chan struct{})
+				defer func() {
+					<-ch
+				}()
+				go func() {
+					close(ch)
+				}()
+			})
+		})
+	})
+}

tests/integration/basic_example_database_sql_bindings_test.go

@@ -26,7 +26,7 @@ import (
 )
 
 func TestBasicExampleDatabaseSqlBindings(t *testing.T) {
-	defer simpleDetectGoroutineLeak(t)
+	defer xtest.CheckGoroutinesLeak(t)
 
 	folder := t.Name()
 

tests/integration/basic_example_database_sql_test.go

@@ -27,7 +27,7 @@ import (
 )
 
 func TestBasicExampleDatabaseSql(t *testing.T) {
-	defer simpleDetectGoroutineLeak(t)
+	defer xtest.CheckGoroutinesLeak(t)
 
 	folder := t.Name()
 

tests/integration/helpers_test.go

@@ -10,7 +10,6 @@ import (
 	"fmt"
 	"os"
 	"path"
-	"runtime"
 	"strings"
 	"testing"
 	"text/template"
@@ -465,16 +464,3 @@ func driverEngine(db *sql.DB) (engine xsql.Engine) {
 
 	return engine
 }
-
-func simpleDetectGoroutineLeak(t *testing.T) {
-	// 1) testing.go => main.main()
-	// 2) current test
-	const expectedGoroutinesCount = 2
-	if num := runtime.NumGoroutine(); num > expectedGoroutinesCount {
-		bb := make([]byte, 2<<32)
-		if n := runtime.Stack(bb, true); n < len(bb) {
-			bb = bb[:n]
-		}
-		t.Error(fmt.Sprintf("unexpected goroutines:\n%s\n", string(bb[runtime.Stack(bb, false)+1:])))
-	}
-}