cancan-microstack 0.0.1__py3-none-any.whl

cancan_microstack/public/schemas/controllersrv/task_models.py

@@ -0,0 +1,102 @@
+"""
+任务领域模型
+
+定义Task相关的领域模型类
+"""
+from typing import (
+    Dict,
+    Any,
+    Optional,
+)
+from datetime import datetime
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from cancan_microstack.public.const.operation_consts import (
+    OperationType,
+    OperationStatus,
+)
+
+
+class Task(BaseModel):
+    """
+    任务数据类
+    
+    Attributes:
+        serial_number: 流水号（唯一标识）
+        operation: 操作类型
+        service_names: 服务名称列表
+        params: 其他参数
+        status: 任务状态
+        created_at: 创建时间
+        started_at: 开始执行时间
+        finished_at: 完成时间
+        result: 执行结果
+        error: 错误信息
+        retry_count: 重试次数
+    """
+    serial_number: str
+    operation: OperationType
+    service_names: list
+    params: Dict[str, Any] = Field(default_factory=dict)
+    status: OperationStatus = OperationStatus.PENDING
+    created_at: datetime = Field(default_factory=datetime.now)
+    started_at: Optional[datetime] = None
+    finished_at: Optional[datetime] = None
+    result: Optional[Dict[str, Any]] = None
+    error: Optional[str] = None
+    retry_count: int = 0
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        return self.model_dump(mode='json')
+
+    def mark_running(self):
+        """标记为运行中"""
+        self.status = OperationStatus.RUNNING
+        self.started_at = datetime.now()
+
+    def mark_success(self, result: Dict[str, Any]):
+        """标记为成功"""
+        self.status = OperationStatus.SUCCESS
+        self.finished_at = datetime.now()
+        self.result = result
+
+    def mark_failed(self, error: str):
+        """标记为失败"""
+        self.status = OperationStatus.FAILED
+        self.finished_at = datetime.now()
+        self.error = error
+
+    def mark_timeout(self):
+        """标记为超时"""
+        self.status = OperationStatus.TIMEOUT
+        self.finished_at = datetime.now()
+        self.error = "Task execution timeout"
+
+    def mark_cancelled(self):
+        """标记为已取消"""
+        self.status = OperationStatus.CANCELLED
+        self.finished_at = datetime.now()
+        self.error = "Task cancelled"
+
+    def is_finished(self) -> bool:
+        """是否已完成（无论成功还是失败）"""
+        return self.status in {
+            OperationStatus.SUCCESS,
+            OperationStatus.FAILED,
+            OperationStatus.TIMEOUT,
+            OperationStatus.CANCELLED,
+        }
+
+    def execution_time(self) -> Optional[float]:
+        """计算执行时间（秒）"""
+        if self.started_at and self.finished_at:
+            return (self.finished_at - self.started_at).total_seconds()
+        elif self.started_at:
+            # 正在执行中
+            return (datetime.now() - self.started_at).total_seconds()
+        return None

cancan_microstack/public/schemas/controllersrv/validation.py

@@ -0,0 +1,23 @@
+"""
+controllersrv 验证相关模型
+
+定义服务验证结果等模型
+"""
+from typing import List
+
+from pydantic import BaseModel
+
+
+class ValidationResult(BaseModel):
+    """服务验证结果模型
+    
+    Attributes:
+        valid: 是否验证通过
+        invalid_services: 无效的服务名称列表
+        non_operable_services: 不可操作的服务名称列表
+        valid_services: 有效的服务名称列表
+    """
+    valid: bool
+    invalid_services: List[str]
+    non_operable_services: List[str]
+    valid_services: List[str]

cancan_microstack/public/schemas/hook_metrics.py

