Merge pull request #586 from niklr/ledger_tests

fix: resolve import cycle in ledger tests
vitelabs · May 6, 2022 · 00fd800 · 00fd800
2 parents a28fab7 + 8e04fed
commit 00fd800
Show file tree

Hide file tree

Showing 24 changed files with 587 additions and 337 deletions.
diff --git a/common/types/address_test.go b/common/types/address_test.go
@@ -16,7 +16,7 @@ import (
 func TestCreateContractAddress(t *testing.T) {
 	addr := CreateContractAddress([]byte{1, 2, 3}, []byte{1, 2, 3})
 	fmt.Println(addr)
-	if _, err := ValidHexAddress(addr.String()); err == nil {
+	if _, err := ValidHexAddress(addr.String()); err != nil {
 		t.Fatal("Not valid")
 	}
 }

diff --git a/interfaces/chain.go b/interfaces/chain.go
@@ -9,6 +9,20 @@ import (
 	"github.com/vitelabs/go-vite/v2/interfaces/core"
 )
 
+type EventListener interface {
+	PrepareInsertAccountBlocks(blocks []*VmAccountBlock) error
+	InsertAccountBlocks(blocks []*VmAccountBlock) error
+
+	PrepareInsertSnapshotBlocks(chunks []*core.SnapshotChunk) error
+	InsertSnapshotBlocks(chunks []*core.SnapshotChunk) error
+
+	PrepareDeleteAccountBlocks(blocks []*core.AccountBlock) error
+	DeleteAccountBlocks(blocks []*core.AccountBlock) error
+
+	PrepareDeleteSnapshotBlocks(chunks []*core.SnapshotChunk) error
+	DeleteSnapshotBlocks(chunks []*core.SnapshotChunk) error
+}
+
 type StorageIterator interface {
 	Last() bool
 	Prev() bool

diff --git a/interfaces/core/account_block_test.go b/interfaces/core/account_block_test.go
@@ -157,7 +157,7 @@ func TestAccountBlock_ComputeHash(t *testing.T) {
 	}
 	fmt.Printf("%s\n", str)
 
-	if block.ComputeHash().String() != "6d54436d78a3bae0b4aacbeb91a0af3c666c6ed3339fbcc6610e12844736d091" {
+	if block.ComputeHash().String() != "57410f8496598113220fd7f8780cedec5f23f13bbe0d4852e1c0e782092b3a46" {
 		t.Fatal(block.ComputeHash().String())
 	}
 

diff --git a/ledger/chain/db/flush_test.go b/ledger/chain/db/flush_test.go
@@ -2,38 +2,56 @@ package chain_db
 
 import (
 	"bytes"
+	"fmt"
+	"os"
 	"path"
 	"sync"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/vitelabs/go-vite/v2/common/db/xleveldb"
-	"github.com/vitelabs/go-vite/v2/ledger/chain/flusher"
+	leveldb "github.com/vitelabs/go-vite/v2/common/db/xleveldb"
+	chain_flusher "github.com/vitelabs/go-vite/v2/ledger/chain/flusher"
 	"github.com/vitelabs/go-vite/v2/ledger/chain/test_tools"
 )
 
-func newStore() *Store {
-	store, err := NewStore(path.Join(test_tools.DefaultDataDir(), "test_store", "store"), "store")
+func newStore(dirName string, clear bool) (*Store, string) {
+	tempDir := path.Join(test_tools.DefaultDataDir(), dirName)
+	fmt.Printf("tempDir: %s\n", tempDir)
+	if clear {
+		os.RemoveAll(tempDir)
+	}
+	dataDir := path.Join(tempDir, "test_store")
+	store, err := NewStore(dataDir, "test_store")
 	if err != nil {
 		panic(err)
 	}
 
-	return store
+	return store, tempDir
+}
+
+func clearStore(tempDir string) {
+	err := os.RemoveAll(tempDir)
+	if err != nil {
+		panic(err)
+	}
 }
 
 func TestRedoLog(t *testing.T) {
-	store := newStore()
+	store, tempDir := newStore(t.Name(), true)
+	defer clearStore(tempDir)
+
 	var mu sync.RWMutex
-	flusher, err := chain_flusher.NewFlusher([]chain_flusher.Storage{store}, &mu, path.Join(test_tools.DefaultDataDir(), "test_store"))
+	flusher, err := chain_flusher.NewFlusher([]chain_flusher.Storage{store}, &mu, path.Join(test_tools.DefaultDataDir(), t.Name()))
 	// assert flusher
 	assert.NoError(t, err)
 	flusher.Flush()
-
 }
 
 func TestFlush(t *testing.T) {
-	store := newStore()
+	store, tempDir := newStore(t.Name(), true)
+	defer clearStore(tempDir)
+
 	batch := store.NewBatch()
 
 	batch.Put([]byte("key1"), []byte("value1"))
@@ -119,7 +137,9 @@ func TestFlush(t *testing.T) {
 }
 
 func TestRecover(t *testing.T) {
-	store := newStore()
+	store, tempDir := newStore(t.Name(), true)
+	defer clearStore(tempDir)
+
 	batch := store.NewBatch()
 
 	batch.Put([]byte("key1"), []byte("value1"))
@@ -190,7 +210,6 @@ func TestRecover(t *testing.T) {
 	v3, err := store.db.Get([]byte("key3"), nil)
 	assert.NoError(t, err)
 	assert.Equal(t, v3, []byte("value3"))
-
 }
 
 const (

diff --git a/ledger/chain/event_manager.go b/ledger/chain/event_manager.go
@@ -24,7 +24,7 @@ const (
 )
 
 type eventManager struct {
-	listenerList []EventListener
+	listenerList []interfaces.EventListener
 
 	chain        *chain
 	maxHandlerId uint32
@@ -35,7 +35,7 @@ func newEventManager(chain *chain) *eventManager {
 	return &eventManager{
 		chain:        chain,
 		maxHandlerId: 0,
-		listenerList: make([]EventListener, 0),
+		listenerList: make([]interfaces.EventListener, 0),
 	}
 }
 
@@ -150,14 +150,14 @@ func (em *eventManager) TriggerDeleteSbs(eventType byte, chunks []*ledger.Snapsh
 	return nil
 }
 
-func (em *eventManager) Register(listener EventListener) {
+func (em *eventManager) Register(listener interfaces.EventListener) {
 	em.mu.Lock()
 	defer em.mu.Unlock()
 
 	em.listenerList = append(em.listenerList, listener)
 }
 
-func (em *eventManager) UnRegister(listener EventListener) {
+func (em *eventManager) UnRegister(listener interfaces.EventListener) {
 	em.mu.Lock()
 	defer em.mu.Unlock()
 
@@ -169,10 +169,10 @@ func (em *eventManager) UnRegister(listener EventListener) {
 	}
 }
 
-func (c *chain) Register(listener EventListener) {
+func (c *chain) Register(listener interfaces.EventListener) {
 	c.em.Register(listener)
 }
 
-func (c *chain) UnRegister(listener EventListener) {
+func (c *chain) UnRegister(listener interfaces.EventListener) {
 	c.em.UnRegister(listener)
 }
diff --git a/ledger/chain/interface.go b/ledger/chain/interface.go
@@ -18,20 +18,6 @@ import (
 	"github.com/vitelabs/go-vite/v2/vm/contracts/dex"
 )
 
-type EventListener interface {
-	PrepareInsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-	InsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-
-	PrepareInsertSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-	InsertSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-
-	PrepareDeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-	DeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-
-	PrepareDeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-	DeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-}
-
 type Consensus interface {
 	VerifyAccountProducer(block *ledger.AccountBlock) (bool, error)
 	SBPReader() core.SBPStatReader
@@ -53,8 +39,8 @@ type Chain interface {
 	/*
 	*	Event Manager
 	 */
-	Register(listener EventListener)
-	UnRegister(listener EventListener)
+	Register(listener interfaces.EventListener)
+	UnRegister(listener interfaces.EventListener)
 
 	/*
 	 *	C(Create)

diff --git a/ledger/chain/state/interface.go b/ledger/chain/state/interface.go
@@ -13,20 +13,6 @@ import (
 	"github.com/vitelabs/go-vite/v2/ledger/consensus/core"
 )
 
-type EventListener interface {
-	PrepareInsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-	InsertAccountBlocks(blocks []*interfaces.VmAccountBlock) error
-
-	PrepareInsertSnapshotBlocks(snapshotBlocks []*ledger.SnapshotBlock) error
-	InsertSnapshotBlocks(snapshotBlocks []*ledger.SnapshotBlock) error
-
-	PrepareDeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-	DeleteAccountBlocks(blocks []*ledger.AccountBlock) error
-
-	PrepareDeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-	DeleteSnapshotBlocks(chunks []*ledger.SnapshotChunk) error
-}
-
 type Consensus interface {
 	VerifyAccountProducer(block *ledger.AccountBlock) (bool, error)
 	SBPReader() core.SBPStatReader

diff --git a/ledger/chain/test_tools/chain.go b/ledger/chain/test_tools/chain.go
diff --git a/ledger/consensus/README.md b/ledger/consensus/README.md
@@ -0,0 +1,5 @@
+Generate `MockChain`:
+
+```
+~/go/bin/mockgen -source=ledger/consensus/chain_rw.go -destination=ledger/consensus/mock_ch.go -package=consensus
+```
diff --git a/ledger/consensus/chain_rw.go b/ledger/consensus/chain_rw.go
@@ -7,13 +7,14 @@ import (
 	"sync"
 	"time"
 
-	"github.com/hashicorp/golang-lru"
+	lru "github.com/hashicorp/golang-lru"
 	"github.com/pkg/errors"
 	"github.com/syndtr/goleveldb/leveldb"
 
 	"github.com/vitelabs/go-vite/v2/common/types"
+	"github.com/vitelabs/go-vite/v2/interfaces"
 	ledger "github.com/vitelabs/go-vite/v2/interfaces/core"
-	"github.com/vitelabs/go-vite/v2/ledger/chain"
+
 	"github.com/vitelabs/go-vite/v2/ledger/consensus/cdb"
 	"github.com/vitelabs/go-vite/v2/ledger/consensus/core"
 	"github.com/vitelabs/go-vite/v2/ledger/pool/lock"
@@ -28,8 +29,8 @@ type Chain interface {
 	/*
 	*	Event Manager
 	 */
-	Register(listener chain.EventListener)
-	UnRegister(listener chain.EventListener)
+	Register(listener interfaces.EventListener)
+	UnRegister(listener interfaces.EventListener)
 
 	GetConsensusGroupList(snapshotHash types.Hash) ([]*types.ConsensusGroupInfo, error)                                                 // Get all consensus group
 	GetRegisterList(snapshotHash types.Hash, gid types.Gid) ([]*types.Registration, error)                                              // Get register for consensus group

diff --git a/ledger/consensus/chain_rw_test.go b/ledger/consensus/chain_rw_test.go
@@ -1,17 +1,16 @@
 package consensus
 
 import (
-	"os"
 	"testing"
 
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/assert"
 
+	"github.com/vitelabs/go-vite/v2/common/config"
 	"github.com/vitelabs/go-vite/v2/common/types"
 	ledger "github.com/vitelabs/go-vite/v2/interfaces/core"
-	"github.com/vitelabs/go-vite/v2/ledger/chain"
-	"github.com/vitelabs/go-vite/v2/ledger/chain/test_tools"
 	"github.com/vitelabs/go-vite/v2/ledger/pool/lock"
+	"github.com/vitelabs/go-vite/v2/ledger/test_tools"
 	"github.com/vitelabs/go-vite/v2/log15"
 )
 
@@ -38,44 +37,21 @@ func GetConsensusGroupList() ([]*types.ConsensusGroupInfo, error) {
 	return []*types.ConsensusGroupInfo{info}, nil
 }
 
-func testDataDir() string {
-	return "testdata-consensus"
-}
-
-func prepareChain() chain.Chain {
-	clearChain(nil)
-
-	c, err := test_tools.NewChainInstanceFromDir(testDataDir(), false, "")
-	if err != nil {
-		panic(err)
-	}
-	return c
-}
-
-func clearChain(c chain.Chain) {
-	if c != nil {
-		c.Stop()
-	}
-	err := os.RemoveAll(testDataDir())
-	if err != nil {
-		panic(err)
-	}
-}
-
 func Test_chainRw(t *testing.T) {
-	c := prepareChain()
-	defer clearChain(c)
-
+	c, tempDir := test_tools.NewTestChainInstance(t, true, nil)
+	defer test_tools.ClearChain(c, tempDir)
 }
 
 func TestChainRw_GetMemberInfo(t *testing.T) {
+	c, tempDir := test_tools.NewTestChainInstance(t, true, nil)
+	defer test_tools.ClearChain(c, tempDir)
+
 	ctrl := gomock.NewController(t)
 	// Assert that Bar() is invoked.
 	defer ctrl.Finish()
 
-	dir := "testdata-consensus"
-	db := NewDb(t, dir)
-	defer ClearDb(t, dir)
+	db := NewDb(t, tempDir)
+	defer ClearDb(t, tempDir)
 
 	mch := NewMockChain(ctrl)
 	genesisBlock := &ledger.SnapshotBlock{Height: uint64(1), Timestamp: &simpleGenesis}
@@ -97,8 +73,9 @@ func TestChainRw_GetMemberInfo(t *testing.T) {
 }
 
 func TestChainRw_GetMemberInfo2(t *testing.T) {
-	c := prepareChain()
-	defer clearChain(c)
+	c, tempDir := test_tools.NewTestChainInstance(t, true, config.MockGenesis())
+	defer test_tools.ClearChain(c, tempDir)
+
 	genesis := c.GetGenesisSnapshotBlock()
 	infos, err := c.GetConsensusGroupList(genesis.Hash)
 	if err != nil {