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
|
// 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 mongo
import (
"context"
"fmt"
"testing"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/internal/assert"
"go.mongodb.org/mongo-driver/internal/require"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
"go.mongodb.org/mongo-driver/x/mongo/driver"
)
type testBatchCursor struct {
batches []*bsoncore.DocumentSequence
batch *bsoncore.DocumentSequence
closed bool
}
func newTestBatchCursor(numBatches, batchSize int) *testBatchCursor {
batches := make([]*bsoncore.DocumentSequence, 0, numBatches)
counter := 0
for batch := 0; batch < numBatches; batch++ {
var docSequence []byte
for doc := 0; doc < batchSize; doc++ {
var elem []byte
elem = bsoncore.AppendInt32Element(elem, "foo", int32(counter))
counter++
var doc []byte
doc = bsoncore.BuildDocumentFromElements(doc, elem)
docSequence = append(docSequence, doc...)
}
batches = append(batches, &bsoncore.DocumentSequence{
Style: bsoncore.SequenceStyle,
Data: docSequence,
})
}
return &testBatchCursor{
batches: batches,
}
}
func (tbc *testBatchCursor) ID() int64 {
if len(tbc.batches) == 0 {
return 0 // cursor exhausted
}
return 10
}
func (tbc *testBatchCursor) Next(context.Context) bool {
if len(tbc.batches) == 0 {
return false
}
tbc.batch = tbc.batches[0]
tbc.batches = tbc.batches[1:]
return true
}
func (tbc *testBatchCursor) Batch() *bsoncore.DocumentSequence {
return tbc.batch
}
func (tbc *testBatchCursor) Server() driver.Server {
return nil
}
func (tbc *testBatchCursor) Err() error {
return nil
}
func (tbc *testBatchCursor) Close(context.Context) error {
tbc.closed = true
return nil
}
func (tbc *testBatchCursor) SetBatchSize(int32) {}
func (tbc *testBatchCursor) SetComment(interface{}) {}
func (tbc *testBatchCursor) SetMaxTime(time.Duration) {}
func TestCursor(t *testing.T) {
t.Run("TestAll", func(t *testing.T) {
t.Run("errors if argument is not pointer to slice", func(t *testing.T) {
cursor, err := newCursor(newTestBatchCursor(1, 5), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
err = cursor.All(context.Background(), []bson.D{})
assert.Error(t, err, "expected error, got nil")
})
t.Run("fills slice with all documents", func(t *testing.T) {
cursor, err := newCursor(newTestBatchCursor(1, 5), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
var docs []bson.D
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.Len(t, docs, 5, "expected 5 docs, got %v", len(docs))
for index, doc := range docs {
expected := bson.D{{"foo", int32(index)}}
assert.Equal(t, expected, doc, "expected doc %v, got %v", expected, doc)
}
})
t.Run("nil slice", func(t *testing.T) {
cursor, err := newCursor(newTestBatchCursor(0, 0), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
var docs []bson.D
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.Nil(t, docs, "expected nil docs")
})
t.Run("empty slice", func(t *testing.T) {
cursor, err := newCursor(newTestBatchCursor(0, 0), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
docs := []bson.D{}
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.NotNil(t, docs, "expected non-nil docs")
assert.Len(t, docs, 0, "expected 0 docs, got %v", len(docs))
})
t.Run("empty slice overwritten", func(t *testing.T) {
cursor, err := newCursor(newTestBatchCursor(0, 0), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
docs := []bson.D{{{"foo", "bar"}}, {{"hello", "world"}, {"pi", 3.14159}}}
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.NotNil(t, docs, "expected non-nil docs")
assert.Len(t, docs, 0, "expected 0 docs, got %v", len(docs))
})
t.Run("decodes each document into slice type", func(t *testing.T) {
cursor, err := newCursor(newTestBatchCursor(1, 5), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
type Document struct {
Foo int32 `bson:"foo"`
}
var docs []Document
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.Len(t, docs, 5, "expected 5 documents, got %v", len(docs))
for index, doc := range docs {
expected := Document{Foo: int32(index)}
assert.Equal(t, expected, doc, "expected doc %v, got %v", expected, doc)
}
})
t.Run("multiple batches are included", func(t *testing.T) {
cursor, err := newCursor(newTestBatchCursor(2, 5), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
var docs []bson.D
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.Len(t, docs, 10, "expected 10 docs, got %v", len(docs))
for index, doc := range docs {
expected := bson.D{{"foo", int32(index)}}
assert.Equal(t, expected, doc, "expected doc %v, got %v", expected, doc)
}
})
t.Run("cursor is closed after All is called", func(t *testing.T) {
var docs []bson.D
tbc := newTestBatchCursor(1, 5)
cursor, err := newCursor(tbc, nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.True(t, tbc.closed, "expected batch cursor to be closed but was not")
})
t.Run("does not error given interface as parameter", func(t *testing.T) {
var docs interface{} = []bson.D{}
cursor, err := newCursor(newTestBatchCursor(1, 5), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
err = cursor.All(context.Background(), &docs)
require.NoError(t, err, "All error: %v", err)
assert.Len(t, docs.([]bson.D), 5, "expected 5 documents, got %v", len(docs.([]bson.D)))
})
t.Run("errors when not given pointer to slice", func(t *testing.T) {
var docs interface{} = "test"
cursor, err := newCursor(newTestBatchCursor(1, 5), nil, nil)
require.NoError(t, err, "newCursor error: %v", err)
err = cursor.All(context.Background(), &docs)
assert.Error(t, err, "expected error, got: %v", err)
})
t.Run("with BSONOptions", func(t *testing.T) {
cursor, err := newCursor(
newTestBatchCursor(1, 5),
&options.BSONOptions{
UseJSONStructTags: true,
},
nil)
require.NoError(t, err, "newCursor error: %v", err)
type myDocument struct {
A int32 `json:"foo"`
}
var got []myDocument
err = cursor.All(context.Background(), &got)
require.NoError(t, err, "All error: %v", err)
want := []myDocument{{A: 0}, {A: 1}, {A: 2}, {A: 3}, {A: 4}}
assert.Equal(t, want, got, "expected and actual All results are different")
})
})
}
func TestNewCursorFromDocuments(t *testing.T) {
// Mock documents returned by Find in a Cursor.
t.Run("mock Find", func(t *testing.T) {
findResult := []interface{}{
bson.D{{"_id", 0}, {"foo", "bar"}},
bson.D{{"_id", 1}, {"baz", "qux"}},
bson.D{{"_id", 2}, {"quux", "quuz"}},
}
cur, err := NewCursorFromDocuments(findResult, nil, nil)
require.NoError(t, err, "NewCursorFromDocuments error: %v", err)
// Assert that decoded documents are as expected.
var i int
for cur.Next(context.Background()) {
docBytes, err := bson.Marshal(findResult[i])
require.NoError(t, err, "Marshal error: %v", err)
expectedDecoded := bson.Raw(docBytes)
var decoded bson.Raw
err = cur.Decode(&decoded)
require.NoError(t, err, "Decode error: %v", err)
assert.Equal(t, expectedDecoded, decoded,
"expected decoded document %v of Cursor to be %v, got %v",
i, expectedDecoded, decoded)
i++
}
assert.Equal(t, 3, i, "expected 3 calls to cur.Next, got %v", i)
// Check for error on Cursor.
require.NoError(t, cur.Err(), "Cursor error: %v", cur.Err())
// Assert that a call to cur.Close will not fail.
err = cur.Close(context.Background())
require.NoError(t, err, "Close error: %v", err)
})
// Mock an error in a Cursor.
t.Run("mock Find with error", func(t *testing.T) {
mockErr := fmt.Errorf("mock error")
findResult := []interface{}{bson.D{{"_id", 0}, {"foo", "bar"}}}
cur, err := NewCursorFromDocuments(findResult, mockErr, nil)
require.NoError(t, err, "NewCursorFromDocuments error: %v", err)
// Assert that a call to Next will return false because of existing error.
next := cur.Next(context.Background())
assert.False(t, next, "expected call to Next to return false, got true")
// Check for error on Cursor.
assert.Error(t, cur.Err(), "expected Cursor error, got nil")
assert.Equal(t, mockErr, cur.Err(), "expected Cursor error %v, got %v",
mockErr, cur.Err())
})
}
|