github.com/myafeier/fabric@v1.0.1-0.20170722181825-3a4b1f2bce86/core/deliverservice/blocksprovider/blocksprovider_test.go

/*
Copyright IBM Corp. 2017 All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

                 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package blocksprovider

import (
	"errors"
	"sync"
	"sync/atomic"
	"testing"
	"time"

	"github.com/hyperledger/fabric/core/deliverservice/mocks"
	"github.com/hyperledger/fabric/gossip/api"
	common2 "github.com/hyperledger/fabric/gossip/common"
	"github.com/hyperledger/fabric/protos/common"
	"github.com/hyperledger/fabric/protos/orderer"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/mock"
)

func init() {
	MaxRetryDelay = time.Second
}

type mockMCS struct {
	mock.Mock
}

func (*mockMCS) GetPKIidOfCert(peerIdentity api.PeerIdentityType) common2.PKIidType {
	return common2.PKIidType("pkiID")
}

func (m *mockMCS) VerifyBlock(chainID common2.ChainID, seqNum uint64, signedBlock []byte) error {
	args := m.Called()
	if args.Get(0) != nil {
		return args.Get(0).(error)
	}
	return nil
}

func (*mockMCS) Sign(msg []byte) ([]byte, error) {
	return msg, nil
}

func (*mockMCS) Verify(peerIdentity api.PeerIdentityType, signature, message []byte) error {
	return nil
}

func (*mockMCS) VerifyByChannel(chainID common2.ChainID, peerIdentity api.PeerIdentityType, signature, message []byte) error {
	return nil
}

func (*mockMCS) ValidateIdentity(peerIdentity api.PeerIdentityType) error {
	return nil
}

type rcvFunc func(mock *mocks.MockBlocksDeliverer) (*orderer.DeliverResponse, error)

// Used to generate a simple test case to initialize delivery
// from given block sequence number.
func makeTestCase(ledgerHeight uint64, mcs api.MessageCryptoService, shouldSucceed bool, rcv rcvFunc) func(*testing.T) {
	return func(t *testing.T) {
		gossipServiceAdapter := &mocks.MockGossipServiceAdapter{GossipBlockDisseminations: make(chan uint64)}
		deliverer := &mocks.MockBlocksDeliverer{Pos: ledgerHeight}
		deliverer.MockRecv = rcv
		provider := NewBlocksProvider("***TEST_CHAINID***", deliverer, gossipServiceAdapter, mcs)
		defer provider.Stop()
		ready := make(chan struct{})
		go func() {
			go provider.DeliverBlocks()
			// Send notification
			ready <- struct{}{}
		}()

		time.Sleep(time.Second)

		assertDelivery(t, gossipServiceAdapter, deliverer, shouldSucceed)
	}
}

func assertDelivery(t *testing.T, ga *mocks.MockGossipServiceAdapter, deliverer *mocks.MockBlocksDeliverer, shouldSucceed bool) {
	// Check that all blocks received eventually get gossiped and locally committed

	select {
	case <-ga.GossipBlockDisseminations:
		if !shouldSucceed {
			assert.Fail(t, "Should not have succeede")
		}
		assert.True(t, deliverer.RecvCnt == ga.AddPayloadsCnt)
	case <-time.After(time.Second):
		if shouldSucceed {
			assert.Fail(t, "Didn't gossip a block within a timely manner")
		}
	}
}

func waitUntilOrFail(t *testing.T, pred func() bool) {
	timeout := time.Second * 30
	start := time.Now()
	limit := start.UnixNano() + timeout.Nanoseconds()
	for time.Now().UnixNano() < limit {
		if pred() {
			return
		}
		time.Sleep(timeout / 60)
	}
	assert.Fail(t, "Timeout expired!")
}

/*
   Test to check whenever blocks provider starts calling new blocks from the
   oldest and that eventually it terminates after the Stop method has been called.
*/
func TestBlocksProviderImpl_GetBlockFromTheOldest(t *testing.T) {
	mcs := &mockMCS{}
	mcs.On("VerifyBlock", mock.Anything).Return(nil)
	makeTestCase(uint64(0), mcs, true, mocks.MockRecv)(t)
}

/*
   Test to check whenever blocks provider starts calling new blocks from the
   oldest and that eventually it terminates after the Stop method has been called.
*/
func TestBlocksProviderImpl_GetBlockFromSpecified(t *testing.T) {
	mcs := &mockMCS{}
	mcs.On("VerifyBlock", mock.Anything).Return(nil)
	makeTestCase(uint64(101), mcs, true, mocks.MockRecv)(t)
}

