test/framework.py

   1 #!/usr/bin/env python3
   2
   3 from __future__ import print_function
   4 import gc
   5 import sys
   6 import os
   7 import select
   8 import signal
   9 import unittest
  10 import tempfile
  11 import time
  12 import faulthandler
  13 import random
  14 import copy
  15 import psutil
  16 import platform
  17 from collections import deque
  18 from threading import Thread, Event
  19 from inspect import getdoc, isclass
  20 from traceback import format_exception
  21 from logging import FileHandler, DEBUG, Formatter
  22
  23 import scapy.compat
  24 from scapy.packet import Raw
  25 import hook as hookmodule
  26 from vpp_pg_interface import VppPGInterface
  27 from vpp_sub_interface import VppSubInterface
  28 from vpp_lo_interface import VppLoInterface
  29 from vpp_bvi_interface import VppBviInterface
  30 from vpp_papi_provider import VppPapiProvider
  31 import vpp_papi
  32 from vpp_papi.vpp_stats import VPPStats
  33 from vpp_papi.vpp_transport_shmem import VppTransportShmemIOError
  34 from log import RED, GREEN, YELLOW, double_line_delim, single_line_delim, \
  35     get_logger, colorize
  36 from vpp_object import VppObjectRegistry
  37 from util import ppp, is_core_present
  38 from scapy.layers.inet import IPerror, TCPerror, UDPerror, ICMPerror
  39 from scapy.layers.inet6 import ICMPv6DestUnreach, ICMPv6EchoRequest
  40 from scapy.layers.inet6 import ICMPv6EchoReply
  41
  42 if os.name == 'posix' and sys.version_info[0] < 3:
  43     # using subprocess32 is recommended by python official documentation
  44     # @ https://docs.python.org/2/library/subprocess.html
  45     import subprocess32 as subprocess
  46 else:
  47     import subprocess
  48
  49 #  Python2/3 compatible
  50 try:
  51     input = raw_input
  52 except NameError:
  53     pass
  54
  55 PASS = 0
  56 FAIL = 1
  57 ERROR = 2
  58 SKIP = 3
  59 TEST_RUN = 4
  60
  61
  62 class BoolEnvironmentVariable(object):
  63
  64     def __init__(self, env_var_name, default='n', true_values=None):
  65         self.name = env_var_name
  66         self.default = default
  67         self.true_values = true_values if true_values is not None else \
  68             ("y", "yes", "1")
  69
  70     def __bool__(self):
  71         return os.getenv(self.name, self.default).lower() in self.true_values
  72
  73     if sys.version_info[0] == 2:
  74         __nonzero__ = __bool__
  75
  76     def __repr__(self):
  77         return 'BoolEnvironmentVariable(%r, default=%r, true_values=%r)' % \
  78                (self.name, self.default, self.true_values)
  79
  80
  81 debug_framework = BoolEnvironmentVariable('TEST_DEBUG')
  82 if debug_framework:
  83     import debug_internal
  84
  85 """
  86   Test framework module.
  87
  88   The module provides a set of tools for constructing and running tests and
  89   representing the results.
  90 """
  91
  92
  93 class VppDiedError(Exception):
  94     """ exception for reporting that the subprocess has died."""
  95
  96     signals_by_value = {v: k for k, v in signal.__dict__.items() if
  97                         k.startswith('SIG') and not k.startswith('SIG_')}
  98
  99     def __init__(self, rv=None, testcase=None, method_name=None):
 100         self.rv = rv
 101         self.signal_name = None
 102         self.testcase = testcase
 103         self.method_name = method_name
 104
 105         try:
 106             self.signal_name = VppDiedError.signals_by_value[-rv]
 107         except (KeyError, TypeError):
 108             pass
 109
 110         if testcase is None and method_name is None:
 111             in_msg = ''
 112         else:
 113             in_msg = 'running %s.%s ' % (testcase, method_name)
 114
 115         msg = "VPP subprocess died %sunexpectedly with return code: %d%s." % (
 116             in_msg,
 117             self.rv,
 118             ' [%s]' % (self.signal_name if
 119                        self.signal_name is not None else ''))
 120         super(VppDiedError, self).__init__(msg)
 121
 122
 123 class _PacketInfo(object):
 124     """Private class to create packet info object.
 125
 126     Help process information about the next packet.
 127     Set variables to default values.
 128     """
 129     #: Store the index of the packet.
 130     index = -1
 131     #: Store the index of the source packet generator interface of the packet.
 132     src = -1
 133     #: Store the index of the destination packet generator interface
 134     #: of the packet.
 135     dst = -1
 136     #: Store expected ip version
 137     ip = -1
 138     #: Store expected upper protocol
 139     proto = -1
 140     #: Store the copy of the former packet.
 141     data = None
 142
 143     def __eq__(self, other):
 144         index = self.index == other.index
 145         src = self.src == other.src
 146         dst = self.dst == other.dst
 147         data = self.data == other.data
 148         return index and src and dst and data
 149
 150
 151 def pump_output(testclass):
 152     """ pump output from vpp stdout/stderr to proper queues """
 153     stdout_fragment = ""
 154     stderr_fragment = ""
 155     while not testclass.pump_thread_stop_flag.is_set():
 156         readable = select.select([testclass.vpp.stdout.fileno(),
 157                                   testclass.vpp.stderr.fileno(),
 158                                   testclass.pump_thread_wakeup_pipe[0]],
 159                                  [], [])[0]
 160         if testclass.vpp.stdout.fileno() in readable:
 161             read = os.read(testclass.vpp.stdout.fileno(), 102400)
 162             if len(read) > 0:
 163                 split = read.decode('ascii',
 164                                     errors='backslashreplace').splitlines(True)
 165                 if len(stdout_fragment) > 0:
 166                     split[0] = "%s%s" % (stdout_fragment, split[0])
 167                 if len(split) > 0 and split[-1].endswith("\n"):
 168                     limit = None
 169                 else:
 170                     limit = -1
 171                     stdout_fragment = split[-1]
 172                 testclass.vpp_stdout_deque.extend(split[:limit])
 173                 if not testclass.cache_vpp_output:
 174                     for line in split[:limit]:
 175                         testclass.logger.info(
 176                             "VPP STDOUT: %s" % line.rstrip("\n"))
 177         if testclass.vpp.stderr.fileno() in readable:
 178             read = os.read(testclass.vpp.stderr.fileno(), 102400)
 179             if len(read) > 0:
 180                 split = read.decode('ascii',
 181                                     errors='backslashreplace').splitlines(True)
 182                 if len(stderr_fragment) > 0:
 183                     split[0] = "%s%s" % (stderr_fragment, split[0])
 184                 if len(split) > 0 and split[-1].endswith("\n"):
 185                     limit = None
 186                 else:
 187                     limit = -1
 188                     stderr_fragment = split[-1]
 189
 190                 testclass.vpp_stderr_deque.extend(split[:limit])
 191                 if not testclass.cache_vpp_output:
 192                     for line in split[:limit]:
 193                         testclass.logger.error(
 194                             "VPP STDERR: %s" % line.rstrip("\n"))
 195                         # ignoring the dummy pipe here intentionally - the
 196                         # flag will take care of properly terminating the loop
 197
 198
 199 def _is_skip_aarch64_set():
 200     return BoolEnvironmentVariable('SKIP_AARCH64')
 201
 202
 203 is_skip_aarch64_set = _is_skip_aarch64_set()
 204
 205
 206 def _is_platform_aarch64():
 207     return platform.machine() == 'aarch64'
 208
 209
 210 is_platform_aarch64 = _is_platform_aarch64()
 211
 212
 213 def _running_extended_tests():
 214     return BoolEnvironmentVariable("EXTENDED_TESTS")
 215
 216
 217 running_extended_tests = _running_extended_tests()
 218
 219
 220 def _running_on_centos():
 221     os_id = os.getenv("OS_ID", "")
 222     return True if "centos" in os_id.lower() else False
 223
 224
 225 running_on_centos = _running_on_centos()
 226
 227
 228 class KeepAliveReporter(object):
 229     """
 230     Singleton object which reports test start to parent process
 231     """
 232     _shared_state = {}
 233
 234     def __init__(self):
 235         self.__dict__ = self._shared_state
 236         self._pipe = None
 237
 238     @property
 239     def pipe(self):
 240         return self._pipe
 241
 242     @pipe.setter
 243     def pipe(self, pipe):
 244         if self._pipe is not None:
 245             raise Exception("Internal error - pipe should only be set once.")
 246         self._pipe = pipe
 247
 248     def send_keep_alive(self, test, desc=None):
 249         """
 250         Write current test tmpdir & desc to keep-alive pipe to signal liveness
 251         """
 252         if self.pipe is None:
 253             # if not running forked..
 254             return
 255
 256         if isclass(test):
 257             desc = '%s (%s)' % (desc, unittest.util.strclass(test))
 258         else:
 259             desc = test.id()
 260
 261         self.pipe.send((desc, test.vpp_bin, test.tempdir, test.vpp.pid))
 262
 263
 264 class VppTestCase(unittest.TestCase):
 265     """This subclass is a base class for VPP test cases that are implemented as
 266     classes. It provides methods to create and run test case.
 267     """
 268
 269     extra_vpp_punt_config = []
 270     extra_vpp_plugin_config = []
 271     vapi_response_timeout = 5
 272
 273     @property
 274     def packet_infos(self):
 275         """List of packet infos"""
 276         return self._packet_infos
 277
 278     @classmethod
 279     def get_packet_count_for_if_idx(cls, dst_if_index):
 280         """Get the number of packet info for specified destination if index"""
 281         if dst_if_index in cls._packet_count_for_dst_if_idx:
 282             return cls._packet_count_for_dst_if_idx[dst_if_index]
 283         else:
 284             return 0
 285
 286     @classmethod
 287     def instance(cls):
 288         """Return the instance of this testcase"""
 289         return cls.test_instance
 290
 291     @classmethod
 292     def set_debug_flags(cls, d):
 293         cls.gdbserver_port = 7777
 294         cls.debug_core = False
 295         cls.debug_gdb = False
 296         cls.debug_gdbserver = False
 297         cls.debug_all = False
 298         if d is None:
 299             return
 300         dl = d.lower()
 301         if dl == "core":
 302             cls.debug_core = True
 303         elif dl == "gdb" or dl == "gdb-all":
 304             cls.debug_gdb = True
 305         elif dl == "gdbserver" or dl == "gdbserver-all":
 306             cls.debug_gdbserver = True
 307         else:
 308             raise Exception("Unrecognized DEBUG option: '%s'" % d)
 309         if dl == "gdb-all" or dl == "gdbserver-all":
 310             cls.debug_all = True
 311
 312     @staticmethod
 313     def get_least_used_cpu():
 314         cpu_usage_list = [set(range(psutil.cpu_count()))]
 315         vpp_processes = [p for p in psutil.process_iter(attrs=['pid', 'name'])
 316                          if 'vpp_main' == p.info['name']]
 317         for vpp_process in vpp_processes:
 318             for cpu_usage_set in cpu_usage_list:
 319                 try:
 320                     cpu_num = vpp_process.cpu_num()
 321                     if cpu_num in cpu_usage_set:
 322                         cpu_usage_set_index = cpu_usage_list.index(
 323                             cpu_usage_set)
 324                         if cpu_usage_set_index == len(cpu_usage_list) - 1:
 325                             cpu_usage_list.append({cpu_num})
 326                         else:
 327                             cpu_usage_list[cpu_usage_set_index + 1].add(
 328                                 cpu_num)
 329                         cpu_usage_set.remove(cpu_num)
 330                         break
 331                 except psutil.NoSuchProcess:
 332                     pass
 333
 334         for cpu_usage_set in cpu_usage_list:
 335             if len(cpu_usage_set) > 0:
 336                 min_usage_set = cpu_usage_set
 337                 break
 338
 339         return random.choice(tuple(min_usage_set))
 340
 341     @classmethod
 342     def setUpConstants(cls):
 343         """ Set-up the test case class based on environment variables """
 344         cls.step = BoolEnvironmentVariable('STEP')
 345         d = os.getenv("DEBUG", None)
 346         # inverted case to handle '' == True
 347         c = os.getenv("CACHE_OUTPUT", "1")
 348         cls.cache_vpp_output = False if c.lower() in ("n", "no", "0") else True
 349         cls.set_debug_flags(d)
 350         cls.vpp_bin = os.getenv('VPP_BIN', "vpp")
 351         cls.plugin_path = os.getenv('VPP_PLUGIN_PATH')
 352         cls.test_plugin_path = os.getenv('VPP_TEST_PLUGIN_PATH')
 353         cls.extern_plugin_path = os.getenv('EXTERN_PLUGINS')
 354         plugin_path = None
 355         if cls.plugin_path is not None:
 356             if cls.extern_plugin_path is not None:
 357                 plugin_path = "%s:%s" % (
 358                     cls.plugin_path, cls.extern_plugin_path)
 359             else:
 360                 plugin_path = cls.plugin_path
 361         elif cls.extern_plugin_path is not None:
 362             plugin_path = cls.extern_plugin_path
 363         debug_cli = ""
 364         if cls.step or cls.debug_gdb or cls.debug_gdbserver:
 365             debug_cli = "cli-listen localhost:5002"
 366         coredump_size = None
 367         size = os.getenv("COREDUMP_SIZE")
 368         if size is not None:
 369             coredump_size = "coredump-size %s" % size
 370         if coredump_size is None:
 371             coredump_size = "coredump-size unlimited"
 372
 373         cpu_core_number = cls.get_least_used_cpu()
 374         if not hasattr(cls, "worker_config"):
 375             cls.worker_config = ""
 376
 377         cls.vpp_cmdline = [cls.vpp_bin, "unix",
 378                            "{", "nodaemon", debug_cli, "full-coredump",
 379                            coredump_size, "runtime-dir", cls.tempdir, "}",
 380                            "api-trace", "{", "on", "}", "api-segment", "{",
 381                            "prefix", cls.shm_prefix, "}", "cpu", "{",
 382                            "main-core", str(cpu_core_number),
 383                            cls.worker_config, "}",
 384                            "statseg", "{", "socket-name", cls.stats_sock, "}",
 385                            "socksvr", "{", "socket-name", cls.api_sock, "}",
 386                            "plugins",
 387                            "{", "plugin", "dpdk_plugin.so", "{", "disable",
 388                            "}", "plugin", "rdma_plugin.so", "{", "disable",
 389                            "}", "plugin", "unittest_plugin.so", "{", "enable",
 390                            "}"] + cls.extra_vpp_plugin_config + ["}", ]
 391         if cls.extra_vpp_punt_config is not None:
 392             cls.vpp_cmdline.extend(cls.extra_vpp_punt_config)
 393         if plugin_path is not None:
 394             cls.vpp_cmdline.extend(["plugin_path", plugin_path])
 395         if cls.test_plugin_path is not None:
 396             cls.vpp_cmdline.extend(["test_plugin_path", cls.test_plugin_path])
 397
 398         cls.logger.info("vpp_cmdline args: %s" % cls.vpp_cmdline)
 399         cls.logger.info("vpp_cmdline: %s" % " ".join(cls.vpp_cmdline))
 400
 401     @classmethod
 402     def wait_for_enter(cls):
 403         if cls.debug_gdbserver:
 404             print(double_line_delim)
 405             print("Spawned GDB server with PID: %d" % cls.vpp.pid)
 406         elif cls.debug_gdb:
 407             print(double_line_delim)
 408             print("Spawned VPP with PID: %d" % cls.vpp.pid)
 409         else:
 410             cls.logger.debug("Spawned VPP with PID: %d" % cls.vpp.pid)
 411             return
 412         print(single_line_delim)
 413         print("You can debug VPP using:")
 414         if cls.debug_gdbserver:
 415             print("sudo gdb " + cls.vpp_bin +
 416                   " -ex 'target remote localhost:{port}'"
 417                   .format(port=cls.gdbserver_port))
 418             print("Now is the time to attach gdb by running the above "
 419                   "command, set up breakpoints etc., then resume VPP from "
 420                   "within gdb by issuing the 'continue' command")
 421             cls.gdbserver_port += 1
 422         elif cls.debug_gdb:
 423             print("sudo gdb " + cls.vpp_bin + " -ex 'attach %s'" % cls.vpp.pid)
 424             print("Now is the time to attach gdb by running the above "
 425                   "command and set up breakpoints etc., then resume VPP from"
 426                   " within gdb by issuing the 'continue' command")
 427         print(single_line_delim)
 428         input("Press ENTER to continue running the testcase...")
 429
 430     @classmethod
 431     def run_vpp(cls):
 432         cmdline = cls.vpp_cmdline
 433
 434         if cls.debug_gdbserver:
 435             gdbserver = '/usr/bin/gdbserver'
 436             if not os.path.isfile(gdbserver) or \
 437                     not os.access(gdbserver, os.X_OK):
 438                 raise Exception("gdbserver binary '%s' does not exist or is "
 439                                 "not executable" % gdbserver)
 440
 441             cmdline = [gdbserver, 'localhost:{port}'
 442                        .format(port=cls.gdbserver_port)] + cls.vpp_cmdline
 443             cls.logger.info("Gdbserver cmdline is %s", " ".join(cmdline))
 444
 445         try:
 446             cls.vpp = subprocess.Popen(cmdline,
 447                                        stdout=subprocess.PIPE,
 448                                        stderr=subprocess.PIPE,
 449                                        bufsize=1)
 450         except subprocess.CalledProcessError as e:
 451             cls.logger.critical("Subprocess returned with non-0 return code: ("
 452                                 "%s)", e.returncode)
 453             raise
 454         except OSError as e:
 455             cls.logger.critical("Subprocess returned with OS error: "
 456                                 "(%s) %s", e.errno, e.strerror)
 457             raise
 458         except Exception as e:
 459             cls.logger.exception("Subprocess returned unexpected from "
 460                                  "%s:", cmdline)
 461             raise
 462
 463         cls.wait_for_enter()
 464
 465     @classmethod
 466     def wait_for_stats_socket(cls):
 467         deadline = time.time() + 300
 468         ok = False
 469         while time.time() < deadline or \
 470                 cls.debug_gdb or cls.debug_gdbserver:
 471             if os.path.exists(cls.stats_sock):
 472                 ok = True
 473                 break
 474             cls.sleep(0.8)
 475         if not ok:
 476             cls.logger.critical("Couldn't stat : {}".format(cls.stats_sock))
 477
 478     @classmethod
 479     def wait_for_coredump(cls):
 480         corefile = cls.tempdir + "/core"
 481         if os.path.isfile(corefile):
 482             cls.logger.error("Waiting for coredump to complete: %s", corefile)
 483             curr_size = os.path.getsize(corefile)
 484             deadline = time.time() + 60
 485             ok = False
 486             while time.time() < deadline:
 487                 cls.sleep(1)
 488                 size = curr_size
 489                 curr_size = os.path.getsize(corefile)
 490                 if size == curr_size:
 491                     ok = True
 492                     break
 493             if not ok:
 494                 cls.logger.error("Timed out waiting for coredump to complete:"
 495                                  " %s", corefile)
 496             else:
 497                 cls.logger.error("Coredump complete: %s, size %d",
 498                                  corefile, curr_size)
 499
 500     @classmethod
 501     def setUpClass(cls):
 502         """
 503         Perform class setup before running the testcase
 504         Remove shared memory files, start vpp and connect the vpp-api
 505         """
 506         super(VppTestCase, cls).setUpClass()
 507         gc.collect()  # run garbage collection first
 508         cls.logger = get_logger(cls.__name__)
 509         seed = os.environ["RND_SEED"]
 510         random.seed(seed)
 511         if hasattr(cls, 'parallel_handler'):
 512             cls.logger.addHandler(cls.parallel_handler)
 513             cls.logger.propagate = False
 514
 515         cls.tempdir = tempfile.mkdtemp(
 516             prefix='vpp-unittest-%s-' % cls.__name__)
 517         cls.stats_sock = "%s/stats.sock" % cls.tempdir
 518         cls.api_sock = "%s/api.sock" % cls.tempdir
 519         cls.file_handler = FileHandler("%s/log.txt" % cls.tempdir)
 520         cls.file_handler.setFormatter(
 521             Formatter(fmt='%(asctime)s,%(msecs)03d %(message)s',
 522                       datefmt="%H:%M:%S"))
 523         cls.file_handler.setLevel(DEBUG)
 524         cls.logger.addHandler(cls.file_handler)
 525         cls.logger.debug("--- setUpClass() for %s called ---" %
 526                          cls.__name__)
 527         cls.shm_prefix = os.path.basename(cls.tempdir)
 528         os.chdir(cls.tempdir)
 529         cls.logger.info("Temporary dir is %s, shm prefix is %s",
 530                         cls.tempdir, cls.shm_prefix)
 531         cls.logger.debug("Random seed is %s" % seed)
 532         cls.setUpConstants()
 533         cls.reset_packet_infos()
 534         cls._captures = []
 535         cls.verbose = 0
 536         cls.vpp_dead = False
 537         cls.registry = VppObjectRegistry()
 538         cls.vpp_startup_failed = False
 539         cls.reporter = KeepAliveReporter()
 540         # need to catch exceptions here because if we raise, then the cleanup
 541         # doesn't get called and we might end with a zombie vpp
 542         try:
 543             cls.run_vpp()
 544             cls.reporter.send_keep_alive(cls, 'setUpClass')
 545             VppTestResult.current_test_case_info = TestCaseInfo(
 546                 cls.logger, cls.tempdir, cls.vpp.pid, cls.vpp_bin)
 547             cls.vpp_stdout_deque = deque()
 548             cls.vpp_stderr_deque = deque()
 549             cls.pump_thread_stop_flag = Event()
 550             cls.pump_thread_wakeup_pipe = os.pipe()
 551             cls.pump_thread = Thread(target=pump_output, args=(cls,))
 552             cls.pump_thread.daemon = True
 553             cls.pump_thread.start()
 554             if cls.debug_gdb or cls.debug_gdbserver:
 555                 cls.vapi_response_timeout = 0
 556             cls.vapi = VppPapiProvider(cls.shm_prefix, cls.shm_prefix, cls,
 557                                        cls.vapi_response_timeout)
 558             if cls.step:
 559                 hook = hookmodule.StepHook(cls)
 560             else:
 561                 hook = hookmodule.PollHook(cls)
 562             cls.vapi.register_hook(hook)
 563             cls.wait_for_stats_socket()
 564             cls.statistics = VPPStats(socketname=cls.stats_sock)
 565             try:
 566                 hook.poll_vpp()
 567             except VppDiedError:
 568                 cls.vpp_startup_failed = True
 569                 cls.logger.critical(
 570                     "VPP died shortly after startup, check the"
 571                     " output to standard error for possible cause")
 572                 raise
 573             try:
 574                 cls.vapi.connect()
 575             except vpp_papi.VPPIOError as e:
 576                 cls.logger.debug("Exception connecting to vapi: %s" % e)
 577                 cls.vapi.disconnect()
 578
 579                 if cls.debug_gdbserver:
 580                     print(colorize("You're running VPP inside gdbserver but "
 581                                    "VPP-API connection failed, did you forget "
 582                                    "to 'continue' VPP from within gdb?", RED))
 583                 raise
 584         except Exception as e:
 585             cls.logger.debug("Exception connecting to VPP: %s" % e)
 586
 587             cls.quit()
 588             raise
 589
 590     @classmethod
 591     def quit(cls):
 592         """
 593         Disconnect vpp-api, kill vpp and cleanup shared memory files
 594         """
 595         if (cls.debug_gdbserver or cls.debug_gdb) and hasattr(cls, 'vpp'):
 596             cls.vpp.poll()
 597             if cls.vpp.returncode is None:
 598                 print()
 599                 print(double_line_delim)
 600                 print("VPP or GDB server is still running")
 601                 print(single_line_delim)
 602                 input("When done debugging, press ENTER to kill the "
 603                       "process and finish running the testcase...")
 604
 605         # first signal that we want to stop the pump thread, then wake it up
 606         if hasattr(cls, 'pump_thread_stop_flag'):
 607             cls.pump_thread_stop_flag.set()
 608         if hasattr(cls, 'pump_thread_wakeup_pipe'):
 609             os.write(cls.pump_thread_wakeup_pipe[1], b'ding dong wake up')
 610         if hasattr(cls, 'pump_thread'):
 611             cls.logger.debug("Waiting for pump thread to stop")
 612             cls.pump_thread.join()
 613         if hasattr(cls, 'vpp_stderr_reader_thread'):
 614             cls.logger.debug("Waiting for stdderr pump to stop")
 615             cls.vpp_stderr_reader_thread.join()
 616
 617         if hasattr(cls, 'vpp'):
 618             if hasattr(cls, 'vapi'):
 619                 cls.logger.debug(cls.vapi.vpp.get_stats())
 620                 cls.logger.debug("Disconnecting class vapi client on %s",
 621                                  cls.__name__)
 622                 cls.vapi.disconnect()
 623                 cls.logger.debug("Deleting class vapi attribute on %s",
 624                                  cls.__name__)
 625                 del cls.vapi
 626             cls.vpp.poll()
 627             if cls.vpp.returncode is None:
 628                 cls.wait_for_coredump()
 629                 cls.logger.debug("Sending TERM to vpp")
 630                 cls.vpp.terminate()
 631                 cls.logger.debug("Waiting for vpp to die")
 632                 cls.vpp.communicate()
 633             cls.logger.debug("Deleting class vpp attribute on %s",
 634                              cls.__name__)
 635             del cls.vpp
 636
 637         if cls.vpp_startup_failed:
 638             stdout_log = cls.logger.info
 639             stderr_log = cls.logger.critical
 640         else:
 641             stdout_log = cls.logger.info
 642             stderr_log = cls.logger.info
 643
 644         if hasattr(cls, 'vpp_stdout_deque'):
 645             stdout_log(single_line_delim)
 646             stdout_log('VPP output to stdout while running %s:', cls.__name__)
 647             stdout_log(single_line_delim)
 648             vpp_output = "".join(cls.vpp_stdout_deque)
 649             with open(cls.tempdir + '/vpp_stdout.txt', 'w') as f:
 650                 f.write(vpp_output)
 651             stdout_log('\n%s', vpp_output)
 652             stdout_log(single_line_delim)
 653
 654         if hasattr(cls, 'vpp_stderr_deque'):
 655             stderr_log(single_line_delim)
 656             stderr_log('VPP output to stderr while running %s:', cls.__name__)
 657             stderr_log(single_line_delim)
 658             vpp_output = "".join(cls.vpp_stderr_deque)
 659             with open(cls.tempdir + '/vpp_stderr.txt', 'w') as f:
 660                 f.write(vpp_output)
 661             stderr_log('\n%s', vpp_output)
 662             stderr_log(single_line_delim)
 663
 664     @classmethod
 665     def tearDownClass(cls):
 666         """ Perform final cleanup after running all tests in this test-case """
 667         cls.logger.debug("--- tearDownClass() for %s called ---" %
 668                          cls.__name__)
 669         cls.reporter.send_keep_alive(cls, 'tearDownClass')
 670         cls.quit()
 671         cls.file_handler.close()
 672         cls.reset_packet_infos()
 673         if debug_framework:
 674             debug_internal.on_tear_down_class(cls)
 675
 676     def show_commands_at_teardown(self):
 677         """ Allow subclass specific teardown logging additions."""
 678         self.logger.info("--- No test specific show commands provided. ---")
 679
 680     def tearDown(self):
 681         """ Show various debug prints after each test """
 682         self.logger.debug("--- tearDown() for %s.%s(%s) called ---" %
 683                           (self.__class__.__name__, self._testMethodName,
 684                            self._testMethodDoc))
 685
 686         try:
 687             if not self.vpp_dead:
 688                 self.logger.debug(self.vapi.cli("show trace max 1000"))
 689                 self.logger.info(self.vapi.ppcli("show interface"))
 690                 self.logger.info(self.vapi.ppcli("show hardware"))
 691                 self.logger.info(self.statistics.set_errors_str())
 692                 self.logger.info(self.vapi.ppcli("show run"))
 693                 self.logger.info(self.vapi.ppcli("show log"))
 694                 self.logger.info(self.vapi.ppcli("show bihash"))
 695                 self.logger.info("Logging testcase specific show commands.")
 696                 self.show_commands_at_teardown()
 697                 self.registry.remove_vpp_config(self.logger)
 698             # Save/Dump VPP api trace log
 699             m = self._testMethodName
 700             api_trace = "vpp_api_trace.%s.%d.log" % (m, self.vpp.pid)
 701             tmp_api_trace = "/tmp/%s" % api_trace
 702             vpp_api_trace_log = "%s/%s" % (self.tempdir, api_trace)
 703             self.logger.info(self.vapi.ppcli("api trace save %s" % api_trace))
 704             self.logger.info("Moving %s to %s\n" % (tmp_api_trace,
 705                                                     vpp_api_trace_log))
 706             os.rename(tmp_api_trace, vpp_api_trace_log)
 707             self.logger.info(self.vapi.ppcli("api trace custom-dump %s" %
 708                                              vpp_api_trace_log))
 709         except VppTransportShmemIOError:
 710             self.logger.debug("VppTransportShmemIOError: Vpp dead. "
 711                               "Cannot log show commands.")
 712             self.vpp_dead = True
 713         else:
 714             self.registry.unregister_all(self.logger)
 715
 716     def setUp(self):
 717         """ Clear trace before running each test"""
 718         super(VppTestCase, self).setUp()
 719         self.reporter.send_keep_alive(self)
 720         if self.vpp_dead:
 721
 722             raise VppDiedError(rv=None, testcase=self.__class__.__name__,
 723                                method_name=self._testMethodName)
 724         self.sleep(.1, "during setUp")
 725         self.vpp_stdout_deque.append(
 726             "--- test setUp() for %s.%s(%s) starts here ---\n" %
 727             (self.__class__.__name__, self._testMethodName,
 728              self._testMethodDoc))
 729         self.vpp_stderr_deque.append(
 730             "--- test setUp() for %s.%s(%s) starts here ---\n" %
 731             (self.__class__.__name__, self._testMethodName,
 732              self._testMethodDoc))
 733         self.vapi.cli("clear trace")
 734         # store the test instance inside the test class - so that objects
 735         # holding the class can access instance methods (like assertEqual)
 736         type(self).test_instance = self
 737
 738     @classmethod
 739     def pg_enable_capture(cls, interfaces=None):
 740         """
 741         Enable capture on packet-generator interfaces
 742
 743         :param interfaces: iterable interface indexes (if None,
 744                            use self.pg_interfaces)
 745
 746         """
 747         if interfaces is None:
 748             interfaces = cls.pg_interfaces
 749         for i in interfaces:
 750             i.enable_capture()
 751
 752     @classmethod
 753     def register_capture(cls, cap_name):
 754         """ Register a capture in the testclass """
 755         # add to the list of captures with current timestamp
 756         cls._captures.append((time.time(), cap_name))
 757
 758     @classmethod
 759     def get_vpp_time(cls):
 760         return float(cls.vapi.cli('show clock').replace("Time now ", ""))
 761
 762     @classmethod
 763     def sleep_on_vpp_time(cls, sec):
 764         """ Sleep according to time in VPP world """
 765         # On a busy system with many processes
 766         # we might end up with VPP time being slower than real world
 767         # So take that into account when waiting for VPP to do something
 768         start_time = cls.get_vpp_time()
 769         while cls.get_vpp_time() - start_time < sec:
 770             cls.sleep(0.1)
 771
 772     @classmethod
 773     def pg_start(cls):
 774         """ Enable the PG, wait till it is done, then clean up """
 775         cls.vapi.cli("trace add pg-input 1000")
 776         cls.vapi.cli('packet-generator enable')
 777         # PG, when starts, runs to completion -
 778         # so let's avoid a race condition,
 779         # and wait a little till it's done.
 780         # Then clean it up  - and then be gone.
 781         deadline = time.time() + 300
 782         while cls.vapi.cli('show packet-generator').find("Yes") != -1:
 783             cls.sleep(0.01)  # yield
 784             if time.time() > deadline:
 785                 cls.logger.error("Timeout waiting for pg to stop")
 786                 break
 787         for stamp, cap_name in cls._captures:
 788             cls.vapi.cli('packet-generator delete %s' % cap_name)
 789         cls._captures = []
 790
 791     @classmethod
 792     def create_pg_interfaces(cls, interfaces, gso=0, gso_size=0):
 793         """
 794         Create packet-generator interfaces.
 795
 796         :param interfaces: iterable indexes of the interfaces.
 797         :returns: List of created interfaces.
 798
 799         """
 800         result = []
 801         for i in interfaces:
 802             intf = VppPGInterface(cls, i, gso, gso_size)
 803             setattr(cls, intf.name, intf)
 804             result.append(intf)
 805         cls.pg_interfaces = result
 806         return result
 807
 808     @classmethod
 809     def create_loopback_interfaces(cls, count):
 810         """
 811         Create loopback interfaces.
 812
 813         :param count: number of interfaces created.
 814         :returns: List of created interfaces.
 815         """
 816         result = [VppLoInterface(cls) for i in range(count)]
 817         for intf in result:
 818             setattr(cls, intf.name, intf)
 819         cls.lo_interfaces = result
 820         return result
 821
 822     @classmethod
 823     def create_bvi_interfaces(cls, count):
 824         """
 825         Create BVI interfaces.
 826
 827         :param count: number of interfaces created.
 828         :returns: List of created interfaces.
 829         """
 830         result = [VppBviInterface(cls) for i in range(count)]
 831         for intf in result:
 832             setattr(cls, intf.name, intf)
 833         cls.bvi_interfaces = result
 834         return result
 835
 836     @staticmethod
 837     def extend_packet(packet, size, padding=' '):
 838         """
 839         Extend packet to given size by padding with spaces or custom padding
 840         NOTE: Currently works only when Raw layer is present.
 841
 842         :param packet: packet
 843         :param size: target size
 844         :param padding: padding used to extend the payload
 845
 846         """
 847         packet_len = len(packet) + 4
 848         extend = size - packet_len
 849         if extend > 0:
 850             num = (extend // len(padding)) + 1
 851             packet[Raw].load += (padding * num)[:extend].encode("ascii")
 852
 853     @classmethod
 854     def reset_packet_infos(cls):
 855         """ Reset the list of packet info objects and packet counts to zero """
 856         cls._packet_infos = {}
 857         cls._packet_count_for_dst_if_idx = {}
 858
 859     @classmethod
 860     def create_packet_info(cls, src_if, dst_if):
 861         """
 862         Create packet info object containing the source and destination indexes
 863         and add it to the testcase's packet info list
 864
 865         :param VppInterface src_if: source interface
 866         :param VppInterface dst_if: destination interface
 867
 868         :returns: _PacketInfo object
 869
 870         """
 871         info = _PacketInfo()
 872         info.index = len(cls._packet_infos)
 873         info.src = src_if.sw_if_index
 874         info.dst = dst_if.sw_if_index
 875         if isinstance(dst_if, VppSubInterface):
 876             dst_idx = dst_if.parent.sw_if_index
 877         else:
 878             dst_idx = dst_if.sw_if_index
 879         if dst_idx in cls._packet_count_for_dst_if_idx:
 880             cls._packet_count_for_dst_if_idx[dst_idx] += 1
 881         else:
 882             cls._packet_count_for_dst_if_idx[dst_idx] = 1
 883         cls._packet_infos[info.index] = info
 884         return info
 885
 886     @staticmethod
 887     def info_to_payload(info):
 888         """
 889         Convert _PacketInfo object to packet payload
 890
 891         :param info: _PacketInfo object
 892
 893         :returns: string containing serialized data from packet info
 894         """
 895         return "%d %d %d %d %d" % (info.index, info.src, info.dst,
 896                                    info.ip, info.proto)
 897
 898     @staticmethod
 899     def payload_to_info(payload, payload_field='load'):
 900         """
 901         Convert packet payload to _PacketInfo object
 902
 903         :param payload: packet payload
 904         :type payload:  <class 'scapy.packet.Raw'>
 905         :param payload_field: packet fieldname of payload "load" for
 906                 <class 'scapy.packet.Raw'>
 907         :type payload_field: str
 908         :returns: _PacketInfo object containing de-serialized data from payload
 909
 910         """
 911         numbers = getattr(payload, payload_field).split()
 912         info = _PacketInfo()
 913         info.index = int(numbers[0])
 914         info.src = int(numbers[1])
 915         info.dst = int(numbers[2])
 916         info.ip = int(numbers[3])
 917         info.proto = int(numbers[4])
 918         return info
 919
 920     def get_next_packet_info(self, info):
 921         """
 922         Iterate over the packet info list stored in the testcase
 923         Start iteration with first element if info is None
 924         Continue based on index in info if info is specified
 925
 926         :param info: info or None
 927         :returns: next info in list or None if no more infos
 928         """
 929         if info is None:
 930             next_index = 0
 931         else:
 932             next_index = info.index + 1
 933         if next_index == len(self._packet_infos):
 934             return None
 935         else:
 936             return self._packet_infos[next_index]
 937
 938     def get_next_packet_info_for_interface(self, src_index, info):
 939         """
 940         Search the packet info list for the next packet info with same source
 941         interface index
 942
 943         :param src_index: source interface index to search for
 944         :param info: packet info - where to start the search
 945         :returns: packet info or None
 946
 947         """
 948         while True:
 949             info = self.get_next_packet_info(info)
 950             if info is None:
 951                 return None
 952             if info.src == src_index:
 953                 return info
 954
 955     def get_next_packet_info_for_interface2(self, src_index, dst_index, info):
 956         """
 957         Search the packet info list for the next packet info with same source
 958         and destination interface indexes
 959
 960         :param src_index: source interface index to search for
 961         :param dst_index: destination interface index to search for
 962         :param info: packet info - where to start the search
 963         :returns: packet info or None
 964
 965         """
 966         while True:
 967             info = self.get_next_packet_info_for_interface(src_index, info)
 968             if info is None:
 969                 return None
 970             if info.dst == dst_index:
 971                 return info
 972
 973     def assert_equal(self, real_value, expected_value, name_or_class=None):
 974         if name_or_class is None:
 975             self.assertEqual(real_value, expected_value)
 976             return
 977         try:
 978             msg = "Invalid %s: %d('%s') does not match expected value %d('%s')"
 979             msg = msg % (getdoc(name_or_class).strip(),
 980                          real_value, str(name_or_class(real_value)),
 981                          expected_value, str(name_or_class(expected_value)))
 982         except Exception:
 983             msg = "Invalid %s: %s does not match expected value %s" % (
 984                 name_or_class, real_value, expected_value)
 985
 986         self.assertEqual(real_value, expected_value, msg)
 987
 988     def assert_in_range(self,
 989                         real_value,
 990                         expected_min,
 991                         expected_max,
 992                         name=None):
 993         if name is None:
 994             msg = None
 995         else:
 996             msg = "Invalid %s: %s out of range <%s,%s>" % (
 997                 name, real_value, expected_min, expected_max)
 998         self.assertTrue(expected_min <= real_value <= expected_max, msg)
 999
1000     def assert_packet_checksums_valid(self, packet,
1001                                       ignore_zero_udp_checksums=True):
1002         received = packet.__class__(scapy.compat.raw(packet))
1003         udp_layers = ['UDP', 'UDPerror']
1004         checksum_fields = ['cksum', 'chksum']
1005         checksums = []
1006         counter = 0
1007         temp = received.__class__(scapy.compat.raw(received))
1008         while True:
1009             layer = temp.getlayer(counter)
1010             if layer:
1011                 for cf in checksum_fields:
1012                     if hasattr(layer, cf):
1013                         if ignore_zero_udp_checksums and \
1014                                 0 == getattr(layer, cf) and \
1015                                 layer.name in udp_layers:
1016                             continue
1017                         delattr(layer, cf)
1018                         checksums.append((counter, cf))
1019             else:
1020                 break
1021             counter = counter + 1
1022         if 0 == len(checksums):
1023             return
1024         temp = temp.__class__(scapy.compat.raw(temp))
1025         for layer, cf in checksums:
1026             calc_sum = getattr(temp[layer], cf)
1027             self.assert_equal(
1028                 getattr(received[layer], cf), calc_sum,
1029                 "packet checksum on layer #%d: %s" % (layer, temp[layer].name))
1030             self.logger.debug(
1031                 "Checksum field `%s` on `%s` layer has correct value `%s`" %
1032                 (cf, temp[layer].name, calc_sum))
1033
1034     def assert_checksum_valid(self, received_packet, layer,
1035                               field_name='chksum',
1036                               ignore_zero_checksum=False):
1037         """ Check checksum of received packet on given layer """
1038         received_packet_checksum = getattr(received_packet[layer], field_name)
1039         if ignore_zero_checksum and 0 == received_packet_checksum:
1040             return
1041         recalculated = received_packet.__class__(
1042             scapy.compat.raw(received_packet))
1043         delattr(recalculated[layer], field_name)
1044         recalculated = recalculated.__class__(scapy.compat.raw(recalculated))
1045         self.assert_equal(received_packet_checksum,
1046                           getattr(recalculated[layer], field_name),
1047                           "packet checksum on layer: %s" % layer)
1048
1049     def assert_ip_checksum_valid(self, received_packet,
1050                                  ignore_zero_checksum=False):
1051         self.assert_checksum_valid(received_packet, 'IP',
1052                                    ignore_zero_checksum=ignore_zero_checksum)
1053
1054     def assert_tcp_checksum_valid(self, received_packet,
1055                                   ignore_zero_checksum=False):
1056         self.assert_checksum_valid(received_packet, 'TCP',
1057                                    ignore_zero_checksum=ignore_zero_checksum)
1058
1059     def assert_udp_checksum_valid(self, received_packet,
1060                                   ignore_zero_checksum=True):
1061         self.assert_checksum_valid(received_packet, 'UDP',
1062                                    ignore_zero_checksum=ignore_zero_checksum)
1063
1064     def assert_embedded_icmp_checksum_valid(self, received_packet):
1065         if received_packet.haslayer(IPerror):
1066             self.assert_checksum_valid(received_packet, 'IPerror')
1067         if received_packet.haslayer(TCPerror):
1068             self.assert_checksum_valid(received_packet, 'TCPerror')
1069         if received_packet.haslayer(UDPerror):
1070             self.assert_checksum_valid(received_packet, 'UDPerror',
1071                                        ignore_zero_checksum=True)
1072         if received_packet.haslayer(ICMPerror):
1073             self.assert_checksum_valid(received_packet, 'ICMPerror')
1074
1075     def assert_icmp_checksum_valid(self, received_packet):
1076         self.assert_checksum_valid(received_packet, 'ICMP')
1077         self.assert_embedded_icmp_checksum_valid(received_packet)
1078
1079     def assert_icmpv6_checksum_valid(self, pkt):
1080         if pkt.haslayer(ICMPv6DestUnreach):
1081             self.assert_checksum_valid(pkt, 'ICMPv6DestUnreach', 'cksum')
1082             self.assert_embedded_icmp_checksum_valid(pkt)
1083         if pkt.haslayer(ICMPv6EchoRequest):
1084             self.assert_checksum_valid(pkt, 'ICMPv6EchoRequest', 'cksum')
1085         if pkt.haslayer(ICMPv6EchoReply):
1086             self.assert_checksum_valid(pkt, 'ICMPv6EchoReply', 'cksum')
1087
1088     def get_packet_counter(self, counter):
1089         if counter.startswith("/"):
1090             counter_value = self.statistics.get_counter(counter)
1091         else:
1092             counters = self.vapi.cli("sh errors").split('\n')
1093             counter_value = 0
1094             for i in range(1, len(counters) - 1):
1095                 results = counters[i].split()
1096                 if results[1] == counter:
1097                     counter_value = int(results[0])
1098                     break
1099         return counter_value
1100
1101     def assert_packet_counter_equal(self, counter, expected_value):
1102         counter_value = self.get_packet_counter(counter)
1103         self.assert_equal(counter_value, expected_value,
1104                           "packet counter `%s'" % counter)
1105
1106     def assert_error_counter_equal(self, counter, expected_value):
1107         counter_value = self.statistics.get_err_counter(counter)
1108         self.assert_equal(counter_value, expected_value,
1109                           "error counter `%s'" % counter)
1110
1111     @classmethod
1112     def sleep(cls, timeout, remark=None):
1113
1114         # /* Allow sleep(0) to maintain win32 semantics, and as decreed
1115         #  * by Guido, only the main thread can be interrupted.
1116         # */
1117         # https://github.com/python/cpython/blob/6673decfa0fb078f60587f5cb5e98460eea137c2/Modules/timemodule.c#L1892  # noqa
1118         if timeout == 0:
1119             # yield quantum
1120             if hasattr(os, 'sched_yield'):
1121                 os.sched_yield()
1122             else:
1123                 time.sleep(0)
1124             return
1125
1126         if hasattr(cls, 'logger'):
1127             cls.logger.debug("Starting sleep for %es (%s)", timeout, remark)
1128         before = time.time()
1129         time.sleep(timeout)
1130         after = time.time()
1131         if hasattr(cls, 'logger') and after - before > 2 * timeout:
1132             cls.logger.error("unexpected self.sleep() result - "
1133                              "slept for %es instead of ~%es!",
1134                              after - before, timeout)
1135         if hasattr(cls, 'logger'):
1136             cls.logger.debug(
1137                 "Finished sleep (%s) - slept %es (wanted %es)",
1138                 remark, after - before, timeout)
1139
1140     def pg_send(self, intf, pkts):
1141         self.vapi.cli("clear trace")
1142         intf.add_stream(pkts)
1143         self.pg_enable_capture(self.pg_interfaces)
1144         self.pg_start()
1145
1146     def send_and_assert_no_replies(self, intf, pkts, remark="", timeout=None):
1147         self.pg_send(intf, pkts)
1148         if not timeout:
1149             timeout = 1
1150         for i in self.pg_interfaces:
1151             i.get_capture(0, timeout=timeout)
1152             i.assert_nothing_captured(remark=remark)
1153             timeout = 0.1
1154
1155     def send_and_expect(self, intf, pkts, output, n_rx=None):
1156         if not n_rx:
1157             n_rx = len(pkts)
1158         self.pg_send(intf, pkts)
1159         rx = output.get_capture(n_rx)
1160         return rx
1161
1162     def send_and_expect_only(self, intf, pkts, output, timeout=None):
1163         self.pg_send(intf, pkts)
1164         rx = output.get_capture(len(pkts))
1165         outputs = [output]
1166         if not timeout:
1167             timeout = 1
1168         for i in self.pg_interfaces:
1169             if i not in outputs:
1170                 i.get_capture(0, timeout=timeout)
1171                 i.assert_nothing_captured()
1172                 timeout = 0.1
1173
1174         return rx
1175
1176
1177 def get_testcase_doc_name(test):
1178     return getdoc(test.__class__).splitlines()[0]
1179
1180
1181 def get_test_description(descriptions, test):
1182     short_description = test.shortDescription()
1183     if descriptions and short_description:
1184         return short_description
1185     else:
1186         return str(test)
1187
1188
1189 class TestCaseInfo(object):
1190     def __init__(self, logger, tempdir, vpp_pid, vpp_bin_path):
1191         self.logger = logger
1192         self.tempdir = tempdir
1193         self.vpp_pid = vpp_pid
1194         self.vpp_bin_path = vpp_bin_path
1195         self.core_crash_test = None
1196
1197
1198 class VppTestResult(unittest.TestResult):
1199     """
1200     @property result_string
1201      String variable to store the test case result string.
1202     @property errors
1203      List variable containing 2-tuples of TestCase instances and strings
1204      holding formatted tracebacks. Each tuple represents a test which
1205      raised an unexpected exception.
1206     @property failures
1207      List variable containing 2-tuples of TestCase instances and strings
1208      holding formatted tracebacks. Each tuple represents a test where
1209      a failure was explicitly signalled using the TestCase.assert*()
1210      methods.
1211     """
1212
1213     failed_test_cases_info = set()
1214     core_crash_test_cases_info = set()
1215     current_test_case_info = None
1216
1217     def __init__(self, stream=None, descriptions=None, verbosity=None,
1218                  runner=None):
1219         """
1220         :param stream File descriptor to store where to report test results.
1221             Set to the standard error stream by default.
1222         :param descriptions Boolean variable to store information if to use
1223             test case descriptions.
1224         :param verbosity Integer variable to store required verbosity level.
1225         """
1226         super(VppTestResult, self).__init__(stream, descriptions, verbosity)
1227         self.stream = stream
1228         self.descriptions = descriptions
1229         self.verbosity = verbosity
1230         self.result_string = None
1231         self.runner = runner
1232
1233     def addSuccess(self, test):
1234         """
1235         Record a test succeeded result
1236
1237         :param test:
1238
1239         """
1240         if self.current_test_case_info:
1241             self.current_test_case_info.logger.debug(
1242                 "--- addSuccess() %s.%s(%s) called" % (test.__class__.__name__,
1243                                                        test._testMethodName,
1244                                                        test._testMethodDoc))
1245         unittest.TestResult.addSuccess(self, test)
1246         self.result_string = colorize("OK", GREEN)
1247
1248         self.send_result_through_pipe(test, PASS)
1249
1250     def addSkip(self, test, reason):
1251         """
1252         Record a test skipped.
1253
1254         :param test:
1255         :param reason:
1256
1257         """
1258         if self.current_test_case_info:
1259             self.current_test_case_info.logger.debug(
1260                 "--- addSkip() %s.%s(%s) called, reason is %s" %
1261                 (test.__class__.__name__, test._testMethodName,
1262                  test._testMethodDoc, reason))
1263         unittest.TestResult.addSkip(self, test, reason)
1264         self.result_string = colorize("SKIP", YELLOW)
1265
1266         self.send_result_through_pipe(test, SKIP)
1267
1268     def symlink_failed(self):
1269         if self.current_test_case_info:
1270             try:
1271                 failed_dir = os.getenv('FAILED_DIR')
1272                 link_path = os.path.join(
1273                     failed_dir,
1274                     '%s-FAILED' %
1275                     os.path.basename(self.current_test_case_info.tempdir))
1276                 if self.current_test_case_info.logger:
1277                     self.current_test_case_info.logger.debug(
1278                         "creating a link to the failed test")
1279                     self.current_test_case_info.logger.debug(
1280                         "os.symlink(%s, %s)" %
1281                         (self.current_test_case_info.tempdir, link_path))
1282                 if os.path.exists(link_path):
1283                     if self.current_test_case_info.logger:
1284                         self.current_test_case_info.logger.debug(
1285                             'symlink already exists')
1286                 else:
1287                     os.symlink(self.current_test_case_info.tempdir, link_path)
1288
1289             except Exception as e:
1290                 if self.current_test_case_info.logger:
1291                     self.current_test_case_info.logger.error(e)
1292
1293     def send_result_through_pipe(self, test, result):
1294         if hasattr(self, 'test_framework_result_pipe'):
1295             pipe = self.test_framework_result_pipe
1296             if pipe:
1297                 pipe.send((test.id(), result))
1298
1299     def log_error(self, test, err, fn_name):
1300         if self.current_test_case_info:
1301             if isinstance(test, unittest.suite._ErrorHolder):
1302                 test_name = test.description
1303             else:
1304                 test_name = '%s.%s(%s)' % (test.__class__.__name__,
1305                                            test._testMethodName,
1306                                            test._testMethodDoc)
1307             self.current_test_case_info.logger.debug(
1308                 "--- %s() %s called, err is %s" %
1309                 (fn_name, test_name, err))
1310             self.current_test_case_info.logger.debug(
1311                 "formatted exception is:\n%s" %
1312                 "".join(format_exception(*err)))
1313
1314     def add_error(self, test, err, unittest_fn, error_type):
1315         if error_type == FAIL:
1316             self.log_error(test, err, 'addFailure')
1317             error_type_str = colorize("FAIL", RED)
1318         elif error_type == ERROR:
1319             self.log_error(test, err, 'addError')
1320             error_type_str = colorize("ERROR", RED)
1321         else:
1322             raise Exception('Error type %s cannot be used to record an '
1323                             'error or a failure' % error_type)
1324
1325         unittest_fn(self, test, err)
1326         if self.current_test_case_info:
1327             self.result_string = "%s [ temp dir used by test case: %s ]" % \
1328                                  (error_type_str,
1329                                   self.current_test_case_info.tempdir)
1330             self.symlink_failed()
1331             self.failed_test_cases_info.add(self.current_test_case_info)
1332             if is_core_present(self.current_test_case_info.tempdir):
1333                 if not self.current_test_case_info.core_crash_test:
1334                     if isinstance(test, unittest.suite._ErrorHolder):
1335                         test_name = str(test)
1336                     else:
1337                         test_name = "'{!s}' ({!s})".format(
1338                             get_testcase_doc_name(test), test.id())
1339                     self.current_test_case_info.core_crash_test = test_name
1340                 self.core_crash_test_cases_info.add(
1341                     self.current_test_case_info)
1342         else:
1343             self.result_string = '%s [no temp dir]' % error_type_str
1344
1345         self.send_result_through_pipe(test, error_type)
1346
1347     def addFailure(self, test, err):
1348         """
1349         Record a test failed result
1350
1351         :param test:
1352         :param err: error message
1353
1354         """
1355         self.add_error(test, err, unittest.TestResult.addFailure, FAIL)
1356
1357     def addError(self, test, err):
1358         """
1359         Record a test error result
1360
1361         :param test:
1362         :param err: error message
1363
1364         """
1365         self.add_error(test, err, unittest.TestResult.addError, ERROR)
1366
1367     def getDescription(self, test):
1368         """
1369         Get test description
1370
1371         :param test:
1372         :returns: test description
1373
1374         """
1375         return get_test_description(self.descriptions, test)
1376
1377     def startTest(self, test):
1378         """
1379         Start a test
1380
1381         :param test:
1382
1383         """
1384
1385         def print_header(test):
1386             if not hasattr(test.__class__, '_header_printed'):
1387                 print(double_line_delim)
1388                 print(colorize(getdoc(test).splitlines()[0], GREEN))
1389                 print(double_line_delim)
1390             test.__class__._header_printed = True
1391
1392         print_header(test)
1393         self.start_test = time.time()
1394         unittest.TestResult.startTest(self, test)
1395         if self.verbosity > 0:
1396             self.stream.writeln(
1397                 "Starting " + self.getDescription(test) + " ...")
1398             self.stream.writeln(single_line_delim)
1399
1400     def stopTest(self, test):
1401         """
1402         Called when the given test has been run
1403
1404         :param test:
1405
1406         """
1407         unittest.TestResult.stopTest(self, test)
1408
1409         if self.verbosity > 0:
1410             self.stream.writeln(single_line_delim)
1411             self.stream.writeln("%-73s%s" % (self.getDescription(test),
1412                                              self.result_string))
1413             self.stream.writeln(single_line_delim)
1414         else:
1415             self.stream.writeln("%-68s %4.2f %s" %
1416                                 (self.getDescription(test),
1417                                  time.time() - self.start_test,
1418                                  self.result_string))
1419
1420         self.send_result_through_pipe(test, TEST_RUN)
1421
1422     def printErrors(self):
1423         """
1424         Print errors from running the test case
1425         """
1426         if len(self.errors) > 0 or len(self.failures) > 0:
1427             self.stream.writeln()
1428             self.printErrorList('ERROR', self.errors)
1429             self.printErrorList('FAIL', self.failures)
1430
1431         # ^^ that is the last output from unittest before summary
1432         if not self.runner.print_summary:
1433             devnull = unittest.runner._WritelnDecorator(open(os.devnull, 'w'))
1434             self.stream = devnull
1435             self.runner.stream = devnull
1436
1437     def printErrorList(self, flavour, errors):
1438         """
1439         Print error list to the output stream together with error type
1440         and test case description.
1441
1442         :param flavour: error type
1443         :param errors: iterable errors
1444
1445         """
1446         for test, err in errors:
1447             self.stream.writeln(double_line_delim)
1448             self.stream.writeln("%s: %s" %
1449                                 (flavour, self.getDescription(test)))
1450             self.stream.writeln(single_line_delim)
1451             self.stream.writeln("%s" % err)
1452
1453
1454 class VppTestRunner(unittest.TextTestRunner):
1455     """
1456     A basic test runner implementation which prints results to standard error.
1457     """
1458
1459     @property
1460     def resultclass(self):
1461         """Class maintaining the results of the tests"""
1462         return VppTestResult
1463
1464     def __init__(self, keep_alive_pipe=None, descriptions=True, verbosity=1,
1465                  result_pipe=None, failfast=False, buffer=False,
1466                  resultclass=None, print_summary=True, **kwargs):
1467         # ignore stream setting here, use hard-coded stdout to be in sync
1468         # with prints from VppTestCase methods ...
1469         super(VppTestRunner, self).__init__(sys.stdout, descriptions,
1470                                             verbosity, failfast, buffer,
1471                                             resultclass, **kwargs)
1472         KeepAliveReporter.pipe = keep_alive_pipe
1473
1474         self.orig_stream = self.stream
1475         self.resultclass.test_framework_result_pipe = result_pipe
1476
1477         self.print_summary = print_summary
1478
1479     def _makeResult(self):
1480         return self.resultclass(self.stream,
1481                                 self.descriptions,
1482                                 self.verbosity,
1483                                 self)
1484
1485     def run(self, test):
1486         """
1487         Run the tests
1488
1489         :param test:
1490
1491         """
1492         faulthandler.enable()  # emit stack trace to stderr if killed by signal
1493
1494         result = super(VppTestRunner, self).run(test)
1495         if not self.print_summary:
1496             self.stream = self.orig_stream
1497             result.stream = self.orig_stream
1498         return result
1499
1500
1501 class Worker(Thread):
1502     def __init__(self, args, logger, env=None):
1503         self.logger = logger
1504         self.args = args
1505         if hasattr(self, 'testcase') and self.testcase.debug_all:
1506             if self.testcase.debug_gdbserver:
1507                 self.args = ['/usr/bin/gdbserver', 'localhost:{port}'
1508                              .format(port=self.testcase.gdbserver_port)] + args
1509             elif self.testcase.debug_gdb and hasattr(self, 'wait_for_gdb'):
1510                 self.args.append(self.wait_for_gdb)
1511         self.app_bin = args[0]
1512         self.app_name = os.path.basename(self.app_bin)
1513         if hasattr(self, 'role'):
1514             self.app_name += ' {role}'.format(role=self.role)
1515         self.process = None
1516         self.result = None
1517         env = {} if env is None else env
1518         self.env = copy.deepcopy(env)
1519         super(Worker, self).__init__()
1520
1521     def wait_for_enter(self):
1522         if not hasattr(self, 'testcase'):
1523             return
1524         if self.testcase.debug_all and self.testcase.debug_gdbserver:
1525             print()
1526             print(double_line_delim)
1527             print("Spawned GDB Server for '{app}' with PID: {pid}"
1528                   .format(app=self.app_name, pid=self.process.pid))
1529         elif self.testcase.debug_all and self.testcase.debug_gdb:
1530             print()
1531             print(double_line_delim)
1532             print("Spawned '{app}' with PID: {pid}"
1533                   .format(app=self.app_name, pid=self.process.pid))
1534         else:
1535             return
1536         print(single_line_delim)
1537         print("You can debug '{app}' using:".format(app=self.app_name))
1538         if self.testcase.debug_gdbserver:
1539             print("sudo gdb " + self.app_bin +
1540                   " -ex 'target remote localhost:{port}'"
1541                   .format(port=self.testcase.gdbserver_port))
1542             print("Now is the time to attach gdb by running the above "
1543                   "command, set up breakpoints etc., then resume from "
1544                   "within gdb by issuing the 'continue' command")
1545             self.testcase.gdbserver_port += 1
1546         elif self.testcase.debug_gdb:
1547             print("sudo gdb " + self.app_bin +
1548                   " -ex 'attach {pid}'".format(pid=self.process.pid))
1549             print("Now is the time to attach gdb by running the above "
1550                   "command and set up breakpoints etc., then resume from"
1551                   " within gdb by issuing the 'continue' command")
1552         print(single_line_delim)
1553         input("Press ENTER to continue running the testcase...")
1554
1555     def run(self):
1556         executable = self.args[0]
1557         if not os.path.exists(executable) or not os.access(
1558                 executable, os.F_OK | os.X_OK):
1559             # Exit code that means some system file did not exist,
1560             # could not be opened, or had some other kind of error.
1561             self.result = os.EX_OSFILE
1562             raise EnvironmentError(
1563                 "executable '%s' is not found or executable." % executable)
1564         self.logger.debug("Running executable: '{app}'"
1565                           .format(app=' '.join(self.args)))
1566         env = os.environ.copy()
1567         env.update(self.env)
1568         env["CK_LOG_FILE_NAME"] = "-"
1569         self.process = subprocess.Popen(
1570             self.args, shell=False, env=env, preexec_fn=os.setpgrp,
1571             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1572         self.wait_for_enter()
1573         out, err = self.process.communicate()
1574         self.logger.debug("Finished running `{app}'".format(app=self.app_name))
1575         self.logger.info("Return code is `%s'" % self.process.returncode)
1576         self.logger.info(single_line_delim)
1577         self.logger.info("Executable `{app}' wrote to stdout:"
1578                          .format(app=self.app_name))
1579         self.logger.info(single_line_delim)
1580         self.logger.info(out.decode('utf-8'))
1581         self.logger.info(single_line_delim)
1582         self.logger.info("Executable `{app}' wrote to stderr:"
1583                          .format(app=self.app_name))
1584         self.logger.info(single_line_delim)
1585         self.logger.info(err.decode('utf-8'))
1586         self.logger.info(single_line_delim)
1587         self.result = self.process.returncode
1588
1589
1590 if __name__ == '__main__':
1591     pass