Skip to content
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.

Sign up for GitHub

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

Add testing for ICA events #5687

Merged
merged 24 commits into from
Feb 8, 2024
Merged

Add testing for ICA events #5687

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
452167b
test: adding TestMsgConnectionOpenInitEvents
chatton Jan 22, 2024
b885208
test: adding TestMsgConnectionOpenTryEvents
chatton Jan 22, 2024
27d266e
test: adding TestMsgConnectionOpenAckEvents
chatton Jan 22, 2024
c2adf1b
test: adding TestMsgConnectionOpenConfirmEvents
chatton Jan 22, 2024
1aa723e
test: adding TestMsgCreateClientEvent
chatton Jan 22, 2024
3e038fd
test: adding TestMsgUpdateClientEvents
chatton Jan 22, 2024
8f8258e
test: adding TestMsgUpgradeClientEvents
chatton Jan 22, 2024
4db951d
test: adding event test for recover client
chatton Jan 23, 2024
c848868
test: refactor upgrade client test to use existing test
chatton Jan 23, 2024
cbd165e
test: add test for ibc software upgrade
chatton Jan 23, 2024
a1a8acb
chore: linting
chatton Jan 23, 2024
29ba8eb
wip: adding ica events test
chatton Jan 23, 2024
9d4a757
test: adding event tests for controller OnRecvPacket
chatton Jan 23, 2024
ff94a32
test: adding test for host recv packet
chatton Jan 23, 2024
4e86201
Merge branch 'main' into cian/issue#2823-ica-events-testing
chatton Jan 23, 2024
ec8f18a
Merge branch 'main' into cian/issue#2823-ica-events-testing
chatton Jan 23, 2024
81eb7cc
Merge branch 'main' into cian/issue#2823-ica-events-testing
chatton Jan 24, 2024
c7916b5
Merge branch 'main' into cian/issue#2823-ica-events-testing
chatton Jan 24, 2024
5d62f43
chore: merge main
chatton Jan 25, 2024
2616555
Merge branch 'main' into cian/issue#2823-ica-events-testing
chatton Jan 25, 2024
3d2f1da
Merge branch 'main' into cian/issue#2823-ica-events-testing
crodriguezvega Feb 2, 2024
54b10be
Merge branch 'main' into cian/issue#2823-ica-events-testing
chatton Feb 8, 2024
12dc297
chore: fixing linting errors
chatton Feb 8, 2024
9f18b59
chore: reverted name change
chatton Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,8 +564,22 @@ func (suite *InterchainAccountsTestSuite) TestOnRecvPacket() {
0,
)

ack := cbs.OnRecvPacket(suite.chainA.GetContext(), packet, nil)
ctx := suite.chainA.GetContext()
ack := cbs.OnRecvPacket(ctx, packet, nil)
suite.Require().Equal(tc.expPass, ack.Success())

expectedEvents := sdk.Events{
sdk.NewEvent(
icatypes.EventTypePacket,
sdk.NewAttribute(sdk.AttributeKeyModule, icatypes.ModuleName),
sdk.NewAttribute(icatypes.AttributeKeyControllerChannelID, packet.GetDestChannel()),
sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, fmt.Sprintf("%t", false)),
sdk.NewAttribute(icatypes.AttributeKeyAckError, "cannot receive packet on controller chain: invalid message sent to channel end"),
),
}.ToABCIEvents()

expectedEvents = sdk.MarkEventsToIndex(expectedEvents, map[string]struct{}{})
ibctesting.AssertEvents(&suite.Suite, expectedEvents, ctx.EventManager().Events().ToABCIEvents())
})
}
}
Expand Down
41 changes: 39 additions & 2 deletions modules/apps/27-interchain-accounts/host/ibc_module_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,14 +400,16 @@ func (suite *InterchainAccountsTestSuite) TestOnRecvPacket() {
name string
malleate func()
expAckSuccess bool
eventErrorMsg string
}{
{
"success", func() {}, true,
"success", func() {}, true, "",
},
{
"host submodule disabled", func() {
suite.chainB.GetSimApp().ICAHostKeeper.SetParams(suite.chainB.GetContext(), types.NewParams(false, []string{}))
}, false,
"", // events are not emitted when the host submodule is disabled.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking, is this actually desired behaviour? This could be useful debugging information via events.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I don't see any harm on maybe emitting the event with that information...

},
{
"success with ICA auth module callback failure", func() {
Expand All @@ -417,11 +419,13 @@ func (suite *InterchainAccountsTestSuite) TestOnRecvPacket() {
return channeltypes.NewErrorAcknowledgement(fmt.Errorf("failed OnRecvPacket mock callback"))
}
}, true,
"failed OnRecvPacket mock callback",
},
{
"ICA OnRecvPacket fails - cannot unmarshal packet data", func() {
packetData = []byte("invalid data")
}, false,
"cannot unmarshal ICS-27 interchain account packet data: unknown data type",
},
}

Expand Down Expand Up @@ -487,12 +491,45 @@ func (suite *InterchainAccountsTestSuite) TestOnRecvPacket() {
cbs, ok := suite.chainB.App.GetIBCKeeper().Router.GetRoute(module)
suite.Require().True(ok)

ack := cbs.OnRecvPacket(suite.chainB.GetContext(), packet, nil)
ctx := suite.chainB.GetContext()
ack := cbs.OnRecvPacket(ctx, packet, nil)

expectedAttributes := []sdk.Attribute{
sdk.NewAttribute(sdk.AttributeKeyModule, icatypes.ModuleName),
sdk.NewAttribute(icatypes.AttributeKeyHostChannelID, packet.GetDestChannel()),
sdk.NewAttribute(icatypes.AttributeKeyAckSuccess, fmt.Sprintf("%t", ack.Success())),
}

if tc.expAckSuccess {
suite.Require().True(ack.Success())
suite.Require().Equal(expectedAck, ack)

expectedEvents := sdk.Events{
sdk.NewEvent(
icatypes.EventTypePacket,
expectedAttributes...,
),
}.ToABCIEvents()

expectedEvents = sdk.MarkEventsToIndex(expectedEvents, map[string]struct{}{})
ibctesting.AssertEvents(&suite.Suite, expectedEvents, ctx.EventManager().Events().ToABCIEvents())

} else {
suite.Require().False(ack.Success())

expEventsEmitted := tc.eventErrorMsg != ""
if expEventsEmitted {
expectedAttributes = append(expectedAttributes, sdk.NewAttribute(icatypes.AttributeKeyAckError, tc.eventErrorMsg))
expectedEvents := sdk.Events{
sdk.NewEvent(
icatypes.EventTypePacket,
expectedAttributes...,
),
}.ToABCIEvents()

expectedEvents = sdk.MarkEventsToIndex(expectedEvents, map[string]struct{}{})
ibctesting.AssertEvents(&suite.Suite, expectedEvents, ctx.EventManager().Events().ToABCIEvents())
}
}
})
}
Expand Down
Loading