R4R: Simulation framework, including staking simulation

.circleci/config.yml

@@ -85,6 +85,23 @@ jobs:
             export PATH="$GOBIN:$PATH"
             make test_cli
 
+  test_sim:
+    <<: *defaults
+    parallelism: 1
+    steps:
+      - attach_workspace:
+          at: /tmp/workspace
+      - restore_cache:
+          key: v1-pkg-cache
+      - restore_cache:
+          key: v1-tree-{{ .Environment.CIRCLE_SHA1 }}
+      - run:
+          name: Test simulation
+          command: |
+            export PATH="$GOBIN:$PATH"
+            export GAIA_SIMULATION_SEED=1531897442166404087
+            make test_sim
+
   test_cover:
     <<: *defaults
     parallelism: 4
@@ -144,6 +161,9 @@ workflows:
       - test_cli:
           requires:
             - setup_dependencies
+      - test_sim:
+          requires:
+            - setup_dependencies
       - test_cover:
           requires:
             - setup_dependencies

Makefile

@@ -1,5 +1,6 @@
 PACKAGES=$(shell go list ./... | grep -v '/vendor/')
-PACKAGES_NOCLITEST=$(shell go list ./... | grep -v '/vendor/' | grep -v github.com/cosmos/cosmos-sdk/cmd/gaia/cli_test)
+PACKAGES_NOCLITEST=$(shell go list ./... | grep -v '/vendor/' | grep -v '/simulation' | grep -v github.com/cosmos/cosmos-sdk/cmd/gaia/cli_test)
+PACKAGES_SIMTEST=$(shell go list ./... | grep -v '/vendor/' | grep '/simulation')
 COMMIT_HASH := $(shell git rev-parse --short HEAD)
 BUILD_TAGS = netgo ledger
 BUILD_FLAGS = -tags "${BUILD_TAGS}" -ldflags "-X github.com/cosmos/cosmos-sdk/version.GitCommit=${COMMIT_HASH}"
@@ -127,6 +128,16 @@ test_unit:
 test_race:
 	@go test -race $(PACKAGES_NOCLITEST)
 
+test_sim:
+	@echo "Running individual module simulations."
+	@go test $(PACKAGES_SIMTEST) -v
+	@echo "Running full Gaia simulation. This may take several minutes."
+	@echo "Pass the flag 'SimulationSeed' to run with a constant seed."
+	@echo "Pass the flag 'SimulationNumKeys' to run with the specified number of keys."
+	@echo "Pass the flag 'SimulationNumBlocks' to run with the specified number of blocks."
+	@echo "Pass the flag 'SimulationBlockSize' to run with the specified block size (operations per block)."
+	@go test ./cmd/gaia/app -run TestFullGaiaSimulation -SimulationEnabled=true -SimulationBlockSize=200 -v
+
 test_cover:
 	@bash tests/test_cover.sh
 
@@ -212,4 +223,4 @@ remotenet-status:
 check_tools get_tools get_vendor_deps draw_deps test test_cli test_unit \
 test_cover test_lint benchmark devdoc_init devdoc devdoc_save devdoc_update \
 build-linux build-docker-gaiadnode localnet-start localnet-stop remotenet-start \
-remotenet-stop remotenet-status format check-ledger
+remotenet-stop remotenet-status format check-ledger test_sim

PENDING.md

@@ -6,6 +6,10 @@ BREAKING CHANGES
 
 FEATURES
 * [lcd] Can now query governance proposals by ProposalStatus
+* [x/mock/simulation] Randomized simulation framework
+  * Modules specify invariants and operations, preferably in an x/[module]/simulation package
+  * Modules can test random combinations of their own operations
+  * Applications can integrate operations and invariants from modules together for an integrated simulation
 * [baseapp] Initialize validator set on ResponseInitChain
 * Added support for cosmos-sdk-cli tool under cosmos-sdk/cmd	
    * This allows SDK users to init a new project repository with a single command.

cmd/gaia/app/sim_test.go

