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