accounts/abi/bind/backends: fix goroutine leak in unit test

[yuriechan]

Type of change

• Bug Fix

Description

Properly clean up the running routines with using the Stop method.

Additional details

• Introduce uber-go/goleak to detect goroutine leaks in tests
• Run go mod tidy to clean up dependency
• Used uber-go/goleak to verify the goroutine leak being fixed as pasted below
• Check for goroutine leaks on all unit tests under accounts/abi/bind/backends/simulated_test.go with goleak.VerifyTestMain
  • use goleak.IgnoreCurrent() option to only detect goroutine that spawned within the unit test code

Related issues

Resolves #23978

Before

=== RUN   TestNewAdjustTimeFail
--- PASS: TestNewAdjustTimeFail (0.00s)
PASS
goleak: Errors on successful test run: found unexpected goroutines:
[Goroutine 48 in state chan receive, with github.com/ethereum/go-ethereum/core/state/snapshot.(*diskLayer).generate on top of the stack:
goroutine 48 [chan receive]:
github.com/ethereum/go-ethereum/core/state/snapshot.(*diskLayer).generate(0x14000122750, 0x140001e2880)
	/Users/y-egawa/opensource/go-ethereum-forked/core/state/snapshot/generate.go:719 +0x454
created by github.com/ethereum/go-ethereum/core/state/snapshot.generateSnapshot
	/Users/y-egawa/opensource/go-ethereum-forked/core/state/snapshot/generate.go:79 +0x2bc

 Goroutine 49 in state select, with github.com/ethereum/go-ethereum/core.(*BlockChain).updateFutureBlocks on top of the stack:
goroutine 49 [select]:
github.com/ethereum/go-ethereum/core.(*BlockChain).updateFutureBlocks(0x14000296800)
	/Users/y-egawa/opensource/go-ethereum-forked/core/blockchain.go:2280 +0xdc
created by github.com/ethereum/go-ethereum/core.NewBlockChain
	/Users/y-egawa/opensource/go-ethereum-forked/core/blockchain.go:409 +0x1a0c

 Goroutine 50 in state chan receive, with github.com/ethereum/go-ethereum/accounts/abi/bind/backends.(*filterBackend).SubscribeNewTxsEvent.func1 on top of the stack:
goroutine 50 [chan receive]:
github.com/ethereum/go-ethereum/accounts/abi/bind/backends.(*filterBackend).SubscribeNewTxsEvent.func1(0x0?)
	/Users/y-egawa/opensource/go-ethereum-forked/accounts/abi/bind/backends/simulated.go:935 +0x20
github.com/ethereum/go-ethereum/event.NewSubscription.func1()
	/Users/y-egawa/opensource/go-ethereum-forked/event/subscription.go:53 +0x64
created by github.com/ethereum/go-ethereum/event.NewSubscription
	/Users/y-egawa/opensource/go-ethereum-forked/event/subscription.go:51 +0xec

 Goroutine 51 in state chan receive, with github.com/ethereum/go-ethereum/accounts/abi/bind/backends.(*filterBackend).SubscribePendingLogsEvent.func1 on top of the stack:
goroutine 51 [chan receive]:
github.com/ethereum/go-ethereum/accounts/abi/bind/backends.(*filterBackend).SubscribePendingLogsEvent.func1(0x0?)
	/Users/y-egawa/opensource/go-ethereum-forked/accounts/abi/bind/backends/simulated.go:935 +0x20
github.com/ethereum/go-ethereum/event.NewSubscription.func1()
	/Users/y-egawa/opensource/go-ethereum-forked/event/subscription.go:53 +0x64
created by github.com/ethereum/go-ethereum/event.NewSubscription
	/Users/y-egawa/opensource/go-ethereum-forked/event/subscription.go:51 +0xec

 Goroutine 52 in state select, with github.com/ethereum/go-ethereum/eth/filters.(*EventSystem).eventLoop on top of the stack:
goroutine 52 [select]:
github.com/ethereum/go-ethereum/eth/filters.(*EventSystem).eventLoop(0x140000bc630)
	/Users/y-egawa/opensource/go-ethereum-forked/eth/filters/filter_system.go:561 +0x28c
created by github.com/ethereum/go-ethereum/eth/filters.NewEventSystem
	/Users/y-egawa/opensource/go-ethereum-forked/eth/filters/filter_system.go:250 +0x3d8
]

After

=== RUN   TestNewAdjustTimeFail
--- PASS: TestNewAdjustTimeFail (0.00s)
PASS

Process finished with the exit code 0

[holiman]

LGTM, thanks!