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

Jump to bottom

test(08-wasm): added 'TestUpdateState' using mockVM #4914

Merged
merged 19 commits into from
Oct 25, 2023
Merged

test(08-wasm): added 'TestUpdateState' using mockVM #4914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
00742d4
save progress
srdtrk Oct 18, 2023
2895014
feat: added working test to iterate on
srdtrk Oct 19, 2023
6327a4c
merge: branch 'feat/wasm-clients' into serdar/issue#4831-wasm-TestUpd…
srdtrk Oct 19, 2023
0ca99e8
imp: improved test and added cases
srdtrk Oct 19, 2023
1de1bca
feat: finished 'TestUpdateState'
srdtrk Oct 19, 2023
2be7f92
refactor: used suite.store
srdtrk Oct 19, 2023
15c4897
imp: fixed linter
srdtrk Oct 19, 2023
6f11659
merge: branch 'feat/wasm-clients' into serdar/issue#4831-wasm-TestUpd…
srdtrk Oct 23, 2023
5784e55
style: reverted to a different callback registration pattern
srdtrk Oct 23, 2023
2eecbe9
style: using errors.New instead of fmt
srdtrk Oct 23, 2023
147e7f7
merge: branch 'feat/wasm-clients' into serdar/issue#4831-wasm-TestUpd…
srdtrk Oct 23, 2023
91a3f97
imp: sudoMsg used in tests
srdtrk Oct 23, 2023
8ae1024
imp: removed unneeded callbackFn
srdtrk Oct 23, 2023
50ee137
imp: added more tests on sudoMsg struct
srdtrk Oct 23, 2023
ccc0e91
imp: added additional assertion to sudoMsg
srdtrk Oct 23, 2023
b90d6ea
merge: branch 'feat/wasm-clients' into serdar/issue#4831-wasm-TestUpd…
srdtrk Oct 24, 2023
fe3aa40
imp: reverted back to the previous callback pattern
srdtrk Oct 24, 2023
8e72d6e
merge: branch 'feat/wasm-clients' into serdar/issue#4831-wasm-TestUpd…
srdtrk Oct 24, 2023
6183368
Merge branch 'feat/wasm-clients' into serdar/issue#4831-wasm-TestUpda…
srdtrk Oct 25, 2023
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
8 changes: 8 additions & 0 deletions modules/light-clients/08-wasm/types/export_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,11 @@ package types

// MaxWasmSize is the maximum size of a wasm code in bytes.
const MaxWasmSize = maxWasmSize

// these fields are exported aliases for the payload fields passed to the wasm vm.
// these are used to specify callback functions to handle specific queries in the mock vm.
type (
// CallbackFn types
QueryFn = queryFn
SudoFn = sudoFn
)
326 changes: 134 additions & 192 deletions modules/light-clients/08-wasm/types/update_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,21 @@ package types_test

import (
"encoding/base64"
"encoding/json"
"errors"
"fmt"

wasmvm "github.com/CosmWasm/wasmvm"
wasmvmtypes "github.com/CosmWasm/wasmvm/types"

errorsmod "cosmossdk.io/errors"

wasmtesting "github.com/cosmos/ibc-go/modules/light-clients/08-wasm/testing"
"github.com/cosmos/ibc-go/modules/light-clients/08-wasm/types"
clienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
host "github.com/cosmos/ibc-go/v8/modules/core/24-host"
"github.com/cosmos/ibc-go/v8/modules/core/exported"
tmtypes "github.com/cosmos/ibc-go/v8/modules/light-clients/07-tendermint"
)

func (suite *TypesTestSuite) TestVerifyHeaderGrandpa() {
Expand Down Expand Up @@ -449,208 +459,140 @@ func (suite *TypesTestSuite) TestUpdateStateGrandpa() {
}
}

// func (suite *TypesTestSuite) TestUpdateStateTendermint() {
// var (
// path *ibctesting.Path
// clientMessage exported.ClientMessage
// clientStore sdk.KVStore
// consensusHeights []exported.Height
// pruneHeight clienttypes.Height
// prevClientState exported.ClientState
// prevConsensusState exported.ConsensusState
// )

