PYTHON-5149 Convert run-tests.sh to a Python script

Author: blink1073

.evergreen/run-tests.sh

@@ -1,16 +1,12 @@
 #!/bin/bash
-set -eux
+set -eu
 
 SCRIPT_DIR=$(dirname ${BASH_SOURCE:-$0})
 SCRIPT_DIR="$( cd -- "$SCRIPT_DIR" > /dev/null 2>&1 && pwd )"
 ROOT_DIR="$(dirname $SCRIPT_DIR)"
 
 pushd $ROOT_DIR
 
-export PIP_QUIET=1  # Quiet by default
-export PIP_PREFER_BINARY=1 # Prefer binary dists by default
-export UV_FROZEN=1  # Do not modify lock files
-
 # Try to source the env file.
 if [ -f $SCRIPT_DIR/scripts/env.sh ]; then
   echo "Sourcing env inputs"
@@ -27,72 +23,12 @@ else
   echo "Missing test inputs, please run 'just setup-test'"
 fi
 
-
 # Source the local secrets export file if available.
 if [ -f "./secrets-export.sh" ]; then
   . "./secrets-export.sh"
 fi
 
-PYTHON_IMPL=$(uv run python -c "import platform; print(platform.python_implementation())")
-
-# Ensure C extensions if applicable.
-if [ -z "${NO_EXT:-}" ] && [ "$PYTHON_IMPL" = "CPython" ]; then
-    uv run --frozen tools/fail_if_no_c.py
-fi
-
-if [ -n "${PYMONGOCRYPT_LIB:-}" ]; then
-    # Ensure pymongocrypt is working properly.
-    # shellcheck disable=SC2048
-    uv run ${UV_ARGS} python -c "import pymongocrypt; print('pymongocrypt version: '+pymongocrypt.__version__)"
-    # shellcheck disable=SC2048
-    uv run ${UV_ARGS} python -c "import pymongocrypt; print('libmongocrypt version: '+pymongocrypt.libmongocrypt_version())"
-    # PATH is updated by configure-env.sh for access to mongocryptd.
-fi
-
-PYTHON_IMPL=$(uv run python -c "import platform; print(platform.python_implementation())")
-echo "Running ${AUTH:-noauth} tests over ${SSL:-nossl} with python $(uv python find)"
-uv run python -c 'import sys; print(sys.version)'
-
-# Show the installed packages
-# shellcheck disable=SC2048
-PIP_QUIET=0 uv run ${UV_ARGS} --with pip pip list
-
-# Record the start time for a perf test.
-if [ -n "${TEST_PERF:-}" ]; then
-    start_time=$(date +%s)
-fi
-
-# Run the tests, and store the results in Evergreen compatible XUnit XML
-# files in the xunit-results/ directory.
-TEST_ARGS=${TEST_ARGS}
-if [ "$#" -ne 0 ]; then
-    TEST_ARGS="$*"
-fi
-echo "Running tests with $TEST_ARGS and uv args $UV_ARGS..."
-if [ -z "${GREEN_FRAMEWORK:-}" ]; then
-    # shellcheck disable=SC2048
-    uv run ${UV_ARGS} pytest $TEST_ARGS
-else
-    # shellcheck disable=SC2048
-    uv run ${UV_ARGS} green_framework_test.py $GREEN_FRAMEWORK -v $TEST_ARGS
-fi
-echo "Running tests with $TEST_ARGS... done."
-
-# Handle perf test post actions.
-if [ -n "${TEST_PERF:-}" ]; then
-    end_time=$(date +%s)
-    elapsed_secs=$((end_time-start_time))
-
-    cat results.json
-
-    echo "{\"failures\": 0, \"results\": [{\"status\": \"pass\", \"exit_code\": 0, \"test_file\": \"BenchMarkTests\", \"start\": $start_time, \"end\": $end_time, \"elapsed\": $elapsed_secs}]}" > report.json
-
-    cat report.json
-fi
-
-# Handle coverage post actions.
-if [ -n "${COVERAGE:-}" ]; then
-    rm -rf .pytest_cache
-fi
+# Start the test runner.
+uv run ${UV_ARGS} $SCRIPT_DIR/scripts/run_tests.py
 
 popd

.evergreen/scripts/run_tests.py

