feat: add operation for variable in ListVariables (kcl-lang#1282)

* feat: add operation for variable in ListVariables Signed-off-by: zongz <zongzhe1024@163.com> * fix: fix test case Signed-off-by: zongz <zongzhe1024@163.com> --------- Signed-off-by: zongz <zongzhe1024@163.com> Signed-off-by: JeevaRamanathan <jeevaramanathan.m@infosys.com>
JeevaRamanathan · May 7, 2024 · 78d7204 · 78d7204
1 parent 768f13a
commit 78d7204
Show file tree

Hide file tree

Showing 5 changed files with 95 additions and 44 deletions.
diff --git a/kclvm/api/src/service/service_impl.rs b/kclvm/api/src/service/service_impl.rs
@@ -355,6 +355,7 @@ impl KclvmServiceImpl {
                     Variable {
                         value: var.value.to_string(),
                         type_name: var.type_name.to_string(),
+                        op_sym: var.op_sym.to_string(),
                     },
                 )
             })

diff --git a/kclvm/api/src/testdata/list-variables.response.json b/kclvm/api/src/testdata/list-variables.response.json
@@ -1 +1 @@
-{"variables":{"a":{"value":"1"}},"unsupported_codes":[]}
+{"variables":{"a":{"value":"1","type_name":"","op_sym":"="}},"unsupported_codes":[]}
diff --git a/kclvm/query/src/selector.rs b/kclvm/query/src/selector.rs
@@ -150,7 +150,11 @@ impl<'ctx> MutSelfWalker for Selector {
 
             self.select_result.insert(
                 target.to_string(),
-                Variable::new(unification_stmt.value.node.name.node.get_name(), kcode),
+                Variable::new(
+                    unification_stmt.value.node.name.node.get_name(),
+                    ast::ConfigEntryOperation::Union.symbol().to_string(),
+                    kcode,
+                ),
             );
         } else {
             // if length of spec is largr or equal to target
@@ -165,7 +169,11 @@ impl<'ctx> MutSelfWalker for Selector {
                             ))));
                         self.select_result.insert(
                             target.to_string(),
-                            Variable::new(unification_stmt.value.node.name.node.get_name(), kcode),
+                            Variable::new(
+                                unification_stmt.value.node.name.node.get_name(),
+                                ast::ConfigEntryOperation::Union.symbol().to_string(),
+                                kcode,
+                            ),
                         );
                     } else {
                         // walk ahead
@@ -201,8 +209,14 @@ impl<'ctx> MutSelfWalker for Selector {
                     target.node.clone(),
                 ))));
                 let key = get_key_path(&target);
-                self.select_result
-                    .insert(key.to_string(), Variable::new(type_name, kcode));
+                self.select_result.insert(
+                    key.to_string(),
+                    Variable::new(
+                        type_name,
+                        ast::ConfigEntryOperation::Override.symbol().to_string(),
+                        kcode,
+                    ),
+                );
             }
         } else {
             // Compare the target with the spec
@@ -230,8 +244,14 @@ impl<'ctx> MutSelfWalker for Selector {
                                 } else {
                                     "".to_string()
                                 };
