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