// testCases := []struct {
// name string
// malleate func()
// expResult func()
// expPass bool
// }{
// {
// "success with height later than latest height", func() {
// suite.Require().True(path.EndpointA.GetClientState().GetLatestHeight().LT(height))
// },
// func() {
// clientState := path.EndpointA.GetClientState()
// suite.Require().True(clientState.GetLatestHeight().EQ(height)) // new update, updated client state should have changed
// suite.Require().True(clientState.GetLatestHeight().EQ(consensusHeights[0]))
// }, true,
// },
// {
// "success with height earlier than latest height", func() {
// // commit a block so the pre-created ClientMessage
// // isn't used to update the client to a newer height
// suite.coordinator.CommitBlock(suite.chainB)
// err := path.EndpointA.UpdateClient()
// suite.Require().NoError(err)

// suite.Require().True(path.EndpointA.GetClientState().GetLatestHeight().GT(height))

// prevClientState = path.EndpointA.GetClientState()
// },
// func() {
// clientState := path.EndpointA.GetClientState()
// suite.Require().Equal(clientState, prevClientState) // fill in height, no change to client state
// suite.Require().True(clientState.GetLatestHeight().GT(consensusHeights[0]))
// }, true,
// },
// {
// "success with duplicate header", func() {
// // update client in advance
// err := path.EndpointA.UpdateClient()
// suite.Require().NoError(err)

// // use the same header which just updated the client
// clientMessage, height, err = path.EndpointA.Chain.ConstructUpdateWasmClientHeader(path.EndpointA.Counterparty.Chain, path.EndpointA.ClientID)
// suite.Require().NoError(err)
// suite.Require().Equal(path.EndpointA.GetClientState().GetLatestHeight(), height)

// prevClientState = path.EndpointA.GetClientState()
// prevConsensusState = path.EndpointA.GetConsensusState(height)
// },
// func() {
// clientState := path.EndpointA.GetClientState()
// suite.Require().Equal(clientState, prevClientState)
// suite.Require().True(clientState.GetLatestHeight().EQ(consensusHeights[0]))
// suite.Require().Equal(path.EndpointA.GetConsensusState(height), prevConsensusState)
// }, true,
// },
// {
// "success with pruned consensus state", func() {
// // this height will be expired and pruned
// err := path.EndpointA.UpdateClient()
// suite.Require().NoError(err)
// pruneHeight = path.EndpointA.GetClientState().GetLatestHeight().(clienttypes.Height)

// // Increment the time by a week
// suite.coordinator.IncrementTimeBy(7 * 24 * time.Hour)

// // create the consensus state that can be used as trusted height for next update
// err = path.EndpointA.UpdateClient()
// suite.Require().NoError(err)

// // Increment the time by another week, then update the client.
// // This will cause the first two consensus states to become expired.
// suite.coordinator.IncrementTimeBy(7 * 24 * time.Hour)
// err = path.EndpointA.UpdateClient()
// suite.Require().NoError(err)

// // ensure counterparty state is committed
// suite.coordinator.CommitBlock(suite.chainB)
// clientMessage, height, err = path.EndpointA.Chain.ConstructUpdateWasmClientHeader(path.EndpointA.Counterparty.Chain, path.EndpointA.ClientID)
// suite.Require().NoError(err)
// },
// func() {
// clientState := path.EndpointA.GetClientState()
// suite.Require().True(clientState.GetLatestHeight().EQ(height)) // new update, updated client state should have changed
// suite.Require().True(clientState.GetLatestHeight().EQ(consensusHeights[0]))

// // ensure consensus state was pruned
// _, found := path.EndpointA.Chain.GetConsensusState(path.EndpointA.ClientID, pruneHeight)
// suite.Require().False(found)
// }, true,
// },
// {
// "success with pruned consensus state using duplicate header", func() {
// // this height will be expired and pruned
// err := path.EndpointA.UpdateClient()
// suite.Require().NoError(err)
// pruneHeight = path.EndpointA.GetClientState().GetLatestHeight().(clienttypes.Height)

// // assert that a consensus state exists at the prune height
// consensusState, found := path.EndpointA.Chain.GetConsensusState(path.EndpointA.ClientID, pruneHeight)
// suite.Require().True(found)
// suite.Require().NotNil(consensusState)

// // Increment the time by a week
// suite.coordinator.IncrementTimeBy(7 * 24 * time.Hour)

// // create the consensus state that can be used as trusted height for next update
// err = path.EndpointA.UpdateClient()
// suite.Require().NoError(err)