@@ -0,0 +1,113 @@
+from __future__ import annotations
+
+import json
+import logging
+import os
+import platform
+import shlex
+import shutil
+import subprocess
+import sys
+from datetime import datetime
+from pathlib import Path
+
+import pytest
+
+HERE = Path(__file__).absolute().parent
+ROOT = HERE.parent.parent
+DRIVERS_TOOLS = os.environ.get("DRIVERS_TOOLS", "").replace(os.sep, "/")
+PLATFORM = "windows" if os.name == "nt" else sys.platform.lower()
+AUTH = os.environ.get("AUTH", "noauth")
+SSL = os.environ.get("SSL", "nossl")
+UV_ARGS = os.environ.get("UV_ARGS", "")
+TEST_PERF = os.environ.get("TEST_PERF")
+GREEN_FRAMEWORK = os.environ.get("GREEN_FRAMEWORK")
+TEST_ARGS = os.environ.get("TEST_ARGS", "").split()
+
+LOGGER = logging.getLogger(__name__)
+logging.basicConfig(level=logging.INFO, format="%(levelname)-8s %(message)s")
+
+# Ensure C extensions if applicable.
+if not os.environ.get("NO_EXT") and platform.python_implementation() == "CPython":
+    import bson
+    import pymongo
+
+    if not pymongo.has_c() or not bson.has_c():
+        try:
+            from pymongo import _cmessage  # type:ignore[attr-defined] # noqa: F401
+        except Exception as e:
+            LOGGER.exception(e)
+        try:
+            from bson import _cbson  # type:ignore[attr-defined] # noqa: F401
+        except Exception as e:
+            LOGGER.exception(e)
+        sys.exit("could not load C extensions")
+
+if os.environ.get("PYMONGOCRYPT_LIB"):
+    # Ensure pymongocrypt is working properly.
+    import pymongocrypt
+
+    LOGGER.info(f"pymongocrypt version: {pymongocrypt.__version__})")
+    LOGGER.info(f"libmongocrypt version: {pymongocrypt.libmongocrypt_version()})")
+
+LOGGER.info(f"Running {AUTH} tests over {SSL} with python {sys.executable}")
+
+# Show the installed packages.  Pip can only be run as a cli.
+env = os.environ.copy()
+env["PIP_QUIET"] = "0"
+subprocess.run(shlex.split(f"uv run {UV_ARGS} --with pip pip list"), env=env, check=True)  # noqa: S603
+
+# Record the start time for a perf test.
+if TEST_PERF:
+    start_time = datetime.now()
+
+# Handle green frameworks.
+if GREEN_FRAMEWORK:
+    if GREEN_FRAMEWORK == "eventlet":
+        import eventlet
+
+        # https://github.com/eventlet/eventlet/issues/401
+        eventlet.sleep()
+        eventlet.monkey_patch()
+    elif GREEN_FRAMEWORK == "gevent":
+        from gevent import monkey
+
+        monkey.patch_all()
+
+    # Never run async tests with a framework.
+    if len(TEST_ARGS) <= 1:
+        TEST_ARGS.extend(["-m", "not default_async and default"])
+    else:
+        for i in range(len(TEST_ARGS) - 1):
+            if "-m" in TEST_ARGS[i]:
+                TEST_ARGS[i + 1] = f"not default_async and {TEST_ARGS[i + 1]}"
+
+
+# Run the tests.
+pytest.main(TEST_ARGS)
+
+# Handle perf test post actions.
+if TEST_PERF:
+    end_time = datetime.now()
+    elapsed_secs = (end_time - start_time).total_seconds()
+    with open("results.json") as fid:
+        print(json.dump(fid, indent=2))  # noqa: T201
+
+    results = dict(
+        status="pass",
+        exit_code=0,
+        test_file="BenchMarkTests",
+        start=start_time.timestamp(),
+        end=end_time.timestamp(),
+        elapsed=elapsed_secs,
+    )
+    report = dict(failures=0, results=results)
+    print(json.dumps(report, indent=2))  # noqa: T201
+
+    with open("report.json", "w", newline="\n") as fid:
+        json.dump(report, fid)
+
+
+# Handle coverage post actions.
+if os.environ.get("COVERAGE"):
+    shutil.rmtree(".pytest_cache", ignore_errors=True)

.evergreen/scripts/setup_tests.py

@@ -228,6 +228,9 @@ def handle_test_env() -> None:
 
     write_env("AUTH", AUTH)
     write_env("SSL", SSL)
+    write_env("PIP_QUIET")  # Quiet by default
+    write_env("PIP_PREFER_BINARY")  # Prefer binary dists by default
+    write_env("UV_FROZEN")  # Do not modify lock files
 
     # Skip CSOT tests on non-linux platforms.
     if PLATFORM != "linux":

green_framework_test.py

@@ -234,7 +234,6 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?)|dummy.*)$"
     "RET", "ARG", "F405", "B028", "PGH001", "B018", "F403", "RUF015", "E731", "B007",
     "UP031", "F401", "B023", "F811"]
 "tools/*.py" = ["T201"]
-"green_framework_test.py" = ["T201"]
 "hatch_build.py" = ["S"]
 "_setup.py" = ["SIM112"]