mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 1 | """\ |
| 2 | Functions to expose over the RPC interface. |
| 3 | |
| 4 | For all modify* and delete* functions that ask for an 'id' parameter to |
| 5 | identify 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 | |
| 11 | When specifying foreign key fields (i.e. adding hosts to a label, or adding |
| 12 | users to an ACL group), the given value may be either the database row ID or the |
| 13 | name of the object. |
| 14 | |
| 15 | All get* functions return lists of dictionaries. Each dictionary represents one |
| 16 | object and maps field names to values. |
| 17 | |
| 18 | Some examples: |
| 19 | modify_host(2, hostname='myhost') # modify hostname of host with database ID 2 |
| 20 | modify_host('ipaj2', hostname='myhost') # modify hostname of host 'ipaj2' |
| 21 | modify_test('sleeptest', test_type='Client', params=', seconds=60') |
| 22 | delete_acl_group(1) # delete by ID |
| 23 | delete_acl_group('Everyone') # delete by name |
| 24 | acl_group_add_users('Everyone', ['mbligh', 'showard']) |
| 25 | get_jobs(owner='showard', status='Queued') |
| 26 | |
mbligh | 93c80e6 | 2009-02-03 17:48:30 +0000 | [diff] [blame] | 27 | See doctests/001_rpc_test.txt for (lots) more examples. |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 28 | """ |
| 29 | |
| 30 | __author__ = 'showard@google.com (Steve Howard)' |
| 31 | |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 32 | import datetime |
showard | cafd16e | 2009-05-29 18:37:49 +0000 | [diff] [blame] | 33 | import common |
| 34 | from autotest_lib.frontend import thread_local |
showard | 6d7b2ff | 2009-06-10 00:16:47 +0000 | [diff] [blame] | 35 | from autotest_lib.frontend.afe import models, model_logic |
| 36 | from autotest_lib.frontend.afe import control_file, rpc_utils |
showard | 3bb499f | 2008-07-03 19:42:20 +0000 | [diff] [blame] | 37 | from autotest_lib.client.common_lib import global_config |
| 38 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 39 | |
| 40 | # labels |
| 41 | |
showard | 989f25d | 2008-10-01 11:38:11 +0000 | [diff] [blame] | 42 | def add_label(name, kernel_config=None, platform=None, only_if_needed=None): |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 43 | return models.Label.add_object( |
| 44 | name=name, kernel_config=kernel_config, platform=platform, |
| 45 | only_if_needed=only_if_needed).id |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 46 | |
| 47 | |
| 48 | def modify_label(id, **data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 49 | models.Label.smart_get(id).update_object(data) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 50 | |
| 51 | |
| 52 | def delete_label(id): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 53 | models.Label.smart_get(id).delete() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 54 | |
| 55 | |
showard | bbabf50 | 2008-06-06 00:02:02 +0000 | [diff] [blame] | 56 | def label_add_hosts(id, hosts): |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 57 | host_objs = models.Host.smart_get_bulk(hosts) |
showard | cafd16e | 2009-05-29 18:37:49 +0000 | [diff] [blame] | 58 | 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) |
showard | bbabf50 | 2008-06-06 00:02:02 +0000 | [diff] [blame] | 62 | |
| 63 | |
| 64 | def label_remove_hosts(id, hosts): |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 65 | host_objs = models.Host.smart_get_bulk(hosts) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 66 | models.Label.smart_get(id).host_set.remove(*host_objs) |
showard | bbabf50 | 2008-06-06 00:02:02 +0000 | [diff] [blame] | 67 | |
| 68 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 69 | def get_labels(**filter_data): |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 70 | """\ |
| 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 | |
showard | e9450c9 | 2009-06-30 01:58:52 +0000 | [diff] [blame] | 80 | def add_atomic_group(name, max_number_of_machines=None, description=None): |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 81 | return models.AtomicGroup.add_object( |
| 82 | name=name, max_number_of_machines=max_number_of_machines, |
| 83 | description=description).id |
| 84 | |
| 85 | |
| 86 | def modify_atomic_group(id, **data): |
| 87 | models.AtomicGroup.smart_get(id).update_object(data) |
| 88 | |
| 89 | |
| 90 | def delete_atomic_group(id): |
| 91 | models.AtomicGroup.smart_get(id).delete() |
| 92 | |
| 93 | |
| 94 | def 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 | |
| 99 | def 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 | |
| 104 | def get_atomic_groups(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 105 | return rpc_utils.prepare_for_serialization( |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 106 | models.AtomicGroup.list_objects(filter_data)) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 107 | |
| 108 | |
| 109 | # hosts |
| 110 | |
showard | df06256 | 2008-07-03 19:56:37 +0000 | [diff] [blame] | 111 | def add_host(hostname, status=None, locked=None, protection=None): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 112 | return models.Host.add_object(hostname=hostname, status=status, |
showard | df06256 | 2008-07-03 19:56:37 +0000 | [diff] [blame] | 113 | locked=locked, protection=protection).id |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 114 | |
| 115 | |
| 116 | def modify_host(id, **data): |
showard | be0d869 | 2009-08-20 23:42:44 +0000 | [diff] [blame] | 117 | rpc_utils.check_modify_host(data) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 118 | models.Host.smart_get(id).update_object(data) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 119 | |
| 120 | |
showard | 276f944 | 2009-05-20 00:33:16 +0000 | [diff] [blame] | 121 | def modify_hosts(host_filter_data, update_data): |
| 122 | """ |
showard | be0d869 | 2009-08-20 23:42:44 +0000 | [diff] [blame] | 123 | @param host_filter_data: Filters out which hosts to modify. |
| 124 | @param update_data: A dictionary with the changes to make to the hosts. |
showard | 276f944 | 2009-05-20 00:33:16 +0000 | [diff] [blame] | 125 | """ |
showard | be0d869 | 2009-08-20 23:42:44 +0000 | [diff] [blame] | 126 | rpc_utils.check_modify_host(update_data) |
showard | 276f944 | 2009-05-20 00:33:16 +0000 | [diff] [blame] | 127 | hosts = models.Host.query_objects(host_filter_data) |
| 128 | for host in hosts: |
| 129 | host.update_object(update_data) |
| 130 | |
| 131 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 132 | def host_add_labels(id, labels): |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 133 | labels = models.Label.smart_get_bulk(labels) |
showard | cafd16e | 2009-05-29 18:37:49 +0000 | [diff] [blame] | 134 | host = models.Host.smart_get(id) |
| 135 | |
| 136 | platforms = [label.name for label in labels if label.platform] |
| 137 | if len(platforms) > 1: |
| 138 | raise model_logic.ValidationError( |
| 139 | {'labels': 'Adding more than one platform label: %s' % |
| 140 | ', '.join(platforms)}) |
| 141 | if len(platforms) == 1: |
| 142 | models.Host.check_no_platform([host]) |
| 143 | host.labels.add(*labels) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 144 | |
| 145 | |
| 146 | def host_remove_labels(id, labels): |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 147 | labels = models.Label.smart_get_bulk(labels) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 148 | models.Host.smart_get(id).labels.remove(*labels) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 149 | |
| 150 | |
showard | 0957a84 | 2009-05-11 19:25:08 +0000 | [diff] [blame] | 151 | def set_host_attribute(attribute, value, **host_filter_data): |
| 152 | """ |
| 153 | @param attribute string name of attribute |
| 154 | @param value string, or None to delete an attribute |
| 155 | @param host_filter_data filter data to apply to Hosts to choose hosts to act |
| 156 | upon |
| 157 | """ |
| 158 | assert host_filter_data # disallow accidental actions on all hosts |
| 159 | hosts = models.Host.query_objects(host_filter_data) |
| 160 | models.AclGroup.check_for_acl_violation_hosts(hosts) |
| 161 | |
| 162 | for host in hosts: |
showard | f8b1904 | 2009-05-12 17:22:49 +0000 | [diff] [blame] | 163 | host.set_or_delete_attribute(attribute, value) |
showard | 0957a84 | 2009-05-11 19:25:08 +0000 | [diff] [blame] | 164 | |
| 165 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 166 | def delete_host(id): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 167 | models.Host.smart_get(id).delete() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 168 | |
| 169 | |
showard | 87cc38f | 2009-08-20 23:37:04 +0000 | [diff] [blame] | 170 | def get_hosts(multiple_labels=(), exclude_only_if_needed_labels=False, |
| 171 | exclude_atomic_group_hosts=False, **filter_data): |
| 172 | """ |
| 173 | @param multiple_labels: match hosts in all of the labels given. Should |
| 174 | be a list of label names. |
| 175 | @param exclude_only_if_needed_labels: Exclude hosts with at least one |
| 176 | "only_if_needed" label applied. |
| 177 | @param exclude_atomic_group_hosts: Exclude hosts that have one or more |
| 178 | atomic group labels associated with them. |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 179 | """ |
showard | 43a3d26 | 2008-11-12 18:17:05 +0000 | [diff] [blame] | 180 | hosts = rpc_utils.get_host_query(multiple_labels, |
| 181 | exclude_only_if_needed_labels, |
showard | 87cc38f | 2009-08-20 23:37:04 +0000 | [diff] [blame] | 182 | exclude_atomic_group_hosts, |
showard | 43a3d26 | 2008-11-12 18:17:05 +0000 | [diff] [blame] | 183 | filter_data) |
showard | 0957a84 | 2009-05-11 19:25:08 +0000 | [diff] [blame] | 184 | hosts = list(hosts) |
| 185 | models.Host.objects.populate_relationships(hosts, models.Label, |
| 186 | 'label_list') |
| 187 | models.Host.objects.populate_relationships(hosts, models.AclGroup, |
| 188 | 'acl_list') |
| 189 | models.Host.objects.populate_relationships(hosts, models.HostAttribute, |
| 190 | 'attribute_list') |
showard | 43a3d26 | 2008-11-12 18:17:05 +0000 | [diff] [blame] | 191 | host_dicts = [] |
| 192 | for host_obj in hosts: |
| 193 | host_dict = host_obj.get_object_dict() |
showard | 0957a84 | 2009-05-11 19:25:08 +0000 | [diff] [blame] | 194 | host_dict['labels'] = [label.name for label in host_obj.label_list] |
showard | 909c914 | 2009-07-07 20:54:42 +0000 | [diff] [blame] | 195 | host_dict['platform'], host_dict['atomic_group'] = (rpc_utils. |
| 196 | find_platform_and_atomic_group(host_obj)) |
showard | 0957a84 | 2009-05-11 19:25:08 +0000 | [diff] [blame] | 197 | host_dict['acls'] = [acl.name for acl in host_obj.acl_list] |
| 198 | host_dict['attributes'] = dict((attribute.attribute, attribute.value) |
| 199 | for attribute in host_obj.attribute_list) |
showard | 43a3d26 | 2008-11-12 18:17:05 +0000 | [diff] [blame] | 200 | host_dicts.append(host_dict) |
| 201 | return rpc_utils.prepare_for_serialization(host_dicts) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 202 | |
| 203 | |
showard | 87cc38f | 2009-08-20 23:37:04 +0000 | [diff] [blame] | 204 | def get_num_hosts(multiple_labels=(), exclude_only_if_needed_labels=False, |
| 205 | exclude_atomic_group_hosts=False, **filter_data): |
| 206 | """ |
| 207 | Same parameters as get_hosts(). |
| 208 | |
| 209 | @returns The number of matching hosts. |
| 210 | """ |
showard | 43a3d26 | 2008-11-12 18:17:05 +0000 | [diff] [blame] | 211 | hosts = rpc_utils.get_host_query(multiple_labels, |
| 212 | exclude_only_if_needed_labels, |
showard | 87cc38f | 2009-08-20 23:37:04 +0000 | [diff] [blame] | 213 | exclude_atomic_group_hosts, |
showard | 43a3d26 | 2008-11-12 18:17:05 +0000 | [diff] [blame] | 214 | filter_data) |
| 215 | return hosts.count() |
showard | 1385b16 | 2008-03-13 15:59:40 +0000 | [diff] [blame] | 216 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 217 | |
| 218 | # tests |
| 219 | |
showard | 909c7a6 | 2008-07-15 21:52:38 +0000 | [diff] [blame] | 220 | def add_test(name, test_type, path, author=None, dependencies=None, |
showard | 3d9899a | 2008-07-31 02:11:58 +0000 | [diff] [blame] | 221 | experimental=True, run_verify=None, test_class=None, |
showard | 909c7a6 | 2008-07-15 21:52:38 +0000 | [diff] [blame] | 222 | test_time=None, test_category=None, description=None, |
| 223 | sync_count=1): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 224 | return models.Test.add_object(name=name, test_type=test_type, path=path, |
showard | 909c7a6 | 2008-07-15 21:52:38 +0000 | [diff] [blame] | 225 | author=author, dependencies=dependencies, |
| 226 | experimental=experimental, |
| 227 | run_verify=run_verify, test_time=test_time, |
| 228 | test_category=test_category, |
| 229 | sync_count=sync_count, |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 230 | test_class=test_class, |
| 231 | description=description).id |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 232 | |
| 233 | |
| 234 | def modify_test(id, **data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 235 | models.Test.smart_get(id).update_object(data) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 236 | |
| 237 | |
| 238 | def delete_test(id): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 239 | models.Test.smart_get(id).delete() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 240 | |
| 241 | |
| 242 | def get_tests(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 243 | return rpc_utils.prepare_for_serialization( |
| 244 | models.Test.list_objects(filter_data)) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 245 | |
| 246 | |
showard | 2b9a88b | 2008-06-13 20:55:03 +0000 | [diff] [blame] | 247 | # profilers |
| 248 | |
| 249 | def add_profiler(name, description=None): |
| 250 | return models.Profiler.add_object(name=name, description=description).id |
| 251 | |
| 252 | |
| 253 | def modify_profiler(id, **data): |
| 254 | models.Profiler.smart_get(id).update_object(data) |
| 255 | |
| 256 | |
| 257 | def delete_profiler(id): |
| 258 | models.Profiler.smart_get(id).delete() |
| 259 | |
| 260 | |
| 261 | def get_profilers(**filter_data): |
| 262 | return rpc_utils.prepare_for_serialization( |
| 263 | models.Profiler.list_objects(filter_data)) |
| 264 | |
| 265 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 266 | # users |
| 267 | |
| 268 | def add_user(login, access_level=None): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 269 | return models.User.add_object(login=login, access_level=access_level).id |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 270 | |
| 271 | |
| 272 | def modify_user(id, **data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 273 | models.User.smart_get(id).update_object(data) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 274 | |
| 275 | |
| 276 | def delete_user(id): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 277 | models.User.smart_get(id).delete() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 278 | |
| 279 | |
| 280 | def get_users(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 281 | return rpc_utils.prepare_for_serialization( |
| 282 | models.User.list_objects(filter_data)) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 283 | |
| 284 | |
| 285 | # acl groups |
| 286 | |
| 287 | def add_acl_group(name, description=None): |
showard | 04f2cd8 | 2008-07-25 20:53:31 +0000 | [diff] [blame] | 288 | group = models.AclGroup.add_object(name=name, description=description) |
| 289 | group.users.add(thread_local.get_user()) |
| 290 | return group.id |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 291 | |
| 292 | |
| 293 | def modify_acl_group(id, **data): |
showard | 04f2cd8 | 2008-07-25 20:53:31 +0000 | [diff] [blame] | 294 | group = models.AclGroup.smart_get(id) |
| 295 | group.check_for_acl_violation_acl_group() |
| 296 | group.update_object(data) |
| 297 | group.add_current_user_if_empty() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 298 | |
| 299 | |
| 300 | def acl_group_add_users(id, users): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 301 | group = models.AclGroup.smart_get(id) |
showard | 04f2cd8 | 2008-07-25 20:53:31 +0000 | [diff] [blame] | 302 | group.check_for_acl_violation_acl_group() |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 303 | users = models.User.smart_get_bulk(users) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 304 | group.users.add(*users) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 305 | |
| 306 | |
| 307 | def acl_group_remove_users(id, users): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 308 | group = models.AclGroup.smart_get(id) |
showard | 04f2cd8 | 2008-07-25 20:53:31 +0000 | [diff] [blame] | 309 | group.check_for_acl_violation_acl_group() |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 310 | users = models.User.smart_get_bulk(users) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 311 | group.users.remove(*users) |
showard | 04f2cd8 | 2008-07-25 20:53:31 +0000 | [diff] [blame] | 312 | group.add_current_user_if_empty() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 313 | |
| 314 | |
| 315 | def acl_group_add_hosts(id, hosts): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 316 | group = models.AclGroup.smart_get(id) |
showard | 04f2cd8 | 2008-07-25 20:53:31 +0000 | [diff] [blame] | 317 | group.check_for_acl_violation_acl_group() |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 318 | hosts = models.Host.smart_get_bulk(hosts) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 319 | group.hosts.add(*hosts) |
showard | 08f981b | 2008-06-24 21:59:03 +0000 | [diff] [blame] | 320 | group.on_host_membership_change() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 321 | |
| 322 | |
| 323 | def acl_group_remove_hosts(id, hosts): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 324 | group = models.AclGroup.smart_get(id) |
showard | 04f2cd8 | 2008-07-25 20:53:31 +0000 | [diff] [blame] | 325 | group.check_for_acl_violation_acl_group() |
showard | be3ec04 | 2008-11-12 18:16:07 +0000 | [diff] [blame] | 326 | hosts = models.Host.smart_get_bulk(hosts) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 327 | group.hosts.remove(*hosts) |
showard | 08f981b | 2008-06-24 21:59:03 +0000 | [diff] [blame] | 328 | group.on_host_membership_change() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 329 | |
| 330 | |
| 331 | def delete_acl_group(id): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 332 | models.AclGroup.smart_get(id).delete() |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 333 | |
| 334 | |
| 335 | def get_acl_groups(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 336 | acl_groups = models.AclGroup.list_objects(filter_data) |
| 337 | for acl_group in acl_groups: |
| 338 | acl_group_obj = models.AclGroup.objects.get(id=acl_group['id']) |
| 339 | acl_group['users'] = [user.login |
| 340 | for user in acl_group_obj.users.all()] |
| 341 | acl_group['hosts'] = [host.hostname |
| 342 | for host in acl_group_obj.hosts.all()] |
| 343 | return rpc_utils.prepare_for_serialization(acl_groups) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 344 | |
| 345 | |
| 346 | # jobs |
| 347 | |
mbligh | 120351e | 2009-01-24 01:40:45 +0000 | [diff] [blame] | 348 | def generate_control_file(tests=(), kernel=None, label=None, profilers=(), |
| 349 | client_control_file='', use_container=False): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 350 | """ |
mbligh | 120351e | 2009-01-24 01:40:45 +0000 | [diff] [blame] | 351 | Generates a client-side control file to load a kernel and run tests. |
| 352 | |
| 353 | @param tests List of tests to run. |
mbligh | a3c58d2 | 2009-08-24 22:01:51 +0000 | [diff] [blame] | 354 | @param kernel A list of kernel info dictionaries configuring which kernels |
| 355 | to boot for this job and other options for them |
mbligh | 120351e | 2009-01-24 01:40:45 +0000 | [diff] [blame] | 356 | @param label Name of label to grab kernel config from. |
| 357 | @param profilers List of profilers to activate during the job. |
| 358 | @param client_control_file The contents of a client-side control file to |
| 359 | run at the end of all tests. If this is supplied, all tests must be |
| 360 | client side. |
| 361 | TODO: in the future we should support server control files directly |
| 362 | to wrap with a kernel. That'll require changing the parameter |
| 363 | name and adding a boolean to indicate if it is a client or server |
| 364 | control file. |
| 365 | @param use_container unused argument today. TODO: Enable containers |
| 366 | on the host during a client side test. |
| 367 | |
| 368 | @returns a dict with the following keys: |
| 369 | control_file: str, The control file text. |
| 370 | is_server: bool, is the control file a server-side control file? |
| 371 | synch_count: How many machines the job uses per autoserv execution. |
| 372 | synch_count == 1 means the job is asynchronous. |
| 373 | dependencies: A list of the names of labels on which the job depends. |
| 374 | """ |
showard | d86debe | 2009-06-10 17:37:56 +0000 | [diff] [blame] | 375 | if not tests and not client_control_file: |
showard | 2bab8f4 | 2008-11-12 18:15:22 +0000 | [diff] [blame] | 376 | return dict(control_file='', is_server=False, synch_count=1, |
showard | 989f25d | 2008-10-01 11:38:11 +0000 | [diff] [blame] | 377 | dependencies=[]) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 378 | |
showard | 989f25d | 2008-10-01 11:38:11 +0000 | [diff] [blame] | 379 | cf_info, test_objects, profiler_objects, label = ( |
showard | 2b9a88b | 2008-06-13 20:55:03 +0000 | [diff] [blame] | 380 | rpc_utils.prepare_generate_control_file(tests, kernel, label, |
| 381 | profilers)) |
showard | 989f25d | 2008-10-01 11:38:11 +0000 | [diff] [blame] | 382 | cf_info['control_file'] = control_file.generate_control( |
mbligh | a3c58d2 | 2009-08-24 22:01:51 +0000 | [diff] [blame] | 383 | tests=test_objects, kernels=kernel, platform=label, |
mbligh | 120351e | 2009-01-24 01:40:45 +0000 | [diff] [blame] | 384 | profilers=profiler_objects, is_server=cf_info['is_server'], |
| 385 | client_control_file=client_control_file) |
showard | 989f25d | 2008-10-01 11:38:11 +0000 | [diff] [blame] | 386 | return cf_info |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 387 | |
| 388 | |
showard | 12f3e32 | 2009-05-13 21:27:42 +0000 | [diff] [blame] | 389 | def create_job(name, priority, control_file, control_type, |
| 390 | hosts=(), meta_hosts=(), one_time_hosts=(), |
| 391 | atomic_group_name=None, synch_count=None, is_template=False, |
| 392 | timeout=None, max_runtime_hrs=None, run_verify=True, |
| 393 | email_list='', dependencies=(), reboot_before=None, |
| 394 | reboot_after=None, parse_failed_repair=None): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 395 | """\ |
| 396 | Create and enqueue a job. |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 397 | |
showard | a1e74b3 | 2009-05-12 17:32:04 +0000 | [diff] [blame] | 398 | @param name name of this job |
| 399 | @param priority Low, Medium, High, Urgent |
| 400 | @param control_file String contents of the control file. |
| 401 | @param control_type Type of control file, Client or Server. |
| 402 | @param synch_count How many machines the job uses per autoserv execution. |
| 403 | synch_count == 1 means the job is asynchronous. If an atomic group is |
| 404 | given this value is treated as a minimum. |
| 405 | @param is_template If true then create a template job. |
| 406 | @param timeout Hours after this call returns until the job times out. |
showard | 12f3e32 | 2009-05-13 21:27:42 +0000 | [diff] [blame] | 407 | @param max_runtime_hrs Hours from job starting time until job times out |
showard | a1e74b3 | 2009-05-12 17:32:04 +0000 | [diff] [blame] | 408 | @param run_verify Should the host be verified before running the test? |
| 409 | @param email_list String containing emails to mail when the job is done |
| 410 | @param dependencies List of label names on which this job depends |
| 411 | @param reboot_before Never, If dirty, or Always |
| 412 | @param reboot_after Never, If all tests passed, or Always |
| 413 | @param parse_failed_repair if true, results of failed repairs launched by |
| 414 | this job will be parsed as part of the job. |
| 415 | |
| 416 | @param hosts List of hosts to run job on. |
| 417 | @param meta_hosts List where each entry is a label name, and for each entry |
| 418 | one host will be chosen from that label to run the job on. |
| 419 | @param one_time_hosts List of hosts not in the database to run the job on. |
| 420 | @param atomic_group_name The name of an atomic group to schedule the job on. |
| 421 | |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 422 | |
| 423 | @returns The created Job id number. |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 424 | """ |
showard | 8765816 | 2009-05-29 18:39:50 +0000 | [diff] [blame] | 425 | user = thread_local.get_user() |
| 426 | owner = user.login |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 427 | # input validation |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 428 | if not (hosts or meta_hosts or one_time_hosts or atomic_group_name): |
mbligh | ec5546d | 2008-06-16 16:51:28 +0000 | [diff] [blame] | 429 | raise model_logic.ValidationError({ |
showard | b8471e3 | 2008-07-03 19:51:08 +0000 | [diff] [blame] | 430 | 'arguments' : "You must pass at least one of 'hosts', " |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 431 | "'meta_hosts', 'one_time_hosts', " |
| 432 | "or 'atomic_group_name'" |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 433 | }) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 434 | |
showard | bc93f0f | 2009-06-10 00:16:21 +0000 | [diff] [blame] | 435 | labels_by_name = dict((label.name, label) |
| 436 | for label in models.Label.objects.all()) |
| 437 | atomic_groups_by_name = dict((ag.name, ag) |
| 438 | for ag in models.AtomicGroup.objects.all()) |
| 439 | |
showard | c873032 | 2009-06-30 01:56:38 +0000 | [diff] [blame] | 440 | # Schedule on an atomic group automagically if one of the labels given |
| 441 | # is an atomic group label and no explicit atomic_group_name was supplied. |
| 442 | if not atomic_group_name: |
| 443 | for label_name in meta_hosts or []: |
| 444 | label = labels_by_name.get(label_name) |
| 445 | if label and label.atomic_group: |
| 446 | atomic_group_name = label.atomic_group.name |
| 447 | break |
| 448 | |
showard | bc93f0f | 2009-06-10 00:16:21 +0000 | [diff] [blame] | 449 | # convert hostnames & meta hosts to host/label objects |
| 450 | host_objects = models.Host.smart_get_bulk(hosts) |
| 451 | metahost_objects = [] |
showard | c873032 | 2009-06-30 01:56:38 +0000 | [diff] [blame] | 452 | for label_name in meta_hosts or []: |
| 453 | if label_name in labels_by_name: |
| 454 | label = labels_by_name[label_name] |
| 455 | metahost_objects.append(label) |
| 456 | elif label_name in atomic_groups_by_name: |
| 457 | # If given a metahost name that isn't a Label, check to |
| 458 | # see if the user was specifying an Atomic Group instead. |
| 459 | atomic_group = atomic_groups_by_name[label_name] |
showard | bc93f0f | 2009-06-10 00:16:21 +0000 | [diff] [blame] | 460 | if atomic_group_name and atomic_group_name != atomic_group.name: |
| 461 | raise model_logic.ValidationError({ |
| 462 | 'meta_hosts': ( |
| 463 | 'Label "%s" not found. If assumed to be an ' |
| 464 | 'atomic group it would conflict with the ' |
| 465 | 'supplied atomic group "%s".' % ( |
showard | c873032 | 2009-06-30 01:56:38 +0000 | [diff] [blame] | 466 | label_name, atomic_group_name))}) |
showard | bc93f0f | 2009-06-10 00:16:21 +0000 | [diff] [blame] | 467 | atomic_group_name = atomic_group.name |
| 468 | else: |
| 469 | raise model_logic.ValidationError( |
| 470 | {'meta_hosts' : 'Label "%s" not found' % label}) |
| 471 | |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 472 | # Create and sanity check an AtomicGroup object if requested. |
| 473 | if atomic_group_name: |
| 474 | if one_time_hosts: |
| 475 | raise model_logic.ValidationError( |
| 476 | {'one_time_hosts': |
| 477 | 'One time hosts cannot be used with an Atomic Group.'}) |
| 478 | atomic_group = models.AtomicGroup.smart_get(atomic_group_name) |
| 479 | if synch_count and synch_count > atomic_group.max_number_of_machines: |
| 480 | raise model_logic.ValidationError( |
| 481 | {'atomic_group_name' : |
| 482 | 'You have requested a synch_count (%d) greater than the ' |
| 483 | 'maximum machines in the requested Atomic Group (%d).' % |
| 484 | (synch_count, atomic_group.max_number_of_machines)}) |
| 485 | else: |
| 486 | atomic_group = None |
| 487 | |
showard | b8471e3 | 2008-07-03 19:51:08 +0000 | [diff] [blame] | 488 | for host in one_time_hosts or []: |
| 489 | this_host = models.Host.create_one_time_host(host) |
| 490 | host_objects.append(this_host) |
showard | ba87290 | 2008-06-28 00:51:08 +0000 | [diff] [blame] | 491 | |
showard | 8765816 | 2009-05-29 18:39:50 +0000 | [diff] [blame] | 492 | if reboot_before is None: |
| 493 | reboot_before = user.get_reboot_before_display() |
| 494 | if reboot_after is None: |
| 495 | reboot_after = user.get_reboot_after_display() |
| 496 | |
showard | a1e74b3 | 2009-05-12 17:32:04 +0000 | [diff] [blame] | 497 | options = dict(name=name, |
| 498 | priority=priority, |
| 499 | control_file=control_file, |
| 500 | control_type=control_type, |
| 501 | is_template=is_template, |
| 502 | timeout=timeout, |
showard | 12f3e32 | 2009-05-13 21:27:42 +0000 | [diff] [blame] | 503 | max_runtime_hrs=max_runtime_hrs, |
showard | a1e74b3 | 2009-05-12 17:32:04 +0000 | [diff] [blame] | 504 | synch_count=synch_count, |
| 505 | run_verify=run_verify, |
| 506 | email_list=email_list, |
| 507 | dependencies=dependencies, |
| 508 | reboot_before=reboot_before, |
| 509 | reboot_after=reboot_after, |
| 510 | parse_failed_repair=parse_failed_repair) |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 511 | return rpc_utils.create_new_job(owner=owner, |
showard | a1e74b3 | 2009-05-12 17:32:04 +0000 | [diff] [blame] | 512 | options=options, |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 513 | host_objects=host_objects, |
| 514 | metahost_objects=metahost_objects, |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 515 | atomic_group=atomic_group) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 516 | |
| 517 | |
showard | 9dbdcda | 2008-10-14 17:34:36 +0000 | [diff] [blame] | 518 | def abort_host_queue_entries(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 519 | """\ |
showard | 9dbdcda | 2008-10-14 17:34:36 +0000 | [diff] [blame] | 520 | Abort a set of host queue entries. |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 521 | """ |
showard | 9dbdcda | 2008-10-14 17:34:36 +0000 | [diff] [blame] | 522 | query = models.HostQueueEntry.query_objects(filter_data) |
showard | 0c18519 | 2009-01-16 03:07:57 +0000 | [diff] [blame] | 523 | query = query.filter(complete=False) |
showard | dc81751 | 2008-11-12 18:16:41 +0000 | [diff] [blame] | 524 | models.AclGroup.check_abort_permissions(query) |
showard | 9dbdcda | 2008-10-14 17:34:36 +0000 | [diff] [blame] | 525 | host_queue_entries = list(query.select_related()) |
showard | 2bab8f4 | 2008-11-12 18:15:22 +0000 | [diff] [blame] | 526 | rpc_utils.check_abort_synchronous_jobs(host_queue_entries) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 527 | |
showard | 9dbdcda | 2008-10-14 17:34:36 +0000 | [diff] [blame] | 528 | user = thread_local.get_user() |
| 529 | for queue_entry in host_queue_entries: |
| 530 | queue_entry.abort(user) |
showard | 9d821ab | 2008-07-11 16:54:29 +0000 | [diff] [blame] | 531 | |
| 532 | |
showard | 1ff7b2e | 2009-05-15 23:17:18 +0000 | [diff] [blame] | 533 | def reverify_hosts(**filter_data): |
| 534 | """\ |
| 535 | Schedules a set of hosts for verify. |
| 536 | """ |
| 537 | hosts = models.Host.query_objects(filter_data) |
| 538 | models.AclGroup.check_for_acl_violation_hosts(hosts) |
showard | 6d7b2ff | 2009-06-10 00:16:47 +0000 | [diff] [blame] | 539 | models.SpecialTask.schedule_special_task(hosts, |
showard | 2fe3f1d | 2009-07-06 20:19:11 +0000 | [diff] [blame] | 540 | models.SpecialTask.Task.VERIFY) |
showard | 1ff7b2e | 2009-05-15 23:17:18 +0000 | [diff] [blame] | 541 | |
| 542 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 543 | def get_jobs(not_yet_run=False, running=False, finished=False, **filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 544 | """\ |
| 545 | Extra filter args for get_jobs: |
| 546 | -not_yet_run: Include only jobs that have not yet started running. |
| 547 | -running: Include only jobs that have start running but for which not |
| 548 | all hosts have completed. |
| 549 | -finished: Include only jobs for which all hosts have completed (or |
| 550 | aborted). |
| 551 | At most one of these three fields should be specified. |
| 552 | """ |
| 553 | filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run, |
| 554 | running, |
| 555 | finished) |
showard | 0957a84 | 2009-05-11 19:25:08 +0000 | [diff] [blame] | 556 | job_dicts = [] |
| 557 | jobs = list(models.Job.query_objects(filter_data)) |
| 558 | models.Job.objects.populate_relationships(jobs, models.Label, |
| 559 | 'dependencies') |
| 560 | for job in jobs: |
| 561 | job_dict = job.get_object_dict() |
| 562 | job_dict['dependencies'] = ','.join(label.name |
| 563 | for label in job.dependencies) |
| 564 | job_dicts.append(job_dict) |
| 565 | return rpc_utils.prepare_for_serialization(job_dicts) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 566 | |
| 567 | |
| 568 | def get_num_jobs(not_yet_run=False, running=False, finished=False, |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 569 | **filter_data): |
| 570 | """\ |
| 571 | See get_jobs() for documentation of extra filter parameters. |
| 572 | """ |
| 573 | filter_data['extra_args'] = rpc_utils.extra_job_filters(not_yet_run, |
| 574 | running, |
| 575 | finished) |
| 576 | return models.Job.query_count(filter_data) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 577 | |
| 578 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 579 | def get_jobs_summary(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 580 | """\ |
showard | a8709c5 | 2008-07-03 19:44:54 +0000 | [diff] [blame] | 581 | Like get_jobs(), but adds a 'status_counts' field, which is a dictionary |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 582 | mapping status strings to the number of hosts currently with that |
| 583 | status, i.e. {'Queued' : 4, 'Running' : 2}. |
| 584 | """ |
| 585 | jobs = get_jobs(**filter_data) |
| 586 | ids = [job['id'] for job in jobs] |
| 587 | all_status_counts = models.Job.objects.get_status_counts(ids) |
| 588 | for job in jobs: |
| 589 | job['status_counts'] = all_status_counts[job['id']] |
| 590 | return rpc_utils.prepare_for_serialization(jobs) |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 591 | |
| 592 | |
showard | a965cef | 2009-05-15 23:17:41 +0000 | [diff] [blame] | 593 | def get_info_for_clone(id, preserve_metahosts, queue_entry_filter_data=None): |
showard | a8709c5 | 2008-07-03 19:44:54 +0000 | [diff] [blame] | 594 | """\ |
| 595 | Retrieves all the information needed to clone a job. |
| 596 | """ |
showard | a8709c5 | 2008-07-03 19:44:54 +0000 | [diff] [blame] | 597 | job = models.Job.objects.get(id=id) |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 598 | job_info = rpc_utils.get_job_info(job, |
showard | a965cef | 2009-05-15 23:17:41 +0000 | [diff] [blame] | 599 | preserve_metahosts, |
| 600 | queue_entry_filter_data) |
showard | 945072f | 2008-09-03 20:34:59 +0000 | [diff] [blame] | 601 | |
showard | d9992fe | 2008-07-31 02:15:03 +0000 | [diff] [blame] | 602 | host_dicts = [] |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 603 | for host in job_info['hosts']: |
| 604 | host_dict = get_hosts(id=host.id)[0] |
| 605 | other_labels = host_dict['labels'] |
| 606 | if host_dict['platform']: |
| 607 | other_labels.remove(host_dict['platform']) |
| 608 | host_dict['other_labels'] = ', '.join(other_labels) |
showard | d9992fe | 2008-07-31 02:15:03 +0000 | [diff] [blame] | 609 | host_dicts.append(host_dict) |
showard | a8709c5 | 2008-07-03 19:44:54 +0000 | [diff] [blame] | 610 | |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 611 | for host in job_info['one_time_hosts']: |
| 612 | host_dict = dict(hostname=host.hostname, |
| 613 | id=host.id, |
| 614 | platform='(one-time host)', |
| 615 | locked_text='') |
| 616 | host_dicts.append(host_dict) |
showard | a8709c5 | 2008-07-03 19:44:54 +0000 | [diff] [blame] | 617 | |
showard | 4d07756 | 2009-05-08 18:24:36 +0000 | [diff] [blame] | 618 | # convert keys from Label objects to strings (names of labels) |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 619 | meta_host_counts = dict((meta_host.name, count) for meta_host, count |
showard | 4d07756 | 2009-05-08 18:24:36 +0000 | [diff] [blame] | 620 | in job_info['meta_host_counts'].iteritems()) |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 621 | |
| 622 | info = dict(job=job.get_object_dict(), |
| 623 | meta_host_counts=meta_host_counts, |
| 624 | hosts=host_dicts) |
| 625 | info['job']['dependencies'] = job_info['dependencies'] |
| 626 | if job_info['atomic_group']: |
| 627 | info['atomic_group_name'] = (job_info['atomic_group']).name |
| 628 | else: |
| 629 | info['atomic_group_name'] = None |
showard | a8709c5 | 2008-07-03 19:44:54 +0000 | [diff] [blame] | 630 | |
| 631 | return rpc_utils.prepare_for_serialization(info) |
| 632 | |
| 633 | |
showard | 34dc5fa | 2008-04-24 20:58:40 +0000 | [diff] [blame] | 634 | # host queue entries |
| 635 | |
| 636 | def get_host_queue_entries(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 637 | """\ |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 638 | @returns A sequence of nested dictionaries of host and job information. |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 639 | """ |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 640 | return rpc_utils.prepare_rows_as_nested_dicts( |
| 641 | models.HostQueueEntry.query_objects(filter_data), |
| 642 | ('host', 'atomic_group', 'job')) |
showard | 34dc5fa | 2008-04-24 20:58:40 +0000 | [diff] [blame] | 643 | |
| 644 | |
| 645 | def get_num_host_queue_entries(**filter_data): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 646 | """\ |
| 647 | Get the number of host queue entries associated with this job. |
| 648 | """ |
| 649 | return models.HostQueueEntry.query_count(filter_data) |
showard | 34dc5fa | 2008-04-24 20:58:40 +0000 | [diff] [blame] | 650 | |
| 651 | |
showard | 1e935f1 | 2008-07-11 00:11:36 +0000 | [diff] [blame] | 652 | def get_hqe_percentage_complete(**filter_data): |
| 653 | """ |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 654 | Computes the fraction of host queue entries matching the given filter data |
showard | 1e935f1 | 2008-07-11 00:11:36 +0000 | [diff] [blame] | 655 | that are complete. |
| 656 | """ |
| 657 | query = models.HostQueueEntry.query_objects(filter_data) |
| 658 | complete_count = query.filter(complete=True).count() |
| 659 | total_count = query.count() |
| 660 | if total_count == 0: |
| 661 | return 1 |
| 662 | return float(complete_count) / total_count |
| 663 | |
| 664 | |
showard | 1a5a408 | 2009-07-28 20:01:37 +0000 | [diff] [blame] | 665 | # special tasks |
| 666 | |
| 667 | def get_special_tasks(**filter_data): |
| 668 | return rpc_utils.prepare_rows_as_nested_dicts( |
| 669 | models.SpecialTask.query_objects(filter_data), |
| 670 | ('host', 'queue_entry')) |
| 671 | |
| 672 | |
showard | c0ac3a7 | 2009-07-08 21:14:45 +0000 | [diff] [blame] | 673 | # support for host detail view |
| 674 | |
| 675 | def get_host_queue_entries_and_special_tasks(hostname, query_start=None, |
| 676 | query_limit=None): |
| 677 | """ |
| 678 | @returns an interleaved list of HostQueueEntries and SpecialTasks, |
| 679 | in approximate run order. each dict contains keys for type, host, |
| 680 | job, status, started_on, execution_path, and ID. |
| 681 | """ |
| 682 | total_limit = None |
| 683 | if query_limit is not None: |
| 684 | total_limit = query_start + query_limit |
| 685 | filter_data = {'host__hostname': hostname, |
| 686 | 'query_limit': total_limit, |
| 687 | 'sort_by': ['-id']} |
| 688 | |
| 689 | queue_entries = list(models.HostQueueEntry.query_objects(filter_data)) |
| 690 | special_tasks = list(models.SpecialTask.query_objects(filter_data)) |
| 691 | |
| 692 | interleaved_entries = rpc_utils.interleave_entries(queue_entries, |
| 693 | special_tasks) |
| 694 | if query_start is not None: |
| 695 | interleaved_entries = interleaved_entries[query_start:] |
| 696 | if query_limit is not None: |
| 697 | interleaved_entries = interleaved_entries[:query_limit] |
| 698 | return rpc_utils.prepare_for_serialization(interleaved_entries) |
| 699 | |
| 700 | |
| 701 | def get_num_host_queue_entries_and_special_tasks(hostname): |
| 702 | filter_data = {'host__hostname': hostname} |
| 703 | return (models.HostQueueEntry.query_count(filter_data) |
| 704 | + models.SpecialTask.query_count(filter_data)) |
| 705 | |
| 706 | |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 707 | # recurring run |
| 708 | |
| 709 | def get_recurring(**filter_data): |
| 710 | return rpc_utils.prepare_rows_as_nested_dicts( |
| 711 | models.RecurringRun.query_objects(filter_data), |
| 712 | ('job', 'owner')) |
| 713 | |
| 714 | |
| 715 | def get_num_recurring(**filter_data): |
| 716 | return models.RecurringRun.query_count(filter_data) |
| 717 | |
| 718 | |
| 719 | def delete_recurring_runs(**filter_data): |
| 720 | to_delete = models.RecurringRun.query_objects(filter_data) |
| 721 | to_delete.delete() |
| 722 | |
| 723 | |
| 724 | def create_recurring_run(job_id, start_date, loop_period, loop_count): |
| 725 | owner = thread_local.get_user().login |
| 726 | job = models.Job.objects.get(id=job_id) |
| 727 | return job.create_recurring_job(start_date=start_date, |
| 728 | loop_period=loop_period, |
| 729 | loop_count=loop_count, |
| 730 | owner=owner) |
| 731 | |
| 732 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 733 | # other |
| 734 | |
showard | e0b6362 | 2008-08-04 20:58:47 +0000 | [diff] [blame] | 735 | def echo(data=""): |
| 736 | """\ |
| 737 | Returns a passed in string. For doing a basic test to see if RPC calls |
| 738 | can successfully be made. |
| 739 | """ |
| 740 | return data |
| 741 | |
| 742 | |
showard | b7a52fd | 2009-04-27 20:10:56 +0000 | [diff] [blame] | 743 | def get_motd(): |
| 744 | """\ |
| 745 | Returns the message of the day as a string. |
| 746 | """ |
| 747 | return rpc_utils.get_motd() |
| 748 | |
| 749 | |
mbligh | e8819cd | 2008-02-15 16:48:40 +0000 | [diff] [blame] | 750 | def get_static_data(): |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 751 | """\ |
| 752 | Returns a dictionary containing a bunch of data that shouldn't change |
| 753 | often and is otherwise inaccessible. This includes: |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 754 | |
| 755 | priorities: List of job priority choices. |
| 756 | default_priority: Default priority value for new jobs. |
| 757 | users: Sorted list of all users. |
| 758 | labels: Sorted list of all labels. |
| 759 | atomic_groups: Sorted list of all atomic groups. |
| 760 | tests: Sorted list of all tests. |
| 761 | profilers: Sorted list of all profilers. |
| 762 | current_user: Logged-in username. |
| 763 | host_statuses: Sorted list of possible Host statuses. |
| 764 | job_statuses: Sorted list of possible HostQueueEntry statuses. |
| 765 | job_timeout_default: The default job timeout length in hours. |
showard | a1e74b3 | 2009-05-12 17:32:04 +0000 | [diff] [blame] | 766 | parse_failed_repair_default: Default value for the parse_failed_repair job |
| 767 | option. |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 768 | reboot_before_options: A list of valid RebootBefore string enums. |
| 769 | reboot_after_options: A list of valid RebootAfter string enums. |
| 770 | motd: Server's message of the day. |
| 771 | status_dictionary: A mapping from one word job status names to a more |
| 772 | informative description. |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 773 | """ |
showard | 21baa45 | 2008-10-21 00:08:39 +0000 | [diff] [blame] | 774 | |
| 775 | job_fields = models.Job.get_field_dict() |
| 776 | |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 777 | result = {} |
| 778 | result['priorities'] = models.Job.Priority.choices() |
showard | 21baa45 | 2008-10-21 00:08:39 +0000 | [diff] [blame] | 779 | default_priority = job_fields['priority'].default |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 780 | default_string = models.Job.Priority.get_string(default_priority) |
| 781 | result['default_priority'] = default_string |
| 782 | result['users'] = get_users(sort_by=['login']) |
| 783 | result['labels'] = get_labels(sort_by=['-platform', 'name']) |
showard | c92da83 | 2009-04-07 18:14:34 +0000 | [diff] [blame] | 784 | result['atomic_groups'] = get_atomic_groups(sort_by=['name']) |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 785 | result['tests'] = get_tests(sort_by=['name']) |
showard | 2b9a88b | 2008-06-13 20:55:03 +0000 | [diff] [blame] | 786 | result['profilers'] = get_profilers(sort_by=['name']) |
showard | 0fc3830 | 2008-10-23 00:44:07 +0000 | [diff] [blame] | 787 | result['current_user'] = rpc_utils.prepare_for_serialization( |
| 788 | thread_local.get_user().get_object_dict()) |
showard | 2b9a88b | 2008-06-13 20:55:03 +0000 | [diff] [blame] | 789 | result['host_statuses'] = sorted(models.Host.Status.names) |
mbligh | 5a198b9 | 2008-12-11 19:33:29 +0000 | [diff] [blame] | 790 | result['job_statuses'] = sorted(models.HostQueueEntry.Status.names) |
showard | b1e5187 | 2008-10-07 11:08:18 +0000 | [diff] [blame] | 791 | result['job_timeout_default'] = models.Job.DEFAULT_TIMEOUT |
showard | 12f3e32 | 2009-05-13 21:27:42 +0000 | [diff] [blame] | 792 | result['job_max_runtime_hrs_default'] = models.Job.DEFAULT_MAX_RUNTIME_HRS |
showard | a1e74b3 | 2009-05-12 17:32:04 +0000 | [diff] [blame] | 793 | result['parse_failed_repair_default'] = bool( |
| 794 | models.Job.DEFAULT_PARSE_FAILED_REPAIR) |
showard | 0fc3830 | 2008-10-23 00:44:07 +0000 | [diff] [blame] | 795 | result['reboot_before_options'] = models.RebootBefore.names |
| 796 | result['reboot_after_options'] = models.RebootAfter.names |
showard | 8fbae65 | 2009-01-20 23:23:10 +0000 | [diff] [blame] | 797 | result['motd'] = rpc_utils.get_motd() |
showard | 8ac29b4 | 2008-07-17 17:01:55 +0000 | [diff] [blame] | 798 | |
showard | d3dc199 | 2009-04-22 21:01:40 +0000 | [diff] [blame] | 799 | result['status_dictionary'] = {"Aborted": "Aborted", |
showard | 8ac29b4 | 2008-07-17 17:01:55 +0000 | [diff] [blame] | 800 | "Verifying": "Verifying Host", |
| 801 | "Pending": "Waiting on other hosts", |
| 802 | "Running": "Running autoserv", |
| 803 | "Completed": "Autoserv completed", |
| 804 | "Failed": "Failed to complete", |
showard | d823b36 | 2008-07-24 16:35:46 +0000 | [diff] [blame] | 805 | "Queued": "Queued", |
showard | 5deb677 | 2008-11-04 21:54:33 +0000 | [diff] [blame] | 806 | "Starting": "Next in host's queue", |
| 807 | "Stopped": "Other host(s) failed verify", |
showard | d3dc199 | 2009-04-22 21:01:40 +0000 | [diff] [blame] | 808 | "Parsing": "Awaiting parse of final results", |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 809 | "Gathering": "Gathering log files", |
showard | 8cc058f | 2009-09-08 16:26:33 +0000 | [diff] [blame^] | 810 | "Template": "Template job for recurring run", |
| 811 | "Waiting": "Waiting for scheduler action"} |
jadmanski | 0afbb63 | 2008-06-06 21:10:57 +0000 | [diff] [blame] | 812 | return result |
showard | 29f7cd2 | 2009-04-29 21:16:24 +0000 | [diff] [blame] | 813 | |
| 814 | |
| 815 | def get_server_time(): |
| 816 | return datetime.datetime.now().strftime("%Y-%m-%d %H:%M") |