@@ -0,0 +1,124 @@
+"""
+钩子指标相关的 Pydantic 模型
+Hook metrics related Pydantic models
+"""
+from typing import (
+    Dict,
+    List,
+)
+from datetime import datetime
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from cancan_microstack.public.const.metrics_enums import MetricType
+
+
+class Metric(BaseModel):
+    """指标数据类"""
+    name: str = Field(description="指标名称")
+    metric_type: MetricType = Field(description="指标类型")
+    description: str = Field(default="", description="指标描述")
+    value: float = Field(default=0.0, description="指标值")
+    labels: Dict[str, str] = Field(default_factory=dict, description="标签")
+    timestamp: datetime = Field(default_factory=datetime.now, description="时间戳")
+
+
+class MetricValue(BaseModel):
+    """指标值 / Metric value"""
+    value: float = Field(description="指标值 / Metric value")
+    labels: Dict[str, str] = Field(default_factory=dict, description="标签 / Labels")
+    timestamp: datetime = Field(description="时间戳 / Timestamp")
+
+
+class MetricData(BaseModel):
+    """指标数据 / Metric data"""
+    name: str = Field(description="指标名称 / Metric name")
+    type: str = Field(description="指标类型 / Metric type")
+    description: str = Field(description="指标描述 / Metric description")
+    values: List[MetricValue] = Field(default_factory=list, description="指标值列表 / Metric values")
+
+
+class HookExecutionHistoryItem(BaseModel):
+    """钩子执行历史项 / Hook execution history item"""
+    hook_name: str = Field(description="钩子名称 / Hook name")
+    result: str = Field(description="执行结果 / Execution result")
+    message: str = Field(description="消息 / Message")
+    execution_time: float = Field(description="执行时间(秒) / Execution time (seconds)")
+    has_modified_service_info: bool = Field(description="是否修改了服务信息 / Whether service info was modified")
+
+
+class HookInfo(BaseModel):
+    """钩子信息 / Hook information"""
+    name: str = Field(description="钩子名称 / Hook name")
+    priority: str = Field(description="优先级 / Priority")
+    type: str = Field(description="钩子类型 / Hook type")
+
+
+class HooksByPriority(BaseModel):
+    """按优先级分组的钩子 / Hooks grouped by priority"""
+    CRITICAL: List[HookInfo] = Field(default_factory=list, description="关键优先级钩子 / Critical priority hooks")
+    HIGH: List[HookInfo] = Field(default_factory=list, description="高优先级钩子 / High priority hooks")
+    MEDIUM: List[HookInfo] = Field(default_factory=list, description="中优先级钩子 / Medium priority hooks")
+    LOW: List[HookInfo] = Field(default_factory=list, description="低优先级钩子 / Low priority hooks")
+
+
+class HookTypeStatus(BaseModel):
+    """钩子类型状态 / Hook type status"""
+    count: int = Field(description="钩子数量 / Hook count")
+    hooks_by_priority: HooksByPriority = Field(description="按优先级分组的钩子 / Hooks by priority")
+
+
+class MetricSummary(BaseModel):
+    """指标摘要 / Metric summary"""
+    type: str = Field(description="指标类型 / Metric type")
+    description: str = Field(description="指标描述 / Metric description")
+    latest_value: float = Field(description="最新值 / Latest value")
+    latest_timestamp: datetime = Field(description="最新时间戳 / Latest timestamp")
+
+
+class HookPerformance(BaseModel):
+    """钩子性能统计 / Hook performance statistics"""
+    total_executions: int = Field(default=0, description="总执行次数 / Total executions")
+    successful_executions: int = Field(default=0, description="成功执行次数 / Successful executions")
+    failed_executions: int = Field(default=0, description="失败执行次数 / Failed executions")
+    total_execution_time: float = Field(default=0.0, description="总执行时间 / Total execution time")
+    min_execution_time: float = Field(default=float('inf'), description="最小执行时间 / Min execution time")
+    max_execution_time: float = Field(default=0.0, description="最大执行时间 / Max execution time")
+    avg_execution_time: float = Field(default=0.0, description="平均执行时间 / Average execution time")
+
+
+class OverallPerformanceStats(BaseModel):
+    """整体性能统计 / Overall performance statistics"""
+    total_executions: int = Field(description="总执行次数 / Total executions")
+    successful_executions: int = Field(description="成功执行次数 / Successful executions")
+    failed_executions: int = Field(description="失败执行次数 / Failed executions")
+    success_rate: float = Field(description="成功率(%) / Success rate (%)")
+
+
+class BaseMetricLabels(BaseModel):
+    """指标标签基类"""
+    hook_name: str
+    hook_type: str
+
+
+class HookExecutionLabels(BaseMetricLabels):
+    """hook_executions_total 指标的标签"""
+    result: str
+
+
+class HookFailureLabels(BaseMetricLabels):
+    """hook_failures_total 指标的标签"""
+    error_type: str
+
+
+class ActiveHooksLabels(BaseModel):
+    """active_hooks 指标的标签"""
+    hook_type: str
+
+
+class HookRejectionLabels(BaseModel):
+    """hook_rejections_total 指标的标签"""
+    hook_name: str
+    reason: str

