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