acex-devkit 1.12.0__tar.gz → 1.14.0__tar.gz

{acex_devkit-1.12.0 → acex_devkit-1.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acex-devkit
-Version: 1.12.0
+Version: 1.14.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.12.0 → acex_devkit-1.14.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acex-devkit"
-version = "1.12.0"
+version = "1.14.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.12.0 → acex_devkit-1.14.0}/src/acex_devkit/models/composed_configuration.py

@@ -1,5 +1,5 @@
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, SerializeAsAny
 from typing import Optional, Dict, List, Literal, ClassVar, Union, Any
 from enum import Enum
 
@@ -147,7 +147,45 @@ class StormControlAttributes(BaseModel):
     action: Optional[AttributeValue[Literal["trap", "shutdown"]]] = None
 
 
-class InterfaceTemplateAttributes(ContainerEntry, BaseModel):
+# --- Augments --------------------------------------------------------------
+# Vendor/os-specific augments mount on target tree components via the
+# `Augmentable` mixin. Devkit only knows about `AugmentAttributes` — the
+# generic base — and uses `extra='allow'` to round-trip subclass-specific
+# fields. Concrete augment payload classes (CiscoDeviceTrackingPolicy-
+# Attributes, etc.) live in the backend alongside their ConfigComponent
+# classes, so adding a new vendor augment requires no devkit edit.
+
+class AugmentAttributes(BaseModel):
+    """
+    Base for vendor/os-specific augments that mount on target tree components.
+
+    Subclasses live in the backend (next to their ConfigComponent) and add
+    typed payload fields. `extra='allow'` lets those fields round-trip
+    through serialize → JSON → re-validate without devkit knowing about them.
+
+    Augments live on a target node's `augments` dict, keyed by `type`. The
+    target itself is implicit (it's the node carrying this augment).
+    """
+    model_config = ConfigDict(extra="allow")
+    type: str
+
+
+class Augmentable(BaseModel):
+    """
+    Mixin that gives a target node a slot for vendor/os-specific augments.
+    Drivers walk `augments` per target and dispatch by augment type; targets
+    that no driver augments simply carry an empty dict.
+
+    `SerializeAsAny[AugmentAttributes]` makes Pydantic serialize each value
+    using its runtime type (the concrete subclass defined in backend),
+    not the declared base type. Combined with `extra='allow'` on
+    AugmentAttributes, this round-trips subclass-declared fields through
+    serialize → JSON → re-validate without devkit knowing the subclasses.
+    """
+    augments: Dict[str, SerializeAsAny[AugmentAttributes]] = {}
+
+
+class InterfaceTemplateAttributes(ContainerEntry, Augmentable):
     "Reusable named set of interface attributes that interfaces can reference."
     identity_fields: ClassVar[tuple[str, ...]] = ("name",)
     name: AttributeValue[str]
@@ -194,7 +232,7 @@ class InterfaceTemplateAttributes(ContainerEntry, BaseModel):
     lacp_interval: Optional[AttributeValue[Literal["fast", "slow"]]] = None
 
 
-class Interface(ContainerEntry, BaseModel):
+class Interface(ContainerEntry, Augmentable):
     "Base class for all interfaces"
     identity_fields: ClassVar[tuple[str, ...]] = ("index", "type")
     index: AttributeValue[int]
@@ -394,16 +432,15 @@ class SnmpConfig(ContainerEntry, BaseModel):
     contact: Optional[AttributeValue[str]] = None
 
 
-class SnmpCommunity(ContainerEntry, BaseModel):
+class SnmpCommunity(ContainerEntry, Augmentable):
     identity_fields: ClassVar[tuple[str, ...]] = ("name",)
     name: AttributeValue[str]
     community: Optional[AttributeValue[str]] = None # Community string
     access: Optional[AttributeValue[SnmpAccess]] = AttributeValue(value=SnmpAccess.READ_ONLY)
     view: Optional[AttributeValue[str]] = None
-    ipv4_acl: Optional[AttributeValue[str]] = None # Cisco and "liknande" vendors 
+    ipv4_acl: Optional[AttributeValue[str]] = None # Cisco and "liknande" vendors
     ipv6_acl: Optional[AttributeValue[str]] = None
     source_interface: Optional[Reference] = None
-    clients: Optional[AttributeValue[List[str]]] = None # Juniper specific
 
 
 class SnmpUser(ContainerEntry, BaseModel):
@@ -736,10 +773,9 @@ class TripleA(BaseModel):
     authorization: aaaAuthorization = aaaAuthorization()
     accounting: aaaAccounting = aaaAccounting()
 
-class VTPAttributes(BaseModel):
+class VTPAttributes(Augmentable):
     domain_name: Optional[AttributeValue[str]] = None
     mode: Optional[AttributeValue[Literal["server", "client", "transparent", 'off']]] = None
-    primary_server: Optional[AttributeValue[bool]] = False # Cisco proprietary
     version: Optional[AttributeValue[Literal[1, 2, 3]]] = None
     password: Optional[AttributeValue[str]] = None
     password_hashed: Optional[AttributeValue[str]] = None
@@ -875,6 +911,18 @@ class Sampling(BaseModel):
     netflow: Optional[Netflow] = Netflow()
     #sflow: Optional[Sflow] = Sflow() # Sflow can be added in the future, similar structure to Netflow
 
+class DnsServerAttributes(ContainerEntry, BaseModel):
+    identity_fields: ClassVar[tuple[str, ...]] = ("address",)
+    address: Optional[AttributeValue[str]] = None
+    port: Optional[AttributeValue[int]] = None # Keeping option to allow for use where needed, even if default DNS port is 53
+    source_interface: Optional[Reference] = None # Keeping option to allow for use where needed
+    network_instance: Optional[AttributeValue[str]] = None
+
+class Dns(BaseModel):
+    # Placeholder for DNS configuration. Can be expanded with actual DNS attributes as needed.
+    #enabled: Optional[AttributeValue[bool]] = None
+    dns_servers: Optional[Dict[str, DnsServerAttributes]] = {} # key is server name, value is IP address
+
 class System(BaseModel):
     config: SystemConfig = SystemConfig()
     aaa: Optional[TripleA] = TripleA()
@@ -884,6 +932,7 @@ class System(BaseModel):
     snmp: Optional[Snmp] = Snmp()
     vtp: Optional[VTP] = VTP()
     dhcp: Optional[Dhcp] = Dhcp()
+    dns: Optional[Dns] = Dns()
     services: Optional[Services] = Services()
 
 # For different types of interfaces that are fine for response model:
@@ -896,6 +945,7 @@ InterfaceType = Union[
     ManagementInterface,
 ]
 
+
 class ComposedConfiguration(BaseModel):
     system: Optional[System] = System()
     acl: Optional[Acl] = Acl()