-
-
Notifications
You must be signed in to change notification settings - Fork 175
/
test_junit.py
342 lines (305 loc) · 14.5 KB
/
test_junit.py
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
import dataclasses
import pathlib
import re
import sys
import unittest
from distutils.version import LooseVersion
from glob import glob
from typing import Optional, List
import junitparser
import prettyprinter as pp
from junitparser import JUnitXml, Element
from lxml import etree
sys.path.append(str(pathlib.Path(__file__).resolve().parent.parent))
sys.path.append(str(pathlib.Path(__file__).resolve().parent))
from publish.junit import parse_junit_xml_files, process_junit_xml_elems, get_results, get_result, get_content, \
get_message, Disabled, JUnitTreeOrParseError, ParseError
from publish.unittestresults import ParsedUnitTestResults, UnitTestCase
from test_utils import temp_locale
test_path = pathlib.Path(__file__).resolve().parent
test_files_path = test_path / 'files' / 'junit-xml'
pp.install_extras()
class TestElement(Element):
__test__ = False
def __init__(self, tag: str, message: Optional[str] = None, content: Optional[str] = None):
super().__init__(tag)
self._tag = tag
self.message = message
self._elem.text = content
@property
def text(self):
return self._elem.text
class JUnitXmlParseTest:
@property
def test(self):
raise NotImplementedError()
@staticmethod
def _test_files_path() -> pathlib.Path:
raise NotImplementedError()
@staticmethod
def get_test_files() -> List[str]:
raise NotImplementedError()
@staticmethod
def parse_file(filename) -> JUnitTreeOrParseError:
raise NotImplementedError()
@staticmethod
def assert_expectation(test, actual, filename):
with open(filename, 'r', encoding='utf-8') as r:
expected = r.read()
test.assertEqual(expected, actual)
@classmethod
def shorten_filename(cls, filename):
return filename[len(str(cls._test_files_path().resolve().as_posix())) + 1:]
def do_test_parse_and_process_files(self, filename: str):
for locale in [None, 'en_US.UTF-8', 'de_DE.UTF-8']:
with self.test.subTest(file=self.shorten_filename(filename), locale=locale):
with temp_locale(locale):
actual = self.parse_file(filename)
path = pathlib.Path(filename)
if isinstance(actual, ParseError):
# make file relative so the path in the exception file does not depend on where we checkout the sources
actual = dataclasses.replace(actual, file=str(pathlib.Path(actual.file).relative_to(test_path).as_posix()))
actual = self.prettify_exception(actual)
expectation_path = path.parent / (path.stem + '.exception')
self.assert_expectation(self.test, actual, expectation_path)
else:
xml_expectation_path = path.parent / (path.stem + '.junit-xml')
actual_tree = etree.tostring(actual, encoding='utf-8', xml_declaration=True, pretty_print=True).decode('utf-8')
self.assert_expectation(self.test, actual_tree, xml_expectation_path)
results_expectation_path = path.parent / (path.stem + '.results')
actual_results = process_junit_xml_elems([(self.shorten_filename(str(path.resolve().as_posix())), actual)])
self.assert_expectation(self.test, pp.pformat(actual_results, indent=2), results_expectation_path)
def test_parse_and_process_files(self):
for file in self.get_test_files():
self.do_test_parse_and_process_files(file)
@classmethod
def update_expectations(cls):
print('updating expectations')
for filename in cls.get_test_files():
print(f'- updating {filename}')
actual = cls.parse_file(filename)
path = pathlib.Path(filename).resolve()
if isinstance(actual, ParseError):
# make file relative so the path in the exception file does not depend on where we checkout the sources
actual = dataclasses.replace(actual, file=str(pathlib.Path(actual.file).relative_to(test_path).as_posix()))
with open(path.parent / (path.stem + '.exception'), 'w', encoding='utf-8') as w:
w.write(cls.prettify_exception(actual))
else:
with open(path.parent / (path.stem + '.junit-xml'), 'w', encoding='utf-8') as w:
xml = etree.tostring(actual, encoding='utf-8', xml_declaration=True, pretty_print=True)
w.write(xml.decode('utf-8'))
with open(path.parent / (path.stem + '.results'), 'w', encoding='utf-8') as w:
results = process_junit_xml_elems([(cls.shorten_filename(str(path.resolve().as_posix())), actual)])
w.write(pp.pformat(results, indent=2))
@staticmethod
def prettify_exception(exception) -> str:
exception = exception.__repr__()
exception = re.sub(r'\(', ': ', exception, 1)
exception = re.sub(r',?\s*\)$', '', exception)
return exception
class TestJunit(unittest.TestCase, JUnitXmlParseTest):
maxDiff = None
@property
def test(self):
return self
@staticmethod
def _test_files_path() -> pathlib.Path:
return test_files_path
@staticmethod
def get_test_files() -> List[str]:
return glob(str(test_files_path / '**' / '*.xml'), recursive=True)
@staticmethod
def parse_file(filename) -> JUnitTreeOrParseError:
return list(parse_junit_xml_files([filename]))[0][1]
def test_process_parse_junit_xml_files_with_no_files(self):
self.assertEqual(
process_junit_xml_elems(parse_junit_xml_files([])),
ParsedUnitTestResults(
files=0,
errors=[],
suites=0,
suite_tests=0,
suite_skipped=0,
suite_failures=0,
suite_errors=0,
suite_time=0,
cases=[]
))
# tests https://github.com/weiwei/junitparser/issues/64
def test_junitparser_locale(self):
junit = JUnitXml.fromfile(str(test_files_path / 'pytest' / 'junit.spark.integration.1.xml'))
self.assertAlmostEqual(162.933, junit.time, 3)
@unittest.skipIf(LooseVersion(junitparser.version) < LooseVersion('2.0.0'),
'multiple results per test case not supported by junitparser')
def test_parse_junit_xml_file_with_multiple_results(self):
junit = process_junit_xml_elems(parse_junit_xml_files([str(test_files_path / 'junit.multiresult.xml')]))
self.assertEqual(4, len(junit.cases))
self.assertEqual("error", junit.cases[0].result)
self.assertEqual("failure", junit.cases[1].result)
self.assertEqual("skipped", junit.cases[2].result)
self.assertEqual("success", junit.cases[3].result)
def test_process_parse_junit_xml_files_with_time_factor(self):
result_file = str(test_files_path / 'scalatest' / 'TEST-uk.co.gresearch.spark.diff.DiffOptionsSuite.xml')
for time_factor in [1.0, 10.0, 60.0, 0.1, 0.001]:
with self.subTest(time_factor=time_factor):
self.assertEqual(
process_junit_xml_elems(parse_junit_xml_files([result_file]), time_factor),
ParsedUnitTestResults(
files=1,
errors=[],
suites=1,
suite_tests=5,
suite_skipped=0,
suite_failures=0,
suite_errors=0,
suite_time=int(2.222 * time_factor),
cases=[
UnitTestCase(
class_name='uk.co.gresearch.spark.diff.DiffOptionsSuite',
result_file=result_file,
test_file=None,
line=None,
test_name='diff options with empty diff column name',
result='success',
content=None,
message=None,
time=0.259 * time_factor
),
UnitTestCase(
class_name='uk.co.gresearch.spark.diff.DiffOptionsSuite',
result_file=result_file,
test_name='diff options left and right prefixes',
test_file=None,
line=None,
result='success',
content=None,
message=None,
time=1.959 * time_factor
),
UnitTestCase(
class_name='uk.co.gresearch.spark.diff.DiffOptionsSuite',
result_file=result_file,
test_name='diff options diff value',
test_file=None,
line=None,
result='success',
content=None,
message=None,
time=0.002 * time_factor
),
UnitTestCase(
class_name='uk.co.gresearch.spark.diff.DiffOptionsSuite',
result_file=result_file,
test_name='diff options with change column name same as diff column',
test_file=None,
line=None,
result='success',
content=None,
message=None,
time=0.002 * time_factor
),
UnitTestCase(
class_name='uk.co.gresearch.spark.diff.DiffOptionsSuite',
result_file=result_file,
test_name='fluent methods of diff options',
test_file=None,
line=None,
result='success',
content=None,
message=None,
time=0.001 * time_factor
)
]
))
def test_get_results(self):
success = TestElement('success')
skipped = TestElement('skipped')
failure = TestElement('failure')
error = TestElement('error')
tests = [
([], []),
([success], [success]),
([skipped], [skipped]),
([failure], [failure]),
([error], [error]),
([success, success], [success, success]),
([success, success, skipped], [success, success]),
([success, success, failure], [failure]),
([success, success, failure, failure], [failure, failure]),
([success, success, failure, failure, error], [error]),
([success, success, failure, failure, error, error], [error, error]),
([success, success, skipped, failure, failure, error, error], [error, error]),
([skipped, skipped], [skipped, skipped]),
]
for results, expected in tests:
with self.subTest(results=results):
actual = get_results(results)
self.assertEqual(expected, actual)
def test_get_results_with_disabled_status(self):
disabled = Disabled()
success = TestElement('success')
skipped = TestElement('skipped')
failure = TestElement('failure')
error = TestElement('error')
tests = [
([], [disabled]),
([success], [success]),
([skipped], [skipped]),
([failure], [failure]),
([error], [error]),
]
for results, expected in tests:
with self.subTest(results=results):
actual = get_results(results, 'disabled')
self.assertEqual(expected, actual)
def test_get_result(self):
success = TestElement('success')
skipped = TestElement('skipped')
failure = TestElement('failure')
error = TestElement('error')
tests = [
([], 'success'),
([success], 'success'),
([skipped], 'skipped'),
([failure], 'failure'),
([error], 'error'),
([success, success], 'success'),
([skipped, skipped], 'skipped'),
([failure, failure], 'failure'),
([error, error], 'error'),
(success, 'success'),
(skipped, 'skipped'),
(failure, 'failure'),
(error, 'error'),
(None, 'success')
]
for results, expected in tests:
with self.subTest(results=results):
actual = get_result(results)
self.assertEqual(expected, actual)
def test_get_message(self):
tests = [
([], None),
([TestElement('failure', message=None)], None),
([TestElement('failure', message='failure')], 'failure'),
([TestElement('failure', message='failure one'), TestElement('failure', message=None)], 'failure one'),
([TestElement('failure', message='failure one'), TestElement('failure', message='failure two')], 'failure one\nfailure two'),
]
for results, expected in tests:
with self.subTest(results=results):
actual = get_message(results)
self.assertEqual(expected, actual)
def test_get_content(self):
tests = [
([], None),
([TestElement('failure', content=None)], None),
([TestElement('failure', content='failure')], 'failure'),
([TestElement('failure', content='failure one'), TestElement('failure', content=None)], 'failure one'),
([TestElement('failure', content='failure one'), TestElement('failure', content='failure two')], 'failure one\nfailure two'),
]
for results, expected in tests:
with self.subTest(results=results):
actual = get_content(results)
self.assertEqual(expected, actual)
if __name__ == "__main__":
TestJunit.update_expectations()