blob: 3e750d211068595d49894a9e96e08875d327a638 [file] [log] [blame]
Simran Basi431010f2013-09-04 10:42:41 -07001# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
Bryan Lewandowski0f3f0112016-05-27 15:17:19 -07004
5import datetime
Kevin Cheng3a4a57a2015-09-30 12:09:50 -07006import functools
Simran Basi431010f2013-09-04 10:42:41 -07007import logging
Kevin Cheng018db352015-09-20 02:22:08 -07008import os
Simran Basi431010f2013-09-04 10:42:41 -07009import re
Kevin Cheng92fe6ae2015-10-21 11:45:34 -070010import stat
Dan Shia2872172015-10-31 01:16:51 -070011import sys
Simran Basi431010f2013-09-04 10:42:41 -070012import time
13
14import common
15
Simran Basi9c5d3982016-04-01 18:49:44 -070016from autotest_lib.client.bin import utils as client_utils
Dan Shi49d451f2016-04-19 09:25:01 -070017from autotest_lib.client.common_lib import android_utils
Simran Basi431010f2013-09-04 10:42:41 -070018from autotest_lib.client.common_lib import error
Dan Shi6450e142016-03-11 11:52:20 -080019from autotest_lib.client.common_lib import global_config
Dan Shi225b9042015-11-18 10:25:21 -080020from autotest_lib.client.common_lib.cros import dev_server
Simran Basi431010f2013-09-04 10:42:41 -070021from autotest_lib.client.common_lib.cros import retry
Dan Shi6450e142016-03-11 11:52:20 -080022from autotest_lib.server import afe_utils
Dan Shi225b9042015-11-18 10:25:21 -080023from autotest_lib.server import autoserv_parser
Dan Shia2872172015-10-31 01:16:51 -070024from autotest_lib.server import constants as server_constants
Dan Shi225b9042015-11-18 10:25:21 -080025from autotest_lib.server import utils
Simran Basi5ace6f22016-01-06 17:30:44 -080026from autotest_lib.server.cros import provision
Dan Shi6450e142016-03-11 11:52:20 -080027from autotest_lib.server.cros.dynamic_suite import tools
Kevin Cheng3a4a57a2015-09-30 12:09:50 -070028from autotest_lib.server.cros.dynamic_suite import constants
Simran Basi724b8a52013-09-30 11:19:31 -070029from autotest_lib.server.hosts import abstract_ssh
Kevin Chengc6a645a2015-12-18 11:15:10 -080030from autotest_lib.server.hosts import adb_label
31from autotest_lib.server.hosts import base_label
Kevin Cheng85e864a2015-11-30 11:49:34 -080032from autotest_lib.server.hosts import teststation_host
Simran Basi431010f2013-09-04 10:42:41 -070033
34
Dan Shi6450e142016-03-11 11:52:20 -080035CONFIG = global_config.global_config
36
Dan Shi6ea3e1c2015-10-28 15:19:04 -070037ADB_CMD = 'adb'
38FASTBOOT_CMD = 'fastboot'
Simran Basi431010f2013-09-04 10:42:41 -070039SHELL_CMD = 'shell'
Filipe Brandenburger34363392015-08-13 14:57:45 -070040# Some devices have no serial, then `adb serial` has output such as:
41# (no serial number) device
42# ?????????? device
43DEVICE_NO_SERIAL_MSG = '(no serial number)'
44DEVICE_NO_SERIAL_TAG = '<NO_SERIAL>'
Simran Basi431010f2013-09-04 10:42:41 -070045# Regex to find an adb device. Examples:
46# 0146B5580B01801B device
47# 018e0ecb20c97a62 device
48# 172.22.75.141:5555 device
Kevin Cheng224415e2016-04-22 11:32:10 -070049# localhost:22 device
Alexandru Branciogea380fb2016-04-01 16:01:34 +030050DEVICE_FINDER_REGEX = (r'^(?P<SERIAL>([\w-]+)|((tcp:)?' +
51 '\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}([:]5555)?)|' +
Kevin Cheng224415e2016-04-22 11:32:10 -070052 '((tcp:)?localhost([:]22)?)|' +
Filipe Brandenburger34363392015-08-13 14:57:45 -070053 re.escape(DEVICE_NO_SERIAL_MSG) +
Alexandru Branciogea380fb2016-04-01 16:01:34 +030054 r')[ \t]+(?:device|fastboot)')
Simran Basi431010f2013-09-04 10:42:41 -070055CMD_OUTPUT_PREFIX = 'ADB_CMD_OUTPUT'
56CMD_OUTPUT_REGEX = ('(?P<OUTPUT>[\s\S]*)%s:(?P<EXIT_CODE>\d{1,3})' %
57 CMD_OUTPUT_PREFIX)
Kevin Cheng018db352015-09-20 02:22:08 -070058RELEASE_FILE = 'ro.build.version.release'
Kevin Cheng3a4a57a2015-09-30 12:09:50 -070059BOARD_FILE = 'ro.product.device'
Bryan Lewandowski0f3f0112016-05-27 15:17:19 -070060SDK_FILE = 'ro.build.version.sdk'
61LOGCAT_FILE = 'logcat.log'
Simran Basi38f7ddf2015-09-18 12:25:03 -070062TMP_DIR = '/data/local/tmp'
Kevin Cheng92fe6ae2015-10-21 11:45:34 -070063# Regex to pull out file type, perms and symlink. Example:
Kevin Chengaaabd0c2015-11-10 16:05:04 -080064# lrwxrwx--- 1 6 root system 2015-09-12 19:21 blah_link -> ./blah
Kevin Cheng92fe6ae2015-10-21 11:45:34 -070065FILE_INFO_REGEX = '^(?P<TYPE>[dl-])(?P<PERMS>[rwx-]{9})'
66FILE_SYMLINK_REGEX = '^.*-> (?P<SYMLINK>.+)'
67# List of the perm stats indexed by the order they are listed in the example
68# supplied above.
69FILE_PERMS_FLAGS = [stat.S_IRUSR, stat.S_IWUSR, stat.S_IXUSR,
70 stat.S_IRGRP, stat.S_IWGRP, stat.S_IXGRP,
71 stat.S_IROTH, stat.S_IWOTH, stat.S_IXOTH]
Simran Basi431010f2013-09-04 10:42:41 -070072
Dan Shi6ea3e1c2015-10-28 15:19:04 -070073# Default maximum number of seconds to wait for a device to be down.
74DEFAULT_WAIT_DOWN_TIME_SECONDS = 10
75# Default maximum number of seconds to wait for a device to be up.
Dan Shie4e807b2015-12-10 09:04:03 -080076DEFAULT_WAIT_UP_TIME_SECONDS = 300
77# Maximum number of seconds to wait for a device to be up after it's wiped.
Dan Shi50a412a2016-01-05 10:52:40 -080078WAIT_UP_AFTER_WIPE_TIME_SECONDS = 1200
Simran Basi431010f2013-09-04 10:42:41 -070079
Dan Shi7075f552016-04-21 15:42:41 -070080# Default timeout for retrying adb/fastboot command.
81DEFAULT_COMMAND_RETRY_TIMEOUT_SECONDS = 10
82
Dan Shia2872172015-10-31 01:16:51 -070083OS_TYPE_ANDROID = 'android'
84OS_TYPE_BRILLO = 'brillo'
85
Dan Shie234dea2016-01-20 17:15:17 -080086# Regex to parse build name to get the detailed build information.
Dan Shi6450e142016-03-11 11:52:20 -080087BUILD_REGEX = ('(?P<BRANCH>([^/]+))/(?P<BUILD_TARGET>([^/]+))-'
Dan Shie234dea2016-01-20 17:15:17 -080088 '(?P<BUILD_TYPE>([^/]+))/(?P<BUILD_ID>([^/]+))')
Dan Shia2872172015-10-31 01:16:51 -070089# Regex to parse devserver url to get the detailed build information. Sample
90# url: http://$devserver:8080/static/branch/target/build_id
Dan Shie234dea2016-01-20 17:15:17 -080091DEVSERVER_URL_REGEX = '.*/%s/*' % BUILD_REGEX
Dan Shia2872172015-10-31 01:16:51 -070092
Dan Shi6450e142016-03-11 11:52:20 -080093ANDROID_IMAGE_FILE_FMT = '%(build_target)s-img-%(build_id)s.zip'
Dan Shi49d451f2016-04-19 09:25:01 -070094
Dan Shiab999722015-12-04 14:27:08 -080095BRILLO_VENDOR_PARTITIONS_FILE_FMT = (
Dan Shi6450e142016-03-11 11:52:20 -080096 '%(build_target)s-vendor_partitions-%(build_id)s.zip')
97AUTOTEST_SERVER_PACKAGE_FILE_FMT = (
98 '%(build_target)s-autotest_server_package-%(build_id)s.tar.bz2')
Simran Basi9228a6f2016-03-29 12:03:37 -070099ADB_DEVICE_PREFIXES = ['product:', 'model:', 'device:']
Dan Shia2872172015-10-31 01:16:51 -0700100
Simran Basi9c5d3982016-04-01 18:49:44 -0700101# Map of product names to build target name.
102PRODUCT_TARGET_MAP = {'dragon' : 'ryu',
103 'flo' : 'razor',
104 'flo_lte' : 'razorg',
105 'gm4g_sprout' : 'seed_l8150',
106 'flounder' : 'volantis',
107 'flounder_lte' : 'volantisg'}
108
Dan Shiab999722015-12-04 14:27:08 -0800109# Command to provision a Brillo device.
110# os_image_dir: The full path of the directory that contains all the Android image
111# files (from the image zip file).
112# vendor_partition_dir: The full path of the directory that contains all the
113# Brillo vendor partitions, and provision-device script.
114BRILLO_PROVISION_CMD = (
Simran Basi7e52c622016-01-05 15:43:51 -0800115 'sudo ANDROID_PROVISION_OS_PARTITIONS=%(os_image_dir)s '
Dan Shiab999722015-12-04 14:27:08 -0800116 'ANDROID_PROVISION_VENDOR_PARTITIONS=%(vendor_partition_dir)s '
117 '%(vendor_partition_dir)s/provision-device')
Dan Shia2872172015-10-31 01:16:51 -0700118
Dan Shi12a4f662016-05-10 14:49:42 -0700119# Default timeout in minutes for fastboot commands.
120DEFAULT_FASTBOOT_RETRY_TIMEOUT_MIN = 10
121
David Purselle01548b2016-05-11 10:00:42 -0700122# Default permissions for files/dirs copied from the device.
123_DEFAULT_FILE_PERMS = 0o600
124_DEFAULT_DIR_PERMS = 0o700
125
Dan Shi626d5412016-05-16 16:05:13 -0700126# Constants for getprop return value for a given property.
127PROPERTY_VALUE_TRUE = '1'
128
Dan Shic716ac62016-05-24 16:47:57 -0700129# Timeout used for retrying installing apk. After reinstall apk failed, we try
130# to reboot the device and try again.
131APK_INSTALL_TIMEOUT_MIN = 5
132
Dan Shia2872172015-10-31 01:16:51 -0700133class AndroidInstallError(error.InstallError):
134 """Generic error for Android installation related exceptions."""
135
136
Simran Basi724b8a52013-09-30 11:19:31 -0700137class ADBHost(abstract_ssh.AbstractSSHHost):
Simran Basi431010f2013-09-04 10:42:41 -0700138 """This class represents a host running an ADB server."""
139
Simran Basi5ace6f22016-01-06 17:30:44 -0800140 VERSION_PREFIX = provision.ANDROID_BUILD_VERSION_PREFIX
Kevin Cheng3a4a57a2015-09-30 12:09:50 -0700141 _LABEL_FUNCTIONS = []
142 _DETECTABLE_LABELS = []
143 label_decorator = functools.partial(utils.add_label_detector,
144 _LABEL_FUNCTIONS,
145 _DETECTABLE_LABELS)
146
Dan Shi225b9042015-11-18 10:25:21 -0800147 _parser = autoserv_parser.autoserv_parser
Simran Basi431010f2013-09-04 10:42:41 -0700148
Dan Shi6450e142016-03-11 11:52:20 -0800149 # Minimum build id that supports server side packaging. Older builds may
150 # not have server side package built or with Autotest code change to support
151 # server-side packaging.
152 MIN_VERSION_SUPPORT_SSP = CONFIG.get_config_value(
153 'AUTOSERV', 'min_launch_control_build_id_support_ssp', type=int)
154
beeps46dadc92013-11-07 14:07:10 -0800155 @staticmethod
156 def check_host(host, timeout=10):
157 """
158 Check if the given host is an adb host.
159
Simran Basi14622bb2015-11-25 13:23:40 -0800160 If SSH connectivity can't be established, check_host will try to use
161 user 'adb' as well. If SSH connectivity still can't be established
162 then the original SSH user is restored.
163
beeps46dadc92013-11-07 14:07:10 -0800164 @param host: An ssh host representing a device.
165 @param timeout: The timeout for the run command.
166
167
168 @return: True if the host device has adb.
169
170 @raises AutoservRunError: If the command failed.
171 @raises AutoservSSHTimeout: Ssh connection has timed out.
172 """
Dan Shi64e130f2015-12-16 14:45:44 -0800173 # host object may not have user attribute if it's a LocalHost object.
174 current_user = host.user if hasattr(host, 'user') else None
beeps46dadc92013-11-07 14:07:10 -0800175 try:
Simran Basi14622bb2015-11-25 13:23:40 -0800176 if not (host.hostname == 'localhost' or
177 host.verify_ssh_user_access()):
Simran Basi1621c632015-10-14 12:22:23 -0700178 host.user = 'adb'
Simran Basi933c8af2015-04-29 14:05:07 -0700179 result = host.run(
Dan Shia2872172015-10-31 01:16:51 -0700180 'test -f %s' % server_constants.ANDROID_TESTER_FILEFLAG,
Simran Basi933c8af2015-04-29 14:05:07 -0700181 timeout=timeout)
beeps46dadc92013-11-07 14:07:10 -0800182 except (error.AutoservRunError, error.AutoservSSHTimeout):
Dan Shi64e130f2015-12-16 14:45:44 -0800183 if current_user is not None:
184 host.user = current_user
beeps46dadc92013-11-07 14:07:10 -0800185 return False
186 return result.exit_status == 0
187
188
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700189 # TODO(garnold) Remove the 'serials' argument once all clients are made to
190 # not use it.
Kevin Cheng3a4a57a2015-09-30 12:09:50 -0700191 def _initialize(self, hostname='localhost', serials=None,
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700192 adb_serial=None, fastboot_serial=None,
Simran Basi9228a6f2016-03-29 12:03:37 -0700193 teststation=None, *args, **dargs):
Simran Basi431010f2013-09-04 10:42:41 -0700194 """Initialize an ADB Host.
195
196 This will create an ADB Host. Hostname should always refer to the
Kevin Chengd19e6c62015-10-28 16:39:39 -0700197 test station connected to an Android DUT. This will be the DUT
198 to test with. If there are multiple, serial must be specified or an
Simran Basi9228a6f2016-03-29 12:03:37 -0700199 exception will be raised.
Simran Basi431010f2013-09-04 10:42:41 -0700200
201 @param hostname: Hostname of the machine running ADB.
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700202 @param serials: DEPRECATED (to be removed)
203 @param adb_serial: An ADB device serial. If None, assume a single
204 device is attached (and fail otherwise).
205 @param fastboot_serial: A fastboot device serial. If None, defaults to
206 the ADB serial (or assumes a single device if
207 the latter is None).
Kevin Cheng549beb42015-11-18 11:42:25 -0800208 @param teststation: The teststation object ADBHost should use.
Simran Basi431010f2013-09-04 10:42:41 -0700209 """
Simran Basi1bf60eb2015-12-01 16:39:29 -0800210 # Sets up the is_client_install_supported field.
211 super(ADBHost, self)._initialize(hostname=hostname,
212 is_client_install_supported=False,
213 *args, **dargs)
Kevin Cheng85e864a2015-11-30 11:49:34 -0800214
Kevin Chengd19e6c62015-10-28 16:39:39 -0700215 self.tmp_dirs = []
Kevin Chengc6a645a2015-12-18 11:15:10 -0800216 self.labels = base_label.LabelRetriever(adb_label.ADB_LABELS)
Simran Basi1bf60eb2015-12-01 16:39:29 -0800217 # TODO (sbasi/kevcheng): Once the teststation host is committed,
218 # refactor the serial retrieval.
219 adb_serial = adb_serial or self.host_attributes.get('serials', None)
Simran Basi973bf712016-05-26 13:41:34 -0700220 fastboot_serial = fastboot_serial or self.host_attributes.get(
221 'fastboot_serial', None)
Dan Shi50a412a2016-01-05 10:52:40 -0800222 self.adb_serial = adb_serial
Dan Shi3a011ed2016-04-26 12:26:53 -0700223 if adb_serial:
224 adb_prefix = any(adb_serial.startswith(p)
225 for p in ADB_DEVICE_PREFIXES)
226 self.fastboot_serial = (fastboot_serial or
227 ('tcp:%s' % adb_serial.split(':')[0] if
228 ':' in adb_serial and not adb_prefix else adb_serial))
229 self._use_tcpip = ':' in adb_serial and not adb_prefix
230 else:
231 self.fastboot_serial = fastboot_serial or adb_serial
232 self._use_tcpip = False
Kevin Cheng85e864a2015-11-30 11:49:34 -0800233 self.teststation = (teststation if teststation
234 else teststation_host.create_teststationhost(hostname=hostname))
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700235
236 msg ='Initializing ADB device on host: %s' % hostname
Dan Shi50a412a2016-01-05 10:52:40 -0800237 if self.adb_serial:
238 msg += ', ADB serial: %s' % self.adb_serial
239 if self.fastboot_serial:
240 msg += ', fastboot serial: %s' % self.fastboot_serial
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700241 logging.debug(msg)
242
Simran Basibeb2bb22016-02-03 15:25:48 -0800243 # Try resetting the ADB daemon on the device, however if we are
244 # creating the host to do a repair job, the device maybe inaccesible
245 # via ADB.
246 try:
247 self._reset_adbd_connection()
248 except (error.AutotestHostRunError, error.AutoservRunError) as e:
249 logging.error('Unable to reset the device adb daemon connection: '
250 '%s.', e)
Dan Shiab999722015-12-04 14:27:08 -0800251 self._os_type = None
252
Simran Basi431010f2013-09-04 10:42:41 -0700253
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700254 def _connect_over_tcpip_as_needed(self):
255 """Connect to the ADB device over TCP/IP if so configured."""
Simran Basi9228a6f2016-03-29 12:03:37 -0700256 if not self._use_tcpip:
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700257 return
258 logging.debug('Connecting to device over TCP/IP')
Simran Basi9228a6f2016-03-29 12:03:37 -0700259 self.adb_run('connect %s' % self.adb_serial)
Simran Basi431010f2013-09-04 10:42:41 -0700260
261
Roshan Pius4d7540c2015-12-16 13:30:32 -0800262 def _restart_adbd_with_root_permissions(self):
263 """Restarts the adb daemon with root permissions."""
Dan Shi922de302016-04-22 15:19:18 -0700264 @retry.retry(error.AutoservRunError, timeout_min=20/60.0, delay_sec=1)
265 def run_adb_root():
266 """Run command `adb root`."""
267 self.adb_run('root')
268
269 # adb command may flake with error "device not found". Retry the root
270 # command to reduce the chance of flake.
271 run_adb_root()
Roshan Pius4d7540c2015-12-16 13:30:32 -0800272 # TODO(ralphnathan): Remove this sleep once b/19749057 is resolved.
273 time.sleep(1)
Alexandru Branciogea380fb2016-04-01 16:01:34 +0300274 self._connect_over_tcpip_as_needed()
Roshan Pius4d7540c2015-12-16 13:30:32 -0800275 self.adb_run('wait-for-device')
276
277
Simran Basi9228a6f2016-03-29 12:03:37 -0700278 def _set_tcp_port(self):
279 """Ensure the device remains in tcp/ip mode after a reboot."""
280 if not self._use_tcpip:
281 return
282 port = self.adb_serial.split(':')[-1]
283 self.run('setprop persist.adb.tcp.port %s' % port)
284
285
Roshan Pius4d7540c2015-12-16 13:30:32 -0800286 def _reset_adbd_connection(self):
287 """Resets adbd connection to the device after a reboot/initialization"""
Roshan Pius4d7540c2015-12-16 13:30:32 -0800288 self._connect_over_tcpip_as_needed()
Simran Basi9228a6f2016-03-29 12:03:37 -0700289 self._restart_adbd_with_root_permissions()
290 self._set_tcp_port()
Roshan Pius4d7540c2015-12-16 13:30:32 -0800291
292
Kevin Cheng85e864a2015-11-30 11:49:34 -0800293 # pylint: disable=missing-docstring
Gilad Arnoldf17f6fd2015-11-12 14:44:07 -0800294 def adb_run(self, command, **kwargs):
Simran Basi431010f2013-09-04 10:42:41 -0700295 """Runs an adb command.
296
Kevin Chengd19e6c62015-10-28 16:39:39 -0700297 This command will launch on the test station.
Simran Basi431010f2013-09-04 10:42:41 -0700298
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700299 Refer to _device_run method for docstring for parameters.
300 """
Gilad Arnoldf17f6fd2015-11-12 14:44:07 -0800301 return self._device_run(ADB_CMD, command, **kwargs)
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700302
303
Kevin Cheng85e864a2015-11-30 11:49:34 -0800304 # pylint: disable=missing-docstring
Gilad Arnoldf17f6fd2015-11-12 14:44:07 -0800305 def fastboot_run(self, command, **kwargs):
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700306 """Runs an fastboot command.
307
Kevin Chengd19e6c62015-10-28 16:39:39 -0700308 This command will launch on the test station.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700309
310 Refer to _device_run method for docstring for parameters.
311 """
Gilad Arnoldf17f6fd2015-11-12 14:44:07 -0800312 return self._device_run(FASTBOOT_CMD, command, **kwargs)
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700313
314
Dan Shi12a4f662016-05-10 14:49:42 -0700315 # pylint: disable=missing-docstring
316 @retry.retry(error.AutoservRunError,
317 timeout_min=DEFAULT_FASTBOOT_RETRY_TIMEOUT_MIN)
318 def _fastboot_run_with_retry(self, command, **kwargs):
319 """Runs an fastboot command with retry.
320
321 This command will launch on the test station.
322
323 Refer to _device_run method for docstring for parameters.
324 """
325 return self.fastboot_run(command, **kwargs)
326
327
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700328 def _device_run(self, function, command, shell=False,
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700329 timeout=3600, ignore_status=False, ignore_timeout=False,
330 stdout=utils.TEE_TO_LOGS, stderr=utils.TEE_TO_LOGS,
331 connect_timeout=30, options='', stdin=None, verbose=True,
332 require_sudo=False, args=()):
Kevin Chengd19e6c62015-10-28 16:39:39 -0700333 """Runs a command named `function` on the test station.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700334
Kevin Chengd19e6c62015-10-28 16:39:39 -0700335 This command will launch on the test station.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700336
Simran Basi431010f2013-09-04 10:42:41 -0700337 @param command: Command to run.
338 @param shell: If true the command runs in the adb shell otherwise if
339 False it will be passed directly to adb. For example
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700340 reboot with shell=False will call 'adb reboot'. This
341 option only applies to function adb.
Simran Basi431010f2013-09-04 10:42:41 -0700342 @param timeout: Time limit in seconds before attempting to
343 kill the running process. The run() function
344 will take a few seconds longer than 'timeout'
345 to complete if it has to kill the process.
346 @param ignore_status: Do not raise an exception, no matter
347 what the exit code of the command is.
348 @param ignore_timeout: Bool True if command timeouts should be
349 ignored. Will return None on command timeout.
350 @param stdout: Redirect stdout.
351 @param stderr: Redirect stderr.
352 @param connect_timeout: Connection timeout (in seconds)
353 @param options: String with additional ssh command options
354 @param stdin: Stdin to pass (a string) to the executed command
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700355 @param require_sudo: True to require sudo to run the command. Default is
356 False.
Simran Basi431010f2013-09-04 10:42:41 -0700357 @param args: Sequence of strings to pass as arguments to command by
358 quoting them in " and escaping their contents if
359 necessary.
360
361 @returns a CMDResult object.
Simran Basi431010f2013-09-04 10:42:41 -0700362 """
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700363 if function == ADB_CMD:
Dan Shi50a412a2016-01-05 10:52:40 -0800364 serial = self.adb_serial
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700365 elif function == FASTBOOT_CMD:
Dan Shi50a412a2016-01-05 10:52:40 -0800366 serial = self.fastboot_serial
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700367 else:
368 raise NotImplementedError('Mode %s is not supported' % function)
369
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700370 if function != ADB_CMD and shell:
371 raise error.CmdError('shell option is only applicable to `adb`.')
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700372
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700373 cmd = '%s%s ' % ('sudo -n ' if require_sudo else '', function)
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700374
375 if serial:
376 cmd += '-s %s ' % serial
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700377
Simran Basi431010f2013-09-04 10:42:41 -0700378 if shell:
379 cmd += '%s ' % SHELL_CMD
380 cmd += command
381
Roshan Pius58e5dd32015-10-16 15:16:42 -0700382 if verbose:
383 logging.debug('Command: %s', cmd)
Simran Basi431010f2013-09-04 10:42:41 -0700384
Kevin Cheng85e864a2015-11-30 11:49:34 -0800385 return self.teststation.run(cmd, timeout=timeout,
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400386 ignore_status=ignore_status,
387 ignore_timeout=ignore_timeout, stdout_tee=stdout,
388 stderr_tee=stderr, options=options, stdin=stdin,
389 connect_timeout=connect_timeout, args=args)
Simran Basi431010f2013-09-04 10:42:41 -0700390
391
Dan Shi8c51bda2016-05-26 12:21:02 -0700392 def _run_output_with_retry(self, cmd):
393 """Call run_output method for the given command with retry.
394
395 adb command can be flaky some time and return empty string. It may take
396 several retries until a value can be returned.
397
398 @param cmd: The command to run.
399
400 @return: Return value from the command after retry.
401 """
402 try:
403 return client_utils.poll_for_condition(
404 lambda: self.run_output(cmd),
405 timeout=DEFAULT_COMMAND_RETRY_TIMEOUT_SECONDS,
406 sleep_interval=0.5,
407 desc='Get return value for command `%s`' % cmd)
408 except client_utils.TimeoutError:
409 return ''
410
411
Dan Shie234dea2016-01-20 17:15:17 -0800412 def get_board_name(self):
413 """Get the name of the board, e.g., shamu, dragonboard etc.
414 """
Simran Basi9c5d3982016-04-01 18:49:44 -0700415 product = self.run_output('getprop %s' % BOARD_FILE)
416 return PRODUCT_TARGET_MAP.get(product, product)
Dan Shie234dea2016-01-20 17:15:17 -0800417
418
Kevin Cheng3a4a57a2015-09-30 12:09:50 -0700419 @label_decorator()
Christopher Wiley8e6b08e2013-10-11 12:34:26 -0700420 def get_board(self):
Kevin Cheng3a4a57a2015-09-30 12:09:50 -0700421 """Determine the correct board label for the device.
422
423 @returns a string representing this device's board.
424 """
Dan Shie234dea2016-01-20 17:15:17 -0800425 board = self.get_board_name()
Kevin Cheng3a4a57a2015-09-30 12:09:50 -0700426 board_os = self.get_os_type()
Kevin Cheng49f7b812015-12-15 15:24:23 -0800427 return constants.BOARD_PREFIX + '-'.join([board_os, board])
Christopher Wiley8e6b08e2013-10-11 12:34:26 -0700428
429
Christopher Wiley08849d52013-11-22 08:57:58 -0800430 def job_start(self):
Bryan Lewandowski0f3f0112016-05-27 15:17:19 -0700431 """Overload of parent which intentionally doesn't log certain files.
Dan Shi2d279cf2016-05-27 22:06:10 +0000432
Bryan Lewandowski0f3f0112016-05-27 15:17:19 -0700433 The parent implementation attempts to log certain Linux files, such as
434 /var/log, which do not exist on Android, thus there is no call to the
435 parent's job_start(). The sync call is made so that logcat logs can be
436 approximately matched to server logs.
Dan Shi2d279cf2016-05-27 22:06:10 +0000437 """
Bryan Lewandowski0f3f0112016-05-27 15:17:19 -0700438 self._sync_time()
Christopher Wiley08849d52013-11-22 08:57:58 -0800439
440
Simran Basi431010f2013-09-04 10:42:41 -0700441 def run(self, command, timeout=3600, ignore_status=False,
442 ignore_timeout=False, stdout_tee=utils.TEE_TO_LOGS,
443 stderr_tee=utils.TEE_TO_LOGS, connect_timeout=30, options='',
Roshan Pius58e5dd32015-10-16 15:16:42 -0700444 stdin=None, verbose=True, args=()):
Simran Basi431010f2013-09-04 10:42:41 -0700445 """Run a command on the adb device.
446
447 The command given will be ran directly on the adb device; for example
448 'ls' will be ran as: 'abd shell ls'
449
450 @param command: The command line string.
451 @param timeout: Time limit in seconds before attempting to
452 kill the running process. The run() function
453 will take a few seconds longer than 'timeout'
454 to complete if it has to kill the process.
455 @param ignore_status: Do not raise an exception, no matter
456 what the exit code of the command is.
457 @param ignore_timeout: Bool True if command timeouts should be
458 ignored. Will return None on command timeout.
459 @param stdout_tee: Redirect stdout.
460 @param stderr_tee: Redirect stderr.
461 @param connect_timeout: Connection timeout (in seconds).
462 @param options: String with additional ssh command options.
463 @param stdin: Stdin to pass (a string) to the executed command
464 @param args: Sequence of strings to pass as arguments to command by
465 quoting them in " and escaping their contents if
466 necessary.
467
468 @returns A CMDResult object or None if the call timed out and
469 ignore_timeout is True.
470
471 @raises AutoservRunError: If the command failed.
472 @raises AutoservSSHTimeout: Ssh connection has timed out.
Simran Basi431010f2013-09-04 10:42:41 -0700473 """
Filipe Brandenburger68a80072015-07-14 10:39:33 -0700474 command = ('"%s; echo %s:\$?"' %
475 (utils.sh_escape(command), CMD_OUTPUT_PREFIX))
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700476 result = self.adb_run(
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700477 command, shell=True, timeout=timeout,
Simran Basi431010f2013-09-04 10:42:41 -0700478 ignore_status=ignore_status, ignore_timeout=ignore_timeout,
479 stdout=stdout_tee, stderr=stderr_tee,
480 connect_timeout=connect_timeout, options=options, stdin=stdin,
Roshan Pius58e5dd32015-10-16 15:16:42 -0700481 verbose=verbose, args=args)
Simran Basi431010f2013-09-04 10:42:41 -0700482 if not result:
483 # In case of timeouts.
484 return None
485
486 parse_output = re.match(CMD_OUTPUT_REGEX, result.stdout)
Roshan Pius5ba5d182015-10-28 09:19:41 -0700487 if not parse_output and not ignore_status:
Simran Basi431010f2013-09-04 10:42:41 -0700488 raise error.AutoservRunError(
Roshan Pius5ba5d182015-10-28 09:19:41 -0700489 'Failed to parse the exit code for command: %s' %
490 command, result)
491 elif parse_output:
492 result.stdout = parse_output.group('OUTPUT')
493 result.exit_status = int(parse_output.group('EXIT_CODE'))
494 if result.exit_status != 0 and not ignore_status:
495 raise error.AutoservRunError(command, result)
Simran Basi431010f2013-09-04 10:42:41 -0700496 return result
497
498
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700499 def wait_up(self, timeout=DEFAULT_WAIT_UP_TIME_SECONDS, command=ADB_CMD):
500 """Wait until the remote host is up or the timeout expires.
Simran Basi431010f2013-09-04 10:42:41 -0700501
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700502 Overrides wait_down from AbstractSSHHost.
Simran Basi431010f2013-09-04 10:42:41 -0700503
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700504 @param timeout: Time limit in seconds before returning even if the host
505 is not up.
506 @param command: The command used to test if a device is up, i.e.,
507 accessible by the given command. Default is set to `adb`.
Simran Basi431010f2013-09-04 10:42:41 -0700508
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700509 @returns True if the host was found to be up before the timeout expires,
510 False otherwise.
Simran Basi431010f2013-09-04 10:42:41 -0700511 """
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700512 @retry.retry(error.TimeoutException, timeout_min=timeout/60.0,
513 delay_sec=1)
514 def _wait_up():
515 if not self.is_up(command=command):
516 raise error.TimeoutException('Device is still down.')
517 return True
518
519 try:
520 _wait_up()
521 logging.debug('Host %s is now up, and can be accessed by %s.',
522 self.hostname, command)
523 return True
524 except error.TimeoutException:
525 logging.debug('Host %s is still down after waiting %d seconds',
526 self.hostname, timeout)
527 return False
Simran Basi431010f2013-09-04 10:42:41 -0700528
529
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700530 def wait_down(self, timeout=DEFAULT_WAIT_DOWN_TIME_SECONDS,
531 warning_timer=None, old_boot_id=None, command=ADB_CMD):
532 """Wait till the host goes down, i.e., not accessible by given command.
Simran Basi431010f2013-09-04 10:42:41 -0700533
534 Overrides wait_down from AbstractSSHHost.
535
536 @param timeout: Time in seconds to wait for the host to go down.
537 @param warning_timer: Time limit in seconds that will generate
538 a warning if the host is not down yet.
539 Currently ignored.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700540 @param old_boot_id: Not applicable for adb_host.
541 @param command: `adb`, test if the device can be accessed by adb
542 command, or `fastboot`, test if the device can be accessed by
543 fastboot command. Default is set to `adb`.
Simran Basi431010f2013-09-04 10:42:41 -0700544
545 @returns True if the device goes down before the timeout, False
546 otherwise.
Simran Basi431010f2013-09-04 10:42:41 -0700547 """
548 @retry.retry(error.TimeoutException, timeout_min=timeout/60.0,
549 delay_sec=1)
550 def _wait_down():
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700551 if self.is_up(command=command):
Simran Basi431010f2013-09-04 10:42:41 -0700552 raise error.TimeoutException('Device is still up.')
553 return True
554
555 try:
556 _wait_down()
557 logging.debug('Host %s is now down', self.hostname)
558 return True
559 except error.TimeoutException:
560 logging.debug('Host %s is still up after waiting %d seconds',
561 self.hostname, timeout)
562 return False
563
564
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700565 def reboot(self):
Kevin Chengd19e6c62015-10-28 16:39:39 -0700566 """Reboot the android device via adb.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700567
568 @raises AutoservRebootError if reboot failed.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700569 """
570 # Not calling super.reboot() as we want to reboot the ADB device not
Kevin Chengd19e6c62015-10-28 16:39:39 -0700571 # the test station we are running ADB on.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700572 self.adb_run('reboot', timeout=10, ignore_timeout=True)
573 if not self.wait_down():
574 raise error.AutoservRebootError(
575 'ADB Device is still up after reboot')
576 if not self.wait_up():
577 raise error.AutoservRebootError(
578 'ADB Device failed to return from reboot.')
Roshan Pius4d7540c2015-12-16 13:30:32 -0800579 self._reset_adbd_connection()
Roshan Pius50c1f9c2015-11-30 11:37:49 -0800580
581
Alexandru Branciog969ff7c2016-03-30 14:07:15 +0300582 def fastboot_reboot(self):
583 """Do a fastboot reboot to go back to adb.
584
585 @raises AutoservRebootError if reboot failed.
586 """
587 self.fastboot_run('reboot')
588 if not self.wait_down(command=FASTBOOT_CMD):
589 raise error.AutoservRebootError(
590 'Device is still in fastboot mode after reboot')
591 if not self.wait_up():
592 raise error.AutoservRebootError(
593 'Device failed to boot to adb after fastboot reboot.')
594 self._reset_adbd_connection()
595
596
Ralph Nathanb45eb672015-11-18 20:04:39 -0800597 def remount(self):
598 """Remounts paritions on the device read-write.
599
600 Specifically, the /system, /vendor (if present) and /oem (if present)
601 partitions on the device are remounted read-write.
602 """
Ralph Nathanb45eb672015-11-18 20:04:39 -0800603 self.adb_run('remount')
604
605
Kevin Cheng549beb42015-11-18 11:42:25 -0800606 @staticmethod
607 def parse_device_serials(devices_output):
608 """Return a list of parsed serials from the output.
609
610 @param devices_output: Output from either an adb or fastboot command.
611
612 @returns List of device serials
613 """
614 devices = []
615 for line in devices_output.splitlines():
616 match = re.search(DEVICE_FINDER_REGEX, line)
617 if match:
618 serial = match.group('SERIAL')
619 if serial == DEVICE_NO_SERIAL_MSG or re.match(r'^\?+$', serial):
620 serial = DEVICE_NO_SERIAL_TAG
621 logging.debug('Found Device: %s', serial)
622 devices.append(serial)
623 return devices
624
625
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700626 def _get_devices(self, use_adb):
Kevin Chengd19e6c62015-10-28 16:39:39 -0700627 """Get a list of devices currently attached to the test station.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700628
629 @params use_adb: True to get adb accessible devices. Set to False to
630 get fastboot accessible devices.
631
Kevin Chengd19e6c62015-10-28 16:39:39 -0700632 @returns a list of devices attached to the test station.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700633 """
634 if use_adb:
Alexandru Branciogea380fb2016-04-01 16:01:34 +0300635 result = self.adb_run('devices').stdout
636 if self.adb_serial and self.adb_serial not in result:
637 self._connect_over_tcpip_as_needed()
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700638 else:
Alexandru Branciogea380fb2016-04-01 16:01:34 +0300639 result = self.fastboot_run('devices').stdout
640 if (self.fastboot_serial and
641 self.fastboot_serial not in result):
642 # fastboot devices won't list the devices using TCP
643 try:
644 if 'product' in self.fastboot_run('getvar product',
645 timeout=2).stderr:
646 result += '\n%s\tfastboot' % self.fastboot_serial
Kevin Chengcfcb2cf2016-04-13 10:04:36 -0700647 # The main reason we do a general Exception catch here instead
648 # of setting ignore_timeout/status to True is because even when
649 # the fastboot process has been nuked, it still stays around and
650 # so bgjob wants to warn us of this and tries to read the
651 # /proc/<pid>/stack file which then promptly returns an
652 # 'Operation not permitted' error since we're running as moblab
653 # and we don't have permission to read those files.
654 except Exception:
Alexandru Branciogea380fb2016-04-01 16:01:34 +0300655 pass
656 return self.parse_device_serials(result)
Simran Basi431010f2013-09-04 10:42:41 -0700657
658
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700659 def adb_devices(self):
Kevin Chengd19e6c62015-10-28 16:39:39 -0700660 """Get a list of devices currently attached to the test station and
661 accessible with the adb command."""
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700662 devices = self._get_devices(use_adb=True)
Dan Shi50a412a2016-01-05 10:52:40 -0800663 if self.adb_serial is None and len(devices) > 1:
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700664 raise error.AutoservError(
665 'Not given ADB serial but multiple devices detected')
666 return devices
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700667
668
669 def fastboot_devices(self):
Kevin Chengd19e6c62015-10-28 16:39:39 -0700670 """Get a list of devices currently attached to the test station and
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700671 accessible by fastboot command.
672 """
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700673 devices = self._get_devices(use_adb=False)
Dan Shi50a412a2016-01-05 10:52:40 -0800674 if self.fastboot_serial is None and len(devices) > 1:
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700675 raise error.AutoservError(
676 'Not given fastboot serial but multiple devices detected')
677 return devices
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700678
679
680 def is_up(self, timeout=0, command=ADB_CMD):
681 """Determine if the specified adb device is up with expected mode.
Simran Basi431010f2013-09-04 10:42:41 -0700682
683 @param timeout: Not currently used.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700684 @param command: `adb`, the device can be accessed by adb command,
685 or `fastboot`, the device can be accessed by fastboot command.
686 Default is set to `adb`.
Simran Basi431010f2013-09-04 10:42:41 -0700687
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700688 @returns True if the device is detectable by given command, False
689 otherwise.
Simran Basi431010f2013-09-04 10:42:41 -0700690
691 """
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700692 if command == ADB_CMD:
693 devices = self.adb_devices()
Dan Shi50a412a2016-01-05 10:52:40 -0800694 serial = self.adb_serial
Kris Rambishde8f9d12015-12-16 12:42:41 -0800695 # ADB has a device state, if the device is not online, no
696 # subsequent ADB command will complete.
Dan Shi6450e142016-03-11 11:52:20 -0800697 # DUT with single device connected may not have adb_serial set.
698 # Therefore, skip checking if serial is in the list of adb devices
699 # if self.adb_serial is not set.
700 if (serial and serial not in devices) or not self.is_device_ready():
Kris Rambishde8f9d12015-12-16 12:42:41 -0800701 logging.debug('Waiting for device to enter the ready state.')
702 return False
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700703 elif command == FASTBOOT_CMD:
704 devices = self.fastboot_devices()
Dan Shi50a412a2016-01-05 10:52:40 -0800705 serial = self.fastboot_serial
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700706 else:
Gilad Arnold2cfa5522015-10-30 13:58:02 -0700707 raise NotImplementedError('Mode %s is not supported' % command)
708
709 return bool(devices and (not serial or serial in devices))
Simran Basi431010f2013-09-04 10:42:41 -0700710
711
Bryan Lewandowski0f3f0112016-05-27 15:17:19 -0700712 def stop_loggers(self):
713 """Inherited stop_loggers function.
714
715 Calls parent function and captures logcat, since the end of the run
716 is logically the end/stop of the logcat log.
717 """
718 super(ADBHost, self).stop_loggers()
719 # Record logcat log to a temporary file on the teststation.
720 tmp_dir = self.teststation.get_tmp_dir()
721 teststation_filename = os.path.join(tmp_dir, LOGCAT_FILE)
722 self.adb_run('logcat -v time -d > "%s"' % (teststation_filename))
723 # Copy-back the log to the drone's results directory.
724 logcat_filename = os.path.join(self.job.resultdir, LOGCAT_FILE)
725 self.teststation.get_file(teststation_filename, logcat_filename)
726 try:
727 self.teststation.run('rm -rf %s' % tmp_dir)
728 except (error.AutoservRunError, error.AutoservSSHTimeout) as e:
729 logging.warn('failed to remove dir %s: %s', tmp_dir, e)
730
731
Simran Basi431010f2013-09-04 10:42:41 -0700732 def close(self):
Kevin Chengd19e6c62015-10-28 16:39:39 -0700733 """Close the ADBHost object.
Simran Basi431010f2013-09-04 10:42:41 -0700734
735 Called as the test ends. Will return the device to USB mode and kill
736 the ADB server.
Simran Basi431010f2013-09-04 10:42:41 -0700737 """
Christopher Wiley08849d52013-11-22 08:57:58 -0800738 # TODO(sbasi) Originally, we would kill the server after each test to
739 # reduce the opportunity for bad server state to hang around.
740 # Unfortunately, there is a period of time after each kill during which
741 # the Android device becomes unusable, and if we start the next test
742 # too quickly, we'll get an error complaining about no ADB device
743 # attached.
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700744 #self.adb_run('kill-server')
Roshan Pius39942602015-12-17 13:42:07 -0800745 # |close| the associated teststation as well.
746 self.teststation.close()
Simran Basi431010f2013-09-04 10:42:41 -0700747 return super(ADBHost, self).close()
Kris Rambish60461dc2014-03-11 11:10:18 -0700748
749
750 def syslog(self, message, tag='autotest'):
Kevin Chengd19e6c62015-10-28 16:39:39 -0700751 """Logs a message to syslog on the device.
Kris Rambish60461dc2014-03-11 11:10:18 -0700752
753 @param message String message to log into syslog
754 @param tag String tag prefix for syslog
755
756 """
Kevin Chengd19e6c62015-10-28 16:39:39 -0700757 self.run('log -t "%s" "%s"' % (tag, message))
Simran Basid3ba3fb2015-09-11 14:35:07 -0700758
759
760 def get_autodir(self):
761 """Return the directory to install autotest for client side tests."""
762 return '/data/autotest'
763
Kevin Cheng018db352015-09-20 02:22:08 -0700764
Kris Rambishde8f9d12015-12-16 12:42:41 -0800765 def is_device_ready(self):
766 """Return the if the device is ready for ADB commands."""
Dan Shi7075f552016-04-21 15:42:41 -0700767 try:
768 # Retry to avoid possible flakes.
769 is_ready = client_utils.poll_for_condition(
770 lambda: self.adb_run('get-state').stdout.strip() == 'device',
771 timeout=DEFAULT_COMMAND_RETRY_TIMEOUT_SECONDS, sleep_interval=1,
772 desc='Waiting for device state to be `device`')
773 except client_utils.TimeoutError:
774 is_ready = False
775
776 logging.debug('Device state is %sready', '' if is_ready else 'NOT ')
777 return is_ready
Kris Rambishde8f9d12015-12-16 12:42:41 -0800778
779
Kevin Chengd19e6c62015-10-28 16:39:39 -0700780 def verify_connectivity(self):
781 """Verify we can connect to the device."""
Kris Rambishde8f9d12015-12-16 12:42:41 -0800782 if not self.is_device_ready():
783 raise error.AutoservHostError('device state is not in the '
784 '\'device\' state.')
Kevin Chengd19e6c62015-10-28 16:39:39 -0700785
786
Simran Basid3ba3fb2015-09-11 14:35:07 -0700787 def verify_software(self):
788 """Verify working software on an adb_host.
789
Simran Basi38f7ddf2015-09-18 12:25:03 -0700790 TODO (crbug.com/532222): Actually implement this method.
Simran Basid3ba3fb2015-09-11 14:35:07 -0700791 """
Dan Shiab999722015-12-04 14:27:08 -0800792 # Check if adb and fastboot are present.
793 self.teststation.run('which adb')
794 self.teststation.run('which fastboot')
795 self.teststation.run('which unzip')
Simran Basid3ba3fb2015-09-11 14:35:07 -0700796
Dan Shi626d5412016-05-16 16:05:13 -0700797 # Apply checks only for Android device.
Dan Shi1e2a98a2016-05-18 12:08:08 -0700798 if self.get_os_type() == OS_TYPE_ANDROID:
Dan Shi626d5412016-05-16 16:05:13 -0700799 # Make sure ro.boot.hardware and ro.build.product match.
Dan Shi8c51bda2016-05-26 12:21:02 -0700800 hardware = self._run_output_with_retry('getprop ro.boot.hardware')
801 product = self._run_output_with_retry('getprop ro.build.product')
Dan Shi1e2a98a2016-05-18 12:08:08 -0700802 if hardware != product:
803 raise error.AutoservHostError('ro.boot.hardware: %s does not '
804 'match to ro.build.product: %s' %
805 (hardware, product))
806
Dan Shi626d5412016-05-16 16:05:13 -0700807 # Check the bootloader is not locked. sys.oem_unlock_allowed is not
808 # applicable to Brillo devices.
Dan Shi8c51bda2016-05-26 12:21:02 -0700809 result = self._run_output_with_retry(
810 'getprop sys.oem_unlock_allowed')
Dan Shi626d5412016-05-16 16:05:13 -0700811 if result != PROPERTY_VALUE_TRUE:
812 raise error.AutoservHostError(
813 'The bootloader is locked. sys.oem_unlock_allowed: %s.'
814 % result)
815
Kevin Cheng018db352015-09-20 02:22:08 -0700816
Simran Basid3ba3fb2015-09-11 14:35:07 -0700817 def verify_job_repo_url(self, tag=''):
818 """Make sure job_repo_url of this host is valid.
819
Simran Basi38f7ddf2015-09-18 12:25:03 -0700820 TODO (crbug.com/532223): Actually implement this method.
Simran Basid3ba3fb2015-09-11 14:35:07 -0700821
822 @param tag: The tag from the server job, in the format
823 <job_id>-<user>/<hostname>, or <hostless> for a server job.
824 """
825 return
Kevin Cheng018db352015-09-20 02:22:08 -0700826
827
Simran Basibeb2bb22016-02-03 15:25:48 -0800828 def repair(self):
829 """Attempt to get the DUT to pass `self.verify()`."""
830 try:
831 self.ensure_adb_mode(timeout=30)
832 return
833 except error.AutoservError as e:
834 logging.error(e)
835 logging.debug('Verifying the device is accessible via fastboot.')
836 self.ensure_bootloader_mode()
837 if not self.job.run_test(
838 'provision_AndroidUpdate', host=self, value=None,
839 force=True, repair=True):
840 raise error.AutoservRepairTotalFailure(
841 'Unable to repair the device.')
842
843
Simran Basi1b023762015-09-25 12:12:20 -0700844 def send_file(self, source, dest, delete_dest=False,
845 preserve_symlinks=False):
Kevin Cheng018db352015-09-20 02:22:08 -0700846 """Copy files from the drone to the device.
847
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400848 Just a note, there is the possibility the test station is localhost
849 which makes some of these steps redundant (e.g. creating tmp dir) but
850 that scenario will undoubtedly be a development scenario (test station
851 is also the moblab) and not the typical live test running scenario so
852 the redundancy I think is harmless.
853
Kevin Cheng018db352015-09-20 02:22:08 -0700854 @param source: The file/directory on the drone to send to the device.
855 @param dest: The destination path on the device to copy to.
856 @param delete_dest: A flag set to choose whether or not to delete
857 dest on the device if it exists.
Simran Basi1b023762015-09-25 12:12:20 -0700858 @param preserve_symlinks: Controls if symlinks on the source will be
859 copied as such on the destination or
860 transformed into the referenced
861 file/directory.
Kevin Cheng018db352015-09-20 02:22:08 -0700862 """
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700863 # If we need to preserve symlinks, let's check if the source is a
864 # symlink itself and if so, just create it on the device.
865 if preserve_symlinks:
866 symlink_target = None
867 try:
868 symlink_target = os.readlink(source)
869 except OSError:
870 # Guess it's not a symlink.
871 pass
872
873 if symlink_target is not None:
874 # Once we create the symlink, let's get out of here.
875 self.run('ln -s %s %s' % (symlink_target, dest))
876 return
877
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400878 # Stage the files on the test station.
Kevin Chengd19e6c62015-10-28 16:39:39 -0700879 tmp_dir = self.teststation.get_tmp_dir()
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400880 src_path = os.path.join(tmp_dir, os.path.basename(dest))
881 # Now copy the file over to the test station so you can reference the
882 # file in the push command.
883 self.teststation.send_file(source, src_path,
884 preserve_symlinks=preserve_symlinks)
Kevin Cheng018db352015-09-20 02:22:08 -0700885
886 if delete_dest:
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400887 self.run('rm -rf %s' % dest)
Kevin Cheng018db352015-09-20 02:22:08 -0700888
Dan Shi6ea3e1c2015-10-28 15:19:04 -0700889 self.adb_run('push %s %s' % (src_path, dest))
Kevin Cheng018db352015-09-20 02:22:08 -0700890
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400891 # Cleanup the test station.
892 try:
893 self.teststation.run('rm -rf %s' % tmp_dir)
894 except (error.AutoservRunError, error.AutoservSSHTimeout) as e:
895 logging.warn('failed to remove dir %s: %s', tmp_dir, e)
Kevin Cheng018db352015-09-20 02:22:08 -0700896
897
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700898 def _get_file_info(self, dest):
899 """Get permission and possible symlink info about file on the device.
900
901 These files are on the device so we only have shell commands (via adb)
902 to get the info we want. We'll use 'ls' to get it all.
903
904 @param dest: File to get info about.
905
906 @returns a dict of the file permissions and symlink.
907 """
Kevin Chengaaabd0c2015-11-10 16:05:04 -0800908 # Grab file info.
Casey Dahlinf6bc8ed2016-04-13 14:33:48 -0700909 file_info = self.run_output('ls -ld %s' % dest)
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700910 symlink = None
911 perms = 0
912 match = re.match(FILE_INFO_REGEX, file_info)
913 if match:
914 # Check if it's a symlink and grab the linked dest if it is.
915 if match.group('TYPE') == 'l':
916 symlink_match = re.match(FILE_SYMLINK_REGEX, file_info)
917 if symlink_match:
918 symlink = symlink_match.group('SYMLINK')
919
920 # Set the perms.
921 for perm, perm_flag in zip(match.group('PERMS'), FILE_PERMS_FLAGS):
922 if perm != '-':
923 perms |= perm_flag
924
925 return {'perms': perms,
926 'symlink': symlink}
927
928
Simran Basi1b023762015-09-25 12:12:20 -0700929 def get_file(self, source, dest, delete_dest=False, preserve_perm=True,
930 preserve_symlinks=False):
Kevin Cheng018db352015-09-20 02:22:08 -0700931 """Copy files from the device to the drone.
932
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400933 Just a note, there is the possibility the test station is localhost
934 which makes some of these steps redundant (e.g. creating tmp dir) but
935 that scenario will undoubtedly be a development scenario (test station
936 is also the moblab) and not the typical live test running scenario so
937 the redundancy I think is harmless.
938
Kevin Cheng018db352015-09-20 02:22:08 -0700939 @param source: The file/directory on the device to copy back to the
940 drone.
941 @param dest: The destination path on the drone to copy to.
942 @param delete_dest: A flag set to choose whether or not to delete
943 dest on the drone if it exists.
Simran Basi1b023762015-09-25 12:12:20 -0700944 @param preserve_perm: Tells get_file() to try to preserve the sources
945 permissions on files and dirs.
946 @param preserve_symlinks: Try to preserve symlinks instead of
947 transforming them into files/dirs on copy.
Kevin Cheng018db352015-09-20 02:22:08 -0700948 """
David Purselle01548b2016-05-11 10:00:42 -0700949 # Stage the files on the test station under teststation_temp_dir.
950 teststation_temp_dir = self.teststation.get_tmp_dir()
951 teststation_dest = os.path.join(teststation_temp_dir,
952 os.path.basename(source))
Kevin Cheng018db352015-09-20 02:22:08 -0700953
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700954 source_info = {}
955 if preserve_symlinks or preserve_perm:
956 source_info = self._get_file_info(source)
Kevin Cheng018db352015-09-20 02:22:08 -0700957
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700958 # If we want to preserve symlinks, just create it here, otherwise pull
959 # the file off the device.
Casey Dahlinf6bc8ed2016-04-13 14:33:48 -0700960 #
961 # TODO(sadmac): Directories containing symlinks won't behave as
962 # expected.
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700963 if preserve_symlinks and source_info['symlink']:
964 os.symlink(source_info['symlink'], dest)
965 else:
David Purselle01548b2016-05-11 10:00:42 -0700966 self.adb_run('pull %s %s' % (source, teststation_temp_dir))
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700967
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400968 # Copy over the file from the test station and clean up.
David Purselle01548b2016-05-11 10:00:42 -0700969 self.teststation.get_file(teststation_dest, dest,
970 delete_dest=delete_dest)
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400971 try:
David Purselle01548b2016-05-11 10:00:42 -0700972 self.teststation.run('rm -rf %s' % teststation_temp_dir)
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -0400973 except (error.AutoservRunError, error.AutoservSSHTimeout) as e:
David Purselle01548b2016-05-11 10:00:42 -0700974 logging.warn('failed to remove dir %s: %s',
975 teststation_temp_dir, e)
Kevin Cheng92fe6ae2015-10-21 11:45:34 -0700976
David Pursell788b1b52016-05-19 09:03:31 -0700977 # Source will be copied under dest if either:
978 # 1. Source is a directory and doesn't end with /.
979 # 2. Source is a file and dest is a directory.
980 source_is_dir = self.run('[ -d "$${%s} ]',
981 ignore_status=True).exit_status == 0
982 if ((source_is_dir and not source.endswith(os.sep)) or
983 (not source_is_dir and os.path.isdir(dest))):
984 receive_path = os.path.join(dest, os.path.basename(source))
985 else:
986 receive_path = dest
Casey Dahlinf6bc8ed2016-04-13 14:33:48 -0700987
David Pursell788b1b52016-05-19 09:03:31 -0700988 # Set the permissions of the received file/dirs.
989 if os.path.isdir(receive_path):
990 for root, _dirs, files in os.walk(receive_path):
991 def process(rel_path, default_perm):
992 info = self._get_file_info(os.path.join(source,
993 rel_path))
994 if info['perms'] != 0:
995 target = os.path.join(receive_path, rel_path)
996 if preserve_perm:
997 os.chmod(target, info['perms'])
998 else:
999 os.chmod(target, default_perm)
Casey Dahlinf6bc8ed2016-04-13 14:33:48 -07001000
David Pursell788b1b52016-05-19 09:03:31 -07001001 rel_root = os.path.relpath(root, receive_path)
1002 process(rel_root, _DEFAULT_DIR_PERMS)
1003 for f in files:
1004 process(os.path.join(rel_root, f), _DEFAULT_FILE_PERMS)
1005 elif preserve_perm:
1006 os.chmod(receive_path, source_info['perms'])
1007 else:
1008 os.chmod(receive_path, _DEFAULT_FILE_PERMS)
Kevin Cheng018db352015-09-20 02:22:08 -07001009
1010
1011 def get_release_version(self):
1012 """Get the release version from the RELEASE_FILE on the device.
1013
1014 @returns The release string in the RELEASE_FILE.
1015
1016 """
1017 return self.run_output('getprop %s' % RELEASE_FILE)
Simran Basi38f7ddf2015-09-18 12:25:03 -07001018
1019
1020 def get_tmp_dir(self, parent=''):
Kevin Chengd19e6c62015-10-28 16:39:39 -07001021 """Return a suitable temporary directory on the device.
Simran Basi38f7ddf2015-09-18 12:25:03 -07001022
Kevin Chengd19e6c62015-10-28 16:39:39 -07001023 We ensure this is a subdirectory of /data/local/tmp.
Simran Basi38f7ddf2015-09-18 12:25:03 -07001024
1025 @param parent: Parent directory of the returned tmp dir.
1026
Kevin Cheng3a4a57a2015-09-30 12:09:50 -07001027 @returns a path to the temp directory on the host.
Simran Basi38f7ddf2015-09-18 12:25:03 -07001028 """
Kevin Chengd19e6c62015-10-28 16:39:39 -07001029 # TODO(kevcheng): Refactor the cleanup of tmp dir to be inherited
1030 # from the parent.
Simran Basi38f7ddf2015-09-18 12:25:03 -07001031 if not parent.startswith(TMP_DIR):
1032 parent = os.path.join(TMP_DIR, parent.lstrip(os.path.sep))
Kevin Chengd19e6c62015-10-28 16:39:39 -07001033 self.run('mkdir -p %s' % parent)
1034 tmp_dir = self.run_output('mktemp -d -p %s' % parent)
1035 self.tmp_dirs.append(tmp_dir)
1036 return tmp_dir
Simran Basi1b023762015-09-25 12:12:20 -07001037
1038
1039 def get_platform(self):
1040 """Determine the correct platform label for this host.
1041
1042 TODO (crbug.com/536250): Figure out what we want to do for adb_host's
Kevin Chengd19e6c62015-10-28 16:39:39 -07001043 get_platform.
Simran Basi1b023762015-09-25 12:12:20 -07001044
1045 @returns a string representing this host's platform.
1046 """
1047 return 'adb'
1048
1049
Gilad Arnolda76bef02015-09-29 13:55:15 -07001050 def get_os_type(self):
Dan Shiab999722015-12-04 14:27:08 -08001051 """Get the OS type of the DUT, e.g., android or brillo.
1052 """
1053 if not self._os_type:
1054 if self.run_output('getprop ro.product.brand') == 'Brillo':
1055 self._os_type = OS_TYPE_BRILLO
1056 else:
1057 self._os_type = OS_TYPE_ANDROID
1058
1059 return self._os_type
Gilad Arnolde452b1f2015-10-06 08:48:34 -07001060
1061
1062 def _forward(self, reverse, args):
1063 """Execute a forwarding command.
1064
1065 @param reverse: Whether this is reverse forwarding (Boolean).
1066 @param args: List of command arguments.
1067 """
1068 cmd = '%s %s' % ('reverse' if reverse else 'forward', ' '.join(args))
Dan Shi6ea3e1c2015-10-28 15:19:04 -07001069 self.adb_run(cmd)
Gilad Arnolde452b1f2015-10-06 08:48:34 -07001070
1071
1072 def add_forwarding(self, src, dst, reverse=False, rebind=True):
1073 """Forward a port between the ADB host and device.
1074
1075 Port specifications are any strings accepted as such by ADB, for
1076 example 'tcp:8080'.
1077
1078 @param src: Port specification to forward from.
1079 @param dst: Port specification to forward to.
1080 @param reverse: Do reverse forwarding from device to host (Boolean).
1081 @param rebind: Allow rebinding an already bound port (Boolean).
1082 """
1083 args = []
1084 if not rebind:
1085 args.append('--no-rebind')
1086 args += [src, dst]
1087 self._forward(reverse, args)
1088
1089
1090 def remove_forwarding(self, src=None, reverse=False):
1091 """Removes forwarding on port.
1092
1093 @param src: Port specification, or None to remove all forwarding.
1094 @param reverse: Whether this is reverse forwarding (Boolean).
1095 """
1096 args = []
1097 if src is None:
1098 args.append('--remove-all')
1099 else:
1100 args += ['--remove', src]
1101 self._forward(reverse, args)
Roshan Pius58e5dd32015-10-16 15:16:42 -07001102
1103
xixuan6cf6d2f2016-01-29 15:29:00 -08001104 def create_ssh_tunnel(self, port, local_port):
Roshan Pius58e5dd32015-10-16 15:16:42 -07001105 """
1106 Forwards a port securely through a tunnel process from the server
1107 to the DUT for RPC server connection.
1108 Add a 'ADB forward' rule to forward the RPC packets from the AdbHost
1109 to the DUT.
1110
1111 @param port: remote port on the DUT.
1112 @param local_port: local forwarding port.
1113
1114 @return: the tunnel process.
1115 """
1116 self.add_forwarding('tcp:%s' % port, 'tcp:%s' % port)
xixuan6cf6d2f2016-01-29 15:29:00 -08001117 return super(ADBHost, self).create_ssh_tunnel(port, local_port)
Roshan Pius58e5dd32015-10-16 15:16:42 -07001118
1119
xixuan6cf6d2f2016-01-29 15:29:00 -08001120 def disconnect_ssh_tunnel(self, tunnel_proc, port):
Roshan Pius58e5dd32015-10-16 15:16:42 -07001121 """
1122 Disconnects a previously forwarded port from the server to the DUT for
1123 RPC server connection.
1124 Remove the previously added 'ADB forward' rule to forward the RPC
1125 packets from the AdbHost to the DUT.
1126
1127 @param tunnel_proc: the original tunnel process returned from
xixuan6cf6d2f2016-01-29 15:29:00 -08001128 |create_ssh_tunnel|.
Roshan Pius58e5dd32015-10-16 15:16:42 -07001129 @param port: remote port on the DUT.
1130
1131 """
1132 self.remove_forwarding('tcp:%s' % port)
xixuan6cf6d2f2016-01-29 15:29:00 -08001133 super(ADBHost, self).disconnect_ssh_tunnel(tunnel_proc, port)
Dan Shi6ea3e1c2015-10-28 15:19:04 -07001134
1135
1136 def ensure_bootloader_mode(self):
Kevin Chengd19e6c62015-10-28 16:39:39 -07001137 """Ensure the device is in bootloader mode.
Dan Shi6ea3e1c2015-10-28 15:19:04 -07001138
1139 @raise: error.AutoservError if the device failed to reboot into
1140 bootloader mode.
1141 """
1142 if self.is_up(command=FASTBOOT_CMD):
1143 return
1144 self.adb_run('reboot bootloader')
1145 if not self.wait_up(command=FASTBOOT_CMD):
1146 raise error.AutoservError(
1147 'The device failed to reboot into bootloader mode.')
1148
1149
Dan Shie4e807b2015-12-10 09:04:03 -08001150 def ensure_adb_mode(self, timeout=DEFAULT_WAIT_UP_TIME_SECONDS):
Dan Shi6ea3e1c2015-10-28 15:19:04 -07001151 """Ensure the device is up and can be accessed by adb command.
1152
Dan Shie4e807b2015-12-10 09:04:03 -08001153 @param timeout: Time limit in seconds before returning even if the host
1154 is not up.
1155
Dan Shi6ea3e1c2015-10-28 15:19:04 -07001156 @raise: error.AutoservError if the device failed to reboot into
1157 adb mode.
1158 """
1159 if self.is_up():
1160 return
Dan Shi04980372016-03-22 10:57:47 -07001161 # Ignore timeout error to allow `fastboot reboot` to fail quietly and
1162 # check if the device is in adb mode.
1163 self.fastboot_run('reboot', timeout=timeout, ignore_timeout=True)
Dan Shie4e807b2015-12-10 09:04:03 -08001164 if not self.wait_up(timeout=timeout):
Dan Shi6ea3e1c2015-10-28 15:19:04 -07001165 raise error.AutoservError(
1166 'The device failed to reboot into adb mode.')
Roshan Pius4d7540c2015-12-16 13:30:32 -08001167 self._reset_adbd_connection()
Dan Shia2872172015-10-31 01:16:51 -07001168
1169
1170 @classmethod
Dan Shi08ff1282016-02-18 19:51:16 -08001171 def get_build_info_from_build_url(cls, build_url):
Dan Shia2872172015-10-31 01:16:51 -07001172 """Get the Android build information from the build url.
1173
1174 @param build_url: The url to use for downloading Android artifacts.
1175 pattern: http://$devserver:###/static/branch/target/build_id
1176
Dan Shi6450e142016-03-11 11:52:20 -08001177 @return: A dictionary of build information, including keys:
1178 build_target, branch, target, build_id.
Dan Shiab999722015-12-04 14:27:08 -08001179 @raise AndroidInstallError: If failed to parse build_url.
Dan Shia2872172015-10-31 01:16:51 -07001180 """
Dan Shiab999722015-12-04 14:27:08 -08001181 if not build_url:
1182 raise AndroidInstallError('Need build_url to download image files.')
1183
1184 try:
1185 match = re.match(DEVSERVER_URL_REGEX, build_url)
Dan Shi6450e142016-03-11 11:52:20 -08001186 return {'build_target': match.group('BUILD_TARGET'),
Dan Shiab999722015-12-04 14:27:08 -08001187 'branch': match.group('BRANCH'),
Dan Shi6450e142016-03-11 11:52:20 -08001188 'target': ('%s-%s' % (match.group('BUILD_TARGET'),
Dan Shiab999722015-12-04 14:27:08 -08001189 match.group('BUILD_TYPE'))),
1190 'build_id': match.group('BUILD_ID')}
1191 except (AttributeError, IndexError, ValueError) as e:
1192 raise AndroidInstallError(
1193 'Failed to parse build url: %s\nError: %s' % (build_url, e))
Dan Shia2872172015-10-31 01:16:51 -07001194
1195
Dan Shia2872172015-10-31 01:16:51 -07001196 @retry.retry(error.AutoservRunError, timeout_min=10)
Simran Basi7756a0b2016-03-16 13:10:07 -07001197 def download_file(self, build_url, file, dest_dir, unzip=False,
1198 unzip_dest=None):
Dan Shia2872172015-10-31 01:16:51 -07001199 """Download the given file from the build url.
1200
1201 @param build_url: The url to use for downloading Android artifacts.
1202 pattern: http://$devserver:###/static/branch/target/build_id
1203 @param file: Name of the file to be downloaded, e.g., boot.img.
1204 @param dest_dir: Destination folder for the file to be downloaded to.
Simran Basi7756a0b2016-03-16 13:10:07 -07001205 @param unzip: If True, unzip the downloaded file.
1206 @param unzip_dest: Location to unzip the downloaded file to. If not
1207 provided, dest_dir is used.
Dan Shia2872172015-10-31 01:16:51 -07001208 """
Dan Shidb0366c2016-02-19 10:36:18 -08001209 # Append the file name to the url if build_url is linked to the folder
1210 # containing the file.
1211 if not build_url.endswith('/%s' % file):
1212 src_url = os.path.join(build_url, file)
1213 else:
1214 src_url = build_url
Dan Shia2872172015-10-31 01:16:51 -07001215 dest_file = os.path.join(dest_dir, file)
1216 try:
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -04001217 self.teststation.run('wget -q -O "%s" "%s"' % (dest_file, src_url))
Simran Basi7756a0b2016-03-16 13:10:07 -07001218 if unzip:
1219 unzip_dest = unzip_dest or dest_dir
1220 self.teststation.run('unzip "%s/%s" -x -d "%s"' %
1221 (dest_dir, file, unzip_dest))
Dan Shia2872172015-10-31 01:16:51 -07001222 except:
1223 # Delete the destination file if download failed.
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -04001224 self.teststation.run('rm -f "%s"' % dest_file)
Dan Shia2872172015-10-31 01:16:51 -07001225 raise
1226
1227
Dan Shiab999722015-12-04 14:27:08 -08001228 def stage_android_image_files(self, build_url):
Dan Shia2872172015-10-31 01:16:51 -07001229 """Download required image files from the given build_url to a local
1230 directory in the machine runs fastboot command.
1231
1232 @param build_url: The url to use for downloading Android artifacts.
1233 pattern: http://$devserver:###/static/branch/target/build_id
1234
1235 @return: Path to the directory contains image files.
1236 """
Dan Shi08ff1282016-02-18 19:51:16 -08001237 build_info = self.get_build_info_from_build_url(build_url)
Dan Shia2872172015-10-31 01:16:51 -07001238
1239 zipped_image_file = ANDROID_IMAGE_FILE_FMT % build_info
Kevin Cheng85e864a2015-11-30 11:49:34 -08001240 image_dir = self.teststation.get_tmp_dir()
Dan Shia2872172015-10-31 01:16:51 -07001241
1242 try:
Simran Basi7756a0b2016-03-16 13:10:07 -07001243 self.download_file(build_url, zipped_image_file, image_dir,
1244 unzip=True)
Dan Shi49d451f2016-04-19 09:25:01 -07001245 images = android_utils.AndroidImageFiles.get_standalone_images(
1246 build_info['build_target'])
1247 for image_file in images:
Dan Shidb0366c2016-02-19 10:36:18 -08001248 self.download_file(build_url, image_file, image_dir)
Dan Shia2872172015-10-31 01:16:51 -07001249
Dan Shia2872172015-10-31 01:16:51 -07001250 return image_dir
1251 except:
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -04001252 self.teststation.run('rm -rf %s' % image_dir)
Dan Shia2872172015-10-31 01:16:51 -07001253 raise
1254
1255
Dan Shiab999722015-12-04 14:27:08 -08001256 def stage_brillo_image_files(self, build_url):
1257 """Download required brillo image files from the given build_url to a
1258 local directory in the machine runs fastboot command.
1259
1260 @param build_url: The url to use for downloading Android artifacts.
1261 pattern: http://$devserver:###/static/branch/target/build_id
1262
1263 @return: Path to the directory contains image files.
1264 """
Dan Shi08ff1282016-02-18 19:51:16 -08001265 build_info = self.get_build_info_from_build_url(build_url)
Dan Shiab999722015-12-04 14:27:08 -08001266
1267 zipped_image_file = ANDROID_IMAGE_FILE_FMT % build_info
1268 vendor_partitions_file = BRILLO_VENDOR_PARTITIONS_FILE_FMT % build_info
1269 image_dir = self.teststation.get_tmp_dir()
Dan Shiab999722015-12-04 14:27:08 -08001270
1271 try:
Simran Basi7756a0b2016-03-16 13:10:07 -07001272 self.download_file(build_url, zipped_image_file, image_dir,
1273 unzip=True)
1274 self.download_file(build_url, vendor_partitions_file, image_dir,
1275 unzip=True,
1276 unzip_dest=os.path.join(image_dir, 'vendor'))
Dan Shiab999722015-12-04 14:27:08 -08001277 return image_dir
1278 except:
1279 self.teststation.run('rm -rf %s' % image_dir)
1280 raise
1281
1282
Simran Basibeb2bb22016-02-03 15:25:48 -08001283 def stage_build_for_install(self, build_name, os_type=None):
Dan Shi225b9042015-11-18 10:25:21 -08001284 """Stage a build on a devserver and return the build_url and devserver.
1285
1286 @param build_name: a name like git-master/shamu-userdebug/2040953
Dan Shiab999722015-12-04 14:27:08 -08001287
Dan Shi225b9042015-11-18 10:25:21 -08001288 @returns a tuple with an update URL like:
1289 http://172.22.50.122:8080/git-master/shamu-userdebug/2040953
1290 and the devserver instance.
1291 """
Simran Basibeb2bb22016-02-03 15:25:48 -08001292 os_type = os_type or self.get_os_type()
Dan Shi225b9042015-11-18 10:25:21 -08001293 logging.info('Staging build for installation: %s', build_name)
Dan Shi216389c2015-12-22 11:03:06 -08001294 devserver = dev_server.AndroidBuildServer.resolve(build_name,
1295 self.hostname)
Dan Shiba943532015-12-03 08:58:00 -08001296 build_name = devserver.translate(build_name)
Dan Shi6450e142016-03-11 11:52:20 -08001297 branch, target, build_id = utils.parse_launch_control_build(build_name)
Simran Basibeb2bb22016-02-03 15:25:48 -08001298 is_brillo = os_type == OS_TYPE_BRILLO
Dan Shi08ff1282016-02-18 19:51:16 -08001299 devserver.trigger_download(target, build_id, branch,
1300 is_brillo=is_brillo, synchronous=False)
Dan Shif2fd0762015-12-01 10:09:32 -08001301 return '%s/static/%s' % (devserver.url(), build_name), devserver
Dan Shi225b9042015-11-18 10:25:21 -08001302
1303
Dan Shie4e807b2015-12-10 09:04:03 -08001304 def install_android(self, build_url, build_local_path=None, wipe=True,
Dan Shia2872172015-10-31 01:16:51 -07001305 flash_all=False):
Dan Shiab999722015-12-04 14:27:08 -08001306 """Install the Android DUT.
Dan Shia2872172015-10-31 01:16:51 -07001307
1308 Following are the steps used here to provision an android device:
1309 1. If build_local_path is not set, download the image zip file, e.g.,
1310 shamu-img-2284311.zip, unzip it.
1311 2. Run fastboot to install following artifacts:
1312 bootloader, radio, boot, system, vendor(only if exists)
1313
1314 Repair is not supported for Android devices yet.
1315
1316 @param build_url: The url to use for downloading Android artifacts.
1317 pattern: http://$devserver:###/static/$build
1318 @param build_local_path: The path to a local folder that contains the
1319 image files needed to provision the device. Note that the folder
1320 is in the machine running adb command, rather than the drone.
1321 @param wipe: If true, userdata will be wiped before flashing.
1322 @param flash_all: If True, all img files found in img_path will be
1323 flashed. Otherwise, only boot and system are flashed.
1324
1325 @raises AndroidInstallError if any error occurs.
1326 """
Dan Shia2872172015-10-31 01:16:51 -07001327 # If the build is not staged in local server yet, clean up the temp
1328 # folder used to store image files after the provision is completed.
1329 delete_build_folder = bool(not build_local_path)
1330
1331 try:
1332 # Download image files needed for provision to a local directory.
1333 if not build_local_path:
Dan Shiab999722015-12-04 14:27:08 -08001334 build_local_path = self.stage_android_image_files(build_url)
Dan Shia2872172015-10-31 01:16:51 -07001335
1336 # Device needs to be in bootloader mode for flashing.
1337 self.ensure_bootloader_mode()
1338
1339 if wipe:
Dan Shi12a4f662016-05-10 14:49:42 -07001340 self._fastboot_run_with_retry('-w')
Dan Shia2872172015-10-31 01:16:51 -07001341
1342 # Get all *.img file in the build_local_path.
1343 list_file_cmd = 'ls -d %s' % os.path.join(build_local_path, '*.img')
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -04001344 image_files = self.teststation.run(
1345 list_file_cmd).stdout.strip().split()
Dan Shia2872172015-10-31 01:16:51 -07001346 images = dict([(os.path.basename(f), f) for f in image_files])
Dan Shi49d451f2016-04-19 09:25:01 -07001347 build_info = self.get_build_info_from_build_url(build_url)
1348 board = build_info['build_target']
1349 all_images = (
1350 android_utils.AndroidImageFiles.get_standalone_images(board)
1351 + android_utils.AndroidImageFiles.get_zipped_images(board))
1352
1353 # Sort images to be flashed, bootloader needs to be the first one.
1354 bootloader = android_utils.AndroidImageFiles.BOOTLOADER
1355 sorted_images = sorted(
1356 images.items(),
1357 key=lambda pair: 0 if pair[0] == bootloader else 1)
1358 for image, image_file in sorted_images:
1359 if image not in all_images:
Dan Shia2872172015-10-31 01:16:51 -07001360 continue
1361 logging.info('Flashing %s...', image_file)
Dan Shi12a4f662016-05-10 14:49:42 -07001362 self._fastboot_run_with_retry('-S 256M flash %s %s' %
1363 (image[:-4], image_file))
Dan Shi49d451f2016-04-19 09:25:01 -07001364 if image == android_utils.AndroidImageFiles.BOOTLOADER:
Dan Shia2872172015-10-31 01:16:51 -07001365 self.fastboot_run('reboot-bootloader')
1366 self.wait_up(command=FASTBOOT_CMD)
1367 except Exception as e:
1368 logging.error('Install Android build failed with error: %s', e)
1369 # Re-raise the exception with type of AndroidInstallError.
1370 raise AndroidInstallError, sys.exc_info()[1], sys.exc_info()[2]
1371 finally:
1372 if delete_build_folder:
Kevin Cheng5f6ed6a2015-10-28 16:18:12 -04001373 self.teststation.run('rm -rf %s' % build_local_path)
Dan Shie4e807b2015-12-10 09:04:03 -08001374 timeout = (WAIT_UP_AFTER_WIPE_TIME_SECONDS if wipe else
1375 DEFAULT_WAIT_UP_TIME_SECONDS)
1376 self.ensure_adb_mode(timeout=timeout)
Dan Shia2872172015-10-31 01:16:51 -07001377 logging.info('Successfully installed Android build staged at %s.',
1378 build_url)
1379
1380
Dan Shiab999722015-12-04 14:27:08 -08001381 def install_brillo(self, build_url, build_local_path=None):
1382 """Install the Brillo DUT.
1383
1384 Following are the steps used here to provision an android device:
1385 1. If build_local_path is not set, download the image zip file, e.g.,
1386 dragonboard-img-123456.zip, unzip it. And download the vendor
1387 partition zip file, e.g., dragonboard-vendor_partitions-123456.zip,
1388 unzip it to vendor folder.
1389 2. Run provision_device script to install OS images and vendor
1390 partitions.
1391
1392 @param build_url: The url to use for downloading Android artifacts.
1393 pattern: http://$devserver:###/static/$build
1394 @param build_local_path: The path to a local folder that contains the
1395 image files needed to provision the device. Note that the folder
1396 is in the machine running adb command, rather than the drone.
1397
1398 @raises AndroidInstallError if any error occurs.
1399 """
1400 # If the build is not staged in local server yet, clean up the temp
1401 # folder used to store image files after the provision is completed.
1402 delete_build_folder = bool(not build_local_path)
1403
Dan Shiab999722015-12-04 14:27:08 -08001404 try:
1405 # Download image files needed for provision to a local directory.
1406 if not build_local_path:
1407 build_local_path = self.stage_brillo_image_files(build_url)
1408
1409 # Device needs to be in bootloader mode for flashing.
1410 self.ensure_bootloader_mode()
1411
1412 # Run provision_device command to install image files and vendor
1413 # partitions.
1414 vendor_partition_dir = os.path.join(build_local_path, 'vendor')
1415 cmd = (BRILLO_PROVISION_CMD %
1416 {'os_image_dir': build_local_path,
1417 'vendor_partition_dir': vendor_partition_dir})
Dan Shi86bd8c02016-03-10 09:21:51 -08001418 if self.fastboot_serial:
Dan Shi91b42352016-03-10 22:12:22 -08001419 cmd += ' -s %s ' % self.fastboot_serial
Dan Shiab999722015-12-04 14:27:08 -08001420 self.teststation.run(cmd)
1421 except Exception as e:
1422 logging.error('Install Brillo build failed with error: %s', e)
1423 # Re-raise the exception with type of AndroidInstallError.
1424 raise AndroidInstallError, sys.exc_info()[1], sys.exc_info()[2]
1425 finally:
1426 if delete_build_folder:
1427 self.teststation.run('rm -rf %s' % build_local_path)
1428 self.ensure_adb_mode()
1429 logging.info('Successfully installed Android build staged at %s.',
1430 build_url)
1431
1432
Dan Shibe3636a2016-02-14 22:48:01 -08001433 @property
1434 def job_repo_url_attribute(self):
1435 """Get the host attribute name for job_repo_url, which should append the
1436 adb serial.
1437 """
1438 return '%s_%s' % (constants.JOB_REPO_URL, self.adb_serial)
1439
1440
Dan Shie4e807b2015-12-10 09:04:03 -08001441 def machine_install(self, build_url=None, build_local_path=None, wipe=True,
Simran Basibeb2bb22016-02-03 15:25:48 -08001442 flash_all=False, os_type=None):
Dan Shia2872172015-10-31 01:16:51 -07001443 """Install the DUT.
1444
1445 @param build_url: The url to use for downloading Android artifacts.
Dan Shi225b9042015-11-18 10:25:21 -08001446 pattern: http://$devserver:###/static/$build. If build_url is
1447 set to None, the code may try _parser.options.image to do the
1448 installation. If none of them is set, machine_install will fail.
Dan Shia2872172015-10-31 01:16:51 -07001449 @param build_local_path: The path to a local directory that contains the
1450 image files needed to provision the device.
1451 @param wipe: If true, userdata will be wiped before flashing.
1452 @param flash_all: If True, all img files found in img_path will be
1453 flashed. Otherwise, only boot and system are flashed.
Simran Basi5ace6f22016-01-06 17:30:44 -08001454
Dan Shibe3636a2016-02-14 22:48:01 -08001455 @returns A tuple of (image_name, host_attributes).
1456 image_name is the name of image installed, e.g.,
1457 git_mnc-release/shamu-userdebug/1234
1458 host_attributes is a dictionary of (attribute, value), which
1459 can be saved to afe_host_attributes table in database. This
1460 method returns a dictionary with a single entry of
1461 `job_repo_url_[adb_serial]`: devserver_url, where devserver_url
1462 is a url to the build staged on devserver.
Dan Shia2872172015-10-31 01:16:51 -07001463 """
Simran Basibeb2bb22016-02-03 15:25:48 -08001464 os_type = os_type or self.get_os_type()
Simran Basi5ace6f22016-01-06 17:30:44 -08001465 if not build_url and self._parser.options.image:
1466 build_url, _ = self.stage_build_for_install(
Simran Basibeb2bb22016-02-03 15:25:48 -08001467 self._parser.options.image, os_type=os_type)
1468 if os_type == OS_TYPE_ANDROID:
Dan Shia2872172015-10-31 01:16:51 -07001469 self.install_android(
1470 build_url=build_url, build_local_path=build_local_path,
1471 wipe=wipe, flash_all=flash_all)
Simran Basibeb2bb22016-02-03 15:25:48 -08001472 elif os_type == OS_TYPE_BRILLO:
Dan Shiab999722015-12-04 14:27:08 -08001473 self.install_brillo(
1474 build_url=build_url, build_local_path=build_local_path)
Dan Shia2872172015-10-31 01:16:51 -07001475 else:
1476 raise error.InstallError(
1477 'Installation of os type %s is not supported.' %
1478 self.get_os_type())
Dan Shibe3636a2016-02-14 22:48:01 -08001479 return (build_url.split('static/')[-1],
1480 {self.job_repo_url_attribute: build_url})
Kevin Chengd19e6c62015-10-28 16:39:39 -07001481
1482
1483 def list_files_glob(self, path_glob):
1484 """Get a list of files on the device given glob pattern path.
1485
1486 @param path_glob: The path glob that we want to return the list of
1487 files that match the glob. Relative paths will not work as
1488 expected. Supply an absolute path to get the list of files
1489 you're hoping for.
1490
1491 @returns List of files that match the path_glob.
1492 """
1493 # This is just in case path_glob has no path separator.
1494 base_path = os.path.dirname(path_glob) or '.'
1495 result = self.run('find %s -path \'%s\' -print' %
Christopher Wileyd21d66a2016-03-01 10:58:13 -08001496 (base_path, path_glob), ignore_status=True)
Kevin Chengd19e6c62015-10-28 16:39:39 -07001497 if result.exit_status != 0:
1498 return []
1499 return result.stdout.splitlines()
Kevin Cheng31355942016-01-05 14:23:35 -08001500
1501
Dan Shic716ac62016-05-24 16:47:57 -07001502 @retry.retry(error.AutoservRunError, timeout_min=APK_INSTALL_TIMEOUT_MIN)
Dan Shida995002016-04-25 23:12:58 -07001503 def install_apk(self, apk, force_reinstall=True):
Kevin Cheng31355942016-01-05 14:23:35 -08001504 """Install the specified apk.
1505
1506 This will install the apk and override it if it's already installed and
1507 will also allow for downgraded apks.
1508
1509 @param apk: The path to apk file.
Dan Shidb0366c2016-02-19 10:36:18 -08001510 @param force_reinstall: True to reinstall the apk even if it's already
Dan Shida995002016-04-25 23:12:58 -07001511 installed. Default is set to True.
Dan Shidb0366c2016-02-19 10:36:18 -08001512
1513 @returns a CMDResult object.
Kevin Cheng31355942016-01-05 14:23:35 -08001514 """
Dan Shic716ac62016-05-24 16:47:57 -07001515 try:
1516 client_utils.poll_for_condition(
1517 lambda: self.run('pm list packages',
1518 ignore_status=True).exit_status == 0,
1519 timeout=120)
1520 client_utils.poll_for_condition(
1521 lambda: self.run('service list | grep mount',
1522 ignore_status=True).exit_status == 0,
1523 timeout=120)
1524 return self.adb_run('install %s -d %s' %
1525 ('-r' if force_reinstall else '', apk))
1526 except error.AutoservRunError:
1527 self.reboot()
1528 raise
Dan Shidb0366c2016-02-19 10:36:18 -08001529
1530
1531 @retry.retry(error.AutoservRunError, timeout_min=0.2)
1532 def _confirm_apk_installed(self, package_name):
1533 """Confirm if apk is already installed with the given name.
1534
1535 `pm list packages` command is not reliable some time. The retry helps to
1536 reduce the chance of false negative.
1537
1538 @param package_name: Name of the package, e.g., com.android.phone.
1539
1540 @raise AutoservRunError: If the package is not found or pm list command
1541 failed for any reason.
1542 """
1543 name = 'package:%s' % package_name
1544 self.adb_run('shell pm list packages | grep -w "%s"' % name)
1545
1546
1547 def is_apk_installed(self, package_name):
1548 """Check if apk is already installed with the given name.
1549
1550 @param package_name: Name of the package, e.g., com.android.phone.
1551
1552 @return: True if package is installed. False otherwise.
1553 """
1554 try:
1555 self._confirm_apk_installed(package_name)
1556 return True
1557 except:
1558 return False
Dan Shibe3636a2016-02-14 22:48:01 -08001559
1560
1561 def get_attributes_to_clear_before_provision(self):
1562 """Get a list of attributes to be cleared before machine_install starts.
1563 """
1564 return [self.job_repo_url_attribute]
Kevin Chengc6a645a2015-12-18 11:15:10 -08001565
1566
1567 def get_labels(self):
1568 """Return a list of the labels gathered from the devices connected.
1569
1570 @return: A list of strings that denote the labels from all the devices
1571 connected.
1572 """
1573 return self.labels.get_labels(self)
1574
1575
1576 def update_labels(self):
1577 """Update the labels for this testbed."""
1578 self.labels.update_labels(self)
Dan Shi6450e142016-03-11 11:52:20 -08001579
1580
1581 def stage_server_side_package(self, image=None):
1582 """Stage autotest server-side package on devserver.
1583
1584 @param image: A build name, e.g., git_mnc_dev/shamu-eng/123
1585
1586 @return: A url to the autotest server-side package. Return None if
1587 server-side package is not supported.
1588 @raise: error.AutoservError if fail to locate the build to test with.
1589 """
1590 if image:
1591 ds = dev_server.AndroidBuildServer.resolve(image, self.hostname)
1592 else:
1593 job_repo_url = afe_utils.get_host_attribute(
1594 self, self.job_repo_url_attribute)
1595 if job_repo_url:
1596 devserver_url, image = (
1597 tools.get_devserver_build_from_package_url(
1598 job_repo_url, True))
1599 ds = dev_server.AndroidBuildServer(devserver_url)
1600 else:
1601 labels = afe_utils.get_labels(self, self.VERSION_PREFIX)
1602 if not labels:
1603 raise error.AutoservError(
1604 'Failed to stage server-side package. The host has '
1605 'no job_report_url attribute or version label.')
1606 image = labels[0].name[len(self.VERSION_PREFIX)+1:]
1607 ds = dev_server.AndroidBuildServer.resolve(image, self.hostname)
1608
1609 branch, target, build_id = utils.parse_launch_control_build(image)
1610 build_target, _ = utils.parse_launch_control_target(target)
1611
1612 # For any build older than MIN_VERSION_SUPPORT_SSP, server side
1613 # packaging is not supported.
1614 try:
1615 if int(build_id) < self.MIN_VERSION_SUPPORT_SSP:
1616 logging.warn('Build %s is older than %s. Server side packaging '
1617 'is disabled.', image,
1618 self.MIN_VERSION_SUPPORT_SSP)
1619 return None
1620 except ValueError:
1621 logging.warn('Failed to compare build id in %s with the minimum '
1622 'version that supports server side packaging. Server '
1623 'side packaging is disabled.', image)
1624 return None
1625
1626 ds.stage_artifacts(target, build_id, branch,
1627 artifacts=['autotest_server_package'])
1628 autotest_server_package_name = (AUTOTEST_SERVER_PACKAGE_FILE_FMT %
1629 {'build_target': build_target,
1630 'build_id': build_id})
1631 return '%s/static/%s/%s' % (ds.url(), image,
1632 autotest_server_package_name)
Bryan Lewandowski0f3f0112016-05-27 15:17:19 -07001633
1634
1635 def _sync_time(self):
1636 """Approximate synchronization of time between host and ADB device.
1637
1638 This sets the ADB/Android device's clock to approximately the same
1639 time as the Autotest host for the purposes of comparing Android system
1640 logs such as logcat to logs from the Autotest host system.
1641 """
1642 command = 'date '
1643 sdk_version = int(self.run('getprop %s' % SDK_FILE).stdout)
1644 if sdk_version < 23:
1645 # Android L and earlier use this format: date -s (format).
1646 command += ('-s %s' %
1647 datetime.datetime.now().strftime('%Y%m%d.%H%M%S'))
1648 else:
1649 # Android M and later use this format: date (format).
1650 command += datetime.datetime.now().strftime('%m%d%H%M%Y.%S')
1651 self.run(command)