configurer

README

End-to-end Tests

The configurer package

The chain can either be initialized off of the current branch, or off the prior mainnet release and then upgraded to the current branch.

If current, we run chain initialization off of the current Git branch by calling chain.Init(...) method in the configurer/current.go.

If with the upgrade, the same chain.Init(...) function is run inside a Docker container of the previous Chain4Energy version, inside configurer/upgrade.go. This is needed to initialize chain configs and the genesis of the previous version that we are upgrading from.

The decision of what configuration type to use is decided by the Configurer. This is an interface that has CurrentBranchConfigurer and UpgradeConfigurer implementations. There is also a BaseConfigurer which is shared by the concrete implementations. However, the user of the configurer package does not need to know about this detail.

When the desired configurer is created, the caller may configure the chain in the desired way as follows:

conf, _ := configurer.New(..., < isIBCEnabled bool >, < isUpgradeEnabled bool >)

conf.ConfigureChains()

The caller (e2e setup logic), does not need to be concerned about what type of configurations is hapenning in the background. The appropriate logic is selected depending on what the values of the arguments to configurer.New(...) are.

The configurer constructor is using a factory design pattern to decide on what kind of configurer to return. Factory design pattern is used to decouple the client from the initialization details of the configurer. More on this can be found here

The rules for deciding on the configurer type must be sent to each of the test suites. We currently have 2 options to run the test suite

• If only startUpgrade is set to true only one chain using the previous version of the codebase will be started. Then an upgrade proposal will be sent and after reaching the appropriate height, the upgrade will be carried out,

• If only startIbc is set to true 2 chains will be launched, and they will be connected by the appropriate IBC relayer.

• If both startUpgrade and startIbc 2 chains will be launched, then an upgrade will be carried out and these 2 chains will be connected using the IBC relayer

• If none are true, we only need one chain at the current branch version of the Chain4Energy code

upgrade Package

The upgrade package starts chain initialization. In addition, there is a Dockerfile init-e2e.Dockerfile. When executed, its container produces all files necessary for starting up a new chain. These resulting files can be mounted on a volume and propagated to our production Chain4Energy container to start the c4ed service.

The decoupling between chain initialization and start-up allows to minimize the differences between our test suite and the production environment.

Documentation

Index

• type Configurer
  • func New(t *testing.T, isIBCEnabled, isDebugLogEnabled bool, signMode string, ...) (Configurer, error)
  • func NewCurrentBranchConfigurer(t *testing.T, chainConfigs []*chain.Config, setupTests setupFn, ...) Configurer
  • func NewUpgradeConfigurer(t *testing.T, chainConfigs []*chain.Config, setupTests setupFn, ...) Configurer
  • func StartDockerContainers(t *testing.T, startIBC, isDebugLogEnabled bool, signMode string, ...) (Configurer, error)
• type CurrentBranchConfigurer
  • func (bc *CurrentBranchConfigurer) ClearResources() error
  • func (cb *CurrentBranchConfigurer) ConfigureChain(chainConfig *chain.Config) error
  • func (cb *CurrentBranchConfigurer) ConfigureChains() error
  • func (bc *CurrentBranchConfigurer) GetChainConfig(chainIndex int) *chain.Config
  • func (bc *CurrentBranchConfigurer) RunIBC() error
  • func (cb *CurrentBranchConfigurer) RunSetup() error
  • func (bc *CurrentBranchConfigurer) RunValidators() error
• type UpgradeConfigurer
  • func (bc *UpgradeConfigurer) ClearResources() error
  • func (uc *UpgradeConfigurer) ConfigureChain(chainConfig *chain.Config) error
  • func (uc *UpgradeConfigurer) ConfigureChains() error
  • func (bc *UpgradeConfigurer) GetChainConfig(chainIndex int) *chain.Config
  • func (bc *UpgradeConfigurer) RunIBC() error
  • func (uc *UpgradeConfigurer) RunSetup() error
  • func (uc *UpgradeConfigurer) RunUpgrade() error
  • func (bc *UpgradeConfigurer) RunValidators() error
