Pretty-print XML in Studio edit

apps/openassessment/xblock/test/test_xml.py

@@ -77,6 +77,11 @@ class TestSerializeContent(TestCase):
         # instead of a test failure.
         parsed_expected = etree.fromstring("".join(data['expected_xml']))
 
+        # Pretty-print and reparse the expected XML
+        pretty_expected = etree.tostring(parsed_expected, pretty_print=True, encoding='utf-8')
+        parsed_expected = etree.fromstring(pretty_expected)
+
+
         # Walk both trees, comparing elements and attributes
         actual_elements = [el for el in parsed_actual.getiterator()]
         expected_elements = [el for el in parsed_expected.getiterator()]
@@ -88,8 +93,14 @@ class TestSerializeContent(TestCase):
 
         for actual, expected in zip(actual_elements, expected_elements):
             self.assertEqual(actual.tag, expected.tag)
-            self.assertEqual(actual.text, expected.text)
-            self.assertItemsEqual(actual.items(), expected.items())
+            self.assertEqual(
+                actual.text, expected.text,
+                msg="Incorrect text for {tag}".format(tag=actual.tag)
+            )
+            self.assertItemsEqual(
+                actual.items(), expected.items(),
+                msg="Incorrect attributes for {tag}".format(tag=actual.tag)
+            )
 
     def test_mutated_criteria_dict(self):
         self.oa_block.title = "Test title"

apps/openassessment/xblock/xml.py

@@ -429,7 +429,7 @@ def serialize_content(oa_block):
     _serialize_rubric(rubric_root, oa_block)
 
     # Return a UTF-8 representation of the XML
-    return etree.tostring(root, encoding='utf-8')
+    return etree.tostring(root, pretty_print=True, encoding='utf-8')
 
 
 def update_from_xml(