docs: add contiv vpp
[vpp.git] / test / run_tests.py
index d3a885f..6836466 100644 (file)
@@ -3,6 +3,7 @@
 import sys
 import shutil
 import os
+import fnmatch
 import select
 import unittest
 import argparse
@@ -14,7 +15,8 @@ from multiprocessing import Process, Pipe, cpu_count
 from multiprocessing.queues import Queue
 from multiprocessing.managers import BaseManager
 from framework import VppTestRunner, running_extended_tests, VppTestCase, \
-    get_testcase_doc_name, get_test_description
+    get_testcase_doc_name, get_test_description, PASS, FAIL, ERROR, SKIP, \
+    TEST_RUN
 from debug import spawn_gdb
 from log import get_parallel_logger, double_line_delim, RED, YELLOW, GREEN, \
     colorize
@@ -48,21 +50,75 @@ class StreamQueueManager(BaseManager):
     pass
 
 
-StreamQueueManager.register('Queue', StreamQueue)
+StreamQueueManager.register('StreamQueue', StreamQueue)
 
 
-def test_runner_wrapper(suite, keep_alive_pipe, result_pipe, stdouterr_queue,
-                        logger):
+class TestResult(dict):
+    def __init__(self, testcase_suite):
+        super(TestResult, self).__init__()
+        self[PASS] = []
+        self[FAIL] = []
+        self[ERROR] = []
+        self[SKIP] = []
+        self[TEST_RUN] = []
+        self.testcase_suite = testcase_suite
+        self.testcases = [testcase for testcase in testcase_suite]
+        self.testcases_by_id = {}
+
+    def was_successful(self):
+        return len(self[PASS] + self[SKIP]) \
+               == self.testcase_suite.countTestCases()
+
+    def no_tests_run(self):
+        return 0 == len(self[TEST_RUN])
+
+    def process_result(self, test_id, result):
+        self[result].append(test_id)
+        for testcase in self.testcases:
+            if testcase.id() == test_id:
+                self.testcases_by_id[test_id] = testcase
+                self.testcases.remove(testcase)
+                break
+
+    def suite_from_failed(self):
+        rerun_ids = set([])
+        for testcase in self.testcase_suite:
+            tc_id = testcase.id()
+            if tc_id not in self[PASS] and tc_id not in self[SKIP]:
+                rerun_ids.add(tc_id)
+        if len(rerun_ids) > 0:
+            return suite_from_failed(self.testcase_suite, rerun_ids)
+
+    def get_testcase_names(self, test_id):
+        return self._get_testcase_class(test_id), \
+               self._get_test_description(test_id)
+
+    def _get_test_description(self, test_id):
+        if test_id in self.testcases_by_id:
+            return get_test_description(descriptions,
+                                        self.testcases_by_id[test_id])
+        else:
+            return test_id
+
+    def _get_testcase_class(self, test_id):
+        if test_id in self.testcases_by_id:
+            return get_testcase_doc_name(self.testcases_by_id[test_id])
+        else:
+            return test_id
+
+
+def test_runner_wrapper(suite, keep_alive_pipe, stdouterr_queue,
+                        finished_pipe, result_pipe, logger):
     sys.stdout = stdouterr_queue
     sys.stderr = stdouterr_queue
     VppTestCase.logger = logger
-    unittest.installHandler()
     result = VppTestRunner(keep_alive_pipe=keep_alive_pipe,
                            descriptions=descriptions,
                            verbosity=verbose,
+                           result_pipe=result_pipe,
                            failfast=failfast).run(suite)
-    result_pipe.send(result)
-    result_pipe.close()
+    finished_pipe.send(result.wasSuccessful())
+    finished_pipe.close()
     keep_alive_pipe.close()
 
 
@@ -70,31 +126,35 @@ class TestCaseWrapper(object):
     def __init__(self, testcase_suite, manager):
         self.keep_alive_parent_end, self.keep_alive_child_end = Pipe(
             duplex=False)
+        self.finished_parent_end, self.finished_child_end = Pipe(duplex=False)
         self.result_parent_end, self.result_child_end = Pipe(duplex=False)
         self.testcase_suite = testcase_suite
