agent-starter-pack 0.15.7__py3-none-any.whl → 0.17.0__py3-none-any.whl

{src → agent_starter_pack}/base_template/{% if cookiecutter.cicd_runner == 'google_cloud_build' %}.cloudbuild{% else %}unused_.cloudbuild{% endif %}/staging.yaml

@@ -14,13 +14,13 @@
 
 steps:
 {%- if cookiecutter.data_ingestion %}
-  - name: "python:3.11-slim"
+  - name: "python:3.12-slim"
     id: deploy-data-ingestion-pipeline-staging
     entrypoint: bash
     args:
       - -c
       - |
-        cd data_ingestion && pip install uv==0.6.12 --user && cd data_ingestion_pipeline && \
+        cd data_ingestion && pip install uv==0.8.13 --user && cd data_ingestion_pipeline && \
         uv sync --locked && uv run python submit_pipeline.py
     env:
       - "PIPELINE_ROOT=${_PIPELINE_GCS_ROOT_STAGING}"
@@ -91,17 +91,17 @@ steps:
       - |
         echo $(gcloud auth print-identity-token -q) > id_token.txt
 {%- elif cookiecutter.deployment_target == 'agent_engine' %}
-  - name: "python:3.11-slim" 
+  - name: "python:3.12-slim"
     id: install-dependencies
     entrypoint: /bin/bash
     args:
       - "-c"
       - |
-        pip install uv==0.6.12 --user && uv sync --locked
+        pip install uv==0.8.13 --user && uv sync --locked
     env:
       - 'PATH=/usr/local/bin:/usr/bin:~/.local/bin'
 
-  - name: "python:3.11-slim"
+  - name: "python:3.12-slim"
     id: deploy-staging
     entrypoint: /bin/bash
     args:
@@ -111,7 +111,7 @@ steps:
         uv run {{cookiecutter.agent_directory}}/agent_engine_app.py \
           --project ${_STAGING_PROJECT_ID} \
           --location ${_REGION} \
-          --service-account ${_APP_SA_EMAIL_STAGING} \
+          --artifacts-bucket-name ${_LOGS_BUCKET_NAME_STAGING} \
           --set-env-vars="COMMIT_SHA=${COMMIT_SHA}{%- if cookiecutter.data_ingestion %}{%- if cookiecutter.datastore_type == "vertex_ai_search" %},DATA_STORE_ID=${_DATA_STORE_ID_STAGING},DATA_STORE_REGION=${_DATA_STORE_REGION}{%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %},VECTOR_SEARCH_INDEX=${_VECTOR_SEARCH_INDEX_STAGING},VECTOR_SEARCH_INDEX_ENDPOINT=${_VECTOR_SEARCH_INDEX_ENDPOINT_STAGING},VECTOR_SEARCH_BUCKET=${_VECTOR_SEARCH_BUCKET_STAGING}{%- endif %}{%- endif %}"
     env:
       - 'PATH=/usr/local/bin:/usr/bin:~/.local/bin'
@@ -127,31 +127,113 @@ steps:
 {%- endif %}
 
   # Load Testing
-  - name: "python:3.11-slim"
+{%- if cookiecutter.deployment_target == 'cloud_run' and cookiecutter.agent_name == 'adk_live' %}
+  - name: "europe-west4-docker.pkg.dev/production-ai-template/starter-pack/e2e-tests"
+    id: load_test
+    entrypoint: /bin/bash
+    args:
+      - "-c"
+      - |
+        # Install load test dependencies
+        pip install locust==2.31.1 websockets
+
+        # Install Cloud Run proxy component
+        apt-get update && apt-get install -y google-cloud-cli-cloud-run-proxy
+
+        # Start Cloud Run proxy in background
+        gcloud run services proxy {{cookiecutter.project_name}} \
+        --port=8080 \
+        --region ${_REGION} \
+        --project ${_STAGING_PROJECT_ID} \
+        --quiet &
+        _PROXY_PID=$$!
+
+        # Wait for proxy to be ready
+        echo "Waiting for proxy to start..."
+        sleep 10
+
+        # Run load test and capture exit code
+        locust -f tests/load_test/load_test.py \
+        --headless \
+        -H http://127.0.0.1:8080 \
+        -t 30s -u 2 -r 2 \
+        --csv=tests/load_test/.results/results \
+        --html=tests/load_test/.results/report.html
+        _LOAD_TEST_EXIT_CODE=$$?
+
+        # Clean up proxy
+        kill $$_PROXY_PID || true
+
+        # Exit with load test result to fail build if tests failed
+        exit $$_LOAD_TEST_EXIT_CODE
+{%- elif cookiecutter.deployment_target == 'cloud_run' %}
+  - name: "python:3.12-slim"
     id: load_test
     entrypoint: /bin/bash
     args:
       - "-c"
       - |
