Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1 | #!/usr/bin/env python |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 2 | |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 3 | from __future__ import print_function |
| 4 | import gc |
Paul Vinciguerra | 72f0004 | 2018-11-25 11:05:13 -0800 | [diff] [blame] | 5 | import sys |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 6 | import os |
| 7 | import select |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 8 | import signal |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 9 | import unittest |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 10 | import tempfile |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 11 | import time |
Paul Vinciguerra | 72f0004 | 2018-11-25 11:05:13 -0800 | [diff] [blame] | 12 | import faulthandler |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 13 | import random |
| 14 | import copy |
Paul Vinciguerra | 72f0004 | 2018-11-25 11:05:13 -0800 | [diff] [blame] | 15 | import psutil |
juraj.linkes | 68ebc83 | 2018-11-29 09:37:08 +0100 | [diff] [blame] | 16 | import platform |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 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 |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 22 | |
| 23 | import scapy.compat |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 24 | from scapy.packet import Raw |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 25 | import hook as hookmodule |
Paul Vinciguerra | 919efad | 2018-12-17 21:43:43 -0800 | [diff] [blame] | 26 | from vpp_pg_interface import VppPGInterface |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 27 | from vpp_sub_interface import VppSubInterface |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 28 | from vpp_lo_interface import VppLoInterface |
Neale Ranns | 192b13f | 2019-03-15 02:16:20 -0700 | [diff] [blame] | 29 | from vpp_bvi_interface import VppBviInterface |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 30 | from vpp_papi_provider import VppPapiProvider |
| 31 | from vpp_papi.vpp_stats import VPPStats |
Paul Vinciguerra | 499ea64 | 2019-03-15 09:39:19 -0700 | [diff] [blame] | 32 | from vpp_papi.vpp_transport_shmem import VppTransportShmemIOError |
Ole Trøan | 162989e | 2018-11-26 10:27:50 +0000 | [diff] [blame] | 33 | from log import RED, GREEN, YELLOW, double_line_delim, single_line_delim, \ |
| 34 | get_logger, colorize |
| 35 | from vpp_object import VppObjectRegistry |
| 36 | from util import ppp, is_core_present |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 37 | from scapy.layers.inet import IPerror, TCPerror, UDPerror, ICMPerror |
| 38 | from scapy.layers.inet6 import ICMPv6DestUnreach, ICMPv6EchoRequest |
| 39 | from scapy.layers.inet6 import ICMPv6EchoReply |
Paul Vinciguerra | 6919b0d | 2018-12-09 15:37:04 -0800 | [diff] [blame] | 40 | |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 41 | if os.name == 'posix' and sys.version_info[0] < 3: |
| 42 | # using subprocess32 is recommended by python official documentation |
| 43 | # @ https://docs.python.org/2/library/subprocess.html |
| 44 | import subprocess32 as subprocess |
| 45 | else: |
| 46 | import subprocess |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 47 | |
Paul Vinciguerra | 852f5ef | 2018-12-15 10:16:35 -0800 | [diff] [blame] | 48 | # Python2/3 compatible |
| 49 | try: |
| 50 | input = raw_input |
| 51 | except NameError: |
| 52 | pass |
| 53 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 54 | PASS = 0 |
| 55 | FAIL = 1 |
| 56 | ERROR = 2 |
| 57 | SKIP = 3 |
| 58 | TEST_RUN = 4 |
| 59 | |
Paul Vinciguerra | 0cbc71d | 2019-07-03 08:38:38 -0400 | [diff] [blame] | 60 | |
| 61 | class BoolEnvironmentVariable(object): |
| 62 | |
| 63 | def __init__(self, env_var_name, default='n', true_values=None): |
| 64 | self.name = env_var_name |
| 65 | self.default = default |
| 66 | self.true_values = true_values if true_values is not None else \ |
| 67 | ("y", "yes", "1") |
| 68 | |
| 69 | def __bool__(self): |
| 70 | return os.getenv(self.name, self.default).lower() in self.true_values |
| 71 | |
| 72 | if sys.version_info[0] == 2: |
| 73 | __nonzero__ = __bool__ |
| 74 | |
| 75 | def __repr__(self): |
| 76 | return 'BoolEnvironmentVariable(%r, default=%r, true_values=%r)' % \ |
| 77 | (self.name, self.default, self.true_values) |
| 78 | |
| 79 | |
| 80 | debug_framework = BoolEnvironmentVariable('TEST_DEBUG') |
| 81 | if debug_framework: |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 82 | import debug_internal |
| 83 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 84 | """ |
| 85 | Test framework module. |
| 86 | |
| 87 | The module provides a set of tools for constructing and running tests and |
| 88 | representing the results. |
| 89 | """ |
| 90 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 91 | |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 92 | class VppDiedError(Exception): |
| 93 | """ exception for reporting that the subprocess has died.""" |
| 94 | |
| 95 | signals_by_value = {v: k for k, v in signal.__dict__.items() if |
| 96 | k.startswith('SIG') and not k.startswith('SIG_')} |
| 97 | |
Paul Vinciguerra | 5dd6a7b | 2019-06-19 10:29:24 -0400 | [diff] [blame] | 98 | def __init__(self, rv=None, testcase=None, method_name=None): |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 99 | self.rv = rv |
| 100 | self.signal_name = None |
Paul Vinciguerra | 5dd6a7b | 2019-06-19 10:29:24 -0400 | [diff] [blame] | 101 | self.testcase = testcase |
| 102 | self.method_name = method_name |
| 103 | |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 104 | try: |
| 105 | self.signal_name = VppDiedError.signals_by_value[-rv] |
Paul Vinciguerra | fea8260 | 2019-06-26 20:45:08 -0400 | [diff] [blame] | 106 | except (KeyError, TypeError): |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 107 | pass |
| 108 | |
Paul Vinciguerra | 5dd6a7b | 2019-06-19 10:29:24 -0400 | [diff] [blame] | 109 | if testcase is None and method_name is None: |
| 110 | in_msg = '' |
| 111 | else: |
| 112 | in_msg = 'running %s.%s ' % (testcase, method_name) |
| 113 | |
| 114 | msg = "VPP subprocess died %sunexpectedly with return code: %d%s." % ( |
| 115 | in_msg, |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 116 | self.rv, |
Paul Vinciguerra | f745752 | 2019-07-13 09:35:38 -0400 | [diff] [blame] | 117 | ' [%s]' % (self.signal_name if |
| 118 | self.signal_name is not None else '')) |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 119 | super(VppDiedError, self).__init__(msg) |
| 120 | |
| 121 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 122 | class _PacketInfo(object): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 123 | """Private class to create packet info object. |
| 124 | |
| 125 | Help process information about the next packet. |
| 126 | Set variables to default values. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 127 | """ |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 128 | #: Store the index of the packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 129 | index = -1 |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 130 | #: Store the index of the source packet generator interface of the packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 131 | src = -1 |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 132 | #: Store the index of the destination packet generator interface |
| 133 | #: of the packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 134 | dst = -1 |
Pavel Kotucek | 59dda06 | 2017-03-02 15:22:47 +0100 | [diff] [blame] | 135 | #: Store expected ip version |
| 136 | ip = -1 |
| 137 | #: Store expected upper protocol |
| 138 | proto = -1 |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 139 | #: Store the copy of the former packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 140 | data = None |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 141 | |
Matej Klotton | 16a14cd | 2016-12-07 15:09:13 +0100 | [diff] [blame] | 142 | def __eq__(self, other): |
| 143 | index = self.index == other.index |
| 144 | src = self.src == other.src |
| 145 | dst = self.dst == other.dst |
| 146 | data = self.data == other.data |
| 147 | return index and src and dst and data |
| 148 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 149 | |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 150 | def pump_output(testclass): |
| 151 | """ pump output from vpp stdout/stderr to proper queues """ |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 152 | stdout_fragment = "" |
| 153 | stderr_fragment = "" |
Neale Ranns | 1678236 | 2018-07-23 05:35:56 -0400 | [diff] [blame] | 154 | while not testclass.pump_thread_stop_flag.is_set(): |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 155 | readable = select.select([testclass.vpp.stdout.fileno(), |
| 156 | testclass.vpp.stderr.fileno(), |
| 157 | testclass.pump_thread_wakeup_pipe[0]], |
| 158 | [], [])[0] |
| 159 | if testclass.vpp.stdout.fileno() in readable: |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 160 | read = os.read(testclass.vpp.stdout.fileno(), 102400) |
| 161 | if len(read) > 0: |
Ole Troan | 45ec570 | 2019-10-17 01:53:47 +0200 | [diff] [blame] | 162 | split = read.decode('ascii', |
| 163 | errors='backslashreplace').splitlines(True) |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 164 | if len(stdout_fragment) > 0: |
| 165 | split[0] = "%s%s" % (stdout_fragment, split[0]) |
| 166 | if len(split) > 0 and split[-1].endswith("\n"): |
| 167 | limit = None |
| 168 | else: |
| 169 | limit = -1 |
| 170 | stdout_fragment = split[-1] |
| 171 | testclass.vpp_stdout_deque.extend(split[:limit]) |
| 172 | if not testclass.cache_vpp_output: |
| 173 | for line in split[:limit]: |
| 174 | testclass.logger.debug( |
| 175 | "VPP STDOUT: %s" % line.rstrip("\n")) |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 176 | if testclass.vpp.stderr.fileno() in readable: |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 177 | read = os.read(testclass.vpp.stderr.fileno(), 102400) |
| 178 | if len(read) > 0: |
Ole Troan | 6ed154f | 2019-10-15 19:31:55 +0200 | [diff] [blame] | 179 | split = read.decode('ascii', |
| 180 | errors='backslashreplace').splitlines(True) |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 181 | if len(stderr_fragment) > 0: |
| 182 | split[0] = "%s%s" % (stderr_fragment, split[0]) |
Ole Troan | 6ed154f | 2019-10-15 19:31:55 +0200 | [diff] [blame] | 183 | if len(split) > 0 and split[-1].endswith("\n"): |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 184 | limit = None |
| 185 | else: |
| 186 | limit = -1 |
| 187 | stderr_fragment = split[-1] |
Ole Troan | 6ed154f | 2019-10-15 19:31:55 +0200 | [diff] [blame] | 188 | |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 189 | testclass.vpp_stderr_deque.extend(split[:limit]) |
| 190 | if not testclass.cache_vpp_output: |
| 191 | for line in split[:limit]: |
| 192 | testclass.logger.debug( |
| 193 | "VPP STDERR: %s" % line.rstrip("\n")) |
Paul Vinciguerra | 6919b0d | 2018-12-09 15:37:04 -0800 | [diff] [blame] | 194 | # ignoring the dummy pipe here intentionally - the |
| 195 | # flag will take care of properly terminating the loop |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 196 | |
| 197 | |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 198 | def _is_skip_aarch64_set(): |
Paul Vinciguerra | 0cbc71d | 2019-07-03 08:38:38 -0400 | [diff] [blame] | 199 | return BoolEnvironmentVariable('SKIP_AARCH64') |
juraj.linkes | 68ebc83 | 2018-11-29 09:37:08 +0100 | [diff] [blame] | 200 | |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 201 | |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 202 | is_skip_aarch64_set = _is_skip_aarch64_set() |
juraj.linkes | 68ebc83 | 2018-11-29 09:37:08 +0100 | [diff] [blame] | 203 | |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 204 | |
| 205 | def _is_platform_aarch64(): |
juraj.linkes | 68ebc83 | 2018-11-29 09:37:08 +0100 | [diff] [blame] | 206 | return platform.machine() == 'aarch64' |
| 207 | |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 208 | |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 209 | is_platform_aarch64 = _is_platform_aarch64() |
juraj.linkes | 68ebc83 | 2018-11-29 09:37:08 +0100 | [diff] [blame] | 210 | |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 211 | |
| 212 | def _running_extended_tests(): |
Paul Vinciguerra | 0cbc71d | 2019-07-03 08:38:38 -0400 | [diff] [blame] | 213 | return BoolEnvironmentVariable("EXTENDED_TESTS") |
Klement Sekera | 8713493 | 2017-03-07 11:39:27 +0100 | [diff] [blame] | 214 | |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 215 | |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 216 | running_extended_tests = _running_extended_tests() |
Klement Sekera | 8713493 | 2017-03-07 11:39:27 +0100 | [diff] [blame] | 217 | |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 218 | |
| 219 | def _running_on_centos(): |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 220 | os_id = os.getenv("OS_ID", "") |
| 221 | return True if "centos" in os_id.lower() else False |
Klement Sekera | d3e671e | 2017-09-29 12:36:37 +0200 | [diff] [blame] | 222 | |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 223 | |
Klement Sekera | 3a35070 | 2019-09-02 14:26:26 +0000 | [diff] [blame] | 224 | running_on_centos = _running_on_centos() |
Paul Vinciguerra | defde0f | 2018-12-06 07:46:13 -0800 | [diff] [blame] | 225 | |
Klement Sekera | d3e671e | 2017-09-29 12:36:37 +0200 | [diff] [blame] | 226 | |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 227 | class KeepAliveReporter(object): |
| 228 | """ |
| 229 | Singleton object which reports test start to parent process |
| 230 | """ |
| 231 | _shared_state = {} |
| 232 | |
| 233 | def __init__(self): |
| 234 | self.__dict__ = self._shared_state |
Paul Vinciguerra | c7b03fe | 2018-11-18 08:17:34 -0800 | [diff] [blame] | 235 | self._pipe = None |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 236 | |
| 237 | @property |
| 238 | def pipe(self): |
| 239 | return self._pipe |
| 240 | |
| 241 | @pipe.setter |
| 242 | def pipe(self, pipe): |
Paul Vinciguerra | c7b03fe | 2018-11-18 08:17:34 -0800 | [diff] [blame] | 243 | if self._pipe is not None: |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 244 | raise Exception("Internal error - pipe should only be set once.") |
| 245 | self._pipe = pipe |
| 246 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 247 | def send_keep_alive(self, test, desc=None): |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 248 | """ |
| 249 | Write current test tmpdir & desc to keep-alive pipe to signal liveness |
| 250 | """ |
Klement Sekera | 3f6ff19 | 2017-08-11 06:56:05 +0200 | [diff] [blame] | 251 | if self.pipe is None: |
| 252 | # if not running forked.. |
| 253 | return |
| 254 | |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 255 | if isclass(test): |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 256 | desc = '%s (%s)' % (desc, unittest.util.strclass(test)) |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 257 | else: |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 258 | desc = test.id() |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 259 | |
Dave Wallace | e2efd12 | 2017-09-30 22:04:21 -0400 | [diff] [blame] | 260 | self.pipe.send((desc, test.vpp_bin, test.tempdir, test.vpp.pid)) |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 261 | |
| 262 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 263 | class VppTestCase(unittest.TestCase): |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 264 | """This subclass is a base class for VPP test cases that are implemented as |
| 265 | classes. It provides methods to create and run test case. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 266 | """ |
| 267 | |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 268 | extra_vpp_punt_config = [] |
| 269 | extra_vpp_plugin_config = [] |
Pavel Kotucek | e88865d | 2018-11-28 07:42:11 +0100 | [diff] [blame] | 270 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 271 | @property |
| 272 | def packet_infos(self): |
| 273 | """List of packet infos""" |
| 274 | return self._packet_infos |
| 275 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 276 | @classmethod |
| 277 | def get_packet_count_for_if_idx(cls, dst_if_index): |
| 278 | """Get the number of packet info for specified destination if index""" |
| 279 | if dst_if_index in cls._packet_count_for_dst_if_idx: |
| 280 | return cls._packet_count_for_dst_if_idx[dst_if_index] |
| 281 | else: |
| 282 | return 0 |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 283 | |
| 284 | @classmethod |
| 285 | def instance(cls): |
| 286 | """Return the instance of this testcase""" |
| 287 | return cls.test_instance |
| 288 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 289 | @classmethod |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 290 | def set_debug_flags(cls, d): |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 291 | cls.gdbserver_port = 7777 |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 292 | cls.debug_core = False |
| 293 | cls.debug_gdb = False |
| 294 | cls.debug_gdbserver = False |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 295 | cls.debug_all = False |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 296 | if d is None: |
| 297 | return |
| 298 | dl = d.lower() |
| 299 | if dl == "core": |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 300 | cls.debug_core = True |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 301 | elif dl == "gdb" or dl == "gdb-all": |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 302 | cls.debug_gdb = True |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 303 | elif dl == "gdbserver" or dl == "gdbserver-all": |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 304 | cls.debug_gdbserver = True |
| 305 | else: |
| 306 | raise Exception("Unrecognized DEBUG option: '%s'" % d) |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 307 | if dl == "gdb-all" or dl == "gdbserver-all": |
| 308 | cls.debug_all = True |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 309 | |
Paul Vinciguerra | 86ebba6 | 2018-11-21 09:28:32 -0800 | [diff] [blame] | 310 | @staticmethod |
| 311 | def get_least_used_cpu(): |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 312 | cpu_usage_list = [set(range(psutil.cpu_count()))] |
| 313 | vpp_processes = [p for p in psutil.process_iter(attrs=['pid', 'name']) |
| 314 | if 'vpp_main' == p.info['name']] |
| 315 | for vpp_process in vpp_processes: |
| 316 | for cpu_usage_set in cpu_usage_list: |
| 317 | try: |
| 318 | cpu_num = vpp_process.cpu_num() |
| 319 | if cpu_num in cpu_usage_set: |
| 320 | cpu_usage_set_index = cpu_usage_list.index( |
| 321 | cpu_usage_set) |
| 322 | if cpu_usage_set_index == len(cpu_usage_list) - 1: |
| 323 | cpu_usage_list.append({cpu_num}) |
| 324 | else: |
| 325 | cpu_usage_list[cpu_usage_set_index + 1].add( |
| 326 | cpu_num) |
| 327 | cpu_usage_set.remove(cpu_num) |
| 328 | break |
| 329 | except psutil.NoSuchProcess: |
| 330 | pass |
| 331 | |
| 332 | for cpu_usage_set in cpu_usage_list: |
| 333 | if len(cpu_usage_set) > 0: |
| 334 | min_usage_set = cpu_usage_set |
| 335 | break |
| 336 | |
| 337 | return random.choice(tuple(min_usage_set)) |
| 338 | |
Paul Vinciguerra | 86ebba6 | 2018-11-21 09:28:32 -0800 | [diff] [blame] | 339 | @classmethod |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 340 | def setUpConstants(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 341 | """ Set-up the test case class based on environment variables """ |
Paul Vinciguerra | 0cbc71d | 2019-07-03 08:38:38 -0400 | [diff] [blame] | 342 | cls.step = BoolEnvironmentVariable('STEP') |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 343 | d = os.getenv("DEBUG", None) |
Paul Vinciguerra | 0cbc71d | 2019-07-03 08:38:38 -0400 | [diff] [blame] | 344 | # inverted case to handle '' == True |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 345 | c = os.getenv("CACHE_OUTPUT", "1") |
| 346 | cls.cache_vpp_output = False if c.lower() in ("n", "no", "0") else True |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 347 | cls.set_debug_flags(d) |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 348 | cls.vpp_bin = os.getenv('VPP_BIN', "vpp") |
| 349 | cls.plugin_path = os.getenv('VPP_PLUGIN_PATH') |
Dave Barach | 7d31ab2 | 2019-05-08 19:18:18 -0400 | [diff] [blame] | 350 | cls.test_plugin_path = os.getenv('VPP_TEST_PLUGIN_PATH') |
Klement Sekera | 47e275b | 2017-03-21 08:21:25 +0100 | [diff] [blame] | 351 | cls.extern_plugin_path = os.getenv('EXTERN_PLUGINS') |
| 352 | plugin_path = None |
| 353 | if cls.plugin_path is not None: |
| 354 | if cls.extern_plugin_path is not None: |
| 355 | plugin_path = "%s:%s" % ( |
| 356 | cls.plugin_path, cls.extern_plugin_path) |
Klement Sekera | 6abbc28 | 2017-03-24 05:47:15 +0100 | [diff] [blame] | 357 | else: |
| 358 | plugin_path = cls.plugin_path |
Klement Sekera | 47e275b | 2017-03-21 08:21:25 +0100 | [diff] [blame] | 359 | elif cls.extern_plugin_path is not None: |
| 360 | plugin_path = cls.extern_plugin_path |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 361 | debug_cli = "" |
Klement Sekera | 01bbbe9 | 2016-11-02 09:25:05 +0100 | [diff] [blame] | 362 | if cls.step or cls.debug_gdb or cls.debug_gdbserver: |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 363 | debug_cli = "cli-listen localhost:5002" |
Klement Sekera | 80a7f0a | 2017-03-02 11:27:11 +0100 | [diff] [blame] | 364 | coredump_size = None |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 365 | size = os.getenv("COREDUMP_SIZE") |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 366 | if size is not None: |
| 367 | coredump_size = "coredump-size %s" % size |
| 368 | if coredump_size is None: |
| 369 | coredump_size = "coredump-size unlimited" |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 370 | |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 371 | cpu_core_number = cls.get_least_used_cpu() |
Klement Sekera | 630ab58 | 2019-07-19 09:14:19 +0000 | [diff] [blame] | 372 | if not hasattr(cls, "worker_config"): |
| 373 | cls.worker_config = "" |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 374 | |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 375 | cls.vpp_cmdline = [cls.vpp_bin, "unix", |
| 376 | "{", "nodaemon", debug_cli, "full-coredump", |
| 377 | coredump_size, "runtime-dir", cls.tempdir, "}", |
| 378 | "api-trace", "{", "on", "}", "api-segment", "{", |
| 379 | "prefix", cls.shm_prefix, "}", "cpu", "{", |
Klement Sekera | 630ab58 | 2019-07-19 09:14:19 +0000 | [diff] [blame] | 380 | "main-core", str(cpu_core_number), |
| 381 | cls.worker_config, "}", |
Ole Troan | 4ff09ae | 2019-04-15 11:27:22 +0200 | [diff] [blame] | 382 | "statseg", "{", "socket-name", cls.stats_sock, "}", |
| 383 | "socksvr", "{", "socket-name", cls.api_sock, "}", |
| 384 | "plugins", |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 385 | "{", "plugin", "dpdk_plugin.so", "{", "disable", |
Ole Troan | 2e1c896 | 2019-04-10 09:44:23 +0200 | [diff] [blame] | 386 | "}", "plugin", "rdma_plugin.so", "{", "disable", |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 387 | "}", "plugin", "unittest_plugin.so", "{", "enable", |
| 388 | "}"] + cls.extra_vpp_plugin_config + ["}", ] |
| 389 | if cls.extra_vpp_punt_config is not None: |
| 390 | cls.vpp_cmdline.extend(cls.extra_vpp_punt_config) |
Klement Sekera | 47e275b | 2017-03-21 08:21:25 +0100 | [diff] [blame] | 391 | if plugin_path is not None: |
Ole Troan | a45dc07 | 2018-12-21 16:04:22 +0100 | [diff] [blame] | 392 | cls.vpp_cmdline.extend(["plugin_path", plugin_path]) |
Dave Barach | 7d31ab2 | 2019-05-08 19:18:18 -0400 | [diff] [blame] | 393 | if cls.test_plugin_path is not None: |
| 394 | cls.vpp_cmdline.extend(["test_plugin_path", cls.test_plugin_path]) |
| 395 | |
Klement Sekera | f37c3ba | 2018-11-08 11:24:34 +0100 | [diff] [blame] | 396 | cls.logger.info("vpp_cmdline args: %s" % cls.vpp_cmdline) |
| 397 | cls.logger.info("vpp_cmdline: %s" % " ".join(cls.vpp_cmdline)) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 398 | |
| 399 | @classmethod |
| 400 | def wait_for_enter(cls): |
| 401 | if cls.debug_gdbserver: |
| 402 | print(double_line_delim) |
| 403 | print("Spawned GDB server with PID: %d" % cls.vpp.pid) |
| 404 | elif cls.debug_gdb: |
| 405 | print(double_line_delim) |
| 406 | print("Spawned VPP with PID: %d" % cls.vpp.pid) |
| 407 | else: |
| 408 | cls.logger.debug("Spawned VPP with PID: %d" % cls.vpp.pid) |
| 409 | return |
| 410 | print(single_line_delim) |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 411 | print("You can debug VPP using:") |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 412 | if cls.debug_gdbserver: |
Paul Vinciguerra | 3a9f11e | 2019-06-18 22:59:55 -0400 | [diff] [blame] | 413 | print("sudo gdb " + cls.vpp_bin + |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 414 | " -ex 'target remote localhost:{port}'" |
| 415 | .format(port=cls.gdbserver_port)) |
| 416 | print("Now is the time to attach gdb by running the above " |
| 417 | "command, set up breakpoints etc., then resume VPP from " |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 418 | "within gdb by issuing the 'continue' command") |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 419 | cls.gdbserver_port += 1 |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 420 | elif cls.debug_gdb: |
Paul Vinciguerra | 3a9f11e | 2019-06-18 22:59:55 -0400 | [diff] [blame] | 421 | print("sudo gdb " + cls.vpp_bin + " -ex 'attach %s'" % cls.vpp.pid) |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 422 | print("Now is the time to attach gdb by running the above " |
| 423 | "command and set up breakpoints etc., then resume VPP from" |
| 424 | " within gdb by issuing the 'continue' command") |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 425 | print(single_line_delim) |
Paul Vinciguerra | 852f5ef | 2018-12-15 10:16:35 -0800 | [diff] [blame] | 426 | input("Press ENTER to continue running the testcase...") |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 427 | |
| 428 | @classmethod |
| 429 | def run_vpp(cls): |
| 430 | cmdline = cls.vpp_cmdline |
| 431 | |
| 432 | if cls.debug_gdbserver: |
Klement Sekera | 931be3a | 2016-11-03 05:36:01 +0100 | [diff] [blame] | 433 | gdbserver = '/usr/bin/gdbserver' |
| 434 | if not os.path.isfile(gdbserver) or \ |
| 435 | not os.access(gdbserver, os.X_OK): |
| 436 | raise Exception("gdbserver binary '%s' does not exist or is " |
| 437 | "not executable" % gdbserver) |
| 438 | |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 439 | cmdline = [gdbserver, 'localhost:{port}' |
| 440 | .format(port=cls.gdbserver_port)] + cls.vpp_cmdline |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 441 | cls.logger.info("Gdbserver cmdline is %s", " ".join(cmdline)) |
| 442 | |
Klement Sekera | 931be3a | 2016-11-03 05:36:01 +0100 | [diff] [blame] | 443 | try: |
| 444 | cls.vpp = subprocess.Popen(cmdline, |
| 445 | stdout=subprocess.PIPE, |
| 446 | stderr=subprocess.PIPE, |
| 447 | bufsize=1) |
Paul Vinciguerra | 61e63bf | 2018-11-24 21:19:38 -0800 | [diff] [blame] | 448 | except subprocess.CalledProcessError as e: |
Paul Vinciguerra | 38a4ec7 | 2018-11-28 11:34:21 -0800 | [diff] [blame] | 449 | cls.logger.critical("Subprocess returned with non-0 return code: (" |
| 450 | "%s)", e.returncode) |
| 451 | raise |
| 452 | except OSError as e: |
| 453 | cls.logger.critical("Subprocess returned with OS error: " |
| 454 | "(%s) %s", e.errno, e.strerror) |
| 455 | raise |
| 456 | except Exception as e: |
| 457 | cls.logger.exception("Subprocess returned unexpected from " |
| 458 | "%s:", cmdline) |
Klement Sekera | 931be3a | 2016-11-03 05:36:01 +0100 | [diff] [blame] | 459 | raise |
| 460 | |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 461 | cls.wait_for_enter() |
Pierre Pfister | cd8e318 | 2016-10-07 16:30:03 +0100 | [diff] [blame] | 462 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 463 | @classmethod |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 464 | def wait_for_stats_socket(cls): |
Andrew Yourtchenko | 4f05a8e | 2019-10-13 10:06:46 +0000 | [diff] [blame] | 465 | deadline = time.time() + 300 |
Paul Vinciguerra | dd4b2bb | 2018-11-15 08:13:03 -0800 | [diff] [blame] | 466 | ok = False |
| 467 | while time.time() < deadline or \ |
| 468 | cls.debug_gdb or cls.debug_gdbserver: |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 469 | if os.path.exists(cls.stats_sock): |
Paul Vinciguerra | dd4b2bb | 2018-11-15 08:13:03 -0800 | [diff] [blame] | 470 | ok = True |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 471 | break |
Paul Vinciguerra | 0f6602c | 2019-03-10 09:10:54 -0700 | [diff] [blame] | 472 | cls.sleep(0.8) |
Paul Vinciguerra | dd4b2bb | 2018-11-15 08:13:03 -0800 | [diff] [blame] | 473 | if not ok: |
| 474 | cls.logger.critical("Couldn't stat : {}".format(cls.stats_sock)) |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 475 | |
| 476 | @classmethod |
Andrew Yourtchenko | b31d393 | 2019-10-31 08:34:22 +0000 | [diff] [blame] | 477 | def wait_for_coredump(cls): |
| 478 | corefile = cls.tempdir + "/core" |
Dave Wallace | 3e9b7a2 | 2019-04-09 20:19:51 -0400 | [diff] [blame] | 479 | if os.path.isfile(corefile): |
Andrew Yourtchenko | b31d393 | 2019-10-31 08:34:22 +0000 | [diff] [blame] | 480 | cls.logger.error("Waiting for coredump to complete: %s", corefile) |
Dave Wallace | 3e9b7a2 | 2019-04-09 20:19:51 -0400 | [diff] [blame] | 481 | curr_size = os.path.getsize(corefile) |
Andrew Yourtchenko | b31d393 | 2019-10-31 08:34:22 +0000 | [diff] [blame] | 482 | deadline = time.time() + 60 |
Dave Wallace | 3e9b7a2 | 2019-04-09 20:19:51 -0400 | [diff] [blame] | 483 | ok = False |
| 484 | while time.time() < deadline: |
| 485 | cls.sleep(1) |
| 486 | size = curr_size |
| 487 | curr_size = os.path.getsize(corefile) |
| 488 | if size == curr_size: |
| 489 | ok = True |
| 490 | break |
| 491 | if not ok: |
| 492 | cls.logger.error("Timed out waiting for coredump to complete:" |
| 493 | " %s", corefile) |
| 494 | else: |
| 495 | cls.logger.error("Coredump complete: %s, size %d", |
| 496 | corefile, curr_size) |
| 497 | |
| 498 | @classmethod |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 499 | def setUpClass(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 500 | """ |
| 501 | Perform class setup before running the testcase |
| 502 | Remove shared memory files, start vpp and connect the vpp-api |
| 503 | """ |
Paul Vinciguerra | 8d991d9 | 2019-01-25 14:05:48 -0800 | [diff] [blame] | 504 | super(VppTestCase, cls).setUpClass() |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 505 | gc.collect() # run garbage collection first |
juraj.linkes | dfb5f2a | 2018-11-09 11:58:54 +0100 | [diff] [blame] | 506 | cls.logger = get_logger(cls.__name__) |
Klement Sekera | 45a95dd | 2019-11-05 11:18:25 +0000 | [diff] [blame^] | 507 | seed = os.environ["RND_SEED"] |
| 508 | random.seed(seed) |
juraj.linkes | dfb5f2a | 2018-11-09 11:58:54 +0100 | [diff] [blame] | 509 | if hasattr(cls, 'parallel_handler'): |
| 510 | cls.logger.addHandler(cls.parallel_handler) |
juraj.linkes | 3d9b92a | 2018-11-21 13:13:39 +0100 | [diff] [blame] | 511 | cls.logger.propagate = False |
Paul Vinciguerra | 90cf21b | 2019-03-13 09:23:05 -0700 | [diff] [blame] | 512 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 513 | cls.tempdir = tempfile.mkdtemp( |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 514 | prefix='vpp-unittest-%s-' % cls.__name__) |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 515 | cls.stats_sock = "%s/stats.sock" % cls.tempdir |
Ole Troan | 4ff09ae | 2019-04-15 11:27:22 +0200 | [diff] [blame] | 516 | cls.api_sock = "%s/api.sock" % cls.tempdir |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 517 | cls.file_handler = FileHandler("%s/log.txt" % cls.tempdir) |
| 518 | cls.file_handler.setFormatter( |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 519 | Formatter(fmt='%(asctime)s,%(msecs)03d %(message)s', |
| 520 | datefmt="%H:%M:%S")) |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 521 | cls.file_handler.setLevel(DEBUG) |
| 522 | cls.logger.addHandler(cls.file_handler) |
Paul Vinciguerra | 90cf21b | 2019-03-13 09:23:05 -0700 | [diff] [blame] | 523 | cls.logger.debug("--- setUpClass() for %s called ---" % |
| 524 | cls.__name__) |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 525 | cls.shm_prefix = os.path.basename(cls.tempdir) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 526 | os.chdir(cls.tempdir) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 527 | cls.logger.info("Temporary dir is %s, shm prefix is %s", |
| 528 | cls.tempdir, cls.shm_prefix) |
Klement Sekera | 45a95dd | 2019-11-05 11:18:25 +0000 | [diff] [blame^] | 529 | cls.logger.debug("Random seed is %s" % seed) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 530 | cls.setUpConstants() |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 531 | cls.reset_packet_infos() |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 532 | cls._captures = [] |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 533 | cls.verbose = 0 |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 534 | cls.vpp_dead = False |
Klement Sekera | 10db26f | 2017-01-11 08:16:53 +0100 | [diff] [blame] | 535 | cls.registry = VppObjectRegistry() |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 536 | cls.vpp_startup_failed = False |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 537 | cls.reporter = KeepAliveReporter() |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 538 | # need to catch exceptions here because if we raise, then the cleanup |
| 539 | # doesn't get called and we might end with a zombie vpp |
| 540 | try: |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 541 | cls.run_vpp() |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 542 | cls.reporter.send_keep_alive(cls, 'setUpClass') |
| 543 | VppTestResult.current_test_case_info = TestCaseInfo( |
| 544 | cls.logger, cls.tempdir, cls.vpp.pid, cls.vpp_bin) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 545 | cls.vpp_stdout_deque = deque() |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 546 | cls.vpp_stderr_deque = deque() |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 547 | cls.pump_thread_stop_flag = Event() |
| 548 | cls.pump_thread_wakeup_pipe = os.pipe() |
| 549 | cls.pump_thread = Thread(target=pump_output, args=(cls,)) |
Klement Sekera | aeeac3b | 2017-02-14 07:11:52 +0100 | [diff] [blame] | 550 | cls.pump_thread.daemon = True |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 551 | cls.pump_thread.start() |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 552 | if cls.debug_gdb or cls.debug_gdbserver: |
| 553 | read_timeout = 0 |
| 554 | else: |
| 555 | read_timeout = 5 |
| 556 | cls.vapi = VppPapiProvider(cls.shm_prefix, cls.shm_prefix, cls, |
| 557 | read_timeout) |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 558 | if cls.step: |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 559 | hook = hookmodule.StepHook(cls) |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 560 | else: |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 561 | hook = hookmodule.PollHook(cls) |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 562 | cls.vapi.register_hook(hook) |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 563 | cls.wait_for_stats_socket() |
| 564 | cls.statistics = VPPStats(socketname=cls.stats_sock) |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 565 | try: |
| 566 | hook.poll_vpp() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 567 | except VppDiedError: |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 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 |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 573 | try: |
| 574 | cls.vapi.connect() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 575 | except Exception: |
Klement Sekera | 4c53313 | 2018-02-22 11:41:12 +0100 | [diff] [blame] | 576 | try: |
| 577 | cls.vapi.disconnect() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 578 | except Exception: |
Klement Sekera | 4c53313 | 2018-02-22 11:41:12 +0100 | [diff] [blame] | 579 | pass |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 580 | if cls.debug_gdbserver: |
| 581 | print(colorize("You're running VPP inside gdbserver but " |
| 582 | "VPP-API connection failed, did you forget " |
| 583 | "to 'continue' VPP from within gdb?", RED)) |
| 584 | raise |
Andrew Yourtchenko | 4f05a8e | 2019-10-13 10:06:46 +0000 | [diff] [blame] | 585 | except Exception as e: |
| 586 | cls.logger.debug("Exception connecting to VPP: %s" % e) |
Paul Vinciguerra | 496b0de | 2019-06-20 12:24:12 -0400 | [diff] [blame] | 587 | |
| 588 | cls.quit() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 589 | raise |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 590 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 591 | @classmethod |
| 592 | def quit(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 593 | """ |
| 594 | Disconnect vpp-api, kill vpp and cleanup shared memory files |
| 595 | """ |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 596 | if (cls.debug_gdbserver or cls.debug_gdb) and hasattr(cls, 'vpp'): |
| 597 | cls.vpp.poll() |
| 598 | if cls.vpp.returncode is None: |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 599 | print() |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 600 | print(double_line_delim) |
| 601 | print("VPP or GDB server is still running") |
| 602 | print(single_line_delim) |
Paul Vinciguerra | 852f5ef | 2018-12-15 10:16:35 -0800 | [diff] [blame] | 603 | input("When done debugging, press ENTER to kill the " |
| 604 | "process and finish running the testcase...") |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 605 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 606 | # first signal that we want to stop the pump thread, then wake it up |
| 607 | if hasattr(cls, 'pump_thread_stop_flag'): |
| 608 | cls.pump_thread_stop_flag.set() |
| 609 | if hasattr(cls, 'pump_thread_wakeup_pipe'): |
Ole Troan | 7f99183 | 2018-12-06 17:35:12 +0100 | [diff] [blame] | 610 | os.write(cls.pump_thread_wakeup_pipe[1], b'ding dong wake up') |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 611 | if hasattr(cls, 'pump_thread'): |
| 612 | cls.logger.debug("Waiting for pump thread to stop") |
| 613 | cls.pump_thread.join() |
| 614 | if hasattr(cls, 'vpp_stderr_reader_thread'): |
Andrew Yourtchenko | b31d393 | 2019-10-31 08:34:22 +0000 | [diff] [blame] | 615 | cls.logger.debug("Waiting for stdderr pump to stop") |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 616 | cls.vpp_stderr_reader_thread.join() |
| 617 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 618 | if hasattr(cls, 'vpp'): |
Klement Sekera | 0529a74 | 2016-12-02 07:05:24 +0100 | [diff] [blame] | 619 | if hasattr(cls, 'vapi'): |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 620 | cls.logger.debug("Disconnecting class vapi client on %s", |
| 621 | cls.__name__) |
Klement Sekera | 0529a74 | 2016-12-02 07:05:24 +0100 | [diff] [blame] | 622 | cls.vapi.disconnect() |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 623 | cls.logger.debug("Deleting class vapi attribute on %s", |
| 624 | cls.__name__) |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 625 | del cls.vapi |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 626 | cls.vpp.poll() |
| 627 | if cls.vpp.returncode is None: |
Andrew Yourtchenko | b31d393 | 2019-10-31 08:34:22 +0000 | [diff] [blame] | 628 | cls.wait_for_coredump() |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 629 | cls.logger.debug("Sending TERM to vpp") |
Dave Barach | ad64687 | 2019-05-06 10:49:41 -0400 | [diff] [blame] | 630 | cls.vpp.terminate() |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 631 | cls.logger.debug("Waiting for vpp to die") |
| 632 | cls.vpp.communicate() |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 633 | cls.logger.debug("Deleting class vpp attribute on %s", |
| 634 | cls.__name__) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 635 | del cls.vpp |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 636 | |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 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 | |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 644 | if hasattr(cls, 'vpp_stdout_deque'): |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 645 | stdout_log(single_line_delim) |
| 646 | stdout_log('VPP output to stdout while running %s:', cls.__name__) |
| 647 | stdout_log(single_line_delim) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 648 | vpp_output = "".join(cls.vpp_stdout_deque) |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 649 | with open(cls.tempdir + '/vpp_stdout.txt', 'w') as f: |
| 650 | f.write(vpp_output) |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 651 | stdout_log('\n%s', vpp_output) |
| 652 | stdout_log(single_line_delim) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 653 | |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 654 | if hasattr(cls, 'vpp_stderr_deque'): |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 655 | stderr_log(single_line_delim) |
| 656 | stderr_log('VPP output to stderr while running %s:', cls.__name__) |
| 657 | stderr_log(single_line_delim) |
Klement Sekera | 0ede47a | 2019-01-29 11:49:09 +0100 | [diff] [blame] | 658 | vpp_output = "".join(cls.vpp_stderr_deque) |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 659 | with open(cls.tempdir + '/vpp_stderr.txt', 'w') as f: |
| 660 | f.write(vpp_output) |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 661 | stderr_log('\n%s', vpp_output) |
| 662 | stderr_log(single_line_delim) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 663 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 664 | @classmethod |
| 665 | def tearDownClass(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 666 | """ Perform final cleanup after running all tests in this test-case """ |
Paul Vinciguerra | 90cf21b | 2019-03-13 09:23:05 -0700 | [diff] [blame] | 667 | cls.logger.debug("--- tearDownClass() for %s called ---" % |
| 668 | cls.__name__) |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 669 | cls.reporter.send_keep_alive(cls, 'tearDownClass') |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 670 | cls.quit() |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 671 | cls.file_handler.close() |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 672 | cls.reset_packet_infos() |
| 673 | if debug_framework: |
| 674 | debug_internal.on_tear_down_class(cls) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 675 | |
Paul Vinciguerra | 90cf21b | 2019-03-13 09:23:05 -0700 | [diff] [blame] | 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 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 680 | def tearDown(self): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 681 | """ Show various debug prints after each test """ |
Klement Sekera | b91017a | 2017-02-09 06:04:36 +0100 | [diff] [blame] | 682 | self.logger.debug("--- tearDown() for %s.%s(%s) called ---" % |
| 683 | (self.__class__.__name__, self._testMethodName, |
| 684 | self._testMethodDoc)) |
Paul Vinciguerra | 499ea64 | 2019-03-15 09:39:19 -0700 | [diff] [blame] | 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")) |
Dave Barach | 32dcd3b | 2019-07-08 12:25:38 -0400 | [diff] [blame] | 694 | self.logger.info(self.vapi.ppcli("show bihash")) |
Paul Vinciguerra | 499ea64 | 2019-03-15 09:39:19 -0700 | [diff] [blame] | 695 | self.logger.info("Logging testcase specific show commands.") |
| 696 | self.show_commands_at_teardown() |
| 697 | self.registry.remove_vpp_config(self.logger) |
Dave Wallace | 90c5572 | 2017-02-16 11:25:26 -0500 | [diff] [blame] | 698 | # Save/Dump VPP api trace log |
Andrew Yourtchenko | 586d3ed | 2019-10-21 12:55:48 +0000 | [diff] [blame] | 699 | m = self._testMethodName |
| 700 | api_trace = "vpp_api_trace.%s.%d.log" % (m, self.vpp.pid) |
Dave Wallace | 90c5572 | 2017-02-16 11:25:26 -0500 | [diff] [blame] | 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) |
Dave Wallace | 5ba5837 | 2018-02-13 16:14:06 -0500 | [diff] [blame] | 707 | self.logger.info(self.vapi.ppcli("api trace custom-dump %s" % |
Dave Wallace | 90c5572 | 2017-02-16 11:25:26 -0500 | [diff] [blame] | 708 | vpp_api_trace_log)) |
Paul Vinciguerra | 499ea64 | 2019-03-15 09:39:19 -0700 | [diff] [blame] | 709 | except VppTransportShmemIOError: |
| 710 | self.logger.debug("VppTransportShmemIOError: Vpp dead. " |
| 711 | "Cannot log show commands.") |
| 712 | self.vpp_dead = True |
Klement Sekera | 1b68640 | 2017-03-02 11:29:19 +0100 | [diff] [blame] | 713 | else: |
| 714 | self.registry.unregister_all(self.logger) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 715 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 716 | def setUp(self): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 717 | """ Clear trace before running each test""" |
Paul Vinciguerra | 8d991d9 | 2019-01-25 14:05:48 -0800 | [diff] [blame] | 718 | super(VppTestCase, self).setUp() |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 719 | self.reporter.send_keep_alive(self) |
Klement Sekera | 0c1519b | 2016-12-08 05:03:32 +0100 | [diff] [blame] | 720 | if self.vpp_dead: |
Paul Vinciguerra | fea8260 | 2019-06-26 20:45:08 -0400 | [diff] [blame] | 721 | |
| 722 | raise VppDiedError(rv=None, testcase=self.__class__.__name__, |
| 723 | method_name=self._testMethodName) |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 724 | self.sleep(.1, "during setUp") |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 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)) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 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 |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 737 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 738 | @classmethod |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 739 | def pg_enable_capture(cls, interfaces=None): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 740 | """ |
| 741 | Enable capture on packet-generator interfaces |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 742 | |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 743 | :param interfaces: iterable interface indexes (if None, |
| 744 | use self.pg_interfaces) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 745 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 746 | """ |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 747 | if interfaces is None: |
| 748 | interfaces = cls.pg_interfaces |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 749 | for i in interfaces: |
| 750 | i.enable_capture() |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 751 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 752 | @classmethod |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 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)) |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 757 | |
| 758 | @classmethod |
Andrew Yourtchenko | 63cb882 | 2019-10-13 18:56:03 +0000 | [diff] [blame] | 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 |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 773 | def pg_start(cls): |
Andrew Yourtchenko | 8d829f6 | 2019-10-13 10:09:50 +0000 | [diff] [blame] | 774 | """ Enable the PG, wait till it is done, then clean up """ |
Klement Sekera | d91fa61 | 2019-01-15 13:25:09 +0100 | [diff] [blame] | 775 | cls.vapi.cli("trace add pg-input 1000") |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 776 | cls.vapi.cli('packet-generator enable') |
Andrew Yourtchenko | 8d829f6 | 2019-10-13 10:09:50 +0000 | [diff] [blame] | 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) |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 789 | cls._captures = [] |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 790 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 791 | @classmethod |
Mohsin Kazmi | 22e9cfd | 2019-07-23 11:54:48 +0200 | [diff] [blame] | 792 | def create_pg_interfaces(cls, interfaces, gso=0, gso_size=0): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 793 | """ |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 794 | Create packet-generator interfaces. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 795 | |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 796 | :param interfaces: iterable indexes of the interfaces. |
| 797 | :returns: List of created interfaces. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 798 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 799 | """ |
| 800 | result = [] |
| 801 | for i in interfaces: |
Mohsin Kazmi | 22e9cfd | 2019-07-23 11:54:48 +0200 | [diff] [blame] | 802 | intf = VppPGInterface(cls, i, gso, gso_size) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 803 | setattr(cls, intf.name, intf) |
| 804 | result.append(intf) |
| 805 | cls.pg_interfaces = result |
| 806 | return result |
| 807 | |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 808 | @classmethod |
Klement Sekera | b9ef273 | 2018-06-24 22:49:33 +0200 | [diff] [blame] | 809 | def create_loopback_interfaces(cls, count): |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 810 | """ |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 811 | Create loopback interfaces. |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 812 | |
Klement Sekera | b9ef273 | 2018-06-24 22:49:33 +0200 | [diff] [blame] | 813 | :param count: number of interfaces created. |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 814 | :returns: List of created interfaces. |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 815 | """ |
Klement Sekera | b9ef273 | 2018-06-24 22:49:33 +0200 | [diff] [blame] | 816 | result = [VppLoInterface(cls) for i in range(count)] |
| 817 | for intf in result: |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 818 | setattr(cls, intf.name, intf) |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 819 | cls.lo_interfaces = result |
| 820 | return result |
| 821 | |
Neale Ranns | 192b13f | 2019-03-15 02:16:20 -0700 | [diff] [blame] | 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 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 836 | @staticmethod |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 837 | def extend_packet(packet, size, padding=' '): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 838 | """ |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 839 | Extend packet to given size by padding with spaces or custom padding |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 840 | NOTE: Currently works only when Raw layer is present. |
| 841 | |
| 842 | :param packet: packet |
| 843 | :param size: target size |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 844 | :param padding: padding used to extend the payload |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 845 | |
| 846 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 847 | packet_len = len(packet) + 4 |
| 848 | extend = size - packet_len |
| 849 | if extend > 0: |
Alexandre Poirrier | cc99149 | 2019-05-07 10:39:57 +0200 | [diff] [blame] | 850 | num = (extend // len(padding)) + 1 |
| 851 | packet[Raw].load += (padding * num)[:extend].encode("ascii") |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 852 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 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 = {} |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 858 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 859 | @classmethod |
| 860 | def create_packet_info(cls, src_if, dst_if): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 861 | """ |
| 862 | Create packet info object containing the source and destination indexes |
| 863 | and add it to the testcase's packet info list |
| 864 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 865 | :param VppInterface src_if: source interface |
| 866 | :param VppInterface dst_if: destination interface |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 867 | |
| 868 | :returns: _PacketInfo object |
| 869 | |
| 870 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 871 | info = _PacketInfo() |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 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 |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 884 | return info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 885 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 886 | @staticmethod |
| 887 | def info_to_payload(info): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 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 | """ |
Pavel Kotucek | 59dda06 | 2017-03-02 15:22:47 +0100 | [diff] [blame] | 895 | return "%d %d %d %d %d" % (info.index, info.src, info.dst, |
| 896 | info.ip, info.proto) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 897 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 898 | @staticmethod |
Paul Vinciguerra | eaea421 | 2019-03-06 11:58:06 -0800 | [diff] [blame] | 899 | def payload_to_info(payload, payload_field='load'): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 900 | """ |
| 901 | Convert packet payload to _PacketInfo object |
| 902 | |
| 903 | :param payload: packet payload |
Paul Vinciguerra | 22364e4 | 2019-03-12 20:04:56 -0700 | [diff] [blame] | 904 | :type payload: <class 'scapy.packet.Raw'> |
| 905 | :param payload_field: packet fieldname of payload "load" for |
Paul Vinciguerra | eaea421 | 2019-03-06 11:58:06 -0800 | [diff] [blame] | 906 | <class 'scapy.packet.Raw'> |
Paul Vinciguerra | 22364e4 | 2019-03-12 20:04:56 -0700 | [diff] [blame] | 907 | :type payload_field: str |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 908 | :returns: _PacketInfo object containing de-serialized data from payload |
| 909 | |
| 910 | """ |
Paul Vinciguerra | eaea421 | 2019-03-06 11:58:06 -0800 | [diff] [blame] | 911 | numbers = getattr(payload, payload_field).split() |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 912 | info = _PacketInfo() |
| 913 | info.index = int(numbers[0]) |
| 914 | info.src = int(numbers[1]) |
| 915 | info.dst = int(numbers[2]) |
Pavel Kotucek | 59dda06 | 2017-03-02 15:22:47 +0100 | [diff] [blame] | 916 | info.ip = int(numbers[3]) |
| 917 | info.proto = int(numbers[4]) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 918 | return info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 919 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 920 | def get_next_packet_info(self, info): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 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 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 929 | if info is None: |
| 930 | next_index = 0 |
| 931 | else: |
| 932 | next_index = info.index + 1 |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 933 | if next_index == len(self._packet_infos): |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 934 | return None |
| 935 | else: |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 936 | return self._packet_infos[next_index] |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 937 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 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 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 948 | while True: |
| 949 | info = self.get_next_packet_info(info) |
| 950 | if info is None: |
| 951 | return None |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 952 | if info.src == src_index: |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 953 | return info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 954 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 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 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 966 | while True: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 967 | info = self.get_next_packet_info_for_interface(src_index, info) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 968 | if info is None: |
| 969 | return None |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 970 | if info.dst == dst_index: |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 971 | return info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 972 | |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 973 | def assert_equal(self, real_value, expected_value, name_or_class=None): |
| 974 | if name_or_class is None: |
Klement Sekera | 239790f | 2017-02-16 10:53:53 +0100 | [diff] [blame] | 975 | self.assertEqual(real_value, expected_value) |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 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))) |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 982 | except Exception: |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 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 | |
Klement Sekera | b17dd96 | 2017-01-09 07:43:48 +0100 | [diff] [blame] | 988 | def assert_in_range(self, |
| 989 | real_value, |
| 990 | expected_min, |
| 991 | expected_max, |
| 992 | name=None): |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 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 | |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 1000 | def assert_packet_checksums_valid(self, packet, |
| 1001 | ignore_zero_udp_checksums=True): |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 1002 | received = packet.__class__(scapy.compat.raw(packet)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 1003 | udp_layers = ['UDP', 'UDPerror'] |
| 1004 | checksum_fields = ['cksum', 'chksum'] |
| 1005 | checksums = [] |
| 1006 | counter = 0 |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 1007 | temp = received.__class__(scapy.compat.raw(received)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 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 \ |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 1014 | 0 == getattr(layer, cf) and \ |
| 1015 | layer.name in udp_layers: |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 1016 | continue |
| 1017 | delattr(layer, cf) |
| 1018 | checksums.append((counter, cf)) |
| 1019 | else: |
| 1020 | break |
| 1021 | counter = counter + 1 |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1022 | if 0 == len(checksums): |
| 1023 | return |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 1024 | temp = temp.__class__(scapy.compat.raw(temp)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 1025 | for layer, cf in checksums: |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 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)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 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 |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 1041 | recalculated = received_packet.__class__( |
| 1042 | scapy.compat.raw(received_packet)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 1043 | delattr(recalculated[layer], field_name) |
Paul Vinciguerra | a7427ec | 2019-03-10 10:04:23 -0700 | [diff] [blame] | 1044 | recalculated = recalculated.__class__(scapy.compat.raw(recalculated)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 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 | |
Klement Sekera | 3a343d4 | 2019-05-16 14:35:46 +0200 | [diff] [blame] | 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') |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 1093 | counter_value = 0 |
Klement Sekera | 3a343d4 | 2019-05-16 14:35:46 +0200 | [diff] [blame] | 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 | |
Klement Sekera | f37c3ba | 2018-11-08 11:24:34 +0100 | [diff] [blame] | 1101 | def assert_packet_counter_equal(self, counter, expected_value): |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 1102 | counter_value = self.get_packet_counter(counter) |
| 1103 | self.assert_equal(counter_value, expected_value, |
| 1104 | "packet counter `%s'" % counter) |
Klement Sekera | f37c3ba | 2018-11-08 11:24:34 +0100 | [diff] [blame] | 1105 | |
Ole Troan | 233e468 | 2019-05-16 15:01:34 +0200 | [diff] [blame] | 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 | |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 1111 | @classmethod |
| 1112 | def sleep(cls, timeout, remark=None): |
Paul Vinciguerra | 0f6602c | 2019-03-10 09:10:54 -0700 | [diff] [blame] | 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 | |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 1126 | if hasattr(cls, 'logger'): |
Paul Vinciguerra | 6919b0d | 2018-12-09 15:37:04 -0800 | [diff] [blame] | 1127 | cls.logger.debug("Starting sleep for %es (%s)", timeout, remark) |
Klement Sekera | 3cfa558 | 2017-04-19 07:10:58 +0000 | [diff] [blame] | 1128 | before = time.time() |
Klement Sekera | a57a970 | 2017-02-02 06:58:07 +0100 | [diff] [blame] | 1129 | time.sleep(timeout) |
Klement Sekera | 3cfa558 | 2017-04-19 07:10:58 +0000 | [diff] [blame] | 1130 | after = time.time() |
Paul Vinciguerra | 6919b0d | 2018-12-09 15:37:04 -0800 | [diff] [blame] | 1131 | if hasattr(cls, 'logger') and after - before > 2 * timeout: |
Paul Vinciguerra | 0f6602c | 2019-03-10 09:10:54 -0700 | [diff] [blame] | 1132 | cls.logger.error("unexpected self.sleep() result - " |
Paul Vinciguerra | 6919b0d | 2018-12-09 15:37:04 -0800 | [diff] [blame] | 1133 | "slept for %es instead of ~%es!", |
| 1134 | after - before, timeout) |
Klement Sekera | 3cfa558 | 2017-04-19 07:10:58 +0000 | [diff] [blame] | 1135 | if hasattr(cls, 'logger'): |
| 1136 | cls.logger.debug( |
Paul Vinciguerra | 6919b0d | 2018-12-09 15:37:04 -0800 | [diff] [blame] | 1137 | "Finished sleep (%s) - slept %es (wanted %es)", |
| 1138 | remark, after - before, timeout) |
Klement Sekera | a57a970 | 2017-02-02 06:58:07 +0100 | [diff] [blame] | 1139 | |
Paul Vinciguerra | eb41443 | 2019-02-20 09:01:14 -0800 | [diff] [blame] | 1140 | def pg_send(self, intf, pkts): |
Neale Ranns | 52fae86 | 2018-01-08 04:41:42 -0800 | [diff] [blame] | 1141 | self.vapi.cli("clear trace") |
| 1142 | intf.add_stream(pkts) |
| 1143 | self.pg_enable_capture(self.pg_interfaces) |
| 1144 | self.pg_start() |
Paul Vinciguerra | eb41443 | 2019-02-20 09:01:14 -0800 | [diff] [blame] | 1145 | |
| 1146 | def send_and_assert_no_replies(self, intf, pkts, remark="", timeout=None): |
| 1147 | self.pg_send(intf, pkts) |
Neale Ranns | 947ea62 | 2018-06-07 23:48:20 -0700 | [diff] [blame] | 1148 | if not timeout: |
| 1149 | timeout = 1 |
Neale Ranns | 52fae86 | 2018-01-08 04:41:42 -0800 | [diff] [blame] | 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 | |
Neale Ranns | d7603d9 | 2019-03-28 08:56:10 +0000 | [diff] [blame] | 1155 | def send_and_expect(self, intf, pkts, output, n_rx=None): |
| 1156 | if not n_rx: |
| 1157 | n_rx = len(pkts) |
Paul Vinciguerra | eb41443 | 2019-02-20 09:01:14 -0800 | [diff] [blame] | 1158 | self.pg_send(intf, pkts) |
Neale Ranns | d7603d9 | 2019-03-28 08:56:10 +0000 | [diff] [blame] | 1159 | rx = output.get_capture(n_rx) |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1160 | return rx |
| 1161 | |
Paul Vinciguerra | eb41443 | 2019-02-20 09:01:14 -0800 | [diff] [blame] | 1162 | def send_and_expect_only(self, intf, pkts, output, timeout=None): |
| 1163 | self.pg_send(intf, pkts) |
Paul Vinciguerra | 8aeb220 | 2019-01-07 16:29:26 -0800 | [diff] [blame] | 1164 | rx = output.get_capture(len(pkts)) |
| 1165 | outputs = [output] |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 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 | |
Neale Ranns | 52fae86 | 2018-01-08 04:41:42 -0800 | [diff] [blame] | 1174 | return rx |
| 1175 | |
Paul Vinciguerra | 087c811 | 2018-12-15 08:03:09 -0800 | [diff] [blame] | 1176 | def runTest(self): |
| 1177 | """ unittest calls runTest when TestCase is instantiated without a |
| 1178 | test case. Use case: Writing unittests against VppTestCase""" |
| 1179 | pass |
| 1180 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1181 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1182 | def get_testcase_doc_name(test): |
| 1183 | return getdoc(test.__class__).splitlines()[0] |
| 1184 | |
| 1185 | |
Ole Trøan | 5ba9159 | 2018-11-22 10:01:09 +0000 | [diff] [blame] | 1186 | def get_test_description(descriptions, test): |
| 1187 | short_description = test.shortDescription() |
| 1188 | if descriptions and short_description: |
| 1189 | return short_description |
| 1190 | else: |
| 1191 | return str(test) |
| 1192 | |
| 1193 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1194 | class TestCaseInfo(object): |
| 1195 | def __init__(self, logger, tempdir, vpp_pid, vpp_bin_path): |
| 1196 | self.logger = logger |
| 1197 | self.tempdir = tempdir |
| 1198 | self.vpp_pid = vpp_pid |
| 1199 | self.vpp_bin_path = vpp_bin_path |
| 1200 | self.core_crash_test = None |
Klement Sekera | 8713493 | 2017-03-07 11:39:27 +0100 | [diff] [blame] | 1201 | |
| 1202 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1203 | class VppTestResult(unittest.TestResult): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1204 | """ |
| 1205 | @property result_string |
| 1206 | String variable to store the test case result string. |
| 1207 | @property errors |
| 1208 | List variable containing 2-tuples of TestCase instances and strings |
| 1209 | holding formatted tracebacks. Each tuple represents a test which |
| 1210 | raised an unexpected exception. |
| 1211 | @property failures |
| 1212 | List variable containing 2-tuples of TestCase instances and strings |
| 1213 | holding formatted tracebacks. Each tuple represents a test where |
| 1214 | a failure was explicitly signalled using the TestCase.assert*() |
| 1215 | methods. |
| 1216 | """ |
| 1217 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1218 | failed_test_cases_info = set() |
| 1219 | core_crash_test_cases_info = set() |
| 1220 | current_test_case_info = None |
| 1221 | |
Paul Vinciguerra | 1ec06ff | 2019-01-16 11:12:50 -0800 | [diff] [blame] | 1222 | def __init__(self, stream=None, descriptions=None, verbosity=None, |
| 1223 | runner=None): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1224 | """ |
Klement Sekera | da505f6 | 2017-01-04 12:58:53 +0100 | [diff] [blame] | 1225 | :param stream File descriptor to store where to report test results. |
| 1226 | Set to the standard error stream by default. |
| 1227 | :param descriptions Boolean variable to store information if to use |
| 1228 | test case descriptions. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1229 | :param verbosity Integer variable to store required verbosity level. |
| 1230 | """ |
Paul Vinciguerra | dd3c5d2 | 2019-01-13 16:09:10 -0800 | [diff] [blame] | 1231 | super(VppTestResult, self).__init__(stream, descriptions, verbosity) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1232 | self.stream = stream |
| 1233 | self.descriptions = descriptions |
| 1234 | self.verbosity = verbosity |
| 1235 | self.result_string = None |
juraj.linkes | abec012 | 2018-11-16 17:28:56 +0100 | [diff] [blame] | 1236 | self.runner = runner |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1237 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1238 | def addSuccess(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1239 | """ |
| 1240 | Record a test succeeded result |
| 1241 | |
| 1242 | :param test: |
| 1243 | |
| 1244 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1245 | if self.current_test_case_info: |
| 1246 | self.current_test_case_info.logger.debug( |
| 1247 | "--- addSuccess() %s.%s(%s) called" % (test.__class__.__name__, |
| 1248 | test._testMethodName, |
| 1249 | test._testMethodDoc)) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1250 | unittest.TestResult.addSuccess(self, test) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 1251 | self.result_string = colorize("OK", GREEN) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1252 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1253 | self.send_result_through_pipe(test, PASS) |
| 1254 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1255 | def addSkip(self, test, reason): |
| 1256 | """ |
| 1257 | Record a test skipped. |
| 1258 | |
| 1259 | :param test: |
| 1260 | :param reason: |
| 1261 | |
| 1262 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1263 | if self.current_test_case_info: |
| 1264 | self.current_test_case_info.logger.debug( |
| 1265 | "--- addSkip() %s.%s(%s) called, reason is %s" % |
| 1266 | (test.__class__.__name__, test._testMethodName, |
| 1267 | test._testMethodDoc, reason)) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1268 | unittest.TestResult.addSkip(self, test, reason) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 1269 | self.result_string = colorize("SKIP", YELLOW) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1270 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1271 | self.send_result_through_pipe(test, SKIP) |
| 1272 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1273 | def symlink_failed(self): |
| 1274 | if self.current_test_case_info: |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 1275 | try: |
Klement Sekera | b8c72a4 | 2018-11-08 11:21:39 +0100 | [diff] [blame] | 1276 | failed_dir = os.getenv('FAILED_DIR') |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1277 | link_path = os.path.join( |
| 1278 | failed_dir, |
| 1279 | '%s-FAILED' % |
| 1280 | os.path.basename(self.current_test_case_info.tempdir)) |
| 1281 | if self.current_test_case_info.logger: |
| 1282 | self.current_test_case_info.logger.debug( |
| 1283 | "creating a link to the failed test") |
| 1284 | self.current_test_case_info.logger.debug( |
| 1285 | "os.symlink(%s, %s)" % |
| 1286 | (self.current_test_case_info.tempdir, link_path)) |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1287 | if os.path.exists(link_path): |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1288 | if self.current_test_case_info.logger: |
| 1289 | self.current_test_case_info.logger.debug( |
| 1290 | 'symlink already exists') |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1291 | else: |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1292 | os.symlink(self.current_test_case_info.tempdir, link_path) |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1293 | |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 1294 | except Exception as e: |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1295 | if self.current_test_case_info.logger: |
| 1296 | self.current_test_case_info.logger.error(e) |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 1297 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1298 | def send_result_through_pipe(self, test, result): |
| 1299 | if hasattr(self, 'test_framework_result_pipe'): |
| 1300 | pipe = self.test_framework_result_pipe |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1301 | if pipe: |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1302 | pipe.send((test.id(), result)) |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1303 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1304 | def log_error(self, test, err, fn_name): |
| 1305 | if self.current_test_case_info: |
| 1306 | if isinstance(test, unittest.suite._ErrorHolder): |
| 1307 | test_name = test.description |
| 1308 | else: |
| 1309 | test_name = '%s.%s(%s)' % (test.__class__.__name__, |
| 1310 | test._testMethodName, |
| 1311 | test._testMethodDoc) |
| 1312 | self.current_test_case_info.logger.debug( |
| 1313 | "--- %s() %s called, err is %s" % |
| 1314 | (fn_name, test_name, err)) |
| 1315 | self.current_test_case_info.logger.debug( |
| 1316 | "formatted exception is:\n%s" % |
| 1317 | "".join(format_exception(*err))) |
| 1318 | |
| 1319 | def add_error(self, test, err, unittest_fn, error_type): |
| 1320 | if error_type == FAIL: |
| 1321 | self.log_error(test, err, 'addFailure') |
| 1322 | error_type_str = colorize("FAIL", RED) |
| 1323 | elif error_type == ERROR: |
| 1324 | self.log_error(test, err, 'addError') |
| 1325 | error_type_str = colorize("ERROR", RED) |
| 1326 | else: |
| 1327 | raise Exception('Error type %s cannot be used to record an ' |
| 1328 | 'error or a failure' % error_type) |
| 1329 | |
| 1330 | unittest_fn(self, test, err) |
| 1331 | if self.current_test_case_info: |
| 1332 | self.result_string = "%s [ temp dir used by test case: %s ]" % \ |
| 1333 | (error_type_str, |
| 1334 | self.current_test_case_info.tempdir) |
| 1335 | self.symlink_failed() |
| 1336 | self.failed_test_cases_info.add(self.current_test_case_info) |
| 1337 | if is_core_present(self.current_test_case_info.tempdir): |
| 1338 | if not self.current_test_case_info.core_crash_test: |
| 1339 | if isinstance(test, unittest.suite._ErrorHolder): |
| 1340 | test_name = str(test) |
| 1341 | else: |
Paul Vinciguerra | ea2450f | 2019-03-06 08:23:58 -0800 | [diff] [blame] | 1342 | test_name = "'{!s}' ({!s})".format( |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1343 | get_testcase_doc_name(test), test.id()) |
| 1344 | self.current_test_case_info.core_crash_test = test_name |
| 1345 | self.core_crash_test_cases_info.add( |
| 1346 | self.current_test_case_info) |
| 1347 | else: |
| 1348 | self.result_string = '%s [no temp dir]' % error_type_str |
| 1349 | |
| 1350 | self.send_result_through_pipe(test, error_type) |
| 1351 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1352 | def addFailure(self, test, err): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1353 | """ |
| 1354 | Record a test failed result |
| 1355 | |
| 1356 | :param test: |
| 1357 | :param err: error message |
| 1358 | |
| 1359 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1360 | self.add_error(test, err, unittest.TestResult.addFailure, FAIL) |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1361 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1362 | def addError(self, test, err): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1363 | """ |
| 1364 | Record a test error result |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1365 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1366 | :param test: |
| 1367 | :param err: error message |
| 1368 | |
| 1369 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1370 | self.add_error(test, err, unittest.TestResult.addError, ERROR) |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1371 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1372 | def getDescription(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1373 | """ |
| 1374 | Get test description |
| 1375 | |
| 1376 | :param test: |
| 1377 | :returns: test description |
| 1378 | |
| 1379 | """ |
Ole Trøan | 5ba9159 | 2018-11-22 10:01:09 +0000 | [diff] [blame] | 1380 | return get_test_description(self.descriptions, test) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1381 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1382 | def startTest(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1383 | """ |
| 1384 | Start a test |
| 1385 | |
| 1386 | :param test: |
| 1387 | |
| 1388 | """ |
Paul Vinciguerra | dd3c5d2 | 2019-01-13 16:09:10 -0800 | [diff] [blame] | 1389 | |
| 1390 | def print_header(test): |
| 1391 | if not hasattr(test.__class__, '_header_printed'): |
| 1392 | print(double_line_delim) |
| 1393 | print(colorize(getdoc(test).splitlines()[0], GREEN)) |
| 1394 | print(double_line_delim) |
| 1395 | test.__class__._header_printed = True |
| 1396 | |
| 1397 | print_header(test) |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1398 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1399 | unittest.TestResult.startTest(self, test) |
| 1400 | if self.verbosity > 0: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1401 | self.stream.writeln( |
| 1402 | "Starting " + self.getDescription(test) + " ...") |
| 1403 | self.stream.writeln(single_line_delim) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1404 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1405 | def stopTest(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1406 | """ |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1407 | Called when the given test has been run |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1408 | |
| 1409 | :param test: |
| 1410 | |
| 1411 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1412 | unittest.TestResult.stopTest(self, test) |
| 1413 | if self.verbosity > 0: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1414 | self.stream.writeln(single_line_delim) |
Klement Sekera | 52e84f3 | 2017-01-13 07:25:25 +0100 | [diff] [blame] | 1415 | self.stream.writeln("%-73s%s" % (self.getDescription(test), |
Klement Sekera | da505f6 | 2017-01-04 12:58:53 +0100 | [diff] [blame] | 1416 | self.result_string)) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1417 | self.stream.writeln(single_line_delim) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1418 | else: |
Klement Sekera | 52e84f3 | 2017-01-13 07:25:25 +0100 | [diff] [blame] | 1419 | self.stream.writeln("%-73s%s" % (self.getDescription(test), |
Klement Sekera | da505f6 | 2017-01-04 12:58:53 +0100 | [diff] [blame] | 1420 | self.result_string)) |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1421 | |
| 1422 | self.send_result_through_pipe(test, TEST_RUN) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1423 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1424 | def printErrors(self): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1425 | """ |
| 1426 | Print errors from running the test case |
| 1427 | """ |
juraj.linkes | abec012 | 2018-11-16 17:28:56 +0100 | [diff] [blame] | 1428 | if len(self.errors) > 0 or len(self.failures) > 0: |
| 1429 | self.stream.writeln() |
| 1430 | self.printErrorList('ERROR', self.errors) |
| 1431 | self.printErrorList('FAIL', self.failures) |
| 1432 | |
| 1433 | # ^^ that is the last output from unittest before summary |
| 1434 | if not self.runner.print_summary: |
| 1435 | devnull = unittest.runner._WritelnDecorator(open(os.devnull, 'w')) |
| 1436 | self.stream = devnull |
| 1437 | self.runner.stream = devnull |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1438 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1439 | def printErrorList(self, flavour, errors): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1440 | """ |
| 1441 | Print error list to the output stream together with error type |
| 1442 | and test case description. |
| 1443 | |
| 1444 | :param flavour: error type |
| 1445 | :param errors: iterable errors |
| 1446 | |
| 1447 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1448 | for test, err in errors: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1449 | self.stream.writeln(double_line_delim) |
| 1450 | self.stream.writeln("%s: %s" % |
| 1451 | (flavour, self.getDescription(test))) |
| 1452 | self.stream.writeln(single_line_delim) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1453 | self.stream.writeln("%s" % err) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1454 | |
| 1455 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1456 | class VppTestRunner(unittest.TextTestRunner): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1457 | """ |
Klement Sekera | 104543f | 2017-02-03 07:29:43 +0100 | [diff] [blame] | 1458 | A basic test runner implementation which prints results to standard error. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1459 | """ |
Paul Vinciguerra | 6919b0d | 2018-12-09 15:37:04 -0800 | [diff] [blame] | 1460 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1461 | @property |
| 1462 | def resultclass(self): |
| 1463 | """Class maintaining the results of the tests""" |
| 1464 | return VppTestResult |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1465 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1466 | def __init__(self, keep_alive_pipe=None, descriptions=True, verbosity=1, |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1467 | result_pipe=None, failfast=False, buffer=False, |
Paul Vinciguerra | 9889402 | 2019-01-13 21:32:37 -0800 | [diff] [blame] | 1468 | resultclass=None, print_summary=True, **kwargs): |
Klement Sekera | 7a161da | 2017-01-17 13:42:48 +0100 | [diff] [blame] | 1469 | # ignore stream setting here, use hard-coded stdout to be in sync |
| 1470 | # with prints from VppTestCase methods ... |
| 1471 | super(VppTestRunner, self).__init__(sys.stdout, descriptions, |
| 1472 | verbosity, failfast, buffer, |
Paul Vinciguerra | 9889402 | 2019-01-13 21:32:37 -0800 | [diff] [blame] | 1473 | resultclass, **kwargs) |
juraj.linkes | ccfead6 | 2018-11-21 13:20:43 +0100 | [diff] [blame] | 1474 | KeepAliveReporter.pipe = keep_alive_pipe |
Klement Sekera | 104543f | 2017-02-03 07:29:43 +0100 | [diff] [blame] | 1475 | |
juraj.linkes | abec012 | 2018-11-16 17:28:56 +0100 | [diff] [blame] | 1476 | self.orig_stream = self.stream |
| 1477 | self.resultclass.test_framework_result_pipe = result_pipe |
| 1478 | |
| 1479 | self.print_summary = print_summary |
| 1480 | |
| 1481 | def _makeResult(self): |
| 1482 | return self.resultclass(self.stream, |
| 1483 | self.descriptions, |
| 1484 | self.verbosity, |
| 1485 | self) |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1486 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1487 | def run(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1488 | """ |
| 1489 | Run the tests |
| 1490 | |
| 1491 | :param test: |
| 1492 | |
| 1493 | """ |
Klement Sekera | 3658adc | 2017-06-07 08:19:47 +0200 | [diff] [blame] | 1494 | faulthandler.enable() # emit stack trace to stderr if killed by signal |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1495 | |
| 1496 | result = super(VppTestRunner, self).run(test) |
juraj.linkes | abec012 | 2018-11-16 17:28:56 +0100 | [diff] [blame] | 1497 | if not self.print_summary: |
| 1498 | self.stream = self.orig_stream |
| 1499 | result.stream = self.orig_stream |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1500 | return result |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1501 | |
| 1502 | |
| 1503 | class Worker(Thread): |
Paul Vinciguerra | 063366e | 2019-06-30 15:38:55 -0400 | [diff] [blame] | 1504 | def __init__(self, args, logger, env=None): |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1505 | self.logger = logger |
| 1506 | self.args = args |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 1507 | if hasattr(self, 'testcase') and self.testcase.debug_all: |
| 1508 | if self.testcase.debug_gdbserver: |
| 1509 | self.args = ['/usr/bin/gdbserver', 'localhost:{port}' |
| 1510 | .format(port=self.testcase.gdbserver_port)] + args |
| 1511 | elif self.testcase.debug_gdb and hasattr(self, 'wait_for_gdb'): |
| 1512 | self.args.append(self.wait_for_gdb) |
| 1513 | self.app_bin = args[0] |
| 1514 | self.app_name = os.path.basename(self.app_bin) |
| 1515 | if hasattr(self, 'role'): |
| 1516 | self.app_name += ' {role}'.format(role=self.role) |
Paul Vinciguerra | 063366e | 2019-06-30 15:38:55 -0400 | [diff] [blame] | 1517 | self.process = None |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1518 | self.result = None |
Paul Vinciguerra | 063366e | 2019-06-30 15:38:55 -0400 | [diff] [blame] | 1519 | env = {} if env is None else env |
Dave Wallace | 42996c0 | 2018-02-26 14:40:13 -0500 | [diff] [blame] | 1520 | self.env = copy.deepcopy(env) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1521 | super(Worker, self).__init__() |
| 1522 | |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 1523 | def wait_for_enter(self): |
| 1524 | if not hasattr(self, 'testcase'): |
| 1525 | return |
| 1526 | if self.testcase.debug_all and self.testcase.debug_gdbserver: |
| 1527 | print() |
| 1528 | print(double_line_delim) |
| 1529 | print("Spawned GDB Server for '{app}' with PID: {pid}" |
| 1530 | .format(app=self.app_name, pid=self.process.pid)) |
| 1531 | elif self.testcase.debug_all and self.testcase.debug_gdb: |
| 1532 | print() |
| 1533 | print(double_line_delim) |
| 1534 | print("Spawned '{app}' with PID: {pid}" |
| 1535 | .format(app=self.app_name, pid=self.process.pid)) |
| 1536 | else: |
| 1537 | return |
| 1538 | print(single_line_delim) |
| 1539 | print("You can debug '{app}' using:".format(app=self.app_name)) |
| 1540 | if self.testcase.debug_gdbserver: |
| 1541 | print("sudo gdb " + self.app_bin + |
| 1542 | " -ex 'target remote localhost:{port}'" |
| 1543 | .format(port=self.testcase.gdbserver_port)) |
| 1544 | print("Now is the time to attach gdb by running the above " |
| 1545 | "command, set up breakpoints etc., then resume from " |
| 1546 | "within gdb by issuing the 'continue' command") |
| 1547 | self.testcase.gdbserver_port += 1 |
| 1548 | elif self.testcase.debug_gdb: |
| 1549 | print("sudo gdb " + self.app_bin + |
| 1550 | " -ex 'attach {pid}'".format(pid=self.process.pid)) |
| 1551 | print("Now is the time to attach gdb by running the above " |
| 1552 | "command and set up breakpoints etc., then resume from" |
| 1553 | " within gdb by issuing the 'continue' command") |
| 1554 | print(single_line_delim) |
| 1555 | input("Press ENTER to continue running the testcase...") |
| 1556 | |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1557 | def run(self): |
| 1558 | executable = self.args[0] |
Paul Vinciguerra | 063366e | 2019-06-30 15:38:55 -0400 | [diff] [blame] | 1559 | if not os.path.exists(executable) or not os.access( |
| 1560 | executable, os.F_OK | os.X_OK): |
| 1561 | # Exit code that means some system file did not exist, |
| 1562 | # could not be opened, or had some other kind of error. |
| 1563 | self.result = os.EX_OSFILE |
| 1564 | raise EnvironmentError( |
| 1565 | "executable '%s' is not found or executable." % executable) |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 1566 | self.logger.debug("Running executable: '{app}'" |
| 1567 | .format(app=' '.join(self.args))) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1568 | env = os.environ.copy() |
Dave Wallace | cfcf2f4 | 2018-02-16 18:31:56 -0500 | [diff] [blame] | 1569 | env.update(self.env) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1570 | env["CK_LOG_FILE_NAME"] = "-" |
| 1571 | self.process = subprocess.Popen( |
| 1572 | self.args, shell=False, env=env, preexec_fn=os.setpgrp, |
| 1573 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 1574 | self.wait_for_enter() |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1575 | out, err = self.process.communicate() |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 1576 | self.logger.debug("Finished running `{app}'".format(app=self.app_name)) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1577 | self.logger.info("Return code is `%s'" % self.process.returncode) |
| 1578 | self.logger.info(single_line_delim) |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 1579 | self.logger.info("Executable `{app}' wrote to stdout:" |
| 1580 | .format(app=self.app_name)) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1581 | self.logger.info(single_line_delim) |
Dave Wallace | 97ea2f4 | 2019-10-29 19:12:03 -0400 | [diff] [blame] | 1582 | self.logger.info(out.decode('utf-8')) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1583 | self.logger.info(single_line_delim) |
Dave Wallace | 2456433 | 2019-10-21 02:53:14 +0000 | [diff] [blame] | 1584 | self.logger.info("Executable `{app}' wrote to stderr:" |
| 1585 | .format(app=self.app_name)) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1586 | self.logger.info(single_line_delim) |
Dave Wallace | 97ea2f4 | 2019-10-29 19:12:03 -0400 | [diff] [blame] | 1587 | self.logger.info(err.decode('utf-8')) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1588 | self.logger.info(single_line_delim) |
| 1589 | self.result = self.process.returncode |
Paul Vinciguerra | dd3c5d2 | 2019-01-13 16:09:10 -0800 | [diff] [blame] | 1590 | |
Klement Sekera | 6aa58b7 | 2019-05-16 14:34:55 +0200 | [diff] [blame] | 1591 | |
Paul Vinciguerra | dd3c5d2 | 2019-01-13 16:09:10 -0800 | [diff] [blame] | 1592 | if __name__ == '__main__': |
| 1593 | pass |