-        self.stdouterr_queue = manager.Queue()
+        self.stdouterr_queue = manager.StreamQueue()
         self.logger = get_parallel_logger(self.stdouterr_queue)
         self.child = Process(target=test_runner_wrapper,
-                             args=(testcase_suite, self.keep_alive_child_end,
-                                   self.result_child_end, self.stdouterr_queue,
+                             args=(testcase_suite,
+                                   self.keep_alive_child_end,
+                                   self.stdouterr_queue,
+                                   self.finished_child_end,
+                                   self.result_child_end,
                                    self.logger)
                              )
         self.child.start()
-        self.pid = self.child.pid
         self.last_test_temp_dir = None
         self.last_test_vpp_binary = None
         self.last_test = None
         self.result = None
+        self.vpp_pid = None
         self.last_heard = time.time()
         self.core_detected_at = None
-        self.failed_tests = []
-        self.fail = False
-        self.fail_addressed = False
+        self.result = TestResult(testcase_suite)
 
     def close_pipes(self):
         self.keep_alive_child_end.close()
+        self.finished_child_end.close()
         self.result_child_end.close()
         self.keep_alive_parent_end.close()
+        self.finished_parent_end.close()
         self.result_parent_end.close()
 
 
@@ -119,7 +179,7 @@ def stdouterr_reader_wrapper(unread_testcases, finished_unread_testcases,
             read_testcase = None
 
 
-def run_forked(testcases):
+def run_forked(testcase_suites):
     wrapped_testcase_suites = set()
 
     # suites are unhashable, need to use list
@@ -130,8 +190,9 @@ def run_forked(testcases):
     manager = StreamQueueManager()
     manager.start()
     for i in range(concurrent_tests):
-        if len(testcases) > 0:
-            wrapped_testcase_suite = TestCaseWrapper(testcases.pop(0), manager)
+        if len(testcase_suites) > 0:
+            wrapped_testcase_suite = TestCaseWrapper(testcase_suites.pop(0),
+                                                     manager)
             wrapped_testcase_suites.add(wrapped_testcase_suite)
             unread_testcases.add(wrapped_testcase_suite)
             # time.sleep(1)
@@ -149,77 +210,75 @@ def run_forked(testcases):
     while len(wrapped_testcase_suites) > 0:
         finished_testcase_suites = set()
         for wrapped_testcase_suite in wrapped_testcase_suites:
-            readable = select.select(
-                [wrapped_testcase_suite.keep_alive_parent_end.fileno(),
-                 wrapped_testcase_suite.result_parent_end.fileno()],
-                [], [], 1)[0]
-            if wrapped_testcase_suite.result_parent_end.fileno() in readable:
-                results.append(
-                    (wrapped_testcase_suite.testcase_suite,
-                     wrapped_testcase_suite.result_parent_end.recv()))
+            while wrapped_testcase_suite.result_parent_end.poll():
+                wrapped_testcase_suite.result.process_result(
+                    *wrapped_testcase_suite.result_parent_end.recv())
+                wrapped_testcase_suite.last_heard = time.time()
+
+            if wrapped_testcase_suite.finished_parent_end.poll():
+                wrapped_testcase_suite.finished_parent_end.recv()
+                results.append(wrapped_testcase_suite.result)
                 finished_testcase_suites.add(wrapped_testcase_suite)
                 continue
 
-            if wrapped_testcase_suite.keep_alive_parent_end.fileno() \
-                    in readable:
-                while wrapped_testcase_suite.keep_alive_parent_end.poll():
-                    wrapped_testcase_suite.last_test, \
-                        wrapped_testcase_suite.last_test_vpp_binary, \
-                        wrapped_testcase_suite.last_test_temp_dir, \
-                        wrapped_testcase_suite.vpp_pid = \
-                        wrapped_testcase_suite.keep_alive_parent_end.recv()
+            while wrapped_testcase_suite.keep_alive_parent_end.poll():
+                wrapped_testcase_suite.last_test, \
+                    wrapped_testcase_suite.last_test_vpp_binary, \
+                    wrapped_testcase_suite.last_test_temp_dir, \
+                    wrapped_testcase_suite.vpp_pid = \
+                    wrapped_testcase_suite.keep_alive_parent_end.recv()
                 wrapped_testcase_suite.last_heard = time.time()
 
-            if not wrapped_testcase_suite.fail:
-                if wrapped_testcase_suite.last_heard + \
-                        test_timeout < time.time() and \
-                        not os.path.isfile(
-                                    "%s/_core_handled" %
-                                    wrapped_testcase_suite.last_test_temp_dir):
-                    wrapped_testcase_suite.fail = True
-                    wrapped_testcase_suite.logger.critical(
-                        "Timeout while waiting for child test "
-                        "runner process (last test running was "
-                        "`%s' in `%s')!" %
-                        (wrapped_testcase_suite.last_test,
-                         wrapped_testcase_suite.last_test_temp_dir))
-                elif not wrapped_testcase_suite.child.is_alive():
-                    wrapped_testcase_suite.fail = True
-                    wrapped_testcase_suite.logger.critical(
-                        "Child python process unexpectedly died "
-                        "(last test running was `%s' in `%s')!" %
-                        (wrapped_testcase_suite.last_test,
-                         wrapped_testcase_suite.last_test_temp_dir))
-                elif wrapped_testcase_suite.last_test_temp_dir and \
-                        wrapped_testcase_suite.last_test_vpp_binary:
-                    core_path = "%s/core" % \
-                                wrapped_testcase_suite.last_test_temp_dir
-                    if os.path.isfile(core_path):
-                        if wrapped_testcase_suite.core_detected_at is None:
-                            wrapped_testcase_suite.core_detected_at = \
-                                time.time()
-                        elif wrapped_testcase_suite.core_detected_at + \
-                                core_timeout < time.time():
-                            if not os.path.isfile(
-                                            "%s/_core_handled" %
-                                            wrapped_testcase_suite.
-                                            last_test_temp_dir):
-                                wrapped_testcase_suite.logger.critical(
-                                    "Child python process unresponsive and "
-                                    "core-file exists in test temporary "
-                                    "directory!")
-                                wrapped_testcase_suite.fail = True
-
-            if wrapped_testcase_suite.fail and not \
-                    wrapped_testcase_suite.fail_addressed:
+            fail = False
+            if wrapped_testcase_suite.last_heard + test_timeout < time.time() \
+                    and not os.path.isfile(
+                                "%s/_core_handled" %
+                                wrapped_testcase_suite.last_test_temp_dir):
+                fail = True
+                wrapped_testcase_suite.logger.critical(
+                    "Timeout while waiting for child test "
+                    "runner process (last test running was "
+                    "`%s' in `%s')!" %
+                    (wrapped_testcase_suite.last_test,
+                     wrapped_testcase_suite.last_test_temp_dir))
+            elif not wrapped_testcase_suite.child.is_alive():
+                fail = True
+                wrapped_testcase_suite.logger.critical(
+                    "Child python process unexpectedly died "
+                    "(last test running was `%s' in `%s')!" %
+                    (wrapped_testcase_suite.last_test,
+                     wrapped_testcase_suite.last_test_temp_dir))
+            elif wrapped_testcase_suite.last_test_temp_dir and \
+                    wrapped_testcase_suite.last_test_vpp_binary:
+                core_path = "%s/core" % \
+                            wrapped_testcase_suite.last_test_temp_dir
+                if os.path.isfile(core_path):
+                    if wrapped_testcase_suite.core_detected_at is None:
+                        wrapped_testcase_suite.core_detected_at = time.time()
+                    elif wrapped_testcase_suite.core_detected_at + \
+                            core_timeout < time.time():
+                        if not os.path.isfile(
+                                        "%s/_core_handled" %
+                                        wrapped_testcase_suite.
+                                        last_test_temp_dir):
+                            wrapped_testcase_suite.logger.critical(
+                                "Child python process unresponsive and core-"
+                                "file exists in test temporary directory!")
+                            fail = True
+
+            if fail:
                 failed_dir = os.getenv('VPP_TEST_FAILED_DIR')
-                lttd = os.path.basename(
-                    wrapped_testcase_suite.last_test_temp_dir)
+                if wrapped_testcase_suite.last_test_temp_dir:
+                    lttd = os.path.basename(
+                        wrapped_testcase_suite.last_test_temp_dir)
+                else:
+                    lttd = None
                 link_path = '%s%s-FAILED' % (failed_dir, lttd)
                 wrapped_testcase_suite.logger.error(
                     "Creating a link to the failed test: %s -> %s" %
                     (link_path, lttd))
-                if not os.path.exists(link_path):
+                if not os.path.exists(link_path) \
+                        and wrapped_testcase_suite.last_test_temp_dir:
                     os.symlink(wrapped_testcase_suite.last_test_temp_dir,
                                link_path)
                 api_post_mortem_path = "/tmp/api_post_mortem.%d" % \
@@ -255,7 +314,7 @@ def run_forked(testcases):
                             spawn_gdb(
                                 wrapped_testcase_suite.last_test_vpp_binary,
                                 core_path, wrapped_testcase_suite.logger)
-                os.kill(wrapped_testcase_suite.child.pid, signal.SIGINT)
+                wrapped_testcase_suite.child.terminate()
                 try:
                     # terminating the child process tends to leave orphan
                     # VPP process around
@@ -263,7 +322,8 @@ def run_forked(testcases):
                 except OSError:
                     # already dead
                     pass
-                wrapped_testcase_suite.fail_addressed = True
+                results.append(wrapped_testcase_suite.result)
+                finished_testcase_suites.add(wrapped_testcase_suite)
 
         for finished_testcase in finished_testcase_suites:
             finished_testcase.child.join()
@@ -271,8 +331,8 @@ def run_forked(testcases):
             wrapped_testcase_suites.remove(finished_testcase)
             finished_unread_testcases.add(finished_testcase)
             finished_testcase.stdouterr_queue.put(None)
-            if len(testcases) > 0:
-                new_testcase = TestCaseWrapper(testcases.pop(0), manager)
+            if len(testcase_suites) > 0:
+                new_testcase = TestCaseWrapper(testcase_suites.pop(0), manager)
                 wrapped_testcase_suites.add(new_testcase)
                 unread_testcases.add(new_testcase)
 
@@ -366,8 +426,10 @@ class FilterByTestOption:
         self.filter_func_name = filter_func_name
 
     def __call__(self, file_name, class_name, func_name):
-        if self.filter_file_name and file_name != self.filter_file_name:
-            return False
+        if self.filter_file_name:
+            fn_match = fnmatch.fnmatch(file_name, self.filter_file_name)
+            if not fn_match:
+                return False
         if self.filter_class_name and class_name != self.filter_class_name:
             return False
         if self.filter_func_name and func_name != self.filter_func_name:
@@ -376,91 +438,59 @@ class FilterByTestOption:
 
 
 class FilterByClassList:
-    def __init__(self, class_list):
-        self.class_list = class_list
+    def __init__(self, classes_with_filenames):
+        self.classes_with_filenames = classes_with_filenames
 
     def __call__(self, file_name, class_name, func_name):
-        return class_name in self.class_list
+        return '.'.join([file_name, class_name]) in self.classes_with_filenames
 
 
 def suite_from_failed(suite, failed):
+    failed = {x.rsplit('.', 1)[0] for x in failed}
     filter_cb = FilterByClassList(failed)
     suite = filter_tests(suite, filter_cb)
     return suite
 
 
-class NonPassedResults(dict):
+class AllResults(dict):
     def __init__(self):
-        super(NonPassedResults, self).__init__()
+        super(AllResults, self).__init__()
         self.all_testcases = 0
-        self.results_per_suite = {}
-        self.failures_id = 'failures'
-        self.errors_id = 'errors'
-        self.crashes_id = 'crashes'
-        self.skipped_id = 'skipped'
-        self.expectedFailures_id = 'expectedFailures'
-        self.unexpectedSuccesses_id = 'unexpectedSuccesses'
+        self.results_per_suite = []
+        self[PASS] = 0
+        self[FAIL] = 0
+        self[ERROR] = 0
+        self[SKIP] = 0
+        self[TEST_RUN] = 0
         self.rerun = []
-        self.passed = 0
-        self[self.failures_id] = 0
-        self[self.errors_id] = 0
-        self[self.skipped_id] = 0
-        self[self.expectedFailures_id] = 0
-        self[self.unexpectedSuccesses_id] = 0
-
-    def _add_result(self, test, result_id):
-        if isinstance(test, VppTestCase):
-            parts = test.id().split('.')
-            if len(parts) == 3:
-                tc_class = get_testcase_doc_name(test)
-                if tc_class not in self.results_per_suite:
-                    # failed, errored, skipped, expectedly failed,
-                    # unexpectedly passed
-                    self.results_per_suite[tc_class] = \
-                        {self.failures_id: [],
-                         self.errors_id: [],
-                         self.skipped_id: [],
-                         self.expectedFailures_id: [],
-                         self.unexpectedSuccesses_id: []}
-                self.results_per_suite[tc_class][result_id].append(test)
-                return True
-        return False
-
-    def add_results(self, testcases, testcase_result_id):
-        for failed_testcase, _ in testcases:
-            if self._add_result(failed_testcase, testcase_result_id):
-                self[testcase_result_id] += 1
-
-    def add_result(self, testcase_suite, result):
+        self.testsuites_no_tests_run = []
+
+    def add_results(self, result):
+        self.results_per_suite.append(result)
+        result_types = [PASS, FAIL, ERROR, SKIP, TEST_RUN]
+        for result_type in result_types:
+            self[result_type] += len(result[result_type])
+
+    def add_result(self, result):
         retval = 0
-        self.all_testcases += result.testsRun
-        self.passed += result.passed
-        if result:
-            # suite finished properly
-            if not result.wasSuccessful():
+        self.all_testcases += result.testcase_suite.countTestCases()
+        if not result.no_tests_run():
+            if not result.was_successful():
                 retval = 1
 
-            self.add_results(result.failures, self.failures_id)
-            self.add_results(result.errors, self.errors_id)
-            self.add_results(result.skipped, self.skipped_id)
-            self.add_results(result.expectedFailures,
-                             self.expectedFailures_id)
-            self.add_results(result.unexpectedSuccesses,
-                             self.unexpectedSuccesses_id)
+            self.add_results(result)
+        else:
+            self.testsuites_no_tests_run.append(result.testcase_suite)
+            retval = -1
 
         if retval != 0:
             if concurrent_tests == 1:
-                if result:
-                    rerun_classes = {x[0].__class__.__name__ for
-                                     x in result.errors}
-                    rerun_classes.update({x[0].__class__.__name__ for
-                                          x in result.failures})
-                    self.rerun.append(suite_from_failed(testcase_suite,
-                                                        rerun_classes))
+                if not result.no_tests_run():
+                    self.rerun.append(result.suite_from_failed())
                 else:
-                    self.rerun.append(testcase_suite)
+                    self.rerun.append(result.testcase_suite)
             else:
-                self.rerun.append(testcase_suite)
+                self.rerun.append(result.testcase_suite)
 
         return retval
 
@@ -468,70 +498,85 @@ class NonPassedResults(dict):
         print('')
         print(double_line_delim)
         print('TEST RESULTS:')
-        print('        Executed tests: {}'.format(self.all_testcases))
-        print('          Passed tests: {}'.format(
-            colorize(str(self.passed), GREEN)))
-        if self[self.failures_id] > 0:
-            print('              Failures: {}'.format(
-                colorize(str(self[self.failures_id]), RED)))
-        if self[self.errors_id] > 0:
-            print('                Errors: {}'.format(
-                colorize(str(self[self.errors_id]), RED)))
-        if self[self.skipped_id] > 0:
-            print('         Skipped tests: {}'.format(
-                colorize(str(self[self.skipped_id]), YELLOW)))
-        if self[self.expectedFailures_id] > 0:
-            print('     Expected failures: {}'.format(
-                colorize(str(self[self.expectedFailures_id]), GREEN)))
-        if self[self.unexpectedSuccesses_id] > 0:
-            print('  Unexpected successes: {}'.format(
-                colorize(str(self[self.unexpectedSuccesses_id]), YELLOW)))
+        print('     Scheduled tests: {}'.format(self.all_testcases))
+        print('      Executed tests: {}'.format(self[TEST_RUN]))
+        print('        Passed tests: {}'.format(
+            colorize(str(self[PASS]), GREEN)))
+        if self[SKIP] > 0:
+            print('       Skipped tests: {}'.format(
+                colorize(str(self[SKIP]), YELLOW)))
+        if self.not_executed > 0:
+            print('  Not Executed tests: {}'.format(
+                colorize(str(self.not_executed), RED)))
+        if self[FAIL] > 0:
+            print('            Failures: {}'.format(
+                colorize(str(self[FAIL]), RED)))
+        if self[ERROR] > 0:
+            print('              Errors: {}'.format(
+                colorize(str(self[ERROR]), RED)))
 
         if self.all_failed > 0:
             print('FAILED TESTS:')
-            for testcase_class, suite_results in \
-                    self.results_per_suite.items():
-                failed_testcases = suite_results[
-                    self.failures_id]
-                errored_testcases = suite_results[
-                    self.errors_id]
-                if len(failed_testcases) or len(errored_testcases):
-                    print('  Testcase name: {}'.format(
-                        colorize(testcase_class, RED)))
-                    for failed_test in failed_testcases:
+            for result in self.results_per_suite:
+                failed_testcase_ids = result[FAIL]
+                errored_testcase_ids = result[ERROR]
+                old_testcase_name = None
+                if len(failed_testcase_ids) or len(errored_testcase_ids):
+                    for failed_test_id in failed_testcase_ids:
+                        new_testcase_name, test_name = \
+                            result.get_testcase_names(failed_test_id)
+                        if new_testcase_name != old_testcase_name:
+                            print('  Testcase name: {}'.format(
+                                colorize(new_testcase_name, RED)))
+                            old_testcase_name = new_testcase_name
                         print('     FAILED: {}'.format(
-                            colorize(get_test_description(
-                                descriptions, failed_test), RED)))
-                    for failed_test in errored_testcases:
+                            colorize(test_name, RED)))
+                    for failed_test_id in errored_testcase_ids:
+                        new_testcase_name, test_name = \
+                            result.get_testcase_names(failed_test_id)
+                        if new_testcase_name != old_testcase_name:
+                            print('  Testcase name: {}'.format(
+                                colorize(new_testcase_name, RED)))
+                            old_testcase_name = new_testcase_name
                         print('    ERRORED: {}'.format(
-                            colorize(get_test_description(
-                                descriptions, failed_test), RED)))
+                            colorize(test_name, RED)))
+        if len(self.testsuites_no_tests_run) > 0:
+            print('TESTCASES WHERE NO TESTS WERE SUCCESSFULLY EXECUTED:')
+            tc_classes = set([])
+            for testsuite in self.testsuites_no_tests_run:
+                for testcase in testsuite:
+                    tc_classes.add(get_testcase_doc_name(testcase))
+            for tc_class in tc_classes:
+                print('  {}'.format(colorize(tc_class, RED)))
 
         print(double_line_delim)
         print('')
 
