Skip to content

Add ping uptimes test #1550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 27, 2023
Merged

Add ping uptimes test #1550

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e453164
add ping tests
ceyonur May 25, 2023
bab325e
use require zero
ceyonur May 25, 2023
7f1c3fc
Merge branch 'dev' into ping-tests
hexfusion May 25, 2023
ade7185
Merge branch 'dev' into ping-tests
StephenButtolph May 26, 2023
8a1a3f3
nits
StephenButtolph May 26, 2023
7b5dbe8
clarify test
StephenButtolph May 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 140 additions & 9 deletions network/peer/peer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"github.com/ava-labs/avalanchego/proto/pb/p2p"
"github.com/ava-labs/avalanchego/snow/networking/router"
"github.com/ava-labs/avalanchego/snow/networking/tracker"
"github.com/ava-labs/avalanchego/snow/uptime"
"github.com/ava-labs/avalanchego/snow/validators"
"github.com/ava-labs/avalanchego/staking"
"github.com/ava-labs/avalanchego/utils/constants"
Expand Down Expand Up @@ -60,7 +61,7 @@ func newMessageCreator(t *testing.T) message.Creator {
return mc
}

func makeRawTestPeers(t *testing.T) (*rawTestPeer, *rawTestPeer) {
func makeRawTestPeers(t *testing.T, trackedSubnets set.Set[ids.ID]) (*rawTestPeer, *rawTestPeer) {
t.Helper()
require := require.New(t)

Expand Down Expand Up @@ -98,7 +99,8 @@ func makeRawTestPeers(t *testing.T) (*rawTestPeer, *rawTestPeer) {
Log: logging.NoLog{},
InboundMsgThrottler: throttling.NewNoInboundThrottler(),
VersionCompatibility: version.GetCompatibility(constants.LocalID),
MySubnets: set.Set[ids.ID]{},
MySubnets: trackedSubnets,
UptimeCalculator: uptime.NoOpCalculator,
Beacons: validators.NewSet(),
NetworkID: constants.LocalID,
PingFrequency: constants.DefaultPingFrequency,
Expand Down Expand Up @@ -146,8 +148,8 @@ func makeRawTestPeers(t *testing.T) (*rawTestPeer, *rawTestPeer) {
return peer0, peer1
}

func makeTestPeers(t *testing.T) (*testPeer, *testPeer) {
rawPeer0, rawPeer1 := makeRawTestPeers(t)
func makeTestPeers(t *testing.T, trackedSubnets set.Set[ids.ID]) (*testPeer, *testPeer) {
rawPeer0, rawPeer1 := makeRawTestPeers(t, trackedSubnets)

peer0 := &testPeer{
Peer: Start(
Expand Down Expand Up @@ -182,11 +184,11 @@ func makeTestPeers(t *testing.T) (*testPeer, *testPeer) {
return peer0, peer1
}

func makeReadyTestPeers(t *testing.T) (*testPeer, *testPeer) {
func makeReadyTestPeers(t *testing.T, trackedSubnets set.Set[ids.ID]) (*testPeer, *testPeer) {
t.Helper()
require := require.New(t)

peer0, peer1 := makeTestPeers(t)
peer0, peer1 := makeTestPeers(t, trackedSubnets)

err := peer0.AwaitReady(context.Background())
require.NoError(err)
Expand All @@ -204,8 +206,7 @@ func makeReadyTestPeers(t *testing.T) (*testPeer, *testPeer) {
func TestReady(t *testing.T) {
require := require.New(t)

rawPeer0, rawPeer1 := makeRawTestPeers(t)

rawPeer0, rawPeer1 := makeRawTestPeers(t, set.Set[ids.ID]{})
peer0 := Start(
rawPeer0.config,
rawPeer0.conn,
Expand Down Expand Up @@ -255,7 +256,7 @@ func TestReady(t *testing.T) {
func TestSend(t *testing.T) {
require := require.New(t)

peer0, peer1 := makeReadyTestPeers(t)
peer0, peer1 := makeReadyTestPeers(t, set.Set[ids.ID]{})
mc := newMessageCreator(t)

outboundGetMsg, err := mc.Get(ids.Empty, 1, time.Second, ids.Empty, p2p.EngineType_ENGINE_TYPE_SNOWMAN)
Expand All @@ -273,3 +274,133 @@ func TestSend(t *testing.T) {
err = peer1.AwaitClosed(context.Background())
require.NoError(err)
}

func TestPingUptimes(t *testing.T) {
trackedSubnetID := ids.GenerateTestID()
untrackedSubnetID := ids.GenerateTestID()

trackedSubnets := set.NewSet[ids.ID](1)
trackedSubnets.Add(trackedSubnetID)

mc := newMessageCreator(t)

testCases := []struct {
name string
msg message.OutboundMessage
shouldClose bool
assertFn func(*require.Assertions, *testPeer)
}{
{
name: "primary network only",
msg: func() message.OutboundMessage {
pingMsg, err := mc.Ping(1, nil)
require.NoError(t, err)
return pingMsg
}(),
assertFn: func(require *require.Assertions, peer *testPeer) {
uptime, ok := peer.ObservedUptime(constants.PrimaryNetworkID)
require.True(ok)
require.Equal(uint32(1), uptime)

uptime, ok = peer.ObservedUptime(trackedSubnetID)
require.False(ok)
require.Zero(uptime)
},
},
{
name: "primary network and subnet",
msg: func() message.OutboundMessage {
pingMsg, err := mc.Ping(
1,
[]*p2p.SubnetUptime{
{
SubnetId: trackedSubnetID[:],
Uptime: 1,
},
},
)
require.NoError(t, err)
return pingMsg
}(),
assertFn: func(require *require.Assertions, peer *testPeer) {
uptime, ok := peer.ObservedUptime(constants.PrimaryNetworkID)
require.True(ok)
require.Equal(uint32(1), uptime)

uptime, ok = peer.ObservedUptime(trackedSubnetID)
require.True(ok)
require.Equal(uint32(1), uptime)
},
},
{
name: "primary network and non tracked subnet",
msg: func() message.OutboundMessage {
pingMsg, err := mc.Ping(
1,
[]*p2p.SubnetUptime{
{
// Providing the untrackedSubnetID here should cause
// the remote peer to disconnect from us.
SubnetId: untrackedSubnetID[:],
Uptime: 1,
},
{
SubnetId: trackedSubnetID[:],
Uptime: 1,
},
},
)
require.NoError(t, err)
return pingMsg
}(),
shouldClose: true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this test doesn't assertFn anything, because the peer should be closing... so the state doesn't really matter.

},
}

// Note: we reuse peers across tests because makeReadyTestPeers takes awhile
// to run.
peer0, peer1 := makeReadyTestPeers(t, trackedSubnets)
defer func() {
peer1.StartClose()
peer0.StartClose()
require.NoError(t, peer0.AwaitClosed(context.Background()))
require.NoError(t, peer1.AwaitClosed(context.Background()))
}()

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
require := require.New(t)

require.True(peer0.Send(context.Background(), tc.msg))

// Note: shouldClose can only be `true` for the last test because
// we reuse peers across tests.
if tc.shouldClose {
require.NoError(peer1.AwaitClosed(context.Background()))
return
}

// we send Get message after ping to ensure Ping is handled by the
// time Get is handled. This is because Get is routed to the handler
// whereas Ping is handled by the peer directly. We have no way to
// know when the peer has handled the Ping message.
sendAndFlush(t, peer0, peer1)

tc.assertFn(require, peer1)
})
}
}

// Helper to send a message from sender to receiver and assert that the
// receiver receives the message. This can be used to test a prior message
// was handled by the peer.
func sendAndFlush(t *testing.T, sender *testPeer, receiver *testPeer) {
t.Helper()
mc := newMessageCreator(t)
outboundGetMsg, err := mc.Get(ids.Empty, 1, time.Second, ids.Empty, p2p.EngineType_ENGINE_TYPE_SNOWMAN)
require.NoError(t, err)
sent := sender.Send(context.Background(), outboundGetMsg)
require.True(t, sent)
inboundGetMsg := <-receiver.inboundMsgChan
require.Equal(t, message.GetOp, inboundGetMsg.Op())
}