feat(errors): support grpc codes (#11274)
## Description Follow-up to https://github.com/cosmos/cosmos-sdk/pull/11113#pullrequestreview-872963572. This PR also makes `New` an alias of `Register` as some packages are using `New` as if it were `Register` but are not actually registering their error codes. --- ### 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... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] 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) - [ ] 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)
This commit is contained in:
+17
-3
@@ -5,6 +5,10 @@ import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
grpcstatus "google.golang.org/grpc/status"
|
||||
|
||||
"google.golang.org/grpc/codes"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"github.com/stretchr/testify/suite"
|
||||
)
|
||||
@@ -206,6 +210,16 @@ func (s *errorsTestSuite) TestABCIError() {
|
||||
s.Require().Equal("custom: unknown", ABCIError("unknown", 1, "custom").Error())
|
||||
}
|
||||
|
||||
func (s *errorsTestSuite) TestGRPCStatus() {
|
||||
s.Require().Equal(codes.Unknown, grpcstatus.Code(errInternal))
|
||||
s.Require().Equal(codes.NotFound, grpcstatus.Code(ErrNotFound))
|
||||
s.Require().Equal(codes.Unimplemented, grpcstatus.Code(ErrNotSupported))
|
||||
s.Require().Equal(codes.FailedPrecondition, grpcstatus.Code(ErrConflict))
|
||||
status, ok := grpcstatus.FromError(ErrNotFound)
|
||||
s.Require().True(ok)
|
||||
s.Require().Equal("codespace testtesttest code 38: not found", status.Message())
|
||||
}
|
||||
|
||||
func ExampleWrap() {
|
||||
err1 := Wrap(ErrInsufficientFunds, "90 is smaller than 100")
|
||||
err2 := errors.Wrap(ErrInsufficientFunds, "90 is smaller than 100")
|
||||
@@ -254,8 +268,8 @@ var (
|
||||
ErrUnknownExtensionOptions = Register(testCodespace, 31, "unknown extension options")
|
||||
ErrPackAny = Register(testCodespace, 33, "failed packing protobuf message to Any")
|
||||
ErrLogic = Register(testCodespace, 35, "internal logic error")
|
||||
ErrConflict = Register(testCodespace, 36, "conflict")
|
||||
ErrNotSupported = Register(testCodespace, 37, "feature not supported")
|
||||
ErrNotFound = Register(testCodespace, 38, "not found")
|
||||
ErrConflict = RegisterWithGRPCCode(testCodespace, 36, codes.FailedPrecondition, "conflict")
|
||||
ErrNotSupported = RegisterWithGRPCCode(testCodespace, 37, codes.Unimplemented, "feature not supported")
|
||||
ErrNotFound = RegisterWithGRPCCode(testCodespace, 38, codes.NotFound, "not found")
|
||||
ErrIO = Register(testCodespace, 39, "Internal IO error")
|
||||
)
|
||||
|
||||
Reference in New Issue
Block a user