fix(simulation): Fix all problems `make test-sim-custom-genesis-fast` for simulation test. #17911

luchenqun · 2023-09-27T16:43:38Z

cosmos sdk provides a powerful simulation testing capability, and one of the simulation modes TestFullAppSimulation allows for simulation testing using data from genesis.json. The original implementation can be found at #3428. However, with the release of v0.40.0, there have been significant changes to the code and TestFullAppSimulation is no longer being maintained.

The following are my steps:

To begin, the chain-related data can be initialized using the following command, at least 2 accounts must be added for genesis account, otherwise when executing SimulateMsgSend, two accounts will be selected to meet the conditions from != to and it will fall into an infinite loop.

simd init cosmos --chain-id simulation-app

simd keys add my_validator --keyring-backend test

MY_VALIDATOR_ADDRESS=$(simd keys show my_validator -a --keyring-backend test)

simd genesis add-genesis-account $MY_VALIDATOR_ADDRESS 100000000000stake
simd genesis add-genesis-account cosmos1gfg9ucc7rrzc207y9qfmf58erftzf8z8ww5lr7 100000000000stake
simd genesis add-genesis-account cosmos1lh6pmahlkytz7lmrs25a42j6kxlmztyt204kyq 100000000000stake
simd genesis add-genesis-account cosmos18v3mjs2pmssd03v0qz80fr0u2j5p7lxw8nchxg 100000000000stake

simd genesis gentx my_validator 100000000stake --chain-id simulation-app --keyring-backend test

simd genesis collect-gentxs

Then, in the latest main branch, execute the command make test-sim-custom-genesis-fast (note: you need to modify -Genesis=${HOME}/.gaiad/config/genesis.json to -Genesis=${HOME}/.simapp/config/genesis.json in the Makefile first). You may encounter the following error:

Running custom genesis simulation...
By default, /Users/lcq/.gaiad/config/genesis.json will be used.
=== RUN   TestFullAppSimulation
Starting SimulateFromSeed with randomness created with seed 99
Randomized simulation params: 
{}
Selected randomly generated consensus parameters:
{
 "block": {
  "max_bytes": 21456269,
  "max_gas": -1
 },
 "evidence": {
  "max_age_num_blocks": 302400,
  "max_age_duration": 1814400000000000
 },
 "validator": {
  "pub_key_types": [
   "ed25519"
  ]
 }
}
Starting the simulation from time Wed Sep 27 15:49:06 UTC 2023 (unixtime 1695829746)
Simulating... block 1/100, operation 0/269. Logs to writing to /Users/lcq/.simapp/simulations/2023-09-28_00:18:10.log
    simulate.go:347: error on block  1/100, operation (1/269) from x/group:
        group: not found [cosmos/cosmos-sdk/x/group/keeper/grpc_query.go:27]
        Comment: 
--- FAIL: TestFullAppSimulation (0.12s)
FAIL

Based on the errors encountered during each execution of make test-sim-custom-genesis-fast, I have identified and attempted to resolve three potential issues:

Issue 1: Fix the problem where the account randomly generated by AppStateFromGenesisFileFn does not have a ConsKey, causing SimulateMsgCreateValidator to fail.
This issue primarily arises when executing SimulateMsgCreateValidator. The accounts generated by AppStateFromGenesisFileFn do not have the ConsKey field specified, leading to a null pointer exception when calling simAccount.ConsKey.PubKey().

Issue 2: Fix the problem of operating on a group, such as SimulateMsgCreateGroupPolicy, when the group does not exist in the chain during simulation testing.
The problem is encountered when executing the simulation test of the group module. It occurs when there is no group created, meaning there is no group in the chain. Some operations are performed on an empty group, such as executing SimulateMsgCreateGroupPolicy.

Issue 3: Add the SigverifyTx flag in the simulation test whether to check the transaction signature.
During the execution of AppStateFromGenesisFileFn, the private keys corresponding to addresses are generated randomly. Therefore, when executing transactions, we need to skip the signature verification check.
Of course, if the genesis data is also randomly generated, such as the simulation test executed by the make test-sim-nondeterminism command, the private key corresponding to the address generated at this time is correct, and the signature needs to be verified at this time.
Or when we also read the data initialization chain from the genesis.json file. If the private keys corresponding to all addresses are passed in, we can also verify the signature at this time.
So I added a SigverifyTx flag that leaves it up to the user to decide whether signature verification of the transaction is required. For example, if I want to skip signature verification when executing simulation, then I can run go test -mod=readonly -run TestFullAppSimulation -Genesis=genesis.json -SigverifyTx=false

…sFileFn does not have ConsKey causing SimulateMsgCreateValidator fail

…sgCreateGroupPolicy when the group does not exist in the chain during simulation test

alexanderbez · 2023-09-27T17:09:58Z

cc @elias-orijtech

julienrbrt · 2023-09-28T08:03:12Z

testutil/sims/state_helpers.go

