-
Notifications
You must be signed in to change notification settings - Fork 410
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added randomized simulation parameters generation (#389)
* added simulation params * fixed return types * implemented full sim test on wasmd * removed wrong committed github action * switched to a import export test since i'm introducing params and genesis simulations * fixed makefile * Fixed sim test flags not working * fixed some errors on sim test * fixed conflicts still a failure to be solved * fixed wasm params error * added missing codec * Update params.go removed unused import * fixed intellij cache errors * added full app simulation test that pass * added README.md for sims credits added me into contributors list Co-authored-by: riccardo.montagnin <[email protected]>
- Loading branch information
Showing
10 changed files
with
423 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,230 @@ | ||
| package app | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "github.com/CosmWasm/wasmd/x/wasm" | ||
| "github.com/cosmos/cosmos-sdk/baseapp" | ||
| "github.com/cosmos/cosmos-sdk/simapp" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/types/kv" | ||
| simtypes "github.com/cosmos/cosmos-sdk/types/simulation" | ||
| authtypes "github.com/cosmos/cosmos-sdk/x/auth/types" | ||
| banktypes "github.com/cosmos/cosmos-sdk/x/bank/types" | ||
| capabilitytypes "github.com/cosmos/cosmos-sdk/x/capability/types" | ||
| distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types" | ||
| evidencetypes "github.com/cosmos/cosmos-sdk/x/evidence/types" | ||
| govtypes "github.com/cosmos/cosmos-sdk/x/gov/types" | ||
| ibctransfertypes "github.com/cosmos/cosmos-sdk/x/ibc/applications/transfer/types" | ||
| ibchost "github.com/cosmos/cosmos-sdk/x/ibc/core/24-host" | ||
| minttypes "github.com/cosmos/cosmos-sdk/x/mint/types" | ||
| paramstypes "github.com/cosmos/cosmos-sdk/x/params/types" | ||
| "github.com/cosmos/cosmos-sdk/x/simulation" | ||
| slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types" | ||
| stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/tendermint/tendermint/libs/log" | ||
| tmproto "github.com/tendermint/tendermint/proto/tendermint/types" | ||
| dbm "github.com/tendermint/tm-db" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
| ) | ||
|
|
||
| // Get flags every time the simulator is run | ||
| func init() { | ||
| simapp.GetSimulatorFlags() | ||
| } | ||
|
|
||
| type StoreKeysPrefixes struct { | ||
| A sdk.StoreKey | ||
| B sdk.StoreKey | ||
| Prefixes [][]byte | ||
| } | ||
|
|
||
| // SetupSimulation wraps simapp.SetupSimulation in order to create any export directory if they do not exist yet | ||
| func SetupSimulation(dirPrefix, dbName string) (simtypes.Config, dbm.DB, string, log.Logger, bool, error) { | ||
| config, db, dir, logger, skip, err := simapp.SetupSimulation(dirPrefix, dbName) | ||
| if err != nil { | ||
| return simtypes.Config{}, nil, "", nil, false, err | ||
| } | ||
|
|
||
| paths := []string{config.ExportParamsPath, config.ExportStatePath, config.ExportStatsPath} | ||
| for _, path := range paths { | ||
| if len(path) == 0 { | ||
| continue | ||
| } | ||
|
|
||
| path = filepath.Dir(path) | ||
| if _, err := os.Stat(path); os.IsNotExist(err) { | ||
| if err := os.MkdirAll(path, os.ModePerm); err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return config, db, dir, logger, skip, err | ||
| } | ||
|
|
||
| // GetSimulationLog unmarshals the KVPair's Value to the corresponding type based on the | ||
| // each's module store key and the prefix bytes of the KVPair's key. | ||
| func GetSimulationLog(storeName string, sdr sdk.StoreDecoderRegistry, kvAs, kvBs []kv.Pair) (log string) { | ||
| for i := 0; i < len(kvAs); i++ { | ||
| if len(kvAs[i].Value) == 0 && len(kvBs[i].Value) == 0 { | ||
| // skip if the value doesn't have any bytes | ||
| continue | ||
| } | ||
|
|
||
| decoder, ok := sdr[storeName] | ||
| if ok { | ||
| log += decoder(kvAs[i], kvBs[i]) | ||
| } else { | ||
| log += fmt.Sprintf("store A %s => %s\nstore B %s => %s\n", kvAs[i].Key, kvAs[i].Value, kvBs[i].Key, kvBs[i].Value) | ||
| } | ||
| } | ||
|
|
||
| return log | ||
| } | ||
|
|
||
| // fauxMerkleModeOpt returns a BaseApp option to use a dbStoreAdapter instead of | ||
| // an IAVLStore for faster simulation speed. | ||
| func fauxMerkleModeOpt(bapp *baseapp.BaseApp) { | ||
| bapp.SetFauxMerkleMode() | ||
| } | ||
|
|
||
| func TestAppImportExport(t *testing.T) { | ||
| config, db, dir, logger, skip, err := SetupSimulation("leveldb-app-sim", "Simulation") | ||
| if skip { | ||
| t.Skip("skipping application import/export simulation") | ||
| } | ||
| require.NoError(t, err, "simulation setup failed") | ||
|
|
||
| defer func() { | ||
| db.Close() | ||
| require.NoError(t, os.RemoveAll(dir)) | ||
| }() | ||
|
|
||
| app := NewWasmApp(logger, db, nil, true, map[int64]bool{}, DefaultNodeHome, simapp.FlagPeriodValue, wasm.EnableAllProposals, EmptyBaseAppOptions{}, nil, fauxMerkleModeOpt) | ||
| require.Equal(t, appName, app.Name()) | ||
|
|
||
| // Run randomized simulation | ||
| _, simParams, simErr := simulation.SimulateFromSeed( | ||
| t, | ||
| os.Stdout, | ||
| app.BaseApp, | ||
| simapp.AppStateFn(app.AppCodec(), app.SimulationManager()), | ||
| simtypes.RandomAccounts, | ||
| simapp.SimulationOperations(app, app.AppCodec(), config), | ||
| app.ModuleAccountAddrs(), | ||
| config, | ||
| app.AppCodec(), | ||
| ) | ||
|
|
||
| // export state and simParams before the simulation error is checked | ||
| err = simapp.CheckExportSimulation(app, config, simParams) | ||
| require.NoError(t, err) | ||
| require.NoError(t, simErr) | ||
|
|
||
| if config.Commit { | ||
| simapp.PrintStats(db) | ||
| } | ||
|
|
||
| fmt.Printf("exporting genesis...\n") | ||
|
|
||
| exported, err := app.ExportAppStateAndValidators(false, []string{}) | ||
| require.NoError(t, err) | ||
|
|
||
| fmt.Printf("importing genesis...\n") | ||
|
|
||
| _, newDB, newDir, _, _, err := SetupSimulation("leveldb-app-sim-2", "Simulation-2") | ||
| require.NoError(t, err, "simulation setup failed") | ||
|
|
||
| defer func() { | ||
| newDB.Close() | ||
| require.NoError(t, os.RemoveAll(newDir)) | ||
| }() | ||
|
|
||
| newApp := NewWasmApp(logger, db, nil, true, map[int64]bool{}, DefaultNodeHome, simapp.FlagPeriodValue, wasm.EnableAllProposals, EmptyBaseAppOptions{}, nil, fauxMerkleModeOpt) | ||
| require.Equal(t, appName, newApp.Name()) | ||
|
|
||
| var genesisState GenesisState | ||
| err = json.Unmarshal(exported.AppState, &genesisState) | ||
| require.NoError(t, err) | ||
|
|
||
| ctxA := app.NewContext(true, tmproto.Header{Height: app.LastBlockHeight()}) | ||
| ctxB := newApp.NewContext(true, tmproto.Header{Height: app.LastBlockHeight()}) | ||
| newApp.mm.InitGenesis(ctxB, app.AppCodec(), genesisState) | ||
| newApp.StoreConsensusParams(ctxB, exported.ConsensusParams) | ||
|
|
||
| fmt.Printf("comparing stores...\n") | ||
|
|
||
| storeKeysPrefixes := []StoreKeysPrefixes{ | ||
| {app.keys[authtypes.StoreKey], newApp.keys[authtypes.StoreKey], [][]byte{}}, | ||
| {app.keys[stakingtypes.StoreKey], newApp.keys[stakingtypes.StoreKey], | ||
| [][]byte{ | ||
| stakingtypes.UnbondingQueueKey, stakingtypes.RedelegationQueueKey, stakingtypes.ValidatorQueueKey, | ||
| stakingtypes.HistoricalInfoKey, | ||
| }}, | ||
| {app.keys[slashingtypes.StoreKey], newApp.keys[slashingtypes.StoreKey], [][]byte{}}, | ||
| {app.keys[minttypes.StoreKey], newApp.keys[minttypes.StoreKey], [][]byte{}}, | ||
| {app.keys[distrtypes.StoreKey], newApp.keys[distrtypes.StoreKey], [][]byte{}}, | ||
| {app.keys[banktypes.StoreKey], newApp.keys[banktypes.StoreKey], [][]byte{banktypes.BalancesPrefix}}, | ||
| {app.keys[paramstypes.StoreKey], newApp.keys[paramstypes.StoreKey], [][]byte{}}, | ||
| {app.keys[govtypes.StoreKey], newApp.keys[govtypes.StoreKey], [][]byte{}}, | ||
| {app.keys[evidencetypes.StoreKey], newApp.keys[evidencetypes.StoreKey], [][]byte{}}, | ||
| {app.keys[capabilitytypes.StoreKey], newApp.keys[capabilitytypes.StoreKey], [][]byte{}}, | ||
| {app.keys[ibchost.StoreKey], newApp.keys[ibchost.StoreKey], [][]byte{}}, | ||
| {app.keys[ibctransfertypes.StoreKey], newApp.keys[ibctransfertypes.StoreKey], [][]byte{}}, | ||
| {app.keys[wasm.StoreKey], newApp.keys[wasm.StoreKey], [][]byte{}}, | ||
| } | ||
|
|
||
| for _, skp := range storeKeysPrefixes { | ||
| storeA := ctxA.KVStore(skp.A) | ||
| storeB := ctxB.KVStore(skp.B) | ||
|
|
||
| failedKVAs, failedKVBs := sdk.DiffKVStores(storeA, storeB, skp.Prefixes) | ||
| require.Equal(t, len(failedKVAs), len(failedKVBs), "unequal sets of key-values to compare") | ||
|
|
||
| fmt.Printf("compared %d different key/value pairs between %s and %s\n", len(failedKVAs), skp.A, skp.B) | ||
| require.Len(t, failedKVAs, 0, GetSimulationLog(skp.A.Name(), app.SimulationManager().StoreDecoders, failedKVAs, failedKVBs)) | ||
| } | ||
| } | ||
|
|
||
| func TestFullAppSimulation(t *testing.T) { | ||
| config, db, dir, logger, skip, err := SetupSimulation("leveldb-app-sim", "Simulation") | ||
| if skip { | ||
| t.Skip("skipping application simulation") | ||
| } | ||
| require.NoError(t, err, "simulation setup failed") | ||
|
|
||
| defer func() { | ||
| db.Close() | ||
| require.NoError(t, os.RemoveAll(dir)) | ||
| }() | ||
|
|
||
| app := NewWasmApp(logger, db, nil, true, map[int64]bool{}, DefaultNodeHome, simapp.FlagPeriodValue, | ||
| wasm.EnableAllProposals, simapp.EmptyAppOptions{}, nil, fauxMerkleModeOpt) | ||
| require.Equal(t, "WasmApp", app.Name()) | ||
|
|
||
| // run randomized simulation | ||
| _, simParams, simErr := simulation.SimulateFromSeed( | ||
| t, | ||
| os.Stdout, | ||
| app.BaseApp, | ||
| simapp.AppStateFn(app.appCodec, app.SimulationManager()), | ||
| simtypes.RandomAccounts, // Replace with own random account function if using keys other than secp256k1 | ||
| simapp.SimulationOperations(app, app.AppCodec(), config), | ||
| app.ModuleAccountAddrs(), | ||
| config, | ||
| app.AppCodec(), | ||
| ) | ||
|
|
||
| // export state and simParams before the simulation error is checked | ||
| err = simapp.CheckExportSimulation(app, config, simParams) | ||
| require.NoError(t, err) | ||
| require.NoError(t, simErr) | ||
|
|
||
| if config.Commit { | ||
| simapp.PrintStats(db) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| ### | ||
| # Find OS and Go environment | ||
| # GO contains the Go binary | ||
| # FS contains the OS file separator | ||
| ### | ||
| ifeq ($(OS),Windows_NT) | ||
| GO := $(shell where go.exe 2> NUL) | ||
| FS := "\\" | ||
| else | ||
| GO := $(shell command -v go 2> /dev/null) | ||
| FS := "/" | ||
| endif | ||
|
|
||
| ifeq ($(GO),) | ||
| $(error could not find go. Is it in PATH? $(GO)) | ||
| endif | ||
|
|
||
| ############################################################################### | ||
| ### Functions ### | ||
| ############################################################################### | ||
|
|
||
| go_get = $(if $(findstring Windows_NT,$(OS)),\ | ||
| IF NOT EXIST $(GITHUBDIR)$(FS)$(1)$(FS) ( mkdir $(GITHUBDIR)$(FS)$(1) ) else (cd .) &\ | ||
| IF NOT EXIST $(GITHUBDIR)$(FS)$(1)$(FS)$(2)$(FS) ( cd $(GITHUBDIR)$(FS)$(1) && git clone https://github.com/$(1)/$(2) ) else (cd .) &\ | ||
| ,\ | ||
| mkdir -p $(GITHUBDIR)$(FS)$(1) &&\ | ||
| (test ! -d $(GITHUBDIR)$(FS)$(1)$(FS)$(2) && cd $(GITHUBDIR)$(FS)$(1) && git clone https://github.com/$(1)/$(2)) || true &&\ | ||
| )\ | ||
| cd $(GITHUBDIR)$(FS)$(1)$(FS)$(2) && git fetch origin && git checkout -q $(3) | ||
|
|
||
| mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST))) | ||
| mkfile_dir := $(shell cd $(shell dirname $(mkfile_path)); pwd) | ||
|
|
||
|
|
||
| ############################################################################### | ||
| ### Tools ### | ||
| ############################################################################### | ||
|
|
||
| PREFIX ?= /usr/local | ||
| BIN ?= $(PREFIX)/bin | ||
| UNAME_S ?= $(shell uname -s) | ||
| UNAME_M ?= $(shell uname -m) | ||
|
|
||
| GOPATH ?= $(shell $(GO) env GOPATH) | ||
| GITHUBDIR := $(GOPATH)$(FS)src$(FS)github.com | ||
|
|
||
| BUF_VERSION ?= 0.11.0 | ||
|
|
||
| TOOLS_DESTDIR ?= $(GOPATH)/bin | ||
| STATIK = $(TOOLS_DESTDIR)/statik | ||
| RUNSIM = $(TOOLS_DESTDIR)/runsim | ||
| GOLANGCI_LINT = $(TOOLS_DESTDIR)/golangci-lint | ||
|
|
||
| tools: tools-stamp | ||
| tools-stamp: statik runsim golangci-lint | ||
| # Create dummy file to satisfy dependency and avoid | ||
| # rebuilding when this Makefile target is hit twice | ||
| # in a row. | ||
| touch $@ | ||
|
|
||
| statik: $(STATIK) | ||
| $(STATIK): | ||
| @echo "Installing statik..." | ||
| @(cd /tmp && go get github.com/rakyll/[email protected]) | ||
|
|
||
| # Install the runsim binary with a temporary workaround of entering an outside | ||
| # directory as the "go get" command ignores the -mod option and will polute the | ||
| # go.{mod, sum} files. | ||
| # | ||
| # ref: https://github.com/golang/go/issues/30515 | ||
| runsim: $(RUNSIM) | ||
| $(RUNSIM): | ||
| @echo "Installing runsim..." | ||
| @(cd /tmp && go get github.com/cosmos/tools/cmd/[email protected]) | ||
|
|
||
| golangci-lint: $(GOLANGCI_LINT) | ||
| $(GOLANGCI_LINT): | ||
| @echo "Installing golangci-lint..." | ||
| @(cd /tmp && go get github.com/golangci/golangci-lint/cmd/[email protected]) | ||
|
|
||
| tools-clean: | ||
| rm -f $(STATIK) $(GOLANGCI_LINT) $(RUNSIM) | ||
| rm -f tools-stamp | ||
|
|
||
| .PHONY: tools-clean statik runsim |
Oops, something went wrong.