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

catalystwan/tests/test_cli_template.py

@@ -9,6 +9,7 @@ from ciscoconfparse import CiscoConfParse  # type: ignore
 from catalystwan.api.templates.cli_template import CLITemplate
 from catalystwan.dataclasses import Device
 from catalystwan.exceptions import TemplateTypeError
+from catalystwan.utils.device_model import DeviceModel
 
 
 class TestCLITemplate(unittest.TestCase):
@@ -39,7 +40,7 @@ class TestCLITemplate(unittest.TestCase):
         # Arrange
         mock_session.get_json.return_value = {"configType": "file", "templateConfiguration": self.config}
         # Act
-        temp = CLITemplate(template_name="test", template_description="test", device_model="vedge-cloud")
+        temp = CLITemplate(template_name="test", template_description="test", device_model=DeviceModel.VEDGE)
         answer = temp.load(session=mock_session, id="temp_id")
         # Assert
         self.assertEqual(answer.ioscfg, self.template.ioscfg)
@@ -53,7 +54,7 @@ class TestCLITemplate(unittest.TestCase):
             "templateConfiguration": self.config,
         }
         # Act
-        temp = CLITemplate(template_name="test", template_description="test", device_model="vedge-cloud")
+        temp = CLITemplate(template_name="test", template_description="test", device_model=DeviceModel.VEDGE)
 
         def answer():
             return temp.load(session=mock_session, id="temp_id")
@@ -78,7 +79,7 @@ class TestCLITemplate(unittest.TestCase):
             model="vedge-cloud",
         )
         # Act
-        temp = CLITemplate(template_name="test", template_description="test", device_model="vedge-cloud")
+        temp = CLITemplate(template_name="test", template_description="test", device_model=DeviceModel.VEDGE)
         answer = temp.load_running(session=mock_session, device=device)
         # Assert
         self.assertEqual(answer.ioscfg, self.template.ioscfg)
@@ -86,7 +87,7 @@ class TestCLITemplate(unittest.TestCase):
     def test_generate_payload(self):
         # Arrange
         template = CLITemplate(
-            template_name="test", template_description="test", device_model="vedge-cloud", config=self.template
+            template_name="test", template_description="test", device_model=DeviceModel.VEDGE, config=self.template
         )
         # Act
         answer = template.generate_payload()
@@ -125,7 +126,7 @@ class TestCLITemplate(unittest.TestCase):
         template = CLITemplate(
             template_name="test",
             template_description="test",
-            device_model="vedge-C8000V",
+            device_model=DeviceModel.VEDGE_C8000V,
             config=self.template,
         )
         # Act
@@ -173,7 +174,7 @@ class TestCLITemplate(unittest.TestCase):
         )
         config = CiscoConfParse(templateConfiguration.splitlines())
         # Act
-        template = CLITemplate(template_name="test", template_description="test", device_model="vedge-cloud")
+        template = CLITemplate(template_name="test", template_description="test", device_model=DeviceModel.VEDGE)
         result = template.update(session=mock_session, id="temp_id", config=config)
         # Assert
         self.assertTrue(result)
@@ -190,7 +191,7 @@ class TestCLITemplate(unittest.TestCase):
             "        system-ip               192.168.1.26\n"
         )
         config = CiscoConfParse(templateConfiguration.splitlines())
-        template = CLITemplate(template_name="test", template_description="test", device_model="vedge-cloud")
+        template = CLITemplate(template_name="test", template_description="test", device_model=DeviceModel.VEDGE)
 
         # Act
         with self.assertRaises(HTTPError):
@@ -212,7 +213,7 @@ class TestCLITemplate(unittest.TestCase):
         config2 = CiscoConfParse(templateConfiguration2.splitlines())
         # Act
         result = CLITemplate(
-            template_name="test", template_description="test", device_model="vedge-cloud"
+            template_name="test", template_description="test", device_model=DeviceModel.VEDGE
         ).compare_template(config1, config2)
         # Assert
         self.assertEqual(result, "")

catalystwan/tests/test_endpoints.py