• type UpgradeSettings

Types

type Configurer

type Configurer interface {
	ConfigureChains() error

	ClearResources() error

	GetChainConfig(chainIndex int) *chain.Config

	RunSetup() error

	RunValidators() error

	RunIBC() error
}

func New

func New(t *testing.T, isIBCEnabled, isDebugLogEnabled bool, signMode string, upgradeSettings UpgradeSettings) (Configurer, error)

New returns a new Configurer depending on the values of its parameters. - If only isIBCEnabled, we want to have 2 chains initialized at the current Git branch version of C4e codebase. - If only isUpgradeEnabled, that is invalid and an error is returned. - If both isIBCEnabled and isUpgradeEnabled, we want 2 chains with IBC initialized at the previous C4e version. - If !isIBCEnabled and !isUpgradeEnabled, we only need one chain at the current Git branch version of the C4e code.

func NewCurrentBranchConfigurer

func NewCurrentBranchConfigurer(t *testing.T, chainConfigs []*chain.Config, setupTests setupFn, containerManager *containers.Manager) Configurer

func NewUpgradeConfigurer

func NewUpgradeConfigurer(t *testing.T, chainConfigs []*chain.Config, setupTests setupFn, containerManager *containers.Manager, upgradeVersion string, upgradeLegacyProposal bool) Configurer

func StartDockerContainers

func StartDockerContainers(t *testing.T, startIBC, isDebugLogEnabled bool, signMode string, upgradeSettings UpgradeSettings) (Configurer, error)

type CurrentBranchConfigurer

type CurrentBranchConfigurer struct {
	// contains filtered or unexported fields
}

func (*CurrentBranchConfigurer) ClearResources

func (bc *CurrentBranchConfigurer) ClearResources() error

func (*CurrentBranchConfigurer) ConfigureChain

func (cb *CurrentBranchConfigurer) ConfigureChain(chainConfig *chain.Config) error

func (*CurrentBranchConfigurer) ConfigureChains

func (cb *CurrentBranchConfigurer) ConfigureChains() error

func (*CurrentBranchConfigurer) GetChainConfig

func (bc *CurrentBranchConfigurer) GetChainConfig(chainIndex int) *chain.Config

func (*CurrentBranchConfigurer) RunIBC

func (bc *CurrentBranchConfigurer) RunIBC() error

func (*CurrentBranchConfigurer) RunSetup

func (cb *CurrentBranchConfigurer) RunSetup() error

func (*CurrentBranchConfigurer) RunValidators

func (bc *CurrentBranchConfigurer) RunValidators() error

type UpgradeConfigurer

type UpgradeConfigurer struct {
	// contains filtered or unexported fields
}

func (*UpgradeConfigurer) ClearResources

func (bc *UpgradeConfigurer) ClearResources() error

func (*UpgradeConfigurer) ConfigureChain

func (uc *UpgradeConfigurer) ConfigureChain(chainConfig *chain.Config) error

func (*UpgradeConfigurer) ConfigureChains

func (uc *UpgradeConfigurer) ConfigureChains() error

func (*UpgradeConfigurer) GetChainConfig

func (bc *UpgradeConfigurer) GetChainConfig(chainIndex int) *chain.Config

func (*UpgradeConfigurer) RunIBC

func (bc *UpgradeConfigurer) RunIBC() error

func (*UpgradeConfigurer) RunSetup

func (uc *UpgradeConfigurer) RunSetup() error

func (*UpgradeConfigurer) RunUpgrade

func (uc *UpgradeConfigurer) RunUpgrade() error

func (*UpgradeConfigurer) RunValidators

func (bc *UpgradeConfigurer) RunValidators() error

type UpgradeSettings

type UpgradeSettings struct {
	IsEnabled               bool
	Version                 string
	OldInitialAppStateBytes []byte
	MigrationChaining       bool
}