blob: 44cf8688b5e641e943c7ebfd00d1743a052d0050 [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
Simran Basi5e6339a2013-03-21 11:34:32 -0700147 _RPM_OUTLET_CHANGED = 'outlet_changed'
148
Dan Shi9cb0eec2014-06-03 09:04:50 -0700149 # URL pattern to download firmware image.
Dan Shib8540a52015-07-16 14:18:23 -0700150 _FW_IMAGE_URL_PATTERN = CONFIG.get_config_value(
Dan Shi9cb0eec2014-06-03 09:04:50 -0700151 'CROS', 'firmware_url_pattern', type=str)
beeps687243d2013-07-18 15:29:27 -0700152
Brent Peterson1cb623a2020-01-09 13:14:28 -0800153 # Regular expression for extracting EC version string
154 _EC_REGEX = '(%s_\w*[-\.]\w*[-\.]\w*[-\.]\w*)'
155
156 # Regular expression for extracting BIOS version string
157 _BIOS_REGEX = '(%s\.\w*\.\w*\.\w*)'
158
Brent Petersonc70a1832020-01-24 15:54:35 -0800159 # Command to update firmware located on DUT
Brent Peterson669edf42020-02-07 15:07:54 -0800160 _FW_UPDATE_CMD = 'chromeos-firmwareupdate --mode=recovery -i %s %s'
Brent Petersonc70a1832020-01-24 15:54:35 -0800161
J. Richard Barnette964fba02012-10-24 17:34:29 -0700162 @staticmethod
beeps46dadc92013-11-07 14:07:10 -0800163 def check_host(host, timeout=10):
164 """
165 Check if the given host is a chrome-os host.
166
167 @param host: An ssh host representing a device.
168 @param timeout: The timeout for the run command.
169
170 @return: True if the host device is chromeos.
171
beeps46dadc92013-11-07 14:07:10 -0800172 """
173 try:
Allen Liad719c12017-06-27 23:48:04 +0000174 result = host.run(
Simran Basi933c8af2015-04-29 14:05:07 -0700175 'grep -q CHROMEOS /etc/lsb-release && '
Garry Wange4b6d6e2019-06-17 17:08:46 -0700176 '! grep -q moblab /etc/lsb-release && '
177 '! grep -q labstation /etc/lsb-release',
Simran Basi933c8af2015-04-29 14:05:07 -0700178 ignore_status=True, timeout=timeout)
Laurence Goodby468de252017-06-08 17:22:53 -0700179 if result.exit_status == 0:
Allen Liad719c12017-06-27 23:48:04 +0000180 lsb_release_content = host.run(
Laurence Goodby468de252017-06-08 17:22:53 -0700181 'grep CHROMEOS_RELEASE_BOARD /etc/lsb-release',
182 timeout=timeout).stdout
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -0800183 return not (
184 lsbrelease_utils.is_jetstream(
185 lsb_release_content=lsb_release_content) or
186 lsbrelease_utils.is_gce_board(
187 lsb_release_content=lsb_release_content))
188
beeps46dadc92013-11-07 14:07:10 -0800189 except (error.AutoservRunError, error.AutoservSSHTimeout):
190 return False
Laurence Goodby468de252017-06-08 17:22:53 -0700191
192 return False
beeps46dadc92013-11-07 14:07:10 -0800193
194
195 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800196 def get_chameleon_arguments(args_dict):
197 """Extract chameleon options from `args_dict` and return the result.
198
199 Recommended usage:
200 ~~~~~~~~
201 args_dict = utils.args_to_dict(args)
202 chameleon_args = hosts.CrosHost.get_chameleon_arguments(args_dict)
203 host = hosts.create_host(machine, chameleon_args=chameleon_args)
204 ~~~~~~~~
205
206 @param args_dict Dictionary from which to extract the chameleon
207 arguments.
208 """
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800209 return {key: args_dict[key]
Allen Li083866b2016-08-18 10:07:10 -0700210 for key in ('chameleon_host', 'chameleon_port')
211 if key in args_dict}
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800212
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800213 @staticmethod
214 def get_btpeer_arguments(args_dict):
215 """Extract btpeer options from `args_dict` and return the result.
216
217 This is used to parse details of Bluetooth peer.
218 Recommended usage:
219 ~~~~~~~~
220 args_dict = utils.args_to_dict(args)
221 btpeer_args = hosts.CrosHost.get_btpeer_arguments(args_dict)
222 host = hosts.create_host(machine)
223 host.initialize_btpeer(btpeer_args)
224 ~~~~~~~~
225
226 @param args_dict: Dictionary from which to extract the btpeer
227 arguments.
228 """
229 if 'btpeer_host_list' in args_dict:
230 result = []
231 for btpeer in args_dict['btpeer_host_list'].split(','):
232 result.append({key: value for key,value in
233 zip(('btpeer_host','btpeer_port'),
234 btpeer.split(':'))})
235 return result
236 else:
237 return {key: args_dict[key]
238 for key in ('btpeer_host', 'btpeer_port')
239 if key in args_dict}
240
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800241
242 @staticmethod
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700243 def get_pdtester_arguments(args_dict):
Scottfe06ed82015-11-05 17:15:01 -0800244 """Extract chameleon options from `args_dict` and return the result.
245
246 Recommended usage:
247 ~~~~~~~~
248 args_dict = utils.args_to_dict(args)
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700249 pdtester_args = hosts.CrosHost.get_pdtester_arguments(args_dict)
250 host = hosts.create_host(machine, pdtester_args=pdtester_args)
Scottfe06ed82015-11-05 17:15:01 -0800251 ~~~~~~~~
252
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700253 @param args_dict Dictionary from which to extract the pdtester
Scottfe06ed82015-11-05 17:15:01 -0800254 arguments.
255 """
Allen Li083866b2016-08-18 10:07:10 -0700256 return {key: args_dict[key]
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700257 for key in ('pdtester_host', 'pdtester_port')
Allen Li083866b2016-08-18 10:07:10 -0700258 if key in args_dict}
Scottfe06ed82015-11-05 17:15:01 -0800259
260
261 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800262 def get_servo_arguments(args_dict):
263 """Extract servo options from `args_dict` and return the result.
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800264
265 Recommended usage:
266 ~~~~~~~~
267 args_dict = utils.args_to_dict(args)
Fang Deng0ca40e22013-08-27 17:47:44 -0700268 servo_args = hosts.CrosHost.get_servo_arguments(args_dict)
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800269 host = hosts.create_host(machine, servo_args=servo_args)
270 ~~~~~~~~
271
272 @param args_dict Dictionary from which to extract the servo
273 arguments.
274 """
Richard Barnettee519dcd2016-08-15 17:37:17 -0700275 servo_attrs = (servo_host.SERVO_HOST_ATTR,
276 servo_host.SERVO_PORT_ATTR,
Nick Sanders2f3c9852018-10-24 12:10:24 -0700277 servo_host.SERVO_BOARD_ATTR,
278 servo_host.SERVO_MODEL_ATTR)
Armando Miraglia2ac802e2017-08-15 14:54:47 +0200279 servo_args = {key: args_dict[key]
280 for key in servo_attrs
281 if key in args_dict}
282 return (
283 None
284 if servo_host.SERVO_HOST_ATTR in servo_args
285 and not servo_args[servo_host.SERVO_HOST_ATTR]
286 else servo_args)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -0700287
J. Richard Barnette964fba02012-10-24 17:34:29 -0700288
J. Richard Barnette91137f02016-03-10 16:52:26 -0800289 def _initialize(self, hostname, chameleon_args=None, servo_args=None,
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700290 pdtester_args=None, try_lab_servo=False,
Richard Barnette9a26ad62016-06-10 12:03:08 -0700291 try_servo_repair=False,
J. Richard Barnette91137f02016-03-10 16:52:26 -0800292 ssh_verbosity_flag='', ssh_options='',
Fang Dengd1c2b732013-08-20 12:59:46 -0700293 *args, **dargs):
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800294 """Initialize superclasses, |self.chameleon|, and |self.servo|.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700295
Fang Denge545abb2014-12-30 18:43:47 -0800296 This method will attempt to create the test-assistant object
297 (chameleon/servo) when it is needed by the test. Check
298 the docstring of chameleon_host.create_chameleon_host and
299 servo_host.create_servo_host for how this is determined.
Fang Deng5d518f42013-08-02 14:04:32 -0700300
Fang Denge545abb2014-12-30 18:43:47 -0800301 @param hostname: Hostname of the dut.
302 @param chameleon_args: A dictionary that contains args for creating
303 a ChameleonHost. See chameleon_host for details.
304 @param servo_args: A dictionary that contains args for creating
305 a ServoHost object. See servo_host for details.
Richard Barnette9a26ad62016-06-10 12:03:08 -0700306 @param try_lab_servo: When true, indicates that an attempt should
307 be made to create a ServoHost for a DUT in
308 the test lab, even if not required by
309 `servo_args`. See servo_host for details.
310 @param try_servo_repair: If a servo host is created, check it
311 with `repair()` rather than `verify()`.
Fang Denge545abb2014-12-30 18:43:47 -0800312 See servo_host for details.
313 @param ssh_verbosity_flag: String, to pass to the ssh command to control
314 verbosity.
315 @param ssh_options: String, other ssh options to pass to the ssh
316 command.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700317 """
Fang Deng0ca40e22013-08-27 17:47:44 -0700318 super(CrosHost, self)._initialize(hostname=hostname,
J. Richard Barnette45e93de2012-04-11 17:24:15 -0700319 *args, **dargs)
J. Richard Barnette91137f02016-03-10 16:52:26 -0800320 self._repair_strategy = cros_repair.create_cros_repair_strategy()
Kevin Chenga2619dc2016-03-28 11:42:08 -0700321 self.labels = base_label.LabelRetriever(cros_label.CROS_LABELS)
J. Richard Barnettef0859852012-08-20 14:55:50 -0700322 # self.env is a dictionary of environment variable settings
323 # to be exported for commands run on the host.
324 # LIBC_FATAL_STDERR_ can be useful for diagnosing certain
325 # errors that might happen.
326 self.env['LIBC_FATAL_STDERR_'] = '1'
Fang Dengd1c2b732013-08-20 12:59:46 -0700327 self._ssh_verbosity_flag = ssh_verbosity_flag
Aviv Keshetc5947fa2013-09-04 14:06:29 -0700328 self._ssh_options = ssh_options
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700329 _servo_host, servo_state = servo_host.create_servo_host(
330 dut=self,
331 servo_args=servo_args,
332 try_lab_servo=try_lab_servo,
333 try_servo_repair=try_servo_repair,
334 dut_host_info=self.host_info_store.get())
335 self.set_servo_host(_servo_host, servo_state)
Garry Wang5e5538a2019-04-08 15:36:18 -0700336 self._default_power_method = None
Richard Barnettee519dcd2016-08-15 17:37:17 -0700337
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800338 # TODO(waihong): Do the simplication on Chameleon too.
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800339 self._chameleon_host = chameleon_host.create_chameleon_host(
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700340 dut=self.hostname,
341 chameleon_args=chameleon_args)
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800342 if self._chameleon_host:
343 self.chameleon = self._chameleon_host.create_chameleon_board()
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800344 else:
Tom Wai-Hong Tam3d6790d2014-04-14 16:15:47 +0800345 self.chameleon = None
Fang Deng5d518f42013-08-02 14:04:32 -0700346
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800347 # Bluetooth peers. These will be initialized by test if required.
348 self._btpeer_host_list = []
349 self.btpeer_list = []
350 self.btpeer = None
351
howardchung83e55272019-08-08 14:08:05 +0800352 # Add pdtester host if pdtester args were added on command line
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -0700353 self._pdtester_host = pdtester_host.create_pdtester_host(
Wai-Hong Tam90b164d2019-10-25 13:15:39 -0700354 pdtester_args, self._servo_host)
howardchung83e55272019-08-08 14:08:05 +0800355
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700356 if self._pdtester_host:
357 self.pdtester_servo = self._pdtester_host.get_servo()
358 logging.info('pdtester_servo: %r', self.pdtester_servo)
359 # Create the pdtester object used to access the ec uart
360 self.pdtester = pdtester.PDTester(self.pdtester_servo,
361 self._pdtester_host.get_servod_server_proxy())
Scottfe06ed82015-11-05 17:15:01 -0800362 else:
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700363 self.pdtester = None
Scottfe06ed82015-11-05 17:15:01 -0800364
Fang Deng5d518f42013-08-02 14:04:32 -0700365
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800366 def initialize_btpeer(self, btpeer_args):
367 """ Initialize the Bluetooth peers
368
369 Initialize Bluetooth peer devices given in the arguments. Bluetooth peer
370 is chameleon host on Raspberry Pi.
371 @param btpeer_args: A dictionary that contains args for creating
372 a ChameleonHost. See chameleon_host for details.
373
374 """
375
376 if type(btpeer_args) is list:
377 btpeer_args_list = btpeer_args
378 else:
379 btpeer_args_list = [btpeer_args]
380
381 self._btpeer_host_list = chameleon_host.create_btpeer_host(
382 dut=self.hostname, btpeer_args_list=btpeer_args_list)
383 logging.debug('Bluetooth peer hosts are %s', self._btpeer_host_list)
384 self.btpeer_list = [_host.create_chameleon_board() for _host in
385 self._btpeer_host_list if _host is not None]
386
387 if len(self.btpeer_list) > 0:
388 self.btpeer = self.btpeer_list[0]
389 else:
390 self.btpeer = None
391
392 logging.debug('After initialize_btpeer btpeer_list %s btpeer_host_list'
393 'is %s and btpeer is %s',self.btpeer_list,
394 self._btpeer_host_list, self.btpeer)
395
396
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000397 def get_cros_repair_image_name(self):
Ruben Rodriguez Buchilloncee72f72019-05-01 13:20:58 -0700398 """Get latest stable cros image name from AFE.
399
400 Use the board name from the info store. Should that fail, try to
401 retrieve the board name from the host's installed image itself.
402
403 @returns: current stable cros image name for this host.
404 """
405 board = self.host_info_store.get().board
406 if not board:
407 logging.warn('No board label value found. Trying to infer '
408 'from the host itself.')
409 try:
410 board = self.get_board().split(':')[1]
411 except (error.AutoservRunError, error.AutoservSSHTimeout) as e:
412 logging.error('Also failed to get the board name from the DUT '
413 'itself. %s.', str(e))
414 raise error.AutoservError('Cannot obtain repair image name.')
Gregory Nisbet7fe11c22019-11-22 11:06:06 -0800415 return afe_utils.get_stable_cros_image_name_v2(self.host_info_store.get())
Scott Zawalski89c44dd2013-02-26 09:28:02 -0500416
417
Rohit Makasanadf0a3a32017-06-30 13:55:18 -0700418 def host_version_prefix(self, image):
419 """Return version label prefix.
420
421 In case the CrOS provisioning version is something other than the
422 standard CrOS version e.g. CrOS TH version, this function will
423 find the prefix from provision.py.
424
425 @param image: The image name to find its version prefix.
426 @returns: A prefix string for the image type.
427 """
428 return provision.get_version_label_prefix(image)
429
430
beepsdae65fd2013-07-26 16:24:41 -0700431 def verify_job_repo_url(self, tag=''):
beepscb6f1e22013-06-28 19:14:10 -0700432 """
433 Make sure job_repo_url of this host is valid.
434
joychen03eaad92013-06-26 09:55:21 -0700435 Eg: The job_repo_url "http://lmn.cd.ab.xyx:8080/static/\
beepscb6f1e22013-06-28 19:14:10 -0700436 lumpy-release/R29-4279.0.0/autotest/packages" claims to have the
437 autotest package for lumpy-release/R29-4279.0.0. If this isn't the case,
438 download and extract it. If the devserver embedded in the url is
439 unresponsive, update the job_repo_url of the host after staging it on
440 another devserver.
441
442 @param job_repo_url: A url pointing to the devserver where the autotest
443 package for this build should be staged.
beepsdae65fd2013-07-26 16:24:41 -0700444 @param tag: The tag from the server job, in the format
445 <job_id>-<user>/<hostname>, or <hostless> for a server job.
beepscb6f1e22013-06-28 19:14:10 -0700446
447 @raises DevServerException: If we could not resolve a devserver.
448 @raises AutoservError: If we're unable to save the new job_repo_url as
449 a result of choosing a new devserver because the old one failed to
450 respond to a health check.
beeps0c865032013-07-30 11:37:06 -0700451 @raises urllib2.URLError: If the devserver embedded in job_repo_url
452 doesn't respond within the timeout.
beepscb6f1e22013-06-28 19:14:10 -0700453 """
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800454 info = self.host_info_store.get()
455 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
beepscb6f1e22013-06-28 19:14:10 -0700456 if not job_repo_url:
457 logging.warning('No job repo url set on host %s', self.hostname)
458 return
459
460 logging.info('Verifying job repo url %s', job_repo_url)
461 devserver_url, image_name = tools.get_devserver_build_from_package_url(
462 job_repo_url)
463
beeps0c865032013-07-30 11:37:06 -0700464 ds = dev_server.ImageServer(devserver_url)
beepscb6f1e22013-06-28 19:14:10 -0700465
466 logging.info('Staging autotest artifacts for %s on devserver %s',
467 image_name, ds.url())
beeps687243d2013-07-18 15:29:27 -0700468
469 start_time = time.time()
Simran Basi25e7a922014-10-31 11:56:10 -0700470 ds.stage_artifacts(image_name, ['autotest_packages'])
beeps687243d2013-07-18 15:29:27 -0700471 stage_time = time.time() - start_time
472
473 # Record how much of the verification time comes from a devserver
474 # restage. If we're doing things right we should not see multiple
475 # devservers for a given board/build/branch path.
476 try:
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800477 board, build_type, branch = server_utils.ParseBuildName(
beeps687243d2013-07-18 15:29:27 -0700478 image_name)[:3]
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800479 except server_utils.ParseBuildNameException:
beeps687243d2013-07-18 15:29:27 -0700480 pass
481 else:
beeps0c865032013-07-30 11:37:06 -0700482 devserver = devserver_url[
Chris Sosa65425082013-10-16 13:26:22 -0700483 devserver_url.find('/') + 2:devserver_url.rfind(':')]
beeps687243d2013-07-18 15:29:27 -0700484 stats_key = {
485 'board': board,
486 'build_type': build_type,
487 'branch': branch,
beeps0c865032013-07-30 11:37:06 -0700488 'devserver': devserver.replace('.', '_'),
beeps687243d2013-07-18 15:29:27 -0700489 }
Dan Shi5e2efb72017-02-07 11:40:23 -0800490
491 monarch_fields = {
492 'board': board,
493 'build_type': build_type,
Dan Shi5e2efb72017-02-07 11:40:23 -0800494 'branch': branch,
495 'dev_server': devserver,
496 }
497 metrics.Counter(
498 'chromeos/autotest/provision/verify_url'
499 ).increment(fields=monarch_fields)
500 metrics.SecondsDistribution(
501 'chromeos/autotest/provision/verify_url_duration'
502 ).add(stage_time, fields=monarch_fields)
503
504
Dan Shicf4d2032015-03-12 15:04:21 -0700505 def stage_server_side_package(self, image=None):
506 """Stage autotest server-side package on devserver.
507
508 @param image: Full path of an OS image to install or a build name.
509
510 @return: A url to the autotest server-side package.
Dan Shi14de7622016-08-22 11:09:06 -0700511
512 @raise: error.AutoservError if fail to locate the build to test with, or
513 fail to stage server-side package.
Dan Shicf4d2032015-03-12 15:04:21 -0700514 """
Dan Shid37736b2016-07-06 15:10:29 -0700515 # If enable_drone_in_restricted_subnet is False, do not set hostname
516 # in devserver.resolve call, so a devserver in non-restricted subnet
517 # is picked to stage autotest server package for drone to download.
518 hostname = self.hostname
519 if not server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
520 hostname = None
Dan Shicf4d2032015-03-12 15:04:21 -0700521 if image:
522 image_name = tools.get_build_from_image(image)
523 if not image_name:
524 raise error.AutoservError(
525 'Failed to parse build name from %s' % image)
Dan Shid37736b2016-07-06 15:10:29 -0700526 ds = dev_server.ImageServer.resolve(image_name, hostname)
Dan Shicf4d2032015-03-12 15:04:21 -0700527 else:
Prathmesh Prabhu9235e4c2017-03-28 13:16:06 -0700528 info = self.host_info_store.get()
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800529 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
Dan Shicf4d2032015-03-12 15:04:21 -0700530 if job_repo_url:
531 devserver_url, image_name = (
532 tools.get_devserver_build_from_package_url(job_repo_url))
Dan Shid37736b2016-07-06 15:10:29 -0700533 # If enable_drone_in_restricted_subnet is True, use the
534 # existing devserver. Otherwise, resolve a new one in
535 # non-restricted subnet.
536 if server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
537 ds = dev_server.ImageServer(devserver_url)
538 else:
539 ds = dev_server.ImageServer.resolve(image_name)
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800540 elif info.build is not None:
541 ds = dev_server.ImageServer.resolve(info.build, hostname)
Prathmesh Prabhu0c1dd4d2017-06-07 13:01:53 -0700542 image_name = info.build
Dan Shicf4d2032015-03-12 15:04:21 -0700543 else:
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800544 raise error.AutoservError(
545 'Failed to stage server-side package. The host has '
Garry Wang12b9baf2019-06-24 18:58:54 -0700546 'no job_repo_url attribute or cros-version label.')
Dan Shica503482015-03-30 17:23:25 -0700547
548 # Get the OS version of the build, for any build older than
549 # MIN_VERSION_SUPPORT_SSP, server side packaging is not supported.
550 match = re.match('.*/R\d+-(\d+)\.', image_name)
551 if match and int(match.group(1)) < self.MIN_VERSION_SUPPORT_SSP:
Dan Shi14de7622016-08-22 11:09:06 -0700552 raise error.AutoservError(
553 'Build %s is older than %s. Server side packaging is '
554 'disabled.' % (image_name, self.MIN_VERSION_SUPPORT_SSP))
Dan Shica503482015-03-30 17:23:25 -0700555
Dan Shicf4d2032015-03-12 15:04:21 -0700556 ds.stage_artifacts(image_name, ['autotest_server_package'])
557 return '%s/static/%s/%s' % (ds.url(), image_name,
558 'autotest_server_package.tar.bz2')
559
560
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700561 def stage_image_for_servo(self, image_name=None, artifact='test_image'):
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700562 """Stage a build on a devserver and return the update_url.
563
564 @param image_name: a name like lumpy-release/R27-3837.0.0
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700565 @param artifact: a string like 'test_image'. Requests
566 appropriate image to be staged.
Xixuan Wufee57542019-10-15 11:50:27 -0700567 @returns a tuple of (image_name, URL) like
568 (lumpy-release/R27-3837.0.0,
569 http://172.22.50.205:8082/update/lumpy-release/R27-3837.0.0)
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700570 """
571 if not image_name:
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000572 image_name = self.get_cros_repair_image_name()
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700573 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800574 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700575 devserver.stage_artifacts(image_name, [artifact])
576 if artifact == 'test_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700577 return image_name, devserver.get_test_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700578 elif artifact == 'recovery_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700579 return image_name, devserver.get_recovery_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700580 else:
581 raise error.AutoservError("Bad artifact!")
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700582
583
beepse539be02013-07-31 21:57:39 -0700584 def stage_factory_image_for_servo(self, image_name):
585 """Stage a build on a devserver and return the update_url.
586
587 @param image_name: a name like <baord>/4262.204.0
beeps12c0a3c2013-09-03 11:58:27 -0700588
beepse539be02013-07-31 21:57:39 -0700589 @return: An update URL, eg:
590 http://<devserver>/static/canary-channel/\
591 <board>/4262.204.0/factory_test/chromiumos_factory_image.bin
beeps12c0a3c2013-09-03 11:58:27 -0700592
593 @raises: ValueError if the factory artifact name is missing from
594 the config.
595
beepse539be02013-07-31 21:57:39 -0700596 """
597 if not image_name:
598 logging.error('Need an image_name to stage a factory image.')
599 return
600
Dan Shib8540a52015-07-16 14:18:23 -0700601 factory_artifact = CONFIG.get_config_value(
beeps12c0a3c2013-09-03 11:58:27 -0700602 'CROS', 'factory_artifact', type=str, default='')
603 if not factory_artifact:
604 raise ValueError('Cannot retrieve the factory artifact name from '
605 'autotest config, and hence cannot stage factory '
606 'artifacts.')
607
beepse539be02013-07-31 21:57:39 -0700608 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800609 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
beepse539be02013-07-31 21:57:39 -0700610 devserver.stage_artifacts(
611 image_name,
beeps12c0a3c2013-09-03 11:58:27 -0700612 [factory_artifact],
613 archive_url=None)
beepse539be02013-07-31 21:57:39 -0700614
615 return tools.factory_image_url_pattern() % (devserver.url(), image_name)
616
617
Laurence Goodby778c9a42017-05-24 19:24:07 -0700618 def prepare_for_update(self):
619 """Prepares the DUT for an update.
620
621 Subclasses may override this to perform any special actions
622 required before updating.
623 """
Laurence Goodby468de252017-06-08 17:22:53 -0700624 pass
Laurence Goodby778c9a42017-05-24 19:24:07 -0700625
626
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800627 def _clear_fw_version_labels(self, rw_only):
628 """Clear firmware version labels from the machine.
629
630 @param rw_only: True to only clear fwrw_version; otherewise, clear
631 both fwro_version and fwrw_version.
632 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700633 info = self.host_info_store.get()
634 info.clear_version_labels(provision.FW_RW_VERSION_PREFIX)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800635 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700636 info.clear_version_labels(provision.FW_RO_VERSION_PREFIX)
637 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700638
639
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800640 def _add_fw_version_label(self, build, rw_only):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700641 """Add firmware version label to the machine.
642
643 @param build: Build of firmware.
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800644 @param rw_only: True to only add fwrw_version; otherwise, add both
645 fwro_version and fwrw_version.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700646
647 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700648 info = self.host_info_store.get()
649 info.set_version_label(provision.FW_RW_VERSION_PREFIX, build)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800650 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700651 info.set_version_label(provision.FW_RO_VERSION_PREFIX, build)
652 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700653
654
Namyoon Woo5f894662019-11-15 15:23:23 -0800655 def get_latest_release_version(self, board):
656 """Search for the latest package release version from the image archive,
657 and return it.
658
659 @param board: board name
660
661 @return 'firmware-{board}-{branch}-firmwarebranch/{release-version}'
662 or None if LATEST release file does not exist.
663 """
664
665 # This might be in the format of 'baseboard_model',
666 # e.g. octopus_fleex. In that case, board should be just
667 # 'baseboard' to use in search for image package, e.g. octopus.
668 board = board.split('_')[0]
669
670 # Read 'LATEST-1.0.0' file
671 branch_dir = provision.FW_BRANCH_GLOB % board
672 latest_file = os.path.join(provision.CROS_IMAGE_ARCHIVE, branch_dir,
673 'LATEST-1.0.0')
Namyoon Woo5f894662019-11-15 15:23:23 -0800674
Namyoon Woo406c7d42020-01-24 15:57:11 -0800675 try:
676 # The result could be one or more.
677 result = utils.system_output('gsutil ls -d ' + latest_file)
678
679 candidates = re.findall('gs://.*', result)
Namyoon Woo5f894662019-11-15 15:23:23 -0800680 except error.CmdError:
681 logging.error('No LATEST release info is available.')
682 return None
683
Namyoon Woo406c7d42020-01-24 15:57:11 -0800684 for cand_dir in candidates:
685 result = utils.system_output('gsutil cat ' + cand_dir)
Namyoon Woo5f894662019-11-15 15:23:23 -0800686
Namyoon Woo406c7d42020-01-24 15:57:11 -0800687 release_path = cand_dir.replace('LATEST-1.0.0', result)
688 release_path = os.path.join(release_path, board)
689 try:
690 # Check if release_path does exist.
691 release = utils.system_output('gsutil ls -d ' + release_path)
692 # Now 'release' has a full directory path: e.g.
693 # gs://chromeos-image-archive/firmware-octopus-11297.B-
694 # firmwarebranch/RNone-1.0.0-b4395530/octopus/
695
696 # Remove "gs://chromeos-image-archive".
697 release = release.replace(provision.CROS_IMAGE_ARCHIVE, '')
698
699 # Remove CROS_IMAGE_ARCHIVE and any surrounding '/'s.
700 return release.strip('/')
701 except error.CmdError:
702 # The directory might not exist. Let's try next candidate.
703 pass
704 else:
705 raise error.AutoservError('Cannot find the latest firmware')
Namyoon Woo5f894662019-11-15 15:23:23 -0800706
Brent Peterson1cb623a2020-01-09 13:14:28 -0800707 @staticmethod
708 def get_version_from_image(image, version_regex):
Brent Peterson8039b472020-02-14 10:51:23 -0800709 """Get version string from binary image using regular expression.
710
711 @param image: Binary image to search
712 @param version_regex: Regular expression to search for
713
714 @return Version string
715
716 @raises TestFail if no version string is found in image
717 """
Brent Peterson1cb623a2020-01-09 13:14:28 -0800718 with open(image, 'rb') as f:
719 image_data = f.read()
720 match = re.findall(version_regex, image_data)
721 if match:
722 return match[0]
723 else:
724 raise error.TestFail('Failed to read version from %s.' % image)
725
726
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800727 def firmware_install(self, build=None, rw_only=False, dest=None,
Brent Petersonc70a1832020-01-24 15:54:35 -0800728 local_tarball=None, verify_version=False,
729 try_scp=False):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700730 """Install firmware to the DUT.
731
732 Use stateful update if the DUT is already running the same build.
733 Stateful update does not update kernel and tends to run much faster
734 than a full reimage. If the DUT is running a different build, or it
735 failed to do a stateful update, full update, including kernel update,
736 will be applied to the DUT.
737
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800738 Once a host enters firmware_install its fw[ro|rw]_version label will
739 be removed. After the firmware is updated successfully, a new
740 fw[ro|rw]_version label will be added to the host.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700741
742 @param build: The build version to which we want to provision the
743 firmware of the machine,
744 e.g. 'link-firmware/R22-2695.1.144'.
Tom Wai-Hong Tam4ac78982016-01-08 02:34:37 +0800745 @param rw_only: True to only install firmware to its RW portions. Keep
746 the RO portions unchanged.
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700747 @param dest: Directory to store the firmware in.
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800748 @param local_tarball: Path to local firmware image for installing
749 without devserver.
Brent Peterson1cb623a2020-01-09 13:14:28 -0800750 @param verify_version: True to verify EC and BIOS versions after
751 programming firmware, default is False.
Brent Petersonc70a1832020-01-24 15:54:35 -0800752 @param try_scp: False to always program using servo, true to try copying
753 the firmware and programming from the DUT.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700754
755 TODO(dshi): After bug 381718 is fixed, update here with corresponding
756 exceptions that could be raised.
757
758 """
759 if not self.servo:
760 raise error.TestError('Host %s does not have servo.' %
761 self.hostname)
762
Wai-Hong Tam3fa455a2018-07-18 14:40:43 -0700763 # Get the DUT board name from AFE.
764 info = self.host_info_store.get()
765 board = info.board
Shelley Chenac61d5a2019-06-24 15:35:46 -0700766 model = info.model
Namyoon Woo8dbfcf92019-01-15 18:37:12 -0800767
768 if board is None or board == '':
769 board = self.servo.get_board()
Dan Shi9cb0eec2014-06-03 09:04:50 -0700770
Mary Ruthvende14a8b2019-08-23 12:43:52 -0700771 if model is None or model == '':
772 model = self.get_platform_from_fwid()
773
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800774 # If local firmware path not provided fetch it from the dev server
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700775 tmpd = None
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800776 if not local_tarball:
777 # If build is not set, try to install firmware from stable CrOS.
778 if not build:
779 build = afe_utils.get_stable_faft_version_v2(info)
780 if not build:
781 raise error.TestError(
782 'Failed to find stable firmware build for %s.',
783 self.hostname)
784 logging.info('Will install firmware from build %s.', build)
785
786 ds = dev_server.ImageServer.resolve(build, self.hostname)
787 ds.stage_artifacts(build, ['firmware'])
788
789 if not dest:
790 tmpd = autotemp.tempdir(unique_id='fwimage')
791 dest = tmpd.name
792
793 # Download firmware image
Dan Shi9cb0eec2014-06-03 09:04:50 -0700794 fwurl = self._FW_IMAGE_URL_PATTERN % (ds.url(), build)
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700795 local_tarball = os.path.join(dest, os.path.basename(fwurl))
xixuan4e116822016-11-17 15:32:10 -0800796 ds.download_file(fwurl, local_tarball)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700797
Brent Peterson1cb623a2020-01-09 13:14:28 -0800798 # Extract EC image from tarball
799 logging.info('Extracting EC image.')
800 ec_image = self.servo.extract_ec_image(board, model, local_tarball)
801
802 # Extract BIOS image from tarball
803 logging.info('Extracting BIOS image.')
804 bios_image = self.servo.extract_bios_image(board, model, local_tarball)
805
Brent Petersonc70a1832020-01-24 15:54:35 -0800806 # Clear firmware version labels
807 self._clear_fw_version_labels(rw_only)
808
809 # Install firmware from local tarball
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800810 try:
Brent Petersonc70a1832020-01-24 15:54:35 -0800811 # Check if DUT is available and copying to DUT is enabled
812 if self.is_up() and try_scp:
813 # DUT is available, make temp firmware directory to store images
814 logging.info('Making temp folder.')
815 dest_folder = '/tmp/firmware'
816 self.run('mkdir -p ' + dest_folder)
817
Brent Petersonc70a1832020-01-24 15:54:35 -0800818 # Send BIOS firmware image to DUT
819 logging.info('Sending BIOS firmware.')
820 dest_bios_path = os.path.join(dest_folder,
821 os.path.basename(bios_image))
822 self.send_file(bios_image, dest_bios_path)
823
Brent Peterson669edf42020-02-07 15:07:54 -0800824 # Initialize firmware update command for BIOS image
825 fw_cmd = self._FW_UPDATE_CMD % (dest_bios_path,
Brent Petersonc70a1832020-01-24 15:54:35 -0800826 '--wp=1' if rw_only else '')
Brent Peterson669edf42020-02-07 15:07:54 -0800827
828 # Send EC firmware image to DUT when EC image was found
829 if ec_image:
830 logging.info('Sending EC firmware.')
831 dest_ec_path = os.path.join(dest_folder,
832 os.path.basename(ec_image))
833 self.send_file(ec_image, dest_ec_path)
834
835 # Add EC image to firmware update command
836 fw_cmd += ' -e %s' % dest_ec_path
837
838 # Update firmware on DUT
839 logging.info('Updating firmware.')
Brent Petersonc70a1832020-01-24 15:54:35 -0800840 self.run(fw_cmd)
841 else:
842 # Host is not available, program firmware using servo
Brent Peterson669edf42020-02-07 15:07:54 -0800843 if ec_image:
844 self.servo.program_ec(ec_image, rw_only)
Brent Petersonc70a1832020-01-24 15:54:35 -0800845 self.servo.program_bios(bios_image, rw_only)
846 if utils.host_is_in_lab_zone(self.hostname):
847 self._add_fw_version_label(build, rw_only)
Brent Peterson1cb623a2020-01-09 13:14:28 -0800848
849 # Reboot and wait for DUT after installing firmware
850 logging.info('Rebooting DUT.')
851 self.servo.get_power_state_controller().reset()
852 time.sleep(self.servo.BOOT_DELAY)
853 self.test_wait_for_boot()
854
855 # When enabled verify EC and BIOS firmware version after programming
856 if verify_version:
Brent Peterson669edf42020-02-07 15:07:54 -0800857 # Check programmed EC firmware when EC image was found
858 if ec_image:
859 logging.info('Checking EC firmware version.')
860 dest_ec_version = self.get_ec_version()
Brent Peterson8039b472020-02-14 10:51:23 -0800861 ec_version_prefix = dest_ec_version.split('_', 1)[0]
862 ec_regex = self._EC_REGEX % ec_version_prefix
Brent Peterson669edf42020-02-07 15:07:54 -0800863 image_ec_version = self.get_version_from_image(ec_image,
Brent Peterson8039b472020-02-14 10:51:23 -0800864 ec_regex)
Brent Peterson669edf42020-02-07 15:07:54 -0800865 if dest_ec_version != image_ec_version:
866 raise error.TestFail(
867 'Failed to update EC RO, version %s (expected %s)' %
868 (dest_ec_version, image_ec_version))
Brent Peterson1cb623a2020-01-09 13:14:28 -0800869
870 # Check programmed BIOS firmware against expected version
871 logging.info('Checking BIOS firmware version.')
872 dest_bios_version = self.get_firmware_version()
873 bios_version_prefix = dest_bios_version.split('.', 1)[0]
874 bios_regex = self._BIOS_REGEX % bios_version_prefix
875 image_bios_version = self.get_version_from_image(bios_image,
876 bios_regex)
877 if dest_bios_version != image_bios_version:
878 raise error.TestFail(
879 'Failed to update BIOS RO, version %s (expected %s)' %
880 (dest_bios_version, image_bios_version))
Dan Shi9cb0eec2014-06-03 09:04:50 -0700881 finally:
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700882 if tmpd:
883 tmpd.clean()
Dan Shi9cb0eec2014-06-03 09:04:50 -0700884
885
beepsf079cfb2013-09-18 17:49:51 -0700886 def servo_install(self, image_url=None, usb_boot_timeout=USB_BOOT_TIMEOUT,
887 install_timeout=INSTALL_TIMEOUT):
Scott Zawalski62bacae2013-03-05 10:40:32 -0500888 """
889 Re-install the OS on the DUT by:
890 1) installing a test image on a USB storage device attached to the Servo
891 board,
Richard Barnette03a0c132012-11-05 12:40:35 -0800892 2) booting that image in recovery mode, and then
J. Richard Barnette31b2e312013-04-04 16:05:22 -0700893 3) installing the image with chromeos-install.
894
Scott Zawalski62bacae2013-03-05 10:40:32 -0500895 @param image_url: If specified use as the url to install on the DUT.
896 otherwise boot the currently staged image on the USB stick.
beepsf079cfb2013-09-18 17:49:51 -0700897 @param usb_boot_timeout: The usb_boot_timeout to use during reimage.
898 Factory images need a longer usb_boot_timeout than regular
899 cros images.
900 @param install_timeout: The timeout to use when installing the chromeos
901 image. Factory images need a longer install_timeout.
Richard Barnette03a0c132012-11-05 12:40:35 -0800902
Scott Zawalski62bacae2013-03-05 10:40:32 -0500903 @raises AutoservError if the image fails to boot.
beepsf079cfb2013-09-18 17:49:51 -0700904
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800905 """
beepsf079cfb2013-09-18 17:49:51 -0700906 logging.info('Downloading image to USB, then booting from it. Usb boot '
907 'timeout = %s', usb_boot_timeout)
Allen Li48a13fe2016-11-22 14:10:40 -0800908 with metrics.SecondsTimer(
909 'chromeos/autotest/provision/servo_install/boot_duration'):
910 self.servo.install_recovery_image(image_url)
911 if not self.wait_up(timeout=usb_boot_timeout):
912 raise hosts.AutoservRepairError(
913 'DUT failed to boot from USB after %d seconds' %
Garry Wang954f8382019-01-23 13:49:29 -0800914 usb_boot_timeout, 'failed_to_reboot')
Scott Zawalski62bacae2013-03-05 10:40:32 -0500915
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +0800916 # The new chromeos-tpm-recovery has been merged since R44-7073.0.0.
917 # In old CrOS images, this command fails. Skip the error.
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +0800918 logging.info('Resetting the TPM status')
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +0800919 try:
920 self.run('chromeos-tpm-recovery')
921 except error.AutoservRunError:
922 logging.warn('chromeos-tpm-recovery is too old.')
923
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +0800924
Allen Li48a13fe2016-11-22 14:10:40 -0800925 with metrics.SecondsTimer(
926 'chromeos/autotest/provision/servo_install/install_duration'):
927 logging.info('Installing image through chromeos-install.')
Garry Wang83fb5b32019-09-27 13:16:00 -0700928 self.run('chromeos-install --yes',timeout=install_timeout)
Anh Lee21e4032019-07-11 15:01:06 -0700929
Allen Li48a13fe2016-11-22 14:10:40 -0800930 self.halt()
beepsf079cfb2013-09-18 17:49:51 -0700931
932 logging.info('Power cycling DUT through servo.')
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800933 self.servo.get_power_state_controller().power_off()
Fang Dengafb88142013-05-30 17:44:31 -0700934 self.servo.switch_usbkey('off')
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800935 # N.B. The Servo API requires that we use power_on() here
936 # for two reasons:
937 # 1) After turning on a DUT in recovery mode, you must turn
938 # it off and then on with power_on() once more to
939 # disable recovery mode (this is a Parrot specific
940 # requirement).
941 # 2) After power_off(), the only way to turn on is with
942 # power_on() (this is a Storm specific requirement).
J. Richard Barnettefbcc7122013-07-24 18:24:59 -0700943 self.servo.get_power_state_controller().power_on()
beepsf079cfb2013-09-18 17:49:51 -0700944
945 logging.info('Waiting for DUT to come back up.')
Richard Barnette03a0c132012-11-05 12:40:35 -0800946 if not self.wait_up(timeout=self.BOOT_TIMEOUT):
947 raise error.AutoservError('DUT failed to reboot installed '
948 'test image after %d seconds' %
Scott Zawalski62bacae2013-03-05 10:40:32 -0500949 self.BOOT_TIMEOUT)
950
951
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700952 def set_servo_host(self, host, servo_state = None):
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700953 """Set our servo host member, and associated servo.
954
955 @param host Our new `ServoHost`.
956 """
957 self._servo_host = host
958 if self._servo_host is not None:
959 self.servo = self._servo_host.get_servo()
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700960 servo_state = self._servo_host.get_servo_state()
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700961 else:
962 self.servo = None
963
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700964 self.set_servo_state(servo_state)
965
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700966
Richard Barnette9a26ad62016-06-10 12:03:08 -0700967 def repair_servo(self):
Dan Shi90466352015-09-22 15:01:05 -0700968 """
Richard Barnette9a26ad62016-06-10 12:03:08 -0700969 Confirm that servo is initialized and verified.
Dan Shi90466352015-09-22 15:01:05 -0700970
Richard Barnette9a26ad62016-06-10 12:03:08 -0700971 If the servo object is missing, attempt to repair the servo
972 host. Repair failures are passed back to the caller.
973
974 @raise AutoservError: If there is no servo host for this CrOS
975 host.
976 """
977 if self.servo:
978 return
979 if not self._servo_host:
980 raise error.AutoservError('No servo host for %s.' %
981 self.hostname)
Otabek Kasimovcc9738e2020-02-14 16:17:15 -0800982 try:
983 self._servo_host.repair()
984 except:
985 raise
986 finally:
987 self.set_servo_host(self._servo_host)
988
989
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700990 def set_servo_state(self, servo_state):
Otabek Kasimovcc9738e2020-02-14 16:17:15 -0800991 """Set servo info labels to dut host_info"""
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700992 if servo_state is not None:
Otabek Kasimovcc9738e2020-02-14 16:17:15 -0800993 host_info = self.host_info_store.get()
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700994 servo_state_prefix = servo_host.SERVO_STATE_LABEL_PREFIX
995 old_state = host_info.get_label_value(servo_state_prefix)
996 if old_state == servo_state:
997 # do not need update
998 return
999 host_info.set_version_label(servo_state_prefix, servo_state)
Otabek Kasimovcc9738e2020-02-14 16:17:15 -08001000 self.host_info_store.commit(host_info)
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001001 logging.info('ServoHost: servo_state updated to %s (previous: %s)',
1002 servo_state, old_state)
Dan Shi90466352015-09-22 15:01:05 -07001003
1004
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001005 def get_servo_state(self):
1006 host_info = self.host_info_store.get()
1007 servo_state_prefix = servo_host.SERVO_STATE_LABEL_PREFIX
1008 return host_info.get_label_value(servo_state_prefix)
1009
J. Richard Barnettec2d99cf2015-11-18 12:46:15 -08001010 def repair(self):
1011 """Attempt to get the DUT to pass `self.verify()`.
Richard Barnette82c35912012-11-20 10:09:10 -08001012
1013 This overrides the base class function for repair; it does
J. Richard Barnette91137f02016-03-10 16:52:26 -08001014 not call back to the parent class, but instead relies on
1015 `self._repair_strategy` to coordinate the verification and
1016 repair steps needed to get the DUT working.
Richard Barnette82c35912012-11-20 10:09:10 -08001017 """
Richard Barnetteabbdc252018-07-26 16:57:42 -07001018 message = 'Beginning repair for host %s board %s model %s'
1019 info = self.host_info_store.get()
1020 message %= (self.hostname, info.board, info.model)
1021 self.record('INFO', None, None, message)
J. Richard Barnette91137f02016-03-10 16:52:26 -08001022 self._repair_strategy.repair(self)
Scott Zawalski89c44dd2013-02-26 09:28:02 -05001023
Richard Barnette82c35912012-11-20 10:09:10 -08001024
J. Richard Barnette1d78b012012-05-15 13:56:30 -07001025 def close(self):
David Rileye2c6be12017-12-11 10:20:57 -08001026 """Close connection."""
Fang Deng0ca40e22013-08-27 17:47:44 -07001027 super(CrosHost, self).close()
howardchung83e55272019-08-08 14:08:05 +08001028
Shijin Abraham783a7dd2020-02-14 15:36:11 -08001029 if self._chameleon_host:
1030 self._chameleon_host.close()
xixuand6011f12016-12-08 15:01:58 -08001031
1032 if self._servo_host:
1033 self._servo_host.close()
J. Richard Barnette1d78b012012-05-15 13:56:30 -07001034
1035
Dan Shi49ca0932014-11-14 11:22:27 -08001036 def get_power_supply_info(self):
1037 """Get the output of power_supply_info.
1038
1039 power_supply_info outputs the info of each power supply, e.g.,
1040 Device: Line Power
1041 online: no
1042 type: Mains
1043 voltage (V): 0
1044 current (A): 0
1045 Device: Battery
1046 state: Discharging
1047 percentage: 95.9276
1048 technology: Li-ion
1049
1050 Above output shows two devices, Line Power and Battery, with details of
1051 each device listed. This function parses the output into a dictionary,
1052 with key being the device name, and value being a dictionary of details
1053 of the device info.
1054
1055 @return: The dictionary of power_supply_info, e.g.,
1056 {'Line Power': {'online': 'yes', 'type': 'main'},
1057 'Battery': {'vendor': 'xyz', 'percentage': '100'}}
Dan Shie9b765d2014-12-29 16:59:49 -08001058 @raise error.AutoservRunError if power_supply_info tool is not found in
1059 the DUT. Caller should handle this error to avoid false failure
1060 on verification.
Dan Shi49ca0932014-11-14 11:22:27 -08001061 """
1062 result = self.run('power_supply_info').stdout.strip()
1063 info = {}
1064 device_name = None
1065 device_info = {}
1066 for line in result.split('\n'):
1067 pair = [v.strip() for v in line.split(':')]
1068 if len(pair) != 2:
1069 continue
1070 if pair[0] == 'Device':
1071 if device_name:
1072 info[device_name] = device_info
1073 device_name = pair[1]
1074 device_info = {}
1075 else:
1076 device_info[pair[0]] = pair[1]
1077 if device_name and not device_name in info:
1078 info[device_name] = device_info
1079 return info
1080
1081
1082 def get_battery_percentage(self):
1083 """Get the battery percentage.
1084
1085 @return: The percentage of battery level, value range from 0-100. Return
1086 None if the battery info cannot be retrieved.
1087 """
1088 try:
1089 info = self.get_power_supply_info()
1090 logging.info(info)
1091 return float(info['Battery']['percentage'])
Dan Shie9b765d2014-12-29 16:59:49 -08001092 except (KeyError, ValueError, error.AutoservRunError):
Dan Shi49ca0932014-11-14 11:22:27 -08001093 return None
1094
1095
Daniel Campello8ca25c22019-12-13 16:48:26 -07001096 def get_battery_display_percentage(self):
1097 """Get the battery display percentage.
1098
1099 @return: The display percentage of battery level, value range from
1100 0-100. Return None if the battery info cannot be retrieved.
1101 """
1102 try:
1103 info = self.get_power_supply_info()
1104 logging.info(info)
1105 return float(info['Battery']['display percentage'])
1106 except (KeyError, ValueError, error.AutoservRunError):
1107 return None
1108
1109
Dan Shi49ca0932014-11-14 11:22:27 -08001110 def is_ac_connected(self):
1111 """Check if the dut has power adapter connected and charging.
1112
1113 @return: True if power adapter is connected and charging.
1114 """
1115 try:
1116 info = self.get_power_supply_info()
1117 return info['Line Power']['online'] == 'yes'
Dan Shie9b765d2014-12-29 16:59:49 -08001118 except (KeyError, error.AutoservRunError):
1119 return None
Dan Shi49ca0932014-11-14 11:22:27 -08001120
1121
Simran Basi5e6339a2013-03-21 11:34:32 -07001122 def _cleanup_poweron(self):
1123 """Special cleanup method to make sure hosts always get power back."""
Garry Wangad4d4fd2019-01-30 17:00:38 -08001124 info = self.host_info_store.get()
1125 if self._RPM_OUTLET_CHANGED not in info.attributes:
Simran Basi5e6339a2013-03-21 11:34:32 -07001126 return
1127 logging.debug('This host has recently interacted with the RPM'
1128 ' Infrastructure. Ensuring power is on.')
1129 try:
1130 self.power_on()
Garry Wangad4d4fd2019-01-30 17:00:38 -08001131 self._remove_rpm_changed_tag()
Simran Basi5e6339a2013-03-21 11:34:32 -07001132 except rpm_client.RemotePowerException:
Simran Basi5e6339a2013-03-21 11:34:32 -07001133 logging.error('Failed to turn Power On for this host after '
1134 'cleanup through the RPM Infrastructure.')
Dan Shi49ca0932014-11-14 11:22:27 -08001135
1136 battery_percentage = self.get_battery_percentage()
Dan Shif01ebe22014-12-05 13:10:57 -08001137 if battery_percentage and battery_percentage < 50:
Dan Shi49ca0932014-11-14 11:22:27 -08001138 raise
1139 elif self.is_ac_connected():
1140 logging.info('The device has power adapter connected and '
1141 'charging. No need to try to turn RPM on '
1142 'again.')
Garry Wangad4d4fd2019-01-30 17:00:38 -08001143 self._remove_rpm_changed_tag()
Dan Shi49ca0932014-11-14 11:22:27 -08001144 logging.info('Battery level is now at %s%%. The device may '
1145 'still have enough power to run test, so no '
1146 'exception will be raised.', battery_percentage)
1147
Simran Basi5e6339a2013-03-21 11:34:32 -07001148
Garry Wangad4d4fd2019-01-30 17:00:38 -08001149 def _remove_rpm_changed_tag(self):
1150 info = self.host_info_store.get()
1151 del info.attributes[self._RPM_OUTLET_CHANGED]
1152 self.host_info_store.commit(info)
1153
1154
1155 def _add_rpm_changed_tag(self):
1156 info = self.host_info_store.get()
Garry Wang518831d2019-02-21 15:15:36 -08001157 info.attributes[self._RPM_OUTLET_CHANGED] = 'true'
Garry Wangad4d4fd2019-01-30 17:00:38 -08001158 self.host_info_store.commit(info)
1159
1160
1161
beepsc87ff602013-07-31 21:53:00 -07001162 def _is_factory_image(self):
1163 """Checks if the image on the DUT is a factory image.
1164
1165 @return: True if the image on the DUT is a factory image.
1166 False otherwise.
1167 """
1168 result = self.run('[ -f /root/.factory_test ]', ignore_status=True)
1169 return result.exit_status == 0
1170
1171
1172 def _restart_ui(self):
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001173 """Restart the Chrome UI.
beepsc87ff602013-07-31 21:53:00 -07001174
1175 @raises: FactoryImageCheckerException for factory images, since
1176 we cannot attempt to restart ui on them.
1177 error.AutoservRunError for any other type of error that
1178 occurs while restarting ui.
1179 """
1180 if self._is_factory_image():
Dan Shi549fb822015-03-24 18:01:11 -07001181 raise FactoryImageCheckerException('Cannot restart ui on factory '
1182 'images')
beepsc87ff602013-07-31 21:53:00 -07001183
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001184 # TODO(jrbarnette): The command to stop/start the ui job
1185 # should live inside cros_ui, too. However that would seem
1186 # to imply interface changes to the existing start()/restart()
1187 # functions, which is a bridge too far (for now).
J. Richard Barnette6069aa12015-06-08 09:10:24 -07001188 prompt = cros_ui.get_chrome_session_ident(self)
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001189 self.run('stop ui; start ui')
1190 cros_ui.wait_for_chrome_ready(prompt, self)
beepsc87ff602013-07-31 21:53:00 -07001191
1192
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001193 def _start_powerd_if_needed(self):
1194 """Start powerd if it isn't already running."""
1195 self.run('start powerd', ignore_status=True)
1196
1197
xixuana3bbc422017-05-04 15:57:21 -07001198 def _get_lsb_release_content(self):
1199 """Return the content of lsb-release file of host."""
1200 return self.run(
1201 'cat "%s"' % client_constants.LSB_RELEASE).stdout.strip()
1202
1203
Dan Shi549fb822015-03-24 18:01:11 -07001204 def get_release_version(self):
1205 """Get the value of attribute CHROMEOS_RELEASE_VERSION from lsb-release.
1206
1207 @returns The version string in lsb-release, under attribute
1208 CHROMEOS_RELEASE_VERSION.
1209 """
Dan Shi549fb822015-03-24 18:01:11 -07001210 return lsbrelease_utils.get_chromeos_release_version(
xixuana3bbc422017-05-04 15:57:21 -07001211 lsb_release_content=self._get_lsb_release_content())
1212
1213
Don Garrettb9f35802018-01-22 18:25:40 -08001214 def get_release_builder_path(self):
1215 """Get the value of CHROMEOS_RELEASE_BUILDER_PATH from lsb-release.
1216
1217 @returns The version string in lsb-release, under attribute
1218 CHROMEOS_RELEASE_BUILDER_PATH.
1219 """
1220 return lsbrelease_utils.get_chromeos_release_builder_path(
1221 lsb_release_content=self._get_lsb_release_content())
1222
1223
xixuana3bbc422017-05-04 15:57:21 -07001224 def get_chromeos_release_milestone(self):
1225 """Get the value of attribute CHROMEOS_RELEASE_BUILD_TYPE
1226 from lsb-release.
1227
1228 @returns The version string in lsb-release, under attribute
1229 CHROMEOS_RELEASE_BUILD_TYPE.
1230 """
1231 return lsbrelease_utils.get_chromeos_release_milestone(
1232 lsb_release_content=self._get_lsb_release_content())
Dan Shi549fb822015-03-24 18:01:11 -07001233
1234
1235 def verify_cros_version_label(self):
1236 """ Make sure host's cros-version label match the actual image in dut.
1237
1238 Remove any cros-version: label that doesn't match that installed in
1239 the dut.
1240
1241 @param raise_error: Set to True to raise exception if any mismatch found
1242
1243 @raise error.AutoservError: If any mismatch between cros-version label
1244 and the build installed in dut is found.
1245 """
Prathmesh Prabhuce2da3a2019-10-04 11:54:51 -07001246 # crbug.com/1007333: This check is being removed.
1247 return True
Dan Shi549fb822015-03-24 18:01:11 -07001248
1249
Laurence Goodby778c9a42017-05-24 19:24:07 -07001250 def cleanup_services(self):
1251 """Reinitializes the device for cleanup.
1252
1253 Subclasses may override this to customize the cleanup method.
1254
1255 To indicate failure of the reset, the implementation may raise
1256 any of:
1257 error.AutoservRunError
1258 error.AutotestRunError
1259 FactoryImageCheckerException
1260
1261 @raises error.AutoservRunError
1262 @raises error.AutotestRunError
1263 @raises error.FactoryImageCheckerException
1264 """
1265 self._restart_ui()
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001266 self._start_powerd_if_needed()
Laurence Goodby778c9a42017-05-24 19:24:07 -07001267
1268
beepsc87ff602013-07-31 21:53:00 -07001269 def cleanup(self):
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -08001270 """Cleanup state on device."""
MK Ryu35d661e2014-09-25 17:44:10 -07001271 self.run('rm -f %s' % client_constants.CLEANUP_LOGS_PAUSED_FILE)
Scott Zawalskiddbc31e2012-11-15 11:29:01 -05001272 try:
Laurence Goodby778c9a42017-05-24 19:24:07 -07001273 self.cleanup_services()
beepsc87ff602013-07-31 21:53:00 -07001274 except (error.AutotestRunError, error.AutoservRunError,
1275 FactoryImageCheckerException):
Ilja H. Friedel04be2bd2014-05-07 21:29:59 -07001276 logging.warning('Unable to restart ui, rebooting device.')
Scott Zawalskiddbc31e2012-11-15 11:29:01 -05001277 # Since restarting the UI fails fall back to normal Autotest
1278 # cleanup routines, i.e. reboot the machine.
Fang Deng0ca40e22013-08-27 17:47:44 -07001279 super(CrosHost, self).cleanup()
Simran Basi5e6339a2013-03-21 11:34:32 -07001280 # Check if the rpm outlet was manipulated.
Simran Basid5e5e272012-09-24 15:23:59 -07001281 if self.has_power():
Simran Basi5e6339a2013-03-21 11:34:32 -07001282 self._cleanup_poweron()
Dan Shi549fb822015-03-24 18:01:11 -07001283 self.verify_cros_version_label()
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001284
1285
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001286 def reboot(self, **dargs):
1287 """
1288 This function reboots the site host. The more generic
1289 RemoteHost.reboot() performs sync and sleeps for 5
1290 seconds. This is not necessary for Chrome OS devices as the
1291 sync should be finished in a short time during the reboot
1292 command.
1293 """
Tom Wai-Hong Tamf5cd1d42012-08-13 12:04:08 +08001294 if 'reboot_cmd' not in dargs:
Doug Anderson7d5aeb22014-02-27 15:12:17 -08001295 reboot_timeout = dargs.get('reboot_timeout', 10)
J. Richard Barnette9af19632015-09-25 12:18:03 -07001296 dargs['reboot_cmd'] = ('sleep 1; '
1297 'reboot & sleep %d; '
1298 'reboot -f' % reboot_timeout)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001299 # Enable fastsync to avoid running extra sync commands before reboot.
Tom Wai-Hong Tamf5cd1d42012-08-13 12:04:08 +08001300 if 'fastsync' not in dargs:
1301 dargs['fastsync'] = True
Michael Liangda8c60a2014-06-03 13:24:51 -07001302
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001303 dargs['board'] = self.host_info_store.get().board
Vincent Palatindf2372c2016-10-07 17:03:00 +02001304 # Record who called us
1305 orig = sys._getframe(1).f_code
Vincent Palatin80780b22016-07-27 16:02:37 +02001306 metric_fields = {'board' : dargs['board'],
Vincent Palatindf2372c2016-10-07 17:03:00 +02001307 'dut_host_name' : self.hostname,
1308 'success' : True}
1309 metric_debug_fields = {'board' : dargs['board'],
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001310 'caller' : "%s:%s" % (orig.co_filename,
1311 orig.co_name),
Vincent Palatindf2372c2016-10-07 17:03:00 +02001312 'success' : True,
1313 'error' : ''}
1314
Vincent Palatin80780b22016-07-27 16:02:37 +02001315 t0 = time.time()
1316 try:
1317 super(CrosHost, self).reboot(**dargs)
1318 except Exception as e:
1319 metric_fields['success'] = False
Vincent Palatindf2372c2016-10-07 17:03:00 +02001320 metric_debug_fields['success'] = False
1321 metric_debug_fields['error'] = type(e).__name__
Vincent Palatin80780b22016-07-27 16:02:37 +02001322 raise
1323 finally:
1324 duration = int(time.time() - t0)
Dan Shi5e2efb72017-02-07 11:40:23 -08001325 metrics.Counter(
1326 'chromeos/autotest/autoserv/reboot_count').increment(
1327 fields=metric_fields)
1328 metrics.Counter(
1329 'chromeos/autotest/autoserv/reboot_debug').increment(
1330 fields=metric_debug_fields)
1331 metrics.SecondsDistribution(
1332 'chromeos/autotest/autoserv/reboot_duration').add(
1333 duration, fields=metric_fields)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001334
1335
Kalin Stoyanov83d9caa2020-01-31 16:58:27 -08001336 def suspend(self, suspend_time=60, delay_seconds=0,
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001337 suspend_cmd=None, allow_early_resume=False):
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001338 """
1339 This function suspends the site host.
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001340
1341 @param suspend_time: How long to suspend as integer seconds.
1342 @param suspend_cmd: Suspend command to execute.
1343 @param allow_early_resume: If False and if device resumes before
1344 |suspend_time|, throw an error.
1345
1346 @exception AutoservSuspendError Host resumed earlier than
1347 |suspend_time|.
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001348 """
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001349
1350 if suspend_cmd is None:
1351 suspend_cmd = ' && '.join([
J. Richard Barnette9af19632015-09-25 12:18:03 -07001352 'echo 0 > /sys/class/rtc/rtc0/wakealarm',
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001353 'echo +%d > /sys/class/rtc/rtc0/wakealarm' % suspend_time,
Kalin Stoyanov83d9caa2020-01-31 16:58:27 -08001354 'powerd_dbus_suspend --delay=%d' % delay_seconds])
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001355 super(CrosHost, self).suspend(suspend_time, suspend_cmd,
1356 allow_early_resume);
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001357
1358
Simran Basiec564392014-08-25 16:48:09 -07001359 def upstart_status(self, service_name):
1360 """Check the status of an upstart init script.
1361
1362 @param service_name: Service to look up.
1363
1364 @returns True if the service is running, False otherwise.
1365 """
Richard Barnettee204dc52017-09-26 11:02:25 -07001366 return 'start/running' in self.run('status %s' % service_name,
1367 ignore_status=True).stdout
Simran Basiec564392014-08-25 16:48:09 -07001368
Tom Hughese9552342018-12-18 14:29:25 -08001369 def upstart_stop(self, service_name):
1370 """Stops an upstart job if it's running.
1371
1372 @param service_name: Service to stop
1373
1374 @returns True if service has been stopped or was already stopped
1375 False otherwise.
1376 """
1377 if not self.upstart_status(service_name):
1378 return True
1379
1380 result = self.run('stop %s' % service_name, ignore_status=True)
1381 if result.exit_status != 0:
1382 return False
1383 return True
1384
1385 def upstart_restart(self, service_name):
1386 """Restarts (or starts) an upstart job.
1387
1388 @param service_name: Service to start/restart
1389
1390 @returns True if service has been started/restarted, False otherwise.
1391 """
1392 cmd = 'start'
1393 if self.upstart_status(service_name):
1394 cmd = 'restart'
1395 cmd = cmd + ' %s' % service_name
1396 result = self.run(cmd)
1397 if result.exit_status != 0:
1398 return False
1399 return True
Simran Basiec564392014-08-25 16:48:09 -07001400
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001401 def verify_software(self):
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001402 """Verify working software on a Chrome OS system.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001403
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001404 Tests for the following conditions:
1405 1. All conditions tested by the parent version of this
1406 function.
1407 2. Sufficient space in /mnt/stateful_partition.
Fang Deng6b05f5b2013-03-20 13:42:11 -07001408 3. Sufficient space in /mnt/stateful_partition/encrypted.
1409 4. update_engine answers a simple status request over DBus.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001410
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001411 """
Fang Deng0ca40e22013-08-27 17:47:44 -07001412 super(CrosHost, self).verify_software()
Dan Shib8540a52015-07-16 14:18:23 -07001413 default_kilo_inodes_required = CONFIG.get_config_value(
1414 'SERVER', 'kilo_inodes_required', type=int, default=100)
1415 board = self.get_board().replace(ds_constants.BOARD_PREFIX, '')
1416 kilo_inodes_required = CONFIG.get_config_value(
1417 'SERVER', 'kilo_inodes_required_%s' % board,
1418 type=int, default=default_kilo_inodes_required)
1419 self.check_inodes('/mnt/stateful_partition', kilo_inodes_required)
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001420 self.check_diskspace(
1421 '/mnt/stateful_partition',
Dan Shib8540a52015-07-16 14:18:23 -07001422 CONFIG.get_config_value(
Fang Deng6b05f5b2013-03-20 13:42:11 -07001423 'SERVER', 'gb_diskspace_required', type=float,
1424 default=20.0))
Gaurav Shahe448af82014-06-19 15:18:59 -07001425 encrypted_stateful_path = '/mnt/stateful_partition/encrypted'
1426 # Not all targets build with encrypted stateful support.
1427 if self.path_exists(encrypted_stateful_path):
1428 self.check_diskspace(
1429 encrypted_stateful_path,
Dan Shib8540a52015-07-16 14:18:23 -07001430 CONFIG.get_config_value(
Gaurav Shahe448af82014-06-19 15:18:59 -07001431 'SERVER', 'gb_encrypted_diskspace_required', type=float,
1432 default=0.1))
beepsc87ff602013-07-31 21:53:00 -07001433
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001434 self.wait_for_system_services()
Prashanth B5d0a0512014-04-25 12:26:08 -07001435
beepsc87ff602013-07-31 21:53:00 -07001436 # Factory images don't run update engine,
1437 # goofy controls dbus on these DUTs.
1438 if not self._is_factory_image():
1439 self.run('update_engine_client --status')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001440
Dan Shi549fb822015-03-24 18:01:11 -07001441 self.verify_cros_version_label()
1442
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001443
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001444 @retry.retry(error.AutoservError, timeout_min=5, delay_sec=10)
1445 def wait_for_system_services(self):
1446 """Waits for system-services to be running.
1447
1448 Sometimes, update_engine will take a while to update firmware, so we
1449 should give this some time to finish. See crbug.com/765686#c38 for
1450 details.
1451 """
1452 if not self.upstart_status('system-services'):
1453 raise error.AutoservError('Chrome failed to reach login. '
1454 'System services not running.')
1455
1456
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001457 def verify(self):
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -08001458 """Verify Chrome OS system is in good state."""
Richard Barnetteabbdc252018-07-26 16:57:42 -07001459 message = 'Beginning verify for host %s board %s model %s'
1460 info = self.host_info_store.get()
1461 message %= (self.hostname, info.board, info.model)
1462 self.record('INFO', None, None, message)
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001463 self._repair_strategy.verify(self)
1464
1465
Fang Deng96667ca2013-08-01 17:46:18 -07001466 def make_ssh_command(self, user='root', port=22, opts='', hosts_file=None,
Dean Liaoe3e75f62017-11-14 10:36:43 +08001467 connect_timeout=None, alive_interval=None,
1468 alive_count_max=None, connection_attempts=None):
Fang Deng96667ca2013-08-01 17:46:18 -07001469 """Override default make_ssh_command to use options tuned for Chrome OS.
1470
1471 Tuning changes:
1472 - ConnectTimeout=30; maximum of 30 seconds allowed for an SSH
1473 connection failure. Consistency with remote_access.sh.
1474
Samuel Tan2ce155b2015-06-23 18:24:38 -07001475 - ServerAliveInterval=900; which causes SSH to ping connection every
1476 900 seconds. In conjunction with ServerAliveCountMax ensures
1477 that if the connection dies, Autotest will bail out.
Fang Deng96667ca2013-08-01 17:46:18 -07001478 Originally tried 60 secs, but saw frequent job ABORTS where
Samuel Tan2ce155b2015-06-23 18:24:38 -07001479 the test completed successfully. Later increased from 180 seconds to
1480 900 seconds to account for tests where the DUT is suspended for
1481 longer periods of time.
Fang Deng96667ca2013-08-01 17:46:18 -07001482
1483 - ServerAliveCountMax=3; consistency with remote_access.sh.
1484
1485 - ConnectAttempts=4; reduce flakiness in connection errors;
1486 consistency with remote_access.sh.
1487
1488 - UserKnownHostsFile=/dev/null; we don't care about the keys.
1489 Host keys change with every new installation, don't waste
1490 memory/space saving them.
1491
1492 - SSH protocol forced to 2; needed for ServerAliveInterval.
1493
1494 @param user User name to use for the ssh connection.
1495 @param port Port on the target host to use for ssh connection.
1496 @param opts Additional options to the ssh command.
1497 @param hosts_file Ignored.
1498 @param connect_timeout Ignored.
1499 @param alive_interval Ignored.
Dean Liaoe3e75f62017-11-14 10:36:43 +08001500 @param alive_count_max Ignored.
1501 @param connection_attempts Ignored.
Fang Deng96667ca2013-08-01 17:46:18 -07001502 """
Dean Liaoe3e75f62017-11-14 10:36:43 +08001503 options = ' '.join([opts, '-o Protocol=2'])
1504 return super(CrosHost, self).make_ssh_command(
1505 user=user, port=port, opts=options, hosts_file='/dev/null',
1506 connect_timeout=30, alive_interval=900, alive_count_max=3,
1507 connection_attempts=4)
1508
1509
Jason Abeleb6f924f2013-11-13 16:01:54 -08001510 def syslog(self, message, tag='autotest'):
1511 """Logs a message to syslog on host.
1512
1513 @param message String message to log into syslog
1514 @param tag String tag prefix for syslog
1515
1516 """
1517 self.run('logger -t "%s" "%s"' % (tag, message))
1518
1519
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001520 def _ping_check_status(self, status):
1521 """Ping the host once, and return whether it has a given status.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001522
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001523 @param status Check the ping status against this value.
1524 @return True iff `status` and the result of ping are the same
1525 (i.e. both True or both False).
1526
1527 """
1528 ping_val = utils.ping(self.hostname, tries=1, deadline=1)
1529 return not (status ^ (ping_val == 0))
1530
1531 def _ping_wait_for_status(self, status, timeout):
1532 """Wait for the host to have a given status (UP or DOWN).
1533
1534 Status is checked by polling. Polling will not last longer
1535 than the number of seconds in `timeout`. The polling
1536 interval will be long enough that only approximately
1537 _PING_WAIT_COUNT polling cycles will be executed, subject
1538 to a maximum interval of about one minute.
1539
1540 @param status Waiting will stop immediately if `ping` of the
1541 host returns this status.
1542 @param timeout Poll for at most this many seconds.
1543 @return True iff the host status from `ping` matched the
1544 requested status at the time of return.
1545
1546 """
1547 # _ping_check_status() takes about 1 second, hence the
1548 # "- 1" in the formula below.
Nathan Ciobanu38480a32016-10-25 15:26:45 -07001549 # FIXME: if the ping command errors then _ping_check_status()
1550 # returns instantly. If timeout is also smaller than twice
1551 # _PING_WAIT_COUNT then the while loop below forks many
1552 # thousands of ping commands (see /tmp/test_that_results_XXXXX/
1553 # /results-1-logging_YYY.ZZZ/debug/autoserv.DEBUG) and hogs one
1554 # CPU core for 60 seconds.
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001555 poll_interval = min(int(timeout / self._PING_WAIT_COUNT), 60) - 1
1556 end_time = time.time() + timeout
1557 while time.time() <= end_time:
1558 if self._ping_check_status(status):
1559 return True
1560 if poll_interval > 0:
1561 time.sleep(poll_interval)
1562
1563 # The last thing we did was sleep(poll_interval), so it may
1564 # have been too long since the last `ping`. Check one more
1565 # time, just to be sure.
1566 return self._ping_check_status(status)
1567
1568 def ping_wait_up(self, timeout):
1569 """Wait for the host to respond to `ping`.
1570
1571 N.B. This method is not a reliable substitute for
1572 `wait_up()`, because a host that responds to ping will not
1573 necessarily respond to ssh. This method should only be used
1574 if the target DUT can be considered functional even if it
1575 can't be reached via ssh.
1576
1577 @param timeout Minimum time to allow before declaring the
1578 host to be non-responsive.
1579 @return True iff the host answered to ping before the timeout.
1580
1581 """
1582 return self._ping_wait_for_status(self._PING_STATUS_UP, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001583
Andrew Bresticker678c0c72013-01-22 10:44:09 -08001584 def ping_wait_down(self, timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001585 """Wait until the host no longer responds to `ping`.
1586
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001587 This function can be used as a slightly faster version of
1588 `wait_down()`, by avoiding potentially long ssh timeouts.
1589
1590 @param timeout Minimum time to allow for the host to become
1591 non-responsive.
1592 @return True iff the host quit answering ping before the
1593 timeout.
1594
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001595 """
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001596 return self._ping_wait_for_status(self._PING_STATUS_DOWN, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001597
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001598 def test_wait_for_sleep(self, sleep_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001599 """Wait for the client to enter low-power sleep mode.
1600
1601 The test for "is asleep" can't distinguish a system that is
1602 powered off; to confirm that the unit was asleep, it is
1603 necessary to force resume, and then call
1604 `test_wait_for_resume()`.
1605
1606 This function is expected to be called from a test as part
1607 of a sequence like the following:
1608
1609 ~~~~~~~~
1610 boot_id = host.get_boot_id()
1611 # trigger sleep on the host
1612 host.test_wait_for_sleep()
1613 # trigger resume on the host
1614 host.test_wait_for_resume(boot_id)
1615 ~~~~~~~~
1616
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001617 @param sleep_timeout time limit in seconds to allow the host sleep.
1618
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001619 @exception TestFail The host did not go to sleep within
1620 the allowed time.
1621 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001622 if sleep_timeout is None:
1623 sleep_timeout = self.SLEEP_TIMEOUT
1624
1625 if not self.ping_wait_down(timeout=sleep_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001626 raise error.TestFail(
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001627 'client failed to sleep after %d seconds' % sleep_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001628
1629
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001630 def test_wait_for_resume(self, old_boot_id, resume_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001631 """Wait for the client to resume from low-power sleep mode.
1632
1633 The `old_boot_id` parameter should be the value from
1634 `get_boot_id()` obtained prior to entering sleep mode. A
1635 `TestFail` exception is raised if the boot id changes.
1636
1637 See @ref test_wait_for_sleep for more on this function's
1638 usage.
1639
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08001640 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001641 target host went to sleep.
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001642 @param resume_timeout time limit in seconds to allow the host up.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001643
1644 @exception TestFail The host did not respond within the
1645 allowed time.
1646 @exception TestFail The host responded, but the boot id test
1647 indicated a reboot rather than a sleep
1648 cycle.
1649 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001650 if resume_timeout is None:
1651 resume_timeout = self.RESUME_TIMEOUT
1652
1653 if not self.wait_up(timeout=resume_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001654 raise error.TestFail(
1655 'client failed to resume from sleep after %d seconds' %
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001656 resume_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001657 else:
1658 new_boot_id = self.get_boot_id()
1659 if new_boot_id != old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001660 logging.error('client rebooted (old boot %s, new boot %s)',
1661 old_boot_id, new_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001662 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001663 'client rebooted, but sleep was expected')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001664
1665
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001666 def test_wait_for_shutdown(self, shutdown_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001667 """Wait for the client to shut down.
1668
1669 The test for "has shut down" can't distinguish a system that
1670 is merely asleep; to confirm that the unit was down, it is
1671 necessary to force boot, and then call test_wait_for_boot().
1672
1673 This function is expected to be called from a test as part
1674 of a sequence like the following:
1675
1676 ~~~~~~~~
1677 boot_id = host.get_boot_id()
1678 # trigger shutdown on the host
1679 host.test_wait_for_shutdown()
1680 # trigger boot on the host
1681 host.test_wait_for_boot(boot_id)
1682 ~~~~~~~~
1683
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001684 @param shutdown_timeout time limit in seconds to allow the host down.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001685 @exception TestFail The host did not shut down within the
1686 allowed time.
1687 """
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001688 if shutdown_timeout is None:
1689 shutdown_timeout = self.SHUTDOWN_TIMEOUT
1690
1691 if not self.ping_wait_down(timeout=shutdown_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001692 raise error.TestFail(
1693 'client failed to shut down after %d seconds' %
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001694 shutdown_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001695
1696
1697 def test_wait_for_boot(self, old_boot_id=None):
1698 """Wait for the client to boot from cold power.
1699
1700 The `old_boot_id` parameter should be the value from
1701 `get_boot_id()` obtained prior to shutting down. A
1702 `TestFail` exception is raised if the boot id does not
1703 change. The boot id test is omitted if `old_boot_id` is not
1704 specified.
1705
1706 See @ref test_wait_for_shutdown for more on this function's
1707 usage.
1708
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08001709 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001710 shut down.
1711
1712 @exception TestFail The host did not respond within the
1713 allowed time.
1714 @exception TestFail The host responded, but the boot id test
1715 indicated that there was no reboot.
1716 """
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07001717 if not self.wait_up(timeout=self.REBOOT_TIMEOUT):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001718 raise error.TestFail(
1719 'client failed to reboot after %d seconds' %
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07001720 self.REBOOT_TIMEOUT)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001721 elif old_boot_id:
1722 if self.get_boot_id() == old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001723 logging.error('client not rebooted (boot %s)',
1724 old_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001725 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001726 'client is back up, but did not reboot')
Simran Basid5e5e272012-09-24 15:23:59 -07001727
1728
1729 @staticmethod
1730 def check_for_rpm_support(hostname):
1731 """For a given hostname, return whether or not it is powered by an RPM.
1732
Simran Basi1df55112013-09-06 11:25:09 -07001733 @param hostname: hostname to check for rpm support.
1734
Simran Basid5e5e272012-09-24 15:23:59 -07001735 @return None if this host does not follows the defined naming format
1736 for RPM powered DUT's in the lab. If it does follow the format,
1737 it returns a regular expression MatchObject instead.
1738 """
Fang Dengbaff9082015-01-06 13:46:15 -08001739 return re.match(CrosHost._RPM_HOSTNAME_REGEX, hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07001740
1741
1742 def has_power(self):
1743 """For this host, return whether or not it is powered by an RPM.
1744
1745 @return True if this host is in the CROS lab and follows the defined
1746 naming format.
1747 """
Fang Deng0ca40e22013-08-27 17:47:44 -07001748 return CrosHost.check_for_rpm_support(self.hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07001749
1750
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001751 def _set_power(self, state, power_method):
Garry Wang5e5538a2019-04-08 15:36:18 -07001752 """Sets the power to the host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001753
1754 @param state Specifies which power state to set to DUT
1755 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001756 use. By default "RPM" or "CCD" will be used based
1757 on servo type. Valid values from
1758 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001759
1760 """
1761 ACCEPTABLE_STATES = ['ON', 'OFF']
1762
Garry Wang5e5538a2019-04-08 15:36:18 -07001763 if not power_method:
1764 power_method = self.get_default_power_method()
1765
1766 state = state.upper()
1767 if state not in ACCEPTABLE_STATES:
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001768 raise error.TestError('State must be one of: %s.'
1769 % (ACCEPTABLE_STATES,))
1770
1771 if power_method == self.POWER_CONTROL_SERVO:
1772 logging.info('Setting servo port J10 to %s', state)
1773 self.servo.set('prtctl3_pwren', state.lower())
1774 time.sleep(self._USB_POWER_TIMEOUT)
1775 elif power_method == self.POWER_CONTROL_MANUAL:
1776 logging.info('You have %d seconds to set the AC power to %s.',
1777 self._POWER_CYCLE_TIMEOUT, state)
1778 time.sleep(self._POWER_CYCLE_TIMEOUT)
Garry Wang5e5538a2019-04-08 15:36:18 -07001779 elif power_method == self.POWER_CONTROL_CCD:
1780 servo_role = 'src' if state == 'ON' else 'snk'
1781 logging.info('servo ccd power pass through detected,'
1782 ' changing servo_role to %s.', servo_role)
1783 self.servo.set_servo_v4_role(servo_role)
1784 if not self.ping_wait_up(timeout=self._CHANGE_SERVO_ROLE_TIMEOUT):
Garry Wang94bf9de2019-06-10 17:23:37 -07001785 # Make sure we don't leave DUT with no power(servo_role=snk)
1786 # when DUT is not pingable, as we raise a exception here
1787 # that may break a power cycle in the middle.
1788 self.servo.set_servo_v4_role('src')
Garry Wang5e5538a2019-04-08 15:36:18 -07001789 raise error.AutoservError(
1790 'DUT failed to regain network connection after %d seconds.'
1791 % self._CHANGE_SERVO_ROLE_TIMEOUT)
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001792 else:
1793 if not self.has_power():
1794 raise error.TestFail('DUT does not have RPM connected.')
Garry Wangad4d4fd2019-01-30 17:00:38 -08001795 self._add_rpm_changed_tag()
Garry Wang5e5538a2019-04-08 15:36:18 -07001796 rpm_client.set_power(self, state, timeout_mins=5)
Simran Basid5e5e272012-09-24 15:23:59 -07001797
1798
Garry Wang5e5538a2019-04-08 15:36:18 -07001799 def power_off(self, power_method=None):
1800 """Turn off power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001801
1802 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001803 use. By default "RPM" or "CCD" will be used based
1804 on servo type. Valid values from
1805 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001806
1807 """
1808 self._set_power('OFF', power_method)
Simran Basid5e5e272012-09-24 15:23:59 -07001809
1810
Garry Wang5e5538a2019-04-08 15:36:18 -07001811 def power_on(self, power_method=None):
1812 """Turn on power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001813
1814 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001815 use. By default "RPM" or "CCD" will be used based
1816 on servo type. Valid values from
1817 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001818
1819 """
1820 self._set_power('ON', power_method)
1821
1822
Garry Wang5e5538a2019-04-08 15:36:18 -07001823 def power_cycle(self, power_method=None):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001824 """Cycle power to this host by turning it OFF, then ON.
1825
1826 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001827 use. By default "RPM" or "CCD" will be used based
1828 on servo type. Valid values from
1829 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001830
1831 """
Garry Wang5e5538a2019-04-08 15:36:18 -07001832 if not power_method:
1833 power_method = self.get_default_power_method()
1834
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001835 if power_method in (self.POWER_CONTROL_SERVO,
Garry Wang5e5538a2019-04-08 15:36:18 -07001836 self.POWER_CONTROL_MANUAL,
1837 self.POWER_CONTROL_CCD):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001838 self.power_off(power_method=power_method)
1839 time.sleep(self._POWER_CYCLE_TIMEOUT)
1840 self.power_on(power_method=power_method)
1841 else:
Garry Wangad4d4fd2019-01-30 17:00:38 -08001842 self._add_rpm_changed_tag()
1843 rpm_client.set_power(self, 'CYCLE')
Simran Basic6f1f7a2012-10-16 10:47:46 -07001844
1845
Mary Ruthvende14a8b2019-08-23 12:43:52 -07001846 def get_platform_from_fwid(self):
1847 """Determine the platform from the crossystem fwid.
1848
1849 @returns a string representing this host's platform.
1850 """
1851 # Look at the firmware for non-unibuild cases or if mosys fails.
1852 crossystem = utils.Crossystem(self)
1853 crossystem.init()
1854 # Extract fwid value and use the leading part as the platform id.
1855 # fwid generally follow the format of {platform}.{firmware version}
1856 # Example: Alex.X.YYY.Z or Google_Alex.X.YYY.Z
1857 platform = crossystem.fwid().split('.')[0].lower()
1858 # Newer platforms start with 'Google_' while the older ones do not.
1859 return platform.replace('google_', '')
1860
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08001861
Simran Basic6f1f7a2012-10-16 10:47:46 -07001862 def get_platform(self):
1863 """Determine the correct platform label for this host.
1864
1865 @returns a string representing this host's platform.
1866 """
C Shapiroed87c6f2018-04-19 09:13:58 -06001867 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
1868 run_method=self.run)
C Shapiroed87c6f2018-04-19 09:13:58 -06001869 platform = ''
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08001870 if release_info.get('CHROMEOS_RELEASE_UNIBUILD') == '1':
1871 platform = self.get_platform_from_mosys()
Mary Ruthvende14a8b2019-08-23 12:43:52 -07001872 return platform if platform else self.get_platform_from_fwid()
Simran Basic6f1f7a2012-10-16 10:47:46 -07001873
1874
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08001875 def get_platform_from_mosys(self):
1876 """Get the host platform from mosys command.
1877
1878 @returns a string representing this host's platform.
1879 """
1880 cmd = 'mosys platform model'
1881 result = self.run(command=cmd, ignore_status=True)
1882 return result.stdout.strip() if result.exit_status == 0 else ''
1883
1884
Hung-ying Tyanb1328032014-04-01 14:18:54 +08001885 def get_architecture(self):
1886 """Determine the correct architecture label for this host.
1887
1888 @returns a string representing this host's architecture.
1889 """
1890 crossystem = utils.Crossystem(self)
1891 crossystem.init()
1892 return crossystem.arch()
1893
1894
Luis Lozano40b7d0d2014-01-17 15:12:06 -08001895 def get_chrome_version(self):
1896 """Gets the Chrome version number and milestone as strings.
1897
1898 Invokes "chrome --version" to get the version number and milestone.
1899
1900 @return A tuple (chrome_ver, milestone) where "chrome_ver" is the
1901 current Chrome version number as a string (in the form "W.X.Y.Z")
1902 and "milestone" is the first component of the version number
1903 (the "W" from "W.X.Y.Z"). If the version number cannot be parsed
1904 in the "W.X.Y.Z" format, the "chrome_ver" will be the full output
1905 of "chrome --version" and the milestone will be the empty string.
1906
1907 """
MK Ryu35d661e2014-09-25 17:44:10 -07001908 version_string = self.run(client_constants.CHROME_VERSION_COMMAND).stdout
Luis Lozano40b7d0d2014-01-17 15:12:06 -08001909 return utils.parse_chrome_version(version_string)
1910
J. Richard Barnetted2af5852016-02-05 15:03:10 -08001911
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001912 def get_ec_version(self):
1913 """Get the ec version as strings.
1914
1915 @returns a string representing this host's ec version.
1916 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08001917 command = 'mosys ec info -s fw_version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08001918 result = self.run(command, ignore_status=True)
1919 if result.exit_status != 0:
1920 return ''
1921 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001922
1923
1924 def get_firmware_version(self):
1925 """Get the firmware version as strings.
1926
1927 @returns a string representing this host's firmware version.
1928 """
1929 crossystem = utils.Crossystem(self)
1930 crossystem.init()
1931 return crossystem.fwid()
1932
1933
1934 def get_hardware_revision(self):
1935 """Get the hardware revision as strings.
1936
1937 @returns a string representing this host's hardware revision.
1938 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08001939 command = 'mosys platform version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08001940 result = self.run(command, ignore_status=True)
1941 if result.exit_status != 0:
1942 return ''
1943 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001944
1945
1946 def get_kernel_version(self):
1947 """Get the kernel version as strings.
1948
1949 @returns a string representing this host's kernel version.
1950 """
1951 return self.run('uname -r').stdout.strip()
1952
1953
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08001954 def get_cpu_name(self):
1955 """Get the cpu name as strings.
1956
1957 @returns a string representing this host's cpu name.
1958 """
1959
1960 # Try get cpu name from device tree first
1961 if self.path_exists('/proc/device-tree/compatible'):
1962 command = ' | '.join(
1963 ["sed -e 's/\\x0/\\n/g' /proc/device-tree/compatible",
1964 'tail -1'])
1965 return self.run(command).stdout.strip().replace(',', ' ')
1966
1967 # Get cpu name from uname -p
1968 command = 'uname -p'
1969 ret = self.run(command).stdout.strip()
1970
1971 # 'uname -p' return variant of unknown or amd64 or x86_64 or i686
1972 # Try get cpu name from /proc/cpuinfo instead
1973 if re.match("unknown|amd64|[ix][0-9]?86(_64)?", ret, re.IGNORECASE):
1974 command = "grep model.name /proc/cpuinfo | cut -f 2 -d: | head -1"
1975 self = self.run(command).stdout.strip()
1976
1977 # Remove bloat from CPU name, for example
1978 # Intel(R) Core(TM) i5-7Y57 CPU @ 1.20GHz -> Intel Core i5-7Y57
1979 # Intel(R) Xeon(R) CPU E5-2690 v4 @ 2.60GHz -> Intel Xeon E5-2690 v4
1980 # AMD A10-7850K APU with Radeon(TM) R7 Graphics -> AMD A10-7850K
1981 # AMD GX-212JC SOC with Radeon(TM) R2E Graphics -> AMD GX-212JC
1982 trim_re = r' (@|processor|apu|soc|radeon).*|\(.*?\)| cpu'
1983 return re.sub(trim_re, '', ret, flags=re.IGNORECASE)
1984
1985
1986 def get_screen_resolution(self):
1987 """Get the screen(s) resolution as strings.
1988 In case of more than 1 monitor, return resolution for each monitor
1989 separate with plus sign.
1990
1991 @returns a string representing this host's screen(s) resolution.
1992 """
1993 command = 'for f in /sys/class/drm/*/*/modes; do head -1 $f; done'
1994 ret = self.run(command, ignore_status=True)
1995 # We might have Chromebox without a screen
1996 if ret.exit_status != 0:
1997 return ''
1998 return ret.stdout.strip().replace('\n', '+')
1999
2000
2001 def get_mem_total_gb(self):
2002 """Get total memory available in the system in GiB (2^20).
2003
2004 @returns an integer representing total memory
2005 """
2006 mem_total_kb = self.read_from_meminfo('MemTotal')
2007 kb_in_gb = float(2 ** 20)
2008 return int(round(mem_total_kb / kb_in_gb))
2009
2010
2011 def get_disk_size_gb(self):
2012 """Get size of disk in GB (10^9)
2013
2014 @returns an integer representing size of disk, 0 in Error Case
2015 """
2016 command = 'grep $(rootdev -s -d | cut -f3 -d/)$ /proc/partitions'
2017 result = self.run(command, ignore_status=True)
2018 if result.exit_status != 0:
2019 return 0
2020 _, _, block, _ = re.split(r' +', result.stdout.strip())
2021 byte_per_block = 1024.0
2022 disk_kb_in_gb = 1e9
2023 return int(int(block) * byte_per_block / disk_kb_in_gb + 0.5)
2024
2025
2026 def get_battery_size(self):
2027 """Get size of battery in Watt-hour via sysfs
2028
2029 This method assumes that battery support voltage_min_design and
2030 charge_full_design sysfs.
2031
2032 @returns a float representing Battery size, 0 if error.
2033 """
2034 # sysfs report data in micro scale
2035 battery_scale = 1e6
2036
2037 command = 'cat /sys/class/power_supply/*/voltage_min_design'
2038 result = self.run(command, ignore_status=True)
2039 if result.exit_status != 0:
2040 return 0
2041 voltage = float(result.stdout.strip()) / battery_scale
2042
2043 command = 'cat /sys/class/power_supply/*/charge_full_design'
2044 result = self.run(command, ignore_status=True)
2045 if result.exit_status != 0:
2046 return 0
2047 amphereHour = float(result.stdout.strip()) / battery_scale
2048
2049 return voltage * amphereHour
2050
2051
2052 def get_low_battery_shutdown_percent(self):
2053 """Get the percent-based low-battery shutdown threshold.
2054
2055 @returns a float representing low-battery shutdown percent, 0 if error.
2056 """
2057 ret = 0.0
2058 try:
2059 command = 'check_powerd_config --low_battery_shutdown_percent'
2060 ret = float(self.run(command).stdout)
2061 except error.CmdError:
2062 logging.debug("Can't run %s", command)
2063 except ValueError:
2064 logging.debug("Didn't get number from %s", command)
2065
2066 return ret
2067
2068
Puthikorn Voravootivat09c83d72018-08-10 15:58:32 -07002069 def has_hammer(self):
2070 """Check whether DUT has hammer device or not.
2071
2072 @returns boolean whether device has hammer or not
2073 """
2074 command = 'grep Hammer /sys/bus/usb/devices/*/product'
2075 return self.run(command, ignore_status=True).exit_status == 0
2076
2077
Niranjan Kumar34618872017-05-31 12:57:09 -07002078 def is_chrome_switch_present(self, switch):
David Haddock3ce538e2017-06-22 13:37:05 -07002079 """Returns True if the specified switch was provided to Chrome.
2080
2081 @param switch The chrome switch to search for.
2082 """
Niranjan Kumar34618872017-05-31 12:57:09 -07002083
Niranjan Kumar5f23fe92017-06-22 15:18:55 -07002084 command = 'pgrep -x -f -c "/opt/google/chrome/chrome.*%s.*"' % switch
2085 return self.run(command, ignore_status=True).exit_status == 0
Niranjan Kumar34618872017-05-31 12:57:09 -07002086
2087
2088 def oobe_triggers_update(self):
2089 """Returns True if this host has an OOBE flow during which
2090 it will perform an update check and perhaps an update.
2091 One example of such a flow is Hands-Off Zero-Touch Enrollment.
2092 As more such flows are developed, code handling them needs
2093 to be added here.
2094
2095 @return Boolean indicating whether this host's OOBE triggers an update.
2096 """
2097 return self.is_chrome_switch_present(
2098 '--enterprise-enable-zero-touch-enrollment=hands-off')
2099
2100
Kevin Chenga2619dc2016-03-28 11:42:08 -07002101 # TODO(kevcheng): change this to just return the board without the
2102 # 'board:' prefix and fix up all the callers. Also look into removing the
2103 # need for this method.
Simran Basic6f1f7a2012-10-16 10:47:46 -07002104 def get_board(self):
2105 """Determine the correct board label for this host.
2106
2107 @returns a string representing this host's board.
2108 """
2109 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
2110 run_method=self.run)
J. Richard Barnetted2af5852016-02-05 15:03:10 -08002111 return (ds_constants.BOARD_PREFIX +
2112 release_info['CHROMEOS_RELEASE_BOARD'])
Simran Basic6f1f7a2012-10-16 10:47:46 -07002113
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07002114 def get_channel(self):
2115 """Determine the correct channel label for this host.
Simran Basic6f1f7a2012-10-16 10:47:46 -07002116
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07002117 @returns: a string represeting this host's build channel.
2118 (stable, dev, beta). None on fail.
2119 """
2120 return lsbrelease_utils.get_chromeos_channel(
2121 lsb_release_content=self._get_lsb_release_content())
Kevin Chenga328da62016-03-31 10:49:04 -07002122
Kevin Chenga328da62016-03-31 10:49:04 -07002123 def get_power_supply(self):
2124 """
2125 Determine what type of power supply the host has
2126
2127 @returns a string representing this host's power supply.
2128 'power:battery' when the device has a battery intended for
2129 extended use
2130 'power:AC_primary' when the device has a battery not intended
2131 for extended use (for moving the machine, etc)
2132 'power:AC_only' when the device has no battery at all.
2133 """
2134 psu = self.run(command='mosys psu type', ignore_status=True)
2135 if psu.exit_status:
2136 # The psu command for mosys is not included for all platforms. The
2137 # assumption is that the device will have a battery if the command
2138 # is not found.
2139 return 'power:battery'
2140
2141 psu_str = psu.stdout.strip()
2142 if psu_str == 'unknown':
2143 return None
2144
2145 return 'power:%s' % psu_str
2146
2147
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08002148 def has_battery(self):
2149 """Determine if DUT has a battery.
2150
2151 Returns:
2152 Boolean, False if known not to have battery, True otherwise.
2153 """
2154 rv = True
2155 power_supply = self.get_power_supply()
2156 if power_supply == 'power:battery':
2157 _NO_BATTERY_BOARD_TYPE = ['CHROMEBOX', 'CHROMEBIT', 'CHROMEBASE']
2158 board_type = self.get_board_type()
2159 if board_type in _NO_BATTERY_BOARD_TYPE:
2160 logging.warn('Do NOT believe type %s has battery. '
2161 'See debug for mosys details', board_type)
2162 psu = self.system_output('mosys -vvvv psu type',
2163 ignore_status=True)
2164 logging.debug(psu)
2165 rv = False
2166 elif power_supply == 'power:AC_only':
2167 rv = False
2168
2169 return rv
2170
2171
Kevin Chenga328da62016-03-31 10:49:04 -07002172 def get_servo(self):
2173 """Determine if the host has a servo attached.
2174
2175 If the host has a working servo attached, it should have a servo label.
2176
2177 @return: string 'servo' if the host has servo attached. Otherwise,
2178 returns None.
2179 """
2180 return 'servo' if self._servo_host else None
2181
2182
Kevin Chenga328da62016-03-31 10:49:04 -07002183 def has_internal_display(self):
2184 """Determine if the device under test is equipped with an internal
2185 display.
2186
2187 @return: 'internal_display' if one is present; None otherwise.
2188 """
2189 from autotest_lib.client.cros.graphics import graphics_utils
2190 from autotest_lib.client.common_lib import utils as common_utils
2191
2192 def __system_output(cmd):
2193 return self.run(cmd).stdout
2194
2195 def __read_file(remote_path):
2196 return self.run('cat %s' % remote_path).stdout
2197
2198 # Hijack the necessary client functions so that we can take advantage
2199 # of the client lib here.
2200 # FIXME: find a less hacky way than this
2201 original_system_output = utils.system_output
2202 original_read_file = common_utils.read_file
2203 utils.system_output = __system_output
2204 common_utils.read_file = __read_file
2205 try:
2206 return ('internal_display' if graphics_utils.has_internal_display()
2207 else None)
2208 finally:
2209 utils.system_output = original_system_output
2210 common_utils.read_file = original_read_file
2211
2212
Dan Shi85276d42014-04-08 22:11:45 -07002213 def is_boot_from_usb(self):
2214 """Check if DUT is boot from USB.
2215
2216 @return: True if DUT is boot from usb.
2217 """
2218 device = self.run('rootdev -s -d').stdout.strip()
2219 removable = int(self.run('cat /sys/block/%s/removable' %
2220 os.path.basename(device)).stdout.strip())
2221 return removable == 1
Helen Zhang17dae2b2014-11-11 09:25:52 -08002222
2223
2224 def read_from_meminfo(self, key):
Dan Shi49ca0932014-11-14 11:22:27 -08002225 """Return the memory info from /proc/meminfo
Helen Zhang17dae2b2014-11-11 09:25:52 -08002226
2227 @param key: meminfo requested
2228
2229 @return the memory value as a string
2230
2231 """
Helen Zhang17dae2b2014-11-11 09:25:52 -08002232 meminfo = self.run('grep %s /proc/meminfo' % key).stdout.strip()
2233 logging.debug('%s', meminfo)
2234 return int(re.search(r'\d+', meminfo).group(0))
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002235
2236
Rohit Makasana98e696f2016-06-03 18:48:10 -07002237 def get_cpu_arch(self):
2238 """Returns CPU arch of the device.
2239
2240 @return CPU architecture of the DUT.
2241 """
Allen Li2c32d6b2017-02-03 15:28:10 -08002242 # Add CPUs by following logic in client/bin/utils.py.
Rohit Makasana98e696f2016-06-03 18:48:10 -07002243 if self.run("grep '^flags.*:.* lm .*' /proc/cpuinfo",
2244 ignore_status=True).stdout:
2245 return 'x86_64'
2246 if self.run("grep -Ei 'ARM|CPU implementer' /proc/cpuinfo",
2247 ignore_status=True).stdout:
2248 return 'arm'
2249 return 'i386'
2250
2251
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002252 def get_board_type(self):
2253 """
2254 Get the DUT's device type from /etc/lsb-release.
Danny Chan471a8d12015-08-18 14:57:41 -07002255 DEVICETYPE can be one of CHROMEBOX, CHROMEBASE, CHROMEBOOK or more.
2256
2257 @return value of DEVICETYPE param from lsb-release.
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002258 """
Danny Chan471a8d12015-08-18 14:57:41 -07002259 device_type = self.run('grep DEVICETYPE /etc/lsb-release',
2260 ignore_status=True).stdout
2261 if device_type:
Kalin Stoyanov524310b2015-08-21 16:24:04 -07002262 return device_type.split('=')[-1].strip()
Danny Chan471a8d12015-08-18 14:57:41 -07002263 return ''
Gilad Arnolda76bef02015-09-29 13:55:15 -07002264
2265
Rohit Makasanadf0a3a32017-06-30 13:55:18 -07002266 def get_arc_version(self):
2267 """Return ARC version installed on the DUT.
2268
2269 @returns ARC version as string if the CrOS build has ARC, else None.
2270 """
2271 arc_version = self.run('grep CHROMEOS_ARC_VERSION /etc/lsb-release',
2272 ignore_status=True).stdout
2273 if arc_version:
2274 return arc_version.split('=')[-1].strip()
2275 return None
2276
2277
Gilad Arnolda76bef02015-09-29 13:55:15 -07002278 def get_os_type(self):
2279 return 'cros'
Simran Basia5522a32015-10-06 11:01:24 -07002280
2281
Kevin Chenga2619dc2016-03-28 11:42:08 -07002282 def get_labels(self):
Kevin Chengf8660142016-08-12 10:17:41 -07002283 """Return the detected labels on the host."""
Kevin Chenga2619dc2016-03-28 11:42:08 -07002284 return self.labels.get_labels(self)
Garry Wang5e5538a2019-04-08 15:36:18 -07002285
2286
2287 def get_default_power_method(self):
2288 """
2289 Get the default power method for power_on/off/cycle() methods.
2290 @return POWER_CONTROL_RPM or POWER_CONTROL_CCD
2291 """
2292 if not self._default_power_method:
Garry Wang1a004aa2019-05-16 22:56:51 -07002293 self._default_power_method = self.POWER_CONTROL_RPM
Ruben Rodriguez Buchillon3eeeab32019-10-02 15:29:58 -07002294 if self.servo and self.servo.supports_built_in_pd_control():
2295 self._default_power_method = self.POWER_CONTROL_CCD
2296 else:
2297 logging.debug('Either servo is unitialized or the servo '
2298 'setup does not support pd controls. Falling '
2299 'back to default RPM method.')
Garry Wang5e5538a2019-04-08 15:36:18 -07002300 return self._default_power_method
Puthikorn Voravootivat4a054792019-12-13 16:44:17 -08002301
2302
2303 def find_usb_devices(self, idVendor, idProduct):
2304 """
2305 Get usb device sysfs name for specific device.
2306
2307 @param idVendor Vendor ID to search in sysfs directory.
2308 @param idProduct Product ID to search in sysfs directory.
2309
2310 @return Usb node names in /sys/bus/usb/drivers/usb/ that match.
2311 """
2312 # Look for matching file and cut at position 7 to get dir name.
2313 grep_cmd = 'grep {} /sys/bus/usb/drivers/usb/*/{} | cut -f 7 -d /'
2314
2315 vendor_cmd = grep_cmd.format(idVendor, 'idVendor')
2316 product_cmd = grep_cmd.format(idProduct, 'idProduct')
2317
2318 # Use uniq -d to print duplicate line from both command
2319 cmd = 'sort <({}) <({}) | uniq -d'.format(vendor_cmd, product_cmd)
2320
2321 return self.run(cmd, ignore_status=True).stdout.strip().split('\n')
2322
2323
2324 def bind_usb_device(self, usb_node):
2325 """
2326 Bind usb device
2327
2328 @param usb_node Node name in /sys/bus/usb/drivers/usb/
2329 """
2330 cmd = 'echo {} > /sys/bus/usb/drivers/usb/bind'.format(usb_node)
2331 self.run(cmd, ignore_status=True)
2332
2333
2334 def unbind_usb_device(self, usb_node):
2335 """
2336 Unbind usb device
2337
2338 @param usb_node Node name in /sys/bus/usb/drivers/usb/
2339 """
2340 cmd = 'echo {} > /sys/bus/usb/drivers/usb/unbind'.format(usb_node)
2341 self.run(cmd, ignore_status=True)
2342
2343
2344 def get_wlan_ip(self):
2345 """
2346 Get ip address of wlan interface.
2347
2348 @return ip address of wlan or empty string if wlan is not connected.
2349 """
2350 cmds = [
2351 'iw dev', # List wlan physical device
2352 'grep Interface', # Grep only interface name
2353 'cut -f 2 -d" "', # Cut the name part
2354 'xargs ifconfig', # Feed it to ifconfig to get ip
2355 'grep -oE "inet [0-9.]+"', # Grep only ipv4
2356 'cut -f 2 -d " "' # Cut the ip part
2357 ]
2358 return self.run(' | '.join(cmds), ignore_status=True).stdout.strip()
Puthikorn Voravootivatcd0dc9e2020-01-22 14:22:22 -08002359
2360 def connect_to_wifi(self, ssid, passphrase=None, security=None):
2361 """
2362 Connect to wifi network
2363
2364 @param ssid SSID of the wifi network.
2365 @param passphrase Passphrase of the wifi network. None if not existed.
2366 @param security Security of the wifi network. Default to "psk" if
2367 passphase is given without security. Possible values
2368 are "none", "psk", "802_1x".
2369
2370 @return True if succeed, False if not.
2371 """
2372 cmd = '/usr/local/autotest/cros/scripts/wifi connect ' + ssid
2373 if passphrase:
2374 cmd += ' ' + passphrase
2375 if security:
2376 cmd += ' ' + security
2377 return self.run(cmd, ignore_status=True).exit_status == 0