Add --suite flag to tbots.py to run entire test suites (#3586)

* Add --suite flag to run test suites

* Add running test suite from tbots to docs

* Add option for no search query when --suite is specified

* Remove repeated -t flag

* Refactor tbots.py a bit, now running test suite works

* Revert docs update

* Merge master

Author: nycrat

src/cli/cli_params.py

@@ -1,4 +1,4 @@
-from typer import Option
+from typer import Option, Argument
 from enum import Enum
 from typing import Annotated
 
@@ -17,6 +17,10 @@ class DebugBinary(str, Enum):
     yellow = "yellow"
 
 
+SearchQueryArgument = Annotated[
+    str | None, Argument(help="Search query for bazel target")
+]
+
 PrintCommandOption: type[bool] = Annotated[
     bool, Option("-p", "--print_command", help="Print the generated Bazel command")
 ]
@@ -76,6 +80,11 @@ class DebugBinary(str, Enum):
     bool, Option("--tracy", help="Run the binary with the TRACY_ENABLE macro defined")
 ]
 
+TestSuiteOption = Annotated[
+    bool,
+    Option("--suite", help="Run entire test suite instead of searching for a target"),
+]
+
 EnableThunderscopeOption = Annotated[bool, Option("-t", "--enable_thunderscope")]
 EnableVisualizerOption = Annotated[bool, Option("-v", "--enable_visualizer")]
 StopAIOnStartOption = Annotated[bool, Option("-s", "--stop_ai_on_start")]

src/tbots.py

@@ -21,6 +21,8 @@
     EnableThunderscopeOption,
     EnableVisualizerOption,
     StopAIOnStartOption,
+    SearchQueryArgument,
+    TestSuiteOption,
     DebugBinary,
     JobsOption,
 )
@@ -37,33 +39,11 @@
 app = Typer()
 
 
-@app.command(
-    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
-    no_args_is_help=True,
-)
-def main(
-    ctx: Context,
+def fuzzy_find_target(
     action: ActionArgument,
-    search_query: str,
-    print_command: PrintCommandOption = False,
-    no_optimized_build: NoOptimizedBuildOption = False,
-    debug_build: DebugBuildOption = False,
-    select_debug_binaries: SelectDebugBinariesOption = None,
-    flash_robots: FlashRobotsOption = None,
-    ssh_password: SSHPasswordOption = None,
-    interactive_search: InteractiveModeOption = False,
-    tracy: TracyOption = False,
-    enable_thunderscope: EnableThunderscopeOption = False,
-    enable_visualizer: EnableVisualizerOption = False,
-    stop_ai_on_start: StopAIOnStartOption = False,
-    jobs_option: JobsOption = None,
-) -> None:
-    if bool(flash_robots) ^ bool(ssh_password):
-        print(
-            "If you want to flash robots, both the robot IDs and password must be provided"
-        )
-        sys.exit(1)
-
+    search_query: SearchQueryArgument,
+    interactive_search: InteractiveModeOption,
+) -> str:
     test_query = ["bazel", "query", "tests(//...)"]
     binary_query = ["bazel", "query", "kind(.*_binary,//...)"]
     library_query = ["bazel", "query", "kind(.*_library,//...)"]
@@ -109,7 +89,53 @@ def main(
         target = str(iterfzf.iterfzf(iter(targets)), encoding="utf-8")
         print("User selected {}".format(target))
 
-    command = ["bazel", action.value, target]
+    return target
+
+
+@app.command(
+    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+    no_args_is_help=True,
+)
+def main(
+    ctx: Context,
+    action: ActionArgument,
+    search_query: SearchQueryArgument = None,
+    print_command: PrintCommandOption = False,
+    no_optimized_build: NoOptimizedBuildOption = False,
+    debug_build: DebugBuildOption = False,
+    select_debug_binaries: SelectDebugBinariesOption = None,
+    flash_robots: FlashRobotsOption = None,
+    ssh_password: SSHPasswordOption = None,
+    interactive_search: InteractiveModeOption = False,
+    tracy: TracyOption = False,
+    enable_thunderscope: EnableThunderscopeOption = False,
+    enable_visualizer: EnableVisualizerOption = False,
+    stop_ai_on_start: StopAIOnStartOption = False,
+    test_suite: TestSuiteOption = False,
+    jobs_option: JobsOption = "",
+) -> None:
+    if bool(flash_robots) ^ bool(ssh_password):
+        print(
+            "If you want to flash robots, both the robot IDs and password must be provided"
+        )
+        sys.exit(1)
+
+    if search_query is None and (not test_suite or not action == ActionArgument.test):
+        print(
+            "You must specify a search query unless you are running the test suite, use ./tbots.py test --suite instead"
+        )
+        sys.exit(1)
+
+    if test_suite and action == ActionArgument.test:
+        target = """-- //...                              \\
+                      -//software/field_tests/...         \\
+                      -//toolchains/cc/...                \\
+                      -//software:unix_full_system_tar_gen"""
+        print("Running software and simulated gameplay test suite")
+    else:
+        target = fuzzy_find_target(action, search_query, interactive_search)
+
+    command = ["bazel", action.value]
     unknown_args = ctx.args
 
     # Trigger a debug build
@@ -151,6 +177,8 @@ def main(
     if action == ActionArgument.run:
         command += ["--"]
 
+    command.append(target)
+
     bazel_arguments = unknown_args
     if stop_ai_on_start:
         bazel_arguments += ["--stop_ai_on_start"]