adopt changes to unified test format 1.25

baileympearson · baileympearson · commit d57aaa0b4226 · 2025-07-31T12:01:51.000-06:00
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-cleanupStructuredEncryptionData.json b/test/spec/client-side-encryption/tests/unified/QE-Text-cleanupStructuredEncryptionData.json
@@ -1,6 +1,6 @@
 {
   "description": "QE-Text-cleanupStructuredEncryptionData",
-  "schemaVersion": "1.23",
+  "schemaVersion": "1.25",
   "runOnRequirements": [
     {
       "minServerVersion": "8.2.0",
@@ -9,7 +9,9 @@
         "sharded",
         "load-balanced"
       ],
-      "csfle": true
+      "csfle": {
+        "minLibmongocryptVersion": "1.15.0"
+      }
     }
   ],
   "createEntities": [
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-cleanupStructuredEncryptionData.yml b/test/spec/client-side-encryption/tests/unified/QE-Text-cleanupStructuredEncryptionData.yml
@@ -1,10 +1,10 @@
 description: QE-Text-cleanupStructuredEncryptionData
-schemaVersion: "1.23"
+schemaVersion: "1.25"
 runOnRequirements:
-  # Requires libmongocrypt 1.15.0 for SPM-4158.
   - minServerVersion: "8.2.0" # Server 8.2.0 adds preview support for QE text queries.
     topologies: ["replicaset", "sharded", "load-balanced"] # QE does not support standalone.
-    csfle: true
+    csfle:
+      minLibmongocryptVersion: 1.15.0 # For SPM-4158.
 createEntities:
   - client:
       id: &client "client"
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-compactStructuredEncryptionData.json b/test/spec/client-side-encryption/tests/unified/QE-Text-compactStructuredEncryptionData.json
@@ -1,6 +1,6 @@
 {
   "description": "QE-Text-compactStructuredEncryptionData",
-  "schemaVersion": "1.23",
+  "schemaVersion": "1.25",
   "runOnRequirements": [
     {
       "minServerVersion": "8.2.0",
@@ -9,7 +9,9 @@
         "sharded",
         "load-balanced"
       ],
-      "csfle": true
+      "csfle": {
+        "minLibmongocryptVersion": "1.15.0"
+      }
     }
   ],
   "createEntities": [
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-compactStructuredEncryptionData.yml b/test/spec/client-side-encryption/tests/unified/QE-Text-compactStructuredEncryptionData.yml
@@ -1,10 +1,10 @@
 description: QE-Text-compactStructuredEncryptionData
-schemaVersion: "1.23"
+schemaVersion: "1.25"
 runOnRequirements:
-  # Requires libmongocrypt 1.15.0 for SPM-4158.
   - minServerVersion: "8.2.0" # Server 8.2.0 adds preview support for QE text queries.
     topologies: ["replicaset", "sharded", "load-balanced"] # QE does not support standalone.
-    csfle: true
+    csfle:
+      minLibmongocryptVersion: 1.15.0 # For SPM-4158.
 createEntities:
   - client:
       id: &client "client"
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-prefixPreview.json b/test/spec/client-side-encryption/tests/unified/QE-Text-prefixPreview.json
@@ -1,6 +1,6 @@
 {
   "description": "QE-Text-prefixPreview",
-  "schemaVersion": "1.23",
+  "schemaVersion": "1.25",
   "runOnRequirements": [
     {
       "minServerVersion": "8.2.0",
@@ -9,7 +9,9 @@
         "sharded",
         "load-balanced"
       ],
-      "csfle": true
+      "csfle": {
+        "minLibmongocryptVersion": "1.15.0"
+      }
     }
   ],
   "createEntities": [
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-prefixPreview.yml b/test/spec/client-side-encryption/tests/unified/QE-Text-prefixPreview.yml
@@ -1,10 +1,10 @@
 description: QE-Text-prefixPreview
-schemaVersion: "1.23"
+schemaVersion: "1.25"
 runOnRequirements:
-  # Requires libmongocrypt 1.15.0 for SPM-4158.
   - minServerVersion: "8.2.0" # Server 8.2.0 adds preview support for QE text queries.
     topologies: ["replicaset", "sharded", "load-balanced"] # QE does not support standalone.
-    csfle: true
+    csfle:
+      minLibmongocryptVersion: 1.15.0 # For SPM-4158.
 createEntities:
   - client:
       id: &client "client"
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-substringPreview.json b/test/spec/client-side-encryption/tests/unified/QE-Text-substringPreview.json
@@ -1,6 +1,6 @@
 {
   "description": "QE-Text-substringPreview",
-  "schemaVersion": "1.23",
+  "schemaVersion": "1.25",
   "runOnRequirements": [
     {
       "minServerVersion": "8.2.0",
@@ -9,7 +9,9 @@
         "sharded",
         "load-balanced"
       ],
-      "csfle": true
+      "csfle": {
+        "minLibmongocryptVersion": "1.15.0"
+      }
     }
   ],
   "createEntities": [
@@ -546,4 +548,4 @@
       ]
     }
   ]
-}
+}
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-substringPreview.yml b/test/spec/client-side-encryption/tests/unified/QE-Text-substringPreview.yml
@@ -1,10 +1,10 @@
-description: QE-Text-suffixPreview
-schemaVersion: "1.23"
+description: QE-Text-substringPreview
+schemaVersion: "1.25"
 runOnRequirements:
