list search index tests working on atlas

baileympearson · baileympearson · commit 5c4c0ee1d40f · 2023-06-21T11:54:45.000-06:00
diff --git a/test/manual/search-index-management.spec.test.ts b/test/manual/search-index-management.spec.test.ts
@@ -4,5 +4,10 @@ import { loadSpecTests } from '../spec';
 import { runUnifiedSuite } from '../tools/unified-spec-runner/runner';
 
 describe('Search Index Management Tests (Unified)', function () {
-  runUnifiedSuite(loadSpecTests(join('index-management')));
+  before(function () {
+    this.configuration = this.configuration.makeAtlasTestConfiguration();
+  });
+  runUnifiedSuite(loadSpecTests(join('index-management')), test =>
+    test.description.includes('test') ? false : 'skipped'
+  );
 });
diff --git a/test/spec/index-management/listSearchIndexes.json b/test/spec/index-management/listSearchIndexes.json
@@ -13,16 +13,16 @@
     },
     {
       "database": {
-        "id": "database0",
+        "id": "shared",
         "client": "client0",
-        "databaseName": "database0"
+        "databaseName": "shared"
       }
     },
     {
       "collection": {
-        "id": "collection0",
-        "database": "database0",
-        "collectionName": "collection0"
+        "id": "list-search-indexes",
+        "database": "shared",
+        "collectionName": "list-search-indexes"
       }
     }
   ],
@@ -34,19 +34,22 @@
         "load-balanced",
         "sharded"
       ],
