catalystwan 0.41.6.dev6__tar.gz → 0.41.6.dev8__tar.gz

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: catalystwan
-Version: 0.41.6.dev6
+Version: 0.41.6.dev8
 Summary: Cisco Catalyst WAN SDK for Python
 Author: sbasan
 Author-email: sbasan@cisco.com

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/catalystwan/models/common.py

@@ -100,11 +100,11 @@ class VersionedField:
         return model_dict
 
 
-def check_fields_exclusive(values: Dict, field_names: Set[str], at_least_one: bool = False) -> bool:
+def check_fields_exclusive(values: Mapping[str, Any], field_names: Set[str], at_least_one: bool = False) -> bool:
     """Helper method to check fields are mutually exclusive
 
     Args:
-        values (Dict): BaseModel field values
+        values (Mapping[str, Any]): BaseModel field values
         field_names (Set[str]): set of field names that we want to be mutually exclusive
         at_least_one (bool, optional): Additionaly check if at least one of fields is not None
 
@@ -122,13 +122,13 @@ def check_fields_exclusive(values: Dict, field_names: Set[str], at_least_one: bo
     return True if len(assigned) > 0 else False
 
 
-def check_any_of_exclusive_field_sets(values: Dict, field_sets: List[Tuple[Set[str], bool]]):
+def check_any_of_exclusive_field_sets(values: Mapping[str, Any], field_sets: List[Tuple[Set[str], bool]]):
     """This is very specific validator but common in policy definitions model.
     It checks that fields in each of the sets are mutually exclusive and also
     guarantees that at least one of the values is present from all sets.
 
     Args:
-        values (Dict): BaseModel field values
+        values (Mapping[str, Any]): BaseModel field values
         field_sets (Set[Tuple[Set[str]], bool]): Set of tuples each tuple should
         contain field names set and flag to check if at least one of fields is present within a set
 
