oxml: add unit tests for serialize_for_reading()

Steve Canny · Steve Canny · commit 8ae8ba5fdf36 · 2014-06-15T12:27:29.000-07:00
diff --git a/docx/compat.py b/docx/compat.py
@@ -24,6 +24,8 @@ def is_string(obj):
         """
         return isinstance(obj, str)
 
+    Unicode = str
+
 # ===========================================================================
 # Python 2 versions
 # ===========================================================================
@@ -37,3 +39,5 @@ def is_string(obj):
         Return True if *obj* is a string, False otherwise.
         """
         return isinstance(obj, basestring)
+
+    Unicode = unicode
diff --git a/docx/oxml/xmlchemy.py b/docx/oxml/xmlchemy.py
@@ -11,6 +11,8 @@
 
 import re
 
+from ..compat import Unicode
+
 
 def serialize_for_reading(element):
     """
@@ -21,7 +23,7 @@ def serialize_for_reading(element):
     return XmlString(xml)
 
 
-class XmlString(str):
+class XmlString(Unicode):
     """
     Provides string comparison override suitable for serialized XML that is
     useful for tests.
diff --git a/tests/oxml/test_xmlchemy.py b/tests/oxml/test_xmlchemy.py
@@ -8,7 +8,43 @@
 
 import pytest
 
-from docx.oxml.xmlchemy import XmlString
+from docx.compat import Unicode
+from docx.oxml import parse_xml
+from docx.oxml.xmlchemy import serialize_for_reading, XmlString
+
+
+class DescribeSerializeForReading(object):
+
+    def it_pretty_prints_an_lxml_element(self, pretty_fixture):
+        element, expected_xml_text = pretty_fixture
+        xml_text = serialize_for_reading(element)
+        assert xml_text == expected_xml_text
+
+    def it_returns_unicode_text(self, type_fixture):
+        element = type_fixture
+        xml_text = serialize_for_reading(element)
+        assert isinstance(xml_text, Unicode)
+
+    # fixtures ---------------------------------------------
+
+    @pytest.fixture
+    def pretty_fixture(self, element):
+        expected_xml_text = (
+            '<foø>\n'
+            '  <bår>text</bår>\n'
+            '</foø>\n'
+        )
+        return element, expected_xml_text
+
+    @pytest.fixture
+    def type_fixture(self, element):
+        return element
+
+    # fixture components -----------------------------------
+
+    @pytest.fixture
+    def element(self):
+        return parse_xml('<foø><bår>text</bår></foø>')
 
 
 class DescribeXmlString(object):
