refactor(testing): Multi and KVStore testing improvements (#1194)

### Summary by CodeRabbit **Refactor:** - Updated the package import paths and refactored the code to use a new logging system across multiple modules. - Modified the `ReadOnlyStore` to use a different underlying data store. - Refactored the `testutil` package for better organization and usage across tests. **Test:** - Enhanced test setup functions to include a logger for better test logging. - Updated test cases to use the new logger and the refactored `testutil` package. **Chore:** - Renamed the package from "utils" to "testutil" for better clarity and consistency.
berachain · Oct 8, 2023 · cc9e8f7 · cc9e8f7
1 parent 348b172
commit cc9e8f7
Show file tree

Hide file tree

Showing 24 changed files with 113 additions and 1,866 deletions.
diff --git a/cosmos/precompile/bank/bank_test.go b/cosmos/precompile/bank/bank_test.go
@@ -26,6 +26,7 @@ import (
 	"math/big"
 	"testing"
 
+	"cosmossdk.io/log"
 	sdkmath "cosmossdk.io/math"
 
 	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
@@ -36,8 +37,8 @@ import (
 
 	"pkg.berachain.dev/polaris/cosmos/precompile"
 	"pkg.berachain.dev/polaris/cosmos/precompile/bank"
-	testutils "pkg.berachain.dev/polaris/cosmos/testing/utils"
-	"pkg.berachain.dev/polaris/cosmos/x/evm/plugins/precompile/log"
+	testutils "pkg.berachain.dev/polaris/cosmos/testutil"
+	pclog "pkg.berachain.dev/polaris/cosmos/x/evm/plugins/precompile/log"
 	evmtypes "pkg.berachain.dev/polaris/cosmos/x/evm/types"
 	"pkg.berachain.dev/polaris/eth/common"
 	ethprecompile "pkg.berachain.dev/polaris/eth/core/precompile"
@@ -57,22 +58,22 @@ var _ = Describe("Bank Precompile Test", func() {
 	var (
 		contract *bank.Contract
 		addr     sdk.AccAddress
-		factory  *log.Factory
+		factory  *pclog.Factory
 		ak       authkeeper.AccountKeeperI
 		bk       bankkeeper.BaseKeeper
 		ctx      context.Context
 	)
 
 	BeforeEach(func() {
-		ctx, ak, bk, _ = testutils.SetupMinimalKeepers()
+		ctx, ak, bk, _ = testutils.SetupMinimalKeepers(log.NewTestLogger(GinkgoT()))
 
 		contract = utils.MustGetAs[*bank.Contract](bank.NewPrecompileContract(
 			ak, bankkeeper.NewMsgServerImpl(bk), bk),
 		)
 		addr = sdk.AccAddress([]byte("bank"))
 
 		// Register the events.
-		factory = log.NewFactory([]ethprecompile.Registrable{contract})
+		factory = pclog.NewFactory([]ethprecompile.Registrable{contract})
 	})
 
 	It("should register the send event", func() {

diff --git a/cosmos/precompile/distribution/distribution_test.go b/cosmos/precompile/distribution/distribution_test.go
@@ -25,6 +25,7 @@ import (
 	"math/big"
 	"testing"
 
+	"cosmossdk.io/log"
 	sdkmath "cosmossdk.io/math"
 	storetypes "cosmossdk.io/store/types"
 
@@ -44,8 +45,8 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 
-	testutil "pkg.berachain.dev/polaris/cosmos/testing/utils"
-	"pkg.berachain.dev/polaris/cosmos/x/evm/plugins/precompile/log"
+	testutil "pkg.berachain.dev/polaris/cosmos/testutil"
+	pclog "pkg.berachain.dev/polaris/cosmos/x/evm/plugins/precompile/log"
 	ethprecompile "pkg.berachain.dev/polaris/eth/core/precompile"
 	"pkg.berachain.dev/polaris/eth/core/vm"
 	"pkg.berachain.dev/polaris/lib/utils"
@@ -77,15 +78,17 @@ func setup() (
 	*stakingkeeper.Keeper,
 	*bankkeeper.BaseKeeper,
 ) {
-	ctx, ak, bk, sk := testutil.SetupMinimalKeepers()
+	distrKey := storetypes.NewKVStoreKey(distributiontypes.StoreKey)
+	ctx, ak, bk, sk := testutil.SetupMinimalKeepers(log.NewTestLogger(GinkgoT()),
+		[]storetypes.StoreKey{distrKey}...)
 
 	encCfg := cosmostestutil.MakeTestEncodingConfig(
 		distribution.AppModuleBasic{},
 	)
 
 	dk := distrkeeper.NewKeeper(
 		encCfg.Codec,
-		runtime.NewKVStoreService(storetypes.NewKVStoreKey(distributiontypes.StoreKey)),
+		runtime.NewKVStoreService(distrKey),
 		ak,
 		bk,
 		sk,
@@ -107,7 +110,7 @@ var _ = Describe("Distribution Precompile Test", func() {
 	var (
 		contract *Contract
 		valAddr  sdk.ValAddress
-		f        *log.Factory
+		f        *pclog.Factory
 		amt      sdk.Coin
 
 		ctx sdk.Context
@@ -131,7 +134,7 @@ var _ = Describe("Distribution Precompile Test", func() {
 		))
 
 		// Register the events.
-		f = log.NewFactory([]ethprecompile.Registrable{contract})
+		f = pclog.NewFactory([]ethprecompile.Registrable{contract})
 
 		// Set up the stateful factory.
 		sf = ethprecompile.NewStatefulFactory()

diff --git a/cosmos/precompile/governance/governance_test.go b/cosmos/precompile/governance/governance_test.go
@@ -43,7 +43,7 @@ import (
 
 	cbindings "pkg.berachain.dev/polaris/contracts/bindings/cosmos/lib"
 	generated "pkg.berachain.dev/polaris/contracts/bindings/cosmos/precompile/governance"
-	testutils "pkg.berachain.dev/polaris/cosmos/testing/utils"
+	testutils "pkg.berachain.dev/polaris/cosmos/testutil"
 	"pkg.berachain.dev/polaris/cosmos/types"
 	"pkg.berachain.dev/polaris/eth/common"
 	ethprecompile "pkg.berachain.dev/polaris/eth/core/precompile"

diff --git a/cosmos/precompile/governance/testutil.go b/cosmos/precompile/governance/testutil.go
@@ -26,6 +26,7 @@ import (
 
 	"github.com/golang/mock/gomock"
 
+	"cosmossdk.io/log"
 	storetypes "cosmossdk.io/store/types"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
@@ -43,7 +44,7 @@ import (
 	v1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 
-	testutils "pkg.berachain.dev/polaris/cosmos/testing/utils"
+	testutils "pkg.berachain.dev/polaris/cosmos/testutil"
 	"pkg.berachain.dev/polaris/eth/common"
 
 	//nolint:stylecheck,revive // Ginkgo is the testing framework.
@@ -67,7 +68,10 @@ func setupGovTest(ctrl *gomock.Controller, caller sdk.AccAddress) (
 	sdk.Context, authkeeper.AccountKeeperI, bankkeeper.Keeper, *governancekeeper.Keeper,
 ) {
 	// Setup the keepers and context.
-	ctx, ak, bk, sk := testutils.SetupMinimalKeepers()
+	govKey := storetypes.NewKVStoreKey(governancetypes.StoreKey)
+	ctx, ak, bk, sk := testutils.SetupMinimalKeepers(
+		log.NewTestLogger(GinkgoT()), []storetypes.StoreKey{govKey}...,
+	)
 	dk := govtestutil.NewMockDistributionKeeper(ctrl)
 
 	// Create the codec.
@@ -94,7 +98,7 @@ func setupGovTest(ctrl *gomock.Controller, caller sdk.AccAddress) (
 	}
 	gk := governancekeeper.NewKeeper(
 		encCfg.Codec,
-		runtime.NewKVStoreService(storetypes.NewKVStoreKey(governancetypes.StoreKey)),
+		runtime.NewKVStoreService(govKey),
 		ak,
 		bk,
 		sk,

diff --git a/cosmos/precompile/staking/staking_test.go b/cosmos/precompile/staking/staking_test.go
@@ -25,6 +25,7 @@ import (
 	"math/big"
 	"testing"
 
+	"cosmossdk.io/log"
 	sdkmath "cosmossdk.io/math"
 
 	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
@@ -38,7 +39,7 @@ import (
 	cbindings "pkg.berachain.dev/polaris/contracts/bindings/cosmos/lib"
 	generated "pkg.berachain.dev/polaris/contracts/bindings/cosmos/precompile/staking"
 	cosmlib "pkg.berachain.dev/polaris/cosmos/lib"
-	testutil "pkg.berachain.dev/polaris/cosmos/testing/utils"
+	testutil "pkg.berachain.dev/polaris/cosmos/testutil"
 	"pkg.berachain.dev/polaris/eth/accounts/abi"
 	"pkg.berachain.dev/polaris/eth/common"
 	ethprecompile "pkg.berachain.dev/polaris/eth/core/precompile"
@@ -88,7 +89,7 @@ var _ = Describe("Staking", func() {
 	)
 
 	BeforeEach(func() {
-		sdkCtx, ak, bk, sk = testutil.SetupMinimalKeepers()
+		sdkCtx, ak, bk, sk = testutil.SetupMinimalKeepers(log.NewTestLogger(GinkgoT()))
 		contract = libutils.MustGetAs[*Contract](NewPrecompileContract(ak, &sk))
 		sf = ethprecompile.NewStatefulFactory()
 	})

diff --git a/cosmos/store/cachekv/readonly_store.go b/cosmos/store/cachekv/readonly_store.go
@@ -26,14 +26,14 @@ import (
 	"pkg.berachain.dev/polaris/eth/core/vm"
 )
 
-var _ storetypes.CacheKVStore = (*ReadOnlyStore)(nil)
+var _ storetypes.KVStore = (*ReadOnlyStore)(nil)
 
 // ReadOnlyStore is a wrapper around cachekv.Store that panics on any write operation.
 type ReadOnlyStore struct {
-	storetypes.CacheKVStore
+	storetypes.KVStore
 }
 
-func NewReadOnlyStoreFor(cacheKVStore storetypes.CacheKVStore) *ReadOnlyStore {
+func NewReadOnlyStoreFor(cacheKVStore storetypes.KVStore) *ReadOnlyStore {
 	return &ReadOnlyStore{cacheKVStore}
 }
 

diff --git a/cosmos/store/cachekv/readonly_store_test.go b/cosmos/store/cachekv/readonly_store_test.go
@@ -23,11 +23,11 @@ package cachekv_test
 import (
 	"testing"
 
-	sdkcachekv "cosmossdk.io/store/cachekv"
-	storetypes "cosmossdk.io/store/types"
+	cdb "github.com/cosmos/cosmos-db"
+
+	"cosmossdk.io/store/dbadapter"
 
 	"pkg.berachain.dev/polaris/cosmos/store/cachekv"
-	"pkg.berachain.dev/polaris/cosmos/testing/types/mock"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -42,10 +42,9 @@ var _ = Describe("ReadOnly Store", func() {
 	var readOnlyStore *cachekv.ReadOnlyStore
 
 	BeforeEach(func() {
-		ms := mock.NewMultiStore()
-		kv := ms.GetKVStore(storetypes.NewKVStoreKey("test"))
-		kv.Set([]byte("key"), []byte("value"))
-		readOnlyStore = cachekv.NewReadOnlyStoreFor(sdkcachekv.NewStore(kv))
+		kvStore := dbadapter.Store{DB: cdb.NewMemDB()}
+		kvStore.Set([]byte("key"), []byte("value"))
+		readOnlyStore = cachekv.NewReadOnlyStoreFor(kvStore)
 	})
 
 	It("should panic only on writes", func() {