a8a52d0775
## Description
Main changes:
#### `x/auth` and `x/auth/ante` stopped depending on simapp
Some usages are left but this PR grew too much, so we might want to do it in a separate.
#### Removed all usages of the `suite` in `ante`
This makes tests way more verbose but helps keep the test cases self-contained and easier to understand (before you would need to mentally track the state of the suite throughout the test cases to understand them).
Also, it's easier to test, given that all tests are converted to standard Go unit tests (`func TestSomething(t *testing.T){`) and at least VSCode recognizes them and lets you run a single one instead of the entire suite.
I think this can/should be replicated in other modules.
Closes: #12502
---
### 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/main/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] 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)
103 lines
3.4 KiB
Go
103 lines
3.4 KiB
Go
package ante_test
|
|
|
|
import (
|
|
"testing"
|
|
|
|
cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
|
|
"github.com/cosmos/cosmos-sdk/testutil/testdata"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
"github.com/cosmos/cosmos-sdk/x/auth/ante"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestSetup(t *testing.T) {
|
|
suite := SetupTestSuite(t, true)
|
|
suite.txBuilder = suite.clientCtx.TxConfig.NewTxBuilder()
|
|
|
|
// keys and addresses
|
|
priv1, _, addr1 := testdata.KeyTestPubAddr()
|
|
|
|
// msg and signatures
|
|
msg := testdata.NewTestMsg(addr1)
|
|
feeAmount := testdata.NewTestFeeAmount()
|
|
gasLimit := testdata.NewTestGasLimit()
|
|
require.NoError(t, suite.txBuilder.SetMsgs(msg))
|
|
suite.txBuilder.SetFeeAmount(feeAmount)
|
|
suite.txBuilder.SetGasLimit(gasLimit)
|
|
|
|
privs, accNums, accSeqs := []cryptotypes.PrivKey{priv1}, []uint64{0}, []uint64{0}
|
|
tx, err := suite.CreateTestTx(privs, accNums, accSeqs, suite.ctx.ChainID())
|
|
require.NoError(t, err)
|
|
|
|
sud := ante.NewSetUpContextDecorator()
|
|
antehandler := sdk.ChainAnteDecorators(sud)
|
|
|
|
// Set height to non-zero value for GasMeter to be set
|
|
suite.ctx = suite.ctx.WithBlockHeight(1).WithGasMeter(sdk.NewGasMeter(0))
|
|
|
|
// Context GasMeter Limit not set
|
|
require.Equal(t, uint64(0), suite.ctx.GasMeter().Limit(), "GasMeter set with limit before setup")
|
|
|
|
newCtx, err := antehandler(suite.ctx, tx, false)
|
|
require.Nil(t, err, "SetUpContextDecorator returned error")
|
|
|
|
// Context GasMeter Limit should be set after SetUpContextDecorator runs
|
|
require.Equal(t, gasLimit, newCtx.GasMeter().Limit(), "GasMeter not set correctly")
|
|
}
|
|
|
|
func TestRecoverPanic(t *testing.T) {
|
|
suite := SetupTestSuite(t, true)
|
|
suite.txBuilder = suite.clientCtx.TxConfig.NewTxBuilder()
|
|
|
|
// keys and addresses
|
|
priv1, _, addr1 := testdata.KeyTestPubAddr()
|
|
|
|
// msg and signatures
|
|
msg := testdata.NewTestMsg(addr1)
|
|
feeAmount := testdata.NewTestFeeAmount()
|
|
gasLimit := testdata.NewTestGasLimit()
|
|
require.NoError(t, suite.txBuilder.SetMsgs(msg))
|
|
suite.txBuilder.SetFeeAmount(feeAmount)
|
|
suite.txBuilder.SetGasLimit(gasLimit)
|
|
|
|
privs, accNums, accSeqs := []cryptotypes.PrivKey{priv1}, []uint64{0}, []uint64{0}
|
|
tx, err := suite.CreateTestTx(privs, accNums, accSeqs, suite.ctx.ChainID())
|
|
require.NoError(t, err)
|
|
|
|
sud := ante.NewSetUpContextDecorator()
|
|
antehandler := sdk.ChainAnteDecorators(sud, OutOfGasDecorator{})
|
|
|
|
// Set height to non-zero value for GasMeter to be set
|
|
suite.ctx = suite.ctx.WithBlockHeight(1)
|
|
|
|
newCtx, err := antehandler(suite.ctx, tx, false)
|
|
|
|
require.NotNil(t, err, "Did not return error on OutOfGas panic")
|
|
|
|
require.True(t, sdkerrors.ErrOutOfGas.Is(err), "Returned error is not an out of gas error")
|
|
require.Equal(t, gasLimit, newCtx.GasMeter().Limit())
|
|
|
|
antehandler = sdk.ChainAnteDecorators(sud, PanicDecorator{})
|
|
require.Panics(t, func() { antehandler(suite.ctx, tx, false) }, "Recovered from non-Out-of-Gas panic") // nolint:errcheck
|
|
}
|
|
|
|
type OutOfGasDecorator struct{}
|
|
|
|
// AnteDecorator that will throw OutOfGas panic
|
|
func (ogd OutOfGasDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error) {
|
|
overLimit := ctx.GasMeter().Limit() + 1
|
|
|
|
// Should panic with outofgas error
|
|
ctx.GasMeter().ConsumeGas(overLimit, "test panic")
|
|
|
|
// not reached
|
|
return next(ctx, tx, simulate)
|
|
}
|
|
|
|
type PanicDecorator struct{}
|
|
|
|
func (pd PanicDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
|
|
panic("random error")
|
|
}
|