go-libp2p-peerstore/test/addr_book_suite.go

package test

import (
	"testing"
	"time"

	"github.com/libp2p/go-libp2p-peer"
	ma "github.com/multiformats/go-multiaddr"

	pstore "github.com/libp2p/go-libp2p-peerstore"
)

var addressBookSuite = map[string]func(book pstore.AddrBook) func(*testing.T){
	"Addresses":            testAddresses,
	"Clear":                testClearWorks,
	"SetNegativeTTLClears": testSetNegativeTTLClears,
	"UpdateTTLs":           testUpdateTTLs,
	"NilAddrsDontBreak":    testNilAddrsDontBreak,
	"AddressesExpire":      testAddressesExpire,
}

type AddrBookFactory func() (pstore.AddrBook, func())

func TestAddrBook(t *testing.T, factory AddrBookFactory) {
	for name, test := range addressBookSuite {
		// Create a new peerstore.
		ab, closeFunc := factory()

		// Run the test.
		t.Run(name, test(ab))

		// Cleanup.
		if closeFunc != nil {
			closeFunc()
		}
	}
}

func testAddresses(m pstore.AddrBook) func(*testing.T) {
	return func(t *testing.T) {
		id1 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQN")
		id2 := IDS(t, "QmRmPL3FDZKE3Qiwv1RosLdwdvbvg17b2hB39QPScgWKKZ")
		id3 := IDS(t, "QmPhi7vBsChP7sjRoZGgg7bcKqF6MmCcQwvRbDte8aJ6Kn")
		id4 := IDS(t, "QmPhi7vBsChP7sjRoZGgg7bcKqF6MmCcQwvRbDte8aJ5Kn")
		id5 := IDS(t, "QmPhi7vBsChP7sjRoZGgg7bcKqF6MmCcQwvRbDte8aJ5Km")

		ma11 := MA(t, "/ip4/1.2.3.1/tcp/1111")
		ma21 := MA(t, "/ip4/2.2.3.2/tcp/1111")
		ma22 := MA(t, "/ip4/2.2.3.2/tcp/2222")
		ma31 := MA(t, "/ip4/3.2.3.3/tcp/1111")
		ma32 := MA(t, "/ip4/3.2.3.3/tcp/2222")
		ma33 := MA(t, "/ip4/3.2.3.3/tcp/3333")
		ma41 := MA(t, "/ip4/4.2.3.3/tcp/1111")
		ma42 := MA(t, "/ip4/4.2.3.3/tcp/2222")
		ma43 := MA(t, "/ip4/4.2.3.3/tcp/3333")
		ma44 := MA(t, "/ip4/4.2.3.3/tcp/4444")
		ma51 := MA(t, "/ip4/5.2.3.3/tcp/1111")
		ma52 := MA(t, "/ip4/5.2.3.3/tcp/2222")
		ma53 := MA(t, "/ip4/5.2.3.3/tcp/3333")
		ma54 := MA(t, "/ip4/5.2.3.3/tcp/4444")
		ma55 := MA(t, "/ip4/5.2.3.3/tcp/5555")

		ttl := time.Hour
		m.AddAddr(id1, ma11, ttl)

		m.AddAddrs(id2, []ma.Multiaddr{ma21, ma22}, ttl)
		m.AddAddrs(id2, []ma.Multiaddr{ma21, ma22}, ttl) // idempotency

		m.AddAddr(id3, ma31, ttl)
		m.AddAddr(id3, ma32, ttl)
		m.AddAddr(id3, ma33, ttl)
		m.AddAddr(id3, ma33, ttl) // idempotency
		m.AddAddr(id3, ma33, ttl)

		m.AddAddrs(id4, []ma.Multiaddr{ma41, ma42, ma43, ma44}, ttl) // multiple

		m.AddAddrs(id5, []ma.Multiaddr{ma21, ma22}, ttl)             // clearing
		m.AddAddrs(id5, []ma.Multiaddr{ma41, ma42, ma43, ma44}, ttl) // clearing
		m.ClearAddrs(id5)
		m.AddAddrs(id5, []ma.Multiaddr{ma51, ma52, ma53, ma54, ma55}, ttl) // clearing

		// test the Addresses return value
		testHas(t, []ma.Multiaddr{ma11}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma21, ma22}, m.Addrs(id2))
		testHas(t, []ma.Multiaddr{ma31, ma32, ma33}, m.Addrs(id3))
		testHas(t, []ma.Multiaddr{ma41, ma42, ma43, ma44}, m.Addrs(id4))
		testHas(t, []ma.Multiaddr{ma51, ma52, ma53, ma54, ma55}, m.Addrs(id5))
	}
}

