PYTHON-5151 Convert kms tests to use python scripts

Author: blink1073

.evergreen/config.yml

@@ -562,51 +562,6 @@ task_groups:
     tasks:
       - ".serverless"
 
-  - name: testgcpkms_task_group
-    setup_group_can_fail_task: true
-    setup_group_timeout_secs: 1800 # 30 minutes
-    setup_group:
-      - func: fetch source
-      - func: setup system
-      - command: subprocess.exec
-        params:
-          binary: bash
-          args:
-            - ${DRIVERS_TOOLS}/.evergreen/csfle/gcpkms/create-and-setup-instance.sh
-    teardown_task:
-      - command: subprocess.exec
-        params:
-          binary: bash
-          args:
-            - ${DRIVERS_TOOLS}/.evergreen/csfle/gcpkms/delete-instance.sh
-      - func: "upload test results"
-    tasks:
-      - testgcpkms-task
-
-  - name: testazurekms_task_group
-    setup_group:
-      - func: fetch source
-      - func: setup system
-      - command: subprocess.exec
-        params:
-          binary: bash
-          env:
-            AZUREKMS_VMNAME_PREFIX: "PYTHON_DRIVER"
-          args:
-            - ${DRIVERS_TOOLS}/.evergreen/csfle/azurekms/create-and-setup-vm.sh
-    teardown_group:
-      - command: subprocess.exec
-        params:
-          binary: bash
-          args:
-            - ${DRIVERS_TOOLS}/.evergreen/csfle/azurekms/delete-vm.sh
-      - func: "upload test results"
-    setup_group_can_fail_task: true
-    teardown_task_can_fail_task: true
-    setup_group_timeout_secs: 1800
-    tasks:
-    - testazurekms-task
-
   - name: testazureoidc_task_group
     setup_group:
       - func: fetch source
@@ -1395,60 +1350,6 @@ tasks:
       commands:
         - func: "download and merge coverage"
 
-    - name: "testgcpkms-task"
-      commands:
-        - command: subprocess.exec
-          type: test
-          params:
-            working_dir: "src"
-            binary: bash
-            include_expansions_in_env: ["DRIVERS_TOOLS"]
-            args:
-              - .evergreen/run-gcpkms-test.sh
-
-    - name: "testgcpkms-fail-task"
-      # testgcpkms-fail-task runs in a non-GCE environment.
-      # It is expected to fail to obtain GCE credentials.
-      commands:
-        - func: "bootstrap mongo-orchestration"
-          vars:
-            VERSION: "latest"
-            TOPOLOGY: "server"
-        - command: subprocess.exec
-          type: test
-          params:
-            include_expansions_in_env: ["PYTHON_BINARY"]
-            working_dir: "src"
-            binary: "bash"
-            args:
-              - .evergreen/scripts/run-gcpkms-fail-test.sh
-
-    - name: testazurekms-task
-      commands:
-      - command: subprocess.exec
-        type: test
-        params:
-          binary: bash
-          working_dir: src
-          include_expansions_in_env: ["DRIVERS_TOOLS"]
-          args:
-            - .evergreen/run-azurekms-test.sh
-
-    - name: testazurekms-fail-task
-      commands:
-      - func: "bootstrap mongo-orchestration"
-        vars:
-          VERSION: "latest"
-          TOPOLOGY: "server"
-      - command: subprocess.exec
-        type: test
-        params:
-          binary: bash
-          working_dir: src
-          include_expansions_in_env: ["DRIVERS_TOOLS"]
-          args:
-            - .evergreen/run-azurekms-fail-test.sh
-
     - name: "perf-6.0-standalone"
       tags: ["perf"]
       commands:
@@ -1529,12 +1430,12 @@ buildvariants:
   run_on:
     - debian11-small
   tasks:
-    - name: testgcpkms_task_group
+    - name: test-gcpkms
       batchtime: 20160 # Use a batchtime of 14 days as suggested by the CSFLE test README
-    - testgcpkms-fail-task
-    - name: testazurekms_task_group
+    - name: test-gcpkms-fail
+    - name: test-azurekms
       batchtime: 20160 # Use a batchtime of 14 days as suggested by the CSFLE test README
-    - testazurekms-fail-task
+    - name: test-azurekms-fail
 
 - name: rhel8-test-lambda
   display_name: FaaS Lambda

.evergreen/run-azurekms-fail-test.sh

@@ -835,6 +835,24 @@ def create_load_balancer_tasks():
     return tasks
 
 
