Skip to content

GODRIVER-3880 Skip QE "prefixPreview" and "suffixPreview" tests on server 9.0.0+. #2378

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

Merged
qingyang-hu merged 3 commits into from
May 11, 2026
+96 −49
Merged

GODRIVER-3880 Skip QE "prefixPreview" and "suffixPreview" tests on server 9.0.0+. #2378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cb0260
Skip QE prose tests of "prefixPreview" and "suffixPreview" on server …
qingyang-hu May 4, 2026
b929c89
Sync tests
qingyang-hu May 5, 2026
621e841
Update skip logic in the prose test.
qingyang-hu May 5, 2026
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
115 changes: 66 additions & 49 deletions internal/integration/client_side_encryption_prose_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3126,17 +3126,68 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
mt := newCSE_T(t, newQEOpts().MinServerVersion("8.2"))
mt.Setup()

encryptedFields := readJSONFile(mt, "encryptedFields-prefix-suffix.json")
key1Document := readJSONFile(mt, "key1-document.json")
subtype, data := key1Document.Lookup("_id").Binary()
key1ID := bson.Binary{Subtype: subtype, Data: data}

encryptedColls := []struct {
name string
fields bson.Raw
textOpts *options.TextOptionsBuilder
}{
{
name: "prefix-suffix",
fields: readJSONFile(mt, "encryptedFields-prefix-suffix.json"),
textOpts: options.Text().
SetCaseSensitive(true).
SetDiacriticSensitive(true).
SetPrefix(options.PrefixOptions{
StrMaxQueryLength: 10,
StrMinQueryLength: 2,
}).
SetSuffix(options.SuffixOptions{
StrMaxQueryLength: 10,
StrMinQueryLength: 2,
}),
},
{
name: "substring",
fields: readJSONFile(mt, "encryptedFields-substring.json"),
textOpts: options.Text().
SetCaseSensitive(true).
SetDiacriticSensitive(true).
SetSubstring(options.SubstringOptions{
StrMaxLength: 10,
StrMaxQueryLength: 10,
StrMinQueryLength: 2,
}),
},
}

