blob: 55b8123756cc4eee6278b1d135280f4036383d78 [file] [log] [blame]
Damjan Marionf56b77a2016-10-03 19:44:57 +02001#!/usr/bin/env python
2
Klement Sekera993e0ed2017-03-16 09:14:59 +01003import sys
Dave Wallacee2efd122017-09-30 22:04:21 -04004import shutil
Damjan Marionf56b77a2016-10-03 19:44:57 +02005import os
Andrew Yourtchenkod760f792018-10-03 11:38:31 +02006import fnmatch
Damjan Marionf56b77a2016-10-03 19:44:57 +02007import unittest
Klement Sekera993e0ed2017-03-16 09:14:59 +01008import argparse
Klement Sekera545be522018-02-16 19:25:06 +01009import time
juraj.linkes184870a2018-07-16 14:22:01 +020010import threading
11import signal
12import psutil
juraj.linkes40dd73b2018-09-21 13:55:16 +020013import re
juraj.linkes184870a2018-07-16 14:22:01 +020014from multiprocessing import Process, Pipe, cpu_count
15from multiprocessing.queues import Queue
16from multiprocessing.managers import BaseManager
17from framework import VppTestRunner, running_extended_tests, VppTestCase, \
Ole Trøan5ba91592018-11-22 10:01:09 +000018 get_testcase_doc_name, get_test_description, PASS, FAIL, ERROR, SKIP, \
juraj.linkescae64f82018-09-19 15:01:47 +020019 TEST_RUN
Klement Sekera909a6a12017-08-08 04:33:53 +020020from debug import spawn_gdb
juraj.linkes184870a2018-07-16 14:22:01 +020021from log import get_parallel_logger, double_line_delim, RED, YELLOW, GREEN, \
juraj.linkes40dd73b2018-09-21 13:55:16 +020022 colorize, single_line_delim
Klement Sekerafcbf4442017-08-17 07:38:42 +020023from discover_tests import discover_tests
Klement Sekera9b6ece72018-03-23 10:50:11 +010024from subprocess import check_output, CalledProcessError
juraj.linkes40dd73b2018-09-21 13:55:16 +020025from util import check_core_path, get_core_path, is_core_present
Klement Sekera993e0ed2017-03-16 09:14:59 +010026
Klement Sekera05742262018-03-14 18:14:49 +010027# timeout which controls how long the child has to finish after seeing
28# a core dump in test temporary directory. If this is exceeded, parent assumes
29# that child process is stuck (e.g. waiting for shm mutex, which will never
30# get unlocked) and kill the child
31core_timeout = 3
juraj.linkes184870a2018-07-16 14:22:01 +020032min_req_shm = 536870912 # min 512MB shm required
33# 128MB per extra process
34shm_per_process = 134217728
Klement Sekera05742262018-03-14 18:14:49 +010035
Klement Sekera909a6a12017-08-08 04:33:53 +020036
juraj.linkes184870a2018-07-16 14:22:01 +020037class StreamQueue(Queue):
38 def write(self, msg):
39 self.put(msg)
40
41 def flush(self):
42 sys.__stdout__.flush()
43 sys.__stderr__.flush()
44
45 def fileno(self):
46 return self._writer.fileno()
47
48
49class StreamQueueManager(BaseManager):
50 pass
51
52
juraj.linkescae64f82018-09-19 15:01:47 +020053StreamQueueManager.register('StreamQueue', StreamQueue)
juraj.linkes184870a2018-07-16 14:22:01 +020054
55
juraj.linkescae64f82018-09-19 15:01:47 +020056class TestResult(dict):
juraj.linkes40dd73b2018-09-21 13:55:16 +020057 def __init__(self, testcase_suite, testcases_by_id=None):
juraj.linkescae64f82018-09-19 15:01:47 +020058 super(TestResult, self).__init__()
59 self[PASS] = []
60 self[FAIL] = []
61 self[ERROR] = []
62 self[SKIP] = []
63 self[TEST_RUN] = []
juraj.linkes40dd73b2018-09-21 13:55:16 +020064 self.crashed = False
juraj.linkescae64f82018-09-19 15:01:47 +020065 self.testcase_suite = testcase_suite
66 self.testcases = [testcase for testcase in testcase_suite]
juraj.linkes40dd73b2018-09-21 13:55:16 +020067 self.testcases_by_id = testcases_by_id
juraj.linkescae64f82018-09-19 15:01:47 +020068
69 def was_successful(self):
juraj.linkes40dd73b2018-09-21 13:55:16 +020070 return 0 == len(self[FAIL]) == len(self[ERROR]) \
Klement Sekerab8c72a42018-11-08 11:21:39 +010071 and len(self[PASS] + self[SKIP]) \
72 == self.testcase_suite.countTestCases() == len(self[TEST_RUN])
juraj.linkescae64f82018-09-19 15:01:47 +020073
74 def no_tests_run(self):
75 return 0 == len(self[TEST_RUN])
76
77 def process_result(self, test_id, result):
78 self[result].append(test_id)
juraj.linkescae64f82018-09-19 15:01:47 +020079
80 def suite_from_failed(self):
81 rerun_ids = set([])
82 for testcase in self.testcase_suite:
83 tc_id = testcase.id()
84 if tc_id not in self[PASS] and tc_id not in self[SKIP]:
85 rerun_ids.add(tc_id)
Naveen Joy2cbf2fb2019-03-06 10:41:06 -080086 if rerun_ids:
juraj.linkescae64f82018-09-19 15:01:47 +020087 return suite_from_failed(self.testcase_suite, rerun_ids)
88
89 def get_testcase_names(self, test_id):
juraj.linkes2eca70d2018-12-13 11:10:47 +010090 # could be tearDownClass (test_ipsec_esp.TestIpsecEsp1)
91 setup_teardown_match = re.match(
92 r'((tearDownClass)|(setUpClass)) \((.+\..+)\)', test_id)
93 if setup_teardown_match:
94 test_name, _, _, testcase_name = setup_teardown_match.groups()
95 if len(testcase_name.split('.')) == 2:
96 for key in self.testcases_by_id.keys():
97 if key.startswith(testcase_name):
98 testcase_name = key
99 break
100 testcase_name = self._get_testcase_doc_name(testcase_name)
101 else:
Ole Trøan5ba91592018-11-22 10:01:09 +0000102 test_name = self._get_test_description(test_id)
juraj.linkes40dd73b2018-09-21 13:55:16 +0200103 testcase_name = self._get_testcase_doc_name(test_id)
juraj.linkes40dd73b2018-09-21 13:55:16 +0200104
105 return testcase_name, test_name
juraj.linkescae64f82018-09-19 15:01:47 +0200106
Ole Trøan5ba91592018-11-22 10:01:09 +0000107 def _get_test_description(self, test_id):
juraj.linkes2eca70d2018-12-13 11:10:47 +0100108 if test_id in self.testcases_by_id:
109 desc = get_test_description(descriptions,
110 self.testcases_by_id[test_id])
111 else:
112 desc = test_id
113 return desc
Ole Trøan5ba91592018-11-22 10:01:09 +0000114
juraj.linkes40dd73b2018-09-21 13:55:16 +0200115 def _get_testcase_doc_name(self, test_id):
juraj.linkes2eca70d2018-12-13 11:10:47 +0100116 if test_id in self.testcases_by_id:
117 doc_name = get_testcase_doc_name(self.testcases_by_id[test_id])
118 else:
119 doc_name = test_id
120 return doc_name
juraj.linkescae64f82018-09-19 15:01:47 +0200121
122
123def test_runner_wrapper(suite, keep_alive_pipe, stdouterr_queue,
124 finished_pipe, result_pipe, logger):
juraj.linkes184870a2018-07-16 14:22:01 +0200125 sys.stdout = stdouterr_queue
126 sys.stderr = stdouterr_queue
juraj.linkesdfb5f2a2018-11-09 11:58:54 +0100127 VppTestCase.parallel_handler = logger.handlers[0]
juraj.linkes184870a2018-07-16 14:22:01 +0200128 result = VppTestRunner(keep_alive_pipe=keep_alive_pipe,
129 descriptions=descriptions,
130 verbosity=verbose,
juraj.linkescae64f82018-09-19 15:01:47 +0200131 result_pipe=result_pipe,
juraj.linkesabec0122018-11-16 17:28:56 +0100132 failfast=failfast,
133 print_summary=False).run(suite)
juraj.linkescae64f82018-09-19 15:01:47 +0200134 finished_pipe.send(result.wasSuccessful())
135 finished_pipe.close()
Klement Sekera909a6a12017-08-08 04:33:53 +0200136 keep_alive_pipe.close()
137
138
juraj.linkes184870a2018-07-16 14:22:01 +0200139class TestCaseWrapper(object):
140 def __init__(self, testcase_suite, manager):
141 self.keep_alive_parent_end, self.keep_alive_child_end = Pipe(
142 duplex=False)
juraj.linkescae64f82018-09-19 15:01:47 +0200143 self.finished_parent_end, self.finished_child_end = Pipe(duplex=False)
juraj.linkes184870a2018-07-16 14:22:01 +0200144 self.result_parent_end, self.result_child_end = Pipe(duplex=False)
145 self.testcase_suite = testcase_suite
Ole Troan7f991832018-12-06 17:35:12 +0100146 if sys.version[0] == '2':
147 self.stdouterr_queue = manager.StreamQueue()
148 else:
149 from multiprocessing import get_context
150 self.stdouterr_queue = manager.StreamQueue(ctx=get_context())
juraj.linkes184870a2018-07-16 14:22:01 +0200151 self.logger = get_parallel_logger(self.stdouterr_queue)
152 self.child = Process(target=test_runner_wrapper,
juraj.linkescae64f82018-09-19 15:01:47 +0200153 args=(testcase_suite,
154 self.keep_alive_child_end,
155 self.stdouterr_queue,
156 self.finished_child_end,
157 self.result_child_end,
158 self.logger)
juraj.linkes184870a2018-07-16 14:22:01 +0200159 )
160 self.child.start()
juraj.linkes184870a2018-07-16 14:22:01 +0200161 self.last_test_temp_dir = None
162 self.last_test_vpp_binary = None
juraj.linkes40dd73b2018-09-21 13:55:16 +0200163 self._last_test = None
164 self.last_test_id = None
juraj.linkes721872e2018-09-05 18:13:45 +0200165 self.vpp_pid = None
juraj.linkes184870a2018-07-16 14:22:01 +0200166 self.last_heard = time.time()
167 self.core_detected_at = None
juraj.linkes40dd73b2018-09-21 13:55:16 +0200168 self.testcases_by_id = {}
169 self.testclasess_with_core = {}
170 for testcase in self.testcase_suite:
171 self.testcases_by_id[testcase.id()] = testcase
172 self.result = TestResult(testcase_suite, self.testcases_by_id)
173
174 @property
175 def last_test(self):
176 return self._last_test
177
178 @last_test.setter
179 def last_test(self, test_id):
180 self.last_test_id = test_id
181 if test_id in self.testcases_by_id:
182 testcase = self.testcases_by_id[test_id]
183 self._last_test = testcase.shortDescription()
184 if not self._last_test:
185 self._last_test = str(testcase)
186 else:
187 self._last_test = test_id
188
189 def add_testclass_with_core(self):
190 if self.last_test_id in self.testcases_by_id:
191 test = self.testcases_by_id[self.last_test_id]
192 class_name = unittest.util.strclass(test.__class__)
193 test_name = "'{}' ({})".format(get_test_description(descriptions,
194 test),
195 self.last_test_id)
196 else:
197 test_name = self.last_test_id
198 class_name = re.match(r'((tearDownClass)|(setUpClass)) '
199 r'\((.+\..+)\)', test_name).groups()[3]
200 if class_name not in self.testclasess_with_core:
201 self.testclasess_with_core[class_name] = (
202 test_name,
203 self.last_test_vpp_binary,
204 self.last_test_temp_dir)
juraj.linkes184870a2018-07-16 14:22:01 +0200205
206 def close_pipes(self):
207 self.keep_alive_child_end.close()
juraj.linkescae64f82018-09-19 15:01:47 +0200208 self.finished_child_end.close()
juraj.linkes184870a2018-07-16 14:22:01 +0200209 self.result_child_end.close()
210 self.keep_alive_parent_end.close()
juraj.linkescae64f82018-09-19 15:01:47 +0200211 self.finished_parent_end.close()
juraj.linkes184870a2018-07-16 14:22:01 +0200212 self.result_parent_end.close()
213
juraj.linkes40dd73b2018-09-21 13:55:16 +0200214 def was_successful(self):
215 return self.result.was_successful()
216
juraj.linkes184870a2018-07-16 14:22:01 +0200217
218def stdouterr_reader_wrapper(unread_testcases, finished_unread_testcases,
219 read_testcases):
220 read_testcase = None
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800221 while read_testcases.is_set() or unread_testcases:
222 if finished_unread_testcases:
juraj.linkese6b58cf2018-11-29 09:56:35 +0100223 read_testcase = finished_unread_testcases.pop()
224 unread_testcases.remove(read_testcase)
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800225 elif unread_testcases:
juraj.linkese6b58cf2018-11-29 09:56:35 +0100226 read_testcase = unread_testcases.pop()
juraj.linkes184870a2018-07-16 14:22:01 +0200227 if read_testcase:
228 data = ''
229 while data is not None:
230 sys.stdout.write(data)
231 data = read_testcase.stdouterr_queue.get()
232
233 read_testcase.stdouterr_queue.close()
234 finished_unread_testcases.discard(read_testcase)
235 read_testcase = None
236
237
juraj.linkes40dd73b2018-09-21 13:55:16 +0200238def handle_failed_suite(logger, last_test_temp_dir, vpp_pid):
239 if last_test_temp_dir:
240 # Need to create link in case of a timeout or core dump without failure
241 lttd = os.path.basename(last_test_temp_dir)
Klement Sekerab8c72a42018-11-08 11:21:39 +0100242 failed_dir = os.getenv('FAILED_DIR')
juraj.linkes40dd73b2018-09-21 13:55:16 +0200243 link_path = '%s%s-FAILED' % (failed_dir, lttd)
244 if not os.path.exists(link_path):
juraj.linkes40dd73b2018-09-21 13:55:16 +0200245 os.symlink(last_test_temp_dir, link_path)
juraj.linkesabec0122018-11-16 17:28:56 +0100246 logger.error("Symlink to failed testcase directory: %s -> %s"
247 % (link_path, lttd))
juraj.linkes40dd73b2018-09-21 13:55:16 +0200248
249 # Report core existence
250 core_path = get_core_path(last_test_temp_dir)
251 if os.path.exists(core_path):
252 logger.error(
253 "Core-file exists in test temporary directory: %s!" %
254 core_path)
255 check_core_path(logger, core_path)
Paul Vinciguerra38a4ec72018-11-28 11:34:21 -0800256 logger.debug("Running 'file %s':" % core_path)
juraj.linkes40dd73b2018-09-21 13:55:16 +0200257 try:
258 info = check_output(["file", core_path])
259 logger.debug(info)
260 except CalledProcessError as e:
Paul Vinciguerra38a4ec72018-11-28 11:34:21 -0800261 logger.error("Subprocess returned with return code "
262 "while running `file' utility on core-file "
263 "returned: "
264 "rc=%s", e.returncode)
265 except OSError as e:
266 logger.error("Subprocess returned with OS error while "
267 "running 'file' utility "
268 "on core-file: "
269 "(%s) %s", e.errno, e.strerror)
270 except Exception as e:
271 logger.exception("Unexpected error running `file' utility "
272 "on core-file")
juraj.linkes40dd73b2018-09-21 13:55:16 +0200273
274 if vpp_pid:
275 # Copy api post mortem
276 api_post_mortem_path = "/tmp/api_post_mortem.%d" % vpp_pid
277 if os.path.isfile(api_post_mortem_path):
278 logger.error("Copying api_post_mortem.%d to %s" %
279 (vpp_pid, last_test_temp_dir))
280 shutil.copy2(api_post_mortem_path, last_test_temp_dir)
281
282
283def check_and_handle_core(vpp_binary, tempdir, core_crash_test):
284 if is_core_present(tempdir):
Klement Sekeraf40ee3a2019-05-06 19:11:25 +0200285 if debug_core:
286 print('VPP core detected in %s. Last test running was %s' %
287 (tempdir, core_crash_test))
288 print(single_line_delim)
289 spawn_gdb(vpp_binary, get_core_path(tempdir))
290 print(single_line_delim)
291 elif compress_core:
292 print("Compressing core-file in test directory `%s'" % tempdir)
293 os.system("gzip %s" % get_core_path(tempdir))
juraj.linkes40dd73b2018-09-21 13:55:16 +0200294
295
296def handle_cores(failed_testcases):
Klement Sekeraf40ee3a2019-05-06 19:11:25 +0200297 for failed_testcase in failed_testcases:
298 tcs_with_core = failed_testcase.testclasess_with_core
299 if tcs_with_core:
300 for test, vpp_binary, tempdir in tcs_with_core.values():
301 check_and_handle_core(vpp_binary, tempdir, test)
juraj.linkes40dd73b2018-09-21 13:55:16 +0200302
303
304def process_finished_testsuite(wrapped_testcase_suite,
305 finished_testcase_suites,
306 failed_wrapped_testcases,
307 results):
308 results.append(wrapped_testcase_suite.result)
309 finished_testcase_suites.add(wrapped_testcase_suite)
310 stop_run = False
311 if failfast and not wrapped_testcase_suite.was_successful():
312 stop_run = True
313
314 if not wrapped_testcase_suite.was_successful():
315 failed_wrapped_testcases.add(wrapped_testcase_suite)
316 handle_failed_suite(wrapped_testcase_suite.logger,
317 wrapped_testcase_suite.last_test_temp_dir,
318 wrapped_testcase_suite.vpp_pid)
319
320 return stop_run
321
322
juraj.linkes721872e2018-09-05 18:13:45 +0200323def run_forked(testcase_suites):
juraj.linkes184870a2018-07-16 14:22:01 +0200324 wrapped_testcase_suites = set()
325
326 # suites are unhashable, need to use list
327 results = []
juraj.linkes184870a2018-07-16 14:22:01 +0200328 unread_testcases = set()
329 finished_unread_testcases = set()
330 manager = StreamQueueManager()
331 manager.start()
332 for i in range(concurrent_tests):
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800333 if testcase_suites:
juraj.linkes721872e2018-09-05 18:13:45 +0200334 wrapped_testcase_suite = TestCaseWrapper(testcase_suites.pop(0),
335 manager)
juraj.linkes184870a2018-07-16 14:22:01 +0200336 wrapped_testcase_suites.add(wrapped_testcase_suite)
337 unread_testcases.add(wrapped_testcase_suite)
juraj.linkes184870a2018-07-16 14:22:01 +0200338 else:
339 break
340
341 read_from_testcases = threading.Event()
342 read_from_testcases.set()
343 stdouterr_thread = threading.Thread(target=stdouterr_reader_wrapper,
344 args=(unread_testcases,
345 finished_unread_testcases,
346 read_from_testcases))
347 stdouterr_thread.start()
348
juraj.linkes40dd73b2018-09-21 13:55:16 +0200349 failed_wrapped_testcases = set()
350 stop_run = False
juraj.linkese6b58cf2018-11-29 09:56:35 +0100351
352 try:
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800353 while wrapped_testcase_suites:
juraj.linkese6b58cf2018-11-29 09:56:35 +0100354 finished_testcase_suites = set()
355 for wrapped_testcase_suite in wrapped_testcase_suites:
356 while wrapped_testcase_suite.result_parent_end.poll():
357 wrapped_testcase_suite.result.process_result(
358 *wrapped_testcase_suite.result_parent_end.recv())
359 wrapped_testcase_suite.last_heard = time.time()
360
361 while wrapped_testcase_suite.keep_alive_parent_end.poll():
362 wrapped_testcase_suite.last_test, \
363 wrapped_testcase_suite.last_test_vpp_binary, \
364 wrapped_testcase_suite.last_test_temp_dir, \
365 wrapped_testcase_suite.vpp_pid = \
366 wrapped_testcase_suite.keep_alive_parent_end.recv()
367 wrapped_testcase_suite.last_heard = time.time()
368
369 if wrapped_testcase_suite.finished_parent_end.poll():
370 wrapped_testcase_suite.finished_parent_end.recv()
371 wrapped_testcase_suite.last_heard = time.time()
372 stop_run = process_finished_testsuite(
373 wrapped_testcase_suite,
374 finished_testcase_suites,
375 failed_wrapped_testcases,
376 results) or stop_run
377 continue
378
379 fail = False
380 if wrapped_testcase_suite.last_heard + test_timeout < \
381 time.time():
382 fail = True
383 wrapped_testcase_suite.logger.critical(
384 "Child test runner process timed out "
385 "(last test running was `%s' in `%s')!" %
386 (wrapped_testcase_suite.last_test,
387 wrapped_testcase_suite.last_test_temp_dir))
388 elif not wrapped_testcase_suite.child.is_alive():
389 fail = True
390 wrapped_testcase_suite.logger.critical(
391 "Child test runner process unexpectedly died "
392 "(last test running was `%s' in `%s')!" %
393 (wrapped_testcase_suite.last_test,
394 wrapped_testcase_suite.last_test_temp_dir))
395 elif wrapped_testcase_suite.last_test_temp_dir and \
396 wrapped_testcase_suite.last_test_vpp_binary:
397 if is_core_present(
398 wrapped_testcase_suite.last_test_temp_dir):
399 wrapped_testcase_suite.add_testclass_with_core()
400 if wrapped_testcase_suite.core_detected_at is None:
401 wrapped_testcase_suite.core_detected_at = \
402 time.time()
403 elif wrapped_testcase_suite.core_detected_at + \
404 core_timeout < time.time():
405 wrapped_testcase_suite.logger.critical(
406 "Child test runner process unresponsive and "
407 "core-file exists in test temporary directory "
408 "(last test running was `%s' in `%s')!" %
409 (wrapped_testcase_suite.last_test,
410 wrapped_testcase_suite.last_test_temp_dir))
411 fail = True
412
413 if fail:
414 wrapped_testcase_suite.child.terminate()
415 try:
416 # terminating the child process tends to leave orphan
417 # VPP process around
418 if wrapped_testcase_suite.vpp_pid:
419 os.kill(wrapped_testcase_suite.vpp_pid,
420 signal.SIGTERM)
421 except OSError:
422 # already dead
423 pass
424 wrapped_testcase_suite.result.crashed = True
425 wrapped_testcase_suite.result.process_result(
426 wrapped_testcase_suite.last_test_id, ERROR)
427 stop_run = process_finished_testsuite(
428 wrapped_testcase_suite,
429 finished_testcase_suites,
430 failed_wrapped_testcases,
431 results) or stop_run
432
433 for finished_testcase in finished_testcase_suites:
434 finished_testcase.child.join()
435 finished_testcase.close_pipes()
436 wrapped_testcase_suites.remove(finished_testcase)
437 finished_unread_testcases.add(finished_testcase)
438 finished_testcase.stdouterr_queue.put(None)
439 if stop_run:
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800440 while testcase_suites:
juraj.linkese6b58cf2018-11-29 09:56:35 +0100441 results.append(TestResult(testcase_suites.pop(0)))
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800442 elif testcase_suites:
juraj.linkese6b58cf2018-11-29 09:56:35 +0100443 new_testcase = TestCaseWrapper(testcase_suites.pop(0),
444 manager)
445 wrapped_testcase_suites.add(new_testcase)
446 unread_testcases.add(new_testcase)
Paul Vinciguerrac0692a42019-03-15 19:16:50 -0700447 time.sleep(0.1)
juraj.linkese6b58cf2018-11-29 09:56:35 +0100448 except Exception:
juraj.linkes184870a2018-07-16 14:22:01 +0200449 for wrapped_testcase_suite in wrapped_testcase_suites:
juraj.linkese6b58cf2018-11-29 09:56:35 +0100450 wrapped_testcase_suite.child.terminate()
451 wrapped_testcase_suite.stdouterr_queue.put(None)
452 raise
453 finally:
454 read_from_testcases.clear()
455 stdouterr_thread.join(test_timeout)
456 manager.shutdown()
juraj.linkescae64f82018-09-19 15:01:47 +0200457
juraj.linkes40dd73b2018-09-21 13:55:16 +0200458 handle_cores(failed_wrapped_testcases)
juraj.linkes184870a2018-07-16 14:22:01 +0200459 return results
460
461
462class SplitToSuitesCallback:
463 def __init__(self, filter_callback):
464 self.suites = {}
465 self.suite_name = 'default'
466 self.filter_callback = filter_callback
467 self.filtered = unittest.TestSuite()
Klement Sekerafcbf4442017-08-17 07:38:42 +0200468
469 def __call__(self, file_name, cls, method):
juraj.linkes184870a2018-07-16 14:22:01 +0200470 test_method = cls(method)
471 if self.filter_callback(file_name, cls.__name__, method):
472 self.suite_name = file_name + cls.__name__
473 if self.suite_name not in self.suites:
474 self.suites[self.suite_name] = unittest.TestSuite()
475 self.suites[self.suite_name].addTest(test_method)
476
477 else:
478 self.filtered.addTest(test_method)
Klement Sekerafcbf4442017-08-17 07:38:42 +0200479
480
juraj.linkes184870a2018-07-16 14:22:01 +0200481test_option = "TEST"
482
483
484def parse_test_option():
485 f = os.getenv(test_option, None)
486 filter_file_name = None
487 filter_class_name = None
488 filter_func_name = None
489 if f:
490 if '.' in f:
491 parts = f.split('.')
492 if len(parts) > 3:
493 raise Exception("Unrecognized %s option: %s" %
494 (test_option, f))
495 if len(parts) > 2:
496 if parts[2] not in ('*', ''):
497 filter_func_name = parts[2]
498 if parts[1] not in ('*', ''):
499 filter_class_name = parts[1]
500 if parts[0] not in ('*', ''):
501 if parts[0].startswith('test_'):
502 filter_file_name = parts[0]
503 else:
504 filter_file_name = 'test_%s' % parts[0]
505 else:
506 if f.startswith('test_'):
507 filter_file_name = f
508 else:
509 filter_file_name = 'test_%s' % f
510 if filter_file_name:
511 filter_file_name = '%s.py' % filter_file_name
512 return filter_file_name, filter_class_name, filter_func_name
513
514
515def filter_tests(tests, filter_cb):
516 result = unittest.suite.TestSuite()
517 for t in tests:
518 if isinstance(t, unittest.suite.TestSuite):
519 # this is a bunch of tests, recursively filter...
520 x = filter_tests(t, filter_cb)
521 if x.countTestCases() > 0:
522 result.addTest(x)
523 elif isinstance(t, unittest.TestCase):
524 # this is a single test
525 parts = t.id().split('.')
526 # t.id() for common cases like this:
527 # test_classifier.TestClassifier.test_acl_ip
528 # apply filtering only if it is so
529 if len(parts) == 3:
530 if not filter_cb(parts[0], parts[1], parts[2]):
531 continue
532 result.addTest(t)
533 else:
534 # unexpected object, don't touch it
535 result.addTest(t)
536 return result
537
538
539class FilterByTestOption:
540 def __init__(self, filter_file_name, filter_class_name, filter_func_name):
541 self.filter_file_name = filter_file_name
542 self.filter_class_name = filter_class_name
543 self.filter_func_name = filter_func_name
544
545 def __call__(self, file_name, class_name, func_name):
Andrew Yourtchenkod760f792018-10-03 11:38:31 +0200546 if self.filter_file_name:
547 fn_match = fnmatch.fnmatch(file_name, self.filter_file_name)
548 if not fn_match:
549 return False
juraj.linkes184870a2018-07-16 14:22:01 +0200550 if self.filter_class_name and class_name != self.filter_class_name:
551 return False
552 if self.filter_func_name and func_name != self.filter_func_name:
553 return False
554 return True
555
556
557class FilterByClassList:
juraj.linkes721872e2018-09-05 18:13:45 +0200558 def __init__(self, classes_with_filenames):
559 self.classes_with_filenames = classes_with_filenames
Klement Sekeradf2b9802017-10-05 10:26:03 +0200560
561 def __call__(self, file_name, class_name, func_name):
juraj.linkes721872e2018-09-05 18:13:45 +0200562 return '.'.join([file_name, class_name]) in self.classes_with_filenames
Klement Sekeradf2b9802017-10-05 10:26:03 +0200563
564
565def suite_from_failed(suite, failed):
juraj.linkes721872e2018-09-05 18:13:45 +0200566 failed = {x.rsplit('.', 1)[0] for x in failed}
juraj.linkes184870a2018-07-16 14:22:01 +0200567 filter_cb = FilterByClassList(failed)
568 suite = filter_tests(suite, filter_cb)
Klement Sekera4c5422e2018-06-22 13:19:45 +0200569 return suite
Klement Sekeradf2b9802017-10-05 10:26:03 +0200570
571
juraj.linkescae64f82018-09-19 15:01:47 +0200572class AllResults(dict):
juraj.linkes184870a2018-07-16 14:22:01 +0200573 def __init__(self):
juraj.linkescae64f82018-09-19 15:01:47 +0200574 super(AllResults, self).__init__()
juraj.linkes184870a2018-07-16 14:22:01 +0200575 self.all_testcases = 0
juraj.linkescae64f82018-09-19 15:01:47 +0200576 self.results_per_suite = []
577 self[PASS] = 0
578 self[FAIL] = 0
579 self[ERROR] = 0
580 self[SKIP] = 0
581 self[TEST_RUN] = 0
juraj.linkes184870a2018-07-16 14:22:01 +0200582 self.rerun = []
juraj.linkescae64f82018-09-19 15:01:47 +0200583 self.testsuites_no_tests_run = []
Klement Sekera909a6a12017-08-08 04:33:53 +0200584
juraj.linkescae64f82018-09-19 15:01:47 +0200585 def add_results(self, result):
586 self.results_per_suite.append(result)
587 result_types = [PASS, FAIL, ERROR, SKIP, TEST_RUN]
588 for result_type in result_types:
589 self[result_type] += len(result[result_type])
Klement Sekera05742262018-03-14 18:14:49 +0100590
juraj.linkescae64f82018-09-19 15:01:47 +0200591 def add_result(self, result):
juraj.linkes184870a2018-07-16 14:22:01 +0200592 retval = 0
juraj.linkescae64f82018-09-19 15:01:47 +0200593 self.all_testcases += result.testcase_suite.countTestCases()
juraj.linkes40dd73b2018-09-21 13:55:16 +0200594 self.add_results(result)
juraj.linkes184870a2018-07-16 14:22:01 +0200595
juraj.linkes40dd73b2018-09-21 13:55:16 +0200596 if result.no_tests_run():
juraj.linkescae64f82018-09-19 15:01:47 +0200597 self.testsuites_no_tests_run.append(result.testcase_suite)
juraj.linkes40dd73b2018-09-21 13:55:16 +0200598 if result.crashed:
599 retval = -1
600 else:
601 retval = 1
602 elif not result.was_successful():
603 retval = 1
juraj.linkes184870a2018-07-16 14:22:01 +0200604
juraj.linkes184870a2018-07-16 14:22:01 +0200605 if retval != 0:
juraj.linkesabec0122018-11-16 17:28:56 +0100606 self.rerun.append(result.testcase_suite)
juraj.linkes184870a2018-07-16 14:22:01 +0200607
608 return retval
609
610 def print_results(self):
611 print('')
612 print(double_line_delim)
613 print('TEST RESULTS:')
juraj.linkescae64f82018-09-19 15:01:47 +0200614 print(' Scheduled tests: {}'.format(self.all_testcases))
615 print(' Executed tests: {}'.format(self[TEST_RUN]))
616 print(' Passed tests: {}'.format(
617 colorize(str(self[PASS]), GREEN)))
618 if self[SKIP] > 0:
619 print(' Skipped tests: {}'.format(
620 colorize(str(self[SKIP]), YELLOW)))
621 if self.not_executed > 0:
622 print(' Not Executed tests: {}'.format(
623 colorize(str(self.not_executed), RED)))
624 if self[FAIL] > 0:
625 print(' Failures: {}'.format(
626 colorize(str(self[FAIL]), RED)))
627 if self[ERROR] > 0:
628 print(' Errors: {}'.format(
629 colorize(str(self[ERROR]), RED)))
juraj.linkes184870a2018-07-16 14:22:01 +0200630
631 if self.all_failed > 0:
juraj.linkes40dd73b2018-09-21 13:55:16 +0200632 print('FAILURES AND ERRORS IN TESTS:')
juraj.linkescae64f82018-09-19 15:01:47 +0200633 for result in self.results_per_suite:
634 failed_testcase_ids = result[FAIL]
635 errored_testcase_ids = result[ERROR]
636 old_testcase_name = None
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800637 if failed_testcase_ids or errored_testcase_ids:
juraj.linkescae64f82018-09-19 15:01:47 +0200638 for failed_test_id in failed_testcase_ids:
639 new_testcase_name, test_name = \
640 result.get_testcase_names(failed_test_id)
641 if new_testcase_name != old_testcase_name:
642 print(' Testcase name: {}'.format(
643 colorize(new_testcase_name, RED)))
644 old_testcase_name = new_testcase_name
Klement Sekera33177d62018-11-30 14:17:20 +0100645 print(' FAILURE: {} [{}]'.format(
646 colorize(test_name, RED), failed_test_id))
juraj.linkescae64f82018-09-19 15:01:47 +0200647 for failed_test_id in errored_testcase_ids:
648 new_testcase_name, test_name = \
649 result.get_testcase_names(failed_test_id)
650 if new_testcase_name != old_testcase_name:
651 print(' Testcase name: {}'.format(
652 colorize(new_testcase_name, RED)))
653 old_testcase_name = new_testcase_name
Klement Sekera33177d62018-11-30 14:17:20 +0100654 print(' ERROR: {} [{}]'.format(
655 colorize(test_name, RED), failed_test_id))
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800656 if self.testsuites_no_tests_run:
juraj.linkescae64f82018-09-19 15:01:47 +0200657 print('TESTCASES WHERE NO TESTS WERE SUCCESSFULLY EXECUTED:')
juraj.linkes40dd73b2018-09-21 13:55:16 +0200658 tc_classes = set()
juraj.linkescae64f82018-09-19 15:01:47 +0200659 for testsuite in self.testsuites_no_tests_run:
660 for testcase in testsuite:
661 tc_classes.add(get_testcase_doc_name(testcase))
662 for tc_class in tc_classes:
663 print(' {}'.format(colorize(tc_class, RED)))
juraj.linkes184870a2018-07-16 14:22:01 +0200664
665 print(double_line_delim)
666 print('')
667
668 @property
juraj.linkescae64f82018-09-19 15:01:47 +0200669 def not_executed(self):
670 return self.all_testcases - self[TEST_RUN]
671
672 @property
juraj.linkes184870a2018-07-16 14:22:01 +0200673 def all_failed(self):
juraj.linkescae64f82018-09-19 15:01:47 +0200674 return self[FAIL] + self[ERROR]
juraj.linkes184870a2018-07-16 14:22:01 +0200675
676
677def parse_results(results):
678 """
juraj.linkescae64f82018-09-19 15:01:47 +0200679 Prints the number of scheduled, executed, not executed, passed, failed,
680 errored and skipped tests and details about failed and errored tests.
juraj.linkes184870a2018-07-16 14:22:01 +0200681
juraj.linkescae64f82018-09-19 15:01:47 +0200682 Also returns all suites where any test failed.
juraj.linkes184870a2018-07-16 14:22:01 +0200683
684 :param results:
685 :return:
686 """
687
juraj.linkescae64f82018-09-19 15:01:47 +0200688 results_per_suite = AllResults()
juraj.linkes184870a2018-07-16 14:22:01 +0200689 crashed = False
690 failed = False
juraj.linkescae64f82018-09-19 15:01:47 +0200691 for result in results:
692 result_code = results_per_suite.add_result(result)
juraj.linkes184870a2018-07-16 14:22:01 +0200693 if result_code == 1:
694 failed = True
695 elif result_code == -1:
696 crashed = True
697
698 results_per_suite.print_results()
699
700 if crashed:
701 return_code = -1
702 elif failed:
703 return_code = 1
704 else:
705 return_code = 0
706 return return_code, results_per_suite.rerun
707
708
709def parse_digit_env(env_var, default):
710 value = os.getenv(env_var, default)
711 if value != default:
712 if value.isdigit():
713 value = int(value)
714 else:
715 print('WARNING: unsupported value "%s" for env var "%s",'
716 'defaulting to %s' % (value, env_var, default))
717 value = default
718 return value
Klement Sekera3f6ff192017-08-11 06:56:05 +0200719
720
721if __name__ == '__main__':
722
juraj.linkes184870a2018-07-16 14:22:01 +0200723 verbose = parse_digit_env("V", 0)
Klement Sekera3f6ff192017-08-11 06:56:05 +0200724
juraj.linkes184870a2018-07-16 14:22:01 +0200725 test_timeout = parse_digit_env("TIMEOUT", 600) # default = 10 minutes
Klement Sekera3f6ff192017-08-11 06:56:05 +0200726
juraj.linkes184870a2018-07-16 14:22:01 +0200727 retries = parse_digit_env("RETRIES", 0)
Klement Sekera3f6ff192017-08-11 06:56:05 +0200728
juraj.linkes184870a2018-07-16 14:22:01 +0200729 debug = os.getenv("DEBUG", "n").lower() in ["gdb", "gdbserver"]
730
juraj.linkes40dd73b2018-09-21 13:55:16 +0200731 debug_core = os.getenv("DEBUG", "").lower() == "core"
Klement Sekeraf40ee3a2019-05-06 19:11:25 +0200732 compress_core = os.getenv("CORE_COMPRESS", "").lower() in ("y", "yes", "1")
juraj.linkes40dd73b2018-09-21 13:55:16 +0200733
juraj.linkes184870a2018-07-16 14:22:01 +0200734 step = os.getenv("STEP", "n").lower() in ("y", "yes", "1")
735
juraj.linkes40dd73b2018-09-21 13:55:16 +0200736 run_interactive = debug or step
juraj.linkes184870a2018-07-16 14:22:01 +0200737
738 test_jobs = os.getenv("TEST_JOBS", "1").lower() # default = 1 process
739 if test_jobs == 'auto':
740 if run_interactive:
741 concurrent_tests = 1
742 print('Interactive mode required, running on one core')
743 else:
744 shm_free = psutil.disk_usage('/dev/shm').free
745 shm_max_processes = 1
746 if shm_free < min_req_shm:
747 raise Exception('Not enough free space in /dev/shm. Required '
748 'free space is at least %sM.'
749 % (min_req_shm >> 20))
750 else:
751 extra_shm = shm_free - min_req_shm
752 shm_max_processes += extra_shm / shm_per_process
Klement Sekera6c7bda92018-09-18 14:32:27 +0200753 concurrent_tests = min(cpu_count(), shm_max_processes)
juraj.linkes184870a2018-07-16 14:22:01 +0200754 print('Found enough resources to run tests with %s cores'
755 % concurrent_tests)
756 elif test_jobs.isdigit():
757 concurrent_tests = int(test_jobs)
758 else:
759 concurrent_tests = 1
760
761 if run_interactive and concurrent_tests > 1:
762 raise NotImplementedError(
juraj.linkes40dd73b2018-09-21 13:55:16 +0200763 'Running tests interactively (DEBUG is gdb or gdbserver or STEP '
764 'is set) in parallel (TEST_JOBS is more than 1) is not supported')
Klement Sekera13a83ef2018-03-21 12:35:51 +0100765
Klement Sekera3f6ff192017-08-11 06:56:05 +0200766 parser = argparse.ArgumentParser(description="VPP unit tests")
juraj.linkes184870a2018-07-16 14:22:01 +0200767 parser.add_argument("-f", "--failfast", action='store_true',
Klement Sekera3f6ff192017-08-11 06:56:05 +0200768 help="fast failure flag")
769 parser.add_argument("-d", "--dir", action='append', type=str,
770 help="directory containing test files "
771 "(may be specified multiple times)")
772 args = parser.parse_args()
juraj.linkes184870a2018-07-16 14:22:01 +0200773 failfast = args.failfast
774 descriptions = True
Klement Sekera3f6ff192017-08-11 06:56:05 +0200775
juraj.linkes184870a2018-07-16 14:22:01 +0200776 print("Running tests using custom test runner") # debug message
777 filter_file, filter_class, filter_func = parse_test_option()
778
779 print("Active filters: file=%s, class=%s, function=%s" % (
780 filter_file, filter_class, filter_func))
781
782 filter_cb = FilterByTestOption(filter_file, filter_class, filter_func)
783
Klement Sekerab8c72a42018-11-08 11:21:39 +0100784 ignore_path = os.getenv("VENV_PATH", None)
juraj.linkes184870a2018-07-16 14:22:01 +0200785 cb = SplitToSuitesCallback(filter_cb)
Klement Sekera3f6ff192017-08-11 06:56:05 +0200786 for d in args.dir:
Klement Sekeradf2b9802017-10-05 10:26:03 +0200787 print("Adding tests from directory tree %s" % d)
Klement Sekerab8c72a42018-11-08 11:21:39 +0100788 discover_tests(d, cb, ignore_path)
Klement Sekera3f6ff192017-08-11 06:56:05 +0200789
juraj.linkes184870a2018-07-16 14:22:01 +0200790 # suites are not hashable, need to use list
791 suites = []
792 tests_amount = 0
793 for testcase_suite in cb.suites.values():
794 tests_amount += testcase_suite.countTestCases()
795 suites.append(testcase_suite)
Klement Sekerabbfa5fd2018-06-27 13:54:32 +0200796
juraj.linkes184870a2018-07-16 14:22:01 +0200797 print("%s out of %s tests match specified filters" % (
798 tests_amount, tests_amount + cb.filtered.countTestCases()))
799
Paul Vinciguerradefde0f2018-12-06 07:46:13 -0800800 if not running_extended_tests:
juraj.linkes184870a2018-07-16 14:22:01 +0200801 print("Not running extended tests (some tests will be skipped)")
802
Klement Sekeradf2b9802017-10-05 10:26:03 +0200803 attempts = retries + 1
804 if attempts > 1:
805 print("Perform %s attempts to pass the suite..." % attempts)
juraj.linkes184870a2018-07-16 14:22:01 +0200806
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800807 if run_interactive and suites:
juraj.linkes184870a2018-07-16 14:22:01 +0200808 # don't fork if requiring interactive terminal
juraj.linkes46e8e912019-01-10 12:13:07 +0100809 full_suite = unittest.TestSuite()
810 map(full_suite.addTests, suites)
juraj.linkesabec0122018-11-16 17:28:56 +0100811 result = VppTestRunner(verbosity=verbose,
812 failfast=failfast,
juraj.linkes46e8e912019-01-10 12:13:07 +0100813 print_summary=True).run(full_suite)
juraj.linkes40dd73b2018-09-21 13:55:16 +0200814 was_successful = result.wasSuccessful()
815 if not was_successful:
816 for test_case_info in result.failed_test_cases_info:
817 handle_failed_suite(test_case_info.logger,
818 test_case_info.tempdir,
819 test_case_info.vpp_pid)
Klement Sekeraf40ee3a2019-05-06 19:11:25 +0200820 if test_case_info in result.core_crash_test_cases_info:
juraj.linkes40dd73b2018-09-21 13:55:16 +0200821 check_and_handle_core(test_case_info.vpp_bin_path,
822 test_case_info.tempdir,
823 test_case_info.core_crash_test)
824
825 sys.exit(not was_successful)
Klement Sekera13a83ef2018-03-21 12:35:51 +0100826 else:
juraj.linkes184870a2018-07-16 14:22:01 +0200827 exit_code = 0
Naveen Joy2cbf2fb2019-03-06 10:41:06 -0800828 while suites and attempts > 0:
juraj.linkes184870a2018-07-16 14:22:01 +0200829 results = run_forked(suites)
830 exit_code, suites = parse_results(results)
831 attempts -= 1
832 if exit_code == 0:
833 print('Test run was successful')
834 else:
835 print('%s attempt(s) left.' % attempts)
836 sys.exit(exit_code)