numam-dpdk/app/test/autotest_runner.py
Olivier Matz f632ff17a6 app/test: display command line when starting
It's useful for debug purposes to see the command line used by
autotest.py.

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
2016-03-24 21:12:45 +01:00

413 lines
12 KiB
Python

#!/usr/bin/python
# BSD LICENSE
#
# Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
# * Neither the name of Intel Corporation nor the names of its
# contributors may be used to endorse or promote products derived
# from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# The main logic behind running autotests in parallel
import multiprocessing, sys, pexpect, time, os, StringIO, csv
# wait for prompt
def wait_prompt(child):
try:
child.sendline()
result = child.expect(["RTE>>", pexpect.TIMEOUT, pexpect.EOF],
timeout = 120)
except:
return False
if result == 0:
return True
else:
return False
# run a test group
# each result tuple in results list consists of:
# result value (0 or -1)
# result string
# test name
# total test run time (double)
# raw test log
# test report (if not available, should be None)
#
# this function needs to be outside AutotestRunner class
# because otherwise Pool won't work (or rather it will require
# quite a bit of effort to make it work).
def run_test_group(cmdline, test_group):
results = []
child = None
start_time = time.time()
startuplog = None
# run test app
try:
# prepare logging of init
startuplog = StringIO.StringIO()
print >>startuplog, "\n%s %s\n" % ("="*20, test_group["Prefix"])
print >>startuplog, "\ncmdline=%s" % cmdline
child = pexpect.spawn(cmdline, logfile=startuplog)
# wait for target to boot
if not wait_prompt(child):
child.close()
results.append((-1, "Fail [No prompt]", "Start %s" % test_group["Prefix"],
time.time() - start_time, startuplog.getvalue(), None))
# mark all tests as failed
for test in test_group["Tests"]:
results.append((-1, "Fail [No prompt]", test["Name"],
time.time() - start_time, "", None))
# exit test
return results
except:
results.append((-1, "Fail [Can't run]", "Start %s" % test_group["Prefix"],
time.time() - start_time, startuplog.getvalue(), None))
# mark all tests as failed
for t in test_group["Tests"]:
results.append((-1, "Fail [Can't run]", t["Name"],
time.time() - start_time, "", None))
# exit test
return results
# startup was successful
results.append((0, "Success", "Start %s" % test_group["Prefix"],
time.time() - start_time, startuplog.getvalue(), None))
# run all tests in test group
for test in test_group["Tests"]:
# create log buffer for each test
# in multiprocessing environment, the logging would be
# interleaved and will create a mess, hence the buffering
logfile = StringIO.StringIO()
child.logfile = logfile
result = ()
# make a note when the test started
start_time = time.time()
try:
# print test name to log buffer
print >>logfile, "\n%s %s\n" % ("-"*20, test["Name"])
# run test function associated with the test
result = test["Func"](child, test["Command"])
# make a note when the test was finished
end_time = time.time()
# append test data to the result tuple
result += (test["Name"], end_time - start_time,
logfile.getvalue())
# call report function, if any defined, and supply it with
# target and complete log for test run
if test["Report"]:
report = test["Report"](self.target, log)
# append report to results tuple
result += (report,)
else:
# report is None
result += (None,)
except:
# make a note when the test crashed
end_time = time.time()
# mark test as failed
result = (-1, "Fail [Crash]", test["Name"],
end_time - start_time, logfile.getvalue(), None)
finally:
# append the results to the results list
results.append(result)
# regardless of whether test has crashed, try quitting it
try:
child.sendline("quit")
child.close()
# if the test crashed, just do nothing instead
except:
# nop
pass
# return test results
return results
# class representing an instance of autotests run
class AutotestRunner:
cmdline = ""
parallel_test_groups = []
non_parallel_test_groups = []
logfile = None
csvwriter = None
target = ""
start = None
n_tests = 0
fails = 0
log_buffers = []
blacklist = []
whitelist = []
def __init__(self, cmdline, target, blacklist, whitelist):
self.cmdline = cmdline
self.target = target
self.blacklist = blacklist
self.whitelist = whitelist
# log file filename
logfile = "%s.log" % target
csvfile = "%s.csv" % target
self.logfile = open(logfile, "w")
csvfile = open(csvfile, "w")
self.csvwriter = csv.writer(csvfile)
# prepare results table
self.csvwriter.writerow(["test_name","test_result","result_str"])
# set up cmdline string
def __get_cmdline(self, test):
cmdline = self.cmdline
# append memory limitations for each test
# otherwise tests won't run in parallel
if not "i686" in self.target:
cmdline += " --socket-mem=%s"% test["Memory"]
else:
# affinitize startup so that tests don't fail on i686
cmdline = "taskset 1 " + cmdline
cmdline += " -m " + str(sum(map(int,test["Memory"].split(","))))
# set group prefix for autotest group
# otherwise they won't run in parallel
cmdline += " --file-prefix=%s"% test["Prefix"]
return cmdline
def add_parallel_test_group(self,test_group):
self.parallel_test_groups.append(test_group)
def add_non_parallel_test_group(self,test_group):
self.non_parallel_test_groups.append(test_group)
def __process_results(self, results):
# this iterates over individual test results
for i, result in enumerate(results):
# increase total number of tests that were run
# do not include "start" test
if i > 0:
self.n_tests += 1
# unpack result tuple
test_result, result_str, test_name, \
test_time, log, report = result
# get total run time
cur_time = time.time()
total_time = int(cur_time - self.start)
# print results, test run time and total time since start
print ("%s:" % test_name).ljust(30),
print result_str.ljust(29),
print "[%02dm %02ds]" % (test_time / 60, test_time % 60),
# don't print out total time every line, it's the same anyway
if i == len(results) - 1:
print "[%02dm %02ds]" % (total_time / 60, total_time % 60)
else:
print ""
# if test failed and it wasn't a "start" test
if test_result < 0 and not i == 0:
self.fails += 1
# collect logs
self.log_buffers.append(log)
# create report if it exists
if report:
try:
f = open("%s_%s_report.rst" % (self.target,test_name), "w")
except IOError:
print "Report for %s could not be created!" % test_name
else:
with f:
f.write(report)
# write test result to CSV file
if i != 0:
self.csvwriter.writerow([test_name, test_result, result_str])
# this function iterates over test groups and removes each
# test that is not in whitelist/blacklist
def __filter_groups(self, test_groups):
groups_to_remove = []
# filter out tests from parallel test groups
for i, test_group in enumerate(test_groups):
# iterate over a copy so that we could safely delete individual tests
for test in test_group["Tests"][:]:
test_id = test["Command"]
# dump tests are specified in full e.g. "Dump_mempool"
if "_autotest" in test_id:
test_id = test_id[:-len("_autotest")]
# filter out blacklisted/whitelisted tests
if self.blacklist and test_id in self.blacklist:
test_group["Tests"].remove(test)
continue
if self.whitelist and test_id not in self.whitelist:
test_group["Tests"].remove(test)
continue
# modify or remove original group
if len(test_group["Tests"]) > 0:
test_groups[i] = test_group
else:
# remember which groups should be deleted
# put the numbers backwards so that we start
# deleting from the end, not from the beginning
groups_to_remove.insert(0, i)
# remove test groups that need to be removed
for i in groups_to_remove:
del test_groups[i]
return test_groups
# iterate over test groups and run tests associated with them
def run_all_tests(self):
# filter groups
self.parallel_test_groups = \
self.__filter_groups(self.parallel_test_groups)
self.non_parallel_test_groups = \
self.__filter_groups(self.non_parallel_test_groups)
# create a pool of worker threads
pool = multiprocessing.Pool(processes=1)
results = []
# whatever happens, try to save as much logs as possible
try:
# create table header
print ""
print "Test name".ljust(30),
print "Test result".ljust(29),
print "Test".center(9),
print "Total".center(9)
print "=" * 80
# make a note of tests start time
self.start = time.time()
# assign worker threads to run test groups
for test_group in self.parallel_test_groups:
result = pool.apply_async(run_test_group,
[self.__get_cmdline(test_group), test_group])
results.append(result)
# iterate while we have group execution results to get
while len(results) > 0:
# iterate over a copy to be able to safely delete results
# this iterates over a list of group results
for group_result in results[:]:
# if the thread hasn't finished yet, continue
if not group_result.ready():
continue
res = group_result.get()
self.__process_results(res)
# remove result from results list once we're done with it
results.remove(group_result)
# run non_parallel tests. they are run one by one, synchronously
for test_group in self.non_parallel_test_groups:
group_result = run_test_group(self.__get_cmdline(test_group), test_group)
self.__process_results(group_result)
# get total run time
cur_time = time.time()
total_time = int(cur_time - self.start)
# print out summary
print "=" * 80
print "Total run time: %02dm %02ds" % (total_time / 60, total_time % 60)
if self.fails != 0:
print "Number of failed tests: %s" % str(self.fails)
# write summary to logfile
self.logfile.write("Summary\n")
self.logfile.write("Target: ".ljust(15) + "%s\n" % self.target)
self.logfile.write("Tests: ".ljust(15) + "%i\n" % self.n_tests)
self.logfile.write("Failed tests: ".ljust(15) + "%i\n" % self.fails)
except:
print "Exception occured"
print sys.exc_info()
self.fails = 1
# drop logs from all executions to a logfile
for buf in self.log_buffers:
self.logfile.write(buf.replace("\r",""))
log_buffers = []
return self.fails