[Debug] Add automatic device attribute dump on composition test failures

src/python_testing/TC_DeviceBasicComposition.py

@@ -189,7 +189,7 @@
 from matter.clusters.Types import Nullable
 from matter.exceptions import ChipStackError
 from matter.interaction_model import InteractionModelError, Status
-from matter.testing.basic_composition import BasicCompositionTests
+from matter.testing.basic_composition import BasicCompositionTests, log_structured_data
 from matter.testing.global_attribute_ids import (AttributeIdType, ClusterIdType, CommandIdType, GlobalAttributeIds,
                                                  attribute_id_type, cluster_id_type, command_id_type)
 from matter.testing.matter_testing import MatterBaseTest, TestStep, async_test_body, default_matter_test_main
@@ -271,7 +271,7 @@ def check_no_duplicates(obj: Any) -> None:
         raise ValueError(f"Value {str(obj)} contains duplicate values")
 
 
-class TC_DeviceBasicComposition(MatterBaseTest, BasicCompositionTests):
+class TC_DeviceBasicComposition(BasicCompositionTests, MatterBaseTest):
     @async_test_body
     async def setup_class(self):
         super().setup_class()
@@ -965,13 +965,6 @@ def test_TC_IDM_12_1(self):
         json_str, txt_str = self.dump_wildcard(dump_device_composition_path)
 
         # Structured dump so we can pull these back out of the logs
-        def log_structured_data(start_tag: str, dump_string):
-            lines = dump_string.splitlines()
-            logging.info(f'{start_tag}BEGIN ({len(lines)} lines)====')
-            for line in lines:
-                logging.info(f'{start_tag}{line}')
-            logging.info(f'{start_tag}END ====')
-
         log_structured_data('==== json: ', json_str)
         log_structured_data('==== txt: ', txt_str)
 

src/python_testing/TC_DeviceConformance.py

@@ -505,7 +505,7 @@ def check_root_node_restricted_clusters(self) -> list[ProblemNotice]:
         return problems
 
 
-class TC_DeviceConformance(MatterBaseTest, DeviceConformanceTests):
+class TC_DeviceConformance(DeviceConformanceTests, MatterBaseTest):
     @async_test_body
     async def setup_class(self):
         super().setup_class()

src/python_testing/matter_testing_infrastructure/matter/testing/basic_composition.py

@@ -41,6 +41,23 @@
 LOGGER = logging.getLogger(__name__)
 
 
+def log_structured_data(start_tag: str, dump_string: str):
+    """Log structured data with a clear start and end marker.
+
+    This function is used to output device attribute dumps and other structured 
+    data to logs in a format that can be easily extracted for debugging.
+
+    Args:
+        start_tag: A prefix tag to identify the type of data being logged
+        dump_string: The data to be logged
+    """
+    lines = dump_string.splitlines()
+    LOGGER.info(f'{start_tag}BEGIN ({len(lines)} lines)====')
+    for line in lines:
+        LOGGER.info(f'{start_tag}{line}')
+    LOGGER.info(f'{start_tag}END ====')
+
+
 @dataclass
 class ArlData:
     have_arl: bool
@@ -278,3 +295,27 @@ def build_spec_xmls(self):
         self.xml_clusters, self.problems = build_xml_clusters(dm)
         self.xml_device_types, problems = build_xml_device_types(dm)
         self.problems.extend(problems)
+
+    def teardown_class(self):
+        """Override teardown_class to dump device attribute data when problems are found.
+
+        This ensures that whenever any test inheriting from BasicCompositionTests has problems,
+        we automatically get the device attribute dump for debugging purposes.
+        """
+        # Check if we have problems and device attributes are available
+        if len(self.problems) > 0:
+            LOGGER.info("BasicCompositionTests: Problems detected - attempting device attribute dump")
+            try:
+                if hasattr(self, 'endpoints_tlv') and self.endpoints_tlv:
+                    LOGGER.info("Device attribute data available - generating dump")
+                    _, txt_str = self.dump_wildcard(None)
+                    # Only dump the text format - it's more readable for debugging
+                    log_structured_data('==== FAILURE_DUMP_txt: ', txt_str)
+                else:
+                    LOGGER.info("No device attribute data available (endpoints_tlv not populated)")
+            except Exception as e:
+                # Don't let logging errors interfere with the original test failure
+                LOGGER.warning(f"Failed to generate device attribute dump: {e}")
+
+        # Call the parent teardown_class method to handle normal teardown and problem logging
+        super().teardown_class()