Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 1 | # 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 Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 5 | """Script that deploys a Chrome build to a device. |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 6 | |
| 7 | The script supports deploying Chrome from these sources: |
| 8 | |
| 9 | 1. A local build output directory, such as chromium/src/out/[Debug|Release]. |
| 10 | 2. A Chrome tarball uploaded by a trybot/official-builder to GoogleStorage. |
| 11 | 3. A Chrome tarball existing locally. |
| 12 | |
| 13 | The script copies the necessary contents of the source location (tarball or |
| 14 | build directory) and rsyncs the contents of the staging directory onto your |
| 15 | device's rootfs. |
| 16 | """ |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 17 | |
Mike Frysinger | 383367e | 2014-09-16 15:06:17 -0400 | [diff] [blame] | 18 | from __future__ import print_function |
| 19 | |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 20 | import argparse |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 21 | import collections |
Ryan Cui | f890a3e | 2013-03-07 18:57:06 -0800 | [diff] [blame] | 22 | import contextlib |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 23 | import functools |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 24 | import glob |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 25 | import multiprocessing |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 26 | import os |
Ryan Cui | 5b7c2ed | 2013-03-18 18:45:46 -0700 | [diff] [blame] | 27 | import shlex |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 28 | import shutil |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 29 | import time |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 30 | |
Aviv Keshet | b7519e1 | 2016-10-04 00:50:00 -0700 | [diff] [blame] | 31 | from chromite.lib import constants |
| 32 | from chromite.lib import failures_lib |
David Pursell | cfd5887 | 2015-03-19 09:15:48 -0700 | [diff] [blame] | 33 | from chromite.cli.cros import cros_chrome_sdk |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 34 | from chromite.lib import chrome_util |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 35 | from chromite.lib import commandline |
Ralph Nathan | 91874ca | 2015-03-19 13:29:41 -0700 | [diff] [blame] | 36 | from chromite.lib import cros_build_lib |
| 37 | from chromite.lib import cros_logging as logging |
Ryan Cui | 777ff42 | 2012-12-07 13:12:54 -0800 | [diff] [blame] | 38 | from chromite.lib import gs |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 39 | from chromite.lib import osutils |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 40 | from chromite.lib import parallel |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 41 | from chromite.lib import remote_access as remote |
David James | 3432acd | 2013-11-27 10:02:18 -0800 | [diff] [blame] | 42 | from chromite.lib import timeout_util |
Steven Bennetts | 368c3e5 | 2016-09-23 13:05:21 -0700 | [diff] [blame] | 43 | from gn_helpers import gn_helpers |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 44 | |
| 45 | |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 46 | KERNEL_A_PARTITION = 2 |
| 47 | KERNEL_B_PARTITION = 4 |
| 48 | |
| 49 | KILL_PROC_MAX_WAIT = 10 |
| 50 | POST_KILL_WAIT = 2 |
| 51 | |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 52 | MOUNT_RW_COMMAND = 'mount -o remount,rw /' |
Pawel Osciak | 577773a | 2013-03-05 10:52:12 -0800 | [diff] [blame] | 53 | LSOF_COMMAND = 'lsof %s/chrome' |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 54 | |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 55 | _ANDROID_DIR = '/system/chrome' |
| 56 | _ANDROID_DIR_EXTRACT_PATH = 'system/chrome/*' |
| 57 | |
David James | 2cb3400 | 2013-03-01 18:42:40 -0800 | [diff] [blame] | 58 | _CHROME_DIR = '/opt/google/chrome' |
Thiago Goncales | 1279331 | 2013-05-23 11:26:17 -0700 | [diff] [blame] | 59 | _CHROME_DIR_MOUNT = '/mnt/stateful_partition/deploy_rootfs/opt/google/chrome' |
David James | 2cb3400 | 2013-03-01 18:42:40 -0800 | [diff] [blame] | 60 | |
Pawel Osciak | c1bb274 | 2014-12-29 16:32:33 +0900 | [diff] [blame] | 61 | _UMOUNT_DIR_IF_MOUNTPOINT_CMD = ( |
| 62 | 'if mountpoint -q %(dir)s; then umount %(dir)s; fi') |
Thiago Goncales | 1279331 | 2013-05-23 11:26:17 -0700 | [diff] [blame] | 63 | _BIND_TO_FINAL_DIR_CMD = 'mount --rbind %s %s' |
| 64 | _SET_MOUNT_FLAGS_CMD = 'mount -o remount,exec,suid %s' |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 65 | |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 66 | DF_COMMAND = 'df -k %s' |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 67 | |
Mike Frysinger | e65f375 | 2014-12-08 00:46:39 -0500 | [diff] [blame] | 68 | |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 69 | def _UrlBaseName(url): |
| 70 | """Return the last component of the URL.""" |
| 71 | return url.rstrip('/').rpartition('/')[-1] |
| 72 | |
| 73 | |
Yu-Ju Hong | c54d334 | 2014-05-14 12:42:06 -0700 | [diff] [blame] | 74 | class DeployFailure(failures_lib.StepFailure): |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 75 | """Raised whenever the deploy fails.""" |
| 76 | |
| 77 | |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 78 | DeviceInfo = collections.namedtuple( |
| 79 | 'DeviceInfo', ['target_dir_size', 'target_fs_free']) |
| 80 | |
| 81 | |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 82 | class DeployChrome(object): |
| 83 | """Wraps the core deployment functionality.""" |
Mike Frysinger | e65f375 | 2014-12-08 00:46:39 -0500 | [diff] [blame] | 84 | |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 85 | def __init__(self, options, tempdir, staging_dir): |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 86 | """Initialize the class. |
| 87 | |
Mike Frysinger | 02e1e07 | 2013-11-10 22:11:34 -0500 | [diff] [blame] | 88 | Args: |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 89 | options: options object. |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 90 | tempdir: Scratch space for the class. Caller has responsibility to clean |
| 91 | it up. |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 92 | staging_dir: Directory to stage the files to. |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 93 | """ |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 94 | self.tempdir = tempdir |
| 95 | self.options = options |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 96 | self.staging_dir = staging_dir |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 97 | if not self.options.staging_only: |
Pawel Osciak | 141b226 | 2014-12-21 10:27:05 +0900 | [diff] [blame] | 98 | self.device = remote.RemoteDevice(options.to, port=options.port, |
| 99 | ping=options.ping) |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 100 | self._target_dir_is_still_readonly = multiprocessing.Event() |
Steven Bennetts | 5a7c72d | 2016-10-17 20:04:46 +0000 | [diff] [blame] | 101 | |
Sadrul Habib Chowdhury | 977aef7 | 2016-11-21 16:30:37 -0500 | [diff] [blame] | 102 | self.copy_paths = chrome_util.GetCopyPaths('chrome') |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 103 | self.chrome_dir = _CHROME_DIR |
| 104 | |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 105 | def _GetRemoteMountFree(self, remote_dir): |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 106 | result = self.device.RunCommand(DF_COMMAND % remote_dir) |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 107 | line = result.output.splitlines()[1] |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 108 | 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 Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 115 | |
| 116 | def _GetRemoteDirSize(self, remote_dir): |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 117 | result = self.device.RunCommand('du -ks %s' % remote_dir, |
| 118 | capture_output=True) |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 119 | return int(result.output.split()[0]) |
| 120 | |
| 121 | def _GetStagingDirSize(self): |
| 122 | result = cros_build_lib.DebugRunCommand(['du', '-ks', self.staging_dir], |
Yu-Ju Hong | 3add443 | 2014-01-30 11:46:15 -0800 | [diff] [blame] | 123 | redirect_stdout=True, |
| 124 | capture_output=True) |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 125 | return int(result.output.split()[0]) |
| 126 | |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 127 | def _ChromeFileInUse(self): |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 128 | result = self.device.RunCommand(LSOF_COMMAND % (self.options.target_dir,), |
| 129 | error_code_ok=True, capture_output=True) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 130 | return result.returncode == 0 |
| 131 | |
Justin TerAvest | fac210e | 2017-04-13 11:39:00 -0600 | [diff] [blame] | 132 | 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 Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 138 | 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 Harring | 521e724 | 2012-11-01 16:57:42 -0700 | [diff] [blame] | 145 | if not cros_build_lib.BooleanPrompt('Remove roots verification?', False): |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 146 | # 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 Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 149 | self.device.RunCommand('start ui') |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 150 | raise DeployFailure('Need rootfs verification to be disabled. ' |
| 151 | 'Aborting.') |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 152 | |
| 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 Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 159 | self.device.RunCommand(cmd % partition, error_code_ok=True) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 160 | |
Justin TerAvest | fac210e | 2017-04-13 11:39:00 -0600 | [diff] [blame] | 161 | self._Reboot() |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 162 | |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 163 | # 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 Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 168 | |
| 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 Cui | f2d1a58 | 2013-02-19 14:08:13 -0800 | [diff] [blame] | 173 | try: |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 174 | result = self.device.RunCommand('status ui', capture_output=True) |
Ryan Cui | f2d1a58 | 2013-02-19 14:08:13 -0800 | [diff] [blame] | 175 | 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 Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 181 | return result.output.split()[1].split('/')[0] == 'start' |
| 182 | |
| 183 | def _KillProcsIfNeeded(self): |
| 184 | if self._CheckUiJobStarted(): |
Ryan Cui | 4d6b0db | 2013-02-28 15:13:24 -0800 | [diff] [blame] | 185 | logging.info('Shutting down Chrome...') |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 186 | self.device.RunCommand('stop ui') |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 187 | |
| 188 | # Developers sometimes run session_manager manually, in which case we'll |
| 189 | # need to help shut the chrome processes down. |
| 190 | try: |
Achuith Bhandarkar | 2f8352f | 2017-06-02 12:47:18 -0700 | [diff] [blame^] | 191 | with timeout_util.Timeout(self.options.process_timeout): |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 192 | 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 Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 196 | self.device.RunCommand("pkill 'chrome|session_manager'", |
Mike Frysinger | e65f375 | 2014-12-08 00:46:39 -0500 | [diff] [blame] | 197 | error_code_ok=True) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 198 | # Wait for processes to actually terminate |
| 199 | time.sleep(POST_KILL_WAIT) |
| 200 | logging.info('Rechecking the chrome binary...') |
David James | 3432acd | 2013-11-27 10:02:18 -0800 | [diff] [blame] | 201 | except timeout_util.TimeoutError: |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 202 | msg = ('Could not kill processes after %s seconds. Please exit any ' |
Achuith Bhandarkar | 2f8352f | 2017-06-02 12:47:18 -0700 | [diff] [blame^] | 203 | 'running chrome processes and try again.' |
| 204 | % self.options.process_timeout) |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 205 | raise DeployFailure(msg) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 206 | |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 207 | def _MountRootfsAsWritable(self, error_code_ok=True): |
| 208 | """Mount the rootfs as writable. |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 209 | |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 210 | If the command fails, and error_code_ok is True, and the target dir is not |
| 211 | writable then this function sets self._target_dir_is_still_readonly. |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 212 | |
Mike Frysinger | 02e1e07 | 2013-11-10 22:11:34 -0500 | [diff] [blame] | 213 | Args: |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 214 | error_code_ok: See remote.RemoteAccess.RemoteSh for details. |
| 215 | """ |
Yu-Ju Hong | 7e116ac | 2014-01-03 17:08:26 -0800 | [diff] [blame] | 216 | # TODO: Should migrate to use the remount functions in remote_access. |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 217 | result = self.device.RunCommand(MOUNT_RW_COMMAND, |
| 218 | error_code_ok=error_code_ok, |
| 219 | capture_output=True) |
| 220 | if (result.returncode and |
Mike Frysinger | 74ccd57 | 2015-05-21 21:18:20 -0400 | [diff] [blame] | 221 | not self.device.IsDirWritable(self.options.target_dir)): |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 222 | self._target_dir_is_still_readonly.set() |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 223 | |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 224 | def _GetDeviceInfo(self): |
| 225 | steps = [ |
| 226 | functools.partial(self._GetRemoteDirSize, self.options.target_dir), |
| 227 | functools.partial(self._GetRemoteMountFree, self.options.target_dir) |
| 228 | ] |
| 229 | return_values = parallel.RunParallelSteps(steps, return_values=True) |
| 230 | return DeviceInfo(*return_values) |
| 231 | |
| 232 | def _CheckDeviceFreeSpace(self, device_info): |
| 233 | """See if target device has enough space for Chrome. |
| 234 | |
Mike Frysinger | 02e1e07 | 2013-11-10 22:11:34 -0500 | [diff] [blame] | 235 | Args: |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 236 | device_info: A DeviceInfo named tuple. |
| 237 | """ |
| 238 | effective_free = device_info.target_dir_size + device_info.target_fs_free |
| 239 | staging_size = self._GetStagingDirSize() |
| 240 | if effective_free < staging_size: |
Daniel Erat | 1ae4638 | 2014-08-14 10:23:39 -0700 | [diff] [blame] | 241 | raise DeployFailure( |
| 242 | 'Not enough free space on the device. Required: %s MiB, ' |
| 243 | 'actual: %s MiB.' % (staging_size / 1024, effective_free / 1024)) |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 244 | if device_info.target_fs_free < (100 * 1024): |
| 245 | logging.warning('The device has less than 100MB free. deploy_chrome may ' |
| 246 | 'hang during the transfer.') |
| 247 | |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 248 | def _Deploy(self): |
Justin TerAvest | fac210e | 2017-04-13 11:39:00 -0600 | [diff] [blame] | 249 | old_dbus_checksums = self._GetDBusChecksums() |
| 250 | |
Pawel Osciak | 577773a | 2013-03-05 10:52:12 -0800 | [diff] [blame] | 251 | logging.info('Copying Chrome to %s on device...', self.options.target_dir) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 252 | # Show the output (status) for this command. |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 253 | dest_path = _CHROME_DIR |
Ilja H. Friedel | 0ab63e1 | 2017-03-28 13:29:48 -0700 | [diff] [blame] | 254 | # CopyToDevice will fall back to scp if rsync is corrupted on stateful. |
| 255 | # This does not work for deploy. |
Satoru Takabayashi | ab380bc | 2015-01-15 16:00:41 +0900 | [diff] [blame] | 256 | if not self.device.HasRsync(): |
| 257 | raise DeployFailure( |
David Pursell | cfd5887 | 2015-03-19 09:15:48 -0700 | [diff] [blame] | 258 | 'rsync is not found on the device.\n' |
| 259 | 'Run dev_install on the device to get rsync installed') |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 260 | self.device.CopyToDevice('%s/' % os.path.abspath(self.staging_dir), |
| 261 | self.options.target_dir, |
Steven Bennetts | d57a72a | 2017-03-20 12:54:00 -0700 | [diff] [blame] | 262 | mode='rsync', inplace=True, |
| 263 | debug_level=logging.INFO, |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 264 | verbose=self.options.verbose) |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 265 | |
| 266 | for p in self.copy_paths: |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 267 | if p.mode: |
| 268 | # Set mode if necessary. |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 269 | self.device.RunCommand('chmod %o %s/%s' % ( |
| 270 | p.mode, dest_path, p.src if not p.dest else p.dest)) |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 271 | |
Justin TerAvest | fac210e | 2017-04-13 11:39:00 -0600 | [diff] [blame] | 272 | new_dbus_checksums = self._GetDBusChecksums() |
| 273 | if old_dbus_checksums != new_dbus_checksums: |
Justin TerAvest | e8c827b | 2017-05-19 12:58:35 -0600 | [diff] [blame] | 274 | if self.options.target_dir == _CHROME_DIR: |
| 275 | logging.info('Detected change to D-Bus service files, rebooting.') |
| 276 | self._Reboot() |
| 277 | return |
| 278 | else: |
| 279 | logging.warn('Detected change in D-Bus service files, but target dir ' |
| 280 | 'is not %s. D-Bus changes will not be picked up by ' |
| 281 | 'dbus-daemon at boot time.', _CHROME_DIR) |
Justin TerAvest | fac210e | 2017-04-13 11:39:00 -0600 | [diff] [blame] | 282 | |
Ryan Cui | 82a1f2d | 2013-02-22 17:34:23 -0800 | [diff] [blame] | 283 | if self.options.startui: |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 284 | logging.info('Starting UI...') |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 285 | self.device.RunCommand('start ui') |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 286 | |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 287 | def _CheckConnection(self): |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 288 | try: |
Ryan Cui | 4d6b0db | 2013-02-28 15:13:24 -0800 | [diff] [blame] | 289 | logging.info('Testing connection to the device...') |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 290 | self.device.RunCommand('true') |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 291 | except cros_build_lib.RunCommandError as ex: |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 292 | logging.error('Error connecting to the test device.') |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 293 | raise DeployFailure(ex) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 294 | |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 295 | def _CheckDeployType(self): |
Steve Fung | 63d705d | 2014-03-16 03:14:03 -0700 | [diff] [blame] | 296 | if self.options.build_dir: |
Daniel Erat | 3fd6c7a | 2014-05-02 14:28:31 -0700 | [diff] [blame] | 297 | def BinaryExists(filename): |
| 298 | """Checks if the passed-in file is present in the build directory.""" |
| 299 | return os.path.exists(os.path.join(self.options.build_dir, filename)) |
| 300 | |
Daniel Erat | 9813f0e | 2014-11-12 11:00:28 -0700 | [diff] [blame] | 301 | # Handle non-Chrome deployments. |
| 302 | if not BinaryExists('chrome'): |
Daniel Erat | f53bd3a | 2016-12-02 11:28:36 -0700 | [diff] [blame] | 303 | if BinaryExists('app_shell'): |
Daniel Erat | 9813f0e | 2014-11-12 11:00:28 -0700 | [diff] [blame] | 304 | self.copy_paths = chrome_util.GetCopyPaths('app_shell') |
| 305 | |
Daniel Erat | 3fd6c7a | 2014-05-02 14:28:31 -0700 | [diff] [blame] | 306 | # TODO(derat): Update _Deploy() and remove this after figuring out how |
Daniel Erat | f53bd3a | 2016-12-02 11:28:36 -0700 | [diff] [blame] | 307 | # app_shell should be executed. |
Daniel Erat | 3fd6c7a | 2014-05-02 14:28:31 -0700 | [diff] [blame] | 308 | self.options.startui = False |
| 309 | |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 310 | def _PrepareStagingDir(self): |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 311 | _PrepareStagingDir(self.options, self.tempdir, self.staging_dir, |
| 312 | self.copy_paths, self.chrome_dir) |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 313 | |
Thiago Goncales | 1279331 | 2013-05-23 11:26:17 -0700 | [diff] [blame] | 314 | def _MountTarget(self): |
| 315 | logging.info('Mounting Chrome...') |
| 316 | |
| 317 | # Create directory if does not exist |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 318 | self.device.RunCommand('mkdir -p --mode 0775 %s' % ( |
Mike Frysinger | e65f375 | 2014-12-08 00:46:39 -0500 | [diff] [blame] | 319 | self.options.mount_dir,)) |
Pawel Osciak | fb200f5 | 2014-12-21 13:42:05 +0900 | [diff] [blame] | 320 | # Umount the existing mount on mount_dir if present first |
| 321 | self.device.RunCommand(_UMOUNT_DIR_IF_MOUNTPOINT_CMD % |
| 322 | {'dir': self.options.mount_dir}) |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 323 | self.device.RunCommand(_BIND_TO_FINAL_DIR_CMD % (self.options.target_dir, |
| 324 | self.options.mount_dir)) |
Thiago Goncales | 1279331 | 2013-05-23 11:26:17 -0700 | [diff] [blame] | 325 | # Chrome needs partition to have exec and suid flags set |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 326 | self.device.RunCommand(_SET_MOUNT_FLAGS_CMD % (self.options.mount_dir,)) |
| 327 | |
Justin TerAvest | fac210e | 2017-04-13 11:39:00 -0600 | [diff] [blame] | 328 | def _GetDBusChecksums(self): |
| 329 | """Returns Checksums for D-Bus files deployed with Chrome. |
| 330 | |
| 331 | This is used to determine if a reboot is required after deploying Chrome. |
| 332 | """ |
Justin TerAvest | e8c827b | 2017-05-19 12:58:35 -0600 | [diff] [blame] | 333 | path = os.path.join(_CHROME_DIR, 'dbus/*') |
| 334 | result = self.device.RunCommand('md5sum ' + path, |
Justin TerAvest | fac210e | 2017-04-13 11:39:00 -0600 | [diff] [blame] | 335 | error_code_ok=True) |
| 336 | return result.output |
| 337 | |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 338 | def Cleanup(self): |
| 339 | """Clean up RemoteDevice.""" |
| 340 | if not self.options.staging_only: |
| 341 | self.device.Cleanup() |
Thiago Goncales | 1279331 | 2013-05-23 11:26:17 -0700 | [diff] [blame] | 342 | |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 343 | def Perform(self): |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 344 | self._CheckDeployType() |
| 345 | |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 346 | # If requested, just do the staging step. |
| 347 | if self.options.staging_only: |
| 348 | self._PrepareStagingDir() |
| 349 | return 0 |
| 350 | |
| 351 | # Run setup steps in parallel. If any step fails, RunParallelSteps will |
David James | 48f6b33 | 2013-03-03 20:11:18 -0800 | [diff] [blame] | 352 | # stop printing output at that point, and halt any running steps. |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 353 | steps = [self._GetDeviceInfo, self._CheckConnection, |
| 354 | self._KillProcsIfNeeded, self._MountRootfsAsWritable, |
| 355 | self._PrepareStagingDir] |
Ryan Cui | 7193a7e | 2013-04-26 14:15:19 -0700 | [diff] [blame] | 356 | ret = parallel.RunParallelSteps(steps, halt_on_error=True, |
| 357 | return_values=True) |
| 358 | self._CheckDeviceFreeSpace(ret[0]) |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 359 | |
Robert Flack | 1dc7ea8 | 2014-11-26 13:50:24 -0500 | [diff] [blame] | 360 | # If we're trying to deploy to a dir which is not writable and we failed |
| 361 | # to mark the rootfs as writable, try disabling rootfs verification. |
| 362 | if self._target_dir_is_still_readonly.is_set(): |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 363 | self._DisableRootfsVerification() |
| 364 | |
Thiago Goncales | 1279331 | 2013-05-23 11:26:17 -0700 | [diff] [blame] | 365 | if self.options.mount_dir is not None: |
| 366 | self._MountTarget() |
| 367 | |
David James | 88e6f03 | 2013-03-02 08:13:20 -0800 | [diff] [blame] | 368 | # Actually deploy Chrome to the device. |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 369 | self._Deploy() |
| 370 | |
| 371 | |
Steven Bennetts | da8d9f0 | 2016-09-23 13:25:45 -0700 | [diff] [blame] | 372 | def ValidateStagingFlags(value): |
| 373 | """Convert formatted string to dictionary.""" |
| 374 | return chrome_util.ProcessShellFlags(value) |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 375 | |
| 376 | |
Steven Bennetts | 368c3e5 | 2016-09-23 13:05:21 -0700 | [diff] [blame] | 377 | def ValidateGnArgs(value): |
| 378 | """Convert GN_ARGS-formatted string to dictionary.""" |
| 379 | return gn_helpers.FromGNArgs(value) |
| 380 | |
| 381 | |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 382 | def _CreateParser(): |
| 383 | """Create our custom parser.""" |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 384 | parser = commandline.ArgumentParser(description=__doc__, caching=True) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 385 | |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 386 | # TODO(rcui): Have this use the UI-V2 format of having source and target |
| 387 | # device be specified as positional arguments. |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 388 | parser.add_argument('--force', action='store_true', default=False, |
| 389 | help='Skip all prompts (i.e., for disabling of rootfs ' |
| 390 | 'verification). This may result in the target ' |
| 391 | 'machine being rebooted.') |
Ryan Cui | a0215a7 | 2013-02-14 16:20:45 -0800 | [diff] [blame] | 392 | sdk_board_env = os.environ.get(cros_chrome_sdk.SDKFetcher.SDK_BOARD_ENV) |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 393 | parser.add_argument('--board', default=sdk_board_env, |
| 394 | help="The board the Chrome build is targeted for. When " |
| 395 | "in a 'cros chrome-sdk' shell, defaults to the SDK " |
| 396 | "board.") |
| 397 | parser.add_argument('--build-dir', type='path', |
| 398 | help='The directory with Chrome build artifacts to ' |
| 399 | 'deploy from. Typically of format ' |
| 400 | '<chrome_root>/out/Debug. When this option is used, ' |
Steven Bennetts | da8d9f0 | 2016-09-23 13:25:45 -0700 | [diff] [blame] | 401 | 'the GN_ARGS environment variable must be set.') |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 402 | parser.add_argument('--target-dir', type='path', |
| 403 | default=None, |
| 404 | help='Target directory on device to deploy Chrome into.') |
| 405 | parser.add_argument('-g', '--gs-path', type='gs_path', |
| 406 | help='GS path that contains the chrome to deploy.') |
| 407 | parser.add_argument('--nostartui', action='store_false', dest='startui', |
| 408 | default=True, |
| 409 | help="Don't restart the ui daemon after deployment.") |
| 410 | parser.add_argument('--nostrip', action='store_false', dest='dostrip', |
| 411 | default=True, |
| 412 | help="Don't strip binaries during deployment. Warning: " |
| 413 | 'the resulting binaries will be very large!') |
| 414 | parser.add_argument('-p', '--port', type=int, default=remote.DEFAULT_SSH_PORT, |
| 415 | help='Port of the target device to connect to.') |
| 416 | parser.add_argument('-t', '--to', |
| 417 | help='The IP address of the CrOS device to deploy to.') |
| 418 | parser.add_argument('-v', '--verbose', action='store_true', default=False, |
| 419 | help='Show more debug output.') |
| 420 | parser.add_argument('--mount-dir', type='path', default=None, |
| 421 | help='Deploy Chrome in target directory and bind it ' |
| 422 | 'to the directory specified by this flag.' |
| 423 | 'Any existing mount on this directory will be ' |
| 424 | 'umounted first.') |
| 425 | parser.add_argument('--mount', action='store_true', default=False, |
| 426 | help='Deploy Chrome to default target directory and bind ' |
| 427 | 'it to the default mount directory.' |
| 428 | 'Any existing mount on this directory will be ' |
| 429 | 'umounted first.') |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 430 | |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 431 | group = parser.add_argument_group('Advanced Options') |
| 432 | group.add_argument('-l', '--local-pkg-path', type='path', |
| 433 | help='Path to local chrome prebuilt package to deploy.') |
| 434 | group.add_argument('--sloppy', action='store_true', default=False, |
| 435 | help='Ignore when mandatory artifacts are missing.') |
Steven Bennetts | da8d9f0 | 2016-09-23 13:25:45 -0700 | [diff] [blame] | 436 | group.add_argument('--staging-flags', default=None, type=ValidateStagingFlags, |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 437 | help=('Extra flags to control staging. Valid flags are - ' |
| 438 | '%s' % ', '.join(chrome_util.STAGING_FLAGS))) |
Steven Bennetts | 46a84c3 | 2016-08-12 15:20:46 -0700 | [diff] [blame] | 439 | # TODO(stevenjb): Remove --strict entirely once removed from the ebuild. |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 440 | group.add_argument('--strict', action='store_true', default=False, |
Steven Bennetts | 46a84c3 | 2016-08-12 15:20:46 -0700 | [diff] [blame] | 441 | help='Deprecated. Default behavior is "strict". Use ' |
| 442 | '--sloppy to omit warnings for missing optional ' |
| 443 | 'files.') |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 444 | group.add_argument('--strip-flags', default=None, |
| 445 | help="Flags to call the 'strip' binutil tool with. " |
| 446 | "Overrides the default arguments.") |
| 447 | group.add_argument('--ping', action='store_true', default=False, |
| 448 | help='Ping the device before connection attempt.') |
Achuith Bhandarkar | 2f8352f | 2017-06-02 12:47:18 -0700 | [diff] [blame^] | 449 | group.add_argument('--process-timeout', type=int, |
| 450 | default=KILL_PROC_MAX_WAIT, |
| 451 | help='Timeout for process shutdown.') |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 452 | |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 453 | group = parser.add_argument_group( |
| 454 | 'Metadata Overrides (Advanced)', |
| 455 | description='Provide all of these overrides in order to remove ' |
| 456 | 'dependencies on metadata.json existence.') |
| 457 | group.add_argument('--target-tc', action='store', default=None, |
| 458 | help='Override target toolchain name, e.g. ' |
| 459 | 'x86_64-cros-linux-gnu') |
| 460 | group.add_argument('--toolchain-url', action='store', default=None, |
| 461 | help='Override toolchain url format pattern, e.g. ' |
| 462 | '2014/04/%%(target)s-2014.04.23.220740.tar.xz') |
Aviv Keshet | 1c986f3 | 2014-04-24 13:20:49 -0700 | [diff] [blame] | 463 | |
Steven Bennetts | da8d9f0 | 2016-09-23 13:25:45 -0700 | [diff] [blame] | 464 | # DEPRECATED: --gyp-defines is ignored, but retained for backwards |
| 465 | # compatibility. TODO(stevenjb): Remove once eliminated from the ebuild. |
| 466 | parser.add_argument('--gyp-defines', default=None, type=ValidateStagingFlags, |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 467 | help=argparse.SUPPRESS) |
Steven Bennetts | 368c3e5 | 2016-09-23 13:05:21 -0700 | [diff] [blame] | 468 | |
| 469 | # GN_ARGS (args.gn) used to build Chrome. Influences which files are staged |
| 470 | # when --build-dir is set. Defaults to reading from the GN_ARGS env variable. |
| 471 | # CURRENLY IGNORED, ADDED FOR FORWARD COMPATABILITY. |
| 472 | parser.add_argument('--gn-args', default=None, type=ValidateGnArgs, |
| 473 | help=argparse.SUPPRESS) |
| 474 | |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 475 | # Path of an empty directory to stage chrome artifacts to. Defaults to a |
| 476 | # temporary directory that is removed when the script finishes. If the path |
| 477 | # is specified, then it will not be removed. |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 478 | parser.add_argument('--staging-dir', type='path', default=None, |
| 479 | help=argparse.SUPPRESS) |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 480 | # Only prepare the staging directory, and skip deploying to the device. |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 481 | parser.add_argument('--staging-only', action='store_true', default=False, |
| 482 | help=argparse.SUPPRESS) |
Ryan Cui | 5b7c2ed | 2013-03-18 18:45:46 -0700 | [diff] [blame] | 483 | # Path to a binutil 'strip' tool to strip binaries with. The passed-in path |
| 484 | # is used as-is, and not normalized. Used by the Chrome ebuild to skip |
| 485 | # fetching the SDK toolchain. |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 486 | parser.add_argument('--strip-bin', default=None, help=argparse.SUPPRESS) |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 487 | return parser |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 488 | |
Ryan Cui | e535b17 | 2012-10-19 18:25:03 -0700 | [diff] [blame] | 489 | |
| 490 | def _ParseCommandLine(argv): |
| 491 | """Parse args, and run environment-independent checks.""" |
| 492 | parser = _CreateParser() |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 493 | options = parser.parse_args(argv) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 494 | |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 495 | if not any([options.gs_path, options.local_pkg_path, options.build_dir]): |
| 496 | parser.error('Need to specify either --gs-path, --local-pkg-path, or ' |
Ryan Cui | ef91e70 | 2013-02-04 12:06:36 -0800 | [diff] [blame] | 497 | '--build-dir') |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 498 | if options.build_dir and any([options.gs_path, options.local_pkg_path]): |
| 499 | parser.error('Cannot specify both --build_dir and ' |
| 500 | '--gs-path/--local-pkg-patch') |
Ryan Cui | 686ec05 | 2013-02-12 16:39:41 -0800 | [diff] [blame] | 501 | if options.build_dir and not options.board: |
| 502 | parser.error('--board is required when --build-dir is specified.') |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 503 | if options.gs_path and options.local_pkg_path: |
| 504 | parser.error('Cannot specify both --gs-path and --local-pkg-path') |
| 505 | if not (options.staging_only or options.to): |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 506 | parser.error('Need to specify --to') |
Steven Bennetts | 46a84c3 | 2016-08-12 15:20:46 -0700 | [diff] [blame] | 507 | if options.staging_flags and not options.build_dir: |
| 508 | parser.error('--staging-flags require --build-dir to be set.') |
Steven Bennetts | da8d9f0 | 2016-09-23 13:25:45 -0700 | [diff] [blame] | 509 | |
Steven Bennetts | 46a84c3 | 2016-08-12 15:20:46 -0700 | [diff] [blame] | 510 | if options.strict: |
| 511 | logging.warning('--strict is deprecated.') |
Steven Bennetts | da8d9f0 | 2016-09-23 13:25:45 -0700 | [diff] [blame] | 512 | if options.gyp_defines: |
| 513 | logging.warning('--gyp-defines is deprecated.') |
Thiago Goncales | 1279331 | 2013-05-23 11:26:17 -0700 | [diff] [blame] | 514 | |
| 515 | if options.mount or options.mount_dir: |
| 516 | if not options.target_dir: |
| 517 | options.target_dir = _CHROME_DIR_MOUNT |
| 518 | else: |
| 519 | if not options.target_dir: |
| 520 | options.target_dir = _CHROME_DIR |
| 521 | |
| 522 | if options.mount and not options.mount_dir: |
| 523 | options.mount_dir = _CHROME_DIR |
| 524 | |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 525 | return options |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 526 | |
| 527 | |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 528 | def _PostParseCheck(options): |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 529 | """Perform some usage validation (after we've parsed the arguments). |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 530 | |
| 531 | Args: |
Mike Frysinger | 5fe3f22 | 2016-09-01 00:14:16 -0400 | [diff] [blame] | 532 | options: The options object returned by the cli parser. |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 533 | """ |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 534 | if options.local_pkg_path and not os.path.isfile(options.local_pkg_path): |
| 535 | cros_build_lib.Die('%s is not a file.', options.local_pkg_path) |
| 536 | |
Steven Bennetts | 368c3e5 | 2016-09-23 13:05:21 -0700 | [diff] [blame] | 537 | if not options.gn_args: |
| 538 | gn_env = os.getenv('GN_ARGS') |
| 539 | if gn_env is not None: |
| 540 | options.gn_args = gn_helpers.FromGNArgs(gn_env) |
| 541 | logging.info('GN_ARGS taken from environment: %s', options.gn_args) |
Ryan Cui | b623e7b | 2013-03-14 12:54:11 -0700 | [diff] [blame] | 542 | |
Steven Bennetts | 6060046 | 2016-05-12 10:40:20 -0700 | [diff] [blame] | 543 | if not options.staging_flags: |
| 544 | use_env = os.getenv('USE') |
| 545 | if use_env is not None: |
| 546 | options.staging_flags = ' '.join(set(use_env.split()).intersection( |
| 547 | chrome_util.STAGING_FLAGS)) |
| 548 | logging.info('Staging flags taken from USE in environment: %s', |
| 549 | options.staging_flags) |
| 550 | |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 551 | |
Ryan Cui | 504db72 | 2013-01-22 11:48:01 -0800 | [diff] [blame] | 552 | def _FetchChromePackage(cache_dir, tempdir, gs_path): |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 553 | """Get the chrome prebuilt tarball from GS. |
| 554 | |
Mike Frysinger | 02e1e07 | 2013-11-10 22:11:34 -0500 | [diff] [blame] | 555 | Returns: |
| 556 | Path to the fetched chrome tarball. |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 557 | """ |
David James | 9374aac | 2013-10-08 16:00:17 -0700 | [diff] [blame] | 558 | gs_ctx = gs.GSContext(cache_dir=cache_dir, init_boto=True) |
Mike Frysinger | 7ad4fd6 | 2014-02-11 16:53:56 -0500 | [diff] [blame] | 559 | files = gs_ctx.LS(gs_path) |
Ryan Cui | 4c2d42c | 2013-02-08 16:22:26 -0800 | [diff] [blame] | 560 | files = [found for found in files if |
| 561 | _UrlBaseName(found).startswith('%s-' % constants.CHROME_PN)] |
| 562 | if not files: |
| 563 | raise Exception('No chrome package found at %s' % gs_path) |
| 564 | elif len(files) > 1: |
| 565 | # - Users should provide us with a direct link to either a stripped or |
| 566 | # unstripped chrome package. |
| 567 | # - In the case of being provided with an archive directory, where both |
| 568 | # stripped and unstripped chrome available, use the stripped chrome |
| 569 | # package. |
| 570 | # - Stripped chrome pkg is chromeos-chrome-<version>.tar.gz |
| 571 | # - Unstripped chrome pkg is chromeos-chrome-<version>-unstripped.tar.gz. |
| 572 | files = [f for f in files if not 'unstripped' in f] |
| 573 | assert len(files) == 1 |
| 574 | logging.warning('Multiple chrome packages found. Using %s', files[0]) |
Ryan Cui | 777ff42 | 2012-12-07 13:12:54 -0800 | [diff] [blame] | 575 | |
Ryan Cui | 4c2d42c | 2013-02-08 16:22:26 -0800 | [diff] [blame] | 576 | filename = _UrlBaseName(files[0]) |
Ryan Cui | 4d6b0db | 2013-02-28 15:13:24 -0800 | [diff] [blame] | 577 | logging.info('Fetching %s...', filename) |
Ryan Cui | 4c2d42c | 2013-02-08 16:22:26 -0800 | [diff] [blame] | 578 | gs_ctx.Copy(files[0], tempdir, print_cmd=False) |
| 579 | chrome_path = os.path.join(tempdir, filename) |
| 580 | assert os.path.exists(chrome_path) |
| 581 | return chrome_path |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 582 | |
| 583 | |
Ryan Cui | f890a3e | 2013-03-07 18:57:06 -0800 | [diff] [blame] | 584 | @contextlib.contextmanager |
| 585 | def _StripBinContext(options): |
| 586 | if not options.dostrip: |
| 587 | yield None |
| 588 | elif options.strip_bin: |
| 589 | yield options.strip_bin |
| 590 | else: |
Ryan Cui | a0215a7 | 2013-02-14 16:20:45 -0800 | [diff] [blame] | 591 | sdk = cros_chrome_sdk.SDKFetcher(options.cache_dir, options.board) |
Ryan Cui | 686ec05 | 2013-02-12 16:39:41 -0800 | [diff] [blame] | 592 | components = (sdk.TARGET_TOOLCHAIN_KEY, constants.CHROME_ENV_TAR) |
Aviv Keshet | 1c986f3 | 2014-04-24 13:20:49 -0700 | [diff] [blame] | 593 | with sdk.Prepare(components=components, target_tc=options.target_tc, |
| 594 | toolchain_url=options.toolchain_url) as ctx: |
Ryan Cui | 686ec05 | 2013-02-12 16:39:41 -0800 | [diff] [blame] | 595 | env_path = os.path.join(ctx.key_map[constants.CHROME_ENV_TAR].path, |
| 596 | constants.CHROME_ENV_FILE) |
| 597 | strip_bin = osutils.SourceEnvironment(env_path, ['STRIP'])['STRIP'] |
| 598 | strip_bin = os.path.join(ctx.key_map[sdk.TARGET_TOOLCHAIN_KEY].path, |
| 599 | 'bin', os.path.basename(strip_bin)) |
Ryan Cui | f890a3e | 2013-03-07 18:57:06 -0800 | [diff] [blame] | 600 | yield strip_bin |
| 601 | |
| 602 | |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 603 | def _PrepareStagingDir(options, tempdir, staging_dir, copy_paths=None, |
| 604 | chrome_dir=_CHROME_DIR): |
Ryan Cui | f890a3e | 2013-03-07 18:57:06 -0800 | [diff] [blame] | 605 | """Place the necessary files in the staging directory. |
| 606 | |
| 607 | The staging directory is the directory used to rsync the build artifacts over |
| 608 | to the device. Only the necessary Chrome build artifacts are put into the |
| 609 | staging directory. |
| 610 | """ |
Ryan Cui | 5866be0 | 2013-03-18 14:12:00 -0700 | [diff] [blame] | 611 | osutils.SafeMakedirs(staging_dir) |
Mike Frysinger | 60ec101 | 2013-10-21 00:11:10 -0400 | [diff] [blame] | 612 | os.chmod(staging_dir, 0o755) |
Ryan Cui | f890a3e | 2013-03-07 18:57:06 -0800 | [diff] [blame] | 613 | if options.build_dir: |
| 614 | with _StripBinContext(options) as strip_bin: |
Ryan Cui | 5b7c2ed | 2013-03-18 18:45:46 -0700 | [diff] [blame] | 615 | strip_flags = (None if options.strip_flags is None else |
| 616 | shlex.split(options.strip_flags)) |
Ryan Cui | 686ec05 | 2013-02-12 16:39:41 -0800 | [diff] [blame] | 617 | chrome_util.StageChromeFromBuildDir( |
Steven Bennetts | 46a84c3 | 2016-08-12 15:20:46 -0700 | [diff] [blame] | 618 | staging_dir, options.build_dir, strip_bin, |
Steven Bennetts | da8d9f0 | 2016-09-23 13:25:45 -0700 | [diff] [blame] | 619 | sloppy=options.sloppy, gn_args=options.gn_args, |
Ryan Cui | 5b7c2ed | 2013-03-18 18:45:46 -0700 | [diff] [blame] | 620 | staging_flags=options.staging_flags, |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 621 | strip_flags=strip_flags, copy_paths=copy_paths) |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 622 | else: |
| 623 | pkg_path = options.local_pkg_path |
| 624 | if options.gs_path: |
Ryan Cui | 504db72 | 2013-01-22 11:48:01 -0800 | [diff] [blame] | 625 | pkg_path = _FetchChromePackage(options.cache_dir, tempdir, |
| 626 | options.gs_path) |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 627 | |
| 628 | assert pkg_path |
Ryan Cui | 4d6b0db | 2013-02-28 15:13:24 -0800 | [diff] [blame] | 629 | logging.info('Extracting %s...', pkg_path) |
Ryan Cui | 5866be0 | 2013-03-18 14:12:00 -0700 | [diff] [blame] | 630 | # Extract only the ./opt/google/chrome contents, directly into the staging |
| 631 | # dir, collapsing the directory hierarchy. |
Steve Fung | e984a53 | 2013-11-25 17:09:25 -0800 | [diff] [blame] | 632 | if pkg_path[-4:] == '.zip': |
| 633 | cros_build_lib.DebugRunCommand( |
| 634 | ['unzip', '-X', pkg_path, _ANDROID_DIR_EXTRACT_PATH, '-d', |
| 635 | staging_dir]) |
| 636 | for filename in glob.glob(os.path.join(staging_dir, 'system/chrome/*')): |
| 637 | shutil.move(filename, staging_dir) |
| 638 | osutils.RmDir(os.path.join(staging_dir, 'system'), ignore_missing=True) |
| 639 | else: |
| 640 | cros_build_lib.DebugRunCommand( |
| 641 | ['tar', '--strip-components', '4', '--extract', |
| 642 | '--preserve-permissions', '--file', pkg_path, '.%s' % chrome_dir], |
| 643 | cwd=staging_dir) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 644 | |
Ryan Cui | 71aa8de | 2013-04-19 16:12:55 -0700 | [diff] [blame] | 645 | |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 646 | def main(argv): |
Mike Frysinger | c3061a6 | 2015-06-04 04:16:18 -0400 | [diff] [blame] | 647 | options = _ParseCommandLine(argv) |
| 648 | _PostParseCheck(options) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 649 | |
| 650 | # Set cros_build_lib debug level to hide RunCommand spew. |
| 651 | if options.verbose: |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 652 | logging.getLogger().setLevel(logging.DEBUG) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 653 | else: |
Ryan Cui | 4d6b0db | 2013-02-28 15:13:24 -0800 | [diff] [blame] | 654 | logging.getLogger().setLevel(logging.INFO) |
Ryan Cui | 3045c5d | 2012-07-13 18:00:33 -0700 | [diff] [blame] | 655 | |
Aviv Keshet | 01a82e9 | 2017-03-02 17:39:59 -0800 | [diff] [blame] | 656 | with osutils.TempDir(set_global=True) as tempdir: |
| 657 | staging_dir = options.staging_dir |
| 658 | if not staging_dir: |
| 659 | staging_dir = os.path.join(tempdir, 'chrome') |
Ryan Cui | a56a71e | 2012-10-18 18:40:35 -0700 | [diff] [blame] | 660 | |
Aviv Keshet | 01a82e9 | 2017-03-02 17:39:59 -0800 | [diff] [blame] | 661 | deploy = DeployChrome(options, tempdir, staging_dir) |
| 662 | try: |
| 663 | deploy.Perform() |
| 664 | except failures_lib.StepFailure as ex: |
| 665 | raise SystemExit(str(ex).strip()) |
| 666 | deploy.Cleanup() |