-
Notifications
You must be signed in to change notification settings - Fork 628
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: e2e for ICA reopening #2720
Changes from 14 commits
2259ab5
38818f1
e693456
4455226
f72efb4
1056302
09f2db6
c3402b4
893d43c
cff318f
ac9ac4f
814627a
6b2aee3
20bb218
45c3533
939f348
9ce26ff
4e13744
41a689e
12f8537
6e1da4f
67db5e9
f7e2dbf
62d4b2c
d13b134
4c91678
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -6,6 +6,7 @@ import ( | |||||
"time" | ||||||
|
||||||
ibctest "github.com/strangelove-ventures/ibctest/v6" | ||||||
"github.com/strangelove-ventures/ibctest/v6/chain/cosmos" | ||||||
"github.com/strangelove-ventures/ibctest/v6/ibc" | ||||||
"github.com/strangelove-ventures/ibctest/v6/test" | ||||||
"github.com/stretchr/testify/suite" | ||||||
|
@@ -21,6 +22,7 @@ import ( | |||||
|
||||||
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" | ||||||
channeltypes "github.com/cosmos/ibc-go/v6/modules/core/04-channel/types" | ||||||
ibctesting "github.com/cosmos/ibc-go/v6/testing" | ||||||
) | ||||||
|
||||||
|
@@ -44,6 +46,14 @@ func getICAVersion(chainAVersion, chainBVersion string) string { | |||||
return icatypes.NewDefaultMetadataString(ibctesting.FirstConnectionID, ibctesting.FirstConnectionID) | ||||||
} | ||||||
|
||||||
// RegisterInterchainAccount will attempt to register an interchain account on the counterparty chain. | ||||||
func (s *InterchainAccountsTestSuite) RegisterInterchainAccount(ctx context.Context, chain *cosmos.CosmosChain, user *ibc.Wallet, msgRegisterAccount *controllertypes.MsgRegisterInterchainAccount) error { | ||||||
txResp, err := s.BroadcastMessages(ctx, chain, user, msgRegisterAccount) | ||||||
s.Require().NoError(err) | ||||||
s.AssertValidTxResponse(txResp) | ||||||
return err | ||||||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
} | ||||||
|
||||||
func (s *InterchainAccountsTestSuite) TestMsgSendTx_SuccessfulTransfer() { | ||||||
t := s.T() | ||||||
ctx := context.TODO() | ||||||
|
@@ -228,3 +238,177 @@ func (s *InterchainAccountsTestSuite) TestMsgSendTx_FailedTransfer_InsufficientF | |||||
}) | ||||||
}) | ||||||
} | ||||||
|
||||||
func (s *InterchainAccountsTestSuite) TestMsgSubmitTx_SuccessfulTransfer_AfterReopeningICA() { | ||||||
t := s.T() | ||||||
ctx := context.TODO() | ||||||
|
||||||
// setup relayers and connection-0 between two chains | ||||||
// channel-0 is a transfer channel but it will not be used in this test case | ||||||
relayer, _ := s.SetupChainsRelayerAndChannel(ctx) | ||||||
chainA, chainB := s.GetChains() | ||||||
|
||||||
// setup 2 accounts: controller account on chain A, a second chain B account. | ||||||
// host account will be created when the ICA is registered | ||||||
controllerAccount := s.CreateUserOnChainA(ctx, testvalues.StartingTokenAmount) | ||||||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
chainBAccount := s.CreateUserOnChainB(ctx, testvalues.StartingTokenAmount) | ||||||
|
||||||
var ( | ||||||
portID string | ||||||
hostAccount string | ||||||
) | ||||||
|
||||||
t.Run("register interchain account", func(t *testing.T) { | ||||||
version := getICAVersion(testconfig.GetChainATag(), testconfig.GetChainBTag()) | ||||||
msgRegisterInterchainAccount := controllertypes.NewMsgRegisterInterchainAccount(ibctesting.FirstConnectionID, controllerAccount.Bech32Address(chainA.Config().Bech32Prefix), version) | ||||||
err := s.RegisterInterchainAccount(ctx, chainA, controllerAccount, msgRegisterInterchainAccount) | ||||||
s.Require().NoError(err) | ||||||
|
||||||
portID, err = icatypes.NewControllerPortID(controllerAccount.Bech32Address(chainA.Config().Bech32Prefix)) | ||||||
s.Require().NoError(err) | ||||||
}) | ||||||
|
||||||
t.Run("start relayer", func(t *testing.T) { | ||||||
s.StartRelayer(relayer) | ||||||
}) | ||||||
|
||||||
t.Run("verify interchain account", func(t *testing.T) { | ||||||
var err error | ||||||
hostAccount, err = s.QueryInterchainAccount(ctx, chainA, controllerAccount.Bech32Address(chainA.Config().Bech32Prefix), ibctesting.FirstConnectionID) | ||||||
s.Require().NoError(err) | ||||||
s.Require().NotZero(len(hostAccount)) | ||||||
|
||||||
channels, err := relayer.GetChannels(ctx, s.GetRelayerExecReporter(), chainA.Config().ChainID) | ||||||
s.Require().NoError(err) | ||||||
s.Require().Equal(len(channels), 2) | ||||||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
}) | ||||||
|
||||||
// stop the relayer to let the submit tx message time out | ||||||
t.Run("stop relayer", func(t *testing.T) { | ||||||
s.StopRelayer(ctx, relayer) | ||||||
}) | ||||||
|
||||||
t.Run("submit tx message with bank transfer message times out", func(t *testing.T) { | ||||||
t.Run("fund interchain account wallet", func(t *testing.T) { | ||||||
// fund the host account account so it has some $$ to send | ||||||
err := chainB.SendFunds(ctx, ibctest.FaucetAccountKeyName, ibc.WalletAmount{ | ||||||
Address: hostAccount, | ||||||
Amount: testvalues.StartingTokenAmount, | ||||||
Denom: chainB.Config().Denom, | ||||||
}) | ||||||
s.Require().NoError(err) | ||||||
}) | ||||||
|
||||||
t.Run("broadcast MsgSendTx", func(t *testing.T) { | ||||||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
// assemble bank transfer message from host account to user account on host chain | ||||||
msgSend := &banktypes.MsgSend{ | ||||||
FromAddress: hostAccount, | ||||||
ToAddress: chainBAccount.Bech32Address(chainB.Config().Bech32Prefix), | ||||||
Amount: sdk.NewCoins(testvalues.DefaultTransferAmount(chainB.Config().Denom)), | ||||||
} | ||||||
|
||||||
cfg := simappparams.MakeTestEncodingConfig() | ||||||
banktypes.RegisterInterfaces(cfg.InterfaceRegistry) | ||||||
cdc := codec.NewProtoCodec(cfg.InterfaceRegistry) | ||||||
|
||||||
bz, err := icatypes.SerializeCosmosTx(cdc, []proto.Message{msgSend}) | ||||||
s.Require().NoError(err) | ||||||
|
||||||
packetData := icatypes.InterchainAccountPacketData{ | ||||||
Type: icatypes.EXECUTE_TX, | ||||||
Data: bz, | ||||||
Memo: "e2e", | ||||||
} | ||||||
|
||||||
msgSendTx := controllertypes.NewMsgSendTx(controllerAccount.Bech32Address(chainA.Config().Bech32Prefix), ibctesting.FirstConnectionID, uint64(1), packetData) | ||||||
|
||||||
resp, err := s.BroadcastMessages( | ||||||
ctx, | ||||||
chainA, | ||||||
controllerAccount, | ||||||
msgSendTx, | ||||||
) | ||||||
|
||||||
s.AssertValidTxResponse(resp) | ||||||
s.Require().NoError(err) | ||||||
|
||||||
time.Sleep(1 * time.Second) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe we should indicate that this is to cause a packet timeout |
||||||
}) | ||||||
}) | ||||||
|
||||||
t.Run("start relayer", func(t *testing.T) { | ||||||
s.StartRelayer(relayer) | ||||||
}) | ||||||
|
||||||
t.Run("verify channel is closed due to timeout on ordered channel", func(t *testing.T) { | ||||||
channel, err := s.QueryChannel(ctx, chainA, portID, "channel-1") | ||||||
s.Require().NoError(err) | ||||||
|
||||||
t.Logf("channel-1: %+v", channel) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. not sure if we need to log the full channel here. I think we can get by with assertions on the fields for values that are deterministic, and we can include the full channel as output in the error message if the assertion fails. e.g. // additional assertions if needed
s.Require().Equal(channeltypes.CLOSED, channel.State, "channel was not in expected state", channel) Would have to double check on syntax for passing additional args to Require().Equal() though There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. true |
||||||
s.Require().Equal(channeltypes.CLOSED, channel.State) | ||||||
}) | ||||||
|
||||||
t.Run("verify tokens not transferred", func(t *testing.T) { | ||||||
balance, err := chainB.GetBalance(ctx, chainBAccount.Bech32Address(chainB.Config().Bech32Prefix), chainB.Config().Denom) | ||||||
s.Require().NoError(err) | ||||||
|
||||||
_, err = chainB.GetBalance(ctx, hostAccount, chainB.Config().Denom) | ||||||
s.Require().NoError(err) | ||||||
|
||||||
expected := testvalues.StartingTokenAmount | ||||||
s.Require().Equal(expected, balance) | ||||||
}) | ||||||
|
||||||
// re-register interchain account to reopen the channel now that it has been closed due to timeout | ||||||
// on an ordered channel | ||||||
t.Run("register interchain account", func(t *testing.T) { | ||||||
version := getICAVersion(testconfig.GetChainATag(), testconfig.GetChainBTag()) | ||||||
msgRegisterInterchainAccount := controllertypes.NewMsgRegisterInterchainAccount(ibctesting.FirstConnectionID, controllerAccount.Bech32Address(chainA.Config().Bech32Prefix), version) | ||||||
err := s.RegisterInterchainAccount(ctx, chainA, controllerAccount, msgRegisterInterchainAccount) | ||||||
s.Require().NoError(err) | ||||||
|
||||||
test.WaitForBlocks(ctx, 3, chainA, chainB) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
}) | ||||||
|
||||||
t.Run("verify new channel is now open and interchain account has been reregistered with the same portID", func(t *testing.T) { | ||||||
channel, err := s.QueryChannel(ctx, chainA, portID, "channel-2") | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe we can use constants for initialChannelName := "channel-1"
channelNameAfterReopening := "channel-2" or something |
||||||
s.Require().NoError(err) | ||||||
|
||||||
t.Logf("channel-2: %+v", channel) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same comment as above |
||||||
s.Require().Equal(channeltypes.OPEN, channel.State) | ||||||
}) | ||||||
|
||||||
t.Run("broadcast MsgSendTx", func(t *testing.T) { | ||||||
// assemble bank transfer message from host account to user account on host chain | ||||||
msgSend := &banktypes.MsgSend{ | ||||||
FromAddress: hostAccount, | ||||||
ToAddress: chainBAccount.Bech32Address(chainB.Config().Bech32Prefix), | ||||||
Amount: sdk.NewCoins(testvalues.DefaultTransferAmount(chainB.Config().Denom)), | ||||||
} | ||||||
|
||||||
cfg := simappparams.MakeTestEncodingConfig() | ||||||
banktypes.RegisterInterfaces(cfg.InterfaceRegistry) | ||||||
cdc := codec.NewProtoCodec(cfg.InterfaceRegistry) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can use this function to fetch the codec. |
||||||
|
||||||
bz, err := icatypes.SerializeCosmosTx(cdc, []proto.Message{msgSend}) | ||||||
s.Require().NoError(err) | ||||||
|
||||||
packetData := icatypes.InterchainAccountPacketData{ | ||||||
Type: icatypes.EXECUTE_TX, | ||||||
Data: bz, | ||||||
Memo: "e2e", | ||||||
} | ||||||
|
||||||
msgSendTx := controllertypes.NewMsgSendTx(controllerAccount.Bech32Address(chainA.Config().Bech32Prefix), ibctesting.FirstConnectionID, uint64(5*time.Minute), packetData) | ||||||
|
||||||
resp, err := s.BroadcastMessages( | ||||||
ctx, | ||||||
chainA, | ||||||
controllerAccount, | ||||||
msgSendTx, | ||||||
) | ||||||
|
||||||
s.AssertValidTxResponse(resp) | ||||||
s.Require().NoError(err) | ||||||
}) | ||||||
} | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should we verify the bank send transferred funds correctly? |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,6 +33,20 @@ func (s *E2ETestSuite) QueryClientState(ctx context.Context, chain ibc.Chain, cl | |
return clientState, nil | ||
} | ||
|
||
// QueryChannel queries the channel on a given chain for the provided portID and channelID | ||
func (s *E2ETestSuite) QueryChannel(ctx context.Context, chain ibc.Chain, portID, channelID string) (channeltypes.Channel, error) { | ||
queryClient := s.GetChainGRCPClients(chain).ChannelQueryClient | ||
res, err := queryClient.Channel(ctx, &channeltypes.QueryChannelRequest{ | ||
PortId: portID, | ||
ChannelId: channelID, | ||
}) | ||
if err != nil { | ||
return channeltypes.Channel{}, err | ||
} | ||
|
||
return *res.Channel, nil | ||
} | ||
|
||
Comment on lines
+37
to
+49
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. great addition! |
||
// QueryPacketCommitment queries the packet commitment on the given chain for the provided channel and sequence. | ||
func (s *E2ETestSuite) QueryPacketCommitment(ctx context.Context, chain ibc.Chain, portID, channelID string, sequence uint64) ([]byte, error) { | ||
queryClient := s.GetChainGRCPClients(chain).ChannelQueryClient | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -398,6 +398,7 @@ func (s *E2ETestSuite) AssertValidTxResponse(resp sdk.TxResponse) { | |
s.Require().NotEqual(int64(0), resp.GasWanted, respLogsMsg) | ||
s.Require().NotEmpty(resp.Events, respLogsMsg) | ||
s.Require().NotEmpty(resp.Data, respLogsMsg) | ||
s.T().Logf("tx response: %s", resp) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we include this this will be quite verbose for all tests. I think the response logs being included should be enough. WDYT? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yea...true. it was useful for checking the tx because checking that the tx is a valid response doesn't actually tell us if the tx succeeded or not when i was running the test locally, but we can verify the bank send transferred funds correctly as you indicated below. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can we assert a status code? Or maybe accept an additional argument which is the expected code. |
||
} | ||
|
||
// AssertPacketRelayed asserts that the packet commitment does not exist on the sending chain. | ||
|
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.
This is the tag with the 1-minute packet timeout, right? Maybe we don't need to use it anymore, if we plan to test the timeout/reopen scenario only with simd >= 6.0.0.
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.
Since this is manual only, I don't think there's much harm in having this additional drop down option. I'm happy to have it removed though if people don't think it will ever be used!
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.
I would have to check, but I think v0.1.5 is basically the same as v0.1.4 but with a shorter timeout, so I think it doesn't really add much to have both...
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.
okay sounds good to me to remove it 👍