• Stars
    star
    4,509
  • Rank 9,462 (Top 0.2 %)
  • Language
    Go
  • License
    MIT License
  • Created almost 7 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Goroutine leak detector

goleak GoDoc Build Status Coverage Status

Goroutine leak detector to help avoid Goroutine leaks.

Installation

You can use go get to get the latest version:

go get -u go.uber.org/goleak

goleak also supports semver releases.

Note that go-leak only supports the two most recent minor versions of Go.

Quick Start

To verify that there are no unexpected goroutines running at the end of a test:

func TestA(t *testing.T) {
	defer goleak.VerifyNone(t)

	// test logic here.
}

Instead of checking for leaks at the end of every test, goleak can also be run at the end of every test package by creating a TestMain function for your package:

func TestMain(m *testing.M) {
	goleak.VerifyTestMain(m)
}

Determine Source of Package Leaks

When verifying leaks using TestMain, the leak test is only run once after all tests have been run. This is typically enough to ensure there's no goroutines leaked from tests, but when there are leaks, it's hard to determine which test is causing them.

You can use the following bash script to determine the source of the failing test:

# Create a test binary which will be used to run each test individually
$ go test -c -o tests

# Run each test individually, printing "." for successful tests, or the test name
# for failing tests.
$ for test in $(go test -list . | grep -E "^(Test|Example)"); do ./tests -test.run "^$test\$" &>/dev/null && echo -n "." || echo -e "\n$test failed"; done

This will only print names of failing tests which can be investigated individually. E.g.,

.....
TestLeakyTest failed
.......

Stability

goleak is v1 and follows SemVer strictly.

No breaking changes will be made to exported APIs before 2.0.

More Repositories

1

zap

Blazing fast, structured, leveled logging in Go.
Go
21,782
star
2

guide

The Uber Go Style Guide.
Makefile
15,636
star
3

fx

A dependency injection based application framework for Go.
Go
5,742
star
4

ratelimit

A Go blocking leaky-bucket rate limit implementation
Go
3,934
star
5

dig

A reflection based dependency injection toolkit for Go.
Go
3,802
star
6

automaxprocs

Automatically set GOMAXPROCS to match Linux container CPU quota.
Go
3,459
star
7

mock

GoMock is a mocking framework for the Go programming language.
Go
2,165
star
8

atomic

Wrapper types for sync/atomic which enforce atomic access
Go
1,342
star
9

multierr

Combine one or more Go errors together
Go
1,012
star
10

tally

A Go metrics interface with fast buffered metrics and third party reporters
Go
847
star
11

gopatch

Refactoring and code transformation tool for Go.
Go
681
star
12

nilaway

Static Analysis tool to detect potential Nil panics in Go code
Go
400
star
13

config

Configuration for Go applications
Go
382
star
14

cadence-client

Framework for authoring workflows and activities running on top of the Cadence orchestration engine.
Go
339
star
15

sally

A tiny HTTP server for supporting custom Golang import paths
Go
228
star
16

kafka-client

Go client library for Apache Kafka
Go
220
star
17

dosa

DOSA is a data object abstraction layer
Go
197
star
18

cff

Concurrency toolkit for Go
Go
124
star
19

tools

A collection of golang tools used at Uber
Go
58
star
20

go-helix

A Go implementation of Apache Helix (currently the participant part only).
Go
56
star
21

icu4go

A Go binding for the icu4c library
Go
49
star
22

mapdecode

Implement YAML/JSON decoding in one place.
Go
48
star
23

hackeroni

A Go API client for HackerOne (api.hackerone.com)
Go
41
star
24

gwr

Get / Watch / Report -ing of operational data. This project is deprecated and not maintained.
Go
38
star
25

flagoverride

An automatic way of creating command line options to override fields from a struct.
Go
20
star