blob: b063215dc4b55e69ac65b856e2589e68a209205e [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
27See doctests/rpc_test.txt for (lots) more examples.
28"""
29
30__author__ = 'showard@google.com (Steve Howard)'
31
showardff901382008-07-07 23:22:16 +000032from frontend import thread_local
showard09096d82008-07-07 23:20:49 +000033from frontend.afe import models, model_logic, control_file, rpc_utils
34from frontend.afe import readonly_connection
showard3bb499f2008-07-03 19:42:20 +000035from autotest_lib.client.common_lib import global_config
36
mblighe8819cd2008-02-15 16:48:40 +000037
38# labels
39
40def add_label(name, kernel_config=None, platform=None):
jadmanski0afbb632008-06-06 21:10:57 +000041 return models.Label.add_object(name=name, kernel_config=kernel_config,
42 platform=platform).id
mblighe8819cd2008-02-15 16:48:40 +000043
44
45def modify_label(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +000046 models.Label.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +000047
48
49def delete_label(id):
jadmanski0afbb632008-06-06 21:10:57 +000050 models.Label.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +000051
52
showardbbabf502008-06-06 00:02:02 +000053def label_add_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +000054 host_objs = [models.Host.smart_get(host) for host in hosts]
55 models.Label.smart_get(id).host_set.add(*host_objs)
showardbbabf502008-06-06 00:02:02 +000056
57
58def label_remove_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +000059 host_objs = [models.Host.smart_get(host) for host in hosts]
60 models.Label.smart_get(id).host_set.remove(*host_objs)
showardbbabf502008-06-06 00:02:02 +000061
62
mblighe8819cd2008-02-15 16:48:40 +000063def get_labels(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +000064 return rpc_utils.prepare_for_serialization(
65 models.Label.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +000066
67
68# hosts
69
showarddf062562008-07-03 19:56:37 +000070def add_host(hostname, status=None, locked=None, protection=None):
jadmanski0afbb632008-06-06 21:10:57 +000071 return models.Host.add_object(hostname=hostname, status=status,
showarddf062562008-07-03 19:56:37 +000072 locked=locked, protection=protection).id
mblighe8819cd2008-02-15 16:48:40 +000073
74
75def modify_host(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +000076 models.Host.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +000077
78
79def host_add_labels(id, labels):
jadmanski0afbb632008-06-06 21:10:57 +000080 labels = [models.Label.smart_get(label) for label in labels]
81 models.Host.smart_get(id).labels.add(*labels)
mblighe8819cd2008-02-15 16:48:40 +000082
83
84def host_remove_labels(id, labels):
jadmanski0afbb632008-06-06 21:10:57 +000085 labels = [models.Label.smart_get(label) for label in labels]
86 models.Host.smart_get(id).labels.remove(*labels)
mblighe8819cd2008-02-15 16:48:40 +000087
88
89def delete_host(id):
jadmanski0afbb632008-06-06 21:10:57 +000090 models.Host.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +000091
92
showard8e3aa5e2008-04-08 19:42:32 +000093def get_hosts(multiple_labels=[], **filter_data):
jadmanski0afbb632008-06-06 21:10:57 +000094 """\
95 multiple_labels: match hosts in all of the labels given. Should be a
96 list of label names.
97 """
98 filter_data['extra_args'] = (
99 rpc_utils.extra_host_filters(multiple_labels))
100 hosts = models.Host.list_objects(filter_data)
101 for host in hosts:
102 host_obj = models.Host.objects.get(id=host['id'])
103 host['labels'] = [label.name
104 for label in host_obj.labels.all()]
105 platform = host_obj.platform()
106 host['platform'] = platform and platform.name or None
107 return rpc_utils.prepare_for_serialization(hosts)
mblighe8819cd2008-02-15 16:48:40 +0000108
109
showard8e3aa5e2008-04-08 19:42:32 +0000110def get_num_hosts(multiple_labels=[], **filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000111 filter_data['extra_args'] = (
112 rpc_utils.extra_host_filters(multiple_labels))
113 return models.Host.query_count(filter_data)
showard1385b162008-03-13 15:59:40 +0000114
mblighe8819cd2008-02-15 16:48:40 +0000115
116# tests
117
showard909c7a62008-07-15 21:52:38 +0000118def add_test(name, test_type, path, author=None, dependencies=None,
showard3d9899a2008-07-31 02:11:58 +0000119 experimental=True, run_verify=None, test_class=None,
showard909c7a62008-07-15 21:52:38 +0000120 test_time=None, test_category=None, description=None,
121 sync_count=1):
jadmanski0afbb632008-06-06 21:10:57 +0000122 return models.Test.add_object(name=name, test_type=test_type, path=path,
showard909c7a62008-07-15 21:52:38 +0000123 author=author, dependencies=dependencies,
124 experimental=experimental,
125 run_verify=run_verify, test_time=test_time,
126 test_category=test_category,
127 sync_count=sync_count,
jadmanski0afbb632008-06-06 21:10:57 +0000128 test_class=test_class,
129 description=description).id
mblighe8819cd2008-02-15 16:48:40 +0000130
131
132def modify_test(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +0000133 models.Test.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000134
135
136def delete_test(id):
jadmanski0afbb632008-06-06 21:10:57 +0000137 models.Test.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000138
139
140def get_tests(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000141 return rpc_utils.prepare_for_serialization(
142 models.Test.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000143
144
showard2b9a88b2008-06-13 20:55:03 +0000145# profilers
146
147def add_profiler(name, description=None):
148 return models.Profiler.add_object(name=name, description=description).id
149
150
151def modify_profiler(id, **data):
152 models.Profiler.smart_get(id).update_object(data)
153
154
155def delete_profiler(id):
156 models.Profiler.smart_get(id).delete()
157
158
159def get_profilers(**filter_data):
160 return rpc_utils.prepare_for_serialization(
161 models.Profiler.list_objects(filter_data))
162
163
mblighe8819cd2008-02-15 16:48:40 +0000164# users
165
166def add_user(login, access_level=None):
jadmanski0afbb632008-06-06 21:10:57 +0000167 return models.User.add_object(login=login, access_level=access_level).id
mblighe8819cd2008-02-15 16:48:40 +0000168
169
170def modify_user(id, **data):
jadmanski0afbb632008-06-06 21:10:57 +0000171 models.User.smart_get(id).update_object(data)
mblighe8819cd2008-02-15 16:48:40 +0000172
173
174def delete_user(id):
jadmanski0afbb632008-06-06 21:10:57 +0000175 models.User.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000176
177
178def get_users(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000179 return rpc_utils.prepare_for_serialization(
180 models.User.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000181
182
183# acl groups
184
185def add_acl_group(name, description=None):
showard04f2cd82008-07-25 20:53:31 +0000186 group = models.AclGroup.add_object(name=name, description=description)
187 group.users.add(thread_local.get_user())
188 return group.id
mblighe8819cd2008-02-15 16:48:40 +0000189
190
191def modify_acl_group(id, **data):
showard04f2cd82008-07-25 20:53:31 +0000192 group = models.AclGroup.smart_get(id)
193 group.check_for_acl_violation_acl_group()
194 group.update_object(data)
195 group.add_current_user_if_empty()
mblighe8819cd2008-02-15 16:48:40 +0000196
197
198def acl_group_add_users(id, users):
jadmanski0afbb632008-06-06 21:10:57 +0000199 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000200 group.check_for_acl_violation_acl_group()
201 users = [models.User.smart_get(user) for user in users]
jadmanski0afbb632008-06-06 21:10:57 +0000202 group.users.add(*users)
mblighe8819cd2008-02-15 16:48:40 +0000203
204
205def acl_group_remove_users(id, users):
jadmanski0afbb632008-06-06 21:10:57 +0000206 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000207 group.check_for_acl_violation_acl_group()
208 users = [models.User.smart_get(user) for user in users]
jadmanski0afbb632008-06-06 21:10:57 +0000209 group.users.remove(*users)
showard04f2cd82008-07-25 20:53:31 +0000210 group.add_current_user_if_empty()
mblighe8819cd2008-02-15 16:48:40 +0000211
212
213def acl_group_add_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +0000214 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000215 group.check_for_acl_violation_acl_group()
216 hosts = [models.Host.smart_get(host) for host in hosts]
jadmanski0afbb632008-06-06 21:10:57 +0000217 group.hosts.add(*hosts)
showard08f981b2008-06-24 21:59:03 +0000218 group.on_host_membership_change()
mblighe8819cd2008-02-15 16:48:40 +0000219
220
221def acl_group_remove_hosts(id, hosts):
jadmanski0afbb632008-06-06 21:10:57 +0000222 group = models.AclGroup.smart_get(id)
showard04f2cd82008-07-25 20:53:31 +0000223 group.check_for_acl_violation_acl_group()
224 hosts = [models.Host.smart_get(host) for host in hosts]
jadmanski0afbb632008-06-06 21:10:57 +0000225 group.hosts.remove(*hosts)
showard08f981b2008-06-24 21:59:03 +0000226 group.on_host_membership_change()
mblighe8819cd2008-02-15 16:48:40 +0000227
228
229def delete_acl_group(id):
jadmanski0afbb632008-06-06 21:10:57 +0000230 models.AclGroup.smart_get(id).delete()
mblighe8819cd2008-02-15 16:48:40 +0000231
232
233def get_acl_groups(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000234 acl_groups = models.AclGroup.list_objects(filter_data)
235 for acl_group in acl_groups:
236 acl_group_obj = models.AclGroup.objects.get(id=acl_group['id'])
237 acl_group['users'] = [user.login
238 for user in acl_group_obj.users.all()]
239 acl_group['hosts'] = [host.hostname
240 for host in acl_group_obj.hosts.all()]
241 return rpc_utils.prepare_for_serialization(acl_groups)
mblighe8819cd2008-02-15 16:48:40 +0000242
243
244# jobs
245
showard2b9a88b2008-06-13 20:55:03 +0000246def generate_control_file(tests, kernel=None, label=None, profilers=[]):
jadmanski0afbb632008-06-06 21:10:57 +0000247 """\
248 Generates a client-side control file to load a kernel and run a set of
249 tests. Returns a tuple (control_file, is_server, is_synchronous):
250 control_file - the control file text
251 is_server - is the control file a server-side control file?
252 is_synchronous - should the control file be run synchronously?
mblighe8819cd2008-02-15 16:48:40 +0000253
jadmanski0afbb632008-06-06 21:10:57 +0000254 tests: list of tests to run
255 kernel: kernel to install in generated control file
256 label: name of label to grab kernel config from
showard2b9a88b2008-06-13 20:55:03 +0000257 profilers: list of profilers to activate during the job
jadmanski0afbb632008-06-06 21:10:57 +0000258 """
259 if not tests:
260 return '', False, False
mblighe8819cd2008-02-15 16:48:40 +0000261
showard2b9a88b2008-06-13 20:55:03 +0000262 is_server, is_synchronous, test_objects, profiler_objects, label = (
263 rpc_utils.prepare_generate_control_file(tests, kernel, label,
264 profilers))
265 cf_text = control_file.generate_control(tests=test_objects, kernel=kernel,
266 platform=label,
267 profilers=profiler_objects,
268 is_server=is_server)
jadmanski0afbb632008-06-06 21:10:57 +0000269 return cf_text, is_server, is_synchronous
mblighe8819cd2008-02-15 16:48:40 +0000270
271
showard3bb499f2008-07-03 19:42:20 +0000272def create_job(name, priority, control_file, control_type, timeout=None,
showardb8471e32008-07-03 19:51:08 +0000273 is_synchronous=None, hosts=None, meta_hosts=None,
showard909c7a62008-07-15 21:52:38 +0000274 run_verify=True, one_time_hosts=None):
jadmanski0afbb632008-06-06 21:10:57 +0000275 """\
276 Create and enqueue a job.
mblighe8819cd2008-02-15 16:48:40 +0000277
jadmanski0afbb632008-06-06 21:10:57 +0000278 priority: Low, Medium, High, Urgent
279 control_file: contents of control file
280 control_type: type of control file, Client or Server
281 is_synchronous: boolean indicating if a job is synchronous
282 hosts: list of hosts to run job on
283 meta_hosts: list where each entry is a label name, and for each entry
284 one host will be chosen from that label to run the job
285 on.
showard3bb499f2008-07-03 19:42:20 +0000286 timeout: hours until job times out
jadmanski0afbb632008-06-06 21:10:57 +0000287 """
showard3bb499f2008-07-03 19:42:20 +0000288
289 if timeout is None:
290 timeout=global_config.global_config.get_config_value(
291 'AUTOTEST_WEB', 'job_timeout_default')
292
showardff901382008-07-07 23:22:16 +0000293 owner = thread_local.get_user().login
jadmanski0afbb632008-06-06 21:10:57 +0000294 # input validation
showardb8471e32008-07-03 19:51:08 +0000295 if not hosts and not meta_hosts and not one_time_hosts:
mblighec5546d2008-06-16 16:51:28 +0000296 raise model_logic.ValidationError({
showardb8471e32008-07-03 19:51:08 +0000297 'arguments' : "You must pass at least one of 'hosts', "
298 "'meta_hosts', or 'one_time_hosts'"
jadmanski0afbb632008-06-06 21:10:57 +0000299 })
mblighe8819cd2008-02-15 16:48:40 +0000300
showardba872902008-06-28 00:51:08 +0000301 requested_host_counts = {}
302
jadmanski0afbb632008-06-06 21:10:57 +0000303 # convert hostnames & meta hosts to host/label objects
304 host_objects = []
305 for host in hosts or []:
306 this_host = models.Host.smart_get(host)
307 host_objects.append(this_host)
308 for label in meta_hosts or []:
309 this_label = models.Label.smart_get(label)
310 host_objects.append(this_label)
showardba872902008-06-28 00:51:08 +0000311 requested_host_counts.setdefault(this_label.name, 0)
312 requested_host_counts[this_label.name] += 1
showardb8471e32008-07-03 19:51:08 +0000313 for host in one_time_hosts or []:
314 this_host = models.Host.create_one_time_host(host)
315 host_objects.append(this_host)
showardba872902008-06-28 00:51:08 +0000316
317 # check that each metahost request has enough hosts under the label
318 if meta_hosts:
showard09096d82008-07-07 23:20:49 +0000319 labels = models.Label.objects.filter(
320 name__in=requested_host_counts.keys())
showardba872902008-06-28 00:51:08 +0000321 for label in labels:
322 count = label.host_set.count()
323 if requested_host_counts[label.name] > count:
324 error = ("You have requested %d %s's, but there are only %d."
325 % (requested_host_counts[label.name],
326 label.name, count))
327 raise model_logic.ValidationError({'arguments' : error})
mblighe8819cd2008-02-15 16:48:40 +0000328
jadmanski0afbb632008-06-06 21:10:57 +0000329 # default is_synchronous to some appropriate value
330 ControlType = models.Job.ControlType
331 control_type = ControlType.get_value(control_type)
332 if is_synchronous is None:
333 is_synchronous = (control_type == ControlType.SERVER)
334 # convert the synch flag to an actual type
335 if is_synchronous:
336 synch_type = models.Test.SynchType.SYNCHRONOUS
337 else:
338 synch_type = models.Test.SynchType.ASYNCHRONOUS
mblighe8819cd2008-02-15 16:48:40 +0000339
jadmanski0afbb632008-06-06 21:10:57 +0000340 job = models.Job.create(owner=owner, name=name, priority=priority,
341 control_file=control_file,
342 control_type=control_type,
343 synch_type=synch_type,
showard3bb499f2008-07-03 19:42:20 +0000344 hosts=host_objects,
showard909c7a62008-07-15 21:52:38 +0000345 timeout=timeout,
346 run_verify=run_verify)
jadmanski0afbb632008-06-06 21:10:57 +0000347 job.queue(host_objects)
348 return job.id
mblighe8819cd2008-02-15 16:48:40 +0000349
350
mblighe8819cd2008-02-15 16:48:40 +0000351def abort_job(id):
jadmanski0afbb632008-06-06 21:10:57 +0000352 """\
353 Abort the job with the given id number.
showard9d821ab2008-07-11 16:54:29 +0000354
355 TODO: this method is deprecated in favor of abort_jobs(). We need
356 to eventually remove this rpc call entirely.
jadmanski0afbb632008-06-06 21:10:57 +0000357 """
358 job = models.Job.objects.get(id=id)
359 job.abort()
mblighe8819cd2008-02-15 16:48:40 +0000360
361
showard9d821ab2008-07-11 16:54:29 +0000362def abort_jobs(job_ids):
363 """\
364 Abort a list of jobs.
365 """
366 for job in models.Job.objects.in_bulk(job_ids).values():
367 job.abort()
368
369
mblighe8819cd2008-02-15 16:48:40 +0000370def get_jobs(not_yet_run=False, running=False, finished=False, **filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000371 """\
372 Extra filter args for get_jobs:
373 -not_yet_run: Include only jobs that have not yet started running.
374 -running: Include only jobs that have start running but for which not
375 all hosts have completed.
376 -finished: Include only jobs for which all hosts have completed (or
377 aborted).
378 At most one of these three fields should be specified.
379 """
380 filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run,
381 running,
382 finished)
383 return rpc_utils.prepare_for_serialization(
384 models.Job.list_objects(filter_data))
mblighe8819cd2008-02-15 16:48:40 +0000385
386
387def get_num_jobs(not_yet_run=False, running=False, finished=False,
jadmanski0afbb632008-06-06 21:10:57 +0000388 **filter_data):
389 """\
390 See get_jobs() for documentation of extra filter parameters.
391 """
392 filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run,
393 running,
394 finished)
395 return models.Job.query_count(filter_data)
mblighe8819cd2008-02-15 16:48:40 +0000396
397
mblighe8819cd2008-02-15 16:48:40 +0000398def get_jobs_summary(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000399 """\
showarda8709c52008-07-03 19:44:54 +0000400 Like get_jobs(), but adds a 'status_counts' field, which is a dictionary
jadmanski0afbb632008-06-06 21:10:57 +0000401 mapping status strings to the number of hosts currently with that
402 status, i.e. {'Queued' : 4, 'Running' : 2}.
403 """
404 jobs = get_jobs(**filter_data)
405 ids = [job['id'] for job in jobs]
406 all_status_counts = models.Job.objects.get_status_counts(ids)
407 for job in jobs:
408 job['status_counts'] = all_status_counts[job['id']]
409 return rpc_utils.prepare_for_serialization(jobs)
mblighe8819cd2008-02-15 16:48:40 +0000410
411
showarda8709c52008-07-03 19:44:54 +0000412def get_info_for_clone(id):
413 """\
414 Retrieves all the information needed to clone a job.
415 """
416 info = {}
417 job = models.Job.objects.get(id=id)
418 query = job.hostqueueentry_set.filter(deleted=False)
419 hosts = [queue_entry.host for queue_entry
showarde48cef52008-07-24 16:32:59 +0000420 in query if queue_entry.host and not queue_entry.meta_host]
showarda8709c52008-07-03 19:44:54 +0000421 meta_hosts = [queue_entry.meta_host.name for queue_entry
422 in query if queue_entry.meta_host]
showardd9992fe2008-07-31 02:15:03 +0000423 host_dicts = []
showarda8709c52008-07-03 19:44:54 +0000424
showardd9992fe2008-07-31 02:15:03 +0000425 for host in hosts:
426 host_dict = {}
427 host_dict['hostname'] = host.hostname
428 host_dict['id'] = host.id
429
430 # one-time host
431 if host.invalid:
432 host_dict['platform'] = '(one-time host)'
433 host_dict['locked_text'] = ''
434
435 else:
436 platform = host.platform()
437 if platform:
438 host_dict['platform'] = platform.name
439 else:
440 host_dict['platform'] = None
441 labels = [label.name for label in host.labels.all()]
442 if platform and platform.name in labels:
443 labels.remove(platform.name)
444 host_dict['other_labels'] = ', '.join(labels)
445 host_dict['status'] = host.status
446 host_dict['locked'] = host.locked
447 host_dicts.append(host_dict)
showarda8709c52008-07-03 19:44:54 +0000448
449 meta_host_counts = {}
450 for meta_host in meta_hosts:
451 meta_host_counts.setdefault(meta_host, 0)
452 meta_host_counts[meta_host] += 1
453
454 info['job'] = job.get_object_dict()
455 info['meta_host_counts'] = meta_host_counts
showardd9992fe2008-07-31 02:15:03 +0000456 info['hosts'] = host_dicts
showarda8709c52008-07-03 19:44:54 +0000457
458 return rpc_utils.prepare_for_serialization(info)
459
460
showard34dc5fa2008-04-24 20:58:40 +0000461# host queue entries
462
463def get_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000464 """\
465 TODO
466 """
467 query = models.HostQueueEntry.query_objects(filter_data)
468 all_dicts = []
469 for queue_entry in query.select_related():
470 entry_dict = queue_entry.get_object_dict()
471 if entry_dict['host'] is not None:
472 entry_dict['host'] = queue_entry.host.get_object_dict()
473 entry_dict['job'] = queue_entry.job.get_object_dict()
474 all_dicts.append(entry_dict)
475 return rpc_utils.prepare_for_serialization(all_dicts)
showard34dc5fa2008-04-24 20:58:40 +0000476
477
478def get_num_host_queue_entries(**filter_data):
jadmanski0afbb632008-06-06 21:10:57 +0000479 """\
480 Get the number of host queue entries associated with this job.
481 """
482 return models.HostQueueEntry.query_count(filter_data)
showard34dc5fa2008-04-24 20:58:40 +0000483
484
showard1e935f12008-07-11 00:11:36 +0000485def get_hqe_percentage_complete(**filter_data):
486 """
487 Computes the percentage of host queue entries matching the given filter data
488 that are complete.
489 """
490 query = models.HostQueueEntry.query_objects(filter_data)
491 complete_count = query.filter(complete=True).count()
492 total_count = query.count()
493 if total_count == 0:
494 return 1
495 return float(complete_count) / total_count
496
497
mblighe8819cd2008-02-15 16:48:40 +0000498# other
499
showarde0b63622008-08-04 20:58:47 +0000500def echo(data=""):
501 """\
502 Returns a passed in string. For doing a basic test to see if RPC calls
503 can successfully be made.
504 """
505 return data
506
507
mblighe8819cd2008-02-15 16:48:40 +0000508def get_static_data():
jadmanski0afbb632008-06-06 21:10:57 +0000509 """\
510 Returns a dictionary containing a bunch of data that shouldn't change
511 often and is otherwise inaccessible. This includes:
512 priorities: list of job priority choices
513 default_priority: default priority value for new jobs
514 users: sorted list of all users
515 labels: sorted list of all labels
516 tests: sorted list of all tests
showard2b9a88b2008-06-13 20:55:03 +0000517 profilers: sorted list of all profilers
jadmanski0afbb632008-06-06 21:10:57 +0000518 user_login: logged-in username
519 host_statuses: sorted list of possible Host statuses
520 job_statuses: sorted list of possible HostQueueEntry statuses
521 """
522 result = {}
523 result['priorities'] = models.Job.Priority.choices()
524 default_priority = models.Job.get_field_dict()['priority'].default
525 default_string = models.Job.Priority.get_string(default_priority)
526 result['default_priority'] = default_string
527 result['users'] = get_users(sort_by=['login'])
528 result['labels'] = get_labels(sort_by=['-platform', 'name'])
529 result['tests'] = get_tests(sort_by=['name'])
showard2b9a88b2008-06-13 20:55:03 +0000530 result['profilers'] = get_profilers(sort_by=['name'])
showardff901382008-07-07 23:22:16 +0000531 result['user_login'] = thread_local.get_user().login
showard2b9a88b2008-06-13 20:55:03 +0000532 result['host_statuses'] = sorted(models.Host.Status.names)
533 result['job_statuses'] = sorted(models.Job.Status.names)
showard3bb499f2008-07-03 19:42:20 +0000534 result['job_timeout_default'] = global_config.global_config.get_config_value(
535 'AUTOTEST_WEB', 'job_timeout_default')
showard8ac29b42008-07-17 17:01:55 +0000536
showard95128e52008-08-04 20:59:34 +0000537 result['status_dictionary'] = {"Abort": "Abort",
538 "Aborted": "Aborted",
showard8ac29b42008-07-17 17:01:55 +0000539 "Verifying": "Verifying Host",
540 "Pending": "Waiting on other hosts",
541 "Running": "Running autoserv",
542 "Completed": "Autoserv completed",
543 "Failed": "Failed to complete",
544 "Aborting": "Abort in progress",
showardd823b362008-07-24 16:35:46 +0000545 "Queued": "Queued",
546 "Starting": "Next in host's queue"}
jadmanski0afbb632008-06-06 21:10:57 +0000547 return result