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