Merge pull request #741 from cisco-open/kuba/convert-result-ft

Use ConvertResult for FTs

catalystwan/models/configuration/config_migration.py

@@ -629,3 +629,6 @@ class ConvertResult(Generic[TO]):
     def update_status(self, status: ConvertStatus, message: str):
         self.status = status
         self.info.append(message)
+
+    def get_info(self) -> str:
+        return "\n".join(self.info)

catalystwan/models/configuration/feature_profile/sdwan/transport/__init__.py

@@ -1,4 +1,3 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
 from typing import List, Union
@@ -14,6 +13,7 @@
 from .management.ethernet import InterfaceEthernetParcel as ManagementInterfaceEthernetParcel
 from .t1e1controller import T1E1ControllerParcel
 from .vpn import ManagementVpnParcel, TransportVpnParcel
+from .wan.interface.cellular import InterfaceCellularParcel
 from .wan.interface.ethernet import InterfaceEthernetParcel
 from .wan.interface.gre import InterfaceGreParcel
 from .wan.interface.ipsec import InterfaceIpsecParcel
@@ -37,6 +37,7 @@
         InterfaceIpsecParcel,
         InterfaceEthernetParcel,
         InterfaceMultilinkParcel,
+        InterfaceCellularParcel,
         # Add wan interfaces here
     ],
     Field(discriminator="type_"),

catalystwan/utils/config_migration/converters/feature_template/aaa.py

@@ -4,8 +4,10 @@
 from catalystwan.api.configuration_groups.parcel import Global
 from catalystwan.models.configuration.feature_profile.sdwan.system import AAAParcel
 
+from .base import FTConverter
 
-class AAATemplateConverter:
+
+class AAAConverter(FTConverter):
     supported_template_types = ("cisco_aaa", "cedge_aaa", "aaa")
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> AAAParcel:

catalystwan/utils/config_migration/converters/feature_template/appqoe.py

@@ -19,8 +19,10 @@
     VirtualApplicationType,
 )
 
+from .base import FTConverter
 
-class AppqoeTemplateConverter:
+
+class AppqoeConverter(FTConverter):
     supported_template_types = ("appqoe",)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> AppqoeParcel:

catalystwan/utils/config_migration/converters/feature_template/banner.py

@@ -1,7 +1,9 @@
 from catalystwan.models.configuration.feature_profile.sdwan.system import BannerParcel
 
+from .base import FTConverter
 
-class BannerTemplateConverter:
+
+class BannerConverter(FTConverter):
     supported_template_types = ("cisco_banner",)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> BannerParcel:

catalystwan/utils/config_migration/converters/feature_template/base.py

@@ -1,8 +1,35 @@
-from typing_extensions import Protocol
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from abc import ABC, abstractmethod
+from typing import Optional, Tuple
 
+from catalystwan.models.configuration.config_migration import ConvertResult
 from catalystwan.models.configuration.feature_profile.parcel import AnyParcel
+from catalystwan.utils.config_migration.converters.exceptions import CatalystwanConverterCantConvertException
 
 
-class FeatureTemplateConverter(Protocol):
-    def create_parcel(self, name: str, description: str, template_values: dict) -> AnyParcel:
+class FTConverter(ABC):
+    """Feature Template Converter abstract base class."""
+
+    supported_template_types: Tuple = tuple()
+
+    def __init__(self):
+        self._convert_result = ConvertResult[AnyParcel]()
+
+    @abstractmethod
+    def create_parcel(self, name: str, description: str, template_values: dict) -> Optional[AnyParcel]:
+        """This function can modify status and info attributes of the conversion process."""
         ...
+
+    def convert(self, name: str, description: str, template_values: dict) -> ConvertResult[AnyParcel]:
+        if not self.supported_template_types:
+            self._convert_result.update_status(
+                "unsupported", "supported_template_types must be defined in the subclass"
+            )
+            return self._convert_result
+
+        try:
+            parcel = self.create_parcel(name, description, template_values)
+            self._convert_result.output = parcel
+        except CatalystwanConverterCantConvertException as e:
+            self._convert_result.update_status("failed", str(e))
+        return self._convert_result

