feat: create test chains with custom app creation functions (#8154) (#8189)

* feat: add additional constructor to create a test chain with a specific app creation function

* chore: fix linter

---------

Co-authored-by: Gjermund Garaba <[email protected]>
(cherry picked from commit fe25b21)

Co-authored-by: Cian Hatton <[email protected]>

Author: mergify[bot]

modules/apps/callbacks/callbacks_test.go

@@ -32,10 +32,6 @@ import (
 
 const maxCallbackGas = uint64(1000000)
 
-func init() {
-	ibctesting.DefaultTestingAppInit = SetupTestingApp
-}
-
 // SetupTestingApp provides the duplicated simapp which is specific to the callbacks module on chain creation.
 func SetupTestingApp() (ibctesting.TestingApp, map[string]json.RawMessage) {
 	db := dbm.NewMemDB()
@@ -67,7 +63,7 @@ type CallbacksTestSuite struct {
 
 // setupChains sets up a coordinator with 2 test chains.
 func (s *CallbacksTestSuite) setupChains() {
-	s.coordinator = ibctesting.NewCoordinator(s.T(), 2)
+	s.coordinator = ibctesting.NewCustomAppCoordinator(s.T(), 2, SetupTestingApp)
 	s.chainA = s.coordinator.GetChain(ibctesting.GetChainID(1))
 	s.chainB = s.coordinator.GetChain(ibctesting.GetChainID(2))
 	s.path = ibctesting.NewPath(s.chainA, s.chainB)

modules/apps/callbacks/v2/v2_test.go

@@ -23,10 +23,6 @@ import (
 
 const maxCallbackGas = uint64(1000000)
 
-func init() {
-	ibctesting.DefaultTestingAppInit = SetupTestingApp
-}
-
 // SetupTestingApp provides the duplicated simapp which is specific to the callbacks module on chain creation.
 func SetupTestingApp() (ibctesting.TestingApp, map[string]json.RawMessage) {
 	db := dbm.NewMemDB()
@@ -58,7 +54,7 @@ type CallbacksTestSuite struct {
 
 // setupChains sets up a coordinator with 2 test chains.
 func (s *CallbacksTestSuite) setupChains() {
-	s.coordinator = ibctesting.NewCoordinator(s.T(), 2)
+	s.coordinator = ibctesting.NewCustomAppCoordinator(s.T(), 2, SetupTestingApp)
 	s.chainA = s.coordinator.GetChain(ibctesting.GetChainID(1))
 	s.chainB = s.coordinator.GetChain(ibctesting.GetChainID(2))
 	s.path = ibctesting.NewPath(s.chainA, s.chainB)

modules/light-clients/08-wasm/internal/types/store_test.go

@@ -24,10 +24,6 @@ import (
 	ibctesting "github.com/cosmos/ibc-go/v10/testing"
 )
 
-func init() {
-	ibctesting.DefaultTestingAppInit = setupTestingApp
-}
-
 var invalidPrefix = []byte("invalid/")
 
 type TypesTestSuite struct {
@@ -41,9 +37,7 @@ func TestWasmTestSuite(t *testing.T) {
 }
 
 func (suite *TypesTestSuite) SetupTest() {
-	ibctesting.DefaultTestingAppInit = setupTestingApp
-
-	suite.coordinator = ibctesting.NewCoordinator(suite.T(), 1)
+	suite.coordinator = ibctesting.NewCustomAppCoordinator(suite.T(), 1, setupTestingApp)
 	suite.chainA = suite.coordinator.GetChain(ibctesting.GetChainID(1))
 }
 

modules/light-clients/08-wasm/keeper/keeper_test.go

@@ -44,10 +44,6 @@ type KeeperTestSuite struct {
 	chainA *ibctesting.TestChain
 }
 
-func init() {
-	ibctesting.DefaultTestingAppInit = setupTestingApp
-}
-
 // setupTestingApp provides the duplicated simapp which is specific to the 08-wasm module on chain creation.
 func setupTestingApp() (ibctesting.TestingApp, map[string]json.RawMessage) {
 	db := dbm.NewMemDB()
@@ -66,7 +62,7 @@ func GetSimApp(chain *ibctesting.TestChain) *simapp.SimApp {
 }
 
 func (suite *KeeperTestSuite) SetupTest() {
-	suite.coordinator = ibctesting.NewCoordinator(suite.T(), 1)
+	suite.coordinator = ibctesting.NewCustomAppCoordinator(suite.T(), 1, setupTestingApp)
 	suite.chainA = suite.coordinator.GetChain(ibctesting.GetChainID(1))
 
 	queryHelper := baseapp.NewQueryServerTestHelper(suite.chainA.GetContext(), GetSimApp(suite.chainA).InterfaceRegistry())
@@ -75,9 +71,7 @@ func (suite *KeeperTestSuite) SetupTest() {
 
 // SetupWasmWithMockVM sets up mock cometbft chain with a mock vm.
 func (suite *KeeperTestSuite) SetupWasmWithMockVM() {
-	ibctesting.DefaultTestingAppInit = suite.setupWasmWithMockVM
-
-	suite.coordinator = ibctesting.NewCoordinator(suite.T(), 1)
+	suite.coordinator = ibctesting.NewCustomAppCoordinator(suite.T(), 1, suite.setupWasmWithMockVM)
 	suite.chainA = suite.coordinator.GetChain(ibctesting.GetChainID(1))
 }
 
@@ -115,8 +109,6 @@ func (suite *KeeperTestSuite) setupWasmWithMockVM() (ibctesting.TestingApp, map[
 	db := dbm.NewMemDB()
 	app := simapp.NewUnitTestSimApp(log.NewNopLogger(), db, nil, true, simtestutil.EmptyAppOptions{}, suite.mockVM)
 
-	// reset DefaultTestingAppInit to its original value
-	ibctesting.DefaultTestingAppInit = setupTestingApp
 	return app, app.DefaultGenesis()
 }
 

modules/light-clients/08-wasm/types/types_test.go

@@ -32,16 +32,10 @@ func TestWasmTestSuite(t *testing.T) {
 }
 
 func (suite *TypesTestSuite) SetupTest() {
-	ibctesting.DefaultTestingAppInit = setupTestingApp
-
-	suite.coordinator = ibctesting.NewCoordinator(suite.T(), 1)
+	suite.coordinator = ibctesting.NewCustomAppCoordinator(suite.T(), 1, setupTestingApp)
 	suite.chainA = suite.coordinator.GetChain(ibctesting.GetChainID(1))
 }
 
-func init() {
-	ibctesting.DefaultTestingAppInit = setupTestingApp
-}
-
 // GetSimApp returns the duplicated SimApp from within the 08-wasm directory.
 // This must be used instead of chain.GetSimApp() for tests within this directory.
 func GetSimApp(chain *ibctesting.TestChain) *simapp.SimApp {

modules/light-clients/08-wasm/wasm_test.go

@@ -41,16 +41,10 @@ func TestWasmTestSuite(t *testing.T) {
 }
 
 func (suite *WasmTestSuite) SetupTest() {
-	ibctesting.DefaultTestingAppInit = setupTestingApp
-
-	suite.coordinator = ibctesting.NewCoordinator(suite.T(), 1)
+	suite.coordinator = ibctesting.NewCustomAppCoordinator(suite.T(), 1, setupTestingApp)
 	suite.chainA = suite.coordinator.GetChain(ibctesting.GetChainID(1))
 }
 
-func init() {
-	ibctesting.DefaultTestingAppInit = setupTestingApp
-}
-
 // GetSimApp returns the duplicated SimApp from within the 08-wasm directory.
 // This must be used instead of chain.GetSimApp() for tests within this directory.
 func GetSimApp(chain *ibctesting.TestChain) *simapp.SimApp {
@@ -70,9 +64,7 @@ func setupTestingApp() (ibctesting.TestingApp, map[string]json.RawMessage) {
 
 // SetupWasmWithMockVM sets up mock cometbft chain with a mock vm.
 func (suite *WasmTestSuite) SetupWasmWithMockVM() {
-	ibctesting.DefaultTestingAppInit = suite.setupWasmWithMockVM
-
-	suite.coordinator = ibctesting.NewCoordinator(suite.T(), 1)
+	suite.coordinator = ibctesting.NewCustomAppCoordinator(suite.T(), 1, suite.setupWasmWithMockVM)
 	suite.chainA = suite.coordinator.GetChain(ibctesting.GetChainID(1))
 	suite.checksum = storeWasmCode(suite, wasmtesting.Code)
 }
@@ -111,8 +103,6 @@ func (suite *WasmTestSuite) setupWasmWithMockVM() (ibctesting.TestingApp, map[st
 	db := dbm.NewMemDB()
 	app := simapp.NewUnitTestSimApp(log.NewNopLogger(), db, nil, true, simtestutil.EmptyAppOptions{}, suite.mockVM)
 
-	// reset DefaultTestingAppInit to its original value
-	ibctesting.DefaultTestingAppInit = setupTestingApp
 	return app, app.DefaultGenesis()
 }
 

testing/chain.go

@@ -1,6 +1,7 @@
 package ibctesting
 
 import (
+	"encoding/json"
 	"fmt"
 	"testing"
 	"time"
@@ -102,6 +103,10 @@ type TestChain struct {
 // CONTRACT: Validator array must be provided in the order expected by Tendermint.
 // i.e. sorted first by power and then lexicographically by address.
 func NewTestChainWithValSet(tb testing.TB, coord *Coordinator, chainID string, valSet *cmttypes.ValidatorSet, signers map[string]cmttypes.PrivValidator) *TestChain {
+	return newTestChainWithValSet(tb, coord, chainID, valSet, signers, DefaultTestingAppInit)
+}
+
+func newTestChainWithValSet(tb testing.TB, coord *Coordinator, chainID string, valSet *cmttypes.ValidatorSet, signers map[string]cmttypes.PrivValidator, appCreator AppCreator) *TestChain {
 	tb.Helper()
 	genAccs := []authtypes.GenesisAccount{}
 	genBals := []banktypes.Balance{}
@@ -134,7 +139,7 @@ func NewTestChainWithValSet(tb testing.TB, coord *Coordinator, chainID string, v
 		senderAccs = append(senderAccs, senderAcc)
 	}
 
-	app := SetupWithGenesisValSet(tb, valSet, genAccs, chainID, sdk.DefaultPowerReduction, genBals...)
+	app := setupWithGenesisValSet(tb, valSet, genAccs, chainID, sdk.DefaultPowerReduction, appCreator, genBals...)
 
 	// create current header and call begin block
 	header := cmtproto.Header{
@@ -169,9 +174,11 @@ func NewTestChainWithValSet(tb testing.TB, coord *Coordinator, chainID string, v
 	return chain
 }
 
-// NewTestChain initializes a new test chain with a default of 4 validators
-// Use this function if the tests do not need custom control over the validator set
-func NewTestChain(t *testing.T, coord *Coordinator, chainID string) *TestChain {
+// AppCreator is a function which returns a TestingApp and a GenesisState
+type AppCreator func() (TestingApp, map[string]json.RawMessage)
+
+// NewCustomAppTestChain creates a TestChain instance with the provided AppCreator function.
+func NewCustomAppTestChain(t *testing.T, coord *Coordinator, chainID string, appCreator AppCreator) *TestChain {
 	t.Helper()
 	// generate validators private/public key
 	var (
@@ -193,7 +200,14 @@ func NewTestChain(t *testing.T, coord *Coordinator, chainID string) *TestChain {
 	// or, if equal, by address lexical order
 	valSet := cmttypes.NewValidatorSet(validators)
 
-	return NewTestChainWithValSet(t, coord, chainID, valSet, signersByAddress)
+	return newTestChainWithValSet(t, coord, chainID, valSet, signersByAddress, appCreator)
+}
+
+// NewTestChain initializes a new test chain with a default of 4 validators
+// Use this function if the tests do not need custom control over the validator set
+func NewTestChain(t *testing.T, coord *Coordinator, chainID string) *TestChain {
+	t.Helper()
+	return NewCustomAppTestChain(t, coord, chainID, DefaultTestingAppInit)
 }
 
 // GetContext returns the current context for the application.

testing/coordinator.go

@@ -28,6 +28,11 @@ type Coordinator struct {
 
 // NewCoordinator initializes Coordinator with N TestChain's
 func NewCoordinator(t *testing.T, n int) *Coordinator {
+	return NewCustomAppCoordinator(t, n, DefaultTestingAppInit)
+}
+
+// NewCustomAppCoordinator initializes a Coordinator with N TestChain's using the given AppCreator function.
+func NewCustomAppCoordinator(t *testing.T, n int, appCreator AppCreator) *Coordinator {
 	t.Helper()
 	chains := make(map[string]*TestChain)
 	coord := &Coordinator{
@@ -37,7 +42,7 @@ func NewCoordinator(t *testing.T, n int) *Coordinator {
 
 	for i := 1; i <= n; i++ {
 		chainID := GetChainID(i)
-		chains[chainID] = NewTestChain(t, coord, chainID)
+		chains[chainID] = NewCustomAppTestChain(t, coord, chainID, appCreator)
 	}
 	coord.Chains = chains
 

testing/testing_app.go

@@ -31,7 +31,7 @@ import (
 	"github.com/cosmos/ibc-go/v10/testing/simapp"
 )
 
-var DefaultTestingAppInit = SetupTestingApp
+var DefaultTestingAppInit AppCreator = SetupTestingApp
 
 type TestingApp interface {
 	servertypes.ABCI
@@ -60,8 +60,12 @@ func SetupTestingApp() (TestingApp, map[string]json.RawMessage) {
 // of one consensus engine unit (10^6) in the default token of the simapp from first genesis
 // account. A Nop logger is set in SimApp.
 func SetupWithGenesisValSet(tb testing.TB, valSet *cmttypes.ValidatorSet, genAccs []authtypes.GenesisAccount, chainID string, powerReduction sdkmath.Int, balances ...banktypes.Balance) TestingApp {
+	return setupWithGenesisValSet(tb, valSet, genAccs, chainID, powerReduction, DefaultTestingAppInit, balances...)
+}
+
+func setupWithGenesisValSet(tb testing.TB, valSet *cmttypes.ValidatorSet, genAccs []authtypes.GenesisAccount, chainID string, powerReduction sdkmath.Int, appCreator AppCreator, balances ...banktypes.Balance) TestingApp {
 	tb.Helper()
-	app, genesisState := DefaultTestingAppInit()
+	app, genesisState := appCreator()
 
 	// ensure baseapp has a chain-id set before running InitChain
 	baseapp.SetChainID(chainID)(app.GetBaseApp())