You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27-6Lines changed: 27 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -190,13 +190,15 @@ just docs-serve
190
190
Browse to the link provided, and then as you make changes to docstrings or narrative docs,
191
191
the pages will re-render and the browser will automatically refresh.
192
192
193
-
194
193
## Running Tests Locally
195
194
196
-
- Ensure you have started the appropriate Mongo Server(s).
197
195
- Run `just install` to set a local virtual environment, or you can manually
198
196
create a virtual environment and run `pytest` directly. If you want to use a specific
199
197
version of Python, remove the `.venv` folder and set `PYTHON_BINARY` before running `just install`.
198
+
- Ensure you have started the appropriate Mongo Server(s). You can run `just run-server` with optional args
199
+
to set up the server. All given options will be passed to
200
+
[`run-orchestration.sh`](https://github.com/mongodb-labs/drivers-evergreen-tools/blob/master/.evergreen/run-orchestration.sh). Run `$DRIVERS_TOOLS/evergreen/run-orchestration.sh -h`
201
+
for a full list of options.
200
202
- Run `just test` or `pytest` to run all of the tests.
201
203
- Append `test/<mod_name>.py::<class_name>::<test_name>` to run
202
204
specific tests. You can omit the `<test_name>` to test a full class
@@ -213,18 +215,36 @@ the pages will re-render and the browser will automatically refresh.
- Run `export DRIVERS_TOOLS=$PWD/drivers-evergreen-tools`. This can be put into a `.bashrc` file
215
217
for convenience.
216
-
-Set up access to [Drivers test secrets](https://github.com/mongodb-labs/drivers-evergreen-tools/tree/master/.evergreen/secrets_handling#secrets-handling).
218
+
-Some tests require access to [Drivers test secrets](https://github.com/mongodb-labs/drivers-evergreen-tools/tree/master/.evergreen/secrets_handling#secrets-handling).
217
219
218
220
### Usage
219
221
220
-
- Run `just run-server` with optional args to set up the server. All given options will be passed to
221
-
`run-orchestration.sh` in `$DRIVERS_TOOLS`. See `$DRIVERS_TOOLS/evergreen/run-orchestration.sh -h`
222
-
for a full list of options.
222
+
- Run `just run-server` with optional args to set up the server.
223
223
- Run `just setup-tests` with optional args to set up the test environment, secrets, etc.
224
224
See `just setup-tests -h` for a full list of available options.
225
225
- Run `just run-tests` to run the tests in an appropriate Python environment.
226
226
- When done, run `just teardown-tests` to clean up and `just stop-server` to stop the server.
227
227
228
+
### SSL tests
229
+
230
+
- Run `just run-server --ssl` to start the server with TLS enabled.
231
+
- Run `just setup-tests --ssl`.
232
+
- Run `just run-tests`.
233
+
234
+
Note: for general testing purposes with an TLS-enabled server, you can use the following (this should ONLY be used
0 commit comments