blob: 5712f0e68bc0c604cd658842486691fc6afc5f26 [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):
jadmanski0afbb632008-06-06 21:10:57 +0000117 models.Host.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000118
119
showard276f9442009-05-20 00:33:16 +0000120def modify_hosts(host_filter_data, update_data):
121 """
122 @param host_filter_data filters out which hosts to modify
123 @param update_data dictionary with the changes to make to the hosts
124 """
125 hosts = models.Host.query_objects(host_filter_data)
126 for host in hosts:
127 host.update_object(update_data)
128
129
mblighe8819cd2008-02-15 16:48:40 +0000130def host_add_labels(id, labels):
showardbe3ec042008-11-12 18:16:07 +0000131 labels = models.Label.smart_get_bulk(labels)
showardcafd16e2009-05-29 18:37:49 +0000132 host = models.Host.smart_get(id)
133
134 platforms = [label.name for label in labels if label.platform]
135 if len(platforms) > 1:
136 raise model_logic.ValidationError(
137 {'labels': 'Adding more than one platform label: %s' %
138 ', '.join(platforms)})
139 if len(platforms) == 1:
140 models.Host.check_no_platform([host])
141 host.labels.add(*labels)
mblighe8819cd2008-02-15 16:48:40 +0000142
143
144def host_remove_labels(id, labels):
showardbe3ec042008-11-12 18:16:07 +0000145 labels = models.Label.smart_get_bulk(labels)
jadmanski0afbb632008-06-06 21:10:57 +0000146 models.Host.smart_get(id).labels.remove(*labels)
mblighe8819cd2008-02-15 16:48:40 +0000147
148
showard0957a842009-05-11 19:25:08 +0000149def set_host_attribute(attribute, value, **host_filter_data):
150 """
151 @param attribute string name of attribute
152 @param value string, or None to delete an attribute
153 @param host_filter_data filter data to apply to Hosts to choose hosts to act
154 upon
155 """
156 assert host_filter_data # disallow accidental actions on all hosts
157 hosts = models.Host.query_objects(host_filter_data)
158 models.AclGroup.check_for_acl_violation_hosts(hosts)
159
160 for host in hosts:
showardf8b19042009-05-12 17:22:49 +0000161 host.set_or_delete_attribute(attribute, value)
showard0957a842009-05-11 19:25:08 +0000162
163
mblighe8819cd2008-02-15 16:48:40 +0000164def delete_host(id):
jadmanski0afbb632008-06-06 21:10:57 +0000165 models.Host.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000166
167
showard43a3d262008-11-12 18:17:05 +0000168def get_hosts(multiple_labels=[], exclude_only_if_needed_labels=False,
169 **filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000170 """\
171 multiple_labels: match hosts in all of the labels given. Should be a
172 list of label names.
showard43a3d262008-11-12 18:17:05 +0000173 exclude_only_if_needed_labels: exclude hosts with at least one
174 "only_if_needed" label applied.
jadmanski0afbb632008-06-06 21:10:57 +0000175 """
showard43a3d262008-11-12 18:17:05 +0000176 hosts = rpc_utils.get_host_query(multiple_labels,
177 exclude_only_if_needed_labels,
178 filter_data)
showard0957a842009-05-11 19:25:08 +0000179 hosts = list(hosts)
180 models.Host.objects.populate_relationships(hosts, models.Label,
181 'label_list')
182 models.Host.objects.populate_relationships(hosts, models.AclGroup,
183 'acl_list')
184 models.Host.objects.populate_relationships(hosts, models.HostAttribute,
185 'attribute_list')
showard43a3d262008-11-12 18:17:05 +0000186 host_dicts = []
187 for host_obj in hosts:
188 host_dict = host_obj.get_object_dict()
showard0957a842009-05-11 19:25:08 +0000189 host_dict['labels'] = [label.name for label in host_obj.label_list]
showard909c9142009-07-07 20:54:42 +0000190 host_dict['platform'], host_dict['atomic_group'] = (rpc_utils.
191 find_platform_and_atomic_group(host_obj))
showard0957a842009-05-11 19:25:08 +0000192 host_dict['acls'] = [acl.name for acl in host_obj.acl_list]
193 host_dict['attributes'] = dict((attribute.attribute, attribute.value)
194 for attribute in host_obj.attribute_list)
showard43a3d262008-11-12 18:17:05 +0000195 host_dicts.append(host_dict)
196 return rpc_utils.prepare_for_serialization(host_dicts)
mblighe8819cd2008-02-15 16:48:40 +0000197
198
showard43a3d262008-11-12 18:17:05 +0000199def get_num_hosts(multiple_labels=[], exclude_only_if_needed_labels=False,
200 **filter_data):
201 hosts = rpc_utils.get_host_query(multiple_labels,
202 exclude_only_if_needed_labels,
203 filter_data)
204 return hosts.count()
showard1385b162008-03-13 15:59:40 +0000205
mblighe8819cd2008-02-15 16:48:40 +0000206
207# tests
208
showard909c7a62008-07-15 21:52:38 +0000209def add_test(name, test_type, path, author=None, dependencies=None,
showard3d9899a2008-07-31 02:11:58 +0000210 experimental=True, run_verify=None, test_class=None,
showard909c7a62008-07-15 21:52:38 +0000211 test_time=None, test_category=None, description=None,
212 sync_count=1):
jadmanski0afbb632008-06-06 21:10:57 +0000213 return models.Test.add_object(name=name, test_type=test_type, path=path,
showard909c7a62008-07-15 21:52:38 +0000214 author=author, dependencies=dependencies,
215 experimental=experimental,
216 run_verify=run_verify, test_time=test_time,
217 test_category=test_category,
218 sync_count=sync_count,
jadmanski0afbb632008-06-06 21:10:57 +0000219 test_class=test_class,
220 description=description).id
mblighe8819cd2008-02-15 16:48:40 +0000221
222
223def modify_test(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +0000224 models.Test.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000225
226
227def delete_test(id):
jadmanski0afbb632008-06-06 21:10:57 +0000228 models.Test.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000229
230
231def get_tests(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000232 return rpc_utils.prepare_for_serialization(
233 models.Test.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000234
235
showard2b9a88b2008-06-13 20:55:03 +0000236# profilers
237
238def add_profiler(name, description=None):
239 return models.Profiler.add_object(name=name, description=description).id
240
241
242def modify_profiler(id, **data):
243 models.Profiler.smart_get(id).update_object(data)
244
245
246def delete_profiler(id):
247 models.Profiler.smart_get(id).delete()
248
249
250def get_profilers(**filter_data):
251 return rpc_utils.prepare_for_serialization(
252 models.Profiler.list_objects(filter_data))
253
254
mblighe8819cd2008-02-15 16:48:40 +0000255# users
256
257def add_user(login, access_level=None):
jadmanski0afbb632008-06-06 21:10:57 +0000258 return models.User.add_object(login=login, access_level=access_level).id
mblighe8819cd2008-02-15 16:48:40 +0000259
260
261def modify_user(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +0000262 models.User.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000263
264
265def delete_user(id):
jadmanski0afbb632008-06-06 21:10:57 +0000266 models.User.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000267
268
269def get_users(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000270 return rpc_utils.prepare_for_serialization(
271 models.User.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000272
273
274# acl groups
275
276def add_acl_group(name, description=None):
showard04f2cd82008-07-25 20:53:31 +0000277 group = models.AclGroup.add_object(name=name, description=description)
278 group.users.add(thread_local.get_user())
279 return group.id
mblighe8819cd2008-02-15 16:48:40 +0000280
281
282def modify_acl_group(id, **data):
showard04f2cd82008-07-25 20:53:31 +0000283 group = models.AclGroup.smart_get(id)
284 group.check_for_acl_violation_acl_group()
285 group.update_object(data)
286 group.add_current_user_if_empty()
mblighe8819cd2008-02-15 16:48:40 +0000287
288
289def acl_group_add_users(id, users):
jadmanski0afbb632008-06-06 21:10:57 +0000290 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000291 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000292 users = models.User.smart_get_bulk(users)
jadmanski0afbb632008-06-06 21:10:57 +0000293 group.users.add(*users)
mblighe8819cd2008-02-15 16:48:40 +0000294
295
296def acl_group_remove_users(id, users):
jadmanski0afbb632008-06-06 21:10:57 +0000297 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000298 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000299 users = models.User.smart_get_bulk(users)
jadmanski0afbb632008-06-06 21:10:57 +0000300 group.users.remove(*users)
showard04f2cd82008-07-25 20:53:31 +0000301 group.add_current_user_if_empty()
mblighe8819cd2008-02-15 16:48:40 +0000302
303
304def acl_group_add_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +0000305 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000306 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000307 hosts = models.Host.smart_get_bulk(hosts)
jadmanski0afbb632008-06-06 21:10:57 +0000308 group.hosts.add(*hosts)
showard08f981b2008-06-24 21:59:03 +0000309 group.on_host_membership_change()
mblighe8819cd2008-02-15 16:48:40 +0000310
311
312def acl_group_remove_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +0000313 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000314 group.check_for_acl_violation_acl_group()
showardbe3ec042008-11-12 18:16:07 +0000315 hosts = models.Host.smart_get_bulk(hosts)
jadmanski0afbb632008-06-06 21:10:57 +0000316 group.hosts.remove(*hosts)
showard08f981b2008-06-24 21:59:03 +0000317 group.on_host_membership_change()
mblighe8819cd2008-02-15 16:48:40 +0000318
319
320def delete_acl_group(id):
jadmanski0afbb632008-06-06 21:10:57 +0000321 models.AclGroup.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000322
323
324def get_acl_groups(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000325 acl_groups = models.AclGroup.list_objects(filter_data)
326 for acl_group in acl_groups:
327 acl_group_obj = models.AclGroup.objects.get(id=acl_group['id'])
328 acl_group['users'] = [user.login
329 for user in acl_group_obj.users.all()]
330 acl_group['hosts'] = [host.hostname
331 for host in acl_group_obj.hosts.all()]
332 return rpc_utils.prepare_for_serialization(acl_groups)
mblighe8819cd2008-02-15 16:48:40 +0000333
334
335# jobs
336
mbligh120351e2009-01-24 01:40:45 +0000337def generate_control_file(tests=(), kernel=None, label=None, profilers=(),
338 client_control_file='', use_container=False):
jadmanski0afbb632008-06-06 21:10:57 +0000339 """
mbligh120351e2009-01-24 01:40:45 +0000340 Generates a client-side control file to load a kernel and run tests.
341
342 @param tests List of tests to run.
343 @param kernel Kernel to install in generated control file.
344 @param label Name of label to grab kernel config from.
345 @param profilers List of profilers to activate during the job.
346 @param client_control_file The contents of a client-side control file to
347 run at the end of all tests. If this is supplied, all tests must be
348 client side.
349 TODO: in the future we should support server control files directly
350 to wrap with a kernel. That'll require changing the parameter
351 name and adding a boolean to indicate if it is a client or server
352 control file.
353 @param use_container unused argument today. TODO: Enable containers
354 on the host during a client side test.
355
356 @returns a dict with the following keys:
357 control_file: str, The control file text.
358 is_server: bool, is the control file a server-side control file?
359 synch_count: How many machines the job uses per autoserv execution.
360 synch_count == 1 means the job is asynchronous.
361 dependencies: A list of the names of labels on which the job depends.
362 """
showardd86debe2009-06-10 17:37:56 +0000363 if not tests and not client_control_file:
showard2bab8f42008-11-12 18:15:22 +0000364 return dict(control_file='', is_server=False, synch_count=1,
showard989f25d2008-10-01 11:38:11 +0000365 dependencies=[])
mblighe8819cd2008-02-15 16:48:40 +0000366
showard989f25d2008-10-01 11:38:11 +0000367 cf_info, test_objects, profiler_objects, label = (
showard2b9a88b2008-06-13 20:55:03 +0000368 rpc_utils.prepare_generate_control_file(tests, kernel, label,
369 profilers))
showard989f25d2008-10-01 11:38:11 +0000370 cf_info['control_file'] = control_file.generate_control(
371 tests=test_objects, kernel=kernel, platform=label,
mbligh120351e2009-01-24 01:40:45 +0000372 profilers=profiler_objects, is_server=cf_info['is_server'],
373 client_control_file=client_control_file)
showard989f25d2008-10-01 11:38:11 +0000374 return cf_info
mblighe8819cd2008-02-15 16:48:40 +0000375
376
showard12f3e322009-05-13 21:27:42 +0000377def create_job(name, priority, control_file, control_type,
378 hosts=(), meta_hosts=(), one_time_hosts=(),
379 atomic_group_name=None, synch_count=None, is_template=False,
380 timeout=None, max_runtime_hrs=None, run_verify=True,
381 email_list='', dependencies=(), reboot_before=None,
382 reboot_after=None, parse_failed_repair=None):
jadmanski0afbb632008-06-06 21:10:57 +0000383 """\
384 Create and enqueue a job.
mblighe8819cd2008-02-15 16:48:40 +0000385
showarda1e74b32009-05-12 17:32:04 +0000386 @param name name of this job
387 @param priority Low, Medium, High, Urgent
388 @param control_file String contents of the control file.
389 @param control_type Type of control file, Client or Server.
390 @param synch_count How many machines the job uses per autoserv execution.
391 synch_count == 1 means the job is asynchronous. If an atomic group is
392 given this value is treated as a minimum.
393 @param is_template If true then create a template job.
394 @param timeout Hours after this call returns until the job times out.
showard12f3e322009-05-13 21:27:42 +0000395 @param max_runtime_hrs Hours from job starting time until job times out
showarda1e74b32009-05-12 17:32:04 +0000396 @param run_verify Should the host be verified before running the test?
397 @param email_list String containing emails to mail when the job is done
398 @param dependencies List of label names on which this job depends
399 @param reboot_before Never, If dirty, or Always
400 @param reboot_after Never, If all tests passed, or Always
401 @param parse_failed_repair if true, results of failed repairs launched by
402 this job will be parsed as part of the job.
403
404 @param hosts List of hosts to run job on.
405 @param meta_hosts List where each entry is a label name, and for each entry
406 one host will be chosen from that label to run the job on.
407 @param one_time_hosts List of hosts not in the database to run the job on.
408 @param atomic_group_name The name of an atomic group to schedule the job on.
409
showardc92da832009-04-07 18:14:34 +0000410
411 @returns The created Job id number.
jadmanski0afbb632008-06-06 21:10:57 +0000412 """
showard87658162009-05-29 18:39:50 +0000413 user = thread_local.get_user()
414 owner = user.login
jadmanski0afbb632008-06-06 21:10:57 +0000415 # input validation
showardc92da832009-04-07 18:14:34 +0000416 if not (hosts or meta_hosts or one_time_hosts or atomic_group_name):
mblighec5546d2008-06-16 16:51:28 +0000417 raise model_logic.ValidationError({
showardb8471e32008-07-03 19:51:08 +0000418 'arguments' : "You must pass at least one of 'hosts', "
showardc92da832009-04-07 18:14:34 +0000419 "'meta_hosts', 'one_time_hosts', "
420 "or 'atomic_group_name'"
jadmanski0afbb632008-06-06 21:10:57 +0000421 })
mblighe8819cd2008-02-15 16:48:40 +0000422
showardbc93f0f2009-06-10 00:16:21 +0000423 labels_by_name = dict((label.name, label)
424 for label in models.Label.objects.all())
425 atomic_groups_by_name = dict((ag.name, ag)
426 for ag in models.AtomicGroup.objects.all())
427
showardc8730322009-06-30 01:56:38 +0000428 # Schedule on an atomic group automagically if one of the labels given
429 # is an atomic group label and no explicit atomic_group_name was supplied.
430 if not atomic_group_name:
431 for label_name in meta_hosts or []:
432 label = labels_by_name.get(label_name)
433 if label and label.atomic_group:
434 atomic_group_name = label.atomic_group.name
435 break
436
showardbc93f0f2009-06-10 00:16:21 +0000437 # convert hostnames & meta hosts to host/label objects
438 host_objects = models.Host.smart_get_bulk(hosts)
439 metahost_objects = []
showardc8730322009-06-30 01:56:38 +0000440 for label_name in meta_hosts or []:
441 if label_name in labels_by_name:
442 label = labels_by_name[label_name]
443 metahost_objects.append(label)
444 elif label_name in atomic_groups_by_name:
445 # If given a metahost name that isn't a Label, check to
446 # see if the user was specifying an Atomic Group instead.
447 atomic_group = atomic_groups_by_name[label_name]
showardbc93f0f2009-06-10 00:16:21 +0000448 if atomic_group_name and atomic_group_name != atomic_group.name:
449 raise model_logic.ValidationError({
450 'meta_hosts': (
451 'Label "%s" not found. If assumed to be an '
452 'atomic group it would conflict with the '
453 'supplied atomic group "%s".' % (
showardc8730322009-06-30 01:56:38 +0000454 label_name, atomic_group_name))})
showardbc93f0f2009-06-10 00:16:21 +0000455 atomic_group_name = atomic_group.name
456 else:
457 raise model_logic.ValidationError(
458 {'meta_hosts' : 'Label "%s" not found' % label})
459
showardc92da832009-04-07 18:14:34 +0000460 # Create and sanity check an AtomicGroup object if requested.
461 if atomic_group_name:
462 if one_time_hosts:
463 raise model_logic.ValidationError(
464 {'one_time_hosts':
465 'One time hosts cannot be used with an Atomic Group.'})
466 atomic_group = models.AtomicGroup.smart_get(atomic_group_name)
467 if synch_count and synch_count > atomic_group.max_number_of_machines:
468 raise model_logic.ValidationError(
469 {'atomic_group_name' :
470 'You have requested a synch_count (%d) greater than the '
471 'maximum machines in the requested Atomic Group (%d).' %
472 (synch_count, atomic_group.max_number_of_machines)})
473 else:
474 atomic_group = None
475
showardb8471e32008-07-03 19:51:08 +0000476 for host in one_time_hosts or []:
477 this_host = models.Host.create_one_time_host(host)
478 host_objects.append(this_host)
showardba872902008-06-28 00:51:08 +0000479
showard87658162009-05-29 18:39:50 +0000480 if reboot_before is None:
481 reboot_before = user.get_reboot_before_display()
482 if reboot_after is None:
483 reboot_after = user.get_reboot_after_display()
484
showarda1e74b32009-05-12 17:32:04 +0000485 options = dict(name=name,
486 priority=priority,
487 control_file=control_file,
488 control_type=control_type,
489 is_template=is_template,
490 timeout=timeout,
showard12f3e322009-05-13 21:27:42 +0000491 max_runtime_hrs=max_runtime_hrs,
showarda1e74b32009-05-12 17:32:04 +0000492 synch_count=synch_count,
493 run_verify=run_verify,
494 email_list=email_list,
495 dependencies=dependencies,
496 reboot_before=reboot_before,
497 reboot_after=reboot_after,
498 parse_failed_repair=parse_failed_repair)
showard29f7cd22009-04-29 21:16:24 +0000499 return rpc_utils.create_new_job(owner=owner,
showarda1e74b32009-05-12 17:32:04 +0000500 options=options,
showard29f7cd22009-04-29 21:16:24 +0000501 host_objects=host_objects,
502 metahost_objects=metahost_objects,
showard29f7cd22009-04-29 21:16:24 +0000503 atomic_group=atomic_group)
mblighe8819cd2008-02-15 16:48:40 +0000504
505
showard9dbdcda2008-10-14 17:34:36 +0000506def abort_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000507 """\
showard9dbdcda2008-10-14 17:34:36 +0000508 Abort a set of host queue entries.
jadmanski0afbb632008-06-06 21:10:57 +0000509 """
showard9dbdcda2008-10-14 17:34:36 +0000510 query = models.HostQueueEntry.query_objects(filter_data)
showard0c185192009-01-16 03:07:57 +0000511 query = query.filter(complete=False)
showarddc817512008-11-12 18:16:41 +0000512 models.AclGroup.check_abort_permissions(query)
showard9dbdcda2008-10-14 17:34:36 +0000513 host_queue_entries = list(query.select_related())
showard2bab8f42008-11-12 18:15:22 +0000514 rpc_utils.check_abort_synchronous_jobs(host_queue_entries)
mblighe8819cd2008-02-15 16:48:40 +0000515
showard9dbdcda2008-10-14 17:34:36 +0000516 user = thread_local.get_user()
517 for queue_entry in host_queue_entries:
518 queue_entry.abort(user)
showard9d821ab2008-07-11 16:54:29 +0000519
520
showard1ff7b2e2009-05-15 23:17:18 +0000521def reverify_hosts(**filter_data):
522 """\
523 Schedules a set of hosts for verify.
524 """
525 hosts = models.Host.query_objects(filter_data)
526 models.AclGroup.check_for_acl_violation_hosts(hosts)
showard6d7b2ff2009-06-10 00:16:47 +0000527 models.SpecialTask.schedule_special_task(hosts,
showard2fe3f1d2009-07-06 20:19:11 +0000528 models.SpecialTask.Task.VERIFY)
showard1ff7b2e2009-05-15 23:17:18 +0000529
530
mblighe8819cd2008-02-15 16:48:40 +0000531def get_jobs(not_yet_run=False, running=False, finished=False, **filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000532 """\
533 Extra filter args for get_jobs:
534 -not_yet_run: Include only jobs that have not yet started running.
535 -running: Include only jobs that have start running but for which not
536 all hosts have completed.
537 -finished: Include only jobs for which all hosts have completed (or
538 aborted).
539 At most one of these three fields should be specified.
540 """
541 filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run,
542 running,
543 finished)
showard0957a842009-05-11 19:25:08 +0000544 job_dicts = []
545 jobs = list(models.Job.query_objects(filter_data))
546 models.Job.objects.populate_relationships(jobs, models.Label,
547 'dependencies')
548 for job in jobs:
549 job_dict = job.get_object_dict()
550 job_dict['dependencies'] = ','.join(label.name
551 for label in job.dependencies)
552 job_dicts.append(job_dict)
553 return rpc_utils.prepare_for_serialization(job_dicts)
mblighe8819cd2008-02-15 16:48:40 +0000554
555
556def get_num_jobs(not_yet_run=False, running=False, finished=False,
jadmanski0afbb632008-06-06 21:10:57 +0000557 **filter_data):
558 """\
559 See get_jobs() for documentation of extra filter parameters.
560 """
561 filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run,
562 running,
563 finished)
564 return models.Job.query_count(filter_data)
mblighe8819cd2008-02-15 16:48:40 +0000565
566
mblighe8819cd2008-02-15 16:48:40 +0000567def get_jobs_summary(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000568 """\
showarda8709c52008-07-03 19:44:54 +0000569 Like get_jobs(), but adds a 'status_counts' field, which is a dictionary
jadmanski0afbb632008-06-06 21:10:57 +0000570 mapping status strings to the number of hosts currently with that
571 status, i.e. {'Queued' : 4, 'Running' : 2}.
572 """
573 jobs = get_jobs(**filter_data)
574 ids = [job['id'] for job in jobs]
575 all_status_counts = models.Job.objects.get_status_counts(ids)
576 for job in jobs:
577 job['status_counts'] = all_status_counts[job['id']]
578 return rpc_utils.prepare_for_serialization(jobs)
mblighe8819cd2008-02-15 16:48:40 +0000579
580
showarda965cef2009-05-15 23:17:41 +0000581def get_info_for_clone(id, preserve_metahosts, queue_entry_filter_data=None):
showarda8709c52008-07-03 19:44:54 +0000582 """\
583 Retrieves all the information needed to clone a job.
584 """
showarda8709c52008-07-03 19:44:54 +0000585 job = models.Job.objects.get(id=id)
showard29f7cd22009-04-29 21:16:24 +0000586 job_info = rpc_utils.get_job_info(job,
showarda965cef2009-05-15 23:17:41 +0000587 preserve_metahosts,
588 queue_entry_filter_data)
showard945072f2008-09-03 20:34:59 +0000589
showardd9992fe2008-07-31 02:15:03 +0000590 host_dicts = []
showard29f7cd22009-04-29 21:16:24 +0000591 for host in job_info['hosts']:
592 host_dict = get_hosts(id=host.id)[0]
593 other_labels = host_dict['labels']
594 if host_dict['platform']:
595 other_labels.remove(host_dict['platform'])
596 host_dict['other_labels'] = ', '.join(other_labels)
showardd9992fe2008-07-31 02:15:03 +0000597 host_dicts.append(host_dict)
showarda8709c52008-07-03 19:44:54 +0000598
showard29f7cd22009-04-29 21:16:24 +0000599 for host in job_info['one_time_hosts']:
600 host_dict = dict(hostname=host.hostname,
601 id=host.id,
602 platform='(one-time host)',
603 locked_text='')
604 host_dicts.append(host_dict)
showarda8709c52008-07-03 19:44:54 +0000605
showard4d077562009-05-08 18:24:36 +0000606 # convert keys from Label objects to strings (names of labels)
showard29f7cd22009-04-29 21:16:24 +0000607 meta_host_counts = dict((meta_host.name, count) for meta_host, count
showard4d077562009-05-08 18:24:36 +0000608 in job_info['meta_host_counts'].iteritems())
showard29f7cd22009-04-29 21:16:24 +0000609
610 info = dict(job=job.get_object_dict(),
611 meta_host_counts=meta_host_counts,
612 hosts=host_dicts)
613 info['job']['dependencies'] = job_info['dependencies']
614 if job_info['atomic_group']:
615 info['atomic_group_name'] = (job_info['atomic_group']).name
616 else:
617 info['atomic_group_name'] = None
showarda8709c52008-07-03 19:44:54 +0000618
619 return rpc_utils.prepare_for_serialization(info)
620
621
showard34dc5fa2008-04-24 20:58:40 +0000622# host queue entries
623
624def get_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000625 """\
showardc92da832009-04-07 18:14:34 +0000626 @returns A sequence of nested dictionaries of host and job information.
jadmanski0afbb632008-06-06 21:10:57 +0000627 """
showardc92da832009-04-07 18:14:34 +0000628 return rpc_utils.prepare_rows_as_nested_dicts(
629 models.HostQueueEntry.query_objects(filter_data),
630 ('host', 'atomic_group', 'job'))
showard34dc5fa2008-04-24 20:58:40 +0000631
632
633def get_num_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000634 """\
635 Get the number of host queue entries associated with this job.
636 """
637 return models.HostQueueEntry.query_count(filter_data)
showard34dc5fa2008-04-24 20:58:40 +0000638
639
showard1e935f12008-07-11 00:11:36 +0000640def get_hqe_percentage_complete(**filter_data):
641 """
showardc92da832009-04-07 18:14:34 +0000642 Computes the fraction of host queue entries matching the given filter data
showard1e935f12008-07-11 00:11:36 +0000643 that are complete.
644 """
645 query = models.HostQueueEntry.query_objects(filter_data)
646 complete_count = query.filter(complete=True).count()
647 total_count = query.count()
648 if total_count == 0:
649 return 1
650 return float(complete_count) / total_count
651
652
showardc0ac3a72009-07-08 21:14:45 +0000653# support for host detail view
654
655def get_host_queue_entries_and_special_tasks(hostname, query_start=None,
656 query_limit=None):
657 """
658 @returns an interleaved list of HostQueueEntries and SpecialTasks,
659 in approximate run order. each dict contains keys for type, host,
660 job, status, started_on, execution_path, and ID.
661 """
662 total_limit = None
663 if query_limit is not None:
664 total_limit = query_start + query_limit
665 filter_data = {'host__hostname': hostname,
666 'query_limit': total_limit,
667 'sort_by': ['-id']}
668
669 queue_entries = list(models.HostQueueEntry.query_objects(filter_data))
670 special_tasks = list(models.SpecialTask.query_objects(filter_data))
671
672 interleaved_entries = rpc_utils.interleave_entries(queue_entries,
673 special_tasks)
674 if query_start is not None:
675 interleaved_entries = interleaved_entries[query_start:]
676 if query_limit is not None:
677 interleaved_entries = interleaved_entries[:query_limit]
678 return rpc_utils.prepare_for_serialization(interleaved_entries)
679
680
681def get_num_host_queue_entries_and_special_tasks(hostname):
682 filter_data = {'host__hostname': hostname}
683 return (models.HostQueueEntry.query_count(filter_data)
684 + models.SpecialTask.query_count(filter_data))
685
686
showard29f7cd22009-04-29 21:16:24 +0000687# recurring run
688
689def get_recurring(**filter_data):
690 return rpc_utils.prepare_rows_as_nested_dicts(
691 models.RecurringRun.query_objects(filter_data),
692 ('job', 'owner'))
693
694
695def get_num_recurring(**filter_data):
696 return models.RecurringRun.query_count(filter_data)
697
698
699def delete_recurring_runs(**filter_data):
700 to_delete = models.RecurringRun.query_objects(filter_data)
701 to_delete.delete()
702
703
704def create_recurring_run(job_id, start_date, loop_period, loop_count):
705 owner = thread_local.get_user().login
706 job = models.Job.objects.get(id=job_id)
707 return job.create_recurring_job(start_date=start_date,
708 loop_period=loop_period,
709 loop_count=loop_count,
710 owner=owner)
711
712
mblighe8819cd2008-02-15 16:48:40 +0000713# other
714
showarde0b63622008-08-04 20:58:47 +0000715def echo(data=""):
716 """\
717 Returns a passed in string. For doing a basic test to see if RPC calls
718 can successfully be made.
719 """
720 return data
721
722
showardb7a52fd2009-04-27 20:10:56 +0000723def get_motd():
724 """\
725 Returns the message of the day as a string.
726 """
727 return rpc_utils.get_motd()
728
729
mblighe8819cd2008-02-15 16:48:40 +0000730def get_static_data():
jadmanski0afbb632008-06-06 21:10:57 +0000731 """\
732 Returns a dictionary containing a bunch of data that shouldn't change
733 often and is otherwise inaccessible. This includes:
showardc92da832009-04-07 18:14:34 +0000734
735 priorities: List of job priority choices.
736 default_priority: Default priority value for new jobs.
737 users: Sorted list of all users.
738 labels: Sorted list of all labels.
739 atomic_groups: Sorted list of all atomic groups.
740 tests: Sorted list of all tests.
741 profilers: Sorted list of all profilers.
742 current_user: Logged-in username.
743 host_statuses: Sorted list of possible Host statuses.
744 job_statuses: Sorted list of possible HostQueueEntry statuses.
745 job_timeout_default: The default job timeout length in hours.
showarda1e74b32009-05-12 17:32:04 +0000746 parse_failed_repair_default: Default value for the parse_failed_repair job
747 option.
showardc92da832009-04-07 18:14:34 +0000748 reboot_before_options: A list of valid RebootBefore string enums.
749 reboot_after_options: A list of valid RebootAfter string enums.
750 motd: Server's message of the day.
751 status_dictionary: A mapping from one word job status names to a more
752 informative description.
jadmanski0afbb632008-06-06 21:10:57 +0000753 """
showard21baa452008-10-21 00:08:39 +0000754
755 job_fields = models.Job.get_field_dict()
756
jadmanski0afbb632008-06-06 21:10:57 +0000757 result = {}
758 result['priorities'] = models.Job.Priority.choices()
showard21baa452008-10-21 00:08:39 +0000759 default_priority = job_fields['priority'].default
jadmanski0afbb632008-06-06 21:10:57 +0000760 default_string = models.Job.Priority.get_string(default_priority)
761 result['default_priority'] = default_string
762 result['users'] = get_users(sort_by=['login'])
763 result['labels'] = get_labels(sort_by=['-platform', 'name'])
showardc92da832009-04-07 18:14:34 +0000764 result['atomic_groups'] = get_atomic_groups(sort_by=['name'])
jadmanski0afbb632008-06-06 21:10:57 +0000765 result['tests'] = get_tests(sort_by=['name'])
showard2b9a88b2008-06-13 20:55:03 +0000766 result['profilers'] = get_profilers(sort_by=['name'])
showard0fc38302008-10-23 00:44:07 +0000767 result['current_user'] = rpc_utils.prepare_for_serialization(
768 thread_local.get_user().get_object_dict())
showard2b9a88b2008-06-13 20:55:03 +0000769 result['host_statuses'] = sorted(models.Host.Status.names)
mbligh5a198b92008-12-11 19:33:29 +0000770 result['job_statuses'] = sorted(models.HostQueueEntry.Status.names)
showardb1e51872008-10-07 11:08:18 +0000771 result['job_timeout_default'] = models.Job.DEFAULT_TIMEOUT
showard12f3e322009-05-13 21:27:42 +0000772 result['job_max_runtime_hrs_default'] = models.Job.DEFAULT_MAX_RUNTIME_HRS
showarda1e74b32009-05-12 17:32:04 +0000773 result['parse_failed_repair_default'] = bool(
774 models.Job.DEFAULT_PARSE_FAILED_REPAIR)
showard0fc38302008-10-23 00:44:07 +0000775 result['reboot_before_options'] = models.RebootBefore.names
776 result['reboot_after_options'] = models.RebootAfter.names
showard8fbae652009-01-20 23:23:10 +0000777 result['motd'] = rpc_utils.get_motd()
showard8ac29b42008-07-17 17:01:55 +0000778
showardd3dc1992009-04-22 21:01:40 +0000779 result['status_dictionary'] = {"Aborted": "Aborted",
showard8ac29b42008-07-17 17:01:55 +0000780 "Verifying": "Verifying Host",
781 "Pending": "Waiting on other hosts",
782 "Running": "Running autoserv",
783 "Completed": "Autoserv completed",
784 "Failed": "Failed to complete",
showardd823b362008-07-24 16:35:46 +0000785 "Queued": "Queued",
showard5deb6772008-11-04 21:54:33 +0000786 "Starting": "Next in host's queue",
787 "Stopped": "Other host(s) failed verify",
showardd3dc1992009-04-22 21:01:40 +0000788 "Parsing": "Awaiting parse of final results",
showard29f7cd22009-04-29 21:16:24 +0000789 "Gathering": "Gathering log files",
showard6d7b2ff2009-06-10 00:16:47 +0000790 "Template": "Template job for recurring run"}
jadmanski0afbb632008-06-06 21:10:57 +0000791 return result
showard29f7cd22009-04-29 21:16:24 +0000792
793
794def get_server_time():
795 return datetime.datetime.now().strftime("%Y-%m-%d %H:%M")