d9f3eb027d
## Description Refs: #11970 Changes target of `SIGN_MODE_TEXTUAL` rendering to be a structured datatype instead of lines of ASCII text. This avoids the complexities of in-band, signaling and allows more capable signing devices not to be hindered by the limitations of those less capable. --- ### 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 - [X] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed NOTE: changelog intentionally omitted - we'll add an entry when #11970 is complete. ### 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)
77 lines
2.2 KiB
Go
77 lines
2.2 KiB
Go
package valuerenderer_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"cosmossdk.io/tx/textual/valuerenderer"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"google.golang.org/protobuf/proto"
|
|
"google.golang.org/protobuf/reflect/protoreflect"
|
|
dur "google.golang.org/protobuf/types/known/durationpb"
|
|
tspb "google.golang.org/protobuf/types/known/timestamppb"
|
|
)
|
|
|
|
// timestampJsonTest is the type of test cases in the testdata file.
|
|
// If the test case has a Proto, try to Format() it. If Error is set, expect
|
|
// an error, otherwise match Text, then Parse() the text and expect it to
|
|
// match (via proto.Equals()) the original Proto. If the test case has no
|
|
// Proto, try to Parse() the Text and expect an error if Error is set.
|
|
//
|
|
// The Timestamp proto seconds field is int64, but restricted in range
|
|
// by convention and will fit within a JSON number.
|
|
type timestampJsonTest struct {
|
|
Proto *tspb.Timestamp
|
|
Error bool
|
|
Text string
|
|
}
|
|
|
|
func TestTimestampJsonTestcases(t *testing.T) {
|
|
raw, err := os.ReadFile("../internal/testdata/timestamp.json")
|
|
require.NoError(t, err)
|
|
|
|
var testcases []timestampJsonTest
|
|
err = json.Unmarshal(raw, &testcases)
|
|
require.NoError(t, err)
|
|
|
|
for i, tc := range testcases {
|
|
t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
|
|
rend := valuerenderer.NewTimestampValueRenderer()
|
|
|
|
var screens []valuerenderer.Screen
|
|
if tc.Proto != nil {
|
|
screens, err = rend.Format(context.Background(), protoreflect.ValueOf(tc.Proto.ProtoReflect()))
|
|
if tc.Error {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
require.Equal(t, 1, len(screens))
|
|
require.Equal(t, tc.Text, screens[0].Text)
|
|
}
|
|
|
|
val, err := rend.Parse(context.Background(), screens)
|
|
if tc.Error {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
msg := val.Message().Interface()
|
|
require.IsType(t, &tspb.Timestamp{}, msg)
|
|
timestamp := msg.(*tspb.Timestamp)
|
|
require.True(t, proto.Equal(timestamp, tc.Proto))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestTimestampBadFormat(t *testing.T) {
|
|
rend := valuerenderer.NewTimestampValueRenderer()
|
|
_, err := rend.Format(context.Background(), protoreflect.ValueOf(dur.New(time.Hour).ProtoReflect()))
|
|
require.Error(t, err)
|
|
}
|