1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
// Copyright 2020 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 protorange
import (
"testing"
"time"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protopath"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/reflect/protoregistry"
"google.golang.org/protobuf/testing/protocmp"
newspb "google.golang.org/protobuf/internal/testprotos/news"
anypb "google.golang.org/protobuf/types/known/anypb"
timestamppb "google.golang.org/protobuf/types/known/timestamppb"
)
func mustMarshal(m proto.Message) []byte {
b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
if err != nil {
panic(err)
}
return b
}
var transformReflectValue = cmp.Transformer("", func(v protoreflect.Value) interface{} {
switch v := v.Interface().(type) {
case protoreflect.Message:
return v.Interface()
case protoreflect.Map:
ms := map[interface{}]protoreflect.Value{}
v.Range(func(k protoreflect.MapKey, v protoreflect.Value) bool {
ms[k.Interface()] = v
return true
})
return ms
case protoreflect.List:
ls := []protoreflect.Value{}
for i := 0; i < v.Len(); i++ {
ls = append(ls, v.Get(i))
}
return ls
default:
return v
}
})
func TestRange(t *testing.T) {
m2 := (&newspb.KeyValueAttachment{
Name: "checksums.txt",
Data: map[string]string{
"go1.10.src.tar.gz": "07cbb9d0091b846c6aea40bf5bc0cea7",
"go1.10.darwin-amd64.pkg": "cbb38bb6ff6ea86279e01745984445bf",
"go1.10.linux-amd64.tar.gz": "6b3d0e4a5c77352cf4275573817f7566",
"go1.10.windows-amd64.msi": "57bda02030f58f5d2bf71943e1390123",
},
}).ProtoReflect()
m := (&newspb.Article{
Author: "Brad Fitzpatrick",
Date: timestamppb.New(time.Date(2018, time.February, 16, 0, 0, 0, 0, time.UTC)),
Title: "Go 1.10 is released",
Content: "Happy Friday, happy weekend! Today the Go team is happy to announce the release of Go 1.10...",
Status: newspb.Article_PUBLISHED,
Tags: []string{"go1.10", "release"},
Attachments: []*anypb.Any{{
TypeUrl: "google.golang.org.KeyValueAttachment",
Value: mustMarshal(m2.Interface()),
}},
}).ProtoReflect()
// Nil push and pop functions should not panic.
noop := func(protopath.Values) error { return nil }
Options{}.Range(m, nil, nil)
Options{}.Range(m, noop, nil)
Options{}.Range(m, nil, noop)
getByName := func(m protoreflect.Message, s protoreflect.Name) protoreflect.Value {
fds := m.Descriptor().Fields()
return m.Get(fds.ByName(s))
}
wantPaths := []string{
``,
`.author`,
`.date`,
`.date.seconds`,
`.title`,
`.content`,
`.attachments`,
`.attachments[0]`,
`.attachments[0].(google.golang.org.KeyValueAttachment)`,
`.attachments[0].(google.golang.org.KeyValueAttachment).name`,
`.attachments[0].(google.golang.org.KeyValueAttachment).data`,
`.attachments[0].(google.golang.org.KeyValueAttachment).data["go1.10.darwin-amd64.pkg"]`,
`.attachments[0].(google.golang.org.KeyValueAttachment).data["go1.10.linux-amd64.tar.gz"]`,
`.attachments[0].(google.golang.org.KeyValueAttachment).data["go1.10.src.tar.gz"]`,
`.attachments[0].(google.golang.org.KeyValueAttachment).data["go1.10.windows-amd64.msi"]`,
`.tags`,
`.tags[0]`,
`.tags[1]`,
`.status`,
}
wantValues := []protoreflect.Value{
protoreflect.ValueOfMessage(m),
getByName(m, "author"),
getByName(m, "date"),
getByName(getByName(m, "date").Message(), "seconds"),
getByName(m, `title`),
getByName(m, `content`),
getByName(m, `attachments`),
getByName(m, `attachments`).List().Get(0),
protoreflect.ValueOfMessage(m2),
getByName(m2, `name`),
getByName(m2, `data`),
getByName(m2, `data`).Map().Get(protoreflect.ValueOfString("go1.10.darwin-amd64.pkg").MapKey()),
getByName(m2, `data`).Map().Get(protoreflect.ValueOfString("go1.10.linux-amd64.tar.gz").MapKey()),
getByName(m2, `data`).Map().Get(protoreflect.ValueOfString("go1.10.src.tar.gz").MapKey()),
getByName(m2, `data`).Map().Get(protoreflect.ValueOfString("go1.10.windows-amd64.msi").MapKey()),
getByName(m, `tags`),
getByName(m, `tags`).List().Get(0),
getByName(m, `tags`).List().Get(1),
getByName(m, `status`),
}
tests := []struct {
resolver interface {
protoregistry.ExtensionTypeResolver
protoregistry.MessageTypeResolver
}
errorAt int
breakAt int
terminateAt int
wantPaths []string
wantValues []protoreflect.Value
wantError error
}{{
wantPaths: wantPaths,
wantValues: wantValues,
}, {
resolver: (*protoregistry.Types)(nil),
wantPaths: append(append(wantPaths[:8:8],
`.attachments[0].type_url`,
`.attachments[0].value`,
), wantPaths[15:]...),
wantValues: append(append(wantValues[:8:8],
protoreflect.ValueOfString("google.golang.org.KeyValueAttachment"),
protoreflect.ValueOfBytes(mustMarshal(m2.Interface())),
), wantValues[15:]...),
}, {
errorAt: 5, // return error within newspb.Article
wantPaths: wantPaths[:5],
wantValues: wantValues[:5],
wantError: cmpopts.AnyError,
}, {
terminateAt: 11, // terminate within newspb.KeyValueAttachment
wantPaths: wantPaths[:11],
wantValues: wantValues[:11],
}, {
breakAt: 11, // break within newspb.KeyValueAttachment
wantPaths: append(wantPaths[:11:11], wantPaths[15:]...),
wantValues: append(wantValues[:11:11], wantValues[15:]...),
}, {
errorAt: 17, // return error within newspb.Article.Tags
wantPaths: wantPaths[:17],
wantValues: wantValues[:17],
wantError: cmpopts.AnyError,
}, {
breakAt: 17, // break within newspb.Article.Tags
wantPaths: append(wantPaths[:17:17], wantPaths[18:]...),
wantValues: append(wantValues[:17:17], wantValues[18:]...),
}, {
terminateAt: 17, // terminate within newspb.Article.Tags
wantPaths: wantPaths[:17],
wantValues: wantValues[:17],
}, {
errorAt: 13, // return error within newspb.KeyValueAttachment.Data
wantPaths: wantPaths[:13],
wantValues: wantValues[:13],
wantError: cmpopts.AnyError,
}, {
breakAt: 13, // break within newspb.KeyValueAttachment.Data
wantPaths: append(wantPaths[:13:13], wantPaths[15:]...),
wantValues: append(wantValues[:13:13], wantValues[15:]...),
}, {
terminateAt: 13, // terminate within newspb.KeyValueAttachment.Data
wantPaths: wantPaths[:13],
wantValues: wantValues[:13],
}}
for _, tt := range tests {
t.Run("", func(t *testing.T) {
var gotPaths []string
var gotValues []protoreflect.Value
var stackPaths []string
var stackValues []protoreflect.Value
gotError := Options{
Stable: true,
Resolver: tt.resolver,
}.Range(m,
func(p protopath.Values) error {
gotPaths = append(gotPaths, p.Path[1:].String())
stackPaths = append(stackPaths, p.Path[1:].String())
gotValues = append(gotValues, p.Index(-1).Value)
stackValues = append(stackValues, p.Index(-1).Value)
switch {
case tt.errorAt > 0 && tt.errorAt == len(gotPaths):
return cmpopts.AnyError
case tt.breakAt > 0 && tt.breakAt == len(gotPaths):
return Break
case tt.terminateAt > 0 && tt.terminateAt == len(gotPaths):
return Terminate
default:
return nil
}
},
func(p protopath.Values) error {
gotPath := p.Path[1:].String()
wantPath := stackPaths[len(stackPaths)-1]
if wantPath != gotPath {
t.Errorf("%d: pop path mismatch: got %v, want %v", len(gotPaths), gotPath, wantPath)
}
gotValue := p.Index(-1).Value
wantValue := stackValues[len(stackValues)-1]
if diff := cmp.Diff(wantValue, gotValue, transformReflectValue, protocmp.Transform()); diff != "" {
t.Errorf("%d: pop value mismatch (-want +got):\n%v", len(gotValues), diff)
}
stackPaths = stackPaths[:len(stackPaths)-1]
stackValues = stackValues[:len(stackValues)-1]
return nil
},
)
if n := len(stackPaths) + len(stackValues); n > 0 {
t.Errorf("stack mismatch: got %d unpopped items", n)
}
if diff := cmp.Diff(tt.wantPaths, gotPaths); diff != "" {
t.Errorf("paths mismatch (-want +got):\n%s", diff)
}
if diff := cmp.Diff(tt.wantValues, gotValues, transformReflectValue, protocmp.Transform()); diff != "" {
t.Errorf("values mismatch (-want +got):\n%s", diff)
}
if !cmp.Equal(gotError, tt.wantError, cmpopts.EquateErrors()) {
t.Errorf("error mismatch: got %v, want %v", gotError, tt.wantError)
}
})
}
}
|
