fix(cli): Ensure ADK compatibility in agent engine requirements

Use a Final constant (`_AGENT_ENGINE_REQUIREMENT`) containing the `adk` extra
for the `google-cloud-aiplatform` package in the generated requirements.txt
instead of hardcoding the dependency without it. This ensures all required ADK
templates and classes are available in the deployed Vertex AI Agent Engine,
preventing `ModuleNotFoundError: No module named
'vertexai.agent_engines.templates.adk'` at runtime.

Fixes #5966

Co-authored-by: Haran Rajkumar <haranrk@google.com>
PiperOrigin-RevId: 933989073

Author: 2 people

src/google/adk/cli/cli_deploy.py

@@ -35,6 +35,9 @@
 _IS_WINDOWS = os.name == 'nt'
 _GCLOUD_CMD = 'gcloud.cmd' if _IS_WINDOWS else 'gcloud'
 _LOCAL_STORAGE_FLAG_MIN_VERSION: Final[str] = '1.21.0'
+_AGENT_ENGINE_REQUIREMENT: Final[str] = (
+    'google-cloud-aiplatform[adk,agent_engines]'
+)
 
 
 def _ensure_agent_engine_dependency(requirements_txt_path: str) -> None:
@@ -60,7 +63,7 @@ def _ensure_agent_engine_dependency(requirements_txt_path: str) -> None:
   with open(requirements_txt_path, 'a', encoding='utf-8') as f:
     if requirements and not requirements.endswith('\n'):
       f.write('\n')
-    f.write('google-cloud-aiplatform[agent_engines]\n')
+    f.write(f'{_AGENT_ENGINE_REQUIREMENT}\n')
     f.write(f'google-adk[a2a]=={__version__}\n')
 
 
@@ -1013,7 +1016,7 @@ def to_agent_engine(
     if not os.path.exists(requirements_txt_path):
       click.echo(f'Creating {requirements_txt_path}...')
       with open(requirements_txt_path, 'w', encoding='utf-8') as f:
-        f.write('google-cloud-aiplatform[agent_engines]\n')
+        f.write(f'{_AGENT_ENGINE_REQUIREMENT}\n')
         f.write(f'google-adk[a2a]=={__version__}\n')
         click.echo(f'Using google-adk[a2a]=={__version__} in requirements')
       click.echo(f'Created {requirements_txt_path}')

tests/unittests/cli/utils/test_cli_deploy.py

@@ -302,6 +302,13 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
   assert len(create_recorder.calls) == 1
   assert str(rmtree_recorder.get_last_call_args()[0]) == str(tmp_dir)
 
+  requirements_file = tmp_dir / "agents" / "agent" / "requirements.txt"
+  assert requirements_file.is_file()
+  assert (
+      "google-cloud-aiplatform[adk,agent_engines]"
+      in requirements_file.read_text()
+  )
+
 
 def test_to_agent_engine_raises_when_explicit_config_file_missing(
     monkeypatch: pytest.MonkeyPatch,
@@ -682,3 +689,26 @@ def test_cli_deploy_agent_engine_artifact_service_uri(tmp_path: Path):
     mock_to_agent_engine.assert_called_once()
     _, kwargs = mock_to_agent_engine.call_args
     assert kwargs["artifact_service_uri"] == "gs://my-bucket"
+
+
+def test_ensure_agent_engine_dependency(tmp_path: Path):
+  """Tests that _ensure_agent_engine_dependency appends correct extras."""
+  requirements_file = tmp_path / "requirements.txt"
+
+  # Case 1: raises FileNotFoundError when the file doesn't exist
+  with pytest.raises(FileNotFoundError):
+    cli_deploy._ensure_agent_engine_dependency(str(requirements_file))
+
+  # Case 2: appends google-cloud-aiplatform with 'adk' and 'agent_engines'
+  # extras and the versioned google-adk requirement.
+  requirements_file.write_text("")
+  cli_deploy._ensure_agent_engine_dependency(str(requirements_file))
+  content = requirements_file.read_text()
+  assert "google-cloud-aiplatform[adk,agent_engines]\n" in content
+  assert f"google-adk[a2a]=={cli_deploy.__version__}\n" in content
+
+  # Case 3: does not append duplicate if google-cloud-aiplatform already exists
+  requirements_file.write_text("google-cloud-aiplatform[adk,agent_engines]\n")
+  cli_deploy._ensure_agent_engine_dependency(str(requirements_file))
+  content = requirements_file.read_text()
+  assert content == "google-cloud-aiplatform[adk,agent_engines]\n"