-  # Requires libmongocrypt 1.15.0 for SPM-4158.
   - minServerVersion: "8.2.0" # Server 8.2.0 adds preview support for QE text queries.
     topologies: ["replicaset", "sharded", "load-balanced"] # QE does not support standalone.
-    csfle: true
+    csfle:
+      minLibmongocryptVersion: 1.15.0 # For SPM-4158.
 createEntities:
   - client:
       id: &client "client"
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-suffixPreview.json b/test/spec/client-side-encryption/tests/unified/QE-Text-suffixPreview.json
@@ -1,6 +1,6 @@
 {
   "description": "QE-Text-suffixPreview",
-  "schemaVersion": "1.23",
+  "schemaVersion": "1.25",
   "runOnRequirements": [
     {
       "minServerVersion": "8.2.0",
@@ -9,7 +9,9 @@
         "sharded",
         "load-balanced"
       ],
-      "csfle": true
+      "csfle": {
+        "minLibmongocryptVersion": "1.15.0"
+      }
     }
   ],
   "createEntities": [
diff --git a/test/spec/client-side-encryption/tests/unified/QE-Text-suffixPreview.yml b/test/spec/client-side-encryption/tests/unified/QE-Text-suffixPreview.yml
@@ -1,10 +1,10 @@
 description: QE-Text-suffixPreview
-schemaVersion: "1.23"
+schemaVersion: "1.25"
 runOnRequirements:
-  # Requires libmongocrypt 1.15.0 for SPM-4158.
   - minServerVersion: "8.2.0" # Server 8.2.0 adds preview support for QE text queries.
     topologies: ["replicaset", "sharded", "load-balanced"] # QE does not support standalone.
-    csfle: true
+    csfle:
+      minLibmongocryptVersion: 1.15.0 # For SPM-4158.
 createEntities:
   - client:
       id: &client "client"
diff --git a/test/tools/unified-spec-runner/schema.ts b/test/tools/unified-spec-runner/schema.ts
@@ -113,7 +113,11 @@ export interface RunOnRequirement {
   minServerVersion?: string;
   topologies?: TopologyName[];
   serverParameters?: Document;
-  csfle?: boolean;
+  csfle?:
+    | boolean
+    | {
+        minLibmongocryptVersion?: string;
+      };
 }
 export type ObservableCommandEventId =
   | 'commandStartedEvent'
diff --git a/test/tools/unified-spec-runner/unified-utils.ts b/test/tools/unified-spec-runner/unified-utils.ts
@@ -1,6 +1,6 @@
 import { AssertionError, expect } from 'chai';
 import ConnectionString from 'mongodb-connection-string-url';
-import { gte as semverGte, lte as semverLte } from 'semver';
+import { coerce, gte as semverGte, lte as semverLte } from 'semver';
 import { isDeepStrictEqual } from 'util';
 
 /* eslint-disable @typescript-eslint/no-restricted-imports */
@@ -115,23 +115,33 @@ export async function topologySatisfies(
     }
   }
 
