feat: add mockVM for wasm clients testing #4804

colin-axner · 2023-10-02T16:12:13Z

Description

Initial work on bringing a mock VM. Likely should be merged after:

As this pr should likely handle any extra logic required after those changes

closes: #4798

Commit Message / Changelog Entry

type: commit message

see the guidelines for commit messages. (view raw markdown for examples)

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md).
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards and Go style guide.
Wrote unit and integration tests.
Updated relevant documentation (docs/) or specification (x/<module>/spec/).
Added relevant godoc comments.
Provide a commit message to be used for the changelog entry in the PR description for review.
Re-reviewed Files changed in the Github PR explorer.
Review Codecov Report in the comment section below once CI passes.

colin-axner · 2023-10-02T16:12:45Z

modules/light-clients/08-wasm/testing/mock_engine.go

+// MockWasmEngine implements types.WasmEngine for testing purpose. One or multiple messages can be stubbed.
+// Without a stub function a panic is thrown.
+type MockWasmEngine struct {


https://github.com/CosmWasm/wasmd/blob/main/x/wasm/keeper/wasmtesting/mock_engine.go#L19, also very similar to how we mock ibc apps

maybe we can add this link in the code? Will be nice as an easy reference for making changes in the future.

colin-axner · 2023-10-02T16:13:32Z

modules/light-clients/08-wasm/testing/simapp/app.go

@@ -281,6 +281,7 @@ func NewSimApp(
 	traceStore io.Writer,
 	loadLatest bool,
 	appOpts servertypes.AppOptions,
+	mockVM wasmtypes.WasmEngine,


quick hack, didn't want to spend so much time on this

We could maybe just add an additional constructor NewSimAppWithVm (also no ideal and would be reworked later) but I'm fine with just adding this as is for now.

Will leave as is for now, I figure once we get time to reduce the redundant simapps we will solve this issue, but also happy to see a followup with a nicer solution

colin-axner · 2023-10-03T12:11:09Z

modules/light-clients/08-wasm/testing/mock_engine.go

+	return m.StoreCodeFn(codeID)
+}
+
+func (m *MockWasmEngine) Instantiate(codeID wasmvm.Checksum, env wasmvmtypes.Env, info wasmvmtypes.MessageInfo, initMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) (*wasmvmtypes.Response, uint64, error) {


Some of these funcs are only expected to perform a single action (initialize the contract or not), so I think a simple override of functionality makes sense for those

colin-axner · 2023-10-03T12:13:02Z

modules/light-clients/08-wasm/testing/mock_engine.go

+	return m.InstantiateFn(codeID, env, info, initMsg, store, goapi, querier, gasMeter, gasLimit, deserCost)
+}
+
+func (m *MockWasmEngine) Query(codeID wasmvm.Checksum, env wasmvmtypes.Env, queryMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) ([]byte, uint64, error) {


Other funcs like query are expected to handle a subset of queries, so we may actually want to make the subset actions overrideable, not the entire query fn itself

I could remove the QueryFn field and replace with overrides for each subset action, then the QueryFn would use code magic to determine what the request is and then delegate to the appropriate response handler?

could we utilize amap[someKey]QueryFn to handle different message types?

Maybe expose a mockVm.OverrideQueryFn(key, func(){...})

Happy to leave as is for the initial run and see if we can make improvements later 👍

colin-axner · 2023-10-03T15:57:17Z

modules/light-clients/08-wasm/testing/wasm_endpoint.go

+// CreateClient creates an IBC client on the endpoint. It will update the
+// clientID for the endpoint if the message is successfully executed.
+// NOTE: a solo machine client will be created with an empty diversifier.
+func (endpoint *WasmEndpoint) CreateClient() (err error) {


took the quick route. I think the testing pkg will need to define either an interface for the Endpoint type or an interface that the endpoint needs to construct messages (such as a QueryProof interface fn). I think this will be easier to do reason about after we start the testing pkg improvement issues, so for now, I thought it was easier to duplicate the code a bit by implementing the fn's that require wasm client specific logic

opened #4807 and #4808 for the direction I think makes the most sense. For now, I think we should move forward with continuing to create this override type. Essentially the WasmEndpoint is a mock cometbft chain with a wasm client on it, and the endpoint represents that client and its connection/channel.

Once we implement interfaces for the light client module to plug into the endpoint, we could implement that interface and remove this type

colin-axner · 2023-10-03T15:57:33Z

modules/light-clients/08-wasm/testing/wasm_endpoint.go

+	contractClientState    = []byte{1}
+	contractConsensusState = []byte{2}


can be changed, just wrote something down for them

colin-axner · 2023-10-03T15:58:32Z

modules/light-clients/08-wasm/types/client_state_test.go

-				clientState.LatestHeight = latestHeight
-				path.EndpointA.SetClientState(clientState)
+				suite.mockVM.QueryFn = func(codeID wasmvm.Checksum, env wasmvmtypes.Env, queryMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) ([]byte, uint64, error) {
+					resp := fmt.Sprintf(`{"status":"%s"}`, exported.Expired)


can also do something like:

statusResult := new(types.StatusResult) statusResult.Status = exported.Active resp, err := json.Marshal(&statusResult) suite.Require().NoError(err)

I just chose something

I actually thing the one liner you have is super readable. I think the other approach you suggested would be preferable for larger types.

That, or pass an fn that acts on the type and handle the marshalling in separately.

colin-axner · 2023-10-03T15:59:26Z

modules/light-clients/08-wasm/types/types_test.go

+
+func (suite *TypesTestSuite) setupWasmWithMockVM() (ibctesting.TestingApp, map[string]json.RawMessage) {
+	suite.mockVM = &wasmtesting.MockWasmEngine{}
+	// TODO: move default functionality required for wasm client testing to the mock VM


I think it'd be easier to address this in a followup when we better define how the mock VM will be used

aye, I'll be adding some funcs here since we'd need to define ones for storing code and pinning (relevant to issue #4849). ~~I'll open another issue to track this TODO.~~ issue was already opened!

crodriguezvega

It's looking good. Thank you, @colin-axner!

I just left one minor comment for now. Looking forward to seeing the progress on this one!

modules/light-clients/08-wasm/testing/mock_engine.go

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

…in/4798-mock-wasmvm

colin-axner · 2023-10-04T09:08:25Z

modules/light-clients/08-wasm/testing/wasm_endpoint.go

+// CreateClient creates an IBC client on the endpoint. It will update the
+// clientID for the endpoint if the message is successfully executed.
+// NOTE: a solo machine client will be created with an empty diversifier.
+func (endpoint *WasmEndpoint) CreateClient() (err error) {


opened #4807 and #4808 for the direction I think makes the most sense. For now, I think we should move forward with continuing to create this override type. Essentially the WasmEndpoint is a mock cometbft chain with a wasm client on it, and the endpoint represents that client and its connection/channel.

Once we implement interfaces for the light client module to plug into the endpoint, we could implement that interface and remove this type

colin-axner · 2023-10-04T09:36:08Z

modules/light-clients/08-wasm/keeper/keeper.go

-	if types.WasmVM != nil && !reflect.DeepEqual(types.WasmVM, vm) {
-		panic(errors.New("global Wasm VM instance should not be set to a different instance"))
-	}


this check doesn't work with mock vm when you have other testing also uses the wasmvm, so I decided to remove it, especially since we are going to manage global assignment internally

TBH I like this quite a bit, even though we're still dealing with global variables, removing the scope at which we assign them can never be a bad thing.

…in/4798-mock-wasmvm

chatton

Overall I really like the direction here. The function override pattern aligns well with the mock module we use in our other tests.

I left a few suggestions, but I think one of the bigger ones would be that maybe we actually can have default functionality baked into the mock vm, and replace it only if an override function is defined.

I'm happy with how it is now though, happy to make changes in a follow up.

chatton · 2023-10-04T11:28:23Z

modules/light-clients/08-wasm/keeper/keeper.go

-	if types.WasmVM != nil && !reflect.DeepEqual(types.WasmVM, vm) {
-		panic(errors.New("global Wasm VM instance should not be set to a different instance"))
-	}


TBH I like this quite a bit, even though we're still dealing with global variables, removing the scope at which we assign them can never be a bad thing.

chatton · 2023-10-04T11:29:10Z

modules/light-clients/08-wasm/keeper/keeper_test.go

+	app := simapp.NewSimApp(log.NewNopLogger(), db, nil, true, simtestutil.EmptyAppOptions{}, nil)
 	return app, simapp.NewDefaultGenesisState(encCdc.Codec)


we'll run into some conflicts here with the sync to main. I guess we can hold off on this PR until after that is in.

chatton · 2023-10-04T11:30:01Z

modules/light-clients/08-wasm/testing/mock_engine.go

+// MockWasmEngine implements types.WasmEngine for testing purpose. One or multiple messages can be stubbed.
+// Without a stub function a panic is thrown.
+type MockWasmEngine struct {


maybe we can add this link in the code? Will be nice as an easy reference for making changes in the future.

chatton · 2023-10-04T11:33:06Z

modules/light-clients/08-wasm/testing/mock_engine.go

+	return m.InstantiateFn(codeID, env, info, initMsg, store, goapi, querier, gasMeter, gasLimit, deserCost)
+}
+
+func (m *MockWasmEngine) Query(codeID wasmvm.Checksum, env wasmvmtypes.Env, queryMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) ([]byte, uint64, error) {


could we utilize amap[someKey]QueryFn to handle different message types?

Maybe expose a mockVm.OverrideQueryFn(key, func(){...})

chatton · 2023-10-04T11:34:50Z

modules/light-clients/08-wasm/testing/mock_engine.go

+	if m.PinFn == nil {
+		panic("mock engine is not properly initialized")
+	}


I wonder maybe some of these fns can have defualts, for Pin I think in all of our tests we'd be happy with a no-op.

I think so, I decided to hold off for now until we run into the reason they need a default. I attempted to bring in the existing default functionality for initialize and status to the mock engine, but it requires exposing access to a cdc and other fields the suite has, so I decided it was better to handle that later when we have more of the testing pattern defined

modules/light-clients/08-wasm/testing/wasm_endpoint.go

chatton · 2023-10-04T11:44:42Z

modules/light-clients/08-wasm/types/client_state_test.go

+		{
+			"client is frozen",
+			func() {
+				suite.mockVM.QueryFn = func(codeID wasmvm.Checksum, env wasmvmtypes.Env, queryMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) ([]byte, uint64, error) {


this is super nice, one thing that might be useful for readability is a function alias, but editors will auto fill this stuff for you so I don't feel super strongly about it.

I don't feel strongly either, so I'll let it be a followup if we so chose

chatton · 2023-10-04T11:46:29Z

modules/light-clients/08-wasm/types/client_state_test.go

-				clientState.LatestHeight = latestHeight
-				path.EndpointA.SetClientState(clientState)
+				suite.mockVM.QueryFn = func(codeID wasmvm.Checksum, env wasmvmtypes.Env, queryMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) ([]byte, uint64, error) {
+					resp := fmt.Sprintf(`{"status":"%s"}`, exported.Expired)


I actually thing the one liner you have is super readable. I think the other approach you suggested would be preferable for larger types.

That, or pass an fn that acts on the type and handle the marshalling in separately.

chatton · 2023-10-04T11:48:08Z

modules/light-clients/08-wasm/types/client_state_test.go


-// 			clientStore := suite.chainA.App.GetIBCKeeper().ClientKeeper.ClientStore(suite.chainA.GetContext(), path.EndpointA.ClientID)
-// 			clientState = path.EndpointA.GetClientState().(*types.ClientState)
+			endpoint := &wasmtesting.WasmEndpoint{Endpoint: ibctesting.NewDefaultEndpoint(suite.chainA)}


worth wrapping this in a wasmtesting.NewDefaultEndpoint(suite.chainA)? which would call ibctesting.NewDefaultEndpoint(suite.chainA)

I can add a wasmtesting.NewWasmEndpoint constructor to perform this

chatton · 2023-10-04T11:50:00Z

testing/chain.go

-func (chain *TestChain) SetWasm(wasm bool) *TestChain {
-	chain.UseWasmClient = wasm
-	return chain
-}


…in/4798-mock-wasmvm

Co-authored-by: Cian Hatton <cian@interchain.io>

…o colin/4798-mock-wasmvm

damiannolan

Super nice! Awesome job, thanks for getting this together. I feel happy enough about moving forward with tests which leverage this!

🚀 🚀 🚀

damiannolan · 2023-10-04T13:21:09Z

modules/light-clients/08-wasm/testing/mock_engine.go

+	return m.InstantiateFn(codeID, env, info, initMsg, store, goapi, querier, gasMeter, gasLimit, deserCost)
+}
+
+func (m *MockWasmEngine) Query(codeID wasmvm.Checksum, env wasmvmtypes.Env, queryMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) ([]byte, uint64, error) {


Happy to leave as is for the initial run and see if we can make improvements later 👍

damiannolan · 2023-10-04T13:22:15Z

modules/light-clients/08-wasm/testing/wasm_endpoint.go

+type WasmEndpoint struct {
+	*ibctesting.Endpoint
+}


Big +

mega nit: should we add a basic godoc?

colin-axner added 3 commits October 2, 2023 18:10

feat: poc of mock engine

877c0df

chore: remove debug println

ed161e4

chore: remove unused file

d43af71

crodriguezvega added the 08-wasm label Oct 3, 2023

colin-axner mentioned this pull request Oct 3, 2023

fix: rm dependency on 08-wasm in ibc-go #4801

Merged

9 tasks

colin-axner added 2 commits October 3, 2023 14:09

fix: fixup tests

2559a5b

fix build

e5187b4

colin-axner requested a review from chatton October 3, 2023 12:16

colin-axner added 2 commits October 3, 2023 17:11

fix: use wasm endpoint instead of ibctesting endpoint

842719d

imp: remove dep on ibctesting to run wasm logic

cde7797

colin-axner commented Oct 3, 2023

View reviewed changes

crodriguezvega reviewed Oct 4, 2023

View reviewed changes

modules/light-clients/08-wasm/testing/mock_engine.go Outdated Show resolved Hide resolved

colin-axner and others added 6 commits October 4, 2023 10:54

Update modules/light-clients/08-wasm/testing/mock_engine.go

ef6b6ee

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>

apply self nits

323b6ae

lint lint lint

b1b62d1

refactor: remove reassinging global check in keeper

c458d23

Merge branch 'feat/wasm-clients' of github.com:cosmos/ibc-go into col…

c088c77

…in/4798-mock-wasmvm

remove unecessary logic and apply self nits

6dbe416

colin-axner commented Oct 4, 2023

View reviewed changes

colin-axner marked this pull request as ready for review October 4, 2023 09:46

colin-axner requested review from AdityaSripal, damiannolan, charleenfei and DimitrisJim as code owners October 4, 2023 09:46

colin-axner added 2 commits October 4, 2023 11:49

me vs the linter

af729ee

Merge branch 'feat/wasm-clients' of github.com:cosmos/ibc-go into col…

db819b0

…in/4798-mock-wasmvm

chatton approved these changes Oct 4, 2023

View reviewed changes

colin-axner and others added 3 commits October 4, 2023 15:18

Merge branch 'feat/wasm-clients' of github.com:cosmos/ibc-go into col…

4055830

…in/4798-mock-wasmvm

Update modules/light-clients/08-wasm/testing/wasm_endpoint.go

23114ae

Co-authored-by: Cian Hatton <cian@interchain.io>

apply review feedback from Cian

98087c2

Merge branch 'colin/4798-mock-wasmvm' of github.com:cosmos/ibc-go int…

2541e6c

…o colin/4798-mock-wasmvm

damiannolan approved these changes Oct 4, 2023

View reviewed changes

colin-axner added 3 commits October 4, 2023 15:28

me vs the linter, round 2

7e51364

chore: add godoc for WasmEndpoint

f3c57b9

chore: add godoc for NewWasmEndpoint

7bdda21

colin-axner mentioned this pull request Oct 4, 2023

Handle default actions for the mock engine #4818

Open

3 tasks

me vs the linter, round 3 hahah

d9b8f06

colin-axner merged commit 7032548 into feat/wasm-clients Oct 4, 2023
58 of 59 checks passed

colin-axner deleted the colin/4798-mock-wasmvm branch October 4, 2023 13:58

This was referenced Oct 4, 2023

Mock calls to Wasm VM in integration tests #4798

Closed

small fix to remove the option of generating a wasm tm client #4814

Closed

DimitrisJim mentioned this pull request Oct 6, 2023

Move default functionality required for wasm client testing to the mock VM #4850

Closed

3 tasks

		contractClientState = []byte{1}
		contractConsensusState = []byte{2}

		app := simapp.NewSimApp(log.NewNopLogger(), db, nil, true, simtestutil.EmptyAppOptions{}, nil)
		return app, simapp.NewDefaultGenesisState(encCdc.Codec)

feat: add mockVM for wasm clients testing #4804

feat: add mockVM for wasm clients testing #4804

Conversation

colin-axner commented Oct 2, 2023 • edited Loading

Description

Commit Message / Changelog Entry

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner Oct 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DimitrisJim Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

crodriguezvega left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chatton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner commented Oct 2, 2023 •

edited

Loading

colin-axner Oct 4, 2023 •

edited

Loading

DimitrisJim Oct 6, 2023 •

edited

Loading