s3:auth: Use cli_credentials_init_server()
[metze/samba-autobuild/.git] / selftest / subunithelper.py
1 # Python module for parsing and generating the Subunit protocol
2 # (Samba-specific)
3 # Copyright (C) 2008-2009 Jelmer Vernooij <jelmer@samba.org>
4 #
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.
9
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.
14
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/>.
17
18 from __future__ import print_function
19 __all__ = ['parse_results']
20
21 import datetime
22 import re
23 import sys
24 import os
25 from samba import subunit
26 from samba.subunit.run import TestProtocolClient
27 import unittest
28 try:
29     from dateutil.parser import isoparse as iso_parse_date
30 except ImportError:
31     try:
32         from iso8601 import parse_date as iso_parse_date;
33     except ImportError:
34         print('Install either python-dateutil >= 2.7.1 or python-iso8601')
35
36
37 VALID_RESULTS = set(['success', 'successful', 'failure', 'fail', 'skip',
38                      'knownfail', 'error', 'xfail', 'skip-testsuite',
39                      'testsuite-failure', 'testsuite-xfail',
40                      'testsuite-success', 'testsuite-error',
41                      'uxsuccess', 'testsuite-uxsuccess'])
42
43
44 class TestsuiteEnabledTestResult(unittest.TestResult):
45
46     def start_testsuite(self, name):
47         raise NotImplementedError(self.start_testsuite)
48
49
50 def parse_results(msg_ops, statistics, fh):
51     exitcode = 0
52     open_tests = {}
53
54     for l in fh:
55         parts = l.split(None, 1)
56         if not len(parts) == 2 or not l.startswith(parts[0]):
57             msg_ops.output_msg(l)
58             continue
59         command = parts[0].rstrip(":")
60         arg = parts[1]
61         if command in ("test", "testing"):
62             msg_ops.control_msg(l)
63             name = arg.rstrip()
64             test = subunit.RemotedTestCase(name)
65             if name in open_tests:
66                 msg_ops.addError(open_tests.pop(name), subunit.RemoteError(u"Test already running"))
67             msg_ops.startTest(test)
68             open_tests[name] = test
69         elif command == "time":
70             msg_ops.control_msg(l)
71             try:
72                 dt = iso_parse_date(arg.rstrip("\n"))
73             except TypeError as e:
74                 print("Unable to parse time line: %s" % arg.rstrip("\n"))
75             else:
76                 msg_ops.time(dt)
77         elif command in VALID_RESULTS:
78             msg_ops.control_msg(l)
79             result = command
80             grp = re.match("(.*?)( \[)?([ \t]*)( multipart)?\n", arg)
81             (testname, hasreason) = (grp.group(1), grp.group(2))
82             if hasreason:
83                 reason = ""
84                 # reason may be specified in next lines
85                 terminated = False
86                 for l in fh:
87                     msg_ops.control_msg(l)
88                     if l == "]\n":
89                         terminated = True
90                         break
91                     else:
92                         reason += l
93
94                 if isinstance(reason, bytes):
95                     remote_error = subunit.RemoteError(reason.decode("utf-8"))
96                 else:
97                     remote_error = subunit.RemoteError(reason)
98
99                 if not terminated:
100                     statistics['TESTS_ERROR'] += 1
101                     msg_ops.addError(subunit.RemotedTestCase(testname),
102                                      subunit.RemoteError(u"result (%s) reason (%s) interrupted" % (result, reason)))
103                     return 1
104             else:
105                 reason = None
106                 remote_error = subunit.RemoteError(u"No reason specified")
107             if result in ("success", "successful"):
108                 try:
109                     test = open_tests.pop(testname)
110                 except KeyError:
111                     statistics['TESTS_ERROR'] += 1
112                     exitcode = 1
113                     msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
114                 else:
115                     statistics['TESTS_EXPECTED_OK'] += 1
116                     msg_ops.addSuccess(test)
117             elif result in ("xfail", "knownfail"):
118                 try:
119                     test = open_tests.pop(testname)
120                 except KeyError:
121                     statistics['TESTS_ERROR'] += 1
122                     exitcode = 1
123                     msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
124                 else:
125                     statistics['TESTS_EXPECTED_FAIL'] += 1
126                     msg_ops.addExpectedFailure(test, remote_error)
127             elif result in ("uxsuccess", ):
128                 try:
129                     test = open_tests.pop(testname)
130                 except KeyError:
131                     statistics['TESTS_ERROR'] += 1
132                     exitcode = 1
133                     msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
134                 else:
135                     statistics['TESTS_UNEXPECTED_OK'] += 1
136                     msg_ops.addUnexpectedSuccess(test)
137                     exitcode = 1
138             elif result in ("failure", "fail"):
139                 try:
140                     test = open_tests.pop(testname)
141                 except KeyError:
142                     statistics['TESTS_ERROR'] += 1
143                     exitcode = 1
144                     msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
145                 else:
146                     statistics['TESTS_UNEXPECTED_FAIL'] += 1
147                     exitcode = 1
148                     msg_ops.addFailure(test, remote_error)
149             elif result == "skip":
150                 statistics['TESTS_SKIP'] += 1
151                 # Allow tests to be skipped without prior announcement of test
152                 try:
153                     test = open_tests.pop(testname)
154                 except KeyError:
155                     test = subunit.RemotedTestCase(testname)
156                 msg_ops.addSkip(test, reason)
157             elif result == "error":
158                 statistics['TESTS_ERROR'] += 1
159                 exitcode = 1
160                 try:
161                     test = open_tests.pop(testname)
162                 except KeyError:
163                     test = subunit.RemotedTestCase(testname)
164                 msg_ops.addError(test, remote_error)
165             elif result == "skip-testsuite":
166                 msg_ops.skip_testsuite(testname)
167             elif result == "testsuite-success":
168                 msg_ops.end_testsuite(testname, "success", reason)
169             elif result == "testsuite-failure":
170                 msg_ops.end_testsuite(testname, "failure", reason)
171                 exitcode = 1
172             elif result == "testsuite-xfail":
173                 msg_ops.end_testsuite(testname, "xfail", reason)
174             elif result == "testsuite-uxsuccess":
175                 msg_ops.end_testsuite(testname, "uxsuccess", reason)
176                 exitcode = 1
177             elif result == "testsuite-error":
178                 msg_ops.end_testsuite(testname, "error", reason)
179                 exitcode = 1
180             else:
181                 raise AssertionError("Recognized but unhandled result %r" %
182                                      result)
183         elif command == "testsuite":
184             msg_ops.start_testsuite(arg.strip())
185         elif command == "progress":
186             arg = arg.strip()
187             if arg == "pop":
188                 msg_ops.progress(None, subunit.PROGRESS_POP)
189             elif arg == "push":
190                 msg_ops.progress(None, subunit.PROGRESS_PUSH)
191             elif arg[0] in '+-':
192                 msg_ops.progress(int(arg), subunit.PROGRESS_CUR)
193             else:
194                 msg_ops.progress(int(arg), subunit.PROGRESS_SET)
195         else:
196             msg_ops.output_msg(l)
197
198     while open_tests:
199         test = subunit.RemotedTestCase(open_tests.popitem()[1])
200         msg_ops.addError(test, subunit.RemoteError(u"was started but never finished!"))
201         statistics['TESTS_ERROR'] += 1
202         exitcode = 1
203
204     return exitcode
205
206
207 class SubunitOps(TestProtocolClient, TestsuiteEnabledTestResult):
208
209     def progress(self, count, whence):
210         if whence == subunit.PROGRESS_POP:
211             self._stream.write("progress: pop\n")
212         elif whence == subunit.PROGRESS_PUSH:
213             self._stream.write("progress: push\n")
214         elif whence == subunit.PROGRESS_SET:
215             self._stream.write("progress: %d\n" % count)
216         elif whence == subunit.PROGRESS_CUR:
217             raise NotImplementedError
218
219     # The following are Samba extensions:
220     def start_testsuite(self, name):
221         self._stream.write("testsuite: %s\n" % name)
222
223     def skip_testsuite(self, name, reason=None):
224         if reason:
225             self._stream.write("skip-testsuite: %s [\n%s\n]\n" % (name, reason))
226         else:
227             self._stream.write("skip-testsuite: %s\n" % name)
228
229     def end_testsuite(self, name, result, reason=None):
230         if reason:
231             self._stream.write("testsuite-%s: %s [\n%s\n]\n" % (result, name, reason))
232         else:
233             self._stream.write("testsuite-%s: %s\n" % (result, name))
234
235     def output_msg(self, msg):
236         self._stream.write(msg)
237
238
239 def read_test_regexes(*names):
240     ret = {}
241     files = []
242     for name in names:
243         # if we are given a directory, we read all the files it contains
244         # (except the ones that end with "~").
245         if os.path.isdir(name):
246             files.extend([os.path.join(name, x)
247                           for x in os.listdir(name)
248                           if x[-1] != '~'])
249         else:
250             files.append(name)
251
252     for filename in files:
253         with open(filename, 'r') as f:
254             for l in f:
255                 l = l.strip()
256                 if l == "" or l[0] == "#":
257                     continue
258                 if "#" in l:
259                     (regex, reason) = l.split("#", 1)
260                     ret[regex.strip()] = reason.strip()
261                 else:
262                     ret[l] = None
263
264     return ret
265
266
267 def find_in_list(regexes, fullname):
268     for regex, reason in regexes.items():
269         if re.match(regex, fullname):
270             if reason is None:
271                 return ""
272             return reason
273     return None
274
275
276 class ImmediateFail(Exception):
277     """Raised to abort immediately."""
278
279     def __init__(self):
280         super(ImmediateFail, self).__init__("test failed and fail_immediately set")
281
282
283 class FilterOps(unittest.TestResult):
284
285     def control_msg(self, msg):
286         pass  # We regenerate control messages, so ignore this
287
288     def time(self, time):
289         self._ops.time(time)
290
291     def progress(self, delta, whence):
292         self._ops.progress(delta, whence)
293
294     def output_msg(self, msg):
295         if self.output is None:
296             sys.stdout.write(msg)
297         else:
298             self.output += msg
299
300     def startTest(self, test):
301         self.seen_output = True
302         test = self._add_prefix(test)
303         if self.strip_ok_output:
304             self.output = ""
305
306         self._ops.startTest(test)
307
308     def _add_prefix(self, test):
309         return subunit.RemotedTestCase(self.prefix + test.id() + self.suffix)
310
311     def addError(self, test, err=None):
312         test = self._add_prefix(test)
313         self.error_added += 1
314         self.total_error += 1
315         self._ops.addError(test, err)
316         self.output = None
317         if self.fail_immediately:
318             raise ImmediateFail()
319
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.output = None
325
326     def addExpectedFailure(self, test, err=None):
327         test = self._add_prefix(test)
328         self._ops.addExpectedFailure(test, err)
329         self.output = None
330
331     def addUnexpectedSuccess(self, test):
332         test = self._add_prefix(test)
333         self.uxsuccess_added += 1
334         self.total_uxsuccess += 1
335         self._ops.addUnexpectedSuccess(test)
336         if self.output:
337             self._ops.output_msg(self.output)
338         self.output = None
339         if self.fail_immediately:
340             raise ImmediateFail()
341
342     def addFailure(self, test, err=None):
343         test = self._add_prefix(test)
344         xfail_reason = find_in_list(self.expected_failures, test.id())
345         if xfail_reason is None:
346             xfail_reason = find_in_list(self.flapping, test.id())
347         if xfail_reason is not None:
348             self.xfail_added += 1
349             self.total_xfail += 1
350             self._ops.addExpectedFailure(test, err)
351         else:
352             self.fail_added += 1
353             self.total_fail += 1
354             self._ops.addFailure(test, err)
355             if self.output:
356                 self._ops.output_msg(self.output)
357             if self.fail_immediately:
358                 raise ImmediateFail()
359         self.output = None
360
361     def addSuccess(self, test):
362         test = self._add_prefix(test)
363         xfail_reason = find_in_list(self.expected_failures, test.id())
364         if xfail_reason is not None:
365             self.uxsuccess_added += 1
366             self.total_uxsuccess += 1
367             self._ops.addUnexpectedSuccess(test)
368             if self.output:
369                 self._ops.output_msg(self.output)
370             if self.fail_immediately:
371                 raise ImmediateFail()
372         else:
373             self._ops.addSuccess(test)
374         self.output = None
375
376     def skip_testsuite(self, name, reason=None):
377         self._ops.skip_testsuite(name, reason)
378
379     def start_testsuite(self, name):
380         self._ops.start_testsuite(name)
381         self.error_added = 0
382         self.fail_added = 0
383         self.xfail_added = 0
384         self.uxsuccess_added = 0
385
386     def end_testsuite(self, name, result, reason=None):
387         xfail = False
388
389         if self.xfail_added > 0:
390             xfail = True
391         if self.fail_added > 0 or self.error_added > 0 or self.uxsuccess_added > 0:
392             xfail = False
393
394         if xfail and result in ("fail", "failure"):
395             result = "xfail"
396
397         if self.uxsuccess_added > 0 and result != "uxsuccess":
398             result = "uxsuccess"
399             if reason is None:
400                 reason = "Subunit/Filter Reason"
401             reason += "\n uxsuccess[%d]" % self.uxsuccess_added
402
403         if self.fail_added > 0 and result != "failure":
404             result = "failure"
405             if reason is None:
406                 reason = "Subunit/Filter Reason"
407             reason += "\n failures[%d]" % self.fail_added
408
409         if self.error_added > 0 and result != "error":
410             result = "error"
411             if reason is None:
412                 reason = "Subunit/Filter Reason"
413             reason += "\n errors[%d]" % self.error_added
414
415         self._ops.end_testsuite(name, result, reason)
416         if result not in ("success", "xfail"):
417             if self.output:
418                 self._ops.output_msg(self.output)
419             if self.fail_immediately:
420                 raise ImmediateFail()
421         self.output = None
422
423     def __init__(self, out, prefix=None, suffix=None, expected_failures=None,
424                  strip_ok_output=False, fail_immediately=False,
425                  flapping=None):
426         self._ops = out
427         self.seen_output = False
428         self.output = None
429         self.prefix = prefix
430         self.suffix = suffix
431         if expected_failures is not None:
432             self.expected_failures = expected_failures
433         else:
434             self.expected_failures = {}
435         if flapping is not None:
436             self.flapping = flapping
437         else:
438             self.flapping = {}
439         self.strip_ok_output = strip_ok_output
440         self.xfail_added = 0
441         self.fail_added = 0
442         self.uxsuccess_added = 0
443         self.total_xfail = 0
444         self.total_error = 0
445         self.total_fail = 0
446         self.total_uxsuccess = 0
447         self.error_added = 0
448         self.fail_immediately = fail_immediately
449
450
451 class PerfFilterOps(unittest.TestResult):
452
453     def progress(self, delta, whence):
454         pass
455
456     def output_msg(self, msg):
457         pass
458
459     def control_msg(self, msg):
460         pass
461
462     def skip_testsuite(self, name, reason=None):
463         self._ops.skip_testsuite(name, reason)
464
465     def start_testsuite(self, name):
466         self.suite_has_time = False
467
468     def end_testsuite(self, name, result, reason=None):
469         pass
470
471     def _add_prefix(self, test):
472         return subunit.RemotedTestCase(self.prefix + test.id() + self.suffix)
473
474     def time(self, time):
475         self.latest_time = time
476         #self._ops.output_msg("found time %s\n" % time)
477         self.suite_has_time = True
478
479     def get_time(self):
480         if self.suite_has_time:
481             return self.latest_time
482         return datetime.datetime.utcnow()
483
484     def startTest(self, test):
485         self.seen_output = True
486         test = self._add_prefix(test)
487         self.starts[test.id()] = self.get_time()
488
489     def addSuccess(self, test):
490         test = self._add_prefix(test)
491         tid = test.id()
492         if tid not in self.starts:
493             self._ops.addError(test, "%s succeeded without ever starting!" % tid)
494         delta = self.get_time() - self.starts[tid]
495         self._ops.output_msg("elapsed-time: %s: %f\n" % (tid, delta.total_seconds()))
496
497     def addFailure(self, test, err=''):
498         tid = test.id()
499         delta = self.get_time() - self.starts[tid]
500         self._ops.output_msg("failure: %s failed after %f seconds (%s)\n" %
501                              (tid, delta.total_seconds(), err))
502
503     def addError(self, test, err=''):
504         tid = test.id()
505         delta = self.get_time() - self.starts[tid]
506         self._ops.output_msg("error: %s failed after %f seconds (%s)\n" %
507                              (tid, delta.total_seconds(), err))
508
509     def __init__(self, out, prefix='', suffix=''):
510         self._ops = out
511         self.prefix = prefix or ''
512         self.suffix = suffix or ''
513         self.starts = {}
514         self.seen_output = False
515         self.suite_has_time = False
516
517
518 class PlainFormatter(TestsuiteEnabledTestResult):
519
520     def __init__(self, verbose, immediate, statistics,
521                  totaltests=None):
522         super(PlainFormatter, self).__init__()
523         self.verbose = verbose
524         self.immediate = immediate
525         self.statistics = statistics
526         self.start_time = None
527         self.test_output = {}
528         self.suitesfailed = []
529         self.suites_ok = 0
530         self.skips = {}
531         self.index = 0
532         self.name = None
533         self._progress_level = 0
534         self.totalsuites = totaltests
535         self.last_time = None
536
537     @staticmethod
538     def _format_time(delta):
539         minutes, seconds = divmod(delta.seconds, 60)
540         hours, minutes = divmod(minutes, 60)
541         ret = ""
542         if hours:
543             ret += "%dh" % hours
544         if minutes:
545             ret += "%dm" % minutes
546         ret += "%ds" % seconds
547         return ret
548
549     def progress(self, offset, whence):
550         if whence == subunit.PROGRESS_POP:
551             self._progress_level -= 1
552         elif whence == subunit.PROGRESS_PUSH:
553             self._progress_level += 1
554         elif whence == subunit.PROGRESS_SET:
555             if self._progress_level == 0:
556                 self.totalsuites = offset
557         elif whence == subunit.PROGRESS_CUR:
558             raise NotImplementedError
559
560     def time(self, dt):
561         if self.start_time is None:
562             self.start_time = dt
563         self.last_time = dt
564
565     def start_testsuite(self, name):
566         self.index += 1
567         self.name = name
568
569         if not self.verbose:
570             self.test_output[name] = ""
571
572         total_tests = (self.statistics['TESTS_EXPECTED_OK'] +
573                        self.statistics['TESTS_EXPECTED_FAIL'] +
574                        self.statistics['TESTS_ERROR'] +
575                        self.statistics['TESTS_UNEXPECTED_FAIL'] +
576                        self.statistics['TESTS_UNEXPECTED_OK'])
577
578         out = "[%d(%d)" % (self.index, total_tests)
579         if self.totalsuites is not None:
580             out += "/%d" % self.totalsuites
581         if self.start_time is not None:
582             out += " at " + self._format_time(self.last_time - self.start_time)
583         if self.suitesfailed:
584             out += ", %d errors" % (len(self.suitesfailed),)
585         out += "] %s" % name
586         if self.immediate:
587             sys.stdout.write(out + "\n")
588         else:
589             sys.stdout.write(out + ": ")
590
591     def output_msg(self, output):
592         if self.verbose:
593             sys.stdout.write(output)
594         elif self.name is not None:
595             self.test_output[self.name] += output
596         else:
597             sys.stdout.write(output)
598
599     def control_msg(self, output):
600         pass
601
602     def end_testsuite(self, name, result, reason):
603         out = ""
604         unexpected = False
605
606         if name not in self.test_output:
607             print("no output for name[%s]" % name)
608
609         if result in ("success", "xfail"):
610             self.suites_ok += 1
611         else:
612             self.output_msg("ERROR: Testsuite[%s]\n" % name)
613             if reason is not None:
614                 self.output_msg("REASON: %s\n" % (reason,))
615             self.suitesfailed.append(name)
616             if self.immediate and not self.verbose and name in self.test_output:
617                 out += self.test_output[name]
618             unexpected = True
619
620         if not self.immediate:
621             if not unexpected:
622                 out += " ok\n"
623             else:
624                 out += " " + result.upper() + "\n"
625
626         sys.stdout.write(out)
627
628     def startTest(self, test):
629         pass
630
631     def addSuccess(self, test):
632         self.end_test(test.id(), "success", False)
633
634     def addError(self, test, err=None):
635         self.end_test(test.id(), "error", True, err)
636
637     def addFailure(self, test, err=None):
638         self.end_test(test.id(), "failure", True, err)
639
640     def addSkip(self, test, reason=None):
641         self.end_test(test.id(), "skip", False, reason)
642
643     def addExpectedFailure(self, test, err=None):
644         self.end_test(test.id(), "xfail", False, err)
645
646     def addUnexpectedSuccess(self, test):
647         self.end_test(test.id(), "uxsuccess", True)
648
649     def end_test(self, testname, result, unexpected, err=None):
650         if not unexpected:
651             self.test_output[self.name] = ""
652             if not self.immediate:
653                 sys.stdout.write({
654                     'failure': 'f',
655                     'xfail': 'X',
656                     'skip': 's',
657                     'success': '.'}.get(result, "?(%s)" % result))
658             return
659
660         if self.name not in self.test_output:
661             self.test_output[self.name] = ""
662
663         self.test_output[self.name] += "UNEXPECTED(%s): %s\n" % (result, testname)
664         if err is not None:
665             self.test_output[self.name] += "REASON: %s\n" % str(err[1]).strip()
666
667         if self.immediate and not self.verbose:
668             sys.stdout.write(self.test_output[self.name])
669             self.test_output[self.name] = ""
670
671         if not self.immediate:
672             sys.stdout.write({
673                 'error': 'E',
674                'failure': 'F',
675                'uxsuccess': 'U',
676                'success': 'S'}.get(result, "?"))
677
678     def write_summary(self, path):
679         f = open(path, 'w+')
680
681         if self.suitesfailed:
682             f.write("= Failed tests =\n")
683
684             for suite in self.suitesfailed:
685                 f.write("== %s ==\n" % suite)
686                 if suite in self.test_output:
687                     f.write(self.test_output[suite] + "\n\n")
688
689             f.write("\n")
690
691         if not self.immediate and not self.verbose:
692             for suite in self.suitesfailed:
693                 print("=" * 78)
694                 print("FAIL: %s" % suite)
695                 if suite in self.test_output:
696                     print(self.test_output[suite])
697                 print("")
698
699         f.write("= Skipped tests =\n")
700         for reason in self.skips.keys():
701             f.write(reason + "\n")
702             for name in self.skips[reason]:
703                 f.write("\t%s\n" % name)
704             f.write("\n")
705         f.close()
706
707         if (not self.suitesfailed and
708             not self.statistics['TESTS_UNEXPECTED_FAIL'] and
709             not self.statistics['TESTS_UNEXPECTED_OK'] and
710             not self.statistics['TESTS_ERROR']):
711             ok = (self.statistics['TESTS_EXPECTED_OK'] +
712                   self.statistics['TESTS_EXPECTED_FAIL'])
713             print("\nALL OK (%d tests in %d testsuites)" % (ok, self.suites_ok))
714         else:
715             print("\nFAILED (%d failures, %d errors and %d unexpected successes in %d testsuites)" % (
716                 self.statistics['TESTS_UNEXPECTED_FAIL'],
717                 self.statistics['TESTS_ERROR'],
718                 self.statistics['TESTS_UNEXPECTED_OK'],
719                 len(self.suitesfailed)))
720
721     def skip_testsuite(self, name, reason="UNKNOWN"):
722         self.skips.setdefault(reason, []).append(name)
723         if self.totalsuites:
724             self.totalsuites -= 1