@@ -0,0 +1,100 @@
+package app
+
+import (
+	"encoding/json"
+	"flag"
+	"math/rand"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	dbm "github.com/tendermint/tendermint/libs/db"
+	"github.com/tendermint/tendermint/libs/log"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	banksim "github.com/cosmos/cosmos-sdk/x/bank/simulation"
+	"github.com/cosmos/cosmos-sdk/x/mock/simulation"
+	stake "github.com/cosmos/cosmos-sdk/x/stake"
+	stakesim "github.com/cosmos/cosmos-sdk/x/stake/simulation"
+)
+
+var (
+	seed      int64
+	numKeys   int
+	numBlocks int
+	blockSize int
+	enabled   bool
+)
+
+func init() {
+	flag.Int64Var(&seed, "SimulationSeed", 42, "Simulation random seed")
+	flag.IntVar(&numKeys, "SimulationNumKeys", 10, "Number of keys (accounts)")
+	flag.IntVar(&numBlocks, "SimulationNumBlocks", 100, "Number of blocks")
+	flag.IntVar(&blockSize, "SimulationBlockSize", 100, "Operations per block")
+	flag.BoolVar(&enabled, "SimulationEnabled", false, "Enable the simulation")
+}
+
+func appStateFn(r *rand.Rand, accs []sdk.AccAddress) json.RawMessage {
+	var genesisAccounts []GenesisAccount
+
+	// Randomly generate some genesis accounts
+	for _, addr := range accs {
+		coins := sdk.Coins{sdk.Coin{"steak", sdk.NewInt(100)}}
+		genesisAccounts = append(genesisAccounts, GenesisAccount{
+			Address: addr,
+			Coins:   coins,
+		})
+	}
+
+	// Default genesis state
+	stakeGenesis := stake.DefaultGenesisState()
+	stakeGenesis.Pool.LooseTokens = sdk.NewRat(1000)
+	genesis := GenesisState{
+		Accounts:  genesisAccounts,
+		StakeData: stakeGenesis,
+	}
+
+	// Marshal genesis
+	appState, err := MakeCodec().MarshalJSON(genesis)
+	if err != nil {
+		panic(err)
+	}
+
+	return appState
+}
+
+func TestFullGaiaSimulation(t *testing.T) {
+	if !enabled {
+		t.Skip("Skipping Gaia simulation")
+	}
+
+	// Setup Gaia application
+	logger := log.NewNopLogger()
+	db := dbm.NewMemDB()
+	app := NewGaiaApp(logger, db, nil)
+	require.Equal(t, "GaiaApp", app.Name())
+
+	// Run randomized simulation
+	simulation.SimulateFromSeed(
+		t, app.BaseApp, appStateFn, seed,
+		[]simulation.TestAndRunTx{
+			banksim.TestAndRunSingleInputMsgSend(app.accountMapper),
+			stakesim.SimulateMsgCreateValidator(app.accountMapper, app.stakeKeeper),
+			stakesim.SimulateMsgEditValidator(app.stakeKeeper),
+			stakesim.SimulateMsgDelegate(app.accountMapper, app.stakeKeeper),
+			stakesim.SimulateMsgBeginUnbonding(app.accountMapper, app.stakeKeeper),
+			stakesim.SimulateMsgCompleteUnbonding(app.stakeKeeper),
+			stakesim.SimulateMsgBeginRedelegate(app.accountMapper, app.stakeKeeper),
+			stakesim.SimulateMsgCompleteRedelegate(app.stakeKeeper),
+		},
+		[]simulation.RandSetup{},
+		[]simulation.Invariant{
+			banksim.NonnegativeBalanceInvariant(app.accountMapper),
+			stakesim.AllInvariants(app.coinKeeper, app.stakeKeeper, app.accountMapper),
+		},
+		numKeys,
+		numBlocks,
+		blockSize,
+	)
+
+}

examples/democoin/mock/validator.go

@@ -28,6 +28,11 @@ func (v Validator) GetPubKey() crypto.PubKey {
 	return nil
 }
 
