mirror of
https://github.com/protocolbuffers/protobuf-go.git
synced 2025-01-01 11:58:21 +00:00
74b1460c5b
The Format function and MarshalOptions.Format method are helper
functions for directly obtaining the formatted string for a message
without having to deal with errors or convert a []byte to string.
It is only intended for human consumption (e.g., debugging or logging).
We also add a MarshalOptions.Multiline option to specify that the output
should use some default indentation in a multiline output.
This assists in the v1 to v2 migration where:
protoV1.CompactTextString(m) => prototext.MarshalOptions{}.Format(m)
protoV1.MarshalTextString(m) => prototext.Format(m)
At Google, there are approximately 10x more usages of MarshalTextString than
CompactTextString, so it makes sense that the top-level Format function
does multiline expansion by default.
Fixes #850
Change-Id: I149c9e190a6d99b985d3884df675499a3313e9b3
Reviewed-on: https://go-review.googlesource.com/c/protobuf/+/213460
Reviewed-by: Damien Neil <dneil@google.com>
Reviewed-by: Herbie Ong <herbie@google.com>
90 lines
2.1 KiB
Go
90 lines
2.1 KiB
Go
// Copyright 2019 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style.
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package proto_test
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
"testing"
|
|
|
|
"google.golang.org/protobuf/encoding/prototext"
|
|
"google.golang.org/protobuf/internal/flags"
|
|
"google.golang.org/protobuf/proto"
|
|
|
|
testpb "google.golang.org/protobuf/internal/testprotos/test"
|
|
weakpb "google.golang.org/protobuf/internal/testprotos/test/weak1"
|
|
)
|
|
|
|
func TestIsInitializedErrors(t *testing.T) {
|
|
type test struct {
|
|
m proto.Message
|
|
want string
|
|
skip bool
|
|
}
|
|
tests := []test{{
|
|
m: &testpb.TestRequired{},
|
|
want: `goproto.proto.test.TestRequired.required_field`,
|
|
}, {
|
|
m: &testpb.TestRequiredForeign{
|
|
OptionalMessage: &testpb.TestRequired{},
|
|
},
|
|
want: `goproto.proto.test.TestRequired.required_field`,
|
|
}, {
|
|
m: &testpb.TestRequiredForeign{
|
|
RepeatedMessage: []*testpb.TestRequired{
|
|
{RequiredField: proto.Int32(1)},
|
|
{},
|
|
},
|
|
},
|
|
want: `goproto.proto.test.TestRequired.required_field`,
|
|
}, {
|
|
m: &testpb.TestRequiredForeign{
|
|
MapMessage: map[int32]*testpb.TestRequired{
|
|
1: {},
|
|
},
|
|
},
|
|
want: `goproto.proto.test.TestRequired.required_field`,
|
|
}, {
|
|
m: &testpb.TestWeak{},
|
|
want: `<nil>`,
|
|
skip: !flags.ProtoLegacy,
|
|
}, {
|
|
m: func() proto.Message {
|
|
m := &testpb.TestWeak{}
|
|
m.SetWeakMessage1(&weakpb.WeakImportMessage1{})
|
|
return m
|
|
}(),
|
|
want: `goproto.proto.test.weak.WeakImportMessage1.a`,
|
|
skip: !flags.ProtoLegacy,
|
|
}, {
|
|
m: func() proto.Message {
|
|
m := &testpb.TestWeak{}
|
|
m.SetWeakMessage1(&weakpb.WeakImportMessage1{
|
|
A: proto.Int32(1),
|
|
})
|
|
return m
|
|
}(),
|
|
want: `<nil>`,
|
|
skip: !flags.ProtoLegacy,
|
|
}}
|
|
|
|
for _, tt := range tests {
|
|
t.Run("", func(t *testing.T) {
|
|
if tt.skip {
|
|
t.SkipNow()
|
|
}
|
|
|
|
err := proto.IsInitialized(tt.m)
|
|
got := "<nil>"
|
|
if err != nil {
|
|
got = fmt.Sprintf("%q", err)
|
|
}
|
|
if !strings.Contains(got, tt.want) {
|
|
t.Errorf("IsInitialized(m):\n got: %v\nwant contains: %v\nMessage:\n%v", got, tt.want, prototext.Format(tt.m))
|
|
}
|
|
})
|
|
}
|
|
}
|