-                            self.select_result
-                                .insert(target.to_string(), Variable::new(type_name, kcode));
+                            self.select_result.insert(
+                                target.to_string(),
+                                Variable::new(
+                                    type_name,
+                                    ast::ConfigEntryOperation::Override.symbol().to_string(),
+                                    kcode,
+                                ),
+                            );
                         } else {
                             // walk ahead
                             self.walk_expr(&assign_stmt.value.node)
@@ -276,7 +296,11 @@ impl<'ctx> MutSelfWalker for Selector {
                         };
                         self.select_result.insert(
                             self.inner.current_spec.to_string(),
-                            Variable::new(type_name, kcode),
+                            Variable::new(
+                                type_name,
+                                item.node.operation.symbol().to_string(),
+                                kcode,
+                            ),
                         );
                     } else {
                         // the spec is still not used up
@@ -367,12 +391,17 @@ pub struct ListVariablesResult {
 #[derive(Debug, PartialEq)]
 pub struct Variable {
     pub type_name: String,
+    pub op_sym: String,
     pub value: String,
 }
 
 impl Variable {
-    pub fn new(type_name: String, value: String) -> Self {
-        Self { type_name, value }
+    pub fn new(type_name: String, op_sym: String, value: String) -> Self {
+        Self {
+            type_name,
+            op_sym,
+            value,
+        }
     }
 }
 

diff --git a/kclvm/query/src/tests.rs b/kclvm/query/src/tests.rs
@@ -225,16 +225,16 @@ fn test_list_variables() {
         .display()
         .to_string();
     let test_cases = vec![
-        ("a", "1", ""),
-        ("a1", "2", ""),
-        ("a3", "3m", ""),
-        ("b1", "True", ""),
-        ("b2", "False", ""),
-        ("s1", "\"Hello\"", ""),
-        ("array1", "[1, 2, 3]", ""),
-        ("dict1", "{\"a\": 1, \"b\": 2}", ""),
-        ("dict1.a", "1", ""),
-        ("dict1.b", "2", ""),
+        ("a", "1", "", "="),
+        ("a1", "2", "", "="),
+        ("a3", "3m", "", "="),
+        ("b1", "True", "", "="),
+        ("b2", "False", "", "="),
+        ("s1", "\"Hello\"", "", "="),
+        ("array1", "[1, 2, 3]", "", "="),
+        ("dict1", "{\"a\": 1, \"b\": 2}", "", "="),
+        ("dict1.a", "1", "", ":"),
+        ("dict1.b", "2", "", ":"),
         (
             "dict2",
             r#"{
@@ -245,18 +245,20 @@ fn test_list_variables() {
     }
 }"#,
             "",
+            "=",
         ),
-        ("dict2.a", "1", ""),
+        ("dict2.a", "1", "", ":"),
         (
             "dict2.b",
             r#"{
     "c": 2
     "d": 3
 }"#,
             "",
+            ":",
         ),
-        ("dict2.b.c", "2", ""),
-        ("dict2.b.d", "3", ""),
+        ("dict2.b.c", "2", "", ":"),
+        ("dict2.b.d", "3", "", ":"),
         (
             "sha",
             r#"A {
@@ -269,9 +271,10 @@ fn test_list_variables() {
     }
 }"#,
             "A",
+            "=",
         ),
-        ("sha.name", "\"Hello\"", ""),
-        ("sha.ids", "[1, 2, 3]", ""),
+        ("sha.name", "\"Hello\"", "", ":"),
+        ("sha.ids", "[1, 2, 3]", "", ":"),
         (
             "sha.data",
             r#"{
@@ -280,16 +283,18 @@ fn test_list_variables() {
     }
 }"#,
             "",
+            ":",
         ),
         (
             "sha.data.a",
             r#"{
     "b": {"c": 2}
 }"#,
             "",
+            ":",
         ),
-        ("sha.data.a.b", r#"{"c": 2}"#, ""),
-        ("sha.data.a.b.c", "2", ""),
+        ("sha.data.a.b", r#"{"c": 2}"#, "", ":"),
+        ("sha.data.a.b.c", "2", "", ":"),
         (
             "shb",
             r#"B {
@@ -304,6 +309,7 @@ fn test_list_variables() {
     }
 }"#,
             "B",
+            "=",
         ),
         (
             "shb.a",
@@ -317,9 +323,10 @@ fn test_list_variables() {
     }
 }"#,
             "",
+            ":",
         ),
-        ("shb.a.name", "\"HelloB\"", ""),
-        ("shb.a.ids", "[4, 5, 6]", ""),
+        ("shb.a.name", "\"HelloB\"", "", ":"),
+        ("shb.a.ids", "[4, 5, 6]", "", ":"),
         (
             "shb.a.data",
             r#"{
@@ -328,28 +335,36 @@ fn test_list_variables() {
     }
 }"#,
             "",
