package leakcheck

import "cloud.google.com/go/internal/leakcheck"

Package leakcheck contains functions to check leaked goroutines.

Call "defer leakcheck.Check(t)" at the beginning of tests.

This is very closely based on grpc-go's leakcheck.

Index

Functions

func Check

func Check(efer Errorfer)

Check looks at the currently-running goroutines and checks if there are any interestring (created by gRPC) goroutines leaked. It waits up to 10 seconds in the error cases.

func RegisterIgnoreGoroutine

func RegisterIgnoreGoroutine(s string)

RegisterIgnoreGoroutine appends s into the ignore goroutine list. The goroutines whose stack trace contains s will not be identified as leaked goroutines. Not thread-safe, only call this function in init().

Types

type Errorfer

type Errorfer interface {
	Errorf(format string, args ...interface{})
}

Errorfer is the interface that wraps the Errorf method. It's a subset of testing.TB to make it easy to use Check.

Source Files

leakcheck.go

Version
v0.118.3 (latest)
Published
Feb 20, 2025
Platform
linux/amd64
Imports
4 packages
Last checked
5 hours ago

Tools for package owners.