catalystwan 0.41.2.dev9__py3-none-any.whl → 0.41.3__py3-none-any.whl

catalystwan/endpoints/configuration/policy/list/translation_rules.py

@@ -1,52 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put
-from catalystwan.endpoints.configuration.policy.abstractions import PolicyListEndpoints
-from catalystwan.models.policy.list.translation_rules import (
-    TranslationRulesList,
-    TranslationRulesListEditPayload,
-    TranslationRulesListInfo,
-)
-from catalystwan.models.policy.policy_list import InfoTag, PolicyListId, PolicyListPreview
-from catalystwan.typed_list import DataSequence
-
-
-class ConfigurationPolicyTranslationRulesList(APIEndpoints, PolicyListEndpoints):
-    @post("/template/policy/list/translationrules")
-    def create_policy_list(self, payload: TranslationRulesList) -> PolicyListId:
-        ...
-
-    @delete("/template/policy/list/translationrules/{id}")
-    def delete_policy_list(self, id: UUID) -> None:
-        ...
-
-    @delete("/template/policy/list/translationrules")
-    def delete_policy_lists_with_info_tag(self, params: InfoTag) -> None:
-        ...
-
-    @put("/template/policy/list/translationrules/{id}")
-    def edit_policy_list(self, id: UUID, payload: TranslationRulesListEditPayload) -> None:
-        ...
-
-    @get("/template/policy/list/translationrules/{id}")
-    def get_lists_by_id(self, id: UUID) -> TranslationRulesListInfo:
-        ...
-
-    @get("/template/policy/list/translationrules", "data")
-    def get_policy_lists(self) -> DataSequence[TranslationRulesListInfo]:
-        ...
-
-    @get("/template/policy/list/translationrules/filtered", "data")
-    def get_policy_lists_with_info_tag(self, params: InfoTag) -> DataSequence[TranslationRulesListInfo]:
-        ...
-
-    @post("/template/policy/list/translationrules/preview")
-    def preview_policy_list(self, payload: TranslationRulesList) -> PolicyListPreview:
-        ...
-
-    @get("/template/policy/list/translationrules/preview/{id}")
-    def preview_policy_list_by_id(self, id: UUID) -> PolicyListPreview:
-        ...

catalystwan/endpoints/configuration/policy/list/trunkgroup.py

@@ -1,48 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put
-from catalystwan.endpoints.configuration.policy.abstractions import PolicyListEndpoints
-from catalystwan.models.policy.list.trunkgroup import TrunkGroupList, TrunkGroupListEditPayload, TrunkGroupListInfo
-from catalystwan.models.policy.policy_list import InfoTag, PolicyListId, PolicyListPreview
-from catalystwan.typed_list import DataSequence
-
-
-class ConfigurationPolicyTrunkGroupList(APIEndpoints, PolicyListEndpoints):
-    @post("/template/policy/list/trunkgroup")
-    def create_policy_list(self, payload: TrunkGroupList) -> PolicyListId:
-        ...
-
-    @delete("/template/policy/list/trunkgroup/{id}")
-    def delete_policy_list(self, id: UUID) -> None:
-        ...
-
-    @delete("/template/policy/list/trunkgroup")
-    def delete_policy_lists_with_info_tag(self, params: InfoTag) -> None:
-        ...
-
-    @put("/template/policy/list/trunkgroup/{id}")
-    def edit_policy_list(self, id: UUID, payload: TrunkGroupListEditPayload) -> None:
-        ...
-
-    @get("/template/policy/list/trunkgroup/{id}")
-    def get_lists_by_id(self, id: UUID) -> TrunkGroupListInfo:
-        ...
-
-    @get("/template/policy/list/trunkgroup", "data")
-    def get_policy_lists(self) -> DataSequence[TrunkGroupListInfo]:
-        ...
-
-    @get("/template/policy/list/trunkgroup/filtered", "data")
-    def get_policy_lists_with_info_tag(self, params: InfoTag) -> DataSequence[TrunkGroupListInfo]:
-        ...
-
-    @post("/template/policy/list/trunkgroup/preview")
-    def preview_policy_list(self, payload: TrunkGroupList) -> PolicyListPreview:
-        ...
-
-    @get("/template/policy/list/trunkgroup/preview/{id}")
-    def preview_policy_list_by_id(self, id: UUID) -> PolicyListPreview:
-        ...

