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 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
|
// 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 integration
import (
"bytes"
"context"
"io"
"math/rand"
"runtime"
"testing"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/bson/primitive"
"go.mongodb.org/mongo-driver/event"
"go.mongodb.org/mongo-driver/internal/assert"
"go.mongodb.org/mongo-driver/internal/israce"
"go.mongodb.org/mongo-driver/mongo"
"go.mongodb.org/mongo-driver/mongo/gridfs"
"go.mongodb.org/mongo-driver/mongo/integration/mtest"
"go.mongodb.org/mongo-driver/mongo/options"
)
func TestGridFS(x *testing.T) {
mt := mtest.New(x, noClientOpts)
mt.Run("skipping download", func(mt *mtest.T) {
data := []byte("abc.def.ghi")
var chunkSize int32 = 4
testcases := []struct {
name string
read int
skip int64
expectedSkipN int64
expectedSkipErr error
expectedRemaining int
}{
{
"read 0, skip 0", 0, 0, 0, nil, 11,
},
{
"read 0, skip to end of chunk", 0, 4, 4, nil, 7,
},
{
"read 0, skip 1", 0, 1, 1, nil, 10,
},
{
"read 1, skip to end of chunk", 1, 3, 3, nil, 7,
},
{
"read all, skip beyond", 11, 1, 0, nil, 0,
},
{
"skip all", 0, 11, 11, nil, 0,
},
{
"read 1, skip to last chunk", 1, 8, 8, nil, 2,
},
{
"read to last chunk, skip to end", 9, 2, 2, nil, 0,
},
{
"read to last chunk, skip beyond", 9, 4, 2, nil, 0,
},
}
for _, tc := range testcases {
mt.Run(tc.name, func(mt *mtest.T) {
bucket, err := gridfs.NewBucket(mt.DB, options.GridFSBucket().SetChunkSizeBytes(chunkSize))
assert.Nil(mt, err, "NewBucket error: %v", err)
ustream, err := bucket.OpenUploadStream("foo")
assert.Nil(mt, err, "OpenUploadStream error: %v", err)
id := ustream.FileID
_, err = ustream.Write(data)
assert.Nil(mt, err, "Write error: %v", err)
err = ustream.Close()
assert.Nil(mt, err, "Close error: %v", err)
dstream, err := bucket.OpenDownloadStream(id)
assert.Nil(mt, err, "OpenDownloadStream error")
dst := make([]byte, tc.read)
_, err = dstream.Read(dst)
assert.Nil(mt, err, "Read error: %v", err)
n, err := dstream.Skip(tc.skip)
assert.Equal(mt, tc.expectedSkipErr, err, "expected error on Skip: %v, got %v", tc.expectedSkipErr, err)
assert.Equal(mt, tc.expectedSkipN, n, "expected Skip to return: %v, got %v", tc.expectedSkipN, n)
// Read the rest.
dst = make([]byte, len(data))
remaining, err := dstream.Read(dst)
if err != nil {
assert.Equal(mt, err, io.EOF, "unexpected Read error: %v", err)
}
assert.Equal(mt, tc.expectedRemaining, remaining, "expected remaining data to be: %v, got %v", tc.expectedRemaining, remaining)
})
}
})
mt.Run("index creation", func(mt *mtest.T) {
// Unit tests showing that UploadFromStream creates indexes on the chunks and files collections.
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
err = bucket.SetWriteDeadline(time.Now().Add(5 * time.Second))
assert.Nil(mt, err, "SetWriteDeadline error: %v", err)
byteData := []byte("Hello, world!")
r := bytes.NewReader(byteData)
_, err = bucket.UploadFromStream("filename", r)
assert.Nil(mt, err, "UploadFromStream error: %v", err)
findCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
findIndex(findCtx, mt, mt.DB.Collection("fs.files"), false, "key", "filename")
findIndex(findCtx, mt, mt.DB.Collection("fs.chunks"), true, "key", "files_id")
})
// should not create a new index if index is numerically the same
mt.Run("equivalent indexes", func(mt *mtest.T) {
tests := []struct {
name string
filesIndex bson.D
chunksIndex bson.D
newIndexes bool
}{
{
"numerically equal",
bson.D{
{"key", bson.D{{"filename", float64(1.0)}, {"uploadDate", float64(1.0)}}},
{"name", "filename_1_uploadDate_1"},
},
bson.D{
{"key", bson.D{{"files_id", float64(1.0)}, {"n", float64(1.0)}}},
{"name", "files_id_1_n_1"},
{"unique", true},
},
false,
},
{
"numerically inequal",
bson.D{
{"key", bson.D{{"filename", float64(-1.0)}, {"uploadDate", float64(1.0)}}},
{"name", "filename_-1_uploadDate_1"},
},
bson.D{
{"key", bson.D{{"files_id", float64(1.0)}, {"n", float64(-1.0)}}},
{"name", "files_id_1_n_-1"},
{"unique", true},
},
true,
},
}
for _, test := range tests {
mt.Run(test.name, func(mt *mtest.T) {
mt.Run("OpenUploadStream", func(mt *mtest.T) {
// add indexes with floats to collections manually
res := mt.DB.RunCommand(context.Background(),
bson.D{
{"createIndexes", "fs.files"},
{"indexes", bson.A{
test.filesIndex,
}},
},
)
assert.Nil(mt, res.Err(), "createIndexes error: %v", res.Err())
res = mt.DB.RunCommand(context.Background(),
bson.D{
{"createIndexes", "fs.chunks"},
{"indexes", bson.A{
test.chunksIndex,
}},
},
)
assert.Nil(mt, res.Err(), "createIndexes error: %v", res.Err())
mt.ClearEvents()
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() {
_ = bucket.Drop()
}()
_, err = bucket.OpenUploadStream("filename")
assert.Nil(mt, err, "OpenUploadStream error: %v", err)
mt.FilterStartedEvents(func(evt *event.CommandStartedEvent) bool {
return evt.CommandName == "createIndexes"
})
evt := mt.GetStartedEvent()
if test.newIndexes {
if evt == nil {
mt.Fatalf("expected createIndexes events but got none")
}
} else {
if evt != nil {
mt.Fatalf("expected no createIndexes events but got %v", evt.Command)
}
}
})
mt.Run("UploadFromStream", func(mt *mtest.T) {
// add indexes with floats to collections manually
res := mt.DB.RunCommand(context.Background(),
bson.D{
{"createIndexes", "fs.files"},
{"indexes", bson.A{
test.filesIndex,
}},
},
)
assert.Nil(mt, res.Err(), "createIndexes error: %v", res.Err())
res = mt.DB.RunCommand(context.Background(),
bson.D{
{"createIndexes", "fs.chunks"},
{"indexes", bson.A{
test.chunksIndex,
}},
},
)
assert.Nil(mt, res.Err(), "createIndexes error: %v", res.Err())
mt.ClearEvents()
var fileContent []byte
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() {
_ = bucket.Drop()
}()
_, err = bucket.UploadFromStream("filename", bytes.NewBuffer(fileContent))
assert.Nil(mt, err, "UploadFromStream error: %v", err)
mt.FilterStartedEvents(func(evt *event.CommandStartedEvent) bool {
return evt.CommandName == "createIndexes"
})
evt := mt.GetStartedEvent()
if test.newIndexes {
if evt == nil {
mt.Fatalf("expected createIndexes events but got none")
}
} else {
if evt != nil {
mt.Fatalf("expected no createIndexes events but got %v", evt.Command)
}
}
})
})
}
})
mt.RunOpts("download", noClientOpts, func(mt *mtest.T) {
mt.RunOpts("get file data", noClientOpts, func(mt *mtest.T) {
// Tests for the DownloadStream.GetFile method.
fileName := "get-file-data-test"
fileData := []byte{1, 2, 3, 4}
fileMetadata := bson.D{{"k1", "v1"}, {"k2", "v2"}}
rawMetadata, err := bson.Marshal(fileMetadata)
assert.Nil(mt, err, "Marshal error: %v", err)
uploadOpts := options.GridFSUpload().SetMetadata(fileMetadata)
testCases := []struct {
name string
fileID interface{}
}{
{"default ID", nil},
{"custom ID type", "customID"},
}
for _, tc := range testCases {
mt.Run(tc.name, func(mt *mtest.T) {
// Create a new GridFS bucket.
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() { _ = bucket.Drop() }()
// Upload the file and store the uploaded file ID.
uploadedFileID := tc.fileID
dataReader := bytes.NewReader(fileData)
if uploadedFileID == nil {
uploadedFileID, err = bucket.UploadFromStream(fileName, dataReader, uploadOpts)
} else {
err = bucket.UploadFromStreamWithID(tc.fileID, fileName, dataReader, uploadOpts)
}
assert.Nil(mt, err, "error uploading file: %v", err)
// The uploadDate field is calculated when the upload is complete. Manually fetch it from the
// fs.files collection to use in assertions.
filesColl := mt.DB.Collection("fs.files")
uploadedFileDoc, err := filesColl.FindOne(context.Background(), bson.D{}).Raw()
assert.Nil(mt, err, "FindOne error: %v", err)
uploadTime := uploadedFileDoc.Lookup("uploadDate").Time().UTC()
expectedFile := &gridfs.File{
ID: uploadedFileID,
Length: int64(len(fileData)),
ChunkSize: gridfs.DefaultChunkSize,
UploadDate: uploadTime,
Name: fileName,
Metadata: rawMetadata,
}
// For both methods that create a DownloadStream, open a stream and compare the file given by the
// stream to the expected File object.
mt.RunOpts("OpenDownloadStream", noClientOpts, func(mt *mtest.T) {
downloadStream, err := bucket.OpenDownloadStream(uploadedFileID)
assert.Nil(mt, err, "OpenDownloadStream error: %v", err)
actualFile := downloadStream.GetFile()
assert.Equal(mt, expectedFile, actualFile, "expected file %v, got %v", expectedFile, actualFile)
})
mt.RunOpts("OpenDownloadStreamByName", noClientOpts, func(mt *mtest.T) {
downloadStream, err := bucket.OpenDownloadStreamByName(fileName)
assert.Nil(mt, err, "OpenDownloadStream error: %v", err)
actualFile := downloadStream.GetFile()
assert.Equal(mt, expectedFile, actualFile, "expected file %v, got %v", expectedFile, actualFile)
})
})
}
})
mt.Run("chunk size determined by files collection document", func(mt *mtest.T) {
// Test that the chunk size for a file download is determined by the chunkSize field in the files
// collection document, not the bucket's chunk size.
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() { _ = bucket.Drop() }()
fileData := []byte("hello world")
uploadOpts := options.GridFSUpload().SetChunkSizeBytes(4)
fileID, err := bucket.UploadFromStream("file", bytes.NewReader(fileData), uploadOpts)
assert.Nil(mt, err, "UploadFromStream error: %v", err)
// If the bucket's chunk size was used, this would error because the actual chunk size is 4 and the bucket
// chunk size is 255 KB.
var downloadBuffer bytes.Buffer
_, err = bucket.DownloadToStream(fileID, &downloadBuffer)
assert.Nil(mt, err, "DownloadToStream error: %v", err)
downloadedBytes := downloadBuffer.Bytes()
assert.Equal(mt, fileData, downloadedBytes, "expected bytes %s, got %s", fileData, downloadedBytes)
})
mt.Run("error if files collection document does not have a chunkSize field", func(mt *mtest.T) {
// Test that opening a download returns ErrMissingChunkSize if the files collection document has no
// chunk size field.
oid := primitive.NewObjectID()
filesDoc := bson.D{
{"_id", oid},
{"length", 10},
{"filename", "filename"},
}
_, err := mt.DB.Collection("fs.files").InsertOne(context.Background(), filesDoc)
assert.Nil(mt, err, "InsertOne error for files collection: %v", err)
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() { _ = bucket.Drop() }()
_, err = bucket.OpenDownloadStream(oid)
assert.Equal(mt, gridfs.ErrMissingChunkSize, err, "expected error %v, got %v", gridfs.ErrMissingChunkSize, err)
})
mt.Run("cursor error during read after downloading", func(mt *mtest.T) {
// To simulate a cursor error we upload a file larger than the 16MB default batch size,
// so the underlying cursor remains open on the server. Since the ReadDeadline is
// set in the past, Read should cause a timeout.
fileName := "read-error-test"
fileData := make([]byte, 17000000)
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() { _ = bucket.Drop() }()
dataReader := bytes.NewReader(fileData)
_, err = bucket.UploadFromStream(fileName, dataReader)
assert.Nil(mt, err, "UploadFromStream error: %v", err)
ds, err := bucket.OpenDownloadStreamByName(fileName)
assert.Nil(mt, err, "OpenDownloadStreamByName error: %v", err)
err = ds.SetReadDeadline(time.Now().Add(-1 * time.Second))
assert.Nil(mt, err, "SetReadDeadline error: %v", err)
p := make([]byte, len(fileData))
_, err = ds.Read(p)
assert.NotNil(mt, err, "expected error from Read, got nil")
assert.True(mt, mongo.IsTimeout(err), "expected error to be a timeout, got %v", err.Error())
})
mt.Run("cursor error during skip after downloading", func(mt *mtest.T) {
// To simulate a cursor error we upload a file larger than the 16MB default batch size,
// so the underlying cursor remains open on the server. Since the ReadDeadline is
// set in the past, Skip should cause a timeout.
fileName := "skip-error-test"
fileData := make([]byte, 17000000)
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() { _ = bucket.Drop() }()
dataReader := bytes.NewReader(fileData)
_, err = bucket.UploadFromStream(fileName, dataReader)
assert.Nil(mt, err, "UploadFromStream error: %v", err)
ds, err := bucket.OpenDownloadStreamByName(fileName)
assert.Nil(mt, err, "OpenDownloadStreamByName error: %v", err)
err = ds.SetReadDeadline(time.Now().Add(-1 * time.Second))
assert.Nil(mt, err, "SetReadDeadline error: %v", err)
_, err = ds.Skip(int64(len(fileData)))
assert.NotNil(mt, err, "expected error from Skip, got nil")
assert.True(mt, mongo.IsTimeout(err), "expected error to be a timeout, got %v", err.Error())
})
})
mt.RunOpts("bucket collection accessors", noClientOpts, func(mt *mtest.T) {
// Tests for the GetFilesCollection and GetChunksCollection accessors.
fileData := []byte{1, 2, 3, 4}
var chunkSize int32 = 2
testCases := []struct {
name string
bucketName string // defaults to "fs"
}{
{"default bucket name", ""},
{"custom bucket name", "bucket"},
}
for _, tc := range testCases {
mt.Run(tc.name, func(mt *mtest.T) {
bucketOpts := options.GridFSBucket().SetChunkSizeBytes(chunkSize)
if tc.bucketName != "" {
bucketOpts.SetName(tc.bucketName)
}
bucket, err := gridfs.NewBucket(mt.DB, bucketOpts)
assert.Nil(mt, err, "NewBucket error: %v", err)
defer func() { _ = bucket.Drop() }()
_, err = bucket.UploadFromStream("accessors-test-file", bytes.NewReader(fileData))
assert.Nil(mt, err, "UploadFromStream error: %v", err)
bucketName := tc.bucketName
if bucketName == "" {
bucketName = "fs"
}
assertGridFSCollectionState(mt, bucket.GetFilesCollection(), bucketName+".files", 1)
assertGridFSCollectionState(mt, bucket.GetChunksCollection(), bucketName+".chunks", 2)
})
}
})
mt.RunOpts("round trip", mtest.NewOptions().MaxServerVersion("3.6"), func(mt *mtest.T) {
skipRoundTripTest(mt)
oneK := 1024
smallBuffSize := 100
tests := []struct {
name string
chunkSize int // make -1 for no capacity for no chunkSize
fileSize int
bufSize int // make -1 for no capacity for no bufSize
}{
{"RoundTrip: original", -1, oneK, -1},
{"RoundTrip: chunk size multiple of file", oneK, oneK * 16, -1},
{"RoundTrip: chunk size is file size", oneK, oneK, -1},
{"RoundTrip: chunk size multiple of file size and with strict buffer size", oneK, oneK * 16, smallBuffSize},
{"RoundTrip: chunk size multiple of file size and buffer size", oneK, oneK * 16, oneK * 16},
{"RoundTrip: chunk size, file size, buffer size all the same", oneK, oneK, oneK},
}
for _, test := range tests {
mt.Run(test.name, func(mt *mtest.T) {
var chunkSize *int32
var temp int32
if test.chunkSize != -1 {
temp = int32(test.chunkSize)
chunkSize = &temp
}
bucket, err := gridfs.NewBucket(mt.DB, &options.BucketOptions{
ChunkSizeBytes: chunkSize,
})
assert.Nil(mt, err, "NewBucket error: %v", err)
timeout := 5 * time.Second
if israce.Enabled {
timeout = 20 * time.Second // race detector causes 2-20x slowdown
}
err = bucket.SetWriteDeadline(time.Now().Add(timeout))
assert.Nil(mt, err, "SetWriteDeadline error: %v", err)
// Test that Upload works when the buffer to write is longer than the upload stream's internal buffer.
// This requires multiple calls to uploadChunks.
size := test.fileSize
p := make([]byte, size)
for i := 0; i < size; i++ {
p[i] = byte(rand.Intn(100))
}
_, err = bucket.UploadFromStream("filename", bytes.NewReader(p))
assert.Nil(mt, err, "UploadFromStream error: %v", err)
var w *bytes.Buffer
if test.bufSize == -1 {
w = bytes.NewBuffer(make([]byte, 0))
} else {
w = bytes.NewBuffer(make([]byte, 0, test.bufSize))
}
_, err = bucket.DownloadToStreamByName("filename", w)
assert.Nil(mt, err, "DownloadToStreamByName error: %v", err)
assert.Equal(mt, p, w.Bytes(), "downloaded file did not match p")
})
}
})
// Regression test for a bug introduced in GODRIVER-2346.
mt.Run("Find", func(mt *mtest.T) {
bucket, err := gridfs.NewBucket(mt.DB)
assert.Nil(mt, err, "NewBucket error: %v", err)
// Find the file back.
cursor, err := bucket.Find(bson.D{{"foo", "bar"}})
defer func() {
_ = cursor.Close(context.Background())
}()
assert.Nil(mt, err, "Find error: %v", err)
})
}
func assertGridFSCollectionState(mt *mtest.T, coll *mongo.Collection, expectedName string, expectedNumDocuments int64) {
mt.Helper()
assert.Equal(mt, expectedName, coll.Name(), "expected collection name %v, got %v", expectedName, coll.Name())
count, err := coll.CountDocuments(context.Background(), bson.D{})
assert.Nil(mt, err, "CountDocuments error: %v", err)
assert.Equal(mt, expectedNumDocuments, count, "expected %d documents in collection, got %d", expectedNumDocuments,
count)
}
func findIndex(ctx context.Context, mt *mtest.T, coll *mongo.Collection, unique bool, keys ...string) {
mt.Helper()
cur, err := coll.Indexes().List(ctx)
assert.Nil(mt, err, "Indexes List error: %v", err)
foundIndex := false
for cur.Next(ctx) {
if _, err := cur.Current.LookupErr(keys...); err == nil {
if uVal, err := cur.Current.LookupErr("unique"); (unique && err == nil && uVal.Boolean() == true) ||
(!unique && (err != nil || uVal.Boolean() == false)) {
foundIndex = true
}
}
}
assert.True(mt, foundIndex, "index %v not found", keys)
}
func skipRoundTripTest(mt *mtest.T) {
if runtime.GOOS != "darwin" {
return
}
var serverStatus bson.Raw
err := mt.DB.RunCommand(
context.Background(),
bson.D{{"serverStatus", 1}},
).Decode(&serverStatus)
assert.Nil(mt, err, "serverStatus error %v", err)
// can run on non-sharded clusters or on sharded cluster with auth/ssl disabled
_, err = serverStatus.LookupErr("sharding")
if err != nil {
return
}
_, err = serverStatus.LookupErr("security")
if err != nil {
return
}
mt.Skip("skipping round trip test")
}
|