Skip to content

chore: update local cluster setup instructions #4662

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
merged 3 commits into from
Sep 17, 2025
Merged

chore: update local cluster setup instructions #4662

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0011663
update readme
baileympearson Sep 16, 2025
59470d1
phrasing
baileympearson Sep 16, 2025
49259fd
remove noauth setting
baileympearson Sep 17, 2025
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
23 changes: 19 additions & 4 deletions test/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ about the types of tests and how to run them.
- [Kerberos Tests](#kerberos-tests)
- [AWS Authentication tests](#aws-authentication-tests)
- [Container Tests](#container-tests)
- [GCP](#gcp)
- [Azure](#azure)
- [AWS](#aws)
- [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)
Expand Down Expand Up @@ -76,7 +79,7 @@ The actual implementations of the spec tests can be unit tests or integration te

## Running the Tests Locally

The easiest way to get started running the tests locally is to start a standalone server and run all of the tests.
The easiest way to get started running the tests locally is to start a replica set and run all of the integration tests.

Ensure the drivers tools submodule is cloned:

Expand All @@ -85,16 +88,28 @@ git submodule init
git submodule update
```

Start a `mongod` standalone with our [run-orchestration.sh](.evergreen/run-orchestration.sh) script with the environment set for the cluster:
Set the `DRIVERS_TOOLS` environment variable:

```sh
VERSION='latest' TOPOLOGY='server' AUTH='noauth' ./.evergreen/run-orchestration.sh
export DRIVERS_TOOLS=<path to driver>/drivers-evergreen-tools
```

Start a replica set with our [run-orchestration.sh](.evergreen/run-orchestration.sh) script with the environment set for the cluster:

```sh
VERSION='latest' TOPOLOGY='replica_set' bash .evergreen/run-orchestration.sh
```

Load the new cluster's URI into the environment:

```sh
source mo-expansion.sh
```

Then run the tests:

```sh
npm test
npm run check:test
```

> **Note:** the command above will run a subset of the tests that work with the standalone server topology since the tests are being run against a standalone server.
Expand Down