catalystwan 0.41.6.dev2__tar.gz → 0.41.6.dev3__tar.gz

{catalystwan-0.41.6.dev2 → catalystwan-0.41.6.dev3}/PKG-INFO

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

catalystwan-0.41.6.dev3/catalystwan/tests/templates/conftest.py

@@ -0,0 +1,21 @@
+# Copyright 2026 Cisco Systems, Inc. and its affiliates
+import json
+from pathlib import Path
+from typing import Callable
+
+import pytest
+
+
+@pytest.fixture(scope="module")
+def template_payload_dir() -> Path:
+    return Path(Path(__file__).resolve().parent / "payload")
+
+
+@pytest.fixture(scope="module")
+def template_definition_loader(template_payload_dir) -> Callable[[str], dict]:
+
+    def loader(path: str) -> dict:
+        filepath = template_payload_dir / path
+        return json.load(open(filepath))
+
+    return loader

catalystwan-0.41.6.dev3/catalystwan/tests/templates/payload/cisco-vpn-definition.json

@@ -0,0 +1 @@
+{"vpn-id":{"vipObjectType":"object","vipType":"constant","vipValue":30},"name":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"vpn_name"},"ecmp-hash-key":{"layer4":{"vipObjectType":"object","vipType":"ignore","vipValue":"false","vipVariableName":"vpn_layer4"}},"nat64-global":{"prefix":{"stateful":{}}},"nat64":{"v4":{"pool":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["name"]}}},"tenant-vpn-id":{},"org-name":{},"omp-admin-distance-ipv4":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"vpn_omp-admin-distance-ipv4"},"omp-admin-distance-ipv6":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"vpn_omp-admin-distance-ipv6"},"nat":{"natpool":{"vipType":"constant","vipValue":[{"name":{"vipObjectType":"object","vipType":"constant","vipValue":1,"vipVariableName":"vpn_nat_pool_name"},"prefix-length":{"vipObjectType":"object","vipType":"constant","vipValue":8,"vipVariableName":"vpn_nat_prefix_length"},"range-start":{"vipObjectType":"object","vipType":"constant","vipValue":"192.168.2.1","vipVariableName":"vpn_nat_range_start"},"range-end":{"vipObjectType":"object","vipType":"constant","vipValue":"192.168.2.150","vipVariableName":"vpn_nat_range_end"},"overload":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"vpn_nat_pool_overload"},"direction":{"vipObjectType":"object","vipType":"constant","vipValue":"outside","vipVariableName":"vpn_nat_direction"},"tracker-id":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"vpn_nat_tracker_id"},"priority-order":["name","prefix-length","range-start","range-end","overload","direction","tracker-id"]},{"name":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"vpn_nat_pool_name"},"prefix-length":{"vipObjectType":"object","vipType":"constant","vipValue":24,"vipVariableName":"vpn_nat_prefix_length"},"range-start":{"vipObjectType":"object","vipType":"constant","vipValue":"192.168.3.1","vipVariableName":"vpn_nat_range_start"},"range-end":{"vipObjectType":"object","vipType":"constant","vipValue":"192.168.3.150","vipVariableName":"vpn_nat_range_end"},"overload":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"vpn_nat_pool_overload"},"direction":{"vipObjectType":"object","vipType":"constant","vipValue":"outside","vipVariableName":"vpn_nat_direction"},"tracker-id":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"vpn_nat_tracker_id"},"priority-order":["name","prefix-length","range-start","range-end","overload","direction","tracker-id"]}],"vipObjectType":"tree","vipPrimaryKey":["name"]},"port-forward":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["source-port","translate-port","source-ip","translate-ip","proto"]},"static":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["source-ip","translate-ip"]},"subnet-static":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["source-ip-subnet","translate-ip-subnet"]}},"route-import-from":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["protocol","source-vpn"]},"route-import":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["protocol"]},"route-export":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["protocol"]},"host":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["hostname"]},"service":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["svc-type"]},"ip":{"gre-route":{},"ipsec-route":{},"service-route":{}},"ipv6":{},"omp":{"advertise":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["protocol"]},"ipv6-advertise":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["protocol"]}}}