cancan_microstack/public/schemas/hooks.py

@@ -0,0 +1,39 @@
+from datetime import datetime
+from typing import (
+    Any,
+    Dict,
+    Optional,
+)
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from cancan_microstack.public.schemas.infra.enums import HookExecutionResult as HookResult
+
+
+class HookContext(BaseModel):
+    """钩子执行上下文"""
+    service_name: str = Field(description="服务名称")
+    service_type: str = Field(description="服务类型")
+    instance_id: str = Field(description="实例ID")
+    host: Optional[str] = Field(default=None, description="主机地址")
+    port: Optional[int] = Field(default=None, description="端口号")
+    metadata: Dict[str, Any] = Field(default_factory=dict, description="元数据")
+    created_at: datetime = Field(default_factory=datetime.now, description="创建时间")
+    retry_count: int = Field(default=0, description="重试次数")
+    max_retries: int = Field(default=3, description="最大重试次数")
+    timeout: int = Field(default=30, description="超时时间")
+    dry_run: bool = Field(default=False, description="是否为试运行")
+
+
+class HookExecutionResult(BaseModel):
+    """钩子执行结果"""
+    hook_name: str = Field(description="钩子名称")
+    result: HookResult = Field(description="执行结果")
+    message: str = Field(default="", description="消息")
+    execution_time: float = Field(default=0.0, description="执行时间")
+    error: Optional[str] = Field(default=None, description="错误信息")
+    timestamp: datetime = Field(default_factory=datetime.now, description="时间戳")
+    retry_count: int = Field(default=0, description="重试次数")

cancan_microstack/public/schemas/infra/cleanup.py

@@ -0,0 +1,25 @@
+from typing import (
+    List,
+    Optional,
+)
+from datetime import datetime
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+
+class CleanupDetail(BaseModel):
+    service_name: str = Field(...)
+    instance_id: str = Field(...)
+    action: str = Field(...)
+    reason: Optional[str] = None
+    last_heartbeat: Optional[datetime] = None
+
+
+class CleanupResult(BaseModel):
+    total_checked: int = Field(...)
+    cleaned: int = Field(default=0)
+    kept: int = Field(default=0)
+    details: List[CleanupDetail] = Field(default_factory=list)

cancan_microstack/public/schemas/infra/container.py

@@ -0,0 +1,74 @@
+"""
+Container related types
+"""
+from typing import Optional
+from datetime import datetime
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+
+class ContainerState(BaseModel):
+    """Represents the state of a container at a point in time."""
+    name: str = Field(description="容器名称")
+    status: str = Field(description="容器状态 (e.g., 'running', 'exited', 'unknown', 'error')")
+    running: bool = Field(description="容器是否正在运行")
+    is_healthy: bool = Field(default=False, description="容器是否健康")
+    error: Optional[str] = Field(default=None, description="检查时发生的错误信息")
+    checked_at: datetime = Field(default_factory=datetime.now, description="状态检查时间")
+    
+    # Fields from container_info.to_dict() that might be useful
+    id: Optional[str] = None
+    paused: bool = False
+    restarting: bool = False
+    oom_killed: bool = False
+    exit_code: int = 0
+    started_at: Optional[str] = None
+    finished_at: Optional[str] = None
+    health: Optional[dict] = None
+    network_settings: Optional[dict] = None
+    ports: Optional[dict] = None
+    labels: Optional[dict] = None
+    created: Optional[str] = None
+
+    class Config:
+        from_attributes = True
+
+
+class FullContainerState(ContainerState):
+    """Represents the combined state of a container and its service instance."""
+    instance_id: Optional[str] = None
+    service_name: Optional[str] = None
+    expected_status: Optional[str] = None
+    db_status: Optional[str] = None
+
+
+class ContainerStateCacheEntry(BaseModel):
+    """Represents a cache entry for a container's state."""
+    state: ContainerState
+    timestamp: datetime
+
+
+class InconsistentInstanceInfo(BaseModel):
+    """Represents information about an instance with inconsistent state."""
+    instance_id: str
+    service_name: str
+    container_name: str
+    db_status: str
+    expected_status: str
+    container_status: Optional[str] = None
+    container_running: bool
+    container_healthy: bool
+    inconsistency_reason: str
+
+
+class CleanedInstanceInfo(BaseModel):
+    """Represents information about a cleaned-up instance."""
+    instance_id: str
+    service_name: str
+    container_name: str
+    exit_code: Optional[int] = None
+    finished_at: Optional[str] = None
+    reason: str

