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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
import pytest
import os
import sys
from io import BytesIO, StringIO
from tempfile import NamedTemporaryFile
from unittest import skipIf
from junitparser import (
TestCase,
TestSuite,
JUnitXmlError,
JUnitXml
)
try:
from lxml.etree import XMLParser # noqa: F401
has_lxml = True
except ImportError:
has_lxml = False
python_major = int(sys.version.split(".")[0])
python_minor = int(sys.version.split(".")[1])
def get_expected_xml(test_case_name: str, test_suites: bool = True, newlines: bool = False):
if python_major == 3 and python_minor <= 7 and not has_lxml:
expected_test_suite = '<testsuite errors="0" failures="0" name="suite1" skipped="0" tests="1" time="0">'
else:
expected_test_suite = '<testsuite name="suite1" tests="1" errors="0" failures="0" skipped="0" time="0">'
if has_lxml:
encoding = "UTF-8"
closing_tag = '/'
else:
encoding = "utf-8"
closing_tag = ' /'
if test_suites:
start_test_suites = "<testsuites>"
end_test_suites = "</testsuites>"
else:
start_test_suites = ""
end_test_suites = ""
eol = "\n" if newlines else ""
indent = " " if newlines else ""
return (
f"<?xml version='1.0' encoding='{encoding}'?>\n"
f'{start_test_suites}{expected_test_suite}{eol}'
f'{indent}<testcase name="{test_case_name}"{closing_tag}>{eol}'
f'</testsuite>{end_test_suites}'
)
def test_write_xml_without_testsuite_tag():
suite = TestSuite()
suite.name = "suite1"
case = TestCase()
case.name = "case1"
suite.add_testcase(case)
xmlfile = BytesIO()
suite.write(xmlfile)
assert xmlfile.getvalue().decode("utf-8") == get_expected_xml("case1", False)
def do_test_write(write_arg, read_func):
suite1 = TestSuite()
suite1.name = "suite1"
case1 = TestCase()
case1.name = "case1"
suite1.add_testcase(case1)
result = JUnitXml()
result.add_testsuite(suite1)
result.write(write_arg)
text = read_func()
assert text == get_expected_xml("case1")
@skipIf(os.name == 'nt' and python_major == 3 and python_minor <= 11, "Not for Windows with Python ≤3.11")
def test_write():
kwargs = dict(delete_on_close=False) if os.name == 'nt' else {}
with NamedTemporaryFile(suffix=".xml", **kwargs) as tmpfile:
if os.name == "nt":
# needed by Windows
tmpfile.close()
def read():
with open(tmpfile.name, "rt") as file_obj:
return file_obj.read()
do_test_write(tmpfile.name, read)
@skipIf(os.name == 'nt' and python_major == 3 and python_minor <= 11, "Not for Windows with Python ≤3.11")
def test_write_file_obj():
kwargs = dict(delete_on_close=False) if os.name == 'nt' else {}
with NamedTemporaryFile(suffix=".xml", mode="wb", **kwargs) as tmp_file:
def read():
tmp_file.flush()
if os.name == "nt":
# needed by Windows
tmp_file.close()
with open(tmp_file.name, "rt") as file_obj:
return file_obj.read()
do_test_write(tmp_file, read)
def test_write_stdout_stderr(capsys):
def read_stdout():
captured = capsys.readouterr()
return captured.out
def read_stderr():
captured = capsys.readouterr()
return captured.err
do_test_write(sys.stdout, read_stdout)
do_test_write(sys.stderr, read_stderr)
do_test_write(sys.stdout.buffer, read_stdout)
do_test_write(sys.stderr.buffer, read_stderr)
def test_write_stringio_bytesio():
obj = BytesIO()
do_test_write(obj, lambda: obj.getvalue().decode("utf-8"))
with pytest.raises(TypeError) as e:
do_test_write(StringIO(), lambda: "")
assert e.value.args == ("string argument expected, got 'bytes'", )
def test_write_filelike_obj():
# a file-like object providing a write method only
class FileObject:
content = BytesIO()
def write(self, buf):
return self.content.write(buf)
def _read(self):
self.content.seek(0)
return self.content.read().decode("utf-8")
filelike_obj = FileObject()
do_test_write(filelike_obj, filelike_obj._read)
def test_write_noarg():
suite1 = TestSuite()
suite1.name = "suite1"
case1 = TestCase()
case1.name = "case1"
suite1.add_testcase(case1)
result = JUnitXml()
result.add_testsuite(suite1)
with pytest.raises(JUnitXmlError):
result.write()
def test_write_nonascii():
suite1 = TestSuite()
suite1.name = "suite1"
case1 = TestCase()
case1.name = "用例1"
suite1.add_testcase(case1)
result = JUnitXml()
result.add_testsuite(suite1)
xmlfile = BytesIO()
result.write(xmlfile)
assert xmlfile.getvalue().decode("utf-8") == get_expected_xml("用例1")
def test_write_no_testsuites():
# Has to be a binary string to include xml declarations.
text = b"""<?xml version='1.0' encoding='UTF-8'?>
<testsuite name="suite1" tests="1" errors="0" failures="0" skipped="0" time="0">
<testcase name="case1"/>
</testsuite>"""
xml = JUnitXml.fromstring(text)
assert isinstance(xml, JUnitXml)
suite = next(iter(xml))
assert isinstance(suite, TestSuite)
case = next(iter(suite))
assert isinstance(case, TestCase)
assert len(case.result) == 0
# writing this JUnitXml object contains a root <testsuites> element
xmlfile = BytesIO()
xml.write(xmlfile)
assert xmlfile.getvalue().decode("utf-8") == get_expected_xml("case1", test_suites=True, newlines=True)
# writing the inner testsuite reproduces the input string
xmlfile = BytesIO()
suite.write(xmlfile)
assert xmlfile.getvalue().decode("utf-8") == get_expected_xml("case1", test_suites=False, newlines=True)
def test_read_written_xml():
suite1 = TestSuite()
suite1.name = "suite1"
case1 = TestCase()
case1.name = "用例1"
suite1.add_testcase(case1)
result = JUnitXml()
result.add_testsuite(suite1)
xmlfile = BytesIO()
result.write(xmlfile)
assert xmlfile.getvalue().decode("utf-8") == get_expected_xml("用例1")
xmlfile.seek(0)
xml = JUnitXml.fromfile(xmlfile)
suite = next(iter(xml))
case = next(iter(suite))
assert case.name == "用例1"
def do_test_write_pretty(write_arg, read_func):
suite1 = TestSuite()
suite1.name = "suite1"
case1 = TestCase()
case1.name = "用例1"
suite1.add_testcase(case1)
result = JUnitXml()
result.add_testsuite(suite1)
result.write(write_arg, pretty=True)
written = read_func()
if python_major == 3 and python_minor <= 7:
assert written == (
'<?xml version="1.0" encoding="utf-8"?>\n'
'<testsuites>\n'
'\t<testsuite errors="0" failures="0" name="suite1" skipped="0" tests="1" time="0">\n'
'\t\t<testcase name="用例1"/>\n'
'\t</testsuite>\n'
'</testsuites>\n'
)
else:
assert written == (
'<?xml version="1.0" encoding="utf-8"?>\n'
'<testsuites>\n'
'\t<testsuite name="suite1" tests="1" errors="0" failures="0" skipped="0" time="0">\n'
'\t\t<testcase name="用例1"/>\n'
'\t</testsuite>\n'
'</testsuites>\n'
)
xml = JUnitXml.fromstring(written.encode("utf-8"))
suite = next(iter(xml))
case = next(iter(suite))
assert case.name == "用例1"
def test_write_pretty(capsys):
xmlfile = BytesIO()
do_test_write_pretty(xmlfile, lambda: xmlfile.getvalue().decode("utf-8"))
string = StringIO()
with pytest.raises(TypeError) as e:
do_test_write_pretty(string, lambda: "")
assert (e.value.args == ("string argument expected, got 'bytes'",))
def read_stdout():
captured = capsys.readouterr()
return captured.out
def read_stderr():
captured = capsys.readouterr()
return captured.err
do_test_write_pretty(sys.stdout, read_stdout)
do_test_write_pretty(sys.stderr, read_stderr)
do_test_write_pretty(sys.stdout.buffer, read_stdout)
do_test_write_pretty(sys.stderr.buffer, read_stderr)
|
