feat: add mockVM for wasm clients testing #4804
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package mock | ||
|
|
||
| import ( | ||
| wasmvm "github.com/CosmWasm/wasmvm" | ||
| wasmvmtypes "github.com/CosmWasm/wasmvm/types" | ||
|
|
||
| "github.com/cosmos/ibc-go/modules/light-clients/08-wasm/types" | ||
| ) | ||
|
|
||
| var _ types.WasmEngine = &MockWasmEngine{} | ||
colin-axner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // 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 { | ||
|
There was a problem hiding this comment. https://github.com/CosmWasm/wasmd/blob/main/x/wasm/keeper/wasmtesting/mock_engine.go#L19, also very similar to how we mock ibc apps There was a problem hiding this comment. maybe we can add this link in the code? Will be nice as an easy reference for making changes in the future. |
||
| StoreCodeFn func(codeID wasmvm.WasmCode) (wasmvm.Checksum, error) | ||
| InstantiateFn func(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) | ||
| 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) | ||
| SudoFn func(codeID wasmvm.Checksum, env wasmvmtypes.Env, sudoMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) (*wasmvmtypes.Response, uint64, error) | ||
| GetCodeFn func(codeID wasmvm.Checksum) (wasmvm.WasmCode, error) | ||
| PinFn func(checksum wasmvm.Checksum) error | ||
| } | ||
|
|
||
| func (m *MockWasmEngine) StoreCode(codeID wasmvm.WasmCode) (wasmvm.Checksum, error) { | ||
| if m.StoreCodeFn == nil { | ||
| panic("mock engine is not properly initialized") | ||
| } | ||
| 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) { | ||
|
There was a problem hiding this comment. 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 |
||
| if m.InstantiateFn == nil { | ||
| panic("mock engine is not properly initialized") | ||
| } | ||
| 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) { | ||
|
There was a problem hiding this comment. 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? There was a problem hiding this comment. could we utilize a Maybe expose a There was a problem hiding this comment. Happy to leave as is for the initial run and see if we can make improvements later 👍 |
||
| if m.QueryFn == nil { | ||
| panic("mock engine is not properly initialized") | ||
| } | ||
| return m.QueryFn(codeID, env, queryMsg, store, goapi, querier, gasMeter, gasLimit, deserCost) | ||
| } | ||
|
|
||
| func (m *MockWasmEngine) Sudo(codeID wasmvm.Checksum, env wasmvmtypes.Env, sudoMsg []byte, store wasmvm.KVStore, goapi wasmvm.GoAPI, querier wasmvm.Querier, gasMeter wasmvm.GasMeter, gasLimit uint64, deserCost wasmvmtypes.UFraction) (*wasmvmtypes.Response, uint64, error) { | ||
| if m.SudoFn == nil { | ||
| panic("mock engine is not properly initialized") | ||
| } | ||
| return m.SudoFn(codeID, env, sudoMsg, store, goapi, querier, gasMeter, gasLimit, deserCost) | ||
| } | ||
|
|
||
| func (m *MockWasmEngine) GetCode(codeID wasmvm.Checksum) (wasmvm.WasmCode, error) { | ||
| if m.GetCodeFn == nil { | ||
| panic("mock engine is not properly initialized") | ||
| } | ||
|
Comment on lines
+60
to
+62
There was a problem hiding this comment. a default of a hashmap maintaining code ids might be a nice default. |
||
| return m.GetCodeFn(codeID) | ||
| } | ||
|
|
||
| func (m *MockWasmEngine) Pin(checksum wasmvm.Checksum) error { | ||
| if m.PinFn == nil { | ||
| panic("mock engine is not properly initialized") | ||
| } | ||
|
Comment on lines
+68
to
+70
There was a problem hiding this comment. I wonder maybe some of these fns can have defualts, for There was a problem hiding this comment. 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 |
||
| return m.PinFn(checksum) | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package types | ||
|
|
||
| /* | ||
| This file is to allow for unexported functions and fields to be accessible to the testing package. | ||
| */ | ||
|
|
||
| type StatusResult struct { | ||
| statusResult | ||
| } |
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 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
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.
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.