func testClearWorks(m pstore.AddrBook) func(t *testing.T) {
	return func(t *testing.T) {
		id1 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQN")
		id2 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQM")
		ma11 := MA(t, "/ip4/1.2.3.1/tcp/1111")
		ma12 := MA(t, "/ip4/2.2.3.2/tcp/2222")
		ma13 := MA(t, "/ip4/3.2.3.3/tcp/3333")
		ma24 := MA(t, "/ip4/4.2.3.3/tcp/4444")
		ma25 := MA(t, "/ip4/5.2.3.3/tcp/5555")

		m.AddAddr(id1, ma11, time.Hour)
		m.AddAddr(id1, ma12, time.Hour)
		m.AddAddr(id1, ma13, time.Hour)
		m.AddAddr(id2, ma24, time.Hour)
		m.AddAddr(id2, ma25, time.Hour)

		testHas(t, []ma.Multiaddr{ma11, ma12, ma13}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma24, ma25}, m.Addrs(id2))

		m.ClearAddrs(id1)
		m.ClearAddrs(id2)

		testHas(t, nil, m.Addrs(id1))
		testHas(t, nil, m.Addrs(id2))
	}
}

func testSetNegativeTTLClears(m pstore.AddrBook) func(t *testing.T) {
	return func(t *testing.T) {
		id1 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQN")
		ma11 := MA(t, "/ip4/1.2.3.1/tcp/1111")

		m.SetAddr(id1, ma11, time.Hour)

		testHas(t, []ma.Multiaddr{ma11}, m.Addrs(id1))

		m.SetAddr(id1, ma11, -1)

		testHas(t, nil, m.Addrs(id1))
	}
}

func testUpdateTTLs(m pstore.AddrBook) func(t *testing.T) {
	return func(t *testing.T) {
		id1 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQN")
		id2 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQM")
		ma11 := MA(t, "/ip4/1.2.3.1/tcp/1111")
		ma12 := MA(t, "/ip4/1.2.3.1/tcp/1112")
		ma21 := MA(t, "/ip4/1.2.3.1/tcp/1121")
		ma22 := MA(t, "/ip4/1.2.3.1/tcp/1122")

		// Shouldn't panic.
		m.UpdateAddrs(id1, time.Hour, time.Minute)

		m.SetAddr(id1, ma11, time.Hour)
		m.SetAddr(id1, ma12, time.Minute)

		// Shouldn't panic.
		m.UpdateAddrs(id2, time.Hour, time.Minute)

		m.SetAddr(id2, ma21, time.Hour)
		m.SetAddr(id2, ma22, time.Minute)

		testHas(t, []ma.Multiaddr{ma11, ma12}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma21, ma22}, m.Addrs(id2))

		m.UpdateAddrs(id1, time.Hour, time.Second)

		testHas(t, []ma.Multiaddr{ma11, ma12}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma21, ma22}, m.Addrs(id2))

		time.Sleep(1200 * time.Millisecond)

		testHas(t, []ma.Multiaddr{ma12}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma21, ma22}, m.Addrs(id2))

		m.UpdateAddrs(id2, time.Hour, time.Second)

		testHas(t, []ma.Multiaddr{ma12}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma21, ma22}, m.Addrs(id2))

		time.Sleep(1200 * time.Millisecond)

		testHas(t, []ma.Multiaddr{ma12}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma22}, m.Addrs(id2))
	}
}

