23e864bc98
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description ref: #8961 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> Following up on [#9697](https://github.com/cosmos/cosmos-sdk/pull/9697#pullrequestreview-727295733), this PR is the first step for the #8961. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
311 lines
10 KiB
Go
311 lines
10 KiB
Go
package keeper_test
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/suite"
|
|
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
|
|
|
|
"github.com/cosmos/cosmos-sdk/simapp"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
|
|
"github.com/cosmos/cosmos-sdk/x/capability/keeper"
|
|
"github.com/cosmos/cosmos-sdk/x/capability/types"
|
|
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
|
|
)
|
|
|
|
type KeeperTestSuite struct {
|
|
suite.Suite
|
|
|
|
ctx sdk.Context
|
|
app *simapp.SimApp
|
|
keeper *keeper.Keeper
|
|
}
|
|
|
|
func (suite *KeeperTestSuite) SetupTest() {
|
|
checkTx := false
|
|
app := simapp.Setup(suite.T(), checkTx)
|
|
cdc := app.AppCodec()
|
|
|
|
// create new keeper so we can define custom scoping before init and seal
|
|
keeper := keeper.NewKeeper(cdc, app.GetKey(types.StoreKey), app.GetMemKey(types.MemStoreKey))
|
|
|
|
suite.app = app
|
|
suite.ctx = app.BaseApp.NewContext(checkTx, tmproto.Header{Height: 1})
|
|
suite.keeper = keeper
|
|
}
|
|
|
|
func (suite *KeeperTestSuite) TestSeal() {
|
|
sk := suite.keeper.ScopeToModule(banktypes.ModuleName)
|
|
suite.Require().Panics(func() {
|
|
suite.keeper.ScopeToModule(" ")
|
|
})
|
|
|
|
caps := make([]*types.Capability, 5)
|
|
// Get Latest Index before creating new ones to sychronize indices correctly
|
|
prevIndex := suite.keeper.GetLatestIndex(suite.ctx)
|
|
|
|
for i := range caps {
|
|
cap, err := sk.NewCapability(suite.ctx, fmt.Sprintf("transfer-%d", i))
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap)
|
|
suite.Require().Equal(uint64(i)+prevIndex, cap.GetIndex())
|
|
|
|
caps[i] = cap
|
|
}
|
|
|
|
suite.Require().NotPanics(func() {
|
|
suite.keeper.Seal()
|
|
})
|
|
|
|
for i, cap := range caps {
|
|
got, ok := sk.GetCapability(suite.ctx, fmt.Sprintf("transfer-%d", i))
|
|
suite.Require().True(ok)
|
|
suite.Require().Equal(cap, got)
|
|
suite.Require().Equal(uint64(i)+prevIndex, got.GetIndex())
|
|
}
|
|
|
|
suite.Require().Panics(func() {
|
|
suite.keeper.Seal()
|
|
})
|
|
|
|
suite.Require().Panics(func() {
|
|
_ = suite.keeper.ScopeToModule(stakingtypes.ModuleName)
|
|
})
|
|
}
|
|
|
|
func (suite *KeeperTestSuite) TestNewCapability() {
|
|
sk := suite.keeper.ScopeToModule(banktypes.ModuleName)
|
|
|
|
got, ok := sk.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().False(ok)
|
|
suite.Require().Nil(got)
|
|
|
|
cap, err := sk.NewCapability(suite.ctx, "transfer")
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap)
|
|
|
|
got, ok = sk.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().True(ok)
|
|
suite.Require().Equal(cap, got)
|
|
suite.Require().True(cap == got, "expected memory addresses to be equal")
|
|
|
|
got, ok = sk.GetCapability(suite.ctx, "invalid")
|
|
suite.Require().False(ok)
|
|
suite.Require().Nil(got)
|
|
|
|
got, ok = sk.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().True(ok)
|
|
suite.Require().Equal(cap, got)
|
|
suite.Require().True(cap == got, "expected memory addresses to be equal")
|
|
|
|
cap2, err := sk.NewCapability(suite.ctx, "transfer")
|
|
suite.Require().Error(err)
|
|
suite.Require().Nil(cap2)
|
|
|
|
got, ok = sk.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().True(ok)
|
|
suite.Require().Equal(cap, got)
|
|
suite.Require().True(cap == got, "expected memory addresses to be equal")
|
|
|
|
cap, err = sk.NewCapability(suite.ctx, " ")
|
|
suite.Require().Error(err)
|
|
suite.Require().Nil(cap)
|
|
}
|
|
|
|
func (suite *KeeperTestSuite) TestAuthenticateCapability() {
|
|
sk1 := suite.keeper.ScopeToModule(banktypes.ModuleName)
|
|
sk2 := suite.keeper.ScopeToModule(stakingtypes.ModuleName)
|
|
|
|
cap1, err := sk1.NewCapability(suite.ctx, "transfer")
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap1)
|
|
|
|
forgedCap := types.NewCapability(cap1.Index) // index should be the same index as the first capability
|
|
suite.Require().False(sk1.AuthenticateCapability(suite.ctx, forgedCap, "transfer"))
|
|
suite.Require().False(sk2.AuthenticateCapability(suite.ctx, forgedCap, "transfer"))
|
|
|
|
cap2, err := sk2.NewCapability(suite.ctx, "bond")
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap2)
|
|
|
|
got, ok := sk1.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().True(ok)
|
|
|
|
suite.Require().True(sk1.AuthenticateCapability(suite.ctx, cap1, "transfer"))
|
|
suite.Require().True(sk1.AuthenticateCapability(suite.ctx, got, "transfer"))
|
|
suite.Require().False(sk1.AuthenticateCapability(suite.ctx, cap1, "invalid"))
|
|
suite.Require().False(sk1.AuthenticateCapability(suite.ctx, cap2, "transfer"))
|
|
|
|
suite.Require().True(sk2.AuthenticateCapability(suite.ctx, cap2, "bond"))
|
|
suite.Require().False(sk2.AuthenticateCapability(suite.ctx, cap2, "invalid"))
|
|
suite.Require().False(sk2.AuthenticateCapability(suite.ctx, cap1, "bond"))
|
|
|
|
sk2.ReleaseCapability(suite.ctx, cap2)
|
|
suite.Require().False(sk2.AuthenticateCapability(suite.ctx, cap2, "bond"))
|
|
|
|
badCap := types.NewCapability(100)
|
|
suite.Require().False(sk1.AuthenticateCapability(suite.ctx, badCap, "transfer"))
|
|
suite.Require().False(sk2.AuthenticateCapability(suite.ctx, badCap, "bond"))
|
|
|
|
suite.Require().False(sk1.AuthenticateCapability(suite.ctx, cap1, " "))
|
|
suite.Require().False(sk1.AuthenticateCapability(suite.ctx, nil, "transfer"))
|
|
}
|
|
|
|
func (suite *KeeperTestSuite) TestClaimCapability() {
|
|
sk1 := suite.keeper.ScopeToModule(banktypes.ModuleName)
|
|
sk2 := suite.keeper.ScopeToModule(stakingtypes.ModuleName)
|
|
sk3 := suite.keeper.ScopeToModule("foo")
|
|
|
|
cap, err := sk1.NewCapability(suite.ctx, "transfer")
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap)
|
|
|
|
suite.Require().Error(sk1.ClaimCapability(suite.ctx, cap, "transfer"))
|
|
suite.Require().NoError(sk2.ClaimCapability(suite.ctx, cap, "transfer"))
|
|
|
|
got, ok := sk1.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().True(ok)
|
|
suite.Require().Equal(cap, got)
|
|
|
|
got, ok = sk2.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().True(ok)
|
|
suite.Require().Equal(cap, got)
|
|
|
|
suite.Require().Error(sk3.ClaimCapability(suite.ctx, cap, " "))
|
|
suite.Require().Error(sk3.ClaimCapability(suite.ctx, nil, "transfer"))
|
|
}
|
|
|
|
func (suite *KeeperTestSuite) TestGetOwners() {
|
|
sk1 := suite.keeper.ScopeToModule(banktypes.ModuleName)
|
|
sk2 := suite.keeper.ScopeToModule(stakingtypes.ModuleName)
|
|
sk3 := suite.keeper.ScopeToModule("foo")
|
|
|
|
sks := []keeper.ScopedKeeper{sk1, sk2, sk3}
|
|
|
|
cap, err := sk1.NewCapability(suite.ctx, "transfer")
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap)
|
|
|
|
suite.Require().NoError(sk2.ClaimCapability(suite.ctx, cap, "transfer"))
|
|
suite.Require().NoError(sk3.ClaimCapability(suite.ctx, cap, "transfer"))
|
|
|
|
expectedOrder := []string{banktypes.ModuleName, "foo", stakingtypes.ModuleName}
|
|
// Ensure all scoped keepers can get owners
|
|
for _, sk := range sks {
|
|
owners, ok := sk.GetOwners(suite.ctx, "transfer")
|
|
mods, gotCap, err := sk.LookupModules(suite.ctx, "transfer")
|
|
|
|
suite.Require().True(ok, "could not retrieve owners")
|
|
suite.Require().NotNil(owners, "owners is nil")
|
|
|
|
suite.Require().NoError(err, "could not retrieve modules")
|
|
suite.Require().NotNil(gotCap, "capability is nil")
|
|
suite.Require().NotNil(mods, "modules is nil")
|
|
suite.Require().Equal(cap, gotCap, "caps not equal")
|
|
|
|
suite.Require().Equal(len(expectedOrder), len(owners.Owners), "length of owners is unexpected")
|
|
for i, o := range owners.Owners {
|
|
// Require owner is in expected position
|
|
suite.Require().Equal(expectedOrder[i], o.Module, "module is unexpected")
|
|
suite.Require().Equal(expectedOrder[i], mods[i], "module in lookup is unexpected")
|
|
}
|
|
}
|
|
|
|
// foo module releases capability
|
|
err = sk3.ReleaseCapability(suite.ctx, cap)
|
|
suite.Require().Nil(err, "could not release capability")
|
|
|
|
// new expected order and scoped capabilities
|
|
expectedOrder = []string{banktypes.ModuleName, stakingtypes.ModuleName}
|
|
sks = []keeper.ScopedKeeper{sk1, sk2}
|
|
|
|
// Ensure all scoped keepers can get owners
|
|
for _, sk := range sks {
|
|
owners, ok := sk.GetOwners(suite.ctx, "transfer")
|
|
mods, cap, err := sk.LookupModules(suite.ctx, "transfer")
|
|
|
|
suite.Require().True(ok, "could not retrieve owners")
|
|
suite.Require().NotNil(owners, "owners is nil")
|
|
|
|
suite.Require().NoError(err, "could not retrieve modules")
|
|
suite.Require().NotNil(cap, "capability is nil")
|
|
suite.Require().NotNil(mods, "modules is nil")
|
|
|
|
suite.Require().Equal(len(expectedOrder), len(owners.Owners), "length of owners is unexpected")
|
|
for i, o := range owners.Owners {
|
|
// Require owner is in expected position
|
|
suite.Require().Equal(expectedOrder[i], o.Module, "module is unexpected")
|
|
suite.Require().Equal(expectedOrder[i], mods[i], "module in lookup is unexpected")
|
|
}
|
|
}
|
|
|
|
_, ok := sk1.GetOwners(suite.ctx, " ")
|
|
suite.Require().False(ok, "got owners from empty capability name")
|
|
}
|
|
|
|
func (suite *KeeperTestSuite) TestReleaseCapability() {
|
|
sk1 := suite.keeper.ScopeToModule(banktypes.ModuleName)
|
|
sk2 := suite.keeper.ScopeToModule(stakingtypes.ModuleName)
|
|
|
|
cap1, err := sk1.NewCapability(suite.ctx, "transfer")
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap1)
|
|
|
|
suite.Require().NoError(sk2.ClaimCapability(suite.ctx, cap1, "transfer"))
|
|
|
|
cap2, err := sk2.NewCapability(suite.ctx, "bond")
|
|
suite.Require().NoError(err)
|
|
suite.Require().NotNil(cap2)
|
|
|
|
suite.Require().Error(sk1.ReleaseCapability(suite.ctx, cap2))
|
|
|
|
suite.Require().NoError(sk2.ReleaseCapability(suite.ctx, cap1))
|
|
got, ok := sk2.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().False(ok)
|
|
suite.Require().Nil(got)
|
|
|
|
suite.Require().NoError(sk1.ReleaseCapability(suite.ctx, cap1))
|
|
got, ok = sk1.GetCapability(suite.ctx, "transfer")
|
|
suite.Require().False(ok)
|
|
suite.Require().Nil(got)
|
|
|
|
suite.Require().Error(sk1.ReleaseCapability(suite.ctx, nil))
|
|
}
|
|
|
|
func (suite KeeperTestSuite) TestRevertCapability() {
|
|
sk := suite.keeper.ScopeToModule(banktypes.ModuleName)
|
|
|
|
ms := suite.ctx.MultiStore()
|
|
|
|
msCache := ms.CacheMultiStore()
|
|
cacheCtx := suite.ctx.WithMultiStore(msCache)
|
|
|
|
capName := "revert"
|
|
// Create capability on cached context
|
|
cap, err := sk.NewCapability(cacheCtx, capName)
|
|
suite.Require().NoError(err, "could not create capability")
|
|
|
|
// Check that capability written in cached context
|
|
gotCache, ok := sk.GetCapability(cacheCtx, capName)
|
|
suite.Require().True(ok, "could not retrieve capability from cached context")
|
|
suite.Require().Equal(cap, gotCache, "did not get correct capability from cached context")
|
|
|
|
// Check that capability is NOT written to original context
|
|
got, ok := sk.GetCapability(suite.ctx, capName)
|
|
suite.Require().False(ok, "retrieved capability from original context before write")
|
|
suite.Require().Nil(got, "capability not nil in original store")
|
|
|
|
// Write to underlying memKVStore
|
|
msCache.Write()
|
|
|
|
got, ok = sk.GetCapability(suite.ctx, capName)
|
|
suite.Require().True(ok, "could not retrieve capability from context")
|
|
suite.Require().Equal(cap, got, "did not get correct capability from context")
|
|
}
|
|
|
|
func TestKeeperTestSuite(t *testing.T) {
|
|
suite.Run(t, new(KeeperTestSuite))
|
|
}
|