feat: Review suggestion - keeping cloud_run command and adding new command for docker environment

Author: raflFaisal

src/google/adk/cli/cli_deploy.py

@@ -19,10 +19,10 @@
 from .deployers.deployer_factory import DeployerFactory
 from .config.dockerfile_template import _DOCKERFILE_TEMPLATE
 
-def to_cloud_run(
+def run(
     *,
     agent_folder: str,
-    cloud_provider: str,
+    provider: str,
     project: Optional[str],
     region: Optional[str],
     service_name: str,
@@ -54,7 +54,7 @@ def to_cloud_run(
 
   Args:
     agent_folder: The folder (absolute path) containing the agent source code.
-    cloud_provider: Target deployment platform (gcp, local, etc).
+    provider: Target deployment platform (gcp, docker, etc).
     project: Google Cloud project id.
     region: Google Cloud region.
     service_name: The service name in Cloud Run.
@@ -118,13 +118,8 @@ def to_cloud_run(
           dockerfile_content,
       )
     click.echo(f'Creating Dockerfile complete: {dockerfile_path}')
-
-        # Deploy using the appropriate deployer
-    if cloud_provider is None:
-      cloud_provider = 'local'
-      
-    click.echo(f'Deploying to {cloud_provider}...')
-    deployer = DeployerFactory.get_deployer(cloud_provider)
+    click.echo(f'Deploying to {provider}...')
+    deployer = DeployerFactory.get_deployer(provider)
     deployer.deploy(
           agent_folder=agent_folder,
           temp_folder=temp_folder,
@@ -137,7 +132,7 @@ def to_cloud_run(
           verbosity=verbosity,
     )
 
-    click.echo(f'Deployment to {cloud_provider} complete.')
+    click.echo(f'Deployment to {provider} complete.')
 
   finally:
     click.echo(f'Cleaning up the temp folder: {temp_folder}')

src/google/adk/cli/cli_tools_click.py

@@ -91,6 +91,113 @@ def main():
   """Agent Development Kit CLI tools."""
   pass
 
+def add_common_deploy_options(command):
+    """Add common options to deploy subcommands."""
+    options = [
+      click.option(
+            "--service_name",
+            type=str,
+            default="adk-default-service-name",
+            help=(
+                "Optional. The service name to use in target environment (default:"
+                " 'adk-default-service-name')."
+            ),
+        ),
+        click.option(
+            "--env",
+            multiple=True,
+            help="Optional. Environment variables as multiple --env key=value pairs.",
+        ),
+        click.option(
+            "--provider-args",
+            multiple=True,
+            help="Optional. Provider-specific arguments as multiple --provider-args key=value pairs.",
+        ),
+        click.option(
+            "--app_name",
+            type=str,
+            default="",
+            help=(
+                "Optional. App name of the ADK API server (default: the folder name"
+                " of the AGENT source code)."
+            ),
+        ),
+        click.option(
+            "--port",
+            type=int,
+            default=8000,
+            help="Optional. The port of the ADK API server (default: 8000).",
+        ),
+        click.option(
+            "--trace_to_cloud",
+            is_flag=True,
+            show_default=True,
+            default=False,
+            help="Optional. Whether to enable cloud tracing for deployment.",
+        ),
+        click.option(
+            "--with_ui",
+            is_flag=True,
+            show_default=True,
+            default=False,
+            help=(
+                "Optional. Deploy ADK Web UI if set. (default: deploy ADK API server"
+                " only)"
+            ),
+        ),
+        click.option(
+            "--temp_folder",
+            type=str,
+            default=lambda: os.path.join(
+                tempfile.gettempdir(),
+                "deploy_src",
+                datetime.now().strftime("%Y%m%d_%H%M%S"),
+            ),
+            help=(
+                "Optional. Temp folder for the generated source files"
+                " (default: a timestamped folder in the system temp directory)."
+            ),
+        ),
+        click.option(
+            "--verbosity",
+            type=click.Choice(
+                ["debug", "info", "warning", "error", "critical"], case_sensitive=False
+            ),
+            default="WARNING",
+            help="Optional. Override the default verbosity level.",
+        ),
+        click.option(
+            "--session_db_url",
+            help=(
+                """Optional. The database URL to store the session.
+
+  - Use 'agentengine://<agent_engine_resource_id>' to connect to Agent Engine sessions.
+
+  - Use 'sqlite://<path_to_sqlite_file>' to connect to a SQLite DB.
+
+  - See https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls for more details on supported DB URLs."""
+            ),
+        ),
+        click.option(
+            "--adk_version",
+            type=str,
+            default=version.__version__,
+            show_default=True,
+            help=(
+                "Optional. The ADK version used in deployment. (default: the"
+                " version in the dev environment)"
+            ),
+        ),
+        click.argument(
+            "agent",
+            type=click.Path(
+                exists=True, dir_okay=True, file_okay=False, resolve_path=True
+            ),
+        ),
+    ]
+    for option in options:
+        command = option(command)
+    return command
 
 @main.group()
 def deploy():
@@ -617,26 +724,7 @@ def cli_api_server(
   server = uvicorn.Server(config)
   server.run()
 
-
-@deploy.command("cloud_run")
-@click.option(
-    "--cloud-provider",
-    type=str,
-    help=(
-        "Optional. Name of cloud provider where to deploy the agent. When absent,"
-        " default the agent will be deployed locally as a docker container."
-    ),
-)
-@click.option(
-    "--env",
-    multiple=True,
-    help="Optional. Environment variables as multiple --env key=value pairs.",
-)
-@click.option(
-    "--provider-args",
-    multiple=True,
-    help="Optional. Provider-specific arguments as multiple --provider-args key=value pairs.",
-)
+@deploy.command("cloud_run", cls=HelpfulCommand)
 @click.option(
     "--project",
     type=str,
@@ -653,99 +741,9 @@ def cli_api_server(
         " gcloud run deploy will prompt later."
     ),
 )
-@click.option(
-    "--service_name",
-    type=str,
-    default="adk-default-service-name",
-    help=(
-        "Optional. The service name to use in Cloud Run (default:"
-        " 'adk-default-service-name')."
-    ),
-)
-@click.option(
-    "--app_name",
-    type=str,
-    default="",
-    help=(
-        "Optional. App name of the ADK API server (default: the folder name"
-        " of the AGENT source code)."
-    ),
-)
-@click.option(
-    "--port",
-    type=int,
-    default=8000,
-    help="Optional. The port of the ADK API server (default: 8000).",
-)
-@click.option(
-    "--trace_to_cloud",
-    is_flag=True,
-    show_default=True,
-    default=False,
-    help="Optional. Whether to enable Cloud Trace for cloud run.",
-)
-@click.option(
-    "--with_ui",
-    is_flag=True,
-    show_default=True,
-    default=False,
-    help=(
-        "Optional. Deploy ADK Web UI if set. (default: deploy ADK API server"
-        " only)"
-    ),
-)
-@click.option(
-    "--temp_folder",
-    type=str,
-    default=os.path.join(
-        tempfile.gettempdir(),
-        "cloud_run_deploy_src",
-        datetime.now().strftime("%Y%m%d_%H%M%S"),
-    ),
-    help=(
-        "Optional. Temp folder for the generated Cloud Run source files"
-        " (default: a timestamped folder in the system temp directory)."
-    ),
-)
-@click.option(
-    "--verbosity",
-    type=click.Choice(
-        ["debug", "info", "warning", "error", "critical"], case_sensitive=False
-    ),
-    default="WARNING",
-    help="Optional. Override the default verbosity level.",
-)
-@click.option(
-    "--session_db_url",
-    help=(
-        """Optional. The database URL to store the session.
-
-  - Use 'agentengine://<agent_engine_resource_id>' to connect to Agent Engine sessions.
-
-  - Use 'sqlite://<path_to_sqlite_file>' to connect to a SQLite DB.
-
-  - See https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls for more details on supported DB URLs."""
-    ),
-)
-@click.argument(
-    "agent",
-    type=click.Path(
-        exists=True, dir_okay=True, file_okay=False, resolve_path=True
-    ),
-)
-@click.option(
-    "--adk_version",
-    type=str,
-    default=version.__version__,
-    show_default=True,
-    help=(
-        "Optional. The ADK version used in Cloud Run deployment. (default: the"
-        " version in the dev environment)"
-    ),
-)
-def cli_deploy_cloud_run(
+@add_common_deploy_options
+def cli_deploy_to_cloud_run(
     agent: str,
-    cloud_provider: Optional[str],
     project: Optional[str],
     region: Optional[str],
     service_name: str,
@@ -769,9 +767,9 @@ def cli_deploy_cloud_run(
     adk deploy cloud_run --project=[project] --region=[region] path/to/my_agent
   """
   try:
-    cli_deploy.to_cloud_run(
+    cli_deploy.run(
         agent_folder=agent,
-        cloud_provider=cloud_provider,
+        provider="gcp",
         project=project,
         region=region,
         service_name=service_name,
@@ -788,3 +786,47 @@ def cli_deploy_cloud_run(
     )
   except Exception as e:
     click.secho(f"Deploy failed: {e}", fg="red", err=True)
+
+@deploy.command("docker", cls=HelpfulCommand)
+@add_common_deploy_options
+def cli_deploy_docker(
+    agent: str,
+    service_name: str,
+    app_name: str,
+    temp_folder: str,
+    port: int,
+    trace_to_cloud: bool,
+    with_ui: bool,
+    verbosity: str,
+    session_db_url: str,
+    adk_version: str,
+    provider_args: Tuple[str],
+    env: Tuple[str],
+):
+    """Deploys an agent to Docker container.
+
+    AGENT: The path to the agent source code folder.
+
+    Example:
+        adk deploy docker path/to/my_agent
+    """
+    try:
+        cli_deploy.run(
+            agent_folder=agent,
+            project=None,
+            region=None,
+            provider="docker",
+            service_name=service_name,
+            app_name=app_name,
+            temp_folder=temp_folder,
+            port=port,
+            trace_to_cloud=trace_to_cloud,
+            with_ui=with_ui,
+            verbosity=verbosity,
+            session_db_url=session_db_url,
+            adk_version=adk_version,
+            provider_args=provider_args,
+            env=env,
+        )
+    except Exception as e:
+        click.secho(f"Deploy failed: {e}", fg="red", err=True)

src/google/adk/cli/deployers/deployer_factory.py

@@ -1,13 +1,13 @@
 from ..deployers.gcp_deployer import GCPDeployer
-from ..deployers.local_docker_deployer import LocalDockerDeployer
+from ..deployers.docker_deployer import DockerDeployer
 # Future deployers can be added here
 
 class DeployerFactory:
     @staticmethod
     def get_deployer(cloud_provider: str):
         """Returns the appropriate deployer based on the cloud provider."""
         deployers = {
-            'local': LocalDockerDeployer(),
+            'docker': DockerDeployer(),
             'gcp': GCPDeployer(),
             # Future providers: 'aws': AWSDeployer(), 'k8s': KubernetesDeployer()
         }

src/google/adk/cli/deployers/local_docker_deployer.py renamed to src/google/adk/cli/deployers/docker_deployer.py

@@ -4,7 +4,7 @@
 from ..deployers.base_deployer import Deployer
 import click
 
-class LocalDockerDeployer(Deployer):
+class DockerDeployer(Deployer):
     def deploy(self, 
                agent_folder: str, 
                temp_folder: str,