Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move fail point structs to an internal package. #1833

Merged
merged 2 commits into from
Sep 28, 2024
Merged

Move fail point structs to an internal package. #1833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e8826d
Move fail point structs to an internal package.
matthewdale Sep 27, 2024
5e6801e
Add license header to new failpoint.go
matthewdale Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions internal/failpoint/failpoint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
// Copyright (C) MongoDB, Inc. 2024-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 failpoint

import (
"go.mongodb.org/mongo-driver/v2/bson"
)

const (
// ModeAlwaysOn is the fail point mode that enables the fail point for an
// indefinite number of matching commands.
ModeAlwaysOn = "alwaysOn"

// ModeOff is the fail point mode that disables the fail point.
ModeOff = "off"
)

// FailPoint is used to configure a server fail point. It is intended to be
// passed as the command argument to RunCommand.
//
// For more information about fail points, see
// https://github.com/mongodb/specifications/tree/HEAD/source/transactions/tests#server-fail-point
type FailPoint struct {
ConfigureFailPoint string `bson:"configureFailPoint"`
// Mode should be a string, FailPointMode, or map[string]interface{}
Mode interface{} `bson:"mode"`
Data Data `bson:"data"`
}

// Mode configures when a fail point will be enabled. It is used to set the
// FailPoint.Mode field.
type Mode struct {
Times int32 `bson:"times"`
Skip int32 `bson:"skip"`
}

// Data configures how a fail point will behave. It is used to set the
// FailPoint.Data field.
type Data struct {
FailCommands []string `bson:"failCommands,omitempty"`
CloseConnection bool `bson:"closeConnection,omitempty"`
ErrorCode int32 `bson:"errorCode,omitempty"`
FailBeforeCommitExceptionCode int32 `bson:"failBeforeCommitExceptionCode,omitempty"`
ErrorLabels *[]string `bson:"errorLabels,omitempty"`
WriteConcernError *WriteConcernError `bson:"writeConcernError,omitempty"`
BlockConnection bool `bson:"blockConnection,omitempty"`
BlockTimeMS int32 `bson:"blockTimeMS,omitempty"`
AppName string `bson:"appName,omitempty"`
}

