prysm-pulse/beacon-chain/rpc/service_test.go

package rpc

import (
	"bytes"
	"context"
	"errors"
	"fmt"
	"io/ioutil"
	"testing"

	"github.com/gogo/protobuf/proto"
	"github.com/prysmaticlabs/prysm/beacon-chain/db"
	pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
	"github.com/prysmaticlabs/prysm/shared/bytesutil"
	"github.com/prysmaticlabs/prysm/shared/event"
	"github.com/prysmaticlabs/prysm/shared/hashutil"
	"github.com/prysmaticlabs/prysm/shared/params"
	"github.com/prysmaticlabs/prysm/shared/testutil"
	"github.com/sirupsen/logrus"
	logTest "github.com/sirupsen/logrus/hooks/test"
)

func init() {
	logrus.SetLevel(logrus.DebugLevel)
	logrus.SetOutput(ioutil.Discard)
}

type TestLogger struct {
	logrus.FieldLogger
	testMap map[string]interface{}
}

func (t *TestLogger) Errorf(format string, args ...interface{}) {
	t.testMap["error"] = true
}

type mockOperationService struct {
	pendingAttestations []*pb.Attestation
}

func (ms *mockOperationService) IncomingAttFeed() *event.Feed {
	return new(event.Feed)
}

func (ms *mockOperationService) IncomingExitFeed() *event.Feed {
	return new(event.Feed)
}

func (ms *mockOperationService) HandleAttestations(_ context.Context, _ proto.Message) error {
	return nil
}

func (ms *mockOperationService) IsAttCanonical(_ context.Context, att *pb.Attestation) (bool, error) {
	return true, nil
}

func (ms *mockOperationService) PendingAttestations(_ context.Context) ([]*pb.Attestation, error) {
	if ms.pendingAttestations != nil {
		return ms.pendingAttestations, nil
	}
	return []*pb.Attestation{
		{
			AggregationBitfield: []byte("A"),
			Data: &pb.AttestationData{
				Slot:                    params.BeaconConfig().GenesisSlot + params.BeaconConfig().SlotsPerEpoch,
				CrosslinkDataRootHash32: params.BeaconConfig().ZeroHash[:],
			},
		},
		{
			AggregationBitfield: []byte("B"),
			Data: &pb.AttestationData{
				Slot:                    params.BeaconConfig().GenesisSlot + params.BeaconConfig().SlotsPerEpoch,
				CrosslinkDataRootHash32: params.BeaconConfig().ZeroHash[:],
			},
		},
		{
			AggregationBitfield: []byte("C"),
			Data: &pb.AttestationData{
				Slot:                    params.BeaconConfig().GenesisSlot + params.BeaconConfig().SlotsPerEpoch,
				CrosslinkDataRootHash32: params.BeaconConfig().ZeroHash[:],
			},
		},
	}, nil
}

type mockChainService struct {
	blockFeed            *event.Feed
	stateFeed            *event.Feed
	attestationFeed      *event.Feed
	stateInitializedFeed *event.Feed
	canonicalBlocks      map[uint64][]byte
	targets              map[uint64]*pb.AttestationTarget
	beaconDB             *db.BeaconDB
}

func (m *mockChainService) StateInitializedFeed() *event.Feed {
	return m.stateInitializedFeed
}

func (m *mockChainService) ReceiveBlock(ctx context.Context, block *pb.BeaconBlock) (*pb.BeaconState, error) {
	return &pb.BeaconState{}, nil
}

func (m *mockChainService) ApplyForkChoiceRule(ctx context.Context, block *pb.BeaconBlock, computedState *pb.BeaconState) error {
	return nil
}

func (m *mockChainService) CanonicalBlockFeed() *event.Feed {
	return new(event.Feed)
}

func (m *mockChainService) UpdateCanonicalRoots(block *pb.BeaconBlock, root [32]byte) {

}

func (m mockChainService) SaveHistoricalState(beaconState *pb.BeaconState) error {
	return nil
}

