blob: 2425cb506388868cb9f02bfc04c731bb59e89bfc [file] [log] [blame]
#!/usr/bin/python -u
import collections
import datetime
import errno
import fcntl
import json
import optparse
import os
import socket
import subprocess
import sys
import time
import traceback
import common
from autotest_lib.client.bin.result_tools import utils as result_utils
from autotest_lib.client.bin.result_tools import utils_lib as result_utils_lib
from autotest_lib.client.bin.result_tools import runner as result_runner
from autotest_lib.client.common_lib import control_data
from autotest_lib.client.common_lib import global_config
from autotest_lib.client.common_lib import mail, pidfile
from autotest_lib.client.common_lib import utils
from autotest_lib.frontend import setup_django_environment
from autotest_lib.frontend.tko import models as tko_models
from autotest_lib.server import site_utils
from autotest_lib.server.cros.dynamic_suite import constants
from autotest_lib.site_utils.sponge_lib import sponge_utils
from autotest_lib.tko import db as tko_db, utils as tko_utils
from autotest_lib.tko import models, parser_lib
from autotest_lib.tko.perf_upload import perf_uploader
from chromite.lib import metrics
except ImportError:
metrics = utils.metrics_mock
_ParseOptions = collections.namedtuple(
'ParseOptions', ['reparse', 'mail_on_failure', 'dry_run', 'suite_report',
'datastore_creds', 'export_to_gcloud_path'])
# client side test control, as saved in old Autotest paths.
# server side test control, as saved in old Autotest paths.
# All control files, as saved in skylab.
def parse_args():
"""Parse args."""
# build up our options parser and parse sys.argv
parser = optparse.OptionParser()
parser.add_option("-m", help="Send mail for FAILED tests",
dest="mailit", action="store_true")
parser.add_option("-r", help="Reparse the results of a job",
dest="reparse", action="store_true")
parser.add_option("-o", help="Parse a single results directory",
dest="singledir", action="store_true")
parser.add_option("-l", help=("Levels of subdirectories to include "
"in the job name"),
type="int", dest="level", default=1)
parser.add_option("-n", help="No blocking on an existing parse",
dest="noblock", action="store_true")
parser.add_option("-s", help="Database server hostname",
dest="db_host", action="store")
parser.add_option("-u", help="Database username", dest="db_user",
parser.add_option("-p", help="Database password", dest="db_pass",
parser.add_option("-d", help="Database name", dest="db_name",
parser.add_option("--dry-run", help="Do not actually commit any results.",
dest="dry_run", action="store_true", default=False)
"--detach", action="store_true",
help="Detach parsing process from the caller process. Used by "
"monitor_db to safely restart without affecting parsing.",
help="write pidfile (.parser_execute)",
dest="write_pidfile", action="store_true",
help="[DEPRECATED] Record timing to metadata db",
dest="record_duration", action="store_true",
help=("Allows parsing job to attempt to create a suite "
"timeline report, if it detects that the job being "
"parsed is a suite job."),
dest="suite_report", action="store_true",
help=("The path to gcloud datastore credentials file, "
"which will be used to upload suite timeline "
"report to gcloud. If not specified, the one "
"defined in shadow_config will be used."),
dest="datastore_creds", action="store", default=None)
help=("The path to export_to_gcloud script. Please find "
"chromite path on your server. The script is under "
dest="export_to_gcloud_path", action="store",
options, args = parser.parse_args()
# we need a results directory
if len(args) == 0:
tko_utils.dprint("ERROR: at least one results directory must "
"be provided")
if not options.datastore_creds:
gcloud_creds = global_config.global_config.get_config_value(
'GCLOUD', 'cidb_datastore_writer_creds', default=None)
options.datastore_creds = (site_utils.get_creds_abspath(gcloud_creds)
if gcloud_creds else None)
if not options.export_to_gcloud_path:
export_script = 'chromiumos/chromite/bin/export_to_gcloud'
# If it is a lab server, the script is under ~chromeos-test/
if os.path.exists(os.path.expanduser('~chromeos-test/%s' %
path = os.path.expanduser('~chromeos-test/%s' % export_script)
# If it is a local workstation, it is probably under ~/
elif os.path.exists(os.path.expanduser('~/%s' % export_script)):
path = os.path.expanduser('~/%s' % export_script)
# If it is not found anywhere, the default will be set to None.
path = None
options.export_to_gcloud_path = path
# pass the options back
return options, args
def format_failure_message(jobname, kernel, testname, status, reason):
"""Format failure message with the given information.
@param jobname: String representing the job name.
@param kernel: String representing the kernel.
@param testname: String representing the test name.
@param status: String representing the test status.
@param reason: String representing the reason.
@return: Failure message as a string.
format_string = "%-12s %-20s %-12s %-10s %s"
return format_string % (jobname, kernel, testname, status, reason)
def mailfailure(jobname, job, message):
"""Send an email about the failure.
@param jobname: String representing the job name.
@param job: A job object.
@param message: The message to mail.
message_lines = [""]
message_lines.append("The following tests FAILED for this job")
message_lines.append("http://%s/results/%s" %
(socket.gethostname(), jobname))
message_lines.append(format_failure_message("Job name", "Kernel",
"Test name", "FAIL/WARN",
"Failure reason"))
message_lines.append(format_failure_message("=" * 8, "=" * 6, "=" * 8,
"=" * 8, "=" * 14))
message_header = "\n".join(message_lines)
subject = "AUTOTEST: FAILED tests from job %s" % jobname
mail.send("", job.user, "", subject, message_header + message)
def _invalidate_original_tests(orig_job_idx, retry_job_idx):
"""Retry tests invalidates original tests.
Whenever a retry job is complete, we want to invalidate the original
job's test results, such that the consumers of the tko database
(e.g. tko frontend, wmatrix) could figure out which results are the latest.
When a retry job is parsed, we retrieve the original job's afe_job_id
from the retry job's keyvals, which is then converted to tko job_idx and
passed into this method as |orig_job_idx|.
In this method, we are going to invalidate the rows in tko_tests that are
associated with the original job by flipping their 'invalid' bit to True.
In addition, in tko_tests, we also maintain a pointer from the retry results
to the original results, so that later we can always know which rows in
tko_tests are retries and which are the corresponding original results.
This is done by setting the field 'invalidates_test_idx' of the tests
associated with the retry job.
For example, assume Job(job_idx=105) are retried by Job(job_idx=108), after
this method is run, their tko_tests rows will look like:
test_idx| job_idx | test | ... | invalid | invalidates_test_idx
10 | 105 | dummy_Fail.Error| ... | 1 | NULL
11 | 105 | dummy_Fail.Fail | ... | 1 | NULL
20 | 108 | dummy_Fail.Error| ... | 0 | 10
21 | 108 | dummy_Fail.Fail | ... | 0 | 11
Note the invalid bits of the rows for Job(job_idx=105) are set to '1'.
And the 'invalidates_test_idx' fields of the rows for Job(job_idx=108)
are set to 10 and 11 (the test_idx of the rows for the original job).
@param orig_job_idx: An integer representing the original job's
tko job_idx. Tests associated with this job will
be marked as 'invalid'.
@param retry_job_idx: An integer representing the retry job's
tko job_idx. The field 'invalidates_test_idx'
of the tests associated with this job will be updated.
msg = 'orig_job_idx: %s, retry_job_idx: %s' % (orig_job_idx, retry_job_idx)
if not orig_job_idx or not retry_job_idx:
tko_utils.dprint('ERROR: Could not invalidate tests: ' + msg)
# Using django models here makes things easier, but make sure that
# before this method is called, all other relevant transactions have been
# committed to avoid race condition. In the long run, we might consider
# to make the rest of parser use django models.
orig_tests = tko_models.Test.objects.filter(job__job_idx=orig_job_idx)
retry_tests = tko_models.Test.objects.filter(job__job_idx=retry_job_idx)
# Invalidate original tests.
# Maintain a dictionary that maps (test, subdir) to original tests.
# Note that within the scope of a job, (test, subdir) uniquelly
# identifies a test run, but 'test' does not.
# In a control file, one could run the same test with different
# 'subdir_tag', for example,
# job.run_test('dummy_Fail', tag='Error', subdir_tag='subdir_1')
# job.run_test('dummy_Fail', tag='Error', subdir_tag='subdir_2')
# In tko, we will get
# (test='dummy_Fail.Error', subdir='dummy_Fail.Error.subdir_1')
# (test='dummy_Fail.Error', subdir='dummy_Fail.Error.subdir_2')
invalidated_tests = {(orig_test.test, orig_test.subdir): orig_test
for orig_test in orig_tests}
for retry in retry_tests:
# It is possible that (retry.test, retry.subdir) doesn't exist
# in invalidated_tests. This could happen when the original job
# didn't run some of its tests. For example, a dut goes offline
# since the beginning of the job, in which case invalidated_tests
# will only have one entry for 'SERVER_JOB'.
orig_test = invalidated_tests.get((retry.test, retry.subdir), None)
if orig_test:
retry.invalidates_test = orig_test
tko_utils.dprint('DEBUG: Invalidated tests associated to job: ' + msg)
def _throttle_result_size(path):
"""Limit the total size of test results for the given path.
@param path: Path of the result directory.
if not result_runner.ENABLE_RESULT_THROTTLING:
'Result throttling is not enabled. Skipping throttling %s' %
max_result_size_KB = _max_result_size_from_control(path)
if max_result_size_KB is None:
max_result_size_KB = control_data.DEFAULT_MAX_RESULT_SIZE_KB
result_utils.execute(path, max_result_size_KB)
'Failed to throttle result size of %s.\nDetails %s' %
(path, traceback.format_exc()))
def _max_result_size_from_control(path):
"""Gets the max result size set in a control file, if any.
If not overrides is found, returns None.
for control_file in _HARDCODED_CONTROL_FILE_NAMES:
control = os.path.join(path, control_file)
if not os.path.exists(control):
max_result_size_KB = control_data.parse_control(
control, raise_warnings=False).max_result_size_KB
if max_result_size_KB != control_data.DEFAULT_MAX_RESULT_SIZE_KB:
return max_result_size_KB
except IOError as e:
'Failed to access %s. Error: %s\nDetails %s' %
(control, e, traceback.format_exc()))
except control_data.ControlVariableException as e:
'Failed to parse %s. Error: %s\nDetails %s' %
(control, e, traceback.format_exc()))
return None
def export_tko_job_to_file(job, jobname, filename):
"""Exports the tko job to disk file.
@param job: database object.
@param jobname: the job name as string.
@param filename: The path to the results to be parsed.
from autotest_lib.tko import job_serializer
serializer = job_serializer.JobSerializer()
serializer.serialize_to_binary(job, jobname, filename)
def parse_one(db, pid_file_manager, jobname, path, parse_options):
"""Parse a single job. Optionally send email on failure.
@param db: database object.
@param pid_file_manager: pidfile.PidFileManager object.
@param jobname: the tag used to search for existing job in db,
e.g. '1234-chromeos-test/host1'
@param path: The path to the results to be parsed.
@param parse_options: _ParseOptions instance.
reparse = parse_options.reparse
mail_on_failure = parse_options.mail_on_failure
dry_run = parse_options.dry_run
suite_report = parse_options.suite_report
datastore_creds = parse_options.datastore_creds
export_to_gcloud_path = parse_options.export_to_gcloud_path
tko_utils.dprint("\nScanning %s (%s)" % (jobname, path))
old_job_idx = db.find_job(jobname)
if old_job_idx is not None and not reparse:
tko_utils.dprint("! Job is already parsed, done")
# look up the status version
job_keyval = models.job.read_keyval(path)
status_version = job_keyval.get("status_version", 0)
parser = parser_lib.parser(status_version)
job = parser.make_job(path)
tko_utils.dprint("+ Parsing dir=%s, jobname=%s" % (path, jobname))
status_log_path = _find_status_log_path(path)
if not status_log_path:
tko_utils.dprint("! Unable to parse job, no status file")
_parse_status_log(parser, job, status_log_path)
if old_job_idx is not None:
job.job_idx = old_job_idx
unmatched_tests = _match_existing_tests(db, job)
if not dry_run:
_delete_tests_from_db(db, unmatched_tests)
job.afe_job_id = tko_utils.get_afe_job_id(jobname)
job.skylab_task_id = tko_utils.get_skylab_task_id(jobname)
job.afe_parent_job_id = job_keyval.get(constants.PARENT_JOB_ID)
job.skylab_parent_task_id = job_keyval.get(constants.PARENT_JOB_ID) = None
job.board = None
job.build_version = None
job.suite = None
if job.label:
label_info = site_utils.parse_job_name(job.label)
if label_info: = label_info.get('build', None)
job.build_version = label_info.get('build_version', None)
job.board = label_info.get('board', None)
job.suite = label_info.get('suite', None)
result_utils_lib.LOG = tko_utils.dprint
# Record test result size to job_keyvals
start_time = time.time()
result_size_info = site_utils.collect_result_sizes(
path, log=tko_utils.dprint)
tko_utils.dprint('Finished collecting result sizes after %s seconds' %
# TODO(dshi): Update sizes with sponge_invocation.xml and throttle it.
# check for failures
message_lines = [""]
job_successful = True
for test in job.tests:
if not test.subdir:
tko_utils.dprint("* testname, subdir, status, reason: %s %s %s %s"
% (test.testname, test.subdir, test.status,
if test.status != 'GOOD':
job_successful = False
pid_file_manager.num_tests_failed += 1
jobname, test.kernel.base, test.subdir,
test.status, test.reason))
message = "\n".join(message_lines)
if not dry_run:
# send out a email report of failure
if len(message) > 2 and mail_on_failure:
tko_utils.dprint("Sending email report of failure on %s to %s"
% (jobname, job.user))
mailfailure(jobname, job, message)
# Upload perf values to the perf dashboard, if applicable.
for test in job.tests:
perf_uploader.upload_test(job, test, jobname)
# Upload job details to Sponge.
sponge_url = sponge_utils.upload_results(job, log=tko_utils.dprint)
if sponge_url:
job.keyval_dict['sponge_url'] = sponge_url
_write_job_to_db(db, jobname, job)
# Verify the job data is written to the database.
if job.tests:
tests_in_db = db.find_tests(job.job_idx)
tests_in_db_count = len(tests_in_db) if tests_in_db else 0
if tests_in_db_count != len(job.tests):
'Failed to find enough tests for job_idx: %d. The '
'job should have %d tests, only found %d tests.' %
(job.job_idx, len(job.tests), tests_in_db_count))
description='The number of times parse failed to '
'save job to TKO database.').increment()
# Although the cursor has autocommit, we still need to force it to
# commit existing changes before we can use django models, otherwise
# it will go into deadlock when django models try to start a new
# trasaction while the current one has not finished yet.
# Handle retry job.
orig_afe_job_id = job_keyval.get(constants.RETRY_ORIGINAL_JOB_ID,
if orig_afe_job_id:
orig_job_idx = tko_models.Job.objects.get(
_invalidate_original_tests(orig_job_idx, job.job_idx)
# Serializing job into a binary file
export_tko_to_file = global_config.global_config.get_config_value(
'AUTOSERV', 'export_tko_job_to_file', type=bool, default=False)
binary_file_name = os.path.join(path, "job.serialize")
if export_tko_to_file:
export_tko_job_to_file(job, jobname, binary_file_name)
if not dry_run:
# Generate a suite report.
# Check whether this is a suite job, a suite job will be a hostless job, its
# jobname will be <JOB_ID>-<USERNAME>/hostless, the suite field will not be
# NULL. Only generate timeline report when datastore_parent_key is given.
datastore_parent_key = job_keyval.get('datastore_parent_key', None)
provision_job_id = job_keyval.get('provision_job_id', None)
if (suite_report and jobname.endswith('/hostless')
and job.suite and datastore_parent_key):
tko_utils.dprint('Start dumping suite timing report...')
timing_log = os.path.join(path, 'suite_timing.log')
dump_cmd = ("%s/site_utils/ %s "
"--output='%s' --debug" %
(common.autotest_dir, job.afe_job_id,
if provision_job_id is not None:
dump_cmd += " --provision_job_id=%d" % int(provision_job_id)
subprocess.check_output(dump_cmd, shell=True)
tko_utils.dprint('Successfully finish dumping suite timing report')
if (datastore_creds and export_to_gcloud_path
and os.path.exists(export_to_gcloud_path)):
upload_cmd = [export_to_gcloud_path, datastore_creds,
timing_log, '--parent_key',
tko_utils.dprint('Start exporting timeline report to gcloud')
tko_utils.dprint('Successfully export timeline report to '
tko_utils.dprint('DEBUG: skip exporting suite timeline to '
'gcloud, because either gcloud creds or '
'export_to_gcloud script is not found.')
# Mark GS_OFFLOADER_NO_OFFLOAD in gs_offloader_instructions at the end of
# the function, so any failure, e.g., db connection error, will stop
# gs_offloader_instructions being updated, and logs can be uploaded for
# troubleshooting.
if job_successful:
# Check if we should not offload this test's results.
if job_keyval.get(constants.JOB_OFFLOAD_FAILURES_KEY, False):
# Update the gs_offloader_instructions json file.
gs_instructions_file = os.path.join(
gs_offloader_instructions = {}
if os.path.exists(gs_instructions_file):
with open(gs_instructions_file, 'r') as f:
gs_offloader_instructions = json.load(f)
gs_offloader_instructions[constants.GS_OFFLOADER_NO_OFFLOAD] = True
with open(gs_instructions_file, 'w') as f:
json.dump(gs_offloader_instructions, f)
def _write_job_to_db(db, jobname, job):
"""Write all TKO data associated with a job to DB.
This updates the job object as a side effect.
@param db: tko.db.db_sql object.
@param jobname: Name of the job to write.
@param job: tko.models.job object.
db.insert_job(jobname, job)
'skylab' if tko_utils.is_skylab_task(jobname) else 'afe',
for test in job.tests:
db.insert_test(job, test)
def _find_status_log_path(path):
if os.path.exists(os.path.join(path, "status.log")):
return os.path.join(path, "status.log")
if os.path.exists(os.path.join(path, "status")):
return os.path.join(path, "status")
return ""
def _parse_status_log(parser, job, status_log_path):
status_lines = open(status_log_path).readlines()
tests = parser.end(status_lines)
# parser.end can return the same object multiple times, so filter out dups
job.tests = []
already_added = set()
for test in tests:
if test not in already_added:
def _match_existing_tests(db, job):
"""Find entries in the DB corresponding to the job's tests, update job.
@return: Any unmatched tests in the db.
old_job_idx = job.job_idx
raw_old_tests ="test_idx,subdir,test", "tko_tests",
{"job_idx": old_job_idx})
if raw_old_tests:
old_tests = dict(((test, subdir), test_idx)
for test_idx, subdir, test in raw_old_tests)
old_tests = {}
for test in job.tests:
test_idx = old_tests.pop((test.testname, test.subdir), None)
if test_idx is not None:
test.test_idx = test_idx
tko_utils.dprint("! Reparse returned new test "
"testname=%r subdir=%r" %
(test.testname, test.subdir))
return old_tests
def _delete_tests_from_db(db, tests):
for test_idx in tests.itervalues():
where = {'test_idx' : test_idx}
db.delete('tko_iteration_result', where)
db.delete('tko_iteration_perf_value', where)
db.delete('tko_iteration_attributes', where)
db.delete('tko_test_attributes', where)
db.delete('tko_test_labels_tests', {'test_id': test_idx})
db.delete('tko_tests', where)
def _get_job_subdirs(path):
Returns a list of job subdirectories at path. Returns None if the test
is itself a job directory. Does not recurse into the subdirs.
# if there's a .machines file, use it to get the subdirs
machine_list = os.path.join(path, ".machines")
if os.path.exists(machine_list):
subdirs = set(line.strip() for line in file(machine_list))
existing_subdirs = set(subdir for subdir in subdirs
if os.path.exists(os.path.join(path, subdir)))
if len(existing_subdirs) != 0:
return existing_subdirs
# if this dir contains ONLY subdirectories, return them
contents = set(os.listdir(path))
subdirs = set(sub for sub in contents if
os.path.isdir(os.path.join(path, sub)))
if len(contents) == len(subdirs) != 0:
return subdirs
# this is a job directory, or something else we don't understand
return None
def parse_leaf_path(db, pid_file_manager, path, level, parse_options):
"""Parse a leaf path.
@param db: database handle.
@param pid_file_manager: pidfile.PidFileManager object.
@param path: The path to the results to be parsed.
@param level: Integer, level of subdirectories to include in the job name.
@param parse_options: _ParseOptions instance.
@returns: The job name of the parsed job, e.g. '123-chromeos-test/host1'
job_elements = path.split("/")[-level:]
jobname = "/".join(job_elements)
db.run_with_retry(parse_one, db, pid_file_manager, jobname, path,
return jobname
def parse_path(db, pid_file_manager, path, level, parse_options):
"""Parse a path
@param db: database handle.
@param pid_file_manager: pidfile.PidFileManager object.
@param path: The path to the results to be parsed.
@param level: Integer, level of subdirectories to include in the job name.
@param parse_options: _ParseOptions instance.
@returns: A set of job names of the parsed jobs.
set(['123-chromeos-test/host1', '123-chromeos-test/host2'])
processed_jobs = set()
job_subdirs = _get_job_subdirs(path)
if job_subdirs is not None:
# parse status.log in current directory, if it exists. multi-machine
# synchronous server side tests record output in this directory. without
# this check, we do not parse these results.
if os.path.exists(os.path.join(path, 'status.log')):
new_job = parse_leaf_path(db, pid_file_manager, path, level,
# multi-machine job
for subdir in job_subdirs:
jobpath = os.path.join(path, subdir)
new_jobs = parse_path(db, pid_file_manager, jobpath, level + 1,
# single machine job
new_job = parse_leaf_path(db, pid_file_manager, path, level,
return processed_jobs
def _detach_from_parent_process():
"""Allow reparenting the parse process away from caller.
When monitor_db is run via upstart, restarting the job sends SIGTERM to
the whole process group. This makes us immune from that.
if os.getpid() != os.getpgid(0):
def main():
"""tko_parse entry point."""
options, args = parse_args()
# We are obliged to use indirect=False, not use the SetupTsMonGlobalState
# context manager, and add a manual flush, because tko/parse is expected to
# be a very short lived (<1 min) script when working effectively, and we
# can't afford to either a) wait for up to 1min for metrics to flush at the
# end or b) drop metrics that were sent within the last minute of execution.
site_utils.SetupTsMonGlobalState('tko_parse', indirect=False,
with metrics.SuccessCounter('chromeos/autotest/tko_parse/runs'):
_main_with_options(options, args)
def _main_with_options(options, args):
"""Entry point with options parsed and metrics already set up."""
# Record the processed jobs so that
# we can send the duration of parsing to metadata db.
processed_jobs = set()
if options.detach:
parse_options = _ParseOptions(options.reparse, options.mailit,
options.dry_run, options.suite_report,
results_dir = os.path.abspath(args[0])
assert os.path.exists(results_dir)
pid_file_manager = pidfile.PidFileManager("parser", results_dir)
if options.write_pidfile:
# build up the list of job dirs to parse
if options.singledir:
jobs_list = [results_dir]
jobs_list = [os.path.join(results_dir, subdir)
for subdir in os.listdir(results_dir)]
# build up the database
db = tko_db.db(autocommit=False, host=options.db_host,
user=options.db_user, password=options.db_pass,
# parse all the jobs
for path in jobs_list:
lockfile = open(os.path.join(path, ".parse.lock"), "w")
flags = fcntl.LOCK_EX
if options.noblock:
flags |= fcntl.LOCK_NB
fcntl.flock(lockfile, flags)
except IOError, e:
# lock is not available and nonblock has been requested
if e.errno == errno.EWOULDBLOCK:
raise # something unexpected happened
new_jobs = parse_path(db, pid_file_manager, path, options.level,
fcntl.flock(lockfile, fcntl.LOCK_UN)
except Exception as e:
if __name__ == "__main__":