File: encoder_test.go

package info (click to toggle)
golang-mongodb-mongo-driver 1.17.1%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental, sid, trixie
  • size: 25,988 kB
  • sloc: perl: 533; ansic: 491; python: 432; sh: 327; makefile: 174
file content (315 lines) | stat: -rw-r--r-- 8,544 bytes parent folder | download
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
// Copyright (C) MongoDB, Inc. 2017-present.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

package bson

import (
	"bytes"
	"errors"
	"reflect"
	"testing"

	"go.mongodb.org/mongo-driver/bson/bsoncodec"
	"go.mongodb.org/mongo-driver/bson/bsonrw"
	"go.mongodb.org/mongo-driver/bson/bsonrw/bsonrwtest"
	"go.mongodb.org/mongo-driver/bson/bsontype"
	"go.mongodb.org/mongo-driver/internal/assert"
	"go.mongodb.org/mongo-driver/internal/require"
	"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
)

func TestBasicEncode(t *testing.T) {
	for _, tc := range marshalingTestCases {
		t.Run(tc.name, func(t *testing.T) {
			got := make(bsonrw.SliceWriter, 0, 1024)
			vw, err := bsonrw.NewBSONValueWriter(&got)
			noerr(t, err)
			reg := DefaultRegistry
			encoder, err := reg.LookupEncoder(reflect.TypeOf(tc.val))
			noerr(t, err)
			err = encoder.EncodeValue(bsoncodec.EncodeContext{Registry: reg}, vw, reflect.ValueOf(tc.val))
			noerr(t, err)

			if !bytes.Equal(got, tc.want) {
				t.Errorf("Bytes are not equal. got %v; want %v", got, tc.want)
				t.Errorf("Bytes:\n%v\n%v", got, tc.want)
			}
		})
	}
}

func TestEncoderEncode(t *testing.T) {
	for _, tc := range marshalingTestCases {
		t.Run(tc.name, func(t *testing.T) {
			got := make(bsonrw.SliceWriter, 0, 1024)
			vw, err := bsonrw.NewBSONValueWriter(&got)
			noerr(t, err)
			enc, err := NewEncoder(vw)
			noerr(t, err)
			err = enc.Encode(tc.val)
			noerr(t, err)

			if !bytes.Equal(got, tc.want) {
				t.Errorf("Bytes are not equal. got %v; want %v", got, tc.want)
				t.Errorf("Bytes:\n%v\n%v", got, tc.want)
			}
		})
	}

	t.Run("Marshaler", func(t *testing.T) {
		testCases := []struct {
			name    string
			buf     []byte
			err     error
			wanterr error
			vw      bsonrw.ValueWriter
		}{
			{
				"error",
				nil,
				errors.New("Marshaler error"),
				errors.New("Marshaler error"),
				&bsonrwtest.ValueReaderWriter{},
			},
			{
				"copy error",
				[]byte{0x05, 0x00, 0x00, 0x00, 0x00},
				nil,
				errors.New("copy error"),
				&bsonrwtest.ValueReaderWriter{Err: errors.New("copy error"), ErrAfter: bsonrwtest.WriteDocument},
			},
			{
				"success",
				[]byte{0x07, 0x00, 0x00, 0x00, 0x0A, 0x00, 0x00},
				nil,
				nil,
				nil,
			},
		}

		for _, tc := range testCases {
			t.Run(tc.name, func(t *testing.T) {
				marshaler := testMarshaler{buf: tc.buf, err: tc.err}

				var vw bsonrw.ValueWriter
				var err error
				b := make(bsonrw.SliceWriter, 0, 100)
				compareVW := false
				if tc.vw != nil {
					vw = tc.vw
				} else {
					compareVW = true
					vw, err = bsonrw.NewBSONValueWriter(&b)
					noerr(t, err)
				}
				enc, err := NewEncoder(vw)
				noerr(t, err)
				got := enc.Encode(marshaler)
				want := tc.wanterr
				if !compareErrors(got, want) {
					t.Errorf("Did not receive expected error. got %v; want %v", got, want)
				}
				if compareVW {
					buf := b
					if !bytes.Equal(buf, tc.buf) {
						t.Errorf("Copied bytes do not match. got %v; want %v", buf, tc.buf)
					}
				}
			})
		}
	})
}

type testMarshaler struct {
	buf []byte
	err error
}

func (tm testMarshaler) MarshalBSON() ([]byte, error) { return tm.buf, tm.err }

func docToBytes(d interface{}) []byte {
	b, err := Marshal(d)
	if err != nil {
		panic(err)
	}
	return b
}

type stringerTest struct{}

func (stringerTest) String() string {
	return "test key"
}