catalystwan/endpoints/configuration/policy/list/umbrella_data.py

@@ -1,52 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put
-from catalystwan.endpoints.configuration.policy.abstractions import PolicyListEndpoints
-from catalystwan.models.policy.list.umbrella_data import (
-    UmbrellaDataList,
-    UmbrellaDataListEditPayload,
-    UmbrellaDataListInfo,
-)
-from catalystwan.models.policy.policy_list import InfoTag, PolicyListId, PolicyListPreview
-from catalystwan.typed_list import DataSequence
-
-
-class ConfigurationPolicyUmbrellaDataList(APIEndpoints, PolicyListEndpoints):
-    @post("/template/policy/list/umbrelladata")
-    def create_policy_list(self, payload: UmbrellaDataList) -> PolicyListId:
-        ...
-
-    @delete("/template/policy/list/umbrelladata/{id}")
-    def delete_policy_list(self, id: UUID) -> None:
-        ...
-
-    @delete("/template/policy/list/umbrelladata")
-    def delete_policy_lists_with_info_tag(self, params: InfoTag) -> None:
-        ...
-
-    @put("/template/policy/list/umbrelladata/{id}")
-    def edit_policy_list(self, id: UUID, payload: UmbrellaDataListEditPayload) -> None:
-        ...
-
-    @get("/template/policy/list/umbrelladata/{id}")
-    def get_lists_by_id(self, id: UUID) -> UmbrellaDataListInfo:
-        ...
-
-    @get("/template/policy/list/umbrelladata", "data")
-    def get_policy_lists(self) -> DataSequence[UmbrellaDataListInfo]:
-        ...
-
-    @get("/template/policy/list/umbrelladata/filtered", "data")
-    def get_policy_lists_with_info_tag(self, params: InfoTag) -> DataSequence[UmbrellaDataListInfo]:
-        ...
-
-    @post("/template/policy/list/umbrelladata/preview")
-    def preview_policy_list(self, payload: UmbrellaDataList) -> PolicyListPreview:
-        ...
-
-    @get("/template/policy/list/umbrelladata/preview/{id}")
-    def preview_policy_list_by_id(self, id: UUID) -> PolicyListPreview:
-        ...

catalystwan/endpoints/configuration/policy/voice_template.py

@@ -1,39 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import JSON, APIEndpoints, delete, get, post, put
-from catalystwan.models.policy.voice import VoicePolicy, VoicePolicyEditResponse, VoicePolicyInfo
-from catalystwan.typed_list import DataSequence
-
-
-class ConfigurationVoiceTemplatePolicy(APIEndpoints):
-    @post("/template/policy/voice")
-    def create_voice_template(self, payload: VoicePolicy) -> None:
-        ...
-
-    @delete("/template/policy/voice/{id}")
-    def delete_voice_template(self, id: UUID, payload: JSON = {}) -> None:
-        ...
-
-    @put("/template/policy/voice/{id}")
-    def edit_voice_template(self, id: UUID, payload: VoicePolicy) -> VoicePolicyEditResponse:
-        # PUT /template/policy/voice/{policyId}
-        ...
-
-    def generate_voice_policy_summary(self):
-        # GET /template/policy/voice/summary
-        ...
-
-    @get("/template/policy/voice", "data")
-    def generate_voice_template_list(self) -> DataSequence[VoicePolicyInfo]:
-        ...
-
-    @get("/template/policy/voice/definition/{id}")
-    def get_voice_template(self, id: UUID) -> VoicePolicy:
-        ...
-
-    def get_voice_templates_for_device(self):
-        # GET /template/policy/voice/{deviceModel}
-        ...

catalystwan/endpoints/configuration/policy_group.py

