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
|
#!/usr/bin/env python3
# $Id$
# Author: Dave Kuhlman <dkuhlman@rexx.com>
# Copyright: This module has been placed in the public domain.
"""
Tests for docutils odtwriter.
Instructions for adding a new test:
1. Add a new method to class DocutilsOdtTestCase (below) named
test_odt_xxxx, where xxxx describes your new feature. See
test_odt_basic for an example.
2. Add a new input reST (.txt) file in test/functional/input. This
file should contain the smallest amount of reST that tests your
new feature. Name this file odt_xxxx.txt.
3. Convert your input reST (.txt) file to an ODF (.odt) file using
rst2odt.py. Place this ODF (.odt) file in
test/functional/expected. Name this file odt_xxxx.odt.
You can also pass parameter save_output_name='filename' to method
process_test() in order to produce expected output.
See and modify variable TEMP_FILE_PATH for destination.
4. Run your test. Your new test should pass.
5. If any other tests fail, that's a possible regression.
"""
from io import BytesIO
from pathlib import Path
import os
import sys
import unittest
import xml.etree.ElementTree as etree
import zipfile
if __name__ == '__main__':
# prepend the "docutils root" to the Python library path
# so we import the local `docutils` package.
sys.path.insert(0, str(Path(__file__).resolve().parents[2]))
import docutils
import docutils.core
# FUNCTIONAL_ROOT is ./test/functional/ from the docutils root
FUNCTIONAL_ROOT = os.path.abspath(os.path.join(__file__, '..', '..', 'functional'))
#
# Globals
TEMP_FILE_PATH = os.path.join(FUNCTIONAL_ROOT, 'output')
INPUT_PATH = os.path.join(FUNCTIONAL_ROOT, 'input')
EXPECTED_PATH = os.path.join(FUNCTIONAL_ROOT, 'expected')
class DocutilsOdtTestCase(unittest.TestCase):
def process_test(self, input_filename, expected_filename,
save_output_name=None, settings_overrides=None):
# Test that xmlcharrefreplace is the default output encoding
# error handler.
input_file = open(os.path.join(INPUT_PATH, input_filename), 'rb')
expected_file = open(os.path.join(EXPECTED_PATH, expected_filename), 'rb')
input = input_file.read()
expected = expected_file.read()
input_file.close()
expected_file.close()
if settings_overrides is None:
settings_overrides = {}
settings_overrides['_disable_config'] = True
settings_overrides['language_code'] = 'en-US'
result = docutils.core.publish_string(
source=input,
reader_name='standalone',
writer_name='odf_odt',
settings_overrides=settings_overrides)
# msg = 'file length not equal: expected length: %d actual length: %d' % (
# len(expected), len(result), )
# self.assertEqual(str(len(result)), str(len(expected)))
if save_output_name:
filename = os.path.join(TEMP_FILE_PATH, save_output_name)
outfile = open(filename, 'wb')
outfile.write(result)
outfile.close()
content1 = self.extract_file(result, 'content.xml')
content2 = self.extract_file(expected, 'content.xml')
msg = 'content.xml not equal: expected len: %d actual len: %d' % (
len(content2), len(content1), )
self.assertEqual(content1, content2, msg)
def reorder_attributes(self, root):
"""
Make attribute order independent of python version.
python3.8 is different to previous.
"""
for el in root.iter():
attrib = el.attrib
if len(attrib) > 1:
# adjust attribute order, e.g. by sorting
attribs = sorted(attrib.items())
attrib.clear()
attrib.update(attribs)
def extract_file(self, payload, filename):
payloadfile = BytesIO()
payloadfile.write(payload)
payloadfile.seek(0)
zfile = zipfile.ZipFile(payloadfile, 'r')
content1 = zfile.read(filename)
doc = etree.fromstring(content1)
self.reorder_attributes(doc)
# return doc.toprettyxml(indent=' ')
return etree.tostring(doc)
#
# Unit test methods
#
# All test methods should be named "test_odt_xxxx", where
# xxxx is replaced with a name for the new test.
# See instructions above in module doc-string.
#
def test_odt_basic(self):
self.process_test('odt_basic.txt', 'odt_basic.odt',
save_output_name='odt_basic.odt')
def test_odt_nested_class(self):
self.process_test('odt_nested_class.txt',
'odt_nested_class.odt',
save_output_name='odt_nested_class.odt')
self.process_test('odt_unnested_class.txt',
'odt_unnested_class.odt',
save_output_name='odt_unnested_class.odt')
self.process_test('odt_no_class.txt',
'odt_no_class.odt',
save_output_name='odt_no_class.odt')
def test_odt_tables1(self):
self.process_test('odt_tables1.txt', 'odt_tables1.odt',
save_output_name='odt_tables1.odt')
def test_odt_custom_headfoot(self):
settings_overrides = {
'custom_header': 'Page %p% of %P%',
'custom_footer': 'Title: %t% Date: %d3% Time: %t4%',
'language_code': 'en-US',
}
self.process_test('odt_custom_headfoot.txt', 'odt_custom_headfoot.odt',
settings_overrides=settings_overrides,
save_output_name='odt_custom_headfoot.odt')
def test_odt_header_footer(self):
self.process_test('odt_header_footer.txt', 'odt_header_footer.odt',
save_output_name='odt_header_footer.odt')
def test_odt_literal_block(self):
self.process_test('odt_literal_block.txt', 'odt_literal_block.odt')
def test_odt_contents(self):
self.process_test('odt_contents.txt', 'odt_contents.odt')
def test_odt_classifier(self):
self.process_test('odt_classifier.txt', 'odt_classifier.odt')
def test_odt_footnotes(self):
self.process_test('odt_footnotes.txt', 'odt_footnotes.odt',
save_output_name='odt_footnotes.odt')
def test_odt_raw(self):
self.process_test('odt_raw.txt', 'odt_raw.odt',
save_output_name='odt_raw.odt')
#
# Template for new tests.
# Also add functional/input/odt_xxxx.txt and
# functional/expected/odt_xxxx.odt
# Replace all xxxx with name of your test.
#
# def test_odt_xxxx(self):
# self.process_test('odt_xxxx.txt', 'odt_xxxx.odt')
# -----------------------------------------------------------------
if __name__ == '__main__':
unittest.main()
|
