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