app/test/autotest_runner.py

   1 #!/usr/bin/python
   2
   3 #   BSD LICENSE
   4 #
   5 #   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   6 #   All rights reserved.
   7 #
   8 #   Redistribution and use in source and binary forms, with or without
   9 #   modification, are permitted provided that the following conditions
  10 #   are met:
  11 #
  12 #     * Redistributions of source code must retain the above copyright
  13 #       notice, this list of conditions and the following disclaimer.
  14 #     * Redistributions in binary form must reproduce the above copyright
  15 #       notice, this list of conditions and the following disclaimer in
  16 #       the documentation and/or other materials provided with the
  17 #       distribution.
  18 #     * Neither the name of Intel Corporation nor the names of its
  19 #       contributors may be used to endorse or promote products derived
  20 #       from this software without specific prior written permission.
  21 #
  22 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25 #   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26 #   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27 #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28 #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29 #   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30 #   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31 #   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33
  34 # The main logic behind running autotests in parallel
  35
  36 import multiprocessing, sys, pexpect, time, os, StringIO, csv
  37
  38 # wait for prompt
  39 def wait_prompt(child):
  40         try:
  41                 child.sendline()
  42                 result = child.expect(["RTE>>", pexpect.TIMEOUT, pexpect.EOF],
  43                         timeout = 120)
  44         except:
  45                 return False
  46         if result == 0:
  47                 return True
  48         else:
  49                 return False
  50
  51 # run a test group
  52 # each result tuple in results list consists of:
  53 #   result value (0 or -1)
  54 #   result string
  55 #   test name
  56 #   total test run time (double)
  57 #   raw test log
  58 #   test report (if not available, should be None)
  59 #
  60 # this function needs to be outside AutotestRunner class
  61 # because otherwise Pool won't work (or rather it will require
  62 # quite a bit of effort to make it work).
  63 def run_test_group(cmdline, test_group):
  64         results = []
  65         child = None
  66         start_time = time.time()
  67         startuplog = None
  68
  69         # run test app
  70         try:
  71                 # prepare logging of init
  72                 startuplog = StringIO.StringIO()
  73
  74                 print >>startuplog, "\n%s %s\n" % ("="*20, test_group["Prefix"])
  75                 print >>startuplog, "\ncmdline=%s" % cmdline
  76
  77                 child = pexpect.spawn(cmdline, logfile=startuplog)
  78
  79                 # wait for target to boot
  80                 if not wait_prompt(child):
  81                         child.close()
  82
  83                         results.append((-1, "Fail [No prompt]", "Start %s" % test_group["Prefix"],
  84                                 time.time() - start_time, startuplog.getvalue(), None))
  85
  86                         # mark all tests as failed
  87                         for test in test_group["Tests"]:
  88                                 results.append((-1, "Fail [No prompt]", test["Name"],
  89                                 time.time() - start_time, "", None))
  90                         # exit test
  91                         return results
  92
  93         except:
  94                 results.append((-1, "Fail [Can't run]", "Start %s" % test_group["Prefix"],
  95                                 time.time() - start_time, startuplog.getvalue(), None))
  96
  97                 # mark all tests as failed
  98                 for t in test_group["Tests"]:
  99                         results.append((-1, "Fail [Can't run]", t["Name"],
 100                                 time.time() - start_time, "", None))
 101                 # exit test
 102                 return results
 103
 104         # startup was successful
 105         results.append((0, "Success", "Start %s" % test_group["Prefix"],
 106                 time.time() - start_time, startuplog.getvalue(), None))
 107
 108         # run all tests in test group
 109         for test in test_group["Tests"]:
 110
 111                 # create log buffer for each test
 112                 # in multiprocessing environment, the logging would be
 113                 # interleaved and will create a mess, hence the buffering
 114                 logfile = StringIO.StringIO()
 115                 child.logfile = logfile
 116
 117                 result = ()
 118
 119                 # make a note when the test started
 120                 start_time = time.time()
 121
 122                 try:
 123                         # print test name to log buffer
 124                         print >>logfile, "\n%s %s\n" % ("-"*20, test["Name"])
 125
 126                         # run test function associated with the test
 127                         result = test["Func"](child, test["Command"])
 128
 129                         # make a note when the test was finished
 130                         end_time = time.time()
 131
 132                         # append test data to the result tuple
 133                         result += (test["Name"], end_time - start_time,
 134                                 logfile.getvalue())
 135
 136                         # call report function, if any defined, and supply it with
 137                         # target and complete log for test run
 138                         if test["Report"]:
 139                                 report = test["Report"](self.target, log)
 140
 141                                 # append report to results tuple
 142                                 result += (report,)
 143                         else:
 144                                 # report is None
 145                                 result += (None,)
 146                 except:
 147                         # make a note when the test crashed
 148                         end_time = time.time()
 149
 150                         # mark test as failed
 151                         result = (-1, "Fail [Crash]", test["Name"],
 152                                 end_time - start_time, logfile.getvalue(), None)
 153                 finally:
 154                         # append the results to the results list
 155                         results.append(result)
 156
 157         # regardless of whether test has crashed, try quitting it
 158         try:
 159                 child.sendline("quit")
 160                 child.close()
 161         # if the test crashed, just do nothing instead
 162         except:
 163                 # nop
 164                 pass
 165
 166         # return test results
 167         return results
 168
 169
 170
 171
 172
 173 # class representing an instance of autotests run
 174 class AutotestRunner:
 175         cmdline = ""
 176         parallel_test_groups = []
 177         non_parallel_test_groups = []
 178         logfile = None
 179         csvwriter = None
 180         target = ""
 181         start = None
 182         n_tests = 0
 183         fails = 0
 184         log_buffers = []
 185         blacklist = []
 186         whitelist = []
 187
 188
 189         def __init__(self, cmdline, target, blacklist, whitelist):
 190                 self.cmdline = cmdline
 191                 self.target = target
 192                 self.blacklist = blacklist
 193                 self.whitelist = whitelist
 194
 195                 # log file filename
 196                 logfile = "%s.log" % target
 197                 csvfile = "%s.csv" % target
 198
 199                 self.logfile = open(logfile, "w")
 200                 csvfile = open(csvfile, "w")
 201                 self.csvwriter = csv.writer(csvfile)
 202
 203                 # prepare results table
 204                 self.csvwriter.writerow(["test_name","test_result","result_str"])
 205
 206
 207
 208         # set up cmdline string
 209         def __get_cmdline(self, test):
 210                 cmdline = self.cmdline
 211
 212                 # append memory limitations for each test
 213                 # otherwise tests won't run in parallel
 214                 if not "i686" in self.target:
 215                         cmdline += " --socket-mem=%s"% test["Memory"]
 216                 else:
 217                         # affinitize startup so that tests don't fail on i686
 218                         cmdline = "taskset 1 " + cmdline
 219                         cmdline += " -m " + str(sum(map(int,test["Memory"].split(","))))
 220
 221                 # set group prefix for autotest group
 222                 # otherwise they won't run in parallel
 223                 cmdline += " --file-prefix=%s"% test["Prefix"]
 224
 225                 return cmdline
 226
 227
 228
 229         def add_parallel_test_group(self,test_group):
 230                 self.parallel_test_groups.append(test_group)
 231
 232         def add_non_parallel_test_group(self,test_group):
 233                 self.non_parallel_test_groups.append(test_group)
 234
 235
 236         def __process_results(self, results):
 237                 # this iterates over individual test results
 238                 for i, result in enumerate(results):
 239
 240                         # increase total number of tests that were run
 241                         # do not include "start" test
 242                         if i > 0:
 243                                 self.n_tests += 1
 244
 245                         # unpack result tuple
 246                         test_result, result_str, test_name, \
 247                                 test_time, log, report = result
 248
 249                         # get total run time
 250                         cur_time = time.time()
 251                         total_time = int(cur_time - self.start)
 252
 253                         # print results, test run time and total time since start
 254                         print ("%s:" % test_name).ljust(30),
 255                         print result_str.ljust(29),
 256                         print "[%02dm %02ds]" % (test_time / 60, test_time % 60),
 257
 258                         # don't print out total time every line, it's the same anyway
 259                         if i == len(results) - 1:
 260                                 print "[%02dm %02ds]" % (total_time / 60, total_time % 60)
 261                         else:
 262                                 print ""
 263
 264                         # if test failed and it wasn't a "start" test
 265                         if test_result < 0 and not i == 0:
 266                                 self.fails += 1
 267
 268                         # collect logs
 269                         self.log_buffers.append(log)
 270
 271                         # create report if it exists
 272                         if report:
 273                                 try:
 274                                         f = open("%s_%s_report.rst" % (self.target,test_name), "w")
 275                                 except IOError:
 276                                         print "Report for %s could not be created!" % test_name
 277                                 else:
 278                                         with f:
 279                                                 f.write(report)
 280
 281                         # write test result to CSV file
 282                         if i != 0:
 283                                 self.csvwriter.writerow([test_name, test_result, result_str])
 284
 285
 286
 287
 288         # this function iterates over test groups and removes each
 289         # test that is not in whitelist/blacklist
 290         def __filter_groups(self, test_groups):
 291                 groups_to_remove = []
 292
 293                 # filter out tests from parallel test groups
 294                 for i, test_group in enumerate(test_groups):
 295
 296                         # iterate over a copy so that we could safely delete individual tests
 297                         for test in test_group["Tests"][:]:
 298                                 test_id = test["Command"]
 299
 300                                 # dump tests are specified in full e.g. "Dump_mempool"
 301                                 if "_autotest" in test_id:
 302                                         test_id = test_id[:-len("_autotest")]
 303
 304                                 # filter out blacklisted/whitelisted tests
 305                                 if self.blacklist and test_id in self.blacklist:
 306                                         test_group["Tests"].remove(test)
 307                                         continue
 308                                 if self.whitelist and test_id not in self.whitelist:
 309                                         test_group["Tests"].remove(test)
 310                                         continue
 311
 312                         # modify or remove original group
 313                         if len(test_group["Tests"]) > 0:
 314                                 test_groups[i] = test_group
 315                         else:
 316                                 # remember which groups should be deleted
 317                                 # put the numbers backwards so that we start
 318                                 # deleting from the end, not from the beginning
 319                                 groups_to_remove.insert(0, i)
 320
 321                 # remove test groups that need to be removed
 322                 for i in groups_to_remove:
 323                         del test_groups[i]
 324
 325                 return test_groups
 326
 327
 328
 329         # iterate over test groups and run tests associated with them
 330         def run_all_tests(self):
 331                 # filter groups
 332                 self.parallel_test_groups = \
 333                         self.__filter_groups(self.parallel_test_groups)
 334                 self.non_parallel_test_groups = \
 335                         self.__filter_groups(self.non_parallel_test_groups)
 336
 337                 # create a pool of worker threads
 338                 pool = multiprocessing.Pool(processes=1)
 339
 340                 results = []
 341
 342                 # whatever happens, try to save as much logs as possible
 343                 try:
 344
 345                         # create table header
 346                         print ""
 347                         print "Test name".ljust(30),
 348                         print "Test result".ljust(29),
 349                         print "Test".center(9),
 350                         print "Total".center(9)
 351                         print "=" * 80
 352
 353                         # make a note of tests start time
 354                         self.start = time.time()
 355
 356                         # assign worker threads to run test groups
 357                         for test_group in self.parallel_test_groups:
 358                                 result = pool.apply_async(run_test_group,
 359                                         [self.__get_cmdline(test_group), test_group])
 360                                 results.append(result)
 361
 362                         # iterate while we have group execution results to get
 363                         while len(results) > 0:
 364
 365                                 # iterate over a copy to be able to safely delete results
 366                                 # this iterates over a list of group results
 367                                 for group_result in results[:]:
 368
 369                                         # if the thread hasn't finished yet, continue
 370                                         if not group_result.ready():
 371                                                 continue
 372
 373                                         res = group_result.get()
 374
 375                                         self.__process_results(res)
 376
 377                                         # remove result from results list once we're done with it
 378                                         results.remove(group_result)
 379
 380                         # run non_parallel tests. they are run one by one, synchronously
 381                         for test_group in self.non_parallel_test_groups:
 382                                 group_result = run_test_group(self.__get_cmdline(test_group), test_group)
 383
 384                                 self.__process_results(group_result)
 385
 386                         # get total run time
 387                         cur_time = time.time()
 388                         total_time = int(cur_time - self.start)
 389
 390                         # print out summary
 391                         print "=" * 80
 392                         print "Total run time: %02dm %02ds" % (total_time / 60, total_time % 60)
 393                         if self.fails != 0:
 394                                 print "Number of failed tests: %s" % str(self.fails)
 395
 396                         # write summary to logfile
 397                         self.logfile.write("Summary\n")
 398                         self.logfile.write("Target: ".ljust(15) + "%s\n" % self.target)
 399                         self.logfile.write("Tests: ".ljust(15) + "%i\n" % self.n_tests)
 400                         self.logfile.write("Failed tests: ".ljust(15) + "%i\n" % self.fails)
 401                 except:
 402                         print "Exception occured"
 403                         print sys.exc_info()
 404                         self.fails = 1
 405
 406                 # drop logs from all executions to a logfile
 407                 for buf in self.log_buffers:
 408                         self.logfile.write(buf.replace("\r",""))
 409
 410                 log_buffers = []
 411
 412                 return self.fails