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 |
| 5 | import sys |
| 6 | import os |
| 7 | import select |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 8 | import unittest |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 9 | import tempfile |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 10 | import time |
Klement Sekera | 3658adc | 2017-06-07 08:19:47 +0200 | [diff] [blame] | 11 | import faulthandler |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 12 | import random |
Dave Wallace | 42996c0 | 2018-02-26 14:40:13 -0500 | [diff] [blame] | 13 | import copy |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 14 | import psutil |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 15 | from collections import deque |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 16 | from threading import Thread, Event |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 17 | from inspect import getdoc, isclass |
Klement Sekera | b91017a | 2017-02-09 06:04:36 +0100 | [diff] [blame] | 18 | from traceback import format_exception |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 19 | from logging import FileHandler, DEBUG, Formatter |
| 20 | from scapy.packet import Raw |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 21 | from hook import StepHook, PollHook, VppDiedError |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 22 | from vpp_pg_interface import VppPGInterface |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 23 | from vpp_sub_interface import VppSubInterface |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 24 | from vpp_lo_interface import VppLoInterface |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 25 | from vpp_papi_provider import VppPapiProvider |
Ole Troan | 7320210 | 2018-08-31 00:29:48 +0200 | [diff] [blame] | 26 | from vpp_papi.vpp_stats import VPPStats |
Klement Sekera | 0574226 | 2018-03-14 18:14:49 +0100 | [diff] [blame] | 27 | from log import RED, GREEN, YELLOW, double_line_delim, single_line_delim, \ |
juraj.linkes | dfb5f2a | 2018-11-09 11:58:54 +0100 | [diff] [blame] | 28 | get_logger, colorize |
Klement Sekera | 10db26f | 2017-01-11 08:16:53 +0100 | [diff] [blame] | 29 | from vpp_object import VppObjectRegistry |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 30 | from util import ppp, is_core_present |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 31 | from scapy.layers.inet import IPerror, TCPerror, UDPerror, ICMPerror |
| 32 | from scapy.layers.inet6 import ICMPv6DestUnreach, ICMPv6EchoRequest |
| 33 | from scapy.layers.inet6 import ICMPv6EchoReply |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 34 | if os.name == 'posix' and sys.version_info[0] < 3: |
| 35 | # using subprocess32 is recommended by python official documentation |
| 36 | # @ https://docs.python.org/2/library/subprocess.html |
| 37 | import subprocess32 as subprocess |
| 38 | else: |
| 39 | import subprocess |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 40 | |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 41 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 42 | PASS = 0 |
| 43 | FAIL = 1 |
| 44 | ERROR = 2 |
| 45 | SKIP = 3 |
| 46 | TEST_RUN = 4 |
| 47 | |
| 48 | |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 49 | debug_framework = False |
| 50 | if os.getenv('TEST_DEBUG', "0") == "1": |
| 51 | debug_framework = True |
| 52 | import debug_internal |
| 53 | |
| 54 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 55 | """ |
| 56 | Test framework module. |
| 57 | |
| 58 | The module provides a set of tools for constructing and running tests and |
| 59 | representing the results. |
| 60 | """ |
| 61 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 62 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 63 | class _PacketInfo(object): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 64 | """Private class to create packet info object. |
| 65 | |
| 66 | Help process information about the next packet. |
| 67 | Set variables to default values. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 68 | """ |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 69 | #: Store the index of the packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 70 | index = -1 |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 71 | #: Store the index of the source packet generator interface of the packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 72 | src = -1 |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 73 | #: Store the index of the destination packet generator interface |
| 74 | #: of the packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 75 | dst = -1 |
Pavel Kotucek | 59dda06 | 2017-03-02 15:22:47 +0100 | [diff] [blame] | 76 | #: Store expected ip version |
| 77 | ip = -1 |
| 78 | #: Store expected upper protocol |
| 79 | proto = -1 |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 80 | #: Store the copy of the former packet. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 81 | data = None |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 82 | |
Matej Klotton | 16a14cd | 2016-12-07 15:09:13 +0100 | [diff] [blame] | 83 | def __eq__(self, other): |
| 84 | index = self.index == other.index |
| 85 | src = self.src == other.src |
| 86 | dst = self.dst == other.dst |
| 87 | data = self.data == other.data |
| 88 | return index and src and dst and data |
| 89 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 90 | |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 91 | def pump_output(testclass): |
| 92 | """ pump output from vpp stdout/stderr to proper queues """ |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 93 | stdout_fragment = "" |
| 94 | stderr_fragment = "" |
Neale Ranns | 1678236 | 2018-07-23 05:35:56 -0400 | [diff] [blame] | 95 | while not testclass.pump_thread_stop_flag.is_set(): |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 96 | readable = select.select([testclass.vpp.stdout.fileno(), |
| 97 | testclass.vpp.stderr.fileno(), |
| 98 | testclass.pump_thread_wakeup_pipe[0]], |
| 99 | [], [])[0] |
| 100 | if testclass.vpp.stdout.fileno() in readable: |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 101 | read = os.read(testclass.vpp.stdout.fileno(), 102400) |
| 102 | if len(read) > 0: |
| 103 | split = read.splitlines(True) |
| 104 | if len(stdout_fragment) > 0: |
| 105 | split[0] = "%s%s" % (stdout_fragment, split[0]) |
| 106 | if len(split) > 0 and split[-1].endswith("\n"): |
| 107 | limit = None |
| 108 | else: |
| 109 | limit = -1 |
| 110 | stdout_fragment = split[-1] |
| 111 | testclass.vpp_stdout_deque.extend(split[:limit]) |
| 112 | if not testclass.cache_vpp_output: |
| 113 | for line in split[:limit]: |
| 114 | testclass.logger.debug( |
| 115 | "VPP STDOUT: %s" % line.rstrip("\n")) |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 116 | if testclass.vpp.stderr.fileno() in readable: |
Klement Sekera | 6a6f4f7 | 2017-11-09 09:16:39 +0100 | [diff] [blame] | 117 | read = os.read(testclass.vpp.stderr.fileno(), 102400) |
| 118 | if len(read) > 0: |
| 119 | split = read.splitlines(True) |
| 120 | if len(stderr_fragment) > 0: |
| 121 | split[0] = "%s%s" % (stderr_fragment, split[0]) |
| 122 | if len(split) > 0 and split[-1].endswith("\n"): |
| 123 | limit = None |
| 124 | else: |
| 125 | limit = -1 |
| 126 | stderr_fragment = split[-1] |
| 127 | testclass.vpp_stderr_deque.extend(split[:limit]) |
| 128 | if not testclass.cache_vpp_output: |
| 129 | for line in split[:limit]: |
| 130 | testclass.logger.debug( |
| 131 | "VPP STDERR: %s" % line.rstrip("\n")) |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 132 | # ignoring the dummy pipe here intentionally - the flag will take care |
| 133 | # of properly terminating the loop |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 134 | |
| 135 | |
Klement Sekera | 8713493 | 2017-03-07 11:39:27 +0100 | [diff] [blame] | 136 | def running_extended_tests(): |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 137 | s = os.getenv("EXTENDED_TESTS", "n") |
| 138 | return True if s.lower() in ("y", "yes", "1") else False |
Klement Sekera | 8713493 | 2017-03-07 11:39:27 +0100 | [diff] [blame] | 139 | |
| 140 | |
Klement Sekera | d3e671e | 2017-09-29 12:36:37 +0200 | [diff] [blame] | 141 | def running_on_centos(): |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 142 | os_id = os.getenv("OS_ID", "") |
| 143 | return True if "centos" in os_id.lower() else False |
Klement Sekera | d3e671e | 2017-09-29 12:36:37 +0200 | [diff] [blame] | 144 | |
| 145 | |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 146 | class KeepAliveReporter(object): |
| 147 | """ |
| 148 | Singleton object which reports test start to parent process |
| 149 | """ |
| 150 | _shared_state = {} |
| 151 | |
| 152 | def __init__(self): |
| 153 | self.__dict__ = self._shared_state |
Paul Vinciguerra | c7b03fe | 2018-11-18 08:17:34 -0800 | [diff] [blame] | 154 | self._pipe = None |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 155 | |
| 156 | @property |
| 157 | def pipe(self): |
| 158 | return self._pipe |
| 159 | |
| 160 | @pipe.setter |
| 161 | def pipe(self, pipe): |
Paul Vinciguerra | c7b03fe | 2018-11-18 08:17:34 -0800 | [diff] [blame] | 162 | if self._pipe is not None: |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 163 | raise Exception("Internal error - pipe should only be set once.") |
| 164 | self._pipe = pipe |
| 165 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 166 | def send_keep_alive(self, test, desc=None): |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 167 | """ |
| 168 | Write current test tmpdir & desc to keep-alive pipe to signal liveness |
| 169 | """ |
Klement Sekera | 3f6ff19 | 2017-08-11 06:56:05 +0200 | [diff] [blame] | 170 | if self.pipe is None: |
| 171 | # if not running forked.. |
| 172 | return |
| 173 | |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 174 | if isclass(test): |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 175 | desc = '%s (%s)' % (desc, unittest.util.strclass(test)) |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 176 | else: |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 177 | desc = test.id() |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 178 | |
Dave Wallace | e2efd12 | 2017-09-30 22:04:21 -0400 | [diff] [blame] | 179 | self.pipe.send((desc, test.vpp_bin, test.tempdir, test.vpp.pid)) |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 180 | |
| 181 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 182 | class VppTestCase(unittest.TestCase): |
Matej Klotton | 86d87c4 | 2016-11-11 11:38:55 +0100 | [diff] [blame] | 183 | """This subclass is a base class for VPP test cases that are implemented as |
| 184 | classes. It provides methods to create and run test case. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 185 | """ |
| 186 | |
| 187 | @property |
| 188 | def packet_infos(self): |
| 189 | """List of packet infos""" |
| 190 | return self._packet_infos |
| 191 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 192 | @classmethod |
| 193 | def get_packet_count_for_if_idx(cls, dst_if_index): |
| 194 | """Get the number of packet info for specified destination if index""" |
| 195 | if dst_if_index in cls._packet_count_for_dst_if_idx: |
| 196 | return cls._packet_count_for_dst_if_idx[dst_if_index] |
| 197 | else: |
| 198 | return 0 |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 199 | |
| 200 | @classmethod |
| 201 | def instance(cls): |
| 202 | """Return the instance of this testcase""" |
| 203 | return cls.test_instance |
| 204 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 205 | @classmethod |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 206 | def set_debug_flags(cls, d): |
| 207 | cls.debug_core = False |
| 208 | cls.debug_gdb = False |
| 209 | cls.debug_gdbserver = False |
| 210 | if d is None: |
| 211 | return |
| 212 | dl = d.lower() |
| 213 | if dl == "core": |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 214 | cls.debug_core = True |
| 215 | elif dl == "gdb": |
| 216 | cls.debug_gdb = True |
| 217 | elif dl == "gdbserver": |
| 218 | cls.debug_gdbserver = True |
| 219 | else: |
| 220 | raise Exception("Unrecognized DEBUG option: '%s'" % d) |
| 221 | |
| 222 | @classmethod |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 223 | def get_least_used_cpu(self): |
| 224 | cpu_usage_list = [set(range(psutil.cpu_count()))] |
| 225 | vpp_processes = [p for p in psutil.process_iter(attrs=['pid', 'name']) |
| 226 | if 'vpp_main' == p.info['name']] |
| 227 | for vpp_process in vpp_processes: |
| 228 | for cpu_usage_set in cpu_usage_list: |
| 229 | try: |
| 230 | cpu_num = vpp_process.cpu_num() |
| 231 | if cpu_num in cpu_usage_set: |
| 232 | cpu_usage_set_index = cpu_usage_list.index( |
| 233 | cpu_usage_set) |
| 234 | if cpu_usage_set_index == len(cpu_usage_list) - 1: |
| 235 | cpu_usage_list.append({cpu_num}) |
| 236 | else: |
| 237 | cpu_usage_list[cpu_usage_set_index + 1].add( |
| 238 | cpu_num) |
| 239 | cpu_usage_set.remove(cpu_num) |
| 240 | break |
| 241 | except psutil.NoSuchProcess: |
| 242 | pass |
| 243 | |
| 244 | for cpu_usage_set in cpu_usage_list: |
| 245 | if len(cpu_usage_set) > 0: |
| 246 | min_usage_set = cpu_usage_set |
| 247 | break |
| 248 | |
| 249 | return random.choice(tuple(min_usage_set)) |
| 250 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 251 | @staticmethod |
| 252 | def print_header(cls): |
| 253 | if not hasattr(cls, '_header_printed'): |
| 254 | print(double_line_delim) |
| 255 | print(colorize(getdoc(cls).splitlines()[0], GREEN)) |
| 256 | print(double_line_delim) |
| 257 | cls._header_printed = True |
| 258 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 259 | @classmethod |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 260 | def setUpConstants(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 261 | """ Set-up the test case class based on environment variables """ |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 262 | s = os.getenv("STEP", "n") |
| 263 | cls.step = True if s.lower() in ("y", "yes", "1") else False |
| 264 | d = os.getenv("DEBUG", None) |
| 265 | c = os.getenv("CACHE_OUTPUT", "1") |
| 266 | 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] | 267 | cls.set_debug_flags(d) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 268 | cls.vpp_bin = os.getenv('VPP_TEST_BIN', "vpp") |
Pierre Pfister | cd8e318 | 2016-10-07 16:30:03 +0100 | [diff] [blame] | 269 | cls.plugin_path = os.getenv('VPP_TEST_PLUGIN_PATH') |
Klement Sekera | 47e275b | 2017-03-21 08:21:25 +0100 | [diff] [blame] | 270 | cls.extern_plugin_path = os.getenv('EXTERN_PLUGINS') |
| 271 | plugin_path = None |
| 272 | if cls.plugin_path is not None: |
| 273 | if cls.extern_plugin_path is not None: |
| 274 | plugin_path = "%s:%s" % ( |
| 275 | cls.plugin_path, cls.extern_plugin_path) |
Klement Sekera | 6abbc28 | 2017-03-24 05:47:15 +0100 | [diff] [blame] | 276 | else: |
| 277 | plugin_path = cls.plugin_path |
Klement Sekera | 47e275b | 2017-03-21 08:21:25 +0100 | [diff] [blame] | 278 | elif cls.extern_plugin_path is not None: |
| 279 | plugin_path = cls.extern_plugin_path |
Klement Sekera | 01bbbe9 | 2016-11-02 09:25:05 +0100 | [diff] [blame] | 280 | debug_cli = "" |
| 281 | if cls.step or cls.debug_gdb or cls.debug_gdbserver: |
| 282 | debug_cli = "cli-listen localhost:5002" |
Klement Sekera | 80a7f0a | 2017-03-02 11:27:11 +0100 | [diff] [blame] | 283 | coredump_size = None |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 284 | size = os.getenv("COREDUMP_SIZE") |
| 285 | if size is not None: |
| 286 | coredump_size = "coredump-size %s" % size |
Klement Sekera | 80a7f0a | 2017-03-02 11:27:11 +0100 | [diff] [blame] | 287 | if coredump_size is None: |
Dave Wallace | e2efd12 | 2017-09-30 22:04:21 -0400 | [diff] [blame] | 288 | coredump_size = "coredump-size unlimited" |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 289 | |
| 290 | cpu_core_number = cls.get_least_used_cpu() |
| 291 | |
Klement Sekera | 80a7f0a | 2017-03-02 11:27:11 +0100 | [diff] [blame] | 292 | cls.vpp_cmdline = [cls.vpp_bin, "unix", |
Dave Wallace | e2efd12 | 2017-09-30 22:04:21 -0400 | [diff] [blame] | 293 | "{", "nodaemon", debug_cli, "full-coredump", |
Jakub Grajciar | 9974391 | 2018-10-09 12:28:21 +0200 | [diff] [blame] | 294 | coredump_size, "runtime-dir", cls.tempdir, "}", |
| 295 | "api-trace", "{", "on", "}", "api-segment", "{", |
| 296 | "prefix", cls.shm_prefix, "}", "cpu", "{", |
| 297 | "main-core", str(cpu_core_number), "}", "statseg", |
| 298 | "{", "socket-name", cls.stats_sock, "}", "plugins", |
| 299 | "{", "plugin", "dpdk_plugin.so", "{", "disable", |
| 300 | "}", "plugin", "unittest_plugin.so", "{", "enable", |
| 301 | "}", "}", ] |
Klement Sekera | 47e275b | 2017-03-21 08:21:25 +0100 | [diff] [blame] | 302 | if plugin_path is not None: |
| 303 | cls.vpp_cmdline.extend(["plugin_path", plugin_path]) |
Klement Sekera | f37c3ba | 2018-11-08 11:24:34 +0100 | [diff] [blame] | 304 | cls.logger.info("vpp_cmdline args: %s" % cls.vpp_cmdline) |
| 305 | cls.logger.info("vpp_cmdline: %s" % " ".join(cls.vpp_cmdline)) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 306 | |
| 307 | @classmethod |
| 308 | def wait_for_enter(cls): |
| 309 | if cls.debug_gdbserver: |
| 310 | print(double_line_delim) |
| 311 | print("Spawned GDB server with PID: %d" % cls.vpp.pid) |
| 312 | elif cls.debug_gdb: |
| 313 | print(double_line_delim) |
| 314 | print("Spawned VPP with PID: %d" % cls.vpp.pid) |
| 315 | else: |
| 316 | cls.logger.debug("Spawned VPP with PID: %d" % cls.vpp.pid) |
| 317 | return |
| 318 | print(single_line_delim) |
| 319 | print("You can debug the VPP using e.g.:") |
| 320 | if cls.debug_gdbserver: |
| 321 | print("gdb " + cls.vpp_bin + " -ex 'target remote localhost:7777'") |
| 322 | print("Now is the time to attach a gdb by running the above " |
| 323 | "command, set up breakpoints etc. and then resume VPP from " |
| 324 | "within gdb by issuing the 'continue' command") |
| 325 | elif cls.debug_gdb: |
| 326 | print("gdb " + cls.vpp_bin + " -ex 'attach %s'" % cls.vpp.pid) |
| 327 | print("Now is the time to attach a gdb by running the above " |
| 328 | "command and set up breakpoints etc.") |
| 329 | print(single_line_delim) |
Klement Sekera | e1ace19 | 2018-03-23 21:54:12 +0100 | [diff] [blame] | 330 | raw_input("Press ENTER to continue running the testcase...") |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 331 | |
| 332 | @classmethod |
| 333 | def run_vpp(cls): |
| 334 | cmdline = cls.vpp_cmdline |
| 335 | |
| 336 | if cls.debug_gdbserver: |
Klement Sekera | 931be3a | 2016-11-03 05:36:01 +0100 | [diff] [blame] | 337 | gdbserver = '/usr/bin/gdbserver' |
| 338 | if not os.path.isfile(gdbserver) or \ |
| 339 | not os.access(gdbserver, os.X_OK): |
| 340 | raise Exception("gdbserver binary '%s' does not exist or is " |
| 341 | "not executable" % gdbserver) |
| 342 | |
| 343 | cmdline = [gdbserver, 'localhost:7777'] + cls.vpp_cmdline |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 344 | cls.logger.info("Gdbserver cmdline is %s", " ".join(cmdline)) |
| 345 | |
Klement Sekera | 931be3a | 2016-11-03 05:36:01 +0100 | [diff] [blame] | 346 | try: |
| 347 | cls.vpp = subprocess.Popen(cmdline, |
| 348 | stdout=subprocess.PIPE, |
| 349 | stderr=subprocess.PIPE, |
| 350 | bufsize=1) |
| 351 | except Exception as e: |
| 352 | cls.logger.critical("Couldn't start vpp: %s" % e) |
| 353 | raise |
| 354 | |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 355 | cls.wait_for_enter() |
Pierre Pfister | cd8e318 | 2016-10-07 16:30:03 +0100 | [diff] [blame] | 356 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 357 | @classmethod |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 358 | def wait_for_stats_socket(cls): |
| 359 | deadline = time.time() + 3 |
Paul Vinciguerra | dd4b2bb | 2018-11-15 08:13:03 -0800 | [diff] [blame] | 360 | ok = False |
| 361 | while time.time() < deadline or \ |
| 362 | cls.debug_gdb or cls.debug_gdbserver: |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 363 | if os.path.exists(cls.stats_sock): |
Paul Vinciguerra | dd4b2bb | 2018-11-15 08:13:03 -0800 | [diff] [blame] | 364 | ok = True |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 365 | break |
Paul Vinciguerra | dd4b2bb | 2018-11-15 08:13:03 -0800 | [diff] [blame] | 366 | time.sleep(0.8) |
| 367 | if not ok: |
| 368 | cls.logger.critical("Couldn't stat : {}".format(cls.stats_sock)) |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 369 | |
| 370 | @classmethod |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 371 | def setUpClass(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 372 | """ |
| 373 | Perform class setup before running the testcase |
| 374 | Remove shared memory files, start vpp and connect the vpp-api |
| 375 | """ |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 376 | gc.collect() # run garbage collection first |
Klement Sekera | 96867ba | 2018-02-02 11:27:53 +0100 | [diff] [blame] | 377 | random.seed() |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 378 | cls.print_header(cls) |
juraj.linkes | dfb5f2a | 2018-11-09 11:58:54 +0100 | [diff] [blame] | 379 | cls.logger = get_logger(cls.__name__) |
| 380 | if hasattr(cls, 'parallel_handler'): |
| 381 | cls.logger.addHandler(cls.parallel_handler) |
juraj.linkes | 3d9b92a | 2018-11-21 13:13:39 +0100 | [diff] [blame^] | 382 | cls.logger.propagate = False |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 383 | cls.tempdir = tempfile.mkdtemp( |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 384 | prefix='vpp-unittest-%s-' % cls.__name__) |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 385 | cls.stats_sock = "%s/stats.sock" % cls.tempdir |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 386 | cls.file_handler = FileHandler("%s/log.txt" % cls.tempdir) |
| 387 | cls.file_handler.setFormatter( |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 388 | Formatter(fmt='%(asctime)s,%(msecs)03d %(message)s', |
| 389 | datefmt="%H:%M:%S")) |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 390 | cls.file_handler.setLevel(DEBUG) |
| 391 | cls.logger.addHandler(cls.file_handler) |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 392 | cls.shm_prefix = os.path.basename(cls.tempdir) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 393 | os.chdir(cls.tempdir) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 394 | cls.logger.info("Temporary dir is %s, shm prefix is %s", |
| 395 | cls.tempdir, cls.shm_prefix) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 396 | cls.setUpConstants() |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 397 | cls.reset_packet_infos() |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 398 | cls._captures = [] |
| 399 | cls._zombie_captures = [] |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 400 | cls.verbose = 0 |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 401 | cls.vpp_dead = False |
Klement Sekera | 10db26f | 2017-01-11 08:16:53 +0100 | [diff] [blame] | 402 | cls.registry = VppObjectRegistry() |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 403 | cls.vpp_startup_failed = False |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 404 | cls.reporter = KeepAliveReporter() |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 405 | # need to catch exceptions here because if we raise, then the cleanup |
| 406 | # doesn't get called and we might end with a zombie vpp |
| 407 | try: |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 408 | cls.run_vpp() |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 409 | cls.reporter.send_keep_alive(cls, 'setUpClass') |
| 410 | VppTestResult.current_test_case_info = TestCaseInfo( |
| 411 | cls.logger, cls.tempdir, cls.vpp.pid, cls.vpp_bin) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 412 | cls.vpp_stdout_deque = deque() |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 413 | cls.vpp_stderr_deque = deque() |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 414 | cls.pump_thread_stop_flag = Event() |
| 415 | cls.pump_thread_wakeup_pipe = os.pipe() |
| 416 | cls.pump_thread = Thread(target=pump_output, args=(cls,)) |
Klement Sekera | aeeac3b | 2017-02-14 07:11:52 +0100 | [diff] [blame] | 417 | cls.pump_thread.daemon = True |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 418 | cls.pump_thread.start() |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 419 | if cls.debug_gdb or cls.debug_gdbserver: |
| 420 | read_timeout = 0 |
| 421 | else: |
| 422 | read_timeout = 5 |
| 423 | cls.vapi = VppPapiProvider(cls.shm_prefix, cls.shm_prefix, cls, |
| 424 | read_timeout) |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 425 | if cls.step: |
| 426 | hook = StepHook(cls) |
| 427 | else: |
| 428 | hook = PollHook(cls) |
| 429 | cls.vapi.register_hook(hook) |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 430 | cls.wait_for_stats_socket() |
| 431 | cls.statistics = VPPStats(socketname=cls.stats_sock) |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 432 | try: |
| 433 | hook.poll_vpp() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 434 | except VppDiedError: |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 435 | cls.vpp_startup_failed = True |
| 436 | cls.logger.critical( |
| 437 | "VPP died shortly after startup, check the" |
| 438 | " output to standard error for possible cause") |
| 439 | raise |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 440 | try: |
| 441 | cls.vapi.connect() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 442 | except Exception: |
Klement Sekera | 4c53313 | 2018-02-22 11:41:12 +0100 | [diff] [blame] | 443 | try: |
| 444 | cls.vapi.disconnect() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 445 | except Exception: |
Klement Sekera | 4c53313 | 2018-02-22 11:41:12 +0100 | [diff] [blame] | 446 | pass |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 447 | if cls.debug_gdbserver: |
| 448 | print(colorize("You're running VPP inside gdbserver but " |
| 449 | "VPP-API connection failed, did you forget " |
| 450 | "to 'continue' VPP from within gdb?", RED)) |
| 451 | raise |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 452 | except Exception: |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 453 | try: |
| 454 | cls.quit() |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 455 | except Exception: |
Klement Sekera | 085f5c0 | 2016-11-24 01:59:16 +0100 | [diff] [blame] | 456 | pass |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 457 | raise |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 458 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 459 | @classmethod |
| 460 | def quit(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 461 | """ |
| 462 | Disconnect vpp-api, kill vpp and cleanup shared memory files |
| 463 | """ |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 464 | if (cls.debug_gdbserver or cls.debug_gdb) and hasattr(cls, 'vpp'): |
| 465 | cls.vpp.poll() |
| 466 | if cls.vpp.returncode is None: |
| 467 | print(double_line_delim) |
| 468 | print("VPP or GDB server is still running") |
| 469 | print(single_line_delim) |
Klement Sekera | e1ace19 | 2018-03-23 21:54:12 +0100 | [diff] [blame] | 470 | raw_input("When done debugging, press ENTER to kill the " |
| 471 | "process and finish running the testcase...") |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 472 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 473 | # first signal that we want to stop the pump thread, then wake it up |
| 474 | if hasattr(cls, 'pump_thread_stop_flag'): |
| 475 | cls.pump_thread_stop_flag.set() |
| 476 | if hasattr(cls, 'pump_thread_wakeup_pipe'): |
| 477 | os.write(cls.pump_thread_wakeup_pipe[1], 'ding dong wake up') |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 478 | if hasattr(cls, 'pump_thread'): |
| 479 | cls.logger.debug("Waiting for pump thread to stop") |
| 480 | cls.pump_thread.join() |
| 481 | if hasattr(cls, 'vpp_stderr_reader_thread'): |
| 482 | cls.logger.debug("Waiting for stdderr pump to stop") |
| 483 | cls.vpp_stderr_reader_thread.join() |
| 484 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 485 | if hasattr(cls, 'vpp'): |
Klement Sekera | 0529a74 | 2016-12-02 07:05:24 +0100 | [diff] [blame] | 486 | if hasattr(cls, 'vapi'): |
| 487 | cls.vapi.disconnect() |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 488 | del cls.vapi |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 489 | cls.vpp.poll() |
| 490 | if cls.vpp.returncode is None: |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 491 | cls.logger.debug("Sending TERM to vpp") |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 492 | cls.vpp.kill() |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 493 | cls.logger.debug("Waiting for vpp to die") |
| 494 | cls.vpp.communicate() |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 495 | del cls.vpp |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 496 | |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 497 | if cls.vpp_startup_failed: |
| 498 | stdout_log = cls.logger.info |
| 499 | stderr_log = cls.logger.critical |
| 500 | else: |
| 501 | stdout_log = cls.logger.info |
| 502 | stderr_log = cls.logger.info |
| 503 | |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 504 | if hasattr(cls, 'vpp_stdout_deque'): |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 505 | stdout_log(single_line_delim) |
| 506 | stdout_log('VPP output to stdout while running %s:', cls.__name__) |
| 507 | stdout_log(single_line_delim) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 508 | vpp_output = "".join(cls.vpp_stdout_deque) |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 509 | with open(cls.tempdir + '/vpp_stdout.txt', 'w') as f: |
| 510 | f.write(vpp_output) |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 511 | stdout_log('\n%s', vpp_output) |
| 512 | stdout_log(single_line_delim) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 513 | |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 514 | if hasattr(cls, 'vpp_stderr_deque'): |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 515 | stderr_log(single_line_delim) |
| 516 | stderr_log('VPP output to stderr while running %s:', cls.__name__) |
| 517 | stderr_log(single_line_delim) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 518 | vpp_output = "".join(cls.vpp_stderr_deque) |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 519 | with open(cls.tempdir + '/vpp_stderr.txt', 'w') as f: |
| 520 | f.write(vpp_output) |
Klement Sekera | 3747c75 | 2017-04-10 06:30:17 +0200 | [diff] [blame] | 521 | stderr_log('\n%s', vpp_output) |
| 522 | stderr_log(single_line_delim) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 523 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 524 | @classmethod |
| 525 | def tearDownClass(cls): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 526 | """ Perform final cleanup after running all tests in this test-case """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 527 | cls.reporter.send_keep_alive(cls, 'tearDownClass') |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 528 | cls.quit() |
Klement Sekera | 027dbd5 | 2017-04-11 06:01:53 +0200 | [diff] [blame] | 529 | cls.file_handler.close() |
Klement Sekera | ebbaf55 | 2018-02-17 13:41:33 +0100 | [diff] [blame] | 530 | cls.reset_packet_infos() |
| 531 | if debug_framework: |
| 532 | debug_internal.on_tear_down_class(cls) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 533 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 534 | def tearDown(self): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 535 | """ Show various debug prints after each test """ |
Klement Sekera | b91017a | 2017-02-09 06:04:36 +0100 | [diff] [blame] | 536 | self.logger.debug("--- tearDown() for %s.%s(%s) called ---" % |
| 537 | (self.__class__.__name__, self._testMethodName, |
| 538 | self._testMethodDoc)) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 539 | if not self.vpp_dead: |
Jan | 49c0fca | 2016-10-26 15:44:27 +0200 | [diff] [blame] | 540 | self.logger.debug(self.vapi.cli("show trace")) |
Neale Ranns | 88fc83e | 2017-04-05 08:11:14 -0700 | [diff] [blame] | 541 | self.logger.info(self.vapi.ppcli("show interface")) |
Jan | 49c0fca | 2016-10-26 15:44:27 +0200 | [diff] [blame] | 542 | self.logger.info(self.vapi.ppcli("show hardware")) |
Ole Troan | 7320210 | 2018-08-31 00:29:48 +0200 | [diff] [blame] | 543 | self.logger.info(self.statistics.set_errors_str()) |
Jan | 49c0fca | 2016-10-26 15:44:27 +0200 | [diff] [blame] | 544 | self.logger.info(self.vapi.ppcli("show run")) |
Damjan Marion | 07a3857 | 2018-01-21 06:44:18 -0800 | [diff] [blame] | 545 | self.logger.info(self.vapi.ppcli("show log")) |
Klement Sekera | 10db26f | 2017-01-11 08:16:53 +0100 | [diff] [blame] | 546 | self.registry.remove_vpp_config(self.logger) |
Dave Wallace | 90c5572 | 2017-02-16 11:25:26 -0500 | [diff] [blame] | 547 | # Save/Dump VPP api trace log |
| 548 | api_trace = "vpp_api_trace.%s.log" % self._testMethodName |
| 549 | tmp_api_trace = "/tmp/%s" % api_trace |
| 550 | vpp_api_trace_log = "%s/%s" % (self.tempdir, api_trace) |
| 551 | self.logger.info(self.vapi.ppcli("api trace save %s" % api_trace)) |
| 552 | self.logger.info("Moving %s to %s\n" % (tmp_api_trace, |
| 553 | vpp_api_trace_log)) |
| 554 | os.rename(tmp_api_trace, vpp_api_trace_log) |
Dave Wallace | 5ba5837 | 2018-02-13 16:14:06 -0500 | [diff] [blame] | 555 | self.logger.info(self.vapi.ppcli("api trace custom-dump %s" % |
Dave Wallace | 90c5572 | 2017-02-16 11:25:26 -0500 | [diff] [blame] | 556 | vpp_api_trace_log)) |
Klement Sekera | 1b68640 | 2017-03-02 11:29:19 +0100 | [diff] [blame] | 557 | else: |
| 558 | self.registry.unregister_all(self.logger) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 559 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 560 | def setUp(self): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 561 | """ Clear trace before running each test""" |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 562 | self.reporter.send_keep_alive(self) |
Klement Sekera | b91017a | 2017-02-09 06:04:36 +0100 | [diff] [blame] | 563 | self.logger.debug("--- setUp() for %s.%s(%s) called ---" % |
| 564 | (self.__class__.__name__, self._testMethodName, |
| 565 | self._testMethodDoc)) |
Klement Sekera | 0c1519b | 2016-12-08 05:03:32 +0100 | [diff] [blame] | 566 | if self.vpp_dead: |
| 567 | raise Exception("VPP is dead when setting up the test") |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 568 | self.sleep(.1, "during setUp") |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 569 | self.vpp_stdout_deque.append( |
| 570 | "--- test setUp() for %s.%s(%s) starts here ---\n" % |
| 571 | (self.__class__.__name__, self._testMethodName, |
| 572 | self._testMethodDoc)) |
| 573 | self.vpp_stderr_deque.append( |
| 574 | "--- test setUp() for %s.%s(%s) starts here ---\n" % |
| 575 | (self.__class__.__name__, self._testMethodName, |
| 576 | self._testMethodDoc)) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 577 | self.vapi.cli("clear trace") |
| 578 | # store the test instance inside the test class - so that objects |
| 579 | # holding the class can access instance methods (like assertEqual) |
| 580 | type(self).test_instance = self |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 581 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 582 | @classmethod |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 583 | def pg_enable_capture(cls, interfaces=None): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 584 | """ |
| 585 | Enable capture on packet-generator interfaces |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 586 | |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 587 | :param interfaces: iterable interface indexes (if None, |
| 588 | use self.pg_interfaces) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 589 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 590 | """ |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 591 | if interfaces is None: |
| 592 | interfaces = cls.pg_interfaces |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 593 | for i in interfaces: |
| 594 | i.enable_capture() |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 595 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 596 | @classmethod |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 597 | def register_capture(cls, cap_name): |
| 598 | """ Register a capture in the testclass """ |
| 599 | # add to the list of captures with current timestamp |
| 600 | cls._captures.append((time.time(), cap_name)) |
| 601 | # filter out from zombies |
| 602 | cls._zombie_captures = [(stamp, name) |
| 603 | for (stamp, name) in cls._zombie_captures |
| 604 | if name != cap_name] |
| 605 | |
| 606 | @classmethod |
| 607 | def pg_start(cls): |
| 608 | """ Remove any zombie captures and enable the packet generator """ |
| 609 | # how long before capture is allowed to be deleted - otherwise vpp |
| 610 | # crashes - 100ms seems enough (this shouldn't be needed at all) |
| 611 | capture_ttl = 0.1 |
| 612 | now = time.time() |
| 613 | for stamp, cap_name in cls._zombie_captures: |
| 614 | wait = stamp + capture_ttl - now |
| 615 | if wait > 0: |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 616 | cls.sleep(wait, "before deleting capture %s" % cap_name) |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 617 | now = time.time() |
| 618 | cls.logger.debug("Removing zombie capture %s" % cap_name) |
| 619 | cls.vapi.cli('packet-generator delete %s' % cap_name) |
| 620 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 621 | cls.vapi.cli("trace add pg-input 50") # 50 is maximum |
| 622 | cls.vapi.cli('packet-generator enable') |
Klement Sekera | 9225dee | 2016-12-12 08:36:58 +0100 | [diff] [blame] | 623 | cls._zombie_captures = cls._captures |
| 624 | cls._captures = [] |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 625 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 626 | @classmethod |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 627 | def create_pg_interfaces(cls, interfaces): |
| 628 | """ |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 629 | Create packet-generator interfaces. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 630 | |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 631 | :param interfaces: iterable indexes of the interfaces. |
| 632 | :returns: List of created interfaces. |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 633 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 634 | """ |
| 635 | result = [] |
| 636 | for i in interfaces: |
| 637 | intf = VppPGInterface(cls, i) |
| 638 | setattr(cls, intf.name, intf) |
| 639 | result.append(intf) |
| 640 | cls.pg_interfaces = result |
| 641 | return result |
| 642 | |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 643 | @classmethod |
Klement Sekera | b9ef273 | 2018-06-24 22:49:33 +0200 | [diff] [blame] | 644 | def create_loopback_interfaces(cls, count): |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 645 | """ |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 646 | Create loopback interfaces. |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 647 | |
Klement Sekera | b9ef273 | 2018-06-24 22:49:33 +0200 | [diff] [blame] | 648 | :param count: number of interfaces created. |
Matej Klotton | 8d8a1da | 2016-12-22 11:06:56 +0100 | [diff] [blame] | 649 | :returns: List of created interfaces. |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 650 | """ |
Klement Sekera | b9ef273 | 2018-06-24 22:49:33 +0200 | [diff] [blame] | 651 | result = [VppLoInterface(cls) for i in range(count)] |
| 652 | for intf in result: |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 653 | setattr(cls, intf.name, intf) |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 654 | cls.lo_interfaces = result |
| 655 | return result |
| 656 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 657 | @staticmethod |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 658 | def extend_packet(packet, size, padding=' '): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 659 | """ |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 660 | Extend packet to given size by padding with spaces or custom padding |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 661 | NOTE: Currently works only when Raw layer is present. |
| 662 | |
| 663 | :param packet: packet |
| 664 | :param size: target size |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 665 | :param padding: padding used to extend the payload |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 666 | |
| 667 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 668 | packet_len = len(packet) + 4 |
| 669 | extend = size - packet_len |
| 670 | if extend > 0: |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 671 | num = (extend / len(padding)) + 1 |
| 672 | packet[Raw].load += (padding * num)[:extend] |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 673 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 674 | @classmethod |
| 675 | def reset_packet_infos(cls): |
| 676 | """ Reset the list of packet info objects and packet counts to zero """ |
| 677 | cls._packet_infos = {} |
| 678 | cls._packet_count_for_dst_if_idx = {} |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 679 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 680 | @classmethod |
| 681 | def create_packet_info(cls, src_if, dst_if): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 682 | """ |
| 683 | Create packet info object containing the source and destination indexes |
| 684 | and add it to the testcase's packet info list |
| 685 | |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 686 | :param VppInterface src_if: source interface |
| 687 | :param VppInterface dst_if: destination interface |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 688 | |
| 689 | :returns: _PacketInfo object |
| 690 | |
| 691 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 692 | info = _PacketInfo() |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 693 | info.index = len(cls._packet_infos) |
| 694 | info.src = src_if.sw_if_index |
| 695 | info.dst = dst_if.sw_if_index |
| 696 | if isinstance(dst_if, VppSubInterface): |
| 697 | dst_idx = dst_if.parent.sw_if_index |
| 698 | else: |
| 699 | dst_idx = dst_if.sw_if_index |
| 700 | if dst_idx in cls._packet_count_for_dst_if_idx: |
| 701 | cls._packet_count_for_dst_if_idx[dst_idx] += 1 |
| 702 | else: |
| 703 | cls._packet_count_for_dst_if_idx[dst_idx] = 1 |
| 704 | cls._packet_infos[info.index] = info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 705 | return info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 706 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 707 | @staticmethod |
| 708 | def info_to_payload(info): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 709 | """ |
| 710 | Convert _PacketInfo object to packet payload |
| 711 | |
| 712 | :param info: _PacketInfo object |
| 713 | |
| 714 | :returns: string containing serialized data from packet info |
| 715 | """ |
Pavel Kotucek | 59dda06 | 2017-03-02 15:22:47 +0100 | [diff] [blame] | 716 | return "%d %d %d %d %d" % (info.index, info.src, info.dst, |
| 717 | info.ip, info.proto) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 718 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 719 | @staticmethod |
| 720 | def payload_to_info(payload): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 721 | """ |
| 722 | Convert packet payload to _PacketInfo object |
| 723 | |
| 724 | :param payload: packet payload |
| 725 | |
| 726 | :returns: _PacketInfo object containing de-serialized data from payload |
| 727 | |
| 728 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 729 | numbers = payload.split() |
| 730 | info = _PacketInfo() |
| 731 | info.index = int(numbers[0]) |
| 732 | info.src = int(numbers[1]) |
| 733 | info.dst = int(numbers[2]) |
Pavel Kotucek | 59dda06 | 2017-03-02 15:22:47 +0100 | [diff] [blame] | 734 | info.ip = int(numbers[3]) |
| 735 | info.proto = int(numbers[4]) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 736 | return info |
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 | def get_next_packet_info(self, info): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 739 | """ |
| 740 | Iterate over the packet info list stored in the testcase |
| 741 | Start iteration with first element if info is None |
| 742 | Continue based on index in info if info is specified |
| 743 | |
| 744 | :param info: info or None |
| 745 | :returns: next info in list or None if no more infos |
| 746 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 747 | if info is None: |
| 748 | next_index = 0 |
| 749 | else: |
| 750 | next_index = info.index + 1 |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 751 | if next_index == len(self._packet_infos): |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 752 | return None |
| 753 | else: |
Klement Sekera | dab231a | 2016-12-21 08:50:14 +0100 | [diff] [blame] | 754 | return self._packet_infos[next_index] |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 755 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 756 | def get_next_packet_info_for_interface(self, src_index, info): |
| 757 | """ |
| 758 | Search the packet info list for the next packet info with same source |
| 759 | interface index |
| 760 | |
| 761 | :param src_index: source interface index to search for |
| 762 | :param info: packet info - where to start the search |
| 763 | :returns: packet info or None |
| 764 | |
| 765 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 766 | while True: |
| 767 | info = self.get_next_packet_info(info) |
| 768 | if info is None: |
| 769 | return None |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 770 | if info.src == src_index: |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 771 | return info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 772 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 773 | def get_next_packet_info_for_interface2(self, src_index, dst_index, info): |
| 774 | """ |
| 775 | Search the packet info list for the next packet info with same source |
| 776 | and destination interface indexes |
| 777 | |
| 778 | :param src_index: source interface index to search for |
| 779 | :param dst_index: destination interface index to search for |
| 780 | :param info: packet info - where to start the search |
| 781 | :returns: packet info or None |
| 782 | |
| 783 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 784 | while True: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 785 | info = self.get_next_packet_info_for_interface(src_index, info) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 786 | if info is None: |
| 787 | return None |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 788 | if info.dst == dst_index: |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 789 | return info |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 790 | |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 791 | def assert_equal(self, real_value, expected_value, name_or_class=None): |
| 792 | if name_or_class is None: |
Klement Sekera | 239790f | 2017-02-16 10:53:53 +0100 | [diff] [blame] | 793 | self.assertEqual(real_value, expected_value) |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 794 | return |
| 795 | try: |
| 796 | msg = "Invalid %s: %d('%s') does not match expected value %d('%s')" |
| 797 | msg = msg % (getdoc(name_or_class).strip(), |
| 798 | real_value, str(name_or_class(real_value)), |
| 799 | expected_value, str(name_or_class(expected_value))) |
Klement Sekera | 13a83ef | 2018-03-21 12:35:51 +0100 | [diff] [blame] | 800 | except Exception: |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 801 | msg = "Invalid %s: %s does not match expected value %s" % ( |
| 802 | name_or_class, real_value, expected_value) |
| 803 | |
| 804 | self.assertEqual(real_value, expected_value, msg) |
| 805 | |
Klement Sekera | b17dd96 | 2017-01-09 07:43:48 +0100 | [diff] [blame] | 806 | def assert_in_range(self, |
| 807 | real_value, |
| 808 | expected_min, |
| 809 | expected_max, |
| 810 | name=None): |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 811 | if name is None: |
| 812 | msg = None |
| 813 | else: |
| 814 | msg = "Invalid %s: %s out of range <%s,%s>" % ( |
| 815 | name, real_value, expected_min, expected_max) |
| 816 | self.assertTrue(expected_min <= real_value <= expected_max, msg) |
| 817 | |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 818 | def assert_packet_checksums_valid(self, packet, |
| 819 | ignore_zero_udp_checksums=True): |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 820 | received = packet.__class__(str(packet)) |
| 821 | self.logger.debug( |
| 822 | ppp("Verifying packet checksums for packet:", received)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 823 | udp_layers = ['UDP', 'UDPerror'] |
| 824 | checksum_fields = ['cksum', 'chksum'] |
| 825 | checksums = [] |
| 826 | counter = 0 |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 827 | temp = received.__class__(str(received)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 828 | while True: |
| 829 | layer = temp.getlayer(counter) |
| 830 | if layer: |
| 831 | for cf in checksum_fields: |
| 832 | if hasattr(layer, cf): |
| 833 | if ignore_zero_udp_checksums and \ |
| 834 | 0 == getattr(layer, cf) and \ |
| 835 | layer.name in udp_layers: |
| 836 | continue |
| 837 | delattr(layer, cf) |
| 838 | checksums.append((counter, cf)) |
| 839 | else: |
| 840 | break |
| 841 | counter = counter + 1 |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 842 | if 0 == len(checksums): |
| 843 | return |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 844 | temp = temp.__class__(str(temp)) |
| 845 | for layer, cf in checksums: |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 846 | calc_sum = getattr(temp[layer], cf) |
| 847 | self.assert_equal( |
| 848 | getattr(received[layer], cf), calc_sum, |
| 849 | "packet checksum on layer #%d: %s" % (layer, temp[layer].name)) |
| 850 | self.logger.debug( |
| 851 | "Checksum field `%s` on `%s` layer has correct value `%s`" % |
| 852 | (cf, temp[layer].name, calc_sum)) |
Klement Sekera | d81ae41 | 2018-05-16 10:52:54 +0200 | [diff] [blame] | 853 | |
| 854 | def assert_checksum_valid(self, received_packet, layer, |
| 855 | field_name='chksum', |
| 856 | ignore_zero_checksum=False): |
| 857 | """ Check checksum of received packet on given layer """ |
| 858 | received_packet_checksum = getattr(received_packet[layer], field_name) |
| 859 | if ignore_zero_checksum and 0 == received_packet_checksum: |
| 860 | return |
| 861 | recalculated = received_packet.__class__(str(received_packet)) |
| 862 | delattr(recalculated[layer], field_name) |
| 863 | recalculated = recalculated.__class__(str(recalculated)) |
| 864 | self.assert_equal(received_packet_checksum, |
| 865 | getattr(recalculated[layer], field_name), |
| 866 | "packet checksum on layer: %s" % layer) |
| 867 | |
| 868 | def assert_ip_checksum_valid(self, received_packet, |
| 869 | ignore_zero_checksum=False): |
| 870 | self.assert_checksum_valid(received_packet, 'IP', |
| 871 | ignore_zero_checksum=ignore_zero_checksum) |
| 872 | |
| 873 | def assert_tcp_checksum_valid(self, received_packet, |
| 874 | ignore_zero_checksum=False): |
| 875 | self.assert_checksum_valid(received_packet, 'TCP', |
| 876 | ignore_zero_checksum=ignore_zero_checksum) |
| 877 | |
| 878 | def assert_udp_checksum_valid(self, received_packet, |
| 879 | ignore_zero_checksum=True): |
| 880 | self.assert_checksum_valid(received_packet, 'UDP', |
| 881 | ignore_zero_checksum=ignore_zero_checksum) |
| 882 | |
| 883 | def assert_embedded_icmp_checksum_valid(self, received_packet): |
| 884 | if received_packet.haslayer(IPerror): |
| 885 | self.assert_checksum_valid(received_packet, 'IPerror') |
| 886 | if received_packet.haslayer(TCPerror): |
| 887 | self.assert_checksum_valid(received_packet, 'TCPerror') |
| 888 | if received_packet.haslayer(UDPerror): |
| 889 | self.assert_checksum_valid(received_packet, 'UDPerror', |
| 890 | ignore_zero_checksum=True) |
| 891 | if received_packet.haslayer(ICMPerror): |
| 892 | self.assert_checksum_valid(received_packet, 'ICMPerror') |
| 893 | |
| 894 | def assert_icmp_checksum_valid(self, received_packet): |
| 895 | self.assert_checksum_valid(received_packet, 'ICMP') |
| 896 | self.assert_embedded_icmp_checksum_valid(received_packet) |
| 897 | |
| 898 | def assert_icmpv6_checksum_valid(self, pkt): |
| 899 | if pkt.haslayer(ICMPv6DestUnreach): |
| 900 | self.assert_checksum_valid(pkt, 'ICMPv6DestUnreach', 'cksum') |
| 901 | self.assert_embedded_icmp_checksum_valid(pkt) |
| 902 | if pkt.haslayer(ICMPv6EchoRequest): |
| 903 | self.assert_checksum_valid(pkt, 'ICMPv6EchoRequest', 'cksum') |
| 904 | if pkt.haslayer(ICMPv6EchoReply): |
| 905 | self.assert_checksum_valid(pkt, 'ICMPv6EchoReply', 'cksum') |
| 906 | |
Klement Sekera | f37c3ba | 2018-11-08 11:24:34 +0100 | [diff] [blame] | 907 | def assert_packet_counter_equal(self, counter, expected_value): |
| 908 | counters = self.vapi.cli("sh errors").split('\n') |
| 909 | counter_value = -1 |
| 910 | for i in range(1, len(counters)-1): |
| 911 | results = counters[i].split() |
| 912 | if results[1] == counter: |
| 913 | counter_value = int(results[0]) |
| 914 | break |
| 915 | self.assert_equal(counter_value, expected_value, |
| 916 | "packet counter `%s'" % counter) |
| 917 | |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 918 | @classmethod |
| 919 | def sleep(cls, timeout, remark=None): |
| 920 | if hasattr(cls, 'logger'): |
Klement Sekera | 3cfa558 | 2017-04-19 07:10:58 +0000 | [diff] [blame] | 921 | cls.logger.debug("Starting sleep for %ss (%s)" % (timeout, remark)) |
| 922 | before = time.time() |
Klement Sekera | a57a970 | 2017-02-02 06:58:07 +0100 | [diff] [blame] | 923 | time.sleep(timeout) |
Klement Sekera | 3cfa558 | 2017-04-19 07:10:58 +0000 | [diff] [blame] | 924 | after = time.time() |
| 925 | if after - before > 2 * timeout: |
Klement Sekera | 60c1223 | 2017-07-18 10:33:06 +0200 | [diff] [blame] | 926 | cls.logger.error("unexpected time.sleep() result - " |
| 927 | "slept for %ss instead of ~%ss!" % ( |
| 928 | after - before, timeout)) |
Klement Sekera | 3cfa558 | 2017-04-19 07:10:58 +0000 | [diff] [blame] | 929 | if hasattr(cls, 'logger'): |
| 930 | cls.logger.debug( |
| 931 | "Finished sleep (%s) - slept %ss (wanted %ss)" % ( |
| 932 | remark, after - before, timeout)) |
Klement Sekera | a57a970 | 2017-02-02 06:58:07 +0100 | [diff] [blame] | 933 | |
Neale Ranns | 947ea62 | 2018-06-07 23:48:20 -0700 | [diff] [blame] | 934 | def send_and_assert_no_replies(self, intf, pkts, remark="", timeout=None): |
Neale Ranns | 52fae86 | 2018-01-08 04:41:42 -0800 | [diff] [blame] | 935 | self.vapi.cli("clear trace") |
| 936 | intf.add_stream(pkts) |
| 937 | self.pg_enable_capture(self.pg_interfaces) |
| 938 | self.pg_start() |
Neale Ranns | 947ea62 | 2018-06-07 23:48:20 -0700 | [diff] [blame] | 939 | if not timeout: |
| 940 | timeout = 1 |
Neale Ranns | 52fae86 | 2018-01-08 04:41:42 -0800 | [diff] [blame] | 941 | for i in self.pg_interfaces: |
| 942 | i.get_capture(0, timeout=timeout) |
| 943 | i.assert_nothing_captured(remark=remark) |
| 944 | timeout = 0.1 |
| 945 | |
| 946 | def send_and_expect(self, input, pkts, output): |
| 947 | self.vapi.cli("clear trace") |
| 948 | input.add_stream(pkts) |
| 949 | self.pg_enable_capture(self.pg_interfaces) |
| 950 | self.pg_start() |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 951 | if isinstance(object, (list,)): |
| 952 | rx = [] |
| 953 | for o in output: |
| 954 | rx.append(output.get_capture(len(pkts))) |
| 955 | else: |
| 956 | rx = output.get_capture(len(pkts)) |
| 957 | return rx |
| 958 | |
| 959 | def send_and_expect_only(self, input, pkts, output, timeout=None): |
| 960 | self.vapi.cli("clear trace") |
| 961 | input.add_stream(pkts) |
| 962 | self.pg_enable_capture(self.pg_interfaces) |
| 963 | self.pg_start() |
| 964 | if isinstance(object, (list,)): |
| 965 | outputs = output |
| 966 | rx = [] |
| 967 | for o in outputs: |
| 968 | rx.append(output.get_capture(len(pkts))) |
| 969 | else: |
| 970 | rx = output.get_capture(len(pkts)) |
| 971 | outputs = [output] |
| 972 | if not timeout: |
| 973 | timeout = 1 |
| 974 | for i in self.pg_interfaces: |
| 975 | if i not in outputs: |
| 976 | i.get_capture(0, timeout=timeout) |
| 977 | i.assert_nothing_captured() |
| 978 | timeout = 0.1 |
| 979 | |
Neale Ranns | 52fae86 | 2018-01-08 04:41:42 -0800 | [diff] [blame] | 980 | return rx |
| 981 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 982 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 983 | def get_testcase_doc_name(test): |
| 984 | return getdoc(test.__class__).splitlines()[0] |
| 985 | |
| 986 | |
Ole Trøan | 5ba9159 | 2018-11-22 10:01:09 +0000 | [diff] [blame] | 987 | def get_test_description(descriptions, test): |
| 988 | short_description = test.shortDescription() |
| 989 | if descriptions and short_description: |
| 990 | return short_description |
| 991 | else: |
| 992 | return str(test) |
| 993 | |
| 994 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 995 | class TestCaseInfo(object): |
| 996 | def __init__(self, logger, tempdir, vpp_pid, vpp_bin_path): |
| 997 | self.logger = logger |
| 998 | self.tempdir = tempdir |
| 999 | self.vpp_pid = vpp_pid |
| 1000 | self.vpp_bin_path = vpp_bin_path |
| 1001 | self.core_crash_test = None |
Klement Sekera | 8713493 | 2017-03-07 11:39:27 +0100 | [diff] [blame] | 1002 | |
| 1003 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1004 | class VppTestResult(unittest.TestResult): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1005 | """ |
| 1006 | @property result_string |
| 1007 | String variable to store the test case result string. |
| 1008 | @property errors |
| 1009 | List variable containing 2-tuples of TestCase instances and strings |
| 1010 | holding formatted tracebacks. Each tuple represents a test which |
| 1011 | raised an unexpected exception. |
| 1012 | @property failures |
| 1013 | List variable containing 2-tuples of TestCase instances and strings |
| 1014 | holding formatted tracebacks. Each tuple represents a test where |
| 1015 | a failure was explicitly signalled using the TestCase.assert*() |
| 1016 | methods. |
| 1017 | """ |
| 1018 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1019 | failed_test_cases_info = set() |
| 1020 | core_crash_test_cases_info = set() |
| 1021 | current_test_case_info = None |
| 1022 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1023 | def __init__(self, stream, descriptions, verbosity): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1024 | """ |
Klement Sekera | da505f6 | 2017-01-04 12:58:53 +0100 | [diff] [blame] | 1025 | :param stream File descriptor to store where to report test results. |
| 1026 | Set to the standard error stream by default. |
| 1027 | :param descriptions Boolean variable to store information if to use |
| 1028 | test case descriptions. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1029 | :param verbosity Integer variable to store required verbosity level. |
| 1030 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1031 | unittest.TestResult.__init__(self, stream, descriptions, verbosity) |
| 1032 | self.stream = stream |
| 1033 | self.descriptions = descriptions |
| 1034 | self.verbosity = verbosity |
| 1035 | self.result_string = None |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1036 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1037 | def addSuccess(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1038 | """ |
| 1039 | Record a test succeeded result |
| 1040 | |
| 1041 | :param test: |
| 1042 | |
| 1043 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1044 | if self.current_test_case_info: |
| 1045 | self.current_test_case_info.logger.debug( |
| 1046 | "--- addSuccess() %s.%s(%s) called" % (test.__class__.__name__, |
| 1047 | test._testMethodName, |
| 1048 | test._testMethodDoc)) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1049 | unittest.TestResult.addSuccess(self, test) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 1050 | self.result_string = colorize("OK", GREEN) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1051 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1052 | self.send_result_through_pipe(test, PASS) |
| 1053 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1054 | def addSkip(self, test, reason): |
| 1055 | """ |
| 1056 | Record a test skipped. |
| 1057 | |
| 1058 | :param test: |
| 1059 | :param reason: |
| 1060 | |
| 1061 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1062 | if self.current_test_case_info: |
| 1063 | self.current_test_case_info.logger.debug( |
| 1064 | "--- addSkip() %s.%s(%s) called, reason is %s" % |
| 1065 | (test.__class__.__name__, test._testMethodName, |
| 1066 | test._testMethodDoc, reason)) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1067 | unittest.TestResult.addSkip(self, test, reason) |
Klement Sekera | 277b89c | 2016-10-28 13:20:27 +0200 | [diff] [blame] | 1068 | self.result_string = colorize("SKIP", YELLOW) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1069 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1070 | self.send_result_through_pipe(test, SKIP) |
| 1071 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1072 | def symlink_failed(self): |
| 1073 | if self.current_test_case_info: |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 1074 | try: |
| 1075 | failed_dir = os.getenv('VPP_TEST_FAILED_DIR') |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1076 | link_path = os.path.join( |
| 1077 | failed_dir, |
| 1078 | '%s-FAILED' % |
| 1079 | os.path.basename(self.current_test_case_info.tempdir)) |
| 1080 | if self.current_test_case_info.logger: |
| 1081 | self.current_test_case_info.logger.debug( |
| 1082 | "creating a link to the failed test") |
| 1083 | self.current_test_case_info.logger.debug( |
| 1084 | "os.symlink(%s, %s)" % |
| 1085 | (self.current_test_case_info.tempdir, link_path)) |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1086 | if os.path.exists(link_path): |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1087 | if self.current_test_case_info.logger: |
| 1088 | self.current_test_case_info.logger.debug( |
| 1089 | 'symlink already exists') |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1090 | else: |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1091 | os.symlink(self.current_test_case_info.tempdir, link_path) |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1092 | |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 1093 | except Exception as e: |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1094 | if self.current_test_case_info.logger: |
| 1095 | self.current_test_case_info.logger.error(e) |
Klement Sekera | f413bef | 2017-08-15 07:09:02 +0200 | [diff] [blame] | 1096 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1097 | def send_result_through_pipe(self, test, result): |
| 1098 | if hasattr(self, 'test_framework_result_pipe'): |
| 1099 | pipe = self.test_framework_result_pipe |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1100 | if pipe: |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1101 | pipe.send((test.id(), result)) |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1102 | |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1103 | def log_error(self, test, err, fn_name): |
| 1104 | if self.current_test_case_info: |
| 1105 | if isinstance(test, unittest.suite._ErrorHolder): |
| 1106 | test_name = test.description |
| 1107 | else: |
| 1108 | test_name = '%s.%s(%s)' % (test.__class__.__name__, |
| 1109 | test._testMethodName, |
| 1110 | test._testMethodDoc) |
| 1111 | self.current_test_case_info.logger.debug( |
| 1112 | "--- %s() %s called, err is %s" % |
| 1113 | (fn_name, test_name, err)) |
| 1114 | self.current_test_case_info.logger.debug( |
| 1115 | "formatted exception is:\n%s" % |
| 1116 | "".join(format_exception(*err))) |
| 1117 | |
| 1118 | def add_error(self, test, err, unittest_fn, error_type): |
| 1119 | if error_type == FAIL: |
| 1120 | self.log_error(test, err, 'addFailure') |
| 1121 | error_type_str = colorize("FAIL", RED) |
| 1122 | elif error_type == ERROR: |
| 1123 | self.log_error(test, err, 'addError') |
| 1124 | error_type_str = colorize("ERROR", RED) |
| 1125 | else: |
| 1126 | raise Exception('Error type %s cannot be used to record an ' |
| 1127 | 'error or a failure' % error_type) |
| 1128 | |
| 1129 | unittest_fn(self, test, err) |
| 1130 | if self.current_test_case_info: |
| 1131 | self.result_string = "%s [ temp dir used by test case: %s ]" % \ |
| 1132 | (error_type_str, |
| 1133 | self.current_test_case_info.tempdir) |
| 1134 | self.symlink_failed() |
| 1135 | self.failed_test_cases_info.add(self.current_test_case_info) |
| 1136 | if is_core_present(self.current_test_case_info.tempdir): |
| 1137 | if not self.current_test_case_info.core_crash_test: |
| 1138 | if isinstance(test, unittest.suite._ErrorHolder): |
| 1139 | test_name = str(test) |
| 1140 | else: |
| 1141 | test_name = "'{}' ({})".format( |
| 1142 | get_testcase_doc_name(test), test.id()) |
| 1143 | self.current_test_case_info.core_crash_test = test_name |
| 1144 | self.core_crash_test_cases_info.add( |
| 1145 | self.current_test_case_info) |
| 1146 | else: |
| 1147 | self.result_string = '%s [no temp dir]' % error_type_str |
| 1148 | |
| 1149 | self.send_result_through_pipe(test, error_type) |
| 1150 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1151 | def addFailure(self, test, err): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1152 | """ |
| 1153 | Record a test failed result |
| 1154 | |
| 1155 | :param test: |
| 1156 | :param err: error message |
| 1157 | |
| 1158 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1159 | self.add_error(test, err, unittest.TestResult.addFailure, FAIL) |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1160 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1161 | def addError(self, test, err): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1162 | """ |
| 1163 | Record a test error result |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1164 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1165 | :param test: |
| 1166 | :param err: error message |
| 1167 | |
| 1168 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1169 | self.add_error(test, err, unittest.TestResult.addError, ERROR) |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1170 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1171 | def getDescription(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1172 | """ |
| 1173 | Get test description |
| 1174 | |
| 1175 | :param test: |
| 1176 | :returns: test description |
| 1177 | |
| 1178 | """ |
Ole Trøan | 5ba9159 | 2018-11-22 10:01:09 +0000 | [diff] [blame] | 1179 | return get_test_description(self.descriptions, test) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1180 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1181 | def startTest(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1182 | """ |
| 1183 | Start a test |
| 1184 | |
| 1185 | :param test: |
| 1186 | |
| 1187 | """ |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1188 | test.print_header(test.__class__) |
| 1189 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1190 | unittest.TestResult.startTest(self, test) |
| 1191 | if self.verbosity > 0: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1192 | self.stream.writeln( |
| 1193 | "Starting " + self.getDescription(test) + " ...") |
| 1194 | self.stream.writeln(single_line_delim) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1195 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1196 | def stopTest(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1197 | """ |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1198 | Called when the given test has been run |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1199 | |
| 1200 | :param test: |
| 1201 | |
| 1202 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1203 | unittest.TestResult.stopTest(self, test) |
| 1204 | if self.verbosity > 0: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1205 | self.stream.writeln(single_line_delim) |
Klement Sekera | 52e84f3 | 2017-01-13 07:25:25 +0100 | [diff] [blame] | 1206 | self.stream.writeln("%-73s%s" % (self.getDescription(test), |
Klement Sekera | da505f6 | 2017-01-04 12:58:53 +0100 | [diff] [blame] | 1207 | self.result_string)) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1208 | self.stream.writeln(single_line_delim) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1209 | else: |
Klement Sekera | 52e84f3 | 2017-01-13 07:25:25 +0100 | [diff] [blame] | 1210 | self.stream.writeln("%-73s%s" % (self.getDescription(test), |
Klement Sekera | da505f6 | 2017-01-04 12:58:53 +0100 | [diff] [blame] | 1211 | self.result_string)) |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1212 | |
| 1213 | self.send_result_through_pipe(test, TEST_RUN) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1214 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1215 | def printErrors(self): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1216 | """ |
| 1217 | Print errors from running the test case |
| 1218 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1219 | self.stream.writeln() |
| 1220 | self.printErrorList('ERROR', self.errors) |
| 1221 | self.printErrorList('FAIL', self.failures) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1222 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1223 | def printErrorList(self, flavour, errors): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1224 | """ |
| 1225 | Print error list to the output stream together with error type |
| 1226 | and test case description. |
| 1227 | |
| 1228 | :param flavour: error type |
| 1229 | :param errors: iterable errors |
| 1230 | |
| 1231 | """ |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1232 | for test, err in errors: |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1233 | self.stream.writeln(double_line_delim) |
| 1234 | self.stream.writeln("%s: %s" % |
| 1235 | (flavour, self.getDescription(test))) |
| 1236 | self.stream.writeln(single_line_delim) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1237 | self.stream.writeln("%s" % err) |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1238 | |
| 1239 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1240 | class VppTestRunner(unittest.TextTestRunner): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1241 | """ |
Klement Sekera | 104543f | 2017-02-03 07:29:43 +0100 | [diff] [blame] | 1242 | A basic test runner implementation which prints results to standard error. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1243 | """ |
| 1244 | @property |
| 1245 | def resultclass(self): |
| 1246 | """Class maintaining the results of the tests""" |
| 1247 | return VppTestResult |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1248 | |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1249 | def __init__(self, keep_alive_pipe=None, descriptions=True, verbosity=1, |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1250 | result_pipe=None, failfast=False, buffer=False, |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1251 | resultclass=None): |
juraj.linkes | 40dd73b | 2018-09-21 13:55:16 +0200 | [diff] [blame] | 1252 | |
Klement Sekera | 7a161da | 2017-01-17 13:42:48 +0100 | [diff] [blame] | 1253 | # ignore stream setting here, use hard-coded stdout to be in sync |
| 1254 | # with prints from VppTestCase methods ... |
| 1255 | super(VppTestRunner, self).__init__(sys.stdout, descriptions, |
| 1256 | verbosity, failfast, buffer, |
| 1257 | resultclass) |
Klement Sekera | 909a6a1 | 2017-08-08 04:33:53 +0200 | [diff] [blame] | 1258 | reporter = KeepAliveReporter() |
Klement Sekera | df2b980 | 2017-10-05 10:26:03 +0200 | [diff] [blame] | 1259 | reporter.pipe = keep_alive_pipe |
Klement Sekera | 104543f | 2017-02-03 07:29:43 +0100 | [diff] [blame] | 1260 | |
juraj.linkes | cae64f8 | 2018-09-19 15:01:47 +0200 | [diff] [blame] | 1261 | VppTestResult.test_framework_result_pipe = result_pipe |
juraj.linkes | 5e2c54d | 2018-08-30 10:51:45 +0200 | [diff] [blame] | 1262 | |
Damjan Marion | f56b77a | 2016-10-03 19:44:57 +0200 | [diff] [blame] | 1263 | def run(self, test): |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 1264 | """ |
| 1265 | Run the tests |
| 1266 | |
| 1267 | :param test: |
| 1268 | |
| 1269 | """ |
Klement Sekera | 3658adc | 2017-06-07 08:19:47 +0200 | [diff] [blame] | 1270 | faulthandler.enable() # emit stack trace to stderr if killed by signal |
juraj.linkes | 184870a | 2018-07-16 14:22:01 +0200 | [diff] [blame] | 1271 | |
| 1272 | result = super(VppTestRunner, self).run(test) |
| 1273 | return result |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1274 | |
| 1275 | |
| 1276 | class Worker(Thread): |
Dave Wallace | 42996c0 | 2018-02-26 14:40:13 -0500 | [diff] [blame] | 1277 | def __init__(self, args, logger, env={}): |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1278 | self.logger = logger |
| 1279 | self.args = args |
| 1280 | self.result = None |
Dave Wallace | 42996c0 | 2018-02-26 14:40:13 -0500 | [diff] [blame] | 1281 | self.env = copy.deepcopy(env) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1282 | super(Worker, self).__init__() |
| 1283 | |
| 1284 | def run(self): |
| 1285 | executable = self.args[0] |
| 1286 | self.logger.debug("Running executable w/args `%s'" % self.args) |
| 1287 | env = os.environ.copy() |
Dave Wallace | cfcf2f4 | 2018-02-16 18:31:56 -0500 | [diff] [blame] | 1288 | env.update(self.env) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1289 | env["CK_LOG_FILE_NAME"] = "-" |
| 1290 | self.process = subprocess.Popen( |
| 1291 | self.args, shell=False, env=env, preexec_fn=os.setpgrp, |
| 1292 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
| 1293 | out, err = self.process.communicate() |
| 1294 | self.logger.debug("Finished running `%s'" % executable) |
| 1295 | self.logger.info("Return code is `%s'" % self.process.returncode) |
| 1296 | self.logger.info(single_line_delim) |
| 1297 | self.logger.info("Executable `%s' wrote to stdout:" % executable) |
| 1298 | self.logger.info(single_line_delim) |
| 1299 | self.logger.info(out) |
| 1300 | self.logger.info(single_line_delim) |
| 1301 | self.logger.info("Executable `%s' wrote to stderr:" % executable) |
| 1302 | self.logger.info(single_line_delim) |
Klement Sekera | de0203e | 2018-02-22 19:21:27 +0100 | [diff] [blame] | 1303 | self.logger.info(err) |
Neale Ranns | 812ed39 | 2017-10-16 04:20:13 -0700 | [diff] [blame] | 1304 | self.logger.info(single_line_delim) |
| 1305 | self.result = self.process.returncode |