Skip to content

Commit 3be83fb

Browse files
document
1 parent c3ba4e9 commit 3be83fb

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

test/readme.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -679,10 +679,37 @@ needs to be tested.
679679
3. For additional Node.js options (like HTTP debug), add them to `K8S_TEST_CMD` in `.evergreen/run-oidc-tests-k8s.sh`
680680
4. Create an evergreen patch and schedule only the `oidc-auth-test-k8s-latest-aks` variant.
681681

682+
### Running tests with TLS
683+
684+
We tests TLS in two suites in CI:
685+
686+
- For each node version and platform, we run a small test suite that confirms TLS works.
687+
- We run the full test suite on Linux, on latest Nodejs and on all topologies, to confirm that our full test suite works with TLS enabled.
688+
689+
Setting up a local environment is the same for both suites.
690+
691+
First, configure a server with TLS enabled by following the steps in [Runing the Tests Locally](#Running-the-Tests-Locally) with the environment
692+
variable `SSL=SSL` set.
693+
694+
Then, in addition to setting the `MONGODB_URI` environment varialbe, set the following environment variables:
695+
696+
```bash
697+
export SSL='ssl' # enable TLS
698+
699+
# TLS certificates
700+
export TLS_KEY_FILE="$DRIVERS_TOOLS/.evergreen/x509gen/client.pem"
701+
export TLS_CA_FILE="$DRIVERS_TOOLS/.evergreen/x509gen/ca.pem"
702+
export TLS_CRL_FILE="$DRIVERS_TOOLS/.evergreen/x509gen/crl.pem"
703+
```
704+
705+
Then run the TLS tests:
706+
707+
- If running the integration test suite, run `npm run check:test`
708+
- If running the manual TLS tests, run `npm run check:tls`
709+
682710

683711
### TODO Special Env Sections
684712

685-
- TLS
686713
- LDAP
687714
- Snappy (maybe in general, how to test optional dependencies)
688715
- Atlas connectivity

0 commit comments

Comments
 (0)