blob: 73ce7b18660cb702d3c1853d170d2d9c8c917123 [file] [log] [blame]
iannucci@chromium.org405b87e2015-11-12 18:08:34 +00001#!/usr/bin/env python
miket@chromium.org183df1a2012-01-04 19:44:55 +00002# Copyright (c) 2012 The Chromium Authors. All rights reserved.
maruel@chromium.org725f1c32011-04-01 20:24:54 +00003# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00006# Copyright (C) 2008 Evan Martin <martine@danga.com>
7
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00008"""A git-command for integrating reviews on Rietveld and Gerrit."""
maruel@chromium.org725f1c32011-04-01 20:24:54 +00009
vapiera7fbd5a2016-06-16 09:17:49 -070010from __future__ import print_function
11
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +000012from distutils.version import LooseVersion
calamity@chromium.orgffde55c2015-03-12 00:44:17 +000013from multiprocessing.pool import ThreadPool
thakis@chromium.org3421c992014-11-02 02:20:32 +000014import base64
rmistry@google.com2dd99862015-06-22 12:22:18 +000015import collections
sheyang@google.com6ebaf782015-05-12 19:17:54 +000016import httplib
maruel@chromium.org4f6852c2012-04-20 20:39:20 +000017import json
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000018import logging
calamity@chromium.orgcf197482016-04-29 20:15:53 +000019import multiprocessing
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000020import optparse
21import os
22import re
ukai@chromium.org78c4b982012-02-14 02:20:26 +000023import stat
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000024import sys
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000025import textwrap
sheyang@google.com6ebaf782015-05-12 19:17:54 +000026import traceback
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000027import urllib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000028import urllib2
maruel@chromium.org967c0a82013-06-17 22:52:24 +000029import urlparse
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000030import uuid
thestig@chromium.org00858c82013-12-02 23:08:03 +000031import webbrowser
thakis@chromium.org3421c992014-11-02 02:20:32 +000032import zlib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000033
34try:
maruel@chromium.orgc98c0c52011-04-06 13:39:43 +000035 import readline # pylint: disable=F0401,W0611
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000036except ImportError:
37 pass
38
maruel@chromium.org2e23ce32013-05-07 12:42:28 +000039from third_party import colorama
sheyang@google.com6ebaf782015-05-12 19:17:54 +000040from third_party import httplib2
maruel@chromium.org2a74d372011-03-29 19:05:50 +000041from third_party import upload
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000042import auth
skobes6468b902016-10-24 08:45:10 -070043import checkout
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +000044import clang_format
tandrii@chromium.org71184c02016-01-13 15:18:44 +000045import commit_queue
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +000046import dart_format
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +000047import setup_color
maruel@chromium.org6f09cd92011-04-01 16:38:12 +000048import fix_encoding
maruel@chromium.org0e0436a2011-10-25 13:32:41 +000049import gclient_utils
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +000050import gerrit_util
szager@chromium.org151ebcf2016-03-09 01:08:25 +000051import git_cache
iannucci@chromium.org9e849272014-04-04 00:31:55 +000052import git_common
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +000053import git_footers
piman@chromium.org336f9122014-09-04 02:16:55 +000054import owners
iannucci@chromium.org9e849272014-04-04 00:31:55 +000055import owners_finder
maruel@chromium.org2a74d372011-03-29 19:05:50 +000056import presubmit_support
maruel@chromium.orgcab38e92011-04-09 00:30:51 +000057import rietveld
maruel@chromium.org2a74d372011-03-29 19:05:50 +000058import scm
maruel@chromium.org0633fb42013-08-16 20:06:14 +000059import subcommand
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +000060import subprocess2
maruel@chromium.org2a74d372011-03-29 19:05:50 +000061import watchlists
62
tandrii7400cf02016-06-21 08:48:07 -070063__version__ = '2.0'
maruel@chromium.org2a74d372011-03-29 19:05:50 +000064
tandrii9d2c7a32016-06-22 03:42:45 -070065COMMIT_BOT_EMAIL = 'commit-bot@chromium.org'
iannuccie7f68952016-08-15 17:45:29 -070066DEFAULT_SERVER = 'https://codereview.chromium.org'
maruel@chromium.org0ba7f962011-01-11 22:13:58 +000067POSTUPSTREAM_HOOK_PATTERN = '.git/hooks/post-cl-%s'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000068DESCRIPTION_BACKUP_FILE = '~/.git_cl_description_backup'
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +000069GIT_INSTRUCTIONS_URL = 'http://code.google.com/p/chromium/wiki/UsingGit'
rmistry@google.comc68112d2015-03-03 12:48:06 +000070REFS_THAT_ALIAS_TO_OTHER_REFS = {
71 'refs/remotes/origin/lkgr': 'refs/remotes/origin/master',
72 'refs/remotes/origin/lkcr': 'refs/remotes/origin/master',
73}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000074
thestig@chromium.org44202a22014-03-11 19:22:18 +000075# Valid extensions for files we want to lint.
76DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
77DEFAULT_LINT_IGNORE_REGEX = r"$^"
78
borenet6c0efe62016-10-19 08:13:29 -070079# Buildbucket master name prefix.
80MASTER_PREFIX = 'master.'
81
maruel@chromium.org2e23ce32013-05-07 12:42:28 +000082# Shortcut since it quickly becomes redundant.
83Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +000084
maruel@chromium.orgddd59412011-11-30 14:20:38 +000085# Initialized in main()
86settings = None
87
88
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000089def DieWithError(message):
vapiera7fbd5a2016-06-16 09:17:49 -070090 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000091 sys.exit(1)
92
93
thestig@chromium.org8b0553c2014-02-11 00:33:37 +000094def GetNoGitPagerEnv():
95 env = os.environ.copy()
96 # 'cat' is a magical git string that disables pagers on all platforms.
97 env['GIT_PAGER'] = 'cat'
98 return env
99
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000100
bsep@chromium.org627d9002016-04-29 00:00:52 +0000101def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000102 try:
bsep@chromium.org627d9002016-04-29 00:00:52 +0000103 return subprocess2.check_output(args, shell=shell, **kwargs)
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000104 except subprocess2.CalledProcessError as e:
105 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000106 if not error_ok:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000107 DieWithError(
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000108 'Command "%s" failed.\n%s' % (
109 ' '.join(args), error_message or e.stdout or ''))
110 return e.stdout
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000111
112
113def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000114 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000115 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000116
117
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000118def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000119 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700120 if suppress_stderr:
121 stderr = subprocess2.VOID
122 else:
123 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000124 try:
tandrii5d48c322016-08-18 16:19:37 -0700125 (out, _), code = subprocess2.communicate(['git'] + args,
126 env=GetNoGitPagerEnv(),
127 stdout=subprocess2.PIPE,
128 stderr=stderr)
129 return code, out
130 except subprocess2.CalledProcessError as e:
131 logging.debug('Failed running %s', args)
132 return e.returncode, e.stdout
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000133
134
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000135def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000136 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000137 return RunGitWithCode(args, suppress_stderr=True)[1]
138
139
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000140def IsGitVersionAtLeast(min_version):
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000141 prefix = 'git version '
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000142 version = RunGit(['--version']).strip()
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000143 return (version.startswith(prefix) and
144 LooseVersion(version[len(prefix):]) >= LooseVersion(min_version))
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000145
146
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +0000147def BranchExists(branch):
148 """Return True if specified branch exists."""
149 code, _ = RunGitWithCode(['rev-parse', '--verify', branch],
150 suppress_stderr=True)
151 return not code
152
153
tandrii2a16b952016-10-19 07:09:44 -0700154def time_sleep(seconds):
155 # Use this so that it can be mocked in tests without interfering with python
156 # system machinery.
157 import time # Local import to discourage others from importing time globally.
158 return time.sleep(seconds)
159
160
maruel@chromium.org90541732011-04-01 17:54:18 +0000161def ask_for_data(prompt):
162 try:
163 return raw_input(prompt)
164 except KeyboardInterrupt:
165 # Hide the exception.
166 sys.exit(1)
167
168
tandrii5d48c322016-08-18 16:19:37 -0700169def _git_branch_config_key(branch, key):
170 """Helper method to return Git config key for a branch."""
171 assert branch, 'branch name is required to set git config for it'
172 return 'branch.%s.%s' % (branch, key)
173
174
175def _git_get_branch_config_value(key, default=None, value_type=str,
176 branch=False):
177 """Returns git config value of given or current branch if any.
178
179 Returns default in all other cases.
180 """
181 assert value_type in (int, str, bool)
182 if branch is False: # Distinguishing default arg value from None.
183 branch = GetCurrentBranch()
184
rogerta@chromium.orgcaa16552013-03-18 20:45:05 +0000185 if not branch:
tandrii5d48c322016-08-18 16:19:37 -0700186 return default
rogerta@chromium.orgcaa16552013-03-18 20:45:05 +0000187
tandrii5d48c322016-08-18 16:19:37 -0700188 args = ['config']
tandrii33a46ff2016-08-23 05:53:40 -0700189 if value_type == bool:
tandrii5d48c322016-08-18 16:19:37 -0700190 args.append('--bool')
tandrii33a46ff2016-08-23 05:53:40 -0700191 # git config also has --int, but apparently git config suffers from integer
192 # overflows (http://crbug.com/640115), so don't use it.
tandrii5d48c322016-08-18 16:19:37 -0700193 args.append(_git_branch_config_key(branch, key))
194 code, out = RunGitWithCode(args)
195 if code == 0:
196 value = out.strip()
197 if value_type == int:
198 return int(value)
199 if value_type == bool:
200 return bool(value.lower() == 'true')
201 return value
iannucci@chromium.org79540052012-10-19 23:15:26 +0000202 return default
203
204
tandrii5d48c322016-08-18 16:19:37 -0700205def _git_set_branch_config_value(key, value, branch=None, **kwargs):
206 """Sets the value or unsets if it's None of a git branch config.
207
208 Valid, though not necessarily existing, branch must be provided,
209 otherwise currently checked out branch is used.
210 """
211 if not branch:
212 branch = GetCurrentBranch()
213 assert branch, 'a branch name OR currently checked out branch is required'
214 args = ['config']
qyearsley12fa6ff2016-08-24 09:18:40 -0700215 # Check for boolean first, because bool is int, but int is not bool.
tandrii5d48c322016-08-18 16:19:37 -0700216 if value is None:
217 args.append('--unset')
218 elif isinstance(value, bool):
219 args.append('--bool')
220 value = str(value).lower()
tandrii5d48c322016-08-18 16:19:37 -0700221 else:
tandrii33a46ff2016-08-23 05:53:40 -0700222 # git config also has --int, but apparently git config suffers from integer
223 # overflows (http://crbug.com/640115), so don't use it.
tandrii5d48c322016-08-18 16:19:37 -0700224 value = str(value)
225 args.append(_git_branch_config_key(branch, key))
226 if value is not None:
227 args.append(value)
228 RunGit(args, **kwargs)
229
230
iannucci@chromium.org53937ba2012-10-02 18:20:43 +0000231def add_git_similarity(parser):
232 parser.add_option(
tandrii5d48c322016-08-18 16:19:37 -0700233 '--similarity', metavar='SIM', type=int, action='store',
iannucci@chromium.org53937ba2012-10-02 18:20:43 +0000234 help='Sets the percentage that a pair of files need to match in order to'
235 ' be considered copies (default 50)')
iannucci@chromium.org79540052012-10-19 23:15:26 +0000236 parser.add_option(
237 '--find-copies', action='store_true',
238 help='Allows git to look for copies.')
239 parser.add_option(
240 '--no-find-copies', action='store_false', dest='find_copies',
241 help='Disallows git from looking for copies.')
iannucci@chromium.org53937ba2012-10-02 18:20:43 +0000242
243 old_parser_args = parser.parse_args
244 def Parse(args):
245 options, args = old_parser_args(args)
246
iannucci@chromium.org53937ba2012-10-02 18:20:43 +0000247 if options.similarity is None:
tandrii5d48c322016-08-18 16:19:37 -0700248 options.similarity = _git_get_branch_config_value(
249 'git-cl-similarity', default=50, value_type=int)
iannucci@chromium.org53937ba2012-10-02 18:20:43 +0000250 else:
iannucci@chromium.org79540052012-10-19 23:15:26 +0000251 print('Note: Saving similarity of %d%% in git config.'
252 % options.similarity)
tandrii5d48c322016-08-18 16:19:37 -0700253 _git_set_branch_config_value('git-cl-similarity', options.similarity)
iannucci@chromium.org53937ba2012-10-02 18:20:43 +0000254
iannucci@chromium.org79540052012-10-19 23:15:26 +0000255 options.similarity = max(0, min(options.similarity, 100))
256
257 if options.find_copies is None:
tandrii5d48c322016-08-18 16:19:37 -0700258 options.find_copies = _git_get_branch_config_value(
259 'git-find-copies', default=True, value_type=bool)
iannucci@chromium.org79540052012-10-19 23:15:26 +0000260 else:
tandrii5d48c322016-08-18 16:19:37 -0700261 _git_set_branch_config_value('git-find-copies', bool(options.find_copies))
iannucci@chromium.org53937ba2012-10-02 18:20:43 +0000262
263 print('Using %d%% similarity for rename/copy detection. '
264 'Override with --similarity.' % options.similarity)
265
266 return options, args
267 parser.parse_args = Parse
268
269
machenbach@chromium.org45453142015-09-15 08:45:22 +0000270def _get_properties_from_options(options):
271 properties = dict(x.split('=', 1) for x in options.properties)
272 for key, val in properties.iteritems():
273 try:
274 properties[key] = json.loads(val)
275 except ValueError:
276 pass # If a value couldn't be evaluated, treat it as a string.
277 return properties
278
279
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000280def _prefix_master(master):
281 """Convert user-specified master name to full master name.
282
283 Buildbucket uses full master name(master.tryserver.chromium.linux) as bucket
284 name, while the developers always use shortened master name
285 (tryserver.chromium.linux) by stripping off the prefix 'master.'. This
286 function does the conversion for buildbucket migration.
287 """
borenet6c0efe62016-10-19 08:13:29 -0700288 if master.startswith(MASTER_PREFIX):
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000289 return master
borenet6c0efe62016-10-19 08:13:29 -0700290 return '%s%s' % (MASTER_PREFIX, master)
291
292
293def _unprefix_master(bucket):
294 """Convert bucket name to shortened master name.
295
296 Buildbucket uses full master name(master.tryserver.chromium.linux) as bucket
297 name, while the developers always use shortened master name
298 (tryserver.chromium.linux) by stripping off the prefix 'master.'. This
299 function does the conversion for buildbucket migration.
300 """
301 if bucket.startswith(MASTER_PREFIX):
302 return bucket[len(MASTER_PREFIX):]
303 return bucket
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000304
305
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000306def _buildbucket_retry(operation_name, http, *args, **kwargs):
307 """Retries requests to buildbucket service and returns parsed json content."""
308 try_count = 0
309 while True:
310 response, content = http.request(*args, **kwargs)
311 try:
312 content_json = json.loads(content)
313 except ValueError:
314 content_json = None
315
316 # Buildbucket could return an error even if status==200.
317 if content_json and content_json.get('error'):
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000318 error = content_json.get('error')
319 if error.get('code') == 403:
320 raise BuildbucketResponseException(
321 'Access denied: %s' % error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000322 msg = 'Error in response. Reason: %s. Message: %s.' % (
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000323 error.get('reason', ''), error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000324 raise BuildbucketResponseException(msg)
325
326 if response.status == 200:
327 if not content_json:
328 raise BuildbucketResponseException(
329 'Buildbucket returns invalid json content: %s.\n'
330 'Please file bugs at http://crbug.com, label "Infra-BuildBucket".' %
331 content)
332 return content_json
333 if response.status < 500 or try_count >= 2:
334 raise httplib2.HttpLib2Error(content)
335
336 # status >= 500 means transient failures.
337 logging.debug('Transient errors when %s. Will retry.', operation_name)
tandrii2a16b952016-10-19 07:09:44 -0700338 time_sleep(0.5 + 1.5*try_count)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000339 try_count += 1
340 assert False, 'unreachable'
341
342
qyearsley1fdfcb62016-10-24 13:22:03 -0700343def _get_bucket_map(changelist, options, option_parser):
qyearsleydd49f942016-10-28 11:57:22 -0700344 """Returns a dict mapping bucket names to builders and tests,
345 for triggering try jobs.
qyearsley1fdfcb62016-10-24 13:22:03 -0700346 """
qyearsleydd49f942016-10-28 11:57:22 -0700347 # If no bots are listed, we try to get a set of builders and tests based
348 # on GetPreferredTryMasters functions in PRESUBMIT.py files.
qyearsley1fdfcb62016-10-24 13:22:03 -0700349 if not options.bot:
350 change = changelist.GetChange(
351 changelist.GetCommonAncestorWithUpstream(), None)
qyearsley136b49f2016-10-31 09:02:26 -0700352 # Get try masters from PRESUBMIT.py files.
nodire4f0fe02016-11-04 16:23:30 -0700353 masters = presubmit_support.DoGetTryMasters(
qyearsley1fdfcb62016-10-24 13:22:03 -0700354 change=change,
355 changed_files=change.LocalPaths(),
356 repository_root=settings.GetRoot(),
357 default_presubmit=None,
358 project=None,
359 verbose=options.verbose,
360 output_stream=sys.stdout)
nodire4f0fe02016-11-04 16:23:30 -0700361 if masters is None:
362 return None
363 return {MASTER_PREFIX + m: b for m, b in masters.iteritems()}
qyearsley1fdfcb62016-10-24 13:22:03 -0700364
qyearsley1fdfcb62016-10-24 13:22:03 -0700365 if options.bucket:
366 return {options.bucket: {b: [] for b in options.bot}}
qyearsleydd49f942016-10-28 11:57:22 -0700367 if options.master:
368 return {_prefix_master(options.master): {b: [] for b in options.bot}}
qyearsley1fdfcb62016-10-24 13:22:03 -0700369
qyearsleydd49f942016-10-28 11:57:22 -0700370 # If bots are listed but no master or bucket, then we need to find out
371 # the corresponding master for each bot.
372 bucket_map, error_message = _get_bucket_map_for_builders(options.bot)
373 if error_message:
374 option_parser.error(
375 'Tryserver master cannot be found because: %s\n'
376 'Please manually specify the tryserver master, e.g. '
377 '"-m tryserver.chromium.linux".' % error_message)
378 return bucket_map
qyearsley1fdfcb62016-10-24 13:22:03 -0700379
380
qyearsley123a4682016-10-26 09:12:17 -0700381def _get_bucket_map_for_builders(builders):
382 """Returns a map of buckets to builders for the given builders."""
qyearsley1fdfcb62016-10-24 13:22:03 -0700383 map_url = 'https://builders-map.appspot.com/'
384 try:
qyearsley123a4682016-10-26 09:12:17 -0700385 builders_map = json.load(urllib2.urlopen(map_url))
qyearsley1fdfcb62016-10-24 13:22:03 -0700386 except urllib2.URLError as e:
387 return None, ('Failed to fetch builder-to-master map from %s. Error: %s.' %
388 (map_url, e))
389 except ValueError as e:
390 return None, ('Invalid json string from %s. Error: %s.' % (map_url, e))
qyearsley123a4682016-10-26 09:12:17 -0700391 if not builders_map:
qyearsley1fdfcb62016-10-24 13:22:03 -0700392 return None, 'Failed to build master map.'
393
qyearsley123a4682016-10-26 09:12:17 -0700394 bucket_map = {}
395 for builder in builders:
qyearsley123a4682016-10-26 09:12:17 -0700396 masters = builders_map.get(builder, [])
397 if not masters:
qyearsley1fdfcb62016-10-24 13:22:03 -0700398 return None, ('No matching master for builder %s.' % builder)
qyearsley123a4682016-10-26 09:12:17 -0700399 if len(masters) > 1:
qyearsley1fdfcb62016-10-24 13:22:03 -0700400 return None, ('The builder name %s exists in multiple masters %s.' %
qyearsley123a4682016-10-26 09:12:17 -0700401 (builder, masters))
402 bucket = _prefix_master(masters[0])
403 bucket_map.setdefault(bucket, {})[builder] = []
404
405 return bucket_map, None
qyearsley1fdfcb62016-10-24 13:22:03 -0700406
407
borenet6c0efe62016-10-19 08:13:29 -0700408def _trigger_try_jobs(auth_config, changelist, buckets, options,
tandriide281ae2016-10-12 06:02:30 -0700409 category='git_cl_try', patchset=None):
qyearsley1fdfcb62016-10-24 13:22:03 -0700410 """Sends a request to Buildbucket to trigger try jobs for a changelist.
411
412 Args:
413 auth_config: AuthConfig for Rietveld.
414 changelist: Changelist that the try jobs are associated with.
415 buckets: A nested dict mapping bucket names to builders to tests.
416 options: Command-line options.
417 """
tandriide281ae2016-10-12 06:02:30 -0700418 assert changelist.GetIssue(), 'CL must be uploaded first'
419 codereview_url = changelist.GetCodereviewServer()
420 assert codereview_url, 'CL must be uploaded first'
421 patchset = patchset or changelist.GetMostRecentPatchset()
422 assert patchset, 'CL must be uploaded first'
423
424 codereview_host = urlparse.urlparse(codereview_url).hostname
425 authenticator = auth.get_authenticator_for_host(codereview_host, auth_config)
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000426 http = authenticator.authorize(httplib2.Http())
427 http.force_exception_to_status_code = True
tandriide281ae2016-10-12 06:02:30 -0700428
429 # TODO(tandrii): consider caching Gerrit CL details just like
430 # _RietveldChangelistImpl does, then caching values in these two variables
431 # won't be necessary.
432 owner_email = changelist.GetIssueOwner()
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000433
434 buildbucket_put_url = (
435 'https://{hostname}/_ah/api/buildbucket/v1/builds/batch'.format(
sheyang@chromium.orgdb375572015-08-17 19:22:23 +0000436 hostname=options.buildbucket_host))
tandriide281ae2016-10-12 06:02:30 -0700437 buildset = 'patch/{codereview}/{hostname}/{issue}/{patch}'.format(
438 codereview='gerrit' if changelist.IsGerrit() else 'rietveld',
439 hostname=codereview_host,
440 issue=changelist.GetIssue(),
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000441 patch=patchset)
tandrii8c5a3532016-11-04 07:52:02 -0700442
443 shared_parameters_properties = changelist.GetTryjobProperties(patchset)
444 shared_parameters_properties['category'] = category
445 if options.clobber:
446 shared_parameters_properties['clobber'] = True
tandriide281ae2016-10-12 06:02:30 -0700447 extra_properties = _get_properties_from_options(options)
tandrii8c5a3532016-11-04 07:52:02 -0700448 if extra_properties:
449 shared_parameters_properties.update(extra_properties)
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000450
451 batch_req_body = {'builds': []}
452 print_text = []
453 print_text.append('Tried jobs on:')
borenet6c0efe62016-10-19 08:13:29 -0700454 for bucket, builders_and_tests in sorted(buckets.iteritems()):
455 print_text.append('Bucket: %s' % bucket)
456 master = None
457 if bucket.startswith(MASTER_PREFIX):
458 master = _unprefix_master(bucket)
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000459 for builder, tests in sorted(builders_and_tests.iteritems()):
460 print_text.append(' %s: %s' % (builder, tests))
461 parameters = {
462 'builder_name': builder,
nodir@chromium.orgd2217312015-09-21 15:51:21 +0000463 'changes': [{
tandriide281ae2016-10-12 06:02:30 -0700464 'author': {'email': owner_email},
nodir@chromium.orgd2217312015-09-21 15:51:21 +0000465 'revision': options.revision,
466 }],
tandrii8c5a3532016-11-04 07:52:02 -0700467 'properties': shared_parameters_properties.copy(),
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000468 }
machenbach@chromium.org2403e802016-04-29 12:34:42 +0000469 if 'presubmit' in builder.lower():
470 parameters['properties']['dry_run'] = 'true'
tandrii@chromium.org3764fa22015-10-21 16:40:40 +0000471 if tests:
472 parameters['properties']['testfilter'] = tests
borenet6c0efe62016-10-19 08:13:29 -0700473
474 tags = [
475 'builder:%s' % builder,
476 'buildset:%s' % buildset,
477 'user_agent:git_cl_try',
478 ]
479 if master:
480 parameters['properties']['master'] = master
481 tags.append('master:%s' % master)
482
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000483 batch_req_body['builds'].append(
484 {
485 'bucket': bucket,
486 'parameters_json': json.dumps(parameters),
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000487 'client_operation_id': str(uuid.uuid4()),
borenet6c0efe62016-10-19 08:13:29 -0700488 'tags': tags,
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000489 }
490 )
491
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000492 _buildbucket_retry(
qyearsleyeab3c042016-08-24 09:18:28 -0700493 'triggering try jobs',
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000494 http,
495 buildbucket_put_url,
496 'PUT',
497 body=json.dumps(batch_req_body),
498 headers={'Content-Type': 'application/json'}
499 )
tandrii@chromium.org35c61452016-02-26 15:24:57 +0000500 print_text.append('To see results here, run: git cl try-results')
501 print_text.append('To see results in browser, run: git cl web')
vapiera7fbd5a2016-06-16 09:17:49 -0700502 print('\n'.join(print_text))
kjellander@chromium.org44424542015-06-02 18:35:29 +0000503
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000504
tandrii221ab252016-10-06 08:12:04 -0700505def fetch_try_jobs(auth_config, changelist, buildbucket_host,
506 patchset=None):
qyearsleyeab3c042016-08-24 09:18:28 -0700507 """Fetches try jobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000508
qyearsley53f48a12016-09-01 10:45:13 -0700509 Returns a map from build id to build info as a dictionary.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000510 """
tandrii221ab252016-10-06 08:12:04 -0700511 assert buildbucket_host
512 assert changelist.GetIssue(), 'CL must be uploaded first'
513 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
514 patchset = patchset or changelist.GetMostRecentPatchset()
515 assert patchset, 'CL must be uploaded first'
516
517 codereview_url = changelist.GetCodereviewServer()
518 codereview_host = urlparse.urlparse(codereview_url).hostname
519 authenticator = auth.get_authenticator_for_host(codereview_host, auth_config)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000520 if authenticator.has_cached_credentials():
521 http = authenticator.authorize(httplib2.Http())
522 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700523 print('Warning: Some results might be missing because %s' %
524 # Get the message on how to login.
tandrii221ab252016-10-06 08:12:04 -0700525 (auth.LoginRequiredError(codereview_host).message,))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000526 http = httplib2.Http()
527
528 http.force_exception_to_status_code = True
529
tandrii221ab252016-10-06 08:12:04 -0700530 buildset = 'patch/{codereview}/{hostname}/{issue}/{patch}'.format(
531 codereview='gerrit' if changelist.IsGerrit() else 'rietveld',
532 hostname=codereview_host,
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000533 issue=changelist.GetIssue(),
tandrii221ab252016-10-06 08:12:04 -0700534 patch=patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000535 params = {'tag': 'buildset:%s' % buildset}
536
537 builds = {}
538 while True:
539 url = 'https://{hostname}/_ah/api/buildbucket/v1/search?{params}'.format(
tandrii221ab252016-10-06 08:12:04 -0700540 hostname=buildbucket_host,
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000541 params=urllib.urlencode(params))
qyearsleyeab3c042016-08-24 09:18:28 -0700542 content = _buildbucket_retry('fetching try jobs', http, url, 'GET')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000543 for build in content.get('builds', []):
544 builds[build['id']] = build
545 if 'next_cursor' in content:
546 params['start_cursor'] = content['next_cursor']
547 else:
548 break
549 return builds
550
551
qyearsleyeab3c042016-08-24 09:18:28 -0700552def print_try_jobs(options, builds):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000553 """Prints nicely result of fetch_try_jobs."""
554 if not builds:
qyearsleyeab3c042016-08-24 09:18:28 -0700555 print('No try jobs scheduled')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000556 return
557
558 # Make a copy, because we'll be modifying builds dictionary.
559 builds = builds.copy()
560 builder_names_cache = {}
561
562 def get_builder(b):
563 try:
564 return builder_names_cache[b['id']]
565 except KeyError:
566 try:
567 parameters = json.loads(b['parameters_json'])
568 name = parameters['builder_name']
569 except (ValueError, KeyError) as error:
vapiera7fbd5a2016-06-16 09:17:49 -0700570 print('WARNING: failed to get builder name for build %s: %s' % (
571 b['id'], error))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000572 name = None
573 builder_names_cache[b['id']] = name
574 return name
575
576 def get_bucket(b):
577 bucket = b['bucket']
578 if bucket.startswith('master.'):
579 return bucket[len('master.'):]
580 return bucket
581
582 if options.print_master:
583 name_fmt = '%%-%ds %%-%ds' % (
584 max(len(str(get_bucket(b))) for b in builds.itervalues()),
585 max(len(str(get_builder(b))) for b in builds.itervalues()))
586 def get_name(b):
587 return name_fmt % (get_bucket(b), get_builder(b))
588 else:
589 name_fmt = '%%-%ds' % (
590 max(len(str(get_builder(b))) for b in builds.itervalues()))
591 def get_name(b):
592 return name_fmt % get_builder(b)
593
594 def sort_key(b):
595 return b['status'], b.get('result'), get_name(b), b.get('url')
596
597 def pop(title, f, color=None, **kwargs):
598 """Pop matching builds from `builds` dict and print them."""
599
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000600 if not options.color or color is None:
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000601 colorize = str
602 else:
603 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
604
605 result = []
606 for b in builds.values():
607 if all(b.get(k) == v for k, v in kwargs.iteritems()):
608 builds.pop(b['id'])
609 result.append(b)
610 if result:
vapiera7fbd5a2016-06-16 09:17:49 -0700611 print(colorize(title))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000612 for b in sorted(result, key=sort_key):
vapiera7fbd5a2016-06-16 09:17:49 -0700613 print(' ', colorize('\t'.join(map(str, f(b)))))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000614
615 total = len(builds)
616 pop(status='COMPLETED', result='SUCCESS',
617 title='Successes:', color=Fore.GREEN,
618 f=lambda b: (get_name(b), b.get('url')))
619 pop(status='COMPLETED', result='FAILURE', failure_reason='INFRA_FAILURE',
620 title='Infra Failures:', color=Fore.MAGENTA,
621 f=lambda b: (get_name(b), b.get('url')))
622 pop(status='COMPLETED', result='FAILURE', failure_reason='BUILD_FAILURE',
623 title='Failures:', color=Fore.RED,
624 f=lambda b: (get_name(b), b.get('url')))
625 pop(status='COMPLETED', result='CANCELED',
626 title='Canceled:', color=Fore.MAGENTA,
627 f=lambda b: (get_name(b),))
628 pop(status='COMPLETED', result='FAILURE',
629 failure_reason='INVALID_BUILD_DEFINITION',
630 title='Wrong master/builder name:', color=Fore.MAGENTA,
631 f=lambda b: (get_name(b),))
632 pop(status='COMPLETED', result='FAILURE',
633 title='Other failures:',
634 f=lambda b: (get_name(b), b.get('failure_reason'), b.get('url')))
635 pop(status='COMPLETED',
636 title='Other finished:',
637 f=lambda b: (get_name(b), b.get('result'), b.get('url')))
638 pop(status='STARTED',
639 title='Started:', color=Fore.YELLOW,
640 f=lambda b: (get_name(b), b.get('url')))
641 pop(status='SCHEDULED',
642 title='Scheduled:',
643 f=lambda b: (get_name(b), 'id=%s' % b['id']))
644 # The last section is just in case buildbucket API changes OR there is a bug.
645 pop(title='Other:',
646 f=lambda b: (get_name(b), 'id=%s' % b['id']))
647 assert len(builds) == 0
qyearsleyeab3c042016-08-24 09:18:28 -0700648 print('Total: %d try jobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000649
650
qyearsley53f48a12016-09-01 10:45:13 -0700651def write_try_results_json(output_file, builds):
652 """Writes a subset of the data from fetch_try_jobs to a file as JSON.
653
654 The input |builds| dict is assumed to be generated by Buildbucket.
655 Buildbucket documentation: http://goo.gl/G0s101
656 """
657
658 def convert_build_dict(build):
659 return {
660 'buildbucket_id': build.get('id'),
661 'status': build.get('status'),
662 'result': build.get('result'),
663 'bucket': build.get('bucket'),
664 'builder_name': json.loads(
665 build.get('parameters_json', '{}')).get('builder_name'),
666 'failure_reason': build.get('failure_reason'),
667 'url': build.get('url'),
668 }
669
670 converted = []
671 for _, build in sorted(builds.items()):
672 converted.append(convert_build_dict(build))
673 write_json(output_file, converted)
674
675
bauerb@chromium.org866276c2011-03-18 20:09:31 +0000676def MatchSvnGlob(url, base_url, glob_spec, allow_wildcards):
677 """Return the corresponding git ref if |base_url| together with |glob_spec|
678 matches the full |url|.
679
680 If |allow_wildcards| is true, |glob_spec| can contain wildcards (see below).
681 """
682 fetch_suburl, as_ref = glob_spec.split(':')
683 if allow_wildcards:
684 glob_match = re.match('(.+/)?(\*|{[^/]*})(/.+)?', fetch_suburl)
685 if glob_match:
686 # Parse specs like "branches/*/src:refs/remotes/svn/*" or
687 # "branches/{472,597,648}/src:refs/remotes/svn/*".
688 branch_re = re.escape(base_url)
689 if glob_match.group(1):
690 branch_re += '/' + re.escape(glob_match.group(1))
691 wildcard = glob_match.group(2)
692 if wildcard == '*':
693 branch_re += '([^/]*)'
694 else:
695 # Escape and replace surrounding braces with parentheses and commas
696 # with pipe symbols.
697 wildcard = re.escape(wildcard)
698 wildcard = re.sub('^\\\\{', '(', wildcard)
699 wildcard = re.sub('\\\\,', '|', wildcard)
700 wildcard = re.sub('\\\\}$', ')', wildcard)
701 branch_re += wildcard
702 if glob_match.group(3):
703 branch_re += re.escape(glob_match.group(3))
704 match = re.match(branch_re, url)
705 if match:
706 return re.sub('\*$', match.group(1), as_ref)
707
708 # Parse specs like "trunk/src:refs/remotes/origin/trunk".
709 if fetch_suburl:
710 full_url = base_url + '/' + fetch_suburl
711 else:
712 full_url = base_url
713 if full_url == url:
714 return as_ref
715 return None
716
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000717
iannucci@chromium.org79540052012-10-19 23:15:26 +0000718def print_stats(similarity, find_copies, args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000719 """Prints statistics about the change to the user."""
720 # --no-ext-diff is broken in some versions of Git, so try to work around
721 # this by overriding the environment (but there is still a problem if the
722 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000723 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000724 if 'GIT_EXTERNAL_DIFF' in env:
725 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000726
727 if find_copies:
scottmgb84b5e32016-11-10 09:25:33 -0800728 similarity_options = ['-l100000', '-C%s' % similarity]
iannucci@chromium.org79540052012-10-19 23:15:26 +0000729 else:
730 similarity_options = ['-M%s' % similarity]
731
szager@chromium.orgd057f9a2014-05-29 21:09:36 +0000732 try:
733 stdout = sys.stdout.fileno()
734 except AttributeError:
735 stdout = None
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000736 return subprocess2.call(
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000737 ['git',
bratell@opera.comf267b0e2013-05-02 09:11:43 +0000738 'diff', '--no-ext-diff', '--stat'] + similarity_options + args,
szager@chromium.orgd057f9a2014-05-29 21:09:36 +0000739 stdout=stdout, env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000740
741
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000742class BuildbucketResponseException(Exception):
743 pass
744
745
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000746class Settings(object):
747 def __init__(self):
748 self.default_server = None
749 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000750 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000751 self.is_git_svn = None
752 self.svn_branch = None
753 self.tree_status_url = None
754 self.viewvc_url = None
755 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000756 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000757 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000758 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000759 self.git_editor = None
sheyang@chromium.org152cf832014-06-11 21:37:49 +0000760 self.project = None
kjellander@chromium.org6abc6522014-12-02 07:34:49 +0000761 self.force_https_commit_url = None
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000762 self.pending_ref_prefix = None
tandriif46c20f2016-09-14 06:17:05 -0700763 self.git_number_footer = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000764
765 def LazyUpdateIfNeeded(self):
766 """Updates the settings from a codereview.settings file, if available."""
767 if not self.updated:
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000768 # The only value that actually changes the behavior is
769 # autoupdate = "false". Everything else means "true".
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +0000770 autoupdate = RunGit(['config', 'rietveld.autoupdate'],
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000771 error_ok=True
772 ).strip().lower()
773
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000774 cr_settings_file = FindCodereviewSettingsFile()
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000775 if autoupdate != 'false' and cr_settings_file:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000776 LoadCodereviewSettingsFromFile(cr_settings_file)
777 self.updated = True
778
779 def GetDefaultServerUrl(self, error_ok=False):
780 if not self.default_server:
781 self.LazyUpdateIfNeeded()
maruel@chromium.orgeb5edbc2012-01-16 17:03:28 +0000782 self.default_server = gclient_utils.UpgradeToHttps(
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000783 self._GetRietveldConfig('server', error_ok=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000784 if error_ok:
785 return self.default_server
786 if not self.default_server:
787 error_message = ('Could not find settings file. You must configure '
788 'your review setup by running "git cl config".')
maruel@chromium.orgeb5edbc2012-01-16 17:03:28 +0000789 self.default_server = gclient_utils.UpgradeToHttps(
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000790 self._GetRietveldConfig('server', error_message=error_message))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000791 return self.default_server
792
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000793 @staticmethod
794 def GetRelativeRoot():
795 return RunGit(['rev-parse', '--show-cdup']).strip()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000796
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000797 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000798 if self.root is None:
799 self.root = os.path.abspath(self.GetRelativeRoot())
800 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000801
szager@chromium.org151ebcf2016-03-09 01:08:25 +0000802 def GetGitMirror(self, remote='origin'):
803 """If this checkout is from a local git mirror, return a Mirror object."""
szager@chromium.org81593742016-03-09 20:27:58 +0000804 local_url = RunGit(['config', '--get', 'remote.%s.url' % remote]).strip()
szager@chromium.org151ebcf2016-03-09 01:08:25 +0000805 if not os.path.isdir(local_url):
806 return None
807 git_cache.Mirror.SetCachePath(os.path.dirname(local_url))
808 remote_url = git_cache.Mirror.CacheDirToUrl(local_url)
809 # Use the /dev/null print_func to avoid terminal spew in WaitForRealCommit.
810 mirror = git_cache.Mirror(remote_url, print_func = lambda *args: None)
811 if mirror.exists():
812 return mirror
813 return None
814
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000815 def GetIsGitSvn(self):
816 """Return true if this repo looks like it's using git-svn."""
817 if self.is_git_svn is None:
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000818 if self.GetPendingRefPrefix():
819 # If PENDING_REF_PREFIX is set then it's a pure git repo no matter what.
820 self.is_git_svn = False
821 else:
822 # If you have any "svn-remote.*" config keys, we think you're using svn.
823 self.is_git_svn = RunGitWithCode(
824 ['config', '--local', '--get-regexp', r'^svn-remote\.'])[0] == 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000825 return self.is_git_svn
826
827 def GetSVNBranch(self):
828 if self.svn_branch is None:
829 if not self.GetIsGitSvn():
830 DieWithError('Repo doesn\'t appear to be a git-svn repo.')
831
832 # Try to figure out which remote branch we're based on.
833 # Strategy:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000834 # 1) iterate through our branch history and find the svn URL.
835 # 2) find the svn-remote that fetches from the URL.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000836
837 # regexp matching the git-svn line that contains the URL.
838 git_svn_re = re.compile(r'^\s*git-svn-id: (\S+)@', re.MULTILINE)
839
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000840 # We don't want to go through all of history, so read a line from the
841 # pipe at a time.
842 # The -100 is an arbitrary limit so we don't search forever.
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000843 cmd = ['git', 'log', '-100', '--pretty=medium']
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000844 proc = subprocess2.Popen(cmd, stdout=subprocess2.PIPE,
845 env=GetNoGitPagerEnv())
maruel@chromium.org740f9d72011-06-10 18:33:10 +0000846 url = None
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000847 for line in proc.stdout:
848 match = git_svn_re.match(line)
849 if match:
850 url = match.group(1)
851 proc.stdout.close() # Cut pipe.
852 break
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000853
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000854 if url:
855 svn_remote_re = re.compile(r'^svn-remote\.([^.]+)\.url (.*)$')
856 remotes = RunGit(['config', '--get-regexp',
857 r'^svn-remote\..*\.url']).splitlines()
858 for remote in remotes:
859 match = svn_remote_re.match(remote)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000860 if match:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000861 remote = match.group(1)
862 base_url = match.group(2)
szager@chromium.org4ac25532013-12-16 22:07:02 +0000863 rewrite_root = RunGit(
864 ['config', 'svn-remote.%s.rewriteRoot' % remote],
865 error_ok=True).strip()
866 if rewrite_root:
867 base_url = rewrite_root
bauerb@chromium.orgade368c2011-03-01 08:57:50 +0000868 fetch_spec = RunGit(
bauerb@chromium.org866276c2011-03-18 20:09:31 +0000869 ['config', 'svn-remote.%s.fetch' % remote],
870 error_ok=True).strip()
871 if fetch_spec:
872 self.svn_branch = MatchSvnGlob(url, base_url, fetch_spec, False)
873 if self.svn_branch:
874 break
875 branch_spec = RunGit(
876 ['config', 'svn-remote.%s.branches' % remote],
877 error_ok=True).strip()
878 if branch_spec:
879 self.svn_branch = MatchSvnGlob(url, base_url, branch_spec, True)
880 if self.svn_branch:
881 break
882 tag_spec = RunGit(
883 ['config', 'svn-remote.%s.tags' % remote],
884 error_ok=True).strip()
885 if tag_spec:
886 self.svn_branch = MatchSvnGlob(url, base_url, tag_spec, True)
887 if self.svn_branch:
888 break
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000889
890 if not self.svn_branch:
891 DieWithError('Can\'t guess svn branch -- try specifying it on the '
892 'command line')
893
894 return self.svn_branch
895
896 def GetTreeStatusUrl(self, error_ok=False):
897 if not self.tree_status_url:
898 error_message = ('You must configure your tree status URL by running '
899 '"git cl config".')
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000900 self.tree_status_url = self._GetRietveldConfig(
901 'tree-status-url', error_ok=error_ok, error_message=error_message)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000902 return self.tree_status_url
903
904 def GetViewVCUrl(self):
905 if not self.viewvc_url:
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000906 self.viewvc_url = self._GetRietveldConfig('viewvc-url', error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000907 return self.viewvc_url
908
rmistry@google.com90752582014-01-14 21:04:50 +0000909 def GetBugPrefix(self):
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000910 return self._GetRietveldConfig('bug-prefix', error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +0000911
rmistry@google.com78948ed2015-07-08 23:09:57 +0000912 def GetIsSkipDependencyUpload(self, branch_name):
913 """Returns true if specified branch should skip dep uploads."""
914 return self._GetBranchConfig(branch_name, 'skip-deps-uploads',
915 error_ok=True)
916
rmistry@google.com5626a922015-02-26 14:03:30 +0000917 def GetRunPostUploadHook(self):
918 run_post_upload_hook = self._GetRietveldConfig(
919 'run-post-upload-hook', error_ok=True)
920 return run_post_upload_hook == "True"
921
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000922 def GetDefaultCCList(self):
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000923 return self._GetRietveldConfig('cc', error_ok=True)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000924
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000925 def GetDefaultPrivateFlag(self):
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000926 return self._GetRietveldConfig('private', error_ok=True)
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000927
ukai@chromium.orge8077812012-02-03 03:41:46 +0000928 def GetIsGerrit(self):
929 """Return true if this repo is assosiated with gerrit code review system."""
930 if self.is_gerrit is None:
931 self.is_gerrit = self._GetConfig('gerrit.host', error_ok=True)
932 return self.is_gerrit
933
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000934 def GetSquashGerritUploads(self):
935 """Return true if uploads to Gerrit should be squashed by default."""
936 if self.squash_gerrit_uploads is None:
tandriia60502f2016-06-20 02:01:53 -0700937 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
938 if self.squash_gerrit_uploads is None:
939 # Default is squash now (http://crbug.com/611892#c23).
940 self.squash_gerrit_uploads = not (
941 RunGit(['config', '--bool', 'gerrit.squash-uploads'],
942 error_ok=True).strip() == 'false')
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000943 return self.squash_gerrit_uploads
944
tandriia60502f2016-06-20 02:01:53 -0700945 def GetSquashGerritUploadsOverride(self):
946 """Return True or False if codereview.settings should be overridden.
947
948 Returns None if no override has been defined.
949 """
950 # See also http://crbug.com/611892#c23
951 result = RunGit(['config', '--bool', 'gerrit.override-squash-uploads'],
952 error_ok=True).strip()
953 if result == 'true':
954 return True
955 if result == 'false':
956 return False
957 return None
958
tandrii@chromium.org28253532016-04-14 13:46:56 +0000959 def GetGerritSkipEnsureAuthenticated(self):
960 """Return True if EnsureAuthenticated should not be done for Gerrit
961 uploads."""
962 if self.gerrit_skip_ensure_authenticated is None:
963 self.gerrit_skip_ensure_authenticated = (
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +0000964 RunGit(['config', '--bool', 'gerrit.skip-ensure-authenticated'],
tandrii@chromium.org28253532016-04-14 13:46:56 +0000965 error_ok=True).strip() == 'true')
966 return self.gerrit_skip_ensure_authenticated
967
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000968 def GetGitEditor(self):
969 """Return the editor specified in the git config, or None if none is."""
970 if self.git_editor is None:
971 self.git_editor = self._GetConfig('core.editor', error_ok=True)
972 return self.git_editor or None
973
thestig@chromium.org44202a22014-03-11 19:22:18 +0000974 def GetLintRegex(self):
975 return (self._GetRietveldConfig('cpplint-regex', error_ok=True) or
976 DEFAULT_LINT_REGEX)
977
978 def GetLintIgnoreRegex(self):
979 return (self._GetRietveldConfig('cpplint-ignore-regex', error_ok=True) or
980 DEFAULT_LINT_IGNORE_REGEX)
981
sheyang@chromium.org152cf832014-06-11 21:37:49 +0000982 def GetProject(self):
983 if not self.project:
984 self.project = self._GetRietveldConfig('project', error_ok=True)
985 return self.project
986
kjellander@chromium.org6abc6522014-12-02 07:34:49 +0000987 def GetForceHttpsCommitUrl(self):
988 if not self.force_https_commit_url:
989 self.force_https_commit_url = self._GetRietveldConfig(
990 'force-https-commit-url', error_ok=True)
991 return self.force_https_commit_url
992
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000993 def GetPendingRefPrefix(self):
994 if not self.pending_ref_prefix:
995 self.pending_ref_prefix = self._GetRietveldConfig(
996 'pending-ref-prefix', error_ok=True)
997 return self.pending_ref_prefix
998
tandriif46c20f2016-09-14 06:17:05 -0700999 def GetHasGitNumberFooter(self):
1000 # TODO(tandrii): this has to be removed after Rietveld is read-only.
1001 # see also bugs http://crbug.com/642493 and http://crbug.com/600469.
1002 if not self.git_number_footer:
1003 self.git_number_footer = self._GetRietveldConfig(
1004 'git-number-footer', error_ok=True)
1005 return self.git_number_footer
1006
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001007 def _GetRietveldConfig(self, param, **kwargs):
1008 return self._GetConfig('rietveld.' + param, **kwargs)
1009
rmistry@google.com78948ed2015-07-08 23:09:57 +00001010 def _GetBranchConfig(self, branch_name, param, **kwargs):
1011 return self._GetConfig('branch.' + branch_name + '.' + param, **kwargs)
1012
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001013 def _GetConfig(self, param, **kwargs):
1014 self.LazyUpdateIfNeeded()
1015 return RunGit(['config', param], **kwargs).strip()
1016
1017
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001018def ShortBranchName(branch):
1019 """Convert a name like 'refs/heads/foo' to just 'foo'."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001020 return branch.replace('refs/heads/', '', 1)
1021
1022
1023def GetCurrentBranchRef():
1024 """Returns branch ref (e.g., refs/heads/master) or None."""
1025 return RunGit(['symbolic-ref', 'HEAD'],
1026 stderr=subprocess2.VOID, error_ok=True).strip() or None
1027
1028
1029def GetCurrentBranch():
1030 """Returns current branch or None.
1031
1032 For refs/heads/* branches, returns just last part. For others, full ref.
1033 """
1034 branchref = GetCurrentBranchRef()
1035 if branchref:
1036 return ShortBranchName(branchref)
1037 return None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001038
1039
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001040class _CQState(object):
1041 """Enum for states of CL with respect to Commit Queue."""
1042 NONE = 'none'
1043 DRY_RUN = 'dry_run'
1044 COMMIT = 'commit'
1045
1046 ALL_STATES = [NONE, DRY_RUN, COMMIT]
1047
1048
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001049class _ParsedIssueNumberArgument(object):
1050 def __init__(self, issue=None, patchset=None, hostname=None):
1051 self.issue = issue
1052 self.patchset = patchset
1053 self.hostname = hostname
1054
1055 @property
1056 def valid(self):
1057 return self.issue is not None
1058
1059
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001060def ParseIssueNumberArgument(arg):
1061 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
1062 fail_result = _ParsedIssueNumberArgument()
1063
1064 if arg.isdigit():
1065 return _ParsedIssueNumberArgument(issue=int(arg))
1066 if not arg.startswith('http'):
1067 return fail_result
1068 url = gclient_utils.UpgradeToHttps(arg)
1069 try:
1070 parsed_url = urlparse.urlparse(url)
1071 except ValueError:
1072 return fail_result
1073 for cls in _CODEREVIEW_IMPLEMENTATIONS.itervalues():
1074 tmp = cls.ParseIssueURL(parsed_url)
1075 if tmp is not None:
1076 return tmp
1077 return fail_result
1078
1079
tandriic2405f52016-10-10 08:13:15 -07001080class GerritIssueNotExists(Exception):
1081 def __init__(self, issue, url):
1082 self.issue = issue
1083 self.url = url
1084 super(GerritIssueNotExists, self).__init__()
1085
1086 def __str__(self):
1087 return 'issue %s at %s does not exist or you have no access to it' % (
1088 self.issue, self.url)
1089
1090
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001091class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001092 """Changelist works with one changelist in local branch.
1093
1094 Supports two codereview backends: Rietveld or Gerrit, selected at object
1095 creation.
1096
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00001097 Notes:
1098 * Not safe for concurrent multi-{thread,process} use.
1099 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -07001100 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001101 """
1102
1103 def __init__(self, branchref=None, issue=None, codereview=None, **kwargs):
1104 """Create a new ChangeList instance.
1105
1106 If issue is given, the codereview must be given too.
1107
1108 If `codereview` is given, it must be 'rietveld' or 'gerrit'.
1109 Otherwise, it's decided based on current configuration of the local branch,
1110 with default being 'rietveld' for backwards compatibility.
1111 See _load_codereview_impl for more details.
1112
1113 **kwargs will be passed directly to codereview implementation.
1114 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001115 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +00001116 global settings
1117 if not settings:
1118 # Happens when git_cl.py is used as a utility library.
1119 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001120
1121 if issue:
1122 assert codereview, 'codereview must be known, if issue is known'
1123
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001124 self.branchref = branchref
1125 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00001126 assert branchref.startswith('refs/heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001127 self.branch = ShortBranchName(self.branchref)
1128 else:
1129 self.branch = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001130 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001131 self.lookedup_issue = False
1132 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001133 self.has_description = False
1134 self.description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001135 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001136 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001137 self.cc = None
1138 self.watchers = ()
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001139 self._remote = None
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001140
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001141 self._codereview_impl = None
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001142 self._codereview = None
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001143 self._load_codereview_impl(codereview, **kwargs)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001144 assert self._codereview_impl
1145 assert self._codereview in _CODEREVIEW_IMPLEMENTATIONS
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001146
1147 def _load_codereview_impl(self, codereview=None, **kwargs):
1148 if codereview:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001149 assert codereview in _CODEREVIEW_IMPLEMENTATIONS
1150 cls = _CODEREVIEW_IMPLEMENTATIONS[codereview]
1151 self._codereview = codereview
1152 self._codereview_impl = cls(self, **kwargs)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001153 return
1154
1155 # Automatic selection based on issue number set for a current branch.
1156 # Rietveld takes precedence over Gerrit.
1157 assert not self.issue
1158 # Whether we find issue or not, we are doing the lookup.
1159 self.lookedup_issue = True
tandrii5d48c322016-08-18 16:19:37 -07001160 if self.GetBranch():
1161 for codereview, cls in _CODEREVIEW_IMPLEMENTATIONS.iteritems():
1162 issue = _git_get_branch_config_value(
1163 cls.IssueConfigKey(), value_type=int, branch=self.GetBranch())
1164 if issue:
1165 self._codereview = codereview
1166 self._codereview_impl = cls(self, **kwargs)
1167 self.issue = int(issue)
1168 return
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001169
1170 # No issue is set for this branch, so decide based on repo-wide settings.
1171 return self._load_codereview_impl(
1172 codereview='gerrit' if settings.GetIsGerrit() else 'rietveld',
1173 **kwargs)
1174
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001175 def IsGerrit(self):
1176 return self._codereview == 'gerrit'
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001177
1178 def GetCCList(self):
1179 """Return the users cc'd on this CL.
1180
agable92bec4f2016-08-24 09:27:27 -07001181 Return is a string suitable for passing to git cl with the --cc flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001182 """
1183 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001184 base_cc = settings.GetDefaultCCList()
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001185 more_cc = ','.join(self.watchers)
1186 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1187 return self.cc
1188
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001189 def GetCCListWithoutDefault(self):
1190 """Return the users cc'd on this CL excluding default ones."""
1191 if self.cc is None:
1192 self.cc = ','.join(self.watchers)
1193 return self.cc
1194
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001195 def SetWatchers(self, watchers):
1196 """Set the list of email addresses that should be cc'd based on the changed
1197 files in this CL.
1198 """
1199 self.watchers = watchers
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001200
1201 def GetBranch(self):
1202 """Returns the short branch name, e.g. 'master'."""
1203 if not self.branch:
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001204 branchref = GetCurrentBranchRef()
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001205 if not branchref:
1206 return None
1207 self.branchref = branchref
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001208 self.branch = ShortBranchName(self.branchref)
1209 return self.branch
1210
1211 def GetBranchRef(self):
1212 """Returns the full branch name, e.g. 'refs/heads/master'."""
1213 self.GetBranch() # Poke the lazy loader.
1214 return self.branchref
1215
tandrii@chromium.org534f67a2016-04-07 18:47:05 +00001216 def ClearBranch(self):
1217 """Clears cached branch data of this object."""
1218 self.branch = self.branchref = None
1219
tandrii5d48c322016-08-18 16:19:37 -07001220 def _GitGetBranchConfigValue(self, key, default=None, **kwargs):
1221 assert 'branch' not in kwargs, 'this CL branch is used automatically'
1222 kwargs['branch'] = self.GetBranch()
1223 return _git_get_branch_config_value(key, default, **kwargs)
1224
1225 def _GitSetBranchConfigValue(self, key, value, **kwargs):
1226 assert 'branch' not in kwargs, 'this CL branch is used automatically'
1227 assert self.GetBranch(), (
1228 'this CL must have an associated branch to %sset %s%s' %
1229 ('un' if value is None else '',
1230 key,
1231 '' if value is None else ' to %r' % value))
1232 kwargs['branch'] = self.GetBranch()
1233 return _git_set_branch_config_value(key, value, **kwargs)
1234
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001235 @staticmethod
1236 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001237 """Returns a tuple containing remote and remote ref,
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001238 e.g. 'origin', 'refs/heads/master'
1239 """
1240 remote = '.'
tandrii5d48c322016-08-18 16:19:37 -07001241 upstream_branch = _git_get_branch_config_value('merge', branch=branch)
1242
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001243 if upstream_branch:
tandrii5d48c322016-08-18 16:19:37 -07001244 remote = _git_get_branch_config_value('remote', branch=branch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001245 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +00001246 upstream_branch = RunGit(['config', 'rietveld.upstream-branch'],
1247 error_ok=True).strip()
1248 if upstream_branch:
1249 remote = RunGit(['config', 'rietveld.upstream-remote']).strip()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001250 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +00001251 # Fall back on trying a git-svn upstream branch.
1252 if settings.GetIsGitSvn():
1253 upstream_branch = settings.GetSVNBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001254 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +00001255 # Else, try to guess the origin remote.
1256 remote_branches = RunGit(['branch', '-r']).split()
1257 if 'origin/master' in remote_branches:
1258 # Fall back on origin/master if it exits.
1259 remote = 'origin'
1260 upstream_branch = 'refs/heads/master'
1261 elif 'origin/trunk' in remote_branches:
1262 # Fall back on origin/trunk if it exists. Generally a shared
1263 # git-svn clone
1264 remote = 'origin'
1265 upstream_branch = 'refs/heads/trunk'
1266 else:
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001267 DieWithError(
1268 'Unable to determine default branch to diff against.\n'
1269 'Either pass complete "git diff"-style arguments, like\n'
1270 ' git cl upload origin/master\n'
1271 'or verify this branch is set up to track another \n'
1272 '(via the --track argument to "git checkout -b ...").')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001273
1274 return remote, upstream_branch
1275
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001276 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001277 upstream_branch = self.GetUpstreamBranch()
1278 if not BranchExists(upstream_branch):
1279 DieWithError('The upstream for the current branch (%s) does not exist '
1280 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001281 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001282 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001283
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001284 def GetUpstreamBranch(self):
1285 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001286 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001287 if remote is not '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001288 upstream_branch = upstream_branch.replace('refs/heads/',
1289 'refs/remotes/%s/' % remote)
1290 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1291 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001292 self.upstream_branch = upstream_branch
1293 return self.upstream_branch
1294
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001295 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001296 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001297 remote, branch = None, self.GetBranch()
1298 seen_branches = set()
1299 while branch not in seen_branches:
1300 seen_branches.add(branch)
1301 remote, branch = self.FetchUpstreamTuple(branch)
1302 branch = ShortBranchName(branch)
1303 if remote != '.' or branch.startswith('refs/remotes'):
1304 break
1305 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001306 remotes = RunGit(['remote'], error_ok=True).split()
1307 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001308 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001309 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001310 remote = 'origin'
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001311 logging.warning('Could not determine which remote this change is '
1312 'associated with, so defaulting to "%s". This may '
1313 'not be what you want. You may prevent this message '
1314 'by running "git svn info" as documented here: %s',
1315 self._remote,
1316 GIT_INSTRUCTIONS_URL)
1317 else:
1318 logging.warn('Could not determine which remote this change is '
1319 'associated with. You may prevent this message by '
1320 'running "git svn info" as documented here: %s',
1321 GIT_INSTRUCTIONS_URL)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001322 branch = 'HEAD'
1323 if branch.startswith('refs/remotes'):
1324 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001325 elif branch.startswith('refs/branch-heads/'):
1326 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001327 else:
1328 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001329 return self._remote
1330
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001331 def GitSanityChecks(self, upstream_git_obj):
1332 """Checks git repo status and ensures diff is from local commits."""
1333
sbc@chromium.org79706062015-01-14 21:18:12 +00001334 if upstream_git_obj is None:
1335 if self.GetBranch() is None:
vapiera7fbd5a2016-06-16 09:17:49 -07001336 print('ERROR: unable to determine current branch (detached HEAD?)',
1337 file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001338 else:
vapiera7fbd5a2016-06-16 09:17:49 -07001339 print('ERROR: no upstream branch', file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001340 return False
1341
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001342 # Verify the commit we're diffing against is in our current branch.
1343 upstream_sha = RunGit(['rev-parse', '--verify', upstream_git_obj]).strip()
1344 common_ancestor = RunGit(['merge-base', upstream_sha, 'HEAD']).strip()
1345 if upstream_sha != common_ancestor:
vapiera7fbd5a2016-06-16 09:17:49 -07001346 print('ERROR: %s is not in the current branch. You may need to rebase '
1347 'your tracking branch' % upstream_sha, file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001348 return False
1349
1350 # List the commits inside the diff, and verify they are all local.
1351 commits_in_diff = RunGit(
1352 ['rev-list', '^%s' % upstream_sha, 'HEAD']).splitlines()
1353 code, remote_branch = RunGitWithCode(['config', 'gitcl.remotebranch'])
1354 remote_branch = remote_branch.strip()
1355 if code != 0:
1356 _, remote_branch = self.GetRemoteBranch()
1357
1358 commits_in_remote = RunGit(
1359 ['rev-list', '^%s' % upstream_sha, remote_branch]).splitlines()
1360
1361 common_commits = set(commits_in_diff) & set(commits_in_remote)
1362 if common_commits:
vapiera7fbd5a2016-06-16 09:17:49 -07001363 print('ERROR: Your diff contains %d commits already in %s.\n'
1364 'Run "git log --oneline %s..HEAD" to get a list of commits in '
1365 'the diff. If you are using a custom git flow, you can override'
1366 ' the reference used for this check with "git config '
1367 'gitcl.remotebranch <git-ref>".' % (
1368 len(common_commits), remote_branch, upstream_git_obj),
1369 file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001370 return False
1371 return True
1372
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001373 def GetGitBaseUrlFromConfig(self):
sheyang@chromium.orga656e702014-05-15 20:43:05 +00001374 """Return the configured base URL from branch.<branchname>.baseurl.
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001375
1376 Returns None if it is not set.
1377 """
tandrii5d48c322016-08-18 16:19:37 -07001378 return self._GitGetBranchConfigValue('base-url')
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001379
kjellander@chromium.org6abc6522014-12-02 07:34:49 +00001380 def GetGitSvnRemoteUrl(self):
1381 """Return the configured git-svn remote URL parsed from git svn info.
1382
1383 Returns None if it is not set.
1384 """
1385 # URL is dependent on the current directory.
1386 data = RunGit(['svn', 'info'], cwd=settings.GetRoot())
1387 if data:
1388 keys = dict(line.split(': ', 1) for line in data.splitlines()
1389 if ': ' in line)
1390 return keys.get('URL', None)
1391 return None
1392
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001393 def GetRemoteUrl(self):
1394 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1395
1396 Returns None if there is no remote.
1397 """
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001398 remote, _ = self.GetRemoteBranch()
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001399 url = RunGit(['config', 'remote.%s.url' % remote], error_ok=True).strip()
1400
1401 # If URL is pointing to a local directory, it is probably a git cache.
1402 if os.path.isdir(url):
1403 url = RunGit(['config', 'remote.%s.url' % remote],
1404 error_ok=True,
1405 cwd=url).strip()
1406 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001407
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001408 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001409 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001410 if self.issue is None and not self.lookedup_issue:
tandrii5d48c322016-08-18 16:19:37 -07001411 self.issue = self._GitGetBranchConfigValue(
1412 self._codereview_impl.IssueConfigKey(), value_type=int)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001413 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001414 return self.issue
1415
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001416 def GetIssueURL(self):
1417 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001418 issue = self.GetIssue()
1419 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001420 return None
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001421 return '%s/%s' % (self._codereview_impl.GetCodereviewServer(), issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001422
1423 def GetDescription(self, pretty=False):
1424 if not self.has_description:
1425 if self.GetIssue():
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001426 self.description = self._codereview_impl.FetchDescription()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001427 self.has_description = True
1428 if pretty:
1429 wrapper = textwrap.TextWrapper()
1430 wrapper.initial_indent = wrapper.subsequent_indent = ' '
1431 return wrapper.fill(self.description)
1432 return self.description
1433
1434 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001435 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001436 if self.patchset is None and not self.lookedup_patchset:
tandrii5d48c322016-08-18 16:19:37 -07001437 self.patchset = self._GitGetBranchConfigValue(
1438 self._codereview_impl.PatchsetConfigKey(), value_type=int)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001439 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001440 return self.patchset
1441
1442 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001443 """Set this branch's patchset. If patchset=0, clears the patchset."""
1444 assert self.GetBranch()
1445 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001446 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001447 else:
1448 self.patchset = int(patchset)
1449 self._GitSetBranchConfigValue(
1450 self._codereview_impl.PatchsetConfigKey(), self.patchset)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001451
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001452 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001453 """Set this branch's issue. If issue isn't given, clears the issue."""
1454 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001455 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001456 issue = int(issue)
1457 self._GitSetBranchConfigValue(
1458 self._codereview_impl.IssueConfigKey(), issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001459 self.issue = issue
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001460 codereview_server = self._codereview_impl.GetCodereviewServer()
1461 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001462 self._GitSetBranchConfigValue(
1463 self._codereview_impl.CodereviewServerConfigKey(),
1464 codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001465 else:
tandrii5d48c322016-08-18 16:19:37 -07001466 # Reset all of these just to be clean.
1467 reset_suffixes = [
1468 'last-upload-hash',
1469 self._codereview_impl.IssueConfigKey(),
1470 self._codereview_impl.PatchsetConfigKey(),
1471 self._codereview_impl.CodereviewServerConfigKey(),
1472 ] + self._PostUnsetIssueProperties()
1473 for prop in reset_suffixes:
1474 self._GitSetBranchConfigValue(prop, None, error_ok=True)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001475 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001476 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001477
dnjba1b0f32016-09-02 12:37:42 -07001478 def GetChange(self, upstream_branch, author, local_description=False):
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001479 if not self.GitSanityChecks(upstream_branch):
1480 DieWithError('\nGit sanity check failure')
1481
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001482 root = settings.GetRelativeRoot()
bratell@opera.comf267b0e2013-05-02 09:11:43 +00001483 if not root:
1484 root = '.'
bauerb@chromium.org512f1ef2011-04-20 15:17:57 +00001485 absroot = os.path.abspath(root)
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001486
1487 # We use the sha1 of HEAD as a name of this change.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001488 name = RunGitWithCode(['rev-parse', 'HEAD'])[1].strip()
bauerb@chromium.org512f1ef2011-04-20 15:17:57 +00001489 # Need to pass a relative path for msysgit.
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001490 try:
maruel@chromium.org80a9ef12011-12-13 20:44:10 +00001491 files = scm.GIT.CaptureStatus([root], '.', upstream_branch)
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001492 except subprocess2.CalledProcessError:
1493 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001494 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001495 'This branch probably doesn\'t exist anymore. To reset the\n'
1496 'tracking branch, please run\n'
stip7a3dd352016-09-22 17:32:28 -07001497 ' git branch --set-upstream-to origin/master %s\n'
1498 'or replace origin/master with the relevant branch') %
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001499 (upstream_branch, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001500
maruel@chromium.org52424302012-08-29 15:14:30 +00001501 issue = self.GetIssue()
1502 patchset = self.GetPatchset()
dnjba1b0f32016-09-02 12:37:42 -07001503 if issue and not local_description:
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001504 description = self.GetDescription()
1505 else:
1506 # If the change was never uploaded, use the log messages of all commits
1507 # up to the branch point, as git cl upload will prefill the description
1508 # with these log messages.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001509 args = ['log', '--pretty=format:%s%n%n%b', '%s...' % (upstream_branch)]
1510 description = RunGitWithCode(args)[1].strip()
maruel@chromium.org03b3bdc2011-06-14 13:04:12 +00001511
1512 if not author:
maruel@chromium.org13f623c2011-07-22 16:02:23 +00001513 author = RunGit(['config', 'user.email']).strip() or None
asvitkine@chromium.org15169952011-09-27 14:30:53 +00001514 return presubmit_support.GitChange(
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001515 name,
1516 description,
1517 absroot,
1518 files,
1519 issue,
1520 patchset,
agable@chromium.orgea84ef12014-04-30 19:55:12 +00001521 author,
1522 upstream=upstream_branch)
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001523
dsansomee2d6fd92016-09-08 00:10:47 -07001524 def UpdateDescription(self, description, force=False):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001525 self.description = description
dsansomee2d6fd92016-09-08 00:10:47 -07001526 return self._codereview_impl.UpdateDescriptionRemote(
1527 description, force=force)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001528
1529 def RunHook(self, committing, may_prompt, verbose, change):
1530 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1531 try:
1532 return presubmit_support.DoPresubmitChecks(change, committing,
1533 verbose=verbose, output_stream=sys.stdout, input_stream=sys.stdin,
1534 default_presubmit=None, may_prompt=may_prompt,
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001535 rietveld_obj=self._codereview_impl.GetRieveldObjForPresubmit(),
1536 gerrit_obj=self._codereview_impl.GetGerritObjForPresubmit())
vapierfd77ac72016-06-16 08:33:57 -07001537 except presubmit_support.PresubmitFailure as e:
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001538 DieWithError(
1539 ('%s\nMaybe your depot_tools is out of date?\n'
1540 'If all fails, contact maruel@') % e)
1541
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001542 def CMDPatchIssue(self, issue_arg, reject, nocommit, directory):
1543 """Fetches and applies the issue patch from codereview to local branch."""
tandrii@chromium.orgef7c68c2016-04-07 09:39:39 +00001544 if isinstance(issue_arg, (int, long)) or issue_arg.isdigit():
1545 parsed_issue_arg = _ParsedIssueNumberArgument(int(issue_arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001546 else:
1547 # Assume url.
1548 parsed_issue_arg = self._codereview_impl.ParseIssueURL(
1549 urlparse.urlparse(issue_arg))
1550 if not parsed_issue_arg or not parsed_issue_arg.valid:
1551 DieWithError('Failed to parse issue argument "%s". '
1552 'Must be an issue number or a valid URL.' % issue_arg)
1553 return self._codereview_impl.CMDPatchWithParsedIssue(
1554 parsed_issue_arg, reject, nocommit, directory)
1555
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001556 def CMDUpload(self, options, git_diff_args, orig_args):
1557 """Uploads a change to codereview."""
1558 if git_diff_args:
1559 # TODO(ukai): is it ok for gerrit case?
1560 base_branch = git_diff_args[0]
1561 else:
1562 if self.GetBranch() is None:
1563 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1564
1565 # Default to diffing against common ancestor of upstream branch
1566 base_branch = self.GetCommonAncestorWithUpstream()
1567 git_diff_args = [base_branch, 'HEAD']
1568
1569 # Make sure authenticated to codereview before running potentially expensive
1570 # hooks. It is a fast, best efforts check. Codereview still can reject the
1571 # authentication during the actual upload.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001572 self._codereview_impl.EnsureAuthenticated(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001573
1574 # Apply watchlists on upload.
1575 change = self.GetChange(base_branch, None)
1576 watchlist = watchlists.Watchlists(change.RepositoryRoot())
1577 files = [f.LocalPath() for f in change.AffectedFiles()]
1578 if not options.bypass_watchlists:
1579 self.SetWatchers(watchlist.GetWatchersForPaths(files))
1580
1581 if not options.bypass_hooks:
1582 if options.reviewers or options.tbr_owners:
1583 # Set the reviewer list now so that presubmit checks can access it.
1584 change_description = ChangeDescription(change.FullDescriptionText())
1585 change_description.update_reviewers(options.reviewers,
1586 options.tbr_owners,
1587 change)
1588 change.SetDescriptionText(change_description.description)
1589 hook_results = self.RunHook(committing=False,
1590 may_prompt=not options.force,
1591 verbose=options.verbose,
1592 change=change)
1593 if not hook_results.should_continue():
1594 return 1
1595 if not options.reviewers and hook_results.reviewers:
1596 options.reviewers = hook_results.reviewers.split(',')
1597
Ravi Mistryfda50ca2016-11-14 10:19:18 -05001598 # TODO(tandrii): Checking local patchset against remote patchset is only
1599 # supported for Rietveld. Extend it to Gerrit or remove it completely.
1600 if self.GetIssue() and not self.IsGerrit():
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001601 latest_patchset = self.GetMostRecentPatchset()
1602 local_patchset = self.GetPatchset()
1603 if (latest_patchset and local_patchset and
1604 local_patchset != latest_patchset):
vapiera7fbd5a2016-06-16 09:17:49 -07001605 print('The last upload made from this repository was patchset #%d but '
1606 'the most recent patchset on the server is #%d.'
1607 % (local_patchset, latest_patchset))
1608 print('Uploading will still work, but if you\'ve uploaded to this '
1609 'issue from another machine or branch the patch you\'re '
1610 'uploading now might not include those changes.')
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001611 ask_for_data('About to upload; enter to confirm.')
1612
1613 print_stats(options.similarity, options.find_copies, git_diff_args)
1614 ret = self.CMDUploadChange(options, git_diff_args, change)
1615 if not ret:
tandrii4d0545a2016-07-06 03:56:49 -07001616 if options.use_commit_queue:
1617 self.SetCQState(_CQState.COMMIT)
1618 elif options.cq_dry_run:
1619 self.SetCQState(_CQState.DRY_RUN)
1620
tandrii5d48c322016-08-18 16:19:37 -07001621 _git_set_branch_config_value('last-upload-hash',
1622 RunGit(['rev-parse', 'HEAD']).strip())
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001623 # Run post upload hooks, if specified.
1624 if settings.GetRunPostUploadHook():
1625 presubmit_support.DoPostUploadExecuter(
1626 change,
1627 self,
1628 settings.GetRoot(),
1629 options.verbose,
1630 sys.stdout)
1631
1632 # Upload all dependencies if specified.
1633 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001634 print()
1635 print('--dependencies has been specified.')
1636 print('All dependent local branches will be re-uploaded.')
1637 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001638 # Remove the dependencies flag from args so that we do not end up in a
1639 # loop.
1640 orig_args.remove('--dependencies')
1641 ret = upload_branch_deps(self, orig_args)
1642 return ret
1643
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001644 def SetCQState(self, new_state):
1645 """Update the CQ state for latest patchset.
1646
1647 Issue must have been already uploaded and known.
1648 """
1649 assert new_state in _CQState.ALL_STATES
1650 assert self.GetIssue()
1651 return self._codereview_impl.SetCQState(new_state)
1652
qyearsley1fdfcb62016-10-24 13:22:03 -07001653 def TriggerDryRun(self):
1654 """Triggers a dry run and prints a warning on failure."""
1655 # TODO(qyearsley): Either re-use this method in CMDset_commit
1656 # and CMDupload, or change CMDtry to trigger dry runs with
1657 # just SetCQState, and catch keyboard interrupt and other
1658 # errors in that method.
1659 try:
1660 self.SetCQState(_CQState.DRY_RUN)
1661 print('scheduled CQ Dry Run on %s' % self.GetIssueURL())
1662 return 0
1663 except KeyboardInterrupt:
1664 raise
1665 except:
1666 print('WARNING: failed to trigger CQ Dry Run.\n'
1667 'Either:\n'
1668 ' * your project has no CQ\n'
1669 ' * you don\'t have permission to trigger Dry Run\n'
1670 ' * bug in this code (see stack trace below).\n'
1671 'Consider specifying which bots to trigger manually '
1672 'or asking your project owners for permissions '
1673 'or contacting Chrome Infrastructure team at '
1674 'https://www.chromium.org/infra\n\n')
1675 # Still raise exception so that stack trace is printed.
1676 raise
1677
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001678 # Forward methods to codereview specific implementation.
1679
1680 def CloseIssue(self):
1681 return self._codereview_impl.CloseIssue()
1682
1683 def GetStatus(self):
1684 return self._codereview_impl.GetStatus()
1685
1686 def GetCodereviewServer(self):
1687 return self._codereview_impl.GetCodereviewServer()
1688
tandriide281ae2016-10-12 06:02:30 -07001689 def GetIssueOwner(self):
1690 """Get owner from codereview, which may differ from this checkout."""
1691 return self._codereview_impl.GetIssueOwner()
1692
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001693 def GetApprovingReviewers(self):
1694 return self._codereview_impl.GetApprovingReviewers()
1695
1696 def GetMostRecentPatchset(self):
1697 return self._codereview_impl.GetMostRecentPatchset()
1698
tandriide281ae2016-10-12 06:02:30 -07001699 def CannotTriggerTryJobReason(self):
1700 """Returns reason (str) if unable trigger tryjobs on this CL or None."""
1701 return self._codereview_impl.CannotTriggerTryJobReason()
1702
tandrii8c5a3532016-11-04 07:52:02 -07001703 def GetTryjobProperties(self, patchset=None):
1704 """Returns dictionary of properties to launch tryjob."""
1705 return self._codereview_impl.GetTryjobProperties(patchset=patchset)
1706
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001707 def __getattr__(self, attr):
1708 # This is because lots of untested code accesses Rietveld-specific stuff
1709 # directly, and it's hard to fix for sure. So, just let it work, and fix
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00001710 # on a case by case basis.
tandrii4d895502016-08-18 08:26:19 -07001711 # Note that child method defines __getattr__ as well, and forwards it here,
1712 # because _RietveldChangelistImpl is not cleaned up yet, and given
1713 # deprecation of Rietveld, it should probably be just removed.
1714 # Until that time, avoid infinite recursion by bypassing __getattr__
1715 # of implementation class.
1716 return self._codereview_impl.__getattribute__(attr)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001717
1718
1719class _ChangelistCodereviewBase(object):
1720 """Abstract base class encapsulating codereview specifics of a changelist."""
1721 def __init__(self, changelist):
1722 self._changelist = changelist # instance of Changelist
1723
1724 def __getattr__(self, attr):
1725 # Forward methods to changelist.
1726 # TODO(tandrii): maybe clean up _GerritChangelistImpl and
1727 # _RietveldChangelistImpl to avoid this hack?
1728 return getattr(self._changelist, attr)
1729
1730 def GetStatus(self):
1731 """Apply a rough heuristic to give a simple summary of an issue's review
1732 or CQ status, assuming adherence to a common workflow.
1733
1734 Returns None if no issue for this branch, or specific string keywords.
1735 """
1736 raise NotImplementedError()
1737
1738 def GetCodereviewServer(self):
1739 """Returns server URL without end slash, like "https://codereview.com"."""
1740 raise NotImplementedError()
1741
1742 def FetchDescription(self):
1743 """Fetches and returns description from the codereview server."""
1744 raise NotImplementedError()
1745
tandrii5d48c322016-08-18 16:19:37 -07001746 @classmethod
1747 def IssueConfigKey(cls):
1748 """Returns branch setting storing issue number."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001749 raise NotImplementedError()
1750
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001751 @classmethod
tandrii5d48c322016-08-18 16:19:37 -07001752 def PatchsetConfigKey(cls):
1753 """Returns branch setting storing patchset number."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001754 raise NotImplementedError()
1755
tandrii5d48c322016-08-18 16:19:37 -07001756 @classmethod
1757 def CodereviewServerConfigKey(cls):
1758 """Returns branch setting storing codereview server."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001759 raise NotImplementedError()
1760
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001761 def _PostUnsetIssueProperties(self):
1762 """Which branch-specific properties to erase when unsettin issue."""
tandrii5d48c322016-08-18 16:19:37 -07001763 return []
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001764
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001765 def GetRieveldObjForPresubmit(self):
1766 # This is an unfortunate Rietveld-embeddedness in presubmit.
1767 # For non-Rietveld codereviews, this probably should return a dummy object.
1768 raise NotImplementedError()
1769
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001770 def GetGerritObjForPresubmit(self):
1771 # None is valid return value, otherwise presubmit_support.GerritAccessor.
1772 return None
1773
dsansomee2d6fd92016-09-08 00:10:47 -07001774 def UpdateDescriptionRemote(self, description, force=False):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001775 """Update the description on codereview site."""
1776 raise NotImplementedError()
1777
1778 def CloseIssue(self):
1779 """Closes the issue."""
1780 raise NotImplementedError()
1781
1782 def GetApprovingReviewers(self):
1783 """Returns a list of reviewers approving the change.
1784
1785 Note: not necessarily committers.
1786 """
1787 raise NotImplementedError()
1788
1789 def GetMostRecentPatchset(self):
1790 """Returns the most recent patchset number from the codereview site."""
1791 raise NotImplementedError()
1792
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001793 def CMDPatchWithParsedIssue(self, parsed_issue_arg, reject, nocommit,
1794 directory):
1795 """Fetches and applies the issue.
1796
1797 Arguments:
1798 parsed_issue_arg: instance of _ParsedIssueNumberArgument.
1799 reject: if True, reject the failed patch instead of switching to 3-way
1800 merge. Rietveld only.
1801 nocommit: do not commit the patch, thus leave the tree dirty. Rietveld
1802 only.
1803 directory: switch to directory before applying the patch. Rietveld only.
1804 """
1805 raise NotImplementedError()
1806
1807 @staticmethod
1808 def ParseIssueURL(parsed_url):
1809 """Parses url and returns instance of _ParsedIssueNumberArgument or None if
1810 failed."""
1811 raise NotImplementedError()
1812
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001813 def EnsureAuthenticated(self, force):
1814 """Best effort check that user is authenticated with codereview server.
1815
1816 Arguments:
1817 force: whether to skip confirmation questions.
1818 """
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001819 raise NotImplementedError()
1820
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00001821 def CMDUploadChange(self, options, args, change):
1822 """Uploads a change to codereview."""
1823 raise NotImplementedError()
1824
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001825 def SetCQState(self, new_state):
1826 """Update the CQ state for latest patchset.
1827
1828 Issue must have been already uploaded and known.
1829 """
1830 raise NotImplementedError()
1831
tandriie113dfd2016-10-11 10:20:12 -07001832 def CannotTriggerTryJobReason(self):
1833 """Returns reason (str) if unable trigger tryjobs on this CL or None."""
1834 raise NotImplementedError()
1835
tandriide281ae2016-10-12 06:02:30 -07001836 def GetIssueOwner(self):
1837 raise NotImplementedError()
1838
tandrii8c5a3532016-11-04 07:52:02 -07001839 def GetTryjobProperties(self, patchset=None):
tandriide281ae2016-10-12 06:02:30 -07001840 raise NotImplementedError()
1841
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001842
1843class _RietveldChangelistImpl(_ChangelistCodereviewBase):
1844 def __init__(self, changelist, auth_config=None, rietveld_server=None):
1845 super(_RietveldChangelistImpl, self).__init__(changelist)
1846 assert settings, 'must be initialized in _ChangelistCodereviewBase'
martiniss6eda05f2016-06-30 10:18:35 -07001847 if not rietveld_server:
1848 settings.GetDefaultServerUrl()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001849
1850 self._rietveld_server = rietveld_server
1851 self._auth_config = auth_config
1852 self._props = None
1853 self._rpc_server = None
1854
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001855 def GetCodereviewServer(self):
1856 if not self._rietveld_server:
1857 # If we're on a branch then get the server potentially associated
1858 # with that branch.
1859 if self.GetIssue():
tandrii5d48c322016-08-18 16:19:37 -07001860 self._rietveld_server = gclient_utils.UpgradeToHttps(
1861 self._GitGetBranchConfigValue(self.CodereviewServerConfigKey()))
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001862 if not self._rietveld_server:
1863 self._rietveld_server = settings.GetDefaultServerUrl()
1864 return self._rietveld_server
1865
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001866 def EnsureAuthenticated(self, force):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001867 """Best effort check that user is authenticated with Rietveld server."""
1868 if self._auth_config.use_oauth2:
1869 authenticator = auth.get_authenticator_for_host(
1870 self.GetCodereviewServer(), self._auth_config)
1871 if not authenticator.has_cached_credentials():
1872 raise auth.LoginRequiredError(self.GetCodereviewServer())
1873
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001874 def FetchDescription(self):
1875 issue = self.GetIssue()
1876 assert issue
1877 try:
1878 return self.RpcServer().get_description(issue).strip()
1879 except urllib2.HTTPError as e:
1880 if e.code == 404:
1881 DieWithError(
1882 ('\nWhile fetching the description for issue %d, received a '
1883 '404 (not found)\n'
1884 'error. It is likely that you deleted this '
1885 'issue on the server. If this is the\n'
1886 'case, please run\n\n'
1887 ' git cl issue 0\n\n'
1888 'to clear the association with the deleted issue. Then run '
1889 'this command again.') % issue)
1890 else:
1891 DieWithError(
1892 '\nFailed to fetch issue description. HTTP error %d' % e.code)
1893 except urllib2.URLError as e:
vapiera7fbd5a2016-06-16 09:17:49 -07001894 print('Warning: Failed to retrieve CL description due to network '
1895 'failure.', file=sys.stderr)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001896 return ''
1897
1898 def GetMostRecentPatchset(self):
1899 return self.GetIssueProperties()['patchsets'][-1]
1900
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001901 def GetIssueProperties(self):
1902 if self._props is None:
1903 issue = self.GetIssue()
1904 if not issue:
1905 self._props = {}
1906 else:
1907 self._props = self.RpcServer().get_issue_properties(issue, True)
1908 return self._props
1909
tandriie113dfd2016-10-11 10:20:12 -07001910 def CannotTriggerTryJobReason(self):
1911 props = self.GetIssueProperties()
1912 if not props:
1913 return 'Rietveld doesn\'t know about your issue %s' % self.GetIssue()
1914 if props.get('closed'):
1915 return 'CL %s is closed' % self.GetIssue()
1916 if props.get('private'):
1917 return 'CL %s is private' % self.GetIssue()
1918 return None
1919
tandrii8c5a3532016-11-04 07:52:02 -07001920 def GetTryjobProperties(self, patchset=None):
1921 """Returns dictionary of properties to launch tryjob."""
1922 project = (self.GetIssueProperties() or {}).get('project')
1923 return {
1924 'issue': self.GetIssue(),
1925 'patch_project': project,
1926 'patch_storage': 'rietveld',
1927 'patchset': patchset or self.GetPatchset(),
1928 'rietveld': self.GetCodereviewServer(),
1929 }
1930
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001931 def GetApprovingReviewers(self):
1932 return get_approving_reviewers(self.GetIssueProperties())
1933
tandriide281ae2016-10-12 06:02:30 -07001934 def GetIssueOwner(self):
1935 return (self.GetIssueProperties() or {}).get('owner_email')
1936
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001937 def AddComment(self, message):
1938 return self.RpcServer().add_comment(self.GetIssue(), message)
1939
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00001940 def GetStatus(self):
1941 """Apply a rough heuristic to give a simple summary of an issue's review
1942 or CQ status, assuming adherence to a common workflow.
1943
1944 Returns None if no issue for this branch, or one of the following keywords:
1945 * 'error' - error from review tool (including deleted issues)
1946 * 'unsent' - not sent for review
1947 * 'waiting' - waiting for review
1948 * 'reply' - waiting for owner to reply to review
1949 * 'lgtm' - LGTM from at least one approved reviewer
1950 * 'commit' - in the commit queue
1951 * 'closed' - closed
1952 """
1953 if not self.GetIssue():
1954 return None
1955
1956 try:
1957 props = self.GetIssueProperties()
1958 except urllib2.HTTPError:
1959 return 'error'
1960
1961 if props.get('closed'):
1962 # Issue is closed.
1963 return 'closed'
tandrii@chromium.orgb4f6a222016-03-03 01:11:04 +00001964 if props.get('commit') and not props.get('cq_dry_run', False):
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00001965 # Issue is in the commit queue.
1966 return 'commit'
1967
1968 try:
1969 reviewers = self.GetApprovingReviewers()
1970 except urllib2.HTTPError:
1971 return 'error'
1972
1973 if reviewers:
1974 # Was LGTM'ed.
1975 return 'lgtm'
1976
1977 messages = props.get('messages') or []
1978
tandrii9d2c7a32016-06-22 03:42:45 -07001979 # Skip CQ messages that don't require owner's action.
1980 while messages and messages[-1]['sender'] == COMMIT_BOT_EMAIL:
1981 if 'Dry run:' in messages[-1]['text']:
1982 messages.pop()
1983 elif 'The CQ bit was unchecked' in messages[-1]['text']:
1984 # This message always follows prior messages from CQ,
1985 # so skip this too.
1986 messages.pop()
1987 else:
1988 # This is probably a CQ messages warranting user attention.
1989 break
1990
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00001991 if not messages:
1992 # No message was sent.
1993 return 'unsent'
1994 if messages[-1]['sender'] != props.get('owner_email'):
tandrii9d2c7a32016-06-22 03:42:45 -07001995 # Non-LGTM reply from non-owner and not CQ bot.
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00001996 return 'reply'
1997 return 'waiting'
1998
dsansomee2d6fd92016-09-08 00:10:47 -07001999 def UpdateDescriptionRemote(self, description, force=False):
maruel@chromium.orgb021b322013-04-08 17:57:29 +00002000 return self.RpcServer().update_description(
2001 self.GetIssue(), self.description)
2002
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002003 def CloseIssue(self):
maruel@chromium.orgb021b322013-04-08 17:57:29 +00002004 return self.RpcServer().close_issue(self.GetIssue())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002005
maruel@chromium.org27bb3872011-05-30 20:33:19 +00002006 def SetFlag(self, flag, value):
tandrii4b233bd2016-07-06 03:50:29 -07002007 return self.SetFlags({flag: value})
2008
2009 def SetFlags(self, flags):
2010 """Sets flags on this CL/patchset in Rietveld.
tandrii4b233bd2016-07-06 03:50:29 -07002011 """
phajdan.jr68598232016-08-10 03:28:28 -07002012 patchset = self.GetPatchset() or self.GetMostRecentPatchset()
maruel@chromium.org27bb3872011-05-30 20:33:19 +00002013 try:
tandrii4b233bd2016-07-06 03:50:29 -07002014 return self.RpcServer().set_flags(
phajdan.jr68598232016-08-10 03:28:28 -07002015 self.GetIssue(), patchset, flags)
vapierfd77ac72016-06-16 08:33:57 -07002016 except urllib2.HTTPError as e:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00002017 if e.code == 404:
2018 DieWithError('The issue %s doesn\'t exist.' % self.GetIssue())
2019 if e.code == 403:
2020 DieWithError(
2021 ('Access denied to issue %s. Maybe the patchset %s doesn\'t '
phajdan.jr68598232016-08-10 03:28:28 -07002022 'match?') % (self.GetIssue(), patchset))
maruel@chromium.org27bb3872011-05-30 20:33:19 +00002023 raise
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002024
maruel@chromium.orgcab38e92011-04-09 00:30:51 +00002025 def RpcServer(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002026 """Returns an upload.RpcServer() to access this review's rietveld instance.
2027 """
maruel@chromium.orge77ebbf2011-03-29 20:35:38 +00002028 if not self._rpc_server:
maruel@chromium.org4bac4b52012-11-27 20:33:52 +00002029 self._rpc_server = rietveld.CachingRietveld(
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002030 self.GetCodereviewServer(),
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00002031 self._auth_config or auth.make_auth_config())
maruel@chromium.orge77ebbf2011-03-29 20:35:38 +00002032 return self._rpc_server
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002033
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00002034 @classmethod
tandrii5d48c322016-08-18 16:19:37 -07002035 def IssueConfigKey(cls):
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00002036 return 'rietveldissue'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002037
tandrii5d48c322016-08-18 16:19:37 -07002038 @classmethod
2039 def PatchsetConfigKey(cls):
2040 return 'rietveldpatchset'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002041
tandrii5d48c322016-08-18 16:19:37 -07002042 @classmethod
2043 def CodereviewServerConfigKey(cls):
2044 return 'rietveldserver'
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00002045
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002046 def GetRieveldObjForPresubmit(self):
2047 return self.RpcServer()
2048
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002049 def SetCQState(self, new_state):
2050 props = self.GetIssueProperties()
2051 if props.get('private'):
2052 DieWithError('Cannot set-commit on private issue')
2053
2054 if new_state == _CQState.COMMIT:
tandrii4d843592016-07-27 08:22:56 -07002055 self.SetFlags({'commit': '1', 'cq_dry_run': '0'})
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002056 elif new_state == _CQState.NONE:
tandrii4b233bd2016-07-06 03:50:29 -07002057 self.SetFlags({'commit': '0', 'cq_dry_run': '0'})
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002058 else:
tandrii4b233bd2016-07-06 03:50:29 -07002059 assert new_state == _CQState.DRY_RUN
2060 self.SetFlags({'commit': '1', 'cq_dry_run': '1'})
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002061
2062
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002063 def CMDPatchWithParsedIssue(self, parsed_issue_arg, reject, nocommit,
2064 directory):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002065 # PatchIssue should never be called with a dirty tree. It is up to the
2066 # caller to check this, but just in case we assert here since the
2067 # consequences of the caller not checking this could be dire.
2068 assert(not git_common.is_dirty_git_tree('apply'))
2069 assert(parsed_issue_arg.valid)
2070 self._changelist.issue = parsed_issue_arg.issue
2071 if parsed_issue_arg.hostname:
2072 self._rietveld_server = 'https://%s' % parsed_issue_arg.hostname
2073
skobes6468b902016-10-24 08:45:10 -07002074 patchset = parsed_issue_arg.patchset or self.GetMostRecentPatchset()
2075 patchset_object = self.RpcServer().get_patch(self.GetIssue(), patchset)
2076 scm_obj = checkout.GitCheckout(settings.GetRoot(), None, None, None, None)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002077 try:
skobes6468b902016-10-24 08:45:10 -07002078 scm_obj.apply_patch(patchset_object)
2079 except Exception as e:
2080 print(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002081 return 1
2082
2083 # If we had an issue, commit the current state and register the issue.
2084 if not nocommit:
2085 RunGit(['commit', '-m', (self.GetDescription() + '\n\n' +
2086 'patch from issue %(i)s at patchset '
2087 '%(p)s (http://crrev.com/%(i)s#ps%(p)s)'
2088 % {'i': self.GetIssue(), 'p': patchset})])
2089 self.SetIssue(self.GetIssue())
2090 self.SetPatchset(patchset)
vapiera7fbd5a2016-06-16 09:17:49 -07002091 print('Committed patch locally.')
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002092 else:
vapiera7fbd5a2016-06-16 09:17:49 -07002093 print('Patch applied to index.')
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002094 return 0
2095
2096 @staticmethod
2097 def ParseIssueURL(parsed_url):
2098 if not parsed_url.scheme or not parsed_url.scheme.startswith('http'):
2099 return None
wychen3c1c1722016-08-04 11:46:36 -07002100 # Rietveld patch: https://domain/<number>/#ps<patchset>
2101 match = re.match(r'/(\d+)/$', parsed_url.path)
2102 match2 = re.match(r'ps(\d+)$', parsed_url.fragment)
2103 if match and match2:
skobes6468b902016-10-24 08:45:10 -07002104 return _ParsedIssueNumberArgument(
wychen3c1c1722016-08-04 11:46:36 -07002105 issue=int(match.group(1)),
2106 patchset=int(match2.group(1)),
2107 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002108 # Typical url: https://domain/<issue_number>[/[other]]
2109 match = re.match('/(\d+)(/.*)?$', parsed_url.path)
2110 if match:
skobes6468b902016-10-24 08:45:10 -07002111 return _ParsedIssueNumberArgument(
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002112 issue=int(match.group(1)),
2113 hostname=parsed_url.netloc)
2114 # Rietveld patch: https://domain/download/issue<number>_<patchset>.diff
2115 match = re.match(r'/download/issue(\d+)_(\d+).diff$', parsed_url.path)
2116 if match:
skobes6468b902016-10-24 08:45:10 -07002117 return _ParsedIssueNumberArgument(
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002118 issue=int(match.group(1)),
2119 patchset=int(match.group(2)),
skobes6468b902016-10-24 08:45:10 -07002120 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002121 return None
2122
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002123 def CMDUploadChange(self, options, args, change):
2124 """Upload the patch to Rietveld."""
2125 upload_args = ['--assume_yes'] # Don't ask about untracked files.
2126 upload_args.extend(['--server', self.GetCodereviewServer()])
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002127 upload_args.extend(auth.auth_config_to_command_options(self._auth_config))
2128 if options.emulate_svn_auto_props:
2129 upload_args.append('--emulate_svn_auto_props')
2130
2131 change_desc = None
2132
2133 if options.email is not None:
2134 upload_args.extend(['--email', options.email])
2135
2136 if self.GetIssue():
nodirca166002016-06-27 10:59:51 -07002137 if options.title is not None:
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002138 upload_args.extend(['--title', options.title])
2139 if options.message:
2140 upload_args.extend(['--message', options.message])
2141 upload_args.extend(['--issue', str(self.GetIssue())])
vapiera7fbd5a2016-06-16 09:17:49 -07002142 print('This branch is associated with issue %s. '
2143 'Adding patch to that issue.' % self.GetIssue())
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002144 else:
nodirca166002016-06-27 10:59:51 -07002145 if options.title is not None:
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002146 upload_args.extend(['--title', options.title])
2147 message = (options.title or options.message or
2148 CreateDescriptionFromLog(args))
2149 change_desc = ChangeDescription(message)
2150 if options.reviewers or options.tbr_owners:
2151 change_desc.update_reviewers(options.reviewers,
2152 options.tbr_owners,
2153 change)
2154 if not options.force:
tandriif9aefb72016-07-01 09:06:51 -07002155 change_desc.prompt(bug=options.bug)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002156
2157 if not change_desc.description:
vapiera7fbd5a2016-06-16 09:17:49 -07002158 print('Description is empty; aborting.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002159 return 1
2160
2161 upload_args.extend(['--message', change_desc.description])
2162 if change_desc.get_reviewers():
2163 upload_args.append('--reviewers=%s' % ','.join(
2164 change_desc.get_reviewers()))
2165 if options.send_mail:
2166 if not change_desc.get_reviewers():
2167 DieWithError("Must specify reviewers to send email.")
2168 upload_args.append('--send_mail')
2169
2170 # We check this before applying rietveld.private assuming that in
2171 # rietveld.cc only addresses which we can send private CLs to are listed
2172 # if rietveld.private is set, and so we should ignore rietveld.cc only
2173 # when --private is specified explicitly on the command line.
2174 if options.private:
2175 logging.warn('rietveld.cc is ignored since private flag is specified. '
2176 'You need to review and add them manually if necessary.')
2177 cc = self.GetCCListWithoutDefault()
2178 else:
2179 cc = self.GetCCList()
2180 cc = ','.join(filter(None, (cc, ','.join(options.cc))))
bradnelsond975b302016-10-23 12:20:23 -07002181 if change_desc.get_cced():
2182 cc = ','.join(filter(None, (cc, ','.join(change_desc.get_cced()))))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002183 if cc:
2184 upload_args.extend(['--cc', cc])
2185
2186 if options.private or settings.GetDefaultPrivateFlag() == "True":
2187 upload_args.append('--private')
2188
2189 upload_args.extend(['--git_similarity', str(options.similarity)])
2190 if not options.find_copies:
2191 upload_args.extend(['--git_no_find_copies'])
2192
2193 # Include the upstream repo's URL in the change -- this is useful for
2194 # projects that have their source spread across multiple repos.
2195 remote_url = self.GetGitBaseUrlFromConfig()
2196 if not remote_url:
2197 if settings.GetIsGitSvn():
2198 remote_url = self.GetGitSvnRemoteUrl()
2199 else:
2200 if self.GetRemoteUrl() and '/' in self.GetUpstreamBranch():
2201 remote_url = '%s@%s' % (self.GetRemoteUrl(),
2202 self.GetUpstreamBranch().split('/')[-1])
2203 if remote_url:
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002204 remote, remote_branch = self.GetRemoteBranch()
2205 target_ref = GetTargetRef(remote, remote_branch, options.target_branch,
2206 settings.GetPendingRefPrefix())
2207 if target_ref:
2208 upload_args.extend(['--target_ref', target_ref])
2209
2210 # Look for dependent patchsets. See crbug.com/480453 for more details.
2211 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
2212 upstream_branch = ShortBranchName(upstream_branch)
2213 if remote is '.':
2214 # A local branch is being tracked.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00002215 local_branch = upstream_branch
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002216 if settings.GetIsSkipDependencyUpload(local_branch):
vapiera7fbd5a2016-06-16 09:17:49 -07002217 print()
2218 print('Skipping dependency patchset upload because git config '
2219 'branch.%s.skip-deps-uploads is set to True.' % local_branch)
2220 print()
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002221 else:
2222 auth_config = auth.extract_auth_config_from_options(options)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00002223 branch_cl = Changelist(branchref='refs/heads/'+local_branch,
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002224 auth_config=auth_config)
2225 branch_cl_issue_url = branch_cl.GetIssueURL()
2226 branch_cl_issue = branch_cl.GetIssue()
2227 branch_cl_patchset = branch_cl.GetPatchset()
2228 if branch_cl_issue_url and branch_cl_issue and branch_cl_patchset:
2229 upload_args.extend(
2230 ['--depends_on_patchset', '%s:%s' % (
2231 branch_cl_issue, branch_cl_patchset)])
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00002232 print(
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002233 '\n'
2234 'The current branch (%s) is tracking a local branch (%s) with '
2235 'an associated CL.\n'
2236 'Adding %s/#ps%s as a dependency patchset.\n'
2237 '\n' % (self.GetBranch(), local_branch, branch_cl_issue_url,
2238 branch_cl_patchset))
2239
2240 project = settings.GetProject()
2241 if project:
2242 upload_args.extend(['--project', project])
2243
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002244 try:
2245 upload_args = ['upload'] + upload_args + args
2246 logging.info('upload.RealMain(%s)', upload_args)
2247 issue, patchset = upload.RealMain(upload_args)
2248 issue = int(issue)
2249 patchset = int(patchset)
2250 except KeyboardInterrupt:
2251 sys.exit(1)
2252 except:
2253 # If we got an exception after the user typed a description for their
2254 # change, back up the description before re-raising.
2255 if change_desc:
2256 backup_path = os.path.expanduser(DESCRIPTION_BACKUP_FILE)
2257 print('\nGot exception while uploading -- saving description to %s\n' %
2258 backup_path)
2259 backup_file = open(backup_path, 'w')
2260 backup_file.write(change_desc.description)
2261 backup_file.close()
2262 raise
2263
2264 if not self.GetIssue():
2265 self.SetIssue(issue)
2266 self.SetPatchset(patchset)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002267 return 0
2268
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002269
2270class _GerritChangelistImpl(_ChangelistCodereviewBase):
2271 def __init__(self, changelist, auth_config=None):
2272 # auth_config is Rietveld thing, kept here to preserve interface only.
2273 super(_GerritChangelistImpl, self).__init__(changelist)
2274 self._change_id = None
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00002275 # Lazily cached values.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002276 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00002277 self._gerrit_host = None # e.g. chromium-review.googlesource.com
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002278
2279 def _GetGerritHost(self):
2280 # Lazy load of configs.
2281 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07002282 if self._gerrit_host and '.' not in self._gerrit_host:
2283 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
2284 # This happens for internal stuff http://crbug.com/614312.
2285 parsed = urlparse.urlparse(self.GetRemoteUrl())
2286 if parsed.scheme == 'sso':
2287 print('WARNING: using non https URLs for remote is likely broken\n'
2288 ' Your current remote is: %s' % self.GetRemoteUrl())
2289 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
2290 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002291 return self._gerrit_host
2292
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00002293 def _GetGitHost(self):
2294 """Returns git host to be used when uploading change to Gerrit."""
2295 return urlparse.urlparse(self.GetRemoteUrl()).netloc
2296
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002297 def GetCodereviewServer(self):
2298 if not self._gerrit_server:
2299 # If we're on a branch then get the server potentially associated
2300 # with that branch.
2301 if self.GetIssue():
tandrii5d48c322016-08-18 16:19:37 -07002302 self._gerrit_server = self._GitGetBranchConfigValue(
2303 self.CodereviewServerConfigKey())
2304 if self._gerrit_server:
2305 self._gerrit_host = urlparse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002306 if not self._gerrit_server:
2307 # We assume repo to be hosted on Gerrit, and hence Gerrit server
2308 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00002309 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002310 parts[0] = parts[0] + '-review'
2311 self._gerrit_host = '.'.join(parts)
2312 self._gerrit_server = 'https://%s' % self._gerrit_host
2313 return self._gerrit_server
2314
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00002315 @classmethod
tandrii5d48c322016-08-18 16:19:37 -07002316 def IssueConfigKey(cls):
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00002317 return 'gerritissue'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002318
tandrii5d48c322016-08-18 16:19:37 -07002319 @classmethod
2320 def PatchsetConfigKey(cls):
2321 return 'gerritpatchset'
2322
2323 @classmethod
2324 def CodereviewServerConfigKey(cls):
2325 return 'gerritserver'
2326
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00002327 def EnsureAuthenticated(self, force):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00002328 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00002329 if settings.GetGerritSkipEnsureAuthenticated():
2330 # For projects with unusual authentication schemes.
2331 # See http://crbug.com/603378.
2332 return
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00002333 # Lazy-loader to identify Gerrit and Git hosts.
2334 if gerrit_util.GceAuthenticator.is_gce():
2335 return
2336 self.GetCodereviewServer()
2337 git_host = self._GetGitHost()
2338 assert self._gerrit_server and self._gerrit_host
2339 cookie_auth = gerrit_util.CookiesAuthenticator()
2340
2341 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
2342 git_auth = cookie_auth.get_auth_header(git_host)
2343 if gerrit_auth and git_auth:
2344 if gerrit_auth == git_auth:
2345 return
2346 print((
2347 'WARNING: you have different credentials for Gerrit and git hosts.\n'
2348 ' Check your %s or %s file for credentials of hosts:\n'
2349 ' %s\n'
2350 ' %s\n'
2351 ' %s') %
2352 (cookie_auth.get_gitcookies_path(), cookie_auth.get_netrc_path(),
2353 git_host, self._gerrit_host,
2354 cookie_auth.get_new_password_message(git_host)))
2355 if not force:
2356 ask_for_data('If you know what you are doing, press Enter to continue, '
2357 'Ctrl+C to abort.')
2358 return
2359 else:
2360 missing = (
2361 [] if gerrit_auth else [self._gerrit_host] +
2362 [] if git_auth else [git_host])
2363 DieWithError('Credentials for the following hosts are required:\n'
2364 ' %s\n'
2365 'These are read from %s (or legacy %s)\n'
2366 '%s' % (
2367 '\n '.join(missing),
2368 cookie_auth.get_gitcookies_path(),
2369 cookie_auth.get_netrc_path(),
2370 cookie_auth.get_new_password_message(git_host)))
2371
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00002372 def _PostUnsetIssueProperties(self):
2373 """Which branch-specific properties to erase when unsetting issue."""
tandrii5d48c322016-08-18 16:19:37 -07002374 return ['gerritsquashhash']
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00002375
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002376 def GetRieveldObjForPresubmit(self):
2377 class ThisIsNotRietveldIssue(object):
2378 def __nonzero__(self):
2379 # This is a hack to make presubmit_support think that rietveld is not
2380 # defined, yet still ensure that calls directly result in a decent
2381 # exception message below.
2382 return False
2383
2384 def __getattr__(self, attr):
2385 print(
2386 'You aren\'t using Rietveld at the moment, but Gerrit.\n'
2387 'Using Rietveld in your PRESUBMIT scripts won\'t work.\n'
2388 'Please, either change your PRESUBIT to not use rietveld_obj.%s,\n'
2389 'or use Rietveld for codereview.\n'
2390 'See also http://crbug.com/579160.' % attr)
2391 raise NotImplementedError()
2392 return ThisIsNotRietveldIssue()
2393
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00002394 def GetGerritObjForPresubmit(self):
2395 return presubmit_support.GerritAccessor(self._GetGerritHost())
2396
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002397 def GetStatus(self):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002398 """Apply a rough heuristic to give a simple summary of an issue's review
2399 or CQ status, assuming adherence to a common workflow.
2400
2401 Returns None if no issue for this branch, or one of the following keywords:
2402 * 'error' - error from review tool (including deleted issues)
2403 * 'unsent' - no reviewers added
2404 * 'waiting' - waiting for review
2405 * 'reply' - waiting for owner to reply to review
tandriic2405f52016-10-10 08:13:15 -07002406 * 'not lgtm' - Code-Review disaproval from at least one valid reviewer
2407 * 'lgtm' - Code-Review approval from at least one valid reviewer
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002408 * 'commit' - in the commit queue
2409 * 'closed' - abandoned
2410 """
2411 if not self.GetIssue():
2412 return None
2413
2414 try:
2415 data = self._GetChangeDetail(['DETAILED_LABELS', 'CURRENT_REVISION'])
tandriic2405f52016-10-10 08:13:15 -07002416 except (httplib.HTTPException, GerritIssueNotExists):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002417 return 'error'
2418
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00002419 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002420 return 'closed'
2421
2422 cq_label = data['labels'].get('Commit-Queue', {})
2423 if cq_label:
rmistryc9ebbd22016-10-14 12:35:54 -07002424 votes = cq_label.get('all', [])
2425 highest_vote = 0
2426 for v in votes:
2427 highest_vote = max(highest_vote, v.get('value', 0))
2428 vote_value = str(highest_vote)
2429 if vote_value != '0':
2430 # Add a '+' if the value is not 0 to match the values in the label.
2431 # The cq_label does not have negatives.
2432 vote_value = '+' + vote_value
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002433 vote_text = cq_label.get('values', {}).get(vote_value, '')
2434 if vote_text.lower() == 'commit':
2435 return 'commit'
2436
2437 lgtm_label = data['labels'].get('Code-Review', {})
2438 if lgtm_label:
2439 if 'rejected' in lgtm_label:
2440 return 'not lgtm'
2441 if 'approved' in lgtm_label:
2442 return 'lgtm'
2443
2444 if not data.get('reviewers', {}).get('REVIEWER', []):
2445 return 'unsent'
2446
2447 messages = data.get('messages', [])
2448 if messages:
2449 owner = data['owner'].get('_account_id')
2450 last_message_author = messages[-1].get('author', {}).get('_account_id')
2451 if owner != last_message_author:
2452 # Some reply from non-owner.
2453 return 'reply'
2454
2455 return 'waiting'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002456
2457 def GetMostRecentPatchset(self):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002458 data = self._GetChangeDetail(['CURRENT_REVISION'])
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002459 return data['revisions'][data['current_revision']]['_number']
2460
2461 def FetchDescription(self):
tandrii@chromium.org2d3da632016-04-25 19:23:27 +00002462 data = self._GetChangeDetail(['CURRENT_REVISION'])
2463 current_rev = data['current_revision']
2464 url = data['revisions'][current_rev]['fetch']['http']['url']
2465 return gerrit_util.GetChangeDescriptionFromGitiles(url, current_rev)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002466
dsansomee2d6fd92016-09-08 00:10:47 -07002467 def UpdateDescriptionRemote(self, description, force=False):
2468 if gerrit_util.HasPendingChangeEdit(self._GetGerritHost(), self.GetIssue()):
2469 if not force:
2470 ask_for_data(
2471 'The description cannot be modified while the issue has a pending '
2472 'unpublished edit. Either publish the edit in the Gerrit web UI '
2473 'or delete it.\n\n'
2474 'Press Enter to delete the unpublished edit, Ctrl+C to abort.')
2475
2476 gerrit_util.DeletePendingChangeEdit(self._GetGerritHost(),
2477 self.GetIssue())
scottmg@chromium.org6d1266e2016-04-26 11:12:26 +00002478 gerrit_util.SetCommitMessage(self._GetGerritHost(), self.GetIssue(),
2479 description)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002480
2481 def CloseIssue(self):
2482 gerrit_util.AbandonChange(self._GetGerritHost(), self.GetIssue(), msg='')
2483
tandrii@chromium.org600b4922016-04-26 10:57:52 +00002484 def GetApprovingReviewers(self):
2485 """Returns a list of reviewers approving the change.
2486
2487 Note: not necessarily committers.
2488 """
2489 raise NotImplementedError()
2490
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002491 def SubmitIssue(self, wait_for_merge=True):
2492 gerrit_util.SubmitChange(self._GetGerritHost(), self.GetIssue(),
2493 wait_for_merge=wait_for_merge)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002494
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002495 def _GetChangeDetail(self, options=None, issue=None):
2496 options = options or []
2497 issue = issue or self.GetIssue()
tandriic2405f52016-10-10 08:13:15 -07002498 assert issue, 'issue is required to query Gerrit'
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002499 try:
2500 data = gerrit_util.GetChangeDetail(self._GetGerritHost(), str(issue),
2501 options, ignore_404=False)
2502 except gerrit_util.GerritError as e:
2503 if e.http_status == 404:
2504 raise GerritIssueNotExists(issue, self.GetCodereviewServer())
2505 raise
tandriic2405f52016-10-10 08:13:15 -07002506 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002507
agable32978d92016-11-01 12:55:02 -07002508 def _GetChangeCommit(self, issue=None):
2509 issue = issue or self.GetIssue()
2510 assert issue, 'issue is required to query Gerrit'
2511 data = gerrit_util.GetChangeCommit(self._GetGerritHost(), str(issue))
2512 if not data:
2513 raise GerritIssueNotExists(issue, self.GetCodereviewServer())
2514 return data
2515
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002516 def CMDLand(self, force, bypass_hooks, verbose):
2517 if git_common.is_dirty_git_tree('land'):
2518 return 1
tandriid60367b2016-06-22 05:25:12 -07002519 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
2520 if u'Commit-Queue' in detail.get('labels', {}):
2521 if not force:
2522 ask_for_data('\nIt seems this repository has a Commit Queue, '
2523 'which can test and land changes for you. '
2524 'Are you sure you wish to bypass it?\n'
2525 'Press Enter to continue, Ctrl+C to abort.')
2526
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002527 differs = True
tandriic4344b52016-08-29 06:04:54 -07002528 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002529 # Note: git diff outputs nothing if there is no diff.
2530 if not last_upload or RunGit(['diff', last_upload]).strip():
2531 print('WARNING: some changes from local branch haven\'t been uploaded')
2532 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002533 if detail['current_revision'] == last_upload:
2534 differs = False
2535 else:
2536 print('WARNING: local branch contents differ from latest uploaded '
2537 'patchset')
2538 if differs:
2539 if not force:
2540 ask_for_data(
2541 'Do you want to submit latest Gerrit patchset and bypass hooks?')
2542 print('WARNING: bypassing hooks and submitting latest uploaded patchset')
2543 elif not bypass_hooks:
2544 hook_results = self.RunHook(
2545 committing=True,
2546 may_prompt=not force,
2547 verbose=verbose,
2548 change=self.GetChange(self.GetCommonAncestorWithUpstream(), None))
2549 if not hook_results.should_continue():
2550 return 1
2551
2552 self.SubmitIssue(wait_for_merge=True)
2553 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002554 links = self._GetChangeCommit().get('web_links', [])
2555 for link in links:
2556 if link.get('name') == 'gerrit' and link.get('url'):
2557 print('Landed as %s' % link.get('url'))
2558 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002559 return 0
2560
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002561 def CMDPatchWithParsedIssue(self, parsed_issue_arg, reject, nocommit,
2562 directory):
2563 assert not reject
2564 assert not nocommit
2565 assert not directory
2566 assert parsed_issue_arg.valid
2567
2568 self._changelist.issue = parsed_issue_arg.issue
2569
2570 if parsed_issue_arg.hostname:
2571 self._gerrit_host = parsed_issue_arg.hostname
2572 self._gerrit_server = 'https://%s' % self._gerrit_host
2573
tandriic2405f52016-10-10 08:13:15 -07002574 try:
2575 detail = self._GetChangeDetail(['ALL_REVISIONS'])
2576 except GerritIssueNotExists as e:
2577 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002578
2579 if not parsed_issue_arg.patchset:
2580 # Use current revision by default.
2581 revision_info = detail['revisions'][detail['current_revision']]
2582 patchset = int(revision_info['_number'])
2583 else:
2584 patchset = parsed_issue_arg.patchset
2585 for revision_info in detail['revisions'].itervalues():
2586 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2587 break
2588 else:
2589 DieWithError('Couldn\'t find patchset %i in issue %i' %
2590 (parsed_issue_arg.patchset, self.GetIssue()))
2591
2592 fetch_info = revision_info['fetch']['http']
2593 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
2594 RunGit(['cherry-pick', 'FETCH_HEAD'])
2595 self.SetIssue(self.GetIssue())
2596 self.SetPatchset(patchset)
2597 print('Committed patch for issue %i pathset %i locally' %
2598 (self.GetIssue(), self.GetPatchset()))
2599 return 0
2600
2601 @staticmethod
2602 def ParseIssueURL(parsed_url):
2603 if not parsed_url.scheme or not parsed_url.scheme.startswith('http'):
2604 return None
2605 # Gerrit's new UI is https://domain/c/<issue_number>[/[patchset]]
2606 # But current GWT UI is https://domain/#/c/<issue_number>[/[patchset]]
2607 # Short urls like https://domain/<issue_number> can be used, but don't allow
2608 # specifying the patchset (you'd 404), but we allow that here.
2609 if parsed_url.path == '/':
2610 part = parsed_url.fragment
2611 else:
2612 part = parsed_url.path
2613 match = re.match('(/c)?/(\d+)(/(\d+)?/?)?$', part)
2614 if match:
2615 return _ParsedIssueNumberArgument(
2616 issue=int(match.group(2)),
2617 patchset=int(match.group(4)) if match.group(4) else None,
2618 hostname=parsed_url.netloc)
2619 return None
2620
tandrii16e0b4e2016-06-07 10:34:28 -07002621 def _GerritCommitMsgHookCheck(self, offer_removal):
2622 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2623 if not os.path.exists(hook):
2624 return
2625 # Crude attempt to distinguish Gerrit Codereview hook from potentially
2626 # custom developer made one.
2627 data = gclient_utils.FileRead(hook)
2628 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2629 return
2630 print('Warning: you have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002631 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002632 'and may interfere with it in subtle ways.\n'
2633 'We recommend you remove the commit-msg hook.')
2634 if offer_removal:
2635 reply = ask_for_data('Do you want to remove it now? [Yes/No]')
2636 if reply.lower().startswith('y'):
2637 gclient_utils.rm_file_or_tree(hook)
2638 print('Gerrit commit-msg hook removed.')
2639 else:
2640 print('OK, will keep Gerrit commit-msg hook in place.')
2641
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002642 def CMDUploadChange(self, options, args, change):
2643 """Upload the current branch to Gerrit."""
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00002644 if options.squash and options.no_squash:
2645 DieWithError('Can only use one of --squash or --no-squash')
tandriia60502f2016-06-20 02:01:53 -07002646
2647 if not options.squash and not options.no_squash:
2648 # Load default for user, repo, squash=true, in this order.
2649 options.squash = settings.GetSquashGerritUploads()
2650 elif options.no_squash:
2651 options.squash = False
tandrii26f3e4e2016-06-10 08:37:04 -07002652
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002653 # We assume the remote called "origin" is the one we want.
2654 # It is probably not worthwhile to support different workflows.
2655 gerrit_remote = 'origin'
2656
2657 remote, remote_branch = self.GetRemoteBranch()
2658 branch = GetTargetRef(remote, remote_branch, options.target_branch,
2659 pending_prefix='')
2660
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002661 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002662 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002663 if self.GetIssue():
2664 # Try to get the message from a previous upload.
2665 message = self.GetDescription()
2666 if not message:
2667 DieWithError(
2668 'failed to fetch description from current Gerrit issue %d\n'
2669 '%s' % (self.GetIssue(), self.GetIssueURL()))
2670 change_id = self._GetChangeDetail()['change_id']
2671 while True:
2672 footer_change_ids = git_footers.get_footer_change_id(message)
2673 if footer_change_ids == [change_id]:
2674 break
2675 if not footer_change_ids:
2676 message = git_footers.add_footer_change_id(message, change_id)
2677 print('WARNING: appended missing Change-Id to issue description')
2678 continue
2679 # There is already a valid footer but with different or several ids.
2680 # Doing this automatically is non-trivial as we don't want to lose
2681 # existing other footers, yet we want to append just 1 desired
2682 # Change-Id. Thus, just create a new footer, but let user verify the
2683 # new description.
2684 message = '%s\n\nChange-Id: %s' % (message, change_id)
2685 print(
2686 'WARNING: issue %s has Change-Id footer(s):\n'
2687 ' %s\n'
2688 'but issue has Change-Id %s, according to Gerrit.\n'
2689 'Please, check the proposed correction to the description, '
2690 'and edit it if necessary but keep the "Change-Id: %s" footer\n'
2691 % (self.GetIssue(), '\n '.join(footer_change_ids), change_id,
2692 change_id))
2693 ask_for_data('Press enter to edit now, Ctrl+C to abort')
2694 if not options.force:
2695 change_desc = ChangeDescription(message)
tandriif9aefb72016-07-01 09:06:51 -07002696 change_desc.prompt(bug=options.bug)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002697 message = change_desc.description
2698 if not message:
2699 DieWithError("Description is empty. Aborting...")
2700 # Continue the while loop.
2701 # Sanity check of this code - we should end up with proper message
2702 # footer.
2703 assert [change_id] == git_footers.get_footer_change_id(message)
2704 change_desc = ChangeDescription(message)
2705 else:
2706 change_desc = ChangeDescription(
2707 options.message or CreateDescriptionFromLog(args))
2708 if not options.force:
tandriif9aefb72016-07-01 09:06:51 -07002709 change_desc.prompt(bug=options.bug)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002710 if not change_desc.description:
2711 DieWithError("Description is empty. Aborting...")
2712 message = change_desc.description
2713 change_ids = git_footers.get_footer_change_id(message)
2714 if len(change_ids) > 1:
2715 DieWithError('too many Change-Id footers, at most 1 allowed.')
2716 if not change_ids:
2717 # Generate the Change-Id automatically.
2718 message = git_footers.add_footer_change_id(
2719 message, GenerateGerritChangeId(message))
2720 change_desc.set_description(message)
2721 change_ids = git_footers.get_footer_change_id(message)
2722 assert len(change_ids) == 1
2723 change_id = change_ids[0]
2724
2725 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
2726 if remote is '.':
2727 # If our upstream branch is local, we base our squashed commit on its
2728 # squashed version.
2729 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2730 # Check the squashed hash of the parent.
2731 parent = RunGit(['config',
2732 'branch.%s.gerritsquashhash' % upstream_branch_name],
2733 error_ok=True).strip()
2734 # Verify that the upstream branch has been uploaded too, otherwise
2735 # Gerrit will create additional CLs when uploading.
2736 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2737 RunGitSilent(['rev-parse', parent + ':'])):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002738 DieWithError(
2739 'Upload upstream branch %s first.\n'
tandrii2bdadf12016-07-12 12:27:54 -07002740 'Note: maybe you\'ve uploaded it with --no-squash. '
2741 'If so, then re-upload it with:\n'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002742 ' git cl upload --squash\n' % upstream_branch_name)
2743 else:
2744 parent = self.GetCommonAncestorWithUpstream()
2745
2746 tree = RunGit(['rev-parse', 'HEAD:']).strip()
2747 ref_to_push = RunGit(['commit-tree', tree, '-p', parent,
2748 '-m', message]).strip()
2749 else:
2750 change_desc = ChangeDescription(
2751 options.message or CreateDescriptionFromLog(args))
2752 if not change_desc.description:
2753 DieWithError("Description is empty. Aborting...")
2754
2755 if not git_footers.get_footer_change_id(change_desc.description):
2756 DownloadGerritHook(False)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002757 change_desc.set_description(self._AddChangeIdToCommitMessage(options,
2758 args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002759 ref_to_push = 'HEAD'
2760 parent = '%s/%s' % (gerrit_remote, branch)
2761 change_id = git_footers.get_footer_change_id(change_desc.description)[0]
2762
2763 assert change_desc
2764 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2765 ref_to_push)]).splitlines()
2766 if len(commits) > 1:
2767 print('WARNING: This will upload %d commits. Run the following command '
2768 'to see which commits will be uploaded: ' % len(commits))
2769 print('git log %s..%s' % (parent, ref_to_push))
2770 print('You can also use `git squash-branch` to squash these into a '
2771 'single commit.')
2772 ask_for_data('About to upload; enter to confirm.')
2773
2774 if options.reviewers or options.tbr_owners:
2775 change_desc.update_reviewers(options.reviewers, options.tbr_owners,
2776 change)
2777
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002778 # Extra options that can be specified at push time. Doc:
2779 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
2780 refspec_opts = []
tandrii99a72f22016-08-17 14:33:24 -07002781 if change_desc.get_reviewers(tbr_only=True):
2782 print('Adding self-LGTM (Code-Review +1) because of TBRs')
2783 refspec_opts.append('l=Code-Review+1')
2784
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002785 if options.title:
tandriieefe8322016-08-17 10:12:24 -07002786 if not re.match(r'^[\w ]+$', options.title):
2787 options.title = re.sub(r'[^\w ]', '', options.title)
2788 print('WARNING: Patchset title may only contain alphanumeric chars '
2789 'and spaces. Cleaned up title:\n%s' % options.title)
2790 if not options.force:
2791 ask_for_data('Press enter to continue, Ctrl+C to abort')
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002792 # Per doc, spaces must be converted to underscores, and Gerrit will do the
2793 # reverse on its side.
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002794 refspec_opts.append('m=' + options.title.replace(' ', '_'))
2795
tandrii@chromium.org8da45402016-05-24 23:11:03 +00002796 if options.send_mail:
2797 if not change_desc.get_reviewers():
2798 DieWithError('Must specify reviewers to send email.')
2799 refspec_opts.append('notify=ALL')
2800 else:
2801 refspec_opts.append('notify=NONE')
2802
tandrii99a72f22016-08-17 14:33:24 -07002803 reviewers = change_desc.get_reviewers()
2804 if reviewers:
2805 refspec_opts.extend('r=' + email.strip() for email in reviewers)
tandrii@chromium.org8acd8332016-04-13 12:56:03 +00002806
agablec6787972016-09-09 16:13:34 -07002807 if options.private:
2808 refspec_opts.append('draft')
2809
rmistry9eadede2016-09-19 11:22:43 -07002810 if options.topic:
2811 # Documentation on Gerrit topics is here:
2812 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
2813 refspec_opts.append('topic=%s' % options.topic)
2814
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002815 refspec_suffix = ''
2816 if refspec_opts:
2817 refspec_suffix = '%' + ','.join(refspec_opts)
2818 assert ' ' not in refspec_suffix, (
2819 'spaces not allowed in refspec: "%s"' % refspec_suffix)
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002820 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002821
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002822 push_stdout = gclient_utils.CheckCallAndFilter(
tandrii@chromium.org8acd8332016-04-13 12:56:03 +00002823 ['git', 'push', gerrit_remote, refspec],
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002824 print_stdout=True,
2825 # Flush after every line: useful for seeing progress when running as
2826 # recipe.
2827 filter_fn=lambda _: sys.stdout.flush())
2828
2829 if options.squash:
2830 regex = re.compile(r'remote:\s+https?://[\w\-\.\/]*/(\d+)\s.*')
2831 change_numbers = [m.group(1)
2832 for m in map(regex.match, push_stdout.splitlines())
2833 if m]
2834 if len(change_numbers) != 1:
2835 DieWithError(
2836 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
2837 'Change-Id: %s') % (len(change_numbers), change_id))
2838 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002839 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002840
2841 # Add cc's from the CC_LIST and --cc flag (if any).
2842 cc = self.GetCCList().split(',')
2843 if options.cc:
2844 cc.extend(options.cc)
2845 cc = filter(None, [email.strip() for email in cc])
bradnelsond975b302016-10-23 12:20:23 -07002846 if change_desc.get_cced():
2847 cc.extend(change_desc.get_cced())
tandrii88189772016-09-29 04:29:57 -07002848 if cc:
Aaron Gabledf86e302016-11-08 10:48:03 -08002849 errors = gerrit_util.AddReviewers(
tandrii88189772016-09-29 04:29:57 -07002850 self._GetGerritHost(), self.GetIssue(), cc, is_reviewer=False)
Aaron Gabledf86e302016-11-08 10:48:03 -08002851 if errors:
2852 return 1
tandrii88189772016-09-29 04:29:57 -07002853
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002854 return 0
2855
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002856 def _AddChangeIdToCommitMessage(self, options, args):
2857 """Re-commits using the current message, assumes the commit hook is in
2858 place.
2859 """
2860 log_desc = options.message or CreateDescriptionFromLog(args)
2861 git_command = ['commit', '--amend', '-m', log_desc]
2862 RunGit(git_command)
2863 new_log_desc = CreateDescriptionFromLog(args)
2864 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002865 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002866 return new_log_desc
2867 else:
tandrii@chromium.orgb067ec52016-05-31 15:24:44 +00002868 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002869
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002870 def SetCQState(self, new_state):
2871 """Sets the Commit-Queue label assuming canonical CQ config for Gerrit."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002872 vote_map = {
2873 _CQState.NONE: 0,
2874 _CQState.DRY_RUN: 1,
2875 _CQState.COMMIT : 2,
2876 }
2877 gerrit_util.SetReview(self._GetGerritHost(), self.GetIssue(),
2878 labels={'Commit-Queue': vote_map[new_state]})
2879
tandriie113dfd2016-10-11 10:20:12 -07002880 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002881 try:
2882 data = self._GetChangeDetail()
2883 except GerritIssueNotExists:
2884 return 'Gerrit doesn\'t know about your issue %s' % self.GetIssue()
2885
2886 if data['status'] in ('ABANDONED', 'MERGED'):
2887 return 'CL %s is closed' % self.GetIssue()
2888
2889 def GetTryjobProperties(self, patchset=None):
2890 """Returns dictionary of properties to launch tryjob."""
2891 data = self._GetChangeDetail(['ALL_REVISIONS'])
2892 patchset = int(patchset or self.GetPatchset())
2893 assert patchset
2894 revision_data = None # Pylint wants it to be defined.
2895 for revision_data in data['revisions'].itervalues():
2896 if int(revision_data['_number']) == patchset:
2897 break
2898 else:
2899 raise Exception('Patchset %d is not known in Gerrit issue %d' %
2900 (patchset, self.GetIssue()))
2901 return {
2902 'patch_issue': self.GetIssue(),
2903 'patch_set': patchset or self.GetPatchset(),
2904 'patch_project': data['project'],
2905 'patch_storage': 'gerrit',
2906 'patch_ref': revision_data['fetch']['http']['ref'],
2907 'patch_repository_url': revision_data['fetch']['http']['url'],
2908 'patch_gerrit_url': self.GetCodereviewServer(),
2909 }
tandriie113dfd2016-10-11 10:20:12 -07002910
tandriide281ae2016-10-12 06:02:30 -07002911 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002912 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002913
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002914
2915_CODEREVIEW_IMPLEMENTATIONS = {
2916 'rietveld': _RietveldChangelistImpl,
2917 'gerrit': _GerritChangelistImpl,
2918}
2919
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002920
iannuccie53c9352016-08-17 14:40:40 -07002921def _add_codereview_issue_select_options(parser, extra=""):
2922 _add_codereview_select_options(parser)
2923
2924 text = ('Operate on this issue number instead of the current branch\'s '
2925 'implicit issue.')
2926 if extra:
2927 text += ' '+extra
2928 parser.add_option('-i', '--issue', type=int, help=text)
2929
2930
2931def _process_codereview_issue_select_options(parser, options):
2932 _process_codereview_select_options(parser, options)
2933 if options.issue is not None and not options.forced_codereview:
2934 parser.error('--issue must be specified with either --rietveld or --gerrit')
2935
2936
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002937def _add_codereview_select_options(parser):
2938 """Appends --gerrit and --rietveld options to force specific codereview."""
2939 parser.codereview_group = optparse.OptionGroup(
2940 parser, 'EXPERIMENTAL! Codereview override options')
2941 parser.add_option_group(parser.codereview_group)
2942 parser.codereview_group.add_option(
2943 '--gerrit', action='store_true',
2944 help='Force the use of Gerrit for codereview')
2945 parser.codereview_group.add_option(
2946 '--rietveld', action='store_true',
2947 help='Force the use of Rietveld for codereview')
2948
2949
2950def _process_codereview_select_options(parser, options):
2951 if options.gerrit and options.rietveld:
2952 parser.error('Options --gerrit and --rietveld are mutually exclusive')
2953 options.forced_codereview = None
2954 if options.gerrit:
2955 options.forced_codereview = 'gerrit'
2956 elif options.rietveld:
2957 options.forced_codereview = 'rietveld'
2958
2959
tandriif9aefb72016-07-01 09:06:51 -07002960def _get_bug_line_values(default_project, bugs):
2961 """Given default_project and comma separated list of bugs, yields bug line
2962 values.
2963
2964 Each bug can be either:
2965 * a number, which is combined with default_project
2966 * string, which is left as is.
2967
2968 This function may produce more than one line, because bugdroid expects one
2969 project per line.
2970
2971 >>> list(_get_bug_line_values('v8', '123,chromium:789'))
2972 ['v8:123', 'chromium:789']
2973 """
2974 default_bugs = []
2975 others = []
2976 for bug in bugs.split(','):
2977 bug = bug.strip()
2978 if bug:
2979 try:
2980 default_bugs.append(int(bug))
2981 except ValueError:
2982 others.append(bug)
2983
2984 if default_bugs:
2985 default_bugs = ','.join(map(str, default_bugs))
2986 if default_project:
2987 yield '%s:%s' % (default_project, default_bugs)
2988 else:
2989 yield default_bugs
2990 for other in sorted(others):
2991 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2992 yield other
2993
2994
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002995class ChangeDescription(object):
2996 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002997 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002998 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
agable@chromium.org42c20792013-09-12 17:34:49 +00002999 BUG_LINE = r'^[ \t]*(BUG)[ \t]*=[ \t]*(.*?)[ \t]*$'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003000
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003001 def __init__(self, description):
agable@chromium.org42c20792013-09-12 17:34:49 +00003002 self._description_lines = (description or '').strip().splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003003
agable@chromium.org42c20792013-09-12 17:34:49 +00003004 @property # www.logilab.org/ticket/89786
3005 def description(self): # pylint: disable=E0202
3006 return '\n'.join(self._description_lines)
3007
3008 def set_description(self, desc):
3009 if isinstance(desc, basestring):
3010 lines = desc.splitlines()
3011 else:
3012 lines = [line.rstrip() for line in desc]
3013 while lines and not lines[0]:
3014 lines.pop(0)
3015 while lines and not lines[-1]:
3016 lines.pop(-1)
3017 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003018
piman@chromium.org336f9122014-09-04 02:16:55 +00003019 def update_reviewers(self, reviewers, add_owners_tbr=False, change=None):
agable@chromium.org42c20792013-09-12 17:34:49 +00003020 """Rewrites the R=/TBR= line(s) as a single line each."""
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003021 assert isinstance(reviewers, list), reviewers
piman@chromium.org336f9122014-09-04 02:16:55 +00003022 if not reviewers and not add_owners_tbr:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003023 return
agable@chromium.org42c20792013-09-12 17:34:49 +00003024 reviewers = reviewers[:]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003025
agable@chromium.org42c20792013-09-12 17:34:49 +00003026 # Get the set of R= and TBR= lines and remove them from the desciption.
3027 regexp = re.compile(self.R_LINE)
3028 matches = [regexp.match(line) for line in self._description_lines]
3029 new_desc = [l for i, l in enumerate(self._description_lines)
3030 if not matches[i]]
3031 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003032
agable@chromium.org42c20792013-09-12 17:34:49 +00003033 # Construct new unified R= and TBR= lines.
3034 r_names = []
3035 tbr_names = []
3036 for match in matches:
3037 if not match:
3038 continue
3039 people = cleanup_list([match.group(2).strip()])
3040 if match.group(1) == 'TBR':
3041 tbr_names.extend(people)
3042 else:
3043 r_names.extend(people)
3044 for name in r_names:
3045 if name not in reviewers:
3046 reviewers.append(name)
piman@chromium.org336f9122014-09-04 02:16:55 +00003047 if add_owners_tbr:
3048 owners_db = owners.Database(change.RepositoryRoot(),
dtu944b6052016-07-14 14:48:21 -07003049 fopen=file, os_path=os.path)
piman@chromium.org336f9122014-09-04 02:16:55 +00003050 all_reviewers = set(tbr_names + reviewers)
3051 missing_files = owners_db.files_not_covered_by(change.LocalPaths(),
3052 all_reviewers)
3053 tbr_names.extend(owners_db.reviewers_for(missing_files,
3054 change.author_email))
agable@chromium.org42c20792013-09-12 17:34:49 +00003055 new_r_line = 'R=' + ', '.join(reviewers) if reviewers else None
3056 new_tbr_line = 'TBR=' + ', '.join(tbr_names) if tbr_names else None
3057
3058 # Put the new lines in the description where the old first R= line was.
3059 line_loc = next((i for i, match in enumerate(matches) if match), -1)
3060 if 0 <= line_loc < len(self._description_lines):
3061 if new_tbr_line:
3062 self._description_lines.insert(line_loc, new_tbr_line)
3063 if new_r_line:
3064 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003065 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00003066 if new_r_line:
3067 self.append_footer(new_r_line)
3068 if new_tbr_line:
3069 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003070
tandriif9aefb72016-07-01 09:06:51 -07003071 def prompt(self, bug=None):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003072 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00003073 self.set_description([
3074 '# Enter a description of the change.',
3075 '# This will be displayed on the codereview site.',
3076 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00003077 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00003078 '--------------------',
3079 ] + self._description_lines)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003080
agable@chromium.org42c20792013-09-12 17:34:49 +00003081 regexp = re.compile(self.BUG_LINE)
3082 if not any((regexp.match(line) for line in self._description_lines)):
tandriif9aefb72016-07-01 09:06:51 -07003083 prefix = settings.GetBugPrefix()
3084 values = list(_get_bug_line_values(prefix, bug or '')) or [prefix]
3085 for value in values:
3086 # TODO(tandrii): change this to 'Bug: xxx' to be a proper Gerrit footer.
3087 self.append_footer('BUG=%s' % value)
3088
agable@chromium.org42c20792013-09-12 17:34:49 +00003089 content = gclient_utils.RunEditor(self.description, True,
jbroman@chromium.org615a2622013-05-03 13:20:14 +00003090 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00003091 if not content:
3092 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00003093 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003094
3095 # Strip off comments.
agable@chromium.org42c20792013-09-12 17:34:49 +00003096 clean_lines = [line.rstrip() for line in lines if not line.startswith('#')]
3097 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00003098 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00003099 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003100
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003101 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00003102 """Adds a footer line to the description.
3103
3104 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
3105 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
3106 that Gerrit footers are always at the end.
3107 """
3108 parsed_footer_line = git_footers.parse_footer(line)
3109 if parsed_footer_line:
3110 # Line is a gerrit footer in the form: Footer-Key: any value.
3111 # Thus, must be appended observing Gerrit footer rules.
3112 self.set_description(
3113 git_footers.add_footer(self.description,
3114 key=parsed_footer_line[0],
3115 value=parsed_footer_line[1]))
3116 return
3117
3118 if not self._description_lines:
3119 self._description_lines.append(line)
3120 return
3121
3122 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
3123 if gerrit_footers:
3124 # git_footers.split_footers ensures that there is an empty line before
3125 # actual (gerrit) footers, if any. We have to keep it that way.
3126 assert top_lines and top_lines[-1] == ''
3127 top_lines, separator = top_lines[:-1], top_lines[-1:]
3128 else:
3129 separator = [] # No need for separator if there are no gerrit_footers.
3130
3131 prev_line = top_lines[-1] if top_lines else ''
3132 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
3133 not presubmit_support.Change.TAG_LINE_RE.match(line)):
3134 top_lines.append('')
3135 top_lines.append(line)
3136 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003137
tandrii99a72f22016-08-17 14:33:24 -07003138 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003139 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00003140 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07003141 reviewers = [match.group(2).strip()
3142 for match in matches
3143 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003144 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003145
bradnelsond975b302016-10-23 12:20:23 -07003146 def get_cced(self):
3147 """Retrieves the list of reviewers."""
3148 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
3149 cced = [match.group(2).strip() for match in matches if match]
3150 return cleanup_list(cced)
3151
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003152
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003153def get_approving_reviewers(props):
3154 """Retrieves the reviewers that approved a CL from the issue properties with
3155 messages.
3156
3157 Note that the list may contain reviewers that are not committer, thus are not
3158 considered by the CQ.
3159 """
3160 return sorted(
3161 set(
3162 message['sender']
3163 for message in props['messages']
3164 if message['approval'] and message['sender'] in props['reviewers']
3165 )
3166 )
3167
3168
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003169def FindCodereviewSettingsFile(filename='codereview.settings'):
3170 """Finds the given file starting in the cwd and going up.
3171
3172 Only looks up to the top of the repository unless an
3173 'inherit-review-settings-ok' file exists in the root of the repository.
3174 """
3175 inherit_ok_file = 'inherit-review-settings-ok'
3176 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00003177 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003178 if os.path.isfile(os.path.join(root, inherit_ok_file)):
3179 root = '/'
3180 while True:
3181 if filename in os.listdir(cwd):
3182 if os.path.isfile(os.path.join(cwd, filename)):
3183 return open(os.path.join(cwd, filename))
3184 if cwd == root:
3185 break
3186 cwd = os.path.dirname(cwd)
3187
3188
3189def LoadCodereviewSettingsFromFile(fileobj):
3190 """Parse a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00003191 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003192
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003193 def SetProperty(name, setting, unset_error_ok=False):
3194 fullname = 'rietveld.' + name
3195 if setting in keyvals:
3196 RunGit(['config', fullname, keyvals[setting]])
3197 else:
3198 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
3199
tandrii48df5812016-10-17 03:55:37 -07003200 if not keyvals.get('GERRIT_HOST', False):
3201 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003202 # Only server setting is required. Other settings can be absent.
3203 # In that case, we ignore errors raised during option deletion attempt.
3204 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +00003205 SetProperty('private', 'PRIVATE', unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003206 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
3207 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00003208 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003209 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
kjellander@chromium.org6abc6522014-12-02 07:34:49 +00003210 SetProperty('force-https-commit-url', 'FORCE_HTTPS_COMMIT_URL',
3211 unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003212 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
sheyang@chromium.org152cf832014-06-11 21:37:49 +00003213 SetProperty('project', 'PROJECT', unset_error_ok=True)
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00003214 SetProperty('pending-ref-prefix', 'PENDING_REF_PREFIX', unset_error_ok=True)
tandriif46c20f2016-09-14 06:17:05 -07003215 SetProperty('git-number-footer', 'GIT_NUMBER_FOOTER', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00003216 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
3217 unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003218
ukai@chromium.org7044efc2013-11-28 01:51:21 +00003219 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00003220 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00003221
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003222 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
tandrii8dd81ea2016-06-16 13:24:23 -07003223 RunGit(['config', 'gerrit.squash-uploads',
3224 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003225
tandrii@chromium.org28253532016-04-14 13:46:56 +00003226 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00003227 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00003228 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
3229
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003230 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
3231 #should be of the form
3232 #PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
3233 #ORIGIN_URL_CONFIG: http://src.chromium.org/git
3234 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
3235 keyvals['ORIGIN_URL_CONFIG']])
3236
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003237
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003238def urlretrieve(source, destination):
3239 """urllib is broken for SSL connections via a proxy therefore we
3240 can't use urllib.urlretrieve()."""
3241 with open(destination, 'w') as f:
3242 f.write(urllib2.urlopen(source).read())
3243
3244
ukai@chromium.org712d6102013-11-27 00:52:58 +00003245def hasSheBang(fname):
3246 """Checks fname is a #! script."""
3247 with open(fname) as f:
3248 return f.read(2).startswith('#!')
3249
3250
bpastene@chromium.org917f0ff2016-04-05 00:45:30 +00003251# TODO(bpastene) Remove once a cleaner fix to crbug.com/600473 presents itself.
3252def DownloadHooks(*args, **kwargs):
3253 pass
3254
3255
tandrii@chromium.org18630d62016-03-04 12:06:02 +00003256def DownloadGerritHook(force):
3257 """Download and install Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003258
3259 Args:
3260 force: True to update hooks. False to install hooks if not present.
3261 """
3262 if not settings.GetIsGerrit():
3263 return
ukai@chromium.org712d6102013-11-27 00:52:58 +00003264 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003265 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
3266 if not os.access(dst, os.X_OK):
3267 if os.path.exists(dst):
3268 if not force:
3269 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003270 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003271 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003272 if not hasSheBang(dst):
3273 DieWithError('Not a script: %s\n'
3274 'You need to download from\n%s\n'
3275 'into .git/hooks/commit-msg and '
3276 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003277 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
3278 except Exception:
3279 if os.path.exists(dst):
3280 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003281 DieWithError('\nFailed to download hooks.\n'
3282 'You need to download from\n%s\n'
3283 'into .git/hooks/commit-msg and '
3284 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003285
3286
tandrii@chromium.orge7d3d162016-03-15 14:15:57 +00003287
3288def GetRietveldCodereviewSettingsInteractively():
3289 """Prompt the user for settings."""
3290 server = settings.GetDefaultServerUrl(error_ok=True)
3291 prompt = 'Rietveld server (host[:port])'
3292 prompt += ' [%s]' % (server or DEFAULT_SERVER)
3293 newserver = ask_for_data(prompt + ':')
3294 if not server and not newserver:
3295 newserver = DEFAULT_SERVER
3296 if newserver:
3297 newserver = gclient_utils.UpgradeToHttps(newserver)
3298 if newserver != server:
3299 RunGit(['config', 'rietveld.server', newserver])
3300
3301 def SetProperty(initial, caption, name, is_url):
3302 prompt = caption
3303 if initial:
3304 prompt += ' ("x" to clear) [%s]' % initial
3305 new_val = ask_for_data(prompt + ':')
3306 if new_val == 'x':
3307 RunGit(['config', '--unset-all', 'rietveld.' + name], error_ok=True)
3308 elif new_val:
3309 if is_url:
3310 new_val = gclient_utils.UpgradeToHttps(new_val)
3311 if new_val != initial:
3312 RunGit(['config', 'rietveld.' + name, new_val])
3313
3314 SetProperty(settings.GetDefaultCCList(), 'CC list', 'cc', False)
3315 SetProperty(settings.GetDefaultPrivateFlag(),
3316 'Private flag (rietveld only)', 'private', False)
3317 SetProperty(settings.GetTreeStatusUrl(error_ok=True), 'Tree status URL',
3318 'tree-status-url', False)
3319 SetProperty(settings.GetViewVCUrl(), 'ViewVC URL', 'viewvc-url', True)
3320 SetProperty(settings.GetBugPrefix(), 'Bug Prefix', 'bug-prefix', False)
3321 SetProperty(settings.GetRunPostUploadHook(), 'Run Post Upload Hook',
3322 'run-post-upload-hook', False)
3323
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003324@subcommand.usage('[repo root containing codereview.settings]')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003325def CMDconfig(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003326 """Edits configuration for this tree."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003327
tandrii5d0a0422016-09-14 06:24:35 -07003328 print('WARNING: git cl config works for Rietveld only')
3329 # TODO(tandrii): remove this once we switch to Gerrit.
3330 # See bugs http://crbug.com/637561 and http://crbug.com/600469.
pgervais@chromium.org87884cc2014-01-03 22:23:41 +00003331 parser.add_option('--activate-update', action='store_true',
3332 help='activate auto-updating [rietveld] section in '
3333 '.git/config')
3334 parser.add_option('--deactivate-update', action='store_true',
3335 help='deactivate auto-updating [rietveld] section in '
3336 '.git/config')
3337 options, args = parser.parse_args(args)
3338
3339 if options.deactivate_update:
3340 RunGit(['config', 'rietveld.autoupdate', 'false'])
3341 return
3342
3343 if options.activate_update:
3344 RunGit(['config', '--unset', 'rietveld.autoupdate'])
3345 return
3346
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003347 if len(args) == 0:
tandrii@chromium.orge7d3d162016-03-15 14:15:57 +00003348 GetRietveldCodereviewSettingsInteractively()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003349 return 0
3350
3351 url = args[0]
3352 if not url.endswith('codereview.settings'):
3353 url = os.path.join(url, 'codereview.settings')
3354
3355 # Load code review settings and download hooks (if available).
3356 LoadCodereviewSettingsFromFile(urllib2.urlopen(url))
3357 return 0
3358
3359
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003360def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003361 """Gets or sets base-url for this branch."""
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003362 branchref = RunGit(['symbolic-ref', 'HEAD']).strip()
3363 branch = ShortBranchName(branchref)
3364 _, args = parser.parse_args(args)
3365 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003366 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003367 return RunGit(['config', 'branch.%s.base-url' % branch],
3368 error_ok=False).strip()
3369 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003370 print('Setting base-url to %s' % args[0])
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003371 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3372 error_ok=False).strip()
3373
3374
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003375def color_for_status(status):
3376 """Maps a Changelist status to color, for CMDstatus and other tools."""
3377 return {
3378 'unsent': Fore.RED,
3379 'waiting': Fore.BLUE,
3380 'reply': Fore.YELLOW,
3381 'lgtm': Fore.GREEN,
3382 'commit': Fore.MAGENTA,
3383 'closed': Fore.CYAN,
3384 'error': Fore.WHITE,
3385 }.get(status, Fore.WHITE)
3386
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003387
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003388def get_cl_statuses(changes, fine_grained, max_processes=None):
3389 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003390
3391 If fine_grained is true, this will fetch CL statuses from the server.
3392 Otherwise, simply indicate if there's a matching url for the given branches.
3393
3394 If max_processes is specified, it is used as the maximum number of processes
3395 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3396 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003397
3398 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003399 """
qyearsley12fa6ff2016-08-24 09:18:40 -07003400 # Silence upload.py otherwise it becomes unwieldy.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003401 upload.verbosity = 0
3402
3403 if fine_grained:
3404 # Process one branch synchronously to work through authentication, then
3405 # spawn processes to process all the other branches in parallel.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003406 if changes:
tandriiea9514a2016-08-17 12:32:37 -07003407 def fetch(cl):
3408 try:
3409 return (cl, cl.GetStatus())
3410 except:
3411 # See http://crbug.com/629863.
3412 logging.exception('failed to fetch status for %s:', cl)
3413 raise
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003414 yield fetch(changes[0])
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003415
tandriiea9514a2016-08-17 12:32:37 -07003416 changes_to_fetch = changes[1:]
3417 if not changes_to_fetch:
kmarshall3bff56b2016-06-06 18:31:47 -07003418 # Exit early if there was only one branch to fetch.
3419 return
3420
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003421 pool = ThreadPool(
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003422 min(max_processes, len(changes_to_fetch))
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003423 if max_processes is not None
dsinclair99d30172016-08-09 10:48:58 -07003424 else max(len(changes_to_fetch), 1))
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003425
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003426 fetched_cls = set()
3427 it = pool.imap_unordered(fetch, changes_to_fetch).__iter__()
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003428 while True:
3429 try:
3430 row = it.next(timeout=5)
3431 except multiprocessing.TimeoutError:
3432 break
3433
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003434 fetched_cls.add(row[0])
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003435 yield row
3436
3437 # Add any branches that failed to fetch.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003438 for cl in set(changes_to_fetch) - fetched_cls:
3439 yield (cl, 'error')
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003440
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003441 else:
3442 # Do not use GetApprovingReviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003443 for cl in changes:
3444 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003445
rmistry@google.com2dd99862015-06-22 12:22:18 +00003446
3447def upload_branch_deps(cl, args):
3448 """Uploads CLs of local branches that are dependents of the current branch.
3449
3450 If the local branch dependency tree looks like:
3451 test1 -> test2.1 -> test3.1
3452 -> test3.2
3453 -> test2.2 -> test3.3
3454
3455 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3456 run on the dependent branches in this order:
3457 test2.1, test3.1, test3.2, test2.2, test3.3
3458
3459 Note: This function does not rebase your local dependent branches. Use it when
3460 you make a change to the parent branch that will not conflict with its
3461 dependent branches, and you would like their dependencies updated in
3462 Rietveld.
3463 """
3464 if git_common.is_dirty_git_tree('upload-branch-deps'):
3465 return 1
3466
3467 root_branch = cl.GetBranch()
3468 if root_branch is None:
3469 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3470 'Get on a branch!')
3471 if not cl.GetIssue() or not cl.GetPatchset():
3472 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3473 'patchset dependencies without an uploaded CL.')
3474
3475 branches = RunGit(['for-each-ref',
3476 '--format=%(refname:short) %(upstream:short)',
3477 'refs/heads'])
3478 if not branches:
3479 print('No local branches found.')
3480 return 0
3481
3482 # Create a dictionary of all local branches to the branches that are dependent
3483 # on it.
3484 tracked_to_dependents = collections.defaultdict(list)
3485 for b in branches.splitlines():
3486 tokens = b.split()
3487 if len(tokens) == 2:
3488 branch_name, tracked = tokens
3489 tracked_to_dependents[tracked].append(branch_name)
3490
vapiera7fbd5a2016-06-16 09:17:49 -07003491 print()
3492 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003493 dependents = []
3494 def traverse_dependents_preorder(branch, padding=''):
3495 dependents_to_process = tracked_to_dependents.get(branch, [])
3496 padding += ' '
3497 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003498 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003499 dependents.append(dependent)
3500 traverse_dependents_preorder(dependent, padding)
3501 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003502 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003503
3504 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003505 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003506 return 0
3507
vapiera7fbd5a2016-06-16 09:17:49 -07003508 print('This command will checkout all dependent branches and run '
3509 '"git cl upload".')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003510 ask_for_data('[Press enter to continue or ctrl-C to quit]')
3511
andybons@chromium.org962f9462016-02-03 20:00:42 +00003512 # Add a default patchset title to all upload calls in Rietveld.
tandrii@chromium.org4c72b082016-03-31 22:26:35 +00003513 if not cl.IsGerrit():
andybons@chromium.org962f9462016-02-03 20:00:42 +00003514 args.extend(['-t', 'Updated patchset dependency'])
3515
rmistry@google.com2dd99862015-06-22 12:22:18 +00003516 # Record all dependents that failed to upload.
3517 failures = {}
3518 # Go through all dependents, checkout the branch and upload.
3519 try:
3520 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003521 print()
3522 print('--------------------------------------')
3523 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003524 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003525 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003526 try:
3527 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003528 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003529 failures[dependent_branch] = 1
3530 except: # pylint: disable=W0702
3531 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003532 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003533 finally:
3534 # Swap back to the original root branch.
3535 RunGit(['checkout', '-q', root_branch])
3536
vapiera7fbd5a2016-06-16 09:17:49 -07003537 print()
3538 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003539 for dependent_branch in dependents:
3540 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003541 print(' %s : %s' % (dependent_branch, upload_status))
3542 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003543
3544 return 0
3545
3546
kmarshall3bff56b2016-06-06 18:31:47 -07003547def CMDarchive(parser, args):
3548 """Archives and deletes branches associated with closed changelists."""
3549 parser.add_option(
3550 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003551 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003552 parser.add_option(
3553 '-f', '--force', action='store_true',
3554 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003555 parser.add_option(
3556 '-d', '--dry-run', action='store_true',
3557 help='Skip the branch tagging and removal steps.')
3558 parser.add_option(
3559 '-t', '--notags', action='store_true',
3560 help='Do not tag archived branches. '
3561 'Note: local commit history may be lost.')
kmarshall3bff56b2016-06-06 18:31:47 -07003562
3563 auth.add_auth_options(parser)
3564 options, args = parser.parse_args(args)
3565 if args:
3566 parser.error('Unsupported args: %s' % ' '.join(args))
3567 auth_config = auth.extract_auth_config_from_options(options)
3568
3569 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3570 if not branches:
3571 return 0
3572
vapiera7fbd5a2016-06-16 09:17:49 -07003573 print('Finding all branches associated with closed issues...')
kmarshall3bff56b2016-06-06 18:31:47 -07003574 changes = [Changelist(branchref=b, auth_config=auth_config)
3575 for b in branches.splitlines()]
3576 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3577 statuses = get_cl_statuses(changes,
3578 fine_grained=True,
3579 max_processes=options.maxjobs)
3580 proposal = [(cl.GetBranch(),
3581 'git-cl-archived-%s-%s' % (cl.GetIssue(), cl.GetBranch()))
3582 for cl, status in statuses
3583 if status == 'closed']
3584 proposal.sort()
3585
3586 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003587 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003588 return 0
3589
3590 current_branch = GetCurrentBranch()
3591
vapiera7fbd5a2016-06-16 09:17:49 -07003592 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003593 if options.notags:
3594 for next_item in proposal:
3595 print(' ' + next_item[0])
3596 else:
3597 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3598 for next_item in proposal:
3599 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003600
kmarshall9249e012016-08-23 12:02:16 -07003601 # Quit now on precondition failure or if instructed by the user, either
3602 # via an interactive prompt or by command line flags.
3603 if options.dry_run:
3604 print('\nNo changes were made (dry run).\n')
3605 return 0
3606 elif any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003607 print('You are currently on a branch \'%s\' which is associated with a '
3608 'closed codereview issue, so archive cannot proceed. Please '
3609 'checkout another branch and run this command again.' %
3610 current_branch)
3611 return 1
kmarshall9249e012016-08-23 12:02:16 -07003612 elif not options.force:
sergiyb4a5ecbe2016-06-20 09:46:00 -07003613 answer = ask_for_data('\nProceed with deletion (Y/n)? ').lower()
3614 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003615 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003616 return 1
3617
3618 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003619 if not options.notags:
3620 RunGit(['tag', tagname, branch])
kmarshall3bff56b2016-06-06 18:31:47 -07003621 RunGit(['branch', '-D', branch])
kmarshall9249e012016-08-23 12:02:16 -07003622
vapiera7fbd5a2016-06-16 09:17:49 -07003623 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003624
3625 return 0
3626
3627
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003628def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003629 """Show status of changelists.
3630
3631 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003632 - Red not sent for review or broken
3633 - Blue waiting for review
3634 - Yellow waiting for you to reply to review
3635 - Green LGTM'ed
3636 - Magenta in the commit queue
3637 - Cyan was committed, branch can be deleted
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003638
3639 Also see 'git cl comments'.
3640 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003641 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003642 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003643 parser.add_option('-f', '--fast', action='store_true',
3644 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003645 parser.add_option(
3646 '-j', '--maxjobs', action='store', type=int,
3647 help='The maximum number of jobs to use when retrieving review status')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003648
3649 auth.add_auth_options(parser)
iannuccie53c9352016-08-17 14:40:40 -07003650 _add_codereview_issue_select_options(
3651 parser, 'Must be in conjunction with --field.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003652 options, args = parser.parse_args(args)
iannuccie53c9352016-08-17 14:40:40 -07003653 _process_codereview_issue_select_options(parser, options)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003654 if args:
3655 parser.error('Unsupported args: %s' % args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003656 auth_config = auth.extract_auth_config_from_options(options)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003657
iannuccie53c9352016-08-17 14:40:40 -07003658 if options.issue is not None and not options.field:
3659 parser.error('--field must be specified with --issue')
iannucci3c972b92016-08-17 13:24:10 -07003660
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003661 if options.field:
iannucci3c972b92016-08-17 13:24:10 -07003662 cl = Changelist(auth_config=auth_config, issue=options.issue,
3663 codereview=options.forced_codereview)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003664 if options.field.startswith('desc'):
vapiera7fbd5a2016-06-16 09:17:49 -07003665 print(cl.GetDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003666 elif options.field == 'id':
3667 issueid = cl.GetIssue()
3668 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07003669 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003670 elif options.field == 'patch':
3671 patchset = cl.GetPatchset()
3672 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07003673 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07003674 elif options.field == 'status':
3675 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003676 elif options.field == 'url':
3677 url = cl.GetIssueURL()
3678 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07003679 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003680 return 0
3681
3682 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3683 if not branches:
3684 print('No local branch found.')
3685 return 0
3686
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003687 changes = [
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003688 Changelist(branchref=b, auth_config=auth_config)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003689 for b in branches.splitlines()]
vapiera7fbd5a2016-06-16 09:17:49 -07003690 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003691 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003692 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003693 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003694
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003695 branch_statuses = {}
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003696 alignment = max(5, max(len(ShortBranchName(c.GetBranch())) for c in changes))
3697 for cl in sorted(changes, key=lambda c: c.GetBranch()):
3698 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003699 while branch not in branch_statuses:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003700 c, status = output.next()
3701 branch_statuses[c.GetBranch()] = status
3702 status = branch_statuses.pop(branch)
3703 url = cl.GetIssueURL()
3704 if url and (not status or status == 'error'):
3705 # The issue probably doesn't exist anymore.
3706 url += ' (broken)'
3707
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003708 color = color_for_status(status)
maruel@chromium.org885f6512013-07-27 02:17:26 +00003709 reset = Fore.RESET
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00003710 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00003711 color = ''
3712 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003713 status_str = '(%s)' % status if status else ''
vapiera7fbd5a2016-06-16 09:17:49 -07003714 print(' %*s : %s%s %s%s' % (
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003715 alignment, ShortBranchName(branch), color, url,
vapiera7fbd5a2016-06-16 09:17:49 -07003716 status_str, reset))
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003717
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003718 cl = Changelist(auth_config=auth_config)
vapiera7fbd5a2016-06-16 09:17:49 -07003719 print()
3720 print('Current branch:',)
3721 print(cl.GetBranch())
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003722 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07003723 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003724 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07003725 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00003726 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07003727 print('Issue description:')
3728 print(cl.GetDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003729 return 0
3730
3731
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003732def colorize_CMDstatus_doc():
3733 """To be called once in main() to add colors to git cl status help."""
3734 colors = [i for i in dir(Fore) if i[0].isupper()]
3735
3736 def colorize_line(line):
3737 for color in colors:
3738 if color in line.upper():
3739 # Extract whitespaces first and the leading '-'.
3740 indent = len(line) - len(line.lstrip(' ')) + 1
3741 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
3742 return line
3743
3744 lines = CMDstatus.__doc__.splitlines()
3745 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
3746
3747
phajdan.jre328cf92016-08-22 04:12:17 -07003748def write_json(path, contents):
3749 with open(path, 'w') as f:
3750 json.dump(contents, f)
3751
3752
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003753@subcommand.usage('[issue_number]')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003754def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003755 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003756
3757 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003758 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00003759 parser.add_option('-r', '--reverse', action='store_true',
3760 help='Lookup the branch(es) for the specified issues. If '
3761 'no issues are specified, all branches with mapped '
3762 'issues will be listed.')
phajdan.jre328cf92016-08-22 04:12:17 -07003763 parser.add_option('--json', help='Path to JSON output file.')
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00003764 _add_codereview_select_options(parser)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003765 options, args = parser.parse_args(args)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00003766 _process_codereview_select_options(parser, options)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003767
dnj@chromium.org406c4402015-03-03 17:22:28 +00003768 if options.reverse:
3769 branches = RunGit(['for-each-ref', 'refs/heads',
3770 '--format=%(refname:short)']).splitlines()
3771
3772 # Reverse issue lookup.
3773 issue_branch_map = {}
3774 for branch in branches:
3775 cl = Changelist(branchref=branch)
3776 issue_branch_map.setdefault(cl.GetIssue(), []).append(branch)
3777 if not args:
3778 args = sorted(issue_branch_map.iterkeys())
phajdan.jre328cf92016-08-22 04:12:17 -07003779 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00003780 for issue in args:
3781 if not issue:
3782 continue
phajdan.jre328cf92016-08-22 04:12:17 -07003783 result[int(issue)] = issue_branch_map.get(int(issue))
vapiera7fbd5a2016-06-16 09:17:49 -07003784 print('Branch for issue number %s: %s' % (
3785 issue, ', '.join(issue_branch_map.get(int(issue)) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07003786 if options.json:
3787 write_json(options.json, result)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003788 else:
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00003789 cl = Changelist(codereview=options.forced_codereview)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003790 if len(args) > 0:
3791 try:
3792 issue = int(args[0])
3793 except ValueError:
3794 DieWithError('Pass a number to set the issue or none to list it.\n'
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00003795 'Maybe you want to run git cl status?')
dnj@chromium.org406c4402015-03-03 17:22:28 +00003796 cl.SetIssue(issue)
vapiera7fbd5a2016-06-16 09:17:49 -07003797 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
phajdan.jre328cf92016-08-22 04:12:17 -07003798 if options.json:
3799 write_json(options.json, {
3800 'issue': cl.GetIssue(),
3801 'issue_url': cl.GetIssueURL(),
3802 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003803 return 0
3804
3805
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003806def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003807 """Shows or posts review comments for any changelist."""
3808 parser.add_option('-a', '--add-comment', dest='comment',
3809 help='comment to add to an issue')
3810 parser.add_option('-i', dest='issue',
3811 help="review issue id (defaults to current issue)")
smut@google.comc85ac942015-09-15 16:34:43 +00003812 parser.add_option('-j', '--json-file',
3813 help='File to write JSON summary to')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003814 auth.add_auth_options(parser)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003815 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003816 auth_config = auth.extract_auth_config_from_options(options)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003817
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003818 issue = None
3819 if options.issue:
3820 try:
3821 issue = int(options.issue)
3822 except ValueError:
3823 DieWithError('A review issue id is expected to be a number')
3824
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00003825 cl = Changelist(issue=issue, codereview='rietveld', auth_config=auth_config)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003826
3827 if options.comment:
3828 cl.AddComment(options.comment)
3829 return 0
3830
3831 data = cl.GetIssueProperties()
smut@google.comc85ac942015-09-15 16:34:43 +00003832 summary = []
maruel@chromium.org5cab2d32014-11-11 18:32:41 +00003833 for message in sorted(data.get('messages', []), key=lambda x: x['date']):
smut@google.comc85ac942015-09-15 16:34:43 +00003834 summary.append({
3835 'date': message['date'],
3836 'lgtm': False,
3837 'message': message['text'],
3838 'not_lgtm': False,
3839 'sender': message['sender'],
3840 })
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003841 if message['disapproval']:
3842 color = Fore.RED
smut@google.comc85ac942015-09-15 16:34:43 +00003843 summary[-1]['not lgtm'] = True
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003844 elif message['approval']:
3845 color = Fore.GREEN
smut@google.comc85ac942015-09-15 16:34:43 +00003846 summary[-1]['lgtm'] = True
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003847 elif message['sender'] == data['owner_email']:
3848 color = Fore.MAGENTA
3849 else:
3850 color = Fore.BLUE
vapiera7fbd5a2016-06-16 09:17:49 -07003851 print('\n%s%s %s%s' % (
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003852 color, message['date'].split('.', 1)[0], message['sender'],
vapiera7fbd5a2016-06-16 09:17:49 -07003853 Fore.RESET))
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003854 if message['text'].strip():
vapiera7fbd5a2016-06-16 09:17:49 -07003855 print('\n'.join(' ' + l for l in message['text'].splitlines()))
smut@google.comc85ac942015-09-15 16:34:43 +00003856 if options.json_file:
3857 with open(options.json_file, 'wb') as f:
3858 json.dump(summary, f)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003859 return 0
3860
3861
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003862@subcommand.usage('[codereview url or issue id]')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003863def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003864 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00003865 parser.add_option('-d', '--display', action='store_true',
3866 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003867 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07003868 help='New description to set for this issue (- for stdin, '
3869 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07003870 parser.add_option('-f', '--force', action='store_true',
3871 help='Delete any unpublished Gerrit edits for this issue '
3872 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003873
3874 _add_codereview_select_options(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003875 auth.add_auth_options(parser)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003876 options, args = parser.parse_args(args)
3877 _process_codereview_select_options(parser, options)
3878
3879 target_issue = None
3880 if len(args) > 0:
martiniss6eda05f2016-06-30 10:18:35 -07003881 target_issue = ParseIssueNumberArgument(args[0])
3882 if not target_issue.valid:
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003883 parser.print_help()
3884 return 1
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003885
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003886 auth_config = auth.extract_auth_config_from_options(options)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003887
martiniss6eda05f2016-06-30 10:18:35 -07003888 kwargs = {
3889 'auth_config': auth_config,
3890 'codereview': options.forced_codereview,
3891 }
3892 if target_issue:
3893 kwargs['issue'] = target_issue.issue
3894 if options.forced_codereview == 'rietveld':
3895 kwargs['rietveld_server'] = target_issue.hostname
3896
3897 cl = Changelist(**kwargs)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003898
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003899 if not cl.GetIssue():
3900 DieWithError('This branch has no associated changelist.')
3901 description = ChangeDescription(cl.GetDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003902
smut@google.com34fb6b12015-07-13 20:03:26 +00003903 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07003904 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00003905 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003906
3907 if options.new_description:
3908 text = options.new_description
3909 if text == '-':
3910 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07003911 elif text == '+':
3912 base_branch = cl.GetCommonAncestorWithUpstream()
3913 change = cl.GetChange(base_branch, None, local_description=True)
3914 text = change.FullDescriptionText()
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003915
3916 description.set_description(text)
3917 else:
3918 description.prompt()
3919
wychen@chromium.org063e4e52015-04-03 06:51:44 +00003920 if cl.GetDescription() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07003921 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003922 return 0
3923
3924
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003925def CreateDescriptionFromLog(args):
3926 """Pulls out the commit log to use as a base for the CL description."""
3927 log_args = []
3928 if len(args) == 1 and not args[0].endswith('.'):
3929 log_args = [args[0] + '..']
3930 elif len(args) == 1 and args[0].endswith('...'):
3931 log_args = [args[0][:-1]]
3932 elif len(args) == 2:
3933 log_args = [args[0] + '..' + args[1]]
3934 else:
3935 log_args = args[:] # Hope for the best!
maruel@chromium.org373af802012-05-25 21:07:33 +00003936 return RunGit(['log', '--pretty=format:%s\n\n%b'] + log_args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003937
3938
thestig@chromium.org44202a22014-03-11 19:22:18 +00003939def CMDlint(parser, args):
3940 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00003941 parser.add_option('--filter', action='append', metavar='-x,+y',
3942 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003943 auth.add_auth_options(parser)
3944 options, args = parser.parse_args(args)
3945 auth_config = auth.extract_auth_config_from_options(options)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003946
3947 # Access to a protected member _XX of a client class
3948 # pylint: disable=W0212
3949 try:
3950 import cpplint
3951 import cpplint_chromium
3952 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07003953 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00003954 return 1
3955
3956 # Change the current working directory before calling lint so that it
3957 # shows the correct base.
3958 previous_cwd = os.getcwd()
3959 os.chdir(settings.GetRoot())
3960 try:
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003961 cl = Changelist(auth_config=auth_config)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003962 change = cl.GetChange(cl.GetCommonAncestorWithUpstream(), None)
3963 files = [f.LocalPath() for f in change.AffectedFiles()]
thestig@chromium.org5839eb52014-05-30 16:20:51 +00003964 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07003965 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00003966 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00003967
3968 # Process cpplints arguments if any.
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00003969 command = args + files
3970 if options.filter:
3971 command = ['--filter=' + ','.join(options.filter)] + command
3972 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003973
3974 white_regex = re.compile(settings.GetLintRegex())
3975 black_regex = re.compile(settings.GetLintIgnoreRegex())
3976 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
3977 for filename in filenames:
3978 if white_regex.match(filename):
3979 if black_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07003980 print('Ignoring file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003981 else:
3982 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
3983 extra_check_functions)
3984 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003985 print('Skipping file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003986 finally:
3987 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07003988 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003989 if cpplint._cpplint_state.error_count != 0:
3990 return 1
3991 return 0
3992
3993
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003994def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003995 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00003996 parser.add_option('-u', '--upload', action='store_true',
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003997 help='Run upload hook instead of the push/dcommit hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00003998 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00003999 help='Run checks even if tree is dirty')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004000 auth.add_auth_options(parser)
4001 options, args = parser.parse_args(args)
4002 auth_config = auth.extract_auth_config_from_options(options)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004003
sbc@chromium.org71437c02015-04-09 19:29:40 +00004004 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07004005 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004006 return 1
4007
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004008 cl = Changelist(auth_config=auth_config)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004009 if args:
4010 base_branch = args[0]
4011 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004012 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004013 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004014
ilevy@chromium.org051ad0e2013-03-04 21:57:34 +00004015 cl.RunHook(
4016 committing=not options.upload,
4017 may_prompt=False,
4018 verbose=options.verbose,
4019 change=cl.GetChange(base_branch, None))
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00004020 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004021
4022
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004023def GenerateGerritChangeId(message):
4024 """Returns Ixxxxxx...xxx change id.
4025
4026 Works the same way as
4027 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
4028 but can be called on demand on all platforms.
4029
4030 The basic idea is to generate git hash of a state of the tree, original commit
4031 message, author/committer info and timestamps.
4032 """
4033 lines = []
4034 tree_hash = RunGitSilent(['write-tree'])
4035 lines.append('tree %s' % tree_hash.strip())
4036 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
4037 if code == 0:
4038 lines.append('parent %s' % parent.strip())
4039 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
4040 lines.append('author %s' % author.strip())
4041 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
4042 lines.append('committer %s' % committer.strip())
4043 lines.append('')
4044 # Note: Gerrit's commit-hook actually cleans message of some lines and
4045 # whitespace. This code is not doing this, but it clearly won't decrease
4046 # entropy.
4047 lines.append(message)
4048 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
4049 stdin='\n'.join(lines))
4050 return 'I%s' % change_hash.strip()
4051
4052
wittman@chromium.org455dc922015-01-26 20:15:50 +00004053def GetTargetRef(remote, remote_branch, target_branch, pending_prefix):
4054 """Computes the remote branch ref to use for the CL.
4055
4056 Args:
4057 remote (str): The git remote for the CL.
4058 remote_branch (str): The git remote branch for the CL.
4059 target_branch (str): The target branch specified by the user.
4060 pending_prefix (str): The pending prefix from the settings.
4061 """
4062 if not (remote and remote_branch):
4063 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004064
wittman@chromium.org455dc922015-01-26 20:15:50 +00004065 if target_branch:
4066 # Cannonicalize branch references to the equivalent local full symbolic
4067 # refs, which are then translated into the remote full symbolic refs
4068 # below.
4069 if '/' not in target_branch:
4070 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4071 else:
4072 prefix_replacements = (
4073 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4074 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4075 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4076 )
4077 match = None
4078 for regex, replacement in prefix_replacements:
4079 match = re.search(regex, target_branch)
4080 if match:
4081 remote_branch = target_branch.replace(match.group(0), replacement)
4082 break
4083 if not match:
4084 # This is a branch path but not one we recognize; use as-is.
4085 remote_branch = target_branch
rmistry@google.comc68112d2015-03-03 12:48:06 +00004086 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
4087 # Handle the refs that need to land in different refs.
4088 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004089
wittman@chromium.org455dc922015-01-26 20:15:50 +00004090 # Create the true path to the remote branch.
4091 # Does the following translation:
4092 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
4093 # * refs/remotes/origin/master -> refs/heads/master
4094 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4095 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4096 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4097 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4098 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4099 'refs/heads/')
4100 elif remote_branch.startswith('refs/remotes/branch-heads'):
4101 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
4102 # If a pending prefix exists then replace refs/ with it.
4103 if pending_prefix:
4104 remote_branch = remote_branch.replace('refs/', pending_prefix)
4105 return remote_branch
4106
4107
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004108def cleanup_list(l):
4109 """Fixes a list so that comma separated items are put as individual items.
4110
4111 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4112 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4113 """
4114 items = sum((i.split(',') for i in l), [])
4115 stripped_items = (i.strip() for i in items)
4116 return sorted(filter(None, stripped_items))
4117
4118
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004119@subcommand.usage('[args to "git diff"]')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004120def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004121 """Uploads the current changelist to codereview.
4122
4123 Can skip dependency patchset uploads for a branch by running:
4124 git config branch.branch_name.skip-deps-uploads True
4125 To unset run:
4126 git config --unset branch.branch_name.skip-deps-uploads
4127 Can also set the above globally by using the --global flag.
4128 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004129 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4130 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004131 parser.add_option('--bypass-watchlists', action='store_true',
4132 dest='bypass_watchlists',
4133 help='bypass watchlists auto CC-ing reviewers')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004134 parser.add_option('-f', action='store_true', dest='force',
4135 help="force yes to questions (don't prompt)")
rogerta@chromium.org420d3b82012-05-14 18:41:38 +00004136 parser.add_option('-m', dest='message', help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004137 parser.add_option('-b', '--bug',
4138 help='pre-populate the bug number(s) for this issue. '
4139 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004140 parser.add_option('--message-file', dest='message_file',
4141 help='file which contains message for patchset')
andybons@chromium.org962f9462016-02-03 20:00:42 +00004142 parser.add_option('-t', dest='title',
4143 help='title for patchset (Rietveld only)')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004144 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004145 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004146 help='reviewer email addresses')
4147 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004148 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004149 help='cc email addresses')
adamk@chromium.org36f47302013-04-05 01:08:31 +00004150 parser.add_option('-s', '--send-mail', action='store_true',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004151 help='send email to reviewer immediately')
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004152 parser.add_option('--emulate_svn_auto_props',
4153 '--emulate-svn-auto-props',
4154 action="store_true",
ukai@chromium.orge8077812012-02-03 03:41:46 +00004155 dest="emulate_svn_auto_props",
4156 help="Emulate Subversion's auto properties feature.")
ukai@chromium.orge8077812012-02-03 03:41:46 +00004157 parser.add_option('-c', '--use-commit-queue', action='store_true',
4158 help='tell the commit queue to commit this patchset')
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +00004159 parser.add_option('--private', action='store_true',
4160 help='set the review private (rietveld only)')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004161 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004162 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004163 metavar='TARGET',
4164 help='Apply CL to remote ref TARGET. ' +
4165 'Default: remote branch head, or master')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004166 parser.add_option('--squash', action='store_true',
4167 help='Squash multiple commits into one (Gerrit only)')
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00004168 parser.add_option('--no-squash', action='store_true',
4169 help='Don\'t squash multiple commits into one ' +
4170 '(Gerrit only)')
rmistry9eadede2016-09-19 11:22:43 -07004171 parser.add_option('--topic', default=None,
4172 help='Topic to specify when uploading (Gerrit only)')
pgervais@chromium.org91141372014-01-09 23:27:20 +00004173 parser.add_option('--email', default=None,
4174 help='email address to use to connect to Rietveld')
piman@chromium.org336f9122014-09-04 02:16:55 +00004175 parser.add_option('--tbr-owners', dest='tbr_owners', action='store_true',
4176 help='add a set of OWNERS to TBR')
tandrii@chromium.orgd50452a2015-11-23 16:38:15 +00004177 parser.add_option('-d', '--cq-dry-run', dest='cq_dry_run',
4178 action='store_true',
rmistry@google.comef966222015-04-07 11:15:01 +00004179 help='Send the patchset to do a CQ dry run right after '
4180 'upload.')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004181 parser.add_option('--dependencies', action='store_true',
4182 help='Uploads CLs of all the local branches that depend on '
4183 'the current branch')
pgervais@chromium.org91141372014-01-09 23:27:20 +00004184
rmistry@google.com2dd99862015-06-22 12:22:18 +00004185 orig_args = args
iannucci@chromium.org53937ba2012-10-02 18:20:43 +00004186 add_git_similarity(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004187 auth.add_auth_options(parser)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004188 _add_codereview_select_options(parser)
ukai@chromium.orge8077812012-02-03 03:41:46 +00004189 (options, args) = parser.parse_args(args)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004190 _process_codereview_select_options(parser, options)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004191 auth_config = auth.extract_auth_config_from_options(options)
ukai@chromium.orge8077812012-02-03 03:41:46 +00004192
sbc@chromium.org71437c02015-04-09 19:29:40 +00004193 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004194 return 1
4195
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004196 options.reviewers = cleanup_list(options.reviewers)
4197 options.cc = cleanup_list(options.cc)
4198
tandriib80458a2016-06-23 12:20:07 -07004199 if options.message_file:
4200 if options.message:
4201 parser.error('only one of --message and --message-file allowed.')
4202 options.message = gclient_utils.FileRead(options.message_file)
4203 options.message_file = None
4204
tandrii4d0545a2016-07-06 03:56:49 -07004205 if options.cq_dry_run and options.use_commit_queue:
4206 parser.error('only one of --use-commit-queue and --cq-dry-run allowed.')
4207
tandrii@chromium.org512d79c2016-03-31 12:55:28 +00004208 # For sanity of test expectations, do this otherwise lazy-loading *now*.
4209 settings.GetIsGerrit()
4210
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004211 cl = Changelist(auth_config=auth_config, codereview=options.forced_codereview)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00004212 return cl.CMDUpload(options, args, orig_args)
ukai@chromium.orge8077812012-02-03 03:41:46 +00004213
4214
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004215def IsSubmoduleMergeCommit(ref):
4216 # When submodules are added to the repo, we expect there to be a single
4217 # non-git-svn merge commit at remote HEAD with a signature comment.
4218 pattern = '^SVN changes up to revision [0-9]*$'
szager@chromium.orge84b7542012-06-15 21:26:58 +00004219 cmd = ['rev-list', '--merges', '--grep=%s' % pattern, '%s^!' % ref]
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004220 return RunGit(cmd) != ''
4221
4222
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004223def SendUpstream(parser, args, cmd):
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004224 """Common code for CMDland and CmdDCommit
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004225
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00004226 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4227 upstream and closes the issue automatically and atomically.
4228
4229 Otherwise (in case of Rietveld):
4230 Squashes branch into a single commit.
4231 Updates changelog with metadata (e.g. pointer to review).
4232 Pushes/dcommits the code upstream.
4233 Updates review and closes.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004234 """
4235 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4236 help='bypass upload presubmit hook')
4237 parser.add_option('-m', dest='message',
4238 help="override review description")
4239 parser.add_option('-f', action='store_true', dest='force',
4240 help="force yes to questions (don't prompt)")
4241 parser.add_option('-c', dest='contributor',
4242 help="external contributor for patch (appended to " +
4243 "description and used as author for git). Should be " +
4244 "formatted as 'First Last <email@example.com>'")
iannucci@chromium.org53937ba2012-10-02 18:20:43 +00004245 add_git_similarity(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004246 auth.add_auth_options(parser)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004247 (options, args) = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004248 auth_config = auth.extract_auth_config_from_options(options)
4249
4250 cl = Changelist(auth_config=auth_config)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004251
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00004252 # TODO(tandrii): refactor this into _RietveldChangelistImpl method.
4253 if cl.IsGerrit():
4254 if options.message:
4255 # This could be implemented, but it requires sending a new patch to
4256 # Gerrit, as Gerrit unlike Rietveld versions messages with patchsets.
4257 # Besides, Gerrit has the ability to change the commit message on submit
4258 # automatically, thus there is no need to support this option (so far?).
4259 parser.error('-m MESSAGE option is not supported for Gerrit.')
4260 if options.contributor:
4261 parser.error(
4262 '-c CONTRIBUTOR option is not supported for Gerrit.\n'
4263 'Before uploading a commit to Gerrit, ensure it\'s author field is '
4264 'the contributor\'s "name <email>". If you can\'t upload such a '
4265 'commit for review, contact your repository admin and request'
4266 '"Forge-Author" permission.')
tandrii73449b02016-09-14 06:27:24 -07004267 if not cl.GetIssue():
4268 DieWithError('You must upload the issue first to Gerrit.\n'
4269 ' If you would rather have `git cl land` upload '
4270 'automatically for you, see http://crbug.com/642759')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00004271 return cl._codereview_impl.CMDLand(options.force, options.bypass_hooks,
4272 options.verbose)
4273
iannucci@chromium.org5724c962014-04-11 09:32:56 +00004274 current = cl.GetBranch()
4275 remote, upstream_branch = cl.FetchUpstreamTuple(cl.GetBranch())
4276 if not settings.GetIsGitSvn() and remote == '.':
vapiera7fbd5a2016-06-16 09:17:49 -07004277 print()
4278 print('Attempting to push branch %r into another local branch!' % current)
4279 print()
4280 print('Either reparent this branch on top of origin/master:')
4281 print(' git reparent-branch --root')
4282 print()
4283 print('OR run `git rebase-update` if you think the parent branch is ')
4284 print('already committed.')
4285 print()
4286 print(' Current parent: %r' % upstream_branch)
iannucci@chromium.org5724c962014-04-11 09:32:56 +00004287 return 1
4288
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004289 if not args or cmd == 'land':
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004290 # Default to merging against our best guess of the upstream branch.
4291 args = [cl.GetUpstreamBranch()]
4292
maruel@chromium.org13f623c2011-07-22 16:02:23 +00004293 if options.contributor:
4294 if not re.match('^.*\s<\S+@\S+>$', options.contributor):
vapiera7fbd5a2016-06-16 09:17:49 -07004295 print("Please provide contibutor as 'First Last <email@example.com>'")
maruel@chromium.org13f623c2011-07-22 16:02:23 +00004296 return 1
4297
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004298 base_branch = args[0]
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004299 base_has_submodules = IsSubmoduleMergeCommit(base_branch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004300
sbc@chromium.org71437c02015-04-09 19:29:40 +00004301 if git_common.is_dirty_git_tree(cmd):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004302 return 1
4303
4304 # This rev-list syntax means "show all commits not in my branch that
4305 # are in base_branch".
4306 upstream_commits = RunGit(['rev-list', '^' + cl.GetBranchRef(),
4307 base_branch]).splitlines()
4308 if upstream_commits:
vapiera7fbd5a2016-06-16 09:17:49 -07004309 print('Base branch "%s" has %d commits '
4310 'not in this branch.' % (base_branch, len(upstream_commits)))
4311 print('Run "git merge %s" before attempting to %s.' % (base_branch, cmd))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004312 return 1
4313
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004314 # This is the revision `svn dcommit` will commit on top of.
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004315 svn_head = None
4316 if cmd == 'dcommit' or base_has_submodules:
4317 svn_head = RunGit(['log', '--grep=^git-svn-id:', '-1',
4318 '--pretty=format:%H'])
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004319
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004320 if cmd == 'dcommit':
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004321 # If the base_head is a submodule merge commit, the first parent of the
4322 # base_head should be a git-svn commit, which is what we're interested in.
4323 base_svn_head = base_branch
4324 if base_has_submodules:
4325 base_svn_head += '^1'
4326
4327 extra_commits = RunGit(['rev-list', '^' + svn_head, base_svn_head])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004328 if extra_commits:
vapiera7fbd5a2016-06-16 09:17:49 -07004329 print('This branch has %d additional commits not upstreamed yet.'
4330 % len(extra_commits.splitlines()))
4331 print('Upstream "%s" or rebase this branch on top of the upstream trunk '
4332 'before attempting to %s.' % (base_branch, cmd))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004333 return 1
4334
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004335 merge_base = RunGit(['merge-base', base_branch, 'HEAD']).strip()
maruel@chromium.orgb0a63912012-01-17 18:10:16 +00004336 if not options.bypass_hooks:
maruel@chromium.org13f623c2011-07-22 16:02:23 +00004337 author = None
4338 if options.contributor:
4339 author = re.search(r'\<(.*)\>', options.contributor).group(1)
maruel@chromium.orgb0a63912012-01-17 18:10:16 +00004340 hook_results = cl.RunHook(
4341 committing=True,
maruel@chromium.orgb0a63912012-01-17 18:10:16 +00004342 may_prompt=not options.force,
4343 verbose=options.verbose,
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004344 change=cl.GetChange(merge_base, author))
maruel@chromium.orgb0a63912012-01-17 18:10:16 +00004345 if not hook_results.should_continue():
4346 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004347
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004348 # Check the tree status if the tree status URL is set.
4349 status = GetTreeStatus()
4350 if 'closed' == status:
4351 print('The tree is closed. Please wait for it to reopen. Use '
4352 '"git cl %s --bypass-hooks" to commit on a closed tree.' % cmd)
4353 return 1
4354 elif 'unknown' == status:
4355 print('Unable to determine tree status. Please verify manually and '
4356 'use "git cl %s --bypass-hooks" to commit on a closed tree.' % cmd)
4357 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004358
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004359 change_desc = ChangeDescription(options.message)
4360 if not change_desc.description and cl.GetIssue():
4361 change_desc = ChangeDescription(cl.GetDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004362
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004363 if not change_desc.description:
erg@chromium.org1a173982012-08-29 20:43:05 +00004364 if not cl.GetIssue() and options.bypass_hooks:
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004365 change_desc = ChangeDescription(CreateDescriptionFromLog([merge_base]))
erg@chromium.org1a173982012-08-29 20:43:05 +00004366 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004367 print('No description set.')
4368 print('Visit %s/edit to set it.' % (cl.GetIssueURL()))
erg@chromium.org1a173982012-08-29 20:43:05 +00004369 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004370
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004371 # Keep a separate copy for the commit message, because the commit message
4372 # contains the link to the Rietveld issue, while the Rietveld message contains
4373 # the commit viewvc url.
maruel@chromium.orge52678e2013-04-26 18:34:44 +00004374 # Keep a separate copy for the commit message.
4375 if cl.GetIssue():
maruel@chromium.orgcf087782013-07-23 13:08:48 +00004376 change_desc.update_reviewers(cl.GetApprovingReviewers())
maruel@chromium.orge52678e2013-04-26 18:34:44 +00004377
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004378 commit_desc = ChangeDescription(change_desc.description)
maruel@chromium.orgcc73ad62011-07-06 17:39:26 +00004379 if cl.GetIssue():
smut@google.com4c61dcc2015-06-08 22:31:29 +00004380 # Xcode won't linkify this URL unless there is a non-whitespace character
sergiyb@chromium.org4b39c5f2015-07-07 10:33:12 +00004381 # after it. Add a period on a new line to circumvent this. Also add a space
4382 # before the period to make sure that Gitiles continues to correctly resolve
4383 # the URL.
4384 commit_desc.append_footer('Review URL: %s .' % cl.GetIssueURL())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004385 if options.contributor:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004386 commit_desc.append_footer('Patch from %s.' % options.contributor)
4387
agable@chromium.orgeec3ea32013-08-15 20:31:39 +00004388 print('Description:')
4389 print(commit_desc.description)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004390
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004391 branches = [merge_base, cl.GetBranchRef()]
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004392 if not options.force:
iannucci@chromium.org79540052012-10-19 23:15:26 +00004393 print_stats(options.similarity, options.find_copies, branches)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004394
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004395 # We want to squash all this branch's commits into one commit with the proper
4396 # description. We do this by doing a "reset --soft" to the base branch (which
4397 # keeps the working copy the same), then dcommitting that. If origin/master
4398 # has a submodule merge commit, we'll also need to cherry-pick the squashed
4399 # commit onto a branch based on the git-svn head.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004400 MERGE_BRANCH = 'git-cl-commit'
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004401 CHERRY_PICK_BRANCH = 'git-cl-cherry-pick'
4402 # Delete the branches if they exist.
4403 for branch in [MERGE_BRANCH, CHERRY_PICK_BRANCH]:
4404 showref_cmd = ['show-ref', '--quiet', '--verify', 'refs/heads/%s' % branch]
4405 result = RunGitWithCode(showref_cmd)
4406 if result[0] == 0:
4407 RunGit(['branch', '-D', branch])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004408
4409 # We might be in a directory that's present in this branch but not in the
4410 # trunk. Move up to the top of the tree so that git commands that expect a
4411 # valid CWD won't fail after we check out the merge branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004412 rel_base_path = settings.GetRelativeRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004413 if rel_base_path:
4414 os.chdir(rel_base_path)
4415
4416 # Stuff our change into the merge branch.
4417 # We wrap in a try...finally block so if anything goes wrong,
4418 # we clean up the branches.
maruel@chromium.org0ba7f962011-01-11 22:13:58 +00004419 retcode = -1
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004420 pushed_to_pending = False
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004421 pending_ref = None
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004422 revision = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004423 try:
bauerb@chromium.orgb4a75c42011-03-08 08:35:38 +00004424 RunGit(['checkout', '-q', '-b', MERGE_BRANCH])
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004425 RunGit(['reset', '--soft', merge_base])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004426 if options.contributor:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004427 RunGit(
4428 [
4429 'commit', '--author', options.contributor,
4430 '-m', commit_desc.description,
4431 ])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004432 else:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004433 RunGit(['commit', '-m', commit_desc.description])
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004434 if base_has_submodules:
4435 cherry_pick_commit = RunGit(['rev-list', 'HEAD^!']).rstrip()
4436 RunGit(['branch', CHERRY_PICK_BRANCH, svn_head])
4437 RunGit(['checkout', CHERRY_PICK_BRANCH])
4438 RunGit(['cherry-pick', cherry_pick_commit])
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004439 if cmd == 'land':
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004440 remote, branch = cl.FetchUpstreamTuple(cl.GetBranch())
szager@chromium.org151ebcf2016-03-09 01:08:25 +00004441 mirror = settings.GetGitMirror(remote)
4442 pushurl = mirror.url if mirror else remote
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004443 pending_prefix = settings.GetPendingRefPrefix()
4444 if not pending_prefix or branch.startswith(pending_prefix):
4445 # If not using refs/pending/heads/* at all, or target ref is already set
4446 # to pending, then push to the target ref directly.
4447 retcode, output = RunGitWithCode(
szager@chromium.org151ebcf2016-03-09 01:08:25 +00004448 ['push', '--porcelain', pushurl, 'HEAD:%s' % branch])
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004449 pushed_to_pending = pending_prefix and branch.startswith(pending_prefix)
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004450 else:
4451 # Cherry-pick the change on top of pending ref and then push it.
4452 assert branch.startswith('refs/'), branch
4453 assert pending_prefix[-1] == '/', pending_prefix
4454 pending_ref = pending_prefix + branch[len('refs/'):]
tandriibf429402016-09-14 07:09:12 -07004455 retcode, output = PushToGitPending(pushurl, pending_ref)
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004456 pushed_to_pending = (retcode == 0)
iannucci@chromium.org34504a12014-08-29 23:51:37 +00004457 if retcode == 0:
4458 revision = RunGit(['rev-parse', 'HEAD']).strip()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004459 else:
4460 # dcommit the merge branch.
iannucci@chromium.orga1950c42014-12-05 22:15:56 +00004461 cmd_args = [
kjellander@chromium.org6abc6522014-12-02 07:34:49 +00004462 'svn', 'dcommit',
4463 '-C%s' % options.similarity,
4464 '--no-rebase', '--rmdir',
4465 ]
4466 if settings.GetForceHttpsCommitUrl():
4467 # Allow forcing https commit URLs for some projects that don't allow
4468 # committing to http URLs (like Google Code).
4469 remote_url = cl.GetGitSvnRemoteUrl()
4470 if urlparse.urlparse(remote_url).scheme == 'http':
4471 remote_url = remote_url.replace('http://', 'https://')
iannucci@chromium.orga1950c42014-12-05 22:15:56 +00004472 cmd_args.append('--commit-url=%s' % remote_url)
4473 _, output = RunGitWithCode(cmd_args)
iannucci@chromium.org34504a12014-08-29 23:51:37 +00004474 if 'Committed r' in output:
4475 revision = re.match(
4476 '.*?\nCommitted r(\\d+)', output, re.DOTALL).group(1)
4477 logging.debug(output)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004478 finally:
4479 # And then swap back to the original branch and clean up.
4480 RunGit(['checkout', '-q', cl.GetBranch()])
4481 RunGit(['branch', '-D', MERGE_BRANCH])
szager@chromium.org9bb85e22012-06-13 20:28:23 +00004482 if base_has_submodules:
4483 RunGit(['branch', '-D', CHERRY_PICK_BRANCH])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004484
iannucci@chromium.org34504a12014-08-29 23:51:37 +00004485 if not revision:
vapiera7fbd5a2016-06-16 09:17:49 -07004486 print('Failed to push. If this persists, please file a bug.')
iannucci@chromium.org34504a12014-08-29 23:51:37 +00004487 return 1
iannucci@chromium.org6c217b12014-08-29 22:10:59 +00004488
iannucci@chromium.orgbbe9cc52014-09-05 18:25:51 +00004489 killed = False
iannucci@chromium.org6c217b12014-08-29 22:10:59 +00004490 if pushed_to_pending:
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004491 try:
4492 revision = WaitForRealCommit(remote, revision, base_branch, branch)
4493 # We set pushed_to_pending to False, since it made it all the way to the
4494 # real ref.
4495 pushed_to_pending = False
4496 except KeyboardInterrupt:
iannucci@chromium.orgbbe9cc52014-09-05 18:25:51 +00004497 killed = True
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004498
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004499 if cl.GetIssue():
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004500 to_pending = ' to pending queue' if pushed_to_pending else ''
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004501 viewvc_url = settings.GetViewVCUrl()
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004502 if not to_pending:
4503 if viewvc_url and revision:
4504 change_desc.append_footer(
4505 'Committed: %s%s' % (viewvc_url, revision))
4506 elif revision:
4507 change_desc.append_footer('Committed: %s' % (revision,))
vapiera7fbd5a2016-06-16 09:17:49 -07004508 print('Closing issue '
4509 '(you may be prompted for your codereview password)...')
maruel@chromium.org78936cb2013-04-11 00:17:52 +00004510 cl.UpdateDescription(change_desc.description)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004511 cl.CloseIssue()
maruel@chromium.org1033efd2013-07-23 23:25:09 +00004512 props = cl.GetIssueProperties()
sadrul@chromium.org34b5d822013-02-18 01:39:24 +00004513 patch_num = len(props['patchsets'])
rmistry@google.com52d224a2014-08-27 14:44:41 +00004514 comment = "Committed patchset #%d (id:%d)%s manually as %s" % (
mark@chromium.org782570c2014-09-26 21:48:02 +00004515 patch_num, props['patchsets'][-1], to_pending, revision)
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004516 if options.bypass_hooks:
4517 comment += ' (tree was closed).' if GetTreeStatus() == 'closed' else '.'
4518 else:
4519 comment += ' (presubmit successful).'
iannucci@chromium.orgb85a3162013-01-26 01:11:13 +00004520 cl.RpcServer().add_comment(cl.GetIssue(), comment)
maruel@chromium.org0ba7f962011-01-11 22:13:58 +00004521
iannucci@chromium.org6c217b12014-08-29 22:10:59 +00004522 if pushed_to_pending:
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004523 _, branch = cl.FetchUpstreamTuple(cl.GetBranch())
vapiera7fbd5a2016-06-16 09:17:49 -07004524 print('The commit is in the pending queue (%s).' % pending_ref)
4525 print('It will show up on %s in ~1 min, once it gets a Cr-Commit-Position '
4526 'footer.' % branch)
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004527
iannucci@chromium.org6c217b12014-08-29 22:10:59 +00004528 hook = POSTUPSTREAM_HOOK_PATTERN % cmd
4529 if os.path.isfile(hook):
4530 RunCommand([hook, merge_base], error_ok=True)
maruel@chromium.org0ba7f962011-01-11 22:13:58 +00004531
iannucci@chromium.orgbbe9cc52014-09-05 18:25:51 +00004532 return 1 if killed else 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004533
4534
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004535def WaitForRealCommit(remote, pushed_commit, local_base_ref, real_ref):
vapiera7fbd5a2016-06-16 09:17:49 -07004536 print()
4537 print('Waiting for commit to be landed on %s...' % real_ref)
4538 print('(If you are impatient, you may Ctrl-C once without harm)')
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004539 target_tree = RunGit(['rev-parse', '%s:' % pushed_commit]).strip()
4540 current_rev = RunGit(['rev-parse', local_base_ref]).strip()
szager@chromium.org151ebcf2016-03-09 01:08:25 +00004541 mirror = settings.GetGitMirror(remote)
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004542
4543 loop = 0
4544 while True:
4545 sys.stdout.write('fetching (%d)... \r' % loop)
4546 sys.stdout.flush()
4547 loop += 1
4548
szager@chromium.org151ebcf2016-03-09 01:08:25 +00004549 if mirror:
4550 mirror.populate()
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004551 RunGit(['retry', 'fetch', remote, real_ref], stderr=subprocess2.VOID)
4552 to_rev = RunGit(['rev-parse', 'FETCH_HEAD']).strip()
4553 commits = RunGit(['rev-list', '%s..%s' % (current_rev, to_rev)])
4554 for commit in commits.splitlines():
4555 if RunGit(['rev-parse', '%s:' % commit]).strip() == target_tree:
vapiera7fbd5a2016-06-16 09:17:49 -07004556 print('Found commit on %s' % real_ref)
iannucci@chromium.orge6896b52014-08-29 01:38:03 +00004557 return commit
4558
4559 current_rev = to_rev
4560
4561
tandriibf429402016-09-14 07:09:12 -07004562def PushToGitPending(remote, pending_ref):
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004563 """Fetches pending_ref, cherry-picks current HEAD on top of it, pushes.
4564
4565 Returns:
4566 (retcode of last operation, output log of last operation).
4567 """
4568 assert pending_ref.startswith('refs/'), pending_ref
4569 local_pending_ref = 'refs/git-cl/' + pending_ref[len('refs/'):]
4570 cherry = RunGit(['rev-parse', 'HEAD']).strip()
4571 code = 0
4572 out = ''
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004573 max_attempts = 3
4574 attempts_left = max_attempts
4575 while attempts_left:
4576 if attempts_left != max_attempts:
vapiera7fbd5a2016-06-16 09:17:49 -07004577 print('Retrying, %d attempts left...' % (attempts_left - 1,))
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004578 attempts_left -= 1
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004579
4580 # Fetch. Retry fetch errors.
vapiera7fbd5a2016-06-16 09:17:49 -07004581 print('Fetching pending ref %s...' % pending_ref)
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004582 code, out = RunGitWithCode(
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004583 ['retry', 'fetch', remote, '+%s:%s' % (pending_ref, local_pending_ref)])
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004584 if code:
vapiera7fbd5a2016-06-16 09:17:49 -07004585 print('Fetch failed with exit code %d.' % code)
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004586 if out.strip():
vapiera7fbd5a2016-06-16 09:17:49 -07004587 print(out.strip())
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004588 continue
4589
4590 # Try to cherry pick. Abort on merge conflicts.
vapiera7fbd5a2016-06-16 09:17:49 -07004591 print('Cherry-picking commit on top of pending ref...')
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004592 RunGitWithCode(['checkout', local_pending_ref], suppress_stderr=True)
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004593 code, out = RunGitWithCode(['cherry-pick', cherry])
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004594 if code:
vapiera7fbd5a2016-06-16 09:17:49 -07004595 print('Your patch doesn\'t apply cleanly to ref \'%s\', '
4596 'the following files have merge conflicts:' % pending_ref)
4597 print(RunGit(['diff', '--name-status', '--diff-filter=U']).strip())
4598 print('Please rebase your patch and try again.')
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004599 RunGitWithCode(['cherry-pick', '--abort'])
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004600 return code, out
4601
4602 # Applied cleanly, try to push now. Retry on error (flake or non-ff push).
vapiera7fbd5a2016-06-16 09:17:49 -07004603 print('Pushing commit to %s... It can take a while.' % pending_ref)
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004604 code, out = RunGitWithCode(
4605 ['retry', 'push', '--porcelain', remote, 'HEAD:%s' % pending_ref])
4606 if code == 0:
4607 # Success.
vapiera7fbd5a2016-06-16 09:17:49 -07004608 print('Commit pushed to pending ref successfully!')
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004609 return code, out
4610
vapiera7fbd5a2016-06-16 09:17:49 -07004611 print('Push failed with exit code %d.' % code)
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004612 if out.strip():
vapiera7fbd5a2016-06-16 09:17:49 -07004613 print(out.strip())
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004614 if IsFatalPushFailure(out):
vapiera7fbd5a2016-06-16 09:17:49 -07004615 print('Fatal push error. Make sure your .netrc credentials and git '
4616 'user.email are correct and you have push access to the repo.')
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004617 return code, out
4618
vapiera7fbd5a2016-06-16 09:17:49 -07004619 print('All attempts to push to pending ref failed.')
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004620 return code, out
4621
4622
vadimsh@chromium.org749fbd92014-08-26 21:57:53 +00004623def IsFatalPushFailure(push_stdout):
4624 """True if retrying push won't help."""
4625 return '(prohibited by Gerrit)' in push_stdout
4626
4627
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004628@subcommand.usage('[upstream branch to apply against]')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004629def CMDdcommit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004630 """Commits the current changelist via git-svn."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004631 if not settings.GetIsGitSvn():
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +00004632 if git_footers.get_footer_svn_id():
mmoss@chromium.orgf0e41522015-06-10 19:52:01 +00004633 # If it looks like previous commits were mirrored with git-svn.
agable3b9a5bb2016-09-22 11:32:08 -07004634 message = """This repository appears to be a git-svn mirror, but we
4635don't support git-svn mirrors anymore."""
mmoss@chromium.orgf0e41522015-06-10 19:52:01 +00004636 else:
4637 message = """This doesn't appear to be an SVN repository.
4638If your project has a true, writeable git repository, you probably want to run
4639'git cl land' instead.
4640If your project has a git mirror of an upstream SVN master, you probably need
4641to run 'git svn init'.
4642
4643Using the wrong command might cause your commit to appear to succeed, and the
4644review to be closed, without actually landing upstream. If you choose to
4645proceed, please verify that the commit lands upstream as expected."""
thakis@chromium.orgcde3bb62011-01-20 01:16:14 +00004646 print(message)
maruel@chromium.org90541732011-04-01 17:54:18 +00004647 ask_for_data('[Press enter to dcommit or ctrl-C to quit]')
tandrii3bb82ff2016-06-17 07:36:36 -07004648 print('WARNING: chrome infrastructure is migrating SVN repos to Git.\n'
4649 'Please let us know of this project you are committing to:'
4650 ' http://crbug.com/600451')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004651 return SendUpstream(parser, args, 'dcommit')
4652
4653
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004654@subcommand.usage('[upstream branch to apply against]')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004655def CMDland(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004656 """Commits the current changelist via git."""
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +00004657 if settings.GetIsGitSvn() or git_footers.get_footer_svn_id():
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004658 print('This appears to be an SVN repository.')
4659 print('Are you sure you didn\'t mean \'git cl dcommit\'?')
mmoss@chromium.orgf0e41522015-06-10 19:52:01 +00004660 print('(Ignore if this is the first commit after migrating from svn->git)')
maruel@chromium.org90541732011-04-01 17:54:18 +00004661 ask_for_data('[Press enter to push or ctrl-C to quit]')
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +00004662 return SendUpstream(parser, args, 'land')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004663
4664
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004665@subcommand.usage('<patch url or issue id or issue url>')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004666def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004667 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004668 parser.add_option('-b', dest='newbranch',
4669 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004670 parser.add_option('-f', '--force', action='store_true',
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004671 help='with -b, clobber any existing branch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004672 parser.add_option('-d', '--directory', action='store', metavar='DIR',
4673 help='Change to the directory DIR immediately, '
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004674 'before doing anything else. Rietveld only.')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004675 parser.add_option('--reject', action='store_true',
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +00004676 help='failed patches spew .rej files rather than '
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004677 'attempting a 3-way merge. Rietveld only.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004678 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004679 help='don\'t commit after patch applies. Rietveld only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004680
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004681
4682 group = optparse.OptionGroup(
4683 parser,
4684 'Options for continuing work on the current issue uploaded from a '
4685 'different clone (e.g. different machine). Must be used independently '
4686 'from the other options. No issue number should be specified, and the '
4687 'branch must have an issue number associated with it')
4688 group.add_option('--reapply', action='store_true', dest='reapply',
4689 help='Reset the branch and reapply the issue.\n'
4690 'CAUTION: This will undo any local changes in this '
4691 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004692
4693 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004694 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004695 parser.add_option_group(group)
4696
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004697 auth.add_auth_options(parser)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004698 _add_codereview_select_options(parser)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004699 (options, args) = parser.parse_args(args)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004700 _process_codereview_select_options(parser, options)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004701 auth_config = auth.extract_auth_config_from_options(options)
4702
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004703
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004704 if options.reapply :
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004705 if options.newbranch:
4706 parser.error('--reapply works on the current branch only')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004707 if len(args) > 0:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004708 parser.error('--reapply implies no additional arguments')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004709
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004710 cl = Changelist(auth_config=auth_config,
4711 codereview=options.forced_codereview)
4712 if not cl.GetIssue():
4713 parser.error('current branch must have an associated issue')
4714
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004715 upstream = cl.GetUpstreamBranch()
4716 if upstream == None:
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004717 parser.error('No upstream branch specified. Cannot reset branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004718
4719 RunGit(['reset', '--hard', upstream])
4720 if options.pull:
4721 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004722
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004723 return cl.CMDPatchIssue(cl.GetIssue(), options.reject, options.nocommit,
4724 options.directory)
4725
4726 if len(args) != 1 or not args[0]:
4727 parser.error('Must specify issue number or url')
4728
4729 # We don't want uncommitted changes mixed up with the patch.
4730 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004731 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004732
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004733 if options.newbranch:
4734 if options.force:
4735 RunGit(['branch', '-D', options.newbranch],
4736 stderr=subprocess2.PIPE, error_ok=True)
4737 RunGit(['new-branch', options.newbranch])
tandriidf09a462016-08-18 16:23:55 -07004738 elif not GetCurrentBranch():
4739 DieWithError('A branch is required to apply patch. Hint: use -b option.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004740
4741 cl = Changelist(auth_config=auth_config, codereview=options.forced_codereview)
4742
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004743 if cl.IsGerrit():
4744 if options.reject:
4745 parser.error('--reject is not supported with Gerrit codereview.')
4746 if options.nocommit:
4747 parser.error('--nocommit is not supported with Gerrit codereview.')
4748 if options.directory:
4749 parser.error('--directory is not supported with Gerrit codereview.')
4750
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004751 return cl.CMDPatchIssue(args[0], options.reject, options.nocommit,
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004752 options.directory)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004753
4754
4755def CMDrebase(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004756 """Rebases current branch on top of svn repo."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004757 # Provide a wrapper for git svn rebase to help avoid accidental
4758 # git svn dcommit.
4759 # It's the only command that doesn't use parser at all since we just defer
4760 # execution to git-svn.
bratell@opera.com82b91cd2013-07-09 06:33:41 +00004761
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004762 return RunGitWithCode(['svn', 'rebase'] + args)[1]
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004763
4764
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004765def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004766 """Fetches the tree status and returns either 'open', 'closed',
4767 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004768 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004769 if url:
4770 status = urllib2.urlopen(url).read().lower()
4771 if status.find('closed') != -1 or status == '0':
4772 return 'closed'
4773 elif status.find('open') != -1 or status == '1':
4774 return 'open'
4775 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004776 return 'unset'
4777
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004778
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004779def GetTreeStatusReason():
4780 """Fetches the tree status from a json url and returns the message
4781 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004782 url = settings.GetTreeStatusUrl()
4783 json_url = urlparse.urljoin(url, '/current?format=json')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004784 connection = urllib2.urlopen(json_url)
4785 status = json.loads(connection.read())
4786 connection.close()
4787 return status['message']
4788
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004789
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004790def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004791 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004792 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004793 status = GetTreeStatus()
4794 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004795 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004796 return 2
4797
vapiera7fbd5a2016-06-16 09:17:49 -07004798 print('The tree is %s' % status)
4799 print()
4800 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004801 if status != 'open':
4802 return 1
4803 return 0
4804
4805
maruel@chromium.org15192402012-09-06 12:38:29 +00004806def CMDtry(parser, args):
qyearsley1fdfcb62016-10-24 13:22:03 -07004807 """Triggers try jobs using either BuildBucket or CQ dry run."""
tandrii1838bad2016-10-06 00:10:52 -07004808 group = optparse.OptionGroup(parser, 'Try job options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004809 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004810 '-b', '--bot', action='append',
4811 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4812 'times to specify multiple builders. ex: '
4813 '"-b win_rel -b win_layout". See '
4814 'the try server waterfall for the builders name and the tests '
4815 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004816 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004817 '-B', '--bucket', default='',
4818 help=('Buildbucket bucket to send the try requests.'))
4819 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004820 '-m', '--master', default='',
4821 help=('Specify a try master where to run the tries.'))
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00004822 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004823 '-r', '--revision',
tandriif7b29d42016-10-07 08:45:41 -07004824 help='Revision to use for the try job; default: the revision will '
4825 'be determined by the try recipe that builder runs, which usually '
4826 'defaults to HEAD of origin/master')
maruel@chromium.org15192402012-09-06 12:38:29 +00004827 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004828 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004829 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004830 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004831 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004832 '--project',
4833 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004834 'in recipe to determine to which repository or directory to '
4835 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004836 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004837 '-p', '--property', dest='properties', action='append', default=[],
4838 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004839 'key2=value2 etc. The value will be treated as '
4840 'json if decodable, or as string otherwise. '
4841 'NOTE: using this may make your try job not usable for CQ, '
4842 'which will then schedule another try job with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004843 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004844 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4845 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004846 parser.add_option_group(group)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004847 auth.add_auth_options(parser)
maruel@chromium.org15192402012-09-06 12:38:29 +00004848 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004849 auth_config = auth.extract_auth_config_from_options(options)
maruel@chromium.org15192402012-09-06 12:38:29 +00004850
machenbach@chromium.org45453142015-09-15 08:45:22 +00004851 # Make sure that all properties are prop=value pairs.
4852 bad_params = [x for x in options.properties if '=' not in x]
4853 if bad_params:
4854 parser.error('Got properties with missing "=": %s' % bad_params)
4855
maruel@chromium.org15192402012-09-06 12:38:29 +00004856 if args:
4857 parser.error('Unknown arguments: %s' % args)
4858
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004859 cl = Changelist(auth_config=auth_config)
maruel@chromium.org15192402012-09-06 12:38:29 +00004860 if not cl.GetIssue():
4861 parser.error('Need to upload first')
4862
tandriie113dfd2016-10-11 10:20:12 -07004863 error_message = cl.CannotTriggerTryJobReason()
4864 if error_message:
qyearsley99e2cdf2016-10-23 12:51:41 -07004865 parser.error('Can\'t trigger try jobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004866
borenet6c0efe62016-10-19 08:13:29 -07004867 if options.bucket and options.master:
4868 parser.error('Only one of --bucket and --master may be used.')
4869
qyearsley1fdfcb62016-10-24 13:22:03 -07004870 buckets = _get_bucket_map(cl, options, parser)
phajdan.jr@chromium.org8da7f272014-03-14 01:28:39 +00004871
qyearsleydd49f942016-10-28 11:57:22 -07004872 # If no bots are listed and we couldn't get a list based on PRESUBMIT files,
4873 # then we default to triggering a CQ dry run (see http://crbug.com/625697).
qyearsley1fdfcb62016-10-24 13:22:03 -07004874 if not buckets:
qyearsley1fdfcb62016-10-24 13:22:03 -07004875 if options.verbose:
4876 print('git cl try with no bots now defaults to CQ Dry Run.')
4877 return cl.TriggerDryRun()
stip@chromium.org43064fd2013-12-18 20:07:44 +00004878
borenet6c0efe62016-10-19 08:13:29 -07004879 for builders in buckets.itervalues():
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00004880 if any('triggered' in b for b in builders):
vapiera7fbd5a2016-06-16 09:17:49 -07004881 print('ERROR You are trying to send a job to a triggered bot. This type '
tandriide281ae2016-10-12 06:02:30 -07004882 'of bot requires an initial job from a parent (usually a builder). '
4883 'Instead send your job to the parent.\n'
vapiera7fbd5a2016-06-16 09:17:49 -07004884 'Bot list: %s' % builders, file=sys.stderr)
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00004885 return 1
ilevy@chromium.orgf3b21232012-09-24 20:48:55 +00004886
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004887 patchset = cl.GetMostRecentPatchset()
Ravi Mistryfda50ca2016-11-14 10:19:18 -05004888 # TODO(tandrii): Checking local patchset against remote patchset is only
4889 # supported for Rietveld. Extend it to Gerrit or remove it completely.
4890 if not cl.IsGerrit() and patchset != cl.GetPatchset():
tandriide281ae2016-10-12 06:02:30 -07004891 print('Warning: Codereview server has newer patchsets (%s) than most '
4892 'recent upload from local checkout (%s). Did a previous upload '
4893 'fail?\n'
4894 'By default, git cl try uses the latest patchset from '
4895 'codereview, continuing to use patchset %s.\n' %
4896 (patchset, cl.GetPatchset(), patchset))
qyearsley1fdfcb62016-10-24 13:22:03 -07004897
tandrii568043b2016-10-11 07:49:18 -07004898 try:
borenet6c0efe62016-10-19 08:13:29 -07004899 _trigger_try_jobs(auth_config, cl, buckets, options, 'git_cl_try',
4900 patchset)
tandrii568043b2016-10-11 07:49:18 -07004901 except BuildbucketResponseException as ex:
4902 print('ERROR: %s' % ex)
4903 return 1
maruel@chromium.org15192402012-09-06 12:38:29 +00004904 return 0
4905
4906
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004907def CMDtry_results(parser, args):
tandrii1838bad2016-10-06 00:10:52 -07004908 """Prints info about try jobs associated with current CL."""
4909 group = optparse.OptionGroup(parser, 'Try job results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004910 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004911 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004912 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004913 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004914 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004915 '--color', action='store_true', default=setup_color.IS_TTY,
4916 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004917 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004918 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4919 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004920 group.add_option(
4921 '--json', help='Path of JSON output file to write try job results to.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004922 parser.add_option_group(group)
4923 auth.add_auth_options(parser)
4924 options, args = parser.parse_args(args)
4925 if args:
4926 parser.error('Unrecognized args: %s' % ' '.join(args))
4927
4928 auth_config = auth.extract_auth_config_from_options(options)
4929 cl = Changelist(auth_config=auth_config)
4930 if not cl.GetIssue():
4931 parser.error('Need to upload first')
4932
tandrii221ab252016-10-06 08:12:04 -07004933 patchset = options.patchset
4934 if not patchset:
4935 patchset = cl.GetMostRecentPatchset()
4936 if not patchset:
4937 parser.error('Codereview doesn\'t know about issue %s. '
4938 'No access to issue or wrong issue number?\n'
4939 'Either upload first, or pass --patchset explicitely' %
4940 cl.GetIssue())
4941
Ravi Mistryfda50ca2016-11-14 10:19:18 -05004942 # TODO(tandrii): Checking local patchset against remote patchset is only
4943 # supported for Rietveld. Extend it to Gerrit or remove it completely.
4944 if not cl.IsGerrit() and patchset != cl.GetPatchset():
tandrii45b2a582016-10-11 03:14:16 -07004945 print('Warning: Codereview server has newer patchsets (%s) than most '
4946 'recent upload from local checkout (%s). Did a previous upload '
4947 'fail?\n'
tandriide281ae2016-10-12 06:02:30 -07004948 'By default, git cl try-results uses the latest patchset from '
4949 'codereview, continuing to use patchset %s.\n' %
tandrii45b2a582016-10-11 03:14:16 -07004950 (patchset, cl.GetPatchset(), patchset))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004951 try:
tandrii221ab252016-10-06 08:12:04 -07004952 jobs = fetch_try_jobs(auth_config, cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004953 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004954 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004955 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004956 if options.json:
4957 write_try_results_json(options.json, jobs)
4958 else:
4959 print_try_jobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004960 return 0
4961
4962
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004963@subcommand.usage('[new upstream branch]')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004964def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004965 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004966 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004967 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004968 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004969
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004970 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004971 if args:
4972 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004973 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07004974 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004975 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07004976 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004977
4978 # Clear configured merge-base, if there is one.
4979 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004980 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004981 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004982 return 0
4983
4984
thestig@chromium.org00858c82013-12-02 23:08:03 +00004985def CMDweb(parser, args):
4986 """Opens the current CL in the web browser."""
4987 _, args = parser.parse_args(args)
4988 if args:
4989 parser.error('Unrecognized args: %s' % ' '.join(args))
4990
4991 issue_url = Changelist().GetIssueURL()
4992 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07004993 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004994 return 1
4995
4996 webbrowser.open(issue_url)
4997 return 0
4998
4999
maruel@chromium.org27bb3872011-05-30 20:33:19 +00005000def CMDset_commit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005001 """Sets the commit bit to trigger the Commit Queue."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005002 parser.add_option('-d', '--dry-run', action='store_true',
5003 help='trigger in dry run mode')
5004 parser.add_option('-c', '--clear', action='store_true',
5005 help='stop CQ run, if any')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005006 auth.add_auth_options(parser)
iannuccie53c9352016-08-17 14:40:40 -07005007 _add_codereview_issue_select_options(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005008 options, args = parser.parse_args(args)
iannuccie53c9352016-08-17 14:40:40 -07005009 _process_codereview_issue_select_options(parser, options)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005010 auth_config = auth.extract_auth_config_from_options(options)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00005011 if args:
5012 parser.error('Unrecognized args: %s' % ' '.join(args))
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005013 if options.dry_run and options.clear:
5014 parser.error('Make up your mind: both --dry-run and --clear not allowed')
5015
iannuccie53c9352016-08-17 14:40:40 -07005016 cl = Changelist(auth_config=auth_config, issue=options.issue,
5017 codereview=options.forced_codereview)
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005018 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07005019 state = _CQState.NONE
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005020 elif options.dry_run:
qyearsley1fdfcb62016-10-24 13:22:03 -07005021 # TODO(qyearsley): Use cl.TriggerDryRun.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005022 state = _CQState.DRY_RUN
5023 else:
5024 state = _CQState.COMMIT
5025 if not cl.GetIssue():
5026 parser.error('Must upload the issue first')
tandrii9de9ec62016-07-13 03:01:59 -07005027 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00005028 return 0
5029
5030
groby@chromium.org411034a2013-02-26 15:12:01 +00005031def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005032 """Closes the issue."""
iannuccie53c9352016-08-17 14:40:40 -07005033 _add_codereview_issue_select_options(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005034 auth.add_auth_options(parser)
5035 options, args = parser.parse_args(args)
iannuccie53c9352016-08-17 14:40:40 -07005036 _process_codereview_issue_select_options(parser, options)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005037 auth_config = auth.extract_auth_config_from_options(options)
groby@chromium.org411034a2013-02-26 15:12:01 +00005038 if args:
5039 parser.error('Unrecognized args: %s' % ' '.join(args))
iannuccie53c9352016-08-17 14:40:40 -07005040 cl = Changelist(auth_config=auth_config, issue=options.issue,
5041 codereview=options.forced_codereview)
groby@chromium.org411034a2013-02-26 15:12:01 +00005042 # Ensure there actually is an issue to close.
5043 cl.GetDescription()
5044 cl.CloseIssue()
5045 return 0
5046
5047
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005048def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00005049 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07005050 parser.add_option(
5051 '--stat',
5052 action='store_true',
5053 dest='stat',
5054 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005055 auth.add_auth_options(parser)
5056 options, args = parser.parse_args(args)
5057 auth_config = auth.extract_auth_config_from_options(options)
5058 if args:
5059 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00005060
5061 # Uncommitted (staged and unstaged) changes will be destroyed by
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005062 # "git reset --hard" if there are merging conflicts in CMDPatchIssue().
wychen@chromium.org46309bf2015-04-03 21:04:49 +00005063 # Staged changes would be committed along with the patch from last
5064 # upload, hence counted toward the "last upload" side in the final
5065 # diff output, and this is not what we want.
sbc@chromium.org71437c02015-04-09 19:29:40 +00005066 if git_common.is_dirty_git_tree('diff'):
wychen@chromium.org46309bf2015-04-03 21:04:49 +00005067 return 1
5068
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005069 cl = Changelist(auth_config=auth_config)
sbc@chromium.org78dc9842013-11-25 18:43:44 +00005070 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005071 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00005072 if not issue:
5073 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005074 TMP_BRANCH = 'git-cl-diff'
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005075 base_branch = cl.GetCommonAncestorWithUpstream()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005076
5077 # Create a new branch based on the merge-base
5078 RunGit(['checkout', '-q', '-b', TMP_BRANCH, base_branch])
tandrii@chromium.org534f67a2016-04-07 18:47:05 +00005079 # Clear cached branch in cl object, to avoid overwriting original CL branch
5080 # properties.
5081 cl.ClearBranch()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005082 try:
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005083 rtn = cl.CMDPatchIssue(issue, reject=False, nocommit=False, directory=None)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005084 if rtn != 0:
wychen@chromium.orga872e752015-04-28 23:42:18 +00005085 RunGit(['reset', '--hard'])
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005086 return rtn
5087
wychen@chromium.org06928532015-02-03 02:11:29 +00005088 # Switch back to starting branch and diff against the temporary
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005089 # branch containing the latest rietveld patch.
thomasanderson074beb22016-08-29 14:03:20 -07005090 cmd = ['git', 'diff']
5091 if options.stat:
5092 cmd.append('--stat')
5093 cmd.extend([TMP_BRANCH, branch, '--'])
5094 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005095 finally:
5096 RunGit(['checkout', '-q', branch])
5097 RunGit(['branch', '-D', TMP_BRANCH])
5098
5099 return 0
5100
5101
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005102def CMDowners(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00005103 """Interactively find the owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005104 parser.add_option(
5105 '--no-color',
5106 action='store_true',
5107 help='Use this option to disable color output')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005108 auth.add_auth_options(parser)
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005109 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005110 auth_config = auth.extract_auth_config_from_options(options)
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005111
5112 author = RunGit(['config', 'user.email']).strip() or None
5113
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005114 cl = Changelist(auth_config=auth_config)
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005115
5116 if args:
5117 if len(args) > 1:
5118 parser.error('Unknown args')
5119 base_branch = args[0]
5120 else:
5121 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005122 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005123
5124 change = cl.GetChange(base_branch, None)
5125 return owners_finder.OwnersFinder(
5126 [f.LocalPath() for f in
5127 cl.GetChange(base_branch, None).AffectedFiles()],
5128 change.RepositoryRoot(), author,
dtu944b6052016-07-14 14:48:21 -07005129 fopen=file, os_path=os.path,
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005130 disable_color=options.no_color).run()
5131
5132
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005133def BuildGitDiffCmd(diff_type, upstream_commit, args):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005134 """Generates a diff command."""
5135 # Generate diff for the current branch's changes.
5136 diff_cmd = ['diff', '--no-ext-diff', '--no-prefix', diff_type,
5137 upstream_commit, '--' ]
5138
5139 if args:
5140 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005141 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005142 diff_cmd.append(arg)
5143 else:
5144 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005145
5146 return diff_cmd
5147
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005148def MatchingFileType(file_name, extensions):
5149 """Returns true if the file name ends with one of the given extensions."""
5150 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005151
enne@chromium.org555cfe42014-01-29 18:21:39 +00005152@subcommand.usage('[files or directories to diff]')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005153def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005154 """Runs auto-formatting tools (clang-format etc.) on the diff."""
zengsterbf470142016-07-07 16:43:00 -07005155 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07005156 GN_EXTS = ['.gn', '.gni', '.typemap']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005157 parser.add_option('--full', action='store_true',
5158 help='Reformat the full content of all touched files')
5159 parser.add_option('--dry-run', action='store_true',
5160 help='Don\'t modify any file on disk.')
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005161 parser.add_option('--python', action='store_true',
5162 help='Format python code with yapf (experimental).')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00005163 parser.add_option('--diff', action='store_true',
5164 help='Print diff to stdout rather than modifying files.')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005165 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005166
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005167 # git diff generates paths against the root of the repository. Change
5168 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005169 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005170 if rel_base_path:
5171 os.chdir(rel_base_path)
5172
digit@chromium.org29e47272013-05-17 17:01:46 +00005173 # Grab the merge-base commit, i.e. the upstream commit of the current
5174 # branch when it was created or the last time it was rebased. This is
5175 # to cover the case where the user may have called "git fetch origin",
5176 # moving the origin branch to a newer commit, but hasn't rebased yet.
5177 upstream_commit = None
5178 cl = Changelist()
5179 upstream_branch = cl.GetUpstreamBranch()
5180 if upstream_branch:
5181 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
5182 upstream_commit = upstream_commit.strip()
5183
5184 if not upstream_commit:
5185 DieWithError('Could not find base commit for this branch. '
5186 'Are you in detached state?')
5187
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005188 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5189 diff_output = RunGit(changed_files_cmd)
5190 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005191 # Filter out files deleted by this CL
5192 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005193
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005194 clang_diff_files = [x for x in diff_files if MatchingFileType(x, CLANG_EXTS)]
5195 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
5196 dart_diff_files = [x for x in diff_files if MatchingFileType(x, ['.dart'])]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005197 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005198
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005199 top_dir = os.path.normpath(
5200 RunGit(["rev-parse", "--show-toplevel"]).rstrip('\n'))
5201
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005202 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
5203 # formatted. This is used to block during the presubmit.
5204 return_value = 0
5205
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005206 if clang_diff_files:
techtonik@gmail.com5573df12016-04-12 18:34:10 +00005207 # Locate the clang-format binary in the checkout
5208 try:
5209 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
vapierfd77ac72016-06-16 08:33:57 -07005210 except clang_format.NotFoundError as e:
techtonik@gmail.com5573df12016-04-12 18:34:10 +00005211 DieWithError(e)
5212
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005213 if opts.full:
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005214 cmd = [clang_format_tool]
5215 if not opts.dry_run and not opts.diff:
5216 cmd.append('-i')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005217 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005218 if opts.diff:
5219 sys.stdout.write(stdout)
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005220 else:
5221 env = os.environ.copy()
5222 env['PATH'] = str(os.path.dirname(clang_format_tool))
5223 try:
5224 script = clang_format.FindClangFormatScriptInChromiumTree(
5225 'clang-format-diff.py')
vapierfd77ac72016-06-16 08:33:57 -07005226 except clang_format.NotFoundError as e:
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005227 DieWithError(e)
digit@chromium.orgd6ddc1c2013-10-25 15:36:32 +00005228
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005229 cmd = [sys.executable, script, '-p0']
5230 if not opts.dry_run and not opts.diff:
5231 cmd.append('-i')
digit@chromium.orgd6ddc1c2013-10-25 15:36:32 +00005232
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005233 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
5234 diff_output = RunGit(diff_cmd)
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005235
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005236 stdout = RunCommand(cmd, stdin=diff_output, cwd=top_dir, env=env)
5237 if opts.diff:
5238 sys.stdout.write(stdout)
5239 if opts.dry_run and len(stdout) > 0:
5240 return_value = 2
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005241
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005242 # Similar code to above, but using yapf on .py files rather than clang-format
5243 # on C/C++ files
5244 if opts.python:
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005245 yapf_tool = gclient_utils.FindExecutable('yapf')
5246 if yapf_tool is None:
5247 DieWithError('yapf not found in PATH')
5248
5249 if opts.full:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005250 if python_diff_files:
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005251 cmd = [yapf_tool]
5252 if not opts.dry_run and not opts.diff:
5253 cmd.append('-i')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005254 stdout = RunCommand(cmd + python_diff_files, cwd=top_dir)
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005255 if opts.diff:
5256 sys.stdout.write(stdout)
5257 else:
5258 # TODO(sbc): yapf --lines mode still has some issues.
5259 # https://github.com/google/yapf/issues/154
5260 DieWithError('--python currently only works with --full')
5261
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005262 # Dart's formatter does not have the nice property of only operating on
5263 # modified chunks, so hard code full.
5264 if dart_diff_files:
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005265 try:
5266 command = [dart_format.FindDartFmtToolInChromiumTree()]
5267 if not opts.dry_run and not opts.diff:
5268 command.append('-w')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005269 command.extend(dart_diff_files)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005270
ppi@chromium.org6593d932016-03-03 15:41:15 +00005271 stdout = RunCommand(command, cwd=top_dir)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005272 if opts.dry_run and stdout:
5273 return_value = 2
5274 except dart_format.NotFoundError as e:
vapiera7fbd5a2016-06-16 09:17:49 -07005275 print('Warning: Unable to check Dart code formatting. Dart SDK not '
5276 'found in this checkout. Files in other languages are still '
5277 'formatted.')
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005278
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005279 # Format GN build files. Always run on full build files for canonical form.
5280 if gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005281 cmd = ['gn', 'format' ]
5282 if opts.dry_run or opts.diff:
5283 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005284 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005285 gn_ret = subprocess2.call(cmd + [gn_diff_file],
5286 shell=sys.platform == 'win32',
5287 cwd=top_dir)
5288 if opts.dry_run and gn_ret == 2:
5289 return_value = 2 # Not formatted.
5290 elif opts.diff and gn_ret == 2:
5291 # TODO this should compute and print the actual diff.
5292 print("This change has GN build file diff for " + gn_diff_file)
5293 elif gn_ret != 0:
5294 # For non-dry run cases (and non-2 return values for dry-run), a
5295 # nonzero error code indicates a failure, probably because the file
5296 # doesn't parse.
5297 DieWithError("gn format failed on " + gn_diff_file +
5298 "\nTry running 'gn format' on this file manually.")
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005299
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005300 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005301
5302
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005303@subcommand.usage('<codereview url or issue id>')
5304def CMDcheckout(parser, args):
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005305 """Checks out a branch associated with a given Rietveld or Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005306 _, args = parser.parse_args(args)
5307
5308 if len(args) != 1:
5309 parser.print_help()
5310 return 1
5311
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005312 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005313 if not issue_arg.valid:
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005314 parser.print_help()
5315 return 1
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005316 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005317
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005318 def find_issues(issueprefix):
tandrii@chromium.org26c8fd22016-04-11 21:33:21 +00005319 output = RunGit(['config', '--local', '--get-regexp',
5320 r'branch\..*\.%s' % issueprefix],
5321 error_ok=True)
5322 for key, issue in [x.split() for x in output.splitlines()]:
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005323 if issue == target_issue:
5324 yield re.sub(r'branch\.(.*)\.%s' % issueprefix, r'\1', key)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005325
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005326 branches = []
5327 for cls in _CODEREVIEW_IMPLEMENTATIONS.values():
tandrii5d48c322016-08-18 16:19:37 -07005328 branches.extend(find_issues(cls.IssueConfigKey()))
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005329 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005330 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005331 return 1
5332 if len(branches) == 1:
5333 RunGit(['checkout', branches[0]])
5334 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005335 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005336 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005337 print('%d: %s' % (i, branches[i]))
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005338 which = raw_input('Choose by index: ')
5339 try:
5340 RunGit(['checkout', branches[int(which)]])
5341 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005342 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005343 return 1
5344
5345 return 0
5346
5347
maruel@chromium.org29404b52014-09-08 22:58:00 +00005348def CMDlol(parser, args):
5349 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005350 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005351 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5352 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5353 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
vapiera7fbd5a2016-06-16 09:17:49 -07005354 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005355 return 0
5356
5357
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005358class OptionParser(optparse.OptionParser):
5359 """Creates the option parse and add --verbose support."""
5360 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005361 optparse.OptionParser.__init__(
5362 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005363 self.add_option(
5364 '-v', '--verbose', action='count', default=0,
5365 help='Use 2 times for more debugging info')
5366
5367 def parse_args(self, args=None, values=None):
5368 options, args = optparse.OptionParser.parse_args(self, args, values)
5369 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
5370 logging.basicConfig(level=levels[min(options.verbose, len(levels) - 1)])
5371 return options, args
5372
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005373
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005374def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005375 if sys.hexversion < 0x02060000:
vapiera7fbd5a2016-06-16 09:17:49 -07005376 print('\nYour python version %s is unsupported, please upgrade.\n' %
5377 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005378 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005379
maruel@chromium.orgddd59412011-11-30 14:20:38 +00005380 # Reload settings.
5381 global settings
5382 settings = Settings()
5383
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005384 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005385 dispatcher = subcommand.CommandDispatcher(__name__)
5386 try:
5387 return dispatcher.execute(OptionParser(), argv)
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005388 except auth.AuthenticationError as e:
5389 DieWithError(str(e))
vapierfd77ac72016-06-16 08:33:57 -07005390 except urllib2.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005391 if e.code != 500:
5392 raise
5393 DieWithError(
5394 ('AppEngine is misbehaving and returned HTTP %d, again. Keep faith '
5395 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005396 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005397
5398
5399if __name__ == '__main__':
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005400 # These affect sys.stdout so do it outside of main() to simplify mocks in
5401 # unit testing.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005402 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005403 setup_color.init()
sbc@chromium.org013731e2015-02-26 18:28:43 +00005404 try:
5405 sys.exit(main(sys.argv[1:]))
5406 except KeyboardInterrupt:
5407 sys.stderr.write('interrupted\n')
5408 sys.exit(1)