blob: 182641b2f13fa01f3fed48473af57c91ec613023 [file] [log] [blame]
#pylint: disable-msg=C0111
Utility functions for We keep them in a separate file so that
only RPC interface functions go into that file.
__author__ = ' (Steve Howard)'
import datetime, os, inspect
import django.http
from autotest_lib.frontend.afe import models, model_logic
from autotest_lib.client.common_lib import priorities
from autotest_lib.client.common_lib import control_data, error
from autotest_lib.server.cros import provision
NULL_DATETIME = datetime.datetime.max
def prepare_for_serialization(objects):
Prepare Python objects to be returned via RPC.
@param objects: objects to be prepared.
if (isinstance(objects, list) and len(objects) and
isinstance(objects[0], dict) and 'id' in objects[0]):
objects = gather_unique_dicts(objects)
return _prepare_data(objects)
def prepare_rows_as_nested_dicts(query, nested_dict_column_names):
Prepare a Django query to be returned via RPC as a sequence of nested
@param query - A Django model query object with a select_related() method.
@param nested_dict_column_names - A list of column/attribute names for the
rows returned by query to expand into nested dictionaries using
their get_object_dict() method when not None.
@returns An list suitable to returned in an RPC.
all_dicts = []
for row in query.select_related():
row_dict = row.get_object_dict()
for column in nested_dict_column_names:
if row_dict[column] is not None:
row_dict[column] = getattr(row, column).get_object_dict()
return prepare_for_serialization(all_dicts)
def _prepare_data(data):
Recursively process data structures, performing necessary type
conversions to values in data to allow for RPC serialization:
-convert datetimes to strings
-convert tuples and sets to lists
if isinstance(data, dict):
new_data = {}
for key, value in data.iteritems():
new_data[key] = _prepare_data(value)
return new_data
elif (isinstance(data, list) or isinstance(data, tuple) or
isinstance(data, set)):
return [_prepare_data(item) for item in data]
elif isinstance(data,
if data is NULL_DATETIME or data is NULL_DATE:
return None
return str(data)
return data
def raw_http_response(response_data, content_type=None):
response = django.http.HttpResponse(response_data, mimetype=content_type)
response['Content-length'] = str(len(response.content))
return response
def gather_unique_dicts(dict_iterable):
Pick out unique objects (by ID) from an iterable of object dicts.
id_set = set()
result = []
for obj in dict_iterable:
if obj['id'] not in id_set:
return result
def extra_job_filters(not_yet_run=False, running=False, finished=False):
Generate a SQL WHERE clause for job status filtering, and return it in
a dict of keyword args to pass to query.extra(). No more than one of
the parameters should be passed as True.
* not_yet_run: all HQEs are Queued
* finished: all HQEs are complete
* running: everything else
assert not ((not_yet_run and running) or
(not_yet_run and finished) or
(running and finished)), ('Cannot specify more than one '
'filter to this function')
not_queued = ('(SELECT job_id FROM afe_host_queue_entries '
'WHERE status != "%s")'
% models.HostQueueEntry.Status.QUEUED)
not_finished = ('(SELECT job_id FROM afe_host_queue_entries '
'WHERE not complete)')
if not_yet_run:
where = ['id NOT IN ' + not_queued]
elif running:
where = ['(id IN %s) AND (id IN %s)' % (not_queued, not_finished)]
elif finished:
where = ['id NOT IN ' + not_finished]
return {}
return {'where': where}
def extra_host_filters(multiple_labels=()):
Generate SQL WHERE clauses for matching hosts in an intersection of
extra_args = {}
where_str = (' in (select host_id from afe_hosts_labels '
'where label_id=%s)')
extra_args['where'] = [where_str] * len(multiple_labels)
extra_args['params'] = [models.Label.smart_get(label).id
for label in multiple_labels]
return extra_args
def get_host_query(multiple_labels, exclude_only_if_needed_labels,
exclude_atomic_group_hosts, valid_only, filter_data):
if valid_only:
query = models.Host.valid_objects.all()
query = models.Host.objects.all()
if exclude_only_if_needed_labels:
only_if_needed_labels = models.Label.valid_objects.filter(
if only_if_needed_labels.count() > 0:
only_if_needed_ids = ','.join(
for label in only_if_needed_labels.values('id'))
query = models.Host.objects.add_join(
query, 'afe_hosts_labels', join_key='host_id',
join_condition=('afe_hosts_labels_exclude_OIN.label_id IN (%s)'
% only_if_needed_ids),
suffix='_exclude_OIN', exclude=True)
if exclude_atomic_group_hosts:
atomic_group_labels = models.Label.valid_objects.filter(
if atomic_group_labels.count() > 0:
atomic_group_label_ids = ','.join(
for atomic_group in atomic_group_labels.values('id'))
query = models.Host.objects.add_join(
query, 'afe_hosts_labels', join_key='host_id',
'afe_hosts_labels_exclude_AG.label_id IN (%s)'
% atomic_group_label_ids),
suffix='_exclude_AG', exclude=True)
assert 'extra_args' not in filter_data
filter_data['extra_args'] = extra_host_filters(multiple_labels)
return models.Host.query_objects(filter_data, initial_query=query)
except models.Label.DoesNotExist as e:
return models.Host.objects.none()
class InconsistencyException(Exception):
'Raised when a list of objects does not have a consistent value'
def get_consistent_value(objects, field):
if not objects:
# well a list of nothing is consistent
return None
value = getattr(objects[0], field)
for obj in objects:
this_value = getattr(obj, field)
if this_value != value:
raise InconsistencyException(objects[0], obj)
return value
def prepare_generate_control_file(tests, kernel, label, profilers):
test_objects = [models.Test.smart_get(test) for test in tests]
profiler_objects = [models.Profiler.smart_get(profiler)
for profiler in profilers]
# ensure tests are all the same type
test_type = get_consistent_value(test_objects, 'test_type')
except InconsistencyException, exc:
test1, test2 = exc.args
raise model_logic.ValidationError(
{'tests' : 'You cannot run both server- and client-side '
'tests together (tests %s and %s differ' % (,})
is_server = (test_type == control_data.CONTROL_TYPE.SERVER)
if test_objects:
synch_count = max(test.sync_count for test in test_objects)
synch_count = 1
if label:
label = models.Label.smart_get(label)
dependencies = set( for label
in models.Label.objects.filter(test__in=test_objects))
cf_info = dict(is_server=is_server, synch_count=synch_count,
return cf_info, test_objects, profiler_objects, label
def check_job_dependencies(host_objects, job_dependencies):
Check that a set of machines satisfies a job's dependencies.
host_objects: list of models.Host objects
job_dependencies: list of names of labels
# check that hosts satisfy dependencies
host_ids = [ for host in host_objects]
hosts_in_job = models.Host.objects.filter(id__in=host_ids)
ok_hosts = hosts_in_job
for index, dependency in enumerate(job_dependencies):
if not provision.is_for_special_action(dependency):
ok_hosts = ok_hosts.filter(labels__name=dependency)
failing_hosts = (set(host.hostname for host in host_objects) -
set(host.hostname for host in ok_hosts))
if failing_hosts:
raise model_logic.ValidationError(
{'hosts' : 'Host(s) failed to meet job dependencies (' +
(', '.join(job_dependencies)) + '): ' +
(', '.join(failing_hosts))})
def check_job_metahost_dependencies(metahost_objects, job_dependencies):
Check that at least one machine within the metahost spec satisfies the job's
@param metahost_objects A list of label objects representing the metahosts.
@param job_dependencies A list of strings of the required label names.
@raises NoEligibleHostException If a metahost cannot run the job.
for metahost in metahost_objects:
hosts = models.Host.objects.filter(labels=metahost)
for label_name in job_dependencies:
if not provision.is_for_special_action(label_name):
hosts = hosts.filter(labels__name=label_name)
if not any(hosts):
raise error.NoEligibleHostException("No hosts within %s satisfy %s."
% (, ', '.join(job_dependencies)))
def _execution_key_for(host_queue_entry):
return (, host_queue_entry.execution_subdir)
def check_abort_synchronous_jobs(host_queue_entries):
# ensure user isn't aborting part of a synchronous autoserv execution
count_per_execution = {}
for queue_entry in host_queue_entries:
key = _execution_key_for(queue_entry)
count_per_execution.setdefault(key, 0)
count_per_execution[key] += 1
for queue_entry in host_queue_entries:
if not queue_entry.execution_subdir:
execution_count = count_per_execution[_execution_key_for(queue_entry)]
if execution_count < queue_entry.job.synch_count:
raise model_logic.ValidationError(
{'' : 'You cannot abort part of a synchronous job execution '
'(%d/%s), %d included, %d expected'
% (, queue_entry.execution_subdir,
execution_count, queue_entry.job.synch_count)})
def check_atomic_group_create_job(synch_count, host_objects, metahost_objects,
dependencies, atomic_group):
Attempt to reject create_job requests with an atomic group that
will be impossible to schedule. The checks are not perfect but
should catch the most obvious issues.
@param synch_count - The job's minimum synch count.
@param host_objects - A list of models.Host instances.
@param metahost_objects - A list of models.Label instances.
@param dependencies - A list of job dependency label names.
@param labels_by_name - A dictionary mapping label names to models.Label
instance. Used to look up instances for dependencies.
@raises model_logic.ValidationError - When an issue is found.
# If specific host objects were supplied with an atomic group, verify
# that there are enough to satisfy the synch_count.
minimum_required = synch_count or 1
if (host_objects and not metahost_objects and
len(host_objects) < minimum_required):
raise model_logic.ValidationError(
'only %d hosts provided for job with synch_count = %d' %
(len(host_objects), synch_count)})
# Check that the atomic group has a hope of running this job
# given any supplied metahosts and dependancies that may limit.
# Get a set of hostnames in the atomic group.
possible_hosts = set()
for label in atomic_group.label_set.all():
possible_hosts.update(h.hostname for h in label.host_set.all())
# Filter out hosts that don't match all of the job dependency labels.
for label in models.Label.objects.filter(name__in=dependencies):
hosts_in_label = (h.hostname for h in label.host_set.all())
if not host_objects and not metahost_objects:
# No hosts or metahosts are required to queue an atomic group Job.
# However, if they are given, we respect them below.
host_set = possible_hosts
host_set = set(host.hostname for host in host_objects)
unusable_host_set = host_set.difference(possible_hosts)
if unusable_host_set:
raise model_logic.ValidationError(
{'hosts': 'Hosts "%s" are not in Atomic Group "%s"' %
(', '.join(sorted(unusable_host_set)),})
# Lookup hosts provided by each meta host and merge them into the
# host_set for final counting.
for meta_host in metahost_objects:
meta_possible = possible_hosts.copy()
hosts_in_meta_host = (h.hostname for h in meta_host.host_set.all())
# Count all hosts that this meta_host will provide.
if len(host_set) < minimum_required:
raise model_logic.ValidationError(
'Insufficient hosts in Atomic Group "%s" with the'
' supplied dependencies and meta_hosts.' %
def check_modify_host(update_data):
Sanity check modify_host* requests.
@param update_data: A dictionary with the changes to make to a host
or hosts.
# Only the scheduler (monitor_db) is allowed to modify Host status.
# Otherwise race conditions happen as a hosts state is changed out from
# beneath tasks being run on a host.
if 'status' in update_data:
raise model_logic.ValidationError({
'status': 'Host status can not be modified by the frontend.'})
def check_modify_host_locking(host, update_data):
Checks when locking/unlocking has been requested if the host is already
@param host: models.Host object to be modified
@param update_data: A dictionary with the changes to make to the host.
locked = update_data.get('locked', None)
if locked is not None:
if locked and host.locked:
raise model_logic.ValidationError({
'locked': 'Host already locked by %s on %s.' %
(host.locked_by, host.lock_time)})
if not locked and not host.locked:
raise model_logic.ValidationError({
'locked': 'Host already unlocked.'})
def get_motd():
dirname = os.path.dirname(__file__)
filename = os.path.join(dirname, "..", "..", "motd.txt")
text = ''
fp = open(filename, "r")
text =
return text
def _get_metahost_counts(metahost_objects):
metahost_counts = {}
for metahost in metahost_objects:
metahost_counts.setdefault(metahost, 0)
metahost_counts[metahost] += 1
return metahost_counts
def get_job_info(job, preserve_metahosts=False, queue_entry_filter_data=None):
hosts = []
one_time_hosts = []
meta_hosts = []
atomic_group = None
hostless = False
queue_entries = job.hostqueueentry_set.all()
if queue_entry_filter_data:
queue_entries = models.HostQueueEntry.query_objects(
queue_entry_filter_data, initial_query=queue_entries)
for queue_entry in queue_entries:
if ( and (preserve_metahosts or
not queue_entry.meta_host)):
if queue_entry.deleted:
elif queue_entry.meta_host:
hostless = True
if atomic_group is None:
if queue_entry.atomic_group is not None:
atomic_group = queue_entry.atomic_group
assert ==, (
'DB inconsistency. HostQueueEntries with multiple atomic'
' groups on job %s: %s != %s' % (
meta_host_counts = _get_metahost_counts(meta_hosts)
info = dict(dependencies=[ for label
in job.dependency_labels.all()],
return info
def check_for_duplicate_hosts(host_objects):
host_ids = set()
duplicate_hostnames = set()
for host in host_objects:
if in host_ids:
if duplicate_hostnames:
raise model_logic.ValidationError(
{'hosts' : 'Duplicate hosts: %s'
% ', '.join(duplicate_hostnames)})
def create_new_job(owner, options, host_objects, metahost_objects,
all_host_objects = host_objects + metahost_objects
metahost_counts = _get_metahost_counts(metahost_objects)
dependencies = options.get('dependencies', [])
synch_count = options.get('synch_count')
if atomic_group:
synch_count, host_objects, metahost_objects,
dependencies, atomic_group)
if synch_count is not None and synch_count > len(all_host_objects):
raise model_logic.ValidationError(
'only %d hosts provided for job with synch_count = %d' %
(len(all_host_objects), synch_count)})
atomic_hosts = models.Host.objects.filter(
id__in=[ for host in host_objects],
unusable_host_names = [host.hostname for host in atomic_hosts]
if unusable_host_names:
raise model_logic.ValidationError(
'Host(s) "%s" are atomic group hosts but no '
'atomic group was specified for this job.' %
(', '.join(unusable_host_names),)})
for label_name in dependencies:
if provision.is_for_special_action(label_name):
# TODO: We could save a few queries
# if we had a bulk ensure-label-exists function, which used
# a bulk .get() call. The win is probably very small.
# This only checks targeted hosts, not hosts eligible due to the metahost
check_job_dependencies(host_objects, dependencies)
check_job_metahost_dependencies(metahost_objects, dependencies)
options['dependencies'] = list(
for label in metahost_objects + options['dependencies']:
if label.atomic_group and not atomic_group:
raise model_logic.ValidationError(
'Dependency %r requires an atomic group but no '
'atomic_group_name or meta_host in an atomic group was '
'specified for this job.' %})
elif (label.atomic_group and !=
raise model_logic.ValidationError(
'meta_hosts or dependency %r requires atomic group '
'%r instead of the supplied atomic_group_name=%r.' %
job = models.Job.create(owner=owner, options=options,
job.queue(all_host_objects, atomic_group=atomic_group,
is_template=options.get('is_template', False))
def _ensure_label_exists(name):
Ensure that a label called |name| exists in the Django models.
This function is to be called from within afe rpcs only, as an
alternative to server.cros.provision.ensure_label_exists(...). It works
by Django model manipulation, rather than by making another create_label
rpc call.
@param name: the label to check for/create.
@raises ValidationError: There was an error in the response that was
not because the label already existed.
@returns True is a label was created, False otherwise.
except models.Label.DoesNotExist:
new_label = models.Label.objects.create(name=name)
return True
return False
def find_platform_and_atomic_group(host):
Figure out the platform name and atomic group name for the given host
object. If none, the return value for either will be None.
@returns (platform name, atomic group name) for the given host.
platforms = [ for label in host.label_list if label.platform]
if not platforms:
platform = None
platform = platforms[0]
if len(platforms) > 1:
raise ValueError('Host %s has more than one platform: %s' %
(host.hostname, ', '.join(platforms)))
for label in host.label_list:
if label.atomic_group:
atomic_group_name =
atomic_group_name = None
# Don't check for multiple atomic groups on a host here. That is an
# error but should not trip up the RPC interface. monitor_db_cleanup
# deals with it. This just returns the first one found.
return platform, atomic_group_name
# support for get_host_queue_entries_and_special_tasks()
def _common_entry_to_dict(entry, type, job_dict):
return dict(type=type,,
id=str( + type)
def _special_task_to_dict(special_task):
job_dict = None
if special_task.queue_entry:
job_dict = special_task.queue_entry.job.get_object_dict()
return _common_entry_to_dict(special_task, special_task.task, job_dict)
def _queue_entry_to_dict(queue_entry):
return _common_entry_to_dict(queue_entry, 'Job',
def _compute_next_job_for_tasks(queue_entries, special_tasks):
For each task, try to figure out the next job that ran after that task.
This is done using two pieces of information:
* if the task has a queue entry, we can use that entry's job ID.
* if the task has a time_started, we can try to compare that against the
started_on field of queue_entries. this isn't guaranteed to work perfectly
since queue_entries may also have null started_on values.
* if the task has neither, or if use of time_started fails, just use the
last computed job ID.
next_job_id = None # most recently computed next job
hqe_index = 0 # index for scanning by started_on times
for task in special_tasks:
if task.queue_entry:
next_job_id =
elif task.time_started is not None:
for queue_entry in queue_entries[hqe_index:]:
if queue_entry.started_on is None:
if queue_entry.started_on < task.time_started:
next_job_id =
task.next_job_id = next_job_id
# advance hqe_index to just after next_job_id
if next_job_id is not None:
for queue_entry in queue_entries[hqe_index:]:
if < next_job_id:
hqe_index += 1
def interleave_entries(queue_entries, special_tasks):
Both lists should be ordered by descending ID.
_compute_next_job_for_tasks(queue_entries, special_tasks)
# start with all special tasks that've run since the last job
interleaved_entries = []
for task in special_tasks:
if task.next_job_id is not None:
# now interleave queue entries with the remaining special tasks
special_task_index = len(interleaved_entries)
for queue_entry in queue_entries:
# add all tasks that ran between this job and the previous one
for task in special_tasks[special_task_index:]:
if task.next_job_id <
special_task_index += 1
return interleaved_entries
def get_create_job_common_args(local_args):
Returns a dict containing only the args that apply for create_job_common
Returns a subset of local_args, which contains only the arguments that can
be passed in to create_job_common().
# This code is only here to not kill suites scheduling tests when priority
# becomes an int instead of a string.
if isinstance(local_args['priority'], str):
local_args['priority'] = priorities.Priority.DEFAULT
# </migration hack>
arg_names, _, _, _ = inspect.getargspec(create_job_common)
return dict(item for item in local_args.iteritems() if item[0] in arg_names)
def create_job_common(name, priority, control_type, control_file=None,
hosts=(), meta_hosts=(), one_time_hosts=(),
atomic_group_name=None, synch_count=None,
is_template=False, timeout=None, timeout_mins=None,
max_runtime_mins=None, run_verify=True, email_list='',
dependencies=(), reboot_before=None, reboot_after=None,
parse_failed_repair=None, hostless=False, keyvals=None,
drone_set=None, parameterized_job=None,
parent_job_id=None, test_retry=0, run_reset=True):
#pylint: disable-msg=C0111
Common code between creating "standard" jobs and creating parameterized jobs
user = models.User.current_user()
owner = user.login
# input validation
if not (hosts or meta_hosts or one_time_hosts or atomic_group_name
or hostless):
raise model_logic.ValidationError({
'arguments' : "You must pass at least one of 'hosts', "
"'meta_hosts', 'one_time_hosts', "
"'atomic_group_name', or 'hostless'"
if hostless:
if hosts or meta_hosts or one_time_hosts or atomic_group_name:
raise model_logic.ValidationError({
'hostless': 'Hostless jobs cannot include any hosts!'})
server_type = control_data.CONTROL_TYPE_NAMES.SERVER
if control_type != server_type:
raise model_logic.ValidationError({
'control_type': 'Hostless jobs cannot use client-side '
'control files'})
atomic_groups_by_name = dict((, ag)
for ag in models.AtomicGroup.objects.all())
label_objects = list(models.Label.objects.filter(name__in=meta_hosts))
# Schedule on an atomic group automagically if one of the labels given
# is an atomic group label and no explicit atomic_group_name was supplied.
if not atomic_group_name:
for label in label_objects:
if label and label.atomic_group:
atomic_group_name =
# convert hostnames & meta hosts to host/label objects
host_objects = models.Host.smart_get_bulk(hosts)
metahost_objects = []
meta_host_labels_by_name = { label for label in label_objects}
for label_name in meta_hosts or []:
if label_name in meta_host_labels_by_name:
elif label_name in atomic_groups_by_name:
# If given a metahost name that isn't a Label, check to
# see if the user was specifying an Atomic Group instead.
atomic_group = atomic_groups_by_name[label_name]
if atomic_group_name and atomic_group_name !=
raise model_logic.ValidationError({
'meta_hosts': (
'Label "%s" not found. If assumed to be an '
'atomic group it would conflict with the '
'supplied atomic group "%s".' % (
label_name, atomic_group_name))})
atomic_group_name =
raise model_logic.ValidationError(
{'meta_hosts' : 'Label "%s" not found' % label_name})
# Create and sanity check an AtomicGroup object if requested.
if atomic_group_name:
if one_time_hosts:
raise model_logic.ValidationError(
'One time hosts cannot be used with an Atomic Group.'})
atomic_group = models.AtomicGroup.smart_get(atomic_group_name)
if synch_count and synch_count > atomic_group.max_number_of_machines:
raise model_logic.ValidationError(
{'atomic_group_name' :
'You have requested a synch_count (%d) greater than the '
'maximum machines in the requested Atomic Group (%d).' %
(synch_count, atomic_group.max_number_of_machines)})
atomic_group = None
for host in one_time_hosts or []:
this_host = models.Host.create_one_time_host(host)
options = dict(name=name,
return create_new_job(owner=owner,
def encode_ascii(control_file):
"""Force a control file to only contain ascii characters.
@param control_file: Control file to encode.
@returns the control file in an ascii encoding.
@raises error.ControlFileMalformed: if encoding fails.
return control_file.encode('ascii')
except UnicodeDecodeError as e:
raise error.ControlFileMalformed(str(e))