fic: enable thelper linter

Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>
etcd-io · Oct 16, 2024 · 4632b7e · 4632b7e
1 parent 6779a89
commit 4632b7e
Show file tree

Hide file tree

Showing 39 changed files with 135 additions and 56 deletions.
diff --git a/client/internal/v2/keys_bench_test.go b/client/internal/v2/keys_bench_test.go
@@ -49,6 +49,7 @@ func createTestResponse(children, size int) *Response {
 }
 
 func benchmarkResponseUnmarshalling(b *testing.B, children, size int) {
+	b.Helper()
 	header := http.Header{}
 	header.Add("X-Etcd-Index", "123456")
 	response := createTestResponse(children, size)

diff --git a/client/pkg/fileutil/preallocate_test.go b/client/pkg/fileutil/preallocate_test.go
@@ -23,16 +23,24 @@ import (
 
 func TestPreallocateExtend(t *testing.T) {
 	pf := func(f *os.File, sz int64) error { return Preallocate(f, sz, true) }
-	tf := func(t *testing.T, f *os.File) { testPreallocateExtend(t, f, pf) }
+	tf := func(t *testing.T, f *os.File) {
+		t.Helper()
+		testPreallocateExtend(t, f, pf)
+	}
 	runPreallocTest(t, tf)
 }
 
 func TestPreallocateExtendTrunc(t *testing.T) {
-	tf := func(t *testing.T, f *os.File) { testPreallocateExtend(t, f, preallocExtendTrunc) }
+	t.Helper()
+	tf := func(t *testing.T, f *os.File) {
+		t.Helper()
+		testPreallocateExtend(t, f, preallocExtendTrunc)
+	}
 	runPreallocTest(t, tf)
 }
 
 func testPreallocateExtend(t *testing.T, f *os.File, pf func(*os.File, int64) error) {
+	t.Helper()
 	size := int64(64 * 1000)
 	require.NoError(t, pf(f, size))
 
@@ -45,6 +53,7 @@ func testPreallocateExtend(t *testing.T, f *os.File, pf func(*os.File, int64) er
 
 func TestPreallocateFixed(t *testing.T) { runPreallocTest(t, testPreallocateFixed) }
 func testPreallocateFixed(t *testing.T, f *os.File) {
+	t.Helper()
 	size := int64(64 * 1000)
 	require.NoError(t, Preallocate(f, size, false))
 
@@ -56,6 +65,7 @@ func testPreallocateFixed(t *testing.T, f *os.File) {
 }
 
 func runPreallocTest(t *testing.T, test func(*testing.T, *os.File)) {
+	t.Helper()
 	p := t.TempDir()
 
 	f, err := os.CreateTemp(p, "")

diff --git a/client/pkg/fileutil/read_dir_test.go b/client/pkg/fileutil/read_dir_test.go
@@ -51,6 +51,7 @@ func TestReadDir(t *testing.T) {
 }
 
 func writeFunc(t *testing.T, path string) {
+	t.Helper()
 	fh, err := os.Create(path)
 	require.NoErrorf(t, err, "error creating file")
 	assert.NoErrorf(t, fh.Close(), "error closing file")

diff --git a/client/pkg/testutil/before.go b/client/pkg/testutil/before.go
@@ -24,20 +24,21 @@ import (
 	"go.etcd.io/etcd/client/pkg/v3/verify"
 )
 
-func BeforeTest(t testing.TB) {
-	RegisterLeakDetection(t)
+func BeforeTest(tb testing.TB) {
+	tb.Helper()
+	RegisterLeakDetection(tb)
 
 	revertVerifyFunc := verify.EnableAllVerifications()
 
 	path, err := os.Getwd()
-	assert.NoError(t, err)
-	tempDir := t.TempDir()
-	assert.NoError(t, os.Chdir(tempDir))
-	t.Logf("Changing working directory to: %s", tempDir)
+	assert.NoError(tb, err)
+	tempDir := tb.TempDir()
+	assert.NoError(tb, os.Chdir(tempDir))
+	tb.Logf("Changing working directory to: %s", tempDir)
 
-	t.Cleanup(func() {
+	tb.Cleanup(func() {
 		revertVerifyFunc()
-		assert.NoError(t, os.Chdir(path))
+		assert.NoError(tb, os.Chdir(path))
 	})
 }
 

diff --git a/client/pkg/testutil/testutil.go b/client/pkg/testutil/testutil.go
@@ -30,6 +30,7 @@ func WaitSchedule() {
 }
 
 func MustNewURLs(t *testing.T, urls []string) []url.URL {
+	t.Helper()
 	if urls == nil {
 		return nil
 	}
@@ -42,6 +43,7 @@ func MustNewURLs(t *testing.T, urls []string) []url.URL {
 }
 
 func MustNewURL(t *testing.T, s string) *url.URL {
+	t.Helper()
 	u, err := url.Parse(s)
 	if err != nil {
 		t.Fatalf("parse %v error: %v", s, err)
@@ -51,6 +53,7 @@ func MustNewURL(t *testing.T, s string) *url.URL {
 
 // FatalStack helps to fatal the test and print out the stacks of all running goroutines.
 func FatalStack(t *testing.T, s string) {
+	t.Helper()
 	stackTrace := make([]byte, 1024*1024)
 	n := runtime.Stack(stackTrace, true)
 	t.Errorf("---> Test failed: %s", s)

diff --git a/client/pkg/tlsutil/cipher_suites_test.go b/client/pkg/tlsutil/cipher_suites_test.go
@@ -27,6 +27,7 @@ func TestGetCipherSuite_not_existing(t *testing.T) {
 }
 
 func CipherSuiteExpectedToExist(tb testing.TB, cipher string, expectedID uint16) {
+	tb.Helper()
 	vid, ok := GetCipherSuite(cipher)
 	if !ok {
 		tb.Errorf("Expected %v cipher to exist", cipher)

diff --git a/client/pkg/transport/listener_test.go b/client/pkg/transport/listener_test.go
@@ -35,10 +35,12 @@ import (
 )
 
 func createSelfCert(t *testing.T) (*TLSInfo, error) {
+	t.Helper()
 	return createSelfCertEx(t, "127.0.0.1")
 }
 
 func createSelfCertEx(t *testing.T, host string, additionalUsages ...x509.ExtKeyUsage) (*TLSInfo, error) {
+	t.Helper()
 	d := t.TempDir()
 	info, err := SelfCert(zaptest.NewLogger(t), d, []string{host + ":0"}, 1, additionalUsages...)
 	if err != nil {
@@ -218,6 +220,7 @@ func TestNewListenerWithSocketOpts(t *testing.T) {
 }
 
 func testNewListenerTLSInfoAccept(t *testing.T, tlsInfo TLSInfo) {
+	t.Helper()
 	ln, err := NewListener("127.0.0.1:0", "https", &tlsInfo)
 	require.NoErrorf(t, err, "unexpected NewListener error")
 	defer ln.Close()
@@ -254,6 +257,7 @@ func TestNewListenerTLSInfoSkipClientSANVerify(t *testing.T) {
 }
 
 func testNewListenerTLSInfoClientCheck(t *testing.T, skipClientSANVerify, goodClientHost, acceptExpected bool) {
+	t.Helper()
 	tlsInfo, err := createSelfCert(t)
 	require.NoErrorf(t, err, "unable to create cert")
 

diff --git a/client/pkg/transport/timeout_dialer_test.go b/client/pkg/transport/timeout_dialer_test.go
@@ -89,6 +89,7 @@ type testBlockingServer struct {
 }
 
 func (ts *testBlockingServer) Start(t *testing.T) {
+	t.Helper()
 	for i := 0; i < ts.n; i++ {
 		conn, err := ts.ln.Accept()
 		if err != nil {

diff --git a/client/pkg/types/set_test.go b/client/pkg/types/set_test.go
@@ -38,6 +38,7 @@ func equal(a, b []string) bool {
 }
 
 func driveSetTests(t *testing.T, s Set) {
+	t.Helper()
 	// Verify operations on an empty set
 	values := s.Values()
 	if len(values) != 0 {

diff --git a/client/v3/client_test.go b/client/v3/client_test.go
@@ -38,6 +38,7 @@ import (
 )
 
 func NewClient(t *testing.T, cfg Config) (*Client, error) {
+	t.Helper()
 	if cfg.Logger == nil {
 		cfg.Logger = zaptest.NewLogger(t).Named("client")
 	}

diff --git a/pkg/osutil/osutil_test.go b/pkg/osutil/osutil_test.go
@@ -27,6 +27,7 @@ import (
 func init() { setDflSignal = func(syscall.Signal) {} }
 
 func waitSig(t *testing.T, c <-chan os.Signal, sig os.Signal) {
+	t.Helper()
 	select {
 	case s := <-c:
 		if s != sig {

diff --git a/pkg/proxy/server_test.go b/pkg/proxy/server_test.go
@@ -47,6 +47,7 @@ func TestServer_Unix_Secure_DelayTx(t *testing.T)   { testServer(t, "unix", true
 func TestServer_TCP_Secure_DelayTx(t *testing.T)    { testServer(t, "tcp", true, true) }
 
 func testServer(t *testing.T, scheme string, secure bool, delayTx bool) {
+	t.Helper()
 	lg := zaptest.NewLogger(t)
 	srcAddr, dstAddr := newUnixAddr(), newUnixAddr()
 	if scheme == "tcp" {
@@ -178,6 +179,7 @@ func createTLSInfo(lg *zap.Logger, secure bool) transport.TLSInfo {
 func TestServer_Unix_Insecure_DelayAccept(t *testing.T) { testServerDelayAccept(t, false) }
 func TestServer_Unix_Secure_DelayAccept(t *testing.T)   { testServerDelayAccept(t, true) }
 func testServerDelayAccept(t *testing.T, secure bool) {
+	t.Helper()
 	lg := zaptest.NewLogger(t)
 	srcAddr, dstAddr := newUnixAddr(), newUnixAddr()
 	defer func() {
@@ -486,6 +488,7 @@ func TestServerHTTP_Secure_DelayTx(t *testing.T)   { testServerHTTP(t, true, tru
 func TestServerHTTP_Insecure_DelayRx(t *testing.T) { testServerHTTP(t, false, false) }
 func TestServerHTTP_Secure_DelayRx(t *testing.T)   { testServerHTTP(t, true, false) }
 func testServerHTTP(t *testing.T, secure, delayTx bool) {
+	t.Helper()
 	lg := zaptest.NewLogger(t)
 	scheme := "tcp"
 	ln1, ln2 := listen(t, scheme, "localhost:0", transport.TLSInfo{}), listen(t, scheme, "localhost:0", transport.TLSInfo{})
@@ -634,6 +637,7 @@ func newUnixAddr() string {
 }
 
 func listen(t *testing.T, scheme, addr string, tlsInfo transport.TLSInfo) (ln net.Listener) {
+	t.Helper()
 	var err error
 	if !tlsInfo.Empty() {
 		ln, err = transport.NewListener(addr, scheme, &tlsInfo)
@@ -647,6 +651,7 @@ func listen(t *testing.T, scheme, addr string, tlsInfo transport.TLSInfo) (ln ne
 }
 
 func send(t *testing.T, data []byte, scheme, addr string, tlsInfo transport.TLSInfo) {
+	t.Helper()
 	var out net.Conn
 	var err error
 	if !tlsInfo.Empty() {
@@ -670,6 +675,7 @@ func send(t *testing.T, data []byte, scheme, addr string, tlsInfo transport.TLSI
 }
 
 func receive(t *testing.T, ln net.Listener) (data []byte) {
+	t.Helper()
 	buf := bytes.NewBuffer(make([]byte, 0, 1024))
 	for {
 		in, err := ln.Accept()
@@ -691,6 +697,7 @@ func receive(t *testing.T, ln net.Listener) (data []byte) {
 // Waits until a proxy is ready to serve.
 // Aborts test on proxy start-up error.
 func waitForServer(t *testing.T, s Server) {
+	t.Helper()
 	select {
 	case <-s.Ready():
 	case err := <-s.Error():

diff --git a/server/config/config_test.go b/server/config/config_test.go
@@ -24,6 +24,7 @@ import (
 )
 
 func mustNewURLs(t *testing.T, urls []string) []url.URL {
+	t.Helper()
 	if len(urls) == 0 {
 		return nil
 	}

diff --git a/server/embed/config_test.go b/server/embed/config_test.go
@@ -467,6 +467,7 @@ func compareSlices(slice1, slice2 []string) bool {
 }
 
 func mustCreateCfgFile(t *testing.T, b []byte) *os.File {
+	t.Helper()
 	tmpfile, err := os.CreateTemp("", "servercfg")
 	if err != nil {
 		t.Fatal(err)

diff --git a/server/etcdmain/config_test.go b/server/etcdmain/config_test.go
@@ -476,6 +476,7 @@ func TestParseFeatureGateFlags(t *testing.T) {
 }
 
 func mustCreateCfgFile(t *testing.T, b []byte) *os.File {
+	t.Helper()
 	tmpfile, err := os.CreateTemp("", "servercfg")
 	if err != nil {
 		t.Fatal(err)
@@ -494,6 +495,7 @@ func mustCreateCfgFile(t *testing.T, b []byte) *os.File {
 }
 
 func validateMemberFlags(t *testing.T, cfg *config) {
+	t.Helper()
 	wcfg := &embed.Config{
 		Dir:                    "testdir",
 		ListenPeerUrls:         []url.URL{{Scheme: "http", Host: "localhost:8000"}, {Scheme: "https", Host: "localhost:8001"}},
@@ -536,6 +538,7 @@ func validateMemberFlags(t *testing.T, cfg *config) {
 }
 
 func validateClusteringFlags(t *testing.T, cfg *config) {
+	t.Helper()
 	wcfg := newConfig()
 	wcfg.ec.AdvertisePeerUrls = []url.URL{{Scheme: "http", Host: "localhost:8000"}, {Scheme: "https", Host: "localhost:8001"}}
 	wcfg.ec.AdvertiseClientUrls = []url.URL{{Scheme: "http", Host: "localhost:7000"}, {Scheme: "https", Host: "localhost:7001"}}

diff --git a/server/etcdserver/api/membership/cluster_test.go b/server/etcdserver/api/membership/cluster_test.go
@@ -652,8 +652,9 @@ func TestNodeToMember(t *testing.T) {
 	}
 }
 
-func newTestCluster(t testing.TB, membs []*Member) *RaftCluster {
-	c := &RaftCluster{lg: zaptest.NewLogger(t), members: make(map[types.ID]*Member), removed: make(map[types.ID]bool)}
+func newTestCluster(tb testing.TB, membs []*Member) *RaftCluster {
+	tb.Helper()
+	c := &RaftCluster{lg: zaptest.NewLogger(tb), members: make(map[types.ID]*Member), removed: make(map[types.ID]bool)}
 	for _, m := range membs {
 		c.members[m.ID] = m
 	}

diff --git a/server/etcdserver/api/v2store/store_bench_test.go b/server/etcdserver/api/v2store/store_bench_test.go
@@ -174,6 +174,7 @@ func BenchmarkWatchOneKey(b *testing.B) {
 }
 
 func benchStoreSet(b *testing.B, valueSize int, process func(any) ([]byte, error)) {
+	b.Helper()
 	s := newStore()
 	b.StopTimer()
 	kvs, size := generateNRandomKV(b.N, valueSize)

diff --git a/server/etcdserver/api/v3rpc/validationfuzz_test.go b/server/etcdserver/api/v3rpc/validationfuzz_test.go
@@ -155,13 +155,15 @@ func FuzzTxnDeleteRangeRequest(f *testing.F) {
 }
 
 func verifyCheck(t *testing.T, check func() error) {
+	t.Helper()
 	errCheck := check()
 	if errCheck != nil {
 		t.Skip("Validation not passing. Skipping the apply.")
 	}
 }
 
 func execTransaction(t *testing.T, req *pb.RequestOp) {
+	t.Helper()
 	b, _ := betesting.NewDefaultTmpBackend(t)
 	defer betesting.Close(t, b)
 	s := mvcc.NewStore(zaptest.NewLogger(t), b, &lease.FakeLessor{}, mvcc.StoreConfig{})

diff --git a/server/etcdserver/apply/apply_auth_test.go b/server/etcdserver/apply/apply_auth_test.go
@@ -71,6 +71,7 @@ type fakeSnapshotServer struct{}
 func (*fakeSnapshotServer) ForceSnapshot() {}
 
 func defaultAuthApplierV3(t *testing.T) *authApplierV3 {
+	t.Helper()
 	lg := zaptest.NewLogger(t)
 	be, _ := betesting.NewDefaultTmpBackend(t)
 	t.Cleanup(func() {
@@ -125,6 +126,7 @@ const (
 )
 
 func mustCreateRolesAndEnableAuth(t *testing.T, authApplier *authApplierV3) {
+	t.Helper()
 	_, err := authApplier.UserAdd(&pb.AuthUserAddRequest{Name: userRoot, Options: &authpb.UserAddOptions{NoPassword: true}})
 	require.NoError(t, err)
 	_, err = authApplier.RoleAdd(&pb.AuthRoleAddRequest{Name: roleRoot})

diff --git a/server/etcdserver/apply/uber_applier_test.go b/server/etcdserver/apply/uber_applier_test.go
@@ -37,6 +37,7 @@ import (
 const memberID = 111195
 
 func defaultUberApplier(t *testing.T) UberApplier {
+	t.Helper()
 	lg := zaptest.NewLogger(t)
 	be, _ := betesting.NewDefaultTmpBackend(t)
 	t.Cleanup(func() {

diff --git a/server/etcdserver/bootstrap_test.go b/server/etcdserver/bootstrap_test.go
@@ -219,6 +219,7 @@ func TestBootstrapBackend(t *testing.T) {
 }
 
 func createDataDir(t *testing.T) (string, error) {
+	t.Helper()
 	var err error
 
 	// create the temporary data dir

diff --git a/server/etcdserver/server_test.go b/server/etcdserver/server_test.go
@@ -291,6 +291,7 @@ func TestApplyConfStateWithRestart(t *testing.T) {
 }
 
 func newServer(t *testing.T, recorder *nodeRecorder) *EtcdServer {
+	t.Helper()
 	lg := zaptest.NewLogger(t)
 	be, _ := betesting.NewDefaultTmpBackend(t)
 	t.Cleanup(func() {
@@ -1409,12 +1410,14 @@ func (n *nodeConfChangeCommitterRecorder) ApplyConfChange(conf raftpb.ConfChange
 	return &raftpb.ConfState{}
 }
 
-func newTestCluster(t testing.TB) *membership.RaftCluster {
-	return membership.NewCluster(zaptest.NewLogger(t))
+func newTestCluster(tb testing.TB) *membership.RaftCluster {
+	tb.Helper()
+	return membership.NewCluster(zaptest.NewLogger(tb))
 }
 
-func newTestClusterWithBackend(t testing.TB, membs []*membership.Member, be backend.Backend) *membership.RaftCluster {
-	lg := zaptest.NewLogger(t)
+func newTestClusterWithBackend(tb testing.TB, membs []*membership.Member, be backend.Backend) *membership.RaftCluster {
+	tb.Helper()
+	lg := zaptest.NewLogger(tb)
 	c := membership.NewCluster(lg)
 	c.SetBackend(schema.NewMembershipBackend(lg, be))
 	for _, m := range membs {

diff --git a/server/lease/leasehttp/http_test.go b/server/lease/leasehttp/http_test.go
@@ -93,6 +93,7 @@ func TestTimeToLiveHTTPTimeout(t *testing.T) {
 }
 
 func testApplyTimeout(t *testing.T, f func(*lease.Lease, string) error) {
+	t.Helper()
 	lg := zaptest.NewLogger(t)
 	be, _ := betesting.NewTmpBackend(t, time.Hour, 10000)
 	defer betesting.Close(t, be)