func TestBlocksProvider_CheckTerminationDeliveryResponseStatus(t *testing.T) {
	tmp := struct{ mocks.MockBlocksDeliverer }{}

	// Making mocked Recv() function to return DeliverResponse_Status to force block
	// provider to fail and exit, checking that in that case to block was actually
	// delivered.
	tmp.MockRecv = func(mock *mocks.MockBlocksDeliverer) (*orderer.DeliverResponse, error) {
		return &orderer.DeliverResponse{
			Type: &orderer.DeliverResponse_Status{
				Status: common.Status_SUCCESS,
			},
		}, nil
	}

	gossipServiceAdapter := &mocks.MockGossipServiceAdapter{}
	provider := &blocksProviderImpl{
		chainID: "***TEST_CHAINID***",
		gossip:  gossipServiceAdapter,
		client:  &tmp,
	}

	var wg sync.WaitGroup
	wg.Add(1)

	ready := make(chan struct{})
	go func() {
		provider.DeliverBlocks()
		wg.Done()
		// Send notification
		ready <- struct{}{}
	}()

	time.Sleep(time.Duration(10) * time.Millisecond)
	provider.Stop()

	select {
	case <-ready:
		{
			assert.Equal(t, int32(1), tmp.RecvCnt)
			// No payload should commit locally
			assert.Equal(t, int32(0), gossipServiceAdapter.AddPayloadsCnt)
			// No payload should be transferred to other peers
			select {
			case <-gossipServiceAdapter.GossipBlockDisseminations:
				assert.Fail(t, "Gossiped block but shouldn't have")
			case <-time.After(time.Second):
			}
			return
		}
	case <-time.After(time.Duration(1) * time.Second):
		{
			t.Fatal("Test hasn't finished in timely manner, failing.")
		}
	}
}

func TestBlocksProvider_DeliveryWrongStatus(t *testing.T) {
	sendBlock := func(seqNum uint64) *orderer.DeliverResponse {
		return &orderer.DeliverResponse{
			Type: &orderer.DeliverResponse_Block{
				Block: &common.Block{
					Header: &common.BlockHeader{
						Number:       seqNum,
						DataHash:     []byte{},
						PreviousHash: []byte{},
					},
					Data: &common.BlockData{
						Data: [][]byte{},
					},
				}},
		}
	}
	sendStatus := func(status common.Status) *orderer.DeliverResponse {
		return &orderer.DeliverResponse{
			Type: &orderer.DeliverResponse_Status{
				Status: status,
			},
		}
	}

	bd := mocks.MockBlocksDeliverer{DisconnectCalled: make(chan struct{}, 10)}
	mcs := &mockMCS{}
	mcs.On("VerifyBlock", mock.Anything).Return(nil)
	gossipServiceAdapter := &mocks.MockGossipServiceAdapter{GossipBlockDisseminations: make(chan uint64, 2)}
	provider := &blocksProviderImpl{
		chainID:              "***TEST_CHAINID***",
		gossip:               gossipServiceAdapter,
		client:               &bd,
		mcs:                  mcs,
		wrongStatusThreshold: wrongStatusThreshold,
	}

	attempts := int32(0)
	bd.MockRecv = func(mock *mocks.MockBlocksDeliverer) (*orderer.DeliverResponse, error) {
		atomic.AddInt32(&attempts, 1)
		switch atomic.LoadInt32(&attempts) {
		case int32(1):
			return sendBlock(0), nil
		case int32(2):
			return sendStatus(common.Status_SERVICE_UNAVAILABLE), nil
		case int32(3):
			return sendStatus(common.Status_BAD_REQUEST), nil
		case int32(4):
			return sendStatus(common.Status_FORBIDDEN), nil
		case int32(5):
			return sendStatus(common.Status_NOT_FOUND), nil
		case int32(6):
			return sendStatus(common.Status_INTERNAL_SERVER_ERROR), nil
		case int32(7):
			return sendBlock(1), nil
		default:
			provider.Stop()
			return nil, errors.New("Stopping")
		}
	}

	go provider.DeliverBlocks()
	assert.Len(t, bd.DisconnectCalled, 0)
	for i := 0; i < 2; i++ {
		select {
		case seq := <-gossipServiceAdapter.GossipBlockDisseminations:
			assert.Equal(t, uint64(i), seq)
		case <-time.After(time.Second * 10):
			assert.Fail(t, "Didn't receive a block within a timely manner")
		}
	}
	// Make sure disconnect was called in between the deliveries
	assert.Len(t, bd.DisconnectCalled, 5)
}