catalystwan/utils/config_migration/converters/feature_template/basic.py

@@ -13,8 +13,10 @@
 from catalystwan.utils.config_migration.converters.feature_template.helpers import create_dict_without_none
 from catalystwan.utils.timezone import Timezone
 
+from .base import FTConverter
 
-class SystemToBasicTemplateConverter:
+
+class SystemToBasicConverter(FTConverter):
     supported_template_types = ("cisco_system", "system-vsmart", "system-vedge")
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> BasicParcel:

catalystwan/utils/config_migration/converters/feature_template/bfd.py

@@ -1,7 +1,9 @@
 from catalystwan.models.configuration.feature_profile.sdwan.system import BFDParcel
 
+from .base import FTConverter
 
-class BFDTemplateConverter:
+
+class BFDConverter(FTConverter):
     supported_template_types = ("cisco_bfd", "bfd-vedge")
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> BFDParcel:

catalystwan/utils/config_migration/converters/feature_template/bgp.py

@@ -21,10 +21,12 @@
 from catalystwan.utils.config_migration.converters.feature_template.helpers import create_dict_without_none
 from catalystwan.utils.config_migration.steps.constants import LAN_BGP, WAN_BGP
 
+from .base import FTConverter
+
 logger = logging.getLogger(__name__)
 
 
-class BgpRoutingTemplateConverter:
+class BgpRoutingConverter(FTConverter):
     supported_template_types = (WAN_BGP, LAN_BGP)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> RoutingBgpParcel:

catalystwan/utils/config_migration/converters/feature_template/cellular_controller.py

@@ -9,8 +9,10 @@
 )
 from catalystwan.utils.config_migration.converters.exceptions import CatalystwanConverterCantConvertException
 
+from .base import FTConverter
 
-class CellularControllerTemplateConverter:
+
+class CellularControllerConverter(FTConverter):
     supported_template_types = ("cellular-cedge-controller",)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> CellularControllerParcel:

catalystwan/utils/config_migration/converters/feature_template/cellular_profile.py

@@ -14,10 +14,12 @@
 )
 from catalystwan.utils.config_migration.converters.exceptions import CatalystwanConverterCantConvertException
 
+from .base import FTConverter
+
 logger = logging.getLogger(__name__)
 
 
-class CellularProfileTemplateConverter:
+class CellularProfileConverter(FTConverter):
     supported_template_types = ("cellular-cedge-profile",)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> CellularProfileParcel:

catalystwan/utils/config_migration/converters/feature_template/cli.py

@@ -3,8 +3,10 @@
 from catalystwan.models.configuration.feature_profile.sdwan.cli.config import ConfigParcel
 from catalystwan.utils.config_migration.converters.exceptions import CatalystwanConverterCantConvertException
 
+from .base import FTConverter
 
-class CliTemplateConverter:
+
+class CliConverter(FTConverter):
     supported_template_types = ("cli-template",)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> ConfigParcel:

catalystwan/utils/config_migration/converters/feature_template/dhcp.py

@@ -14,10 +14,12 @@
 from catalystwan.utils.config_migration.converters.exceptions import CatalystwanConverterCantConvertException
 from catalystwan.utils.config_migration.converters.feature_template.helpers import create_dict_without_none
 
+from .base import FTConverter
+
 logger = logging.getLogger(__name__)
 
 
-class DhcpTemplateConverter:
+class DhcpConverter(FTConverter):
     supported_template_types = ("dhcp", "cisco_dhcp_server", "dhcp-server")
 
     variable_address_pool = "{{dhcp_1_addressPool_networkAddress}}"

catalystwan/utils/config_migration/converters/feature_template/eigrp.py

@@ -14,8 +14,10 @@
     TableMap,
 )
 
+from .base import FTConverter
 
