blob: 72bc1923e238b7eea98d0a39b383d44a686a6ffd [file] [log] [blame]
Edward Lemur1f3bafb2019-10-08 17:56:33 +00001#!/usr/bin/env vpython
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02002# Copyright (c) 2013 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
Andrii Shyshkalov03da1502018-10-15 03:42:34 +00008"""A git-command for integrating reviews on 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
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +010016import datetime
Brian Sheedy59b06a82019-10-14 17:03:29 +000017import glob
Edward Lemurd2a5a4c2019-10-23 22:55:26 +000018import httplib
Edward Lemur202c5592019-10-21 22:44:52 +000019import httplib2
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +010020import itertools
maruel@chromium.org4f6852c2012-04-20 20:39:20 +000021import json
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000022import logging
calamity@chromium.orgcf197482016-04-29 20:15:53 +000023import multiprocessing
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000024import optparse
25import os
26import re
Andrii Shyshkalov353637c2017-03-14 16:52:18 +010027import shutil
ukai@chromium.org78c4b982012-02-14 02:20:26 +000028import stat
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000029import sys
Aaron Gable9a03ae02017-11-03 11:31:07 -070030import tempfile
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000031import textwrap
Edward Lemurfec80c42018-11-01 23:14:14 +000032import time
Edward Lemurd2a5a4c2019-10-23 22:55:26 +000033import urllib
34import urllib2
35import urlparse
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000036import uuid
thestig@chromium.org00858c82013-12-02 23:08:03 +000037import webbrowser
thakis@chromium.org3421c992014-11-02 02:20:32 +000038import zlib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000039
maruel@chromium.org2e23ce32013-05-07 12:42:28 +000040from third_party import colorama
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000041import auth
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +000042import clang_format
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +000043import dart_format
maruel@chromium.org6f09cd92011-04-01 16:38:12 +000044import fix_encoding
maruel@chromium.org0e0436a2011-10-25 13:32:41 +000045import gclient_utils
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +000046import gerrit_util
iannucci@chromium.org9e849272014-04-04 00:31:55 +000047import git_common
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +000048import git_footers
Edward Lemur5ba1e9c2018-07-23 18:19:02 +000049import metrics
Edward Lesmes93277a72018-10-18 22:04:26 +000050import metrics_utils
piman@chromium.org336f9122014-09-04 02:16:55 +000051import owners
iannucci@chromium.org9e849272014-04-04 00:31:55 +000052import owners_finder
maruel@chromium.org2a74d372011-03-29 19:05:50 +000053import presubmit_support
54import scm
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +000055import setup_color
Francois Dorayd42c6812017-05-30 15:10:20 -040056import split_cl
maruel@chromium.org0633fb42013-08-16 20:06:14 +000057import subcommand
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +000058import subprocess2
maruel@chromium.org2a74d372011-03-29 19:05:50 +000059import watchlists
60
tandrii7400cf02016-06-21 08:48:07 -070061__version__ = '2.0'
maruel@chromium.org2a74d372011-03-29 19:05:50 +000062
Edward Lemur0f58ae42019-04-30 17:24:12 +000063# Traces for git push will be stored in a traces directory inside the
64# depot_tools checkout.
65DEPOT_TOOLS = os.path.dirname(os.path.abspath(__file__))
66TRACES_DIR = os.path.join(DEPOT_TOOLS, 'traces')
67
68# When collecting traces, Git hashes will be reduced to 6 characters to reduce
69# the size after compression.
70GIT_HASH_RE = re.compile(r'\b([a-f0-9]{6})[a-f0-9]{34}\b', flags=re.I)
71# Used to redact the cookies from the gitcookies file.
72GITCOOKIES_REDACT_RE = re.compile(r'1/.*')
73
Edward Lemurd4d1ba42019-09-20 21:46:37 +000074MAX_ATTEMPTS = 3
75
Edward Lemur1b52d872019-05-09 21:12:12 +000076# The maximum number of traces we will keep. Multiplied by 3 since we store
77# 3 files per trace.
78MAX_TRACES = 3 * 10
Edward Lemur5737f022019-05-17 01:24:00 +000079# Message to be displayed to the user to inform where to find the traces for a
80# git-cl upload execution.
Edward Lemur0f58ae42019-04-30 17:24:12 +000081TRACES_MESSAGE = (
Edward Lemur1b52d872019-05-09 21:12:12 +000082'\n'
Edward Lemur5737f022019-05-17 01:24:00 +000083'The traces of this git-cl execution have been recorded at:\n'
Edward Lemur1b52d872019-05-09 21:12:12 +000084' %(trace_name)s-traces.zip\n'
Edward Lemur5737f022019-05-17 01:24:00 +000085'Copies of your gitcookies file and git config have been recorded at:\n'
86' %(trace_name)s-git-info.zip\n')
Edward Lemur1b52d872019-05-09 21:12:12 +000087# Format of the message to be stored as part of the traces to give developers a
88# better context when they go through traces.
89TRACES_README_FORMAT = (
90'Date: %(now)s\n'
91'\n'
92'Change: https://%(gerrit_host)s/q/%(change_id)s\n'
93'Title: %(title)s\n'
94'\n'
95'%(description)s\n'
96'\n'
97'Execution time: %(execution_time)s\n'
98'Exit code: %(exit_code)s\n') + TRACES_MESSAGE
Edward Lemur0f58ae42019-04-30 17:24:12 +000099
tandrii9d2c7a32016-06-22 03:42:45 -0700100COMMIT_BOT_EMAIL = 'commit-bot@chromium.org'
Aaron Gable1bc7bfe2016-12-19 10:08:14 -0800101POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000102DESCRIPTION_BACKUP_FILE = '~/.git_cl_description_backup'
rmistry@google.comc68112d2015-03-03 12:48:06 +0000103REFS_THAT_ALIAS_TO_OTHER_REFS = {
104 'refs/remotes/origin/lkgr': 'refs/remotes/origin/master',
105 'refs/remotes/origin/lkcr': 'refs/remotes/origin/master',
106}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000107
thestig@chromium.org44202a22014-03-11 19:22:18 +0000108# Valid extensions for files we want to lint.
109DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
110DEFAULT_LINT_IGNORE_REGEX = r"$^"
111
Aiden Bennerc08566e2018-10-03 17:52:42 +0000112# File name for yapf style config files.
113YAPF_CONFIG_FILENAME = '.style.yapf'
114
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000115# Shortcut since it quickly becomes repetitive.
maruel@chromium.org2e23ce32013-05-07 12:42:28 +0000116Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +0000117
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000118# Initialized in main()
119settings = None
120
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100121# Used by tests/git_cl_test.py to add extra logging.
122# Inside the weirdly failing test, add this:
123# >>> self.mock(git_cl, '_IS_BEING_TESTED', True)
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700124# And scroll up to see the stack trace printed.
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100125_IS_BEING_TESTED = False
126
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000127
Christopher Lamf732cd52017-01-24 12:40:11 +1100128def DieWithError(message, change_desc=None):
129 if change_desc:
130 SaveDescriptionBackup(change_desc)
131
vapiera7fbd5a2016-06-16 09:17:49 -0700132 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000133 sys.exit(1)
134
135
Christopher Lamf732cd52017-01-24 12:40:11 +1100136def SaveDescriptionBackup(change_desc):
137 backup_path = os.path.expanduser(DESCRIPTION_BACKUP_FILE)
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +0000138 print('\nsaving CL description to %s\n' % backup_path)
Christopher Lamf732cd52017-01-24 12:40:11 +1100139 backup_file = open(backup_path, 'w')
140 backup_file.write(change_desc.description)
141 backup_file.close()
142
143
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000144def GetNoGitPagerEnv():
145 env = os.environ.copy()
146 # 'cat' is a magical git string that disables pagers on all platforms.
147 env['GIT_PAGER'] = 'cat'
148 return env
149
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000150
bsep@chromium.org627d9002016-04-29 00:00:52 +0000151def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000152 try:
bsep@chromium.org627d9002016-04-29 00:00:52 +0000153 return subprocess2.check_output(args, shell=shell, **kwargs)
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000154 except subprocess2.CalledProcessError as e:
155 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000156 if not error_ok:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000157 DieWithError(
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000158 'Command "%s" failed.\n%s' % (
159 ' '.join(args), error_message or e.stdout or ''))
160 return e.stdout
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000161
162
163def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000164 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000165 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000166
167
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000168def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000169 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700170 if suppress_stderr:
171 stderr = subprocess2.VOID
172 else:
173 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000174 try:
tandrii5d48c322016-08-18 16:19:37 -0700175 (out, _), code = subprocess2.communicate(['git'] + args,
176 env=GetNoGitPagerEnv(),
177 stdout=subprocess2.PIPE,
178 stderr=stderr)
179 return code, out
180 except subprocess2.CalledProcessError as e:
Yoshisato Yanagisawa81e3ff52017-09-26 15:33:34 +0900181 logging.debug('Failed running %s', ['git'] + args)
tandrii5d48c322016-08-18 16:19:37 -0700182 return e.returncode, e.stdout
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000183
184
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000185def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000186 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000187 return RunGitWithCode(args, suppress_stderr=True)[1]
188
189
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000190def IsGitVersionAtLeast(min_version):
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000191 prefix = 'git version '
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000192 version = RunGit(['--version']).strip()
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000193 return (version.startswith(prefix) and
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000194 LooseVersion(version[len(prefix):]) >= LooseVersion(min_version))
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000195
196
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +0000197def BranchExists(branch):
198 """Return True if specified branch exists."""
199 code, _ = RunGitWithCode(['rev-parse', '--verify', branch],
200 suppress_stderr=True)
201 return not code
202
203
tandrii2a16b952016-10-19 07:09:44 -0700204def time_sleep(seconds):
205 # Use this so that it can be mocked in tests without interfering with python
206 # system machinery.
tandrii2a16b952016-10-19 07:09:44 -0700207 return time.sleep(seconds)
208
209
Edward Lemur01f4a4f2018-11-03 00:40:38 +0000210def time_time():
211 # Use this so that it can be mocked in tests without interfering with python
212 # system machinery.
213 return time.time()
214
215
Edward Lemur1b52d872019-05-09 21:12:12 +0000216def datetime_now():
217 # Use this so that it can be mocked in tests without interfering with python
218 # system machinery.
219 return datetime.datetime.now()
220
221
maruel@chromium.org90541732011-04-01 17:54:18 +0000222def ask_for_data(prompt):
223 try:
224 return raw_input(prompt)
225 except KeyboardInterrupt:
226 # Hide the exception.
227 sys.exit(1)
228
229
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100230def confirm_or_exit(prefix='', action='confirm'):
231 """Asks user to press enter to continue or press Ctrl+C to abort."""
232 if not prefix or prefix.endswith('\n'):
233 mid = 'Press'
Andrii Shyshkalov353637c2017-03-14 16:52:18 +0100234 elif prefix.endswith('.') or prefix.endswith('?'):
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100235 mid = ' Press'
236 elif prefix.endswith(' '):
237 mid = 'press'
238 else:
239 mid = ' press'
240 ask_for_data('%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action))
241
242
243def ask_for_explicit_yes(prompt):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000244 """Returns whether user typed 'y' or 'yes' to confirm the given prompt."""
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100245 result = ask_for_data(prompt + ' [Yes/No]: ').lower()
246 while True:
247 if 'yes'.startswith(result):
248 return True
249 if 'no'.startswith(result):
250 return False
251 result = ask_for_data('Please, type yes or no: ').lower()
252
253
tandrii5d48c322016-08-18 16:19:37 -0700254def _git_branch_config_key(branch, key):
255 """Helper method to return Git config key for a branch."""
256 assert branch, 'branch name is required to set git config for it'
257 return 'branch.%s.%s' % (branch, key)
258
259
260def _git_get_branch_config_value(key, default=None, value_type=str,
261 branch=False):
262 """Returns git config value of given or current branch if any.
263
264 Returns default in all other cases.
265 """
266 assert value_type in (int, str, bool)
267 if branch is False: # Distinguishing default arg value from None.
268 branch = GetCurrentBranch()
269
rogerta@chromium.orgcaa16552013-03-18 20:45:05 +0000270 if not branch:
tandrii5d48c322016-08-18 16:19:37 -0700271 return default
rogerta@chromium.orgcaa16552013-03-18 20:45:05 +0000272
tandrii5d48c322016-08-18 16:19:37 -0700273 args = ['config']
tandrii33a46ff2016-08-23 05:53:40 -0700274 if value_type == bool:
tandrii5d48c322016-08-18 16:19:37 -0700275 args.append('--bool')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000276 # `git config` also has --int, but apparently git config suffers from integer
tandrii33a46ff2016-08-23 05:53:40 -0700277 # overflows (http://crbug.com/640115), so don't use it.
tandrii5d48c322016-08-18 16:19:37 -0700278 args.append(_git_branch_config_key(branch, key))
279 code, out = RunGitWithCode(args)
280 if code == 0:
281 value = out.strip()
282 if value_type == int:
283 return int(value)
284 if value_type == bool:
285 return bool(value.lower() == 'true')
286 return value
iannucci@chromium.org79540052012-10-19 23:15:26 +0000287 return default
288
289
tandrii5d48c322016-08-18 16:19:37 -0700290def _git_set_branch_config_value(key, value, branch=None, **kwargs):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000291 """Sets or unsets the git branch config value.
tandrii5d48c322016-08-18 16:19:37 -0700292
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000293 If value is None, the key will be unset, otherwise it will be set.
294 If no branch is given, the currently checked out branch is used.
tandrii5d48c322016-08-18 16:19:37 -0700295 """
296 if not branch:
297 branch = GetCurrentBranch()
298 assert branch, 'a branch name OR currently checked out branch is required'
299 args = ['config']
qyearsley12fa6ff2016-08-24 09:18:40 -0700300 # Check for boolean first, because bool is int, but int is not bool.
tandrii5d48c322016-08-18 16:19:37 -0700301 if value is None:
302 args.append('--unset')
303 elif isinstance(value, bool):
304 args.append('--bool')
305 value = str(value).lower()
tandrii5d48c322016-08-18 16:19:37 -0700306 else:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000307 # `git config` also has --int, but apparently git config suffers from
308 # integer overflows (http://crbug.com/640115), so don't use it.
tandrii5d48c322016-08-18 16:19:37 -0700309 value = str(value)
310 args.append(_git_branch_config_key(branch, key))
311 if value is not None:
312 args.append(value)
313 RunGit(args, **kwargs)
314
315
machenbach@chromium.org45453142015-09-15 08:45:22 +0000316def _get_properties_from_options(options):
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000317 prop_list = getattr(options, 'properties', [])
318 properties = dict(x.split('=', 1) for x in prop_list)
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000319 for key, val in properties.items():
machenbach@chromium.org45453142015-09-15 08:45:22 +0000320 try:
321 properties[key] = json.loads(val)
322 except ValueError:
323 pass # If a value couldn't be evaluated, treat it as a string.
324 return properties
325
326
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000327# TODO(crbug.com/976104): Remove this function once git-cl try-results has
328# migrated to use buildbucket v2
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000329def _buildbucket_retry(operation_name, http, *args, **kwargs):
330 """Retries requests to buildbucket service and returns parsed json content."""
331 try_count = 0
332 while True:
333 response, content = http.request(*args, **kwargs)
334 try:
335 content_json = json.loads(content)
336 except ValueError:
337 content_json = None
338
339 # Buildbucket could return an error even if status==200.
340 if content_json and content_json.get('error'):
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000341 error = content_json.get('error')
342 if error.get('code') == 403:
343 raise BuildbucketResponseException(
344 'Access denied: %s' % error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000345 msg = 'Error in response. Reason: %s. Message: %s.' % (
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000346 error.get('reason', ''), error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000347 raise BuildbucketResponseException(msg)
348
349 if response.status == 200:
Nodir Turakulov23d75d22018-06-04 12:37:32 -0700350 if content_json is None:
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000351 raise BuildbucketResponseException(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000352 'Buildbucket returned invalid JSON content: %s.\n'
Nodir Turakulov9ac59792018-06-04 12:34:14 -0700353 'Please file bugs at http://crbug.com, '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000354 'component "Infra>Platform>Buildbucket".' %
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000355 content)
356 return content_json
357 if response.status < 500 or try_count >= 2:
358 raise httplib2.HttpLib2Error(content)
359
360 # status >= 500 means transient failures.
361 logging.debug('Transient errors when %s. Will retry.', operation_name)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000362 time_sleep(0.5 + (1.5 * try_count))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000363 try_count += 1
364 assert False, 'unreachable'
365
366
Edward Lemur4c707a22019-09-24 21:13:43 +0000367def _call_buildbucket(http, buildbucket_host, method, request):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000368 """Calls a buildbucket v2 method and returns the parsed json response."""
369 headers = {
370 'Accept': 'application/json',
371 'Content-Type': 'application/json',
372 }
373 request = json.dumps(request)
374 url = 'https://%s/prpc/buildbucket.v2.Builds/%s' % (buildbucket_host, method)
375
376 logging.info('POST %s with %s' % (url, request))
377
378 attempts = 1
379 time_to_sleep = 1
380 while True:
381 response, content = http.request(url, 'POST', body=request, headers=headers)
382 if response.status == 200:
383 return json.loads(content[4:])
384 if attempts >= MAX_ATTEMPTS or 400 <= response.status < 500:
385 msg = '%s error when calling POST %s with %s: %s' % (
386 response.status, url, request, content)
387 raise BuildbucketResponseException(msg)
388 logging.debug(
389 '%s error when calling POST %s with %s. '
390 'Sleeping for %d seconds and retrying...' % (
391 response.status, url, request, time_to_sleep))
392 time.sleep(time_to_sleep)
393 time_to_sleep *= 2
394 attempts += 1
395
396 assert False, 'unreachable'
397
398
qyearsley1fdfcb62016-10-24 13:22:03 -0700399def _get_bucket_map(changelist, options, option_parser):
qyearsleydd49f942016-10-28 11:57:22 -0700400 """Returns a dict mapping bucket names to builders and tests,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000401 for triggering tryjobs.
qyearsley1fdfcb62016-10-24 13:22:03 -0700402 """
qyearsleydd49f942016-10-28 11:57:22 -0700403 # If no bots are listed, we try to get a set of builders and tests based
404 # on GetPreferredTryMasters functions in PRESUBMIT.py files.
qyearsley1fdfcb62016-10-24 13:22:03 -0700405 if not options.bot:
406 change = changelist.GetChange(
407 changelist.GetCommonAncestorWithUpstream(), None)
qyearsley136b49f2016-10-31 09:02:26 -0700408 # Get try masters from PRESUBMIT.py files.
nodire4f0fe02016-11-04 16:23:30 -0700409 masters = presubmit_support.DoGetTryMasters(
qyearsley1fdfcb62016-10-24 13:22:03 -0700410 change=change,
411 changed_files=change.LocalPaths(),
412 repository_root=settings.GetRoot(),
413 default_presubmit=None,
414 project=None,
415 verbose=options.verbose,
416 output_stream=sys.stdout)
nodire4f0fe02016-11-04 16:23:30 -0700417 if masters is None:
418 return None
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000419 return {m: b for m, b in masters.items()}
qyearsley1fdfcb62016-10-24 13:22:03 -0700420
qyearsley1fdfcb62016-10-24 13:22:03 -0700421 if options.bucket:
422 return {options.bucket: {b: [] for b in options.bot}}
Andrii Shyshkalov75424372019-08-30 22:48:15 +0000423 option_parser.error(
424 'Please specify the bucket, e.g. "-B luci.chromium.try".')
qyearsley1fdfcb62016-10-24 13:22:03 -0700425
426
Edward Lemur6215c792019-10-03 21:59:05 +0000427def _parse_bucket(raw_bucket):
428 legacy = True
429 project = bucket = None
430 if '/' in raw_bucket:
431 legacy = False
432 project, bucket = raw_bucket.split('/', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000433 # Assume luci.<project>.<bucket>.
Edward Lemur6215c792019-10-03 21:59:05 +0000434 elif raw_bucket.startswith('luci.'):
435 project, bucket = raw_bucket[len('luci.'):].split('.', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000436 # Otherwise, assume prefix is also the project name.
Edward Lemur6215c792019-10-03 21:59:05 +0000437 elif '.' in raw_bucket:
438 project = raw_bucket.split('.')[0]
439 bucket = raw_bucket
440 # Legacy buckets.
441 if legacy:
442 print('WARNING Please use %s/%s to specify the bucket.' % (project, bucket))
443 return project, bucket
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000444
445
Edward Lemur5b929a42019-10-21 17:57:39 +0000446def _trigger_try_jobs(changelist, buckets, options, patchset):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000447 """Sends a request to Buildbucket to trigger tryjobs for a changelist.
qyearsley1fdfcb62016-10-24 13:22:03 -0700448
449 Args:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000450 changelist: Changelist that the tryjobs are associated with.
qyearsley1fdfcb62016-10-24 13:22:03 -0700451 buckets: A nested dict mapping bucket names to builders to tests.
452 options: Command-line options.
453 """
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000454 print('Scheduling jobs on:')
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000455 for bucket, builders_and_tests in sorted(buckets.items()):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000456 print('Bucket:', bucket)
457 print('\n'.join(
458 ' %s: %s' % (builder, tests)
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000459 for builder, tests in sorted(builders_and_tests.items())))
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000460 print('To see results here, run: git cl try-results')
461 print('To see results in browser, run: git cl web')
tandriide281ae2016-10-12 06:02:30 -0700462
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000463 requests = _make_try_job_schedule_requests(
464 changelist, buckets, options, patchset)
465 if not requests:
466 return
467
Edward Lemur5b929a42019-10-21 17:57:39 +0000468 http = auth.Authenticator().authorize(httplib2.Http())
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000469 http.force_exception_to_status_code = True
470
471 batch_request = {'requests': requests}
472 batch_response = _call_buildbucket(
473 http, options.buildbucket_host, 'Batch', batch_request)
474
475 errors = [
476 ' ' + response['error']['message']
477 for response in batch_response.get('responses', [])
478 if 'error' in response
479 ]
480 if errors:
481 raise BuildbucketResponseException(
482 'Failed to schedule builds for some bots:\n%s' % '\n'.join(errors))
483
484
485def _make_try_job_schedule_requests(changelist, buckets, options, patchset):
Edward Lemurf0faf482019-09-25 20:40:17 +0000486 gerrit_changes = [changelist.GetGerritChange(patchset)]
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000487 shared_properties = {'category': getattr(options, 'category', 'git_cl_try')}
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000488 if getattr(options, 'clobber', False):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000489 shared_properties['clobber'] = True
490 shared_properties.update(_get_properties_from_options(options) or {})
491
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000492 shared_tags = [{'key': 'user_agent', 'value': 'git_cl_try'}]
493 if options.retry_failed:
494 shared_tags.append({'key': 'retry_failed',
495 'value': '1'})
496
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000497 requests = []
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000498 for raw_bucket, builders_and_tests in sorted(buckets.items()):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000499 project, bucket = _parse_bucket(raw_bucket)
500 if not project or not bucket:
501 print('WARNING Could not parse bucket "%s". Skipping.' % raw_bucket)
502 continue
503
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000504 for builder, tests in sorted(builders_and_tests.items()):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000505 properties = shared_properties.copy()
506 if 'presubmit' in builder.lower():
507 properties['dry_run'] = 'true'
508 if tests:
509 properties['testfilter'] = tests
510
511 requests.append({
512 'scheduleBuild': {
513 'requestId': str(uuid.uuid4()),
514 'builder': {
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000515 'project': getattr(options, 'project', None) or project,
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000516 'bucket': bucket,
517 'builder': builder,
518 },
519 'gerritChanges': gerrit_changes,
520 'properties': properties,
521 'tags': [
522 {'key': 'builder', 'value': builder},
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000523 ] + shared_tags,
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000524 }
525 })
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000526 return requests
kjellander@chromium.org44424542015-06-02 18:35:29 +0000527
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000528
Edward Lemur5b929a42019-10-21 17:57:39 +0000529def fetch_try_jobs(changelist, buildbucket_host, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000530 """Fetches tryjobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000531
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000532 Returns list of buildbucket.v2.Build with the try jobs for the changelist.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000533 """
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000534 fields = ['id', 'builder', 'status', 'createTime', 'tags']
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000535 request = {
536 'predicate': {
537 'gerritChanges': [changelist.GetGerritChange(patchset)],
538 },
539 'fields': ','.join('builds.*.' + field for field in fields),
540 }
tandrii221ab252016-10-06 08:12:04 -0700541
Edward Lemur5b929a42019-10-21 17:57:39 +0000542 authenticator = auth.Authenticator()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000543 if authenticator.has_cached_credentials():
544 http = authenticator.authorize(httplib2.Http())
545 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700546 print('Warning: Some results might be missing because %s' %
547 # Get the message on how to login.
Edward Lemurba5bc992019-09-23 22:59:17 +0000548 (auth.LoginRequiredError().message,))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000549 http = httplib2.Http()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000550 http.force_exception_to_status_code = True
551
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000552 response = _call_buildbucket(http, buildbucket_host, 'SearchBuilds', request)
553 return response.get('builds', [])
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000554
Edward Lemur5b929a42019-10-21 17:57:39 +0000555def _fetch_latest_builds(changelist, buildbucket_host, latest_patchset=None):
Quinten Yearsley983111f2019-09-26 17:18:48 +0000556 """Fetches builds from the latest patchset that has builds (within
557 the last few patchsets).
558
559 Args:
Quinten Yearsley983111f2019-09-26 17:18:48 +0000560 changelist (Changelist): The CL to fetch builds for
561 buildbucket_host (str): Buildbucket host, e.g. "cr-buildbucket.appspot.com"
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000562 lastest_patchset(int|NoneType): the patchset to start fetching builds from.
563 If None (default), starts with the latest available patchset.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000564 Returns:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000565 A tuple (builds, patchset) where builds is a list of buildbucket.v2.Build,
566 and patchset is the patchset number where those builds came from.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000567 """
568 assert buildbucket_host
569 assert changelist.GetIssue(), 'CL must be uploaded first'
570 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000571 if latest_patchset is None:
572 assert changelist.GetMostRecentPatchset()
573 ps = changelist.GetMostRecentPatchset()
574 else:
575 assert latest_patchset > 0, latest_patchset
576 ps = latest_patchset
577
Quinten Yearsley983111f2019-09-26 17:18:48 +0000578 min_ps = max(1, ps - 5)
579 while ps >= min_ps:
Edward Lemur5b929a42019-10-21 17:57:39 +0000580 builds = fetch_try_jobs(changelist, buildbucket_host, patchset=ps)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000581 if len(builds):
582 return builds, ps
583 ps -= 1
584 return [], 0
585
586
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000587def _filter_failed_for_retry(all_builds):
588 """Returns a list of buckets/builders that are worth retrying.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000589
590 Args:
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000591 all_builds (list): Builds, in the format returned by fetch_try_jobs,
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000592 i.e. a list of buildbucket.v2.Builds which includes status and builder
593 info.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000594
595 Returns:
596 A dict of bucket to builder to tests (empty list). This is the same format
597 accepted by _trigger_try_jobs and returned by _get_bucket_map.
598 """
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000599
600 def _builder_of(build):
601 builder = build['builder']
602 return (builder['project'], builder['bucket'], builder['builder'])
603
604 res = collections.defaultdict(dict)
605 ordered = sorted(all_builds, key=lambda b: (_builder_of(b), b['createTime']))
606 for (proj, buck, bldr), builds in itertools.groupby(ordered, key=_builder_of):
607 # If builder had several builds, retry only if the last one failed.
608 # This is a bit different from CQ, which would re-use *any* SUCCESS-full
609 # build, but in case of retrying failed jobs retrying a flaky one makes
610 # sense.
611 builds = list(builds)
612 if builds[-1]['status'] not in ('FAILURE', 'INFRA_FAILURE'):
613 continue
614 if any(t['key'] == 'cq_experimental' and t['value'] == 'true'
615 for t in builds[-1]['tags']):
616 # Don't retry experimental build previously triggered by CQ.
617 continue
618 if any(b['status'] in ('STARTED', 'SCHEDULED') for b in builds):
619 # Don't retry if any are running.
620 continue
621 res[proj + '/' + buck][bldr] = []
622 return res
Quinten Yearsley983111f2019-09-26 17:18:48 +0000623
624
qyearsleyeab3c042016-08-24 09:18:28 -0700625def print_try_jobs(options, builds):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000626 """Prints nicely result of fetch_try_jobs."""
627 if not builds:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000628 print('No tryjobs scheduled.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000629 return
630
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000631 longest_builder = max(len(b['builder']['builder']) for b in builds)
632 name_fmt = '{builder:<%d}' % longest_builder
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000633 if options.print_master:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000634 longest_bucket = max(len(b['builder']['bucket']) for b in builds)
635 name_fmt = ('{bucket:>%d} ' % longest_bucket) + name_fmt
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000636
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000637 builds_by_status = {}
638 for b in builds:
639 builds_by_status.setdefault(b['status'], []).append({
640 'id': b['id'],
641 'name': name_fmt.format(
642 builder=b['builder']['builder'], bucket=b['builder']['bucket']),
643 })
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000644
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000645 sort_key = lambda b: (b['name'], b['id'])
646
647 def print_builds(title, builds, fmt=None, color=None):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000648 """Pop matching builds from `builds` dict and print them."""
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000649 if not builds:
650 return
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000651
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000652 fmt = fmt or '{name} https://ci.chromium.org/b/{id}'
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000653 if not options.color or color is None:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000654 colorize = lambda x: x
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000655 else:
656 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
657
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000658 print(colorize(title))
659 for b in sorted(builds, key=sort_key):
660 print(' ', colorize(fmt.format(**b)))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000661
662 total = len(builds)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000663 print_builds(
664 'Successes:', builds_by_status.pop('SUCCESS', []), color=Fore.GREEN)
665 print_builds(
666 'Infra Failures:', builds_by_status.pop('INFRA_FAILURE', []),
667 color=Fore.MAGENTA)
668 print_builds('Failures:', builds_by_status.pop('FAILURE', []), color=Fore.RED)
669 print_builds('Canceled:', builds_by_status.pop('CANCELED', []), fmt='{name}',
670 color=Fore.MAGENTA)
671 print_builds('Started:', builds_by_status.pop('STARTED', []))
672 print_builds(
673 'Scheduled:', builds_by_status.pop('SCHEDULED', []), fmt='{name} id={id}')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000674 # The last section is just in case buildbucket API changes OR there is a bug.
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000675 print_builds(
676 'Other:', sum(builds_by_status.values(), []), fmt='{name} id={id}')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000677 print('Total: %d tryjobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000678
679
Aiden Bennerc08566e2018-10-03 17:52:42 +0000680def _ComputeDiffLineRanges(files, upstream_commit):
681 """Gets the changed line ranges for each file since upstream_commit.
682
683 Parses a git diff on provided files and returns a dict that maps a file name
684 to an ordered list of range tuples in the form (start_line, count).
685 Ranges are in the same format as a git diff.
686 """
687 # If files is empty then diff_output will be a full diff.
688 if len(files) == 0:
689 return {}
690
Aiden Benner6c18a1a2018-11-23 20:18:23 +0000691 # Take the git diff and find the line ranges where there are changes.
Jamie Madill3671a6a2019-10-24 15:13:21 +0000692 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000693 diff_output = RunGit(diff_cmd)
694
695 pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)'
696 # 2 capture groups
697 # 0 == fname of diff file
698 # 1 == 'diff_start,diff_count' or 'diff_start'
699 # will match each of
700 # diff --git a/foo.foo b/foo.py
701 # @@ -12,2 +14,3 @@
702 # @@ -12,2 +17 @@
703 # running re.findall on the above string with pattern will give
704 # [('foo.py', ''), ('', '14,3'), ('', '17')]
705
706 curr_file = None
707 line_diffs = {}
708 for match in re.findall(pattern, diff_output, flags=re.MULTILINE):
709 if match[0] != '':
710 # Will match the second filename in diff --git a/a.py b/b.py.
711 curr_file = match[0]
712 line_diffs[curr_file] = []
713 else:
714 # Matches +14,3
715 if ',' in match[1]:
716 diff_start, diff_count = match[1].split(',')
717 else:
718 # Single line changes are of the form +12 instead of +12,1.
719 diff_start = match[1]
720 diff_count = 1
721
722 diff_start = int(diff_start)
723 diff_count = int(diff_count)
724
725 # If diff_count == 0 this is a removal we can ignore.
726 line_diffs[curr_file].append((diff_start, diff_count))
727
728 return line_diffs
729
730
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000731def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000732 """Checks if a yapf file is in any parent directory of fpath until top_dir.
733
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000734 Recursively checks parent directories to find yapf file and if no yapf file
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000735 is found returns None. Uses yapf_config_cache as a cache for previously found
736 configs.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000737 """
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000738 fpath = os.path.abspath(fpath)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000739 # Return result if we've already computed it.
740 if fpath in yapf_config_cache:
741 return yapf_config_cache[fpath]
742
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000743 parent_dir = os.path.dirname(fpath)
744 if os.path.isfile(fpath):
745 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000746 else:
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000747 # Otherwise fpath is a directory
748 yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME)
749 if os.path.isfile(yapf_file):
750 ret = yapf_file
751 elif fpath == top_dir or parent_dir == fpath:
752 # If we're at the top level directory, or if we're at root
753 # there is no provided style.
754 ret = None
755 else:
756 # Otherwise recurse on the current directory.
757 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000758 yapf_config_cache[fpath] = ret
759 return ret
760
761
Brian Sheedy59b06a82019-10-14 17:03:29 +0000762def _GetYapfIgnoreFilepaths(top_dir):
763 """Returns all filepaths that match the ignored files in the .yapfignore file.
764
765 yapf is supposed to handle the ignoring of files listed in .yapfignore itself,
766 but this functionality appears to break when explicitly passing files to
767 yapf for formatting. According to
768 https://github.com/google/yapf/blob/master/README.rst#excluding-files-from-formatting-yapfignore,
769 the .yapfignore file should be in the directory that yapf is invoked from,
770 which we assume to be the top level directory in this case.
771
772 Args:
773 top_dir: The top level directory for the repository being formatted.
774
775 Returns:
776 A set of all filepaths that should be ignored by yapf.
777 """
778 yapfignore_file = os.path.join(top_dir, '.yapfignore')
779 ignore_filepaths = set()
780 if not os.path.exists(yapfignore_file):
781 return ignore_filepaths
782
783 # glob works relative to the current working directory, so we need to ensure
784 # that we're at the top level directory.
785 old_cwd = os.getcwd()
786 try:
787 os.chdir(top_dir)
788 with open(yapfignore_file) as f:
789 for line in f.readlines():
790 stripped_line = line.strip()
791 # Comments and blank lines should be ignored.
792 if stripped_line.startswith('#') or stripped_line == '':
793 continue
794 ignore_filepaths |= set(glob.glob(stripped_line))
795 return ignore_filepaths
796 finally:
797 os.chdir(old_cwd)
798
799
Aaron Gable13101a62018-02-09 13:20:41 -0800800def print_stats(args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000801 """Prints statistics about the change to the user."""
802 # --no-ext-diff is broken in some versions of Git, so try to work around
803 # this by overriding the environment (but there is still a problem if the
804 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000805 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000806 if 'GIT_EXTERNAL_DIFF' in env:
807 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000808
szager@chromium.orgd057f9a2014-05-29 21:09:36 +0000809 try:
810 stdout = sys.stdout.fileno()
811 except AttributeError:
812 stdout = None
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000813 return subprocess2.call(
Aaron Gable13101a62018-02-09 13:20:41 -0800814 ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args,
szager@chromium.orgd057f9a2014-05-29 21:09:36 +0000815 stdout=stdout, env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000816
817
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000818class BuildbucketResponseException(Exception):
819 pass
820
821
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000822class Settings(object):
823 def __init__(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000824 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000825 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000826 self.tree_status_url = None
827 self.viewvc_url = None
828 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000829 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000830 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000831 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000832 self.git_editor = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000833
834 def LazyUpdateIfNeeded(self):
835 """Updates the settings from a codereview.settings file, if available."""
836 if not self.updated:
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000837 # The only value that actually changes the behavior is
838 # autoupdate = "false". Everything else means "true".
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +0000839 autoupdate = RunGit(['config', 'rietveld.autoupdate'],
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000840 error_ok=True
841 ).strip().lower()
842
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000843 cr_settings_file = FindCodereviewSettingsFile()
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000844 if autoupdate != 'false' and cr_settings_file:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000845 LoadCodereviewSettingsFromFile(cr_settings_file)
846 self.updated = True
847
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000848 @staticmethod
849 def GetRelativeRoot():
850 return RunGit(['rev-parse', '--show-cdup']).strip()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000851
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000852 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000853 if self.root is None:
854 self.root = os.path.abspath(self.GetRelativeRoot())
855 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000856
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000857 def GetTreeStatusUrl(self, error_ok=False):
858 if not self.tree_status_url:
859 error_message = ('You must configure your tree status URL by running '
860 '"git cl config".')
Edward Lemur61ea3072018-12-01 00:34:36 +0000861 self.tree_status_url = self._GetConfig(
862 'rietveld.tree-status-url', error_ok=error_ok,
863 error_message=error_message)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000864 return self.tree_status_url
865
866 def GetViewVCUrl(self):
867 if not self.viewvc_url:
Edward Lemur61ea3072018-12-01 00:34:36 +0000868 self.viewvc_url = self._GetConfig('rietveld.viewvc-url', error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000869 return self.viewvc_url
870
rmistry@google.com90752582014-01-14 21:04:50 +0000871 def GetBugPrefix(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000872 return self._GetConfig('rietveld.bug-prefix', error_ok=True)
rmistry@google.com78948ed2015-07-08 23:09:57 +0000873
rmistry@google.com5626a922015-02-26 14:03:30 +0000874 def GetRunPostUploadHook(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000875 run_post_upload_hook = self._GetConfig(
876 'rietveld.run-post-upload-hook', error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +0000877 return run_post_upload_hook == "True"
878
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000879 def GetDefaultCCList(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000880 return self._GetConfig('rietveld.cc', error_ok=True)
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000881
ukai@chromium.orge8077812012-02-03 03:41:46 +0000882 def GetIsGerrit(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000883 """Returns True if this repo is associated with Gerrit."""
ukai@chromium.orge8077812012-02-03 03:41:46 +0000884 if self.is_gerrit is None:
Aaron Gable9b465272017-05-12 10:53:51 -0700885 self.is_gerrit = (
886 self._GetConfig('gerrit.host', error_ok=True).lower() == 'true')
ukai@chromium.orge8077812012-02-03 03:41:46 +0000887 return self.is_gerrit
888
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000889 def GetSquashGerritUploads(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000890 """Returns True if uploads to Gerrit should be squashed by default."""
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000891 if self.squash_gerrit_uploads is None:
tandriia60502f2016-06-20 02:01:53 -0700892 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
893 if self.squash_gerrit_uploads is None:
894 # Default is squash now (http://crbug.com/611892#c23).
895 self.squash_gerrit_uploads = not (
896 RunGit(['config', '--bool', 'gerrit.squash-uploads'],
897 error_ok=True).strip() == 'false')
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000898 return self.squash_gerrit_uploads
899
tandriia60502f2016-06-20 02:01:53 -0700900 def GetSquashGerritUploadsOverride(self):
901 """Return True or False if codereview.settings should be overridden.
902
903 Returns None if no override has been defined.
904 """
905 # See also http://crbug.com/611892#c23
906 result = RunGit(['config', '--bool', 'gerrit.override-squash-uploads'],
907 error_ok=True).strip()
908 if result == 'true':
909 return True
910 if result == 'false':
911 return False
912 return None
913
tandrii@chromium.org28253532016-04-14 13:46:56 +0000914 def GetGerritSkipEnsureAuthenticated(self):
915 """Return True if EnsureAuthenticated should not be done for Gerrit
916 uploads."""
917 if self.gerrit_skip_ensure_authenticated is None:
918 self.gerrit_skip_ensure_authenticated = (
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +0000919 RunGit(['config', '--bool', 'gerrit.skip-ensure-authenticated'],
tandrii@chromium.org28253532016-04-14 13:46:56 +0000920 error_ok=True).strip() == 'true')
921 return self.gerrit_skip_ensure_authenticated
922
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000923 def GetGitEditor(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000924 """Returns the editor specified in the git config, or None if none is."""
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000925 if self.git_editor is None:
Raul Tambre5a525872019-02-12 19:08:08 +0000926 # Git requires single quotes for paths with spaces. We need to replace
927 # them with double quotes for Windows to treat such paths as a single
928 # path.
929 self.git_editor = self._GetConfig(
930 'core.editor', error_ok=True).replace('\'', '"')
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000931 return self.git_editor or None
932
thestig@chromium.org44202a22014-03-11 19:22:18 +0000933 def GetLintRegex(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000934 return (self._GetConfig('rietveld.cpplint-regex', error_ok=True) or
thestig@chromium.org44202a22014-03-11 19:22:18 +0000935 DEFAULT_LINT_REGEX)
936
937 def GetLintIgnoreRegex(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000938 return (self._GetConfig('rietveld.cpplint-ignore-regex', error_ok=True) or
thestig@chromium.org44202a22014-03-11 19:22:18 +0000939 DEFAULT_LINT_IGNORE_REGEX)
940
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000941 def _GetConfig(self, param, **kwargs):
942 self.LazyUpdateIfNeeded()
943 return RunGit(['config', param], **kwargs).strip()
944
945
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000946def ShortBranchName(branch):
947 """Convert a name like 'refs/heads/foo' to just 'foo'."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000948 return branch.replace('refs/heads/', '', 1)
949
950
951def GetCurrentBranchRef():
952 """Returns branch ref (e.g., refs/heads/master) or None."""
953 return RunGit(['symbolic-ref', 'HEAD'],
954 stderr=subprocess2.VOID, error_ok=True).strip() or None
955
956
957def GetCurrentBranch():
958 """Returns current branch or None.
959
960 For refs/heads/* branches, returns just last part. For others, full ref.
961 """
962 branchref = GetCurrentBranchRef()
963 if branchref:
964 return ShortBranchName(branchref)
965 return None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000966
967
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000968class _CQState(object):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +0000969 """Enum for states of CL with respect to CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000970 NONE = 'none'
971 DRY_RUN = 'dry_run'
972 COMMIT = 'commit'
973
974 ALL_STATES = [NONE, DRY_RUN, COMMIT]
975
976
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000977class _ParsedIssueNumberArgument(object):
Edward Lemurf38bc172019-09-03 21:02:13 +0000978 def __init__(self, issue=None, patchset=None, hostname=None):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000979 self.issue = issue
980 self.patchset = patchset
981 self.hostname = hostname
982
983 @property
984 def valid(self):
985 return self.issue is not None
986
987
Edward Lemurf38bc172019-09-03 21:02:13 +0000988def ParseIssueNumberArgument(arg):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000989 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
990 fail_result = _ParsedIssueNumberArgument()
991
Edward Lemur678a6842019-10-03 22:25:05 +0000992 if isinstance(arg, int):
993 return _ParsedIssueNumberArgument(issue=arg)
994 if not isinstance(arg, basestring):
995 return fail_result
996
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000997 if arg.isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +0000998 return _ParsedIssueNumberArgument(issue=int(arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000999 if not arg.startswith('http'):
1000 return fail_result
Aaron Gableaee6c852017-06-26 12:49:01 -07001001
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001002 url = gclient_utils.UpgradeToHttps(arg)
1003 try:
1004 parsed_url = urlparse.urlparse(url)
1005 except ValueError:
1006 return fail_result
Andrii Shyshkalov28d840e2017-04-10 15:45:09 +02001007
Edward Lemur678a6842019-10-03 22:25:05 +00001008 # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]]
1009 # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]]
1010 # Short urls like https://domain/<issue_number> can be used, but don't allow
1011 # specifying the patchset (you'd 404), but we allow that here.
1012 if parsed_url.path == '/':
1013 part = parsed_url.fragment
1014 else:
1015 part = parsed_url.path
1016
1017 match = re.match(
1018 r'(/c(/.*/\+)?)?/(?P<issue>\d+)(/(?P<patchset>\d+)?/?)?$', part)
1019 if not match:
1020 return fail_result
1021
1022 issue = int(match.group('issue'))
1023 patchset = match.group('patchset')
1024 return _ParsedIssueNumberArgument(
1025 issue=issue,
1026 patchset=int(patchset) if patchset else None,
1027 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001028
1029
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00001030def _create_description_from_log(args):
1031 """Pulls out the commit log to use as a base for the CL description."""
1032 log_args = []
1033 if len(args) == 1 and not args[0].endswith('.'):
1034 log_args = [args[0] + '..']
1035 elif len(args) == 1 and args[0].endswith('...'):
1036 log_args = [args[0][:-1]]
1037 elif len(args) == 2:
1038 log_args = [args[0] + '..' + args[1]]
1039 else:
1040 log_args = args[:] # Hope for the best!
1041 return RunGit(['log', '--pretty=format:%s\n\n%b'] + log_args)
1042
1043
Aaron Gablea45ee112016-11-22 15:14:38 -08001044class GerritChangeNotExists(Exception):
tandriic2405f52016-10-10 08:13:15 -07001045 def __init__(self, issue, url):
1046 self.issue = issue
1047 self.url = url
Aaron Gablea45ee112016-11-22 15:14:38 -08001048 super(GerritChangeNotExists, self).__init__()
tandriic2405f52016-10-10 08:13:15 -07001049
1050 def __str__(self):
Aaron Gablea45ee112016-11-22 15:14:38 -08001051 return 'change %s at %s does not exist or you have no access to it' % (
tandriic2405f52016-10-10 08:13:15 -07001052 self.issue, self.url)
1053
1054
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001055_CommentSummary = collections.namedtuple(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001056 '_CommentSummary', ['date', 'message', 'sender', 'autogenerated',
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001057 # TODO(tandrii): these two aren't known in Gerrit.
1058 'approval', 'disapproval'])
1059
1060
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001061class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001062 """Changelist works with one changelist in local branch.
1063
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00001064 Notes:
1065 * Not safe for concurrent multi-{thread,process} use.
1066 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -07001067 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001068 """
1069
Edward Lemur125d60a2019-09-13 18:25:41 +00001070 def __init__(self, branchref=None, issue=None, codereview_host=None):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001071 """Create a new ChangeList instance.
1072
Edward Lemurf38bc172019-09-03 21:02:13 +00001073 **kwargs will be passed directly to Gerrit implementation.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001074 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001075 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +00001076 global settings
1077 if not settings:
1078 # Happens when git_cl.py is used as a utility library.
1079 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001080
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001081 self.branchref = branchref
1082 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00001083 assert branchref.startswith('refs/heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001084 self.branch = ShortBranchName(self.branchref)
1085 else:
1086 self.branch = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001087 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001088 self.lookedup_issue = False
1089 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001090 self.has_description = False
1091 self.description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001092 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001093 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001094 self.cc = None
Daniel Cheng7227d212017-11-17 08:12:37 -08001095 self.more_cc = []
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001096 self._remote = None
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001097 self._cached_remote_url = (False, None) # (is_cached, value)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001098
Edward Lemur125d60a2019-09-13 18:25:41 +00001099 # Lazily cached values.
1100 self._gerrit_host = None # e.g. chromium-review.googlesource.com
1101 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
1102 # Map from change number (issue) to its detail cache.
1103 self._detail_cache = {}
1104
1105 if codereview_host is not None:
1106 assert not codereview_host.startswith('https://'), codereview_host
1107 self._gerrit_host = codereview_host
1108 self._gerrit_server = 'https://%s' % codereview_host
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001109
1110 def GetCCList(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001111 """Returns the users cc'd on this CL.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001112
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001113 The return value is a string suitable for passing to git cl with the --cc
1114 flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001115 """
1116 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001117 base_cc = settings.GetDefaultCCList()
Daniel Cheng7227d212017-11-17 08:12:37 -08001118 more_cc = ','.join(self.more_cc)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001119 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1120 return self.cc
1121
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001122 def GetCCListWithoutDefault(self):
1123 """Return the users cc'd on this CL excluding default ones."""
1124 if self.cc is None:
Daniel Cheng7227d212017-11-17 08:12:37 -08001125 self.cc = ','.join(self.more_cc)
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001126 return self.cc
1127
Daniel Cheng7227d212017-11-17 08:12:37 -08001128 def ExtendCC(self, more_cc):
1129 """Extends the list of users to cc on this CL based on the changed files."""
1130 self.more_cc.extend(more_cc)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001131
1132 def GetBranch(self):
1133 """Returns the short branch name, e.g. 'master'."""
1134 if not self.branch:
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001135 branchref = GetCurrentBranchRef()
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001136 if not branchref:
1137 return None
1138 self.branchref = branchref
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001139 self.branch = ShortBranchName(self.branchref)
1140 return self.branch
1141
1142 def GetBranchRef(self):
1143 """Returns the full branch name, e.g. 'refs/heads/master'."""
1144 self.GetBranch() # Poke the lazy loader.
1145 return self.branchref
1146
tandrii@chromium.org534f67a2016-04-07 18:47:05 +00001147 def ClearBranch(self):
1148 """Clears cached branch data of this object."""
1149 self.branch = self.branchref = None
1150
tandrii5d48c322016-08-18 16:19:37 -07001151 def _GitGetBranchConfigValue(self, key, default=None, **kwargs):
1152 assert 'branch' not in kwargs, 'this CL branch is used automatically'
1153 kwargs['branch'] = self.GetBranch()
1154 return _git_get_branch_config_value(key, default, **kwargs)
1155
1156 def _GitSetBranchConfigValue(self, key, value, **kwargs):
1157 assert 'branch' not in kwargs, 'this CL branch is used automatically'
1158 assert self.GetBranch(), (
1159 'this CL must have an associated branch to %sset %s%s' %
1160 ('un' if value is None else '',
1161 key,
1162 '' if value is None else ' to %r' % value))
1163 kwargs['branch'] = self.GetBranch()
1164 return _git_set_branch_config_value(key, value, **kwargs)
1165
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001166 @staticmethod
1167 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001168 """Returns a tuple containing remote and remote ref,
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001169 e.g. 'origin', 'refs/heads/master'
1170 """
1171 remote = '.'
tandrii5d48c322016-08-18 16:19:37 -07001172 upstream_branch = _git_get_branch_config_value('merge', branch=branch)
1173
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001174 if upstream_branch:
tandrii5d48c322016-08-18 16:19:37 -07001175 remote = _git_get_branch_config_value('remote', branch=branch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001176 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +00001177 upstream_branch = RunGit(['config', 'rietveld.upstream-branch'],
1178 error_ok=True).strip()
1179 if upstream_branch:
1180 remote = RunGit(['config', 'rietveld.upstream-remote']).strip()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001181 else:
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001182 # Else, try to guess the origin remote.
1183 remote_branches = RunGit(['branch', '-r']).split()
1184 if 'origin/master' in remote_branches:
1185 # Fall back on origin/master if it exits.
1186 remote = 'origin'
1187 upstream_branch = 'refs/heads/master'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001188 else:
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001189 DieWithError(
1190 'Unable to determine default branch to diff against.\n'
1191 'Either pass complete "git diff"-style arguments, like\n'
1192 ' git cl upload origin/master\n'
1193 'or verify this branch is set up to track another \n'
1194 '(via the --track argument to "git checkout -b ...").')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001195
1196 return remote, upstream_branch
1197
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001198 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001199 upstream_branch = self.GetUpstreamBranch()
1200 if not BranchExists(upstream_branch):
1201 DieWithError('The upstream for the current branch (%s) does not exist '
1202 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001203 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001204 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001205
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001206 def GetUpstreamBranch(self):
1207 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001208 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Raul Tambrefe1dbe12019-05-02 04:43:57 +00001209 if remote != '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001210 upstream_branch = upstream_branch.replace('refs/heads/',
1211 'refs/remotes/%s/' % remote)
1212 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1213 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001214 self.upstream_branch = upstream_branch
1215 return self.upstream_branch
1216
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001217 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001218 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001219 remote, branch = None, self.GetBranch()
1220 seen_branches = set()
1221 while branch not in seen_branches:
1222 seen_branches.add(branch)
1223 remote, branch = self.FetchUpstreamTuple(branch)
1224 branch = ShortBranchName(branch)
1225 if remote != '.' or branch.startswith('refs/remotes'):
1226 break
1227 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001228 remotes = RunGit(['remote'], error_ok=True).split()
1229 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001230 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001231 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001232 remote = 'origin'
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001233 logging.warn('Could not determine which remote this change is '
1234 'associated with, so defaulting to "%s".' % self._remote)
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001235 else:
1236 logging.warn('Could not determine which remote this change is '
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001237 'associated with.')
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001238 branch = 'HEAD'
1239 if branch.startswith('refs/remotes'):
1240 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001241 elif branch.startswith('refs/branch-heads/'):
1242 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001243 else:
1244 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001245 return self._remote
1246
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001247 def GitSanityChecks(self, upstream_git_obj):
1248 """Checks git repo status and ensures diff is from local commits."""
1249
sbc@chromium.org79706062015-01-14 21:18:12 +00001250 if upstream_git_obj is None:
1251 if self.GetBranch() is None:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001252 print('ERROR: Unable to determine current branch (detached HEAD?)',
vapiera7fbd5a2016-06-16 09:17:49 -07001253 file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001254 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001255 print('ERROR: No upstream branch.', file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001256 return False
1257
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001258 # Verify the commit we're diffing against is in our current branch.
1259 upstream_sha = RunGit(['rev-parse', '--verify', upstream_git_obj]).strip()
1260 common_ancestor = RunGit(['merge-base', upstream_sha, 'HEAD']).strip()
1261 if upstream_sha != common_ancestor:
vapiera7fbd5a2016-06-16 09:17:49 -07001262 print('ERROR: %s is not in the current branch. You may need to rebase '
1263 'your tracking branch' % upstream_sha, file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001264 return False
1265
1266 # List the commits inside the diff, and verify they are all local.
1267 commits_in_diff = RunGit(
1268 ['rev-list', '^%s' % upstream_sha, 'HEAD']).splitlines()
1269 code, remote_branch = RunGitWithCode(['config', 'gitcl.remotebranch'])
1270 remote_branch = remote_branch.strip()
1271 if code != 0:
1272 _, remote_branch = self.GetRemoteBranch()
1273
1274 commits_in_remote = RunGit(
1275 ['rev-list', '^%s' % upstream_sha, remote_branch]).splitlines()
1276
1277 common_commits = set(commits_in_diff) & set(commits_in_remote)
1278 if common_commits:
vapiera7fbd5a2016-06-16 09:17:49 -07001279 print('ERROR: Your diff contains %d commits already in %s.\n'
1280 'Run "git log --oneline %s..HEAD" to get a list of commits in '
1281 'the diff. If you are using a custom git flow, you can override'
1282 ' the reference used for this check with "git config '
1283 'gitcl.remotebranch <git-ref>".' % (
1284 len(common_commits), remote_branch, upstream_git_obj),
1285 file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001286 return False
1287 return True
1288
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001289 def GetGitBaseUrlFromConfig(self):
sheyang@chromium.orga656e702014-05-15 20:43:05 +00001290 """Return the configured base URL from branch.<branchname>.baseurl.
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001291
1292 Returns None if it is not set.
1293 """
tandrii5d48c322016-08-18 16:19:37 -07001294 return self._GitGetBranchConfigValue('base-url')
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001295
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001296 def GetRemoteUrl(self):
1297 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1298
1299 Returns None if there is no remote.
1300 """
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001301 is_cached, value = self._cached_remote_url
1302 if is_cached:
1303 return value
1304
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001305 remote, _ = self.GetRemoteBranch()
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001306 url = RunGit(['config', 'remote.%s.url' % remote], error_ok=True).strip()
1307
Edward Lemur298f2cf2019-02-22 21:40:39 +00001308 # Check if the remote url can be parsed as an URL.
1309 host = urlparse.urlparse(url).netloc
1310 if host:
1311 self._cached_remote_url = (True, url)
1312 return url
1313
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001314 # If it cannot be parsed as an url, assume it is a local directory,
1315 # probably a git cache.
Edward Lemur298f2cf2019-02-22 21:40:39 +00001316 logging.warning('"%s" doesn\'t appear to point to a git host. '
1317 'Interpreting it as a local directory.', url)
1318 if not os.path.isdir(url):
1319 logging.error(
1320 'Remote "%s" for branch "%s" points to "%s", but it doesn\'t exist.',
Daniel Bratell4a60db42019-09-16 17:02:52 +00001321 remote, self.GetBranch(), url)
Edward Lemur298f2cf2019-02-22 21:40:39 +00001322 return None
1323
1324 cache_path = url
1325 url = RunGit(['config', 'remote.%s.url' % remote],
1326 error_ok=True,
1327 cwd=url).strip()
1328
1329 host = urlparse.urlparse(url).netloc
1330 if not host:
1331 logging.error(
1332 'Remote "%(remote)s" for branch "%(branch)s" points to '
1333 '"%(cache_path)s", but it is misconfigured.\n'
1334 '"%(cache_path)s" must be a git repo and must have a remote named '
1335 '"%(remote)s" pointing to the git host.', {
1336 'remote': remote,
1337 'cache_path': cache_path,
1338 'branch': self.GetBranch()})
1339 return None
1340
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001341 self._cached_remote_url = (True, url)
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001342 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001343
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001344 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001345 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001346 if self.issue is None and not self.lookedup_issue:
tandrii5d48c322016-08-18 16:19:37 -07001347 self.issue = self._GitGetBranchConfigValue(
Edward Lemur125d60a2019-09-13 18:25:41 +00001348 self.IssueConfigKey(), value_type=int)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001349 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001350 return self.issue
1351
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001352 def GetIssueURL(self):
1353 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001354 issue = self.GetIssue()
1355 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001356 return None
Edward Lemur125d60a2019-09-13 18:25:41 +00001357 return '%s/%s' % (self.GetCodereviewServer(), issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001358
Andrii Shyshkalov31863012017-02-08 11:35:12 +01001359 def GetDescription(self, pretty=False, force=False):
1360 if not self.has_description or force:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001361 if self.GetIssue():
Edward Lemur125d60a2019-09-13 18:25:41 +00001362 self.description = self.FetchDescription(force=force)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001363 self.has_description = True
1364 if pretty:
Asanka Herath7c61dcb2016-12-14 13:01:58 -05001365 # Set width to 72 columns + 2 space indent.
1366 wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001367 wrapper.initial_indent = wrapper.subsequent_indent = ' '
Asanka Herath7c61dcb2016-12-14 13:01:58 -05001368 lines = self.description.splitlines()
1369 return '\n'.join([wrapper.fill(line) for line in lines])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001370 return self.description
1371
Robert Iannucci09f1f3d2017-03-28 16:54:32 -07001372 def GetDescriptionFooters(self):
1373 """Returns (non_footer_lines, footers) for the commit message.
1374
1375 Returns:
1376 non_footer_lines (list(str)) - Simple list of description lines without
1377 any footer. The lines do not contain newlines, nor does the list contain
1378 the empty line between the message and the footers.
1379 footers (list(tuple(KEY, VALUE))) - List of parsed footers, e.g.
1380 [("Change-Id", "Ideadbeef...."), ...]
1381 """
1382 raw_description = self.GetDescription()
1383 msg_lines, _, footers = git_footers.split_footers(raw_description)
1384 if footers:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001385 msg_lines = msg_lines[:len(msg_lines) - 1]
Robert Iannucci09f1f3d2017-03-28 16:54:32 -07001386 return msg_lines, footers
1387
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001388 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001389 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001390 if self.patchset is None and not self.lookedup_patchset:
tandrii5d48c322016-08-18 16:19:37 -07001391 self.patchset = self._GitGetBranchConfigValue(
Edward Lemur125d60a2019-09-13 18:25:41 +00001392 self.PatchsetConfigKey(), value_type=int)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001393 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001394 return self.patchset
1395
1396 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001397 """Set this branch's patchset. If patchset=0, clears the patchset."""
1398 assert self.GetBranch()
1399 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001400 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001401 else:
1402 self.patchset = int(patchset)
1403 self._GitSetBranchConfigValue(
Edward Lemur125d60a2019-09-13 18:25:41 +00001404 self.PatchsetConfigKey(), self.patchset)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001405
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001406 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001407 """Set this branch's issue. If issue isn't given, clears the issue."""
1408 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001409 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001410 issue = int(issue)
1411 self._GitSetBranchConfigValue(
Edward Lemur125d60a2019-09-13 18:25:41 +00001412 self.IssueConfigKey(), issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001413 self.issue = issue
Edward Lemur125d60a2019-09-13 18:25:41 +00001414 codereview_server = self.GetCodereviewServer()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001415 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001416 self._GitSetBranchConfigValue(
Edward Lemur125d60a2019-09-13 18:25:41 +00001417 self.CodereviewServerConfigKey(),
tandrii5d48c322016-08-18 16:19:37 -07001418 codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001419 else:
tandrii5d48c322016-08-18 16:19:37 -07001420 # Reset all of these just to be clean.
1421 reset_suffixes = [
1422 'last-upload-hash',
Edward Lemur125d60a2019-09-13 18:25:41 +00001423 self.IssueConfigKey(),
1424 self.PatchsetConfigKey(),
1425 self.CodereviewServerConfigKey(),
tandrii5d48c322016-08-18 16:19:37 -07001426 ] + self._PostUnsetIssueProperties()
1427 for prop in reset_suffixes:
1428 self._GitSetBranchConfigValue(prop, None, error_ok=True)
Aaron Gableca01e2c2017-07-19 11:16:02 -07001429 msg = RunGit(['log', '-1', '--format=%B']).strip()
1430 if msg and git_footers.get_footer_change_id(msg):
1431 print('WARNING: The change patched into this branch has a Change-Id. '
1432 'Removing it.')
1433 RunGit(['commit', '--amend', '-m',
1434 git_footers.remove_footer(msg, 'Change-Id')])
Edward Lemurf38bc172019-09-03 21:02:13 +00001435 self.lookedup_issue = True
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001436 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001437 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001438
dnjba1b0f32016-09-02 12:37:42 -07001439 def GetChange(self, upstream_branch, author, local_description=False):
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001440 if not self.GitSanityChecks(upstream_branch):
1441 DieWithError('\nGit sanity check failure')
1442
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001443 root = settings.GetRelativeRoot()
bratell@opera.comf267b0e2013-05-02 09:11:43 +00001444 if not root:
1445 root = '.'
bauerb@chromium.org512f1ef2011-04-20 15:17:57 +00001446 absroot = os.path.abspath(root)
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001447
1448 # We use the sha1 of HEAD as a name of this change.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001449 name = RunGitWithCode(['rev-parse', 'HEAD'])[1].strip()
bauerb@chromium.org512f1ef2011-04-20 15:17:57 +00001450 # Need to pass a relative path for msysgit.
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001451 try:
maruel@chromium.org80a9ef12011-12-13 20:44:10 +00001452 files = scm.GIT.CaptureStatus([root], '.', upstream_branch)
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001453 except subprocess2.CalledProcessError:
1454 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001455 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001456 'This branch probably doesn\'t exist anymore. To reset the\n'
1457 'tracking branch, please run\n'
stip7a3dd352016-09-22 17:32:28 -07001458 ' git branch --set-upstream-to origin/master %s\n'
1459 'or replace origin/master with the relevant branch') %
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001460 (upstream_branch, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001461
maruel@chromium.org52424302012-08-29 15:14:30 +00001462 issue = self.GetIssue()
1463 patchset = self.GetPatchset()
dnjba1b0f32016-09-02 12:37:42 -07001464 if issue and not local_description:
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001465 description = self.GetDescription()
1466 else:
1467 # If the change was never uploaded, use the log messages of all commits
1468 # up to the branch point, as git cl upload will prefill the description
1469 # with these log messages.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001470 args = ['log', '--pretty=format:%s%n%n%b', '%s...' % (upstream_branch)]
1471 description = RunGitWithCode(args)[1].strip()
maruel@chromium.org03b3bdc2011-06-14 13:04:12 +00001472
1473 if not author:
maruel@chromium.org13f623c2011-07-22 16:02:23 +00001474 author = RunGit(['config', 'user.email']).strip() or None
asvitkine@chromium.org15169952011-09-27 14:30:53 +00001475 return presubmit_support.GitChange(
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001476 name,
1477 description,
1478 absroot,
1479 files,
1480 issue,
1481 patchset,
agable@chromium.orgea84ef12014-04-30 19:55:12 +00001482 author,
1483 upstream=upstream_branch)
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001484
dsansomee2d6fd92016-09-08 00:10:47 -07001485 def UpdateDescription(self, description, force=False):
Edward Lemur125d60a2019-09-13 18:25:41 +00001486 self.UpdateDescriptionRemote(description, force=force)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001487 self.description = description
Andrii Shyshkalov83051152017-02-07 23:47:29 +01001488 self.has_description = True
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001489
Robert Iannucci09f1f3d2017-03-28 16:54:32 -07001490 def UpdateDescriptionFooters(self, description_lines, footers, force=False):
1491 """Sets the description for this CL remotely.
1492
1493 You can get description_lines and footers with GetDescriptionFooters.
1494
1495 Args:
1496 description_lines (list(str)) - List of CL description lines without
1497 newline characters.
1498 footers (list(tuple(KEY, VALUE))) - List of footers, as returned by
1499 GetDescriptionFooters. Key must conform to the git footers format (i.e.
1500 `List-Of-Tokens`). It will be case-normalized so that each token is
1501 title-cased.
1502 """
1503 new_description = '\n'.join(description_lines)
1504 if footers:
1505 new_description += '\n'
1506 for k, v in footers:
1507 foot = '%s: %s' % (git_footers.normalize_name(k), v)
1508 if not git_footers.FOOTER_PATTERN.match(foot):
1509 raise ValueError('Invalid footer %r' % foot)
1510 new_description += foot + '\n'
1511 self.UpdateDescription(new_description, force)
1512
Edward Lesmes8e282792018-04-03 18:50:29 -04001513 def RunHook(self, committing, may_prompt, verbose, change, parallel):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001514 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1515 try:
Edward Lemur2c48f242019-06-04 16:14:09 +00001516 start = time_time()
1517 result = presubmit_support.DoPresubmitChecks(change, committing,
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001518 verbose=verbose, output_stream=sys.stdout, input_stream=sys.stdin,
1519 default_presubmit=None, may_prompt=may_prompt,
Edward Lemur125d60a2019-09-13 18:25:41 +00001520 gerrit_obj=self.GetGerritObjForPresubmit(),
Edward Lesmes8e282792018-04-03 18:50:29 -04001521 parallel=parallel)
Edward Lemur2c48f242019-06-04 16:14:09 +00001522 metrics.collector.add_repeated('sub_commands', {
1523 'command': 'presubmit',
1524 'execution_time': time_time() - start,
1525 'exit_code': 0 if result.should_continue() else 1,
1526 })
1527 return result
vapierfd77ac72016-06-16 08:33:57 -07001528 except presubmit_support.PresubmitFailure as e:
Aaron Gable5d5f22c2018-02-02 09:12:41 -08001529 DieWithError('%s\nMaybe your depot_tools is out of date?' % e)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001530
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001531 def CMDUpload(self, options, git_diff_args, orig_args):
1532 """Uploads a change to codereview."""
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001533 custom_cl_base = None
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001534 if git_diff_args:
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001535 custom_cl_base = base_branch = git_diff_args[0]
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001536 else:
1537 if self.GetBranch() is None:
1538 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1539
1540 # Default to diffing against common ancestor of upstream branch
1541 base_branch = self.GetCommonAncestorWithUpstream()
1542 git_diff_args = [base_branch, 'HEAD']
1543
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001544 # Fast best-effort checks to abort before running potentially expensive
1545 # hooks if uploading is likely to fail anyway. Passing these checks does
1546 # not guarantee that uploading will not fail.
Edward Lemur125d60a2019-09-13 18:25:41 +00001547 self.EnsureAuthenticated(force=options.force)
1548 self.EnsureCanUploadPatchset(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001549
1550 # Apply watchlists on upload.
1551 change = self.GetChange(base_branch, None)
1552 watchlist = watchlists.Watchlists(change.RepositoryRoot())
1553 files = [f.LocalPath() for f in change.AffectedFiles()]
1554 if not options.bypass_watchlists:
Daniel Cheng7227d212017-11-17 08:12:37 -08001555 self.ExtendCC(watchlist.GetWatchersForPaths(files))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001556
1557 if not options.bypass_hooks:
Robert Iannucci6c98dc62017-04-18 11:38:00 -07001558 if options.reviewers or options.tbrs or options.add_owners_to:
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001559 # Set the reviewer list now so that presubmit checks can access it.
1560 change_description = ChangeDescription(change.FullDescriptionText())
1561 change_description.update_reviewers(options.reviewers,
Robert Iannucci6c98dc62017-04-18 11:38:00 -07001562 options.tbrs,
Robert Iannuccif2708bd2017-04-17 15:49:02 -07001563 options.add_owners_to,
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001564 change)
1565 change.SetDescriptionText(change_description.description)
1566 hook_results = self.RunHook(committing=False,
Edward Lesmes8e282792018-04-03 18:50:29 -04001567 may_prompt=not options.force,
1568 verbose=options.verbose,
1569 change=change, parallel=options.parallel)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001570 if not hook_results.should_continue():
1571 return 1
1572 if not options.reviewers and hook_results.reviewers:
1573 options.reviewers = hook_results.reviewers.split(',')
Daniel Cheng7227d212017-11-17 08:12:37 -08001574 self.ExtendCC(hook_results.more_cc)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001575
Aaron Gable13101a62018-02-09 13:20:41 -08001576 print_stats(git_diff_args)
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001577 ret = self.CMDUploadChange(options, git_diff_args, custom_cl_base, change)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001578 if not ret:
tandrii5d48c322016-08-18 16:19:37 -07001579 _git_set_branch_config_value('last-upload-hash',
1580 RunGit(['rev-parse', 'HEAD']).strip())
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001581 # Run post upload hooks, if specified.
1582 if settings.GetRunPostUploadHook():
1583 presubmit_support.DoPostUploadExecuter(
1584 change,
1585 self,
1586 settings.GetRoot(),
1587 options.verbose,
1588 sys.stdout)
1589
1590 # Upload all dependencies if specified.
1591 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001592 print()
1593 print('--dependencies has been specified.')
1594 print('All dependent local branches will be re-uploaded.')
1595 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001596 # Remove the dependencies flag from args so that we do not end up in a
1597 # loop.
1598 orig_args.remove('--dependencies')
1599 ret = upload_branch_deps(self, orig_args)
1600 return ret
1601
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001602 def SetCQState(self, new_state):
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001603 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001604
1605 Issue must have been already uploaded and known.
1606 """
1607 assert new_state in _CQState.ALL_STATES
1608 assert self.GetIssue()
qyearsley1fdfcb62016-10-24 13:22:03 -07001609 try:
Edward Lemur125d60a2019-09-13 18:25:41 +00001610 vote_map = {
1611 _CQState.NONE: 0,
1612 _CQState.DRY_RUN: 1,
1613 _CQState.COMMIT: 2,
1614 }
1615 labels = {'Commit-Queue': vote_map[new_state]}
1616 notify = False if new_state == _CQState.DRY_RUN else None
1617 gerrit_util.SetReview(
1618 self._GetGerritHost(), self._GerritChangeIdentifier(),
1619 labels=labels, notify=notify)
qyearsley1fdfcb62016-10-24 13:22:03 -07001620 return 0
1621 except KeyboardInterrupt:
1622 raise
1623 except:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001624 print('WARNING: Failed to %s.\n'
qyearsley1fdfcb62016-10-24 13:22:03 -07001625 'Either:\n'
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001626 ' * Your project has no CQ,\n'
1627 ' * You don\'t have permission to change the CQ state,\n'
1628 ' * There\'s a bug in this code (see stack trace below).\n'
1629 'Consider specifying which bots to trigger manually or asking your '
1630 'project owners for permissions or contacting Chrome Infra at:\n'
1631 'https://www.chromium.org/infra\n\n' %
1632 ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ'))
qyearsley1fdfcb62016-10-24 13:22:03 -07001633 # Still raise exception so that stack trace is printed.
1634 raise
1635
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001636 def _GetGerritHost(self):
1637 # Lazy load of configs.
1638 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07001639 if self._gerrit_host and '.' not in self._gerrit_host:
1640 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
1641 # This happens for internal stuff http://crbug.com/614312.
1642 parsed = urlparse.urlparse(self.GetRemoteUrl())
1643 if parsed.scheme == 'sso':
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001644 print('WARNING: using non-https URLs for remote is likely broken\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001645 ' Your current remote is: %s' % self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001646 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
1647 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001648 return self._gerrit_host
1649
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001650 def _GetGitHost(self):
1651 """Returns git host to be used when uploading change to Gerrit."""
Edward Lemur298f2cf2019-02-22 21:40:39 +00001652 remote_url = self.GetRemoteUrl()
1653 if not remote_url:
1654 return None
1655 return urlparse.urlparse(remote_url).netloc
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001656
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001657 def GetCodereviewServer(self):
1658 if not self._gerrit_server:
1659 # If we're on a branch then get the server potentially associated
1660 # with that branch.
1661 if self.GetIssue():
tandrii5d48c322016-08-18 16:19:37 -07001662 self._gerrit_server = self._GitGetBranchConfigValue(
1663 self.CodereviewServerConfigKey())
1664 if self._gerrit_server:
1665 self._gerrit_host = urlparse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001666 if not self._gerrit_server:
1667 # We assume repo to be hosted on Gerrit, and hence Gerrit server
1668 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001669 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001670 parts[0] = parts[0] + '-review'
1671 self._gerrit_host = '.'.join(parts)
1672 self._gerrit_server = 'https://%s' % self._gerrit_host
1673 return self._gerrit_server
1674
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001675 def _GetGerritProject(self):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001676 """Returns Gerrit project name based on remote git URL."""
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001677 remote_url = self.GetRemoteUrl()
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001678 if remote_url is None:
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001679 logging.warn('can\'t detect Gerrit project.')
1680 return None
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001681 project = urlparse.urlparse(remote_url).path.strip('/')
1682 if project.endswith('.git'):
1683 project = project[:-len('.git')]
Andrii Shyshkalov1e828672018-08-23 22:34:37 +00001684 # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with
1685 # 'a/' prefix, because 'a/' prefix is used to force authentication in
1686 # gitiles/git-over-https protocol. E.g.,
1687 # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project
1688 # as
1689 # https://chromium.googlesource.com/v8/v8
1690 if project.startswith('a/'):
1691 project = project[len('a/'):]
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001692 return project
1693
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001694 def _GerritChangeIdentifier(self):
1695 """Handy method for gerrit_util.ChangeIdentifier for a given CL.
1696
1697 Not to be confused by value of "Change-Id:" footer.
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001698 If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC.
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001699 """
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001700 project = self._GetGerritProject()
1701 if project:
1702 return gerrit_util.ChangeIdentifier(project, self.GetIssue())
1703 # Fall back on still unique, but less efficient change number.
1704 return str(self.GetIssue())
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001705
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001706 @classmethod
tandrii5d48c322016-08-18 16:19:37 -07001707 def IssueConfigKey(cls):
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001708 return 'gerritissue'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001709
tandrii5d48c322016-08-18 16:19:37 -07001710 @classmethod
1711 def PatchsetConfigKey(cls):
1712 return 'gerritpatchset'
1713
1714 @classmethod
1715 def CodereviewServerConfigKey(cls):
1716 return 'gerritserver'
1717
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001718 def EnsureAuthenticated(self, force, refresh=None):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001719 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00001720 if settings.GetGerritSkipEnsureAuthenticated():
1721 # For projects with unusual authentication schemes.
1722 # See http://crbug.com/603378.
1723 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001724
1725 # Check presence of cookies only if using cookies-based auth method.
1726 cookie_auth = gerrit_util.Authenticator.get()
1727 if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001728 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001729
Daniel Chengcf6269b2019-05-18 01:02:12 +00001730 if urlparse.urlparse(self.GetRemoteUrl()).scheme != 'https':
1731 print('WARNING: Ignoring branch %s with non-https remote %s' %
Edward Lemur125d60a2019-09-13 18:25:41 +00001732 (self.branch, self.GetRemoteUrl()))
Daniel Chengcf6269b2019-05-18 01:02:12 +00001733 return
1734
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001735 # Lazy-loader to identify Gerrit and Git hosts.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001736 self.GetCodereviewServer()
1737 git_host = self._GetGitHost()
Edward Lemur298f2cf2019-02-22 21:40:39 +00001738 assert self._gerrit_server and self._gerrit_host and git_host
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001739
1740 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
1741 git_auth = cookie_auth.get_auth_header(git_host)
1742 if gerrit_auth and git_auth:
1743 if gerrit_auth == git_auth:
1744 return
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001745 all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com')
Raul Tambre80ee78e2019-05-06 22:41:05 +00001746 print(
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001747 'WARNING: You have different credentials for Gerrit and git hosts:\n'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001748 ' %s\n'
1749 ' %s\n'
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001750 ' Consider running the following command:\n'
1751 ' git cl creds-check\n'
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001752 ' %s\n'
Raul Tambre80ee78e2019-05-06 22:41:05 +00001753 ' %s' %
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001754 (git_host, self._gerrit_host,
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001755 ('Hint: delete creds for .googlesource.com' if all_gsrc else ''),
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001756 cookie_auth.get_new_password_message(git_host)))
1757 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001758 confirm_or_exit('If you know what you are doing', action='continue')
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001759 return
1760 else:
1761 missing = (
Anna Henningsen4e891442017-07-06 21:40:58 +02001762 ([] if gerrit_auth else [self._gerrit_host]) +
1763 ([] if git_auth else [git_host]))
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001764 DieWithError('Credentials for the following hosts are required:\n'
1765 ' %s\n'
1766 'These are read from %s (or legacy %s)\n'
1767 '%s' % (
1768 '\n '.join(missing),
1769 cookie_auth.get_gitcookies_path(),
1770 cookie_auth.get_netrc_path(),
1771 cookie_auth.get_new_password_message(git_host)))
1772
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001773 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001774 if not self.GetIssue():
1775 return
1776
1777 # Warm change details cache now to avoid RPCs later, reducing latency for
1778 # developers.
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001779 self._GetChangeDetail(
Andrii Shyshkalovc4a73562018-09-25 18:40:17 +00001780 ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS'])
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001781
1782 status = self._GetChangeDetail()['status']
1783 if status in ('MERGED', 'ABANDONED'):
1784 DieWithError('Change %s has been %s, new uploads are not allowed' %
1785 (self.GetIssueURL(),
1786 'submitted' if status == 'MERGED' else 'abandoned'))
1787
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001788 # TODO(vadimsh): For some reason the chunk of code below was skipped if
1789 # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'.
1790 # Apparently this check is not very important? Otherwise get_auth_email
1791 # could have been added to other implementations of Authenticator.
1792 cookies_auth = gerrit_util.Authenticator.get()
1793 if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator):
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001794 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001795
1796 cookies_user = cookies_auth.get_auth_email(self._GetGerritHost())
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001797 if self.GetIssueOwner() == cookies_user:
1798 return
1799 logging.debug('change %s owner is %s, cookies user is %s',
1800 self.GetIssue(), self.GetIssueOwner(), cookies_user)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001801 # Maybe user has linked accounts or something like that,
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001802 # so ask what Gerrit thinks of this user.
1803 details = gerrit_util.GetAccountDetails(self._GetGerritHost(), 'self')
1804 if details['email'] == self.GetIssueOwner():
1805 return
1806 if not force:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001807 print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit '
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001808 'as %s.\n'
1809 'Uploading may fail due to lack of permissions.' %
1810 (self.GetIssue(), self.GetIssueOwner(), details['email']))
1811 confirm_or_exit(action='upload')
1812
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001813 def _PostUnsetIssueProperties(self):
1814 """Which branch-specific properties to erase when unsetting issue."""
tandrii5d48c322016-08-18 16:19:37 -07001815 return ['gerritsquashhash']
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001816
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001817 def GetGerritObjForPresubmit(self):
1818 return presubmit_support.GerritAccessor(self._GetGerritHost())
1819
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001820 def GetStatus(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001821 """Applies a rough heuristic to give a simple summary of an issue's review
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001822 or CQ status, assuming adherence to a common workflow.
1823
1824 Returns None if no issue for this branch, or one of the following keywords:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001825 * 'error' - error from review tool (including deleted issues)
1826 * 'unsent' - no reviewers added
1827 * 'waiting' - waiting for review
1828 * 'reply' - waiting for uploader to reply to review
1829 * 'lgtm' - Code-Review label has been set
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001830 * 'dry-run' - dry-running in the CQ
1831 * 'commit' - in the CQ
Aaron Gable9ab38c62017-04-06 14:36:33 -07001832 * 'closed' - successfully submitted or abandoned
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001833 """
1834 if not self.GetIssue():
1835 return None
1836
1837 try:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001838 data = self._GetChangeDetail([
1839 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE'])
Aaron Gablea45ee112016-11-22 15:14:38 -08001840 except (httplib.HTTPException, GerritChangeNotExists):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001841 return 'error'
1842
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00001843 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001844 return 'closed'
1845
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001846 cq_label = data['labels'].get('Commit-Queue', {})
1847 max_cq_vote = 0
1848 for vote in cq_label.get('all', []):
1849 max_cq_vote = max(max_cq_vote, vote.get('value', 0))
1850 if max_cq_vote == 2:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001851 return 'commit'
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001852 if max_cq_vote == 1:
1853 return 'dry-run'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001854
Aaron Gable9ab38c62017-04-06 14:36:33 -07001855 if data['labels'].get('Code-Review', {}).get('approved'):
1856 return 'lgtm'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001857
1858 if not data.get('reviewers', {}).get('REVIEWER', []):
1859 return 'unsent'
1860
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001861 owner = data['owner'].get('_account_id')
Aaron Gable9ab38c62017-04-06 14:36:33 -07001862 messages = sorted(data.get('messages', []), key=lambda m: m.get('updated'))
1863 last_message_author = messages.pop().get('author', {})
1864 while last_message_author:
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001865 if last_message_author.get('email') == COMMIT_BOT_EMAIL:
1866 # Ignore replies from CQ.
Aaron Gable9ab38c62017-04-06 14:36:33 -07001867 last_message_author = messages.pop().get('author', {})
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001868 continue
Aaron Gable9ab38c62017-04-06 14:36:33 -07001869 if last_message_author.get('_account_id') == owner:
1870 # Most recent message was by owner.
1871 return 'waiting'
1872 else:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001873 # Some reply from non-owner.
1874 return 'reply'
Aaron Gable9ab38c62017-04-06 14:36:33 -07001875
1876 # Somehow there are no messages even though there are reviewers.
1877 return 'unsent'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001878
1879 def GetMostRecentPatchset(self):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001880 data = self._GetChangeDetail(['CURRENT_REVISION'])
Aaron Gablee8856ee2017-12-07 12:41:46 -08001881 patchset = data['revisions'][data['current_revision']]['_number']
1882 self.SetPatchset(patchset)
1883 return patchset
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001884
Kenneth Russell61e2ed42017-02-15 11:47:13 -08001885 def FetchDescription(self, force=False):
1886 data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'],
1887 no_cache=force)
tandrii@chromium.org2d3da632016-04-25 19:23:27 +00001888 current_rev = data['current_revision']
Dan Beamcf6df902018-11-08 01:48:37 +00001889 return data['revisions'][current_rev]['commit']['message'].encode(
1890 'utf-8', 'ignore')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001891
dsansomee2d6fd92016-09-08 00:10:47 -07001892 def UpdateDescriptionRemote(self, description, force=False):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001893 if gerrit_util.HasPendingChangeEdit(
1894 self._GetGerritHost(), self._GerritChangeIdentifier()):
dsansomee2d6fd92016-09-08 00:10:47 -07001895 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001896 confirm_or_exit(
dsansomee2d6fd92016-09-08 00:10:47 -07001897 'The description cannot be modified while the issue has a pending '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001898 'unpublished edit. Either publish the edit in the Gerrit web UI '
1899 'or delete it.\n\n', action='delete the unpublished edit')
dsansomee2d6fd92016-09-08 00:10:47 -07001900
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001901 gerrit_util.DeletePendingChangeEdit(
1902 self._GetGerritHost(), self._GerritChangeIdentifier())
1903 gerrit_util.SetCommitMessage(
1904 self._GetGerritHost(), self._GerritChangeIdentifier(),
1905 description, notify='NONE')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001906
Aaron Gable636b13f2017-07-14 10:42:48 -07001907 def AddComment(self, message, publish=None):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001908 gerrit_util.SetReview(
1909 self._GetGerritHost(), self._GerritChangeIdentifier(),
1910 msg=message, ready=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001911
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001912 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalov5a0cf202017-03-17 16:14:59 +01001913 # DETAILED_ACCOUNTS is to get emails in accounts.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001914 # CURRENT_REVISION is included to get the latest patchset so that
1915 # only the robot comments from the latest patchset can be shown.
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001916 messages = self._GetChangeDetail(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001917 options=['MESSAGES', 'DETAILED_ACCOUNTS',
1918 'CURRENT_REVISION']).get('messages', [])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001919 file_comments = gerrit_util.GetChangeComments(
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001920 self._GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001921 robot_file_comments = gerrit_util.GetChangeRobotComments(
1922 self._GetGerritHost(), self._GerritChangeIdentifier())
1923
1924 # Add the robot comments onto the list of comments, but only
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +00001925 # keep those that are from the latest patchset.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001926 latest_patch_set = self.GetMostRecentPatchset()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001927 for path, robot_comments in robot_file_comments.items():
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001928 line_comments = file_comments.setdefault(path, [])
1929 line_comments.extend(
1930 [c for c in robot_comments if c['patch_set'] == latest_patch_set])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001931
1932 # Build dictionary of file comments for easy access and sorting later.
1933 # {author+date: {path: {patchset: {line: url+message}}}}
1934 comments = collections.defaultdict(
1935 lambda: collections.defaultdict(lambda: collections.defaultdict(dict)))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001936 for path, line_comments in file_comments.items():
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001937 for comment in line_comments:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001938 tag = comment.get('tag', '')
1939 if tag.startswith('autogenerated') and 'robot_id' not in comment:
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001940 continue
1941 key = (comment['author']['email'], comment['updated'])
1942 if comment.get('side', 'REVISION') == 'PARENT':
1943 patchset = 'Base'
1944 else:
1945 patchset = 'PS%d' % comment['patch_set']
1946 line = comment.get('line', 0)
1947 url = ('https://%s/c/%s/%s/%s#%s%s' %
1948 (self._GetGerritHost(), self.GetIssue(), comment['patch_set'], path,
1949 'b' if comment.get('side') == 'PARENT' else '',
1950 str(line) if line else ''))
1951 comments[key][path][patchset][line] = (url, comment['message'])
1952
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001953 summaries = []
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001954 for msg in messages:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001955 summary = self._BuildCommentSummary(msg, comments, readable)
1956 if summary:
1957 summaries.append(summary)
1958 return summaries
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001959
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001960 @staticmethod
1961 def _BuildCommentSummary(msg, comments, readable):
1962 key = (msg['author']['email'], msg['date'])
1963 # Don't bother showing autogenerated messages that don't have associated
1964 # file or line comments. this will filter out most autogenerated
1965 # messages, but will keep robot comments like those from Tricium.
1966 is_autogenerated = msg.get('tag', '').startswith('autogenerated')
1967 if is_autogenerated and not comments.get(key):
1968 return None
1969 message = msg['message']
1970 # Gerrit spits out nanoseconds.
1971 assert len(msg['date'].split('.')[-1]) == 9
1972 date = datetime.datetime.strptime(msg['date'][:-3],
1973 '%Y-%m-%d %H:%M:%S.%f')
1974 if key in comments:
1975 message += '\n'
1976 for path, patchsets in sorted(comments.get(key, {}).items()):
1977 if readable:
1978 message += '\n%s' % path
1979 for patchset, lines in sorted(patchsets.items()):
1980 for line, (url, content) in sorted(lines.items()):
1981 if line:
1982 line_str = 'Line %d' % line
1983 path_str = '%s:%d:' % (path, line)
1984 else:
1985 line_str = 'File comment'
1986 path_str = '%s:0:' % path
1987 if readable:
1988 message += '\n %s, %s: %s' % (patchset, line_str, url)
1989 message += '\n %s\n' % content
1990 else:
1991 message += '\n%s ' % path_str
1992 message += '\n%s\n' % content
1993
1994 return _CommentSummary(
1995 date=date,
1996 message=message,
1997 sender=msg['author']['email'],
1998 autogenerated=is_autogenerated,
1999 # These could be inferred from the text messages and correlated with
2000 # Code-Review label maximum, however this is not reliable.
2001 # Leaving as is until the need arises.
2002 approval=False,
2003 disapproval=False,
2004 )
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01002005
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002006 def CloseIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002007 gerrit_util.AbandonChange(
2008 self._GetGerritHost(), self._GerritChangeIdentifier(), msg='')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002009
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002010 def SubmitIssue(self, wait_for_merge=True):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002011 gerrit_util.SubmitChange(
2012 self._GetGerritHost(), self._GerritChangeIdentifier(),
2013 wait_for_merge=wait_for_merge)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002014
Andrii Shyshkalovb7214602018-08-22 23:20:26 +00002015 def _GetChangeDetail(self, options=None, no_cache=False):
2016 """Returns details of associated Gerrit change and caching results.
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002017
2018 If fresh data is needed, set no_cache=True which will clear cache and
2019 thus new data will be fetched from Gerrit.
2020 """
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002021 options = options or []
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002022 assert self.GetIssue(), 'issue is required to query Gerrit'
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002023
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01002024 # Optimization to avoid multiple RPCs:
2025 if (('CURRENT_REVISION' in options or 'ALL_REVISIONS' in options) and
2026 'CURRENT_COMMIT' not in options):
2027 options.append('CURRENT_COMMIT')
2028
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002029 # Normalize issue and options for consistent keys in cache.
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002030 cache_key = str(self.GetIssue())
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002031 options = [o.upper() for o in options]
2032
2033 # Check in cache first unless no_cache is True.
2034 if no_cache:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002035 self._detail_cache.pop(cache_key, None)
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002036 else:
2037 options_set = frozenset(options)
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002038 for cached_options_set, data in self._detail_cache.get(cache_key, []):
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002039 # Assumption: data fetched before with extra options is suitable
2040 # for return for a smaller set of options.
2041 # For example, if we cached data for
2042 # options=[CURRENT_REVISION, DETAILED_FOOTERS]
2043 # and request is for options=[CURRENT_REVISION],
2044 # THEN we can return prior cached data.
2045 if options_set.issubset(cached_options_set):
2046 return data
2047
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002048 try:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002049 data = gerrit_util.GetChangeDetail(
2050 self._GetGerritHost(), self._GerritChangeIdentifier(), options)
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002051 except gerrit_util.GerritError as e:
2052 if e.http_status == 404:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002053 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002054 raise
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002055
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002056 self._detail_cache.setdefault(cache_key, []).append(
2057 (frozenset(options), data))
tandriic2405f52016-10-10 08:13:15 -07002058 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002059
Andrii Shyshkalovcc5f17e2018-08-22 23:35:59 +00002060 def _GetChangeCommit(self):
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002061 assert self.GetIssue(), 'issue must be set to query Gerrit'
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002062 try:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002063 data = gerrit_util.GetChangeCommit(
2064 self._GetGerritHost(), self._GerritChangeIdentifier())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002065 except gerrit_util.GerritError as e:
2066 if e.http_status == 404:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002067 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002068 raise
agable32978d92016-11-01 12:55:02 -07002069 return data
2070
Karen Qian40c19422019-03-13 21:28:29 +00002071 def _IsCqConfigured(self):
2072 detail = self._GetChangeDetail(['LABELS'])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002073 if u'Commit-Queue' not in detail.get('labels', {}):
Karen Qian40c19422019-03-13 21:28:29 +00002074 return False
2075 # TODO(crbug/753213): Remove temporary hack
2076 if ('https://chromium.googlesource.com/chromium/src' ==
Edward Lemur125d60a2019-09-13 18:25:41 +00002077 self.GetRemoteUrl() and
Karen Qian40c19422019-03-13 21:28:29 +00002078 detail['branch'].startswith('refs/branch-heads/')):
2079 return False
2080 return True
2081
Olivier Robin75ee7252018-04-13 10:02:56 +02002082 def CMDLand(self, force, bypass_hooks, verbose, parallel):
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002083 if git_common.is_dirty_git_tree('land'):
2084 return 1
Karen Qian40c19422019-03-13 21:28:29 +00002085
tandriid60367b2016-06-22 05:25:12 -07002086 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
Karen Qian40c19422019-03-13 21:28:29 +00002087 if not force and self._IsCqConfigured():
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00002088 confirm_or_exit('\nIt seems this repository has a CQ, '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002089 'which can test and land changes for you. '
2090 'Are you sure you wish to bypass it?\n',
2091 action='bypass CQ')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002092 differs = True
tandriic4344b52016-08-29 06:04:54 -07002093 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002094 # Note: git diff outputs nothing if there is no diff.
2095 if not last_upload or RunGit(['diff', last_upload]).strip():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002096 print('WARNING: Some changes from local branch haven\'t been uploaded.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002097 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002098 if detail['current_revision'] == last_upload:
2099 differs = False
2100 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002101 print('WARNING: Local branch contents differ from latest uploaded '
2102 'patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002103 if differs:
2104 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002105 confirm_or_exit(
2106 'Do you want to submit latest Gerrit patchset and bypass hooks?\n',
2107 action='submit')
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002108 print('WARNING: Bypassing hooks and submitting latest uploaded patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002109 elif not bypass_hooks:
2110 hook_results = self.RunHook(
2111 committing=True,
2112 may_prompt=not force,
2113 verbose=verbose,
Olivier Robin75ee7252018-04-13 10:02:56 +02002114 change=self.GetChange(self.GetCommonAncestorWithUpstream(), None),
2115 parallel=parallel)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002116 if not hook_results.should_continue():
2117 return 1
2118
2119 self.SubmitIssue(wait_for_merge=True)
2120 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002121 links = self._GetChangeCommit().get('web_links', [])
2122 for link in links:
Aaron Gable02cdbb42016-12-13 16:24:25 -08002123 if link.get('name') == 'gitiles' and link.get('url'):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002124 print('Landed as: %s' % link.get('url'))
agable32978d92016-11-01 12:55:02 -07002125 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002126 return 0
2127
Edward Lemurf38bc172019-09-03 21:02:13 +00002128 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002129 assert parsed_issue_arg.valid
2130
Edward Lemur125d60a2019-09-13 18:25:41 +00002131 self.issue = parsed_issue_arg.issue
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002132
2133 if parsed_issue_arg.hostname:
2134 self._gerrit_host = parsed_issue_arg.hostname
2135 self._gerrit_server = 'https://%s' % self._gerrit_host
2136
tandriic2405f52016-10-10 08:13:15 -07002137 try:
2138 detail = self._GetChangeDetail(['ALL_REVISIONS'])
Aaron Gablea45ee112016-11-22 15:14:38 -08002139 except GerritChangeNotExists as e:
tandriic2405f52016-10-10 08:13:15 -07002140 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002141
2142 if not parsed_issue_arg.patchset:
2143 # Use current revision by default.
2144 revision_info = detail['revisions'][detail['current_revision']]
2145 patchset = int(revision_info['_number'])
2146 else:
2147 patchset = parsed_issue_arg.patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002148 for revision_info in detail['revisions'].values():
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002149 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2150 break
2151 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002152 DieWithError('Couldn\'t find patchset %i in change %i' %
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002153 (parsed_issue_arg.patchset, self.GetIssue()))
2154
Edward Lemur125d60a2019-09-13 18:25:41 +00002155 remote_url = self.GetRemoteUrl()
Aaron Gable697a91b2018-01-19 15:20:15 -08002156 if remote_url.endswith('.git'):
2157 remote_url = remote_url[:-len('.git')]
erikchen0d14d0d2018-08-28 18:57:09 +00002158 remote_url = remote_url.rstrip('/')
2159
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002160 fetch_info = revision_info['fetch']['http']
erikchen0d14d0d2018-08-28 18:57:09 +00002161 fetch_info['url'] = fetch_info['url'].rstrip('/')
Aaron Gable697a91b2018-01-19 15:20:15 -08002162
2163 if remote_url != fetch_info['url']:
2164 DieWithError('Trying to patch a change from %s but this repo appears '
2165 'to be %s.' % (fetch_info['url'], remote_url))
2166
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002167 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
Aaron Gable9387b4f2017-06-08 10:50:03 -07002168
Aaron Gable62619a32017-06-16 08:22:09 -07002169 if force:
2170 RunGit(['reset', '--hard', 'FETCH_HEAD'])
2171 print('Checked out commit for change %i patchset %i locally' %
2172 (parsed_issue_arg.issue, patchset))
Stefan Zager2d5f0392017-10-10 15:17:53 -07002173 elif nocommit:
2174 RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD'])
2175 print('Patch applied to index.')
Aaron Gable62619a32017-06-16 08:22:09 -07002176 else:
Aaron Gable9387b4f2017-06-08 10:50:03 -07002177 RunGit(['cherry-pick', 'FETCH_HEAD'])
2178 print('Committed patch for change %i patchset %i locally.' %
Aaron Gable62619a32017-06-16 08:22:09 -07002179 (parsed_issue_arg.issue, patchset))
2180 print('Note: this created a local commit which does not have '
2181 'the same hash as the one uploaded for review. This will make '
2182 'uploading changes based on top of this branch difficult.\n'
2183 'If you want to do that, use "git cl patch --force" instead.')
2184
Stefan Zagerd08043c2017-10-12 12:07:02 -07002185 if self.GetBranch():
2186 self.SetIssue(parsed_issue_arg.issue)
2187 self.SetPatchset(patchset)
2188 fetched_hash = RunGit(['rev-parse', 'FETCH_HEAD']).strip()
2189 self._GitSetBranchConfigValue('last-upload-hash', fetched_hash)
2190 self._GitSetBranchConfigValue('gerritsquashhash', fetched_hash)
2191 else:
2192 print('WARNING: You are in detached HEAD state.\n'
2193 'The patch has been applied to your checkout, but you will not be '
2194 'able to upload a new patch set to the gerrit issue.\n'
2195 'Try using the \'-b\' option if you would like to work on a '
2196 'branch and/or upload a new patch set.')
2197
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002198 return 0
2199
tandrii16e0b4e2016-06-07 10:34:28 -07002200 def _GerritCommitMsgHookCheck(self, offer_removal):
2201 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2202 if not os.path.exists(hook):
2203 return
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002204 # Crude attempt to distinguish Gerrit Codereview hook from a potentially
2205 # custom developer-made one.
tandrii16e0b4e2016-06-07 10:34:28 -07002206 data = gclient_utils.FileRead(hook)
2207 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2208 return
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002209 print('WARNING: You have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002210 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002211 'and may interfere with it in subtle ways.\n'
2212 'We recommend you remove the commit-msg hook.')
2213 if offer_removal:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002214 if ask_for_explicit_yes('Do you want to remove it now?'):
tandrii16e0b4e2016-06-07 10:34:28 -07002215 gclient_utils.rm_file_or_tree(hook)
2216 print('Gerrit commit-msg hook removed.')
2217 else:
2218 print('OK, will keep Gerrit commit-msg hook in place.')
2219
Edward Lemur1b52d872019-05-09 21:12:12 +00002220 def _CleanUpOldTraces(self):
2221 """Keep only the last |MAX_TRACES| traces."""
2222 try:
2223 traces = sorted([
2224 os.path.join(TRACES_DIR, f)
2225 for f in os.listdir(TRACES_DIR)
2226 if (os.path.isfile(os.path.join(TRACES_DIR, f))
2227 and not f.startswith('tmp'))
2228 ])
2229 traces_to_delete = traces[:-MAX_TRACES]
2230 for trace in traces_to_delete:
Daniel Chengcf6269b2019-05-18 01:02:12 +00002231 os.remove(trace)
Edward Lemur1b52d872019-05-09 21:12:12 +00002232 except OSError:
2233 print('WARNING: Failed to remove old git traces from\n'
2234 ' %s'
2235 'Consider removing them manually.' % TRACES_DIR)
Edward Lemurdc8e23d2019-05-07 00:45:48 +00002236
Edward Lemur5737f022019-05-17 01:24:00 +00002237 def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002238 """Zip and write the git push traces stored in traces_dir."""
2239 gclient_utils.safe_makedirs(TRACES_DIR)
Edward Lemur1b52d872019-05-09 21:12:12 +00002240 traces_zip = trace_name + '-traces'
2241 traces_readme = trace_name + '-README'
Michael Mosse7f0b4c2019-05-08 04:36:24 +00002242 # Create a temporary dir to store git config and gitcookies in. It will be
2243 # compressed and stored next to the traces.
2244 git_info_dir = tempfile.mkdtemp()
Edward Lemur1b52d872019-05-09 21:12:12 +00002245 git_info_zip = trace_name + '-git-info'
2246
Edward Lemur5737f022019-05-17 01:24:00 +00002247 git_push_metadata['now'] = datetime_now().strftime('%c')
Eric Boren67c48202019-05-30 16:52:51 +00002248 if sys.stdin.encoding and sys.stdin.encoding != 'utf-8':
sangwoo.ko7a614332019-05-22 02:46:19 +00002249 git_push_metadata['now'] = git_push_metadata['now'].decode(
2250 sys.stdin.encoding)
2251
Edward Lemur1b52d872019-05-09 21:12:12 +00002252 git_push_metadata['trace_name'] = trace_name
2253 gclient_utils.FileWrite(
2254 traces_readme, TRACES_README_FORMAT % git_push_metadata)
2255
2256 # Keep only the first 6 characters of the git hashes on the packet
2257 # trace. This greatly decreases size after compression.
2258 packet_traces = os.path.join(traces_dir, 'trace-packet')
2259 if os.path.isfile(packet_traces):
2260 contents = gclient_utils.FileRead(packet_traces)
2261 gclient_utils.FileWrite(
2262 packet_traces, GIT_HASH_RE.sub(r'\1', contents))
2263 shutil.make_archive(traces_zip, 'zip', traces_dir)
2264
2265 # Collect and compress the git config and gitcookies.
2266 git_config = RunGit(['config', '-l'])
2267 gclient_utils.FileWrite(
2268 os.path.join(git_info_dir, 'git-config'),
2269 git_config)
2270
2271 cookie_auth = gerrit_util.Authenticator.get()
2272 if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
2273 gitcookies_path = cookie_auth.get_gitcookies_path()
2274 if os.path.isfile(gitcookies_path):
2275 gitcookies = gclient_utils.FileRead(gitcookies_path)
2276 gclient_utils.FileWrite(
2277 os.path.join(git_info_dir, 'gitcookies'),
2278 GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies))
2279 shutil.make_archive(git_info_zip, 'zip', git_info_dir)
2280
Edward Lemur1b52d872019-05-09 21:12:12 +00002281 gclient_utils.rmtree(git_info_dir)
2282
2283 def _RunGitPushWithTraces(
2284 self, change_desc, refspec, refspec_opts, git_push_metadata):
2285 """Run git push and collect the traces resulting from the execution."""
2286 # Create a temporary directory to store traces in. Traces will be compressed
2287 # and stored in a 'traces' dir inside depot_tools.
2288 traces_dir = tempfile.mkdtemp()
Edward Lemur5737f022019-05-17 01:24:00 +00002289 trace_name = os.path.join(
2290 TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f'))
Edward Lemur0f58ae42019-04-30 17:24:12 +00002291
2292 env = os.environ.copy()
2293 env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy'
2294 env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Jonathan Nieder9779b142019-05-29 23:19:29 +00002295 env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002296 env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl')
2297 env['GIT_TRACE_CURL_NO_DATA'] = '1'
2298 env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet')
2299
2300 try:
2301 push_returncode = 0
Edward Lemur1b52d872019-05-09 21:12:12 +00002302 remote_url = self.GetRemoteUrl()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002303 before_push = time_time()
2304 push_stdout = gclient_utils.CheckCallAndFilter(
Edward Lemur1b52d872019-05-09 21:12:12 +00002305 ['git', 'push', remote_url, refspec],
Edward Lemur0f58ae42019-04-30 17:24:12 +00002306 env=env,
2307 print_stdout=True,
2308 # Flush after every line: useful for seeing progress when running as
2309 # recipe.
2310 filter_fn=lambda _: sys.stdout.flush())
2311 except subprocess2.CalledProcessError as e:
2312 push_returncode = e.returncode
2313 DieWithError('Failed to create a change. Please examine output above '
2314 'for the reason of the failure.\n'
2315 'Hint: run command below to diagnose common Git/Gerrit '
2316 'credential problems:\n'
Edward Lemur5737f022019-05-17 01:24:00 +00002317 ' git cl creds-check\n'
2318 '\n'
2319 'If git-cl is not working correctly, file a bug under the '
2320 'Infra>SDK component including the files below.\n'
2321 'Review the files before upload, since they might contain '
2322 'sensitive information.\n'
2323 'Set the Restrict-View-Google label so that they are not '
2324 'publicly accessible.\n'
2325 + TRACES_MESSAGE % {'trace_name': trace_name},
Edward Lemur0f58ae42019-04-30 17:24:12 +00002326 change_desc)
2327 finally:
2328 execution_time = time_time() - before_push
2329 metrics.collector.add_repeated('sub_commands', {
2330 'command': 'git push',
2331 'execution_time': execution_time,
2332 'exit_code': push_returncode,
2333 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts),
2334 })
2335
Edward Lemur1b52d872019-05-09 21:12:12 +00002336 git_push_metadata['execution_time'] = execution_time
2337 git_push_metadata['exit_code'] = push_returncode
Edward Lemur5737f022019-05-17 01:24:00 +00002338 self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata)
Edward Lemur0f58ae42019-04-30 17:24:12 +00002339
Edward Lemur1b52d872019-05-09 21:12:12 +00002340 self._CleanUpOldTraces()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002341 gclient_utils.rmtree(traces_dir)
2342
2343 return push_stdout
2344
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002345 def CMDUploadChange(self, options, git_diff_args, custom_cl_base, change):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002346 """Upload the current branch to Gerrit."""
Mike Frysingera989d552019-08-14 20:51:23 +00002347 if options.squash is None:
tandriia60502f2016-06-20 02:01:53 -07002348 # Load default for user, repo, squash=true, in this order.
2349 options.squash = settings.GetSquashGerritUploads()
tandrii26f3e4e2016-06-10 08:37:04 -07002350
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002351 remote, remote_branch = self.GetRemoteBranch()
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01002352 branch = GetTargetRef(remote, remote_branch, options.target_branch)
Aaron Gableb56ad332017-01-06 15:24:31 -08002353 # This may be None; default fallback value is determined in logic below.
2354 title = options.title
2355
Dominic Battre7d1c4842017-10-27 09:17:28 +02002356 # Extract bug number from branch name.
2357 bug = options.bug
Dan Beamd8b04ca2019-10-10 21:23:26 +00002358 fixed = options.fixed
2359 match = re.match(r'(?P<type>bug|fix(?:e[sd])?)[_-]?(?P<bugnum>\d+)',
2360 self.GetBranch())
2361 if not bug and not fixed and match:
2362 if match.group('type') == 'bug':
2363 bug = match.group('bugnum')
2364 else:
2365 fixed = match.group('bugnum')
Dominic Battre7d1c4842017-10-27 09:17:28 +02002366
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002367 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002368 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002369 if self.GetIssue():
2370 # Try to get the message from a previous upload.
2371 message = self.GetDescription()
2372 if not message:
2373 DieWithError(
Aaron Gablea45ee112016-11-22 15:14:38 -08002374 'failed to fetch description from current Gerrit change %d\n'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002375 '%s' % (self.GetIssue(), self.GetIssueURL()))
Aaron Gableb56ad332017-01-06 15:24:31 -08002376 if not title:
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002377 if options.message:
Aaron Gable7303dcb2017-06-07 14:17:32 -07002378 # When uploading a subsequent patchset, -m|--message is taken
2379 # as the patchset title if --title was not provided.
2380 title = options.message.strip()
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002381 else:
2382 default_title = RunGit(
2383 ['show', '-s', '--format=%s', 'HEAD']).strip()
Aaron Gable7303dcb2017-06-07 14:17:32 -07002384 if options.force:
2385 title = default_title
2386 else:
2387 title = ask_for_data(
2388 'Title for patchset [%s]: ' % default_title) or default_title
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002389 change_id = self._GetChangeDetail()['change_id']
2390 while True:
2391 footer_change_ids = git_footers.get_footer_change_id(message)
2392 if footer_change_ids == [change_id]:
2393 break
2394 if not footer_change_ids:
2395 message = git_footers.add_footer_change_id(message, change_id)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002396 print('WARNING: appended missing Change-Id to change description.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002397 continue
2398 # There is already a valid footer but with different or several ids.
2399 # Doing this automatically is non-trivial as we don't want to lose
2400 # existing other footers, yet we want to append just 1 desired
2401 # Change-Id. Thus, just create a new footer, but let user verify the
2402 # new description.
2403 message = '%s\n\nChange-Id: %s' % (message, change_id)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002404 change_desc = ChangeDescription(message, bug=bug, fixed=fixed)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002405 if not options.force:
Anthony Polito8b955342019-09-24 19:01:36 +00002406 print(
2407 'WARNING: change %s has Change-Id footer(s):\n'
2408 ' %s\n'
2409 'but change has Change-Id %s, according to Gerrit.\n'
2410 'Please, check the proposed correction to the description, '
2411 'and edit it if necessary but keep the "Change-Id: %s" footer\n'
2412 % (self.GetIssue(), '\n '.join(footer_change_ids), change_id,
2413 change_id))
2414 confirm_or_exit(action='edit')
2415 change_desc.prompt()
2416
2417 message = change_desc.description
2418 if not message:
2419 DieWithError("Description is empty. Aborting...")
2420
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002421 # Continue the while loop.
2422 # Sanity check of this code - we should end up with proper message
2423 # footer.
2424 assert [change_id] == git_footers.get_footer_change_id(message)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002425 change_desc = ChangeDescription(message, bug=bug, fixed=fixed)
Aaron Gableb56ad332017-01-06 15:24:31 -08002426 else: # if not self.GetIssue()
2427 if options.message:
2428 message = options.message
2429 else:
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002430 message = _create_description_from_log(git_diff_args)
Aaron Gableb56ad332017-01-06 15:24:31 -08002431 if options.title:
2432 message = options.title + '\n\n' + message
Dan Beamd8b04ca2019-10-10 21:23:26 +00002433 change_desc = ChangeDescription(message, bug=bug, fixed=fixed)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002434 if not options.force:
Anthony Polito8b955342019-09-24 19:01:36 +00002435 change_desc.prompt()
2436
Aaron Gableb56ad332017-01-06 15:24:31 -08002437 # On first upload, patchset title is always this string, while
2438 # --title flag gets converted to first line of message.
2439 title = 'Initial upload'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002440 if not change_desc.description:
2441 DieWithError("Description is empty. Aborting...")
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002442 change_ids = git_footers.get_footer_change_id(change_desc.description)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002443 if len(change_ids) > 1:
2444 DieWithError('too many Change-Id footers, at most 1 allowed.')
2445 if not change_ids:
2446 # Generate the Change-Id automatically.
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002447 change_desc.set_description(git_footers.add_footer_change_id(
2448 change_desc.description,
2449 GenerateGerritChangeId(change_desc.description)))
2450 change_ids = git_footers.get_footer_change_id(change_desc.description)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002451 assert len(change_ids) == 1
2452 change_id = change_ids[0]
2453
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002454 if options.reviewers or options.tbrs or options.add_owners_to:
2455 change_desc.update_reviewers(options.reviewers, options.tbrs,
2456 options.add_owners_to, change)
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002457 if options.preserve_tryjobs:
2458 change_desc.set_preserve_tryjobs()
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002459
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002460 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002461 parent = self._ComputeParent(remote, upstream_branch, custom_cl_base,
2462 options.force, change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002463 tree = RunGit(['rev-parse', 'HEAD:']).strip()
Aaron Gable9a03ae02017-11-03 11:31:07 -07002464 with tempfile.NamedTemporaryFile(delete=False) as desc_tempfile:
2465 desc_tempfile.write(change_desc.description)
2466 desc_tempfile.close()
2467 ref_to_push = RunGit(['commit-tree', tree, '-p', parent,
2468 '-F', desc_tempfile.name]).strip()
2469 os.remove(desc_tempfile.name)
Anthony Polito8b955342019-09-24 19:01:36 +00002470 else: # if not options.squash
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002471 change_desc = ChangeDescription(
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002472 options.message or _create_description_from_log(git_diff_args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002473 if not change_desc.description:
2474 DieWithError("Description is empty. Aborting...")
2475
2476 if not git_footers.get_footer_change_id(change_desc.description):
2477 DownloadGerritHook(False)
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002478 change_desc.set_description(
2479 self._AddChangeIdToCommitMessage(options, git_diff_args))
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002480 if options.reviewers or options.tbrs or options.add_owners_to:
2481 change_desc.update_reviewers(options.reviewers, options.tbrs,
2482 options.add_owners_to, change)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002483 ref_to_push = 'HEAD'
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002484 # For no-squash mode, we assume the remote called "origin" is the one we
2485 # want. It is not worthwhile to support different workflows for
2486 # no-squash mode.
2487 parent = 'origin/%s' % branch
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002488 change_id = git_footers.get_footer_change_id(change_desc.description)[0]
2489
2490 assert change_desc
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +00002491 SaveDescriptionBackup(change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002492 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2493 ref_to_push)]).splitlines()
2494 if len(commits) > 1:
2495 print('WARNING: This will upload %d commits. Run the following command '
2496 'to see which commits will be uploaded: ' % len(commits))
2497 print('git log %s..%s' % (parent, ref_to_push))
2498 print('You can also use `git squash-branch` to squash these into a '
2499 'single commit.')
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002500 confirm_or_exit(action='upload')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002501
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002502 if options.reviewers or options.tbrs or options.add_owners_to:
2503 change_desc.update_reviewers(options.reviewers, options.tbrs,
2504 options.add_owners_to, change)
2505
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002506 reviewers = sorted(change_desc.get_reviewers())
Edward Lemur4508b422019-10-03 21:56:35 +00002507 cc = []
2508 # Add CCs from WATCHLISTS and rietveld.cc git config unless this is
2509 # the initial upload, the CL is private, or auto-CCing has ben disabled.
2510 if not (self.GetIssue() or options.private or options.no_autocc):
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002511 cc = self.GetCCList().split(',')
Edward Lemur4508b422019-10-03 21:56:35 +00002512 # Add cc's from the --cc flag.
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002513 if options.cc:
2514 cc.extend(options.cc)
2515 cc = filter(None, [email.strip() for email in cc])
2516 if change_desc.get_cced():
2517 cc.extend(change_desc.get_cced())
Andrii Shyshkalov0da5e8f2018-10-30 17:29:18 +00002518 if self._GetGerritHost() == 'chromium-review.googlesource.com':
2519 valid_accounts = set(reviewers + cc)
2520 # TODO(crbug/877717): relax this for all hosts.
2521 else:
2522 valid_accounts = gerrit_util.ValidAccounts(
2523 self._GetGerritHost(), reviewers + cc)
Andrii Shyshkalovf170af42018-10-30 07:00:44 +00002524 logging.info('accounts %s are recognized, %s invalid',
2525 sorted(valid_accounts),
2526 set(reviewers + cc).difference(set(valid_accounts)))
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002527
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002528 # Extra options that can be specified at push time. Doc:
2529 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002530 refspec_opts = []
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002531
Aaron Gable844cf292017-06-28 11:32:59 -07002532 # By default, new changes are started in WIP mode, and subsequent patchsets
2533 # don't send email. At any time, passing --send-mail will mark the change
2534 # ready and send email for that particular patch.
Aaron Gableafd52772017-06-27 16:40:10 -07002535 if options.send_mail:
2536 refspec_opts.append('ready')
Aaron Gable844cf292017-06-28 11:32:59 -07002537 refspec_opts.append('notify=ALL')
Jamie Madill276da0b2018-04-27 14:41:20 -04002538 elif not self.GetIssue() and options.squash:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002539 refspec_opts.append('wip')
Aaron Gableafd52772017-06-27 16:40:10 -07002540 else:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002541 refspec_opts.append('notify=NONE')
Aaron Gable70f4e242017-06-26 10:45:59 -07002542
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002543 # TODO(tandrii): options.message should be posted as a comment
Aaron Gablee5adf612017-07-14 10:43:58 -07002544 # if --send-mail is set on non-initial upload as Rietveld used to do it.
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002545
Aaron Gable9b713dd2016-12-14 16:04:21 -08002546 if title:
Nick Carter8692b182017-11-06 16:30:38 -08002547 # Punctuation and whitespace in |title| must be percent-encoded.
2548 refspec_opts.append('m=' + gerrit_util.PercentEncodeForGitRef(title))
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002549
agablec6787972016-09-09 16:13:34 -07002550 if options.private:
Aaron Gableb02daf02017-05-23 11:53:46 -07002551 refspec_opts.append('private')
agablec6787972016-09-09 16:13:34 -07002552
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002553 for r in sorted(reviewers):
2554 if r in valid_accounts:
2555 refspec_opts.append('r=%s' % r)
2556 reviewers.remove(r)
2557 else:
2558 # TODO(tandrii): this should probably be a hard failure.
2559 print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping'
2560 % r)
2561 for c in sorted(cc):
2562 # refspec option will be rejected if cc doesn't correspond to an
2563 # account, even though REST call to add such arbitrary cc may succeed.
2564 if c in valid_accounts:
2565 refspec_opts.append('cc=%s' % c)
2566 cc.remove(c)
2567
rmistry9eadede2016-09-19 11:22:43 -07002568 if options.topic:
2569 # Documentation on Gerrit topics is here:
2570 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002571 refspec_opts.append('topic=%s' % options.topic)
rmistry9eadede2016-09-19 11:22:43 -07002572
Edward Lemur687ca902018-12-05 02:30:30 +00002573 if options.enable_auto_submit:
2574 refspec_opts.append('l=Auto-Submit+1')
2575 if options.use_commit_queue:
2576 refspec_opts.append('l=Commit-Queue+2')
2577 elif options.cq_dry_run:
2578 refspec_opts.append('l=Commit-Queue+1')
2579
2580 if change_desc.get_reviewers(tbr_only=True):
2581 score = gerrit_util.GetCodeReviewTbrScore(
2582 self._GetGerritHost(),
2583 self._GetGerritProject())
2584 refspec_opts.append('l=Code-Review+%s' % score)
Andrii Shyshkalove7a7fc42018-10-30 17:35:09 +00002585
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002586 # Gerrit sorts hashtags, so order is not important.
Nodir Turakulov23b82142017-11-16 11:04:25 -08002587 hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags}
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002588 if not self.GetIssue():
Nodir Turakulov23b82142017-11-16 11:04:25 -08002589 hashtags.update(change_desc.get_hash_tags())
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002590 refspec_opts += ['hashtag=%s' % t for t in sorted(hashtags)]
2591
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002592 refspec_suffix = ''
2593 if refspec_opts:
2594 refspec_suffix = '%' + ','.join(refspec_opts)
2595 assert ' ' not in refspec_suffix, (
2596 'spaces not allowed in refspec: "%s"' % refspec_suffix)
2597 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
2598
Edward Lemur1b52d872019-05-09 21:12:12 +00002599 git_push_metadata = {
2600 'gerrit_host': self._GetGerritHost(),
2601 'title': title or '<untitled>',
2602 'change_id': change_id,
2603 'description': change_desc.description,
2604 }
2605 push_stdout = self._RunGitPushWithTraces(
2606 change_desc, refspec, refspec_opts, git_push_metadata)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002607
2608 if options.squash:
Aaron Gable289b4312017-09-13 14:06:16 -07002609 regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002610 change_numbers = [m.group(1)
2611 for m in map(regex.match, push_stdout.splitlines())
2612 if m]
2613 if len(change_numbers) != 1:
2614 DieWithError(
2615 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
Christopher Lamf732cd52017-01-24 12:40:11 +11002616 'Change-Id: %s') % (len(change_numbers), change_id), change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002617 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002618 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002619
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002620 if self.GetIssue() and (reviewers or cc):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002621 # GetIssue() is not set in case of non-squash uploads according to tests.
2622 # TODO(agable): non-squash uploads in git cl should be removed.
2623 gerrit_util.AddReviewers(
2624 self._GetGerritHost(),
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00002625 self._GerritChangeIdentifier(),
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002626 reviewers, cc,
2627 notify=bool(options.send_mail))
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002628
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002629 return 0
2630
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002631 def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force,
2632 change_desc):
2633 """Computes parent of the generated commit to be uploaded to Gerrit.
2634
2635 Returns revision or a ref name.
2636 """
2637 if custom_cl_base:
2638 # Try to avoid creating additional unintended CLs when uploading, unless
2639 # user wants to take this risk.
2640 local_ref_of_target_remote = self.GetRemoteBranch()[1]
2641 code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base,
2642 local_ref_of_target_remote])
2643 if code == 1:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002644 print('\nWARNING: Manually specified base of this CL `%s` '
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002645 'doesn\'t seem to belong to target remote branch `%s`.\n\n'
2646 'If you proceed with upload, more than 1 CL may be created by '
2647 'Gerrit as a result, in turn confusing or crashing git cl.\n\n'
2648 'If you are certain that specified base `%s` has already been '
2649 'uploaded to Gerrit as another CL, you may proceed.\n' %
2650 (custom_cl_base, local_ref_of_target_remote, custom_cl_base))
2651 if not force:
2652 confirm_or_exit(
2653 'Do you take responsibility for cleaning up potential mess '
2654 'resulting from proceeding with upload?',
2655 action='upload')
2656 return custom_cl_base
2657
Aaron Gablef97e33d2017-03-30 15:44:27 -07002658 if remote != '.':
2659 return self.GetCommonAncestorWithUpstream()
2660
2661 # If our upstream branch is local, we base our squashed commit on its
2662 # squashed version.
2663 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2664
Aaron Gablef97e33d2017-03-30 15:44:27 -07002665 if upstream_branch_name == 'master':
Aaron Gable0bbd1c22017-05-08 14:37:08 -07002666 return self.GetCommonAncestorWithUpstream()
Aaron Gablef97e33d2017-03-30 15:44:27 -07002667
2668 # Check the squashed hash of the parent.
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002669 # TODO(tandrii): consider checking parent change in Gerrit and using its
2670 # hash if tree hash of latest parent revision (patchset) in Gerrit matches
2671 # the tree hash of the parent branch. The upside is less likely bogus
2672 # requests to reupload parent change just because it's uploadhash is
2673 # missing, yet the downside likely exists, too (albeit unknown to me yet).
Aaron Gablef97e33d2017-03-30 15:44:27 -07002674 parent = RunGit(['config',
2675 'branch.%s.gerritsquashhash' % upstream_branch_name],
2676 error_ok=True).strip()
2677 # Verify that the upstream branch has been uploaded too, otherwise
2678 # Gerrit will create additional CLs when uploading.
2679 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2680 RunGitSilent(['rev-parse', parent + ':'])):
2681 DieWithError(
2682 '\nUpload upstream branch %s first.\n'
2683 'It is likely that this branch has been rebased since its last '
2684 'upload, so you just need to upload it again.\n'
2685 '(If you uploaded it with --no-squash, then branch dependencies '
2686 'are not supported, and you should reupload with --squash.)'
2687 % upstream_branch_name,
2688 change_desc)
2689 return parent
2690
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002691 def _AddChangeIdToCommitMessage(self, options, args):
2692 """Re-commits using the current message, assumes the commit hook is in
2693 place.
2694 """
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002695 log_desc = options.message or _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002696 git_command = ['commit', '--amend', '-m', log_desc]
2697 RunGit(git_command)
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002698 new_log_desc = _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002699 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002700 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002701 return new_log_desc
2702 else:
tandrii@chromium.orgb067ec52016-05-31 15:24:44 +00002703 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002704
tandriie113dfd2016-10-11 10:20:12 -07002705 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002706 try:
2707 data = self._GetChangeDetail()
Aaron Gablea45ee112016-11-22 15:14:38 -08002708 except GerritChangeNotExists:
2709 return 'Gerrit doesn\'t know about your change %s' % self.GetIssue()
tandrii8c5a3532016-11-04 07:52:02 -07002710
2711 if data['status'] in ('ABANDONED', 'MERGED'):
2712 return 'CL %s is closed' % self.GetIssue()
2713
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002714 def GetGerritChange(self, patchset=None):
2715 """Returns a buildbucket.v2.GerritChange message for the current issue."""
2716 host = urlparse.urlparse(self.GetCodereviewServer()).hostname
2717 issue = self.GetIssue()
Edward Lemur2c210a42019-09-16 23:58:35 +00002718 patchset = int(patchset or self.GetPatchset())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002719 data = self._GetChangeDetail(['ALL_REVISIONS'])
2720
2721 assert host and issue and patchset, 'CL must be uploaded first'
2722
2723 has_patchset = any(
2724 int(revision_data['_number']) == patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002725 for revision_data in data['revisions'].values())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002726 if not has_patchset:
Aaron Gablea45ee112016-11-22 15:14:38 -08002727 raise Exception('Patchset %d is not known in Gerrit change %d' %
tandrii8c5a3532016-11-04 07:52:02 -07002728 (patchset, self.GetIssue()))
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002729
tandrii8c5a3532016-11-04 07:52:02 -07002730 return {
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002731 'host': host,
2732 'change': issue,
2733 'project': data['project'],
2734 'patchset': patchset,
tandrii8c5a3532016-11-04 07:52:02 -07002735 }
tandriie113dfd2016-10-11 10:20:12 -07002736
tandriide281ae2016-10-12 06:02:30 -07002737 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002738 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002739
Edward Lemur707d70b2018-02-07 00:50:14 +01002740 def GetReviewers(self):
2741 details = self._GetChangeDetail(['DETAILED_ACCOUNTS'])
Mohamed Heikal171c0742018-11-09 20:38:51 +00002742 return [r['email'] for r in details['reviewers'].get('REVIEWER', [])]
Edward Lemur707d70b2018-02-07 00:50:14 +01002743
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002744
2745_CODEREVIEW_IMPLEMENTATIONS = {
Edward Lemur125d60a2019-09-13 18:25:41 +00002746 'gerrit': Changelist,
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002747}
2748
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002749
iannuccie53c9352016-08-17 14:40:40 -07002750def _add_codereview_issue_select_options(parser, extra=""):
2751 _add_codereview_select_options(parser)
2752
2753 text = ('Operate on this issue number instead of the current branch\'s '
2754 'implicit issue.')
2755 if extra:
2756 text += ' '+extra
2757 parser.add_option('-i', '--issue', type=int, help=text)
2758
2759
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002760def _add_codereview_select_options(parser):
Edward Lemurf38bc172019-09-03 21:02:13 +00002761 """Appends --gerrit option to force specific codereview."""
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002762 parser.codereview_group = optparse.OptionGroup(
Edward Lemurf38bc172019-09-03 21:02:13 +00002763 parser, 'DEPRECATED! Codereview override options')
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002764 parser.add_option_group(parser.codereview_group)
2765 parser.codereview_group.add_option(
2766 '--gerrit', action='store_true',
Edward Lemurf38bc172019-09-03 21:02:13 +00002767 help='Deprecated. Noop. Do not use.')
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002768
2769
tandriif9aefb72016-07-01 09:06:51 -07002770def _get_bug_line_values(default_project, bugs):
2771 """Given default_project and comma separated list of bugs, yields bug line
2772 values.
2773
2774 Each bug can be either:
2775 * a number, which is combined with default_project
2776 * string, which is left as is.
2777
2778 This function may produce more than one line, because bugdroid expects one
2779 project per line.
2780
2781 >>> list(_get_bug_line_values('v8', '123,chromium:789'))
2782 ['v8:123', 'chromium:789']
2783 """
2784 default_bugs = []
2785 others = []
2786 for bug in bugs.split(','):
2787 bug = bug.strip()
2788 if bug:
2789 try:
2790 default_bugs.append(int(bug))
2791 except ValueError:
2792 others.append(bug)
2793
2794 if default_bugs:
2795 default_bugs = ','.join(map(str, default_bugs))
2796 if default_project:
2797 yield '%s:%s' % (default_project, default_bugs)
2798 else:
2799 yield default_bugs
2800 for other in sorted(others):
2801 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2802 yield other
2803
2804
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002805class ChangeDescription(object):
2806 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002807 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002808 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
Aaron Gable3a16ed12017-03-23 10:51:55 -07002809 BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$'
Dan Beamd8b04ca2019-10-10 21:23:26 +00002810 FIXED_LINE = r'^[ \t]*Fixed[ \t]*:[ \t]*(.*?)[ \t]*$'
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002811 CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002812 STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*'
2813 BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]'
2814 COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):'
2815 BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002816
Dan Beamd8b04ca2019-10-10 21:23:26 +00002817 def __init__(self, description, bug=None, fixed=None):
agable@chromium.org42c20792013-09-12 17:34:49 +00002818 self._description_lines = (description or '').strip().splitlines()
Anthony Polito8b955342019-09-24 19:01:36 +00002819 if bug:
2820 regexp = re.compile(self.BUG_LINE)
2821 prefix = settings.GetBugPrefix()
2822 if not any((regexp.match(line) for line in self._description_lines)):
2823 values = list(_get_bug_line_values(prefix, bug))
2824 self.append_footer('Bug: %s' % ', '.join(values))
Dan Beamd8b04ca2019-10-10 21:23:26 +00002825 if fixed:
2826 regexp = re.compile(self.FIXED_LINE)
2827 prefix = settings.GetBugPrefix()
2828 if not any((regexp.match(line) for line in self._description_lines)):
2829 values = list(_get_bug_line_values(prefix, fixed))
2830 self.append_footer('Fixed: %s' % ', '.join(values))
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002831
agable@chromium.org42c20792013-09-12 17:34:49 +00002832 @property # www.logilab.org/ticket/89786
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08002833 def description(self): # pylint: disable=method-hidden
agable@chromium.org42c20792013-09-12 17:34:49 +00002834 return '\n'.join(self._description_lines)
2835
2836 def set_description(self, desc):
2837 if isinstance(desc, basestring):
2838 lines = desc.splitlines()
2839 else:
2840 lines = [line.rstrip() for line in desc]
2841 while lines and not lines[0]:
2842 lines.pop(0)
2843 while lines and not lines[-1]:
2844 lines.pop(-1)
2845 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002846
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002847 def update_reviewers(self, reviewers, tbrs, add_owners_to=None, change=None):
2848 """Rewrites the R=/TBR= line(s) as a single line each.
2849
2850 Args:
2851 reviewers (list(str)) - list of additional emails to use for reviewers.
2852 tbrs (list(str)) - list of additional emails to use for TBRs.
2853 add_owners_to (None|'R'|'TBR') - Pass to do an OWNERS lookup for files in
2854 the change that are missing OWNER coverage. If this is not None, you
2855 must also pass a value for `change`.
2856 change (Change) - The Change that should be used for OWNERS lookups.
2857 """
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002858 assert isinstance(reviewers, list), reviewers
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002859 assert isinstance(tbrs, list), tbrs
2860
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002861 assert add_owners_to in (None, 'TBR', 'R'), add_owners_to
Robert Iannuccia28592e2017-04-18 13:14:49 -07002862 assert not add_owners_to or change, add_owners_to
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002863
2864 if not reviewers and not tbrs and not add_owners_to:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002865 return
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002866
2867 reviewers = set(reviewers)
2868 tbrs = set(tbrs)
2869 LOOKUP = {
2870 'TBR': tbrs,
2871 'R': reviewers,
2872 }
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002873
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002874 # Get the set of R= and TBR= lines and remove them from the description.
agable@chromium.org42c20792013-09-12 17:34:49 +00002875 regexp = re.compile(self.R_LINE)
2876 matches = [regexp.match(line) for line in self._description_lines]
2877 new_desc = [l for i, l in enumerate(self._description_lines)
2878 if not matches[i]]
2879 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002880
agable@chromium.org42c20792013-09-12 17:34:49 +00002881 # Construct new unified R= and TBR= lines.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002882
2883 # First, update tbrs/reviewers with names from the R=/TBR= lines (if any).
agable@chromium.org42c20792013-09-12 17:34:49 +00002884 for match in matches:
2885 if not match:
2886 continue
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002887 LOOKUP[match.group(1)].update(cleanup_list([match.group(2).strip()]))
2888
2889 # Next, maybe fill in OWNERS coverage gaps to either tbrs/reviewers.
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002890 if add_owners_to:
piman@chromium.org336f9122014-09-04 02:16:55 +00002891 owners_db = owners.Database(change.RepositoryRoot(),
Jochen Eisinger72606f82017-04-04 10:44:18 +02002892 fopen=file, os_path=os.path)
piman@chromium.org336f9122014-09-04 02:16:55 +00002893 missing_files = owners_db.files_not_covered_by(change.LocalPaths(),
Robert Iannucci100aa212017-04-18 17:28:26 -07002894 (tbrs | reviewers))
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002895 LOOKUP[add_owners_to].update(
2896 owners_db.reviewers_for(missing_files, change.author_email))
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002897
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002898 # If any folks ended up in both groups, remove them from tbrs.
2899 tbrs -= reviewers
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002900
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002901 new_r_line = 'R=' + ', '.join(sorted(reviewers)) if reviewers else None
2902 new_tbr_line = 'TBR=' + ', '.join(sorted(tbrs)) if tbrs else None
agable@chromium.org42c20792013-09-12 17:34:49 +00002903
2904 # Put the new lines in the description where the old first R= line was.
2905 line_loc = next((i for i, match in enumerate(matches) if match), -1)
2906 if 0 <= line_loc < len(self._description_lines):
2907 if new_tbr_line:
2908 self._description_lines.insert(line_loc, new_tbr_line)
2909 if new_r_line:
2910 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002911 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00002912 if new_r_line:
2913 self.append_footer(new_r_line)
2914 if new_tbr_line:
2915 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002916
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002917 def set_preserve_tryjobs(self):
2918 """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'."""
2919 footers = git_footers.parse_footers(self.description)
2920 for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []):
2921 if v.lower() == 'true':
2922 return
2923 self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true')
2924
Anthony Polito8b955342019-09-24 19:01:36 +00002925 def prompt(self):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002926 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002927 self.set_description([
2928 '# Enter a description of the change.',
2929 '# This will be displayed on the codereview site.',
2930 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00002931 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00002932 '--------------------',
2933 ] + self._description_lines)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002934 bug_regexp = re.compile(self.BUG_LINE)
2935 fixed_regexp = re.compile(self.FIXED_LINE)
Jonas Termansend0f79112019-03-22 15:28:26 +00002936 prefix = settings.GetBugPrefix()
Dan Beamd8b04ca2019-10-10 21:23:26 +00002937 has_issue = lambda l: bug_regexp.match(l) or fixed_regexp.match(l)
2938 if not any((has_issue(line) for line in self._description_lines)):
Anthony Polito8b955342019-09-24 19:01:36 +00002939 self.append_footer('Bug: %s' % prefix)
tandriif9aefb72016-07-01 09:06:51 -07002940
agable@chromium.org42c20792013-09-12 17:34:49 +00002941 content = gclient_utils.RunEditor(self.description, True,
Anthony Polito8b955342019-09-24 19:01:36 +00002942 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002943 if not content:
2944 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00002945 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002946
Bruce Dawson2377b012018-01-11 16:46:49 -08002947 # Strip off comments and default inserted "Bug:" line.
2948 clean_lines = [line.rstrip() for line in lines if not
Jonas Termansend0f79112019-03-22 15:28:26 +00002949 (line.startswith('#') or
2950 line.rstrip() == "Bug:" or
2951 line.rstrip() == "Bug: " + prefix)]
agable@chromium.org42c20792013-09-12 17:34:49 +00002952 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002953 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00002954 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002955
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002956 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00002957 """Adds a footer line to the description.
2958
2959 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
2960 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
2961 that Gerrit footers are always at the end.
2962 """
2963 parsed_footer_line = git_footers.parse_footer(line)
2964 if parsed_footer_line:
2965 # Line is a gerrit footer in the form: Footer-Key: any value.
2966 # Thus, must be appended observing Gerrit footer rules.
2967 self.set_description(
2968 git_footers.add_footer(self.description,
2969 key=parsed_footer_line[0],
2970 value=parsed_footer_line[1]))
2971 return
2972
2973 if not self._description_lines:
2974 self._description_lines.append(line)
2975 return
2976
2977 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
2978 if gerrit_footers:
2979 # git_footers.split_footers ensures that there is an empty line before
2980 # actual (gerrit) footers, if any. We have to keep it that way.
2981 assert top_lines and top_lines[-1] == ''
2982 top_lines, separator = top_lines[:-1], top_lines[-1:]
2983 else:
2984 separator = [] # No need for separator if there are no gerrit_footers.
2985
2986 prev_line = top_lines[-1] if top_lines else ''
2987 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
2988 not presubmit_support.Change.TAG_LINE_RE.match(line)):
2989 top_lines.append('')
2990 top_lines.append(line)
2991 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002992
tandrii99a72f22016-08-17 14:33:24 -07002993 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002994 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002995 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07002996 reviewers = [match.group(2).strip()
2997 for match in matches
2998 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002999 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003000
bradnelsond975b302016-10-23 12:20:23 -07003001 def get_cced(self):
3002 """Retrieves the list of reviewers."""
3003 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
3004 cced = [match.group(2).strip() for match in matches if match]
3005 return cleanup_list(cced)
3006
Nodir Turakulov23b82142017-11-16 11:04:25 -08003007 def get_hash_tags(self):
3008 """Extracts and sanitizes a list of Gerrit hashtags."""
3009 subject = (self._description_lines or ('',))[0]
3010 subject = re.sub(
3011 self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE)
3012
3013 tags = []
3014 start = 0
3015 bracket_exp = re.compile(self.BRACKET_HASH_TAG)
3016 while True:
3017 m = bracket_exp.match(subject, start)
3018 if not m:
3019 break
3020 tags.append(self.sanitize_hash_tag(m.group(1)))
3021 start = m.end()
3022
3023 if not tags:
3024 # Try "Tag: " prefix.
3025 m = re.match(self.COLON_SEPARATED_HASH_TAG, subject)
3026 if m:
3027 tags.append(self.sanitize_hash_tag(m.group(1)))
3028 return tags
3029
3030 @classmethod
3031 def sanitize_hash_tag(cls, tag):
3032 """Returns a sanitized Gerrit hash tag.
3033
3034 A sanitized hashtag can be used as a git push refspec parameter value.
3035 """
3036 return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower()
3037
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003038 def update_with_git_number_footers(self, parent_hash, parent_msg, dest_ref):
3039 """Updates this commit description given the parent.
3040
3041 This is essentially what Gnumbd used to do.
3042 Consult https://goo.gl/WMmpDe for more details.
3043 """
3044 assert parent_msg # No, orphan branch creation isn't supported.
3045 assert parent_hash
3046 assert dest_ref
3047 parent_footer_map = git_footers.parse_footers(parent_msg)
3048 # This will also happily parse svn-position, which GnumbD is no longer
3049 # supporting. While we'd generate correct footers, the verifier plugin
3050 # installed in Gerrit will block such commit (ie git push below will fail).
3051 parent_position = git_footers.get_position(parent_footer_map)
3052
3053 # Cherry-picks may have last line obscuring their prior footers,
3054 # from git_footers perspective. This is also what Gnumbd did.
3055 cp_line = None
3056 if (self._description_lines and
3057 re.match(self.CHERRY_PICK_LINE, self._description_lines[-1])):
3058 cp_line = self._description_lines.pop()
3059
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003060 top_lines, footer_lines, _ = git_footers.split_footers(self.description)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003061
3062 # Original-ify all Cr- footers, to avoid re-lands, cherry-picks, or just
3063 # user interference with actual footers we'd insert below.
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003064 for i, line in enumerate(footer_lines):
3065 k, v = git_footers.parse_footer(line) or (None, None)
3066 if k and k.startswith('Cr-'):
3067 footer_lines[i] = '%s: %s' % ('Cr-Original-' + k[len('Cr-'):], v)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003068
3069 # Add Position and Lineage footers based on the parent.
Andrii Shyshkalovb5effa12016-12-14 19:35:12 +01003070 lineage = list(reversed(parent_footer_map.get('Cr-Branched-From', [])))
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003071 if parent_position[0] == dest_ref:
3072 # Same branch as parent.
3073 number = int(parent_position[1]) + 1
3074 else:
3075 number = 1 # New branch, and extra lineage.
3076 lineage.insert(0, '%s-%s@{#%d}' % (parent_hash, parent_position[0],
3077 int(parent_position[1])))
3078
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003079 footer_lines.append('Cr-Commit-Position: %s@{#%d}' % (dest_ref, number))
3080 footer_lines.extend('Cr-Branched-From: %s' % v for v in lineage)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003081
3082 self._description_lines = top_lines
3083 if cp_line:
3084 self._description_lines.append(cp_line)
3085 if self._description_lines[-1] != '':
3086 self._description_lines.append('') # Ensure footer separator.
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003087 self._description_lines.extend(footer_lines)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003088
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003089
Aaron Gablea1bab272017-04-11 16:38:18 -07003090def get_approving_reviewers(props, disapproval=False):
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003091 """Retrieves the reviewers that approved a CL from the issue properties with
3092 messages.
3093
3094 Note that the list may contain reviewers that are not committer, thus are not
3095 considered by the CQ.
Aaron Gablea1bab272017-04-11 16:38:18 -07003096
3097 If disapproval is True, instead returns reviewers who 'not lgtm'd the CL.
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003098 """
Aaron Gablea1bab272017-04-11 16:38:18 -07003099 approval_type = 'disapproval' if disapproval else 'approval'
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003100 return sorted(
3101 set(
3102 message['sender']
3103 for message in props['messages']
Aaron Gablea1bab272017-04-11 16:38:18 -07003104 if message[approval_type] and message['sender'] in props['reviewers']
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003105 )
3106 )
3107
3108
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003109def FindCodereviewSettingsFile(filename='codereview.settings'):
3110 """Finds the given file starting in the cwd and going up.
3111
3112 Only looks up to the top of the repository unless an
3113 'inherit-review-settings-ok' file exists in the root of the repository.
3114 """
3115 inherit_ok_file = 'inherit-review-settings-ok'
3116 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00003117 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003118 if os.path.isfile(os.path.join(root, inherit_ok_file)):
3119 root = '/'
3120 while True:
3121 if filename in os.listdir(cwd):
3122 if os.path.isfile(os.path.join(cwd, filename)):
3123 return open(os.path.join(cwd, filename))
3124 if cwd == root:
3125 break
3126 cwd = os.path.dirname(cwd)
3127
3128
3129def LoadCodereviewSettingsFromFile(fileobj):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003130 """Parses a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00003131 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003132
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003133 def SetProperty(name, setting, unset_error_ok=False):
3134 fullname = 'rietveld.' + name
3135 if setting in keyvals:
3136 RunGit(['config', fullname, keyvals[setting]])
3137 else:
3138 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
3139
tandrii48df5812016-10-17 03:55:37 -07003140 if not keyvals.get('GERRIT_HOST', False):
3141 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003142 # Only server setting is required. Other settings can be absent.
3143 # In that case, we ignore errors raised during option deletion attempt.
3144 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
3145 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
3146 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00003147 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003148 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
3149 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00003150 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
3151 unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003152
ukai@chromium.org7044efc2013-11-28 01:51:21 +00003153 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00003154 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00003155
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003156 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
tandrii8dd81ea2016-06-16 13:24:23 -07003157 RunGit(['config', 'gerrit.squash-uploads',
3158 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003159
tandrii@chromium.org28253532016-04-14 13:46:56 +00003160 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00003161 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00003162 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
3163
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003164 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01003165 # should be of the form
3166 # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
3167 # ORIGIN_URL_CONFIG: http://src.chromium.org/git
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003168 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
3169 keyvals['ORIGIN_URL_CONFIG']])
3170
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003171
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003172def urlretrieve(source, destination):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003173 """Downloads a network object to a local file, like urllib.urlretrieve.
3174
3175 This is necessary because urllib is broken for SSL connections via a proxy.
3176 """
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003177 with open(destination, 'w') as f:
Edward Lemurd2a5a4c2019-10-23 22:55:26 +00003178 f.write(urllib2.urlopen(source).read())
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003179
3180
ukai@chromium.org712d6102013-11-27 00:52:58 +00003181def hasSheBang(fname):
3182 """Checks fname is a #! script."""
3183 with open(fname) as f:
3184 return f.read(2).startswith('#!')
3185
3186
bpastene@chromium.org917f0ff2016-04-05 00:45:30 +00003187# TODO(bpastene) Remove once a cleaner fix to crbug.com/600473 presents itself.
3188def DownloadHooks(*args, **kwargs):
3189 pass
3190
3191
tandrii@chromium.org18630d62016-03-04 12:06:02 +00003192def DownloadGerritHook(force):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003193 """Downloads and installs a Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003194
3195 Args:
3196 force: True to update hooks. False to install hooks if not present.
3197 """
3198 if not settings.GetIsGerrit():
3199 return
ukai@chromium.org712d6102013-11-27 00:52:58 +00003200 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003201 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
3202 if not os.access(dst, os.X_OK):
3203 if os.path.exists(dst):
3204 if not force:
3205 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003206 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003207 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003208 if not hasSheBang(dst):
3209 DieWithError('Not a script: %s\n'
3210 'You need to download from\n%s\n'
3211 'into .git/hooks/commit-msg and '
3212 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003213 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
3214 except Exception:
3215 if os.path.exists(dst):
3216 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003217 DieWithError('\nFailed to download hooks.\n'
3218 'You need to download from\n%s\n'
3219 'into .git/hooks/commit-msg and '
3220 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003221
3222
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003223class _GitCookiesChecker(object):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003224 """Provides facilities for validating and suggesting fixes to .gitcookies."""
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003225
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003226 _GOOGLESOURCE = 'googlesource.com'
3227
3228 def __init__(self):
3229 # Cached list of [host, identity, source], where source is either
3230 # .gitcookies or .netrc.
3231 self._all_hosts = None
3232
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003233 def ensure_configured_gitcookies(self):
3234 """Runs checks and suggests fixes to make git use .gitcookies from default
3235 path."""
3236 default = gerrit_util.CookiesAuthenticator.get_gitcookies_path()
3237 configured_path = RunGitSilent(
3238 ['config', '--global', 'http.cookiefile']).strip()
Andrii Shyshkalov1e250cd2017-05-10 15:39:31 +02003239 configured_path = os.path.expanduser(configured_path)
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003240 if configured_path:
3241 self._ensure_default_gitcookies_path(configured_path, default)
3242 else:
3243 self._configure_gitcookies_path(default)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003244
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003245 @staticmethod
3246 def _ensure_default_gitcookies_path(configured_path, default_path):
3247 assert configured_path
3248 if configured_path == default_path:
3249 print('git is already configured to use your .gitcookies from %s' %
3250 configured_path)
3251 return
3252
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003253 print('WARNING: You have configured custom path to .gitcookies: %s\n'
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003254 'Gerrit and other depot_tools expect .gitcookies at %s\n' %
3255 (configured_path, default_path))
3256
3257 if not os.path.exists(configured_path):
3258 print('However, your configured .gitcookies file is missing.')
3259 confirm_or_exit('Reconfigure git to use default .gitcookies?',
3260 action='reconfigure')
3261 RunGit(['config', '--global', 'http.cookiefile', default_path])
3262 return
3263
3264 if os.path.exists(default_path):
3265 print('WARNING: default .gitcookies file already exists %s' %
3266 default_path)
3267 DieWithError('Please delete %s manually and re-run git cl creds-check' %
3268 default_path)
3269
3270 confirm_or_exit('Move existing .gitcookies to default location?',
3271 action='move')
3272 shutil.move(configured_path, default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003273 RunGit(['config', '--global', 'http.cookiefile', default_path])
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003274 print('Moved and reconfigured git to use .gitcookies from %s' %
3275 default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003276
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003277 @staticmethod
3278 def _configure_gitcookies_path(default_path):
3279 netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path()
3280 if os.path.exists(netrc_path):
3281 print('You seem to be using outdated .netrc for git credentials: %s' %
3282 netrc_path)
3283 print('This tool will guide you through setting up recommended '
3284 '.gitcookies store for git credentials.\n'
3285 '\n'
3286 'IMPORTANT: If something goes wrong and you decide to go back, do:\n'
3287 ' git config --global --unset http.cookiefile\n'
3288 ' mv %s %s.backup\n\n' % (default_path, default_path))
3289 confirm_or_exit(action='setup .gitcookies')
3290 RunGit(['config', '--global', 'http.cookiefile', default_path])
3291 print('Configured git to use .gitcookies from %s' % default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003292
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003293 def get_hosts_with_creds(self, include_netrc=False):
3294 if self._all_hosts is None:
3295 a = gerrit_util.CookiesAuthenticator()
3296 self._all_hosts = [
3297 (h, u, s)
3298 for h, u, s in itertools.chain(
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003299 ((h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.items()),
3300 ((h, u, '.gitcookies') for h, (u, _) in a.gitcookies.items())
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003301 )
3302 if h.endswith(self._GOOGLESOURCE)
3303 ]
3304
3305 if include_netrc:
3306 return self._all_hosts
3307 return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc']
3308
3309 def print_current_creds(self, include_netrc=False):
3310 hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc))
3311 if not hosts:
3312 print('No Git/Gerrit credentials found')
3313 return
3314 lengths = [max(map(len, (row[i] for row in hosts))) for i in xrange(3)]
3315 header = [('Host', 'User', 'Which file'),
3316 ['=' * l for l in lengths]]
3317 for row in (header + hosts):
3318 print('\t'.join((('%%+%ds' % l) % s)
3319 for l, s in zip(lengths, row)))
3320
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003321 @staticmethod
3322 def _parse_identity(identity):
Lei Zhangd3f769a2017-12-15 15:16:14 -08003323 """Parses identity "git-<username>.domain" into <username> and domain."""
3324 # Special case: usernames that contain ".", which are generally not
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02003325 # distinguishable from sub-domains. But we do know typical domains:
3326 if identity.endswith('.chromium.org'):
3327 domain = 'chromium.org'
3328 username = identity[:-len('.chromium.org')]
3329 else:
3330 username, domain = identity.split('.', 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003331 if username.startswith('git-'):
3332 username = username[len('git-'):]
3333 return username, domain
3334
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003335 def _canonical_git_googlesource_host(self, host):
3336 """Normalizes Gerrit hosts (with '-review') to Git host."""
3337 assert host.endswith(self._GOOGLESOURCE)
3338 # Prefix doesn't include '.' at the end.
3339 prefix = host[:-(1 + len(self._GOOGLESOURCE))]
3340 if prefix.endswith('-review'):
3341 prefix = prefix[:-len('-review')]
3342 return prefix + '.' + self._GOOGLESOURCE
3343
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003344 def _canonical_gerrit_googlesource_host(self, host):
3345 git_host = self._canonical_git_googlesource_host(host)
3346 prefix = git_host.split('.', 1)[0]
3347 return prefix + '-review.' + self._GOOGLESOURCE
3348
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003349 def _get_counterpart_host(self, host):
3350 assert host.endswith(self._GOOGLESOURCE)
3351 git = self._canonical_git_googlesource_host(host)
3352 gerrit = self._canonical_gerrit_googlesource_host(git)
3353 return git if gerrit == host else gerrit
3354
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003355 def has_generic_host(self):
3356 """Returns whether generic .googlesource.com has been configured.
3357
3358 Chrome Infra recommends to use explicit ${host}.googlesource.com instead.
3359 """
3360 for host, _, _ in self.get_hosts_with_creds(include_netrc=False):
3361 if host == '.' + self._GOOGLESOURCE:
3362 return True
3363 return False
3364
3365 def _get_git_gerrit_identity_pairs(self):
3366 """Returns map from canonic host to pair of identities (Git, Gerrit).
3367
3368 One of identities might be None, meaning not configured.
3369 """
3370 host_to_identity_pairs = {}
3371 for host, identity, _ in self.get_hosts_with_creds():
3372 canonical = self._canonical_git_googlesource_host(host)
3373 pair = host_to_identity_pairs.setdefault(canonical, [None, None])
3374 idx = 0 if canonical == host else 1
3375 pair[idx] = identity
3376 return host_to_identity_pairs
3377
3378 def get_partially_configured_hosts(self):
3379 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003380 (host if i1 else self._canonical_gerrit_googlesource_host(host))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003381 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003382 if None in (i1, i2) and host != '.' + self._GOOGLESOURCE)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003383
3384 def get_conflicting_hosts(self):
3385 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003386 host
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003387 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003388 if None not in (i1, i2) and i1 != i2)
3389
3390 def get_duplicated_hosts(self):
3391 counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds())
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003392 return set(host for host, count in counters.items() if count > 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003393
3394 _EXPECTED_HOST_IDENTITY_DOMAINS = {
3395 'chromium.googlesource.com': 'chromium.org',
3396 'chrome-internal.googlesource.com': 'google.com',
3397 }
3398
3399 def get_hosts_with_wrong_identities(self):
3400 """Finds hosts which **likely** reference wrong identities.
3401
3402 Note: skips hosts which have conflicting identities for Git and Gerrit.
3403 """
3404 hosts = set()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003405 for host, expected in self._EXPECTED_HOST_IDENTITY_DOMAINS.items():
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003406 pair = self._get_git_gerrit_identity_pairs().get(host)
3407 if pair and pair[0] == pair[1]:
3408 _, domain = self._parse_identity(pair[0])
3409 if domain != expected:
3410 hosts.add(host)
3411 return hosts
3412
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003413 @staticmethod
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003414 def _format_hosts(hosts, extra_column_func=None):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003415 hosts = sorted(hosts)
3416 assert hosts
3417 if extra_column_func is None:
3418 extras = [''] * len(hosts)
3419 else:
3420 extras = [extra_column_func(host) for host in hosts]
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003421 tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras)))
3422 lines = []
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003423 for he in zip(hosts, extras):
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003424 lines.append(tmpl % he)
3425 return lines
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003426
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003427 def _find_problems(self):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003428 if self.has_generic_host():
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003429 yield ('.googlesource.com wildcard record detected',
3430 ['Chrome Infrastructure team recommends to list full host names '
3431 'explicitly.'],
3432 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003433
3434 dups = self.get_duplicated_hosts()
3435 if dups:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003436 yield ('The following hosts were defined twice',
3437 self._format_hosts(dups),
3438 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003439
3440 partial = self.get_partially_configured_hosts()
3441 if partial:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003442 yield ('Credentials should come in pairs for Git and Gerrit hosts. '
3443 'These hosts are missing',
3444 self._format_hosts(partial, lambda host: 'but %s defined' %
3445 self._get_counterpart_host(host)),
3446 partial)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003447
3448 conflicting = self.get_conflicting_hosts()
3449 if conflicting:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003450 yield ('The following Git hosts have differing credentials from their '
3451 'Gerrit counterparts',
3452 self._format_hosts(conflicting, lambda host: '%s vs %s' %
3453 tuple(self._get_git_gerrit_identity_pairs()[host])),
3454 conflicting)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003455
3456 wrong = self.get_hosts_with_wrong_identities()
3457 if wrong:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003458 yield ('These hosts likely use wrong identity',
3459 self._format_hosts(wrong, lambda host: '%s but %s recommended' %
3460 (self._get_git_gerrit_identity_pairs()[host][0],
3461 self._EXPECTED_HOST_IDENTITY_DOMAINS[host])),
3462 wrong)
3463
3464 def find_and_report_problems(self):
3465 """Returns True if there was at least one problem, else False."""
3466 found = False
3467 bad_hosts = set()
3468 for title, sublines, hosts in self._find_problems():
3469 if not found:
3470 found = True
3471 print('\n\n.gitcookies problem report:\n')
3472 bad_hosts.update(hosts or [])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003473 print(' %s%s' % (title, (':' if sublines else '')))
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003474 if sublines:
3475 print()
3476 print(' %s' % '\n '.join(sublines))
3477 print()
3478
3479 if bad_hosts:
3480 assert found
3481 print(' You can manually remove corresponding lines in your %s file and '
3482 'visit the following URLs with correct account to generate '
3483 'correct credential lines:\n' %
3484 gerrit_util.CookiesAuthenticator.get_gitcookies_path())
3485 print(' %s' % '\n '.join(sorted(set(
3486 gerrit_util.CookiesAuthenticator().get_new_password_url(
3487 self._canonical_git_googlesource_host(host))
3488 for host in bad_hosts
3489 ))))
3490 return found
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003491
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003492
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003493@metrics.collector.collect_metrics('git cl creds-check')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003494def CMDcreds_check(parser, args):
3495 """Checks credentials and suggests changes."""
3496 _, _ = parser.parse_args(args)
3497
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003498 # Code below checks .gitcookies. Abort if using something else.
3499 authn = gerrit_util.Authenticator.get()
3500 if not isinstance(authn, gerrit_util.CookiesAuthenticator):
3501 if isinstance(authn, gerrit_util.GceAuthenticator):
3502 DieWithError(
3503 'This command is not designed for GCE, are you on a bot?\n'
3504 'If you need to run this on GCE, export SKIP_GCE_AUTH_FOR_GIT=1 '
3505 'in your env.')
Aaron Gabled10ca0e2017-09-11 11:24:10 -07003506 DieWithError(
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003507 'This command is not designed for bot environment. It checks '
3508 '~/.gitcookies file not generally used on bots.')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003509
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003510 checker = _GitCookiesChecker()
3511 checker.ensure_configured_gitcookies()
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003512
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003513 print('Your .netrc and .gitcookies have credentials for these hosts:')
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003514 checker.print_current_creds(include_netrc=True)
3515
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003516 if not checker.find_and_report_problems():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003517 print('\nNo problems detected in your .gitcookies file.')
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003518 return 0
3519 return 1
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003520
3521
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003522@metrics.collector.collect_metrics('git cl baseurl')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003523def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003524 """Gets or sets base-url for this branch."""
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003525 branchref = RunGit(['symbolic-ref', 'HEAD']).strip()
3526 branch = ShortBranchName(branchref)
3527 _, args = parser.parse_args(args)
3528 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003529 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003530 return RunGit(['config', 'branch.%s.base-url' % branch],
3531 error_ok=False).strip()
3532 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003533 print('Setting base-url to %s' % args[0])
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003534 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3535 error_ok=False).strip()
3536
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003537
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003538def color_for_status(status):
3539 """Maps a Changelist status to color, for CMDstatus and other tools."""
3540 return {
Aaron Gable9ab38c62017-04-06 14:36:33 -07003541 'unsent': Fore.YELLOW,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003542 'waiting': Fore.BLUE,
3543 'reply': Fore.YELLOW,
Aaron Gable9ab38c62017-04-06 14:36:33 -07003544 'not lgtm': Fore.RED,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003545 'lgtm': Fore.GREEN,
3546 'commit': Fore.MAGENTA,
3547 'closed': Fore.CYAN,
3548 'error': Fore.WHITE,
3549 }.get(status, Fore.WHITE)
3550
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003551
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003552def get_cl_statuses(changes, fine_grained, max_processes=None):
3553 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003554
3555 If fine_grained is true, this will fetch CL statuses from the server.
3556 Otherwise, simply indicate if there's a matching url for the given branches.
3557
3558 If max_processes is specified, it is used as the maximum number of processes
3559 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3560 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003561
3562 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003563 """
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003564 if not changes:
3565 raise StopIteration()
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003566
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003567 if not fine_grained:
3568 # Fast path which doesn't involve querying codereview servers.
Aaron Gablea1bab272017-04-11 16:38:18 -07003569 # Do not use get_approving_reviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003570 for cl in changes:
3571 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003572 return
3573
3574 # First, sort out authentication issues.
3575 logging.debug('ensuring credentials exist')
3576 for cl in changes:
3577 cl.EnsureAuthenticated(force=False, refresh=True)
3578
3579 def fetch(cl):
3580 try:
3581 return (cl, cl.GetStatus())
3582 except:
3583 # See http://crbug.com/629863.
Andrii Shyshkalov98824232018-04-19 11:37:15 -07003584 logging.exception('failed to fetch status for cl %s:', cl.GetIssue())
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003585 raise
3586
3587 threads_count = len(changes)
3588 if max_processes:
3589 threads_count = max(1, min(threads_count, max_processes))
3590 logging.debug('querying %d CLs using %d threads', len(changes), threads_count)
3591
3592 pool = ThreadPool(threads_count)
3593 fetched_cls = set()
3594 try:
3595 it = pool.imap_unordered(fetch, changes).__iter__()
3596 while True:
3597 try:
3598 cl, status = it.next(timeout=5)
3599 except multiprocessing.TimeoutError:
3600 break
3601 fetched_cls.add(cl)
3602 yield cl, status
3603 finally:
3604 pool.close()
3605
3606 # Add any branches that failed to fetch.
3607 for cl in set(changes) - fetched_cls:
3608 yield (cl, 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003609
rmistry@google.com2dd99862015-06-22 12:22:18 +00003610
3611def upload_branch_deps(cl, args):
3612 """Uploads CLs of local branches that are dependents of the current branch.
3613
3614 If the local branch dependency tree looks like:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003615
3616 test1 -> test2.1 -> test3.1
3617 -> test3.2
3618 -> test2.2 -> test3.3
rmistry@google.com2dd99862015-06-22 12:22:18 +00003619
3620 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3621 run on the dependent branches in this order:
3622 test2.1, test3.1, test3.2, test2.2, test3.3
3623
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003624 Note: This function does not rebase your local dependent branches. Use it
3625 when you make a change to the parent branch that will not conflict
3626 with its dependent branches, and you would like their dependencies
3627 updated in Rietveld.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003628 """
3629 if git_common.is_dirty_git_tree('upload-branch-deps'):
3630 return 1
3631
3632 root_branch = cl.GetBranch()
3633 if root_branch is None:
3634 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3635 'Get on a branch!')
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00003636 if not cl.GetIssue():
rmistry@google.com2dd99862015-06-22 12:22:18 +00003637 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3638 'patchset dependencies without an uploaded CL.')
3639
3640 branches = RunGit(['for-each-ref',
3641 '--format=%(refname:short) %(upstream:short)',
3642 'refs/heads'])
3643 if not branches:
3644 print('No local branches found.')
3645 return 0
3646
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003647 # Create a dictionary of all local branches to the branches that are
3648 # dependent on it.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003649 tracked_to_dependents = collections.defaultdict(list)
3650 for b in branches.splitlines():
3651 tokens = b.split()
3652 if len(tokens) == 2:
3653 branch_name, tracked = tokens
3654 tracked_to_dependents[tracked].append(branch_name)
3655
vapiera7fbd5a2016-06-16 09:17:49 -07003656 print()
3657 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003658 dependents = []
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003659
rmistry@google.com2dd99862015-06-22 12:22:18 +00003660 def traverse_dependents_preorder(branch, padding=''):
3661 dependents_to_process = tracked_to_dependents.get(branch, [])
3662 padding += ' '
3663 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003664 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003665 dependents.append(dependent)
3666 traverse_dependents_preorder(dependent, padding)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003667
rmistry@google.com2dd99862015-06-22 12:22:18 +00003668 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003669 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003670
3671 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003672 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003673 return 0
3674
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01003675 confirm_or_exit('This command will checkout all dependent branches and run '
3676 '"git cl upload".', action='continue')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003677
rmistry@google.com2dd99862015-06-22 12:22:18 +00003678 # Record all dependents that failed to upload.
3679 failures = {}
3680 # Go through all dependents, checkout the branch and upload.
3681 try:
3682 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003683 print()
3684 print('--------------------------------------')
3685 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003686 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003687 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003688 try:
3689 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003690 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003691 failures[dependent_branch] = 1
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003692 except: # pylint: disable=bare-except
rmistry@google.com2dd99862015-06-22 12:22:18 +00003693 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003694 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003695 finally:
3696 # Swap back to the original root branch.
3697 RunGit(['checkout', '-q', root_branch])
3698
vapiera7fbd5a2016-06-16 09:17:49 -07003699 print()
3700 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003701 for dependent_branch in dependents:
3702 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003703 print(' %s : %s' % (dependent_branch, upload_status))
3704 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003705
3706 return 0
3707
3708
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003709@metrics.collector.collect_metrics('git cl archive')
kmarshall3bff56b2016-06-06 18:31:47 -07003710def CMDarchive(parser, args):
3711 """Archives and deletes branches associated with closed changelists."""
3712 parser.add_option(
3713 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003714 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003715 parser.add_option(
3716 '-f', '--force', action='store_true',
3717 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003718 parser.add_option(
3719 '-d', '--dry-run', action='store_true',
3720 help='Skip the branch tagging and removal steps.')
3721 parser.add_option(
3722 '-t', '--notags', action='store_true',
3723 help='Do not tag archived branches. '
3724 'Note: local commit history may be lost.')
kmarshall3bff56b2016-06-06 18:31:47 -07003725
kmarshall3bff56b2016-06-06 18:31:47 -07003726 options, args = parser.parse_args(args)
3727 if args:
3728 parser.error('Unsupported args: %s' % ' '.join(args))
kmarshall3bff56b2016-06-06 18:31:47 -07003729
3730 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3731 if not branches:
3732 return 0
3733
vapiera7fbd5a2016-06-16 09:17:49 -07003734 print('Finding all branches associated with closed issues...')
Edward Lemur934836a2019-09-09 20:16:54 +00003735 changes = [Changelist(branchref=b)
3736 for b in branches.splitlines()]
kmarshall3bff56b2016-06-06 18:31:47 -07003737 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3738 statuses = get_cl_statuses(changes,
3739 fine_grained=True,
3740 max_processes=options.maxjobs)
3741 proposal = [(cl.GetBranch(),
3742 'git-cl-archived-%s-%s' % (cl.GetIssue(), cl.GetBranch()))
3743 for cl, status in statuses
Andrii Shyshkalov51bdf8c2018-10-18 01:07:58 +00003744 if status in ('closed', 'rietveld-not-supported')]
kmarshall3bff56b2016-06-06 18:31:47 -07003745 proposal.sort()
3746
3747 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003748 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003749 return 0
3750
3751 current_branch = GetCurrentBranch()
3752
vapiera7fbd5a2016-06-16 09:17:49 -07003753 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003754 if options.notags:
3755 for next_item in proposal:
3756 print(' ' + next_item[0])
3757 else:
3758 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3759 for next_item in proposal:
3760 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003761
kmarshall9249e012016-08-23 12:02:16 -07003762 # Quit now on precondition failure or if instructed by the user, either
3763 # via an interactive prompt or by command line flags.
3764 if options.dry_run:
3765 print('\nNo changes were made (dry run).\n')
3766 return 0
3767 elif any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003768 print('You are currently on a branch \'%s\' which is associated with a '
3769 'closed codereview issue, so archive cannot proceed. Please '
3770 'checkout another branch and run this command again.' %
3771 current_branch)
3772 return 1
kmarshall9249e012016-08-23 12:02:16 -07003773 elif not options.force:
sergiyb4a5ecbe2016-06-20 09:46:00 -07003774 answer = ask_for_data('\nProceed with deletion (Y/n)? ').lower()
3775 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003776 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003777 return 1
3778
3779 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003780 if not options.notags:
3781 RunGit(['tag', tagname, branch])
kmarshall3bff56b2016-06-06 18:31:47 -07003782 RunGit(['branch', '-D', branch])
kmarshall9249e012016-08-23 12:02:16 -07003783
vapiera7fbd5a2016-06-16 09:17:49 -07003784 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003785
3786 return 0
3787
3788
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003789@metrics.collector.collect_metrics('git cl status')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003790def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003791 """Show status of changelists.
3792
3793 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003794 - Blue waiting for review
Aaron Gable9ab38c62017-04-06 14:36:33 -07003795 - Yellow waiting for you to reply to review, or not yet sent
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003796 - Green LGTM'ed
Aaron Gable9ab38c62017-04-06 14:36:33 -07003797 - Red 'not LGTM'ed
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00003798 - Magenta in the CQ
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003799 - Cyan was committed, branch can be deleted
Aaron Gable9ab38c62017-04-06 14:36:33 -07003800 - White error, or unknown status
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003801
3802 Also see 'git cl comments'.
3803 """
Alan Cuttera3be9a52019-03-04 18:50:33 +00003804 parser.add_option(
3805 '--no-branch-color',
3806 action='store_true',
3807 help='Disable colorized branch names')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003808 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003809 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003810 parser.add_option('-f', '--fast', action='store_true',
3811 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003812 parser.add_option(
3813 '-j', '--maxjobs', action='store', type=int,
3814 help='The maximum number of jobs to use when retrieving review status')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003815
iannuccie53c9352016-08-17 14:40:40 -07003816 _add_codereview_issue_select_options(
3817 parser, 'Must be in conjunction with --field.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003818 options, args = parser.parse_args(args)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003819 if args:
3820 parser.error('Unsupported args: %s' % args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003821
iannuccie53c9352016-08-17 14:40:40 -07003822 if options.issue is not None and not options.field:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003823 parser.error('--field must be specified with --issue.')
iannucci3c972b92016-08-17 13:24:10 -07003824
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003825 if options.field:
Edward Lemur934836a2019-09-09 20:16:54 +00003826 cl = Changelist(issue=options.issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003827 if options.field.startswith('desc'):
vapiera7fbd5a2016-06-16 09:17:49 -07003828 print(cl.GetDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003829 elif options.field == 'id':
3830 issueid = cl.GetIssue()
3831 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07003832 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003833 elif options.field == 'patch':
Aaron Gablee8856ee2017-12-07 12:41:46 -08003834 patchset = cl.GetMostRecentPatchset()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003835 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07003836 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07003837 elif options.field == 'status':
3838 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003839 elif options.field == 'url':
3840 url = cl.GetIssueURL()
3841 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07003842 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003843 return 0
3844
3845 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3846 if not branches:
3847 print('No local branch found.')
3848 return 0
3849
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003850 changes = [
Edward Lemur934836a2019-09-09 20:16:54 +00003851 Changelist(branchref=b)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003852 for b in branches.splitlines()]
vapiera7fbd5a2016-06-16 09:17:49 -07003853 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003854 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003855 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003856 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003857
Daniel McArdlea23bf592019-02-12 00:25:12 +00003858 current_branch = GetCurrentBranch()
3859
3860 def FormatBranchName(branch, colorize=False):
3861 """Simulates 'git branch' behavior. Colorizes and prefixes branch name with
3862 an asterisk when it is the current branch."""
3863
3864 asterisk = ""
3865 color = Fore.RESET
3866 if branch == current_branch:
3867 asterisk = "* "
3868 color = Fore.GREEN
3869 branch_name = ShortBranchName(branch)
3870
3871 if colorize:
3872 return asterisk + color + branch_name + Fore.RESET
Daniel McArdle452a49f2019-02-14 17:28:31 +00003873 return asterisk + branch_name
3874
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003875 branch_statuses = {}
Daniel McArdlea23bf592019-02-12 00:25:12 +00003876
3877 alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes))
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003878 for cl in sorted(changes, key=lambda c: c.GetBranch()):
3879 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003880 while branch not in branch_statuses:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003881 c, status = output.next()
3882 branch_statuses[c.GetBranch()] = status
3883 status = branch_statuses.pop(branch)
3884 url = cl.GetIssueURL()
3885 if url and (not status or status == 'error'):
3886 # The issue probably doesn't exist anymore.
3887 url += ' (broken)'
3888
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003889 color = color_for_status(status)
maruel@chromium.org885f6512013-07-27 02:17:26 +00003890 reset = Fore.RESET
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00003891 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00003892 color = ''
3893 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003894 status_str = '(%s)' % status if status else ''
Daniel McArdle452a49f2019-02-14 17:28:31 +00003895
Alan Cuttera3be9a52019-03-04 18:50:33 +00003896 branch_display = FormatBranchName(branch)
3897 padding = ' ' * (alignment - len(branch_display))
3898 if not options.no_branch_color:
3899 branch_display = FormatBranchName(branch, colorize=True)
Daniel McArdle452a49f2019-02-14 17:28:31 +00003900
Alan Cuttera3be9a52019-03-04 18:50:33 +00003901 print(' %s : %s%s %s%s' % (padding + branch_display, color, url,
3902 status_str, reset))
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003903
vapiera7fbd5a2016-06-16 09:17:49 -07003904 print()
Daniel McArdlea23bf592019-02-12 00:25:12 +00003905 print('Current branch: %s' % current_branch)
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003906 for cl in changes:
Daniel McArdlea23bf592019-02-12 00:25:12 +00003907 if cl.GetBranch() == current_branch:
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003908 break
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003909 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07003910 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003911 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07003912 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00003913 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07003914 print('Issue description:')
3915 print(cl.GetDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003916 return 0
3917
3918
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003919def colorize_CMDstatus_doc():
3920 """To be called once in main() to add colors to git cl status help."""
3921 colors = [i for i in dir(Fore) if i[0].isupper()]
3922
3923 def colorize_line(line):
3924 for color in colors:
3925 if color in line.upper():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003926 # Extract whitespace first and the leading '-'.
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003927 indent = len(line) - len(line.lstrip(' ')) + 1
3928 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
3929 return line
3930
3931 lines = CMDstatus.__doc__.splitlines()
3932 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
3933
3934
phajdan.jre328cf92016-08-22 04:12:17 -07003935def write_json(path, contents):
Stefan Zager1306bd02017-06-22 19:26:46 -07003936 if path == '-':
3937 json.dump(contents, sys.stdout)
3938 else:
3939 with open(path, 'w') as f:
3940 json.dump(contents, f)
phajdan.jre328cf92016-08-22 04:12:17 -07003941
3942
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003943@subcommand.usage('[issue_number]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003944@metrics.collector.collect_metrics('git cl issue')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003945def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003946 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003947
3948 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003949 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00003950 parser.add_option('-r', '--reverse', action='store_true',
3951 help='Lookup the branch(es) for the specified issues. If '
3952 'no issues are specified, all branches with mapped '
3953 'issues will be listed.')
Stefan Zager1306bd02017-06-22 19:26:46 -07003954 parser.add_option('--json',
3955 help='Path to JSON output file, or "-" for stdout.')
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00003956 _add_codereview_select_options(parser)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003957 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003958
dnj@chromium.org406c4402015-03-03 17:22:28 +00003959 if options.reverse:
3960 branches = RunGit(['for-each-ref', 'refs/heads',
Aaron Gablead64abd2017-12-04 09:49:13 -08003961 '--format=%(refname)']).splitlines()
dnj@chromium.org406c4402015-03-03 17:22:28 +00003962 # Reverse issue lookup.
3963 issue_branch_map = {}
Daniel Bratellb56a43a2018-09-06 15:49:03 +00003964
3965 git_config = {}
3966 for config in RunGit(['config', '--get-regexp',
3967 r'branch\..*issue']).splitlines():
3968 name, _space, val = config.partition(' ')
3969 git_config[name] = val
3970
dnj@chromium.org406c4402015-03-03 17:22:28 +00003971 for branch in branches:
Daniel Bratellb56a43a2018-09-06 15:49:03 +00003972 for cls in _CODEREVIEW_IMPLEMENTATIONS.values():
3973 config_key = _git_branch_config_key(ShortBranchName(branch),
3974 cls.IssueConfigKey())
3975 issue = git_config.get(config_key)
3976 if issue:
3977 issue_branch_map.setdefault(int(issue), []).append(branch)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003978 if not args:
3979 args = sorted(issue_branch_map.iterkeys())
phajdan.jre328cf92016-08-22 04:12:17 -07003980 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00003981 for issue in args:
Lei Zhang5a368d42019-03-25 23:18:19 +00003982 try:
3983 issue_num = int(issue)
3984 except ValueError:
3985 print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003986 continue
Lei Zhang5a368d42019-03-25 23:18:19 +00003987 result[issue_num] = issue_branch_map.get(issue_num)
vapiera7fbd5a2016-06-16 09:17:49 -07003988 print('Branch for issue number %s: %s' % (
Lei Zhang5a368d42019-03-25 23:18:19 +00003989 issue, ', '.join(issue_branch_map.get(issue_num) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07003990 if options.json:
3991 write_json(options.json, result)
Aaron Gable78753da2017-06-15 10:35:49 -07003992 return 0
3993
3994 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003995 issue = ParseIssueNumberArgument(args[0])
Aaron Gable78753da2017-06-15 10:35:49 -07003996 if not issue.valid:
3997 DieWithError('Pass a url or number to set the issue, 0 to unset it, '
3998 'or no argument to list it.\n'
3999 'Maybe you want to run git cl status?')
Edward Lemurf38bc172019-09-03 21:02:13 +00004000 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07004001 cl.SetIssue(issue.issue)
dnj@chromium.org406c4402015-03-03 17:22:28 +00004002 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00004003 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07004004 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
4005 if options.json:
4006 write_json(options.json, {
4007 'issue': cl.GetIssue(),
4008 'issue_url': cl.GetIssueURL(),
4009 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004010 return 0
4011
4012
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004013@metrics.collector.collect_metrics('git cl comments')
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00004014def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004015 """Shows or posts review comments for any changelist."""
4016 parser.add_option('-a', '--add-comment', dest='comment',
4017 help='comment to add to an issue')
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00004018 parser.add_option('-p', '--publish', action='store_true',
4019 help='marks CL as ready and sends comment to reviewers')
Andrii Shyshkalov0d6b46e2017-03-17 22:23:22 +01004020 parser.add_option('-i', '--issue', dest='issue',
Edward Lemurf38bc172019-09-03 21:02:13 +00004021 help='review issue id (defaults to current issue).')
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07004022 parser.add_option('-m', '--machine-readable', dest='readable',
4023 action='store_false', default=True,
4024 help='output comments in a format compatible with '
4025 'editor parsing')
smut@google.comc85ac942015-09-15 16:34:43 +00004026 parser.add_option('-j', '--json-file',
Stefan Zager1306bd02017-06-22 19:26:46 -07004027 help='File to write JSON summary to, or "-" for stdout')
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01004028 _add_codereview_select_options(parser)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004029 options, args = parser.parse_args(args)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00004030
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004031 issue = None
4032 if options.issue:
4033 try:
4034 issue = int(options.issue)
4035 except ValueError:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004036 DieWithError('A review issue ID is expected to be a number.')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004037
Edward Lemur934836a2019-09-09 20:16:54 +00004038 cl = Changelist(issue=issue)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004039
4040 if options.comment:
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00004041 cl.AddComment(options.comment, options.publish)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004042 return 0
4043
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07004044 summary = sorted(cl.GetCommentsSummary(readable=options.readable),
4045 key=lambda c: c.date)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004046 for comment in summary:
4047 if comment.disapproval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004048 color = Fore.RED
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004049 elif comment.approval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004050 color = Fore.GREEN
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004051 elif comment.sender == cl.GetIssueOwner():
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004052 color = Fore.MAGENTA
Quinten Yearsley0e617c02019-02-20 00:37:03 +00004053 elif comment.autogenerated:
4054 color = Fore.CYAN
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004055 else:
4056 color = Fore.BLUE
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004057 print('\n%s%s %s%s\n%s' % (
4058 color,
4059 comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'),
4060 comment.sender,
4061 Fore.RESET,
4062 '\n'.join(' ' + l for l in comment.message.strip().splitlines())))
4063
smut@google.comc85ac942015-09-15 16:34:43 +00004064 if options.json_file:
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004065 def pre_serialize(c):
4066 dct = c.__dict__.copy()
4067 dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f')
4068 return dct
Leszek Swirski45b20c42018-09-17 17:05:26 +00004069 write_json(options.json_file, map(pre_serialize, summary))
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00004070 return 0
4071
4072
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004073@subcommand.usage('[codereview url or issue id]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004074@metrics.collector.collect_metrics('git cl description')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004075def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004076 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00004077 parser.add_option('-d', '--display', action='store_true',
4078 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004079 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07004080 help='New description to set for this issue (- for stdin, '
4081 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07004082 parser.add_option('-f', '--force', action='store_true',
4083 help='Delete any unpublished Gerrit edits for this issue '
4084 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004085
4086 _add_codereview_select_options(parser)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004087 options, args = parser.parse_args(args)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004088
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004089 target_issue_arg = None
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004090 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00004091 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004092 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004093 parser.error('Invalid issue ID or URL.')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004094
Edward Lemur934836a2019-09-09 20:16:54 +00004095 kwargs = {}
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004096 if target_issue_arg:
4097 kwargs['issue'] = target_issue_arg.issue
4098 kwargs['codereview_host'] = target_issue_arg.hostname
martiniss6eda05f2016-06-30 10:18:35 -07004099
4100 cl = Changelist(**kwargs)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004101 if not cl.GetIssue():
4102 DieWithError('This branch has no associated changelist.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004103
Edward Lemur678a6842019-10-03 22:25:05 +00004104 if args and not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004105 logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004106
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004107 description = ChangeDescription(cl.GetDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004108
smut@google.com34fb6b12015-07-13 20:03:26 +00004109 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07004110 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00004111 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004112
4113 if options.new_description:
4114 text = options.new_description
4115 if text == '-':
4116 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07004117 elif text == '+':
4118 base_branch = cl.GetCommonAncestorWithUpstream()
4119 change = cl.GetChange(base_branch, None, local_description=True)
4120 text = change.FullDescriptionText()
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004121
4122 description.set_description(text)
4123 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00004124 description.prompt()
Andrii Shyshkalov680253d2017-03-15 21:07:36 +01004125 if cl.GetDescription().strip() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07004126 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004127 return 0
4128
4129
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004130@metrics.collector.collect_metrics('git cl lint')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004131def CMDlint(parser, args):
4132 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004133 parser.add_option('--filter', action='append', metavar='-x,+y',
4134 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004135 options, args = parser.parse_args(args)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004136
4137 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08004138 # pylint: disable=protected-access
thestig@chromium.org44202a22014-03-11 19:22:18 +00004139 try:
4140 import cpplint
4141 import cpplint_chromium
4142 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07004143 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004144 return 1
4145
4146 # Change the current working directory before calling lint so that it
4147 # shows the correct base.
4148 previous_cwd = os.getcwd()
4149 os.chdir(settings.GetRoot())
4150 try:
Edward Lemur934836a2019-09-09 20:16:54 +00004151 cl = Changelist()
thestig@chromium.org44202a22014-03-11 19:22:18 +00004152 change = cl.GetChange(cl.GetCommonAncestorWithUpstream(), None)
4153 files = [f.LocalPath() for f in change.AffectedFiles()]
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004154 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07004155 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004156 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00004157
4158 # Process cpplints arguments if any.
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004159 command = args + files
4160 if options.filter:
4161 command = ['--filter=' + ','.join(options.filter)] + command
4162 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004163
4164 white_regex = re.compile(settings.GetLintRegex())
4165 black_regex = re.compile(settings.GetLintIgnoreRegex())
4166 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
4167 for filename in filenames:
4168 if white_regex.match(filename):
4169 if black_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07004170 print('Ignoring file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004171 else:
4172 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
4173 extra_check_functions)
4174 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004175 print('Skipping file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004176 finally:
4177 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07004178 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004179 if cpplint._cpplint_state.error_count != 0:
4180 return 1
4181 return 0
4182
4183
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004184@metrics.collector.collect_metrics('git cl presubmit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004185def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004186 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004187 parser.add_option('-u', '--upload', action='store_true',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004188 help='Run upload hook instead of the push hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004189 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00004190 help='Run checks even if tree is dirty')
Aaron Gable8076c282017-11-29 14:39:41 -08004191 parser.add_option('--all', action='store_true',
4192 help='Run checks against all files, not just modified ones')
Edward Lesmes8e282792018-04-03 18:50:29 -04004193 parser.add_option('--parallel', action='store_true',
4194 help='Run all tests specified by input_api.RunTests in all '
4195 'PRESUBMIT files in parallel.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004196 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004197
sbc@chromium.org71437c02015-04-09 19:29:40 +00004198 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07004199 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004200 return 1
4201
Edward Lemur934836a2019-09-09 20:16:54 +00004202 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004203 if args:
4204 base_branch = args[0]
4205 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004206 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004207 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004208
Aaron Gable8076c282017-11-29 14:39:41 -08004209 if options.all:
4210 base_change = cl.GetChange(base_branch, None)
4211 files = [('M', f) for f in base_change.AllFiles()]
4212 change = presubmit_support.GitChange(
4213 base_change.Name(),
4214 base_change.FullDescriptionText(),
4215 base_change.RepositoryRoot(),
4216 files,
4217 base_change.issue,
4218 base_change.patchset,
4219 base_change.author_email,
4220 base_change._upstream)
4221 else:
4222 change = cl.GetChange(base_branch, None)
4223
ilevy@chromium.org051ad0e2013-03-04 21:57:34 +00004224 cl.RunHook(
4225 committing=not options.upload,
4226 may_prompt=False,
4227 verbose=options.verbose,
Edward Lesmes8e282792018-04-03 18:50:29 -04004228 change=change,
4229 parallel=options.parallel)
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00004230 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004231
4232
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004233def GenerateGerritChangeId(message):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004234 """Returns the Change ID footer value (Ixxxxxx...xxx).
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004235
4236 Works the same way as
4237 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
4238 but can be called on demand on all platforms.
4239
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004240 The basic idea is to generate git hash of a state of the tree, original
4241 commit message, author/committer info and timestamps.
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004242 """
4243 lines = []
4244 tree_hash = RunGitSilent(['write-tree'])
4245 lines.append('tree %s' % tree_hash.strip())
4246 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
4247 if code == 0:
4248 lines.append('parent %s' % parent.strip())
4249 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
4250 lines.append('author %s' % author.strip())
4251 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
4252 lines.append('committer %s' % committer.strip())
4253 lines.append('')
4254 # Note: Gerrit's commit-hook actually cleans message of some lines and
4255 # whitespace. This code is not doing this, but it clearly won't decrease
4256 # entropy.
4257 lines.append(message)
4258 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
Raul Tambreb946b232019-03-26 14:48:46 +00004259 stdin=('\n'.join(lines)).encode())
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004260 return 'I%s' % change_hash.strip()
4261
4262
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01004263def GetTargetRef(remote, remote_branch, target_branch):
wittman@chromium.org455dc922015-01-26 20:15:50 +00004264 """Computes the remote branch ref to use for the CL.
4265
4266 Args:
4267 remote (str): The git remote for the CL.
4268 remote_branch (str): The git remote branch for the CL.
4269 target_branch (str): The target branch specified by the user.
wittman@chromium.org455dc922015-01-26 20:15:50 +00004270 """
4271 if not (remote and remote_branch):
4272 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004273
wittman@chromium.org455dc922015-01-26 20:15:50 +00004274 if target_branch:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004275 # Canonicalize branch references to the equivalent local full symbolic
wittman@chromium.org455dc922015-01-26 20:15:50 +00004276 # refs, which are then translated into the remote full symbolic refs
4277 # below.
4278 if '/' not in target_branch:
4279 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4280 else:
4281 prefix_replacements = (
4282 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4283 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4284 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4285 )
4286 match = None
4287 for regex, replacement in prefix_replacements:
4288 match = re.search(regex, target_branch)
4289 if match:
4290 remote_branch = target_branch.replace(match.group(0), replacement)
4291 break
4292 if not match:
4293 # This is a branch path but not one we recognize; use as-is.
4294 remote_branch = target_branch
rmistry@google.comc68112d2015-03-03 12:48:06 +00004295 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
4296 # Handle the refs that need to land in different refs.
4297 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004298
wittman@chromium.org455dc922015-01-26 20:15:50 +00004299 # Create the true path to the remote branch.
4300 # Does the following translation:
4301 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
4302 # * refs/remotes/origin/master -> refs/heads/master
4303 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4304 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4305 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4306 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4307 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4308 'refs/heads/')
4309 elif remote_branch.startswith('refs/remotes/branch-heads'):
4310 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +01004311
wittman@chromium.org455dc922015-01-26 20:15:50 +00004312 return remote_branch
4313
4314
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004315def cleanup_list(l):
4316 """Fixes a list so that comma separated items are put as individual items.
4317
4318 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4319 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4320 """
4321 items = sum((i.split(',') for i in l), [])
4322 stripped_items = (i.strip() for i in items)
4323 return sorted(filter(None, stripped_items))
4324
4325
Aaron Gable4db38df2017-11-03 14:59:07 -07004326@subcommand.usage('[flags]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004327@metrics.collector.collect_metrics('git cl upload')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004328def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004329 """Uploads the current changelist to codereview.
4330
4331 Can skip dependency patchset uploads for a branch by running:
4332 git config branch.branch_name.skip-deps-uploads True
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004333 To unset, run:
rmistry@google.com78948ed2015-07-08 23:09:57 +00004334 git config --unset branch.branch_name.skip-deps-uploads
4335 Can also set the above globally by using the --global flag.
Dominic Battre7d1c4842017-10-27 09:17:28 +02004336
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004337 If the name of the checked out branch starts with "bug-" or "fix-" followed
4338 by a bug number, this bug number is automatically populated in the CL
Dominic Battre7d1c4842017-10-27 09:17:28 +02004339 description.
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004340
4341 If subject contains text in square brackets or has "<text>: " prefix, such
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004342 text(s) is treated as Gerrit hashtags. For example, CLs with subjects:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004343 [git-cl] add support for hashtags
4344 Foo bar: implement foo
4345 will be hashtagged with "git-cl" and "foo-bar" respectively.
rmistry@google.com78948ed2015-07-08 23:09:57 +00004346 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004347 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4348 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004349 parser.add_option('--bypass-watchlists', action='store_true',
4350 dest='bypass_watchlists',
4351 help='bypass watchlists auto CC-ing reviewers')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004352 parser.add_option('-f', '--force', action='store_true', dest='force',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004353 help="force yes to questions (don't prompt)")
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004354 parser.add_option('--message', '-m', dest='message',
4355 help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004356 parser.add_option('-b', '--bug',
4357 help='pre-populate the bug number(s) for this issue. '
4358 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004359 parser.add_option('--message-file', dest='message_file',
4360 help='file which contains message for patchset')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004361 parser.add_option('--title', '-t', dest='title',
4362 help='title for patchset')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004363 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004364 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004365 help='reviewer email addresses')
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004366 parser.add_option('--tbrs',
4367 action='append', default=[],
4368 help='TBR email addresses')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004369 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004370 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004371 help='cc email addresses')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004372 parser.add_option('--hashtag', dest='hashtags',
4373 action='append', default=[],
4374 help=('Gerrit hashtag for new CL; '
4375 'can be applied multiple times'))
adamk@chromium.org36f47302013-04-05 01:08:31 +00004376 parser.add_option('-s', '--send-mail', action='store_true',
Aaron Gable59f48512017-01-12 10:54:46 -08004377 help='send email to reviewer(s) and cc(s) immediately')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004378 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004379 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004380 metavar='TARGET',
4381 help='Apply CL to remote ref TARGET. ' +
4382 'Default: remote branch head, or master')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004383 parser.add_option('--squash', action='store_true',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004384 help='Squash multiple commits into one')
Mike Frysingera989d552019-08-14 20:51:23 +00004385 parser.add_option('--no-squash', action='store_false', dest='squash',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004386 help='Don\'t squash multiple commits into one')
rmistry9eadede2016-09-19 11:22:43 -07004387 parser.add_option('--topic', default=None,
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004388 help='Topic to specify when uploading')
Robert Iannuccif2708bd2017-04-17 15:49:02 -07004389 parser.add_option('--tbr-owners', dest='add_owners_to', action='store_const',
4390 const='TBR', help='add a set of OWNERS to TBR')
4391 parser.add_option('--r-owners', dest='add_owners_to', action='store_const',
4392 const='R', help='add a set of OWNERS to R')
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004393 parser.add_option('-c', '--use-commit-queue', action='store_true',
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004394 default=False,
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004395 help='tell the CQ to commit this patchset; '
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004396 'implies --send-mail')
4397 parser.add_option('-d', '--cq-dry-run',
4398 action='store_true', default=False,
rmistry@google.comef966222015-04-07 11:15:01 +00004399 help='Send the patchset to do a CQ dry run right after '
4400 'upload.')
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00004401 parser.add_option('--preserve-tryjobs', action='store_true',
4402 help='instruct the CQ to let tryjobs running even after '
4403 'new patchsets are uploaded instead of canceling '
4404 'prior patchset\' tryjobs')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004405 parser.add_option('--dependencies', action='store_true',
4406 help='Uploads CLs of all the local branches that depend on '
4407 'the current branch')
Ravi Mistry31e7d562018-04-02 12:53:57 -04004408 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4409 help='Sends your change to the CQ after an approval. Only '
4410 'works on repos that have the Auto-Submit label '
4411 'enabled')
Edward Lesmes8e282792018-04-03 18:50:29 -04004412 parser.add_option('--parallel', action='store_true',
4413 help='Run all tests specified by input_api.RunTests in all '
4414 'PRESUBMIT files in parallel.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004415 parser.add_option('--no-autocc', action='store_true',
4416 help='Disables automatic addition of CC emails')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004417 parser.add_option('--private', action='store_true',
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004418 help='Set the review private. This implies --no-autocc.')
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004419 parser.add_option('-R', '--retry-failed', action='store_true',
4420 help='Retry failed tryjobs from old patchset immediately '
4421 'after uploading new patchset. Cannot be used with '
4422 '--use-commit-queue or --cq-dry-run.')
4423 parser.add_option('--buildbucket-host', default='cr-buildbucket.appspot.com',
4424 help='Host of buildbucket. The default host is %default.')
Dan Beamd8b04ca2019-10-10 21:23:26 +00004425 parser.add_option('--fixed', '-x',
4426 help='List of bugs that will be commented on and marked '
4427 'fixed (pre-populates "Fixed:" tag). Same format as '
4428 '-b option / "Bug:" tag. If fixing several issues, '
4429 'separate with commas.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004430
rmistry@google.com2dd99862015-06-22 12:22:18 +00004431 orig_args = args
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004432 _add_codereview_select_options(parser)
ukai@chromium.orge8077812012-02-03 03:41:46 +00004433 (options, args) = parser.parse_args(args)
4434
sbc@chromium.org71437c02015-04-09 19:29:40 +00004435 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004436 return 1
4437
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004438 options.reviewers = cleanup_list(options.reviewers)
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004439 options.tbrs = cleanup_list(options.tbrs)
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004440 options.cc = cleanup_list(options.cc)
4441
tandriib80458a2016-06-23 12:20:07 -07004442 if options.message_file:
4443 if options.message:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004444 parser.error('Only one of --message and --message-file allowed.')
tandriib80458a2016-06-23 12:20:07 -07004445 options.message = gclient_utils.FileRead(options.message_file)
4446 options.message_file = None
4447
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004448 if ([options.cq_dry_run,
4449 options.use_commit_queue,
4450 options.retry_failed].count(True) > 1):
4451 parser.error('Only one of --use-commit-queue, --cq-dry-run, or '
4452 '--retry-failed is allowed.')
tandrii4d0545a2016-07-06 03:56:49 -07004453
Aaron Gableedbc4132017-09-11 13:22:28 -07004454 if options.use_commit_queue:
4455 options.send_mail = True
4456
tandrii@chromium.org512d79c2016-03-31 12:55:28 +00004457 # For sanity of test expectations, do this otherwise lazy-loading *now*.
4458 settings.GetIsGerrit()
4459
Edward Lemur934836a2019-09-09 20:16:54 +00004460 cl = Changelist()
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004461 if options.retry_failed and not cl.GetIssue():
4462 print('No previous patchsets, so --retry-failed has no effect.')
4463 options.retry_failed = False
4464 # cl.GetMostRecentPatchset uses cached information, and can return the last
4465 # patchset before upload. Calling it here makes it clear that it's the
4466 # last patchset before upload. Note that GetMostRecentPatchset will fail
4467 # if no CL has been uploaded yet.
4468 if options.retry_failed:
4469 patchset = cl.GetMostRecentPatchset()
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00004470
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004471 ret = cl.CMDUpload(options, args, orig_args)
4472
4473 if options.retry_failed:
4474 if ret != 0:
4475 print('Upload failed, so --retry-failed has no effect.')
4476 return ret
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +00004477 builds, _ = _fetch_latest_builds(
Edward Lemur5b929a42019-10-21 17:57:39 +00004478 cl, options.buildbucket_host, latest_patchset=patchset)
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +00004479 buckets = _filter_failed_for_retry(builds)
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004480 if len(buckets) == 0:
4481 print('No failed tryjobs, so --retry-failed has no effect.')
4482 return ret
Edward Lemur5b929a42019-10-21 17:57:39 +00004483 _trigger_try_jobs(cl, buckets, options, patchset + 1)
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004484
4485 return ret
ukai@chromium.orge8077812012-02-03 03:41:46 +00004486
4487
Francois Dorayd42c6812017-05-30 15:10:20 -04004488@subcommand.usage('--description=<description file>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004489@metrics.collector.collect_metrics('git cl split')
Francois Dorayd42c6812017-05-30 15:10:20 -04004490def CMDsplit(parser, args):
4491 """Splits a branch into smaller branches and uploads CLs.
4492
4493 Creates a branch and uploads a CL for each group of files modified in the
4494 current branch that share a common OWNERS file. In the CL description and
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004495 comment, the string '$directory', is replaced with the directory containing
Francois Dorayd42c6812017-05-30 15:10:20 -04004496 the shared OWNERS file.
4497 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004498 parser.add_option('-d', '--description', dest='description_file',
4499 help='A text file containing a CL description in which '
4500 '$directory will be replaced by each CL\'s directory.')
4501 parser.add_option('-c', '--comment', dest='comment_file',
4502 help='A text file containing a CL comment.')
4503 parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true',
Chris Watkinsba28e462017-12-13 11:22:17 +11004504 default=False,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004505 help='List the files and reviewers for each CL that would '
4506 'be created, but don\'t create branches or CLs.')
4507 parser.add_option('--cq-dry-run', action='store_true',
4508 help='If set, will do a cq dry run for each uploaded CL. '
4509 'Please be careful when doing this; more than ~10 CLs '
4510 'has the potential to overload our build '
4511 'infrastructure. Try to upload these not during high '
4512 'load times (usually 11-3 Mountain View time). Email '
4513 'infra-dev@chromium.org with any questions.')
Takuto Ikuta51eca592019-02-14 19:40:52 +00004514 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4515 default=True,
4516 help='Sends your change to the CQ after an approval. Only '
4517 'works on repos that have the Auto-Submit label '
4518 'enabled')
Francois Dorayd42c6812017-05-30 15:10:20 -04004519 options, _ = parser.parse_args(args)
4520
4521 if not options.description_file:
4522 parser.error('No --description flag specified.')
4523
4524 def WrappedCMDupload(args):
4525 return CMDupload(OptionParser(), args)
4526
4527 return split_cl.SplitCl(options.description_file, options.comment_file,
Stephen Martiniscb326682018-08-29 21:06:30 +00004528 Changelist, WrappedCMDupload, options.dry_run,
Takuto Ikuta51eca592019-02-14 19:40:52 +00004529 options.cq_dry_run, options.enable_auto_submit)
Francois Dorayd42c6812017-05-30 15:10:20 -04004530
4531
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004532@subcommand.usage('DEPRECATED')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004533@metrics.collector.collect_metrics('git cl commit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004534def CMDdcommit(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004535 """DEPRECATED: Used to commit the current changelist via git-svn."""
4536 message = ('git-cl no longer supports committing to SVN repositories via '
4537 'git-svn. You probably want to use `git cl land` instead.')
4538 print(message)
4539 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004540
4541
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004542@subcommand.usage('[upstream branch to apply against]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004543@metrics.collector.collect_metrics('git cl land')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004544def CMDland(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004545 """Commits the current changelist via git.
4546
4547 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4548 upstream and closes the issue automatically and atomically.
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004549 """
4550 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4551 help='bypass upload presubmit hook')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004552 parser.add_option('-f', '--force', action='store_true', dest='force',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004553 help="force yes to questions (don't prompt)")
Edward Lesmes67b3faa2018-04-13 17:50:52 -04004554 parser.add_option('--parallel', action='store_true',
4555 help='Run all tests specified by input_api.RunTests in all '
4556 'PRESUBMIT files in parallel.')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004557 (options, args) = parser.parse_args(args)
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004558
Edward Lemur934836a2019-09-09 20:16:54 +00004559 cl = Changelist()
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004560
Robert Iannucci2e73d432018-03-14 01:10:47 -07004561 if not cl.GetIssue():
4562 DieWithError('You must upload the change first to Gerrit.\n'
4563 ' If you would rather have `git cl land` upload '
4564 'automatically for you, see http://crbug.com/642759')
Edward Lemur125d60a2019-09-13 18:25:41 +00004565 return cl.CMDLand(options.force, options.bypass_hooks,
Olivier Robin75ee7252018-04-13 10:02:56 +02004566 options.verbose, options.parallel)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004567
4568
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004569@subcommand.usage('<patch url or issue id or issue url>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004570@metrics.collector.collect_metrics('git cl patch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004571def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004572 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004573 parser.add_option('-b', dest='newbranch',
4574 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004575 parser.add_option('-f', '--force', action='store_true',
Aaron Gable62619a32017-06-16 08:22:09 -07004576 help='overwrite state on the current or chosen branch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004577 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
Edward Lemurf38bc172019-09-03 21:02:13 +00004578 help='don\'t commit after patch applies.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004579
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004580 group = optparse.OptionGroup(
4581 parser,
4582 'Options for continuing work on the current issue uploaded from a '
4583 'different clone (e.g. different machine). Must be used independently '
4584 'from the other options. No issue number should be specified, and the '
4585 'branch must have an issue number associated with it')
4586 group.add_option('--reapply', action='store_true', dest='reapply',
4587 help='Reset the branch and reapply the issue.\n'
4588 'CAUTION: This will undo any local changes in this '
4589 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004590
4591 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004592 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004593 parser.add_option_group(group)
4594
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004595 _add_codereview_select_options(parser)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004596 (options, args) = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004597
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004598 if options.reapply:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004599 if options.newbranch:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004600 parser.error('--reapply works on the current branch only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004601 if len(args) > 0:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004602 parser.error('--reapply implies no additional arguments.')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004603
Edward Lemur934836a2019-09-09 20:16:54 +00004604 cl = Changelist()
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004605 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004606 parser.error('Current branch must have an associated issue.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004607
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004608 upstream = cl.GetUpstreamBranch()
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004609 if upstream is None:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004610 parser.error('No upstream branch specified. Cannot reset branch.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004611
4612 RunGit(['reset', '--hard', upstream])
4613 if options.pull:
4614 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004615
Edward Lemur678a6842019-10-03 22:25:05 +00004616 target_issue_arg = ParseIssueNumberArgument(cl.GetIssue())
4617 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, False)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004618
4619 if len(args) != 1 or not args[0]:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004620 parser.error('Must specify issue number or URL.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004621
Edward Lemurf38bc172019-09-03 21:02:13 +00004622 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004623 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004624 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004625
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004626 # We don't want uncommitted changes mixed up with the patch.
4627 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004628 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004629
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004630 if options.newbranch:
4631 if options.force:
4632 RunGit(['branch', '-D', options.newbranch],
4633 stderr=subprocess2.PIPE, error_ok=True)
4634 RunGit(['new-branch', options.newbranch])
4635
Edward Lemur678a6842019-10-03 22:25:05 +00004636 cl = Changelist(
4637 codereview_host=target_issue_arg.hostname, issue=target_issue_arg.issue)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004638
Edward Lemur678a6842019-10-03 22:25:05 +00004639 if not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004640 print('canonical issue/change URL: %s\n' % cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004641
Edward Lemurf38bc172019-09-03 21:02:13 +00004642 return cl.CMDPatchWithParsedIssue(
4643 target_issue_arg, options.nocommit, options.force)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004644
4645
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004646def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004647 """Fetches the tree status and returns either 'open', 'closed',
4648 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004649 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004650 if url:
Edward Lemurd2a5a4c2019-10-23 22:55:26 +00004651 status = urllib2.urlopen(url).read().lower()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004652 if status.find('closed') != -1 or status == '0':
4653 return 'closed'
4654 elif status.find('open') != -1 or status == '1':
4655 return 'open'
4656 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004657 return 'unset'
4658
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004659
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004660def GetTreeStatusReason():
4661 """Fetches the tree status from a json url and returns the message
4662 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004663 url = settings.GetTreeStatusUrl()
4664 json_url = urlparse.urljoin(url, '/current?format=json')
Edward Lemurd2a5a4c2019-10-23 22:55:26 +00004665 connection = urllib2.urlopen(json_url)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004666 status = json.loads(connection.read())
4667 connection.close()
4668 return status['message']
4669
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004670
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004671@metrics.collector.collect_metrics('git cl tree')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004672def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004673 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004674 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004675 status = GetTreeStatus()
4676 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004677 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004678 return 2
4679
vapiera7fbd5a2016-06-16 09:17:49 -07004680 print('The tree is %s' % status)
4681 print()
4682 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004683 if status != 'open':
4684 return 1
4685 return 0
4686
4687
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004688@metrics.collector.collect_metrics('git cl try')
maruel@chromium.org15192402012-09-06 12:38:29 +00004689def CMDtry(parser, args):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004690 """Triggers tryjobs using either Buildbucket or CQ dry run."""
4691 group = optparse.OptionGroup(parser, 'Tryjob options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004692 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004693 '-b', '--bot', action='append',
4694 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4695 'times to specify multiple builders. ex: '
4696 '"-b win_rel -b win_layout". See '
4697 'the try server waterfall for the builders name and the tests '
4698 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004699 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004700 '-B', '--bucket', default='',
4701 help=('Buildbucket bucket to send the try requests.'))
4702 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004703 '-r', '--revision',
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004704 help='Revision to use for the tryjob; default: the revision will '
tandriif7b29d42016-10-07 08:45:41 -07004705 'be determined by the try recipe that builder runs, which usually '
4706 'defaults to HEAD of origin/master')
maruel@chromium.org15192402012-09-06 12:38:29 +00004707 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004708 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004709 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004710 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004711 group.add_option(
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004712 '--category', default='git_cl_try', help='Specify custom build category.')
4713 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004714 '--project',
4715 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004716 'in recipe to determine to which repository or directory to '
4717 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004718 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004719 '-p', '--property', dest='properties', action='append', default=[],
4720 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004721 'key2=value2 etc. The value will be treated as '
4722 'json if decodable, or as string otherwise. '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004723 'NOTE: using this may make your tryjob not usable for CQ, '
4724 'which will then schedule another tryjob with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004725 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004726 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4727 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004728 parser.add_option_group(group)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004729 parser.add_option(
4730 '-R', '--retry-failed', action='store_true', default=False,
4731 help='Retry failed jobs from the latest set of tryjobs. '
4732 'Not allowed with --bucket and --bot options.')
Koji Ishii31c14782018-01-08 17:17:33 +09004733 _add_codereview_issue_select_options(parser)
maruel@chromium.org15192402012-09-06 12:38:29 +00004734 options, args = parser.parse_args(args)
4735
machenbach@chromium.org45453142015-09-15 08:45:22 +00004736 # Make sure that all properties are prop=value pairs.
4737 bad_params = [x for x in options.properties if '=' not in x]
4738 if bad_params:
4739 parser.error('Got properties with missing "=": %s' % bad_params)
4740
maruel@chromium.org15192402012-09-06 12:38:29 +00004741 if args:
4742 parser.error('Unknown arguments: %s' % args)
4743
Edward Lemur934836a2019-09-09 20:16:54 +00004744 cl = Changelist(issue=options.issue)
maruel@chromium.org15192402012-09-06 12:38:29 +00004745 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004746 parser.error('Need to upload first.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004747
Edward Lemurf38bc172019-09-03 21:02:13 +00004748 # HACK: warm up Gerrit change detail cache to save on RPCs.
Edward Lemur125d60a2019-09-13 18:25:41 +00004749 cl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS'])
Andrii Shyshkaloveadad922017-01-26 09:38:30 +01004750
tandriie113dfd2016-10-11 10:20:12 -07004751 error_message = cl.CannotTriggerTryJobReason()
4752 if error_message:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004753 parser.error('Can\'t trigger tryjobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004754
Quinten Yearsley983111f2019-09-26 17:18:48 +00004755 if options.retry_failed:
4756 if options.bot or options.bucket:
4757 print('ERROR: The option --retry-failed is not compatible with '
4758 '-B, -b, --bucket, or --bot.', file=sys.stderr)
4759 return 1
4760 print('Searching for failed tryjobs...')
Edward Lemur5b929a42019-10-21 17:57:39 +00004761 builds, patchset = _fetch_latest_builds(cl, options.buildbucket_host)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004762 if options.verbose:
4763 print('Got %d builds in patchset #%d' % (len(builds), patchset))
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +00004764 buckets = _filter_failed_for_retry(builds)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004765 if not buckets:
4766 print('There are no failed jobs in the latest set of jobs '
4767 '(patchset #%d), doing nothing.' % patchset)
4768 return 0
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00004769 num_builders = sum(map(len, buckets.values()))
Quinten Yearsley983111f2019-09-26 17:18:48 +00004770 if num_builders > 10:
4771 confirm_or_exit('There are %d builders with failed builds.'
4772 % num_builders, action='continue')
4773 else:
4774 buckets = _get_bucket_map(cl, options, parser)
4775 if buckets and any(b.startswith('master.') for b in buckets):
4776 print('ERROR: Buildbot masters are not supported.')
4777 return 1
phajdan.jr@chromium.org8da7f272014-03-14 01:28:39 +00004778
qyearsleydd49f942016-10-28 11:57:22 -07004779 # If no bots are listed and we couldn't get a list based on PRESUBMIT files,
4780 # then we default to triggering a CQ dry run (see http://crbug.com/625697).
qyearsley1fdfcb62016-10-24 13:22:03 -07004781 if not buckets:
qyearsley1fdfcb62016-10-24 13:22:03 -07004782 if options.verbose:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07004783 print('git cl try with no bots now defaults to CQ dry run.')
4784 print('Scheduling CQ dry run on: %s' % cl.GetIssueURL())
4785 return cl.SetCQState(_CQState.DRY_RUN)
stip@chromium.org43064fd2013-12-18 20:07:44 +00004786
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00004787 for builders in buckets.values():
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00004788 if any('triggered' in b for b in builders):
vapiera7fbd5a2016-06-16 09:17:49 -07004789 print('ERROR You are trying to send a job to a triggered bot. This type '
tandriide281ae2016-10-12 06:02:30 -07004790 'of bot requires an initial job from a parent (usually a builder). '
4791 'Instead send your job to the parent.\n'
vapiera7fbd5a2016-06-16 09:17:49 -07004792 'Bot list: %s' % builders, file=sys.stderr)
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00004793 return 1
ilevy@chromium.orgf3b21232012-09-24 20:48:55 +00004794
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004795 patchset = cl.GetMostRecentPatchset()
Edward Lemur2c210a42019-09-16 23:58:35 +00004796 try:
Edward Lemur5b929a42019-10-21 17:57:39 +00004797 _trigger_try_jobs(cl, buckets, options, patchset)
Edward Lemur2c210a42019-09-16 23:58:35 +00004798 except BuildbucketResponseException as ex:
4799 print('ERROR: %s' % ex)
4800 return 1
4801 return 0
maruel@chromium.org15192402012-09-06 12:38:29 +00004802
4803
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004804@metrics.collector.collect_metrics('git cl try-results')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004805def CMDtry_results(parser, args):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004806 """Prints info about results for tryjobs associated with the current CL."""
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004807 group = optparse.OptionGroup(parser, 'Tryjob results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004808 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004809 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004810 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004811 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004812 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004813 '--color', action='store_true', default=setup_color.IS_TTY,
4814 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004815 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004816 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4817 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004818 group.add_option(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004819 '--json', help=('Path of JSON output file to write tryjob results to,'
Stefan Zager1306bd02017-06-22 19:26:46 -07004820 'or "-" for stdout.'))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004821 parser.add_option_group(group)
Stefan Zager27db3f22017-10-10 15:15:01 -07004822 _add_codereview_issue_select_options(parser)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004823 options, args = parser.parse_args(args)
4824 if args:
4825 parser.error('Unrecognized args: %s' % ' '.join(args))
4826
Edward Lemur934836a2019-09-09 20:16:54 +00004827 cl = Changelist(issue=options.issue)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004828 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004829 parser.error('Need to upload first.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004830
tandrii221ab252016-10-06 08:12:04 -07004831 patchset = options.patchset
4832 if not patchset:
4833 patchset = cl.GetMostRecentPatchset()
4834 if not patchset:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004835 parser.error('Code review host doesn\'t know about issue %s. '
tandrii221ab252016-10-06 08:12:04 -07004836 'No access to issue or wrong issue number?\n'
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004837 'Either upload first, or pass --patchset explicitly.' %
tandrii221ab252016-10-06 08:12:04 -07004838 cl.GetIssue())
4839
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004840 try:
Edward Lemur5b929a42019-10-21 17:57:39 +00004841 jobs = fetch_try_jobs(cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004842 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004843 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004844 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004845 if options.json:
Edward Lemurbaaf6be2019-10-09 18:00:44 +00004846 write_json(options.json, jobs)
qyearsley53f48a12016-09-01 10:45:13 -07004847 else:
4848 print_try_jobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004849 return 0
4850
4851
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004852@subcommand.usage('[new upstream branch]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004853@metrics.collector.collect_metrics('git cl upstream')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004854def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004855 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004856 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004857 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004858 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004859
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004860 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004861 if args:
4862 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004863 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07004864 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004865 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07004866 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004867
4868 # Clear configured merge-base, if there is one.
4869 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004870 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004871 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004872 return 0
4873
4874
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004875@metrics.collector.collect_metrics('git cl web')
thestig@chromium.org00858c82013-12-02 23:08:03 +00004876def CMDweb(parser, args):
4877 """Opens the current CL in the web browser."""
4878 _, args = parser.parse_args(args)
4879 if args:
4880 parser.error('Unrecognized args: %s' % ' '.join(args))
4881
4882 issue_url = Changelist().GetIssueURL()
4883 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07004884 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004885 return 1
4886
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004887 # Redirect I/O before invoking browser to hide its output. For example, this
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004888 # allows us to hide the "Created new window in existing browser session."
4889 # message from Chrome. Based on https://stackoverflow.com/a/2323563.
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004890 saved_stdout = os.dup(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004891 saved_stderr = os.dup(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004892 os.close(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004893 os.close(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004894 os.open(os.devnull, os.O_RDWR)
4895 try:
4896 webbrowser.open(issue_url)
4897 finally:
4898 os.dup2(saved_stdout, 1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004899 os.dup2(saved_stderr, 2)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004900 return 0
4901
4902
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004903@metrics.collector.collect_metrics('git cl set-commit')
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004904def CMDset_commit(parser, args):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004905 """Sets the commit bit to trigger the CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004906 parser.add_option('-d', '--dry-run', action='store_true',
4907 help='trigger in dry run mode')
4908 parser.add_option('-c', '--clear', action='store_true',
4909 help='stop CQ run, if any')
iannuccie53c9352016-08-17 14:40:40 -07004910 _add_codereview_issue_select_options(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004911 options, args = parser.parse_args(args)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004912 if args:
4913 parser.error('Unrecognized args: %s' % ' '.join(args))
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004914 if options.dry_run and options.clear:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004915 parser.error('Only one of --dry-run and --clear are allowed.')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004916
Edward Lemur934836a2019-09-09 20:16:54 +00004917 cl = Changelist(issue=options.issue)
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004918 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07004919 state = _CQState.NONE
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004920 elif options.dry_run:
4921 state = _CQState.DRY_RUN
4922 else:
4923 state = _CQState.COMMIT
4924 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004925 parser.error('Must upload the issue first.')
tandrii9de9ec62016-07-13 03:01:59 -07004926 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004927 return 0
4928
4929
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004930@metrics.collector.collect_metrics('git cl set-close')
groby@chromium.org411034a2013-02-26 15:12:01 +00004931def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004932 """Closes the issue."""
iannuccie53c9352016-08-17 14:40:40 -07004933 _add_codereview_issue_select_options(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004934 options, args = parser.parse_args(args)
groby@chromium.org411034a2013-02-26 15:12:01 +00004935 if args:
4936 parser.error('Unrecognized args: %s' % ' '.join(args))
Edward Lemur934836a2019-09-09 20:16:54 +00004937 cl = Changelist(issue=options.issue)
groby@chromium.org411034a2013-02-26 15:12:01 +00004938 # Ensure there actually is an issue to close.
Aaron Gable7139a4e2017-09-05 17:53:09 -07004939 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004940 DieWithError('ERROR: No issue to close.')
groby@chromium.org411034a2013-02-26 15:12:01 +00004941 cl.CloseIssue()
4942 return 0
4943
4944
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004945@metrics.collector.collect_metrics('git cl diff')
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004946def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00004947 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07004948 parser.add_option(
4949 '--stat',
4950 action='store_true',
4951 dest='stat',
4952 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004953 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004954 if args:
4955 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00004956
Edward Lemur934836a2019-09-09 20:16:54 +00004957 cl = Changelist()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004958 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004959 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004960 if not issue:
4961 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004962
Aaron Gablea718c3e2017-08-28 17:47:28 -07004963 base = cl._GitGetBranchConfigValue('last-upload-hash')
4964 if not base:
4965 base = cl._GitGetBranchConfigValue('gerritsquashhash')
4966 if not base:
4967 detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
4968 revision_info = detail['revisions'][detail['current_revision']]
4969 fetch_info = revision_info['fetch']['http']
4970 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
4971 base = 'FETCH_HEAD'
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004972
Aaron Gablea718c3e2017-08-28 17:47:28 -07004973 cmd = ['git', 'diff']
4974 if options.stat:
4975 cmd.append('--stat')
4976 cmd.append(base)
4977 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004978
4979 return 0
4980
4981
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004982@metrics.collector.collect_metrics('git cl owners')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004983def CMDowners(parser, args):
Dirk Prankebf980882017-09-02 15:08:00 -07004984 """Finds potential owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004985 parser.add_option(
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004986 '--ignore-current',
4987 action='store_true',
4988 help='Ignore the CL\'s current reviewers and start from scratch.')
4989 parser.add_option(
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004990 '--ignore-self',
4991 action='store_true',
4992 help='Do not consider CL\'s author as an owners.')
4993 parser.add_option(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004994 '--no-color',
4995 action='store_true',
4996 help='Use this option to disable color output')
Dirk Prankebf980882017-09-02 15:08:00 -07004997 parser.add_option(
4998 '--batch',
4999 action='store_true',
5000 help='Do not run interactively, just suggest some')
Yang Guo6e269a02019-06-26 11:17:02 +00005001 # TODO: Consider moving this to another command, since other
5002 # git-cl owners commands deal with owners for a given CL.
5003 parser.add_option(
5004 '--show-all',
5005 action='store_true',
5006 help='Show all owners for a particular file')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005007 options, args = parser.parse_args(args)
5008
5009 author = RunGit(['config', 'user.email']).strip() or None
5010
Edward Lemur934836a2019-09-09 20:16:54 +00005011 cl = Changelist()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005012
Yang Guo6e269a02019-06-26 11:17:02 +00005013 if options.show_all:
5014 for arg in args:
5015 base_branch = cl.GetCommonAncestorWithUpstream()
5016 change = cl.GetChange(base_branch, None)
5017 database = owners.Database(change.RepositoryRoot(), file, os.path)
5018 database.load_data_needed_for([arg])
5019 print('Owners for %s:' % arg)
5020 for owner in sorted(database.all_possible_owners([arg], None)):
5021 print(' - %s' % owner)
5022 return 0
5023
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005024 if args:
5025 if len(args) > 1:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005026 parser.error('Unknown args.')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005027 base_branch = args[0]
5028 else:
5029 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005030 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005031
5032 change = cl.GetChange(base_branch, None)
Dirk Prankebf980882017-09-02 15:08:00 -07005033 affected_files = [f.LocalPath() for f in change.AffectedFiles()]
5034
5035 if options.batch:
5036 db = owners.Database(change.RepositoryRoot(), file, os.path)
5037 print('\n'.join(db.reviewers_for(affected_files, author)))
5038 return 0
5039
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005040 return owners_finder.OwnersFinder(
Dirk Prankebf980882017-09-02 15:08:00 -07005041 affected_files,
Jochen Eisinger72606f82017-04-04 10:44:18 +02005042 change.RepositoryRoot(),
Edward Lemur707d70b2018-02-07 00:50:14 +01005043 author,
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00005044 [] if options.ignore_current else cl.GetReviewers(),
Edward Lemur707d70b2018-02-07 00:50:14 +01005045 fopen=file, os_path=os.path,
Jochen Eisingerd0573ec2017-04-13 10:55:06 +02005046 disable_color=options.no_color,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00005047 override_files=change.OriginalOwnersFiles(),
5048 ignore_author=options.ignore_self).run()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005049
5050
Aiden Bennerc08566e2018-10-03 17:52:42 +00005051def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005052 """Generates a diff command."""
5053 # Generate diff for the current branch's changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +00005054 diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff']
5055
Aiden Benner6c18a1a2018-11-23 20:18:23 +00005056 if allow_prefix:
5057 # explicitly setting --src-prefix and --dst-prefix is necessary in the
5058 # case that diff.noprefix is set in the user's git config.
5059 diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/']
5060 else:
Aiden Bennerc08566e2018-10-03 17:52:42 +00005061 diff_cmd += ['--no-prefix']
5062
5063 diff_cmd += [diff_type, upstream_commit, '--']
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005064
5065 if args:
5066 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005067 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005068 diff_cmd.append(arg)
5069 else:
5070 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005071
5072 return diff_cmd
5073
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005074
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005075def MatchingFileType(file_name, extensions):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00005076 """Returns True if the file name ends with one of the given extensions."""
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005077 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005078
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005079
enne@chromium.org555cfe42014-01-29 18:21:39 +00005080@subcommand.usage('[files or directories to diff]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005081@metrics.collector.collect_metrics('git cl format')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005082def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005083 """Runs auto-formatting tools (clang-format etc.) on the diff."""
Christopher Lamc5ba6922017-01-24 11:19:14 +11005084 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07005085 GN_EXTS = ['.gn', '.gni', '.typemap']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005086 parser.add_option('--full', action='store_true',
5087 help='Reformat the full content of all touched files')
5088 parser.add_option('--dry-run', action='store_true',
5089 help='Don\'t modify any file on disk.')
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005090 parser.add_option(
5091 '--python',
5092 action='store_true',
5093 default=None,
5094 help='Enables python formatting on all python files.')
5095 parser.add_option(
5096 '--no-python',
5097 action='store_true',
5098 dest='python',
5099 help='Disables python formatting on all python files. '
5100 'Takes precedence over --python. '
5101 'If neither --python or --no-python are set, python '
5102 'files that have a .style.yapf file in an ancestor '
5103 'directory will be formatted.')
Christopher Lamc5ba6922017-01-24 11:19:14 +11005104 parser.add_option('--js', action='store_true',
5105 help='Format javascript code with clang-format.')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00005106 parser.add_option('--diff', action='store_true',
5107 help='Print diff to stdout rather than modifying files.')
Ilya Shermane081cbe2017-08-15 17:51:04 -07005108 parser.add_option('--presubmit', action='store_true',
5109 help='Used when running the script from a presubmit.')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005110 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005111
Daniel Chengc55eecf2016-12-30 03:11:02 -08005112 # Normalize any remaining args against the current path, so paths relative to
5113 # the current directory are still resolved as expected.
5114 args = [os.path.join(os.getcwd(), arg) for arg in args]
5115
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005116 # git diff generates paths against the root of the repository. Change
5117 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005118 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005119 if rel_base_path:
5120 os.chdir(rel_base_path)
5121
digit@chromium.org29e47272013-05-17 17:01:46 +00005122 # Grab the merge-base commit, i.e. the upstream commit of the current
5123 # branch when it was created or the last time it was rebased. This is
5124 # to cover the case where the user may have called "git fetch origin",
5125 # moving the origin branch to a newer commit, but hasn't rebased yet.
5126 upstream_commit = None
5127 cl = Changelist()
5128 upstream_branch = cl.GetUpstreamBranch()
5129 if upstream_branch:
5130 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
5131 upstream_commit = upstream_commit.strip()
5132
5133 if not upstream_commit:
5134 DieWithError('Could not find base commit for this branch. '
5135 'Are you in detached state?')
5136
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005137 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5138 diff_output = RunGit(changed_files_cmd)
5139 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005140 # Filter out files deleted by this CL
5141 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005142
Christopher Lamc5ba6922017-01-24 11:19:14 +11005143 if opts.js:
Deepanjan Roy605dd312018-07-02 17:48:54 +00005144 CLANG_EXTS.extend(['.js', '.ts'])
Christopher Lamc5ba6922017-01-24 11:19:14 +11005145
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005146 clang_diff_files = [x for x in diff_files if MatchingFileType(x, CLANG_EXTS)]
5147 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
5148 dart_diff_files = [x for x in diff_files if MatchingFileType(x, ['.dart'])]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005149 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005150
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005151 top_dir = os.path.normpath(
5152 RunGit(["rev-parse", "--show-toplevel"]).rstrip('\n'))
5153
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005154 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
5155 # formatted. This is used to block during the presubmit.
5156 return_value = 0
5157
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005158 if clang_diff_files:
techtonik@gmail.com5573df12016-04-12 18:34:10 +00005159 # Locate the clang-format binary in the checkout
5160 try:
5161 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
vapierfd77ac72016-06-16 08:33:57 -07005162 except clang_format.NotFoundError as e:
techtonik@gmail.com5573df12016-04-12 18:34:10 +00005163 DieWithError(e)
5164
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005165 if opts.full:
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005166 cmd = [clang_format_tool]
5167 if not opts.dry_run and not opts.diff:
5168 cmd.append('-i')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005169 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005170 if opts.diff:
5171 sys.stdout.write(stdout)
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005172 else:
5173 env = os.environ.copy()
5174 env['PATH'] = str(os.path.dirname(clang_format_tool))
5175 try:
5176 script = clang_format.FindClangFormatScriptInChromiumTree(
5177 'clang-format-diff.py')
vapierfd77ac72016-06-16 08:33:57 -07005178 except clang_format.NotFoundError as e:
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005179 DieWithError(e)
digit@chromium.orgd6ddc1c2013-10-25 15:36:32 +00005180
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005181 cmd = [sys.executable, script, '-p0']
5182 if not opts.dry_run and not opts.diff:
5183 cmd.append('-i')
digit@chromium.orgd6ddc1c2013-10-25 15:36:32 +00005184
Jamie Madill3671a6a2019-10-24 15:13:21 +00005185 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005186 diff_output = RunGit(diff_cmd)
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005187
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005188 stdout = RunCommand(cmd, stdin=diff_output, cwd=top_dir, env=env)
5189 if opts.diff:
5190 sys.stdout.write(stdout)
5191 if opts.dry_run and len(stdout) > 0:
5192 return_value = 2
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005193
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005194 # Similar code to above, but using yapf on .py files rather than clang-format
5195 # on C/C++ files
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005196 py_explicitly_disabled = opts.python is not None and not opts.python
5197 if python_diff_files and not py_explicitly_disabled:
Aiden Bennere47ac152018-11-20 16:44:03 +00005198 depot_tools_path = os.path.dirname(os.path.abspath(__file__))
5199 yapf_tool = os.path.join(depot_tools_path, 'yapf')
5200 if sys.platform.startswith('win'):
5201 yapf_tool += '.bat'
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005202
Aiden Bennerc08566e2018-10-03 17:52:42 +00005203 # If we couldn't find a yapf file we'll default to the chromium style
5204 # specified in depot_tools.
Aiden Bennerc08566e2018-10-03 17:52:42 +00005205 chromium_default_yapf_style = os.path.join(depot_tools_path,
5206 YAPF_CONFIG_FILENAME)
Aiden Bennerc08566e2018-10-03 17:52:42 +00005207 # Used for caching.
5208 yapf_configs = {}
5209 for f in python_diff_files:
5210 # Find the yapf style config for the current file, defaults to depot
5211 # tools default.
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005212 _FindYapfConfigFile(f, yapf_configs, top_dir)
5213
5214 # Turn on python formatting by default if a yapf config is specified.
5215 # This breaks in the case of this repo though since the specified
5216 # style file is also the global default.
5217 if opts.python is None:
5218 filtered_py_files = []
5219 for f in python_diff_files:
5220 if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None:
5221 filtered_py_files.append(f)
5222 else:
5223 filtered_py_files = python_diff_files
5224
5225 # Note: yapf still seems to fix indentation of the entire file
5226 # even if line ranges are specified.
5227 # See https://github.com/google/yapf/issues/499
5228 if not opts.full and filtered_py_files:
5229 py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit)
5230
Brian Sheedy59b06a82019-10-14 17:03:29 +00005231 ignored_yapf_files = _GetYapfIgnoreFilepaths(top_dir)
5232
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005233 for f in filtered_py_files:
Brian Sheedy59b06a82019-10-14 17:03:29 +00005234 if f in ignored_yapf_files:
5235 continue
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005236 yapf_config = _FindYapfConfigFile(f, yapf_configs, top_dir)
5237 if yapf_config is None:
5238 yapf_config = chromium_default_yapf_style
Aiden Bennerc08566e2018-10-03 17:52:42 +00005239
5240 cmd = [yapf_tool, '--style', yapf_config, f]
5241
5242 has_formattable_lines = False
5243 if not opts.full:
5244 # Only run yapf over changed line ranges.
5245 for diff_start, diff_len in py_line_diffs[f]:
5246 diff_end = diff_start + diff_len - 1
5247 # Yapf errors out if diff_end < diff_start but this
5248 # is a valid line range diff for a removal.
5249 if diff_end >= diff_start:
5250 has_formattable_lines = True
5251 cmd += ['-l', '{}-{}'.format(diff_start, diff_end)]
5252 # If all line diffs were removals we have nothing to format.
5253 if not has_formattable_lines:
5254 continue
5255
5256 if opts.diff or opts.dry_run:
5257 cmd += ['--diff']
5258 # Will return non-zero exit code if non-empty diff.
5259 stdout = RunCommand(cmd, error_ok=True, cwd=top_dir)
5260 if opts.diff:
5261 sys.stdout.write(stdout)
5262 elif len(stdout) > 0:
5263 return_value = 2
5264 else:
5265 cmd += ['-i']
5266 RunCommand(cmd, cwd=top_dir)
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005267
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005268 # Dart's formatter does not have the nice property of only operating on
5269 # modified chunks, so hard code full.
5270 if dart_diff_files:
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005271 try:
5272 command = [dart_format.FindDartFmtToolInChromiumTree()]
5273 if not opts.dry_run and not opts.diff:
5274 command.append('-w')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005275 command.extend(dart_diff_files)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005276
ppi@chromium.org6593d932016-03-03 15:41:15 +00005277 stdout = RunCommand(command, cwd=top_dir)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005278 if opts.dry_run and stdout:
5279 return_value = 2
5280 except dart_format.NotFoundError as e:
vapiera7fbd5a2016-06-16 09:17:49 -07005281 print('Warning: Unable to check Dart code formatting. Dart SDK not '
5282 'found in this checkout. Files in other languages are still '
5283 'formatted.')
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005284
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005285 # Format GN build files. Always run on full build files for canonical form.
5286 if gn_diff_files:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005287 cmd = ['gn', 'format']
brettw4b8ed592016-08-05 16:19:12 -07005288 if opts.dry_run or opts.diff:
5289 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005290 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005291 gn_ret = subprocess2.call(cmd + [gn_diff_file],
5292 shell=sys.platform == 'win32',
5293 cwd=top_dir)
5294 if opts.dry_run and gn_ret == 2:
5295 return_value = 2 # Not formatted.
5296 elif opts.diff and gn_ret == 2:
5297 # TODO this should compute and print the actual diff.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005298 print('This change has GN build file diff for ' + gn_diff_file)
brettw4b8ed592016-08-05 16:19:12 -07005299 elif gn_ret != 0:
5300 # For non-dry run cases (and non-2 return values for dry-run), a
5301 # nonzero error code indicates a failure, probably because the file
5302 # doesn't parse.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005303 DieWithError('gn format failed on ' + gn_diff_file +
5304 '\nTry running `gn format` on this file manually.')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005305
Ilya Shermane081cbe2017-08-15 17:51:04 -07005306 # Skip the metrics formatting from the global presubmit hook. These files have
5307 # a separate presubmit hook that issues an error if the files need formatting,
5308 # whereas the top-level presubmit script merely issues a warning. Formatting
5309 # these files is somewhat slow, so it's important not to duplicate the work.
5310 if not opts.presubmit:
5311 for xml_dir in GetDirtyMetricsDirs(diff_files):
5312 tool_dir = os.path.join(top_dir, xml_dir)
5313 cmd = [os.path.join(tool_dir, 'pretty_print.py'), '--non-interactive']
5314 if opts.dry_run or opts.diff:
5315 cmd.append('--diff')
Ilya Sherman235b70d2017-08-22 17:46:38 -07005316 stdout = RunCommand(cmd, cwd=top_dir)
Ilya Shermane081cbe2017-08-15 17:51:04 -07005317 if opts.diff:
5318 sys.stdout.write(stdout)
5319 if opts.dry_run and stdout:
5320 return_value = 2 # Not formatted.
Alexei Svitkinef3cac412017-02-06 11:08:50 -05005321
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005322 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005323
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005324
Steven Holte2e664bf2017-04-21 13:10:47 -07005325def GetDirtyMetricsDirs(diff_files):
5326 xml_diff_files = [x for x in diff_files if MatchingFileType(x, ['.xml'])]
5327 metrics_xml_dirs = [
5328 os.path.join('tools', 'metrics', 'actions'),
5329 os.path.join('tools', 'metrics', 'histograms'),
5330 os.path.join('tools', 'metrics', 'rappor'),
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005331 os.path.join('tools', 'metrics', 'ukm'),
5332 ]
Steven Holte2e664bf2017-04-21 13:10:47 -07005333 for xml_dir in metrics_xml_dirs:
5334 if any(file.startswith(xml_dir) for file in xml_diff_files):
5335 yield xml_dir
5336
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005337
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005338@subcommand.usage('<codereview url or issue id>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005339@metrics.collector.collect_metrics('git cl checkout')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005340def CMDcheckout(parser, args):
Edward Lemurf38bc172019-09-03 21:02:13 +00005341 """Checks out a branch associated with a given Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005342 _, args = parser.parse_args(args)
5343
5344 if len(args) != 1:
5345 parser.print_help()
5346 return 1
5347
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005348 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005349 if not issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005350 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02005351
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005352 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005353
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005354 def find_issues(issueprefix):
tandrii@chromium.org26c8fd22016-04-11 21:33:21 +00005355 output = RunGit(['config', '--local', '--get-regexp',
5356 r'branch\..*\.%s' % issueprefix],
5357 error_ok=True)
5358 for key, issue in [x.split() for x in output.splitlines()]:
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005359 if issue == target_issue:
5360 yield re.sub(r'branch\.(.*)\.%s' % issueprefix, r'\1', key)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005361
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005362 branches = []
5363 for cls in _CODEREVIEW_IMPLEMENTATIONS.values():
tandrii5d48c322016-08-18 16:19:37 -07005364 branches.extend(find_issues(cls.IssueConfigKey()))
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005365 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005366 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005367 return 1
5368 if len(branches) == 1:
5369 RunGit(['checkout', branches[0]])
5370 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005371 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005372 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005373 print('%d: %s' % (i, branches[i]))
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005374 which = raw_input('Choose by index: ')
5375 try:
5376 RunGit(['checkout', branches[int(which)]])
5377 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005378 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005379 return 1
5380
5381 return 0
5382
5383
maruel@chromium.org29404b52014-09-08 22:58:00 +00005384def CMDlol(parser, args):
5385 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005386 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005387 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5388 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5389 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
vapiera7fbd5a2016-06-16 09:17:49 -07005390 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005391 return 0
5392
5393
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005394class OptionParser(optparse.OptionParser):
5395 """Creates the option parse and add --verbose support."""
5396 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005397 optparse.OptionParser.__init__(
5398 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005399 self.add_option(
5400 '-v', '--verbose', action='count', default=0,
5401 help='Use 2 times for more debugging info')
5402
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005403 def parse_args(self, args=None, _values=None):
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005404 try:
5405 return self._parse_args(args)
5406 finally:
5407 # Regardless of success or failure of args parsing, we want to report
5408 # metrics, but only after logging has been initialized (if parsing
5409 # succeeded).
5410 global settings
5411 settings = Settings()
5412
5413 if not metrics.DISABLE_METRICS_COLLECTION:
5414 # GetViewVCUrl ultimately calls logging method.
5415 project_url = settings.GetViewVCUrl().strip('/+')
5416 if project_url in metrics_utils.KNOWN_PROJECT_URLS:
5417 metrics.collector.add('project_urls', [project_url])
5418
5419 def _parse_args(self, args=None):
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005420 # Create an optparse.Values object that will store only the actual passed
5421 # options, without the defaults.
5422 actual_options = optparse.Values()
5423 _, args = optparse.OptionParser.parse_args(self, args, actual_options)
5424 # Create an optparse.Values object with the default options.
5425 options = optparse.Values(self.get_default_values().__dict__)
5426 # Update it with the options passed by the user.
5427 options._update_careful(actual_options.__dict__)
5428 # Store the options passed by the user in an _actual_options attribute.
5429 # We store only the keys, and not the values, since the values can contain
5430 # arbitrary information, which might be PII.
5431 metrics.collector.add('arguments', actual_options.__dict__.keys())
5432
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005433 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
Andrii Shyshkalov5b04a572017-01-23 17:44:41 +01005434 logging.basicConfig(
5435 level=levels[min(options.verbose, len(levels) - 1)],
5436 format='[%(levelname).1s%(asctime)s %(process)d %(thread)d '
5437 '%(filename)s] %(message)s')
Edward Lemur83bd7f42018-10-10 00:14:21 +00005438
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005439 return options, args
5440
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005441
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005442def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005443 if sys.hexversion < 0x02060000:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005444 print('\nYour Python version %s is unsupported, please upgrade.\n' %
vapiera7fbd5a2016-06-16 09:17:49 -07005445 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005446 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005447
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005448 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005449 dispatcher = subcommand.CommandDispatcher(__name__)
5450 try:
5451 return dispatcher.execute(OptionParser(), argv)
Edward Lemur5b929a42019-10-21 17:57:39 +00005452 except auth.LoginRequiredError as e:
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005453 DieWithError(str(e))
Edward Lemurd2a5a4c2019-10-23 22:55:26 +00005454 except urllib2.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005455 if e.code != 500:
5456 raise
5457 DieWithError(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005458 ('App Engine is misbehaving and returned HTTP %d, again. Keep faith '
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005459 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005460 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005461
5462
5463if __name__ == '__main__':
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005464 # These affect sys.stdout, so do it outside of main() to simplify mocks in
5465 # the unit tests.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005466 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005467 setup_color.init()
Edward Lemur6f812e12018-07-31 22:45:57 +00005468 with metrics.collector.print_notice_and_exit():
sbc@chromium.org013731e2015-02-26 18:28:43 +00005469 sys.exit(main(sys.argv[1:]))