tests/hwsim/run-tests.py

   1 #!/usr/bin/env python2
   2 #
   3 # Test case executor
   4 # Copyright (c) 2013-2014, Jouni Malinen <j@w1.fi>
   5 #
   6 # This software may be distributed under the terms of the BSD license.
   7 # See README for more details.
   8
   9 import os
  10 import re
  11 import sys
  12 import time
  13 from datetime import datetime
  14 import argparse
  15 import subprocess
  16
  17 import logging
  18 logger = logging.getLogger()
  19
  20 if os.path.exists('../../wpaspy'):
  21     sys.path.append('../../wpaspy')
  22 else:
  23     sys.path.append('../../../wpaspy')
  24
  25 from wpasupplicant import WpaSupplicant
  26 from hostapd import HostapdGlobal
  27 from check_kernel import check_kernel
  28 from wlantest import Wlantest
  29
  30 def reset_devs(dev, apdev):
  31     ok = True
  32     for d in dev:
  33         try:
  34             d.reset()
  35         except Exception, e:
  36             logger.info("Failed to reset device " + d.ifname)
  37             print str(e)
  38             ok = False
  39
  40     try:
  41         wpas = WpaSupplicant(global_iface='/tmp/wpas-wlan5')
  42         ifaces = wpas.global_request("INTERFACES").splitlines()
  43         for iface in ifaces:
  44             if iface.startswith("wlan"):
  45                 wpas.interface_remove(iface)
  46     except Exception, e:
  47         pass
  48
  49     try:
  50         hapd = HostapdGlobal()
  51         hapd.flush()
  52         hapd.remove('wlan3-3')
  53         hapd.remove('wlan3-2')
  54         for ap in apdev:
  55             hapd.remove(ap['ifname'])
  56     except Exception, e:
  57         logger.info("Failed to remove hostapd interface")
  58         print str(e)
  59         ok = False
  60     return ok
  61
  62 def add_log_file(conn, test, run, type, path):
  63     if not os.path.exists(path):
  64         return
  65     contents = None
  66     with open(path, 'r') as f:
  67         contents = f.read()
  68     if contents is None:
  69         return
  70     sql = "INSERT INTO logs(test,run,type,contents) VALUES(?, ?, ?, ?)"
  71     params = (test, run, type, contents)
  72     try:
  73         conn.execute(sql, params)
  74         conn.commit()
  75     except Exception, e:
  76         print "sqlite: " + str(e)
  77         print "sql: %r" % (params, )
  78
  79 def report(conn, prefill, build, commit, run, test, result, duration, logdir,
  80            sql_commit=True):
  81     if conn:
  82         if not build:
  83             build = ''
  84         if not commit:
  85             commit = ''
  86         if prefill:
  87             conn.execute('DELETE FROM results WHERE test=? AND run=? AND result=?', (test, run, 'NOTRUN'))
  88         sql = "INSERT INTO results(test,result,run,time,duration,build,commitid) VALUES(?, ?, ?, ?, ?, ?, ?)"
  89         params = (test, result, run, time.time(), duration, build, commit)
  90         try:
  91             conn.execute(sql, params)
  92             if sql_commit:
  93                 conn.commit()
  94         except Exception, e:
  95             print "sqlite: " + str(e)
  96             print "sql: %r" % (params, )
  97
  98         if result == "FAIL":
  99             for log in [ "log", "log0", "log1", "log2", "log3", "log5",
 100                          "hostapd", "dmesg", "hwsim0", "hwsim0.pcapng" ]:
 101                 add_log_file(conn, test, run, log,
 102                              logdir + "/" + test + "." + log)
 103
 104 class DataCollector(object):
 105     def __init__(self, logdir, testname, tracing, dmesg):
 106         self._logdir = logdir
 107         self._testname = testname
 108         self._tracing = tracing
 109         self._dmesg = dmesg
 110     def __enter__(self):
 111         if self._tracing:
 112             output = os.path.abspath(os.path.join(self._logdir, '%s.dat' % (self._testname, )))
 113             self._trace_cmd = subprocess.Popen(['sudo', 'trace-cmd', 'record', '-o', output, '-e', 'mac80211', '-e', 'cfg80211', 'sh', '-c', 'echo STARTED ; read l'],
 114                                                stdin=subprocess.PIPE,
 115                                                stdout=subprocess.PIPE,
 116                                                stderr=open('/dev/null', 'w'),
 117                                                cwd=self._logdir)
 118             l = self._trace_cmd.stdout.read(7)
 119             while self._trace_cmd.poll() is None and not 'STARTED' in l:
 120                 l += self._trace_cmd.stdout.read(1)
 121             res = self._trace_cmd.returncode
 122             if res:
 123                 print "Failed calling trace-cmd: returned exit status %d" % res
 124                 sys.exit(1)
 125     def __exit__(self, type, value, traceback):
 126         if self._tracing:
 127             self._trace_cmd.stdin.write('DONE\n')
 128             self._trace_cmd.wait()
 129         if self._dmesg:
 130             output = os.path.join(self._logdir, '%s.dmesg' % (self._testname, ))
 131             subprocess.call(['sudo', 'dmesg', '-c'], stdout=open(output, 'w'))
 132
 133 def rename_log(logdir, basename, testname, dev):
 134     try:
 135         import getpass
 136         srcname = os.path.join(logdir, basename)
 137         dstname = os.path.join(logdir, testname + '.' + basename)
 138         num = 0
 139         while os.path.exists(dstname):
 140             dstname = os.path.join(logdir,
 141                                    testname + '.' + basename + '-' + str(num))
 142             num = num + 1
 143         os.rename(srcname, dstname)
 144         if dev:
 145             dev.relog()
 146             subprocess.call(['sudo', 'chown', '-f', getpass.getuser(), srcname])
 147     except Exception, e:
 148         logger.info("Failed to rename log files")
 149         logger.info(e)
 150
 151 def main():
 152     tests = []
 153     test_modules = []
 154     if os.path.exists('run-tests.py'):
 155         files = os.listdir(".")
 156     else:
 157         files = os.listdir("..")
 158     for t in files:
 159         m = re.match(r'(test_.*)\.py$', t)
 160         if m:
 161             logger.debug("Import test cases from " + t)
 162             mod = __import__(m.group(1))
 163             test_modules.append(mod.__name__.replace('test_', '', 1))
 164             for s in dir(mod):
 165                 if s.startswith("test_"):
 166                     func = mod.__dict__.get(s)
 167                     tests.append(func)
 168     test_names = list(set([t.__name__.replace('test_', '', 1) for t in tests]))
 169
 170     run = None
 171
 172     parser = argparse.ArgumentParser(description='hwsim test runner')
 173     parser.add_argument('--logdir', metavar='<directory>',
 174                         help='log output directory for all other options, ' +
 175                              'must be given if other log options are used')
 176     group = parser.add_mutually_exclusive_group()
 177     group.add_argument('-d', const=logging.DEBUG, action='store_const',
 178                        dest='loglevel', default=logging.INFO,
 179                        help="verbose debug output")
 180     group.add_argument('-q', const=logging.WARNING, action='store_const',
 181                        dest='loglevel', help="be quiet")
 182
 183     parser.add_argument('-S', metavar='<sqlite3 db>', dest='database',
 184                         help='database to write results to')
 185     parser.add_argument('--prefill-tests', action='store_true', dest='prefill',
 186                         help='prefill test database with NOTRUN before all tests')
 187     parser.add_argument('--commit', metavar='<commit id>',
 188                         help='commit ID, only for database')
 189     parser.add_argument('-b', metavar='<build>', dest='build', help='build ID')
 190     parser.add_argument('-L', action='store_true', dest='update_tests_db',
 191                         help='List tests (and update descriptions in DB)')
 192     parser.add_argument('-T', action='store_true', dest='tracing',
 193                         help='collect tracing per test case (in log directory)')
 194     parser.add_argument('-D', action='store_true', dest='dmesg',
 195                         help='collect dmesg per test case (in log directory)')
 196     parser.add_argument('--shuffle-tests', action='store_true',
 197                         dest='shuffle_tests',
 198                         help='Shuffle test cases to randomize order')
 199     parser.add_argument('--split', help='split tests for parallel execution (<server number>/<total servers>)')
 200     parser.add_argument('--no-reset', action='store_true', dest='no_reset',
 201                         help='Do not reset devices at the end of the test')
 202     parser.add_argument('--long', action='store_true',
 203                         help='Include test cases that take long time')
 204     parser.add_argument('-f', dest='testmodules', metavar='<test module>',
 205                         help='execute only tests from these test modules',
 206                         type=str, choices=[[]] + test_modules, nargs='+')
 207     parser.add_argument('-l', metavar='<modules file>', dest='mfile',
 208                         help='test modules file name')
 209     parser.add_argument('-i', action='store_true', dest='stdin_ctrl',
 210                         help='stdin-controlled test case execution')
 211     parser.add_argument('tests', metavar='<test>', nargs='*', type=str,
 212                         help='tests to run (only valid without -f)',
 213                         choices=[[]] + test_names)
 214
 215     args = parser.parse_args()
 216
 217     if (args.tests and args.testmodules) or (args.tests and args.mfile) or (args.testmodules and args.mfile):
 218         print 'Invalid arguments - only one of (test, test modules, modules file) can be given.'
 219         sys.exit(2)
 220
 221     if args.database:
 222         import sqlite3
 223         conn = sqlite3.connect(args.database)
 224         conn.execute('CREATE TABLE IF NOT EXISTS results (test,result,run,time,duration,build,commitid)')
 225         conn.execute('CREATE TABLE IF NOT EXISTS tests (test,description)')
 226         conn.execute('CREATE TABLE IF NOT EXISTS logs (test,run,type,contents)')
 227     else:
 228         conn = None
 229
 230     if conn:
 231         run = int(time.time())
 232
 233     # read the modules from the modules file
 234     if args.mfile:
 235         args.testmodules = []
 236         with open(args.mfile) as f:
 237             for line in f.readlines():
 238                 line = line.strip()
 239                 if not line or line.startswith('#'):
 240                     continue
 241                 args.testmodules.append(line)
 242
 243     tests_to_run = []
 244     if args.tests:
 245         for selected in args.tests:
 246             for t in tests:
 247                 name = t.__name__.replace('test_', '', 1)
 248                 if name == selected:
 249                     tests_to_run.append(t)
 250     else:
 251         for t in tests:
 252             name = t.__name__.replace('test_', '', 1)
 253             if args.testmodules:
 254                 if not t.__module__.replace('test_', '', 1) in args.testmodules:
 255                     continue
 256             tests_to_run.append(t)
 257
 258     if args.update_tests_db:
 259         for t in tests_to_run:
 260             name = t.__name__.replace('test_', '', 1)
 261             if t.__doc__ is None:
 262                 print name + " - MISSING DESCRIPTION"
 263             else:
 264                 print name + " - " + t.__doc__
 265             if conn:
 266                 sql = 'INSERT OR REPLACE INTO tests(test,description) VALUES (?, ?)'
 267                 params = (name, t.__doc__)
 268                 try:
 269                     conn.execute(sql, params)
 270                 except Exception, e:
 271                     print "sqlite: " + str(e)
 272                     print "sql: %r" % (params,)
 273         if conn:
 274             conn.commit()
 275             conn.close()
 276         sys.exit(0)
 277
 278     if not args.logdir:
 279         if os.path.exists('logs/current'):
 280             args.logdir = 'logs/current'
 281         else:
 282             args.logdir = 'logs'
 283
 284     # Write debug level log to a file and configurable verbosity to stdout
 285     logger.setLevel(logging.DEBUG)
 286
 287     stdout_handler = logging.StreamHandler()
 288     stdout_handler.setLevel(args.loglevel)
 289     logger.addHandler(stdout_handler)
 290
 291     file_name = os.path.join(args.logdir, 'run-tests.log')
 292     log_handler = logging.FileHandler(file_name)
 293     log_handler.setLevel(logging.DEBUG)
 294     fmt = "%(asctime)s %(levelname)s %(message)s"
 295     log_formatter = logging.Formatter(fmt)
 296     log_handler.setFormatter(log_formatter)
 297     logger.addHandler(log_handler)
 298
 299     dev0 = WpaSupplicant('wlan0', '/tmp/wpas-wlan0')
 300     dev1 = WpaSupplicant('wlan1', '/tmp/wpas-wlan1')
 301     dev2 = WpaSupplicant('wlan2', '/tmp/wpas-wlan2')
 302     dev = [ dev0, dev1, dev2 ]
 303     apdev = [ ]
 304     apdev.append({"ifname": 'wlan3', "bssid": "02:00:00:00:03:00"})
 305     apdev.append({"ifname": 'wlan4', "bssid": "02:00:00:00:04:00"})
 306
 307     for d in dev:
 308         if not d.ping():
 309             logger.info(d.ifname + ": No response from wpa_supplicant")
 310             return
 311         logger.info("DEV: " + d.ifname + ": " + d.p2p_dev_addr())
 312     for ap in apdev:
 313         logger.info("APDEV: " + ap['ifname'])
 314
 315     passed = []
 316     skipped = []
 317     failed = []
 318
 319     # make sure nothing is left over from previous runs
 320     # (if there were any other manual runs or we crashed)
 321     if not reset_devs(dev, apdev):
 322         if conn:
 323             conn.close()
 324             conn = None
 325         sys.exit(1)
 326
 327     if args.dmesg:
 328         subprocess.call(['sudo', 'dmesg', '-c'], stdout=open('/dev/null', 'w'))
 329
 330     if conn and args.prefill:
 331         for t in tests_to_run:
 332             name = t.__name__.replace('test_', '', 1)
 333             report(conn, False, args.build, args.commit, run, name, 'NOTRUN', 0,
 334                    args.logdir, sql_commit=False)
 335         conn.commit()
 336
 337     if args.split:
 338         vals = args.split.split('/')
 339         split_server = int(vals[0])
 340         split_total = int(vals[1])
 341         logger.info("Parallel execution - %d/%d" % (split_server, split_total))
 342         split_server -= 1
 343         tests_to_run.sort(key=lambda t: t.__name__)
 344         tests_to_run = [x for i,x in enumerate(tests_to_run) if i % split_total == split_server]
 345
 346     if args.shuffle_tests:
 347         from random import shuffle
 348         shuffle(tests_to_run)
 349
 350     count = 0
 351     if args.stdin_ctrl:
 352         print "READY"
 353         sys.stdout.flush()
 354         num_tests = 0
 355     else:
 356         num_tests = len(tests_to_run)
 357     while True:
 358         if args.stdin_ctrl:
 359             test = sys.stdin.readline()
 360             if not test:
 361                 break
 362             test = test.splitlines()[0]
 363             if test == '':
 364                 break
 365             t = None
 366             for tt in tests:
 367                 name = tt.__name__.replace('test_', '', 1)
 368                 if name == test:
 369                     t = tt
 370                     break
 371             if not t:
 372                 print "NOT-FOUND"
 373                 sys.stdout.flush()
 374                 continue
 375         else:
 376             if len(tests_to_run) == 0:
 377                 break
 378             t = tests_to_run.pop(0)
 379
 380         name = t.__name__.replace('test_', '', 1)
 381         if log_handler:
 382             log_handler.stream.close()
 383             logger.removeHandler(log_handler)
 384             file_name = os.path.join(args.logdir, name + '.log')
 385             log_handler = logging.FileHandler(file_name)
 386             log_handler.setLevel(logging.DEBUG)
 387             log_handler.setFormatter(log_formatter)
 388             logger.addHandler(log_handler)
 389
 390         reset_ok = True
 391         with DataCollector(args.logdir, name, args.tracing, args.dmesg):
 392             count = count + 1
 393             msg = "START {} {}/{}".format(name, count, num_tests)
 394             logger.info(msg)
 395             if args.loglevel == logging.WARNING:
 396                 print msg
 397                 sys.stdout.flush()
 398             if t.__doc__:
 399                 logger.info("Test: " + t.__doc__)
 400             start = datetime.now()
 401             for d in dev:
 402                 try:
 403                     d.dump_monitor()
 404                     if not d.ping():
 405                         raise Exception("PING failed for {}".format(d.ifname))
 406                     if not d.global_ping():
 407                         raise Exception("Global PING failed for {}".format(d.ifname))
 408                     d.request("NOTE TEST-START " + name)
 409                 except Exception, e:
 410                     logger.info("Failed to issue TEST-START before " + name + " for " + d.ifname)
 411                     logger.info(e)
 412                     print "FAIL " + name + " - could not start test"
 413                     if conn:
 414                         conn.close()
 415                         conn = None
 416                     sys.exit(1)
 417             try:
 418                 if t.func_code.co_argcount > 2:
 419                     params = {}
 420                     params['logdir'] = args.logdir
 421                     params['long'] = args.long
 422                     res = t(dev, apdev, params)
 423                 elif t.func_code.co_argcount > 1:
 424                     res = t(dev, apdev)
 425                 else:
 426                     res = t(dev)
 427                 if res == "skip":
 428                     result = "SKIP"
 429                 else:
 430                     result = "PASS"
 431             except Exception, e:
 432                 logger.info(e)
 433                 if args.loglevel == logging.WARNING:
 434                     print "Exception: " + str(e)
 435                 result = "FAIL"
 436             for d in dev:
 437                 try:
 438                     d.dump_monitor()
 439                     d.request("NOTE TEST-STOP " + name)
 440                 except Exception, e:
 441                     logger.info("Failed to issue TEST-STOP after {} for {}".format(name, d.ifname))
 442                     logger.info(e)
 443                     result = "FAIL"
 444             try:
 445                 wpas = WpaSupplicant("/tmp/wpas-wlan5")
 446                 d.dump_monitor()
 447                 rename_log(args.logdir, 'log5', name, wpas)
 448                 if not args.no_reset:
 449                     wpas.remove_ifname()
 450             except Exception, e:
 451                 pass
 452             if args.no_reset:
 453                 print "Leaving devices in current state"
 454             else:
 455                 reset_ok = reset_devs(dev, apdev)
 456
 457             for i in range(0, 3):
 458                 rename_log(args.logdir, 'log' + str(i), name, dev[i])
 459             try:
 460                 hapd = HostapdGlobal()
 461             except Exception, e:
 462                 print "Failed to connect to hostapd interface"
 463                 print str(e)
 464                 reset_ok = False
 465                 result = "FAIL"
 466                 hapd = None
 467             rename_log(args.logdir, 'hostapd', name, hapd)
 468
 469             wt = Wlantest()
 470             rename_log(args.logdir, 'hwsim0.pcapng', name, wt)
 471             rename_log(args.logdir, 'hwsim0', name, wt)
 472
 473         end = datetime.now()
 474         diff = end - start
 475
 476         if result == 'PASS' and args.dmesg:
 477             if not check_kernel(os.path.join(args.logdir, name + '.dmesg')):
 478                 logger.info("Kernel issue found in dmesg - mark test failed")
 479                 result = 'FAIL'
 480
 481         if result == 'PASS':
 482             passed.append(name)
 483         elif result == 'SKIP':
 484             skipped.append(name)
 485         else:
 486             failed.append(name)
 487
 488         report(conn, args.prefill, args.build, args.commit, run, name, result,
 489                diff.total_seconds(), args.logdir)
 490         result = "{} {} {} {}".format(result, name, diff.total_seconds(), end)
 491         logger.info(result)
 492         if args.loglevel == logging.WARNING:
 493             print result
 494             sys.stdout.flush()
 495
 496         if not reset_ok:
 497             print "Terminating early due to device reset failure"
 498             break
 499
 500     if log_handler:
 501         log_handler.stream.close()
 502         logger.removeHandler(log_handler)
 503         file_name = os.path.join(args.logdir, 'run-tests.log')
 504         log_handler = logging.FileHandler(file_name)
 505         log_handler.setLevel(logging.DEBUG)
 506         log_handler.setFormatter(log_formatter)
 507         logger.addHandler(log_handler)
 508
 509     if conn:
 510         conn.close()
 511
 512     if len(failed):
 513         logger.info("passed {} test case(s)".format(len(passed)))
 514         logger.info("skipped {} test case(s)".format(len(skipped)))
 515         logger.info("failed tests: " + ' '.join(failed))
 516         if args.loglevel == logging.WARNING:
 517             print "failed tests: " + ' '.join(failed)
 518         sys.exit(1)
 519     logger.info("passed all {} test case(s)".format(len(passed)))
 520     if len(skipped):
 521         logger.info("skipped {} test case(s)".format(len(skipped)))
 522     if args.loglevel == logging.WARNING:
 523         print "passed all {} test case(s)".format(len(passed))
 524         if len(skipped):
 525             print "skipped {} test case(s)".format(len(skipped))
 526
 527 if __name__ == "__main__":
 528     main()