catalystwan 0.41.3.dev3__tar.gz → 0.41.4.dev1__tar.gz

{catalystwan-0.41.3.dev3 → catalystwan-0.41.4.dev1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.3
 Name: catalystwan
-Version: 0.41.3.dev3
+Version: 0.41.4.dev1
 Summary: Cisco Catalyst WAN SDK for Python
-Author: kagorski
-Author-email: kagorski@cisco.com
+Author: sbasan
+Author-email: sbasan@cisco.com
 Requires-Python: >=3.8.0,<4.0.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8

{catalystwan-0.41.3.dev3 → catalystwan-0.41.4.dev1}/catalystwan/api/task_status_api.py

@@ -5,9 +5,10 @@ from __future__ import annotations
 import logging
 from typing import TYPE_CHECKING, List, cast
 
-from tenacity import retry, retry_if_result, stop_after_attempt, wait_fixed  # type: ignore
+from tenacity import retry, retry_if_exception_type, retry_if_result, stop_after_attempt, wait_fixed  # type: ignore
+from tenacity.retry import retry_base  # type: ignore
 
-from catalystwan.exceptions import TaskValidationError
+from catalystwan.exceptions import ManagerRequestException, TaskValidationError
 
 if TYPE_CHECKING:
     from catalystwan.session import ManagerSession
@@ -59,6 +60,7 @@ class Task:
         failure_statuses_ids: List[OperationStatusId] = [
             OperationStatusId.FAILURE,
         ],
+        expect_conn_drop: bool = False,
     ) -> TaskResult:
         """
         Method to check subtasks statuses of the task
@@ -91,6 +93,8 @@ class Task:
             success_statuses_ids (Union[List[OperationStatus], str]): list of positive sub-tasks statuses id's
             fails_statuses_id (Union[List[OperationStatusId], str]): list of negative sub-tasks statuses
             fails_statuses_ids (Union[List[OperationStatusId], str]): list of negative sub-tasks statuses id's
+            expect_conn_drop (bool): set to true when performing action which can result in connection drop like:
+                                     server reboot or server configuration change
 
         Returns:
             TaskResult(): result attr is True if all subtasks are success
@@ -136,10 +140,14 @@ class Task:
         def log_exception(self) -> None:
             logger.error("Operation status not achieved in given time")
 
+        retry_condition: retry_base = retry_if_result(check_status)
+        if expect_conn_drop:
+            retry_condition |= retry_if_exception_type(ManagerRequestException)
+
         @retry(
             wait=wait_fixed(interval_seconds),
             stop=stop_after_attempt(int(timeout_seconds / interval_seconds)),
-            retry=retry_if_result(check_status),
+            retry=retry_condition,
             retry_error_callback=log_exception,
         )
         def wait_for_action_finish() -> List[SubTaskData]:

{catalystwan-0.41.3.dev3 → catalystwan-0.41.4.dev1}/catalystwan/api/template_api.py

@@ -51,6 +51,7 @@ from catalystwan.models.templates import DeviceTemplateInformation, FeatureTempl
 from catalystwan.response import ManagerResponse
 from catalystwan.typed_list import DataSequence
 from catalystwan.utils.dict import merge
+from catalystwan.utils.personality import Personality
 from catalystwan.utils.pydantic_field import get_extra_field
 from catalystwan.utils.template_type import TemplateType
 
@@ -195,7 +196,9 @@ class TemplatesAPI:
         endpoint = "/dataservice/template/device/config/attachfeature"
         logger.info(f"Attaching a template: {name} to the device: {device.hostname}.")
         response = self.session.post(url=endpoint, json=payload).json()
-        task = Task(session=self.session, task_id=response["id"]).wait_for_completed(timeout_seconds=timeout_seconds)
+        task = Task(session=self.session, task_id=response["id"]).wait_for_completed(
+            timeout_seconds=timeout_seconds, expect_conn_drop=device.personality is Personality.VMANAGE
+        )
         if task.result:
             return True
         logger.warning(f"Failed to attach template: {name} to the device: {device.hostname}.")
@@ -240,7 +243,9 @@ class TemplatesAPI:
         endpoint = "/dataservice/template/device/config/attachcli"
         logger.info(f"Attaching a template: {name} to the device: {device.hostname}.")
         response = self.session.post(url=endpoint, json=payload).json()
-        task = Task(session=self.session, task_id=response["id"]).wait_for_completed(timeout_seconds=timeout_seconds)
+        task = Task(session=self.session, task_id=response["id"]).wait_for_completed(
+            timeout_seconds=timeout_seconds, expect_conn_drop=device.personality is Personality.VMANAGE
+        )
         if task.result:
             return True
         logger.warning(f"Failed to attach tempate: {name} to the device: {device.hostname}.")
@@ -264,7 +269,9 @@ class TemplatesAPI:
         endpoint = "/dataservice/template/config/device/mode/cli"
         logger.info(f"Changing mode to cli mode for {device.hostname}.")
         response = self.session.post(url=endpoint, json=payload).json()
-        task = Task(session=self.session, task_id=response["id"]).wait_for_completed()
+        task = Task(session=self.session, task_id=response["id"]).wait_for_completed(
+            expect_conn_drop=device.personality is Personality.VMANAGE
+        )
         if task.result:
             return True
         logger.warning(f"Failed to change to cli mode for device: {device.hostname}.")
@@ -358,16 +365,13 @@ class TemplatesAPI:
         return True
 
     @overload
-    def edit(self, template: FeatureTemplate) -> Any:
-        ...
+    def edit(self, template: FeatureTemplate) -> Any: ...
 
     @overload
-    def edit(self, template: CLITemplate) -> Any:
-        ...
+    def edit(self, template: CLITemplate) -> Any: ...
 
     @overload
-    def edit(self, template: DeviceTemplate) -> Any:
-        ...
+    def edit(self, template: DeviceTemplate) -> Any: ...
 
     def edit(self, template):
         template_info = self.get(template).filter(name=template.template_name).single_or_default()
@@ -407,16 +411,13 @@ class TemplatesAPI:
         return response
 
     @overload
-    def create(self, template: FeatureTemplate, debug=False) -> str:
-        ...
+    def create(self, template: FeatureTemplate, debug=False) -> str: ...
 
     @overload
-    def create(self, template: DeviceTemplate) -> str:
-        ...
+    def create(self, template: DeviceTemplate) -> str: ...
 
     @overload
-    def create(self, template: CLITemplate) -> str:
-        ...
+    def create(self, template: CLITemplate) -> str: ...
 
     def create(self, template, debug: bool = False):
         if isinstance(template, list):

{catalystwan-0.41.3.dev3 → catalystwan-0.41.4.dev1}/catalystwan/tests/templates/test_find_template_values.py

@@ -1,5 +1,4 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
-import logging
 
 from catalystwan.api.templates.device_variable import DeviceVariable
 from catalystwan.utils.feature_template.find_template_values import find_template_values
@@ -195,128 +194,7 @@ def test_find_template_values():
     assert expected_values == result
 
 
-def test_log_error_when_overwriting_existing_variable_value(caplog):
-    input_values = {
-        "if-name": {
-            "vipObjectType": "object",
-            "vipType": "variableName",
-            "vipValue": "",
-            "vipVariableName": "inet-if_name",
-        },
-        "description": {
-            "vipObjectType": "object",
-            "vipType": "variableName",
-            "vipValue": "",
-            "vipVariableName": "inet-if_desc",
-        },
-        "ip": {
-            "value": {
-                "vipObjectType": "object",
-                "vipType": "variableName",
-                "vipValue": "",
-                "vipVariableName": "first_test_value_variable",
-            },
-            "address": {
-                "vipObjectType": "object",
-                "vipType": "variableName",
-                "vipValue": "",
-                "vipVariableName": "inet-if_ipv4_address",
-            },
-        },
-        "tunnel-interface": {
-            "color": {
-                "value": {
-                    "vipObjectType": "object",
-                    "vipType": "variableName",
-                    "vipValue": "",
-                    "vipVariableName": "second_test_value_variable",
-                },
-                "restrict": {
-                    "vipObjectType": "node-only",
-                    "vipType": "ignore",
-                    "vipValue": "false",
-                    "vipVariableName": "vpn_if_tunnel_color_restrict",
-                },
-            },
-        },
-    }
-
-    expected_error_log = (
-        "Overwriting existing value for field: 'value' in templated_values. "
-        "Previous value: name='first_test_value_variable', new value: name='second_test_value_variable'."
-    )
-    # Act
-    result = find_template_values(input_values)
-
-    # Assert
-    error_logs = [log.getMessage() for log in caplog.records if log.levelno == logging.ERROR]
-    assert expected_error_log in error_logs
-    assert isinstance(result.get("value"), DeviceVariable)
-    assert result.get("value").name == "second_test_value_variable"
-
-
-def test_log_error_when_overwriting_existing_top_level_global_value(caplog):
-    input_values = {
-        "if-name": {
-            "vipObjectType": "object",
-            "vipType": "variableName",
-            "vipValue": "",
-            "vipVariableName": "inet-if_name",
-        },
-        "description": {
-            "vipObjectType": "object",
-            "vipType": "variableName",
-            "vipValue": "",
-            "vipVariableName": "inet-if_desc",
-        },
-        "value": {
-            "vipObjectType": "object",
-            "vipType": "constant",
-            "vipValue": "test_value",
-            "vipVariableName": "first_test_value_variable",
-        },
-        "ip": {
-            "address": {
-                "vipObjectType": "object",
-                "vipType": "variableName",
-                "vipValue": "",
-                "vipVariableName": "inet-if_ipv4_address",
-            },
-        },
-        "tunnel-interface": {
-            "color": {
-                "value": {
-                    "vipObjectType": "object",
-                    "vipType": "variableName",
-                    "vipValue": "",
-                    "vipVariableName": "second_test_value_variable",
-                },
-                "restrict": {
-                    "vipObjectType": "node-only",
-                    "vipType": "ignore",
-                    "vipValue": "false",
-                    "vipVariableName": "vpn_if_tunnel_color_restrict",
-                },
-            },
-        },
-    }
-
-    expected_error_log = (
-        "Overwriting existing value for field: 'value' in templated_values. "
-        "Previous value: test_value, new value: name='second_test_value_variable'."
-    )
-    # Act
-    result = find_template_values(input_values)
-
-    # Assert
-    error_logs = [log.getMessage() for log in caplog.records if log.levelno == logging.ERROR]
-
-    assert expected_error_log in error_logs
-    assert isinstance(result.get("value"), DeviceVariable)
-    assert result.get("value").name == "second_test_value_variable"
-
-
-def test_no_log_error_when_setting_value_first_time(caplog):
+def test_nested_variable_values():
     input_values = {
         "if-name": {
             "vipObjectType": "object",
@@ -360,63 +238,6 @@ def test_no_log_error_when_setting_value_first_time(caplog):
     result = find_template_values(input_values)
 
     # Assert
-    error_logs = [log.getMessage() for log in caplog.records if log.levelno == logging.ERROR]
-    assert len(error_logs) == 0
-    assert isinstance(result.get("value"), DeviceVariable)
-    assert result.get("value").name == "test_value_variable"
-
-
-def test_no_log_error_when_global_value_is_nested(caplog):
-    input_values = {
-        "if-name": {
-            "vipObjectType": "object",
-            "vipType": "variableName",
-            "vipValue": "",
-            "vipVariableName": "inet-if_name",
-        },
-        "description": {
-            "vipObjectType": "object",
-            "vipType": "variableName",
-            "vipValue": "",
-            "vipVariableName": "inet-if_desc",
-        },
-        "ip": {
-            "address": {
-                "vipObjectType": "object",
-                "vipType": "variableName",
-                "vipValue": "",
-                "vipVariableName": "inet-if_ipv4_address",
-            },
-            "value": {
-                "vipObjectType": "object",
-                "vipType": "constant",
-                "vipValue": "test_value",
-                "vipVariableName": "first_test_value_variable",
-            },
-        },
-        "tunnel-interface": {
-            "color": {
-                "value": {
-                    "vipObjectType": "object",
-                    "vipType": "variableName",
-                    "vipValue": "",
-                    "vipVariableName": "second_test_value_variable",
-                },
-                "restrict": {
-                    "vipObjectType": "node-only",
-                    "vipType": "ignore",
-                    "vipValue": "false",
-                    "vipVariableName": "vpn_if_tunnel_color_restrict",
-                },
-            },
-        },
-    }
-
-    # Act
-    result = find_template_values(input_values)
-
-    # Assert
-    error_logs = [log.getMessage() for log in caplog.records if log.levelno == logging.ERROR]
-    assert len(error_logs) == 0
-    assert isinstance(result.get("value"), DeviceVariable)
-    assert result.get("value").name == "second_test_value_variable"
+    variable = result.get("tunnel-interface", {}).get("color", {}).get("value")
+    assert isinstance(variable, DeviceVariable)
+    assert variable.name == "test_value_variable"

{catalystwan-0.41.3.dev3 → catalystwan-0.41.4.dev1}/catalystwan/utils/feature_template/find_template_values.py

@@ -56,12 +56,8 @@ def find_template_values(
             # {"dns-addr": DeviceVariable(name="vpn_dns_primary")}
             if var_name := template_definition.get("vipVariableName"):
                 new_value = DeviceVariable(name=var_name)
-                if previous_value := templated_values.get(field_key):
-                    logger.error(
-                        f"Overwriting existing value for field: '{field_key}' in templated_values. "
-                        f"Previous value: {previous_value}, new value: {new_value}."
-                    )
-                templated_values[field_key] = new_value
+                current_nesting = get_nested_dict(templated_values, path[:-1])
+                current_nesting[field_key] = new_value
             return templated_values
 
         if template_value is None:

{catalystwan-0.41.3.dev3 → catalystwan-0.41.4.dev1}/pyproject.toml

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "catalystwan"
-version = "0.41.3dev3"
+version = "0.41.4dev1"
 description = "Cisco Catalyst WAN SDK for Python"
-authors = ["kagorski <kagorski@cisco.com>"]
+authors = ["sbasan <sbasan@cisco.com>"]
 readme = "README.md"
 repository = "https://github.com/cisco-en-programmability/catalystwan-sdk"