-  if (typeof r.csfle === 'boolean') {
-    const versionSupportsCSFLE = semverGte(config.version, '4.2.0');
+  if (r.csfle != null) {
     const csfleEnabled = config.clientSideEncryption.enabled;
 
-    if (r.csfle) {
-      ok &&= versionSupportsCSFLE && csfleEnabled;
+    if (r.csfle === false) {
+      ok &&= !csfleEnabled;
       if (!ok && skipReason == null) {
-        skipReason = versionSupportsCSFLE
-          ? `requires csfle to run but CSFLE is not set for this environment`
-          : 'requires mongodb >= 4.2 to run csfle tests';
+        skipReason = `forbids csfle to run but CSFLE is set for this environment`;
       }
     } else {
-      ok &&= !(csfleEnabled && versionSupportsCSFLE);
+      // first, confirm that CSFLE is enabled
+      ok &&= csfleEnabled;
       if (!ok && skipReason == null) {
-        skipReason = versionSupportsCSFLE
-          ? `forbids csfle to run but CSFLE is set for this environment`
-          : 'forbids mongodb >= 4.2 to run csfle tests';
+        skipReason = `requires csfle to run but CSFLE is not set for this environment`;
+      }
+
+      // then, confirm that libmongocrypt satisfies the version constraint (if it exists)
+      const minLibmongocryptVersion: string | undefined =
+        typeof r.csfle === 'object' && r.csfle.minLibmongocryptVersion;
+
+      if (typeof minLibmongocryptVersion === 'string') {
+        ok &&= semverGte(
+          coerce(config.clientSideEncryption.libmongocrypt),
+          coerce(minLibmongocryptVersion)
+        );
+        if (!ok && skipReason == null) {
+          skipReason = `requires libmongocrypt>=${minLibmongocryptVersion} but ${config.clientSideEncryption.libmongocrypt} is being used.`;
+        }
       }
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"description": "QE-Text-cleanupStructuredEncryptionData",`
`3`		`- "schemaVersion": "1.23",`
	`3`	`+ "schemaVersion": "1.25",`
`4`	`4`	`"runOnRequirements": [`
`5`	`5`	`{`
`6`	`6`	`"minServerVersion": "8.2.0",`
`@@ -9,7 +9,9 @@`
`9`	`9`	`"sharded",`
`10`	`10`	`"load-balanced"`
`11`	`11`	`],`
`12`		`- "csfle": true`
	`12`	`+ "csfle": {`
	`13`	`+ "minLibmongocryptVersion": "1.15.0"`
	`14`	`+ }`
`13`	`15`	`}`
`14`	`16`	`],`
`15`	`17`	`"createEntities": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"description": "QE-Text-compactStructuredEncryptionData",`
`3`		`- "schemaVersion": "1.23",`
	`3`	`+ "schemaVersion": "1.25",`
`4`	`4`	`"runOnRequirements": [`
`5`	`5`	`{`
`6`	`6`	`"minServerVersion": "8.2.0",`
`@@ -9,7 +9,9 @@`
`9`	`9`	`"sharded",`
`10`	`10`	`"load-balanced"`
`11`	`11`	`],`
`12`		`- "csfle": true`
	`12`	`+ "csfle": {`
	`13`	`+ "minLibmongocryptVersion": "1.15.0"`
	`14`	`+ }`
`13`	`15`	`}`
`14`	`16`	`],`
`15`	`17`	`"createEntities": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"description": "QE-Text-prefixPreview",`
`3`		`- "schemaVersion": "1.23",`
	`3`	`+ "schemaVersion": "1.25",`
`4`	`4`	`"runOnRequirements": [`
`5`	`5`	`{`
`6`	`6`	`"minServerVersion": "8.2.0",`
`@@ -9,7 +9,9 @@`
`9`	`9`	`"sharded",`
`10`	`10`	`"load-balanced"`
`11`	`11`	`],`
`12`		`- "csfle": true`
	`12`	`+ "csfle": {`
	`13`	`+ "minLibmongocryptVersion": "1.15.0"`
	`14`	`+ }`
`13`	`15`	`}`
`14`	`16`	`],`
`15`	`17`	`"createEntities": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"description": "QE-Text-substringPreview",`
`3`		`- "schemaVersion": "1.23",`
	`3`	`+ "schemaVersion": "1.25",`
`4`	`4`	`"runOnRequirements": [`
`5`	`5`	`{`
`6`	`6`	`"minServerVersion": "8.2.0",`
`@@ -9,7 +9,9 @@`
`9`	`9`	`"sharded",`
`10`	`10`	`"load-balanced"`
`11`	`11`	`],`
`12`		`- "csfle": true`
	`12`	`+ "csfle": {`
	`13`	`+ "minLibmongocryptVersion": "1.15.0"`
	`14`	`+ }`
`13`	`15`	`}`
`14`	`16`	`],`
`15`	`17`	`"createEntities": [`
`@@ -546,4 +548,4 @@`
`546`	`548`	`]`
`547`	`549`	`}`
`548`	`550`	`]`
`549`		`-}`
	`551`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"description": "QE-Text-suffixPreview",`
`3`		`- "schemaVersion": "1.23",`
	`3`	`+ "schemaVersion": "1.25",`
`4`	`4`	`"runOnRequirements": [`
`5`	`5`	`{`
`6`	`6`	`"minServerVersion": "8.2.0",`
`@@ -9,7 +9,9 @@`
`9`	`9`	`"sharded",`
`10`	`10`	`"load-balanced"`
`11`	`11`	`],`
`12`		`- "csfle": true`
	`12`	`+ "csfle": {`
	`13`	`+ "minLibmongocryptVersion": "1.15.0"`
	`14`	`+ }`
`13`	`15`	`}`
`14`	`16`	`],`
`15`	`17`	`"createEntities": [`