maruel@chromium.org | 725f1c3 | 2011-04-01 20:24:54 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | # Copyright (c) 2011 The Chromium Authors. All rights reserved. |
maruel@chromium.org | ba55177 | 2010-02-03 18:21:42 +0000 | [diff] [blame] | 3 | # Use of this source code is governed by a BSD-style license that can be |
| 4 | # found in the LICENSE file. |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 5 | |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 6 | """Meta checkout manager supporting both Subversion and GIT. |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 7 | |
| 8 | Files |
| 9 | .gclient : Current client configuration, written by 'config' command. |
| 10 | Format is a Python script defining 'solutions', a list whose |
| 11 | entries each are maps binding the strings "name" and "url" |
| 12 | to strings specifying the name and location of the client |
| 13 | module, as well as "custom_deps" to a map similar to the DEPS |
| 14 | file below. |
| 15 | .gclient_entries : A cache constructed by 'update' command. Format is a |
| 16 | Python script defining 'entries', a list of the names |
| 17 | of all modules in the client |
| 18 | <module>/DEPS : Python script defining var 'deps' as a map from each requisite |
| 19 | submodule name to a URL where it can be found (via one SCM) |
| 20 | |
| 21 | Hooks |
| 22 | .gclient and DEPS files may optionally contain a list named "hooks" to |
| 23 | allow custom actions to be performed based on files that have changed in the |
evan@chromium.org | 67820ef | 2009-07-27 17:23:00 +0000 | [diff] [blame] | 24 | working copy as a result of a "sync"/"update" or "revert" operation. This |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 25 | can be prevented by using --nohooks (hooks run by default). Hooks can also |
maruel@chromium.org | 5df6a46 | 2009-08-28 18:52:26 +0000 | [diff] [blame] | 26 | be forced to run with the "runhooks" operation. If "sync" is run with |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 27 | --force, all known hooks will run regardless of the state of the working |
| 28 | copy. |
| 29 | |
| 30 | Each item in a "hooks" list is a dict, containing these two keys: |
| 31 | "pattern" The associated value is a string containing a regular |
| 32 | expression. When a file whose pathname matches the expression |
| 33 | is checked out, updated, or reverted, the hook's "action" will |
| 34 | run. |
| 35 | "action" A list describing a command to run along with its arguments, if |
| 36 | any. An action command will run at most one time per gclient |
| 37 | invocation, regardless of how many files matched the pattern. |
| 38 | The action is executed in the same directory as the .gclient |
| 39 | file. If the first item in the list is the string "python", |
| 40 | the current Python interpreter (sys.executable) will be used |
phajdan.jr@chromium.org | 71b4068 | 2009-07-31 23:40:09 +0000 | [diff] [blame] | 41 | to run the command. If the list contains string "$matching_files" |
| 42 | it will be removed from the list and the list will be extended |
| 43 | by the list of matching files. |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 44 | |
| 45 | Example: |
| 46 | hooks = [ |
| 47 | { "pattern": "\\.(gif|jpe?g|pr0n|png)$", |
| 48 | "action": ["python", "image_indexer.py", "--all"]}, |
| 49 | ] |
| 50 | """ |
| 51 | |
phajdan.jr@chromium.org | 6e043f7 | 2011-05-02 07:24:32 +0000 | [diff] [blame] | 52 | __version__ = "0.6.2" |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 53 | |
maruel@chromium.org | 9e5317a | 2010-08-13 20:35:11 +0000 | [diff] [blame] | 54 | import copy |
maruel@chromium.org | 754960e | 2009-09-21 12:31:05 +0000 | [diff] [blame] | 55 | import logging |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 56 | import optparse |
| 57 | import os |
maruel@chromium.org | 621939b | 2010-08-10 20:12:00 +0000 | [diff] [blame] | 58 | import posixpath |
msb@chromium.org | 2e38de7 | 2009-09-28 17:04:47 +0000 | [diff] [blame] | 59 | import pprint |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 60 | import re |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 61 | import sys |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 62 | import urlparse |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 63 | import urllib |
| 64 | |
maruel@chromium.org | cb2985f | 2010-11-03 14:08:31 +0000 | [diff] [blame] | 65 | import breakpad # pylint: disable=W0611 |
maruel@chromium.org | ada4c65 | 2009-12-03 15:32:01 +0000 | [diff] [blame] | 66 | |
maruel@chromium.org | 35625c7 | 2011-03-23 17:34:02 +0000 | [diff] [blame] | 67 | import fix_encoding |
maruel@chromium.org | 5f3eee3 | 2009-09-17 00:34:30 +0000 | [diff] [blame] | 68 | import gclient_scm |
| 69 | import gclient_utils |
nasser@codeaurora.org | 1f7a3d1 | 2010-02-04 15:11:50 +0000 | [diff] [blame] | 70 | from third_party.repo.progress import Progress |
maruel@chromium.org | 31cb48a | 2011-04-04 18:01:36 +0000 | [diff] [blame] | 71 | import subprocess2 |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 72 | |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 73 | |
maruel@chromium.org | cb2985f | 2010-11-03 14:08:31 +0000 | [diff] [blame] | 74 | def attr(attribute, data): |
maruel@chromium.org | 1f7d118 | 2010-05-17 18:17:38 +0000 | [diff] [blame] | 75 | """Sets an attribute on a function.""" |
| 76 | def hook(fn): |
maruel@chromium.org | cb2985f | 2010-11-03 14:08:31 +0000 | [diff] [blame] | 77 | setattr(fn, attribute, data) |
maruel@chromium.org | 1f7d118 | 2010-05-17 18:17:38 +0000 | [diff] [blame] | 78 | return fn |
| 79 | return hook |
maruel@chromium.org | e3da35f | 2010-03-09 21:40:45 +0000 | [diff] [blame] | 80 | |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 81 | |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 82 | ## GClient implementation. |
| 83 | |
| 84 | |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 85 | class GClientKeywords(object): |
| 86 | class FromImpl(object): |
| 87 | """Used to implement the From() syntax.""" |
| 88 | |
| 89 | def __init__(self, module_name, sub_target_name=None): |
| 90 | """module_name is the dep module we want to include from. It can also be |
| 91 | the name of a subdirectory to include from. |
| 92 | |
| 93 | sub_target_name is an optional parameter if the module name in the other |
| 94 | DEPS file is different. E.g., you might want to map src/net to net.""" |
| 95 | self.module_name = module_name |
| 96 | self.sub_target_name = sub_target_name |
| 97 | |
| 98 | def __str__(self): |
| 99 | return 'From(%s, %s)' % (repr(self.module_name), |
| 100 | repr(self.sub_target_name)) |
| 101 | |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 102 | class FileImpl(object): |
| 103 | """Used to implement the File('') syntax which lets you sync a single file |
maruel@chromium.org | e3216c6 | 2010-07-08 03:31:43 +0000 | [diff] [blame] | 104 | from a SVN repo.""" |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 105 | |
| 106 | def __init__(self, file_location): |
| 107 | self.file_location = file_location |
| 108 | |
| 109 | def __str__(self): |
| 110 | return 'File("%s")' % self.file_location |
| 111 | |
| 112 | def GetPath(self): |
| 113 | return os.path.split(self.file_location)[0] |
| 114 | |
| 115 | def GetFilename(self): |
| 116 | rev_tokens = self.file_location.split('@') |
| 117 | return os.path.split(rev_tokens[0])[1] |
| 118 | |
| 119 | def GetRevision(self): |
| 120 | rev_tokens = self.file_location.split('@') |
| 121 | if len(rev_tokens) > 1: |
| 122 | return rev_tokens[1] |
| 123 | return None |
| 124 | |
| 125 | class VarImpl(object): |
| 126 | def __init__(self, custom_vars, local_scope): |
| 127 | self._custom_vars = custom_vars |
| 128 | self._local_scope = local_scope |
| 129 | |
| 130 | def Lookup(self, var_name): |
| 131 | """Implements the Var syntax.""" |
| 132 | if var_name in self._custom_vars: |
| 133 | return self._custom_vars[var_name] |
| 134 | elif var_name in self._local_scope.get("vars", {}): |
| 135 | return self._local_scope["vars"][var_name] |
| 136 | raise gclient_utils.Error("Var is not defined: %s" % var_name) |
| 137 | |
| 138 | |
maruel@chromium.org | 80cbe8b | 2010-08-13 13:53:07 +0000 | [diff] [blame] | 139 | class Dependency(GClientKeywords, gclient_utils.WorkItem): |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 140 | """Object that represents a dependency checkout.""" |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 141 | |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 142 | def __init__(self, parent, name, url, safesync_url, managed, custom_deps, |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 143 | custom_vars, deps_file, should_process): |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 144 | # Warning: this function can be called from any thread. Both |
| 145 | # self.dependencies and self.requirements are read and modified from |
| 146 | # multiple threads at the same time. Sad. |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 147 | GClientKeywords.__init__(self) |
maruel@chromium.org | 6ca8bf8 | 2011-09-19 23:04:30 +0000 | [diff] [blame] | 148 | gclient_utils.WorkItem.__init__(self, name) |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 149 | |
| 150 | # These are not mutable: |
| 151 | self._parent = parent |
| 152 | self._safesync_url = safesync_url |
| 153 | self._deps_file = deps_file |
| 154 | self._should_process = should_process |
| 155 | |
| 156 | # This is in both .gclient and DEPS files: |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 157 | self.url = url |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 158 | |
| 159 | # These are only set in .gclient and not in DEPS files. |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 160 | # 'managed' determines whether or not this dependency is synced/updated by |
| 161 | # gclient after gclient checks it out initially. The difference between |
| 162 | # 'managed' and 'should_process' (defined below) is that the user specifies |
| 163 | # 'managed' via the --unmanaged command-line flag or a .gclient config, |
| 164 | # where 'should_process' is dynamically set by gclient if it goes over its |
| 165 | # recursion limit and controls gclient's behavior so it does not misbehave. |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 166 | self._managed = managed |
| 167 | self._custom_vars = custom_vars or {} |
| 168 | self._custom_deps = custom_deps or {} |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 169 | self.deps_hooks = [] |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 170 | |
| 171 | # Calculates properties: |
| 172 | self.parsed_url = None |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 173 | self.dependencies = [] |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 174 | # A cache of the files affected by the current operation, necessary for |
| 175 | # hooks. |
maruel@chromium.org | 861fd0f | 2010-07-23 03:05:05 +0000 | [diff] [blame] | 176 | self._file_list = [] |
maruel@chromium.org | 85c2a19 | 2010-07-22 21:14:43 +0000 | [diff] [blame] | 177 | # If it is not set to True, the dependency wasn't processed for its child |
| 178 | # dependency, i.e. its DEPS wasn't read. |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 179 | self.deps_parsed = False |
maruel@chromium.org | f3abb80 | 2010-08-10 17:19:56 +0000 | [diff] [blame] | 180 | # This dependency has been processed, i.e. checked out |
| 181 | self.processed = False |
| 182 | # This dependency had its hook run |
| 183 | self.hooks_ran = False |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 184 | |
maruel@chromium.org | 98023df | 2011-09-07 18:44:47 +0000 | [diff] [blame] | 185 | # Post process the url to remove trailing slashes. |
| 186 | if isinstance(self.url, basestring): |
| 187 | # urls are sometime incorrectly written as proto://host/path/@rev. Replace |
| 188 | # it to proto://host/path@rev. |
| 189 | if self.url.count('@') > 1: |
| 190 | raise gclient_utils.Error('Invalid url "%s"' % self.url) |
| 191 | self.url = self.url.replace('/@', '@') |
| 192 | |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 193 | self._FindDependencies() |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 194 | |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 195 | # Sanity checks |
| 196 | if not self.name and self.parent: |
| 197 | raise gclient_utils.Error('Dependency without name') |
| 198 | if not isinstance(self.url, |
| 199 | (basestring, self.FromImpl, self.FileImpl, None.__class__)): |
| 200 | raise gclient_utils.Error('dependency url must be either a string, None, ' |
| 201 | 'File() or From() instead of %s' % |
| 202 | self.url.__class__.__name__) |
| 203 | if '/' in self.deps_file or '\\' in self.deps_file: |
| 204 | raise gclient_utils.Error('deps_file name must not be a path, just a ' |
| 205 | 'filename. %s' % self.deps_file) |
| 206 | |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 207 | def _FindDependencies(self): |
| 208 | """Setup self.requirements and find any other dependency who would have self |
| 209 | as a requirement. |
| 210 | """ |
| 211 | # self.parent is implicitly a requirement. This will be recursive by |
| 212 | # definition. |
| 213 | if self.parent and self.parent.name: |
maruel@chromium.org | 6ca8bf8 | 2011-09-19 23:04:30 +0000 | [diff] [blame] | 214 | self._requirements.add(self.parent.name) |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 215 | |
| 216 | # For a tree with at least 2 levels*, the leaf node needs to depend |
| 217 | # on the level higher up in an orderly way. |
| 218 | # This becomes messy for >2 depth as the DEPS file format is a dictionary, |
| 219 | # thus unsorted, while the .gclient format is a list thus sorted. |
| 220 | # |
| 221 | # * _recursion_limit is hard coded 2 and there is no hope to change this |
| 222 | # value. |
| 223 | # |
| 224 | # Interestingly enough, the following condition only works in the case we |
| 225 | # want: self is a 2nd level node. 3nd level node wouldn't need this since |
| 226 | # they already have their parent as a requirement. |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 227 | root_deps = self.root.dependencies |
| 228 | if self.parent in root_deps: |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 229 | for i in root_deps: |
| 230 | if i is self.parent: |
| 231 | break |
| 232 | if i.name: |
| 233 | self._requirements.add(i.name) |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 234 | |
| 235 | if isinstance(self.url, self.FromImpl): |
maruel@chromium.org | 6ca8bf8 | 2011-09-19 23:04:30 +0000 | [diff] [blame] | 236 | self._requirements.add(self.url.module_name) |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 237 | |
maruel@chromium.org | 485dcab | 2011-09-14 12:48:47 +0000 | [diff] [blame] | 238 | if self.name and self.should_process: |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 239 | def yield_full_tree(root): |
| 240 | """Depth-first recursion.""" |
| 241 | yield root |
| 242 | for i in root.dependencies: |
| 243 | for j in yield_full_tree(i): |
maruel@chromium.org | 485dcab | 2011-09-14 12:48:47 +0000 | [diff] [blame] | 244 | if j.should_process: |
| 245 | yield j |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 246 | |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 247 | for obj in yield_full_tree(self.root): |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 248 | if obj is self or not obj.name: |
| 249 | continue |
| 250 | # Step 1: Find any requirements self may need. |
| 251 | if self.name.startswith(posixpath.join(obj.name, '')): |
maruel@chromium.org | 6ca8bf8 | 2011-09-19 23:04:30 +0000 | [diff] [blame] | 252 | self._requirements.add(obj.name) |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 253 | # Step 2: Find any requirements self may impose. |
| 254 | if obj.name.startswith(posixpath.join(self.name, '')): |
maruel@chromium.org | 6ca8bf8 | 2011-09-19 23:04:30 +0000 | [diff] [blame] | 255 | try: |
| 256 | # Access to a protected member _requirements of a client class |
| 257 | # pylint: disable=W0212 |
| 258 | obj.lock.acquire() |
| 259 | obj._requirements.add(self.name) |
| 260 | finally: |
| 261 | obj.lock.release() |
maruel@chromium.org | 118fb1c | 2011-09-01 20:04:24 +0000 | [diff] [blame] | 262 | |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 263 | def LateOverride(self, url): |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 264 | """Resolves the parsed url from url. |
| 265 | |
| 266 | Manages From() keyword accordingly. Do not touch self.parsed_url nor |
| 267 | self.url because it may called with other urls due to From().""" |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 268 | assert self.parsed_url == None or not self.should_process, self.parsed_url |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 269 | overriden_url = self.get_custom_deps(self.name, url) |
| 270 | if overriden_url != url: |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 271 | logging.info('%s, %s was overriden to %s' % (self.name, url, |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 272 | overriden_url)) |
| 273 | return overriden_url |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 274 | elif isinstance(url, self.FromImpl): |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 275 | ref = [ |
| 276 | dep for dep in self.root.subtree(True) if url.module_name == dep.name |
| 277 | ] |
maruel@chromium.org | f3abb80 | 2010-08-10 17:19:56 +0000 | [diff] [blame] | 278 | if not ref: |
| 279 | raise gclient_utils.Error('Failed to find one reference to %s. %s' % ( |
| 280 | url.module_name, ref)) |
| 281 | # It may happen that len(ref) > 1 but it's no big deal. |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 282 | ref = ref[0] |
maruel@chromium.org | 98d05fa | 2010-07-22 21:58:01 +0000 | [diff] [blame] | 283 | sub_target = url.sub_target_name or self.name |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 284 | # Make sure the referenced dependency DEPS file is loaded and file the |
| 285 | # inner referenced dependency. |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 286 | ref.ParseDepsFile() |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 287 | found_dep = None |
| 288 | for d in ref.dependencies: |
| 289 | if d.name == sub_target: |
| 290 | found_dep = d |
| 291 | break |
| 292 | if not found_dep: |
maruel@chromium.org | f3abb80 | 2010-08-10 17:19:56 +0000 | [diff] [blame] | 293 | raise gclient_utils.Error( |
maruel@chromium.org | 98023df | 2011-09-07 18:44:47 +0000 | [diff] [blame] | 294 | 'Couldn\'t find %s in %s, referenced by %s (parent: %s)\n%s' % ( |
| 295 | sub_target, ref.name, self.name, self.parent.name, |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 296 | str(self.root))) |
maruel@chromium.org | 98023df | 2011-09-07 18:44:47 +0000 | [diff] [blame] | 297 | |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 298 | # Call LateOverride() again. |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 299 | parsed_url = found_dep.LateOverride(found_dep.url) |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 300 | logging.info('%s, %s to %s' % (self.name, url, parsed_url)) |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 301 | return parsed_url |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 302 | elif isinstance(url, basestring): |
| 303 | parsed_url = urlparse.urlparse(url) |
| 304 | if not parsed_url[0]: |
| 305 | # A relative url. Fetch the real base. |
| 306 | path = parsed_url[2] |
| 307 | if not path.startswith('/'): |
| 308 | raise gclient_utils.Error( |
| 309 | 'relative DEPS entry \'%s\' must begin with a slash' % url) |
| 310 | # Create a scm just to query the full url. |
| 311 | parent_url = self.parent.parsed_url |
| 312 | if isinstance(parent_url, self.FileImpl): |
| 313 | parent_url = parent_url.file_location |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 314 | scm = gclient_scm.CreateSCM(parent_url, self.root.root_dir, None) |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 315 | parsed_url = scm.FullUrlForRelativeUrl(url) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 316 | else: |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 317 | parsed_url = url |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 318 | logging.info('%s, %s -> %s' % (self.name, url, parsed_url)) |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 319 | return parsed_url |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 320 | elif isinstance(url, self.FileImpl): |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 321 | parsed_url = url |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 322 | logging.info('%s, %s -> %s (File)' % (self.name, url, parsed_url)) |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 323 | return parsed_url |
| 324 | elif url is None: |
| 325 | return None |
| 326 | else: |
| 327 | raise gclient_utils.Error('Unkown url type') |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 328 | |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 329 | def ParseDepsFile(self): |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 330 | """Parses the DEPS file for this dependency.""" |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 331 | assert self.processed == True |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 332 | if self.deps_parsed: |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 333 | logging.debug('%s was already parsed' % self.name) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 334 | return |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 335 | self.deps_parsed = True |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 336 | # One thing is unintuitive, vars= {} must happen before Var() use. |
| 337 | local_scope = {} |
| 338 | var = self.VarImpl(self.custom_vars, local_scope) |
| 339 | global_scope = { |
| 340 | 'File': self.FileImpl, |
| 341 | 'From': self.FromImpl, |
| 342 | 'Var': var.Lookup, |
| 343 | 'deps_os': {}, |
| 344 | } |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 345 | filepath = os.path.join(self.root.root_dir, self.name, self.deps_file) |
maruel@chromium.org | 4630429 | 2010-10-28 11:42:00 +0000 | [diff] [blame] | 346 | if not os.path.isfile(filepath): |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 347 | logging.info('%s: No %s file found at %s' % (self.name, self.deps_file, |
| 348 | filepath)) |
maruel@chromium.org | 4630429 | 2010-10-28 11:42:00 +0000 | [diff] [blame] | 349 | else: |
| 350 | deps_content = gclient_utils.FileRead(filepath) |
| 351 | logging.debug(deps_content) |
| 352 | # Eval the content. |
| 353 | try: |
| 354 | exec(deps_content, global_scope, local_scope) |
| 355 | except SyntaxError, e: |
| 356 | gclient_utils.SyntaxErrorToError(filepath, e) |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 357 | deps = local_scope.get('deps', {}) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 358 | # load os specific dependencies if defined. these dependencies may |
| 359 | # override or extend the values defined by the 'deps' member. |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 360 | if 'deps_os' in local_scope: |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 361 | enforced_os = self.root.enforced_os |
| 362 | for deps_os_key in enforced_os: |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 363 | os_deps = local_scope['deps_os'].get(deps_os_key, {}) |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 364 | if len(enforced_os) > 1: |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 365 | # Ignore any conflict when including deps for more than one |
maruel@chromium.org | 4630429 | 2010-10-28 11:42:00 +0000 | [diff] [blame] | 366 | # platform, so we collect the broadest set of dependencies |
| 367 | # available. We may end up with the wrong revision of something for |
| 368 | # our platform, but this is the best we can do. |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 369 | deps.update([x for x in os_deps.items() if not x[0] in deps]) |
| 370 | else: |
| 371 | deps.update(os_deps) |
| 372 | |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 373 | self.deps_hooks.extend(local_scope.get('hooks', [])) |
| 374 | |
| 375 | # If a line is in custom_deps, but not in the solution, we want to append |
| 376 | # this line to the solution. |
| 377 | for d in self.custom_deps: |
| 378 | if d not in deps: |
| 379 | deps[d] = self.custom_deps[d] |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 380 | |
| 381 | # If use_relative_paths is set in the DEPS file, regenerate |
| 382 | # the dictionary using paths relative to the directory containing |
| 383 | # the DEPS file. |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 384 | use_relative_paths = local_scope.get('use_relative_paths', False) |
| 385 | if use_relative_paths: |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 386 | rel_deps = {} |
| 387 | for d, url in deps.items(): |
| 388 | # normpath is required to allow DEPS to use .. in their |
| 389 | # dependency local path. |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 390 | rel_deps[os.path.normpath(os.path.join(self.name, d))] = url |
| 391 | deps = rel_deps |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 392 | |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 393 | # Convert the deps into real Dependency. |
| 394 | for name, url in deps.iteritems(): |
| 395 | if name in [s.name for s in self.dependencies]: |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 396 | raise gclient_utils.Error( |
| 397 | 'The same name "%s" appears multiple times in the deps section' % |
| 398 | name) |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 399 | should_process = self.recursion_limit and self.should_process |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 400 | if should_process: |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 401 | tree = dict((d.name, d) for d in self.root.subtree(False)) |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 402 | if name in tree: |
| 403 | if url == tree[name].url: |
| 404 | logging.info('Won\'t process duplicate dependency %s' % tree[name]) |
| 405 | # In theory we could keep it as a shadow of the other one. In |
| 406 | # practice, simply ignore it. |
| 407 | #should_process = False |
| 408 | continue |
| 409 | else: |
| 410 | raise gclient_utils.Error( |
| 411 | 'Dependency %s specified more than once:\n %s\nvs\n %s' % |
| 412 | (name, tree[name].hierarchy(), self.hierarchy())) |
maruel@chromium.org | 0d81244 | 2010-08-10 12:41:08 +0000 | [diff] [blame] | 413 | self.dependencies.append(Dependency(self, name, url, None, None, None, |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 414 | None, self.deps_file, should_process)) |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 415 | logging.debug('Loaded: %s' % str(self)) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 416 | |
maruel@chromium.org | b17b55b | 2010-11-03 14:42:37 +0000 | [diff] [blame] | 417 | # Arguments number differs from overridden method |
| 418 | # pylint: disable=W0221 |
maruel@chromium.org | 3742c84 | 2010-09-09 19:27:14 +0000 | [diff] [blame] | 419 | def run(self, revision_overrides, command, args, work_queue, options): |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 420 | """Runs 'command' before parsing the DEPS in case it's a initial checkout |
| 421 | or a revert.""" |
floitsch@google.com | eaab784 | 2011-04-28 09:07:58 +0000 | [diff] [blame] | 422 | |
| 423 | def maybeGetParentRevision(options): |
| 424 | """If we are performing an update and --transitive is set, set the |
| 425 | revision to the parent's revision. If we have an explicit revision |
| 426 | do nothing.""" |
| 427 | if command == 'update' and options.transitive and not options.revision: |
| 428 | _, revision = gclient_utils.SplitUrlRevision(self.parsed_url) |
| 429 | if not revision: |
| 430 | options.revision = revision_overrides.get(self.parent.name) |
| 431 | if options.verbose and options.revision: |
| 432 | print("Using parent's revision date: %s" % options.revision) |
| 433 | # If the parent has a revision override, then it must have been |
| 434 | # converted to date format. |
| 435 | assert (not options.revision or |
| 436 | gclient_utils.IsDateRevision(options.revision)) |
| 437 | |
| 438 | def maybeConvertToDateRevision(options): |
| 439 | """If we are performing an update and --transitive is set, convert the |
| 440 | revision to a date-revision (if necessary). Instead of having |
| 441 | -r 101 replace the revision with the time stamp of 101 (e.g. |
| 442 | "{2011-18-04}"). |
| 443 | This way dependencies are upgraded to the revision they had at the |
| 444 | check-in of revision 101.""" |
| 445 | if (command == 'update' and |
| 446 | options.transitive and |
| 447 | options.revision and |
| 448 | not gclient_utils.IsDateRevision(options.revision)): |
| 449 | revision_date = scm.GetRevisionDate(options.revision) |
| 450 | revision = gclient_utils.MakeDateRevision(revision_date) |
| 451 | if options.verbose: |
| 452 | print("Updating revision override from %s to %s." % |
| 453 | (options.revision, revision)) |
| 454 | revision_overrides[self.name] = revision |
| 455 | |
maruel@chromium.org | 861fd0f | 2010-07-23 03:05:05 +0000 | [diff] [blame] | 456 | assert self._file_list == [] |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 457 | if not self.should_process: |
| 458 | return |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 459 | # When running runhooks, there's no need to consult the SCM. |
| 460 | # All known hooks are expected to run unconditionally regardless of working |
| 461 | # copy state, so skip the SCM status check. |
| 462 | run_scm = command not in ('runhooks', None) |
maruel@chromium.org | da7a1f9 | 2010-08-10 17:19:02 +0000 | [diff] [blame] | 463 | self.parsed_url = self.LateOverride(self.url) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 464 | if run_scm and self.parsed_url: |
| 465 | if isinstance(self.parsed_url, self.FileImpl): |
| 466 | # Special support for single-file checkout. |
| 467 | if not command in (None, 'cleanup', 'diff', 'pack', 'status'): |
| 468 | options.revision = self.parsed_url.GetRevision() |
| 469 | scm = gclient_scm.SVNWrapper(self.parsed_url.GetPath(), |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 470 | self.root.root_dir, |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 471 | self.name) |
| 472 | scm.RunCommand('updatesingle', options, |
| 473 | args + [self.parsed_url.GetFilename()], |
maruel@chromium.org | 861fd0f | 2010-07-23 03:05:05 +0000 | [diff] [blame] | 474 | self._file_list) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 475 | else: |
maruel@chromium.org | 9e5317a | 2010-08-13 20:35:11 +0000 | [diff] [blame] | 476 | # Create a shallow copy to mutate revision. |
| 477 | options = copy.copy(options) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 478 | options.revision = revision_overrides.get(self.name) |
floitsch@google.com | eaab784 | 2011-04-28 09:07:58 +0000 | [diff] [blame] | 479 | maybeGetParentRevision(options) |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 480 | scm = gclient_scm.CreateSCM( |
| 481 | self.parsed_url, self.root.root_dir, self.name) |
maruel@chromium.org | 861fd0f | 2010-07-23 03:05:05 +0000 | [diff] [blame] | 482 | scm.RunCommand(command, options, args, self._file_list) |
floitsch@google.com | eaab784 | 2011-04-28 09:07:58 +0000 | [diff] [blame] | 483 | maybeConvertToDateRevision(options) |
maruel@chromium.org | 861fd0f | 2010-07-23 03:05:05 +0000 | [diff] [blame] | 484 | self._file_list = [os.path.join(self.name, f.strip()) |
| 485 | for f in self._file_list] |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 486 | |
| 487 | # TODO(phajdan.jr): We should know exactly when the paths are absolute. |
| 488 | # Convert all absolute paths to relative. |
| 489 | for i in range(len(self._file_list)): |
| 490 | # It depends on the command being executed (like runhooks vs sync). |
| 491 | if not os.path.isabs(self._file_list[i]): |
| 492 | continue |
| 493 | prefix = os.path.commonprefix( |
| 494 | [self.root.root_dir.lower(), self._file_list[i].lower()]) |
| 495 | self._file_list[i] = self._file_list[i][len(prefix):] |
| 496 | # Strip any leading path separators. |
| 497 | while (self._file_list[i].startswith('\\') or |
| 498 | self._file_list[i].startswith('/')): |
| 499 | self._file_list[i] = self._file_list[i][1:] |
maruel@chromium.org | f3abb80 | 2010-08-10 17:19:56 +0000 | [diff] [blame] | 500 | self.processed = True |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 501 | if self.recursion_limit: |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 502 | # Then we can parse the DEPS file. |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 503 | self.ParseDepsFile() |
maruel@chromium.org | 621939b | 2010-08-10 20:12:00 +0000 | [diff] [blame] | 504 | |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 505 | # Parse the dependencies of this dependency. |
| 506 | for s in self.dependencies: |
maruel@chromium.org | 049bced | 2010-08-12 13:37:20 +0000 | [diff] [blame] | 507 | work_queue.enqueue(s) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 508 | |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 509 | def RunHooksRecursively(self, options): |
maruel@chromium.org | 049bced | 2010-08-12 13:37:20 +0000 | [diff] [blame] | 510 | """Evaluates all hooks, running actions as needed. run() |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 511 | must have been called before to load the DEPS.""" |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 512 | assert self.hooks_ran == False |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 513 | if not self.should_process or not self.recursion_limit: |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 514 | # Don't run the hook when it is above recursion_limit. |
| 515 | return |
maruel@chromium.org | dc7445d | 2010-07-09 21:05:29 +0000 | [diff] [blame] | 516 | # If "--force" was specified, run all hooks regardless of what files have |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 517 | # changed. |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 518 | if self.deps_hooks: |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 519 | # TODO(maruel): If the user is using git or git-svn, then we don't know |
| 520 | # what files have changed so we always run all hooks. It'd be nice to fix |
| 521 | # that. |
| 522 | if (options.force or |
| 523 | isinstance(self.parsed_url, self.FileImpl) or |
| 524 | gclient_scm.GetScmName(self.parsed_url) in ('git', None) or |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 525 | os.path.isdir(os.path.join(self.root.root_dir, self.name, '.git'))): |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 526 | for hook_dict in self.deps_hooks: |
| 527 | self._RunHookAction(hook_dict, []) |
| 528 | else: |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 529 | # Run hooks on the basis of whether the files from the gclient operation |
| 530 | # match each hook's pattern. |
| 531 | for hook_dict in self.deps_hooks: |
| 532 | pattern = re.compile(hook_dict['pattern']) |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 533 | matching_file_list = [f for f in self.file_list if pattern.search(f)] |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 534 | if matching_file_list: |
| 535 | self._RunHookAction(hook_dict, matching_file_list) |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 536 | for s in self.dependencies: |
| 537 | s.RunHooksRecursively(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 538 | |
maruel@chromium.org | eaf6106 | 2010-07-07 18:42:39 +0000 | [diff] [blame] | 539 | def _RunHookAction(self, hook_dict, matching_file_list): |
| 540 | """Runs the action from a single hook.""" |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 541 | # A single DEPS file can specify multiple hooks so this function can be |
| 542 | # called multiple times on a single Dependency. |
| 543 | #assert self.hooks_ran == False |
maruel@chromium.org | f3abb80 | 2010-08-10 17:19:56 +0000 | [diff] [blame] | 544 | self.hooks_ran = True |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 545 | logging.debug(hook_dict) |
| 546 | logging.debug(matching_file_list) |
maruel@chromium.org | eaf6106 | 2010-07-07 18:42:39 +0000 | [diff] [blame] | 547 | command = hook_dict['action'][:] |
| 548 | if command[0] == 'python': |
| 549 | # If the hook specified "python" as the first item, the action is a |
| 550 | # Python script. Run it by starting a new copy of the same |
| 551 | # interpreter. |
| 552 | command[0] = sys.executable |
| 553 | |
| 554 | if '$matching_files' in command: |
| 555 | splice_index = command.index('$matching_files') |
| 556 | command[splice_index:splice_index + 1] = matching_file_list |
| 557 | |
maruel@chromium.org | 17d0179 | 2010-09-01 18:07:10 +0000 | [diff] [blame] | 558 | try: |
| 559 | gclient_utils.CheckCallAndFilterAndHeader( |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 560 | command, cwd=self.root.root_dir, always=True) |
maruel@chromium.org | 31cb48a | 2011-04-04 18:01:36 +0000 | [diff] [blame] | 561 | except (gclient_utils.Error, subprocess2.CalledProcessError), e: |
maruel@chromium.org | 17d0179 | 2010-09-01 18:07:10 +0000 | [diff] [blame] | 562 | # Use a discrete exit status code of 2 to indicate that a hook action |
| 563 | # failed. Users of this script may wish to treat hook action failures |
| 564 | # differently from VC failures. |
| 565 | print >> sys.stderr, 'Error: %s' % str(e) |
| 566 | sys.exit(2) |
maruel@chromium.org | eaf6106 | 2010-07-07 18:42:39 +0000 | [diff] [blame] | 567 | |
maruel@chromium.org | 0d81244 | 2010-08-10 12:41:08 +0000 | [diff] [blame] | 568 | def subtree(self, include_all): |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 569 | """Breadth first""" |
maruel@chromium.org | c57e4f2 | 2010-07-22 21:37:46 +0000 | [diff] [blame] | 570 | result = [] |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 571 | dependencies = self.dependencies |
| 572 | for d in dependencies: |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 573 | if d.should_process or include_all: |
maruel@chromium.org | 044f4e3 | 2010-07-22 21:59:57 +0000 | [diff] [blame] | 574 | result.append(d) |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 575 | for d in dependencies: |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 576 | result.extend(d.subtree(include_all)) |
maruel@chromium.org | c57e4f2 | 2010-07-22 21:37:46 +0000 | [diff] [blame] | 577 | return result |
| 578 | |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 579 | def get_custom_deps(self, name, url): |
| 580 | """Returns a custom deps if applicable.""" |
| 581 | if self.parent: |
| 582 | url = self.parent.get_custom_deps(name, url) |
| 583 | # None is a valid return value to disable a dependency. |
| 584 | return self.custom_deps.get(name, url) |
| 585 | |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 586 | @property |
| 587 | def recursion_limit(self): |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 588 | """Returns > 0 if this dependency is not too recursed to be processed. |
| 589 | |
| 590 | Immutable so no need to lock.""" |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 591 | return max(self.parent.recursion_limit - 1, 0) |
| 592 | |
| 593 | @property |
| 594 | def deps_file(self): |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 595 | """Immutable so no need to lock.""" |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 596 | return self._deps_file |
| 597 | |
| 598 | @property |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 599 | def managed(self): |
| 600 | """Immutable so no need to lock.""" |
| 601 | return self._managed |
| 602 | |
| 603 | @property |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 604 | def safesync_url(self): |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 605 | """Immutable so no need to lock.""" |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 606 | return self._safesync_url |
| 607 | |
| 608 | @property |
| 609 | def should_process(self): |
| 610 | """True if this dependency should be processed, i.e. checked out.""" |
| 611 | return self._should_process |
| 612 | |
| 613 | @property |
| 614 | def parent(self): |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 615 | """Immutable so no need to lock.""" |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 616 | return self._parent |
| 617 | |
| 618 | @property |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 619 | def custom_vars(self): |
| 620 | """Immutable so no need to lock.""" |
| 621 | return self._custom_vars.copy() |
| 622 | |
| 623 | @property |
| 624 | def custom_deps(self): |
| 625 | """Immutable so no need to lock.""" |
| 626 | return self._custom_deps.copy() |
| 627 | |
| 628 | @property |
| 629 | @gclient_utils.lockedmethod |
maruel@chromium.org | 861fd0f | 2010-07-23 03:05:05 +0000 | [diff] [blame] | 630 | def file_list(self): |
| 631 | result = self._file_list[:] |
| 632 | for d in self.dependencies: |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 633 | result.extend(d.file_list) |
| 634 | return tuple(result) |
maruel@chromium.org | 861fd0f | 2010-07-23 03:05:05 +0000 | [diff] [blame] | 635 | |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 636 | def __str__(self): |
| 637 | out = [] |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 638 | for i in ('name', 'url', 'parsed_url', 'safesync_url', 'custom_deps', |
maruel@chromium.org | 3c74bc9 | 2011-09-15 19:17:21 +0000 | [diff] [blame] | 639 | 'custom_vars', 'deps_hooks', 'file_list', 'should_process', |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 640 | 'processed', 'hooks_ran', 'deps_parsed', 'requirements'): |
maruel@chromium.org | 3c74bc9 | 2011-09-15 19:17:21 +0000 | [diff] [blame] | 641 | # First try the native property if it exists. |
| 642 | if hasattr(self, '_' + i): |
| 643 | value = getattr(self, '_' + i, False) |
| 644 | else: |
| 645 | value = getattr(self, i, False) |
| 646 | if value: |
| 647 | out.append('%s: %s' % (i, value)) |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 648 | |
| 649 | for d in self.dependencies: |
| 650 | out.extend([' ' + x for x in str(d).splitlines()]) |
| 651 | out.append('') |
| 652 | return '\n'.join(out) |
| 653 | |
| 654 | def __repr__(self): |
| 655 | return '%s: %s' % (self.name, self.url) |
| 656 | |
maruel@chromium.org | bffb904 | 2010-07-22 20:59:36 +0000 | [diff] [blame] | 657 | def hierarchy(self): |
maruel@chromium.org | bc2d2f9 | 2010-07-22 21:26:48 +0000 | [diff] [blame] | 658 | """Returns a human-readable hierarchical reference to a Dependency.""" |
maruel@chromium.org | bffb904 | 2010-07-22 20:59:36 +0000 | [diff] [blame] | 659 | out = '%s(%s)' % (self.name, self.url) |
| 660 | i = self.parent |
| 661 | while i and i.name: |
| 662 | out = '%s(%s) -> %s' % (i.name, i.url, out) |
| 663 | i = i.parent |
| 664 | return out |
| 665 | |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 666 | @property |
| 667 | def root(self): |
| 668 | """Returns the root node, a GClient object.""" |
| 669 | if not self.parent: |
| 670 | # This line is to signal pylint that it could be a GClient instance. |
| 671 | return self or GClient(None, None) |
| 672 | return self.parent.root |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 673 | |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 674 | |
| 675 | class GClient(Dependency): |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 676 | """Object that represent a gclient checkout. A tree of Dependency(), one per |
| 677 | solution or DEPS entry.""" |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 678 | |
| 679 | DEPS_OS_CHOICES = { |
| 680 | "win32": "win", |
| 681 | "win": "win", |
| 682 | "cygwin": "win", |
| 683 | "darwin": "mac", |
| 684 | "mac": "mac", |
| 685 | "unix": "unix", |
| 686 | "linux": "unix", |
| 687 | "linux2": "unix", |
maruel@chromium.org | 244e344 | 2011-06-12 15:20:55 +0000 | [diff] [blame] | 688 | "linux3": "unix", |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 689 | } |
| 690 | |
| 691 | DEFAULT_CLIENT_FILE_TEXT = ("""\ |
| 692 | solutions = [ |
| 693 | { "name" : "%(solution_name)s", |
| 694 | "url" : "%(solution_url)s", |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 695 | "deps_file" : "%(deps_file)s", |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 696 | "managed" : %(managed)s, |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 697 | "custom_deps" : { |
| 698 | }, |
maruel@chromium.org | 73e2114 | 2010-07-05 13:32:01 +0000 | [diff] [blame] | 699 | "safesync_url": "%(safesync_url)s", |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 700 | }, |
| 701 | ] |
| 702 | """) |
| 703 | |
| 704 | DEFAULT_SNAPSHOT_SOLUTION_TEXT = ("""\ |
| 705 | { "name" : "%(solution_name)s", |
| 706 | "url" : "%(solution_url)s", |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 707 | "deps_file" : "%(deps_file)s", |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 708 | "managed" : %(managed)s, |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 709 | "custom_deps" : { |
maruel@chromium.org | 73e2114 | 2010-07-05 13:32:01 +0000 | [diff] [blame] | 710 | %(solution_deps)s }, |
| 711 | "safesync_url": "%(safesync_url)s", |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 712 | }, |
| 713 | """) |
| 714 | |
| 715 | DEFAULT_SNAPSHOT_FILE_TEXT = ("""\ |
| 716 | # Snapshot generated with gclient revinfo --snapshot |
| 717 | solutions = [ |
maruel@chromium.org | 73e2114 | 2010-07-05 13:32:01 +0000 | [diff] [blame] | 718 | %(solution_list)s] |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 719 | """) |
| 720 | |
| 721 | def __init__(self, root_dir, options): |
maruel@chromium.org | 0d81244 | 2010-08-10 12:41:08 +0000 | [diff] [blame] | 722 | # Do not change previous behavior. Only solution level and immediate DEPS |
| 723 | # are processed. |
| 724 | self._recursion_limit = 2 |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 725 | Dependency.__init__(self, None, None, None, None, True, None, None, |
| 726 | 'unused', True) |
maruel@chromium.org | 0d42592 | 2010-06-21 19:22:24 +0000 | [diff] [blame] | 727 | self._options = options |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 728 | if options.deps_os: |
| 729 | enforced_os = options.deps_os.split(',') |
| 730 | else: |
| 731 | enforced_os = [self.DEPS_OS_CHOICES.get(sys.platform, 'unix')] |
| 732 | if 'all' in enforced_os: |
| 733 | enforced_os = self.DEPS_OS_CHOICES.itervalues() |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 734 | self._enforced_os = tuple(set(enforced_os)) |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 735 | self._root_dir = root_dir |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 736 | self.config_content = None |
| 737 | |
| 738 | def SetConfig(self, content): |
maruel@chromium.org | f13a418 | 2011-09-22 00:26:15 +0000 | [diff] [blame^] | 739 | assert not self.dependencies |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 740 | config_dict = {} |
| 741 | self.config_content = content |
| 742 | try: |
| 743 | exec(content, config_dict) |
| 744 | except SyntaxError, e: |
maruel@chromium.org | 5990f9d | 2010-07-07 18:02:58 +0000 | [diff] [blame] | 745 | gclient_utils.SyntaxErrorToError('.gclient', e) |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 746 | for s in config_dict.get('solutions', []): |
maruel@chromium.org | 81843b8 | 2010-06-28 16:49:26 +0000 | [diff] [blame] | 747 | try: |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 748 | tree = dict((d.name, d) for d in self.root.subtree(False)) |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 749 | if s['name'] in tree: |
| 750 | raise gclient_utils.Error( |
| 751 | 'Dependency %s specified more than once in .gclient' % s['name']) |
maruel@chromium.org | 81843b8 | 2010-06-28 16:49:26 +0000 | [diff] [blame] | 752 | self.dependencies.append(Dependency( |
| 753 | self, s['name'], s['url'], |
| 754 | s.get('safesync_url', None), |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 755 | s.get('managed', True), |
maruel@chromium.org | 81843b8 | 2010-06-28 16:49:26 +0000 | [diff] [blame] | 756 | s.get('custom_deps', {}), |
maruel@chromium.org | 0d81244 | 2010-08-10 12:41:08 +0000 | [diff] [blame] | 757 | s.get('custom_vars', {}), |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 758 | s.get('deps_file', 'DEPS'), |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 759 | True)) |
maruel@chromium.org | 81843b8 | 2010-06-28 16:49:26 +0000 | [diff] [blame] | 760 | except KeyError: |
| 761 | raise gclient_utils.Error('Invalid .gclient file. Solution is ' |
| 762 | 'incomplete: %s' % s) |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 763 | # .gclient can have hooks. |
| 764 | self.deps_hooks = config_dict.get('hooks', []) |
maruel@chromium.org | 049bced | 2010-08-12 13:37:20 +0000 | [diff] [blame] | 765 | self.deps_parsed = True |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 766 | |
| 767 | def SaveConfig(self): |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 768 | gclient_utils.FileWrite(os.path.join(self.root_dir, |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 769 | self._options.config_filename), |
| 770 | self.config_content) |
| 771 | |
| 772 | @staticmethod |
| 773 | def LoadCurrentConfig(options): |
| 774 | """Searches for and loads a .gclient file relative to the current working |
| 775 | dir. Returns a GClient object.""" |
maruel@chromium.org | 1580409 | 2010-09-02 17:07:37 +0000 | [diff] [blame] | 776 | path = gclient_utils.FindGclientRoot(os.getcwd(), options.config_filename) |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 777 | if not path: |
| 778 | return None |
| 779 | client = GClient(path, options) |
| 780 | client.SetConfig(gclient_utils.FileRead( |
| 781 | os.path.join(path, options.config_filename))) |
maruel@chromium.org | 1580409 | 2010-09-02 17:07:37 +0000 | [diff] [blame] | 782 | return client |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 783 | |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 784 | def SetDefaultConfig(self, solution_name, deps_file, solution_url, |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 785 | safesync_url, managed=True): |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 786 | self.SetConfig(self.DEFAULT_CLIENT_FILE_TEXT % { |
| 787 | 'solution_name': solution_name, |
| 788 | 'solution_url': solution_url, |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 789 | 'deps_file': deps_file, |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 790 | 'safesync_url' : safesync_url, |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 791 | 'managed': managed, |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 792 | }) |
| 793 | |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 794 | def _SaveEntries(self): |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 795 | """Creates a .gclient_entries file to record the list of unique checkouts. |
| 796 | |
| 797 | The .gclient_entries file lives in the same directory as .gclient. |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 798 | """ |
| 799 | # Sometimes pprint.pformat will use {', sometimes it'll use { ' ... It |
| 800 | # makes testing a bit too fun. |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 801 | result = 'entries = {\n' |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 802 | for entry in self.root.subtree(False): |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 803 | # Skip over File() dependencies as we can't version them. |
| 804 | if not isinstance(entry.parsed_url, self.FileImpl): |
| 805 | result += ' %s: %s,\n' % (pprint.pformat(entry.name), |
| 806 | pprint.pformat(entry.parsed_url)) |
| 807 | result += '}\n' |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 808 | file_path = os.path.join(self.root_dir, self._options.entries_filename) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 809 | logging.info(result) |
| 810 | gclient_utils.FileWrite(file_path, result) |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 811 | |
| 812 | def _ReadEntries(self): |
| 813 | """Read the .gclient_entries file for the given client. |
| 814 | |
| 815 | Returns: |
| 816 | A sequence of solution names, which will be empty if there is the |
| 817 | entries file hasn't been created yet. |
| 818 | """ |
| 819 | scope = {} |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 820 | filename = os.path.join(self.root_dir, self._options.entries_filename) |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 821 | if not os.path.exists(filename): |
maruel@chromium.org | 73e2114 | 2010-07-05 13:32:01 +0000 | [diff] [blame] | 822 | return {} |
maruel@chromium.org | 5990f9d | 2010-07-07 18:02:58 +0000 | [diff] [blame] | 823 | try: |
| 824 | exec(gclient_utils.FileRead(filename), scope) |
| 825 | except SyntaxError, e: |
| 826 | gclient_utils.SyntaxErrorToError(filename, e) |
maruel@chromium.org | 9a66ddf | 2010-06-16 16:54:16 +0000 | [diff] [blame] | 827 | return scope['entries'] |
| 828 | |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 829 | def _EnforceRevisions(self): |
maruel@chromium.org | 918a9ae | 2010-05-28 15:50:30 +0000 | [diff] [blame] | 830 | """Checks for revision overrides.""" |
| 831 | revision_overrides = {} |
maruel@chromium.org | 307d179 | 2010-05-31 20:03:13 +0000 | [diff] [blame] | 832 | if self._options.head: |
| 833 | return revision_overrides |
joi@chromium.org | 792ea88 | 2010-11-10 02:37:27 +0000 | [diff] [blame] | 834 | # Do not check safesync_url if one or more --revision flag is specified. |
| 835 | if not self._options.revisions: |
| 836 | for s in self.dependencies: |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 837 | if not s.managed: |
| 838 | self._options.revisions.append('%s@unmanaged' % s.name) |
| 839 | elif s.safesync_url: |
| 840 | handle = urllib.urlopen(s.safesync_url) |
| 841 | rev = handle.read().strip() |
| 842 | handle.close() |
| 843 | if len(rev): |
| 844 | self._options.revisions.append('%s@%s' % (s.name, rev)) |
maruel@chromium.org | 307d179 | 2010-05-31 20:03:13 +0000 | [diff] [blame] | 845 | if not self._options.revisions: |
| 846 | return revision_overrides |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 847 | solutions_names = [s.name for s in self.dependencies] |
maruel@chromium.org | 307d179 | 2010-05-31 20:03:13 +0000 | [diff] [blame] | 848 | index = 0 |
| 849 | for revision in self._options.revisions: |
| 850 | if not '@' in revision: |
| 851 | # Support for --revision 123 |
| 852 | revision = '%s@%s' % (solutions_names[index], revision) |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 853 | sol, rev = revision.split('@', 1) |
maruel@chromium.org | 307d179 | 2010-05-31 20:03:13 +0000 | [diff] [blame] | 854 | if not sol in solutions_names: |
| 855 | #raise gclient_utils.Error('%s is not a valid solution.' % sol) |
| 856 | print >> sys.stderr, ('Please fix your script, having invalid ' |
| 857 | '--revision flags will soon considered an error.') |
| 858 | else: |
maruel@chromium.org | 918a9ae | 2010-05-28 15:50:30 +0000 | [diff] [blame] | 859 | revision_overrides[sol] = rev |
maruel@chromium.org | 307d179 | 2010-05-31 20:03:13 +0000 | [diff] [blame] | 860 | index += 1 |
maruel@chromium.org | 918a9ae | 2010-05-28 15:50:30 +0000 | [diff] [blame] | 861 | return revision_overrides |
| 862 | |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 863 | def RunOnDeps(self, command, args): |
| 864 | """Runs a command on each dependency in a client and its dependencies. |
| 865 | |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 866 | Args: |
| 867 | command: The command to use (e.g., 'status' or 'diff') |
| 868 | args: list of str - extra arguments to add to the command line. |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 869 | """ |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 870 | if not self.dependencies: |
maruel@chromium.org | 73e2114 | 2010-07-05 13:32:01 +0000 | [diff] [blame] | 871 | raise gclient_utils.Error('No solution specified') |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 872 | revision_overrides = self._EnforceRevisions() |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 873 | pm = None |
maruel@chromium.org | 5b3f885 | 2010-09-10 16:49:54 +0000 | [diff] [blame] | 874 | # Disable progress for non-tty stdout. |
maruel@chromium.org | a116e7d | 2010-10-05 19:58:02 +0000 | [diff] [blame] | 875 | if (command in ('update', 'revert') and sys.stdout.isatty() and not |
| 876 | self._options.verbose): |
maruel@chromium.org | 049bced | 2010-08-12 13:37:20 +0000 | [diff] [blame] | 877 | pm = Progress('Syncing projects', 1) |
maruel@chromium.org | 9e5317a | 2010-08-13 20:35:11 +0000 | [diff] [blame] | 878 | work_queue = gclient_utils.ExecutionQueue(self._options.jobs, pm) |
maruel@chromium.org | 049bced | 2010-08-12 13:37:20 +0000 | [diff] [blame] | 879 | for s in self.dependencies: |
| 880 | work_queue.enqueue(s) |
maruel@chromium.org | 3742c84 | 2010-09-09 19:27:14 +0000 | [diff] [blame] | 881 | work_queue.flush(revision_overrides, command, args, options=self._options) |
piman@chromium.org | 6f36372 | 2010-04-27 00:41:09 +0000 | [diff] [blame] | 882 | |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 883 | # Once all the dependencies have been processed, it's now safe to run the |
| 884 | # hooks. |
| 885 | if not self._options.nohooks: |
| 886 | self.RunHooksRecursively(self._options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 887 | |
| 888 | if command == 'update': |
ajwong@chromium.org | cdcee80 | 2009-06-23 15:30:42 +0000 | [diff] [blame] | 889 | # Notify the user if there is an orphaned entry in their working copy. |
| 890 | # Only delete the directory if there are no changes in it, and |
| 891 | # delete_unversioned_trees is set to true. |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 892 | entries = [i.name for i in self.root.subtree(False) if i.url] |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 893 | for entry, prev_url in self._ReadEntries().iteritems(): |
maruel@chromium.org | 04dd7de | 2010-10-14 13:25:49 +0000 | [diff] [blame] | 894 | if not prev_url: |
| 895 | # entry must have been overridden via .gclient custom_deps |
| 896 | continue |
maruel@chromium.org | c5e9aec | 2009-08-03 18:25:56 +0000 | [diff] [blame] | 897 | # Fix path separator on Windows. |
| 898 | entry_fixed = entry.replace('/', os.path.sep) |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 899 | e_dir = os.path.join(self.root_dir, entry_fixed) |
maruel@chromium.org | c5e9aec | 2009-08-03 18:25:56 +0000 | [diff] [blame] | 900 | # Use entry and not entry_fixed there. |
maruel@chromium.org | 0329e67 | 2009-05-13 18:41:04 +0000 | [diff] [blame] | 901 | if entry not in entries and os.path.exists(e_dir): |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 902 | file_list = [] |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 903 | scm = gclient_scm.CreateSCM(prev_url, self.root_dir, entry_fixed) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 904 | scm.status(self._options, [], file_list) |
| 905 | modified_files = file_list != [] |
maruel@chromium.org | 28d14bd | 2010-11-11 20:37:09 +0000 | [diff] [blame] | 906 | if (not self._options.delete_unversioned_trees or |
| 907 | (modified_files and not self._options.force)): |
maruel@chromium.org | c5e9aec | 2009-08-03 18:25:56 +0000 | [diff] [blame] | 908 | # There are modified files in this entry. Keep warning until |
| 909 | # removed. |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 910 | print(('\nWARNING: \'%s\' is no longer part of this client. ' |
| 911 | 'It is recommended that you manually remove it.\n') % |
maruel@chromium.org | c5e9aec | 2009-08-03 18:25:56 +0000 | [diff] [blame] | 912 | entry_fixed) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 913 | else: |
| 914 | # Delete the entry |
maruel@chromium.org | 73e2114 | 2010-07-05 13:32:01 +0000 | [diff] [blame] | 915 | print('\n________ deleting \'%s\' in \'%s\'' % ( |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 916 | entry_fixed, self.root_dir)) |
maruel@chromium.org | 5f3eee3 | 2009-09-17 00:34:30 +0000 | [diff] [blame] | 917 | gclient_utils.RemoveDirectory(e_dir) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 918 | # record the current list of entries for next time |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 919 | self._SaveEntries() |
maruel@chromium.org | 17cdf76 | 2010-05-28 17:30:52 +0000 | [diff] [blame] | 920 | return 0 |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 921 | |
| 922 | def PrintRevInfo(self): |
maruel@chromium.org | 54a07a2 | 2010-06-14 19:07:39 +0000 | [diff] [blame] | 923 | if not self.dependencies: |
maruel@chromium.org | 73e2114 | 2010-07-05 13:32:01 +0000 | [diff] [blame] | 924 | raise gclient_utils.Error('No solution specified') |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 925 | # Load all the settings. |
maruel@chromium.org | 9e5317a | 2010-08-13 20:35:11 +0000 | [diff] [blame] | 926 | work_queue = gclient_utils.ExecutionQueue(self._options.jobs, None) |
maruel@chromium.org | 049bced | 2010-08-12 13:37:20 +0000 | [diff] [blame] | 927 | for s in self.dependencies: |
| 928 | work_queue.enqueue(s) |
maruel@chromium.org | 3742c84 | 2010-09-09 19:27:14 +0000 | [diff] [blame] | 929 | work_queue.flush({}, None, [], options=self._options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 930 | |
maruel@chromium.org | 6da25d0 | 2010-08-11 17:32:55 +0000 | [diff] [blame] | 931 | def GetURLAndRev(dep): |
| 932 | """Returns the revision-qualified SCM url for a Dependency.""" |
| 933 | if dep.parsed_url is None: |
maruel@chromium.org | baa578e | 2010-07-12 17:36:59 +0000 | [diff] [blame] | 934 | return None |
maruel@chromium.org | 6da25d0 | 2010-08-11 17:32:55 +0000 | [diff] [blame] | 935 | if isinstance(dep.parsed_url, self.FileImpl): |
| 936 | original_url = dep.parsed_url.file_location |
| 937 | else: |
| 938 | original_url = dep.parsed_url |
nasser@codeaurora.org | 5d63eb8 | 2010-03-24 23:22:09 +0000 | [diff] [blame] | 939 | url, _ = gclient_utils.SplitUrlRevision(original_url) |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 940 | scm = gclient_scm.CreateSCM(original_url, self.root_dir, dep.name) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 941 | if not os.path.isdir(scm.checkout_path): |
| 942 | return None |
maruel@chromium.org | baa578e | 2010-07-12 17:36:59 +0000 | [diff] [blame] | 943 | return '%s@%s' % (url, scm.revinfo(self._options, [], None)) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 944 | |
maruel@chromium.org | baa578e | 2010-07-12 17:36:59 +0000 | [diff] [blame] | 945 | if self._options.snapshot: |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 946 | new_gclient = '' |
| 947 | # First level at .gclient |
| 948 | for d in self.dependencies: |
| 949 | entries = {} |
maruel@chromium.org | 6da25d0 | 2010-08-11 17:32:55 +0000 | [diff] [blame] | 950 | def GrabDeps(dep): |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 951 | """Recursively grab dependencies.""" |
maruel@chromium.org | 6da25d0 | 2010-08-11 17:32:55 +0000 | [diff] [blame] | 952 | for d in dep.dependencies: |
| 953 | entries[d.name] = GetURLAndRev(d) |
| 954 | GrabDeps(d) |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 955 | GrabDeps(d) |
| 956 | custom_deps = [] |
| 957 | for k in sorted(entries.keys()): |
| 958 | if entries[k]: |
| 959 | # Quotes aren't escaped... |
| 960 | custom_deps.append(' \"%s\": \'%s\',\n' % (k, entries[k])) |
| 961 | else: |
| 962 | custom_deps.append(' \"%s\": None,\n' % k) |
| 963 | new_gclient += self.DEFAULT_SNAPSHOT_SOLUTION_TEXT % { |
| 964 | 'solution_name': d.name, |
| 965 | 'solution_url': d.url, |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 966 | 'deps_file': d.deps_file, |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 967 | 'safesync_url' : d.safesync_url or '', |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 968 | 'managed': d.managed, |
maruel@chromium.org | df2b315 | 2010-07-21 17:35:24 +0000 | [diff] [blame] | 969 | 'solution_deps': ''.join(custom_deps), |
| 970 | } |
| 971 | # Print the snapshot configuration file |
| 972 | print(self.DEFAULT_SNAPSHOT_FILE_TEXT % {'solution_list': new_gclient}) |
nasser@codeaurora.org | de8f352 | 2010-03-11 23:47:44 +0000 | [diff] [blame] | 973 | else: |
maruel@chromium.org | b1e315f | 2010-08-11 18:44:50 +0000 | [diff] [blame] | 974 | entries = {} |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 975 | for d in self.root.subtree(False): |
maruel@chromium.org | b1e315f | 2010-08-11 18:44:50 +0000 | [diff] [blame] | 976 | if self._options.actual: |
| 977 | entries[d.name] = GetURLAndRev(d) |
| 978 | else: |
| 979 | entries[d.name] = d.parsed_url |
| 980 | keys = sorted(entries.keys()) |
| 981 | for x in keys: |
maruel@chromium.org | ce46489 | 2010-08-12 17:12:18 +0000 | [diff] [blame] | 982 | print('%s: %s' % (x, entries[x])) |
maruel@chromium.org | dde32ee | 2010-08-10 17:44:05 +0000 | [diff] [blame] | 983 | logging.info(str(self)) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 984 | |
maruel@chromium.org | f50907b | 2010-08-12 17:05:48 +0000 | [diff] [blame] | 985 | def ParseDepsFile(self): |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 986 | """No DEPS to parse for a .gclient file.""" |
maruel@chromium.org | 049bced | 2010-08-12 13:37:20 +0000 | [diff] [blame] | 987 | raise gclient_utils.Error('Internal error') |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 988 | |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 989 | @property |
maruel@chromium.org | 75a5927 | 2010-06-11 22:34:03 +0000 | [diff] [blame] | 990 | def root_dir(self): |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 991 | """Root directory of gclient checkout.""" |
maruel@chromium.org | 75a5927 | 2010-06-11 22:34:03 +0000 | [diff] [blame] | 992 | return self._root_dir |
| 993 | |
maruel@chromium.org | d6db3d5 | 2011-09-20 14:00:45 +0000 | [diff] [blame] | 994 | @property |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 995 | def enforced_os(self): |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 996 | """What deps_os entries that are to be parsed.""" |
maruel@chromium.org | 271375b | 2010-06-23 19:17:38 +0000 | [diff] [blame] | 997 | return self._enforced_os |
| 998 | |
maruel@chromium.org | 6898897 | 2011-09-20 14:11:42 +0000 | [diff] [blame] | 999 | @property |
maruel@chromium.org | d36fba8 | 2010-06-28 16:50:40 +0000 | [diff] [blame] | 1000 | def recursion_limit(self): |
| 1001 | """How recursive can each dependencies in DEPS file can load DEPS file.""" |
| 1002 | return self._recursion_limit |
| 1003 | |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1004 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1005 | #### gclient commands. |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1006 | |
| 1007 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1008 | def CMDcleanup(parser, args): |
| 1009 | """Cleans up all working copies. |
maruel@chromium.org | ddff62d | 2010-05-17 21:02:36 +0000 | [diff] [blame] | 1010 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1011 | Mostly svn-specific. Simply runs 'svn cleanup' for each module. |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1012 | """ |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1013 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1014 | help='override deps for the specified (comma-separated) ' |
| 1015 | 'platform(s); \'all\' will process all deps_os ' |
| 1016 | 'references') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1017 | (options, args) = parser.parse_args(args) |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1018 | client = GClient.LoadCurrentConfig(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1019 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1020 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1021 | if options.verbose: |
| 1022 | # Print out the .gclient file. This is longer than if we just printed the |
| 1023 | # client dict, but more legible, and it might contain helpful comments. |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 1024 | print(client.config_content) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1025 | return client.RunOnDeps('cleanup', args) |
| 1026 | |
| 1027 | |
piman@chromium.org | 4b90e3a | 2010-07-01 20:28:26 +0000 | [diff] [blame] | 1028 | @attr('usage', '[command] [args ...]') |
| 1029 | def CMDrecurse(parser, args): |
| 1030 | """Operates on all the entries. |
| 1031 | |
| 1032 | Runs a shell command on all entries. |
| 1033 | """ |
| 1034 | # Stop parsing at the first non-arg so that these go through to the command |
| 1035 | parser.disable_interspersed_args() |
| 1036 | parser.add_option('-s', '--scm', action='append', default=[], |
| 1037 | help='choose scm types to operate upon') |
| 1038 | options, args = parser.parse_args(args) |
maruel@chromium.org | 45e9f2d | 2010-10-18 13:33:46 +0000 | [diff] [blame] | 1039 | if not args: |
| 1040 | print >> sys.stderr, 'Need to supply a command!' |
| 1041 | return 1 |
maruel@chromium.org | 78cba52 | 2010-10-18 13:32:05 +0000 | [diff] [blame] | 1042 | root_and_entries = gclient_utils.GetGClientRootAndEntries() |
| 1043 | if not root_and_entries: |
| 1044 | print >> sys.stderr, ( |
| 1045 | 'You need to run gclient sync at least once to use \'recurse\'.\n' |
| 1046 | 'This is because .gclient_entries needs to exist and be up to date.') |
| 1047 | return 1 |
| 1048 | root, entries = root_and_entries |
piman@chromium.org | 4b90e3a | 2010-07-01 20:28:26 +0000 | [diff] [blame] | 1049 | scm_set = set() |
| 1050 | for scm in options.scm: |
| 1051 | scm_set.update(scm.split(',')) |
| 1052 | |
| 1053 | # Pass in the SCM type as an env variable |
| 1054 | env = os.environ.copy() |
| 1055 | |
| 1056 | for path, url in entries.iteritems(): |
| 1057 | scm = gclient_scm.GetScmName(url) |
| 1058 | if scm_set and scm not in scm_set: |
| 1059 | continue |
maruel@chromium.org | 2b9aa8e | 2010-08-25 20:01:42 +0000 | [diff] [blame] | 1060 | cwd = os.path.normpath(os.path.join(root, path)) |
maruel@chromium.org | ac61023 | 2010-10-13 14:01:31 +0000 | [diff] [blame] | 1061 | if scm: |
| 1062 | env['GCLIENT_SCM'] = scm |
| 1063 | if url: |
| 1064 | env['GCLIENT_URL'] = url |
maruel@chromium.org | 1ba646f | 2011-09-08 17:11:53 +0000 | [diff] [blame] | 1065 | subprocess2.call(args, cwd=cwd, env=env) |
maruel@chromium.org | ac61023 | 2010-10-13 14:01:31 +0000 | [diff] [blame] | 1066 | return 0 |
piman@chromium.org | 4b90e3a | 2010-07-01 20:28:26 +0000 | [diff] [blame] | 1067 | |
| 1068 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1069 | @attr('usage', '[url] [safesync url]') |
| 1070 | def CMDconfig(parser, args): |
maruel@chromium.org | ddff62d | 2010-05-17 21:02:36 +0000 | [diff] [blame] | 1071 | """Create a .gclient file in the current directory. |
| 1072 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1073 | This specifies the configuration for further commands. After update/sync, |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1074 | top-level DEPS files in each module are read to determine dependent |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1075 | modules to operate on as well. If optional [url] parameter is |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1076 | provided, then configuration is read from a specified Subversion server |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1077 | URL. |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1078 | """ |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1079 | parser.add_option('--spec', |
| 1080 | help='create a gclient file containing the provided ' |
| 1081 | 'string. Due to Cygwin/Python brokenness, it ' |
| 1082 | 'probably can\'t contain any newlines.') |
| 1083 | parser.add_option('--name', |
| 1084 | help='overrides the default name for the solution') |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 1085 | parser.add_option('--deps-file', default='DEPS', |
| 1086 | help='overrides the default name for the DEPS file for the' |
| 1087 | 'main solutions and all sub-dependencies') |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 1088 | parser.add_option('--unmanaged', action='store_true', default=False, |
| 1089 | help='overrides the default behavior to make it possible ' |
| 1090 | 'to have the main solution untouched by gclient ' |
| 1091 | '(gclient will check out unmanaged dependencies but ' |
| 1092 | 'will never sync them)') |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 1093 | parser.add_option('--git-deps', action='store_true', |
| 1094 | help='sets the deps file to ".DEPS.git" instead of "DEPS"') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1095 | (options, args) = parser.parse_args(args) |
maruel@chromium.org | 5fc2a33 | 2010-05-26 19:37:15 +0000 | [diff] [blame] | 1096 | if ((options.spec and args) or len(args) > 2 or |
| 1097 | (not options.spec and not args)): |
| 1098 | parser.error('Inconsistent arguments. Use either --spec or one or 2 args') |
| 1099 | |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1100 | client = GClient('.', options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1101 | if options.spec: |
| 1102 | client.SetConfig(options.spec) |
| 1103 | else: |
maruel@chromium.org | 1ab7ffc | 2009-06-03 17:21:37 +0000 | [diff] [blame] | 1104 | base_url = args[0].rstrip('/') |
iposva@chromium.org | 8cf7a39 | 2010-04-07 17:20:26 +0000 | [diff] [blame] | 1105 | if not options.name: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1106 | name = base_url.split('/')[-1] |
nsylvain@google.com | 12649ef | 2011-06-01 17:11:20 +0000 | [diff] [blame] | 1107 | if name.endswith('.git'): |
| 1108 | name = name[:-4] |
iposva@chromium.org | 8cf7a39 | 2010-04-07 17:20:26 +0000 | [diff] [blame] | 1109 | else: |
| 1110 | # specify an alternate relpath for the given URL. |
| 1111 | name = options.name |
nsylvain@google.com | efc8093 | 2011-05-31 21:27:56 +0000 | [diff] [blame] | 1112 | deps_file = options.deps_file |
| 1113 | if options.git_deps: |
| 1114 | deps_file = '.DEPS.git' |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1115 | safesync_url = '' |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1116 | if len(args) > 1: |
| 1117 | safesync_url = args[1] |
cmp@chromium.org | eb2756d | 2011-09-20 20:17:51 +0000 | [diff] [blame] | 1118 | client.SetDefaultConfig(name, deps_file, base_url, safesync_url, |
| 1119 | managed=not options.unmanaged) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1120 | client.SaveConfig() |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1121 | return 0 |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1122 | |
| 1123 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1124 | @attr('epilog', """Example: |
| 1125 | gclient pack > patch.txt |
| 1126 | generate simple patch for configured client and dependences |
| 1127 | """) |
| 1128 | def CMDpack(parser, args): |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1129 | """Generate a patch which can be applied at the root of the tree. |
maruel@chromium.org | ddff62d | 2010-05-17 21:02:36 +0000 | [diff] [blame] | 1130 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1131 | Internally, runs 'svn diff'/'git diff' on each checked out module and |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1132 | dependencies, and performs minimal postprocessing of the output. The |
| 1133 | resulting patch is printed to stdout and can be applied to a freshly |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1134 | checked out tree via 'patch -p0 < patchfile'. |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1135 | """ |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1136 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1137 | help='override deps for the specified (comma-separated) ' |
| 1138 | 'platform(s); \'all\' will process all deps_os ' |
| 1139 | 'references') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1140 | (options, args) = parser.parse_args(args) |
kbr@google.com | ab31859 | 2009-09-04 00:54:55 +0000 | [diff] [blame] | 1141 | client = GClient.LoadCurrentConfig(options) |
| 1142 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1143 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
kbr@google.com | ab31859 | 2009-09-04 00:54:55 +0000 | [diff] [blame] | 1144 | if options.verbose: |
| 1145 | # Print out the .gclient file. This is longer than if we just printed the |
| 1146 | # client dict, but more legible, and it might contain helpful comments. |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 1147 | print(client.config_content) |
kbr@google.com | ab31859 | 2009-09-04 00:54:55 +0000 | [diff] [blame] | 1148 | return client.RunOnDeps('pack', args) |
| 1149 | |
| 1150 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1151 | def CMDstatus(parser, args): |
| 1152 | """Show modification status for every dependencies.""" |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1153 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1154 | help='override deps for the specified (comma-separated) ' |
| 1155 | 'platform(s); \'all\' will process all deps_os ' |
| 1156 | 'references') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1157 | (options, args) = parser.parse_args(args) |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1158 | client = GClient.LoadCurrentConfig(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1159 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1160 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1161 | if options.verbose: |
| 1162 | # Print out the .gclient file. This is longer than if we just printed the |
| 1163 | # client dict, but more legible, and it might contain helpful comments. |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 1164 | print(client.config_content) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1165 | return client.RunOnDeps('status', args) |
| 1166 | |
| 1167 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1168 | @attr('epilog', """Examples: |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1169 | gclient sync |
| 1170 | update files from SCM according to current configuration, |
| 1171 | *for modules which have changed since last update or sync* |
| 1172 | gclient sync --force |
| 1173 | update files from SCM according to current configuration, for |
| 1174 | all modules (useful for recovering files deleted from local copy) |
| 1175 | gclient sync --revision src@31000 |
| 1176 | update src directory to r31000 |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1177 | """) |
| 1178 | def CMDsync(parser, args): |
| 1179 | """Checkout/update all modules.""" |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1180 | parser.add_option('-f', '--force', action='store_true', |
| 1181 | help='force update even for unchanged modules') |
| 1182 | parser.add_option('-n', '--nohooks', action='store_true', |
| 1183 | help='don\'t run hooks after the update is complete') |
| 1184 | parser.add_option('-r', '--revision', action='append', |
| 1185 | dest='revisions', metavar='REV', default=[], |
| 1186 | help='Enforces revision/hash for the solutions with the ' |
| 1187 | 'format src@rev. The src@ part is optional and can be ' |
| 1188 | 'skipped. -r can be used multiple times when .gclient ' |
| 1189 | 'has multiple solutions configured and will work even ' |
joi@chromium.org | 792ea88 | 2010-11-10 02:37:27 +0000 | [diff] [blame] | 1190 | 'if the src@ part is skipped. Note that specifying ' |
| 1191 | '--revision means your safesync_url gets ignored.') |
floitsch@google.com | eaab784 | 2011-04-28 09:07:58 +0000 | [diff] [blame] | 1192 | parser.add_option('-t', '--transitive', action='store_true', |
| 1193 | help='When a revision is specified (in the DEPS file or ' |
| 1194 | 'with the command-line flag), transitively update ' |
| 1195 | 'the dependencies to the date of the given revision. ' |
| 1196 | 'Only supported for SVN repositories.') |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1197 | parser.add_option('-H', '--head', action='store_true', |
| 1198 | help='skips any safesync_urls specified in ' |
| 1199 | 'configured solutions and sync to head instead') |
| 1200 | parser.add_option('-D', '--delete_unversioned_trees', action='store_true', |
maruel@chromium.org | 28d14bd | 2010-11-11 20:37:09 +0000 | [diff] [blame] | 1201 | help='delete any dependency that have been removed from ' |
| 1202 | 'last sync as long as there is no local modification. ' |
| 1203 | 'Coupled with --force, it will remove them even with ' |
| 1204 | 'local modifications') |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1205 | parser.add_option('-R', '--reset', action='store_true', |
| 1206 | help='resets any local changes before updating (git only)') |
bauerb@chromium.org | 2aad1b2 | 2011-07-22 12:00:41 +0000 | [diff] [blame] | 1207 | parser.add_option('-M', '--merge', action='store_true', |
| 1208 | help='merge upstream changes instead of trying to ' |
| 1209 | 'fast-forward or rebase') |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1210 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1211 | help='override deps for the specified (comma-separated) ' |
| 1212 | 'platform(s); \'all\' will process all deps_os ' |
| 1213 | 'references') |
| 1214 | parser.add_option('-m', '--manually_grab_svn_rev', action='store_true', |
| 1215 | help='Skip svn up whenever possible by requesting ' |
| 1216 | 'actual HEAD revision from the repository') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1217 | (options, args) = parser.parse_args(args) |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1218 | client = GClient.LoadCurrentConfig(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1219 | |
| 1220 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1221 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1222 | |
maruel@chromium.org | 307d179 | 2010-05-31 20:03:13 +0000 | [diff] [blame] | 1223 | if options.revisions and options.head: |
| 1224 | # TODO(maruel): Make it a parser.error if it doesn't break any builder. |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1225 | print('Warning: you cannot use both --head and --revision') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1226 | |
| 1227 | if options.verbose: |
| 1228 | # Print out the .gclient file. This is longer than if we just printed the |
| 1229 | # client dict, but more legible, and it might contain helpful comments. |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 1230 | print(client.config_content) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1231 | return client.RunOnDeps('update', args) |
| 1232 | |
| 1233 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1234 | def CMDupdate(parser, args): |
maruel@chromium.org | ddff62d | 2010-05-17 21:02:36 +0000 | [diff] [blame] | 1235 | """Alias for the sync command. Deprecated.""" |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1236 | return CMDsync(parser, args) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1237 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1238 | def CMDdiff(parser, args): |
| 1239 | """Displays local diff for every dependencies.""" |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1240 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1241 | help='override deps for the specified (comma-separated) ' |
| 1242 | 'platform(s); \'all\' will process all deps_os ' |
| 1243 | 'references') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1244 | (options, args) = parser.parse_args(args) |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1245 | client = GClient.LoadCurrentConfig(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1246 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1247 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1248 | if options.verbose: |
| 1249 | # Print out the .gclient file. This is longer than if we just printed the |
| 1250 | # client dict, but more legible, and it might contain helpful comments. |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 1251 | print(client.config_content) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1252 | return client.RunOnDeps('diff', args) |
| 1253 | |
| 1254 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1255 | def CMDrevert(parser, args): |
maruel@chromium.org | 28d14bd | 2010-11-11 20:37:09 +0000 | [diff] [blame] | 1256 | """Revert all modifications in every dependencies. |
| 1257 | |
| 1258 | That's the nuclear option to get back to a 'clean' state. It removes anything |
| 1259 | that shows up in svn status.""" |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1260 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1261 | help='override deps for the specified (comma-separated) ' |
| 1262 | 'platform(s); \'all\' will process all deps_os ' |
| 1263 | 'references') |
| 1264 | parser.add_option('-n', '--nohooks', action='store_true', |
| 1265 | help='don\'t run hooks after the revert is complete') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1266 | (options, args) = parser.parse_args(args) |
| 1267 | # --force is implied. |
| 1268 | options.force = True |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1269 | client = GClient.LoadCurrentConfig(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1270 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1271 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1272 | return client.RunOnDeps('revert', args) |
| 1273 | |
| 1274 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1275 | def CMDrunhooks(parser, args): |
| 1276 | """Runs hooks for files that have been modified in the local working copy.""" |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1277 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1278 | help='override deps for the specified (comma-separated) ' |
| 1279 | 'platform(s); \'all\' will process all deps_os ' |
| 1280 | 'references') |
| 1281 | parser.add_option('-f', '--force', action='store_true', default=True, |
| 1282 | help='Deprecated. No effect.') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1283 | (options, args) = parser.parse_args(args) |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1284 | client = GClient.LoadCurrentConfig(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1285 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1286 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1287 | if options.verbose: |
| 1288 | # Print out the .gclient file. This is longer than if we just printed the |
| 1289 | # client dict, but more legible, and it might contain helpful comments. |
maruel@chromium.org | 116704f | 2010-06-11 17:34:38 +0000 | [diff] [blame] | 1290 | print(client.config_content) |
maruel@chromium.org | 5df6a46 | 2009-08-28 18:52:26 +0000 | [diff] [blame] | 1291 | options.force = True |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1292 | options.nohooks = False |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1293 | return client.RunOnDeps('runhooks', args) |
| 1294 | |
| 1295 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1296 | def CMDrevinfo(parser, args): |
maruel@chromium.org | 9eda411 | 2010-06-11 18:56:10 +0000 | [diff] [blame] | 1297 | """Output revision info mapping for the client and its dependencies. |
| 1298 | |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1299 | This allows the capture of an overall 'revision' for the source tree that |
maruel@chromium.org | 9eda411 | 2010-06-11 18:56:10 +0000 | [diff] [blame] | 1300 | can be used to reproduce the same tree in the future. It is only useful for |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1301 | 'unpinned dependencies', i.e. DEPS/deps references without a svn revision |
| 1302 | number or a git hash. A git branch name isn't 'pinned' since the actual |
maruel@chromium.org | 9eda411 | 2010-06-11 18:56:10 +0000 | [diff] [blame] | 1303 | commit can change. |
| 1304 | """ |
| 1305 | parser.add_option('--deps', dest='deps_os', metavar='OS_LIST', |
| 1306 | help='override deps for the specified (comma-separated) ' |
| 1307 | 'platform(s); \'all\' will process all deps_os ' |
| 1308 | 'references') |
maruel@chromium.org | b1e315f | 2010-08-11 18:44:50 +0000 | [diff] [blame] | 1309 | parser.add_option('-a', '--actual', action='store_true', |
| 1310 | help='gets the actual checked out revisions instead of the ' |
| 1311 | 'ones specified in the DEPS and .gclient files') |
maruel@chromium.org | 9eda411 | 2010-06-11 18:56:10 +0000 | [diff] [blame] | 1312 | parser.add_option('-s', '--snapshot', action='store_true', |
| 1313 | help='creates a snapshot .gclient file of the current ' |
maruel@chromium.org | b1e315f | 2010-08-11 18:44:50 +0000 | [diff] [blame] | 1314 | 'version of all repositories to reproduce the tree, ' |
| 1315 | 'implies -a') |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1316 | (options, args) = parser.parse_args(args) |
maruel@chromium.org | 2806acc | 2009-05-15 12:33:34 +0000 | [diff] [blame] | 1317 | client = GClient.LoadCurrentConfig(options) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1318 | if not client: |
maruel@chromium.org | 0b6a084 | 2010-06-15 14:34:19 +0000 | [diff] [blame] | 1319 | raise gclient_utils.Error('client not configured; see \'gclient config\'') |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1320 | client.PrintRevInfo() |
maruel@chromium.org | 79692d6 | 2010-05-14 18:57:13 +0000 | [diff] [blame] | 1321 | return 0 |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1322 | |
| 1323 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1324 | def Command(name): |
| 1325 | return getattr(sys.modules[__name__], 'CMD' + name, None) |
| 1326 | |
| 1327 | |
| 1328 | def CMDhelp(parser, args): |
| 1329 | """Prints list of commands or help for a specific command.""" |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1330 | (_, args) = parser.parse_args(args) |
maruel@chromium.org | ddff62d | 2010-05-17 21:02:36 +0000 | [diff] [blame] | 1331 | if len(args) == 1: |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1332 | return Main(args + ['--help']) |
maruel@chromium.org | ddff62d | 2010-05-17 21:02:36 +0000 | [diff] [blame] | 1333 | parser.print_help() |
| 1334 | return 0 |
| 1335 | |
| 1336 | |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1337 | def GenUsage(parser, command): |
| 1338 | """Modify an OptParse object with the function's documentation.""" |
| 1339 | obj = Command(command) |
| 1340 | if command == 'help': |
| 1341 | command = '<command>' |
| 1342 | # OptParser.description prefer nicely non-formatted strings. |
| 1343 | parser.description = re.sub('[\r\n ]{2,}', ' ', obj.__doc__) |
| 1344 | usage = getattr(obj, 'usage', '') |
| 1345 | parser.set_usage('%%prog %s [options] %s' % (command, usage)) |
| 1346 | parser.epilog = getattr(obj, 'epilog', None) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1347 | |
| 1348 | |
maruel@chromium.org | 0895b75 | 2011-08-26 20:40:33 +0000 | [diff] [blame] | 1349 | def Parser(): |
| 1350 | """Returns the default parser.""" |
| 1351 | parser = optparse.OptionParser(version='%prog ' + __version__) |
maruel@chromium.org | 8fbb776 | 2011-09-14 17:44:53 +0000 | [diff] [blame] | 1352 | parser.add_option('-j', '--jobs', default=1, type='int', |
maruel@chromium.org | 0895b75 | 2011-08-26 20:40:33 +0000 | [diff] [blame] | 1353 | help='Specify how many SCM commands can run in parallel; ' |
| 1354 | 'default=%default') |
| 1355 | parser.add_option('-v', '--verbose', action='count', default=0, |
| 1356 | help='Produces additional output for diagnostics. Can be ' |
| 1357 | 'used up to three times for more logging info.') |
| 1358 | parser.add_option('--gclientfile', dest='config_filename', |
| 1359 | default=os.environ.get('GCLIENT_FILE', '.gclient'), |
| 1360 | help='Specify an alternate %default file') |
| 1361 | # Integrate standard options processing. |
| 1362 | old_parser = parser.parse_args |
| 1363 | def Parse(args): |
| 1364 | (options, args) = old_parser(args) |
| 1365 | level = None |
| 1366 | if options.verbose == 2: |
| 1367 | level = logging.INFO |
| 1368 | elif options.verbose > 2: |
| 1369 | level = logging.DEBUG |
| 1370 | logging.basicConfig(level=level, |
| 1371 | format='%(module)s(%(lineno)d) %(funcName)s:%(message)s') |
| 1372 | options.entries_filename = options.config_filename + '_entries' |
| 1373 | if options.jobs < 1: |
| 1374 | parser.error('--jobs must be 1 or higher') |
| 1375 | |
| 1376 | # These hacks need to die. |
| 1377 | if not hasattr(options, 'revisions'): |
| 1378 | # GClient.RunOnDeps expects it even if not applicable. |
| 1379 | options.revisions = [] |
| 1380 | if not hasattr(options, 'head'): |
| 1381 | options.head = None |
| 1382 | if not hasattr(options, 'nohooks'): |
| 1383 | options.nohooks = True |
| 1384 | if not hasattr(options, 'deps_os'): |
| 1385 | options.deps_os = None |
| 1386 | if not hasattr(options, 'manually_grab_svn_rev'): |
| 1387 | options.manually_grab_svn_rev = None |
| 1388 | if not hasattr(options, 'force'): |
| 1389 | options.force = None |
| 1390 | return (options, args) |
| 1391 | parser.parse_args = Parse |
| 1392 | # We don't want wordwrapping in epilog (usually examples) |
| 1393 | parser.format_epilog = lambda _: parser.epilog or '' |
| 1394 | return parser |
| 1395 | |
| 1396 | |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1397 | def Main(argv): |
maruel@chromium.org | 5ca2769 | 2010-05-26 19:32:41 +0000 | [diff] [blame] | 1398 | """Doesn't parse the arguments here, just find the right subcommand to |
| 1399 | execute.""" |
maruel@chromium.org | c3a15a2 | 2010-11-20 03:12:27 +0000 | [diff] [blame] | 1400 | if sys.hexversion < 0x02050000: |
| 1401 | print >> sys.stderr, ( |
| 1402 | '\nYour python version is unsupported, please upgrade.\n') |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1403 | try: |
maruel@chromium.org | e0de9cb | 2010-09-17 15:07:14 +0000 | [diff] [blame] | 1404 | # Make stdout auto-flush so buildbot doesn't kill us during lengthy |
| 1405 | # operations. Python as a strong tendency to buffer sys.stdout. |
| 1406 | sys.stdout = gclient_utils.MakeFileAutoFlush(sys.stdout) |
maruel@chromium.org | 4ed3418 | 2010-09-17 15:57:47 +0000 | [diff] [blame] | 1407 | # Make stdout annotated with the thread ids. |
| 1408 | sys.stdout = gclient_utils.MakeFileAnnotated(sys.stdout) |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1409 | # Do it late so all commands are listed. |
maruel@chromium.org | b17b55b | 2010-11-03 14:42:37 +0000 | [diff] [blame] | 1410 | # Unused variable 'usage' |
| 1411 | # pylint: disable=W0612 |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1412 | CMDhelp.usage = ('\n\nCommands are:\n' + '\n'.join([ |
| 1413 | ' %-10s %s' % (fn[3:], Command(fn[3:]).__doc__.split('\n')[0].strip()) |
| 1414 | for fn in dir(sys.modules[__name__]) if fn.startswith('CMD')])) |
maruel@chromium.org | 0895b75 | 2011-08-26 20:40:33 +0000 | [diff] [blame] | 1415 | parser = Parser() |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1416 | if argv: |
| 1417 | command = Command(argv[0]) |
| 1418 | if command: |
maruel@chromium.org | f0fc991 | 2010-06-11 17:57:33 +0000 | [diff] [blame] | 1419 | # 'fix' the usage and the description now that we know the subcommand. |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1420 | GenUsage(parser, argv[0]) |
| 1421 | return command(parser, argv[1:]) |
| 1422 | # Not a known command. Default to help. |
| 1423 | GenUsage(parser, 'help') |
| 1424 | return CMDhelp(parser, argv) |
maruel@chromium.org | 31cb48a | 2011-04-04 18:01:36 +0000 | [diff] [blame] | 1425 | except (gclient_utils.Error, subprocess2.CalledProcessError), e: |
maruel@chromium.org | f0fc991 | 2010-06-11 17:57:33 +0000 | [diff] [blame] | 1426 | print >> sys.stderr, 'Error: %s' % str(e) |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1427 | return 1 |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1428 | |
| 1429 | |
maruel@chromium.org | f0fc991 | 2010-06-11 17:57:33 +0000 | [diff] [blame] | 1430 | if '__main__' == __name__: |
maruel@chromium.org | 35625c7 | 2011-03-23 17:34:02 +0000 | [diff] [blame] | 1431 | fix_encoding.fix_encoding() |
maruel@chromium.org | 6e29d57 | 2010-06-04 17:32:20 +0000 | [diff] [blame] | 1432 | sys.exit(Main(sys.argv[1:])) |
maruel@google.com | fb2b8eb | 2009-04-23 21:03:42 +0000 | [diff] [blame] | 1433 | |
| 1434 | # vim: ts=2:sw=2:tw=80:et: |