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