-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#13 Full test coverage for upgrade module
- Loading branch information
Showing
5 changed files
with
158 additions
and
19 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,10 @@ | ||
| package upgrade | ||
|
|
||
| import ( | ||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| ) | ||
|
|
||
| // RegisterCodec registers concrete types on the Amino codec | ||
| func RegisterCodec(cdc *codec.Codec) { | ||
| cdc.RegisterConcrete(UpgradePlan{}, "upgrade/UpgradePlan", nil) | ||
| } |
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,141 @@ | ||
| package upgrade | ||
|
|
||
| import ( | ||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| "github.com/cosmos/cosmos-sdk/store" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/stretchr/testify/suite" | ||
| abci "github.com/tendermint/tendermint/abci/types" | ||
| dbm "github.com/tendermint/tendermint/libs/db" | ||
| "github.com/tendermint/tendermint/libs/log" | ||
| "testing" | ||
| "time" | ||
| ) | ||
|
|
||
| type TestSuite struct { | ||
| suite.Suite | ||
| keeper Keeper | ||
| ctx sdk.Context | ||
| cms store.CommitMultiStore | ||
| } | ||
|
|
||
| func (s *TestSuite) SetupTest() { | ||
| db := dbm.NewMemDB() | ||
| s.cms = store.NewCommitMultiStore(db) | ||
| key := sdk.NewKVStoreKey("upgrade") | ||
| cdc := codec.New() | ||
| RegisterCodec(cdc) | ||
| s.keeper = NewKeeper(key, cdc) | ||
| s.cms.MountStoreWithDB(key, sdk.StoreTypeIAVL, db) | ||
| _ = s.cms.LoadLatestVersion() | ||
| s.ctx = sdk.NewContext(s.cms, abci.Header{Height: 10, Time: time.Now()}, false, log.NewNopLogger()) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestRequireName() { | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{}) | ||
| s.Require().NotNil(err) | ||
| s.Require().Equal(sdk.CodeUnknownRequest, err.Code()) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestRequireFutureTime() { | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{Name: "test", Time: s.ctx.BlockHeader().Time}) | ||
| s.Require().NotNil(err) | ||
| s.Require().Equal(sdk.CodeUnknownRequest, err.Code()) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestRequireFutureBlock() { | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{Name: "test", Height: s.ctx.BlockHeight()}) | ||
| s.Require().NotNil(err) | ||
| s.Require().Equal(sdk.CodeUnknownRequest, err.Code()) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestDoTimeUpgrade() { | ||
| s.T().Log("Verify can schedule an upgrade") | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{Name: "test", Time: time.Now()}) | ||
| s.Require().Nil(err) | ||
|
|
||
| s.VerifyDoUpgrade() | ||
| } | ||
|
|
||
| func (s *TestSuite) TestDoHeightUpgrade() { | ||
| s.T().Log("Verify can schedule an upgrade") | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{Name: "test", Height: s.ctx.BlockHeight() + 1}) | ||
| s.Require().Nil(err) | ||
|
|
||
| s.VerifyDoUpgrade() | ||
| } | ||
|
|
||
| func (s *TestSuite) VerifyDoUpgrade() { | ||
| s.T().Log("Verify that a panic happens at the upgrade time/height") | ||
| newCtx := sdk.NewContext(s.cms, abci.Header{Height: s.ctx.BlockHeight() + 1, Time: time.Now()}, false, log.NewNopLogger()) | ||
| req := abci.RequestBeginBlock{Header: newCtx.BlockHeader()} | ||
| s.Require().Panics(func() { | ||
| s.keeper.BeginBlocker(newCtx, req) | ||
| }) | ||
|
|
||
| s.T().Log("Verify that the upgrade can be successfully applied with a handler") | ||
| s.keeper.SetUpgradeHandler("test", func(ctx sdk.Context, plan UpgradePlan) {}) | ||
| s.Require().NotPanics(func() { | ||
| s.keeper.BeginBlocker(newCtx, req) | ||
| }) | ||
|
|
||
| s.VerifyCleared(newCtx) | ||
| } | ||
|
|
||
| func (s *TestSuite) VerifyCleared(newCtx sdk.Context) { | ||
| s.T().Log("Verify that the upgrade plan has been cleared") | ||
| var plan UpgradePlan | ||
| err := s.keeper.GetUpgradeInfo(newCtx, &plan) | ||
| s.Require().NotNil(err) | ||
| s.Require().Equal(sdk.CodeUnknownRequest, err.Code()) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestCanClear() { | ||
| s.T().Log("Verify upgrade is scheduled") | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{Name: "test", Time: time.Now()}) | ||
| s.Require().Nil(err) | ||
|
|
||
| s.keeper.ClearUpgradePlan(s.ctx) | ||
|
|
||
| s.VerifyCleared(s.ctx) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestCantApplySameUpgradeTwice() { | ||
| s.TestDoTimeUpgrade() | ||
| s.T().Log("Verify an upgrade named \"test\" can't be scheduled twice") | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{Name: "test", Time: time.Now()}) | ||
| s.Require().NotNil(err) | ||
| s.Require().Equal(sdk.CodeUnknownRequest, err.Code()) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestDoShutdowner() { | ||
| s.T().Log("Set a custom DoShutdowner") | ||
| shutdownerCalled := false | ||
| s.keeper.SetDoShutdowner(func(ctx sdk.Context, plan UpgradePlan) { | ||
| shutdownerCalled = true | ||
| }) | ||
|
|
||
| s.T().Log("Run an upgrade and verify that the custom shutdowner was called and no panic happened") | ||
| err := s.keeper.ScheduleUpgrade(s.ctx, UpgradePlan{Name: "test", Time: time.Now()}) | ||
| s.Require().Nil(err) | ||
|
|
||
| header := abci.Header{Height: s.ctx.BlockHeight() + 1, Time: time.Now()} | ||
| newCtx := sdk.NewContext(s.cms, header, false, log.NewNopLogger()) | ||
| req := abci.RequestBeginBlock{Header: header} | ||
| s.Require().NotPanics(func() { | ||
| s.keeper.BeginBlocker(newCtx, req) | ||
| }) | ||
| s.Require().True(shutdownerCalled) | ||
| } | ||
|
|
||
| func (s *TestSuite) TestNoSpuriousUpgrades() { | ||
| s.T().Log("Verify that no upgrade panic is triggered in the BeginBlocker when we haven't scheduled an upgrade") | ||
| req := abci.RequestBeginBlock{Header: s.ctx.BlockHeader()} | ||
| s.Require().NotPanics(func() { | ||
| s.keeper.BeginBlocker(s.ctx, req) | ||
| }) | ||
| } | ||
|
|
||
| func TestTestSuite(t *testing.T) { | ||
| suite.Run(t, new(TestSuite)) | ||
| } |