@@ -6,14 +6,14 @@ import tempfile
 import unittest
 from enum import Enum
 from pathlib import Path
-from typing import List, Literal, Optional, Union
+from typing import Dict, List, Literal, Optional, Union
 from unittest.mock import MagicMock
 from uuid import UUID, uuid4
 
 import pytest  # type: ignore
 from packaging.version import Version  # type: ignore
 from parameterized import parameterized  # type: ignore
-from pydantic import BaseModel, ConfigDict, Field, model_serializer
+from pydantic import BaseModel, Field
 from typing_extensions import Annotated
 
 from catalystwan.endpoints import (
@@ -29,7 +29,6 @@ from catalystwan.endpoints import (
 from catalystwan.endpoints import logger as endpoints_logger
 from catalystwan.endpoints import post, put, request, versions, view
 from catalystwan.exceptions import APIEndpointError, APIRequestPayloadTypeError, APIVersionError, APIViewError
-from catalystwan.models.common import VersionedField
 from catalystwan.typed_list import DataSequence
 from catalystwan.utils.session_type import ProviderAsTenantView, ProviderView, TenantView
 
@@ -309,6 +308,14 @@ class TestAPIEndpoints(unittest.TestCase):
                 def get_data(self, payload: List[str]) -> None:  # type: ignore [empty-body]
                     ...
 
+    def test_request_decorator_unsupported_payload_composite_type(self):
+        with self.assertRaises(APIEndpointError):
+
+            class TestAPI(APIEndpoints):
+                @request("POST", "/v1/data")
+                def get_data(self, payload: Dict[str, BaseModelExample]) -> None:  # type: ignore [empty-body]
+                    ...
+
     @parameterized.expand(
         [
             (BaseModelExample, False, TypeSpecifier(True, None, BaseModelExample, None, False, False)),
@@ -344,7 +351,7 @@ class TestAPIEndpoints(unittest.TestCase):
             (None, True, None),
         ]
     )
-    def test_request_decorator_payload_spec(self, payload_type, raises, expected_payload_spec: Optional[TypeSpecifier]):
+    def test_request_decorator_payload_spec(self, payload_type, raises, expected_payload_spec):
         # Arrange
         class TestAPI(APIEndpoints):
             def get_data(self, payload: payload_type) -> None:  # type: ignore [empty-body]
@@ -357,11 +364,6 @@ class TestAPIEndpoints(unittest.TestCase):
                 decorator(TestAPI.get_data)
         else:
             decorator(TestAPI.get_data)
-            if expected_payload_spec is not None and expected_payload_spec.payload_union_model_types is not None:
-                # check both list contains same set and skip member list comparison below
-                assert decorator.payload_spec.payload_model_set == expected_payload_spec.payload_model_set
-                decorator.payload_spec.payload_union_model_types = None
-                expected_payload_spec.payload_union_model_types = None
             assert decorator.payload_spec == expected_payload_spec
 
     def test_request_decorator_not_annotated_params(self):
@@ -872,36 +874,3 @@ class TestAPIEndpoints(unittest.TestCase):
             @request("POST", "/v1/data")
             def create(self, payload: AnyBaseModel) -> None:  # type: ignore [empty-body]
                 ...
-
-    @parameterized.expand(
-        [
-            ("1.3", '{"name":"John"}'),
-            ("1.9", '{"newName":"John"}'),
-        ]
-    )
-    def test_api_version_passed_in_dump_context(self, version, expected_payload_json):
-        # Arrange
-        class Payload(BaseModel):
-            model_config = ConfigDict(populate_by_name=True)
-            name: Annotated[str, VersionedField(versions=">1.6", serialization_alias="newName")]
-
-            @model_serializer(mode="wrap")
-            def serialize(self, handler, info):
-                return VersionedField.dump(self.model_fields, handler(self), info)
-
-        class ExampleAPI(APIEndpoints):
-            @request("POST", "/v1/data")
-            def create(self, payload: Payload) -> None:  # type: ignore [empty-body]
-                ...
-
-        self.session_mock.api_version = Version(version)
-        api = ExampleAPI(self.session_mock)
-        # Act
-        api.create(Payload(name="John"))
-        # Assert
-        self.session_mock.request.assert_called_once_with(
-            "POST",
-            self.base_path + "/v1/data",
-            data=expected_payload_json,
-            headers={"content-type": "application/json"},
-        )

catalystwan/tests/test_templates.py

@@ -12,9 +12,10 @@ from catalystwan.api.templates.device_template.device_template import DeviceTemp
 from catalystwan.api.templates.feature_template import FeatureTemplate
 from catalystwan.api.templates.models.cisco_aaa_model import CiscoAAAModel
 from catalystwan.api.templates.payloads.aaa.aaa_model import AAAModel, AuthenticationOrder
-from catalystwan.dataclasses import Device
-from catalystwan.endpoints.configuration_template_master import DeviceTemplateInformation
+from catalystwan.dataclasses import Device, FeatureTemplateInfo, TemplateInfo
 from catalystwan.typed_list import DataSequence
+from catalystwan.utils.creation_tools import create_dataclass
+from catalystwan.utils.device_model import DeviceModel
 from catalystwan.utils.personality import Personality
 from catalystwan.utils.reachability import Reachability
 
@@ -54,8 +55,8 @@ class TestTemplatesAPI(unittest.TestCase):
             },
         ]
         self.templates = DataSequence(
-            DeviceTemplateInformation,
-            [DeviceTemplateInformation(**template) for template in self.data_template],
+            TemplateInfo,
+            [create_dataclass(TemplateInfo, template) for template in self.data_template],
         )
         self.device_info = Device(
             personality=Personality.EDGE,
@@ -69,7 +70,7 @@ class TestTemplatesAPI(unittest.TestCase):
             model="vedge-cloud",
             status="normal",
         )