catalystwan-0.41.6.dev3/catalystwan/tests/templates/payload/ospf-multiple-route-policy-variables.json

@@ -0,0 +1 @@
+{"ospf":{"router-id":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"ospf_router_id"},"auto-cost":{"reference-bandwidth":{"vipObjectType":"object","vipType":"ignore","vipValue":100,"vipVariableName":"ospf_reference_bandwidth"}},"compatible":{"rfc1583":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"ospf_rfc1583"}},"distance":{"external":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospf_distance_external"},"inter-area":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospf_distance_inter_area"},"intra-area":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospf_distance_intra_area"}},"timers":{"spf":{"delay":{"vipObjectType":"object","vipType":"ignore","vipValue":200,"vipVariableName":"ospf_delay"},"initial-hold":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"ospf_initial_hold"},"max-hold":{"vipObjectType":"object","vipType":"ignore","vipValue":10000,"vipVariableName":"ospf_max_hold"}}},"route-policy":{"vipType":"constant","vipValue":[{"direction":{"vipObjectType":"object","vipType":"constant","vipValue":"in"},"pol-name":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"ospf_pol_name"},"priority-order":["direction","pol-name"]}],"vipObjectType":"tree","vipPrimaryKey":["direction"]},"redistribute":{"vipType":"constant","vipValue":[{"protocol":{"vipObjectType":"object","vipType":"constant","vipValue":"static","vipVariableName":"ospf_redistribute_protocol"},"route-policy":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"ospf_redistribute_route_policy"},"priority-order":["protocol","route-policy"]}],"vipObjectType":"tree","vipPrimaryKey":["protocol"]},"max-metric":{"router-lsa":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["ad-type"]}},"area":{"vipType":"constant","vipValue":[{"a-num":{"descriptionI18nKey":"server.vmanage.template.general.ciscoOspf.areaNumber","detailsI18nKey":"server.vmanage.template.general.ciscoOspf.setOSPFAreaNumber","originalDefaultOption":"constant","dataPath":[],"vipObjectType":"object","vipType":"constant","vipValue":999,"vipVariableName":"ospf_area_a_num"},"stub":{"no-summary":{"vipType":"ignore","vipObjectType":"node-only"}},"nssa":{"no-summary":{"vipType":"ignore","vipObjectType":"node-only"}},"priority-order":["a-num"]}],"vipObjectType":"tree","vipPrimaryKey":["a-num"]}}}

catalystwan-0.41.6.dev3/catalystwan/tests/templates/payload/ospfv3-multiple-route-policy-variables.json