// // Increment the time by another week, then update the client.
// // This will cause the first two consensus states to become expired.
// suite.coordinator.IncrementTimeBy(7 * 24 * time.Hour)
// err = path.EndpointA.UpdateClient()
// suite.Require().NoError(err)

// // use the same header which just updated the client
// clientMessage, height, err = path.EndpointA.Chain.ConstructUpdateWasmClientHeader(path.EndpointA.Counterparty.Chain, path.EndpointA.ClientID)
// suite.Require().NoError(err)
// },
// func() {
// clientState := path.EndpointA.GetClientState()
// suite.Require().True(clientState.GetLatestHeight().EQ(height)) // new update, updated client state should have changed
// suite.Require().True(clientState.GetLatestHeight().EQ(consensusHeights[0]))

// // ensure consensus state was pruned
// _, found := path.EndpointA.Chain.GetConsensusState(path.EndpointA.ClientID, pruneHeight)
// suite.Require().False(found)
// }, true,
// },
// {
// "invalid ClientMessage type", func() {
// clientMessage = &ibctm.Misbehaviour{}
// },
// func() {},
// false,
// },
// }
// for _, tc := range testCases {
// suite.Run(tc.name, func() {
// suite.SetupWasmTendermint() // reset
// path = ibctesting.NewPath(suite.chainA, suite.chainB)
func (suite *TypesTestSuite) TestUpdateState() {
errMsg := errors.New("callbackFn error")
mockClientStateBz := []byte("mockClientStateBz")
charleenfei marked this conversation as resolved.
Show resolved Hide resolved
mockHeight := clienttypes.NewHeight(1, 1)

// err := path.EndpointA.CreateClient()
// suite.Require().NoError(err)
var clientMsg exported.ClientMessage

// // ensure counterparty state is committed
// suite.coordinator.CommitBlock(suite.chainB)
// clientMessage, height, err = path.EndpointA.Chain.ConstructUpdateWasmClientHeader(path.EndpointA.Counterparty.Chain, path.EndpointA.ClientID)
// suite.Require().NoError(err)
testCases := []struct {
name string
malleate func()
expPanic error
expHeights []exported.Height
expClientState []byte
}{
{
"success: no update",
func() {
suite.mockVM.RegisterSudoCallback(types.UpdateStateMsg{}, func(_ wasmvm.Checksum, _ wasmvmtypes.Env, sudoMsg []byte, _ wasmvm.KVStore, _ wasmvm.GoAPI, _ wasmvm.Querier, _ wasmvm.GasMeter, _ uint64, _ wasmvmtypes.UFraction) (*wasmvmtypes.Response, uint64, error) {
var msg *types.SudoMsg
err := json.Unmarshal(sudoMsg, &msg)
suite.Require().NoError(err)

suite.Require().NotNil(msg.UpdateState)
suite.Require().NotNil(msg.UpdateState.ClientMessage)
suite.Require().Equal(msg.UpdateState.ClientMessage.Data, mockClientStateBz)
suite.Require().Nil(msg.VerifyMembership)
suite.Require().Nil(msg.VerifyNonMembership)
suite.Require().Nil(msg.UpdateStateOnMisbehaviour)
suite.Require().Nil(msg.VerifyUpgradeAndUpdateState)
suite.Require().Nil(msg.CheckSubstituteAndUpdateState)

updateStateResp := types.UpdateStateResult{
Heights: []clienttypes.Height{},
}

resp, err := json.Marshal(updateStateResp)
if err != nil {
return nil, 0, err
}

return &wasmvmtypes.Response{
Data: resp,
}, types.DefaultGasUsed, nil
})
},
nil,
[]exported.Height{},
nil,
},
{
"success: update client",
func() {
suite.mockVM.RegisterSudoCallback(types.UpdateStateMsg{}, func(_ wasmvm.Checksum, _ wasmvmtypes.Env, sudoMsg []byte, store wasmvm.KVStore, _ wasmvm.GoAPI, _ wasmvm.Querier, _ wasmvm.GasMeter, _ uint64, _ wasmvmtypes.UFraction) (*wasmvmtypes.Response, uint64, error) {
var msg *types.SudoMsg
err := json.Unmarshal(sudoMsg, &msg)
suite.Require().NoError(err)

store.Set(host.ClientStateKey(), msg.UpdateState.ClientMessage.Data)
updateStateResp := types.UpdateStateResult{
Heights: []clienttypes.Height{mockHeight},
}

resp, err := json.Marshal(updateStateResp)
if err != nil {
return nil, 0, err
}

return &wasmvmtypes.Response{
Data: resp,
}, types.DefaultGasUsed, nil
})
},
nil,
[]exported.Height{mockHeight},
mockClientStateBz,
},
{
"failure: invalid ClientMessage type",
func() {
// SudoCallback left nil because clientMsg is checked by 08-wasm before callbackFn is called.
clientMsg = &tmtypes.Misbehaviour{}
},
fmt.Errorf("expected type %T, got %T", (*types.ClientMessage)(nil), (*tmtypes.Misbehaviour)(nil)),
nil,
nil,
},
{
"failure: callbackFn returns error",
func() {
suite.mockVM.RegisterSudoCallback(types.UpdateStateMsg{}, func(_ wasmvm.Checksum, _ wasmvmtypes.Env, _ []byte, _ wasmvm.KVStore, _ wasmvm.GoAPI, _ wasmvm.Querier, _ wasmvm.GasMeter, _ uint64, _ wasmvmtypes.UFraction) (*wasmvmtypes.Response, uint64, error) {
return nil, 0, errors.New("callbackFn error")
})
},
errorsmod.Wrapf(errMsg, "call to wasm contract failed"),
nil,
nil,
},
}

// tc.malleate()
for _, tc := range testCases {
suite.Run(tc.name, func() {
suite.SetupWasmWithMockVM() // reset

// clientState := path.EndpointA.GetClientState()
// clientStore = suite.chainA.App.GetIBCKeeper().ClientKeeper.ClientStore(suite.chainA.GetContext(), path.EndpointA.ClientID)
clientMsg = &types.ClientMessage{
Data: mockClientStateBz,
}

// if tc.expPass {
// consensusHeights = clientState.UpdateState(suite.chainA.GetContext(), suite.chainA.App.AppCodec(), clientStore, clientMessage)
endpoint := wasmtesting.NewWasmEndpoint(suite.chainA)
err := endpoint.CreateClient()
suite.Require().NoError(err)

// clientMessage, ok := clientMessage.(*types.ClientMessage)
// suite.Require().True(ok)
// var eHeader exported.ClientMessage
// err := suite.chainA.Codec.UnmarshalInterface(clientMessage.Data, &eHeader)
// tmHeader := eHeader.(*ibctm.Header)
// suite.Require().NoError(err)
// expTmConsensusState := &ibctm.ConsensusState{
// Timestamp: tmHeader.GetTime(),
// Root: commitmenttypes.NewMerkleRoot(tmHeader.Header.GetAppHash()),
// NextValidatorsHash: tmHeader.Header.NextValidatorsHash,
// }
// wasmData, err := suite.chainA.Codec.MarshalInterface(expTmConsensusState)
// suite.Require().NoError(err)
// expWasmConsensusState := &types.ConsensusState{
// Data: wasmData,
// }
tc.malleate()

// bz := clientStore.Get(host.ConsensusStateKey(height))
// updatedConsensusState := clienttypes.MustUnmarshalConsensusState(suite.chainA.App.AppCodec(), bz)
clientState := endpoint.GetClientState()

// suite.Require().Equal(expWasmConsensusState, updatedConsensusState)
var heights []exported.Height
charleenfei marked this conversation as resolved.
Show resolved Hide resolved
updateState := func() {
heights = clientState.UpdateState(suite.ctx, suite.chainA.Codec, suite.store, clientMsg)
}

// } else {
// suite.Require().Panics(func() {
// clientState.UpdateState(suite.chainA.GetContext(), suite.chainA.App.AppCodec(), clientStore, clientMessage)
// })
// }
if tc.expPanic == nil {
updateState()
suite.Require().Equal(tc.expHeights, heights)

// // perform custom checks
// tc.expResult()
// })
// }
// }
if tc.expClientState != nil {
clientStateBz := suite.store.Get(host.ClientStateKey())
suite.Require().Equal(tc.expClientState, clientStateBz)
}
} else {
suite.Require().PanicsWithError(tc.expPanic.Error(), updateState)
}
})
}
}

/* func (suite *TypesTestSuite) TestUpdateStateOnMisbehaviourGrandpa() {
var (
Expand Down
Loading