@@ -1,30 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.policy_group import PolicyGroup, PolicyGroupId, PolicyGroupInfo
-from catalystwan.typed_list import DataSequence
-
-
-class PolicyGroupEndpoints(APIEndpoints):
-    @post("/v1/policy-group")
-    @versions(">=20.12")
-    def create_policy_group(self, payload: PolicyGroup) -> PolicyGroupId:
-        ...
-
-    @get("/v1/policy-group")
-    @versions(">=20.12")
-    def get_all(self) -> DataSequence[PolicyGroupInfo]:
-        ...
-
-    @put("/v1/policy-group/{group_id}")
-    @versions(">=20.12")
-    def update(self, group_id: UUID, payload: PolicyGroup) -> None:
-        ...
-
-    @delete("/v1/policy-group/{group_id}")
-    @versions(">=20.12")
-    def delete(self, group_id: UUID) -> None:
-        ...

catalystwan/endpoints/configuration/topology_group.py

@@ -1,51 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.topology_group import (
-    ActivateRequest,
-    DeployResponse,
-    Preview,
-    TopologyGroup,
-    TopologyGroupId,
-)
-from catalystwan.typed_list import DataSequence
-
-
-class TopologyGroupEndpoints(APIEndpoints):
-    @post("/v1/topology-group")
-    @versions(">=20.12")
-    def create(self, payload: TopologyGroup) -> TopologyGroupId:
-        ...
-
-    @put("/v1/topology-group/{group_id}")
-    @versions(">=20.12")
-    def edit(self, group_id: UUID, payload: TopologyGroup) -> TopologyGroupId:
-        ...
-
-    @get("/v1/topology-group/{group_id}")
-    @versions(">=20.12")
-    def get_by_id(self, group_id: UUID) -> TopologyGroup:
-        ...
-
-    @get("/v1/topology-group")
-    @versions(">=20.12")
-    def get_all(self) -> DataSequence[TopologyGroupId]:
-        ...
-
-    @delete("/v1/topology-group/{group_id}")
-    @versions(">=20.12")
-    def delete(self, group_id: UUID) -> None:
-        ...
-
-    @post("/v1/topology-group/{group_id}/device/{device_id}/preview")
-    @versions(">=20.12")
-    def preview(self, group_id: UUID, device_id: UUID, payload: ActivateRequest) -> Preview:
-        ...
-
-    @post("/v1/topology-group/{group_id}/device/deploy")
-    @versions(">=20.12")
-    def deploy(self, group_id: UUID, payload: ActivateRequest) -> DeployResponse:
-        ...

catalystwan/endpoints/configuration_general_template.py

@@ -1,31 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from typing import Literal, Optional
-from uuid import UUID
-
-from pydantic import BaseModel, Field
-
-from catalystwan.endpoints import APIEndpoints, get
-from catalystwan.models.templates import FeatureTemplateDefinition, FeatureTemplateInformation
-from catalystwan.typed_list import DataSequence
-
-FeatureType = Literal["all", "vmanage-default", "network-design", "cloud-dock", "lawful-interception"]
-
-
-class FeatureQueryParams(BaseModel):
-    summary: bool = Field(default=False)
-    offset: Optional[int] = Field(default=None)
-    limit: Optional[int] = Field(default=None)
-
-
-class ConfigurationGeneralTemplate(APIEndpoints):
-    @get("/template/feature", "data")
-    def get_feature_template_list(
-        self, params: FeatureQueryParams = FeatureQueryParams()
-    ) -> DataSequence[FeatureTemplateInformation]:
-        ...
-
-    @get("/template/feature/object/{template_id}")
-    def get_template_definition(self, template_id: UUID) -> DataSequence[FeatureTemplateDefinition]:
-        ...

catalystwan/endpoints/configuration_template_master.py

