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: driver-core/src/test/resources/client-side-encryption/README.rst
+29-24Lines changed: 29 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -152,14 +152,14 @@ Use as integration tests
152
152
153
153
Do the following before running spec tests:
154
154
155
-
- If available for the platform under test, obtain a csfle_ binary and place it
156
-
in a location accessible to the tests. Refer to: `Using csfle`_
155
+
- If available for the platform under test, obtain a crypt_shared_ binary and place it
156
+
in a location accessible to the tests. Refer to: `Using crypt_shared`_
157
157
- Start the mongocryptd process.
158
158
- Start a mongod process with **server version 4.1.9 or later**.
159
159
- Place credentials to an AWS IAM user (access key ID + secret access key) somewhere in the environment outside of tracked code. (If testing on evergreen, project variables are a good place).
160
160
- Start a KMIP test server on port 5698 by running `drivers-evergreen-tools/.evergreen/csfle/kms_kmip_server.py <https://github.com/mongodb-labs/drivers-evergreen-tools/blob/master/.evergreen/csfle/kms_kmip_server.py>`_.
If ``encrypted_fields`` is defined in the test, the required collections and index described in `FLE 2 CreateCollection() and Collection.Drop() <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#fle-2-createcollection-and-collection-drop>`_ must be created:
185
+
If ``encrypted_fields`` is defined in the test, the required collections and index described in `FLE 2 Create and Drop Collection Helpers <https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#fle-2-create-and-drop-collection-helpers>`_ must be created:
186
+
186
187
- Use the ``dropCollection`` helper with ``encrypted_fields`` as an option and writeConcern "majority".
187
188
- Use the ``createCollection`` helper with ``encrypted_fields`` as an option.
188
189
@@ -323,32 +324,35 @@ Then for each element in ``tests``:
323
324
The spec test MUST be run with *and* without auth.
324
325
325
326
326
-
Using ``csfle``
327
-
===============
327
+
Using ``crypt_shared``
328
+
======================
328
329
329
-
On platforms where csfle_ is available, drivers should prefer to test with the
330
-
csfle library instead of spawning mongocryptd, although having some tests
331
-
dedicated to mongocryptd is recommended. Note that some tests assert on
332
-
mongocryptd-related behaviors (e.g. the ``mongocryptdBypassSpawn`` test).
330
+
On platforms where crypt_shared_ is available, drivers should prefer to test
331
+
with the ``crypt_shared`` library instead of spawning mongocryptd, although
332
+
having some tests dedicated to mongocryptd is recommended. Note that some tests
333
+
assert on mongocryptd-related behaviors (e.g. the ``mongocryptdBypassSpawn``
334
+
test).
333
335
334
-
Drivers under test should load the csfle_ library using either the ``csflePath``
335
-
public API option (as part of the AutoEncryption ``extraOptions``), or by
336
-
setting a special search path instead.
336
+
Drivers under test should load the crypt_shared_ library using either the
337
+
``cryptSharedLibPath`` public API option (as part of the AutoEncryption
338
+
``extraOptions``), or by setting a special search path instead.
337
339
338
-
Some tests will require *not* using csfle_. For such tests, one should ensure
339
-
that csfle will not be loaded. Refer to the client-side-encryption documentation
340
-
for information on "disabling" csfle and setting csfle search paths.
340
+
Some tests will require *not* using crypt_shared_. For such tests, one should
341
+
ensure that ``crypt_shared`` will not be loaded. Refer to the
342
+
client-side-encryption documentation for information on "disabling"
343
+
``crypt_shared`` and setting library search paths.
341
344
342
345
.. note::
343
346
344
-
The ``csfle`` dynamic library can be obtained using the mongodl_ Python
347
+
The crypt_shared_ dynamic library can be obtained using the mongodl_ Python
0 commit comments