hwsim tests: Allow collecting dmesg
[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(__name__)
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.replace('test_', '', 1), 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__)
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__ 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', metavar='<filename>', dest='logfile',
105                        help='debug log filename (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         logging.basicConfig(filename=os.path.join(args.logdir, args.logfile),
146                             level=logging.DEBUG)
147         log_to_file = True
148     else:
149         logging.basicConfig(level=args.loglevel)
150         log_to_file = False
151         if args.loglevel == logging.WARNING:
152             print_res = True
153
154     error_file = args.errorfile and os.path.join(args.logdir, args.errorfile)
155     results_file = args.resultsfile and os.path.join(args.logdir, args.resultsfile)
156
157     if args.database:
158         import sqlite3
159         conn = sqlite3.connect(args.database)
160     else:
161         conn = None
162
163     if conn:
164         run = str(int(time.time()))
165
166     if args.update_tests_db:
167         for t in tests:
168             print t.__name__ + " - " + t.__doc__
169             if conn:
170                 sql = 'INSERT OR REPLACE INTO tests(test,description) VALUES (?, ?)'
171                 params = (t.__name__.replace('test_', '', 1), t.__doc__)
172                 try:
173                     conn.execute(sql, params)
174                 except Exception, e:
175                     print "sqlite: " + str(e)
176                     print "sql: %r" % (params,)
177         if conn:
178             conn.commit()
179             conn.close()
180         sys.exit(0)
181
182
183     dev0 = WpaSupplicant('wlan0', '/tmp/wpas-wlan0')
184     dev1 = WpaSupplicant('wlan1', '/tmp/wpas-wlan1')
185     dev2 = WpaSupplicant('wlan2', '/tmp/wpas-wlan2')
186     dev = [ dev0, dev1, dev2 ]
187     apdev = [ ]
188     apdev.append({"ifname": 'wlan3', "bssid": "02:00:00:00:03:00"})
189     apdev.append({"ifname": 'wlan4', "bssid": "02:00:00:00:04:00"})
190
191     for d in dev:
192         if not d.ping():
193             logger.info(d.ifname + ": No response from wpa_supplicant")
194             return
195         logger.info("DEV: " + d.ifname + ": " + d.p2p_dev_addr())
196     for ap in apdev:
197         logger.info("APDEV: " + ap['ifname'])
198
199     passed = []
200     skipped = []
201     failed = []
202
203     if args.dmesg:
204         subprocess.call(['sudo', 'dmesg', '-c'], stdout=open('/dev/null', 'w'))
205
206     for t in tests:
207         if args.tests:
208             if not t.__name__ in args.tests:
209                 continue
210         if args.testmodules:
211             if not t.__module__ in args.testmodules:
212                 continue
213         with DataCollector(args.logdir, t.__name__, args.tracing, args.dmesg):
214             reset_devs(dev, apdev)
215             logger.info("START " + t.__name__)
216             if log_to_file:
217                 print "START " + t.__name__
218                 sys.stdout.flush()
219             if t.__doc__:
220                 logger.info("Test: " + t.__doc__)
221             start = datetime.now()
222             for d in dev:
223                 try:
224                     d.request("NOTE TEST-START " + t.__name__)
225                 except Exception, e:
226                     logger.info("Failed to issue TEST-START before " + t.__name__ + " for " + d.ifname)
227                     logger.info(e)
228                     print "FAIL " + t.__name__ + " - could not start test"
229                     if conn:
230                         conn.close()
231                         conn = None
232                     sys.exit(1)
233             try:
234                 if t.func_code.co_argcount > 1:
235                     res = t(dev, apdev)
236                 else:
237                     res = t(dev)
238                 end = datetime.now()
239                 diff = end - start
240                 if res == "skip":
241                     skipped.append(t.__name__)
242                     result = "SKIP"
243                 else:
244                     passed.append(t.__name__)
245                     result = "PASS"
246                 report(conn, args.build, args.commit, run, t.__name__, result, diff)
247                 result = result + " " + t.__name__ + " "
248                 result = result + str(diff.total_seconds()) + " " + str(end)
249                 logger.info(result)
250                 if log_to_file or print_res:
251                     print result
252                     sys.stdout.flush()
253                 if results_file:
254                     f = open(results_file, 'a')
255                     f.write(result + "\n")
256                     f.close()
257             except Exception, e:
258                 end = datetime.now()
259                 diff = end - start
260                 logger.info(e)
261                 failed.append(t.__name__)
262                 report(conn, args.build, args.commit, run, t.__name__, "FAIL", diff)
263                 result = "FAIL " + t.__name__ + " " + str(diff.total_seconds()) + " " + str(end)
264                 logger.info(result)
265                 if log_to_file:
266                     print result
267                     sys.stdout.flush()
268                 if results_file:
269                     f = open(results_file, 'a')
270                     f.write(result + "\n")
271                     f.close()
272             for d in dev:
273                 try:
274                     d.request("NOTE TEST-STOP " + t.__name__)
275                 except Exception, e:
276                     logger.info("Failed to issue TEST-STOP after " + t.__name__ + " for " + d.ifname)
277                     logger.info(e)
278
279     if not args.tests:
280         reset_devs(dev, apdev)
281
282     if conn:
283         conn.close()
284
285     if len(failed):
286         logger.info("passed " + str(len(passed)) + " test case(s)")
287         logger.info("skipped " + str(len(skipped)) + " test case(s)")
288         logger.info("failed tests: " + str(failed))
289         if error_file:
290             f = open(error_file, 'w')
291             f.write(str(failed) + '\n')
292             f.close()
293         sys.exit(1)
294     logger.info("passed all " + str(len(passed)) + " test case(s)")
295     if len(skipped):
296         logger.info("skipped " + str(len(skipped)) + " test case(s)")
297     if log_to_file:
298         print "passed all " + str(len(passed)) + " test case(s)"
299         if len(skipped):
300             print "skipped " + str(len(skipped)) + " test case(s)"
301
302 if __name__ == "__main__":
303     main()