4 # Copyright (c) 2013-2015, Jouni Malinen <j@w1.fi>
6 # This software may be distributed under the terms of the BSD license.
7 # See README for more details.
13 from datetime import datetime
19 logger = logging.getLogger()
23 sqlite3_imported = True
25 sqlite3_imported = False
27 scriptsdir = os.path.dirname(os.path.realpath(sys.modules[__name__].__file__))
28 sys.path.append(os.path.join(scriptsdir, '..', '..', 'wpaspy'))
30 from wpasupplicant import WpaSupplicant
31 from hostapd import HostapdGlobal
32 from check_kernel import check_kernel
33 from wlantest import Wlantest
34 from utils import HwsimSkip
36 def set_term_echo(fd, enabled):
37 [iflag, oflag, cflag, lflag, ispeed, ospeed, cc] = termios.tcgetattr(fd)
41 lflag &= ~termios.ECHO
42 termios.tcsetattr(fd, termios.TCSANOW,
43 [iflag, oflag, cflag, lflag, ispeed, ospeed, cc])
45 def reset_devs(dev, apdev):
51 logger.info("Failed to reset device " + d.ifname)
57 wpas = WpaSupplicant(global_iface='/tmp/wpas-wlan5')
58 ifaces = wpas.global_request("INTERFACES").splitlines()
60 if iface.startswith("wlan"):
61 wpas.interface_remove(iface)
68 hapd = HostapdGlobal()
70 hapd.remove('wlan3-3')
71 hapd.remove('wlan3-2')
73 hapd.remove(ap['ifname'])
75 logger.info("Failed to remove hostapd interface")
80 def add_log_file(conn, test, run, type, path):
81 if not os.path.exists(path):
84 with open(path, 'r') as f:
88 sql = "INSERT INTO logs(test,run,type,contents) VALUES(?, ?, ?, ?)"
89 params = (test, run, type, sqlite3.Binary(contents))
91 conn.execute(sql, params)
94 print "sqlite: " + str(e)
95 print "sql: %r" % (params, )
97 def report(conn, prefill, build, commit, run, test, result, duration, logdir,
105 conn.execute('DELETE FROM results WHERE test=? AND run=? AND result=?', (test, run, 'NOTRUN'))
106 sql = "INSERT INTO results(test,result,run,time,duration,build,commitid) VALUES(?, ?, ?, ?, ?, ?, ?)"
107 params = (test, result, run, time.time(), duration, build, commit)
109 conn.execute(sql, params)
113 print "sqlite: " + str(e)
114 print "sql: %r" % (params, )
117 for log in [ "log", "log0", "log1", "log2", "log3", "log5",
118 "hostapd", "dmesg", "hwsim0", "hwsim0.pcapng" ]:
119 add_log_file(conn, test, run, log,
120 logdir + "/" + test + "." + log)
122 class DataCollector(object):
123 def __init__(self, logdir, testname, tracing, dmesg):
124 self._logdir = logdir
125 self._testname = testname
126 self._tracing = tracing
130 output = os.path.abspath(os.path.join(self._logdir, '%s.dat' % (self._testname, )))
131 self._trace_cmd = subprocess.Popen(['trace-cmd', 'record', '-o', output, '-e', 'mac80211', '-e', 'cfg80211', '-e', 'printk', 'sh', '-c', 'echo STARTED ; read l'],
132 stdin=subprocess.PIPE,
133 stdout=subprocess.PIPE,
134 stderr=open('/dev/null', 'w'),
136 l = self._trace_cmd.stdout.read(7)
137 while self._trace_cmd.poll() is None and not 'STARTED' in l:
138 l += self._trace_cmd.stdout.read(1)
139 res = self._trace_cmd.returncode
141 print "Failed calling trace-cmd: returned exit status %d" % res
143 def __exit__(self, type, value, traceback):
145 self._trace_cmd.stdin.write('DONE\n')
146 self._trace_cmd.wait()
148 output = os.path.join(self._logdir, '%s.dmesg' % (self._testname, ))
150 while os.path.exists(output):
151 output = os.path.join(self._logdir, '%s.dmesg-%d' % (self._testname, num))
153 subprocess.call(['dmesg', '-c'], stdout=open(output, 'w'))
155 def rename_log(logdir, basename, testname, dev):
158 srcname = os.path.join(logdir, basename)
159 dstname = os.path.join(logdir, testname + '.' + basename)
161 while os.path.exists(dstname):
162 dstname = os.path.join(logdir,
163 testname + '.' + basename + '-' + str(num))
165 os.rename(srcname, dstname)
168 subprocess.call(['chown', '-f', getpass.getuser(), srcname])
170 logger.info("Failed to rename log files")
176 files = os.listdir(scriptsdir)
178 m = re.match(r'(test_.*)\.py$', t)
180 logger.debug("Import test cases from " + t)
181 mod = __import__(m.group(1))
182 test_modules.append(mod.__name__.replace('test_', '', 1))
183 for key,val in mod.__dict__.iteritems():
184 if key.startswith("test_"):
186 test_names = list(set([t.__name__.replace('test_', '', 1) for t in tests]))
190 parser = argparse.ArgumentParser(description='hwsim test runner')
191 parser.add_argument('--logdir', metavar='<directory>',
192 help='log output directory for all other options, ' +
193 'must be given if other log options are used')
194 group = parser.add_mutually_exclusive_group()
195 group.add_argument('-d', const=logging.DEBUG, action='store_const',
196 dest='loglevel', default=logging.INFO,
197 help="verbose debug output")
198 group.add_argument('-q', const=logging.WARNING, action='store_const',
199 dest='loglevel', help="be quiet")
201 parser.add_argument('-S', metavar='<sqlite3 db>', dest='database',
202 help='database to write results to')
203 parser.add_argument('--prefill-tests', action='store_true', dest='prefill',
204 help='prefill test database with NOTRUN before all tests')
205 parser.add_argument('--commit', metavar='<commit id>',
206 help='commit ID, only for database')
207 parser.add_argument('-b', metavar='<build>', dest='build', help='build ID')
208 parser.add_argument('-L', action='store_true', dest='update_tests_db',
209 help='List tests (and update descriptions in DB)')
210 parser.add_argument('-T', action='store_true', dest='tracing',
211 help='collect tracing per test case (in log directory)')
212 parser.add_argument('-D', action='store_true', dest='dmesg',
213 help='collect dmesg per test case (in log directory)')
214 parser.add_argument('--shuffle-tests', action='store_true',
215 dest='shuffle_tests',
216 help='Shuffle test cases to randomize order')
217 parser.add_argument('--split', help='split tests for parallel execution (<server number>/<total servers>)')
218 parser.add_argument('--no-reset', action='store_true', dest='no_reset',
219 help='Do not reset devices at the end of the test')
220 parser.add_argument('--long', action='store_true',
221 help='Include test cases that take long time')
222 parser.add_argument('-f', dest='testmodules', metavar='<test module>',
223 help='execute only tests from these test modules',
224 type=str, choices=[[]] + test_modules, nargs='+')
225 parser.add_argument('-l', metavar='<modules file>', dest='mfile',
226 help='test modules file name')
227 parser.add_argument('-i', action='store_true', dest='stdin_ctrl',
228 help='stdin-controlled test case execution')
229 parser.add_argument('tests', metavar='<test>', nargs='*', type=str,
230 help='tests to run (only valid without -f)',
231 choices=[[]] + test_names)
233 args = parser.parse_args()
235 if (args.tests and args.testmodules) or (args.tests and args.mfile) or (args.testmodules and args.mfile):
236 print 'Invalid arguments - only one of (test, test modules, modules file) can be given.'
240 if not sqlite3_imported:
241 print "No sqlite3 module found"
243 conn = sqlite3.connect(args.database)
244 conn.execute('CREATE TABLE IF NOT EXISTS results (test,result,run,time,duration,build,commitid)')
245 conn.execute('CREATE TABLE IF NOT EXISTS tests (test,description)')
246 conn.execute('CREATE TABLE IF NOT EXISTS logs (test,run,type,contents)')
251 run = int(time.time())
253 # read the modules from the modules file
255 args.testmodules = []
256 with open(args.mfile) as f:
257 for line in f.readlines():
259 if not line or line.startswith('#'):
261 args.testmodules.append(line)
265 for selected in args.tests:
267 name = t.__name__.replace('test_', '', 1)
269 tests_to_run.append(t)
272 name = t.__name__.replace('test_', '', 1)
274 if not t.__module__.replace('test_', '', 1) in args.testmodules:
276 tests_to_run.append(t)
278 if args.update_tests_db:
279 for t in tests_to_run:
280 name = t.__name__.replace('test_', '', 1)
281 if t.__doc__ is None:
282 print name + " - MISSING DESCRIPTION"
284 print name + " - " + t.__doc__
286 sql = 'INSERT OR REPLACE INTO tests(test,description) VALUES (?, ?)'
287 params = (name, t.__doc__)
289 conn.execute(sql, params)
291 print "sqlite: " + str(e)
292 print "sql: %r" % (params,)
299 if os.path.exists('logs/current'):
300 args.logdir = 'logs/current'
304 # Write debug level log to a file and configurable verbosity to stdout
305 logger.setLevel(logging.DEBUG)
307 stdout_handler = logging.StreamHandler()
308 stdout_handler.setLevel(args.loglevel)
309 logger.addHandler(stdout_handler)
311 file_name = os.path.join(args.logdir, 'run-tests.log')
312 log_handler = logging.FileHandler(file_name)
313 log_handler.setLevel(logging.DEBUG)
314 fmt = "%(asctime)s %(levelname)s %(message)s"
315 log_formatter = logging.Formatter(fmt)
316 log_handler.setFormatter(log_formatter)
317 logger.addHandler(log_handler)
319 dev0 = WpaSupplicant('wlan0', '/tmp/wpas-wlan0')
320 dev1 = WpaSupplicant('wlan1', '/tmp/wpas-wlan1')
321 dev2 = WpaSupplicant('wlan2', '/tmp/wpas-wlan2')
322 dev = [ dev0, dev1, dev2 ]
324 apdev.append({"ifname": 'wlan3', "bssid": "02:00:00:00:03:00"})
325 apdev.append({"ifname": 'wlan4', "bssid": "02:00:00:00:04:00"})
329 logger.info(d.ifname + ": No response from wpa_supplicant")
331 logger.info("DEV: " + d.ifname + ": " + d.p2p_dev_addr())
333 logger.info("APDEV: " + ap['ifname'])
339 # make sure nothing is left over from previous runs
340 # (if there were any other manual runs or we crashed)
341 if not reset_devs(dev, apdev):
348 subprocess.call(['dmesg', '-c'], stdout=open('/dev/null', 'w'))
350 if conn and args.prefill:
351 for t in tests_to_run:
352 name = t.__name__.replace('test_', '', 1)
353 report(conn, False, args.build, args.commit, run, name, 'NOTRUN', 0,
354 args.logdir, sql_commit=False)
358 vals = args.split.split('/')
359 split_server = int(vals[0])
360 split_total = int(vals[1])
361 logger.info("Parallel execution - %d/%d" % (split_server, split_total))
363 tests_to_run.sort(key=lambda t: t.__name__)
364 tests_to_run = [x for i,x in enumerate(tests_to_run) if i % split_total == split_server]
366 if args.shuffle_tests:
367 from random import shuffle
368 shuffle(tests_to_run)
376 num_tests = len(tests_to_run)
378 set_term_echo(sys.stdin.fileno(), False)
381 test = sys.stdin.readline()
384 test = test.splitlines()[0]
389 name = tt.__name__.replace('test_', '', 1)
398 if len(tests_to_run) == 0:
400 t = tests_to_run.pop(0)
402 name = t.__name__.replace('test_', '', 1)
404 log_handler.stream.close()
405 logger.removeHandler(log_handler)
406 file_name = os.path.join(args.logdir, name + '.log')
407 log_handler = logging.FileHandler(file_name)
408 log_handler.setLevel(logging.DEBUG)
409 log_handler.setFormatter(log_formatter)
410 logger.addHandler(log_handler)
413 with DataCollector(args.logdir, name, args.tracing, args.dmesg):
415 msg = "START {} {}/{}".format(name, count, num_tests)
417 if args.loglevel == logging.WARNING:
421 logger.info("Test: " + t.__doc__)
422 start = datetime.now()
427 raise Exception("PING failed for {}".format(d.ifname))
428 if not d.global_ping():
429 raise Exception("Global PING failed for {}".format(d.ifname))
430 d.request("NOTE TEST-START " + name)
432 logger.info("Failed to issue TEST-START before " + name + " for " + d.ifname)
434 print "FAIL " + name + " - could not start test"
439 set_term_echo(sys.stdin.fileno(), True)
442 if t.func_code.co_argcount > 2:
444 params['logdir'] = args.logdir
445 params['long'] = args.long
446 t(dev, apdev, params)
447 elif t.func_code.co_argcount > 1:
453 logger.info("Skip test case: %s" % e)
457 if args.loglevel == logging.WARNING:
458 print "Exception: " + str(e)
463 d.request("NOTE TEST-STOP " + name)
465 logger.info("Failed to issue TEST-STOP after {} for {}".format(name, d.ifname))
470 wpas = WpaSupplicant(global_iface="/tmp/wpas-wlan5")
471 rename_log(args.logdir, 'log5', name, wpas)
472 if not args.no_reset:
479 print "Leaving devices in current state"
481 reset_ok = reset_devs(dev, apdev)
483 for i in range(0, 3):
484 rename_log(args.logdir, 'log' + str(i), name, dev[i])
486 hapd = HostapdGlobal()
488 print "Failed to connect to hostapd interface"
493 rename_log(args.logdir, 'hostapd', name, hapd)
499 rename_log(args.logdir, 'hwsim0.pcapng', name, wt)
500 rename_log(args.logdir, 'hwsim0', name, wt)
501 if os.path.exists(os.path.join(args.logdir, 'fst-wpa_supplicant')):
502 rename_log(args.logdir, 'fst-wpa_supplicant', name, None)
503 if os.path.exists(os.path.join(args.logdir, 'fst-hostapd')):
504 rename_log(args.logdir, 'fst-hostapd', name, None)
509 if result == 'PASS' and args.dmesg:
510 if not check_kernel(os.path.join(args.logdir, name + '.dmesg')):
511 logger.info("Kernel issue found in dmesg - mark test failed")
516 elif result == 'SKIP':
521 report(conn, args.prefill, args.build, args.commit, run, name, result,
522 diff.total_seconds(), args.logdir)
523 result = "{} {} {} {}".format(result, name, diff.total_seconds(), end)
525 if args.loglevel == logging.WARNING:
530 print "Terminating early due to device reset failure"
533 set_term_echo(sys.stdin.fileno(), True)
536 log_handler.stream.close()
537 logger.removeHandler(log_handler)
538 file_name = os.path.join(args.logdir, 'run-tests.log')
539 log_handler = logging.FileHandler(file_name)
540 log_handler.setLevel(logging.DEBUG)
541 log_handler.setFormatter(log_formatter)
542 logger.addHandler(log_handler)
548 logger.info("passed {} test case(s)".format(len(passed)))
549 logger.info("skipped {} test case(s)".format(len(skipped)))
550 logger.info("failed tests: " + ' '.join(failed))
551 if args.loglevel == logging.WARNING:
552 print "failed tests: " + ' '.join(failed)
554 logger.info("passed all {} test case(s)".format(len(passed)))
556 logger.info("skipped {} test case(s)".format(len(skipped)))
557 if args.loglevel == logging.WARNING:
558 print "passed all {} test case(s)".format(len(passed))
560 print "skipped {} test case(s)".format(len(skipped))
562 if __name__ == "__main__":