-{%- if cookiecutter.deployment_target == 'cloud_run' %}
         export _ID_TOKEN=$(cat id_token.txt)
         export _STAGING_URL=$(cat staging_url.txt)
-{%- elif cookiecutter.deployment_target == 'agent_engine' %}
-        export _AUTH_TOKEN=$(cat auth_token.txt)
-{%- endif %}
         pip install locust==2.31.1 --user
         locust -f tests/load_test/load_test.py \
         --headless \
-{%- if cookiecutter.deployment_target == 'cloud_run' %}
         -H $$_STAGING_URL \
         -t 30s -u 10 -r 0.5 \
+        --csv=tests/load_test/.results/results \
+        --html=tests/load_test/.results/report.html
+    env:
+      - 'PATH=/usr/local/bin:/usr/bin:~/.local/bin'
+{%- elif cookiecutter.deployment_target == 'agent_engine' and cookiecutter.is_adk_live %}
+  - name: "python:3.12-slim"
+    id: load_test
+    entrypoint: /bin/bash
+    args:
+      - "-c"
+      - |
+        # Start expose app in remote mode (uses deployment_metadata.json by default)
+        uv run python -m {{cookiecutter.agent_directory}}.utils.expose_app --mode remote &
+        EXPOSE_PID=$$!
+
+        # Wait for expose app to be ready
+        sleep 10
+
+        # Run load test against local expose app
+        uv run --with locust==2.31.1 --with websockets locust -f tests/load_test/load_test.py \
+        -H http://127.0.0.1:8000 \
+        --headless \
+        -t 30s -u 2 -r 1 \
+        --csv=tests/load_test/.results/results \
+        --html=tests/load_test/.results/report.html
+        LOCUST_EXIT_CODE=$$?
+
+        # Stop expose app
+        kill $$EXPOSE_PID
+
+        # Exit with error if locust test failed
+        if [ $$LOCUST_EXIT_CODE -ne 0 ]; then
+          echo "Load test failed with exit code $$LOCUST_EXIT_CODE"
+          exit $$LOCUST_EXIT_CODE
+        fi
+    env:
+      - 'PATH=/usr/local/bin:/usr/bin:~/.local/bin'
 {%- elif cookiecutter.deployment_target == 'agent_engine' %}
+  - name: "python:3.12-slim"
+    id: load_test
+    entrypoint: /bin/bash
+    args:
+      - "-c"
+      - |
+        export _AUTH_TOKEN=$(cat auth_token.txt)
+        pip install locust==2.31.1 --user
+        locust -f tests/load_test/load_test.py \
+        --headless \
         -t 30s -u 2 -r 0.5 \
-{%- endif %}
         --csv=tests/load_test/.results/results \
         --html=tests/load_test/.results/report.html
     env:
       - 'PATH=/usr/local/bin:/usr/bin:~/.local/bin'
+{%- endif %}
 
   # Export Load Test Results to GCS
   - name: gcr.io/cloud-builders/gcloud

{src → agent_starter_pack}/base_template/{{cookiecutter.agent_directory}}/utils/tracing.py

