catalystwan 0.41.0.dev1__tar.gz → 0.41.0.dev2__tar.gz

{catalystwan-0.41.0.dev1 → catalystwan-0.41.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: catalystwan
-Version: 0.41.0.dev1
+Version: 0.41.0.dev2
 Summary: Cisco Catalyst WAN SDK for Python
 Author: kagorski
 Author-email: kagorski@cisco.com

catalystwan-0.41.0.dev2/catalystwan/api/builders/feature_profiles/mixins.py

@@ -0,0 +1,44 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+from __future__ import annotations
+
+from typing import Dict, List, Set, Tuple
+from uuid import UUID
+
+from catalystwan.models.configuration.feature_profile.sdwan.trackers import Tracker, TrackerGroup
+
+
+class TrackerMixin:
+    def init_tracker(self):
+        self._shared_trackers: Dict[str, UUID] = {}
+        self._trackers: List[Tuple[Set[UUID], Tracker]] = []
+        self._tracker_groups: List[Tuple[Set[UUID], TrackerGroup, List[Tracker]]] = []
+        self._interface_tag_to_existing_tracker: Dict[UUID, Tuple[UUID, str]] = {}
+
+    def _create_parcel(self, profile_uuid: UUID, tracker: Tracker | TrackerGroup) -> UUID:
+        raise NotImplementedError()
+
+    def create_trackers(self, profile_uuid: UUID) -> None:
+        for tracker_group_tags, tracker_group, trackers in self._tracker_groups:
+            trackers_uuids: List[UUID] = []
+            for tracker_ in trackers:
+                tracker_uuid = self._create_parcel(profile_uuid, tracker_)
+                if tracker_uuid:
+                    trackers_uuids.append(tracker_uuid)
+                    self._shared_trackers[tracker_.parcel_name] = tracker_uuid
+
+            for tracker_uuid in trackers_uuids:
+                tracker_group.add_ref(tracker_uuid)
+
+            tracker_group_uuid = self._create_parcel(profile_uuid, tracker_group)
+            if tracker_group_uuid:
+                for tag in tracker_group_tags:
+                    self._interface_tag_to_existing_tracker[tag] = tracker_group_uuid, tracker_group._get_parcel_type()
+
+        for tracker_tags, tracker in self._trackers:
+            if tracker.parcel_name in self._shared_trackers:
+                created_tracker_uuid = self._shared_trackers[tracker.parcel_name]
+            else:
+                created_tracker_uuid = self._create_parcel(profile_uuid, tracker)
+            if created_tracker_uuid:
+                for tag in tracker_tags:
+                    self._interface_tag_to_existing_tracker[tag] = (created_tracker_uuid, tracker._get_parcel_type())

{catalystwan-0.41.0.dev1 → catalystwan-0.41.0.dev2}/catalystwan/api/builders/feature_profiles/service.py

@@ -9,6 +9,7 @@ from uuid import UUID, uuid4
 from pydantic import Field
 from typing_extensions import Annotated
 
+from catalystwan.api.builders.feature_profiles.mixins import TrackerMixin
 from catalystwan.api.builders.feature_profiles.report import (
     FeatureProfileBuildReport,
     handle_build_report,
@@ -30,7 +31,7 @@ from catalystwan.models.configuration.feature_profile.sdwan.service import (
     LanVpnParcel,
 )
 from catalystwan.models.configuration.feature_profile.sdwan.service.multicast import MulticastParcel
-from catalystwan.models.configuration.feature_profile.sdwan.trackers import AnyTrackerParcel, Tracker, TrackerGroup
+from catalystwan.models.configuration.feature_profile.sdwan.trackers import Tracker, TrackerGroup
 
 if TYPE_CHECKING:
     from catalystwan.session import ManagerSession
@@ -44,7 +45,7 @@ DependedVpnSubparcels = Annotated[
 ]
 
 
-class ServiceFeatureProfileBuilder:
+class ServiceFeatureProfileBuilder(TrackerMixin):
     """
     A class for building service feature profiles.
     """
@@ -65,9 +66,8 @@ class ServiceFeatureProfileBuilder:
         self._dependent_items_on_vpns: Dict[UUID, List[Tuple[UUID, DependedVpnSubparcels]]] = defaultdict(list)
         self._dependent_routing_items_on_vpns: Dict[UUID, List[AnyRoutingParcel]] = defaultdict(list)
         self._interfaces_with_attached_dhcp_server: Dict[str, LanVpnDhcpServerParcel] = {}
-        self._trackers: List[Tuple[Set[UUID], AnyTrackerParcel]] = []
-        self._tracker_groups: List[Tuple[Set[UUID], TrackerGroup, List[Tracker]]] = []
-        self._interface_tag_to_existing_tracker: Dict[UUID, Tuple[UUID, str]] = {}
+        # Trackers
+        self.init_tracker()
 
     def add_profile_name_and_description(self, feature_profile: FeatureProfileCreationPayload) -> None:
         """
@@ -154,18 +154,18 @@ class ServiceFeatureProfileBuilder:
         logger.debug(f"Adding DHCP server parcel {parcel.parcel_name} to interface {interface_parcel_name}")
         self._interfaces_with_attached_dhcp_server[interface_parcel_name] = parcel
 
-    def add_tracker(self, associate_tags: Set[UUID], parcel: AnyTrackerParcel) -> None:
+    def add_tracker(self, associate_tags: Set[UUID], tracker: Tracker) -> None:
         """
         Adds a tracker parcel to the feature profile.
 
         Args:
             associate_tags (Set[UUID]): The UUIDs of the interfaces to which the tracker should be added.
-            parcel (AnyTrackerParcel): The tracker parcel to add.
+            tracker (Tracker): The tracker parcel to add.
 
         Returns:
             None
         """
-        self._trackers.append((associate_tags, parcel))
+        self._trackers.append((associate_tags, tracker))
 
     def add_tracker_group(self, associate_tags: Set[UUID], group: TrackerGroup, trackers: List[Tracker]) -> None:
         self._tracker_groups.append((associate_tags, group, trackers))
@@ -183,26 +183,7 @@ class ServiceFeatureProfileBuilder:
         for parcel in self._independent_items:
             self._create_parcel(profile_uuid, parcel)
 
-        for tracker_group_tags, tracker_group, trackers in self._tracker_groups:
-            trackers_uuids: List[UUID] = []
-            for tracker_ in trackers:
-                tracker_uuid = self._create_parcel(profile_uuid, tracker_)
-                if tracker_uuid:
-                    trackers_uuids.append(tracker_uuid)
-
-            for tracker_uuid in trackers_uuids:
-                tracker_group.add_ref(tracker_uuid)
-
-            tracker_group_uuid = self._create_parcel(profile_uuid, tracker_group)
-            if tracker_group_uuid:
-                for tag in tracker_group_tags:
-                    self._interface_tag_to_existing_tracker[tag] = tracker_group_uuid, tracker_group._get_parcel_type()
-
-        for tracker_tags, tracker in self._trackers:
-            tracker_uuid = self._create_parcel(profile_uuid, tracker)
-            if tracker_uuid:
-                for tag in tracker_tags:
-                    self._interface_tag_to_existing_tracker[tag] = (tracker_uuid, tracker._get_parcel_type())
+        self.create_trackers(profile_uuid=profile_uuid)
 
         for vpn_tag, vpn_parcel in self._independent_items_vpns.items():
             vpn_uuid = self._create_parcel(profile_uuid, vpn_parcel)

{catalystwan-0.41.0.dev1 → catalystwan-0.41.0.dev2}/catalystwan/api/builders/feature_profiles/transport.py

@@ -6,6 +6,7 @@ from collections import defaultdict
 from typing import TYPE_CHECKING, Dict, List, Optional, Set, Tuple, Union
 from uuid import UUID, uuid4
 
+from catalystwan.api.builders.feature_profiles.mixins import TrackerMixin
 from catalystwan.api.builders.feature_profiles.report import (
     FeatureProfileBuildReport,
     handle_build_report,
@@ -35,7 +36,7 @@ if TYPE_CHECKING:
     from catalystwan.session import ManagerSession
 
 
-class TransportAndManagementProfileBuilder:
+class TransportAndManagementProfileBuilder(TrackerMixin):
     """
     A class for building system feature profiles.
     """
@@ -59,9 +60,8 @@ class TransportAndManagementProfileBuilder:
         self._dependent_items_on_cellular_controllers: Dict[
             UUID, List[Union[CellularProfileParcel, GpsParcel]]
         ] = defaultdict(list)
-        self._trackers: List[Tuple[Set[UUID], Tracker]] = []
-        self._tracker_groups: List[Tuple[Set[UUID], TrackerGroup, List[Tracker]]] = []
-        self._interface_tag_to_existing_tracker: Dict[UUID, Tuple[UUID, str]] = {}
+        # Trackers
+        self.init_tracker()
 
     def add_profile_name_and_description(self, feature_profile: FeatureProfileCreationPayload) -> None:
         """
@@ -161,18 +161,18 @@ class TransportAndManagementProfileBuilder:
         self._dependent_items_on_vpns[vpn_tag].append((subparcel_tag, parcel))
         return subparcel_tag
 
-    def add_tracker(self, associate_tags: Set[UUID], parcel: Tracker) -> None:
+    def add_tracker(self, associate_tags: Set[UUID], tracker: Tracker) -> None:
         """
         Adds a tracker parcel to the feature profile.
 
         Args:
             associate_tags (Set[UUID]): The UUIDs of the interfaces to which the tracker should be added.
-            parcel (AnyTrackerParcel): The tracker parcel to add.
+            tracker (Tracker): The tracker parcel to add.
 
         Returns:
             None
         """
-        self._trackers.append((associate_tags, parcel))
+        self._trackers.append((associate_tags, tracker))
 
     def add_tracker_group(self, associate_tags: Set[UUID], group: TrackerGroup, trackers: List[Tracker]) -> None:
         self._tracker_groups.append((associate_tags, group, trackers))
@@ -190,26 +190,7 @@ class TransportAndManagementProfileBuilder:
         for parcel in self._independent_items:
             self._create_parcel(profile_uuid, parcel)
 
-        for tracker_group_tags, tracker_group, trackers in self._tracker_groups:
-            trackers_uuids: List[UUID] = []
-            for tracker in trackers:
-                tracker_uuid = self._create_parcel(profile_uuid, tracker)
-                if tracker_uuid:
-                    trackers_uuids.append(tracker_uuid)
-
-            for tracker_uuid in trackers_uuids:
-                tracker_group.add_ref(tracker_uuid)
-
-            tracker_group_uuid = self._create_parcel(profile_uuid, tracker_group)
-            if tracker_group_uuid:
-                for tag in tracker_group_tags:
-                    self._interface_tag_to_existing_tracker[tag] = tracker_group_uuid, tracker_group._get_parcel_type()
-
-        for tracker_tags, tracker in self._trackers:
-            tracker_uuid = self._create_parcel(profile_uuid, tracker)
-            if tracker_uuid:
-                for tag in tracker_tags:
-                    self._interface_tag_to_existing_tracker[tag] = tracker_uuid, tracker._get_parcel_type()
+        self.create_trackers(profile_uuid=profile_uuid)
 
         for vpn_tag, vpn_parcel in self._independent_items_vpns.items():
             vpn_uuid = self._create_parcel(profile_uuid, vpn_parcel)
@@ -222,7 +203,9 @@ class TransportAndManagementProfileBuilder:
                     # Associate tracker with VPN interface if it exists
                     if vpn_subparcel_tag in self._interface_tag_to_existing_tracker and vpn_subparcel_uuid:
                         tracker_uuid, tracker_type = self._interface_tag_to_existing_tracker[vpn_subparcel_tag]
-                        vpn_subparcel_type = vpn_subparcel._get_parcel_type().replace("wan/vpn/", "")
+                        vpn_subparcel_type = (
+                            vpn_subparcel._get_parcel_type().replace("wan/vpn/", "").replace("management/vpn/", "")
+                        )
                         self._endpoints.associate_tracker_with_vpn_interface(
                             profile_uuid,
                             vpn_uuid,

{catalystwan-0.41.0.dev1 → catalystwan-0.41.0.dev2}/catalystwan/integration_tests/profile_builder/test_pb_service.py

@@ -94,7 +94,7 @@ class TestServiceFeatureProfileBuilder(TestCaseBase):
             interval=Global[int](value=100),
             endpoint_api_url=Global[str](value="https://example.com/api"),
         )
-        self.builder.add_tracker(associate_tags=[ethernet_tag], parcel=tracker)
+        self.builder.add_tracker(associate_tags=[ethernet_tag], tracker=tracker)
         report = self.builder.build()
 
         assert len(report.failed_parcels) == 0
@@ -140,6 +140,56 @@ class TestServiceFeatureProfileBuilder(TestCaseBase):
 
         assert len(report.failed_parcels) == 0
 
+    def test_when_shared_tracker_expect_success(self):
+        service_vpn_parcel = LanVpnParcel(
+            parcel_name="MinimumSpecifiedTransportVpnParcel",
+            description="Description",
+            vpn_id=as_global(50),
+        )
+        ethernet_parcel_1 = InterfaceEthernetParcel(
+            parcel_name="TestEthernetParcel1",
+            parcel_description="Test Ethernet Parcel",
+            interface_name=as_global("HundredGigE"),
+            ethernet_description=as_global("Test Ethernet Description"),
+            shutdown=as_variable("{{vpn1_gi3_lan_ip_192.168.X.1/24_}}"),
+        )
+        ethernet_parcel_2 = InterfaceEthernetParcel(
+            parcel_name="TestEthernetParcel2",
+            parcel_description="Test Ethernet Parcel",
+            interface_name=as_global("HundredGigE"),
+            ethernet_description=as_global("Test Ethernet Description"),
+            shutdown=as_variable("{{vpn1_gi3_lan_ip_192.168.X.1/24_}}"),
+        )
+        vpn_tag = self.builder.add_parcel_vpn(service_vpn_parcel)
+        ethernet_tag_1 = self.builder.add_parcel_vpn_subparcel(vpn_tag, ethernet_parcel_1)
+        ethernet_tag_2 = self.builder.add_parcel_vpn_subparcel(vpn_tag, ethernet_parcel_2)
+        tracker1 = Tracker(
+            parcel_name="TestTracker1",
+            parcel_description="Test Tracker Description",
+            tracker_name=Global[str](value="TestTracker1"),
+            interval=Global[int](value=100),
+            endpoint_api_url=Global[str](value="https://example.com/api"),
+        )
+        tracker2 = Tracker(
+            parcel_name="TestTracker2",
+            parcel_description="Test Tracker Description",
+            tracker_name=Global[str](value="TestTracker2"),
+            interval=Global[int](value=100),
+            endpoint_api_url=Global[str](value="https://example.com/api"),
+        )
+        tracker_group = TrackerGroup(
+            parcel_name="TestTrackerGroup",
+            parcel_description="Test Tracker Group Description",
+            tracker_refs=[],
+        )
+        self.builder.add_tracker_group(
+            associate_tags=[ethernet_tag_1], group=tracker_group, trackers=[tracker1, tracker2]
+        )
+        self.builder.add_tracker(associate_tags=[ethernet_tag_2], tracker=tracker2)
+        report = self.builder.build()
+
+        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:

{catalystwan-0.41.0.dev1 → catalystwan-0.41.0.dev2}/catalystwan/integration_tests/profile_builder/test_pb_transport.py

@@ -102,7 +102,7 @@ class TestTransportFeatureProfileBuilder(TestCaseBase):
             interval=Global[int](value=100),
             endpoint_api_url=Global[str](value="https://example.com/api"),
         )
-        self.builder.add_tracker(associate_tags=[gre_tag], parcel=tracker)
+        self.builder.add_tracker(associate_tags=[gre_tag], tracker=tracker)
         report = self.builder.build()
 
         assert len(report.failed_parcels) == 0
@@ -150,6 +150,75 @@ class TestTransportFeatureProfileBuilder(TestCaseBase):
 
         assert len(report.failed_parcels) == 0
 
+    def test_when_shared_tracker_expect_success(self):
+        service_vpn_parcel = TransportVpnParcel(
+            parcel_name="MinimumSpecifiedTransportVpnParcel",
+            description="Description",
+        )
+        vpn_tag = self.builder.add_parcel_vpn(service_vpn_parcel)
+        gre_parcel = InterfaceGreParcel(
+            parcel_name="InterfaceGreParcel",
+            parcel_description="Description",
+            basic=Basic(
+                address=AddressWithMask(
+                    address=Global[IPv4Address](value=IPv4Address("39.5.0.97")),
+                    mask=Variable(value="{{QPg11165441vY1}}"),
+                ),
+                if_name=Global[str](value="gre23"),
+                tunnel_destination=Global[IPv4Address](value=IPv4Address("3.3.3.3")),
+                clear_dont_fragment=Global[bool](value=True),
+                description=Global[str](value="QsLBBBBBCF"),
+                mtu=Global[int](value=1500),
+                shutdown=Global[bool](value=True),
+                tcp_mss_adjust=Global[int](value=600),
+                tunnel_source_type=TunnelSourceType(
+                    source_loopback=SourceLoopback(
+                        tunnel_route_via=Global[str](value="xSVIxuF"),
+                        tunnel_source_interface=Global[str](value="YnBabgxBUm"),
+                    )
+                ),
+            ),
+            advanced=AdvancedGre(application=Global[Literal["none", "sig"]](value="sig")),
+        )
+        gre_tag = self.builder.add_vpn_subparcel(vpn_tag, gre_parcel)
+        cellular_parcel = InterfaceCellularParcel(
+            parcel_name="InterfaceCellularParcel",
+            parcel_description="Description",
+            encapsulation=[],
+            interface_description=Global[str](value="CkmMzlz"),
+            interface_name=Global[str](value="xnaohVUa"),
+            nat=Global[bool](value=True),
+            shutdown=Global[bool](value=False),
+            tunnel_interface=Global[bool](value=True),
+        )
+        cellular_tag = self.builder.add_vpn_subparcel(vpn_tag, cellular_parcel)
+        tracker1 = Tracker(
+            parcel_name="TestTracker1",
+            parcel_description="Test Tracker Description",
+            tracker_name=Global[str](value="TestTracker1"),
+            interval=Global[int](value=100),
+            endpoint_api_url=Global[str](value="https://example.com/api"),
+        )
+        tracker2 = Tracker(
+            parcel_name="TestTracker2",
+            parcel_description="Test Tracker Description",
+            tracker_name=Global[str](value="TestTracker2"),
+            interval=Global[int](value=100),
+            endpoint_api_url=Global[str](value="https://example.com/api"),
+        )
+        tracker_group = TrackerGroup(
+            parcel_name="TestTrackerGroup",
+            parcel_description="Test Tracker Group Description",
+            tracker_refs=[],
+        )
+        self.builder.add_tracker_group(
+            associate_tags=set([cellular_tag]), group=tracker_group, trackers=[tracker1, tracker2]
+        )
+        self.builder.add_tracker(associate_tags=set([gre_tag]), tracker=tracker1)
+        report = self.builder.build()
+
+        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:

{catalystwan-0.41.0.dev1 → catalystwan-0.41.0.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "catalystwan"
-version = "0.41.0.dev1"
+version = "0.41.0.dev2"
 description = "Cisco Catalyst WAN SDK for Python"
 authors = ["kagorski <kagorski@cisco.com>"]
 readme = "README.md"