Skip to content

Commit

Permalink
(fixup) Generate EnvelopeSender mock and use it for improving test
Browse files Browse the repository at this point in the history
  • Loading branch information
@tnasu
tnasu committed Jul 21, 2023
1 parent 5e6aed2 commit 8cc8ef6
Show file tree
Hide file tree
Showing 6 changed files with 100 additions and 56 deletions.
21 changes: 13 additions & 8 deletions evidence/reactor_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ import (
"github.com/Finschia/ostracon/types"
)

type Peer struct {
*p2pmocks.Peer
*p2pmocks.EnvelopeSender
}

var (
numEvidence = 10
timeout = 120 * time.Second // ridiculously high because CircleCI is slow
Expand Down Expand Up @@ -200,24 +205,24 @@ func TestReactorBroadcastEvidenceMemoryLeak(t *testing.T) {
pool, err := evidence.NewPool(evidenceDB, stateStore, blockStore)
require.NoError(t, err)

p := &p2pmocks.Peer{}
p := &Peer{Peer: &p2pmocks.Peer{}, EnvelopeSender: &p2pmocks.EnvelopeSender{}}

p.On("IsRunning").Once().Return(true)
p.On("IsRunning").Return(false)
p.Peer.On("IsRunning").Once().Return(true)
p.Peer.On("IsRunning").Return(false)
// check that we are not leaking any go-routines
// i.e. broadcastEvidenceRoutine finishes when peer is stopped
defer leaktest.CheckTimeout(t, 10*time.Second)()

p.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
p.EnvelopeSender.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
e, ok := i.(p2p.Envelope)
return ok && e.ChannelID == evidence.EvidenceChannel
})).Return(false)
quitChan := make(<-chan struct{})
p.On("Quit").Return(quitChan)
p.Peer.On("Quit").Return(quitChan)
ps := peerState{2}
p.On("Get", types.PeerStateKey).Return(ps)
p.On("ID").Return("ABC")
p.On("String").Return("mock")
p.Peer.On("Get", types.PeerStateKey).Return(ps)
p.Peer.On("ID").Return("ABC")
p.Peer.On("String").Return("mock")

r := evidence.NewReactor(pool, config.P2P.RecvAsync, config.P2P.EvidenceRecvBufSize)
r.SetLogger(log.TestingLogger())
Expand Down
55 changes: 55 additions & 0 deletions p2p/mocks/envelope_sender.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 0 additions & 28 deletions p2p/mocks/peer.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions p2p/peer.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
)

//go:generate ../scripts/mockery_generate.sh Peer
//go:generate ../scripts/mockery_generate.sh EnvelopeSender

const metricsTickerDuration = 10 * time.Second

Expand Down
23 changes: 15 additions & 8 deletions statesync/reactor_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ import (
"github.com/Finschia/ostracon/version"
)

type Peer struct {
*p2pmocks.Peer
*p2pmocks.EnvelopeSender
}

