blob: c41d152b7a42ab25f0e60363c0740d01ce5e2609 [file] [log] [blame]
Derek Beckettf73baca2020-08-19 15:08:47 -07001# Lint as: python2, python3
J. Richard Barnette24adbf42012-04-11 15:04:53 -07002# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Dale Curtisaa5eedb2011-08-23 16:18:52 -07003# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
Derek Beckettf73baca2020-08-19 15:08:47 -07006from __future__ import absolute_import
7from __future__ import division
8from __future__ import print_function
9
J. Richard Barnette1d78b012012-05-15 13:56:30 -070010import logging
Dan Shi0f466e82013-02-22 15:44:58 -080011import os
Simran Basid5e5e272012-09-24 15:23:59 -070012import re
Vincent Palatindf2372c2016-10-07 17:03:00 +020013import sys
Otabek Kasimovb7cb8422020-12-23 02:38:32 -080014import six
J. Richard Barnette134ec2c2012-04-25 12:59:37 -070015import time
16
mussa584b4462014-06-20 15:13:28 -070017import common
J. Richard Barnette45e93de2012-04-11 17:24:15 -070018from autotest_lib.client.bin import utils
Dan Shi9cb0eec2014-06-03 09:04:50 -070019from autotest_lib.client.common_lib import autotemp
Richard Barnette0c73ffc2012-11-19 15:21:18 -080020from autotest_lib.client.common_lib import error
21from autotest_lib.client.common_lib import global_config
J. Richard Barnette91137f02016-03-10 16:52:26 -080022from autotest_lib.client.common_lib import hosts
Dan Shi549fb822015-03-24 18:01:11 -070023from autotest_lib.client.common_lib import lsbrelease_utils
Otabek Kasimov6825b762020-06-23 23:42:44 -070024from autotest_lib.client.common_lib import utils as common_utils
Greg Edelstona7b05d12020-04-01 16:00:51 -060025from autotest_lib.client.common_lib.cros import cros_config
Richard Barnette03a0c132012-11-05 12:40:35 -080026from autotest_lib.client.common_lib.cros import dev_server
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -070027from autotest_lib.client.common_lib.cros import retry
Hsinyu Chaoe0b08e62015-08-11 10:50:37 +000028from autotest_lib.client.cros import constants as client_constants
J. Richard Barnette84890bd2014-02-21 11:05:47 -080029from autotest_lib.client.cros import cros_ui
Simran Basi5ace6f22016-01-06 17:30:44 -080030from autotest_lib.server import afe_utils
Dan Shia1ecd5c2013-06-06 11:21:31 -070031from autotest_lib.server import utils as server_utils
Dan Shi9cb0eec2014-06-03 09:04:50 -070032from autotest_lib.server.cros import provision
Scott Zawalski89c44dd2013-02-26 09:28:02 -050033from autotest_lib.server.cros.dynamic_suite import constants as ds_constants
Simran Basi5e6339a2013-03-21 11:34:32 -070034from autotest_lib.server.cros.dynamic_suite import tools, frontend_wrappers
Garry Wang1a493d82020-08-31 21:01:19 -070035from autotest_lib.server.cros.device_health_profile import device_health_profile
Garry Wanga2e78172020-09-09 23:49:07 -070036from autotest_lib.server.cros.device_health_profile import profile_constants
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070037from autotest_lib.server.cros.servo import pdtester
Fang Deng96667ca2013-08-01 17:46:18 -070038from autotest_lib.server.hosts import abstract_ssh
Kevin Chenga2619dc2016-03-28 11:42:08 -070039from autotest_lib.server.hosts import base_label
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +080040from autotest_lib.server.hosts import chameleon_host
Otabek Kasimov832d9162020-07-27 19:24:57 -070041from autotest_lib.server.hosts import cros_constants
Richard Barnetted31580e2018-05-14 19:58:00 +000042from autotest_lib.server.hosts import cros_label
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -080043from autotest_lib.server.hosts import cros_repair
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -070044from autotest_lib.server.hosts import pdtester_host
Fang Deng5d518f42013-08-02 14:04:32 -070045from autotest_lib.server.hosts import servo_host
Garry Wang11b5e872020-03-11 15:14:08 -070046from autotest_lib.server.hosts import servo_constants
Simran Basidcff4252012-11-20 16:13:20 -080047from autotest_lib.site_utils.rpm_control_system import rpm_client
Otabek Kasimov808cd832020-05-28 18:27:46 -070048from autotest_lib.site_utils.admin_audit import constants as audit_const
Otabek Kasimov27bb2862020-08-10 14:40:45 -070049from autotest_lib.site_utils.admin_audit import verifiers as audit_verify
Derek Beckettf73baca2020-08-19 15:08:47 -070050from six.moves import zip
Simran Basid5e5e272012-09-24 15:23:59 -070051
Simran Basi382506b2016-09-13 14:58:15 -070052# In case cros_host is being ran via SSP on an older Moblab version with an
53# older chromite version.
54try:
55 from chromite.lib import metrics
Dan Shi5e2efb72017-02-07 11:40:23 -080056except ImportError:
Congbin Guo42427612019-02-12 10:22:06 -080057 metrics = utils.metrics_mock
Dan Shi5e2efb72017-02-07 11:40:23 -080058
Simran Basid5e5e272012-09-24 15:23:59 -070059
Dan Shib8540a52015-07-16 14:18:23 -070060CONFIG = global_config.global_config
61
beepsc87ff602013-07-31 21:53:00 -070062class FactoryImageCheckerException(error.AutoservError):
63 """Exception raised when an image is a factory image."""
64 pass
65
66
Fang Deng0ca40e22013-08-27 17:47:44 -070067class CrosHost(abstract_ssh.AbstractSSHHost):
J. Richard Barnette45e93de2012-04-11 17:24:15 -070068 """Chromium OS specific subclass of Host."""
69
Simran Basi5ace6f22016-01-06 17:30:44 -080070 VERSION_PREFIX = provision.CROS_VERSION_PREFIX
71
Scott Zawalski62bacae2013-03-05 10:40:32 -050072 _AFE = frontend_wrappers.RetryingAFE(timeout_min=5, delay_sec=10)
J. Richard Barnette45e93de2012-04-11 17:24:15 -070073
Richard Barnette03a0c132012-11-05 12:40:35 -080074 # Timeout values (in seconds) associated with various Chrome OS
75 # state changes.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -070076 #
Richard Barnette0c73ffc2012-11-19 15:21:18 -080077 # In general, a good rule of thumb is that the timeout can be up
78 # to twice the typical measured value on the slowest platform.
79 # The times here have not necessarily been empirically tested to
80 # meet this criterion.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070081 #
82 # SLEEP_TIMEOUT: Time to allow for suspend to memory.
Richard Barnette0c73ffc2012-11-19 15:21:18 -080083 # RESUME_TIMEOUT: Time to allow for resume after suspend, plus
84 # time to restart the netwowrk.
J. Richard Barnette84890bd2014-02-21 11:05:47 -080085 # SHUTDOWN_TIMEOUT: Time to allow for shut down.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070086 # BOOT_TIMEOUT: Time to allow for boot from power off. Among
Richard Barnette0c73ffc2012-11-19 15:21:18 -080087 # other things, this must account for the 30 second dev-mode
J. Richard Barnette417cc792015-10-01 09:56:36 -070088 # screen delay, time to start the network on the DUT, and the
89 # ssh timeout of 120 seconds.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070090 # USB_BOOT_TIMEOUT: Time to allow for boot from a USB device,
Richard Barnette0c73ffc2012-11-19 15:21:18 -080091 # including the 30 second dev-mode delay and time to start the
J. Richard Barnetted4649c62013-03-06 17:42:27 -080092 # network.
beepsf079cfb2013-09-18 17:49:51 -070093 # INSTALL_TIMEOUT: Time to allow for chromeos-install.
J. Richard Barnette84890bd2014-02-21 11:05:47 -080094 # POWERWASH_BOOT_TIMEOUT: Time to allow for a reboot that
95 # includes powerwash.
J. Richard Barnetteeb69d722012-06-18 17:29:44 -070096
97 SLEEP_TIMEOUT = 2
J. Richard Barnetted4649c62013-03-06 17:42:27 -080098 RESUME_TIMEOUT = 10
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +080099 SHUTDOWN_TIMEOUT = 10
J. Richard Barnette417cc792015-10-01 09:56:36 -0700100 BOOT_TIMEOUT = 150
J. Richard Barnette5bab5f52015-08-03 13:14:38 -0700101 USB_BOOT_TIMEOUT = 300
J. Richard Barnette7817b052014-08-28 09:47:29 -0700102 INSTALL_TIMEOUT = 480
Dan Shi2c88eed2013-11-12 10:18:38 -0800103 POWERWASH_BOOT_TIMEOUT = 60
Chris Sosab76e0ee2013-05-22 16:55:41 -0700104
Dan Shica503482015-03-30 17:23:25 -0700105 # Minimum OS version that supports server side packaging. Older builds may
106 # not have server side package built or with Autotest code change to support
107 # server-side packaging.
Dan Shib8540a52015-07-16 14:18:23 -0700108 MIN_VERSION_SUPPORT_SSP = CONFIG.get_config_value(
Dan Shiced09e42015-04-17 16:09:34 -0700109 'AUTOSERV', 'min_version_support_ssp', type=int)
Dan Shica503482015-03-30 17:23:25 -0700110
Dana Goyettec172b172020-07-29 16:26:15 -0700111 USE_FSFREEZE = CONFIG.get_config_value(
Dana Goyette6242cb32020-09-23 11:02:57 -0700112 'CROS', 'enable_fs_freeze', type=bool, default=False)
Dana Goyettec172b172020-07-29 16:26:15 -0700113
J. Richard Barnette84890bd2014-02-21 11:05:47 -0800114 # REBOOT_TIMEOUT: How long to wait for a reboot.
115 #
Chris Sosab76e0ee2013-05-22 16:55:41 -0700116 # We have a long timeout to ensure we don't flakily fail due to other
117 # issues. Shorter timeouts are vetted in platform_RebootAfterUpdate.
Simran Basi1160e2c2013-10-04 16:00:24 -0700118 # TODO(sbasi - crbug.com/276094) Restore to 5 mins once the 'host did not
119 # return from reboot' bug is solved.
120 REBOOT_TIMEOUT = 480
Chris Sosab76e0ee2013-05-22 16:55:41 -0700121
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800122 # _USB_POWER_TIMEOUT: Time to allow for USB to power toggle ON and OFF.
123 # _POWER_CYCLE_TIMEOUT: Time to allow for manual power cycle.
Garry Wang5e5538a2019-04-08 15:36:18 -0700124 # _CHANGE_SERVO_ROLE_TIMEOUT: Time to allow DUT regain network connection
125 # since changing servo role will reset USB state
126 # and causes temporary ethernet drop.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800127 _USB_POWER_TIMEOUT = 5
128 _POWER_CYCLE_TIMEOUT = 10
Garry Wang5e5538a2019-04-08 15:36:18 -0700129 _CHANGE_SERVO_ROLE_TIMEOUT = 180
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800130
Fang Dengdeba14f2014-11-14 11:54:09 -0800131 _RPM_HOSTNAME_REGEX = ('chromeos(\d+)(-row(\d+))?-rack(\d+[a-z]*)'
132 '-host(\d+)')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -0700133
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -0800134 # Constants used in ping_wait_up() and ping_wait_down().
135 #
136 # _PING_WAIT_COUNT is the approximate number of polling
137 # cycles to use when waiting for a host state change.
138 #
139 # _PING_STATUS_DOWN and _PING_STATUS_UP are names used
140 # for arguments to the internal _ping_wait_for_status()
141 # method.
142 _PING_WAIT_COUNT = 40
143 _PING_STATUS_DOWN = False
144 _PING_STATUS_UP = True
145
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800146 # Allowed values for the power_method argument.
147
Garry Wang5e5538a2019-04-08 15:36:18 -0700148 # POWER_CONTROL_RPM: Used in power_off/on/cycle() methods, default for all
149 # DUTs except those with servo_v4 CCD.
150 # POWER_CONTROL_CCD: Used in power_off/on/cycle() methods, default for all
151 # DUTs with servo_v4 CCD.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800152 # POWER_CONTROL_SERVO: Used in set_power() and power_cycle() methods.
153 # POWER_CONTROL_MANUAL: Used in set_power() and power_cycle() methods.
154 POWER_CONTROL_RPM = 'RPM'
Garry Wang5e5538a2019-04-08 15:36:18 -0700155 POWER_CONTROL_CCD = 'CCD'
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800156 POWER_CONTROL_SERVO = 'servoj10'
157 POWER_CONTROL_MANUAL = 'manual'
158
159 POWER_CONTROL_VALID_ARGS = (POWER_CONTROL_RPM,
Garry Wang5e5538a2019-04-08 15:36:18 -0700160 POWER_CONTROL_CCD,
Ismail Noorbasha07fdb612013-02-14 14:13:31 -0800161 POWER_CONTROL_SERVO,
162 POWER_CONTROL_MANUAL)
Richard Barnette0c73ffc2012-11-19 15:21:18 -0800163
Simran Basi5e6339a2013-03-21 11:34:32 -0700164 _RPM_OUTLET_CHANGED = 'outlet_changed'
165
Dan Shi9cb0eec2014-06-03 09:04:50 -0700166 # URL pattern to download firmware image.
Dan Shib8540a52015-07-16 14:18:23 -0700167 _FW_IMAGE_URL_PATTERN = CONFIG.get_config_value(
Dan Shi9cb0eec2014-06-03 09:04:50 -0700168 'CROS', 'firmware_url_pattern', type=str)
beeps687243d2013-07-18 15:29:27 -0700169
Brent Peterson1cb623a2020-01-09 13:14:28 -0800170 # Regular expression for extracting EC version string
171 _EC_REGEX = '(%s_\w*[-\.]\w*[-\.]\w*[-\.]\w*)'
172
173 # Regular expression for extracting BIOS version string
174 _BIOS_REGEX = '(%s\.\w*\.\w*\.\w*)'
175
Brent Petersonc70a1832020-01-24 15:54:35 -0800176 # Command to update firmware located on DUT
Namyoon Woo382e5892020-05-20 16:48:40 -0700177 _FW_UPDATE_CMD = 'chromeos-firmwareupdate --mode=recovery %s'
Brent Petersonc70a1832020-01-24 15:54:35 -0800178
J. Richard Barnette964fba02012-10-24 17:34:29 -0700179 @staticmethod
beeps46dadc92013-11-07 14:07:10 -0800180 def check_host(host, timeout=10):
181 """
182 Check if the given host is a chrome-os host.
183
184 @param host: An ssh host representing a device.
185 @param timeout: The timeout for the run command.
186
187 @return: True if the host device is chromeos.
188
beeps46dadc92013-11-07 14:07:10 -0800189 """
190 try:
Allen Liad719c12017-06-27 23:48:04 +0000191 result = host.run(
Simran Basi933c8af2015-04-29 14:05:07 -0700192 'grep -q CHROMEOS /etc/lsb-release && '
Garry Wange4b6d6e2019-06-17 17:08:46 -0700193 '! grep -q moblab /etc/lsb-release && '
Derek Beckett342e3e62021-01-05 17:17:23 -0800194 '! grep -q labstation /etc/lsb-release &&'
195 ' grep CHROMEOS_RELEASE_BOARD /etc/lsb-release',
196 ignore_status=True,
Laurence Goodby468de252017-06-08 17:22:53 -0700197 timeout=timeout).stdout
Derek Beckett342e3e62021-01-05 17:17:23 -0800198 if result:
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -0800199 return not (
200 lsbrelease_utils.is_jetstream(
Derek Beckett342e3e62021-01-05 17:17:23 -0800201 lsb_release_content=result) or
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -0800202 lsbrelease_utils.is_gce_board(
Derek Beckett342e3e62021-01-05 17:17:23 -0800203 lsb_release_content=result))
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -0800204
beeps46dadc92013-11-07 14:07:10 -0800205 except (error.AutoservRunError, error.AutoservSSHTimeout):
206 return False
Laurence Goodby468de252017-06-08 17:22:53 -0700207
208 return False
beeps46dadc92013-11-07 14:07:10 -0800209
210
211 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800212 def get_chameleon_arguments(args_dict):
213 """Extract chameleon options from `args_dict` and return the result.
214
215 Recommended usage:
216 ~~~~~~~~
217 args_dict = utils.args_to_dict(args)
218 chameleon_args = hosts.CrosHost.get_chameleon_arguments(args_dict)
219 host = hosts.create_host(machine, chameleon_args=chameleon_args)
220 ~~~~~~~~
221
222 @param args_dict Dictionary from which to extract the chameleon
223 arguments.
224 """
Sam McNally66594ca2019-12-09 12:45:44 +1100225 chameleon_args = {key: args_dict[key]
226 for key in ('chameleon_host', 'chameleon_port')
227 if key in args_dict}
228 if 'chameleon_ssh_port' in args_dict:
229 chameleon_args['port'] = int(args_dict['chameleon_ssh_port'])
230 return chameleon_args
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800231
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800232 @staticmethod
233 def get_btpeer_arguments(args_dict):
234 """Extract btpeer options from `args_dict` and return the result.
235
236 This is used to parse details of Bluetooth peer.
237 Recommended usage:
238 ~~~~~~~~
239 args_dict = utils.args_to_dict(args)
240 btpeer_args = hosts.CrosHost.get_btpeer_arguments(args_dict)
Shijin Abraham22f24cb2020-03-26 09:07:41 -0700241 host = hosts.create_host(machine, btpeer_args=btpeer_args)
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800242 ~~~~~~~~
243
244 @param args_dict: Dictionary from which to extract the btpeer
245 arguments.
246 """
247 if 'btpeer_host_list' in args_dict:
248 result = []
249 for btpeer in args_dict['btpeer_host_list'].split(','):
Claire Changd0b19842020-11-04 22:28:45 +0800250 # IPv6 addresses including a port number should be enclosed in
251 # square brackets.
252 delimiter = ']:' if re.search(r':.*:', btpeer) else ':'
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800253 result.append({key: value for key,value in
254 zip(('btpeer_host','btpeer_port'),
Claire Changd0b19842020-11-04 22:28:45 +0800255 btpeer.strip('[]').split(delimiter))})
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800256 return result
257 else:
Anand K Mistrye8933092020-08-05 14:49:41 +1000258 return {key: args_dict[key]
259 for key in ('btpeer_host', 'btpeer_port', 'btpeer_ssh_port')
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800260 if key in args_dict}
261
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800262
263 @staticmethod
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700264 def get_pdtester_arguments(args_dict):
Scottfe06ed82015-11-05 17:15:01 -0800265 """Extract chameleon options from `args_dict` and return the result.
266
267 Recommended usage:
268 ~~~~~~~~
269 args_dict = utils.args_to_dict(args)
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700270 pdtester_args = hosts.CrosHost.get_pdtester_arguments(args_dict)
271 host = hosts.create_host(machine, pdtester_args=pdtester_args)
Scottfe06ed82015-11-05 17:15:01 -0800272 ~~~~~~~~
273
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700274 @param args_dict Dictionary from which to extract the pdtester
Scottfe06ed82015-11-05 17:15:01 -0800275 arguments.
276 """
Allen Li083866b2016-08-18 10:07:10 -0700277 return {key: args_dict[key]
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700278 for key in ('pdtester_host', 'pdtester_port')
Allen Li083866b2016-08-18 10:07:10 -0700279 if key in args_dict}
Scottfe06ed82015-11-05 17:15:01 -0800280
281
282 @staticmethod
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800283 def get_servo_arguments(args_dict):
284 """Extract servo options from `args_dict` and return the result.
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800285
286 Recommended usage:
287 ~~~~~~~~
288 args_dict = utils.args_to_dict(args)
Fang Deng0ca40e22013-08-27 17:47:44 -0700289 servo_args = hosts.CrosHost.get_servo_arguments(args_dict)
J. Richard Barnette7214e0b2013-02-06 15:20:49 -0800290 host = hosts.create_host(machine, servo_args=servo_args)
291 ~~~~~~~~
292
293 @param args_dict Dictionary from which to extract the servo
294 arguments.
295 """
Garry Wang11b5e872020-03-11 15:14:08 -0700296 servo_attrs = (servo_constants.SERVO_HOST_ATTR,
297 servo_constants.SERVO_PORT_ATTR,
Otabek Kasimov382c3bb2020-10-28 13:22:45 -0700298 servo_constants.SERVO_SERIAL_ATTR,
Garry Wang11b5e872020-03-11 15:14:08 -0700299 servo_constants.SERVO_BOARD_ATTR,
300 servo_constants.SERVO_MODEL_ATTR)
Armando Miraglia2ac802e2017-08-15 14:54:47 +0200301 servo_args = {key: args_dict[key]
302 for key in servo_attrs
303 if key in args_dict}
304 return (
305 None
Garry Wang11b5e872020-03-11 15:14:08 -0700306 if servo_constants.SERVO_HOST_ATTR in servo_args
307 and not servo_args[servo_constants.SERVO_HOST_ATTR]
Armando Miraglia2ac802e2017-08-15 14:54:47 +0200308 else servo_args)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -0700309
J. Richard Barnette964fba02012-10-24 17:34:29 -0700310
J. Richard Barnette91137f02016-03-10 16:52:26 -0800311 def _initialize(self, hostname, chameleon_args=None, servo_args=None,
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700312 pdtester_args=None, try_lab_servo=False,
Shijin Abraham78ce4402020-09-08 22:04:27 -0700313 try_servo_repair=False, ssh_verbosity_flag='',
314 ssh_options='', *args, **dargs):
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800315 """Initialize superclasses, |self.chameleon|, and |self.servo|.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700316
Fang Denge545abb2014-12-30 18:43:47 -0800317 This method will attempt to create the test-assistant object
318 (chameleon/servo) when it is needed by the test. Check
319 the docstring of chameleon_host.create_chameleon_host and
320 servo_host.create_servo_host for how this is determined.
Fang Deng5d518f42013-08-02 14:04:32 -0700321
Fang Denge545abb2014-12-30 18:43:47 -0800322 @param hostname: Hostname of the dut.
323 @param chameleon_args: A dictionary that contains args for creating
324 a ChameleonHost. See chameleon_host for details.
325 @param servo_args: A dictionary that contains args for creating
326 a ServoHost object. See servo_host for details.
Richard Barnette9a26ad62016-06-10 12:03:08 -0700327 @param try_lab_servo: When true, indicates that an attempt should
328 be made to create a ServoHost for a DUT in
329 the test lab, even if not required by
330 `servo_args`. See servo_host for details.
331 @param try_servo_repair: If a servo host is created, check it
332 with `repair()` rather than `verify()`.
Fang Denge545abb2014-12-30 18:43:47 -0800333 See servo_host for details.
334 @param ssh_verbosity_flag: String, to pass to the ssh command to control
335 verbosity.
336 @param ssh_options: String, other ssh options to pass to the ssh
337 command.
J. Richard Barnette67ccb872012-04-19 16:34:56 -0700338 """
Fang Deng0ca40e22013-08-27 17:47:44 -0700339 super(CrosHost, self)._initialize(hostname=hostname,
J. Richard Barnette45e93de2012-04-11 17:24:15 -0700340 *args, **dargs)
J. Richard Barnette91137f02016-03-10 16:52:26 -0800341 self._repair_strategy = cros_repair.create_cros_repair_strategy()
Otabek Kasimov6825b762020-06-23 23:42:44 -0700342 # hold special dut_state for repair process
343 self._device_repair_state = None
Kevin Chenga2619dc2016-03-28 11:42:08 -0700344 self.labels = base_label.LabelRetriever(cros_label.CROS_LABELS)
J. Richard Barnettef0859852012-08-20 14:55:50 -0700345 # self.env is a dictionary of environment variable settings
346 # to be exported for commands run on the host.
347 # LIBC_FATAL_STDERR_ can be useful for diagnosing certain
348 # errors that might happen.
349 self.env['LIBC_FATAL_STDERR_'] = '1'
Fang Dengd1c2b732013-08-20 12:59:46 -0700350 self._ssh_verbosity_flag = ssh_verbosity_flag
Aviv Keshetc5947fa2013-09-04 14:06:29 -0700351 self._ssh_options = ssh_options
Garry Wang1a493d82020-08-31 21:01:19 -0700352 self.health_profile = None
Garry Wang5e5538a2019-04-08 15:36:18 -0700353 self._default_power_method = None
Otabek Kasimov39637412020-11-23 19:09:27 -0800354 dut_health_profile = device_health_profile.DeviceHealthProfile(
355 hostname=self.hostname,
356 host_info=self.host_info_store.get(),
357 result_dir=self.get_result_dir())
Otabek Kasimovb61729d2020-11-24 00:42:43 -0800358
359 # TODO(otabek@): remove when b/171414073 closed
Otabek Kasimov7587b902020-12-07 23:54:33 -0800360 pingable_before_servo = self.is_up_fast(count=3)
Otabek Kasimovb61729d2020-11-24 00:42:43 -0800361 if pingable_before_servo:
362 logging.info('DUT is pingable before init Servo.')
Otabek Kasimov39637412020-11-23 19:09:27 -0800363 _servo_host, servo_state = servo_host.create_servo_host(
364 dut=self,
365 servo_args=servo_args,
366 try_lab_servo=try_lab_servo,
367 try_servo_repair=try_servo_repair,
368 dut_host_info=self.host_info_store.get(),
369 dut_health_profile=dut_health_profile)
370 if dut_health_profile.is_loaded():
371 logging.info('Device health profile loaded.')
372 # The device profile is located in the servo_host which make it
373 # dependency. If profile is not loaded yet then we do not have it
374 # TODO(otabek@) persist device provide out of servo-host.
375 self.health_profile = dut_health_profile
376 self.set_servo_host(_servo_host, servo_state)
Richard Barnettee519dcd2016-08-15 17:37:17 -0700377
Otabek Kasimovb61729d2020-11-24 00:42:43 -0800378 # TODO(otabek@): remove when b/171414073 closed
379 # Introduced to collect cases when servo made DUT not sshable
Otabek Kasimov7587b902020-12-07 23:54:33 -0800380 pingable_after_servo = self.is_up_fast(count=3)
Otabek Kasimovb61729d2020-11-24 00:42:43 -0800381 if pingable_after_servo:
382 logging.info('DUT is pingable after init Servo.')
383 elif pingable_before_servo:
384 logging.info('DUT was pingable before init Servo but not now')
Otabek Kasimov7587b902020-12-07 23:54:33 -0800385 if servo_args and self._servo_host and self._servo_host.hostname:
386 # collect stats only for tests.
387 dut_ping_servo_init_data = {
388 'host': self.hostname,
389 'servo_host': self._servo_host.hostname,
390 }
391 metrics.Counter('chromeos/autotest/dut_ping_servo_init2'
392 ).increment(fields=dut_ping_servo_init_data)
Otabek Kasimovb61729d2020-11-24 00:42:43 -0800393
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800394 # TODO(waihong): Do the simplication on Chameleon too.
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800395 self._chameleon_host = chameleon_host.create_chameleon_host(
Otabek Kasimova7ba91a2020-03-09 08:31:01 -0700396 dut=self.hostname,
397 chameleon_args=chameleon_args)
Shijin Abraham783a7dd2020-02-14 15:36:11 -0800398 if self._chameleon_host:
399 self.chameleon = self._chameleon_host.create_chameleon_board()
Tom Wai-Hong Tamefe1c7f2014-01-02 14:00:11 +0800400 else:
Tom Wai-Hong Tam3d6790d2014-04-14 16:15:47 +0800401 self.chameleon = None
Fang Deng5d518f42013-08-02 14:04:32 -0700402
Shijin Abraham78ce4402020-09-08 22:04:27 -0700403 # Bluetooth peers will be populated by the test if needed
404 self._btpeer_host_list = []
405 self.btpeer_list = []
406 self.btpeer = None
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800407
howardchung83e55272019-08-08 14:08:05 +0800408 # Add pdtester host if pdtester args were added on command line
Wai-Hong Tam16e5edb2019-09-17 16:10:07 -0700409 self._pdtester_host = pdtester_host.create_pdtester_host(
Wai-Hong Tam90b164d2019-10-25 13:15:39 -0700410 pdtester_args, self._servo_host)
howardchung83e55272019-08-08 14:08:05 +0800411
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700412 if self._pdtester_host:
413 self.pdtester_servo = self._pdtester_host.get_servo()
414 logging.info('pdtester_servo: %r', self.pdtester_servo)
415 # Create the pdtester object used to access the ec uart
416 self.pdtester = pdtester.PDTester(self.pdtester_servo,
417 self._pdtester_host.get_servod_server_proxy())
Scottfe06ed82015-11-05 17:15:01 -0800418 else:
Wai-Hong Tam0ed9fe12019-05-23 11:00:58 -0700419 self.pdtester = None
Scottfe06ed82015-11-05 17:15:01 -0800420
Fang Deng5d518f42013-08-02 14:04:32 -0700421
Shijin Abraham78ce4402020-09-08 22:04:27 -0700422 def initialize_btpeer(self, btpeer_args=[]):
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800423 """ Initialize the Bluetooth peers
424
425 Initialize Bluetooth peer devices given in the arguments. Bluetooth peer
426 is chameleon host on Raspberry Pi.
427 @param btpeer_args: A dictionary that contains args for creating
428 a ChameleonHost. See chameleon_host for details.
429
430 """
Shijin Abraham78ce4402020-09-08 22:04:27 -0700431 logging.debug('Attempting to initialize bluetooth peers if available')
Shijin Abraham22f24cb2020-03-26 09:07:41 -0700432 try:
Shijin Abraham22f24cb2020-03-26 09:07:41 -0700433 if type(btpeer_args) is list:
434 btpeer_args_list = btpeer_args
435 else:
436 btpeer_args_list = [btpeer_args]
437
438 self._btpeer_host_list = chameleon_host.create_btpeer_host(
439 dut=self.hostname, btpeer_args_list=btpeer_args_list)
440 logging.debug('Bluetooth peer hosts are %s',
441 self._btpeer_host_list)
442 self.btpeer_list = [_host.create_chameleon_board() for _host in
443 self._btpeer_host_list if _host is not None]
444
445 if len(self.btpeer_list) > 0:
446 self.btpeer = self.btpeer_list[0]
447
448 logging.debug('After initialize_btpeer btpeer_list %s '
449 'btpeer_host_list is %s and btpeer is %s',
450 self.btpeer_list, self._btpeer_host_list,
451 self.btpeer)
452 except Exception as e:
453 logging.error('Exception %s in initialize_btpeer', str(e))
454
Shijin Abrahamc09587d2020-02-14 20:46:55 -0800455
456
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000457 def get_cros_repair_image_name(self):
Ruben Rodriguez Buchilloncee72f72019-05-01 13:20:58 -0700458 """Get latest stable cros image name from AFE.
459
460 Use the board name from the info store. Should that fail, try to
461 retrieve the board name from the host's installed image itself.
462
463 @returns: current stable cros image name for this host.
464 """
Garry Wange8a8fc22020-04-13 15:04:53 -0700465 info = self.host_info_store.get()
466 if not info.board:
Ruben Rodriguez Buchilloncee72f72019-05-01 13:20:58 -0700467 logging.warn('No board label value found. Trying to infer '
468 'from the host itself.')
469 try:
Garry Wange8a8fc22020-04-13 15:04:53 -0700470 info.labels.append(self.get_board())
Ruben Rodriguez Buchilloncee72f72019-05-01 13:20:58 -0700471 except (error.AutoservRunError, error.AutoservSSHTimeout) as e:
472 logging.error('Also failed to get the board name from the DUT '
473 'itself. %s.', str(e))
Garry Wange8a8fc22020-04-13 15:04:53 -0700474 raise error.AutoservError('Cannot determine board of the DUT'
475 ' while getting repair image name.')
476 return afe_utils.get_stable_cros_image_name_v2(info)
Scott Zawalski89c44dd2013-02-26 09:28:02 -0500477
478
Rohit Makasanadf0a3a32017-06-30 13:55:18 -0700479 def host_version_prefix(self, image):
480 """Return version label prefix.
481
482 In case the CrOS provisioning version is something other than the
483 standard CrOS version e.g. CrOS TH version, this function will
484 find the prefix from provision.py.
485
486 @param image: The image name to find its version prefix.
487 @returns: A prefix string for the image type.
488 """
489 return provision.get_version_label_prefix(image)
490
Andrew Luo3332ab22020-04-28 16:42:03 -0700491 def stage_build_to_usb(self, build):
492 """Stage the current ChromeOS image on the USB stick connected to the
493 servo.
494
495 @param build: The build to download and send to USB.
496 """
497 if not self.servo:
498 raise error.TestError('Host %s does not have servo.' %
499 self.hostname)
500
501 _, update_url = self.stage_image_for_servo(build)
Andrew Luob0355ea2020-06-24 16:12:57 -0700502
503 try:
504 self.servo.image_to_servo_usb(update_url)
505 finally:
506 # servo.image_to_servo_usb turned the DUT off, so turn it back on
507 logging.debug('Turn DUT power back on.')
508 self.servo.get_power_state_controller().power_on()
509
Andrew Luo3332ab22020-04-28 16:42:03 -0700510 logging.debug('ChromeOS image %s is staged on the USB stick.',
511 build)
Rohit Makasanadf0a3a32017-06-30 13:55:18 -0700512
beepsdae65fd2013-07-26 16:24:41 -0700513 def verify_job_repo_url(self, tag=''):
beepscb6f1e22013-06-28 19:14:10 -0700514 """
515 Make sure job_repo_url of this host is valid.
516
joychen03eaad92013-06-26 09:55:21 -0700517 Eg: The job_repo_url "http://lmn.cd.ab.xyx:8080/static/\
beepscb6f1e22013-06-28 19:14:10 -0700518 lumpy-release/R29-4279.0.0/autotest/packages" claims to have the
519 autotest package for lumpy-release/R29-4279.0.0. If this isn't the case,
520 download and extract it. If the devserver embedded in the url is
521 unresponsive, update the job_repo_url of the host after staging it on
522 another devserver.
523
524 @param job_repo_url: A url pointing to the devserver where the autotest
525 package for this build should be staged.
beepsdae65fd2013-07-26 16:24:41 -0700526 @param tag: The tag from the server job, in the format
527 <job_id>-<user>/<hostname>, or <hostless> for a server job.
beepscb6f1e22013-06-28 19:14:10 -0700528
529 @raises DevServerException: If we could not resolve a devserver.
530 @raises AutoservError: If we're unable to save the new job_repo_url as
531 a result of choosing a new devserver because the old one failed to
532 respond to a health check.
beeps0c865032013-07-30 11:37:06 -0700533 @raises urllib2.URLError: If the devserver embedded in job_repo_url
534 doesn't respond within the timeout.
beepscb6f1e22013-06-28 19:14:10 -0700535 """
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800536 info = self.host_info_store.get()
537 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
beepscb6f1e22013-06-28 19:14:10 -0700538 if not job_repo_url:
539 logging.warning('No job repo url set on host %s', self.hostname)
540 return
541
542 logging.info('Verifying job repo url %s', job_repo_url)
543 devserver_url, image_name = tools.get_devserver_build_from_package_url(
544 job_repo_url)
545
beeps0c865032013-07-30 11:37:06 -0700546 ds = dev_server.ImageServer(devserver_url)
beepscb6f1e22013-06-28 19:14:10 -0700547
548 logging.info('Staging autotest artifacts for %s on devserver %s',
549 image_name, ds.url())
beeps687243d2013-07-18 15:29:27 -0700550
551 start_time = time.time()
Simran Basi25e7a922014-10-31 11:56:10 -0700552 ds.stage_artifacts(image_name, ['autotest_packages'])
beeps687243d2013-07-18 15:29:27 -0700553 stage_time = time.time() - start_time
554
555 # Record how much of the verification time comes from a devserver
556 # restage. If we're doing things right we should not see multiple
557 # devservers for a given board/build/branch path.
558 try:
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800559 board, build_type, branch = server_utils.ParseBuildName(
beeps687243d2013-07-18 15:29:27 -0700560 image_name)[:3]
J. Richard Barnette3cbd76b2013-11-27 12:11:25 -0800561 except server_utils.ParseBuildNameException:
beeps687243d2013-07-18 15:29:27 -0700562 pass
563 else:
beeps0c865032013-07-30 11:37:06 -0700564 devserver = devserver_url[
Chris Sosa65425082013-10-16 13:26:22 -0700565 devserver_url.find('/') + 2:devserver_url.rfind(':')]
beeps687243d2013-07-18 15:29:27 -0700566 stats_key = {
567 'board': board,
568 'build_type': build_type,
569 'branch': branch,
beeps0c865032013-07-30 11:37:06 -0700570 'devserver': devserver.replace('.', '_'),
beeps687243d2013-07-18 15:29:27 -0700571 }
Dan Shi5e2efb72017-02-07 11:40:23 -0800572
573 monarch_fields = {
574 'board': board,
575 'build_type': build_type,
Dan Shi5e2efb72017-02-07 11:40:23 -0800576 'branch': branch,
577 'dev_server': devserver,
578 }
579 metrics.Counter(
580 'chromeos/autotest/provision/verify_url'
581 ).increment(fields=monarch_fields)
582 metrics.SecondsDistribution(
583 'chromeos/autotest/provision/verify_url_duration'
584 ).add(stage_time, fields=monarch_fields)
585
586
Dan Shicf4d2032015-03-12 15:04:21 -0700587 def stage_server_side_package(self, image=None):
588 """Stage autotest server-side package on devserver.
589
590 @param image: Full path of an OS image to install or a build name.
591
592 @return: A url to the autotest server-side package.
Dan Shi14de7622016-08-22 11:09:06 -0700593
594 @raise: error.AutoservError if fail to locate the build to test with, or
595 fail to stage server-side package.
Dan Shicf4d2032015-03-12 15:04:21 -0700596 """
Dan Shid37736b2016-07-06 15:10:29 -0700597 # If enable_drone_in_restricted_subnet is False, do not set hostname
598 # in devserver.resolve call, so a devserver in non-restricted subnet
599 # is picked to stage autotest server package for drone to download.
600 hostname = self.hostname
601 if not server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
602 hostname = None
Dan Shicf4d2032015-03-12 15:04:21 -0700603 if image:
604 image_name = tools.get_build_from_image(image)
605 if not image_name:
606 raise error.AutoservError(
607 'Failed to parse build name from %s' % image)
Dan Shid37736b2016-07-06 15:10:29 -0700608 ds = dev_server.ImageServer.resolve(image_name, hostname)
Dan Shicf4d2032015-03-12 15:04:21 -0700609 else:
Prathmesh Prabhu9235e4c2017-03-28 13:16:06 -0700610 info = self.host_info_store.get()
Prathmesh Prabhu368abdf2017-02-14 11:23:47 -0800611 job_repo_url = info.attributes.get(ds_constants.JOB_REPO_URL, '')
Dan Shicf4d2032015-03-12 15:04:21 -0700612 if job_repo_url:
613 devserver_url, image_name = (
614 tools.get_devserver_build_from_package_url(job_repo_url))
Dan Shid37736b2016-07-06 15:10:29 -0700615 # If enable_drone_in_restricted_subnet is True, use the
616 # existing devserver. Otherwise, resolve a new one in
617 # non-restricted subnet.
618 if server_utils.ENABLE_DRONE_IN_RESTRICTED_SUBNET:
619 ds = dev_server.ImageServer(devserver_url)
620 else:
621 ds = dev_server.ImageServer.resolve(image_name)
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800622 elif info.build is not None:
623 ds = dev_server.ImageServer.resolve(info.build, hostname)
Prathmesh Prabhu0c1dd4d2017-06-07 13:01:53 -0700624 image_name = info.build
Dan Shicf4d2032015-03-12 15:04:21 -0700625 else:
Prathmesh Prabhub6cea612017-02-09 15:41:19 -0800626 raise error.AutoservError(
627 'Failed to stage server-side package. The host has '
Garry Wang12b9baf2019-06-24 18:58:54 -0700628 'no job_repo_url attribute or cros-version label.')
Dan Shica503482015-03-30 17:23:25 -0700629
630 # Get the OS version of the build, for any build older than
631 # MIN_VERSION_SUPPORT_SSP, server side packaging is not supported.
632 match = re.match('.*/R\d+-(\d+)\.', image_name)
633 if match and int(match.group(1)) < self.MIN_VERSION_SUPPORT_SSP:
Dan Shi14de7622016-08-22 11:09:06 -0700634 raise error.AutoservError(
635 'Build %s is older than %s. Server side packaging is '
636 'disabled.' % (image_name, self.MIN_VERSION_SUPPORT_SSP))
Dan Shica503482015-03-30 17:23:25 -0700637
Dan Shicf4d2032015-03-12 15:04:21 -0700638 ds.stage_artifacts(image_name, ['autotest_server_package'])
639 return '%s/static/%s/%s' % (ds.url(), image_name,
640 'autotest_server_package.tar.bz2')
641
642
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700643 def stage_image_for_servo(self, image_name=None, artifact='test_image'):
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700644 """Stage a build on a devserver and return the update_url.
645
646 @param image_name: a name like lumpy-release/R27-3837.0.0
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700647 @param artifact: a string like 'test_image'. Requests
648 appropriate image to be staged.
Xixuan Wufee57542019-10-15 11:50:27 -0700649 @returns a tuple of (image_name, URL) like
650 (lumpy-release/R27-3837.0.0,
651 http://172.22.50.205:8082/update/lumpy-release/R27-3837.0.0)
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700652 """
653 if not image_name:
Richard Barnetteb4b4d6f2018-05-05 01:47:41 +0000654 image_name = self.get_cros_repair_image_name()
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700655 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800656 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700657 devserver.stage_artifacts(image_name, [artifact])
658 if artifact == 'test_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700659 return image_name, devserver.get_test_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700660 elif artifact == 'recovery_image':
Xixuan Wufee57542019-10-15 11:50:27 -0700661 return image_name, devserver.get_recovery_image_url(image_name)
Kalin Stoyanovb3c11f32018-05-11 09:02:00 -0700662 else:
663 raise error.AutoservError("Bad artifact!")
J. Richard Barnettee4af8b92013-05-01 13:16:12 -0700664
665
beepse539be02013-07-31 21:57:39 -0700666 def stage_factory_image_for_servo(self, image_name):
667 """Stage a build on a devserver and return the update_url.
668
669 @param image_name: a name like <baord>/4262.204.0
beeps12c0a3c2013-09-03 11:58:27 -0700670
beepse539be02013-07-31 21:57:39 -0700671 @return: An update URL, eg:
672 http://<devserver>/static/canary-channel/\
673 <board>/4262.204.0/factory_test/chromiumos_factory_image.bin
beeps12c0a3c2013-09-03 11:58:27 -0700674
675 @raises: ValueError if the factory artifact name is missing from
676 the config.
677
beepse539be02013-07-31 21:57:39 -0700678 """
679 if not image_name:
680 logging.error('Need an image_name to stage a factory image.')
681 return
682
Dan Shib8540a52015-07-16 14:18:23 -0700683 factory_artifact = CONFIG.get_config_value(
beeps12c0a3c2013-09-03 11:58:27 -0700684 'CROS', 'factory_artifact', type=str, default='')
685 if not factory_artifact:
686 raise ValueError('Cannot retrieve the factory artifact name from '
687 'autotest config, and hence cannot stage factory '
688 'artifacts.')
689
beepse539be02013-07-31 21:57:39 -0700690 logging.info('Staging build for servo install: %s', image_name)
Dan Shi216389c2015-12-22 11:03:06 -0800691 devserver = dev_server.ImageServer.resolve(image_name, self.hostname)
beepse539be02013-07-31 21:57:39 -0700692 devserver.stage_artifacts(
693 image_name,
beeps12c0a3c2013-09-03 11:58:27 -0700694 [factory_artifact],
695 archive_url=None)
beepse539be02013-07-31 21:57:39 -0700696
697 return tools.factory_image_url_pattern() % (devserver.url(), image_name)
698
699
Laurence Goodby778c9a42017-05-24 19:24:07 -0700700 def prepare_for_update(self):
701 """Prepares the DUT for an update.
702
703 Subclasses may override this to perform any special actions
704 required before updating.
705 """
Laurence Goodby468de252017-06-08 17:22:53 -0700706 pass
Laurence Goodby778c9a42017-05-24 19:24:07 -0700707
708
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800709 def _clear_fw_version_labels(self, rw_only):
710 """Clear firmware version labels from the machine.
711
712 @param rw_only: True to only clear fwrw_version; otherewise, clear
713 both fwro_version and fwrw_version.
714 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700715 info = self.host_info_store.get()
716 info.clear_version_labels(provision.FW_RW_VERSION_PREFIX)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800717 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700718 info.clear_version_labels(provision.FW_RO_VERSION_PREFIX)
719 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700720
721
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800722 def _add_fw_version_label(self, build, rw_only):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700723 """Add firmware version label to the machine.
724
725 @param build: Build of firmware.
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800726 @param rw_only: True to only add fwrw_version; otherwise, add both
727 fwro_version and fwrw_version.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700728
729 """
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700730 info = self.host_info_store.get()
731 info.set_version_label(provision.FW_RW_VERSION_PREFIX, build)
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800732 if not rw_only:
Prathmesh Prabhuf8ae9a82019-10-04 15:34:13 -0700733 info.set_version_label(provision.FW_RO_VERSION_PREFIX, build)
734 self.host_info_store.commit(info)
Dan Shi9cb0eec2014-06-03 09:04:50 -0700735
736
Namyoon Woo33f38852020-04-13 17:26:58 -0700737 def get_latest_release_version(self, platform, ref_board=None):
Namyoon Woo5f894662019-11-15 15:23:23 -0800738 """Search for the latest package release version from the image archive,
739 and return it.
740
Namyoon Woo33f38852020-04-13 17:26:58 -0700741 @param platform: platform name, a.k.a. board or model
742 @param ref_board: reference board name, a.k.a. baseboard, parent
Namyoon Woo5f894662019-11-15 15:23:23 -0800743
Namyoon Woo33f38852020-04-13 17:26:58 -0700744 @return 'firmware-{platform}-{branch}-firmwarebranch/{release-version}/'
745 '{platform}'
Namyoon Woo5f894662019-11-15 15:23:23 -0800746 or None if LATEST release file does not exist.
747 """
748
Namyoon Woo33f38852020-04-13 17:26:58 -0700749 platforms = [ platform ]
Namyoon Woo5f894662019-11-15 15:23:23 -0800750
Namyoon Woo33f38852020-04-13 17:26:58 -0700751 # Search the image path in reference board archive as well.
752 # For example, bob has its binary image under its reference board (gru)
753 # image archive.
754 if ref_board:
755 platforms.append(ref_board)
Namyoon Woo5f894662019-11-15 15:23:23 -0800756
Namyoon Woo33f38852020-04-13 17:26:58 -0700757 for board in platforms:
758 # Read 'LATEST-1.0.0' file
759 branch_dir = provision.FW_BRANCH_GLOB % board
760 latest_file = os.path.join(provision.CROS_IMAGE_ARCHIVE, branch_dir,
761 'LATEST-1.0.0')
Namyoon Woo406c7d42020-01-24 15:57:11 -0800762
Namyoon Woo33f38852020-04-13 17:26:58 -0700763 try:
764 # The result could be one or more.
765 result = utils.system_output('gsutil ls -d ' + latest_file)
766
767 candidates = re.findall('gs://.*', result)
768
769 # Found the directory candidates. No need to check the other
770 # board name cadidates. Let's break the loop.
771 break
772 except error.CmdError:
773 # It doesn't exist. Let's move on to the next item.
774 pass
775 else:
Namyoon Woo5f894662019-11-15 15:23:23 -0800776 logging.error('No LATEST release info is available.')
777 return None
778
Namyoon Woo406c7d42020-01-24 15:57:11 -0800779 for cand_dir in candidates:
780 result = utils.system_output('gsutil cat ' + cand_dir)
Namyoon Woo5f894662019-11-15 15:23:23 -0800781
Namyoon Woo406c7d42020-01-24 15:57:11 -0800782 release_path = cand_dir.replace('LATEST-1.0.0', result)
Namyoon Woo33f38852020-04-13 17:26:58 -0700783 release_path = os.path.join(release_path, platform)
Namyoon Woo406c7d42020-01-24 15:57:11 -0800784 try:
785 # Check if release_path does exist.
786 release = utils.system_output('gsutil ls -d ' + release_path)
787 # Now 'release' has a full directory path: e.g.
788 # gs://chromeos-image-archive/firmware-octopus-11297.B-
789 # firmwarebranch/RNone-1.0.0-b4395530/octopus/
790
791 # Remove "gs://chromeos-image-archive".
792 release = release.replace(provision.CROS_IMAGE_ARCHIVE, '')
793
794 # Remove CROS_IMAGE_ARCHIVE and any surrounding '/'s.
795 return release.strip('/')
796 except error.CmdError:
797 # The directory might not exist. Let's try next candidate.
798 pass
799 else:
800 raise error.AutoservError('Cannot find the latest firmware')
Namyoon Woo5f894662019-11-15 15:23:23 -0800801
Brent Peterson1cb623a2020-01-09 13:14:28 -0800802 @staticmethod
803 def get_version_from_image(image, version_regex):
Brent Peterson8039b472020-02-14 10:51:23 -0800804 """Get version string from binary image using regular expression.
805
806 @param image: Binary image to search
807 @param version_regex: Regular expression to search for
808
809 @return Version string
810
811 @raises TestFail if no version string is found in image
812 """
Brent Peterson1cb623a2020-01-09 13:14:28 -0800813 with open(image, 'rb') as f:
814 image_data = f.read()
Derek Beckett98345552020-08-31 16:07:22 -0700815 match = re.findall(version_regex,
816 image_data.decode('ISO-8859-1', errors='ignore'))
Brent Peterson1cb623a2020-01-09 13:14:28 -0800817 if match:
818 return match[0]
819 else:
820 raise error.TestFail('Failed to read version from %s.' % image)
821
822
Garry Wangad2a1712020-03-26 15:06:43 -0700823 def firmware_install(self, build, rw_only=False, dest=None,
Brent Petersonc70a1832020-01-24 15:54:35 -0800824 local_tarball=None, verify_version=False,
Namyoon Woo382e5892020-05-20 16:48:40 -0700825 try_scp=False, install_ec=True, install_bios=True,
826 board_as=None):
Dan Shi9cb0eec2014-06-03 09:04:50 -0700827 """Install firmware to the DUT.
828
829 Use stateful update if the DUT is already running the same build.
830 Stateful update does not update kernel and tends to run much faster
831 than a full reimage. If the DUT is running a different build, or it
832 failed to do a stateful update, full update, including kernel update,
833 will be applied to the DUT.
834
Tom Wai-Hong Tam2d00cb22016-01-08 06:40:50 +0800835 Once a host enters firmware_install its fw[ro|rw]_version label will
836 be removed. After the firmware is updated successfully, a new
837 fw[ro|rw]_version label will be added to the host.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700838
839 @param build: The build version to which we want to provision the
840 firmware of the machine,
841 e.g. 'link-firmware/R22-2695.1.144'.
Tom Wai-Hong Tam4ac78982016-01-08 02:34:37 +0800842 @param rw_only: True to only install firmware to its RW portions. Keep
843 the RO portions unchanged.
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700844 @param dest: Directory to store the firmware in.
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800845 @param local_tarball: Path to local firmware image for installing
846 without devserver.
Brent Peterson1cb623a2020-01-09 13:14:28 -0800847 @param verify_version: True to verify EC and BIOS versions after
848 programming firmware, default is False.
Brent Petersonc70a1832020-01-24 15:54:35 -0800849 @param try_scp: False to always program using servo, true to try copying
850 the firmware and programming from the DUT.
Namyoon Woo382e5892020-05-20 16:48:40 -0700851 @param install_ec: True to install EC FW, and False to skip it.
852 @param install_bios: True to install BIOS, and False to skip it.
853 @param board_as: A board name to force to use.
Dan Shi9cb0eec2014-06-03 09:04:50 -0700854
855 TODO(dshi): After bug 381718 is fixed, update here with corresponding
856 exceptions that could be raised.
857
858 """
859 if not self.servo:
860 raise error.TestError('Host %s does not have servo.' %
861 self.hostname)
862
Wai-Hong Tam3fa455a2018-07-18 14:40:43 -0700863 # Get the DUT board name from AFE.
864 info = self.host_info_store.get()
865 board = info.board
Shelley Chenac61d5a2019-06-24 15:35:46 -0700866 model = info.model
Namyoon Woo8dbfcf92019-01-15 18:37:12 -0800867
868 if board is None or board == '':
869 board = self.servo.get_board()
Dan Shi9cb0eec2014-06-03 09:04:50 -0700870
Namyoon Woo382e5892020-05-20 16:48:40 -0700871 # if board_as argument is passed, then use it instead of the original
872 # board name.
873 if board_as:
874 board = board_as
875
Mary Ruthvende14a8b2019-08-23 12:43:52 -0700876 if model is None or model == '':
Namyoon Woofb16eae2020-08-14 10:02:39 -0700877 try:
Mary Ruthven9c15a4e2020-10-23 10:10:53 -0700878 model = self.get_platform()
Namyoon Woofb16eae2020-08-14 10:02:39 -0700879 except Exception as e:
880 logging.warn('Dut is unresponsive: %s', str(e))
Mary Ruthvende14a8b2019-08-23 12:43:52 -0700881
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800882 # If local firmware path not provided fetch it from the dev server
Mary Ruthven6481a9f2019-08-23 12:46:05 -0700883 tmpd = None
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800884 if not local_tarball:
Garry Wangad2a1712020-03-26 15:06:43 -0700885 logging.info('Will install firmware from build %s.', build)
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800886
Namyoon Woo43c1cb22020-05-28 18:58:34 -0700887 try:
888 ds = dev_server.ImageServer.resolve(build, self.hostname)
889 ds.stage_artifacts(build, ['firmware'])
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800890
Namyoon Woo43c1cb22020-05-28 18:58:34 -0700891 if not dest:
892 tmpd = autotemp.tempdir(unique_id='fwimage')
893 dest = tmpd.name
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800894
Namyoon Woo43c1cb22020-05-28 18:58:34 -0700895 # Download firmware image
896 fwurl = self._FW_IMAGE_URL_PATTERN % (ds.url(), build)
897 local_tarball = os.path.join(dest, os.path.basename(fwurl))
898 ds.download_file(fwurl, local_tarball)
899 except Exception as e:
900 raise error.TestError('Failed to download firmware package: %s'
901 % str(e))
Dan Shi9cb0eec2014-06-03 09:04:50 -0700902
Namyoon Woo382e5892020-05-20 16:48:40 -0700903 ec_image = None
904 if install_ec:
905 # Extract EC image from tarball
906 logging.info('Extracting EC image.')
907 ec_image = self.servo.extract_ec_image(board, model, local_tarball)
Mary Ruthven9c15a4e2020-10-23 10:10:53 -0700908 logging.info('Extracted: %s', ec_image)
Brent Peterson1cb623a2020-01-09 13:14:28 -0800909
Namyoon Woo382e5892020-05-20 16:48:40 -0700910 bios_image = None
911 if install_bios:
912 # Extract BIOS image from tarball
913 logging.info('Extracting BIOS image.')
914 bios_image = self.servo.extract_bios_image(board, model,
915 local_tarball)
Mary Ruthven9c15a4e2020-10-23 10:10:53 -0700916 logging.info('Extracted: %s', bios_image)
Namyoon Woo382e5892020-05-20 16:48:40 -0700917
918 if not bios_image and not ec_image:
919 raise error.TestError('No firmware installation was processed.')
Brent Peterson1cb623a2020-01-09 13:14:28 -0800920
Brent Petersonc70a1832020-01-24 15:54:35 -0800921 # Clear firmware version labels
922 self._clear_fw_version_labels(rw_only)
923
924 # Install firmware from local tarball
Brent Peterson5b7c5b12020-01-09 13:14:28 -0800925 try:
Garry Wang50e4a492020-08-05 12:29:57 -0700926 # Check if copying to DUT is enabled and DUT is available
927 if try_scp and self.is_up():
Brent Petersonc70a1832020-01-24 15:54:35 -0800928 # DUT is available, make temp firmware directory to store images
929 logging.info('Making temp folder.')
930 dest_folder = '/tmp/firmware'
931 self.run('mkdir -p ' + dest_folder)
932
Namyoon Woo68b68082020-06-02 13:13:14 -0700933 fw_cmd = self._FW_UPDATE_CMD % ('--wp=1' if rw_only else '')
Brent Petersonc70a1832020-01-24 15:54:35 -0800934
Namyoon Woo382e5892020-05-20 16:48:40 -0700935 if bios_image:
936 # Send BIOS firmware image to DUT
937 logging.info('Sending BIOS firmware.')
938 dest_bios_path = os.path.join(dest_folder,
939 os.path.basename(bios_image))
940 self.send_file(bios_image, dest_bios_path)
941
942 # Initialize firmware update command for BIOS image
943 fw_cmd += ' -i %s' % dest_bios_path
Brent Peterson669edf42020-02-07 15:07:54 -0800944
945 # Send EC firmware image to DUT when EC image was found
946 if ec_image:
947 logging.info('Sending EC firmware.')
948 dest_ec_path = os.path.join(dest_folder,
949 os.path.basename(ec_image))
950 self.send_file(ec_image, dest_ec_path)
951
952 # Add EC image to firmware update command
953 fw_cmd += ' -e %s' % dest_ec_path
954
Dana Goyettee84ef8d2020-07-09 11:55:09 -0700955 # Make sure command is allowed to finish even if ssh fails.
956 fw_cmd = "trap '' SIGHUP; %s" % fw_cmd
957
Brent Peterson669edf42020-02-07 15:07:54 -0800958 # Update firmware on DUT
959 logging.info('Updating firmware.')
Dana Goyettee84ef8d2020-07-09 11:55:09 -0700960 try:
Dana Goyette935b3fe2020-07-23 14:19:39 -0700961 self.run(fw_cmd, options="-o LogLevel=verbose")
Dana Goyettee84ef8d2020-07-09 11:55:09 -0700962 except error.AutoservRunError as e:
963 if e.result_obj.exit_status != 255:
964 raise
965 elif ec_image:
966 logging.warn("DUT network dropped during update"
967 " (often caused by EC resetting USB)")
968 else:
969 logging.error("DUT network dropped during update"
970 " (unexpected, since no EC image)")
971 raise
Brent Petersonc70a1832020-01-24 15:54:35 -0800972 else:
973 # Host is not available, program firmware using servo
Brent Peterson669edf42020-02-07 15:07:54 -0800974 if ec_image:
975 self.servo.program_ec(ec_image, rw_only)
Namyoon Woo382e5892020-05-20 16:48:40 -0700976 if bios_image:
977 self.servo.program_bios(bios_image, rw_only)
Brent Petersonc70a1832020-01-24 15:54:35 -0800978 if utils.host_is_in_lab_zone(self.hostname):
979 self._add_fw_version_label(build, rw_only)
Brent Peterson1cb623a2020-01-09 13:14:28 -0800980
981 # Reboot and wait for DUT after installing firmware
982 logging.info('Rebooting DUT.')
983 self.servo.get_power_state_controller().reset()
984 time.sleep(self.servo.BOOT_DELAY)
985 self.test_wait_for_boot()
986
987 # When enabled verify EC and BIOS firmware version after programming
988 if verify_version:
Brent Peterson669edf42020-02-07 15:07:54 -0800989 # Check programmed EC firmware when EC image was found
990 if ec_image:
991 logging.info('Checking EC firmware version.')
992 dest_ec_version = self.get_ec_version()
Brent Peterson8039b472020-02-14 10:51:23 -0800993 ec_version_prefix = dest_ec_version.split('_', 1)[0]
994 ec_regex = self._EC_REGEX % ec_version_prefix
Brent Peterson669edf42020-02-07 15:07:54 -0800995 image_ec_version = self.get_version_from_image(ec_image,
Brent Peterson8039b472020-02-14 10:51:23 -0800996 ec_regex)
Brent Peterson669edf42020-02-07 15:07:54 -0800997 if dest_ec_version != image_ec_version:
998 raise error.TestFail(
Namyoon Wooe2c009a2020-07-22 10:09:03 -0700999 'Failed to update EC firmware, version %s '
1000 '(expected %s)' % (dest_ec_version,
1001 image_ec_version))
Brent Peterson1cb623a2020-01-09 13:14:28 -08001002
Namyoon Woo382e5892020-05-20 16:48:40 -07001003 if bios_image:
1004 # Check programmed BIOS firmware against expected version
1005 logging.info('Checking BIOS firmware version.')
1006 dest_bios_version = self.get_firmware_version()
1007 bios_version_prefix = dest_bios_version.split('.', 1)[0]
1008 bios_regex = self._BIOS_REGEX % bios_version_prefix
1009 image_bios_version = self.get_version_from_image(bios_image,
1010 bios_regex)
1011 if dest_bios_version != image_bios_version:
1012 raise error.TestFail(
Namyoon Wooe2c009a2020-07-22 10:09:03 -07001013 'Failed to update BIOS, version %s '
Namyoon Woo382e5892020-05-20 16:48:40 -07001014 '(expected %s)' % (dest_bios_version,
1015 image_bios_version))
Dan Shi9cb0eec2014-06-03 09:04:50 -07001016 finally:
Mary Ruthven6481a9f2019-08-23 12:46:05 -07001017 if tmpd:
1018 tmpd.clean()
Dan Shi9cb0eec2014-06-03 09:04:50 -07001019
1020
Garry Wang790953f2020-10-29 21:11:57 -07001021 def servo_install(self,
1022 image_url=None,
1023 usb_boot_timeout=USB_BOOT_TIMEOUT,
1024 install_timeout=INSTALL_TIMEOUT,
1025 is_repair=False):
Scott Zawalski62bacae2013-03-05 10:40:32 -05001026 """
1027 Re-install the OS on the DUT by:
1028 1) installing a test image on a USB storage device attached to the Servo
1029 board,
Richard Barnette03a0c132012-11-05 12:40:35 -08001030 2) booting that image in recovery mode, and then
J. Richard Barnette31b2e312013-04-04 16:05:22 -07001031 3) installing the image with chromeos-install.
1032
Scott Zawalski62bacae2013-03-05 10:40:32 -05001033 @param image_url: If specified use as the url to install on the DUT.
1034 otherwise boot the currently staged image on the USB stick.
beepsf079cfb2013-09-18 17:49:51 -07001035 @param usb_boot_timeout: The usb_boot_timeout to use during reimage.
1036 Factory images need a longer usb_boot_timeout than regular
1037 cros images.
1038 @param install_timeout: The timeout to use when installing the chromeos
1039 image. Factory images need a longer install_timeout.
Garry Wang790953f2020-10-29 21:11:57 -07001040 @param is_repair: Indicates if the method is called from a repair task.
Richard Barnette03a0c132012-11-05 12:40:35 -08001041
Scott Zawalski62bacae2013-03-05 10:40:32 -05001042 @raises AutoservError if the image fails to boot.
beepsf079cfb2013-09-18 17:49:51 -07001043
J. Richard Barnette0199cc82014-12-05 17:08:40 -08001044 """
Garry Wang7b0e1b72020-03-25 19:08:59 -07001045 if image_url:
1046 logging.info('Downloading image to USB, then booting from it.'
1047 ' Usb boot timeout = %s', usb_boot_timeout)
1048 else:
1049 logging.info('Booting from USB directly. Usb boot timeout = %s',
1050 usb_boot_timeout)
1051
1052 metrics_field = {'download': bool(image_url)}
1053 metrics.Counter(
1054 'chromeos/autotest/provision/servo_install/download_image'
1055 ).increment(fields=metrics_field)
1056
Allen Li48a13fe2016-11-22 14:10:40 -08001057 with metrics.SecondsTimer(
1058 'chromeos/autotest/provision/servo_install/boot_duration'):
Otabek Kasimovb887a002020-12-29 02:54:38 -08001059 self.servo.get_power_state_controller().power_off()
Otabek Kasimovb7cb8422020-12-23 02:38:32 -08001060 try:
1061 self.servo.image_to_servo_usb(image_path=image_url,
1062 power_off_dut=False)
1063 except error.AutotestError as e:
1064 metrics.Counter('chromeos/autotest/repair/image_to_usb_error'
1065 ).increment(
1066 fields={'host': self.hostname or ''})
1067 six.reraise(error.AutotestError, str(e), sys.exc_info()[2])
1068 # Give the DUT some time to power_off if we skip
1069 # download image to usb. (crbug.com/982993)
1070 if not image_url:
1071 time.sleep(10)
Garry Wang53fc8f32020-09-18 13:30:08 -07001072 need_snk = self.require_snk_mode_in_recovery()
Otabek Kasimovb7cb8422020-12-23 02:38:32 -08001073 self.servo.boot_in_recovery_mode(snk_mode=need_snk)
Allen Li48a13fe2016-11-22 14:10:40 -08001074 if not self.wait_up(timeout=usb_boot_timeout):
Garry Wang53fc8f32020-09-18 13:30:08 -07001075 if need_snk:
1076 # Attempt to restore servo_v4 role to 'src' mode.
1077 self.servo.set_servo_v4_role('src')
Allen Li48a13fe2016-11-22 14:10:40 -08001078 raise hosts.AutoservRepairError(
1079 'DUT failed to boot from USB after %d seconds' %
Garry Wang9ced7aa2020-04-10 17:26:35 -07001080 usb_boot_timeout, 'failed_to_boot_pre_install')
Scott Zawalski62bacae2013-03-05 10:40:32 -05001081
Garry Wang2e347df2020-10-30 14:04:26 -07001082 # Make sure the DUT is boot from an external device.
1083 if not self.is_boot_from_external_device():
1084 raise hosts.AutoservRepairError(
1085 'DUT is expected to boot from an external device(e.g. '
1086 'a usb stick), however it seems still boot from an'
1087 ' internal storage.', 'boot_from_internal_storage')
1088
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +08001089 # The new chromeos-tpm-recovery has been merged since R44-7073.0.0.
1090 # In old CrOS images, this command fails. Skip the error.
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +08001091 logging.info('Resetting the TPM status')
Tom Wai-Hong Tamf6b4f812015-08-08 04:14:59 +08001092 try:
1093 self.run('chromeos-tpm-recovery')
1094 except error.AutoservRunError:
1095 logging.warn('chromeos-tpm-recovery is too old.')
1096
Tom Wai-Hong Tam27af7332015-07-25 06:09:39 +08001097
Allen Li48a13fe2016-11-22 14:10:40 -08001098 with metrics.SecondsTimer(
1099 'chromeos/autotest/provision/servo_install/install_duration'):
1100 logging.info('Installing image through chromeos-install.')
Garry Wang033a31e2020-04-10 17:20:49 -07001101 try:
1102 self.run('chromeos-install --yes',timeout=install_timeout)
1103 self.halt()
Otabek Kasimov808cd832020-05-28 18:27:46 -07001104 except Exception as e:
1105 storage_errors = [
1106 'No space left on device',
1107 'I/O error when trying to write primary GPT',
1108 'Input/output error while writing out',
1109 'cannot read GPT header',
Otabek Kasimov2b7e8302020-08-21 09:23:31 -07001110 'can not determine destination device',
1111 'wrong fs type',
1112 'bad superblock on',
Otabek Kasimov808cd832020-05-28 18:27:46 -07001113 ]
1114 has_error = [msg for msg in storage_errors if(msg in str(e))]
1115 if has_error:
1116 info = self.host_info_store.get()
1117 info.set_version_label(
1118 audit_const.DUT_STORAGE_STATE_PREFIX,
1119 audit_const.HW_STATE_NEED_REPLACEMENT)
1120 self.host_info_store.commit(info)
Otabek Kasimov6825b762020-06-23 23:42:44 -07001121 self.set_device_repair_state(
Otabek Kasimov832d9162020-07-27 19:24:57 -07001122 cros_constants.DEVICE_STATE_NEEDS_REPLACEMENT)
Otabek Kasimov808cd832020-05-28 18:27:46 -07001123 logging.debug(
1124 'Fail install image from USB; Storage error; %s', e)
1125 raise error.AutoservError(
1126 'Failed to install image from USB due to a suspect '
1127 'disk failure, DUT storage state changed to '
1128 'need_replacement, please check debug log '
1129 'for details.')
1130 else:
Garry Wang790953f2020-10-29 21:11:57 -07001131 if is_repair:
1132 # DUT will be marked for replacement if storage is bad.
1133 audit_verify.VerifyDutStorage(self).verify()
Otabek Kasimov27bb2862020-08-10 14:40:45 -07001134
Otabek Kasimov808cd832020-05-28 18:27:46 -07001135 logging.debug('Fail install image from USB; %s', e)
1136 raise error.AutoservError(
1137 'Failed to install image from USB due to unexpected '
1138 'error, please check debug log for details.')
Garry Wang033a31e2020-04-10 17:20:49 -07001139 finally:
1140 # We need reset the DUT no matter re-install success or not,
1141 # as we don't want leave the DUT in boot from usb state.
1142 logging.info('Power cycling DUT through servo.')
1143 self.servo.get_power_state_controller().power_off()
1144 self.servo.switch_usbkey('off')
Garry Wang53fc8f32020-09-18 13:30:08 -07001145 if need_snk:
1146 # Attempt to restore servo_v4 role to 'src' mode.
1147 self.servo.set_servo_v4_role('src')
Garry Wang033a31e2020-04-10 17:20:49 -07001148 # N.B. The Servo API requires that we use power_on() here
1149 # for two reasons:
1150 # 1) After turning on a DUT in recovery mode, you must turn
1151 # it off and then on with power_on() once more to
1152 # disable recovery mode (this is a Parrot specific
1153 # requirement).
1154 # 2) After power_off(), the only way to turn on is with
1155 # power_on() (this is a Storm specific requirement).
1156 self.servo.get_power_state_controller().power_on()
beepsf079cfb2013-09-18 17:49:51 -07001157
1158 logging.info('Waiting for DUT to come back up.')
Richard Barnette03a0c132012-11-05 12:40:35 -08001159 if not self.wait_up(timeout=self.BOOT_TIMEOUT):
Garry Wang9ced7aa2020-04-10 17:26:35 -07001160 raise hosts.AutoservRepairError('DUT failed to reboot installed '
1161 'test image after %d seconds' %
1162 self.BOOT_TIMEOUT,
1163 'failed_to_boot_post_install')
Scott Zawalski62bacae2013-03-05 10:40:32 -05001164
1165
Garry Wanga2e78172020-09-09 23:49:07 -07001166 def set_servo_host(self, host, servo_state=None):
Richard Barnette4aeb01c2018-09-20 09:36:12 -07001167 """Set our servo host member, and associated servo.
1168
1169 @param host Our new `ServoHost`.
1170 """
1171 self._servo_host = host
Derek Beckettb66e5c82020-08-12 15:31:02 -07001172 self.servo_pwr_supported = None
Richard Barnette4aeb01c2018-09-20 09:36:12 -07001173 if self._servo_host is not None:
1174 self.servo = self._servo_host.get_servo()
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001175 servo_state = self._servo_host.get_servo_state()
Garry Wang000c6c02020-05-11 21:27:23 -07001176 self._set_smart_usbhub_label(self._servo_host.smart_usbhub)
Derek Beckettb66e5c82020-08-12 15:31:02 -07001177 try:
1178 self.servo_pwr_supported = self.servo.has_control('power_state')
1179 except Exception as e:
1180 logging.debug(
1181 "Could not get servo power state due to {}".format(e))
Gregory Nisbet93b23e22020-10-02 20:42:16 +00001182 else:
1183 self.servo = None
Derek Beckettb66e5c82020-08-12 15:31:02 -07001184 self.servo_pwr_supported = False
Otabek Kasimov41301a22020-05-10 15:28:21 -07001185 self.set_servo_type()
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001186 self.set_servo_state(servo_state)
Otabek Kasimov382c3bb2020-10-28 13:22:45 -07001187 self._set_servo_topology()
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001188
Richard Barnette4aeb01c2018-09-20 09:36:12 -07001189
Richard Barnette9a26ad62016-06-10 12:03:08 -07001190 def repair_servo(self):
Dan Shi90466352015-09-22 15:01:05 -07001191 """
Richard Barnette9a26ad62016-06-10 12:03:08 -07001192 Confirm that servo is initialized and verified.
Dan Shi90466352015-09-22 15:01:05 -07001193
Richard Barnette9a26ad62016-06-10 12:03:08 -07001194 If the servo object is missing, attempt to repair the servo
1195 host. Repair failures are passed back to the caller.
1196
1197 @raise AutoservError: If there is no servo host for this CrOS
1198 host.
1199 """
1200 if self.servo:
1201 return
1202 if not self._servo_host:
1203 raise error.AutoservError('No servo host for %s.' %
1204 self.hostname)
Otabek Kasimovcc9738e2020-02-14 16:17:15 -08001205 try:
1206 self._servo_host.repair()
1207 except:
1208 raise
1209 finally:
1210 self.set_servo_host(self._servo_host)
1211
1212
Otabek Kasimov41301a22020-05-10 15:28:21 -07001213 def set_servo_type(self):
1214 """Set servo info labels to dut host_info"""
1215 if not self.servo:
Otabek Kasimovbea89e52020-05-12 15:40:00 -07001216 logging.debug('Servo is not initialized to get servo_type.')
Otabek Kasimov41301a22020-05-10 15:28:21 -07001217 return
1218 servo_type = self.servo.get_servo_type()
1219 if not servo_type:
Otabek Kasimovbea89e52020-05-12 15:40:00 -07001220 logging.debug('Cannot collect servo_type from servo'
Otabek Kasimov41301a22020-05-10 15:28:21 -07001221 ' by `dut-control servo_type`! Please file a bug'
1222 ' and inform infra team as we are not expected '
1223 ' to reach this point.')
1224 return
1225 host_info = self.host_info_store.get()
1226 prefix = servo_constants.SERVO_TYPE_LABEL_PREFIX
1227 old_type = host_info.get_label_value(prefix)
1228 if old_type == servo_type:
1229 # do not need update
1230 return
1231 host_info.set_version_label(prefix, servo_type)
1232 self.host_info_store.commit(host_info)
1233 logging.info('ServoHost: servo_type updated to %s '
1234 '(previous: %s)', servo_type, old_type)
1235
1236
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001237 def set_servo_state(self, servo_state):
Otabek Kasimovcc9738e2020-02-14 16:17:15 -08001238 """Set servo info labels to dut host_info"""
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001239 if servo_state is not None:
Otabek Kasimovcc9738e2020-02-14 16:17:15 -08001240 host_info = self.host_info_store.get()
Garry Wang11b5e872020-03-11 15:14:08 -07001241 servo_state_prefix = servo_constants.SERVO_STATE_LABEL_PREFIX
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001242 old_state = host_info.get_label_value(servo_state_prefix)
1243 if old_state == servo_state:
1244 # do not need update
1245 return
1246 host_info.set_version_label(servo_state_prefix, servo_state)
Otabek Kasimovcc9738e2020-02-14 16:17:15 -08001247 self.host_info_store.commit(host_info)
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001248 logging.info('ServoHost: servo_state updated to %s (previous: %s)',
1249 servo_state, old_state)
Dan Shi90466352015-09-22 15:01:05 -07001250
1251
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001252 def get_servo_state(self):
1253 host_info = self.host_info_store.get()
Garry Wang11b5e872020-03-11 15:14:08 -07001254 servo_state_prefix = servo_constants.SERVO_STATE_LABEL_PREFIX
Otabek Kasimova7ba91a2020-03-09 08:31:01 -07001255 return host_info.get_label_value(servo_state_prefix)
1256
Otabek Kasimov5f039202020-10-28 15:45:29 -07001257 def is_servo_in_working_state(self):
1258 """Validate servo is in WORKING state."""
1259 servo_state = self.get_servo_state()
1260 return servo_state == servo_constants.SERVO_STATE_WORKING
1261
Dana Goyette655af512020-09-03 10:48:23 -07001262 def get_servo_usb_state(self):
1263 """Get the label value indicating the health of the USB drive.
1264
1265 @return: The label value if defined, otherwise '' (empty string).
1266 @rtype: str
1267 """
1268 host_info = self.host_info_store.get()
1269 servo_usb_state_prefix = audit_const.SERVO_USB_STATE_PREFIX
1270 return host_info.get_label_value(servo_usb_state_prefix)
1271
1272 def is_servo_usb_usable(self):
1273 """Check if the servo USB storage device is usable for FAFT.
1274
1275 @return: False if the label indicates a state that will break FAFT.
1276 True if state is okay, or if state is not defined.
1277 @rtype: bool
1278 """
1279 usb_state = self.get_servo_usb_state()
1280 return usb_state in ('', audit_const.HW_STATE_ACCEPTABLE,
1281 audit_const.HW_STATE_NORMAL,
1282 audit_const.HW_STATE_UNKNOWN)
Otabek Kasimov41301a22020-05-10 15:28:21 -07001283
Garry Wang000c6c02020-05-11 21:27:23 -07001284 def _set_smart_usbhub_label(self, smart_usbhub_detected):
1285 if smart_usbhub_detected is None:
1286 # skip the label update here as this indicate we wasn't able
1287 # to confirm usbhub type.
1288 return
1289 host_info = self.host_info_store.get()
1290 if (smart_usbhub_detected ==
1291 (servo_constants.SMART_USBHUB_LABEL in host_info.labels)):
1292 # skip label update if current label match the truth.
1293 return
1294 if smart_usbhub_detected:
1295 logging.info('Adding %s label to host %s',
1296 servo_constants.SMART_USBHUB_LABEL,
1297 self.hostname)
1298 host_info.labels.append(servo_constants.SMART_USBHUB_LABEL)
1299 else:
1300 logging.info('Removing %s label from host %s',
1301 servo_constants.SMART_USBHUB_LABEL,
1302 self.hostname)
1303 host_info.labels.remove(servo_constants.SMART_USBHUB_LABEL)
1304 self.host_info_store.commit(host_info)
1305
J. Richard Barnettec2d99cf2015-11-18 12:46:15 -08001306 def repair(self):
1307 """Attempt to get the DUT to pass `self.verify()`.
Richard Barnette82c35912012-11-20 10:09:10 -08001308
1309 This overrides the base class function for repair; it does
J. Richard Barnette91137f02016-03-10 16:52:26 -08001310 not call back to the parent class, but instead relies on
1311 `self._repair_strategy` to coordinate the verification and
1312 repair steps needed to get the DUT working.
Richard Barnette82c35912012-11-20 10:09:10 -08001313 """
Richard Barnetteabbdc252018-07-26 16:57:42 -07001314 message = 'Beginning repair for host %s board %s model %s'
1315 info = self.host_info_store.get()
1316 message %= (self.hostname, info.board, info.model)
1317 self.record('INFO', None, None, message)
Garry Wanga2e78172020-09-09 23:49:07 -07001318 profile_state = profile_constants.DUT_STATE_READY
Shijin Abraham78ce4402020-09-08 22:04:27 -07001319 # Initialize bluetooth peers
1320 self.initialize_btpeer()
Garry Wang87af1d02020-05-26 17:55:54 -07001321 try:
1322 self._repair_strategy.repair(self)
1323 except hosts.AutoservVerifyDependencyError as e:
Otabek Kasimovd48389b2020-12-07 02:38:34 -08001324 # TODO(otabek): remove when finish b/174191325
1325 self._stat_if_pingable_but_not_sshable()
Garry Wang87af1d02020-05-26 17:55:54 -07001326 # We don't want flag a DUT as failed if only non-critical
1327 # verifier(s) failed during the repair.
1328 if e.is_critical():
Garry Wanga2e78172020-09-09 23:49:07 -07001329 profile_state = profile_constants.DUT_STATE_REPAIR_FAILED
Otabek Kasimov86062d02020-11-17 13:30:22 -08001330 self._reboot_labstation_if_needed()
Otabek Kasimov7cad9ce2020-07-28 14:58:48 -07001331 self.try_set_device_needs_manual_repair()
Garry Wang87af1d02020-05-26 17:55:54 -07001332 raise
Garry Wanga2e78172020-09-09 23:49:07 -07001333 finally:
1334 self.set_health_profile_dut_state(profile_state)
Scott Zawalski89c44dd2013-02-26 09:28:02 -05001335
Otabek Kasimov8bb09912020-10-01 14:44:57 -07001336 def get_verifier_state(self, tag):
1337 """Return the state of servo verifier.
1338
1339 @returns: bool or None
1340 """
1341 return self._repair_strategy.verifier_is_good(tag)
Richard Barnette82c35912012-11-20 10:09:10 -08001342
J. Richard Barnette1d78b012012-05-15 13:56:30 -07001343 def close(self):
David Rileye2c6be12017-12-11 10:20:57 -08001344 """Close connection."""
Fang Deng0ca40e22013-08-27 17:47:44 -07001345 super(CrosHost, self).close()
howardchung83e55272019-08-08 14:08:05 +08001346
Shijin Abraham783a7dd2020-02-14 15:36:11 -08001347 if self._chameleon_host:
1348 self._chameleon_host.close()
xixuand6011f12016-12-08 15:01:58 -08001349
Garry Wang1a493d82020-08-31 21:01:19 -07001350 if self.health_profile:
1351 try:
1352 self.health_profile.close()
1353 except Exception as e:
1354 logging.warning(
1355 'Failed to finalize device health profile; %s', e)
1356
xixuand6011f12016-12-08 15:01:58 -08001357 if self._servo_host:
1358 self._servo_host.close()
J. Richard Barnette1d78b012012-05-15 13:56:30 -07001359
Dan Shi49ca0932014-11-14 11:22:27 -08001360 def get_power_supply_info(self):
1361 """Get the output of power_supply_info.
1362
1363 power_supply_info outputs the info of each power supply, e.g.,
1364 Device: Line Power
1365 online: no
1366 type: Mains
1367 voltage (V): 0
1368 current (A): 0
1369 Device: Battery
1370 state: Discharging
1371 percentage: 95.9276
1372 technology: Li-ion
1373
1374 Above output shows two devices, Line Power and Battery, with details of
1375 each device listed. This function parses the output into a dictionary,
1376 with key being the device name, and value being a dictionary of details
1377 of the device info.
1378
1379 @return: The dictionary of power_supply_info, e.g.,
1380 {'Line Power': {'online': 'yes', 'type': 'main'},
1381 'Battery': {'vendor': 'xyz', 'percentage': '100'}}
Dan Shie9b765d2014-12-29 16:59:49 -08001382 @raise error.AutoservRunError if power_supply_info tool is not found in
1383 the DUT. Caller should handle this error to avoid false failure
1384 on verification.
Dan Shi49ca0932014-11-14 11:22:27 -08001385 """
1386 result = self.run('power_supply_info').stdout.strip()
1387 info = {}
1388 device_name = None
1389 device_info = {}
1390 for line in result.split('\n'):
1391 pair = [v.strip() for v in line.split(':')]
1392 if len(pair) != 2:
1393 continue
1394 if pair[0] == 'Device':
1395 if device_name:
1396 info[device_name] = device_info
1397 device_name = pair[1]
1398 device_info = {}
1399 else:
1400 device_info[pair[0]] = pair[1]
1401 if device_name and not device_name in info:
1402 info[device_name] = device_info
1403 return info
1404
1405
1406 def get_battery_percentage(self):
1407 """Get the battery percentage.
1408
1409 @return: The percentage of battery level, value range from 0-100. Return
1410 None if the battery info cannot be retrieved.
1411 """
1412 try:
1413 info = self.get_power_supply_info()
1414 logging.info(info)
1415 return float(info['Battery']['percentage'])
Dan Shie9b765d2014-12-29 16:59:49 -08001416 except (KeyError, ValueError, error.AutoservRunError):
Dan Shi49ca0932014-11-14 11:22:27 -08001417 return None
1418
1419
Philip Chenaf69ead2020-03-27 13:06:42 -07001420 def get_battery_state(self):
1421 """Get the battery charging state.
1422
1423 @return: A string representing the battery charging state. It can be
1424 'Charging', 'Fully charged', or 'Discharging'.
1425 """
1426 try:
1427 info = self.get_power_supply_info()
1428 logging.info(info)
1429 return info['Battery']['state']
1430 except (KeyError, ValueError, error.AutoservRunError):
1431 return None
1432
1433
Daniel Campello8ca25c22019-12-13 16:48:26 -07001434 def get_battery_display_percentage(self):
1435 """Get the battery display percentage.
1436
1437 @return: The display percentage of battery level, value range from
1438 0-100. Return None if the battery info cannot be retrieved.
1439 """
1440 try:
1441 info = self.get_power_supply_info()
1442 logging.info(info)
1443 return float(info['Battery']['display percentage'])
1444 except (KeyError, ValueError, error.AutoservRunError):
1445 return None
1446
1447
Dan Shi49ca0932014-11-14 11:22:27 -08001448 def is_ac_connected(self):
1449 """Check if the dut has power adapter connected and charging.
1450
1451 @return: True if power adapter is connected and charging.
1452 """
1453 try:
1454 info = self.get_power_supply_info()
1455 return info['Line Power']['online'] == 'yes'
Dan Shie9b765d2014-12-29 16:59:49 -08001456 except (KeyError, error.AutoservRunError):
1457 return None
Dan Shi49ca0932014-11-14 11:22:27 -08001458
1459
Simran Basi5e6339a2013-03-21 11:34:32 -07001460 def _cleanup_poweron(self):
1461 """Special cleanup method to make sure hosts always get power back."""
Garry Wangad4d4fd2019-01-30 17:00:38 -08001462 info = self.host_info_store.get()
1463 if self._RPM_OUTLET_CHANGED not in info.attributes:
Simran Basi5e6339a2013-03-21 11:34:32 -07001464 return
1465 logging.debug('This host has recently interacted with the RPM'
1466 ' Infrastructure. Ensuring power is on.')
1467 try:
1468 self.power_on()
Garry Wangad4d4fd2019-01-30 17:00:38 -08001469 self._remove_rpm_changed_tag()
Simran Basi5e6339a2013-03-21 11:34:32 -07001470 except rpm_client.RemotePowerException:
Simran Basi5e6339a2013-03-21 11:34:32 -07001471 logging.error('Failed to turn Power On for this host after '
1472 'cleanup through the RPM Infrastructure.')
Dan Shi49ca0932014-11-14 11:22:27 -08001473
1474 battery_percentage = self.get_battery_percentage()
Otabek Kasimov58e22562020-11-03 17:17:41 -08001475 if (
1476 battery_percentage
1477 and battery_percentage < cros_constants.MIN_BATTERY_LEVEL):
Dan Shi49ca0932014-11-14 11:22:27 -08001478 raise
1479 elif self.is_ac_connected():
1480 logging.info('The device has power adapter connected and '
1481 'charging. No need to try to turn RPM on '
1482 'again.')
Garry Wangad4d4fd2019-01-30 17:00:38 -08001483 self._remove_rpm_changed_tag()
Dan Shi49ca0932014-11-14 11:22:27 -08001484 logging.info('Battery level is now at %s%%. The device may '
1485 'still have enough power to run test, so no '
1486 'exception will be raised.', battery_percentage)
1487
Simran Basi5e6339a2013-03-21 11:34:32 -07001488
Garry Wangad4d4fd2019-01-30 17:00:38 -08001489 def _remove_rpm_changed_tag(self):
1490 info = self.host_info_store.get()
1491 del info.attributes[self._RPM_OUTLET_CHANGED]
1492 self.host_info_store.commit(info)
1493
1494
1495 def _add_rpm_changed_tag(self):
1496 info = self.host_info_store.get()
Garry Wang518831d2019-02-21 15:15:36 -08001497 info.attributes[self._RPM_OUTLET_CHANGED] = 'true'
Garry Wangad4d4fd2019-01-30 17:00:38 -08001498 self.host_info_store.commit(info)
1499
1500
1501
beepsc87ff602013-07-31 21:53:00 -07001502 def _is_factory_image(self):
1503 """Checks if the image on the DUT is a factory image.
1504
1505 @return: True if the image on the DUT is a factory image.
1506 False otherwise.
1507 """
1508 result = self.run('[ -f /root/.factory_test ]', ignore_status=True)
1509 return result.exit_status == 0
1510
1511
1512 def _restart_ui(self):
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001513 """Restart the Chrome UI.
beepsc87ff602013-07-31 21:53:00 -07001514
1515 @raises: FactoryImageCheckerException for factory images, since
1516 we cannot attempt to restart ui on them.
1517 error.AutoservRunError for any other type of error that
1518 occurs while restarting ui.
1519 """
1520 if self._is_factory_image():
Dan Shi549fb822015-03-24 18:01:11 -07001521 raise FactoryImageCheckerException('Cannot restart ui on factory '
1522 'images')
beepsc87ff602013-07-31 21:53:00 -07001523
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001524 # TODO(jrbarnette): The command to stop/start the ui job
1525 # should live inside cros_ui, too. However that would seem
1526 # to imply interface changes to the existing start()/restart()
1527 # functions, which is a bridge too far (for now).
J. Richard Barnette6069aa12015-06-08 09:10:24 -07001528 prompt = cros_ui.get_chrome_session_ident(self)
J. Richard Barnette84890bd2014-02-21 11:05:47 -08001529 self.run('stop ui; start ui')
1530 cros_ui.wait_for_chrome_ready(prompt, self)
beepsc87ff602013-07-31 21:53:00 -07001531
1532
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001533 def _start_powerd_if_needed(self):
1534 """Start powerd if it isn't already running."""
1535 self.run('start powerd', ignore_status=True)
1536
Kazuhiro Inabaa7a00492020-12-17 16:05:12 +09001537 def _read_arc_prop_file(self, filename):
1538 for path in [
1539 '/usr/share/arcvm/properties/', '/usr/share/arc/properties/'
1540 ]:
1541 if self.path_exists(path + filename):
1542 return utils.parse_cmd_output('cat ' + path + filename,
1543 run_method=self.run)
1544 return None
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001545
Jiyoun Hac172ee72020-12-15 08:57:29 +09001546 def _get_arc_build_info(self):
1547 """Returns a dictionary mapping build properties to their values."""
1548 build_info = None
Kazuhiro Inabaa7a00492020-12-17 16:05:12 +09001549 for filename in ['build.prop', 'vendor_build.prop']:
1550 properties = self._read_arc_prop_file(filename)
1551 if properties:
1552 if build_info:
1553 build_info.update(properties)
1554 else:
1555 build_info = properties
1556 else:
1557 logging.error('Failed to find %s in device.', filename)
Jiyoun Hac172ee72020-12-15 08:57:29 +09001558 return build_info
1559
1560 def _get_arc_primary_abi(self):
1561 """Returns the primary abi of the host."""
1562 return self._get_arc_build_info().get('ro.product.cpu.abi')
1563
1564 def _get_arc_security_patch(self):
1565 """Returns the security patch of the host."""
1566 return self._get_arc_build_info().get('ro.build.version.security_patch')
1567
Kazuhiro Inabaa7a00492020-12-17 16:05:12 +09001568 def get_arc_first_api_level(self):
1569 """Returns the security patch of the host."""
1570 return self._get_arc_build_info().get('ro.product.first_api_level')
1571
xixuana3bbc422017-05-04 15:57:21 -07001572 def _get_lsb_release_content(self):
1573 """Return the content of lsb-release file of host."""
1574 return self.run(
1575 'cat "%s"' % client_constants.LSB_RELEASE).stdout.strip()
1576
1577
Dan Shi549fb822015-03-24 18:01:11 -07001578 def get_release_version(self):
1579 """Get the value of attribute CHROMEOS_RELEASE_VERSION from lsb-release.
1580
1581 @returns The version string in lsb-release, under attribute
1582 CHROMEOS_RELEASE_VERSION.
1583 """
Dan Shi549fb822015-03-24 18:01:11 -07001584 return lsbrelease_utils.get_chromeos_release_version(
xixuana3bbc422017-05-04 15:57:21 -07001585 lsb_release_content=self._get_lsb_release_content())
1586
1587
Don Garrettb9f35802018-01-22 18:25:40 -08001588 def get_release_builder_path(self):
1589 """Get the value of CHROMEOS_RELEASE_BUILDER_PATH from lsb-release.
1590
1591 @returns The version string in lsb-release, under attribute
1592 CHROMEOS_RELEASE_BUILDER_PATH.
1593 """
1594 return lsbrelease_utils.get_chromeos_release_builder_path(
1595 lsb_release_content=self._get_lsb_release_content())
1596
1597
xixuana3bbc422017-05-04 15:57:21 -07001598 def get_chromeos_release_milestone(self):
1599 """Get the value of attribute CHROMEOS_RELEASE_BUILD_TYPE
1600 from lsb-release.
1601
1602 @returns The version string in lsb-release, under attribute
1603 CHROMEOS_RELEASE_BUILD_TYPE.
1604 """
1605 return lsbrelease_utils.get_chromeos_release_milestone(
1606 lsb_release_content=self._get_lsb_release_content())
Dan Shi549fb822015-03-24 18:01:11 -07001607
1608
1609 def verify_cros_version_label(self):
Garry Wangd18e7b32020-08-07 18:31:44 -07001610 """Verify if host's cros-version label match the actual image in dut.
Dan Shi549fb822015-03-24 18:01:11 -07001611
Garry Wangd18e7b32020-08-07 18:31:44 -07001612 @returns True if the label match with image in dut, otherwise False
Dan Shi549fb822015-03-24 18:01:11 -07001613 """
Garry Wangd18e7b32020-08-07 18:31:44 -07001614 os_from_host = self.get_release_builder_path()
1615 info = self.host_info_store.get()
1616 os_from_label = info.get_label_value(self.VERSION_PREFIX)
1617 if not os_from_label:
1618 logging.debug('No existing %s label detected', self.VERSION_PREFIX)
1619 return True
1620
1621 # known cases where the version label will not match the
1622 # original CHROMEOS_RELEASE_BUILDER_PATH setting:
1623 # * Tests for the `arc-presubmit` append "-cheetsth" to the label.
1624 if os_from_label.endswith(provision.CHEETS_SUFFIX):
1625 logging.debug('%s label with %s suffix detected, this suffix will'
1626 ' be ignored when comparing label.',
1627 self.VERSION_PREFIX, provision.CHEETS_SUFFIX)
1628 os_from_label = os_from_label[:-len(provision.CHEETS_SUFFIX)]
1629 logging.debug('OS version from host: %s; OS verision cached in '
1630 'label: %s', os_from_host, os_from_label)
1631 return os_from_label == os_from_host
Dan Shi549fb822015-03-24 18:01:11 -07001632
1633
Laurence Goodby778c9a42017-05-24 19:24:07 -07001634 def cleanup_services(self):
1635 """Reinitializes the device for cleanup.
1636
1637 Subclasses may override this to customize the cleanup method.
1638
1639 To indicate failure of the reset, the implementation may raise
1640 any of:
1641 error.AutoservRunError
1642 error.AutotestRunError
1643 FactoryImageCheckerException
1644
1645 @raises error.AutoservRunError
1646 @raises error.AutotestRunError
1647 @raises error.FactoryImageCheckerException
1648 """
1649 self._restart_ui()
Daniel Erat4b5f7e02018-07-04 22:05:30 -07001650 self._start_powerd_if_needed()
Laurence Goodby778c9a42017-05-24 19:24:07 -07001651
1652
Gregory Nisbetec615d62020-12-11 17:59:20 +00001653 def cleanup(self):
1654 """Cleanup state on device."""
MK Ryu35d661e2014-09-25 17:44:10 -07001655 self.run('rm -f %s' % client_constants.CLEANUP_LOGS_PAUSED_FILE)
Scott Zawalskiddbc31e2012-11-15 11:29:01 -05001656 try:
Laurence Goodby778c9a42017-05-24 19:24:07 -07001657 self.cleanup_services()
beepsc87ff602013-07-31 21:53:00 -07001658 except (error.AutotestRunError, error.AutoservRunError,
1659 FactoryImageCheckerException):
Otabek Kasimovc0d77e82020-03-27 15:01:57 -07001660 logging.warning('Unable to restart ui.')
Namyoon Woo33f38852020-04-13 17:26:58 -07001661
Otabek Kasimovc0d77e82020-03-27 15:01:57 -07001662 # cleanup routines, i.e. reboot the machine.
Gregory Nisbetec615d62020-12-11 17:59:20 +00001663 super(CrosHost, self).cleanup()
Otabek Kasimovc0d77e82020-03-27 15:01:57 -07001664
Simran Basi5e6339a2013-03-21 11:34:32 -07001665 # Check if the rpm outlet was manipulated.
Simran Basid5e5e272012-09-24 15:23:59 -07001666 if self.has_power():
Simran Basi5e6339a2013-03-21 11:34:32 -07001667 self._cleanup_poweron()
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001668
Gregory Nisbetec615d62020-12-11 17:59:20 +00001669
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001670 def reboot(self, **dargs):
1671 """
1672 This function reboots the site host. The more generic
1673 RemoteHost.reboot() performs sync and sleeps for 5
1674 seconds. This is not necessary for Chrome OS devices as the
1675 sync should be finished in a short time during the reboot
1676 command.
1677 """
Gregory Nisbetec615d62020-12-11 17:59:20 +00001678 if 'reboot_cmd' not in dargs:
Doug Anderson7d5aeb22014-02-27 15:12:17 -08001679 reboot_timeout = dargs.get('reboot_timeout', 10)
J. Richard Barnette9af19632015-09-25 12:18:03 -07001680 dargs['reboot_cmd'] = ('sleep 1; '
1681 'reboot & sleep %d; '
1682 'reboot -f' % reboot_timeout)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001683 # Enable fastsync to avoid running extra sync commands before reboot.
Tom Wai-Hong Tamf5cd1d42012-08-13 12:04:08 +08001684 if 'fastsync' not in dargs:
1685 dargs['fastsync'] = True
Michael Liangda8c60a2014-06-03 13:24:51 -07001686
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001687 dargs['board'] = self.host_info_store.get().board
Vincent Palatindf2372c2016-10-07 17:03:00 +02001688 # Record who called us
1689 orig = sys._getframe(1).f_code
Vincent Palatin80780b22016-07-27 16:02:37 +02001690 metric_fields = {'board' : dargs['board'],
Vincent Palatindf2372c2016-10-07 17:03:00 +02001691 'dut_host_name' : self.hostname,
1692 'success' : True}
1693 metric_debug_fields = {'board' : dargs['board'],
Prathmesh Prabhu53a4c1c2018-09-14 16:36:27 -07001694 'caller' : "%s:%s" % (orig.co_filename,
1695 orig.co_name),
Vincent Palatindf2372c2016-10-07 17:03:00 +02001696 'success' : True,
1697 'error' : ''}
1698
Vincent Palatin80780b22016-07-27 16:02:37 +02001699 t0 = time.time()
1700 try:
1701 super(CrosHost, self).reboot(**dargs)
1702 except Exception as e:
1703 metric_fields['success'] = False
Vincent Palatindf2372c2016-10-07 17:03:00 +02001704 metric_debug_fields['success'] = False
1705 metric_debug_fields['error'] = type(e).__name__
Vincent Palatin80780b22016-07-27 16:02:37 +02001706 raise
1707 finally:
1708 duration = int(time.time() - t0)
Dan Shi5e2efb72017-02-07 11:40:23 -08001709 metrics.Counter(
1710 'chromeos/autotest/autoserv/reboot_count').increment(
1711 fields=metric_fields)
1712 metrics.Counter(
1713 'chromeos/autotest/autoserv/reboot_debug').increment(
1714 fields=metric_debug_fields)
1715 metrics.SecondsDistribution(
1716 'chromeos/autotest/autoserv/reboot_duration').add(
1717 duration, fields=metric_fields)
Yu-Ju Honga2be94a2012-07-31 09:48:52 -07001718
1719
Kalin Stoyanov83d9caa2020-01-31 16:58:27 -08001720 def suspend(self, suspend_time=60, delay_seconds=0,
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001721 suspend_cmd=None, allow_early_resume=False):
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001722 """
1723 This function suspends the site host.
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001724
1725 @param suspend_time: How long to suspend as integer seconds.
1726 @param suspend_cmd: Suspend command to execute.
1727 @param allow_early_resume: If False and if device resumes before
1728 |suspend_time|, throw an error.
1729
1730 @exception AutoservSuspendError Host resumed earlier than
1731 |suspend_time|.
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001732 """
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001733
1734 if suspend_cmd is None:
1735 suspend_cmd = ' && '.join([
J. Richard Barnette9af19632015-09-25 12:18:03 -07001736 'echo 0 > /sys/class/rtc/rtc0/wakealarm',
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001737 'echo +%d > /sys/class/rtc/rtc0/wakealarm' % suspend_time,
Kalin Stoyanov83d9caa2020-01-31 16:58:27 -08001738 'powerd_dbus_suspend --delay=%d' % delay_seconds])
Ravi Chandra Sadineni812e61b2018-07-09 11:16:50 -07001739 super(CrosHost, self).suspend(suspend_time, suspend_cmd,
1740 allow_early_resume);
Gwendal Grignou7a61d2f2014-05-23 11:05:51 -07001741
1742
Simran Basiec564392014-08-25 16:48:09 -07001743 def upstart_status(self, service_name):
1744 """Check the status of an upstart init script.
1745
1746 @param service_name: Service to look up.
1747
1748 @returns True if the service is running, False otherwise.
1749 """
Richard Barnettee204dc52017-09-26 11:02:25 -07001750 return 'start/running' in self.run('status %s' % service_name,
1751 ignore_status=True).stdout
Simran Basiec564392014-08-25 16:48:09 -07001752
Tom Hughese9552342018-12-18 14:29:25 -08001753 def upstart_stop(self, service_name):
1754 """Stops an upstart job if it's running.
1755
1756 @param service_name: Service to stop
1757
1758 @returns True if service has been stopped or was already stopped
1759 False otherwise.
1760 """
1761 if not self.upstart_status(service_name):
1762 return True
1763
1764 result = self.run('stop %s' % service_name, ignore_status=True)
1765 if result.exit_status != 0:
1766 return False
1767 return True
1768
1769 def upstart_restart(self, service_name):
1770 """Restarts (or starts) an upstart job.
1771
1772 @param service_name: Service to start/restart
1773
1774 @returns True if service has been started/restarted, False otherwise.
1775 """
1776 cmd = 'start'
1777 if self.upstart_status(service_name):
1778 cmd = 'restart'
1779 cmd = cmd + ' %s' % service_name
1780 result = self.run(cmd)
1781 if result.exit_status != 0:
1782 return False
1783 return True
Simran Basiec564392014-08-25 16:48:09 -07001784
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001785 def verify_software(self):
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001786 """Verify working software on a Chrome OS system.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001787
Richard Barnetteb2bc13c2013-01-08 17:32:51 -08001788 Tests for the following conditions:
1789 1. All conditions tested by the parent version of this
1790 function.
1791 2. Sufficient space in /mnt/stateful_partition.
Fang Deng6b05f5b2013-03-20 13:42:11 -07001792 3. Sufficient space in /mnt/stateful_partition/encrypted.
1793 4. update_engine answers a simple status request over DBus.
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001794
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001795 """
Fang Deng0ca40e22013-08-27 17:47:44 -07001796 super(CrosHost, self).verify_software()
Dan Shib8540a52015-07-16 14:18:23 -07001797 default_kilo_inodes_required = CONFIG.get_config_value(
1798 'SERVER', 'kilo_inodes_required', type=int, default=100)
1799 board = self.get_board().replace(ds_constants.BOARD_PREFIX, '')
1800 kilo_inodes_required = CONFIG.get_config_value(
1801 'SERVER', 'kilo_inodes_required_%s' % board,
1802 type=int, default=default_kilo_inodes_required)
1803 self.check_inodes('/mnt/stateful_partition', kilo_inodes_required)
J. Richard Barnette45e93de2012-04-11 17:24:15 -07001804 self.check_diskspace(
1805 '/mnt/stateful_partition',
Dan Shib8540a52015-07-16 14:18:23 -07001806 CONFIG.get_config_value(
Fang Deng6b05f5b2013-03-20 13:42:11 -07001807 'SERVER', 'gb_diskspace_required', type=float,
1808 default=20.0))
Gaurav Shahe448af82014-06-19 15:18:59 -07001809 encrypted_stateful_path = '/mnt/stateful_partition/encrypted'
1810 # Not all targets build with encrypted stateful support.
1811 if self.path_exists(encrypted_stateful_path):
1812 self.check_diskspace(
1813 encrypted_stateful_path,
Dan Shib8540a52015-07-16 14:18:23 -07001814 CONFIG.get_config_value(
Gaurav Shahe448af82014-06-19 15:18:59 -07001815 'SERVER', 'gb_encrypted_diskspace_required', type=float,
1816 default=0.1))
beepsc87ff602013-07-31 21:53:00 -07001817
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001818 self.wait_for_system_services()
Prashanth B5d0a0512014-04-25 12:26:08 -07001819
beepsc87ff602013-07-31 21:53:00 -07001820 # Factory images don't run update engine,
1821 # goofy controls dbus on these DUTs.
1822 if not self._is_factory_image():
1823 self.run('update_engine_client --status')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001824
1825
Justin TerAvest3b0c5ba2017-11-07 09:59:11 -07001826 @retry.retry(error.AutoservError, timeout_min=5, delay_sec=10)
1827 def wait_for_system_services(self):
1828 """Waits for system-services to be running.
1829
1830 Sometimes, update_engine will take a while to update firmware, so we
1831 should give this some time to finish. See crbug.com/765686#c38 for
1832 details.
1833 """
1834 if not self.upstart_status('system-services'):
1835 raise error.AutoservError('Chrome failed to reach login. '
1836 'System services not running.')
1837
1838
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001839 def verify(self):
Pradeep Sawlaniaa013fa2017-11-09 06:34:18 -08001840 """Verify Chrome OS system is in good state."""
Richard Barnetteabbdc252018-07-26 16:57:42 -07001841 message = 'Beginning verify for host %s board %s model %s'
1842 info = self.host_info_store.get()
1843 message %= (self.hostname, info.board, info.model)
1844 self.record('INFO', None, None, message)
Garry Wang87af1d02020-05-26 17:55:54 -07001845 try:
1846 self._repair_strategy.verify(self)
1847 except hosts.AutoservVerifyDependencyError as e:
1848 # We don't want flag a DUT as failed if only non-critical
1849 # verifier(s) failed during the repair.
1850 if e.is_critical():
1851 raise
J. Richard Barnettea7e7fdc2016-02-12 12:35:36 -08001852
1853
Fang Deng96667ca2013-08-01 17:46:18 -07001854 def make_ssh_command(self, user='root', port=22, opts='', hosts_file=None,
Dean Liaoe3e75f62017-11-14 10:36:43 +08001855 connect_timeout=None, alive_interval=None,
1856 alive_count_max=None, connection_attempts=None):
Fang Deng96667ca2013-08-01 17:46:18 -07001857 """Override default make_ssh_command to use options tuned for Chrome OS.
1858
1859 Tuning changes:
1860 - ConnectTimeout=30; maximum of 30 seconds allowed for an SSH
1861 connection failure. Consistency with remote_access.sh.
1862
Samuel Tan2ce155b2015-06-23 18:24:38 -07001863 - ServerAliveInterval=900; which causes SSH to ping connection every
1864 900 seconds. In conjunction with ServerAliveCountMax ensures
1865 that if the connection dies, Autotest will bail out.
Fang Deng96667ca2013-08-01 17:46:18 -07001866 Originally tried 60 secs, but saw frequent job ABORTS where
Samuel Tan2ce155b2015-06-23 18:24:38 -07001867 the test completed successfully. Later increased from 180 seconds to
1868 900 seconds to account for tests where the DUT is suspended for
1869 longer periods of time.
Fang Deng96667ca2013-08-01 17:46:18 -07001870
1871 - ServerAliveCountMax=3; consistency with remote_access.sh.
1872
1873 - ConnectAttempts=4; reduce flakiness in connection errors;
1874 consistency with remote_access.sh.
1875
1876 - UserKnownHostsFile=/dev/null; we don't care about the keys.
1877 Host keys change with every new installation, don't waste
1878 memory/space saving them.
1879
1880 - SSH protocol forced to 2; needed for ServerAliveInterval.
1881
1882 @param user User name to use for the ssh connection.
1883 @param port Port on the target host to use for ssh connection.
1884 @param opts Additional options to the ssh command.
1885 @param hosts_file Ignored.
1886 @param connect_timeout Ignored.
1887 @param alive_interval Ignored.
Dean Liaoe3e75f62017-11-14 10:36:43 +08001888 @param alive_count_max Ignored.
1889 @param connection_attempts Ignored.
Fang Deng96667ca2013-08-01 17:46:18 -07001890 """
Dean Liaoe3e75f62017-11-14 10:36:43 +08001891 options = ' '.join([opts, '-o Protocol=2'])
1892 return super(CrosHost, self).make_ssh_command(
1893 user=user, port=port, opts=options, hosts_file='/dev/null',
1894 connect_timeout=30, alive_interval=900, alive_count_max=3,
1895 connection_attempts=4)
1896
1897
Jason Abeleb6f924f2013-11-13 16:01:54 -08001898 def syslog(self, message, tag='autotest'):
1899 """Logs a message to syslog on host.
1900
1901 @param message String message to log into syslog
1902 @param tag String tag prefix for syslog
1903
1904 """
1905 self.run('logger -t "%s" "%s"' % (tag, message))
1906
1907
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001908 def _ping_check_status(self, status):
1909 """Ping the host once, and return whether it has a given status.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001910
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001911 @param status Check the ping status against this value.
1912 @return True iff `status` and the result of ping are the same
1913 (i.e. both True or both False).
1914
1915 """
Abhishek Pandit-Subedi038df162020-09-14 16:37:43 -07001916 ping_val = utils.ping(self.hostname,
1917 tries=1,
1918 deadline=1,
1919 timeout=2,
1920 ignore_timeout=True)
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001921 return not (status ^ (ping_val == 0))
1922
1923 def _ping_wait_for_status(self, status, timeout):
1924 """Wait for the host to have a given status (UP or DOWN).
1925
1926 Status is checked by polling. Polling will not last longer
1927 than the number of seconds in `timeout`. The polling
1928 interval will be long enough that only approximately
1929 _PING_WAIT_COUNT polling cycles will be executed, subject
1930 to a maximum interval of about one minute.
1931
1932 @param status Waiting will stop immediately if `ping` of the
1933 host returns this status.
1934 @param timeout Poll for at most this many seconds.
1935 @return True iff the host status from `ping` matched the
1936 requested status at the time of return.
1937
1938 """
1939 # _ping_check_status() takes about 1 second, hence the
1940 # "- 1" in the formula below.
Nathan Ciobanu38480a32016-10-25 15:26:45 -07001941 # FIXME: if the ping command errors then _ping_check_status()
1942 # returns instantly. If timeout is also smaller than twice
1943 # _PING_WAIT_COUNT then the while loop below forks many
1944 # thousands of ping commands (see /tmp/test_that_results_XXXXX/
1945 # /results-1-logging_YYY.ZZZ/debug/autoserv.DEBUG) and hogs one
1946 # CPU core for 60 seconds.
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001947 poll_interval = min(int(timeout / self._PING_WAIT_COUNT), 60) - 1
1948 end_time = time.time() + timeout
1949 while time.time() <= end_time:
1950 if self._ping_check_status(status):
1951 return True
1952 if poll_interval > 0:
1953 time.sleep(poll_interval)
1954
1955 # The last thing we did was sleep(poll_interval), so it may
1956 # have been too long since the last `ping`. Check one more
1957 # time, just to be sure.
1958 return self._ping_check_status(status)
1959
1960 def ping_wait_up(self, timeout):
1961 """Wait for the host to respond to `ping`.
1962
1963 N.B. This method is not a reliable substitute for
1964 `wait_up()`, because a host that responds to ping will not
1965 necessarily respond to ssh. This method should only be used
1966 if the target DUT can be considered functional even if it
1967 can't be reached via ssh.
1968
1969 @param timeout Minimum time to allow before declaring the
1970 host to be non-responsive.
1971 @return True iff the host answered to ping before the timeout.
1972
1973 """
1974 return self._ping_wait_for_status(self._PING_STATUS_UP, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001975
Andrew Bresticker678c0c72013-01-22 10:44:09 -08001976 def ping_wait_down(self, timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001977 """Wait until the host no longer responds to `ping`.
1978
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001979 This function can be used as a slightly faster version of
1980 `wait_down()`, by avoiding potentially long ssh timeouts.
1981
1982 @param timeout Minimum time to allow for the host to become
1983 non-responsive.
1984 @return True iff the host quit answering ping before the
1985 timeout.
1986
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001987 """
J. Richard Barnetteb6de7e32013-02-14 13:28:04 -08001988 return self._ping_wait_for_status(self._PING_STATUS_DOWN, timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07001989
Anand K Mistry50f218e2020-07-31 14:50:15 +10001990 def _is_host_port_forwarded(self):
Garry Wanga2e78172020-09-09 23:49:07 -07001991 """Checks if the dut is connected over port forwarding.
Anand K Mistry50f218e2020-07-31 14:50:15 +10001992
1993 N.B. This method does not detect all situations where port forwarding is
1994 occurring. Namely, running autotest on the dut may result in a
1995 false-positive, and port forwarding using a different machine on the
1996 same network will be a false-negative.
1997
1998 @return True if the dut is connected over port forwarding
1999 False otherwise
2000 """
Garry Wanga2e78172020-09-09 23:49:07 -07002001 is_localhost = self.hostname in ['localhost', '127.0.0.1']
2002 is_forwarded = is_localhost and not self.is_default_port
2003 if is_forwarded:
2004 logging.info('Detected DUT connected by port forwarding')
2005 return is_forwarded
Anand K Mistry50f218e2020-07-31 14:50:15 +10002006
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002007 def test_wait_for_sleep(self, sleep_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002008 """Wait for the client to enter low-power sleep mode.
2009
2010 The test for "is asleep" can't distinguish a system that is
2011 powered off; to confirm that the unit was asleep, it is
2012 necessary to force resume, and then call
2013 `test_wait_for_resume()`.
2014
2015 This function is expected to be called from a test as part
2016 of a sequence like the following:
2017
2018 ~~~~~~~~
2019 boot_id = host.get_boot_id()
2020 # trigger sleep on the host
2021 host.test_wait_for_sleep()
2022 # trigger resume on the host
2023 host.test_wait_for_resume(boot_id)
2024 ~~~~~~~~
2025
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002026 @param sleep_timeout time limit in seconds to allow the host sleep.
2027
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002028 @exception TestFail The host did not go to sleep within
2029 the allowed time.
2030 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002031 if sleep_timeout is None:
2032 sleep_timeout = self.SLEEP_TIMEOUT
2033
Anand K Mistry50f218e2020-07-31 14:50:15 +10002034 # If the dut is accessed over SSH port-forwarding, `ping` is not useful
2035 # for detecting the dut is down since a ping to localhost will always
2036 # succeed. In this case, fall back to wait_down() which uses SSH.
2037 if self._is_host_port_forwarded():
Garry Wanga2e78172020-09-09 23:49:07 -07002038 success = self.wait_down(timeout=sleep_timeout)
Anand K Mistry50f218e2020-07-31 14:50:15 +10002039 else:
Garry Wanga2e78172020-09-09 23:49:07 -07002040 success = self.ping_wait_down(timeout=sleep_timeout)
Anand K Mistry50f218e2020-07-31 14:50:15 +10002041
2042 if not success:
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002043 raise error.TestFail(
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002044 'client failed to sleep after %d seconds' % sleep_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002045
2046
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002047 def test_wait_for_resume(self, old_boot_id, resume_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002048 """Wait for the client to resume from low-power sleep mode.
2049
2050 The `old_boot_id` parameter should be the value from
2051 `get_boot_id()` obtained prior to entering sleep mode. A
2052 `TestFail` exception is raised if the boot id changes.
2053
2054 See @ref test_wait_for_sleep for more on this function's
2055 usage.
2056
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08002057 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002058 target host went to sleep.
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002059 @param resume_timeout time limit in seconds to allow the host up.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002060
2061 @exception TestFail The host did not respond within the
2062 allowed time.
2063 @exception TestFail The host responded, but the boot id test
2064 indicated a reboot rather than a sleep
2065 cycle.
2066 """
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002067 if resume_timeout is None:
2068 resume_timeout = self.RESUME_TIMEOUT
2069
2070 if not self.wait_up(timeout=resume_timeout):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002071 raise error.TestFail(
2072 'client failed to resume from sleep after %d seconds' %
Tom Wai-Hong Tamfced4f62014-04-17 10:56:30 +08002073 resume_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002074 else:
2075 new_boot_id = self.get_boot_id()
2076 if new_boot_id != old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08002077 logging.error('client rebooted (old boot %s, new boot %s)',
2078 old_boot_id, new_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002079 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08002080 'client rebooted, but sleep was expected')
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002081
2082
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08002083 def test_wait_for_shutdown(self, shutdown_timeout=None):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002084 """Wait for the client to shut down.
2085
2086 The test for "has shut down" can't distinguish a system that
2087 is merely asleep; to confirm that the unit was down, it is
2088 necessary to force boot, and then call test_wait_for_boot().
2089
2090 This function is expected to be called from a test as part
2091 of a sequence like the following:
2092
2093 ~~~~~~~~
2094 boot_id = host.get_boot_id()
2095 # trigger shutdown on the host
2096 host.test_wait_for_shutdown()
2097 # trigger boot on the host
2098 host.test_wait_for_boot(boot_id)
2099 ~~~~~~~~
2100
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08002101 @param shutdown_timeout time limit in seconds to allow the host down.
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002102 @exception TestFail The host did not shut down within the
2103 allowed time.
2104 """
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08002105 if shutdown_timeout is None:
2106 shutdown_timeout = self.SHUTDOWN_TIMEOUT
2107
Anand K Mistry50f218e2020-07-31 14:50:15 +10002108 if self._is_host_port_forwarded():
Garry Wanga2e78172020-09-09 23:49:07 -07002109 success = self.wait_down(timeout=shutdown_timeout)
Anand K Mistry50f218e2020-07-31 14:50:15 +10002110 else:
Garry Wanga2e78172020-09-09 23:49:07 -07002111 success = self.ping_wait_down(timeout=shutdown_timeout)
Anand K Mistry50f218e2020-07-31 14:50:15 +10002112
2113 if not success:
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002114 raise error.TestFail(
2115 'client failed to shut down after %d seconds' %
Tom Wai-Hong Tamfe005c22014-12-03 09:25:44 +08002116 shutdown_timeout)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002117
2118
2119 def test_wait_for_boot(self, old_boot_id=None):
2120 """Wait for the client to boot from cold power.
2121
2122 The `old_boot_id` parameter should be the value from
2123 `get_boot_id()` obtained prior to shutting down. A
2124 `TestFail` exception is raised if the boot id does not
2125 change. The boot id test is omitted if `old_boot_id` is not
2126 specified.
2127
2128 See @ref test_wait_for_shutdown for more on this function's
2129 usage.
2130
J. Richard Barnette7214e0b2013-02-06 15:20:49 -08002131 @param old_boot_id A boot id value obtained before the
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002132 shut down.
2133
2134 @exception TestFail The host did not respond within the
2135 allowed time.
2136 @exception TestFail The host responded, but the boot id test
2137 indicated that there was no reboot.
2138 """
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07002139 if not self.wait_up(timeout=self.REBOOT_TIMEOUT):
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002140 raise error.TestFail(
2141 'client failed to reboot after %d seconds' %
J. Richard Barnetteeb69d722012-06-18 17:29:44 -07002142 self.REBOOT_TIMEOUT)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002143 elif old_boot_id:
2144 if self.get_boot_id() == old_boot_id:
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08002145 logging.error('client not rebooted (boot %s)',
2146 old_boot_id)
J. Richard Barnette134ec2c2012-04-25 12:59:37 -07002147 raise error.TestFail(
Tom Wai-Hong Tam01792682015-01-06 08:00:46 +08002148 'client is back up, but did not reboot')
Simran Basid5e5e272012-09-24 15:23:59 -07002149
2150
2151 @staticmethod
2152 def check_for_rpm_support(hostname):
2153 """For a given hostname, return whether or not it is powered by an RPM.
2154
Simran Basi1df55112013-09-06 11:25:09 -07002155 @param hostname: hostname to check for rpm support.
2156
Simran Basid5e5e272012-09-24 15:23:59 -07002157 @return None if this host does not follows the defined naming format
2158 for RPM powered DUT's in the lab. If it does follow the format,
2159 it returns a regular expression MatchObject instead.
2160 """
Fang Dengbaff9082015-01-06 13:46:15 -08002161 return re.match(CrosHost._RPM_HOSTNAME_REGEX, hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07002162
2163
2164 def has_power(self):
2165 """For this host, return whether or not it is powered by an RPM.
2166
2167 @return True if this host is in the CROS lab and follows the defined
2168 naming format.
2169 """
Fang Deng0ca40e22013-08-27 17:47:44 -07002170 return CrosHost.check_for_rpm_support(self.hostname)
Simran Basid5e5e272012-09-24 15:23:59 -07002171
2172
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002173 def _set_power(self, state, power_method):
Garry Wang5e5538a2019-04-08 15:36:18 -07002174 """Sets the power to the host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002175
2176 @param state Specifies which power state to set to DUT
2177 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07002178 use. By default "RPM" or "CCD" will be used based
2179 on servo type. Valid values from
2180 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002181
2182 """
2183 ACCEPTABLE_STATES = ['ON', 'OFF']
2184
Garry Wang5e5538a2019-04-08 15:36:18 -07002185 if not power_method:
2186 power_method = self.get_default_power_method()
2187
2188 state = state.upper()
2189 if state not in ACCEPTABLE_STATES:
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002190 raise error.TestError('State must be one of: %s.'
2191 % (ACCEPTABLE_STATES,))
2192
2193 if power_method == self.POWER_CONTROL_SERVO:
2194 logging.info('Setting servo port J10 to %s', state)
2195 self.servo.set('prtctl3_pwren', state.lower())
2196 time.sleep(self._USB_POWER_TIMEOUT)
2197 elif power_method == self.POWER_CONTROL_MANUAL:
2198 logging.info('You have %d seconds to set the AC power to %s.',
2199 self._POWER_CYCLE_TIMEOUT, state)
2200 time.sleep(self._POWER_CYCLE_TIMEOUT)
Garry Wang5e5538a2019-04-08 15:36:18 -07002201 elif power_method == self.POWER_CONTROL_CCD:
2202 servo_role = 'src' if state == 'ON' else 'snk'
2203 logging.info('servo ccd power pass through detected,'
2204 ' changing servo_role to %s.', servo_role)
2205 self.servo.set_servo_v4_role(servo_role)
2206 if not self.ping_wait_up(timeout=self._CHANGE_SERVO_ROLE_TIMEOUT):
Garry Wang94bf9de2019-06-10 17:23:37 -07002207 # Make sure we don't leave DUT with no power(servo_role=snk)
2208 # when DUT is not pingable, as we raise a exception here
2209 # that may break a power cycle in the middle.
2210 self.servo.set_servo_v4_role('src')
Garry Wang5e5538a2019-04-08 15:36:18 -07002211 raise error.AutoservError(
2212 'DUT failed to regain network connection after %d seconds.'
2213 % self._CHANGE_SERVO_ROLE_TIMEOUT)
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002214 else:
2215 if not self.has_power():
2216 raise error.TestFail('DUT does not have RPM connected.')
Garry Wangad4d4fd2019-01-30 17:00:38 -08002217 self._add_rpm_changed_tag()
Garry Wang5e5538a2019-04-08 15:36:18 -07002218 rpm_client.set_power(self, state, timeout_mins=5)
Simran Basid5e5e272012-09-24 15:23:59 -07002219
2220
Garry Wang5e5538a2019-04-08 15:36:18 -07002221 def power_off(self, power_method=None):
2222 """Turn off power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002223
2224 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07002225 use. By default "RPM" or "CCD" will be used based
2226 on servo type. Valid values from
2227 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002228
2229 """
Derek Beckettb66e5c82020-08-12 15:31:02 -07002230 self._sync_if_up()
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002231 self._set_power('OFF', power_method)
Simran Basid5e5e272012-09-24 15:23:59 -07002232
Derek Beckettb66e5c82020-08-12 15:31:02 -07002233 def _check_supported(self):
2234 """Throw an error if dts mode control is not supported."""
2235 if not self.servo_pwr_supported:
2236 raise error.TestFail('power_state controls not supported')
2237
2238 def _sync_if_up(self):
2239 """Run sync on the DUT and wait for completion if the DUT is up.
2240
2241 Additionally, try to sync and ignore status if its not up.
2242
2243 Useful prior to reboots to ensure files are written to disc.
2244
2245 """
2246 if self.is_up_fast():
2247 self.run("sync")
2248 return
2249 # If it is not up, attempt to sync in the rare event the DUT is up but
2250 # doesn't respond to a ping. Ignore any errors.
2251 try:
2252 self.run("sync", ignore_status=True, timeout=1)
2253 except Exception:
2254 pass
2255
2256 def power_off_via_servo(self):
2257 """Force the DUT to power off.
2258
2259 The DUT is guaranteed to be off at the end of this call,
2260 regardless of its previous state, provided that there is
2261 working EC and boot firmware. There is no requirement for
2262 working OS software.
2263
2264 """
2265 self._check_supported()
2266 self._sync_if_up()
2267 self.servo.set_nocheck('power_state', 'off')
2268
2269 def power_on_via_servo(self, rec_mode='on'):
2270 """Force the DUT to power on.
2271
2272 Prior to calling this function, the DUT must be powered off,
2273 e.g. with a call to `power_off()`.
2274
2275 At power on, recovery mode is set as specified by the
2276 corresponding argument. When booting with recovery mode on, it
2277 is the caller's responsibility to unplug/plug in a bootable
2278 external storage device.
2279
2280 If the DUT requires a delay after powering on but before
2281 processing inputs such as USB stick insertion, the delay is
2282 handled by this method; the caller is not responsible for such
2283 delays.
2284
2285 @param rec_mode Setting of recovery mode to be applied at
2286 power on. default: REC_OFF aka 'off'
2287
2288 """
2289 self._check_supported()
2290 self.servo.set_nocheck('power_state', rec_mode)
2291
2292 def reset_via_servo(self):
2293 """Force the DUT to reset.
2294
2295 The DUT is guaranteed to be on at the end of this call,
2296 regardless of its previous state, provided that there is
2297 working OS software. This also guarantees that the EC has
2298 been restarted.
2299
2300 """
2301 self._check_supported()
2302 self._sync_if_up()
2303 self.servo.set_nocheck('power_state', 'reset')
2304
Simran Basid5e5e272012-09-24 15:23:59 -07002305
Garry Wang5e5538a2019-04-08 15:36:18 -07002306 def power_on(self, power_method=None):
2307 """Turn on power to this host via RPM, CCD, Servo or manual.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002308
2309 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07002310 use. By default "RPM" or "CCD" will be used based
2311 on servo type. Valid values from
2312 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002313
2314 """
2315 self._set_power('ON', power_method)
2316
2317
Garry Wang5e5538a2019-04-08 15:36:18 -07002318 def power_cycle(self, power_method=None):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002319 """Cycle power to this host by turning it OFF, then ON.
2320
2321 @param power_method Specifies which method of power control to
Garry Wang5e5538a2019-04-08 15:36:18 -07002322 use. By default "RPM" or "CCD" will be used based
2323 on servo type. Valid values from
2324 POWER_CONTROL_VALID_ARGS, or None to use default.
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002325
2326 """
Garry Wang5e5538a2019-04-08 15:36:18 -07002327 if not power_method:
2328 power_method = self.get_default_power_method()
2329
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002330 if power_method in (self.POWER_CONTROL_SERVO,
Garry Wang5e5538a2019-04-08 15:36:18 -07002331 self.POWER_CONTROL_MANUAL,
2332 self.POWER_CONTROL_CCD):
Ismail Noorbasha07fdb612013-02-14 14:13:31 -08002333 self.power_off(power_method=power_method)
2334 time.sleep(self._POWER_CYCLE_TIMEOUT)
2335 self.power_on(power_method=power_method)
2336 else:
Garry Wangad4d4fd2019-01-30 17:00:38 -08002337 self._add_rpm_changed_tag()
2338 rpm_client.set_power(self, 'CYCLE')
Simran Basic6f1f7a2012-10-16 10:47:46 -07002339
2340
Mary Ruthvende14a8b2019-08-23 12:43:52 -07002341 def get_platform_from_fwid(self):
2342 """Determine the platform from the crossystem fwid.
2343
2344 @returns a string representing this host's platform.
2345 """
Greg Edelstona7b05d12020-04-01 16:00:51 -06002346 # Look at the firmware for non-unibuild cases or if cros_config fails.
Mary Ruthvende14a8b2019-08-23 12:43:52 -07002347 crossystem = utils.Crossystem(self)
2348 crossystem.init()
2349 # Extract fwid value and use the leading part as the platform id.
2350 # fwid generally follow the format of {platform}.{firmware version}
2351 # Example: Alex.X.YYY.Z or Google_Alex.X.YYY.Z
2352 platform = crossystem.fwid().split('.')[0].lower()
2353 # Newer platforms start with 'Google_' while the older ones do not.
2354 return platform.replace('google_', '')
2355
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08002356
Simran Basic6f1f7a2012-10-16 10:47:46 -07002357 def get_platform(self):
2358 """Determine the correct platform label for this host.
2359
2360 @returns a string representing this host's platform.
2361 """
C Shapiroed87c6f2018-04-19 09:13:58 -06002362 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
2363 run_method=self.run)
C Shapiroed87c6f2018-04-19 09:13:58 -06002364 platform = ''
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08002365 if release_info.get('CHROMEOS_RELEASE_UNIBUILD') == '1':
Greg Edelstona7b05d12020-04-01 16:00:51 -06002366 platform = self.get_model_from_cros_config()
Mary Ruthvende14a8b2019-08-23 12:43:52 -07002367 return platform if platform else self.get_platform_from_fwid()
Simran Basic6f1f7a2012-10-16 10:47:46 -07002368
2369
Greg Edelstona7b05d12020-04-01 16:00:51 -06002370 def get_model_from_cros_config(self):
2371 """Get the host model from cros_config command.
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08002372
Greg Edelstona7b05d12020-04-01 16:00:51 -06002373 @returns a string representing this host's model.
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08002374 """
Greg Edelstona7b05d12020-04-01 16:00:51 -06002375 return cros_config.call_cros_config_get_output('/ name',
2376 self.run, ignore_status=True)
Puthikorn Voravootivat0f7c3d82019-11-27 13:48:39 -08002377
2378
Hung-ying Tyanb1328032014-04-01 14:18:54 +08002379 def get_architecture(self):
2380 """Determine the correct architecture label for this host.
2381
2382 @returns a string representing this host's architecture.
2383 """
2384 crossystem = utils.Crossystem(self)
2385 crossystem.init()
2386 return crossystem.arch()
2387
2388
Luis Lozano40b7d0d2014-01-17 15:12:06 -08002389 def get_chrome_version(self):
2390 """Gets the Chrome version number and milestone as strings.
2391
2392 Invokes "chrome --version" to get the version number and milestone.
2393
2394 @return A tuple (chrome_ver, milestone) where "chrome_ver" is the
2395 current Chrome version number as a string (in the form "W.X.Y.Z")
2396 and "milestone" is the first component of the version number
2397 (the "W" from "W.X.Y.Z"). If the version number cannot be parsed
2398 in the "W.X.Y.Z" format, the "chrome_ver" will be the full output
2399 of "chrome --version" and the milestone will be the empty string.
2400
2401 """
MK Ryu35d661e2014-09-25 17:44:10 -07002402 version_string = self.run(client_constants.CHROME_VERSION_COMMAND).stdout
Luis Lozano40b7d0d2014-01-17 15:12:06 -08002403 return utils.parse_chrome_version(version_string)
2404
J. Richard Barnetted2af5852016-02-05 15:03:10 -08002405
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08002406 def get_ec_version(self):
2407 """Get the ec version as strings.
2408
2409 @returns a string representing this host's ec version.
2410 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08002411 command = 'mosys ec info -s fw_version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08002412 result = self.run(command, ignore_status=True)
2413 if result.exit_status != 0:
2414 return ''
2415 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08002416
2417
2418 def get_firmware_version(self):
2419 """Get the firmware version as strings.
2420
2421 @returns a string representing this host's firmware version.
2422 """
2423 crossystem = utils.Crossystem(self)
2424 crossystem.init()
2425 return crossystem.fwid()
2426
2427
2428 def get_hardware_revision(self):
2429 """Get the hardware revision as strings.
2430
2431 @returns a string representing this host's hardware revision.
2432 """
Puthikorn Voravootivat65ad7672018-01-30 14:00:01 -08002433 command = 'mosys platform version'
Puthikorn Voravootivat720640d2018-02-16 17:32:38 -08002434 result = self.run(command, ignore_status=True)
2435 if result.exit_status != 0:
2436 return ''
2437 return result.stdout.strip()
Puthikorn Voravootivatfd132172017-11-16 18:24:38 -08002438
2439
2440 def get_kernel_version(self):
2441 """Get the kernel version as strings.
2442
2443 @returns a string representing this host's kernel version.
2444 """
2445 return self.run('uname -r').stdout.strip()
2446
2447
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08002448 def get_cpu_name(self):
2449 """Get the cpu name as strings.
2450
2451 @returns a string representing this host's cpu name.
2452 """
2453
2454 # Try get cpu name from device tree first
2455 if self.path_exists('/proc/device-tree/compatible'):
2456 command = ' | '.join(
2457 ["sed -e 's/\\x0/\\n/g' /proc/device-tree/compatible",
2458 'tail -1'])
2459 return self.run(command).stdout.strip().replace(',', ' ')
2460
2461 # Get cpu name from uname -p
2462 command = 'uname -p'
2463 ret = self.run(command).stdout.strip()
2464
2465 # 'uname -p' return variant of unknown or amd64 or x86_64 or i686
2466 # Try get cpu name from /proc/cpuinfo instead
2467 if re.match("unknown|amd64|[ix][0-9]?86(_64)?", ret, re.IGNORECASE):
2468 command = "grep model.name /proc/cpuinfo | cut -f 2 -d: | head -1"
2469 self = self.run(command).stdout.strip()
2470
2471 # Remove bloat from CPU name, for example
2472 # Intel(R) Core(TM) i5-7Y57 CPU @ 1.20GHz -> Intel Core i5-7Y57
2473 # Intel(R) Xeon(R) CPU E5-2690 v4 @ 2.60GHz -> Intel Xeon E5-2690 v4
2474 # AMD A10-7850K APU with Radeon(TM) R7 Graphics -> AMD A10-7850K
2475 # AMD GX-212JC SOC with Radeon(TM) R2E Graphics -> AMD GX-212JC
2476 trim_re = r' (@|processor|apu|soc|radeon).*|\(.*?\)| cpu'
2477 return re.sub(trim_re, '', ret, flags=re.IGNORECASE)
2478
2479
2480 def get_screen_resolution(self):
2481 """Get the screen(s) resolution as strings.
2482 In case of more than 1 monitor, return resolution for each monitor
2483 separate with plus sign.
2484
2485 @returns a string representing this host's screen(s) resolution.
2486 """
2487 command = 'for f in /sys/class/drm/*/*/modes; do head -1 $f; done'
2488 ret = self.run(command, ignore_status=True)
2489 # We might have Chromebox without a screen
2490 if ret.exit_status != 0:
2491 return ''
2492 return ret.stdout.strip().replace('\n', '+')
2493
2494
2495 def get_mem_total_gb(self):
2496 """Get total memory available in the system in GiB (2^20).
2497
2498 @returns an integer representing total memory
2499 """
2500 mem_total_kb = self.read_from_meminfo('MemTotal')
2501 kb_in_gb = float(2 ** 20)
2502 return int(round(mem_total_kb / kb_in_gb))
2503
2504
2505 def get_disk_size_gb(self):
2506 """Get size of disk in GB (10^9)
2507
2508 @returns an integer representing size of disk, 0 in Error Case
2509 """
2510 command = 'grep $(rootdev -s -d | cut -f3 -d/)$ /proc/partitions'
2511 result = self.run(command, ignore_status=True)
2512 if result.exit_status != 0:
2513 return 0
2514 _, _, block, _ = re.split(r' +', result.stdout.strip())
2515 byte_per_block = 1024.0
2516 disk_kb_in_gb = 1e9
2517 return int(int(block) * byte_per_block / disk_kb_in_gb + 0.5)
2518
2519
2520 def get_battery_size(self):
2521 """Get size of battery in Watt-hour via sysfs
2522
2523 This method assumes that battery support voltage_min_design and
2524 charge_full_design sysfs.
2525
2526 @returns a float representing Battery size, 0 if error.
2527 """
2528 # sysfs report data in micro scale
2529 battery_scale = 1e6
2530
2531 command = 'cat /sys/class/power_supply/*/voltage_min_design'
2532 result = self.run(command, ignore_status=True)
2533 if result.exit_status != 0:
2534 return 0
2535 voltage = float(result.stdout.strip()) / battery_scale
2536
2537 command = 'cat /sys/class/power_supply/*/charge_full_design'
2538 result = self.run(command, ignore_status=True)
2539 if result.exit_status != 0:
2540 return 0
2541 amphereHour = float(result.stdout.strip()) / battery_scale
2542
2543 return voltage * amphereHour
2544
2545
2546 def get_low_battery_shutdown_percent(self):
2547 """Get the percent-based low-battery shutdown threshold.
2548
2549 @returns a float representing low-battery shutdown percent, 0 if error.
2550 """
2551 ret = 0.0
2552 try:
2553 command = 'check_powerd_config --low_battery_shutdown_percent'
2554 ret = float(self.run(command).stdout)
2555 except error.CmdError:
2556 logging.debug("Can't run %s", command)
2557 except ValueError:
2558 logging.debug("Didn't get number from %s", command)
2559
2560 return ret
2561
2562
Puthikorn Voravootivat09c83d72018-08-10 15:58:32 -07002563 def has_hammer(self):
2564 """Check whether DUT has hammer device or not.
2565
2566 @returns boolean whether device has hammer or not
2567 """
2568 command = 'grep Hammer /sys/bus/usb/devices/*/product'
2569 return self.run(command, ignore_status=True).exit_status == 0
2570
2571
Niranjan Kumar34618872017-05-31 12:57:09 -07002572 def is_chrome_switch_present(self, switch):
David Haddock3ce538e2017-06-22 13:37:05 -07002573 """Returns True if the specified switch was provided to Chrome.
2574
2575 @param switch The chrome switch to search for.
2576 """
Niranjan Kumar34618872017-05-31 12:57:09 -07002577
Niranjan Kumar5f23fe92017-06-22 15:18:55 -07002578 command = 'pgrep -x -f -c "/opt/google/chrome/chrome.*%s.*"' % switch
2579 return self.run(command, ignore_status=True).exit_status == 0
Niranjan Kumar34618872017-05-31 12:57:09 -07002580
2581
2582 def oobe_triggers_update(self):
2583 """Returns True if this host has an OOBE flow during which
2584 it will perform an update check and perhaps an update.
2585 One example of such a flow is Hands-Off Zero-Touch Enrollment.
2586 As more such flows are developed, code handling them needs
2587 to be added here.
2588
2589 @return Boolean indicating whether this host's OOBE triggers an update.
2590 """
2591 return self.is_chrome_switch_present(
2592 '--enterprise-enable-zero-touch-enrollment=hands-off')
2593
2594
Kevin Chenga2619dc2016-03-28 11:42:08 -07002595 # TODO(kevcheng): change this to just return the board without the
2596 # 'board:' prefix and fix up all the callers. Also look into removing the
2597 # need for this method.
Simran Basic6f1f7a2012-10-16 10:47:46 -07002598 def get_board(self):
2599 """Determine the correct board label for this host.
2600
2601 @returns a string representing this host's board.
2602 """
2603 release_info = utils.parse_cmd_output('cat /etc/lsb-release',
2604 run_method=self.run)
J. Richard Barnetted2af5852016-02-05 15:03:10 -08002605 return (ds_constants.BOARD_PREFIX +
2606 release_info['CHROMEOS_RELEASE_BOARD'])
Simran Basic6f1f7a2012-10-16 10:47:46 -07002607
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07002608 def get_channel(self):
2609 """Determine the correct channel label for this host.
Simran Basic6f1f7a2012-10-16 10:47:46 -07002610
Po-Hsien Wang4618adf2017-10-10 14:40:21 -07002611 @returns: a string represeting this host's build channel.
2612 (stable, dev, beta). None on fail.
2613 """
2614 return lsbrelease_utils.get_chromeos_channel(
2615 lsb_release_content=self._get_lsb_release_content())
Kevin Chenga328da62016-03-31 10:49:04 -07002616
Kevin Chenga328da62016-03-31 10:49:04 -07002617 def get_power_supply(self):
2618 """
2619 Determine what type of power supply the host has
2620
2621 @returns a string representing this host's power supply.
2622 'power:battery' when the device has a battery intended for
2623 extended use
2624 'power:AC_primary' when the device has a battery not intended
2625 for extended use (for moving the machine, etc)
2626 'power:AC_only' when the device has no battery at all.
2627 """
2628 psu = self.run(command='mosys psu type', ignore_status=True)
2629 if psu.exit_status:
2630 # The psu command for mosys is not included for all platforms. The
2631 # assumption is that the device will have a battery if the command
2632 # is not found.
2633 return 'power:battery'
2634
2635 psu_str = psu.stdout.strip()
2636 if psu_str == 'unknown':
2637 return None
2638
2639 return 'power:%s' % psu_str
2640
2641
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08002642 def has_battery(self):
2643 """Determine if DUT has a battery.
2644
2645 Returns:
2646 Boolean, False if known not to have battery, True otherwise.
2647 """
2648 rv = True
2649 power_supply = self.get_power_supply()
2650 if power_supply == 'power:battery':
2651 _NO_BATTERY_BOARD_TYPE = ['CHROMEBOX', 'CHROMEBIT', 'CHROMEBASE']
2652 board_type = self.get_board_type()
2653 if board_type in _NO_BATTERY_BOARD_TYPE:
2654 logging.warn('Do NOT believe type %s has battery. '
2655 'See debug for mosys details', board_type)
Sam Hurst57fa60a2020-05-08 08:55:47 -07002656 psu = utils.system_output('mosys -vvvv psu type',
Puthikorn Voravootivat54aa53c2018-03-01 19:00:25 -08002657 ignore_status=True)
2658 logging.debug(psu)
2659 rv = False
2660 elif power_supply == 'power:AC_only':
2661 rv = False
2662
2663 return rv
2664
2665
Kevin Chenga328da62016-03-31 10:49:04 -07002666 def get_servo(self):
2667 """Determine if the host has a servo attached.
2668
2669 If the host has a working servo attached, it should have a servo label.
2670
2671 @return: string 'servo' if the host has servo attached. Otherwise,
2672 returns None.
2673 """
2674 return 'servo' if self._servo_host else None
2675
2676
Kevin Chenga328da62016-03-31 10:49:04 -07002677 def has_internal_display(self):
2678 """Determine if the device under test is equipped with an internal
2679 display.
2680
2681 @return: 'internal_display' if one is present; None otherwise.
2682 """
2683 from autotest_lib.client.cros.graphics import graphics_utils
2684 from autotest_lib.client.common_lib import utils as common_utils
2685
2686 def __system_output(cmd):
2687 return self.run(cmd).stdout
2688
2689 def __read_file(remote_path):
2690 return self.run('cat %s' % remote_path).stdout
2691
2692 # Hijack the necessary client functions so that we can take advantage
2693 # of the client lib here.
2694 # FIXME: find a less hacky way than this
2695 original_system_output = utils.system_output
2696 original_read_file = common_utils.read_file
2697 utils.system_output = __system_output
2698 common_utils.read_file = __read_file
2699 try:
2700 return ('internal_display' if graphics_utils.has_internal_display()
2701 else None)
2702 finally:
2703 utils.system_output = original_system_output
2704 common_utils.read_file = original_read_file
2705
2706
Dan Shi85276d42014-04-08 22:11:45 -07002707 def is_boot_from_usb(self):
2708 """Check if DUT is boot from USB.
2709
2710 @return: True if DUT is boot from usb.
2711 """
2712 device = self.run('rootdev -s -d').stdout.strip()
2713 removable = int(self.run('cat /sys/block/%s/removable' %
2714 os.path.basename(device)).stdout.strip())
2715 return removable == 1
Helen Zhang17dae2b2014-11-11 09:25:52 -08002716
Otabek Kasimov77a40332020-10-20 15:40:03 -07002717 def is_boot_from_external_device(self):
2718 """Check if DUT is boot from external storage.
2719
2720 @return: True if DUT is boot from external storage.
2721 """
2722 boot_device = self.run('rootdev -s -d', ignore_status=True,
2723 timeout=60).stdout.strip()
2724 if not boot_device:
2725 logging.debug('Boot storage not detected on the host.')
2726 return False
2727 main_storage_cmd = ('. /usr/sbin/write_gpt.sh;'
2728 ' . /usr/share/misc/chromeos-common.sh;'
2729 ' load_base_vars; get_fixed_dst_drive')
2730 main_storage = self.run(main_storage_cmd,
2731 ignore_status=True,
2732 timeout=60).stdout.strip()
Otabek Kasimov723e8562020-12-08 13:29:34 -08002733 if not main_storage or boot_device != main_storage:
2734 logging.debug('Device booted from external storage storage.')
2735 return True
2736 logging.debug('Device booted from main storage.')
2737 return False
Helen Zhang17dae2b2014-11-11 09:25:52 -08002738
2739 def read_from_meminfo(self, key):
Dan Shi49ca0932014-11-14 11:22:27 -08002740 """Return the memory info from /proc/meminfo
Helen Zhang17dae2b2014-11-11 09:25:52 -08002741
2742 @param key: meminfo requested
2743
2744 @return the memory value as a string
2745
2746 """
Helen Zhang17dae2b2014-11-11 09:25:52 -08002747 meminfo = self.run('grep %s /proc/meminfo' % key).stdout.strip()
2748 logging.debug('%s', meminfo)
2749 return int(re.search(r'\d+', meminfo).group(0))
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002750
2751
Rohit Makasana98e696f2016-06-03 18:48:10 -07002752 def get_cpu_arch(self):
2753 """Returns CPU arch of the device.
2754
2755 @return CPU architecture of the DUT.
2756 """
Allen Li2c32d6b2017-02-03 15:28:10 -08002757 # Add CPUs by following logic in client/bin/utils.py.
Rohit Makasana98e696f2016-06-03 18:48:10 -07002758 if self.run("grep '^flags.*:.* lm .*' /proc/cpuinfo",
2759 ignore_status=True).stdout:
2760 return 'x86_64'
2761 if self.run("grep -Ei 'ARM|CPU implementer' /proc/cpuinfo",
2762 ignore_status=True).stdout:
2763 return 'arm'
2764 return 'i386'
2765
2766
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002767 def get_board_type(self):
2768 """
2769 Get the DUT's device type from /etc/lsb-release.
Danny Chan471a8d12015-08-18 14:57:41 -07002770 DEVICETYPE can be one of CHROMEBOX, CHROMEBASE, CHROMEBOOK or more.
2771
2772 @return value of DEVICETYPE param from lsb-release.
Rohit Makasana8a4923c2015-08-13 17:04:26 -07002773 """
Danny Chan471a8d12015-08-18 14:57:41 -07002774 device_type = self.run('grep DEVICETYPE /etc/lsb-release',
2775 ignore_status=True).stdout
2776 if device_type:
Kalin Stoyanov524310b2015-08-21 16:24:04 -07002777 return device_type.split('=')[-1].strip()
Danny Chan471a8d12015-08-18 14:57:41 -07002778 return ''
Gilad Arnolda76bef02015-09-29 13:55:15 -07002779
2780
Rohit Makasanadf0a3a32017-06-30 13:55:18 -07002781 def get_arc_version(self):
2782 """Return ARC version installed on the DUT.
2783
2784 @returns ARC version as string if the CrOS build has ARC, else None.
2785 """
2786 arc_version = self.run('grep CHROMEOS_ARC_VERSION /etc/lsb-release',
2787 ignore_status=True).stdout
2788 if arc_version:
2789 return arc_version.split('=')[-1].strip()
2790 return None
2791
2792
Gilad Arnolda76bef02015-09-29 13:55:15 -07002793 def get_os_type(self):
2794 return 'cros'
Simran Basia5522a32015-10-06 11:01:24 -07002795
2796
Kevin Chenga2619dc2016-03-28 11:42:08 -07002797 def get_labels(self):
Kevin Chengf8660142016-08-12 10:17:41 -07002798 """Return the detected labels on the host."""
Kevin Chenga2619dc2016-03-28 11:42:08 -07002799 return self.labels.get_labels(self)
Garry Wang5e5538a2019-04-08 15:36:18 -07002800
2801
2802 def get_default_power_method(self):
2803 """
2804 Get the default power method for power_on/off/cycle() methods.
2805 @return POWER_CONTROL_RPM or POWER_CONTROL_CCD
2806 """
2807 if not self._default_power_method:
Garry Wang1a004aa2019-05-16 22:56:51 -07002808 self._default_power_method = self.POWER_CONTROL_RPM
Ruben Rodriguez Buchillon3eeeab32019-10-02 15:29:58 -07002809 if self.servo and self.servo.supports_built_in_pd_control():
2810 self._default_power_method = self.POWER_CONTROL_CCD
2811 else:
2812 logging.debug('Either servo is unitialized or the servo '
2813 'setup does not support pd controls. Falling '
2814 'back to default RPM method.')
Garry Wang5e5538a2019-04-08 15:36:18 -07002815 return self._default_power_method
Puthikorn Voravootivat4a054792019-12-13 16:44:17 -08002816
2817
2818 def find_usb_devices(self, idVendor, idProduct):
2819 """
2820 Get usb device sysfs name for specific device.
2821
2822 @param idVendor Vendor ID to search in sysfs directory.
2823 @param idProduct Product ID to search in sysfs directory.
2824
2825 @return Usb node names in /sys/bus/usb/drivers/usb/ that match.
2826 """
2827 # Look for matching file and cut at position 7 to get dir name.
2828 grep_cmd = 'grep {} /sys/bus/usb/drivers/usb/*/{} | cut -f 7 -d /'
2829
2830 vendor_cmd = grep_cmd.format(idVendor, 'idVendor')
2831 product_cmd = grep_cmd.format(idProduct, 'idProduct')
2832
2833 # Use uniq -d to print duplicate line from both command
2834 cmd = 'sort <({}) <({}) | uniq -d'.format(vendor_cmd, product_cmd)
2835
2836 return self.run(cmd, ignore_status=True).stdout.strip().split('\n')
2837
2838
2839 def bind_usb_device(self, usb_node):
2840 """
2841 Bind usb device
2842
2843 @param usb_node Node name in /sys/bus/usb/drivers/usb/
2844 """
2845 cmd = 'echo {} > /sys/bus/usb/drivers/usb/bind'.format(usb_node)
2846 self.run(cmd, ignore_status=True)
2847
2848
2849 def unbind_usb_device(self, usb_node):
2850 """
2851 Unbind usb device
2852
2853 @param usb_node Node name in /sys/bus/usb/drivers/usb/
2854 """
2855 cmd = 'echo {} > /sys/bus/usb/drivers/usb/unbind'.format(usb_node)
2856 self.run(cmd, ignore_status=True)
2857
2858
2859 def get_wlan_ip(self):
2860 """
2861 Get ip address of wlan interface.
2862
2863 @return ip address of wlan or empty string if wlan is not connected.
2864 """
2865 cmds = [
2866 'iw dev', # List wlan physical device
2867 'grep Interface', # Grep only interface name
2868 'cut -f 2 -d" "', # Cut the name part
2869 'xargs ifconfig', # Feed it to ifconfig to get ip
2870 'grep -oE "inet [0-9.]+"', # Grep only ipv4
2871 'cut -f 2 -d " "' # Cut the ip part
2872 ]
2873 return self.run(' | '.join(cmds), ignore_status=True).stdout.strip()
Puthikorn Voravootivatcd0dc9e2020-01-22 14:22:22 -08002874
2875 def connect_to_wifi(self, ssid, passphrase=None, security=None):
2876 """
2877 Connect to wifi network
2878
2879 @param ssid SSID of the wifi network.
2880 @param passphrase Passphrase of the wifi network. None if not existed.
2881 @param security Security of the wifi network. Default to "psk" if
2882 passphase is given without security. Possible values
2883 are "none", "psk", "802_1x".
2884
2885 @return True if succeed, False if not.
2886 """
2887 cmd = '/usr/local/autotest/cros/scripts/wifi connect ' + ssid
2888 if passphrase:
2889 cmd += ' ' + passphrase
2890 if security:
2891 cmd += ' ' + security
2892 return self.run(cmd, ignore_status=True).exit_status == 0
Otabek Kasimov6825b762020-06-23 23:42:44 -07002893
2894 def get_device_repair_state(self):
2895 """Get device repair state"""
2896 return self._device_repair_state
2897
Otabek Kasimov7cad9ce2020-07-28 14:58:48 -07002898 def set_device_repair_state(self, state, resultdir=None):
Otabek Kasimov6825b762020-06-23 23:42:44 -07002899 """Set device repair state.
2900
2901 The special device state will be written to the 'dut_state.repair'
Otabek Kasimov7cad9ce2020-07-28 14:58:48 -07002902 file in result directory. The file will be read by Lucifer. The
2903 file will not be created if result directory not specified.
2904
2905 @params state: The new state for the device.
2906 @params resultdir: The path to result directory. If path not provided
2907 will be attempt to get retrieve it from job
2908 if present.
Otabek Kasimov6825b762020-06-23 23:42:44 -07002909 """
Otabek Kasimov7cad9ce2020-07-28 14:58:48 -07002910 resultdir = resultdir or getattr(self.job, 'resultdir', '')
2911 if resultdir:
2912 target = os.path.join(resultdir, 'dut_state.repair')
Otabek Kasimov6825b762020-06-23 23:42:44 -07002913 common_utils.open_write_close(target, state)
Otabek Kasimov7cad9ce2020-07-28 14:58:48 -07002914 logging.info('Set device state as %s. '
2915 'Created dut_state.repair file.', state)
Otabek Kasimov6825b762020-06-23 23:42:44 -07002916 else:
2917 logging.debug('Cannot write the device state due missing info '
2918 'about result dir.')
2919 self._device_repair_state = state
2920
Otabek Kasimov7cad9ce2020-07-28 14:58:48 -07002921 def set_device_needs_replacement(self, resultdir=None):
2922 """Set device as required replacement.
2923
2924 @params resultdir: The path to result directory. If path not provided
2925 will be attempt to get retrieve it from job
2926 if present.
2927 """
2928 self.set_device_repair_state(
2929 cros_constants.DEVICE_STATE_NEEDS_REPLACEMENT,
2930 resultdir=resultdir)
2931
Otabek Kasimov86062d02020-11-17 13:30:22 -08002932 def _dut_fail_ssh_verifier(self):
2933 """Check if DUT failed SSH verifier.
2934
2935 @returns: bool, True - verifier marked as fail.
2936 False - result not reachable, verifier did not fail.
2937 """
2938 if not self._repair_strategy:
2939 return False
2940 dut_ssh_verifier = self._repair_strategy.verifier_is_good('ssh')
2941 return dut_ssh_verifier == hosts.VERIFY_FAILED
2942
Otabek Kasimovd48389b2020-12-07 02:38:34 -08002943 def _stat_if_pingable_but_not_sshable(self):
2944 """Check if DUT pingable but failed SSH verifier."""
2945 if not self._repair_strategy:
2946 return
2947 dut_ssh = self._repair_strategy.verifier_is_good('ssh')
2948 dut_ping = self._repair_strategy.verifier_is_good('ping')
2949 if (dut_ping == hosts.VERIFY_FAILED
2950 and dut_ssh == hosts.VERIFY_FAILED):
2951 metrics.Counter('chromeos/autotest/dut_pingable_no_ssh').increment(
2952 fields={'host': self.hostname})
2953
Otabek Kasimov7cad9ce2020-07-28 14:58:48 -07002954 def try_set_device_needs_manual_repair(self):
Otabek Kasimov6825b762020-06-23 23:42:44 -07002955 """Check if device require manual attention to be fixed.
2956
2957 The state 'needs_manual_repair' can be set when auto repair cannot
2958 fix the device due hardware or cable issues.
2959 """
2960 # ignore the logic if state present
2961 # state can be set by any cros repair actions
Otabek Kasimov86062d02020-11-17 13:30:22 -08002962 if self.get_device_repair_state():
Otabek Kasimov6825b762020-06-23 23:42:44 -07002963 return
Otabek Kasimov86062d02020-11-17 13:30:22 -08002964 if not self._dut_fail_ssh_verifier():
2965 # DUT is sshable and we still have many options to repair it.
Otabek Kasimovc9812582020-10-08 18:52:52 -07002966 return
Otabek Kasimov9189ede2020-11-09 14:08:58 -08002967 needs_manual_repair = False
2968 dhp = self.health_profile
Otabek Kasimov69253822020-11-24 10:52:27 -08002969 if dhp and dhp.get_repair_fail_count() > 49:
2970 # 42 = 6 times during 7 days. (every 4 hour repair)
2971 # round up to 50 in case somebody will run some attempt on it.
Otabek Kasimovc9812582020-10-08 18:52:52 -07002972 logging.info(
Otabek Kasimov9189ede2020-11-09 14:08:58 -08002973 'DUT is not sshable and fail %s times.'
Otabek Kasimov69253822020-11-24 10:52:27 -08002974 ' Limit to try repair is 50 times',
Otabek Kasimov9189ede2020-11-09 14:08:58 -08002975 dhp.get_repair_fail_count())
2976 needs_manual_repair = True
2977
2978 if not needs_manual_repair:
2979 # We cannot ssh to the DUT and we have hardware or set-up issues
2980 # with servo then we need request manual repair for the DUT.
2981 servo_state_required_manual_fix = [
2982 servo_constants.SERVO_STATE_DUT_NOT_CONNECTED,
2983 servo_constants.SERVO_STATE_NEED_REPLACEMENT,
2984 ]
2985 if self.get_servo_state() in servo_state_required_manual_fix:
2986 logging.info(
2987 'DUT required manual repair because it is not sshable'
2988 ' and possible have setup issue with Servo. Please'
2989 ' verify all connections and present of devices.')
2990 needs_manual_repair = True
2991
2992 if needs_manual_repair:
Otabek Kasimovc9812582020-10-08 18:52:52 -07002993 self.set_device_repair_state(
2994 cros_constants.DEVICE_STATE_NEEDS_MANUAL_REPAIR)
Otabek Kasimov42506d02020-07-29 14:44:57 -07002995
Otabek Kasimov86062d02020-11-17 13:30:22 -08002996 def _reboot_labstation_if_needed(self):
2997 """Place request to reboot the labstation if DUT is not sshable.
2998
2999 @returns: None
3000 """
3001 message_prefix = "Don't need to request servo-host reboot "
3002 if not self._dut_fail_ssh_verifier():
3003 return
3004 if not self._servo_host:
3005 logging.debug(message_prefix + 'as it not initialized')
3006 return
3007 if not self._servo_host.is_up_fast():
3008 logging.debug(message_prefix + 'as servo-host is not sshable')
3009 return
3010 if not self._servo_host.is_labstation():
3011 logging.debug('Servo_v3 is not requested to reboot for the DUT')
3012 return
3013 usb_path = self._servo_host.get_main_servo_usb_path()
3014 if usb_path:
3015 connected_port = os.path.basename(os.path.normpath(usb_path))
3016 # Directly connected servo to the labstation looks like '1-5.3'
3017 # and when connected by hub - '1-5.2.3' or '1-5.2.1.3'. Where:
3018 # - '1-5' - port on labstation
3019 # - '2' or '2.1' - port on the hub or smart-hub
3020 # - '3' - port on servo hub
3021 if len(connected_port.split('.')) > 2:
3022 logging.debug(message_prefix + 'as servo connected by hub')
3023 return
3024 self._servo_host.request_reboot()
3025 logging.info('Requested labstation reboot because DUT is not sshable')
3026
Otabek Kasimov42506d02020-07-29 14:44:57 -07003027 def is_file_system_writable(self, testdirs=None):
3028 """Check is the file systems are writable.
3029
3030 The standard linux response to certain unexpected file system errors
3031 (including hardware errors in block devices) is to change the file
3032 system status to read-only. This checks that that hasn't happened.
3033
3034 @param testdirs: List of directories to check. If no data provided
3035 then '/mnt/stateful_partition' and '/var/tmp'
3036 directories will be checked.
3037
3038 @returns boolean whether file-system writable.
3039 """
3040 def _check_dir(testdir):
3041 # check if we can create a file
3042 filename = os.path.join(testdir, 'writable_my_test_file')
3043 command = 'touch %s && rm %s' % (filename, filename)
3044 rv = self.run(command=command,
3045 timeout=30,
3046 ignore_status=True)
3047 is_writable = rv.exit_status == 0
3048 if not is_writable:
3049 logging.info('Cannot create a file in "%s"!'
3050 ' Probably the FS is read-only', testdir)
3051 logging.info("FileSystem is not writable!")
3052 return False
3053 return True
3054
3055 if not testdirs or len(testdirs) == 0:
3056 # N.B. Order matters here: Encrypted stateful is loop-mounted
3057 # from a file in unencrypted stateful, so we don't test for
3058 # errors in encrypted stateful if unencrypted fails.
3059 testdirs = ['/mnt/stateful_partition', '/var/tmp']
3060
3061 for dir in testdirs:
3062 # loop will be stopped if any directory fill fail the check
3063 try:
3064 if not _check_dir(dir):
3065 return False
3066 except Exception as e:
3067 # here expected only timeout error, all other will
3068 # be catch by 'ignore_status=True'
3069 logging.debug('Fail to check %s to write in it', dir)
3070 return False
3071 return True
Garry Wang1a493d82020-08-31 21:01:19 -07003072
Dana Goyettec172b172020-07-29 16:26:15 -07003073 def blocking_sync(self, freeze_for_reset=False):
3074 """Sync root device and internal device, via script.
3075
3076 The actual calls end up logged by the run() call, since they're printed
3077 to stdout/stderr in the script.
3078
3079 @param freeze_for_reset: if True, prepare for reset by blocking writes
3080 (only if enable_fs_sync_fsfreeze=True)
3081 """
3082
3083 if freeze_for_reset and self.USE_FSFREEZE:
3084 logging.info('Blocking sync and freeze')
3085 elif freeze_for_reset:
3086 logging.info('Blocking sync for reset')
3087 else:
3088 logging.info('Blocking sync')
3089
3090 # client/bin is installed on the DUT as /usr/local/autotest/bin
3091 sync_cmd = '/usr/local/autotest/bin/fs_sync.py'
3092 if freeze_for_reset and self.USE_FSFREEZE:
3093 sync_cmd += ' --freeze'
3094 return self.run(sync_cmd)
3095
Garry Wanga2e78172020-09-09 23:49:07 -07003096 def set_health_profile_dut_state(self, state):
3097 if not self.health_profile:
3098 logging.debug('Device health profile is not initialized, skip'
3099 ' set dut state.')
3100 return
3101 reset_counters = state in profile_constants.STATES_NEED_RESET_COUNTER
3102 self.health_profile.update_dut_state(state, reset_counters)
Garry Wang53fc8f32020-09-18 13:30:08 -07003103
3104 def require_snk_mode_in_recovery(self):
3105 """Check whether we need to switch servo_v4 role to snk when
3106 booting into recovery mode. (See crbug.com/1129165)
3107 """
Garry Wanga8739cc2020-10-30 00:49:23 -07003108 has_battery = True
3109 # Determine if the host has battery based on host_info first.
3110 power_info = self.host_info_store.get().get_label_value('power')
3111 if power_info:
3112 has_battery = power_info == 'battery'
3113 elif self.is_up_fast():
3114 # when running local tests host_info is not available, so we
3115 # need to determine whether the host has battery by checking
3116 # from host side.
3117 logging.debug('Label `power` is not found in host_info, checking'
3118 ' if the host has battery from host side.')
3119 has_battery = self.has_battery()
3120
3121 if not has_battery:
Garry Wang53fc8f32020-09-18 13:30:08 -07003122 logging.info(
3123 '%s does not has battery, snk mode is not needed'
3124 ' for recovery.', self.hostname)
3125 return False
Garry Wanga8739cc2020-10-30 00:49:23 -07003126
Garry Wang53fc8f32020-09-18 13:30:08 -07003127 if not self.servo.supports_built_in_pd_control():
3128 logging.info('Power delivery is not supported on this servo, snk'
3129 ' mode is not needed for recovery.')
3130 return False
3131 try:
Garry Wang53fc8f32020-09-18 13:30:08 -07003132 battery_percent = self.servo.get('battery_charge_percent')
Otabek Kasimov58e22562020-11-03 17:17:41 -08003133 if battery_percent < cros_constants.MIN_BATTERY_LEVEL:
Garry Wang53fc8f32020-09-18 13:30:08 -07003134 logging.info(
3135 'Current battery level %s%% below %s%% threshold, we'
3136 ' will attempt to boot host in recovery mode without'
3137 ' changing servo to snk mode. Please note the host may'
3138 ' not able to see usb drive in recovery mode later due'
3139 ' to servo not in snk mode.', battery_percent,
Otabek Kasimov58e22562020-11-03 17:17:41 -08003140 cros_constants.MIN_BATTERY_LEVEL)
Garry Wang53fc8f32020-09-18 13:30:08 -07003141 return False
3142 except Exception as e:
3143 logging.info(
3144 'Unexpected error occurred when getting'
3145 ' battery_charge_percent from servo; %s', str(e))
3146 return False
3147 return True
Otabek Kasimov382c3bb2020-10-28 13:22:45 -07003148
3149 def _set_servo_topology(self):
3150 """Set servo-topology info to the host-info."""
3151 logging.debug('Try to save servo topology to host-info.')
3152 if not self._servo_host:
3153 logging.info('Servo host is not initilized.')
3154 return
3155 if not self._servo_host.is_servo_topology_supported():
3156 logging.info('Servo-topology is not supported.')
3157 return
3158 servo_topology = self._servo_host.get_topology()
3159 if not servo_topology or servo_topology.is_empty():
3160 logging.info('Servo topology is empty')
3161 return
3162 servo_topology.save(self.host_info_store)