Skip to content
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.

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

add unit test for common/deliverclient/blocksprovider/delivery_requester #4798

Merged
merged 2 commits into from
Apr 17, 2024
Merged
Changes from all commits
Commits
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
198 changes: 198 additions & 0 deletions common/deliverclient/blocksprovider/delivery_requester_test.go
Copy link
Contributor

@tock-ibm tock-ibm Apr 17, 2024

Choose a reason for hiding this comment

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

@solo-daemon
First of all thanks for this contribution!
This style of "fake mocks" based testing is good. The deliverer and bft_deliverer are tested this way. I will accept all the tests written here.
However, the issue calls for a more explicit style of testing - against a real gRPC service (a mockup for testing, not a real orderer).
See for example how it's done here: orderer/common/cluster/deliver_test.go where there is a deliverServer that implements the "Deliver" API. You can copy the deliverServer from there, and run the DeliveryRequester against it.

Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
/*
Copyright IBM Corp. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0
*/

package blocksprovider_test

import (
"testing"

"github.com/hyperledger/fabric-protos-go/common"
"github.com/hyperledger/fabric/common/deliverclient/blocksprovider"
"github.com/hyperledger/fabric/common/deliverclient/blocksprovider/fake"
"github.com/hyperledger/fabric/common/deliverclient/orderers"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"google.golang.org/grpc"
"google.golang.org/grpc/connectivity"
"google.golang.org/grpc/credentials/insecure"
)

func TestDeliveryRequester_Connect_Success(t *testing.T) {
fakeSigner := &fake.Signer{}
fakeSigner.SignReturns([]byte("good-sig"), nil)

fakeDialer := &fake.Dialer{}
cc := &grpc.ClientConn{}
fakeDialer.DialReturns(cc, nil)

fakeDeliverClient := &fake.DeliverClient{}
fakeDeliverClient.SendReturns(nil)

fakeDeliverStreamer := &fake.DeliverStreamer{}
fakeDeliverStreamer.DeliverReturns(fakeDeliverClient, nil)

dr := blocksprovider.NewDeliveryRequester("channel-id", fakeSigner, []byte("tls-cert-hash"), fakeDialer, fakeDeliverStreamer)
assert.NotNil(t, dr)

seekInfoEnv := &common.Envelope{}
endpoint := &orderers.Endpoint{
Address: "orderer-address-1",
RootCerts: [][]byte{[]byte("root-cert")},
Refreshed: make(chan struct{}),
}

deliverClient, cancelFunc, err := dr.Connect(seekInfoEnv, endpoint)
assert.NoError(t, err)
assert.NotNil(t, deliverClient)
assert.NotNil(t, cancelFunc)
}

func TestDeliveryRequester_Connect_DialerError(t *testing.T) {
fakeSigner := &fake.Signer{}
fakeSigner.SignReturns([]byte("good-sig"), nil)

fakeDialer := &fake.Dialer{}
dialError := errors.New("dialer-error")
fakeDialer.DialReturns(nil, dialError)

fakeDeliverClient := &fake.DeliverClient{}
fakeDeliverClient.SendReturns(nil)

fakeDeliverStreamer := &fake.DeliverStreamer{}
fakeDeliverStreamer.DeliverReturns(fakeDeliverClient, nil)

dr := blocksprovider.NewDeliveryRequester("channel-id", fakeSigner, []byte("tls-cert-hash"), fakeDialer, fakeDeliverStreamer)
assert.NotNil(t, dr)

seekInfoEnv := &common.Envelope{}
endpoint := &orderers.Endpoint{
Address: "orderer-address-1",
RootCerts: [][]byte{[]byte("root-cert")},
Refreshed: make(chan struct{}),
}

deliverClient, cancelFunc, err := dr.Connect(seekInfoEnv, endpoint)
assert.Error(t, err)
assert.Nil(t, deliverClient)
assert.Nil(t, cancelFunc)
}

