ceremonyclient/go-libp2p-kad-dht/rtrefresh/rt_refresh_manager_test.go

package rtrefresh

import (
	"context"
	"strconv"
	"testing"
	"time"

	"github.com/libp2p/go-libp2p/core/test"

	kb "github.com/libp2p/go-libp2p-kbucket"
	pstore "github.com/libp2p/go-libp2p/p2p/host/peerstore"

	"github.com/stretchr/testify/require"
)

func TestSkipRefreshOnGapCpls(t *testing.T) {
	t.Skip("This test is flaky, see https://github.com/libp2p/go-libp2p-kad-dht/issues/722.")

	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	local := test.RandPeerIDFatal(t)

	// adds a peer for a cpl.
	// The "ignoreCpl" is the cpl for which we assume we have no peers in the network.
	// So. if the query function gets a "key" which is basically tha stringed version of the "ignoreCpl",
	// we return without adding any peers for it to the Routing Table.
	qFuncWithIgnore := func(rt *kb.RoutingTable, ignoreCpl uint) func(c context.Context, key string) error {
		return func(c context.Context, key string) error {
			if key == string(local) {
				return nil
			}

			u, err := strconv.ParseInt(key, 10, 64)
			require.NoError(t, err)

			if uint(u) == ignoreCpl {
				return nil
			}

			p, err := rt.GenRandPeerID(uint(u))
			require.NoError(t, err)
			b, err := rt.TryAddPeer(p, true, false)
			require.NoError(t, err)
			require.True(t, b)
			return nil
		}
	}

	// We use the cpl as the key for the query. So, the cpl -> key transformation function
	// basically just converts the uint cpl to a string key using the strconv lib.
	kfnc := func(cpl uint) (string, error) {
		return strconv.FormatInt(int64(cpl), 10), nil
	}

	// when 2*gapcpl < maxCpl
	// gap is 2 and max is 10
	rt, err := kb.NewRoutingTable(2, kb.ConvertPeerID(local), time.Hour, pstore.NewMetrics(), 100*time.Hour, nil)
	require.NoError(t, err)
	r := &RtRefreshManager{ctx: ctx, rt: rt, refreshKeyGenFnc: kfnc, dhtPeerId: local}
	icpl := uint(2)
	lastCpl := 2 * (icpl + 1)
	p, err := rt.GenRandPeerID(10)
	require.NoError(t, err)
	b, _ := rt.TryAddPeer(p, true, false)
	require.True(t, b)
	r.refreshQueryFnc = qFuncWithIgnore(rt, icpl)
	require.NoError(t, r.doRefresh(ctx, true))

	for i := uint(0); i < lastCpl+1; i++ {
		if i == icpl {
			require.Equal(t, 0, rt.NPeersForCpl(i))
			continue
		}
		require.Equal(t, 1, rt.NPeersForCpl(uint(i)))
	}
	for i := lastCpl + 1; i < 10; i++ {
		require.Equal(t, 0, rt.NPeersForCpl(i))
	}

	// when 2 * (gapcpl + 1) > maxCpl
	rt, err = kb.NewRoutingTable(2, kb.ConvertPeerID(local), time.Hour, pstore.NewMetrics(), 100*time.Hour, nil)
	require.NoError(t, err)
	r = &RtRefreshManager{ctx: ctx, rt: rt, refreshKeyGenFnc: kfnc, dhtPeerId: local}
	icpl = uint(6)
	p, err = rt.GenRandPeerID(10)
	require.NoError(t, err)
	b, _ = rt.TryAddPeer(p, true, false)
	require.True(t, b)
	r.refreshQueryFnc = qFuncWithIgnore(rt, icpl)
	require.NoError(t, r.doRefresh(ctx, true))

	for i := uint(0); i < 10; i++ {
		if i == icpl {
			require.Equal(t, 0, rt.NPeersForCpl(i))
			continue
		}

		require.Equal(t, 1, rt.NPeersForCpl(uint(i)))
	}
	require.Equal(t, 2, rt.NPeersForCpl(10))
}