You-Cheng Syu | d569294 | 2018-01-04 14:40:59 +0800 | [diff] [blame] | 1 | #!/usr/bin/env python |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 2 | # |
Hung-Te Lin | 1990b74 | 2017-08-09 17:34:57 +0800 | [diff] [blame] | 3 | # Copyright 2014 The Chromium OS Authors. All rights reserved. |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 4 | # Use of this source code is governed by a BSD-style license that can be |
| 5 | # found in the LICENSE file. |
| 6 | |
| 7 | """Factory toolkit installer. |
| 8 | |
| 9 | The factory toolkit is a self-extracting shellball containing factory test |
| 10 | related files and this installer. This installer is invoked when the toolkit |
| 11 | is deployed and is responsible for installing files. |
| 12 | """ |
| 13 | |
| 14 | |
| 15 | import argparse |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 16 | from contextlib import contextmanager |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 17 | import getpass |
Hung-Te Lin | eb7632b | 2016-07-29 15:38:34 +0800 | [diff] [blame] | 18 | import glob |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 19 | import os |
Wei-Ning Huang | 4855e79 | 2015-06-11 15:33:39 +0800 | [diff] [blame] | 20 | import shutil |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 21 | import sys |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 22 | import tempfile |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 23 | import time |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 24 | |
You-Cheng Syu | 70e99ad | 2017-03-09 17:15:00 +0800 | [diff] [blame] | 25 | import factory_common # pylint: disable=unused-import |
Wei-Han Chen | 2ebb92d | 2016-01-12 14:51:41 +0800 | [diff] [blame] | 26 | from cros.factory.test.env import paths |
Jon Salz | 2559030 | 2014-07-11 16:07:20 +0800 | [diff] [blame] | 27 | from cros.factory.tools import install_symlinks |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 28 | from cros.factory.utils import file_utils |
Yong Hong | 89938e6 | 2018-10-26 11:59:21 +0800 | [diff] [blame^] | 29 | from cros.factory.utils import json_utils |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 30 | from cros.factory.utils.process_utils import Spawn |
Peter Shih | fe22158 | 2017-06-15 13:40:53 +0800 | [diff] [blame] | 31 | from cros.factory.utils import sys_utils |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 32 | |
| 33 | |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 34 | INSTALLER_PATH = 'usr/local/factory/py/toolkit/installer.py' |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 35 | VERSION_PATH = 'usr/local/factory/TOOLKIT_VERSION' |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 36 | |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 37 | # Short and sweet help header for the executable generated by makeself. |
| 38 | HELP_HEADER = """ |
| 39 | Installs the factory toolkit, transforming a test image into a factory test |
| 40 | image. You can: |
| 41 | |
| 42 | - Install the factory toolkit on a CrOS device that is running a test |
| 43 | image. To do this, copy install_factory_toolkit.run to the device and |
| 44 | run it. The factory tests will then come up on the next boot. |
| 45 | |
| 46 | rsync -a install_factory_toolkit.run crosdevice:/tmp |
| 47 | ssh crosdevice '/tmp/install_factory_toolkit.run && sync && reboot' |
| 48 | |
| 49 | - Modify a test image, turning it into a factory test image. When you |
| 50 | use the image on a device, the factory tests will come up. |
| 51 | |
| 52 | install_factory_toolkit.run chromiumos_test_image.bin |
| 53 | """ |
| 54 | |
| 55 | HELP_HEADER_ADVANCED = """ |
| 56 | - (advanced) Modify a mounted stateful partition, turning it into a factory |
| 57 | test image. This is equivalent to the previous command: |
| 58 | |
| 59 | mount_partition -rw chromiumos_test_image.bin 1 /mnt/stateful |
| 60 | install_factory_toolkit.run /mnt/stateful |
| 61 | umount /mnt/stateful |
| 62 | |
| 63 | - (advanced) Unpack the factory toolkit, modify a file, and then repack it. |
| 64 | |
| 65 | # Unpack but don't actually install |
| 66 | install_factory_toolkit.run --target /tmp/toolkit --noexec |
| 67 | # Edit some files in /tmp/toolkit |
| 68 | emacs /tmp/toolkit/whatever |
| 69 | # Repack |
| 70 | install_factory_toolkit.run -- --repack /tmp/toolkit \\ |
| 71 | --pack-into /path/to/new/install_factory_toolkit.run |
| 72 | """ |
| 73 | |
| 74 | # The makeself-generated header comes next. This is a little confusing, |
| 75 | # so explain. |
| 76 | HELP_HEADER_MAKESELF = """ |
| 77 | For complete usage information and advanced operations, run |
| 78 | "install_factory_toolkit.run -- --help" (note the extra "--"). |
| 79 | |
| 80 | Following is the help message from makeself, which was used to create |
| 81 | this self-extracting archive. |
| 82 | |
| 83 | ----- |
| 84 | """ |
| 85 | |
Vic Yang | db1e20e | 2014-10-05 12:10:33 +0800 | [diff] [blame] | 86 | SERVER_FILE_MASK = [ |
| 87 | # Exclude Umpire server but keep Umpire client |
| 88 | '--include', 'py/umpire/__init__.*', |
| 89 | '--include', 'py/umpire/common.*', |
| 90 | '--include', 'py/umpire/client', |
| 91 | '--include', 'py/umpire/client/**', |
| 92 | '--exclude', 'py/umpire/**', |
Peter Shih | ac90478 | 2017-06-14 15:24:09 +0800 | [diff] [blame] | 93 | '--exclude', 'bin/umpire', |
| 94 | '--exclude', 'bin/umpired', |
Vic Yang | db1e20e | 2014-10-05 12:10:33 +0800 | [diff] [blame] | 95 | ] |
| 96 | |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 97 | |
Hung-Te Lin | 7b596ff | 2015-01-16 20:19:15 +0800 | [diff] [blame] | 98 | class FactoryToolkitInstaller(object): |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 99 | """Factory toolkit installer. |
| 100 | |
| 101 | Args: |
| 102 | src: Source path containing usr/ and var/. |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 103 | dest: Installation destination path. Set this to the mount point of the |
| 104 | stateful partition if patching a test image. |
| 105 | no_enable: True to not install the tag file. |
| 106 | system_root: The path to the root of the file system. This must be left |
| 107 | as its default value except for unit testing. |
Peter Shih | 2f1f8c4 | 2017-06-15 15:05:55 +0800 | [diff] [blame] | 108 | apps: The list of apps to enable/disable under factory/init/main.d/. |
| 109 | active_test_list: The id of active test list for Goofy. |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 110 | """ |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 111 | |
Jon Salz | b7e4426 | 2014-05-07 15:53:37 +0800 | [diff] [blame] | 112 | # Whether to sudo when rsyncing; set to False for testing. |
| 113 | _sudo = True |
| 114 | |
Hung-Te Lin | fc162e6 | 2017-09-21 00:45:04 +0800 | [diff] [blame] | 115 | def __init__(self, src, dest, no_enable, non_cros=False, system_root='/', |
Peter Shih | 2f1f8c4 | 2017-06-15 15:05:55 +0800 | [diff] [blame] | 116 | apps=None, active_test_list=None): |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 117 | self._src = src |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 118 | self._system_root = system_root |
| 119 | if dest == self._system_root: |
| 120 | self._usr_local_dest = os.path.join(dest, 'usr', 'local') |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 121 | |
| 122 | # Make sure we're on a CrOS device. |
Hung-Te Lin | f5f2d7f | 2016-01-08 17:12:46 +0800 | [diff] [blame] | 123 | if not non_cros and not sys_utils.InCrOSDevice(): |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 124 | sys.stderr.write( |
Vic Yang | 196d524 | 2014-08-05 13:51:35 +0800 | [diff] [blame] | 125 | "ERROR: You're not on a CrOS device (for more details, please\n" |
Hung-Te Lin | f5f2d7f | 2016-01-08 17:12:46 +0800 | [diff] [blame] | 126 | 'check sys_utils.py:InCrOSDevice), so you must specify a test\n' |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 127 | 'image or a mounted stateful partition on which to install the\n' |
| 128 | 'factory toolkit. Please run\n' |
| 129 | '\n' |
| 130 | ' install_factory_toolkit.run -- --help\n' |
| 131 | '\n' |
Vic Yang | 70fdae9 | 2015-02-17 19:21:08 -0800 | [diff] [blame] | 132 | 'for help.\n' |
| 133 | '\n' |
Hung-Te Lin | fc162e6 | 2017-09-21 00:45:04 +0800 | [diff] [blame] | 134 | 'If you want to install on a non-CrOS host,\n' |
Vic Yang | 70fdae9 | 2015-02-17 19:21:08 -0800 | [diff] [blame] | 135 | 'please run\n' |
| 136 | '\n' |
Hung-Te Lin | fc162e6 | 2017-09-21 00:45:04 +0800 | [diff] [blame] | 137 | ' install_factory_toolkit.run -- --non-cros \n' |
Vic Yang | 70fdae9 | 2015-02-17 19:21:08 -0800 | [diff] [blame] | 138 | '\n') |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 139 | sys.exit(1) |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 140 | if os.getuid() != 0: |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 141 | raise Exception('You must be root to install the factory toolkit on a ' |
| 142 | 'CrOS device.') |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 143 | else: |
| 144 | self._usr_local_dest = os.path.join(dest, 'dev_image') |
Hung-Te Lin | 4aeabe6 | 2016-10-21 15:45:20 +0800 | [diff] [blame] | 145 | if not os.path.exists(self._usr_local_dest): |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 146 | raise Exception( |
| 147 | 'The destination path %s is not a stateful partition!' % dest) |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 148 | |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 149 | self._dest = dest |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 150 | self._usr_local_src = os.path.join(src, 'usr', 'local') |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 151 | self._no_enable = no_enable |
Vic (Chun-Ju) Yang | 7cc3e67 | 2014-01-20 14:06:39 +0800 | [diff] [blame] | 152 | self._tag_file = os.path.join(self._usr_local_dest, 'factory', 'enabled') |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 153 | |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 154 | self._apps = apps |
Peter Shih | 2f1f8c4 | 2017-06-15 15:05:55 +0800 | [diff] [blame] | 155 | self._active_test_list = active_test_list |
Vic Yang | 7039f42 | 2014-07-07 15:38:13 -0700 | [diff] [blame] | 156 | |
Hung-Te Lin | 4aeabe6 | 2016-10-21 15:45:20 +0800 | [diff] [blame] | 157 | if not os.path.exists(self._usr_local_src): |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 158 | raise Exception( |
| 159 | 'This installer must be run from within the factory toolkit!') |
| 160 | |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 161 | def WarningMessage(self, target_test_image=None): |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 162 | ret = file_utils.ReadFile(os.path.join(self._src, VERSION_PATH)) |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 163 | if target_test_image: |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 164 | ret += ( |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 165 | '\n' |
| 166 | '\n' |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 167 | '*** You are about to patch the factory toolkit into:\n' |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 168 | '*** %s\n' |
| 169 | '***' % target_test_image) |
| 170 | else: |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 171 | ret += ( |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 172 | '\n' |
| 173 | '\n' |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 174 | '*** You are about to install the factory toolkit to:\n' |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 175 | '*** %s\n' |
| 176 | '***' % self._dest) |
| 177 | if self._dest == self._system_root: |
Vic (Chun-Ju) Yang | 7cc3e67 | 2014-01-20 14:06:39 +0800 | [diff] [blame] | 178 | if self._no_enable: |
Hung-Te Lin | 7b596ff | 2015-01-16 20:19:15 +0800 | [diff] [blame] | 179 | ret += ('\n*** Factory tests will be disabled after this process is ' |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 180 | 'done, but\n*** you can enable them by creating the factory ' |
| 181 | 'enabled tag:\n*** %s\n***' % self._tag_file) |
Vic (Chun-Ju) Yang | 7cc3e67 | 2014-01-20 14:06:39 +0800 | [diff] [blame] | 182 | else: |
Hung-Te Lin | 7b596ff | 2015-01-16 20:19:15 +0800 | [diff] [blame] | 183 | ret += ('\n*** After this process is done, your device will start ' |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 184 | 'factory\n*** tests on the next reboot.\n***\n*** Factory ' |
| 185 | 'tests can be disabled by deleting the factory enabled\n*** ' |
| 186 | 'tag:\n*** %s\n***' % self._tag_file) |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 187 | return ret |
| 188 | |
Vic Yang | 7039f42 | 2014-07-07 15:38:13 -0700 | [diff] [blame] | 189 | def _SetTagFile(self, name, path, enabled): |
| 190 | """Install or remove a tag file.""" |
| 191 | if enabled: |
| 192 | print '*** Installing %s enabled tag...' % name |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 193 | Spawn(['touch', path], sudo=True, log=True, check_call=True) |
| 194 | Spawn(['chmod', 'go+r', path], sudo=True, log=True, check_call=True) |
Vic Yang | 7039f42 | 2014-07-07 15:38:13 -0700 | [diff] [blame] | 195 | else: |
| 196 | print '*** Removing %s enabled tag...' % name |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 197 | Spawn(['rm', '-f', path], sudo=True, log=True, check_call=True) |
Vic Yang | 7039f42 | 2014-07-07 15:38:13 -0700 | [diff] [blame] | 198 | |
Peter Shih | 2f1f8c4 | 2017-06-15 15:05:55 +0800 | [diff] [blame] | 199 | def _SetActiveTestList(self): |
| 200 | """Set the active test list for Goofy.""" |
| 201 | if self._active_test_list is not None: |
Yong Hong | 89938e6 | 2018-10-26 11:59:21 +0800 | [diff] [blame^] | 202 | path = os.path.join(self._usr_local_dest, 'factory', 'py', 'config', |
| 203 | 'active_test_list.json') |
| 204 | json_utils.DumpFile(path, {'id': self._active_test_list}) |
Peter Shih | 2f1f8c4 | 2017-06-15 15:05:55 +0800 | [diff] [blame] | 205 | |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 206 | def _EnableApp(self, app, enabled): |
| 207 | """Enable / disable @app. |
| 208 | |
| 209 | In factory/init/startup, a main app is considered disabled if and only: |
| 210 | 1. file "factory/init/main.d/disable-@app" exists OR |
| 211 | 2. file "factory/init/main.d/enable-@app" doesn't exist AND |
| 212 | file "factory/init/main.d/@app.sh" is not executable. |
| 213 | |
| 214 | Therefore, we enable an app by removing file "disable-@app" and creating |
You-Cheng Syu | 70e99ad | 2017-03-09 17:15:00 +0800 | [diff] [blame] | 215 | file "enable-@app", and vice versa. |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 216 | """ |
| 217 | app_enable = os.path.join(self._usr_local_dest, |
| 218 | 'factory', 'init', 'main.d', 'enable-' + app) |
| 219 | app_disable = os.path.join(self._usr_local_dest, |
| 220 | 'factory', 'init', 'main.d', 'disable-' + app) |
| 221 | if enabled: |
| 222 | print '*** Enabling {app} ***'.format(app=app) |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 223 | Spawn(['rm', '-f', app_disable], sudo=self._sudo, log=True, |
| 224 | check_call=True) |
| 225 | Spawn(['touch', app_enable], sudo=self._sudo, log=True, check_call=True) |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 226 | else: |
| 227 | print '*** Disabling {app} ***'.format(app=app) |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 228 | Spawn(['touch', app_disable], sudo=self._sudo, log=True, check_call=True) |
| 229 | Spawn(['rm', '-f', app_enable], sudo=self._sudo, log=True, |
| 230 | check_call=True) |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 231 | |
| 232 | def _EnableApps(self): |
| 233 | if not self._apps: |
| 234 | return |
| 235 | |
| 236 | app_list = [] |
| 237 | for app in self._apps: |
| 238 | if app[0] == '+': |
| 239 | app_list.append((app[1:], True)) |
| 240 | elif app[0] == '-': |
| 241 | app_list.append((app[1:], False)) |
| 242 | else: |
| 243 | raise ValueError( |
| 244 | 'Use +{app} to enable and -{app} to disable'.format(app=app)) |
| 245 | |
| 246 | for app, enabled in app_list: |
| 247 | self._EnableApp(app, enabled) |
| 248 | |
Wei-Han Chen | 7137dcf | 2016-08-03 15:43:22 +0800 | [diff] [blame] | 249 | def InstallFactorySubDir(self, sub_dirs): |
| 250 | """Install only the specified directories under factory folder.""" |
| 251 | |
| 252 | def _InstallOneSubDir(sub_dir_name): |
| 253 | sub_dir_dest = os.path.join(self._usr_local_dest, 'factory', sub_dir_name) |
| 254 | sub_dir_src = os.path.join(self._src, 'usr', 'local', 'factory', |
| 255 | sub_dir_name) |
| 256 | try: |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 257 | Spawn(['mkdir', '-p', sub_dir_dest], sudo=True, log=True, |
| 258 | check_call=True) |
Wei-Han Chen | 7137dcf | 2016-08-03 15:43:22 +0800 | [diff] [blame] | 259 | except OSError as e: |
| 260 | print str(e) |
| 261 | return |
| 262 | |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 263 | Spawn(['rsync', '-a', '--force', '-v', |
| 264 | sub_dir_src + '/', sub_dir_dest], |
| 265 | sudo=self._sudo, log=True, check_call=True) |
| 266 | Spawn(['chown', '-R', 'root', sub_dir_dest], |
| 267 | sudo=self._sudo, log=True, check_call=True) |
| 268 | Spawn(['chmod', '-R', 'go+rX', sub_dir_dest], |
| 269 | sudo=self._sudo, log=True, check_call=True) |
Wei-Han Chen | 7137dcf | 2016-08-03 15:43:22 +0800 | [diff] [blame] | 270 | |
| 271 | for sub_dir_name in sub_dirs: |
| 272 | _InstallOneSubDir(sub_dir_name) |
| 273 | |
| 274 | self._SetTagFile('factory', self._tag_file, not self._no_enable) |
| 275 | self._EnableApps() |
| 276 | |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 277 | def Install(self): |
| 278 | print '*** Installing factory toolkit...' |
Mao Huang | f75aa3e | 2016-11-24 11:44:17 +0800 | [diff] [blame] | 279 | |
| 280 | # --no-owner and --no-group will set owner/group to the current user/group |
| 281 | # running the command. This is important if we're running with sudo, so |
| 282 | # the destination will be changed to root/root instead of the user/group |
| 283 | # before sudo (doesn't matter if sudo is not present). --force is also |
| 284 | # necessary to allow goofy directory from prior toolkit installations to |
| 285 | # be overwritten by the goofy symlink. |
| 286 | print '*** %s -> %s' % (self._usr_local_src, self._usr_local_dest) |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 287 | Spawn(['rsync', '-a', '--no-owner', '--no-group', '--chmod=ugo+rX', |
| 288 | '--force'] + SERVER_FILE_MASK + [self._usr_local_src + '/', |
| 289 | self._usr_local_dest], |
| 290 | sudo=self._sudo, log=True, check_output=True, cwd=self._usr_local_src) |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 291 | |
Hung-Te Lin | eb7632b | 2016-07-29 15:38:34 +0800 | [diff] [blame] | 292 | print '*** Ensure SSH keys file permission...' |
| 293 | sshkeys_dir = os.path.join(self._usr_local_dest, 'factory/misc/sshkeys') |
| 294 | sshkeys = glob.glob(os.path.join(sshkeys_dir, '*')) |
| 295 | ssh_public_keys = glob.glob(os.path.join(sshkeys_dir, '*.pub')) |
| 296 | ssh_private_keys = list(set(sshkeys) - set(ssh_public_keys)) |
| 297 | if ssh_private_keys: |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 298 | Spawn(['chmod', '600'] + ssh_private_keys, log=True, check_call=True, |
| 299 | sudo=self._sudo) |
Hung-Te Lin | eb7632b | 2016-07-29 15:38:34 +0800 | [diff] [blame] | 300 | |
Jon Salz | 2559030 | 2014-07-11 16:07:20 +0800 | [diff] [blame] | 301 | print '*** Installing symlinks...' |
| 302 | install_symlinks.InstallSymlinks( |
| 303 | '../factory/bin', |
| 304 | os.path.join(self._usr_local_dest, 'bin'), |
| 305 | install_symlinks.MODE_FULL, |
| 306 | sudo=self._sudo) |
| 307 | |
Vic Yang | 7039f42 | 2014-07-07 15:38:13 -0700 | [diff] [blame] | 308 | self._SetTagFile('factory', self._tag_file, not self._no_enable) |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 309 | |
Peter Shih | 2f1f8c4 | 2017-06-15 15:05:55 +0800 | [diff] [blame] | 310 | self._SetActiveTestList() |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 311 | self._EnableApps() |
Wei-Ning Huang | 5135b7e | 2015-07-03 17:31:15 +0800 | [diff] [blame] | 312 | |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 313 | print '*** Installation completed.' |
| 314 | |
| 315 | |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 316 | @contextmanager |
| 317 | def DummyContext(arg): |
| 318 | """A context manager that simply yields its argument.""" |
| 319 | yield arg |
| 320 | |
| 321 | |
Vic (Chun-Ju) Yang | 98b4fbc | 2014-02-18 19:32:32 +0800 | [diff] [blame] | 322 | def PrintBuildInfo(src_root): |
| 323 | """Print build information.""" |
| 324 | info_file = os.path.join(src_root, 'REPO_STATUS') |
| 325 | if not os.path.exists(info_file): |
| 326 | raise OSError('Build info file not found!') |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 327 | print file_utils.ReadFile(info_file) |
Vic (Chun-Ju) Yang | 98b4fbc | 2014-02-18 19:32:32 +0800 | [diff] [blame] | 328 | |
| 329 | |
Hung-Te Lin | fc162e6 | 2017-09-21 00:45:04 +0800 | [diff] [blame] | 330 | def PackFactoryToolkit(src_root, output_path, initial_version): |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 331 | """Packs the files containing this script into a factory toolkit.""" |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 332 | if initial_version is None: |
| 333 | complete_version = '%s repacked by %s@%s at %s\n' % ( |
| 334 | file_utils.ReadFile(os.path.join(src_root, VERSION_PATH)), |
| 335 | getpass.getuser(), os.uname()[1], time.strftime('%Y-%m-%d %H:%M:%S')) |
| 336 | initial_version = complete_version.splitlines()[0] |
| 337 | else: |
| 338 | complete_version = initial_version + '\n' |
| 339 | modified_times = len(complete_version.splitlines()) - 1 |
| 340 | if modified_times == 0: |
| 341 | modified_msg = '' |
| 342 | else: |
| 343 | modified_msg = ' (modified %d times)' % modified_times |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 344 | with tempfile.NamedTemporaryFile() as help_header: |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 345 | help_header.write(initial_version + '\n' + |
| 346 | HELP_HEADER + HELP_HEADER_MAKESELF) |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 347 | help_header.flush() |
Wei-Ning Huang | b723d7f | 2014-11-17 17:26:32 +0800 | [diff] [blame] | 348 | cmd = [os.path.join(src_root, 'makeself.sh'), '--bzip2', '--nox11', |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 349 | '--help-header', help_header.name, |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 350 | src_root, output_path, initial_version + modified_msg, |
| 351 | INSTALLER_PATH, '--in-exe'] |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 352 | Spawn(cmd, check_call=True, log=True) |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 353 | with file_utils.TempDirectory() as tmp_dir: |
| 354 | version_path = os.path.join(tmp_dir, VERSION_PATH) |
| 355 | os.makedirs(os.path.dirname(version_path)) |
| 356 | file_utils.WriteFile(version_path, complete_version) |
You-Cheng Syu | c068273 | 2017-05-10 12:17:05 +0800 | [diff] [blame] | 357 | Spawn([cmd[0], '--lsm', version_path, '--append', tmp_dir, output_path], |
| 358 | check_call=True, log=True) |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 359 | print ('\n' |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 360 | ' Factory toolkit generated at %s.\n' |
| 361 | '\n' |
| 362 | ' To install factory toolkit on a live device running a test image,\n' |
| 363 | ' copy this to the device and execute it as root.\n' |
| 364 | '\n' |
| 365 | ' Alternatively, the factory toolkit can be used to patch a test\n' |
| 366 | ' image. For more information, run:\n' |
| 367 | ' %s --help\n' |
| 368 | '\n' % (output_path, output_path)) |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 369 | |
| 370 | |
Wei-Ning Huang | 4855e79 | 2015-06-11 15:33:39 +0800 | [diff] [blame] | 371 | def ExtractOverlord(src_root, output_dir): |
| 372 | output_dir = os.path.join(output_dir, 'overlord') |
| 373 | try: |
| 374 | os.makedirs(output_dir) |
| 375 | except OSError as e: |
| 376 | print str(e) |
| 377 | return |
| 378 | |
| 379 | # Copy overlord binary and resource files |
| 380 | shutil.copyfile(os.path.join(src_root, 'usr/bin/overlordd'), |
| 381 | os.path.join(output_dir, 'overlordd')) |
| 382 | shutil.copytree(os.path.join(src_root, 'usr/share/overlord/app'), |
| 383 | os.path.join(output_dir, 'app')) |
| 384 | |
| 385 | # Give overlordd execution permission |
Peter Shih | e6afab3 | 2018-09-11 17:16:48 +0800 | [diff] [blame] | 386 | os.chmod(os.path.join(output_dir, 'overlordd'), 0o755) |
You-Cheng Syu | 70e99ad | 2017-03-09 17:15:00 +0800 | [diff] [blame] | 387 | print "Extracted overlord under '%s'" % output_dir |
Wei-Ning Huang | 4855e79 | 2015-06-11 15:33:39 +0800 | [diff] [blame] | 388 | |
| 389 | |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 390 | def main(): |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 391 | import logging |
| 392 | logging.basicConfig(level=logging.INFO) |
| 393 | |
| 394 | # In order to determine which usage message to show, first determine |
| 395 | # whether we're in the self-extracting archive. Do this first |
| 396 | # because we need it to even parse the arguments. |
| 397 | if '--in-exe' in sys.argv: |
| 398 | sys.argv = [x for x in sys.argv if x != '--in-exe'] |
| 399 | in_archive = True |
| 400 | else: |
| 401 | in_archive = False |
| 402 | |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 403 | parser = argparse.ArgumentParser( |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 404 | description=HELP_HEADER + HELP_HEADER_ADVANCED, |
| 405 | usage=('install_factory_toolkit.run -- [options]' if in_archive |
| 406 | else None), |
| 407 | formatter_class=argparse.RawDescriptionHelpFormatter) |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 408 | parser.add_argument( |
| 409 | 'dest', nargs='?', default='/', |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 410 | help='A test image or the mount point of the stateful partition. ' |
| 411 | "If omitted, install to live system, i.e. '/'.") |
Vic (Chun-Ju) Yang | 7cc3e67 | 2014-01-20 14:06:39 +0800 | [diff] [blame] | 412 | parser.add_argument('--no-enable', '-n', action='store_true', |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 413 | help="Don't enable factory tests after installing") |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 414 | parser.add_argument('--yes', '-y', action='store_true', |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 415 | help="Don't ask for confirmation") |
Vic (Chun-Ju) Yang | 98b4fbc | 2014-02-18 19:32:32 +0800 | [diff] [blame] | 416 | parser.add_argument('--build-info', action='store_true', |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 417 | help='Print build information and exit') |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 418 | parser.add_argument('--pack-into', metavar='NEW_TOOLKIT', |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 419 | help='Pack the files into a new factory toolkit') |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 420 | parser.add_argument('--repack', metavar='UNPACKED_TOOLKIT', |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 421 | help='Repack from previously unpacked toolkit') |
You-Cheng Syu | 53f4a0c | 2017-04-20 17:46:12 +0800 | [diff] [blame] | 422 | parser.add_argument('--version', metavar='VERSION', |
| 423 | help='String to write into TOOLKIT_VERSION when packing') |
Vic Yang | 7039f42 | 2014-07-07 15:38:13 -0700 | [diff] [blame] | 424 | |
Vic Yang | 70fdae9 | 2015-02-17 19:21:08 -0800 | [diff] [blame] | 425 | parser.add_argument('--non-cros', dest='non_cros', |
| 426 | action='store_true', |
| 427 | help='Install on non-ChromeOS host.') |
| 428 | |
Vic Yang | 423c272 | 2014-09-24 16:05:06 +0800 | [diff] [blame] | 429 | |
Rong Chang | 6d65fad | 2014-08-22 16:00:12 +0800 | [diff] [blame] | 430 | parser.add_argument('--exe-path', dest='exe_path', |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 431 | nargs='?', default=None, |
| 432 | help='Current self-extracting archive pathname') |
Wei-Ning Huang | 4855e79 | 2015-06-11 15:33:39 +0800 | [diff] [blame] | 433 | parser.add_argument('--extract-overlord', dest='extract_overlord', |
| 434 | metavar='OUTPUT_DIR', type=str, default=None, |
| 435 | help='Extract overlord from the toolkit') |
Wei-Han Chen | 7137dcf | 2016-08-03 15:43:22 +0800 | [diff] [blame] | 436 | parser.add_argument('--install-dirs', nargs='+', default=None, |
| 437 | help=('Install only the specified directories under ' |
| 438 | 'factory folder. Can be used with --apps to ' |
| 439 | 'enable / disable some apps. Defaults to install ' |
| 440 | 'all folders.')) |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 441 | parser.add_argument('--apps', type=lambda s: s.split(','), default=None, |
| 442 | help=('Enable or disable some apps under ' |
| 443 | 'factory/init/main.d/. Use prefix "-" to disable, ' |
You-Cheng Syu | 70e99ad | 2017-03-09 17:15:00 +0800 | [diff] [blame] | 444 | 'prefix "+" to enable, and use "," to separate. ' |
Wei-Han Chen | e6fe387 | 2016-06-30 14:29:06 +0800 | [diff] [blame] | 445 | 'For example: --apps="-goofy,+whale_servo"')) |
Peter Shih | 2f1f8c4 | 2017-06-15 15:05:55 +0800 | [diff] [blame] | 446 | parser.add_argument('--active-test-list', dest='active_test_list', |
| 447 | default=None, |
| 448 | help='Set the id of active test list for Goofy.') |
Vic Yang | 7039f42 | 2014-07-07 15:38:13 -0700 | [diff] [blame] | 449 | |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 450 | args = parser.parse_args() |
| 451 | |
Peter Shih | ad16677 | 2017-05-31 11:36:17 +0800 | [diff] [blame] | 452 | src_root = paths.FACTORY_DIR |
Vic (Chun-Ju) Yang | 98b4fbc | 2014-02-18 19:32:32 +0800 | [diff] [blame] | 453 | for _ in xrange(3): |
| 454 | src_root = os.path.dirname(src_root) |
| 455 | |
Wei-Ning Huang | 4855e79 | 2015-06-11 15:33:39 +0800 | [diff] [blame] | 456 | if args.extract_overlord is not None: |
| 457 | ExtractOverlord(src_root, args.extract_overlord) |
| 458 | return |
| 459 | |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 460 | # --pack-into may be called directly so this must be done before changing |
| 461 | # working directory to OLDPWD. |
| 462 | if args.pack_into and args.repack is None: |
Hung-Te Lin | fc162e6 | 2017-09-21 00:45:04 +0800 | [diff] [blame] | 463 | PackFactoryToolkit(src_root, args.pack_into, args.version) |
Vic (Chun-Ju) Yang | 98b4fbc | 2014-02-18 19:32:32 +0800 | [diff] [blame] | 464 | return |
| 465 | |
Jon Salz | 4f3ade5 | 2014-02-20 17:55:09 +0800 | [diff] [blame] | 466 | if not in_archive: |
| 467 | # If you're not in the self-extracting archive, you're not allowed to |
| 468 | # do anything except the above --pack-into call. |
| 469 | parser.error('Not running from install_factory_toolkit.run; ' |
| 470 | 'only --pack-into (without --repack) is allowed') |
| 471 | |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 472 | # Change to original working directory in case the user specifies |
| 473 | # a relative path. |
| 474 | # TODO: Use USER_PWD instead when makeself is upgraded |
| 475 | os.chdir(os.environ['OLDPWD']) |
| 476 | |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 477 | if args.repack: |
| 478 | if args.pack_into is None: |
| 479 | parser.error('Must specify --pack-into when using --repack.') |
Youcheng Syu | ac39177 | 2017-04-20 09:08:58 +0000 | [diff] [blame] | 480 | Spawn([os.path.join(args.repack, INSTALLER_PATH), |
| 481 | '--pack-into', args.pack_into], check_call=True, log=True) |
Vic (Chun-Ju) Yang | b7388f7 | 2014-02-19 15:22:58 +0800 | [diff] [blame] | 482 | return |
| 483 | |
| 484 | if args.build_info: |
| 485 | PrintBuildInfo(src_root) |
| 486 | return |
| 487 | |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 488 | if not os.path.exists(args.dest): |
| 489 | parser.error('Destination %s does not exist!' % args.dest) |
| 490 | |
| 491 | patch_test_image = os.path.isfile(args.dest) |
| 492 | |
Hung-Te Lin | f5f2d7f | 2016-01-08 17:12:46 +0800 | [diff] [blame] | 493 | with (sys_utils.MountPartition(args.dest, 1, rw=True) if patch_test_image |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 494 | else DummyContext(args.dest)) as dest: |
Wei-Han Chen | 7137dcf | 2016-08-03 15:43:22 +0800 | [diff] [blame] | 495 | |
Hung-Te Lin | 56b1840 | 2015-01-16 14:52:30 +0800 | [diff] [blame] | 496 | installer = FactoryToolkitInstaller( |
Wei-Ning Huang | 5135b7e | 2015-07-03 17:31:15 +0800 | [diff] [blame] | 497 | src=src_root, dest=dest, no_enable=args.no_enable, |
Hung-Te Lin | fc162e6 | 2017-09-21 00:45:04 +0800 | [diff] [blame] | 498 | non_cros=args.non_cros, apps=args.apps, |
| 499 | active_test_list=args.active_test_list) |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 500 | |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 501 | print installer.WarningMessage(args.dest if patch_test_image else None) |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 502 | |
Vic (Chun-Ju) Yang | 469592b | 2014-02-18 19:15:41 +0800 | [diff] [blame] | 503 | if not args.yes: |
| 504 | answer = raw_input('*** Continue? [y/N] ') |
| 505 | if not answer or answer[0] not in 'yY': |
| 506 | sys.exit('Aborting.') |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 507 | |
Wei-Han Chen | 7137dcf | 2016-08-03 15:43:22 +0800 | [diff] [blame] | 508 | if args.install_dirs: |
| 509 | installer.InstallFactorySubDir(args.install_dirs) |
| 510 | else: |
| 511 | installer.Install() |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 512 | |
| 513 | if __name__ == '__main__': |
You-Cheng Syu | 70e99ad | 2017-03-09 17:15:00 +0800 | [diff] [blame] | 514 | # makself interprets "LICENSE" environment variable string as license text and |
Hung-Te Lin | 5a2a1c4 | 2016-11-10 12:43:40 +0800 | [diff] [blame] | 515 | # will prompt user to accept before installation. For factory toolkit, we |
| 516 | # don't want any user interaction in installation and the license is already |
| 517 | # covered by ebuild or download platform like CPFE. |
| 518 | os.putenv('LICENSE', '') |
Vic (Chun-Ju) Yang | 296871a | 2014-01-13 12:05:18 +0800 | [diff] [blame] | 519 | main() |