@@ -145,6 +145,20 @@ def check_any_of_exclusive_field_sets(values: Dict, field_sets: List[Tuple[Set[s
         raise ValueError(f"One of {all_sets_field_names} must be assigned")
 
 
+def check_any_of_fields(values: Mapping[str, Any], field_names: Set[str]):
+    """Checks if at least one of fields is set
+    Args:
+            values (Mapping[str, Any]): BaseModel field values
+            field_names (Set[str]): set of field names that we want to be set
+
+        Raises:
+            ValueError: When none of fields are set
+    """
+    assigned = [k for k, v in values.items() if v is not None]
+    if not field_names & set(assigned):
+        raise ValueError(f"One of {field_names} must be assigned")
+
+
 def str_as_uuid_list(val: Union[str, Sequence[UUID]]) -> Sequence[UUID]:
     if isinstance(val, str):
         return [UUID(uuid_) for uuid_ in val.split()]

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/catalystwan/models/configuration/feature_profile/sdwan/policy_object/__init__.py

@@ -17,7 +17,7 @@ from .policy.ipv6_data_prefix import IPv6DataPrefixEntry, IPv6DataPrefixParcel
 from .policy.ipv6_prefix_list import IPv6PrefixListEntry, IPv6PrefixListParcel
 from .policy.mirror import MirrorParcel
 from .policy.policer import PolicerEntry, PolicerParcel
-from .policy.prefered_group_color import Preference, PreferredColorGroupEntry, PreferredColorGroupParcel
+from .policy.preferred_color_group import Preference, PreferredColorGroupEntry, PreferredColorGroupParcel
 from .policy.prefix_list import PrefixListEntry, PrefixListParcel
 from .policy.service_object_group import ServiceObjectGroupParcel
 from .policy.sla_class import FallbackBestTunnel, SLAClassCriteria, SLAClassListEntry, SLAClassParcel

catalystwan-0.41.6.dev8/catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/preferred_color_group.py

@@ -0,0 +1,99 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional
+
+from pydantic import AliasPath, BaseModel, ConfigDict, Field, field_validator, model_validator
+
+from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, _ParcelEntry
+from catalystwan.models.common import TLOCColor, check_any_of_fields
+
+PathPreference = Literal[
+    "direct-path",
+    "multi-hop-path",
+    "all-paths",
+]
+
+
+class Preference(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    color_preference: Optional[Global[List[TLOCColor]]] = Field(
+        default=None, serialization_alias="colorPreference", validation_alias="colorPreference"
+    )
+    path_preference: Optional[Global[PathPreference]] = Field(
+        default=None, serialization_alias="pathPreference", validation_alias="pathPreference"
+    )
+
+    @model_validator(mode="after")
+    def check_color_or_path(self):
+        check_any_of_fields(self.__dict__, {"color_preference", "path_preference"})
+        return self
+
+
+class PreferredColorGroupEntry(_ParcelEntry):
+    model_config = ConfigDict(populate_by_name=True)
+    primary_preference: Preference = Field(
+        serialization_alias="primaryPreference", validation_alias="primaryPreference"
+    )
+    secondary_preference: Optional[Preference] = Field(
+        default=None, serialization_alias="secondaryPreference", validation_alias="secondaryPreference"
+    )
+    tertiary_preference: Optional[Preference] = Field(
+        default=None, serialization_alias="tertiaryPreference", validation_alias="tertiaryPreference"
+    )
+
+    @model_validator(mode="after")
+    def check_preference_precedence(self) -> "PreferredColorGroupEntry":
+        if not self.secondary_preference and self.tertiary_preference:
+            raise IndexError("Preference Entry has to have a secondary prefrence when assigning tertiary preference.")
+        return self
+
+    @field_validator("secondary_preference", "tertiary_preference", mode="before")
+    @classmethod
+    def remove_empty_preferences(cls, value):
+        """handle a situation when server returns empty json object: '{}'"""
+        if not value:
+            return None
+        return value
+
+
+class PreferredColorGroupParcel(_ParcelBase):
+    model_config = ConfigDict(populate_by_name=True)
+    type_: Literal["preferred-color-group"] = Field(default="preferred-color-group", exclude=True)
+    entries: List[PreferredColorGroupEntry] = Field(default_factory=list, validation_alias=AliasPath("data", "entries"))
+
+    @staticmethod
+    def _create_preference(color_preference: List[TLOCColor], path_preference: Optional[PathPreference]) -> Preference:
+        _color_preference = None
+        _path_preference = None
+        if color_preference:
+            _color_preference = Global[List[TLOCColor]](value=color_preference)
+        if path_preference:
+            _path_preference = Global[PathPreference](value=path_preference)
+        return Preference(color_preference=_color_preference, path_preference=_path_preference)
+
+    def add_primary(self, color_preference: List[TLOCColor], path_preference: Optional[PathPreference]):
+        self.entries.append(
+            PreferredColorGroupEntry(
+                primary_preference=PreferredColorGroupParcel._create_preference(color_preference, path_preference),
+                secondary_preference=None,
+                tertiary_preference=None,
+            )
+        )
+
+    def add_secondary(self, color_preference: List[TLOCColor], path_preference: Optional[PathPreference]):
+        preferred_color = self.entries[0]
+        if preferred_color.primary_preference is None:
+            raise IndexError("Preference Entry has to have a primary prefrence when assigning secondary preference.")
+        preferred_color.secondary_preference = PreferredColorGroupParcel._create_preference(
+            color_preference, path_preference
+        )
+
+    def add_tertiary(self, color_preference: List[TLOCColor], path_preference: Optional[PathPreference]):
+        preferred_color = self.entries[0]
+        if preferred_color.primary_preference is None or preferred_color.secondary_preference is None:
+            raise IndexError(
+                "Preference Entry has to have a primary and secondary prefrence when assigning secondary preference."
+            )
+        preferred_color.tertiary_preference = PreferredColorGroupParcel._create_preference(
+            color_preference, path_preference
+        )

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/catalystwan/models/configuration/feature_profile/sdwan/system/logging_parcel.py

@@ -59,6 +59,7 @@ class Server(BaseModel):
 
 
 class File(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
     disk_file_size: Optional[Union[Global[int], Default[int], Variable]] = Field(
         default=as_default(10), serialization_alias="diskFileSize", validation_alias="diskFileSize"
     )
@@ -68,7 +69,8 @@ class File(BaseModel):
 
 
 class Disk(BaseModel):
-    disk_enable: Optional[Global[bool]] = Field(
+    model_config = ConfigDict(populate_by_name=True)
+    disk_enable: Optional[Union[Global[bool], Variable]] = Field(
         default=None, serialization_alias="diskEnable", validation_alias="diskEnable"
     )
     file: File = Field(default_factory=File)
@@ -99,9 +101,9 @@ class LoggingParcel(_ParcelBase):
             TlsProfile(
                 profile=as_global(profile),
                 version=as_global(version, TlsVersion),
-                ciphersuite_list=Global[List[CypherSuite]](value=ciphersuite_list)
-                if ciphersuite_list
-                else Default[None](value=None),
+                ciphersuite_list=(
+                    Global[List[CypherSuite]](value=ciphersuite_list) if ciphersuite_list else Default[None](value=None)
+                ),
             )
         )
 

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/catalystwan/models/policy/definition/app_route.py

@@ -17,7 +17,7 @@ from catalystwan.models.common import (
 )
 from catalystwan.models.policy.policy_definition import (
     AppListEntry,
-    BackupSlaPrefferedColorAction,
+    BackupSlaPreferredColorAction,
     CloudSaaSAction,
     CountAction,
     DefinitionWithSequencesCommonBase,
@@ -82,7 +82,7 @@ AppRoutePolicySequenceEntry = Annotated[
 
 AppRoutePolicySequenceActionEntry = Annotated[
     Union[
-        BackupSlaPrefferedColorAction,
+        BackupSlaPreferredColorAction,
         CloudSaaSAction,
         CountAction,
         LogAction,
@@ -162,7 +162,7 @@ class AppRoutePolicySequence(PolicyDefinitionSequenceBase):
         self._insert_match(TrafficToEntry(value=traffic_to))
 
     def associate_backup_sla_preferred_color_action(self, tloc_colors: List[TLOCColor]) -> None:
-        self._insert_action(BackupSlaPrefferedColorAction(parameter=tloc_colors))
+        self._insert_action(BackupSlaPreferredColorAction(parameter=tloc_colors))
 
     def associate_cloud_saas_action(self) -> None:
         self._insert_action(CloudSaaSAction())
@@ -176,14 +176,12 @@ class AppRoutePolicySequence(PolicyDefinitionSequenceBase):
     @overload
     def associate_sla_class_action(
         self, sla_class: UUID, not_met_action: Optional[SlaNotMetAction] = None, *, preferred_color: List[TLOCColor]
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @overload
     def associate_sla_class_action(
         self, sla_class: UUID, not_met_action: Optional[SlaNotMetAction] = None, *, preferred_color_group: UUID
-    ) -> None:
-        ...
+    ) -> None: ...
 
     def associate_sla_class_action(
         self,

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/catalystwan/models/policy/definition/traffic_data.py

@@ -60,9 +60,9 @@ from catalystwan.models.policy.policy_definition import (
     PolicyDefinitionGetResponse,
     PolicyDefinitionId,
     PolicyDefinitionSequenceBase,
+    PreferredColorGroupListEntry,
     PreferredRemoteColorEntry,
     PreferredRemoteColorValue,
-    PrefferedColorGroupListEntry,
     ProtocolEntry,
     RedirectDNSAction,
     SecureInternetGatewayAction,
@@ -234,8 +234,8 @@ class TrafficDataPolicySequence(PolicyDefinitionSequenceBase):
         self._insert_action_in_set(tloc_entry)
 
     @accept_action
-    def associate_preffered_color_group(self, color_group_list_id: UUID, restrict: bool = False) -> None:
-        self._insert_action_in_set(PrefferedColorGroupListEntry(ref=color_group_list_id, color_restrict=restrict))
+    def associate_preferred_color_group(self, color_group_list_id: UUID, restrict: bool = False) -> None:
+        self._insert_action_in_set(PreferredColorGroupListEntry(ref=color_group_list_id, color_restrict=restrict))
 
     @accept_action
     def associate_preferred_remote_color(self, color_group_list_id: TLOCColor, restrict: bool = False) -> None:

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/catalystwan/models/policy/list/sla.py

@@ -52,6 +52,22 @@ class SLAClassListEntry(BaseModel):
         default=None, serialization_alias="fallbackBestTunnel", validation_alias="fallbackBestTunnel"
     )
 
+    def configure_fallback_best_tunnel(
+        self,
+        criteria: Optional[SLAClassCriteria] = None,
+        jitter_variance: Optional[int] = None,
+        latency_variance: Optional[int] = None,
+        loss_variance: Optional[int] = None,
+    ) -> FallbackBestTunnel:
+        tunnel = FallbackBestTunnel(
+            criteria=criteria,
+            jitter_variance=jitter_variance,
+            latency_variance=latency_variance,
+            loss_variance=loss_variance,
+        )
+        self.fallback_best_tunnel = tunnel
+        return tunnel
+
 
 class SLAClassList(PolicyListBase):
     type: Literal["sla"] = "sla"

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/catalystwan/models/policy/policy_definition.py

@@ -897,7 +897,7 @@ class DestinationVpnEntry(BaseModel):
     value: str = Field(description="VPN ids numbers separated by space")
 
 
-class PrefferedColorGroupListEntry(BaseModel):
+class PreferredColorGroupListEntry(BaseModel):
     field: Literal["preferredColorGroup"] = "preferredColorGroup"
     ref: UUID
     color_restrict: bool = Field(False, serialization_alias="colorRestrict", validation_alias="colorRestrict")
@@ -1154,7 +1154,7 @@ class AdvancedInspectionProfileAction(BaseModel):
     parameter: ReferenceWithId
 
 
-class BackupSlaPrefferedColorAction(BaseModel):
+class BackupSlaPreferredColorAction(BaseModel):
     type: Literal["backupSlaPreferredColor"] = "backupSlaPreferredColor"
     parameter: SpaceSeparatedTLOCColorStr
 
@@ -1264,7 +1264,7 @@ ActionSetEntry = Annotated[
         OspfTagEntry,
         PolicerListEntry,
         PreferenceEntry,
-        PrefferedColorGroupListEntry,
+        PreferredColorGroupListEntry,
         PreferredRemoteColorEntry,
         ServiceChainEntry,
         ServiceEntry,
@@ -1288,7 +1288,7 @@ ActionEntry = Annotated[
     Union[
         ActionSet,
         AdvancedInspectionProfileAction,
-        BackupSlaPrefferedColorAction,
+        BackupSlaPreferredColorAction,
         CFlowDAction,
         ClassMapAction,
         CloudSaaSAction,

catalystwan-0.41.6.dev8/catalystwan/tests/models/configuration/feature_profile/sdwan/policy_object/policy/test_preferred_color_group_parcel.py

@@ -0,0 +1,54 @@
+# Copyright 2026 Cisco Systems, Inc. and its affiliates
+
+import pytest
+from pydantic import ValidationError
+
+from catalystwan.models.configuration.feature_profile.sdwan.policy_object.policy.preferred_color_group import (
+    PreferredColorGroupParcel,
+)
+
+
+def test_create_preferred_color_group_parcel():
+    # Arrange / Act
+    parcel = PreferredColorGroupParcel(parcel_name="test")
+    parcel.add_primary(["gold", "silver"], "direct-path")
+    parcel.add_secondary(["bronze"], None)
+    parcel.add_tertiary([], "all-paths")
+
+    # Assert
+    assert len(parcel.entries) == 1
+    entry = parcel.entries[0]
+
+    assert entry.primary_preference.color_preference is not None
+    assert entry.primary_preference.color_preference.value == ["gold", "silver"]
+    assert entry.primary_preference.path_preference is not None
+    assert entry.primary_preference.path_preference.value == "direct-path"
+
+    assert entry.secondary_preference is not None
+    assert entry.secondary_preference.color_preference is not None
+    assert entry.secondary_preference.color_preference.value == ["bronze"]
+    assert entry.secondary_preference.path_preference is None
+
+    assert entry.tertiary_preference is not None
+    assert entry.tertiary_preference.color_preference is None
+    assert entry.tertiary_preference.path_preference is not None
+    assert entry.tertiary_preference.path_preference.value == "all-paths"
+
+
+def test_index_error_on_creating_secondary_without_primary():
+    parcel = PreferredColorGroupParcel(parcel_name="test")
+    with pytest.raises(IndexError):
+        parcel.add_secondary(["blue"], "all-paths")
+
+
+def test_index_error_on_creating_teritary_without_secondary():
+    parcel = PreferredColorGroupParcel(parcel_name="test")
+    parcel.add_primary(["gold", "silver"], "direct-path")
+    with pytest.raises(IndexError):
+        parcel.add_tertiary(["blue"], "all-paths")
+
+
+def test_validation_error_on_missing_one_of_preferences():
+    parcel = PreferredColorGroupParcel(parcel_name="test")
+    with pytest.raises(ValidationError):
+        parcel.add_primary([], None)

{catalystwan-0.41.6.dev6 → catalystwan-0.41.6.dev8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "catalystwan"
-version = "0.41.6dev6"
+version = "0.41.6dev8"
 description = "Cisco Catalyst WAN SDK for Python"
 authors = ["sbasan <sbasan@cisco.com>"]
 readme = "README.md"

catalystwan-0.41.6.dev6/catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/prefered_group_color.py

@@ -1,83 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-from typing import List, Literal, Optional
-
-from pydantic import AliasPath, BaseModel, ConfigDict, Field, field_validator, model_validator
-
-from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, _ParcelEntry, as_global
-from catalystwan.models.common import TLOCColor
-
-PathPreference = Literal[
-    "direct-path",
-    "multi-hop-path",
-    "all-paths",
-]
-
-
-class Preference(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    color_preference: Global[List[TLOCColor]] = Field(
-        serialization_alias="colorPreference", validation_alias="colorPreference"
-    )
-    path_preference: Global[PathPreference] = Field(
-        serialization_alias="pathPreference", validation_alias="pathPreference"
-    )
-
-
-class PreferredColorGroupEntry(_ParcelEntry):
-    model_config = ConfigDict(populate_by_name=True)
-    primary_preference: Preference = Field(
-        serialization_alias="primaryPreference", validation_alias="primaryPreference"
-    )
-    secondary_preference: Optional[Preference] = Field(
-        None, serialization_alias="secondaryPreference", validation_alias="secondaryPreference"
-    )
-    tertiary_preference: Optional[Preference] = Field(
-        None, serialization_alias="tertiaryPreference", validation_alias="tertiaryPreference"
-    )
-
-    @model_validator(mode="after")
-    def check_passwords_match(self) -> "PreferredColorGroupEntry":
-        if not self.secondary_preference and self.tertiary_preference:
-            raise ValueError("Preference Entry has to have a secondary prefrence when assigning tertiary preference.")
-        return self
-
-    @field_validator("secondary_preference", "tertiary_preference", mode="before")
-    @classmethod
-    def remove_empty_preferences(cls, value):
-        """handle a situation when server returns empty json object: '{}'"""
-        if not value:
-            return None
-        return value
-
-
-class PreferredColorGroupParcel(_ParcelBase):
-    model_config = ConfigDict(populate_by_name=True)
-    type_: Literal["preferred-color-group"] = Field(default="preferred-color-group", exclude=True)
-    entries: List[PreferredColorGroupEntry] = Field(default_factory=list, validation_alias=AliasPath("data", "entries"))
-
-    def add_primary(self, color_preference: List[TLOCColor], path_preference: PathPreference):
-        self.entries.append(
-            PreferredColorGroupEntry(
-                primary_preference=Preference(
-                    color_preference=Global[List[TLOCColor]](value=color_preference),
-                    path_preference=as_global(path_preference, PathPreference),
-                ),
-                secondary_preference=None,
-                tertiary_preference=None,
-            )
-        )
-
-    def add_secondary(self, color_preference: List[TLOCColor], path_preference: PathPreference):
-        preferred_color = self.entries[0]
-        preferred_color.secondary_preference = Preference(
-            color_preference=Global[List[TLOCColor]](value=color_preference),
-            path_preference=as_global(path_preference, PathPreference),
-        )
-
-    def add_tertiary(self, color_preference: List[TLOCColor], path_preference: PathPreference):
-        preferred_color = self.entries[0]
-        preferred_color.tertiary_preference = Preference(
-            color_preference=Global[List[TLOCColor]](value=color_preference),
-            path_preference=as_global(path_preference, PathPreference),
-        )