func TestReactor_Receive_ChunkRequest(t *testing.T) {
testcases := map[string]struct {
request *ssproto.ChunkRequest
Expand Down Expand Up @@ -59,11 +64,11 @@ func TestReactor_Receive_ChunkRequest(t *testing.T) {
}).Return(&abci.ResponseLoadSnapshotChunk{Chunk: tc.chunk}, nil)

// Mock peer to store response, if found
peer := &p2pmocks.Peer{}
peer.On("ID").Return(p2p.ID("id"))
peer := &Peer{Peer: &p2pmocks.Peer{}, EnvelopeSender: &p2pmocks.EnvelopeSender{}}
peer.Peer.On("ID").Return(p2p.ID("id"))
var response *ssproto.ChunkResponse
if tc.expectResponse != nil {
peer.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
peer.EnvelopeSender.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
e, ok := i.(p2p.Envelope)
return ok && e.ChannelID == ChunkChannel
})).Run(func(args mock.Arguments) {
Expand Down Expand Up @@ -98,7 +103,8 @@ func TestReactor_Receive_ChunkRequest(t *testing.T) {
assert.Equal(t, tc.expectResponse, response)

conn.AssertExpectations(t)
peer.AssertExpectations(t)
peer.Peer.AssertExpectations(t)
peer.EnvelopeSender.AssertExpectations(t)
})
}
}
Expand Down Expand Up @@ -150,10 +156,10 @@ func TestReactor_Receive_SnapshotsRequest(t *testing.T) {

// Mock peer to catch responses and store them in a slice
responses := []*ssproto.SnapshotsResponse{}
peer := &p2pmocks.Peer{}
peer := &Peer{Peer: &p2pmocks.Peer{}, EnvelopeSender: &p2pmocks.EnvelopeSender{}}
if len(tc.expectResponses) > 0 {
peer.On("ID").Return(p2p.ID("id"))
peer.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
peer.Peer.On("ID").Return(p2p.ID("id"))
peer.EnvelopeSender.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
e, ok := i.(p2p.Envelope)
return ok && e.ChannelID == SnapshotChannel
})).Run(func(args mock.Arguments) {
Expand Down Expand Up @@ -188,7 +194,8 @@ func TestReactor_Receive_SnapshotsRequest(t *testing.T) {
assert.Equal(t, tc.expectResponses, responses)

conn.AssertExpectations(t)
peer.AssertExpectations(t)
peer.Peer.AssertExpectations(t)
peer.EnvelopeSender.AssertExpectations(t)
})
}
}
Expand Down
28 changes: 16 additions & 12 deletions statesync/syncer_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ func TestSyncer_SyncAny(t *testing.T) {
require.Error(t, err)

// Adding a couple of peers should trigger snapshot discovery messages
peerA := &p2pmocks.Peer{}
peerA.On("ID").Return(p2p.ID("a"))
peerA.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
peerA := &Peer{Peer: &p2pmocks.Peer{}, EnvelopeSender: &p2pmocks.EnvelopeSender{}}
peerA.Peer.On("ID").Return(p2p.ID("a"))
peerA.EnvelopeSender.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
e, ok := i.(p2p.Envelope)
if !ok {
return false
Expand All @@ -111,11 +111,12 @@ func TestSyncer_SyncAny(t *testing.T) {
return ok && e.ChannelID == SnapshotChannel && req != nil
})).Return(true)
syncer.AddPeer(peerA)
peerA.AssertExpectations(t)
peerA.Peer.AssertExpectations(t)
peerA.EnvelopeSender.AssertExpectations(t)

peerB := &p2pmocks.Peer{}
peerB.On("ID").Return(p2p.ID("b"))
peerB.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
peerB := &Peer{Peer: &p2pmocks.Peer{}, EnvelopeSender: &p2pmocks.EnvelopeSender{}}
peerB.Peer.On("ID").Return(p2p.ID("b"))
peerB.EnvelopeSender.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
e, ok := i.(p2p.Envelope)
if !ok {
return false
Expand All @@ -124,7 +125,8 @@ func TestSyncer_SyncAny(t *testing.T) {
return ok && e.ChannelID == SnapshotChannel && req != nil
})).Return(true)
syncer.AddPeer(peerB)
peerB.AssertExpectations(t)
peerB.Peer.AssertExpectations(t)
peerB.EnvelopeSender.AssertExpectations(t)

// Both peers report back with snapshots. One of them also returns a snapshot we don't want, in
// format 2, which will be rejected by the ABCI application.
Expand Down Expand Up @@ -180,11 +182,11 @@ func TestSyncer_SyncAny(t *testing.T) {
chunkRequests[msg.Index]++
chunkRequestsMtx.Unlock()
}
peerA.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
peerA.EnvelopeSender.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
e, ok := i.(p2p.Envelope)
return ok && e.ChannelID == ChunkChannel
})).Maybe().Run(onChunkRequest).Return(true)
peerB.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
peerB.EnvelopeSender.On("SendEnvelope", mock.MatchedBy(func(i interface{}) bool {
e, ok := i.(p2p.Envelope)
return ok && e.ChannelID == ChunkChannel
})).Maybe().Run(onChunkRequest).Return(true)
Expand Down Expand Up @@ -233,8 +235,10 @@ func TestSyncer_SyncAny(t *testing.T) {

connSnapshot.AssertExpectations(t)
connQuery.AssertExpectations(t)
peerA.AssertExpectations(t)
peerB.AssertExpectations(t)
peerA.Peer.AssertExpectations(t)
peerA.EnvelopeSender.AssertExpectations(t)
peerB.Peer.AssertExpectations(t)
peerB.EnvelopeSender.AssertExpectations(t)
}

func TestSyncer_SyncAny_noSnapshots(t *testing.T) {
Expand Down

0 comments on commit 8cc8ef6

Please sign in to comment.