tests/hwsim/run-tests.py

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