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

supervaizer/deploy/drivers/base.py

@@ -0,0 +1,196 @@
+# 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/.
+
+"""
+Base Driver Interface
+
+This module defines the base interface for deployment drivers.
+"""
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel
+
+
+class ActionType(str, Enum):
+    """Type of deployment action."""
+
+    CREATE = "create"
+    UPDATE = "update"
+    NOOP = "noop"
+    DELETE = "delete"
+
+
+class ResourceType(str, Enum):
+    """Type of cloud resource."""
+
+    SERVICE = "service"
+    SECRET = "secret"
+    REGISTRY = "registry"
+    IMAGE = "image"
+
+
+@dataclass
+class ResourceAction:
+    """Represents an action to be taken on a resource."""
+
+    resource_type: ResourceType
+    action_type: ActionType
+    resource_name: str
+    description: str
+    cost_estimate: Optional[str] = None
+    metadata: Optional[Dict[str, Any]] = None
+
+
+class DeploymentPlan(BaseModel):
+    """Deployment plan containing all actions to be taken."""
+
+    platform: str
+    service_name: str
+    environment: str
+    region: str
+    project_id: Optional[str] = None
+
+    # Plan details
+    actions: List[ResourceAction] = []
+    total_cost_estimate: Optional[str] = None
+    estimated_duration: Optional[str] = None
+
+    # Current state
+    current_image: Optional[str] = None
+    current_url: Optional[str] = None
+    current_status: Optional[str] = None
+
+    # Target state
+    target_image: str
+    target_port: int = 8000
+    target_env_vars: Dict[str, str] = {}
+    target_secrets: Dict[str, str] = {}
+
+
+class DeploymentResult(BaseModel):
+    """Result of a deployment operation."""
+
+    success: bool
+    service_url: Optional[str] = None
+    service_id: Optional[str] = None
+    revision: Optional[str] = None
+    image_digest: Optional[str] = None
+
+    # Status information
+    status: str = "unknown"
+    health_status: str = "unknown"
+
+    # Timing
+    deployment_time: Optional[float] = None
+
+    # Error information
+    error_message: Optional[str] = None
+    error_details: Optional[Dict[str, Any]] = None
+
+
+class BaseDriver(ABC):
+    """Base interface for deployment drivers."""
+
+    def __init__(self, region: str, project_id: Optional[str] = None):
+        """Initialize the driver."""
+        self.region = region
+        self.project_id = project_id
+
+    @abstractmethod
+    def plan_deployment(
+        self,
+        service_name: str,
+        environment: str,
+        image_tag: str,
+        port: int = 8000,
+        env_vars: Optional[Dict[str, str]] = None,
+        secrets: Optional[Dict[str, str]] = None,
+    ) -> DeploymentPlan:
+        """Plan deployment changes without applying them."""
+        pass
+
+    @abstractmethod
+    def deploy_service(
+        self,
+        service_name: str,
+        environment: str,
+        image_tag: str,
+        port: int = 8000,
+        env_vars: Optional[Dict[str, str]] = None,
+        secrets: Optional[Dict[str, str]] = None,
+        timeout: int = 300,
+    ) -> DeploymentResult:
+        """Deploy or update the service."""
+        pass
+
+    @abstractmethod
+    def destroy_service(
+        self,
+        service_name: str,
+        environment: str,
+        keep_secrets: bool = False,
+    ) -> DeploymentResult:
+        """Destroy the service and cleanup resources."""
+        pass
+
+    @abstractmethod
+    def get_service_status(
+        self,
+        service_name: str,
+        environment: str,
+    ) -> DeploymentResult:
+        """Get current service status and health."""
+        pass
+
+    @abstractmethod
+    def verify_health(self, service_url: str, timeout: int = 60) -> bool:
+        """Verify service health by checking the health endpoint."""
+        pass
+
+    def verify_health_enhanced(
+        self,
+        service_url: str,
+        api_key: Optional[str] = None,
+        timeout: int = 60,
+        max_retries: int = 5,
+    ) -> bool:
+        """
+        Enhanced health verification with retry logic and exponential backoff.
+
+        Args:
+            service_url: Base URL of the service
+            api_key: Optional API key for authenticated endpoints
+            timeout: Request timeout in seconds
+            max_retries: Maximum number of retry attempts
+
+        Returns:
+            True if service is healthy, False otherwise
+        """
+        from supervaizer.deploy.health import verify_service_health
+
+        return verify_service_health(service_url, api_key, timeout, max_retries)
+
+    @abstractmethod
+    def check_prerequisites(self) -> List[str]:
+        """Check prerequisites and return list of missing requirements."""
+        pass
+
+    def get_service_key(self, service_name: str, environment: str) -> str:
+        """Generate a unique key for the service."""
+        return f"{service_name}-{environment}"
+
+    def validate_configuration(self, **kwargs: Any) -> List[str]:
+        """Validate driver configuration and return list of errors."""
+        errors = []
+
+        if not self.region:
+            errors.append("Region is required")
+
+        return errors