Add tests for pkg/geth/blockchain

- inject dependencies instead of initializing them in the constructor
2018-07-18 16:34:13 -05:00
parent 1355271011
commit 63434f6bc9
20 changed files with 538 additions and 106 deletions
@@ -1,44 +1,48 @@
 package geth

 import (
-	"log"
 	"math/big"

 	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/ethereum/go-ethereum/rpc"
 	"golang.org/x/net/context"

 	"github.com/vulcanize/vulcanizedb/pkg/core"
 	vulcCommon "github.com/vulcanize/vulcanizedb/pkg/geth/converters/common"
-	vulcRpc "github.com/vulcanize/vulcanizedb/pkg/geth/converters/rpc"
-	"github.com/vulcanize/vulcanizedb/pkg/geth/node"
 )

 type BlockChain struct {
-	client          *ethclient.Client
+	client          core.Client
 	blockConverter  vulcCommon.BlockConverter
 	headerConverter vulcCommon.HeaderConverter
 	node            core.Node
 }

-func NewBlockChain(ipcPath string) *BlockChain {
-	rpcClient, err := rpc.Dial(ipcPath)
-	if err != nil {
-		log.Fatal(err)
-	}
-	client := ethclient.NewClient(rpcClient)
-	clientWrapper := node.ClientWrapper{ContextCaller: rpcClient, IPCPath: ipcPath}
-	transactionConverter := vulcRpc.NewRpcTransactionConverter(client)
+func NewBlockChain(client core.Client, node core.Node, converter vulcCommon.TransactionConverter) *BlockChain {
 	return &BlockChain{
 		client:          client,
-		blockConverter:  vulcCommon.NewBlockConverter(transactionConverter),
+		blockConverter:  vulcCommon.NewBlockConverter(converter),
 		headerConverter: vulcCommon.HeaderConverter{},
-		node:            node.MakeNode(clientWrapper),
+		node:            node,
 	}
 }

+func (blockChain *BlockChain) GetBlockByNumber(blockNumber int64) (block core.Block, err error) {
+	gethBlock, err := blockChain.client.BlockByNumber(context.Background(), big.NewInt(blockNumber))
+	if err != nil {
+		return block, err
+	}
+	return blockChain.blockConverter.ToCoreBlock(gethBlock)
+}
+
+func (blockChain *BlockChain) GetHeaderByNumber(blockNumber int64) (header core.Header, err error) {
+	gethHeader, err := blockChain.client.HeaderByNumber(context.Background(), big.NewInt(blockNumber))
+	if err != nil {
+		return header, err
+	}
+	return blockChain.headerConverter.Convert(gethHeader)
+}
+
 func (blockChain *BlockChain) GetLogs(contract core.Contract, startingBlockNumber, endingBlockNumber *big.Int) ([]core.Log, error) {
 	if endingBlockNumber == nil {
 		endingBlockNumber = startingBlockNumber
@@ -57,27 +61,11 @@ func (blockChain *BlockChain) GetLogs(contract core.Contract, startingBlockNumbe
 	return logs, nil
 }

-func (blockChain *BlockChain) Node() core.Node {
-	return blockChain.node
-}
-
-func (blockChain *BlockChain) GetBlockByNumber(blockNumber int64) (block core.Block, err error) {
-	gethBlock, err := blockChain.client.BlockByNumber(context.Background(), big.NewInt(blockNumber))
-	if err != nil {
-		return block, err
-	}
-	return blockChain.blockConverter.ToCoreBlock(gethBlock)
-}
-
-func (blockChain *BlockChain) GetHeaderByNumber(blockNumber int64) (header core.Header, err error) {
-	gethHeader, err := blockChain.client.HeaderByNumber(context.Background(), big.NewInt(blockNumber))
-	if err != nil {
-		return header, err
-	}
-	return blockChain.headerConverter.Convert(gethHeader)
-}
-
 func (blockChain *BlockChain) LastBlock() *big.Int {
 	block, _ := blockChain.client.HeaderByNumber(context.Background(), nil)
 	return block.Number
 }
+
+func (blockChain *BlockChain) Node() core.Node {
+	return blockChain.node
+}
@@ -0,0 +1,125 @@
+package geth_test
+
+import (
+	"context"
+	"math/big"
+
+	"github.com/ethereum/go-ethereum"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	vulcCore "github.com/vulcanize/vulcanizedb/pkg/core"
+	"github.com/vulcanize/vulcanizedb/pkg/fakes"
+	"github.com/vulcanize/vulcanizedb/pkg/geth"
+	"github.com/vulcanize/vulcanizedb/pkg/geth/converters/cold_db"
+)
+
+var _ = Describe("Geth blockchain", func() {
+	Describe("getting a block", func() {
+		It("fetches block from client", func() {
+			mockClient := fakes.NewMockClient()
+			mockClient.SetBlockByNumberReturnBlock(types.NewBlockWithHeader(&types.Header{}))
+			node := vulcCore.Node{}
+			blockChain := geth.NewBlockChain(mockClient, node, cold_db.NewColdDbTransactionConverter())
+			blockNumber := int64(100)
+
+			_, err := blockChain.GetBlockByNumber(blockNumber)
+
+			Expect(err).NotTo(HaveOccurred())
+			mockClient.AssertBlockByNumberCalledWith(context.Background(), big.NewInt(blockNumber))
+		})
+
+		It("returns err if client returns err", func() {
+			mockClient := fakes.NewMockClient()
+			mockClient.SetBlockByNumberErr(fakes.FakeError)
+			node := vulcCore.Node{}
+			blockChain := geth.NewBlockChain(mockClient, node, cold_db.NewColdDbTransactionConverter())
+
+			_, err := blockChain.GetBlockByNumber(100)
+
+			Expect(err).To(HaveOccurred())
+			Expect(err).To(MatchError(fakes.FakeError))
+		})
+	})
+
+	Describe("getting a header", func() {
+		It("fetches header from client", func() {
+			mockClient := fakes.NewMockClient()
+			blockNumber := int64(100)
+			mockClient.SetHeaderByNumberReturnHeader(&types.Header{Number: big.NewInt(blockNumber)})
+			node := vulcCore.Node{}
+			blockChain := geth.NewBlockChain(mockClient, node, cold_db.NewColdDbTransactionConverter())
+
+			_, err := blockChain.GetHeaderByNumber(blockNumber)
+
+			Expect(err).NotTo(HaveOccurred())
+			mockClient.AssertHeaderByNumberCalledWith(context.Background(), big.NewInt(blockNumber))
+		})
+
+		It("returns err if client returns err", func() {
+			mockClient := fakes.NewMockClient()
+			mockClient.SetHeaderByNumberErr(fakes.FakeError)
+			node := vulcCore.Node{}
+			blockChain := geth.NewBlockChain(mockClient, node, cold_db.NewColdDbTransactionConverter())
+
+			_, err := blockChain.GetHeaderByNumber(100)
+
+			Expect(err).To(HaveOccurred())
+			Expect(err).To(MatchError(fakes.FakeError))
+		})
+	})
+
+	Describe("getting logs", func() {
+		It("fetches logs from client", func() {
+			mockClient := fakes.NewMockClient()
+			mockClient.SetFilterLogsReturnLogs([]types.Log{{}})
+			node := vulcCore.Node{}
+			blockChain := geth.NewBlockChain(mockClient, node, cold_db.NewColdDbTransactionConverter())
+			contract := vulcCore.Contract{Hash: common.BytesToHash([]byte{1, 2, 3, 4, 5}).Hex()}
+			startingBlockNumber := big.NewInt(1)
+			endingBlockNumber := big.NewInt(2)
+
+			_, err := blockChain.GetLogs(contract, startingBlockNumber, endingBlockNumber)
+
+			Expect(err).NotTo(HaveOccurred())
+			expectedQuery := ethereum.FilterQuery{
+				FromBlock: startingBlockNumber,
+				ToBlock:   endingBlockNumber,
+				Addresses: []common.Address{common.HexToAddress(contract.Hash)},
+			}
+			mockClient.AssertFilterLogsCalledWith(context.Background(), expectedQuery)
+		})
+
+		It("returns err if client returns err", func() {
+			mockClient := fakes.NewMockClient()
+			mockClient.SetFilterLogsErr(fakes.FakeError)
+			node := vulcCore.Node{}
+			blockChain := geth.NewBlockChain(mockClient, node, cold_db.NewColdDbTransactionConverter())
+			contract := vulcCore.Contract{Hash: common.BytesToHash([]byte{1, 2, 3, 4, 5}).Hex()}
+			startingBlockNumber := big.NewInt(1)
+			endingBlockNumber := big.NewInt(2)
+
+			_, err := blockChain.GetLogs(contract, startingBlockNumber, endingBlockNumber)
+
+			Expect(err).To(HaveOccurred())
+			Expect(err).To(MatchError(fakes.FakeError))
+		})
+	})
+
+	Describe("getting the most recent block number", func() {
+		It("fetches latest header from client", func() {
+			mockClient := fakes.NewMockClient()
+			blockNumber := int64(100)
+			mockClient.SetHeaderByNumberReturnHeader(&types.Header{Number: big.NewInt(blockNumber)})
+			node := vulcCore.Node{}
+			blockChain := geth.NewBlockChain(mockClient, node, cold_db.NewColdDbTransactionConverter())
+
+			result := blockChain.LastBlock()
+
+			mockClient.AssertHeaderByNumberCalledWith(context.Background(), nil)
+			Expect(result).To(Equal(big.NewInt(blockNumber)))
+		})
+	})
+})
@@ -0,0 +1,33 @@
+package client
+
+import (
+	"context"
+	"github.com/ethereum/go-ethereum"
+	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum/go-ethereum/ethclient"
+	"math/big"
+)
+
+type Client struct {
+	client *ethclient.Client
+}
+
+func NewClient(client *ethclient.Client) Client {
+	return Client{client: client}
+}
+
+func (client Client) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
+	return client.client.BlockByNumber(ctx, number)
+}
+
+func (client Client) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
+	return client.client.CallContract(ctx, msg, blockNumber)
+}
+
+func (client Client) FilterLogs(ctx context.Context, q ethereum.FilterQuery) ([]types.Log, error) {
+	return client.client.FilterLogs(ctx, q)
+}
+
+func (client Client) HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error) {
+	return client.client.HeaderByNumber(ctx, number)
+}