fix(codec): MarshalInterface should err when UnmarshalInterface will fail (#12964)
## Description Closes: #12894 --- ### 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 - [ ] 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 - [ ] 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 - [x] 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:
@@ -3,6 +3,7 @@ package codec_test
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"github.com/gogo/protobuf/proto"
|
||||
@@ -46,6 +47,70 @@ func (lpm *lyingProtoMarshaler) Size() int {
|
||||
return lpm.falseSize
|
||||
}
|
||||
|
||||
func TestEnsureRegistered(t *testing.T) {
|
||||
interfaceRegistry := types.NewInterfaceRegistry()
|
||||
cat := &testdata.Cat{Moniker: "Garfield"}
|
||||
|
||||
err := interfaceRegistry.EnsureRegistered(*cat)
|
||||
require.ErrorContains(t, err, "testdata.Cat is not a pointer")
|
||||
|
||||
err = interfaceRegistry.EnsureRegistered(cat)
|
||||
require.ErrorContains(t, err, "testdata.Cat does not have a registered interface")
|
||||
|
||||
interfaceRegistry.RegisterInterface("testdata.Animal",
|
||||
(*testdata.Animal)(nil),
|
||||
&testdata.Cat{},
|
||||
)
|
||||
|
||||
require.NoError(t, interfaceRegistry.EnsureRegistered(cat))
|
||||
}
|
||||
|
||||
func TestProtoCodecMarshal(t *testing.T) {
|
||||
interfaceRegistry := types.NewInterfaceRegistry()
|
||||
interfaceRegistry.RegisterInterface("testdata.Animal",
|
||||
(*testdata.Animal)(nil),
|
||||
&testdata.Cat{},
|
||||
)
|
||||
cdc := codec.NewProtoCodec(interfaceRegistry)
|
||||
|
||||
cartonRegistry := types.NewInterfaceRegistry()
|
||||
cartonRegistry.RegisterInterface("testdata.Cartoon",
|
||||
(*testdata.Cartoon)(nil),
|
||||
&testdata.Bird{},
|
||||
)
|
||||
cartoonCdc := codec.NewProtoCodec(cartonRegistry)
|
||||
|
||||
cat := &testdata.Cat{Moniker: "Garfield", Lives: 6}
|
||||
bird := &testdata.Bird{Species: "Passerina ciris"}
|
||||
require.NoError(t, interfaceRegistry.EnsureRegistered(cat))
|
||||
|
||||
var (
|
||||
animal testdata.Animal
|
||||
cartoon testdata.Cartoon
|
||||
)
|
||||
|
||||
// sanity check
|
||||
require.True(t, reflect.TypeOf(cat).Implements(reflect.TypeOf((*testdata.Animal)(nil)).Elem()))
|
||||
|
||||
bz, err := cdc.MarshalInterface(cat)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = cdc.UnmarshalInterface(bz, &animal)
|
||||
require.NoError(t, err)
|
||||
|
||||
bz, err = cdc.MarshalInterface(bird)
|
||||
require.ErrorContains(t, err, "does not have a registered interface")
|
||||
|
||||
bz, err = cartoonCdc.MarshalInterface(bird)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = cdc.UnmarshalInterface(bz, &cartoon)
|
||||
require.ErrorContains(t, err, "no registered implementations")
|
||||
|
||||
err = cartoonCdc.UnmarshalInterface(bz, &cartoon)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
func TestProtoCodecUnmarshalLengthPrefixedChecks(t *testing.T) {
|
||||
cdc := codec.NewProtoCodec(createTestInterfaceRegistry())
|
||||
|
||||
|
||||
Reference in New Issue
Block a user