cancan_microstack/public/schemas/infra/enums.py

@@ -0,0 +1,135 @@
+from enum import (
+    StrEnum,
+    IntEnum,
+)
+
+
+class ServiceType(StrEnum):
+    """服务类型"""
+    INFRASTRUCTURE = "infrastructure"
+    BUSINESS = "business"
+    OPS = "ops"
+
+
+class HookExecutionResult(StrEnum):
+    """钩子执行结果"""
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    TERMINATE = "TERMINATE"
+    RETRY = "RETRY"
+
+
+class HookPriority(IntEnum):
+    """钩子优先级"""
+    HIGHEST = 1
+    HIGH = 2
+    NORMAL = 3
+    LOW = 4
+    LOWEST = 5
+
+
+class WorkflowStatus(StrEnum):
+    PENDING = "PENDING"
+    RUNNING = "RUNNING"
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    CANCELLED = "CANCELLED"
+    PAUSED = "PAUSED"
+
+
+class NodeStatus(StrEnum):
+    PENDING = "PENDING"
+    RUNNING = "RUNNING"
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    SKIPPED = "SKIPPED"
+    SUSPENDED = "SUSPENDED"  # 等待回调
+    RETRYING = "RETRYING"
+    CANCELLED = "CANCELLED"  # 跟随流程取消
+
+
+class TriggerType(StrEnum):
+    MANUAL = "MANUAL"
+    SCHEDULE = "SCHEDULE"
+    API = "API"
+
+
+class NodeType(StrEnum):
+    START = "START"
+    ACTION = "ACTION"
+    TRANSFORM = "TRANSFORM"
+    LOGIC = "LOGIC"
+    FORK = "FORK"  # 并行分支节点 / Parallel fork node
+    JOIN = "JOIN"
+    LOOP = "LOOP"
+    END = "END"
+
+
+class ConditionTruth(StrEnum):
+    """条件求值标准化枚举 / Normalized enum for condition evaluations"""
+
+    TRUE = "true"
+    FALSE = "false"
+
+
+class JoinMode(StrEnum):
+    ALL = "ALL"
+    ANY = "ANY"
+
+class EndStatus(StrEnum):
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+
+class TransformEngine(StrEnum):
+    """数据转换引擎枚举 / Enumerates transform engines"""
+
+    JINJA2 = "JINJA2"
+    JMESPATH = "JMESPATH"
+
+
+class ExecutionLogStatus(StrEnum):
+    """执行日志状态 / Execution log status"""
+
+    PENDING = "PENDING"
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    TIMEOUT = "TIMEOUT"
+
+
+class TriggerDispatchStatus(StrEnum):
+    """工作流触发指令状态 / Workflow trigger dispatch status"""
+
+    DISPATCHED = "DISPATCHED"
+    QUEUED_NO_ENTRY = "QUEUED_NO_ENTRY"
+
+
+class CallbackAckStatus(StrEnum):
+    """回调确认结果 / Callback acknowledgement status"""
+
+    ACCEPTED = "ACCEPTED"
+    IGNORED = "IGNORED"
+
+
+class WorkflowEngineAlertStatus(StrEnum):
+    """工作流引擎告警状态枚举 / Workflow engine alert lifecycle status"""
+
+    OPEN = "OPEN"
+    ACKED = "ACKED"
+    RESOLVED = "RESOLVED"
+
+
+class WorkflowEngineAlertSeverity(StrEnum):
+    """工作流引擎告警严重程度 / Workflow engine alert severity"""
+
+    CRITICAL = "CRITICAL"
+    MAJOR = "MAJOR"
+    MINOR = "MINOR"
+
+
+class WorkflowEngineAlertCategory(StrEnum):
+    """告警分类，便于前端筛选 / Alert category for filtering"""
+
+    ORCHESTRATOR_GUARD = "ORCHESTRATOR_GUARD"
+    TRANSPORT_PIPELINE = "TRANSPORT_PIPELINE"
+    CALLBACK = "CALLBACK"
+    DATA_INTEGRITY = "DATA_INTEGRITY"