func testNilAddrsDontBreak(m pstore.AddrBook) func(t *testing.T) {
	return func(t *testing.T) {
		id1 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQN")
		m.SetAddr(id1, nil, time.Hour)
		m.AddAddr(id1, nil, time.Hour)
	}
}

func testAddressesExpire(m pstore.AddrBook) func(t *testing.T) {
	return func(t *testing.T) {
		id1 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQN")
		id2 := IDS(t, "QmcNstKuwBBoVTpSCSDrwzjgrRcaYXK833Psuz2EMHwyQM")
		ma11 := MA(t, "/ip4/1.2.3.1/tcp/1111")
		ma12 := MA(t, "/ip4/2.2.3.2/tcp/2222")
		ma13 := MA(t, "/ip4/3.2.3.3/tcp/3333")
		ma24 := MA(t, "/ip4/4.2.3.3/tcp/4444")
		ma25 := MA(t, "/ip4/5.2.3.3/tcp/5555")

		m.AddAddr(id1, ma11, time.Hour)
		m.AddAddr(id1, ma12, time.Hour)
		m.AddAddr(id1, ma13, time.Hour)
		m.AddAddr(id2, ma24, time.Hour)
		m.AddAddr(id2, ma25, time.Hour)

		testHas(t, []ma.Multiaddr{ma11, ma12, ma13}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma24, ma25}, m.Addrs(id2))

		m.SetAddr(id1, ma11, 2*time.Hour)
		m.SetAddr(id1, ma12, 2*time.Hour)
		m.SetAddr(id1, ma13, 2*time.Hour)
		m.SetAddr(id2, ma24, 2*time.Hour)
		m.SetAddr(id2, ma25, 2*time.Hour)

		testHas(t, []ma.Multiaddr{ma11, ma12, ma13}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma24, ma25}, m.Addrs(id2))

		m.SetAddr(id1, ma11, time.Millisecond)
		<-time.After(time.Millisecond * 5)
		testHas(t, []ma.Multiaddr{ma12, ma13}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma24, ma25}, m.Addrs(id2))

		m.SetAddr(id1, ma13, time.Millisecond)
		<-time.After(time.Millisecond * 5)
		testHas(t, []ma.Multiaddr{ma12}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma24, ma25}, m.Addrs(id2))

		m.SetAddr(id2, ma24, time.Millisecond)
		<-time.After(time.Millisecond * 5)
		testHas(t, []ma.Multiaddr{ma12}, m.Addrs(id1))
		testHas(t, []ma.Multiaddr{ma25}, m.Addrs(id2))

		m.SetAddr(id2, ma25, time.Millisecond)
		<-time.After(time.Millisecond * 5)
		testHas(t, []ma.Multiaddr{ma12}, m.Addrs(id1))
		testHas(t, nil, m.Addrs(id2))

		m.SetAddr(id1, ma12, time.Millisecond)
		<-time.After(time.Millisecond * 5)
		testHas(t, nil, m.Addrs(id1))
		testHas(t, nil, m.Addrs(id2))
	}
}

func IDS(t *testing.T, ids string) peer.ID {
	t.Helper()
	id, err := peer.IDB58Decode(ids)
	if err != nil {
		t.Fatalf("id %q is bad: %s", ids, err)
	}
	return id
}

func MA(t *testing.T, m string) ma.Multiaddr {
	t.Helper()
	maddr, err := ma.NewMultiaddr(m)
	if err != nil {
		t.Fatal(err)
	}
	return maddr
}

func testHas(t *testing.T, exp, act []ma.Multiaddr) {
	t.Helper()
	if len(exp) != len(act) {
		t.Fatalf("lengths not the same. expected %d, got %d\n", len(exp), len(act))
	}

	for _, a := range exp {
		found := false

		for _, b := range act {
			if a.Equal(b) {
				found = true
				break
			}
		}

		if !found {
			t.Fatalf("expected address %s not found", a)
		}
	}
}