add test for api/blocklistener.go and api/listener.go (iotexproject#2307)

improve testcoverage in api package (iotexproject#1581)

* Add test for api/listener.go

* Add test for api/blocklistener.go

* Modify irregular names

* simplify code and add an error catch

Author: newyear6565

api/apitestserver.go

@@ -0,0 +1,18 @@
+// Copyright (c) 2019 IoTeX Foundation
+// This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no
+// warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent
+// permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache
+// License 2.0 that can be found in the LICENSE file.
+
+package api
+
+import (
+	grpc "google.golang.org/grpc"
+	"github.com/iotexproject/iotex-proto/golang/iotexapi"
+)
+
+// StreamBlocksServer defines the interface of a rpc stream server
+type StreamBlocksServer interface {
+	Send(*iotexapi.StreamBlocksResponse) error
+	grpc.ServerStream
+}

api/blocklistener_test.go

@@ -0,0 +1,62 @@
+// Copyright (c) 2019 IoTeX Foundation
+// This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no
+// warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent
+// permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache
+// License 2.0 that can be found in the LICENSE file.
+
+package api
+
+import (
+	"errors"
+	"testing"
+	"time"
+
+	"github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/require"
+
+	"github.com/iotexproject/iotex-core/action"
+	"github.com/iotexproject/iotex-core/blockchain/block"
+	"github.com/iotexproject/iotex-core/test/identityset"
+	"github.com/iotexproject/iotex-core/test/mock/mock_apiserver"
+)
+
+var (
+	errorSend error = errors.New("send error")
+)
+
+func TestBlockListener(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	errChan := make(chan error, 10)
+
+	server := mock_apiserver.NewMockStreamBlocksServer(ctrl)
+	responder := NewBlockListener(server, errChan)
+
+	receipts := []*action.Receipt{
+		{
+			BlockHeight: 1,
+		},
+		{
+			BlockHeight: 2,
+		},
+	}
+	builder := block.NewTestingBuilder().
+		SetHeight(1).
+		SetVersion(111).
+		SetTimeStamp(time.Now()).
+		SetReceipts(receipts)
+	testBlock, err := builder.SignAndBuild(identityset.PrivateKey(0))
+	require.NoError(t, err)
+
+	server.EXPECT().Send(gomock.Any()).Return(nil).Times(1)
+	require.NoError(t, responder.Respond(&testBlock))
+
+	server.EXPECT().Send(gomock.Any()).Return(errorSend).Times(1)
+	require.Equal(t, errorSend, responder.Respond(&testBlock))
+
+	responder.Exit()
+
+	require.Equal(t, errorSend, <-errChan)
+	require.NoError(t, <-errChan)
+}

api/listener.go

@@ -9,13 +9,11 @@ import (
 	"github.com/iotexproject/iotex-core/blockchain/block"
 )
 
-type (
-	// Responder responds to new block
-	Responder interface {
-		Respond(*block.Block) error
-		Exit()
-	}
+var (
+	errorResponderAdded = errors.New("Responder already added")
+)
 
+type (
 	// Listener pass new block to all responders
 	Listener interface {
 		Start() error
@@ -75,7 +73,7 @@ func (cl *chainListener) ReceiveBlock(blk *block.Block) error {
 func (cl *chainListener) AddResponder(r Responder) error {
 	_, loaded := cl.streamMap.LoadOrStore(r, struct{}{})
 	if loaded {
-		return errors.New("Responder already added")
+		return errorResponderAdded
 	}
 	return nil
 }

api/listener_test.go

@@ -0,0 +1,60 @@
+// Copyright (c) 2019 IoTeX Foundation
+// This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no
+// warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent
+// permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache
+// License 2.0 that can be found in the LICENSE file.
+
+package api
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"github.com/pkg/errors"
+	"github.com/stretchr/testify/require"
+
+	"github.com/iotexproject/iotex-core/blockchain/block"
+	"github.com/iotexproject/iotex-core/test/mock/mock_apiresponder"
+)
+
+// test for chainListener
+func TestChainListener(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	responder := mock_apiresponder.NewMockResponder(ctrl)
+	listener := NewChainListener()
+
+	err := listener.Start()
+	require.NoError(t, err)
+
+	err = listener.Stop()
+	require.NoError(t, err)
+
+	err = listener.AddResponder(responder)
+	require.NoError(t, err)
+
+	err = listener.AddResponder(responder)
+	require.Error(t, err)
+	require.Equal(t, errorResponderAdded, err)
+
+	block := &block.Block{
+		Header: block.Header{},
+		Body:   block.Body{},
+		Footer: block.Footer{},
+	}
+	responder.EXPECT().Respond(gomock.Any()).Return(nil).Times(1)
+	err = listener.ReceiveBlock(block)
+	require.NoError(t, err)
+
+	expectedError := errors.New("Error when streaming the block")
+	responder.EXPECT().Respond(gomock.Any()).Return(expectedError).Times(1)
+	err = listener.ReceiveBlock(block)
+	require.NoError(t, err)
+
+	responder.EXPECT().Exit().Return().Times(1)
+	err = listener.AddResponder(responder)
+	require.NoError(t, err)
+	err = listener.Stop()
+	require.NoError(t, err)
+}

api/responder.go

@@ -0,0 +1,17 @@
+// Copyright (c) 2019 IoTeX Foundation
+// This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no
+// warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent
+// permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache
+// License 2.0 that can be found in the LICENSE file.
+
+package api
+
+import (
+	"github.com/iotexproject/iotex-core/blockchain/block"
+)
+
+// Responder responds to new block
+type Responder interface {
+	Respond(*block.Block) error
+	Exit()
+}

misc/scripts/mockgen.sh

@@ -122,3 +122,15 @@ mockgen -destination=./test/mock/mock_ioctlclient/mock_ioctlclient.go  \
         -source=./ioctl/client.go \
         -package=mock_ioctlclient \
         Client
+
+mkdir -p ./test/mock/mock_apiresponder
+mockgen -destination=./test/mock/mock_apiresponder/mock_apiresponder.go  \
+        -source=./api/responder.go \
+        -package=mock_apiresponder \
+        Responder
+
+mkdir -p ./test/mock/mock_apiserver
+mockgen -destination=./test/mock/mock_apiserver/mock_apiserver.go  \
+        -source=./api/apitestserver.go \
+        -package=mock_apiserver \
+        StreamBlocksServer