mirror of
				https://github.com/tailscale/tailscale.git
				synced 2025-11-04 02:01:14 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			61 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			61 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright (c) Tailscale Inc & AUTHORS
 | 
						|
// SPDX-License-Identifier: BSD-3-Clause
 | 
						|
 | 
						|
package tstest
 | 
						|
 | 
						|
import (
 | 
						|
	"bytes"
 | 
						|
	"runtime"
 | 
						|
	"runtime/pprof"
 | 
						|
	"testing"
 | 
						|
	"time"
 | 
						|
 | 
						|
	"github.com/google/go-cmp/cmp"
 | 
						|
)
 | 
						|
 | 
						|
// ResourceCheck takes a snapshot of the current goroutines and registers a
 | 
						|
// cleanup on tb to verify that after the rest, all goroutines created by the
 | 
						|
// test go away. (well, at least that the count matches. Maybe in the future it
 | 
						|
// can look at specific routines).
 | 
						|
//
 | 
						|
// It panics if called from a parallel test.
 | 
						|
func ResourceCheck(tb testing.TB) {
 | 
						|
	tb.Helper()
 | 
						|
 | 
						|
	// Set an environment variable (anything at all) just for the
 | 
						|
	// side effect of tb.Setenv panicking if we're in a parallel test.
 | 
						|
	tb.Setenv("TS_CHECKING_RESOURCES", "1")
 | 
						|
 | 
						|
	startN, startStacks := goroutines()
 | 
						|
	tb.Cleanup(func() {
 | 
						|
		if tb.Failed() {
 | 
						|
			// Test has failed - but this doesn't catch panics due to
 | 
						|
			// https://github.com/golang/go/issues/49929.
 | 
						|
			return
 | 
						|
		}
 | 
						|
		// Goroutines might be still exiting.
 | 
						|
		for range 300 {
 | 
						|
			if runtime.NumGoroutine() <= startN {
 | 
						|
				return
 | 
						|
			}
 | 
						|
			time.Sleep(10 * time.Millisecond)
 | 
						|
		}
 | 
						|
		endN, endStacks := goroutines()
 | 
						|
		if endN <= startN {
 | 
						|
			return
 | 
						|
		}
 | 
						|
		tb.Logf("goroutine diff:\n%v\n", cmp.Diff(startStacks, endStacks))
 | 
						|
 | 
						|
		// tb.Failed() above won't report on panics, so we shouldn't call Fatal
 | 
						|
		// here or we risk suppressing reporting of the panic.
 | 
						|
		tb.Errorf("goroutine count: expected %d, got %d\n", startN, endN)
 | 
						|
	})
 | 
						|
}
 | 
						|
 | 
						|
func goroutines() (int, []byte) {
 | 
						|
	p := pprof.Lookup("goroutine")
 | 
						|
	b := new(bytes.Buffer)
 | 
						|
	p.WriteTo(b, 1)
 | 
						|
	return p.Count(), b.Bytes()
 | 
						|
}
 |