search indexes

Author: baileympearson

.evergreen/config.in.yml

@@ -1663,9 +1663,9 @@ task_groups:
         params:
           working_dir: src
           binary: bash
-          add_expansions_to_env: true
           env:
             MONGODB_VERSION: "7.0"
+            CLUSTER_PREFIX: dbx-node-search-indexes
           args:
             - ${DRIVERS_TOOLS}/.evergreen/atlas/setup-atlas-cluster.sh
       - command: expansions.update
@@ -1676,7 +1676,6 @@ task_groups:
         params:
           working_dir: src
           binary: bash
-          add_expansions_to_env: true
           args:
             - ${DRIVERS_TOOLS}/.evergreen/atlas/teardown-atlas-cluster.sh
     setup_group_can_fail_task: true

.evergreen/config.yml

@@ -4680,9 +4680,9 @@ task_groups:
         params:
           working_dir: src
           binary: bash
-          add_expansions_to_env: true
           env:
             MONGODB_VERSION: '7.0'
+            CLUSTER_PREFIX: dbx-node-search-indexes
           args:
             - ${DRIVERS_TOOLS}/.evergreen/atlas/setup-atlas-cluster.sh
       - command: expansions.update
@@ -4693,7 +4693,6 @@ task_groups:
         params:
           working_dir: src
           binary: bash
-          add_expansions_to_env: true
           args:
             - ${DRIVERS_TOOLS}/.evergreen/atlas/teardown-atlas-cluster.sh
     setup_group_can_fail_task: true

test/readme.md

@@ -5,13 +5,40 @@ about the types of tests and how to run them.
 
 ## Table of Contents
 
