github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/leakutil/leak_helper.go (about)

     1  // Copyright 2021 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package leakutil
    15  
    16  import (
    17  	"testing"
    18  
    19  	"go.uber.org/goleak"
    20  )
    21  
    22  // defaultOpts is the default ignore list for goleak.
    23  var defaultOpts = []goleak.Option{
    24  	goleak.IgnoreTopFunction("go.etcd.io/etcd/client/pkg/v3/logutil.(*MergeLogger).outputLoop"),
    25  	goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"),
    26  	goleak.IgnoreTopFunction("github.com/golang/glog.(*loggingT).flushDaemon"),
    27  	goleak.IgnoreTopFunction("github.com/golang/glog.(*fileSink).flushDaemon"),
    28  
    29  	// library used by sarama, ref: https://github.com/rcrowley/go-metrics/pull/266
    30  	goleak.IgnoreTopFunction("github.com/rcrowley/go-metrics.(*meterArbiter).tick"),
    31  	// Because we close the sarama producer asynchronously, so we have to ignore these funcs.
    32  	goleak.IgnoreTopFunction("github.com/IBM/sarama.(*client).backgroundMetadataUpdater"),
    33  	goleak.IgnoreTopFunction("github.com/IBM/sarama.(*Broker).responseReceiver"),
    34  	goleak.IgnoreTopFunction("github.com/lestrrat-go/httprc.runFetchWorker"),
    35  }
    36  
    37  // VerifyNone verifies that no unexpected leaks occur
    38  // Note that this function is incompatible with `t.Parallel()`
    39  func VerifyNone(t *testing.T, options ...goleak.Option) {
    40  	options = append(options, defaultOpts...)
    41  	goleak.VerifyNone(t, options...)
    42  }
    43  
    44  // SetUpLeakTest ignore unexpected common etcd and opencensus stack functions for goleak
    45  // options can be used to implement other ignore items
    46  func SetUpLeakTest(m *testing.M, options ...goleak.Option) {
    47  	options = append(options, defaultOpts...)
    48  	goleak.VerifyTestMain(m, options...)
    49  }