cancan_microstack/public/schemas/infra/health_check.py

@@ -0,0 +1,42 @@
+from typing import (
+    List,
+    Optional,
+)
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+from cancan_microstack.public.const.health_consts import InstanceHealthStatus
+
+
+class InstanceHealthDetail(BaseModel):
+    """单个实例的健康检查详情模型"""
+    instance_id: str = Field(..., description="实例ID")
+    service_name: str = Field(..., description="服务名称")
+    host: str = Field(..., description="主机")
+    port: int = Field(..., description="端口")
+    status: str = Field(..., description="实例运行状态")
+    health_status: InstanceHealthStatus = Field(
+        InstanceHealthStatus.UNKNOWN, description="健康状态"
+    )
+    consecutive_failures: int = Field(0, description="连续失败次数")
+    exempted: bool = Field(False, description="是否被豁免")
+    exemption_reason: Optional[str] = Field(None, description="豁免原因")
+    expected_stopped: bool = Field(False, description="是否期望停止")
+    action_taken: Optional[str] = Field(None, description="采取的自动动作标识")
+    # 使用 Optional[str] 接受 ISO 字符串或 datetime，方便与现有代码兼容
+    last_heartbeat: Optional[str] = Field(None, description="最后心跳时间 (ISO string)")
+
+
+class HealthCheckSummary(BaseModel):
+    """整体健康检查汇总结果模型"""
+    total: int = Field(..., description="实例总数")
+    healthy: int = Field(default=0, description="健康实例数")
+    unhealthy: int = Field(default=0, description="不健康实例数")
+    degraded: int = Field(default=0, description="降级实例数")
+    exempted: int = Field(default=0, description="豁免实例数")
+    expected_stopped: int = Field(default=0, description="期望停止实例数")
+    details: List[InstanceHealthDetail] = Field(default_factory=list, description="实例详情列表")
+

cancan_microstack/public/schemas/infra/hook_log.py

@@ -0,0 +1,42 @@
+"""
+Hook 日志数据模型
+Hook logging data models
+"""
+from typing import (
+    Dict,
+    Any,
+    Optional,
+)
+
+from pydantic import (
+    BaseModel,
+    Field,
+)
+
+
+class HookInfo(BaseModel):
+    """
+    钩子信息模型
+    Hook information model
+    """
+    name: str = Field(..., description="钩子名称 / Hook name")
+    type: str = Field(..., description="钩子类型 / Hook type")
+    priority: Optional[str] = Field(None, description="钩子优先级 / Hook priority")
+
+
+class HookLogData(BaseModel):
+    """
+    钩子日志数据模型，用于结构化日志输出
+    Hook log data model for structured logging
+    """
+    timestamp: str = Field(..., description="时间戳 (ISO格式) / Timestamp (ISO format)")
+    hook: HookInfo = Field(..., description="钩子信息 / Hook information")
+    message: str = Field(..., description="日志消息 / Log message")
+    context: Optional[Dict[str, Any]] = Field(None, description="上下文数据 / Context data")
+    execution_time: Optional[float] = Field(None, description="执行时间（秒）/ Execution time (seconds)")
+    error: Optional[str] = Field(None, description="错误信息 / Error message")
+    rejection_reason: Optional[str] = Field(None, description="拒绝原因 / Rejection reason")
+    modifications: Optional[Dict[str, Any]] = Field(None, description="修改内容 / Modifications")
+
+    class Config:
+        from_attributes = True