1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
#!/usr/bin/env python
# $Id: test_docutils_xml.py 7966 2016-08-18 13:06:09Z milde $
# Author: Lea Wiemann <LeWiemann@gmail.com>
# Copyright: This module has been placed in the public domain.
"""
Test for docutils XML writer.
.. Attention::
While the tests compare the output on the string-level, no guarantee
is given against changes to identical XML representations like
``<empty></empty>`` vs. ``<empty/>``. The sample strings in this test
module mirrors the current behaviour of the docutils_xml writer.
"""
from StringIO import StringIO
from __init__ import DocutilsTestSupport # must be imported before docutils
import docutils
import docutils.core
# sample strings
# --------------
source = u"""\
Test
----------
Test. \xe4\xf6\xfc\u20ac"""
xmldecl = u"""<?xml version="1.0" encoding="iso-8859-1"?>
"""
doctypedecl = u"""\
<!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net\
//DTD Docutils Generic//EN//XML"\
"http://docutils.sourceforge.net/docs/ref/docutils.dtd">
"""
generatedby = u'<!-- Generated by Docutils %s -->\n' % docutils.__version__
bodynormal = u"""\
<document source="<string>"><paragraph>Test</paragraph>\
<transition></transition><paragraph>Test. \xe4\xf6\xfc€</paragraph>\
</document>"""
bodynewlines = u"""\
<document source="<string>">
<paragraph>Test</paragraph>
<transition></transition>
<paragraph>Test. \xe4\xf6\xfc€</paragraph>
</document>
"""
bodyindents = u"""\
<document source="<string>">
<paragraph>Test</paragraph>
<transition></transition>
<paragraph>Test. \xe4\xf6\xfc€</paragraph>
</document>
"""
# raw XML
# """""""
raw_xml_source = u"""\
.. raw:: xml
<root>
<child>Test \xe4\xf6\xfc\u20ac</child>
>
<
</root>
.. role:: xml(raw)
:format: xml
:xml:`<test>inline raw XML</test>`.
"""
raw_xml = u"""\
<document source="<string>">
<raw format="xml" xml:space="preserve"><root>
<child>Test \xe4\xf6\xfc€</child>
>
<
</root></raw>
<paragraph><raw classes="xml" format="xml" xml:space="preserve">\
<test>inline raw XML</test></raw>.</paragraph>
</document>
"""
invalid_raw_xml_source = u"""\
.. raw:: xml
<root>
<child>Test \xe4\xf6\xfc\u20ac</child>
</mismatch>
.. role:: xml(raw)
:format: xml
:xml:`<test>inline raw XML</test>`.
"""
invalid_raw_xml = u"""\
<document source="<string>">
<raw format="xml" xml:space="preserve"><root>
<child>Test \xe4\xf6\xfc\u20ac</child>
</mismatch></raw>
<paragraph><raw classes="xml" format="xml" xml:space="preserve">\
<test>inline raw XML</test></raw>.</paragraph>
</document>
"""
def publish_xml(settings, source):
return docutils.core.publish_string(source=source.encode('utf8'),
reader_name='standalone',
writer_name='docutils_xml',
settings_overrides=settings)
# XML Test Case
# -------------
class DocutilsXMLTestCase(DocutilsTestSupport.StandardTestCase):
settings = {'input_encoding': 'utf8',
'output_encoding': 'iso-8859-1',
'_disable_config': True,
'indents': False,
'newlines': True,
'xml_declaration': False,
'doctype_declaration': False,
}
def test_publish(self):
settings = self.settings.copy()
settings['newlines'] = False
for settings['xml_declaration'] in True, False:
for settings['doctype_declaration'] in True, False:
expected = u''
if settings['xml_declaration']:
expected += xmldecl
if settings['doctype_declaration']:
expected += doctypedecl
expected += generatedby
expected += bodynormal
result = publish_xml(settings, source)
self.assertEqual(result, expected.encode('latin1'))
def test_publish_indents(self):
settings = self.settings.copy()
settings['indents'] = True
result = publish_xml(settings, source)
expected = (generatedby + bodyindents).encode('latin1')
self.assertEqual(result, expected)
def test_publish_newlines(self):
settings = self.settings.copy()
result = publish_xml(settings, source)
expected = (generatedby + bodynewlines).encode('latin1')
self.assertEqual(result, expected)
def test_raw_xml(self):
result = publish_xml(self.settings, raw_xml_source)
expected = (generatedby
+ raw_xml).encode('latin1', 'xmlcharrefreplace')
self.assertEqual(result, expected)
def test_invalid_raw_xml(self):
warnings = StringIO()
settings = self.settings.copy()
settings['warning_stream'] = warnings
result = publish_xml(settings, invalid_raw_xml_source)
expected = (generatedby
+ invalid_raw_xml).encode('latin1', 'xmlcharrefreplace')
self.assertEqual(result, expected)
warnings.seek(0)
self.assertEqual(warnings.readlines(),
[u'<string>:5: '
u'(WARNING/2) Invalid raw XML in column 2, line offset 3:\n',
u'<root>\n',
u' <child>Test \xe4\xf6\xfc\u20ac</child>\n',
u'</mismatch>\n',
u'<string>:10: '
u'(WARNING/2) Invalid raw XML in column 30, line offset 1:\n',
u'<test>inline raw XML</test>\n'])
# abort with SystemMessage if halt_level is "info":
settings['halt_level'] = 2
settings['warning_stream'] = ''
self.assertRaises(docutils.utils.SystemMessage,
publish_xml, settings, invalid_raw_xml_source)
if __name__ == '__main__':
import unittest
unittest.main()
|