@@ -0,0 +1 @@
+{"ospfv3":{"address-family":{"ipv4":{"router-id":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"ospfv3_router_id"},"auto-cost":{"reference-bandwidth":{"vipObjectType":"object","vipType":"ignore","vipValue":100,"vipVariableName":"ospfv3_reference_bandwidth"}},"distance-ipv4":{"distance":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_distance"},"ospf":{"external":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_external"},"inter-area":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_inter_area"},"intra-area":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_intra_area"}}},"table-map":{"name":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"ospfv3_distance_name"}},"compatible":{"rfc1583":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"ospfv3_rfc1583"}},"timers":{"throttle":{"spf":{"delay":{"vipObjectType":"object","vipType":"ignore","vipValue":200,"vipVariableName":"ospfv3_delay"},"initial-hold":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"ospfv3_initial_hold"},"max-hold":{"vipObjectType":"object","vipType":"ignore","vipValue":10000,"vipVariableName":"ospfv3_max_hold"}}}},"redistribute":{"vipType":"constant","vipValue":[{"protocol":{"vipObjectType":"object","vipType":"constant","vipValue":"static","vipVariableName":"ospf_redistribute_protocol"},"route-policy":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"ospf_redistribute_route_policy"},"priority-order":["protocol","route-policy"]},{"protocol":{"vipObjectType":"object","vipType":"constant","vipValue":"nat-route","vipVariableName":"ospf_redistribute_protocol"},"route-policy":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"ospf_redistribute_route_policy"},"dia":{"vipObjectType":"object","vipType":"constant","vipValue":"true","vipVariableName":"ospf_redistribute_dia"},"priority-order":["protocol","route-policy","dia"]},{"protocol":{"vipObjectType":"object","vipType":"constant","vipValue":"eigrp","vipVariableName":"ospf_redistribute_protocol"},"route-policy":{"vipObjectType":"object","vipType":"variableName","vipValue":"","vipVariableName":"ospf_redistribute_route_policy"},"priority-order":["protocol","route-policy"]}],"vipObjectType":"tree","vipPrimaryKey":["protocol"]},"max-metric":{"router-lsa":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["ad-type"]}}},"ipv6":{"router-id":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"ospfv3_router_id_ipv6"},"auto-cost":{"reference-bandwidth":{"vipObjectType":"object","vipType":"ignore","vipValue":100,"vipVariableName":"ospfv3_reference_bandwidth_ipv6"}},"distance-ipv4":{"distance":{},"ospf":{"external":{},"inter-area":{},"intra-area":{}}},"table-map":{"name":{"vipObjectType":"object","vipType":"ignore","vipVariableName":"ospfv3_distance_name_ipv6"}},"compatible":{"rfc1583":{"vipObjectType":"object","vipType":"ignore","vipValue":"true","vipVariableName":"ospfv3_rfc1583_ipv6"}},"distance-ipv6":{"ospf":{"external":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_external_ipv6"},"inter-area":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_inter_area_ipv6"},"intra-area":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_intra_area_ipv6"}},"distance":{"vipObjectType":"object","vipType":"ignore","vipValue":110,"vipVariableName":"ospfv3_distance_distance_ipv6"}},"timers":{"throttle":{"spf":{"delay":{"vipObjectType":"object","vipType":"ignore","vipValue":200,"vipVariableName":"ospfv3_delay_ipv6"},"initial-hold":{"vipObjectType":"object","vipType":"ignore","vipValue":1000,"vipVariableName":"ospfv3_initial_hold_ipv6"},"max-hold":{"vipObjectType":"object","vipType":"ignore","vipValue":10000,"vipVariableName":"ospfv3_max_hold_ipv6"}}}},"max-metric":{"router-lsa":{"vipType":"ignore","vipValue":[],"vipObjectType":"tree","vipPrimaryKey":["ad-type"]}}}}}}

{catalystwan-0.41.6.dev2 → catalystwan-0.41.6.dev3}/catalystwan/tests/templates/test_find_template_values.py

@@ -1,9 +1,15 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
+from functools import reduce
+
 from catalystwan.api.templates.device_variable import DeviceVariable
 from catalystwan.utils.feature_template.find_template_values import find_template_values
 
 
+def dict_get(dictionary, keys):
+    return reduce(lambda a, x: a[x], keys, dictionary)
+
+
 def test_find_template_values():
     input_values = {
         "vpn-id": {"vipObjectType": "object", "vipType": "constant", "vipValue": 0},
@@ -238,6 +244,72 @@ def test_nested_variable_values():
     result = find_template_values(input_values)
 
     # Assert
-    variable = result.get("tunnel-interface", {}).get("color", {}).get("value")
+    variable = dict_get(result, ("tunnel-interface", "color", "value"))
     assert isinstance(variable, DeviceVariable)
     assert variable.name == "test_value_variable"
+
+
+def test_ospf_multiple_route_policy_variables(template_definition_loader):
+    # Arrange
+    data = template_definition_loader("ospf-multiple-route-policy-variables.json")
+
+    # Act
+    values = find_template_values(data)
+
+    # Assert
+    var_policy = dict_get(values, ("ospf", "route-policy", 0, "pol-name"))
+    assert isinstance(var_policy, DeviceVariable)
+    assert var_policy._template_path == ("ospf", "route-policy", "in", "pol-name")
+
+    var_redistribute = dict_get(values, ("ospf", "redistribute", "route-policy"))
+    assert isinstance(var_redistribute, DeviceVariable)
+    assert var_redistribute._template_path == ("ospf", "redistribute", "static", "route-policy")
+
+
+def test_ospfv3_multiple_route_policy_variables(template_definition_loader):
+    # Arrange
+    data = template_definition_loader("ospfv3-multiple-route-policy-variables.json")
+
+    # Act
+    values = find_template_values(data)
+
+    # Assert
+    var_policy = dict_get(values, ("ospfv3", "address-family", "ipv4", "table-map", "name"))
+    assert isinstance(var_policy, DeviceVariable)
+    assert var_policy._template_path == ("ospfv3", "address-family", "ipv4", "table-map", "name")
+
+    var_redistribute_nat = dict_get(values, ("ospfv3", "address-family", "ipv4", "redistribute", 1, "route-policy"))
+    assert isinstance(var_redistribute_nat, DeviceVariable)
+    assert var_redistribute_nat._template_path == (
+        "ospfv3",
+        "address-family",
+        "ipv4",
+        "redistribute",
+        "nat-route",
+        "route-policy",
+    )
+
+    var_redistribute_eigrp = dict_get(values, ("ospfv3", "address-family", "ipv4", "redistribute", 2, "route-policy"))
+    assert isinstance(var_redistribute_eigrp, DeviceVariable)
+    assert var_redistribute_eigrp._template_path == (
+        "ospfv3",
+        "address-family",
+        "ipv4",
+        "redistribute",
+        "eigrp",
+        "route-policy",
+    )
+
+
+def test_cisco_vpn(template_definition_loader):
+    # Arrange
+    data = template_definition_loader("cisco-vpn-definition.json")
+
+    # Act
+    values = find_template_values(data)
+
+    # Assert
+    var_natpool = dict_get(values, ("nat", "natpool", 1, "name"))
+    assert isinstance(var_natpool, DeviceVariable)
+    assert var_natpool._object_type == "variableName"
+    assert var_natpool._template_path == ("nat", "natpool", "vpn_nat_pool_name", "name")

{catalystwan-0.41.6.dev2 → catalystwan-0.41.6.dev3}/catalystwan/utils/feature_template/find_template_values.py

@@ -7,6 +7,20 @@ from catalystwan.api.templates.device_variable import DeviceVariable
 logger = logging.getLogger(__name__)
 
 
+class _TreeValueList(list):
+    """List of tree values with mapping-style access for a single item."""
+
+    def __getitem__(self, key):
+        if isinstance(key, str):
+            if len(self) != 1:
+                raise KeyError(key)
+            item = super().__getitem__(0)
+            if not isinstance(item, dict):
+                raise KeyError(key)
+            return item[key]
+        return super().__getitem__(key)
+
+
 def find_template_values(
     template_definition: dict,
     templated_values: Optional[dict] = None,
@@ -14,6 +28,7 @@ def find_template_values(
     target_key_default_values: List[str] = ["ignore", "notIgnore"],
     target_key_for_template_value: str = "vipValue",
     path: Optional[List[str]] = None,
+    _template_path_prefix: Optional[List[str]] = None,
 ) -> Dict[str, Union[str, list, dict]]:
     """Based on provided template definition generates a dictionary with template fields and values
 
@@ -32,6 +47,8 @@ def find_template_values(
     """
     if path is None:
         path = []
+    if _template_path_prefix is None:
+        _template_path_prefix = []
     if templated_values is None:
         templated_values = {}
     # if value object is reached, try to extract the value
@@ -57,7 +74,7 @@ def find_template_values(
             if var_name := template_definition.get("vipVariableName"):
                 new_value = DeviceVariable(name=var_name)
                 new_value._object_type = value
-                new_value._template_path = tuple(path)
+                new_value._template_path = tuple(_template_path_prefix + path)
                 current_nesting = get_nested_dict(templated_values, path[:-1])
                 current_nesting[field_key] = new_value
             return templated_values
@@ -74,23 +91,100 @@ def find_template_values(
             current_nesting = get_nested_dict(templated_values, path[:-1])
             current_nesting[field_key] = template_value
         elif isinstance(template_value, dict):
-            find_template_values(value, templated_values, path=path)
+            find_template_values(
+                value,
+                templated_values,
+                target_key,
+                target_key_default_values,
+                target_key_for_template_value,
+                path,
+                _template_path_prefix,
+            )
         elif isinstance(template_value, list):
             current_nesting = get_nested_dict(templated_values, path[:-1])
-            current_nesting[field_key] = []
+            current_nesting[field_key] = _TreeValueList()
             for item in template_value:
-                item_value = find_template_values(item, {})
+                item_path_prefix = _template_path_prefix + get_list_item_template_path(
+                    template_definition,
+                    item,
+                    path,
+                    target_key,
+                    target_key_for_template_value,
+                )
+                item_value = find_template_values(
+                    item,
+                    {},
+                    target_key,
+                    target_key_default_values,
+                    target_key_for_template_value,
+                    path=[],
+                    _template_path_prefix=item_path_prefix,
+                )
                 if item_value:
                     current_nesting[field_key].append(item_value)
         return templated_values
 
     # iterate the dict to extract values and assign them to their fields
-    for key, value in template_definition.items():
+    for key in ordered_item_keys(template_definition):
+        value = template_definition[key]
         if isinstance(value, dict) and value not in target_key_default_values:
-            find_template_values(value, templated_values, path=path + [key])
+            find_template_values(
+                value,
+                templated_values,
+                target_key,
+                target_key_default_values,
+                target_key_for_template_value,
+                path + [key],
+                _template_path_prefix,
+            )
     return templated_values
 
 
+def ordered_item_keys(item: dict) -> List[str]:
+    """Return payload keys in schema order, followed by any unlisted keys."""
+    priority_order = item.get("priority-order", [])
+    if not isinstance(priority_order, list):
+        priority_order = []
+    return [key for key in priority_order if key in item] + [key for key in item if key not in priority_order]
+
+
+def get_list_item_template_path(
+    tree_definition: dict,
+    item: Any,
+    path: List[str],
+    target_key: str,
+    target_key_for_template_value: str,
+) -> List[str]:
+    """Build a stable path for a tree-list item from its concrete primary keys."""
+    item_path = list(path)
+    if not isinstance(item, dict):
+        return item_path
+
+    primary_keys = tree_definition.get("vipPrimaryKey", [])
+    if not isinstance(primary_keys, list):
+        return item_path
+
+    for key in ordered_item_keys(item):
+        if key not in primary_keys:
+            continue
+        field = item.get(key)
+        if not isinstance(field, dict):
+            continue
+
+        field_type = field.get(target_key)
+        if field_type == "constant":
+            value = field.get(target_key_for_template_value)
+        elif field_type in ("variableName", "variable"):
+            value = field.get("vipVariableName")
+        else:
+            continue
+
+        if value is not None and not isinstance(value, (dict, list)):
+            item_path.append(str(value))
+
+    return item_path
+
+
 def get_nested_dict(d: dict, path: List[str], populate: bool = True):
     current_dict = d
     for path_key in path:

{catalystwan-0.41.6.dev2 → catalystwan-0.41.6.dev3}/pyproject.toml

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