chore: import upstream snapshot with attribution

tests/unittests/cli/utils/test_cli_create.py

@@ -0,0 +1,560 @@
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Tests for utilities in cli_create."""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+import subprocess
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import Tuple
+
+import click
+import google.adk.cli.cli_create as cli_create
+from google.adk.cli.utils import _onboarding
+from google.adk.cli.utils import gcp_utils
+import pytest
+
+
+# Helpers
+class _Recorder:
+  """A callable object that records every invocation."""
+
+  def __init__(self) -> None:
+    self.calls: List[Tuple[Tuple[Any, ...], Dict[str, Any]]] = []
+
+  def __call__(self, *args: Any, **kwargs: Any) -> None:  # noqa: D401
+    self.calls.append((args, kwargs))
+
+
+# Fixtures
+@pytest.fixture(autouse=True)
+def _mute_click(monkeypatch: pytest.MonkeyPatch) -> None:
+  """Silence click output in every test."""
+  monkeypatch.setattr(click, "echo", lambda *a, **k: None)
+  monkeypatch.setattr(click, "secho", lambda *a, **k: None)
+
+
+@pytest.fixture()
+def agent_folder(tmp_path: Path) -> Path:
+  """Return a temporary path that will hold generated agent sources."""
+  return tmp_path / "agent"
+
+
+# _generate_files
+def test_generate_files_with_api_key(agent_folder: Path) -> None:
+  """Files should be created with the API-key backend and correct .env flags."""
+  cli_create._generate_files(
+      str(agent_folder),
+      google_api_key="dummy-key",
+      model="gemini-2.5-flash",
+      type="code",
+  )
+
+  env_content = (agent_folder / ".env").read_text()
+  assert "GOOGLE_API_KEY=dummy-key" in env_content
+  assert "GOOGLE_GENAI_USE_ENTERPRISE=0" in env_content
+  assert (agent_folder / ".gitignore").read_text() == ".env\n"
+  assert (agent_folder / "agent.py").exists()
+  assert (agent_folder / "__init__.py").exists()
+
+
+def test_generate_files_with_gcp(agent_folder: Path) -> None:
+  """Files should be created with Vertex AI backend and correct .env flags."""
+  cli_create._generate_files(
+      str(agent_folder),
+      google_cloud_project="proj",
+      google_cloud_region="us-central1",
+      model="gemini-2.5-flash",
+      type="code",
+  )
+
+  env_content = (agent_folder / ".env").read_text()
+  assert "GOOGLE_CLOUD_PROJECT=proj" in env_content
+  assert "GOOGLE_CLOUD_LOCATION=us-central1" in env_content
+  assert "GOOGLE_GENAI_USE_ENTERPRISE=1" in env_content
+
+
+def test_generate_files_with_express_mode(agent_folder: Path) -> None:
+  """Files should be created with Vertex AI backend when both project and API key are present (Express Mode)."""
+  cli_create._generate_files(
+      str(agent_folder),
+      google_api_key="express-api-key",
+      google_cloud_project="express-project-id",
+      google_cloud_region="us-central1",
+      model="gemini-2.5-flash",
+      type="code",
+  )
+
+  env_content = (agent_folder / ".env").read_text()
+  assert "GOOGLE_GENAI_USE_ENTERPRISE=1" in env_content
+  assert "GOOGLE_API_KEY=express-api-key" in env_content
+  assert "GOOGLE_CLOUD_PROJECT=express-project-id" in env_content
+
+
+def test_generate_files_overwrite(agent_folder: Path) -> None:
+  """Existing files should be overwritten when generating again."""
+  agent_folder.mkdir(parents=True, exist_ok=True)
+  (agent_folder / ".env").write_text("OLD")
+
+  cli_create._generate_files(
+      str(agent_folder),
+      google_api_key="new-key",
+      model="gemini-2.5-flash",
+      type="code",
+  )
+
+  assert "GOOGLE_API_KEY=new-key" in (agent_folder / ".env").read_text()
+
+
+def test_generate_files_permission_error(
+    monkeypatch: pytest.MonkeyPatch, agent_folder: Path
+) -> None:
+  """PermissionError raised by os.makedirs should propagate."""
+  monkeypatch.setattr(
+      os, "makedirs", lambda *a, **k: (_ for _ in ()).throw(PermissionError())
+  )
+  with pytest.raises(PermissionError):
+    cli_create._generate_files(
+        str(agent_folder), model="gemini-2.5-flash", type="code"
+    )
+
+
+def test_generate_files_no_params(agent_folder: Path) -> None:
+  """No backend parameters → minimal .env file is generated."""
+  cli_create._generate_files(
+      str(agent_folder), model="gemini-2.5-flash", type="code"
+  )
+
+  env_content = (agent_folder / ".env").read_text()
+  for key in (
+      "GOOGLE_API_KEY",
+      "GOOGLE_CLOUD_PROJECT",
+      "GOOGLE_CLOUD_LOCATION",
+      "GOOGLE_GENAI_USE_ENTERPRISE",
+  ):
+    assert key not in env_content
+
+
+def test_generate_files_appends_dotenv_to_existing_gitignore(
+    agent_folder: Path,
+) -> None:
+  """Existing .gitignore entries should be preserved."""
+  agent_folder.mkdir(parents=True, exist_ok=True)
+  (agent_folder / ".gitignore").write_text("__pycache__")
+
+  cli_create._generate_files(
+      str(agent_folder), model="gemini-2.0-flash-001", type="code"
+  )
+
+  assert (agent_folder / ".gitignore").read_text() == "__pycache__\n.env\n"
+
+
+def test_generate_files_appends_dotenv_to_existing_gitignore_with_newline(
+    agent_folder: Path,
+) -> None:
+  """Existing .gitignore entries ending in a newline should not cause extra blank lines."""
+  agent_folder.mkdir(parents=True, exist_ok=True)
+  (agent_folder / ".gitignore").write_text("__pycache__\n")
+
+  cli_create._generate_files(
+      str(agent_folder), model="gemini-2.0-flash-001", type="code"
+  )
+
+  assert (agent_folder / ".gitignore").read_text() == "__pycache__\n.env\n"
+
+
+def test_generate_files_does_not_duplicate_dotenv_gitignore_entry(
+    agent_folder: Path,
+) -> None:
+  """Existing .env ignore entries should not be duplicated."""
+  agent_folder.mkdir(parents=True, exist_ok=True)
+  (agent_folder / ".gitignore").write_text("__pycache__\n.env\n")
+
+  cli_create._generate_files(
+      str(agent_folder), model="gemini-2.0-flash-001", type="code"
+  )
+
+  assert (agent_folder / ".gitignore").read_text() == "__pycache__\n.env\n"
+
+
+# run_cmd
+def test_run_cmd_overwrite_reject(
+    monkeypatch: pytest.MonkeyPatch, tmp_path: Path
+) -> None:
+  """User rejecting overwrite should trigger click.Abort."""
+  agent_name = "agent"
+  agent_dir = tmp_path / agent_name
+  agent_dir.mkdir()
+  (agent_dir / "dummy.txt").write_text("dummy")
+
+  monkeypatch.setattr(os, "getcwd", lambda: str(tmp_path))
+  monkeypatch.setattr(click, "confirm", lambda *a, **k: False)
+
+  with pytest.raises(click.Abort):
+    cli_create.run_cmd(
+        agent_name,
+        model="gemini-2.5-flash",
+        google_api_key=None,
+        google_cloud_project=None,
+        google_cloud_region=None,
+        type="code",
+    )
+
+
+def test_run_cmd_invalid_app_name(
+    monkeypatch: pytest.MonkeyPatch, tmp_path: Path
+) -> None:
+  """Invalid app names should be rejected before creating any files."""
+  monkeypatch.setattr(os, "getcwd", lambda: str(tmp_path))
+
+  with pytest.raises(click.BadParameter, match="Invalid app name"):
+    cli_create.run_cmd(
+        "invalid name",
+        model="gemini-2.5-flash",
+        google_api_key=None,
+        google_cloud_project=None,
+        google_cloud_region=None,
+        type="code",
+    )
+
+
+def test_run_cmd_with_type_config(
+    monkeypatch: pytest.MonkeyPatch, tmp_path: Path
+) -> None:
+  """run_cmd with --type=config should generate YAML config file."""
+  agent_name = "test_agent"
+
+  monkeypatch.setattr(os, "getcwd", lambda: str(tmp_path))
+
+  cli_create.run_cmd(
+      agent_name,
+      model="gemini-2.5-flash",
+      google_api_key="test-key",
+      google_cloud_project=None,
+      google_cloud_region=None,
+      type="config",
+  )
+
+  agent_dir = tmp_path / agent_name
+  assert agent_dir.exists()
+
+  # Should create root_agent.yaml instead of agent.py
+  yaml_file = agent_dir / "root_agent.yaml"
+  assert yaml_file.exists()
+  assert not (agent_dir / "agent.py").exists()
+
+  # Check YAML content
+  yaml_content = yaml_file.read_text()
+  assert "name: root_agent" in yaml_content
+  assert "model: gemini-2.5-flash" in yaml_content
+  assert "description: A helpful assistant for user questions." in yaml_content
+
+  # Should create empty __init__.py
+  init_file = agent_dir / "__init__.py"
+  assert init_file.exists()
+  assert init_file.read_text().strip() == ""
+
+  # Should still create .env file
+  env_file = agent_dir / ".env"
+  assert env_file.exists()
+  assert "GOOGLE_API_KEY=test-key" in env_file.read_text()
+  assert (agent_dir / ".gitignore").read_text() == ".env\n"
+
+
+# Prompt helpers
+def test_prompt_for_google_cloud(monkeypatch: pytest.MonkeyPatch) -> None:
+  """Prompt should return the project input."""
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "test-proj")
+  assert _onboarding.prompt_for_google_cloud(None) == "test-proj"
+
+
+def test_prompt_for_google_cloud_region(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """Prompt should return the region input."""
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "asia-northeast1")
+  assert _onboarding.prompt_for_google_cloud_region(None) == "asia-northeast1"
+
+
+def test_prompt_for_google_api_key(monkeypatch: pytest.MonkeyPatch) -> None:
+  """Prompt should return the API-key input."""
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "api-key")
+  assert _onboarding.prompt_for_google_api_key(None) == "api-key"
+
+
+def test_prompt_for_model_gemini(monkeypatch: pytest.MonkeyPatch) -> None:
+  """Selecting option '1' should return the default Gemini model string."""
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "1")
+  assert cli_create._prompt_for_model() == "gemini-3.5-flash"
+
+
+def test_prompt_for_model_other(monkeypatch: pytest.MonkeyPatch) -> None:
+  """Selecting option '2' should return placeholder and call secho."""
+  called: Dict[str, bool] = {}
+
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "2")
+
+  def _fake_secho(*_a: Any, **_k: Any) -> None:
+    called["secho"] = True
+
+  monkeypatch.setattr(click, "secho", _fake_secho)
+  assert cli_create._prompt_for_model() == "<FILL_IN_MODEL>"
+  assert called.get("secho") is True
+
+
+# Backend selection helper
+def test_prompt_to_choose_backend_api(monkeypatch: pytest.MonkeyPatch) -> None:
+  """Choosing API-key backend returns (api_key, None, None)."""
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "1")
+  monkeypatch.setattr(
+      _onboarding, "prompt_for_google_api_key", lambda _v: "api-key"
+  )
+
+  auth_info = _onboarding.prompt_to_choose_backend(None, None, None)
+  assert isinstance(auth_info, _onboarding.GoogleAIAuth)
+  assert auth_info.api_key == "api-key"
+
+
+def test_prompt_to_choose_backend_vertex(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """Choosing Vertex backend returns (None, project, region)."""
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "2")
+  monkeypatch.setattr(_onboarding, "prompt_for_google_cloud", lambda _v: "proj")
+  monkeypatch.setattr(
+      _onboarding, "prompt_for_google_cloud_region", lambda _v: "region"
+  )
+
+  auth_info = _onboarding.prompt_to_choose_backend(None, None, None)
+  assert isinstance(auth_info, _onboarding.VertexAIAuth)
+  assert auth_info.project_id == "proj"
+  assert auth_info.region == "region"
+
+
+def test_prompt_to_choose_backend_login(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """Choosing Login with Google returns (api_key, project, region) from handler."""
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "3")
+  monkeypatch.setattr(
+      _onboarding,
+      "handle_login_with_google",
+      lambda: _onboarding.ExpressModeAuth(
+          api_key="api-key", project_id="proj", region="region"
+      ),
+  )
+
+  auth_info = _onboarding.prompt_to_choose_backend(None, None, None)
+  assert isinstance(auth_info, _onboarding.ExpressModeAuth)
+  assert auth_info.api_key == "api-key"
+  assert auth_info.project_id == "proj"
+  assert auth_info.region == "region"
+
+
+def test_handle_login_with_google_existing_express(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """Handler should return existing Express project if found."""
+  monkeypatch.setattr(gcp_utils, "check_adc", lambda: True)
+  monkeypatch.setattr(
+      gcp_utils,
+      "retrieve_express_project",
+      lambda: {"api_key": "key", "project_id": "proj", "region": "us-central1"},
+  )
+
+  auth_info = _onboarding.handle_login_with_google()
+  assert isinstance(auth_info, _onboarding.ExpressModeAuth)
+  assert auth_info.api_key == "key"
+  assert auth_info.project_id == "proj"
+  assert auth_info.region == "us-central1"
+
+
+def test_handle_login_with_google_select_gcp_project(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """Handler should prompt for project selection if no Express project found."""
+  monkeypatch.setattr(gcp_utils, "check_adc", lambda: True)
+  monkeypatch.setattr(gcp_utils, "retrieve_express_project", lambda: None)
+  monkeypatch.setattr(
+      gcp_utils, "list_gcp_projects", lambda limit: [("p1", "Project 1")]
+  )
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: 1)
+  monkeypatch.setattr(
+      _onboarding, "prompt_for_google_cloud_region", lambda _v: "us-east1"
+  )
+
+  auth_info = _onboarding.handle_login_with_google()
+  assert isinstance(auth_info, _onboarding.VertexAIAuth)
+  assert auth_info.project_id == "p1"
+  assert auth_info.region == "us-east1"
+
+
+def test_handle_login_with_google_manual_project(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """Handler should allow manual project ID entry when '0' is selected."""
+  monkeypatch.setattr(gcp_utils, "check_adc", lambda: True)
+  monkeypatch.setattr(gcp_utils, "retrieve_express_project", lambda: None)
+  monkeypatch.setattr(
+      gcp_utils, "list_gcp_projects", lambda limit: [("p1", "Project 1")]
+  )
+  prompts = iter([0, "manual-proj", "us-east1"])
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: next(prompts))
+
+  auth_info = _onboarding.handle_login_with_google()
+  assert isinstance(auth_info, _onboarding.VertexAIAuth)
+  assert auth_info.project_id == "manual-proj"
+  assert auth_info.region == "us-east1"
+
+
+def test_handle_login_with_google_option_1(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """User selects 1, enters project ID and region."""
+  monkeypatch.setattr(gcp_utils, "check_adc", lambda: True)
+  monkeypatch.setattr(gcp_utils, "retrieve_express_project", lambda: None)
+  monkeypatch.setattr(gcp_utils, "list_gcp_projects", lambda limit: [])
+  prompts = iter(["1", "test-proj", "us-east1"])
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: next(prompts))
+
+  auth_info = _onboarding.handle_login_with_google()
+  assert isinstance(auth_info, _onboarding.VertexAIAuth)
+  assert auth_info.project_id == "test-proj"
+  assert auth_info.region == "us-east1"
+
+
+def test_handle_login_with_google_option_2(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """User selects 2, goes through express sign up."""
+  monkeypatch.setattr(gcp_utils, "check_adc", lambda: True)
+  monkeypatch.setattr(gcp_utils, "retrieve_express_project", lambda: None)
+  monkeypatch.setattr(gcp_utils, "list_gcp_projects", lambda limit: [])
+  monkeypatch.setattr(gcp_utils, "check_express_eligibility", lambda: True)
+  monkeypatch.setattr(click, "confirm", lambda *a, **k: True)
+  prompts = iter(["2", "1"])
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: next(prompts))
+  monkeypatch.setattr(
+      gcp_utils,
+      "sign_up_express",
+      lambda location="us-central1": {
+          "api_key": "new-key",
+          "project_id": "new-proj",
+          "region": location,
+      },
+  )
+
+  auth_info = _onboarding.handle_login_with_google()
+  assert isinstance(auth_info, _onboarding.ExpressModeAuth)
+  assert auth_info.api_key == "new-key"
+  assert auth_info.project_id == "new-proj"
+  assert auth_info.region == "us-central1"
+
+
+def test_handle_login_with_google_option_2_unset_project(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """User selects 2, goes through express sign up, and unsets existing gcloud project."""
+  monkeypatch.setattr(gcp_utils, "check_adc", lambda: True)
+  monkeypatch.setattr(gcp_utils, "retrieve_express_project", lambda: None)
+  monkeypatch.setattr(gcp_utils, "list_gcp_projects", lambda limit: [])
+  monkeypatch.setattr(gcp_utils, "check_express_eligibility", lambda: True)
+
+  confirms = iter([True, True])
+  monkeypatch.setattr(click, "confirm", lambda *a, **k: next(confirms))
+
+  prompts = iter(["2", "1"])
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: next(prompts))
+
+  monkeypatch.setattr(
+      gcp_utils,
+      "sign_up_express",
+      lambda location="us-central1": {
+          "api_key": "new-key",
+          "project_id": "new-proj",
+          "region": location,
+      },
+  )
+
+  monkeypatch.setattr(
+      _onboarding, "get_gcp_project_from_gcloud", lambda: "old-proj"
+  )
+
+  called = {}
+
+  def fake_run(cmd, **kwargs):
+    if cmd == ["gcloud", "config", "unset", "project"]:
+      called["unset"] = True
+      return subprocess.CompletedProcess(args=cmd, returncode=0)
+    raise ValueError(f"Unexpected command: {cmd}")
+
+  monkeypatch.setattr(subprocess, "run", fake_run)
+
+  auth_info = _onboarding.handle_login_with_google()
+  assert isinstance(auth_info, _onboarding.ExpressModeAuth)
+  assert auth_info.api_key == "new-key"
+  assert auth_info.project_id == "new-proj"
+  assert auth_info.region == "us-central1"
+  assert called.get("unset") is True
+
+
+def test_handle_login_with_google_option_3(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """User selects 3, aborts."""
+  monkeypatch.setattr(gcp_utils, "retrieve_express_project", lambda: None)
+  monkeypatch.setattr(gcp_utils, "list_gcp_projects", lambda limit: [])
+  monkeypatch.setattr(click, "prompt", lambda *a, **k: "3")
+  with pytest.raises(click.Abort):
+    _onboarding.handle_login_with_google()
+
+
+# prompt_str
+def test_prompt_str_non_empty(monkeypatch: pytest.MonkeyPatch) -> None:
+  """prompt_str should retry until a non-blank string is provided."""
+  responses = iter(["", " ", "valid"])
+  monkeypatch.setattr(click, "prompt", lambda *_a, **_k: next(responses))
+  assert _onboarding.prompt_str("dummy") == "valid"
+
+
+# gcloud fallback helpers
+def test_get_gcp_project_from_gcloud_fail(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """Failure of gcloud project lookup should return empty string."""
+  monkeypatch.setattr(
+      subprocess,
+      "run",
+      lambda *_a, **_k: (_ for _ in ()).throw(FileNotFoundError()),
+  )
+  assert _onboarding.get_gcp_project_from_gcloud() == ""
+
+
+def test_get_gcp_region_from_gcloud_fail(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+  """CalledProcessError should result in empty region string."""
+  monkeypatch.setattr(
+      subprocess,
+      "run",
+      lambda *_a, **_k: (_ for _ in ()).throw(
+          subprocess.CalledProcessError(1, "gcloud")
+      ),
+  )
+  assert _onboarding.get_gcp_region_from_gcloud() == ""