-class EigrpTemplateConverter:
+
+class EigrpConverter(FTConverter):
     supported_template_types = ("eigrp",)
 
     delete_keys = ("as_num",)

catalystwan/utils/config_migration/converters/feature_template/ethernet.py

@@ -26,8 +26,10 @@
 from catalystwan.utils.config_migration.converters.utils import parse_interface_name
 from catalystwan.utils.config_migration.steps.constants import MANAGEMENT_VPN_ETHERNET
 
+from .base import FTConverter
 
-class ManagementInterfaceEthernetTemplateConverter:
+
+class ManagementInterfaceEthernetConverter(FTConverter):
     supported_template_types = (MANAGEMENT_VPN_ETHERNET,)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> InterfaceEthernetParcel:
@@ -37,7 +39,7 @@ def create_parcel(self, name: str, description: str, template_values: dict) -> I
             parcel_name=name,
             parcel_description=description,
             advanced=self.parse_advanced(data),
-            interface_name=parse_interface_name(data),
+            interface_name=parse_interface_name(self, data),
             interface_description=data.get("description", Default[None](value=None)),
             intf_ip_address=self.parse_ipv4_address(data),
             shutdown=data.get("shutdown"),

catalystwan/utils/config_migration/converters/feature_template/global_.py

@@ -1,7 +1,9 @@
 from catalystwan.models.configuration.feature_profile.sdwan.system import GlobalParcel
 
+from .base import FTConverter
 
-class GlobalTemplateConverter:
+
+class GlobalConverter(FTConverter):
     supported_template_types = ("cedge_global",)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> GlobalParcel:

catalystwan/utils/config_migration/converters/feature_template/gps.py

@@ -5,8 +5,10 @@
 from catalystwan.models.configuration.feature_profile.sdwan.transport.gps import GpsMode, GpsParcel
 from catalystwan.utils.config_migration.converters.feature_template.helpers import create_dict_without_none
 
+from .base import FTConverter
 
-class GpsTemplateConverter:
+
+class GpsConverter(FTConverter):
     supported_template_types = ("cellular-cedge-gps-controller",)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> GpsParcel:

catalystwan/utils/config_migration/converters/feature_template/lan/ethernet.py

@@ -26,11 +26,12 @@
     Trustsec,
     VrrpIPv4,
 )
+from catalystwan.utils.config_migration.converters.feature_template.base import FTConverter
 from catalystwan.utils.config_migration.converters.utils import parse_interface_name
 from catalystwan.utils.config_migration.steps.constants import LAN_VPN_ETHERNET
 
 
-class LanInterfaceEthernetTemplateConverter:
+class LanInterfaceEthernetConverter(FTConverter):
     supported_template_types = (LAN_VPN_ETHERNET,)
 
     delete_keys = (
@@ -113,7 +114,7 @@ def prepare_parcel_values(self, name: str, description: str, values: dict) -> di
         return {"parcel_name": name, "parcel_description": description, **values}
 
     def configure_interface_name(self, values: dict) -> None:
-        values["interface_name"] = parse_interface_name(values)
+        values["interface_name"] = parse_interface_name(self, values)
 
     def configure_ethernet_description(self, values: dict) -> None:
         values["ethernet_description"] = values.get("description")

catalystwan/utils/config_migration/converters/feature_template/lan/gre.py

@@ -18,10 +18,11 @@
     TunnelSourceIPv6,
 )
 from catalystwan.utils.config_migration.converters.exceptions import CatalystwanConverterCantConvertException
+from catalystwan.utils.config_migration.converters.feature_template.base import FTConverter
 from catalystwan.utils.config_migration.steps.constants import LAN_VPN_GRE
 
 
-class LanInterfaceGreTemplateConverter:
+class LanInterfaceGreConverter(FTConverter):
     supported_template_types = (LAN_VPN_GRE,)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> InterfaceGreParcel:

catalystwan/utils/config_migration/converters/feature_template/lan/ipsec.py

