Add unit test for the collector

Author: zivkovicmilos

internal/collector/collector_test.go

@@ -0,0 +1,126 @@
+package collector
+
+import (
+	"crypto/rand"
+	"testing"
+	"time"
+
+	core_types "github.com/gnolang/gno/pkgs/bft/rpc/core/types"
+	"github.com/gnolang/gno/pkgs/bft/types"
+	"github.com/gnolang/gno/pkgs/crypto/tmhash"
+	"github.com/stretchr/testify/assert"
+)
+
+// generateRandomData generates random 32B chunks
+func generateRandomData(t *testing.T, count int) [][]byte {
+	t.Helper()
+
+	data := make([][]byte, count)
+
+	for i := 0; i < count; i++ {
+		buf := make([]byte, 32)
+
+		_, err := rand.Read(buf)
+		if err != nil {
+			t.Fatalf("unable to generate random data, %v", err)
+		}
+
+		data[i] = buf
+	}
+
+	return data
+}
+
+func TestCollector_GetRunResults(t *testing.T) {
+	t.Parallel()
+
+	numTxs := 100
+	startTime := time.Now()
+	blockTimes := make([]time.Time, numTxs)
+
+	for i := 0; i < numTxs; i++ {
+		if i == 0 {
+			blockTimes[i] = startTime
+		}
+
+		blockTimes[i] = startTime.Add(time.Duration(i) * time.Second)
+	}
+
+	txs := generateRandomData(t, numTxs)
+	txHashes := make([][]byte, numTxs)
+
+	for i := 0; i < numTxs; i++ {
+		txHashes[i] = tmhash.Sum(txs[i])
+	}
+
+	var (
+		gasLimit = int64(1000)
+		gasUsed  = int64(100)
+
+		mockClient = &mockClient{
+			getBlockFn: func(height *int64) (*core_types.ResultBlock, error) {
+				if *height > int64(numTxs) {
+					t.Fatalf("invalid height requested")
+				}
+
+				return &core_types.ResultBlock{
+					BlockMeta: &types.BlockMeta{
+						Header: types.Header{
+							Height: *height,
+							Time:   blockTimes[*height-1],
+							NumTxs: 1,
+						},
+					},
+					Block: &types.Block{
+						Data: types.Data{
+							Txs: []types.Tx{
+								txs[*height-1],
+							},
+						},
+					},
+				}, nil
+			},
+			getLatestBlockHeightFn: func() (int64, error) {
+				return int64(numTxs), nil
+			},
+			getBlockGasLimitFn: func(height int64) (int64, error) {
+				if height > int64(numTxs) {
+					t.Fatalf("invalid height requested")
+				}
+
+				return gasLimit, nil
+			},
+			getBlockGasUsedFn: func(height int64) (int64, error) {
+				if height > int64(numTxs) {
+					t.Fatalf("invalid height requested")
+				}
+
+				return gasUsed, nil
+			},
+		}
+	)
+
+	// Create the collector
+	c := NewCollector(mockClient)
+	c.requestTimeout = time.Second * 0
+
+	// Collect the results
+	result, err := c.GetRunResult(txHashes, 1)
+	if err != nil {
+		t.Fatalf("unable to get run results, %v", err)
+	}
+
+	if result == nil {
+		t.Fatal("result should not be nil")
+	}
+
+	assert.Equal(t, 2, result.AverageTPS) // 1 tx per block; 100 blocks; 1s per block;
+	assert.Len(t, result.Blocks, numTxs)
+
+	for index, block := range result.Blocks {
+		assert.Equal(t, int64(index+1), block.Number)
+		assert.Equal(t, gasUsed, block.GasUsed)
+		assert.Equal(t, gasLimit, block.GasLimit)
+		assert.Equal(t, int64(1), block.Transactions)
+	}
+}

internal/collector/mock_test.go

@@ -0,0 +1,49 @@
+package collector
+
+import core_types "github.com/gnolang/gno/pkgs/bft/rpc/core/types"
+
+type (
+	getBlockDelegate             func(height *int64) (*core_types.ResultBlock, error)
+	getBlockGasUsedDelegate      func(height int64) (int64, error)
+	getBlockGasLimitDelegate     func(height int64) (int64, error)
+	getLatestBlockHeightDelegate func() (int64, error)
+)
+
+type mockClient struct {
+	getBlockFn             getBlockDelegate
+	getBlockGasUsedFn      getBlockGasUsedDelegate
+	getBlockGasLimitFn     getBlockGasLimitDelegate
+	getLatestBlockHeightFn getLatestBlockHeightDelegate
+}
+
+func (m *mockClient) GetBlock(height *int64) (*core_types.ResultBlock, error) {
+	if m.getBlockFn != nil {
+		return m.getBlockFn(height)
+	}
+
+	return nil, nil
+}
+
+func (m *mockClient) GetBlockGasUsed(height int64) (int64, error) {
+	if m.getBlockGasUsedFn != nil {
+		return m.getBlockGasUsedFn(height)
+	}
+
+	return 0, nil
+}
+
+func (m *mockClient) GetBlockGasLimit(height int64) (int64, error) {
+	if m.getBlockGasLimitFn != nil {
+		return m.getBlockGasLimitFn(height)
+	}
+
+	return 0, nil
+}
+
+func (m *mockClient) GetLatestBlockHeight() (int64, error) {
+	if m.getLatestBlockHeightFn != nil {
+		return m.getLatestBlockHeightFn()
+	}
+
+	return 0, nil
+}