func TestBlocksProvider_DeliveryWrongStatusClose(t *testing.T) {
	// Test emulate receive of wrong statuses from orderer
	// Once test get sequence of wrongStatusThreshold (5) FORBIDDEN or BAD_REQUEST statuses,
	// it stop blocks deliver go routine
	// At start is sends all 5 statuses and check is each one of them caused disconnect and reconnect
	// but blocks deliver still running
	// At next step it sends 2 FORBIDDEN or BAD_REQUEST statuses, followed by SERVICE_UNAVAILABLE
	// and 4 more FORBIDDEN or BAD_REQUEST statuses. It checks if enough disconnects called, but
	// blocks deliver still running
	// At the end, it send 2 FORBIDDEN or BAD_REQUEST statuses and check is blocks deliver stopped

	sendStatus := func(status common.Status) *orderer.DeliverResponse {
		return &orderer.DeliverResponse{
			Type: &orderer.DeliverResponse_Status{
				Status: status,
			},
		}
	}

	bd := mocks.MockBlocksDeliverer{DisconnectCalled: make(chan struct{}, 100), CloseCalled: make(chan struct{}, 1)}
	mcs := &mockMCS{}
	mcs.On("VerifyBlock", mock.Anything).Return(nil)
	gossipServiceAdapter := &mocks.MockGossipServiceAdapter{GossipBlockDisseminations: make(chan uint64, 2)}
	provider := &blocksProviderImpl{
		chainID:              "***TEST_CHAINID***",
		gossip:               gossipServiceAdapter,
		client:               &bd,
		mcs:                  mcs,
		wrongStatusThreshold: 5,
	}

	incomingMsgs := make(chan *orderer.DeliverResponse)

	bd.MockRecv = func(mock *mocks.MockBlocksDeliverer) (*orderer.DeliverResponse, error) {
		inMsg := <-incomingMsgs
		return inMsg, nil
	}

	go provider.DeliverBlocks()

	incomingMsgs <- sendStatus(common.Status_SERVICE_UNAVAILABLE)
	incomingMsgs <- sendStatus(common.Status_BAD_REQUEST)
	incomingMsgs <- sendStatus(common.Status_FORBIDDEN)
	incomingMsgs <- sendStatus(common.Status_NOT_FOUND)
	incomingMsgs <- sendStatus(common.Status_INTERNAL_SERVER_ERROR)

	waitUntilOrFail(t, func() bool {
		return len(bd.DisconnectCalled) == 5
	})

	waitUntilOrFail(t, func() bool {
		return len(bd.CloseCalled) == 0
	})

	incomingMsgs <- sendStatus(common.Status_FORBIDDEN)
	incomingMsgs <- sendStatus(common.Status_BAD_REQUEST)
	incomingMsgs <- sendStatus(common.Status_SERVICE_UNAVAILABLE)
	incomingMsgs <- sendStatus(common.Status_FORBIDDEN)
	incomingMsgs <- sendStatus(common.Status_BAD_REQUEST)
	incomingMsgs <- sendStatus(common.Status_FORBIDDEN)
	incomingMsgs <- sendStatus(common.Status_BAD_REQUEST)

	waitUntilOrFail(t, func() bool {
		return len(bd.DisconnectCalled) == 12
	})

	waitUntilOrFail(t, func() bool {
		return len(bd.CloseCalled) == 0
	})

	incomingMsgs <- sendStatus(common.Status_BAD_REQUEST)
	incomingMsgs <- sendStatus(common.Status_FORBIDDEN)

	waitUntilOrFail(t, func() bool {
		return len(bd.CloseCalled) == 1
	})
}

func TestBlockFetchFailure(t *testing.T) {
	rcvr := func(mock *mocks.MockBlocksDeliverer) (*orderer.DeliverResponse, error) {
		return nil, errors.New("Failed fetching block")
	}
	mcs := &mockMCS{}
	mcs.On("VerifyBlock", mock.Anything).Return(nil)
	makeTestCase(uint64(0), mcs, false, rcvr)(t)
}

func TestBlockVerificationFailure(t *testing.T) {
	attempts := int32(0)
	rcvr := func(mock *mocks.MockBlocksDeliverer) (*orderer.DeliverResponse, error) {
		if atomic.LoadInt32(&attempts) == int32(1) {
			return &orderer.DeliverResponse{
				Type: &orderer.DeliverResponse_Status{
					Status: common.Status_SUCCESS,
				},
			}, nil
		}
		atomic.AddInt32(&attempts, int32(1))
		return &orderer.DeliverResponse{
			Type: &orderer.DeliverResponse_Block{
				Block: &common.Block{
					Header: &common.BlockHeader{
						Number:       0,
						DataHash:     []byte{},
						PreviousHash: []byte{},
					},
					Data: &common.BlockData{
						Data: [][]byte{},
					},
				}},
		}, nil
	}
	mcs := &mockMCS{}
	mcs.On("VerifyBlock", mock.Anything).Return(errors.New("Invalid signature"))
	makeTestCase(uint64(0), mcs, false, rcvr)(t)
}