-      "serverless": "forbid"
+      "serverless": "forbid",
+      "atlas": true
     }
   ],
   "tests": [
     {
-      "description": "when no name is provided, it does not populate the filter",
+      "description": "test when no name is provided, it does not populate the filter",
       "operations": [
         {
           "name": "listSearchIndexes",
-          "object": "collection0",
-          "expectError": {
-            "isError": true
-          }
+          "object": "list-search-indexes",
+          "expectResult": [
+            {
+              "name": "default"
+            }
+          ]
         }
       ],
       "expectEvents": [
@@ -56,7 +59,7 @@
             {
               "commandStartedEvent": {
                 "command": {
-                  "aggregate": "collection0",
+                  "aggregate": "list-search-indexes",
                   "pipeline": [
                     {
                       "$listSearchIndexes": {}
@@ -70,17 +73,15 @@
       ]
     },
     {
-      "description": "when a name is provided, it is present in the filter",
+      "description": "test when a name is provided, it is present in the filter",
       "operations": [
         {
           "name": "listSearchIndexes",
-          "object": "collection0",
+          "object": "list-search-indexes",
           "arguments": {
-            "name": "test index"
+            "name": "test-index"
           },
-          "expectError": {
-            "isError": true
-          }
+          "expectResult": []
         }
       ],
       "expectEvents": [
@@ -90,15 +91,15 @@
             {
               "commandStartedEvent": {
                 "command": {
-                  "aggregate": "collection0",
+                  "aggregate": "list-search-indexes",
                   "pipeline": [
                     {
                       "$listSearchIndexes": {
-                        "name": "test index"
+                        "name": "test-index"
                       }
                     }
                   ],
-                  "$db": "database0"
+                  "$db": "shared"
                 }
               }
             }
@@ -107,20 +108,21 @@
       ]
     },
     {
-      "description": "aggregation cursor options are supported",
+      "description": "test aggregation cursor options are supported",
       "operations": [
         {
           "name": "listSearchIndexes",
-          "object": "collection0",
+          "object": "list-search-indexes",
           "arguments": {
-            "name": "test index",
             "aggregationOptions": {
               "batchSize": 10
             }
           },
-          "expectError": {
-            "isError": true
-          }
+          "expectResult": [
+            {
+              "name": "default"
+            }
+          ]
         }
       ],
       "expectEvents": [
@@ -130,18 +132,16 @@
             {
               "commandStartedEvent": {
                 "command": {
-                  "aggregate": "collection0",
+                  "aggregate": "list-search-indexes",
                   "cursor": {
                     "batchSize": 10
                   },
                   "pipeline": [
                     {
-                      "$listSearchIndexes": {
-                        "name": "test index"
-                      }
+                      "$listSearchIndexes": {}
                     }
                   ],
-                  "$db": "database0"
+                  "$db": "shared"
                 }
               }
             }
diff --git a/test/spec/index-management/listSearchIndexes.yml b/test/spec/index-management/listSearchIndexes.yml
@@ -1,3 +1,5 @@
+# yaml-language-server: $schema=/Users/bailey.pearson/dev/specifications/source/unified-test-format/schema-1.15.json
+
 description: "listSearchIndexes"
 schemaVersion: "1.4"
 createEntities:
@@ -7,28 +9,27 @@ createEntities:
       observeEvents:
         - commandStartedEvent
   - database:
-      id: &database0 database0
+      id: &database0 shared
       client: *client0
       databaseName: *database0
   - collection:
-      id: &collection0 collection0
+      id: &collection0 list-search-indexes
       database: *database0
       collectionName: *collection0
 
 runOnRequirements:
   - minServerVersion: "7.0.0"
     topologies: [ replicaset, load-balanced, sharded ]
     serverless: forbid
+    atlas: true
 
 tests:
-  - description: "when no name is provided, it does not populate the filter"
+  - description: "test when no name is provided, it does not populate the filter"
     operations:
       - name: listSearchIndexes
         object: *collection0
-        expectError:
-          # Search indexes are only available on 7.0+ atlas clusters.  DRIVERS-2630 will add e2e testing 
-          # against an Atlas cluster and the expectError will be removed.
-          isError: true
+        expectResult: [ { name: default } ]
+    
     expectEvents:
       - client: *client0
         events:
@@ -38,16 +39,14 @@ tests:
                 pipeline:
                   - $listSearchIndexes: {}
 
-  - description: "when a name is provided, it is present in the filter"
+  - description: "test when a name is provided, it is present in the filter"
     operations:
       - name: listSearchIndexes
         object: *collection0
         arguments: 
-          name: &indexName "test index"
-        expectError:
-          # Search indexes are only available on 7.0+ atlas clusters.  DRIVERS-2630 will add e2e testing 
-          # against an Atlas cluster and the expectError will be removed.
-          isError: true
+          name: &indexName "test-index"
+        expectResult: []
+
     expectEvents:
       - client: *client0
         events:
@@ -58,18 +57,15 @@ tests:
                   - $listSearchIndexes: { name: *indexName }
                 $db: *database0
 
-  - description: aggregation cursor options are supported
+  - description: test aggregation cursor options are supported
     operations:
       - name: listSearchIndexes
         object: *collection0
         arguments: 
-          name: &indexName "test index"
           aggregationOptions: 
             batchSize: 10
-        expectError:
-          # Search indexes are only available on 7.0+ atlas clusters.  DRIVERS-2630 will add e2e testing 
-          # against an Atlas cluster and the expectError will be removed.
-          isError: true
+        expectResult: [ { name: default } ]
+
     expectEvents:
       - client: *client0
         events:
@@ -78,5 +74,5 @@ tests:
                 aggregate: *collection0
                 cursor: { batchSize: 10 }
                 pipeline:
-                  - $listSearchIndexes: { name: *indexName }
+                  - $listSearchIndexes: { }
                 $db: *database0
diff --git a/test/tools/runner/config.ts b/test/tools/runner/config.ts
@@ -72,8 +72,9 @@ export class TestConfiguration {
     proxyURIParams?: ProxyParams;
   };
   serverApi: string;
+  isAtlas: boolean;
 
-  constructor(uri: string, context: Record<string, any>) {
+  constructor(private uri: string, private context: Record<string, any>) {
     const url = new ConnectionString(uri);
     const { hosts } = url;
     const hostAddresses = hosts.map(HostAddress.fromString);
@@ -116,6 +117,7 @@ export class TestConfiguration {
       const { username, password } = context.serverlessCredentials;
       this.options.auth = { username, password, authSource: 'admin' };
     }
+    this.isAtlas = process.env.IS_ATLAS === 'true';
   }
 
   get isLoadBalanced() {
@@ -358,4 +360,23 @@ export class TestConfiguration {
   kmsProviders(localKey): Record<string, any> {
     return { local: { key: localKey } };
   }
+
+  makeAtlasTestConfiguration(): AtlasTestConfiguration {
+    return new AtlasTestConfiguration(this.uri, this.context);
+  }
+}
+
+/**
+ * A specialized configuration used to connect to Atlas for testing.
+ *
+ * This class requires that the Atlas srv URI is set as the `MONGODB_URI` in the environment.
+ */
+export class AtlasTestConfiguration extends TestConfiguration {
+  override newClient(): MongoClient {
+    return new MongoClient(process.env.MONGODB_URI!);
+  }
+
+  override url(): string {
+    return process.env.MONGODB_URI!;
+  }
 }
diff --git a/test/tools/unified-spec-runner/match.ts b/test/tools/unified-spec-runner/match.ts
@@ -220,7 +220,10 @@ export function resultCheck(
     }
 
     if (typeof actual !== 'object') {
-      expect.fail('Expected actual value to be an object');
+      const error = { expected, actual, path };
+      expect.fail(
+        `Error matching.  Expected an object but received something else. ${inspect(error)}`
+      );
     }
 
     const expectedEntries = Object.entries(expected);
diff --git a/test/tools/unified-spec-runner/schema.ts b/test/tools/unified-spec-runner/schema.ts
@@ -114,6 +114,7 @@ export interface RunOnRequirement {
   topologies?: TopologyId[];
   serverParameters?: Document;
   csfle?: boolean;
+  atlas?: boolean;
 }
 export type ObservableCommandEventId =
   | 'commandStartedEvent'
diff --git a/test/tools/unified-spec-runner/unified-utils.ts b/test/tools/unified-spec-runner/unified-utils.ts
@@ -132,6 +132,20 @@ export async function topologySatisfies(
     }
   }
 
+  if (typeof r.atlas === 'boolean') {
+    if (r.atlas) {
+      ok &&= config.isAtlas;
+      if (!ok) {
+        skipReason = `Tests must be connected to atlas.`;
+      }
+    } else {
+      ok &&= !config.isAtlas;
+      if (!ok) {
+        skipReason = `Tests must NOT be connected to atlas.`;
+      }
+    }
+  }
+
   if (!ok && skipReason != null) {
     if (ctx.currentTest) {
       // called from beforeEach hook

Original file line number	Diff line number	Diff line change
`@@ -13,16 +13,16 @@`
`13`	`13`	`},`
`14`	`14`	`{`
`15`	`15`	`"database": {`
`16`		`- "id": "database0",`
	`16`	`+ "id": "shared",`
`17`	`17`	`"client": "client0",`
`18`		`- "databaseName": "database0"`
	`18`	`+ "databaseName": "shared"`
`19`	`19`	`}`
`20`	`20`	`},`
`21`	`21`	`{`
`22`	`22`	`"collection": {`
`23`		`- "id": "collection0",`
`24`		`- "database": "database0",`
`25`		`- "collectionName": "collection0"`
	`23`	`+ "id": "list-search-indexes",`
	`24`	`+ "database": "shared",`
	`25`	`+ "collectionName": "list-search-indexes"`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`	`],`
`@@ -34,19 +34,22 @@`
`34`	`34`	`"load-balanced",`
`35`	`35`	`"sharded"`
`36`	`36`	`],`
`37`		`- "serverless": "forbid"`
	`37`	`+ "serverless": "forbid",`
	`38`	`+ "atlas": true`
`38`	`39`	`}`
`39`	`40`	`],`
`40`	`41`	`"tests": [`
`41`	`42`	`{`
`42`		`- "description": "when no name is provided, it does not populate the filter",`
	`43`	`+ "description": "test when no name is provided, it does not populate the filter",`
`43`	`44`	`"operations": [`
`44`	`45`	`{`
`45`	`46`	`"name": "listSearchIndexes",`
`46`		`- "object": "collection0",`
`47`		`- "expectError": {`
`48`		`- "isError": true`
`49`		`- }`
	`47`	`+ "object": "list-search-indexes",`
	`48`	`+ "expectResult": [`
	`49`	`+ {`
	`50`	`+ "name": "default"`
	`51`	`+ }`
	`52`	`+ ]`
`50`	`53`	`}`
`51`	`54`	`],`
`52`	`55`	`"expectEvents": [`
`@@ -56,7 +59,7 @@`
`56`	`59`	`{`
`57`	`60`	`"commandStartedEvent": {`
`58`	`61`	`"command": {`
`59`		`- "aggregate": "collection0",`
	`62`	`+ "aggregate": "list-search-indexes",`
`60`	`63`	`"pipeline": [`
`61`	`64`	`{`
`62`	`65`	`"$listSearchIndexes": {}`
`@@ -70,17 +73,15 @@`
`70`	`73`	`]`
`71`	`74`	`},`
`72`	`75`	`{`
`73`		`- "description": "when a name is provided, it is present in the filter",`
	`76`	`+ "description": "test when a name is provided, it is present in the filter",`
`74`	`77`	`"operations": [`
`75`	`78`	`{`
`76`	`79`	`"name": "listSearchIndexes",`
`77`		`- "object": "collection0",`
	`80`	`+ "object": "list-search-indexes",`
`78`	`81`	`"arguments": {`
`79`		`- "name": "test index"`
	`82`	`+ "name": "test-index"`
`80`	`83`	`},`
`81`		`- "expectError": {`
`82`		`- "isError": true`
`83`		`- }`
	`84`	`+ "expectResult": []`
`84`	`85`	`}`
`85`	`86`	`],`
`86`	`87`	`"expectEvents": [`
`@@ -90,15 +91,15 @@`
`90`	`91`	`{`
`91`	`92`	`"commandStartedEvent": {`
`92`	`93`	`"command": {`
`93`		`- "aggregate": "collection0",`
	`94`	`+ "aggregate": "list-search-indexes",`
`94`	`95`	`"pipeline": [`
`95`	`96`	`{`
`96`	`97`	`"$listSearchIndexes": {`
`97`		`- "name": "test index"`
	`98`	`+ "name": "test-index"`
`98`	`99`	`}`
`99`	`100`	`}`
`100`	`101`	`],`
`101`		`- "$db": "database0"`
	`102`	`+ "$db": "shared"`
`102`	`103`	`}`
`103`	`104`	`}`
`104`	`105`	`}`
`@@ -107,20 +108,21 @@`
`107`	`108`	`]`
`108`	`109`	`},`
`109`	`110`	`{`
`110`		`- "description": "aggregation cursor options are supported",`
	`111`	`+ "description": "test aggregation cursor options are supported",`
`111`	`112`	`"operations": [`
`112`	`113`	`{`
`113`	`114`	`"name": "listSearchIndexes",`
`114`		`- "object": "collection0",`
	`115`	`+ "object": "list-search-indexes",`
`115`	`116`	`"arguments": {`
`116`		`- "name": "test index",`
`117`	`117`	`"aggregationOptions": {`
`118`	`118`	`"batchSize": 10`
`119`	`119`	`}`
`120`	`120`	`},`
`121`		`- "expectError": {`
`122`		`- "isError": true`
`123`		`- }`
	`121`	`+ "expectResult": [`
	`122`	`+ {`
	`123`	`+ "name": "default"`
	`124`	`+ }`
	`125`	`+ ]`
`124`	`126`	`}`
`125`	`127`	`],`
`126`	`128`	`"expectEvents": [`
`@@ -130,18 +132,16 @@`
`130`	`132`	`{`
`131`	`133`	`"commandStartedEvent": {`
`132`	`134`	`"command": {`
`133`		`- "aggregate": "collection0",`
	`135`	`+ "aggregate": "list-search-indexes",`
`134`	`136`	`"cursor": {`
`135`	`137`	`"batchSize": 10`
`136`	`138`	`},`
`137`	`139`	`"pipeline": [`
`138`	`140`	`{`
`139`		`- "$listSearchIndexes": {`
`140`		`- "name": "test index"`
`141`		`- }`
	`141`	`+ "$listSearchIndexes": {}`
`142`	`142`	`}`
`143`	`143`	`],`
`144`		`- "$db": "database0"`
	`144`	`+ "$db": "shared"`
`145`	`145`	`}`
`146`	`146`	`}`
`147`	`147`	`}`
Original file line number	Diff line number	Diff line change
`@@ -220,7 +220,10 @@ export function resultCheck(`
`220`	`220`	`}`
`221`	`221`
`222`	`222`	`if (typeof actual !== 'object') {`
`223`		`- expect.fail('Expected actual value to be an object');`
	`223`	`+ const error = { expected, actual, path };`
	`224`	`+ expect.fail(`
	`225`	+ `Error matching. Expected an object but received something else. ${inspect(error)}`
	`226`	`+ );`
`224`	`227`	`}`
`225`	`228`
`226`	`229`	`const expectedEntries = Object.entries(expected);`
Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,7 @@ export interface RunOnRequirement {`
`114`	`114`	`topologies?: TopologyId[];`
`115`	`115`	`serverParameters?: Document;`
`116`	`116`	`csfle?: boolean;`
	`117`	`+ atlas?: boolean;`
`117`	`118`	`}`
`118`	`119`	`export type ObservableCommandEventId =`
`119`	`120`	`\| 'commandStartedEvent'`