func (m mockChainService) IsCanonical(slot uint64, hash []byte) bool {
	return bytes.Equal(m.canonicalBlocks[slot], hash)
}

func (m *mockChainService) BlockChildren(ctx context.Context, block *pb.BeaconBlock, highestSlot uint64) ([]*pb.BeaconBlock, error) {
	blockRoot, err := hashutil.HashBeaconBlock(block)
	if err != nil {
		return nil, err
	}
	var children []*pb.BeaconBlock
	startSlot := block.Slot + 1
	for i := startSlot; i <= highestSlot; i++ {
		kids, err := m.beaconDB.BlocksBySlot(ctx, i)
		if err != nil {
			return nil, fmt.Errorf("could not get block by slot: %v", err)
		}
		children = append(children, kids...)
	}

	filteredChildren := []*pb.BeaconBlock{}
	for _, kid := range children {
		parentRoot := bytesutil.ToBytes32(kid.ParentRootHash32)
		if blockRoot == parentRoot {
			filteredChildren = append(filteredChildren, kid)
		}
	}
	return filteredChildren, nil
}

func (m *mockChainService) AttestationTargets(justifiedState *pb.BeaconState) (map[uint64]*pb.AttestationTarget, error) {
	return m.targets, nil
}

func newMockChainService() *mockChainService {
	return &mockChainService{
		blockFeed:            new(event.Feed),
		stateFeed:            new(event.Feed),
		attestationFeed:      new(event.Feed),
		stateInitializedFeed: new(event.Feed),
	}
}

type mockSyncService struct {
}

func (ms *mockSyncService) Status() error {
	return nil
}

func TestLifecycle_OK(t *testing.T) {
	hook := logTest.NewGlobal()
	rpcService := NewRPCService(context.Background(), &Config{
		Port:        "7348",
		CertFlag:    "alice.crt",
		KeyFlag:     "alice.key",
		SyncService: &mockSyncService{},
	})

	rpcService.Start()

	testutil.AssertLogsContain(t, hook, "Starting service")
	testutil.AssertLogsContain(t, hook, "Listening on port")

	rpcService.Stop()
	testutil.AssertLogsContain(t, hook, "Stopping service")

}

func TestRPC_BadEndpoint(t *testing.T) {
	fl := logrus.WithField("prefix", "rpc")

	log = &TestLogger{
		FieldLogger: fl,
		testMap:     make(map[string]interface{}),
	}

	hook := logTest.NewLocal(fl.Logger)

	rpcService := NewRPCService(context.Background(), &Config{
		Port:        "ralph merkle!!!",
		SyncService: &mockSyncService{},
	})

	if val, ok := log.(*TestLogger).testMap["error"]; ok {
		t.Fatalf("Error in Start() occurred before expected: %v", val)
	}

	rpcService.Start()

	if _, ok := log.(*TestLogger).testMap["error"]; !ok {
		t.Fatal("No error occurred. Expected Start() to output an error")
	}

	testutil.AssertLogsContain(t, hook, "Starting service")

}

func TestStatus_CredentialError(t *testing.T) {
	credentialErr := errors.New("credentialError")
	s := &Service{credentialError: credentialErr}

	if err := s.Status(); err != s.credentialError {
		t.Errorf("Wanted: %v, got: %v", s.credentialError, s.Status())
	}
}

func TestRPC_InsecureEndpoint(t *testing.T) {
	hook := logTest.NewGlobal()
	rpcService := NewRPCService(context.Background(), &Config{
		Port:        "7777",
		SyncService: &mockSyncService{},
	})

	rpcService.Start()

	testutil.AssertLogsContain(t, hook, "Starting service")
	testutil.AssertLogsContain(t, hook, fmt.Sprint("Listening on port"))
	testutil.AssertLogsContain(t, hook, "You are using an insecure gRPC connection")

	rpcService.Stop()
	testutil.AssertLogsContain(t, hook, "Stopping service")
}