// 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 //go:build go1.13 // +build go1.13 package integration import ( "context" "errors" "io" "net" "testing" "time" "go.mongodb.org/mongo-driver/bson" "go.mongodb.org/mongo-driver/internal/testutil" "go.mongodb.org/mongo-driver/internal/testutil/assert" "go.mongodb.org/mongo-driver/mongo" "go.mongodb.org/mongo-driver/mongo/integration/mtest" "go.mongodb.org/mongo-driver/mongo/options" "go.mongodb.org/mongo-driver/x/mongo/driver" "go.mongodb.org/mongo-driver/x/mongo/driver/topology" ) type netErr struct { timeout bool } func (n netErr) Error() string { return "error" } func (n netErr) Timeout() bool { return n.timeout } func (n netErr) Temporary() bool { return false } var _ net.Error = (*netErr)(nil) type wrappedError struct { err error } func (we wrappedError) Error() string { return we.err.Error() } func (we wrappedError) Unwrap() error { return we.err } func TestErrors(t *testing.T) { mt := mtest.New(t, noClientOpts) defer mt.Close() mt.RunOpts("errors are wrapped", noClientOpts, func(mt *mtest.T) { mt.Run("network error during application operation", func(mt *mtest.T) { ctx, cancel := context.WithCancel(context.Background()) cancel() err := mt.Client.Ping(ctx, mtest.PrimaryRp) assert.True(mt, errors.Is(err, context.Canceled), "expected error %v, got %v", context.Canceled, err) }) authOpts := mtest.NewOptions().Auth(true).Topologies(mtest.ReplicaSet, mtest.Single).MinServerVersion("4.0") mt.RunOpts("network error during auth", authOpts, func(mt *mtest.T) { mt.SetFailPoint(mtest.FailPoint{ ConfigureFailPoint: "failCommand", Mode: mtest.FailPointMode{ Times: 1, }, Data: mtest.FailPointData{ // Set the fail point for saslContinue rather than saslStart because the driver will use speculative // auth on 4.4+ so there won't be an explicit saslStart command. FailCommands: []string{"saslContinue"}, CloseConnection: true, }, }) clientOpts := options.Client().ApplyURI(mtest.ClusterURI()) testutil.AddTestServerAPIVersion(clientOpts) client, err := mongo.Connect(context.Background(), clientOpts) assert.Nil(mt, err, "Connect error: %v", err) defer client.Disconnect(context.Background()) // A connection getting closed should manifest as an io.EOF error. err = client.Ping(context.Background(), mtest.PrimaryRp) assert.True(mt, errors.Is(err, io.EOF), "expected error %v, got %v", io.EOF, err) }) }) mt.RunOpts("network timeouts", noClientOpts, func(mt *mtest.T) { mt.Run("context timeouts return DeadlineExceeded", func(mt *mtest.T) { _, err := mt.Coll.InsertOne(context.Background(), bson.D{{"x", 1}}) assert.Nil(mt, err, "InsertOne error: %v", err) mt.ClearEvents() filter := bson.M{ "$where": "function() { sleep(1000); return false; }", } timeoutCtx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond) defer cancel() _, err = mt.Coll.Find(timeoutCtx, filter) evt := mt.GetStartedEvent() assert.Equal(mt, "find", evt.CommandName, "expected command 'find', got %q", evt.CommandName) assert.True(mt, errors.Is(err, context.DeadlineExceeded), "errors.Is failure: expected error %v to be %v", err, context.DeadlineExceeded) }) mt.Run("socketTimeoutMS timeouts return network errors", func(mt *mtest.T) { _, err := mt.Coll.InsertOne(context.Background(), bson.D{{"x", 1}}) assert.Nil(mt, err, "InsertOne error: %v", err) // Reset the test client to have a 100ms socket timeout. We do this here rather than passing it in as a // test option using mt.RunOpts because that could cause the collection creation or InsertOne to fail. resetClientOpts := options.Client(). SetSocketTimeout(100 * time.Millisecond) mt.ResetClient(resetClientOpts) mt.ClearEvents() filter := bson.M{ "$where": "function() { sleep(1000); return false; }", } _, err = mt.Coll.Find(context.Background(), filter) evt := mt.GetStartedEvent() assert.Equal(mt, "find", evt.CommandName, "expected command 'find', got %q", evt.CommandName) assert.False(mt, errors.Is(err, context.DeadlineExceeded), "errors.Is failure: expected error %v to not be %v", err, context.DeadlineExceeded) var netErr net.Error ok := errors.As(err, &netErr) assert.True(mt, ok, "errors.As failure: expected error %v to be a net.Error", err) assert.True(mt, netErr.Timeout(), "expected error %v to be a network timeout", err) }) }) mt.Run("ServerError", func(mt *mtest.T) { matchWrapped := errors.New("wrapped err") otherWrapped := errors.New("other err") const matchCode = 100 const otherCode = 120 const label = "testError" testCases := []struct { name string err mongo.ServerError hasCode bool hasLabel bool hasMessage bool hasCodeWithMessage bool isResult bool }{ { "CommandError all true", mongo.CommandError{matchCode, "foo", []string{label}, "name", matchWrapped, nil}, true, true, true, true, true, }, { "CommandError all false", mongo.CommandError{otherCode, "bar", []string{"otherError"}, "name", otherWrapped, nil}, false, false, false, false, false, }, { "CommandError has code not message", mongo.CommandError{matchCode, "bar", []string{}, "name", nil, nil}, true, false, false, false, false, }, { "WriteException all in writeConcernError", mongo.WriteException{ &mongo.WriteConcernError{"name", matchCode, "foo", nil, nil}, nil, []string{label}, nil, }, true, true, true, true, false, }, { "WriteException all in writeError", mongo.WriteException{ nil, mongo.WriteErrors{ mongo.WriteError{0, otherCode, "bar", nil, nil}, mongo.WriteError{0, matchCode, "foo", nil, nil}, }, []string{"otherError"}, nil, }, true, false, true, true, false, }, { "WriteException all false", mongo.WriteException{ &mongo.WriteConcernError{"name", otherCode, "bar", nil, nil}, mongo.WriteErrors{ mongo.WriteError{0, otherCode, "baz", nil, nil}, }, []string{"otherError"}, nil, }, false, false, false, false, false, }, { "WriteException HasErrorCodeAndMessage false", mongo.WriteException{ &mongo.WriteConcernError{"name", matchCode, "bar", nil, nil}, mongo.WriteErrors{ mongo.WriteError{0, otherCode, "foo", nil, nil}, }, []string{"otherError"}, nil, }, true, false, true, false, false, }, { "BulkWriteException all in writeConcernError", mongo.BulkWriteException{ &mongo.WriteConcernError{"name", matchCode, "foo", nil, nil}, nil, []string{label}, }, true, true, true, true, false, }, { "BulkWriteException all in writeError", mongo.BulkWriteException{ nil, []mongo.BulkWriteError{ {mongo.WriteError{0, matchCode, "foo", nil, nil}, &mongo.InsertOneModel{}}, {mongo.WriteError{0, otherCode, "bar", nil, nil}, &mongo.InsertOneModel{}}, }, []string{"otherError"}, }, true, false, true, true, false, }, { "BulkWriteException all false", mongo.BulkWriteException{ &mongo.WriteConcernError{"name", otherCode, "bar", nil, nil}, []mongo.BulkWriteError{ {mongo.WriteError{0, otherCode, "baz", nil, nil}, &mongo.InsertOneModel{}}, }, []string{"otherError"}, }, false, false, false, false, false, }, { "BulkWriteException HasErrorCodeAndMessage false", mongo.BulkWriteException{ &mongo.WriteConcernError{"name", matchCode, "bar", nil, nil}, []mongo.BulkWriteError{ {mongo.WriteError{0, otherCode, "foo", nil, nil}, &mongo.InsertOneModel{}}, }, []string{"otherError"}, }, true, false, true, false, false, }, } for _, tc := range testCases { mt.Run(tc.name, func(mt *mtest.T) { has := tc.err.HasErrorCode(matchCode) assert.Equal(mt, has, tc.hasCode, "expected HasErrorCode to return %v, got %v", tc.hasCode, has) has = tc.err.HasErrorLabel(label) assert.Equal(mt, has, tc.hasLabel, "expected HasErrorLabel to return %v, got %v", tc.hasLabel, has) // Check for full message and substring has = tc.err.HasErrorMessage("foo") assert.Equal(mt, has, tc.hasMessage, "expected HasErrorMessage to return %v, got %v", tc.hasMessage, has) has = tc.err.HasErrorMessage("fo") assert.Equal(mt, has, tc.hasMessage, "expected HasErrorMessage to return %v, got %v", tc.hasMessage, has) has = tc.err.HasErrorCodeWithMessage(matchCode, "foo") assert.Equal(mt, has, tc.hasCodeWithMessage, "expected HasErrorCodeWithMessage to return %v, got %v", tc.hasCodeWithMessage, has) has = tc.err.HasErrorCodeWithMessage(matchCode, "fo") assert.Equal(mt, has, tc.hasCodeWithMessage, "expected HasErrorCodeWithMessage to return %v, got %v", tc.hasCodeWithMessage, has) assert.Equal(mt, errors.Is(tc.err, matchWrapped), tc.isResult, "expected errors.Is result to be %v", tc.isResult) }) } mtOpts := mtest.NewOptions().MinServerVersion("4.0").Topologies(mtest.ReplicaSet) mt.RunOpts("Raw response", mtOpts, func(mt *mtest.T) { mt.Run("CommandError", func(mt *mtest.T) { // Mock a CommandError via failpoint with an arbitrary code. mt.SetFailPoint(mtest.FailPoint{ ConfigureFailPoint: "failCommand", Mode: mtest.FailPointMode{ Times: 1, }, Data: mtest.FailPointData{ FailCommands: []string{"find"}, ErrorCode: 123, }, }) res := mt.Coll.FindOne(context.Background(), bson.D{}) assert.NotNil(mt, res.Err(), "expected FindOne error, got nil") ce, ok := res.Err().(mongo.CommandError) assert.True(mt, ok, "expected FindOne error to be CommandError, got %T", res.Err()) // Assert that raw response exists and contains error code 123. assert.NotNil(mt, ce.Raw, "ce.Raw is nil") val, err := ce.Raw.LookupErr("code") assert.Nil(mt, err, "expected 'code' field in ce.Raw, got %v", ce.Raw) code, ok := val.AsInt64OK() assert.True(mt, ok, "expected 'code' to be int64, got %v", val) assert.Equal(mt, code, int64(123), "expected 'code' 123, got %d", code) }) mt.Run("WriteError", func(mt *mtest.T) { // Mock a WriteError by inserting documents with duplicate _id fields. _, err := mt.Coll.InsertOne(context.Background(), bson.D{{"_id", 1}}) assert.Nil(mt, err, "InsertOne error: %v", err) _, err = mt.Coll.InsertOne(context.Background(), bson.D{{"_id", 1}}) assert.NotNil(mt, err, "expected InsertOne error, got nil") we, ok := err.(mongo.WriteException) assert.True(mt, ok, "expected InsertOne error to be WriteException, got %T", err) assert.NotNil(mt, we.WriteErrors, "expected we.WriteErrors, got nil") assert.NotNil(mt, we.WriteErrors[0], "expected at least one WriteError") // Assert that raw response exists for the WriteError and contains error code 11000. raw := we.WriteErrors[0].Raw assert.NotNil(mt, raw, "Raw of WriteError is nil") val, err := raw.LookupErr("code") assert.Nil(mt, err, "expected 'code' field in Raw field, got %v", raw) code, ok := val.AsInt64OK() assert.True(mt, ok, "expected 'code' to be int64, got %v", val) assert.Equal(mt, code, int64(11000), "expected 'code' 11000, got %d", code) }) mt.Run("WriteException", func(mt *mtest.T) { // Mock a WriteException via failpoint with an arbitrary WriteConcernError. mt.SetFailPoint(mtest.FailPoint{ ConfigureFailPoint: "failCommand", Mode: mtest.FailPointMode{ Times: 1, }, Data: mtest.FailPointData{ FailCommands: []string{"delete"}, WriteConcernError: &mtest.WriteConcernErrorData{ Code: 123, }, }, }) _, err := mt.Coll.DeleteMany(context.Background(), bson.D{}) assert.NotNil(mt, err, "expected DeleteMany error, got nil") we, ok := err.(mongo.WriteException) assert.True(mt, ok, "expected DeleteMany error to be WriteException, got %T", err) // Assert that raw response exists and contains error code 123. assert.NotNil(mt, we.Raw, "expected RawResponse, got nil") val, err := we.Raw.LookupErr("writeConcernError", "code") assert.Nil(mt, err, "expected 'code' field in RawResponse, got %v", we.Raw) code, ok := val.AsInt64OK() assert.True(mt, ok, "expected 'code' to be int64, got %v", val) assert.Equal(mt, code, int64(123), "expected 'code' 123, got %d", code) }) }) }) mt.Run("error helpers", func(mt *mtest.T) { //IsDuplicateKeyError mt.Run("IsDuplicateKeyError", func(mt *mtest.T) { testCases := []struct { name string err error result bool }{ {"CommandError true", mongo.CommandError{11000, "", nil, "blah", nil, nil}, true}, {"CommandError false", mongo.CommandError{100, "", nil, "blah", nil, nil}, false}, {"WriteError true", mongo.WriteError{0, 11000, "", nil, nil}, true}, {"WriteError false", mongo.WriteError{0, 100, "", nil, nil}, false}, { "WriteException true in writeConcernError", mongo.WriteException{ &mongo.WriteConcernError{"name", 11001, "bar", nil, nil}, mongo.WriteErrors{ mongo.WriteError{0, 100, "baz", nil, nil}, }, nil, nil, }, true, }, { "WriteException true in writeErrors", mongo.WriteException{ &mongo.WriteConcernError{"name", 100, "bar", nil, nil}, mongo.WriteErrors{ mongo.WriteError{0, 12582, "baz", nil, nil}, }, nil, nil, }, true, }, { "WriteException false", mongo.WriteException{ &mongo.WriteConcernError{"name", 16460, "bar", nil, nil}, mongo.WriteErrors{ mongo.WriteError{0, 100, "blah E11000 blah", nil, nil}, }, nil, nil, }, false, }, { "BulkWriteException true", mongo.BulkWriteException{ &mongo.WriteConcernError{"name", 100, "bar", nil, nil}, []mongo.BulkWriteError{ {mongo.WriteError{0, 16460, "blah E11000 blah", nil, nil}, &mongo.InsertOneModel{}}, }, []string{"otherError"}, }, true, }, { "BulkWriteException false", mongo.BulkWriteException{ &mongo.WriteConcernError{"name", 100, "bar", nil, nil}, []mongo.BulkWriteError{ {mongo.WriteError{0, 110, "blah", nil, nil}, &mongo.InsertOneModel{}}, }, []string{"otherError"}, }, false, }, {"wrapped error", wrappedError{mongo.CommandError{11000, "", nil, "blah", nil, nil}}, true}, {"other error type", errors.New("foo"), false}, } for _, tc := range testCases { mt.Run(tc.name, func(mt *mtest.T) { res := mongo.IsDuplicateKeyError(tc.err) assert.Equal(mt, res, tc.result, "expected IsDuplicateKeyError %v, got %v", tc.result, res) }) } }) //IsNetworkError mt.Run("IsNetworkError", func(mt *mtest.T) { const networkLabel = "NetworkError" const otherLabel = "other" testCases := []struct { name string err error result bool }{ {"ServerError true", mongo.CommandError{100, "", []string{networkLabel}, "blah", nil, nil}, true}, {"ServerError false", mongo.CommandError{100, "", []string{otherLabel}, "blah", nil, nil}, false}, {"wrapped error", wrappedError{mongo.CommandError{100, "", []string{networkLabel}, "blah", nil, nil}}, true}, {"other error type", errors.New("foo"), false}, } for _, tc := range testCases { mt.Run(tc.name, func(mt *mtest.T) { res := mongo.IsNetworkError(tc.err) assert.Equal(mt, res, tc.result, "expected IsNetworkError %v, got %v", tc.result, res) }) } }) //IsTimeout mt.Run("IsTimeout", func(mt *mtest.T) { testCases := []struct { name string err error result bool }{ {"context timeout", mongo.CommandError{ 100, "", []string{"other"}, "blah", context.DeadlineExceeded, nil}, true}, {"deadline would be exceeded", mongo.CommandError{ 100, "", []string{"other"}, "blah", driver.ErrDeadlineWouldBeExceeded, nil}, true}, {"server selection timeout", mongo.CommandError{ 100, "", []string{"other"}, "blah", topology.ErrServerSelectionTimeout, nil}, true}, {"wait queue timeout", mongo.CommandError{ 100, "", []string{"other"}, "blah", topology.WaitQueueTimeoutError{}, nil}, true}, {"ServerError NetworkTimeoutError", mongo.CommandError{ 100, "", []string{"NetworkTimeoutError"}, "blah", nil, nil}, true}, {"ServerError ExceededTimeLimitError", mongo.CommandError{ 100, "", []string{"ExceededTimeLimitError"}, "blah", nil, nil}, true}, {"ServerError false", mongo.CommandError{ 100, "", []string{"other"}, "blah", nil, nil}, false}, {"net error true", mongo.CommandError{ 100, "", []string{"other"}, "blah", netErr{true}, nil}, true}, {"net error false", netErr{false}, false}, {"wrapped error", wrappedError{mongo.CommandError{ 100, "", []string{"other"}, "blah", context.DeadlineExceeded, nil}}, true}, {"other error", errors.New("foo"), false}, } for _, tc := range testCases { mt.Run(tc.name, func(mt *mtest.T) { res := mongo.IsTimeout(tc.err) assert.Equal(mt, res, tc.result, "expected IsTimeout %v, got %v", tc.result, res) }) } }) }) }