p2p/discover: fix flaky tests writing to test.log after completion (#30506)

This PR fixes two tests, which had a tendency to sometimes write to the `*testing.T` `log` facility after the test function had completed, which is not allowed. This PR fixes it by using waitgroups to ensure that the handler/logwriter terminates before the test exits.

closes #30505
This commit is contained in:
Martin HS 2024-09-26 08:12:12 +02:00 committed by GitHub
parent 80b529ea71
commit b5a88dafae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 27 additions and 5 deletions

View File

@ -21,6 +21,7 @@ import (
"fmt"
"net/netip"
"slices"
"sync"
"testing"
"github.com/ethereum/go-ethereum/crypto"
@ -67,7 +68,11 @@ func TestUDPv4_Lookup(t *testing.T) {
func TestUDPv4_LookupIterator(t *testing.T) {
t.Parallel()
test := newUDPTest(t)
defer test.close()
var wg sync.WaitGroup
defer func() {
test.close()
wg.Wait()
}()
// Seed table with initial nodes.
bootnodes := make([]*enode.Node, len(lookupTestnet.dists[256]))
@ -75,7 +80,11 @@ func TestUDPv4_LookupIterator(t *testing.T) {
bootnodes[i] = lookupTestnet.node(256, i)
}
fillTable(test.table, bootnodes, true)
go serveTestnet(test, lookupTestnet)
wg.Add(1)
go func() {
serveTestnet(test, lookupTestnet)
wg.Done()
}()
// Create the iterator and collect the nodes it yields.
iter := test.udp.RandomNodes()
@ -102,7 +111,11 @@ func TestUDPv4_LookupIterator(t *testing.T) {
func TestUDPv4_LookupIteratorClose(t *testing.T) {
t.Parallel()
test := newUDPTest(t)
defer test.close()
var wg sync.WaitGroup
defer func() {
test.close()
wg.Wait()
}()
// Seed table with initial nodes.
bootnodes := make([]*enode.Node, len(lookupTestnet.dists[256]))
@ -110,7 +123,12 @@ func TestUDPv4_LookupIteratorClose(t *testing.T) {
bootnodes[i] = lookupTestnet.node(256, i)
}
fillTable(test.table, bootnodes, true)
go serveTestnet(test, lookupTestnet)
wg.Add(1)
go func() {
serveTestnet(test, lookupTestnet)
wg.Done()
}()
it := test.udp.RandomNodes()
if ok := it.Next(); !ok || it.Node() == nil {

View File

@ -496,6 +496,10 @@ func nextNode(it iterator.Iterator) *Node {
// Close flushes and closes the database files.
func (db *DB) Close() {
select {
case <-db.quit: // already closed
default:
close(db.quit)
}
db.lvl.Close()
}