tests/hwsim/run-tests.py

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