add tests for present behavior

libp2p · Dec 3, 2024 · 144e7b3 · 144e7b3
1 parent fd76100
commit 144e7b3
Show file tree

Hide file tree

Showing 2 changed files with 181 additions and 6 deletions.
diff --git a/p2p/host/basic/address_service.go b/p2p/host/basic/address_service.go
@@ -34,12 +34,13 @@ type addressService struct {
 	addrsChangeChan      chan struct{}
 	addrsUpdated         chan struct{}
 	autoRelayAddrsSub    event.Subscription
-	autoRelayAddrs       func() []ma.Multiaddr
-	reachability         func() network.Reachability
-	ifaceAddrs           *interfaceAddrsCache
-	wg                   sync.WaitGroup
-	ctx                  context.Context
-	ctxCancel            context.CancelFunc
+	// There are wrapped in to functions for mocking
+	autoRelayAddrs func() []ma.Multiaddr
+	reachability   func() network.Reachability
+	ifaceAddrs     *interfaceAddrsCache
+	wg             sync.WaitGroup
+	ctx            context.Context
+	ctxCancel      context.CancelFunc
 }
 
 func NewAddressService(h *BasicHost, natmgr func(network.Network) NATManager,

diff --git a/p2p/host/basic/address_service_test.go b/p2p/host/basic/address_service_test.go
@@ -2,7 +2,10 @@ package basichost
 
 import (
 	"testing"
+	"time"
 
+	"github.com/libp2p/go-libp2p/core/network"
+	swarmt "github.com/libp2p/go-libp2p/p2p/net/swarm/testing"
 	ma "github.com/multiformats/go-multiaddr"
 	manet "github.com/multiformats/go-multiaddr/net"
 	"github.com/stretchr/testify/require"
@@ -96,3 +99,174 @@ func TestAppendNATAddrs(t *testing.T) {
 		})
 	}
 }
