catalystwan 0.40.0.dev1__tar.gz → 0.40.0.dev3__tar.gz

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: catalystwan
-Version: 0.40.0.dev1
+Version: 0.40.0.dev3
 Summary: Cisco Catalyst WAN SDK for Python
 Home-page: https://github.com/cisco-en-programmability/catalystwan-sdk
 Author: kagorski

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/api/builders/feature_profiles/builder_factory.py

@@ -9,6 +9,7 @@ from catalystwan.api.builders.feature_profiles.other import OtherFeatureProfileB
 from catalystwan.api.builders.feature_profiles.service import ServiceFeatureProfileBuilder
 from catalystwan.api.builders.feature_profiles.system import SystemFeatureProfileBuilder
 from catalystwan.api.builders.feature_profiles.transport import TransportAndManagementProfileBuilder
+from catalystwan.api.builders.feature_profiles.uc_voice import UcVoiceFeatureProfileBuilder
 from catalystwan.exceptions import CatalystwanException
 from catalystwan.models.configuration.feature_profile.common import ProfileType
 
@@ -31,6 +32,7 @@ BUILDER_MAPPING: Mapping[ProfileType, Callable] = {
     "transport": TransportAndManagementProfileBuilder,
     "cli": CliFeatureProfileBuilder,
     "application-priority": ApplicationPriorityFeatureProfileBuilder,
+    "uc-voice": UcVoiceFeatureProfileBuilder,
 }
 
 

catalystwan-0.40.0.dev3/catalystwan/api/builders/feature_profiles/uc_voice.py

@@ -0,0 +1,116 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from __future__ import annotations
+
+import logging
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, List, Optional
+from uuid import UUID
+
+from catalystwan.api.builders.feature_profiles.report import FeatureProfileBuildReport, handle_build_report
+from catalystwan.api.feature_profile_api import UcVoiceFeatureProfileAPI
+from catalystwan.endpoints.configuration.feature_profile.sdwan.uc_voice import UcVoiceFeatureProfile
+from catalystwan.models.configuration.feature_profile.common import FeatureProfileCreationPayload
+from catalystwan.models.configuration.feature_profile.sdwan.uc_voice import (
+    AnyUcVoiceParcel,
+    TranslationProfileParcel,
+    TranslationRuleParcel,
+)
+
+logger = logging.getLogger(__name__)
+
+if TYPE_CHECKING:
+    from catalystwan.session import ManagerSession
+
+
+@dataclass
+class TranslationProfile:
+    tpp: TranslationProfileParcel
+    calling: Optional[TranslationRuleParcel] = None
+    called: Optional[TranslationRuleParcel] = None
+
+
+class UcVoiceFeatureProfileBuilder:
+    """
+    A class for building UcVoice feature profiles.
+    """
+
+    def __init__(self, session: ManagerSession) -> None:
+        """
+        Initialize a new instance of the Service class.
+
+        Args:
+            session (ManagerSession): The ManagerSession object used for API communication.
+            profile_uuid (UUID): The UUID of the profile.
+        """
+        self._profile: FeatureProfileCreationPayload
+        self._api = UcVoiceFeatureProfileAPI(session)
+        self._endpoints = UcVoiceFeatureProfile(session)
+        self._independent_items: List[AnyUcVoiceParcel] = []
+        self._translation_profiles: List[TranslationProfile] = []
+
+    def add_profile_name_and_description(self, feature_profile: FeatureProfileCreationPayload) -> None:
+        """
+        Adds a name and description to the feature profile.
+
+        Args:
+            name (str): The name of the feature profile.
+            description (str): The description of the feature profile.
+
+        Returns:
+            None
+        """
+        self._profile = feature_profile
+
+    def add_parcel(self, parcel: AnyUcVoiceParcel) -> None:
+        """
+        Adds a parcel to the feature profile.
+
+        Args:
+            parcel (AnySystemParcel): The parcel to add.
+
+        Returns:
+            None
+        """
+        self._independent_items.append(parcel)
+
+    def add_translation_profile(
+        self,
+        tpp: TranslationProfileParcel,
+        calling: Optional[TranslationRuleParcel] = None,
+        called: Optional[TranslationRuleParcel] = None,
+    ):
+        if not calling and not called:
+            raise ValueError("There must be at least one translation rule to create a translation profile")
+        self._translation_profiles.append(TranslationProfile(tpp=tpp, called=called, calling=calling))
+
+    def build(self) -> FeatureProfileBuildReport:
+        """
+        Builds the feature profile.
+
+        Returns:
+            UUID: The UUID of the created feature profile.
+        """
+
+        profile_uuid = self._endpoints.create_uc_voice_feature_profile(self._profile).id
+        self.build_report = FeatureProfileBuildReport(profile_uuid=profile_uuid, profile_name=self._profile.name)
+        for parcel in self._independent_items:
+            self._create_parcel(profile_uuid, parcel)
+        for tp in self._translation_profiles:
+            self._create_translation_profile(profile_uuid, tp)
+
+        return self.build_report
+
+    @handle_build_report
+    def _create_parcel(self, profile_uuid: UUID, parcel: AnyUcVoiceParcel) -> UUID:
+        return self._api.create_parcel(profile_uuid, parcel).id
+
+    def _create_translation_profile(self, profile_uuid: UUID, tp: TranslationProfile):
+        if tp.called:
+            called_uuid = self._create_parcel(profile_uuid, tp.called)
+            if called_uuid:
+                tp.tpp.set_ref_by_call_type(called_uuid, "called")
+        if tp.calling:
+            calling_uuid = self._create_parcel(profile_uuid, tp.calling)
+            if calling_uuid:
+                tp.tpp.set_ref_by_call_type(calling_uuid, "calling")
+        self._create_parcel(profile_uuid, tp.tpp)

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/api/templates/models/aaa_model.py

