blob: 5bbab8018dab48c9e18c8fa5efbfff72383ff81b [file] [log] [blame]
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001#!/usr/bin/python
2# git-cl -- a git-command for integrating reviews on Rietveld
3# Copyright (C) 2008 Evan Martin <martine@danga.com>
4
5import errno
6import logging
7import optparse
8import os
9import re
dpranke@chromium.org970c5222011-03-12 00:32:24 +000010import StringIO
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000011import subprocess
12import sys
13import tempfile
14import textwrap
15import upload
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +000016import urlparse
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000017import urllib2
18
19try:
20 import readline
21except ImportError:
22 pass
23
24try:
dpranke@chromium.org23beb9e2011-03-11 23:20:54 +000025 # TODO(dpranke): We wrap this in a try block for a limited form of
26 # backwards-compatibility with older versions of git-cl that weren't
27 # dependent on depot_tools. This version should still work outside of
28 # depot_tools as long as --bypass-hooks is used. We should remove this
29 # once this has baked for a while and things seem safe.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000030 depot_tools_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
31 sys.path.append(depot_tools_path)
32 import breakpad
33except ImportError:
34 pass
35
36DEFAULT_SERVER = 'http://codereview.appspot.com'
maruel@chromium.org0ba7f962011-01-11 22:13:58 +000037POSTUPSTREAM_HOOK_PATTERN = '.git/hooks/post-cl-%s'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000038DESCRIPTION_BACKUP_FILE = '~/.git_cl_description_backup'
39
40def DieWithError(message):
dpranke@chromium.org970c5222011-03-12 00:32:24 +000041 print >> sys.stderr, message
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000042 sys.exit(1)
43
44
45def Popen(cmd, **kwargs):
46 """Wrapper for subprocess.Popen() that logs and watch for cygwin issues"""
47 logging.info('Popen: ' + ' '.join(cmd))
48 try:
49 return subprocess.Popen(cmd, **kwargs)
50 except OSError, e:
51 if e.errno == errno.EAGAIN and sys.platform == 'cygwin':
52 DieWithError(
53 'Visit '
54 'http://code.google.com/p/chromium/wiki/CygwinDllRemappingFailure to '
55 'learn how to fix this error; you need to rebase your cygwin dlls')
56 raise
57
58
59def RunCommand(cmd, error_ok=False, error_message=None,
maruel@chromium.orgb92e4802011-03-03 20:22:00 +000060 redirect_stdout=True, swallow_stderr=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000061 if redirect_stdout:
62 stdout = subprocess.PIPE
63 else:
64 stdout = None
65 if swallow_stderr:
66 stderr = subprocess.PIPE
67 else:
68 stderr = None
maruel@chromium.orgb92e4802011-03-03 20:22:00 +000069 proc = Popen(cmd, stdout=stdout, stderr=stderr, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000070 output = proc.communicate()[0]
71 if not error_ok and proc.returncode != 0:
72 DieWithError('Command "%s" failed.\n' % (' '.join(cmd)) +
73 (error_message or output or ''))
74 return output
75
76
77def RunGit(args, **kwargs):
78 cmd = ['git'] + args
79 return RunCommand(cmd, **kwargs)
80
81
82def RunGitWithCode(args):
83 proc = Popen(['git'] + args, stdout=subprocess.PIPE)
84 output = proc.communicate()[0]
85 return proc.returncode, output
86
87
88def usage(more):
89 def hook(fn):
90 fn.usage_more = more
91 return fn
92 return hook
93
94
95def FixUrl(server):
96 """Fix a server url to defaults protocol to http:// if none is specified."""
97 if not server:
98 return server
99 if not re.match(r'[a-z]+\://.*', server):
100 return 'http://' + server
101 return server
102
103
104class Settings(object):
105 def __init__(self):
106 self.default_server = None
107 self.cc = None
108 self.root = None
109 self.is_git_svn = None
110 self.svn_branch = None
111 self.tree_status_url = None
112 self.viewvc_url = None
113 self.updated = False
114
115 def LazyUpdateIfNeeded(self):
116 """Updates the settings from a codereview.settings file, if available."""
117 if not self.updated:
118 cr_settings_file = FindCodereviewSettingsFile()
119 if cr_settings_file:
120 LoadCodereviewSettingsFromFile(cr_settings_file)
121 self.updated = True
122
123 def GetDefaultServerUrl(self, error_ok=False):
124 if not self.default_server:
125 self.LazyUpdateIfNeeded()
126 self.default_server = FixUrl(self._GetConfig('rietveld.server',
127 error_ok=True))
128 if error_ok:
129 return self.default_server
130 if not self.default_server:
131 error_message = ('Could not find settings file. You must configure '
132 'your review setup by running "git cl config".')
133 self.default_server = FixUrl(self._GetConfig(
134 'rietveld.server', error_message=error_message))
135 return self.default_server
136
137 def GetCCList(self):
138 """Return the users cc'd on this CL.
139
140 Return is a string suitable for passing to gcl with the --cc flag.
141 """
142 if self.cc is None:
maruel@chromium.orgb2a7c332011-02-25 20:30:37 +0000143 base_cc = self._GetConfig('rietveld.cc', error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000144 more_cc = self._GetConfig('rietveld.extracc', error_ok=True)
maruel@chromium.orgb2a7c332011-02-25 20:30:37 +0000145 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000146 return self.cc
147
148 def GetRoot(self):
149 if not self.root:
150 self.root = os.path.abspath(RunGit(['rev-parse', '--show-cdup']).strip())
151 return self.root
152
153 def GetIsGitSvn(self):
154 """Return true if this repo looks like it's using git-svn."""
155 if self.is_git_svn is None:
156 # If you have any "svn-remote.*" config keys, we think you're using svn.
157 self.is_git_svn = RunGitWithCode(
158 ['config', '--get-regexp', r'^svn-remote\.'])[0] == 0
159 return self.is_git_svn
160
161 def GetSVNBranch(self):
162 if self.svn_branch is None:
163 if not self.GetIsGitSvn():
164 DieWithError('Repo doesn\'t appear to be a git-svn repo.')
165
166 # Try to figure out which remote branch we're based on.
167 # Strategy:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000168 # 1) iterate through our branch history and find the svn URL.
169 # 2) find the svn-remote that fetches from the URL.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000170
171 # regexp matching the git-svn line that contains the URL.
172 git_svn_re = re.compile(r'^\s*git-svn-id: (\S+)@', re.MULTILINE)
173
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000174 # We don't want to go through all of history, so read a line from the
175 # pipe at a time.
176 # The -100 is an arbitrary limit so we don't search forever.
177 cmd = ['git', 'log', '-100', '--pretty=medium']
178 proc = Popen(cmd, stdout=subprocess.PIPE)
179 for line in proc.stdout:
180 match = git_svn_re.match(line)
181 if match:
182 url = match.group(1)
183 proc.stdout.close() # Cut pipe.
184 break
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000185
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000186 if url:
187 svn_remote_re = re.compile(r'^svn-remote\.([^.]+)\.url (.*)$')
188 remotes = RunGit(['config', '--get-regexp',
189 r'^svn-remote\..*\.url']).splitlines()
190 for remote in remotes:
191 match = svn_remote_re.match(remote)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000192 if match:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000193 remote = match.group(1)
194 base_url = match.group(2)
195 fetch_spec = RunGit(
196 ['config', 'svn-remote.'+remote+'.fetch']).strip().split(':')
197 if fetch_spec[0]:
198 full_url = base_url + '/' + fetch_spec[0]
199 else:
200 full_url = base_url
201 if full_url == url:
202 self.svn_branch = fetch_spec[1]
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000203 break
204
205 if not self.svn_branch:
206 DieWithError('Can\'t guess svn branch -- try specifying it on the '
207 'command line')
208
209 return self.svn_branch
210
211 def GetTreeStatusUrl(self, error_ok=False):
212 if not self.tree_status_url:
213 error_message = ('You must configure your tree status URL by running '
214 '"git cl config".')
215 self.tree_status_url = self._GetConfig('rietveld.tree-status-url',
216 error_ok=error_ok,
217 error_message=error_message)
218 return self.tree_status_url
219
220 def GetViewVCUrl(self):
221 if not self.viewvc_url:
222 self.viewvc_url = self._GetConfig('rietveld.viewvc-url', error_ok=True)
223 return self.viewvc_url
224
225 def _GetConfig(self, param, **kwargs):
226 self.LazyUpdateIfNeeded()
227 return RunGit(['config', param], **kwargs).strip()
228
229
230settings = Settings()
231
232
233did_migrate_check = False
234def CheckForMigration():
235 """Migrate from the old issue format, if found.
236
237 We used to store the branch<->issue mapping in a file in .git, but it's
238 better to store it in the .git/config, since deleting a branch deletes that
239 branch's entry there.
240 """
241
242 # Don't run more than once.
243 global did_migrate_check
244 if did_migrate_check:
245 return
246
247 gitdir = RunGit(['rev-parse', '--git-dir']).strip()
248 storepath = os.path.join(gitdir, 'cl-mapping')
249 if os.path.exists(storepath):
250 print "old-style git-cl mapping file (%s) found; migrating." % storepath
251 store = open(storepath, 'r')
252 for line in store:
253 branch, issue = line.strip().split()
254 RunGit(['config', 'branch.%s.rietveldissue' % ShortBranchName(branch),
255 issue])
256 store.close()
257 os.remove(storepath)
258 did_migrate_check = True
259
260
261def ShortBranchName(branch):
262 """Convert a name like 'refs/heads/foo' to just 'foo'."""
263 return branch.replace('refs/heads/', '')
264
265
266class Changelist(object):
267 def __init__(self, branchref=None):
268 # Poke settings so we get the "configure your server" message if necessary.
269 settings.GetDefaultServerUrl()
270 self.branchref = branchref
271 if self.branchref:
272 self.branch = ShortBranchName(self.branchref)
273 else:
274 self.branch = None
275 self.rietveld_server = None
276 self.upstream_branch = None
277 self.has_issue = False
278 self.issue = None
279 self.has_description = False
280 self.description = None
281 self.has_patchset = False
282 self.patchset = None
283
284 def GetBranch(self):
285 """Returns the short branch name, e.g. 'master'."""
286 if not self.branch:
287 self.branchref = RunGit(['symbolic-ref', 'HEAD']).strip()
288 self.branch = ShortBranchName(self.branchref)
289 return self.branch
290
291 def GetBranchRef(self):
292 """Returns the full branch name, e.g. 'refs/heads/master'."""
293 self.GetBranch() # Poke the lazy loader.
294 return self.branchref
295
296 def FetchUpstreamTuple(self):
297 """Returns a tuple containg remote and remote ref,
298 e.g. 'origin', 'refs/heads/master'
299 """
300 remote = '.'
301 branch = self.GetBranch()
302 upstream_branch = RunGit(['config', 'branch.%s.merge' % branch],
303 error_ok=True).strip()
304 if upstream_branch:
305 remote = RunGit(['config', 'branch.%s.remote' % branch]).strip()
306 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000307 upstream_branch = RunGit(['config', 'rietveld.upstream-branch'],
308 error_ok=True).strip()
309 if upstream_branch:
310 remote = RunGit(['config', 'rietveld.upstream-remote']).strip()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000311 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000312 # Fall back on trying a git-svn upstream branch.
313 if settings.GetIsGitSvn():
314 upstream_branch = settings.GetSVNBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000315 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000316 # Else, try to guess the origin remote.
317 remote_branches = RunGit(['branch', '-r']).split()
318 if 'origin/master' in remote_branches:
319 # Fall back on origin/master if it exits.
320 remote = 'origin'
321 upstream_branch = 'refs/heads/master'
322 elif 'origin/trunk' in remote_branches:
323 # Fall back on origin/trunk if it exists. Generally a shared
324 # git-svn clone
325 remote = 'origin'
326 upstream_branch = 'refs/heads/trunk'
327 else:
328 DieWithError("""Unable to determine default branch to diff against.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000329Either pass complete "git diff"-style arguments, like
330 git cl upload origin/master
331or verify this branch is set up to track another (via the --track argument to
332"git checkout -b ...").""")
333
334 return remote, upstream_branch
335
336 def GetUpstreamBranch(self):
337 if self.upstream_branch is None:
338 remote, upstream_branch = self.FetchUpstreamTuple()
339 if remote is not '.':
340 upstream_branch = upstream_branch.replace('heads', 'remotes/' + remote)
341 self.upstream_branch = upstream_branch
342 return self.upstream_branch
343
344 def GetRemoteUrl(self):
345 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
346
347 Returns None if there is no remote.
348 """
349 remote = self.FetchUpstreamTuple()[0]
350 if remote == '.':
351 return None
352 return RunGit(['config', 'remote.%s.url' % remote], error_ok=True).strip()
353
354 def GetIssue(self):
355 if not self.has_issue:
356 CheckForMigration()
357 issue = RunGit(['config', self._IssueSetting()], error_ok=True).strip()
358 if issue:
359 self.issue = issue
360 self.rietveld_server = FixUrl(RunGit(
361 ['config', self._RietveldServer()], error_ok=True).strip())
362 else:
363 self.issue = None
364 if not self.rietveld_server:
365 self.rietveld_server = settings.GetDefaultServerUrl()
366 self.has_issue = True
367 return self.issue
368
369 def GetRietveldServer(self):
370 self.GetIssue()
371 return self.rietveld_server
372
373 def GetIssueURL(self):
374 """Get the URL for a particular issue."""
375 return '%s/%s' % (self.GetRietveldServer(), self.GetIssue())
376
377 def GetDescription(self, pretty=False):
378 if not self.has_description:
379 if self.GetIssue():
380 path = '/' + self.GetIssue() + '/description'
381 rpc_server = self._RpcServer()
382 self.description = rpc_server.Send(path).strip()
383 self.has_description = True
384 if pretty:
385 wrapper = textwrap.TextWrapper()
386 wrapper.initial_indent = wrapper.subsequent_indent = ' '
387 return wrapper.fill(self.description)
388 return self.description
389
390 def GetPatchset(self):
391 if not self.has_patchset:
392 patchset = RunGit(['config', self._PatchsetSetting()],
393 error_ok=True).strip()
394 if patchset:
395 self.patchset = patchset
396 else:
397 self.patchset = None
398 self.has_patchset = True
399 return self.patchset
400
401 def SetPatchset(self, patchset):
402 """Set this branch's patchset. If patchset=0, clears the patchset."""
403 if patchset:
404 RunGit(['config', self._PatchsetSetting(), str(patchset)])
405 else:
406 RunGit(['config', '--unset', self._PatchsetSetting()],
407 swallow_stderr=True, error_ok=True)
408 self.has_patchset = False
409
410 def SetIssue(self, issue):
411 """Set this branch's issue. If issue=0, clears the issue."""
412 if issue:
413 RunGit(['config', self._IssueSetting(), str(issue)])
414 if self.rietveld_server:
415 RunGit(['config', self._RietveldServer(), self.rietveld_server])
416 else:
417 RunGit(['config', '--unset', self._IssueSetting()])
418 self.SetPatchset(0)
419 self.has_issue = False
420
421 def CloseIssue(self):
422 rpc_server = self._RpcServer()
423 # Newer versions of Rietveld require us to pass an XSRF token to POST, so
424 # we fetch it from the server. (The version used by Chromium has been
425 # modified so the token isn't required when closing an issue.)
426 xsrf_token = rpc_server.Send('/xsrf_token',
427 extra_headers={'X-Requesting-XSRF-Token': '1'})
428
429 # You cannot close an issue with a GET.
430 # We pass an empty string for the data so it is a POST rather than a GET.
431 data = [("description", self.description),
432 ("xsrf_token", xsrf_token)]
433 ctype, body = upload.EncodeMultipartFormData(data, [])
434 rpc_server.Send('/' + self.GetIssue() + '/close', body, ctype)
435
436 def _RpcServer(self):
437 """Returns an upload.RpcServer() to access this review's rietveld instance.
438 """
439 server = self.GetRietveldServer()
440 return upload.GetRpcServer(server, save_cookies=True)
441
442 def _IssueSetting(self):
443 """Return the git setting that stores this change's issue."""
444 return 'branch.%s.rietveldissue' % self.GetBranch()
445
446 def _PatchsetSetting(self):
447 """Return the git setting that stores this change's most recent patchset."""
448 return 'branch.%s.rietveldpatchset' % self.GetBranch()
449
450 def _RietveldServer(self):
451 """Returns the git setting that stores this change's rietveld server."""
452 return 'branch.%s.rietveldserver' % self.GetBranch()
453
454
455def GetCodereviewSettingsInteractively():
456 """Prompt the user for settings."""
457 server = settings.GetDefaultServerUrl(error_ok=True)
458 prompt = 'Rietveld server (host[:port])'
459 prompt += ' [%s]' % (server or DEFAULT_SERVER)
460 newserver = raw_input(prompt + ': ')
461 if not server and not newserver:
462 newserver = DEFAULT_SERVER
463 if newserver and newserver != server:
464 RunGit(['config', 'rietveld.server', newserver])
465
466 def SetProperty(initial, caption, name):
467 prompt = caption
468 if initial:
469 prompt += ' ("x" to clear) [%s]' % initial
470 new_val = raw_input(prompt + ': ')
471 if new_val == 'x':
472 RunGit(['config', '--unset-all', 'rietveld.' + name], error_ok=True)
473 elif new_val and new_val != initial:
474 RunGit(['config', 'rietveld.' + name, new_val])
475
476 SetProperty(settings.GetCCList(), 'CC list', 'cc')
477 SetProperty(settings.GetTreeStatusUrl(error_ok=True), 'Tree status URL',
478 'tree-status-url')
479 SetProperty(settings.GetViewVCUrl(), 'ViewVC URL', 'viewvc-url')
480
481 # TODO: configure a default branch to diff against, rather than this
482 # svn-based hackery.
483
484
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000485class HookResults(object):
486 """Contains the parsed output of the presubmit hooks."""
487 def __init__(self, output_from_hooks=None):
488 self.reviewers = []
489 self.output = None
490 self._ParseOutputFromHooks(output_from_hooks)
491
492 def _ParseOutputFromHooks(self, output_from_hooks):
493 if not output_from_hooks:
494 return
495 lines = []
496 reviewers = []
497 reviewer_regexp = re.compile('ADD: R=(.+)')
498 for l in output_from_hooks.splitlines():
499 m = reviewer_regexp.match(l)
500 if m:
501 reviewers.extend(m.group(1).split(','))
502 else:
503 lines.append(l)
504 self.output = '\n'.join(lines)
505 self.reviewers = ','.join(reviewers)
506
507
508class ChangeDescription(object):
509 """Contains a parsed form of the change description."""
510 def __init__(self, subject, log_desc, reviewers):
511 self.subject = subject
512 self.log_desc = log_desc
513 self.reviewers = reviewers
514 self.description = self.log_desc
515
516 def Update(self):
517 initial_text = """# Enter a description of the change.
518# This will displayed on the codereview site.
519# The first line will also be used as the subject of the review.
520"""
521 initial_text += self.description
522 if 'R=' not in self.description and self.reviewers:
523 initial_text += '\nR=' + self.reviewers
524 if 'BUG=' not in self.description:
525 initial_text += '\nBUG='
526 if 'TEST=' not in self.description:
527 initial_text += '\nTEST='
528 self._ParseDescription(UserEditedLog(initial_text))
529
530 def _ParseDescription(self, description):
531 if not description:
532 self.description = description
533 return
534
535 parsed_lines = []
536 reviewers_regexp = re.compile('\s*R=(.+)')
537 reviewers = ''
538 subject = ''
539 for l in description.splitlines():
540 if not subject:
541 subject = l
542 matched_reviewers = reviewers_regexp.match(l)
543 if matched_reviewers:
544 reviewers = matched_reviewers.group(1)
545 parsed_lines.append(l)
546
547 self.description = '\n'.join(parsed_lines) + '\n'
548 self.subject = subject
549 self.reviewers = reviewers
550
551 def IsEmpty(self):
552 return not self.description
553
554
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000555def FindCodereviewSettingsFile(filename='codereview.settings'):
556 """Finds the given file starting in the cwd and going up.
557
558 Only looks up to the top of the repository unless an
559 'inherit-review-settings-ok' file exists in the root of the repository.
560 """
561 inherit_ok_file = 'inherit-review-settings-ok'
562 cwd = os.getcwd()
563 root = os.path.abspath(RunGit(['rev-parse', '--show-cdup']).strip())
564 if os.path.isfile(os.path.join(root, inherit_ok_file)):
565 root = '/'
566 while True:
567 if filename in os.listdir(cwd):
568 if os.path.isfile(os.path.join(cwd, filename)):
569 return open(os.path.join(cwd, filename))
570 if cwd == root:
571 break
572 cwd = os.path.dirname(cwd)
573
574
575def LoadCodereviewSettingsFromFile(fileobj):
576 """Parse a codereview.settings file and updates hooks."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000577 keyvals = {}
578 for line in fileobj.read().splitlines():
579 if not line or line.startswith("#"):
580 continue
581 k, v = line.split(": ", 1)
582 keyvals[k] = v
583
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000584 def SetProperty(name, setting, unset_error_ok=False):
585 fullname = 'rietveld.' + name
586 if setting in keyvals:
587 RunGit(['config', fullname, keyvals[setting]])
588 else:
589 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
590
591 SetProperty('server', 'CODE_REVIEW_SERVER')
592 # Only server setting is required. Other settings can be absent.
593 # In that case, we ignore errors raised during option deletion attempt.
594 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
595 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
596 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
597
598 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
599 #should be of the form
600 #PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
601 #ORIGIN_URL_CONFIG: http://src.chromium.org/git
602 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
603 keyvals['ORIGIN_URL_CONFIG']])
604
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000605
606@usage('[repo root containing codereview.settings]')
607def CMDconfig(parser, args):
608 """edit configuration for this tree"""
609
610 (options, args) = parser.parse_args(args)
611 if len(args) == 0:
612 GetCodereviewSettingsInteractively()
613 return 0
614
615 url = args[0]
616 if not url.endswith('codereview.settings'):
617 url = os.path.join(url, 'codereview.settings')
618
619 # Load code review settings and download hooks (if available).
620 LoadCodereviewSettingsFromFile(urllib2.urlopen(url))
621 return 0
622
623
624def CMDstatus(parser, args):
625 """show status of changelists"""
626 parser.add_option('--field',
627 help='print only specific field (desc|id|patch|url)')
628 (options, args) = parser.parse_args(args)
629
630 # TODO: maybe make show_branches a flag if necessary.
631 show_branches = not options.field
632
633 if show_branches:
634 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
635 if branches:
636 print 'Branches associated with reviews:'
637 for branch in sorted(branches.splitlines()):
638 cl = Changelist(branchref=branch)
639 print " %10s: %s" % (cl.GetBranch(), cl.GetIssue())
640
641 cl = Changelist()
642 if options.field:
643 if options.field.startswith('desc'):
644 print cl.GetDescription()
645 elif options.field == 'id':
646 issueid = cl.GetIssue()
647 if issueid:
648 print issueid
649 elif options.field == 'patch':
650 patchset = cl.GetPatchset()
651 if patchset:
652 print patchset
653 elif options.field == 'url':
654 url = cl.GetIssueURL()
655 if url:
656 print url
657 else:
658 print
659 print 'Current branch:',
660 if not cl.GetIssue():
661 print 'no issue assigned.'
662 return 0
663 print cl.GetBranch()
664 print 'Issue number:', cl.GetIssue(), '(%s)' % cl.GetIssueURL()
665 print 'Issue description:'
666 print cl.GetDescription(pretty=True)
667 return 0
668
669
670@usage('[issue_number]')
671def CMDissue(parser, args):
672 """Set or display the current code review issue number.
673
674 Pass issue number 0 to clear the current issue.
675"""
676 (options, args) = parser.parse_args(args)
677
678 cl = Changelist()
679 if len(args) > 0:
680 try:
681 issue = int(args[0])
682 except ValueError:
683 DieWithError('Pass a number to set the issue or none to list it.\n'
684 'Maybe you want to run git cl status?')
685 cl.SetIssue(issue)
686 print 'Issue number:', cl.GetIssue(), '(%s)' % cl.GetIssueURL()
687 return 0
688
689
690def CreateDescriptionFromLog(args):
691 """Pulls out the commit log to use as a base for the CL description."""
692 log_args = []
693 if len(args) == 1 and not args[0].endswith('.'):
694 log_args = [args[0] + '..']
695 elif len(args) == 1 and args[0].endswith('...'):
696 log_args = [args[0][:-1]]
697 elif len(args) == 2:
698 log_args = [args[0] + '..' + args[1]]
699 else:
700 log_args = args[:] # Hope for the best!
701 return RunGit(['log', '--pretty=format:%s\n\n%b'] + log_args)
702
703
704def UserEditedLog(starting_text):
705 """Given some starting text, let the user edit it and return the result."""
706 editor = os.getenv('EDITOR', 'vi')
707
708 (file_handle, filename) = tempfile.mkstemp()
709 fileobj = os.fdopen(file_handle, 'w')
710 fileobj.write(starting_text)
711 fileobj.close()
712
713 ret = subprocess.call(editor + ' ' + filename, shell=True)
714 if ret != 0:
715 os.remove(filename)
716 return
717
718 fileobj = open(filename)
719 text = fileobj.read()
720 fileobj.close()
721 os.remove(filename)
722 stripcomment_re = re.compile(r'^#.*$', re.MULTILINE)
723 return stripcomment_re.sub('', text).strip()
724
725
dpranke@chromium.org23beb9e2011-03-11 23:20:54 +0000726def ConvertToInteger(inputval):
727 """Convert a string to integer, but returns either an int or None."""
728 try:
729 return int(inputval)
730 except (TypeError, ValueError):
731 return None
732
733
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000734def RunHook(committing, upstream_branch, rietveld_server, tbr, may_prompt):
735 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
dpranke@chromium.org23beb9e2011-03-11 23:20:54 +0000736 import presubmit_support
737 import scm
738 import watchlists
739
740 root = RunCommand(['git', 'rev-parse', '--show-cdup']).strip()
741 if not root:
742 root = "."
743 absroot = os.path.abspath(root)
744 if not root:
745 raise Exception("Could not get root directory.")
746
747 # We use the sha1 of HEAD as a name of this change.
748 name = RunCommand(['git', 'rev-parse', 'HEAD']).strip()
749 files = scm.GIT.CaptureStatus([root], upstream_branch)
750
751 cl = Changelist()
752 issue = ConvertToInteger(cl.GetIssue())
753 patchset = ConvertToInteger(cl.GetPatchset())
754 if issue:
755 description = cl.GetDescription()
756 else:
757 # If the change was never uploaded, use the log messages of all commits
758 # up to the branch point, as git cl upload will prefill the description
759 # with these log messages.
760 description = RunCommand(['git', 'log', '--pretty=format:%s%n%n%b',
761 '%s...' % (upstream_branch)]).strip()
762 change = presubmit_support.GitChange(name, description, absroot, files,
763 issue, patchset)
764
765 # Apply watchlists on upload.
766 if not committing:
767 watchlist = watchlists.Watchlists(change.RepositoryRoot())
768 files = [f.LocalPath() for f in change.AffectedFiles()]
769 watchers = watchlist.GetWatchersForPaths(files)
770 RunCommand(['git', 'config', '--replace-all',
771 'rietveld.extracc', ','.join(watchers)])
772
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000773 output = StringIO.StringIO()
774 res = presubmit_support.DoPresubmitChecks(change, committing,
775 verbose=None, output_stream=output, input_stream=sys.stdin,
776 default_presubmit=None, may_prompt=may_prompt, tbr=tbr,
777 host_url=cl.GetRietveldServer())
778 hook_results = HookResults(output.getvalue())
779 if hook_results.output:
780 print hook_results.output
781
782 # TODO(dpranke): We should propagate the error out instead of calling exit().
783 if not res:
784 sys.exit(1)
785 return hook_results
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000786
787
788def CMDpresubmit(parser, args):
789 """run presubmit tests on the current changelist"""
790 parser.add_option('--upload', action='store_true',
791 help='Run upload hook instead of the push/dcommit hook')
792 (options, args) = parser.parse_args(args)
793
794 # Make sure index is up-to-date before running diff-index.
795 RunGit(['update-index', '--refresh', '-q'], error_ok=True)
796 if RunGit(['diff-index', 'HEAD']):
797 # TODO(maruel): Is this really necessary?
798 print 'Cannot presubmit with a dirty tree. You must commit locally first.'
799 return 1
800
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000801 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000802 if args:
803 base_branch = args[0]
804 else:
805 # Default to diffing against the "upstream" branch.
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000806 base_branch = cl.GetUpstreamBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000807
808 if options.upload:
809 print '*** Presubmit checks for UPLOAD would report: ***'
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000810 RunHook(committing=False, upstream_branch=base_branch,
811 rietveld_server=cl.GetRietveldServer(), tbr=False,
812 may_prompt=False)
813 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000814 else:
815 print '*** Presubmit checks for DCOMMIT would report: ***'
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000816 RunHook(committing=True, upstream_branch=base_branch,
817 rietveld_server=cl.GetRietveldServer, tbr=False,
818 may_prompt=False)
819 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000820
821
822@usage('[args to "git diff"]')
823def CMDupload(parser, args):
824 """upload the current changelist to codereview"""
825 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
826 help='bypass upload presubmit hook')
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000827 parser.add_option('-f', action='store_true', dest='force',
828 help="force yes to questions (don't prompt)")
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000829 parser.add_option('-m', dest='message', help='message for patch')
830 parser.add_option('-r', '--reviewers',
831 help='reviewer email addresses')
maruel@chromium.orgb2a7c332011-02-25 20:30:37 +0000832 parser.add_option('--cc',
833 help='cc email addresses')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000834 parser.add_option('--send-mail', action='store_true',
835 help='send email to reviewer immediately')
836 parser.add_option("--emulate_svn_auto_props", action="store_true",
837 dest="emulate_svn_auto_props",
838 help="Emulate Subversion's auto properties feature.")
839 parser.add_option("--desc_from_logs", action="store_true",
840 dest="from_logs",
841 help="""Squashes git commit logs into change description and
842 uses message as subject""")
843 (options, args) = parser.parse_args(args)
844
845 # Make sure index is up-to-date before running diff-index.
846 RunGit(['update-index', '--refresh', '-q'], error_ok=True)
847 if RunGit(['diff-index', 'HEAD']):
848 print 'Cannot upload with a dirty tree. You must commit locally first.'
849 return 1
850
851 cl = Changelist()
852 if args:
853 base_branch = args[0]
854 else:
855 # Default to diffing against the "upstream" branch.
856 base_branch = cl.GetUpstreamBranch()
857 args = [base_branch + "..."]
858
859 if not options.bypass_hooks:
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000860 hook_results = RunHook(committing=False, upstream_branch=base_branch,
861 rietveld_server=cl.GetRietveldServer(), tbr=False,
862 may_prompt=(not options.force))
863 else:
864 hook_results = HookResults()
865
866 if not options.reviewers and hook_results.reviewers:
867 options.reviewers = hook_results.reviewers
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000868
869 # --no-ext-diff is broken in some versions of Git, so try to work around
870 # this by overriding the environment (but there is still a problem if the
871 # git config key "diff.external" is used).
872 env = os.environ.copy()
873 if 'GIT_EXTERNAL_DIFF' in env:
874 del env['GIT_EXTERNAL_DIFF']
875 subprocess.call(['git', 'diff', '--no-ext-diff', '--stat', '-M'] + args,
876 env=env)
877
878 upload_args = ['--assume_yes'] # Don't ask about untracked files.
879 upload_args.extend(['--server', cl.GetRietveldServer()])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000880 if options.emulate_svn_auto_props:
881 upload_args.append('--emulate_svn_auto_props')
882 if options.send_mail:
883 if not options.reviewers:
884 DieWithError("Must specify reviewers to send email.")
885 upload_args.append('--send_mail')
886 if options.from_logs and not options.message:
887 print 'Must set message for subject line if using desc_from_logs'
888 return 1
889
890 change_desc = None
891
892 if cl.GetIssue():
893 if options.message:
894 upload_args.extend(['--message', options.message])
895 upload_args.extend(['--issue', cl.GetIssue()])
896 print ("This branch is associated with issue %s. "
897 "Adding patch to that issue." % cl.GetIssue())
898 else:
899 log_desc = CreateDescriptionFromLog(args)
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000900 change_desc = ChangeDescription(options.message, log_desc,
901 options.reviewers)
902 if not options.from_logs:
903 change_desc.Update()
904
905 if change_desc.IsEmpty():
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000906 print "Description is empty; aborting."
907 return 1
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000908
909 upload_args.extend(['--message', change_desc.subject])
910 upload_args.extend(['--description', change_desc.description])
911 if change_desc.reviewers:
912 upload_args.extend(['--reviewers', change_desc.reviewers])
maruel@chromium.orgb2a7c332011-02-25 20:30:37 +0000913 cc = ','.join(filter(None, (settings.GetCCList(), options.cc)))
914 if cc:
915 upload_args.extend(['--cc', cc])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000916
917 # Include the upstream repo's URL in the change -- this is useful for
918 # projects that have their source spread across multiple repos.
919 remote_url = None
920 if settings.GetIsGitSvn():
maruel@chromium.orgb92e4802011-03-03 20:22:00 +0000921 # URL is dependent on the current directory.
922 data = RunGit(['svn', 'info'], cwd=settings.GetRoot())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000923 if data:
924 keys = dict(line.split(': ', 1) for line in data.splitlines()
925 if ': ' in line)
926 remote_url = keys.get('URL', None)
927 else:
928 if cl.GetRemoteUrl() and '/' in cl.GetUpstreamBranch():
929 remote_url = (cl.GetRemoteUrl() + '@'
930 + cl.GetUpstreamBranch().split('/')[-1])
931 if remote_url:
932 upload_args.extend(['--base_url', remote_url])
933
934 try:
935 issue, patchset = upload.RealMain(['upload'] + upload_args + args)
936 except:
937 # If we got an exception after the user typed a description for their
938 # change, back up the description before re-raising.
939 if change_desc:
940 backup_path = os.path.expanduser(DESCRIPTION_BACKUP_FILE)
941 print '\nGot exception while uploading -- saving description to %s\n' \
942 % backup_path
943 backup_file = open(backup_path, 'w')
dpranke@chromium.org970c5222011-03-12 00:32:24 +0000944 backup_file.write(change_desc.description)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000945 backup_file.close()
946 raise
947
948 if not cl.GetIssue():
949 cl.SetIssue(issue)
950 cl.SetPatchset(patchset)
951 return 0
952
953
954def SendUpstream(parser, args, cmd):
955 """Common code for CmdPush and CmdDCommit
956
957 Squashed commit into a single.
958 Updates changelog with metadata (e.g. pointer to review).
959 Pushes/dcommits the code upstream.
960 Updates review and closes.
961 """
962 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
963 help='bypass upload presubmit hook')
964 parser.add_option('-m', dest='message',
965 help="override review description")
966 parser.add_option('-f', action='store_true', dest='force',
967 help="force yes to questions (don't prompt)")
968 parser.add_option('-c', dest='contributor',
969 help="external contributor for patch (appended to " +
970 "description and used as author for git). Should be " +
971 "formatted as 'First Last <email@example.com>'")
972 parser.add_option('--tbr', action='store_true', dest='tbr',
973 help="short for 'to be reviewed', commit branch " +
974 "even without uploading for review")
975 (options, args) = parser.parse_args(args)
976 cl = Changelist()
977
978 if not args or cmd == 'push':
979 # Default to merging against our best guess of the upstream branch.
980 args = [cl.GetUpstreamBranch()]
981
982 base_branch = args[0]
983
chase@chromium.orgc76e6752011-01-10 18:17:12 +0000984 # Make sure index is up-to-date before running diff-index.
985 RunGit(['update-index', '--refresh', '-q'], error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000986 if RunGit(['diff-index', 'HEAD']):
987 print 'Cannot %s with a dirty tree. You must commit locally first.' % cmd
988 return 1
989
990 # This rev-list syntax means "show all commits not in my branch that
991 # are in base_branch".
992 upstream_commits = RunGit(['rev-list', '^' + cl.GetBranchRef(),
993 base_branch]).splitlines()
994 if upstream_commits:
995 print ('Base branch "%s" has %d commits '
996 'not in this branch.' % (base_branch, len(upstream_commits)))
997 print 'Run "git merge %s" before attempting to %s.' % (base_branch, cmd)
998 return 1
999
1000 if cmd == 'dcommit':
1001 # This is the revision `svn dcommit` will commit on top of.
1002 svn_head = RunGit(['log', '--grep=^git-svn-id:', '-1',
1003 '--pretty=format:%H'])
1004 extra_commits = RunGit(['rev-list', '^' + svn_head, base_branch])
1005 if extra_commits:
1006 print ('This branch has %d additional commits not upstreamed yet.'
1007 % len(extra_commits.splitlines()))
1008 print ('Upstream "%s" or rebase this branch on top of the upstream trunk '
1009 'before attempting to %s.' % (base_branch, cmd))
1010 return 1
1011
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001012 if not options.bypass_hooks:
1013 RunHook(committing=True, upstream_branch=base_branch,
1014 rietveld_server=cl.GetRietveldServer(), tbr=options.tbr,
1015 may_prompt=(not options.force))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001016
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001017 if not options.force and not options.bypass_hooks:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001018 if cmd == 'dcommit':
1019 # Check the tree status if the tree status URL is set.
1020 status = GetTreeStatus()
1021 if 'closed' == status:
1022 print ('The tree is closed. Please wait for it to reopen. Use '
1023 '"git cl dcommit -f" to commit on a closed tree.')
1024 return 1
1025 elif 'unknown' == status:
1026 print ('Unable to determine tree status. Please verify manually and '
1027 'use "git cl dcommit -f" to commit on a closed tree.')
1028
1029 description = options.message
1030 if not options.tbr:
1031 # It is important to have these checks early. Not only for user
1032 # convenience, but also because the cl object then caches the correct values
1033 # of these fields even as we're juggling branches for setting up the commit.
1034 if not cl.GetIssue():
1035 print 'Current issue unknown -- has this branch been uploaded?'
1036 print 'Use --tbr to commit without review.'
1037 return 1
1038
1039 if not description:
1040 description = cl.GetDescription()
1041
1042 if not description:
1043 print 'No description set.'
1044 print 'Visit %s/edit to set it.' % (cl.GetIssueURL())
1045 return 1
1046
1047 description += "\n\nReview URL: %s" % cl.GetIssueURL()
1048 else:
1049 if not description:
1050 # Submitting TBR. See if there's already a description in Rietveld, else
1051 # create a template description. Eitherway, give the user a chance to edit
1052 # it to fill in the TBR= field.
1053 if cl.GetIssue():
1054 description = cl.GetDescription()
1055
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001056 # TODO(dpranke): Update to use ChangeDescription object.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001057 if not description:
1058 description = """# Enter a description of the change.
1059# This will be used as the change log for the commit.
1060
1061"""
1062 description += CreateDescriptionFromLog(args)
1063
1064 description = UserEditedLog(description + '\nTBR=')
1065
1066 if not description:
1067 print "Description empty; aborting."
1068 return 1
1069
1070 if options.contributor:
1071 if not re.match('^.*\s<\S+@\S+>$', options.contributor):
1072 print "Please provide contibutor as 'First Last <email@example.com>'"
1073 return 1
1074 description += "\nPatch from %s." % options.contributor
1075 print 'Description:', repr(description)
1076
1077 branches = [base_branch, cl.GetBranchRef()]
1078 if not options.force:
1079 subprocess.call(['git', 'diff', '--stat'] + branches)
1080 raw_input("About to commit; enter to confirm.")
1081
1082 # We want to squash all this branch's commits into one commit with the
1083 # proper description.
bauerb@chromium.orgb4a75c42011-03-08 08:35:38 +00001084 # We do this by doing a "reset --soft" to the base branch (which keeps
1085 # the working copy the same), then dcommitting that.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001086 MERGE_BRANCH = 'git-cl-commit'
1087 # Delete the merge branch if it already exists.
1088 if RunGitWithCode(['show-ref', '--quiet', '--verify',
1089 'refs/heads/' + MERGE_BRANCH])[0] == 0:
1090 RunGit(['branch', '-D', MERGE_BRANCH])
1091
1092 # We might be in a directory that's present in this branch but not in the
1093 # trunk. Move up to the top of the tree so that git commands that expect a
1094 # valid CWD won't fail after we check out the merge branch.
1095 rel_base_path = RunGit(['rev-parse', '--show-cdup']).strip()
1096 if rel_base_path:
1097 os.chdir(rel_base_path)
1098
1099 # Stuff our change into the merge branch.
1100 # We wrap in a try...finally block so if anything goes wrong,
1101 # we clean up the branches.
maruel@chromium.org0ba7f962011-01-11 22:13:58 +00001102 retcode = -1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001103 try:
bauerb@chromium.orgb4a75c42011-03-08 08:35:38 +00001104 RunGit(['checkout', '-q', '-b', MERGE_BRANCH])
1105 RunGit(['reset', '--soft', base_branch])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001106 if options.contributor:
1107 RunGit(['commit', '--author', options.contributor, '-m', description])
1108 else:
1109 RunGit(['commit', '-m', description])
1110 if cmd == 'push':
1111 # push the merge branch.
1112 remote, branch = cl.FetchUpstreamTuple()
1113 retcode, output = RunGitWithCode(
1114 ['push', '--porcelain', remote, 'HEAD:%s' % branch])
1115 logging.debug(output)
1116 else:
1117 # dcommit the merge branch.
maruel@chromium.org0ba7f962011-01-11 22:13:58 +00001118 retcode, output = RunGitWithCode(['svn', 'dcommit', '--no-rebase'])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001119 finally:
1120 # And then swap back to the original branch and clean up.
1121 RunGit(['checkout', '-q', cl.GetBranch()])
1122 RunGit(['branch', '-D', MERGE_BRANCH])
1123
1124 if cl.GetIssue():
1125 if cmd == 'dcommit' and 'Committed r' in output:
1126 revision = re.match('.*?\nCommitted r(\\d+)', output, re.DOTALL).group(1)
1127 elif cmd == 'push' and retcode == 0:
maruel@chromium.orgdf947ea2011-01-12 20:44:54 +00001128 match = (re.match(r'.*?([a-f0-9]{7})\.\.([a-f0-9]{7})$', l)
1129 for l in output.splitlines(False))
1130 match = filter(None, match)
1131 if len(match) != 1:
1132 DieWithError("Couldn't parse ouput to extract the committed hash:\n%s" %
1133 output)
1134 revision = match[0].group(2)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001135 else:
1136 return 1
1137 viewvc_url = settings.GetViewVCUrl()
1138 if viewvc_url and revision:
1139 cl.description += ('\n\nCommitted: ' + viewvc_url + revision)
1140 print ('Closing issue '
1141 '(you may be prompted for your codereview password)...')
1142 cl.CloseIssue()
1143 cl.SetIssue(0)
maruel@chromium.org0ba7f962011-01-11 22:13:58 +00001144
1145 if retcode == 0:
1146 hook = POSTUPSTREAM_HOOK_PATTERN % cmd
1147 if os.path.isfile(hook):
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001148 RunCommand([hook, base_branch], error_ok=True)
maruel@chromium.org0ba7f962011-01-11 22:13:58 +00001149
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001150 return 0
1151
1152
1153@usage('[upstream branch to apply against]')
1154def CMDdcommit(parser, args):
1155 """commit the current changelist via git-svn"""
1156 if not settings.GetIsGitSvn():
thakis@chromium.orgcde3bb62011-01-20 01:16:14 +00001157 message = """This doesn't appear to be an SVN repository.
1158If your project has a git mirror with an upstream SVN master, you probably need
1159to run 'git svn init', see your project's git mirror documentation.
1160If your project has a true writeable upstream repository, you probably want
1161to run 'git cl push' instead.
1162Choose wisely, if you get this wrong, your commit might appear to succeed but
1163will instead be silently ignored."""
1164 print(message)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001165 raw_input('[Press enter to dcommit or ctrl-C to quit]')
1166 return SendUpstream(parser, args, 'dcommit')
1167
1168
1169@usage('[upstream branch to apply against]')
1170def CMDpush(parser, args):
1171 """commit the current changelist via git"""
1172 if settings.GetIsGitSvn():
1173 print('This appears to be an SVN repository.')
1174 print('Are you sure you didn\'t mean \'git cl dcommit\'?')
1175 raw_input('[Press enter to push or ctrl-C to quit]')
1176 return SendUpstream(parser, args, 'push')
1177
1178
1179@usage('<patch url or issue id>')
1180def CMDpatch(parser, args):
1181 """patch in a code review"""
1182 parser.add_option('-b', dest='newbranch',
1183 help='create a new branch off trunk for the patch')
1184 parser.add_option('-f', action='store_true', dest='force',
1185 help='with -b, clobber any existing branch')
1186 parser.add_option('--reject', action='store_true', dest='reject',
1187 help='allow failed patches and spew .rej files')
1188 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
1189 help="don't commit after patch applies")
1190 (options, args) = parser.parse_args(args)
1191 if len(args) != 1:
1192 parser.print_help()
1193 return 1
1194 input = args[0]
1195
1196 if re.match(r'\d+', input):
1197 # Input is an issue id. Figure out the URL.
1198 issue = input
1199 server = settings.GetDefaultServerUrl()
1200 fetch = urllib2.urlopen('%s/%s' % (server, issue)).read()
1201 m = re.search(r'/download/issue[0-9]+_[0-9]+.diff', fetch)
1202 if not m:
1203 DieWithError('Must pass an issue ID or full URL for '
1204 '\'Download raw patch set\'')
1205 url = '%s%s' % (server, m.group(0).strip())
1206 else:
1207 # Assume it's a URL to the patch. Default to http.
1208 input = FixUrl(input)
1209 match = re.match(r'.*?/issue(\d+)_\d+.diff', input)
1210 if match:
1211 issue = match.group(1)
1212 url = input
1213 else:
1214 DieWithError('Must pass an issue ID or full URL for '
1215 '\'Download raw patch set\'')
1216
1217 if options.newbranch:
1218 if options.force:
1219 RunGit(['branch', '-D', options.newbranch],
1220 swallow_stderr=True, error_ok=True)
1221 RunGit(['checkout', '-b', options.newbranch,
1222 Changelist().GetUpstreamBranch()])
1223
1224 # Switch up to the top-level directory, if necessary, in preparation for
1225 # applying the patch.
1226 top = RunGit(['rev-parse', '--show-cdup']).strip()
1227 if top:
1228 os.chdir(top)
1229
1230 patch_data = urllib2.urlopen(url).read()
1231 # Git patches have a/ at the beginning of source paths. We strip that out
1232 # with a sed script rather than the -p flag to patch so we can feed either
1233 # Git or svn-style patches into the same apply command.
1234 # re.sub() should be used but flags=re.MULTILINE is only in python 2.7.
1235 sed_proc = Popen(['sed', '-e', 's|^--- a/|--- |; s|^+++ b/|+++ |'],
1236 stdin=subprocess.PIPE, stdout=subprocess.PIPE)
1237 patch_data = sed_proc.communicate(patch_data)[0]
1238 if sed_proc.returncode:
1239 DieWithError('Git patch mungling failed.')
1240 logging.info(patch_data)
1241 # We use "git apply" to apply the patch instead of "patch" so that we can
1242 # pick up file adds.
1243 # The --index flag means: also insert into the index (so we catch adds).
1244 cmd = ['git', 'apply', '--index', '-p0']
1245 if options.reject:
1246 cmd.append('--reject')
1247 patch_proc = Popen(cmd, stdin=subprocess.PIPE)
1248 patch_proc.communicate(patch_data)
1249 if patch_proc.returncode:
1250 DieWithError('Failed to apply the patch')
1251
1252 # If we had an issue, commit the current state and register the issue.
1253 if not options.nocommit:
1254 RunGit(['commit', '-m', 'patch from issue %s' % issue])
1255 cl = Changelist()
1256 cl.SetIssue(issue)
1257 print "Committed patch."
1258 else:
1259 print "Patch applied to index."
1260 return 0
1261
1262
1263def CMDrebase(parser, args):
1264 """rebase current branch on top of svn repo"""
1265 # Provide a wrapper for git svn rebase to help avoid accidental
1266 # git svn dcommit.
1267 # It's the only command that doesn't use parser at all since we just defer
1268 # execution to git-svn.
1269 RunGit(['svn', 'rebase'] + args, redirect_stdout=False)
1270 return 0
1271
1272
1273def GetTreeStatus():
1274 """Fetches the tree status and returns either 'open', 'closed',
1275 'unknown' or 'unset'."""
1276 url = settings.GetTreeStatusUrl(error_ok=True)
1277 if url:
1278 status = urllib2.urlopen(url).read().lower()
1279 if status.find('closed') != -1 or status == '0':
1280 return 'closed'
1281 elif status.find('open') != -1 or status == '1':
1282 return 'open'
1283 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001284 return 'unset'
1285
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001286
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001287def GetTreeStatusReason():
1288 """Fetches the tree status from a json url and returns the message
1289 with the reason for the tree to be opened or closed."""
1290 # Don't import it at file level since simplejson is not installed by default
1291 # on python 2.5 and it is only used for git-cl tree which isn't often used,
1292 # forcing everyone to install simplejson isn't efficient.
1293 try:
1294 import simplejson as json
1295 except ImportError:
1296 try:
1297 import json
1298 # Some versions of python2.5 have an incomplete json module. Check to make
1299 # sure loads exists.
1300 json.loads
1301 except (ImportError, AttributeError):
1302 print >> sys.stderr, 'Please install simplejson'
1303 sys.exit(1)
1304
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00001305 url = settings.GetTreeStatusUrl()
1306 json_url = urlparse.urljoin(url, '/current?format=json')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001307 connection = urllib2.urlopen(json_url)
1308 status = json.loads(connection.read())
1309 connection.close()
1310 return status['message']
1311
dpranke@chromium.org970c5222011-03-12 00:32:24 +00001312
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001313def CMDtree(parser, args):
1314 """show the status of the tree"""
1315 (options, args) = parser.parse_args(args)
1316 status = GetTreeStatus()
1317 if 'unset' == status:
1318 print 'You must configure your tree status URL by running "git cl config".'
1319 return 2
1320
1321 print "The tree is %s" % status
1322 print
1323 print GetTreeStatusReason()
1324 if status != 'open':
1325 return 1
1326 return 0
1327
1328
1329def CMDupstream(parser, args):
1330 """print the name of the upstream branch, if any"""
1331 (options, args) = parser.parse_args(args)
1332 cl = Changelist()
1333 print cl.GetUpstreamBranch()
1334 return 0
1335
1336
1337def Command(name):
1338 return getattr(sys.modules[__name__], 'CMD' + name, None)
1339
1340
1341def CMDhelp(parser, args):
1342 """print list of commands or help for a specific command"""
1343 (options, args) = parser.parse_args(args)
1344 if len(args) == 1:
1345 return main(args + ['--help'])
1346 parser.print_help()
1347 return 0
1348
1349
1350def GenUsage(parser, command):
1351 """Modify an OptParse object with the function's documentation."""
1352 obj = Command(command)
1353 more = getattr(obj, 'usage_more', '')
1354 if command == 'help':
1355 command = '<command>'
1356 else:
1357 # OptParser.description prefer nicely non-formatted strings.
1358 parser.description = re.sub('[\r\n ]{2,}', ' ', obj.__doc__)
1359 parser.set_usage('usage: %%prog %s [options] %s' % (command, more))
1360
1361
1362def main(argv):
1363 """Doesn't parse the arguments here, just find the right subcommand to
1364 execute."""
1365 # Do it late so all commands are listed.
1366 CMDhelp.usage_more = ('\n\nCommands are:\n' + '\n'.join([
1367 ' %-10s %s' % (fn[3:], Command(fn[3:]).__doc__.split('\n')[0].strip())
1368 for fn in dir(sys.modules[__name__]) if fn.startswith('CMD')]))
1369
1370 # Create the option parse and add --verbose support.
1371 parser = optparse.OptionParser()
1372 parser.add_option('-v', '--verbose', action='store_true')
1373 old_parser_args = parser.parse_args
1374 def Parse(args):
1375 options, args = old_parser_args(args)
1376 if options.verbose:
1377 logging.basicConfig(level=logging.DEBUG)
1378 else:
1379 logging.basicConfig(level=logging.WARNING)
1380 return options, args
1381 parser.parse_args = Parse
1382
1383 if argv:
1384 command = Command(argv[0])
1385 if command:
1386 # "fix" the usage and the description now that we know the subcommand.
1387 GenUsage(parser, argv[0])
1388 try:
1389 return command(parser, argv[1:])
1390 except urllib2.HTTPError, e:
1391 if e.code != 500:
1392 raise
1393 DieWithError(
1394 ('AppEngine is misbehaving and returned HTTP %d, again. Keep faith '
1395 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
1396
1397 # Not a known command. Default to help.
1398 GenUsage(parser, 'help')
1399 return CMDhelp(parser, argv)
1400
1401
1402if __name__ == '__main__':
1403 sys.exit(main(sys.argv[1:]))