From c126f37f4fe119c20320baacc4dfba1e14ef92ca Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Sun, 19 Dec 2021 14:10:51 +0400 Subject: [PATCH 1/2] speed up the autorelay test --- p2p/host/autorelay/autorelay_test.go | 93 +++++++++------------------- 1 file changed, 30 insertions(+), 63 deletions(-) diff --git a/p2p/host/autorelay/autorelay_test.go b/p2p/host/autorelay/autorelay_test.go index fe62c1d519..a500041fdf 100644 --- a/p2p/host/autorelay/autorelay_test.go +++ b/p2p/host/autorelay/autorelay_test.go @@ -24,6 +24,7 @@ import ( "github.com/ipfs/go-cid" ma "github.com/multiformats/go-multiaddr" manet "github.com/multiformats/go-multiaddr/net" + "github.com/stretchr/testify/require" ) // test specific parameters @@ -106,13 +107,9 @@ func (m *mockRouting) FindProvidersAsync(ctx context.Context, cid cid.Cid, limit return ch } -// connector func connect(t *testing.T, a, b host.Host) { pinfo := peer.AddrInfo{ID: a.ID(), Addrs: a.Addrs()} - err := b.Connect(context.Background(), pinfo) - if err != nil { - t.Fatal(err) - } + require.NoError(t, b.Connect(context.Background(), pinfo)) } // and the actual test! @@ -135,9 +132,6 @@ func isRelayAddr(addr ma.Multiaddr) bool { } func testAutoRelay(t *testing.T, useRelayv2 bool) { - ctx, cancel := context.WithCancel(context.Background()) - defer cancel() - mtab := newMockRoutingTable() makeRouting := func(h host.Host) (*mockRouting, error) { mr := newMockRouting(h, mtab) @@ -162,51 +156,34 @@ func testAutoRelay(t *testing.T, useRelayv2 bool) { } return addrs })) - if err != nil { - t.Fatal(err) - } + require.NoError(t, err) defer relayHost.Close() // instantiate the relay if useRelayv2 { r, err := relayv2.New(relayHost) - if err != nil { - t.Fatal(err) - } + require.NoError(t, err) defer r.Close() } else { r, err := relayv1.NewRelay(relayHost) - if err != nil { - t.Fatal(err) - } + require.NoError(t, err) defer r.Close() } // advertise the relay relayRouting, err := makeRouting(relayHost) - if err != nil { - t.Fatal(err) - } + require.NoError(t, err) relayDiscovery := discovery.NewRoutingDiscovery(relayRouting) - autorelay.Advertise(ctx, relayDiscovery) + autorelay.Advertise(context.Background(), relayDiscovery) // the client hosts h1, err := libp2p.New(libp2p.EnableRelay()) - if err != nil { - t.Fatal(err) - } + require.NoError(t, err) defer h1.Close() h2, err := libp2p.New(libp2p.EnableRelay(), libp2p.EnableAutoRelay(), libp2p.Routing(makePeerRouting)) - if err != nil { - t.Fatal(err) - } + require.NoError(t, err) defer h2.Close() - h3, err := libp2p.New(libp2p.EnableRelay()) - if err != nil { - t.Fatal(err) - } - defer h3.Close() // verify that we don't advertise relay addrs initially for _, addr := range h2.Addrs() { @@ -217,24 +194,27 @@ func testAutoRelay(t *testing.T, useRelayv2 bool) { // connect to AutoNAT, have it resolve to private. connect(t, h1, h2) - time.Sleep(300 * time.Millisecond) + privEmitter, _ := h2.EventBus().Emitter(new(event.EvtLocalReachabilityChanged)) privEmitter.Emit(event.EvtLocalReachabilityChanged{Reachability: network.ReachabilityPrivate}) - // Wait for detection to do its magic - time.Sleep(3000 * time.Millisecond) - // verify that we now advertise relay addrs (but not unspecific relay addrs) - unspecificRelay := ma.StringCast("/p2p-circuit") - var haveRelay bool - for _, addr := range h2.Addrs() { - if addr.Equal(unspecificRelay) { - t.Fatal("unspecific relay addr advertised") - } - if isRelayAddr(addr) { - haveRelay = true + hasRelayAddrs := func(t *testing.T, addrs []ma.Multiaddr) bool { + unspecificRelay := ma.StringCast("/p2p-circuit") + for _, addr := range addrs { + if addr.Equal(unspecificRelay) { + t.Fatal("unspecific relay addr advertised") + } + if isRelayAddr(addr) { + return true + } } + return false } - if !haveRelay { + // Wait for detection to do its magic + require.Eventually(t, func() bool { return hasRelayAddrs(t, h2.Addrs()) }, 3*time.Second, 30*time.Millisecond) + + // verify that we now advertise relay addrs (but not unspecific relay addrs) + if !hasRelayAddrs(t, h2.Addrs()) { t.Fatal("No relay addrs advertised") } @@ -245,26 +225,13 @@ func testAutoRelay(t *testing.T, useRelayv2 bool) { raddrs = append(raddrs, addr) } } - - err = h3.Connect(ctx, peer.AddrInfo{ID: h2.ID(), Addrs: raddrs}) - if err != nil { - t.Fatal(err) - } + h3, err := libp2p.New(libp2p.EnableRelay()) + require.NoError(t, err) + defer h3.Close() + require.NoError(t, h3.Connect(context.Background(), peer.AddrInfo{ID: h2.ID(), Addrs: raddrs})) // verify that we have pushed relay addrs to connected peers - haveRelay = false - for _, addr := range h1.Peerstore().Addrs(h2.ID()) { - if addr.Equal(unspecificRelay) { - t.Fatal("unspecific relay addr advertised") - } - - _, err := addr.ValueForProtocol(ma.P_CIRCUIT) - if err == nil { - haveRelay = true - } - } - - if !haveRelay { + if !hasRelayAddrs(t, h1.Peerstore().Addrs(h2.ID())) { t.Fatal("No relay addrs pushed") } } From 1beb093cb8d154c8f23c0392ebf869463fcca7ed Mon Sep 17 00:00:00 2001 From: Marten Seemann Date: Mon, 10 Jan 2022 11:37:53 +0400 Subject: [PATCH 2/2] fix flaky TestAutoRelay test --- p2p/host/autorelay/autorelay_test.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/p2p/host/autorelay/autorelay_test.go b/p2p/host/autorelay/autorelay_test.go index a500041fdf..bfe93afea6 100644 --- a/p2p/host/autorelay/autorelay_test.go +++ b/p2p/host/autorelay/autorelay_test.go @@ -40,6 +40,12 @@ type mockRoutingTable struct { peers map[peer.ID]peer.AddrInfo } +func (t *mockRoutingTable) NumPeers() int { + t.mx.Lock() + defer t.mx.Unlock() + return len(t.peers) +} + type mockRouting struct { h host.Host tab *mockRoutingTable @@ -175,6 +181,7 @@ func testAutoRelay(t *testing.T, useRelayv2 bool) { require.NoError(t, err) relayDiscovery := discovery.NewRoutingDiscovery(relayRouting) autorelay.Advertise(context.Background(), relayDiscovery) + require.Eventually(t, func() bool { return mtab.NumPeers() > 0 }, time.Second, 10*time.Millisecond) // the client hosts h1, err := libp2p.New(libp2p.EnableRelay())