acex-devkit 1.13.0__tar.gz → 1.14.1__tar.gz

{acex_devkit-1.13.0 → acex_devkit-1.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acex-devkit
-Version: 1.13.0
+Version: 1.14.1
 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.13.0 → acex_devkit-1.14.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "acex-devkit"
-version = "1.13.0"
+version = "1.14.1"
 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.13.0 → acex_devkit-1.14.1}/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]
@@ -351,7 +389,24 @@ class NetworkInstance(ContainerEntry, BaseModel):
 class LacpConfig(BaseModel):
     system_priority: Optional[AttributeValue[int]] = None
     system_id_mac: Optional[AttributeValue[str]] = None
-    load_balance_algorithm: Optional[AttributeValue[list[Literal["src-mac", "dst-mac", "src-dst-mac", "src-ip", "dst-ip", "src-dst-ip", "src-port", "dst-port", "src-dst-port"]]]] = None
+    load_balance_algorithm: Optional[
+        AttributeValue[
+            list[
+                Literal[
+                    "src-mac",
+                    "dst-mac",
+                    "src-dst-mac",
+                    "src-ip",
+                    "dst-ip",
+                    "src-dst-ip",
+                    "src-port",
+                    "dst-port",
+                    "src-dst-port",
+                ]
+            ]
+        ]
+    ] = None
+
 
 class Lacp(BaseModel):
     config: Optional[LacpConfig] = LacpConfig()
@@ -394,16 +449,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 +790,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
@@ -776,9 +829,12 @@ class NetflowFormat(str, Enum):
     NETFLOW_V9 = "NetFlow v9"
     NETFLOW_V5 = "NetFlow v5"
 
-class NetflowRecordIpv4Match(BaseModel):
+
+class NetflowRecordIpv4Match(ContainerEntry, BaseModel):
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",)
+    name: AttributeValue[str]
     # Leaf-level ipv4 matches (Cisco style "match ipv4 <field>"). True = match this field, False = No. None = Ignore the field
-    netflow_record: Optional[AttributeValue[str]] = None # Reference to parent record, used for easier access in config component
+    netflow_record: Optional[AttributeValue[str]] = None  # Reference to parent record, used for easier access in config component
     dscp: Optional[AttributeValue[bool]] = None
     fragmentation: Optional[AttributeValue[bool]] = None
     header_length: Optional[AttributeValue[bool]] = None
@@ -793,35 +849,46 @@ class NetflowRecordIpv4Match(BaseModel):
     ttl: Optional[AttributeValue[bool]] = None
     version: Optional[AttributeValue[bool]] = None
 
-class NetflowRecordAttributes(BaseModel): # Cisco flow record
+
+class NetflowRecordAttributes(ContainerEntry, BaseModel):  # Cisco flow record
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",)
+    name: AttributeValue[str]
     match_ipv4: Optional[NetflowRecordIpv4Match] = None
-    #match_ipv4: Optional[Dict[str, NetflowRecordIpv4Match]] = {}
+    # match_ipv4: Optional[Dict[str, NetflowRecordIpv4Match]] = {}
     application_name: Optional[AttributeValue[bool]] = None
 
     # Escape hatch for vendor-specific match knobs not yet modeled
-    match_vendor_specific: Optional[AttributeValue[Dict[str, Any]]] = None # keeping a flexible option if needed. Not advertised to users.
+    match_vendor_specific: Optional[AttributeValue[Dict[str, Any]]] = None  # keeping a flexible option if needed. Not advertised to users.
 
     collect_timestamp_absolute_first: Optional[AttributeValue[bool]] = None
     collect_timestamp_absolute_last: Optional[AttributeValue[bool]] = None
 
-class NetflowCollectorAttributes(BaseModel): # Cisco flow monitor
-    netflow_record: Optional[AttributeValue[str]] = None # Reference to record, used for easier access in config component
-    netflow_exporter: Optional[AttributeValue[str]] = None # Reference to exporter, used for easier access in config component
+
+class NetflowCollectorAttributes(ContainerEntry, BaseModel):  # Cisco flow monitor
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",)
+    name: AttributeValue[str]
+    records: Optional[Dict[str, Reference]] = {} # References to records, used for easier access in config component
+    exporters: Optional[Dict[str, Reference]] = {} # References to exporters, used for easier access in config component
     cache_inactive: Optional[AttributeValue[int]] = None
     cache_active: Optional[AttributeValue[int]] = None
     interfaces: Optional[Dict[str, Reference]] = {} # allow for disabling netflow on specific interfaces
 
-class NetflowExporterOptions(BaseModel):
+
+class NetflowExporterOptions(ContainerEntry, BaseModel):
     # Mostly timeouts atm
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",)
+    name: AttributeValue[str]
     interface_table_timeout: Optional[AttributeValue[int]] = None
     vrf_table_timeout: Optional[AttributeValue[int]] = None
     sampler_table: Optional[AttributeValue[bool]] = None
     application_table_timeout: Optional[AttributeValue[int]] = None
     application_attributes_timeout: Optional[AttributeValue[int]] = None
-    netflow_exporter: Optional[AttributeValue[str]] = None # Reference to parent exporter, used for easier access in config component
+    netflow_exporter: Optional[AttributeValue[str]] = None  # Reference to parent exporter, used for easier access in config component
 
-class NetflowExporterAttributes(ContainerEntry, BaseModel): # Cisco flow exporter
-    identity_fields: ClassVar[tuple[str, ...]] = ("address",)
+
+class NetflowExporterAttributes(ContainerEntry, BaseModel):  # Cisco flow exporter
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",)
+    name: AttributeValue[str]
     address: Optional[AttributeValue[str]] = None
     port: Optional[AttributeValue[int]] = None
     netflow_format: Optional[AttributeValue[str]] = None
@@ -829,10 +896,14 @@ class NetflowExporterAttributes(ContainerEntry, BaseModel): # Cisco flow exporte
     network_instance: Optional[AttributeValue[str]] = None
     options: Optional[NetflowExporterOptions] = None
 
-class NetflowGlobalConfigAttributes(BaseModel):
+
+class NetflowGlobalConfigAttributes(ContainerEntry, BaseModel):
+    identity_fields: ClassVar[tuple[str, ...]] = ("name",)
+    name: AttributeValue[str]
     enabled: Optional[AttributeValue[bool]] = None
     version: Optional[AttributeValue[int]] = None
 
+
 class Netflow(BaseModel):
     config: Optional[NetflowGlobalConfigAttributes] = None
     records: Optional[Dict[str, NetflowRecordAttributes]] = {}
@@ -909,6 +980,7 @@ InterfaceType = Union[
     ManagementInterface,
 ]
 
+
 class ComposedConfiguration(BaseModel):
     system: Optional[System] = System()
     acl: Optional[Acl] = Acl()