+// Implements sdk.Validator
+func (v Validator) GetTokens() sdk.Rat {
+	return sdk.ZeroRat()
+}
+
 // Implements sdk.Validator
 func (v Validator) GetPower() sdk.Rat {
 	return v.Power

tools/Makefile

@@ -126,10 +126,10 @@ else
 	@echo "Installing unparam"
 	go get -v $(UNPARAM)
 endif
-ifdef GOYCLO_CHECK
-	@echo "goyclo is already installed.  Run 'make update_tools' to update."
+ifdef GOCYCLO_CHECK
+	@echo "gocyclo is already installed.  Run 'make update_tools' to update."
 else
-	@echo "Installing goyclo"
+	@echo "Installing gocyclo"
 	go get -v $(GOCYCLO)
 endif
 

types/coin.go

@@ -15,9 +15,13 @@ type Coin struct {
 }
 
 func NewCoin(denom string, amount int64) Coin {
+	return NewIntCoin(denom, NewInt(amount))
+}
+
+func NewIntCoin(denom string, amount Int) Coin {
 	return Coin{
 		Denom:  denom,
-		Amount: NewInt(amount),
+		Amount: amount,
 	}
 }
 

types/stake.go

@@ -43,6 +43,7 @@ type Validator interface {
 	GetOwner() AccAddress     // owner AccAddress to receive/return validators coins
 	GetPubKey() crypto.PubKey // validation pubkey
 	GetPower() Rat            // validation power
+	GetTokens() Rat           // validation tokens
 	GetDelegatorShares() Rat  // Total out standing delegator shares
 	GetBondHeight() int64     // height in which the validator became active
 }

x/bank/app_test.go

@@ -5,8 +5,6 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"math/rand"
-
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
 	"github.com/cosmos/cosmos-sdk/x/mock"
@@ -83,21 +81,6 @@ func getMockApp(t *testing.T) *mock.App {
 	return mapp
 }
 
-func TestBankWithRandomMessages(t *testing.T) {
-	mapp := getMockApp(t)
-	setup := func(r *rand.Rand, keys []crypto.PrivKey) {
-		return
-	}
-
-	mapp.RandomizedTesting(
-		t,
-		[]mock.TestAndRunTx{TestAndRunSingleInputMsgSend},
-		[]mock.RandSetup{setup},
-		[]mock.Invariant{ModuleInvariants},
-		100, 30, 30,
-	)
-}
-
 func TestMsgSendWithAccounts(t *testing.T) {
 	mapp := getMockApp(t)
 

x/bank/simulation/invariants.go

@@ -0,0 +1,50 @@
+package simulation
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/auth"
+	"github.com/cosmos/cosmos-sdk/x/mock"
+	"github.com/cosmos/cosmos-sdk/x/mock/simulation"
+	abci "github.com/tendermint/tendermint/abci/types"
+)
+
+// NonnegativeBalanceInvariant checks that all accounts in the application have non-negative balances
+func NonnegativeBalanceInvariant(mapper auth.AccountMapper) simulation.Invariant {
+	return func(t *testing.T, app *baseapp.BaseApp, log string) {
+		ctx := app.NewContext(false, abci.Header{})
+		accts := mock.GetAllAccounts(mapper, ctx)
+		for _, acc := range accts {
+			coins := acc.GetCoins()
+			require.True(t, coins.IsNotNegative(),
+				fmt.Sprintf("%s has a negative denomination of %s\n%s",
+					acc.GetAddress().String(),
+					coins.String(),
+					log),
+			)
+		}
+	}
+}
+
+// TotalCoinsInvariant checks that the sum of the coins across all accounts
+// is what is expected
+func TotalCoinsInvariant(mapper auth.AccountMapper, totalSupplyFn func() sdk.Coins) simulation.Invariant {
+	return func(t *testing.T, app *baseapp.BaseApp, log string) {
+		ctx := app.NewContext(false, abci.Header{})
+		totalCoins := sdk.Coins{}
+
+		chkAccount := func(acc auth.Account) bool {
+			coins := acc.GetCoins()
+			totalCoins = totalCoins.Plus(coins)
+			return false
+		}
+
+		mapper.IterateAccounts(ctx, chkAccount)
+		require.Equal(t, totalSupplyFn(), totalCoins, log)
+	}
+}