1 # Python module for parsing and generating the Subunit protocol
3 # Copyright (C) 2008-2009 Jelmer Vernooij <jelmer@samba.org>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 __all__
= ['parse_results']
24 from samba
import subunit
25 from samba
.subunit
.run
import TestProtocolClient
28 from dateutil
.parser
import isoparse
as iso_parse_date
31 from iso8601
import parse_date
as iso_parse_date
;
33 print('Install either python-dateutil >= 2.7.1 or python-iso8601')
36 VALID_RESULTS
= set(['success', 'successful', 'failure', 'fail', 'skip',
37 'knownfail', 'error', 'xfail', 'skip-testsuite',
38 'testsuite-failure', 'testsuite-xfail',
39 'testsuite-success', 'testsuite-error',
40 'uxsuccess', 'testsuite-uxsuccess'])
43 class TestsuiteEnabledTestResult(unittest
.TestResult
):
45 def start_testsuite(self
, name
):
46 raise NotImplementedError(self
.start_testsuite
)
49 def parse_results(msg_ops
, statistics
, fh
):
54 parts
= l
.split(None, 1)
55 if not len(parts
) == 2 or not l
.startswith(parts
[0]):
58 command
= parts
[0].rstrip(":")
60 if command
in ("test", "testing"):
61 msg_ops
.control_msg(l
)
63 test
= subunit
.RemotedTestCase(name
)
64 if name
in open_tests
:
65 msg_ops
.addError(open_tests
.pop(name
), subunit
.RemoteError(u
"Test already running"))
66 msg_ops
.startTest(test
)
67 open_tests
[name
] = test
68 elif command
== "time":
69 msg_ops
.control_msg(l
)
71 dt
= iso_parse_date(arg
.rstrip("\n"))
72 except TypeError as e
:
73 print("Unable to parse time line: %s" % arg
.rstrip("\n"))
76 elif command
in VALID_RESULTS
:
77 msg_ops
.control_msg(l
)
79 grp
= re
.match("(.*?)( \[)?([ \t]*)( multipart)?\n", arg
)
80 (testname
, hasreason
) = (grp
.group(1), grp
.group(2))
83 # reason may be specified in next lines
86 msg_ops
.control_msg(l
)
93 if isinstance(reason
, bytes
):
94 remote_error
= subunit
.RemoteError(reason
.decode("utf-8"))
96 remote_error
= subunit
.RemoteError(reason
)
99 statistics
['TESTS_ERROR'] += 1
100 msg_ops
.addError(subunit
.RemotedTestCase(testname
),
101 subunit
.RemoteError(u
"result (%s) reason (%s) interrupted" % (result
, reason
)))
105 remote_error
= subunit
.RemoteError(u
"No reason specified")
106 if result
in ("success", "successful"):
108 test
= open_tests
.pop(testname
)
110 statistics
['TESTS_ERROR'] += 1
112 msg_ops
.addError(subunit
.RemotedTestCase(testname
), subunit
.RemoteError(u
"Test was never started"))
114 statistics
['TESTS_EXPECTED_OK'] += 1
115 msg_ops
.addSuccess(test
)
116 elif result
in ("xfail", "knownfail"):
118 test
= open_tests
.pop(testname
)
120 statistics
['TESTS_ERROR'] += 1
122 msg_ops
.addError(subunit
.RemotedTestCase(testname
), subunit
.RemoteError(u
"Test was never started"))
124 statistics
['TESTS_EXPECTED_FAIL'] += 1
125 msg_ops
.addExpectedFailure(test
, remote_error
)
126 elif result
in ("uxsuccess", ):
128 test
= open_tests
.pop(testname
)
130 statistics
['TESTS_ERROR'] += 1
132 msg_ops
.addError(subunit
.RemotedTestCase(testname
), subunit
.RemoteError(u
"Test was never started"))
134 statistics
['TESTS_UNEXPECTED_OK'] += 1
135 msg_ops
.addUnexpectedSuccess(test
)
137 elif result
in ("failure", "fail"):
139 test
= open_tests
.pop(testname
)
141 statistics
['TESTS_ERROR'] += 1
143 msg_ops
.addError(subunit
.RemotedTestCase(testname
), subunit
.RemoteError(u
"Test was never started"))
145 statistics
['TESTS_UNEXPECTED_FAIL'] += 1
147 msg_ops
.addFailure(test
, remote_error
)
148 elif result
== "skip":
149 statistics
['TESTS_SKIP'] += 1
150 # Allow tests to be skipped without prior announcement of test
152 test
= open_tests
.pop(testname
)
154 test
= subunit
.RemotedTestCase(testname
)
155 msg_ops
.addSkip(test
, reason
)
156 elif result
== "error":
157 statistics
['TESTS_ERROR'] += 1
160 test
= open_tests
.pop(testname
)
162 test
= subunit
.RemotedTestCase(testname
)
163 msg_ops
.addError(test
, remote_error
)
164 elif result
== "skip-testsuite":
165 msg_ops
.skip_testsuite(testname
)
166 elif result
== "testsuite-success":
167 msg_ops
.end_testsuite(testname
, "success", reason
)
168 elif result
== "testsuite-failure":
169 msg_ops
.end_testsuite(testname
, "failure", reason
)
171 elif result
== "testsuite-xfail":
172 msg_ops
.end_testsuite(testname
, "xfail", reason
)
173 elif result
== "testsuite-uxsuccess":
174 msg_ops
.end_testsuite(testname
, "uxsuccess", reason
)
176 elif result
== "testsuite-error":
177 msg_ops
.end_testsuite(testname
, "error", reason
)
180 raise AssertionError("Recognized but unhandled result %r" %
182 elif command
== "testsuite":
183 msg_ops
.start_testsuite(arg
.strip())
184 elif command
== "progress":
187 msg_ops
.progress(None, subunit
.PROGRESS_POP
)
189 msg_ops
.progress(None, subunit
.PROGRESS_PUSH
)
191 msg_ops
.progress(int(arg
), subunit
.PROGRESS_CUR
)
193 msg_ops
.progress(int(arg
), subunit
.PROGRESS_SET
)
195 msg_ops
.output_msg(l
)
198 test
= subunit
.RemotedTestCase(open_tests
.popitem()[1])
199 msg_ops
.addError(test
, subunit
.RemoteError(u
"was started but never finished!"))
200 statistics
['TESTS_ERROR'] += 1
206 class SubunitOps(TestProtocolClient
, TestsuiteEnabledTestResult
):
208 def progress(self
, count
, whence
):
209 if whence
== subunit
.PROGRESS_POP
:
210 self
._stream
.write("progress: pop\n")
211 elif whence
== subunit
.PROGRESS_PUSH
:
212 self
._stream
.write("progress: push\n")
213 elif whence
== subunit
.PROGRESS_SET
:
214 self
._stream
.write("progress: %d\n" % count
)
215 elif whence
== subunit
.PROGRESS_CUR
:
216 raise NotImplementedError
218 # The following are Samba extensions:
219 def start_testsuite(self
, name
):
220 self
._stream
.write("testsuite: %s\n" % name
)
222 def skip_testsuite(self
, name
, reason
=None):
224 self
._stream
.write("skip-testsuite: %s [\n%s\n]\n" % (name
, reason
))
226 self
._stream
.write("skip-testsuite: %s\n" % name
)
228 def end_testsuite(self
, name
, result
, reason
=None):
230 self
._stream
.write("testsuite-%s: %s [\n%s\n]\n" % (result
, name
, reason
))
232 self
._stream
.write("testsuite-%s: %s\n" % (result
, name
))
234 def output_msg(self
, msg
):
235 self
._stream
.write(msg
)
238 def read_test_regexes(*names
):
242 # if we are given a directory, we read all the files it contains
243 # (except the ones that end with "~").
244 if os
.path
.isdir(name
):
245 files
.extend([os
.path
.join(name
, x
)
246 for x
in os
.listdir(name
)
251 for filename
in files
:
252 with
open(filename
, 'r') as f
:
255 if l
== "" or l
[0] == "#":
258 (regex
, reason
) = l
.split("#", 1)
259 ret
[regex
.strip()] = reason
.strip()
266 def find_in_list(regexes
, fullname
):
267 for regex
, reason
in regexes
.items():
268 if re
.match(regex
, fullname
):
275 class ImmediateFail(Exception):
276 """Raised to abort immediately."""
279 super(ImmediateFail
, self
).__init
__("test failed and fail_immediately set")
282 class FilterOps(unittest
.TestResult
):
284 def control_msg(self
, msg
):
285 pass # We regenerate control messages, so ignore this
287 def time(self
, time
):
290 def progress(self
, delta
, whence
):
291 self
._ops
.progress(delta
, whence
)
293 def output_msg(self
, msg
):
294 if self
.output
is None:
295 sys
.stdout
.write(msg
)
299 def startTest(self
, test
):
300 self
.seen_output
= True
301 test
= self
._add
_prefix
(test
)
302 if self
.strip_ok_output
:
305 self
._ops
.startTest(test
)
307 def _add_prefix(self
, test
):
308 return subunit
.RemotedTestCase(self
.prefix
+ test
.id() + self
.suffix
)
310 def addError(self
, test
, err
=None):
311 test
= self
._add
_prefix
(test
)
312 self
.error_added
+= 1
313 self
.total_error
+= 1
314 self
._ops
.addError(test
, err
)
315 self
._ops
.writeOutcome(test
)
317 if self
.fail_immediately
:
318 raise ImmediateFail()
320 def addSkip(self
, test
, reason
=None):
321 self
.seen_output
= True
322 test
= self
._add
_prefix
(test
)
323 self
._ops
.addSkip(test
, reason
)
324 self
._ops
.writeOutcome(test
)
327 def addExpectedFailure(self
, test
, err
=None):
328 test
= self
._add
_prefix
(test
)
329 self
._ops
.addExpectedFailure(test
, err
)
330 self
._ops
.writeOutcome(test
)
333 def addUnexpectedSuccess(self
, test
):
334 test
= self
._add
_prefix
(test
)
335 self
.uxsuccess_added
+= 1
336 self
.total_uxsuccess
+= 1
337 self
._ops
.addUnexpectedSuccess(test
)
338 self
._ops
.writeOutcome(test
)
340 self
._ops
.output_msg(self
.output
)
342 if self
.fail_immediately
:
343 raise ImmediateFail()
345 def addFailure(self
, test
, err
=None):
346 test
= self
._add
_prefix
(test
)
347 xfail_reason
= find_in_list(self
.expected_failures
, test
.id())
348 if xfail_reason
is None:
349 xfail_reason
= find_in_list(self
.flapping
, test
.id())
350 if xfail_reason
is not None:
351 self
.xfail_added
+= 1
352 self
.total_xfail
+= 1
353 self
._ops
.addExpectedFailure(test
, err
)
354 self
._ops
.writeOutcome(test
)
358 self
._ops
.addFailure(test
, err
)
359 self
._ops
.writeOutcome(test
)
361 self
._ops
.output_msg(self
.output
)
362 if self
.fail_immediately
:
363 raise ImmediateFail()
366 def addSuccess(self
, test
):
367 test
= self
._add
_prefix
(test
)
368 xfail_reason
= find_in_list(self
.expected_failures
, test
.id())
369 if xfail_reason
is not None:
370 self
.uxsuccess_added
+= 1
371 self
.total_uxsuccess
+= 1
372 self
._ops
.addUnexpectedSuccess(test
)
373 self
._ops
.writeOutcome(test
)
375 self
._ops
.output_msg(self
.output
)
376 if self
.fail_immediately
:
377 raise ImmediateFail()
379 self
._ops
.addSuccess(test
)
380 self
._ops
.writeOutcome(test
)
383 def skip_testsuite(self
, name
, reason
=None):
384 self
._ops
.skip_testsuite(name
, reason
)
386 def start_testsuite(self
, name
):
387 self
._ops
.start_testsuite(name
)
391 self
.uxsuccess_added
= 0
393 def end_testsuite(self
, name
, result
, reason
=None):
396 if self
.xfail_added
> 0:
398 if self
.fail_added
> 0 or self
.error_added
> 0 or self
.uxsuccess_added
> 0:
401 if xfail
and result
in ("fail", "failure"):
404 if self
.uxsuccess_added
> 0 and result
!= "uxsuccess":
407 reason
= "Subunit/Filter Reason"
408 reason
+= "\n uxsuccess[%d]" % self
.uxsuccess_added
410 if self
.fail_added
> 0 and result
!= "failure":
413 reason
= "Subunit/Filter Reason"
414 reason
+= "\n failures[%d]" % self
.fail_added
416 if self
.error_added
> 0 and result
!= "error":
419 reason
= "Subunit/Filter Reason"
420 reason
+= "\n errors[%d]" % self
.error_added
422 self
._ops
.end_testsuite(name
, result
, reason
)
423 if result
not in ("success", "xfail"):
425 self
._ops
.output_msg(self
.output
)
426 if self
.fail_immediately
:
427 raise ImmediateFail()
430 def __init__(self
, out
, prefix
=None, suffix
=None, expected_failures
=None,
431 strip_ok_output
=False, fail_immediately
=False,
434 self
.seen_output
= False
438 if expected_failures
is not None:
439 self
.expected_failures
= expected_failures
441 self
.expected_failures
= {}
442 if flapping
is not None:
443 self
.flapping
= flapping
446 self
.strip_ok_output
= strip_ok_output
449 self
.uxsuccess_added
= 0
453 self
.total_uxsuccess
= 0
455 self
.fail_immediately
= fail_immediately
458 class PerfFilterOps(unittest
.TestResult
):
460 def progress(self
, delta
, whence
):
463 def output_msg(self
, msg
):
466 def control_msg(self
, msg
):
469 def skip_testsuite(self
, name
, reason
=None):
470 self
._ops
.skip_testsuite(name
, reason
)
472 def start_testsuite(self
, name
):
473 self
.suite_has_time
= False
475 def end_testsuite(self
, name
, result
, reason
=None):
478 def _add_prefix(self
, test
):
479 return subunit
.RemotedTestCase(self
.prefix
+ test
.id() + self
.suffix
)
481 def time(self
, time
):
482 self
.latest_time
= time
483 #self._ops.output_msg("found time %s\n" % time)
484 self
.suite_has_time
= True
487 if self
.suite_has_time
:
488 return self
.latest_time
489 return datetime
.datetime
.utcnow()
491 def startTest(self
, test
):
492 self
.seen_output
= True
493 test
= self
._add
_prefix
(test
)
494 self
.starts
[test
.id()] = self
.get_time()
496 def addSuccess(self
, test
):
497 test
= self
._add
_prefix
(test
)
499 if tid
not in self
.starts
:
500 self
._ops
.addError(test
, "%s succeeded without ever starting!" % tid
)
501 delta
= self
.get_time() - self
.starts
[tid
]
502 self
._ops
.output_msg("elapsed-time: %s: %f\n" % (tid
, delta
.total_seconds()))
504 def addFailure(self
, test
, err
=''):
506 delta
= self
.get_time() - self
.starts
[tid
]
507 self
._ops
.output_msg("failure: %s failed after %f seconds (%s)\n" %
508 (tid
, delta
.total_seconds(), err
))
510 def addError(self
, test
, err
=''):
512 delta
= self
.get_time() - self
.starts
[tid
]
513 self
._ops
.output_msg("error: %s failed after %f seconds (%s)\n" %
514 (tid
, delta
.total_seconds(), err
))
516 def __init__(self
, out
, prefix
='', suffix
=''):
518 self
.prefix
= prefix
or ''
519 self
.suffix
= suffix
or ''
521 self
.seen_output
= False
522 self
.suite_has_time
= False
525 class PlainFormatter(TestsuiteEnabledTestResult
):
527 def __init__(self
, verbose
, immediate
, statistics
,
529 super(PlainFormatter
, self
).__init
__()
530 self
.verbose
= verbose
531 self
.immediate
= immediate
532 self
.statistics
= statistics
533 self
.start_time
= None
534 self
.test_output
= {}
535 self
.suitesfailed
= []
540 self
._progress
_level
= 0
541 self
.totalsuites
= totaltests
542 self
.last_time
= None
545 def _format_time(delta
):
546 minutes
, seconds
= divmod(delta
.seconds
, 60)
547 hours
, minutes
= divmod(minutes
, 60)
552 ret
+= "%dm" % minutes
553 ret
+= "%ds" % seconds
556 def progress(self
, offset
, whence
):
557 if whence
== subunit
.PROGRESS_POP
:
558 self
._progress
_level
-= 1
559 elif whence
== subunit
.PROGRESS_PUSH
:
560 self
._progress
_level
+= 1
561 elif whence
== subunit
.PROGRESS_SET
:
562 if self
._progress
_level
== 0:
563 self
.totalsuites
= offset
564 elif whence
== subunit
.PROGRESS_CUR
:
565 raise NotImplementedError
568 if self
.start_time
is None:
572 def start_testsuite(self
, name
):
577 self
.test_output
[name
] = ""
579 total_tests
= (self
.statistics
['TESTS_EXPECTED_OK'] +
580 self
.statistics
['TESTS_EXPECTED_FAIL'] +
581 self
.statistics
['TESTS_ERROR'] +
582 self
.statistics
['TESTS_UNEXPECTED_FAIL'] +
583 self
.statistics
['TESTS_UNEXPECTED_OK'])
585 out
= "[%d(%d)" % (self
.index
, total_tests
)
586 if self
.totalsuites
is not None:
587 out
+= "/%d" % self
.totalsuites
588 if self
.start_time
is not None:
589 out
+= " at " + self
._format
_time
(self
.last_time
- self
.start_time
)
590 if self
.suitesfailed
:
591 out
+= ", %d errors" % (len(self
.suitesfailed
),)
594 sys
.stdout
.write(out
+ "\n")
596 sys
.stdout
.write(out
+ ": ")
598 def output_msg(self
, output
):
600 sys
.stdout
.write(output
)
601 elif self
.name
is not None:
602 self
.test_output
[self
.name
] += output
604 sys
.stdout
.write(output
)
606 def control_msg(self
, output
):
609 def end_testsuite(self
, name
, result
, reason
):
613 if name
not in self
.test_output
:
614 print("no output for name[%s]" % name
)
616 if result
in ("success", "xfail"):
619 self
.output_msg("ERROR: Testsuite[%s]\n" % name
)
620 if reason
is not None:
621 self
.output_msg("REASON: %s\n" % (reason
,))
622 self
.suitesfailed
.append(name
)
623 if self
.immediate
and not self
.verbose
and name
in self
.test_output
:
624 out
+= self
.test_output
[name
]
627 if not self
.immediate
:
631 out
+= " " + result
.upper() + "\n"
633 sys
.stdout
.write(out
)
635 def startTest(self
, test
):
638 def addSuccess(self
, test
):
639 self
.end_test(test
.id(), "success", False)
641 def addError(self
, test
, err
=None):
642 self
.end_test(test
.id(), "error", True, err
)
644 def addFailure(self
, test
, err
=None):
645 self
.end_test(test
.id(), "failure", True, err
)
647 def addSkip(self
, test
, reason
=None):
648 self
.end_test(test
.id(), "skip", False, reason
)
650 def addExpectedFailure(self
, test
, err
=None):
651 self
.end_test(test
.id(), "xfail", False, err
)
653 def addUnexpectedSuccess(self
, test
):
654 self
.end_test(test
.id(), "uxsuccess", True)
656 def end_test(self
, testname
, result
, unexpected
, err
=None):
658 self
.test_output
[self
.name
] = ""
659 if not self
.immediate
:
664 'success': '.'}.get(result
, "?(%s)" % result
))
667 if self
.name
not in self
.test_output
:
668 self
.test_output
[self
.name
] = ""
670 self
.test_output
[self
.name
] += "UNEXPECTED(%s): %s\n" % (result
, testname
)
672 self
.test_output
[self
.name
] += "REASON: %s\n" % str(err
[1]).strip()
674 if self
.immediate
and not self
.verbose
:
675 sys
.stdout
.write(self
.test_output
[self
.name
])
676 self
.test_output
[self
.name
] = ""
678 if not self
.immediate
:
683 'success': 'S'}.get(result
, "?"))
685 def write_summary(self
, path
):
688 if self
.suitesfailed
:
689 f
.write("= Failed tests =\n")
691 for suite
in self
.suitesfailed
:
692 f
.write("== %s ==\n" % suite
)
693 if suite
in self
.test_output
:
694 f
.write(self
.test_output
[suite
] + "\n\n")
698 if not self
.immediate
and not self
.verbose
:
699 for suite
in self
.suitesfailed
:
701 print("FAIL: %s" % suite
)
702 if suite
in self
.test_output
:
703 print(self
.test_output
[suite
])
706 f
.write("= Skipped tests =\n")
707 for reason
in self
.skips
.keys():
708 f
.write(reason
+ "\n")
709 for name
in self
.skips
[reason
]:
710 f
.write("\t%s\n" % name
)
714 if (not self
.suitesfailed
and
715 not self
.statistics
['TESTS_UNEXPECTED_FAIL'] and
716 not self
.statistics
['TESTS_UNEXPECTED_OK'] and
717 not self
.statistics
['TESTS_ERROR']):
718 ok
= (self
.statistics
['TESTS_EXPECTED_OK'] +
719 self
.statistics
['TESTS_EXPECTED_FAIL'])
720 print("\nALL OK (%d tests in %d testsuites)" % (ok
, self
.suites_ok
))
722 print("\nFAILED (%d failures, %d errors and %d unexpected successes in %d testsuites)" % (
723 self
.statistics
['TESTS_UNEXPECTED_FAIL'],
724 self
.statistics
['TESTS_ERROR'],
725 self
.statistics
['TESTS_UNEXPECTED_OK'],
726 len(self
.suitesfailed
)))
728 def skip_testsuite(self
, name
, reason
="UNKNOWN"):
729 self
.skips
.setdefault(reason
, []).append(name
)
731 self
.totalsuites
-= 1