supervaizer 0.9.8__py3-none-any.whl → 0.10.1__py3-none-any.whl

supervaizer/deploy/cli.py

@@ -0,0 +1,296 @@
+# Copyright (c) 2024-2025 Alain Prasquier - Supervaize.com. All rights reserved.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, you can obtain one at
+# https://mozilla.org/MPL/2.0/.
+
+"""
+Deployment CLI Commands
+
+This module contains the main CLI commands for the deploy subcommand.
+"""
+
+import typer
+from pathlib import Path
+from rich.console import Console
+
+from supervaizer.deploy.commands.plan import plan_deployment
+from supervaizer.deploy.commands.up import deploy_up
+from supervaizer.deploy.commands.down import deploy_down
+from supervaizer.deploy.commands.status import deploy_status
+from supervaizer.deploy.commands.local import local_docker
+from supervaizer.deploy.commands.clean import (
+    clean_deployment,
+    clean_docker_artifacts,
+    clean_state_only,
+)
+
+console = Console()
+
+# Create the deploy subcommand
+deploy_app = typer.Typer(
+    name="deploy",
+    help="Deploy Supervaizer agents to cloud platforms. Python dependencies must be managed in pyproject.toml file.",
+    no_args_is_help=True,
+)
+
+# Common parameters
+platform_option = typer.Option(
+    None,
+    "--platform",
+    "-p",
+    help="Target platform (cloud-run|aws-app-runner|do-app-platform)",
+)
+name_option = typer.Option(
+    ...,
+    "--name",
+    "-n",
+    help="Service name. Required for local command.",
+    prompt="Service name (e.g. my-service)",
+)
+env_option = typer.Option("dev", "--env", "-e", help="Environment (dev|staging|prod)")
+region_option = typer.Option(None, "--region", "-r", help="Provider region")
+project_id_option = typer.Option(
+    None, "--project-id", help="GCP project / AWS account / DO project"
+)
+verbose_option = typer.Option(False, "--verbose", "-v", help="Show detailed output")
+
+# Additional parameters for specific commands
+image_option = typer.Option(None, "--image", help="Container image (registry/repo:tag)")
+port_option = typer.Option(8000, "--port", help="Application port")
+generate_api_key_option = typer.Option(
+    False, "--generate-api-key", help="Generate secure API key"
+)
+generate_rsa_option = typer.Option(
+    False, "--generate-rsa", help="Generate RSA private key"
+)
+yes_option = typer.Option(False, "--yes", "-y", help="Non-interactive mode")
+no_rollback_option = typer.Option(False, "--no-rollback", help="Keep failed revision")
+timeout_option = typer.Option(300, "--timeout", help="Deployment timeout in seconds")
+docker_files_only_option = typer.Option(
+    False, "--docker-files-only", help="Only generate Docker files without running them"
+)
+
+controller_file_option = typer.Option(
+    "supervaizer_control.py",
+    "--controller-file",
+    help="Controller file name (default: supervaizer_control.py)",
+)
+
+# Clean command options
+force_option = typer.Option(False, "--force", "-f", help="Skip confirmation prompts")
+verbose_option_clean = typer.Option(
+    False, "--verbose", "-v", help="Show detailed output"
+)
+
+
+def _check_pyproject_toml() -> Path:
+    """Check if pyproject.toml exists in current directory or parent directories."""
+    current_dir = Path.cwd()
+
+    # Check current directory first
+    pyproject_path = current_dir / "pyproject.toml"
+    if pyproject_path.exists():
+        return current_dir
+
+    # Check parent directories up to 3 levels
+    for _ in range(3):
+        current_dir = current_dir.parent
+        pyproject_path = current_dir / "pyproject.toml"
+        if pyproject_path.exists():
+            return current_dir
+
+    # If not found, show help and exit
+    _show_pyproject_toml_help()
+    raise typer.Exit(1)
+
+
+def _show_pyproject_toml_help() -> None:
+    """Show help message when pyproject.toml is not found."""
+    console.print("[bold red]Error:[/] pyproject.toml file not found")
+    console.print(
+        "The supervaizer deploy command must be run from a directory containing pyproject.toml"
+    )
+    console.print("or from a subdirectory of such a directory.")
+    console.print("\n[bold]Current directory:[/] " + str(Path.cwd()))
+    console.print("\n[bold]Please ensure:[/]")
+    console.print("  • You are in the correct project directory")
+    console.print("  • The pyproject.toml file exists in the project root")
+    console.print("  • Python dependencies are properly defined in pyproject.toml")
+    console.print("\n[bold]Available deploy commands:[/]")
+    console.print(
+        "  • [bold]supervaizer deploy local[/] - Test deployment locally using Docker Compose"
+    )
+    console.print("  • [bold]supervaizer deploy up[/] - Deploy or update the service")
+    console.print(
+        "  • [bold]supervaizer deploy down[/] - Destroy the service and cleanup resources"
+    )
+    console.print(
+        "  • [bold]supervaizer deploy status[/] - Show deployment status and health information"
+    )
+    console.print(
+        "  • [bold]supervaizer deploy plan[/] - Plan deployment changes without applying them"
+    )
+    console.print(
+        "  • [bold]supervaizer deploy clean[/] - Clean up deployment artifacts and generated files"
+    )
+    console.print(
+        "\nUse [bold]supervaizer deploy <command> --help[/] for more information about each command."
+    )
+
+
+@deploy_app.callback()
+def deploy_callback() -> None:
+    """Deploy Supervaizer agents to cloud platforms."""
+    # This callback is called when no subcommand is provided
+    # The no_args_is_help=True will automatically show help
+    pass
+
+
+def _check_platform_required(platform: str, command_name: str) -> None:
+    """Check if platform is provided and show helpful error if not."""
+    if platform is None:
+        console.print("[bold red]Error:[/] --platform is required")
+        console.print(
+            f"Use [bold]supervaizer deploy {command_name} --help[/] for more information"
+        )
+        raise typer.Exit(1)
+
+
+@deploy_app.command(no_args_is_help=True)
+def plan(
+    platform: str = platform_option,
+    name: str = name_option,
+    env: str = env_option,
+    region: str = region_option,
+    project_id: str = project_id_option,
+    verbose: bool = verbose_option,
+) -> None:
+    """Plan deployment changes without applying them."""
+    _check_platform_required(platform, "plan")
+    source_dir = _check_pyproject_toml()
+    plan_deployment(platform, name, env, region, project_id, verbose, source_dir)
+
+
+@deploy_app.command(no_args_is_help=True)
+def up(
+    platform: str = platform_option,
+    name: str = name_option,
+    env: str = env_option,
+    region: str = region_option,
+    project_id: str = project_id_option,
+    image: str = image_option,
+    port: int = port_option,
+    generate_api_key: bool = generate_api_key_option,
+    generate_rsa: bool = generate_rsa_option,
+    yes: bool = yes_option,
+    no_rollback: bool = no_rollback_option,
+    timeout: int = timeout_option,
+    verbose: bool = verbose_option,
+) -> None:
+    """Deploy or update the service."""
+    _check_platform_required(platform, "up")
+    source_dir = _check_pyproject_toml()
+    deploy_up(
+        platform,
+        name,
+        env,
+        region,
+        project_id,
+        image,
+        port,
+        generate_api_key,
+        generate_rsa,
+        yes,
+        no_rollback,
+        timeout,
+        verbose,
+        source_dir,
+    )
+
+
+@deploy_app.command(no_args_is_help=True)
+def down(
+    platform: str = platform_option,
+    name: str = name_option,
+    env: str = env_option,
+    region: str = region_option,
+    project_id: str = project_id_option,
+    yes: bool = yes_option,
+    verbose: bool = verbose_option,
+) -> None:
+    """Destroy the service and cleanup resources."""
+    _check_platform_required(platform, "down")
+    source_dir = _check_pyproject_toml()
+    deploy_down(platform, name, env, region, project_id, yes, verbose, source_dir)
+
+
+@deploy_app.command(no_args_is_help=True)
+def status(
+    platform: str = platform_option,
+    name: str = name_option,
+    env: str = env_option,
+    region: str = region_option,
+    project_id: str = project_id_option,
+    verbose: bool = verbose_option,
+) -> None:
+    """Show deployment status and health information."""
+    _check_platform_required(platform, "status")
+    source_dir = _check_pyproject_toml()
+    deploy_status(platform, name, env, region, project_id, verbose, source_dir)
+
+
+@deploy_app.command()
+def local(
+    name: str = name_option,
+    env: str = env_option,
+    port: int = port_option,
+    generate_api_key: bool = generate_api_key_option,
+    generate_rsa: bool = generate_rsa_option,
+    timeout: int = timeout_option,
+    verbose: bool = verbose_option,
+    docker_files_only: bool = docker_files_only_option,
+    controller_file: str = controller_file_option,
+) -> None:
+    """Test deployment locally using Docker Compose. Requires --name."""
+    source_dir = _check_pyproject_toml()
+    local_docker(
+        name,
+        env,
+        port,
+        generate_api_key,
+        generate_rsa,
+        timeout,
+        verbose,
+        docker_files_only,
+        str(source_dir),
+        controller_file,
+    )
+
+
+@deploy_app.command()
+def clean(
+    force: bool = force_option,
+    verbose: bool = verbose_option_clean,
+    docker_only: bool = typer.Option(
+        False, "--docker-only", help="Clean only Docker artifacts"
+    ),
+    state_only: bool = typer.Option(
+        False, "--state-only", help="Clean only deployment state"
+    ),
+) -> None:
+    """Clean up deployment artifacts and generated files."""
+    _check_pyproject_toml()
+
+    if docker_only and state_only:
+        console.print(
+            "[bold red]Error:[/] Cannot use both --docker-only and --state-only"
+        )
+        raise typer.Exit(1)
+
+    if docker_only:
+        clean_docker_artifacts(force=force, verbose=verbose)
+    elif state_only:
+        clean_state_only(force=force, verbose=verbose)
+    else:
+        clean_deployment(force=force, verbose=verbose)

