J. Richard Barnette | 24adbf4 | 2012-04-11 15:04:53 -0700 | [diff] [blame] | 1 | # Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Dale Curtis | aa5eedb | 2011-08-23 16:18:52 -0700 | [diff] [blame] | 2 | # Use of this source code is governed by a BSD-style license that can be |
| 3 | # found in the LICENSE file. |
| 4 | |
Aviv Keshet | 74c89a9 | 2013-02-04 15:18:30 -0800 | [diff] [blame] | 5 | import functools |
Christopher Wiley | 0ed712b | 2013-04-09 15:25:12 -0700 | [diff] [blame] | 6 | import httplib |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 7 | import logging |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 8 | import os |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 9 | import re |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 10 | import socket |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 11 | import subprocess |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 12 | import time |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 13 | import xmlrpclib |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 14 | |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 15 | from autotest_lib.client.bin import utils |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 16 | from autotest_lib.client.common_lib import error |
| 17 | from autotest_lib.client.common_lib import global_config |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 18 | from autotest_lib.client.common_lib.cros import autoupdater |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 19 | from autotest_lib.client.common_lib.cros import dev_server |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 20 | from autotest_lib.client.common_lib.cros import retry |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 21 | from autotest_lib.client.cros import constants |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 22 | from autotest_lib.server import autoserv_parser |
Chris Sosa | f4d43ff | 2012-10-30 11:21:05 -0700 | [diff] [blame] | 23 | from autotest_lib.server import autotest |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 24 | from autotest_lib.server import site_host_attributes |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 25 | from autotest_lib.server.cros.dynamic_suite import constants as ds_constants |
Simran Basi | 5e6339a | 2013-03-21 11:34:32 -0700 | [diff] [blame] | 26 | from autotest_lib.server.cros.dynamic_suite import tools, frontend_wrappers |
J. Richard Barnette | 7548757 | 2013-03-08 12:47:50 -0800 | [diff] [blame] | 27 | from autotest_lib.server.cros.servo import servo |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 28 | from autotest_lib.server.hosts import remote |
Simran Basi | dcff425 | 2012-11-20 16:13:20 -0800 | [diff] [blame] | 29 | from autotest_lib.site_utils.rpm_control_system import rpm_client |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 30 | |
| 31 | |
J. Richard Barnette | be5ebcc | 2013-02-11 16:03:15 -0800 | [diff] [blame] | 32 | def _make_servo_hostname(hostname): |
| 33 | host_parts = hostname.split('.') |
| 34 | host_parts[0] = host_parts[0] + '-servo' |
| 35 | return '.'.join(host_parts) |
| 36 | |
| 37 | |
| 38 | def _get_lab_servo(target_hostname): |
| 39 | """Instantiate a Servo for |target_hostname| in the lab. |
| 40 | |
| 41 | Assuming that |target_hostname| is a device in the CrOS test |
| 42 | lab, create and return a Servo object pointed at the servo |
| 43 | attached to that DUT. The servo in the test lab is assumed |
| 44 | to already have servod up and running on it. |
| 45 | |
| 46 | @param target_hostname: device whose servo we want to target. |
| 47 | @return an appropriately configured Servo instance. |
| 48 | """ |
| 49 | servo_host = _make_servo_hostname(target_hostname) |
| 50 | if utils.host_is_in_lab_zone(servo_host): |
| 51 | try: |
J. Richard Barnette | d5f807a | 2013-02-11 16:51:00 -0800 | [diff] [blame] | 52 | return servo.Servo(servo_host=servo_host) |
J. Richard Barnette | be5ebcc | 2013-02-11 16:03:15 -0800 | [diff] [blame] | 53 | except: # pylint: disable=W0702 |
| 54 | # TODO(jrbarnette): Long-term, if we can't get to |
| 55 | # a servo in the lab, we want to fail, so we should |
| 56 | # pass any exceptions along. Short-term, we're not |
| 57 | # ready to rely on servo, so we ignore failures. |
| 58 | pass |
| 59 | return None |
| 60 | |
| 61 | |
Dale Curtis | cb7bfaf | 2011-06-07 16:21:57 -0700 | [diff] [blame] | 62 | def make_ssh_command(user='root', port=22, opts='', hosts_file=None, |
| 63 | connect_timeout=None, alive_interval=None): |
| 64 | """Override default make_ssh_command to use options tuned for Chrome OS. |
| 65 | |
| 66 | Tuning changes: |
Chris Sosa | f7fcd6e | 2011-09-27 17:30:47 -0700 | [diff] [blame] | 67 | - ConnectTimeout=30; maximum of 30 seconds allowed for an SSH connection |
| 68 | failure. Consistency with remote_access.sh. |
Dale Curtis | cb7bfaf | 2011-06-07 16:21:57 -0700 | [diff] [blame] | 69 | |
Dale Curtis | aa5eedb | 2011-08-23 16:18:52 -0700 | [diff] [blame] | 70 | - ServerAliveInterval=180; which causes SSH to ping connection every |
| 71 | 180 seconds. In conjunction with ServerAliveCountMax ensures that if the |
| 72 | connection dies, Autotest will bail out quickly. Originally tried 60 secs, |
| 73 | but saw frequent job ABORTS where the test completed successfully. |
Dale Curtis | cb7bfaf | 2011-06-07 16:21:57 -0700 | [diff] [blame] | 74 | |
Chris Sosa | f7fcd6e | 2011-09-27 17:30:47 -0700 | [diff] [blame] | 75 | - ServerAliveCountMax=3; consistency with remote_access.sh. |
| 76 | |
| 77 | - ConnectAttempts=4; reduce flakiness in connection errors; consistency |
| 78 | with remote_access.sh. |
Dale Curtis | cb7bfaf | 2011-06-07 16:21:57 -0700 | [diff] [blame] | 79 | |
| 80 | - UserKnownHostsFile=/dev/null; we don't care about the keys. Host keys |
| 81 | change with every new installation, don't waste memory/space saving them. |
Chris Sosa | f7fcd6e | 2011-09-27 17:30:47 -0700 | [diff] [blame] | 82 | |
| 83 | - SSH protocol forced to 2; needed for ServerAliveInterval. |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 84 | |
| 85 | @param user User name to use for the ssh connection. |
| 86 | @param port Port on the target host to use for ssh connection. |
| 87 | @param opts Additional options to the ssh command. |
| 88 | @param hosts_file Ignored. |
| 89 | @param connect_timeout Ignored. |
| 90 | @param alive_interval Ignored. |
Dale Curtis | cb7bfaf | 2011-06-07 16:21:57 -0700 | [diff] [blame] | 91 | """ |
| 92 | base_command = ('/usr/bin/ssh -a -x %s -o StrictHostKeyChecking=no' |
| 93 | ' -o UserKnownHostsFile=/dev/null -o BatchMode=yes' |
Chris Sosa | f7fcd6e | 2011-09-27 17:30:47 -0700 | [diff] [blame] | 94 | ' -o ConnectTimeout=30 -o ServerAliveInterval=180' |
| 95 | ' -o ServerAliveCountMax=3 -o ConnectionAttempts=4' |
| 96 | ' -o Protocol=2 -l %s -p %d') |
Dale Curtis | cb7bfaf | 2011-06-07 16:21:57 -0700 | [diff] [blame] | 97 | return base_command % (opts, user, port) |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 98 | |
| 99 | |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 100 | |
Aviv Keshet | 74c89a9 | 2013-02-04 15:18:30 -0800 | [diff] [blame] | 101 | def add_label_detector(label_function_list, label_list=None, label=None): |
| 102 | """Decorator used to group functions together into the provided list. |
| 103 | @param label_function_list: List of label detecting functions to add |
| 104 | decorated function to. |
| 105 | @param label_list: List of detectable labels to add detectable labels to. |
| 106 | (Default: None) |
| 107 | @param label: Label string that is detectable by this detection function |
| 108 | (Default: None) |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 109 | """ |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 110 | def add_func(func): |
Aviv Keshet | 74c89a9 | 2013-02-04 15:18:30 -0800 | [diff] [blame] | 111 | """ |
| 112 | @param func: The function to be added as a detector. |
| 113 | """ |
| 114 | label_function_list.append(func) |
| 115 | if label and label_list is not None: |
| 116 | label_list.append(label) |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 117 | return func |
| 118 | return add_func |
| 119 | |
| 120 | |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 121 | class SiteHost(remote.RemoteHost): |
| 122 | """Chromium OS specific subclass of Host.""" |
| 123 | |
| 124 | _parser = autoserv_parser.autoserv_parser |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 125 | _AFE = frontend_wrappers.RetryingAFE(timeout_min=5, delay_sec=10) |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 126 | |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 127 | # Time to wait for new kernel to be marked successful after |
| 128 | # auto update. |
Chris Masone | 163cead | 2012-05-16 11:49:48 -0700 | [diff] [blame] | 129 | _KERNEL_UPDATE_TIMEOUT = 120 |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 130 | |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 131 | # Timeout values (in seconds) associated with various Chrome OS |
| 132 | # state changes. |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 133 | # |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 134 | # In general, a good rule of thumb is that the timeout can be up |
| 135 | # to twice the typical measured value on the slowest platform. |
| 136 | # The times here have not necessarily been empirically tested to |
| 137 | # meet this criterion. |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 138 | # |
| 139 | # SLEEP_TIMEOUT: Time to allow for suspend to memory. |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 140 | # RESUME_TIMEOUT: Time to allow for resume after suspend, plus |
| 141 | # time to restart the netwowrk. |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 142 | # BOOT_TIMEOUT: Time to allow for boot from power off. Among |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 143 | # other things, this must account for the 30 second dev-mode |
J. Richard Barnette | d4649c6 | 2013-03-06 17:42:27 -0800 | [diff] [blame] | 144 | # screen delay and time to start the network. |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 145 | # USB_BOOT_TIMEOUT: Time to allow for boot from a USB device, |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 146 | # including the 30 second dev-mode delay and time to start the |
J. Richard Barnette | d4649c6 | 2013-03-06 17:42:27 -0800 | [diff] [blame] | 147 | # network. |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 148 | # SHUTDOWN_TIMEOUT: Time to allow for shut down. |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 149 | # REBOOT_TIMEOUT: How long to wait for a reboot. |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 150 | # _INSTALL_TIMEOUT: Time to allow for chromeos-install. |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 151 | |
| 152 | SLEEP_TIMEOUT = 2 |
J. Richard Barnette | d4649c6 | 2013-03-06 17:42:27 -0800 | [diff] [blame] | 153 | RESUME_TIMEOUT = 10 |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 154 | BOOT_TIMEOUT = 45 |
| 155 | USB_BOOT_TIMEOUT = 150 |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 156 | |
| 157 | # We have a long timeout to ensure we don't flakily fail due to other |
| 158 | # issues. Shorter timeouts are vetted in platform_RebootAfterUpdate. |
| 159 | REBOOT_TIMEOUT = 300 |
| 160 | |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 161 | _INSTALL_TIMEOUT = 240 |
| 162 | |
Ismail Noorbasha | 07fdb61 | 2013-02-14 14:13:31 -0800 | [diff] [blame] | 163 | # _USB_POWER_TIMEOUT: Time to allow for USB to power toggle ON and OFF. |
| 164 | # _POWER_CYCLE_TIMEOUT: Time to allow for manual power cycle. |
| 165 | _USB_POWER_TIMEOUT = 5 |
| 166 | _POWER_CYCLE_TIMEOUT = 10 |
| 167 | |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 168 | |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 169 | _RPM_RECOVERY_BOARDS = global_config.global_config.get_config_value('CROS', |
| 170 | 'rpm_recovery_boards', type=str).split(',') |
| 171 | |
| 172 | _MAX_POWER_CYCLE_ATTEMPTS = 6 |
| 173 | _LAB_MACHINE_FILE = '/mnt/stateful_partition/.labmachine' |
| 174 | _RPM_HOSTNAME_REGEX = ('chromeos[0-9]+(-row[0-9]+)?-rack[0-9]+[a-z]*-' |
| 175 | 'host[0-9]+') |
| 176 | _LIGHTSENSOR_FILES = ['in_illuminance0_input', |
| 177 | 'in_illuminance0_raw', |
| 178 | 'illuminance0_input'] |
| 179 | _LIGHTSENSOR_SEARCH_DIR = '/sys/bus/iio/devices' |
| 180 | _LABEL_FUNCTIONS = [] |
Aviv Keshet | 74c89a9 | 2013-02-04 15:18:30 -0800 | [diff] [blame] | 181 | _DETECTABLE_LABELS = [] |
| 182 | label_decorator = functools.partial(add_label_detector, _LABEL_FUNCTIONS, |
| 183 | _DETECTABLE_LABELS) |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 184 | |
J. Richard Barnette | b6de7e3 | 2013-02-14 13:28:04 -0800 | [diff] [blame] | 185 | # Constants used in ping_wait_up() and ping_wait_down(). |
| 186 | # |
| 187 | # _PING_WAIT_COUNT is the approximate number of polling |
| 188 | # cycles to use when waiting for a host state change. |
| 189 | # |
| 190 | # _PING_STATUS_DOWN and _PING_STATUS_UP are names used |
| 191 | # for arguments to the internal _ping_wait_for_status() |
| 192 | # method. |
| 193 | _PING_WAIT_COUNT = 40 |
| 194 | _PING_STATUS_DOWN = False |
| 195 | _PING_STATUS_UP = True |
| 196 | |
Ismail Noorbasha | 07fdb61 | 2013-02-14 14:13:31 -0800 | [diff] [blame] | 197 | # Allowed values for the power_method argument. |
| 198 | |
| 199 | # POWER_CONTROL_RPM: Passed as default arg for power_off/on/cycle() methods. |
| 200 | # POWER_CONTROL_SERVO: Used in set_power() and power_cycle() methods. |
| 201 | # POWER_CONTROL_MANUAL: Used in set_power() and power_cycle() methods. |
| 202 | POWER_CONTROL_RPM = 'RPM' |
| 203 | POWER_CONTROL_SERVO = 'servoj10' |
| 204 | POWER_CONTROL_MANUAL = 'manual' |
| 205 | |
| 206 | POWER_CONTROL_VALID_ARGS = (POWER_CONTROL_RPM, |
| 207 | POWER_CONTROL_SERVO, |
| 208 | POWER_CONTROL_MANUAL) |
Richard Barnette | 0c73ffc | 2012-11-19 15:21:18 -0800 | [diff] [blame] | 209 | |
Simran Basi | 5e6339a | 2013-03-21 11:34:32 -0700 | [diff] [blame] | 210 | _RPM_OUTLET_CHANGED = 'outlet_changed' |
| 211 | |
J. Richard Barnette | 964fba0 | 2012-10-24 17:34:29 -0700 | [diff] [blame] | 212 | @staticmethod |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 213 | def get_servo_arguments(args_dict): |
| 214 | """Extract servo options from `args_dict` and return the result. |
| 215 | |
| 216 | Take the provided dictionary of argument options and return |
| 217 | a subset that represent standard arguments needed to |
| 218 | construct a servo object for a host. The intent is to |
| 219 | provide standard argument processing from run_remote_tests |
| 220 | for tests that require a servo to operate. |
| 221 | |
| 222 | Recommended usage: |
| 223 | ~~~~~~~~ |
| 224 | args_dict = utils.args_to_dict(args) |
| 225 | servo_args = hosts.SiteHost.get_servo_arguments(args_dict) |
| 226 | host = hosts.create_host(machine, servo_args=servo_args) |
| 227 | ~~~~~~~~ |
| 228 | |
| 229 | @param args_dict Dictionary from which to extract the servo |
| 230 | arguments. |
| 231 | """ |
J. Richard Barnette | 964fba0 | 2012-10-24 17:34:29 -0700 | [diff] [blame] | 232 | servo_args = {} |
| 233 | for arg in ('servo_host', 'servo_port'): |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 234 | if arg in args_dict: |
| 235 | servo_args[arg] = args_dict[arg] |
J. Richard Barnette | 964fba0 | 2012-10-24 17:34:29 -0700 | [diff] [blame] | 236 | return servo_args |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 237 | |
J. Richard Barnette | 964fba0 | 2012-10-24 17:34:29 -0700 | [diff] [blame] | 238 | |
| 239 | def _initialize(self, hostname, servo_args=None, *args, **dargs): |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 240 | """Initialize superclasses, and |self.servo|. |
| 241 | |
| 242 | For creating the host servo object, there are three |
| 243 | possibilities: First, if the host is a lab system known to |
| 244 | have a servo board, we connect to that servo unconditionally. |
| 245 | Second, if we're called from a control file that requires |
J. Richard Barnette | 55fb806 | 2012-05-23 10:29:31 -0700 | [diff] [blame] | 246 | servo features for testing, it will pass settings for |
| 247 | `servo_host`, `servo_port`, or both. If neither of these |
| 248 | cases apply, `self.servo` will be `None`. |
J. Richard Barnette | 67ccb87 | 2012-04-19 16:34:56 -0700 | [diff] [blame] | 249 | |
| 250 | """ |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 251 | super(SiteHost, self)._initialize(hostname=hostname, |
| 252 | *args, **dargs) |
J. Richard Barnette | f085985 | 2012-08-20 14:55:50 -0700 | [diff] [blame] | 253 | # self.env is a dictionary of environment variable settings |
| 254 | # to be exported for commands run on the host. |
| 255 | # LIBC_FATAL_STDERR_ can be useful for diagnosing certain |
| 256 | # errors that might happen. |
| 257 | self.env['LIBC_FATAL_STDERR_'] = '1' |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 258 | self._xmlrpc_proxy_map = {} |
J. Richard Barnette | be5ebcc | 2013-02-11 16:03:15 -0800 | [diff] [blame] | 259 | self.servo = _get_lab_servo(hostname) |
J. Richard Barnette | ad7da48 | 2012-10-30 16:46:52 -0700 | [diff] [blame] | 260 | if not self.servo and servo_args is not None: |
J. Richard Barnette | 964fba0 | 2012-10-24 17:34:29 -0700 | [diff] [blame] | 261 | self.servo = servo.Servo(**servo_args) |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 262 | |
| 263 | |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 264 | def get_repair_image_name(self): |
| 265 | """Generate a image_name from variables in the global config. |
| 266 | |
| 267 | @returns a str of $board-version/$BUILD. |
| 268 | |
| 269 | """ |
| 270 | stable_version = global_config.global_config.get_config_value( |
| 271 | 'CROS', 'stable_cros_version') |
| 272 | build_pattern = global_config.global_config.get_config_value( |
| 273 | 'CROS', 'stable_build_pattern') |
| 274 | board = self._get_board_from_afe() |
| 275 | if board is None: |
| 276 | raise error.AutoservError('DUT has no board attribute, ' |
| 277 | 'cannot be repaired.') |
| 278 | return build_pattern % (board, stable_version) |
| 279 | |
| 280 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 281 | def _host_in_AFE(self): |
| 282 | """Check if the host is an object the AFE knows. |
| 283 | |
| 284 | @returns the host object. |
| 285 | """ |
| 286 | return self._AFE.get_hosts(hostname=self.hostname) |
| 287 | |
| 288 | |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 289 | def lookup_job_repo_url(self): |
| 290 | """Looks up the job_repo_url for the host. |
| 291 | |
| 292 | @returns job_repo_url from AFE or None if not found. |
| 293 | |
| 294 | @raises KeyError if the host does not have a job_repo_url |
| 295 | """ |
| 296 | if not self._host_in_AFE(): |
| 297 | return None |
| 298 | |
| 299 | hosts = self._AFE.get_hosts(hostname=self.hostname) |
beeps | b5efc53 | 2013-06-04 11:29:34 -0700 | [diff] [blame] | 300 | if hosts and ds_constants.JOB_REPO_URL in hosts[0].attributes: |
| 301 | return hosts[0].attributes[ds_constants.JOB_REPO_URL] |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 302 | |
| 303 | |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 304 | def clear_cros_version_labels_and_job_repo_url(self): |
| 305 | """Clear cros_version labels and host attribute job_repo_url.""" |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 306 | if not self._host_in_AFE(): |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 307 | return |
| 308 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 309 | host_list = [self.hostname] |
| 310 | labels = self._AFE.get_labels( |
| 311 | name__startswith=ds_constants.VERSION_PREFIX, |
| 312 | host__hostname=self.hostname) |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 313 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 314 | for label in labels: |
| 315 | label.remove_hosts(hosts=host_list) |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 316 | |
beeps | b5efc53 | 2013-06-04 11:29:34 -0700 | [diff] [blame] | 317 | self._AFE.set_host_attribute(ds_constants.JOB_REPO_URL, None, |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 318 | hostname=self.hostname) |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 319 | |
| 320 | |
Dan Shi | 0d8fcfa | 2013-06-10 12:50:16 -0700 | [diff] [blame^] | 321 | def add_cros_version_labels_and_job_repo_url(self, image_name, update_url): |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 322 | """Add cros_version labels and host attribute job_repo_url. |
| 323 | |
| 324 | @param image_name: The name of the image e.g. |
| 325 | lumpy-release/R27-3837.0.0 |
Dan Shi | 0d8fcfa | 2013-06-10 12:50:16 -0700 | [diff] [blame^] | 326 | @param update_url: The url to use for the update |
| 327 | pattern: http://$devserver:###/update/$build |
| 328 | It is used as the value of job_repo_url host attribute. If |
| 329 | update_url is None, a new url will be retrieved from devserver. |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 330 | """ |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 331 | if not self._host_in_AFE(): |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 332 | return |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 333 | |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 334 | cros_label = '%s%s' % (ds_constants.VERSION_PREFIX, image_name) |
Dan Shi | 0d8fcfa | 2013-06-10 12:50:16 -0700 | [diff] [blame^] | 335 | if update_url: |
| 336 | devserver_url = update_url.split('/update/')[0] |
| 337 | else: |
| 338 | devserver_url = dev_server.ImageServer.resolve(image_name).url() |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 339 | |
| 340 | labels = self._AFE.get_labels(name=cros_label) |
| 341 | if labels: |
| 342 | label = labels[0] |
| 343 | else: |
| 344 | label = self._AFE.create_label(name=cros_label) |
| 345 | |
| 346 | label.add_hosts([self.hostname]) |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 347 | repo_url = tools.get_package_url(devserver_url, image_name) |
beeps | b5efc53 | 2013-06-04 11:29:34 -0700 | [diff] [blame] | 348 | self._AFE.set_host_attribute(ds_constants.JOB_REPO_URL, repo_url, |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 349 | hostname=self.hostname) |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 350 | |
| 351 | |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 352 | def _try_stateful_update(self, update_url, force_update, updater): |
| 353 | """Try to use stateful update to initialize DUT. |
| 354 | |
| 355 | When DUT is already running the same version that machine_install |
| 356 | tries to install, stateful update is a much faster way to clean up |
| 357 | the DUT for testing, compared to a full reimage. It is implemeted |
| 358 | by calling autoupdater.run_update, but skipping updating root, as |
| 359 | updating the kernel is time consuming and not necessary. |
| 360 | |
| 361 | @param update_url: url of the image. |
| 362 | @param force_update: Set to True to update the image even if the DUT |
| 363 | is running the same version. |
| 364 | @param updater: ChromiumOSUpdater instance used to update the DUT. |
| 365 | @returns: True if the DUT was updated with stateful update. |
| 366 | |
| 367 | """ |
| 368 | if not updater.check_version(): |
| 369 | return False |
| 370 | if not force_update: |
| 371 | logging.info('Canceling stateful update because the new and ' |
| 372 | 'old versions are the same.') |
| 373 | return False |
| 374 | # Following folders should be rebuilt after stateful update. |
| 375 | # A test file is used to confirm each folder gets rebuilt after |
| 376 | # the stateful update. |
| 377 | folders_to_check = ['/var', '/home', '/mnt/stateful_partition'] |
| 378 | test_file = '.test_file_to_be_deleted' |
| 379 | for folder in folders_to_check: |
| 380 | touch_path = os.path.join(folder, test_file) |
| 381 | self.run('touch %s' % touch_path) |
| 382 | |
| 383 | if not updater.run_update(force_update=True, update_root=False): |
| 384 | return False |
| 385 | |
| 386 | # Reboot to complete stateful update. |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 387 | self.reboot(timeout=self.REBOOT_TIMEOUT, wait=True) |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 388 | check_file_cmd = 'test -f %s; echo $?' |
| 389 | for folder in folders_to_check: |
| 390 | test_file_path = os.path.join(folder, test_file) |
| 391 | result = self.run(check_file_cmd % test_file_path, |
| 392 | ignore_status=True) |
| 393 | if result.exit_status == 1: |
| 394 | return False |
| 395 | return True |
| 396 | |
| 397 | |
| 398 | def _post_update_processing(self, updater, inactive_kernel=None): |
| 399 | """After the DUT is updated, confirm machine_install succeeded. |
| 400 | |
| 401 | @param updater: ChromiumOSUpdater instance used to update the DUT. |
| 402 | @param inactive_kernel: kernel state of inactive kernel before reboot. |
| 403 | |
| 404 | """ |
| 405 | |
| 406 | # Touch the lab machine file to leave a marker that distinguishes |
| 407 | # this image from other test images. |
| 408 | self.run('touch %s' % self._LAB_MACHINE_FILE) |
| 409 | |
| 410 | # Kick off the autoreboot script as the _LAB_MACHINE_FILE was |
| 411 | # missing on the first boot. |
| 412 | self.run('start autoreboot') |
| 413 | |
| 414 | # Following the reboot, verify the correct version. |
Dan Shi | b95bb86 | 2013-03-22 16:29:28 -0700 | [diff] [blame] | 415 | if not updater.check_version_to_confirm_install(): |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 416 | # Print out crossystem to make it easier to debug the rollback. |
| 417 | logging.debug('Dumping partition table.') |
Dan Shi | 346725f | 2013-03-20 15:22:38 -0700 | [diff] [blame] | 418 | self.run('cgpt show $(rootdev -s -d)') |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 419 | logging.debug('Dumping crossystem for firmware debugging.') |
Dan Shi | 346725f | 2013-03-20 15:22:38 -0700 | [diff] [blame] | 420 | self.run('crossystem --all') |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 421 | logging.error('Expected Chromium OS version: %s. ' |
| 422 | 'Found Chromium OS %s', |
Dan Shi | 346725f | 2013-03-20 15:22:38 -0700 | [diff] [blame] | 423 | updater.update_version, updater.get_build_id()) |
| 424 | raise autoupdater.ChromiumOSError('Updater failed on host %s' % |
| 425 | self.hostname) |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 426 | |
| 427 | # Figure out newly active kernel. |
| 428 | new_active_kernel, _ = updater.get_kernel_state() |
| 429 | |
| 430 | # Ensure that previously inactive kernel is now the active kernel. |
| 431 | if inactive_kernel and new_active_kernel != inactive_kernel: |
| 432 | raise autoupdater.ChromiumOSError( |
| 433 | 'Update failed. New kernel partition is not active after' |
| 434 | ' boot.') |
| 435 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 436 | host_attributes = None |
| 437 | if self._host_in_AFE(): |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 438 | host_attributes = site_host_attributes.HostAttributes(self.hostname) |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 439 | |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 440 | if host_attributes and host_attributes.has_chromeos_firmware: |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 441 | # Wait until tries == 0 and success, or until timeout. |
| 442 | utils.poll_for_condition( |
| 443 | lambda: (updater.get_kernel_tries(new_active_kernel) == 0 |
| 444 | and updater.get_kernel_success(new_active_kernel)), |
| 445 | exception=autoupdater.ChromiumOSError( |
| 446 | 'Update failed. Timed out waiting for system to mark' |
| 447 | ' new kernel as successful.'), |
| 448 | timeout=self._KERNEL_UPDATE_TIMEOUT, sleep_interval=5) |
| 449 | |
| 450 | |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 451 | def _stage_image_for_update(self, image_name=None): |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 452 | """Stage a build on a devserver and return the update_url. |
| 453 | |
| 454 | @param image_name: a name like lumpy-release/R27-3837.0.0 |
| 455 | @returns an update URL like: |
| 456 | http://172.22.50.205:8082/update/lumpy-release/R27-3837.0.0 |
| 457 | """ |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 458 | if not image_name: |
| 459 | image_name = self.get_repair_image_name() |
| 460 | logging.info('Staging build for AU: %s', image_name) |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 461 | devserver = dev_server.ImageServer.resolve(image_name) |
| 462 | devserver.trigger_download(image_name, synchronous=False) |
| 463 | return tools.image_url_pattern() % (devserver.url(), image_name) |
| 464 | |
| 465 | |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 466 | def stage_image_for_servo(self, image_name=None): |
| 467 | """Stage a build on a devserver and return the update_url. |
| 468 | |
| 469 | @param image_name: a name like lumpy-release/R27-3837.0.0 |
| 470 | @returns an update URL like: |
| 471 | http://172.22.50.205:8082/update/lumpy-release/R27-3837.0.0 |
| 472 | """ |
| 473 | if not image_name: |
| 474 | image_name = self.get_repair_image_name() |
| 475 | logging.info('Staging build for servo install: %s', image_name) |
| 476 | devserver = dev_server.ImageServer.resolve(image_name) |
| 477 | devserver.stage_artifacts(image_name, ['test_image']) |
| 478 | return devserver.get_test_image_url(image_name) |
| 479 | |
| 480 | |
Chris Sosa | a3ac215 | 2012-05-23 22:23:13 -0700 | [diff] [blame] | 481 | def machine_install(self, update_url=None, force_update=False, |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 482 | local_devserver=False, repair=False): |
| 483 | """Install the DUT. |
| 484 | |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 485 | Use stateful update if the DUT is already running the same build. |
| 486 | Stateful update does not update kernel and tends to run much faster |
| 487 | than a full reimage. If the DUT is running a different build, or it |
| 488 | failed to do a stateful update, full update, including kernel update, |
| 489 | will be applied to the DUT. |
| 490 | |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 491 | Once a host enters machine_install its cros_version label will be |
| 492 | removed as well as its host attribute job_repo_url (used for |
| 493 | package install). |
| 494 | |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 495 | @param update_url: The url to use for the update |
| 496 | pattern: http://$devserver:###/update/$build |
| 497 | If update_url is None and repair is True we will install the |
| 498 | stable image listed in global_config under |
| 499 | CROS.stable_cros_version. |
| 500 | @param force_update: Force an update even if the version installed |
| 501 | is the same. Default:False |
| 502 | @param local_devserver: Used by run_remote_test to allow people to |
| 503 | use their local devserver. Default: False |
| 504 | @param repair: Whether or not we are in repair mode. This adds special |
| 505 | cases for repairing a machine like starting update_engine. |
| 506 | Setting repair to True sets force_update to True as well. |
| 507 | default: False |
| 508 | @raises autoupdater.ChromiumOSError |
| 509 | |
| 510 | """ |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 511 | if not update_url: |
| 512 | if self._parser.options.image: |
| 513 | requested_build = self._parser.options.image |
| 514 | if requested_build.startswith('http://'): |
| 515 | update_url = requested_build |
| 516 | else: |
| 517 | # Try to stage any build that does not start with |
| 518 | # http:// on the devservers defined in |
| 519 | # global_config.ini. |
| 520 | update_url = self._stage_image_for_update( |
| 521 | requested_build) |
| 522 | elif repair: |
| 523 | update_url = self._stage_image_for_update() |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 524 | else: |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 525 | raise autoupdater.ChromiumOSError( |
| 526 | 'Update failed. No update URL provided.') |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 527 | |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 528 | if repair: |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 529 | # In case the system is in a bad state, we always reboot the machine |
| 530 | # before machine_install. |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 531 | self.reboot(timeout=self.REBOOT_TIMEOUT, wait=True) |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 532 | self.run('stop update-engine; start update-engine') |
| 533 | force_update = True |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 534 | |
Chris Sosa | a3ac215 | 2012-05-23 22:23:13 -0700 | [diff] [blame] | 535 | updater = autoupdater.ChromiumOSUpdater(update_url, host=self, |
Chris Sosa | 7231260 | 2013-04-16 15:01:56 -0700 | [diff] [blame] | 536 | local_devserver=local_devserver) |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 537 | updated = False |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 538 | # Remove cros-version and job_repo_url host attribute from host. |
| 539 | self.clear_cros_version_labels_and_job_repo_url() |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 540 | # If the DUT is already running the same build, try stateful update |
| 541 | # first. Stateful update does not update kernel and tends to run much |
| 542 | # faster than a full reimage. |
| 543 | try: |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 544 | updated = self._try_stateful_update( |
| 545 | update_url, force_update, updater) |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 546 | if updated: |
| 547 | logging.info('DUT is updated with stateful update.') |
| 548 | except Exception as e: |
| 549 | logging.exception(e) |
| 550 | logging.warn('Failed to stateful update DUT, force to update.') |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 551 | |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 552 | inactive_kernel = None |
| 553 | # Do a full update if stateful update is not applicable or failed. |
| 554 | if not updated: |
| 555 | # In case the system is in a bad state, we always reboot the |
| 556 | # machine before machine_install. |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 557 | self.reboot(timeout=self.REBOOT_TIMEOUT, wait=True) |
Chris Sosa | b7612bc | 2013-03-21 10:32:37 -0700 | [diff] [blame] | 558 | |
| 559 | # TODO(sosa): Remove temporary hack to get rid of bricked machines |
| 560 | # that can't update due to a corrupted policy. |
| 561 | self.run('rm -rf /var/lib/whitelist') |
| 562 | self.run('touch /var/lib/whitelist') |
| 563 | self.run('chmod -w /var/lib/whitelist') |
Scott Zawalski | b550d5a | 2013-03-22 09:23:59 -0400 | [diff] [blame] | 564 | self.run('stop update-engine; start update-engine') |
Chris Sosa | b7612bc | 2013-03-21 10:32:37 -0700 | [diff] [blame] | 565 | |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 566 | if updater.run_update(force_update): |
| 567 | updated = True |
| 568 | # Figure out active and inactive kernel. |
| 569 | active_kernel, inactive_kernel = updater.get_kernel_state() |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 570 | |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 571 | # Ensure inactive kernel has higher priority than active. |
| 572 | if (updater.get_kernel_priority(inactive_kernel) |
| 573 | < updater.get_kernel_priority(active_kernel)): |
| 574 | raise autoupdater.ChromiumOSError( |
| 575 | 'Update failed. The priority of the inactive kernel' |
| 576 | ' partition is less than that of the active kernel' |
| 577 | ' partition.') |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 578 | |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 579 | update_engine_log = '/var/log/update_engine.log' |
| 580 | logging.info('Dumping %s', update_engine_log) |
| 581 | self.run('cat %s' % update_engine_log) |
| 582 | # Updater has returned successfully; reboot the host. |
Chris Sosa | b76e0ee | 2013-05-22 16:55:41 -0700 | [diff] [blame] | 583 | self.reboot(timeout=self.REBOOT_TIMEOUT, wait=True) |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 584 | |
Dan Shi | 0f466e8 | 2013-02-22 15:44:58 -0800 | [diff] [blame] | 585 | if updated: |
| 586 | self._post_update_processing(updater, inactive_kernel) |
Scott Zawalski | eadbf70 | 2013-03-14 09:23:06 -0400 | [diff] [blame] | 587 | image_name = autoupdater.url_to_image_name(update_url) |
Dan Shi | 0d8fcfa | 2013-06-10 12:50:16 -0700 | [diff] [blame^] | 588 | self.add_cros_version_labels_and_job_repo_url(image_name, |
| 589 | update_url) |
Simran Basi | 13fa1ba | 2013-03-04 10:56:47 -0800 | [diff] [blame] | 590 | |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 591 | # Clean up any old autotest directories which may be lying around. |
| 592 | for path in global_config.global_config.get_config_value( |
| 593 | 'AUTOSERV', 'client_autodir_paths', type=list): |
| 594 | self.run('rm -rf ' + path) |
| 595 | |
| 596 | |
Simran Basi | 833814b | 2013-01-29 13:13:43 -0800 | [diff] [blame] | 597 | def _get_label_from_afe(self, label_prefix): |
| 598 | """Retrieve a host's specific label from the AFE. |
| 599 | |
| 600 | Looks for a host label that has the form <label_prefix>:<value> |
| 601 | and returns the "<value>" part of the label. None is returned |
| 602 | if there is not a label matching the pattern |
| 603 | |
| 604 | @returns the label that matches the prefix or 'None' |
| 605 | """ |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 606 | labels = self._AFE.get_labels(name__startswith=label_prefix, |
| 607 | host__hostname__in=[self.hostname]) |
| 608 | if labels and len(labels) == 1: |
| 609 | return labels[0].name.split(label_prefix, 1)[1] |
Simran Basi | 833814b | 2013-01-29 13:13:43 -0800 | [diff] [blame] | 610 | |
| 611 | |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 612 | def _get_board_from_afe(self): |
| 613 | """Retrieve this host's board from its labels in the AFE. |
| 614 | |
| 615 | Looks for a host label of the form "board:<board>", and |
| 616 | returns the "<board>" part of the label. `None` is returned |
| 617 | if there is not a single, unique label matching the pattern. |
| 618 | |
| 619 | @returns board from label, or `None`. |
| 620 | """ |
Simran Basi | 833814b | 2013-01-29 13:13:43 -0800 | [diff] [blame] | 621 | return self._get_label_from_afe(ds_constants.BOARD_PREFIX) |
| 622 | |
| 623 | |
| 624 | def get_build(self): |
| 625 | """Retrieve the current build for this Host from the AFE. |
| 626 | |
| 627 | Looks through this host's labels in the AFE to determine its build. |
| 628 | |
| 629 | @returns The current build or None if it could not find it or if there |
| 630 | were multiple build labels assigned to this host. |
| 631 | """ |
| 632 | return self._get_label_from_afe(ds_constants.VERSION_PREFIX) |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 633 | |
| 634 | |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 635 | def _install_repair(self): |
| 636 | """Attempt to repair this host using upate-engine. |
| 637 | |
| 638 | If the host is up, try installing the DUT with a stable |
| 639 | "repair" version of Chrome OS as defined in the global_config |
| 640 | under CROS.stable_cros_version. |
| 641 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 642 | @raises AutoservRepairMethodNA if the DUT is not reachable. |
| 643 | @raises ChromiumOSError if the install failed for some reason. |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 644 | |
| 645 | """ |
| 646 | if not self.is_up(): |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 647 | raise error.AutoservRepairMethodNA('DUT unreachable for install.') |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 648 | |
| 649 | logging.info('Attempting to reimage machine to repair image.') |
| 650 | try: |
| 651 | self.machine_install(repair=True) |
Fang Deng | d0672f3 | 2013-03-18 17:18:09 -0700 | [diff] [blame] | 652 | except autoupdater.ChromiumOSError as e: |
| 653 | logging.exception(e) |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 654 | logging.info('Repair via install failed.') |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 655 | raise |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 656 | |
| 657 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 658 | def servo_install(self, image_url=None): |
| 659 | """ |
| 660 | Re-install the OS on the DUT by: |
| 661 | 1) installing a test image on a USB storage device attached to the Servo |
| 662 | board, |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 663 | 2) booting that image in recovery mode, and then |
J. Richard Barnette | 31b2e31 | 2013-04-04 16:05:22 -0700 | [diff] [blame] | 664 | 3) installing the image with chromeos-install. |
| 665 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 666 | @param image_url: If specified use as the url to install on the DUT. |
| 667 | otherwise boot the currently staged image on the USB stick. |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 668 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 669 | @raises AutoservError if the image fails to boot. |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 670 | """ |
J. Richard Barnette | 31b2e31 | 2013-04-04 16:05:22 -0700 | [diff] [blame] | 671 | self.servo.install_recovery_image(image_url) |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 672 | if not self.wait_up(timeout=self.USB_BOOT_TIMEOUT): |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 673 | raise error.AutoservRepairFailure( |
| 674 | 'DUT failed to boot from USB after %d seconds' % |
| 675 | self.USB_BOOT_TIMEOUT) |
| 676 | |
| 677 | self.run('chromeos-install --yes', timeout=self._INSTALL_TIMEOUT) |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 678 | self.servo.power_long_press() |
J. Richard Barnette | 31b2e31 | 2013-04-04 16:05:22 -0700 | [diff] [blame] | 679 | self.servo.switch_usbkey('host') |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 680 | self.servo.power_short_press() |
| 681 | if not self.wait_up(timeout=self.BOOT_TIMEOUT): |
| 682 | raise error.AutoservError('DUT failed to reboot installed ' |
| 683 | 'test image after %d seconds' % |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 684 | self.BOOT_TIMEOUT) |
| 685 | |
| 686 | |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 687 | def _servo_repair_reinstall(self): |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 688 | """Reinstall the DUT utilizing servo and a test image. |
| 689 | |
| 690 | Re-install the OS on the DUT by: |
| 691 | 1) installing a test image on a USB storage device attached to the Servo |
| 692 | board, |
| 693 | 2) booting that image in recovery mode, and then |
| 694 | 3) installing the image with chromeos-install. |
| 695 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 696 | @raises AutoservRepairMethodNA if the device does not have servo |
| 697 | support. |
| 698 | |
| 699 | """ |
| 700 | if not self.servo: |
| 701 | raise error.AutoservRepairMethodNA('Repair Reinstall NA: ' |
| 702 | 'DUT has no servo support.') |
| 703 | |
| 704 | logging.info('Attempting to recovery servo enabled device with ' |
| 705 | 'servo_repair_reinstall') |
| 706 | |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 707 | image_url = self.stage_image_for_servo() |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 708 | self.servo_install(image_url) |
| 709 | |
| 710 | |
| 711 | def _servo_repair_power(self): |
| 712 | """Attempt to repair DUT using an attached Servo. |
| 713 | |
| 714 | Attempt to power on the DUT via power_long_press. |
| 715 | |
| 716 | @raises AutoservRepairMethodNA if the device does not have servo |
| 717 | support. |
| 718 | @raises AutoservRepairFailure if the repair fails for any reason. |
| 719 | """ |
| 720 | if not self.servo: |
| 721 | raise error.AutoservRepairMethodNA('Repair Power NA: ' |
| 722 | 'DUT has no servo support.') |
| 723 | |
| 724 | logging.info('Attempting to recover servo enabled device by ' |
| 725 | 'powering it off and on.') |
| 726 | self.servo.get_power_state_controller().power_off() |
| 727 | self.servo.get_power_state_controller().power_on() |
| 728 | if self.wait_up(self.BOOT_TIMEOUT): |
| 729 | return |
| 730 | |
| 731 | raise error.AutoservRepairFailure('DUT did not boot after long_press.') |
Richard Barnette | 03a0c13 | 2012-11-05 12:40:35 -0800 | [diff] [blame] | 732 | |
| 733 | |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 734 | def _powercycle_to_repair(self): |
| 735 | """Utilize the RPM Infrastructure to bring the host back up. |
| 736 | |
| 737 | If the host is not up/repaired after the first powercycle we utilize |
| 738 | auto fallback to the last good install by powercycling and rebooting the |
| 739 | host 6 times. |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 740 | |
| 741 | @raises AutoservRepairMethodNA if the device does not support remote |
| 742 | power. |
| 743 | @raises AutoservRepairFailure if the repair fails for any reason. |
| 744 | |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 745 | """ |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 746 | if not self.has_power(): |
| 747 | raise error.AutoservRepairMethodNA('Device does not support power.') |
| 748 | |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 749 | logging.info('Attempting repair via RPM powercycle.') |
| 750 | failed_cycles = 0 |
| 751 | self.power_cycle() |
| 752 | while not self.wait_up(timeout=self.BOOT_TIMEOUT): |
| 753 | failed_cycles += 1 |
| 754 | if failed_cycles >= self._MAX_POWER_CYCLE_ATTEMPTS: |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 755 | raise error.AutoservRepairFailure( |
| 756 | 'Powercycled host %s %d times; device did not come back' |
| 757 | ' online.' % (self.hostname, failed_cycles)) |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 758 | self.power_cycle() |
| 759 | if failed_cycles == 0: |
| 760 | logging.info('Powercycling was successful first time.') |
| 761 | else: |
| 762 | logging.info('Powercycling was successful after %d failures.', |
| 763 | failed_cycles) |
| 764 | |
| 765 | |
| 766 | def repair_full(self): |
| 767 | """Repair a host for repair level NO_PROTECTION. |
| 768 | |
| 769 | This overrides the base class function for repair; it does |
| 770 | not call back to the parent class, but instead offers a |
| 771 | simplified implementation based on the capabilities in the |
| 772 | Chrome OS test lab. |
| 773 | |
J. Richard Barnette | fde55fc | 2013-03-15 17:47:01 -0700 | [diff] [blame] | 774 | If `self.verify()` fails, the following procedures are |
| 775 | attempted: |
| 776 | 1. Try to re-install to a known stable image using |
| 777 | auto-update. |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 778 | 2. If there's a servo for the DUT, try to power the DUT off and |
| 779 | on. |
| 780 | 3. If there's a servo for the DUT, try to re-install via |
J. Richard Barnette | fde55fc | 2013-03-15 17:47:01 -0700 | [diff] [blame] | 781 | the servo. |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 782 | 4. If the DUT can be power-cycled via RPM, try to repair |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 783 | by power-cycling. |
| 784 | |
| 785 | As with the parent method, the last operation performed on |
| 786 | the DUT must be to call `self.verify()`; if that call fails, |
| 787 | the exception it raises is passed back to the caller. |
J. Richard Barnette | fde55fc | 2013-03-15 17:47:01 -0700 | [diff] [blame] | 788 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 789 | @raises AutoservRepairTotalFailure if the repair process fails to |
| 790 | fix the DUT. |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 791 | """ |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 792 | # TODO(scottz): This should use something similar to label_decorator, |
| 793 | # but needs to be populated in order so DUTs are repaired with the |
| 794 | # least amount of effort. |
| 795 | repair_funcs = [self._install_repair, self._servo_repair_power, |
J. Richard Barnette | e4af8b9 | 2013-05-01 13:16:12 -0700 | [diff] [blame] | 796 | self._servo_repair_reinstall, |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 797 | self._powercycle_to_repair] |
| 798 | errors = [] |
| 799 | for repair_func in repair_funcs: |
| 800 | try: |
| 801 | repair_func() |
| 802 | self.verify() |
| 803 | return |
| 804 | except Exception as e: |
| 805 | logging.warn('Failed to repair device: %s', e) |
| 806 | errors.append(str(e)) |
Scott Zawalski | 89c44dd | 2013-02-26 09:28:02 -0500 | [diff] [blame] | 807 | |
Scott Zawalski | 62bacae | 2013-03-05 10:40:32 -0500 | [diff] [blame] | 808 | raise error.AutoservRepairTotalFailure( |
| 809 | 'All attempts at repairing the device failed:\n%s' % |
| 810 | '\n'.join(errors)) |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 811 | |
| 812 | |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 813 | def close(self): |
| 814 | super(SiteHost, self).close() |
| 815 | self.xmlrpc_disconnect_all() |
| 816 | |
| 817 | |
Simran Basi | 5e6339a | 2013-03-21 11:34:32 -0700 | [diff] [blame] | 818 | def _cleanup_poweron(self): |
| 819 | """Special cleanup method to make sure hosts always get power back.""" |
| 820 | afe = frontend_wrappers.RetryingAFE(timeout_min=5, delay_sec=10) |
| 821 | hosts = afe.get_hosts(hostname=self.hostname) |
| 822 | if not hosts or not (self._RPM_OUTLET_CHANGED in |
| 823 | hosts[0].attributes): |
| 824 | return |
| 825 | logging.debug('This host has recently interacted with the RPM' |
| 826 | ' Infrastructure. Ensuring power is on.') |
| 827 | try: |
| 828 | self.power_on() |
| 829 | except rpm_client.RemotePowerException: |
| 830 | # If cleanup has completed but there was an issue with the RPM |
| 831 | # Infrastructure, log an error message rather than fail cleanup |
| 832 | logging.error('Failed to turn Power On for this host after ' |
| 833 | 'cleanup through the RPM Infrastructure.') |
| 834 | afe.set_host_attribute(self._RPM_OUTLET_CHANGED, None, |
| 835 | hostname=self.hostname) |
| 836 | |
| 837 | |
Chris Sosa | f4d43ff | 2012-10-30 11:21:05 -0700 | [diff] [blame] | 838 | def cleanup(self): |
Chris Sosa | f4d43ff | 2012-10-30 11:21:05 -0700 | [diff] [blame] | 839 | client_at = autotest.Autotest(self) |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 840 | self.run('rm -f %s' % constants.CLEANUP_LOGS_PAUSED_FILE) |
Scott Zawalski | ddbc31e | 2012-11-15 11:29:01 -0500 | [diff] [blame] | 841 | try: |
| 842 | client_at.run_static_method('autotest_lib.client.cros.cros_ui', |
| 843 | '_clear_login_prompt_state') |
| 844 | self.run('restart ui') |
| 845 | client_at.run_static_method('autotest_lib.client.cros.cros_ui', |
| 846 | '_wait_for_login_prompt') |
Alex Miller | f451796 | 2013-02-25 15:03:02 -0800 | [diff] [blame] | 847 | except (error.AutotestRunError, error.AutoservRunError): |
Scott Zawalski | ddbc31e | 2012-11-15 11:29:01 -0500 | [diff] [blame] | 848 | logging.warn('Unable to restart ui, rebooting device.') |
| 849 | # Since restarting the UI fails fall back to normal Autotest |
| 850 | # cleanup routines, i.e. reboot the machine. |
| 851 | super(SiteHost, self).cleanup() |
Simran Basi | 5e6339a | 2013-03-21 11:34:32 -0700 | [diff] [blame] | 852 | # Check if the rpm outlet was manipulated. |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 853 | if self.has_power(): |
Simran Basi | 5e6339a | 2013-03-21 11:34:32 -0700 | [diff] [blame] | 854 | self._cleanup_poweron() |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 855 | |
| 856 | |
Yu-Ju Hong | a2be94a | 2012-07-31 09:48:52 -0700 | [diff] [blame] | 857 | def reboot(self, **dargs): |
| 858 | """ |
| 859 | This function reboots the site host. The more generic |
| 860 | RemoteHost.reboot() performs sync and sleeps for 5 |
| 861 | seconds. This is not necessary for Chrome OS devices as the |
| 862 | sync should be finished in a short time during the reboot |
| 863 | command. |
| 864 | """ |
Tom Wai-Hong Tam | f5cd1d4 | 2012-08-13 12:04:08 +0800 | [diff] [blame] | 865 | if 'reboot_cmd' not in dargs: |
| 866 | dargs['reboot_cmd'] = ('((reboot & sleep 10; reboot -f &)' |
| 867 | ' </dev/null >/dev/null 2>&1 &)') |
Yu-Ju Hong | a2be94a | 2012-07-31 09:48:52 -0700 | [diff] [blame] | 868 | # Enable fastsync to avoid running extra sync commands before reboot. |
Tom Wai-Hong Tam | f5cd1d4 | 2012-08-13 12:04:08 +0800 | [diff] [blame] | 869 | if 'fastsync' not in dargs: |
| 870 | dargs['fastsync'] = True |
Yu-Ju Hong | a2be94a | 2012-07-31 09:48:52 -0700 | [diff] [blame] | 871 | super(SiteHost, self).reboot(**dargs) |
| 872 | |
| 873 | |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 874 | def verify_software(self): |
Richard Barnette | b2bc13c | 2013-01-08 17:32:51 -0800 | [diff] [blame] | 875 | """Verify working software on a Chrome OS system. |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 876 | |
Richard Barnette | b2bc13c | 2013-01-08 17:32:51 -0800 | [diff] [blame] | 877 | Tests for the following conditions: |
| 878 | 1. All conditions tested by the parent version of this |
| 879 | function. |
| 880 | 2. Sufficient space in /mnt/stateful_partition. |
Fang Deng | 6b05f5b | 2013-03-20 13:42:11 -0700 | [diff] [blame] | 881 | 3. Sufficient space in /mnt/stateful_partition/encrypted. |
| 882 | 4. update_engine answers a simple status request over DBus. |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 883 | |
J. Richard Barnette | 45e93de | 2012-04-11 17:24:15 -0700 | [diff] [blame] | 884 | """ |
| 885 | super(SiteHost, self).verify_software() |
| 886 | self.check_diskspace( |
| 887 | '/mnt/stateful_partition', |
| 888 | global_config.global_config.get_config_value( |
Fang Deng | 6b05f5b | 2013-03-20 13:42:11 -0700 | [diff] [blame] | 889 | 'SERVER', 'gb_diskspace_required', type=float, |
| 890 | default=20.0)) |
| 891 | self.check_diskspace( |
| 892 | '/mnt/stateful_partition/encrypted', |
| 893 | global_config.global_config.get_config_value( |
| 894 | 'SERVER', 'gb_encrypted_diskspace_required', type=float, |
| 895 | default=0.1)) |
Richard Barnette | b2bc13c | 2013-01-08 17:32:51 -0800 | [diff] [blame] | 896 | self.run('update_engine_client --status') |
Scott Zawalski | fbca4a9 | 2013-03-04 15:56:42 -0500 | [diff] [blame] | 897 | # Makes sure python is present, loads and can use built in functions. |
| 898 | # We have seen cases where importing cPickle fails with undefined |
| 899 | # symbols in cPickle.so. |
| 900 | self.run('python -c "import cPickle"') |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 901 | |
| 902 | |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 903 | def xmlrpc_connect(self, command, port, command_name=None, |
| 904 | ready_test_name=None, timeout_seconds=10): |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 905 | """Connect to an XMLRPC server on the host. |
| 906 | |
| 907 | The `command` argument should be a simple shell command that |
| 908 | starts an XMLRPC server on the given `port`. The command |
| 909 | must not daemonize, and must terminate cleanly on SIGTERM. |
| 910 | The command is started in the background on the host, and a |
| 911 | local XMLRPC client for the server is created and returned |
| 912 | to the caller. |
| 913 | |
| 914 | Note that the process of creating an XMLRPC client makes no |
| 915 | attempt to connect to the remote server; the caller is |
| 916 | responsible for determining whether the server is running |
| 917 | correctly, and is ready to serve requests. |
| 918 | |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 919 | Optionally, the caller can pass ready_test_name, a string |
| 920 | containing the name of a method to call on the proxy. This |
| 921 | method should take no parameters and return successfully only |
| 922 | when the server is ready to process client requests. When |
| 923 | ready_test_name is set, xmlrpc_connect will block until the |
| 924 | proxy is ready, and throw a TestError if the server isn't |
| 925 | ready by timeout_seconds. |
| 926 | |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 927 | @param command Shell command to start the server. |
| 928 | @param port Port number on which the server is expected to |
| 929 | be serving. |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 930 | @param command_name String to use as input to `pkill` to |
| 931 | terminate the XMLRPC server on the host. |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 932 | @param ready_test_name String containing the name of a |
| 933 | method defined on the XMLRPC server. |
| 934 | @param timeout_seconds Number of seconds to wait |
| 935 | for the server to become 'ready.' Will throw a |
| 936 | TestFail error if server is not ready in time. |
| 937 | |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 938 | """ |
| 939 | self.xmlrpc_disconnect(port) |
| 940 | |
| 941 | # Chrome OS on the target closes down most external ports |
| 942 | # for security. We could open the port, but doing that |
| 943 | # would conflict with security tests that check that only |
| 944 | # expected ports are open. So, to get to the port on the |
| 945 | # target we use an ssh tunnel. |
| 946 | local_port = utils.get_unused_port() |
| 947 | tunnel_options = '-n -N -q -L %d:localhost:%d' % (local_port, port) |
| 948 | ssh_cmd = make_ssh_command(opts=tunnel_options) |
| 949 | tunnel_cmd = '%s %s' % (ssh_cmd, self.hostname) |
| 950 | logging.debug('Full tunnel command: %s', tunnel_cmd) |
| 951 | tunnel_proc = subprocess.Popen(tunnel_cmd, shell=True, close_fds=True) |
| 952 | logging.debug('Started XMLRPC tunnel, local = %d' |
| 953 | ' remote = %d, pid = %d', |
| 954 | local_port, port, tunnel_proc.pid) |
| 955 | |
| 956 | # Start the server on the host. Redirection in the command |
| 957 | # below is necessary, because 'ssh' won't terminate until |
| 958 | # background child processes close stdin, stdout, and |
| 959 | # stderr. |
| 960 | remote_cmd = '( %s ) </dev/null >/dev/null 2>&1 & echo $!' % command |
| 961 | remote_pid = self.run(remote_cmd).stdout.rstrip('\n') |
| 962 | logging.debug('Started XMLRPC server on host %s, pid = %s', |
| 963 | self.hostname, remote_pid) |
| 964 | |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 965 | self._xmlrpc_proxy_map[port] = (command_name, tunnel_proc) |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 966 | rpc_url = 'http://localhost:%d' % local_port |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 967 | proxy = xmlrpclib.ServerProxy(rpc_url, allow_none=True) |
| 968 | if ready_test_name is not None: |
J. Richard Barnette | 13eb7c0 | 2013-03-07 12:06:29 -0800 | [diff] [blame] | 969 | # retry.retry logs each attempt; calculate delay_sec to |
| 970 | # keep log spam to a dull roar. |
Christopher Wiley | 0ed712b | 2013-04-09 15:25:12 -0700 | [diff] [blame] | 971 | @retry.retry((socket.error, |
| 972 | xmlrpclib.ProtocolError, |
| 973 | httplib.BadStatusLine), |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 974 | timeout_min=timeout_seconds/60.0, |
J. Richard Barnette | 13eb7c0 | 2013-03-07 12:06:29 -0800 | [diff] [blame] | 975 | delay_sec=min(max(timeout_seconds/20.0, 0.1), 1)) |
Christopher Wiley | d78249a | 2013-03-01 13:05:31 -0800 | [diff] [blame] | 976 | def ready_test(): |
| 977 | """ Call proxy.ready_test_name(). """ |
| 978 | getattr(proxy, ready_test_name)() |
| 979 | successful = False |
| 980 | try: |
| 981 | logging.info('Waiting %d seconds for XMLRPC server ' |
| 982 | 'to start.', timeout_seconds) |
| 983 | ready_test() |
| 984 | successful = True |
| 985 | except retry.TimeoutException: |
| 986 | raise error.TestError('Unable to start XMLRPC server after ' |
| 987 | '%d seconds.' % timeout_seconds) |
| 988 | finally: |
| 989 | if not successful: |
| 990 | logging.error('Failed to start XMLRPC server.') |
| 991 | self.xmlrpc_disconnect(port) |
| 992 | logging.info('XMLRPC server started successfully.') |
| 993 | return proxy |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 994 | |
| 995 | def xmlrpc_disconnect(self, port): |
| 996 | """Disconnect from an XMLRPC server on the host. |
| 997 | |
| 998 | Terminates the remote XMLRPC server previously started for |
| 999 | the given `port`. Also closes the local ssh tunnel created |
| 1000 | for the connection to the host. This function does not |
| 1001 | directly alter the state of a previously returned XMLRPC |
| 1002 | client object; however disconnection will cause all |
| 1003 | subsequent calls to methods on the object to fail. |
| 1004 | |
| 1005 | This function does nothing if requested to disconnect a port |
| 1006 | that was not previously connected via `self.xmlrpc_connect()` |
| 1007 | |
| 1008 | @param port Port number passed to a previous call to |
| 1009 | `xmlrpc_connect()` |
| 1010 | """ |
| 1011 | if port not in self._xmlrpc_proxy_map: |
| 1012 | return |
| 1013 | entry = self._xmlrpc_proxy_map[port] |
| 1014 | remote_name = entry[0] |
| 1015 | tunnel_proc = entry[1] |
| 1016 | if remote_name: |
| 1017 | # We use 'pkill' to find our target process rather than |
| 1018 | # a PID, because the host may have rebooted since |
| 1019 | # connecting, and we don't want to kill an innocent |
| 1020 | # process with the same PID. |
| 1021 | # |
| 1022 | # 'pkill' helpfully exits with status 1 if no target |
| 1023 | # process is found, for which run() will throw an |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 1024 | # exception. We don't want that, so we the ignore |
J. Richard Barnette | 1d78b01 | 2012-05-15 13:56:30 -0700 | [diff] [blame] | 1025 | # status. |
| 1026 | self.run("pkill -f '%s'" % remote_name, ignore_status=True) |
| 1027 | |
| 1028 | if tunnel_proc.poll() is None: |
| 1029 | tunnel_proc.terminate() |
| 1030 | logging.debug('Terminated tunnel, pid %d', tunnel_proc.pid) |
| 1031 | else: |
| 1032 | logging.debug('Tunnel pid %d terminated early, status %d', |
| 1033 | tunnel_proc.pid, tunnel_proc.returncode) |
| 1034 | del self._xmlrpc_proxy_map[port] |
| 1035 | |
| 1036 | |
| 1037 | def xmlrpc_disconnect_all(self): |
| 1038 | """Disconnect all known XMLRPC proxy ports.""" |
| 1039 | for port in self._xmlrpc_proxy_map.keys(): |
| 1040 | self.xmlrpc_disconnect(port) |
| 1041 | |
| 1042 | |
J. Richard Barnette | b6de7e3 | 2013-02-14 13:28:04 -0800 | [diff] [blame] | 1043 | def _ping_check_status(self, status): |
| 1044 | """Ping the host once, and return whether it has a given status. |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1045 | |
J. Richard Barnette | b6de7e3 | 2013-02-14 13:28:04 -0800 | [diff] [blame] | 1046 | @param status Check the ping status against this value. |
| 1047 | @return True iff `status` and the result of ping are the same |
| 1048 | (i.e. both True or both False). |
| 1049 | |
| 1050 | """ |
| 1051 | ping_val = utils.ping(self.hostname, tries=1, deadline=1) |
| 1052 | return not (status ^ (ping_val == 0)) |
| 1053 | |
| 1054 | def _ping_wait_for_status(self, status, timeout): |
| 1055 | """Wait for the host to have a given status (UP or DOWN). |
| 1056 | |
| 1057 | Status is checked by polling. Polling will not last longer |
| 1058 | than the number of seconds in `timeout`. The polling |
| 1059 | interval will be long enough that only approximately |
| 1060 | _PING_WAIT_COUNT polling cycles will be executed, subject |
| 1061 | to a maximum interval of about one minute. |
| 1062 | |
| 1063 | @param status Waiting will stop immediately if `ping` of the |
| 1064 | host returns this status. |
| 1065 | @param timeout Poll for at most this many seconds. |
| 1066 | @return True iff the host status from `ping` matched the |
| 1067 | requested status at the time of return. |
| 1068 | |
| 1069 | """ |
| 1070 | # _ping_check_status() takes about 1 second, hence the |
| 1071 | # "- 1" in the formula below. |
| 1072 | poll_interval = min(int(timeout / self._PING_WAIT_COUNT), 60) - 1 |
| 1073 | end_time = time.time() + timeout |
| 1074 | while time.time() <= end_time: |
| 1075 | if self._ping_check_status(status): |
| 1076 | return True |
| 1077 | if poll_interval > 0: |
| 1078 | time.sleep(poll_interval) |
| 1079 | |
| 1080 | # The last thing we did was sleep(poll_interval), so it may |
| 1081 | # have been too long since the last `ping`. Check one more |
| 1082 | # time, just to be sure. |
| 1083 | return self._ping_check_status(status) |
| 1084 | |
| 1085 | def ping_wait_up(self, timeout): |
| 1086 | """Wait for the host to respond to `ping`. |
| 1087 | |
| 1088 | N.B. This method is not a reliable substitute for |
| 1089 | `wait_up()`, because a host that responds to ping will not |
| 1090 | necessarily respond to ssh. This method should only be used |
| 1091 | if the target DUT can be considered functional even if it |
| 1092 | can't be reached via ssh. |
| 1093 | |
| 1094 | @param timeout Minimum time to allow before declaring the |
| 1095 | host to be non-responsive. |
| 1096 | @return True iff the host answered to ping before the timeout. |
| 1097 | |
| 1098 | """ |
| 1099 | return self._ping_wait_for_status(self._PING_STATUS_UP, timeout) |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1100 | |
Andrew Bresticker | 678c0c7 | 2013-01-22 10:44:09 -0800 | [diff] [blame] | 1101 | def ping_wait_down(self, timeout): |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1102 | """Wait until the host no longer responds to `ping`. |
| 1103 | |
J. Richard Barnette | b6de7e3 | 2013-02-14 13:28:04 -0800 | [diff] [blame] | 1104 | This function can be used as a slightly faster version of |
| 1105 | `wait_down()`, by avoiding potentially long ssh timeouts. |
| 1106 | |
| 1107 | @param timeout Minimum time to allow for the host to become |
| 1108 | non-responsive. |
| 1109 | @return True iff the host quit answering ping before the |
| 1110 | timeout. |
| 1111 | |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1112 | """ |
J. Richard Barnette | b6de7e3 | 2013-02-14 13:28:04 -0800 | [diff] [blame] | 1113 | return self._ping_wait_for_status(self._PING_STATUS_DOWN, timeout) |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1114 | |
| 1115 | def test_wait_for_sleep(self): |
| 1116 | """Wait for the client to enter low-power sleep mode. |
| 1117 | |
| 1118 | The test for "is asleep" can't distinguish a system that is |
| 1119 | powered off; to confirm that the unit was asleep, it is |
| 1120 | necessary to force resume, and then call |
| 1121 | `test_wait_for_resume()`. |
| 1122 | |
| 1123 | This function is expected to be called from a test as part |
| 1124 | of a sequence like the following: |
| 1125 | |
| 1126 | ~~~~~~~~ |
| 1127 | boot_id = host.get_boot_id() |
| 1128 | # trigger sleep on the host |
| 1129 | host.test_wait_for_sleep() |
| 1130 | # trigger resume on the host |
| 1131 | host.test_wait_for_resume(boot_id) |
| 1132 | ~~~~~~~~ |
| 1133 | |
| 1134 | @exception TestFail The host did not go to sleep within |
| 1135 | the allowed time. |
| 1136 | """ |
Andrew Bresticker | 678c0c7 | 2013-01-22 10:44:09 -0800 | [diff] [blame] | 1137 | if not self.ping_wait_down(timeout=self.SLEEP_TIMEOUT): |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1138 | raise error.TestFail( |
| 1139 | 'client failed to sleep after %d seconds' % |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 1140 | self.SLEEP_TIMEOUT) |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1141 | |
| 1142 | |
| 1143 | def test_wait_for_resume(self, old_boot_id): |
| 1144 | """Wait for the client to resume from low-power sleep mode. |
| 1145 | |
| 1146 | The `old_boot_id` parameter should be the value from |
| 1147 | `get_boot_id()` obtained prior to entering sleep mode. A |
| 1148 | `TestFail` exception is raised if the boot id changes. |
| 1149 | |
| 1150 | See @ref test_wait_for_sleep for more on this function's |
| 1151 | usage. |
| 1152 | |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 1153 | @param old_boot_id A boot id value obtained before the |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1154 | target host went to sleep. |
| 1155 | |
| 1156 | @exception TestFail The host did not respond within the |
| 1157 | allowed time. |
| 1158 | @exception TestFail The host responded, but the boot id test |
| 1159 | indicated a reboot rather than a sleep |
| 1160 | cycle. |
| 1161 | """ |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 1162 | if not self.wait_up(timeout=self.RESUME_TIMEOUT): |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1163 | raise error.TestFail( |
| 1164 | 'client failed to resume from sleep after %d seconds' % |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 1165 | self.RESUME_TIMEOUT) |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1166 | else: |
| 1167 | new_boot_id = self.get_boot_id() |
| 1168 | if new_boot_id != old_boot_id: |
| 1169 | raise error.TestFail( |
| 1170 | 'client rebooted, but sleep was expected' |
| 1171 | ' (old boot %s, new boot %s)' |
| 1172 | % (old_boot_id, new_boot_id)) |
| 1173 | |
| 1174 | |
| 1175 | def test_wait_for_shutdown(self): |
| 1176 | """Wait for the client to shut down. |
| 1177 | |
| 1178 | The test for "has shut down" can't distinguish a system that |
| 1179 | is merely asleep; to confirm that the unit was down, it is |
| 1180 | necessary to force boot, and then call test_wait_for_boot(). |
| 1181 | |
| 1182 | This function is expected to be called from a test as part |
| 1183 | of a sequence like the following: |
| 1184 | |
| 1185 | ~~~~~~~~ |
| 1186 | boot_id = host.get_boot_id() |
| 1187 | # trigger shutdown on the host |
| 1188 | host.test_wait_for_shutdown() |
| 1189 | # trigger boot on the host |
| 1190 | host.test_wait_for_boot(boot_id) |
| 1191 | ~~~~~~~~ |
| 1192 | |
| 1193 | @exception TestFail The host did not shut down within the |
| 1194 | allowed time. |
| 1195 | """ |
Andrew Bresticker | 678c0c7 | 2013-01-22 10:44:09 -0800 | [diff] [blame] | 1196 | if not self.ping_wait_down(timeout=self.SHUTDOWN_TIMEOUT): |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1197 | raise error.TestFail( |
| 1198 | 'client failed to shut down after %d seconds' % |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 1199 | self.SHUTDOWN_TIMEOUT) |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1200 | |
| 1201 | |
| 1202 | def test_wait_for_boot(self, old_boot_id=None): |
| 1203 | """Wait for the client to boot from cold power. |
| 1204 | |
| 1205 | The `old_boot_id` parameter should be the value from |
| 1206 | `get_boot_id()` obtained prior to shutting down. A |
| 1207 | `TestFail` exception is raised if the boot id does not |
| 1208 | change. The boot id test is omitted if `old_boot_id` is not |
| 1209 | specified. |
| 1210 | |
| 1211 | See @ref test_wait_for_shutdown for more on this function's |
| 1212 | usage. |
| 1213 | |
J. Richard Barnette | 7214e0b | 2013-02-06 15:20:49 -0800 | [diff] [blame] | 1214 | @param old_boot_id A boot id value obtained before the |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1215 | shut down. |
| 1216 | |
| 1217 | @exception TestFail The host did not respond within the |
| 1218 | allowed time. |
| 1219 | @exception TestFail The host responded, but the boot id test |
| 1220 | indicated that there was no reboot. |
| 1221 | """ |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 1222 | if not self.wait_up(timeout=self.REBOOT_TIMEOUT): |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1223 | raise error.TestFail( |
| 1224 | 'client failed to reboot after %d seconds' % |
J. Richard Barnette | eb69d72 | 2012-06-18 17:29:44 -0700 | [diff] [blame] | 1225 | self.REBOOT_TIMEOUT) |
J. Richard Barnette | 134ec2c | 2012-04-25 12:59:37 -0700 | [diff] [blame] | 1226 | elif old_boot_id: |
| 1227 | if self.get_boot_id() == old_boot_id: |
| 1228 | raise error.TestFail( |
| 1229 | 'client is back up, but did not reboot' |
| 1230 | ' (boot %s)' % old_boot_id) |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 1231 | |
| 1232 | |
| 1233 | @staticmethod |
| 1234 | def check_for_rpm_support(hostname): |
| 1235 | """For a given hostname, return whether or not it is powered by an RPM. |
| 1236 | |
| 1237 | @return None if this host does not follows the defined naming format |
| 1238 | for RPM powered DUT's in the lab. If it does follow the format, |
| 1239 | it returns a regular expression MatchObject instead. |
| 1240 | """ |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 1241 | return re.match(SiteHost._RPM_HOSTNAME_REGEX, hostname) |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 1242 | |
| 1243 | |
| 1244 | def has_power(self): |
| 1245 | """For this host, return whether or not it is powered by an RPM. |
| 1246 | |
| 1247 | @return True if this host is in the CROS lab and follows the defined |
| 1248 | naming format. |
| 1249 | """ |
| 1250 | return SiteHost.check_for_rpm_support(self.hostname) |
| 1251 | |
| 1252 | |
Ismail Noorbasha | 07fdb61 | 2013-02-14 14:13:31 -0800 | [diff] [blame] | 1253 | def _set_power(self, state, power_method): |
| 1254 | """Sets the power to the host via RPM, Servo or manual. |
| 1255 | |
| 1256 | @param state Specifies which power state to set to DUT |
| 1257 | @param power_method Specifies which method of power control to |
| 1258 | use. By default "RPM" will be used. Valid values |
| 1259 | are the strings "RPM", "manual", "servoj10". |
| 1260 | |
| 1261 | """ |
| 1262 | ACCEPTABLE_STATES = ['ON', 'OFF'] |
| 1263 | |
| 1264 | if state.upper() not in ACCEPTABLE_STATES: |
| 1265 | raise error.TestError('State must be one of: %s.' |
| 1266 | % (ACCEPTABLE_STATES,)) |
| 1267 | |
| 1268 | if power_method == self.POWER_CONTROL_SERVO: |
| 1269 | logging.info('Setting servo port J10 to %s', state) |
| 1270 | self.servo.set('prtctl3_pwren', state.lower()) |
| 1271 | time.sleep(self._USB_POWER_TIMEOUT) |
| 1272 | elif power_method == self.POWER_CONTROL_MANUAL: |
| 1273 | logging.info('You have %d seconds to set the AC power to %s.', |
| 1274 | self._POWER_CYCLE_TIMEOUT, state) |
| 1275 | time.sleep(self._POWER_CYCLE_TIMEOUT) |
| 1276 | else: |
| 1277 | if not self.has_power(): |
| 1278 | raise error.TestFail('DUT does not have RPM connected.') |
Simran Basi | 5e6339a | 2013-03-21 11:34:32 -0700 | [diff] [blame] | 1279 | afe = frontend_wrappers.RetryingAFE(timeout_min=5, delay_sec=10) |
| 1280 | afe.set_host_attribute(self._RPM_OUTLET_CHANGED, True, |
| 1281 | hostname=self.hostname) |
Ismail Noorbasha | 07fdb61 | 2013-02-14 14:13:31 -0800 | [diff] [blame] | 1282 | rpm_client.set_power(self.hostname, state.upper()) |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 1283 | |
| 1284 | |
Ismail Noorbasha | 07fdb61 | 2013-02-14 14:13:31 -0800 | [diff] [blame] | 1285 | def power_off(self, power_method=POWER_CONTROL_RPM): |
| 1286 | """Turn off power to this host via RPM, Servo or manual. |
| 1287 | |
| 1288 | @param power_method Specifies which method of power control to |
| 1289 | use. By default "RPM" will be used. Valid values |
| 1290 | are the strings "RPM", "manual", "servoj10". |
| 1291 | |
| 1292 | """ |
| 1293 | self._set_power('OFF', power_method) |
Simran Basi | d5e5e27 | 2012-09-24 15:23:59 -0700 | [diff] [blame] | 1294 | |
| 1295 | |
Ismail Noorbasha | 07fdb61 | 2013-02-14 14:13:31 -0800 | [diff] [blame] | 1296 | def power_on(self, power_method=POWER_CONTROL_RPM): |
| 1297 | """Turn on power to this host via RPM, Servo or manual. |
| 1298 | |
| 1299 | @param power_method Specifies which method of power control to |
| 1300 | use. By default "RPM" will be used. Valid values |
| 1301 | are the strings "RPM", "manual", "servoj10". |
| 1302 | |
| 1303 | """ |
| 1304 | self._set_power('ON', power_method) |
| 1305 | |
| 1306 | |
| 1307 | def power_cycle(self, power_method=POWER_CONTROL_RPM): |
| 1308 | """Cycle power to this host by turning it OFF, then ON. |
| 1309 | |
| 1310 | @param power_method Specifies which method of power control to |
| 1311 | use. By default "RPM" will be used. Valid values |
| 1312 | are the strings "RPM", "manual", "servoj10". |
| 1313 | |
| 1314 | """ |
| 1315 | if power_method in (self.POWER_CONTROL_SERVO, |
| 1316 | self.POWER_CONTROL_MANUAL): |
| 1317 | self.power_off(power_method=power_method) |
| 1318 | time.sleep(self._POWER_CYCLE_TIMEOUT) |
| 1319 | self.power_on(power_method=power_method) |
| 1320 | else: |
| 1321 | rpm_client.set_power(self.hostname, 'CYCLE') |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1322 | |
| 1323 | |
| 1324 | def get_platform(self): |
| 1325 | """Determine the correct platform label for this host. |
| 1326 | |
| 1327 | @returns a string representing this host's platform. |
| 1328 | """ |
| 1329 | crossystem = utils.Crossystem(self) |
| 1330 | crossystem.init() |
| 1331 | # Extract fwid value and use the leading part as the platform id. |
| 1332 | # fwid generally follow the format of {platform}.{firmware version} |
| 1333 | # Example: Alex.X.YYY.Z or Google_Alex.X.YYY.Z |
| 1334 | platform = crossystem.fwid().split('.')[0].lower() |
| 1335 | # Newer platforms start with 'Google_' while the older ones do not. |
| 1336 | return platform.replace('google_', '') |
| 1337 | |
| 1338 | |
Aviv Keshet | 74c89a9 | 2013-02-04 15:18:30 -0800 | [diff] [blame] | 1339 | @label_decorator() |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1340 | def get_board(self): |
| 1341 | """Determine the correct board label for this host. |
| 1342 | |
| 1343 | @returns a string representing this host's board. |
| 1344 | """ |
| 1345 | release_info = utils.parse_cmd_output('cat /etc/lsb-release', |
| 1346 | run_method=self.run) |
| 1347 | board = release_info['CHROMEOS_RELEASE_BOARD'] |
| 1348 | # Devices in the lab generally have the correct board name but our own |
| 1349 | # development devices have {board_name}-signed-{key_type}. The board |
| 1350 | # name may also begin with 'x86-' which we need to keep. |
Simran Basi | 833814b | 2013-01-29 13:13:43 -0800 | [diff] [blame] | 1351 | board_format_string = ds_constants.BOARD_PREFIX + '%s' |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1352 | if 'x86' not in board: |
Simran Basi | 833814b | 2013-01-29 13:13:43 -0800 | [diff] [blame] | 1353 | return board_format_string % board.split('-')[0] |
| 1354 | return board_format_string % '-'.join(board.split('-')[0:2]) |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1355 | |
| 1356 | |
Aviv Keshet | 74c89a9 | 2013-02-04 15:18:30 -0800 | [diff] [blame] | 1357 | @label_decorator('lightsensor') |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1358 | def has_lightsensor(self): |
| 1359 | """Determine the correct board label for this host. |
| 1360 | |
| 1361 | @returns the string 'lightsensor' if this host has a lightsensor or |
| 1362 | None if it does not. |
| 1363 | """ |
| 1364 | search_cmd = "find -L %s -maxdepth 4 | egrep '%s'" % ( |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 1365 | self._LIGHTSENSOR_SEARCH_DIR, '|'.join(self._LIGHTSENSOR_FILES)) |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1366 | try: |
| 1367 | # Run the search cmd following the symlinks. Stderr_tee is set to |
| 1368 | # None as there can be a symlink loop, but the command will still |
| 1369 | # execute correctly with a few messages printed to stderr. |
| 1370 | self.run(search_cmd, stdout_tee=None, stderr_tee=None) |
| 1371 | return 'lightsensor' |
| 1372 | except error.AutoservRunError: |
| 1373 | # egrep exited with a return code of 1 meaning none of the possible |
| 1374 | # lightsensor files existed. |
| 1375 | return None |
| 1376 | |
| 1377 | |
Aviv Keshet | 74c89a9 | 2013-02-04 15:18:30 -0800 | [diff] [blame] | 1378 | @label_decorator('bluetooth') |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1379 | def has_bluetooth(self): |
| 1380 | """Determine the correct board label for this host. |
| 1381 | |
| 1382 | @returns the string 'bluetooth' if this host has bluetooth or |
| 1383 | None if it does not. |
| 1384 | """ |
| 1385 | try: |
| 1386 | self.run('test -d /sys/class/bluetooth/hci0') |
| 1387 | # test exited with a return code of 0. |
| 1388 | return 'bluetooth' |
| 1389 | except error.AutoservRunError: |
| 1390 | # test exited with a return code 1 meaning the directory did not |
| 1391 | # exist. |
| 1392 | return None |
| 1393 | |
| 1394 | |
| 1395 | def get_labels(self): |
| 1396 | """Return a list of labels for this given host. |
| 1397 | |
| 1398 | This is the main way to retrieve all the automatic labels for a host |
| 1399 | as it will run through all the currently implemented label functions. |
| 1400 | """ |
| 1401 | labels = [] |
Richard Barnette | 82c3591 | 2012-11-20 10:09:10 -0800 | [diff] [blame] | 1402 | for label_function in self._LABEL_FUNCTIONS: |
Simran Basi | c6f1f7a | 2012-10-16 10:47:46 -0700 | [diff] [blame] | 1403 | label = label_function(self) |
| 1404 | if label: |
| 1405 | labels.append(label) |
| 1406 | return labels |