feat: Add log_level option for adk run CLI

Merge google#3674

Co-authored-by: Xuan Yang <xygoogle@google.com>
PiperOrigin-RevId: 933452646

Author: 2 people

src/google/adk/cli/cli_tools_click.py

@@ -47,6 +47,41 @@
 )
 
 
+def _logging_options():
+  """Decorator to add logging options to click commands."""
+
+  def decorator(func):
+    @click.option(
+        "-v",
+        "--verbose",
+        is_flag=True,
+        show_default=True,
+        default=False,
+        help="Enable verbose (DEBUG) logging. Shortcut for --log_level DEBUG.",
+    )
+    @click.option(
+        "--log_level",
+        type=LOG_LEVELS,
+        default="INFO",
+        help="Optional. Set the logging level",
+    )
+    @functools.wraps(func)
+    @click.pass_context
+    def wrapper(ctx, *args, **kwargs):
+      # If verbose flag is set and log level is not set, set log level to DEBUG.
+      log_level_source = ctx.get_parameter_source("log_level")
+      if (
+          kwargs.pop("verbose", False)
+          and log_level_source == ParameterSource.DEFAULT
+      ):
+        kwargs["log_level"] = "DEBUG"
+      return func(*args, **kwargs)
+
+    return wrapper
+
+  return decorator
+
+
 def _apply_feature_overrides(
     *,
     enable_features: tuple[str, ...] = (),
@@ -606,6 +641,7 @@ def wrapper(*args, **kwargs):
 @main.command("run", cls=HelpfulCommand)
 @feature_options()
 @adk_services_options(default_use_local_storage=True)
+@_logging_options()
 @click.option(
     "--save_session",
     type=bool,
@@ -700,6 +736,7 @@ def cli_run(
     memory_service_uri: Optional[str] = None,
     use_local_storage: bool = True,
     default_llm_model: Optional[str] = None,
+    log_level: str = "INFO",
 ):
   """Runs an agent. If no query is provided, enters interactive mode.
 
@@ -711,7 +748,7 @@ def cli_run(
     adk run path/to/my_agent
     adk run path/to/my_agent "hello"
   """
-  logs.log_to_tmp_folder()
+  logs.log_to_tmp_folder(level=getattr(logging, log_level.upper()))
 
   agent_parent_folder = os.path.dirname(agent)
   agent_folder_name = os.path.basename(agent)
@@ -1588,6 +1625,7 @@ def fast_api_common_options():
   """Decorator to add common fast api options to click commands."""
 
   def decorator(func):
+    func = _logging_options()(func)
 
     @click.option(
         "--host",
@@ -1611,20 +1649,6 @@ def decorator(func):
         ),
         multiple=True,
     )
-    @click.option(
-        "-v",
-        "--verbose",
-        is_flag=True,
-        show_default=True,
-        default=False,
-        help="Enable verbose (DEBUG) logging. Shortcut for --log_level DEBUG.",
-    )
-    @click.option(
-        "--log_level",
-        type=LOG_LEVELS,
-        default="INFO",
-        help="Optional. Set the logging level",
-    )
     @click.option(
         "--trace_to_cloud",
         is_flag=True,
@@ -1707,14 +1731,6 @@ def decorator(func):
     @functools.wraps(func)
     @click.pass_context
     def wrapper(ctx, *args, **kwargs):
-      # If verbose flag is set and log level is not set, set log level to DEBUG.
-      log_level_source = ctx.get_parameter_source("log_level")
-      if (
-          kwargs.pop("verbose", False)
-          and log_level_source == ParameterSource.DEFAULT
-      ):
-        kwargs["log_level"] = "DEBUG"
-
       # Parse comma-separated trigger_sources into a list.
       trigger_sources = kwargs.get("trigger_sources")
       if trigger_sources is not None:

tests/unittests/cli/test_cli_tools_click_option_mismatch.py

@@ -98,7 +98,7 @@ def test_adk_run():
       run_command,
       cli_run.callback,
       "run",
-      ignore_params={"enable_features", "disable_features"},
+      ignore_params={"verbose", "enable_features", "disable_features"},
   )
 
 

tests/unittests/cli/utils/test_cli_tools_click.py

@@ -18,6 +18,7 @@
 
 import builtins
 import json
+import logging
 from pathlib import Path
 from types import SimpleNamespace
 from typing import Any
@@ -1538,3 +1539,73 @@ def _mock_to_cloud_run(*_a, **kwargs):
       " command."
   )
   assert expected_msg in result.output
+
+
+@pytest.mark.parametrize(
+    "cli_args,expected_log_level",
+    [
+        pytest.param(
+            [],
+            "INFO",
+            id="default_info",
+        ),
+        pytest.param(
+            ["--log_level", "DEBUG"],
+            "DEBUG",
+            id="explicit_debug",
+        ),
+        pytest.param(
+            ["--log_level", "WARNING"],
+            "WARNING",
+            id="explicit_warning",
+        ),
+        pytest.param(
+            ["-v"],
+            "DEBUG",
+            id="verbose_flag",
+        ),
+        pytest.param(
+            ["--verbose"],
+            "DEBUG",
+            id="verbose_long_flag",
+        ),
+        pytest.param(
+            ["-v", "--log_level", "WARNING"],
+            "WARNING",
+            id="both_verbose_and_explicit_warning",
+        ),
+    ],
+)
+def test_cli_run_log_level(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+    cli_args: list[str],
+    expected_log_level: str,
+) -> None:
+  """`adk run` should configure log level correctly based on flags."""
+  agent_dir = tmp_path / "agent"
+  agent_dir.mkdir()
+  (agent_dir / "__init__.py").touch()
+  (agent_dir / "agent.py").touch()
+
+  # Mock logs.log_to_tmp_folder
+  mock_log_to_tmp_folder = mock.Mock()
+  monkeypatch.setattr(
+      cli_tools_click.logs, "log_to_tmp_folder", mock_log_to_tmp_folder
+  )
+
+  # Mock asyncio.run to do nothing, preventing full run
+  monkeypatch.setattr(cli_tools_click.asyncio, "run", mock.Mock())
+
+  runner = CliRunner()
+  result = runner.invoke(
+      cli_tools_click.main,
+      ["run", *cli_args, str(agent_dir)],
+  )
+  assert result.exit_code == 0, (result.output, repr(result.exception))
+
+  # Check if log_to_tmp_folder was called with the correct log level object from `logging` module
+  expected_logging_level = getattr(logging, expected_log_level)
+  mock_log_to_tmp_folder.assert_called_once()
+  kwargs = mock_log_to_tmp_folder.call_args[1]
+  assert kwargs.get("level") == expected_logging_level