DRIVERS-2917 - Standardized Performance Testing of ODMs and Integrations

.evergreen/config.yml

@@ -48,6 +48,64 @@ functions:
         args:
           - ./.evergreen/run-tests.sh
 
+  "run performance tests":
+    - command: subprocess.exec
+      type: test
+      params:
+        binary: bash
+        working_dir: "src"
+        include_expansions_in_env: [ "DRIVERS_TOOLS", "MONGODB_URI" ]
+        args:
+          - ./.evergreen/run-perf-tests.sh
+
+  attach benchmark test results:
+    - command: attach.results
+      params:
+        file_location: src/report.json
+
+  send dashboard data:
+    - command: subprocess.exec
+      params:
+        binary: bash
+        args:
+          - .evergreen/perf-submission-setup.sh
+        working_dir: src
+        include_expansions_in_env: [
+          "requester",
+          "revision_order_id",
+          "project_id",
+          "version_id",
+          "build_variant",
+          "parsed_order_id",
+          "task_name",
+          "task_id",
+          "execution",
+          "is_mainline"
+        ]
+      type: test
+    - command: expansions.update
+      params:
+        file: src/expansion.yml
+    - command: subprocess.exec
+      params:
+        binary: bash
+        args:
+          - .evergreen/perf-submission.sh
+        working_dir: src
+        include_expansions_in_env: [
+          "requester",
+          "revision_order_id",
+          "project_id",
+          "version_id",
+          "build_variant",
+          "parsed_order_id",
+          "task_name",
+          "task_id",
+          "execution",
+          "is_mainline"
+        ]
+      type: test
+
   "teardown":
     - command: subprocess.exec
       params:
@@ -67,6 +125,12 @@ tasks:
     commands:
       - func: "run unit tests"
 
+  - name: perf-tests
+    commands:
+      - func: "run performance tests"
+      - func: "attach benchmark test results"
+      - func: "send dashboard data"
+
 buildvariants:
   - name: tests-6-noauth-nossl
     display_name: Run Tests 6.0 NoAuth NoSSL
@@ -111,3 +175,11 @@ buildvariants:
       SSL: "ssl"
     tasks:
       - name: run-tests
+
+  - name: performance-benchmarks
+    display_name: Performance Benchmarks
+    run_on:
+      - rhel90-dbx-perf-large
+    batchtime: 10080
+    tasks:
+      - name: perf-tests

.evergreen/perf-submission-setup.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# We use the requester expansion to determine whether the data is from a mainline evergreen run or not
+
+set -eu
+
+# shellcheck disable=SC2154
+if [ "${requester}" == "commit" ]; then
+  echo "is_mainline: true" >> expansion.yml
+else
+  echo "is_mainline: false" >> expansion.yml
+fi
+
+# We parse the username out of the order_id as patches append that in and SPS does not need that information
+# shellcheck disable=SC2154
+echo "parsed_order_id: $(echo "${revision_order_id}" | awk -F'_' '{print $NF}')"  >> expansion.yml

.evergreen/perf-submission.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# We use the requester expansion to determine whether the data is from a mainline evergreen run or not
+
+set -eu
+
+# Submit the performance data to the SPS endpoint
+# shellcheck disable=SC2154
+response=$(curl -s -w "\nHTTP_STATUS:%{http_code}" -X 'POST' \
+  "https://performance-monitoring-api.corp.mongodb.com/raw_perf_results/cedar_report?project=${project_id}&version=${version_id}&variant=${build_variant}&order=${parsed_order_id}&task_name=${task_name}&task_id=${task_id}&execution=${execution}&mainline=${is_mainline}" \
+  -H 'accept: application/json' \
+  -H 'Content-Type: application/json' \
+  -d @results.json)
+
+http_status=$(echo "$response" | grep "HTTP_STATUS" | awk -F':' '{print $2}')
+response_body=$(echo "$response" | sed '/HTTP_STATUS/d')
+
+# We want to throw an error if the data was not successfully submitted
+if [ "$http_status" -ne 200 ]; then
+  echo "Error: Received HTTP status $http_status"
+  echo "Response Body: $response_body"
+  exit 1
+fi
+
+echo "Response Body: $response_body"
+echo "HTTP Status: $http_status"

.evergreen/run-perf-tests.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/bash
+
+set -eux
+
+export OUTPUT_FILE="results.json"
+
+# Install django-mongodb-backend
+/opt/python/3.10/bin/python3 -m venv venv
+. venv/bin/activate
+python -m pip install -U pip
+pip install -e .
+
+python .evergreen/run_perf_test.py
+mv tests/performance/$OUTPUT_FILE $OUTPUT_FILE
+mv tests/performance/report.json report.json

.evergreen/run_perf_test.py

@@ -0,0 +1,55 @@
+import json
+import logging
+import os
+import shlex
+import subprocess
+import sys
+from datetime import datetime
+
+LOGGER = logging.getLogger("test")
+logging.basicConfig(level=logging.INFO, format="%(levelname)-8s %(message)s")
+OUTPUT_FILE = os.environ.get("OUTPUT_FILE")
+
+
+def handle_perf(start_time: datetime):
+    end_time = datetime.now()
+    elapsed_secs = (end_time - start_time).total_seconds()
+    with open(OUTPUT_FILE) as fid:  # noqa: PTH123
+        results = json.load(fid)
+    LOGGER.info("results.json:\n%s", json.dumps(results, indent=2))
+
+    results = {
+        "status": "PASS",
+        "exit_code": 0,
+        "test_file": "BenchMarkTests",
+        "start": int(start_time.timestamp()),
+        "end": int(end_time.timestamp()),
+        "elapsed": elapsed_secs,
+    }
+    report = {"results": [results]}
+
+    LOGGER.info("report.json\n%s", json.dumps(report, indent=2))
+
+    with open("report.json", "w", newline="\n") as fid:  # noqa: PTH123
+        json.dump(report, fid)
+
+
+def run_command(cmd: str | list[str], **kwargs) -> None:
+    if isinstance(cmd, list):
+        cmd = " ".join(cmd)
+    LOGGER.info("Running command '%s'...", cmd)
+    kwargs.setdefault("check", True)
+    try:
+        subprocess.run(shlex.split(cmd), **kwargs)  # noqa: PLW1510, S603
+    except subprocess.CalledProcessError as e:
+        LOGGER.error(e.output)
+        LOGGER.error(str(e))
+        sys.exit(e.returncode)
+    LOGGER.info("Running command '%s'... done.", cmd)
+
+
+os.chdir("tests/performance")
+
+start_time = datetime.now()
+run_command(["python manage.py test"])
+handle_perf(start_time)

.github/workflows/runtests.py

@@ -157,7 +157,8 @@
             x.name
             for x in (pathlib.Path(__file__).parent.parent.parent.resolve() / "tests").iterdir()
             # Omit GIS tests unless GIS libraries are installed.
-            if x.name != "gis_tests_"
+            # Always omit the performance benchmarking suite.
+            if x.name != "gis_tests_" and x.name != "performance"
         ]
     ),
 ]

tests/performance/manage.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "perftest.settings")
+    try:
+        from django.core.management import execute_from_command_line  # noqa: PLC0415
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()