supervaizer/deploy/commands/__init__.py

@@ -0,0 +1,9 @@
+# Copyright (c) 2024-2025 Alain Prasquier - Supervaize.com. All rights reserved.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, you can obtain one at
+# https://mozilla.org/MPL/2.0/.
+
+from . import plan, up, down, status
+
+__all__ = ["plan", "up", "down", "status"]

supervaizer/deploy/commands/clean.py

@@ -0,0 +1,294 @@
+# Copyright (c) 2024-2025 Alain Prasquier - Supervaize.com. All rights reserved.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+# If a copy of the MPL was not distributed with this file, you can obtain one at
+# https://mozilla.org/MPL/2.0/.
+
+"""
+Clean Command
+
+This module provides functionality to clean up deployment artifacts and generated files.
+"""
+
+import shutil
+from pathlib import Path
+from typing import Optional
+
+from rich.console import Console
+from rich.prompt import Confirm
+
+from supervaizer.common import log
+
+console = Console()
+
+
+def clean_deployment(
+    deployment_dir: Optional[Path] = None,
+    force: bool = False,
+    verbose: bool = False,
+) -> None:
+    """
+    Clean up deployment artifacts and generated files.
+
+    Args:
+        deployment_dir: Path to deployment directory (default: .deployment)
+        force: Skip confirmation prompt
+        verbose: Show detailed output
+    """
+    if deployment_dir is None:
+        deployment_dir = Path(".deployment")
+
+    # Check if deployment directory exists
+    if not deployment_dir.exists():
+        console.print(f"[yellow]No deployment directory found at {deployment_dir}[/]")
+        console.print("Nothing to clean up.")
+        return
+
+    # Show what will be deleted
+    console.print(f"[bold blue]Cleaning deployment directory: {deployment_dir}[/]")
+
+    if verbose:
+        console.print("\n[bold]Contents to be deleted:[/]")
+        try:
+            for item in deployment_dir.rglob("*"):
+                if item.is_file():
+                    console.print(f"  📄 {item.relative_to(deployment_dir)}")
+                elif item.is_dir():
+                    console.print(f"  📁 {item.relative_to(deployment_dir)}/")
+        except Exception as e:
+            log.debug(f"Error listing directory contents: {e}")
+
+    # Calculate total size
+    total_size = 0
+    file_count = 0
+    try:
+        for item in deployment_dir.rglob("*"):
+            if item.is_file():
+                total_size += item.stat().st_size
+                file_count += 1
+    except Exception as e:
+        log.debug(f"Error calculating directory size: {e}")
+
+    if file_count > 0:
+        size_mb = total_size / (1024 * 1024)
+        console.print(f"\n[bold]Summary:[/] {file_count} files, {size_mb:.2f} MB")
+
+    # Confirmation prompt (unless forced)
+    if not force:
+        console.print(
+            "\n[yellow]This will permanently delete all deployment artifacts.[/]"
+        )
+        console.print("This includes:")
+        console.print("  • Generated Docker files")
+        console.print("  • Deployment state")
+        console.print("  • Configuration files")
+        console.print("  • Logs and debug information")
+
+        if not Confirm.ask("\n[bold red]Are you sure you want to continue?[/]"):
+            console.print("[yellow]Cleanup cancelled.[/]")
+            return
+
+    # Perform cleanup
+    try:
+        console.print(f"\n[bold]Deleting {deployment_dir}...[/]")
+        shutil.rmtree(deployment_dir)
+        console.print("[green]✓[/] Deployment directory cleaned successfully")
+
+        # Show what was cleaned
+        console.print("\n[bold green]Cleanup completed![/]")
+        console.print(f"Removed: {deployment_dir}")
+        if file_count > 0:
+            console.print(f"Files deleted: {file_count}")
+            console.print(f"Space freed: {size_mb:.2f} MB")
+
+        # Show next steps
+        console.print("\n[bold]Next steps:[/]")
+        console.print(
+            "  • Run [bold]supervaizer deploy local[/] to regenerate files for local testing"
+        )
+        console.print(
+            "  • Run [bold]supervaizer deploy up[/] to deploy to cloud platforms"
+        )
+        console.print(
+            "  • Run [bold]supervaizer deploy plan[/] to plan new deployments"
+        )
+
+    except PermissionError as e:
+        console.print(
+            f"[bold red]Error:[/] Permission denied while deleting {deployment_dir}"
+        )
+        console.print(
+            "Make sure no processes are using files in the deployment directory."
+        )
+        console.print(f"Details: {e}")
+        raise RuntimeError(f"Failed to clean deployment directory: {e}") from e
+    except Exception as e:
+        console.print("[bold red]Error:[/] Failed to clean deployment directory")
+        console.print(f"Details: {e}")
+        raise RuntimeError(f"Failed to clean deployment directory: {e}") from e
+
+
+def clean_docker_artifacts(
+    force: bool = False,
+    verbose: bool = False,
+) -> None:
+    """
+    Clean up Docker-related artifacts only.
+
+    Args:
+        force: Skip confirmation prompt
+        verbose: Show detailed output
+    """
+    deployment_dir = Path(".deployment")
+
+    if not deployment_dir.exists():
+        console.print("[yellow]No deployment directory found[/]")
+        return
+
+    # List of Docker-related files to clean
+    docker_files = [
+        "Dockerfile",
+        ".dockerignore",
+        "docker-compose.yml",
+        "docker-compose.yaml",
+    ]
+
+    docker_dirs = [
+        "logs",
+    ]
+
+    files_to_delete = []
+    dirs_to_delete = []
+
+    # Find files to delete
+    for file_name in docker_files:
+        file_path = deployment_dir / file_name
+        if file_path.exists():
+            files_to_delete.append(file_path)
+
+    # Find directories to delete
+    for dir_name in docker_dirs:
+        dir_path = deployment_dir / dir_name
+        if dir_path.exists() and dir_path.is_dir():
+            dirs_to_delete.append(dir_path)
+
+    if not files_to_delete and not dirs_to_delete:
+        console.print("[yellow]No Docker artifacts found to clean[/]")
+        return
+
+    # Show what will be deleted
+    console.print("[bold blue]Cleaning Docker artifacts[/]")
+
+    if verbose:
+        console.print("\n[bold]Files to be deleted:[/]")
+        for file_path in files_to_delete:
+            console.print(f"  📄 {file_path.relative_to(deployment_dir)}")
+
+        console.print("\n[bold]Directories to be deleted:[/]")
+        for dir_path in dirs_to_delete:
+            console.print(f"  📁 {dir_path.relative_to(deployment_dir)}/")
+
+    # Confirmation prompt (unless forced)
+    if not force:
+        console.print("\n[yellow]This will delete Docker-related files only.[/]")
+        console.print("Deployment state and configuration will be preserved.")
+
+        if not Confirm.ask("\n[bold red]Continue with Docker cleanup?[/]"):
+            console.print("[yellow]Cleanup cancelled.[/]")
+            return
+
+    # Perform cleanup
+    deleted_count = 0
+
+    try:
+        # Delete files
+        for file_path in files_to_delete:
+            if verbose:
+                console.print(f"Deleting {file_path.relative_to(deployment_dir)}...")
+            file_path.unlink()
+            deleted_count += 1
+
+        # Delete directories
+        for dir_path in dirs_to_delete:
+            if verbose:
+                console.print(f"Deleting {dir_path.relative_to(deployment_dir)}/...")
+            shutil.rmtree(dir_path)
+            deleted_count += 1
+
+        console.print("[green]✓[/] Docker artifacts cleaned successfully")
+        console.print(f"Deleted {deleted_count} items")
+
+    except Exception as e:
+        console.print("[bold red]Error:[/] Failed to clean Docker artifacts")
+        console.print(f"Details: {e}")
+        raise RuntimeError(f"Failed to clean Docker artifacts: {e}") from e
+
+
+def clean_state_only(
+    force: bool = False,
+    verbose: bool = False,
+) -> None:
+    """
+    Clean up deployment state only, preserving generated files.
+
+    Args:
+        force: Skip confirmation prompt
+        verbose: Show detailed output
+    """
+    deployment_dir = Path(".deployment")
+
+    if not deployment_dir.exists():
+        console.print("[yellow]No deployment directory found[/]")
+        return
+
+    # State-related files to clean
+    state_files = [
+        "state.json",
+        "config.yaml",
+        "config.yml",
+    ]
+
+    files_to_delete = []
+
+    # Find state files to delete
+    for file_name in state_files:
+        file_path = deployment_dir / file_name
+        if file_path.exists():
+            files_to_delete.append(file_path)
+
+    if not files_to_delete:
+        console.print("[yellow]No state files found to clean[/]")
+        return
+
+    # Show what will be deleted
+    console.print("[bold blue]Cleaning deployment state[/]")
+
+    if verbose:
+        console.print("\n[bold]State files to be deleted:[/]")
+        for file_path in files_to_delete:
+            console.print(f"  📄 {file_path.relative_to(deployment_dir)}")
+
+    # Confirmation prompt (unless forced)
+    if not force:
+        console.print("\n[yellow]This will delete deployment state only.[/]")
+        console.print("Generated Docker files will be preserved.")
+        console.print("You will need to redeploy to recreate the state.")
+
+        if not Confirm.ask("\n[bold red]Continue with state cleanup?[/]"):
+            console.print("[yellow]Cleanup cancelled.[/]")
+            return
+
+    # Perform cleanup
+    try:
+        for file_path in files_to_delete:
+            if verbose:
+                console.print(f"Deleting {file_path.relative_to(deployment_dir)}...")
+            file_path.unlink()
+
+        console.print("[green]✓[/] Deployment state cleaned successfully")
+        console.print(f"Deleted {len(files_to_delete)} state files")
+
+    except Exception as e:
+        console.print("[bold red]Error:[/] Failed to clean deployment state")
+        console.print(f"Details: {e}")
+        raise RuntimeError(f"Failed to clean deployment state: {e}") from e