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