-		return genesis, nil, err
+		// NOTE: cometbft uses a custom JSON decoder for GenesisDoc
+		// On some machines, the above will go wrong, so try using cbftjson for Unmarshal again.
+		if err = cbftjson.Unmarshal(bytes, &genesis); err != nil {


We have a helper for that un x/genutil (

cosmos-sdk/x/genutil/types/genesis.go

Line 92 in 0a253f3

func AppGenesisFromReader(reader io.Reader) (*AppGenesis, error) {

)

Thanks for the suggestion, have used the AppGenesisFromReader function to Unmarshal the genesis.json file

julienrbrt · 2023-09-28T08:06:35Z

baseapp/baseapp.go

@@ -31,6 +31,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/types/mempool"
+	simcli "github.com/cosmos/cosmos-sdk/x/simulation/client/cli"


This feels not right to import a x/ path in baseapp.

Yes, but as I mentioned above: "Add the SigverifyTx flag in the simulation test whether to check the transaction signature.", in order to achieve this requirement, I followed the previous implementation and added a FlagSigverifyTx global variable（x/simulation/client/cli/flags.go）, and during in the simulation test,whether check the user's signature based on this global variable. In order to achieve this requirement, I have not thought of a better implementation for the time being. Can you give me any more suggestions or tips?

This feels not right to import a x/ path in baseapp.

@julienrbrt A private variable sigverifyTx has been added to the type BaseApp struct to solve this problem. Please help me review the code again.

…er to sigverify check for transaction

julienrbrt · 2023-10-13T09:34:20Z

baseapp/test_helpers.go

 	errorsmod "cosmossdk.io/errors"
+	cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"


please rn make lint-fix

julienrbrt · 2023-10-13T09:36:25Z

x/auth/ante/sigverify.go

Can we add a test in sigverify_test to harden this

done! Please help me review the code again.

julienrbrt · 2023-10-13T09:42:59Z

baseapp/baseapp.go

@@ -89,6 +89,7 @@ type BaseApp struct {
 	addrPeerFilter sdk.PeerFilter // filter peers by address and port
 	idPeerFilter   sdk.PeerFilter // filter peers by node ID
 	fauxMerkleMode bool           // if true, IAVL MountStores uses MountStoresDB for simulation speed.
+	sigverifyTx    bool           // whether to sigverify check for transaction


can we precise here, as in context what it is used for.

julienrbrt

lgtm!

fmorency · 2024-07-05T13:37:17Z

@julienrbrt Could we get those fixes in the next CosmosSDK 0.50.x version?

The fix in x/simulation/simulate.go prevents a failed simulation edge case.

fmorency · 2024-07-08T12:46:47Z

Hey @julienrbrt, I'm sorry for poking you again but I want to make sure you saw my post above.

julienrbrt · 2024-07-09T10:13:48Z

Perfectly on time for our monthly patch release (this week), thanks for pinging me

julienrbrt · 2024-07-09T10:13:58Z

@Mergifyio backport release/v0.50.x

mergify · 2024-07-09T10:14:02Z

backport release/v0.50.x

✅ Backports have been created

#20909 fix(simulation): Fix all problems make test-sim-custom-genesis-fast for simulation test. (backport #17911) has been created for branch release/v0.50.x but encountered conflicts

… for simulation test. (#17911) Co-authored-by: Luke <chenqun.l@kaitaitech.cn> (cherry picked from commit 611cd36) # Conflicts: # CHANGELOG.md

… for simulation test. (backport #17911) (#20909) Co-authored-by: Chenqun Lu <luchenqun@qq.com> Co-authored-by: Julien Robert <julien@rbrt.fr>

* build(deps): Bump github.com/cosmos/gogoproto from 1.4.12 to 1.5.0 (cosmos#20567) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * refactor(x/authz,x/feegrant): provide updated keeper in depinject (cosmos#20590) * docs: Update high level overview and introduction (backport cosmos#20535) (cosmos#20627) Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * fix: Properly parse json in the wait-tx command. (backport cosmos#20631) (cosmos#20660) Co-authored-by: Daniel Wedul <github@wedul.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * docs: remove Ineffective code block (backport cosmos#20703) (cosmos#20711) * feat(client): Add flag & reading mnemonic from file (backport cosmos#20690) (cosmos#20712) Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> * fix: nested multisig signatures using CLI (backport cosmos#20438) (cosmos#20692) Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Facundo <facundomedica@gmail.com> * feat(client/v2): get keyring from context (backport cosmos#19646) (cosmos#20727) Co-authored-by: Julien Robert <julien@rbrt.fr> * docs(x/group): orm codespace comment (backport cosmos#20749) (cosmos#20751) * feat: parse home flag earlier (backport cosmos#20771) (cosmos#20777) Co-authored-by: Julien Robert <julien@rbrt.fr> * build(deps): Bump github.com/cometbft/cometbft from 0.38.7 to 0.38.8 (cosmos#20805) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * build(deps): Bump github.com/cometbft/cometbft from 0.38.8 to 0.38.9 (cosmos#20836) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * fix(simulation): fix the problem of `validator set is empty after InitGenesis` in simulation test (backport cosmos#18196) (cosmos#20897) Co-authored-by: Chenqun Lu <luchenqun@qq.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * fix(simulation): Fix all problems `make test-sim-custom-genesis-fast` for simulation test. (backport cosmos#17911) (cosmos#20909) Co-authored-by: Chenqun Lu <luchenqun@qq.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * chore: prepare v0.50.8 (cosmos#20910) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com> Co-authored-by: marbar3778 <marbar3778@yahoo.com> Co-authored-by: Daniel Wedul <github@wedul.com> Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com> Co-authored-by: Facundo <facundomedica@gmail.com> Co-authored-by: Chenqun Lu <luchenqun@qq.com>

luchenqun added 4 commits September 27, 2023 20:45

fix(simulation): fix account randomly generated by AppStateFromGenesi…

126b8b2

…sFileFn does not have ConsKey causing SimulateMsgCreateValidator fail

fix(simulation): fix the problem of operating group such as SimulateM…

f9f3f76

…sgCreateGroupPolicy when the group does not exist in the chain during simulation test

Merge remote-tracking branch 'origin/main' into simulation

7172d90

fix(simulation): skip sigverify check when run simulation test

6aaaa0a

luchenqun requested a review from a team as a code owner September 27, 2023 16:43

github-actions bot added C:Simulations C:x/auth C:x/group Type: Build labels Sep 27, 2023

chore: update CHANGELOG.md

0b0b283

github-actions bot added the C:CLI label Sep 28, 2023

julienrbrt reviewed Sep 28, 2023

View reviewed changes

luchenqun requested a review from julienrbrt October 1, 2023 03:31

fix(simulation): add an SigverifyTx flag in the simulation test wheth…

8996f6b

…er to sigverify check for transaction

luchenqun force-pushed the simulation branch from 069d82e to 8996f6b Compare October 9, 2023 05:41

tac0turtle assigned alexanderbez and julienrbrt Oct 11, 2023

chore: fix commit error strings should not be capitalized

bc7a998

julienrbrt reviewed Oct 13, 2023

View reviewed changes

luchenqun added 2 commits October 13, 2023 18:09

chore: run make lint-fix and update commit

25d1c20

fix(simulation): add a test in sigverify_test to harden

958e45b

luchenqun requested a review from julienrbrt October 13, 2023 12:11

julienrbrt approved these changes Oct 20, 2023

View reviewed changes

julienrbrt requested review from alexanderbez and removed request for tac0turtle and atheeshp October 20, 2023 08:21

tac0turtle added this pull request to the merge queue Oct 20, 2023

Merged via the queue into cosmos:main with commit 611cd36 Oct 20, 2023
44 of 47 checks passed

luchenqun mentioned this pull request Oct 28, 2023

fix(sim): set FlagSigverifyTxValue to newApp for TestAppSimulationAfterImport #18289

Merged

fmorency mentioned this pull request Jul 4, 2024

write a simulation for POA to get off SDK fork strangelove-ventures/poa#170

Closed

mergify bot mentioned this pull request Jul 9, 2024

fix(simulation): Fix all problems make test-sim-custom-genesis-fast for simulation test. (backport #17911) #20909

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(simulation): Fix all problems `make test-sim-custom-genesis-fast` for simulation test. #17911

fix(simulation): Fix all problems `make test-sim-custom-genesis-fast` for simulation test. #17911

luchenqun commented Sep 27, 2023 •

edited

Loading

alexanderbez commented Sep 27, 2023

julienrbrt Sep 28, 2023 •

edited

Loading

luchenqun Oct 1, 2023

julienrbrt Sep 28, 2023

luchenqun Oct 1, 2023 •

edited

Loading

luchenqun Oct 9, 2023

julienrbrt Oct 13, 2023

luchenqun Oct 13, 2023

julienrbrt Oct 13, 2023

luchenqun Oct 13, 2023

julienrbrt Oct 13, 2023

luchenqun Oct 13, 2023

julienrbrt left a comment

fmorency commented Jul 5, 2024

fmorency commented Jul 8, 2024

julienrbrt commented Jul 9, 2024

julienrbrt commented Jul 9, 2024

mergify bot commented Jul 9, 2024 •

edited

Loading

		errorsmod "cosmossdk.io/errors"
		cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"

fix(simulation): Fix all problems make test-sim-custom-genesis-fast for simulation test. #17911

fix(simulation): Fix all problems make test-sim-custom-genesis-fast for simulation test. #17911

Conversation

luchenqun commented Sep 27, 2023 • edited Loading

alexanderbez commented Sep 27, 2023

julienrbrt Sep 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luchenqun Oct 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

fmorency commented Jul 5, 2024

fmorency commented Jul 8, 2024

julienrbrt commented Jul 9, 2024

julienrbrt commented Jul 9, 2024

mergify bot commented Jul 9, 2024 • edited Loading

✅ Backports have been created

fix(simulation): Fix all problems `make test-sim-custom-genesis-fast` for simulation test. #17911

fix(simulation): Fix all problems `make test-sim-custom-genesis-fast` for simulation test. #17911

luchenqun commented Sep 27, 2023 •

edited

Loading

julienrbrt Sep 28, 2023 •

edited

Loading

luchenqun Oct 1, 2023 •

edited

Loading

mergify bot commented Jul 9, 2024 •

edited

Loading