blob: 4b6b5977c56ee6f0b58e4677d388d61fc8a9bcf6 [file] [log] [blame]
J. Richard Barnette24adbf42012-04-11 15:04:53 -07001# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Dale Curtisaa5eedb2011-08-23 16:18:52 -07002# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
J. Richard Barnette1d78b012012-05-15 13:56:30 -07005import logging
Dan Shi0f466e82013-02-22 15:44:58 -08006import os
Simran Basid5e5e272012-09-24 15:23:59 -07007import re
Vincent Palatindf2372c2016-10-07 17:03:00 +02008import sys
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07009import time
10
mussa584b4462014-06-20 15:13:28 -070011import common
J. Richard Barnette45e93de2012-04-11 17:24:15 -070012from autotest_lib.client.bin import utils
Dan Shi9cb0eec2014-06-03 09:04:50 -070013from autotest_lib.client.common_lib import autotemp
Richard Barnette0c73ffc2012-11-19 15:21:18 -080014from autotest_lib.client.common_lib import error
15from autotest_lib.client.common_lib import global_config
J. Richard Barnette91137f02016-03-10 16:52:26 -080016from autotest_lib.client.common_lib import hosts
Dan Shi549fb822015-03-24 18:01:11 -070017from autotest_lib.client.common_lib import lsbrelease_utils
Richard Barnette03a0c132012-11-05 12:40:35 -080018from autotest_lib.client.common_lib.cros import dev_server
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -070019from autotest_lib.client.common_lib.cros import retry
Hsinyu Chaoe0b08e62015-08-11 10:50:37 +000020from autotest_lib.client.cros import constants as client_constants
J. Richard Barnette84890bd2014-02-21 11:05:47 -080021from autotest_lib.client.cros import cros_ui
Simran Basi5ace6f22016-01-06 17:30:44 -080022from autotest_lib.server import afe_utils
Dan Shia1ecd5c2013-06-06 11:21:31 -070023from autotest_lib.server import utils as server_utils
Dan Shi9cb0eec2014-06-03 09:04:50 -070024from autotest_lib.server.cros import provision
Scott Zawalski89c44dd2013-02-26 09:28:02 -050025from autotest_lib.server.cros.dynamic_suite import constants as ds_constants
Simran Basi5e6339a2013-03-21 11:34:32 -070026from autotest_lib.server.cros.dynamic_suite import tools, frontend_wrappers
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070027from autotest_lib.server.cros.servo import pdtester
Fang Deng96667ca2013-08-01 17:46:18 -070028from autotest_lib.server.hosts import abstract_ssh
Kevin Chenga2619dc2016-03-28 11:42:08 -070029from autotest_lib.server.hosts import base_label
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +080030from autotest_lib.server.hosts import chameleon_host
Richard Barnetted31580e2018-05-14 19:58:00 +000031from autotest_lib.server.hosts import cros_label
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -080032from autotest_lib.server.hosts import cros_repair
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070033from autotest_lib.server.hosts import pdtester_host
Fang Deng5d518f42013-08-02 14:04:32 -070034from autotest_lib.server.hosts import servo_host
Simran Basidcff4252012-11-20 16:13:20 -080035from autotest_lib.site_utils.rpm_control_system import rpm_client
Simran Basid5e5e272012-09-24 15:23:59 -070036
Simran Basi382506b2016-09-13 14:58:15 -070037# In case cros_host is being ran via SSP on an older Moblab version with an
38# older chromite version.
39try:
40 from chromite.lib import metrics
Dan Shi5e2efb72017-02-07 11:40:23 -080041except ImportError:
Congbin Guo42427612019-02-12 10:22:06 -080042 metrics = utils.metrics_mock
Dan Shi5e2efb72017-02-07 11:40:23 -080043
Simran Basid5e5e272012-09-24 15:23:59 -070044
Dan Shib8540a52015-07-16 14:18:23 -070045CONFIG = global_config.global_config
46
Dan Shid07ee2e2015-09-24 14:49:25 -070047
beepsc87ff602013-07-31 21:53:00 -070048class FactoryImageCheckerException(error.AutoservError):
49 """Exception raised when an image is a factory image."""
50 pass
51
52
Fang Deng0ca40e22013-08-27 17:47:44 -070053class CrosHost(abstract_ssh.AbstractSSHHost):
J. Richard Barnette45e93de2012-04-11 17:24:15 -070054 """Chromium OS specific subclass of Host."""
55
Simran Basi5ace6f22016-01-06 17:30:44 -080056 VERSION_PREFIX = provision.CROS_VERSION_PREFIX
57
Scott Zawalski62bacae2013-03-05 10:40:32 -050058 _AFE = frontend_wrappers.RetryingAFE(timeout_min=5, delay_sec=10)
J. Richard Barnette45e93de2012-04-11 17:24:15 -070059
Richard Barnette03a0c132012-11-05 12:40:35 -080060 # Timeout values (in seconds) associated with various Chrome OS
61 # state changes.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -070062 #
Richard Barnette0c73ffc2012-11-19 15:21:18 -080063 # In general, a good rule of thumb is that the timeout can be up
64 # to twice the typical measured value on the slowest platform.
65 # The times here have not necessarily been empirically tested to
66 # meet this criterion.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070067 #
68 # SLEEP_TIMEOUT: Time to allow for suspend to memory.
Richard Barnette0c73ffc2012-11-19 15:21:18 -080069 # RESUME_TIMEOUT: Time to allow for resume after suspend, plus
70 # time to restart the netwowrk.
J. Richard Barnette84890bd2014-02-21 11:05:47 -080071 # SHUTDOWN_TIMEOUT: Time to allow for shut down.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070072 # BOOT_TIMEOUT: Time to allow for boot from power off. Among
Richard Barnette0c73ffc2012-11-19 15:21:18 -080073 # other things, this must account for the 30 second dev-mode
J. Richard Barnette417cc792015-10-01 09:56:36 -070074 # screen delay, time to start the network on the DUT, and the
75 # ssh timeout of 120 seconds.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070076 # USB_BOOT_TIMEOUT: Time to allow for boot from a USB device,
Richard Barnette0c73ffc2012-11-19 15:21:18 -080077 # including the 30 second dev-mode delay and time to start the
J. Richard Barnetted4649c62013-03-06 17:42:27 -080078 # network.
beepsf079cfb2013-09-18 17:49:51 -070079 # INSTALL_TIMEOUT: Time to allow for chromeos-install.
J. Richard Barnette84890bd2014-02-21 11:05:47 -080080 # POWERWASH_BOOT_TIMEOUT: Time to allow for a reboot that
81 # includes powerwash.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070082
83 SLEEP_TIMEOUT = 2
J. Richard Barnetted4649c62013-03-06 17:42:27 -080084 RESUME_TIMEOUT = 10
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +080085 SHUTDOWN_TIMEOUT = 10
J. Richard Barnette417cc792015-10-01 09:56:36 -070086 BOOT_TIMEOUT = 150
J. Richard Barnette5bab5f52015-08-03 13:14:38 -070087 USB_BOOT_TIMEOUT = 300
J. Richard Barnette7817b052014-08-28 09:47:29 -070088 INSTALL_TIMEOUT = 480
Dan Shi2c88eed2013-11-12 10:18:38 -080089 POWERWASH_BOOT_TIMEOUT = 60
Chris Sosab76e0ee2013-05-22 16:55:41 -070090
Dan Shica503482015-03-30 17:23:25 -070091 # Minimum OS version that supports server side packaging. Older builds may
92 # not have server side package built or with Autotest code change to support
93 # server-side packaging.
Dan Shib8540a52015-07-16 14:18:23 -070094 MIN_VERSION_SUPPORT_SSP = CONFIG.get_config_value(
Dan Shiced09e42015-04-17 16:09:34 -070095 'AUTOSERV', 'min_version_support_ssp', type=int)
Dan Shica503482015-03-30 17:23:25 -070096
J. Richard Barnette84890bd2014-02-21 11:05:47 -080097 # REBOOT_TIMEOUT: How long to wait for a reboot.
98 #
Chris Sosab76e0ee2013-05-22 16:55:41 -070099 # We have a long timeout to ensure we don't flakily fail due to other
100 # issues. Shorter timeouts are vetted in platform_RebootAfterUpdate.
Simran Basi1160e2c2013-10-04 16:00:24 -0700101 # TODO(sbasi - crbug.com/276094) Restore to 5 mins once the 'host did not
102 # return from reboot' bug is solved.
103 REBOOT_TIMEOUT = 480
Chris Sosab76e0ee2013-05-22 16:55:41 -0700104
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800105 # _USB_POWER_TIMEOUT: Time to allow for USB to power toggle ON and OFF.
106 # _POWER_CYCLE_TIMEOUT: Time to allow for manual power cycle.
Garry Wang5e5538a2019-04-08 15:36:18 -0700107 # _CHANGE_SERVO_ROLE_TIMEOUT: Time to allow DUT regain network connection
108 # since changing servo role will reset USB state
109 # and causes temporary ethernet drop.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800110 _USB_POWER_TIMEOUT = 5
111 _POWER_CYCLE_TIMEOUT = 10
Garry Wang5e5538a2019-04-08 15:36:18 -0700112 _CHANGE_SERVO_ROLE_TIMEOUT = 180
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800113
Fang Dengdeba14f2014-11-14 11:54:09 -0800114 _RPM_HOSTNAME_REGEX = ('chromeos(\d+)(-row(\d+))?-rack(\d+[a-z]*)'
115 '-host(\d+)')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -0700116
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -0800117 # Constants used in ping_wait_up() and ping_wait_down().
118 #
119 # _PING_WAIT_COUNT is the approximate number of polling
120 # cycles to use when waiting for a host state change.
121 #
122 # _PING_STATUS_DOWN and _PING_STATUS_UP are names used
123 # for arguments to the internal _ping_wait_for_status()
124 # method.
125 _PING_WAIT_COUNT = 40
126 _PING_STATUS_DOWN = False
127 _PING_STATUS_UP = True
128
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800129 # Allowed values for the power_method argument.
130
Garry Wang5e5538a2019-04-08 15:36:18 -0700131 # POWER_CONTROL_RPM: Used in power_off/on/cycle() methods, default for all
132 # DUTs except those with servo_v4 CCD.
133 # POWER_CONTROL_CCD: Used in power_off/on/cycle() methods, default for all
134 # DUTs with servo_v4 CCD.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800135 # POWER_CONTROL_SERVO: Used in set_power() and power_cycle() methods.
136 # POWER_CONTROL_MANUAL: Used in set_power() and power_cycle() methods.
137 POWER_CONTROL_RPM = 'RPM'
Garry Wang5e5538a2019-04-08 15:36:18 -0700138 POWER_CONTROL_CCD = 'CCD'
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800139 POWER_CONTROL_SERVO = 'servoj10'
140 POWER_CONTROL_MANUAL = 'manual'
141
142 POWER_CONTROL_VALID_ARGS = (POWER_CONTROL_RPM,
Garry Wang5e5538a2019-04-08 15:36:18 -0700143 POWER_CONTROL_CCD,
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800144 POWER_CONTROL_SERVO,
145 POWER_CONTROL_MANUAL)
Richard Barnette0c73ffc2012-11-19 15:21:18 -0800146
Garry Wang5e5538a2019-04-08 15:36:18 -0700147 # CCD_SERVO: The string of servo type to compare with the return value of
148 # self.servo.get_servo_version() to decide default power method.
149 CCD_SERVO = 'servo_v4_with_ccd_cr50'
150
Simran Basi5e6339a2013-03-21 11:34:32 -0700151 _RPM_OUTLET_CHANGED = 'outlet_changed'
152
Dan Shi9cb0eec2014-06-03 09:04:50 -0700153 # URL pattern to download firmware image.
Dan Shib8540a52015-07-16 14:18:23 -0700154 _FW_IMAGE_URL_PATTERN = CONFIG.get_config_value(
Dan Shi9cb0eec2014-06-03 09:04:50 -0700155 'CROS', 'firmware_url_pattern', type=str)
beeps687243d2013-07-18 15:29:27 -0700156
J. Richard Barnette964fba02012-10-24 17:34:29 -0700157 @staticmethod
beeps46dadc92013-11-07 14:07:10 -0800158 def check_host(host, timeout=10):
159 """
160 Check if the given host is a chrome-os host.
161
162 @param host: An ssh host representing a device.
163 @param timeout: The timeout for the run command.
164
165 @return: True if the host device is chromeos.
166
beeps46dadc92013-11-07 14:07:10 -0800167 """
168 try:
Allen Liad719c12017-06-27 23:48:04 +0000169 result = host.run(
Simran Basi933c8af2015-04-29 14:05:07 -0700170 'grep -q CHROMEOS /etc/lsb-release && '
Garry Wange4b6d6e2019-06-17 17:08:46 -0700171 '! grep -q moblab /etc/lsb-release && '
172 '! grep -q labstation /etc/lsb-release',
Simran Basi933c8af2015-04-29 14:05:07 -0700173 ignore_status=True, timeout=timeout)
Laurence Goodby468de252017-06-08 17:22:53 -0700174 if result.exit_status == 0:
Allen Liad719c12017-06-27 23:48:04 +0000175 lsb_release_content = host.run(
Laurence Goodby468de252017-06-08 17:22:53 -0700176 'grep CHROMEOS_RELEASE_BOARD /etc/lsb-release',
177 timeout=timeout).stdout
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -0800178 return not (
179 lsbrelease_utils.is_jetstream(
180 lsb_release_content=lsb_release_content) or
181 lsbrelease_utils.is_gce_board(
182 lsb_release_content=lsb_release_content))
183
beeps46dadc92013-11-07 14:07:10 -0800184 except (error.AutoservRunError, error.AutoservSSHTimeout):
185 return False
Laurence Goodby468de252017-06-08 17:22:53 -0700186
187 return False
beeps46dadc92013-11-07 14:07:10 -0800188
189
190 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800191 def get_chameleon_arguments(args_dict):
192 """Extract chameleon options from `args_dict` and return the result.
193
194 Recommended usage:
195 ~~~~~~~~
196 args_dict = utils.args_to_dict(args)
197 chameleon_args = hosts.CrosHost.get_chameleon_arguments(args_dict)
198 host = hosts.create_host(machine, chameleon_args=chameleon_args)
199 ~~~~~~~~
200
201 @param args_dict Dictionary from which to extract the chameleon
202 arguments.
203 """
howardchung83e55272019-08-08 14:08:05 +0800204 if 'chameleon_host_list' in args_dict:
205 result = []
206 for chameleon in args_dict['chameleon_host_list'].split(','):
207 result.append({key: value for key,value in
208 zip(('chameleon_host','chameleon_port'),
209 chameleon.split(':'))})
210
211 logging.info(result)
212 return result
213 else:
214 return {key: args_dict[key]
Allen Li083866b2016-08-18 10:07:10 -0700215 for key in ('chameleon_host', 'chameleon_port')
216 if key in args_dict}
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800217
218
219 @staticmethod
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700220 def get_pdtester_arguments(args_dict):
Scottfe06ed82015-11-05 17:15:01 -0800221 """Extract chameleon options from `args_dict` and return the result.
222
223 Recommended usage:
224 ~~~~~~~~
225 args_dict = utils.args_to_dict(args)
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700226 pdtester_args = hosts.CrosHost.get_pdtester_arguments(args_dict)
227 host = hosts.create_host(machine, pdtester_args=pdtester_args)
Scottfe06ed82015-11-05 17:15:01 -0800228 ~~~~~~~~
229
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700230 @param args_dict Dictionary from which to extract the pdtester
Scottfe06ed82015-11-05 17:15:01 -0800231 arguments.
232 """
Allen Li083866b2016-08-18 10:07:10 -0700233 return {key: args_dict[key]
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700234 for key in ('pdtester_host', 'pdtester_port')
Allen Li083866b2016-08-18 10:07:10 -0700235 if key in args_dict}
Scottfe06ed82015-11-05 17:15:01 -0800236
237
238 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800239 def get_servo_arguments(args_dict):
240 """Extract servo options from `args_dict` and return the result.
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800241
242 Recommended usage:
243 ~~~~~~~~
244 args_dict = utils.args_to_dict(args)
Fang Deng0ca40e22013-08-27 17:47:44 -0700245 servo_args = hosts.CrosHost.get_servo_arguments(args_dict)
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800246 host = hosts.create_host(machine, servo_args=servo_args)
247 ~~~~~~~~
248
249 @param args_dict Dictionary from which to extract the servo
250 arguments.
251 """
Richard Barnettee519dcd2016-08-15 17:37:17 -0700252 servo_attrs = (servo_host.SERVO_HOST_ATTR,
253 servo_host.SERVO_PORT_ATTR,
Nick Sanders2f3c9852018-10-24 12:10:24 -0700254 servo_host.SERVO_BOARD_ATTR,
255 servo_host.SERVO_MODEL_ATTR)
Armando Miraglia2ac802e2017-08-15 14:54:47 +0200256 servo_args = {key: args_dict[key]
257 for key in servo_attrs
258 if key in args_dict}
259 return (
260 None
261 if servo_host.SERVO_HOST_ATTR in servo_args
262 and not servo_args[servo_host.SERVO_HOST_ATTR]
263 else servo_args)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -0700264
J. Richard Barnette964fba02012-10-24 17:34:29 -0700265
J. Richard Barnette91137f02016-03-10 16:52:26 -0800266 def _initialize(self, hostname, chameleon_args=None, servo_args=None,
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700267 pdtester_args=None, try_lab_servo=False,
Richard Barnette9a26ad62016-06-10 12:03:08 -0700268 try_servo_repair=False,
J. Richard Barnette91137f02016-03-10 16:52:26 -0800269 ssh_verbosity_flag='', ssh_options='',
Fang Dengd1c2b732013-08-20 12:59:46 -0700270 *args, **dargs):
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800271 """Initialize superclasses, |self.chameleon|, and |self.servo|.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700272
Fang Denge545abb2014-12-30 18:43:47 -0800273 This method will attempt to create the test-assistant object
274 (chameleon/servo) when it is needed by the test. Check
275 the docstring of chameleon_host.create_chameleon_host and
276 servo_host.create_servo_host for how this is determined.
Fang Deng5d518f42013-08-02 14:04:32 -0700277
Fang Denge545abb2014-12-30 18:43:47 -0800278 @param hostname: Hostname of the dut.
279 @param chameleon_args: A dictionary that contains args for creating
280 a ChameleonHost. See chameleon_host for details.
281 @param servo_args: A dictionary that contains args for creating
282 a ServoHost object. See servo_host for details.
Richard Barnette9a26ad62016-06-10 12:03:08 -0700283 @param try_lab_servo: When true, indicates that an attempt should
284 be made to create a ServoHost for a DUT in
285 the test lab, even if not required by
286 `servo_args`. See servo_host for details.
287 @param try_servo_repair: If a servo host is created, check it
288 with `repair()` rather than `verify()`.
Fang Denge545abb2014-12-30 18:43:47 -0800289 See servo_host for details.
290 @param ssh_verbosity_flag: String, to pass to the ssh command to control
291 verbosity.
292 @param ssh_options: String, other ssh options to pass to the ssh
293 command.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700294 """
Fang Deng0ca40e22013-08-27 17:47:44 -0700295 super(CrosHost, self)._initialize(hostname=hostname,
J. Richard Barnette45e93de2012-04-11 17:24:15 -0700296 *args, **dargs)
J. Richard Barnette91137f02016-03-10 16:52:26 -0800297 self._repair_strategy = cros_repair.create_cros_repair_strategy()
Kevin Chenga2619dc2016-03-28 11:42:08 -0700298 self.labels = base_label.LabelRetriever(cros_label.CROS_LABELS)
J. Richard Barnettef0859852012-08-20 14:55:50 -0700299 # self.env is a dictionary of environment variable settings
300 # to be exported for commands run on the host.
301 # LIBC_FATAL_STDERR_ can be useful for diagnosing certain
302 # errors that might happen.
303 self.env['LIBC_FATAL_STDERR_'] = '1'
Fang Dengd1c2b732013-08-20 12:59:46 -0700304 self._ssh_verbosity_flag = ssh_verbosity_flag
Aviv Keshetc5947fa2013-09-04 14:06:29 -0700305 self._ssh_options = ssh_options
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700306 self.set_servo_host(
307 servo_host.create_servo_host(
Richard Barnetteea3e4602016-06-10 12:36:41 -0700308 dut=self, servo_args=servo_args,
Richard Barnette9a26ad62016-06-10 12:03:08 -0700309 try_lab_servo=try_lab_servo,
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700310 try_servo_repair=try_servo_repair))
Garry Wang5e5538a2019-04-08 15:36:18 -0700311 self._default_power_method = None
Richard Barnettee519dcd2016-08-15 17:37:17 -0700312
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800313 # TODO(waihong): Do the simplication on Chameleon too.
howardchung83e55272019-08-08 14:08:05 +0800314 if type(chameleon_args) is list:
315 self.multi_chameleon = True
316 chameleon_args_list = chameleon_args
317 else:
318 self.multi_chameleon = False
319 chameleon_args_list = [chameleon_args]
Tom Wai-Hong Tam3d6790d2014-04-14 16:15:47 +0800320
howardchung83e55272019-08-08 14:08:05 +0800321 self._chameleon_host_list = [
322 chameleon_host.create_chameleon_host(
323 dut=self.hostname, chameleon_args=_args)
324 for _args in chameleon_args_list]
325
326 self.chameleon_list = [_host.create_chameleon_board() for _host in
327 self._chameleon_host_list if _host is not None]
328 if len(self.chameleon_list) > 0:
329 self.chameleon = self.chameleon_list[0]
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800330 else:
Tom Wai-Hong Tam3d6790d2014-04-14 16:15:47 +0800331 self.chameleon = None
Fang Deng5d518f42013-08-02 14:04:32 -0700332
howardchung83e55272019-08-08 14:08:05 +0800333 # Add pdtester host if pdtester args were added on command line
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -0700334 self._pdtester_host = pdtester_host.create_pdtester_host(
Wai-Hong Tam90b164d2019-10-25 13:15:39 -0700335 pdtester_args, self._servo_host)
howardchung83e55272019-08-08 14:08:05 +0800336
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700337 if self._pdtester_host:
338 self.pdtester_servo = self._pdtester_host.get_servo()
339 logging.info('pdtester_servo: %r', self.pdtester_servo)
340 # Create the pdtester object used to access the ec uart
341 self.pdtester = pdtester.PDTester(self.pdtester_servo,
342 self._pdtester_host.get_servod_server_proxy())
Scottfe06ed82015-11-05 17:15:01 -0800343 else:
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700344 self.pdtester = None
Scottfe06ed82015-11-05 17:15:01 -0800345
Fang Deng5d518f42013-08-02 14:04:32 -0700346
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000347 def get_cros_repair_image_name(self):
Ruben Rodriguez Buchilloncee72f72019-05-01 13:20:58 -0700348 """Get latest stable cros image name from AFE.
349
350 Use the board name from the info store. Should that fail, try to
351 retrieve the board name from the host's installed image itself.
352
353 @returns: current stable cros image name for this host.
354 """
355 board = self.host_info_store.get().board
356 if not board:
357 logging.warn('No board label value found. Trying to infer '
358 'from the host itself.')
359 try:
360 board = self.get_board().split(':')[1]
361 except (error.AutoservRunError, error.AutoservSSHTimeout) as e:
362 logging.error('Also failed to get the board name from the DUT '
363 'itself. %s.', str(e))
364 raise error.AutoservError('Cannot obtain repair image name.')
365 return afe_utils.get_stable_cros_image_name(board)
Scott Zawalski89c44dd2013-02-26 09:28:02 -0500366
367
Rohit Makasanadf0a3a32017-06-30 13:55:18 -0700368 def host_version_prefix(self, image):
369 """Return version label prefix.
370
371 In case the CrOS provisioning version is something other than the
372 standard CrOS version e.g. CrOS TH version, this function will
373 find the prefix from provision.py.
374
375 @param image: The image name to find its version prefix.
376 @returns: A prefix string for the image type.
377 """
378 return provision.get_version_label_prefix(image)
379
380
beepsdae65fd2013-07-26 16:24:41 -0700381 def verify_job_repo_url(self, tag=''):
beepscb6f1e22013-06-28 19:14:10 -0700382 """
383 Make sure job_repo_url of this host is valid.
384
joychen03eaad92013-06-26 09:55:21 -0700385 Eg: The job_repo_url "http://lmn.cd.ab.xyx:8080/static/\
beepscb6f1e22013-06-28 19:14:10 -0700386 lumpy-release/R29-4279.0.0/autotest/packages" claims to have the
387 autotest package for lumpy-release/R29-4279.0.0. If this isn't the case,
388 download and extract it. If the devserver embedded in the url is
389 unresponsive, update the job_repo_url of the host after staging it on
390 another devserver.
391
392 @param job_repo_url: A url pointing to the devserver where the autotest
393 package for this build should be staged.
beepsdae65fd2013-07-26 16:24:41 -0700394 @param tag: The tag from the server job, in the format
395 <job_id>-<user>/<hostname>, or <hostless> for a server job.
beepscb6f1e22013-06-28 19:14:10 -0700396
397 @raises DevServerException: If we could not resolve a devserver.
398 @raises AutoservError: If we're unable to save the new job_repo_url as
399 a result of choosing a new devserver because the old one failed to
400 respond to a health check.
beeps0c865032013-07-30 11:37:06 -0700401 @raises urllib2.URLError: If the devserver embedded in job_repo_url
402 doesn't respond within the timeout.
beepscb6f1e22013-06-28 19:14:10 -0700403 """
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800404 info = self.host_info_store.get()
405 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
beepscb6f1e22013-06-28 19:14:10 -0700406 if not job_repo_url:
407 logging.warning('No job repo url set on host %s', self.hostname)
408 return
409
410 logging.info('Verifying job repo url %s', job_repo_url)
411 devserver_url, image_name = tools.get_devserver_build_from_package_url(
412 job_repo_url)
413
beeps0c865032013-07-30 11:37:06 -0700414 ds = dev_server.ImageServer(devserver_url)
beepscb6f1e22013-06-28 19:14:10 -0700415
416 logging.info('Staging autotest artifacts for %s on devserver %s',
417 image_name, ds.url())
beeps687243d2013-07-18 15:29:27 -0700418
419 start_time = time.time()
Simran Basi25e7a922014-10-31 11:56:10 -0700420 ds.stage_artifacts(image_name, ['autotest_packages'])
beeps687243d2013-07-18 15:29:27 -0700421 stage_time = time.time() - start_time
422
423 # Record how much of the verification time comes from a devserver
424 # restage. If we're doing things right we should not see multiple
425 # devservers for a given board/build/branch path.
426 try:
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800427 board, build_type, branch = server_utils.ParseBuildName(
beeps687243d2013-07-18 15:29:27 -0700428 image_name)[:3]
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800429 except server_utils.ParseBuildNameException:
beeps687243d2013-07-18 15:29:27 -0700430 pass
431 else:
beeps0c865032013-07-30 11:37:06 -0700432 devserver = devserver_url[
Chris Sosa65425082013-10-16 13:26:22 -0700433 devserver_url.find('/') + 2:devserver_url.rfind(':')]
beeps687243d2013-07-18 15:29:27 -0700434 stats_key = {
435 'board': board,
436 'build_type': build_type,
437 'branch': branch,
beeps0c865032013-07-30 11:37:06 -0700438 'devserver': devserver.replace('.', '_'),
beeps687243d2013-07-18 15:29:27 -0700439 }
Dan Shi5e2efb72017-02-07 11:40:23 -0800440
441 monarch_fields = {
442 'board': board,
443 'build_type': build_type,
Dan Shi5e2efb72017-02-07 11:40:23 -0800444 'branch': branch,
445 'dev_server': devserver,
446 }
447 metrics.Counter(
448 'chromeos/autotest/provision/verify_url'
449 ).increment(fields=monarch_fields)
450 metrics.SecondsDistribution(
451 'chromeos/autotest/provision/verify_url_duration'
452 ).add(stage_time, fields=monarch_fields)
453
454
Dan Shicf4d2032015-03-12 15:04:21 -0700455 def stage_server_side_package(self, image=None):
456 """Stage autotest server-side package on devserver.
457
458 @param image: Full path of an OS image to install or a build name.
459
460 @return: A url to the autotest server-side package.
Dan Shi14de7622016-08-22 11:09:06 -0700461
462 @raise: error.AutoservError if fail to locate the build to test with, or
463 fail to stage server-side package.
Dan Shicf4d2032015-03-12 15:04:21 -0700464 """
Dan Shid37736b2016-07-06 15:10:29 -0700465 # If enable_drone_in_restricted_subnet is False, do not set hostname
466 # in devserver.resolve call, so a devserver in non-restricted subnet
467 # is picked to stage autotest server package for drone to download.
468 hostname = self.hostname
469 if not server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
470 hostname = None
Dan Shicf4d2032015-03-12 15:04:21 -0700471 if image:
472 image_name = tools.get_build_from_image(image)
473 if not image_name:
474 raise error.AutoservError(
475 'Failed to parse build name from %s' % image)
Dan Shid37736b2016-07-06 15:10:29 -0700476 ds = dev_server.ImageServer.resolve(image_name, hostname)
Dan Shicf4d2032015-03-12 15:04:21 -0700477 else:
Prathmesh Prabhu9235e4c2017-03-28 13:16:06 -0700478 info = self.host_info_store.get()
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800479 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
Dan Shicf4d2032015-03-12 15:04:21 -0700480 if job_repo_url:
481 devserver_url, image_name = (
482 tools.get_devserver_build_from_package_url(job_repo_url))
Dan Shid37736b2016-07-06 15:10:29 -0700483 # If enable_drone_in_restricted_subnet is True, use the
484 # existing devserver. Otherwise, resolve a new one in
485 # non-restricted subnet.
486 if server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
487 ds = dev_server.ImageServer(devserver_url)
488 else:
489 ds = dev_server.ImageServer.resolve(image_name)
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800490 elif info.build is not None:
491 ds = dev_server.ImageServer.resolve(info.build, hostname)
Prathmesh Prabhu0c1dd4d2017-06-07 13:01:53 -0700492 image_name = info.build
Dan Shicf4d2032015-03-12 15:04:21 -0700493 else:
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800494 raise error.AutoservError(
495 'Failed to stage server-side package. The host has '
Garry Wang12b9baf2019-06-24 18:58:54 -0700496 'no job_repo_url attribute or cros-version label.')
Dan Shica503482015-03-30 17:23:25 -0700497
498 # Get the OS version of the build, for any build older than
499 # MIN_VERSION_SUPPORT_SSP, server side packaging is not supported.
500 match = re.match('.*/R\d+-(\d+)\.', image_name)
501 if match and int(match.group(1)) < self.MIN_VERSION_SUPPORT_SSP:
Dan Shi14de7622016-08-22 11:09:06 -0700502 raise error.AutoservError(
503 'Build %s is older than %s. Server side packaging is '
504 'disabled.' % (image_name, self.MIN_VERSION_SUPPORT_SSP))
Dan Shica503482015-03-30 17:23:25 -0700505
Dan Shicf4d2032015-03-12 15:04:21 -0700506 ds.stage_artifacts(image_name, ['autotest_server_package'])
507 return '%s/static/%s/%s' % (ds.url(), image_name,
508 'autotest_server_package.tar.bz2')
509
510
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700511 def stage_image_for_servo(self, image_name=None, artifact='test_image'):
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700512 """Stage a build on a devserver and return the update_url.
513
514 @param image_name: a name like lumpy-release/R27-3837.0.0
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700515 @param artifact: a string like 'test_image'. Requests
516 appropriate image to be staged.
Xixuan Wufee57542019-10-15 11:50:27 -0700517 @returns a tuple of (image_name, URL) like
518 (lumpy-release/R27-3837.0.0,
519 http://172.22.50.205:8082/update/lumpy-release/R27-3837.0.0)
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700520 """
521 if not image_name:
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000522 image_name = self.get_cros_repair_image_name()
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700523 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800524 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700525 devserver.stage_artifacts(image_name, [artifact])
526 if artifact == 'test_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700527 return image_name, devserver.get_test_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700528 elif artifact == 'recovery_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700529 return image_name, devserver.get_recovery_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700530 else:
531 raise error.AutoservError("Bad artifact!")
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700532
533
beepse539be02013-07-31 21:57:39 -0700534 def stage_factory_image_for_servo(self, image_name):
535 """Stage a build on a devserver and return the update_url.
536
537 @param image_name: a name like <baord>/4262.204.0
beeps12c0a3c2013-09-03 11:58:27 -0700538
beepse539be02013-07-31 21:57:39 -0700539 @return: An update URL, eg:
540 http://<devserver>/static/canary-channel/\
541 <board>/4262.204.0/factory_test/chromiumos_factory_image.bin
beeps12c0a3c2013-09-03 11:58:27 -0700542
543 @raises: ValueError if the factory artifact name is missing from
544 the config.
545
beepse539be02013-07-31 21:57:39 -0700546 """
547 if not image_name:
548 logging.error('Need an image_name to stage a factory image.')
549 return
550
Dan Shib8540a52015-07-16 14:18:23 -0700551 factory_artifact = CONFIG.get_config_value(
beeps12c0a3c2013-09-03 11:58:27 -0700552 'CROS', 'factory_artifact', type=str, default='')
553 if not factory_artifact:
554 raise ValueError('Cannot retrieve the factory artifact name from '
555 'autotest config, and hence cannot stage factory '
556 'artifacts.')
557
beepse539be02013-07-31 21:57:39 -0700558 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800559 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
beepse539be02013-07-31 21:57:39 -0700560 devserver.stage_artifacts(
561 image_name,
beeps12c0a3c2013-09-03 11:58:27 -0700562 [factory_artifact],
563 archive_url=None)
beepse539be02013-07-31 21:57:39 -0700564
565 return tools.factory_image_url_pattern() % (devserver.url(), image_name)
566
567
Laurence Goodby778c9a42017-05-24 19:24:07 -0700568 def prepare_for_update(self):
569 """Prepares the DUT for an update.
570
571 Subclasses may override this to perform any special actions
572 required before updating.
573 """
Laurence Goodby468de252017-06-08 17:22:53 -0700574 pass
Laurence Goodby778c9a42017-05-24 19:24:07 -0700575
576
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800577 def _clear_fw_version_labels(self, rw_only):
578 """Clear firmware version labels from the machine.
579
580 @param rw_only: True to only clear fwrw_version; otherewise, clear
581 both fwro_version and fwrw_version.
582 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700583 info = self.host_info_store.get()
584 info.clear_version_labels(provision.FW_RW_VERSION_PREFIX)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800585 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700586 info.clear_version_labels(provision.FW_RO_VERSION_PREFIX)
587 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700588
589
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800590 def _add_fw_version_label(self, build, rw_only):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700591 """Add firmware version label to the machine.
592
593 @param build: Build of firmware.
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800594 @param rw_only: True to only add fwrw_version; otherwise, add both
595 fwro_version and fwrw_version.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700596
597 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700598 info = self.host_info_store.get()
599 info.set_version_label(provision.FW_RW_VERSION_PREFIX, build)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800600 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700601 info.set_version_label(provision.FW_RO_VERSION_PREFIX, build)
602 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700603
604
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700605 def firmware_install(self, build=None, rw_only=False, dest=None):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700606 """Install firmware to the DUT.
607
608 Use stateful update if the DUT is already running the same build.
609 Stateful update does not update kernel and tends to run much faster
610 than a full reimage. If the DUT is running a different build, or it
611 failed to do a stateful update, full update, including kernel update,
612 will be applied to the DUT.
613
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800614 Once a host enters firmware_install its fw[ro|rw]_version label will
615 be removed. After the firmware is updated successfully, a new
616 fw[ro|rw]_version label will be added to the host.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700617
618 @param build: The build version to which we want to provision the
619 firmware of the machine,
620 e.g. 'link-firmware/R22-2695.1.144'.
Tom Wai-Hong Tam4ac78982016-01-08 02:34:37 +0800621 @param rw_only: True to only install firmware to its RW portions. Keep
622 the RO portions unchanged.
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700623 @param dest: Directory to store the firmware in.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700624
625 TODO(dshi): After bug 381718 is fixed, update here with corresponding
626 exceptions that could be raised.
627
628 """
629 if not self.servo:
630 raise error.TestError('Host %s does not have servo.' %
631 self.hostname)
632
Wai-Hong Tam3fa455a2018-07-18 14:40:43 -0700633 # Get the DUT board name from AFE.
634 info = self.host_info_store.get()
635 board = info.board
Shelley Chenac61d5a2019-06-24 15:35:46 -0700636 model = info.model
Namyoon Woo8dbfcf92019-01-15 18:37:12 -0800637
638 if board is None or board == '':
639 board = self.servo.get_board()
Dan Shi9cb0eec2014-06-03 09:04:50 -0700640
Mary Ruthvende14a8b2019-08-23 12:43:52 -0700641 if model is None or model == '':
642 model = self.get_platform_from_fwid()
643
Chris Sosae92399e2015-04-24 11:32:59 -0700644 # If build is not set, try to install firmware from stable CrOS.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700645 if not build:
Richard Barnette260cbd02016-10-06 12:23:28 -0700646 build = afe_utils.get_stable_faft_version(board)
Dan Shi3d7a0e12015-10-12 11:55:45 -0700647 if not build:
648 raise error.TestError(
649 'Failed to find stable firmware build for %s.',
650 self.hostname)
651 logging.info('Will install firmware from build %s.', build)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700652
Dan Shi216389c2015-12-22 11:03:06 -0800653 ds = dev_server.ImageServer.resolve(build, self.hostname)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700654 ds.stage_artifacts(build, ['firmware'])
655
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700656 tmpd = None
657 if not dest:
658 tmpd = autotemp.tempdir(unique_id='fwimage')
659 dest = tmpd.name
Dan Shi9cb0eec2014-06-03 09:04:50 -0700660 try:
661 fwurl = self._FW_IMAGE_URL_PATTERN % (ds.url(), build)
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700662 local_tarball = os.path.join(dest, os.path.basename(fwurl))
xixuan4e116822016-11-17 15:32:10 -0800663 ds.download_file(fwurl, local_tarball)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700664
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800665 self._clear_fw_version_labels(rw_only)
Shelley Chenac61d5a2019-06-24 15:35:46 -0700666 self.servo.program_firmware(board, model, local_tarball, rw_only)
Wai-Hong Tamb5f66ce2016-11-10 15:45:30 -0800667 if utils.host_is_in_lab_zone(self.hostname):
668 self._add_fw_version_label(build, rw_only)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700669 finally:
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700670 if tmpd:
671 tmpd.clean()
Dan Shi9cb0eec2014-06-03 09:04:50 -0700672
673
beepsf079cfb2013-09-18 17:49:51 -0700674 def servo_install(self, image_url=None, usb_boot_timeout=USB_BOOT_TIMEOUT,
675 install_timeout=INSTALL_TIMEOUT):
Scott Zawalski62bacae2013-03-05 10:40:32 -0500676 """
677 Re-install the OS on the DUT by:
678 1) installing a test image on a USB storage device attached to the Servo
679 board,
Richard Barnette03a0c132012-11-05 12:40:35 -0800680 2) booting that image in recovery mode, and then
J. Richard Barnette31b2e312013-04-04 16:05:22 -0700681 3) installing the image with chromeos-install.
682
Scott Zawalski62bacae2013-03-05 10:40:32 -0500683 @param image_url: If specified use as the url to install on the DUT.
684 otherwise boot the currently staged image on the USB stick.
beepsf079cfb2013-09-18 17:49:51 -0700685 @param usb_boot_timeout: The usb_boot_timeout to use during reimage.
686 Factory images need a longer usb_boot_timeout than regular
687 cros images.
688 @param install_timeout: The timeout to use when installing the chromeos
689 image. Factory images need a longer install_timeout.
Richard Barnette03a0c132012-11-05 12:40:35 -0800690
Scott Zawalski62bacae2013-03-05 10:40:32 -0500691 @raises AutoservError if the image fails to boot.
beepsf079cfb2013-09-18 17:49:51 -0700692
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800693 """
beepsf079cfb2013-09-18 17:49:51 -0700694 logging.info('Downloading image to USB, then booting from it. Usb boot '
695 'timeout = %s', usb_boot_timeout)
Allen Li48a13fe2016-11-22 14:10:40 -0800696 with metrics.SecondsTimer(
697 'chromeos/autotest/provision/servo_install/boot_duration'):
698 self.servo.install_recovery_image(image_url)
699 if not self.wait_up(timeout=usb_boot_timeout):
700 raise hosts.AutoservRepairError(
701 'DUT failed to boot from USB after %d seconds' %
Garry Wang954f8382019-01-23 13:49:29 -0800702 usb_boot_timeout, 'failed_to_reboot')
Scott Zawalski62bacae2013-03-05 10:40:32 -0500703
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +0800704 # The new chromeos-tpm-recovery has been merged since R44-7073.0.0.
705 # In old CrOS images, this command fails. Skip the error.
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +0800706 logging.info('Resetting the TPM status')
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +0800707 try:
708 self.run('chromeos-tpm-recovery')
709 except error.AutoservRunError:
710 logging.warn('chromeos-tpm-recovery is too old.')
711
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +0800712
Allen Li48a13fe2016-11-22 14:10:40 -0800713 with metrics.SecondsTimer(
714 'chromeos/autotest/provision/servo_install/install_duration'):
715 logging.info('Installing image through chromeos-install.')
Garry Wang83fb5b32019-09-27 13:16:00 -0700716 self.run('chromeos-install --yes',timeout=install_timeout)
Anh Lee21e4032019-07-11 15:01:06 -0700717
Allen Li48a13fe2016-11-22 14:10:40 -0800718 self.halt()
beepsf079cfb2013-09-18 17:49:51 -0700719
720 logging.info('Power cycling DUT through servo.')
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800721 self.servo.get_power_state_controller().power_off()
Fang Dengafb88142013-05-30 17:44:31 -0700722 self.servo.switch_usbkey('off')
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800723 # N.B. The Servo API requires that we use power_on() here
724 # for two reasons:
725 # 1) After turning on a DUT in recovery mode, you must turn
726 # it off and then on with power_on() once more to
727 # disable recovery mode (this is a Parrot specific
728 # requirement).
729 # 2) After power_off(), the only way to turn on is with
730 # power_on() (this is a Storm specific requirement).
J. Richard Barnettefbcc7122013-07-24 18:24:59 -0700731 self.servo.get_power_state_controller().power_on()
beepsf079cfb2013-09-18 17:49:51 -0700732
733 logging.info('Waiting for DUT to come back up.')
Richard Barnette03a0c132012-11-05 12:40:35 -0800734 if not self.wait_up(timeout=self.BOOT_TIMEOUT):
735 raise error.AutoservError('DUT failed to reboot installed '
736 'test image after %d seconds' %
Scott Zawalski62bacae2013-03-05 10:40:32 -0500737 self.BOOT_TIMEOUT)
738
739
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700740 def set_servo_host(self, host):
741 """Set our servo host member, and associated servo.
742
743 @param host Our new `ServoHost`.
744 """
745 self._servo_host = host
746 if self._servo_host is not None:
747 self.servo = self._servo_host.get_servo()
748 else:
749 self.servo = None
750
751
Richard Barnette9a26ad62016-06-10 12:03:08 -0700752 def repair_servo(self):
Dan Shi90466352015-09-22 15:01:05 -0700753 """
Richard Barnette9a26ad62016-06-10 12:03:08 -0700754 Confirm that servo is initialized and verified.
Dan Shi90466352015-09-22 15:01:05 -0700755
Richard Barnette9a26ad62016-06-10 12:03:08 -0700756 If the servo object is missing, attempt to repair the servo
757 host. Repair failures are passed back to the caller.
758
759 @raise AutoservError: If there is no servo host for this CrOS
760 host.
761 """
762 if self.servo:
763 return
764 if not self._servo_host:
765 raise error.AutoservError('No servo host for %s.' %
766 self.hostname)
767 self._servo_host.repair()
768 self.servo = self._servo_host.get_servo()
Dan Shi90466352015-09-22 15:01:05 -0700769
770
J. Richard Barnettec2d99cf2015-11-18 12:46:15 -0800771 def repair(self):
772 """Attempt to get the DUT to pass `self.verify()`.
Richard Barnette82c35912012-11-20 10:09:10 -0800773
774 This overrides the base class function for repair; it does
J. Richard Barnette91137f02016-03-10 16:52:26 -0800775 not call back to the parent class, but instead relies on
776 `self._repair_strategy` to coordinate the verification and
777 repair steps needed to get the DUT working.
Richard Barnette82c35912012-11-20 10:09:10 -0800778 """
Richard Barnetteabbdc252018-07-26 16:57:42 -0700779 message = 'Beginning repair for host %s board %s model %s'
780 info = self.host_info_store.get()
781 message %= (self.hostname, info.board, info.model)
782 self.record('INFO', None, None, message)
J. Richard Barnette91137f02016-03-10 16:52:26 -0800783 self._repair_strategy.repair(self)
Scott Zawalski89c44dd2013-02-26 09:28:02 -0500784
Richard Barnette82c35912012-11-20 10:09:10 -0800785
J. Richard Barnette1d78b012012-05-15 13:56:30 -0700786 def close(self):
David Rileye2c6be12017-12-11 10:20:57 -0800787 """Close connection."""
Fang Deng0ca40e22013-08-27 17:47:44 -0700788 super(CrosHost, self).close()
howardchung83e55272019-08-08 14:08:05 +0800789
790 for chameleon_host in self._chameleon_host_list:
791 if chameleon_host:
792 chameleon_host.close()
xixuand6011f12016-12-08 15:01:58 -0800793
794 if self._servo_host:
795 self._servo_host.close()
J. Richard Barnette1d78b012012-05-15 13:56:30 -0700796
797
Dan Shi49ca0932014-11-14 11:22:27 -0800798 def get_power_supply_info(self):
799 """Get the output of power_supply_info.
800
801 power_supply_info outputs the info of each power supply, e.g.,
802 Device: Line Power
803 online: no
804 type: Mains
805 voltage (V): 0
806 current (A): 0
807 Device: Battery
808 state: Discharging
809 percentage: 95.9276
810 technology: Li-ion
811
812 Above output shows two devices, Line Power and Battery, with details of
813 each device listed. This function parses the output into a dictionary,
814 with key being the device name, and value being a dictionary of details
815 of the device info.
816
817 @return: The dictionary of power_supply_info, e.g.,
818 {'Line Power': {'online': 'yes', 'type': 'main'},
819 'Battery': {'vendor': 'xyz', 'percentage': '100'}}
Dan Shie9b765d2014-12-29 16:59:49 -0800820 @raise error.AutoservRunError if power_supply_info tool is not found in
821 the DUT. Caller should handle this error to avoid false failure
822 on verification.
Dan Shi49ca0932014-11-14 11:22:27 -0800823 """
824 result = self.run('power_supply_info').stdout.strip()
825 info = {}
826 device_name = None
827 device_info = {}
828 for line in result.split('\n'):
829 pair = [v.strip() for v in line.split(':')]
830 if len(pair) != 2:
831 continue
832 if pair[0] == 'Device':
833 if device_name:
834 info[device_name] = device_info
835 device_name = pair[1]
836 device_info = {}
837 else:
838 device_info[pair[0]] = pair[1]
839 if device_name and not device_name in info:
840 info[device_name] = device_info
841 return info
842
843
844 def get_battery_percentage(self):
845 """Get the battery percentage.
846
847 @return: The percentage of battery level, value range from 0-100. Return
848 None if the battery info cannot be retrieved.
849 """
850 try:
851 info = self.get_power_supply_info()
852 logging.info(info)
853 return float(info['Battery']['percentage'])
Dan Shie9b765d2014-12-29 16:59:49 -0800854 except (KeyError, ValueError, error.AutoservRunError):
Dan Shi49ca0932014-11-14 11:22:27 -0800855 return None
856
857
858 def is_ac_connected(self):
859 """Check if the dut has power adapter connected and charging.
860
861 @return: True if power adapter is connected and charging.
862 """
863 try:
864 info = self.get_power_supply_info()
865 return info['Line Power']['online'] == 'yes'
Dan Shie9b765d2014-12-29 16:59:49 -0800866 except (KeyError, error.AutoservRunError):
867 return None
Dan Shi49ca0932014-11-14 11:22:27 -0800868
869
Simran Basi5e6339a2013-03-21 11:34:32 -0700870 def _cleanup_poweron(self):
871 """Special cleanup method to make sure hosts always get power back."""
Garry Wangad4d4fd2019-01-30 17:00:38 -0800872 info = self.host_info_store.get()
873 if self._RPM_OUTLET_CHANGED not in info.attributes:
Simran Basi5e6339a2013-03-21 11:34:32 -0700874 return
875 logging.debug('This host has recently interacted with the RPM'
876 ' Infrastructure. Ensuring power is on.')
877 try:
878 self.power_on()
Garry Wangad4d4fd2019-01-30 17:00:38 -0800879 self._remove_rpm_changed_tag()
Simran Basi5e6339a2013-03-21 11:34:32 -0700880 except rpm_client.RemotePowerException:
Simran Basi5e6339a2013-03-21 11:34:32 -0700881 logging.error('Failed to turn Power On for this host after '
882 'cleanup through the RPM Infrastructure.')
Dan Shi49ca0932014-11-14 11:22:27 -0800883
884 battery_percentage = self.get_battery_percentage()
Dan Shif01ebe22014-12-05 13:10:57 -0800885 if battery_percentage and battery_percentage < 50:
Dan Shi49ca0932014-11-14 11:22:27 -0800886 raise
887 elif self.is_ac_connected():
888 logging.info('The device has power adapter connected and '
889 'charging. No need to try to turn RPM on '
890 'again.')
Garry Wangad4d4fd2019-01-30 17:00:38 -0800891 self._remove_rpm_changed_tag()
Dan Shi49ca0932014-11-14 11:22:27 -0800892 logging.info('Battery level is now at %s%%. The device may '
893 'still have enough power to run test, so no '
894 'exception will be raised.', battery_percentage)
895
Simran Basi5e6339a2013-03-21 11:34:32 -0700896
Garry Wangad4d4fd2019-01-30 17:00:38 -0800897 def _remove_rpm_changed_tag(self):
898 info = self.host_info_store.get()
899 del info.attributes[self._RPM_OUTLET_CHANGED]
900 self.host_info_store.commit(info)
901
902
903 def _add_rpm_changed_tag(self):
904 info = self.host_info_store.get()
Garry Wang518831d2019-02-21 15:15:36 -0800905 info.attributes[self._RPM_OUTLET_CHANGED] = 'true'
Garry Wangad4d4fd2019-01-30 17:00:38 -0800906 self.host_info_store.commit(info)
907
908
909
beepsc87ff602013-07-31 21:53:00 -0700910 def _is_factory_image(self):
911 """Checks if the image on the DUT is a factory image.
912
913 @return: True if the image on the DUT is a factory image.
914 False otherwise.
915 """
916 result = self.run('[ -f /root/.factory_test ]', ignore_status=True)
917 return result.exit_status == 0
918
919
920 def _restart_ui(self):
J. Richard Barnette84890bd2014-02-21 11:05:47 -0800921 """Restart the Chrome UI.
beepsc87ff602013-07-31 21:53:00 -0700922
923 @raises: FactoryImageCheckerException for factory images, since
924 we cannot attempt to restart ui on them.
925 error.AutoservRunError for any other type of error that
926 occurs while restarting ui.
927 """
928 if self._is_factory_image():
Dan Shi549fb822015-03-24 18:01:11 -0700929 raise FactoryImageCheckerException('Cannot restart ui on factory '
930 'images')
beepsc87ff602013-07-31 21:53:00 -0700931
J. Richard Barnette84890bd2014-02-21 11:05:47 -0800932 # TODO(jrbarnette): The command to stop/start the ui job
933 # should live inside cros_ui, too. However that would seem
934 # to imply interface changes to the existing start()/restart()
935 # functions, which is a bridge too far (for now).
J. Richard Barnette6069aa12015-06-08 09:10:24 -0700936 prompt = cros_ui.get_chrome_session_ident(self)
J. Richard Barnette84890bd2014-02-21 11:05:47 -0800937 self.run('stop ui; start ui')
938 cros_ui.wait_for_chrome_ready(prompt, self)
beepsc87ff602013-07-31 21:53:00 -0700939
940
Daniel Erat4b5f7e02018-07-04 22:05:30 -0700941 def _start_powerd_if_needed(self):
942 """Start powerd if it isn't already running."""
943 self.run('start powerd', ignore_status=True)
944
945
xixuana3bbc422017-05-04 15:57:21 -0700946 def _get_lsb_release_content(self):
947 """Return the content of lsb-release file of host."""
948 return self.run(
949 'cat "%s"' % client_constants.LSB_RELEASE).stdout.strip()
950
951
Dan Shi549fb822015-03-24 18:01:11 -0700952 def get_release_version(self):
953 """Get the value of attribute CHROMEOS_RELEASE_VERSION from lsb-release.
954
955 @returns The version string in lsb-release, under attribute
956 CHROMEOS_RELEASE_VERSION.
957 """
Dan Shi549fb822015-03-24 18:01:11 -0700958 return lsbrelease_utils.get_chromeos_release_version(
xixuana3bbc422017-05-04 15:57:21 -0700959 lsb_release_content=self._get_lsb_release_content())
960
961
Don Garrettb9f35802018-01-22 18:25:40 -0800962 def get_release_builder_path(self):
963 """Get the value of CHROMEOS_RELEASE_BUILDER_PATH from lsb-release.
964
965 @returns The version string in lsb-release, under attribute
966 CHROMEOS_RELEASE_BUILDER_PATH.
967 """
968 return lsbrelease_utils.get_chromeos_release_builder_path(
969 lsb_release_content=self._get_lsb_release_content())
970
971
xixuana3bbc422017-05-04 15:57:21 -0700972 def get_chromeos_release_milestone(self):
973 """Get the value of attribute CHROMEOS_RELEASE_BUILD_TYPE
974 from lsb-release.
975
976 @returns The version string in lsb-release, under attribute
977 CHROMEOS_RELEASE_BUILD_TYPE.
978 """
979 return lsbrelease_utils.get_chromeos_release_milestone(
980 lsb_release_content=self._get_lsb_release_content())
Dan Shi549fb822015-03-24 18:01:11 -0700981
982
983 def verify_cros_version_label(self):
984 """ Make sure host's cros-version label match the actual image in dut.
985
986 Remove any cros-version: label that doesn't match that installed in
987 the dut.
988
989 @param raise_error: Set to True to raise exception if any mismatch found
990
991 @raise error.AutoservError: If any mismatch between cros-version label
992 and the build installed in dut is found.
993 """
Prathmesh Prabhuce2da3a2019-10-04 11:54:51 -0700994 # crbug.com/1007333: This check is being removed.
995 return True
Dan Shi549fb822015-03-24 18:01:11 -0700996
997
Laurence Goodby778c9a42017-05-24 19:24:07 -0700998 def cleanup_services(self):
999 """Reinitializes the device for cleanup.
1000
1001 Subclasses may override this to customize the cleanup method.
1002
1003 To indicate failure of the reset, the implementation may raise
1004 any of:
1005 error.AutoservRunError
1006 error.AutotestRunError
1007 FactoryImageCheckerException
1008
1009 @raises error.AutoservRunError
1010 @raises error.AutotestRunError
1011 @raises error.FactoryImageCheckerException
1012 """
1013 self._restart_ui()
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001014 self._start_powerd_if_needed()
Laurence Goodby778c9a42017-05-24 19:24:07 -07001015
1016
beepsc87ff602013-07-31 21:53:00 -07001017 def cleanup(self):
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -08001018 """Cleanup state on device."""
MK Ryu35d661e2014-09-25 17:44:10 -07001019 self.run('rm -f %s' % client_constants.CLEANUP_LOGS_PAUSED_FILE)
Scott Zawalskiddbc31e2012-11-15 11:29:01 -05001020 try:
Laurence Goodby778c9a42017-05-24 19:24:07 -07001021 self.cleanup_services()
beepsc87ff602013-07-31 21:53:00 -07001022 except (error.AutotestRunError, error.AutoservRunError,
1023 FactoryImageCheckerException):
Ilja H. Friedel04be2bd2014-05-07 21:29:59 -07001024 logging.warning('Unable to restart ui, rebooting device.')
Scott Zawalskiddbc31e2012-11-15 11:29:01 -05001025 # Since restarting the UI fails fall back to normal Autotest
1026 # cleanup routines, i.e. reboot the machine.
Fang Deng0ca40e22013-08-27 17:47:44 -07001027 super(CrosHost, self).cleanup()
Simran Basi5e6339a2013-03-21 11:34:32 -07001028 # Check if the rpm outlet was manipulated.
Simran Basid5e5e272012-09-24 15:23:59 -07001029 if self.has_power():
Simran Basi5e6339a2013-03-21 11:34:32 -07001030 self._cleanup_poweron()
Dan Shi549fb822015-03-24 18:01:11 -07001031 self.verify_cros_version_label()
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001032
1033
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001034 def reboot(self, **dargs):
1035 """
1036 This function reboots the site host. The more generic
1037 RemoteHost.reboot() performs sync and sleeps for 5
1038 seconds. This is not necessary for Chrome OS devices as the
1039 sync should be finished in a short time during the reboot
1040 command.
1041 """
Tom Wai-Hong Tamf5cd1d42012-08-13 12:04:08 +08001042 if 'reboot_cmd' not in dargs:
Doug Anderson7d5aeb22014-02-27 15:12:17 -08001043 reboot_timeout = dargs.get('reboot_timeout', 10)
J. Richard Barnette9af19632015-09-25 12:18:03 -07001044 dargs['reboot_cmd'] = ('sleep 1; '
1045 'reboot & sleep %d; '
1046 'reboot -f' % reboot_timeout)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001047 # Enable fastsync to avoid running extra sync commands before reboot.
Tom Wai-Hong Tamf5cd1d42012-08-13 12:04:08 +08001048 if 'fastsync' not in dargs:
1049 dargs['fastsync'] = True
Michael Liangda8c60a2014-06-03 13:24:51 -07001050
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001051 dargs['board'] = self.host_info_store.get().board
Vincent Palatindf2372c2016-10-07 17:03:00 +02001052 # Record who called us
1053 orig = sys._getframe(1).f_code
Vincent Palatin80780b22016-07-27 16:02:37 +02001054 metric_fields = {'board' : dargs['board'],
Vincent Palatindf2372c2016-10-07 17:03:00 +02001055 'dut_host_name' : self.hostname,
1056 'success' : True}
1057 metric_debug_fields = {'board' : dargs['board'],
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001058 'caller' : "%s:%s" % (orig.co_filename,
1059 orig.co_name),
Vincent Palatindf2372c2016-10-07 17:03:00 +02001060 'success' : True,
1061 'error' : ''}
1062
Vincent Palatin80780b22016-07-27 16:02:37 +02001063 t0 = time.time()
1064 try:
1065 super(CrosHost, self).reboot(**dargs)
1066 except Exception as e:
1067 metric_fields['success'] = False
Vincent Palatindf2372c2016-10-07 17:03:00 +02001068 metric_debug_fields['success'] = False
1069 metric_debug_fields['error'] = type(e).__name__
Vincent Palatin80780b22016-07-27 16:02:37 +02001070 raise
1071 finally:
1072 duration = int(time.time() - t0)
Dan Shi5e2efb72017-02-07 11:40:23 -08001073 metrics.Counter(
1074 'chromeos/autotest/autoserv/reboot_count').increment(
1075 fields=metric_fields)
1076 metrics.Counter(
1077 'chromeos/autotest/autoserv/reboot_debug').increment(
1078 fields=metric_debug_fields)
1079 metrics.SecondsDistribution(
1080 'chromeos/autotest/autoserv/reboot_duration').add(
1081 duration, fields=metric_fields)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001082
1083
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001084 def suspend(self, suspend_time=60,
1085 suspend_cmd=None, allow_early_resume=False):
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001086 """
1087 This function suspends the site host.
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001088
1089 @param suspend_time: How long to suspend as integer seconds.
1090 @param suspend_cmd: Suspend command to execute.
1091 @param allow_early_resume: If False and if device resumes before
1092 |suspend_time|, throw an error.
1093
1094 @exception AutoservSuspendError Host resumed earlier than
1095 |suspend_time|.
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001096 """
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001097
1098 if suspend_cmd is None:
1099 suspend_cmd = ' && '.join([
J. Richard Barnette9af19632015-09-25 12:18:03 -07001100 'echo 0 > /sys/class/rtc/rtc0/wakealarm',
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001101 'echo +%d > /sys/class/rtc/rtc0/wakealarm' % suspend_time,
J. Richard Barnette9af19632015-09-25 12:18:03 -07001102 'powerd_dbus_suspend --delay=0'])
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001103 super(CrosHost, self).suspend(suspend_time, suspend_cmd,
1104 allow_early_resume);
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001105
1106
Simran Basiec564392014-08-25 16:48:09 -07001107 def upstart_status(self, service_name):
1108 """Check the status of an upstart init script.
1109
1110 @param service_name: Service to look up.
1111
1112 @returns True if the service is running, False otherwise.
1113 """
Richard Barnettee204dc52017-09-26 11:02:25 -07001114 return 'start/running' in self.run('status %s' % service_name,
1115 ignore_status=True).stdout
Simran Basiec564392014-08-25 16:48:09 -07001116
Tom Hughese9552342018-12-18 14:29:25 -08001117 def upstart_stop(self, service_name):
1118 """Stops an upstart job if it's running.
1119
1120 @param service_name: Service to stop
1121
1122 @returns True if service has been stopped or was already stopped
1123 False otherwise.
1124 """
1125 if not self.upstart_status(service_name):
1126 return True
1127
1128 result = self.run('stop %s' % service_name, ignore_status=True)
1129 if result.exit_status != 0:
1130 return False
1131 return True
1132
1133 def upstart_restart(self, service_name):
1134 """Restarts (or starts) an upstart job.
1135
1136 @param service_name: Service to start/restart
1137
1138 @returns True if service has been started/restarted, False otherwise.
1139 """
1140 cmd = 'start'
1141 if self.upstart_status(service_name):
1142 cmd = 'restart'
1143 cmd = cmd + ' %s' % service_name
1144 result = self.run(cmd)
1145 if result.exit_status != 0:
1146 return False
1147 return True
Simran Basiec564392014-08-25 16:48:09 -07001148
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001149 def verify_software(self):
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001150 """Verify working software on a Chrome OS system.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001151
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001152 Tests for the following conditions:
1153 1. All conditions tested by the parent version of this
1154 function.
1155 2. Sufficient space in /mnt/stateful_partition.
Fang Deng6b05f5b2013-03-20 13:42:11 -07001156 3. Sufficient space in /mnt/stateful_partition/encrypted.
1157 4. update_engine answers a simple status request over DBus.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001158
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001159 """
Fang Deng0ca40e22013-08-27 17:47:44 -07001160 super(CrosHost, self).verify_software()
Dan Shib8540a52015-07-16 14:18:23 -07001161 default_kilo_inodes_required = CONFIG.get_config_value(
1162 'SERVER', 'kilo_inodes_required', type=int, default=100)
1163 board = self.get_board().replace(ds_constants.BOARD_PREFIX, '')
1164 kilo_inodes_required = CONFIG.get_config_value(
1165 'SERVER', 'kilo_inodes_required_%s' % board,
1166 type=int, default=default_kilo_inodes_required)
1167 self.check_inodes('/mnt/stateful_partition', kilo_inodes_required)
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001168 self.check_diskspace(
1169 '/mnt/stateful_partition',
Dan Shib8540a52015-07-16 14:18:23 -07001170 CONFIG.get_config_value(
Fang Deng6b05f5b2013-03-20 13:42:11 -07001171 'SERVER', 'gb_diskspace_required', type=float,
1172 default=20.0))
Gaurav Shahe448af82014-06-19 15:18:59 -07001173 encrypted_stateful_path = '/mnt/stateful_partition/encrypted'
1174 # Not all targets build with encrypted stateful support.
1175 if self.path_exists(encrypted_stateful_path):
1176 self.check_diskspace(
1177 encrypted_stateful_path,
Dan Shib8540a52015-07-16 14:18:23 -07001178 CONFIG.get_config_value(
Gaurav Shahe448af82014-06-19 15:18:59 -07001179 'SERVER', 'gb_encrypted_diskspace_required', type=float,
1180 default=0.1))
beepsc87ff602013-07-31 21:53:00 -07001181
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001182 self.wait_for_system_services()
Prashanth B5d0a0512014-04-25 12:26:08 -07001183
beepsc87ff602013-07-31 21:53:00 -07001184 # Factory images don't run update engine,
1185 # goofy controls dbus on these DUTs.
1186 if not self._is_factory_image():
1187 self.run('update_engine_client --status')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001188
Dan Shi549fb822015-03-24 18:01:11 -07001189 self.verify_cros_version_label()
1190
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001191
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001192 @retry.retry(error.AutoservError, timeout_min=5, delay_sec=10)
1193 def wait_for_system_services(self):
1194 """Waits for system-services to be running.
1195
1196 Sometimes, update_engine will take a while to update firmware, so we
1197 should give this some time to finish. See crbug.com/765686#c38 for
1198 details.
1199 """
1200 if not self.upstart_status('system-services'):
1201 raise error.AutoservError('Chrome failed to reach login. '
1202 'System services not running.')
1203
1204
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001205 def verify(self):
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -08001206 """Verify Chrome OS system is in good state."""
Richard Barnetteabbdc252018-07-26 16:57:42 -07001207 message = 'Beginning verify for host %s board %s model %s'
1208 info = self.host_info_store.get()
1209 message %= (self.hostname, info.board, info.model)
1210 self.record('INFO', None, None, message)
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001211 self._repair_strategy.verify(self)
1212
1213
Fang Deng96667ca2013-08-01 17:46:18 -07001214 def make_ssh_command(self, user='root', port=22, opts='', hosts_file=None,
Dean Liaoe3e75f62017-11-14 10:36:43 +08001215 connect_timeout=None, alive_interval=None,
1216 alive_count_max=None, connection_attempts=None):
Fang Deng96667ca2013-08-01 17:46:18 -07001217 """Override default make_ssh_command to use options tuned for Chrome OS.
1218
1219 Tuning changes:
1220 - ConnectTimeout=30; maximum of 30 seconds allowed for an SSH
1221 connection failure. Consistency with remote_access.sh.
1222
Samuel Tan2ce155b2015-06-23 18:24:38 -07001223 - ServerAliveInterval=900; which causes SSH to ping connection every
1224 900 seconds. In conjunction with ServerAliveCountMax ensures
1225 that if the connection dies, Autotest will bail out.
Fang Deng96667ca2013-08-01 17:46:18 -07001226 Originally tried 60 secs, but saw frequent job ABORTS where
Samuel Tan2ce155b2015-06-23 18:24:38 -07001227 the test completed successfully. Later increased from 180 seconds to
1228 900 seconds to account for tests where the DUT is suspended for
1229 longer periods of time.
Fang Deng96667ca2013-08-01 17:46:18 -07001230
1231 - ServerAliveCountMax=3; consistency with remote_access.sh.
1232
1233 - ConnectAttempts=4; reduce flakiness in connection errors;
1234 consistency with remote_access.sh.
1235
1236 - UserKnownHostsFile=/dev/null; we don't care about the keys.
1237 Host keys change with every new installation, don't waste
1238 memory/space saving them.
1239
1240 - SSH protocol forced to 2; needed for ServerAliveInterval.
1241
1242 @param user User name to use for the ssh connection.
1243 @param port Port on the target host to use for ssh connection.
1244 @param opts Additional options to the ssh command.
1245 @param hosts_file Ignored.
1246 @param connect_timeout Ignored.
1247 @param alive_interval Ignored.
Dean Liaoe3e75f62017-11-14 10:36:43 +08001248 @param alive_count_max Ignored.
1249 @param connection_attempts Ignored.
Fang Deng96667ca2013-08-01 17:46:18 -07001250 """
Dean Liaoe3e75f62017-11-14 10:36:43 +08001251 options = ' '.join([opts, '-o Protocol=2'])
1252 return super(CrosHost, self).make_ssh_command(
1253 user=user, port=port, opts=options, hosts_file='/dev/null',
1254 connect_timeout=30, alive_interval=900, alive_count_max=3,
1255 connection_attempts=4)
1256
1257
Jason Abeleb6f924f2013-11-13 16:01:54 -08001258 def syslog(self, message, tag='autotest'):
1259 """Logs a message to syslog on host.
1260
1261 @param message String message to log into syslog
1262 @param tag String tag prefix for syslog
1263
1264 """
1265 self.run('logger -t "%s" "%s"' % (tag, message))
1266
1267
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001268 def _ping_check_status(self, status):
1269 """Ping the host once, and return whether it has a given status.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001270
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001271 @param status Check the ping status against this value.
1272 @return True iff `status` and the result of ping are the same
1273 (i.e. both True or both False).
1274
1275 """
1276 ping_val = utils.ping(self.hostname, tries=1, deadline=1)
1277 return not (status ^ (ping_val == 0))
1278
1279 def _ping_wait_for_status(self, status, timeout):
1280 """Wait for the host to have a given status (UP or DOWN).
1281
1282 Status is checked by polling. Polling will not last longer
1283 than the number of seconds in `timeout`. The polling
1284 interval will be long enough that only approximately
1285 _PING_WAIT_COUNT polling cycles will be executed, subject
1286 to a maximum interval of about one minute.
1287
1288 @param status Waiting will stop immediately if `ping` of the
1289 host returns this status.
1290 @param timeout Poll for at most this many seconds.
1291 @return True iff the host status from `ping` matched the
1292 requested status at the time of return.
1293
1294 """
1295 # _ping_check_status() takes about 1 second, hence the
1296 # "- 1" in the formula below.
Nathan Ciobanu38480a32016-10-25 15:26:45 -07001297 # FIXME: if the ping command errors then _ping_check_status()
1298 # returns instantly. If timeout is also smaller than twice
1299 # _PING_WAIT_COUNT then the while loop below forks many
1300 # thousands of ping commands (see /tmp/test_that_results_XXXXX/
1301 # /results-1-logging_YYY.ZZZ/debug/autoserv.DEBUG) and hogs one
1302 # CPU core for 60 seconds.
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001303 poll_interval = min(int(timeout / self._PING_WAIT_COUNT), 60) - 1
1304 end_time = time.time() + timeout
1305 while time.time() <= end_time:
1306 if self._ping_check_status(status):
1307 return True
1308 if poll_interval > 0:
1309 time.sleep(poll_interval)
1310
1311 # The last thing we did was sleep(poll_interval), so it may
1312 # have been too long since the last `ping`. Check one more
1313 # time, just to be sure.
1314 return self._ping_check_status(status)
1315
1316 def ping_wait_up(self, timeout):
1317 """Wait for the host to respond to `ping`.
1318
1319 N.B. This method is not a reliable substitute for
1320 `wait_up()`, because a host that responds to ping will not
1321 necessarily respond to ssh. This method should only be used
1322 if the target DUT can be considered functional even if it
1323 can't be reached via ssh.
1324
1325 @param timeout Minimum time to allow before declaring the
1326 host to be non-responsive.
1327 @return True iff the host answered to ping before the timeout.
1328
1329 """
1330 return self._ping_wait_for_status(self._PING_STATUS_UP, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001331
Andrew Bresticker678c0c72013-01-22 10:44:09 -08001332 def ping_wait_down(self, timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001333 """Wait until the host no longer responds to `ping`.
1334
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001335 This function can be used as a slightly faster version of
1336 `wait_down()`, by avoiding potentially long ssh timeouts.
1337
1338 @param timeout Minimum time to allow for the host to become
1339 non-responsive.
1340 @return True iff the host quit answering ping before the
1341 timeout.
1342
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001343 """
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001344 return self._ping_wait_for_status(self._PING_STATUS_DOWN, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001345
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001346 def test_wait_for_sleep(self, sleep_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001347 """Wait for the client to enter low-power sleep mode.
1348
1349 The test for "is asleep" can't distinguish a system that is
1350 powered off; to confirm that the unit was asleep, it is
1351 necessary to force resume, and then call
1352 `test_wait_for_resume()`.
1353
1354 This function is expected to be called from a test as part
1355 of a sequence like the following:
1356
1357 ~~~~~~~~
1358 boot_id = host.get_boot_id()
1359 # trigger sleep on the host
1360 host.test_wait_for_sleep()
1361 # trigger resume on the host
1362 host.test_wait_for_resume(boot_id)
1363 ~~~~~~~~
1364
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001365 @param sleep_timeout time limit in seconds to allow the host sleep.
1366
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001367 @exception TestFail The host did not go to sleep within
1368 the allowed time.
1369 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001370 if sleep_timeout is None:
1371 sleep_timeout = self.SLEEP_TIMEOUT
1372
1373 if not self.ping_wait_down(timeout=sleep_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001374 raise error.TestFail(
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001375 'client failed to sleep after %d seconds' % sleep_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001376
1377
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001378 def test_wait_for_resume(self, old_boot_id, resume_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001379 """Wait for the client to resume from low-power sleep mode.
1380
1381 The `old_boot_id` parameter should be the value from
1382 `get_boot_id()` obtained prior to entering sleep mode. A
1383 `TestFail` exception is raised if the boot id changes.
1384
1385 See @ref test_wait_for_sleep for more on this function's
1386 usage.
1387
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08001388 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001389 target host went to sleep.
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001390 @param resume_timeout time limit in seconds to allow the host up.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001391
1392 @exception TestFail The host did not respond within the
1393 allowed time.
1394 @exception TestFail The host responded, but the boot id test
1395 indicated a reboot rather than a sleep
1396 cycle.
1397 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001398 if resume_timeout is None:
1399 resume_timeout = self.RESUME_TIMEOUT
1400
1401 if not self.wait_up(timeout=resume_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001402 raise error.TestFail(
1403 'client failed to resume from sleep after %d seconds' %
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001404 resume_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001405 else:
1406 new_boot_id = self.get_boot_id()
1407 if new_boot_id != old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001408 logging.error('client rebooted (old boot %s, new boot %s)',
1409 old_boot_id, new_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001410 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001411 'client rebooted, but sleep was expected')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001412
1413
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001414 def test_wait_for_shutdown(self, shutdown_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001415 """Wait for the client to shut down.
1416
1417 The test for "has shut down" can't distinguish a system that
1418 is merely asleep; to confirm that the unit was down, it is
1419 necessary to force boot, and then call test_wait_for_boot().
1420
1421 This function is expected to be called from a test as part
1422 of a sequence like the following:
1423
1424 ~~~~~~~~
1425 boot_id = host.get_boot_id()
1426 # trigger shutdown on the host
1427 host.test_wait_for_shutdown()
1428 # trigger boot on the host
1429 host.test_wait_for_boot(boot_id)
1430 ~~~~~~~~
1431
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001432 @param shutdown_timeout time limit in seconds to allow the host down.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001433 @exception TestFail The host did not shut down within the
1434 allowed time.
1435 """
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001436 if shutdown_timeout is None:
1437 shutdown_timeout = self.SHUTDOWN_TIMEOUT
1438
1439 if not self.ping_wait_down(timeout=shutdown_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001440 raise error.TestFail(
1441 'client failed to shut down after %d seconds' %
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001442 shutdown_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001443
1444
1445 def test_wait_for_boot(self, old_boot_id=None):
1446 """Wait for the client to boot from cold power.
1447
1448 The `old_boot_id` parameter should be the value from
1449 `get_boot_id()` obtained prior to shutting down. A
1450 `TestFail` exception is raised if the boot id does not
1451 change. The boot id test is omitted if `old_boot_id` is not
1452 specified.
1453
1454 See @ref test_wait_for_shutdown for more on this function's
1455 usage.
1456
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08001457 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001458 shut down.
1459
1460 @exception TestFail The host did not respond within the
1461 allowed time.
1462 @exception TestFail The host responded, but the boot id test
1463 indicated that there was no reboot.
1464 """
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07001465 if not self.wait_up(timeout=self.REBOOT_TIMEOUT):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001466 raise error.TestFail(
1467 'client failed to reboot after %d seconds' %
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07001468 self.REBOOT_TIMEOUT)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001469 elif old_boot_id:
1470 if self.get_boot_id() == old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001471 logging.error('client not rebooted (boot %s)',
1472 old_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001473 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001474 'client is back up, but did not reboot')
Simran Basid5e5e272012-09-24 15:23:59 -07001475
1476
1477 @staticmethod
1478 def check_for_rpm_support(hostname):
1479 """For a given hostname, return whether or not it is powered by an RPM.
1480
Simran Basi1df55112013-09-06 11:25:09 -07001481 @param hostname: hostname to check for rpm support.
1482
Simran Basid5e5e272012-09-24 15:23:59 -07001483 @return None if this host does not follows the defined naming format
1484 for RPM powered DUT's in the lab. If it does follow the format,
1485 it returns a regular expression MatchObject instead.
1486 """
Fang Dengbaff9082015-01-06 13:46:15 -08001487 return re.match(CrosHost._RPM_HOSTNAME_REGEX, hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07001488
1489
1490 def has_power(self):
1491 """For this host, return whether or not it is powered by an RPM.
1492
1493 @return True if this host is in the CROS lab and follows the defined
1494 naming format.
1495 """
Fang Deng0ca40e22013-08-27 17:47:44 -07001496 return CrosHost.check_for_rpm_support(self.hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07001497
1498
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001499 def _set_power(self, state, power_method):
Garry Wang5e5538a2019-04-08 15:36:18 -07001500 """Sets the power to the host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001501
1502 @param state Specifies which power state to set to DUT
1503 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001504 use. By default "RPM" or "CCD" will be used based
1505 on servo type. Valid values from
1506 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001507
1508 """
1509 ACCEPTABLE_STATES = ['ON', 'OFF']
1510
Garry Wang5e5538a2019-04-08 15:36:18 -07001511 if not power_method:
1512 power_method = self.get_default_power_method()
1513
1514 state = state.upper()
1515 if state not in ACCEPTABLE_STATES:
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001516 raise error.TestError('State must be one of: %s.'
1517 % (ACCEPTABLE_STATES,))
1518
1519 if power_method == self.POWER_CONTROL_SERVO:
1520 logging.info('Setting servo port J10 to %s', state)
1521 self.servo.set('prtctl3_pwren', state.lower())
1522 time.sleep(self._USB_POWER_TIMEOUT)
1523 elif power_method == self.POWER_CONTROL_MANUAL:
1524 logging.info('You have %d seconds to set the AC power to %s.',
1525 self._POWER_CYCLE_TIMEOUT, state)
1526 time.sleep(self._POWER_CYCLE_TIMEOUT)
Garry Wang5e5538a2019-04-08 15:36:18 -07001527 elif power_method == self.POWER_CONTROL_CCD:
1528 servo_role = 'src' if state == 'ON' else 'snk'
1529 logging.info('servo ccd power pass through detected,'
1530 ' changing servo_role to %s.', servo_role)
1531 self.servo.set_servo_v4_role(servo_role)
1532 if not self.ping_wait_up(timeout=self._CHANGE_SERVO_ROLE_TIMEOUT):
Garry Wang94bf9de2019-06-10 17:23:37 -07001533 # Make sure we don't leave DUT with no power(servo_role=snk)
1534 # when DUT is not pingable, as we raise a exception here
1535 # that may break a power cycle in the middle.
1536 self.servo.set_servo_v4_role('src')
Garry Wang5e5538a2019-04-08 15:36:18 -07001537 raise error.AutoservError(
1538 'DUT failed to regain network connection after %d seconds.'
1539 % self._CHANGE_SERVO_ROLE_TIMEOUT)
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001540 else:
1541 if not self.has_power():
1542 raise error.TestFail('DUT does not have RPM connected.')
Garry Wangad4d4fd2019-01-30 17:00:38 -08001543 self._add_rpm_changed_tag()
Garry Wang5e5538a2019-04-08 15:36:18 -07001544 rpm_client.set_power(self, state, timeout_mins=5)
Simran Basid5e5e272012-09-24 15:23:59 -07001545
1546
Garry Wang5e5538a2019-04-08 15:36:18 -07001547 def power_off(self, power_method=None):
1548 """Turn off power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001549
1550 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001551 use. By default "RPM" or "CCD" will be used based
1552 on servo type. Valid values from
1553 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001554
1555 """
1556 self._set_power('OFF', power_method)
Simran Basid5e5e272012-09-24 15:23:59 -07001557
1558
Garry Wang5e5538a2019-04-08 15:36:18 -07001559 def power_on(self, power_method=None):
1560 """Turn on power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001561
1562 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001563 use. By default "RPM" or "CCD" will be used based
1564 on servo type. Valid values from
1565 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001566
1567 """
1568 self._set_power('ON', power_method)
1569
1570
Garry Wang5e5538a2019-04-08 15:36:18 -07001571 def power_cycle(self, power_method=None):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001572 """Cycle power to this host by turning it OFF, then ON.
1573
1574 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001575 use. By default "RPM" or "CCD" will be used based
1576 on servo type. Valid values from
1577 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001578
1579 """
Garry Wang5e5538a2019-04-08 15:36:18 -07001580 if not power_method:
1581 power_method = self.get_default_power_method()
1582
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001583 if power_method in (self.POWER_CONTROL_SERVO,
Garry Wang5e5538a2019-04-08 15:36:18 -07001584 self.POWER_CONTROL_MANUAL,
1585 self.POWER_CONTROL_CCD):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001586 self.power_off(power_method=power_method)
1587 time.sleep(self._POWER_CYCLE_TIMEOUT)
1588 self.power_on(power_method=power_method)
1589 else:
Garry Wangad4d4fd2019-01-30 17:00:38 -08001590 self._add_rpm_changed_tag()
1591 rpm_client.set_power(self, 'CYCLE')
Simran Basic6f1f7a2012-10-16 10:47:46 -07001592
1593
Mary Ruthvende14a8b2019-08-23 12:43:52 -07001594 def get_platform_from_fwid(self):
1595 """Determine the platform from the crossystem fwid.
1596
1597 @returns a string representing this host's platform.
1598 """
1599 # Look at the firmware for non-unibuild cases or if mosys fails.
1600 crossystem = utils.Crossystem(self)
1601 crossystem.init()
1602 # Extract fwid value and use the leading part as the platform id.
1603 # fwid generally follow the format of {platform}.{firmware version}
1604 # Example: Alex.X.YYY.Z or Google_Alex.X.YYY.Z
1605 platform = crossystem.fwid().split('.')[0].lower()
1606 # Newer platforms start with 'Google_' while the older ones do not.
1607 return platform.replace('google_', '')
1608
Simran Basic6f1f7a2012-10-16 10:47:46 -07001609 def get_platform(self):
1610 """Determine the correct platform label for this host.
1611
1612 @returns a string representing this host's platform.
1613 """
C Shapiroed87c6f2018-04-19 09:13:58 -06001614 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
1615 run_method=self.run)
1616 unibuild = release_info.get('CHROMEOS_RELEASE_UNIBUILD') == '1'
1617 platform = ''
1618 if unibuild:
1619 cmd = 'mosys platform model'
1620 result = self.run(command=cmd, ignore_status=True)
1621 if result.exit_status == 0:
1622 platform = result.stdout.strip()
Mary Ruthvende14a8b2019-08-23 12:43:52 -07001623 return platform if platform else self.get_platform_from_fwid()
Simran Basic6f1f7a2012-10-16 10:47:46 -07001624
1625
Hung-ying Tyanb1328032014-04-01 14:18:54 +08001626 def get_architecture(self):
1627 """Determine the correct architecture label for this host.
1628
1629 @returns a string representing this host's architecture.
1630 """
1631 crossystem = utils.Crossystem(self)
1632 crossystem.init()
1633 return crossystem.arch()
1634
1635
Luis Lozano40b7d0d2014-01-17 15:12:06 -08001636 def get_chrome_version(self):
1637 """Gets the Chrome version number and milestone as strings.
1638
1639 Invokes "chrome --version" to get the version number and milestone.
1640
1641 @return A tuple (chrome_ver, milestone) where "chrome_ver" is the
1642 current Chrome version number as a string (in the form "W.X.Y.Z")
1643 and "milestone" is the first component of the version number
1644 (the "W" from "W.X.Y.Z"). If the version number cannot be parsed
1645 in the "W.X.Y.Z" format, the "chrome_ver" will be the full output
1646 of "chrome --version" and the milestone will be the empty string.
1647
1648 """
MK Ryu35d661e2014-09-25 17:44:10 -07001649 version_string = self.run(client_constants.CHROME_VERSION_COMMAND).stdout
Luis Lozano40b7d0d2014-01-17 15:12:06 -08001650 return utils.parse_chrome_version(version_string)
1651
J. Richard Barnetted2af5852016-02-05 15:03:10 -08001652
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001653 def get_ec_version(self):
1654 """Get the ec version as strings.
1655
1656 @returns a string representing this host's ec version.
1657 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08001658 command = 'mosys ec info -s fw_version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08001659 result = self.run(command, ignore_status=True)
1660 if result.exit_status != 0:
1661 return ''
1662 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001663
1664
1665 def get_firmware_version(self):
1666 """Get the firmware version as strings.
1667
1668 @returns a string representing this host's firmware version.
1669 """
1670 crossystem = utils.Crossystem(self)
1671 crossystem.init()
1672 return crossystem.fwid()
1673
1674
1675 def get_hardware_revision(self):
1676 """Get the hardware revision as strings.
1677
1678 @returns a string representing this host's hardware revision.
1679 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08001680 command = 'mosys platform version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08001681 result = self.run(command, ignore_status=True)
1682 if result.exit_status != 0:
1683 return ''
1684 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001685
1686
1687 def get_kernel_version(self):
1688 """Get the kernel version as strings.
1689
1690 @returns a string representing this host's kernel version.
1691 """
1692 return self.run('uname -r').stdout.strip()
1693
1694
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08001695 def get_cpu_name(self):
1696 """Get the cpu name as strings.
1697
1698 @returns a string representing this host's cpu name.
1699 """
1700
1701 # Try get cpu name from device tree first
1702 if self.path_exists('/proc/device-tree/compatible'):
1703 command = ' | '.join(
1704 ["sed -e 's/\\x0/\\n/g' /proc/device-tree/compatible",
1705 'tail -1'])
1706 return self.run(command).stdout.strip().replace(',', ' ')
1707
1708 # Get cpu name from uname -p
1709 command = 'uname -p'
1710 ret = self.run(command).stdout.strip()
1711
1712 # 'uname -p' return variant of unknown or amd64 or x86_64 or i686
1713 # Try get cpu name from /proc/cpuinfo instead
1714 if re.match("unknown|amd64|[ix][0-9]?86(_64)?", ret, re.IGNORECASE):
1715 command = "grep model.name /proc/cpuinfo | cut -f 2 -d: | head -1"
1716 self = self.run(command).stdout.strip()
1717
1718 # Remove bloat from CPU name, for example
1719 # Intel(R) Core(TM) i5-7Y57 CPU @ 1.20GHz -> Intel Core i5-7Y57
1720 # Intel(R) Xeon(R) CPU E5-2690 v4 @ 2.60GHz -> Intel Xeon E5-2690 v4
1721 # AMD A10-7850K APU with Radeon(TM) R7 Graphics -> AMD A10-7850K
1722 # AMD GX-212JC SOC with Radeon(TM) R2E Graphics -> AMD GX-212JC
1723 trim_re = r' (@|processor|apu|soc|radeon).*|\(.*?\)| cpu'
1724 return re.sub(trim_re, '', ret, flags=re.IGNORECASE)
1725
1726
1727 def get_screen_resolution(self):
1728 """Get the screen(s) resolution as strings.
1729 In case of more than 1 monitor, return resolution for each monitor
1730 separate with plus sign.
1731
1732 @returns a string representing this host's screen(s) resolution.
1733 """
1734 command = 'for f in /sys/class/drm/*/*/modes; do head -1 $f; done'
1735 ret = self.run(command, ignore_status=True)
1736 # We might have Chromebox without a screen
1737 if ret.exit_status != 0:
1738 return ''
1739 return ret.stdout.strip().replace('\n', '+')
1740
1741
1742 def get_mem_total_gb(self):
1743 """Get total memory available in the system in GiB (2^20).
1744
1745 @returns an integer representing total memory
1746 """
1747 mem_total_kb = self.read_from_meminfo('MemTotal')
1748 kb_in_gb = float(2 ** 20)
1749 return int(round(mem_total_kb / kb_in_gb))
1750
1751
1752 def get_disk_size_gb(self):
1753 """Get size of disk in GB (10^9)
1754
1755 @returns an integer representing size of disk, 0 in Error Case
1756 """
1757 command = 'grep $(rootdev -s -d | cut -f3 -d/)$ /proc/partitions'
1758 result = self.run(command, ignore_status=True)
1759 if result.exit_status != 0:
1760 return 0
1761 _, _, block, _ = re.split(r' +', result.stdout.strip())
1762 byte_per_block = 1024.0
1763 disk_kb_in_gb = 1e9
1764 return int(int(block) * byte_per_block / disk_kb_in_gb + 0.5)
1765
1766
1767 def get_battery_size(self):
1768 """Get size of battery in Watt-hour via sysfs
1769
1770 This method assumes that battery support voltage_min_design and
1771 charge_full_design sysfs.
1772
1773 @returns a float representing Battery size, 0 if error.
1774 """
1775 # sysfs report data in micro scale
1776 battery_scale = 1e6
1777
1778 command = 'cat /sys/class/power_supply/*/voltage_min_design'
1779 result = self.run(command, ignore_status=True)
1780 if result.exit_status != 0:
1781 return 0
1782 voltage = float(result.stdout.strip()) / battery_scale
1783
1784 command = 'cat /sys/class/power_supply/*/charge_full_design'
1785 result = self.run(command, ignore_status=True)
1786 if result.exit_status != 0:
1787 return 0
1788 amphereHour = float(result.stdout.strip()) / battery_scale
1789
1790 return voltage * amphereHour
1791
1792
1793 def get_low_battery_shutdown_percent(self):
1794 """Get the percent-based low-battery shutdown threshold.
1795
1796 @returns a float representing low-battery shutdown percent, 0 if error.
1797 """
1798 ret = 0.0
1799 try:
1800 command = 'check_powerd_config --low_battery_shutdown_percent'
1801 ret = float(self.run(command).stdout)
1802 except error.CmdError:
1803 logging.debug("Can't run %s", command)
1804 except ValueError:
1805 logging.debug("Didn't get number from %s", command)
1806
1807 return ret
1808
1809
Puthikorn Voravootivat09c83d72018-08-10 15:58:32 -07001810 def has_hammer(self):
1811 """Check whether DUT has hammer device or not.
1812
1813 @returns boolean whether device has hammer or not
1814 """
1815 command = 'grep Hammer /sys/bus/usb/devices/*/product'
1816 return self.run(command, ignore_status=True).exit_status == 0
1817
1818
Niranjan Kumar34618872017-05-31 12:57:09 -07001819 def is_chrome_switch_present(self, switch):
David Haddock3ce538e2017-06-22 13:37:05 -07001820 """Returns True if the specified switch was provided to Chrome.
1821
1822 @param switch The chrome switch to search for.
1823 """
Niranjan Kumar34618872017-05-31 12:57:09 -07001824
Niranjan Kumar5f23fe92017-06-22 15:18:55 -07001825 command = 'pgrep -x -f -c "/opt/google/chrome/chrome.*%s.*"' % switch
1826 return self.run(command, ignore_status=True).exit_status == 0
Niranjan Kumar34618872017-05-31 12:57:09 -07001827
1828
1829 def oobe_triggers_update(self):
1830 """Returns True if this host has an OOBE flow during which
1831 it will perform an update check and perhaps an update.
1832 One example of such a flow is Hands-Off Zero-Touch Enrollment.
1833 As more such flows are developed, code handling them needs
1834 to be added here.
1835
1836 @return Boolean indicating whether this host's OOBE triggers an update.
1837 """
1838 return self.is_chrome_switch_present(
1839 '--enterprise-enable-zero-touch-enrollment=hands-off')
1840
1841
Kevin Chenga2619dc2016-03-28 11:42:08 -07001842 # TODO(kevcheng): change this to just return the board without the
1843 # 'board:' prefix and fix up all the callers. Also look into removing the
1844 # need for this method.
Simran Basic6f1f7a2012-10-16 10:47:46 -07001845 def get_board(self):
1846 """Determine the correct board label for this host.
1847
1848 @returns a string representing this host's board.
1849 """
1850 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
1851 run_method=self.run)
J. Richard Barnetted2af5852016-02-05 15:03:10 -08001852 return (ds_constants.BOARD_PREFIX +
1853 release_info['CHROMEOS_RELEASE_BOARD'])
Simran Basic6f1f7a2012-10-16 10:47:46 -07001854
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07001855 def get_channel(self):
1856 """Determine the correct channel label for this host.
Simran Basic6f1f7a2012-10-16 10:47:46 -07001857
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07001858 @returns: a string represeting this host's build channel.
1859 (stable, dev, beta). None on fail.
1860 """
1861 return lsbrelease_utils.get_chromeos_channel(
1862 lsb_release_content=self._get_lsb_release_content())
Kevin Chenga328da62016-03-31 10:49:04 -07001863
Kevin Chenga328da62016-03-31 10:49:04 -07001864 def get_power_supply(self):
1865 """
1866 Determine what type of power supply the host has
1867
1868 @returns a string representing this host's power supply.
1869 'power:battery' when the device has a battery intended for
1870 extended use
1871 'power:AC_primary' when the device has a battery not intended
1872 for extended use (for moving the machine, etc)
1873 'power:AC_only' when the device has no battery at all.
1874 """
1875 psu = self.run(command='mosys psu type', ignore_status=True)
1876 if psu.exit_status:
1877 # The psu command for mosys is not included for all platforms. The
1878 # assumption is that the device will have a battery if the command
1879 # is not found.
1880 return 'power:battery'
1881
1882 psu_str = psu.stdout.strip()
1883 if psu_str == 'unknown':
1884 return None
1885
1886 return 'power:%s' % psu_str
1887
1888
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08001889 def has_battery(self):
1890 """Determine if DUT has a battery.
1891
1892 Returns:
1893 Boolean, False if known not to have battery, True otherwise.
1894 """
1895 rv = True
1896 power_supply = self.get_power_supply()
1897 if power_supply == 'power:battery':
1898 _NO_BATTERY_BOARD_TYPE = ['CHROMEBOX', 'CHROMEBIT', 'CHROMEBASE']
1899 board_type = self.get_board_type()
1900 if board_type in _NO_BATTERY_BOARD_TYPE:
1901 logging.warn('Do NOT believe type %s has battery. '
1902 'See debug for mosys details', board_type)
1903 psu = self.system_output('mosys -vvvv psu type',
1904 ignore_status=True)
1905 logging.debug(psu)
1906 rv = False
1907 elif power_supply == 'power:AC_only':
1908 rv = False
1909
1910 return rv
1911
1912
Kevin Chenga328da62016-03-31 10:49:04 -07001913 def get_servo(self):
1914 """Determine if the host has a servo attached.
1915
1916 If the host has a working servo attached, it should have a servo label.
1917
1918 @return: string 'servo' if the host has servo attached. Otherwise,
1919 returns None.
1920 """
1921 return 'servo' if self._servo_host else None
1922
1923
Kevin Chenga328da62016-03-31 10:49:04 -07001924 def has_internal_display(self):
1925 """Determine if the device under test is equipped with an internal
1926 display.
1927
1928 @return: 'internal_display' if one is present; None otherwise.
1929 """
1930 from autotest_lib.client.cros.graphics import graphics_utils
1931 from autotest_lib.client.common_lib import utils as common_utils
1932
1933 def __system_output(cmd):
1934 return self.run(cmd).stdout
1935
1936 def __read_file(remote_path):
1937 return self.run('cat %s' % remote_path).stdout
1938
1939 # Hijack the necessary client functions so that we can take advantage
1940 # of the client lib here.
1941 # FIXME: find a less hacky way than this
1942 original_system_output = utils.system_output
1943 original_read_file = common_utils.read_file
1944 utils.system_output = __system_output
1945 common_utils.read_file = __read_file
1946 try:
1947 return ('internal_display' if graphics_utils.has_internal_display()
1948 else None)
1949 finally:
1950 utils.system_output = original_system_output
1951 common_utils.read_file = original_read_file
1952
1953
Dan Shi85276d42014-04-08 22:11:45 -07001954 def is_boot_from_usb(self):
1955 """Check if DUT is boot from USB.
1956
1957 @return: True if DUT is boot from usb.
1958 """
1959 device = self.run('rootdev -s -d').stdout.strip()
1960 removable = int(self.run('cat /sys/block/%s/removable' %
1961 os.path.basename(device)).stdout.strip())
1962 return removable == 1
Helen Zhang17dae2b2014-11-11 09:25:52 -08001963
1964
1965 def read_from_meminfo(self, key):
Dan Shi49ca0932014-11-14 11:22:27 -08001966 """Return the memory info from /proc/meminfo
Helen Zhang17dae2b2014-11-11 09:25:52 -08001967
1968 @param key: meminfo requested
1969
1970 @return the memory value as a string
1971
1972 """
Helen Zhang17dae2b2014-11-11 09:25:52 -08001973 meminfo = self.run('grep %s /proc/meminfo' % key).stdout.strip()
1974 logging.debug('%s', meminfo)
1975 return int(re.search(r'\d+', meminfo).group(0))
Rohit Makasana8a4923c2015-08-13 17:04:26 -07001976
1977
Rohit Makasana98e696f2016-06-03 18:48:10 -07001978 def get_cpu_arch(self):
1979 """Returns CPU arch of the device.
1980
1981 @return CPU architecture of the DUT.
1982 """
Allen Li2c32d6b2017-02-03 15:28:10 -08001983 # Add CPUs by following logic in client/bin/utils.py.
Rohit Makasana98e696f2016-06-03 18:48:10 -07001984 if self.run("grep '^flags.*:.* lm .*' /proc/cpuinfo",
1985 ignore_status=True).stdout:
1986 return 'x86_64'
1987 if self.run("grep -Ei 'ARM|CPU implementer' /proc/cpuinfo",
1988 ignore_status=True).stdout:
1989 return 'arm'
1990 return 'i386'
1991
1992
Rohit Makasana8a4923c2015-08-13 17:04:26 -07001993 def get_board_type(self):
1994 """
1995 Get the DUT's device type from /etc/lsb-release.
Danny Chan471a8d12015-08-18 14:57:41 -07001996 DEVICETYPE can be one of CHROMEBOX, CHROMEBASE, CHROMEBOOK or more.
1997
1998 @return value of DEVICETYPE param from lsb-release.
Rohit Makasana8a4923c2015-08-13 17:04:26 -07001999 """
Danny Chan471a8d12015-08-18 14:57:41 -07002000 device_type = self.run('grep DEVICETYPE /etc/lsb-release',
2001 ignore_status=True).stdout
2002 if device_type:
Kalin Stoyanov524310b2015-08-21 16:24:04 -07002003 return device_type.split('=')[-1].strip()
Danny Chan471a8d12015-08-18 14:57:41 -07002004 return ''
Gilad Arnolda76bef02015-09-29 13:55:15 -07002005
2006
Rohit Makasanadf0a3a32017-06-30 13:55:18 -07002007 def get_arc_version(self):
2008 """Return ARC version installed on the DUT.
2009
2010 @returns ARC version as string if the CrOS build has ARC, else None.
2011 """
2012 arc_version = self.run('grep CHROMEOS_ARC_VERSION /etc/lsb-release',
2013 ignore_status=True).stdout
2014 if arc_version:
2015 return arc_version.split('=')[-1].strip()
2016 return None
2017
2018
Gilad Arnolda76bef02015-09-29 13:55:15 -07002019 def get_os_type(self):
2020 return 'cros'
Simran Basia5522a32015-10-06 11:01:24 -07002021
2022
Kevin Chenga2619dc2016-03-28 11:42:08 -07002023 def get_labels(self):
Kevin Chengf8660142016-08-12 10:17:41 -07002024 """Return the detected labels on the host."""
Kevin Chenga2619dc2016-03-28 11:42:08 -07002025 return self.labels.get_labels(self)
Garry Wang5e5538a2019-04-08 15:36:18 -07002026
2027
2028 def get_default_power_method(self):
2029 """
2030 Get the default power method for power_on/off/cycle() methods.
2031 @return POWER_CONTROL_RPM or POWER_CONTROL_CCD
2032 """
2033 if not self._default_power_method:
Garry Wang1a004aa2019-05-16 22:56:51 -07002034 self._default_power_method = self.POWER_CONTROL_RPM
Garry Wang5e5538a2019-04-08 15:36:18 -07002035 info = self.host_info_store.get()
2036 if info.attributes.get('servo_type') == self.CCD_SERVO:
Garry Wang1a004aa2019-05-16 22:56:51 -07002037 if self.servo:
2038 self._default_power_method = self.POWER_CONTROL_CCD
2039 else:
2040 logging.warn('CCD servo detected but failed to apply CCD'
2041 ' servo RPM method due to servo instance'
2042 ' was not initialized, fall back to normal'
2043 ' RPM method.')
Garry Wang5e5538a2019-04-08 15:36:18 -07002044 return self._default_power_method