blob: 9833254f23f164711c0868796e6d6d615a7890f8 [file] [log] [blame]
Ryan Cui3045c5d2012-07-13 18:00:33 -07001# Copyright (c) 2012 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.
4
Steve Funge984a532013-11-25 17:09:25 -08005"""Script that deploys a Chrome build to a device.
Ryan Cuia56a71e2012-10-18 18:40:35 -07006
7The script supports deploying Chrome from these sources:
8
91. A local build output directory, such as chromium/src/out/[Debug|Release].
102. A Chrome tarball uploaded by a trybot/official-builder to GoogleStorage.
113. A Chrome tarball existing locally.
12
13The script copies the necessary contents of the source location (tarball or
14build directory) and rsyncs the contents of the staging directory onto your
15device's rootfs.
16"""
Ryan Cui3045c5d2012-07-13 18:00:33 -070017
Mike Frysinger383367e2014-09-16 15:06:17 -040018from __future__ import print_function
19
Mike Frysingerc3061a62015-06-04 04:16:18 -040020import argparse
Ryan Cui7193a7e2013-04-26 14:15:19 -070021import collections
Ryan Cuif890a3e2013-03-07 18:57:06 -080022import contextlib
Ryan Cui7193a7e2013-04-26 14:15:19 -070023import functools
Steve Funge984a532013-11-25 17:09:25 -080024import glob
David James88e6f032013-03-02 08:13:20 -080025import multiprocessing
Ryan Cui3045c5d2012-07-13 18:00:33 -070026import os
Ryan Cui5b7c2ed2013-03-18 18:45:46 -070027import shlex
Steve Funge984a532013-11-25 17:09:25 -080028import shutil
Ryan Cui3045c5d2012-07-13 18:00:33 -070029import time
Ryan Cui3045c5d2012-07-13 18:00:33 -070030
Aviv Keshetb7519e12016-10-04 00:50:00 -070031from chromite.lib import constants
32from chromite.lib import failures_lib
David Pursellcfd58872015-03-19 09:15:48 -070033from chromite.cli.cros import cros_chrome_sdk
Ryan Cuia56a71e2012-10-18 18:40:35 -070034from chromite.lib import chrome_util
Ryan Cuie535b172012-10-19 18:25:03 -070035from chromite.lib import commandline
Ralph Nathan91874ca2015-03-19 13:29:41 -070036from chromite.lib import cros_build_lib
37from chromite.lib import cros_logging as logging
Ryan Cui777ff422012-12-07 13:12:54 -080038from chromite.lib import gs
Ryan Cui3045c5d2012-07-13 18:00:33 -070039from chromite.lib import osutils
David James88e6f032013-03-02 08:13:20 -080040from chromite.lib import parallel
Ryan Cui3045c5d2012-07-13 18:00:33 -070041from chromite.lib import remote_access as remote
David James3432acd2013-11-27 10:02:18 -080042from chromite.lib import timeout_util
Steven Bennetts368c3e52016-09-23 13:05:21 -070043from gn_helpers import gn_helpers
Ryan Cui3045c5d2012-07-13 18:00:33 -070044
45
Ryan Cui3045c5d2012-07-13 18:00:33 -070046KERNEL_A_PARTITION = 2
47KERNEL_B_PARTITION = 4
48
49KILL_PROC_MAX_WAIT = 10
50POST_KILL_WAIT = 2
51
Ryan Cuie535b172012-10-19 18:25:03 -070052MOUNT_RW_COMMAND = 'mount -o remount,rw /'
Pawel Osciak577773a2013-03-05 10:52:12 -080053LSOF_COMMAND = 'lsof %s/chrome'
Ryan Cui3045c5d2012-07-13 18:00:33 -070054
Steve Funge984a532013-11-25 17:09:25 -080055_ANDROID_DIR = '/system/chrome'
56_ANDROID_DIR_EXTRACT_PATH = 'system/chrome/*'
57
David James2cb34002013-03-01 18:42:40 -080058_CHROME_DIR = '/opt/google/chrome'
Thiago Goncales12793312013-05-23 11:26:17 -070059_CHROME_DIR_MOUNT = '/mnt/stateful_partition/deploy_rootfs/opt/google/chrome'
David James2cb34002013-03-01 18:42:40 -080060
Pawel Osciakc1bb2742014-12-29 16:32:33 +090061_UMOUNT_DIR_IF_MOUNTPOINT_CMD = (
62 'if mountpoint -q %(dir)s; then umount %(dir)s; fi')
Thiago Goncales12793312013-05-23 11:26:17 -070063_BIND_TO_FINAL_DIR_CMD = 'mount --rbind %s %s'
64_SET_MOUNT_FLAGS_CMD = 'mount -o remount,exec,suid %s'
Ryan Cui3045c5d2012-07-13 18:00:33 -070065
Steve Funge984a532013-11-25 17:09:25 -080066DF_COMMAND = 'df -k %s'
Steve Funge984a532013-11-25 17:09:25 -080067
Mike Frysingere65f3752014-12-08 00:46:39 -050068
Ryan Cui3045c5d2012-07-13 18:00:33 -070069def _UrlBaseName(url):
70 """Return the last component of the URL."""
71 return url.rstrip('/').rpartition('/')[-1]
72
73
Yu-Ju Hongc54d3342014-05-14 12:42:06 -070074class DeployFailure(failures_lib.StepFailure):
David James88e6f032013-03-02 08:13:20 -080075 """Raised whenever the deploy fails."""
76
77
Ryan Cui7193a7e2013-04-26 14:15:19 -070078DeviceInfo = collections.namedtuple(
79 'DeviceInfo', ['target_dir_size', 'target_fs_free'])
80
81
Ryan Cui3045c5d2012-07-13 18:00:33 -070082class DeployChrome(object):
83 """Wraps the core deployment functionality."""
Mike Frysingere65f3752014-12-08 00:46:39 -050084
Ryan Cuia56a71e2012-10-18 18:40:35 -070085 def __init__(self, options, tempdir, staging_dir):
Ryan Cuie535b172012-10-19 18:25:03 -070086 """Initialize the class.
87
Mike Frysinger02e1e072013-11-10 22:11:34 -050088 Args:
Mike Frysingerc3061a62015-06-04 04:16:18 -040089 options: options object.
Ryan Cuie535b172012-10-19 18:25:03 -070090 tempdir: Scratch space for the class. Caller has responsibility to clean
91 it up.
Steve Funge984a532013-11-25 17:09:25 -080092 staging_dir: Directory to stage the files to.
Ryan Cuie535b172012-10-19 18:25:03 -070093 """
Ryan Cui3045c5d2012-07-13 18:00:33 -070094 self.tempdir = tempdir
95 self.options = options
Ryan Cuia56a71e2012-10-18 18:40:35 -070096 self.staging_dir = staging_dir
Robert Flack1dc7ea82014-11-26 13:50:24 -050097 if not self.options.staging_only:
Pawel Osciak141b2262014-12-21 10:27:05 +090098 self.device = remote.RemoteDevice(options.to, port=options.port,
99 ping=options.ping)
Robert Flack1dc7ea82014-11-26 13:50:24 -0500100 self._target_dir_is_still_readonly = multiprocessing.Event()
Steven Bennetts5a7c72d2016-10-17 20:04:46 +0000101
Sadrul Habib Chowdhury977aef72016-11-21 16:30:37 -0500102 self.copy_paths = chrome_util.GetCopyPaths('chrome')
Steve Funge984a532013-11-25 17:09:25 -0800103 self.chrome_dir = _CHROME_DIR
104
Ryan Cui7193a7e2013-04-26 14:15:19 -0700105 def _GetRemoteMountFree(self, remote_dir):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500106 result = self.device.RunCommand(DF_COMMAND % remote_dir)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700107 line = result.output.splitlines()[1]
Steve Funge984a532013-11-25 17:09:25 -0800108 value = line.split()[3]
109 multipliers = {
110 'G': 1024 * 1024 * 1024,
111 'M': 1024 * 1024,
112 'K': 1024,
113 }
114 return int(value.rstrip('GMK')) * multipliers.get(value[-1], 1)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700115
116 def _GetRemoteDirSize(self, remote_dir):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500117 result = self.device.RunCommand('du -ks %s' % remote_dir,
118 capture_output=True)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700119 return int(result.output.split()[0])
120
121 def _GetStagingDirSize(self):
122 result = cros_build_lib.DebugRunCommand(['du', '-ks', self.staging_dir],
Yu-Ju Hong3add4432014-01-30 11:46:15 -0800123 redirect_stdout=True,
124 capture_output=True)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700125 return int(result.output.split()[0])
126
Ryan Cui3045c5d2012-07-13 18:00:33 -0700127 def _ChromeFileInUse(self):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500128 result = self.device.RunCommand(LSOF_COMMAND % (self.options.target_dir,),
129 error_code_ok=True, capture_output=True)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700130 return result.returncode == 0
131
Justin TerAvestfac210e2017-04-13 11:39:00 -0600132 def _Reboot(self):
133 # A reboot in developer mode takes a while (and has delays), so the user
134 # will have time to read and act on the USB boot instructions below.
135 logging.info('Please remember to press Ctrl-U if you are booting from USB.')
136 self.device.Reboot()
137
Ryan Cui3045c5d2012-07-13 18:00:33 -0700138 def _DisableRootfsVerification(self):
139 if not self.options.force:
140 logging.error('Detected that the device has rootfs verification enabled.')
141 logging.info('This script can automatically remove the rootfs '
142 'verification, which requires that it reboot the device.')
143 logging.info('Make sure the device is in developer mode!')
144 logging.info('Skip this prompt by specifying --force.')
Brian Harring521e7242012-11-01 16:57:42 -0700145 if not cros_build_lib.BooleanPrompt('Remove roots verification?', False):
David James88e6f032013-03-02 08:13:20 -0800146 # Since we stopped Chrome earlier, it's good form to start it up again.
147 if self.options.startui:
148 logging.info('Starting Chrome...')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500149 self.device.RunCommand('start ui')
David James88e6f032013-03-02 08:13:20 -0800150 raise DeployFailure('Need rootfs verification to be disabled. '
151 'Aborting.')
Ryan Cui3045c5d2012-07-13 18:00:33 -0700152
153 logging.info('Removing rootfs verification from %s', self.options.to)
154 # Running in VM's cause make_dev_ssd's firmware sanity checks to fail.
155 # Use --force to bypass the checks.
156 cmd = ('/usr/share/vboot/bin/make_dev_ssd.sh --partitions %d '
157 '--remove_rootfs_verification --force')
158 for partition in (KERNEL_A_PARTITION, KERNEL_B_PARTITION):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500159 self.device.RunCommand(cmd % partition, error_code_ok=True)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700160
Justin TerAvestfac210e2017-04-13 11:39:00 -0600161 self._Reboot()
Ryan Cui3045c5d2012-07-13 18:00:33 -0700162
David James88e6f032013-03-02 08:13:20 -0800163 # Now that the machine has been rebooted, we need to kill Chrome again.
164 self._KillProcsIfNeeded()
165
166 # Make sure the rootfs is writable now.
167 self._MountRootfsAsWritable(error_code_ok=False)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700168
169 def _CheckUiJobStarted(self):
170 # status output is in the format:
171 # <job_name> <status> ['process' <pid>].
172 # <status> is in the format <goal>/<state>.
Ryan Cuif2d1a582013-02-19 14:08:13 -0800173 try:
Robert Flack1dc7ea82014-11-26 13:50:24 -0500174 result = self.device.RunCommand('status ui', capture_output=True)
Ryan Cuif2d1a582013-02-19 14:08:13 -0800175 except cros_build_lib.RunCommandError as e:
176 if 'Unknown job' in e.result.error:
177 return False
178 else:
179 raise e
180
Ryan Cui3045c5d2012-07-13 18:00:33 -0700181 return result.output.split()[1].split('/')[0] == 'start'
182
183 def _KillProcsIfNeeded(self):
184 if self._CheckUiJobStarted():
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800185 logging.info('Shutting down Chrome...')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500186 self.device.RunCommand('stop ui')
Ryan Cui3045c5d2012-07-13 18:00:33 -0700187
188 # Developers sometimes run session_manager manually, in which case we'll
189 # need to help shut the chrome processes down.
190 try:
David James3432acd2013-11-27 10:02:18 -0800191 with timeout_util.Timeout(KILL_PROC_MAX_WAIT):
Ryan Cui3045c5d2012-07-13 18:00:33 -0700192 while self._ChromeFileInUse():
193 logging.warning('The chrome binary on the device is in use.')
194 logging.warning('Killing chrome and session_manager processes...\n')
195
Robert Flack1dc7ea82014-11-26 13:50:24 -0500196 self.device.RunCommand("pkill 'chrome|session_manager'",
Mike Frysingere65f3752014-12-08 00:46:39 -0500197 error_code_ok=True)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700198 # Wait for processes to actually terminate
199 time.sleep(POST_KILL_WAIT)
200 logging.info('Rechecking the chrome binary...')
David James3432acd2013-11-27 10:02:18 -0800201 except timeout_util.TimeoutError:
David James88e6f032013-03-02 08:13:20 -0800202 msg = ('Could not kill processes after %s seconds. Please exit any '
203 'running chrome processes and try again.' % KILL_PROC_MAX_WAIT)
204 raise DeployFailure(msg)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700205
David James88e6f032013-03-02 08:13:20 -0800206 def _MountRootfsAsWritable(self, error_code_ok=True):
207 """Mount the rootfs as writable.
Ryan Cui3045c5d2012-07-13 18:00:33 -0700208
Robert Flack1dc7ea82014-11-26 13:50:24 -0500209 If the command fails, and error_code_ok is True, and the target dir is not
210 writable then this function sets self._target_dir_is_still_readonly.
Ryan Cui3045c5d2012-07-13 18:00:33 -0700211
Mike Frysinger02e1e072013-11-10 22:11:34 -0500212 Args:
David James88e6f032013-03-02 08:13:20 -0800213 error_code_ok: See remote.RemoteAccess.RemoteSh for details.
214 """
Yu-Ju Hong7e116ac2014-01-03 17:08:26 -0800215 # TODO: Should migrate to use the remount functions in remote_access.
Robert Flack1dc7ea82014-11-26 13:50:24 -0500216 result = self.device.RunCommand(MOUNT_RW_COMMAND,
217 error_code_ok=error_code_ok,
218 capture_output=True)
219 if (result.returncode and
Mike Frysinger74ccd572015-05-21 21:18:20 -0400220 not self.device.IsDirWritable(self.options.target_dir)):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500221 self._target_dir_is_still_readonly.set()
Ryan Cui3045c5d2012-07-13 18:00:33 -0700222
Ryan Cui7193a7e2013-04-26 14:15:19 -0700223 def _GetDeviceInfo(self):
224 steps = [
225 functools.partial(self._GetRemoteDirSize, self.options.target_dir),
226 functools.partial(self._GetRemoteMountFree, self.options.target_dir)
227 ]
228 return_values = parallel.RunParallelSteps(steps, return_values=True)
229 return DeviceInfo(*return_values)
230
231 def _CheckDeviceFreeSpace(self, device_info):
232 """See if target device has enough space for Chrome.
233
Mike Frysinger02e1e072013-11-10 22:11:34 -0500234 Args:
Ryan Cui7193a7e2013-04-26 14:15:19 -0700235 device_info: A DeviceInfo named tuple.
236 """
237 effective_free = device_info.target_dir_size + device_info.target_fs_free
238 staging_size = self._GetStagingDirSize()
239 if effective_free < staging_size:
Daniel Erat1ae46382014-08-14 10:23:39 -0700240 raise DeployFailure(
241 'Not enough free space on the device. Required: %s MiB, '
242 'actual: %s MiB.' % (staging_size / 1024, effective_free / 1024))
Ryan Cui7193a7e2013-04-26 14:15:19 -0700243 if device_info.target_fs_free < (100 * 1024):
244 logging.warning('The device has less than 100MB free. deploy_chrome may '
245 'hang during the transfer.')
246
Ryan Cui3045c5d2012-07-13 18:00:33 -0700247 def _Deploy(self):
Justin TerAvestfac210e2017-04-13 11:39:00 -0600248 old_dbus_checksums = self._GetDBusChecksums()
249
Pawel Osciak577773a2013-03-05 10:52:12 -0800250 logging.info('Copying Chrome to %s on device...', self.options.target_dir)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700251 # Show the output (status) for this command.
Steve Funge984a532013-11-25 17:09:25 -0800252 dest_path = _CHROME_DIR
Ilja H. Friedel0ab63e12017-03-28 13:29:48 -0700253 # CopyToDevice will fall back to scp if rsync is corrupted on stateful.
254 # This does not work for deploy.
Satoru Takabayashiab380bc2015-01-15 16:00:41 +0900255 if not self.device.HasRsync():
256 raise DeployFailure(
David Pursellcfd58872015-03-19 09:15:48 -0700257 'rsync is not found on the device.\n'
258 'Run dev_install on the device to get rsync installed')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500259 self.device.CopyToDevice('%s/' % os.path.abspath(self.staging_dir),
260 self.options.target_dir,
Steven Bennettsd57a72a2017-03-20 12:54:00 -0700261 mode='rsync', inplace=True,
262 debug_level=logging.INFO,
Robert Flack1dc7ea82014-11-26 13:50:24 -0500263 verbose=self.options.verbose)
Steve Funge984a532013-11-25 17:09:25 -0800264
265 for p in self.copy_paths:
Steve Funge984a532013-11-25 17:09:25 -0800266 if p.mode:
267 # Set mode if necessary.
Robert Flack1dc7ea82014-11-26 13:50:24 -0500268 self.device.RunCommand('chmod %o %s/%s' % (
269 p.mode, dest_path, p.src if not p.dest else p.dest))
Steve Funge984a532013-11-25 17:09:25 -0800270
Justin TerAvestfac210e2017-04-13 11:39:00 -0600271 new_dbus_checksums = self._GetDBusChecksums()
272 if old_dbus_checksums != new_dbus_checksums:
273 logging.info('Detected change to D-Bus service files, rebooting.')
274 self._Reboot()
275 return
276
Ryan Cui82a1f2d2013-02-22 17:34:23 -0800277 if self.options.startui:
Steve Funge984a532013-11-25 17:09:25 -0800278 logging.info('Starting UI...')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500279 self.device.RunCommand('start ui')
Ryan Cui3045c5d2012-07-13 18:00:33 -0700280
David James88e6f032013-03-02 08:13:20 -0800281 def _CheckConnection(self):
Ryan Cui3045c5d2012-07-13 18:00:33 -0700282 try:
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800283 logging.info('Testing connection to the device...')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500284 self.device.RunCommand('true')
David James88e6f032013-03-02 08:13:20 -0800285 except cros_build_lib.RunCommandError as ex:
Ryan Cui3045c5d2012-07-13 18:00:33 -0700286 logging.error('Error connecting to the test device.')
David James88e6f032013-03-02 08:13:20 -0800287 raise DeployFailure(ex)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700288
Steve Funge984a532013-11-25 17:09:25 -0800289 def _CheckDeployType(self):
Steve Fung63d705d2014-03-16 03:14:03 -0700290 if self.options.build_dir:
Daniel Erat3fd6c7a2014-05-02 14:28:31 -0700291 def BinaryExists(filename):
292 """Checks if the passed-in file is present in the build directory."""
293 return os.path.exists(os.path.join(self.options.build_dir, filename))
294
Daniel Erat9813f0e2014-11-12 11:00:28 -0700295 # Handle non-Chrome deployments.
296 if not BinaryExists('chrome'):
Daniel Eratf53bd3a2016-12-02 11:28:36 -0700297 if BinaryExists('app_shell'):
Daniel Erat9813f0e2014-11-12 11:00:28 -0700298 self.copy_paths = chrome_util.GetCopyPaths('app_shell')
299
Daniel Erat3fd6c7a2014-05-02 14:28:31 -0700300 # TODO(derat): Update _Deploy() and remove this after figuring out how
Daniel Eratf53bd3a2016-12-02 11:28:36 -0700301 # app_shell should be executed.
Daniel Erat3fd6c7a2014-05-02 14:28:31 -0700302 self.options.startui = False
303
David James88e6f032013-03-02 08:13:20 -0800304 def _PrepareStagingDir(self):
Steve Funge984a532013-11-25 17:09:25 -0800305 _PrepareStagingDir(self.options, self.tempdir, self.staging_dir,
306 self.copy_paths, self.chrome_dir)
David James88e6f032013-03-02 08:13:20 -0800307
Thiago Goncales12793312013-05-23 11:26:17 -0700308 def _MountTarget(self):
309 logging.info('Mounting Chrome...')
310
311 # Create directory if does not exist
Robert Flack1dc7ea82014-11-26 13:50:24 -0500312 self.device.RunCommand('mkdir -p --mode 0775 %s' % (
Mike Frysingere65f3752014-12-08 00:46:39 -0500313 self.options.mount_dir,))
Pawel Osciakfb200f52014-12-21 13:42:05 +0900314 # Umount the existing mount on mount_dir if present first
315 self.device.RunCommand(_UMOUNT_DIR_IF_MOUNTPOINT_CMD %
316 {'dir': self.options.mount_dir})
Robert Flack1dc7ea82014-11-26 13:50:24 -0500317 self.device.RunCommand(_BIND_TO_FINAL_DIR_CMD % (self.options.target_dir,
318 self.options.mount_dir))
Thiago Goncales12793312013-05-23 11:26:17 -0700319 # Chrome needs partition to have exec and suid flags set
Robert Flack1dc7ea82014-11-26 13:50:24 -0500320 self.device.RunCommand(_SET_MOUNT_FLAGS_CMD % (self.options.mount_dir,))
321
Justin TerAvestfac210e2017-04-13 11:39:00 -0600322 def _GetDBusChecksums(self):
323 """Returns Checksums for D-Bus files deployed with Chrome.
324
325 This is used to determine if a reboot is required after deploying Chrome.
326 """
327 result = self.device.RunCommand('md5sum /opt/google/chrome/dbus/*',
328 error_code_ok=True)
329 return result.output
330
Robert Flack1dc7ea82014-11-26 13:50:24 -0500331 def Cleanup(self):
332 """Clean up RemoteDevice."""
333 if not self.options.staging_only:
334 self.device.Cleanup()
Thiago Goncales12793312013-05-23 11:26:17 -0700335
David James88e6f032013-03-02 08:13:20 -0800336 def Perform(self):
Steve Funge984a532013-11-25 17:09:25 -0800337 self._CheckDeployType()
338
David James88e6f032013-03-02 08:13:20 -0800339 # If requested, just do the staging step.
340 if self.options.staging_only:
341 self._PrepareStagingDir()
342 return 0
343
344 # Run setup steps in parallel. If any step fails, RunParallelSteps will
David James48f6b332013-03-03 20:11:18 -0800345 # stop printing output at that point, and halt any running steps.
Steve Funge984a532013-11-25 17:09:25 -0800346 steps = [self._GetDeviceInfo, self._CheckConnection,
347 self._KillProcsIfNeeded, self._MountRootfsAsWritable,
348 self._PrepareStagingDir]
Ryan Cui7193a7e2013-04-26 14:15:19 -0700349 ret = parallel.RunParallelSteps(steps, halt_on_error=True,
350 return_values=True)
351 self._CheckDeviceFreeSpace(ret[0])
David James88e6f032013-03-02 08:13:20 -0800352
Robert Flack1dc7ea82014-11-26 13:50:24 -0500353 # If we're trying to deploy to a dir which is not writable and we failed
354 # to mark the rootfs as writable, try disabling rootfs verification.
355 if self._target_dir_is_still_readonly.is_set():
David James88e6f032013-03-02 08:13:20 -0800356 self._DisableRootfsVerification()
357
Thiago Goncales12793312013-05-23 11:26:17 -0700358 if self.options.mount_dir is not None:
359 self._MountTarget()
360
David James88e6f032013-03-02 08:13:20 -0800361 # Actually deploy Chrome to the device.
Ryan Cui3045c5d2012-07-13 18:00:33 -0700362 self._Deploy()
363
364
Steven Bennettsda8d9f02016-09-23 13:25:45 -0700365def ValidateStagingFlags(value):
366 """Convert formatted string to dictionary."""
367 return chrome_util.ProcessShellFlags(value)
Ryan Cuia56a71e2012-10-18 18:40:35 -0700368
369
Steven Bennetts368c3e52016-09-23 13:05:21 -0700370def ValidateGnArgs(value):
371 """Convert GN_ARGS-formatted string to dictionary."""
372 return gn_helpers.FromGNArgs(value)
373
374
Ryan Cuie535b172012-10-19 18:25:03 -0700375def _CreateParser():
376 """Create our custom parser."""
Mike Frysingerc3061a62015-06-04 04:16:18 -0400377 parser = commandline.ArgumentParser(description=__doc__, caching=True)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700378
Ryan Cuia56a71e2012-10-18 18:40:35 -0700379 # TODO(rcui): Have this use the UI-V2 format of having source and target
380 # device be specified as positional arguments.
Mike Frysingerc3061a62015-06-04 04:16:18 -0400381 parser.add_argument('--force', action='store_true', default=False,
382 help='Skip all prompts (i.e., for disabling of rootfs '
383 'verification). This may result in the target '
384 'machine being rebooted.')
Ryan Cuia0215a72013-02-14 16:20:45 -0800385 sdk_board_env = os.environ.get(cros_chrome_sdk.SDKFetcher.SDK_BOARD_ENV)
Mike Frysingerc3061a62015-06-04 04:16:18 -0400386 parser.add_argument('--board', default=sdk_board_env,
387 help="The board the Chrome build is targeted for. When "
388 "in a 'cros chrome-sdk' shell, defaults to the SDK "
389 "board.")
390 parser.add_argument('--build-dir', type='path',
391 help='The directory with Chrome build artifacts to '
392 'deploy from. Typically of format '
393 '<chrome_root>/out/Debug. When this option is used, '
Steven Bennettsda8d9f02016-09-23 13:25:45 -0700394 'the GN_ARGS environment variable must be set.')
Mike Frysingerc3061a62015-06-04 04:16:18 -0400395 parser.add_argument('--target-dir', type='path',
396 default=None,
397 help='Target directory on device to deploy Chrome into.')
398 parser.add_argument('-g', '--gs-path', type='gs_path',
399 help='GS path that contains the chrome to deploy.')
400 parser.add_argument('--nostartui', action='store_false', dest='startui',
401 default=True,
402 help="Don't restart the ui daemon after deployment.")
403 parser.add_argument('--nostrip', action='store_false', dest='dostrip',
404 default=True,
405 help="Don't strip binaries during deployment. Warning: "
406 'the resulting binaries will be very large!')
407 parser.add_argument('-p', '--port', type=int, default=remote.DEFAULT_SSH_PORT,
408 help='Port of the target device to connect to.')
409 parser.add_argument('-t', '--to',
410 help='The IP address of the CrOS device to deploy to.')
411 parser.add_argument('-v', '--verbose', action='store_true', default=False,
412 help='Show more debug output.')
413 parser.add_argument('--mount-dir', type='path', default=None,
414 help='Deploy Chrome in target directory and bind it '
415 'to the directory specified by this flag.'
416 'Any existing mount on this directory will be '
417 'umounted first.')
418 parser.add_argument('--mount', action='store_true', default=False,
419 help='Deploy Chrome to default target directory and bind '
420 'it to the default mount directory.'
421 'Any existing mount on this directory will be '
422 'umounted first.')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700423
Mike Frysingerc3061a62015-06-04 04:16:18 -0400424 group = parser.add_argument_group('Advanced Options')
425 group.add_argument('-l', '--local-pkg-path', type='path',
426 help='Path to local chrome prebuilt package to deploy.')
427 group.add_argument('--sloppy', action='store_true', default=False,
428 help='Ignore when mandatory artifacts are missing.')
Steven Bennettsda8d9f02016-09-23 13:25:45 -0700429 group.add_argument('--staging-flags', default=None, type=ValidateStagingFlags,
Mike Frysingerc3061a62015-06-04 04:16:18 -0400430 help=('Extra flags to control staging. Valid flags are - '
431 '%s' % ', '.join(chrome_util.STAGING_FLAGS)))
Steven Bennetts46a84c32016-08-12 15:20:46 -0700432 # TODO(stevenjb): Remove --strict entirely once removed from the ebuild.
Mike Frysingerc3061a62015-06-04 04:16:18 -0400433 group.add_argument('--strict', action='store_true', default=False,
Steven Bennetts46a84c32016-08-12 15:20:46 -0700434 help='Deprecated. Default behavior is "strict". Use '
435 '--sloppy to omit warnings for missing optional '
436 'files.')
Mike Frysingerc3061a62015-06-04 04:16:18 -0400437 group.add_argument('--strip-flags', default=None,
438 help="Flags to call the 'strip' binutil tool with. "
439 "Overrides the default arguments.")
440 group.add_argument('--ping', action='store_true', default=False,
441 help='Ping the device before connection attempt.')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700442
Mike Frysingerc3061a62015-06-04 04:16:18 -0400443 group = parser.add_argument_group(
444 'Metadata Overrides (Advanced)',
445 description='Provide all of these overrides in order to remove '
446 'dependencies on metadata.json existence.')
447 group.add_argument('--target-tc', action='store', default=None,
448 help='Override target toolchain name, e.g. '
449 'x86_64-cros-linux-gnu')
450 group.add_argument('--toolchain-url', action='store', default=None,
451 help='Override toolchain url format pattern, e.g. '
452 '2014/04/%%(target)s-2014.04.23.220740.tar.xz')
Aviv Keshet1c986f32014-04-24 13:20:49 -0700453
Steven Bennettsda8d9f02016-09-23 13:25:45 -0700454 # DEPRECATED: --gyp-defines is ignored, but retained for backwards
455 # compatibility. TODO(stevenjb): Remove once eliminated from the ebuild.
456 parser.add_argument('--gyp-defines', default=None, type=ValidateStagingFlags,
Mike Frysingerc3061a62015-06-04 04:16:18 -0400457 help=argparse.SUPPRESS)
Steven Bennetts368c3e52016-09-23 13:05:21 -0700458
459 # GN_ARGS (args.gn) used to build Chrome. Influences which files are staged
460 # when --build-dir is set. Defaults to reading from the GN_ARGS env variable.
461 # CURRENLY IGNORED, ADDED FOR FORWARD COMPATABILITY.
462 parser.add_argument('--gn-args', default=None, type=ValidateGnArgs,
463 help=argparse.SUPPRESS)
464
Ryan Cuia56a71e2012-10-18 18:40:35 -0700465 # Path of an empty directory to stage chrome artifacts to. Defaults to a
466 # temporary directory that is removed when the script finishes. If the path
467 # is specified, then it will not be removed.
Mike Frysingerc3061a62015-06-04 04:16:18 -0400468 parser.add_argument('--staging-dir', type='path', default=None,
469 help=argparse.SUPPRESS)
Ryan Cuia56a71e2012-10-18 18:40:35 -0700470 # Only prepare the staging directory, and skip deploying to the device.
Mike Frysingerc3061a62015-06-04 04:16:18 -0400471 parser.add_argument('--staging-only', action='store_true', default=False,
472 help=argparse.SUPPRESS)
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700473 # Path to a binutil 'strip' tool to strip binaries with. The passed-in path
474 # is used as-is, and not normalized. Used by the Chrome ebuild to skip
475 # fetching the SDK toolchain.
Mike Frysingerc3061a62015-06-04 04:16:18 -0400476 parser.add_argument('--strip-bin', default=None, help=argparse.SUPPRESS)
Ryan Cuie535b172012-10-19 18:25:03 -0700477 return parser
Ryan Cui3045c5d2012-07-13 18:00:33 -0700478
Ryan Cuie535b172012-10-19 18:25:03 -0700479
480def _ParseCommandLine(argv):
481 """Parse args, and run environment-independent checks."""
482 parser = _CreateParser()
Mike Frysingerc3061a62015-06-04 04:16:18 -0400483 options = parser.parse_args(argv)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700484
Ryan Cuia56a71e2012-10-18 18:40:35 -0700485 if not any([options.gs_path, options.local_pkg_path, options.build_dir]):
486 parser.error('Need to specify either --gs-path, --local-pkg-path, or '
Ryan Cuief91e702013-02-04 12:06:36 -0800487 '--build-dir')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700488 if options.build_dir and any([options.gs_path, options.local_pkg_path]):
489 parser.error('Cannot specify both --build_dir and '
490 '--gs-path/--local-pkg-patch')
Ryan Cui686ec052013-02-12 16:39:41 -0800491 if options.build_dir and not options.board:
492 parser.error('--board is required when --build-dir is specified.')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700493 if options.gs_path and options.local_pkg_path:
494 parser.error('Cannot specify both --gs-path and --local-pkg-path')
495 if not (options.staging_only or options.to):
Ryan Cui3045c5d2012-07-13 18:00:33 -0700496 parser.error('Need to specify --to')
Steven Bennetts46a84c32016-08-12 15:20:46 -0700497 if options.staging_flags and not options.build_dir:
498 parser.error('--staging-flags require --build-dir to be set.')
Steven Bennettsda8d9f02016-09-23 13:25:45 -0700499
Steven Bennetts46a84c32016-08-12 15:20:46 -0700500 if options.strict:
501 logging.warning('--strict is deprecated.')
Steven Bennettsda8d9f02016-09-23 13:25:45 -0700502 if options.gyp_defines:
503 logging.warning('--gyp-defines is deprecated.')
Thiago Goncales12793312013-05-23 11:26:17 -0700504
505 if options.mount or options.mount_dir:
506 if not options.target_dir:
507 options.target_dir = _CHROME_DIR_MOUNT
508 else:
509 if not options.target_dir:
510 options.target_dir = _CHROME_DIR
511
512 if options.mount and not options.mount_dir:
513 options.mount_dir = _CHROME_DIR
514
Mike Frysingerc3061a62015-06-04 04:16:18 -0400515 return options
Ryan Cui3045c5d2012-07-13 18:00:33 -0700516
517
Mike Frysingerc3061a62015-06-04 04:16:18 -0400518def _PostParseCheck(options):
Steve Funge984a532013-11-25 17:09:25 -0800519 """Perform some usage validation (after we've parsed the arguments).
Ryan Cui3045c5d2012-07-13 18:00:33 -0700520
521 Args:
Mike Frysinger5fe3f222016-09-01 00:14:16 -0400522 options: The options object returned by the cli parser.
Ryan Cui3045c5d2012-07-13 18:00:33 -0700523 """
Ryan Cuia56a71e2012-10-18 18:40:35 -0700524 if options.local_pkg_path and not os.path.isfile(options.local_pkg_path):
525 cros_build_lib.Die('%s is not a file.', options.local_pkg_path)
526
Steven Bennetts368c3e52016-09-23 13:05:21 -0700527 if not options.gn_args:
528 gn_env = os.getenv('GN_ARGS')
529 if gn_env is not None:
530 options.gn_args = gn_helpers.FromGNArgs(gn_env)
531 logging.info('GN_ARGS taken from environment: %s', options.gn_args)
Ryan Cuib623e7b2013-03-14 12:54:11 -0700532
Steven Bennetts60600462016-05-12 10:40:20 -0700533 if not options.staging_flags:
534 use_env = os.getenv('USE')
535 if use_env is not None:
536 options.staging_flags = ' '.join(set(use_env.split()).intersection(
537 chrome_util.STAGING_FLAGS))
538 logging.info('Staging flags taken from USE in environment: %s',
539 options.staging_flags)
540
Ryan Cuia56a71e2012-10-18 18:40:35 -0700541
Ryan Cui504db722013-01-22 11:48:01 -0800542def _FetchChromePackage(cache_dir, tempdir, gs_path):
Ryan Cuia56a71e2012-10-18 18:40:35 -0700543 """Get the chrome prebuilt tarball from GS.
544
Mike Frysinger02e1e072013-11-10 22:11:34 -0500545 Returns:
546 Path to the fetched chrome tarball.
Ryan Cuia56a71e2012-10-18 18:40:35 -0700547 """
David James9374aac2013-10-08 16:00:17 -0700548 gs_ctx = gs.GSContext(cache_dir=cache_dir, init_boto=True)
Mike Frysinger7ad4fd62014-02-11 16:53:56 -0500549 files = gs_ctx.LS(gs_path)
Ryan Cui4c2d42c2013-02-08 16:22:26 -0800550 files = [found for found in files if
551 _UrlBaseName(found).startswith('%s-' % constants.CHROME_PN)]
552 if not files:
553 raise Exception('No chrome package found at %s' % gs_path)
554 elif len(files) > 1:
555 # - Users should provide us with a direct link to either a stripped or
556 # unstripped chrome package.
557 # - In the case of being provided with an archive directory, where both
558 # stripped and unstripped chrome available, use the stripped chrome
559 # package.
560 # - Stripped chrome pkg is chromeos-chrome-<version>.tar.gz
561 # - Unstripped chrome pkg is chromeos-chrome-<version>-unstripped.tar.gz.
562 files = [f for f in files if not 'unstripped' in f]
563 assert len(files) == 1
564 logging.warning('Multiple chrome packages found. Using %s', files[0])
Ryan Cui777ff422012-12-07 13:12:54 -0800565
Ryan Cui4c2d42c2013-02-08 16:22:26 -0800566 filename = _UrlBaseName(files[0])
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800567 logging.info('Fetching %s...', filename)
Ryan Cui4c2d42c2013-02-08 16:22:26 -0800568 gs_ctx.Copy(files[0], tempdir, print_cmd=False)
569 chrome_path = os.path.join(tempdir, filename)
570 assert os.path.exists(chrome_path)
571 return chrome_path
Ryan Cuia56a71e2012-10-18 18:40:35 -0700572
573
Ryan Cuif890a3e2013-03-07 18:57:06 -0800574@contextlib.contextmanager
575def _StripBinContext(options):
576 if not options.dostrip:
577 yield None
578 elif options.strip_bin:
579 yield options.strip_bin
580 else:
Ryan Cuia0215a72013-02-14 16:20:45 -0800581 sdk = cros_chrome_sdk.SDKFetcher(options.cache_dir, options.board)
Ryan Cui686ec052013-02-12 16:39:41 -0800582 components = (sdk.TARGET_TOOLCHAIN_KEY, constants.CHROME_ENV_TAR)
Aviv Keshet1c986f32014-04-24 13:20:49 -0700583 with sdk.Prepare(components=components, target_tc=options.target_tc,
584 toolchain_url=options.toolchain_url) as ctx:
Ryan Cui686ec052013-02-12 16:39:41 -0800585 env_path = os.path.join(ctx.key_map[constants.CHROME_ENV_TAR].path,
586 constants.CHROME_ENV_FILE)
587 strip_bin = osutils.SourceEnvironment(env_path, ['STRIP'])['STRIP']
588 strip_bin = os.path.join(ctx.key_map[sdk.TARGET_TOOLCHAIN_KEY].path,
589 'bin', os.path.basename(strip_bin))
Ryan Cuif890a3e2013-03-07 18:57:06 -0800590 yield strip_bin
591
592
Steve Funge984a532013-11-25 17:09:25 -0800593def _PrepareStagingDir(options, tempdir, staging_dir, copy_paths=None,
594 chrome_dir=_CHROME_DIR):
Ryan Cuif890a3e2013-03-07 18:57:06 -0800595 """Place the necessary files in the staging directory.
596
597 The staging directory is the directory used to rsync the build artifacts over
598 to the device. Only the necessary Chrome build artifacts are put into the
599 staging directory.
600 """
Ryan Cui5866be02013-03-18 14:12:00 -0700601 osutils.SafeMakedirs(staging_dir)
Mike Frysinger60ec1012013-10-21 00:11:10 -0400602 os.chmod(staging_dir, 0o755)
Ryan Cuif890a3e2013-03-07 18:57:06 -0800603 if options.build_dir:
604 with _StripBinContext(options) as strip_bin:
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700605 strip_flags = (None if options.strip_flags is None else
606 shlex.split(options.strip_flags))
Ryan Cui686ec052013-02-12 16:39:41 -0800607 chrome_util.StageChromeFromBuildDir(
Steven Bennetts46a84c32016-08-12 15:20:46 -0700608 staging_dir, options.build_dir, strip_bin,
Steven Bennettsda8d9f02016-09-23 13:25:45 -0700609 sloppy=options.sloppy, gn_args=options.gn_args,
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700610 staging_flags=options.staging_flags,
Steve Funge984a532013-11-25 17:09:25 -0800611 strip_flags=strip_flags, copy_paths=copy_paths)
Ryan Cuia56a71e2012-10-18 18:40:35 -0700612 else:
613 pkg_path = options.local_pkg_path
614 if options.gs_path:
Ryan Cui504db722013-01-22 11:48:01 -0800615 pkg_path = _FetchChromePackage(options.cache_dir, tempdir,
616 options.gs_path)
Ryan Cuia56a71e2012-10-18 18:40:35 -0700617
618 assert pkg_path
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800619 logging.info('Extracting %s...', pkg_path)
Ryan Cui5866be02013-03-18 14:12:00 -0700620 # Extract only the ./opt/google/chrome contents, directly into the staging
621 # dir, collapsing the directory hierarchy.
Steve Funge984a532013-11-25 17:09:25 -0800622 if pkg_path[-4:] == '.zip':
623 cros_build_lib.DebugRunCommand(
624 ['unzip', '-X', pkg_path, _ANDROID_DIR_EXTRACT_PATH, '-d',
625 staging_dir])
626 for filename in glob.glob(os.path.join(staging_dir, 'system/chrome/*')):
627 shutil.move(filename, staging_dir)
628 osutils.RmDir(os.path.join(staging_dir, 'system'), ignore_missing=True)
629 else:
630 cros_build_lib.DebugRunCommand(
631 ['tar', '--strip-components', '4', '--extract',
632 '--preserve-permissions', '--file', pkg_path, '.%s' % chrome_dir],
633 cwd=staging_dir)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700634
Ryan Cui71aa8de2013-04-19 16:12:55 -0700635
Ryan Cui3045c5d2012-07-13 18:00:33 -0700636def main(argv):
Mike Frysingerc3061a62015-06-04 04:16:18 -0400637 options = _ParseCommandLine(argv)
638 _PostParseCheck(options)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700639
640 # Set cros_build_lib debug level to hide RunCommand spew.
641 if options.verbose:
Ryan Cuia56a71e2012-10-18 18:40:35 -0700642 logging.getLogger().setLevel(logging.DEBUG)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700643 else:
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800644 logging.getLogger().setLevel(logging.INFO)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700645
Aviv Keshet01a82e92017-03-02 17:39:59 -0800646 with osutils.TempDir(set_global=True) as tempdir:
647 staging_dir = options.staging_dir
648 if not staging_dir:
649 staging_dir = os.path.join(tempdir, 'chrome')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700650
Aviv Keshet01a82e92017-03-02 17:39:59 -0800651 deploy = DeployChrome(options, tempdir, staging_dir)
652 try:
653 deploy.Perform()
654 except failures_lib.StepFailure as ex:
655 raise SystemExit(str(ex).strip())
656 deploy.Cleanup()