+    @property
+    def not_executed(self):
+        return self.all_testcases - self[TEST_RUN]
+
     @property
     def all_failed(self):
-        return self[self.failures_id] + self[self.errors_id]
+        return self[FAIL] + self[ERROR]
 
 
 def parse_results(results):
     """
-    Prints the number of executed, passed, failed, errored, skipped,
-    expectedly failed and unexpectedly passed tests and details about
-    failed, errored, expectedly failed and unexpectedly passed tests.
+    Prints the number of scheduled, executed, not executed, passed, failed,
+    errored and skipped tests and details about failed and errored tests.
 
-    Also returns any suites where any test failed.
+    Also returns all suites where any test failed.
 
     :param results:
     :return:
     """
 
-    results_per_suite = NonPassedResults()
+    results_per_suite = AllResults()
     crashed = False
     failed = False
-    for testcase_suite, result in results:
-        result_code = results_per_suite.add_result(testcase_suite, result)
+    for result in results:
+        result_code = results_per_suite.add_result(result)
         if result_code == 1:
             failed = True
         elif result_code == -1:
@@ -592,7 +637,7 @@ if __name__ == '__main__':
             else:
                 extra_shm = shm_free - min_req_shm
                 shm_max_processes += extra_shm / shm_per_process
-            concurrent_tests = max(cpu_count(), shm_max_processes)
+            concurrent_tests = min(cpu_count(), shm_max_processes)
             print('Found enough resources to run tests with %s cores'
                   % concurrent_tests)
     elif test_jobs.isdigit():
@@ -639,7 +684,7 @@ if __name__ == '__main__':
     if concurrent_tests == 1:
         new_suite = unittest.TestSuite()
         for suite in suites:
-            new_suite.addTest(suite)
+            new_suite.addTests(suite)
 
         suites = [new_suite]