e2e: adding e2e upgrade test for ibc-go v7 #2902
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,8 +24,11 @@ import ( | |
| "github.com/cosmos/ibc-go/e2e/testvalues" | ||
| controllertypes "github.com/cosmos/ibc-go/v6/modules/apps/27-interchain-accounts/controller/types" | ||
| icatypes "github.com/cosmos/ibc-go/v6/modules/apps/27-interchain-accounts/types" | ||
| v7 "github.com/cosmos/ibc-go/v6/modules/core/02-client/migrations/v7" | ||
| clienttypes "github.com/cosmos/ibc-go/v6/modules/core/02-client/types" | ||
| ibctesting "github.com/cosmos/ibc-go/v6/testing" | ||
| simappupgrades "github.com/cosmos/ibc-go/v6/testing/simapp/upgrades" | ||
| v7upgrades "github.com/cosmos/ibc-go/v6/testing/simapp/upgrades/v7" | ||
| ) | ||
|
|
||
| const ( | ||
|
|
@@ -70,6 +73,8 @@ func (s *UpgradeTestSuite) UpgradeChain(ctx context.Context, chain *cosmos.Cosmo | |
| err = chain.StartAllNodes(ctx) | ||
| s.Require().NoError(err, "error starting upgraded node(s)") | ||
|
|
||
| s.InitGRPCClients(chain) | ||
chatton marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. just a note for the future, it might make sense to bundle these into a |
||
|
|
||
| timeoutCtx, timeoutCtxCancel = context.WithTimeout(ctx, time.Minute*2) | ||
| defer timeoutCtxCancel() | ||
|
|
||
|
|
@@ -386,6 +391,147 @@ func (s *UpgradeTestSuite) TestV5ToV6ChainUpgrade() { | |
| }) | ||
| } | ||
|
|
||
| func (s *UpgradeTestSuite) TestV6ToV7ChainUpgrade() { | ||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| t := s.T() | ||
| testCfg := testconfig.FromEnv() | ||
|
|
||
| ctx := context.Background() | ||
| relayer, channelA := s.SetupChainsRelayerAndChannel(ctx) | ||
| chainA, chainB := s.GetChains() | ||
|
|
||
| createClientOptions := ibc.CreateClientOptions{ | ||
| TrustingPeriod: time.Duration(time.Hour * 24 * 7).String(), | ||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // create second tendermint client | ||
| s.SetupClients(ctx, relayer, createClientOptions) | ||
|
|
||
| status, err := s.Status(ctx, chainA, ibctesting.FirstClientID) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal("Active", status) | ||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| status, err = s.Status(ctx, chainA, ibctesting.SecondClientID) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal("Active", status) | ||
|
|
||
| var ( | ||
| chainADenom = chainA.Config().Denom | ||
| chainBIBCToken = testsuite.GetIBCToken(chainADenom, channelA.Counterparty.PortID, channelA.Counterparty.ChannelID) // IBC token sent to chainB | ||
| soloMachineClientID = "06-solomachine-2" | ||
|
There was a problem hiding this comment. I left a comment later about a function to name client IDs, I think this is a good place to use it! |
||
| ) | ||
|
|
||
| chainAWallet := s.CreateUserOnChainA(ctx, testvalues.StartingTokenAmount) | ||
| chainAAddress := chainAWallet.Bech32Address(chainA.Config().Bech32Prefix) | ||
|
|
||
| chainBWallet := s.CreateUserOnChainB(ctx, testvalues.StartingTokenAmount) | ||
| chainBAddress := chainBWallet.Bech32Address(chainB.Config().Bech32Prefix) | ||
|
|
||
| // create solo machine client | ||
|
There was a problem hiding this comment. I don't think this comment is very useful. Maybe we can outline why we're using the solomachine type from |
||
| solo := ibctesting.NewSolomachine(t, testsuite.Codec(), "solomachine", "testing", 1) | ||
|
|
||
| legacyConsensusState := &v7.ConsensusState{ | ||
| PublicKey: solo.ConsensusState().PublicKey, | ||
| Diversifier: solo.ConsensusState().Diversifier, | ||
| Timestamp: solo.ConsensusState().Timestamp, | ||
| } | ||
|
|
||
| legacyClientState := &v7.ClientState{ | ||
| Sequence: solo.ClientState().Sequence, | ||
| IsFrozen: solo.ClientState().IsFrozen, | ||
| ConsensusState: legacyConsensusState, | ||
| AllowUpdateAfterProposal: true, | ||
| } | ||
|
There was a problem hiding this comment. could we add a comment explaining why we need to construct the legacy types? That is, the ibc testing package uses the newest version of the solo machine which isn't supported by the chain we are broadcasting the message to, so we need to construct the legacy type in order to setup the pre upgraded chain with legacy state |
||
|
|
||
| msgCreateSoloMachineClient, err := clienttypes.NewMsgCreateClient(legacyClientState, legacyConsensusState, chainAAddress) | ||
| s.Require().NoError(err) | ||
|
|
||
| resp, err := s.BroadcastMessages( | ||
| ctx, | ||
| chainA, | ||
| chainAWallet, | ||
| msgCreateSoloMachineClient, | ||
| ) | ||
|
|
||
| s.AssertValidTxResponse(resp) | ||
| s.Require().NoError(err) | ||
|
|
||
| status, err = s.Status(ctx, chainA, soloMachineClientID) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal("Active", status) | ||
|
There was a problem hiding this comment. I think there is a constant we can use for There was a problem hiding this comment. this seems like a good candidate for a subtest rather than being at the root level of the test |
||
|
|
||
| res, err := s.ClientState(ctx, chainA, soloMachineClientID) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal(res.ClientState.TypeUrl, "/ibc.lightclients.solomachine.v2.ClientState") | ||
|
There was a problem hiding this comment. another great candidate for t.Run !
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| s.Require().NoError(test.WaitForBlocks(ctx, 1, chainA, chainB), "failed to wait for blocks") | ||
|
|
||
| t.Run("IBC token transfer from chainA to chainB, sender is source of tokens", func(t *testing.T) { | ||
| transferTxResp, err := s.Transfer(ctx, chainA, chainAWallet, channelA.PortID, channelA.ChannelID, testvalues.DefaultTransferAmount(chainADenom), chainAAddress, chainBAddress, s.GetTimeoutHeight(ctx, chainB), 0, "") | ||
| s.Require().NoError(err) | ||
| s.AssertValidTxResponse(transferTxResp) | ||
| }) | ||
|
|
||
| t.Run("tokens are escrowed", func(t *testing.T) { | ||
| actualBalance, err := s.GetChainANativeBalance(ctx, chainAWallet) | ||
| s.Require().NoError(err) | ||
|
|
||
| expected := testvalues.StartingTokenAmount - testvalues.IBCTransferAmount | ||
| s.Require().Equal(expected, actualBalance) | ||
| }) | ||
|
|
||
| t.Run("start relayer", func(t *testing.T) { | ||
| s.StartRelayer(relayer) | ||
| }) | ||
|
|
||
| t.Run("packets are relayed", func(t *testing.T) { | ||
| s.AssertPacketRelayed(ctx, chainA, channelA.PortID, channelA.ChannelID, 1) | ||
|
|
||
| actualBalance, err := chainB.GetBalance(ctx, chainBAddress, chainBIBCToken.IBCDenom()) | ||
| s.Require().NoError(err) | ||
|
|
||
| expected := testvalues.IBCTransferAmount | ||
| s.Require().Equal(expected, actualBalance) | ||
| }) | ||
|
|
||
| // create separate user specifically for the upgrade proposal to more easily verify starting | ||
| // and end balances of the chainA users. | ||
| chainAUpgradeProposalWallet := s.CreateUserOnChainA(ctx, testvalues.StartingTokenAmount) | ||
|
|
||
| t.Run("upgrade chainA", func(t *testing.T) { | ||
| s.UpgradeChain(ctx, chainA, chainAUpgradeProposalWallet, v7upgrades.UpgradeName, testCfg.ChainAConfig.Tag, testCfg.UpgradeTag) | ||
| }) | ||
|
|
||
| status, err = s.Status(ctx, chainA, ibctesting.FirstClientID) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal("Active", status) | ||
|
|
||
| status, err = s.Status(ctx, chainA, ibctesting.SecondClientID) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal("Active", status) | ||
|
|
||
| // send another transfer from chainA to chainB to make sure the upgrade did not break the packet flow | ||
| t.Run("IBC token transfer from chainA to chainB, sender is source of tokens", func(t *testing.T) { | ||
| transferTxResp, err := s.Transfer(ctx, chainA, chainAWallet, channelA.PortID, channelA.ChannelID, testvalues.DefaultTransferAmount(chainADenom), chainAAddress, chainBAddress, s.GetTimeoutHeight(ctx, chainB), 0, "") | ||
| s.Require().NoError(err) | ||
| s.AssertValidTxResponse(transferTxResp) | ||
| }) | ||
|
|
||
| t.Run("packets are relayed", func(t *testing.T) { | ||
| s.AssertPacketRelayed(ctx, chainA, channelA.PortID, channelA.ChannelID, 1) | ||
|
|
||
| actualBalance, err := chainB.GetBalance(ctx, chainBAddress, chainBIBCToken.IBCDenom()) | ||
| s.Require().NoError(err) | ||
|
|
||
| expected := testvalues.IBCTransferAmount * 2 | ||
| s.Require().Equal(expected, actualBalance) | ||
| }) | ||
|
|
||
| // check that the v2 solo machine clientstate has been updated to the v3 solo machine clientstate | ||
| res, err = s.ClientState(ctx, chainA, soloMachineClientID) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal(res.ClientState.TypeUrl, "/ibc.lightclients.solomachine.v3.ClientState") | ||
|
There was a problem hiding this comment. is There was a problem hiding this comment. Normally we could use You could use what the impl of that function does tho, something like: |
||
| } | ||
|
|
||
| // RegisterInterchainAccount will attempt to register an interchain account on the counterparty chain. | ||
| func (s *UpgradeTestSuite) RegisterInterchainAccount(ctx context.Context, chain *cosmos.CosmosChain, user *ibc.Wallet, msgRegisterAccount *intertxtypes.MsgRegisterAccount) error { | ||
| txResp, err := s.BroadcastMessages(ctx, chain, user, msgRegisterAccount) | ||
|
|
@@ -405,3 +551,29 @@ func getICAVersion(chainAVersion, chainBVersion string) string { | |
| // explicitly set the version string because the host chain might not yet support incentivized channels. | ||
| return icatypes.NewDefaultMetadataString(ibctesting.FirstConnectionID, ibctesting.FirstConnectionID) | ||
| } | ||
|
|
||
| // Status queries the status of the client by clientID | ||
| func (s *UpgradeTestSuite) Status(ctx context.Context, chain ibc.Chain, clientID string) (string, error) { | ||
|
There was a problem hiding this comment. maybe this can be renamed to |
||
| queryClient := s.GetChainGRCPClients(chain).ClientQueryClient | ||
| res, err := queryClient.ClientStatus(ctx, &clienttypes.QueryClientStatusRequest{ | ||
| ClientId: clientID, | ||
| }) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| return res.Status, nil | ||
| } | ||
|
|
||
| // ClientState queries the current ClientState by clientID | ||
| func (s *UpgradeTestSuite) ClientState(ctx context.Context, chain ibc.Chain, clientID string) (*clienttypes.QueryClientStateResponse, error) { | ||
|
There was a problem hiding this comment. fetching client state might be something we want to do in other tests, I'm happy to leave it here for now, but it might be worth moving this to the There was a problem hiding this comment. i could move this one and Status as well, I think they are generic enough functions There was a problem hiding this comment. Ah you mean to return
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| queryClient := s.GetChainGRCPClients(chain).ClientQueryClient | ||
| res, err := queryClient.ClientState(ctx, &clienttypes.QueryClientStateRequest{ | ||
| ClientId: clientID, | ||
| }) | ||
| if err != nil { | ||
| return res, err | ||
| } | ||
|
|
||
| return res, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe the alias should be
v7migrationsinstead of justv7to make it explicit in the tests. The same way we havev7upgrades