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