blob: 7a403a90da2008020b4c4875b81cd06759d5d7c7 [file] [log] [blame]
Damien Neil5ec58b92019-04-30 11:36:39 -07001// Copyright 2019 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
5// Package prototest exercises protobuf reflection.
6package prototest
7
8import (
9 "bytes"
10 "fmt"
11 "math"
Joe Tsaib7695fa2020-01-04 09:09:04 -080012 "reflect"
Damien Neil5ec58b92019-04-30 11:36:39 -070013 "sort"
14 "testing"
15
Damien Neild91246e2019-06-21 08:36:26 -070016 "google.golang.org/protobuf/encoding/prototext"
17 "google.golang.org/protobuf/internal/encoding/wire"
Damien Neile89e6242019-05-13 23:55:40 -070018 "google.golang.org/protobuf/proto"
19 pref "google.golang.org/protobuf/reflect/protoreflect"
Damien Neild91246e2019-06-21 08:36:26 -070020 preg "google.golang.org/protobuf/reflect/protoregistry"
Damien Neil5ec58b92019-04-30 11:36:39 -070021)
22
Joe Tsai378c1322019-04-25 23:48:08 -070023// TODO: Test invalid field descriptors or oneof descriptors.
24// TODO: This should test the functionality that can be provided by fast-paths.
Damien Neil5ec58b92019-04-30 11:36:39 -070025
Damien Neild91246e2019-06-21 08:36:26 -070026// MessageOptions configure message tests.
27type MessageOptions struct {
28 // ExtensionTypes is a list of types to test with.
29 //
30 // If nil, TestMessage will look for extension types in the global registry.
31 ExtensionTypes []pref.ExtensionType
Damien Neil290ceea2019-07-15 13:39:43 -070032
33 // Resolver is used for looking up types when unmarshaling extension fields.
34 // If nil, this defaults to using protoregistry.GlobalTypes.
35 Resolver interface {
36 preg.ExtensionTypeResolver
37 }
Damien Neild91246e2019-06-21 08:36:26 -070038}
39
Joe Tsai378c1322019-04-25 23:48:08 -070040// TestMessage runs the provided m through a series of tests
41// exercising the protobuf reflection API.
Damien Neild91246e2019-06-21 08:36:26 -070042func TestMessage(t testing.TB, m proto.Message, opts MessageOptions) {
Joe Tsaib7695fa2020-01-04 09:09:04 -080043 testType(t, m)
44
Joe Tsai378c1322019-04-25 23:48:08 -070045 md := m.ProtoReflect().Descriptor()
46 m1 := m.ProtoReflect().New()
Damien Neil5ec58b92019-04-30 11:36:39 -070047 for i := 0; i < md.Fields().Len(); i++ {
48 fd := md.Fields().Get(i)
Joe Tsai378c1322019-04-25 23:48:08 -070049 testField(t, m1, fd)
Damien Neil5ec58b92019-04-30 11:36:39 -070050 }
Damien Neild91246e2019-06-21 08:36:26 -070051 if opts.ExtensionTypes == nil {
52 preg.GlobalTypes.RangeExtensionsByMessage(md.FullName(), func(e pref.ExtensionType) bool {
53 opts.ExtensionTypes = append(opts.ExtensionTypes, e)
54 return true
55 })
56 }
57 for _, xt := range opts.ExtensionTypes {
Damien Neil79bfdbe2019-08-28 11:08:22 -070058 testField(t, m1, xt.TypeDescriptor())
Damien Neild91246e2019-06-21 08:36:26 -070059 }
Damien Neil5ec58b92019-04-30 11:36:39 -070060 for i := 0; i < md.Oneofs().Len(); i++ {
Joe Tsai378c1322019-04-25 23:48:08 -070061 testOneof(t, m1, md.Oneofs().Get(i))
Damien Neil5ec58b92019-04-30 11:36:39 -070062 }
Damien Neild91246e2019-06-21 08:36:26 -070063 testUnknown(t, m1)
Damien Neil5ec58b92019-04-30 11:36:39 -070064
65 // Test round-trip marshal/unmarshal.
Joe Tsai378c1322019-04-25 23:48:08 -070066 m2 := m.ProtoReflect().New().Interface()
67 populateMessage(m2.ProtoReflect(), 1, nil)
Damien Neil290ceea2019-07-15 13:39:43 -070068 for _, xt := range opts.ExtensionTypes {
69 m2.ProtoReflect().Set(xt.TypeDescriptor(), newValue(m2.ProtoReflect(), xt.TypeDescriptor(), 1, nil))
70 }
71 b, err := proto.MarshalOptions{
72 AllowPartial: true,
73 }.Marshal(m2)
Damien Neil5ec58b92019-04-30 11:36:39 -070074 if err != nil {
Joe Tsai74b14602020-01-06 15:44:09 -080075 t.Errorf("Marshal() = %v, want nil\n%v", err, prototext.Format(m2))
Damien Neil5ec58b92019-04-30 11:36:39 -070076 }
Joe Tsai378c1322019-04-25 23:48:08 -070077 m3 := m.ProtoReflect().New().Interface()
Damien Neil290ceea2019-07-15 13:39:43 -070078 if err := (proto.UnmarshalOptions{
79 AllowPartial: true,
80 Resolver: opts.Resolver,
81 }.Unmarshal(b, m3)); err != nil {
Joe Tsai74b14602020-01-06 15:44:09 -080082 t.Errorf("Unmarshal() = %v, want nil\n%v", err, prototext.Format(m2))
Damien Neil5ec58b92019-04-30 11:36:39 -070083 }
Joe Tsai378c1322019-04-25 23:48:08 -070084 if !proto.Equal(m2, m3) {
Joe Tsai74b14602020-01-06 15:44:09 -080085 t.Errorf("round-trip marshal/unmarshal did not preserve message\nOriginal:\n%v\nNew:\n%v", prototext.Format(m2), prototext.Format(m3))
Damien Neil5ec58b92019-04-30 11:36:39 -070086 }
87}
88
Joe Tsaib7695fa2020-01-04 09:09:04 -080089func testType(t testing.TB, m proto.Message) {
90 want := reflect.TypeOf(m)
91 if got := reflect.TypeOf(m.ProtoReflect().Interface()); got != want {
92 t.Errorf("type mismatch: reflect.TypeOf(m) != reflect.TypeOf(m.ProtoReflect().Interface()): %v != %v", got, want)
93 }
94 if got := reflect.TypeOf(m.ProtoReflect().New().Interface()); got != want {
95 t.Errorf("type mismatch: reflect.TypeOf(m) != reflect.TypeOf(m.ProtoReflect().New().Interface()): %v != %v", got, want)
96 }
97 if got := reflect.TypeOf(m.ProtoReflect().Type().Zero().Interface()); got != want {
98 t.Errorf("type mismatch: reflect.TypeOf(m) != reflect.TypeOf(m.ProtoReflect().Type().Zero().Interface()): %v != %v", got, want)
99 }
100}
101
Joe Tsai378c1322019-04-25 23:48:08 -0700102// testField exercises set/get/has/clear of a field.
Damien Neil5ec58b92019-04-30 11:36:39 -0700103func testField(t testing.TB, m pref.Message, fd pref.FieldDescriptor) {
Damien Neil5ec58b92019-04-30 11:36:39 -0700104 name := fd.FullName()
Joe Tsai378c1322019-04-25 23:48:08 -0700105 num := fd.Number()
Damien Neil5ec58b92019-04-30 11:36:39 -0700106
Damien Neild91246e2019-06-21 08:36:26 -0700107 switch {
108 case fd.IsList():
109 testFieldList(t, m, fd)
110 case fd.IsMap():
111 testFieldMap(t, m, fd)
Damien Neilf5274512019-08-05 10:48:38 -0700112 case fd.Message() != nil:
113 default:
114 if got, want := m.NewField(fd), fd.Default(); !valueEqual(got, want) {
115 t.Errorf("Message.NewField(%v) = %v, want default value %v", name, formatValue(got), formatValue(want))
116 }
117 if fd.Kind() == pref.FloatKind || fd.Kind() == pref.DoubleKind {
118 testFieldFloat(t, m, fd)
119 }
Damien Neild91246e2019-06-21 08:36:26 -0700120 }
121
Damien Neil5ec58b92019-04-30 11:36:39 -0700122 // Set to a non-zero value, the zero value, different non-zero values.
123 for _, n := range []seed{1, 0, minVal, maxVal} {
124 v := newValue(m, fd, n, nil)
Joe Tsai378c1322019-04-25 23:48:08 -0700125 m.Set(fd, v)
Damien Neil5ec58b92019-04-30 11:36:39 -0700126 wantHas := true
127 if n == 0 {
128 if fd.Syntax() == pref.Proto3 && fd.Message() == nil {
129 wantHas = false
130 }
Damien Neild91246e2019-06-21 08:36:26 -0700131 if fd.IsExtension() {
132 wantHas = true
133 }
Damien Neila0a54b82019-11-01 15:18:36 -0700134 if fd.Cardinality() == pref.Repeated {
135 wantHas = false
136 }
Joe Tsaiac31a352019-05-13 14:32:56 -0700137 if fd.ContainingOneof() != nil {
Damien Neil5ec58b92019-04-30 11:36:39 -0700138 wantHas = true
139 }
140 }
Damien Neilf5274512019-08-05 10:48:38 -0700141 if fd.Syntax() == pref.Proto3 && fd.Cardinality() != pref.Repeated && fd.ContainingOneof() == nil && fd.Kind() == pref.EnumKind && v.Enum() == 0 {
142 wantHas = false
143 }
Joe Tsai378c1322019-04-25 23:48:08 -0700144 if got, want := m.Has(fd), wantHas; got != want {
145 t.Errorf("after setting %q to %v:\nMessage.Has(%v) = %v, want %v", name, formatValue(v), num, got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700146 }
Joe Tsai378c1322019-04-25 23:48:08 -0700147 if got, want := m.Get(fd), v; !valueEqual(got, want) {
148 t.Errorf("after setting %q:\nMessage.Get(%v) = %v, want %v", name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700149 }
Damien Neild91246e2019-06-21 08:36:26 -0700150 found := false
151 m.Range(func(d pref.FieldDescriptor, got pref.Value) bool {
152 if fd != d {
153 return true
154 }
155 found = true
156 if want := v; !valueEqual(got, want) {
157 t.Errorf("after setting %q:\nMessage.Range got value %v, want %v", name, formatValue(got), formatValue(want))
158 }
159 return true
160 })
161 if got, want := wantHas, found; got != want {
162 t.Errorf("after setting %q:\nMessageRange saw field: %v, want %v", name, got, want)
163 }
Damien Neil5ec58b92019-04-30 11:36:39 -0700164 }
165
Joe Tsai378c1322019-04-25 23:48:08 -0700166 m.Clear(fd)
167 if got, want := m.Has(fd), false; got != want {
168 t.Errorf("after clearing %q:\nMessage.Has(%v) = %v, want %v", name, num, got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700169 }
170 switch {
Joe Tsaiac31a352019-05-13 14:32:56 -0700171 case fd.IsList():
Joe Tsai378c1322019-04-25 23:48:08 -0700172 if got := m.Get(fd); got.List().Len() != 0 {
173 t.Errorf("after clearing %q:\nMessage.Get(%v) = %v, want empty list", name, num, formatValue(got))
Damien Neil5ec58b92019-04-30 11:36:39 -0700174 }
Joe Tsaiac31a352019-05-13 14:32:56 -0700175 case fd.IsMap():
Joe Tsai378c1322019-04-25 23:48:08 -0700176 if got := m.Get(fd); got.Map().Len() != 0 {
Damien Neil290ceea2019-07-15 13:39:43 -0700177 t.Errorf("after clearing %q:\nMessage.Get(%v) = %v, want empty map", name, num, formatValue(got))
Damien Neil5ec58b92019-04-30 11:36:39 -0700178 }
Joe Tsai378c1322019-04-25 23:48:08 -0700179 case fd.Message() == nil:
180 if got, want := m.Get(fd), fd.Default(); !valueEqual(got, want) {
181 t.Errorf("after clearing %q:\nMessage.Get(%v) = %v, want default %v", name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700182 }
183 }
Damien Neild91246e2019-06-21 08:36:26 -0700184
Damien Neil290ceea2019-07-15 13:39:43 -0700185 // Set to the default value.
186 switch {
187 case fd.IsList() || fd.IsMap():
Damien Neil9f1165c2019-11-26 13:31:38 -0800188 m.Set(fd, m.Mutable(fd))
Damien Neila0a54b82019-11-01 15:18:36 -0700189 if got, want := m.Has(fd), (fd.IsExtension() && fd.Cardinality() != pref.Repeated) || fd.ContainingOneof() != nil; got != want {
Damien Neil290ceea2019-07-15 13:39:43 -0700190 t.Errorf("after setting %q to default:\nMessage.Has(%v) = %v, want %v", name, num, got, want)
191 }
192 case fd.Message() == nil:
193 m.Set(fd, m.Get(fd))
194 if got, want := m.Get(fd), fd.Default(); !valueEqual(got, want) {
195 t.Errorf("after setting %q to default:\nMessage.Get(%v) = %v, want default %v", name, num, formatValue(got), formatValue(want))
196 }
197 }
198 m.Clear(fd)
199
Damien Neild91246e2019-06-21 08:36:26 -0700200 // Set to the wrong type.
Joe Tsai84177c92019-09-17 13:38:48 -0700201 v := pref.ValueOfString("")
Damien Neild91246e2019-06-21 08:36:26 -0700202 if fd.Kind() == pref.StringKind {
Joe Tsai84177c92019-09-17 13:38:48 -0700203 v = pref.ValueOfInt32(0)
Damien Neild91246e2019-06-21 08:36:26 -0700204 }
205 if !panics(func() {
206 m.Set(fd, v)
207 }) {
208 t.Errorf("setting %v to %T succeeds, want panic", name, v.Interface())
209 }
Damien Neil5ec58b92019-04-30 11:36:39 -0700210}
211
212// testFieldMap tests set/get/has/clear of entries in a map field.
213func testFieldMap(t testing.TB, m pref.Message, fd pref.FieldDescriptor) {
Damien Neil5ec58b92019-04-30 11:36:39 -0700214 name := fd.FullName()
Joe Tsai378c1322019-04-25 23:48:08 -0700215 num := fd.Number()
216
Damien Neilf5274512019-08-05 10:48:38 -0700217 // New values.
Joe Tsai378c1322019-04-25 23:48:08 -0700218 m.Clear(fd) // start with an empty map
Damien Neilf5274512019-08-05 10:48:38 -0700219 mapv := m.Get(fd).Map()
Damien Neil9f1165c2019-11-26 13:31:38 -0800220 if mapv.IsValid() {
221 t.Errorf("after clearing field: message.Get(%v).IsValid() = true, want false", name)
222 }
Damien Neilf5274512019-08-05 10:48:38 -0700223 if got, want := mapv.NewValue(), newMapValue(fd, mapv, 0, nil); !valueEqual(got, want) {
224 t.Errorf("message.Get(%v).NewValue() = %v, want %v", name, formatValue(got), formatValue(want))
225 }
Damien Neil9f1165c2019-11-26 13:31:38 -0800226 if !panics(func() {
227 m.Set(fd, pref.ValueOfMap(mapv))
228 }) {
229 t.Errorf("message.Set(%v, <invalid>) does not panic", name)
230 }
231 if !panics(func() {
232 mapv.Set(newMapKey(fd, 0), newMapValue(fd, mapv, 0, nil))
233 }) {
234 t.Errorf("message.Get(%v).Set(...) of invalid map does not panic", name)
235 }
Damien Neilf5274512019-08-05 10:48:38 -0700236 mapv = m.Mutable(fd).Map() // mutable map
Damien Neil9f1165c2019-11-26 13:31:38 -0800237 if !mapv.IsValid() {
238 t.Errorf("message.Mutable(%v).IsValid() = false, want true", name)
239 }
Damien Neilf5274512019-08-05 10:48:38 -0700240 if got, want := mapv.NewValue(), newMapValue(fd, mapv, 0, nil); !valueEqual(got, want) {
241 t.Errorf("message.Mutable(%v).NewValue() = %v, want %v", name, formatValue(got), formatValue(want))
242 }
Damien Neil5ec58b92019-04-30 11:36:39 -0700243
244 // Add values.
245 want := make(testMap)
246 for i, n := range []seed{1, 0, minVal, maxVal} {
Joe Tsai378c1322019-04-25 23:48:08 -0700247 if got, want := m.Has(fd), i > 0; got != want {
248 t.Errorf("after inserting %d elements to %q:\nMessage.Has(%v) = %v, want %v", i, name, num, got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700249 }
250
251 k := newMapKey(fd, n)
252 v := newMapValue(fd, mapv, n, nil)
253 mapv.Set(k, v)
254 want.Set(k, v)
Joe Tsai84177c92019-09-17 13:38:48 -0700255 if got, want := m.Get(fd), pref.ValueOfMap(want); !valueEqual(got, want) {
Joe Tsai378c1322019-04-25 23:48:08 -0700256 t.Errorf("after inserting %d elements to %q:\nMessage.Get(%v) = %v, want %v", i, name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700257 }
258 }
259
260 // Set values.
261 want.Range(func(k pref.MapKey, v pref.Value) bool {
262 nv := newMapValue(fd, mapv, 10, nil)
263 mapv.Set(k, nv)
264 want.Set(k, nv)
Joe Tsai84177c92019-09-17 13:38:48 -0700265 if got, want := m.Get(fd), pref.ValueOfMap(want); !valueEqual(got, want) {
Joe Tsai378c1322019-04-25 23:48:08 -0700266 t.Errorf("after setting element %v of %q:\nMessage.Get(%v) = %v, want %v", formatValue(k.Value()), name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700267 }
268 return true
269 })
270
271 // Clear values.
272 want.Range(func(k pref.MapKey, v pref.Value) bool {
273 mapv.Clear(k)
274 want.Clear(k)
Joe Tsai378c1322019-04-25 23:48:08 -0700275 if got, want := m.Has(fd), want.Len() > 0; got != want {
276 t.Errorf("after clearing elements of %q:\nMessage.Has(%v) = %v, want %v", name, num, got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700277 }
Joe Tsai84177c92019-09-17 13:38:48 -0700278 if got, want := m.Get(fd), pref.ValueOfMap(want); !valueEqual(got, want) {
Joe Tsai378c1322019-04-25 23:48:08 -0700279 t.Errorf("after clearing elements of %q:\nMessage.Get(%v) = %v, want %v", name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700280 }
281 return true
282 })
Damien Neil9f1165c2019-11-26 13:31:38 -0800283 if mapv := m.Get(fd).Map(); mapv.IsValid() {
284 t.Errorf("after clearing all elements: message.Get(%v).IsValid() = true, want false %v", name, formatValue(pref.ValueOfMap(mapv)))
285 }
Damien Neil5ec58b92019-04-30 11:36:39 -0700286
287 // Non-existent map keys.
288 missingKey := newMapKey(fd, 1)
289 if got, want := mapv.Has(missingKey), false; got != want {
Joe Tsai378c1322019-04-25 23:48:08 -0700290 t.Errorf("non-existent map key in %q: Map.Has(%v) = %v, want %v", name, formatValue(missingKey.Value()), got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700291 }
292 if got, want := mapv.Get(missingKey).IsValid(), false; got != want {
Joe Tsai378c1322019-04-25 23:48:08 -0700293 t.Errorf("non-existent map key in %q: Map.Get(%v).IsValid() = %v, want %v", name, formatValue(missingKey.Value()), got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700294 }
295 mapv.Clear(missingKey) // noop
296}
297
298type testMap map[interface{}]pref.Value
299
300func (m testMap) Get(k pref.MapKey) pref.Value { return m[k.Interface()] }
301func (m testMap) Set(k pref.MapKey, v pref.Value) { m[k.Interface()] = v }
302func (m testMap) Has(k pref.MapKey) bool { return m.Get(k).IsValid() }
303func (m testMap) Clear(k pref.MapKey) { delete(m, k.Interface()) }
304func (m testMap) Len() int { return len(m) }
Damien Neilf5274512019-08-05 10:48:38 -0700305func (m testMap) NewValue() pref.Value { panic("unimplemented") }
Damien Neil5ec58b92019-04-30 11:36:39 -0700306func (m testMap) Range(f func(pref.MapKey, pref.Value) bool) {
307 for k, v := range m {
308 if !f(pref.ValueOf(k).MapKey(), v) {
309 return
310 }
311 }
312}
Damien Neil82886da2019-11-26 13:27:24 -0800313func (m testMap) IsValid() bool { return true }
Damien Neil5ec58b92019-04-30 11:36:39 -0700314
315// testFieldList exercises set/get/append/truncate of values in a list.
316func testFieldList(t testing.TB, m pref.Message, fd pref.FieldDescriptor) {
Damien Neil5ec58b92019-04-30 11:36:39 -0700317 name := fd.FullName()
Joe Tsai378c1322019-04-25 23:48:08 -0700318 num := fd.Number()
319
320 m.Clear(fd) // start with an empty list
Damien Neilf5274512019-08-05 10:48:38 -0700321 list := m.Get(fd).List()
Damien Neil9f1165c2019-11-26 13:31:38 -0800322 if list.IsValid() {
323 t.Errorf("message.Get(%v).IsValid() = true, want false", name)
324 }
325 if !panics(func() {
326 m.Set(fd, pref.ValueOfList(list))
327 }) {
328 t.Errorf("message.Set(%v, <invalid>) does not panic", name)
329 }
330 if !panics(func() {
331 list.Append(newListElement(fd, list, 0, nil))
332 }) {
333 t.Errorf("message.Get(%v).Append(...) of invalid list does not panic", name)
334 }
Damien Neilf5274512019-08-05 10:48:38 -0700335 if got, want := list.NewElement(), newListElement(fd, list, 0, nil); !valueEqual(got, want) {
336 t.Errorf("message.Get(%v).NewElement() = %v, want %v", name, formatValue(got), formatValue(want))
337 }
338 list = m.Mutable(fd).List() // mutable list
Damien Neil9f1165c2019-11-26 13:31:38 -0800339 if !list.IsValid() {
340 t.Errorf("message.Get(%v).IsValid() = false, want true", name)
341 }
Damien Neilf5274512019-08-05 10:48:38 -0700342 if got, want := list.NewElement(), newListElement(fd, list, 0, nil); !valueEqual(got, want) {
343 t.Errorf("message.Mutable(%v).NewElement() = %v, want %v", name, formatValue(got), formatValue(want))
344 }
Damien Neil5ec58b92019-04-30 11:36:39 -0700345
346 // Append values.
347 var want pref.List = &testList{}
348 for i, n := range []seed{1, 0, minVal, maxVal} {
Damien Neila0a54b82019-11-01 15:18:36 -0700349 if got, want := m.Has(fd), i > 0; got != want {
Joe Tsai378c1322019-04-25 23:48:08 -0700350 t.Errorf("after appending %d elements to %q:\nMessage.Has(%v) = %v, want %v", i, name, num, got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700351 }
352 v := newListElement(fd, list, n, nil)
353 want.Append(v)
354 list.Append(v)
355
Joe Tsai84177c92019-09-17 13:38:48 -0700356 if got, want := m.Get(fd), pref.ValueOfList(want); !valueEqual(got, want) {
Joe Tsai378c1322019-04-25 23:48:08 -0700357 t.Errorf("after appending %d elements to %q:\nMessage.Get(%v) = %v, want %v", i+1, name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700358 }
359 }
360
361 // Set values.
362 for i := 0; i < want.Len(); i++ {
363 v := newListElement(fd, list, seed(i+10), nil)
364 want.Set(i, v)
365 list.Set(i, v)
Joe Tsai84177c92019-09-17 13:38:48 -0700366 if got, want := m.Get(fd), pref.ValueOfList(want); !valueEqual(got, want) {
Joe Tsai378c1322019-04-25 23:48:08 -0700367 t.Errorf("after setting element %d of %q:\nMessage.Get(%v) = %v, want %v", i, name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700368 }
369 }
370
371 // Truncate.
372 for want.Len() > 0 {
373 n := want.Len() - 1
374 want.Truncate(n)
375 list.Truncate(n)
Damien Neila0a54b82019-11-01 15:18:36 -0700376 if got, want := m.Has(fd), want.Len() > 0; got != want {
Joe Tsai378c1322019-04-25 23:48:08 -0700377 t.Errorf("after truncating %q to %d:\nMessage.Has(%v) = %v, want %v", name, n, num, got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700378 }
Joe Tsai84177c92019-09-17 13:38:48 -0700379 if got, want := m.Get(fd), pref.ValueOfList(want); !valueEqual(got, want) {
Joe Tsai378c1322019-04-25 23:48:08 -0700380 t.Errorf("after truncating %q to %d:\nMessage.Get(%v) = %v, want %v", name, n, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700381 }
382 }
383}
384
385type testList struct {
386 a []pref.Value
387}
388
Damien Neil2eaed362019-09-05 10:08:32 -0700389func (l *testList) Append(v pref.Value) { l.a = append(l.a, v) }
390func (l *testList) Get(n int) pref.Value { return l.a[n] }
391func (l *testList) Len() int { return len(l.a) }
392func (l *testList) Set(n int, v pref.Value) { l.a[n] = v }
393func (l *testList) Truncate(n int) { l.a = l.a[:n] }
394func (l *testList) NewElement() pref.Value { panic("unimplemented") }
Damien Neil82886da2019-11-26 13:27:24 -0800395func (l *testList) IsValid() bool { return true }
Damien Neil5ec58b92019-04-30 11:36:39 -0700396
397// testFieldFloat exercises some interesting floating-point scalar field values.
398func testFieldFloat(t testing.TB, m pref.Message, fd pref.FieldDescriptor) {
Damien Neil5ec58b92019-04-30 11:36:39 -0700399 name := fd.FullName()
Joe Tsai378c1322019-04-25 23:48:08 -0700400 num := fd.Number()
401
Damien Neil5ec58b92019-04-30 11:36:39 -0700402 for _, v := range []float64{math.Inf(-1), math.Inf(1), math.NaN(), math.Copysign(0, -1)} {
403 var val pref.Value
404 if fd.Kind() == pref.FloatKind {
Joe Tsai84177c92019-09-17 13:38:48 -0700405 val = pref.ValueOfFloat32(float32(v))
Damien Neil5ec58b92019-04-30 11:36:39 -0700406 } else {
Joe Tsai84177c92019-09-17 13:38:48 -0700407 val = pref.ValueOfFloat64(float64(v))
Damien Neil5ec58b92019-04-30 11:36:39 -0700408 }
Joe Tsai378c1322019-04-25 23:48:08 -0700409 m.Set(fd, val)
Damien Neil5ec58b92019-04-30 11:36:39 -0700410 // Note that Has is true for -0.
Joe Tsai378c1322019-04-25 23:48:08 -0700411 if got, want := m.Has(fd), true; got != want {
412 t.Errorf("after setting %v to %v: Message.Has(%v) = %v, want %v", name, v, num, got, want)
Damien Neil5ec58b92019-04-30 11:36:39 -0700413 }
Joe Tsai378c1322019-04-25 23:48:08 -0700414 if got, want := m.Get(fd), val; !valueEqual(got, want) {
415 t.Errorf("after setting %v: Message.Get(%v) = %v, want %v", name, num, formatValue(got), formatValue(want))
Damien Neil5ec58b92019-04-30 11:36:39 -0700416 }
417 }
418}
419
420// testOneof tests the behavior of fields in a oneof.
421func testOneof(t testing.TB, m pref.Message, od pref.OneofDescriptor) {
Damien Neila3456c92019-04-30 11:36:49 -0700422 for _, mutable := range []bool{false, true} {
423 for i := 0; i < od.Fields().Len(); i++ {
424 fda := od.Fields().Get(i)
425 if mutable {
426 // Set fields by requesting a mutable reference.
427 if !fda.IsMap() && !fda.IsList() && fda.Message() == nil {
428 continue
429 }
430 _ = m.Mutable(fda)
431 } else {
432 // Set fields explicitly.
433 m.Set(fda, newValue(m, fda, 1, nil))
434 }
435 if got, want := m.WhichOneof(od), fda; got != want {
436 t.Errorf("after setting oneof field %q:\nWhichOneof(%q) = %v, want %v", fda.FullName(), fda.Name(), got, want)
437 }
438 for j := 0; j < od.Fields().Len(); j++ {
439 fdb := od.Fields().Get(j)
440 if got, want := m.Has(fdb), i == j; got != want {
441 t.Errorf("after setting oneof field %q:\nGet(%q) = %v, want %v", fda.FullName(), fdb.FullName(), got, want)
442 }
Damien Neil5ec58b92019-04-30 11:36:39 -0700443 }
444 }
445 }
446}
447
Damien Neild91246e2019-06-21 08:36:26 -0700448// testUnknown tests the behavior of unknown fields.
449func testUnknown(t testing.TB, m pref.Message) {
450 var b []byte
451 b = wire.AppendTag(b, 1000, wire.VarintType)
452 b = wire.AppendVarint(b, 1001)
453 m.SetUnknown(pref.RawFields(b))
454 if got, want := []byte(m.GetUnknown()), b; !bytes.Equal(got, want) {
455 t.Errorf("after setting unknown fields:\nGetUnknown() = %v, want %v", got, want)
456 }
457}
458
Damien Neil5ec58b92019-04-30 11:36:39 -0700459func formatValue(v pref.Value) string {
460 switch v := v.Interface().(type) {
461 case pref.List:
462 var buf bytes.Buffer
463 buf.WriteString("list[")
464 for i := 0; i < v.Len(); i++ {
465 if i > 0 {
466 buf.WriteString(" ")
467 }
468 buf.WriteString(formatValue(v.Get(i)))
469 }
470 buf.WriteString("]")
471 return buf.String()
472 case pref.Map:
473 var buf bytes.Buffer
474 buf.WriteString("map[")
475 var keys []pref.MapKey
476 v.Range(func(k pref.MapKey, v pref.Value) bool {
477 keys = append(keys, k)
478 return true
479 })
480 sort.Slice(keys, func(i, j int) bool {
481 return keys[i].String() < keys[j].String()
482 })
483 for i, k := range keys {
484 if i > 0 {
485 buf.WriteString(" ")
486 }
487 buf.WriteString(formatValue(k.Value()))
488 buf.WriteString(":")
489 buf.WriteString(formatValue(v.Get(k)))
490 }
491 buf.WriteString("]")
492 return buf.String()
493 case pref.Message:
Damien Neil5c5b5312019-05-14 12:44:37 -0700494 b, err := prototext.Marshal(v.Interface())
Damien Neil5ec58b92019-04-30 11:36:39 -0700495 if err != nil {
496 return fmt.Sprintf("<%v>", err)
497 }
Joe Tsai0fc49f82019-05-01 12:29:25 -0700498 return fmt.Sprintf("%v{%v}", v.Descriptor().FullName(), string(b))
Damien Neil5ec58b92019-04-30 11:36:39 -0700499 case string:
500 return fmt.Sprintf("%q", v)
501 default:
502 return fmt.Sprint(v)
503 }
504}
505
506func valueEqual(a, b pref.Value) bool {
507 ai, bi := a.Interface(), b.Interface()
508 switch ai.(type) {
509 case pref.Message:
510 return proto.Equal(
511 a.Message().Interface(),
512 b.Message().Interface(),
513 )
514 case pref.List:
515 lista, listb := a.List(), b.List()
516 if lista.Len() != listb.Len() {
517 return false
518 }
519 for i := 0; i < lista.Len(); i++ {
520 if !valueEqual(lista.Get(i), listb.Get(i)) {
521 return false
522 }
523 }
524 return true
525 case pref.Map:
526 mapa, mapb := a.Map(), b.Map()
527 if mapa.Len() != mapb.Len() {
528 return false
529 }
530 equal := true
531 mapa.Range(func(k pref.MapKey, v pref.Value) bool {
532 if !valueEqual(v, mapb.Get(k)) {
533 equal = false
534 return false
535 }
536 return true
537 })
538 return equal
539 case []byte:
540 return bytes.Equal(a.Bytes(), b.Bytes())
Joe Tsaifb30a402019-05-20 15:19:14 -0700541 case float32:
Damien Neil5ec58b92019-04-30 11:36:39 -0700542 // NaNs are equal, but must be the same NaN.
Joe Tsaifb30a402019-05-20 15:19:14 -0700543 return math.Float32bits(ai.(float32)) == math.Float32bits(bi.(float32))
544 case float64:
545 // NaNs are equal, but must be the same NaN.
546 return math.Float64bits(ai.(float64)) == math.Float64bits(bi.(float64))
Damien Neil5ec58b92019-04-30 11:36:39 -0700547 default:
548 return ai == bi
549 }
550}
551
552// A seed is used to vary the content of a value.
553//
554// A seed of 0 is the zero value. Messages do not have a zero-value; a 0-seeded messages
555// is unpopulated.
556//
557// A seed of minVal or maxVal is the least or greatest value of the value type.
558type seed int
559
560const (
561 minVal seed = -1
562 maxVal seed = -2
563)
564
Damien Neilf5274512019-08-05 10:48:38 -0700565// newSeed creates new seed values from a base, for example to create seeds for the
566// elements in a list. If the input seed is minVal or maxVal, so is the output.
567func newSeed(n seed, adjust ...int) seed {
568 switch n {
569 case minVal, maxVal:
570 return n
571 }
572 for _, a := range adjust {
573 n = 10*n + seed(a)
574 }
575 return n
576}
577
Damien Neil5ec58b92019-04-30 11:36:39 -0700578// newValue returns a new value assignable to a field.
579//
580// The stack parameter is used to avoid infinite recursion when populating circular
581// data structures.
Joe Tsai0fc49f82019-05-01 12:29:25 -0700582func newValue(m pref.Message, fd pref.FieldDescriptor, n seed, stack []pref.MessageDescriptor) pref.Value {
Damien Neil5ec58b92019-04-30 11:36:39 -0700583 switch {
Joe Tsaiac31a352019-05-13 14:32:56 -0700584 case fd.IsList():
Joe Tsaiac31a352019-05-13 14:32:56 -0700585 if n == 0 {
Damien Neil9f1165c2019-11-26 13:31:38 -0800586 return m.New().Mutable(fd)
Joe Tsaiac31a352019-05-13 14:32:56 -0700587 }
Damien Neil290ceea2019-07-15 13:39:43 -0700588 list := m.NewField(fd).List()
Joe Tsaiac31a352019-05-13 14:32:56 -0700589 list.Append(newListElement(fd, list, 0, stack))
590 list.Append(newListElement(fd, list, minVal, stack))
591 list.Append(newListElement(fd, list, maxVal, stack))
592 list.Append(newListElement(fd, list, n, stack))
Joe Tsai84177c92019-09-17 13:38:48 -0700593 return pref.ValueOfList(list)
Damien Neil5ec58b92019-04-30 11:36:39 -0700594 case fd.IsMap():
Damien Neil5ec58b92019-04-30 11:36:39 -0700595 if n == 0 {
Damien Neil9f1165c2019-11-26 13:31:38 -0800596 return m.New().Mutable(fd)
Damien Neil5ec58b92019-04-30 11:36:39 -0700597 }
Damien Neil290ceea2019-07-15 13:39:43 -0700598 mapv := m.NewField(fd).Map()
Damien Neil5ec58b92019-04-30 11:36:39 -0700599 mapv.Set(newMapKey(fd, 0), newMapValue(fd, mapv, 0, stack))
600 mapv.Set(newMapKey(fd, minVal), newMapValue(fd, mapv, minVal, stack))
601 mapv.Set(newMapKey(fd, maxVal), newMapValue(fd, mapv, maxVal, stack))
Damien Neilf5274512019-08-05 10:48:38 -0700602 mapv.Set(newMapKey(fd, n), newMapValue(fd, mapv, newSeed(n, 0), stack))
Joe Tsai84177c92019-09-17 13:38:48 -0700603 return pref.ValueOfMap(mapv)
Damien Neil5ec58b92019-04-30 11:36:39 -0700604 case fd.Message() != nil:
Damien Neil290ceea2019-07-15 13:39:43 -0700605 //if n == 0 {
606 // return m.New().Get(fd)
607 //}
Damien Neilf5274512019-08-05 10:48:38 -0700608 return populateMessage(m.NewField(fd).Message(), n, stack)
Damien Neil5ec58b92019-04-30 11:36:39 -0700609 default:
610 return newScalarValue(fd, n)
611 }
612}
613
Joe Tsai0fc49f82019-05-01 12:29:25 -0700614func newListElement(fd pref.FieldDescriptor, list pref.List, n seed, stack []pref.MessageDescriptor) pref.Value {
Damien Neil5ec58b92019-04-30 11:36:39 -0700615 if fd.Message() == nil {
616 return newScalarValue(fd, n)
617 }
Damien Neilf5274512019-08-05 10:48:38 -0700618 return populateMessage(list.NewElement().Message(), n, stack)
Damien Neil5ec58b92019-04-30 11:36:39 -0700619}
620
621func newMapKey(fd pref.FieldDescriptor, n seed) pref.MapKey {
Joe Tsaiac31a352019-05-13 14:32:56 -0700622 kd := fd.MapKey()
Damien Neil5ec58b92019-04-30 11:36:39 -0700623 return newScalarValue(kd, n).MapKey()
624}
625
Joe Tsai0fc49f82019-05-01 12:29:25 -0700626func newMapValue(fd pref.FieldDescriptor, mapv pref.Map, n seed, stack []pref.MessageDescriptor) pref.Value {
Joe Tsaiac31a352019-05-13 14:32:56 -0700627 vd := fd.MapValue()
Damien Neil5ec58b92019-04-30 11:36:39 -0700628 if vd.Message() == nil {
629 return newScalarValue(vd, n)
630 }
Damien Neilf5274512019-08-05 10:48:38 -0700631 return populateMessage(mapv.NewValue().Message(), n, stack)
Damien Neil5ec58b92019-04-30 11:36:39 -0700632}
633
634func newScalarValue(fd pref.FieldDescriptor, n seed) pref.Value {
635 switch fd.Kind() {
636 case pref.BoolKind:
Joe Tsai84177c92019-09-17 13:38:48 -0700637 return pref.ValueOfBool(n != 0)
Damien Neil5ec58b92019-04-30 11:36:39 -0700638 case pref.EnumKind:
Damien Neilf5274512019-08-05 10:48:38 -0700639 vals := fd.Enum().Values()
640 var i int
641 switch n {
642 case minVal:
643 i = 0
644 case maxVal:
645 i = vals.Len() - 1
646 default:
647 i = int(n) % vals.Len()
648 }
Joe Tsai84177c92019-09-17 13:38:48 -0700649 return pref.ValueOfEnum(vals.Get(i).Number())
Damien Neil5ec58b92019-04-30 11:36:39 -0700650 case pref.Int32Kind, pref.Sint32Kind, pref.Sfixed32Kind:
651 switch n {
652 case minVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700653 return pref.ValueOfInt32(math.MinInt32)
Damien Neil5ec58b92019-04-30 11:36:39 -0700654 case maxVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700655 return pref.ValueOfInt32(math.MaxInt32)
Damien Neil5ec58b92019-04-30 11:36:39 -0700656 default:
Joe Tsai84177c92019-09-17 13:38:48 -0700657 return pref.ValueOfInt32(int32(n))
Damien Neil5ec58b92019-04-30 11:36:39 -0700658 }
659 case pref.Uint32Kind, pref.Fixed32Kind:
660 switch n {
661 case minVal:
662 // Only use 0 for the zero value.
Joe Tsai84177c92019-09-17 13:38:48 -0700663 return pref.ValueOfUint32(1)
Damien Neil5ec58b92019-04-30 11:36:39 -0700664 case maxVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700665 return pref.ValueOfUint32(math.MaxInt32)
Damien Neil5ec58b92019-04-30 11:36:39 -0700666 default:
Joe Tsai84177c92019-09-17 13:38:48 -0700667 return pref.ValueOfUint32(uint32(n))
Damien Neil5ec58b92019-04-30 11:36:39 -0700668 }
669 case pref.Int64Kind, pref.Sint64Kind, pref.Sfixed64Kind:
670 switch n {
671 case minVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700672 return pref.ValueOfInt64(math.MinInt64)
Damien Neil5ec58b92019-04-30 11:36:39 -0700673 case maxVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700674 return pref.ValueOfInt64(math.MaxInt64)
Damien Neil5ec58b92019-04-30 11:36:39 -0700675 default:
Joe Tsai84177c92019-09-17 13:38:48 -0700676 return pref.ValueOfInt64(int64(n))
Damien Neil5ec58b92019-04-30 11:36:39 -0700677 }
678 case pref.Uint64Kind, pref.Fixed64Kind:
679 switch n {
680 case minVal:
681 // Only use 0 for the zero value.
Joe Tsai84177c92019-09-17 13:38:48 -0700682 return pref.ValueOfUint64(1)
Damien Neil5ec58b92019-04-30 11:36:39 -0700683 case maxVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700684 return pref.ValueOfUint64(math.MaxInt64)
Damien Neil5ec58b92019-04-30 11:36:39 -0700685 default:
Joe Tsai84177c92019-09-17 13:38:48 -0700686 return pref.ValueOfUint64(uint64(n))
Damien Neil5ec58b92019-04-30 11:36:39 -0700687 }
688 case pref.FloatKind:
689 switch n {
690 case minVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700691 return pref.ValueOfFloat32(math.SmallestNonzeroFloat32)
Damien Neil5ec58b92019-04-30 11:36:39 -0700692 case maxVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700693 return pref.ValueOfFloat32(math.MaxFloat32)
Damien Neil5ec58b92019-04-30 11:36:39 -0700694 default:
Joe Tsai84177c92019-09-17 13:38:48 -0700695 return pref.ValueOfFloat32(1.5 * float32(n))
Damien Neil5ec58b92019-04-30 11:36:39 -0700696 }
697 case pref.DoubleKind:
698 switch n {
699 case minVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700700 return pref.ValueOfFloat64(math.SmallestNonzeroFloat64)
Damien Neil5ec58b92019-04-30 11:36:39 -0700701 case maxVal:
Joe Tsai84177c92019-09-17 13:38:48 -0700702 return pref.ValueOfFloat64(math.MaxFloat64)
Damien Neil5ec58b92019-04-30 11:36:39 -0700703 default:
Joe Tsai84177c92019-09-17 13:38:48 -0700704 return pref.ValueOfFloat64(1.5 * float64(n))
Damien Neil5ec58b92019-04-30 11:36:39 -0700705 }
706 case pref.StringKind:
707 if n == 0 {
Joe Tsai84177c92019-09-17 13:38:48 -0700708 return pref.ValueOfString("")
Damien Neil5ec58b92019-04-30 11:36:39 -0700709 }
Joe Tsai84177c92019-09-17 13:38:48 -0700710 return pref.ValueOfString(fmt.Sprintf("%d", n))
Damien Neil5ec58b92019-04-30 11:36:39 -0700711 case pref.BytesKind:
712 if n == 0 {
Joe Tsai84177c92019-09-17 13:38:48 -0700713 return pref.ValueOfBytes(nil)
Damien Neil5ec58b92019-04-30 11:36:39 -0700714 }
Joe Tsai84177c92019-09-17 13:38:48 -0700715 return pref.ValueOfBytes([]byte{byte(n >> 24), byte(n >> 16), byte(n >> 8), byte(n)})
Damien Neil5ec58b92019-04-30 11:36:39 -0700716 }
717 panic("unhandled kind")
718}
719
Joe Tsai0fc49f82019-05-01 12:29:25 -0700720func populateMessage(m pref.Message, n seed, stack []pref.MessageDescriptor) pref.Value {
Damien Neil5ec58b92019-04-30 11:36:39 -0700721 if n == 0 {
Joe Tsai84177c92019-09-17 13:38:48 -0700722 return pref.ValueOfMessage(m)
Damien Neil5ec58b92019-04-30 11:36:39 -0700723 }
Joe Tsai0fc49f82019-05-01 12:29:25 -0700724 md := m.Descriptor()
Damien Neil5ec58b92019-04-30 11:36:39 -0700725 for _, x := range stack {
726 if md == x {
Joe Tsai84177c92019-09-17 13:38:48 -0700727 return pref.ValueOfMessage(m)
Damien Neil5ec58b92019-04-30 11:36:39 -0700728 }
729 }
730 stack = append(stack, md)
Damien Neil5ec58b92019-04-30 11:36:39 -0700731 for i := 0; i < md.Fields().Len(); i++ {
732 fd := md.Fields().Get(i)
733 if fd.IsWeak() {
734 continue
735 }
Damien Neilf5274512019-08-05 10:48:38 -0700736 m.Set(fd, newValue(m, fd, newSeed(n, i), stack))
Damien Neil5ec58b92019-04-30 11:36:39 -0700737 }
Joe Tsai84177c92019-09-17 13:38:48 -0700738 return pref.ValueOfMessage(m)
Damien Neil5ec58b92019-04-30 11:36:39 -0700739}
Damien Neild91246e2019-06-21 08:36:26 -0700740
741func panics(f func()) (didPanic bool) {
742 defer func() {
743 if err := recover(); err != nil {
744 didPanic = true
745 }
746 }()
747 f()
748 return false
749}