PYTHON-1966 Test with custom default encoding on Python 2

Author: ShaneHarvey

.evergreen/config.yml

@@ -339,6 +339,9 @@ functions:
             export LIBMONGOCRYPT_URL="${libmongocrypt_url}"
             export TEST_ENCRYPTION=1
           fi
+          if [ -n "${SETDEFAULTENCODING}" ]; then
+            export SETDEFAULTENCODING="${SETDEFAULTENCODING}"
+          fi
 
           PYTHON_BINARY=${PYTHON_BINARY} \
             GREEN_FRAMEWORK=${GREEN_FRAMEWORK} \
@@ -1097,6 +1100,16 @@ axes:
         variables:
           test_encryption: true
 
+  # Run setdefaultencoding before running the test suite?
+  - id: setdefaultencoding
+    display_name: "setdefaultencoding"
+    values:
+      - id: "setdefaultencoding"
+        display_name: "setdefaultencoding"
+        tags: ["setdefaultencoding_tag"]
+        variables:
+          SETDEFAULTENCODING: "cp1251"
+
 buildvariants:
 - matrix_name: "tests-all"
   matrix_spec:
@@ -1529,6 +1542,16 @@ buildvariants:
   tasks:
      - ".latest"
 
+# setdefaultencoding tests on RHEL 6.2 (x86_64) with Python 2.7.
+- matrix_name: "test-setdefaultencoding"
+  matrix_spec:
+    platform: rhel62
+    setdefaultencoding: "*"
+    python-version: "2.7"
+  display_name: "setdefaultencoding ${python-version} ${platform}"
+  tasks:
+     - "test-latest-standalone"
+
 - matrix_name: "test-linux-enterprise-auth"
   matrix_spec:
     platform: rhel62

.evergreen/run-tests.sh

@@ -2,15 +2,16 @@
 set -o errexit  # Exit the script with error if any of the commands fail
 
 # Supported/used environment variables:
-#  SET_XTRACE_ON     Set to non-empty to write all commands first to stderr.
-#  AUTH              Set to enable authentication. Defaults to "noauth"
-#  SSL               Set to enable SSL. Defaults to "nossl"
-#  PYTHON_BINARY     The Python version to use. Defaults to whatever is available
-#  GREEN_FRAMEWORK   The green framework to test with, if any.
-#  C_EXTENSIONS      Pass --no_ext to setup.py, or not.
-#  COVERAGE          If non-empty, run the test suite with coverage.
-#  TEST_ENCRYPTION   If non-empty, install pymongocrypt.
-#  LIBMONGOCRYPT_URL The URL to download libmongocrypt.
+#  SET_XTRACE_ON      Set to non-empty to write all commands first to stderr.
+#  AUTH               Set to enable authentication. Defaults to "noauth"
+#  SSL                Set to enable SSL. Defaults to "nossl"
+#  PYTHON_BINARY      The Python version to use. Defaults to whatever is available
+#  GREEN_FRAMEWORK    The green framework to test with, if any.
+#  C_EXTENSIONS       Pass --no_ext to setup.py, or not.
+#  COVERAGE           If non-empty, run the test suite with coverage.
+#  TEST_ENCRYPTION    If non-empty, install pymongocrypt.
+#  LIBMONGOCRYPT_URL  The URL to download libmongocrypt.
+#  SETDEFAULTENCODING The encoding to set via sys.setdefaultencoding.
 
 if [ -n "${SET_XTRACE_ON}" ]; then
     set -o xtrace
@@ -28,6 +29,7 @@ COVERAGE=${COVERAGE:-}
 COMPRESSORS=${COMPRESSORS:-}
 TEST_ENCRYPTION=${TEST_ENCRYPTION:-}
 LIBMONGOCRYPT_URL=${LIBMONGOCRYPT_URL:-}
+SETDEFAULTENCODING=${SETDEFAULTENCODING:-}
 
 if [ -n "$COMPRESSORS" ]; then
     export COMPRESSORS=$COMPRESSORS
@@ -72,6 +74,17 @@ elif [ "$COMPRESSORS" = "zstd" ]; then
     trap "deactivate; rm -rf zstdtest" EXIT HUP
     pip install zstandard
     PYTHON=python
+elif [ -n "$SETDEFAULTENCODING" ]; then
+    $PYTHON_BINARY -m virtualenv --system-site-packages --never-download encodingtest
+    . encodingtest/bin/activate
+    trap "deactivate; rm -rf encodingtest" EXIT HUP
+    mkdir test-sitecustomize
+    cat <<EOT > test-sitecustomize/sitecustomize.py
+import sys
+sys.setdefaultencoding("$SETDEFAULTENCODING")
+EOT
+    export PYTHONPATH="$(pwd)/test-sitecustomize"
+    PYTHON=python
 else
     PYTHON="$PYTHON_BINARY"
 fi

test/test_client_context.py

@@ -38,6 +38,13 @@ def test_enableTestCommands_is_disabled(self):
                          'enableTestCommands must be disabled when '
                          'PYMONGO_DISABLE_TEST_COMMANDS is set.')
 
+    def test_setdefaultencoding_worked(self):
+        if 'SETDEFAULTENCODING' not in os.environ:
+            raise SkipTest('SETDEFAULTENCODING is not set')
+
+        self.assertEqual(
+            sys.getdefaultencoding(), os.environ['SETDEFAULTENCODING'])
+
 
 if __name__ == "__main__":
     unittest.main()