PHPC-2135: Test with consistent version of crypt_shared (#1353)

Use the crypt_shared library provisioned by download-mongodb.sh and add an additional task to disable the library and fall back to mongocryptd.

This also revises how we pass environment variables into run-tests.sh and the test suite. Everything is now explicitly passed instead of relying on export attributes from a parent context.

Author: jmikola

.evergreen/config.yml

@@ -362,7 +362,7 @@ functions:
         script: |
           ${PREPARE_SHELL}
           MONGODB_VERSION=${VERSION} TOPOLOGY=${TOPOLOGY} AUTH=${AUTH} SSL=${SSL} STORAGE_ENGINE=${STORAGE_ENGINE} LOAD_BALANCER=${LOAD_BALANCER} REQUIRE_API_VERSION=${REQUIRE_API_VERSION} ORCHESTRATION_FILE=${ORCHESTRATION_FILE} sh ${DRIVERS_TOOLS}/.evergreen/run-orchestration.sh
-    # run-orchestration generates expansion file with the MONGODB_URI for the cluster
+    # run-orchestration generates expansion file with MONGODB_URI and CRYPT_SHARED_LIB_PATH
     - command: expansions.update
       params:
         file: mo-expansion.yml
@@ -388,8 +388,14 @@ functions:
         working_dir: "src"
         script: |
           ${PREPARE_SHELL}
-          export CRYPT_SHARED_LIB_PATH="${client_side_encryption_crypt_shared_lib_path}"
-          API_VERSION=${API_VERSION} TESTS=${TESTS} SSL=${SSL} MONGODB_URI="${MONGODB_URI}${APPEND_URI}" sh ${PROJECT_DIRECTORY}/.evergreen/run-tests.sh
+          API_VERSION=${API_VERSION} \
+          CRYPT_SHARED_LIB_PATH=${CRYPT_SHARED_LIB_PATH} \
+          MONGODB_URI="${MONGODB_URI}${APPEND_URI}" \
+          SKIP_CRYPT_SHARED=${SKIP_CRYPT_SHARED} \
+          SSL=${SSL} \
+          SSL_DIR=${SSL_DIR} \
+          TESTS=${TESTS} \
+          sh ${PROJECT_DIRECTORY}/.evergreen/run-tests.sh
 
   "cleanup":
     - command: shell.exec
@@ -467,18 +473,6 @@ functions:
             ${DRIVERS_TOOLS}/.evergreen/run-load-balancer.sh stop
           fi
 
-  "fetch crypt_shared":
-    - command: shell.exec
-      params:
-        script: |
-          # TODO: Specify same version provisioned by download-mongodb.sh (see: DRIVERS-2355)
-          python3 ${DRIVERS_TOOLS}/.evergreen/mongodl.py --component crypt_shared --version latest --only "**/mongo_crypt_v1.so" --out ${DRIVERS_TOOLS}/.evergreen/csfle --strip-path-components 1
-    - command: expansions.update
-      params:
-        updates:
-          - key: client_side_encryption_crypt_shared_lib_path
-            value: ${DRIVERS_TOOLS}/.evergreen/csfle/mongo_crypt_v1.so
-
 pre:
   - func: "fetch source"
   - func: "prepare resources"
@@ -598,14 +592,15 @@ tasks:
           vars:
             TESTS: "tests/atlas.phpt"
 
-    - name: "test-crypt_shared"
+    - name: "test-skip_crypt_shared"
       commands:
         - func: "compile driver"
         - func: "bootstrap mongo-orchestration"
           vars:
             TOPOLOGY: "replica_set"
-        - func: "fetch crypt_shared"
         - func: "run tests"
+          vars:
+            SKIP_CRYPT_SHARED: "yes"
 
     - name: "test-loadBalanced"
       tags: ["loadbalanced"]
@@ -1256,9 +1251,9 @@ buildvariants:
   tasks:
     - name: "test-loadBalanced"
 
-# CSFLE crypt_shared is available from MongoDB 6.0+
-- matrix_name: "test-csfle-crypt_shared"
+# CSFLE crypt_shared is available from MongoDB 6.0+, so explicitly test without it to allow use of mongocryptd
+- matrix_name: "test-csfle-skip_crypt_shared"
   matrix_spec: { "os": "debian11", "mongodb-versions": "6.0", "php-edge-versions": "latest-stable" }
-  display_name: "CSFLE crypt_shared - ${mongodb-versions}"
+  display_name: "CSFLE skip_crypt_shared - ${mongodb-versions}"
   tasks:
-    - name: "test-crypt_shared"
+    - name: "test-skip_crypt_shared"

.evergreen/run-tests.sh

@@ -1,16 +1,14 @@
 #!/bin/sh
 set -o errexit  # Exit the script with error if any of the commands fail
 
-# Supported/used environment variables:
-#   SSL             Set to "yes" to enable SSL. Defaults to "nossl"
-#   MONGODB_URI     Set the suggested connection MONGODB_URI (including credentials and topology info)
-#   TESTS           Optional TESTS environment variable for run-tests.php
-#   API_VERSION     Optional API_VERSION environment variable for run-tests.php
-
-SSL=${SSL:-nossl}
-MONGODB_URI=${MONGODB_URI:-}
-TESTS=${TESTS:-}
-API_VERSION=${API_VERSION:-}
+# Supported environment variables
+API_VERSION=${API_VERSION:-} # Optional API_VERSION environment variable for run-tests.php
+CRYPT_SHARED_LIB_PATH="${CRYPT_SHARED_LIB_PATH:-}" # Optional path to crypt_shared library
+MONGODB_URI=${MONGODB_URI:-} # Connection string (including credentials and topology info)
+SKIP_CRYPT_SHARED="${SKIP_CRYPT_SHARED:-no}" # Specify "yes" to ignore CRYPT_SHARED_LIB_PATH. Defaults to "no"
+SSL=${SSL:-no} # Specify "yes" to enable SSL. Defaults to "no"
+SSL_DIR=${SSL_DIR-} # Optional SSL_DIR environment variable for run-tests.php
+TESTS=${TESTS:-} # Optional TESTS environment variable for run-tests.php
 
 OS=$(uname -s | tr '[:upper:]' '[:lower:]')
 [ -z "$MARCH" ] && MARCH=$(uname -m | tr '[:upper:]' '[:lower:]')
@@ -28,12 +26,23 @@ if [ "$SSL" = "yes" ]; then
    fi
 fi
 
+if [ "${SKIP_CRYPT_SHARED}" = "yes" ]; then
+   CRYPT_SHARED_LIB_PATH=""
+   echo "crypt_shared library is skipped"
+elif [ -z "${CRYPT_SHARED_LIB_PATH}" ]; then
+   echo "crypt_shared library path is empty"
+else
+   echo "crypt_shared library will be loaded from path: $CRYPT_SHARED_LIB_PATH"
+fi
+
 echo "Running tests with URI: $MONGODB_URI"
 
 # Run the tests, and store the results in a junit result file
-case "$OS" in
-   *)
-      API_VERSION="${API_VERSION}" TEST_PHP_JUNIT="${PROJECT_DIRECTORY}/test-results.xml" TEST_PHP_ARGS="-q -x --show-diff -g FAIL,XFAIL,BORK,WARN,LEAK,SKIP" make test TESTS=$TESTS
-      ;;
-esac
-
+API_VERSION="${API_VERSION}" \
+CRYPT_SHARED_LIB_PATH="${CRYPT_SHARED_LIB_PATH}" \
+MONGODB_URI="${MONGODB_URI}" \
+SSL_DIR="${SSL_DIR}" \
+TEST_PHP_JUNIT="${PROJECT_DIRECTORY}/test-results.xml" \
+TEST_PHP_ARGS="-q -x --show-diff -g FAIL,XFAIL,BORK,WARN,LEAK,SKIP" \
+TESTS="$TESTS" \
+make test