| Server IP : 147.93.80.58 / Your IP : 216.73.216.75 Web Server : LiteSpeed System : Linux id-dci-web1866.main-hosting.eu 5.14.0-503.38.1.el9_5.x86_64 #1 SMP PREEMPT_DYNAMIC Fri Apr 18 08:52:10 EDT 2025 x86_64 User : u939086737 ( 939086737) PHP Version : 8.2.28 Disable Function : system, exec, shell_exec, passthru, mysql_list_dbs, ini_alter, dl, symlink, link, chgrp, leak, popen, apache_child_terminate, virtual, mb_send_mail MySQL : OFF | cURL : ON | WGET : ON | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /proc/thread-self/root/opt/go/pkg/mod/go.mongodb.org/mongo-driver@v1.14.0/bson/ |
Upload File : |
// 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")
})
}
}