blob: ea9da444b7b923905ebe79cb4f27a714824c9386 [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
Garry Wang11b5e872020-03-11 15:14:08 -070035from autotest_lib.server.hosts import servo_constants
Simran Basidcff4252012-11-20 16:13:20 -080036from autotest_lib.site_utils.rpm_control_system import rpm_client
Simran Basid5e5e272012-09-24 15:23:59 -070037
Simran Basi382506b2016-09-13 14:58:15 -070038# In case cros_host is being ran via SSP on an older Moblab version with an
39# older chromite version.
40try:
41 from chromite.lib import metrics
Dan Shi5e2efb72017-02-07 11:40:23 -080042except ImportError:
Congbin Guo42427612019-02-12 10:22:06 -080043 metrics = utils.metrics_mock
Dan Shi5e2efb72017-02-07 11:40:23 -080044
Simran Basid5e5e272012-09-24 15:23:59 -070045
Dan Shib8540a52015-07-16 14:18:23 -070046CONFIG = global_config.global_config
47
Dan Shid07ee2e2015-09-24 14:49:25 -070048
beepsc87ff602013-07-31 21:53:00 -070049class FactoryImageCheckerException(error.AutoservError):
50 """Exception raised when an image is a factory image."""
51 pass
52
53
Fang Deng0ca40e22013-08-27 17:47:44 -070054class CrosHost(abstract_ssh.AbstractSSHHost):
J. Richard Barnette45e93de2012-04-11 17:24:15 -070055 """Chromium OS specific subclass of Host."""
56
Simran Basi5ace6f22016-01-06 17:30:44 -080057 VERSION_PREFIX = provision.CROS_VERSION_PREFIX
58
Scott Zawalski62bacae2013-03-05 10:40:32 -050059 _AFE = frontend_wrappers.RetryingAFE(timeout_min=5, delay_sec=10)
J. Richard Barnette45e93de2012-04-11 17:24:15 -070060
Richard Barnette03a0c132012-11-05 12:40:35 -080061 # Timeout values (in seconds) associated with various Chrome OS
62 # state changes.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -070063 #
Richard Barnette0c73ffc2012-11-19 15:21:18 -080064 # In general, a good rule of thumb is that the timeout can be up
65 # to twice the typical measured value on the slowest platform.
66 # The times here have not necessarily been empirically tested to
67 # meet this criterion.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070068 #
69 # SLEEP_TIMEOUT: Time to allow for suspend to memory.
Richard Barnette0c73ffc2012-11-19 15:21:18 -080070 # RESUME_TIMEOUT: Time to allow for resume after suspend, plus
71 # time to restart the netwowrk.
J. Richard Barnette84890bd2014-02-21 11:05:47 -080072 # SHUTDOWN_TIMEOUT: Time to allow for shut down.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070073 # BOOT_TIMEOUT: Time to allow for boot from power off. Among
Richard Barnette0c73ffc2012-11-19 15:21:18 -080074 # other things, this must account for the 30 second dev-mode
J. Richard Barnette417cc792015-10-01 09:56:36 -070075 # screen delay, time to start the network on the DUT, and the
76 # ssh timeout of 120 seconds.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070077 # USB_BOOT_TIMEOUT: Time to allow for boot from a USB device,
Richard Barnette0c73ffc2012-11-19 15:21:18 -080078 # including the 30 second dev-mode delay and time to start the
J. Richard Barnetted4649c62013-03-06 17:42:27 -080079 # network.
beepsf079cfb2013-09-18 17:49:51 -070080 # INSTALL_TIMEOUT: Time to allow for chromeos-install.
J. Richard Barnette84890bd2014-02-21 11:05:47 -080081 # POWERWASH_BOOT_TIMEOUT: Time to allow for a reboot that
82 # includes powerwash.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070083
84 SLEEP_TIMEOUT = 2
J. Richard Barnetted4649c62013-03-06 17:42:27 -080085 RESUME_TIMEOUT = 10
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +080086 SHUTDOWN_TIMEOUT = 10
J. Richard Barnette417cc792015-10-01 09:56:36 -070087 BOOT_TIMEOUT = 150
J. Richard Barnette5bab5f52015-08-03 13:14:38 -070088 USB_BOOT_TIMEOUT = 300
J. Richard Barnette7817b052014-08-28 09:47:29 -070089 INSTALL_TIMEOUT = 480
Dan Shi2c88eed2013-11-12 10:18:38 -080090 POWERWASH_BOOT_TIMEOUT = 60
Chris Sosab76e0ee2013-05-22 16:55:41 -070091
Dan Shica503482015-03-30 17:23:25 -070092 # Minimum OS version that supports server side packaging. Older builds may
93 # not have server side package built or with Autotest code change to support
94 # server-side packaging.
Dan Shib8540a52015-07-16 14:18:23 -070095 MIN_VERSION_SUPPORT_SSP = CONFIG.get_config_value(
Dan Shiced09e42015-04-17 16:09:34 -070096 'AUTOSERV', 'min_version_support_ssp', type=int)
Dan Shica503482015-03-30 17:23:25 -070097
J. Richard Barnette84890bd2014-02-21 11:05:47 -080098 # REBOOT_TIMEOUT: How long to wait for a reboot.
99 #
Chris Sosab76e0ee2013-05-22 16:55:41 -0700100 # We have a long timeout to ensure we don't flakily fail due to other
101 # issues. Shorter timeouts are vetted in platform_RebootAfterUpdate.
Simran Basi1160e2c2013-10-04 16:00:24 -0700102 # TODO(sbasi - crbug.com/276094) Restore to 5 mins once the 'host did not
103 # return from reboot' bug is solved.
104 REBOOT_TIMEOUT = 480
Chris Sosab76e0ee2013-05-22 16:55:41 -0700105
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800106 # _USB_POWER_TIMEOUT: Time to allow for USB to power toggle ON and OFF.
107 # _POWER_CYCLE_TIMEOUT: Time to allow for manual power cycle.
Garry Wang5e5538a2019-04-08 15:36:18 -0700108 # _CHANGE_SERVO_ROLE_TIMEOUT: Time to allow DUT regain network connection
109 # since changing servo role will reset USB state
110 # and causes temporary ethernet drop.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800111 _USB_POWER_TIMEOUT = 5
112 _POWER_CYCLE_TIMEOUT = 10
Garry Wang5e5538a2019-04-08 15:36:18 -0700113 _CHANGE_SERVO_ROLE_TIMEOUT = 180
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800114
Fang Dengdeba14f2014-11-14 11:54:09 -0800115 _RPM_HOSTNAME_REGEX = ('chromeos(\d+)(-row(\d+))?-rack(\d+[a-z]*)'
116 '-host(\d+)')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -0700117
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -0800118 # Constants used in ping_wait_up() and ping_wait_down().
119 #
120 # _PING_WAIT_COUNT is the approximate number of polling
121 # cycles to use when waiting for a host state change.
122 #
123 # _PING_STATUS_DOWN and _PING_STATUS_UP are names used
124 # for arguments to the internal _ping_wait_for_status()
125 # method.
126 _PING_WAIT_COUNT = 40
127 _PING_STATUS_DOWN = False
128 _PING_STATUS_UP = True
129
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800130 # Allowed values for the power_method argument.
131
Garry Wang5e5538a2019-04-08 15:36:18 -0700132 # POWER_CONTROL_RPM: Used in power_off/on/cycle() methods, default for all
133 # DUTs except those with servo_v4 CCD.
134 # POWER_CONTROL_CCD: Used in power_off/on/cycle() methods, default for all
135 # DUTs with servo_v4 CCD.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800136 # POWER_CONTROL_SERVO: Used in set_power() and power_cycle() methods.
137 # POWER_CONTROL_MANUAL: Used in set_power() and power_cycle() methods.
138 POWER_CONTROL_RPM = 'RPM'
Garry Wang5e5538a2019-04-08 15:36:18 -0700139 POWER_CONTROL_CCD = 'CCD'
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800140 POWER_CONTROL_SERVO = 'servoj10'
141 POWER_CONTROL_MANUAL = 'manual'
142
143 POWER_CONTROL_VALID_ARGS = (POWER_CONTROL_RPM,
Garry Wang5e5538a2019-04-08 15:36:18 -0700144 POWER_CONTROL_CCD,
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800145 POWER_CONTROL_SERVO,
146 POWER_CONTROL_MANUAL)
Richard Barnette0c73ffc2012-11-19 15:21:18 -0800147
Simran Basi5e6339a2013-03-21 11:34:32 -0700148 _RPM_OUTLET_CHANGED = 'outlet_changed'
149
Dan Shi9cb0eec2014-06-03 09:04:50 -0700150 # URL pattern to download firmware image.
Dan Shib8540a52015-07-16 14:18:23 -0700151 _FW_IMAGE_URL_PATTERN = CONFIG.get_config_value(
Dan Shi9cb0eec2014-06-03 09:04:50 -0700152 'CROS', 'firmware_url_pattern', type=str)
beeps687243d2013-07-18 15:29:27 -0700153
Brent Peterson1cb623a2020-01-09 13:14:28 -0800154 # Regular expression for extracting EC version string
155 _EC_REGEX = '(%s_\w*[-\.]\w*[-\.]\w*[-\.]\w*)'
156
157 # Regular expression for extracting BIOS version string
158 _BIOS_REGEX = '(%s\.\w*\.\w*\.\w*)'
159
Brent Petersonc70a1832020-01-24 15:54:35 -0800160 # Command to update firmware located on DUT
Brent Peterson669edf42020-02-07 15:07:54 -0800161 _FW_UPDATE_CMD = 'chromeos-firmwareupdate --mode=recovery -i %s %s'
Brent Petersonc70a1832020-01-24 15:54:35 -0800162
J. Richard Barnette964fba02012-10-24 17:34:29 -0700163 @staticmethod
beeps46dadc92013-11-07 14:07:10 -0800164 def check_host(host, timeout=10):
165 """
166 Check if the given host is a chrome-os host.
167
168 @param host: An ssh host representing a device.
169 @param timeout: The timeout for the run command.
170
171 @return: True if the host device is chromeos.
172
beeps46dadc92013-11-07 14:07:10 -0800173 """
174 try:
Allen Liad719c12017-06-27 23:48:04 +0000175 result = host.run(
Simran Basi933c8af2015-04-29 14:05:07 -0700176 'grep -q CHROMEOS /etc/lsb-release && '
Garry Wange4b6d6e2019-06-17 17:08:46 -0700177 '! grep -q moblab /etc/lsb-release && '
178 '! grep -q labstation /etc/lsb-release',
Simran Basi933c8af2015-04-29 14:05:07 -0700179 ignore_status=True, timeout=timeout)
Laurence Goodby468de252017-06-08 17:22:53 -0700180 if result.exit_status == 0:
Allen Liad719c12017-06-27 23:48:04 +0000181 lsb_release_content = host.run(
Laurence Goodby468de252017-06-08 17:22:53 -0700182 'grep CHROMEOS_RELEASE_BOARD /etc/lsb-release',
183 timeout=timeout).stdout
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -0800184 return not (
185 lsbrelease_utils.is_jetstream(
186 lsb_release_content=lsb_release_content) or
187 lsbrelease_utils.is_gce_board(
188 lsb_release_content=lsb_release_content))
189
beeps46dadc92013-11-07 14:07:10 -0800190 except (error.AutoservRunError, error.AutoservSSHTimeout):
191 return False
Laurence Goodby468de252017-06-08 17:22:53 -0700192
193 return False
beeps46dadc92013-11-07 14:07:10 -0800194
195
196 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800197 def get_chameleon_arguments(args_dict):
198 """Extract chameleon options from `args_dict` and return the result.
199
200 Recommended usage:
201 ~~~~~~~~
202 args_dict = utils.args_to_dict(args)
203 chameleon_args = hosts.CrosHost.get_chameleon_arguments(args_dict)
204 host = hosts.create_host(machine, chameleon_args=chameleon_args)
205 ~~~~~~~~
206
207 @param args_dict Dictionary from which to extract the chameleon
208 arguments.
209 """
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800210 return {key: args_dict[key]
Allen Li083866b2016-08-18 10:07:10 -0700211 for key in ('chameleon_host', 'chameleon_port')
212 if key in args_dict}
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800213
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800214 @staticmethod
215 def get_btpeer_arguments(args_dict):
216 """Extract btpeer options from `args_dict` and return the result.
217
218 This is used to parse details of Bluetooth peer.
219 Recommended usage:
220 ~~~~~~~~
221 args_dict = utils.args_to_dict(args)
222 btpeer_args = hosts.CrosHost.get_btpeer_arguments(args_dict)
223 host = hosts.create_host(machine)
224 host.initialize_btpeer(btpeer_args)
225 ~~~~~~~~
226
227 @param args_dict: Dictionary from which to extract the btpeer
228 arguments.
229 """
230 if 'btpeer_host_list' in args_dict:
231 result = []
232 for btpeer in args_dict['btpeer_host_list'].split(','):
233 result.append({key: value for key,value in
234 zip(('btpeer_host','btpeer_port'),
235 btpeer.split(':'))})
236 return result
237 else:
238 return {key: args_dict[key]
239 for key in ('btpeer_host', 'btpeer_port')
240 if key in args_dict}
241
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800242
243 @staticmethod
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700244 def get_pdtester_arguments(args_dict):
Scottfe06ed82015-11-05 17:15:01 -0800245 """Extract chameleon options from `args_dict` and return the result.
246
247 Recommended usage:
248 ~~~~~~~~
249 args_dict = utils.args_to_dict(args)
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700250 pdtester_args = hosts.CrosHost.get_pdtester_arguments(args_dict)
251 host = hosts.create_host(machine, pdtester_args=pdtester_args)
Scottfe06ed82015-11-05 17:15:01 -0800252 ~~~~~~~~
253
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700254 @param args_dict Dictionary from which to extract the pdtester
Scottfe06ed82015-11-05 17:15:01 -0800255 arguments.
256 """
Allen Li083866b2016-08-18 10:07:10 -0700257 return {key: args_dict[key]
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700258 for key in ('pdtester_host', 'pdtester_port')
Allen Li083866b2016-08-18 10:07:10 -0700259 if key in args_dict}
Scottfe06ed82015-11-05 17:15:01 -0800260
261
262 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800263 def get_servo_arguments(args_dict):
264 """Extract servo options from `args_dict` and return the result.
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800265
266 Recommended usage:
267 ~~~~~~~~
268 args_dict = utils.args_to_dict(args)
Fang Deng0ca40e22013-08-27 17:47:44 -0700269 servo_args = hosts.CrosHost.get_servo_arguments(args_dict)
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800270 host = hosts.create_host(machine, servo_args=servo_args)
271 ~~~~~~~~
272
273 @param args_dict Dictionary from which to extract the servo
274 arguments.
275 """
Garry Wang11b5e872020-03-11 15:14:08 -0700276 servo_attrs = (servo_constants.SERVO_HOST_ATTR,
277 servo_constants.SERVO_PORT_ATTR,
278 servo_constants.SERVO_BOARD_ATTR,
279 servo_constants.SERVO_MODEL_ATTR)
Armando Miraglia2ac802e2017-08-15 14:54:47 +0200280 servo_args = {key: args_dict[key]
281 for key in servo_attrs
282 if key in args_dict}
283 return (
284 None
Garry Wang11b5e872020-03-11 15:14:08 -0700285 if servo_constants.SERVO_HOST_ATTR in servo_args
286 and not servo_args[servo_constants.SERVO_HOST_ATTR]
Armando Miraglia2ac802e2017-08-15 14:54:47 +0200287 else servo_args)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -0700288
J. Richard Barnette964fba02012-10-24 17:34:29 -0700289
J. Richard Barnette91137f02016-03-10 16:52:26 -0800290 def _initialize(self, hostname, chameleon_args=None, servo_args=None,
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700291 pdtester_args=None, try_lab_servo=False,
Richard Barnette9a26ad62016-06-10 12:03:08 -0700292 try_servo_repair=False,
J. Richard Barnette91137f02016-03-10 16:52:26 -0800293 ssh_verbosity_flag='', ssh_options='',
Fang Dengd1c2b732013-08-20 12:59:46 -0700294 *args, **dargs):
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800295 """Initialize superclasses, |self.chameleon|, and |self.servo|.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700296
Fang Denge545abb2014-12-30 18:43:47 -0800297 This method will attempt to create the test-assistant object
298 (chameleon/servo) when it is needed by the test. Check
299 the docstring of chameleon_host.create_chameleon_host and
300 servo_host.create_servo_host for how this is determined.
Fang Deng5d518f42013-08-02 14:04:32 -0700301
Fang Denge545abb2014-12-30 18:43:47 -0800302 @param hostname: Hostname of the dut.
303 @param chameleon_args: A dictionary that contains args for creating
304 a ChameleonHost. See chameleon_host for details.
305 @param servo_args: A dictionary that contains args for creating
306 a ServoHost object. See servo_host for details.
Richard Barnette9a26ad62016-06-10 12:03:08 -0700307 @param try_lab_servo: When true, indicates that an attempt should
308 be made to create a ServoHost for a DUT in
309 the test lab, even if not required by
310 `servo_args`. See servo_host for details.
311 @param try_servo_repair: If a servo host is created, check it
312 with `repair()` rather than `verify()`.
Fang Denge545abb2014-12-30 18:43:47 -0800313 See servo_host for details.
314 @param ssh_verbosity_flag: String, to pass to the ssh command to control
315 verbosity.
316 @param ssh_options: String, other ssh options to pass to the ssh
317 command.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700318 """
Fang Deng0ca40e22013-08-27 17:47:44 -0700319 super(CrosHost, self)._initialize(hostname=hostname,
J. Richard Barnette45e93de2012-04-11 17:24:15 -0700320 *args, **dargs)
J. Richard Barnette91137f02016-03-10 16:52:26 -0800321 self._repair_strategy = cros_repair.create_cros_repair_strategy()
Kevin Chenga2619dc2016-03-28 11:42:08 -0700322 self.labels = base_label.LabelRetriever(cros_label.CROS_LABELS)
J. Richard Barnettef0859852012-08-20 14:55:50 -0700323 # self.env is a dictionary of environment variable settings
324 # to be exported for commands run on the host.
325 # LIBC_FATAL_STDERR_ can be useful for diagnosing certain
326 # errors that might happen.
327 self.env['LIBC_FATAL_STDERR_'] = '1'
Fang Dengd1c2b732013-08-20 12:59:46 -0700328 self._ssh_verbosity_flag = ssh_verbosity_flag
Aviv Keshetc5947fa2013-09-04 14:06:29 -0700329 self._ssh_options = ssh_options
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700330 _servo_host, servo_state = servo_host.create_servo_host(
331 dut=self,
332 servo_args=servo_args,
333 try_lab_servo=try_lab_servo,
334 try_servo_repair=try_servo_repair,
335 dut_host_info=self.host_info_store.get())
336 self.set_servo_host(_servo_host, servo_state)
Garry Wang5e5538a2019-04-08 15:36:18 -0700337 self._default_power_method = None
Richard Barnettee519dcd2016-08-15 17:37:17 -0700338
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800339 # TODO(waihong): Do the simplication on Chameleon too.
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800340 self._chameleon_host = chameleon_host.create_chameleon_host(
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700341 dut=self.hostname,
342 chameleon_args=chameleon_args)
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800343 if self._chameleon_host:
344 self.chameleon = self._chameleon_host.create_chameleon_board()
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800345 else:
Tom Wai-Hong Tam3d6790d2014-04-14 16:15:47 +0800346 self.chameleon = None
Fang Deng5d518f42013-08-02 14:04:32 -0700347
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800348 # Bluetooth peers. These will be initialized by test if required.
349 self._btpeer_host_list = []
350 self.btpeer_list = []
351 self.btpeer = None
352
howardchung83e55272019-08-08 14:08:05 +0800353 # Add pdtester host if pdtester args were added on command line
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -0700354 self._pdtester_host = pdtester_host.create_pdtester_host(
Wai-Hong Tam90b164d2019-10-25 13:15:39 -0700355 pdtester_args, self._servo_host)
howardchung83e55272019-08-08 14:08:05 +0800356
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700357 if self._pdtester_host:
358 self.pdtester_servo = self._pdtester_host.get_servo()
359 logging.info('pdtester_servo: %r', self.pdtester_servo)
360 # Create the pdtester object used to access the ec uart
361 self.pdtester = pdtester.PDTester(self.pdtester_servo,
362 self._pdtester_host.get_servod_server_proxy())
Scottfe06ed82015-11-05 17:15:01 -0800363 else:
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700364 self.pdtester = None
Scottfe06ed82015-11-05 17:15:01 -0800365
Fang Deng5d518f42013-08-02 14:04:32 -0700366
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800367 def initialize_btpeer(self, btpeer_args):
368 """ Initialize the Bluetooth peers
369
370 Initialize Bluetooth peer devices given in the arguments. Bluetooth peer
371 is chameleon host on Raspberry Pi.
372 @param btpeer_args: A dictionary that contains args for creating
373 a ChameleonHost. See chameleon_host for details.
374
375 """
376
377 if type(btpeer_args) is list:
378 btpeer_args_list = btpeer_args
379 else:
380 btpeer_args_list = [btpeer_args]
381
382 self._btpeer_host_list = chameleon_host.create_btpeer_host(
383 dut=self.hostname, btpeer_args_list=btpeer_args_list)
384 logging.debug('Bluetooth peer hosts are %s', self._btpeer_host_list)
385 self.btpeer_list = [_host.create_chameleon_board() for _host in
386 self._btpeer_host_list if _host is not None]
387
388 if len(self.btpeer_list) > 0:
389 self.btpeer = self.btpeer_list[0]
390 else:
391 self.btpeer = None
392
393 logging.debug('After initialize_btpeer btpeer_list %s btpeer_host_list'
394 'is %s and btpeer is %s',self.btpeer_list,
395 self._btpeer_host_list, self.btpeer)
396
397
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000398 def get_cros_repair_image_name(self):
Ruben Rodriguez Buchilloncee72f72019-05-01 13:20:58 -0700399 """Get latest stable cros image name from AFE.
400
401 Use the board name from the info store. Should that fail, try to
402 retrieve the board name from the host's installed image itself.
403
404 @returns: current stable cros image name for this host.
405 """
406 board = self.host_info_store.get().board
407 if not board:
408 logging.warn('No board label value found. Trying to infer '
409 'from the host itself.')
410 try:
411 board = self.get_board().split(':')[1]
412 except (error.AutoservRunError, error.AutoservSSHTimeout) as e:
413 logging.error('Also failed to get the board name from the DUT '
414 'itself. %s.', str(e))
415 raise error.AutoservError('Cannot obtain repair image name.')
Gregory Nisbet7fe11c22019-11-22 11:06:06 -0800416 return afe_utils.get_stable_cros_image_name_v2(self.host_info_store.get())
Scott Zawalski89c44dd2013-02-26 09:28:02 -0500417
418
Rohit Makasanadf0a3a32017-06-30 13:55:18 -0700419 def host_version_prefix(self, image):
420 """Return version label prefix.
421
422 In case the CrOS provisioning version is something other than the
423 standard CrOS version e.g. CrOS TH version, this function will
424 find the prefix from provision.py.
425
426 @param image: The image name to find its version prefix.
427 @returns: A prefix string for the image type.
428 """
429 return provision.get_version_label_prefix(image)
430
431
beepsdae65fd2013-07-26 16:24:41 -0700432 def verify_job_repo_url(self, tag=''):
beepscb6f1e22013-06-28 19:14:10 -0700433 """
434 Make sure job_repo_url of this host is valid.
435
joychen03eaad92013-06-26 09:55:21 -0700436 Eg: The job_repo_url "http://lmn.cd.ab.xyx:8080/static/\
beepscb6f1e22013-06-28 19:14:10 -0700437 lumpy-release/R29-4279.0.0/autotest/packages" claims to have the
438 autotest package for lumpy-release/R29-4279.0.0. If this isn't the case,
439 download and extract it. If the devserver embedded in the url is
440 unresponsive, update the job_repo_url of the host after staging it on
441 another devserver.
442
443 @param job_repo_url: A url pointing to the devserver where the autotest
444 package for this build should be staged.
beepsdae65fd2013-07-26 16:24:41 -0700445 @param tag: The tag from the server job, in the format
446 <job_id>-<user>/<hostname>, or <hostless> for a server job.
beepscb6f1e22013-06-28 19:14:10 -0700447
448 @raises DevServerException: If we could not resolve a devserver.
449 @raises AutoservError: If we're unable to save the new job_repo_url as
450 a result of choosing a new devserver because the old one failed to
451 respond to a health check.
beeps0c865032013-07-30 11:37:06 -0700452 @raises urllib2.URLError: If the devserver embedded in job_repo_url
453 doesn't respond within the timeout.
beepscb6f1e22013-06-28 19:14:10 -0700454 """
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800455 info = self.host_info_store.get()
456 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
beepscb6f1e22013-06-28 19:14:10 -0700457 if not job_repo_url:
458 logging.warning('No job repo url set on host %s', self.hostname)
459 return
460
461 logging.info('Verifying job repo url %s', job_repo_url)
462 devserver_url, image_name = tools.get_devserver_build_from_package_url(
463 job_repo_url)
464
beeps0c865032013-07-30 11:37:06 -0700465 ds = dev_server.ImageServer(devserver_url)
beepscb6f1e22013-06-28 19:14:10 -0700466
467 logging.info('Staging autotest artifacts for %s on devserver %s',
468 image_name, ds.url())
beeps687243d2013-07-18 15:29:27 -0700469
470 start_time = time.time()
Simran Basi25e7a922014-10-31 11:56:10 -0700471 ds.stage_artifacts(image_name, ['autotest_packages'])
beeps687243d2013-07-18 15:29:27 -0700472 stage_time = time.time() - start_time
473
474 # Record how much of the verification time comes from a devserver
475 # restage. If we're doing things right we should not see multiple
476 # devservers for a given board/build/branch path.
477 try:
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800478 board, build_type, branch = server_utils.ParseBuildName(
beeps687243d2013-07-18 15:29:27 -0700479 image_name)[:3]
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800480 except server_utils.ParseBuildNameException:
beeps687243d2013-07-18 15:29:27 -0700481 pass
482 else:
beeps0c865032013-07-30 11:37:06 -0700483 devserver = devserver_url[
Chris Sosa65425082013-10-16 13:26:22 -0700484 devserver_url.find('/') + 2:devserver_url.rfind(':')]
beeps687243d2013-07-18 15:29:27 -0700485 stats_key = {
486 'board': board,
487 'build_type': build_type,
488 'branch': branch,
beeps0c865032013-07-30 11:37:06 -0700489 'devserver': devserver.replace('.', '_'),
beeps687243d2013-07-18 15:29:27 -0700490 }
Dan Shi5e2efb72017-02-07 11:40:23 -0800491
492 monarch_fields = {
493 'board': board,
494 'build_type': build_type,
Dan Shi5e2efb72017-02-07 11:40:23 -0800495 'branch': branch,
496 'dev_server': devserver,
497 }
498 metrics.Counter(
499 'chromeos/autotest/provision/verify_url'
500 ).increment(fields=monarch_fields)
501 metrics.SecondsDistribution(
502 'chromeos/autotest/provision/verify_url_duration'
503 ).add(stage_time, fields=monarch_fields)
504
505
Dan Shicf4d2032015-03-12 15:04:21 -0700506 def stage_server_side_package(self, image=None):
507 """Stage autotest server-side package on devserver.
508
509 @param image: Full path of an OS image to install or a build name.
510
511 @return: A url to the autotest server-side package.
Dan Shi14de7622016-08-22 11:09:06 -0700512
513 @raise: error.AutoservError if fail to locate the build to test with, or
514 fail to stage server-side package.
Dan Shicf4d2032015-03-12 15:04:21 -0700515 """
Dan Shid37736b2016-07-06 15:10:29 -0700516 # If enable_drone_in_restricted_subnet is False, do not set hostname
517 # in devserver.resolve call, so a devserver in non-restricted subnet
518 # is picked to stage autotest server package for drone to download.
519 hostname = self.hostname
520 if not server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
521 hostname = None
Dan Shicf4d2032015-03-12 15:04:21 -0700522 if image:
523 image_name = tools.get_build_from_image(image)
524 if not image_name:
525 raise error.AutoservError(
526 'Failed to parse build name from %s' % image)
Dan Shid37736b2016-07-06 15:10:29 -0700527 ds = dev_server.ImageServer.resolve(image_name, hostname)
Dan Shicf4d2032015-03-12 15:04:21 -0700528 else:
Prathmesh Prabhu9235e4c2017-03-28 13:16:06 -0700529 info = self.host_info_store.get()
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800530 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
Dan Shicf4d2032015-03-12 15:04:21 -0700531 if job_repo_url:
532 devserver_url, image_name = (
533 tools.get_devserver_build_from_package_url(job_repo_url))
Dan Shid37736b2016-07-06 15:10:29 -0700534 # If enable_drone_in_restricted_subnet is True, use the
535 # existing devserver. Otherwise, resolve a new one in
536 # non-restricted subnet.
537 if server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
538 ds = dev_server.ImageServer(devserver_url)
539 else:
540 ds = dev_server.ImageServer.resolve(image_name)
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800541 elif info.build is not None:
542 ds = dev_server.ImageServer.resolve(info.build, hostname)
Prathmesh Prabhu0c1dd4d2017-06-07 13:01:53 -0700543 image_name = info.build
Dan Shicf4d2032015-03-12 15:04:21 -0700544 else:
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800545 raise error.AutoservError(
546 'Failed to stage server-side package. The host has '
Garry Wang12b9baf2019-06-24 18:58:54 -0700547 'no job_repo_url attribute or cros-version label.')
Dan Shica503482015-03-30 17:23:25 -0700548
549 # Get the OS version of the build, for any build older than
550 # MIN_VERSION_SUPPORT_SSP, server side packaging is not supported.
551 match = re.match('.*/R\d+-(\d+)\.', image_name)
552 if match and int(match.group(1)) < self.MIN_VERSION_SUPPORT_SSP:
Dan Shi14de7622016-08-22 11:09:06 -0700553 raise error.AutoservError(
554 'Build %s is older than %s. Server side packaging is '
555 'disabled.' % (image_name, self.MIN_VERSION_SUPPORT_SSP))
Dan Shica503482015-03-30 17:23:25 -0700556
Dan Shicf4d2032015-03-12 15:04:21 -0700557 ds.stage_artifacts(image_name, ['autotest_server_package'])
558 return '%s/static/%s/%s' % (ds.url(), image_name,
559 'autotest_server_package.tar.bz2')
560
561
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700562 def stage_image_for_servo(self, image_name=None, artifact='test_image'):
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700563 """Stage a build on a devserver and return the update_url.
564
565 @param image_name: a name like lumpy-release/R27-3837.0.0
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700566 @param artifact: a string like 'test_image'. Requests
567 appropriate image to be staged.
Xixuan Wufee57542019-10-15 11:50:27 -0700568 @returns a tuple of (image_name, URL) like
569 (lumpy-release/R27-3837.0.0,
570 http://172.22.50.205:8082/update/lumpy-release/R27-3837.0.0)
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700571 """
572 if not image_name:
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000573 image_name = self.get_cros_repair_image_name()
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700574 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800575 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700576 devserver.stage_artifacts(image_name, [artifact])
577 if artifact == 'test_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700578 return image_name, devserver.get_test_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700579 elif artifact == 'recovery_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700580 return image_name, devserver.get_recovery_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700581 else:
582 raise error.AutoservError("Bad artifact!")
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700583
584
beepse539be02013-07-31 21:57:39 -0700585 def stage_factory_image_for_servo(self, image_name):
586 """Stage a build on a devserver and return the update_url.
587
588 @param image_name: a name like <baord>/4262.204.0
beeps12c0a3c2013-09-03 11:58:27 -0700589
beepse539be02013-07-31 21:57:39 -0700590 @return: An update URL, eg:
591 http://<devserver>/static/canary-channel/\
592 <board>/4262.204.0/factory_test/chromiumos_factory_image.bin
beeps12c0a3c2013-09-03 11:58:27 -0700593
594 @raises: ValueError if the factory artifact name is missing from
595 the config.
596
beepse539be02013-07-31 21:57:39 -0700597 """
598 if not image_name:
599 logging.error('Need an image_name to stage a factory image.')
600 return
601
Dan Shib8540a52015-07-16 14:18:23 -0700602 factory_artifact = CONFIG.get_config_value(
beeps12c0a3c2013-09-03 11:58:27 -0700603 'CROS', 'factory_artifact', type=str, default='')
604 if not factory_artifact:
605 raise ValueError('Cannot retrieve the factory artifact name from '
606 'autotest config, and hence cannot stage factory '
607 'artifacts.')
608
beepse539be02013-07-31 21:57:39 -0700609 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800610 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
beepse539be02013-07-31 21:57:39 -0700611 devserver.stage_artifacts(
612 image_name,
beeps12c0a3c2013-09-03 11:58:27 -0700613 [factory_artifact],
614 archive_url=None)
beepse539be02013-07-31 21:57:39 -0700615
616 return tools.factory_image_url_pattern() % (devserver.url(), image_name)
617
618
Laurence Goodby778c9a42017-05-24 19:24:07 -0700619 def prepare_for_update(self):
620 """Prepares the DUT for an update.
621
622 Subclasses may override this to perform any special actions
623 required before updating.
624 """
Laurence Goodby468de252017-06-08 17:22:53 -0700625 pass
Laurence Goodby778c9a42017-05-24 19:24:07 -0700626
627
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800628 def _clear_fw_version_labels(self, rw_only):
629 """Clear firmware version labels from the machine.
630
631 @param rw_only: True to only clear fwrw_version; otherewise, clear
632 both fwro_version and fwrw_version.
633 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700634 info = self.host_info_store.get()
635 info.clear_version_labels(provision.FW_RW_VERSION_PREFIX)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800636 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700637 info.clear_version_labels(provision.FW_RO_VERSION_PREFIX)
638 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700639
640
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800641 def _add_fw_version_label(self, build, rw_only):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700642 """Add firmware version label to the machine.
643
644 @param build: Build of firmware.
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800645 @param rw_only: True to only add fwrw_version; otherwise, add both
646 fwro_version and fwrw_version.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700647
648 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700649 info = self.host_info_store.get()
650 info.set_version_label(provision.FW_RW_VERSION_PREFIX, build)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800651 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700652 info.set_version_label(provision.FW_RO_VERSION_PREFIX, build)
653 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700654
655
Namyoon Woo5f894662019-11-15 15:23:23 -0800656 def get_latest_release_version(self, board):
657 """Search for the latest package release version from the image archive,
658 and return it.
659
660 @param board: board name
661
662 @return 'firmware-{board}-{branch}-firmwarebranch/{release-version}'
663 or None if LATEST release file does not exist.
664 """
665
666 # This might be in the format of 'baseboard_model',
667 # e.g. octopus_fleex. In that case, board should be just
668 # 'baseboard' to use in search for image package, e.g. octopus.
669 board = board.split('_')[0]
670
671 # Read 'LATEST-1.0.0' file
672 branch_dir = provision.FW_BRANCH_GLOB % board
673 latest_file = os.path.join(provision.CROS_IMAGE_ARCHIVE, branch_dir,
674 'LATEST-1.0.0')
Namyoon Woo5f894662019-11-15 15:23:23 -0800675
Namyoon Woo406c7d42020-01-24 15:57:11 -0800676 try:
677 # The result could be one or more.
678 result = utils.system_output('gsutil ls -d ' + latest_file)
679
680 candidates = re.findall('gs://.*', result)
Namyoon Woo5f894662019-11-15 15:23:23 -0800681 except error.CmdError:
682 logging.error('No LATEST release info is available.')
683 return None
684
Namyoon Woo406c7d42020-01-24 15:57:11 -0800685 for cand_dir in candidates:
686 result = utils.system_output('gsutil cat ' + cand_dir)
Namyoon Woo5f894662019-11-15 15:23:23 -0800687
Namyoon Woo406c7d42020-01-24 15:57:11 -0800688 release_path = cand_dir.replace('LATEST-1.0.0', result)
689 release_path = os.path.join(release_path, board)
690 try:
691 # Check if release_path does exist.
692 release = utils.system_output('gsutil ls -d ' + release_path)
693 # Now 'release' has a full directory path: e.g.
694 # gs://chromeos-image-archive/firmware-octopus-11297.B-
695 # firmwarebranch/RNone-1.0.0-b4395530/octopus/
696
697 # Remove "gs://chromeos-image-archive".
698 release = release.replace(provision.CROS_IMAGE_ARCHIVE, '')
699
700 # Remove CROS_IMAGE_ARCHIVE and any surrounding '/'s.
701 return release.strip('/')
702 except error.CmdError:
703 # The directory might not exist. Let's try next candidate.
704 pass
705 else:
706 raise error.AutoservError('Cannot find the latest firmware')
Namyoon Woo5f894662019-11-15 15:23:23 -0800707
Brent Peterson1cb623a2020-01-09 13:14:28 -0800708 @staticmethod
709 def get_version_from_image(image, version_regex):
Brent Peterson8039b472020-02-14 10:51:23 -0800710 """Get version string from binary image using regular expression.
711
712 @param image: Binary image to search
713 @param version_regex: Regular expression to search for
714
715 @return Version string
716
717 @raises TestFail if no version string is found in image
718 """
Brent Peterson1cb623a2020-01-09 13:14:28 -0800719 with open(image, 'rb') as f:
720 image_data = f.read()
721 match = re.findall(version_regex, image_data)
722 if match:
723 return match[0]
724 else:
725 raise error.TestFail('Failed to read version from %s.' % image)
726
727
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800728 def firmware_install(self, build=None, rw_only=False, dest=None,
Brent Petersonc70a1832020-01-24 15:54:35 -0800729 local_tarball=None, verify_version=False,
730 try_scp=False):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700731 """Install firmware to the DUT.
732
733 Use stateful update if the DUT is already running the same build.
734 Stateful update does not update kernel and tends to run much faster
735 than a full reimage. If the DUT is running a different build, or it
736 failed to do a stateful update, full update, including kernel update,
737 will be applied to the DUT.
738
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800739 Once a host enters firmware_install its fw[ro|rw]_version label will
740 be removed. After the firmware is updated successfully, a new
741 fw[ro|rw]_version label will be added to the host.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700742
743 @param build: The build version to which we want to provision the
744 firmware of the machine,
745 e.g. 'link-firmware/R22-2695.1.144'.
Tom Wai-Hong Tam4ac78982016-01-08 02:34:37 +0800746 @param rw_only: True to only install firmware to its RW portions. Keep
747 the RO portions unchanged.
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700748 @param dest: Directory to store the firmware in.
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800749 @param local_tarball: Path to local firmware image for installing
750 without devserver.
Brent Peterson1cb623a2020-01-09 13:14:28 -0800751 @param verify_version: True to verify EC and BIOS versions after
752 programming firmware, default is False.
Brent Petersonc70a1832020-01-24 15:54:35 -0800753 @param try_scp: False to always program using servo, true to try copying
754 the firmware and programming from the DUT.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700755
756 TODO(dshi): After bug 381718 is fixed, update here with corresponding
757 exceptions that could be raised.
758
759 """
760 if not self.servo:
761 raise error.TestError('Host %s does not have servo.' %
762 self.hostname)
763
Wai-Hong Tam3fa455a2018-07-18 14:40:43 -0700764 # Get the DUT board name from AFE.
765 info = self.host_info_store.get()
766 board = info.board
Shelley Chenac61d5a2019-06-24 15:35:46 -0700767 model = info.model
Namyoon Woo8dbfcf92019-01-15 18:37:12 -0800768
769 if board is None or board == '':
770 board = self.servo.get_board()
Dan Shi9cb0eec2014-06-03 09:04:50 -0700771
Mary Ruthvende14a8b2019-08-23 12:43:52 -0700772 if model is None or model == '':
773 model = self.get_platform_from_fwid()
774
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800775 # If local firmware path not provided fetch it from the dev server
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700776 tmpd = None
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800777 if not local_tarball:
778 # If build is not set, try to install firmware from stable CrOS.
779 if not build:
780 build = afe_utils.get_stable_faft_version_v2(info)
781 if not build:
782 raise error.TestError(
783 'Failed to find stable firmware build for %s.',
784 self.hostname)
785 logging.info('Will install firmware from build %s.', build)
786
787 ds = dev_server.ImageServer.resolve(build, self.hostname)
788 ds.stage_artifacts(build, ['firmware'])
789
790 if not dest:
791 tmpd = autotemp.tempdir(unique_id='fwimage')
792 dest = tmpd.name
793
794 # Download firmware image
Dan Shi9cb0eec2014-06-03 09:04:50 -0700795 fwurl = self._FW_IMAGE_URL_PATTERN % (ds.url(), build)
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700796 local_tarball = os.path.join(dest, os.path.basename(fwurl))
xixuan4e116822016-11-17 15:32:10 -0800797 ds.download_file(fwurl, local_tarball)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700798
Brent Peterson1cb623a2020-01-09 13:14:28 -0800799 # Extract EC image from tarball
800 logging.info('Extracting EC image.')
801 ec_image = self.servo.extract_ec_image(board, model, local_tarball)
802
803 # Extract BIOS image from tarball
804 logging.info('Extracting BIOS image.')
805 bios_image = self.servo.extract_bios_image(board, model, local_tarball)
806
Brent Petersonc70a1832020-01-24 15:54:35 -0800807 # Clear firmware version labels
808 self._clear_fw_version_labels(rw_only)
809
810 # Install firmware from local tarball
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800811 try:
Brent Petersonc70a1832020-01-24 15:54:35 -0800812 # Check if DUT is available and copying to DUT is enabled
813 if self.is_up() and try_scp:
814 # DUT is available, make temp firmware directory to store images
815 logging.info('Making temp folder.')
816 dest_folder = '/tmp/firmware'
817 self.run('mkdir -p ' + dest_folder)
818
Brent Petersonc70a1832020-01-24 15:54:35 -0800819 # Send BIOS firmware image to DUT
820 logging.info('Sending BIOS firmware.')
821 dest_bios_path = os.path.join(dest_folder,
822 os.path.basename(bios_image))
823 self.send_file(bios_image, dest_bios_path)
824
Brent Peterson669edf42020-02-07 15:07:54 -0800825 # Initialize firmware update command for BIOS image
826 fw_cmd = self._FW_UPDATE_CMD % (dest_bios_path,
Brent Petersonc70a1832020-01-24 15:54:35 -0800827 '--wp=1' if rw_only else '')
Brent Peterson669edf42020-02-07 15:07:54 -0800828
829 # Send EC firmware image to DUT when EC image was found
830 if ec_image:
831 logging.info('Sending EC firmware.')
832 dest_ec_path = os.path.join(dest_folder,
833 os.path.basename(ec_image))
834 self.send_file(ec_image, dest_ec_path)
835
836 # Add EC image to firmware update command
837 fw_cmd += ' -e %s' % dest_ec_path
838
839 # Update firmware on DUT
840 logging.info('Updating firmware.')
Brent Petersonc70a1832020-01-24 15:54:35 -0800841 self.run(fw_cmd)
842 else:
843 # Host is not available, program firmware using servo
Brent Peterson669edf42020-02-07 15:07:54 -0800844 if ec_image:
845 self.servo.program_ec(ec_image, rw_only)
Brent Petersonc70a1832020-01-24 15:54:35 -0800846 self.servo.program_bios(bios_image, rw_only)
847 if utils.host_is_in_lab_zone(self.hostname):
848 self._add_fw_version_label(build, rw_only)
Brent Peterson1cb623a2020-01-09 13:14:28 -0800849
850 # Reboot and wait for DUT after installing firmware
851 logging.info('Rebooting DUT.')
852 self.servo.get_power_state_controller().reset()
853 time.sleep(self.servo.BOOT_DELAY)
854 self.test_wait_for_boot()
855
856 # When enabled verify EC and BIOS firmware version after programming
857 if verify_version:
Brent Peterson669edf42020-02-07 15:07:54 -0800858 # Check programmed EC firmware when EC image was found
859 if ec_image:
860 logging.info('Checking EC firmware version.')
861 dest_ec_version = self.get_ec_version()
Brent Peterson8039b472020-02-14 10:51:23 -0800862 ec_version_prefix = dest_ec_version.split('_', 1)[0]
863 ec_regex = self._EC_REGEX % ec_version_prefix
Brent Peterson669edf42020-02-07 15:07:54 -0800864 image_ec_version = self.get_version_from_image(ec_image,
Brent Peterson8039b472020-02-14 10:51:23 -0800865 ec_regex)
Brent Peterson669edf42020-02-07 15:07:54 -0800866 if dest_ec_version != image_ec_version:
867 raise error.TestFail(
868 'Failed to update EC RO, version %s (expected %s)' %
869 (dest_ec_version, image_ec_version))
Brent Peterson1cb623a2020-01-09 13:14:28 -0800870
871 # Check programmed BIOS firmware against expected version
872 logging.info('Checking BIOS firmware version.')
873 dest_bios_version = self.get_firmware_version()
874 bios_version_prefix = dest_bios_version.split('.', 1)[0]
875 bios_regex = self._BIOS_REGEX % bios_version_prefix
876 image_bios_version = self.get_version_from_image(bios_image,
877 bios_regex)
878 if dest_bios_version != image_bios_version:
879 raise error.TestFail(
880 'Failed to update BIOS RO, version %s (expected %s)' %
881 (dest_bios_version, image_bios_version))
Dan Shi9cb0eec2014-06-03 09:04:50 -0700882 finally:
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700883 if tmpd:
884 tmpd.clean()
Dan Shi9cb0eec2014-06-03 09:04:50 -0700885
886
beepsf079cfb2013-09-18 17:49:51 -0700887 def servo_install(self, image_url=None, usb_boot_timeout=USB_BOOT_TIMEOUT,
888 install_timeout=INSTALL_TIMEOUT):
Scott Zawalski62bacae2013-03-05 10:40:32 -0500889 """
890 Re-install the OS on the DUT by:
891 1) installing a test image on a USB storage device attached to the Servo
892 board,
Richard Barnette03a0c132012-11-05 12:40:35 -0800893 2) booting that image in recovery mode, and then
J. Richard Barnette31b2e312013-04-04 16:05:22 -0700894 3) installing the image with chromeos-install.
895
Scott Zawalski62bacae2013-03-05 10:40:32 -0500896 @param image_url: If specified use as the url to install on the DUT.
897 otherwise boot the currently staged image on the USB stick.
beepsf079cfb2013-09-18 17:49:51 -0700898 @param usb_boot_timeout: The usb_boot_timeout to use during reimage.
899 Factory images need a longer usb_boot_timeout than regular
900 cros images.
901 @param install_timeout: The timeout to use when installing the chromeos
902 image. Factory images need a longer install_timeout.
Richard Barnette03a0c132012-11-05 12:40:35 -0800903
Scott Zawalski62bacae2013-03-05 10:40:32 -0500904 @raises AutoservError if the image fails to boot.
beepsf079cfb2013-09-18 17:49:51 -0700905
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800906 """
beepsf079cfb2013-09-18 17:49:51 -0700907 logging.info('Downloading image to USB, then booting from it. Usb boot '
908 'timeout = %s', usb_boot_timeout)
Allen Li48a13fe2016-11-22 14:10:40 -0800909 with metrics.SecondsTimer(
910 'chromeos/autotest/provision/servo_install/boot_duration'):
911 self.servo.install_recovery_image(image_url)
912 if not self.wait_up(timeout=usb_boot_timeout):
913 raise hosts.AutoservRepairError(
914 'DUT failed to boot from USB after %d seconds' %
Garry Wang954f8382019-01-23 13:49:29 -0800915 usb_boot_timeout, 'failed_to_reboot')
Scott Zawalski62bacae2013-03-05 10:40:32 -0500916
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +0800917 # The new chromeos-tpm-recovery has been merged since R44-7073.0.0.
918 # In old CrOS images, this command fails. Skip the error.
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +0800919 logging.info('Resetting the TPM status')
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +0800920 try:
921 self.run('chromeos-tpm-recovery')
922 except error.AutoservRunError:
923 logging.warn('chromeos-tpm-recovery is too old.')
924
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +0800925
Allen Li48a13fe2016-11-22 14:10:40 -0800926 with metrics.SecondsTimer(
927 'chromeos/autotest/provision/servo_install/install_duration'):
928 logging.info('Installing image through chromeos-install.')
Garry Wang83fb5b32019-09-27 13:16:00 -0700929 self.run('chromeos-install --yes',timeout=install_timeout)
Anh Lee21e4032019-07-11 15:01:06 -0700930
Allen Li48a13fe2016-11-22 14:10:40 -0800931 self.halt()
beepsf079cfb2013-09-18 17:49:51 -0700932
933 logging.info('Power cycling DUT through servo.')
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800934 self.servo.get_power_state_controller().power_off()
Fang Dengafb88142013-05-30 17:44:31 -0700935 self.servo.switch_usbkey('off')
J. Richard Barnette0199cc82014-12-05 17:08:40 -0800936 # N.B. The Servo API requires that we use power_on() here
937 # for two reasons:
938 # 1) After turning on a DUT in recovery mode, you must turn
939 # it off and then on with power_on() once more to
940 # disable recovery mode (this is a Parrot specific
941 # requirement).
942 # 2) After power_off(), the only way to turn on is with
943 # power_on() (this is a Storm specific requirement).
J. Richard Barnettefbcc7122013-07-24 18:24:59 -0700944 self.servo.get_power_state_controller().power_on()
beepsf079cfb2013-09-18 17:49:51 -0700945
946 logging.info('Waiting for DUT to come back up.')
Richard Barnette03a0c132012-11-05 12:40:35 -0800947 if not self.wait_up(timeout=self.BOOT_TIMEOUT):
948 raise error.AutoservError('DUT failed to reboot installed '
949 'test image after %d seconds' %
Scott Zawalski62bacae2013-03-05 10:40:32 -0500950 self.BOOT_TIMEOUT)
951
952
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700953 def set_servo_host(self, host, servo_state = None):
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700954 """Set our servo host member, and associated servo.
955
956 @param host Our new `ServoHost`.
957 """
958 self._servo_host = host
959 if self._servo_host is not None:
960 self.servo = self._servo_host.get_servo()
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700961 servo_state = self._servo_host.get_servo_state()
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700962 else:
963 self.servo = None
964
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700965 self.set_servo_state(servo_state)
966
Richard Barnette4aeb01c2018-09-20 09:36:12 -0700967
Richard Barnette9a26ad62016-06-10 12:03:08 -0700968 def repair_servo(self):
Dan Shi90466352015-09-22 15:01:05 -0700969 """
Richard Barnette9a26ad62016-06-10 12:03:08 -0700970 Confirm that servo is initialized and verified.
Dan Shi90466352015-09-22 15:01:05 -0700971
Richard Barnette9a26ad62016-06-10 12:03:08 -0700972 If the servo object is missing, attempt to repair the servo
973 host. Repair failures are passed back to the caller.
974
975 @raise AutoservError: If there is no servo host for this CrOS
976 host.
977 """
978 if self.servo:
979 return
980 if not self._servo_host:
981 raise error.AutoservError('No servo host for %s.' %
982 self.hostname)
Otabek Kasimovcc9738e2020-02-14 16:17:15 -0800983 try:
984 self._servo_host.repair()
985 except:
986 raise
987 finally:
988 self.set_servo_host(self._servo_host)
989
990
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700991 def set_servo_state(self, servo_state):
Otabek Kasimovcc9738e2020-02-14 16:17:15 -0800992 """Set servo info labels to dut host_info"""
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700993 if servo_state is not None:
Otabek Kasimovcc9738e2020-02-14 16:17:15 -0800994 host_info = self.host_info_store.get()
Garry Wang11b5e872020-03-11 15:14:08 -0700995 servo_state_prefix = servo_constants.SERVO_STATE_LABEL_PREFIX
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700996 old_state = host_info.get_label_value(servo_state_prefix)
997 if old_state == servo_state:
998 # do not need update
999 return
1000 host_info.set_version_label(servo_state_prefix, servo_state)
Otabek Kasimovcc9738e2020-02-14 16:17:15 -08001001 self.host_info_store.commit(host_info)
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001002 logging.info('ServoHost: servo_state updated to %s (previous: %s)',
1003 servo_state, old_state)
Dan Shi90466352015-09-22 15:01:05 -07001004
1005
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001006 def get_servo_state(self):
1007 host_info = self.host_info_store.get()
Garry Wang11b5e872020-03-11 15:14:08 -07001008 servo_state_prefix = servo_constants.SERVO_STATE_LABEL_PREFIX
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001009 return host_info.get_label_value(servo_state_prefix)
1010
J. Richard Barnettec2d99cf2015-11-18 12:46:15 -08001011 def repair(self):
1012 """Attempt to get the DUT to pass `self.verify()`.
Richard Barnette82c35912012-11-20 10:09:10 -08001013
1014 This overrides the base class function for repair; it does
J. Richard Barnette91137f02016-03-10 16:52:26 -08001015 not call back to the parent class, but instead relies on
1016 `self._repair_strategy` to coordinate the verification and
1017 repair steps needed to get the DUT working.
Richard Barnette82c35912012-11-20 10:09:10 -08001018 """
Richard Barnetteabbdc252018-07-26 16:57:42 -07001019 message = 'Beginning repair for host %s board %s model %s'
1020 info = self.host_info_store.get()
1021 message %= (self.hostname, info.board, info.model)
1022 self.record('INFO', None, None, message)
J. Richard Barnette91137f02016-03-10 16:52:26 -08001023 self._repair_strategy.repair(self)
Scott Zawalski89c44dd2013-02-26 09:28:02 -05001024
Richard Barnette82c35912012-11-20 10:09:10 -08001025
J. Richard Barnette1d78b012012-05-15 13:56:30 -07001026 def close(self):
David Rileye2c6be12017-12-11 10:20:57 -08001027 """Close connection."""
Fang Deng0ca40e22013-08-27 17:47:44 -07001028 super(CrosHost, self).close()
howardchung83e55272019-08-08 14:08:05 +08001029
Shijin Abraham783a7dd2020-02-14 15:36:11 -08001030 if self._chameleon_host:
1031 self._chameleon_host.close()
xixuand6011f12016-12-08 15:01:58 -08001032
1033 if self._servo_host:
1034 self._servo_host.close()
J. Richard Barnette1d78b012012-05-15 13:56:30 -07001035
1036
Dan Shi49ca0932014-11-14 11:22:27 -08001037 def get_power_supply_info(self):
1038 """Get the output of power_supply_info.
1039
1040 power_supply_info outputs the info of each power supply, e.g.,
1041 Device: Line Power
1042 online: no
1043 type: Mains
1044 voltage (V): 0
1045 current (A): 0
1046 Device: Battery
1047 state: Discharging
1048 percentage: 95.9276
1049 technology: Li-ion
1050
1051 Above output shows two devices, Line Power and Battery, with details of
1052 each device listed. This function parses the output into a dictionary,
1053 with key being the device name, and value being a dictionary of details
1054 of the device info.
1055
1056 @return: The dictionary of power_supply_info, e.g.,
1057 {'Line Power': {'online': 'yes', 'type': 'main'},
1058 'Battery': {'vendor': 'xyz', 'percentage': '100'}}
Dan Shie9b765d2014-12-29 16:59:49 -08001059 @raise error.AutoservRunError if power_supply_info tool is not found in
1060 the DUT. Caller should handle this error to avoid false failure
1061 on verification.
Dan Shi49ca0932014-11-14 11:22:27 -08001062 """
1063 result = self.run('power_supply_info').stdout.strip()
1064 info = {}
1065 device_name = None
1066 device_info = {}
1067 for line in result.split('\n'):
1068 pair = [v.strip() for v in line.split(':')]
1069 if len(pair) != 2:
1070 continue
1071 if pair[0] == 'Device':
1072 if device_name:
1073 info[device_name] = device_info
1074 device_name = pair[1]
1075 device_info = {}
1076 else:
1077 device_info[pair[0]] = pair[1]
1078 if device_name and not device_name in info:
1079 info[device_name] = device_info
1080 return info
1081
1082
1083 def get_battery_percentage(self):
1084 """Get the battery percentage.
1085
1086 @return: The percentage of battery level, value range from 0-100. Return
1087 None if the battery info cannot be retrieved.
1088 """
1089 try:
1090 info = self.get_power_supply_info()
1091 logging.info(info)
1092 return float(info['Battery']['percentage'])
Dan Shie9b765d2014-12-29 16:59:49 -08001093 except (KeyError, ValueError, error.AutoservRunError):
Dan Shi49ca0932014-11-14 11:22:27 -08001094 return None
1095
1096
Daniel Campello8ca25c22019-12-13 16:48:26 -07001097 def get_battery_display_percentage(self):
1098 """Get the battery display percentage.
1099
1100 @return: The display percentage of battery level, value range from
1101 0-100. Return None if the battery info cannot be retrieved.
1102 """
1103 try:
1104 info = self.get_power_supply_info()
1105 logging.info(info)
1106 return float(info['Battery']['display percentage'])
1107 except (KeyError, ValueError, error.AutoservRunError):
1108 return None
1109
1110
Dan Shi49ca0932014-11-14 11:22:27 -08001111 def is_ac_connected(self):
1112 """Check if the dut has power adapter connected and charging.
1113
1114 @return: True if power adapter is connected and charging.
1115 """
1116 try:
1117 info = self.get_power_supply_info()
1118 return info['Line Power']['online'] == 'yes'
Dan Shie9b765d2014-12-29 16:59:49 -08001119 except (KeyError, error.AutoservRunError):
1120 return None
Dan Shi49ca0932014-11-14 11:22:27 -08001121
1122
Simran Basi5e6339a2013-03-21 11:34:32 -07001123 def _cleanup_poweron(self):
1124 """Special cleanup method to make sure hosts always get power back."""
Garry Wangad4d4fd2019-01-30 17:00:38 -08001125 info = self.host_info_store.get()
1126 if self._RPM_OUTLET_CHANGED not in info.attributes:
Simran Basi5e6339a2013-03-21 11:34:32 -07001127 return
1128 logging.debug('This host has recently interacted with the RPM'
1129 ' Infrastructure. Ensuring power is on.')
1130 try:
1131 self.power_on()
Garry Wangad4d4fd2019-01-30 17:00:38 -08001132 self._remove_rpm_changed_tag()
Simran Basi5e6339a2013-03-21 11:34:32 -07001133 except rpm_client.RemotePowerException:
Simran Basi5e6339a2013-03-21 11:34:32 -07001134 logging.error('Failed to turn Power On for this host after '
1135 'cleanup through the RPM Infrastructure.')
Dan Shi49ca0932014-11-14 11:22:27 -08001136
1137 battery_percentage = self.get_battery_percentage()
Dan Shif01ebe22014-12-05 13:10:57 -08001138 if battery_percentage and battery_percentage < 50:
Dan Shi49ca0932014-11-14 11:22:27 -08001139 raise
1140 elif self.is_ac_connected():
1141 logging.info('The device has power adapter connected and '
1142 'charging. No need to try to turn RPM on '
1143 'again.')
Garry Wangad4d4fd2019-01-30 17:00:38 -08001144 self._remove_rpm_changed_tag()
Dan Shi49ca0932014-11-14 11:22:27 -08001145 logging.info('Battery level is now at %s%%. The device may '
1146 'still have enough power to run test, so no '
1147 'exception will be raised.', battery_percentage)
1148
Simran Basi5e6339a2013-03-21 11:34:32 -07001149
Garry Wangad4d4fd2019-01-30 17:00:38 -08001150 def _remove_rpm_changed_tag(self):
1151 info = self.host_info_store.get()
1152 del info.attributes[self._RPM_OUTLET_CHANGED]
1153 self.host_info_store.commit(info)
1154
1155
1156 def _add_rpm_changed_tag(self):
1157 info = self.host_info_store.get()
Garry Wang518831d2019-02-21 15:15:36 -08001158 info.attributes[self._RPM_OUTLET_CHANGED] = 'true'
Garry Wangad4d4fd2019-01-30 17:00:38 -08001159 self.host_info_store.commit(info)
1160
1161
1162
beepsc87ff602013-07-31 21:53:00 -07001163 def _is_factory_image(self):
1164 """Checks if the image on the DUT is a factory image.
1165
1166 @return: True if the image on the DUT is a factory image.
1167 False otherwise.
1168 """
1169 result = self.run('[ -f /root/.factory_test ]', ignore_status=True)
1170 return result.exit_status == 0
1171
1172
1173 def _restart_ui(self):
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001174 """Restart the Chrome UI.
beepsc87ff602013-07-31 21:53:00 -07001175
1176 @raises: FactoryImageCheckerException for factory images, since
1177 we cannot attempt to restart ui on them.
1178 error.AutoservRunError for any other type of error that
1179 occurs while restarting ui.
1180 """
1181 if self._is_factory_image():
Dan Shi549fb822015-03-24 18:01:11 -07001182 raise FactoryImageCheckerException('Cannot restart ui on factory '
1183 'images')
beepsc87ff602013-07-31 21:53:00 -07001184
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001185 # TODO(jrbarnette): The command to stop/start the ui job
1186 # should live inside cros_ui, too. However that would seem
1187 # to imply interface changes to the existing start()/restart()
1188 # functions, which is a bridge too far (for now).
J. Richard Barnette6069aa12015-06-08 09:10:24 -07001189 prompt = cros_ui.get_chrome_session_ident(self)
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001190 self.run('stop ui; start ui')
1191 cros_ui.wait_for_chrome_ready(prompt, self)
beepsc87ff602013-07-31 21:53:00 -07001192
1193
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001194 def _start_powerd_if_needed(self):
1195 """Start powerd if it isn't already running."""
1196 self.run('start powerd', ignore_status=True)
1197
1198
xixuana3bbc422017-05-04 15:57:21 -07001199 def _get_lsb_release_content(self):
1200 """Return the content of lsb-release file of host."""
1201 return self.run(
1202 'cat "%s"' % client_constants.LSB_RELEASE).stdout.strip()
1203
1204
Dan Shi549fb822015-03-24 18:01:11 -07001205 def get_release_version(self):
1206 """Get the value of attribute CHROMEOS_RELEASE_VERSION from lsb-release.
1207
1208 @returns The version string in lsb-release, under attribute
1209 CHROMEOS_RELEASE_VERSION.
1210 """
Dan Shi549fb822015-03-24 18:01:11 -07001211 return lsbrelease_utils.get_chromeos_release_version(
xixuana3bbc422017-05-04 15:57:21 -07001212 lsb_release_content=self._get_lsb_release_content())
1213
1214
Don Garrettb9f35802018-01-22 18:25:40 -08001215 def get_release_builder_path(self):
1216 """Get the value of CHROMEOS_RELEASE_BUILDER_PATH from lsb-release.
1217
1218 @returns The version string in lsb-release, under attribute
1219 CHROMEOS_RELEASE_BUILDER_PATH.
1220 """
1221 return lsbrelease_utils.get_chromeos_release_builder_path(
1222 lsb_release_content=self._get_lsb_release_content())
1223
1224
xixuana3bbc422017-05-04 15:57:21 -07001225 def get_chromeos_release_milestone(self):
1226 """Get the value of attribute CHROMEOS_RELEASE_BUILD_TYPE
1227 from lsb-release.
1228
1229 @returns The version string in lsb-release, under attribute
1230 CHROMEOS_RELEASE_BUILD_TYPE.
1231 """
1232 return lsbrelease_utils.get_chromeos_release_milestone(
1233 lsb_release_content=self._get_lsb_release_content())
Dan Shi549fb822015-03-24 18:01:11 -07001234
1235
1236 def verify_cros_version_label(self):
1237 """ Make sure host's cros-version label match the actual image in dut.
1238
1239 Remove any cros-version: label that doesn't match that installed in
1240 the dut.
1241
1242 @param raise_error: Set to True to raise exception if any mismatch found
1243
1244 @raise error.AutoservError: If any mismatch between cros-version label
1245 and the build installed in dut is found.
1246 """
Prathmesh Prabhuce2da3a2019-10-04 11:54:51 -07001247 # crbug.com/1007333: This check is being removed.
1248 return True
Dan Shi549fb822015-03-24 18:01:11 -07001249
1250
Laurence Goodby778c9a42017-05-24 19:24:07 -07001251 def cleanup_services(self):
1252 """Reinitializes the device for cleanup.
1253
1254 Subclasses may override this to customize the cleanup method.
1255
1256 To indicate failure of the reset, the implementation may raise
1257 any of:
1258 error.AutoservRunError
1259 error.AutotestRunError
1260 FactoryImageCheckerException
1261
1262 @raises error.AutoservRunError
1263 @raises error.AutotestRunError
1264 @raises error.FactoryImageCheckerException
1265 """
1266 self._restart_ui()
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001267 self._start_powerd_if_needed()
Laurence Goodby778c9a42017-05-24 19:24:07 -07001268
1269
beepsc87ff602013-07-31 21:53:00 -07001270 def cleanup(self):
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -08001271 """Cleanup state on device."""
MK Ryu35d661e2014-09-25 17:44:10 -07001272 self.run('rm -f %s' % client_constants.CLEANUP_LOGS_PAUSED_FILE)
Scott Zawalskiddbc31e2012-11-15 11:29:01 -05001273 try:
Laurence Goodby778c9a42017-05-24 19:24:07 -07001274 self.cleanup_services()
beepsc87ff602013-07-31 21:53:00 -07001275 except (error.AutotestRunError, error.AutoservRunError,
1276 FactoryImageCheckerException):
Ilja H. Friedel04be2bd2014-05-07 21:29:59 -07001277 logging.warning('Unable to restart ui, rebooting device.')
Scott Zawalskiddbc31e2012-11-15 11:29:01 -05001278 # Since restarting the UI fails fall back to normal Autotest
1279 # cleanup routines, i.e. reboot the machine.
Fang Deng0ca40e22013-08-27 17:47:44 -07001280 super(CrosHost, self).cleanup()
Simran Basi5e6339a2013-03-21 11:34:32 -07001281 # Check if the rpm outlet was manipulated.
Simran Basid5e5e272012-09-24 15:23:59 -07001282 if self.has_power():
Simran Basi5e6339a2013-03-21 11:34:32 -07001283 self._cleanup_poweron()
Dan Shi549fb822015-03-24 18:01:11 -07001284 self.verify_cros_version_label()
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001285
1286
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001287 def reboot(self, **dargs):
1288 """
1289 This function reboots the site host. The more generic
1290 RemoteHost.reboot() performs sync and sleeps for 5
1291 seconds. This is not necessary for Chrome OS devices as the
1292 sync should be finished in a short time during the reboot
1293 command.
1294 """
Tom Wai-Hong Tamf5cd1d42012-08-13 12:04:08 +08001295 if 'reboot_cmd' not in dargs:
Doug Anderson7d5aeb22014-02-27 15:12:17 -08001296 reboot_timeout = dargs.get('reboot_timeout', 10)
J. Richard Barnette9af19632015-09-25 12:18:03 -07001297 dargs['reboot_cmd'] = ('sleep 1; '
1298 'reboot & sleep %d; '
1299 'reboot -f' % reboot_timeout)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001300 # Enable fastsync to avoid running extra sync commands before reboot.
Tom Wai-Hong Tamf5cd1d42012-08-13 12:04:08 +08001301 if 'fastsync' not in dargs:
1302 dargs['fastsync'] = True
Michael Liangda8c60a2014-06-03 13:24:51 -07001303
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001304 dargs['board'] = self.host_info_store.get().board
Vincent Palatindf2372c2016-10-07 17:03:00 +02001305 # Record who called us
1306 orig = sys._getframe(1).f_code
Vincent Palatin80780b22016-07-27 16:02:37 +02001307 metric_fields = {'board' : dargs['board'],
Vincent Palatindf2372c2016-10-07 17:03:00 +02001308 'dut_host_name' : self.hostname,
1309 'success' : True}
1310 metric_debug_fields = {'board' : dargs['board'],
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001311 'caller' : "%s:%s" % (orig.co_filename,
1312 orig.co_name),
Vincent Palatindf2372c2016-10-07 17:03:00 +02001313 'success' : True,
1314 'error' : ''}
1315
Vincent Palatin80780b22016-07-27 16:02:37 +02001316 t0 = time.time()
1317 try:
1318 super(CrosHost, self).reboot(**dargs)
1319 except Exception as e:
1320 metric_fields['success'] = False
Vincent Palatindf2372c2016-10-07 17:03:00 +02001321 metric_debug_fields['success'] = False
1322 metric_debug_fields['error'] = type(e).__name__
Vincent Palatin80780b22016-07-27 16:02:37 +02001323 raise
1324 finally:
1325 duration = int(time.time() - t0)
Dan Shi5e2efb72017-02-07 11:40:23 -08001326 metrics.Counter(
1327 'chromeos/autotest/autoserv/reboot_count').increment(
1328 fields=metric_fields)
1329 metrics.Counter(
1330 'chromeos/autotest/autoserv/reboot_debug').increment(
1331 fields=metric_debug_fields)
1332 metrics.SecondsDistribution(
1333 'chromeos/autotest/autoserv/reboot_duration').add(
1334 duration, fields=metric_fields)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001335
1336
Kalin Stoyanov83d9caa2020-01-31 16:58:27 -08001337 def suspend(self, suspend_time=60, delay_seconds=0,
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001338 suspend_cmd=None, allow_early_resume=False):
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001339 """
1340 This function suspends the site host.
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001341
1342 @param suspend_time: How long to suspend as integer seconds.
1343 @param suspend_cmd: Suspend command to execute.
1344 @param allow_early_resume: If False and if device resumes before
1345 |suspend_time|, throw an error.
1346
1347 @exception AutoservSuspendError Host resumed earlier than
1348 |suspend_time|.
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001349 """
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001350
1351 if suspend_cmd is None:
1352 suspend_cmd = ' && '.join([
J. Richard Barnette9af19632015-09-25 12:18:03 -07001353 'echo 0 > /sys/class/rtc/rtc0/wakealarm',
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001354 'echo +%d > /sys/class/rtc/rtc0/wakealarm' % suspend_time,
Kalin Stoyanov83d9caa2020-01-31 16:58:27 -08001355 'powerd_dbus_suspend --delay=%d' % delay_seconds])
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001356 super(CrosHost, self).suspend(suspend_time, suspend_cmd,
1357 allow_early_resume);
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001358
1359
Simran Basiec564392014-08-25 16:48:09 -07001360 def upstart_status(self, service_name):
1361 """Check the status of an upstart init script.
1362
1363 @param service_name: Service to look up.
1364
1365 @returns True if the service is running, False otherwise.
1366 """
Richard Barnettee204dc52017-09-26 11:02:25 -07001367 return 'start/running' in self.run('status %s' % service_name,
1368 ignore_status=True).stdout
Simran Basiec564392014-08-25 16:48:09 -07001369
Tom Hughese9552342018-12-18 14:29:25 -08001370 def upstart_stop(self, service_name):
1371 """Stops an upstart job if it's running.
1372
1373 @param service_name: Service to stop
1374
1375 @returns True if service has been stopped or was already stopped
1376 False otherwise.
1377 """
1378 if not self.upstart_status(service_name):
1379 return True
1380
1381 result = self.run('stop %s' % service_name, ignore_status=True)
1382 if result.exit_status != 0:
1383 return False
1384 return True
1385
1386 def upstart_restart(self, service_name):
1387 """Restarts (or starts) an upstart job.
1388
1389 @param service_name: Service to start/restart
1390
1391 @returns True if service has been started/restarted, False otherwise.
1392 """
1393 cmd = 'start'
1394 if self.upstart_status(service_name):
1395 cmd = 'restart'
1396 cmd = cmd + ' %s' % service_name
1397 result = self.run(cmd)
1398 if result.exit_status != 0:
1399 return False
1400 return True
Simran Basiec564392014-08-25 16:48:09 -07001401
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001402 def verify_software(self):
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001403 """Verify working software on a Chrome OS system.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001404
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001405 Tests for the following conditions:
1406 1. All conditions tested by the parent version of this
1407 function.
1408 2. Sufficient space in /mnt/stateful_partition.
Fang Deng6b05f5b2013-03-20 13:42:11 -07001409 3. Sufficient space in /mnt/stateful_partition/encrypted.
1410 4. update_engine answers a simple status request over DBus.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001411
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001412 """
Fang Deng0ca40e22013-08-27 17:47:44 -07001413 super(CrosHost, self).verify_software()
Dan Shib8540a52015-07-16 14:18:23 -07001414 default_kilo_inodes_required = CONFIG.get_config_value(
1415 'SERVER', 'kilo_inodes_required', type=int, default=100)
1416 board = self.get_board().replace(ds_constants.BOARD_PREFIX, '')
1417 kilo_inodes_required = CONFIG.get_config_value(
1418 'SERVER', 'kilo_inodes_required_%s' % board,
1419 type=int, default=default_kilo_inodes_required)
1420 self.check_inodes('/mnt/stateful_partition', kilo_inodes_required)
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001421 self.check_diskspace(
1422 '/mnt/stateful_partition',
Dan Shib8540a52015-07-16 14:18:23 -07001423 CONFIG.get_config_value(
Fang Deng6b05f5b2013-03-20 13:42:11 -07001424 'SERVER', 'gb_diskspace_required', type=float,
1425 default=20.0))
Gaurav Shahe448af82014-06-19 15:18:59 -07001426 encrypted_stateful_path = '/mnt/stateful_partition/encrypted'
1427 # Not all targets build with encrypted stateful support.
1428 if self.path_exists(encrypted_stateful_path):
1429 self.check_diskspace(
1430 encrypted_stateful_path,
Dan Shib8540a52015-07-16 14:18:23 -07001431 CONFIG.get_config_value(
Gaurav Shahe448af82014-06-19 15:18:59 -07001432 'SERVER', 'gb_encrypted_diskspace_required', type=float,
1433 default=0.1))
beepsc87ff602013-07-31 21:53:00 -07001434
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001435 self.wait_for_system_services()
Prashanth B5d0a0512014-04-25 12:26:08 -07001436
beepsc87ff602013-07-31 21:53:00 -07001437 # Factory images don't run update engine,
1438 # goofy controls dbus on these DUTs.
1439 if not self._is_factory_image():
1440 self.run('update_engine_client --status')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001441
Dan Shi549fb822015-03-24 18:01:11 -07001442 self.verify_cros_version_label()
1443
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001444
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001445 @retry.retry(error.AutoservError, timeout_min=5, delay_sec=10)
1446 def wait_for_system_services(self):
1447 """Waits for system-services to be running.
1448
1449 Sometimes, update_engine will take a while to update firmware, so we
1450 should give this some time to finish. See crbug.com/765686#c38 for
1451 details.
1452 """
1453 if not self.upstart_status('system-services'):
1454 raise error.AutoservError('Chrome failed to reach login. '
1455 'System services not running.')
1456
1457
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001458 def verify(self):
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -08001459 """Verify Chrome OS system is in good state."""
Richard Barnetteabbdc252018-07-26 16:57:42 -07001460 message = 'Beginning verify for host %s board %s model %s'
1461 info = self.host_info_store.get()
1462 message %= (self.hostname, info.board, info.model)
1463 self.record('INFO', None, None, message)
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001464 self._repair_strategy.verify(self)
1465
1466
Fang Deng96667ca2013-08-01 17:46:18 -07001467 def make_ssh_command(self, user='root', port=22, opts='', hosts_file=None,
Dean Liaoe3e75f62017-11-14 10:36:43 +08001468 connect_timeout=None, alive_interval=None,
1469 alive_count_max=None, connection_attempts=None):
Fang Deng96667ca2013-08-01 17:46:18 -07001470 """Override default make_ssh_command to use options tuned for Chrome OS.
1471
1472 Tuning changes:
1473 - ConnectTimeout=30; maximum of 30 seconds allowed for an SSH
1474 connection failure. Consistency with remote_access.sh.
1475
Samuel Tan2ce155b2015-06-23 18:24:38 -07001476 - ServerAliveInterval=900; which causes SSH to ping connection every
1477 900 seconds. In conjunction with ServerAliveCountMax ensures
1478 that if the connection dies, Autotest will bail out.
Fang Deng96667ca2013-08-01 17:46:18 -07001479 Originally tried 60 secs, but saw frequent job ABORTS where
Samuel Tan2ce155b2015-06-23 18:24:38 -07001480 the test completed successfully. Later increased from 180 seconds to
1481 900 seconds to account for tests where the DUT is suspended for
1482 longer periods of time.
Fang Deng96667ca2013-08-01 17:46:18 -07001483
1484 - ServerAliveCountMax=3; consistency with remote_access.sh.
1485
1486 - ConnectAttempts=4; reduce flakiness in connection errors;
1487 consistency with remote_access.sh.
1488
1489 - UserKnownHostsFile=/dev/null; we don't care about the keys.
1490 Host keys change with every new installation, don't waste
1491 memory/space saving them.
1492
1493 - SSH protocol forced to 2; needed for ServerAliveInterval.
1494
1495 @param user User name to use for the ssh connection.
1496 @param port Port on the target host to use for ssh connection.
1497 @param opts Additional options to the ssh command.
1498 @param hosts_file Ignored.
1499 @param connect_timeout Ignored.
1500 @param alive_interval Ignored.
Dean Liaoe3e75f62017-11-14 10:36:43 +08001501 @param alive_count_max Ignored.
1502 @param connection_attempts Ignored.
Fang Deng96667ca2013-08-01 17:46:18 -07001503 """
Dean Liaoe3e75f62017-11-14 10:36:43 +08001504 options = ' '.join([opts, '-o Protocol=2'])
1505 return super(CrosHost, self).make_ssh_command(
1506 user=user, port=port, opts=options, hosts_file='/dev/null',
1507 connect_timeout=30, alive_interval=900, alive_count_max=3,
1508 connection_attempts=4)
1509
1510
Jason Abeleb6f924f2013-11-13 16:01:54 -08001511 def syslog(self, message, tag='autotest'):
1512 """Logs a message to syslog on host.
1513
1514 @param message String message to log into syslog
1515 @param tag String tag prefix for syslog
1516
1517 """
1518 self.run('logger -t "%s" "%s"' % (tag, message))
1519
1520
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001521 def _ping_check_status(self, status):
1522 """Ping the host once, and return whether it has a given status.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001523
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001524 @param status Check the ping status against this value.
1525 @return True iff `status` and the result of ping are the same
1526 (i.e. both True or both False).
1527
1528 """
1529 ping_val = utils.ping(self.hostname, tries=1, deadline=1)
1530 return not (status ^ (ping_val == 0))
1531
1532 def _ping_wait_for_status(self, status, timeout):
1533 """Wait for the host to have a given status (UP or DOWN).
1534
1535 Status is checked by polling. Polling will not last longer
1536 than the number of seconds in `timeout`. The polling
1537 interval will be long enough that only approximately
1538 _PING_WAIT_COUNT polling cycles will be executed, subject
1539 to a maximum interval of about one minute.
1540
1541 @param status Waiting will stop immediately if `ping` of the
1542 host returns this status.
1543 @param timeout Poll for at most this many seconds.
1544 @return True iff the host status from `ping` matched the
1545 requested status at the time of return.
1546
1547 """
1548 # _ping_check_status() takes about 1 second, hence the
1549 # "- 1" in the formula below.
Nathan Ciobanu38480a32016-10-25 15:26:45 -07001550 # FIXME: if the ping command errors then _ping_check_status()
1551 # returns instantly. If timeout is also smaller than twice
1552 # _PING_WAIT_COUNT then the while loop below forks many
1553 # thousands of ping commands (see /tmp/test_that_results_XXXXX/
1554 # /results-1-logging_YYY.ZZZ/debug/autoserv.DEBUG) and hogs one
1555 # CPU core for 60 seconds.
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001556 poll_interval = min(int(timeout / self._PING_WAIT_COUNT), 60) - 1
1557 end_time = time.time() + timeout
1558 while time.time() <= end_time:
1559 if self._ping_check_status(status):
1560 return True
1561 if poll_interval > 0:
1562 time.sleep(poll_interval)
1563
1564 # The last thing we did was sleep(poll_interval), so it may
1565 # have been too long since the last `ping`. Check one more
1566 # time, just to be sure.
1567 return self._ping_check_status(status)
1568
1569 def ping_wait_up(self, timeout):
1570 """Wait for the host to respond to `ping`.
1571
1572 N.B. This method is not a reliable substitute for
1573 `wait_up()`, because a host that responds to ping will not
1574 necessarily respond to ssh. This method should only be used
1575 if the target DUT can be considered functional even if it
1576 can't be reached via ssh.
1577
1578 @param timeout Minimum time to allow before declaring the
1579 host to be non-responsive.
1580 @return True iff the host answered to ping before the timeout.
1581
1582 """
1583 return self._ping_wait_for_status(self._PING_STATUS_UP, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001584
Andrew Bresticker678c0c72013-01-22 10:44:09 -08001585 def ping_wait_down(self, timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001586 """Wait until the host no longer responds to `ping`.
1587
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001588 This function can be used as a slightly faster version of
1589 `wait_down()`, by avoiding potentially long ssh timeouts.
1590
1591 @param timeout Minimum time to allow for the host to become
1592 non-responsive.
1593 @return True iff the host quit answering ping before the
1594 timeout.
1595
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001596 """
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001597 return self._ping_wait_for_status(self._PING_STATUS_DOWN, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001598
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001599 def test_wait_for_sleep(self, sleep_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001600 """Wait for the client to enter low-power sleep mode.
1601
1602 The test for "is asleep" can't distinguish a system that is
1603 powered off; to confirm that the unit was asleep, it is
1604 necessary to force resume, and then call
1605 `test_wait_for_resume()`.
1606
1607 This function is expected to be called from a test as part
1608 of a sequence like the following:
1609
1610 ~~~~~~~~
1611 boot_id = host.get_boot_id()
1612 # trigger sleep on the host
1613 host.test_wait_for_sleep()
1614 # trigger resume on the host
1615 host.test_wait_for_resume(boot_id)
1616 ~~~~~~~~
1617
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001618 @param sleep_timeout time limit in seconds to allow the host sleep.
1619
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001620 @exception TestFail The host did not go to sleep within
1621 the allowed time.
1622 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001623 if sleep_timeout is None:
1624 sleep_timeout = self.SLEEP_TIMEOUT
1625
1626 if not self.ping_wait_down(timeout=sleep_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001627 raise error.TestFail(
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001628 'client failed to sleep after %d seconds' % sleep_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001629
1630
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001631 def test_wait_for_resume(self, old_boot_id, resume_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001632 """Wait for the client to resume from low-power sleep mode.
1633
1634 The `old_boot_id` parameter should be the value from
1635 `get_boot_id()` obtained prior to entering sleep mode. A
1636 `TestFail` exception is raised if the boot id changes.
1637
1638 See @ref test_wait_for_sleep for more on this function's
1639 usage.
1640
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08001641 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001642 target host went to sleep.
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001643 @param resume_timeout time limit in seconds to allow the host up.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001644
1645 @exception TestFail The host did not respond within the
1646 allowed time.
1647 @exception TestFail The host responded, but the boot id test
1648 indicated a reboot rather than a sleep
1649 cycle.
1650 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001651 if resume_timeout is None:
1652 resume_timeout = self.RESUME_TIMEOUT
1653
1654 if not self.wait_up(timeout=resume_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001655 raise error.TestFail(
1656 'client failed to resume from sleep after %d seconds' %
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08001657 resume_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001658 else:
1659 new_boot_id = self.get_boot_id()
1660 if new_boot_id != old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001661 logging.error('client rebooted (old boot %s, new boot %s)',
1662 old_boot_id, new_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001663 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001664 'client rebooted, but sleep was expected')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001665
1666
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001667 def test_wait_for_shutdown(self, shutdown_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001668 """Wait for the client to shut down.
1669
1670 The test for "has shut down" can't distinguish a system that
1671 is merely asleep; to confirm that the unit was down, it is
1672 necessary to force boot, and then call test_wait_for_boot().
1673
1674 This function is expected to be called from a test as part
1675 of a sequence like the following:
1676
1677 ~~~~~~~~
1678 boot_id = host.get_boot_id()
1679 # trigger shutdown on the host
1680 host.test_wait_for_shutdown()
1681 # trigger boot on the host
1682 host.test_wait_for_boot(boot_id)
1683 ~~~~~~~~
1684
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001685 @param shutdown_timeout time limit in seconds to allow the host down.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001686 @exception TestFail The host did not shut down within the
1687 allowed time.
1688 """
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001689 if shutdown_timeout is None:
1690 shutdown_timeout = self.SHUTDOWN_TIMEOUT
1691
1692 if not self.ping_wait_down(timeout=shutdown_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001693 raise error.TestFail(
1694 'client failed to shut down after %d seconds' %
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08001695 shutdown_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001696
1697
1698 def test_wait_for_boot(self, old_boot_id=None):
1699 """Wait for the client to boot from cold power.
1700
1701 The `old_boot_id` parameter should be the value from
1702 `get_boot_id()` obtained prior to shutting down. A
1703 `TestFail` exception is raised if the boot id does not
1704 change. The boot id test is omitted if `old_boot_id` is not
1705 specified.
1706
1707 See @ref test_wait_for_shutdown for more on this function's
1708 usage.
1709
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08001710 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001711 shut down.
1712
1713 @exception TestFail The host did not respond within the
1714 allowed time.
1715 @exception TestFail The host responded, but the boot id test
1716 indicated that there was no reboot.
1717 """
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07001718 if not self.wait_up(timeout=self.REBOOT_TIMEOUT):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001719 raise error.TestFail(
1720 'client failed to reboot after %d seconds' %
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07001721 self.REBOOT_TIMEOUT)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001722 elif old_boot_id:
1723 if self.get_boot_id() == old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001724 logging.error('client not rebooted (boot %s)',
1725 old_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001726 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08001727 'client is back up, but did not reboot')
Simran Basid5e5e272012-09-24 15:23:59 -07001728
1729
1730 @staticmethod
1731 def check_for_rpm_support(hostname):
1732 """For a given hostname, return whether or not it is powered by an RPM.
1733
Simran Basi1df55112013-09-06 11:25:09 -07001734 @param hostname: hostname to check for rpm support.
1735
Simran Basid5e5e272012-09-24 15:23:59 -07001736 @return None if this host does not follows the defined naming format
1737 for RPM powered DUT's in the lab. If it does follow the format,
1738 it returns a regular expression MatchObject instead.
1739 """
Fang Dengbaff9082015-01-06 13:46:15 -08001740 return re.match(CrosHost._RPM_HOSTNAME_REGEX, hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07001741
1742
1743 def has_power(self):
1744 """For this host, return whether or not it is powered by an RPM.
1745
1746 @return True if this host is in the CROS lab and follows the defined
1747 naming format.
1748 """
Fang Deng0ca40e22013-08-27 17:47:44 -07001749 return CrosHost.check_for_rpm_support(self.hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07001750
1751
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001752 def _set_power(self, state, power_method):
Garry Wang5e5538a2019-04-08 15:36:18 -07001753 """Sets the power to the host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001754
1755 @param state Specifies which power state to set to DUT
1756 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001757 use. By default "RPM" or "CCD" will be used based
1758 on servo type. Valid values from
1759 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001760
1761 """
1762 ACCEPTABLE_STATES = ['ON', 'OFF']
1763
Garry Wang5e5538a2019-04-08 15:36:18 -07001764 if not power_method:
1765 power_method = self.get_default_power_method()
1766
1767 state = state.upper()
1768 if state not in ACCEPTABLE_STATES:
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001769 raise error.TestError('State must be one of: %s.'
1770 % (ACCEPTABLE_STATES,))
1771
1772 if power_method == self.POWER_CONTROL_SERVO:
1773 logging.info('Setting servo port J10 to %s', state)
1774 self.servo.set('prtctl3_pwren', state.lower())
1775 time.sleep(self._USB_POWER_TIMEOUT)
1776 elif power_method == self.POWER_CONTROL_MANUAL:
1777 logging.info('You have %d seconds to set the AC power to %s.',
1778 self._POWER_CYCLE_TIMEOUT, state)
1779 time.sleep(self._POWER_CYCLE_TIMEOUT)
Garry Wang5e5538a2019-04-08 15:36:18 -07001780 elif power_method == self.POWER_CONTROL_CCD:
1781 servo_role = 'src' if state == 'ON' else 'snk'
1782 logging.info('servo ccd power pass through detected,'
1783 ' changing servo_role to %s.', servo_role)
1784 self.servo.set_servo_v4_role(servo_role)
1785 if not self.ping_wait_up(timeout=self._CHANGE_SERVO_ROLE_TIMEOUT):
Garry Wang94bf9de2019-06-10 17:23:37 -07001786 # Make sure we don't leave DUT with no power(servo_role=snk)
1787 # when DUT is not pingable, as we raise a exception here
1788 # that may break a power cycle in the middle.
1789 self.servo.set_servo_v4_role('src')
Garry Wang5e5538a2019-04-08 15:36:18 -07001790 raise error.AutoservError(
1791 'DUT failed to regain network connection after %d seconds.'
1792 % self._CHANGE_SERVO_ROLE_TIMEOUT)
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001793 else:
1794 if not self.has_power():
1795 raise error.TestFail('DUT does not have RPM connected.')
Garry Wangad4d4fd2019-01-30 17:00:38 -08001796 self._add_rpm_changed_tag()
Garry Wang5e5538a2019-04-08 15:36:18 -07001797 rpm_client.set_power(self, state, timeout_mins=5)
Simran Basid5e5e272012-09-24 15:23:59 -07001798
1799
Garry Wang5e5538a2019-04-08 15:36:18 -07001800 def power_off(self, power_method=None):
1801 """Turn off power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001802
1803 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001804 use. By default "RPM" or "CCD" will be used based
1805 on servo type. Valid values from
1806 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001807
1808 """
1809 self._set_power('OFF', power_method)
Simran Basid5e5e272012-09-24 15:23:59 -07001810
1811
Garry Wang5e5538a2019-04-08 15:36:18 -07001812 def power_on(self, power_method=None):
1813 """Turn on power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001814
1815 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001816 use. By default "RPM" or "CCD" will be used based
1817 on servo type. Valid values from
1818 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001819
1820 """
1821 self._set_power('ON', power_method)
1822
1823
Garry Wang5e5538a2019-04-08 15:36:18 -07001824 def power_cycle(self, power_method=None):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001825 """Cycle power to this host by turning it OFF, then ON.
1826
1827 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07001828 use. By default "RPM" or "CCD" will be used based
1829 on servo type. Valid values from
1830 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001831
1832 """
Garry Wang5e5538a2019-04-08 15:36:18 -07001833 if not power_method:
1834 power_method = self.get_default_power_method()
1835
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001836 if power_method in (self.POWER_CONTROL_SERVO,
Garry Wang5e5538a2019-04-08 15:36:18 -07001837 self.POWER_CONTROL_MANUAL,
1838 self.POWER_CONTROL_CCD):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08001839 self.power_off(power_method=power_method)
1840 time.sleep(self._POWER_CYCLE_TIMEOUT)
1841 self.power_on(power_method=power_method)
1842 else:
Garry Wangad4d4fd2019-01-30 17:00:38 -08001843 self._add_rpm_changed_tag()
1844 rpm_client.set_power(self, 'CYCLE')
Simran Basic6f1f7a2012-10-16 10:47:46 -07001845
1846
Mary Ruthvende14a8b2019-08-23 12:43:52 -07001847 def get_platform_from_fwid(self):
1848 """Determine the platform from the crossystem fwid.
1849
1850 @returns a string representing this host's platform.
1851 """
1852 # Look at the firmware for non-unibuild cases or if mosys fails.
1853 crossystem = utils.Crossystem(self)
1854 crossystem.init()
1855 # Extract fwid value and use the leading part as the platform id.
1856 # fwid generally follow the format of {platform}.{firmware version}
1857 # Example: Alex.X.YYY.Z or Google_Alex.X.YYY.Z
1858 platform = crossystem.fwid().split('.')[0].lower()
1859 # Newer platforms start with 'Google_' while the older ones do not.
1860 return platform.replace('google_', '')
1861
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08001862
Simran Basic6f1f7a2012-10-16 10:47:46 -07001863 def get_platform(self):
1864 """Determine the correct platform label for this host.
1865
1866 @returns a string representing this host's platform.
1867 """
C Shapiroed87c6f2018-04-19 09:13:58 -06001868 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
1869 run_method=self.run)
C Shapiroed87c6f2018-04-19 09:13:58 -06001870 platform = ''
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08001871 if release_info.get('CHROMEOS_RELEASE_UNIBUILD') == '1':
1872 platform = self.get_platform_from_mosys()
Mary Ruthvende14a8b2019-08-23 12:43:52 -07001873 return platform if platform else self.get_platform_from_fwid()
Simran Basic6f1f7a2012-10-16 10:47:46 -07001874
1875
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08001876 def get_platform_from_mosys(self):
1877 """Get the host platform from mosys command.
1878
1879 @returns a string representing this host's platform.
1880 """
1881 cmd = 'mosys platform model'
1882 result = self.run(command=cmd, ignore_status=True)
1883 return result.stdout.strip() if result.exit_status == 0 else ''
1884
1885
Hung-ying Tyanb1328032014-04-01 14:18:54 +08001886 def get_architecture(self):
1887 """Determine the correct architecture label for this host.
1888
1889 @returns a string representing this host's architecture.
1890 """
1891 crossystem = utils.Crossystem(self)
1892 crossystem.init()
1893 return crossystem.arch()
1894
1895
Luis Lozano40b7d0d2014-01-17 15:12:06 -08001896 def get_chrome_version(self):
1897 """Gets the Chrome version number and milestone as strings.
1898
1899 Invokes "chrome --version" to get the version number and milestone.
1900
1901 @return A tuple (chrome_ver, milestone) where "chrome_ver" is the
1902 current Chrome version number as a string (in the form "W.X.Y.Z")
1903 and "milestone" is the first component of the version number
1904 (the "W" from "W.X.Y.Z"). If the version number cannot be parsed
1905 in the "W.X.Y.Z" format, the "chrome_ver" will be the full output
1906 of "chrome --version" and the milestone will be the empty string.
1907
1908 """
MK Ryu35d661e2014-09-25 17:44:10 -07001909 version_string = self.run(client_constants.CHROME_VERSION_COMMAND).stdout
Luis Lozano40b7d0d2014-01-17 15:12:06 -08001910 return utils.parse_chrome_version(version_string)
1911
J. Richard Barnetted2af5852016-02-05 15:03:10 -08001912
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001913 def get_ec_version(self):
1914 """Get the ec version as strings.
1915
1916 @returns a string representing this host's ec version.
1917 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08001918 command = 'mosys ec info -s fw_version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08001919 result = self.run(command, ignore_status=True)
1920 if result.exit_status != 0:
1921 return ''
1922 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001923
1924
1925 def get_firmware_version(self):
1926 """Get the firmware version as strings.
1927
1928 @returns a string representing this host's firmware version.
1929 """
1930 crossystem = utils.Crossystem(self)
1931 crossystem.init()
1932 return crossystem.fwid()
1933
1934
1935 def get_hardware_revision(self):
1936 """Get the hardware revision as strings.
1937
1938 @returns a string representing this host's hardware revision.
1939 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08001940 command = 'mosys platform version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08001941 result = self.run(command, ignore_status=True)
1942 if result.exit_status != 0:
1943 return ''
1944 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08001945
1946
1947 def get_kernel_version(self):
1948 """Get the kernel version as strings.
1949
1950 @returns a string representing this host's kernel version.
1951 """
1952 return self.run('uname -r').stdout.strip()
1953
1954
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08001955 def get_cpu_name(self):
1956 """Get the cpu name as strings.
1957
1958 @returns a string representing this host's cpu name.
1959 """
1960
1961 # Try get cpu name from device tree first
1962 if self.path_exists('/proc/device-tree/compatible'):
1963 command = ' | '.join(
1964 ["sed -e 's/\\x0/\\n/g' /proc/device-tree/compatible",
1965 'tail -1'])
1966 return self.run(command).stdout.strip().replace(',', ' ')
1967
1968 # Get cpu name from uname -p
1969 command = 'uname -p'
1970 ret = self.run(command).stdout.strip()
1971
1972 # 'uname -p' return variant of unknown or amd64 or x86_64 or i686
1973 # Try get cpu name from /proc/cpuinfo instead
1974 if re.match("unknown|amd64|[ix][0-9]?86(_64)?", ret, re.IGNORECASE):
1975 command = "grep model.name /proc/cpuinfo | cut -f 2 -d: | head -1"
1976 self = self.run(command).stdout.strip()
1977
1978 # Remove bloat from CPU name, for example
1979 # Intel(R) Core(TM) i5-7Y57 CPU @ 1.20GHz -> Intel Core i5-7Y57
1980 # Intel(R) Xeon(R) CPU E5-2690 v4 @ 2.60GHz -> Intel Xeon E5-2690 v4
1981 # AMD A10-7850K APU with Radeon(TM) R7 Graphics -> AMD A10-7850K
1982 # AMD GX-212JC SOC with Radeon(TM) R2E Graphics -> AMD GX-212JC
1983 trim_re = r' (@|processor|apu|soc|radeon).*|\(.*?\)| cpu'
1984 return re.sub(trim_re, '', ret, flags=re.IGNORECASE)
1985
1986
1987 def get_screen_resolution(self):
1988 """Get the screen(s) resolution as strings.
1989 In case of more than 1 monitor, return resolution for each monitor
1990 separate with plus sign.
1991
1992 @returns a string representing this host's screen(s) resolution.
1993 """
1994 command = 'for f in /sys/class/drm/*/*/modes; do head -1 $f; done'
1995 ret = self.run(command, ignore_status=True)
1996 # We might have Chromebox without a screen
1997 if ret.exit_status != 0:
1998 return ''
1999 return ret.stdout.strip().replace('\n', '+')
2000
2001
2002 def get_mem_total_gb(self):
2003 """Get total memory available in the system in GiB (2^20).
2004
2005 @returns an integer representing total memory
2006 """
2007 mem_total_kb = self.read_from_meminfo('MemTotal')
2008 kb_in_gb = float(2 ** 20)
2009 return int(round(mem_total_kb / kb_in_gb))
2010
2011
2012 def get_disk_size_gb(self):
2013 """Get size of disk in GB (10^9)
2014
2015 @returns an integer representing size of disk, 0 in Error Case
2016 """
2017 command = 'grep $(rootdev -s -d | cut -f3 -d/)$ /proc/partitions'
2018 result = self.run(command, ignore_status=True)
2019 if result.exit_status != 0:
2020 return 0
2021 _, _, block, _ = re.split(r' +', result.stdout.strip())
2022 byte_per_block = 1024.0
2023 disk_kb_in_gb = 1e9
2024 return int(int(block) * byte_per_block / disk_kb_in_gb + 0.5)
2025
2026
2027 def get_battery_size(self):
2028 """Get size of battery in Watt-hour via sysfs
2029
2030 This method assumes that battery support voltage_min_design and
2031 charge_full_design sysfs.
2032
2033 @returns a float representing Battery size, 0 if error.
2034 """
2035 # sysfs report data in micro scale
2036 battery_scale = 1e6
2037
2038 command = 'cat /sys/class/power_supply/*/voltage_min_design'
2039 result = self.run(command, ignore_status=True)
2040 if result.exit_status != 0:
2041 return 0
2042 voltage = float(result.stdout.strip()) / battery_scale
2043
2044 command = 'cat /sys/class/power_supply/*/charge_full_design'
2045 result = self.run(command, ignore_status=True)
2046 if result.exit_status != 0:
2047 return 0
2048 amphereHour = float(result.stdout.strip()) / battery_scale
2049
2050 return voltage * amphereHour
2051
2052
2053 def get_low_battery_shutdown_percent(self):
2054 """Get the percent-based low-battery shutdown threshold.
2055
2056 @returns a float representing low-battery shutdown percent, 0 if error.
2057 """
2058 ret = 0.0
2059 try:
2060 command = 'check_powerd_config --low_battery_shutdown_percent'
2061 ret = float(self.run(command).stdout)
2062 except error.CmdError:
2063 logging.debug("Can't run %s", command)
2064 except ValueError:
2065 logging.debug("Didn't get number from %s", command)
2066
2067 return ret
2068
2069
Puthikorn Voravootivat09c83d72018-08-10 15:58:32 -07002070 def has_hammer(self):
2071 """Check whether DUT has hammer device or not.
2072
2073 @returns boolean whether device has hammer or not
2074 """
2075 command = 'grep Hammer /sys/bus/usb/devices/*/product'
2076 return self.run(command, ignore_status=True).exit_status == 0
2077
2078
Niranjan Kumar34618872017-05-31 12:57:09 -07002079 def is_chrome_switch_present(self, switch):
David Haddock3ce538e2017-06-22 13:37:05 -07002080 """Returns True if the specified switch was provided to Chrome.
2081
2082 @param switch The chrome switch to search for.
2083 """
Niranjan Kumar34618872017-05-31 12:57:09 -07002084
Niranjan Kumar5f23fe92017-06-22 15:18:55 -07002085 command = 'pgrep -x -f -c "/opt/google/chrome/chrome.*%s.*"' % switch
2086 return self.run(command, ignore_status=True).exit_status == 0
Niranjan Kumar34618872017-05-31 12:57:09 -07002087
2088
2089 def oobe_triggers_update(self):
2090 """Returns True if this host has an OOBE flow during which
2091 it will perform an update check and perhaps an update.
2092 One example of such a flow is Hands-Off Zero-Touch Enrollment.
2093 As more such flows are developed, code handling them needs
2094 to be added here.
2095
2096 @return Boolean indicating whether this host's OOBE triggers an update.
2097 """
2098 return self.is_chrome_switch_present(
2099 '--enterprise-enable-zero-touch-enrollment=hands-off')
2100
2101
Kevin Chenga2619dc2016-03-28 11:42:08 -07002102 # TODO(kevcheng): change this to just return the board without the
2103 # 'board:' prefix and fix up all the callers. Also look into removing the
2104 # need for this method.
Simran Basic6f1f7a2012-10-16 10:47:46 -07002105 def get_board(self):
2106 """Determine the correct board label for this host.
2107
2108 @returns a string representing this host's board.
2109 """
2110 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
2111 run_method=self.run)
J. Richard Barnetted2af5852016-02-05 15:03:10 -08002112 return (ds_constants.BOARD_PREFIX +
2113 release_info['CHROMEOS_RELEASE_BOARD'])
Simran Basic6f1f7a2012-10-16 10:47:46 -07002114
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07002115 def get_channel(self):
2116 """Determine the correct channel label for this host.
Simran Basic6f1f7a2012-10-16 10:47:46 -07002117
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07002118 @returns: a string represeting this host's build channel.
2119 (stable, dev, beta). None on fail.
2120 """
2121 return lsbrelease_utils.get_chromeos_channel(
2122 lsb_release_content=self._get_lsb_release_content())
Kevin Chenga328da62016-03-31 10:49:04 -07002123
Kevin Chenga328da62016-03-31 10:49:04 -07002124 def get_power_supply(self):
2125 """
2126 Determine what type of power supply the host has
2127
2128 @returns a string representing this host's power supply.
2129 'power:battery' when the device has a battery intended for
2130 extended use
2131 'power:AC_primary' when the device has a battery not intended
2132 for extended use (for moving the machine, etc)
2133 'power:AC_only' when the device has no battery at all.
2134 """
2135 psu = self.run(command='mosys psu type', ignore_status=True)
2136 if psu.exit_status:
2137 # The psu command for mosys is not included for all platforms. The
2138 # assumption is that the device will have a battery if the command
2139 # is not found.
2140 return 'power:battery'
2141
2142 psu_str = psu.stdout.strip()
2143 if psu_str == 'unknown':
2144 return None
2145
2146 return 'power:%s' % psu_str
2147
2148
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08002149 def has_battery(self):
2150 """Determine if DUT has a battery.
2151
2152 Returns:
2153 Boolean, False if known not to have battery, True otherwise.
2154 """
2155 rv = True
2156 power_supply = self.get_power_supply()
2157 if power_supply == 'power:battery':
2158 _NO_BATTERY_BOARD_TYPE = ['CHROMEBOX', 'CHROMEBIT', 'CHROMEBASE']
2159 board_type = self.get_board_type()
2160 if board_type in _NO_BATTERY_BOARD_TYPE:
2161 logging.warn('Do NOT believe type %s has battery. '
2162 'See debug for mosys details', board_type)
2163 psu = self.system_output('mosys -vvvv psu type',
2164 ignore_status=True)
2165 logging.debug(psu)
2166 rv = False
2167 elif power_supply == 'power:AC_only':
2168 rv = False
2169
2170 return rv
2171
2172
Kevin Chenga328da62016-03-31 10:49:04 -07002173 def get_servo(self):
2174 """Determine if the host has a servo attached.
2175
2176 If the host has a working servo attached, it should have a servo label.
2177
2178 @return: string 'servo' if the host has servo attached. Otherwise,
2179 returns None.
2180 """
2181 return 'servo' if self._servo_host else None
2182
2183
Kevin Chenga328da62016-03-31 10:49:04 -07002184 def has_internal_display(self):
2185 """Determine if the device under test is equipped with an internal
2186 display.
2187
2188 @return: 'internal_display' if one is present; None otherwise.
2189 """
2190 from autotest_lib.client.cros.graphics import graphics_utils
2191 from autotest_lib.client.common_lib import utils as common_utils
2192
2193 def __system_output(cmd):
2194 return self.run(cmd).stdout
2195
2196 def __read_file(remote_path):
2197 return self.run('cat %s' % remote_path).stdout
2198
2199 # Hijack the necessary client functions so that we can take advantage
2200 # of the client lib here.
2201 # FIXME: find a less hacky way than this
2202 original_system_output = utils.system_output
2203 original_read_file = common_utils.read_file
2204 utils.system_output = __system_output
2205 common_utils.read_file = __read_file
2206 try:
2207 return ('internal_display' if graphics_utils.has_internal_display()
2208 else None)
2209 finally:
2210 utils.system_output = original_system_output
2211 common_utils.read_file = original_read_file
2212
2213
Dan Shi85276d42014-04-08 22:11:45 -07002214 def is_boot_from_usb(self):
2215 """Check if DUT is boot from USB.
2216
2217 @return: True if DUT is boot from usb.
2218 """
2219 device = self.run('rootdev -s -d').stdout.strip()
2220 removable = int(self.run('cat /sys/block/%s/removable' %
2221 os.path.basename(device)).stdout.strip())
2222 return removable == 1
Helen Zhang17dae2b2014-11-11 09:25:52 -08002223
2224
2225 def read_from_meminfo(self, key):
Dan Shi49ca0932014-11-14 11:22:27 -08002226 """Return the memory info from /proc/meminfo
Helen Zhang17dae2b2014-11-11 09:25:52 -08002227
2228 @param key: meminfo requested
2229
2230 @return the memory value as a string
2231
2232 """
Helen Zhang17dae2b2014-11-11 09:25:52 -08002233 meminfo = self.run('grep %s /proc/meminfo' % key).stdout.strip()
2234 logging.debug('%s', meminfo)
2235 return int(re.search(r'\d+', meminfo).group(0))
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002236
2237
Rohit Makasana98e696f2016-06-03 18:48:10 -07002238 def get_cpu_arch(self):
2239 """Returns CPU arch of the device.
2240
2241 @return CPU architecture of the DUT.
2242 """
Allen Li2c32d6b2017-02-03 15:28:10 -08002243 # Add CPUs by following logic in client/bin/utils.py.
Rohit Makasana98e696f2016-06-03 18:48:10 -07002244 if self.run("grep '^flags.*:.* lm .*' /proc/cpuinfo",
2245 ignore_status=True).stdout:
2246 return 'x86_64'
2247 if self.run("grep -Ei 'ARM|CPU implementer' /proc/cpuinfo",
2248 ignore_status=True).stdout:
2249 return 'arm'
2250 return 'i386'
2251
2252
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002253 def get_board_type(self):
2254 """
2255 Get the DUT's device type from /etc/lsb-release.
Danny Chan471a8d12015-08-18 14:57:41 -07002256 DEVICETYPE can be one of CHROMEBOX, CHROMEBASE, CHROMEBOOK or more.
2257
2258 @return value of DEVICETYPE param from lsb-release.
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002259 """
Danny Chan471a8d12015-08-18 14:57:41 -07002260 device_type = self.run('grep DEVICETYPE /etc/lsb-release',
2261 ignore_status=True).stdout
2262 if device_type:
Kalin Stoyanov524310b2015-08-21 16:24:04 -07002263 return device_type.split('=')[-1].strip()
Danny Chan471a8d12015-08-18 14:57:41 -07002264 return ''
Gilad Arnolda76bef02015-09-29 13:55:15 -07002265
2266
Rohit Makasanadf0a3a32017-06-30 13:55:18 -07002267 def get_arc_version(self):
2268 """Return ARC version installed on the DUT.
2269
2270 @returns ARC version as string if the CrOS build has ARC, else None.
2271 """
2272 arc_version = self.run('grep CHROMEOS_ARC_VERSION /etc/lsb-release',
2273 ignore_status=True).stdout
2274 if arc_version:
2275 return arc_version.split('=')[-1].strip()
2276 return None
2277
2278
Gilad Arnolda76bef02015-09-29 13:55:15 -07002279 def get_os_type(self):
2280 return 'cros'
Simran Basia5522a32015-10-06 11:01:24 -07002281
2282
Kevin Chenga2619dc2016-03-28 11:42:08 -07002283 def get_labels(self):
Kevin Chengf8660142016-08-12 10:17:41 -07002284 """Return the detected labels on the host."""
Kevin Chenga2619dc2016-03-28 11:42:08 -07002285 return self.labels.get_labels(self)
Garry Wang5e5538a2019-04-08 15:36:18 -07002286
2287
2288 def get_default_power_method(self):
2289 """
2290 Get the default power method for power_on/off/cycle() methods.
2291 @return POWER_CONTROL_RPM or POWER_CONTROL_CCD
2292 """
2293 if not self._default_power_method:
Garry Wang1a004aa2019-05-16 22:56:51 -07002294 self._default_power_method = self.POWER_CONTROL_RPM
Ruben Rodriguez Buchillon3eeeab32019-10-02 15:29:58 -07002295 if self.servo and self.servo.supports_built_in_pd_control():
2296 self._default_power_method = self.POWER_CONTROL_CCD
2297 else:
2298 logging.debug('Either servo is unitialized or the servo '
2299 'setup does not support pd controls. Falling '
2300 'back to default RPM method.')
Garry Wang5e5538a2019-04-08 15:36:18 -07002301 return self._default_power_method
Puthikorn Voravootivat4a054792019-12-13 16:44:17 -08002302
2303
2304 def find_usb_devices(self, idVendor, idProduct):
2305 """
2306 Get usb device sysfs name for specific device.
2307
2308 @param idVendor Vendor ID to search in sysfs directory.
2309 @param idProduct Product ID to search in sysfs directory.
2310
2311 @return Usb node names in /sys/bus/usb/drivers/usb/ that match.
2312 """
2313 # Look for matching file and cut at position 7 to get dir name.
2314 grep_cmd = 'grep {} /sys/bus/usb/drivers/usb/*/{} | cut -f 7 -d /'
2315
2316 vendor_cmd = grep_cmd.format(idVendor, 'idVendor')
2317 product_cmd = grep_cmd.format(idProduct, 'idProduct')
2318
2319 # Use uniq -d to print duplicate line from both command
2320 cmd = 'sort <({}) <({}) | uniq -d'.format(vendor_cmd, product_cmd)
2321
2322 return self.run(cmd, ignore_status=True).stdout.strip().split('\n')
2323
2324
2325 def bind_usb_device(self, usb_node):
2326 """
2327 Bind usb device
2328
2329 @param usb_node Node name in /sys/bus/usb/drivers/usb/
2330 """
2331 cmd = 'echo {} > /sys/bus/usb/drivers/usb/bind'.format(usb_node)
2332 self.run(cmd, ignore_status=True)
2333
2334
2335 def unbind_usb_device(self, usb_node):
2336 """
2337 Unbind usb device
2338
2339 @param usb_node Node name in /sys/bus/usb/drivers/usb/
2340 """
2341 cmd = 'echo {} > /sys/bus/usb/drivers/usb/unbind'.format(usb_node)
2342 self.run(cmd, ignore_status=True)
2343
2344
2345 def get_wlan_ip(self):
2346 """
2347 Get ip address of wlan interface.
2348
2349 @return ip address of wlan or empty string if wlan is not connected.
2350 """
2351 cmds = [
2352 'iw dev', # List wlan physical device
2353 'grep Interface', # Grep only interface name
2354 'cut -f 2 -d" "', # Cut the name part
2355 'xargs ifconfig', # Feed it to ifconfig to get ip
2356 'grep -oE "inet [0-9.]+"', # Grep only ipv4
2357 'cut -f 2 -d " "' # Cut the ip part
2358 ]
2359 return self.run(' | '.join(cmds), ignore_status=True).stdout.strip()
Puthikorn Voravootivatcd0dc9e2020-01-22 14:22:22 -08002360
2361 def connect_to_wifi(self, ssid, passphrase=None, security=None):
2362 """
2363 Connect to wifi network
2364
2365 @param ssid SSID of the wifi network.
2366 @param passphrase Passphrase of the wifi network. None if not existed.
2367 @param security Security of the wifi network. Default to "psk" if
2368 passphase is given without security. Possible values
2369 are "none", "psk", "802_1x".
2370
2371 @return True if succeed, False if not.
2372 """
2373 cmd = '/usr/local/autotest/cros/scripts/wifi connect ' + ssid
2374 if passphrase:
2375 cmd += ' ' + passphrase
2376 if security:
2377 cmd += ' ' + security
2378 return self.run(cmd, ignore_status=True).exit_status == 0