// WriteConcernError is the write concern error to return when the fail point is
// triggered. It is used to set the FailPoint.Data.WriteConcernError field.
type WriteConcernError struct {
Code int32 `bson:"code"`
Name string `bson:"codeName"`
Errmsg string `bson:"errmsg"`
ErrorLabels *[]string `bson:"errorLabels,omitempty"`
ErrInfo bson.Raw `bson:"errInfo,omitempty"`
}
19 changes: 10 additions & 9 deletions internal/integration/change_stream_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
"go.mongodb.org/mongo-driver/v2/event"
"go.mongodb.org/mongo-driver/v2/internal/assert"
"go.mongodb.org/mongo-driver/v2/internal/eventtest"
"go.mongodb.org/mongo-driver/v2/internal/failpoint"
"go.mongodb.org/mongo-driver/v2/internal/integration/mtest"
"go.mongodb.org/mongo-driver/v2/internal/require"
"go.mongodb.org/mongo-driver/v2/mongo"
Expand Down Expand Up @@ -523,12 +524,12 @@ func TestChangeStream_ReplicaSet(t *testing.T) {
SetReadConcern(mtest.MajorityRc).
SetRetryReads(false))

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"aggregate"},
CloseConnection: true,
},
Expand All @@ -546,12 +547,12 @@ func TestChangeStream_ReplicaSet(t *testing.T) {
SetReadConcern(mtest.MajorityRc).
SetRetryReads(false))

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"getMore"},
CloseConnection: true,
},
Expand All @@ -574,12 +575,12 @@ func TestChangeStream_ReplicaSet(t *testing.T) {
SetPoolMonitor(tpm.PoolMonitor).
SetRetryReads(true))

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 2,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"aggregate"},
CloseConnection: true,
},
Expand Down
7 changes: 4 additions & 3 deletions internal/integration/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"go.mongodb.org/mongo-driver/v2/event"
"go.mongodb.org/mongo-driver/v2/internal/assert"
"go.mongodb.org/mongo-driver/v2/internal/eventtest"
"go.mongodb.org/mongo-driver/v2/internal/failpoint"
"go.mongodb.org/mongo-driver/v2/internal/handshake"
"go.mongodb.org/mongo-driver/v2/internal/integration/mtest"
"go.mongodb.org/mongo-driver/v2/internal/integtest"
Expand Down Expand Up @@ -678,10 +679,10 @@ func TestClient(t *testing.T) {
_, err := mt.Coll.InsertOne(context.Background(), bson.D{})
require.NoError(mt, err)

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: "alwaysOn",
Data: mtest.FailPointData{
Mode: failpoint.ModeAlwaysOn,
Data: failpoint.Data{
FailCommands: []string{"find", "insert"},
BlockConnection: true,
BlockTimeMS: 500,
Expand Down
33 changes: 17 additions & 16 deletions internal/integration/crud_prose_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (

"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/internal/assert"
"go.mongodb.org/mongo-driver/v2/internal/failpoint"
"go.mongodb.org/mongo-driver/v2/internal/integration/mtest"
"go.mongodb.org/mongo-driver/v2/mongo"
"go.mongodb.org/mongo-driver/v2/mongo/options"
Expand All @@ -29,14 +30,14 @@ func TestWriteErrorsWithLabels(t *testing.T) {

label := "ExampleError"
mt.Run("InsertMany errors with label", func(mt *mtest.T) {
mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"insert"},
WriteConcernError: &mtest.WriteConcernErrorData{
WriteConcernError: &failpoint.WriteConcernError{
Code: 100,
ErrorLabels: &[]string{label},
},
Expand All @@ -60,14 +61,14 @@ func TestWriteErrorsWithLabels(t *testing.T) {
})

mt.Run("WriteException with label", func(mt *mtest.T) {
mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"delete"},
WriteConcernError: &mtest.WriteConcernErrorData{
WriteConcernError: &failpoint.WriteConcernError{
Code: 100,
ErrorLabels: &[]string{label},
},
Expand All @@ -83,14 +84,14 @@ func TestWriteErrorsWithLabels(t *testing.T) {
})

mt.Run("BulkWriteException with label", func(mt *mtest.T) {
mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"delete"},
WriteConcernError: &mtest.WriteConcernErrorData{
WriteConcernError: &failpoint.WriteConcernError{
Code: 100,
ErrorLabels: &[]string{label},
},
Expand Down Expand Up @@ -333,14 +334,14 @@ func TestWriteConcernError(t *testing.T) {
errInfoDoc := bsoncore.BuildDocumentFromElements(nil,
bsoncore.AppendDocumentElement(nil, "writeConcern", wcDoc),
)
fp := mtest.FailPoint{
fp := failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"insert"},
WriteConcernError: &mtest.WriteConcernErrorData{
WriteConcernError: &failpoint.WriteConcernError{
Code: 100,
Name: "UnsatisfiableWriteConcern",
Errmsg: "Not enough data-bearing nodes",
Expand Down
25 changes: 13 additions & 12 deletions internal/integration/csot_prose_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/event"
"go.mongodb.org/mongo-driver/v2/internal/assert"
"go.mongodb.org/mongo-driver/v2/internal/failpoint"
"go.mongodb.org/mongo-driver/v2/internal/integration/mtest"
"go.mongodb.org/mongo-driver/v2/internal/integtest"
"go.mongodb.org/mongo-driver/v2/internal/mongoutil"
Expand All @@ -35,12 +36,12 @@ func TestCSOTProse(t *testing.T) {
assert.Nil(mt, err, "Drop error: %v", err)

// Configure a fail point to block both inserts of the multi-write for 1010ms (2020ms total).
mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 2,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"insert"},
BlockConnection: true,
BlockTimeMS: 1010,
Expand Down Expand Up @@ -191,12 +192,12 @@ func TestCSOTProse_GridFS(t *testing.T) {
SetHosts([]string{failpointHost}))

// Set a blocking "insert" fail point.
mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"insert"},
BlockConnection: true,
BlockTimeMS: 1250,
Expand Down Expand Up @@ -251,12 +252,12 @@ func TestCSOTProse_GridFS(t *testing.T) {
SetHosts([]string{failpointHost}))

// Set a blocking "delete" fail point.
mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"delete"},
BlockConnection: true,
BlockTimeMS: 1250,
Expand Down Expand Up @@ -367,12 +368,12 @@ func TestCSOTProse_GridFS(t *testing.T) {
SetHosts([]string{failpointHost}))

// Set a blocking "insert" fail point.
mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"insert"},
BlockConnection: true,
BlockTimeMS: 200,
Expand Down
25 changes: 13 additions & 12 deletions internal/integration/csot_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
"go.mongodb.org/mongo-driver/v2/event"
"go.mongodb.org/mongo-driver/v2/internal/assert"
"go.mongodb.org/mongo-driver/v2/internal/eventtest"
"go.mongodb.org/mongo-driver/v2/internal/failpoint"
"go.mongodb.org/mongo-driver/v2/internal/integration/mtest"
"go.mongodb.org/mongo-driver/v2/internal/require"
"go.mongodb.org/mongo-driver/v2/mongo"
Expand Down Expand Up @@ -351,10 +352,10 @@ func TestCSOT_maxTimeMS(t *testing.T) {
require.NoError(mt, err)
}

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: "alwaysOn",
Data: mtest.FailPointData{
Mode: failpoint.ModeAlwaysOn,
Data: failpoint.Data{
FailCommands: []string{tc.commandName},
BlockConnection: true,
// Note that some operations (currently Find and
Expand Down Expand Up @@ -424,12 +425,12 @@ func TestCSOT_errors(t *testing.T) {
_, err := mt.Coll.InsertOne(context.Background(), bson.D{})
require.NoError(mt, err, "InsertOne error")

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"find"},
ErrorCode: 50, // MaxTimeMSExceeded
},
Expand All @@ -454,12 +455,12 @@ func TestCSOT_errors(t *testing.T) {
_, err := mt.Coll.InsertOne(context.Background(), bson.D{})
require.NoError(mt, err, "InsertOne error")

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"find"},
BlockConnection: true,
BlockTimeMS: 500,
Expand Down Expand Up @@ -488,12 +489,12 @@ func TestCSOT_errors(t *testing.T) {
_, err := mt.Coll.InsertOne(context.Background(), bson.D{})
require.NoError(mt, err, "InsertOne error")

mt.SetFailPoint(mtest.FailPoint{
mt.SetFailPoint(failpoint.FailPoint{
ConfigureFailPoint: "failCommand",
Mode: mtest.FailPointMode{
Mode: failpoint.Mode{
Times: 1,
},
Data: mtest.FailPointData{
Data: failpoint.Data{
FailCommands: []string{"find"},
BlockConnection: true,
BlockTimeMS: 100,
Expand Down
Loading
Loading