@@ -1,48 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-
-from typing import List, Optional
-from uuid import UUID
-
-from pydantic import BaseModel, ConfigDict, Field
-
-from catalystwan.endpoints import JSON, APIEndpoints, get, post, put
-from catalystwan.models.templates import DeviceTemplateInformation, FeatureType
-from catalystwan.typed_list import DataSequence
-
-
-class TemplateID(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    template_id: UUID = Field(serialization_alias="templateId", validation_alias="templateId")
-
-
-class AttachedDevices(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    attached_devices: Optional[List] = Field(
-        default=[], serialization_alias="AttachedDevices", validation_alias="AttachedDevices"
-    )
-
-
-class FeatureQueryParams(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    feature: FeatureType = Field(default="all")
-
-
-class ConfigurationTemplateMaster(APIEndpoints):
-    @get("/template/device", "data")
-    def get_device_template_list(
-        self, params: FeatureQueryParams = FeatureQueryParams()
-    ) -> DataSequence[DeviceTemplateInformation]:
-        ...
-
-    @post("/template/device/feature")
-    def create_device_template_from_feature_templates(self, payload: JSON) -> TemplateID:
-        ...
-
-    @put("/template/device/{template_id}", "data")
-    def edit_template(self, template_id: str, payload: JSON) -> AttachedDevices:
-        ...

catalystwan/integration_tests/base.py

@@ -1,81 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-import logging
-import os
-import unittest
-from typing import Union
-from uuid import UUID, uuid4
-
-from packaging.version import Version  # type: ignore
-
-from catalystwan.api.builders.feature_profiles.uc_voice import UcVoiceFeatureProfileAPI
-from catalystwan.api.feature_profile_api import (
-    ApplicationPriorityFeatureProfileAPI,
-    CliFeatureProfileAPI,
-    DnsSecurityFeatureProfileAPI,
-    OtherFeatureProfileAPI,
-    ServiceFeatureProfileAPI,
-    SIGSecurityAPI,
-    SystemFeatureProfileAPI,
-    TransportFeatureProfileAPI,
-)
-from catalystwan.exceptions import CatalystwanException
-from catalystwan.session import ManagerSession, create_manager_session
-
-logger = logging.getLogger(__name__)
-
-RUN_ID: str = str(uuid4())[:4]
-
-
-def load_config() -> dict:
-    """Load the configuration from the environment variables"""
-    url = os.environ.get("VMANAGE_URL")
-    port = os.environ.get("VMANAGE_PORT")
-    username = os.environ.get("VMANAGE_USERNAME")
-    password = os.environ.get("VMANAGE_PASSWORD")
-    if url is None or port is None or username is None or password is None:
-        raise CatalystwanException("Missing environment variables")
-    return dict(
-        url=url,
-        username=username,
-        password=password,
-        port=port,
-    )
-
-
-def create_session() -> ManagerSession:
-    """Try to create a session with the environment variables, if it fails, raise an exception"""
-    try:
-        session = create_manager_session(**load_config())
-        return session
-    except Exception:
-        raise CatalystwanException("Failed to create session")
-
-
-SESSION = create_session()
-IS_API_20_12: bool = SESSION.api_version == Version("20.12")
-
-
-def create_name_with_run_id(name: str) -> str:
-    """Prevent collisions when running on the same resource"""
-    return f"{RUN_ID}_{name}"
-
-
-class TestCaseBase(unittest.TestCase):
-    session: ManagerSession
-    profile_uuid: UUID
-
-    api: Union[
-        ApplicationPriorityFeatureProfileAPI,
-        CliFeatureProfileAPI,
-        DnsSecurityFeatureProfileAPI,
-        OtherFeatureProfileAPI,
-        ServiceFeatureProfileAPI,
-        SIGSecurityAPI,
-        SystemFeatureProfileAPI,
-        TransportFeatureProfileAPI,
-        UcVoiceFeatureProfileAPI,
-    ]
-
-    @classmethod
-    def setUpClass(cls) -> None:
-        cls.session = SESSION

catalystwan/integration_tests/feature_profile/sdwan/policy/base.py

@@ -1,33 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from typing import Type
-
-from catalystwan.api.feature_profile_api import PolicyObjectFeatureProfileAPI
-from catalystwan.endpoints.configuration_feature_profile import ConfigurationFeatureProfile
-from catalystwan.integration_tests.base import TestCaseBase
-from catalystwan.models.configuration.feature_profile.sdwan.policy_object import AnyPolicyObjectParcel
-
-
-class PolicyTestCaseBase(TestCaseBase):
-    policy_api: PolicyObjectFeatureProfileAPI
-    parcel_type: Type[AnyPolicyObjectParcel]
-
-    @classmethod
-    def setUpClass(cls) -> None:
-        super().setUpClass()
-        cls.policy_api = cls.session.api.sdwan_feature_profiles.policy_object
-        cls.profile_uuid = (
-            ConfigurationFeatureProfile(cls.session)
-            .get_sdwan_feature_profiles()
-            .filter(profile_type="policy-object")
-            .single_or_default()
-        ).profile_id
-
-    def setUp(self) -> None:
-        self.created_id = None
-        return super().setUp()
-
-    def tearDown(self) -> None:
-        if self.created_id:
-            self.policy_api.delete(self.profile_uuid, self.parcel_type, self.created_id)
-
-        return super().tearDown()

catalystwan/integration_tests/feature_profile/sdwan/policy/test_extended_community.py

@@ -1,33 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-from catalystwan.integration_tests.base import create_name_with_run_id
-from catalystwan.integration_tests.feature_profile.sdwan.policy.base import PolicyTestCaseBase
-from catalystwan.models.configuration.feature_profile.sdwan.policy_object import ExtendedCommunityParcel
-from catalystwan.typed_list import DataSequence
-
-
-class TestExtendedCommunityParcel(PolicyTestCaseBase):
-    parcel_type = ExtendedCommunityParcel
-
-    def test_get_all_parcels(self):
-        parcels = self.policy_api.get(self.profile_uuid, self.parcel_type)
-        assert type(parcels) is DataSequence
-
-    def test_create_extended_community_parcel(self):
-        # Arrange
-        parcel_name = create_name_with_run_id("ext")
-        ext = ExtendedCommunityParcel(parcel_name=parcel_name)
-        ext.add_route_target_community(100, 2000)
-        ext.add_route_target_community(300, 5000)
-        ext.add_site_of_origin_community("1.2.3.4", 1000)
-        ext.add_site_of_origin_community("10.20.30.40", 3000)
-        # Act
-        self.created_id = self.policy_api.create_parcel(self.profile_uuid, ext).id
-        parcel = self.policy_api.get(self.profile_uuid, self.parcel_type, parcel_id=self.created_id)
-        # Assert
-        assert parcel.payload.parcel_name == parcel_name
-        assert len(parcel.payload.entries) == 4
-        assert parcel.payload.entries[0].extended_community.value == "rt 100:2000"
-        assert parcel.payload.entries[1].extended_community.value == "rt 300:5000"
-        assert parcel.payload.entries[2].extended_community.value == "soo 1.2.3.4:1000"
-        assert parcel.payload.entries[3].extended_community.value == "soo 10.20.30.40:3000"

catalystwan/integration_tests/feature_profile/sdwan/policy/test_security_app_list.py

@@ -1,32 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from catalystwan.integration_tests.base import create_name_with_run_id
-from catalystwan.integration_tests.feature_profile.sdwan.policy.base import PolicyTestCaseBase
-from catalystwan.models.configuration.feature_profile.sdwan.policy_object.security.application_list import (
-    SecurityApplicationListParcel,
-)
-from catalystwan.typed_list import DataSequence
-
-
-class TestSecurityApplicationListParcel(PolicyTestCaseBase):
-    parcel_type = SecurityApplicationListParcel
-
-    def test_get_all_parcels(self):
-        parcels = self.policy_api.get(self.profile_uuid, self.parcel_type)
-        assert type(parcels) is DataSequence
-
-    def test_createsecurity_application_list_parcel(self):
-        # Arrange
-        parcel_name = create_name_with_run_id("sal")
-        sal = SecurityApplicationListParcel(parcel_name=parcel_name)
-        sal.add_application_family("web")
-        sal.add_application_family("file-server")
-        sal.add_application_family("audio-video")
-        # Act
-        self.created_id = self.policy_api.create_parcel(self.profile_uuid, sal).id
-        parcel = self.policy_api.get(self.profile_uuid, self.parcel_type, parcel_id=self.created_id)
-        # Assert
-        assert parcel.payload.parcel_name == parcel_name
-        assert len(parcel.payload.entries) == 3
-        assert parcel.payload.entries[0].app_list_family.value == "web"
-        assert parcel.payload.entries[1].app_list_family.value == "file-server"
-        assert parcel.payload.entries[2].app_list_family.value == "audio-video"