e2e: Create only required number of chains. (#8371)

DeshErBojhaa · gjermundgaraba · DeshErBojhaa · commit 618a409d4dec · 2025-05-12T18:11:21.000+06:00
* sync deps * feat: create only necessary chains * updated changelog * feat: default chain setings * fix: missing tags for chain C and D * test * chore: remove e2e fork and draft restrictions (#8359) * bump wasmvm to v2.2.4, go-etheruem to v1.15.11, spf13/cast to v1.8.0 (#8369) * sync deps * bump wasmvm to v2.2.4, go-etheruem to v1.15.11, spf13/cast to v1.8.0 (#8369) * sync deps * bump wasmvm to v2.2.4, go-etheruem to v1.15.11, spf13/cast to v1.8.0 (#8369) * fix dep * sync dep * fix missing tags for C and D * remove comments --------- Signed-off-by: tamjidahmed <mail.to.tamjid@gmail.com> Co-authored-by: Gjermund Garaba <gjermund@garaba.net>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -53,6 +53,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Bug Fixes
 
 ### Testing API
+* [\#8371](https://github.com/cosmos/ibc-go/pull/8371) e2e: Create only necessary number of chains for e2e suite.
 
 ## [v10.2.0](https://github.com/cosmos/ibc-go/releases/tag/v10.2.0) - 2022-04-30
 
diff --git a/e2e/README.md b/e2e/README.md
@@ -59,6 +59,15 @@ running tests locally via `make test`. For an example of this, see any of the ex
 New test suites should be composed of `testsuite.E2ETestSuite`. This type has lots of useful helper functionality that will
 be quite common in most tests.
 
+Override the default `SetupSuite` function with the number of chains required for the suite. Example:
+
+```go
+// SetupSuite sets up chains for the current test suite
+func (s *ConnectionTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil) // This suite requires at most two chains.
+}
+```
+
 > Note: see [here](#how-tests-are-run) for details about these requirements.
 
 ### Example of running a single test
diff --git a/e2e/ci-e2e-config.yaml b/e2e/ci-e2e-config.yaml
@@ -7,8 +7,8 @@
 # | CHAIN_IMAGE          | The image that will be used for the chain | ghcr.io/cosmos/ibc-go-simd   |
 # | CHAIN_A_TAG          | The tag used for chain A                  | N/A (must be set)            |
 # | CHAIN_B_TAG          | The tag used for chain B                  | N/A (must be set)            |
-# | CHAIN_C_TAG          | The tag used for chain C                  | N/A (must be set)            |
-# | CHAIN_D_TAG          | The tag used for chain D                  | N/A (must be set)            |
+# | CHAIN_C_TAG          | The tag used for chain C                  | N/A (optional; fallback to A)|
+# | CHAIN_D_TAG          | The tag used for chain D                  | N/A (optional; fallback to A)|
 # | CHAIN_BINARY         | The binary used in the container          | simd                         |
 # | RELAYER_TAG          | The tag used for the relayer              | 1.10.4                       |
 # | RELAYER_ID           | The type of relayer to use (rly/hermes)   | hermes                       |
diff --git a/e2e/go.mod b/e2e/go.mod
@@ -53,7 +53,7 @@ require (
 	filippo.io/edwards25519 v1.1.0 // indirect
 	github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4 // indirect
 	github.com/99designs/keyring v1.2.2 // indirect
-	github.com/BurntSushi/toml v1.4.0 // indirect
+	github.com/BurntSushi/toml v1.4.1-0.20240526193622-a339e1f7089c // indirect
 	github.com/CosmWasm/wasmvm/v2 v2.2.4 // indirect
 	github.com/DataDog/datadog-go v4.8.3+incompatible // indirect
 	github.com/DataDog/zstd v1.5.7 // indirect
@@ -127,7 +127,7 @@ require (
 	github.com/google/flatbuffers v24.3.25+incompatible // indirect
 	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/orderedcode v0.0.1 // indirect
-	github.com/google/pprof v0.0.0-20231023181126-ff6d637d2a7b // indirect
+	github.com/google/pprof v0.0.0-20240727154555-813a5fbdbec8 // indirect
 	github.com/google/s2a-go v0.1.9 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.4 // indirect
diff --git a/e2e/go.sum b/e2e/go.sum
@@ -731,8 +731,8 @@ github.com/bits-and-blooms/bitset v1.22.0 h1:Tquv9S8+SGaS3EhyA+up3FXzmkhxPGjQQCk
 github.com/bits-and-blooms/bitset v1.22.0/go.mod h1:7hO7Gc7Pp1vODcmWvKMRA9BNmbv6a/7QIWpPxHddWR8=
 github.com/boombuler/barcode v1.0.0/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8=
 github.com/boombuler/barcode v1.0.1/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8=
-github.com/btcsuite/btcd/btcec/v2 v2.3.2 h1:5n0X6hX0Zk+6omWcihdYvdAlGf2DfasC0GMf7DClJ3U=
-github.com/btcsuite/btcd/btcec/v2 v2.3.2/go.mod h1:zYzJ8etWJQIv1Ogk7OzpWjowwOdXY1W/17j2MW85J04=
+github.com/btcsuite/btcd/btcec/v2 v2.3.4 h1:3EJjcN70HCu/mwqlUsGK8GcNVyLVxFDlWurTXGPFfiQ=
+github.com/btcsuite/btcd/btcec/v2 v2.3.4/go.mod h1:zYzJ8etWJQIv1Ogk7OzpWjowwOdXY1W/17j2MW85J04=
 github.com/btcsuite/btcd/btcutil v1.1.6 h1:zFL2+c3Lb9gEgqKNzowKUPQNb8jV7v5Oaodi/AYFd6c=
 github.com/btcsuite/btcd/btcutil v1.1.6/go.mod h1:9dFymx8HpuLqBnsPELrImQeTQfKBQqzqGbbV3jK55aE=
 github.com/bufbuild/protocompile v0.14.1 h1:iA73zAf/fyljNjQKwYzUHD6AD4R8KMasmwa/FBatYVw=
diff --git a/e2e/tests/core/02-client/client_test.go b/e2e/tests/core/02-client/client_test.go
@@ -61,6 +61,11 @@ func (s *ClientTestSuite) QueryAllowedClients(ctx context.Context, chain ibc.Cha
 	return res.Params.AllowedClients
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *ClientTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 // TestScheduleIBCUpgrade_Succeeds tests that a governance proposal to schedule an IBC software upgrade is successful.
 // compatibility:TestScheduleIBCUpgrade_Succeeds:from_versions: v8.7.0,v10.0.0
 func (s *ClientTestSuite) TestScheduleIBCUpgrade_Succeeds() {
diff --git a/e2e/tests/core/03-connection/connection_test.go b/e2e/tests/core/03-connection/connection_test.go
@@ -34,6 +34,11 @@ type ConnectionTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *ConnectionTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 func (s *ConnectionTestSuite) CreateConnectionTestPath(testName string) (ibc.Relayer, ibc.ChannelOutput) {
 	return s.CreatePaths(ibc.DefaultClientOpts(), s.TransferChannelOptions(), testName), s.GetChainAToChainBChannel(testName)
 }
diff --git a/e2e/tests/interchain_accounts/base_test.go b/e2e/tests/interchain_accounts/base_test.go
@@ -45,6 +45,11 @@ type InterchainAccountsTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *InterchainAccountsTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 // RegisterInterchainAccount will attempt to register an interchain account on the counterparty chain.
 func (s *InterchainAccountsTestSuite) RegisterInterchainAccount(ctx context.Context, chain ibc.Chain, user ibc.Wallet, msgRegisterAccount *controllertypes.MsgRegisterInterchainAccount) {
 	txResp := s.BroadcastMessages(ctx, chain, user, msgRegisterAccount)
diff --git a/e2e/tests/interchain_accounts/gov_test.go b/e2e/tests/interchain_accounts/gov_test.go
@@ -37,6 +37,11 @@ type InterchainAccountsGovTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *InterchainAccountsGovTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 func (s *InterchainAccountsGovTestSuite) TestInterchainAccountsGovIntegration() {
 	t := s.T()
 	ctx := context.TODO()
diff --git a/e2e/tests/interchain_accounts/groups_test.go b/e2e/tests/interchain_accounts/groups_test.go
@@ -68,6 +68,11 @@ type InterchainAccountsGroupsTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *InterchainAccountsGroupsTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 func (s *InterchainAccountsGroupsTestSuite) QueryGroupPolicyAddress(ctx context.Context, chain ibc.Chain) string {
 	res, err := query.GRPCQuery[grouptypes.QueryGroupPoliciesByGroupResponse](ctx, chain, &grouptypes.QueryGroupPoliciesByGroupRequest{
 		GroupId: InitialGroupID, // always use the initial group id
diff --git a/e2e/tests/interchain_accounts/localhost_test.go b/e2e/tests/interchain_accounts/localhost_test.go
@@ -39,6 +39,11 @@ type LocalhostInterchainAccountsTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *LocalhostInterchainAccountsTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 1, nil)
+}
+
 // compatibility:TestInterchainAccounts_Localhost:from_versions: v7.10.0,v8.7.0,v10.0.0
 func (s *LocalhostInterchainAccountsTestSuite) TestInterchainAccounts_Localhost() {
 	t := s.T()
@@ -47,7 +52,8 @@ func (s *LocalhostInterchainAccountsTestSuite) TestInterchainAccounts_Localhost(
 	testName := t.Name()
 	s.CreateDefaultPaths(testName)
 
-	chainA, _ := s.GetChains()
+	chains := s.GetAllChains()
+	chainA := chains[0]
 
 	chainADenom := chainA.Config().Denom
 
@@ -203,7 +209,8 @@ func (s *LocalhostInterchainAccountsTestSuite) TestInterchainAccounts_ReopenChan
 	testName := t.Name()
 	s.CreateDefaultPaths(testName)
 
-	chainA, _ := s.GetChains()
+	chains := s.GetAllChains()
+	chainA := chains[0]
 
 	chainADenom := chainA.Config().Denom
 
diff --git a/e2e/tests/interchain_accounts/params_test.go b/e2e/tests/interchain_accounts/params_test.go
@@ -40,6 +40,11 @@ type InterchainAccountsParamsTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *InterchainAccountsParamsTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 // QueryControllerParams queries the params for the controller
 func (s *InterchainAccountsParamsTestSuite) QueryControllerParams(ctx context.Context, chain ibc.Chain) controllertypes.Params {
 	res, err := query.GRPCQuery[controllertypes.QueryParamsResponse](ctx, chain, &controllertypes.QueryParamsRequest{})
diff --git a/e2e/tests/interchain_accounts/query_test.go b/e2e/tests/interchain_accounts/query_test.go
@@ -35,6 +35,11 @@ type InterchainAccountsQueryTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *InterchainAccountsQueryTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 // compatibility:TestInterchainAccountsQuery:from_versions: v7.10.0,v8.7.0,v10.0.0
 func (s *InterchainAccountsQueryTestSuite) TestInterchainAccountsQuery() {
 	t := s.T()
diff --git a/e2e/tests/transfer/authz_test.go b/e2e/tests/transfer/authz_test.go
@@ -33,6 +33,11 @@ type AuthzTransferTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *AuthzTransferTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 func (suite *AuthzTransferTestSuite) CreateAuthzTestPath(testName string) (ibc.Relayer, ibc.ChannelOutput) {
 	return suite.CreatePaths(ibc.DefaultClientOpts(), suite.TransferChannelOptions(), testName), suite.GetChainAToChainBChannel(testName)
 }
diff --git a/e2e/tests/transfer/base_test.go b/e2e/tests/transfer/base_test.go
@@ -30,6 +30,11 @@ type TransferTestSuite struct {
 	transferTester
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *TransferTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 // transferTester defines some helper functions that can be used in various test suites
 // that test transfer functionality.
 type transferTester struct {
diff --git a/e2e/tests/transfer/localhost_test.go b/e2e/tests/transfer/localhost_test.go
@@ -29,14 +29,20 @@ type LocalhostTransferTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *LocalhostTransferTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 1, nil)
+}
+
 // TestMsgTransfer_Localhost creates two wallets on a single chain and performs MsgTransfers back and forth
 // to ensure ibc functions as expected on localhost. This test is largely the same as TestMsgTransfer_Succeeds_Nonincentivized
 // except that chain B is replaced with an additional wallet on chainA.
 func (s *LocalhostTransferTestSuite) TestMsgTransfer_Localhost() {
 	t := s.T()
 	ctx := context.TODO()
 
-	chainA, _ := s.GetChains()
+	chains := s.GetAllChains()
+	chainA := chains[0]
 
 	channelVersion := transfertypes.V1
 
diff --git a/e2e/tests/transfer/send_enabled_test.go b/e2e/tests/transfer/send_enabled_test.go
@@ -29,7 +29,7 @@ type TransferTestSuiteSendEnabled struct {
 }
 
 func (s *TransferTestSuiteSendEnabled) SetupSuite() {
-	s.SetupChains(context.TODO(), nil, func(options *testsuite.ChainOptions) {
+	s.SetupChains(context.TODO(), 2, nil, func(options *testsuite.ChainOptions) {
 		options.RelayerCount = 1
 	})
 }
diff --git a/e2e/tests/transfer/send_receive_test.go b/e2e/tests/transfer/send_receive_test.go
@@ -29,7 +29,7 @@ type TransferTestSuiteSendReceive struct {
 }
 
 func (s *TransferTestSuiteSendReceive) SetupSuite() {
-	s.SetupChains(context.TODO(), nil, func(options *testsuite.ChainOptions) {
+	s.SetupChains(context.TODO(), 2, nil, func(options *testsuite.ChainOptions) {
 		options.RelayerCount = 1
 	})
 }
diff --git a/e2e/tests/upgrades/genesis_test.go b/e2e/tests/upgrades/genesis_test.go
@@ -37,6 +37,27 @@ type GenesisTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *GenesisTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
+// TODO: this configuration was originally being applied to `GetChains` in the test body, but it is not
+// actually being propagated correctly. If we want to apply the configuration, we can uncomment this code
+// however the test actually fails when this is done.
+// func (s *GenesisTestSuite) SetupSuite() {
+//	configFileOverrides := make(map[string]any)
+//	appTomlOverrides := make(test.Toml)
+//
+//	appTomlOverrides["halt-height"] = haltHeight
+//	configFileOverrides["config/app.toml"] = appTomlOverrides
+//
+//	s.SetupChains(context.TODO(), nil, func(options *testsuite.ChainOptions) {
+//		// create chains with specified chain configuration options
+//		options.ChainSpecs[0].ConfigFileOverrides = configFileOverrides
+//	})
+// }
+
 func (s *GenesisTestSuite) TestIBCGenesis() {
 	t := s.T()
 
diff --git a/e2e/tests/upgrades/upgrade_test.go b/e2e/tests/upgrades/upgrade_test.go
@@ -55,6 +55,11 @@ type UpgradeTestSuite struct {
 	testsuite.E2ETestSuite
 }
 
+// SetupSuite sets up chains for the current test suite
+func (s *UpgradeTestSuite) SetupSuite() {
+	s.SetupChains(context.TODO(), 2, nil)
+}
+
 func (s *UpgradeTestSuite) CreateUpgradeTestPath(testName string) (ibc.Relayer, ibc.ChannelOutput) {
 	return s.CreatePaths(ibc.DefaultClientOpts(), s.TransferChannelOptions(), testName), s.GetChainAToChainBChannel(testName)
 }
diff --git a/e2e/testsuite/testconfig.go b/e2e/testsuite/testconfig.go
diff --git a/e2e/testsuite/testsuite.go b/e2e/testsuite/testsuite.go
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
diff --git a/modules/light-clients/08-wasm/go.mod b/modules/light-clients/08-wasm/go.mod
diff --git a/modules/light-clients/08-wasm/go.sum b/modules/light-clients/08-wasm/go.sum
diff --git a/simapp/go.mod b/simapp/go.mod
diff --git a/simapp/go.sum b/simapp/go.sum

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,11 @@ type ConnectionTestSuite struct {`
`34`	`34`	`testsuite.E2ETestSuite`
`35`	`35`	`}`
`36`	`36`
	`37`	`+// SetupSuite sets up chains for the current test suite`
	`38`	`+func (s *ConnectionTestSuite) SetupSuite() {`
	`39`	`+ s.SetupChains(context.TODO(), 2, nil)`
	`40`	`+}`
	`41`	`+`
`37`	`42`	`func (s *ConnectionTestSuite) CreateConnectionTestPath(testName string) (ibc.Relayer, ibc.ChannelOutput) {`
`38`	`43`	`return s.CreatePaths(ibc.DefaultClientOpts(), s.TransferChannelOptions(), testName), s.GetChainAToChainBChannel(testName)`
`39`	`44`	`}`