simulation: Allow operations to specify future operations

PENDING.md

@@ -41,6 +41,7 @@ FEATURES
 
 * SDK
   * [querier] added custom querier functionality, so ABCI query requests can be handled by keepers
+  * [simulation] \#1924 allow operations to specify future operations
 
 * Tendermint
 

cmd/gaia/app/sim_test.go

@@ -3,7 +3,6 @@ package app
 import (
 	"encoding/json"
 	"flag"
-	"fmt"
 	"math/rand"
 	"testing"
 
@@ -87,7 +86,7 @@ func appStateFn(r *rand.Rand, keys []crypto.PrivKey, accs []sdk.AccAddress) json
 
 func testAndRunTxs(app *GaiaApp) []simulation.Operation {
 	return []simulation.Operation{
-		banksim.TestAndRunSingleInputMsgSend(app.accountMapper),
+		banksim.SimulateSingleInputMsgSend(app.accountMapper),
 		govsim.SimulateMsgSubmitProposal(app.govKeeper, app.stakeKeeper),
 		govsim.SimulateMsgDeposit(app.govKeeper, app.stakeKeeper),
 		govsim.SimulateMsgVote(app.govKeeper, app.stakeKeeper),
@@ -171,11 +170,10 @@ func TestAppStateDeterminism(t *testing.T) {
 				true,
 			)
 			appHash := app.LastCommitID().Hash
-			fmt.Printf(">>> APP HASH: %v, %X\n", appHash, appHash)
 			appHashList[j] = appHash
 		}
 		for k := 1; k < numTimesToRunPerSeed; k++ {
-			require.Equal(t, appHashList[0], appHashList[k])
+			require.Equal(t, appHashList[0], appHashList[k], "appHash list: %v", appHashList)
 		}
 	}
 }

x/bank/simulation/msgs.go

@@ -18,10 +18,10 @@ import (
 	"github.com/tendermint/tendermint/crypto"
 )
 
-// TestAndRunSingleInputMsgSend tests and runs a single msg send, with one input and one output, where both
+// SimulateSingleInputMsgSend tests and runs a single msg send, with one input and one output, where both
 // accounts already exist.
