[lldb] [disassembler] chore: enhance VariableAnnotator to return structured data: simplify test_structured_annotations_api

Signed-off-by: Nikita B <[email protected]>

Author: n2h9

lldb/test/API/functionalities/disassembler-variables/TestVariableAnnotationsDisassembler.py

@@ -138,13 +138,9 @@ def test_structured_annotations_api(self):
         if self.TraceOn():
             print(f"\nTesting GetVariableAnnotations() API on {instructions.GetSize()} instructions")
 
-        # Track what we find.
-        found_annotations = False
+        expected_vars = ["argc", "argv", "i"]
         found_variables = set()
 
-        # Track variable locations to detect changes (for selective printing).
-        prev_locations = {}
-
         # Test each instruction
         for i in range(instructions.GetSize()):
             inst = instructions.GetInstructionAtIndex(i)
@@ -155,18 +151,14 @@ def test_structured_annotations_api(self):
             self.assertIsInstance(annotations, lldb.SBStructuredData,
                                 "GetVariableAnnotations should return SBStructuredData")
 
-            if annotations.GetSize() > 0:
-                found_annotations = True
-
-                # Track current locations and detect changes.
-                current_locations = {}
-                should_print = False
+            self.assertTrue(annotations.GetSize() > 0,
+                            "GetVariableAnnotations should return non empty array")
 
+            if annotations.GetSize() > 0:
                 # Validate each annotation.
                 for j in range(annotations.GetSize()):
                     ann = annotations.GetItemAtIndex(j)
-                    self.assertTrue(ann.IsValid(),
-                                  f"Invalid annotation at index {j}")
+                    self.assertTrue(ann.IsValid(), f"Invalid annotation at index {j}")
 
                     self.assertEqual(ann.GetType(), lldb.eStructuredDataTypeDictionary,
                                    "Each annotation should be a dictionary")
@@ -195,98 +187,13 @@ def test_structured_annotations_api(self):
                     self.assertTrue(register_kind_obj.IsValid(),
                                   "Missing 'register_kind' field")
 
-                    # Extract and validate values.
                     var_name = var_name_obj.GetStringValue(1024)
-                    location = location_obj.GetStringValue(1024)
-                    is_live = is_live_obj.GetBooleanValue()
-                    start_addr = start_addr_obj.GetUnsignedIntegerValue()
-                    end_addr = end_addr_obj.GetUnsignedIntegerValue()
-                    register_kind = register_kind_obj.GetUnsignedIntegerValue()
-
-                    # Validate types and values.
-                    self.assertIsInstance(var_name, str, "variable_name should be string")
-                    self.assertGreater(len(var_name), 0, "variable_name should not be empty")
-
-                    self.assertIsInstance(location, str, "location_description should be string")
-                    self.assertGreater(len(location), 0, "location_description should not be empty")
-
-                    self.assertIsInstance(is_live, bool, "is_live should be boolean")
-
-                    self.assertIsInstance(start_addr, int, "start_address should be integer")
-                    self.assertIsInstance(end_addr, int, "end_address should be integer")
-                    self.assertGreater(end_addr, start_addr,
-                                     "end_address should be greater than start_address")
-
-                    self.assertIsInstance(register_kind, int, "register_kind should be integer")
 
                     # Check for expected variables in this function.
-                    self.assertIn(var_name, ["argc", "argv", "i"],
+                    self.assertIn(var_name, expected_vars,
                                 f"Unexpected variable name: {var_name}")
 
                     found_variables.add(var_name)
 
-                    # Track current location.
-                    current_locations[var_name] = location
-
-                    # Detect if this is a new variable or location changed.
-                    if var_name not in prev_locations or prev_locations[var_name] != location:
-                        should_print = True
-
-                    # Check optional fields (may or may not be present).
-                    decl_file_obj = ann.GetValueForKey("decl_file")
-                    if decl_file_obj.IsValid():
-                        decl_file = decl_file_obj.GetStringValue(1024)
-                        self.assertIsInstance(decl_file, str)
-                        self.assertIn("d_original_example.c", decl_file,
-                                    f"Expected source file d_original_example.c in {decl_file}")
-
-                    decl_line_obj = ann.GetValueForKey("decl_line")
-                    if decl_line_obj.IsValid():
-                        decl_line = decl_line_obj.GetUnsignedIntegerValue()
-                        self.assertIsInstance(decl_line, int)
-
-                        # Validate declaration line matches the source code (according to d_original_example.c).
-                        if var_name == "argc":
-                            self.assertEqual(decl_line, 3, "argc should be declared on line 3")
-                        elif var_name == "argv":
-                            self.assertEqual(decl_line, 3, "argv should be declared on line 3")
-                        elif var_name == "i":
-                            self.assertEqual(decl_line, 4, "i should be declared on line 4")
-
-                    type_name_obj = ann.GetValueForKey("type_name")
-                    if type_name_obj.IsValid():
-                        type_name = type_name_obj.GetStringValue(1024)
-                        self.assertIsInstance(type_name, str)
-
-                        # Validate declaration line matches the source code (according to d_original_example.c).
-                        if var_name == "argc":
-                            self.assertEqual(type_name, "int", "argc should be type 'int'")
-                        elif var_name == "argv":
-                            self.assertEqual(type_name, "char **", "argv should be type 'char **'")
-                        elif var_name == "i":
-                            self.assertEqual(type_name, "int", "i should be type 'int'")
-
-                if self.TraceOn():
-                    # Only print if something happened (location changed or variable appeared/disappeared).
-                    if should_print or len(current_locations) != len(prev_locations):
-                        print(f"\nInstruction {i} at {inst.GetAddress()}: {annotations.GetSize()} annotations")
-                        for var_name, location in current_locations.items():
-                            change_marker = " <- CHANGED" if var_name in prev_locations and prev_locations[var_name] != location else ""
-                            new_marker = " <- NEW" if var_name not in prev_locations else ""
-                            print(f"  {var_name} = {location}{change_marker}{new_marker}")
-                        # Check for disappeared variables.
-                        for var_name in prev_locations:
-                            if var_name not in current_locations:
-                                print(f"  {var_name} <- GONE")
-
-                # Update tracking.
-                prev_locations = current_locations.copy()
-
-        self.assertTrue(found_annotations,
-                       "Should find at least one instruction with variable annotations")
-
-        self.assertGreater(len(found_variables), 0,
-                         "Should find at least one variable")
-
         if self.TraceOn():
             print(f"\nTest complete. Found variables: {found_variables}")