func TestEncoderConfiguration(t *testing.T) {
	type inlineDuplicateInner struct {
		Duplicate string
	}

	type inlineDuplicateOuter struct {
		Inline    inlineDuplicateInner `bson:",inline"`
		Duplicate string
	}

	type zeroStruct struct {
		MyString string
	}

	testCases := []struct {
		description string
		configure   func(*Encoder)
		input       interface{}
		want        []byte
		wantErr     error
	}{
		// Test that ErrorOnInlineDuplicates causes the Encoder to return an error if there are any
		// duplicate fields in the marshaled document caused by using the "inline" struct tag.
		{
			description: "ErrorOnInlineDuplicates",
			configure: func(enc *Encoder) {
				enc.ErrorOnInlineDuplicates()
			},
			input: inlineDuplicateOuter{
				Inline:    inlineDuplicateInner{Duplicate: "inner"},
				Duplicate: "outer",
			},
			wantErr: errors.New("struct bson.inlineDuplicateOuter has duplicated key duplicate"),
		},
		// Test that IntMinSize encodes Go int and int64 values as BSON int32 if the value is small
		// enough.
		{
			description: "IntMinSize",
			configure: func(enc *Encoder) {
				enc.IntMinSize()
			},
			input: D{
				{Key: "myInt", Value: int(1)},
				{Key: "myInt64", Value: int64(1)},
				{Key: "myUint", Value: uint(1)},
				{Key: "myUint32", Value: uint32(1)},
				{Key: "myUint64", Value: uint64(1)},
			},
			want: bsoncore.NewDocumentBuilder().
				AppendInt32("myInt", 1).
				AppendInt32("myInt64", 1).
				AppendInt32("myUint", 1).
				AppendInt32("myUint32", 1).
				AppendInt32("myUint64", 1).
				Build(),
		},
		// Test that StringifyMapKeysWithFmt uses fmt.Sprint to convert map keys to BSON field names.
		{
			description: "StringifyMapKeysWithFmt",
			configure: func(enc *Encoder) {
				enc.StringifyMapKeysWithFmt()
			},
			input: map[stringerTest]string{
				{}: "test value",
			},
			want: bsoncore.NewDocumentBuilder().
				AppendString("test key", "test value").
				Build(),
		},
		// Test that NilMapAsEmpty encodes nil Go maps as empty BSON documents.
		{
			description: "NilMapAsEmpty",
			configure: func(enc *Encoder) {
				enc.NilMapAsEmpty()
			},
			input: D{{Key: "myMap", Value: map[string]string(nil)}},
			want: bsoncore.NewDocumentBuilder().
				AppendDocument("myMap", bsoncore.NewDocumentBuilder().Build()).
				Build(),
		},
		// Test that NilSliceAsEmpty encodes nil Go slices as empty BSON arrays.
		{
			description: "NilSliceAsEmpty",
			configure: func(enc *Encoder) {
				enc.NilSliceAsEmpty()
			},
			input: D{{Key: "mySlice", Value: []string(nil)}},
			want: bsoncore.NewDocumentBuilder().
				AppendArray("mySlice", bsoncore.NewArrayBuilder().Build()).
				Build(),
		},
		// Test that NilByteSliceAsEmpty encodes nil Go byte slices as empty BSON binary elements.
		{
			description: "NilByteSliceAsEmpty",
			configure: func(enc *Encoder) {
				enc.NilByteSliceAsEmpty()
			},
			input: D{{Key: "myBytes", Value: []byte(nil)}},
			want: bsoncore.NewDocumentBuilder().
				AppendBinary("myBytes", bsontype.BinaryGeneric, []byte{}).
				Build(),
		},
		// Test that OmitZeroStruct omits empty structs from the marshaled document if the
		// "omitempty" struct tag is used.
		{
			description: "OmitZeroStruct",
			configure: func(enc *Encoder) {
				enc.OmitZeroStruct()
			},
			input: struct {
				Zero zeroStruct `bson:",omitempty"`
			}{},
			want: bsoncore.NewDocumentBuilder().Build(),
		},
		// Test that UseJSONStructTags causes the Encoder to fall back to "json" struct tags if
		// "bson" struct tags are not available.
		{
			description: "UseJSONStructTags",
			configure: func(enc *Encoder) {
				enc.UseJSONStructTags()
			},
			input: struct {
				StructFieldName string `json:"jsonFieldName"`
			}{
				StructFieldName: "test value",
			},
			want: bsoncore.NewDocumentBuilder().
				AppendString("jsonFieldName", "test value").
				Build(),
		},
	}

	for _, tc := range testCases {
		tc := tc // Capture range variable.

		t.Run(tc.description, func(t *testing.T) {
			t.Parallel()

			got := new(bytes.Buffer)
			vw, err := bsonrw.NewBSONValueWriter(got)
			require.NoError(t, err, "bsonrw.NewBSONValueWriter error")
			enc, err := NewEncoder(vw)
			require.NoError(t, err, "NewEncoder error")

			tc.configure(enc)

			err = enc.Encode(tc.input)
			if tc.wantErr != nil {
				assert.Equal(t, tc.wantErr, err, "expected and actual errors do not match")
				return
			}
			require.NoError(t, err, "Encode error")

			assert.Equal(t, tc.want, got.Bytes(), "expected and actual encoded BSON do not match")

			// After we compare the raw bytes, also decode the expected and actual BSON as a bson.D
			// and compare them. The goal is to make assertion failures easier to debug because
			// binary diffs are very difficult to understand.
			var wantDoc D
			err = Unmarshal(tc.want, &wantDoc)
			require.NoError(t, err, "Unmarshal error")
			var gotDoc D
			err = Unmarshal(got.Bytes(), &gotDoc)
			require.NoError(t, err, "Unmarshal error")

			assert.Equal(t, wantDoc, gotDoc, "expected and actual decoded documents do not match")
		})
	}
}