This repository has been archived by the owner on Nov 30, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* SDK modules simulations * changelog * changelog
- Loading branch information
Showing
3 changed files
with
355 additions
and
8 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,295 @@ | ||
| package app | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "math/rand" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| abci "github.com/tendermint/tendermint/abci/types" | ||
| "github.com/tendermint/tendermint/libs/log" | ||
| dbm "github.com/tendermint/tm-db" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/baseapp" | ||
| "github.com/cosmos/cosmos-sdk/simapp" | ||
| "github.com/cosmos/cosmos-sdk/simapp/helpers" | ||
| "github.com/cosmos/cosmos-sdk/store" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/x/auth" | ||
| distr "github.com/cosmos/cosmos-sdk/x/distribution" | ||
| "github.com/cosmos/cosmos-sdk/x/gov" | ||
| "github.com/cosmos/cosmos-sdk/x/mint" | ||
| "github.com/cosmos/cosmos-sdk/x/params" | ||
| "github.com/cosmos/cosmos-sdk/x/simulation" | ||
| "github.com/cosmos/cosmos-sdk/x/slashing" | ||
| "github.com/cosmos/cosmos-sdk/x/staking" | ||
| "github.com/cosmos/cosmos-sdk/x/supply" | ||
| ) | ||
|
|
||
| func init() { | ||
| simapp.GetSimulatorFlags() | ||
| } | ||
|
|
||
| type storeKeysPrefixes struct { | ||
| A sdk.StoreKey | ||
| B sdk.StoreKey | ||
| Prefixes [][]byte | ||
| } | ||
|
|
||
| // fauxMerkleModeOpt returns a BaseApp option to use a dbStoreAdapter instead of | ||
| // an IAVLStore for faster simulation speed. | ||
| func fauxMerkleModeOpt(bapp *baseapp.BaseApp) { | ||
| bapp.SetFauxMerkleMode() | ||
| } | ||
|
|
||
| // interBlockCacheOpt returns a BaseApp option function that sets the persistent | ||
| // inter-block write-through cache. | ||
| func interBlockCacheOpt() func(*baseapp.BaseApp) { | ||
| return baseapp.SetInterBlockCache(store.NewCommitKVStoreCacheManager()) | ||
| } | ||
|
|
||
| func TestFullAppSimulation(t *testing.T) { | ||
| config, db, dir, logger, skip, err := simapp.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 := NewEthermintApp(logger, db, nil, true, simapp.FlagPeriodValue, fauxMerkleModeOpt) | ||
| require.Equal(t, appName, app.Name()) | ||
|
|
||
| // run randomized simulation | ||
| _, simParams, simErr := simulation.SimulateFromSeed( | ||
| t, os.Stdout, app.BaseApp, simapp.AppStateFn(app.Codec(), app.SimulationManager()), | ||
| simapp.SimulationOperations(app, app.Codec(), config), | ||
| app.ModuleAccountAddrs(), config, | ||
| ) | ||
|
|
||
| // 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) | ||
| } | ||
| } | ||
|
|
||
| func TestAppImportExport(t *testing.T) { | ||
| config, db, dir, logger, skip, err := simapp.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 := NewEthermintApp(logger, db, nil, true, simapp.FlagPeriodValue, fauxMerkleModeOpt) | ||
| require.Equal(t, appName, app.Name()) | ||
|
|
||
| // Run randomized simulation | ||
| _, simParams, simErr := simulation.SimulateFromSeed( | ||
| t, os.Stdout, app.BaseApp, simapp.AppStateFn(app.Codec(), app.SimulationManager()), | ||
| simapp.SimulationOperations(app, app.Codec(), config), | ||
| app.ModuleAccountAddrs(), config, | ||
| ) | ||
|
|
||
| // 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") | ||
|
|
||
| appState, _, err := app.ExportAppStateAndValidators(false, []string{}) | ||
| require.NoError(t, err) | ||
|
|
||
| fmt.Printf("importing genesis...\n") | ||
|
|
||
| // nolint: dogsled | ||
| _, newDB, newDir, _, _, err := simapp.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 := NewEthermintApp(log.NewNopLogger(), newDB, nil, true, simapp.FlagPeriodValue, fauxMerkleModeOpt) | ||
| require.Equal(t, appName, newApp.Name()) | ||
|
|
||
| var genesisState map[string]json.RawMessage | ||
| err = app.Codec().UnmarshalJSON(appState, &genesisState) | ||
| require.NoError(t, err) | ||
|
|
||
| ctxA := app.NewContext(true, abci.Header{Height: app.LastBlockHeight()}) | ||
| ctxB := newApp.NewContext(true, abci.Header{Height: app.LastBlockHeight()}) | ||
| newApp.mm.InitGenesis(ctxB, app.Codec(), genesisState) | ||
|
|
||
| fmt.Printf("comparing stores...\n") | ||
|
|
||
| storeKeysPrefixes := []storeKeysPrefixes{ | ||
| {app.keys[baseapp.MainStoreKey], newApp.keys[baseapp.MainStoreKey], [][]byte{}}, | ||
| {app.keys[auth.StoreKey], newApp.keys[auth.StoreKey], [][]byte{}}, | ||
| {app.keys[staking.StoreKey], newApp.keys[staking.StoreKey], | ||
| [][]byte{ | ||
| staking.UnbondingQueueKey, staking.RedelegationQueueKey, staking.ValidatorQueueKey, | ||
| staking.HistoricalInfoKey, | ||
| }}, // ordering may change but it doesn't matter | ||
| {app.keys[slashing.StoreKey], newApp.keys[slashing.StoreKey], [][]byte{}}, | ||
| {app.keys[mint.StoreKey], newApp.keys[mint.StoreKey], [][]byte{}}, | ||
| {app.keys[distr.StoreKey], newApp.keys[distr.StoreKey], [][]byte{}}, | ||
| {app.keys[supply.StoreKey], newApp.keys[supply.StoreKey], [][]byte{}}, | ||
| {app.keys[params.StoreKey], newApp.keys[params.StoreKey], [][]byte{}}, | ||
| {app.keys[gov.StoreKey], newApp.keys[gov.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 key/value pairs between %s and %s\n", len(failedKVAs), skp.A, skp.B) | ||
| require.Equal(t, len(failedKVAs), 0, simapp.GetSimulationLog(skp.A.Name(), app.SimulationManager().StoreDecoders, app.Codec(), failedKVAs, failedKVBs)) | ||
| } | ||
| } | ||
|
|
||
| func TestAppSimulationAfterImport(t *testing.T) { | ||
| config, db, dir, logger, skip, err := simapp.SetupSimulation("leveldb-app-sim", "Simulation") | ||
| if skip { | ||
| t.Skip("skipping application simulation after import") | ||
| } | ||
| require.NoError(t, err, "simulation setup failed") | ||
|
|
||
| defer func() { | ||
| db.Close() | ||
| require.NoError(t, os.RemoveAll(dir)) | ||
| }() | ||
|
|
||
| app := NewEthermintApp(logger, db, nil, true, simapp.FlagPeriodValue, fauxMerkleModeOpt) | ||
| require.Equal(t, appName, app.Name()) | ||
|
|
||
| // Run randomized simulation | ||
| stopEarly, simParams, simErr := simulation.SimulateFromSeed( | ||
| t, os.Stdout, app.BaseApp, simapp.AppStateFn(app.Codec(), app.SimulationManager()), | ||
| simapp.SimulationOperations(app, app.Codec(), config), | ||
| app.ModuleAccountAddrs(), config, | ||
| ) | ||
|
|
||
| // 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) | ||
| } | ||
|
|
||
| if stopEarly { | ||
| fmt.Println("can't export or import a zero-validator genesis, exiting test...") | ||
| return | ||
| } | ||
|
|
||
| fmt.Printf("exporting genesis...\n") | ||
|
|
||
| appState, _, err := app.ExportAppStateAndValidators(true, []string{}) | ||
| require.NoError(t, err) | ||
|
|
||
| fmt.Printf("importing genesis...\n") | ||
|
|
||
| // nolint: dosgsled | ||
| _, newDB, newDir, _, _, err := simapp.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 := NewEthermintApp(log.NewNopLogger(), newDB, nil, true, simapp.FlagPeriodValue, fauxMerkleModeOpt) | ||
| require.Equal(t, appName, newApp.Name()) | ||
|
|
||
| newApp.InitChain(abci.RequestInitChain{ | ||
| AppStateBytes: appState, | ||
| }) | ||
|
|
||
| _, _, err = simulation.SimulateFromSeed( | ||
| t, os.Stdout, newApp.BaseApp, simapp.AppStateFn(app.Codec(), app.SimulationManager()), | ||
| simapp.SimulationOperations(newApp, newApp.Codec(), config), | ||
| newApp.ModuleAccountAddrs(), config, | ||
| ) | ||
| require.NoError(t, err) | ||
| } | ||
|
|
||
| func TestAppStateDeterminism(t *testing.T) { | ||
| if !simapp.FlagEnabledValue { | ||
| t.Skip("skipping application simulation") | ||
| } | ||
|
|
||
| config := simapp.NewConfigFromFlags() | ||
| config.InitialBlockHeight = 1 | ||
| config.ExportParamsPath = "" | ||
| config.OnOperation = false | ||
| config.AllInvariants = false | ||
| config.ChainID = helpers.SimAppChainID | ||
|
|
||
| numTimesToRunPerSeed := 2 | ||
| appHashList := make([]json.RawMessage, numTimesToRunPerSeed) | ||
|
|
||
| config.Seed = rand.Int63() | ||
|
|
||
| for i := 0; i < numTimesToRunPerSeed; i++ { | ||
| var logger log.Logger | ||
| if simapp.FlagVerboseValue { | ||
| logger = log.TestingLogger() | ||
| } else { | ||
| logger = log.NewNopLogger() | ||
| } | ||
|
|
||
| db := dbm.NewMemDB() | ||
|
|
||
| app := NewEthermintApp(logger, db, nil, true, simapp.FlagPeriodValue, interBlockCacheOpt()) | ||
|
|
||
| fmt.Printf( | ||
| "running non-determinism simulation; seed %d: attempt: %d/%d\n", | ||
| config.Seed, i+1, numTimesToRunPerSeed, | ||
| ) | ||
|
|
||
| _, _, err := simulation.SimulateFromSeed( | ||
| t, os.Stdout, app.BaseApp, simapp.AppStateFn(app.Codec(), app.SimulationManager()), | ||
| simapp.SimulationOperations(app, app.Codec(), config), | ||
| app.ModuleAccountAddrs(), config, | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
| if config.Commit { | ||
| simapp.PrintStats(db) | ||
| } | ||
|
|
||
| appHash := app.LastCommitID().Hash | ||
| appHashList[i] = appHash | ||
|
|
||
| if i != 0 { | ||
| require.Equal( | ||
| t, appHashList[0], appHashList[i], | ||
| "non-determinism in seed %d: %d/%d, attempt: %d/%d\n", config.Seed, i+1, numTimesToRunPerSeed, | ||
| ) | ||
| } | ||
| } | ||
| } |