+
+type mockNatManager struct {
+	GetMappingFunc       func(addr ma.Multiaddr) ma.Multiaddr
+	HasDiscoveredNATFunc func() bool
+}
+
+func (m *mockNatManager) Close() error {
+	return nil
+}
+
+func (m *mockNatManager) GetMapping(addr ma.Multiaddr) ma.Multiaddr {
+	return m.GetMappingFunc(addr)
+}
+
+func (m *mockNatManager) HasDiscoveredNAT() bool {
+	return m.HasDiscoveredNATFunc()
+}
+
+var _ NATManager = &mockNatManager{}
+
+type mockObservedAddrs struct {
+	OwnObservedAddrsFunc func() []ma.Multiaddr
+	ObservedAddrsForFunc func(ma.Multiaddr) []ma.Multiaddr
+}
+
+func (m *mockObservedAddrs) OwnObservedAddrs() []ma.Multiaddr {
+	return m.OwnObservedAddrsFunc()
+}
+
+func (m *mockObservedAddrs) ObservedAddrsFor(local ma.Multiaddr) []ma.Multiaddr {
+	return m.ObservedAddrsForFunc(local)
+}
+
+func TestAddressService(t *testing.T) {
+	getAddrService := func() *addressService {
+		h, err := NewHost(swarmt.GenSwarm(t), &HostOpts{DisableIdentifyAddressDiscovery: true})
+		require.NoError(t, err)
+		t.Cleanup(func() { h.Close() })
+
+		as := h.addressService
+		return as
+	}
+
+	t.Run("NAT Address", func(t *testing.T) {
+		as := getAddrService()
+		as.natmgr = &mockNatManager{
+			HasDiscoveredNATFunc: func() bool { return true },
+			GetMappingFunc: func(addr ma.Multiaddr) ma.Multiaddr {
+				if _, err := addr.ValueForProtocol(ma.P_UDP); err == nil {
+					return ma.StringCast("/ip4/1.2.3.4/udp/1/quic-v1")
+				}
+				return nil
+			},
+		}
+		require.Contains(t, as.Addrs(), ma.StringCast("/ip4/1.2.3.4/udp/1/quic-v1"))
+	})
+
+	t.Run("NAT And Observed Address", func(t *testing.T) {
+		as := getAddrService()
+		as.natmgr = &mockNatManager{
+			HasDiscoveredNATFunc: func() bool { return true },
+			GetMappingFunc: func(addr ma.Multiaddr) ma.Multiaddr {
+				if _, err := addr.ValueForProtocol(ma.P_UDP); err == nil {
+					return ma.StringCast("/ip4/1.2.3.4/udp/1/quic-v1")
+				}
+				return nil
+			},
+		}
+		as.observedAddrsService = &mockObservedAddrs{
+			ObservedAddrsForFunc: func(addr ma.Multiaddr) []ma.Multiaddr {
+				if _, err := addr.ValueForProtocol(ma.P_TCP); err == nil {
+					return []ma.Multiaddr{ma.StringCast("/ip4/2.2.2.2/tcp/1")}
+				}
+				return nil
+			},
+		}
+		require.Contains(t, as.Addrs(), ma.StringCast("/ip4/1.2.3.4/udp/1/quic-v1"))
+		require.Contains(t, as.Addrs(), ma.StringCast("/ip4/2.2.2.2/tcp/1"))
+	})
+	t.Run("Only Observed Address", func(t *testing.T) {
+		as := getAddrService()
+		as.natmgr = nil
+		as.observedAddrsService = &mockObservedAddrs{
+			ObservedAddrsForFunc: func(addr ma.Multiaddr) []ma.Multiaddr {
+				if _, err := addr.ValueForProtocol(ma.P_TCP); err == nil {
+					return []ma.Multiaddr{ma.StringCast("/ip4/2.2.2.2/tcp/1")}
+				}
+				return nil
+			},
+			OwnObservedAddrsFunc: func() []ma.Multiaddr {
+				return []ma.Multiaddr{ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1")}
+			},
+		}
+		require.NotContains(t, as.Addrs(), ma.StringCast("/ip4/2.2.2.2/tcp/1"))
+		require.Contains(t, as.Addrs(), ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1"))
+	})
+	t.Run("Public Addrs Removed When Private", func(t *testing.T) {
+		as := getAddrService()
+		as.natmgr = nil
+		as.observedAddrsService = &mockObservedAddrs{
+			OwnObservedAddrsFunc: func() []ma.Multiaddr {
+				return []ma.Multiaddr{ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1")}
+			},
+		}
+		as.reachability = func() network.Reachability {
+			return network.ReachabilityPrivate
+		}
+		relayAddr := ma.StringCast("/ip4/1.2.3.4/udp/1/quic-v1/p2p/QmdXGaeGiVA745XorV1jr11RHxB9z4fqykm6xCUPX1aTJo/p2p-circuit")
+		as.autoRelayAddrs = func() []ma.Multiaddr {
+			return []ma.Multiaddr{relayAddr}
+		}
+		require.NotContains(t, as.Addrs(), ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1"))
+		require.Contains(t, as.Addrs(), relayAddr)
+		require.Contains(t, as.AllAddrs(), ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1"))
+	})
+
+	t.Run("AddressFactory gets relay addresses", func(t *testing.T) {
+		as := getAddrService()
+		as.natmgr = nil
+		as.observedAddrsService = &mockObservedAddrs{
+			OwnObservedAddrsFunc: func() []ma.Multiaddr {
+				return []ma.Multiaddr{ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1")}
+			},
+		}
+		as.reachability = func() network.Reachability {
+			return network.ReachabilityPrivate
+		}
+		relayAddr := ma.StringCast("/ip4/1.2.3.4/udp/1/quic-v1/p2p/QmdXGaeGiVA745XorV1jr11RHxB9z4fqykm6xCUPX1aTJo/p2p-circuit")
+		as.autoRelayAddrs = func() []ma.Multiaddr {
+			return []ma.Multiaddr{relayAddr}
+		}
+		as.addrsFactory = func(addrs []ma.Multiaddr) []ma.Multiaddr {
+			for _, a := range addrs {
+				if a.Equal(relayAddr) {
+					return []ma.Multiaddr{ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1")}
+				}
+			}
+			return nil
+		}
+		require.Contains(t, as.Addrs(), ma.StringCast("/ip4/3.3.3.3/udp/1/quic-v1"))
+		require.NotContains(t, as.Addrs(), relayAddr)
+	})
+
+	t.Run("updates addresses on signaling", func(t *testing.T) {
+		as := getAddrService()
+		as.Start()
+		as.natmgr = nil
+		updateChan := make(chan struct{})
+		a1 := ma.StringCast("/ip4/1.1.1.1/udp/1/quic-v1")
+		a2 := ma.StringCast("/ip4/1.1.1.1/tcp/1")
+		as.addrsFactory = func(addrs []ma.Multiaddr) []ma.Multiaddr {
+			select {
+			case <-updateChan:
+				return []ma.Multiaddr{a2}
+			default:
+				return []ma.Multiaddr{a1}
+			}
+		}
+		require.Contains(t, as.Addrs(), a1)
+		require.NotContains(t, as.Addrs(), a2)
+		close(updateChan)
+		as.SignalAddressChange()
+		select {
+		case <-as.AddrsUpdated():
+			require.Contains(t, as.Addrs(), a2)
+			require.NotContains(t, as.Addrs(), a1)
+		case <-time.After(2 * time.Second):
+			t.Fatal("expected addrs to be updated")
+		}
+	})
+}