testSetup := func() (*mongo.Client, *mongo.ClientEncryption) {
for _, collName := range []string{"prefix-suffix", "substring"} {
mtest.DropEncryptedCollection(mt, mt.Client.Database("db").Collection(collName), encryptedFields)
cco := options.CreateCollection().SetEncryptedFields(encryptedFields)
err := mt.Client.Database("db").CreateCollection(context.Background(), collName, cco)
var setupColls []struct {
collection string
opts *options.EncryptOptionsBuilder
}
for _, coll := range encryptedColls {
mtest.DropEncryptedCollection(mt, mt.Client.Database("db").Collection(coll.name), coll.fields)
if coll.name == "prefix-suffix" && mtest.CompareServerVersions(mtest.ServerVersion(), "9.0.0") >= 0 {
continue
Comment on lines +3174 to +3175
}
cco := options.CreateCollection().SetEncryptedFields(coll.fields)
err := mt.Client.Database("db").CreateCollection(context.Background(), coll.name, cco)
require.NoError(mt, err, "error on CreateCollection: %v", err)
setupColls = append(setupColls, struct {
collection string
opts *options.EncryptOptionsBuilder
}{
collection: coll.name,
opts: options.Encrypt().
SetKeyID(key1ID).
SetAlgorithm("TextPreview").
SetContentionFactor(0).
SetTextOptions(coll.textOpts),
})
}
err := mt.Client.Database("keyvault").Collection("datakeys").Drop(context.Background())
require.NoError(mt, err, "error on Drop: %v", err)
Expand Down Expand Up @@ -3168,43 +3219,9 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
require.NoError(mt, err, "error on Connect: %v", err)

foobarbaz := bson.RawValue{Type: bson.TypeString, Value: bsoncore.AppendString(nil, "foobarbaz")}
for _, c := range []struct {
collection string
textOpts *options.TextOptionsBuilder
}{
{
collection: "prefix-suffix",
textOpts: options.Text().
SetCaseSensitive(true).
SetDiacriticSensitive(true).
SetPrefix(options.PrefixOptions{
StrMaxQueryLength: 10,
StrMinQueryLength: 2,
}).
SetSuffix(options.SuffixOptions{
StrMaxQueryLength: 10,
StrMinQueryLength: 2,
}),
},
{
collection: "substring",
textOpts: options.Text().
SetCaseSensitive(true).
SetDiacriticSensitive(true).
SetSubstring(options.SubstringOptions{
StrMaxLength: 10,
StrMaxQueryLength: 10,
StrMinQueryLength: 2,
}),
},
} {
for _, c := range setupColls {
coll := encryptedClient.Database("db").Collection(c.collection, options.Collection().SetWriteConcern(mtest.MajorityWc))
eo := options.Encrypt().
SetKeyID(key1ID).
SetAlgorithm("TextPreview").
SetContentionFactor(0).
SetTextOptions(c.textOpts)
insertPayload, err := clientEncryption.Encrypt(context.Background(), foobarbaz, eo)
insertPayload, err := clientEncryption.Encrypt(context.Background(), foobarbaz, c.opts)
require.NoError(mt, err, "error in Encrypt: %v", err)
_, err = coll.InsertOne(context.Background(), bson.D{{"_id", 0}, {"encryptedText", insertPayload}})
require.NoError(mt, err, "error in InsertOne: %v", err)
Expand All @@ -3217,7 +3234,7 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
bar := bson.RawValue{Type: bson.TypeString, Value: bsoncore.AppendString(nil, "bar")}
baz := bson.RawValue{Type: bson.TypeString, Value: bsoncore.AppendString(nil, "baz")}

mt.Run("Case 1: can find a document by prefix", func(mt *mtest.T) {
mt.RunOpts("Case 1: can find a document by prefix", mtest.NewOptions().MaxServerVersion("8.99.99"), func(mt *mtest.T) {
encryptedClient, clientEncryption := testSetup()
defer clientEncryption.Close(context.Background())
defer encryptedClient.Disconnect(context.Background())
Expand Down Expand Up @@ -3254,7 +3271,7 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
require.Equal(mt, 0, got.Id)
require.Equal(mt, "foobarbaz", got.EncryptedText)
})
mt.Run("Case 2: find a document by suffix", func(mt *mtest.T) {
mt.RunOpts("Case 2: find a document by suffix", mtest.NewOptions().MaxServerVersion("8.99.99"), func(mt *mtest.T) {
encryptedClient, clientEncryption := testSetup()
defer clientEncryption.Close(context.Background())
defer encryptedClient.Disconnect(context.Background())
Expand Down Expand Up @@ -3291,7 +3308,7 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
require.Equal(mt, 0, got.Id)
require.Equal(mt, "foobarbaz", got.EncryptedText)
})
mt.Run("Case 3: assert no document found by prefix", func(mt *mtest.T) {
mt.RunOpts("Case 3: assert no document found by prefix", mtest.NewOptions().MaxServerVersion("8.99.99"), func(mt *mtest.T) {
encryptedClient, clientEncryption := testSetup()
defer clientEncryption.Close(context.Background())
defer encryptedClient.Disconnect(context.Background())
Expand Down Expand Up @@ -3319,9 +3336,9 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
}},
}},
}).Raw()
require.Equal(mt, err, mongo.ErrNoDocuments)
assert.ErrorIs(mt, err, mongo.ErrNoDocuments)
})
mt.Run("Case 4: assert no document found by suffix", func(mt *mtest.T) {
mt.RunOpts("Case 4: assert no document found by suffix", mtest.NewOptions().MaxServerVersion("8.99.99"), func(mt *mtest.T) {
encryptedClient, clientEncryption := testSetup()
defer clientEncryption.Close(context.Background())
defer encryptedClient.Disconnect(context.Background())
Expand Down Expand Up @@ -3349,7 +3366,7 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
}},
}},
}).Raw()
require.Equal(mt, err, mongo.ErrNoDocuments)
assert.ErrorIs(mt, err, mongo.ErrNoDocuments)
})
mt.Run("Case 5: can find a document by substring", func(mt *mtest.T) {
encryptedClient, clientEncryption := testSetup()
Expand Down Expand Up @@ -3419,9 +3436,9 @@ func TestClientSideEncryptionProse_27_text_explicit_encryption(t *testing.T) {
}},
}},
}).Raw()
require.Equal(mt, err, mongo.ErrNoDocuments)
assert.ErrorIs(mt, err, mongo.ErrNoDocuments)
})
mt.Run("Case 7: assert contentionFactor is required", func(mt *mtest.T) {
mt.RunOpts("Case 7: assert contentionFactor is required", mtest.NewOptions().MaxServerVersion("8.99.99"), func(mt *mtest.T) {
Copy link
Copy Markdown
Contributor

@matthewdale matthewdale May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These commands will change to non-preview on 9.0+, so these tests will not be relevant for 9.0+.

encryptedClient, clientEncryption := testSetup()
defer clientEncryption.Close(context.Background())
defer encryptedClient.Disconnect(context.Background())
Expand Down
30 changes: 30 additions & 0 deletions testdata/client-side-encryption-prose/encryptedFields-substring.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"fields": [
{
"keyId": {
"$binary": {
"base64": "EjRWeBI0mHYSNBI0VniQEg==",
"subType": "04"
}
},
"path": "encryptedText",
"bsonType": "string",
"queries": [
{
"queryType": "substringPreview",
"strMaxLength": {
"$numberInt": "10"
},
"strMinQueryLength": {
"$numberInt": "2"
},
"strMaxQueryLength": {
"$numberInt": "10"
},
"caseSensitive": true,
"diacriticSensitive": true
}
]
}
]
}
Loading