github-featured/google--adk-python
2
0
Fork 0
Code Issues Pull Requests Actions 8 Deployments Models Agent Notes Packages Projects Releases Wiki Activity

fix(cli): respect ignore files in adk deploy commands

Browse Source 
Merge https://github.com/google/adk-python/pull/4187

**Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.**

### Link to Issue or Description of Change

**1. Link to an existing issue (if applicable):**

- Closes: #4183

**Problem:**
The `adk deploy` commands (`cloud_run`, `agent_engine`, `gke`) were not properly respecting `.gitignore`, `.gcloudignore`, or `.ae_ignore` files. This caused all files in the source directory, including large or sensitive ones like `venv/`, `.git/`, and `.env`, to be copied to the temporary staging directory and subsequently uploaded to hosted environments.

**Solution:**
- Implemented a unified `_get_ignore_patterns_func` helper in `src/google/adk/cli/cli_deploy.py` that reads and combines patterns from `.gitignore`, `.gcloudignore`, and `.ae_ignore`.
- Updated `to_cloud_run`, `to_agent_engine`, and `to_gke` to use this helper as an ignore filter in `shutil.copytree`.
- This ensures that only the files intended by the user are staged and deployed.

### Testing Plan

**Unit Tests:**

- [x] I have added or updated unit tests for my change.
- [x] All unit tests pass locally.

Summary of `pytest` results:
```text
tests/unittests/cli/utils/test_cli_deploy_ignore.py ... [100%]
3 passed in 2.20s
```

**Manual End-to-End (E2E) Tests:**

Verified the fix by following these steps:

1.  **Setup:** Created a dummy agent directory with a `.gitignore` file.
    ```bash
    mkdir -p verify_agent
    touch verify_agent/agent.py verify_agent/__init__.py
    touch verify_agent/ignored_file.txt
    echo "ignored_file.txt" > verify_agent/.gitignore
    ```
2.  **Execution:** Ran the deploy command pointing to a local temp folder.
    ```bash
    adk deploy cloud_run --temp_folder ./debug_staged_out ./verify_agent
    ```
3.  **Verification:** Temporarily disabled the `shutil.rmtree` cleanup in code to inspect `./debug_staged_out`.
4.  **Result:** Confirmed that `agent.py` and `.gitignore` were present, but `ignored_file.txt` was correctly excluded from the staging area.

### Checklist

