maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
maruel | ea586f3 | 2016-04-05 11:11:33 -0700 | [diff] [blame] | 2 | # Copyright 2012 The LUCI Authors. All rights reserved. |
maruel | f1f5e2a | 2016-05-25 17:10:39 -0700 | [diff] [blame] | 3 | # Use of this source code is governed under the Apache License, Version 2.0 |
| 4 | # that can be found in the LICENSE file. |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 5 | |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 6 | """Runs a command with optional isolated input/output. |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 7 | |
Marc-Antoine Ruel | eed2f3a | 2019-03-14 00:00:40 +0000 | [diff] [blame] | 8 | run_isolated takes cares of setting up a temporary environment, running a |
| 9 | command, and tearing it down. |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 10 | |
Marc-Antoine Ruel | eed2f3a | 2019-03-14 00:00:40 +0000 | [diff] [blame] | 11 | It handles downloading and uploading isolated files, mapping CIPD packages and |
| 12 | reusing stateful named caches. |
| 13 | |
| 14 | The isolated files, CIPD packages and named caches are kept as a global LRU |
| 15 | cache. |
Marc-Antoine Ruel | 2283ad1 | 2014-02-09 11:14:57 -0500 | [diff] [blame] | 16 | |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 17 | Any ${EXECUTABLE_SUFFIX} on the command line or the environment variables passed |
| 18 | with the --env option will be replaced with ".exe" string on Windows and "" on |
| 19 | other platforms. |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 20 | |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 21 | Any ${ISOLATED_OUTDIR} on the command line or the environment variables passed |
| 22 | with the --env option will be replaced by the location of a temporary directory |
| 23 | upon execution of the command specified in the .isolated file. All content |
| 24 | written to this directory will be uploaded upon termination and the .isolated |
| 25 | file describing this directory will be printed to stdout. |
bpastene | 447c199 | 2016-06-20 15:21:47 -0700 | [diff] [blame] | 26 | |
Marc-Antoine Ruel | eed2f3a | 2019-03-14 00:00:40 +0000 | [diff] [blame] | 27 | Any ${SWARMING_BOT_FILE} on the command line or the environment variables passed |
| 28 | with the --env option will be replaced by the value of the --bot-file parameter. |
| 29 | This file is used by a swarming bot to communicate state of the host to tasks. |
| 30 | It is written to by the swarming bot's on_before_task() hook in the swarming |
| 31 | server's custom bot_config.py. |
| 32 | |
| 33 | See |
| 34 | https://chromium.googlesource.com/infra/luci/luci-py.git/+/master/appengine/swarming/doc/Magic-Values.md |
| 35 | for all the variables. |
| 36 | |
| 37 | See |
| 38 | https://chromium.googlesource.com/infra/luci/luci-py.git/+/master/appengine/swarming/swarming_bot/config/bot_config.py |
| 39 | for more information about bot_config.py. |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 40 | """ |
| 41 | |
Marc-Antoine Ruel | f899c48 | 2019-10-10 23:32:06 +0000 | [diff] [blame] | 42 | from __future__ import print_function |
| 43 | |
| 44 | __version__ = '1.0.1' |
maruel@chromium.org | dedbf49 | 2013-09-12 20:42:11 +0000 | [diff] [blame] | 45 | |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 46 | import argparse |
maruel | 064c0a3 | 2016-04-05 11:47:15 -0700 | [diff] [blame] | 47 | import base64 |
iannucci | 96fcccc | 2016-08-30 15:52:22 -0700 | [diff] [blame] | 48 | import collections |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 49 | import contextlib |
Sadaf Matinkhoo | 10743a6 | 2018-03-29 16:28:58 -0400 | [diff] [blame] | 50 | import errno |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 51 | import json |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 52 | import logging |
| 53 | import optparse |
| 54 | import os |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 55 | import re |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 56 | import sys |
| 57 | import tempfile |
maruel | 064c0a3 | 2016-04-05 11:47:15 -0700 | [diff] [blame] | 58 | import time |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 59 | |
Marc-Antoine Ruel | 016c760 | 2019-04-02 18:31:13 +0000 | [diff] [blame] | 60 | from utils import tools |
| 61 | tools.force_local_third_party() |
vadimsh@chromium.org | a432647 | 2013-08-24 02:05:41 +0000 | [diff] [blame] | 62 | |
Marc-Antoine Ruel | 016c760 | 2019-04-02 18:31:13 +0000 | [diff] [blame] | 63 | # third_party/ |
| 64 | from depot_tools import fix_encoding |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 65 | import six |
Marc-Antoine Ruel | 016c760 | 2019-04-02 18:31:13 +0000 | [diff] [blame] | 66 | |
| 67 | # pylint: disable=ungrouped-imports |
| 68 | import auth |
| 69 | import cipd |
| 70 | import isolate_storage |
| 71 | import isolateserver |
| 72 | import local_caching |
| 73 | from libs import luci_context |
Vadim Shtayura | 6b555c1 | 2014-07-23 16:22:18 -0700 | [diff] [blame] | 74 | from utils import file_path |
maruel | 12e3001 | 2015-10-09 11:55:35 -0700 | [diff] [blame] | 75 | from utils import fs |
maruel | 064c0a3 | 2016-04-05 11:47:15 -0700 | [diff] [blame] | 76 | from utils import large |
Marc-Antoine Ruel | f74cffe | 2015-07-15 15:21:34 -0400 | [diff] [blame] | 77 | from utils import logging_utils |
Marc-Antoine Ruel | cfb6085 | 2014-07-02 15:22:00 -0400 | [diff] [blame] | 78 | from utils import on_error |
Marc-Antoine Ruel | c44f572 | 2015-01-08 16:10:01 -0500 | [diff] [blame] | 79 | from utils import subprocess42 |
maruel@chromium.org | dedbf49 | 2013-09-12 20:42:11 +0000 | [diff] [blame] | 80 | |
vadimsh@chromium.org | a432647 | 2013-08-24 02:05:41 +0000 | [diff] [blame] | 81 | |
maruel | e2f2cb8 | 2016-07-13 14:41:03 -0700 | [diff] [blame] | 82 | # Magic variables that can be found in the isolate task command line. |
| 83 | ISOLATED_OUTDIR_PARAMETER = '${ISOLATED_OUTDIR}' |
| 84 | EXECUTABLE_SUFFIX_PARAMETER = '${EXECUTABLE_SUFFIX}' |
| 85 | SWARMING_BOT_FILE_PARAMETER = '${SWARMING_BOT_FILE}' |
| 86 | |
| 87 | |
csharp@chromium.org | ff2a466 | 2012-11-21 20:49:32 +0000 | [diff] [blame] | 88 | # The name of the log file to use. |
| 89 | RUN_ISOLATED_LOG_FILE = 'run_isolated.log' |
| 90 | |
maruel | e2f2cb8 | 2016-07-13 14:41:03 -0700 | [diff] [blame] | 91 | |
csharp@chromium.org | e217f30 | 2012-11-22 16:51:53 +0000 | [diff] [blame] | 92 | # The name of the log to use for the run_test_cases.py command |
vadimsh@chromium.org | 8b9d56b | 2013-08-21 22:24:35 +0000 | [diff] [blame] | 93 | RUN_TEST_CASES_LOG = 'run_test_cases.log' |
csharp@chromium.org | e217f30 | 2012-11-22 16:51:53 +0000 | [diff] [blame] | 94 | |
vadimsh@chromium.org | 87d6326 | 2013-04-04 19:34:21 +0000 | [diff] [blame] | 95 | |
maruel | e2f2cb8 | 2016-07-13 14:41:03 -0700 | [diff] [blame] | 96 | # Use short names for temporary directories. This is driven by Windows, which |
| 97 | # imposes a relatively short maximum path length of 260 characters, often |
| 98 | # referred to as MAX_PATH. It is relatively easy to create files with longer |
Marc-Antoine Ruel | 793bff3 | 2019-04-18 17:50:48 +0000 | [diff] [blame] | 99 | # path length. A use case is with recursive dependency trees like npm packages. |
maruel | e2f2cb8 | 2016-07-13 14:41:03 -0700 | [diff] [blame] | 100 | # |
| 101 | # It is recommended to start the script with a `root_dir` as short as |
| 102 | # possible. |
| 103 | # - ir stands for isolated_run |
| 104 | # - io stands for isolated_out |
| 105 | # - it stands for isolated_tmp |
| 106 | ISOLATED_RUN_DIR = u'ir' |
| 107 | ISOLATED_OUT_DIR = u'io' |
| 108 | ISOLATED_TMP_DIR = u'it' |
| 109 | |
| 110 | |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 111 | # Keep synced with task_request.py |
Lei Lei | fe202df | 2019-06-11 17:33:34 +0000 | [diff] [blame] | 112 | CACHE_NAME_RE = re.compile(r'^[a-z0-9_]{1,4096}$') |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 113 | |
| 114 | |
maruel | d928c86 | 2017-06-08 08:20:04 -0700 | [diff] [blame] | 115 | OUTLIVING_ZOMBIE_MSG = """\ |
| 116 | *** Swarming tried multiple times to delete the %s directory and failed *** |
| 117 | *** Hard failing the task *** |
| 118 | |
| 119 | Swarming detected that your testing script ran an executable, which may have |
| 120 | started a child executable, and the main script returned early, leaving the |
| 121 | children executables playing around unguided. |
| 122 | |
| 123 | You don't want to leave children processes outliving the task on the Swarming |
| 124 | bot, do you? The Swarming bot doesn't. |
| 125 | |
| 126 | How to fix? |
| 127 | - For any process that starts children processes, make sure all children |
| 128 | processes terminated properly before each parent process exits. This is |
| 129 | especially important in very deep process trees. |
| 130 | - This must be done properly both in normal successful task and in case of |
| 131 | task failure. Cleanup is very important. |
| 132 | - The Swarming bot sends a SIGTERM in case of timeout. |
| 133 | - You have %s seconds to comply after the signal was sent to the process |
| 134 | before the process is forcibly killed. |
| 135 | - To achieve not leaking children processes in case of signals on timeout, you |
| 136 | MUST handle signals in each executable / python script and propagate them to |
| 137 | children processes. |
| 138 | - When your test script (python or binary) receives a signal like SIGTERM or |
| 139 | CTRL_BREAK_EVENT on Windows), send it to all children processes and wait for |
| 140 | them to terminate before quitting. |
| 141 | |
| 142 | See |
Marc-Antoine Ruel | c724359 | 2018-05-24 17:04:04 -0400 | [diff] [blame] | 143 | https://chromium.googlesource.com/infra/luci/luci-py.git/+/master/appengine/swarming/doc/Bot.md#Graceful-termination_aka-the-SIGTERM-and-SIGKILL-dance |
maruel | d928c86 | 2017-06-08 08:20:04 -0700 | [diff] [blame] | 144 | for more information. |
| 145 | |
| 146 | *** May the SIGKILL force be with you *** |
| 147 | """ |
| 148 | |
| 149 | |
Marc-Antoine Ruel | 5d7606b | 2018-06-15 19:06:12 +0000 | [diff] [blame] | 150 | # Currently hardcoded. Eventually could be exposed as a flag once there's value. |
| 151 | # 3 weeks |
| 152 | MAX_AGE_SECS = 21*24*60*60 |
| 153 | |
| 154 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 155 | TaskData = collections.namedtuple( |
Marc-Antoine Ruel | 03c6fd1 | 2019-04-30 12:12:55 +0000 | [diff] [blame] | 156 | 'TaskData', |
| 157 | [ |
Takuto Ikuta | 9a31950 | 2019-11-26 07:40:14 +0000 | [diff] [blame] | 158 | # List of strings; the command line to use, independent of what was |
| 159 | # specified in the isolated file. |
| 160 | 'command', |
| 161 | # Relative directory to start command into. |
| 162 | 'relative_cwd', |
| 163 | # List of strings; the arguments to add to the command specified in the |
| 164 | # isolated file. |
| 165 | 'extra_args', |
| 166 | # Hash of the .isolated file that must be retrieved to recreate the tree |
| 167 | # of files to run the target executable. The command specified in the |
| 168 | # .isolated is executed. Mutually exclusive with command argument. |
| 169 | 'isolated_hash', |
| 170 | # isolateserver.Storage instance to retrieve remote objects. This object |
| 171 | # has a reference to an isolateserver.StorageApi, which does the actual |
| 172 | # I/O. |
| 173 | 'storage', |
| 174 | # isolateserver.LocalCache instance to keep from retrieving the same |
| 175 | # objects constantly by caching the objects retrieved. Can be on-disk or |
| 176 | # in-memory. |
| 177 | 'isolate_cache', |
| 178 | # List of paths relative to root_dir to put into the output isolated |
| 179 | # bundle upon task completion (see link_outputs_to_outdir). |
| 180 | 'outputs', |
| 181 | # Function (run_dir) => context manager that installs named caches into |
| 182 | # |run_dir|. |
| 183 | 'install_named_caches', |
| 184 | # If True, the temporary directory will be deliberately leaked for later |
| 185 | # examination. |
| 186 | 'leak_temp_dir', |
| 187 | # Path to the directory to use to create the temporary directory. If not |
| 188 | # specified, a random temporary directory is created. |
| 189 | 'root_dir', |
| 190 | # Kills the process if it lasts more than this amount of seconds. |
| 191 | 'hard_timeout', |
| 192 | # Number of seconds to wait between SIGTERM and SIGKILL. |
| 193 | 'grace_period', |
| 194 | # Path to a file with bot state, used in place of ${SWARMING_BOT_FILE} |
| 195 | # task command line argument. |
| 196 | 'bot_file', |
| 197 | # Logical account to switch LUCI_CONTEXT into. |
| 198 | 'switch_to_account', |
| 199 | # Context manager dir => CipdInfo, see install_client_and_packages. |
| 200 | 'install_packages_fn', |
| 201 | # Create tree with symlinks instead of hardlinks. |
| 202 | 'use_symlinks', |
| 203 | # Environment variables to set. |
| 204 | 'env', |
| 205 | # Environment variables to mutate with relative directories. |
| 206 | # Example: {"ENV_KEY": ['relative', 'paths', 'to', 'prepend']} |
| 207 | 'env_prefix', |
| 208 | # Lowers the task process priority. |
| 209 | 'lower_priority', |
| 210 | # subprocess42.Containment instance. Can be None. |
| 211 | 'containment', |
Marc-Antoine Ruel | 03c6fd1 | 2019-04-30 12:12:55 +0000 | [diff] [blame] | 212 | ]) |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 213 | |
| 214 | |
Marc-Antoine Ruel | ee6ca62 | 2017-11-29 11:19:16 -0500 | [diff] [blame] | 215 | def _to_str(s): |
| 216 | """Downgrades a unicode instance to str. Pass str through as-is.""" |
| 217 | if isinstance(s, str): |
| 218 | return s |
| 219 | # This is technically incorrect, especially on Windows. In theory |
| 220 | # sys.getfilesystemencoding() should be used to use the right 'ANSI code |
| 221 | # page' on Windows, but that causes other problems, as the character set |
| 222 | # is very limited. |
| 223 | return s.encode('utf-8') |
| 224 | |
| 225 | |
Marc-Antoine Ruel | 7a68f71 | 2017-12-01 18:45:18 -0500 | [diff] [blame] | 226 | def _to_unicode(s): |
| 227 | """Upgrades a str instance to unicode. Pass unicode through as-is.""" |
Takuto Ikuta | 95459dd | 2019-10-29 12:39:47 +0000 | [diff] [blame] | 228 | if isinstance(s, six.text_type) or s is None: |
Marc-Antoine Ruel | 7a68f71 | 2017-12-01 18:45:18 -0500 | [diff] [blame] | 229 | return s |
| 230 | return s.decode('utf-8') |
| 231 | |
| 232 | |
maruel | 03e1184 | 2016-07-14 10:50:16 -0700 | [diff] [blame] | 233 | def make_temp_dir(prefix, root_dir): |
| 234 | """Returns a new unique temporary directory.""" |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 235 | return six.text_type(tempfile.mkdtemp(prefix=prefix, dir=root_dir)) |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 236 | |
| 237 | |
Marc-Antoine Ruel | 7124e39 | 2014-01-09 11:49:21 -0500 | [diff] [blame] | 238 | def change_tree_read_only(rootdir, read_only): |
| 239 | """Changes the tree read-only bits according to the read_only specification. |
| 240 | |
| 241 | The flag can be 0, 1 or 2, which will affect the possibility to modify files |
| 242 | and create or delete files. |
| 243 | """ |
| 244 | if read_only == 2: |
| 245 | # Files and directories (except on Windows) are marked read only. This |
| 246 | # inhibits modifying, creating or deleting files in the test directory, |
| 247 | # except on Windows where creating and deleting files is still possible. |
Marc-Antoine Ruel | e4ad07e | 2014-10-15 20:22:29 -0400 | [diff] [blame] | 248 | file_path.make_tree_read_only(rootdir) |
Marc-Antoine Ruel | 7124e39 | 2014-01-09 11:49:21 -0500 | [diff] [blame] | 249 | elif read_only == 1: |
| 250 | # Files are marked read only but not the directories. This inhibits |
| 251 | # modifying files but creating or deleting files is still possible. |
Marc-Antoine Ruel | e4ad07e | 2014-10-15 20:22:29 -0400 | [diff] [blame] | 252 | file_path.make_tree_files_read_only(rootdir) |
Marc-Antoine Ruel | 7124e39 | 2014-01-09 11:49:21 -0500 | [diff] [blame] | 253 | elif read_only in (0, None): |
Marc-Antoine Ruel | f1d827c | 2014-11-24 15:22:25 -0500 | [diff] [blame] | 254 | # Anything can be modified. |
Marc-Antoine Ruel | 2666d9c | 2018-05-18 13:52:02 -0400 | [diff] [blame] | 255 | # TODO(maruel): This is currently dangerous as long as |
| 256 | # DiskContentAddressedCache.touch() is not yet changed to verify the hash of |
| 257 | # the content of the files it is looking at, so that if a test modifies an |
| 258 | # input file, the file must be deleted. |
Marc-Antoine Ruel | e4ad07e | 2014-10-15 20:22:29 -0400 | [diff] [blame] | 259 | file_path.make_tree_writeable(rootdir) |
Marc-Antoine Ruel | 7124e39 | 2014-01-09 11:49:21 -0500 | [diff] [blame] | 260 | else: |
| 261 | raise ValueError( |
| 262 | 'change_tree_read_only(%s, %s): Unknown flag %s' % |
| 263 | (rootdir, read_only, read_only)) |
| 264 | |
| 265 | |
vadimsh | 9c54b2c | 2017-07-25 14:08:29 -0700 | [diff] [blame] | 266 | @contextlib.contextmanager |
| 267 | def set_luci_context_account(account, tmp_dir): |
| 268 | """Sets LUCI_CONTEXT account to be used by the task. |
| 269 | |
| 270 | If 'account' is None or '', does nothing at all. This happens when |
| 271 | run_isolated.py is called without '--switch-to-account' flag. In this case, |
| 272 | if run_isolated.py is running in some LUCI_CONTEXT environment, the task will |
Takuto Ikuta | 33e2ff3 | 2019-09-30 12:44:03 +0000 | [diff] [blame] | 273 | just inherit whatever account is already set. This may happen if users invoke |
vadimsh | 9c54b2c | 2017-07-25 14:08:29 -0700 | [diff] [blame] | 274 | run_isolated.py explicitly from their code. |
| 275 | |
| 276 | If the requested account is not defined in the context, switches to |
| 277 | non-authenticated access. This happens for Swarming tasks that don't use |
| 278 | 'task' service accounts. |
| 279 | |
| 280 | If not using LUCI_CONTEXT-based auth, does nothing. |
| 281 | If already running as requested account, does nothing. |
| 282 | """ |
| 283 | if not account: |
| 284 | # Not actually switching. |
| 285 | yield |
| 286 | return |
| 287 | |
| 288 | local_auth = luci_context.read('local_auth') |
| 289 | if not local_auth: |
| 290 | # Not using LUCI_CONTEXT auth at all. |
| 291 | yield |
| 292 | return |
| 293 | |
| 294 | # See LUCI_CONTEXT.md for the format of 'local_auth'. |
| 295 | if local_auth.get('default_account_id') == account: |
| 296 | # Already set, no need to switch. |
| 297 | yield |
| 298 | return |
| 299 | |
| 300 | available = {a['id'] for a in local_auth.get('accounts') or []} |
| 301 | if account in available: |
| 302 | logging.info('Switching default LUCI_CONTEXT account to %r', account) |
| 303 | local_auth['default_account_id'] = account |
| 304 | else: |
| 305 | logging.warning( |
| 306 | 'Requested LUCI_CONTEXT account %r is not available (have only %r), ' |
| 307 | 'disabling authentication', account, sorted(available)) |
| 308 | local_auth.pop('default_account_id', None) |
| 309 | |
| 310 | with luci_context.write(_tmpdir=tmp_dir, local_auth=local_auth): |
| 311 | yield |
| 312 | |
| 313 | |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 314 | def process_command(command, out_dir, bot_file): |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 315 | """Replaces parameters in a command line. |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 316 | |
| 317 | Raises: |
| 318 | ValueError if a parameter is requested in |command| but its value is not |
| 319 | provided. |
| 320 | """ |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 321 | return [replace_parameters(arg, out_dir, bot_file) for arg in command] |
| 322 | |
| 323 | |
| 324 | def replace_parameters(arg, out_dir, bot_file): |
| 325 | """Replaces parameter tokens with appropriate values in a string. |
| 326 | |
| 327 | Raises: |
| 328 | ValueError if a parameter is requested in |arg| but its value is not |
| 329 | provided. |
| 330 | """ |
| 331 | arg = arg.replace(EXECUTABLE_SUFFIX_PARAMETER, cipd.EXECUTABLE_SUFFIX) |
| 332 | replace_slash = False |
| 333 | if ISOLATED_OUTDIR_PARAMETER in arg: |
| 334 | if not out_dir: |
| 335 | raise ValueError( |
| 336 | 'output directory is requested in command or env var, but not ' |
| 337 | 'provided; please specify one') |
| 338 | arg = arg.replace(ISOLATED_OUTDIR_PARAMETER, out_dir) |
| 339 | replace_slash = True |
| 340 | if SWARMING_BOT_FILE_PARAMETER in arg: |
| 341 | if bot_file: |
| 342 | arg = arg.replace(SWARMING_BOT_FILE_PARAMETER, bot_file) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 343 | replace_slash = True |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 344 | else: |
| 345 | logging.warning('SWARMING_BOT_FILE_PARAMETER found in command or env ' |
| 346 | 'var, but no bot_file specified. Leaving parameter ' |
| 347 | 'unchanged.') |
| 348 | if replace_slash: |
| 349 | # Replace slashes only if parameters are present |
| 350 | # because of arguments like '${ISOLATED_OUTDIR}/foo/bar' |
| 351 | arg = arg.replace('/', os.sep) |
| 352 | return arg |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 353 | |
| 354 | |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 355 | |
| 356 | def get_command_env(tmp_dir, cipd_info, run_dir, env, env_prefixes, out_dir, |
| 357 | bot_file): |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 358 | """Returns full OS environment to run a command in. |
| 359 | |
Robert Iannucci | bf5f84c | 2017-11-22 12:56:50 -0800 | [diff] [blame] | 360 | Sets up TEMP, puts directory with cipd binary in front of PATH, exposes |
| 361 | CIPD_CACHE_DIR env var, and installs all env_prefixes. |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 362 | |
| 363 | Args: |
| 364 | tmp_dir: temp directory. |
| 365 | cipd_info: CipdInfo object is cipd client is used, None if not. |
Marc-Antoine Ruel | 9ec1e9f | 2017-12-20 16:36:54 -0500 | [diff] [blame] | 366 | run_dir: The root directory the isolated tree is mapped in. |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 367 | env: environment variables to use |
Robert Iannucci | bf5f84c | 2017-11-22 12:56:50 -0800 | [diff] [blame] | 368 | env_prefixes: {"ENV_KEY": ['cwd', 'relative', 'paths', 'to', 'prepend']} |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 369 | out_dir: Isolated output directory. Required to be != None if any of the |
| 370 | env vars contain ISOLATED_OUTDIR_PARAMETER. |
| 371 | bot_file: Required to be != None if any of the env vars contain |
| 372 | SWARMING_BOT_FILE_PARAMETER. |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 373 | """ |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 374 | out = os.environ.copy() |
Marc-Antoine Ruel | 04903a3 | 2019-10-09 21:09:25 +0000 | [diff] [blame] | 375 | for k, v in env.items(): |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 376 | if not v: |
Marc-Antoine Ruel | 9ec1e9f | 2017-12-20 16:36:54 -0500 | [diff] [blame] | 377 | out.pop(k, None) |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 378 | else: |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 379 | out[k] = replace_parameters(v, out_dir, bot_file) |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 380 | |
| 381 | if cipd_info: |
| 382 | bin_dir = os.path.dirname(cipd_info.client.binary_path) |
Marc-Antoine Ruel | ee6ca62 | 2017-11-29 11:19:16 -0500 | [diff] [blame] | 383 | out['PATH'] = '%s%s%s' % (_to_str(bin_dir), os.pathsep, out['PATH']) |
| 384 | out['CIPD_CACHE_DIR'] = _to_str(cipd_info.cache_dir) |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 385 | |
Marc-Antoine Ruel | 04903a3 | 2019-10-09 21:09:25 +0000 | [diff] [blame] | 386 | for key, paths in env_prefixes.items(): |
Marc-Antoine Ruel | 9ec1e9f | 2017-12-20 16:36:54 -0500 | [diff] [blame] | 387 | assert isinstance(paths, list), paths |
| 388 | paths = [os.path.normpath(os.path.join(run_dir, p)) for p in paths] |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 389 | cur = out.get(key) |
| 390 | if cur: |
| 391 | paths.append(cur) |
Marc-Antoine Ruel | ee6ca62 | 2017-11-29 11:19:16 -0500 | [diff] [blame] | 392 | out[key] = _to_str(os.path.pathsep.join(paths)) |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 393 | |
Marc-Antoine Ruel | efb30b1 | 2018-07-25 18:34:36 +0000 | [diff] [blame] | 394 | tmp_dir = _to_str(tmp_dir) |
| 395 | # pylint: disable=line-too-long |
| 396 | # * python respects $TMPDIR, $TEMP, and $TMP in this order, regardless of |
| 397 | # platform. So $TMPDIR must be set on all platforms. |
| 398 | # https://github.com/python/cpython/blob/2.7/Lib/tempfile.py#L155 |
| 399 | out['TMPDIR'] = tmp_dir |
| 400 | if sys.platform == 'win32': |
| 401 | # * chromium's base utils uses GetTempPath(). |
| 402 | # https://cs.chromium.org/chromium/src/base/files/file_util_win.cc?q=GetTempPath |
| 403 | # * Go uses GetTempPath(). |
| 404 | # * GetTempDir() uses %TMP%, then %TEMP%, then other stuff. So %TMP% must be |
| 405 | # set. |
| 406 | # https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-gettemppathw |
| 407 | out['TMP'] = tmp_dir |
| 408 | # https://blogs.msdn.microsoft.com/oldnewthing/20150417-00/?p=44213 |
| 409 | out['TEMP'] = tmp_dir |
| 410 | elif sys.platform == 'darwin': |
| 411 | # * Chromium uses an hack on macOS before calling into |
| 412 | # NSTemporaryDirectory(). |
| 413 | # https://cs.chromium.org/chromium/src/base/files/file_util_mac.mm?q=GetTempDir |
| 414 | # https://developer.apple.com/documentation/foundation/1409211-nstemporarydirectory |
| 415 | out['MAC_CHROMIUM_TMPDIR'] = tmp_dir |
| 416 | else: |
| 417 | # TMPDIR is specified as the POSIX standard envvar for the temp directory. |
| 418 | # http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html |
| 419 | # * mktemp on linux respects $TMPDIR. |
| 420 | # * Chromium respects $TMPDIR on linux. |
| 421 | # https://cs.chromium.org/chromium/src/base/files/file_util_posix.cc?q=GetTempDir |
| 422 | # * Go uses $TMPDIR. |
| 423 | # https://go.googlesource.com/go/+/go1.10.3/src/os/file_unix.go#307 |
| 424 | pass |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 425 | return out |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 426 | |
| 427 | |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 428 | def run_command( |
| 429 | command, cwd, env, hard_timeout, grace_period, lower_priority, containment): |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 430 | """Runs the command. |
| 431 | |
| 432 | Returns: |
| 433 | tuple(process exit code, bool if had a hard timeout) |
| 434 | """ |
Marc-Antoine Ruel | 03c6fd1 | 2019-04-30 12:12:55 +0000 | [diff] [blame] | 435 | logging.info( |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 436 | 'run_command(%s, %s, %s, %s, %s, %s)', |
| 437 | command, cwd, hard_timeout, grace_period, lower_priority, containment) |
maruel | eb5fbee | 2015-09-17 13:01:36 -0700 | [diff] [blame] | 438 | |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 439 | exit_code = None |
| 440 | had_hard_timeout = False |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 441 | with tools.Profiler('RunTest'): |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 442 | proc = None |
| 443 | had_signal = [] |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 444 | try: |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 445 | # TODO(maruel): This code is imperfect. It doesn't handle well signals |
| 446 | # during the download phase and there's short windows were things can go |
| 447 | # wrong. |
| 448 | def handler(signum, _frame): |
| 449 | if proc and not had_signal: |
| 450 | logging.info('Received signal %d', signum) |
| 451 | had_signal.append(True) |
maruel | 556d905 | 2015-10-05 11:12:44 -0700 | [diff] [blame] | 452 | raise subprocess42.TimeoutExpired(command, None) |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 453 | |
Marc-Antoine Ruel | 30b80fe | 2019-02-08 13:51:31 +0000 | [diff] [blame] | 454 | proc = subprocess42.Popen( |
Marc-Antoine Ruel | 03c6fd1 | 2019-04-30 12:12:55 +0000 | [diff] [blame] | 455 | command, cwd=cwd, env=env, detached=True, close_fds=True, |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 456 | lower_priority=lower_priority, containment=containment) |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 457 | with subprocess42.set_signal_handler(subprocess42.STOP_SIGNALS, handler): |
| 458 | try: |
John Budorick | c398f09 | 2019-06-10 22:49:44 +0000 | [diff] [blame] | 459 | exit_code = proc.wait(hard_timeout or None) |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 460 | except subprocess42.TimeoutExpired: |
| 461 | if not had_signal: |
| 462 | logging.warning('Hard timeout') |
| 463 | had_hard_timeout = True |
| 464 | logging.warning('Sending SIGTERM') |
| 465 | proc.terminate() |
| 466 | |
| 467 | # Ignore signals in grace period. Forcibly give the grace period to the |
| 468 | # child process. |
| 469 | if exit_code is None: |
| 470 | ignore = lambda *_: None |
| 471 | with subprocess42.set_signal_handler(subprocess42.STOP_SIGNALS, ignore): |
| 472 | try: |
| 473 | exit_code = proc.wait(grace_period or None) |
| 474 | except subprocess42.TimeoutExpired: |
| 475 | # Now kill for real. The user can distinguish between the |
| 476 | # following states: |
| 477 | # - signal but process exited within grace period, |
| 478 | # hard_timed_out will be set but the process exit code will be |
| 479 | # script provided. |
| 480 | # - processed exited late, exit code will be -9 on posix. |
| 481 | logging.warning('Grace exhausted; sending SIGKILL') |
| 482 | proc.kill() |
martiniss | 5c8043e | 2017-08-01 17:09:43 -0700 | [diff] [blame] | 483 | logging.info('Waiting for process exit') |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 484 | exit_code = proc.wait() |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 485 | except OSError: |
| 486 | # This is not considered to be an internal error. The executable simply |
| 487 | # does not exit. |
maruel | a72f46e | 2016-02-24 11:05:45 -0800 | [diff] [blame] | 488 | sys.stderr.write( |
tikuta | 2d67821 | 2019-09-23 23:12:08 +0000 | [diff] [blame] | 489 | '<The executable does not exist, a dependent library is missing or ' |
| 490 | 'the command line is too long>\n' |
| 491 | '<Check for missing .so/.dll in the .isolate or GN file or length of ' |
| 492 | 'command line args>\n' |
maruel | a72f46e | 2016-02-24 11:05:45 -0800 | [diff] [blame] | 493 | '<Command: %s>\n' % command) |
| 494 | if os.environ.get('SWARMING_TASK_ID'): |
| 495 | # Give an additional hint when running as a swarming task. |
| 496 | sys.stderr.write( |
| 497 | '<See the task\'s page for commands to help diagnose this issue ' |
| 498 | 'by reproducing the task locally>\n') |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 499 | exit_code = 1 |
| 500 | logging.info( |
| 501 | 'Command finished with exit code %d (%s)', |
| 502 | exit_code, hex(0xffffffff & exit_code)) |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 503 | return exit_code, had_hard_timeout |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 504 | |
| 505 | |
maruel | 4409e30 | 2016-07-19 14:25:51 -0700 | [diff] [blame] | 506 | def fetch_and_map(isolated_hash, storage, cache, outdir, use_symlinks): |
| 507 | """Fetches an isolated tree, create the tree and returns (bundle, stats).""" |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 508 | start = time.time() |
| 509 | bundle = isolateserver.fetch_isolated( |
| 510 | isolated_hash=isolated_hash, |
| 511 | storage=storage, |
| 512 | cache=cache, |
maruel | 4409e30 | 2016-07-19 14:25:51 -0700 | [diff] [blame] | 513 | outdir=outdir, |
| 514 | use_symlinks=use_symlinks) |
Takuto Ikuta | 2b9640e | 2019-06-19 00:53:23 +0000 | [diff] [blame] | 515 | hot = (collections.Counter(cache.used) - |
| 516 | collections.Counter(cache.added)).elements() |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 517 | return bundle, { |
| 518 | 'duration': time.time() - start, |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 519 | 'items_cold': base64.b64encode(large.pack(sorted(cache.added))), |
Takuto Ikuta | 2b9640e | 2019-06-19 00:53:23 +0000 | [diff] [blame] | 520 | 'items_hot': base64.b64encode(large.pack(sorted(hot))), |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 521 | } |
| 522 | |
| 523 | |
aludwin | 0a8e17d | 2016-10-27 15:57:39 -0700 | [diff] [blame] | 524 | def link_outputs_to_outdir(run_dir, out_dir, outputs): |
| 525 | """Links any named outputs to out_dir so they can be uploaded. |
| 526 | |
| 527 | Raises an error if the file already exists in that directory. |
| 528 | """ |
| 529 | if not outputs: |
| 530 | return |
| 531 | isolateserver.create_directories(out_dir, outputs) |
| 532 | for o in outputs: |
Sadaf Matinkhoo | 10743a6 | 2018-03-29 16:28:58 -0400 | [diff] [blame] | 533 | copy_recursively(os.path.join(run_dir, o), os.path.join(out_dir, o)) |
| 534 | |
| 535 | |
| 536 | def copy_recursively(src, dst): |
| 537 | """Efficiently copies a file or directory from src_dir to dst_dir. |
| 538 | |
| 539 | `item` may be a file, directory, or a symlink to a file or directory. |
| 540 | All symlinks are replaced with their targets, so the resulting |
| 541 | directory structure in dst_dir will never have any symlinks. |
| 542 | |
| 543 | To increase speed, copy_recursively hardlinks individual files into the |
| 544 | (newly created) directory structure if possible, unlike Python's |
| 545 | shutil.copytree(). |
| 546 | """ |
| 547 | orig_src = src |
| 548 | try: |
| 549 | # Replace symlinks with their final target. |
| 550 | while fs.islink(src): |
| 551 | res = fs.readlink(src) |
| 552 | src = os.path.join(os.path.dirname(src), res) |
| 553 | # TODO(sadafm): Explicitly handle cyclic symlinks. |
| 554 | |
| 555 | # Note that fs.isfile (which is a wrapper around os.path.isfile) throws |
| 556 | # an exception if src does not exist. A warning will be logged in that case. |
| 557 | if fs.isfile(src): |
| 558 | file_path.link_file(dst, src, file_path.HARDLINK_WITH_FALLBACK) |
| 559 | return |
| 560 | |
| 561 | if not fs.exists(dst): |
| 562 | os.makedirs(dst) |
| 563 | |
| 564 | for child in fs.listdir(src): |
| 565 | copy_recursively(os.path.join(src, child), os.path.join(dst, child)) |
| 566 | |
| 567 | except OSError as e: |
| 568 | if e.errno == errno.ENOENT: |
| 569 | logging.warning('Path %s does not exist or %s is a broken symlink', |
| 570 | src, orig_src) |
| 571 | else: |
| 572 | logging.info("Couldn't collect output file %s: %s", src, e) |
aludwin | 0a8e17d | 2016-10-27 15:57:39 -0700 | [diff] [blame] | 573 | |
| 574 | |
Takuto Ikuta | b4aa866 | 2019-09-17 05:54:36 +0000 | [diff] [blame] | 575 | def upload_then_delete(storage, out_dir, leak_temp_dir): |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 576 | """Deletes the temporary run directory and uploads results back. |
| 577 | |
| 578 | Returns: |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 579 | tuple(outputs_ref, success, stats) |
maruel | 064c0a3 | 2016-04-05 11:47:15 -0700 | [diff] [blame] | 580 | - outputs_ref: a dict referring to the results archived back to the isolated |
| 581 | server, if applicable. |
| 582 | - success: False if something occurred that means that the task must |
| 583 | forcibly be considered a failure, e.g. zombie processes were left |
| 584 | behind. |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 585 | - stats: uploading stats. |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 586 | """ |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 587 | # Upload out_dir and generate a .isolated file out of this directory. It is |
| 588 | # only done if files were written in the directory. |
| 589 | outputs_ref = None |
maruel | 064c0a3 | 2016-04-05 11:47:15 -0700 | [diff] [blame] | 590 | cold = [] |
| 591 | hot = [] |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 592 | start = time.time() |
| 593 | |
maruel | 12e3001 | 2015-10-09 11:55:35 -0700 | [diff] [blame] | 594 | if fs.isdir(out_dir) and fs.listdir(out_dir): |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 595 | with tools.Profiler('ArchiveOutput'): |
| 596 | try: |
maruel | 064c0a3 | 2016-04-05 11:47:15 -0700 | [diff] [blame] | 597 | results, f_cold, f_hot = isolateserver.archive_files_to_storage( |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 598 | storage, [out_dir], None) |
| 599 | outputs_ref = { |
Marc-Antoine Ruel | d0868ec | 2018-11-28 20:47:29 +0000 | [diff] [blame] | 600 | 'isolated': results.values()[0], |
Marc-Antoine Ruel | b851313 | 2018-11-20 19:48:53 +0000 | [diff] [blame] | 601 | 'isolatedserver': storage.server_ref.url, |
| 602 | 'namespace': storage.server_ref.namespace, |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 603 | } |
maruel | 064c0a3 | 2016-04-05 11:47:15 -0700 | [diff] [blame] | 604 | cold = sorted(i.size for i in f_cold) |
| 605 | hot = sorted(i.size for i in f_hot) |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 606 | except isolateserver.Aborted: |
| 607 | # This happens when a signal SIGTERM was received while uploading data. |
| 608 | # There is 2 causes: |
| 609 | # - The task was too slow and was about to be killed anyway due to |
| 610 | # exceeding the hard timeout. |
| 611 | # - The amount of data uploaded back is very large and took too much |
| 612 | # time to archive. |
| 613 | sys.stderr.write('Received SIGTERM while uploading') |
| 614 | # Re-raise, so it will be treated as an internal failure. |
| 615 | raise |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 616 | |
| 617 | success = False |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 618 | try: |
maruel | 12e3001 | 2015-10-09 11:55:35 -0700 | [diff] [blame] | 619 | if (not leak_temp_dir and fs.isdir(out_dir) and |
maruel | 6eeea7d | 2015-09-16 12:17:42 -0700 | [diff] [blame] | 620 | not file_path.rmtree(out_dir)): |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 621 | logging.error('Had difficulties removing out_dir %s', out_dir) |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 622 | else: |
| 623 | success = True |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 624 | except OSError as e: |
| 625 | # When this happens, it means there's a process error. |
maruel | 12e3001 | 2015-10-09 11:55:35 -0700 | [diff] [blame] | 626 | logging.exception('Had difficulties removing out_dir %s: %s', out_dir, e) |
nodir | 6f80188 | 2016-04-29 14:41:50 -0700 | [diff] [blame] | 627 | stats = { |
| 628 | 'duration': time.time() - start, |
| 629 | 'items_cold': base64.b64encode(large.pack(cold)), |
| 630 | 'items_hot': base64.b64encode(large.pack(hot)), |
| 631 | } |
| 632 | return outputs_ref, success, stats |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 633 | |
| 634 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 635 | def map_and_run(data, constant_run_path): |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 636 | """Runs a command with optional isolated input/output. |
| 637 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 638 | Arguments: |
| 639 | - data: TaskData instance. |
| 640 | - constant_run_path: TODO |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 641 | |
| 642 | Returns metadata about the result. |
| 643 | """ |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 644 | result = { |
Takuto Ikuta | 5ed62ad | 2019-09-26 09:16:00 +0000 | [diff] [blame] | 645 | 'duration': None, |
| 646 | 'exit_code': None, |
| 647 | 'had_hard_timeout': False, |
| 648 | 'internal_failure': 'run_isolated did not complete properly', |
| 649 | 'stats': { |
| 650 | #'cipd': { |
| 651 | # 'duration': 0., |
| 652 | # 'get_client_duration': 0., |
| 653 | #}, |
| 654 | 'isolated': { |
| 655 | 'download': { |
| 656 | #'duration': 0., |
| 657 | 'initial_number_items': len(data.isolate_cache), |
| 658 | 'initial_size': data.isolate_cache.total_size, |
| 659 | #'items_cold': '<large.pack()>', |
| 660 | #'items_hot': '<large.pack()>', |
| 661 | }, |
| 662 | #'upload': { |
| 663 | # 'duration': 0., |
| 664 | # 'items_cold': '<large.pack()>', |
| 665 | # 'items_hot': '<large.pack()>', |
| 666 | #}, |
| 667 | }, |
Marc-Antoine Ruel | 5d7606b | 2018-06-15 19:06:12 +0000 | [diff] [blame] | 668 | }, |
Takuto Ikuta | 5ed62ad | 2019-09-26 09:16:00 +0000 | [diff] [blame] | 669 | #'cipd_pins': { |
| 670 | # 'packages': [ |
| 671 | # {'package_name': ..., 'version': ..., 'path': ...}, |
| 672 | # ... |
| 673 | # ], |
| 674 | # 'client_package': {'package_name': ..., 'version': ...}, |
| 675 | #}, |
| 676 | 'outputs_ref': None, |
| 677 | 'version': 5, |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 678 | } |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 679 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 680 | if data.root_dir: |
Lei Lei | fe202df | 2019-06-11 17:33:34 +0000 | [diff] [blame] | 681 | file_path.ensure_tree(data.root_dir, 0o700) |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 682 | elif data.isolate_cache.cache_dir: |
| 683 | data = data._replace( |
| 684 | root_dir=os.path.dirname(data.isolate_cache.cache_dir)) |
maruel | e2f2cb8 | 2016-07-13 14:41:03 -0700 | [diff] [blame] | 685 | # See comment for these constants. |
maruel | cffa054 | 2017-04-07 08:39:20 -0700 | [diff] [blame] | 686 | # If root_dir is not specified, it is not constant. |
| 687 | # TODO(maruel): This is not obvious. Change this to become an error once we |
| 688 | # make the constant_run_path an exposed flag. |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 689 | if constant_run_path and data.root_dir: |
| 690 | run_dir = os.path.join(data.root_dir, ISOLATED_RUN_DIR) |
maruel | 5c4eed8 | 2017-05-26 05:33:40 -0700 | [diff] [blame] | 691 | if os.path.isdir(run_dir): |
| 692 | file_path.rmtree(run_dir) |
Lei Lei | fe202df | 2019-06-11 17:33:34 +0000 | [diff] [blame] | 693 | os.mkdir(run_dir, 0o700) |
maruel | cffa054 | 2017-04-07 08:39:20 -0700 | [diff] [blame] | 694 | else: |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 695 | run_dir = make_temp_dir(ISOLATED_RUN_DIR, data.root_dir) |
maruel | 03e1184 | 2016-07-14 10:50:16 -0700 | [diff] [blame] | 696 | # storage should be normally set but don't crash if it is not. This can happen |
| 697 | # as Swarming task can run without an isolate server. |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 698 | out_dir = make_temp_dir( |
| 699 | ISOLATED_OUT_DIR, data.root_dir) if data.storage else None |
| 700 | tmp_dir = make_temp_dir(ISOLATED_TMP_DIR, data.root_dir) |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 701 | cwd = run_dir |
Marc-Antoine Ruel | 95068cf | 2017-12-07 21:35:05 -0500 | [diff] [blame] | 702 | if data.relative_cwd: |
| 703 | cwd = os.path.normpath(os.path.join(cwd, data.relative_cwd)) |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 704 | command = data.command |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 705 | try: |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 706 | with data.install_packages_fn(run_dir) as cipd_info: |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 707 | if cipd_info: |
| 708 | result['stats']['cipd'] = cipd_info.stats |
| 709 | result['cipd_pins'] = cipd_info.pins |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 710 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 711 | if data.isolated_hash: |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 712 | isolated_stats = result['stats'].setdefault('isolated', {}) |
Marc-Antoine Ruel | 5d7606b | 2018-06-15 19:06:12 +0000 | [diff] [blame] | 713 | bundle, stats = fetch_and_map( |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 714 | isolated_hash=data.isolated_hash, |
| 715 | storage=data.storage, |
| 716 | cache=data.isolate_cache, |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 717 | outdir=run_dir, |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 718 | use_symlinks=data.use_symlinks) |
Marc-Antoine Ruel | 5d7606b | 2018-06-15 19:06:12 +0000 | [diff] [blame] | 719 | isolated_stats['download'].update(stats) |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 720 | change_tree_read_only(run_dir, bundle.read_only) |
maruel | abec63c | 2017-04-26 11:53:24 -0700 | [diff] [blame] | 721 | # Inject the command |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 722 | if not command and bundle.command: |
| 723 | command = bundle.command + data.extra_args |
Marc-Antoine Ruel | d704a1f | 2017-10-31 10:51:23 -0400 | [diff] [blame] | 724 | # Only set the relative directory if the isolated file specified a |
| 725 | # command, and no raw command was specified. |
| 726 | if bundle.relative_cwd: |
| 727 | cwd = os.path.normpath(os.path.join(cwd, bundle.relative_cwd)) |
maruel | abec63c | 2017-04-26 11:53:24 -0700 | [diff] [blame] | 728 | |
| 729 | if not command: |
| 730 | # Handle this as a task failure, not an internal failure. |
| 731 | sys.stderr.write( |
| 732 | '<No command was specified!>\n' |
| 733 | '<Please secify a command when triggering your Swarming task>\n') |
| 734 | result['exit_code'] = 1 |
| 735 | return result |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 736 | |
Marc-Antoine Ruel | 95068cf | 2017-12-07 21:35:05 -0500 | [diff] [blame] | 737 | if not cwd.startswith(run_dir): |
| 738 | # Handle this as a task failure, not an internal failure. This is a |
| 739 | # 'last chance' way to gate against directory escape. |
| 740 | sys.stderr.write('<Relative CWD is outside of run directory!>\n') |
| 741 | result['exit_code'] = 1 |
| 742 | return result |
| 743 | |
| 744 | if not os.path.isdir(cwd): |
| 745 | # Accepts relative_cwd that does not exist. |
Lei Lei | fe202df | 2019-06-11 17:33:34 +0000 | [diff] [blame] | 746 | os.makedirs(cwd, 0o700) |
Marc-Antoine Ruel | 95068cf | 2017-12-07 21:35:05 -0500 | [diff] [blame] | 747 | |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 748 | # If we have an explicit list of files to return, make sure their |
| 749 | # directories exist now. |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 750 | if data.storage and data.outputs: |
| 751 | isolateserver.create_directories(run_dir, data.outputs) |
aludwin | 0a8e17d | 2016-10-27 15:57:39 -0700 | [diff] [blame] | 752 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 753 | with data.install_named_caches(run_dir): |
nodir | d616068 | 2017-02-02 13:03:35 -0800 | [diff] [blame] | 754 | sys.stdout.flush() |
| 755 | start = time.time() |
| 756 | try: |
vadimsh | 9c54b2c | 2017-07-25 14:08:29 -0700 | [diff] [blame] | 757 | # Need to switch the default account before 'get_command_env' call, |
| 758 | # so it can grab correct value of LUCI_CONTEXT env var. |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 759 | with set_luci_context_account(data.switch_to_account, tmp_dir): |
| 760 | env = get_command_env( |
Roberto Carrillo | 71ade6d | 2018-10-08 22:30:24 +0000 | [diff] [blame] | 761 | tmp_dir, cipd_info, run_dir, data.env, data.env_prefix, out_dir, |
| 762 | data.bot_file) |
Brian Sheedy | 7a76117 | 2019-08-30 22:55:14 +0000 | [diff] [blame] | 763 | command = tools.find_executable(command, env) |
Robert Iannucci | 24ae76a | 2018-02-26 12:51:18 -0800 | [diff] [blame] | 764 | command = process_command(command, out_dir, data.bot_file) |
| 765 | file_path.ensure_command_has_abs_path(command, cwd) |
| 766 | |
vadimsh | 9c54b2c | 2017-07-25 14:08:29 -0700 | [diff] [blame] | 767 | result['exit_code'], result['had_hard_timeout'] = run_command( |
Marc-Antoine Ruel | 03c6fd1 | 2019-04-30 12:12:55 +0000 | [diff] [blame] | 768 | command, cwd, env, data.hard_timeout, data.grace_period, |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 769 | data.lower_priority, data.containment) |
nodir | d616068 | 2017-02-02 13:03:35 -0800 | [diff] [blame] | 770 | finally: |
| 771 | result['duration'] = max(time.time() - start, 0) |
Seth Koehler | 4913981 | 2017-12-19 13:59:33 -0500 | [diff] [blame] | 772 | |
| 773 | # We successfully ran the command, set internal_failure back to |
| 774 | # None (even if the command failed, it's not an internal error). |
| 775 | result['internal_failure'] = None |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 776 | except Exception as e: |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 777 | # An internal error occurred. Report accordingly so the swarming task will |
| 778 | # be retried automatically. |
maruel | 12e3001 | 2015-10-09 11:55:35 -0700 | [diff] [blame] | 779 | logging.exception('internal failure: %s', e) |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 780 | result['internal_failure'] = str(e) |
| 781 | on_error.report(None) |
aludwin | 0a8e17d | 2016-10-27 15:57:39 -0700 | [diff] [blame] | 782 | |
| 783 | # Clean up |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 784 | finally: |
| 785 | try: |
aludwin | 0a8e17d | 2016-10-27 15:57:39 -0700 | [diff] [blame] | 786 | # Try to link files to the output directory, if specified. |
| 787 | if out_dir: |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 788 | link_outputs_to_outdir(run_dir, out_dir, data.outputs) |
aludwin | 0a8e17d | 2016-10-27 15:57:39 -0700 | [diff] [blame] | 789 | |
nodir | 32a1ec1 | 2016-10-26 18:34:07 -0700 | [diff] [blame] | 790 | success = False |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 791 | if data.leak_temp_dir: |
nodir | 32a1ec1 | 2016-10-26 18:34:07 -0700 | [diff] [blame] | 792 | success = True |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 793 | logging.warning( |
| 794 | 'Deliberately leaking %s for later examination', run_dir) |
maruel | eb5fbee | 2015-09-17 13:01:36 -0700 | [diff] [blame] | 795 | else: |
maruel | 84537cb | 2015-10-16 14:21:28 -0700 | [diff] [blame] | 796 | # On Windows rmtree(run_dir) call above has a synchronization effect: it |
| 797 | # finishes only when all task child processes terminate (since a running |
| 798 | # process locks *.exe file). Examine out_dir only after that call |
| 799 | # completes (since child processes may write to out_dir too and we need |
| 800 | # to wait for them to finish). |
Takuto Ikuta | 69c0d66 | 2019-11-27 01:18:08 +0000 | [diff] [blame^] | 801 | for directory in (run_dir, tmp_dir): |
| 802 | if not fs.isdir(directory): |
| 803 | continue |
maruel | 84537cb | 2015-10-16 14:21:28 -0700 | [diff] [blame] | 804 | try: |
Takuto Ikuta | 69c0d66 | 2019-11-27 01:18:08 +0000 | [diff] [blame^] | 805 | success = file_path.rmtree(directory) |
maruel | 84537cb | 2015-10-16 14:21:28 -0700 | [diff] [blame] | 806 | except OSError as e: |
Takuto Ikuta | 69c0d66 | 2019-11-27 01:18:08 +0000 | [diff] [blame^] | 807 | logging.error('rmtree(%r) failed: %s', directory, e) |
maruel | 84537cb | 2015-10-16 14:21:28 -0700 | [diff] [blame] | 808 | success = False |
| 809 | if not success: |
Takuto Ikuta | 69c0d66 | 2019-11-27 01:18:08 +0000 | [diff] [blame^] | 810 | sys.stderr.write( |
| 811 | OUTLIVING_ZOMBIE_MSG % (directory, data.grace_period)) |
maruel | 84537cb | 2015-10-16 14:21:28 -0700 | [diff] [blame] | 812 | if result['exit_code'] == 0: |
| 813 | result['exit_code'] = 1 |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 814 | |
maruel | eb5fbee | 2015-09-17 13:01:36 -0700 | [diff] [blame] | 815 | # This deletes out_dir if leak_temp_dir is not set. |
nodir | 9130f07 | 2016-05-27 13:59:08 -0700 | [diff] [blame] | 816 | if out_dir: |
nodir | 5571571 | 2016-06-03 12:28:19 -0700 | [diff] [blame] | 817 | isolated_stats = result['stats'].setdefault('isolated', {}) |
| 818 | result['outputs_ref'], success, isolated_stats['upload'] = ( |
Takuto Ikuta | b4aa866 | 2019-09-17 05:54:36 +0000 | [diff] [blame] | 819 | upload_then_delete(data.storage, out_dir, data.leak_temp_dir)) |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 820 | if not success and result['exit_code'] == 0: |
| 821 | result['exit_code'] = 1 |
| 822 | except Exception as e: |
| 823 | # Swallow any exception in the main finally clause. |
nodir | 9130f07 | 2016-05-27 13:59:08 -0700 | [diff] [blame] | 824 | if out_dir: |
| 825 | logging.exception('Leaking out_dir %s: %s', out_dir, e) |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 826 | result['internal_failure'] = str(e) |
| 827 | return result |
Marc-Antoine Ruel | 2283ad1 | 2014-02-09 11:14:57 -0500 | [diff] [blame] | 828 | |
| 829 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 830 | def run_tha_test(data, result_json): |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 831 | """Runs an executable and records execution metadata. |
| 832 | |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 833 | If isolated_hash is specified, downloads the dependencies in the cache, |
| 834 | hardlinks them into a temporary directory and runs the command specified in |
| 835 | the .isolated. |
Marc-Antoine Ruel | 2283ad1 | 2014-02-09 11:14:57 -0500 | [diff] [blame] | 836 | |
| 837 | A temporary directory is created to hold the output files. The content inside |
| 838 | this directory will be uploaded back to |storage| packaged as a .isolated |
| 839 | file. |
| 840 | |
| 841 | Arguments: |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 842 | - data: TaskData instance. |
| 843 | - result_json: File path to dump result metadata into. If set, the process |
| 844 | exit code is always 0 unless an internal error occurred. |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 845 | |
| 846 | Returns: |
| 847 | Process exit code that should be used. |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 848 | """ |
maruel | a76b9ee | 2015-12-15 06:18:08 -0800 | [diff] [blame] | 849 | if result_json: |
| 850 | # Write a json output file right away in case we get killed. |
| 851 | result = { |
| 852 | 'exit_code': None, |
| 853 | 'had_hard_timeout': False, |
| 854 | 'internal_failure': 'Was terminated before completion', |
| 855 | 'outputs_ref': None, |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 856 | 'version': 5, |
maruel | a76b9ee | 2015-12-15 06:18:08 -0800 | [diff] [blame] | 857 | } |
| 858 | tools.write_json(result_json, result, dense=True) |
| 859 | |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 860 | # run_isolated exit code. Depends on if result_json is used or not. |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 861 | result = map_and_run(data, True) |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 862 | logging.info('Result:\n%s', tools.format_json(result, dense=True)) |
bpastene | 3ae0952 | 2016-06-10 17:12:59 -0700 | [diff] [blame] | 863 | |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 864 | if result_json: |
maruel | 05d5a88 | 2015-09-21 13:59:02 -0700 | [diff] [blame] | 865 | # We've found tests to delete 'work' when quitting, causing an exception |
| 866 | # here. Try to recreate the directory if necessary. |
nodir | e5028a9 | 2016-04-29 14:38:21 -0700 | [diff] [blame] | 867 | file_path.ensure_tree(os.path.dirname(result_json)) |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 868 | tools.write_json(result_json, result, dense=True) |
| 869 | # Only return 1 if there was an internal error. |
| 870 | return int(bool(result['internal_failure'])) |
maruel@chromium.org | 781ccf6 | 2013-09-17 19:39:47 +0000 | [diff] [blame] | 871 | |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 872 | # Marshall into old-style inline output. |
| 873 | if result['outputs_ref']: |
Marc-Antoine Ruel | 793bff3 | 2019-04-18 17:50:48 +0000 | [diff] [blame] | 874 | # pylint: disable=unsubscriptable-object |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 875 | data = { |
| 876 | 'hash': result['outputs_ref']['isolated'], |
| 877 | 'namespace': result['outputs_ref']['namespace'], |
| 878 | 'storage': result['outputs_ref']['isolatedserver'], |
| 879 | } |
Marc-Antoine Ruel | c44f572 | 2015-01-08 16:10:01 -0500 | [diff] [blame] | 880 | sys.stdout.flush() |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 881 | print( |
| 882 | '[run_isolated_out_hack]%s[/run_isolated_out_hack]' % |
| 883 | tools.format_json(data, dense=True)) |
maruel | b76604c | 2015-11-11 11:53:44 -0800 | [diff] [blame] | 884 | sys.stdout.flush() |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 885 | return result['exit_code'] or int(bool(result['internal_failure'])) |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 886 | |
| 887 | |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 888 | # Yielded by 'install_client_and_packages'. |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 889 | CipdInfo = collections.namedtuple('CipdInfo', [ |
| 890 | 'client', # cipd.CipdClient object |
| 891 | 'cache_dir', # absolute path to bot-global cipd tag and instance cache |
| 892 | 'stats', # dict with stats to return to the server |
| 893 | 'pins', # dict with installed cipd pins to return to the server |
| 894 | ]) |
| 895 | |
| 896 | |
| 897 | @contextlib.contextmanager |
| 898 | def noop_install_packages(_run_dir): |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 899 | """Placeholder for 'install_client_and_packages' if cipd is disabled.""" |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 900 | yield None |
| 901 | |
| 902 | |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 903 | def _install_packages(run_dir, cipd_cache_dir, client, packages, timeout): |
| 904 | """Calls 'cipd ensure' for packages. |
| 905 | |
| 906 | Args: |
| 907 | run_dir (str): root of installation. |
| 908 | cipd_cache_dir (str): the directory to use for the cipd package cache. |
| 909 | client (CipdClient): the cipd client to use |
| 910 | packages: packages to install, list [(path, package_name, version), ...]. |
| 911 | timeout: max duration in seconds that this function can take. |
| 912 | |
| 913 | Returns: list of pinned packages. Looks like [ |
| 914 | { |
| 915 | 'path': 'subdirectory', |
| 916 | 'package_name': 'resolved/package/name', |
| 917 | 'version': 'deadbeef...', |
| 918 | }, |
| 919 | ... |
| 920 | ] |
| 921 | """ |
| 922 | package_pins = [None]*len(packages) |
| 923 | def insert_pin(path, name, version, idx): |
| 924 | package_pins[idx] = { |
| 925 | 'package_name': name, |
| 926 | # swarming deals with 'root' as '.' |
| 927 | 'path': path or '.', |
| 928 | 'version': version, |
| 929 | } |
| 930 | |
| 931 | by_path = collections.defaultdict(list) |
| 932 | for i, (path, name, version) in enumerate(packages): |
| 933 | # cipd deals with 'root' as '' |
| 934 | if path == '.': |
| 935 | path = '' |
| 936 | by_path[path].append((name, version, i)) |
| 937 | |
| 938 | pins = client.ensure( |
| 939 | run_dir, |
| 940 | { |
| 941 | subdir: [(name, vers) for name, vers, _ in pkgs] |
Marc-Antoine Ruel | 04903a3 | 2019-10-09 21:09:25 +0000 | [diff] [blame] | 942 | for subdir, pkgs in by_path.items() |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 943 | }, |
| 944 | cache_dir=cipd_cache_dir, |
| 945 | timeout=timeout, |
| 946 | ) |
| 947 | |
Marc-Antoine Ruel | 04903a3 | 2019-10-09 21:09:25 +0000 | [diff] [blame] | 948 | for subdir, pin_list in sorted(pins.items()): |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 949 | this_subdir = by_path[subdir] |
| 950 | for i, (name, version) in enumerate(pin_list): |
| 951 | insert_pin(subdir, name, version, this_subdir[i][2]) |
| 952 | |
Robert Iannucci | 461b30d | 2017-12-13 11:34:03 -0800 | [diff] [blame] | 953 | assert None not in package_pins, (packages, pins, package_pins) |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 954 | |
| 955 | return package_pins |
| 956 | |
| 957 | |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 958 | @contextlib.contextmanager |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 959 | def install_client_and_packages( |
nodir | ff531b4 | 2016-06-23 13:05:06 -0700 | [diff] [blame] | 960 | run_dir, packages, service_url, client_package_name, |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 961 | client_version, cache_dir, timeout=None): |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 962 | """Bootstraps CIPD client and installs CIPD packages. |
iannucci | 96fcccc | 2016-08-30 15:52:22 -0700 | [diff] [blame] | 963 | |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 964 | Yields CipdClient, stats, client info and pins (as single CipdInfo object). |
| 965 | |
| 966 | Pins and the CIPD client info are in the form of: |
iannucci | 96fcccc | 2016-08-30 15:52:22 -0700 | [diff] [blame] | 967 | [ |
| 968 | { |
| 969 | "path": path, "package_name": package_name, "version": version, |
| 970 | }, |
| 971 | ... |
| 972 | ] |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 973 | (the CIPD client info is a single dictionary instead of a list) |
iannucci | 96fcccc | 2016-08-30 15:52:22 -0700 | [diff] [blame] | 974 | |
| 975 | such that they correspond 1:1 to all input package arguments from the command |
| 976 | line. These dictionaries make their all the way back to swarming, where they |
| 977 | become the arguments of CipdPackage. |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 978 | |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 979 | If 'packages' list is empty, will bootstrap CIPD client, but won't install |
| 980 | any packages. |
| 981 | |
| 982 | The bootstrapped client (regardless whether 'packages' list is empty or not), |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 983 | will be made available to the task via $PATH. |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 984 | |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 985 | Args: |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 986 | run_dir (str): root of installation. |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 987 | packages: packages to install, list [(path, package_name, version), ...]. |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 988 | service_url (str): CIPD server url, e.g. |
| 989 | "https://chrome-infra-packages.appspot.com." |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 990 | client_package_name (str): CIPD package name of CIPD client. |
| 991 | client_version (str): Version of CIPD client. |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 992 | cache_dir (str): where to keep cache of cipd clients, packages and tags. |
| 993 | timeout: max duration in seconds that this function can take. |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 994 | """ |
| 995 | assert cache_dir |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 996 | |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 997 | timeoutfn = tools.sliding_timeout(timeout) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 998 | start = time.time() |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 999 | |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 1000 | cache_dir = os.path.abspath(cache_dir) |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 1001 | cipd_cache_dir = os.path.join(cache_dir, 'cache') # tag and instance caches |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1002 | run_dir = os.path.abspath(run_dir) |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 1003 | packages = packages or [] |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1004 | |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1005 | get_client_start = time.time() |
| 1006 | client_manager = cipd.get_client( |
| 1007 | service_url, client_package_name, client_version, cache_dir, |
| 1008 | timeout=timeoutfn()) |
iannucci | 96fcccc | 2016-08-30 15:52:22 -0700 | [diff] [blame] | 1009 | |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1010 | with client_manager as client: |
| 1011 | get_client_duration = time.time() - get_client_start |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1012 | |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 1013 | package_pins = [] |
| 1014 | if packages: |
| 1015 | package_pins = _install_packages( |
| 1016 | run_dir, cipd_cache_dir, client, packages, timeoutfn()) |
| 1017 | |
| 1018 | file_path.make_tree_files_read_only(run_dir) |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1019 | |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 1020 | total_duration = time.time() - start |
| 1021 | logging.info( |
| 1022 | 'Installing CIPD client and packages took %d seconds', total_duration) |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1023 | |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 1024 | yield CipdInfo( |
| 1025 | client=client, |
| 1026 | cache_dir=cipd_cache_dir, |
| 1027 | stats={ |
| 1028 | 'duration': total_duration, |
| 1029 | 'get_client_duration': get_client_duration, |
| 1030 | }, |
| 1031 | pins={ |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 1032 | 'client_package': { |
| 1033 | 'package_name': client.package_name, |
| 1034 | 'version': client.instance_id, |
| 1035 | }, |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 1036 | 'packages': package_pins, |
| 1037 | }) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1038 | |
| 1039 | |
| 1040 | def create_option_parser(): |
Marc-Antoine Ruel | f74cffe | 2015-07-15 15:21:34 -0400 | [diff] [blame] | 1041 | parser = logging_utils.OptionParserWithLogging( |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 1042 | usage='%prog <options> [command to run or extra args]', |
maruel@chromium.org | dedbf49 | 2013-09-12 20:42:11 +0000 | [diff] [blame] | 1043 | version=__version__, |
| 1044 | log_file=RUN_ISOLATED_LOG_FILE) |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 1045 | parser.add_option( |
maruel | 36a963d | 2016-04-08 17:15:49 -0700 | [diff] [blame] | 1046 | '--clean', action='store_true', |
| 1047 | help='Cleans the cache, trimming it necessary and remove corrupted items ' |
| 1048 | 'and returns without executing anything; use with -v to know what ' |
| 1049 | 'was done') |
| 1050 | parser.add_option( |
maruel | 4409e30 | 2016-07-19 14:25:51 -0700 | [diff] [blame] | 1051 | '--use-symlinks', action='store_true', |
| 1052 | help='Use symlinks instead of hardlinks') |
| 1053 | parser.add_option( |
maruel | a9cfd6f | 2015-09-15 11:03:15 -0700 | [diff] [blame] | 1054 | '--json', |
| 1055 | help='dump output metadata to json file. When used, run_isolated returns ' |
| 1056 | 'non-zero only on internal failure') |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 1057 | parser.add_option( |
maruel | 5c9e47b | 2015-12-18 13:02:30 -0800 | [diff] [blame] | 1058 | '--hard-timeout', type='float', help='Enforce hard timeout in execution') |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 1059 | parser.add_option( |
maruel | 5c9e47b | 2015-12-18 13:02:30 -0800 | [diff] [blame] | 1060 | '--grace-period', type='float', |
maruel | 6be7f9e | 2015-10-01 12:25:30 -0700 | [diff] [blame] | 1061 | help='Grace period between SIGTERM and SIGKILL') |
bpastene | 3ae0952 | 2016-06-10 17:12:59 -0700 | [diff] [blame] | 1062 | parser.add_option( |
Marc-Antoine Ruel | 49e347d | 2017-10-24 16:52:02 -0700 | [diff] [blame] | 1063 | '--raw-cmd', action='store_true', |
| 1064 | help='Ignore the isolated command, use the one supplied at the command ' |
| 1065 | 'line') |
| 1066 | parser.add_option( |
Marc-Antoine Ruel | 95068cf | 2017-12-07 21:35:05 -0500 | [diff] [blame] | 1067 | '--relative-cwd', |
| 1068 | help='Ignore the isolated \'relative_cwd\' and use this one instead; ' |
| 1069 | 'requires --raw-cmd') |
| 1070 | parser.add_option( |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 1071 | '--env', default=[], action='append', |
| 1072 | help='Environment variables to set for the child process') |
| 1073 | parser.add_option( |
| 1074 | '--env-prefix', default=[], action='append', |
Robert Iannucci | bf5f84c | 2017-11-22 12:56:50 -0800 | [diff] [blame] | 1075 | help='Specify a VAR=./path/fragment to put in the environment variable ' |
| 1076 | 'before executing the command. The path fragment must be relative ' |
| 1077 | 'to the isolated run directory, and must not contain a `..` token. ' |
| 1078 | 'The path will be made absolute and prepended to the indicated ' |
| 1079 | '$VAR using the OS\'s path separator. Multiple items for the same ' |
| 1080 | '$VAR will be prepended in order.') |
| 1081 | parser.add_option( |
bpastene | 3ae0952 | 2016-06-10 17:12:59 -0700 | [diff] [blame] | 1082 | '--bot-file', |
| 1083 | help='Path to a file describing the state of the host. The content is ' |
| 1084 | 'defined by on_before_task() in bot_config.') |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 1085 | parser.add_option( |
vadimsh | 9c54b2c | 2017-07-25 14:08:29 -0700 | [diff] [blame] | 1086 | '--switch-to-account', |
| 1087 | help='If given, switches LUCI_CONTEXT to given logical service account ' |
| 1088 | '(e.g. "task" or "system") before launching the isolated process.') |
| 1089 | parser.add_option( |
aludwin | 0a8e17d | 2016-10-27 15:57:39 -0700 | [diff] [blame] | 1090 | '--output', action='append', |
| 1091 | help='Specifies an output to return. If no outputs are specified, all ' |
| 1092 | 'files located in $(ISOLATED_OUTDIR) will be returned; ' |
| 1093 | 'otherwise, outputs in both $(ISOLATED_OUTDIR) and those ' |
| 1094 | 'specified by --output option (there can be multiple) will be ' |
| 1095 | 'returned. Note that if a file in OUT_DIR has the same path ' |
| 1096 | 'as an --output option, the --output version will be returned.') |
| 1097 | parser.add_option( |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 1098 | '-a', '--argsfile', |
| 1099 | # This is actually handled in parse_args; it's included here purely so it |
| 1100 | # can make it into the help text. |
| 1101 | help='Specify a file containing a JSON array of arguments to this ' |
| 1102 | 'script. If --argsfile is provided, no other argument may be ' |
| 1103 | 'provided on the command line.') |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 1104 | |
| 1105 | group = optparse.OptionGroup(parser, 'Data source') |
| 1106 | group.add_option( |
Marc-Antoine Ruel | 185ded4 | 2015-01-28 20:49:18 -0500 | [diff] [blame] | 1107 | '-s', '--isolated', |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 1108 | help='Hash of the .isolated to grab from the isolate server.') |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 1109 | isolateserver.add_isolate_server_options(group) |
| 1110 | parser.add_option_group(group) |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 1111 | |
Marc-Antoine Ruel | a57d7db | 2014-10-15 20:31:19 -0400 | [diff] [blame] | 1112 | isolateserver.add_cache_options(parser) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1113 | |
| 1114 | cipd.add_cipd_options(parser) |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1115 | |
| 1116 | group = optparse.OptionGroup(parser, 'Named caches') |
| 1117 | group.add_option( |
| 1118 | '--named-cache', |
| 1119 | dest='named_caches', |
| 1120 | action='append', |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1121 | nargs=3, |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1122 | default=[], |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1123 | help='A named cache to request. Accepts 3 arguments: name, path, hint. ' |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1124 | 'name identifies the cache, must match regex [a-z0-9_]{1,4096}. ' |
| 1125 | 'path is a path relative to the run dir where the cache directory ' |
| 1126 | 'must be put to. ' |
| 1127 | 'This option can be specified more than once.') |
| 1128 | group.add_option( |
| 1129 | '--named-cache-root', default='named_caches', |
| 1130 | help='Cache root directory. Default=%default') |
| 1131 | parser.add_option_group(group) |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 1132 | |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 1133 | group = optparse.OptionGroup(parser, 'Process containment') |
| 1134 | parser.add_option( |
| 1135 | '--lower-priority', action='store_true', |
| 1136 | help='Lowers the child process priority') |
| 1137 | parser.add_option( |
| 1138 | '--containment-type', choices=('NONE', 'AUTO', 'JOB_OBJECT'), |
| 1139 | default='NONE', |
| 1140 | help='Type of container to use') |
| 1141 | parser.add_option( |
| 1142 | '--limit-processes', type='int', default=0, |
| 1143 | help='Maximum number of active processes in the containment') |
| 1144 | parser.add_option( |
| 1145 | '--limit-total-committed-memory', type='int', default=0, |
| 1146 | help='Maximum sum of committed memory in the containment') |
| 1147 | parser.add_option_group(group) |
| 1148 | |
| 1149 | group = optparse.OptionGroup(parser, 'Debugging') |
| 1150 | group.add_option( |
Kenneth Russell | 61d4235 | 2014-09-15 11:41:16 -0700 | [diff] [blame] | 1151 | '--leak-temp-dir', |
| 1152 | action='store_true', |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1153 | help='Deliberately leak isolate\'s temp dir for later examination. ' |
| 1154 | 'Default: %default') |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 1155 | group.add_option( |
maruel | eb5fbee | 2015-09-17 13:01:36 -0700 | [diff] [blame] | 1156 | '--root-dir', help='Use a directory instead of a random one') |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 1157 | parser.add_option_group(group) |
Kenneth Russell | 61d4235 | 2014-09-15 11:41:16 -0700 | [diff] [blame] | 1158 | |
Vadim Shtayura | e34e13a | 2014-02-02 11:23:26 -0800 | [diff] [blame] | 1159 | auth.add_auth_options(parser) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1160 | |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1161 | parser.set_defaults(cache='cache', cipd_cache='cipd_cache') |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1162 | return parser |
| 1163 | |
| 1164 | |
Marc-Antoine Ruel | 49f9f8d | 2018-05-24 15:57:06 -0400 | [diff] [blame] | 1165 | def process_named_cache_options(parser, options, time_fn=None): |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1166 | """Validates named cache options and returns a CacheManager.""" |
| 1167 | if options.named_caches and not options.named_cache_root: |
| 1168 | parser.error('--named-cache is specified, but --named-cache-root is empty') |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1169 | for name, path, hint in options.named_caches: |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1170 | if not CACHE_NAME_RE.match(name): |
| 1171 | parser.error( |
| 1172 | 'cache name %r does not match %r' % (name, CACHE_NAME_RE.pattern)) |
| 1173 | if not path: |
| 1174 | parser.error('cache path cannot be empty') |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1175 | try: |
| 1176 | long(hint) |
| 1177 | except ValueError: |
| 1178 | parser.error('cache hint must be a number') |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1179 | if options.named_cache_root: |
| 1180 | # Make these configurable later if there is use case but for now it's fairly |
| 1181 | # safe values. |
| 1182 | # In practice, a fair chunk of bots are already recycled on a daily schedule |
| 1183 | # so this code doesn't have any effect to them, unless they are preloaded |
| 1184 | # with a really old cache. |
| 1185 | policies = local_caching.CachePolicies( |
| 1186 | # 1TiB. |
| 1187 | max_cache_size=1024*1024*1024*1024, |
| 1188 | min_free_space=options.min_free_space, |
| 1189 | max_items=50, |
Marc-Antoine Ruel | 5d7606b | 2018-06-15 19:06:12 +0000 | [diff] [blame] | 1190 | max_age_secs=MAX_AGE_SECS) |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 1191 | root_dir = six.text_type(os.path.abspath(options.named_cache_root)) |
Marc-Antoine Ruel | 49f9f8d | 2018-05-24 15:57:06 -0400 | [diff] [blame] | 1192 | return local_caching.NamedCache(root_dir, policies, time_fn=time_fn) |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1193 | return None |
| 1194 | |
| 1195 | |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 1196 | def parse_args(args): |
| 1197 | # Create a fake mini-parser just to get out the "-a" command. Note that |
| 1198 | # it's not documented here; instead, it's documented in create_option_parser |
| 1199 | # even though that parser will never actually get to parse it. This is |
| 1200 | # because --argsfile is exclusive with all other options and arguments. |
| 1201 | file_argparse = argparse.ArgumentParser(add_help=False) |
| 1202 | file_argparse.add_argument('-a', '--argsfile') |
| 1203 | (file_args, nonfile_args) = file_argparse.parse_known_args(args) |
| 1204 | if file_args.argsfile: |
| 1205 | if nonfile_args: |
| 1206 | file_argparse.error('Can\'t specify --argsfile with' |
| 1207 | 'any other arguments (%s)' % nonfile_args) |
| 1208 | try: |
| 1209 | with open(file_args.argsfile, 'r') as f: |
| 1210 | args = json.load(f) |
| 1211 | except (IOError, OSError, ValueError) as e: |
| 1212 | # We don't need to error out here - "args" is now empty, |
| 1213 | # so the call below to parser.parse_args(args) will fail |
| 1214 | # and print the full help text. |
Marc-Antoine Ruel | f899c48 | 2019-10-10 23:32:06 +0000 | [diff] [blame] | 1215 | print('Couldn\'t read arguments: %s' % e, file=sys.stderr) |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 1216 | |
| 1217 | # Even if we failed to read the args, just call the normal parser now since it |
| 1218 | # will print the correct help message. |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1219 | parser = create_option_parser() |
Marc-Antoine Ruel | 90c9816 | 2013-12-18 15:11:57 -0500 | [diff] [blame] | 1220 | options, args = parser.parse_args(args) |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 1221 | return (parser, options, args) |
| 1222 | |
| 1223 | |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1224 | def _calc_named_cache_hint(named_cache, named_caches): |
| 1225 | """Returns the expected size of the missing named caches.""" |
| 1226 | present = named_cache.available |
| 1227 | size = 0 |
| 1228 | for name, _, hint in named_caches: |
| 1229 | if name not in present: |
| 1230 | hint = long(hint) |
| 1231 | if hint > 0: |
| 1232 | size += hint |
| 1233 | return size |
| 1234 | |
| 1235 | |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 1236 | def main(args): |
Marc-Antoine Ruel | ee6ca62 | 2017-11-29 11:19:16 -0500 | [diff] [blame] | 1237 | # Warning: when --argsfile is used, the strings are unicode instances, when |
| 1238 | # parsed normally, the strings are str instances. |
aludwin | 7556e0c | 2016-10-26 08:46:10 -0700 | [diff] [blame] | 1239 | (parser, options, args) = parse_args(args) |
maruel | 36a963d | 2016-04-08 17:15:49 -0700 | [diff] [blame] | 1240 | |
Marc-Antoine Ruel | 5028ba2 | 2017-08-25 17:37:51 -0400 | [diff] [blame] | 1241 | if not file_path.enable_symlink(): |
Marc-Antoine Ruel | 5a02427 | 2019-01-15 20:11:16 +0000 | [diff] [blame] | 1242 | logging.warning('Symlink support is not enabled') |
Marc-Antoine Ruel | 5028ba2 | 2017-08-25 17:37:51 -0400 | [diff] [blame] | 1243 | |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1244 | named_cache = process_named_cache_options(parser, options) |
Marc-Antoine Ruel | 0d8b0f6 | 2018-09-10 14:40:35 +0000 | [diff] [blame] | 1245 | # hint is 0 if there's no named cache. |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1246 | hint = _calc_named_cache_hint(named_cache, options.named_caches) |
| 1247 | if hint: |
| 1248 | # Increase the --min-free-space value by the hint, and recreate the |
| 1249 | # NamedCache instance so it gets the updated CachePolicy. |
| 1250 | options.min_free_space += hint |
| 1251 | named_cache = process_named_cache_options(parser, options) |
| 1252 | |
Marc-Antoine Ruel | 7139d91 | 2018-06-15 20:04:42 +0000 | [diff] [blame] | 1253 | # TODO(maruel): CIPD caches should be defined at an higher level here too, so |
| 1254 | # they can be cleaned the same way. |
nodir | f33b8d6 | 2016-10-26 22:34:58 -0700 | [diff] [blame] | 1255 | isolate_cache = isolateserver.process_cache_options(options, trim=False) |
Marc-Antoine Ruel | 7139d91 | 2018-06-15 20:04:42 +0000 | [diff] [blame] | 1256 | caches = [] |
| 1257 | if isolate_cache: |
| 1258 | caches.append(isolate_cache) |
| 1259 | if named_cache: |
| 1260 | caches.append(named_cache) |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 1261 | root = caches[0].cache_dir if caches else six.text_type(os.getcwd()) |
maruel | 36a963d | 2016-04-08 17:15:49 -0700 | [diff] [blame] | 1262 | if options.clean: |
| 1263 | if options.isolated: |
| 1264 | parser.error('Can\'t use --isolated with --clean.') |
| 1265 | if options.isolate_server: |
| 1266 | parser.error('Can\'t use --isolate-server with --clean.') |
| 1267 | if options.json: |
| 1268 | parser.error('Can\'t use --json with --clean.') |
nodir | f33b8d6 | 2016-10-26 22:34:58 -0700 | [diff] [blame] | 1269 | if options.named_caches: |
| 1270 | parser.error('Can\t use --named-cache with --clean.') |
Marc-Antoine Ruel | 7139d91 | 2018-06-15 20:04:42 +0000 | [diff] [blame] | 1271 | # Trim first, then clean. |
| 1272 | local_caching.trim_caches( |
| 1273 | caches, |
| 1274 | root, |
| 1275 | min_free_space=options.min_free_space, |
| 1276 | max_age_secs=MAX_AGE_SECS) |
| 1277 | for c in caches: |
Marc-Antoine Ruel | 87fc222 | 2018-06-18 13:09:24 +0000 | [diff] [blame] | 1278 | c.cleanup() |
maruel | 36a963d | 2016-04-08 17:15:49 -0700 | [diff] [blame] | 1279 | return 0 |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1280 | |
| 1281 | # Trim must still be done for the following case: |
| 1282 | # - named-cache was used |
| 1283 | # - some entries, with a large hint, where missing |
| 1284 | # - --min-free-space was increased accordingly, thus trimming is needed |
| 1285 | # Otherwise, this will have no effect, as bot_main calls run_isolated with |
| 1286 | # --clean after each task. |
| 1287 | if hint: |
| 1288 | logging.info('Additional trimming of %d bytes', hint) |
Marc-Antoine Ruel | 0d8b0f6 | 2018-09-10 14:40:35 +0000 | [diff] [blame] | 1289 | local_caching.trim_caches( |
| 1290 | caches, |
| 1291 | root, |
| 1292 | min_free_space=options.min_free_space, |
| 1293 | max_age_secs=MAX_AGE_SECS) |
maruel | 36a963d | 2016-04-08 17:15:49 -0700 | [diff] [blame] | 1294 | |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 1295 | if not options.isolated and not args: |
| 1296 | parser.error('--isolated or command to run is required.') |
| 1297 | |
Vadim Shtayura | 5d1efce | 2014-02-04 10:55:43 -0800 | [diff] [blame] | 1298 | auth.process_auth_options(parser, options) |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 1299 | |
| 1300 | isolateserver.process_isolate_server_options( |
Marc-Antoine Ruel | 5028ba2 | 2017-08-25 17:37:51 -0400 | [diff] [blame] | 1301 | parser, options, True, False) |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 1302 | if not options.isolate_server: |
| 1303 | if options.isolated: |
| 1304 | parser.error('--isolated requires --isolate-server') |
| 1305 | if ISOLATED_OUTDIR_PARAMETER in args: |
| 1306 | parser.error( |
| 1307 | '%s in args requires --isolate-server' % ISOLATED_OUTDIR_PARAMETER) |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 1308 | |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1309 | if options.root_dir: |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 1310 | options.root_dir = six.text_type(os.path.abspath(options.root_dir)) |
maruel | 12e3001 | 2015-10-09 11:55:35 -0700 | [diff] [blame] | 1311 | if options.json: |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 1312 | options.json = six.text_type(os.path.abspath(options.json)) |
nodir | 55be77b | 2016-05-03 09:39:57 -0700 | [diff] [blame] | 1313 | |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 1314 | if any('=' not in i for i in options.env): |
| 1315 | parser.error( |
| 1316 | '--env required key=value form. value can be skipped to delete ' |
| 1317 | 'the variable') |
Marc-Antoine Ruel | 7a68f71 | 2017-12-01 18:45:18 -0500 | [diff] [blame] | 1318 | options.env = dict(i.split('=', 1) for i in options.env) |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 1319 | |
| 1320 | prefixes = {} |
| 1321 | cwd = os.path.realpath(os.getcwd()) |
| 1322 | for item in options.env_prefix: |
| 1323 | if '=' not in item: |
| 1324 | parser.error( |
| 1325 | '--env-prefix %r is malformed, must be in the form `VAR=./path`' |
| 1326 | % item) |
Marc-Antoine Ruel | 7a68f71 | 2017-12-01 18:45:18 -0500 | [diff] [blame] | 1327 | key, opath = item.split('=', 1) |
Marc-Antoine Ruel | 19dd887 | 2017-11-28 18:33:39 -0500 | [diff] [blame] | 1328 | if os.path.isabs(opath): |
| 1329 | parser.error('--env-prefix %r path is bad, must be relative.' % opath) |
| 1330 | opath = os.path.normpath(opath) |
| 1331 | if not os.path.realpath(os.path.join(cwd, opath)).startswith(cwd): |
| 1332 | parser.error( |
| 1333 | '--env-prefix %r path is bad, must be relative and not contain `..`.' |
| 1334 | % opath) |
| 1335 | prefixes.setdefault(key, []).append(opath) |
| 1336 | options.env_prefix = prefixes |
Robert Iannucci | bf5f84c | 2017-11-22 12:56:50 -0800 | [diff] [blame] | 1337 | |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1338 | cipd.validate_cipd_options(parser, options) |
| 1339 | |
vadimsh | 232f5a8 | 2017-01-20 19:23:44 -0800 | [diff] [blame] | 1340 | install_packages_fn = noop_install_packages |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 1341 | if options.cipd_enabled: |
iannucci | b58d10d | 2017-03-18 02:00:25 -0700 | [diff] [blame] | 1342 | install_packages_fn = lambda run_dir: install_client_and_packages( |
vadimsh | 902948e | 2017-01-20 15:57:32 -0800 | [diff] [blame] | 1343 | run_dir, cipd.parse_package_args(options.cipd_packages), |
| 1344 | options.cipd_server, options.cipd_client_package, |
| 1345 | options.cipd_client_version, cache_dir=options.cipd_cache) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1346 | |
nodir | d616068 | 2017-02-02 13:03:35 -0800 | [diff] [blame] | 1347 | @contextlib.contextmanager |
nodir | 0ae98b3 | 2017-05-11 13:21:53 -0700 | [diff] [blame] | 1348 | def install_named_caches(run_dir): |
nodir | d616068 | 2017-02-02 13:03:35 -0800 | [diff] [blame] | 1349 | # WARNING: this function depends on "options" variable defined in the outer |
| 1350 | # function. |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 1351 | assert six.text_type(run_dir), repr(run_dir) |
Marc-Antoine Ruel | 49f9f8d | 2018-05-24 15:57:06 -0400 | [diff] [blame] | 1352 | assert os.path.isabs(run_dir), run_dir |
Takuto Ikuta | 6e2ff96 | 2019-10-29 12:35:27 +0000 | [diff] [blame] | 1353 | named_caches = [(os.path.join(run_dir, six.text_type(relpath)), name) |
| 1354 | for name, relpath, _ in options.named_caches] |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1355 | for path, name in named_caches: |
Marc-Antoine Ruel | e79ddbf | 2018-06-13 18:33:07 +0000 | [diff] [blame] | 1356 | named_cache.install(path, name) |
nodir | d616068 | 2017-02-02 13:03:35 -0800 | [diff] [blame] | 1357 | try: |
| 1358 | yield |
| 1359 | finally: |
dnj | e289d13 | 2017-07-07 11:16:44 -0700 | [diff] [blame] | 1360 | # Uninstall each named cache, returning it to the cache pool. If an |
| 1361 | # uninstall fails for a given cache, it will remain in the task's |
| 1362 | # temporary space, get cleaned up by the Swarming bot, and be lost. |
| 1363 | # |
| 1364 | # If the Swarming bot cannot clean up the cache, it will handle it like |
| 1365 | # any other bot file that could not be removed. |
Marc-Antoine Ruel | c7a704b | 2018-08-29 19:02:23 +0000 | [diff] [blame] | 1366 | for path, name in reversed(named_caches): |
Marc-Antoine Ruel | e79ddbf | 2018-06-13 18:33:07 +0000 | [diff] [blame] | 1367 | try: |
Marc-Antoine Ruel | e955837 | 2018-08-03 03:41:22 +0000 | [diff] [blame] | 1368 | # uninstall() doesn't trim but does call save() implicitly. Trimming |
| 1369 | # *must* be done manually via periodic 'run_isolated.py --clean'. |
Marc-Antoine Ruel | e79ddbf | 2018-06-13 18:33:07 +0000 | [diff] [blame] | 1370 | named_cache.uninstall(path, name) |
| 1371 | except local_caching.NamedCacheError: |
| 1372 | logging.exception('Error while removing named cache %r at %r. ' |
| 1373 | 'The cache will be lost.', path, name) |
nodir | f33b8d6 | 2016-10-26 22:34:58 -0700 | [diff] [blame] | 1374 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1375 | extra_args = [] |
| 1376 | command = [] |
| 1377 | if options.raw_cmd: |
| 1378 | command = args |
Marc-Antoine Ruel | 95068cf | 2017-12-07 21:35:05 -0500 | [diff] [blame] | 1379 | if options.relative_cwd: |
| 1380 | a = os.path.normpath(os.path.abspath(options.relative_cwd)) |
| 1381 | if not a.startswith(os.getcwd()): |
| 1382 | parser.error( |
| 1383 | '--relative-cwd must not try to escape the working directory') |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1384 | else: |
Marc-Antoine Ruel | 95068cf | 2017-12-07 21:35:05 -0500 | [diff] [blame] | 1385 | if options.relative_cwd: |
| 1386 | parser.error('--relative-cwd requires --raw-cmd') |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1387 | extra_args = args |
| 1388 | |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 1389 | containment_type = subprocess42.Containment.NONE |
| 1390 | if options.containment_type == 'AUTO': |
| 1391 | containment_type = subprocess42.Containment.AUTO |
| 1392 | if options.containment_type == 'JOB_OBJECT': |
| 1393 | containment_type = subprocess42.Containment.JOB_OBJECT |
| 1394 | containment = subprocess42.Containment( |
| 1395 | containment_type=containment_type, |
| 1396 | limit_processes=options.limit_processes, |
| 1397 | limit_total_committed_memory=options.limit_total_committed_memory) |
| 1398 | |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1399 | data = TaskData( |
| 1400 | command=command, |
Marc-Antoine Ruel | 95068cf | 2017-12-07 21:35:05 -0500 | [diff] [blame] | 1401 | relative_cwd=options.relative_cwd, |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1402 | extra_args=extra_args, |
| 1403 | isolated_hash=options.isolated, |
| 1404 | storage=None, |
| 1405 | isolate_cache=isolate_cache, |
| 1406 | outputs=options.output, |
| 1407 | install_named_caches=install_named_caches, |
| 1408 | leak_temp_dir=options.leak_temp_dir, |
| 1409 | root_dir=_to_unicode(options.root_dir), |
| 1410 | hard_timeout=options.hard_timeout, |
| 1411 | grace_period=options.grace_period, |
| 1412 | bot_file=options.bot_file, |
| 1413 | switch_to_account=options.switch_to_account, |
| 1414 | install_packages_fn=install_packages_fn, |
Marc-Antoine Ruel | 03c6fd1 | 2019-04-30 12:12:55 +0000 | [diff] [blame] | 1415 | use_symlinks=bool(options.use_symlinks), |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1416 | env=options.env, |
Marc-Antoine Ruel | 03c6fd1 | 2019-04-30 12:12:55 +0000 | [diff] [blame] | 1417 | env_prefix=options.env_prefix, |
Marc-Antoine Ruel | 1b65f4e | 2019-05-02 21:56:58 +0000 | [diff] [blame] | 1418 | lower_priority=bool(options.lower_priority), |
| 1419 | containment=containment) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1420 | try: |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1421 | if options.isolate_server: |
Marc-Antoine Ruel | b851313 | 2018-11-20 19:48:53 +0000 | [diff] [blame] | 1422 | server_ref = isolate_storage.ServerRef( |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1423 | options.isolate_server, options.namespace) |
Marc-Antoine Ruel | b851313 | 2018-11-20 19:48:53 +0000 | [diff] [blame] | 1424 | storage = isolateserver.get_storage(server_ref) |
nodir | 90bc8dc | 2016-06-15 13:35:21 -0700 | [diff] [blame] | 1425 | with storage: |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1426 | data = data._replace(storage=storage) |
nodir | f33b8d6 | 2016-10-26 22:34:58 -0700 | [diff] [blame] | 1427 | # Hashing schemes used by |storage| and |isolate_cache| MUST match. |
Marc-Antoine Ruel | b851313 | 2018-11-20 19:48:53 +0000 | [diff] [blame] | 1428 | assert storage.server_ref.hash_algo == server_ref.hash_algo |
Marc-Antoine Ruel | 7de5259 | 2017-12-07 10:41:12 -0500 | [diff] [blame] | 1429 | return run_tha_test(data, options.json) |
| 1430 | return run_tha_test(data, options.json) |
Marc-Antoine Ruel | 8b11dbd | 2018-05-18 14:31:22 -0400 | [diff] [blame] | 1431 | except ( |
| 1432 | cipd.Error, |
| 1433 | local_caching.NamedCacheError, |
Marc-Antoine Ruel | b6e9e23 | 2018-11-20 00:12:33 +0000 | [diff] [blame] | 1434 | local_caching.NoMoreSpace) as ex: |
Marc-Antoine Ruel | f899c48 | 2019-10-10 23:32:06 +0000 | [diff] [blame] | 1435 | print(ex.message, file=sys.stderr) |
nodir | be642ff | 2016-06-09 15:51:51 -0700 | [diff] [blame] | 1436 | return 1 |
maruel@chromium.org | 9c72d4e | 2012-09-28 19:20:25 +0000 | [diff] [blame] | 1437 | |
| 1438 | |
| 1439 | if __name__ == '__main__': |
maruel | 8e4e40c | 2016-05-30 06:21:07 -0700 | [diff] [blame] | 1440 | subprocess42.inhibit_os_error_reporting() |
csharp@chromium.org | bfb9874 | 2013-03-26 20:28:36 +0000 | [diff] [blame] | 1441 | # Ensure that we are always running with the correct encoding. |
vadimsh@chromium.org | a432647 | 2013-08-24 02:05:41 +0000 | [diff] [blame] | 1442 | fix_encoding.fix_encoding() |
Marc-Antoine Ruel | 90c9816 | 2013-12-18 15:11:57 -0500 | [diff] [blame] | 1443 | sys.exit(main(sys.argv[1:])) |