tests: add option to dump genesis files in E2E tests

e2e/scripts/run-e2e.sh

@@ -59,7 +59,7 @@ _verify_dependencies
 
 # if the dev configs directory is present, enable fzf completion to select a test config file to use.
 if [[ -d "dev-configs"  ]]; then
-  export E2E_CONFIG_PATH="$(pwd)/dev-configs/$(_select_test_config)"
+  export E2E_CONFIG_PATH="/workspaces/ibc-go/e2e/dev-configs/config.yaml"
   echo "Using configuration file at ${E2E_CONFIG_PATH}"
 fi
 

e2e/tests/core/02-client/client_test.go

@@ -44,7 +44,9 @@ const (
 )
 
 func TestClientTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(ClientTestSuite))
+	s := new(ClientTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type ClientTestSuite struct {

e2e/tests/core/03-connection/connection_test.go

@@ -25,7 +25,9 @@ import (
 )
 
 func TestConnectionTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(ConnectionTestSuite))
+	s := new(ConnectionTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type ConnectionTestSuite struct {

e2e/tests/interchain_accounts/base_test.go

@@ -36,7 +36,9 @@ var orderMapping = map[channeltypes.Order][]string{
 }
 
 func TestInterchainAccountsTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(InterchainAccountsTestSuite))
+	s := new(InterchainAccountsTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type InterchainAccountsTestSuite struct {

e2e/tests/interchain_accounts/gov_test.go

@@ -28,7 +28,9 @@ import (
 )
 
 func TestInterchainAccountsGovTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(InterchainAccountsGovTestSuite))
+	s := new(InterchainAccountsGovTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type InterchainAccountsGovTestSuite struct {

e2e/tests/interchain_accounts/groups_test.go

@@ -59,7 +59,9 @@ const (
 )
 
 func TestInterchainAccountsGroupsTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(InterchainAccountsGroupsTestSuite))
+	s := new(InterchainAccountsGroupsTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type InterchainAccountsGroupsTestSuite struct {

e2e/tests/interchain_accounts/incentivized_test.go

@@ -28,7 +28,9 @@ import (
 )
 
 func TestIncentivizedInterchainAccountsTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(IncentivizedInterchainAccountsTestSuite))
+	s := new(IncentivizedInterchainAccountsTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type IncentivizedInterchainAccountsTestSuite struct {

e2e/tests/interchain_accounts/localhost_test.go

@@ -30,7 +30,9 @@ import (
 )
 
 func TestInterchainAccountsLocalhostTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(LocalhostInterchainAccountsTestSuite))
+	s := new(LocalhostInterchainAccountsTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type LocalhostInterchainAccountsTestSuite struct {

e2e/tests/interchain_accounts/params_test.go

@@ -31,7 +31,9 @@ import (
 )
 
 func TestInterchainAccountsParamsTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(InterchainAccountsParamsTestSuite))
+	s := new(InterchainAccountsParamsTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type InterchainAccountsParamsTestSuite struct {

e2e/tests/interchain_accounts/query_test.go

@@ -26,7 +26,9 @@ import (
 )
 
 func TestInterchainAccountsQueryTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(InterchainAccountsQueryTestSuite))
+	s := new(InterchainAccountsQueryTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type InterchainAccountsQueryTestSuite struct {

e2e/tests/interchain_accounts/upgrades_test.go

@@ -29,7 +29,9 @@ import (
 )
 
 func TestInterchainAccountsChannelUpgradesTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(InterchainAccountsChannelUpgradesTestSuite))
+	s := new(InterchainAccountsChannelUpgradesTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type InterchainAccountsChannelUpgradesTestSuite struct {

e2e/tests/transfer/authz_test.go

@@ -23,7 +23,9 @@ import (
 )
 
 func TestAuthzTransferTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(AuthzTransferTestSuite))
+	s := new(AuthzTransferTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type AuthzTransferTestSuite struct {

e2e/tests/transfer/base_test.go

@@ -25,7 +25,9 @@ import (
 )
 
 func TestTransferTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(TransferTestSuite))
+	suite := new(TransferTestSuite)
+	suite.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, suite)
 }
 
 type TransferTestSuite struct {

e2e/tests/transfer/incentivized_test.go

@@ -32,7 +32,9 @@ type IncentivizedTransferTestSuite struct {
 }
 
 func TestIncentivizedTransferTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(IncentivizedTransferTestSuite))
+	s := new(IncentivizedTransferTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 func (s *IncentivizedTransferTestSuite) TestMsgPayPacketFee_AsyncSingleSender_Succeeds() {

e2e/tests/transfer/localhost_test.go

@@ -20,7 +20,9 @@ import (
 )
 
 func TestTransferLocalhostTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(LocalhostTransferTestSuite))
+	s := new(LocalhostTransferTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type LocalhostTransferTestSuite struct {

e2e/tests/transfer/upgrades_test.go

@@ -21,7 +21,9 @@ import (
 )
 
 func TestTransferChannelUpgradesTestSuite(t *testing.T) {
-	testifysuite.Run(t, new(TransferChannelUpgradesTestSuite))
+	s := new(TransferChannelUpgradesTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type TransferChannelUpgradesTestSuite struct {

e2e/tests/upgrades/genesis_test.go

@@ -29,7 +29,9 @@ import (
 )
 
 func TestGenesisTestSuite(t *testing.T) {
-	suite.Run(t, new(GenesisTestSuite))
+	s := new(GenesisTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	suite.Run(t, s)
 }
 
 type GenesisTestSuite struct {

e2e/tests/upgrades/upgrade_test.go

@@ -47,8 +47,9 @@ func TestUpgradeTestSuite(t *testing.T) {
 	if testCfg.UpgradeConfig.Tag == "" || testCfg.UpgradeConfig.PlanName == "" {
 		t.Fatalf("%s and %s must be set when running an upgrade test", testsuite.ChainUpgradeTagEnv, testsuite.ChainUpgradePlanEnv)
 	}
-
-	testifysuite.Run(t, new(UpgradeTestSuite))
+	s := new(UpgradeTestSuite)
+	s.ConfigureGenesisDebugExport(t)
+	testifysuite.Run(t, s)
 }
 
 type UpgradeTestSuite struct {

e2e/testsuite/diagnostics/diagnostics.go

@@ -37,7 +37,7 @@ func Collect(t *testing.T, dc *dockerclient.Client, debugModeEnabled bool, chain
 	t.Logf("writing logs for test: %s", t.Name())
 
 	ctx := context.TODO()
-	e2eDir, err := getE2EDir(t)
+	e2eDir, err := GetE2EDir(t)
 	if err != nil {
 		t.Logf("failed finding log directory: %s", err)
 		return
@@ -162,8 +162,8 @@ func relayerDiagnosticAbsoluteFilePaths() []string {
 	}
 }
 
-// getE2EDir finds the e2e directory above the test.
-func getE2EDir(t *testing.T) (string, error) {
+// GetE2EDir finds the e2e directory above the test.
+func GetE2EDir(t *testing.T) (string, error) {
 	t.Helper()
 
 	wd, err := os.Getwd()

e2e/testsuite/testconfig.go

@@ -68,6 +68,9 @@ const (
 	// defaultConfigFileName is the default filename for the config file that can be used to configure
 	// e2e tests. See sample.config.yaml as an example for what this should look like.
 	defaultConfigFileName = ".ibc-go-e2e-config.yaml"
+
+	// defaultGenesisExportPath is the default path to which Genesis debug files will be exported to.
+	defaultGenesisExportPath = "diagnostics/genesis.json"
 )
 
 func getChainImage(binary string) string {
@@ -103,6 +106,10 @@ func (tc TestConfig) Validate() error {
 	if err := tc.validateRelayers(); err != nil {
 		return fmt.Errorf("invalid relayer configuration: %w", err)
 	}
+
+	if err := tc.validateGenesisDebugConfig(); err != nil {
+		return fmt.Errorf("invalid Genesis debug configuration: %w", err)
+	}
 	return nil
 }
 
@@ -118,6 +125,10 @@ func (tc TestConfig) validateChains() error {
 		if cfg.Tag == "" {
 			return fmt.Errorf("chain config missing tag: %+v", cfg)
 		}
+		// TODO: defaults?
+		if cfg.Name == "" {
+			return fmt.Errorf("chain config missing name: %+v", cfg)
+		}
 
 		// TODO: validate chainID in https://github.com/cosmos/ibc-go/issues/4697
 		// these are not passed in the CI at the moment. Defaults are used.
@@ -163,6 +174,33 @@ func (tc TestConfig) validateRelayers() error {
 	return nil
 }
 
+func (tc TestConfig) GetChainIndex(name string) (int, error) {
+	for i, chainCfg := range tc.ChainConfigs {
+		if chainCfg.Name == name {
+			return i, nil
+		}
+	}
+	return -1, fmt.Errorf("chain %s not found in chain configs", name)
+}
+
+// validateGenesisDebugConfig validates configuration of Genesis debug options/
+func (tc TestConfig) validateGenesisDebugConfig() error {
+	cfg := tc.DebugConfig.GenesisDebug
+	if !cfg.DumpGenesisDebugInfo {
+		return nil
+	}
+
+	if cfg.ChainName == "" {
+		// TODO create a default?
+		return fmt.Errorf("genesis debug config missing chain name: %+v", cfg)
+	}
+
+	// Verify that the provided chain exists in our config
+	_, err := tc.GetChainIndex(cfg.ChainName)
+
+	return err
+}
+
 // GetActiveRelayerConfig returns the currently specified relayer config.
 func (tc TestConfig) GetActiveRelayerConfig() *relayer.Config {
 	for _, r := range tc.RelayerConfigs {
@@ -216,6 +254,7 @@ type UpgradeConfig struct {
 // ChainConfig holds information about an individual chain used in the tests.
 type ChainConfig struct {
 	ChainID       string `yaml:"chainId"`
+	Name          string `yaml:"name"`
 	Image         string `yaml:"image"`
 	Tag           string `yaml:"tag"`
 	Binary        string `yaml:"binary"`
@@ -227,9 +266,23 @@ type CometBFTConfig struct {
 	LogLevel string `yaml:"logLevel"`
 }
 
+type GenesisDebugConfig struct {
+	// DumpGenesisDebugInfo enables the output of Genesis debug files.
+	DumpGenesisDebugInfo bool `yaml:"dumpGenesisDebugInfo"`
+
+	// ExportFilePath specifies which path to export Genesis debug files to.
+	ExportFilePath string `yaml:"filePath"`
+
+	// ChainName represent which chain to get Genesis debug info for.
+	ChainName string `yaml:"chainName"`
+}
+
 type DebugConfig struct {
 	// DumpLogs forces the logs to be collected before removing test containers.
 	DumpLogs bool `yaml:"dumpLogs"`
+
+	// GenesisDebug contains debug information specific to Genesis.
+	GenesisDebug GenesisDebugConfig `yaml:"genesis"`
 }
 
 // LoadConfig attempts to load a atest configuration from the default file path.
@@ -471,8 +524,8 @@ type ChainOptionConfiguration func(options *ChainOptions)
 func DefaultChainOptions() ChainOptions {
 	tc := LoadConfig()
 
-	chainACfg := newDefaultSimappConfig(tc.ChainConfigs[0], "simapp-a", tc.GetChainAID(), "atoma", tc.CometBFTConfig)
-	chainBCfg := newDefaultSimappConfig(tc.ChainConfigs[1], "simapp-b", tc.GetChainBID(), "atomb", tc.CometBFTConfig)
+	chainACfg := newDefaultSimappConfig(tc.ChainConfigs[0], tc.ChainConfigs[0].Name, tc.GetChainAID(), "atoma", tc.CometBFTConfig)
+	chainBCfg := newDefaultSimappConfig(tc.ChainConfigs[1], tc.ChainConfigs[1].Name, tc.GetChainBID(), "atomb", tc.CometBFTConfig)
 
 	chainAVal, chainAFn := getValidatorsAndFullNodes(0)
 	chainBVal, chainBFn := getValidatorsAndFullNodes(1)

e2e/testsuite/testsuite.go

@@ -4,7 +4,10 @@
 	"context"
 	"errors"
 	"fmt"
+	"os"
+	"path"
 	"strings"
+	"testing"
 
 	dockerclient "github.com/docker/docker/client"
 	interchaintest "github.com/strangelove-ventures/interchaintest/v8"
@@ -67,6 +70,41 @@
 	}
 }
 
+// ConfigureGenesisDebugExport sets, if needed, env variables to enable exporting of Genesis debug files.
+func (s *E2ETestSuite) ConfigureGenesisDebugExport(t *testing.T) {
+	t.Helper()
+	tc := LoadConfig()
+	cfg := tc.DebugConfig.GenesisDebug
+	if !cfg.DumpGenesisDebugInfo {
+		return
+	}
+
+	exportPath := cfg.ExportFilePath
+	if exportPath == "" {
+		e2eDir, err := diagnostics.GetE2EDir(t)
+		if err != nil {
+			s.Fail("can't get e2edir: %w", err)
+		}
+		exportPath = path.Join(e2eDir, defaultGenesisExportPath)
+	}
+
+	if !path.IsAbs(exportPath) {
+		wd, err := os.Getwd()
+		if err != nil {
+			s.Fail("can't get working directory: %w", err)
+		}
+		exportPath = path.Join(wd, exportPath)
+	}
+
+	t.Setenv("EXPORT_GENESIS_FILE_PATH", exportPath)
+	chainIdx, err := tc.GetChainIndex(cfg.ChainName)
+	if err != nil {
+		s.Fail(err.Error())
+	}
+	genesisChainName := fmt.Sprintf("%s-%d", cfg.ChainName, chainIdx+1)
+	t.Setenv("EXPORT_GENESIS_CHAIN", genesisChainName)
+}
+
 // GetRelayerUsers returns two ibc.Wallet instances which can be used for the relayer users
 // on the two chains.
 func (s *E2ETestSuite) GetRelayerUsers(ctx context.Context, chainOpts ...ChainOptionConfiguration) (ibc.Wallet, ibc.Wallet) {
@@ -173,7 +211,7 @@
 
 // generatePathName generates the path name using the test suites name
 func (s *E2ETestSuite) generatePathName() string {
 	path := s.GetPathName(s.pathNameIndex)
 	s.pathNameIndex++
 	return path
 }
@@ -219,7 +257,7 @@
 		s.paths = map[string]pathPair{}
 	}
 
 	path, ok := s.paths[s.T().Name()]
 	if ok {
 		return path.chainA, path.chainB
 	}