/usr/lib/plainbox-providers-1/checkbox/bin/fwts_test is in plainbox-provider-checkbox 0.3-2.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 | #! /usr/bin/python3
import sys
import re
from time import time, sleep
from argparse import ArgumentParser, RawTextHelpFormatter, REMAINDER
from subprocess import Popen, PIPE
from syslog import *
TESTS = ['acpidump',
'acpiinfo',
'acpitables',
'apicedge',
'apicinstance',
'aspm',
'bios32',
'bios_info',
'checksum',
'cstates',
'dmar',
'ebda',
'fadt',
'hpet_check',
'klog',
'maxfreq',
'mcfg',
'method',
'mpcheck',
'msr',
'mtrr',
'nx',
'oops',
'uefirtvariable',
'version',
'virt',
'wmi']
def get_sleep_times(start_marker, end_marker, sleep_time, resume_time):
logfile = '/var/log/syslog'
log_fh = open(logfile, 'r')
line = ''
run = 'FAIL'
sleep_start_time = 0.0
sleep_end_time = 0.0
resume_start_time = 0.0
resume_end_time = 0.0
while start_marker not in line:
try:
line = log_fh.readline()
except UnicodeDecodeError:
continue
if start_marker in line:
loglist = log_fh.readlines()
for idx in range(0, len(loglist)):
if 'PM: Syncing filesystems' in loglist[idx]:
sleep_start_time = re.split('[\[\]]', loglist[idx])[1].strip()
if 'ACPI: Low-level resume complete' in loglist[idx]:
sleep_end_time = re.split('[\[\]]', loglist[idx - 1])[1].strip()
resume_start_time = re.split('[\[\]]', loglist[idx])[1].strip()
idx += 1
if 'Restarting tasks' in loglist[idx]:
resume_end_time = re.split('[\[\]]', loglist[idx])[1].strip()
if end_marker in loglist[idx]:
run = 'PASS'
break
sleep_elapsed = float(sleep_end_time) - float(sleep_start_time)
resume_elapsed = float(resume_end_time) - float(resume_start_time)
return (run, sleep_elapsed, resume_elapsed)
def average_times(runs):
sleep_total = 0.0
resume_total = 0.0
run_count = 0
for run in runs.keys():
run_count += 1
sleep_total += runs[run][1]
resume_total += runs[run][2]
sleep_avg = sleep_total / run_count
resume_avg = resume_total / run_count
print('Average time to sleep: %0.5f' % sleep_avg)
print('Average time to resume: %0.5f' % resume_avg)
def fix_sleep_args(args):
new_args = []
for arg in args:
if "=" in arg:
new_args.extend(arg.split('='))
else:
new_args.append(arg)
return new_args
def main():
description_text = 'Tests the system BIOS using the Firmware Test Suite'
epilog_text = ('To perform sleep testing, you will need at least some of '
'the following options: \n'
's3 or s4: tells fwts which type of sleep to perform.\n'
'--s3-delay-delta\n'
'--s3-device-check\n'
'--s3-device-check-delay\n'
'--s3-max-delay\n'
'--s3-min-delay\n'
'--s3-multiple\n'
'--s3-quirks\n'
'--s3-sleep-delay\n'
'--s3power-sleep-delay\n\n'
'Example: fwts-test --sleep s3 --s3-min-delay 30 '
'--s3-multiple 10 --s3-device-check\n\n'
'For further help with sleep options:\n'
'fwts-test --fwts-help')
parser = ArgumentParser(description=description_text,
epilog=epilog_text,
formatter_class=RawTextHelpFormatter)
parser.add_argument('-l', '--log',
default='/tmp/fwts_results.log',
help=('Specify the location and name of the log file.\n'
'[Default: %(default)s]'))
parser.add_argument('-f', '--fail-level',
default='high',
choices=['critical', 'high', 'medium',
'low', 'none', 'aborted'],
help=('Specify the FWTS failure level that will trigger '
'this script to return a failing exit code. For '
'example, if you chose "critical" as the '
'fail-level, this wrapper will NOT return a '
'failing exit code unless FWTS reports a test as '
'FAILED_CRITICAL. You will still be notified of '
'all FWTS test failures. [Default level: '
'%(default)s]'))
sleep_args = parser.add_argument_group('Sleep Options',
('The following arguments are to only be used with the '
'--sleep test option'))
sleep_args.add_argument('--sleep-time',
dest='sleep_time',
action='store',
help=('The max time in seconds that a system '
'should take\nto completely enter sleep. '
'Anything more than this\ntime will cause '
'that test iteration to fail.\n'
'[Default: 10s]'))
sleep_args.add_argument('--resume-time',
dest='resume_time',
action='store',
help=('Same as --sleep-time, except this applies '
'to the\ntime it takes a system to fully '
'wake from sleep.\n[Default: 3s]'))
group = parser.add_mutually_exclusive_group()
group.add_argument('-t', '--test',
action='append',
help='Name of the test to run.')
group.add_argument('-a', '--all',
action='store_true',
help='Run ALL FWTS automated tests (assumes -w and -c)')
group.add_argument('-s', '--sleep',
nargs=REMAINDER,
action='store',
help=('Perform sleep test(s) using the additional\n'
'arguments provided after --sleep. All remaining\n'
'items on the command line will be passed \n'
'through to fwts for performing sleep tests. \n'
'For info on these extra fwts options, please \n'
'see the epilog below and \n'
'the --fwts-help option.'))
group.add_argument('--fwts-help',
dest='fwts_help',
action='store_true',
help='Display the help info for fwts itself (lengthy)')
group.add_argument('--list',
action='store_true',
help='List all tests in fwts.')
args = parser.parse_args()
tests = []
results = {}
critical_fails = []
high_fails = []
medium_fails = []
low_fails = []
passed = []
aborted = []
# Set correct fail level
if args.fail_level is not 'none':
args.fail_level = 'FAILED_%s' % args.fail_level.upper()
# Get our failure priority and create the priority values
fail_levels = {'FAILED_CRITICAL':4,
'FAILED_HIGH':3,
'FAILED_MEDIUM':2,
'FAILED_LOW':1,
'FAILED_NONE':0,
'FAILED_ABORTED':-1}
fail_priority = fail_levels[args.fail_level]
# Enforce only using sleep opts with --sleep
if args.sleep_time or args.resume_time and not args.sleep:
parser.error('--sleep-time and --resume-time only apply to the '
'--sleep testing option.')
if args.fwts_help:
Popen('fwts -h', shell=True).communicate()[0]
return 0
elif args.list:
print('\n'.join(TESTS))
return 0
elif args.test:
tests.extend(args.test)
elif args.all:
tests.extend(['wakealarm', 'cpufreq'] + TESTS)
elif args.sleep:
args.sleep = fix_sleep_args(args.sleep)
iterations = 1
# if multiple iterations are requested, we need to intercept
# that argument and keep it from being presented to fwts since
# we're handling the iterations directly.
s3 = '--s3-multiple'
s4 = '--s4-multiple'
if s3 in args.sleep:
iterations = int(args.sleep.pop(args.sleep.index(s3) + 1))
args.sleep.remove(s3)
if s4 in args.sleep:
iterations = int(args.sleep.pop(args.sleep.index(s4) + 1))
args.sleep.remove(s4)
# if we've passed our custom sleep arguments for resume or sleep
# time, we need to intercept those as well.
resume_time_arg = '--resume-time'
sleep_time_arg = '--sleep-time'
if resume_time_arg in args.sleep:
args.resume_time = int(args.sleep.pop(
args.sleep.index(resume_time_arg) + 1))
args.sleep.remove(resume_time_arg)
if sleep_time_arg in args.sleep:
args.sleep_time = int(args.sleep.pop(
args.sleep.index(sleep_time_arg) + 1))
args.sleep.remove(sleep_time_arg)
# if we still haven't set a sleep or resume time, use defauts.
if not args.sleep_time:
args.sleep_time = 10
if not args.resume_time:
args.resume_time = 3
tests.extend(args.sleep)
else:
tests.extend(TESTS)
# run the tests we want
if args.sleep:
iteration_results = {}
print('=' * 20 + ' Test Results ' + '=' * 20)
for iteration in range(0, iterations):
timestamp = int(time())
start_marker = 'CHECKBOX SLEEP TEST START %s' % timestamp
end_marker = 'CHECKBOX SLEEP TEST STOP %s' % timestamp
syslog(LOG_INFO, '---' + start_marker + '---' + str(time()))
command = ('fwts -q --stdout-summary -r %s %s'
% (args.log, ' '.join(tests)))
results['sleep'] = (Popen(command, stdout=PIPE, shell=True)
.communicate()[0].strip()).decode()
syslog(LOG_INFO, '---' + end_marker + '---' + str(time()))
if 's4' not in args.sleep:
iteration_results[iteration] = get_sleep_times(start_marker,
end_marker, args.sleep_time,
args.resume_time)
print(' - Cycle %s: Status: %s Sleep Elapsed: %0.5f '
'Resume Elapsed: %0.5f' % (iteration,
iteration_results[iteration][0],
iteration_results[iteration][1],
iteration_results[iteration][2]))
if 's4' not in args.sleep:
average_times(iteration_results)
for run in iteration_results.keys():
if 'FAIL' in iteration_results[run]:
results['sleep'] = 'FAILED_CRITICAL'
else:
for test in tests:
command = ('fwts -q --stdout-summary -r %s %s'
% (args.log, test))
results[test] = (Popen(command, stdout=PIPE, shell=True)
.communicate()[0].strip()).decode()
# parse the summaries
for test in results.keys():
if results[test] == 'FAILED_CRITICAL':
critical_fails.append(test)
elif results[test] == 'FAILED_HIGH':
high_fails.append(test)
elif results[test] == 'FAILED_MEDIUM':
medium_fails.append(test)
elif results[test] == 'FAILED_LOW':
low_fails.append(test)
elif results[test] == 'PASSED':
passed.append(test)
elif results[test] == 'ABORTED':
aborted.append(test)
else:
continue
if critical_fails:
print("Critical Failures: %d" % len(critical_fails))
print("WARNING: The following test cases were reported as critical\n"
"level failures by fwts. Please review the log at\n"
"%s for more information." % args.log)
for test in critical_fails:
print(" - " + test)
if high_fails:
print("High Failures: %d" % len(high_fails))
print("WARNING: The following test cases were reported as high\n"
"level failures by fwts. Please review the log at\n"
"%s for more information." % args.log)
for test in high_fails:
print(" - " + test)
if medium_fails:
print("Medium Failures: %d" % len(medium_fails))
print("WARNING: The following test cases were reported as medium\n"
"level failures by fwts. Please review the log at\n"
"%s for more information." % args.log)
for test in medium_fails:
print(" - " + test)
if low_fails:
print("Low Failures: %d" % len(low_fails))
print("WARNING: The following test cases were reported as low\n"
"level failures by fwts. Please review the log at\n"
"%s for more information." % args.log)
for test in low_fails:
print(" - " + test)
if passed:
print("Passed: %d" % len(passed))
for test in passed:
print(" - " + test)
if aborted:
print("Aborted Tests: %d" % len(aborted))
print("WARNING: The following test cases were aborted by fwts\n"
"Please review the log at %s for more information."
% args.log)
for test in aborted:
print(" - " + test)
if args.fail_level is not 'none':
if fail_priority == fail_levels['FAILED_CRITICAL']:
if critical_fails:
return 1
if fail_priority == fail_levels['FAILED_HIGH']:
if critical_fails or high_fails:
return 1
if fail_priority == fail_levels['FAILED_MEDIUM']:
if critical_fails or high_fails or medium_fails:
return 1
if fail_priority == fail_levels['FAILED_LOW']:
if critical_fails or high_fails or medium_fails or low_fails:
return 1
if fail_priority == fail_levels['FAILED_ABORTED']:
if aborted or critical_fails or high_fails:
return 1
return 0
if __name__ == '__main__':
sys.exit(main())
|