+def create_kms_tests():
+    tasks = []
+    for kms_type in ["gcp", "azure"]:
+        for success in [True, False]:
+            name = f"test-{kms_type}"
+            sub_test_name = kms_type
+            if not success:
+                name += "-fail"
+                sub_test_name += " fail"
+            commands = []
+            if not success:
+                commands.append(FunctionCall(func="bootstrap mongo-orchestration"))
+            test_vars = dict(TEST_NAME="kms", SUB_TEST_NAME=sub_test_name)
+            test_func = FunctionCall(func="run tests", vars=test_vars)
+            commands.append(test_func)
+            tasks.append(EvgTask(name=name, commands=commands))
+
+
 ##################
 # Generate Config
 ##################

.evergreen/run-azurekms-test.sh

@@ -1,28 +1,22 @@
 from __future__ import annotations
 
 import json
-import logging
 import os
 import platform
 import shutil
 import sys
 from datetime import datetime
-from pathlib import Path
 
 import pytest
+from utils import LOGGER, ROOT
 
-HERE = Path(__file__).absolute().parent
-ROOT = HERE.parent.parent
 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")
-
 
 def handle_perf(start_time: datetime):
     end_time = datetime.now()

.evergreen/run-gcpkms-test.sh

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+import os
+
+from utils import DRIVERS_TOOLS, LOGGER, ROOT, read_env, run_command, write_env
+
+TMP_DRIVER_FILE = "/tmp/mongo-python-driver.tgz"  # noqa: S108
+
+
+def setup_azurekms() -> None:
+    LOGGER.info("Copying files to Azure VM...")
+    cmd = f"""AZUREKMS_SRC="{TMP_DRIVER_FILE}" AZUREKMS_DST="~/" \
+        {DRIVERS_TOOLS}/.evergreen/csfle/azurekms/copy-file.sh"""
+    run_command(cmd)
+    cmd = """AZUREKMS_CMD="tar xf mongo-python-driver.tgz" \
+        {DRIVERS_TOOLS}/.evergreen/csfle/azurekms/run-command.sh"""
+    run_command(cmd)
+    LOGGER.info("Copying files to Azure VM... done.")
+
+
+def setup_gcpkms() -> None:
+    LOGGER.info("Copying files to GCP VM...")
+    cmd = f"GCPKMS_SRC={TMP_DRIVER_FILE} GCPKMS_DST=$GCPKMS_INSTANCENAME: {DRIVERS_TOOLS}/.evergreen/csfle/gcpkms/copy-file.sh"
+    run_command(cmd)
+    cmd = f'GCPKMS_CMD="tar xf mongo-python-driver.tgz" {DRIVERS_TOOLS}/.evergreen/csfle/gcpkms/run-command.sh'
+    run_command(cmd)
+    LOGGER.info("Copying files to GCP VM...")
+
+
+def create_archive():
+    run_command("git add .", cwd=ROOT)
+    run_command('git commit -m "add files"', check=False, cwd=ROOT)
+    run_command(f"git archive -o {TMP_DRIVER_FILE} HEAD", cwd=ROOT)
+
+
+def setup_kms(sub_test_name: str, success: bool) -> None:
+    success = "fail" not in sub_test_name
+    sub_test_type = sub_test_name.split()[0]
+    if sub_test_name.startswith("azure"):
+        write_env("TEST_FLE_AZURE_AUTO")
+    else:
+        write_env("TEST_FLE_GCP_AUTO")
+
+    write_env("SUCCESS", success)
+
+    if sub_test_type == "azure":
+        os.environ["AZUREKMS_VMNAME_PREFIX"] = "PYTHON_DRIVER"
+
+    run_command(f"{DRIVERS_TOOLS}/.evergreen/csfle/{sub_test_type}kms/setup-secrets.sh")
+    config = read_env(f"{DRIVERS_TOOLS}/csfle/a{sub_test_type}kms/secrets-export.sh")
+    if success:
+        run_command(f"{DRIVERS_TOOLS}/.evergreen/csfle/{sub_test_type}kms/setup.sh")
+        create_archive()
+
+        if sub_test_name == "azure":
+            mongodb_uri = setup_azurekms(config)
+        else:
+            mongodb_uri = setup_gcpkms(config)
+
+    elif sub_test_type == "azure":
+        write_env("KEY_NAME", config["AZUREKMS_KEYNAME"])
+        write_env("KEY_VAULT_ENDPOINT", config["AZUREKMS_KEYVAULTENDPOINT"])
+
+    if "@" in mongodb_uri:
+        raise RuntimeError("MONGODB_URI unexpectedly contains user credentials in FLE test!")
+
+    write_env("MONGODB_URI", mongodb_uri)
+
+
+if __name__ == "__main__":
+    setup_kms()