@@ -86,7 +86,7 @@ class CloudTraceLoggingSpanExporter(CloudTraceSpanExporter):
                 print(span_dict)
 
             # Log the span data to Google Cloud Logging
-{%- if "adk" in cookiecutter.tags %}
+{%- if cookiecutter.is_adk %}
             self.logger.log_struct(
                 span_dict,
                 labels={

{src → agent_starter_pack}/base_template/{{cookiecutter.agent_directory}}/utils/typing.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-{%- if "adk" in cookiecutter.tags %}
+{%- if cookiecutter.is_adk %}
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 import uuid
 from typing import (
@@ -57,7 +57,7 @@ from pydantic import (
 {%- endif %}
 
 
-{%- if "adk" in cookiecutter.tags %}
+{%- if cookiecutter.is_adk %}
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 
 
@@ -103,7 +103,7 @@ class Feedback(BaseModel):
 
     score: int | float
     text: str | None = ""
-{%- if "adk" in cookiecutter.tags %}
+{%- if cookiecutter.is_adk %}
     invocation_id: str
 {%- else %}
     run_id: str
@@ -111,7 +111,7 @@ class Feedback(BaseModel):
     log_type: Literal["feedback"] = "feedback"
     service_name: Literal["{{cookiecutter.project_name}}"] = "{{cookiecutter.project_name}}"
     user_id: str = ""
-{% if "adk" not in cookiecutter.tags %}
+{% if not cookiecutter.is_adk %}
 
 def ensure_valid_config(config: RunnableConfig | None) -> RunnableConfig:
     """Ensures a valid RunnableConfig by setting defaults for missing fields."""

{src → agent_starter_pack}/cli/commands/setup_cicd.py

@@ -24,7 +24,7 @@ import backoff
 import click
 from rich.console import Console
 
-from src.cli.utils.cicd import (
+from agent_starter_pack.cli.utils.cicd import (
     ProjectConfig,
     create_github_connection,
     handle_github_authentication,

{src → agent_starter_pack}/cli/main.py

@@ -49,8 +49,8 @@ def print_version(ctx: click.Context, param: click.Parameter, value: bool) -> No
     help="Show the version and exit.",
 )
 def cli() -> None:
-    # Check for updates at startup (skip if --agent-garden or -ag is used)
-    if "--agent-garden" not in sys.argv and "-ag" not in sys.argv:
+    # Check for updates at startup (skip if --agent-garden, -ag, or --locked is used)
+    if not any(flag in sys.argv for flag in ("--agent-garden", "-ag", "--locked")):
         display_update_message()
 
 

{src → agent_starter_pack}/cli/utils/gcp.py

@@ -34,7 +34,7 @@ from google.cloud.aiplatform_v1beta1.types.prediction_service import (
 from rich.console import Console
 from rich.prompt import Confirm
 
-from src.cli.utils.version import PACKAGE_NAME, get_current_version
+from agent_starter_pack.cli.utils.version import PACKAGE_NAME, get_current_version
 
 console = Console()
 

{src → agent_starter_pack}/cli/utils/remote_template.py

@@ -167,15 +167,18 @@ def check_and_execute_with_version_lock(
 
         # Add version lock specific parameters and handle remote URL replacement
         if original_agent_spec:
-            # Replace remote agent spec with local path
-            modified_args = []
-            for arg in original_args:
-                if arg == original_agent_spec:
-                    # Replace remote URL with local template directory
-                    modified_args.append(f"local@{template_dir}")
-                else:
-                    modified_args.append(arg)
-            original_args = modified_args
+            # Check if --agent flag exists in original args
+            agent_flag_exists = "--agent" in original_args or "-a" in original_args
+
+            if agent_flag_exists:
+                # Replace remote agent spec with local path
+                original_args = [
+                    f"local@{template_dir}" if arg == original_agent_spec else arg
+                    for arg in original_args
+                ]
+            else:
+                # Agent was selected interactively, add --agent flag
+                original_args.extend(["--agent", f"local@{template_dir}"])
 
         # Add version lock flags only for ASP versions 0.14.1 and above
         if pkg_version.parse(version) > pkg_version.parse("0.14.1"):

{src → agent_starter_pack}/cli/utils/template.py

@@ -26,7 +26,7 @@ from cookiecutter.main import cookiecutter
 from rich.console import Console
 from rich.prompt import IntPrompt, Prompt
 
-from src.cli.utils.version import get_current_version
+from agent_starter_pack.cli.utils.version import get_current_version
 
 from .datastores import DATASTORES
 from .remote_template import (
@@ -112,14 +112,14 @@ def get_available_agents(deployment_target: str | None = None) -> dict:
     # Define priority agents that should appear first
     PRIORITY_AGENTS = [
         "adk_base",
-        "adk_gemini_fullstack",
+        "adk_live",
         "agentic_rag",
         "langgraph_base_react",
     ]
 
     agents_list = []
     priority_agents_dict = dict.fromkeys(PRIORITY_AGENTS)  # Track priority agents
-    agents_dir = pathlib.Path(__file__).parent.parent.parent.parent / "agents"
+    agents_dir = pathlib.Path(__file__).parent.parent.parent / "agents"
 
     for agent_dir in agents_dir.iterdir():
         if agent_dir.is_dir() and not agent_dir.name.startswith("__"):
@@ -191,7 +191,7 @@ def get_deployment_targets(
         config = remote_config
     else:
         template_path = (
-            pathlib.Path(__file__).parent.parent.parent.parent
+            pathlib.Path(__file__).parent.parent.parent
             / "agents"
             / agent_name
             / ".template"
@@ -309,7 +309,7 @@ def prompt_datastore_selection(
 
     # Otherwise, proceed with normal flow
     template_path = (
-        pathlib.Path(__file__).parent.parent.parent.parent
+        pathlib.Path(__file__).parent.parent.parent
         / "agents"
         / agent_name
         / ".template"
@@ -418,7 +418,7 @@ def prompt_cicd_runner_selection() -> str:
 
 def get_template_path(agent_name: str, debug: bool = False) -> pathlib.Path:
     """Get the absolute path to the agent template directory."""
-    current_dir = pathlib.Path(__file__).parent.parent.parent.parent
+    current_dir = pathlib.Path(__file__).parent.parent.parent
     template_path = current_dir / "agents" / agent_name / ".template"
     if debug:
         logging.debug(f"Looking for template in: {template_path}")
@@ -526,9 +526,7 @@ def process_template(
         # For remote templates, determine the base template
         base_template_name = get_base_template_name(remote_config or {})
         agent_path = (
-            pathlib.Path(__file__).parent.parent.parent.parent
-            / "agents"
-            / base_template_name
+            pathlib.Path(__file__).parent.parent.parent / "agents" / base_template_name
         )
         logging.debug(f"Remote template using base: {base_template_name}")
     else:
@@ -740,6 +738,8 @@ def process_template(
                 ),
                 "settings": settings,
                 "tags": tags,
+                "is_adk": "adk" in tags,
+                "is_adk_live": "adk_live" in tags,
                 "deployment_target": deployment_target or "",
                 "cicd_runner": cicd_runner or "google_cloud_build",
                 "session_type": session_type or "",
@@ -756,7 +756,12 @@ def process_template(
                 "_copy_without_render": [
                     "*.ipynb",  # Don't render notebooks
                     "*.json",  # Don't render JSON files
-                    "frontend/*",  # Don't render frontend directory
+                    "*.tsx",  # Don't render TypeScript React files
+                    "*.ts",  # Don't render TypeScript files
+                    "*.jsx",  # Don't render JavaScript React files
+                    "*.js",  # Don't render JavaScript files
+                    "*.css",  # Don't render CSS files
+                    "frontend/**/*",  # Don't render frontend directory recursively
                     "notebooks/*",  # Don't render notebooks directory
                     ".git/*",  # Don't render git directory
                     "__pycache__/*",  # Don't render cache
@@ -1069,8 +1074,7 @@ def process_template(
             elif deployment_target:
                 # For local templates, use the existing logic
                 lock_path = (
-                    pathlib.Path(__file__).parent.parent.parent.parent
-                    / "src"
+                    pathlib.Path(__file__).parent.parent.parent
                     / "resources"
                     / "locks"
                     / f"uv-{agent_name}-{deployment_target}.lock"
@@ -1109,12 +1113,12 @@ def should_exclude_path(
     path: pathlib.Path, agent_name: str, agent_directory: str = "app"
 ) -> bool:
     """Determine if a path should be excluded based on the agent type."""
-    if agent_name == "live_api":
-        # Exclude the unit test utils folder and agent utils folder for live_api
+    if agent_name == "adk_live":
+        # Exclude the unit test utils folder and agent utils folder for adk_live
         if "tests/unit/test_utils" in str(path) or f"{agent_directory}/utils" in str(
             path
         ):
-            logging.debug(f"Excluding path for live_api: {path}")
+            logging.debug(f"Excluding path for adk_live: {path}")
             return True
     return False
 

agent_starter_pack/deployment_targets/agent_engine/deployment/terraform/{% if not cookiecutter.is_adk_live %}service.tf{% else %}unused_service.tf{% endif %}

@@ -0,0 +1,82 @@
+# Copyright 2025 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.
+
+# Get project information to access the project number
+data "google_project" "project" {
+  for_each = local.deploy_project_ids
+
+  project_id = local.deploy_project_ids[each.key]
+}
+
+resource "google_vertex_ai_reasoning_engine" "app_staging" {
+  display_name = var.project_name
+  description  = "Agent deployed via Terraform"
+  region       = var.region
+  project      = var.staging_project_id
+
+  spec {
+    service_account = google_service_account.app_sa["staging"].email
+
+    package_spec {
+      # IMPORTANT: This Python version must match the version used in CI/CD pipelines
+      # for pickling compatibility. Mismatched versions will cause deserialization errors.
+      python_version        = "3.12"
+      pickle_object_gcs_uri = "gs://agent-starter-pack/dummy/agent_engine.pkl"
+      dependency_files_gcs_uri = "gs://agent-starter-pack/dummy/dependencies.tar.gz"
+      requirements_gcs_uri  = "gs://agent-starter-pack/dummy/requirements.txt"
+    }
+  }
+
+  # This lifecycle block prevents Terraform from overwriting the spec when it's
+  # updated by Agent Engine deployments outside of Terraform (e.g., via CI/CD pipelines)
+  lifecycle {
+    ignore_changes = [
+      spec,
+    ]
+  }
+
+  # Make dependencies conditional to avoid errors.
+  depends_on = [google_project_service.deploy_project_services]
+}
+
+resource "google_vertex_ai_reasoning_engine" "app_prod" {
+  display_name = var.project_name
+  description  = "Agent deployed via Terraform"
+  region       = var.region
+  project      = var.prod_project_id
+
+  spec {
+    service_account = google_service_account.app_sa["prod"].email
+
+    package_spec {
+      # IMPORTANT: This Python version must match the version used in CI/CD pipelines
+      # for pickling compatibility. Mismatched versions will cause deserialization errors.
+      python_version        = "3.12"
+      pickle_object_gcs_uri = "gs://agent-starter-pack/dummy/agent_engine.pkl"
+      dependency_files_gcs_uri = "gs://agent-starter-pack/dummy/dependencies.tar.gz"
+      requirements_gcs_uri  = "gs://agent-starter-pack/dummy/requirements.txt"
+    }
+  }
+
+  # This lifecycle block prevents Terraform from overwriting the spec when it's
+  # updated by Agent Engine deployments outside of Terraform (e.g., via CI/CD pipelines)
+  lifecycle {
+    ignore_changes = [
+      spec,
+    ]
+  }
+
+  # Make dependencies conditional to avoid errors.
+  depends_on = [google_project_service.deploy_project_services]
+}