-        sub_tasks_data = SubTaskData.model_validate(
+        sub_tasks_data = SubTaskData.parse_obj(
             {
                 "status": "Success",
                 "statusId": "success",
@@ -85,10 +86,12 @@ class TestTemplatesAPI(unittest.TestCase):
         )
         self.task = TaskResult(result=True, sub_tasks_data=[sub_tasks_data])
 
+    @patch("catalystwan.response.ManagerResponse")
     @patch("catalystwan.session.ManagerSession")
-    def test_templates_success(self, mock_session):
+    def test_templates_success(self, mock_session, mocked_response):
         # Arrange
-        mock_session.endpoints.configuration_general_template.get_feature_template_list.return_value = self.templates
+        mock_session.get.return_value = mocked_response
+        mocked_response.dataseq.return_value = self.templates
 
         # Act
         answer = TemplatesAPI(mock_session).get(FeatureTemplate)
@@ -96,18 +99,18 @@ class TestTemplatesAPI(unittest.TestCase):
         # Assert
         self.assertEqual(answer, self.templates)
 
+    @patch("catalystwan.response.ManagerResponse")
     @patch("catalystwan.session.ManagerSession")
-    def test_templates_get(self, mock_session):
+    def test_templates_get(self, mock_session, mocked_response):
         # Arrange
-        mock_session.endpoints.configuration_general_template.get_feature_template_list.return_value = self.templates
+        mock_session.get_data.return_value = mocked_response
+        mocked_response.dataseq.return_value = DataSequence(FeatureTemplateInfo, [])
 
         # Act
         TemplatesAPI(mock_session).get(FeatureTemplate)
 
         # Assert
-        mock_session.endpoints.configuration_general_template.get_feature_template_list.assert_called_once_with(
-            params={"summary": True}
-        )
+        mock_session.get.assert_called_once_with(url="/dataservice/template/feature", params={"summary": True})
 
     @parameterized.expand(
         [
@@ -127,14 +130,14 @@ class TestTemplatesAPI(unittest.TestCase):
                 DeviceTemplate(  # type: ignore
                     template_name="test_device_template",
                     template_description="test_device_template_description",
-                    device_type="vedge-2000",
+                    device_type=DeviceModel.VEDGE_2000,
                     general_templates=[],
                 ),
                 "device_template_id",
             ),
             (
                 CLITemplate(  # type: ignore
-                    template_name="test", template_description="test", device_model="vedge-100"
+                    template_name="test", template_description="test", device_model=DeviceModel.VEDGE
                 ),
                 "cli_id",
             ),
@@ -190,13 +193,13 @@ class TestTemplatesAPI(unittest.TestCase):
                     DeviceTemplate(  # type: ignore
                         template_name="test_device_template",
                         template_description="test_device_template_description",
-                        device_type="vedge-2000",
+                        device_type=DeviceModel.VEDGE_2000,
                         general_templates=[],
                     ),
                     CLITemplate(  # type: ignore
                         template_name="test_cli_template",
                         template_description="test_cli_description",
-                        device_model="vedge-cloud",
+                        device_model=DeviceModel.VBOND,
                     ),
                     CiscoAAAModel(  # type: ignore
                         template_name="test_aaa_model",

catalystwan/utils/feature_template/find_template_values.py

@@ -1,17 +1,15 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
-import logging
+
 from typing import Any, Dict, List, Optional, Union
 
 from catalystwan.api.templates.device_variable import DeviceVariable
 
-logger = logging.getLogger(__name__)
-
 
 def find_template_values(
     template_definition: dict,
     templated_values: Optional[dict] = None,
     target_key: str = "vipType",
-    target_key_default_values: List[str] = ["ignore", "notIgnore"],
+    target_key_value_to_ignore: str = "ignore",
     target_key_for_template_value: str = "vipValue",
     path: Optional[List[str]] = None,
 ) -> Dict[str, Union[str, list, dict]]:
@@ -22,8 +20,8 @@ def find_template_values(
         templated_values: dictionary, empty at the beginning and filed out with names of fields as keys
             and values of those fields as values
         target_key: name of the key specifying if field is used in template, defaults to 'vipType'
-        target_key_default_values: list of values of the target key indicating
-            that a field is not used in template, defaults to ['ignore', 'notIgnore']
+        target_key_value_to_ignore: value of the target key indicating
+            that field is not used in template, defaults to 'ignore'
         target_key_for_template_value: name of the key specifying value of field used in template,
             defaults to 'vipValue'
         path: a list of keys indicating current path, defaults to None
@@ -36,14 +34,14 @@ def find_template_values(
         templated_values = {}
     # if value object is reached, try to extract the value
     if target_key in template_definition:
-        if template_definition[target_key] in target_key_default_values:
+        if template_definition[target_key] == target_key_value_to_ignore:
             return templated_values
 
         value = template_definition[target_key]  # vipType
         template_value = template_definition.get(target_key_for_template_value)
 
         field_key = path[-1]
-        if value in ["variableName", "variable"]:
+        if value == "variableName":
             # For example this is the current dictionary:
             # field_key is "dns-addr"
             # {
@@ -54,14 +52,7 @@ def find_template_values(
             # }
             # vipType is "variableName" so we need to return
             # {"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
+            templated_values[field_key] = DeviceVariable(name=template_definition["vipVariableName"])
             return templated_values
 
         if template_value is None:
@@ -88,7 +79,7 @@ def find_template_values(
 
     # iterate the dict to extract values and assign them to their fields
     for key, value in template_definition.items():
-        if isinstance(value, dict) and value not in target_key_default_values:
+        if isinstance(value, dict) and value != target_key_value_to_ignore:
             find_template_values(value, templated_values, path=path + [key])
     return templated_values
 
@@ -102,11 +93,7 @@ def get_nested_dict(d: dict, path: List[str], populate: bool = True):
     return current_dict
 
 
-def process_list_value(
-    item: Any,
-    target_key: str = "vipType",
-    target_key_for_template_value: str = "vipValue",
-):
+def process_list_value(item: Any, target_key: str = "vipType", target_key_for_template_value: str = "vipValue"):
     if isinstance(item, dict):
         if target_key in item:
             if item["vipObjectType"] == "list":