-- [About the Tests](#about-the-tests)
-- [Running the Tests Locally](#running-the-tests-locally)
-- [Running the Tests in Evergreen](#running-the-tests-in-evergreen)
-- [Using a Pre-Release Version of a Dependent Library](#using-a-pre-release-version-of-a-dependent-library)
-- [Manually Testing the Driver](#manually-testing-the-driver)
-- [Writing Tests](#writing-tests)
-- [Testing with Special Environments](#testing-with-special-environments)
+- [MongoDB Node Driver Test Automation](#mongodb-node-driver-test-automation)
+  - [Table of Contents](#table-of-contents)
+  - [About the Tests](#about-the-tests)
+    - [Spec Tests](#spec-tests)
+  - [Running the Tests Locally](#running-the-tests-locally)
+    - [Testing With Authorization-Enabled](#testing-with-authorization-enabled)
+    - [Testing Different MongoDB Topologies](#testing-different-mongodb-topologies)
+    - [Running Individual Tests](#running-individual-tests)
+  - [Running the Tests in Evergreen](#running-the-tests-in-evergreen)
+    - [Manually Kicking Off Evergreen Builds](#manually-kicking-off-evergreen-builds)
+      - [Evergreen UI](#evergreen-ui)
+      - [Evergreen CLI](#evergreen-cli)
+        - [Setup](#setup)
+        - [Running the Build](#running-the-build)
+  - [Using a Pre-Release Version of a Dependent Library](#using-a-pre-release-version-of-a-dependent-library)
+  - [Manually Testing the Driver](#manually-testing-the-driver)
+  - [Writing Tests](#writing-tests)
+    - [Framework](#framework)
+    - [Skipping Tests](#skipping-tests)
+  - [Running Benchmarks](#running-benchmarks)
+    - [Configuration](#configuration)
+  - [Testing with Special Environments](#testing-with-special-environments)
+    - [Serverless](#serverless)
+    - [Load Balanced](#load-balanced)
+    - [Client-Side Field-Level Encryption (CSFLE)](#client-side-field-level-encryption-csfle)
+      - [KMIP FLE support tests](#kmip-fle-support-tests)
+    - [Deployed Atlas Tests](#deployed-atlas-tests)
+      - [Launching an Atlas Cluster](#launching-an-atlas-cluster)
+      - [Search Indexes](#search-indexes)
+      - [Deployed Lambda Tests](#deployed-lambda-tests)
+    - [TODO Special Env Sections](#todo-special-env-sections)
+  - [Testing driver changes with mongosh](#testing-driver-changes-with-mongosh)
+    - [Point mongosh to the driver](#point-mongosh-to-the-driver)
+    - [Run specific package tests](#run-specific-package-tests)
 
 ## About the Tests
 
@@ -568,44 +595,6 @@ The following steps will walk you through how to run the tests for CSFLE.
 
    To run the functional tests using the crypt shared library instead of `mongocryptd`, download the appropriate version of the crypt shared library for the enterprise server version [here](https://www.mongodb.com/download-center/enterprise/releases) and then set the location of it in the environment variable `CRYPT_SHARED_LIB_PATH`.
 
-#### Testing driver changes with mongosh
-
-These steps require `mongosh` to be available locally. Clone it from GitHub.
-
-`mongosh` uses a `lerna` monorepo. As a result, `mongosh` contains multiple references to the `mongodb` package
-in their `package.json`s.
-
-Set up `mongosh` by following the steps in the `mongosh` readme.
-
-##### Point mongosh to the driver
-
-mongosh contains a script that does this. To use the script, create an environment
- variable `REPLACE_PACKAGE` that contains a string in the form
-`mongodb:<path to your local instance of the driver>`. The package replacement script will replace
-all occurrences of `mongodb` with the local path of your driver.
-
-An alternative, which can be useful for
-testing a release, is to first run `npm pack` on the driver. This generates a tarball containing all the code
-that would be uploaded to `npm` if it were released. Then, set the environment variable `REPLACE_PACKAGE`
-with the full path to the file.
-
-Once the environment variable is set, run replace package in `mongosh` with:
-```sh
-npm run replace:package
-```
-
-##### Run specific package tests
-
-`mongosh`'s readme documents how to run its tests. Most likely, it isn't necessary to run all of mongosh's
-tests. The `mongosh` readme also documents how to run tests for a particular scope. The scopes are
-listed in the `generate_mongosh_tasks.js` evergreen generation script.
-
-For example, to run the `service-provider-server` package, run the following command in `mongosh`:
-
-```shell
-lerna run test --scope @mongosh/service-provider-server
-```
-
 #### KMIP FLE support tests
 
 1. Install `virtualenv`:
@@ -646,6 +635,28 @@ lerna run test --scope @mongosh/service-provider-server
    npx mocha --config test/mocha_mongodb.json test/integration/client-side-encryption/
    ```
 
+### Deployed Atlas Tests
+
+#### Launching an Atlas Cluster
+
+Using drivers evergreen tools, run the `setup-atlas-cluster` script.  You must also set the CLUSTER_PREFIX environment variable.
+
+```bash
+CLUSTER_PREFIX=dbx-node-lambda bash ${DRIVERS_TOOLS}/.evergreen/atlas/setup-atlas-cluster.sh
+```
+
+The URI of the cluster is available in the `atlas-expansions.yml` file.
+
+#### Search Indexes
+
+1. Set up an Atlas cluster, as outlined in the "Launching an Atlas Cluster" section.
+2. Add the URI of the cluster to the environment as the MONGODB_URI environment variable.
+3. Run the tests with `npm run check:search-indexes`.
+
+#### Deployed Lambda Tests
+
+TODO
+
 ### TODO Special Env Sections
 
 - Kerberos
@@ -672,3 +683,41 @@ lerna run test --scope @mongosh/service-provider-server
 [npm-csfle]: https://www.npmjs.com/package/mongodb-client-encryption
 [atlas-api-key]: https://docs.atlas.mongodb.com/tutorial/configure-api-access/organization/create-one-api-key
 [scram-auth]: https://docs.atlas.mongodb.com/security-add-mongodb-users/#database-user-authentication
+
+## Testing driver changes with mongosh
+
+These steps require `mongosh` to be available locally. Clone it from GitHub.
+
+`mongosh` uses a `lerna` monorepo. As a result, `mongosh` contains multiple references to the `mongodb` package
+in their `package.json`s.
+
+Set up `mongosh` by following the steps in the `mongosh` readme.
+
+### Point mongosh to the driver
+
+mongosh contains a script that does this. To use the script, create an environment
+ variable `REPLACE_PACKAGE` that contains a string in the form
+`mongodb:<path to your local instance of the driver>`. The package replacement script will replace
+all occurrences of `mongodb` with the local path of your driver.
+
+An alternative, which can be useful for
+testing a release, is to first run `npm pack` on the driver. This generates a tarball containing all the code
+that would be uploaded to `npm` if it were released. Then, set the environment variable `REPLACE_PACKAGE`
+with the full path to the file.
+
+Once the environment variable is set, run replace package in `mongosh` with:
+```sh
+npm run replace:package
+```
+
+### Run specific package tests
+
+`mongosh`'s readme documents how to run its tests. Most likely, it isn't necessary to run all of mongosh's
+tests. The `mongosh` readme also documents how to run tests for a particular scope. The scopes are
+listed in the `generate_mongosh_tasks.js` evergreen generation script.
+
+For example, to run the `service-provider-server` package, run the following command in `mongosh`:
+
+```shell
+lerna run test --scope @mongosh/service-provider-server
+```