+            ":",
         ),
         (
             "shb.a.data.d",
             r#"{
     "e": {"f": 3}
 }"#,
             "",
+            ":",
+        ),
+        ("shb.a.data.d.e", "{\"f\": 3}", "", ":"),
+        ("uconfa.name", "\"b\"", "", "="),
+        ("c.a", "{ids: [7, 8, 9]}", "", ":"),
+        (
+            "job.name",
+            r#""{}-{}".format("app", "test").lower()"#,
+            "",
+            "=",
         ),
-        ("shb.a.data.d.e", "{\"f\": 3}", ""),
-        ("uconfa.name", "\"b\"", ""),
-        ("c.a", "{ids: [7, 8, 9]}", ""),
-        ("job.name", r#""{}-{}".format("app", "test").lower()"#, ""),
     ];
 
-    for (spec, expected, expected_name) in test_cases {
+    for (spec, expected, expected_name, op_sym) in test_cases {
         let specs = vec![spec.to_string()];
         let result = list_variables(file.clone(), specs).unwrap();
         assert_eq!(result.select_result.get(spec).unwrap().value, expected);
         assert_eq!(
             result.select_result.get(spec).unwrap().type_name,
             expected_name
         );
+        assert_eq!(result.select_result.get(spec).unwrap().op_sym, op_sym);
     }
 }
 
@@ -361,14 +376,14 @@ fn test_list_all_variables() {
         .display()
         .to_string();
     let test_cases = vec![
-        ("a", "1", ""),
-        ("a1", "2", ""),
-        ("a3", "3m", ""),
-        ("b1", "True", ""),
-        ("b2", "False", ""),
-        ("s1", "\"Hello\"", ""),
-        ("array1", "[1, 2, 3]", ""),
-        ("dict1", "{\"a\": 1, \"b\": 2}", ""),
+        ("a", "1", "", "="),
+        ("a1", "2", "", "="),
+        ("a3", "3m", "", "="),
+        ("b1", "True", "", "="),
+        ("b2", "False", "", "="),
+        ("s1", "\"Hello\"", "", "="),
+        ("array1", "[1, 2, 3]", "", "="),
+        ("dict1", "{\"a\": 1, \"b\": 2}", "", "="),
         (
             "dict2",
             r#"{
@@ -379,6 +394,7 @@ fn test_list_all_variables() {
     }
 }"#,
             "",
+            "=",
         ),
         (
             "sha",
@@ -392,6 +408,7 @@ fn test_list_all_variables() {
     }
 }"#,
             "A",
+            "=",
         ),
         (
             "shb",
@@ -407,22 +424,25 @@ fn test_list_all_variables() {
     }
 }"#,
             "B",
+            "=",
         ),
         (
             "job",
             r#"Job {name = "{}-{}".format("app", "test").lower()}"#,
             "Job",
+            "=",
         ),
-        ("select", r#"a.b.c {a: 1}"#, "a.b.c"),
+        ("select", r#"a.b.c {a: 1}"#, "a.b.c", "="),
     ];
 
-    for (spec, expected, expected_name) in test_cases {
+    for (spec, expected, expected_name, op_sym) in test_cases {
         let result = list_variables(file.clone(), vec![]).unwrap();
         assert_eq!(result.select_result.get(spec).unwrap().value, expected);
         assert_eq!(
             result.select_result.get(spec).unwrap().type_name,
             expected_name
         );
+        assert_eq!(result.select_result.get(spec).unwrap().op_sym, op_sym);
     }
 }
 

diff --git a/kclvm/spec/gpyrpc/gpyrpc.proto b/kclvm/spec/gpyrpc/gpyrpc.proto
@@ -304,6 +304,7 @@ message ListVariables_Result {
 message Variable {
 	string value = 1;
 	string type_name = 2;
+	string op_sym = 3;
 }
 
 message GetFullSchemaType_Args {