blob: 09cb9f89c4d080ebf9cc40a4f7dcf664f5900c38 [file] [log] [blame]
Herbie Ong7b828bc2019-02-08 19:56:24 -08001// 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
5package jsonpb_test
6
7import (
Herbie Ong0b0f4032019-03-18 19:06:15 -07008 "encoding/hex"
Herbie Ong7b828bc2019-02-08 19:56:24 -08009 "math"
10 "strings"
11 "testing"
12
13 "github.com/golang/protobuf/v2/encoding/jsonpb"
14 "github.com/golang/protobuf/v2/internal/encoding/pack"
Herbie Ongf83d5bb2019-03-14 00:01:27 -070015 "github.com/golang/protobuf/v2/internal/encoding/wire"
Herbie Ong7b828bc2019-02-08 19:56:24 -080016 "github.com/golang/protobuf/v2/internal/scalar"
17 "github.com/golang/protobuf/v2/proto"
Herbie Ong0b0f4032019-03-18 19:06:15 -070018 preg "github.com/golang/protobuf/v2/reflect/protoregistry"
Joe Tsai4fddeba2019-03-20 18:29:32 -070019 "github.com/golang/protobuf/v2/runtime/protoiface"
Herbie Ong7b828bc2019-02-08 19:56:24 -080020 "github.com/google/go-cmp/cmp"
21 "github.com/google/go-cmp/cmp/cmpopts"
22
Herbie Ongf83d5bb2019-03-14 00:01:27 -070023 // This legacy package is still needed when importing legacy message.
24 _ "github.com/golang/protobuf/v2/internal/legacy"
25
Herbie Ong7b828bc2019-02-08 19:56:24 -080026 "github.com/golang/protobuf/v2/encoding/testprotos/pb2"
27 "github.com/golang/protobuf/v2/encoding/testprotos/pb3"
Herbie Ong0b0f4032019-03-18 19:06:15 -070028 knownpb "github.com/golang/protobuf/v2/types/known"
Herbie Ong7b828bc2019-02-08 19:56:24 -080029)
30
31// splitLines is a cmpopts.Option for comparing strings with line breaks.
32var splitLines = cmpopts.AcyclicTransformer("SplitLines", func(s string) []string {
33 return strings.Split(s, "\n")
34})
35
36func pb2Enum(i int32) *pb2.Enum {
37 p := new(pb2.Enum)
38 *p = pb2.Enum(i)
39 return p
40}
41
42func pb2Enums_NestedEnum(i int32) *pb2.Enums_NestedEnum {
43 p := new(pb2.Enums_NestedEnum)
44 *p = pb2.Enums_NestedEnum(i)
45 return p
46}
47
Joe Tsai4fddeba2019-03-20 18:29:32 -070048func setExtension(m proto.Message, xd *protoiface.ExtensionDescV1, val interface{}) {
Herbie Ongf83d5bb2019-03-14 00:01:27 -070049 knownFields := m.ProtoReflect().KnownFields()
50 extTypes := knownFields.ExtensionTypes()
51 extTypes.Register(xd.Type)
52 if val == nil {
53 return
54 }
55 pval := xd.Type.ValueOf(val)
56 knownFields.Set(wire.Number(xd.Field), pval)
57}
58
Herbie Ong0b0f4032019-03-18 19:06:15 -070059// dhex decodes a hex-string and returns the bytes and panics if s is invalid.
60func dhex(s string) []byte {
61 b, err := hex.DecodeString(s)
62 if err != nil {
63 panic(err)
64 }
65 return b
66}
67
Herbie Ong7b828bc2019-02-08 19:56:24 -080068func TestMarshal(t *testing.T) {
69 tests := []struct {
Herbie Ong0b0f4032019-03-18 19:06:15 -070070 desc string
71 mo jsonpb.MarshalOptions
72 input proto.Message
73 want string
74 wantErr bool // TODO: Verify error message substring.
Herbie Ong7b828bc2019-02-08 19:56:24 -080075 }{{
76 desc: "proto2 optional scalars not set",
77 input: &pb2.Scalars{},
78 want: "{}",
79 }, {
80 desc: "proto3 scalars not set",
81 input: &pb3.Scalars{},
82 want: "{}",
83 }, {
84 desc: "proto2 optional scalars set to zero values",
85 input: &pb2.Scalars{
86 OptBool: scalar.Bool(false),
87 OptInt32: scalar.Int32(0),
88 OptInt64: scalar.Int64(0),
89 OptUint32: scalar.Uint32(0),
90 OptUint64: scalar.Uint64(0),
91 OptSint32: scalar.Int32(0),
92 OptSint64: scalar.Int64(0),
93 OptFixed32: scalar.Uint32(0),
94 OptFixed64: scalar.Uint64(0),
95 OptSfixed32: scalar.Int32(0),
96 OptSfixed64: scalar.Int64(0),
97 OptFloat: scalar.Float32(0),
98 OptDouble: scalar.Float64(0),
99 OptBytes: []byte{},
100 OptString: scalar.String(""),
101 },
102 want: `{
103 "optBool": false,
104 "optInt32": 0,
105 "optInt64": "0",
106 "optUint32": 0,
107 "optUint64": "0",
108 "optSint32": 0,
109 "optSint64": "0",
110 "optFixed32": 0,
111 "optFixed64": "0",
112 "optSfixed32": 0,
113 "optSfixed64": "0",
114 "optFloat": 0,
115 "optDouble": 0,
116 "optBytes": "",
117 "optString": ""
118}`,
119 }, {
120 desc: "proto2 optional scalars set to some values",
121 input: &pb2.Scalars{
122 OptBool: scalar.Bool(true),
123 OptInt32: scalar.Int32(0xff),
124 OptInt64: scalar.Int64(0xdeadbeef),
125 OptUint32: scalar.Uint32(47),
126 OptUint64: scalar.Uint64(0xdeadbeef),
127 OptSint32: scalar.Int32(-1001),
128 OptSint64: scalar.Int64(-0xffff),
129 OptFixed64: scalar.Uint64(64),
130 OptSfixed32: scalar.Int32(-32),
131 OptFloat: scalar.Float32(1.02),
132 OptDouble: scalar.Float64(1.234),
Herbie Ong87608a72019-03-06 14:32:24 -0800133 OptBytes: []byte("谷歌"),
Herbie Ong7b828bc2019-02-08 19:56:24 -0800134 OptString: scalar.String("谷歌"),
135 },
136 want: `{
137 "optBool": true,
138 "optInt32": 255,
139 "optInt64": "3735928559",
140 "optUint32": 47,
141 "optUint64": "3735928559",
142 "optSint32": -1001,
143 "optSint64": "-65535",
144 "optFixed64": "64",
145 "optSfixed32": -32,
146 "optFloat": 1.02,
147 "optDouble": 1.234,
148 "optBytes": "6LC35q2M",
149 "optString": "谷歌"
150}`,
151 }, {
Herbie Ong0b0f4032019-03-18 19:06:15 -0700152 desc: "string",
153 input: &pb3.Scalars{
154 SString: "谷歌",
155 },
156 want: `{
157 "sString": "谷歌"
158}`,
159 }, {
160 desc: "string with invalid UTF8",
161 input: &pb3.Scalars{
162 SString: "abc\xff",
163 },
164 want: "{\n \"sString\": \"abc\xff\"\n}",
165 wantErr: true,
166 }, {
Herbie Ong7b828bc2019-02-08 19:56:24 -0800167 desc: "float nan",
168 input: &pb3.Scalars{
169 SFloat: float32(math.NaN()),
170 },
171 want: `{
172 "sFloat": "NaN"
173}`,
174 }, {
175 desc: "float positive infinity",
176 input: &pb3.Scalars{
177 SFloat: float32(math.Inf(1)),
178 },
179 want: `{
180 "sFloat": "Infinity"
181}`,
182 }, {
183 desc: "float negative infinity",
184 input: &pb3.Scalars{
185 SFloat: float32(math.Inf(-1)),
186 },
187 want: `{
188 "sFloat": "-Infinity"
189}`,
190 }, {
191 desc: "double nan",
192 input: &pb3.Scalars{
193 SDouble: math.NaN(),
194 },
195 want: `{
196 "sDouble": "NaN"
197}`,
198 }, {
199 desc: "double positive infinity",
200 input: &pb3.Scalars{
201 SDouble: math.Inf(1),
202 },
203 want: `{
204 "sDouble": "Infinity"
205}`,
206 }, {
207 desc: "double negative infinity",
208 input: &pb3.Scalars{
209 SDouble: math.Inf(-1),
210 },
211 want: `{
212 "sDouble": "-Infinity"
213}`,
214 }, {
215 desc: "proto2 enum not set",
216 input: &pb2.Enums{},
217 want: "{}",
218 }, {
219 desc: "proto2 enum set to zero value",
220 input: &pb2.Enums{
221 OptEnum: pb2Enum(0),
222 OptNestedEnum: pb2Enums_NestedEnum(0),
223 },
224 want: `{
225 "optEnum": 0,
226 "optNestedEnum": 0
227}`,
228 }, {
229 desc: "proto2 enum",
230 input: &pb2.Enums{
231 OptEnum: pb2.Enum_ONE.Enum(),
232 OptNestedEnum: pb2.Enums_UNO.Enum(),
233 },
234 want: `{
235 "optEnum": "ONE",
236 "optNestedEnum": "UNO"
237}`,
238 }, {
239 desc: "proto2 enum set to numeric values",
240 input: &pb2.Enums{
241 OptEnum: pb2Enum(2),
242 OptNestedEnum: pb2Enums_NestedEnum(2),
243 },
244 want: `{
245 "optEnum": "TWO",
246 "optNestedEnum": "DOS"
247}`,
248 }, {
249 desc: "proto2 enum set to unnamed numeric values",
250 input: &pb2.Enums{
251 OptEnum: pb2Enum(101),
252 OptNestedEnum: pb2Enums_NestedEnum(-101),
253 },
254 want: `{
255 "optEnum": 101,
256 "optNestedEnum": -101
257}`,
258 }, {
259 desc: "proto3 enum not set",
260 input: &pb3.Enums{},
261 want: "{}",
262 }, {
263 desc: "proto3 enum set to zero value",
264 input: &pb3.Enums{
265 SEnum: pb3.Enum_ZERO,
266 SNestedEnum: pb3.Enums_CERO,
267 },
268 want: "{}",
269 }, {
270 desc: "proto3 enum",
271 input: &pb3.Enums{
272 SEnum: pb3.Enum_ONE,
273 SNestedEnum: pb3.Enums_UNO,
274 },
275 want: `{
276 "sEnum": "ONE",
277 "sNestedEnum": "UNO"
278}`,
279 }, {
280 desc: "proto3 enum set to numeric values",
281 input: &pb3.Enums{
282 SEnum: 2,
283 SNestedEnum: 2,
284 },
285 want: `{
286 "sEnum": "TWO",
287 "sNestedEnum": "DOS"
288}`,
289 }, {
290 desc: "proto3 enum set to unnamed numeric values",
291 input: &pb3.Enums{
292 SEnum: -47,
293 SNestedEnum: 47,
294 },
295 want: `{
296 "sEnum": -47,
297 "sNestedEnum": 47
298}`,
299 }, {
300 desc: "proto2 nested message not set",
301 input: &pb2.Nests{},
302 want: "{}",
303 }, {
304 desc: "proto2 nested message set to empty",
305 input: &pb2.Nests{
306 OptNested: &pb2.Nested{},
307 Optgroup: &pb2.Nests_OptGroup{},
308 },
309 want: `{
310 "optNested": {},
311 "optgroup": {}
312}`,
313 }, {
314 desc: "proto2 nested messages",
315 input: &pb2.Nests{
316 OptNested: &pb2.Nested{
317 OptString: scalar.String("nested message"),
318 OptNested: &pb2.Nested{
319 OptString: scalar.String("another nested message"),
320 },
321 },
322 },
323 want: `{
324 "optNested": {
325 "optString": "nested message",
326 "optNested": {
327 "optString": "another nested message"
328 }
329 }
330}`,
331 }, {
332 desc: "proto2 groups",
333 input: &pb2.Nests{
334 Optgroup: &pb2.Nests_OptGroup{
335 OptString: scalar.String("inside a group"),
336 OptNested: &pb2.Nested{
337 OptString: scalar.String("nested message inside a group"),
338 },
339 Optnestedgroup: &pb2.Nests_OptGroup_OptNestedGroup{
340 OptFixed32: scalar.Uint32(47),
341 },
342 },
343 },
344 want: `{
345 "optgroup": {
346 "optString": "inside a group",
347 "optNested": {
348 "optString": "nested message inside a group"
349 },
350 "optnestedgroup": {
351 "optFixed32": 47
352 }
353 }
354}`,
355 }, {
356 desc: "proto3 nested message not set",
357 input: &pb3.Nests{},
358 want: "{}",
359 }, {
360 desc: "proto3 nested message set to empty",
361 input: &pb3.Nests{
362 SNested: &pb3.Nested{},
363 },
364 want: `{
365 "sNested": {}
366}`,
367 }, {
368 desc: "proto3 nested message",
369 input: &pb3.Nests{
370 SNested: &pb3.Nested{
371 SString: "nested message",
372 SNested: &pb3.Nested{
373 SString: "another nested message",
374 },
375 },
376 },
377 want: `{
378 "sNested": {
379 "sString": "nested message",
380 "sNested": {
381 "sString": "another nested message"
382 }
383 }
384}`,
385 }, {
386 desc: "oneof not set",
387 input: &pb3.Oneofs{},
388 want: "{}",
389 }, {
390 desc: "oneof set to empty string",
391 input: &pb3.Oneofs{
392 Union: &pb3.Oneofs_OneofString{},
393 },
394 want: `{
395 "oneofString": ""
396}`,
397 }, {
398 desc: "oneof set to string",
399 input: &pb3.Oneofs{
400 Union: &pb3.Oneofs_OneofString{
401 OneofString: "hello",
402 },
403 },
404 want: `{
405 "oneofString": "hello"
406}`,
407 }, {
408 desc: "oneof set to enum",
409 input: &pb3.Oneofs{
410 Union: &pb3.Oneofs_OneofEnum{
411 OneofEnum: pb3.Enum_ZERO,
412 },
413 },
414 want: `{
415 "oneofEnum": "ZERO"
416}`,
417 }, {
418 desc: "oneof set to empty message",
419 input: &pb3.Oneofs{
420 Union: &pb3.Oneofs_OneofNested{
421 OneofNested: &pb3.Nested{},
422 },
423 },
424 want: `{
425 "oneofNested": {}
426}`,
427 }, {
428 desc: "oneof set to message",
429 input: &pb3.Oneofs{
430 Union: &pb3.Oneofs_OneofNested{
431 OneofNested: &pb3.Nested{
432 SString: "nested message",
433 },
434 },
435 },
436 want: `{
437 "oneofNested": {
438 "sString": "nested message"
439 }
440}`,
441 }, {
442 desc: "repeated fields not set",
443 input: &pb2.Repeats{},
444 want: "{}",
445 }, {
446 desc: "repeated fields set to empty slices",
447 input: &pb2.Repeats{
448 RptBool: []bool{},
449 RptInt32: []int32{},
450 RptInt64: []int64{},
451 RptUint32: []uint32{},
452 RptUint64: []uint64{},
453 RptFloat: []float32{},
454 RptDouble: []float64{},
455 RptBytes: [][]byte{},
456 },
457 want: "{}",
458 }, {
459 desc: "repeated fields set to some values",
460 input: &pb2.Repeats{
461 RptBool: []bool{true, false, true, true},
462 RptInt32: []int32{1, 6, 0, 0},
463 RptInt64: []int64{-64, 47},
464 RptUint32: []uint32{0xff, 0xffff},
465 RptUint64: []uint64{0xdeadbeef},
466 RptFloat: []float32{float32(math.NaN()), float32(math.Inf(1)), float32(math.Inf(-1)), 1.034},
467 RptDouble: []float64{math.NaN(), math.Inf(1), math.Inf(-1), 1.23e-308},
468 RptString: []string{"hello", "世界"},
469 RptBytes: [][]byte{
470 []byte("hello"),
471 []byte("\xe4\xb8\x96\xe7\x95\x8c"),
472 },
473 },
474 want: `{
475 "rptBool": [
476 true,
477 false,
478 true,
479 true
480 ],
481 "rptInt32": [
482 1,
483 6,
484 0,
485 0
486 ],
487 "rptInt64": [
488 "-64",
489 "47"
490 ],
491 "rptUint32": [
492 255,
493 65535
494 ],
495 "rptUint64": [
496 "3735928559"
497 ],
498 "rptFloat": [
499 "NaN",
500 "Infinity",
501 "-Infinity",
502 1.034
503 ],
504 "rptDouble": [
505 "NaN",
506 "Infinity",
507 "-Infinity",
508 1.23e-308
509 ],
510 "rptString": [
511 "hello",
512 "世界"
513 ],
514 "rptBytes": [
515 "aGVsbG8=",
516 "5LiW55WM"
517 ]
518}`,
519 }, {
520 desc: "repeated enums",
521 input: &pb2.Enums{
522 RptEnum: []pb2.Enum{pb2.Enum_ONE, 2, pb2.Enum_TEN, 42},
523 RptNestedEnum: []pb2.Enums_NestedEnum{2, 47, 10},
524 },
525 want: `{
526 "rptEnum": [
527 "ONE",
528 "TWO",
529 "TEN",
530 42
531 ],
532 "rptNestedEnum": [
533 "DOS",
534 47,
535 "DIEZ"
536 ]
537}`,
538 }, {
539 desc: "repeated messages set to empty",
540 input: &pb2.Nests{
541 RptNested: []*pb2.Nested{},
542 Rptgroup: []*pb2.Nests_RptGroup{},
543 },
544 want: "{}",
545 }, {
546 desc: "repeated messages",
547 input: &pb2.Nests{
548 RptNested: []*pb2.Nested{
549 {
550 OptString: scalar.String("repeat nested one"),
551 },
552 {
553 OptString: scalar.String("repeat nested two"),
554 OptNested: &pb2.Nested{
555 OptString: scalar.String("inside repeat nested two"),
556 },
557 },
558 {},
559 },
560 },
561 want: `{
562 "rptNested": [
563 {
564 "optString": "repeat nested one"
565 },
566 {
567 "optString": "repeat nested two",
568 "optNested": {
569 "optString": "inside repeat nested two"
570 }
571 },
572 {}
573 ]
574}`,
575 }, {
576 desc: "repeated messages contains nil value",
577 input: &pb2.Nests{
578 RptNested: []*pb2.Nested{nil, {}},
579 },
580 want: `{
581 "rptNested": [
582 {},
583 {}
584 ]
585}`,
586 }, {
587 desc: "repeated groups",
588 input: &pb2.Nests{
589 Rptgroup: []*pb2.Nests_RptGroup{
590 {
591 RptString: []string{"hello", "world"},
592 },
593 {},
594 nil,
595 },
596 },
597 want: `{
598 "rptgroup": [
599 {
600 "rptString": [
601 "hello",
602 "world"
603 ]
604 },
605 {},
606 {}
607 ]
608}`,
609 }, {
610 desc: "map fields not set",
611 input: &pb3.Maps{},
612 want: "{}",
613 }, {
614 desc: "map fields set to empty",
615 input: &pb3.Maps{
616 Int32ToStr: map[int32]string{},
617 BoolToUint32: map[bool]uint32{},
618 Uint64ToEnum: map[uint64]pb3.Enum{},
619 StrToNested: map[string]*pb3.Nested{},
620 StrToOneofs: map[string]*pb3.Oneofs{},
621 },
622 want: "{}",
623 }, {
624 desc: "map fields 1",
625 input: &pb3.Maps{
626 BoolToUint32: map[bool]uint32{
627 true: 42,
628 false: 101,
629 },
630 },
631 want: `{
632 "boolToUint32": {
633 "false": 101,
634 "true": 42
635 }
636}`,
637 }, {
638 desc: "map fields 2",
639 input: &pb3.Maps{
640 Int32ToStr: map[int32]string{
641 -101: "-101",
642 0xff: "0xff",
643 0: "zero",
644 },
645 },
646 want: `{
647 "int32ToStr": {
648 "-101": "-101",
649 "0": "zero",
650 "255": "0xff"
651 }
652}`,
653 }, {
654 desc: "map fields 3",
655 input: &pb3.Maps{
656 Uint64ToEnum: map[uint64]pb3.Enum{
657 1: pb3.Enum_ONE,
658 2: pb3.Enum_TWO,
659 10: pb3.Enum_TEN,
660 47: 47,
661 },
662 },
663 want: `{
664 "uint64ToEnum": {
665 "1": "ONE",
666 "2": "TWO",
667 "10": "TEN",
668 "47": 47
669 }
670}`,
671 }, {
672 desc: "map fields 4",
673 input: &pb3.Maps{
674 StrToNested: map[string]*pb3.Nested{
675 "nested": &pb3.Nested{
676 SString: "nested in a map",
677 },
678 },
679 },
680 want: `{
681 "strToNested": {
682 "nested": {
683 "sString": "nested in a map"
684 }
685 }
686}`,
687 }, {
688 desc: "map fields 5",
689 input: &pb3.Maps{
690 StrToOneofs: map[string]*pb3.Oneofs{
691 "string": &pb3.Oneofs{
692 Union: &pb3.Oneofs_OneofString{
693 OneofString: "hello",
694 },
695 },
696 "nested": &pb3.Oneofs{
697 Union: &pb3.Oneofs_OneofNested{
698 OneofNested: &pb3.Nested{
699 SString: "nested oneof in map field value",
700 },
701 },
702 },
703 },
704 },
705 want: `{
706 "strToOneofs": {
707 "nested": {
708 "oneofNested": {
709 "sString": "nested oneof in map field value"
710 }
711 },
712 "string": {
713 "oneofString": "hello"
714 }
715 }
716}`,
717 }, {
718 desc: "map field contains nil value",
719 input: &pb3.Maps{
720 StrToNested: map[string]*pb3.Nested{
721 "nil": nil,
722 },
723 },
724 want: `{
725 "strToNested": {
726 "nil": {}
727 }
728}`,
729 }, {
730 desc: "unknown fields are ignored",
731 input: &pb2.Scalars{
732 OptString: scalar.String("no unknowns"),
733 XXX_unrecognized: pack.Message{
734 pack.Tag{101, pack.BytesType}, pack.String("hello world"),
735 }.Marshal(),
736 },
737 want: `{
738 "optString": "no unknowns"
739}`,
740 }, {
741 desc: "json_name",
742 input: &pb3.JSONNames{
743 SString: "json_name",
744 },
745 want: `{
746 "foo_bar": "json_name"
747}`,
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700748 }, {
749 desc: "extensions of non-repeated fields",
750 input: func() proto.Message {
751 m := &pb2.Extensions{
752 OptString: scalar.String("non-extension field"),
753 OptBool: scalar.Bool(true),
754 OptInt32: scalar.Int32(42),
755 }
756 setExtension(m, pb2.E_OptExtBool, true)
757 setExtension(m, pb2.E_OptExtString, "extension field")
758 setExtension(m, pb2.E_OptExtEnum, pb2.Enum_TEN)
759 setExtension(m, pb2.E_OptExtNested, &pb2.Nested{
760 OptString: scalar.String("nested in an extension"),
761 OptNested: &pb2.Nested{
762 OptString: scalar.String("another nested in an extension"),
763 },
764 })
765 return m
766 }(),
767 want: `{
768 "optString": "non-extension field",
769 "optBool": true,
770 "optInt32": 42,
771 "[pb2.opt_ext_bool]": true,
772 "[pb2.opt_ext_enum]": "TEN",
773 "[pb2.opt_ext_nested]": {
774 "optString": "nested in an extension",
775 "optNested": {
776 "optString": "another nested in an extension"
777 }
778 },
779 "[pb2.opt_ext_string]": "extension field"
780}`,
781 }, {
782 desc: "extension message field set to nil",
783 input: func() proto.Message {
784 m := &pb2.Extensions{}
785 setExtension(m, pb2.E_OptExtNested, nil)
786 return m
787 }(),
788 want: "{}",
789 }, {
790 desc: "extensions of repeated fields",
791 input: func() proto.Message {
792 m := &pb2.Extensions{}
793 setExtension(m, pb2.E_RptExtEnum, &[]pb2.Enum{pb2.Enum_TEN, 101, pb2.Enum_ONE})
794 setExtension(m, pb2.E_RptExtFixed32, &[]uint32{42, 47})
795 setExtension(m, pb2.E_RptExtNested, &[]*pb2.Nested{
796 &pb2.Nested{OptString: scalar.String("one")},
797 &pb2.Nested{OptString: scalar.String("two")},
798 &pb2.Nested{OptString: scalar.String("three")},
799 })
800 return m
801 }(),
802 want: `{
803 "[pb2.rpt_ext_enum]": [
804 "TEN",
805 101,
806 "ONE"
807 ],
808 "[pb2.rpt_ext_fixed32]": [
809 42,
810 47
811 ],
812 "[pb2.rpt_ext_nested]": [
813 {
814 "optString": "one"
815 },
816 {
817 "optString": "two"
818 },
819 {
820 "optString": "three"
821 }
822 ]
823}`,
824 }, {
825 desc: "extensions of non-repeated fields in another message",
826 input: func() proto.Message {
827 m := &pb2.Extensions{}
828 setExtension(m, pb2.E_ExtensionsContainer_OptExtBool, true)
829 setExtension(m, pb2.E_ExtensionsContainer_OptExtString, "extension field")
830 setExtension(m, pb2.E_ExtensionsContainer_OptExtEnum, pb2.Enum_TEN)
831 setExtension(m, pb2.E_ExtensionsContainer_OptExtNested, &pb2.Nested{
832 OptString: scalar.String("nested in an extension"),
833 OptNested: &pb2.Nested{
834 OptString: scalar.String("another nested in an extension"),
835 },
836 })
837 return m
838 }(),
839 want: `{
840 "[pb2.ExtensionsContainer.opt_ext_bool]": true,
841 "[pb2.ExtensionsContainer.opt_ext_enum]": "TEN",
842 "[pb2.ExtensionsContainer.opt_ext_nested]": {
843 "optString": "nested in an extension",
844 "optNested": {
845 "optString": "another nested in an extension"
846 }
847 },
848 "[pb2.ExtensionsContainer.opt_ext_string]": "extension field"
849}`,
850 }, {
851 desc: "extensions of repeated fields in another message",
852 input: func() proto.Message {
853 m := &pb2.Extensions{
854 OptString: scalar.String("non-extension field"),
855 OptBool: scalar.Bool(true),
856 OptInt32: scalar.Int32(42),
857 }
858 setExtension(m, pb2.E_ExtensionsContainer_RptExtEnum, &[]pb2.Enum{pb2.Enum_TEN, 101, pb2.Enum_ONE})
859 setExtension(m, pb2.E_ExtensionsContainer_RptExtString, &[]string{"hello", "world"})
860 setExtension(m, pb2.E_ExtensionsContainer_RptExtNested, &[]*pb2.Nested{
861 &pb2.Nested{OptString: scalar.String("one")},
862 &pb2.Nested{OptString: scalar.String("two")},
863 &pb2.Nested{OptString: scalar.String("three")},
864 })
865 return m
866 }(),
867 want: `{
868 "optString": "non-extension field",
869 "optBool": true,
870 "optInt32": 42,
871 "[pb2.ExtensionsContainer.rpt_ext_enum]": [
872 "TEN",
873 101,
874 "ONE"
875 ],
876 "[pb2.ExtensionsContainer.rpt_ext_nested]": [
877 {
878 "optString": "one"
879 },
880 {
881 "optString": "two"
882 },
883 {
884 "optString": "three"
885 }
886 ],
887 "[pb2.ExtensionsContainer.rpt_ext_string]": [
888 "hello",
889 "world"
890 ]
891}`,
892 }, {
893 desc: "MessageSet",
894 input: func() proto.Message {
895 m := &pb2.MessageSet{}
896 setExtension(m, pb2.E_MessageSetExtension_MessageSetExtension, &pb2.MessageSetExtension{
897 OptString: scalar.String("a messageset extension"),
898 })
899 setExtension(m, pb2.E_MessageSetExtension_NotMessageSetExtension, &pb2.MessageSetExtension{
900 OptString: scalar.String("not a messageset extension"),
901 })
902 setExtension(m, pb2.E_MessageSetExtension_ExtNested, &pb2.Nested{
903 OptString: scalar.String("just a regular extension"),
904 })
905 return m
906 }(),
907 want: `{
908 "[pb2.MessageSetExtension]": {
909 "optString": "a messageset extension"
910 },
911 "[pb2.MessageSetExtension.ext_nested]": {
912 "optString": "just a regular extension"
913 },
914 "[pb2.MessageSetExtension.not_message_set_extension]": {
915 "optString": "not a messageset extension"
916 }
917}`,
918 }, {
919 desc: "not real MessageSet 1",
920 input: func() proto.Message {
921 m := &pb2.FakeMessageSet{}
922 setExtension(m, pb2.E_FakeMessageSetExtension_MessageSetExtension, &pb2.FakeMessageSetExtension{
923 OptString: scalar.String("not a messageset extension"),
924 })
925 return m
926 }(),
927 want: `{
928 "[pb2.FakeMessageSetExtension.message_set_extension]": {
929 "optString": "not a messageset extension"
930 }
931}`,
932 }, {
933 desc: "not real MessageSet 2",
934 input: func() proto.Message {
935 m := &pb2.MessageSet{}
936 setExtension(m, pb2.E_MessageSetExtension, &pb2.FakeMessageSetExtension{
937 OptString: scalar.String("another not a messageset extension"),
938 })
939 return m
940 }(),
941 want: `{
942 "[pb2.message_set_extension]": {
943 "optString": "another not a messageset extension"
944 }
945}`,
Herbie Ong0b0f4032019-03-18 19:06:15 -0700946 }, {
947 desc: "BoolValue empty",
948 input: &knownpb.BoolValue{},
949 want: `false`,
950 }, {
951 desc: "BoolValue",
952 input: &knownpb.BoolValue{Value: true},
953 want: `true`,
954 }, {
955 desc: "Int32Value empty",
956 input: &knownpb.Int32Value{},
957 want: `0`,
958 }, {
959 desc: "Int32Value",
960 input: &knownpb.Int32Value{Value: 42},
961 want: `42`,
962 }, {
963 desc: "Int64Value",
964 input: &knownpb.Int64Value{Value: 42},
965 want: `"42"`,
966 }, {
967 desc: "UInt32Value",
968 input: &knownpb.UInt32Value{Value: 42},
969 want: `42`,
970 }, {
971 desc: "UInt64Value",
972 input: &knownpb.UInt64Value{Value: 42},
973 want: `"42"`,
974 }, {
975 desc: "FloatValue",
976 input: &knownpb.FloatValue{Value: 1.02},
977 want: `1.02`,
978 }, {
Herbie Onge63c4c42019-03-22 22:20:22 -0700979 desc: "FloatValue Infinity",
980 input: &knownpb.FloatValue{Value: float32(math.Inf(-1))},
981 want: `"-Infinity"`,
982 }, {
Herbie Ong0b0f4032019-03-18 19:06:15 -0700983 desc: "DoubleValue",
984 input: &knownpb.DoubleValue{Value: 1.02},
985 want: `1.02`,
986 }, {
Herbie Onge63c4c42019-03-22 22:20:22 -0700987 desc: "DoubleValue NaN",
988 input: &knownpb.DoubleValue{Value: math.NaN()},
989 want: `"NaN"`,
990 }, {
Herbie Ong0b0f4032019-03-18 19:06:15 -0700991 desc: "StringValue empty",
992 input: &knownpb.StringValue{},
993 want: `""`,
994 }, {
995 desc: "StringValue",
996 input: &knownpb.StringValue{Value: "谷歌"},
997 want: `"谷歌"`,
998 }, {
999 desc: "StringValue with invalid UTF8 error",
1000 input: &knownpb.StringValue{Value: "abc\xff"},
1001 want: "\"abc\xff\"",
1002 wantErr: true,
1003 }, {
1004 desc: "StringValue field with invalid UTF8 error",
1005 input: &pb2.KnownTypes{
1006 OptString: &knownpb.StringValue{Value: "abc\xff"},
1007 },
1008 want: "{\n \"optString\": \"abc\xff\"\n}",
1009 wantErr: true,
1010 }, {
1011 desc: "BytesValue",
1012 input: &knownpb.BytesValue{Value: []byte("hello")},
1013 want: `"aGVsbG8="`,
1014 }, {
1015 desc: "Empty",
1016 input: &knownpb.Empty{},
1017 want: `{}`,
1018 }, {
Herbie Ong1c7462c2019-03-22 17:56:55 -07001019 desc: "Value empty",
1020 input: &knownpb.Value{},
1021 wantErr: true,
Herbie Ong0b0f4032019-03-18 19:06:15 -07001022 }, {
1023 desc: "Value empty field",
1024 input: &pb2.KnownTypes{
1025 OptValue: &knownpb.Value{},
1026 },
Herbie Ong1c7462c2019-03-22 17:56:55 -07001027 wantErr: true,
Herbie Ong0b0f4032019-03-18 19:06:15 -07001028 }, {
1029 desc: "Value contains NullValue",
1030 input: &knownpb.Value{Kind: &knownpb.Value_NullValue{}},
1031 want: `null`,
1032 }, {
1033 desc: "Value contains BoolValue",
1034 input: &knownpb.Value{Kind: &knownpb.Value_BoolValue{}},
1035 want: `false`,
1036 }, {
1037 desc: "Value contains NumberValue",
1038 input: &knownpb.Value{Kind: &knownpb.Value_NumberValue{1.02}},
1039 want: `1.02`,
1040 }, {
1041 desc: "Value contains StringValue",
1042 input: &knownpb.Value{Kind: &knownpb.Value_StringValue{"hello"}},
1043 want: `"hello"`,
1044 }, {
1045 desc: "Value contains StringValue with invalid UTF8",
1046 input: &knownpb.Value{Kind: &knownpb.Value_StringValue{"\xff"}},
1047 want: "\"\xff\"",
1048 wantErr: true,
1049 }, {
1050 desc: "Value contains Struct",
1051 input: &knownpb.Value{
1052 Kind: &knownpb.Value_StructValue{
1053 &knownpb.Struct{
1054 Fields: map[string]*knownpb.Value{
1055 "null": {Kind: &knownpb.Value_NullValue{}},
1056 "number": {Kind: &knownpb.Value_NumberValue{}},
1057 "string": {Kind: &knownpb.Value_StringValue{}},
1058 "struct": {Kind: &knownpb.Value_StructValue{}},
1059 "list": {Kind: &knownpb.Value_ListValue{}},
1060 "bool": {Kind: &knownpb.Value_BoolValue{}},
1061 },
1062 },
1063 },
1064 },
1065 want: `{
1066 "bool": false,
1067 "list": [],
1068 "null": null,
1069 "number": 0,
1070 "string": "",
1071 "struct": {}
1072}`,
1073 }, {
1074 desc: "Value contains ListValue",
1075 input: &knownpb.Value{
1076 Kind: &knownpb.Value_ListValue{
1077 &knownpb.ListValue{
1078 Values: []*knownpb.Value{
1079 {Kind: &knownpb.Value_BoolValue{}},
1080 {Kind: &knownpb.Value_NullValue{}},
1081 {Kind: &knownpb.Value_NumberValue{}},
1082 {Kind: &knownpb.Value_StringValue{}},
1083 {Kind: &knownpb.Value_StructValue{}},
1084 {Kind: &knownpb.Value_ListValue{}},
1085 },
1086 },
1087 },
1088 },
1089 want: `[
1090 false,
1091 null,
1092 0,
1093 "",
1094 {},
1095 []
1096]`,
1097 }, {
1098 desc: "Struct with nil map",
1099 input: &knownpb.Struct{},
1100 want: `{}`,
1101 }, {
1102 desc: "Struct with empty map",
1103 input: &knownpb.Struct{
1104 Fields: map[string]*knownpb.Value{},
1105 },
1106 want: `{}`,
1107 }, {
1108 desc: "Struct",
1109 input: &knownpb.Struct{
1110 Fields: map[string]*knownpb.Value{
1111 "bool": {Kind: &knownpb.Value_BoolValue{true}},
1112 "null": {Kind: &knownpb.Value_NullValue{}},
1113 "number": {Kind: &knownpb.Value_NumberValue{3.1415}},
1114 "string": {Kind: &knownpb.Value_StringValue{"hello"}},
1115 "struct": {
1116 Kind: &knownpb.Value_StructValue{
1117 &knownpb.Struct{
1118 Fields: map[string]*knownpb.Value{
1119 "string": {Kind: &knownpb.Value_StringValue{"world"}},
1120 },
1121 },
1122 },
1123 },
1124 "list": {
1125 Kind: &knownpb.Value_ListValue{
1126 &knownpb.ListValue{
1127 Values: []*knownpb.Value{
1128 {Kind: &knownpb.Value_BoolValue{}},
1129 {Kind: &knownpb.Value_NullValue{}},
1130 {Kind: &knownpb.Value_NumberValue{}},
1131 },
1132 },
1133 },
1134 },
1135 },
1136 },
1137 want: `{
1138 "bool": true,
1139 "list": [
1140 false,
1141 null,
1142 0
1143 ],
1144 "null": null,
1145 "number": 3.1415,
1146 "string": "hello",
1147 "struct": {
1148 "string": "world"
1149 }
1150}`,
1151 }, {
1152 desc: "Struct message with invalid UTF8 string",
1153 input: &knownpb.Struct{
1154 Fields: map[string]*knownpb.Value{
1155 "string": {Kind: &knownpb.Value_StringValue{"\xff"}},
1156 },
1157 },
1158 want: "{\n \"string\": \"\xff\"\n}",
1159 wantErr: true,
1160 }, {
1161 desc: "ListValue with nil values",
1162 input: &knownpb.ListValue{},
1163 want: `[]`,
1164 }, {
1165 desc: "ListValue with empty values",
1166 input: &knownpb.ListValue{
1167 Values: []*knownpb.Value{},
1168 },
1169 want: `[]`,
1170 }, {
1171 desc: "ListValue",
1172 input: &knownpb.ListValue{
1173 Values: []*knownpb.Value{
1174 {Kind: &knownpb.Value_BoolValue{true}},
1175 {Kind: &knownpb.Value_NullValue{}},
1176 {Kind: &knownpb.Value_NumberValue{3.1415}},
1177 {Kind: &knownpb.Value_StringValue{"hello"}},
1178 {
1179 Kind: &knownpb.Value_ListValue{
1180 &knownpb.ListValue{
1181 Values: []*knownpb.Value{
1182 {Kind: &knownpb.Value_BoolValue{}},
1183 {Kind: &knownpb.Value_NullValue{}},
1184 {Kind: &knownpb.Value_NumberValue{}},
1185 },
1186 },
1187 },
1188 },
1189 {
1190 Kind: &knownpb.Value_StructValue{
1191 &knownpb.Struct{
1192 Fields: map[string]*knownpb.Value{
1193 "string": {Kind: &knownpb.Value_StringValue{"world"}},
1194 },
1195 },
1196 },
1197 },
1198 },
1199 },
1200 want: `[
1201 true,
1202 null,
1203 3.1415,
1204 "hello",
1205 [
1206 false,
1207 null,
1208 0
1209 ],
1210 {
1211 "string": "world"
1212 }
1213]`,
1214 }, {
1215 desc: "ListValue with invalid UTF8 string",
1216 input: &knownpb.ListValue{
1217 Values: []*knownpb.Value{
1218 {Kind: &knownpb.Value_StringValue{"\xff"}},
1219 },
1220 },
1221 want: "[\n \"\xff\"\n]",
1222 wantErr: true,
1223 }, {
1224 desc: "Duration empty",
1225 input: &knownpb.Duration{},
1226 want: `"0s"`,
1227 }, {
1228 desc: "Duration with secs",
1229 input: &knownpb.Duration{Seconds: 3},
1230 want: `"3s"`,
1231 }, {
1232 desc: "Duration with -secs",
1233 input: &knownpb.Duration{Seconds: -3},
1234 want: `"-3s"`,
1235 }, {
1236 desc: "Duration with nanos",
1237 input: &knownpb.Duration{Nanos: 1e6},
1238 want: `"0.001s"`,
1239 }, {
1240 desc: "Duration with -nanos",
1241 input: &knownpb.Duration{Nanos: -1e6},
1242 want: `"-0.001s"`,
1243 }, {
1244 desc: "Duration with large secs",
1245 input: &knownpb.Duration{Seconds: 1e10, Nanos: 1},
1246 want: `"10000000000.000000001s"`,
1247 }, {
1248 desc: "Duration with 6-digit nanos",
1249 input: &knownpb.Duration{Nanos: 1e4},
1250 want: `"0.000010s"`,
1251 }, {
1252 desc: "Duration with 3-digit nanos",
1253 input: &knownpb.Duration{Nanos: 1e6},
1254 want: `"0.001s"`,
1255 }, {
1256 desc: "Duration with -secs -nanos",
1257 input: &knownpb.Duration{Seconds: -123, Nanos: -450},
1258 want: `"-123.000000450s"`,
1259 }, {
1260 desc: "Duration with +secs -nanos",
1261 input: &knownpb.Duration{Seconds: 1, Nanos: -1},
1262 wantErr: true,
1263 }, {
1264 desc: "Duration with -secs +nanos",
1265 input: &knownpb.Duration{Seconds: -1, Nanos: 1},
1266 wantErr: true,
1267 }, {
1268 desc: "Duration with +secs out of range",
1269 input: &knownpb.Duration{Seconds: 315576000001},
1270 wantErr: true,
1271 }, {
1272 desc: "Duration with -secs out of range",
1273 input: &knownpb.Duration{Seconds: -315576000001},
1274 wantErr: true,
1275 }, {
1276 desc: "Duration with +nanos out of range",
1277 input: &knownpb.Duration{Seconds: 0, Nanos: 1e9},
1278 wantErr: true,
1279 }, {
1280 desc: "Duration with -nanos out of range",
1281 input: &knownpb.Duration{Seconds: 0, Nanos: -1e9},
1282 wantErr: true,
1283 }, {
1284 desc: "Timestamp zero",
1285 input: &knownpb.Timestamp{},
1286 want: `"1970-01-01T00:00:00Z"`,
1287 }, {
1288 desc: "Timestamp",
1289 input: &knownpb.Timestamp{Seconds: 1553036601},
1290 want: `"2019-03-19T23:03:21Z"`,
1291 }, {
1292 desc: "Timestamp with nanos",
1293 input: &knownpb.Timestamp{Seconds: 1553036601, Nanos: 1},
1294 want: `"2019-03-19T23:03:21.000000001Z"`,
1295 }, {
1296 desc: "Timestamp with 6-digit nanos",
1297 input: &knownpb.Timestamp{Nanos: 1e3},
1298 want: `"1970-01-01T00:00:00.000001Z"`,
1299 }, {
1300 desc: "Timestamp with 3-digit nanos",
1301 input: &knownpb.Timestamp{Nanos: 1e7},
1302 want: `"1970-01-01T00:00:00.010Z"`,
1303 }, {
1304 desc: "Timestamp with +secs out of range",
1305 input: &knownpb.Timestamp{Seconds: 253402300800},
1306 wantErr: true,
1307 }, {
1308 desc: "Timestamp with -secs out of range",
1309 input: &knownpb.Timestamp{Seconds: -62135596801},
1310 wantErr: true,
1311 }, {
1312 desc: "Timestamp with -nanos",
1313 input: &knownpb.Timestamp{Nanos: -1},
1314 wantErr: true,
1315 }, {
1316 desc: "Timestamp with +nanos out of range",
1317 input: &knownpb.Timestamp{Nanos: 1e9},
1318 wantErr: true,
1319 }, {
1320 desc: "FieldMask empty",
1321 input: &knownpb.FieldMask{},
1322 want: `""`,
1323 }, {
1324 desc: "FieldMask",
1325 input: &knownpb.FieldMask{
1326 Paths: []string{
1327 "foo",
1328 "foo_bar",
1329 "foo.bar_qux",
1330 "_foo",
1331 },
1332 },
1333 want: `"foo,fooBar,foo.barQux,Foo"`,
1334 }, {
1335 desc: "FieldMask error 1",
1336 input: &knownpb.FieldMask{
1337 Paths: []string{"foo_"},
1338 },
1339 wantErr: true,
1340 }, {
1341 desc: "FieldMask error 2",
1342 input: &knownpb.FieldMask{
1343 Paths: []string{"foo__bar"},
1344 },
1345 wantErr: true,
1346 }, {
1347 desc: "Any empty",
1348 input: &knownpb.Any{},
1349 want: `{}`,
1350 }, {
1351 desc: "Any",
1352 mo: jsonpb.MarshalOptions{
1353 Resolver: preg.NewTypes((&pb2.Nested{}).ProtoReflect().Type()),
1354 },
1355 input: func() proto.Message {
1356 m := &pb2.Nested{
1357 OptString: scalar.String("embedded inside Any"),
1358 OptNested: &pb2.Nested{
1359 OptString: scalar.String("inception"),
1360 },
1361 }
1362 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1363 if err != nil {
1364 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1365 }
1366 return &knownpb.Any{
1367 TypeUrl: "foo/pb2.Nested",
1368 Value: b,
1369 }
1370 }(),
1371 want: `{
1372 "@type": "foo/pb2.Nested",
1373 "optString": "embedded inside Any",
1374 "optNested": {
1375 "optString": "inception"
1376 }
1377}`,
1378 }, {
1379 desc: "Any without value",
1380 mo: jsonpb.MarshalOptions{
1381 Resolver: preg.NewTypes((&pb2.Nested{}).ProtoReflect().Type()),
1382 },
1383 input: &knownpb.Any{TypeUrl: "foo/pb2.Nested"},
1384 want: `{
1385 "@type": "foo/pb2.Nested"
1386}`,
1387 }, {
1388 desc: "Any without registered type",
1389 mo: jsonpb.MarshalOptions{Resolver: preg.NewTypes()},
1390 input: func() proto.Message {
1391 return &knownpb.Any{TypeUrl: "foo/pb2.Nested"}
1392 }(),
1393 wantErr: true,
1394 }, {
1395 desc: "Any with missing required error",
1396 mo: jsonpb.MarshalOptions{
1397 Resolver: preg.NewTypes((&pb2.PartialRequired{}).ProtoReflect().Type()),
1398 },
1399 input: func() proto.Message {
1400 m := &pb2.PartialRequired{
1401 OptString: scalar.String("embedded inside Any"),
1402 }
1403 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1404 // TODO: Marshal may fail due to required field not set at some
1405 // point. Need to ignore required not set error here.
1406 if err != nil {
1407 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1408 }
1409 return &knownpb.Any{
1410 TypeUrl: string(m.ProtoReflect().Type().FullName()),
1411 Value: b,
1412 }
1413 }(),
1414 want: `{
1415 "@type": "pb2.PartialRequired",
1416 "optString": "embedded inside Any"
1417}`,
1418 wantErr: true,
1419 }, {
1420 desc: "Any with invalid UTF8",
1421 mo: jsonpb.MarshalOptions{
1422 Resolver: preg.NewTypes((&pb2.Nested{}).ProtoReflect().Type()),
1423 },
1424 input: func() proto.Message {
1425 m := &pb2.Nested{
1426 OptString: scalar.String("abc\xff"),
1427 }
1428 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1429 if err != nil {
1430 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1431 }
1432 return &knownpb.Any{
1433 TypeUrl: "foo/pb2.Nested",
1434 Value: b,
1435 }
1436 }(),
1437 want: `{
1438 "@type": "foo/pb2.Nested",
1439 "optString": "` + "abc\xff" + `"
1440}`,
1441 wantErr: true,
1442 }, {
1443 desc: "Any with invalid value",
1444 mo: jsonpb.MarshalOptions{
1445 Resolver: preg.NewTypes((&pb2.Nested{}).ProtoReflect().Type()),
1446 },
1447 input: &knownpb.Any{
1448 TypeUrl: "foo/pb2.Nested",
1449 Value: dhex("80"),
1450 },
1451 wantErr: true,
1452 }, {
1453 desc: "Any with BoolValue",
1454 mo: jsonpb.MarshalOptions{
1455 Resolver: preg.NewTypes((&knownpb.BoolValue{}).ProtoReflect().Type()),
1456 },
1457 input: func() proto.Message {
1458 m := &knownpb.BoolValue{Value: true}
1459 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1460 if err != nil {
1461 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1462 }
1463 return &knownpb.Any{
1464 TypeUrl: "type.googleapis.com/google.protobuf.BoolValue",
1465 Value: b,
1466 }
1467 }(),
1468 want: `{
1469 "@type": "type.googleapis.com/google.protobuf.BoolValue",
1470 "value": true
1471}`,
1472 }, {
1473 // TODO: Need clarification on the specification for this. See
1474 // https://github.com/protocolbuffers/protobuf/issues/5390
1475 desc: "Any with Empty",
1476 mo: jsonpb.MarshalOptions{
1477 Resolver: preg.NewTypes((&knownpb.Empty{}).ProtoReflect().Type()),
1478 },
1479 input: func() proto.Message {
1480 m := &knownpb.Empty{}
1481 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1482 if err != nil {
1483 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1484 }
1485 return &knownpb.Any{
1486 TypeUrl: "type.googleapis.com/google.protobuf.Empty",
1487 Value: b,
1488 }
1489 }(),
1490 want: `{
1491 "@type": "type.googleapis.com/google.protobuf.Empty"
1492}`,
1493 }, {
1494 desc: "Any with StringValue containing invalid UTF8",
1495 mo: jsonpb.MarshalOptions{
1496 Resolver: preg.NewTypes((&knownpb.StringValue{}).ProtoReflect().Type()),
1497 },
1498 input: func() proto.Message {
1499 m := &knownpb.StringValue{Value: "abc\xff"}
1500 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1501 if err != nil {
1502 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1503 }
1504 return &knownpb.Any{
1505 TypeUrl: "google.protobuf.StringValue",
1506 Value: b,
1507 }
1508 }(),
1509 want: `{
1510 "@type": "google.protobuf.StringValue",
1511 "value": "` + "abc\xff" + `"
1512}`,
1513 wantErr: true,
1514 }, {
1515 desc: "Any with Value of StringValue",
1516 mo: jsonpb.MarshalOptions{
1517 Resolver: preg.NewTypes((&knownpb.Value{}).ProtoReflect().Type()),
1518 },
1519 input: func() proto.Message {
1520 m := &knownpb.Value{Kind: &knownpb.Value_StringValue{"abc\xff"}}
1521 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1522 if err != nil {
1523 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1524 }
1525 return &knownpb.Any{
1526 TypeUrl: "type.googleapis.com/google.protobuf.Value",
1527 Value: b,
1528 }
1529 }(),
1530 want: `{
1531 "@type": "type.googleapis.com/google.protobuf.Value",
1532 "value": "` + "abc\xff" + `"
1533}`,
1534 wantErr: true,
1535 }, {
1536 desc: "Any with empty Value",
1537 mo: jsonpb.MarshalOptions{
1538 Resolver: preg.NewTypes((&knownpb.Value{}).ProtoReflect().Type()),
1539 },
1540 input: func() proto.Message {
1541 m := &knownpb.Value{}
Herbie Ong1c7462c2019-03-22 17:56:55 -07001542 b, err := proto.Marshal(m)
Herbie Ong0b0f4032019-03-18 19:06:15 -07001543 if err != nil {
1544 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1545 }
1546 return &knownpb.Any{
1547 TypeUrl: "type.googleapis.com/google.protobuf.Value",
1548 Value: b,
1549 }
1550 }(),
Herbie Ong1c7462c2019-03-22 17:56:55 -07001551 wantErr: true,
Herbie Ong0b0f4032019-03-18 19:06:15 -07001552 }, {
1553 desc: "Any with Duration",
1554 mo: jsonpb.MarshalOptions{
1555 Resolver: preg.NewTypes((&knownpb.Duration{}).ProtoReflect().Type()),
1556 },
1557 input: func() proto.Message {
1558 m := &knownpb.Duration{}
1559 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1560 if err != nil {
1561 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1562 }
1563 return &knownpb.Any{
1564 TypeUrl: "type.googleapis.com/google.protobuf.Duration",
1565 Value: b,
1566 }
1567 }(),
1568 want: `{
1569 "@type": "type.googleapis.com/google.protobuf.Duration",
1570 "value": "0s"
1571}`,
1572 }, {
1573 desc: "Any with Struct",
1574 mo: jsonpb.MarshalOptions{
1575 Resolver: preg.NewTypes(
1576 (&knownpb.Struct{}).ProtoReflect().Type(),
1577 (&knownpb.Value{}).ProtoReflect().Type(),
1578 (&knownpb.BoolValue{}).ProtoReflect().Type(),
1579 knownpb.NullValue_NULL_VALUE.Type(),
1580 (&knownpb.StringValue{}).ProtoReflect().Type(),
1581 ),
1582 },
1583 input: func() proto.Message {
1584 m := &knownpb.Struct{
1585 Fields: map[string]*knownpb.Value{
1586 "bool": {Kind: &knownpb.Value_BoolValue{true}},
1587 "null": {Kind: &knownpb.Value_NullValue{}},
1588 "string": {Kind: &knownpb.Value_StringValue{"hello"}},
1589 "struct": {
1590 Kind: &knownpb.Value_StructValue{
1591 &knownpb.Struct{
1592 Fields: map[string]*knownpb.Value{
1593 "string": {Kind: &knownpb.Value_StringValue{"world"}},
1594 },
1595 },
1596 },
1597 },
1598 },
1599 }
1600 b, err := proto.MarshalOptions{Deterministic: true}.Marshal(m)
1601 if err != nil {
1602 t.Fatalf("error in binary marshaling message for Any.value: %v", err)
1603 }
1604 return &knownpb.Any{
1605 TypeUrl: "google.protobuf.Struct",
1606 Value: b,
1607 }
1608 }(),
1609 want: `{
1610 "@type": "google.protobuf.Struct",
1611 "value": {
1612 "bool": true,
1613 "null": null,
1614 "string": "hello",
1615 "struct": {
1616 "string": "world"
1617 }
1618 }
1619}`,
1620 }, {
1621 desc: "well known types as field values",
1622 mo: jsonpb.MarshalOptions{
1623 Resolver: preg.NewTypes((&knownpb.Empty{}).ProtoReflect().Type()),
1624 },
1625 input: &pb2.KnownTypes{
1626 OptBool: &knownpb.BoolValue{Value: false},
1627 OptInt32: &knownpb.Int32Value{Value: 42},
1628 OptInt64: &knownpb.Int64Value{Value: 42},
1629 OptUint32: &knownpb.UInt32Value{Value: 42},
1630 OptUint64: &knownpb.UInt64Value{Value: 42},
1631 OptFloat: &knownpb.FloatValue{Value: 1.23},
1632 OptDouble: &knownpb.DoubleValue{Value: 3.1415},
1633 OptString: &knownpb.StringValue{Value: "hello"},
1634 OptBytes: &knownpb.BytesValue{Value: []byte("hello")},
1635 OptDuration: &knownpb.Duration{Seconds: 123},
1636 OptTimestamp: &knownpb.Timestamp{Seconds: 1553036601},
1637 OptStruct: &knownpb.Struct{
1638 Fields: map[string]*knownpb.Value{
1639 "string": {Kind: &knownpb.Value_StringValue{"hello"}},
1640 },
1641 },
1642 OptList: &knownpb.ListValue{
1643 Values: []*knownpb.Value{
1644 {Kind: &knownpb.Value_NullValue{}},
1645 {Kind: &knownpb.Value_StringValue{}},
1646 {Kind: &knownpb.Value_StructValue{}},
1647 {Kind: &knownpb.Value_ListValue{}},
1648 },
1649 },
Herbie Ong1c7462c2019-03-22 17:56:55 -07001650 OptValue: &knownpb.Value{
1651 Kind: &knownpb.Value_StringValue{"world"},
1652 },
Herbie Ong0b0f4032019-03-18 19:06:15 -07001653 OptEmpty: &knownpb.Empty{},
1654 OptAny: &knownpb.Any{
1655 TypeUrl: "google.protobuf.Empty",
1656 },
1657 OptFieldmask: &knownpb.FieldMask{
1658 Paths: []string{"foo_bar", "bar_foo"},
1659 },
1660 },
1661 want: `{
1662 "optBool": false,
1663 "optInt32": 42,
1664 "optInt64": "42",
1665 "optUint32": 42,
1666 "optUint64": "42",
1667 "optFloat": 1.23,
1668 "optDouble": 3.1415,
1669 "optString": "hello",
1670 "optBytes": "aGVsbG8=",
1671 "optDuration": "123s",
1672 "optTimestamp": "2019-03-19T23:03:21Z",
1673 "optStruct": {
1674 "string": "hello"
1675 },
1676 "optList": [
1677 null,
1678 "",
1679 {},
1680 []
1681 ],
Herbie Ong1c7462c2019-03-22 17:56:55 -07001682 "optValue": "world",
Herbie Ong0b0f4032019-03-18 19:06:15 -07001683 "optEmpty": {},
1684 "optAny": {
1685 "@type": "google.protobuf.Empty"
1686 },
1687 "optFieldmask": "fooBar,barFoo"
1688}`,
Herbie Ong7b828bc2019-02-08 19:56:24 -08001689 }}
1690
1691 for _, tt := range tests {
1692 tt := tt
1693 t.Run(tt.desc, func(t *testing.T) {
Herbie Ong0b0f4032019-03-18 19:06:15 -07001694 // Use 2-space indentation on all MarshalOptions.
1695 tt.mo.Indent = " "
Herbie Ong7b828bc2019-02-08 19:56:24 -08001696 b, err := tt.mo.Marshal(tt.input)
Herbie Ong0b0f4032019-03-18 19:06:15 -07001697 if err != nil && !tt.wantErr {
Herbie Ong7b828bc2019-02-08 19:56:24 -08001698 t.Errorf("Marshal() returned error: %v\n", err)
1699 }
Herbie Ong0b0f4032019-03-18 19:06:15 -07001700 if err == nil && tt.wantErr {
1701 t.Errorf("Marshal() got nil error, want error\n")
1702 }
Herbie Ong7b828bc2019-02-08 19:56:24 -08001703 got := string(b)
1704 if got != tt.want {
1705 t.Errorf("Marshal()\n<got>\n%v\n<want>\n%v\n", got, tt.want)
1706 if diff := cmp.Diff(tt.want, got, splitLines); diff != "" {
1707 t.Errorf("Marshal() diff -want +got\n%v\n", diff)
1708 }
1709 }
1710 })
1711 }
1712}