acex-devkit 1.6.1__tar.gz → 1.7.0__tar.gz

{acex_devkit-1.6.1 → acex_devkit-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acex-devkit
-Version: 1.6.1
+Version: 1.7.0
 Summary: ACE-X DevKit - Development kit for building ACE-X drivers and plugins
 License: AGPL-3.0
 Keywords: automation,devkit,sdk,drivers,plugins

{acex_devkit-1.6.1 → acex_devkit-1.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acex-devkit"
-version = "1.6.1"
+version = "1.7.0"
 description = "ACE-X DevKit - Development kit for building ACE-X drivers and plugins"
 authors = ["Johan Lahti <johan.lahti@acebit.se>"]
 readme = "README.md"

{acex_devkit-1.6.1 → acex_devkit-1.7.0}/src/acex_devkit/drivers/base.py

@@ -3,6 +3,9 @@
 from abc import ABC, abstractmethod
 from typing import Any, Dict
 
+from acex_devkit.models.node_response import NodeListItem
+from acex_devkit.models.management_connection import ManagementConnection
+
 
 class ParserBase(ABC):
     """Base class for configuration parsers."""
@@ -38,36 +41,32 @@ class RendererBase(ABC):
 
 
 class TransportBase(ABC):
-    """Base class for device transport/communication."""
-    
-    @abstractmethod
-    def connect(self) -> None:
-        """Establish connection to the device."""
-        pass
+    """Base class for device transport/communication.
 
-    @abstractmethod
-    def send(self, payload: Any) -> None:
-        """Send configuration to the device.
-        
-        Args:
-            payload: Configuration payload to send
-        """
-        pass
+    Each method is self-contained — the driver decides internally
+    whether to open/close sessions per call, pool connections, or
+    make stateless requests.
+
+    Args:
+        node: The node instance (identity, hostname, vendor, os, ned_id)
+        connection: Management connection (target_ip, connection_type)
+        **kwargs: Future use (credentials, options, etc.)
+    """
 
     @abstractmethod
-    def verify(self) -> bool:
-        """Verify configuration was applied correctly.
-        
-        Returns:
-            True if verification succeeded, False otherwise
-        """
+    def get_config(self, node: NodeListItem, connection: ManagementConnection, **kwargs) -> str:
+        """Fetch the full running configuration from a device."""
         pass
 
     @abstractmethod
-    def rollback(self) -> None:
-        """Rollback configuration if verification fails."""
+    def send_config(self, node: NodeListItem, connection: ManagementConnection, commands: list[str], **kwargs) -> str:
+        """Apply configuration commands to a device."""
         pass
 
+    def execute(self, node: NodeListItem, connection: ManagementConnection, commands: list[str], **kwargs) -> list[str]:
+        """Run arbitrary commands and return output per command. Opt-in per driver."""
+        raise NotImplementedError(f"{self.__class__.__name__} does not implement execute()")
+
 
 class NetworkElementDriver:
     """Base class for network element drivers.

{acex_devkit-1.6.1 → acex_devkit-1.7.0}/src/acex_devkit/drivers/base_driver.py

@@ -1,6 +1,9 @@
 from abc import ABC, abstractmethod
 from typing import Any, Dict
 
+from acex_devkit.models.node_response import NodeListItem
+from acex_devkit.models.management_connection import ManagementConnection
+
 class ParserBase(ABC):
     @abstractmethod
     def parse(self, model: Dict[str, Any]) -> Any:
@@ -14,16 +17,18 @@ class RendererBase(ABC):
 
 class TransportBase(ABC):
     @abstractmethod
-    def connect(self) -> None: ...
-
-    @abstractmethod
-    def send(self, payload: Any) -> None: ...
+    def get_config(self, node: NodeListItem, connection: ManagementConnection, **kwargs) -> str:
+        """Fetch the full running configuration from a device."""
+        pass
 
     @abstractmethod
-    def verify(self) -> bool: ...
+    def send_config(self, node: NodeListItem, connection: ManagementConnection, commands: list[str], **kwargs) -> str:
+        """Apply configuration commands to a device."""
+        pass
 
-    @abstractmethod
-    def rollback(self) -> None: ...
+    def execute(self, node: NodeListItem, connection: ManagementConnection, commands: list[str], **kwargs) -> list[str]:
+        """Run arbitrary commands. Opt-in per driver."""
+        raise NotImplementedError(f"{self.__class__.__name__} does not implement execute()")
 
 class NetworkElementDriver:
     """Kombinerar renderer + transport – exponeras som en plugin."""

{acex_devkit-1.6.1 → acex_devkit-1.7.0}/src/acex_devkit/models/__init__.py

@@ -6,6 +6,7 @@
 from .external_value import ExternalValue
 from .attribute_value import AttributeValue
 from .node_response import NodeResponse, NodeListItem, LogicalNodeResponse
+from .management_connection import ManagementConnection, ConnectionType
 
 __all__ = [
     ExternalValue,

acex_devkit-1.7.0/src/acex_devkit/models/management_connection.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel
+from typing import Optional
+from enum import Enum
+
+
+class ConnectionType(str, Enum):
+    ssh = "ssh"
+    telnet = "telnet"
+
+
+class ManagementConnection(BaseModel):
+    id: Optional[int] = None
+    node_id: Optional[int] = None
+    primary: bool = True
+    connection_type: ConnectionType = ConnectionType.ssh
+    target_ip: Optional[str] = None

{acex_devkit-1.6.1 → acex_devkit-1.7.0}/src/acex_devkit/models/node_response.py

@@ -1,5 +1,5 @@
 from pydantic import BaseModel, Field
-from typing import Optional, Dict, Any
+from typing import Annotated, Optional, Dict, Any, List, Literal, Union
 from enum import Enum
 from datetime import datetime
 from acex_devkit.models.composed_configuration import ComposedConfiguration
@@ -17,6 +17,7 @@ class LogicalNodeResponse(BaseModel):
 
 class Asset(BaseModel):
     id: Optional[int] = None
+    type: Literal["asset"] = "asset"
     vendor: Optional[str] = None
     serial_number: Optional[str] = None
     os: Optional[str] = None
@@ -25,6 +26,25 @@ class Asset(BaseModel):
     ned_id: Optional[str] = None
 
 
+class AssetClusterAsset(BaseModel):
+    id: Optional[int] = None
+    vendor: Optional[str] = None
+    serial_number: Optional[str] = None
+    os: Optional[str] = None
+    os_version: Optional[str] = None
+    hardware_model: Optional[str] = None
+    ned_id: Optional[str] = None
+    cluster_index: Optional[int] = None
+
+
+class AssetCluster(BaseModel):
+    id: Optional[int] = None
+    type: Literal["asset_cluster"] = "asset_cluster"
+    name: Optional[str] = None
+    ned_id: Optional[str] = None
+    assets: List[AssetClusterAsset] = []
+
+
 class AssetRefType(str, Enum):
     asset = "asset"
     asset_cluster = "asset_cluster"
@@ -65,7 +85,7 @@ class NodeListItem(NodeBase):
 
 class NodeResponse(NodeBase):
     id: Optional[int] = None
-    asset: Asset
+    asset: Annotated[Union[Asset, AssetCluster], Field(discriminator="type")]
     logical_node: LogicalNodeResponse
     created_at: datetime
     updated_at: Optional[datetime] = None