Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 1 | # Copyright (c) 2013 The Chromium Authors. All rights reserved. |
| 2 | # Use of this source code is governed by a BSD-style license that can be |
| 3 | # found in the LICENSE file. |
| 4 | |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 5 | |
Fang Deng | 18699fe | 2015-12-04 16:40:27 -0800 | [diff] [blame] | 6 | import grp |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 7 | import httplib |
| 8 | import json |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 9 | import logging |
MK Ryu | 35d661e | 2014-09-25 17:44:10 -0700 | [diff] [blame] | 10 | import os |
beeps | 023afc6 | 2014-02-04 16:59:22 -0800 | [diff] [blame] | 11 | import random |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 12 | import re |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 13 | import time |
Paul Drews | bef578d | 2013-09-24 15:10:36 -0700 | [diff] [blame] | 14 | import urllib2 |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 15 | |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 16 | import common |
beeps | 023afc6 | 2014-02-04 16:59:22 -0800 | [diff] [blame] | 17 | from autotest_lib.client.common_lib import base_utils |
| 18 | from autotest_lib.client.common_lib import error |
| 19 | from autotest_lib.client.common_lib import global_config |
MK Ryu | 0c1a37d | 2015-04-30 12:00:55 -0700 | [diff] [blame] | 20 | from autotest_lib.client.common_lib import host_queue_entry_states |
Simran Basi | 7756a0b | 2016-03-16 13:10:07 -0700 | [diff] [blame] | 21 | from autotest_lib.server.cros import provision |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 22 | from autotest_lib.server.cros.dynamic_suite import constants |
Dan Shi | 7e04fa8 | 2013-07-25 15:08:48 -0700 | [diff] [blame] | 23 | from autotest_lib.server.cros.dynamic_suite import job_status |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 24 | |
Dan Shi | 82997b9 | 2015-05-06 12:08:02 -0700 | [diff] [blame] | 25 | try: |
| 26 | from chromite.lib import cros_build_lib |
| 27 | except ImportError: |
| 28 | logging.warn('Unable to import chromite.') |
| 29 | # Init the module variable to None. Access to this module can check if it |
| 30 | # is not None before making calls. |
| 31 | cros_build_lib = None |
| 32 | |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 33 | |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 34 | _SHERIFF_JS = global_config.global_config.get_config_value( |
| 35 | 'NOTIFICATIONS', 'sheriffs', default='') |
Fang Deng | 3197b39 | 2013-06-26 11:42:02 -0700 | [diff] [blame] | 36 | _LAB_SHERIFF_JS = global_config.global_config.get_config_value( |
| 37 | 'NOTIFICATIONS', 'lab_sheriffs', default='') |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 38 | _CHROMIUM_BUILD_URL = global_config.global_config.get_config_value( |
| 39 | 'NOTIFICATIONS', 'chromium_build_url', default='') |
| 40 | |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 41 | LAB_GOOD_STATES = ('open', 'throttled') |
| 42 | |
| 43 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 44 | class TestLabException(Exception): |
| 45 | """Exception raised when the Test Lab blocks a test or suite.""" |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 46 | pass |
| 47 | |
| 48 | |
| 49 | class ParseBuildNameException(Exception): |
| 50 | """Raised when ParseBuildName() cannot parse a build name.""" |
| 51 | pass |
| 52 | |
| 53 | |
Fang Deng | f08814a | 2015-08-03 18:12:18 +0000 | [diff] [blame] | 54 | class Singleton(type): |
| 55 | """Enforce that only one client class is instantiated per process.""" |
| 56 | _instances = {} |
| 57 | |
| 58 | def __call__(cls, *args, **kwargs): |
| 59 | """Fetch the instance of a class to use for subsequent calls.""" |
| 60 | if cls not in cls._instances: |
| 61 | cls._instances[cls] = super(Singleton, cls).__call__( |
| 62 | *args, **kwargs) |
| 63 | return cls._instances[cls] |
| 64 | |
| 65 | |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 66 | def ParseBuildName(name): |
| 67 | """Format a build name, given board, type, milestone, and manifest num. |
| 68 | |
Simran Basi | b7d2116 | 2014-05-21 15:26:16 -0700 | [diff] [blame] | 69 | @param name: a build name, e.g. 'x86-alex-release/R20-2015.0.0' or a |
| 70 | relative build name, e.g. 'x86-alex-release/LATEST' |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 71 | |
| 72 | @return board: board the manifest is for, e.g. x86-alex. |
| 73 | @return type: one of 'release', 'factory', or 'firmware' |
| 74 | @return milestone: (numeric) milestone the manifest was associated with. |
Simran Basi | b7d2116 | 2014-05-21 15:26:16 -0700 | [diff] [blame] | 75 | Will be None for relative build names. |
| 76 | @return manifest: manifest number, e.g. '2015.0.0'. |
| 77 | Will be None for relative build names. |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 78 | |
| 79 | """ |
Simran Basi | f8f648e | 2014-09-09 11:40:03 -0700 | [diff] [blame] | 80 | match = re.match(r'(trybot-)?(?P<board>[\w-]+)-(?P<type>\w+)/' |
| 81 | r'(R(?P<milestone>\d+)-(?P<manifest>[\d.ab-]+)|LATEST)', |
| 82 | name) |
| 83 | if match and len(match.groups()) >= 5: |
Simran Basi | b7d2116 | 2014-05-21 15:26:16 -0700 | [diff] [blame] | 84 | return (match.group('board'), match.group('type'), |
| 85 | match.group('milestone'), match.group('manifest')) |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 86 | raise ParseBuildNameException('%s is a malformed build name.' % name) |
| 87 | |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 88 | |
Dan Shi | 3d7a0e1 | 2015-10-12 11:55:45 -0700 | [diff] [blame] | 89 | def get_labels_from_afe(hostname, label_prefix, afe): |
| 90 | """Retrieve a host's specific labels from the AFE. |
| 91 | |
| 92 | Looks for the host labels that have the form <label_prefix>:<value> |
| 93 | and returns the "<value>" part of the label. None is returned |
| 94 | if there is not a label matching the pattern |
| 95 | |
| 96 | @param hostname: hostname of given DUT. |
| 97 | @param label_prefix: prefix of label to be matched, e.g., |board:| |
| 98 | @param afe: afe instance. |
| 99 | |
| 100 | @returns A list of labels that match the prefix or 'None' |
| 101 | |
| 102 | """ |
| 103 | labels = afe.get_labels(name__startswith=label_prefix, |
| 104 | host__hostname__in=[hostname]) |
| 105 | if labels: |
| 106 | return [l.name.split(label_prefix, 1)[1] for l in labels] |
| 107 | |
| 108 | |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 109 | def get_label_from_afe(hostname, label_prefix, afe): |
| 110 | """Retrieve a host's specific label from the AFE. |
| 111 | |
| 112 | Looks for a host label that has the form <label_prefix>:<value> |
| 113 | and returns the "<value>" part of the label. None is returned |
| 114 | if there is not a label matching the pattern |
| 115 | |
| 116 | @param hostname: hostname of given DUT. |
| 117 | @param label_prefix: prefix of label to be matched, e.g., |board:| |
| 118 | @param afe: afe instance. |
| 119 | @returns the label that matches the prefix or 'None' |
| 120 | |
| 121 | """ |
Dan Shi | 3d7a0e1 | 2015-10-12 11:55:45 -0700 | [diff] [blame] | 122 | labels = get_labels_from_afe(hostname, label_prefix, afe) |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 123 | if labels and len(labels) == 1: |
Dan Shi | 3d7a0e1 | 2015-10-12 11:55:45 -0700 | [diff] [blame] | 124 | return labels[0] |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 125 | |
| 126 | |
| 127 | def get_board_from_afe(hostname, afe): |
| 128 | """Retrieve given host's board from its labels in the AFE. |
| 129 | |
| 130 | Looks for a host label of the form "board:<board>", and |
| 131 | returns the "<board>" part of the label. `None` is returned |
| 132 | if there is not a single, unique label matching the pattern. |
| 133 | |
| 134 | @param hostname: hostname of given DUT. |
| 135 | @param afe: afe instance. |
| 136 | @returns board from label, or `None`. |
| 137 | |
| 138 | """ |
| 139 | return get_label_from_afe(hostname, constants.BOARD_PREFIX, afe) |
| 140 | |
| 141 | |
| 142 | def get_build_from_afe(hostname, afe): |
| 143 | """Retrieve the current build for given host from the AFE. |
| 144 | |
| 145 | Looks through the host's labels in the AFE to determine its build. |
| 146 | |
| 147 | @param hostname: hostname of given DUT. |
| 148 | @param afe: afe instance. |
| 149 | @returns The current build or None if it could not find it or if there |
| 150 | were multiple build labels assigned to this host. |
| 151 | |
| 152 | """ |
Simran Basi | 7756a0b | 2016-03-16 13:10:07 -0700 | [diff] [blame] | 153 | for prefix in [provision.CROS_VERSION_PREFIX, |
| 154 | provision.ANDROID_BUILD_VERSION_PREFIX]: |
| 155 | build = get_label_from_afe(hostname, prefix + ':', afe) |
| 156 | if build: |
| 157 | return build |
| 158 | return None |
Dan Shi | a1ecd5c | 2013-06-06 11:21:31 -0700 | [diff] [blame] | 159 | |
| 160 | |
Fang Deng | 3197b39 | 2013-06-26 11:42:02 -0700 | [diff] [blame] | 161 | def get_sheriffs(lab_only=False): |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 162 | """ |
| 163 | Polls the javascript file that holds the identity of the sheriff and |
| 164 | parses it's output to return a list of chromium sheriff email addresses. |
| 165 | The javascript file can contain the ldap of more than one sheriff, eg: |
| 166 | document.write('sheriff_one, sheriff_two'). |
| 167 | |
Fang Deng | 3197b39 | 2013-06-26 11:42:02 -0700 | [diff] [blame] | 168 | @param lab_only: if True, only pulls lab sheriff. |
| 169 | @return: A list of chroium.org sheriff email addresses to cc on the bug. |
| 170 | An empty list if failed to parse the javascript. |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 171 | """ |
| 172 | sheriff_ids = [] |
Fang Deng | 3197b39 | 2013-06-26 11:42:02 -0700 | [diff] [blame] | 173 | sheriff_js_list = _LAB_SHERIFF_JS.split(',') |
| 174 | if not lab_only: |
| 175 | sheriff_js_list.extend(_SHERIFF_JS.split(',')) |
| 176 | |
| 177 | for sheriff_js in sheriff_js_list: |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 178 | try: |
| 179 | url_content = base_utils.urlopen('%s%s'% ( |
| 180 | _CHROMIUM_BUILD_URL, sheriff_js)).read() |
| 181 | except (ValueError, IOError) as e: |
beeps | 4efdf03 | 2013-09-17 11:27:14 -0700 | [diff] [blame] | 182 | logging.warning('could not parse sheriff from url %s%s: %s', |
| 183 | _CHROMIUM_BUILD_URL, sheriff_js, str(e)) |
Paul Drews | bef578d | 2013-09-24 15:10:36 -0700 | [diff] [blame] | 184 | except (urllib2.URLError, httplib.HTTPException) as e: |
| 185 | logging.warning('unexpected error reading from url "%s%s": %s', |
| 186 | _CHROMIUM_BUILD_URL, sheriff_js, str(e)) |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 187 | else: |
| 188 | ldaps = re.search(r"document.write\('(.*)'\)", url_content) |
| 189 | if not ldaps: |
beeps | 4efdf03 | 2013-09-17 11:27:14 -0700 | [diff] [blame] | 190 | logging.warning('Could not retrieve sheriff ldaps for: %s', |
| 191 | url_content) |
Alex Miller | dadc2c2 | 2013-07-08 15:21:21 -0700 | [diff] [blame] | 192 | continue |
| 193 | sheriff_ids += ['%s@chromium.org' % alias.replace(' ', '') |
| 194 | for alias in ldaps.group(1).split(',')] |
| 195 | return sheriff_ids |
beeps | 46dadc9 | 2013-11-07 14:07:10 -0800 | [diff] [blame] | 196 | |
| 197 | |
| 198 | def remote_wget(source_url, dest_path, ssh_cmd): |
| 199 | """wget source_url from localhost to dest_path on remote host using ssh. |
| 200 | |
| 201 | @param source_url: The complete url of the source of the package to send. |
| 202 | @param dest_path: The path on the remote host's file system where we would |
| 203 | like to store the package. |
| 204 | @param ssh_cmd: The ssh command to use in performing the remote wget. |
| 205 | """ |
| 206 | wget_cmd = ("wget -O - %s | %s 'cat >%s'" % |
| 207 | (source_url, ssh_cmd, dest_path)) |
| 208 | base_utils.run(wget_cmd) |
| 209 | |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 210 | |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 211 | _MAX_LAB_STATUS_ATTEMPTS = 5 |
| 212 | def _get_lab_status(status_url): |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 213 | """Grabs the current lab status and message. |
| 214 | |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 215 | @returns The JSON object obtained from the given URL. |
| 216 | |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 217 | """ |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 218 | retry_waittime = 1 |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 219 | for _ in range(_MAX_LAB_STATUS_ATTEMPTS): |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 220 | try: |
| 221 | response = urllib2.urlopen(status_url) |
| 222 | except IOError as e: |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 223 | logging.debug('Error occurred when grabbing the lab status: %s.', |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 224 | e) |
| 225 | time.sleep(retry_waittime) |
| 226 | continue |
| 227 | # Check for successful response code. |
| 228 | if response.getcode() == 200: |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 229 | return json.load(response) |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 230 | time.sleep(retry_waittime) |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 231 | return None |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 232 | |
| 233 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 234 | def _decode_lab_status(lab_status, build): |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 235 | """Decode lab status, and report exceptions as needed. |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 236 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 237 | Take a deserialized JSON object from the lab status page, and |
| 238 | interpret it to determine the actual lab status. Raise |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 239 | exceptions as required to report when the lab is down. |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 240 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 241 | @param build: build name that we want to check the status of. |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 242 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 243 | @raises TestLabException Raised if a request to test for the given |
| 244 | status and build should be blocked. |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 245 | """ |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 246 | # First check if the lab is up. |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 247 | if not lab_status['general_state'] in LAB_GOOD_STATES: |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 248 | raise TestLabException('Chromium OS Test Lab is closed: ' |
| 249 | '%s.' % lab_status['message']) |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 250 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 251 | # Check if the build we wish to use is disabled. |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 252 | # Lab messages should be in the format of: |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 253 | # Lab is 'status' [regex ...] (comment) |
| 254 | # If the build name matches any regex, it will be blocked. |
| 255 | build_exceptions = re.search('\[(.*)\]', lab_status['message']) |
Prashanth Balasubramanian | ae43721 | 2014-10-27 11:17:26 -0700 | [diff] [blame] | 256 | if not build_exceptions or not build: |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 257 | return |
| 258 | for build_pattern in build_exceptions.group(1).split(): |
J. Richard Barnette | 7f215d3 | 2015-06-19 12:44:38 -0700 | [diff] [blame] | 259 | if re.match(build_pattern, build): |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 260 | raise TestLabException('Chromium OS Test Lab is closed: ' |
| 261 | '%s matches %s.' % ( |
| 262 | build, build_pattern)) |
J. Richard Barnette | 3cbd76b | 2013-11-27 12:11:25 -0800 | [diff] [blame] | 263 | return |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 264 | |
| 265 | |
Dan Shi | 94234cb | 2014-05-23 20:04:31 -0700 | [diff] [blame] | 266 | def is_in_lab(): |
| 267 | """Check if current Autotest instance is in lab |
| 268 | |
| 269 | @return: True if the Autotest instance is in lab. |
| 270 | """ |
| 271 | test_server_name = global_config.global_config.get_config_value( |
| 272 | 'SERVER', 'hostname') |
| 273 | return test_server_name.startswith('cautotest') |
| 274 | |
| 275 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 276 | def check_lab_status(build): |
| 277 | """Check if the lab status allows us to schedule for a build. |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 278 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 279 | Checks if the lab is down, or if testing for the requested build |
| 280 | should be blocked. |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 281 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 282 | @param build: Name of the build to be scheduled for testing. |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 283 | |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 284 | @raises TestLabException Raised if a request to test for the given |
| 285 | status and build should be blocked. |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 286 | |
| 287 | """ |
| 288 | # Ensure we are trying to schedule on the actual lab. |
Dan Shi | 94234cb | 2014-05-23 20:04:31 -0700 | [diff] [blame] | 289 | if not is_in_lab(): |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 290 | return |
| 291 | |
| 292 | # Download the lab status from its home on the web. |
| 293 | status_url = global_config.global_config.get_config_value( |
| 294 | 'CROS', 'lab_status_url') |
| 295 | json_status = _get_lab_status(status_url) |
| 296 | if json_status is None: |
| 297 | # We go ahead and say the lab is open if we can't get the status. |
Ilja H. Friedel | 04be2bd | 2014-05-07 21:29:59 -0700 | [diff] [blame] | 298 | logging.warning('Could not get a status from %s', status_url) |
J. Richard Barnette | 266da2a | 2013-11-27 15:09:55 -0800 | [diff] [blame] | 299 | return |
J. Richard Barnette | abbe096 | 2013-12-10 18:15:44 -0800 | [diff] [blame] | 300 | _decode_lab_status(json_status, build) |
beeps | 023afc6 | 2014-02-04 16:59:22 -0800 | [diff] [blame] | 301 | |
| 302 | |
| 303 | def lock_host_with_labels(afe, lock_manager, labels): |
| 304 | """Lookup and lock one host that matches the list of input labels. |
| 305 | |
| 306 | @param afe: An instance of the afe class, as defined in server.frontend. |
| 307 | @param lock_manager: A lock manager capable of locking hosts, eg the |
| 308 | one defined in server.cros.host_lock_manager. |
| 309 | @param labels: A list of labels to look for on hosts. |
| 310 | |
| 311 | @return: The hostname of a host matching all labels, and locked through the |
| 312 | lock_manager. The hostname will be as specified in the database the afe |
| 313 | object is associated with, i.e if it exists in afe_hosts with a .cros |
| 314 | suffix, the hostname returned will contain a .cros suffix. |
| 315 | |
| 316 | @raises: error.NoEligibleHostException: If no hosts matching the list of |
| 317 | input labels are available. |
| 318 | @raises: error.TestError: If unable to lock a host matching the labels. |
| 319 | """ |
| 320 | potential_hosts = afe.get_hosts(multiple_labels=labels) |
| 321 | if not potential_hosts: |
| 322 | raise error.NoEligibleHostException( |
| 323 | 'No devices found with labels %s.' % labels) |
| 324 | |
| 325 | # This prevents errors where a fault might seem repeatable |
| 326 | # because we lock, say, the same packet capturer for each test run. |
| 327 | random.shuffle(potential_hosts) |
| 328 | for host in potential_hosts: |
| 329 | if lock_manager.lock([host.hostname]): |
| 330 | logging.info('Locked device %s with labels %s.', |
| 331 | host.hostname, labels) |
| 332 | return host.hostname |
| 333 | else: |
| 334 | logging.info('Unable to lock device %s with labels %s.', |
| 335 | host.hostname, labels) |
| 336 | |
| 337 | raise error.TestError('Could not lock a device with labels %s' % labels) |
Dan Shi | 7e04fa8 | 2013-07-25 15:08:48 -0700 | [diff] [blame] | 338 | |
| 339 | |
| 340 | def get_test_views_from_tko(suite_job_id, tko): |
| 341 | """Get test name and result for given suite job ID. |
| 342 | |
| 343 | @param suite_job_id: ID of suite job. |
| 344 | @param tko: an instance of TKO as defined in server/frontend.py. |
| 345 | @return: A dictionary of test status keyed by test name, e.g., |
| 346 | {'dummy_Fail.Error': 'ERROR', 'dummy_Fail.NAError': 'TEST_NA'} |
| 347 | @raise: Exception when there is no test view found. |
| 348 | |
| 349 | """ |
| 350 | views = tko.run('get_detailed_test_views', afe_job_id=suite_job_id) |
| 351 | relevant_views = filter(job_status.view_is_relevant, views) |
| 352 | if not relevant_views: |
| 353 | raise Exception('Failed to retrieve job results.') |
| 354 | |
| 355 | test_views = {} |
| 356 | for view in relevant_views: |
| 357 | test_views[view['test_name']] = view['status'] |
| 358 | |
| 359 | return test_views |
MK Ryu | 35d661e | 2014-09-25 17:44:10 -0700 | [diff] [blame] | 360 | |
| 361 | |
MK Ryu | c9c0c3f | 2014-10-27 14:36:01 -0700 | [diff] [blame] | 362 | def get_data_key(prefix, suite, build, board): |
| 363 | """ |
| 364 | Constructs a key string from parameters. |
| 365 | |
| 366 | @param prefix: Prefix for the generating key. |
| 367 | @param suite: a suite name. e.g., bvt-cq, bvt-inline, dummy |
| 368 | @param build: The build string. This string should have a consistent |
| 369 | format eg: x86-mario-release/R26-3570.0.0. If the format of this |
| 370 | string changes such that we can't determine build_type or branch |
| 371 | we give up and use the parametes we're sure of instead (suite, |
| 372 | board). eg: |
| 373 | 1. build = x86-alex-pgo-release/R26-3570.0.0 |
| 374 | branch = 26 |
| 375 | build_type = pgo-release |
| 376 | 2. build = lumpy-paladin/R28-3993.0.0-rc5 |
| 377 | branch = 28 |
| 378 | build_type = paladin |
| 379 | @param board: The board that this suite ran on. |
| 380 | @return: The key string used for a dictionary. |
| 381 | """ |
| 382 | try: |
| 383 | _board, build_type, branch = ParseBuildName(build)[:3] |
| 384 | except ParseBuildNameException as e: |
| 385 | logging.error(str(e)) |
| 386 | branch = 'Unknown' |
| 387 | build_type = 'Unknown' |
| 388 | else: |
| 389 | embedded_str = re.search(r'x86-\w+-(.*)', _board) |
| 390 | if embedded_str: |
| 391 | build_type = embedded_str.group(1) + '-' + build_type |
| 392 | |
| 393 | data_key_dict = { |
| 394 | 'prefix': prefix, |
| 395 | 'board': board, |
| 396 | 'branch': branch, |
| 397 | 'build_type': build_type, |
| 398 | 'suite': suite, |
| 399 | } |
| 400 | return ('%(prefix)s.%(board)s.%(build_type)s.%(branch)s.%(suite)s' |
| 401 | % data_key_dict) |
MK Ryu | 8318435 | 2014-12-10 14:59:40 -0800 | [diff] [blame] | 402 | |
| 403 | |
MK Ryu | 2d0a364 | 2015-01-07 15:11:19 -0800 | [diff] [blame] | 404 | def setup_logging(logfile=None, prefix=False): |
MK Ryu | 8318435 | 2014-12-10 14:59:40 -0800 | [diff] [blame] | 405 | """Setup basic logging with all logging info stripped. |
| 406 | |
| 407 | Calls to logging will only show the message. No severity is logged. |
| 408 | |
| 409 | @param logfile: If specified dump output to a file as well. |
MK Ryu | 2d0a364 | 2015-01-07 15:11:19 -0800 | [diff] [blame] | 410 | @param prefix: Flag for log prefix. Set to True to add prefix to log |
| 411 | entries to include timestamp and log level. Default is False. |
MK Ryu | 8318435 | 2014-12-10 14:59:40 -0800 | [diff] [blame] | 412 | """ |
| 413 | # Remove all existing handlers. client/common_lib/logging_config adds |
| 414 | # a StreamHandler to logger when modules are imported, e.g., |
| 415 | # autotest_lib.client.bin.utils. A new StreamHandler will be added here to |
| 416 | # log only messages, not severity. |
| 417 | logging.getLogger().handlers = [] |
| 418 | |
MK Ryu | 2d0a364 | 2015-01-07 15:11:19 -0800 | [diff] [blame] | 419 | if prefix: |
| 420 | log_format = '%(asctime)s %(levelname)-5s| %(message)s' |
| 421 | else: |
| 422 | log_format = '%(message)s' |
| 423 | |
MK Ryu | 8318435 | 2014-12-10 14:59:40 -0800 | [diff] [blame] | 424 | screen_handler = logging.StreamHandler() |
MK Ryu | 2d0a364 | 2015-01-07 15:11:19 -0800 | [diff] [blame] | 425 | screen_handler.setFormatter(logging.Formatter(log_format)) |
MK Ryu | 8318435 | 2014-12-10 14:59:40 -0800 | [diff] [blame] | 426 | logging.getLogger().addHandler(screen_handler) |
| 427 | logging.getLogger().setLevel(logging.INFO) |
| 428 | if logfile: |
| 429 | file_handler = logging.FileHandler(logfile) |
MK Ryu | 2d0a364 | 2015-01-07 15:11:19 -0800 | [diff] [blame] | 430 | file_handler.setFormatter(logging.Formatter(log_format)) |
MK Ryu | 8318435 | 2014-12-10 14:59:40 -0800 | [diff] [blame] | 431 | file_handler.setLevel(logging.DEBUG) |
| 432 | logging.getLogger().addHandler(file_handler) |
Prashanth Balasubramanian | 8c98ac1 | 2014-12-23 11:26:44 -0800 | [diff] [blame] | 433 | |
| 434 | |
| 435 | def is_shard(): |
| 436 | """Determines if this instance is running as a shard. |
| 437 | |
| 438 | Reads the global_config value shard_hostname in the section SHARD. |
| 439 | |
| 440 | @return True, if shard_hostname is set, False otherwise. |
| 441 | """ |
| 442 | hostname = global_config.global_config.get_config_value( |
| 443 | 'SHARD', 'shard_hostname', default=None) |
MK Ryu | 0c1a37d | 2015-04-30 12:00:55 -0700 | [diff] [blame] | 444 | return bool(hostname) |
| 445 | |
| 446 | |
Fang Deng | 0cb2a3b | 2015-12-10 17:59:00 -0800 | [diff] [blame] | 447 | def get_global_afe_hostname(): |
| 448 | """Read the hostname of the global AFE from the global configuration.""" |
| 449 | return global_config.global_config.get_config_value( |
| 450 | 'SERVER', 'global_afe_hostname') |
| 451 | |
| 452 | |
Fang Deng | 18699fe | 2015-12-04 16:40:27 -0800 | [diff] [blame] | 453 | def is_restricted_user(username): |
| 454 | """Determines if a user is in a restricted group. |
| 455 | |
| 456 | User in restricted group only have access to master. |
| 457 | |
| 458 | @param username: A string, representing a username. |
| 459 | |
| 460 | @returns: True if the user is in a restricted group. |
| 461 | """ |
| 462 | if not username: |
| 463 | return False |
| 464 | |
| 465 | restricted_groups = global_config.global_config.get_config_value( |
| 466 | 'AUTOTEST_WEB', 'restricted_groups', default='').split(',') |
| 467 | for group in restricted_groups: |
Fang Deng | 5229c85 | 2016-02-09 13:30:31 -0800 | [diff] [blame] | 468 | try: |
| 469 | if group and username in grp.getgrnam(group).gr_mem: |
| 470 | return True |
| 471 | except KeyError as e: |
| 472 | logging.debug("%s is not a valid group.", group) |
Fang Deng | 18699fe | 2015-12-04 16:40:27 -0800 | [diff] [blame] | 473 | return False |
| 474 | |
| 475 | |
MK Ryu | 0c1a37d | 2015-04-30 12:00:55 -0700 | [diff] [blame] | 476 | def get_special_task_status(is_complete, success, is_active): |
| 477 | """Get the status of a special task. |
| 478 | |
| 479 | Emulate a host queue entry status for a special task |
| 480 | Although SpecialTasks are not HostQueueEntries, it is helpful to |
| 481 | the user to present similar statuses. |
| 482 | |
| 483 | @param is_complete Boolean if the task is completed. |
| 484 | @param success Boolean if the task succeeded. |
| 485 | @param is_active Boolean if the task is active. |
| 486 | |
| 487 | @return The status of a special task. |
| 488 | """ |
| 489 | if is_complete: |
| 490 | if success: |
| 491 | return host_queue_entry_states.Status.COMPLETED |
| 492 | return host_queue_entry_states.Status.FAILED |
| 493 | if is_active: |
| 494 | return host_queue_entry_states.Status.RUNNING |
| 495 | return host_queue_entry_states.Status.QUEUED |
| 496 | |
| 497 | |
| 498 | def get_special_task_exec_path(hostname, task_id, task_name, time_requested): |
| 499 | """Get the execution path of the SpecialTask. |
| 500 | |
| 501 | This method returns different paths depending on where a |
| 502 | the task ran: |
| 503 | * Master: hosts/hostname/task_id-task_type |
| 504 | * Shard: Master_path/time_created |
| 505 | This is to work around the fact that a shard can fail independent |
| 506 | of the master, and be replaced by another shard that has the same |
| 507 | hosts. Without the time_created stamp the logs of the tasks running |
| 508 | on the second shard will clobber the logs from the first in google |
| 509 | storage, because task ids are not globally unique. |
| 510 | |
| 511 | @param hostname Hostname |
| 512 | @param task_id Special task id |
| 513 | @param task_name Special task name (e.g., Verify, Repair, etc) |
| 514 | @param time_requested Special task requested time. |
| 515 | |
| 516 | @return An execution path for the task. |
| 517 | """ |
| 518 | results_path = 'hosts/%s/%s-%s' % (hostname, task_id, task_name.lower()) |
| 519 | |
| 520 | # If we do this on the master it will break backward compatibility, |
| 521 | # as there are tasks that currently don't have timestamps. If a host |
| 522 | # or job has been sent to a shard, the rpc for that host/job will |
| 523 | # be redirected to the shard, so this global_config check will happen |
| 524 | # on the shard the logs are on. |
| 525 | if not is_shard(): |
| 526 | return results_path |
| 527 | |
| 528 | # Generate a uid to disambiguate special task result directories |
| 529 | # in case this shard fails. The simplest uid is the job_id, however |
| 530 | # in rare cases tasks do not have jobs associated with them (eg: |
| 531 | # frontend verify), so just use the creation timestamp. The clocks |
| 532 | # between a shard and master should always be in sync. Any discrepancies |
| 533 | # will be brought to our attention in the form of job timeouts. |
| 534 | uid = time_requested.strftime('%Y%d%m%H%M%S') |
| 535 | |
| 536 | # TODO: This is a hack, however it is the easiest way to achieve |
| 537 | # correctness. There is currently some debate over the future of |
| 538 | # tasks in our infrastructure and refactoring everything right |
| 539 | # now isn't worth the time. |
| 540 | return '%s/%s' % (results_path, uid) |
| 541 | |
| 542 | |
| 543 | def get_job_tag(id, owner): |
| 544 | """Returns a string tag for a job. |
| 545 | |
| 546 | @param id Job id |
| 547 | @param owner Job owner |
| 548 | |
| 549 | """ |
| 550 | return '%s-%s' % (id, owner) |
| 551 | |
| 552 | |
| 553 | def get_hqe_exec_path(tag, execution_subdir): |
| 554 | """Returns a execution path to a HQE's results. |
| 555 | |
| 556 | @param tag Tag string for a job associated with a HQE. |
| 557 | @param execution_subdir Execution sub-directory string of a HQE. |
| 558 | |
| 559 | """ |
| 560 | return os.path.join(tag, execution_subdir) |
Dan Shi | 82997b9 | 2015-05-06 12:08:02 -0700 | [diff] [blame] | 561 | |
| 562 | |
| 563 | def is_inside_chroot(): |
| 564 | """Check if the process is running inside chroot. |
| 565 | |
| 566 | This is a wrapper around chromite.lib.cros_build_lib.IsInsideChroot(). The |
| 567 | method checks if cros_build_lib can be imported first. |
| 568 | |
| 569 | @return: True if the process is running inside chroot or cros_build_lib |
| 570 | cannot be imported. |
| 571 | |
| 572 | """ |
J. Richard Barnette | 7f215d3 | 2015-06-19 12:44:38 -0700 | [diff] [blame] | 573 | return not cros_build_lib or cros_build_lib.IsInsideChroot() |
Dan Shi | 70647ca | 2015-07-16 22:52:35 -0700 | [diff] [blame] | 574 | |
| 575 | |
| 576 | def parse_job_name(name): |
| 577 | """Parse job name to get information including build, board and suite etc. |
| 578 | |
| 579 | Suite job created by run_suite follows the naming convention of: |
| 580 | [build]-test_suites/control.[suite] |
| 581 | For example: lumpy-release/R46-7272.0.0-test_suites/control.bvt |
| 582 | The naming convention is defined in site_rpc_interface.create_suite_job. |
| 583 | |
| 584 | Test job created by suite job follows the naming convention of: |
| 585 | [build]/[suite]/[test name] |
| 586 | For example: lumpy-release/R46-7272.0.0/bvt/login_LoginSuccess |
| 587 | The naming convention is defined in |
| 588 | server/cros/dynamic_suite/tools.create_job_name |
| 589 | |
| 590 | Note that pgo and chrome-perf builds will fail the method. Since lab does |
| 591 | not run test for these builds, they can be ignored. |
| 592 | |
| 593 | @param name: Name of the job. |
| 594 | |
| 595 | @return: A dictionary containing the test information. The keyvals include: |
| 596 | build: Name of the build, e.g., lumpy-release/R46-7272.0.0 |
| 597 | build_version: The version of the build, e.g., R46-7272.0.0 |
| 598 | board: Name of the board, e.g., lumpy |
| 599 | suite: Name of the test suite, e.g., bvt |
| 600 | |
| 601 | """ |
| 602 | info = {} |
| 603 | suite_job_regex = '([^/]*/[^/]*)-test_suites/control\.(.*)' |
| 604 | test_job_regex = '([^/]*/[^/]*)/([^/]+)/.*' |
| 605 | match = re.match(suite_job_regex, name) |
| 606 | if not match: |
| 607 | match = re.match(test_job_regex, name) |
| 608 | if match: |
| 609 | info['build'] = match.groups()[0] |
| 610 | info['suite'] = match.groups()[1] |
| 611 | info['build_version'] = info['build'].split('/')[1] |
| 612 | try: |
| 613 | info['board'], _, _, _ = ParseBuildName(info['build']) |
| 614 | except ParseBuildNameException: |
| 615 | pass |
| 616 | return info |
Kevin Cheng | 3a4a57a | 2015-09-30 12:09:50 -0700 | [diff] [blame] | 617 | |
| 618 | |
| 619 | def add_label_detector(label_function_list, label_list=None, label=None): |
| 620 | """Decorator used to group functions together into the provided list. |
| 621 | |
| 622 | This is a helper function to automatically add label functions that have |
| 623 | the label decorator. This is to help populate the class list of label |
| 624 | functions to be retrieved by the get_labels class method. |
| 625 | |
| 626 | @param label_function_list: List of label detecting functions to add |
| 627 | decorated function to. |
| 628 | @param label_list: List of detectable labels to add detectable labels to. |
| 629 | (Default: None) |
| 630 | @param label: Label string that is detectable by this detection function |
| 631 | (Default: None) |
| 632 | """ |
| 633 | def add_func(func): |
| 634 | """ |
| 635 | @param func: The function to be added as a detector. |
| 636 | """ |
| 637 | label_function_list.append(func) |
| 638 | if label and label_list is not None: |
| 639 | label_list.append(label) |
| 640 | return func |
| 641 | return add_func |
Simran Basi | 9f364a6 | 2015-12-07 14:15:19 -0800 | [diff] [blame] | 642 | |
| 643 | |
| 644 | def verify_not_root_user(): |
| 645 | """Simple function to error out if running with uid == 0""" |
| 646 | if os.getuid() == 0: |
Simran Basi | 1bf60eb | 2015-12-01 16:39:29 -0800 | [diff] [blame] | 647 | raise error.IllegalUser('This script can not be ran as root.') |
| 648 | |
| 649 | |
| 650 | def get_hostname_from_machine(machine): |
| 651 | """Lookup hostname from a machine string or dict. |
| 652 | |
| 653 | @returns: Machine hostname in string format. |
| 654 | """ |
| 655 | hostname, _ = get_host_info_from_machine(machine) |
| 656 | return hostname |
| 657 | |
| 658 | |
| 659 | def get_host_info_from_machine(machine): |
| 660 | """Lookup host information from a machine string or dict. |
| 661 | |
| 662 | @returns: Tuple of (hostname, host_attributes) |
| 663 | """ |
| 664 | if isinstance(machine, dict): |
| 665 | return (machine['hostname'], machine['host_attributes']) |
| 666 | else: |
| 667 | return (machine, {}) |
Fang Deng | f8a94e2 | 2015-12-07 13:39:13 -0800 | [diff] [blame] | 668 | |
| 669 | |
| 670 | def get_creds_abspath(creds_file): |
| 671 | """Returns the abspath of the credentials file. |
| 672 | |
| 673 | If creds_file is already an absolute path, just return it. |
| 674 | Otherwise, assume it is located in the creds directory |
| 675 | specified in global_config and return the absolute path. |
| 676 | |
| 677 | @param: creds_path, a path to the credentials. |
| 678 | @return: An absolute path to the credentials file. |
| 679 | """ |
| 680 | if not creds_file: |
| 681 | return None |
| 682 | if os.path.isabs(creds_file): |
| 683 | return creds_file |
| 684 | creds_dir = global_config.global_config.get_config_value( |
| 685 | 'SERVER', 'creds_dir', default='') |
| 686 | if not creds_dir or not os.path.exists(creds_dir): |
| 687 | creds_dir = common.autotest_dir |
| 688 | return os.path.join(creds_dir, creds_file) |
Kevin Cheng | 3b11181 | 2015-12-15 11:52:08 -0800 | [diff] [blame] | 689 | |
| 690 | |
| 691 | def machine_is_testbed(machine): |
| 692 | """Checks if the machine is a testbed. |
| 693 | |
| 694 | The signal we use to determine if the machine is a testbed |
| 695 | is if the host attributes contain more than 1 serial. |
| 696 | |
| 697 | @param machine: is a list of dicts |
| 698 | |
| 699 | @return: True if the machine is a testbed, False otherwise. |
| 700 | """ |
| 701 | _, attributes = get_host_info_from_machine(machine) |
| 702 | if len(attributes.get('serials', '').split(',')) > 1: |
| 703 | return True |
| 704 | return False |