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