test(types/tx/msgs.go): add unit tests #20199
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| package tx_test | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| "github.com/cosmos/cosmos-sdk/codec/types" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/types/tx" | ||
| ) | ||
|
|
||
| func Test_SetMsg(t *testing.T) { | ||
| cases := map[string]struct { | ||
| msg sdk.Msg | ||
| msgTypeURL string | ||
| expErr bool | ||
| }{ | ||
| "Set nil Msg": { | ||
| msg: nil, | ||
| expErr: true, | ||
| }, | ||
| "Set empty message": { | ||
| msg: &DummyProtoMessage1{}, | ||
| msgTypeURL: "/dummy.proto.message1", | ||
| expErr: false, | ||
| }, | ||
| "Set a valid message": { | ||
| msg: &DummyProtoMessage1{Name: "some-name"}, | ||
| msgTypeURL: "/dummy.proto.message1", | ||
| expErr: false, | ||
| }, | ||
| } | ||
|
|
||
| for name, tc := range cases { | ||
| t.Run(name, func(t *testing.T) { | ||
| actual, err := tx.SetMsg(tc.msg) | ||
| if tc.expErr { | ||
| require.Error(t, err) | ||
| return | ||
| } | ||
| require.NoError(t, err) | ||
|
|
||
| b, err := json.Marshal(tc.msg) | ||
| require.NoError(t, err) | ||
|
|
||
| require.Equal(t, tc.msgTypeURL, actual.TypeUrl) | ||
| require.Equal(t, b, actual.GetValue()) | ||
| require.Equal(t, tc.msg, actual.GetCachedValue()) | ||
| }) | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. I find the map type easier to read and you can get rid of the name field. For example: specs := map[string]struct{
msg sdk.Msg
expErr bool
}{
"Set nil Msg": {
msg: nil,
expErr: true,
},
}
for name, spec := range specs {
t.Run(name, func(t *testing.T) {
})
}There was a problem hiding this comment. Thanks for the comment. I really like how it looks with a map. I will start using map[string]struct{} instead struct{}. Fixed |
||
|
|
||
| func Test_SetMsgs(t *testing.T) { | ||
| cases := map[string]struct { | ||
| msgs []sdk.Msg | ||
| msgTypeURL []string | ||
| expErr bool | ||
| }{ | ||
| "Set nil slice of messages": { | ||
| msgs: nil, | ||
| expErr: false, | ||
| }, | ||
| "Set empty slice of messages": { | ||
| msgs: []sdk.Msg{}, | ||
| expErr: false, | ||
| }, | ||
| "Set nil message inside the slice of messages": { | ||
| msgs: []sdk.Msg{nil}, | ||
| expErr: true, | ||
| }, | ||
| "Set valid messages": { | ||
| msgs: []sdk.Msg{&DummyProtoMessage1{Name: "name1"}, &DummyProtoMessage2{}}, | ||
| msgTypeURL: []string{"/dummy.proto.message1", "/dummy.proto.message2"}, | ||
| expErr: false, | ||
| }, | ||
| } | ||
|
|
||
| for name, tc := range cases { | ||
| t.Run(name, func(t *testing.T) { | ||
| actual, err := tx.SetMsgs(tc.msgs) | ||
| if tc.expErr { | ||
| require.Error(t, err) | ||
| return | ||
| } | ||
| require.NoError(t, err) | ||
| require.Equal(t, len(tc.msgs), len(actual)) | ||
|
|
||
| for i, msg := range tc.msgs { | ||
| b, err := json.Marshal(msg) | ||
| require.NoError(t, err) | ||
|
|
||
| require.Equal(t, msg, actual[i].GetCachedValue()) | ||
| require.Equal(t, tc.msgTypeURL[i], actual[i].GetTypeUrl()) | ||
| require.Equal(t, b, actual[i].GetValue()) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func Test_GetMsgs(t *testing.T) { | ||
| sdkMsgs := []sdk.Msg{&DummyProtoMessage1{}, &DummyProtoMessage2{}} | ||
| anyMsg, err := tx.SetMsgs(sdkMsgs) | ||
| require.NoError(t, err) | ||
|
|
||
| cases := map[string]struct { | ||
| msgs []*types.Any | ||
| expected []sdk.Msg | ||
| expErr bool | ||
| }{ | ||
| "GetMsgs from a nil slice of Any messages": { | ||
| msgs: nil, | ||
| expected: []sdk.Msg{}, | ||
| expErr: false, | ||
| }, | ||
| "GetMsgs from empty slice of Any messages": { | ||
| msgs: []*types.Any{}, | ||
| expected: []sdk.Msg{}, | ||
| expErr: false, | ||
| }, | ||
| "GetMsgs from a slice with valid Any messages": { | ||
| msgs: anyMsg, | ||
| expected: sdkMsgs, | ||
| expErr: false, | ||
| }, | ||
| "GetMsgs from a slice that contains uncached Any message": { | ||
| msgs: []*types.Any{{}}, | ||
| expErr: true, | ||
| }, | ||
| } | ||
|
|
||
| for name, tc := range cases { | ||
| t.Run(name, func(t *testing.T) { | ||
| actual, err := tx.GetMsgs(tc.msgs, "dummy") | ||
| if tc.expErr { | ||
| require.Error(t, err) | ||
| return | ||
| } | ||
|
|
||
| require.NoError(t, err) | ||
| require.Equal(t, tc.expected, actual) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestTx_UnpackInterfaces(t *testing.T) { | ||
| unpacker := codec.NewProtoCodec(types.NewInterfaceRegistry()) | ||
| sdkMsgs := []sdk.Msg{&DummyProtoMessage1{}, &DummyProtoMessage2{}} | ||
| anyMsg, err := tx.SetMsgs(sdkMsgs) | ||
| require.NoError(t, err) | ||
|
|
||
| cases := map[string]struct { | ||
| msgs []*types.Any | ||
| expErr bool | ||
| }{ | ||
| "Unpack nil slice messages": { | ||
| msgs: nil, | ||
| expErr: false, | ||
| }, | ||
| "Unpack empty slice of messages": { | ||
| msgs: []*types.Any{}, | ||
| expErr: false, | ||
| }, | ||
| "Unpack valid messages": { | ||
| msgs: anyMsg, | ||
| expErr: false, | ||
| }, | ||
| "Unpack uncashed message": { | ||
| msgs: []*types.Any{{TypeUrl: "uncached"}}, | ||
| expErr: true, | ||
| }, | ||
| } | ||
|
|
||
| for name, tc := range cases { | ||
| t.Run(name, func(t *testing.T) { | ||
| err = tx.UnpackInterfaces(unpacker, tc.msgs) | ||
| require.Equal(t, tc.expErr, err != nil) | ||
| }) | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why this? Unless you have to avoid cicular dependencies or want to call from the "outside", the _test package mostly just adds complexity, IMHO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this practice because it improving package design since using the _test package forces you to test the package as if you are an external user, it encourages you to think more carefully about the design of your package’s API. You'll need to ensure that all necessary functionality is properly exposed through exported types and functions, which can lead to better, more user-friendly design. If you have problems with testing and using package probably the clients of the package will have the same problems.