Add 0.43 CLI JSON migrate command (cosmos#8880)

* Add aadr-037 json migration * Add 0.43 to CLI migraet command * Add comment * Don't cover .pb.go * Bez says (2) * Reviews Co-authored-by: Alessio Treglia <[email protected]>
simonfuture2 · Mar 22, 2021 · 3f52d5a · 3f52d5a
1 parent 7b1d80e
commit 3f52d5a
Show file tree

Hide file tree

Showing 12 changed files with 837 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -48,6 +48,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * [\#8346](https://github.com/cosmos/cosmos-sdk/pull/8346) All CLI `tx` commands generate ServiceMsgs by default. Graceful Amino support has been added to ServiceMsgs to support signing legacy Msgs.
 * (crypto/ed25519) [\#8690] Adopt zip1215 ed2559 verification rules.
 * [\#8849](https://github.com/cosmos/cosmos-sdk/pull/8849) Upgrade module no longer supports time based upgrades. 
+* [\#8880](https://github.com/cosmos/cosmos-sdk/pull/8880) The CLI `simd migrate v0.40 ...` command has been renamed to `simd migrate v0.42`.
 
 
 ### API Breaking Changes

diff --git a/x/genutil/client/cli/migrate.go b/x/genutil/client/cli/migrate.go
@@ -18,6 +18,7 @@ import (
 	v038 "github.com/cosmos/cosmos-sdk/x/genutil/legacy/v038"
 	v039 "github.com/cosmos/cosmos-sdk/x/genutil/legacy/v039"
 	v040 "github.com/cosmos/cosmos-sdk/x/genutil/legacy/v040"
+	v043 "github.com/cosmos/cosmos-sdk/x/genutil/legacy/v043"
 	"github.com/cosmos/cosmos-sdk/x/genutil/types"
 )
 
@@ -28,9 +29,10 @@ const flagGenesisTime = "genesis-time"
 // Ref: https://github.com/cosmos/cosmos-sdk/issues/5041
 var migrationMap = types.MigrationMap{
 	"v0.36": v036.Migrate,
-	"v0.38": v038.Migrate, // NOTE: v0.37 and v0.38 are genesis compatible
+	"v0.38": v038.Migrate, // NOTE: v0.37 and v0.38 are genesis compatible.
 	"v0.39": v039.Migrate,
-	"v0.40": v040.Migrate,
+	"v0.42": v040.Migrate, // NOTE: v0.40, v0.41 and v0.42 are genesis compatible.
+	"v0.43": v043.Migrate,
 }
 
 // GetMigrationCallback returns a MigrationCallback for a given version.
@@ -131,7 +133,7 @@ $ %s migrate v0.36 /path/to/genesis.json --chain-id=cosmoshub-3 --genesis-time=2
 				return errors.Wrap(err, "failed to sort JSON genesis doc")
 			}
 
-			fmt.Println(string(sortedBz))
+			cmd.Println(string(sortedBz))
 			return nil
 		},
 	}

diff --git a/x/genutil/client/cli/migrate_test.go b/x/genutil/client/cli/migrate_test.go
@@ -25,35 +25,41 @@ func (s *IntegrationTestSuite) TestMigrateGenesis() {
 		target    string
 		expErr    bool
 		expErrMsg string
+		check     func(jsonOut string)
 	}{
 		{
-			"migrate to 0.36",
+			"migrate 0.34 to 0.36",
 			`{"chain_id":"test","app_state":{}}`,
 			"v0.36",
-			false, "",
+			false, "", func(_ string) {},
 		},
 		{
-			"exported 0.37 genesis file",
+			"migrate 0.37 to 0.42",
 			v037Exported,
-			"v0.40",
-			true, "Make sure that you have correctly migrated all Tendermint consensus params",
+			"v0.42",
+			true, "Make sure that you have correctly migrated all Tendermint consensus params", func(_ string) {},
 		},
 		{
-			"valid 0.40 genesis file",
+			"migrate 0.42 to 0.43",
 			v040Valid,
-			"v0.40",
+			"v0.43",
 			false, "",
+			func(jsonOut string) {
+				// Make sure the json output contains the ADR-037 gov weighted votes.
+				s.Require().Contains(jsonOut, "\"weight\":\"1.000000000000000000\"")
+			},
 		},
 	}
 
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
 			genesisFile := testutil.WriteToNewTempFile(s.T(), tc.genesis)
-			_, err := clitestutil.ExecTestCLICmd(val0.ClientCtx, cli.MigrateGenesisCmd(), []string{tc.target, genesisFile.Name()})
+			jsonOutput, err := clitestutil.ExecTestCLICmd(val0.ClientCtx, cli.MigrateGenesisCmd(), []string{tc.target, genesisFile.Name()})
 			if tc.expErr {
 				s.Require().Contains(err.Error(), tc.expErrMsg)
 			} else {
 				s.Require().NoError(err)
+				tc.check(jsonOutput.String())
 			}
 		})
 	}

diff --git a/x/genutil/client/cli/validate_genesis_test.go b/x/genutil/client/cli/validate_genesis_test.go
@@ -26,9 +26,28 @@ var v037Exported = `{
 }`
 
 // An example exported genesis file that's 0.40 compatible.
+// We added the following app_state:
+//
+// - x/gov: added votes to test ADR-037 split votes migration.
 var v040Valid = `{
 	"app_hash": "",
-	"app_state": {},
+	"app_state": {
+		"gov": {
+			"starting_proposal_id": "0",
+			"deposits": [],
+			"votes": [
+			  {
+				"proposal_id": "5",
+				"voter": "cosmos1fl48vsnmsdzcv85q5d2q4z5ajdha8yu34mf0eh",
+				"option": "VOTE_OPTION_YES"
+			  }
+			],
+			"proposals": [],
+			"deposit_params": { "min_deposit": [], "max_deposit_period": "0s" },
+			"voting_params": { "voting_period": "0s" },
+			"tally_params": { "quorum": "0", "threshold": "0", "veto_threshold": "0" }
+		}	  
+	},
 	"chain_id": "test",
 	"consensus_params": {
 		"block": {

diff --git a/x/genutil/legacy/v043/migrate.go b/x/genutil/legacy/v043/migrate.go
@@ -0,0 +1,27 @@
+package v043
+
+import (
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/x/genutil/types"
+	v040gov "github.com/cosmos/cosmos-sdk/x/gov/legacy/v040"
+	v043gov "github.com/cosmos/cosmos-sdk/x/gov/legacy/v043"
+)
+
+// Migrate migrates exported state from v0.40 to a v0.43 genesis state.
+func Migrate(appState types.AppMap, clientCtx client.Context) types.AppMap {
+	// Migrate x/gov.
+	if appState[v040gov.ModuleName] != nil {
+		// unmarshal relative source genesis application state
+		var oldGovState v040gov.GenesisState
+		clientCtx.JSONMarshaler.MustUnmarshalJSON(appState[v040gov.ModuleName], &oldGovState)
+
+		// delete deprecated x/gov genesis state
+		delete(appState, v040gov.ModuleName)
+
+		// Migrate relative source genesis application state and marshal it into
+		// the respective key.
+		appState[v043gov.ModuleName] = clientCtx.JSONMarshaler.MustMarshalJSON(v043gov.MigrateJSON(&oldGovState))
+	}
+
+	return appState
+}