improve usability

Author: blink1073

.evergreen/scripts/run_server.py

@@ -11,9 +11,21 @@ def set_env(name: str, value: Any = "1") -> None:
 
 
 def start_server():
-    opts = get_test_options(require_sub_test_name=False)
+    opts, extra_opts = get_test_options(
+        "Run a MongoDB server.  All given flags will be passed to run-orchestration.sh in DRIVERS_TOOLS.",
+        require_sub_test_name=False,
+        allow_extra_opts=True,
+    )
     test_name = opts.test_name
 
+    if opts.auth:
+        extra_opts.append("--auth")
+
+    if opts.verbose:
+        extra_opts.append("-v")
+    elif opts.quiet:
+        extra_opts.append("-q")
+
     if test_name == "auth_aws":
         set_env("AUTH_AWS")
 
@@ -24,12 +36,13 @@ def start_server():
         set_env("SKIP_CRYPT_SHARED")
 
     if opts.ssl:
+        extra_opts.append("--ssl")
         certs = ROOT / "test/certificates"
         set_env("TLS_CERT_KEY_FILE", certs / "client.pem")
         set_env("TLS_PEM_KEY_FILE", certs / "server.pem")
         set_env("TLS_CA_FILE", certs / "ca.pem")
 
-    cmd = f"bash {DRIVERS_TOOLS}/.evergreen/run-orchestration.sh"
+    cmd = ["bash", f"{DRIVERS_TOOLS}/.evergreen/run-orchestration.sh", *extra_opts]
     run_command(cmd, cwd=DRIVERS_TOOLS)
 
 

.evergreen/scripts/setup_tests.py

@@ -113,7 +113,7 @@ def setup_libmongocrypt():
 
 
 def handle_test_env() -> None:
-    opts = get_test_options()
+    opts, _ = get_test_options("Set up the test environment and services.")
     test_name = opts.test_name
     sub_test_name = opts.sub_test_name
     AUTH = "auth" if opts.auth else "noauth"

.evergreen/scripts/utils.py

@@ -52,18 +52,31 @@ class Distro:
 SUB_TEST_REQUIRED = ["auth_aws", "kms"]
 
 
-def get_test_options(require_sub_test_name=True):
+def get_test_options(
+    description, require_sub_test_name=True, allow_extra_opts=False
+) -> tuple[argparse.Namespace, list[str]]:
     parser = argparse.ArgumentParser(
-        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
+        description=description, formatter_class=argparse.RawDescriptionHelpFormatter
     )
-    parser.add_argument(
-        "test_name",
-        choices=sorted(TEST_SUITE_MAP),
-        nargs="?",
-        default="default",
-        help="The name of the test suite to set up, typically the same name as a pytest marker.",
-    )
-    parser.add_argument("sub_test_name", nargs="?", help="The sub test name, for example 'azure'")
+    if require_sub_test_name:
+        parser.add_argument(
+            "test_name",
+            choices=sorted(TEST_SUITE_MAP),
+            nargs="?",
+            default="default",
+            help="The optional name of the test suite to set up, typically the same name as a pytest marker.",
+        )
+        parser.add_argument(
+            "sub_test_name", nargs="?", help="The optional sub test name, for example 'azure'."
+        )
+    else:
+        parser.add_argument(
+            "test_name",
+            choices=sorted(TEST_SUITE_MAP),
+            nargs="?",
+            default="default",
+            help="The optional name of the test suite to be run, which informs the server configuration.",
+        )
     parser.add_argument(
         "--verbose", "-v", action="store_true", help="Whether to log at the DEBUG level"
     )
@@ -73,15 +86,18 @@ def get_test_options(require_sub_test_name=True):
     parser.add_argument("--auth", action="store_true", help="Whether to add authentication")
     parser.add_argument("--ssl", action="store_true", help="Whether to add TLS configuration")
     # Get the options.
-    opts = parser.parse_args()
+    if not allow_extra_opts:
+        opts, extra_opts = parser.parse_args(), []
+    else:
+        opts, extra_opts = parser.parse_known_args()
     if opts.verbose:
         LOGGER.setLevel(logging.DEBUG)
     elif opts.quiet:
         LOGGER.setLevel(logging.WARNING)
 
     # Handle validation and environment variable overrides.
     test_name = opts.test_name
-    sub_test_name = opts.sub_test_name
+    sub_test_name = opts.sub_test_name if require_sub_test_name else ""
     if require_sub_test_name and test_name in SUB_TEST_REQUIRED and not sub_test_name:
         raise ValueError(f"Test '{test_name}' requires a sub_test_name")
     if "auth" in test_name or os.environ.get("AUTH") == "auth":
@@ -91,7 +107,7 @@ def get_test_options(require_sub_test_name=True):
             opts.auth = False
     if os.environ.get("SSL") == "ssl":
         opts.ssl = True
-    return opts
+    return opts, extra_opts
 
 
 def read_env(path: Path | str) -> dict[str, Any]:
@@ -115,8 +131,10 @@ def write_env(name: str, value: Any = "1") -> None:
         fid.write(f'export {name}="{value}"\n')
 
 
-def run_command(cmd: str, **kwargs: Any) -> None:
-    LOGGER.info("Running command %s...", cmd)
+def run_command(cmd: str | list[str], **kwargs: Any) -> None:
+    if isinstance(cmd, list):
+        cmd = " ".join(cmd)
+    LOGGER.info("Running command '%s'...", cmd)
     kwargs.setdefault("check", True)
     subprocess.run(shlex.split(cmd), **kwargs)  # noqa: PLW1510, S603
-    LOGGER.info("Running command %s... done.", cmd)
+    LOGGER.info("Running command '%s'... done.", cmd)

CONTRIBUTING.md

@@ -218,6 +218,7 @@ the pages will re-render and the browser will automatically refresh.
 ### Usage
 
 - Run `just run-server` with optional args to set up the server.
+  All given flags will be passed to `run-orchestration.sh` in `DRIVERS_TOOLS`.
 - Run `just setup-tests` with optional args to set up the test environment, secrets, etc.
 - Run `just run-tests` to run the tests in an appropriate Python environment.
 - When done, run `just teardown-tests` to clean up and `just stop-server` to stop the server.