[dev]: device variable update (#189)

* introduce additional properties to DeviceVariable

* fix DeviceVariable equality

Author: sbasan

catalystwan/api/templates/device_variable.py

@@ -1,7 +1,17 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from pydantic import BaseModel
+from typing import Literal, Optional, Tuple
+
+from pydantic import BaseModel, PrivateAttr
+
+VariableObjectType = Literal["variable", "variableName"]
 
 
 class DeviceVariable(BaseModel):
     name: str
+    _object_type: VariableObjectType = PrivateAttr(default="variableName")
+    _template_path: Optional[Tuple[str, ...]] = PrivateAttr(default=None)
+
+    def __eq__(self, other):
+        # do not compare private attributes for backward compatibility
+        return self.__dict__ == other.__dict__

catalystwan/utils/feature_template/find_template_values.py

@@ -56,6 +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)
+                new_value._object_type = value
+                new_value._template_path = tuple(path)
                 current_nesting = get_nested_dict(templated_values, path[:-1])
                 current_nesting[field_key] = new_value
             return templated_values