301 lines
8.6 KiB
Go
301 lines
8.6 KiB
Go
|
// Go support for Protocol Buffers - Google's data interchange format
|
||
|
|
//
|
||
|
|
// Copyright 2016 The Go Authors. All rights reserved.
|
||
|
|
// https://github.com/golang/protobuf
|
||
|
|
//
|
||
|
|
// Redistribution and use in source and binary forms, with or without
|
||
|
|
// modification, are permitted provided that the following conditions are
|
||
|
|
// met:
|
||
|
|
//
|
||
|
|
// * Redistributions of source code must retain the above copyright
|
||
|
|
// notice, this list of conditions and the following disclaimer.
|
||
|
|
// * Redistributions in binary form must reproduce the above
|
||
|
|
// copyright notice, this list of conditions and the following disclaimer
|
||
|
|
// in the documentation and/or other materials provided with the
|
||
|
|
// distribution.
|
||
|
|
// * Neither the name of Google Inc. nor the names of its
|
||
|
|
// contributors may be used to endorse or promote products derived from
|
||
|
|
// this software without specific prior written permission.
|
||
|
|
//
|
||
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
|
||
|
|
package proto_test
|
||
|
|
|
||
|
|
import (
|
||
|
|
"strings"
|
||
|
|
"testing"
|
||
|
|
|
||
|
|
"github.com/golang/protobuf/proto"
|
||
|
|
|
||
|
|
pb "github.com/golang/protobuf/proto/proto3_proto"
|
||
|
|
testpb "github.com/golang/protobuf/proto/testdata"
|
||
|
|
anypb "github.com/golang/protobuf/ptypes/any"
|
||
|
|
)
|
||
|
|
|
||
|
|
var (
|
||
|
|
expandedMarshaler = proto.TextMarshaler{ExpandAny: true}
|
||
|
|
expandedCompactMarshaler = proto.TextMarshaler{Compact: true, ExpandAny: true}
|
||
|
|
)
|
||
|
|
|
||
|
|
// anyEqual reports whether two messages which may be google.protobuf.Any or may
|
||
|
|
// contain google.protobuf.Any fields are equal. We can't use proto.Equal for
|
||
|
|
// comparison, because semantically equivalent messages may be marshaled to
|
||
|
|
// binary in different tag order. Instead, trust that TextMarshaler with
|
||
|
|
// ExpandAny option works and compare the text marshaling results.
|
||
|
|
func anyEqual(got, want proto.Message) bool {
|
||
|
|
// if messages are proto.Equal, no need to marshal.
|
||
|
|
if proto.Equal(got, want) {
|
||
|
|
return true
|
||
|
|
}
|
||
|
|
g := expandedMarshaler.Text(got)
|
||
|
|
w := expandedMarshaler.Text(want)
|
||
|
|
return g == w
|
||
|
|
}
|
||
|
|
|
||
|
|
type golden struct {
|
||
|
|
m proto.Message
|
||
|
|
t, c string
|
||
|
|
}
|
||
|
|
|
||
|
|
var goldenMessages = makeGolden()
|
||
|
|
|
||
|
|
func makeGolden() []golden {
|
||
|
|
nested := &pb.Nested{Bunny: "Monty"}
|
||
|
|
nb, err := proto.Marshal(nested)
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
m1 := &pb.Message{
|
||
|
|
Name: "David",
|
||
|
|
ResultCount: 47,
|
||
|
|
Anything: &anypb.Any{TypeUrl: "type.googleapis.com/" + proto.MessageName(nested), Value: nb},
|
||
|
|
}
|
||
|
|
m2 := &pb.Message{
|
||
|
|
Name: "David",
|
||
|
|
ResultCount: 47,
|
||
|
|
Anything: &anypb.Any{TypeUrl: "http://[::1]/type.googleapis.com/" + proto.MessageName(nested), Value: nb},
|
||
|
|
}
|
||
|
|
m3 := &pb.Message{
|
||
|
|
Name: "David",
|
||
|
|
ResultCount: 47,
|
||
|
|
Anything: &anypb.Any{TypeUrl: `type.googleapis.com/"/` + proto.MessageName(nested), Value: nb},
|
||
|
|
}
|
||
|
|
m4 := &pb.Message{
|
||
|
|
Name: "David",
|
||
|
|
ResultCount: 47,
|
||
|
|
Anything: &anypb.Any{TypeUrl: "type.googleapis.com/a/path/" + proto.MessageName(nested), Value: nb},
|
||
|
|
}
|
||
|
|
m5 := &anypb.Any{TypeUrl: "type.googleapis.com/" + proto.MessageName(nested), Value: nb}
|
||
|
|
|
||
|
|
any1 := &testpb.MyMessage{Count: proto.Int32(47), Name: proto.String("David")}
|
||
|
|
proto.SetExtension(any1, testpb.E_Ext_More, &testpb.Ext{Data: proto.String("foo")})
|
||
|
|
proto.SetExtension(any1, testpb.E_Ext_Text, proto.String("bar"))
|
||
|
|
any1b, err := proto.Marshal(any1)
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
any2 := &testpb.MyMessage{Count: proto.Int32(42), Bikeshed: testpb.MyMessage_GREEN.Enum(), RepBytes: [][]byte{[]byte("roboto")}}
|
||
|
|
proto.SetExtension(any2, testpb.E_Ext_More, &testpb.Ext{Data: proto.String("baz")})
|
||
|
|
any2b, err := proto.Marshal(any2)
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
m6 := &pb.Message{
|
||
|
|
Name: "David",
|
||
|
|
ResultCount: 47,
|
||
|
|
Anything: &anypb.Any{TypeUrl: "type.googleapis.com/" + proto.MessageName(any1), Value: any1b},
|
||
|
|
ManyThings: []*anypb.Any{
|
||
|
|
&anypb.Any{TypeUrl: "type.googleapis.com/" + proto.MessageName(any2), Value: any2b},
|
||
|
|
&anypb.Any{TypeUrl: "type.googleapis.com/" + proto.MessageName(any1), Value: any1b},
|
||
|
|
},
|
||
|
|
}
|
||
|
|
|
||
|
|
const (
|
||
|
|
m1Golden = `
|
||
|
|
name: "David"
|
||
|
|
result_count: 47
|
||
|
|
anything: <
|
||
|
|
[type.googleapis.com/proto3_proto.Nested]: <
|
||
|
|
bunny: "Monty"
|
||
|
|
>
|
||
|
|
>
|
||
|
|
`
|
||
|
|
m2Golden = `
|
||
|
|
name: "David"
|
||
|
|
result_count: 47
|
||
|
|
anything: <
|
||
|
|
["http://[::1]/type.googleapis.com/proto3_proto.Nested"]: <
|
||
|
|
bunny: "Monty"
|
||
|
|
>
|
||
|
|
>
|
||
|
|
`
|
||
|
|
m3Golden = `
|
||
|
|
name: "David"
|
||
|
|
result_count: 47
|
||
|
|
anything: <
|
||
|
|
["type.googleapis.com/\"/proto3_proto.Nested"]: <
|
||
|
|
bunny: "Monty"
|
||
|
|
>
|
||
|
|
>
|
||
|
|
`
|
||
|
|
m4Golden = `
|
||
|
|
name: "David"
|
||
|
|
result_count: 47
|
||
|
|
anything: <
|
||
|
|
[type.googleapis.com/a/path/proto3_proto.Nested]: <
|
||
|
|
bunny: "Monty"
|
||
|
|
>
|
||
|
|
>
|
||
|
|
`
|
||
|
|
m5Golden = `
|
||
|
|
[type.googleapis.com/proto3_proto.Nested]: <
|
||
|
|
bunny: "Monty"
|
||
|
|
>
|
||
|
|
`
|
||
|
|
m6Golden = `
|
||
|
|
name: "David"
|
||
|
|
result_count: 47
|
||
|
|
anything: <
|
||
|
|
[type.googleapis.com/testdata.MyMessage]: <
|
||
|
|
count: 47
|
||
|
|
name: "David"
|
||
|
|
[testdata.Ext.more]: <
|
||
|
|
data: "foo"
|
||
|
|
>
|
||
|
|
[testdata.Ext.text]: "bar"
|
||
|
|
>
|
||
|
|
>
|
||
|
|
many_things: <
|
||
|
|
[type.googleapis.com/testdata.MyMessage]: <
|
||
|
|
count: 42
|
||
|
|
bikeshed: GREEN
|
||
|
|
rep_bytes: "roboto"
|
||
|
|
[testdata.Ext.more]: <
|
||
|
|
data: "baz"
|
||
|
|
>
|
||
|
|
>
|
||
|
|
>
|
||
|
|
many_things: <
|
||
|
|
[type.googleapis.com/testdata.MyMessage]: <
|
||
|
|
count: 47
|
||
|
|
name: "David"
|
||
|
|
[testdata.Ext.more]: <
|
||
|
|
data: "foo"
|
||
|
|
>
|
||
|
|
[testdata.Ext.text]: "bar"
|
||
|
|
>
|
||
|
|
>
|
||
|
|
`
|
||
|
|
)
|
||
|
|
return []golden{
|
||
|
|
{m1, strings.TrimSpace(m1Golden) + "\n", strings.TrimSpace(compact(m1Golden)) + " "},
|
||
|
|
{m2, strings.TrimSpace(m2Golden) + "\n", strings.TrimSpace(compact(m2Golden)) + " "},
|
||
|
|
{m3, strings.TrimSpace(m3Golden) + "\n", strings.TrimSpace(compact(m3Golden)) + " "},
|
||
|
|
{m4, strings.TrimSpace(m4Golden) + "\n", strings.TrimSpace(compact(m4Golden)) + " "},
|
||
|
|
{m5, strings.TrimSpace(m5Golden) + "\n", strings.TrimSpace(compact(m5Golden)) + " "},
|
||
|
|
{m6, strings.TrimSpace(m6Golden) + "\n", strings.TrimSpace(compact(m6Golden)) + " "},
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestMarshalGolden(t *testing.T) {
|
||
|
|
for _, tt := range goldenMessages {
|
||
|
|
if got, want := expandedMarshaler.Text(tt.m), tt.t; got != want {
|
||
|
|
t.Errorf("message %v: got:\n%s\nwant:\n%s", tt.m, got, want)
|
||
|
|
}
|
||
|
|
if got, want := expandedCompactMarshaler.Text(tt.m), tt.c; got != want {
|
||
|
|
t.Errorf("message %v: got:\n`%s`\nwant:\n`%s`", tt.m, got, want)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestUnmarshalGolden(t *testing.T) {
|
||
|
|
for _, tt := range goldenMessages {
|
||
|
|
want := tt.m
|
||
|
|
got := proto.Clone(tt.m)
|
||
|
|
got.Reset()
|
||
|
|
if err := proto.UnmarshalText(tt.t, got); err != nil {
|
||
|
|
t.Errorf("failed to unmarshal\n%s\nerror: %v", tt.t, err)
|
||
|
|
}
|
||
|
|
if !anyEqual(got, want) {
|
||
|
|
t.Errorf("message:\n%s\ngot:\n%s\nwant:\n%s", tt.t, got, want)
|
||
|
|
}
|
||
|
|
got.Reset()
|
||
|
|
if err := proto.UnmarshalText(tt.c, got); err != nil {
|
||
|
|
t.Errorf("failed to unmarshal\n%s\nerror: %v", tt.c, err)
|
||
|
|
}
|
||
|
|
if !anyEqual(got, want) {
|
||
|
|
t.Errorf("message:\n%s\ngot:\n%s\nwant:\n%s", tt.c, got, want)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestMarshalUnknownAny(t *testing.T) {
|
||
|
|
m := &pb.Message{
|
||
|
|
Anything: &anypb.Any{
|
||
|
|
TypeUrl: "foo",
|
||
|
|
Value: []byte("bar"),
|
||
|
|
},
|
||
|
|
}
|
||
|
|
want := `anything: <
|
||
|
|
type_url: "foo"
|
||
|
|
value: "bar"
|
||
|
|
>
|
||
|
|
`
|
||
|
|
got := expandedMarshaler.Text(m)
|
||
|
|
if got != want {
|
||
|
|
t.Errorf("got\n`%s`\nwant\n`%s`", got, want)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestAmbiguousAny(t *testing.T) {
|
||
|
|
pb := &anypb.Any{}
|
||
|
|
err := proto.UnmarshalText(`
|
||
|
|
type_url: "ttt/proto3_proto.Nested"
|
||
|
|
value: "\n\x05Monty"
|
||
|
|
`, pb)
|
||
|
|
t.Logf("result: %v (error: %v)", expandedMarshaler.Text(pb), err)
|
||
|
|
if err != nil {
|
||
|
|
t.Errorf("failed to parse ambiguous Any message: %v", err)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestUnmarshalOverwriteAny(t *testing.T) {
|
||
|
|
pb := &anypb.Any{}
|
||
|
|
err := proto.UnmarshalText(`
|
||
|
|
[type.googleapis.com/a/path/proto3_proto.Nested]: <
|
||
|
|
bunny: "Monty"
|
||
|
|
>
|
||
|
|
[type.googleapis.com/a/path/proto3_proto.Nested]: <
|
||
|
|
bunny: "Rabbit of Caerbannog"
|
||
|
|
>
|
||
|
|
`, pb)
|
||
|
|
want := `line 7: Any message unpacked multiple times, or "type_url" already set`
|
||
|
|
if err.Error() != want {
|
||
|
|
t.Errorf("incorrect error.\nHave: %v\nWant: %v", err.Error(), want)
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
func TestUnmarshalAnyMixAndMatch(t *testing.T) {
|
||
|
|
pb := &anypb.Any{}
|
||
|
|
err := proto.UnmarshalText(`
|
||
|
|
value: "\n\x05Monty"
|
||
|
|
[type.googleapis.com/a/path/proto3_proto.Nested]: <
|
||
|
|
bunny: "Rabbit of Caerbannog"
|
||
|
|
>
|
||
|
|
`, pb)
|
||
|
|
want := `line 5: Any message unpacked multiple times, or "value" already set`
|
||
|
|
if err.Error() != want {
|
||
|
|
t.Errorf("incorrect error.\nHave: %v\nWant: %v", err.Error(), want)
|
||
|
|
}
|
||
|
|
}
|