Skip to content

docs: add info about testing with different versions and the rosetta setup for Mac #4707

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: add info about testing with different versions and the rosetta setup for Mac #4707

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1d467e
doc: add info about testing with different versions and the rosetta s…
PavelSafronov Oct 1, 2025
6441bda
space
PavelSafronov Oct 1, 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
37 changes: 33 additions & 4 deletions test/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ about the types of tests and how to run them.
- [About the Tests](#about-the-tests)
- [Spec Tests](#spec-tests)
- [Running the Tests Locally](#running-the-tests-locally)
- [Testing Against Different Versions](#testing-against-different-versions)
- ["Bad CPU type in executable" error](#bad-cpu-type-in-executable-error)
- [Testing With Authorization-Enabled](#testing-with-authorization-enabled)
- [Testing Different MongoDB Topologies](#testing-different-mongodb-topologies)
- [Running Individual Tests](#running-individual-tests)
Expand Down Expand Up @@ -118,6 +120,33 @@ The output will show how many tests passed, failed, and are pending. Tests that

In the following subsections, we'll dig into the details of running the tests.

### Testing Against Different Versions

Sometimes you'll need to run tests against a specific version, such as "7.0", and to do that you can use the `VERSION` env var.

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

Older versions of MongoDB may not have Mac binaries, so you may also need to specify a different architecture:

```sh
VERSION=4.2 ARCH=x86_64 TOPOLOGY='replica_set' bash .evergreen/run-orchestration.sh
Copy link
Member

Choose a reason for hiding this comment

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

The architecture here is what's causing the need for Rosetta to be installed. ARCH on Apple silicon should be arm64 to get the correct binaries.

Copy link
Contributor

Choose a reason for hiding this comment

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

The server doesn't have arm64 builds for servers <5.0 (I think 5.0 is the correct version, it was somewhere after 4.4). You must override driver-evergreen-tool's architecture inference and use rosetta if running an older server version on an arm mac.

```

#### "Bad CPU type in executable" error

You may encounter this error if Rosetta isn't properly configured on your system.
```txt
OSError: [Errno 86] Bad CPU type in executable: '.../node-mongodb-native/drivers-evergreen-tools/mongodb/bin/mongod'
```

To fix it, simply run:

```sh
softwareupdate --install-rosetta
```

### Testing With Authorization-Enabled

By default, the integration tests run with auth-enabled and the mongo orchestration script will run with auth enabled when the `AUTH` variable is set to `auth`. Tests can be run locally without auth by setting the environment variable `AUTH` to the value of `noauth`. This must be a two-step process of starting a server without auth-enabled and then running the tests without auth-enabled.
Expand Down Expand Up @@ -505,7 +534,7 @@ The following steps will walk you through how to run the tests for CSFLE.
```bash
npm install mongodb-client-encryption
```
> [!NOTE]
> [!NOTE]
> If developing changes in `mongodb-client-encryption`, you can link it locally using `etc/tooling/fle.sh`.

2. Load FLE credentials and download crypt_shared
Expand All @@ -517,8 +546,8 @@ source .evergreen/setup-fle.sh
```

> [!NOTE]
> By default, `setup-fle.sh` installs crypt_shared. If you want to test with mongocryptd instead, set the RUN_WITH_MONGOCRYPTD environment variable before
> sourcing `setup-fle.sh`.
> By default, `setup-fle.sh` installs crypt_shared. If you want to test with mongocryptd instead, set the RUN_WITH_MONGOCRYPTD environment variable before
> sourcing `setup-fle.sh`.

3. Run the functional tests:
```bash
Expand Down Expand Up @@ -546,7 +575,7 @@ All of this is handled in the csfle/azurekms and csfle/gcpkms folders in drivers

#### Azure KMS

1. Provision an Azure server. You must set the `AZUREKMS_VMNAME_PREFIX` variable:
1. Provision an Azure server. You must set the `AZUREKMS_VMNAME_PREFIX` variable:

```bash
export AZUREKMS_VMNAME_PREFIX: "NODE_DRIVER"
Expand Down