PYTHON-5330 Convert no c extensions and doctests to use the standard test pattern (#2294)

Author: blink1073

.evergreen/generated_configs/functions.yml

@@ -85,21 +85,6 @@ functions:
       params:
         directory: src
 
-  # Run just script
-  run just script:
-    - command: subprocess.exec
-      params:
-        binary: bash
-        args:
-          - .evergreen/just.sh
-          - ${JUSTFILE_TARGET}
-        working_dir: src
-        include_expansions_in_env:
-          - AWS_ACCESS_KEY_ID
-          - AWS_SECRET_ACCESS_KEY
-          - AWS_SESSION_TOKEN
-      type: test
-
   # Run server
   run server:
     - command: subprocess.exec

.evergreen/generated_configs/tasks.yml

@@ -734,15 +734,6 @@ tasks:
     depends_on: [{ name: .server-version, variant: .coverage_tag, status: "*", patch_optional: true }]
     tags: [coverage]
 
-  # Doctest tests
-  - name: test-doctests
-    commands:
-      - func: run server
-      - func: run just script
-        vars:
-          JUSTFILE_TARGET: docs-test
-    tags: [doctests]
-
   # Enterprise auth tests
   - name: test-enterprise-auth-python3.9
     commands:

.evergreen/generated_configs/variants.yml

@@ -213,14 +213,14 @@ buildvariants:
       PYTHON_BINARY: /opt/python/3.9/bin/python3
 
   # Doctests tests
-  - name: doctests-rhel8-python3.9
+  - name: doctests-rhel8
     tasks:
-      - name: .doctests
-    display_name: Doctests RHEL8 Python3.9
+      - name: .standard-linux .standalone-noauth-nossl
+    display_name: Doctests RHEL8
     run_on:
       - rhel87-small
     expansions:
-      PYTHON_BINARY: /opt/python/3.9/bin/python3
+      TEST_NAME: doctest
 
   # Encryption tests
   - name: encryption-rhel8-python3.9
@@ -609,51 +609,12 @@ buildvariants:
       PYTHON_BINARY: /opt/python/3.13/bin/python3
 
   # No c ext tests
-  - name: no-c-ext-rhel8-python3.9
-    tasks:
-      - name: .standalone .noauth .nossl !.sync_async
-    display_name: No C Ext RHEL8 Python3.9
-    run_on:
-      - rhel87-small
-    expansions:
-      NO_EXT: "1"
-      PYTHON_BINARY: /opt/python/3.9/bin/python3
-  - name: no-c-ext-rhel8-python3.10
+  - name: no-c-ext-rhel8
     tasks:
-      - name: .replica_set .noauth .nossl !.sync_async
-    display_name: No C Ext RHEL8 Python3.10
-    run_on:
-      - rhel87-small
-    expansions:
-      NO_EXT: "1"
-      PYTHON_BINARY: /opt/python/3.10/bin/python3
-  - name: no-c-ext-rhel8-python3.11
-    tasks:
-      - name: .sharded_cluster .noauth .nossl !.sync_async
-    display_name: No C Ext RHEL8 Python3.11
-    run_on:
-      - rhel87-small
-    expansions:
-      NO_EXT: "1"
-      PYTHON_BINARY: /opt/python/3.11/bin/python3
-  - name: no-c-ext-rhel8-python3.12
-    tasks:
-      - name: .standalone .noauth .nossl !.sync_async
-    display_name: No C Ext RHEL8 Python3.12
-    run_on:
-      - rhel87-small
-    expansions:
-      NO_EXT: "1"
-      PYTHON_BINARY: /opt/python/3.12/bin/python3
-  - name: no-c-ext-rhel8-python3.13
-    tasks:
-      - name: .replica_set .noauth .nossl !.sync_async
-    display_name: No C Ext RHEL8 Python3.13
+      - name: .standard-linux
+    display_name: No C Ext RHEL8
     run_on:
       - rhel87-small
-    expansions:
-      NO_EXT: "1"
-      PYTHON_BINARY: /opt/python/3.13/bin/python3
 
   # No server tests
   - name: no-server

.evergreen/scripts/generate_config.py

@@ -357,18 +357,12 @@ def create_green_framework_variants():
 
 
 def create_no_c_ext_variants():
-    variants = []
     host = DEFAULT_HOST
-    for python, topology in zip_cycle(CPYTHONS, TOPOLOGIES):
-        tasks = [f".{topology} .noauth .nossl !.sync_async"]
-        expansions = dict()
-        handle_c_ext(C_EXTS[0], expansions)
-        display_name = get_variant_name("No C Ext", host, python=python)
-        variant = create_variant(
-            tasks, display_name, host=host, python=python, expansions=expansions
-        )
-        variants.append(variant)
-    return variants
+    tasks = [".standard-linux"]
+    expansions = dict()
+    handle_c_ext(C_EXTS[0], expansions)
+    display_name = get_variant_name("No C Ext", host)
+    return [create_variant(tasks, display_name, host=host)]
 
 
 def create_atlas_data_lake_variants():
@@ -469,13 +463,13 @@ def create_mockupdb_variants():
 
 def create_doctests_variants():
     host = DEFAULT_HOST
-    python = CPYTHONS[0]
+    expansions = dict(TEST_NAME="doctest")
     return [
         create_variant(
-            [".doctests"],
-            get_variant_name("Doctests", host, python=python),
-            python=python,
+            [".standard-linux .standalone-noauth-nossl"],
+            get_variant_name("Doctests", host),
             host=host,
+            expansions=expansions,
         )
     ]
 
@@ -1013,14 +1007,6 @@ def create_mockupdb_tasks():
     return [EvgTask(name=task_name, tags=tags, commands=[test_func])]
 
 
-def create_doctest_tasks():
-    server_func = FunctionCall(func="run server")
-    test_func = FunctionCall(func="run just script", vars=dict(JUSTFILE_TARGET="docs-test"))
-    task_name = "test-doctests"
-    tags = ["doctests"]
-    return [EvgTask(name=task_name, tags=tags, commands=[server_func, test_func])]
-
-
 def create_no_server_tasks():
     test_func = FunctionCall(func="run tests")
     task_name = "test-no-server"
@@ -1164,13 +1150,6 @@ def create_run_server_func():
     return "run server", [sub_cmd, expansion_cmd]
 
 
-def create_run_just_script_func():
-    includes = ["AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY", "AWS_SESSION_TOKEN"]
-    args = [".evergreen/just.sh", "${JUSTFILE_TARGET}"]
-    cmd = get_subprocess_exec(include_expansions_in_env=includes, args=args)
-    return "run just script", [cmd]
-
-
 def create_run_tests_func():
     includes = [
         "AUTH",

.evergreen/scripts/run_tests.py

@@ -152,6 +152,13 @@ def run() -> None:
         test_kms_send_to_remote(SUB_TEST_NAME)
         return
 
+    # Handle doctests.
+    if TEST_NAME == "doctest":
+        from sphinx.cmd.build import main
+
+        result = main("-E -b doctest doc ./doc/_build/doctest".split())
+        sys.exit(result)
+
     # Send ecs tests to run remotely.
     if TEST_NAME == "auth_aws" and SUB_TEST_NAME == "ecs":
         run_command(f"{DRIVERS_TOOLS}/.evergreen/auth_aws/aws_setup.sh ecs")

.evergreen/scripts/setup_tests.py

@@ -285,6 +285,9 @@ def handle_test_env() -> None:
         write_env("GSSAPI_PORT", config["SASL_PORT"])
         write_env("GSSAPI_PRINCIPAL", config["PRINCIPAL"])
 
+    if test_name == "doctest":
+        UV_ARGS.append("--extra docs")
+
     if test_name == "load_balancer":
         SINGLE_MONGOS_LB_URI = os.environ.get(
             "SINGLE_MONGOS_LB_URI", "mongodb://127.0.0.1:8000/?loadBalanced=true"

.evergreen/scripts/utils.py

@@ -52,10 +52,18 @@ class Distro:
 # Tests that require a sub test suite.
 SUB_TEST_REQUIRED = ["auth_aws", "auth_oidc", "kms", "mod_wsgi", "perf"]
 
-EXTRA_TESTS = ["mod_wsgi", "aws_lambda"]
+EXTRA_TESTS = ["mod_wsgi", "aws_lambda", "doctest"]
 
 # Tests that do not use run-orchestration directly.
-NO_RUN_ORCHESTRATION = ["auth_oidc", "atlas_connect", "data_lake", "mockupdb", "serverless", "ocsp"]
+NO_RUN_ORCHESTRATION = [
+    "auth_oidc",
+    "atlas_connect",
+    "aws_lambda",
+    "data_lake",
+    "mockupdb",
+    "serverless",
+    "ocsp",
+]
 
 
 def get_test_options(
@@ -78,7 +86,7 @@ def get_test_options(
     else:
         parser.add_argument(
             "test_name",
-            choices=set(TEST_SUITE_MAP) - set(NO_RUN_ORCHESTRATION),
+            choices=set(list(TEST_SUITE_MAP) + EXTRA_TESTS) - set(NO_RUN_ORCHESTRATION),
             nargs="?",
             default="default",
             help="The optional name of the test suite to be run, which informs the server configuration.",

.github/workflows/test-python.yml

@@ -99,7 +99,9 @@ jobs:
       - name: Install dependencies
         run: just install
       - name: Run tests
-        run:  just docs-test
+        run:  |
+          just setup-tests doctest
+          just run-tests
 
   docs:
     name: Docs Checks

CONTRIBUTING.md

@@ -294,7 +294,8 @@ Note: these tests can only be run from an Evergreen host.
 The doc tests require a running server.
 
 - Run `just run-server`.
-- Run `just docs-test`.
+- Run `just setup-tests doctest`.
+- Run `just run-tests`.
 
 ### Free-threaded Python Tests
 

doc/conf.py

@@ -105,6 +105,7 @@
 client = MongoClient()
 client.drop_database("doctest_test")
 db = client.doctest_test
+server_major_version = int(client.server_info()['version'].split()[-1][0])
 """
 
 # -- Options for HTML output ---------------------------------------------------

doc/examples/client_bulk.rst

@@ -46,6 +46,7 @@ summary of the types of operations performed in the bulk write, along with their
 
 .. doctest::
   :options: +NORMALIZE_WHITESPACE
+  :skipif: server_major_version < 8
 
   >>> from pymongo import InsertOne, DeleteOne, UpdateOne
   >>> models = [
@@ -79,6 +80,7 @@ instance will also include detailed results about each successful operation perf
 
 .. doctest::
   :options: +NORMALIZE_WHITESPACE
+  :skipif: server_major_version < 8
 
   >>> from pymongo import InsertOne, DeleteMany, ReplaceOne, UpdateMany
   >>> models = [
@@ -125,6 +127,7 @@ For example, a duplicate key error on the third operation below aborts the remai
 
 .. doctest::
   :options: +NORMALIZE_WHITESPACE
+  :skipif: server_major_version < 8
 
   >>> from pymongo import InsertOne, DeleteOne
   >>> from pymongo.errors import ClientBulkWriteException
@@ -161,6 +164,7 @@ For example, the fourth and fifth write operations below get executed successful
 
 .. doctest::
   :options: +NORMALIZE_WHITESPACE
+  :skipif: server_major_version < 8
 
   >>> from pymongo import InsertOne, DeleteOne
   >>> from pymongo.errors import ClientBulkWriteException

justfile

@@ -28,10 +28,6 @@ docs-serve:
 docs-linkcheck:
     {{docs_run}} sphinx-build -E -b linkcheck doc {{doc_build}}/linkcheck
 
-[group('docs')]
-docs-test:
-    {{docs_run}} --extra test sphinx-build -E -b doctest doc {{doc_build}}/doctest
-
 [group('typing')]
 typing:
     just typing-mypy