- [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document.
- [x] I have performed a self-review of my own code.
- [x] I have commented my code, particularly in hard-to-understand areas.
- [x] I have added tests that prove my fix is effective or that my feature works.
- [x] New and existing unit tests pass locally with my changes.
- [x] I have manually tested my changes end-to-end.
- [x] Any dependent changes have been merged and published in downstream modules.

Co-authored-by: Haran Rajkumar <haranrk@google.com>
COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/4187 from kotaitos:fix/issue-4183-ignore-files 15f6d6218aa8f6a204a733c871bc661b317bf99a
PiperOrigin-RevId: 934458832
This commit is contained in:
Kotaro Saito
2026-06-18 11:21:42 -07:00
committed by Copybara-Service
parent a012bb7542
commit ee79e7129c
2 changed files with 241 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/google/adk/cli/cli_deploy.py
+34 -10
View File
@@ -603,6 +603,34 @@ def _get_service_option_by_adk_version(
return ' '.join(options)
def _get_ignore_patterns_func(agent_folder: str):
"""Returns a shutil.ignore_patterns function with combined patterns from .gitignore, .gcloudignore and .ae_ignore."""
patterns = set()
for filename in ['.gitignore', '.gcloudignore', '.ae_ignore']:
filepath = os.path.join(agent_folder, filename)
if os.path.exists(filepath):
click.echo(f'Reading ignore patterns from {filename}...')
try:
with open(filepath, 'r') as f:
for line in f:
line = line.strip()
if line and not line.startswith('#'):
# If it ends with /, remove it for fnmatch compatibility
if line.endswith('/'):
line = line[:-1]
# Strip leading / from root-anchored patterns; shutil.ignore_patterns
# matches basenames via fnmatch, so '/venv' would match nothing.
if line.startswith('/'):
line = line[1:]
if line:
patterns.add(line)
except Exception as e:
click.secho(f'Warning: Failed to read {filename}: {e}', fg='yellow')
return shutil.ignore_patterns(*patterns)
def to_cloud_run(
*,
agent_folder: str,
@@ -679,7 +707,8 @@ def to_cloud_run(
# copy agent source code
click.echo('Copying agent source code...')
agent_src_path = os.path.join(temp_folder, 'agents', app_name)
shutil.copytree(agent_folder, agent_src_path)
ignore_func = _get_ignore_patterns_func(agent_folder)
shutil.copytree(agent_folder, agent_src_path, ignore=ignore_func)
requirements_txt_path = os.path.join(agent_src_path, 'requirements.txt')
install_agent_deps = (
f'RUN pip install -r "/app/agents/{app_name}/requirements.txt"'
@@ -943,18 +972,12 @@ def to_agent_engine(
shutil.rmtree(temp_folder_path)
try:
ignore_patterns = None
ae_ignore_path = os.path.join(agent_folder, '.ae_ignore')
if os.path.exists(ae_ignore_path):
click.echo(f'Ignoring files matching the patterns in {ae_ignore_path}')
with open(ae_ignore_path, 'r') as f:
patterns = [pattern.strip() for pattern in f.readlines()]
ignore_patterns = shutil.ignore_patterns(*patterns)
ignore_func = _get_ignore_patterns_func(agent_folder)
click.echo('Copying agent source code...')
shutil.copytree(
agent_folder,
agent_src_path,
ignore=ignore_patterns,
ignore=ignore_func,
dirs_exist_ok=True,
)
os.chdir(temp_folder_path)
@@ -1302,7 +1325,8 @@ def to_gke(
# copy agent source code
click.echo(' - Copying agent source code...')
agent_src_path = os.path.join(temp_folder, 'agents', app_name)
shutil.copytree(agent_folder, agent_src_path)
ignore_func = _get_ignore_patterns_func(agent_folder)
shutil.copytree(agent_folder, agent_src_path, ignore=ignore_func)
requirements_txt_path = os.path.join(agent_src_path, 'requirements.txt')
install_agent_deps = (
f'RUN pip install -r "/app/agents/{app_name}/requirements.txt"'
tests/unittests/cli/utils/test_cli_deploy_ignore.py
+207
View File
@@ -0,0 +1,207 @@
# 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 ignore file support in cli_deploy."""
from __future__ import annotations
import os
from pathlib import Path
import shutil
import subprocess
from unittest import mock
import click
import pytest
import src.google.adk.cli.cli_deploy as cli_deploy
@pytest.fixture(autouse=True)
def _mute_click(monkeypatch: pytest.MonkeyPatch) -> None:
"""Suppress click.echo to keep test output clean."""
monkeypatch.setattr(click, "echo", lambda *_a, **_k: None)
monkeypatch.setattr(click, "secho", lambda *_a, **_k: None)
def test_to_cloud_run_respects_ignore_files(
monkeypatch: pytest.MonkeyPatch,
tmp_path: Path,
) -> None:
"""Test that to_cloud_run respects .gitignore and .gcloudignore."""
agent_dir = tmp_path / "agent"
agent_dir.mkdir()
(agent_dir / "agent.py").write_text("# agent")
(agent_dir / "__init__.py").write_text("")
(agent_dir / "ignored_by_git.txt").write_text("ignored")
(agent_dir / "ignored_by_gcloud.txt").write_text("ignored")
(agent_dir / "ignored_rooted.txt").write_text("ignored")
(agent_dir / "not_ignored.txt").write_text("keep")
# Use a root-anchored pattern (leading slash) to ensure it is honored.
(agent_dir / ".gitignore").write_text(
"ignored_by_git.txt\n/ignored_rooted.txt\n"
)
(agent_dir / ".gcloudignore").write_text("ignored_by_gcloud.txt\n")
temp_deploy_dir = tmp_path / "temp_deploy"
# Mock subprocess.run to avoid actual gcloud call
monkeypatch.setattr(subprocess, "run", mock.Mock())
# Mock shutil.rmtree to keep the temp folder for verification
monkeypatch.setattr(
shutil,
"rmtree",
lambda path, **kwargs: None
if "temp_deploy" in str(path)
else shutil.rmtree(path, **kwargs),
)
cli_deploy.to_cloud_run(
agent_folder=str(agent_dir),
project="proj",
region="us-central1",
service_name="svc",
app_name="app",
temp_folder=str(temp_deploy_dir),
port=8080,
trace_to_cloud=False,
otel_to_cloud=False,
with_ui=False,
log_level="info",
verbosity="info",
adk_version="1.0.0",
)
agent_src_path = temp_deploy_dir / "agents" / "app"
assert (agent_src_path / "agent.py").exists()
assert (agent_src_path / "not_ignored.txt").exists()
# These should be ignored
assert not (
agent_src_path / "ignored_by_git.txt"
).exists(), "Should respect .gitignore"
assert not (
agent_src_path / "ignored_by_gcloud.txt"
).exists(), "Should respect .gcloudignore"
assert not (
agent_src_path / "ignored_rooted.txt"
).exists(), "Should respect root-anchored (leading slash) patterns"
def test_to_agent_engine_respects_multiple_ignore_files(
monkeypatch: pytest.MonkeyPatch,
tmp_path: Path,
) -> None:
"""Test that to_agent_engine respects .gitignore, .gcloudignore and .ae_ignore."""
# We need to be in the project dir for to_agent_engine
project_dir = tmp_path / "project"
project_dir.mkdir()
monkeypatch.chdir(project_dir)
agent_dir = project_dir / "my_agent"
agent_dir.mkdir()
(agent_dir / "agent.py").write_text("root_agent = None")
(agent_dir / "__init__.py").write_text("from . import agent")
(agent_dir / "ignored_by_git.txt").write_text("ignored")
(agent_dir / "ignored_by_ae.txt").write_text("ignored")
(agent_dir / ".gitignore").write_text("ignored_by_git.txt\n")
(agent_dir / ".ae_ignore").write_text("ignored_by_ae.txt\n")
# Mock vertexai.Client and other things to avoid network/complex setup
monkeypatch.setattr("vertexai.Client", mock.Mock())
# Mock shutil.rmtree to keep the temp folder for verification
original_rmtree = shutil.rmtree
def mock_rmtree(path, **kwargs):
if "_tmp" in str(path):
return None
return original_rmtree(path, **kwargs)
monkeypatch.setattr(shutil, "rmtree", mock_rmtree)
cli_deploy.to_agent_engine(
agent_folder=str(agent_dir),
staging_bucket="gs://test",
adk_app="adk_app",
)
# Find the temp folder created by to_agent_engine
temp_folders = [
d for d in project_dir.iterdir() if d.is_dir() and "_tmp" in d.name
]
assert len(temp_folders) == 1
agent_src_path = temp_folders[0]
copied_agent_dir = agent_src_path / "agents" / "my_agent"
assert (copied_agent_dir / "agent.py").exists()
assert not (
copied_agent_dir / "ignored_by_git.txt"
).exists(), "Should respect .gitignore"
assert not (
copied_agent_dir / "ignored_by_ae.txt"
).exists(), "Should respect .ae_ignore"
def test_to_gke_respects_ignore_files(
monkeypatch: pytest.MonkeyPatch,
tmp_path: Path,
) -> None:
"""Test that to_gke respects ignore files."""
agent_dir = tmp_path / "agent"
agent_dir.mkdir()
(agent_dir / "agent.py").write_text("# agent")
(agent_dir / "__init__.py").write_text("")
(agent_dir / "ignored.txt").write_text("ignored")
(agent_dir / ".gitignore").write_text("ignored.txt\n")
temp_deploy_dir = tmp_path / "temp_deploy"
# Mock subprocess.run to avoid actual gcloud call
mock_run = mock.Mock()
mock_run.return_value.stdout = "deployment created"
monkeypatch.setattr(subprocess, "run", mock_run)
# Mock shutil.rmtree to keep the temp folder for verification
monkeypatch.setattr(
shutil,
"rmtree",
lambda path, **kwargs: None
if "temp_deploy" in str(path)
else shutil.rmtree(path, **kwargs),
)
cli_deploy.to_gke(
agent_folder=str(agent_dir),
project="proj",
region="us-central1",
cluster_name="cluster",
service_name="svc",
app_name="app",
temp_folder=str(temp_deploy_dir),
port=8080,
trace_to_cloud=False,
otel_to_cloud=False,
with_ui=False,
log_level="info",
adk_version="1.0.0",
)
agent_src_path = temp_deploy_dir / "agents" / "app"
assert (agent_src_path / "agent.py").exists()
assert not (
agent_src_path / "ignored.txt"
).exists(), "Should respect .gitignore"