@@ -131,7 +131,7 @@ class RadiusServer(FeatureTemplateValidator):
         description="The accounting port for the RADIUS server",
     )
     vpn: Optional[str] = Field(
-        default=0,
+        default="0",
         json_schema_extra={"vmanage_key": "vpn"},
         description="Set VPN in which RADIUS server is located",
     )
@@ -159,7 +159,7 @@ class TacacsServer(FeatureTemplateValidator):
         description="The authentication port for the TACACS+ server",
     )
     vpn: Optional[str] = Field(
-        default=0,
+        default="0",
         json_schema_extra={"vmanage_key": "vpn"},
         description="Set VPN in which TACACS+ server is located",
     )
@@ -185,7 +185,7 @@ class TaskPermissions(FeatureTemplateValidator):
         description="Select the task to set privileges for",
     )
     permission: List[TaskPermission] = Field(
-        default="pap",
+        default=["read"],  # type: ignore
         json_schema_extra={
             "vmanage_key": "permission",
         },
@@ -207,7 +207,7 @@ class UserGroup(FeatureTemplateValidator):
         json_schema_extra={"vmanage_key": "name"},
         description="Set name of user group",
     )
-    task: List[TaskPermissions] = Field(
+    task: Optional[List[TaskPermissions]] = Field(
         default=None,
         json_schema_extra={"vmanage_key": "task", "priority_order": ["mode", "permission"]},
         description="Set the user group's tasks and task privileges. Skipping tasks sets all as read and write",
@@ -220,7 +220,7 @@ class AAAModel(FeatureTemplate):
 
     auth_order: Optional[List[AuthenticationOrder]] = Field(
         validate_default=True,
-        default=["local", "radius", "tacacs"],
+        default=["local", "radius", "tacacs"],  # type: ignore
         json_schema_extra={"vmanage_key": "auth-order", "data_path": ["aaa"]},
         description="ServerGroups authentication order to user access",
     )

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/api/templates/models/cisco_aaa_model.py

@@ -138,7 +138,7 @@ class RadiusGroup(FeatureTemplateValidator):
         json_schema_extra={"vmanage_key": "group-name"},
         description="The name of the RADIUS group",
     )
-    vpn: Optional[int] = Field(description="The VPN ID for the RADIUS group")
+    vpn: Optional[int] = Field(default=None, description="The VPN ID for the RADIUS group")
     source_interface: Optional[str] = Field(
         json_schema_extra={"vmanage_key": "source-interface"},
         description="The source interface for the RADIUS group",
@@ -154,7 +154,6 @@ class RadiusVPN(FeatureTemplateValidator):
         },
     )
     server_key: str = Field(
-        default=None,
         description="Specify a RADIUS client server-key",
         json_schema_extra={
             "vmanage_key": "server-key",

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/api/templates/models/cisco_system.py

@@ -1,7 +1,7 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
 from pathlib import Path
-from typing import ClassVar, List, Literal, Optional
+from typing import ClassVar, List, Literal, Optional, Union
 
 from pydantic import ConfigDict, Field
 
@@ -176,7 +176,7 @@ class CiscoSystemModel(FeatureTemplate):
     overlay_id: Optional[int] = Field(
         default=None, description="The overlay ID of the device.", json_schema_extra={"vmanage_key": "overlay-id"}
     )
-    site_id: int = Field(
+    site_id: Union[int, DeviceVariable] = Field(
         default=DeviceVariable(name="system_site_id"),
         description="The site ID of the device.",
         json_schema_extra={"vmanage_key": "site-id"},

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/api/templates/models/cisco_vpn_model.py

@@ -260,7 +260,6 @@ class Natpool(FeatureTemplateValidator):
         json_schema_extra={"vmanage_key": "prefix-length"},
     )
     range_start: str = Field(
-        default=None,
         description="The starting IP address for the NAT pool range.",
         json_schema_extra={"vmanage_key": "range-start"},
     )

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/api/templates/models/system_vsmart_model.py

@@ -68,7 +68,7 @@ class SystemVsmart(FeatureTemplate):
         description="Geographical longitude of the vSmart controller",
     )
     device_groups: List[str] = Field(
-        default=None,
+        default_factory=list,
         json_schema_extra={"vmanage_key": "device-groups"},
         description="Device group names for the vSmart controller",
     )

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/api/templates/models/vpn_vsmart_interface_model.py

@@ -30,7 +30,7 @@ class VpnVsmartInterfaceModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
     _docs_description: str = "vSmart VPN Interface Feature Template configuration"
 
-    if_name: str = Field(
+    if_name: Optional[str] = Field(
         default=None, description="The name of the interface.", json_schema_extra={"vmanage_key": "if-name"}
     )
     interface_description: Optional[str] = Field(

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/endpoints/configuration/software_actions.py

@@ -100,8 +100,8 @@ class RemoteServerInfo(BaseModel):
 class SoftwareRemoteServer(BaseModel):
     model_config = ConfigDict(populate_by_name=True)
 
-    filename: str = Field(default=None, serialization_alias="fileName", validation_alias="fileName")
-    remote_server_id: str = Field(default=None, serialization_alias="remoteServerId", validation_alias="remoteServerId")
+    filename: str = Field(serialization_alias="fileName", validation_alias="fileName")
+    remote_server_id: str = Field(serialization_alias="remoteServerId", validation_alias="remoteServerId")
     smu_defect_id: Optional[str] = Field(
         default=None, serialization_alias="smuDefectId", validation_alias="smuDefectId"
     )
@@ -158,7 +158,9 @@ class SoftwareImageDetails(BaseModel):
     vnf_properties_json: Optional[str] = Field(
         default=None, serialization_alias="vnfPropertiesJson", validation_alias="vnfPropertiesJson"
     )
-    remote_server_id: str = Field(default=None, serialization_alias="remoteServerId", validation_alias="remoteServerId")
+    remote_server_id: Optional[str] = Field(
+        default=None, serialization_alias="remoteServerId", validation_alias="remoteServerId"
+    )
 
 
 class ConfigurationSoftwareActions(APIEndpoints):

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/endpoints/configuration_dashboard_status.py

@@ -61,7 +61,7 @@ class Validation(BaseModel):
     device_id: Optional[str] = Field(default=None, serialization_alias="deviceID", validation_alias="deviceID")
     uuid: Optional[str] = Field(default=None, serialization_alias="uuid", validation_alias="uuid")
     rid: Optional[int] = Field(default=None, serialization_alias="@rid", validation_alias="@rid")
-    status_id: str = Field(default=None, serialization_alias="statusId", validation_alias="statusId")
+    status_id: str = Field(serialization_alias="statusId", validation_alias="statusId")
     process_id: Optional[str] = Field(default=None, serialization_alias="processId", validation_alias="processId")
     action_config: Optional[Union[str, Dict]] = Field(
         default=None, serialization_alias="actionConfig", validation_alias="actionConfig"
@@ -74,7 +74,7 @@ class Validation(BaseModel):
     request_status: Optional[str] = Field(
         default=None, serialization_alias="requestStatus", validation_alias="requestStatus"
     )
-    status: OperationStatus = Field(default=None, serialization_alias="status", validation_alias="status")
+    status: OperationStatus = Field(serialization_alias="status", validation_alias="status")
     order: Optional[int] = Field(default=None, serialization_alias="order", validation_alias="order")
 
 

catalystwan-0.40.0.dev3/catalystwan/integration_tests/profile_builder/test_pb_uc_voice.py

@@ -0,0 +1,60 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from catalystwan.api.configuration_groups.parcel import Global
+from catalystwan.integration_tests.base import TestCaseBase, create_name_with_run_id
+from catalystwan.models.configuration.feature_profile.common import FeatureProfileCreationPayload
+from catalystwan.models.configuration.feature_profile.sdwan.uc_voice import (
+    TranslationProfileParcel,
+    TranslationRuleParcel,
+)
+from catalystwan.models.configuration.feature_profile.sdwan.uc_voice.translation_rule import Action, RuleSettings
+
+
+class TestUcVoiceFeatureProfileBuilder(TestCaseBase):
+    def setUp(self) -> None:
+        self.fp_name = create_name_with_run_id("FeatureProfileBuilderUcVoice")
+        self.fp_description = "Transport feature profile"
+        self.builder = self.session.api.builders.feature_profiles.create_builder("uc-voice")
+        self.builder.add_profile_name_and_description(
+            feature_profile=FeatureProfileCreationPayload(name=self.fp_name, description=self.fp_description)
+        )
+        self.api = self.session.api.sdwan_feature_profiles.transport
+
+    def test_when_build_profile_with_translation_profile_and_rules_expect_success(self):
+        tp = TranslationProfileParcel(parcel_name="TPP", parcel_description="TTP_Desc", translation_profile_settings=[])
+        tr_calling = TranslationRuleParcel(
+            parcel_name="2",
+            parcel_description="desc",
+            rule_name=Global[int](value=2),
+            rule_settings=[
+                RuleSettings(
+                    action=Global[Action](value="replace"),
+                    match=Global[str](value="/123/"),
+                    replacement_pattern=Global[str](value="/444/"),
+                    rule_num=Global[int](value=2),
+                )
+            ],
+        )
+        tr_called = TranslationRuleParcel(
+            parcel_name="4",
+            parcel_description="desc",
+            rule_name=Global[int](value=4),
+            rule_settings=[
+                RuleSettings(
+                    action=Global[Action](value="replace"),
+                    match=Global[str](value="/321/"),
+                    replacement_pattern=Global[str](value="/4445/"),
+                    rule_num=Global[int](value=4),
+                )
+            ],
+        )
+        self.builder.add_translation_profile(tp, tr_calling, tr_called)
+        # Act
+        report = self.builder.build()
+        # Assert
+        assert len(report.failed_parcels) == 0
+
+    def tearDown(self) -> None:
+        target_profile = self.api.get_profiles().filter(profile_name=self.fp_name).single_or_default()
+        if target_profile:
+            # In case of a failed test, the profile might not have been created
+            self.api.delete_profile(target_profile.profile_id)

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/models/common.py

@@ -678,15 +678,14 @@ DNSTypeEntryType = Literal[
 
 _PolicyModeType = Literal["security", "unified"]
 
+
 def parse_policy_mode(val: Optional[str]) -> _PolicyModeType:
     if isinstance(val, str) and val == "unified":
         return "unified"
     return "security"
 
-PolicyModeType = Annotated[
-    _PolicyModeType,
-    BeforeValidator(parse_policy_mode)
-]
+
+PolicyModeType = Annotated[_PolicyModeType, BeforeValidator(parse_policy_mode)]
 
 
 CoreRegion = Literal[

{catalystwan-0.40.0.dev1 → catalystwan-0.40.0.dev3}/catalystwan/models/configuration/feature_profile/common.py

@@ -194,9 +194,7 @@ class WANIPv4StaticRoute(BaseModel):
     gateway: Global[Literal["nextHop", "null0", "dhcp"]] = Field(
         default=Global(value="nextHop"), serialization_alias="gateway", validation_alias="gateway"
     )
-    next_hops: Optional[List[NextHop]] = Field(
-        default_factory=list, serialization_alias="nextHop", validation_alias="nextHop"
-    )
+    next_hops: Optional[List[NextHop]] = Field(default=None, serialization_alias="nextHop", validation_alias="nextHop")
     distance: Optional[Global[int]] = Field(default=None, serialization_alias="distance", validation_alias="distance")
 
     def set_to_next_hop(