blob: 21e4d5a60b6da311a49abb596431c6631ae35512 [file] [log] [blame]
mblighe8819cd2008-02-15 16:48:40 +00001"""\
2Functions to expose over the RPC interface.
3
4For all modify* and delete* functions that ask for an 'id' parameter to
5identify the object to operate on, the id may be either
6 * the database row ID
7 * the name of the object (label name, hostname, user login, etc.)
8 * a dictionary containing uniquely identifying field (this option should seldom
9 be used)
10
11When specifying foreign key fields (i.e. adding hosts to a label, or adding
12users to an ACL group), the given value may be either the database row ID or the
13name of the object.
14
15All get* functions return lists of dictionaries. Each dictionary represents one
16object and maps field names to values.
17
18Some examples:
19modify_host(2, hostname='myhost') # modify hostname of host with database ID 2
20modify_host('ipaj2', hostname='myhost') # modify hostname of host 'ipaj2'
21modify_test('sleeptest', test_type='Client', params=', seconds=60')
22delete_acl_group(1) # delete by ID
23delete_acl_group('Everyone') # delete by name
24acl_group_add_users('Everyone', ['mbligh', 'showard'])
25get_jobs(owner='showard', status='Queued')
26
mbligh93c80e62009-02-03 17:48:30 +000027See doctests/001_rpc_test.txt for (lots) more examples.
mblighe8819cd2008-02-15 16:48:40 +000028"""
29
30__author__ = 'showard@google.com (Steve Howard)'
31
showard29f7cd22009-04-29 21:16:24 +000032import datetime
showardcafd16e2009-05-29 18:37:49 +000033import common
34from autotest_lib.frontend import thread_local
showard6d7b2ff2009-06-10 00:16:47 +000035from autotest_lib.frontend.afe import models, model_logic
36from autotest_lib.frontend.afe import control_file, rpc_utils
showard3bb499f2008-07-03 19:42:20 +000037from autotest_lib.client.common_lib import global_config
38
mblighe8819cd2008-02-15 16:48:40 +000039
40# labels
41
showard989f25d2008-10-01 11:38:11 +000042def add_label(name, kernel_config=None, platform=None, only_if_needed=None):
showardc92da832009-04-07 18:14:34 +000043 return models.Label.add_object(
44 name=name, kernel_config=kernel_config, platform=platform,
45 only_if_needed=only_if_needed).id
mblighe8819cd2008-02-15 16:48:40 +000046
47
48def modify_label(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +000049 models.Label.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +000050
51
52def delete_label(id):
jadmanski0afbb632008-06-06 21:10:57 +000053 models.Label.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +000054
55
showardbbabf502008-06-06 00:02:02 +000056def label_add_hosts(id, hosts):
showardbe3ec042008-11-12 18:16:07 +000057 host_objs = models.Host.smart_get_bulk(hosts)
showardcafd16e2009-05-29 18:37:49 +000058 label = models.Label.smart_get(id)
59 if label.platform:
60 models.Host.check_no_platform(host_objs)
61 label.host_set.add(*host_objs)
showardbbabf502008-06-06 00:02:02 +000062
63
64def label_remove_hosts(id, hosts):
showardbe3ec042008-11-12 18:16:07 +000065 host_objs = models.Host.smart_get_bulk(hosts)
jadmanski0afbb632008-06-06 21:10:57 +000066 models.Label.smart_get(id).host_set.remove(*host_objs)
showardbbabf502008-06-06 00:02:02 +000067
68
mblighe8819cd2008-02-15 16:48:40 +000069def get_labels(**filter_data):
showardc92da832009-04-07 18:14:34 +000070 """\
71 @returns A sequence of nested dictionaries of label information.
72 """
73 return rpc_utils.prepare_rows_as_nested_dicts(
74 models.Label.query_objects(filter_data),
75 ('atomic_group',))
76
77
78# atomic groups
79
showarde9450c92009-06-30 01:58:52 +000080def add_atomic_group(name, max_number_of_machines=None, description=None):
showardc92da832009-04-07 18:14:34 +000081 return models.AtomicGroup.add_object(
82 name=name, max_number_of_machines=max_number_of_machines,
83 description=description).id
84
85
86def modify_atomic_group(id, **data):
87 models.AtomicGroup.smart_get(id).update_object(data)
88
89
90def delete_atomic_group(id):
91 models.AtomicGroup.smart_get(id).delete()
92
93
94def atomic_group_add_labels(id, labels):
95 label_objs = models.Label.smart_get_bulk(labels)
96 models.AtomicGroup.smart_get(id).label_set.add(*label_objs)
97
98
99def atomic_group_remove_labels(id, labels):
100 label_objs = models.Label.smart_get_bulk(labels)
101 models.AtomicGroup.smart_get(id).label_set.remove(*label_objs)
102
103
104def get_atomic_groups(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000105 return rpc_utils.prepare_for_serialization(
showardc92da832009-04-07 18:14:34 +0000106 models.AtomicGroup.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000107
108
109# hosts
110
showarddf062562008-07-03 19:56:37 +0000111def add_host(hostname, status=None, locked=None, protection=None):
jadmanski0afbb632008-06-06 21:10:57 +0000112 return models.Host.add_object(hostname=hostname, status=status,
showarddf062562008-07-03 19:56:37 +0000113 locked=locked, protection=protection).id
mblighe8819cd2008-02-15 16:48:40 +0000114
115
116def modify_host(id, **data):
showardbe0d8692009-08-20 23:42:44 +0000117 rpc_utils.check_modify_host(data)
showardce7c0922009-09-11 18:39:24 +0000118 host = models.Host.smart_get(id)
119 rpc_utils.check_modify_host_locking(host, data)
120 host.update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000121
122
showard276f9442009-05-20 00:33:16 +0000123def modify_hosts(host_filter_data, update_data):
124 """
showardbe0d8692009-08-20 23:42:44 +0000125 @param host_filter_data: Filters out which hosts to modify.
126 @param update_data: A dictionary with the changes to make to the hosts.
showard276f9442009-05-20 00:33:16 +0000127 """
showardbe0d8692009-08-20 23:42:44 +0000128 rpc_utils.check_modify_host(update_data)
showard276f9442009-05-20 00:33:16 +0000129 hosts = models.Host.query_objects(host_filter_data)
130 for host in hosts:
131 host.update_object(update_data)
132
133
mblighe8819cd2008-02-15 16:48:40 +0000134def host_add_labels(id, labels):
showardbe3ec042008-11-12 18:16:07 +0000135 labels = models.Label.smart_get_bulk(labels)
showardcafd16e2009-05-29 18:37:49 +0000136 host = models.Host.smart_get(id)
137
138 platforms = [label.name for label in labels if label.platform]
139 if len(platforms) > 1:
140 raise model_logic.ValidationError(
141 {'labels': 'Adding more than one platform label: %s' %
142 ', '.join(platforms)})
143 if len(platforms) == 1:
144 models.Host.check_no_platform([host])
145 host.labels.add(*labels)
mblighe8819cd2008-02-15 16:48:40 +0000146
147
148def host_remove_labels(id, labels):
showardbe3ec042008-11-12 18:16:07 +0000149 labels = models.Label.smart_get_bulk(labels)
jadmanski0afbb632008-06-06 21:10:57 +0000150 models.Host.smart_get(id).labels.remove(*labels)
mblighe8819cd2008-02-15 16:48:40 +0000151
152
showard0957a842009-05-11 19:25:08 +0000153def set_host_attribute(attribute, value, **host_filter_data):
154 """
155 @param attribute string name of attribute
156 @param value string, or None to delete an attribute
157 @param host_filter_data filter data to apply to Hosts to choose hosts to act
158 upon
159 """
160 assert host_filter_data # disallow accidental actions on all hosts
161 hosts = models.Host.query_objects(host_filter_data)
162 models.AclGroup.check_for_acl_violation_hosts(hosts)
163
164 for host in hosts:
showardf8b19042009-05-12 17:22:49 +0000165 host.set_or_delete_attribute(attribute, value)
showard0957a842009-05-11 19:25:08 +0000166
167
mblighe8819cd2008-02-15 16:48:40 +0000168def delete_host(id):
jadmanski0afbb632008-06-06 21:10:57 +0000169 models.Host.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000170
171
showard87cc38f2009-08-20 23:37:04 +0000172def get_hosts(multiple_labels=(), exclude_only_if_needed_labels=False,
173 exclude_atomic_group_hosts=False, **filter_data):
174 """
175 @param multiple_labels: match hosts in all of the labels given. Should
176 be a list of label names.
177 @param exclude_only_if_needed_labels: Exclude hosts with at least one
178 "only_if_needed" label applied.
179 @param exclude_atomic_group_hosts: Exclude hosts that have one or more
180 atomic group labels associated with them.
jadmanski0afbb632008-06-06 21:10:57 +0000181 """
showard43a3d262008-11-12 18:17:05 +0000182 hosts = rpc_utils.get_host_query(multiple_labels,
183 exclude_only_if_needed_labels,
showard87cc38f2009-08-20 23:37:04 +0000184 exclude_atomic_group_hosts,
showard43a3d262008-11-12 18:17:05 +0000185 filter_data)
showard0957a842009-05-11 19:25:08 +0000186 hosts = list(hosts)
187 models.Host.objects.populate_relationships(hosts, models.Label,
188 'label_list')
189 models.Host.objects.populate_relationships(hosts, models.AclGroup,
190 'acl_list')
191 models.Host.objects.populate_relationships(hosts, models.HostAttribute,
192 'attribute_list')
showard43a3d262008-11-12 18:17:05 +0000193 host_dicts = []
194 for host_obj in hosts:
195 host_dict = host_obj.get_object_dict()
showard0957a842009-05-11 19:25:08 +0000196 host_dict['labels'] = [label.name for label in host_obj.label_list]
showard909c9142009-07-07 20:54:42 +0000197 host_dict['platform'], host_dict['atomic_group'] = (rpc_utils.
198 find_platform_and_atomic_group(host_obj))
showard0957a842009-05-11 19:25:08 +0000199 host_dict['acls'] = [acl.name for acl in host_obj.acl_list]
200 host_dict['attributes'] = dict((attribute.attribute, attribute.value)
201 for attribute in host_obj.attribute_list)
showard43a3d262008-11-12 18:17:05 +0000202 host_dicts.append(host_dict)
203 return rpc_utils.prepare_for_serialization(host_dicts)
mblighe8819cd2008-02-15 16:48:40 +0000204
205
showard87cc38f2009-08-20 23:37:04 +0000206def get_num_hosts(multiple_labels=(), exclude_only_if_needed_labels=False,
207 exclude_atomic_group_hosts=False, **filter_data):
208 """
209 Same parameters as get_hosts().
210
211 @returns The number of matching hosts.
212 """
showard43a3d262008-11-12 18:17:05 +0000213 hosts = rpc_utils.get_host_query(multiple_labels,
214 exclude_only_if_needed_labels,
showard87cc38f2009-08-20 23:37:04 +0000215 exclude_atomic_group_hosts,
showard43a3d262008-11-12 18:17:05 +0000216 filter_data)
217 return hosts.count()
showard1385b162008-03-13 15:59:40 +0000218
mblighe8819cd2008-02-15 16:48:40 +0000219
220# tests
221
showard909c7a62008-07-15 21:52:38 +0000222def add_test(name, test_type, path, author=None, dependencies=None,
showard3d9899a2008-07-31 02:11:58 +0000223 experimental=True, run_verify=None, test_class=None,
showard909c7a62008-07-15 21:52:38 +0000224 test_time=None, test_category=None, description=None,
225 sync_count=1):
jadmanski0afbb632008-06-06 21:10:57 +0000226 return models.Test.add_object(name=name, test_type=test_type, path=path,
showard909c7a62008-07-15 21:52:38 +0000227 author=author, dependencies=dependencies,
228 experimental=experimental,
229 run_verify=run_verify, test_time=test_time,
230 test_category=test_category,
231 sync_count=sync_count,
jadmanski0afbb632008-06-06 21:10:57 +0000232 test_class=test_class,
233 description=description).id
mblighe8819cd2008-02-15 16:48:40 +0000234
235
236def modify_test(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +0000237 models.Test.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000238
239
240def delete_test(id):
jadmanski0afbb632008-06-06 21:10:57 +0000241 models.Test.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000242
243
244def get_tests(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000245 return rpc_utils.prepare_for_serialization(
246 models.Test.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000247
248
showard2b9a88b2008-06-13 20:55:03 +0000249# profilers
250
251def add_profiler(name, description=None):
252 return models.Profiler.add_object(name=name, description=description).id
253
254
255def modify_profiler(id, **data):
256 models.Profiler.smart_get(id).update_object(data)
257
258
259def delete_profiler(id):
260 models.Profiler.smart_get(id).delete()
261
262
263def get_profilers(**filter_data):
264 return rpc_utils.prepare_for_serialization(
265 models.Profiler.list_objects(filter_data))
266
267
mblighe8819cd2008-02-15 16:48:40 +0000268# users
269
270def add_user(login, access_level=None):
jadmanski0afbb632008-06-06 21:10:57 +0000271 return models.User.add_object(login=login, access_level=access_level).id
mblighe8819cd2008-02-15 16:48:40 +0000272
273
274def modify_user(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +0000275 models.User.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000276
277
278def delete_user(id):
jadmanski0afbb632008-06-06 21:10:57 +0000279 models.User.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000280
281
282def get_users(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000283 return rpc_utils.prepare_for_serialization(
284 models.User.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000285
286
287# acl groups
288
289def add_acl_group(name, description=None):
showard04f2cd82008-07-25 20:53:31 +0000290 group = models.AclGroup.add_object(name=name, description=description)
291 group.users.add(thread_local.get_user())
292 return group.id
mblighe8819cd2008-02-15 16:48:40 +0000293
294
295def modify_acl_group(id, **data):
showard04f2cd82008-07-25 20:53:31 +0000296 group = models.AclGroup.smart_get(id)
297 group.check_for_acl_violation_acl_group()
298 group.update_object(data)
299 group.add_current_user_if_empty()
mblighe8819cd2008-02-15 16:48:40 +0000300
301
302def acl_group_add_users(id, users):
jadmanski0afbb632008-06-06 21:10:57 +0000303 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000304 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000305 users = models.User.smart_get_bulk(users)
jadmanski0afbb632008-06-06 21:10:57 +0000306 group.users.add(*users)
mblighe8819cd2008-02-15 16:48:40 +0000307
308
309def acl_group_remove_users(id, users):
jadmanski0afbb632008-06-06 21:10:57 +0000310 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000311 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000312 users = models.User.smart_get_bulk(users)
jadmanski0afbb632008-06-06 21:10:57 +0000313 group.users.remove(*users)
showard04f2cd82008-07-25 20:53:31 +0000314 group.add_current_user_if_empty()
mblighe8819cd2008-02-15 16:48:40 +0000315
316
317def acl_group_add_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +0000318 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000319 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000320 hosts = models.Host.smart_get_bulk(hosts)
jadmanski0afbb632008-06-06 21:10:57 +0000321 group.hosts.add(*hosts)
showard08f981b2008-06-24 21:59:03 +0000322 group.on_host_membership_change()
mblighe8819cd2008-02-15 16:48:40 +0000323
324
325def acl_group_remove_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +0000326 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000327 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000328 hosts = models.Host.smart_get_bulk(hosts)
jadmanski0afbb632008-06-06 21:10:57 +0000329 group.hosts.remove(*hosts)
showard08f981b2008-06-24 21:59:03 +0000330 group.on_host_membership_change()
mblighe8819cd2008-02-15 16:48:40 +0000331
332
333def delete_acl_group(id):
jadmanski0afbb632008-06-06 21:10:57 +0000334 models.AclGroup.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000335
336
337def get_acl_groups(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000338 acl_groups = models.AclGroup.list_objects(filter_data)
339 for acl_group in acl_groups:
340 acl_group_obj = models.AclGroup.objects.get(id=acl_group['id'])
341 acl_group['users'] = [user.login
342 for user in acl_group_obj.users.all()]
343 acl_group['hosts'] = [host.hostname
344 for host in acl_group_obj.hosts.all()]
345 return rpc_utils.prepare_for_serialization(acl_groups)
mblighe8819cd2008-02-15 16:48:40 +0000346
347
348# jobs
349
mbligh120351e2009-01-24 01:40:45 +0000350def generate_control_file(tests=(), kernel=None, label=None, profilers=(),
351 client_control_file='', use_container=False):
jadmanski0afbb632008-06-06 21:10:57 +0000352 """
mbligh120351e2009-01-24 01:40:45 +0000353 Generates a client-side control file to load a kernel and run tests.
354
355 @param tests List of tests to run.
mbligha3c58d22009-08-24 22:01:51 +0000356 @param kernel A list of kernel info dictionaries configuring which kernels
357 to boot for this job and other options for them
mbligh120351e2009-01-24 01:40:45 +0000358 @param label Name of label to grab kernel config from.
359 @param profilers List of profilers to activate during the job.
360 @param client_control_file The contents of a client-side control file to
361 run at the end of all tests. If this is supplied, all tests must be
362 client side.
363 TODO: in the future we should support server control files directly
364 to wrap with a kernel. That'll require changing the parameter
365 name and adding a boolean to indicate if it is a client or server
366 control file.
367 @param use_container unused argument today. TODO: Enable containers
368 on the host during a client side test.
369
370 @returns a dict with the following keys:
371 control_file: str, The control file text.
372 is_server: bool, is the control file a server-side control file?
373 synch_count: How many machines the job uses per autoserv execution.
374 synch_count == 1 means the job is asynchronous.
375 dependencies: A list of the names of labels on which the job depends.
376 """
showardd86debe2009-06-10 17:37:56 +0000377 if not tests and not client_control_file:
showard2bab8f42008-11-12 18:15:22 +0000378 return dict(control_file='', is_server=False, synch_count=1,
showard989f25d2008-10-01 11:38:11 +0000379 dependencies=[])
mblighe8819cd2008-02-15 16:48:40 +0000380
showard989f25d2008-10-01 11:38:11 +0000381 cf_info, test_objects, profiler_objects, label = (
showard2b9a88b2008-06-13 20:55:03 +0000382 rpc_utils.prepare_generate_control_file(tests, kernel, label,
383 profilers))
showard989f25d2008-10-01 11:38:11 +0000384 cf_info['control_file'] = control_file.generate_control(
mbligha3c58d22009-08-24 22:01:51 +0000385 tests=test_objects, kernels=kernel, platform=label,
mbligh120351e2009-01-24 01:40:45 +0000386 profilers=profiler_objects, is_server=cf_info['is_server'],
387 client_control_file=client_control_file)
showard989f25d2008-10-01 11:38:11 +0000388 return cf_info
mblighe8819cd2008-02-15 16:48:40 +0000389
390
showard12f3e322009-05-13 21:27:42 +0000391def create_job(name, priority, control_file, control_type,
392 hosts=(), meta_hosts=(), one_time_hosts=(),
393 atomic_group_name=None, synch_count=None, is_template=False,
394 timeout=None, max_runtime_hrs=None, run_verify=True,
395 email_list='', dependencies=(), reboot_before=None,
396 reboot_after=None, parse_failed_repair=None):
jadmanski0afbb632008-06-06 21:10:57 +0000397 """\
398 Create and enqueue a job.
mblighe8819cd2008-02-15 16:48:40 +0000399
showarda1e74b32009-05-12 17:32:04 +0000400 @param name name of this job
401 @param priority Low, Medium, High, Urgent
402 @param control_file String contents of the control file.
403 @param control_type Type of control file, Client or Server.
404 @param synch_count How many machines the job uses per autoserv execution.
405 synch_count == 1 means the job is asynchronous. If an atomic group is
406 given this value is treated as a minimum.
407 @param is_template If true then create a template job.
408 @param timeout Hours after this call returns until the job times out.
showard12f3e322009-05-13 21:27:42 +0000409 @param max_runtime_hrs Hours from job starting time until job times out
showarda1e74b32009-05-12 17:32:04 +0000410 @param run_verify Should the host be verified before running the test?
411 @param email_list String containing emails to mail when the job is done
412 @param dependencies List of label names on which this job depends
413 @param reboot_before Never, If dirty, or Always
414 @param reboot_after Never, If all tests passed, or Always
415 @param parse_failed_repair if true, results of failed repairs launched by
416 this job will be parsed as part of the job.
417
418 @param hosts List of hosts to run job on.
419 @param meta_hosts List where each entry is a label name, and for each entry
420 one host will be chosen from that label to run the job on.
421 @param one_time_hosts List of hosts not in the database to run the job on.
422 @param atomic_group_name The name of an atomic group to schedule the job on.
423
showardc92da832009-04-07 18:14:34 +0000424
425 @returns The created Job id number.
jadmanski0afbb632008-06-06 21:10:57 +0000426 """
showard87658162009-05-29 18:39:50 +0000427 user = thread_local.get_user()
428 owner = user.login
jadmanski0afbb632008-06-06 21:10:57 +0000429 # input validation
showardc92da832009-04-07 18:14:34 +0000430 if not (hosts or meta_hosts or one_time_hosts or atomic_group_name):
mblighec5546d2008-06-16 16:51:28 +0000431 raise model_logic.ValidationError({
showardb8471e32008-07-03 19:51:08 +0000432 'arguments' : "You must pass at least one of 'hosts', "
showardc92da832009-04-07 18:14:34 +0000433 "'meta_hosts', 'one_time_hosts', "
434 "or 'atomic_group_name'"
jadmanski0afbb632008-06-06 21:10:57 +0000435 })
mblighe8819cd2008-02-15 16:48:40 +0000436
showardbc93f0f2009-06-10 00:16:21 +0000437 labels_by_name = dict((label.name, label)
438 for label in models.Label.objects.all())
439 atomic_groups_by_name = dict((ag.name, ag)
440 for ag in models.AtomicGroup.objects.all())
441
showardc8730322009-06-30 01:56:38 +0000442 # Schedule on an atomic group automagically if one of the labels given
443 # is an atomic group label and no explicit atomic_group_name was supplied.
444 if not atomic_group_name:
445 for label_name in meta_hosts or []:
446 label = labels_by_name.get(label_name)
447 if label and label.atomic_group:
448 atomic_group_name = label.atomic_group.name
449 break
450
showardbc93f0f2009-06-10 00:16:21 +0000451 # convert hostnames & meta hosts to host/label objects
452 host_objects = models.Host.smart_get_bulk(hosts)
453 metahost_objects = []
showardc8730322009-06-30 01:56:38 +0000454 for label_name in meta_hosts or []:
455 if label_name in labels_by_name:
456 label = labels_by_name[label_name]
457 metahost_objects.append(label)
458 elif label_name in atomic_groups_by_name:
459 # If given a metahost name that isn't a Label, check to
460 # see if the user was specifying an Atomic Group instead.
461 atomic_group = atomic_groups_by_name[label_name]
showardbc93f0f2009-06-10 00:16:21 +0000462 if atomic_group_name and atomic_group_name != atomic_group.name:
463 raise model_logic.ValidationError({
464 'meta_hosts': (
465 'Label "%s" not found. If assumed to be an '
466 'atomic group it would conflict with the '
467 'supplied atomic group "%s".' % (
showardc8730322009-06-30 01:56:38 +0000468 label_name, atomic_group_name))})
showardbc93f0f2009-06-10 00:16:21 +0000469 atomic_group_name = atomic_group.name
470 else:
471 raise model_logic.ValidationError(
472 {'meta_hosts' : 'Label "%s" not found' % label})
473
showardc92da832009-04-07 18:14:34 +0000474 # Create and sanity check an AtomicGroup object if requested.
475 if atomic_group_name:
476 if one_time_hosts:
477 raise model_logic.ValidationError(
478 {'one_time_hosts':
479 'One time hosts cannot be used with an Atomic Group.'})
480 atomic_group = models.AtomicGroup.smart_get(atomic_group_name)
481 if synch_count and synch_count > atomic_group.max_number_of_machines:
482 raise model_logic.ValidationError(
483 {'atomic_group_name' :
484 'You have requested a synch_count (%d) greater than the '
485 'maximum machines in the requested Atomic Group (%d).' %
486 (synch_count, atomic_group.max_number_of_machines)})
487 else:
488 atomic_group = None
489
showardb8471e32008-07-03 19:51:08 +0000490 for host in one_time_hosts or []:
491 this_host = models.Host.create_one_time_host(host)
492 host_objects.append(this_host)
showardba872902008-06-28 00:51:08 +0000493
showard87658162009-05-29 18:39:50 +0000494 if reboot_before is None:
495 reboot_before = user.get_reboot_before_display()
496 if reboot_after is None:
497 reboot_after = user.get_reboot_after_display()
498
showarda1e74b32009-05-12 17:32:04 +0000499 options = dict(name=name,
500 priority=priority,
501 control_file=control_file,
502 control_type=control_type,
503 is_template=is_template,
504 timeout=timeout,
showard12f3e322009-05-13 21:27:42 +0000505 max_runtime_hrs=max_runtime_hrs,
showarda1e74b32009-05-12 17:32:04 +0000506 synch_count=synch_count,
507 run_verify=run_verify,
508 email_list=email_list,
509 dependencies=dependencies,
510 reboot_before=reboot_before,
511 reboot_after=reboot_after,
512 parse_failed_repair=parse_failed_repair)
showard29f7cd22009-04-29 21:16:24 +0000513 return rpc_utils.create_new_job(owner=owner,
showarda1e74b32009-05-12 17:32:04 +0000514 options=options,
showard29f7cd22009-04-29 21:16:24 +0000515 host_objects=host_objects,
516 metahost_objects=metahost_objects,
showard29f7cd22009-04-29 21:16:24 +0000517 atomic_group=atomic_group)
mblighe8819cd2008-02-15 16:48:40 +0000518
519
showard9dbdcda2008-10-14 17:34:36 +0000520def abort_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000521 """\
showard9dbdcda2008-10-14 17:34:36 +0000522 Abort a set of host queue entries.
jadmanski0afbb632008-06-06 21:10:57 +0000523 """
showard9dbdcda2008-10-14 17:34:36 +0000524 query = models.HostQueueEntry.query_objects(filter_data)
showard0c185192009-01-16 03:07:57 +0000525 query = query.filter(complete=False)
showarddc817512008-11-12 18:16:41 +0000526 models.AclGroup.check_abort_permissions(query)
showard9dbdcda2008-10-14 17:34:36 +0000527 host_queue_entries = list(query.select_related())
showard2bab8f42008-11-12 18:15:22 +0000528 rpc_utils.check_abort_synchronous_jobs(host_queue_entries)
mblighe8819cd2008-02-15 16:48:40 +0000529
showard9dbdcda2008-10-14 17:34:36 +0000530 user = thread_local.get_user()
531 for queue_entry in host_queue_entries:
532 queue_entry.abort(user)
showard9d821ab2008-07-11 16:54:29 +0000533
534
showard1ff7b2e2009-05-15 23:17:18 +0000535def reverify_hosts(**filter_data):
536 """\
537 Schedules a set of hosts for verify.
538 """
539 hosts = models.Host.query_objects(filter_data)
540 models.AclGroup.check_for_acl_violation_hosts(hosts)
showard6d7b2ff2009-06-10 00:16:47 +0000541 models.SpecialTask.schedule_special_task(hosts,
showard2fe3f1d2009-07-06 20:19:11 +0000542 models.SpecialTask.Task.VERIFY)
showard1ff7b2e2009-05-15 23:17:18 +0000543
544
mblighe8819cd2008-02-15 16:48:40 +0000545def get_jobs(not_yet_run=False, running=False, finished=False, **filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000546 """\
547 Extra filter args for get_jobs:
548 -not_yet_run: Include only jobs that have not yet started running.
549 -running: Include only jobs that have start running but for which not
550 all hosts have completed.
551 -finished: Include only jobs for which all hosts have completed (or
552 aborted).
553 At most one of these three fields should be specified.
554 """
555 filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run,
556 running,
557 finished)
showard0957a842009-05-11 19:25:08 +0000558 job_dicts = []
559 jobs = list(models.Job.query_objects(filter_data))
560 models.Job.objects.populate_relationships(jobs, models.Label,
561 'dependencies')
562 for job in jobs:
563 job_dict = job.get_object_dict()
564 job_dict['dependencies'] = ','.join(label.name
565 for label in job.dependencies)
566 job_dicts.append(job_dict)
567 return rpc_utils.prepare_for_serialization(job_dicts)
mblighe8819cd2008-02-15 16:48:40 +0000568
569
570def get_num_jobs(not_yet_run=False, running=False, finished=False,
jadmanski0afbb632008-06-06 21:10:57 +0000571 **filter_data):
572 """\
573 See get_jobs() for documentation of extra filter parameters.
574 """
575 filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run,
576 running,
577 finished)
578 return models.Job.query_count(filter_data)
mblighe8819cd2008-02-15 16:48:40 +0000579
580
mblighe8819cd2008-02-15 16:48:40 +0000581def get_jobs_summary(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000582 """\
showarda8709c52008-07-03 19:44:54 +0000583 Like get_jobs(), but adds a 'status_counts' field, which is a dictionary
jadmanski0afbb632008-06-06 21:10:57 +0000584 mapping status strings to the number of hosts currently with that
585 status, i.e. {'Queued' : 4, 'Running' : 2}.
586 """
587 jobs = get_jobs(**filter_data)
588 ids = [job['id'] for job in jobs]
589 all_status_counts = models.Job.objects.get_status_counts(ids)
590 for job in jobs:
591 job['status_counts'] = all_status_counts[job['id']]
592 return rpc_utils.prepare_for_serialization(jobs)
mblighe8819cd2008-02-15 16:48:40 +0000593
594
showarda965cef2009-05-15 23:17:41 +0000595def get_info_for_clone(id, preserve_metahosts, queue_entry_filter_data=None):
showarda8709c52008-07-03 19:44:54 +0000596 """\
597 Retrieves all the information needed to clone a job.
598 """
showarda8709c52008-07-03 19:44:54 +0000599 job = models.Job.objects.get(id=id)
showard29f7cd22009-04-29 21:16:24 +0000600 job_info = rpc_utils.get_job_info(job,
showarda965cef2009-05-15 23:17:41 +0000601 preserve_metahosts,
602 queue_entry_filter_data)
showard945072f2008-09-03 20:34:59 +0000603
showardd9992fe2008-07-31 02:15:03 +0000604 host_dicts = []
showard29f7cd22009-04-29 21:16:24 +0000605 for host in job_info['hosts']:
606 host_dict = get_hosts(id=host.id)[0]
607 other_labels = host_dict['labels']
608 if host_dict['platform']:
609 other_labels.remove(host_dict['platform'])
610 host_dict['other_labels'] = ', '.join(other_labels)
showardd9992fe2008-07-31 02:15:03 +0000611 host_dicts.append(host_dict)
showarda8709c52008-07-03 19:44:54 +0000612
showard29f7cd22009-04-29 21:16:24 +0000613 for host in job_info['one_time_hosts']:
614 host_dict = dict(hostname=host.hostname,
615 id=host.id,
616 platform='(one-time host)',
617 locked_text='')
618 host_dicts.append(host_dict)
showarda8709c52008-07-03 19:44:54 +0000619
showard4d077562009-05-08 18:24:36 +0000620 # convert keys from Label objects to strings (names of labels)
showard29f7cd22009-04-29 21:16:24 +0000621 meta_host_counts = dict((meta_host.name, count) for meta_host, count
showard4d077562009-05-08 18:24:36 +0000622 in job_info['meta_host_counts'].iteritems())
showard29f7cd22009-04-29 21:16:24 +0000623
624 info = dict(job=job.get_object_dict(),
625 meta_host_counts=meta_host_counts,
626 hosts=host_dicts)
627 info['job']['dependencies'] = job_info['dependencies']
628 if job_info['atomic_group']:
629 info['atomic_group_name'] = (job_info['atomic_group']).name
630 else:
631 info['atomic_group_name'] = None
showarda8709c52008-07-03 19:44:54 +0000632
633 return rpc_utils.prepare_for_serialization(info)
634
635
showard34dc5fa2008-04-24 20:58:40 +0000636# host queue entries
637
638def get_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000639 """\
showardc92da832009-04-07 18:14:34 +0000640 @returns A sequence of nested dictionaries of host and job information.
jadmanski0afbb632008-06-06 21:10:57 +0000641 """
showardc92da832009-04-07 18:14:34 +0000642 return rpc_utils.prepare_rows_as_nested_dicts(
643 models.HostQueueEntry.query_objects(filter_data),
644 ('host', 'atomic_group', 'job'))
showard34dc5fa2008-04-24 20:58:40 +0000645
646
647def get_num_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000648 """\
649 Get the number of host queue entries associated with this job.
650 """
651 return models.HostQueueEntry.query_count(filter_data)
showard34dc5fa2008-04-24 20:58:40 +0000652
653
showard1e935f12008-07-11 00:11:36 +0000654def get_hqe_percentage_complete(**filter_data):
655 """
showardc92da832009-04-07 18:14:34 +0000656 Computes the fraction of host queue entries matching the given filter data
showard1e935f12008-07-11 00:11:36 +0000657 that are complete.
658 """
659 query = models.HostQueueEntry.query_objects(filter_data)
660 complete_count = query.filter(complete=True).count()
661 total_count = query.count()
662 if total_count == 0:
663 return 1
664 return float(complete_count) / total_count
665
666
showard1a5a4082009-07-28 20:01:37 +0000667# special tasks
668
669def get_special_tasks(**filter_data):
670 return rpc_utils.prepare_rows_as_nested_dicts(
671 models.SpecialTask.query_objects(filter_data),
672 ('host', 'queue_entry'))
673
674
showardc0ac3a72009-07-08 21:14:45 +0000675# support for host detail view
676
677def get_host_queue_entries_and_special_tasks(hostname, query_start=None,
678 query_limit=None):
679 """
680 @returns an interleaved list of HostQueueEntries and SpecialTasks,
681 in approximate run order. each dict contains keys for type, host,
682 job, status, started_on, execution_path, and ID.
683 """
684 total_limit = None
685 if query_limit is not None:
686 total_limit = query_start + query_limit
687 filter_data = {'host__hostname': hostname,
688 'query_limit': total_limit,
689 'sort_by': ['-id']}
690
691 queue_entries = list(models.HostQueueEntry.query_objects(filter_data))
692 special_tasks = list(models.SpecialTask.query_objects(filter_data))
693
694 interleaved_entries = rpc_utils.interleave_entries(queue_entries,
695 special_tasks)
696 if query_start is not None:
697 interleaved_entries = interleaved_entries[query_start:]
698 if query_limit is not None:
699 interleaved_entries = interleaved_entries[:query_limit]
700 return rpc_utils.prepare_for_serialization(interleaved_entries)
701
702
703def get_num_host_queue_entries_and_special_tasks(hostname):
704 filter_data = {'host__hostname': hostname}
705 return (models.HostQueueEntry.query_count(filter_data)
706 + models.SpecialTask.query_count(filter_data))
707
708
showard29f7cd22009-04-29 21:16:24 +0000709# recurring run
710
711def get_recurring(**filter_data):
712 return rpc_utils.prepare_rows_as_nested_dicts(
713 models.RecurringRun.query_objects(filter_data),
714 ('job', 'owner'))
715
716
717def get_num_recurring(**filter_data):
718 return models.RecurringRun.query_count(filter_data)
719
720
721def delete_recurring_runs(**filter_data):
722 to_delete = models.RecurringRun.query_objects(filter_data)
723 to_delete.delete()
724
725
726def create_recurring_run(job_id, start_date, loop_period, loop_count):
727 owner = thread_local.get_user().login
728 job = models.Job.objects.get(id=job_id)
729 return job.create_recurring_job(start_date=start_date,
730 loop_period=loop_period,
731 loop_count=loop_count,
732 owner=owner)
733
734
mblighe8819cd2008-02-15 16:48:40 +0000735# other
736
showarde0b63622008-08-04 20:58:47 +0000737def echo(data=""):
738 """\
739 Returns a passed in string. For doing a basic test to see if RPC calls
740 can successfully be made.
741 """
742 return data
743
744
showardb7a52fd2009-04-27 20:10:56 +0000745def get_motd():
746 """\
747 Returns the message of the day as a string.
748 """
749 return rpc_utils.get_motd()
750
751
mblighe8819cd2008-02-15 16:48:40 +0000752def get_static_data():
jadmanski0afbb632008-06-06 21:10:57 +0000753 """\
754 Returns a dictionary containing a bunch of data that shouldn't change
755 often and is otherwise inaccessible. This includes:
showardc92da832009-04-07 18:14:34 +0000756
757 priorities: List of job priority choices.
758 default_priority: Default priority value for new jobs.
759 users: Sorted list of all users.
760 labels: Sorted list of all labels.
761 atomic_groups: Sorted list of all atomic groups.
762 tests: Sorted list of all tests.
763 profilers: Sorted list of all profilers.
764 current_user: Logged-in username.
765 host_statuses: Sorted list of possible Host statuses.
766 job_statuses: Sorted list of possible HostQueueEntry statuses.
767 job_timeout_default: The default job timeout length in hours.
showarda1e74b32009-05-12 17:32:04 +0000768 parse_failed_repair_default: Default value for the parse_failed_repair job
769 option.
showardc92da832009-04-07 18:14:34 +0000770 reboot_before_options: A list of valid RebootBefore string enums.
771 reboot_after_options: A list of valid RebootAfter string enums.
772 motd: Server's message of the day.
773 status_dictionary: A mapping from one word job status names to a more
774 informative description.
jadmanski0afbb632008-06-06 21:10:57 +0000775 """
showard21baa452008-10-21 00:08:39 +0000776
777 job_fields = models.Job.get_field_dict()
778
jadmanski0afbb632008-06-06 21:10:57 +0000779 result = {}
780 result['priorities'] = models.Job.Priority.choices()
showard21baa452008-10-21 00:08:39 +0000781 default_priority = job_fields['priority'].default
jadmanski0afbb632008-06-06 21:10:57 +0000782 default_string = models.Job.Priority.get_string(default_priority)
783 result['default_priority'] = default_string
784 result['users'] = get_users(sort_by=['login'])
785 result['labels'] = get_labels(sort_by=['-platform', 'name'])
showardc92da832009-04-07 18:14:34 +0000786 result['atomic_groups'] = get_atomic_groups(sort_by=['name'])
jadmanski0afbb632008-06-06 21:10:57 +0000787 result['tests'] = get_tests(sort_by=['name'])
showard2b9a88b2008-06-13 20:55:03 +0000788 result['profilers'] = get_profilers(sort_by=['name'])
showard0fc38302008-10-23 00:44:07 +0000789 result['current_user'] = rpc_utils.prepare_for_serialization(
790 thread_local.get_user().get_object_dict())
showard2b9a88b2008-06-13 20:55:03 +0000791 result['host_statuses'] = sorted(models.Host.Status.names)
mbligh5a198b92008-12-11 19:33:29 +0000792 result['job_statuses'] = sorted(models.HostQueueEntry.Status.names)
showardb1e51872008-10-07 11:08:18 +0000793 result['job_timeout_default'] = models.Job.DEFAULT_TIMEOUT
showard12f3e322009-05-13 21:27:42 +0000794 result['job_max_runtime_hrs_default'] = models.Job.DEFAULT_MAX_RUNTIME_HRS
showarda1e74b32009-05-12 17:32:04 +0000795 result['parse_failed_repair_default'] = bool(
796 models.Job.DEFAULT_PARSE_FAILED_REPAIR)
showard0fc38302008-10-23 00:44:07 +0000797 result['reboot_before_options'] = models.RebootBefore.names
798 result['reboot_after_options'] = models.RebootAfter.names
showard8fbae652009-01-20 23:23:10 +0000799 result['motd'] = rpc_utils.get_motd()
showard8ac29b42008-07-17 17:01:55 +0000800
showardd3dc1992009-04-22 21:01:40 +0000801 result['status_dictionary'] = {"Aborted": "Aborted",
showard8ac29b42008-07-17 17:01:55 +0000802 "Verifying": "Verifying Host",
803 "Pending": "Waiting on other hosts",
804 "Running": "Running autoserv",
805 "Completed": "Autoserv completed",
806 "Failed": "Failed to complete",
showardd823b362008-07-24 16:35:46 +0000807 "Queued": "Queued",
showard5deb6772008-11-04 21:54:33 +0000808 "Starting": "Next in host's queue",
809 "Stopped": "Other host(s) failed verify",
showardd3dc1992009-04-22 21:01:40 +0000810 "Parsing": "Awaiting parse of final results",
showard29f7cd22009-04-29 21:16:24 +0000811 "Gathering": "Gathering log files",
showard8cc058f2009-09-08 16:26:33 +0000812 "Template": "Template job for recurring run",
813 "Waiting": "Waiting for scheduler action"}
jadmanski0afbb632008-06-06 21:10:57 +0000814 return result
showard29f7cd22009-04-29 21:16:24 +0000815
816
817def get_server_time():
818 return datetime.datetime.now().strftime("%Y-%m-%d %H:%M")