0g-chain/x/savings/keeper/invariants_test.go

151 lines
5.0 KiB
Go
Raw Normal View History

package keeper_test
import (
"testing"
Update cosmos-sdk to v0.47.7 (#1811) * Update cometbft, cosmos, ethermint, and ibc-go * Replace github.com/tendermint/tendermint by github.com/cometbft/cometbft * Replace github.com/tendermint/tm-db by github.com/cometbft/cometbft-db * Replace gogo/protobuf with cosmos/gogoproto & simapp replacement * Replace cosmos-sdk/simapp/helpers with cosmos-sdk/testutil/sims * Remove no longer used simulations * Replace ibchost with ibcexported See https://github.com/cosmos/ibc-go/blob/v7.2.2/docs/migrations/v6-to-v7.md#ibc-module-constants * Add new consensus params keeper * Add consensus keeper to blockers * Fix keeper and module issues in app.go * Add IsSendEnabledCoins and update SetParams interface changes * Fix protobuf build for cosmos 47 (#1800) * fix cp errors by using -f; fix lint by only linting our proto dir; and use proofs.proto directly from ics23 for ibc-go v7 * run proto-all; commit updated third party deps and swagger changes * regenerate proto files * use correct gocosmos build plugin for buf * re-gen all protobuf files to update paths for new gocosmos plugin * update protoc and buf to latest versions * fix staking keeper issues in app.go * update tally handler for gov changes * chain id fix and flag fixes * update deps for cometbft 47.7 upgrade * remove all module legacy queriers * update stakingKeeper to pointer * Replace ModuleCdc from govv1beta1 to govcodec * remove simulations * abci.LastCommitInfo → abci.CommitInfo * Remove unused code in keys.go * simapp.MakeTestEncodingConfig -> moduletestutil.MakeTestEncodingConfi * Fix chain id issues in tests * Fix remaining unit test issues * Update changelog for upgrade * Fix e2e tests using updated kvtool * Update protonet to v47 compatible genesis * Bump cometbft-db to v0.9.1-kava.1 * Update kvtool * Remove extra changelog * Fix merged rocksdb issues * go mod cleanup * Bump cometbft-db to v9 and go to 1.21 * Bump rocksdb version to v8.10.0 * Update kvtool to latest version * Update gin to v1.9.0 * Use ibctm.ModuleName in app_test * Fallback to genesis chain id instead of client toml * Remove all simulations * Fix cdp migrations issue with v47 * Update dependencies to correct tags --------- Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
2024-02-06 22:54:10 +00:00
tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
tmtime "github.com/cometbft/cometbft/types/time"
"github.com/stretchr/testify/suite"
sdkmath "cosmossdk.io/math"
sdk "github.com/cosmos/cosmos-sdk/types"
bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
"github.com/kava-labs/kava/app"
"github.com/kava-labs/kava/x/savings/keeper"
"github.com/kava-labs/kava/x/savings/types"
)
type invariantTestSuite struct {
suite.Suite
tApp app.TestApp
ctx sdk.Context
keeper keeper.Keeper
bankKeeper bankkeeper.Keeper
addrs []sdk.AccAddress
invariants map[string]map[string]sdk.Invariant
}
func (suite *invariantTestSuite) SetupTest() {
config := sdk.GetConfig()
app.SetBech32AddressPrefixes(config)
tApp := app.NewTestApp()
ctx := tApp.NewContext(true, tmproto.Header{Height: 1, Time: tmtime.Now()})
_, addrs := app.GeneratePrivKeyAddressPairs(1)
suite.addrs = addrs
suite.tApp = tApp
suite.ctx = ctx
suite.keeper = tApp.GetSavingsKeeper()
suite.bankKeeper = tApp.GetBankKeeper()
suite.invariants = make(map[string]map[string]sdk.Invariant)
keeper.RegisterInvariants(suite, suite.keeper)
}
func (suite *invariantTestSuite) RegisterRoute(moduleName string, route string, invariant sdk.Invariant) {
_, exists := suite.invariants[moduleName]
if !exists {
suite.invariants[moduleName] = make(map[string]sdk.Invariant)
}
suite.invariants[moduleName][route] = invariant
}
func (suite *invariantTestSuite) SetupValidState() {
depositAmt := sdk.NewCoins(sdk.NewCoin("ukava", sdkmath.NewInt(2e8)))
suite.keeper.SetDeposit(suite.ctx, types.NewDeposit(
suite.addrs[0],
depositAmt,
))
err := suite.tApp.FundModuleAccount(suite.ctx, types.ModuleName, depositAmt)
suite.Require().NoError(err)
}
func (suite *invariantTestSuite) runInvariant(route string, invariant func(k keeper.Keeper) sdk.Invariant) (string, bool) {
ctx := suite.ctx
registeredInvariant := suite.invariants[types.ModuleName][route]
suite.Require().NotNil(registeredInvariant)
// direct call
dMessage, dBroken := invariant(suite.keeper)(ctx)
// registered call
rMessage, rBroken := registeredInvariant(ctx)
// all call
aMessage, aBroken := keeper.AllInvariants(suite.keeper)(ctx)
// require matching values for direct call and registered call
suite.Require().Equal(dMessage, rMessage, "expected registered invariant message to match")
suite.Require().Equal(dBroken, rBroken, "expected registered invariant broken to match")
// require matching values for direct call and all invariants call if broken
suite.Require().Equal(dBroken, aBroken, "expected all invariant broken to match")
if dBroken {
suite.Require().Equal(dMessage, aMessage, "expected all invariant message to match")
}
// return message, broken
return dMessage, dBroken
}
func (suite *invariantTestSuite) TestDepositsInvariant() {
message, broken := suite.runInvariant("deposits", keeper.DepositsInvariant)
suite.Equal("savings: validate deposits broken invariant\ndeposit invalid\n", message)
suite.Equal(false, broken)
suite.SetupValidState()
message, broken = suite.runInvariant("deposits", keeper.DepositsInvariant)
suite.Equal("savings: validate deposits broken invariant\ndeposit invalid\n", message)
suite.Equal(false, broken)
// broken with invalid deposit
suite.keeper.SetDeposit(suite.ctx, types.NewDeposit(
suite.addrs[0],
sdk.Coins{},
))
message, broken = suite.runInvariant("deposits", keeper.DepositsInvariant)
suite.Equal("savings: validate deposits broken invariant\ndeposit invalid\n", message)
suite.Equal(true, broken)
}
func (suite *invariantTestSuite) TestSolvencyInvariant() {
message, broken := suite.runInvariant("solvency", keeper.SolvencyInvariant)
suite.Equal("savings: module solvency broken invariant\ntotal deposited amount does not match module account\n", message)
suite.Equal(false, broken)
suite.SetupValidState()
message, broken = suite.runInvariant("solvency", keeper.SolvencyInvariant)
suite.Equal("savings: module solvency broken invariant\ntotal deposited amount does not match module account\n", message)
suite.Equal(false, broken)
// broken when deposits are greater than module balance
suite.keeper.SetDeposit(suite.ctx, types.NewDeposit(
suite.addrs[0],
sdk.NewCoins(sdk.NewCoin("ukava", sdkmath.NewInt(3e8))),
))
message, broken = suite.runInvariant("solvency", keeper.SolvencyInvariant)
suite.Equal("savings: module solvency broken invariant\ntotal deposited amount does not match module account\n", message)
suite.Equal(true, broken)
// broken when deposits are less than the module balance
suite.keeper.SetDeposit(suite.ctx, types.NewDeposit(
suite.addrs[0],
sdk.NewCoins(sdk.NewCoin("ukava", sdkmath.NewInt(1e8))),
))
message, broken = suite.runInvariant("solvency", keeper.SolvencyInvariant)
suite.Equal("savings: module solvency broken invariant\ntotal deposited amount does not match module account\n", message)
suite.Equal(true, broken)
}
func TestInvariantTestSuite(t *testing.T) {
suite.Run(t, new(invariantTestSuite))
}