test/run_tests.py

   1 #!/usr/bin/env python
   2
   3 import sys
   4 import shutil
   5 import os
   6 import fnmatch
   7 import unittest
   8 import argparse
   9 import time
  10 import threading
  11 import signal
  12 import psutil
  13 import re
  14 import multiprocessing
  15 from multiprocessing import Process, Pipe, cpu_count
  16 from multiprocessing.queues import Queue
  17 from multiprocessing.managers import BaseManager
  18 import framework
  19 from framework import VppTestRunner, running_extended_tests, VppTestCase, \
  20     get_testcase_doc_name, get_test_description, PASS, FAIL, ERROR, SKIP, \
  21     TEST_RUN
  22 from debug import spawn_gdb
  23 from log import get_parallel_logger, double_line_delim, RED, YELLOW, GREEN, \
  24     colorize, single_line_delim
  25 from discover_tests import discover_tests
  26 from subprocess import check_output, CalledProcessError
  27 from util import check_core_path, get_core_path, is_core_present
  28
  29 # timeout which controls how long the child has to finish after seeing
  30 # a core dump in test temporary directory. If this is exceeded, parent assumes
  31 # that child process is stuck (e.g. waiting for shm mutex, which will never
  32 # get unlocked) and kill the child
  33 core_timeout = 3
  34 min_req_shm = 536870912  # min 512MB shm required
  35 # 128MB per extra process
  36 shm_per_process = 134217728
  37
  38
  39 class StreamQueue(Queue):
  40     def write(self, msg):
  41         self.put(msg)
  42
  43     def flush(self):
  44         sys.__stdout__.flush()
  45         sys.__stderr__.flush()
  46
  47     def fileno(self):
  48         return self._writer.fileno()
  49
  50
  51 class StreamQueueManager(BaseManager):
  52     pass
  53
  54
  55 StreamQueueManager.register('StreamQueue', StreamQueue)
  56
  57
  58 class TestResult(dict):
  59     def __init__(self, testcase_suite, testcases_by_id=None):
  60         super(TestResult, self).__init__()
  61         self[PASS] = []
  62         self[FAIL] = []
  63         self[ERROR] = []
  64         self[SKIP] = []
  65         self[TEST_RUN] = []
  66         self.crashed = False
  67         self.testcase_suite = testcase_suite
  68         self.testcases = [testcase for testcase in testcase_suite]
  69         self.testcases_by_id = testcases_by_id
  70
  71     def was_successful(self):
  72         return 0 == len(self[FAIL]) == len(self[ERROR]) \
  73             and len(self[PASS] + self[SKIP]) \
  74             == self.testcase_suite.countTestCases() == len(self[TEST_RUN])
  75
  76     def no_tests_run(self):
  77         return 0 == len(self[TEST_RUN])
  78
  79     def process_result(self, test_id, result):
  80         self[result].append(test_id)
  81
  82     def suite_from_failed(self):
  83         rerun_ids = set([])
  84         for testcase in self.testcase_suite:
  85             tc_id = testcase.id()
  86             if tc_id not in self[PASS] and tc_id not in self[SKIP]:
  87                 rerun_ids.add(tc_id)
  88         if rerun_ids:
  89             return suite_from_failed(self.testcase_suite, rerun_ids)
  90
  91     def get_testcase_names(self, test_id):
  92         # could be tearDownClass (test_ipsec_esp.TestIpsecEsp1)
  93         setup_teardown_match = re.match(
  94             r'((tearDownClass)|(setUpClass)) \((.+\..+)\)', test_id)
  95         if setup_teardown_match:
  96             test_name, _, _, testcase_name = setup_teardown_match.groups()
  97             if len(testcase_name.split('.')) == 2:
  98                 for key in self.testcases_by_id.keys():
  99                     if key.startswith(testcase_name):
 100                         testcase_name = key
 101                         break
 102             testcase_name = self._get_testcase_doc_name(testcase_name)
 103         else:
 104             test_name = self._get_test_description(test_id)
 105             testcase_name = self._get_testcase_doc_name(test_id)
 106
 107         return testcase_name, test_name
 108
 109     def _get_test_description(self, test_id):
 110         if test_id in self.testcases_by_id:
 111             desc = get_test_description(descriptions,
 112                                         self.testcases_by_id[test_id])
 113         else:
 114             desc = test_id
 115         return desc
 116
 117     def _get_testcase_doc_name(self, test_id):
 118         if test_id in self.testcases_by_id:
 119             doc_name = get_testcase_doc_name(self.testcases_by_id[test_id])
 120         else:
 121             doc_name = test_id
 122         return doc_name
 123
 124
 125 def test_runner_wrapper(suite, keep_alive_pipe, stdouterr_queue,
 126                         finished_pipe, result_pipe, logger):
 127     sys.stdout = stdouterr_queue
 128     sys.stderr = stdouterr_queue
 129     VppTestCase.parallel_handler = logger.handlers[0]
 130     result = VppTestRunner(keep_alive_pipe=keep_alive_pipe,
 131                            descriptions=descriptions,
 132                            verbosity=verbose,
 133                            result_pipe=result_pipe,
 134                            failfast=failfast,
 135                            print_summary=False).run(suite)
 136     finished_pipe.send(result.wasSuccessful())
 137     finished_pipe.close()
 138     keep_alive_pipe.close()
 139
 140
 141 class TestCaseWrapper(object):
 142     def __init__(self, testcase_suite, manager):
 143         self.keep_alive_parent_end, self.keep_alive_child_end = Pipe(
 144             duplex=False)
 145         self.finished_parent_end, self.finished_child_end = Pipe(duplex=False)
 146         self.result_parent_end, self.result_child_end = Pipe(duplex=False)
 147         self.testcase_suite = testcase_suite
 148         if sys.version[0] == '2':
 149             self.stdouterr_queue = manager.StreamQueue()
 150         else:
 151             from multiprocessing import get_context
 152             self.stdouterr_queue = manager.StreamQueue(ctx=get_context())
 153         self.logger = get_parallel_logger(self.stdouterr_queue)
 154         self.child = Process(target=test_runner_wrapper,
 155                              args=(testcase_suite,
 156                                    self.keep_alive_child_end,
 157                                    self.stdouterr_queue,
 158                                    self.finished_child_end,
 159                                    self.result_child_end,
 160                                    self.logger)
 161                              )
 162         self.child.start()
 163         self.last_test_temp_dir = None
 164         self.last_test_vpp_binary = None
 165         self._last_test = None
 166         self.last_test_id = None
 167         self.vpp_pid = None
 168         self.last_heard = time.time()
 169         self.core_detected_at = None
 170         self.testcases_by_id = {}
 171         self.testclasess_with_core = {}
 172         for testcase in self.testcase_suite:
 173             self.testcases_by_id[testcase.id()] = testcase
 174         self.result = TestResult(testcase_suite, self.testcases_by_id)
 175
 176     @property
 177     def last_test(self):
 178         return self._last_test
 179
 180     @last_test.setter
 181     def last_test(self, test_id):
 182         self.last_test_id = test_id
 183         if test_id in self.testcases_by_id:
 184             testcase = self.testcases_by_id[test_id]
 185             self._last_test = testcase.shortDescription()
 186             if not self._last_test:
 187                 self._last_test = str(testcase)
 188         else:
 189             self._last_test = test_id
 190
 191     def add_testclass_with_core(self):
 192         if self.last_test_id in self.testcases_by_id:
 193             test = self.testcases_by_id[self.last_test_id]
 194             class_name = unittest.util.strclass(test.__class__)
 195             test_name = "'{}' ({})".format(get_test_description(descriptions,
 196                                                                 test),
 197                                            self.last_test_id)
 198         else:
 199             test_name = self.last_test_id
 200             class_name = re.match(r'((tearDownClass)|(setUpClass)) '
 201                                   r'\((.+\..+)\)', test_name).groups()[3]
 202         if class_name not in self.testclasess_with_core:
 203             self.testclasess_with_core[class_name] = (
 204                 test_name,
 205                 self.last_test_vpp_binary,
 206                 self.last_test_temp_dir)
 207
 208     def close_pipes(self):
 209         self.keep_alive_child_end.close()
 210         self.finished_child_end.close()
 211         self.result_child_end.close()
 212         self.keep_alive_parent_end.close()
 213         self.finished_parent_end.close()
 214         self.result_parent_end.close()
 215
 216     def was_successful(self):
 217         return self.result.was_successful()
 218
 219
 220 def stdouterr_reader_wrapper(unread_testcases, finished_unread_testcases,
 221                              read_testcases):
 222     read_testcase = None
 223     while read_testcases.is_set() or unread_testcases:
 224         if finished_unread_testcases:
 225             read_testcase = finished_unread_testcases.pop()
 226             unread_testcases.remove(read_testcase)
 227         elif unread_testcases:
 228             read_testcase = unread_testcases.pop()
 229         if read_testcase:
 230             data = ''
 231             while data is not None:
 232                 sys.stdout.write(data)
 233                 data = read_testcase.stdouterr_queue.get()
 234
 235             read_testcase.stdouterr_queue.close()
 236             finished_unread_testcases.discard(read_testcase)
 237             read_testcase = None
 238
 239
 240 def handle_failed_suite(logger, last_test_temp_dir, vpp_pid):
 241     if last_test_temp_dir:
 242         # Need to create link in case of a timeout or core dump without failure
 243         lttd = os.path.basename(last_test_temp_dir)
 244         failed_dir = os.getenv('FAILED_DIR')
 245         link_path = '%s%s-FAILED' % (failed_dir, lttd)
 246         if not os.path.exists(link_path):
 247             os.symlink(last_test_temp_dir, link_path)
 248         logger.error("Symlink to failed testcase directory: %s -> %s"
 249                      % (link_path, lttd))
 250
 251         # Report core existence
 252         core_path = get_core_path(last_test_temp_dir)
 253         if os.path.exists(core_path):
 254             logger.error(
 255                 "Core-file exists in test temporary directory: %s!" %
 256                 core_path)
 257             check_core_path(logger, core_path)
 258             logger.debug("Running 'file %s':" % core_path)
 259             try:
 260                 info = check_output(["file", core_path])
 261                 logger.debug(info)
 262             except CalledProcessError as e:
 263                 logger.error("Subprocess returned with return code "
 264                              "while running `file' utility on core-file "
 265                              "returned: "
 266                              "rc=%s", e.returncode)
 267             except OSError as e:
 268                 logger.error("Subprocess returned with OS error while "
 269                              "running 'file' utility "
 270                              "on core-file: "
 271                              "(%s) %s", e.errno, e.strerror)
 272             except Exception as e:
 273                 logger.exception("Unexpected error running `file' utility "
 274                                  "on core-file")
 275
 276     if vpp_pid:
 277         # Copy api post mortem
 278         api_post_mortem_path = "/tmp/api_post_mortem.%d" % vpp_pid
 279         if os.path.isfile(api_post_mortem_path):
 280             logger.error("Copying api_post_mortem.%d to %s" %
 281                          (vpp_pid, last_test_temp_dir))
 282             shutil.copy2(api_post_mortem_path, last_test_temp_dir)
 283
 284
 285 def check_and_handle_core(vpp_binary, tempdir, core_crash_test):
 286     if is_core_present(tempdir):
 287         if debug_core:
 288             print('VPP core detected in %s. Last test running was %s' %
 289                   (tempdir, core_crash_test))
 290             print(single_line_delim)
 291             spawn_gdb(vpp_binary, get_core_path(tempdir))
 292             print(single_line_delim)
 293         elif compress_core:
 294             print("Compressing core-file in test directory `%s'" % tempdir)
 295             os.system("gzip %s" % get_core_path(tempdir))
 296
 297
 298 def handle_cores(failed_testcases):
 299     for failed_testcase in failed_testcases:
 300         tcs_with_core = failed_testcase.testclasess_with_core
 301         if tcs_with_core:
 302             for test, vpp_binary, tempdir in tcs_with_core.values():
 303                 check_and_handle_core(vpp_binary, tempdir, test)
 304
 305
 306 def process_finished_testsuite(wrapped_testcase_suite,
 307                                finished_testcase_suites,
 308                                failed_wrapped_testcases,
 309                                results):
 310     results.append(wrapped_testcase_suite.result)
 311     finished_testcase_suites.add(wrapped_testcase_suite)
 312     stop_run = False
 313     if failfast and not wrapped_testcase_suite.was_successful():
 314         stop_run = True
 315
 316     if not wrapped_testcase_suite.was_successful():
 317         failed_wrapped_testcases.add(wrapped_testcase_suite)
 318         handle_failed_suite(wrapped_testcase_suite.logger,
 319                             wrapped_testcase_suite.last_test_temp_dir,
 320                             wrapped_testcase_suite.vpp_pid)
 321
 322     return stop_run
 323
 324
 325 def run_forked(testcase_suites):
 326     wrapped_testcase_suites = set()
 327
 328     # suites are unhashable, need to use list
 329     results = []
 330     unread_testcases = set()
 331     finished_unread_testcases = set()
 332     manager = StreamQueueManager()
 333     manager.start()
 334     for i in range(concurrent_tests):
 335         if testcase_suites:
 336             wrapped_testcase_suite = TestCaseWrapper(testcase_suites.pop(0),
 337                                                      manager)
 338             wrapped_testcase_suites.add(wrapped_testcase_suite)
 339             unread_testcases.add(wrapped_testcase_suite)
 340         else:
 341             break
 342
 343     read_from_testcases = threading.Event()
 344     read_from_testcases.set()
 345     stdouterr_thread = threading.Thread(target=stdouterr_reader_wrapper,
 346                                         args=(unread_testcases,
 347                                               finished_unread_testcases,
 348                                               read_from_testcases))
 349     stdouterr_thread.start()
 350
 351     failed_wrapped_testcases = set()
 352     stop_run = False
 353
 354     try:
 355         while wrapped_testcase_suites:
 356             finished_testcase_suites = set()
 357             for wrapped_testcase_suite in wrapped_testcase_suites:
 358                 while wrapped_testcase_suite.result_parent_end.poll():
 359                     wrapped_testcase_suite.result.process_result(
 360                         *wrapped_testcase_suite.result_parent_end.recv())
 361                     wrapped_testcase_suite.last_heard = time.time()
 362
 363                 while wrapped_testcase_suite.keep_alive_parent_end.poll():
 364                     wrapped_testcase_suite.last_test, \
 365                         wrapped_testcase_suite.last_test_vpp_binary, \
 366                         wrapped_testcase_suite.last_test_temp_dir, \
 367                         wrapped_testcase_suite.vpp_pid = \
 368                         wrapped_testcase_suite.keep_alive_parent_end.recv()
 369                     wrapped_testcase_suite.last_heard = time.time()
 370
 371                 if wrapped_testcase_suite.finished_parent_end.poll():
 372                     wrapped_testcase_suite.finished_parent_end.recv()
 373                     wrapped_testcase_suite.last_heard = time.time()
 374                     stop_run = process_finished_testsuite(
 375                         wrapped_testcase_suite,
 376                         finished_testcase_suites,
 377                         failed_wrapped_testcases,
 378                         results) or stop_run
 379                     continue
 380
 381                 fail = False
 382                 if wrapped_testcase_suite.last_heard + test_timeout < \
 383                         time.time():
 384                     fail = True
 385                     wrapped_testcase_suite.logger.critical(
 386                         "Child test runner process timed out "
 387                         "(last test running was `%s' in `%s')!" %
 388                         (wrapped_testcase_suite.last_test,
 389                          wrapped_testcase_suite.last_test_temp_dir))
 390                 elif not wrapped_testcase_suite.child.is_alive():
 391                     fail = True
 392                     wrapped_testcase_suite.logger.critical(
 393                         "Child test runner process unexpectedly died "
 394                         "(last test running was `%s' in `%s')!" %
 395                         (wrapped_testcase_suite.last_test,
 396                          wrapped_testcase_suite.last_test_temp_dir))
 397                 elif wrapped_testcase_suite.last_test_temp_dir and \
 398                         wrapped_testcase_suite.last_test_vpp_binary:
 399                     if is_core_present(
 400                             wrapped_testcase_suite.last_test_temp_dir):
 401                         wrapped_testcase_suite.add_testclass_with_core()
 402                         if wrapped_testcase_suite.core_detected_at is None:
 403                             wrapped_testcase_suite.core_detected_at = \
 404                                 time.time()
 405                         elif wrapped_testcase_suite.core_detected_at + \
 406                                 core_timeout < time.time():
 407                             wrapped_testcase_suite.logger.critical(
 408                                 "Child test runner process unresponsive and "
 409                                 "core-file exists in test temporary directory "
 410                                 "(last test running was `%s' in `%s')!" %
 411                                 (wrapped_testcase_suite.last_test,
 412                                  wrapped_testcase_suite.last_test_temp_dir))
 413                             fail = True
 414
 415                 if fail:
 416                     wrapped_testcase_suite.child.terminate()
 417                     try:
 418                         # terminating the child process tends to leave orphan
 419                         # VPP process around
 420                         if wrapped_testcase_suite.vpp_pid:
 421                             os.kill(wrapped_testcase_suite.vpp_pid,
 422                                     signal.SIGTERM)
 423                     except OSError:
 424                         # already dead
 425                         pass
 426                     wrapped_testcase_suite.result.crashed = True
 427                     wrapped_testcase_suite.result.process_result(
 428                         wrapped_testcase_suite.last_test_id, ERROR)
 429                     stop_run = process_finished_testsuite(
 430                         wrapped_testcase_suite,
 431                         finished_testcase_suites,
 432                         failed_wrapped_testcases,
 433                         results) or stop_run
 434
 435             for finished_testcase in finished_testcase_suites:
 436                 finished_testcase.child.join()
 437                 finished_testcase.close_pipes()
 438                 wrapped_testcase_suites.remove(finished_testcase)
 439                 finished_unread_testcases.add(finished_testcase)
 440                 finished_testcase.stdouterr_queue.put(None)
 441                 if stop_run:
 442                     while testcase_suites:
 443                         results.append(TestResult(testcase_suites.pop(0)))
 444                 elif testcase_suites:
 445                     new_testcase = TestCaseWrapper(testcase_suites.pop(0),
 446                                                    manager)
 447                     wrapped_testcase_suites.add(new_testcase)
 448                     unread_testcases.add(new_testcase)
 449             time.sleep(0.1)
 450     except Exception:
 451         for wrapped_testcase_suite in wrapped_testcase_suites:
 452             wrapped_testcase_suite.child.terminate()
 453             wrapped_testcase_suite.stdouterr_queue.put(None)
 454         raise
 455     finally:
 456         read_from_testcases.clear()
 457         stdouterr_thread.join(test_timeout)
 458         manager.shutdown()
 459
 460     handle_cores(failed_wrapped_testcases)
 461     return results
 462
 463
 464 class SplitToSuitesCallback:
 465     def __init__(self, filter_callback):
 466         self.suites = {}
 467         self.suite_name = 'default'
 468         self.filter_callback = filter_callback
 469         self.filtered = unittest.TestSuite()
 470
 471     def __call__(self, file_name, cls, method):
 472         test_method = cls(method)
 473         if self.filter_callback(file_name, cls.__name__, method):
 474             self.suite_name = file_name + cls.__name__
 475             if self.suite_name not in self.suites:
 476                 self.suites[self.suite_name] = unittest.TestSuite()
 477             self.suites[self.suite_name].addTest(test_method)
 478
 479         else:
 480             self.filtered.addTest(test_method)
 481
 482
 483 test_option = "TEST"
 484
 485
 486 def parse_test_option():
 487     f = os.getenv(test_option, None)
 488     filter_file_name = None
 489     filter_class_name = None
 490     filter_func_name = None
 491     if f:
 492         if '.' in f:
 493             parts = f.split('.')
 494             if len(parts) > 3:
 495                 raise Exception("Unrecognized %s option: %s" %
 496                                 (test_option, f))
 497             if len(parts) > 2:
 498                 if parts[2] not in ('*', ''):
 499                     filter_func_name = parts[2]
 500             if parts[1] not in ('*', ''):
 501                 filter_class_name = parts[1]
 502             if parts[0] not in ('*', ''):
 503                 if parts[0].startswith('test_'):
 504                     filter_file_name = parts[0]
 505                 else:
 506                     filter_file_name = 'test_%s' % parts[0]
 507         else:
 508             if f.startswith('test_'):
 509                 filter_file_name = f
 510             else:
 511                 filter_file_name = 'test_%s' % f
 512     if filter_file_name:
 513         filter_file_name = '%s.py' % filter_file_name
 514     return filter_file_name, filter_class_name, filter_func_name
 515
 516
 517 def filter_tests(tests, filter_cb):
 518     result = unittest.suite.TestSuite()
 519     for t in tests:
 520         if isinstance(t, unittest.suite.TestSuite):
 521             # this is a bunch of tests, recursively filter...
 522             x = filter_tests(t, filter_cb)
 523             if x.countTestCases() > 0:
 524                 result.addTest(x)
 525         elif isinstance(t, unittest.TestCase):
 526             # this is a single test
 527             parts = t.id().split('.')
 528             # t.id() for common cases like this:
 529             # test_classifier.TestClassifier.test_acl_ip
 530             # apply filtering only if it is so
 531             if len(parts) == 3:
 532                 if not filter_cb(parts[0], parts[1], parts[2]):
 533                     continue
 534             result.addTest(t)
 535         else:
 536             # unexpected object, don't touch it
 537             result.addTest(t)
 538     return result
 539
 540
 541 class FilterByTestOption:
 542     def __init__(self, filter_file_name, filter_class_name, filter_func_name):
 543         self.filter_file_name = filter_file_name
 544         self.filter_class_name = filter_class_name
 545         self.filter_func_name = filter_func_name
 546
 547     def __call__(self, file_name, class_name, func_name):
 548         if self.filter_file_name:
 549             fn_match = fnmatch.fnmatch(file_name, self.filter_file_name)
 550             if not fn_match:
 551                 return False
 552         if self.filter_class_name and class_name != self.filter_class_name:
 553             return False
 554         if self.filter_func_name and func_name != self.filter_func_name:
 555             return False
 556         return True
 557
 558
 559 class FilterByClassList:
 560     def __init__(self, classes_with_filenames):
 561         self.classes_with_filenames = classes_with_filenames
 562
 563     def __call__(self, file_name, class_name, func_name):
 564         return '.'.join([file_name, class_name]) in self.classes_with_filenames
 565
 566
 567 def suite_from_failed(suite, failed):
 568     failed = {x.rsplit('.', 1)[0] for x in failed}
 569     filter_cb = FilterByClassList(failed)
 570     suite = filter_tests(suite, filter_cb)
 571     return suite
 572
 573
 574 class AllResults(dict):
 575     def __init__(self):
 576         super(AllResults, self).__init__()
 577         self.all_testcases = 0
 578         self.results_per_suite = []
 579         self[PASS] = 0
 580         self[FAIL] = 0
 581         self[ERROR] = 0
 582         self[SKIP] = 0
 583         self[TEST_RUN] = 0
 584         self.rerun = []
 585         self.testsuites_no_tests_run = []
 586
 587     def add_results(self, result):
 588         self.results_per_suite.append(result)
 589         result_types = [PASS, FAIL, ERROR, SKIP, TEST_RUN]
 590         for result_type in result_types:
 591             self[result_type] += len(result[result_type])
 592
 593     def add_result(self, result):
 594         retval = 0
 595         self.all_testcases += result.testcase_suite.countTestCases()
 596         self.add_results(result)
 597
 598         if result.no_tests_run():
 599             self.testsuites_no_tests_run.append(result.testcase_suite)
 600             if result.crashed:
 601                 retval = -1
 602             else:
 603                 retval = 1
 604         elif not result.was_successful():
 605             retval = 1
 606
 607         if retval != 0:
 608             self.rerun.append(result.testcase_suite)
 609
 610         return retval
 611
 612     def print_results(self):
 613         print('')
 614         print(double_line_delim)
 615         print('TEST RESULTS:')
 616         print('     Scheduled tests: {}'.format(self.all_testcases))
 617         print('      Executed tests: {}'.format(self[TEST_RUN]))
 618         print('        Passed tests: {}'.format(
 619             colorize(str(self[PASS]), GREEN)))
 620         if self[SKIP] > 0:
 621             print('       Skipped tests: {}'.format(
 622                 colorize(str(self[SKIP]), YELLOW)))
 623         if self.not_executed > 0:
 624             print('  Not Executed tests: {}'.format(
 625                 colorize(str(self.not_executed), RED)))
 626         if self[FAIL] > 0:
 627             print('            Failures: {}'.format(
 628                 colorize(str(self[FAIL]), RED)))
 629         if self[ERROR] > 0:
 630             print('              Errors: {}'.format(
 631                 colorize(str(self[ERROR]), RED)))
 632
 633         if self.all_failed > 0:
 634             print('FAILURES AND ERRORS IN TESTS:')
 635             for result in self.results_per_suite:
 636                 failed_testcase_ids = result[FAIL]
 637                 errored_testcase_ids = result[ERROR]
 638                 old_testcase_name = None
 639                 if failed_testcase_ids or errored_testcase_ids:
 640                     for failed_test_id in failed_testcase_ids:
 641                         new_testcase_name, test_name = \
 642                             result.get_testcase_names(failed_test_id)
 643                         if new_testcase_name != old_testcase_name:
 644                             print('  Testcase name: {}'.format(
 645                                 colorize(new_testcase_name, RED)))
 646                             old_testcase_name = new_testcase_name
 647                         print('    FAILURE: {} [{}]'.format(
 648                             colorize(test_name, RED), failed_test_id))
 649                     for failed_test_id in errored_testcase_ids:
 650                         new_testcase_name, test_name = \
 651                             result.get_testcase_names(failed_test_id)
 652                         if new_testcase_name != old_testcase_name:
 653                             print('  Testcase name: {}'.format(
 654                                 colorize(new_testcase_name, RED)))
 655                             old_testcase_name = new_testcase_name
 656                         print('      ERROR: {} [{}]'.format(
 657                             colorize(test_name, RED), failed_test_id))
 658         if self.testsuites_no_tests_run:
 659             print('TESTCASES WHERE NO TESTS WERE SUCCESSFULLY EXECUTED:')
 660             tc_classes = set()
 661             for testsuite in self.testsuites_no_tests_run:
 662                 for testcase in testsuite:
 663                     tc_classes.add(get_testcase_doc_name(testcase))
 664             for tc_class in tc_classes:
 665                 print('  {}'.format(colorize(tc_class, RED)))
 666
 667         print(double_line_delim)
 668         print('')
 669
 670     @property
 671     def not_executed(self):
 672         return self.all_testcases - self[TEST_RUN]
 673
 674     @property
 675     def all_failed(self):
 676         return self[FAIL] + self[ERROR]
 677
 678
 679 def parse_results(results):
 680     """
 681     Prints the number of scheduled, executed, not executed, passed, failed,
 682     errored and skipped tests and details about failed and errored tests.
 683
 684     Also returns all suites where any test failed.
 685
 686     :param results:
 687     :return:
 688     """
 689
 690     results_per_suite = AllResults()
 691     crashed = False
 692     failed = False
 693     for result in results:
 694         result_code = results_per_suite.add_result(result)
 695         if result_code == 1:
 696             failed = True
 697         elif result_code == -1:
 698             crashed = True
 699
 700     results_per_suite.print_results()
 701
 702     if crashed:
 703         return_code = -1
 704     elif failed:
 705         return_code = 1
 706     else:
 707         return_code = 0
 708     return return_code, results_per_suite.rerun
 709
 710
 711 def parse_digit_env(env_var, default):
 712     value = os.getenv(env_var, default)
 713     if value != default:
 714         if value.isdigit():
 715             value = int(value)
 716         else:
 717             print('WARNING: unsupported value "%s" for env var "%s",'
 718                   'defaulting to %s' % (value, env_var, default))
 719             value = default
 720     return value
 721
 722
 723 if __name__ == '__main__':
 724
 725     verbose = parse_digit_env("V", 0)
 726
 727     test_timeout = parse_digit_env("TIMEOUT", 600)  # default = 10 minutes
 728
 729     retries = parse_digit_env("RETRIES", 0)
 730
 731     debug = os.getenv("DEBUG", "n").lower() in ["gdb", "gdbserver"]
 732
 733     debug_core = os.getenv("DEBUG", "").lower() == "core"
 734     compress_core = framework.BoolEnvironmentVariable("CORE_COMPRESS")
 735
 736     step = framework.BoolEnvironmentVariable("STEP")
 737     force_foreground = framework.BoolEnvironmentVariable("FORCE_FOREGROUND")
 738
 739     run_interactive = debug or step or force_foreground
 740
 741     try:
 742         num_cpus = len(os.sched_getaffinity(0))
 743     except AttributeError:
 744         num_cpus = multiprocessing.cpu_count()
 745     shm_free = psutil.disk_usage('/dev/shm').free
 746
 747     print('OS reports %s available cpu(s). Free shm: %s' % (
 748         num_cpus, "{:,}MB".format(shm_free / (1024 * 1024))))
 749
 750     test_jobs = os.getenv("TEST_JOBS", "1").lower()  # default = 1 process
 751     if test_jobs == 'auto':
 752         if run_interactive:
 753             concurrent_tests = 1
 754             print('Interactive mode required, running on one core')
 755         else:
 756             shm_max_processes = 1
 757             if shm_free < min_req_shm:
 758                 raise Exception('Not enough free space in /dev/shm. Required '
 759                                 'free space is at least %sM.'
 760                                 % (min_req_shm >> 20))
 761             else:
 762                 extra_shm = shm_free - min_req_shm
 763                 shm_max_processes += extra_shm // shm_per_process
 764             concurrent_tests = min(cpu_count(), shm_max_processes)
 765             print('Found enough resources to run tests with %s cores'
 766                   % concurrent_tests)
 767     elif test_jobs.isdigit():
 768         concurrent_tests = int(test_jobs)
 769         print("Running on %s core(s) as set by 'TEST_JOBS'." %
 770               concurrent_tests)
 771     else:
 772         concurrent_tests = 1
 773         print('Running on one core.')
 774
 775     if run_interactive and concurrent_tests > 1:
 776         raise NotImplementedError(
 777             'Running tests interactively (DEBUG is gdb or gdbserver or STEP '
 778             'is set) in parallel (TEST_JOBS is more than 1) is not supported')
 779
 780     parser = argparse.ArgumentParser(description="VPP unit tests")
 781     parser.add_argument("-f", "--failfast", action='store_true',
 782                         help="fast failure flag")
 783     parser.add_argument("-d", "--dir", action='append', type=str,
 784                         help="directory containing test files "
 785                              "(may be specified multiple times)")
 786     args = parser.parse_args()
 787     failfast = args.failfast
 788     descriptions = True
 789
 790     print("Running tests using custom test runner")  # debug message
 791     filter_file, filter_class, filter_func = parse_test_option()
 792
 793     print("Active filters: file=%s, class=%s, function=%s" % (
 794         filter_file, filter_class, filter_func))
 795
 796     filter_cb = FilterByTestOption(filter_file, filter_class, filter_func)
 797
 798     ignore_path = os.getenv("VENV_PATH", None)
 799     cb = SplitToSuitesCallback(filter_cb)
 800     for d in args.dir:
 801         print("Adding tests from directory tree %s" % d)
 802         discover_tests(d, cb, ignore_path)
 803
 804     # suites are not hashable, need to use list
 805     suites = []
 806     tests_amount = 0
 807     for testcase_suite in cb.suites.values():
 808         tests_amount += testcase_suite.countTestCases()
 809         suites.append(testcase_suite)
 810
 811     print("%s out of %s tests match specified filters" % (
 812         tests_amount, tests_amount + cb.filtered.countTestCases()))
 813
 814     if not running_extended_tests:
 815         print("Not running extended tests (some tests will be skipped)")
 816
 817     attempts = retries + 1
 818     if attempts > 1:
 819         print("Perform %s attempts to pass the suite..." % attempts)
 820
 821     if run_interactive and suites:
 822         # don't fork if requiring interactive terminal
 823         print('Running tests in foreground in the current process')
 824         full_suite = unittest.TestSuite()
 825         map(full_suite.addTests, suites)
 826         result = VppTestRunner(verbosity=verbose,
 827                                failfast=failfast,
 828                                print_summary=True).run(full_suite)
 829         was_successful = result.wasSuccessful()
 830         if not was_successful:
 831             for test_case_info in result.failed_test_cases_info:
 832                 handle_failed_suite(test_case_info.logger,
 833                                     test_case_info.tempdir,
 834                                     test_case_info.vpp_pid)
 835                 if test_case_info in result.core_crash_test_cases_info:
 836                     check_and_handle_core(test_case_info.vpp_bin_path,
 837                                           test_case_info.tempdir,
 838                                           test_case_info.core_crash_test)
 839
 840         sys.exit(not was_successful)
 841     else:
 842         print('Running each VPPTestCase in a separate background process'
 843               ' with {} parallel process(es)'.format(concurrent_tests))
 844         exit_code = 0
 845         while suites and attempts > 0:
 846             results = run_forked(suites)
 847             exit_code, suites = parse_results(results)
 848             attempts -= 1
 849             if exit_code == 0:
 850                 print('Test run was successful')
 851             else:
 852                 print('%s attempt(s) left.' % attempts)
 853         sys.exit(exit_code)