Simplify conditional logic. Add comments. Create new field in cisco v…

…pn feature template model. (new in 20.14)
cisco-open · Apr 5, 2024 · 17be01f · 17be01f
1 parent cdb3db1
commit 17be01f
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 53 deletions.
diff --git a/catalystwan/api/templates/feature_template_field.py b/catalystwan/api/templates/feature_template_field.py
@@ -115,61 +115,59 @@ def nest_value_in_output(value: Any) -> dict:
             )
             return nest_value_in_output(vip_variable.model_dump(by_alias=True, exclude_none=True))
 
+        if value is not None and not self.children:
+            output["vipType"] = vip_type or FeatureTemplateOptionType.CONSTANT.value
+            output["vipValue"] = json_dumped_value
+        elif value is not None and self.children:
+            output["vipType"] = vip_type or FeatureTemplateOptionType.CONSTANT.value
+            children_output = []
+            for obj in value:
+                obj_json_dump = obj.model_dump(mode="json")
+                child_payload: dict = {}
+                for child in self.children:  # Child in schema
+                    obj: FeatureTemplate  # type: ignore
+
+                    # We are searching for the model field that
+                    # corresponds to the child element (field from vManage schema)
+                    # If this line fails, it means that the schema from vManage has more fields than the model
+                    # and the model needs to be updated (add missing fields)
+                    model_tuple = next(
+                        filter(
+                            lambda f: (
+                                f[1].alias == child.key
+                                or get_extra_field(f[1], "vmanage_key") == child.key
+                                or f[0] == child.key
+                            ),
+                            obj.model_fields.items(),
+                        )
+                    )
+                    # We get the pydantic model field and the value from the object
+                    model_field = model_tuple[1]
+                    obj_value = getattr(obj, model_tuple[0])
+                    obj_json_value = obj_json_dump.get(model_tuple[0])
+                    po = get_extra_field(model_field, "priority_order")
+                    vip_type = get_extra_field(model_field, "vip_type")
+                    # After we get the data, we create the payload by populating the schema
+                    # Then we merge the payload to the output
+                    merge(
+                        child_payload,
+                        child.payload_scheme(
+                            obj_value,
+                            json_dumped_value=obj_json_value,
+                            priority_order=po,
+                            vip_type=vip_type,
+                        ),
+                    )
+                    if priority_order:
+                        child_payload.update({"priority-order": priority_order})
+                children_output.append(child_payload)
+            output["vipValue"] = children_output
         else:
-            if value is not None:
-                output["vipType"] = vip_type or FeatureTemplateOptionType.CONSTANT.value
-                if self.children:
-                    children_output = []
-                    for obj in value:  # obj is User, atomic value. Loop every child
-                        obj_json_dump = obj.model_dump(mode="json")
-                        child_payload: dict = {}
-                        for child in self.children:  # Child in schema
-                            obj: FeatureTemplate  # type: ignore
-                            model_tuple = next(
-                                filter(
-                                    lambda f: get_extra_field(f[1], "data_path", []) == child.dataPath
-                                    and (
-                                        f[1].alias == child.key
-                                        or get_extra_field(f[1], "vmanage_key") == child.key
-                                        or f[0] == child.key
-                                    ),
-                                    obj.model_fields.items(),
-                                )
-                            )
-                            model_field = model_tuple[1]
-                            obj_value = getattr(obj, model_tuple[0])
-                            obj_json_value = obj_json_dump.get(model_tuple[0])
-                            po = get_extra_field(model_field, "priority_order")
-                            vip_type = get_extra_field(model_field, "vip_type")
-                            merge(
-                                child_payload,
-                                child.payload_scheme(
-                                    obj_value,
-                                    json_dumped_value=obj_json_value,
-                                    priority_order=po,
-                                    vip_type=vip_type,
-                                ),
-                            )
-                            if priority_order:
-                                child_payload.update({"priority-order": priority_order})
-                        children_output.append(child_payload)
-                    output["vipValue"] = children_output
-                else:
-                    output["vipValue"] = json_dumped_value
+            if value is None or "default" in self.dataType:
+                return {}
             else:
-                if value is None:
-                    return {}
-                if "default" in self.dataType:
-                    return {}
-                    # output["vipValue"] = self.dataType["default"] if value is None else value
-                    # output["vipType"] = self.defaultOption.value
-                else:
-                    output["vipValue"] = []
-                    output["vipType"] = FeatureTemplateOptionType.IGNORE.value
-
-        # TODO
-        # DataType to dataclass Model
-        # No default values for everything
+                output["vipValue"] = []
+                output["vipType"] = FeatureTemplateOptionType.IGNORE.value
 
         if self.primaryKeys:
             output["vipPrimaryKey"] = self.primaryKeys

diff --git a/catalystwan/api/templates/models/cisco_vpn_model.py b/catalystwan/api/templates/models/cisco_vpn_model.py
@@ -77,6 +77,14 @@ class NextHopWithTrack(FeatureTemplateValidator):
     tracker: str
 
 
+class RouteInterface(FeatureTemplateValidator):
+    interface_name: str = Field(json_schema_extra={"vmanage_key": "interface-name"})
+    interface_next_hop: Optional[List[NextHop]] = Field(
+        default=None, json_schema_extra={"vmanage_key": "interface-next-hop", "priority_order": ["address", "distance"]}
+    )
+    model_config = ConfigDict(populate_by_name=True)
+
+
 class Routev4(FeatureTemplateValidator):
     prefix: Optional[str] = None
     next_hop: Optional[List[NextHop]] = Field(
@@ -85,6 +93,9 @@ class Routev4(FeatureTemplateValidator):
     next_hop_with_track: Optional[List[NextHopWithTrack]] = Field(
         default=None, json_schema_extra={"vmanage_key": "next-hop-with-track"}
     )
+    route_interface: Optional[RouteInterface] = Field(
+        default=None, json_schema_extra={"vmanage_key": "route-interface"}
+    )
     null0: Optional[bool] = None
     distance: Optional[int] = None
     vpn: Optional[int] = None