func TestDeliveryRequester_Connect_DeliverStreamerError(t *testing.T) {
fakeSigner := &fake.Signer{}
fakeSigner.SignReturns([]byte("good-sig"), nil)

fakeDialer := &fake.Dialer{}
fakeDialer.DialStub = func(string, [][]byte) (*grpc.ClientConn, error) {
cc, err := grpc.Dial("localhost:6005", grpc.WithTransportCredentials(insecure.NewCredentials()))
require.NoError(t, err)
require.NotEqual(t, connectivity.Shutdown, cc.GetState())

return cc, nil
}

fakeDeliverClient := &fake.DeliverClient{}
fakeDeliverClient.SendReturns(nil)

fakeDeliverStreamer := &fake.DeliverStreamer{}
deliverStreamerError := errors.New("deliver-streamer-error")
fakeDeliverStreamer.DeliverReturns(fakeDeliverClient, deliverStreamerError)

dr := blocksprovider.NewDeliveryRequester("channel-id", fakeSigner, []byte("tls-cert-hash"), fakeDialer, fakeDeliverStreamer)
assert.NotNil(t, dr)

seekInfoEnv := &common.Envelope{}
endpoint := &orderers.Endpoint{
Address: "orderer-address-1",
RootCerts: [][]byte{[]byte("root-cert")},
Refreshed: make(chan struct{}),
}

deliverClient, cancelFunc, err := dr.Connect(seekInfoEnv, endpoint)
assert.Error(t, err)
assert.Nil(t, deliverClient)
assert.Nil(t, cancelFunc)
}

func TestDeliveryRequester_Connect_DeliverClientError(t *testing.T) {
fakeSigner := &fake.Signer{}
fakeSigner.SignReturns([]byte("good-sig"), nil)

fakeDialer := &fake.Dialer{}
fakeDialer.DialStub = func(string, [][]byte) (*grpc.ClientConn, error) {
cc, err := grpc.Dial("localhost:6005", grpc.WithTransportCredentials(insecure.NewCredentials()))
require.NoError(t, err)
require.NotEqual(t, connectivity.Shutdown, cc.GetState())

return cc, nil
}

fakeDeliverClient := &fake.DeliverClient{}
deliverClientError := errors.New("deliver-client-error")
fakeDeliverClient.SendReturns(deliverClientError)

fakeDeliverStreamer := &fake.DeliverStreamer{}
fakeDeliverStreamer.DeliverReturns(fakeDeliverClient, nil)

dr := blocksprovider.NewDeliveryRequester("channel-id", fakeSigner, []byte("tls-cert-hash"), fakeDialer, fakeDeliverStreamer)
assert.NotNil(t, dr)

seekInfoEnv := &common.Envelope{}
endpoint := &orderers.Endpoint{
Address: "orderer-address-1",
RootCerts: [][]byte{[]byte("root-cert")},
Refreshed: make(chan struct{}),
}

deliverClient, cancelFunc, err := dr.Connect(seekInfoEnv, endpoint)
assert.Error(t, err)
assert.Nil(t, deliverClient)
assert.Nil(t, cancelFunc)
}

func TestDeliveryRequester_SeekInfoBlocksFrom(t *testing.T) {
fakeSigner := &fake.Signer{}
fakeSigner.SignReturns([]byte("good-sig"), nil)

fakeDialer := &fake.Dialer{}
cc := &grpc.ClientConn{}
fakeDialer.DialReturns(cc, nil)

fakeDeliverClient := &fake.DeliverClient{}
fakeDeliverClient.SendReturns(nil)

fakeDeliverStreamer := &fake.DeliverStreamer{}
fakeDeliverStreamer.DeliverReturns(fakeDeliverClient, nil)

dr := blocksprovider.NewDeliveryRequester("channel-id", fakeSigner, []byte("tls-cert-hash"), fakeDialer, fakeDeliverStreamer)
assert.NotNil(t, dr)

envelope, err := dr.SeekInfoBlocksFrom(1000)
assert.NoError(t, err)
assert.NotNil(t, envelope)
}

func TestDeliveryRequester_SeekInfoHeadersFrom(t *testing.T) {
fakeSigner := &fake.Signer{}
fakeSigner.SignReturns([]byte("good-sig"), nil)

fakeDialer := &fake.Dialer{}
cc := &grpc.ClientConn{}
fakeDialer.DialReturns(cc, nil)

fakeDeliverClient := &fake.DeliverClient{}
fakeDeliverClient.SendReturns(nil)

fakeDeliverStreamer := &fake.DeliverStreamer{}
fakeDeliverStreamer.DeliverReturns(fakeDeliverClient, nil)

dr := blocksprovider.NewDeliveryRequester("channel-id", fakeSigner, []byte("tls-cert-hash"), fakeDialer, fakeDeliverStreamer)
assert.NotNil(t, dr)

envelope, err := dr.SeekInfoHeadersFrom(1000)
assert.NoError(t, err)
assert.NotNil(t, envelope)
}