Skip to content

Commit 7588da2

Browse files
authored
Restructure docs for environment variables (#1354)
1 parent dfa4c20 commit 7588da2

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,24 +100,31 @@ be less restrictive.
100100

101101
The test suite references the following environment variables:
102102

103-
* `MONGODB_URI`: Connection string. Defaults to `mongodb://127.0.0.1/`, which
104-
assumes a MongoDB server is listening localhost port 27017.
105-
* `MONGO_ORCHESTRATION_URI`: API endpoint for Mongo Orchestration. Defaults to
106-
`http://localhost:8889/v1`. This is only used by a few tests that start
103+
* `MONGODB_DATABASE`: Default database to use in tests. Defaults to `phongo`.
104+
* `MONGO_ORCHESTRATION_URI`: API endpoint for
105+
[Mongo Orchestration](https://github.com/10gen/mongo-orchestration). Defaults
106+
to `http://localhost:8889/v1`. This is only used by a few tests that start
107107
temporary servers, and those tests will be skipped if Mongo Orchestration is
108108
inaccessible.
109-
* `MONGODB_DATABASE`: Default database to use in tests. Defaults to `phongo`.
109+
* `MONGODB_URI`: Connection string. Defaults to `mongodb://127.0.0.1/`, which
110+
assumes a MongoDB server is listening on localhost port 27017.
110111
* `SSL_DIR`: Path to directory containing certificate files. On Evergreen, this
111112
will be set to the
112113
[.evergreen/x509gen](https://github.com/mongodb-labs/drivers-evergreen-tools/tree/master/.evergreen/x509gen)
113114
directory within
114115
[drivers-evergreen-tools](https://github.com/mongodb-labs/drivers-evergreen-tools).
115116
If undefined or inaccessible, tests requiring certificates will be skipped.
117+
118+
The following environment variable is used for [stable API testing](https://github.com/mongodb/specifications/blob/master/source/versioned-api/tests/README.rst):
119+
116120
* `API_VERSION`: If defined, this value will be used to construct a
117121
[`MongoDB\Driver\ServerApi`](https://www.php.net/manual/en/mongodb-driver-serverapi.construct.php),
118122
which will then be specified as the `serverApi` driver option for
119123
[`MongoDB\Driver\Manager`](https://www.php.net/manual/en/class.mongodb-driver-manager.php)
120124
objects created by the test suite.
125+
126+
The following environment variables are used for [CSFLE testing](https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/tests/README.rst):
127+
121128
* `CRYPT_SHARED_LIB_PATH`: If defined, this value will be used to set the
122129
`cryptSharedLibPath` autoEncryption driver option for
123130
[`MongoDB\Driver\Manager`](https://www.php.net/manual/en/class.mongodb-driver-manager.php)

0 commit comments

Comments
 (0)