-func TestAndRunSingleInputMsgSend(mapper auth.AccountMapper) simulation.Operation {
-	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, err sdk.Error) {
+func SimulateSingleInputMsgSend(mapper auth.AccountMapper) simulation.Operation {
+	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, fOps []simulation.FutureOperation, err sdk.Error) {
 		fromKey := simulation.RandomKey(r, keys)
 		fromAddr := sdk.AccAddress(fromKey.PubKey().Address())
 		toKey := simulation.RandomKey(r, keys)
@@ -36,13 +36,13 @@ func TestAndRunSingleInputMsgSend(mapper auth.AccountMapper) simulation.Operatio
 		initFromCoins := mapper.GetAccount(ctx, fromAddr).GetCoins()
 
 		if len(initFromCoins) == 0 {
-			return "skipping, no coins at all", nil
+			return "skipping, no coins at all", nil, nil
 		}
 
 		denomIndex := r.Intn(len(initFromCoins))
 		amt, goErr := randPositiveInt(r, initFromCoins[denomIndex].Amount)
 		if goErr != nil {
-			return "skipping bank send due to account having no coins of denomination " + initFromCoins[denomIndex].Denom, nil
+			return "skipping bank send due to account having no coins of denomination " + initFromCoins[denomIndex].Denom, nil, nil
 		}
 
 		action = fmt.Sprintf("%s is sending %s %s to %s",
@@ -61,7 +61,7 @@ func TestAndRunSingleInputMsgSend(mapper auth.AccountMapper) simulation.Operatio
 		sendAndVerifyMsgSend(t, app, mapper, msg, ctx, log, []crypto.PrivKey{fromKey})
 		event("bank/sendAndVerifyMsgSend/ok")
 
-		return action, nil
+		return action, nil, nil
 	}
 }
 

x/bank/simulation/sim_test.go

@@ -34,7 +34,7 @@ func TestBankWithRandomMessages(t *testing.T) {
 	simulation.Simulate(
 		t, mapp.BaseApp, appStateFn,
 		[]simulation.Operation{
-			TestAndRunSingleInputMsgSend(mapper),
+			SimulateSingleInputMsgSend(mapper),
 		},
 		[]simulation.RandSetup{},
 		[]simulation.Invariant{

x/gov/simulation/msgs.go

@@ -20,9 +20,10 @@ const (
 	denom = "steak"
 )
 
-// SimulateMsgSubmitProposal
+// SimulateMsgSubmitProposal simulates a msg Submit Proposal
+// Note: Currently doesn't ensure that the proposal txt is in JSON form
 func SimulateMsgSubmitProposal(k gov.Keeper, sk stake.Keeper) simulation.Operation {
-	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, err sdk.Error) {
+	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, fOps []simulation.FutureOperation, err sdk.Error) {
 		key := simulation.RandomKey(r, keys)
 		addr := sdk.AccAddress(key.PubKey().Address())
 		deposit := randomDeposit(r)
@@ -45,18 +46,18 @@ func SimulateMsgSubmitProposal(k gov.Keeper, sk stake.Keeper) simulation.Operati
 		}
 		event(fmt.Sprintf("gov/MsgSubmitProposal/%v", result.IsOK()))
 		action = fmt.Sprintf("TestMsgSubmitProposal: ok %v, msg %s", result.IsOK(), msg.GetSignBytes())
-		return action, nil
+		return action, nil, nil
 	}
 }
 
 // SimulateMsgDeposit
 func SimulateMsgDeposit(k gov.Keeper, sk stake.Keeper) simulation.Operation {
-	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, err sdk.Error) {
+	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, fOp []simulation.FutureOperation, err sdk.Error) {
 		key := simulation.RandomKey(r, keys)
 		addr := sdk.AccAddress(key.PubKey().Address())
 		proposalID, ok := randomProposalID(r, k, ctx)
 		if !ok {
-			return "no-operation", nil
+			return "no-operation", nil, nil
 		}
 		deposit := randomDeposit(r)
 		msg := gov.NewMsgDeposit(addr, proposalID, deposit)
@@ -72,18 +73,18 @@ func SimulateMsgDeposit(k gov.Keeper, sk stake.Keeper) simulation.Operation {
 		}
 		event(fmt.Sprintf("gov/MsgDeposit/%v", result.IsOK()))
 		action = fmt.Sprintf("TestMsgDeposit: ok %v, msg %s", result.IsOK(), msg.GetSignBytes())
-		return action, nil
+		return action, nil, nil
 	}
 }
 
 // SimulateMsgVote
 func SimulateMsgVote(k gov.Keeper, sk stake.Keeper) simulation.Operation {
-	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, err sdk.Error) {
+	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, fOp []simulation.FutureOperation, err sdk.Error) {
 		key := simulation.RandomKey(r, keys)
 		addr := sdk.AccAddress(key.PubKey().Address())
 		proposalID, ok := randomProposalID(r, k, ctx)
 		if !ok {
-			return "no-operation", nil
+			return "no-operation", nil, nil
 		}
 		option := randomVotingOption(r)
 		msg := gov.NewMsgVote(addr, proposalID, option)
@@ -95,7 +96,7 @@ func SimulateMsgVote(k gov.Keeper, sk stake.Keeper) simulation.Operation {
 		}
 		event(fmt.Sprintf("gov/MsgVote/%v", result.IsOK()))
 		action = fmt.Sprintf("TestMsgVote: ok %v, msg %s", result.IsOK(), msg.GetSignBytes())
-		return action, nil
+		return action, nil, nil
 	}
 }
 

x/mock/simulation/random_simulate_blocks.go

