Skip to content

Commit ddde16e

Browse files
committed
update testing guide
1 parent 3e590c6 commit ddde16e

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ generate man pages and HTML for it.
115115

116116
### Testing
117117

118-
The tests require a MongoDB server with authentication. Start `mongod`:
118+
To run the entire test suite, including authentication tests,
119+
start `mongod` with auth enabled:
119120

120121
```
121122
$ mongod --auth
@@ -127,7 +128,14 @@ In another terminal, use the `mongo` shell to create a user:
127128
$ mongo --eval "db.createUser({user: 'admin', pwd: 'pass', roles: ['root']})" admin
128129
```
129130

130-
Set the user and password environment variables, and run the tests:
131+
To authenticate against MongoDB 3.0+ requires SCRAM-SHA-1, which in turn
132+
requires a driver built with OpenSSL:
133+
134+
```
135+
$ ./configure --enable-ssl`
136+
```
137+
138+
Set the user and password environment variables, then build and run the tests:
131139

132140
```
133141
$ export MONGOC_TEST_USER=admin
@@ -167,8 +175,7 @@ All tests should pass before submitting a patch.
167175
## Configuring the test runner
168176

169177
The test runner can be configured by declaring the `TEST_ARGS` environment
170-
variable.
171-
Currently the following options can be provided:
178+
variable. The following options can be provided:
172179

173180
```
174181
-h, --help Show this help menu.
@@ -197,4 +204,3 @@ $ make debug TEST_ARGS="-l /WriteConcern/bson_omits_defaults"
197204
```
198205

199206
This will build all dependencies and leave you in a debugger ready to run the test.
200-

0 commit comments

Comments
 (0)