blob: 2585a93e0eec8f3d54ad6e558c7c374ad4616cf9 [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
Ryan Cui7193a7e2013-04-26 14:15:19 -070020import collections
Ryan Cuif890a3e2013-03-07 18:57:06 -080021import contextlib
Ryan Cui7193a7e2013-04-26 14:15:19 -070022import functools
Steve Funge984a532013-11-25 17:09:25 -080023import glob
David James88e6f032013-03-02 08:13:20 -080024import multiprocessing
Ryan Cui3045c5d2012-07-13 18:00:33 -070025import os
Ryan Cuia56a71e2012-10-18 18:40:35 -070026import optparse
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
Don Garrett88b8d782014-05-13 17:30:55 -070031from chromite.cbuildbot import constants
David James14e97772014-06-04 18:44:49 -070032from chromite.cbuildbot 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
Ryan Cui71aa8de2013-04-19 16:12:55 -070042from chromite.lib import stats
David James3432acd2013-11-27 10:02:18 -080043from chromite.lib import timeout_util
Ryan Cui3c183c22013-04-29 18:04:11 -070044from chromite.scripts import lddtree
Ryan Cui3045c5d2012-07-13 18:00:33 -070045
46
Mike Frysingere65f3752014-12-08 00:46:39 -050047_USAGE = 'deploy_chrome [--]\n\n %s' % __doc__
Ryan Cuia56a71e2012-10-18 18:40:35 -070048
Ryan Cui3045c5d2012-07-13 18:00:33 -070049KERNEL_A_PARTITION = 2
50KERNEL_B_PARTITION = 4
51
52KILL_PROC_MAX_WAIT = 10
53POST_KILL_WAIT = 2
54
Ryan Cuie535b172012-10-19 18:25:03 -070055MOUNT_RW_COMMAND = 'mount -o remount,rw /'
Pawel Osciak577773a2013-03-05 10:52:12 -080056LSOF_COMMAND = 'lsof %s/chrome'
Ryan Cui3045c5d2012-07-13 18:00:33 -070057
Steve Funge984a532013-11-25 17:09:25 -080058_ANDROID_DIR = '/system/chrome'
59_ANDROID_DIR_EXTRACT_PATH = 'system/chrome/*'
60
David James2cb34002013-03-01 18:42:40 -080061_CHROME_DIR = '/opt/google/chrome'
Thiago Goncales12793312013-05-23 11:26:17 -070062_CHROME_DIR_MOUNT = '/mnt/stateful_partition/deploy_rootfs/opt/google/chrome'
David James2cb34002013-03-01 18:42:40 -080063
Pawel Osciakc1bb2742014-12-29 16:32:33 +090064_UMOUNT_DIR_IF_MOUNTPOINT_CMD = (
65 'if mountpoint -q %(dir)s; then umount %(dir)s; fi')
Thiago Goncales12793312013-05-23 11:26:17 -070066_BIND_TO_FINAL_DIR_CMD = 'mount --rbind %s %s'
67_SET_MOUNT_FLAGS_CMD = 'mount -o remount,exec,suid %s'
Ryan Cui3045c5d2012-07-13 18:00:33 -070068
Steve Funge984a532013-11-25 17:09:25 -080069DF_COMMAND = 'df -k %s'
Steve Funge984a532013-11-25 17:09:25 -080070
Mike Frysingere65f3752014-12-08 00:46:39 -050071
Ryan Cui3045c5d2012-07-13 18:00:33 -070072def _UrlBaseName(url):
73 """Return the last component of the URL."""
74 return url.rstrip('/').rpartition('/')[-1]
75
76
Yu-Ju Hongc54d3342014-05-14 12:42:06 -070077class DeployFailure(failures_lib.StepFailure):
David James88e6f032013-03-02 08:13:20 -080078 """Raised whenever the deploy fails."""
79
80
Ryan Cui7193a7e2013-04-26 14:15:19 -070081DeviceInfo = collections.namedtuple(
82 'DeviceInfo', ['target_dir_size', 'target_fs_free'])
83
84
Ryan Cui3045c5d2012-07-13 18:00:33 -070085class DeployChrome(object):
86 """Wraps the core deployment functionality."""
Mike Frysingere65f3752014-12-08 00:46:39 -050087
Ryan Cuia56a71e2012-10-18 18:40:35 -070088 def __init__(self, options, tempdir, staging_dir):
Ryan Cuie535b172012-10-19 18:25:03 -070089 """Initialize the class.
90
Mike Frysinger02e1e072013-11-10 22:11:34 -050091 Args:
Ryan Cuie535b172012-10-19 18:25:03 -070092 options: Optparse result structure.
93 tempdir: Scratch space for the class. Caller has responsibility to clean
94 it up.
Steve Funge984a532013-11-25 17:09:25 -080095 staging_dir: Directory to stage the files to.
Ryan Cuie535b172012-10-19 18:25:03 -070096 """
Ryan Cui3045c5d2012-07-13 18:00:33 -070097 self.tempdir = tempdir
98 self.options = options
Ryan Cuia56a71e2012-10-18 18:40:35 -070099 self.staging_dir = staging_dir
Robert Flack1dc7ea82014-11-26 13:50:24 -0500100 if not self.options.staging_only:
Pawel Osciak141b2262014-12-21 10:27:05 +0900101 self.device = remote.RemoteDevice(options.to, port=options.port,
102 ping=options.ping)
Robert Flack1dc7ea82014-11-26 13:50:24 -0500103 self._target_dir_is_still_readonly = multiprocessing.Event()
Ryan Cui3045c5d2012-07-13 18:00:33 -0700104
Daniel Erat3fd6c7a2014-05-02 14:28:31 -0700105 self.copy_paths = chrome_util.GetCopyPaths('chrome')
Steve Funge984a532013-11-25 17:09:25 -0800106 self.chrome_dir = _CHROME_DIR
107
Ryan Cui7193a7e2013-04-26 14:15:19 -0700108 def _GetRemoteMountFree(self, remote_dir):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500109 result = self.device.RunCommand(DF_COMMAND % remote_dir)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700110 line = result.output.splitlines()[1]
Steve Funge984a532013-11-25 17:09:25 -0800111 value = line.split()[3]
112 multipliers = {
113 'G': 1024 * 1024 * 1024,
114 'M': 1024 * 1024,
115 'K': 1024,
116 }
117 return int(value.rstrip('GMK')) * multipliers.get(value[-1], 1)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700118
119 def _GetRemoteDirSize(self, remote_dir):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500120 result = self.device.RunCommand('du -ks %s' % remote_dir,
121 capture_output=True)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700122 return int(result.output.split()[0])
123
124 def _GetStagingDirSize(self):
125 result = cros_build_lib.DebugRunCommand(['du', '-ks', self.staging_dir],
Yu-Ju Hong3add4432014-01-30 11:46:15 -0800126 redirect_stdout=True,
127 capture_output=True)
Ryan Cui7193a7e2013-04-26 14:15:19 -0700128 return int(result.output.split()[0])
129
Ryan Cui3045c5d2012-07-13 18:00:33 -0700130 def _ChromeFileInUse(self):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500131 result = self.device.RunCommand(LSOF_COMMAND % (self.options.target_dir,),
132 error_code_ok=True, capture_output=True)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700133 return result.returncode == 0
134
135 def _DisableRootfsVerification(self):
136 if not self.options.force:
137 logging.error('Detected that the device has rootfs verification enabled.')
138 logging.info('This script can automatically remove the rootfs '
139 'verification, which requires that it reboot the device.')
140 logging.info('Make sure the device is in developer mode!')
141 logging.info('Skip this prompt by specifying --force.')
Brian Harring521e7242012-11-01 16:57:42 -0700142 if not cros_build_lib.BooleanPrompt('Remove roots verification?', False):
David James88e6f032013-03-02 08:13:20 -0800143 # Since we stopped Chrome earlier, it's good form to start it up again.
144 if self.options.startui:
145 logging.info('Starting Chrome...')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500146 self.device.RunCommand('start ui')
David James88e6f032013-03-02 08:13:20 -0800147 raise DeployFailure('Need rootfs verification to be disabled. '
148 'Aborting.')
Ryan Cui3045c5d2012-07-13 18:00:33 -0700149
150 logging.info('Removing rootfs verification from %s', self.options.to)
151 # Running in VM's cause make_dev_ssd's firmware sanity checks to fail.
152 # Use --force to bypass the checks.
153 cmd = ('/usr/share/vboot/bin/make_dev_ssd.sh --partitions %d '
154 '--remove_rootfs_verification --force')
155 for partition in (KERNEL_A_PARTITION, KERNEL_B_PARTITION):
Robert Flack1dc7ea82014-11-26 13:50:24 -0500156 self.device.RunCommand(cmd % partition, error_code_ok=True)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700157
158 # A reboot in developer mode takes a while (and has delays), so the user
159 # will have time to read and act on the USB boot instructions below.
160 logging.info('Please remember to press Ctrl-U if you are booting from USB.')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500161 self.device.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
220 not self.device.IsPathWritable(self.options.target_dir)):
221 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):
Pawel Osciak577773a2013-03-05 10:52:12 -0800248 logging.info('Copying Chrome to %s on device...', self.options.target_dir)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700249 # Show the output (status) for this command.
Steve Funge984a532013-11-25 17:09:25 -0800250 dest_path = _CHROME_DIR
Satoru Takabayashiab380bc2015-01-15 16:00:41 +0900251 if not self.device.HasRsync():
252 raise DeployFailure(
David Pursellcfd58872015-03-19 09:15:48 -0700253 'rsync is not found on the device.\n'
254 'Run dev_install on the device to get rsync installed')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500255 self.device.CopyToDevice('%s/' % os.path.abspath(self.staging_dir),
256 self.options.target_dir,
257 inplace=True, debug_level=logging.INFO,
258 verbose=self.options.verbose)
Steve Funge984a532013-11-25 17:09:25 -0800259
260 for p in self.copy_paths:
Steve Funge984a532013-11-25 17:09:25 -0800261 if p.mode:
262 # Set mode if necessary.
Robert Flack1dc7ea82014-11-26 13:50:24 -0500263 self.device.RunCommand('chmod %o %s/%s' % (
264 p.mode, dest_path, p.src if not p.dest else p.dest))
Steve Funge984a532013-11-25 17:09:25 -0800265
Ryan Cui82a1f2d2013-02-22 17:34:23 -0800266 if self.options.startui:
Steve Funge984a532013-11-25 17:09:25 -0800267 logging.info('Starting UI...')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500268 self.device.RunCommand('start ui')
Ryan Cui3045c5d2012-07-13 18:00:33 -0700269
David James88e6f032013-03-02 08:13:20 -0800270 def _CheckConnection(self):
Ryan Cui3045c5d2012-07-13 18:00:33 -0700271 try:
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800272 logging.info('Testing connection to the device...')
Robert Flack1dc7ea82014-11-26 13:50:24 -0500273 self.device.RunCommand('true')
David James88e6f032013-03-02 08:13:20 -0800274 except cros_build_lib.RunCommandError as ex:
Ryan Cui3045c5d2012-07-13 18:00:33 -0700275 logging.error('Error connecting to the test device.')
David James88e6f032013-03-02 08:13:20 -0800276 raise DeployFailure(ex)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700277
Steve Funge984a532013-11-25 17:09:25 -0800278 def _CheckDeployType(self):
Steve Fung63d705d2014-03-16 03:14:03 -0700279 if self.options.build_dir:
Daniel Erat3fd6c7a2014-05-02 14:28:31 -0700280 def BinaryExists(filename):
281 """Checks if the passed-in file is present in the build directory."""
282 return os.path.exists(os.path.join(self.options.build_dir, filename))
283
Daniel Erat9813f0e2014-11-12 11:00:28 -0700284 # Handle non-Chrome deployments.
285 if not BinaryExists('chrome'):
286 if BinaryExists('envoy_shell'):
287 self.copy_paths = chrome_util.GetCopyPaths('envoy')
288 elif BinaryExists('app_shell'):
289 self.copy_paths = chrome_util.GetCopyPaths('app_shell')
290
Daniel Erat3fd6c7a2014-05-02 14:28:31 -0700291 # TODO(derat): Update _Deploy() and remove this after figuring out how
Daniel Erat9813f0e2014-11-12 11:00:28 -0700292 # {app,envoy}_shell should be executed.
Daniel Erat3fd6c7a2014-05-02 14:28:31 -0700293 self.options.startui = False
294
David James88e6f032013-03-02 08:13:20 -0800295 def _PrepareStagingDir(self):
Steve Funge984a532013-11-25 17:09:25 -0800296 _PrepareStagingDir(self.options, self.tempdir, self.staging_dir,
297 self.copy_paths, self.chrome_dir)
David James88e6f032013-03-02 08:13:20 -0800298
Thiago Goncales12793312013-05-23 11:26:17 -0700299 def _MountTarget(self):
300 logging.info('Mounting Chrome...')
301
302 # Create directory if does not exist
Robert Flack1dc7ea82014-11-26 13:50:24 -0500303 self.device.RunCommand('mkdir -p --mode 0775 %s' % (
Mike Frysingere65f3752014-12-08 00:46:39 -0500304 self.options.mount_dir,))
Pawel Osciakfb200f52014-12-21 13:42:05 +0900305 # Umount the existing mount on mount_dir if present first
306 self.device.RunCommand(_UMOUNT_DIR_IF_MOUNTPOINT_CMD %
307 {'dir': self.options.mount_dir})
Robert Flack1dc7ea82014-11-26 13:50:24 -0500308 self.device.RunCommand(_BIND_TO_FINAL_DIR_CMD % (self.options.target_dir,
309 self.options.mount_dir))
Thiago Goncales12793312013-05-23 11:26:17 -0700310 # Chrome needs partition to have exec and suid flags set
Robert Flack1dc7ea82014-11-26 13:50:24 -0500311 self.device.RunCommand(_SET_MOUNT_FLAGS_CMD % (self.options.mount_dir,))
312
313 def Cleanup(self):
314 """Clean up RemoteDevice."""
315 if not self.options.staging_only:
316 self.device.Cleanup()
Thiago Goncales12793312013-05-23 11:26:17 -0700317
David James88e6f032013-03-02 08:13:20 -0800318 def Perform(self):
Steve Funge984a532013-11-25 17:09:25 -0800319 self._CheckDeployType()
320
David James88e6f032013-03-02 08:13:20 -0800321 # If requested, just do the staging step.
322 if self.options.staging_only:
323 self._PrepareStagingDir()
324 return 0
325
326 # Run setup steps in parallel. If any step fails, RunParallelSteps will
David James48f6b332013-03-03 20:11:18 -0800327 # stop printing output at that point, and halt any running steps.
Steve Funge984a532013-11-25 17:09:25 -0800328 steps = [self._GetDeviceInfo, self._CheckConnection,
329 self._KillProcsIfNeeded, self._MountRootfsAsWritable,
330 self._PrepareStagingDir]
Ryan Cui7193a7e2013-04-26 14:15:19 -0700331 ret = parallel.RunParallelSteps(steps, halt_on_error=True,
332 return_values=True)
333 self._CheckDeviceFreeSpace(ret[0])
David James88e6f032013-03-02 08:13:20 -0800334
Robert Flack1dc7ea82014-11-26 13:50:24 -0500335 # If we're trying to deploy to a dir which is not writable and we failed
336 # to mark the rootfs as writable, try disabling rootfs verification.
337 if self._target_dir_is_still_readonly.is_set():
David James88e6f032013-03-02 08:13:20 -0800338 self._DisableRootfsVerification()
339
Thiago Goncales12793312013-05-23 11:26:17 -0700340 if self.options.mount_dir is not None:
341 self._MountTarget()
342
David James88e6f032013-03-02 08:13:20 -0800343 # Actually deploy Chrome to the device.
Ryan Cui3045c5d2012-07-13 18:00:33 -0700344 self._Deploy()
345
346
Ryan Cuia56a71e2012-10-18 18:40:35 -0700347def ValidateGypDefines(_option, _opt, value):
348 """Convert GYP_DEFINES-formatted string to dictionary."""
349 return chrome_util.ProcessGypDefines(value)
350
351
352class CustomOption(commandline.Option):
353 """Subclass Option class to implement path evaluation."""
354 TYPES = commandline.Option.TYPES + ('gyp_defines',)
355 TYPE_CHECKER = commandline.Option.TYPE_CHECKER.copy()
356 TYPE_CHECKER['gyp_defines'] = ValidateGypDefines
357
358
Ryan Cuie535b172012-10-19 18:25:03 -0700359def _CreateParser():
360 """Create our custom parser."""
Ryan Cui504db722013-01-22 11:48:01 -0800361 parser = commandline.OptionParser(usage=_USAGE, option_class=CustomOption,
362 caching=True)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700363
Ryan Cuia56a71e2012-10-18 18:40:35 -0700364 # TODO(rcui): Have this use the UI-V2 format of having source and target
365 # device be specified as positional arguments.
Ryan Cui3045c5d2012-07-13 18:00:33 -0700366 parser.add_option('--force', action='store_true', default=False,
Ryan Cui686ec052013-02-12 16:39:41 -0800367 help='Skip all prompts (i.e., for disabling of rootfs '
368 'verification). This may result in the target '
369 'machine being rebooted.')
Ryan Cuia0215a72013-02-14 16:20:45 -0800370 sdk_board_env = os.environ.get(cros_chrome_sdk.SDKFetcher.SDK_BOARD_ENV)
371 parser.add_option('--board', default=sdk_board_env,
Ryan Cui686ec052013-02-12 16:39:41 -0800372 help="The board the Chrome build is targeted for. When in "
373 "a 'cros chrome-sdk' shell, defaults to the SDK "
374 "board.")
Ryan Cuia56a71e2012-10-18 18:40:35 -0700375 parser.add_option('--build-dir', type='path',
Ryan Cui686ec052013-02-12 16:39:41 -0800376 help='The directory with Chrome build artifacts to deploy '
377 'from. Typically of format <chrome_root>/out/Debug. '
378 'When this option is used, the GYP_DEFINES '
379 'environment variable must be set.')
Pawel Osciak577773a2013-03-05 10:52:12 -0800380 parser.add_option('--target-dir', type='path',
381 help='Target directory on device to deploy Chrome into.',
Thiago Goncales12793312013-05-23 11:26:17 -0700382 default=None)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700383 parser.add_option('-g', '--gs-path', type='gs_path',
Ryan Cui686ec052013-02-12 16:39:41 -0800384 help='GS path that contains the chrome to deploy.')
Ryan Cui82a1f2d2013-02-22 17:34:23 -0800385 parser.add_option('--nostartui', action='store_false', dest='startui',
386 default=True,
387 help="Don't restart the ui daemon after deployment.")
Ryan Cuif890a3e2013-03-07 18:57:06 -0800388 parser.add_option('--nostrip', action='store_false', dest='dostrip',
389 default=True,
390 help="Don't strip binaries during deployment. Warning: "
391 "the resulting binaries will be very large!")
Ryan Cui3045c5d2012-07-13 18:00:33 -0700392 parser.add_option('-p', '--port', type=int, default=remote.DEFAULT_SSH_PORT,
Ryan Cui686ec052013-02-12 16:39:41 -0800393 help='Port of the target device to connect to.')
Ryan Cui3045c5d2012-07-13 18:00:33 -0700394 parser.add_option('-t', '--to',
Ryan Cui686ec052013-02-12 16:39:41 -0800395 help='The IP address of the CrOS device to deploy to.')
Ryan Cui3045c5d2012-07-13 18:00:33 -0700396 parser.add_option('-v', '--verbose', action='store_true', default=False,
Ryan Cui686ec052013-02-12 16:39:41 -0800397 help='Show more debug output.')
Thiago Goncales12793312013-05-23 11:26:17 -0700398 parser.add_option('--mount-dir', type='path', default=None,
Mike Frysingercd304692014-10-02 16:33:41 -0400399 help='Deploy Chrome in target directory and bind it '
Pawel Osciakfb200f52014-12-21 13:42:05 +0900400 'to the directory specified by this flag.'
401 'Any existing mount on this directory will be '
402 'umounted first.')
Thiago Goncales12793312013-05-23 11:26:17 -0700403 parser.add_option('--mount', action='store_true', default=False,
Mike Frysingercd304692014-10-02 16:33:41 -0400404 help='Deploy Chrome to default target directory and bind '
Pawel Osciakfb200f52014-12-21 13:42:05 +0900405 'it to the default mount directory.'
406 'Any existing mount on this directory will be '
407 'umounted first.')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700408
409 group = optparse.OptionGroup(parser, 'Advanced Options')
410 group.add_option('-l', '--local-pkg-path', type='path',
Ryan Cui686ec052013-02-12 16:39:41 -0800411 help='Path to local chrome prebuilt package to deploy.')
David Jamesa6e08892013-03-01 13:34:11 -0800412 group.add_option('--sloppy', action='store_true', default=False,
413 help='Ignore when mandatory artifacts are missing.')
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700414 group.add_option('--staging-flags', default=None, type='gyp_defines',
Mike Frysingere65f3752014-12-08 00:46:39 -0500415 help=('Extra flags to control staging. Valid flags are - %s'
416 % ', '.join(chrome_util.STAGING_FLAGS)))
Ryan Cuief91e702013-02-04 12:06:36 -0800417 group.add_option('--strict', action='store_true', default=False,
Ryan Cui686ec052013-02-12 16:39:41 -0800418 help='Stage artifacts based on the GYP_DEFINES environment '
David Jamesa6e08892013-03-01 13:34:11 -0800419 'variable and --staging-flags, if set. Enforce that '
420 'all optional artifacts are deployed.')
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700421 group.add_option('--strip-flags', default=None,
422 help="Flags to call the 'strip' binutil tool with. "
423 "Overrides the default arguments.")
Pawel Osciak141b2262014-12-21 10:27:05 +0900424 group.add_option('--ping', action='store_true', default=False,
425 help='Ping the device before connection attempt.')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700426 parser.add_option_group(group)
427
Aviv Keshet1c986f32014-04-24 13:20:49 -0700428 group = optparse.OptionGroup(parser, 'Metadata Overrides (Advanced)',
429 description='Provide all of these overrides '
430 'in order to remove dependencies on '
431 'metadata.json existence.')
432 group.add_option('--target-tc', action='store', default=None,
433 help='Override target toolchain name, e.g. '
434 'x86_64-cros-linux-gnu')
435 group.add_option('--toolchain-url', action='store', default=None,
436 help='Override toolchain url format pattern, e.g. '
437 '2014/04/%%(target)s-2014.04.23.220740.tar.xz')
438 parser.add_option_group(group)
439
Ryan Cuif890a3e2013-03-07 18:57:06 -0800440 # GYP_DEFINES that Chrome was built with. Influences which files are staged
441 # when --build-dir is set. Defaults to reading from the GYP_DEFINES
442 # enviroment variable.
443 parser.add_option('--gyp-defines', default=None, type='gyp_defines',
444 help=optparse.SUPPRESS_HELP)
Ryan Cuia56a71e2012-10-18 18:40:35 -0700445 # Path of an empty directory to stage chrome artifacts to. Defaults to a
446 # temporary directory that is removed when the script finishes. If the path
447 # is specified, then it will not be removed.
448 parser.add_option('--staging-dir', type='path', default=None,
449 help=optparse.SUPPRESS_HELP)
450 # Only prepare the staging directory, and skip deploying to the device.
451 parser.add_option('--staging-only', action='store_true', default=False,
452 help=optparse.SUPPRESS_HELP)
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700453 # Path to a binutil 'strip' tool to strip binaries with. The passed-in path
454 # is used as-is, and not normalized. Used by the Chrome ebuild to skip
455 # fetching the SDK toolchain.
456 parser.add_option('--strip-bin', default=None, help=optparse.SUPPRESS_HELP)
Ryan Cuie535b172012-10-19 18:25:03 -0700457 return parser
Ryan Cui3045c5d2012-07-13 18:00:33 -0700458
Ryan Cuie535b172012-10-19 18:25:03 -0700459
460def _ParseCommandLine(argv):
461 """Parse args, and run environment-independent checks."""
462 parser = _CreateParser()
Ryan Cui3045c5d2012-07-13 18:00:33 -0700463 (options, args) = parser.parse_args(argv)
464
Ryan Cuia56a71e2012-10-18 18:40:35 -0700465 if not any([options.gs_path, options.local_pkg_path, options.build_dir]):
466 parser.error('Need to specify either --gs-path, --local-pkg-path, or '
Ryan Cuief91e702013-02-04 12:06:36 -0800467 '--build-dir')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700468 if options.build_dir and any([options.gs_path, options.local_pkg_path]):
469 parser.error('Cannot specify both --build_dir and '
470 '--gs-path/--local-pkg-patch')
Ryan Cui686ec052013-02-12 16:39:41 -0800471 if options.build_dir and not options.board:
472 parser.error('--board is required when --build-dir is specified.')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700473 if options.gs_path and options.local_pkg_path:
474 parser.error('Cannot specify both --gs-path and --local-pkg-path')
475 if not (options.staging_only or options.to):
Ryan Cui3045c5d2012-07-13 18:00:33 -0700476 parser.error('Need to specify --to')
Ryan Cuief91e702013-02-04 12:06:36 -0800477 if (options.strict or options.staging_flags) and not options.build_dir:
478 parser.error('--strict and --staging-flags require --build-dir to be '
479 'set.')
480 if options.staging_flags and not options.strict:
David Jamesa6e08892013-03-01 13:34:11 -0800481 parser.error('--staging-flags requires --strict to be set.')
482 if options.sloppy and options.strict:
483 parser.error('Cannot specify both --strict and --sloppy.')
Thiago Goncales12793312013-05-23 11:26:17 -0700484
485 if options.mount or options.mount_dir:
486 if not options.target_dir:
487 options.target_dir = _CHROME_DIR_MOUNT
488 else:
489 if not options.target_dir:
490 options.target_dir = _CHROME_DIR
491
492 if options.mount and not options.mount_dir:
493 options.mount_dir = _CHROME_DIR
494
Ryan Cui3045c5d2012-07-13 18:00:33 -0700495 return options, args
496
497
Ryan Cuie535b172012-10-19 18:25:03 -0700498def _PostParseCheck(options, _args):
Steve Funge984a532013-11-25 17:09:25 -0800499 """Perform some usage validation (after we've parsed the arguments).
Ryan Cui3045c5d2012-07-13 18:00:33 -0700500
501 Args:
Steve Funge984a532013-11-25 17:09:25 -0800502 options: The options object returned by optparse.
503 _args: The args object returned by optparse.
Ryan Cui3045c5d2012-07-13 18:00:33 -0700504 """
Ryan Cuia56a71e2012-10-18 18:40:35 -0700505 if options.local_pkg_path and not os.path.isfile(options.local_pkg_path):
506 cros_build_lib.Die('%s is not a file.', options.local_pkg_path)
507
Ryan Cuib623e7b2013-03-14 12:54:11 -0700508 if not options.gyp_defines:
Ryan Cuia56a71e2012-10-18 18:40:35 -0700509 gyp_env = os.getenv('GYP_DEFINES', None)
510 if gyp_env is not None:
511 options.gyp_defines = chrome_util.ProcessGypDefines(gyp_env)
Ryan Cuib623e7b2013-03-14 12:54:11 -0700512 logging.debug('GYP_DEFINES taken from environment: %s',
Mike Frysingere65f3752014-12-08 00:46:39 -0500513 options.gyp_defines)
Ryan Cuib623e7b2013-03-14 12:54:11 -0700514
515 if options.strict and not options.gyp_defines:
516 cros_build_lib.Die('When --strict is set, the GYP_DEFINES environment '
Mike Frysingere65f3752014-12-08 00:46:39 -0500517 'variable must be set.')
Ryan Cuia56a71e2012-10-18 18:40:35 -0700518
Ryan Cui3c183c22013-04-29 18:04:11 -0700519 if options.build_dir:
520 chrome_path = os.path.join(options.build_dir, 'chrome')
521 if os.path.isfile(chrome_path):
522 deps = lddtree.ParseELF(chrome_path)
523 if 'libbase.so' in deps['libs']:
524 cros_build_lib.Warning(
525 'Detected a component build of Chrome. component build is '
526 'not working properly for Chrome OS. See crbug.com/196317. '
527 'Use at your own risk!')
Ryan Cuib623e7b2013-03-14 12:54:11 -0700528
Ryan Cuia56a71e2012-10-18 18:40:35 -0700529
Ryan Cui504db722013-01-22 11:48:01 -0800530def _FetchChromePackage(cache_dir, tempdir, gs_path):
Ryan Cuia56a71e2012-10-18 18:40:35 -0700531 """Get the chrome prebuilt tarball from GS.
532
Mike Frysinger02e1e072013-11-10 22:11:34 -0500533 Returns:
534 Path to the fetched chrome tarball.
Ryan Cuia56a71e2012-10-18 18:40:35 -0700535 """
David James9374aac2013-10-08 16:00:17 -0700536 gs_ctx = gs.GSContext(cache_dir=cache_dir, init_boto=True)
Mike Frysinger7ad4fd62014-02-11 16:53:56 -0500537 files = gs_ctx.LS(gs_path)
Ryan Cui4c2d42c2013-02-08 16:22:26 -0800538 files = [found for found in files if
539 _UrlBaseName(found).startswith('%s-' % constants.CHROME_PN)]
540 if not files:
541 raise Exception('No chrome package found at %s' % gs_path)
542 elif len(files) > 1:
543 # - Users should provide us with a direct link to either a stripped or
544 # unstripped chrome package.
545 # - In the case of being provided with an archive directory, where both
546 # stripped and unstripped chrome available, use the stripped chrome
547 # package.
548 # - Stripped chrome pkg is chromeos-chrome-<version>.tar.gz
549 # - Unstripped chrome pkg is chromeos-chrome-<version>-unstripped.tar.gz.
550 files = [f for f in files if not 'unstripped' in f]
551 assert len(files) == 1
552 logging.warning('Multiple chrome packages found. Using %s', files[0])
Ryan Cui777ff422012-12-07 13:12:54 -0800553
Ryan Cui4c2d42c2013-02-08 16:22:26 -0800554 filename = _UrlBaseName(files[0])
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800555 logging.info('Fetching %s...', filename)
Ryan Cui4c2d42c2013-02-08 16:22:26 -0800556 gs_ctx.Copy(files[0], tempdir, print_cmd=False)
557 chrome_path = os.path.join(tempdir, filename)
558 assert os.path.exists(chrome_path)
559 return chrome_path
Ryan Cuia56a71e2012-10-18 18:40:35 -0700560
561
Ryan Cuif890a3e2013-03-07 18:57:06 -0800562@contextlib.contextmanager
563def _StripBinContext(options):
564 if not options.dostrip:
565 yield None
566 elif options.strip_bin:
567 yield options.strip_bin
568 else:
Ryan Cuia0215a72013-02-14 16:20:45 -0800569 sdk = cros_chrome_sdk.SDKFetcher(options.cache_dir, options.board)
Ryan Cui686ec052013-02-12 16:39:41 -0800570 components = (sdk.TARGET_TOOLCHAIN_KEY, constants.CHROME_ENV_TAR)
Aviv Keshet1c986f32014-04-24 13:20:49 -0700571 with sdk.Prepare(components=components, target_tc=options.target_tc,
572 toolchain_url=options.toolchain_url) as ctx:
Ryan Cui686ec052013-02-12 16:39:41 -0800573 env_path = os.path.join(ctx.key_map[constants.CHROME_ENV_TAR].path,
574 constants.CHROME_ENV_FILE)
575 strip_bin = osutils.SourceEnvironment(env_path, ['STRIP'])['STRIP']
576 strip_bin = os.path.join(ctx.key_map[sdk.TARGET_TOOLCHAIN_KEY].path,
577 'bin', os.path.basename(strip_bin))
Ryan Cuif890a3e2013-03-07 18:57:06 -0800578 yield strip_bin
579
580
Steve Funge984a532013-11-25 17:09:25 -0800581def _PrepareStagingDir(options, tempdir, staging_dir, copy_paths=None,
582 chrome_dir=_CHROME_DIR):
Ryan Cuif890a3e2013-03-07 18:57:06 -0800583 """Place the necessary files in the staging directory.
584
585 The staging directory is the directory used to rsync the build artifacts over
586 to the device. Only the necessary Chrome build artifacts are put into the
587 staging directory.
588 """
Ryan Cui5866be02013-03-18 14:12:00 -0700589 osutils.SafeMakedirs(staging_dir)
Mike Frysinger60ec1012013-10-21 00:11:10 -0400590 os.chmod(staging_dir, 0o755)
Ryan Cuif890a3e2013-03-07 18:57:06 -0800591 if options.build_dir:
592 with _StripBinContext(options) as strip_bin:
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700593 strip_flags = (None if options.strip_flags is None else
594 shlex.split(options.strip_flags))
Ryan Cui686ec052013-02-12 16:39:41 -0800595 chrome_util.StageChromeFromBuildDir(
596 staging_dir, options.build_dir, strip_bin, strict=options.strict,
David Jamesa6e08892013-03-01 13:34:11 -0800597 sloppy=options.sloppy, gyp_defines=options.gyp_defines,
Ryan Cui5b7c2ed2013-03-18 18:45:46 -0700598 staging_flags=options.staging_flags,
Steve Funge984a532013-11-25 17:09:25 -0800599 strip_flags=strip_flags, copy_paths=copy_paths)
Ryan Cuia56a71e2012-10-18 18:40:35 -0700600 else:
601 pkg_path = options.local_pkg_path
602 if options.gs_path:
Ryan Cui504db722013-01-22 11:48:01 -0800603 pkg_path = _FetchChromePackage(options.cache_dir, tempdir,
604 options.gs_path)
Ryan Cuia56a71e2012-10-18 18:40:35 -0700605
606 assert pkg_path
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800607 logging.info('Extracting %s...', pkg_path)
Ryan Cui5866be02013-03-18 14:12:00 -0700608 # Extract only the ./opt/google/chrome contents, directly into the staging
609 # dir, collapsing the directory hierarchy.
Steve Funge984a532013-11-25 17:09:25 -0800610 if pkg_path[-4:] == '.zip':
611 cros_build_lib.DebugRunCommand(
612 ['unzip', '-X', pkg_path, _ANDROID_DIR_EXTRACT_PATH, '-d',
613 staging_dir])
614 for filename in glob.glob(os.path.join(staging_dir, 'system/chrome/*')):
615 shutil.move(filename, staging_dir)
616 osutils.RmDir(os.path.join(staging_dir, 'system'), ignore_missing=True)
617 else:
618 cros_build_lib.DebugRunCommand(
619 ['tar', '--strip-components', '4', '--extract',
620 '--preserve-permissions', '--file', pkg_path, '.%s' % chrome_dir],
621 cwd=staging_dir)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700622
Ryan Cui71aa8de2013-04-19 16:12:55 -0700623
Ryan Cui3045c5d2012-07-13 18:00:33 -0700624def main(argv):
625 options, args = _ParseCommandLine(argv)
626 _PostParseCheck(options, args)
627
628 # Set cros_build_lib debug level to hide RunCommand spew.
629 if options.verbose:
Ryan Cuia56a71e2012-10-18 18:40:35 -0700630 logging.getLogger().setLevel(logging.DEBUG)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700631 else:
Ryan Cui4d6b0db2013-02-28 15:13:24 -0800632 logging.getLogger().setLevel(logging.INFO)
Ryan Cui3045c5d2012-07-13 18:00:33 -0700633
Ryan Cui71aa8de2013-04-19 16:12:55 -0700634 with stats.UploadContext() as queue:
Ryan Cuicbd9bb62013-04-30 11:17:02 -0700635 cmd_stats = stats.Stats.SafeInit(cmd_line=argv, cmd_base='deploy_chrome')
636 if cmd_stats:
637 queue.put([cmd_stats, stats.StatsUploader.URL, 1])
Ryan Cuia56a71e2012-10-18 18:40:35 -0700638
Ryan Cui71aa8de2013-04-19 16:12:55 -0700639 with osutils.TempDir(set_global=True) as tempdir:
640 staging_dir = options.staging_dir
641 if not staging_dir:
642 staging_dir = os.path.join(tempdir, 'chrome')
643
644 deploy = DeployChrome(options, tempdir, staging_dir)
645 try:
646 deploy.Perform()
Yu-Ju Hongc54d3342014-05-14 12:42:06 -0700647 except failures_lib.StepFailure as ex:
Ryan Cui71aa8de2013-04-19 16:12:55 -0700648 raise SystemExit(str(ex).strip())
Robert Flack1dc7ea82014-11-26 13:50:24 -0500649 deploy.Cleanup()