@@ -7,10 +7,11 @@
 from catalystwan.models.configuration.feature_profile.common import AddressWithMask, TunnelApplication
 from catalystwan.models.configuration.feature_profile.sdwan.service.lan.ipsec import InterfaceIpsecParcel
 from catalystwan.utils.config_migration.converters.exceptions import CatalystwanConverterCantConvertException
+from catalystwan.utils.config_migration.converters.feature_template.base import FTConverter
 from catalystwan.utils.config_migration.steps.constants import LAN_VPN_IPSEC
 
 
-class LanInterfaceIpsecTemplateConverter:
+class LanInterfaceIpsecConverter(FTConverter):
     supported_template_types = (LAN_VPN_IPSEC,)
 
     # Default Values

catalystwan/utils/config_migration/converters/feature_template/lan/multilink.py

@@ -9,14 +9,15 @@
     MultilinkNimList,
 )
 from catalystwan.models.configuration.feature_profile.sdwan.service.lan.multilink import InterfaceMultilinkParcel
+from catalystwan.utils.config_migration.converters.feature_template.base import FTConverter
 from catalystwan.utils.config_migration.converters.feature_template.model_definition_normalizer import (
     flatten_datapaths,
     normalize_to_model_definition,
 )
 from catalystwan.utils.config_migration.steps.constants import LAN_VPN_MULTILINK
 
 
-class LanMultilinkTemplateConverter:
+class LanMultilinkConverter(FTConverter):
     supported_template_types = (LAN_VPN_MULTILINK,)
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> InterfaceMultilinkParcel:

catalystwan/utils/config_migration/converters/feature_template/lan/svi.py

@@ -11,15 +11,16 @@
     VrrpIPv4,
     VrrpIPv4SecondaryAddress,
 )
-from catalystwan.utils.config_migration.steps.constants import LAN_VPN_SVI
+from catalystwan.utils.config_migration.converters.feature_template.base import FTConverter
+from catalystwan.utils.config_migration.steps.constants import LAN_VPN_SVI, WAN_VPN_SVI
 
 
-class InterfaceSviTemplateConverter:
+class InterfaceSviConverter(FTConverter):
     """
     A class for converting template values into a InterfaceSviParcel object.
     """
 
-    supported_template_types = (LAN_VPN_SVI,)
+    supported_template_types = (LAN_VPN_SVI, WAN_VPN_SVI)
 
     delete_keys = (
         "if_name",

catalystwan/utils/config_migration/converters/feature_template/logging_.py

@@ -5,8 +5,10 @@
 from catalystwan.models.configuration.feature_profile.sdwan.system import LoggingParcel
 from catalystwan.models.configuration.feature_profile.sdwan.system.logging_parcel import CypherSuite
 
+from .base import FTConverter
 
-class LoggingTemplateConverter:
+
+class LoggingConverter(FTConverter):
     supported_template_types = ("cisco_logging", "logging")
 
     def create_parcel(self, name: str, description: str, template_values: dict) -> LoggingParcel:

catalystwan/utils/config_migration/converters/feature_template/multicast.py

@@ -23,8 +23,10 @@
     StaticRpAddress,
 )
 
+from .base import FTConverter
 
-class MulticastToMulticastTemplateConverter:
+
+class MulticastToMulticastConverter(FTConverter):
     """This is corner case.
     Multicast Parcel is not a direct conversion from template.
     It is a combination of multiple templates.
@@ -67,7 +69,7 @@ def get_example_payload(self):
         }
 
 
-class PimToMulticastTemplateConverter:
+class PimToMulticastConverter(FTConverter):
     """This is corner case.
     Multicast Parcel is not a direct conversion from template.
     It is a combination of multiple templates.
@@ -245,7 +247,7 @@ def get_example_payload(self):
         }
 
 
-class IgmpToMulticastTemplateConverter:
+class IgmpToMulticastConverter(FTConverter):
     """This is corner case.
     Multicast Parcel is not a direct conversion from template.
     It is a combination of multiple templates.