@@ -70,6 +70,8 @@ func SimulateFromSeed(
 	request := abci.RequestBeginBlock{Header: header}
 
 	var pastTimes []time.Time
+	// These are operations which have been queued by previous operations
+	operationQueue := make(map[int][]Operation)
 
 	for i := 0; i < numBlocks; i++ {
 
@@ -96,9 +98,14 @@ func SimulateFromSeed(
 		default:
 			thisBlockSize = r.Intn(blockSize * 4)
 		}
+		// Run queued operations. Ignores blocksize if blocksize is too small
+		log, numQueuedOpsRan := runQueuedOperations(operationQueue, int(header.Height), t, r, app, ctx, keys, log, event)
+		opCount += numQueuedOpsRan
+		thisBlockSize -= numQueuedOpsRan
 		for j := 0; j < thisBlockSize; j++ {
-			logUpdate, err := ops[r.Intn(len(ops))](t, r, app, ctx, keys, log, event)
+			logUpdate, futureOps, err := ops[r.Intn(len(ops))](t, r, app, ctx, keys, log, event)
 			log += "\n" + logUpdate
+			queueOperations(operationQueue, futureOps)
 
 			require.Nil(t, err, log)
 			if onOperation {
@@ -134,6 +141,39 @@ func SimulateFromSeed(
 	DisplayEvents(events)
 }
 
+// adds all future operations into the operation queue.
+func queueOperations(queuedOperations map[int][]Operation, futureOperations []FutureOperation) {
+	if futureOperations == nil {
+		return
+	}
+	for _, futureOp := range futureOperations {
+		if val, ok := queuedOperations[futureOp.BlockHeight]; ok {
+			queuedOperations[futureOp.BlockHeight] = append(val, futureOp.Op)
+		} else {
+			queuedOperations[futureOp.BlockHeight] = []Operation{futureOp.Op}
+		}
+	}
+}
+
+func runQueuedOperations(queueOperations map[int][]Operation, height int, t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context,
+	privKeys []crypto.PrivKey, log string, event func(string)) (updatedLog string, numOpsRan int) {
+	updatedLog = log
+	if queuedOps, ok := queueOperations[height]; ok {
+		numOps := len(queuedOps)
+		for i := 0; i < numOps; i++ {
+			// For now, queued operations cannot queue more operations.
+			// If a need arises for us to support queued messages to queue more messages, this can
+			// be changed.
+			logUpdate, _, err := queuedOps[i](t, r, app, ctx, privKeys, updatedLog, event)
+			updatedLog += "\n" + logUpdate
+			require.Nil(t, err, updatedLog)
+		}
+		delete(queueOperations, height)
+		return updatedLog, numOps
+	}
+	return log, 0
+}
+
 func getKeys(validators map[string]mockValidator) []string {
 	keys := make([]string, len(validators))
 	i := 0

x/mock/simulation/types.go

@@ -19,10 +19,13 @@ type (
 	// For ease of debugging,
 	// an operation returns a descriptive message "action",
 	// which details what this fuzzed state machine transition actually did.
+	//
+	// Operations can optionally provide a list of "FutureOperations" to run later
+	// These will be ran at the beginning of the corresponding block.
 	Operation func(
 		t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context,
 		privKeys []crypto.PrivKey, log string, event func(string),
-	) (action string, err sdk.Error)
+	) (action string, futureOperations []FutureOperation, err sdk.Error)
 
 	// RandSetup performs the random setup the mock module needs.
 	RandSetup func(r *rand.Rand, privKeys []crypto.PrivKey)
@@ -36,6 +39,15 @@ type (
 		val           abci.Validator
 		livenessState int
 	}
+
+	// FutureOperation is an operation which will be ran at the
+	// beginning of the provided BlockHeight.
+	// In the (likely) event that multiple operations are queued at the same
+	// block height, they will execute in a FIFO pattern.
+	FutureOperation struct {
+		BlockHeight int
+		Op          Operation
+	}
 )
 
 // PeriodicInvariant returns an Invariant function closure that asserts

x/slashing/simulation/msgs.go

@@ -17,7 +17,7 @@ import (
 
 // SimulateMsgUnjail
 func SimulateMsgUnjail(k slashing.Keeper) simulation.Operation {
-	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, err sdk.Error) {
+	return func(t *testing.T, r *rand.Rand, app *baseapp.BaseApp, ctx sdk.Context, keys []crypto.PrivKey, log string, event func(string)) (action string, fOp []simulation.FutureOperation, err sdk.Error) {
 		key := simulation.RandomKey(r, keys)
 		address := sdk.AccAddress(key.PubKey().Address())
 		msg := slashing.NewMsgUnjail(address)
@@ -29,6 +29,6 @@ func SimulateMsgUnjail(k slashing.Keeper) simulation.Operation {
 		}
 		event(fmt.Sprintf("slashing/MsgUnjail/%v", result.IsOK()))
 		action = fmt.Sprintf("TestMsgUnjail: ok %v, msg %s", result.IsOK(), msg.GetSignBytes())
-		return action, nil
+		return action, nil, nil
 	}
 }