blob: 141364bc000cfff31a9fa11e338cf2be660ba963 [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
thakis@chromium.org3421c992014-11-02 02:20:32 +000012import base64
rmistry@google.com2dd99862015-06-22 12:22:18 +000013import collections
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +010014import datetime
Brian Sheedyb4307d52019-12-02 19:18:17 +000015import fnmatch
Edward Lemur202c5592019-10-21 22:44:52 +000016import httplib2
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +010017import itertools
maruel@chromium.org4f6852c2012-04-20 20:39:20 +000018import json
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000019import logging
calamity@chromium.orgcf197482016-04-29 20:15:53 +000020import multiprocessing
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000021import optparse
22import os
23import re
Andrii Shyshkalov353637c2017-03-14 16:52:18 +010024import shutil
ukai@chromium.org78c4b982012-02-14 02:20:26 +000025import stat
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000026import sys
Aaron Gable9a03ae02017-11-03 11:31:07 -070027import tempfile
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000028import textwrap
Edward Lemurfec80c42018-11-01 23:14:14 +000029import time
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000030import uuid
thestig@chromium.org00858c82013-12-02 23:08:03 +000031import webbrowser
thakis@chromium.org3421c992014-11-02 02:20:32 +000032import zlib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000033
maruel@chromium.org2e23ce32013-05-07 12:42:28 +000034from third_party import colorama
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000035import auth
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +000036import clang_format
maruel@chromium.org6f09cd92011-04-01 16:38:12 +000037import fix_encoding
maruel@chromium.org0e0436a2011-10-25 13:32:41 +000038import gclient_utils
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +000039import gerrit_util
iannucci@chromium.org9e849272014-04-04 00:31:55 +000040import git_common
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +000041import git_footers
Edward Lemur85153282020-02-14 22:06:29 +000042import git_new_branch
Edward Lemur5ba1e9c2018-07-23 18:19:02 +000043import metrics
Edward Lesmes93277a72018-10-18 22:04:26 +000044import metrics_utils
Edward Lesmeseeca9c62020-11-20 00:00:17 +000045import owners_client
iannucci@chromium.org9e849272014-04-04 00:31:55 +000046import owners_finder
Lei Zhangb8c62cf2020-07-15 20:09:37 +000047import presubmit_canned_checks
maruel@chromium.org2a74d372011-03-29 19:05:50 +000048import presubmit_support
49import scm
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +000050import setup_color
Francois Dorayd42c6812017-05-30 15:10:20 -040051import split_cl
maruel@chromium.org0633fb42013-08-16 20:06:14 +000052import subcommand
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +000053import subprocess2
maruel@chromium.org2a74d372011-03-29 19:05:50 +000054import watchlists
55
Edward Lemur79d4f992019-11-11 23:49:02 +000056from third_party import six
57from six.moves import urllib
58
59
60if sys.version_info.major == 3:
61 basestring = (str,) # pylint: disable=redefined-builtin
62
Edward Lemurb9830242019-10-30 22:19:20 +000063
tandrii7400cf02016-06-21 08:48:07 -070064__version__ = '2.0'
maruel@chromium.org2a74d372011-03-29 19:05:50 +000065
Edward Lemur0f58ae42019-04-30 17:24:12 +000066# Traces for git push will be stored in a traces directory inside the
67# depot_tools checkout.
68DEPOT_TOOLS = os.path.dirname(os.path.abspath(__file__))
69TRACES_DIR = os.path.join(DEPOT_TOOLS, 'traces')
Edward Lemur227d5102020-02-25 23:45:35 +000070PRESUBMIT_SUPPORT = os.path.join(DEPOT_TOOLS, 'presubmit_support.py')
Edward Lemur0f58ae42019-04-30 17:24:12 +000071
72# When collecting traces, Git hashes will be reduced to 6 characters to reduce
73# the size after compression.
74GIT_HASH_RE = re.compile(r'\b([a-f0-9]{6})[a-f0-9]{34}\b', flags=re.I)
75# Used to redact the cookies from the gitcookies file.
76GITCOOKIES_REDACT_RE = re.compile(r'1/.*')
77
Edward Lemurd4d1ba42019-09-20 21:46:37 +000078MAX_ATTEMPTS = 3
79
Edward Lemur1b52d872019-05-09 21:12:12 +000080# The maximum number of traces we will keep. Multiplied by 3 since we store
81# 3 files per trace.
82MAX_TRACES = 3 * 10
Edward Lemur5737f022019-05-17 01:24:00 +000083# Message to be displayed to the user to inform where to find the traces for a
84# git-cl upload execution.
Edward Lemur0f58ae42019-04-30 17:24:12 +000085TRACES_MESSAGE = (
Edward Lemur1b52d872019-05-09 21:12:12 +000086'\n'
Edward Lemur5737f022019-05-17 01:24:00 +000087'The traces of this git-cl execution have been recorded at:\n'
Edward Lemur1b52d872019-05-09 21:12:12 +000088' %(trace_name)s-traces.zip\n'
Edward Lemur5737f022019-05-17 01:24:00 +000089'Copies of your gitcookies file and git config have been recorded at:\n'
90' %(trace_name)s-git-info.zip\n')
Edward Lemur1b52d872019-05-09 21:12:12 +000091# Format of the message to be stored as part of the traces to give developers a
92# better context when they go through traces.
93TRACES_README_FORMAT = (
94'Date: %(now)s\n'
95'\n'
96'Change: https://%(gerrit_host)s/q/%(change_id)s\n'
97'Title: %(title)s\n'
98'\n'
99'%(description)s\n'
100'\n'
101'Execution time: %(execution_time)s\n'
102'Exit code: %(exit_code)s\n') + TRACES_MESSAGE
Edward Lemur0f58ae42019-04-30 17:24:12 +0000103
Aaron Gable1bc7bfe2016-12-19 10:08:14 -0800104POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land'
Henrique Ferreiroff249622019-11-28 23:19:29 +0000105DESCRIPTION_BACKUP_FILE = '.git_cl_description_backup'
rmistry@google.comc68112d2015-03-03 12:48:06 +0000106REFS_THAT_ALIAS_TO_OTHER_REFS = {
107 'refs/remotes/origin/lkgr': 'refs/remotes/origin/master',
108 'refs/remotes/origin/lkcr': 'refs/remotes/origin/master',
109}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000110
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000111DEFAULT_OLD_BRANCH = 'refs/remotes/origin/master'
112DEFAULT_NEW_BRANCH = 'refs/remotes/origin/main'
113
thestig@chromium.org44202a22014-03-11 19:22:18 +0000114# Valid extensions for files we want to lint.
115DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
116DEFAULT_LINT_IGNORE_REGEX = r"$^"
117
Aiden Bennerc08566e2018-10-03 17:52:42 +0000118# File name for yapf style config files.
119YAPF_CONFIG_FILENAME = '.style.yapf'
120
Edward Lesmes50da7702020-03-30 19:23:43 +0000121# The issue, patchset and codereview server are stored on git config for each
122# branch under branch.<branch-name>.<config-key>.
123ISSUE_CONFIG_KEY = 'gerritissue'
124PATCHSET_CONFIG_KEY = 'gerritpatchset'
125CODEREVIEW_SERVER_CONFIG_KEY = 'gerritserver'
126
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000127# Shortcut since it quickly becomes repetitive.
maruel@chromium.org2e23ce32013-05-07 12:42:28 +0000128Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +0000129
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000130# Initialized in main()
131settings = None
132
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100133# Used by tests/git_cl_test.py to add extra logging.
134# Inside the weirdly failing test, add this:
135# >>> self.mock(git_cl, '_IS_BEING_TESTED', True)
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700136# And scroll up to see the stack trace printed.
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100137_IS_BEING_TESTED = False
138
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000139
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000140_KNOWN_GERRIT_TO_SHORT_URLS = {
141 'https://chrome-internal-review.googlesource.com': 'https://crrev.com/i',
142 'https://chromium-review.googlesource.com': 'https://crrev.com/c',
143}
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000144assert len(_KNOWN_GERRIT_TO_SHORT_URLS) == len(
145 set(_KNOWN_GERRIT_TO_SHORT_URLS.values())), 'must have unique values'
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000146
147
Josip Sokcevicf736cab2020-10-20 23:41:38 +0000148class GitPushError(Exception):
149 pass
150
151
Christopher Lamf732cd52017-01-24 12:40:11 +1100152def DieWithError(message, change_desc=None):
153 if change_desc:
154 SaveDescriptionBackup(change_desc)
Josip Sokcevic953278a2020-02-28 19:46:36 +0000155 print('\n ** Content of CL description **\n' +
156 '='*72 + '\n' +
157 change_desc.description + '\n' +
158 '='*72 + '\n')
Christopher Lamf732cd52017-01-24 12:40:11 +1100159
vapiera7fbd5a2016-06-16 09:17:49 -0700160 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000161 sys.exit(1)
162
163
Christopher Lamf732cd52017-01-24 12:40:11 +1100164def SaveDescriptionBackup(change_desc):
Henrique Ferreiro5ae48172019-11-29 16:14:42 +0000165 backup_path = os.path.join(DEPOT_TOOLS, DESCRIPTION_BACKUP_FILE)
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +0000166 print('\nsaving CL description to %s\n' % backup_path)
Josip906bfde2020-01-31 22:38:49 +0000167 with open(backup_path, 'w') as backup_file:
168 backup_file.write(change_desc.description)
Christopher Lamf732cd52017-01-24 12:40:11 +1100169
170
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000171def GetNoGitPagerEnv():
172 env = os.environ.copy()
173 # 'cat' is a magical git string that disables pagers on all platforms.
174 env['GIT_PAGER'] = 'cat'
175 return env
176
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000177
bsep@chromium.org627d9002016-04-29 00:00:52 +0000178def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000179 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000180 stdout = subprocess2.check_output(args, shell=shell, **kwargs)
181 return stdout.decode('utf-8', 'replace')
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000182 except subprocess2.CalledProcessError as e:
183 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000184 if not error_ok:
Alan Cutter594fd332020-07-21 23:55:27 +0000185 message = error_message or e.stdout.decode('utf-8', 'replace') or ''
186 DieWithError('Command "%s" failed.\n%s' % (' '.join(args), message))
Edward Lemur79d4f992019-11-11 23:49:02 +0000187 return e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000188
189
190def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000191 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000192 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000193
194
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000195def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000196 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700197 if suppress_stderr:
Edward Lesmescf06cad2020-12-14 22:03:23 +0000198 stderr = subprocess2.DEVNULL
tandrii5d48c322016-08-18 16:19:37 -0700199 else:
200 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000201 try:
tandrii5d48c322016-08-18 16:19:37 -0700202 (out, _), code = subprocess2.communicate(['git'] + args,
203 env=GetNoGitPagerEnv(),
204 stdout=subprocess2.PIPE,
205 stderr=stderr)
Edward Lemur79d4f992019-11-11 23:49:02 +0000206 return code, out.decode('utf-8', 'replace')
tandrii5d48c322016-08-18 16:19:37 -0700207 except subprocess2.CalledProcessError as e:
Yoshisato Yanagisawa81e3ff52017-09-26 15:33:34 +0900208 logging.debug('Failed running %s', ['git'] + args)
Edward Lemur79d4f992019-11-11 23:49:02 +0000209 return e.returncode, e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000210
211
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000212def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000213 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000214 return RunGitWithCode(args, suppress_stderr=True)[1]
215
216
tandrii2a16b952016-10-19 07:09:44 -0700217def time_sleep(seconds):
218 # Use this so that it can be mocked in tests without interfering with python
219 # system machinery.
tandrii2a16b952016-10-19 07:09:44 -0700220 return time.sleep(seconds)
221
222
Edward Lemur01f4a4f2018-11-03 00:40:38 +0000223def time_time():
224 # Use this so that it can be mocked in tests without interfering with python
225 # system machinery.
226 return time.time()
227
228
Edward Lemur1b52d872019-05-09 21:12:12 +0000229def datetime_now():
230 # Use this so that it can be mocked in tests without interfering with python
231 # system machinery.
232 return datetime.datetime.now()
233
234
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100235def confirm_or_exit(prefix='', action='confirm'):
236 """Asks user to press enter to continue or press Ctrl+C to abort."""
237 if not prefix or prefix.endswith('\n'):
238 mid = 'Press'
Andrii Shyshkalov353637c2017-03-14 16:52:18 +0100239 elif prefix.endswith('.') or prefix.endswith('?'):
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100240 mid = ' Press'
241 elif prefix.endswith(' '):
242 mid = 'press'
243 else:
244 mid = ' press'
Edward Lesmesae3586b2020-03-23 21:21:14 +0000245 gclient_utils.AskForData(
246 '%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action))
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100247
248
249def ask_for_explicit_yes(prompt):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000250 """Returns whether user typed 'y' or 'yes' to confirm the given prompt."""
Edward Lesmesae3586b2020-03-23 21:21:14 +0000251 result = gclient_utils.AskForData(prompt + ' [Yes/No]: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100252 while True:
253 if 'yes'.startswith(result):
254 return True
255 if 'no'.startswith(result):
256 return False
Edward Lesmesae3586b2020-03-23 21:21:14 +0000257 result = gclient_utils.AskForData('Please, type yes or no: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100258
259
machenbach@chromium.org45453142015-09-15 08:45:22 +0000260def _get_properties_from_options(options):
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000261 prop_list = getattr(options, 'properties', [])
262 properties = dict(x.split('=', 1) for x in prop_list)
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000263 for key, val in properties.items():
machenbach@chromium.org45453142015-09-15 08:45:22 +0000264 try:
265 properties[key] = json.loads(val)
266 except ValueError:
267 pass # If a value couldn't be evaluated, treat it as a string.
268 return properties
269
270
Edward Lemur4c707a22019-09-24 21:13:43 +0000271def _call_buildbucket(http, buildbucket_host, method, request):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000272 """Calls a buildbucket v2 method and returns the parsed json response."""
273 headers = {
274 'Accept': 'application/json',
275 'Content-Type': 'application/json',
276 }
277 request = json.dumps(request)
278 url = 'https://%s/prpc/buildbucket.v2.Builds/%s' % (buildbucket_host, method)
279
280 logging.info('POST %s with %s' % (url, request))
281
282 attempts = 1
283 time_to_sleep = 1
284 while True:
285 response, content = http.request(url, 'POST', body=request, headers=headers)
286 if response.status == 200:
287 return json.loads(content[4:])
288 if attempts >= MAX_ATTEMPTS or 400 <= response.status < 500:
289 msg = '%s error when calling POST %s with %s: %s' % (
290 response.status, url, request, content)
291 raise BuildbucketResponseException(msg)
292 logging.debug(
293 '%s error when calling POST %s with %s. '
294 'Sleeping for %d seconds and retrying...' % (
295 response.status, url, request, time_to_sleep))
296 time.sleep(time_to_sleep)
297 time_to_sleep *= 2
298 attempts += 1
299
300 assert False, 'unreachable'
301
302
Edward Lemur6215c792019-10-03 21:59:05 +0000303def _parse_bucket(raw_bucket):
304 legacy = True
305 project = bucket = None
306 if '/' in raw_bucket:
307 legacy = False
308 project, bucket = raw_bucket.split('/', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000309 # Assume luci.<project>.<bucket>.
Edward Lemur6215c792019-10-03 21:59:05 +0000310 elif raw_bucket.startswith('luci.'):
311 project, bucket = raw_bucket[len('luci.'):].split('.', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000312 # Otherwise, assume prefix is also the project name.
Edward Lemur6215c792019-10-03 21:59:05 +0000313 elif '.' in raw_bucket:
314 project = raw_bucket.split('.')[0]
315 bucket = raw_bucket
316 # Legacy buckets.
Edward Lemur45768512020-03-02 19:03:14 +0000317 if legacy and project and bucket:
Edward Lemur6215c792019-10-03 21:59:05 +0000318 print('WARNING Please use %s/%s to specify the bucket.' % (project, bucket))
319 return project, bucket
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000320
321
Quinten Yearsley777660f2020-03-04 23:37:06 +0000322def _trigger_tryjobs(changelist, jobs, options, patchset):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000323 """Sends a request to Buildbucket to trigger tryjobs for a changelist.
qyearsley1fdfcb62016-10-24 13:22:03 -0700324
325 Args:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000326 changelist: Changelist that the tryjobs are associated with.
Edward Lemur45768512020-03-02 19:03:14 +0000327 jobs: A list of (project, bucket, builder).
qyearsley1fdfcb62016-10-24 13:22:03 -0700328 options: Command-line options.
329 """
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000330 print('Scheduling jobs on:')
Edward Lemur45768512020-03-02 19:03:14 +0000331 for project, bucket, builder in jobs:
332 print(' %s/%s: %s' % (project, bucket, builder))
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000333 print('To see results here, run: git cl try-results')
334 print('To see results in browser, run: git cl web')
tandriide281ae2016-10-12 06:02:30 -0700335
Quinten Yearsley777660f2020-03-04 23:37:06 +0000336 requests = _make_tryjob_schedule_requests(changelist, jobs, options, patchset)
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000337 if not requests:
338 return
339
Edward Lemur5b929a42019-10-21 17:57:39 +0000340 http = auth.Authenticator().authorize(httplib2.Http())
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000341 http.force_exception_to_status_code = True
342
343 batch_request = {'requests': requests}
344 batch_response = _call_buildbucket(
345 http, options.buildbucket_host, 'Batch', batch_request)
346
347 errors = [
348 ' ' + response['error']['message']
349 for response in batch_response.get('responses', [])
350 if 'error' in response
351 ]
352 if errors:
353 raise BuildbucketResponseException(
354 'Failed to schedule builds for some bots:\n%s' % '\n'.join(errors))
355
356
Quinten Yearsley777660f2020-03-04 23:37:06 +0000357def _make_tryjob_schedule_requests(changelist, jobs, options, patchset):
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000358 """Constructs requests for Buildbucket to trigger tryjobs."""
Edward Lemurf0faf482019-09-25 20:40:17 +0000359 gerrit_changes = [changelist.GetGerritChange(patchset)]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000360 shared_properties = {
361 'category': options.ensure_value('category', 'git_cl_try')
362 }
363 if options.ensure_value('clobber', False):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000364 shared_properties['clobber'] = True
365 shared_properties.update(_get_properties_from_options(options) or {})
366
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000367 shared_tags = [{'key': 'user_agent', 'value': 'git_cl_try'}]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000368 if options.ensure_value('retry_failed', False):
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000369 shared_tags.append({'key': 'retry_failed',
370 'value': '1'})
371
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000372 requests = []
Edward Lemur45768512020-03-02 19:03:14 +0000373 for (project, bucket, builder) in jobs:
374 properties = shared_properties.copy()
375 if 'presubmit' in builder.lower():
376 properties['dry_run'] = 'true'
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000377
Edward Lemur45768512020-03-02 19:03:14 +0000378 requests.append({
379 'scheduleBuild': {
380 'requestId': str(uuid.uuid4()),
381 'builder': {
382 'project': getattr(options, 'project', None) or project,
383 'bucket': bucket,
384 'builder': builder,
385 },
386 'gerritChanges': gerrit_changes,
387 'properties': properties,
388 'tags': [
389 {'key': 'builder', 'value': builder},
390 ] + shared_tags,
391 }
392 })
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000393
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000394 if options.ensure_value('revision', None):
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000395 remote, remote_branch = changelist.GetRemoteBranch()
Edward Lemur45768512020-03-02 19:03:14 +0000396 requests[-1]['scheduleBuild']['gitilesCommit'] = {
397 'host': gerrit_changes[0]['host'],
398 'project': gerrit_changes[0]['project'],
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000399 'id': options.revision,
400 'ref': GetTargetRef(remote, remote_branch, None)
Edward Lemur45768512020-03-02 19:03:14 +0000401 }
Anthony Polito1a5fe232020-01-24 23:17:52 +0000402
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000403 return requests
kjellander@chromium.org44424542015-06-02 18:35:29 +0000404
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000405
Quinten Yearsley777660f2020-03-04 23:37:06 +0000406def _fetch_tryjobs(changelist, buildbucket_host, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000407 """Fetches tryjobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000408
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000409 Returns list of buildbucket.v2.Build with the try jobs for the changelist.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000410 """
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000411 fields = ['id', 'builder', 'status', 'createTime', 'tags']
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000412 request = {
413 'predicate': {
414 'gerritChanges': [changelist.GetGerritChange(patchset)],
415 },
416 'fields': ','.join('builds.*.' + field for field in fields),
417 }
tandrii221ab252016-10-06 08:12:04 -0700418
Edward Lemur5b929a42019-10-21 17:57:39 +0000419 authenticator = auth.Authenticator()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000420 if authenticator.has_cached_credentials():
421 http = authenticator.authorize(httplib2.Http())
422 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700423 print('Warning: Some results might be missing because %s' %
424 # Get the message on how to login.
Andrii Shyshkalov2517afd2021-01-19 17:07:43 +0000425 (str(auth.LoginRequiredError()),))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000426 http = httplib2.Http()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000427 http.force_exception_to_status_code = True
428
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000429 response = _call_buildbucket(http, buildbucket_host, 'SearchBuilds', request)
430 return response.get('builds', [])
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000431
Edward Lemur45768512020-03-02 19:03:14 +0000432
Edward Lemur5b929a42019-10-21 17:57:39 +0000433def _fetch_latest_builds(changelist, buildbucket_host, latest_patchset=None):
Quinten Yearsley983111f2019-09-26 17:18:48 +0000434 """Fetches builds from the latest patchset that has builds (within
435 the last few patchsets).
436
437 Args:
Quinten Yearsley983111f2019-09-26 17:18:48 +0000438 changelist (Changelist): The CL to fetch builds for
439 buildbucket_host (str): Buildbucket host, e.g. "cr-buildbucket.appspot.com"
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000440 lastest_patchset(int|NoneType): the patchset to start fetching builds from.
441 If None (default), starts with the latest available patchset.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000442 Returns:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000443 A tuple (builds, patchset) where builds is a list of buildbucket.v2.Build,
444 and patchset is the patchset number where those builds came from.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000445 """
446 assert buildbucket_host
447 assert changelist.GetIssue(), 'CL must be uploaded first'
448 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000449 if latest_patchset is None:
450 assert changelist.GetMostRecentPatchset()
451 ps = changelist.GetMostRecentPatchset()
452 else:
453 assert latest_patchset > 0, latest_patchset
454 ps = latest_patchset
455
Quinten Yearsley983111f2019-09-26 17:18:48 +0000456 min_ps = max(1, ps - 5)
457 while ps >= min_ps:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000458 builds = _fetch_tryjobs(changelist, buildbucket_host, patchset=ps)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000459 if len(builds):
460 return builds, ps
461 ps -= 1
462 return [], 0
463
464
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000465def _filter_failed_for_retry(all_builds):
466 """Returns a list of buckets/builders that are worth retrying.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000467
468 Args:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000469 all_builds (list): Builds, in the format returned by _fetch_tryjobs,
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000470 i.e. a list of buildbucket.v2.Builds which includes status and builder
471 info.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000472
473 Returns:
Edward Lemur45768512020-03-02 19:03:14 +0000474 A dict {(proj, bucket): [builders]}. This is the same format accepted by
Quinten Yearsley777660f2020-03-04 23:37:06 +0000475 _trigger_tryjobs.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000476 """
Edward Lemur45768512020-03-02 19:03:14 +0000477 grouped = {}
478 for build in all_builds:
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000479 builder = build['builder']
Edward Lemur45768512020-03-02 19:03:14 +0000480 key = (builder['project'], builder['bucket'], builder['builder'])
481 grouped.setdefault(key, []).append(build)
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000482
Edward Lemur45768512020-03-02 19:03:14 +0000483 jobs = []
484 for (project, bucket, builder), builds in grouped.items():
485 if 'triggered' in builder:
486 print('WARNING: Not scheduling %s. Triggered bots require an initial job '
487 'from a parent. Please schedule a manual job for the parent '
488 'instead.')
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000489 continue
490 if any(b['status'] in ('STARTED', 'SCHEDULED') for b in builds):
491 # Don't retry if any are running.
492 continue
Edward Lemur45768512020-03-02 19:03:14 +0000493 # If builder had several builds, retry only if the last one failed.
494 # This is a bit different from CQ, which would re-use *any* SUCCESS-full
495 # build, but in case of retrying failed jobs retrying a flaky one makes
496 # sense.
497 builds = sorted(builds, key=lambda b: b['createTime'])
498 if builds[-1]['status'] not in ('FAILURE', 'INFRA_FAILURE'):
499 continue
500 # Don't retry experimental build previously triggered by CQ.
501 if any(t['key'] == 'cq_experimental' and t['value'] == 'true'
502 for t in builds[-1]['tags']):
503 continue
504 jobs.append((project, bucket, builder))
505
506 # Sort the jobs to make testing easier.
507 return sorted(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000508
509
Quinten Yearsley777660f2020-03-04 23:37:06 +0000510def _print_tryjobs(options, builds):
511 """Prints nicely result of _fetch_tryjobs."""
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000512 if not builds:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000513 print('No tryjobs scheduled.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000514 return
515
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000516 longest_builder = max(len(b['builder']['builder']) for b in builds)
517 name_fmt = '{builder:<%d}' % longest_builder
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000518 if options.print_master:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000519 longest_bucket = max(len(b['builder']['bucket']) for b in builds)
520 name_fmt = ('{bucket:>%d} ' % longest_bucket) + name_fmt
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000521
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000522 builds_by_status = {}
523 for b in builds:
524 builds_by_status.setdefault(b['status'], []).append({
525 'id': b['id'],
526 'name': name_fmt.format(
527 builder=b['builder']['builder'], bucket=b['builder']['bucket']),
528 })
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000529
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000530 sort_key = lambda b: (b['name'], b['id'])
531
532 def print_builds(title, builds, fmt=None, color=None):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000533 """Pop matching builds from `builds` dict and print them."""
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000534 if not builds:
535 return
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000536
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000537 fmt = fmt or '{name} https://ci.chromium.org/b/{id}'
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000538 if not options.color or color is None:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000539 colorize = lambda x: x
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000540 else:
541 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
542
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000543 print(colorize(title))
544 for b in sorted(builds, key=sort_key):
545 print(' ', colorize(fmt.format(**b)))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000546
547 total = len(builds)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000548 print_builds(
549 'Successes:', builds_by_status.pop('SUCCESS', []), color=Fore.GREEN)
550 print_builds(
551 'Infra Failures:', builds_by_status.pop('INFRA_FAILURE', []),
552 color=Fore.MAGENTA)
553 print_builds('Failures:', builds_by_status.pop('FAILURE', []), color=Fore.RED)
554 print_builds('Canceled:', builds_by_status.pop('CANCELED', []), fmt='{name}',
555 color=Fore.MAGENTA)
Andrii Shyshkalov792630c2020-10-19 16:47:44 +0000556 print_builds('Started:', builds_by_status.pop('STARTED', []),
557 color=Fore.YELLOW)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000558 print_builds(
559 'Scheduled:', builds_by_status.pop('SCHEDULED', []), fmt='{name} id={id}')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000560 # The last section is just in case buildbucket API changes OR there is a bug.
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000561 print_builds(
562 'Other:', sum(builds_by_status.values(), []), fmt='{name} id={id}')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000563 print('Total: %d tryjobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000564
565
Aiden Bennerc08566e2018-10-03 17:52:42 +0000566def _ComputeDiffLineRanges(files, upstream_commit):
567 """Gets the changed line ranges for each file since upstream_commit.
568
569 Parses a git diff on provided files and returns a dict that maps a file name
570 to an ordered list of range tuples in the form (start_line, count).
571 Ranges are in the same format as a git diff.
572 """
573 # If files is empty then diff_output will be a full diff.
574 if len(files) == 0:
575 return {}
576
Aiden Benner6c18a1a2018-11-23 20:18:23 +0000577 # Take the git diff and find the line ranges where there are changes.
Jamie Madill3671a6a2019-10-24 15:13:21 +0000578 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000579 diff_output = RunGit(diff_cmd)
580
581 pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)'
582 # 2 capture groups
583 # 0 == fname of diff file
584 # 1 == 'diff_start,diff_count' or 'diff_start'
585 # will match each of
586 # diff --git a/foo.foo b/foo.py
587 # @@ -12,2 +14,3 @@
588 # @@ -12,2 +17 @@
589 # running re.findall on the above string with pattern will give
590 # [('foo.py', ''), ('', '14,3'), ('', '17')]
591
592 curr_file = None
593 line_diffs = {}
594 for match in re.findall(pattern, diff_output, flags=re.MULTILINE):
595 if match[0] != '':
596 # Will match the second filename in diff --git a/a.py b/b.py.
597 curr_file = match[0]
598 line_diffs[curr_file] = []
599 else:
600 # Matches +14,3
601 if ',' in match[1]:
602 diff_start, diff_count = match[1].split(',')
603 else:
604 # Single line changes are of the form +12 instead of +12,1.
605 diff_start = match[1]
606 diff_count = 1
607
608 diff_start = int(diff_start)
609 diff_count = int(diff_count)
610
611 # If diff_count == 0 this is a removal we can ignore.
612 line_diffs[curr_file].append((diff_start, diff_count))
613
614 return line_diffs
615
616
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000617def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000618 """Checks if a yapf file is in any parent directory of fpath until top_dir.
619
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000620 Recursively checks parent directories to find yapf file and if no yapf file
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000621 is found returns None. Uses yapf_config_cache as a cache for previously found
622 configs.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000623 """
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000624 fpath = os.path.abspath(fpath)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000625 # Return result if we've already computed it.
626 if fpath in yapf_config_cache:
627 return yapf_config_cache[fpath]
628
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000629 parent_dir = os.path.dirname(fpath)
630 if os.path.isfile(fpath):
631 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000632 else:
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000633 # Otherwise fpath is a directory
634 yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME)
635 if os.path.isfile(yapf_file):
636 ret = yapf_file
637 elif fpath == top_dir or parent_dir == fpath:
638 # If we're at the top level directory, or if we're at root
639 # there is no provided style.
640 ret = None
641 else:
642 # Otherwise recurse on the current directory.
643 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000644 yapf_config_cache[fpath] = ret
645 return ret
646
647
Brian Sheedyb4307d52019-12-02 19:18:17 +0000648def _GetYapfIgnorePatterns(top_dir):
649 """Returns all patterns in the .yapfignore file.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000650
651 yapf is supposed to handle the ignoring of files listed in .yapfignore itself,
652 but this functionality appears to break when explicitly passing files to
653 yapf for formatting. According to
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000654 https://github.com/google/yapf/blob/HEAD/README.rst#excluding-files-from-formatting-yapfignore,
Brian Sheedy59b06a82019-10-14 17:03:29 +0000655 the .yapfignore file should be in the directory that yapf is invoked from,
656 which we assume to be the top level directory in this case.
657
658 Args:
659 top_dir: The top level directory for the repository being formatted.
660
661 Returns:
Brian Sheedyb4307d52019-12-02 19:18:17 +0000662 A set of all fnmatch patterns to be ignored.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000663 """
664 yapfignore_file = os.path.join(top_dir, '.yapfignore')
Brian Sheedyb4307d52019-12-02 19:18:17 +0000665 ignore_patterns = set()
Brian Sheedy59b06a82019-10-14 17:03:29 +0000666 if not os.path.exists(yapfignore_file):
Brian Sheedyb4307d52019-12-02 19:18:17 +0000667 return ignore_patterns
Brian Sheedy59b06a82019-10-14 17:03:29 +0000668
Brian Sheedyb4307d52019-12-02 19:18:17 +0000669 with open(yapfignore_file) as f:
670 for line in f.readlines():
671 stripped_line = line.strip()
672 # Comments and blank lines should be ignored.
673 if stripped_line.startswith('#') or stripped_line == '':
674 continue
675 ignore_patterns.add(stripped_line)
676 return ignore_patterns
677
678
679def _FilterYapfIgnoredFiles(filepaths, patterns):
680 """Filters out any filepaths that match any of the given patterns.
681
682 Args:
683 filepaths: An iterable of strings containing filepaths to filter.
684 patterns: An iterable of strings containing fnmatch patterns to filter on.
685
686 Returns:
687 A list of strings containing all the elements of |filepaths| that did not
688 match any of the patterns in |patterns|.
689 """
690 # Not inlined so that tests can use the same implementation.
691 return [f for f in filepaths
692 if not any(fnmatch.fnmatch(f, p) for p in patterns)]
Brian Sheedy59b06a82019-10-14 17:03:29 +0000693
694
Aaron Gable13101a62018-02-09 13:20:41 -0800695def print_stats(args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000696 """Prints statistics about the change to the user."""
697 # --no-ext-diff is broken in some versions of Git, so try to work around
698 # this by overriding the environment (but there is still a problem if the
699 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000700 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000701 if 'GIT_EXTERNAL_DIFF' in env:
702 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000703
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000704 return subprocess2.call(
Aaron Gable13101a62018-02-09 13:20:41 -0800705 ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args,
Edward Lemur0db01f02019-11-12 22:01:51 +0000706 env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000707
708
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000709class BuildbucketResponseException(Exception):
710 pass
711
712
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000713class Settings(object):
714 def __init__(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000715 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000716 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000717 self.tree_status_url = None
718 self.viewvc_url = None
719 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000720 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000721 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000722 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000723 self.git_editor = None
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000724 self.format_full_by_default = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000725
Edward Lemur26964072020-02-19 19:18:51 +0000726 def _LazyUpdateIfNeeded(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000727 """Updates the settings from a codereview.settings file, if available."""
Edward Lemur26964072020-02-19 19:18:51 +0000728 if self.updated:
729 return
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000730
Edward Lemur26964072020-02-19 19:18:51 +0000731 # The only value that actually changes the behavior is
732 # autoupdate = "false". Everything else means "true".
733 autoupdate = (
734 scm.GIT.GetConfig(self.GetRoot(), 'rietveld.autoupdate', '').lower())
735
736 cr_settings_file = FindCodereviewSettingsFile()
737 if autoupdate != 'false' and cr_settings_file:
738 LoadCodereviewSettingsFromFile(cr_settings_file)
739 cr_settings_file.close()
740
741 self.updated = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000742
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000743 @staticmethod
744 def GetRelativeRoot():
Edward Lesmes50da7702020-03-30 19:23:43 +0000745 return scm.GIT.GetCheckoutRoot('.')
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000746
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000747 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000748 if self.root is None:
749 self.root = os.path.abspath(self.GetRelativeRoot())
750 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000751
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000752 def GetTreeStatusUrl(self, error_ok=False):
753 if not self.tree_status_url:
Edward Lemur26964072020-02-19 19:18:51 +0000754 self.tree_status_url = self._GetConfig('rietveld.tree-status-url')
755 if self.tree_status_url is None and not error_ok:
756 DieWithError(
757 'You must configure your tree status URL by running '
758 '"git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000759 return self.tree_status_url
760
761 def GetViewVCUrl(self):
762 if not self.viewvc_url:
Edward Lemur26964072020-02-19 19:18:51 +0000763 self.viewvc_url = self._GetConfig('rietveld.viewvc-url')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000764 return self.viewvc_url
765
rmistry@google.com90752582014-01-14 21:04:50 +0000766 def GetBugPrefix(self):
Edward Lemur26964072020-02-19 19:18:51 +0000767 return self._GetConfig('rietveld.bug-prefix')
rmistry@google.com78948ed2015-07-08 23:09:57 +0000768
rmistry@google.com5626a922015-02-26 14:03:30 +0000769 def GetRunPostUploadHook(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000770 run_post_upload_hook = self._GetConfig(
Edward Lemur26964072020-02-19 19:18:51 +0000771 'rietveld.run-post-upload-hook')
rmistry@google.com5626a922015-02-26 14:03:30 +0000772 return run_post_upload_hook == "True"
773
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000774 def GetDefaultCCList(self):
Edward Lemur26964072020-02-19 19:18:51 +0000775 return self._GetConfig('rietveld.cc')
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000776
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000777 def GetSquashGerritUploads(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000778 """Returns True if uploads to Gerrit should be squashed by default."""
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000779 if self.squash_gerrit_uploads is None:
Edward Lesmes4de54132020-05-05 19:41:33 +0000780 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
781 if self.squash_gerrit_uploads is None:
Edward Lemur26964072020-02-19 19:18:51 +0000782 # Default is squash now (http://crbug.com/611892#c23).
783 self.squash_gerrit_uploads = self._GetConfig(
784 'gerrit.squash-uploads').lower() != 'false'
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000785 return self.squash_gerrit_uploads
786
Edward Lesmes4de54132020-05-05 19:41:33 +0000787 def GetSquashGerritUploadsOverride(self):
788 """Return True or False if codereview.settings should be overridden.
789
790 Returns None if no override has been defined.
791 """
792 # See also http://crbug.com/611892#c23
793 result = self._GetConfig('gerrit.override-squash-uploads').lower()
794 if result == 'true':
795 return True
796 if result == 'false':
797 return False
798 return None
799
tandrii@chromium.org28253532016-04-14 13:46:56 +0000800 def GetGerritSkipEnsureAuthenticated(self):
801 """Return True if EnsureAuthenticated should not be done for Gerrit
802 uploads."""
803 if self.gerrit_skip_ensure_authenticated is None:
Edward Lemur26964072020-02-19 19:18:51 +0000804 self.gerrit_skip_ensure_authenticated = self._GetConfig(
805 'gerrit.skip-ensure-authenticated').lower() == 'true'
tandrii@chromium.org28253532016-04-14 13:46:56 +0000806 return self.gerrit_skip_ensure_authenticated
807
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000808 def GetGitEditor(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000809 """Returns the editor specified in the git config, or None if none is."""
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000810 if self.git_editor is None:
Raul Tambre5a525872019-02-12 19:08:08 +0000811 # Git requires single quotes for paths with spaces. We need to replace
812 # them with double quotes for Windows to treat such paths as a single
813 # path.
Edward Lemur26964072020-02-19 19:18:51 +0000814 self.git_editor = self._GetConfig('core.editor').replace('\'', '"')
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000815 return self.git_editor or None
816
thestig@chromium.org44202a22014-03-11 19:22:18 +0000817 def GetLintRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000818 return self._GetConfig('rietveld.cpplint-regex', DEFAULT_LINT_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000819
820 def GetLintIgnoreRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000821 return self._GetConfig(
822 'rietveld.cpplint-ignore-regex', DEFAULT_LINT_IGNORE_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000823
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000824 def GetFormatFullByDefault(self):
825 if self.format_full_by_default is None:
826 result = (
827 RunGit(['config', '--bool', 'rietveld.format-full-by-default'],
828 error_ok=True).strip())
829 self.format_full_by_default = (result == 'true')
830 return self.format_full_by_default
831
Edward Lemur26964072020-02-19 19:18:51 +0000832 def _GetConfig(self, key, default=''):
833 self._LazyUpdateIfNeeded()
834 return scm.GIT.GetConfig(self.GetRoot(), key, default)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000835
836
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000837class _CQState(object):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +0000838 """Enum for states of CL with respect to CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000839 NONE = 'none'
840 DRY_RUN = 'dry_run'
841 COMMIT = 'commit'
842
843 ALL_STATES = [NONE, DRY_RUN, COMMIT]
844
845
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000846class _ParsedIssueNumberArgument(object):
Edward Lemurf38bc172019-09-03 21:02:13 +0000847 def __init__(self, issue=None, patchset=None, hostname=None):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000848 self.issue = issue
849 self.patchset = patchset
850 self.hostname = hostname
851
852 @property
853 def valid(self):
854 return self.issue is not None
855
856
Edward Lemurf38bc172019-09-03 21:02:13 +0000857def ParseIssueNumberArgument(arg):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000858 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
859 fail_result = _ParsedIssueNumberArgument()
860
Edward Lemur678a6842019-10-03 22:25:05 +0000861 if isinstance(arg, int):
862 return _ParsedIssueNumberArgument(issue=arg)
863 if not isinstance(arg, basestring):
864 return fail_result
865
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000866 if arg.isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +0000867 return _ParsedIssueNumberArgument(issue=int(arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000868 if not arg.startswith('http'):
869 return fail_result
Aaron Gableaee6c852017-06-26 12:49:01 -0700870
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000871 url = gclient_utils.UpgradeToHttps(arg)
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000872 for gerrit_url, short_url in _KNOWN_GERRIT_TO_SHORT_URLS.items():
873 if url.startswith(short_url):
874 url = gerrit_url + url[len(short_url):]
875 break
876
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000877 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000878 parsed_url = urllib.parse.urlparse(url)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000879 except ValueError:
880 return fail_result
Andrii Shyshkalov28d840e2017-04-10 15:45:09 +0200881
Edward Lemur678a6842019-10-03 22:25:05 +0000882 # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]]
883 # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]]
884 # Short urls like https://domain/<issue_number> can be used, but don't allow
885 # specifying the patchset (you'd 404), but we allow that here.
886 if parsed_url.path == '/':
887 part = parsed_url.fragment
888 else:
889 part = parsed_url.path
890
891 match = re.match(
892 r'(/c(/.*/\+)?)?/(?P<issue>\d+)(/(?P<patchset>\d+)?/?)?$', part)
893 if not match:
894 return fail_result
895
896 issue = int(match.group('issue'))
897 patchset = match.group('patchset')
898 return _ParsedIssueNumberArgument(
899 issue=issue,
900 patchset=int(patchset) if patchset else None,
901 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000902
903
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000904def _create_description_from_log(args):
905 """Pulls out the commit log to use as a base for the CL description."""
906 log_args = []
907 if len(args) == 1 and not args[0].endswith('.'):
908 log_args = [args[0] + '..']
909 elif len(args) == 1 and args[0].endswith('...'):
910 log_args = [args[0][:-1]]
911 elif len(args) == 2:
912 log_args = [args[0] + '..' + args[1]]
913 else:
914 log_args = args[:] # Hope for the best!
Manh Nguyene3644862020-08-05 18:25:46 +0000915 return RunGit(['log', '--pretty=format:%B%n'] + log_args)
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000916
917
Aaron Gablea45ee112016-11-22 15:14:38 -0800918class GerritChangeNotExists(Exception):
tandriic2405f52016-10-10 08:13:15 -0700919 def __init__(self, issue, url):
920 self.issue = issue
921 self.url = url
Aaron Gablea45ee112016-11-22 15:14:38 -0800922 super(GerritChangeNotExists, self).__init__()
tandriic2405f52016-10-10 08:13:15 -0700923
924 def __str__(self):
Aaron Gablea45ee112016-11-22 15:14:38 -0800925 return 'change %s at %s does not exist or you have no access to it' % (
tandriic2405f52016-10-10 08:13:15 -0700926 self.issue, self.url)
927
928
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100929_CommentSummary = collections.namedtuple(
Quinten Yearsley0e617c02019-02-20 00:37:03 +0000930 '_CommentSummary', ['date', 'message', 'sender', 'autogenerated',
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100931 # TODO(tandrii): these two aren't known in Gerrit.
932 'approval', 'disapproval'])
933
934
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000935class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000936 """Changelist works with one changelist in local branch.
937
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +0000938 Notes:
939 * Not safe for concurrent multi-{thread,process} use.
940 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -0700941 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000942 """
943
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000944 def __init__(self,
945 branchref=None,
946 issue=None,
947 codereview_host=None,
948 commit_date=None):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000949 """Create a new ChangeList instance.
950
Edward Lemurf38bc172019-09-03 21:02:13 +0000951 **kwargs will be passed directly to Gerrit implementation.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000952 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000953 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +0000954 global settings
955 if not settings:
956 # Happens when git_cl.py is used as a utility library.
957 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000958
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000959 self.branchref = branchref
960 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000961 assert branchref.startswith('refs/heads/')
Edward Lemur85153282020-02-14 22:06:29 +0000962 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000963 else:
964 self.branch = None
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000965 self.commit_date = commit_date
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000966 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +0000967 self.lookedup_issue = False
968 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000969 self.description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +0000970 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000971 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000972 self.cc = None
Daniel Cheng7227d212017-11-17 08:12:37 -0800973 self.more_cc = []
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000974 self._remote = None
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +0000975 self._cached_remote_url = (False, None) # (is_cached, value)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000976
Edward Lemur125d60a2019-09-13 18:25:41 +0000977 # Lazily cached values.
978 self._gerrit_host = None # e.g. chromium-review.googlesource.com
979 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
Edward Lesmese1576912021-02-16 21:53:34 +0000980 self._owners_client = None
Edward Lemur125d60a2019-09-13 18:25:41 +0000981 # Map from change number (issue) to its detail cache.
982 self._detail_cache = {}
983
984 if codereview_host is not None:
985 assert not codereview_host.startswith('https://'), codereview_host
986 self._gerrit_host = codereview_host
987 self._gerrit_server = 'https://%s' % codereview_host
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000988
Edward Lesmese1576912021-02-16 21:53:34 +0000989 @property
990 def owners_client(self):
991 if self._owners_client is None:
992 remote, remote_branch = self.GetRemoteBranch()
993 branch = GetTargetRef(remote, remote_branch, None)
994 self._owners_client = owners_client.GetCodeOwnersClient(
995 root=settings.GetRoot(),
996 host=self.GetGerritHost(),
997 project=self.GetGerritProject(),
998 branch=branch)
999 return self._owners_client
1000
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001001 def GetCCList(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001002 """Returns the users cc'd on this CL.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001003
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001004 The return value is a string suitable for passing to git cl with the --cc
1005 flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001006 """
1007 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001008 base_cc = settings.GetDefaultCCList()
Daniel Cheng7227d212017-11-17 08:12:37 -08001009 more_cc = ','.join(self.more_cc)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001010 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1011 return self.cc
1012
Daniel Cheng7227d212017-11-17 08:12:37 -08001013 def ExtendCC(self, more_cc):
1014 """Extends the list of users to cc on this CL based on the changed files."""
1015 self.more_cc.extend(more_cc)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001016
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00001017 def GetCommitDate(self):
1018 """Returns the commit date as provided in the constructor"""
1019 return self.commit_date
1020
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001021 def GetBranch(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001022 """Returns the short branch name, e.g. 'main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001023 if not self.branch:
Edward Lemur85153282020-02-14 22:06:29 +00001024 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001025 if not branchref:
1026 return None
1027 self.branchref = branchref
Edward Lemur85153282020-02-14 22:06:29 +00001028 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001029 return self.branch
1030
1031 def GetBranchRef(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001032 """Returns the full branch name, e.g. 'refs/heads/main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001033 self.GetBranch() # Poke the lazy loader.
1034 return self.branchref
1035
Edward Lemur85153282020-02-14 22:06:29 +00001036 def _GitGetBranchConfigValue(self, key, default=None):
1037 return scm.GIT.GetBranchConfig(
1038 settings.GetRoot(), self.GetBranch(), key, default)
tandrii5d48c322016-08-18 16:19:37 -07001039
Edward Lemur85153282020-02-14 22:06:29 +00001040 def _GitSetBranchConfigValue(self, key, value):
1041 action = 'set %s to %r' % (key, value)
1042 if not value:
1043 action = 'unset %s' % key
1044 assert self.GetBranch(), 'a branch is needed to ' + action
1045 return scm.GIT.SetBranchConfig(
1046 settings.GetRoot(), self.GetBranch(), key, value)
tandrii5d48c322016-08-18 16:19:37 -07001047
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001048 @staticmethod
1049 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001050 """Returns a tuple containing remote and remote ref,
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001051 e.g. 'origin', 'refs/heads/main'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001052 """
Edward Lemur15a9b8c2020-02-13 00:52:30 +00001053 remote, upstream_branch = scm.GIT.FetchUpstreamTuple(
1054 settings.GetRoot(), branch)
1055 if not remote or not upstream_branch:
1056 DieWithError(
1057 'Unable to determine default branch to diff against.\n'
Josip Sokcevicb038f722021-01-06 18:28:11 +00001058 'Verify this branch is set up to track another \n'
1059 '(via the --track argument to "git checkout -b ..."). \n'
1060 'or pass complete "git diff"-style arguments if supported, like\n'
1061 ' git cl upload origin/main\n')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001062
1063 return remote, upstream_branch
1064
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001065 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001066 upstream_branch = self.GetUpstreamBranch()
Edward Lesmes50da7702020-03-30 19:23:43 +00001067 if not scm.GIT.IsValidRevision(settings.GetRoot(), upstream_branch):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001068 DieWithError('The upstream for the current branch (%s) does not exist '
1069 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001070 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001071 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001072
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001073 def GetUpstreamBranch(self):
1074 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001075 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Raul Tambrefe1dbe12019-05-02 04:43:57 +00001076 if remote != '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001077 upstream_branch = upstream_branch.replace('refs/heads/',
1078 'refs/remotes/%s/' % remote)
1079 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1080 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001081 self.upstream_branch = upstream_branch
1082 return self.upstream_branch
1083
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001084 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001085 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001086 remote, branch = None, self.GetBranch()
1087 seen_branches = set()
1088 while branch not in seen_branches:
1089 seen_branches.add(branch)
1090 remote, branch = self.FetchUpstreamTuple(branch)
Edward Lemur85153282020-02-14 22:06:29 +00001091 branch = scm.GIT.ShortBranchName(branch)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001092 if remote != '.' or branch.startswith('refs/remotes'):
1093 break
1094 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001095 remotes = RunGit(['remote'], error_ok=True).split()
1096 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001097 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001098 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001099 remote = 'origin'
Gavin Make6a62332020-12-04 21:57:10 +00001100 logging.warning('Could not determine which remote this change is '
1101 'associated with, so defaulting to "%s".' %
1102 self._remote)
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001103 else:
Gavin Make6a62332020-12-04 21:57:10 +00001104 logging.warning('Could not determine which remote this change is '
1105 'associated with.')
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001106 branch = 'HEAD'
1107 if branch.startswith('refs/remotes'):
1108 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001109 elif branch.startswith('refs/branch-heads/'):
1110 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001111 else:
1112 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001113 return self._remote
1114
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001115 def GetRemoteUrl(self):
1116 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1117
1118 Returns None if there is no remote.
1119 """
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001120 is_cached, value = self._cached_remote_url
1121 if is_cached:
1122 return value
1123
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001124 remote, _ = self.GetRemoteBranch()
Edward Lemur26964072020-02-19 19:18:51 +00001125 url = scm.GIT.GetConfig(settings.GetRoot(), 'remote.%s.url' % remote, '')
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001126
Edward Lemur298f2cf2019-02-22 21:40:39 +00001127 # Check if the remote url can be parsed as an URL.
Edward Lemur79d4f992019-11-11 23:49:02 +00001128 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001129 if host:
1130 self._cached_remote_url = (True, url)
1131 return url
1132
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001133 # If it cannot be parsed as an url, assume it is a local directory,
1134 # probably a git cache.
Edward Lemur298f2cf2019-02-22 21:40:39 +00001135 logging.warning('"%s" doesn\'t appear to point to a git host. '
1136 'Interpreting it as a local directory.', url)
1137 if not os.path.isdir(url):
1138 logging.error(
Josip906bfde2020-01-31 22:38:49 +00001139 'Remote "%(remote)s" for branch "%(branch)s" points to "%(url)s", '
1140 'but it doesn\'t exist.',
1141 {'remote': remote, 'branch': self.GetBranch(), 'url': url})
Edward Lemur298f2cf2019-02-22 21:40:39 +00001142 return None
1143
1144 cache_path = url
Edward Lemur26964072020-02-19 19:18:51 +00001145 url = scm.GIT.GetConfig(url, 'remote.%s.url' % remote, '')
Edward Lemur298f2cf2019-02-22 21:40:39 +00001146
Edward Lemur79d4f992019-11-11 23:49:02 +00001147 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001148 if not host:
1149 logging.error(
1150 'Remote "%(remote)s" for branch "%(branch)s" points to '
1151 '"%(cache_path)s", but it is misconfigured.\n'
1152 '"%(cache_path)s" must be a git repo and must have a remote named '
1153 '"%(remote)s" pointing to the git host.', {
1154 'remote': remote,
1155 'cache_path': cache_path,
1156 'branch': self.GetBranch()})
1157 return None
1158
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001159 self._cached_remote_url = (True, url)
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001160 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001161
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001162 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001163 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001164 if self.issue is None and not self.lookedup_issue:
Edward Lesmes50da7702020-03-30 19:23:43 +00001165 self.issue = self._GitGetBranchConfigValue(ISSUE_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001166 if self.issue is not None:
1167 self.issue = int(self.issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001168 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001169 return self.issue
1170
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001171 def GetIssueURL(self, short=False):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001172 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001173 issue = self.GetIssue()
1174 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001175 return None
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001176 server = self.GetCodereviewServer()
1177 if short:
1178 server = _KNOWN_GERRIT_TO_SHORT_URLS.get(server, server)
1179 return '%s/%s' % (server, issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001180
Edward Lemur6c6827c2020-02-06 21:15:18 +00001181 def FetchDescription(self, pretty=False):
1182 assert self.GetIssue(), 'issue is required to query Gerrit'
1183
Edward Lemur9aa1a962020-02-25 00:58:38 +00001184 if self.description is None:
Edward Lemur6c6827c2020-02-06 21:15:18 +00001185 data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
1186 current_rev = data['current_revision']
1187 self.description = data['revisions'][current_rev]['commit']['message']
Edward Lemur6c6827c2020-02-06 21:15:18 +00001188
1189 if not pretty:
1190 return self.description
1191
1192 # Set width to 72 columns + 2 space indent.
1193 wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True)
1194 wrapper.initial_indent = wrapper.subsequent_indent = ' '
1195 lines = self.description.splitlines()
1196 return '\n'.join([wrapper.fill(line) for line in lines])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001197
1198 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001199 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001200 if self.patchset is None and not self.lookedup_patchset:
Edward Lesmes50da7702020-03-30 19:23:43 +00001201 self.patchset = self._GitGetBranchConfigValue(PATCHSET_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001202 if self.patchset is not None:
1203 self.patchset = int(self.patchset)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001204 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001205 return self.patchset
1206
Edward Lemur9aa1a962020-02-25 00:58:38 +00001207 def GetAuthor(self):
1208 return scm.GIT.GetConfig(settings.GetRoot(), 'user.email')
1209
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001210 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001211 """Set this branch's patchset. If patchset=0, clears the patchset."""
1212 assert self.GetBranch()
1213 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001214 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001215 else:
1216 self.patchset = int(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00001217 self._GitSetBranchConfigValue(PATCHSET_CONFIG_KEY, str(self.patchset))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001218
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001219 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001220 """Set this branch's issue. If issue isn't given, clears the issue."""
1221 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001222 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001223 issue = int(issue)
Edward Lesmes50da7702020-03-30 19:23:43 +00001224 self._GitSetBranchConfigValue(ISSUE_CONFIG_KEY, str(issue))
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001225 self.issue = issue
Edward Lemur125d60a2019-09-13 18:25:41 +00001226 codereview_server = self.GetCodereviewServer()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001227 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001228 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001229 CODEREVIEW_SERVER_CONFIG_KEY, codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001230 else:
tandrii5d48c322016-08-18 16:19:37 -07001231 # Reset all of these just to be clean.
1232 reset_suffixes = [
1233 'last-upload-hash',
Edward Lesmes50da7702020-03-30 19:23:43 +00001234 ISSUE_CONFIG_KEY,
1235 PATCHSET_CONFIG_KEY,
1236 CODEREVIEW_SERVER_CONFIG_KEY,
1237 'gerritsquashhash',
1238 ]
tandrii5d48c322016-08-18 16:19:37 -07001239 for prop in reset_suffixes:
Edward Lemur85153282020-02-14 22:06:29 +00001240 try:
1241 self._GitSetBranchConfigValue(prop, None)
1242 except subprocess2.CalledProcessError:
1243 pass
Aaron Gableca01e2c2017-07-19 11:16:02 -07001244 msg = RunGit(['log', '-1', '--format=%B']).strip()
1245 if msg and git_footers.get_footer_change_id(msg):
1246 print('WARNING: The change patched into this branch has a Change-Id. '
1247 'Removing it.')
1248 RunGit(['commit', '--amend', '-m',
1249 git_footers.remove_footer(msg, 'Change-Id')])
Edward Lemurf38bc172019-09-03 21:02:13 +00001250 self.lookedup_issue = True
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001251 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001252 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001253
Edward Lemur2c62b332020-03-12 22:12:33 +00001254 def GetAffectedFiles(self, upstream):
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001255 try:
Edward Lemur2c62b332020-03-12 22:12:33 +00001256 return [f for _, f in scm.GIT.CaptureStatus(settings.GetRoot(), upstream)]
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001257 except subprocess2.CalledProcessError:
1258 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001259 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001260 'This branch probably doesn\'t exist anymore. To reset the\n'
1261 'tracking branch, please run\n'
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001262 ' git branch --set-upstream-to origin/main %s\n'
1263 'or replace origin/main with the relevant branch') %
Edward Lemur2c62b332020-03-12 22:12:33 +00001264 (upstream, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001265
dsansomee2d6fd92016-09-08 00:10:47 -07001266 def UpdateDescription(self, description, force=False):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001267 assert self.GetIssue(), 'issue is required to update description'
1268
1269 if gerrit_util.HasPendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001270 self.GetGerritHost(), self._GerritChangeIdentifier()):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001271 if not force:
1272 confirm_or_exit(
1273 'The description cannot be modified while the issue has a pending '
1274 'unpublished edit. Either publish the edit in the Gerrit web UI '
1275 'or delete it.\n\n', action='delete the unpublished edit')
1276
1277 gerrit_util.DeletePendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001278 self.GetGerritHost(), self._GerritChangeIdentifier())
Edward Lemur6c6827c2020-02-06 21:15:18 +00001279 gerrit_util.SetCommitMessage(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001280 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur6c6827c2020-02-06 21:15:18 +00001281 description, notify='NONE')
1282
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001283 self.description = description
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001284
Edward Lemur75526302020-02-27 22:31:05 +00001285 def _GetCommonPresubmitArgs(self, verbose, upstream):
Edward Lemur227d5102020-02-25 23:45:35 +00001286 args = [
Edward Lemur227d5102020-02-25 23:45:35 +00001287 '--root', settings.GetRoot(),
1288 '--upstream', upstream,
1289 ]
1290
1291 args.extend(['--verbose'] * verbose)
1292
Edward Lemur99df04e2020-03-05 19:39:43 +00001293 author = self.GetAuthor()
1294 gerrit_url = self.GetCodereviewServer()
Edward Lemur227d5102020-02-25 23:45:35 +00001295 issue = self.GetIssue()
1296 patchset = self.GetPatchset()
Edward Lemur99df04e2020-03-05 19:39:43 +00001297 if author:
1298 args.extend(['--author', author])
1299 if gerrit_url:
1300 args.extend(['--gerrit_url', gerrit_url])
Edward Lemur227d5102020-02-25 23:45:35 +00001301 if issue:
1302 args.extend(['--issue', str(issue)])
1303 if patchset:
1304 args.extend(['--patchset', str(patchset)])
Edward Lemur227d5102020-02-25 23:45:35 +00001305
Edward Lemur75526302020-02-27 22:31:05 +00001306 return args
1307
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001308 def RunHook(self, committing, may_prompt, verbose, parallel, upstream,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001309 description, all_files, resultdb=False, realm=None):
Edward Lemur75526302020-02-27 22:31:05 +00001310 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1311 args = self._GetCommonPresubmitArgs(verbose, upstream)
1312 args.append('--commit' if committing else '--upload')
Edward Lemur227d5102020-02-25 23:45:35 +00001313 if may_prompt:
1314 args.append('--may_prompt')
1315 if parallel:
1316 args.append('--parallel')
1317 if all_files:
1318 args.append('--all_files')
1319
1320 with gclient_utils.temporary_file() as description_file:
1321 with gclient_utils.temporary_file() as json_output:
Edward Lemur1a83da12020-03-04 21:18:36 +00001322
1323 gclient_utils.FileWrite(description_file, description)
Edward Lemur227d5102020-02-25 23:45:35 +00001324 args.extend(['--json_output', json_output])
1325 args.extend(['--description_file', description_file])
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001326 args.extend(['--gerrit_project', self.GetGerritProject()])
Edward Lemur227d5102020-02-25 23:45:35 +00001327
1328 start = time_time()
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001329 cmd = ['vpython', PRESUBMIT_SUPPORT] + args
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001330 if resultdb and realm:
1331 cmd = ['rdb', 'stream', '-new', '-realm', realm, '--'] + cmd
1332 elif resultdb:
1333 # TODO (crbug.com/1113463): store realm somewhere and look it up so
1334 # it is not required to pass the realm flag
1335 print('Note: ResultDB reporting will NOT be performed because --realm'
1336 ' was not specified. To enable ResultDB, please run the command'
1337 ' again with the --realm argument to specify the LUCI realm.')
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001338
1339 p = subprocess2.Popen(cmd)
Edward Lemur227d5102020-02-25 23:45:35 +00001340 exit_code = p.wait()
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001341
Edward Lemur227d5102020-02-25 23:45:35 +00001342 metrics.collector.add_repeated('sub_commands', {
1343 'command': 'presubmit',
1344 'execution_time': time_time() - start,
1345 'exit_code': exit_code,
1346 })
1347
1348 if exit_code:
1349 sys.exit(exit_code)
1350
1351 json_results = gclient_utils.FileRead(json_output)
1352 return json.loads(json_results)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001353
Edward Lemur75526302020-02-27 22:31:05 +00001354 def RunPostUploadHook(self, verbose, upstream, description):
1355 args = self._GetCommonPresubmitArgs(verbose, upstream)
1356 args.append('--post_upload')
1357
1358 with gclient_utils.temporary_file() as description_file:
Edward Lemur1a83da12020-03-04 21:18:36 +00001359 gclient_utils.FileWrite(description_file, description)
Edward Lemur75526302020-02-27 22:31:05 +00001360 args.extend(['--description_file', description_file])
1361 p = subprocess2.Popen(['vpython', PRESUBMIT_SUPPORT] + args)
1362 p.wait()
1363
Edward Lemur5a644f82020-03-18 16:44:57 +00001364 def _GetDescriptionForUpload(self, options, git_diff_args, files):
1365 # Get description message for upload.
1366 if self.GetIssue():
1367 description = self.FetchDescription()
1368 elif options.message:
1369 description = options.message
1370 else:
1371 description = _create_description_from_log(git_diff_args)
1372 if options.title and options.squash:
Edward Lesmes0dd54822020-03-26 18:24:25 +00001373 description = options.title + '\n\n' + description
Edward Lemur5a644f82020-03-18 16:44:57 +00001374
1375 # Extract bug number from branch name.
1376 bug = options.bug
1377 fixed = options.fixed
1378 match = re.match(r'(?P<type>bug|fix(?:e[sd])?)[_-]?(?P<bugnum>\d+)',
1379 self.GetBranch())
1380 if not bug and not fixed and match:
1381 if match.group('type') == 'bug':
1382 bug = match.group('bugnum')
1383 else:
1384 fixed = match.group('bugnum')
1385
1386 change_description = ChangeDescription(description, bug, fixed)
1387
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001388 # Fill gaps in OWNERS coverage to tbrs/reviewers if requested.
1389 if options.add_owners_to:
1390 assert options.add_owners_to in ('TBR', 'R'), options.add_owners_to
Edward Lesmese1576912021-02-16 21:53:34 +00001391 status = self.owners_client.GetFilesApprovalStatus(
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001392 files, [], options.tbrs + options.reviewers)
1393 missing_files = [
1394 f for f in files
Edward Lesmese1576912021-02-16 21:53:34 +00001395 if status[f] == self._owners_client.INSUFFICIENT_REVIEWERS
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001396 ]
Edward Lesmese1576912021-02-16 21:53:34 +00001397 owners = self.owners_client.SuggestOwners(
1398 missing_files, exclude=[self.GetAuthor()])
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001399 if options.add_owners_to == 'TBR':
1400 assert isinstance(options.tbrs, list), options.tbrs
1401 options.tbrs.extend(owners)
1402 else:
1403 assert isinstance(options.reviewers, list), options.reviewers
1404 options.reviewers.extend(owners)
1405
Edward Lemur5a644f82020-03-18 16:44:57 +00001406 # Set the reviewer list now so that presubmit checks can access it.
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001407 if options.reviewers or options.tbrs:
1408 change_description.update_reviewers(options.reviewers, options.tbrs)
Edward Lemur5a644f82020-03-18 16:44:57 +00001409
1410 return change_description
1411
1412 def _GetTitleForUpload(self, options):
1413 # When not squashing, just return options.title.
1414 if not options.squash:
1415 return options.title
1416
1417 # On first upload, patchset title is always this string, while options.title
1418 # gets converted to first line of message.
1419 if not self.GetIssue():
1420 return 'Initial upload'
1421
1422 # When uploading subsequent patchsets, options.message is taken as the title
1423 # if options.title is not provided.
1424 if options.title:
1425 return options.title
1426 if options.message:
1427 return options.message.strip()
1428
1429 # Use the subject of the last commit as title by default.
Edward Lesmes50da7702020-03-30 19:23:43 +00001430 title = RunGit(['show', '-s', '--format=%s', 'HEAD']).strip()
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00001431 if options.force or options.skip_title:
Edward Lemur5a644f82020-03-18 16:44:57 +00001432 return title
Edward Lesmesae3586b2020-03-23 21:21:14 +00001433 user_title = gclient_utils.AskForData('Title for patchset [%s]: ' % title)
1434 return user_title or title
Edward Lemur5a644f82020-03-18 16:44:57 +00001435
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001436 def CMDUpload(self, options, git_diff_args, orig_args):
1437 """Uploads a change to codereview."""
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001438 custom_cl_base = None
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001439 if git_diff_args:
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001440 custom_cl_base = base_branch = git_diff_args[0]
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001441 else:
1442 if self.GetBranch() is None:
1443 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1444
1445 # Default to diffing against common ancestor of upstream branch
1446 base_branch = self.GetCommonAncestorWithUpstream()
1447 git_diff_args = [base_branch, 'HEAD']
1448
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001449 # Fast best-effort checks to abort before running potentially expensive
1450 # hooks if uploading is likely to fail anyway. Passing these checks does
1451 # not guarantee that uploading will not fail.
Edward Lemur125d60a2019-09-13 18:25:41 +00001452 self.EnsureAuthenticated(force=options.force)
1453 self.EnsureCanUploadPatchset(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001454
1455 # Apply watchlists on upload.
Edward Lemur2c62b332020-03-12 22:12:33 +00001456 watchlist = watchlists.Watchlists(settings.GetRoot())
1457 files = self.GetAffectedFiles(base_branch)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001458 if not options.bypass_watchlists:
Daniel Cheng7227d212017-11-17 08:12:37 -08001459 self.ExtendCC(watchlist.GetWatchersForPaths(files))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001460
Edward Lemur5a644f82020-03-18 16:44:57 +00001461 change_desc = self._GetDescriptionForUpload(options, git_diff_args, files)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001462 if not options.bypass_hooks:
Edward Lemur2c62b332020-03-12 22:12:33 +00001463 hook_results = self.RunHook(
1464 committing=False,
1465 may_prompt=not options.force,
1466 verbose=options.verbose,
1467 parallel=options.parallel,
1468 upstream=base_branch,
Edward Lemur5a644f82020-03-18 16:44:57 +00001469 description=change_desc.description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001470 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001471 resultdb=options.resultdb,
1472 realm=options.realm)
Edward Lemur227d5102020-02-25 23:45:35 +00001473 self.ExtendCC(hook_results['more_cc'])
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001474
Aaron Gable13101a62018-02-09 13:20:41 -08001475 print_stats(git_diff_args)
Edward Lemura12175c2020-03-09 16:58:26 +00001476 ret = self.CMDUploadChange(
Edward Lemur5a644f82020-03-18 16:44:57 +00001477 options, git_diff_args, custom_cl_base, change_desc)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001478 if not ret:
Edward Lemur85153282020-02-14 22:06:29 +00001479 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001480 'last-upload-hash', scm.GIT.ResolveCommit(settings.GetRoot(), 'HEAD'))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001481 # Run post upload hooks, if specified.
1482 if settings.GetRunPostUploadHook():
Edward Lemur5a644f82020-03-18 16:44:57 +00001483 self.RunPostUploadHook(
1484 options.verbose, base_branch, change_desc.description)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001485
1486 # Upload all dependencies if specified.
1487 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001488 print()
1489 print('--dependencies has been specified.')
1490 print('All dependent local branches will be re-uploaded.')
1491 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001492 # Remove the dependencies flag from args so that we do not end up in a
1493 # loop.
1494 orig_args.remove('--dependencies')
Jose Lopes3863fc52020-04-07 17:00:25 +00001495 ret = upload_branch_deps(self, orig_args, options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001496 return ret
1497
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001498 def SetCQState(self, new_state):
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001499 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001500
1501 Issue must have been already uploaded and known.
1502 """
1503 assert new_state in _CQState.ALL_STATES
1504 assert self.GetIssue()
qyearsley1fdfcb62016-10-24 13:22:03 -07001505 try:
Edward Lemur125d60a2019-09-13 18:25:41 +00001506 vote_map = {
1507 _CQState.NONE: 0,
1508 _CQState.DRY_RUN: 1,
1509 _CQState.COMMIT: 2,
1510 }
1511 labels = {'Commit-Queue': vote_map[new_state]}
1512 notify = False if new_state == _CQState.DRY_RUN else None
1513 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001514 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur125d60a2019-09-13 18:25:41 +00001515 labels=labels, notify=notify)
qyearsley1fdfcb62016-10-24 13:22:03 -07001516 return 0
1517 except KeyboardInterrupt:
1518 raise
1519 except:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001520 print('WARNING: Failed to %s.\n'
qyearsley1fdfcb62016-10-24 13:22:03 -07001521 'Either:\n'
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001522 ' * Your project has no CQ,\n'
1523 ' * You don\'t have permission to change the CQ state,\n'
1524 ' * There\'s a bug in this code (see stack trace below).\n'
1525 'Consider specifying which bots to trigger manually or asking your '
1526 'project owners for permissions or contacting Chrome Infra at:\n'
1527 'https://www.chromium.org/infra\n\n' %
1528 ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ'))
qyearsley1fdfcb62016-10-24 13:22:03 -07001529 # Still raise exception so that stack trace is printed.
1530 raise
1531
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001532 def GetGerritHost(self):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001533 # Lazy load of configs.
1534 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07001535 if self._gerrit_host and '.' not in self._gerrit_host:
1536 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
1537 # This happens for internal stuff http://crbug.com/614312.
Edward Lemur79d4f992019-11-11 23:49:02 +00001538 parsed = urllib.parse.urlparse(self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001539 if parsed.scheme == 'sso':
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001540 print('WARNING: using non-https URLs for remote is likely broken\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001541 ' Your current remote is: %s' % self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001542 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
1543 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001544 return self._gerrit_host
1545
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001546 def _GetGitHost(self):
1547 """Returns git host to be used when uploading change to Gerrit."""
Edward Lemur298f2cf2019-02-22 21:40:39 +00001548 remote_url = self.GetRemoteUrl()
1549 if not remote_url:
1550 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001551 return urllib.parse.urlparse(remote_url).netloc
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001552
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001553 def GetCodereviewServer(self):
1554 if not self._gerrit_server:
1555 # If we're on a branch then get the server potentially associated
1556 # with that branch.
Edward Lemur85153282020-02-14 22:06:29 +00001557 if self.GetIssue() and self.GetBranch():
tandrii5d48c322016-08-18 16:19:37 -07001558 self._gerrit_server = self._GitGetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001559 CODEREVIEW_SERVER_CONFIG_KEY)
tandrii5d48c322016-08-18 16:19:37 -07001560 if self._gerrit_server:
Edward Lemur79d4f992019-11-11 23:49:02 +00001561 self._gerrit_host = urllib.parse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001562 if not self._gerrit_server:
1563 # We assume repo to be hosted on Gerrit, and hence Gerrit server
1564 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001565 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001566 parts[0] = parts[0] + '-review'
1567 self._gerrit_host = '.'.join(parts)
1568 self._gerrit_server = 'https://%s' % self._gerrit_host
1569 return self._gerrit_server
1570
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001571 def GetGerritProject(self):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001572 """Returns Gerrit project name based on remote git URL."""
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001573 remote_url = self.GetRemoteUrl()
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001574 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001575 logging.warning('can\'t detect Gerrit project.')
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001576 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001577 project = urllib.parse.urlparse(remote_url).path.strip('/')
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001578 if project.endswith('.git'):
1579 project = project[:-len('.git')]
Andrii Shyshkalov1e828672018-08-23 22:34:37 +00001580 # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with
1581 # 'a/' prefix, because 'a/' prefix is used to force authentication in
1582 # gitiles/git-over-https protocol. E.g.,
1583 # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project
1584 # as
1585 # https://chromium.googlesource.com/v8/v8
1586 if project.startswith('a/'):
1587 project = project[len('a/'):]
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001588 return project
1589
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001590 def _GerritChangeIdentifier(self):
1591 """Handy method for gerrit_util.ChangeIdentifier for a given CL.
1592
1593 Not to be confused by value of "Change-Id:" footer.
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001594 If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC.
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001595 """
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001596 project = self.GetGerritProject()
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001597 if project:
1598 return gerrit_util.ChangeIdentifier(project, self.GetIssue())
1599 # Fall back on still unique, but less efficient change number.
1600 return str(self.GetIssue())
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001601
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001602 def EnsureAuthenticated(self, force, refresh=None):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001603 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00001604 if settings.GetGerritSkipEnsureAuthenticated():
1605 # For projects with unusual authentication schemes.
1606 # See http://crbug.com/603378.
1607 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001608
1609 # Check presence of cookies only if using cookies-based auth method.
1610 cookie_auth = gerrit_util.Authenticator.get()
1611 if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001612 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001613
Florian Mayerae510e82020-01-30 21:04:48 +00001614 remote_url = self.GetRemoteUrl()
1615 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001616 logging.warning('invalid remote')
Florian Mayerae510e82020-01-30 21:04:48 +00001617 return
1618 if urllib.parse.urlparse(remote_url).scheme != 'https':
Josip906bfde2020-01-31 22:38:49 +00001619 logging.warning('Ignoring branch %(branch)s with non-https remote '
1620 '%(remote)s', {
1621 'branch': self.branch,
1622 'remote': self.GetRemoteUrl()
1623 })
Daniel Chengcf6269b2019-05-18 01:02:12 +00001624 return
1625
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001626 # Lazy-loader to identify Gerrit and Git hosts.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001627 self.GetCodereviewServer()
1628 git_host = self._GetGitHost()
Edward Lemur298f2cf2019-02-22 21:40:39 +00001629 assert self._gerrit_server and self._gerrit_host and git_host
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001630
1631 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
1632 git_auth = cookie_auth.get_auth_header(git_host)
1633 if gerrit_auth and git_auth:
1634 if gerrit_auth == git_auth:
1635 return
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001636 all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com')
Raul Tambre80ee78e2019-05-06 22:41:05 +00001637 print(
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001638 'WARNING: You have different credentials for Gerrit and git hosts:\n'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001639 ' %s\n'
1640 ' %s\n'
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001641 ' Consider running the following command:\n'
1642 ' git cl creds-check\n'
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001643 ' %s\n'
Raul Tambre80ee78e2019-05-06 22:41:05 +00001644 ' %s' %
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001645 (git_host, self._gerrit_host,
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001646 ('Hint: delete creds for .googlesource.com' if all_gsrc else ''),
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001647 cookie_auth.get_new_password_message(git_host)))
1648 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001649 confirm_or_exit('If you know what you are doing', action='continue')
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001650 return
1651 else:
1652 missing = (
Anna Henningsen4e891442017-07-06 21:40:58 +02001653 ([] if gerrit_auth else [self._gerrit_host]) +
1654 ([] if git_auth else [git_host]))
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001655 DieWithError('Credentials for the following hosts are required:\n'
1656 ' %s\n'
1657 'These are read from %s (or legacy %s)\n'
1658 '%s' % (
1659 '\n '.join(missing),
1660 cookie_auth.get_gitcookies_path(),
1661 cookie_auth.get_netrc_path(),
1662 cookie_auth.get_new_password_message(git_host)))
1663
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001664 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001665 if not self.GetIssue():
1666 return
1667
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001668 status = self._GetChangeDetail()['status']
1669 if status in ('MERGED', 'ABANDONED'):
1670 DieWithError('Change %s has been %s, new uploads are not allowed' %
1671 (self.GetIssueURL(),
1672 'submitted' if status == 'MERGED' else 'abandoned'))
1673
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001674 # TODO(vadimsh): For some reason the chunk of code below was skipped if
1675 # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'.
1676 # Apparently this check is not very important? Otherwise get_auth_email
1677 # could have been added to other implementations of Authenticator.
1678 cookies_auth = gerrit_util.Authenticator.get()
1679 if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator):
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001680 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001681
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001682 cookies_user = cookies_auth.get_auth_email(self.GetGerritHost())
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001683 if self.GetIssueOwner() == cookies_user:
1684 return
1685 logging.debug('change %s owner is %s, cookies user is %s',
1686 self.GetIssue(), self.GetIssueOwner(), cookies_user)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001687 # Maybe user has linked accounts or something like that,
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001688 # so ask what Gerrit thinks of this user.
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001689 details = gerrit_util.GetAccountDetails(self.GetGerritHost(), 'self')
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001690 if details['email'] == self.GetIssueOwner():
1691 return
1692 if not force:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001693 print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit '
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001694 'as %s.\n'
1695 'Uploading may fail due to lack of permissions.' %
1696 (self.GetIssue(), self.GetIssueOwner(), details['email']))
1697 confirm_or_exit(action='upload')
1698
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001699 def GetStatus(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001700 """Applies a rough heuristic to give a simple summary of an issue's review
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001701 or CQ status, assuming adherence to a common workflow.
1702
1703 Returns None if no issue for this branch, or one of the following keywords:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001704 * 'error' - error from review tool (including deleted issues)
1705 * 'unsent' - no reviewers added
1706 * 'waiting' - waiting for review
1707 * 'reply' - waiting for uploader to reply to review
1708 * 'lgtm' - Code-Review label has been set
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001709 * 'dry-run' - dry-running in the CQ
1710 * 'commit' - in the CQ
Aaron Gable9ab38c62017-04-06 14:36:33 -07001711 * 'closed' - successfully submitted or abandoned
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001712 """
1713 if not self.GetIssue():
1714 return None
1715
1716 try:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001717 data = self._GetChangeDetail([
1718 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE'])
Edward Lemur79d4f992019-11-11 23:49:02 +00001719 except GerritChangeNotExists:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001720 return 'error'
1721
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00001722 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001723 return 'closed'
1724
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001725 cq_label = data['labels'].get('Commit-Queue', {})
1726 max_cq_vote = 0
1727 for vote in cq_label.get('all', []):
1728 max_cq_vote = max(max_cq_vote, vote.get('value', 0))
1729 if max_cq_vote == 2:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001730 return 'commit'
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001731 if max_cq_vote == 1:
1732 return 'dry-run'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001733
Aaron Gable9ab38c62017-04-06 14:36:33 -07001734 if data['labels'].get('Code-Review', {}).get('approved'):
1735 return 'lgtm'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001736
1737 if not data.get('reviewers', {}).get('REVIEWER', []):
1738 return 'unsent'
1739
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001740 owner = data['owner'].get('_account_id')
Edward Lemur79d4f992019-11-11 23:49:02 +00001741 messages = sorted(data.get('messages', []), key=lambda m: m.get('date'))
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001742 while messages:
1743 m = messages.pop()
1744 if m.get('tag', '').startswith('autogenerated:cq:'):
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001745 # Ignore replies from CQ.
1746 continue
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001747 if m.get('author', {}).get('_account_id') == owner:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001748 # Most recent message was by owner.
1749 return 'waiting'
1750 else:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001751 # Some reply from non-owner.
1752 return 'reply'
Aaron Gable9ab38c62017-04-06 14:36:33 -07001753
1754 # Somehow there are no messages even though there are reviewers.
1755 return 'unsent'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001756
1757 def GetMostRecentPatchset(self):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001758 if not self.GetIssue():
1759 return None
1760
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001761 data = self._GetChangeDetail(['CURRENT_REVISION'])
Aaron Gablee8856ee2017-12-07 12:41:46 -08001762 patchset = data['revisions'][data['current_revision']]['_number']
1763 self.SetPatchset(patchset)
1764 return patchset
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001765
Gavin Make61ccc52020-11-13 00:12:57 +00001766 def GetMostRecentDryRunPatchset(self):
1767 """Get patchsets equivalent to the most recent patchset and return
1768 the patchset with the latest dry run. If none have been dry run, return
1769 the latest patchset."""
1770 if not self.GetIssue():
1771 return None
1772
1773 data = self._GetChangeDetail(['ALL_REVISIONS'])
1774 patchset = data['revisions'][data['current_revision']]['_number']
1775 dry_run = set([int(m['_revision_number'])
1776 for m in data.get('messages', [])
1777 if m.get('tag', '').endswith('dry-run')])
1778
1779 for revision_info in sorted(data.get('revisions', {}).values(),
1780 key=lambda c: c['_number'], reverse=True):
1781 if revision_info['_number'] in dry_run:
1782 patchset = revision_info['_number']
1783 break
1784 if revision_info.get('kind', '') not in \
1785 ('NO_CHANGE', 'NO_CODE_CHANGE', 'TRIVIAL_REBASE'):
1786 break
1787 self.SetPatchset(patchset)
1788 return patchset
1789
Aaron Gable636b13f2017-07-14 10:42:48 -07001790 def AddComment(self, message, publish=None):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001791 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001792 self.GetGerritHost(), self._GerritChangeIdentifier(),
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001793 msg=message, ready=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001794
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001795 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalov5a0cf202017-03-17 16:14:59 +01001796 # DETAILED_ACCOUNTS is to get emails in accounts.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001797 # CURRENT_REVISION is included to get the latest patchset so that
1798 # only the robot comments from the latest patchset can be shown.
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001799 messages = self._GetChangeDetail(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001800 options=['MESSAGES', 'DETAILED_ACCOUNTS',
1801 'CURRENT_REVISION']).get('messages', [])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001802 file_comments = gerrit_util.GetChangeComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001803 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001804 robot_file_comments = gerrit_util.GetChangeRobotComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001805 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001806
1807 # Add the robot comments onto the list of comments, but only
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +00001808 # keep those that are from the latest patchset.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001809 latest_patch_set = self.GetMostRecentPatchset()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001810 for path, robot_comments in robot_file_comments.items():
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001811 line_comments = file_comments.setdefault(path, [])
1812 line_comments.extend(
1813 [c for c in robot_comments if c['patch_set'] == latest_patch_set])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001814
1815 # Build dictionary of file comments for easy access and sorting later.
1816 # {author+date: {path: {patchset: {line: url+message}}}}
1817 comments = collections.defaultdict(
1818 lambda: collections.defaultdict(lambda: collections.defaultdict(dict)))
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001819
1820 server = self.GetCodereviewServer()
1821 if server in _KNOWN_GERRIT_TO_SHORT_URLS:
1822 # /c/ is automatically added by short URL server.
1823 url_prefix = '%s/%s' % (_KNOWN_GERRIT_TO_SHORT_URLS[server],
1824 self.GetIssue())
1825 else:
1826 url_prefix = '%s/c/%s' % (server, self.GetIssue())
1827
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001828 for path, line_comments in file_comments.items():
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001829 for comment in line_comments:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001830 tag = comment.get('tag', '')
1831 if tag.startswith('autogenerated') and 'robot_id' not in comment:
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001832 continue
1833 key = (comment['author']['email'], comment['updated'])
1834 if comment.get('side', 'REVISION') == 'PARENT':
1835 patchset = 'Base'
1836 else:
1837 patchset = 'PS%d' % comment['patch_set']
1838 line = comment.get('line', 0)
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001839 url = ('%s/%s/%s#%s%s' %
1840 (url_prefix, comment['patch_set'], path,
1841 'b' if comment.get('side') == 'PARENT' else '',
1842 str(line) if line else ''))
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001843 comments[key][path][patchset][line] = (url, comment['message'])
1844
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001845 summaries = []
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001846 for msg in messages:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001847 summary = self._BuildCommentSummary(msg, comments, readable)
1848 if summary:
1849 summaries.append(summary)
1850 return summaries
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001851
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001852 @staticmethod
1853 def _BuildCommentSummary(msg, comments, readable):
1854 key = (msg['author']['email'], msg['date'])
1855 # Don't bother showing autogenerated messages that don't have associated
1856 # file or line comments. this will filter out most autogenerated
1857 # messages, but will keep robot comments like those from Tricium.
1858 is_autogenerated = msg.get('tag', '').startswith('autogenerated')
1859 if is_autogenerated and not comments.get(key):
1860 return None
1861 message = msg['message']
1862 # Gerrit spits out nanoseconds.
1863 assert len(msg['date'].split('.')[-1]) == 9
1864 date = datetime.datetime.strptime(msg['date'][:-3],
1865 '%Y-%m-%d %H:%M:%S.%f')
1866 if key in comments:
1867 message += '\n'
1868 for path, patchsets in sorted(comments.get(key, {}).items()):
1869 if readable:
1870 message += '\n%s' % path
1871 for patchset, lines in sorted(patchsets.items()):
1872 for line, (url, content) in sorted(lines.items()):
1873 if line:
1874 line_str = 'Line %d' % line
1875 path_str = '%s:%d:' % (path, line)
1876 else:
1877 line_str = 'File comment'
1878 path_str = '%s:0:' % path
1879 if readable:
1880 message += '\n %s, %s: %s' % (patchset, line_str, url)
1881 message += '\n %s\n' % content
1882 else:
1883 message += '\n%s ' % path_str
1884 message += '\n%s\n' % content
1885
1886 return _CommentSummary(
1887 date=date,
1888 message=message,
1889 sender=msg['author']['email'],
1890 autogenerated=is_autogenerated,
1891 # These could be inferred from the text messages and correlated with
1892 # Code-Review label maximum, however this is not reliable.
1893 # Leaving as is until the need arises.
1894 approval=False,
1895 disapproval=False,
1896 )
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001897
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001898 def CloseIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001899 gerrit_util.AbandonChange(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001900 self.GetGerritHost(), self._GerritChangeIdentifier(), msg='')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001901
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001902 def SubmitIssue(self, wait_for_merge=True):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001903 gerrit_util.SubmitChange(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001904 self.GetGerritHost(), self._GerritChangeIdentifier(),
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001905 wait_for_merge=wait_for_merge)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001906
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001907 def _GetChangeDetail(self, options=None):
1908 """Returns details of associated Gerrit change and caching results."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00001909 options = options or []
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001910 assert self.GetIssue(), 'issue is required to query Gerrit'
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001911
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001912 # Optimization to avoid multiple RPCs:
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001913 if 'CURRENT_REVISION' in options or 'ALL_REVISIONS' in options:
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001914 options.append('CURRENT_COMMIT')
1915
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001916 # Normalize issue and options for consistent keys in cache.
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001917 cache_key = str(self.GetIssue())
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001918 options_set = frozenset(o.upper() for o in options)
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001919
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001920 for cached_options_set, data in self._detail_cache.get(cache_key, []):
1921 # Assumption: data fetched before with extra options is suitable
1922 # for return for a smaller set of options.
1923 # For example, if we cached data for
1924 # options=[CURRENT_REVISION, DETAILED_FOOTERS]
1925 # and request is for options=[CURRENT_REVISION],
1926 # THEN we can return prior cached data.
1927 if options_set.issubset(cached_options_set):
1928 return data
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001929
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001930 try:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001931 data = gerrit_util.GetChangeDetail(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001932 self.GetGerritHost(), self._GerritChangeIdentifier(), options_set)
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001933 except gerrit_util.GerritError as e:
1934 if e.http_status == 404:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001935 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001936 raise
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001937
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001938 self._detail_cache.setdefault(cache_key, []).append((options_set, data))
tandriic2405f52016-10-10 08:13:15 -07001939 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001940
Andrii Shyshkalovcc5f17e2018-08-22 23:35:59 +00001941 def _GetChangeCommit(self):
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001942 assert self.GetIssue(), 'issue must be set to query Gerrit'
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001943 try:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001944 data = gerrit_util.GetChangeCommit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001945 self.GetGerritHost(), self._GerritChangeIdentifier())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001946 except gerrit_util.GerritError as e:
1947 if e.http_status == 404:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001948 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001949 raise
agable32978d92016-11-01 12:55:02 -07001950 return data
1951
Karen Qian40c19422019-03-13 21:28:29 +00001952 def _IsCqConfigured(self):
1953 detail = self._GetChangeDetail(['LABELS'])
Andrii Shyshkalov8effa4d2020-01-21 13:23:36 +00001954 return u'Commit-Queue' in detail.get('labels', {})
Karen Qian40c19422019-03-13 21:28:29 +00001955
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001956 def CMDLand(self, force, bypass_hooks, verbose, parallel, resultdb, realm):
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001957 if git_common.is_dirty_git_tree('land'):
1958 return 1
Karen Qian40c19422019-03-13 21:28:29 +00001959
tandriid60367b2016-06-22 05:25:12 -07001960 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
Karen Qian40c19422019-03-13 21:28:29 +00001961 if not force and self._IsCqConfigured():
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001962 confirm_or_exit('\nIt seems this repository has a CQ, '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001963 'which can test and land changes for you. '
1964 'Are you sure you wish to bypass it?\n',
1965 action='bypass CQ')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001966 differs = True
tandriic4344b52016-08-29 06:04:54 -07001967 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001968 # Note: git diff outputs nothing if there is no diff.
1969 if not last_upload or RunGit(['diff', last_upload]).strip():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001970 print('WARNING: Some changes from local branch haven\'t been uploaded.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001971 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001972 if detail['current_revision'] == last_upload:
1973 differs = False
1974 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001975 print('WARNING: Local branch contents differ from latest uploaded '
1976 'patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001977 if differs:
1978 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001979 confirm_or_exit(
1980 'Do you want to submit latest Gerrit patchset and bypass hooks?\n',
1981 action='submit')
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001982 print('WARNING: Bypassing hooks and submitting latest uploaded patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001983 elif not bypass_hooks:
Edward Lemur227d5102020-02-25 23:45:35 +00001984 upstream = self.GetCommonAncestorWithUpstream()
1985 if self.GetIssue():
1986 description = self.FetchDescription()
1987 else:
Edward Lemura12175c2020-03-09 16:58:26 +00001988 description = _create_description_from_log([upstream])
Edward Lemur227d5102020-02-25 23:45:35 +00001989 self.RunHook(
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001990 committing=True,
1991 may_prompt=not force,
1992 verbose=verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00001993 parallel=parallel,
1994 upstream=upstream,
1995 description=description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001996 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001997 resultdb=resultdb,
1998 realm=realm)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001999
2000 self.SubmitIssue(wait_for_merge=True)
2001 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002002 links = self._GetChangeCommit().get('web_links', [])
2003 for link in links:
Aaron Gable02cdbb42016-12-13 16:24:25 -08002004 if link.get('name') == 'gitiles' and link.get('url'):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002005 print('Landed as: %s' % link.get('url'))
agable32978d92016-11-01 12:55:02 -07002006 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002007 return 0
2008
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002009 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force,
2010 newbranch):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002011 assert parsed_issue_arg.valid
2012
Edward Lemur125d60a2019-09-13 18:25:41 +00002013 self.issue = parsed_issue_arg.issue
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002014
2015 if parsed_issue_arg.hostname:
2016 self._gerrit_host = parsed_issue_arg.hostname
2017 self._gerrit_server = 'https://%s' % self._gerrit_host
2018
tandriic2405f52016-10-10 08:13:15 -07002019 try:
2020 detail = self._GetChangeDetail(['ALL_REVISIONS'])
Aaron Gablea45ee112016-11-22 15:14:38 -08002021 except GerritChangeNotExists as e:
tandriic2405f52016-10-10 08:13:15 -07002022 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002023
2024 if not parsed_issue_arg.patchset:
2025 # Use current revision by default.
2026 revision_info = detail['revisions'][detail['current_revision']]
2027 patchset = int(revision_info['_number'])
2028 else:
2029 patchset = parsed_issue_arg.patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002030 for revision_info in detail['revisions'].values():
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002031 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2032 break
2033 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002034 DieWithError('Couldn\'t find patchset %i in change %i' %
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002035 (parsed_issue_arg.patchset, self.GetIssue()))
2036
Edward Lemur125d60a2019-09-13 18:25:41 +00002037 remote_url = self.GetRemoteUrl()
Aaron Gable697a91b2018-01-19 15:20:15 -08002038 if remote_url.endswith('.git'):
2039 remote_url = remote_url[:-len('.git')]
erikchen0d14d0d2018-08-28 18:57:09 +00002040 remote_url = remote_url.rstrip('/')
2041
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002042 fetch_info = revision_info['fetch']['http']
erikchen0d14d0d2018-08-28 18:57:09 +00002043 fetch_info['url'] = fetch_info['url'].rstrip('/')
Aaron Gable697a91b2018-01-19 15:20:15 -08002044
2045 if remote_url != fetch_info['url']:
2046 DieWithError('Trying to patch a change from %s but this repo appears '
2047 'to be %s.' % (fetch_info['url'], remote_url))
2048
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002049 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
Aaron Gable9387b4f2017-06-08 10:50:03 -07002050
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002051 # If we have created a new branch then do the "set issue" immediately in
2052 # case the cherry-pick fails, which happens when resolving conflicts.
2053 if newbranch:
2054 self.SetIssue(parsed_issue_arg.issue)
2055
Aaron Gable62619a32017-06-16 08:22:09 -07002056 if force:
2057 RunGit(['reset', '--hard', 'FETCH_HEAD'])
2058 print('Checked out commit for change %i patchset %i locally' %
2059 (parsed_issue_arg.issue, patchset))
Stefan Zager2d5f0392017-10-10 15:17:53 -07002060 elif nocommit:
2061 RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD'])
2062 print('Patch applied to index.')
Aaron Gable62619a32017-06-16 08:22:09 -07002063 else:
Aaron Gable9387b4f2017-06-08 10:50:03 -07002064 RunGit(['cherry-pick', 'FETCH_HEAD'])
2065 print('Committed patch for change %i patchset %i locally.' %
Aaron Gable62619a32017-06-16 08:22:09 -07002066 (parsed_issue_arg.issue, patchset))
2067 print('Note: this created a local commit which does not have '
2068 'the same hash as the one uploaded for review. This will make '
2069 'uploading changes based on top of this branch difficult.\n'
2070 'If you want to do that, use "git cl patch --force" instead.')
2071
Stefan Zagerd08043c2017-10-12 12:07:02 -07002072 if self.GetBranch():
2073 self.SetIssue(parsed_issue_arg.issue)
2074 self.SetPatchset(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00002075 fetched_hash = scm.GIT.ResolveCommit(settings.GetRoot(), 'FETCH_HEAD')
Stefan Zagerd08043c2017-10-12 12:07:02 -07002076 self._GitSetBranchConfigValue('last-upload-hash', fetched_hash)
2077 self._GitSetBranchConfigValue('gerritsquashhash', fetched_hash)
2078 else:
2079 print('WARNING: You are in detached HEAD state.\n'
2080 'The patch has been applied to your checkout, but you will not be '
2081 'able to upload a new patch set to the gerrit issue.\n'
2082 'Try using the \'-b\' option if you would like to work on a '
2083 'branch and/or upload a new patch set.')
2084
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002085 return 0
2086
tandrii16e0b4e2016-06-07 10:34:28 -07002087 def _GerritCommitMsgHookCheck(self, offer_removal):
2088 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2089 if not os.path.exists(hook):
2090 return
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002091 # Crude attempt to distinguish Gerrit Codereview hook from a potentially
2092 # custom developer-made one.
tandrii16e0b4e2016-06-07 10:34:28 -07002093 data = gclient_utils.FileRead(hook)
2094 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2095 return
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002096 print('WARNING: You have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002097 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002098 'and may interfere with it in subtle ways.\n'
2099 'We recommend you remove the commit-msg hook.')
2100 if offer_removal:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002101 if ask_for_explicit_yes('Do you want to remove it now?'):
tandrii16e0b4e2016-06-07 10:34:28 -07002102 gclient_utils.rm_file_or_tree(hook)
2103 print('Gerrit commit-msg hook removed.')
2104 else:
2105 print('OK, will keep Gerrit commit-msg hook in place.')
2106
Edward Lemur1b52d872019-05-09 21:12:12 +00002107 def _CleanUpOldTraces(self):
2108 """Keep only the last |MAX_TRACES| traces."""
2109 try:
2110 traces = sorted([
2111 os.path.join(TRACES_DIR, f)
2112 for f in os.listdir(TRACES_DIR)
2113 if (os.path.isfile(os.path.join(TRACES_DIR, f))
2114 and not f.startswith('tmp'))
2115 ])
2116 traces_to_delete = traces[:-MAX_TRACES]
2117 for trace in traces_to_delete:
Daniel Chengcf6269b2019-05-18 01:02:12 +00002118 os.remove(trace)
Edward Lemur1b52d872019-05-09 21:12:12 +00002119 except OSError:
2120 print('WARNING: Failed to remove old git traces from\n'
2121 ' %s'
2122 'Consider removing them manually.' % TRACES_DIR)
Edward Lemurdc8e23d2019-05-07 00:45:48 +00002123
Edward Lemur5737f022019-05-17 01:24:00 +00002124 def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002125 """Zip and write the git push traces stored in traces_dir."""
2126 gclient_utils.safe_makedirs(TRACES_DIR)
Edward Lemur1b52d872019-05-09 21:12:12 +00002127 traces_zip = trace_name + '-traces'
2128 traces_readme = trace_name + '-README'
Michael Mosse7f0b4c2019-05-08 04:36:24 +00002129 # Create a temporary dir to store git config and gitcookies in. It will be
2130 # compressed and stored next to the traces.
2131 git_info_dir = tempfile.mkdtemp()
Edward Lemur1b52d872019-05-09 21:12:12 +00002132 git_info_zip = trace_name + '-git-info'
2133
Josip Sokcevic5e18b602020-04-23 21:47:00 +00002134 git_push_metadata['now'] = datetime_now().strftime('%Y-%m-%dT%H:%M:%S.%f')
sangwoo.ko7a614332019-05-22 02:46:19 +00002135
Edward Lemur1b52d872019-05-09 21:12:12 +00002136 git_push_metadata['trace_name'] = trace_name
2137 gclient_utils.FileWrite(
2138 traces_readme, TRACES_README_FORMAT % git_push_metadata)
2139
2140 # Keep only the first 6 characters of the git hashes on the packet
2141 # trace. This greatly decreases size after compression.
2142 packet_traces = os.path.join(traces_dir, 'trace-packet')
2143 if os.path.isfile(packet_traces):
2144 contents = gclient_utils.FileRead(packet_traces)
2145 gclient_utils.FileWrite(
2146 packet_traces, GIT_HASH_RE.sub(r'\1', contents))
2147 shutil.make_archive(traces_zip, 'zip', traces_dir)
2148
2149 # Collect and compress the git config and gitcookies.
2150 git_config = RunGit(['config', '-l'])
2151 gclient_utils.FileWrite(
2152 os.path.join(git_info_dir, 'git-config'),
2153 git_config)
2154
2155 cookie_auth = gerrit_util.Authenticator.get()
2156 if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
2157 gitcookies_path = cookie_auth.get_gitcookies_path()
2158 if os.path.isfile(gitcookies_path):
2159 gitcookies = gclient_utils.FileRead(gitcookies_path)
2160 gclient_utils.FileWrite(
2161 os.path.join(git_info_dir, 'gitcookies'),
2162 GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies))
2163 shutil.make_archive(git_info_zip, 'zip', git_info_dir)
2164
Edward Lemur1b52d872019-05-09 21:12:12 +00002165 gclient_utils.rmtree(git_info_dir)
2166
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002167 def _RunGitPushWithTraces(self, refspec, refspec_opts, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002168 """Run git push and collect the traces resulting from the execution."""
2169 # Create a temporary directory to store traces in. Traces will be compressed
2170 # and stored in a 'traces' dir inside depot_tools.
2171 traces_dir = tempfile.mkdtemp()
Edward Lemur5737f022019-05-17 01:24:00 +00002172 trace_name = os.path.join(
2173 TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f'))
Edward Lemur0f58ae42019-04-30 17:24:12 +00002174
2175 env = os.environ.copy()
2176 env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy'
2177 env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Jonathan Nieder9779b142019-05-29 23:19:29 +00002178 env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002179 env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl')
2180 env['GIT_TRACE_CURL_NO_DATA'] = '1'
2181 env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet')
2182
2183 try:
2184 push_returncode = 0
Edward Lemur1b52d872019-05-09 21:12:12 +00002185 remote_url = self.GetRemoteUrl()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002186 before_push = time_time()
2187 push_stdout = gclient_utils.CheckCallAndFilter(
Edward Lemur1b52d872019-05-09 21:12:12 +00002188 ['git', 'push', remote_url, refspec],
Edward Lemur0f58ae42019-04-30 17:24:12 +00002189 env=env,
2190 print_stdout=True,
2191 # Flush after every line: useful for seeing progress when running as
2192 # recipe.
2193 filter_fn=lambda _: sys.stdout.flush())
Edward Lemur79d4f992019-11-11 23:49:02 +00002194 push_stdout = push_stdout.decode('utf-8', 'replace')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002195 except subprocess2.CalledProcessError as e:
2196 push_returncode = e.returncode
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002197 raise GitPushError(
2198 'Failed to create a change. Please examine output above for the '
2199 'reason of the failure.\n'
Josip Sokcevic7386a1e2021-02-12 19:00:34 +00002200 'For emergencies, Googlers can escalate to '
2201 'go/gob-support or go/notify#gob\n'
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002202 'Hint: run command below to diagnose common Git/Gerrit '
2203 'credential problems:\n'
2204 ' git cl creds-check\n'
2205 '\n'
2206 'If git-cl is not working correctly, file a bug under the Infra>SDK '
2207 'component including the files below.\n'
2208 'Review the files before upload, since they might contain sensitive '
2209 'information.\n'
2210 'Set the Restrict-View-Google label so that they are not publicly '
2211 'accessible.\n' + TRACES_MESSAGE % {'trace_name': trace_name})
Edward Lemur0f58ae42019-04-30 17:24:12 +00002212 finally:
2213 execution_time = time_time() - before_push
2214 metrics.collector.add_repeated('sub_commands', {
2215 'command': 'git push',
2216 'execution_time': execution_time,
2217 'exit_code': push_returncode,
2218 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts),
2219 })
2220
Edward Lemur1b52d872019-05-09 21:12:12 +00002221 git_push_metadata['execution_time'] = execution_time
2222 git_push_metadata['exit_code'] = push_returncode
Edward Lemur5737f022019-05-17 01:24:00 +00002223 self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata)
Edward Lemur0f58ae42019-04-30 17:24:12 +00002224
Edward Lemur1b52d872019-05-09 21:12:12 +00002225 self._CleanUpOldTraces()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002226 gclient_utils.rmtree(traces_dir)
2227
2228 return push_stdout
2229
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002230 def CMDUploadChange(self, options, git_diff_args, custom_cl_base,
2231 change_desc):
2232 """Upload the current branch to Gerrit, retry if new remote HEAD is
2233 found. options and change_desc may be mutated."""
Josip Sokcevicb631a882021-01-06 18:18:10 +00002234 remote, remote_branch = self.GetRemoteBranch()
2235 branch = GetTargetRef(remote, remote_branch, options.target_branch)
2236
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002237 try:
2238 return self._CMDUploadChange(options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002239 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002240 except GitPushError as e:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002241 # Repository might be in the middle of transition to main branch as
2242 # default, and uploads to old default might be blocked.
2243 if remote_branch not in [DEFAULT_OLD_BRANCH, DEFAULT_NEW_BRANCH]:
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002244 DieWithError(str(e), change_desc)
2245
Josip Sokcevicb631a882021-01-06 18:18:10 +00002246 project_head = gerrit_util.GetProjectHead(self._gerrit_host,
2247 self.GetGerritProject())
2248 if project_head == branch:
2249 DieWithError(str(e), change_desc)
2250 branch = project_head
2251
2252 print("WARNING: Fetching remote state and retrying upload to default "
2253 "branch...")
2254 RunGit(['fetch', '--prune', remote])
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002255 options.edit_description = False
2256 options.force = True
2257 try:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002258 self._CMDUploadChange(options, git_diff_args, custom_cl_base,
2259 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002260 except GitPushError as e:
2261 DieWithError(str(e), change_desc)
2262
2263 def _CMDUploadChange(self, options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002264 change_desc, branch):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002265 """Upload the current branch to Gerrit."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002266 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002267 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002268 if self.GetIssue():
Josipe827b0f2020-01-30 00:07:20 +00002269 # User requested to change description
2270 if options.edit_description:
Josipe827b0f2020-01-30 00:07:20 +00002271 change_desc.prompt()
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002272 change_id = self._GetChangeDetail()['change_id']
Edward Lemur5a644f82020-03-18 16:44:57 +00002273 change_desc.ensure_change_id(change_id)
Aaron Gableb56ad332017-01-06 15:24:31 -08002274 else: # if not self.GetIssue()
Gavin Mak68e6cf32021-01-25 18:24:08 +00002275 if not options.force and not options.message_file:
Anthony Polito8b955342019-09-24 19:01:36 +00002276 change_desc.prompt()
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002277 change_ids = git_footers.get_footer_change_id(change_desc.description)
Edward Lemur5a644f82020-03-18 16:44:57 +00002278 if len(change_ids) == 1:
2279 change_id = change_ids[0]
2280 else:
2281 change_id = GenerateGerritChangeId(change_desc.description)
2282 change_desc.ensure_change_id(change_id)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002283
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002284 if options.preserve_tryjobs:
2285 change_desc.set_preserve_tryjobs()
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002286
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002287 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Edward Lemur5a644f82020-03-18 16:44:57 +00002288 parent = self._ComputeParent(
2289 remote, upstream_branch, custom_cl_base, options.force, change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002290 tree = RunGit(['rev-parse', 'HEAD:']).strip()
Edward Lemur1773f372020-02-22 00:27:14 +00002291 with gclient_utils.temporary_file() as desc_tempfile:
2292 gclient_utils.FileWrite(desc_tempfile, change_desc.description)
2293 ref_to_push = RunGit(
2294 ['commit-tree', tree, '-p', parent, '-F', desc_tempfile]).strip()
Anthony Polito8b955342019-09-24 19:01:36 +00002295 else: # if not options.squash
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002296 if not git_footers.get_footer_change_id(change_desc.description):
2297 DownloadGerritHook(False)
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002298 change_desc.set_description(
Edward Lemur5a644f82020-03-18 16:44:57 +00002299 self._AddChangeIdToCommitMessage(
2300 change_desc.description, git_diff_args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002301 ref_to_push = 'HEAD'
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002302 # For no-squash mode, we assume the remote called "origin" is the one we
2303 # want. It is not worthwhile to support different workflows for
2304 # no-squash mode.
2305 parent = 'origin/%s' % branch
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002306 change_id = git_footers.get_footer_change_id(change_desc.description)[0]
2307
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +00002308 SaveDescriptionBackup(change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002309 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2310 ref_to_push)]).splitlines()
2311 if len(commits) > 1:
2312 print('WARNING: This will upload %d commits. Run the following command '
2313 'to see which commits will be uploaded: ' % len(commits))
2314 print('git log %s..%s' % (parent, ref_to_push))
2315 print('You can also use `git squash-branch` to squash these into a '
2316 'single commit.')
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002317 confirm_or_exit(action='upload')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002318
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002319 reviewers = sorted(change_desc.get_reviewers())
Edward Lemur4508b422019-10-03 21:56:35 +00002320 cc = []
2321 # Add CCs from WATCHLISTS and rietveld.cc git config unless this is
2322 # the initial upload, the CL is private, or auto-CCing has ben disabled.
2323 if not (self.GetIssue() or options.private or options.no_autocc):
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002324 cc = self.GetCCList().split(',')
Edward Lemur4508b422019-10-03 21:56:35 +00002325 # Add cc's from the --cc flag.
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002326 if options.cc:
2327 cc.extend(options.cc)
Edward Lemur79d4f992019-11-11 23:49:02 +00002328 cc = [email.strip() for email in cc if email.strip()]
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002329 if change_desc.get_cced():
2330 cc.extend(change_desc.get_cced())
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002331 if self.GetGerritHost() == 'chromium-review.googlesource.com':
Andrii Shyshkalov0da5e8f2018-10-30 17:29:18 +00002332 valid_accounts = set(reviewers + cc)
2333 # TODO(crbug/877717): relax this for all hosts.
2334 else:
2335 valid_accounts = gerrit_util.ValidAccounts(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002336 self.GetGerritHost(), reviewers + cc)
Andrii Shyshkalovf170af42018-10-30 07:00:44 +00002337 logging.info('accounts %s are recognized, %s invalid',
2338 sorted(valid_accounts),
2339 set(reviewers + cc).difference(set(valid_accounts)))
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002340
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002341 # Extra options that can be specified at push time. Doc:
2342 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002343 refspec_opts = []
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002344
Aaron Gable844cf292017-06-28 11:32:59 -07002345 # By default, new changes are started in WIP mode, and subsequent patchsets
2346 # don't send email. At any time, passing --send-mail will mark the change
2347 # ready and send email for that particular patch.
Aaron Gableafd52772017-06-27 16:40:10 -07002348 if options.send_mail:
2349 refspec_opts.append('ready')
Aaron Gable844cf292017-06-28 11:32:59 -07002350 refspec_opts.append('notify=ALL')
Jamie Madill276da0b2018-04-27 14:41:20 -04002351 elif not self.GetIssue() and options.squash:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002352 refspec_opts.append('wip')
Aaron Gableafd52772017-06-27 16:40:10 -07002353 else:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002354 refspec_opts.append('notify=NONE')
Aaron Gable70f4e242017-06-26 10:45:59 -07002355
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002356 # TODO(tandrii): options.message should be posted as a comment
Aaron Gablee5adf612017-07-14 10:43:58 -07002357 # if --send-mail is set on non-initial upload as Rietveld used to do it.
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002358
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002359 # Set options.title in case user was prompted in _GetTitleForUpload and
2360 # _CMDUploadChange needs to be called again.
2361 options.title = self._GetTitleForUpload(options)
2362 if options.title:
Nick Carter8692b182017-11-06 16:30:38 -08002363 # Punctuation and whitespace in |title| must be percent-encoded.
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002364 refspec_opts.append(
2365 'm=' + gerrit_util.PercentEncodeForGitRef(options.title))
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002366
agablec6787972016-09-09 16:13:34 -07002367 if options.private:
Aaron Gableb02daf02017-05-23 11:53:46 -07002368 refspec_opts.append('private')
agablec6787972016-09-09 16:13:34 -07002369
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002370 for r in sorted(reviewers):
2371 if r in valid_accounts:
2372 refspec_opts.append('r=%s' % r)
2373 reviewers.remove(r)
2374 else:
2375 # TODO(tandrii): this should probably be a hard failure.
2376 print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping'
2377 % r)
2378 for c in sorted(cc):
2379 # refspec option will be rejected if cc doesn't correspond to an
2380 # account, even though REST call to add such arbitrary cc may succeed.
2381 if c in valid_accounts:
2382 refspec_opts.append('cc=%s' % c)
2383 cc.remove(c)
2384
rmistry9eadede2016-09-19 11:22:43 -07002385 if options.topic:
2386 # Documentation on Gerrit topics is here:
2387 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002388 refspec_opts.append('topic=%s' % options.topic)
rmistry9eadede2016-09-19 11:22:43 -07002389
Edward Lemur687ca902018-12-05 02:30:30 +00002390 if options.enable_auto_submit:
2391 refspec_opts.append('l=Auto-Submit+1')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00002392 if options.set_bot_commit:
2393 refspec_opts.append('l=Bot-Commit+1')
Edward Lemur687ca902018-12-05 02:30:30 +00002394 if options.use_commit_queue:
2395 refspec_opts.append('l=Commit-Queue+2')
2396 elif options.cq_dry_run:
2397 refspec_opts.append('l=Commit-Queue+1')
2398
2399 if change_desc.get_reviewers(tbr_only=True):
2400 score = gerrit_util.GetCodeReviewTbrScore(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002401 self.GetGerritHost(),
2402 self.GetGerritProject())
Edward Lemur687ca902018-12-05 02:30:30 +00002403 refspec_opts.append('l=Code-Review+%s' % score)
Andrii Shyshkalove7a7fc42018-10-30 17:35:09 +00002404
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002405 # Gerrit sorts hashtags, so order is not important.
Nodir Turakulov23b82142017-11-16 11:04:25 -08002406 hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags}
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002407 if not self.GetIssue():
Nodir Turakulov23b82142017-11-16 11:04:25 -08002408 hashtags.update(change_desc.get_hash_tags())
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002409 refspec_opts += ['hashtag=%s' % t for t in sorted(hashtags)]
2410
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002411 refspec_suffix = ''
2412 if refspec_opts:
2413 refspec_suffix = '%' + ','.join(refspec_opts)
2414 assert ' ' not in refspec_suffix, (
2415 'spaces not allowed in refspec: "%s"' % refspec_suffix)
2416 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
2417
Edward Lemur1b52d872019-05-09 21:12:12 +00002418 git_push_metadata = {
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002419 'gerrit_host': self.GetGerritHost(),
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002420 'title': options.title or '<untitled>',
Edward Lemur1b52d872019-05-09 21:12:12 +00002421 'change_id': change_id,
2422 'description': change_desc.description,
2423 }
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002424 push_stdout = self._RunGitPushWithTraces(refspec, refspec_opts,
2425 git_push_metadata)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002426
2427 if options.squash:
Aaron Gable289b4312017-09-13 14:06:16 -07002428 regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002429 change_numbers = [m.group(1)
2430 for m in map(regex.match, push_stdout.splitlines())
2431 if m]
2432 if len(change_numbers) != 1:
2433 DieWithError(
2434 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
Christopher Lamf732cd52017-01-24 12:40:11 +11002435 'Change-Id: %s') % (len(change_numbers), change_id), change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002436 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002437 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002438
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002439 if self.GetIssue() and (reviewers or cc):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002440 # GetIssue() is not set in case of non-squash uploads according to tests.
Aaron Gable6e7ddb62020-05-27 22:23:29 +00002441 # TODO(crbug.com/751901): non-squash uploads in git cl should be removed.
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002442 gerrit_util.AddReviewers(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002443 self.GetGerritHost(),
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00002444 self._GerritChangeIdentifier(),
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002445 reviewers, cc,
2446 notify=bool(options.send_mail))
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002447
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002448 return 0
2449
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002450 def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force,
2451 change_desc):
2452 """Computes parent of the generated commit to be uploaded to Gerrit.
2453
2454 Returns revision or a ref name.
2455 """
2456 if custom_cl_base:
2457 # Try to avoid creating additional unintended CLs when uploading, unless
2458 # user wants to take this risk.
2459 local_ref_of_target_remote = self.GetRemoteBranch()[1]
2460 code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base,
2461 local_ref_of_target_remote])
2462 if code == 1:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002463 print('\nWARNING: Manually specified base of this CL `%s` '
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002464 'doesn\'t seem to belong to target remote branch `%s`.\n\n'
2465 'If you proceed with upload, more than 1 CL may be created by '
2466 'Gerrit as a result, in turn confusing or crashing git cl.\n\n'
2467 'If you are certain that specified base `%s` has already been '
2468 'uploaded to Gerrit as another CL, you may proceed.\n' %
2469 (custom_cl_base, local_ref_of_target_remote, custom_cl_base))
2470 if not force:
2471 confirm_or_exit(
2472 'Do you take responsibility for cleaning up potential mess '
2473 'resulting from proceeding with upload?',
2474 action='upload')
2475 return custom_cl_base
2476
Aaron Gablef97e33d2017-03-30 15:44:27 -07002477 if remote != '.':
2478 return self.GetCommonAncestorWithUpstream()
2479
2480 # If our upstream branch is local, we base our squashed commit on its
2481 # squashed version.
2482 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2483
Aaron Gablef97e33d2017-03-30 15:44:27 -07002484 if upstream_branch_name == 'master':
Aaron Gable0bbd1c22017-05-08 14:37:08 -07002485 return self.GetCommonAncestorWithUpstream()
Glen Robertson7d98e222020-08-27 17:53:11 +00002486 if upstream_branch_name == 'main':
2487 return self.GetCommonAncestorWithUpstream()
Aaron Gablef97e33d2017-03-30 15:44:27 -07002488
2489 # Check the squashed hash of the parent.
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002490 # TODO(tandrii): consider checking parent change in Gerrit and using its
2491 # hash if tree hash of latest parent revision (patchset) in Gerrit matches
2492 # the tree hash of the parent branch. The upside is less likely bogus
2493 # requests to reupload parent change just because it's uploadhash is
2494 # missing, yet the downside likely exists, too (albeit unknown to me yet).
Edward Lesmesa680c232020-03-31 18:26:44 +00002495 parent = scm.GIT.GetBranchConfig(
2496 settings.GetRoot(), upstream_branch_name, 'gerritsquashhash')
Aaron Gablef97e33d2017-03-30 15:44:27 -07002497 # Verify that the upstream branch has been uploaded too, otherwise
2498 # Gerrit will create additional CLs when uploading.
2499 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2500 RunGitSilent(['rev-parse', parent + ':'])):
2501 DieWithError(
2502 '\nUpload upstream branch %s first.\n'
2503 'It is likely that this branch has been rebased since its last '
2504 'upload, so you just need to upload it again.\n'
2505 '(If you uploaded it with --no-squash, then branch dependencies '
2506 'are not supported, and you should reupload with --squash.)'
2507 % upstream_branch_name,
2508 change_desc)
2509 return parent
2510
Edward Lemura12175c2020-03-09 16:58:26 +00002511 def _AddChangeIdToCommitMessage(self, log_desc, args):
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002512 """Re-commits using the current message, assumes the commit hook is in
2513 place.
2514 """
Edward Lemura12175c2020-03-09 16:58:26 +00002515 RunGit(['commit', '--amend', '-m', log_desc])
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002516 new_log_desc = _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002517 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002518 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002519 return new_log_desc
2520 else:
tandrii@chromium.orgb067ec52016-05-31 15:24:44 +00002521 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002522
tandriie113dfd2016-10-11 10:20:12 -07002523 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002524 try:
2525 data = self._GetChangeDetail()
Aaron Gablea45ee112016-11-22 15:14:38 -08002526 except GerritChangeNotExists:
2527 return 'Gerrit doesn\'t know about your change %s' % self.GetIssue()
tandrii8c5a3532016-11-04 07:52:02 -07002528
2529 if data['status'] in ('ABANDONED', 'MERGED'):
2530 return 'CL %s is closed' % self.GetIssue()
2531
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002532 def GetGerritChange(self, patchset=None):
2533 """Returns a buildbucket.v2.GerritChange message for the current issue."""
Edward Lemur79d4f992019-11-11 23:49:02 +00002534 host = urllib.parse.urlparse(self.GetCodereviewServer()).hostname
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002535 issue = self.GetIssue()
Edward Lemur2c210a42019-09-16 23:58:35 +00002536 patchset = int(patchset or self.GetPatchset())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002537 data = self._GetChangeDetail(['ALL_REVISIONS'])
2538
2539 assert host and issue and patchset, 'CL must be uploaded first'
2540
2541 has_patchset = any(
2542 int(revision_data['_number']) == patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002543 for revision_data in data['revisions'].values())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002544 if not has_patchset:
Aaron Gablea45ee112016-11-22 15:14:38 -08002545 raise Exception('Patchset %d is not known in Gerrit change %d' %
tandrii8c5a3532016-11-04 07:52:02 -07002546 (patchset, self.GetIssue()))
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002547
tandrii8c5a3532016-11-04 07:52:02 -07002548 return {
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002549 'host': host,
2550 'change': issue,
2551 'project': data['project'],
2552 'patchset': patchset,
tandrii8c5a3532016-11-04 07:52:02 -07002553 }
tandriie113dfd2016-10-11 10:20:12 -07002554
tandriide281ae2016-10-12 06:02:30 -07002555 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002556 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002557
Edward Lemur707d70b2018-02-07 00:50:14 +01002558 def GetReviewers(self):
2559 details = self._GetChangeDetail(['DETAILED_ACCOUNTS'])
Mohamed Heikal171c0742018-11-09 20:38:51 +00002560 return [r['email'] for r in details['reviewers'].get('REVIEWER', [])]
Edward Lemur707d70b2018-02-07 00:50:14 +01002561
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002562
Lei Zhang8a0efc12020-08-05 19:58:45 +00002563def _get_bug_line_values(default_project_prefix, bugs):
2564 """Given default_project_prefix and comma separated list of bugs, yields bug
2565 line values.
tandriif9aefb72016-07-01 09:06:51 -07002566
2567 Each bug can be either:
Lei Zhang8a0efc12020-08-05 19:58:45 +00002568 * a number, which is combined with default_project_prefix
tandriif9aefb72016-07-01 09:06:51 -07002569 * string, which is left as is.
2570
2571 This function may produce more than one line, because bugdroid expects one
2572 project per line.
2573
Lei Zhang8a0efc12020-08-05 19:58:45 +00002574 >>> list(_get_bug_line_values('v8:', '123,chromium:789'))
tandriif9aefb72016-07-01 09:06:51 -07002575 ['v8:123', 'chromium:789']
2576 """
2577 default_bugs = []
2578 others = []
2579 for bug in bugs.split(','):
2580 bug = bug.strip()
2581 if bug:
2582 try:
2583 default_bugs.append(int(bug))
2584 except ValueError:
2585 others.append(bug)
2586
2587 if default_bugs:
2588 default_bugs = ','.join(map(str, default_bugs))
Lei Zhang8a0efc12020-08-05 19:58:45 +00002589 if default_project_prefix:
2590 if not default_project_prefix.endswith(':'):
2591 default_project_prefix += ':'
2592 yield '%s%s' % (default_project_prefix, default_bugs)
tandriif9aefb72016-07-01 09:06:51 -07002593 else:
2594 yield default_bugs
2595 for other in sorted(others):
2596 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2597 yield other
2598
2599
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002600class ChangeDescription(object):
2601 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002602 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002603 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
Aaron Gable3a16ed12017-03-23 10:51:55 -07002604 BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$'
Dan Beamd8b04ca2019-10-10 21:23:26 +00002605 FIXED_LINE = r'^[ \t]*Fixed[ \t]*:[ \t]*(.*?)[ \t]*$'
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002606 CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002607 STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*'
2608 BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]'
Anthony Polito02b5af32019-12-02 19:49:47 +00002609 COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):($|[^:])'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002610 BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002611
Dan Beamd8b04ca2019-10-10 21:23:26 +00002612 def __init__(self, description, bug=None, fixed=None):
agable@chromium.org42c20792013-09-12 17:34:49 +00002613 self._description_lines = (description or '').strip().splitlines()
Anthony Polito8b955342019-09-24 19:01:36 +00002614 if bug:
2615 regexp = re.compile(self.BUG_LINE)
2616 prefix = settings.GetBugPrefix()
2617 if not any((regexp.match(line) for line in self._description_lines)):
2618 values = list(_get_bug_line_values(prefix, bug))
2619 self.append_footer('Bug: %s' % ', '.join(values))
Dan Beamd8b04ca2019-10-10 21:23:26 +00002620 if fixed:
2621 regexp = re.compile(self.FIXED_LINE)
2622 prefix = settings.GetBugPrefix()
2623 if not any((regexp.match(line) for line in self._description_lines)):
2624 values = list(_get_bug_line_values(prefix, fixed))
2625 self.append_footer('Fixed: %s' % ', '.join(values))
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002626
agable@chromium.org42c20792013-09-12 17:34:49 +00002627 @property # www.logilab.org/ticket/89786
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08002628 def description(self): # pylint: disable=method-hidden
agable@chromium.org42c20792013-09-12 17:34:49 +00002629 return '\n'.join(self._description_lines)
2630
2631 def set_description(self, desc):
2632 if isinstance(desc, basestring):
2633 lines = desc.splitlines()
2634 else:
2635 lines = [line.rstrip() for line in desc]
2636 while lines and not lines[0]:
2637 lines.pop(0)
2638 while lines and not lines[-1]:
2639 lines.pop(-1)
2640 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002641
Edward Lemur5a644f82020-03-18 16:44:57 +00002642 def ensure_change_id(self, change_id):
2643 description = self.description
2644 footer_change_ids = git_footers.get_footer_change_id(description)
2645 # Make sure that the Change-Id in the description matches the given one.
2646 if footer_change_ids != [change_id]:
2647 if footer_change_ids:
2648 # Remove any existing Change-Id footers since they don't match the
2649 # expected change_id footer.
2650 description = git_footers.remove_footer(description, 'Change-Id')
2651 print('WARNING: Change-Id has been set to %s. Use `git cl issue 0` '
2652 'if you want to set a new one.')
2653 # Add the expected Change-Id footer.
2654 description = git_footers.add_footer_change_id(description, change_id)
2655 self.set_description(description)
2656
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002657 def update_reviewers(self, reviewers, tbrs):
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002658 """Rewrites the R=/TBR= line(s) as a single line each.
2659
2660 Args:
2661 reviewers (list(str)) - list of additional emails to use for reviewers.
2662 tbrs (list(str)) - list of additional emails to use for TBRs.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002663 """
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002664 if not reviewers and not tbrs:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002665 return
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002666
2667 reviewers = set(reviewers)
2668 tbrs = set(tbrs)
2669 LOOKUP = {
2670 'TBR': tbrs,
2671 'R': reviewers,
2672 }
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002673
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002674 # Get the set of R= and TBR= lines and remove them from the description.
agable@chromium.org42c20792013-09-12 17:34:49 +00002675 regexp = re.compile(self.R_LINE)
2676 matches = [regexp.match(line) for line in self._description_lines]
2677 new_desc = [l for i, l in enumerate(self._description_lines)
2678 if not matches[i]]
2679 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002680
agable@chromium.org42c20792013-09-12 17:34:49 +00002681 # Construct new unified R= and TBR= lines.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002682
2683 # First, update tbrs/reviewers with names from the R=/TBR= lines (if any).
agable@chromium.org42c20792013-09-12 17:34:49 +00002684 for match in matches:
2685 if not match:
2686 continue
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002687 LOOKUP[match.group(1)].update(cleanup_list([match.group(2).strip()]))
2688
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002689 # If any folks ended up in both groups, remove them from tbrs.
2690 tbrs -= reviewers
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002691
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002692 new_r_line = 'R=' + ', '.join(sorted(reviewers)) if reviewers else None
2693 new_tbr_line = 'TBR=' + ', '.join(sorted(tbrs)) if tbrs else None
agable@chromium.org42c20792013-09-12 17:34:49 +00002694
2695 # Put the new lines in the description where the old first R= line was.
2696 line_loc = next((i for i, match in enumerate(matches) if match), -1)
2697 if 0 <= line_loc < len(self._description_lines):
2698 if new_tbr_line:
2699 self._description_lines.insert(line_loc, new_tbr_line)
2700 if new_r_line:
2701 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002702 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00002703 if new_r_line:
2704 self.append_footer(new_r_line)
2705 if new_tbr_line:
2706 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002707
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002708 def set_preserve_tryjobs(self):
2709 """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'."""
2710 footers = git_footers.parse_footers(self.description)
2711 for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []):
2712 if v.lower() == 'true':
2713 return
2714 self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true')
2715
Anthony Polito8b955342019-09-24 19:01:36 +00002716 def prompt(self):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002717 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002718 self.set_description([
2719 '# Enter a description of the change.',
2720 '# This will be displayed on the codereview site.',
2721 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00002722 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00002723 '--------------------',
2724 ] + self._description_lines)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002725 bug_regexp = re.compile(self.BUG_LINE)
2726 fixed_regexp = re.compile(self.FIXED_LINE)
Jonas Termansend0f79112019-03-22 15:28:26 +00002727 prefix = settings.GetBugPrefix()
Sigurd Schneider8630bb12020-11-11 14:02:49 +00002728 has_issue = lambda l: bug_regexp.match(l) or fixed_regexp.match(l)
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00002729
Dan Beamd8b04ca2019-10-10 21:23:26 +00002730 if not any((has_issue(line) for line in self._description_lines)):
Anthony Polito8b955342019-09-24 19:01:36 +00002731 self.append_footer('Bug: %s' % prefix)
tandriif9aefb72016-07-01 09:06:51 -07002732
Bruce Dawsonfc487042020-10-27 19:11:37 +00002733 print('Waiting for editor...')
agable@chromium.org42c20792013-09-12 17:34:49 +00002734 content = gclient_utils.RunEditor(self.description, True,
Edward Lemur79d4f992019-11-11 23:49:02 +00002735 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002736 if not content:
2737 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00002738 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002739
Bruce Dawson2377b012018-01-11 16:46:49 -08002740 # Strip off comments and default inserted "Bug:" line.
2741 clean_lines = [line.rstrip() for line in lines if not
Jonas Termansend0f79112019-03-22 15:28:26 +00002742 (line.startswith('#') or
2743 line.rstrip() == "Bug:" or
2744 line.rstrip() == "Bug: " + prefix)]
agable@chromium.org42c20792013-09-12 17:34:49 +00002745 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002746 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00002747 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002748
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002749 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00002750 """Adds a footer line to the description.
2751
2752 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
2753 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
2754 that Gerrit footers are always at the end.
2755 """
2756 parsed_footer_line = git_footers.parse_footer(line)
2757 if parsed_footer_line:
2758 # Line is a gerrit footer in the form: Footer-Key: any value.
2759 # Thus, must be appended observing Gerrit footer rules.
2760 self.set_description(
2761 git_footers.add_footer(self.description,
2762 key=parsed_footer_line[0],
2763 value=parsed_footer_line[1]))
2764 return
2765
2766 if not self._description_lines:
2767 self._description_lines.append(line)
2768 return
2769
2770 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
2771 if gerrit_footers:
2772 # git_footers.split_footers ensures that there is an empty line before
2773 # actual (gerrit) footers, if any. We have to keep it that way.
2774 assert top_lines and top_lines[-1] == ''
2775 top_lines, separator = top_lines[:-1], top_lines[-1:]
2776 else:
2777 separator = [] # No need for separator if there are no gerrit_footers.
2778
2779 prev_line = top_lines[-1] if top_lines else ''
2780 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
2781 not presubmit_support.Change.TAG_LINE_RE.match(line)):
2782 top_lines.append('')
2783 top_lines.append(line)
2784 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002785
tandrii99a72f22016-08-17 14:33:24 -07002786 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002787 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002788 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07002789 reviewers = [match.group(2).strip()
2790 for match in matches
2791 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002792 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002793
bradnelsond975b302016-10-23 12:20:23 -07002794 def get_cced(self):
2795 """Retrieves the list of reviewers."""
2796 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
2797 cced = [match.group(2).strip() for match in matches if match]
2798 return cleanup_list(cced)
2799
Nodir Turakulov23b82142017-11-16 11:04:25 -08002800 def get_hash_tags(self):
2801 """Extracts and sanitizes a list of Gerrit hashtags."""
2802 subject = (self._description_lines or ('',))[0]
2803 subject = re.sub(
2804 self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE)
2805
2806 tags = []
2807 start = 0
2808 bracket_exp = re.compile(self.BRACKET_HASH_TAG)
2809 while True:
2810 m = bracket_exp.match(subject, start)
2811 if not m:
2812 break
2813 tags.append(self.sanitize_hash_tag(m.group(1)))
2814 start = m.end()
2815
2816 if not tags:
2817 # Try "Tag: " prefix.
2818 m = re.match(self.COLON_SEPARATED_HASH_TAG, subject)
2819 if m:
2820 tags.append(self.sanitize_hash_tag(m.group(1)))
2821 return tags
2822
2823 @classmethod
2824 def sanitize_hash_tag(cls, tag):
2825 """Returns a sanitized Gerrit hash tag.
2826
2827 A sanitized hashtag can be used as a git push refspec parameter value.
2828 """
2829 return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower()
2830
maruel@chromium.orge52678e2013-04-26 18:34:44 +00002831
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002832def FindCodereviewSettingsFile(filename='codereview.settings'):
2833 """Finds the given file starting in the cwd and going up.
2834
2835 Only looks up to the top of the repository unless an
2836 'inherit-review-settings-ok' file exists in the root of the repository.
2837 """
2838 inherit_ok_file = 'inherit-review-settings-ok'
2839 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00002840 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002841 if os.path.isfile(os.path.join(root, inherit_ok_file)):
2842 root = '/'
2843 while True:
2844 if filename in os.listdir(cwd):
2845 if os.path.isfile(os.path.join(cwd, filename)):
2846 return open(os.path.join(cwd, filename))
2847 if cwd == root:
2848 break
2849 cwd = os.path.dirname(cwd)
2850
2851
2852def LoadCodereviewSettingsFromFile(fileobj):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002853 """Parses a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00002854 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002855
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002856 def SetProperty(name, setting, unset_error_ok=False):
2857 fullname = 'rietveld.' + name
2858 if setting in keyvals:
2859 RunGit(['config', fullname, keyvals[setting]])
2860 else:
2861 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
2862
tandrii48df5812016-10-17 03:55:37 -07002863 if not keyvals.get('GERRIT_HOST', False):
2864 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002865 # Only server setting is required. Other settings can be absent.
2866 # In that case, we ignore errors raised during option deletion attempt.
2867 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
2868 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
2869 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00002870 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00002871 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
2872 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00002873 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
2874 unset_error_ok=True)
Jamie Madilldc4d19e2019-10-24 21:50:02 +00002875 SetProperty(
2876 'format-full-by-default', 'FORMAT_FULL_BY_DEFAULT', unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002877
ukai@chromium.org7044efc2013-11-28 01:51:21 +00002878 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00002879 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00002880
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00002881 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
Edward Lesmes4de54132020-05-05 19:41:33 +00002882 RunGit(['config', 'gerrit.squash-uploads',
2883 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00002884
tandrii@chromium.org28253532016-04-14 13:46:56 +00002885 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00002886 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00002887 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
2888
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002889 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01002890 # should be of the form
2891 # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
2892 # ORIGIN_URL_CONFIG: http://src.chromium.org/git
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002893 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
2894 keyvals['ORIGIN_URL_CONFIG']])
2895
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002896
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002897def urlretrieve(source, destination):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002898 """Downloads a network object to a local file, like urllib.urlretrieve.
2899
2900 This is necessary because urllib is broken for SSL connections via a proxy.
2901 """
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002902 with open(destination, 'w') as f:
Edward Lemur79d4f992019-11-11 23:49:02 +00002903 f.write(urllib.request.urlopen(source).read())
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002904
2905
ukai@chromium.org712d6102013-11-27 00:52:58 +00002906def hasSheBang(fname):
2907 """Checks fname is a #! script."""
2908 with open(fname) as f:
2909 return f.read(2).startswith('#!')
2910
2911
tandrii@chromium.org18630d62016-03-04 12:06:02 +00002912def DownloadGerritHook(force):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002913 """Downloads and installs a Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002914
2915 Args:
2916 force: True to update hooks. False to install hooks if not present.
2917 """
ukai@chromium.org712d6102013-11-27 00:52:58 +00002918 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002919 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2920 if not os.access(dst, os.X_OK):
2921 if os.path.exists(dst):
2922 if not force:
2923 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002924 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002925 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00002926 if not hasSheBang(dst):
2927 DieWithError('Not a script: %s\n'
2928 'You need to download from\n%s\n'
2929 'into .git/hooks/commit-msg and '
2930 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002931 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
2932 except Exception:
2933 if os.path.exists(dst):
2934 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00002935 DieWithError('\nFailed to download hooks.\n'
2936 'You need to download from\n%s\n'
2937 'into .git/hooks/commit-msg and '
2938 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002939
2940
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002941class _GitCookiesChecker(object):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002942 """Provides facilities for validating and suggesting fixes to .gitcookies."""
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01002943
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01002944 _GOOGLESOURCE = 'googlesource.com'
2945
2946 def __init__(self):
2947 # Cached list of [host, identity, source], where source is either
2948 # .gitcookies or .netrc.
2949 self._all_hosts = None
2950
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002951 def ensure_configured_gitcookies(self):
2952 """Runs checks and suggests fixes to make git use .gitcookies from default
2953 path."""
2954 default = gerrit_util.CookiesAuthenticator.get_gitcookies_path()
2955 configured_path = RunGitSilent(
2956 ['config', '--global', 'http.cookiefile']).strip()
Andrii Shyshkalov1e250cd2017-05-10 15:39:31 +02002957 configured_path = os.path.expanduser(configured_path)
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002958 if configured_path:
2959 self._ensure_default_gitcookies_path(configured_path, default)
2960 else:
2961 self._configure_gitcookies_path(default)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01002962
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002963 @staticmethod
2964 def _ensure_default_gitcookies_path(configured_path, default_path):
2965 assert configured_path
2966 if configured_path == default_path:
2967 print('git is already configured to use your .gitcookies from %s' %
2968 configured_path)
2969 return
2970
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002971 print('WARNING: You have configured custom path to .gitcookies: %s\n'
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002972 'Gerrit and other depot_tools expect .gitcookies at %s\n' %
2973 (configured_path, default_path))
2974
2975 if not os.path.exists(configured_path):
2976 print('However, your configured .gitcookies file is missing.')
2977 confirm_or_exit('Reconfigure git to use default .gitcookies?',
2978 action='reconfigure')
2979 RunGit(['config', '--global', 'http.cookiefile', default_path])
2980 return
2981
2982 if os.path.exists(default_path):
2983 print('WARNING: default .gitcookies file already exists %s' %
2984 default_path)
2985 DieWithError('Please delete %s manually and re-run git cl creds-check' %
2986 default_path)
2987
2988 confirm_or_exit('Move existing .gitcookies to default location?',
2989 action='move')
2990 shutil.move(configured_path, default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01002991 RunGit(['config', '--global', 'http.cookiefile', default_path])
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002992 print('Moved and reconfigured git to use .gitcookies from %s' %
2993 default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01002994
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002995 @staticmethod
2996 def _configure_gitcookies_path(default_path):
2997 netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path()
2998 if os.path.exists(netrc_path):
2999 print('You seem to be using outdated .netrc for git credentials: %s' %
3000 netrc_path)
3001 print('This tool will guide you through setting up recommended '
3002 '.gitcookies store for git credentials.\n'
3003 '\n'
3004 'IMPORTANT: If something goes wrong and you decide to go back, do:\n'
3005 ' git config --global --unset http.cookiefile\n'
3006 ' mv %s %s.backup\n\n' % (default_path, default_path))
3007 confirm_or_exit(action='setup .gitcookies')
3008 RunGit(['config', '--global', 'http.cookiefile', default_path])
3009 print('Configured git to use .gitcookies from %s' % default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003010
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003011 def get_hosts_with_creds(self, include_netrc=False):
3012 if self._all_hosts is None:
3013 a = gerrit_util.CookiesAuthenticator()
3014 self._all_hosts = [
3015 (h, u, s)
3016 for h, u, s in itertools.chain(
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003017 ((h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.items()),
3018 ((h, u, '.gitcookies') for h, (u, _) in a.gitcookies.items())
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003019 )
3020 if h.endswith(self._GOOGLESOURCE)
3021 ]
3022
3023 if include_netrc:
3024 return self._all_hosts
3025 return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc']
3026
3027 def print_current_creds(self, include_netrc=False):
3028 hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc))
3029 if not hosts:
3030 print('No Git/Gerrit credentials found')
3031 return
Edward Lemur79d4f992019-11-11 23:49:02 +00003032 lengths = [max(map(len, (row[i] for row in hosts))) for i in range(3)]
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003033 header = [('Host', 'User', 'Which file'),
3034 ['=' * l for l in lengths]]
3035 for row in (header + hosts):
3036 print('\t'.join((('%%+%ds' % l) % s)
3037 for l, s in zip(lengths, row)))
3038
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003039 @staticmethod
3040 def _parse_identity(identity):
Lei Zhangd3f769a2017-12-15 15:16:14 -08003041 """Parses identity "git-<username>.domain" into <username> and domain."""
3042 # Special case: usernames that contain ".", which are generally not
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02003043 # distinguishable from sub-domains. But we do know typical domains:
3044 if identity.endswith('.chromium.org'):
3045 domain = 'chromium.org'
3046 username = identity[:-len('.chromium.org')]
3047 else:
3048 username, domain = identity.split('.', 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003049 if username.startswith('git-'):
3050 username = username[len('git-'):]
3051 return username, domain
3052
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003053 def _canonical_git_googlesource_host(self, host):
3054 """Normalizes Gerrit hosts (with '-review') to Git host."""
3055 assert host.endswith(self._GOOGLESOURCE)
3056 # Prefix doesn't include '.' at the end.
3057 prefix = host[:-(1 + len(self._GOOGLESOURCE))]
3058 if prefix.endswith('-review'):
3059 prefix = prefix[:-len('-review')]
3060 return prefix + '.' + self._GOOGLESOURCE
3061
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003062 def _canonical_gerrit_googlesource_host(self, host):
3063 git_host = self._canonical_git_googlesource_host(host)
3064 prefix = git_host.split('.', 1)[0]
3065 return prefix + '-review.' + self._GOOGLESOURCE
3066
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003067 def _get_counterpart_host(self, host):
3068 assert host.endswith(self._GOOGLESOURCE)
3069 git = self._canonical_git_googlesource_host(host)
3070 gerrit = self._canonical_gerrit_googlesource_host(git)
3071 return git if gerrit == host else gerrit
3072
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003073 def has_generic_host(self):
3074 """Returns whether generic .googlesource.com has been configured.
3075
3076 Chrome Infra recommends to use explicit ${host}.googlesource.com instead.
3077 """
3078 for host, _, _ in self.get_hosts_with_creds(include_netrc=False):
3079 if host == '.' + self._GOOGLESOURCE:
3080 return True
3081 return False
3082
3083 def _get_git_gerrit_identity_pairs(self):
3084 """Returns map from canonic host to pair of identities (Git, Gerrit).
3085
3086 One of identities might be None, meaning not configured.
3087 """
3088 host_to_identity_pairs = {}
3089 for host, identity, _ in self.get_hosts_with_creds():
3090 canonical = self._canonical_git_googlesource_host(host)
3091 pair = host_to_identity_pairs.setdefault(canonical, [None, None])
3092 idx = 0 if canonical == host else 1
3093 pair[idx] = identity
3094 return host_to_identity_pairs
3095
3096 def get_partially_configured_hosts(self):
3097 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003098 (host if i1 else self._canonical_gerrit_googlesource_host(host))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003099 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003100 if None in (i1, i2) and host != '.' + self._GOOGLESOURCE)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003101
3102 def get_conflicting_hosts(self):
3103 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003104 host
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003105 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003106 if None not in (i1, i2) and i1 != i2)
3107
3108 def get_duplicated_hosts(self):
3109 counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds())
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003110 return set(host for host, count in counters.items() if count > 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003111
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003112
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003113 @staticmethod
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003114 def _format_hosts(hosts, extra_column_func=None):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003115 hosts = sorted(hosts)
3116 assert hosts
3117 if extra_column_func is None:
3118 extras = [''] * len(hosts)
3119 else:
3120 extras = [extra_column_func(host) for host in hosts]
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003121 tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras)))
3122 lines = []
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003123 for he in zip(hosts, extras):
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003124 lines.append(tmpl % he)
3125 return lines
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003126
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003127 def _find_problems(self):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003128 if self.has_generic_host():
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003129 yield ('.googlesource.com wildcard record detected',
3130 ['Chrome Infrastructure team recommends to list full host names '
3131 'explicitly.'],
3132 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003133
3134 dups = self.get_duplicated_hosts()
3135 if dups:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003136 yield ('The following hosts were defined twice',
3137 self._format_hosts(dups),
3138 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003139
3140 partial = self.get_partially_configured_hosts()
3141 if partial:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003142 yield ('Credentials should come in pairs for Git and Gerrit hosts. '
3143 'These hosts are missing',
3144 self._format_hosts(partial, lambda host: 'but %s defined' %
3145 self._get_counterpart_host(host)),
3146 partial)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003147
3148 conflicting = self.get_conflicting_hosts()
3149 if conflicting:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003150 yield ('The following Git hosts have differing credentials from their '
3151 'Gerrit counterparts',
3152 self._format_hosts(conflicting, lambda host: '%s vs %s' %
3153 tuple(self._get_git_gerrit_identity_pairs()[host])),
3154 conflicting)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003155
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003156 def find_and_report_problems(self):
3157 """Returns True if there was at least one problem, else False."""
3158 found = False
3159 bad_hosts = set()
3160 for title, sublines, hosts in self._find_problems():
3161 if not found:
3162 found = True
3163 print('\n\n.gitcookies problem report:\n')
3164 bad_hosts.update(hosts or [])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003165 print(' %s%s' % (title, (':' if sublines else '')))
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003166 if sublines:
3167 print()
3168 print(' %s' % '\n '.join(sublines))
3169 print()
3170
3171 if bad_hosts:
3172 assert found
3173 print(' You can manually remove corresponding lines in your %s file and '
3174 'visit the following URLs with correct account to generate '
3175 'correct credential lines:\n' %
3176 gerrit_util.CookiesAuthenticator.get_gitcookies_path())
3177 print(' %s' % '\n '.join(sorted(set(
3178 gerrit_util.CookiesAuthenticator().get_new_password_url(
3179 self._canonical_git_googlesource_host(host))
3180 for host in bad_hosts
3181 ))))
3182 return found
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003183
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003184
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003185@metrics.collector.collect_metrics('git cl creds-check')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003186def CMDcreds_check(parser, args):
3187 """Checks credentials and suggests changes."""
3188 _, _ = parser.parse_args(args)
3189
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003190 # Code below checks .gitcookies. Abort if using something else.
3191 authn = gerrit_util.Authenticator.get()
3192 if not isinstance(authn, gerrit_util.CookiesAuthenticator):
Edward Lemur57d47422020-03-06 20:43:07 +00003193 message = (
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003194 'This command is not designed for bot environment. It checks '
3195 '~/.gitcookies file not generally used on bots.')
Edward Lemur57d47422020-03-06 20:43:07 +00003196 # TODO(crbug.com/1059384): Automatically detect when running on cloudtop.
3197 if isinstance(authn, gerrit_util.GceAuthenticator):
3198 message += (
3199 '\n'
3200 'If you need to run this on GCE or a cloudtop instance, '
3201 'export SKIP_GCE_AUTH_FOR_GIT=1 in your env.')
3202 DieWithError(message)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003203
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003204 checker = _GitCookiesChecker()
3205 checker.ensure_configured_gitcookies()
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003206
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003207 print('Your .netrc and .gitcookies have credentials for these hosts:')
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003208 checker.print_current_creds(include_netrc=True)
3209
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003210 if not checker.find_and_report_problems():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003211 print('\nNo problems detected in your .gitcookies file.')
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003212 return 0
3213 return 1
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003214
3215
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003216@metrics.collector.collect_metrics('git cl baseurl')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003217def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003218 """Gets or sets base-url for this branch."""
Edward Lesmes50da7702020-03-30 19:23:43 +00003219 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
Edward Lemur85153282020-02-14 22:06:29 +00003220 branch = scm.GIT.ShortBranchName(branchref)
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003221 _, args = parser.parse_args(args)
3222 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003223 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003224 return RunGit(['config', 'branch.%s.base-url' % branch],
3225 error_ok=False).strip()
3226 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003227 print('Setting base-url to %s' % args[0])
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003228 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3229 error_ok=False).strip()
3230
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003231
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003232def color_for_status(status):
3233 """Maps a Changelist status to color, for CMDstatus and other tools."""
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003234 BOLD = '\033[1m'
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003235 return {
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003236 'unsent': BOLD + Fore.YELLOW,
3237 'waiting': BOLD + Fore.RED,
3238 'reply': BOLD + Fore.YELLOW,
3239 'not lgtm': BOLD + Fore.RED,
3240 'lgtm': BOLD + Fore.GREEN,
3241 'commit': BOLD + Fore.MAGENTA,
3242 'closed': BOLD + Fore.CYAN,
3243 'error': BOLD + Fore.WHITE,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003244 }.get(status, Fore.WHITE)
3245
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003246
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003247def get_cl_statuses(changes, fine_grained, max_processes=None):
3248 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003249
3250 If fine_grained is true, this will fetch CL statuses from the server.
3251 Otherwise, simply indicate if there's a matching url for the given branches.
3252
3253 If max_processes is specified, it is used as the maximum number of processes
3254 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3255 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003256
3257 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003258 """
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003259 if not changes:
Edward Lemur61bf4172020-02-24 23:22:37 +00003260 return
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003261
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003262 if not fine_grained:
3263 # Fast path which doesn't involve querying codereview servers.
Aaron Gablea1bab272017-04-11 16:38:18 -07003264 # Do not use get_approving_reviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003265 for cl in changes:
3266 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003267 return
3268
3269 # First, sort out authentication issues.
3270 logging.debug('ensuring credentials exist')
3271 for cl in changes:
3272 cl.EnsureAuthenticated(force=False, refresh=True)
3273
3274 def fetch(cl):
3275 try:
3276 return (cl, cl.GetStatus())
3277 except:
3278 # See http://crbug.com/629863.
Andrii Shyshkalov98824232018-04-19 11:37:15 -07003279 logging.exception('failed to fetch status for cl %s:', cl.GetIssue())
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003280 raise
3281
3282 threads_count = len(changes)
3283 if max_processes:
3284 threads_count = max(1, min(threads_count, max_processes))
3285 logging.debug('querying %d CLs using %d threads', len(changes), threads_count)
3286
Edward Lemur61bf4172020-02-24 23:22:37 +00003287 pool = multiprocessing.pool.ThreadPool(threads_count)
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003288 fetched_cls = set()
3289 try:
3290 it = pool.imap_unordered(fetch, changes).__iter__()
3291 while True:
3292 try:
3293 cl, status = it.next(timeout=5)
Edward Lemur61bf4172020-02-24 23:22:37 +00003294 except (multiprocessing.TimeoutError, StopIteration):
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003295 break
3296 fetched_cls.add(cl)
3297 yield cl, status
3298 finally:
3299 pool.close()
3300
3301 # Add any branches that failed to fetch.
3302 for cl in set(changes) - fetched_cls:
3303 yield (cl, 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003304
rmistry@google.com2dd99862015-06-22 12:22:18 +00003305
Jose Lopes3863fc52020-04-07 17:00:25 +00003306def upload_branch_deps(cl, args, force=False):
rmistry@google.com2dd99862015-06-22 12:22:18 +00003307 """Uploads CLs of local branches that are dependents of the current branch.
3308
3309 If the local branch dependency tree looks like:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003310
3311 test1 -> test2.1 -> test3.1
3312 -> test3.2
3313 -> test2.2 -> test3.3
rmistry@google.com2dd99862015-06-22 12:22:18 +00003314
3315 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3316 run on the dependent branches in this order:
3317 test2.1, test3.1, test3.2, test2.2, test3.3
3318
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003319 Note: This function does not rebase your local dependent branches. Use it
3320 when you make a change to the parent branch that will not conflict
3321 with its dependent branches, and you would like their dependencies
3322 updated in Rietveld.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003323 """
3324 if git_common.is_dirty_git_tree('upload-branch-deps'):
3325 return 1
3326
3327 root_branch = cl.GetBranch()
3328 if root_branch is None:
3329 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3330 'Get on a branch!')
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00003331 if not cl.GetIssue():
rmistry@google.com2dd99862015-06-22 12:22:18 +00003332 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3333 'patchset dependencies without an uploaded CL.')
3334
3335 branches = RunGit(['for-each-ref',
3336 '--format=%(refname:short) %(upstream:short)',
3337 'refs/heads'])
3338 if not branches:
3339 print('No local branches found.')
3340 return 0
3341
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003342 # Create a dictionary of all local branches to the branches that are
3343 # dependent on it.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003344 tracked_to_dependents = collections.defaultdict(list)
3345 for b in branches.splitlines():
3346 tokens = b.split()
3347 if len(tokens) == 2:
3348 branch_name, tracked = tokens
3349 tracked_to_dependents[tracked].append(branch_name)
3350
vapiera7fbd5a2016-06-16 09:17:49 -07003351 print()
3352 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003353 dependents = []
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003354
rmistry@google.com2dd99862015-06-22 12:22:18 +00003355 def traverse_dependents_preorder(branch, padding=''):
3356 dependents_to_process = tracked_to_dependents.get(branch, [])
3357 padding += ' '
3358 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003359 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003360 dependents.append(dependent)
3361 traverse_dependents_preorder(dependent, padding)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003362
rmistry@google.com2dd99862015-06-22 12:22:18 +00003363 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003364 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003365
3366 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003367 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003368 return 0
3369
Jose Lopes3863fc52020-04-07 17:00:25 +00003370 if not force:
3371 confirm_or_exit('This command will checkout all dependent branches and run '
3372 '"git cl upload".', action='continue')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003373
rmistry@google.com2dd99862015-06-22 12:22:18 +00003374 # Record all dependents that failed to upload.
3375 failures = {}
3376 # Go through all dependents, checkout the branch and upload.
3377 try:
3378 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003379 print()
3380 print('--------------------------------------')
3381 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003382 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003383 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003384 try:
3385 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003386 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003387 failures[dependent_branch] = 1
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003388 except: # pylint: disable=bare-except
rmistry@google.com2dd99862015-06-22 12:22:18 +00003389 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003390 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003391 finally:
3392 # Swap back to the original root branch.
3393 RunGit(['checkout', '-q', root_branch])
3394
vapiera7fbd5a2016-06-16 09:17:49 -07003395 print()
3396 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003397 for dependent_branch in dependents:
3398 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003399 print(' %s : %s' % (dependent_branch, upload_status))
3400 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003401
3402 return 0
3403
3404
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003405def GetArchiveTagForBranch(issue_num, branch_name, existing_tags, pattern):
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003406 """Given a proposed tag name, returns a tag name that is guaranteed to be
3407 unique. If 'foo' is proposed but already exists, then 'foo-2' is used,
3408 or 'foo-3', and so on."""
3409
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003410 proposed_tag = pattern.format(**{'issue': issue_num, 'branch': branch_name})
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003411 for suffix_num in itertools.count(1):
3412 if suffix_num == 1:
3413 to_check = proposed_tag
3414 else:
3415 to_check = '%s-%d' % (proposed_tag, suffix_num)
3416
3417 if to_check not in existing_tags:
3418 return to_check
3419
3420
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003421@metrics.collector.collect_metrics('git cl archive')
kmarshall3bff56b2016-06-06 18:31:47 -07003422def CMDarchive(parser, args):
3423 """Archives and deletes branches associated with closed changelists."""
3424 parser.add_option(
3425 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003426 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003427 parser.add_option(
3428 '-f', '--force', action='store_true',
3429 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003430 parser.add_option(
3431 '-d', '--dry-run', action='store_true',
3432 help='Skip the branch tagging and removal steps.')
3433 parser.add_option(
3434 '-t', '--notags', action='store_true',
3435 help='Do not tag archived branches. '
3436 'Note: local commit history may be lost.')
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003437 parser.add_option(
3438 '-p',
3439 '--pattern',
3440 default='git-cl-archived-{issue}-{branch}',
3441 help='Format string for archive tags. '
3442 'E.g. \'archived-{issue}-{branch}\'.')
kmarshall3bff56b2016-06-06 18:31:47 -07003443
kmarshall3bff56b2016-06-06 18:31:47 -07003444 options, args = parser.parse_args(args)
3445 if args:
3446 parser.error('Unsupported args: %s' % ' '.join(args))
kmarshall3bff56b2016-06-06 18:31:47 -07003447
3448 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3449 if not branches:
3450 return 0
3451
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003452 tags = RunGit(['for-each-ref', '--format=%(refname)',
3453 'refs/tags']).splitlines() or []
3454 tags = [t.split('/')[-1] for t in tags]
3455
vapiera7fbd5a2016-06-16 09:17:49 -07003456 print('Finding all branches associated with closed issues...')
Edward Lemur934836a2019-09-09 20:16:54 +00003457 changes = [Changelist(branchref=b)
3458 for b in branches.splitlines()]
kmarshall3bff56b2016-06-06 18:31:47 -07003459 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3460 statuses = get_cl_statuses(changes,
3461 fine_grained=True,
3462 max_processes=options.maxjobs)
3463 proposal = [(cl.GetBranch(),
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003464 GetArchiveTagForBranch(cl.GetIssue(), cl.GetBranch(), tags,
3465 options.pattern))
kmarshall3bff56b2016-06-06 18:31:47 -07003466 for cl, status in statuses
Andrii Shyshkalov51bdf8c2018-10-18 01:07:58 +00003467 if status in ('closed', 'rietveld-not-supported')]
kmarshall3bff56b2016-06-06 18:31:47 -07003468 proposal.sort()
3469
3470 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003471 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003472 return 0
3473
Edward Lemur85153282020-02-14 22:06:29 +00003474 current_branch = scm.GIT.GetBranch(settings.GetRoot())
kmarshall3bff56b2016-06-06 18:31:47 -07003475
vapiera7fbd5a2016-06-16 09:17:49 -07003476 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003477 if options.notags:
3478 for next_item in proposal:
3479 print(' ' + next_item[0])
3480 else:
3481 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3482 for next_item in proposal:
3483 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003484
kmarshall9249e012016-08-23 12:02:16 -07003485 # Quit now on precondition failure or if instructed by the user, either
3486 # via an interactive prompt or by command line flags.
3487 if options.dry_run:
3488 print('\nNo changes were made (dry run).\n')
3489 return 0
3490 elif any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003491 print('You are currently on a branch \'%s\' which is associated with a '
3492 'closed codereview issue, so archive cannot proceed. Please '
3493 'checkout another branch and run this command again.' %
3494 current_branch)
3495 return 1
kmarshall9249e012016-08-23 12:02:16 -07003496 elif not options.force:
Edward Lesmesae3586b2020-03-23 21:21:14 +00003497 answer = gclient_utils.AskForData('\nProceed with deletion (Y/n)? ').lower()
sergiyb4a5ecbe2016-06-20 09:46:00 -07003498 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003499 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003500 return 1
3501
3502 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003503 if not options.notags:
3504 RunGit(['tag', tagname, branch])
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003505
3506 if RunGitWithCode(['branch', '-D', branch])[0] != 0:
3507 # Clean up the tag if we failed to delete the branch.
3508 RunGit(['tag', '-d', tagname])
kmarshall9249e012016-08-23 12:02:16 -07003509
vapiera7fbd5a2016-06-16 09:17:49 -07003510 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003511
3512 return 0
3513
3514
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003515@metrics.collector.collect_metrics('git cl status')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003516def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003517 """Show status of changelists.
3518
3519 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003520 - Blue waiting for review
Aaron Gable9ab38c62017-04-06 14:36:33 -07003521 - Yellow waiting for you to reply to review, or not yet sent
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003522 - Green LGTM'ed
Aaron Gable9ab38c62017-04-06 14:36:33 -07003523 - Red 'not LGTM'ed
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00003524 - Magenta in the CQ
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003525 - Cyan was committed, branch can be deleted
Aaron Gable9ab38c62017-04-06 14:36:33 -07003526 - White error, or unknown status
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003527
3528 Also see 'git cl comments'.
3529 """
Alan Cuttera3be9a52019-03-04 18:50:33 +00003530 parser.add_option(
3531 '--no-branch-color',
3532 action='store_true',
3533 help='Disable colorized branch names')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003534 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003535 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003536 parser.add_option('-f', '--fast', action='store_true',
3537 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003538 parser.add_option(
3539 '-j', '--maxjobs', action='store', type=int,
3540 help='The maximum number of jobs to use when retrieving review status')
Edward Lemur52969c92020-02-06 18:15:28 +00003541 parser.add_option(
3542 '-i', '--issue', type=int,
3543 help='Operate on this issue instead of the current branch\'s implicit '
3544 'issue. Requires --field to be set.')
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003545 parser.add_option('-d',
3546 '--date-order',
3547 action='store_true',
3548 help='Order branches by committer date.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003549 options, args = parser.parse_args(args)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003550 if args:
3551 parser.error('Unsupported args: %s' % args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003552
iannuccie53c9352016-08-17 14:40:40 -07003553 if options.issue is not None and not options.field:
Edward Lemur6c6827c2020-02-06 21:15:18 +00003554 parser.error('--field must be given when --issue is set.')
iannucci3c972b92016-08-17 13:24:10 -07003555
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003556 if options.field:
Edward Lemur934836a2019-09-09 20:16:54 +00003557 cl = Changelist(issue=options.issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003558 if options.field.startswith('desc'):
Edward Lemur6c6827c2020-02-06 21:15:18 +00003559 if cl.GetIssue():
3560 print(cl.FetchDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003561 elif options.field == 'id':
3562 issueid = cl.GetIssue()
3563 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07003564 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003565 elif options.field == 'patch':
Aaron Gablee8856ee2017-12-07 12:41:46 -08003566 patchset = cl.GetMostRecentPatchset()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003567 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07003568 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07003569 elif options.field == 'status':
3570 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003571 elif options.field == 'url':
3572 url = cl.GetIssueURL()
3573 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07003574 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003575 return 0
3576
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003577 branches = RunGit([
3578 'for-each-ref', '--format=%(refname) %(committerdate:unix)', 'refs/heads'
3579 ])
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003580 if not branches:
3581 print('No local branch found.')
3582 return 0
3583
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003584 changes = [
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003585 Changelist(branchref=b, commit_date=ct)
3586 for b, ct in map(lambda line: line.split(' '), branches.splitlines())
3587 ]
vapiera7fbd5a2016-06-16 09:17:49 -07003588 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003589 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003590 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003591 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003592
Edward Lemur85153282020-02-14 22:06:29 +00003593 current_branch = scm.GIT.GetBranch(settings.GetRoot())
Daniel McArdlea23bf592019-02-12 00:25:12 +00003594
3595 def FormatBranchName(branch, colorize=False):
3596 """Simulates 'git branch' behavior. Colorizes and prefixes branch name with
3597 an asterisk when it is the current branch."""
3598
3599 asterisk = ""
3600 color = Fore.RESET
3601 if branch == current_branch:
3602 asterisk = "* "
3603 color = Fore.GREEN
Edward Lemur85153282020-02-14 22:06:29 +00003604 branch_name = scm.GIT.ShortBranchName(branch)
Daniel McArdlea23bf592019-02-12 00:25:12 +00003605
3606 if colorize:
3607 return asterisk + color + branch_name + Fore.RESET
Daniel McArdle452a49f2019-02-14 17:28:31 +00003608 return asterisk + branch_name
3609
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003610 branch_statuses = {}
Daniel McArdlea23bf592019-02-12 00:25:12 +00003611
3612 alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes))
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003613 if options.date_order:
3614 sorted_changes = sorted(changes,
3615 key=lambda c: c.GetCommitDate(),
3616 reverse=True)
3617 else:
3618 sorted_changes = sorted(changes, key=lambda c: c.GetBranch())
3619 for cl in sorted_changes:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003620 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003621 while branch not in branch_statuses:
Edward Lemur79d4f992019-11-11 23:49:02 +00003622 c, status = next(output)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003623 branch_statuses[c.GetBranch()] = status
3624 status = branch_statuses.pop(branch)
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00003625 url = cl.GetIssueURL(short=True)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003626 if url and (not status or status == 'error'):
3627 # The issue probably doesn't exist anymore.
3628 url += ' (broken)'
3629
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003630 color = color_for_status(status)
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003631 # Turn off bold as well as colors.
3632 END = '\033[0m'
3633 reset = Fore.RESET + END
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00003634 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00003635 color = ''
3636 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003637 status_str = '(%s)' % status if status else ''
Daniel McArdle452a49f2019-02-14 17:28:31 +00003638
Alan Cuttera3be9a52019-03-04 18:50:33 +00003639 branch_display = FormatBranchName(branch)
3640 padding = ' ' * (alignment - len(branch_display))
3641 if not options.no_branch_color:
3642 branch_display = FormatBranchName(branch, colorize=True)
Daniel McArdle452a49f2019-02-14 17:28:31 +00003643
Alan Cuttera3be9a52019-03-04 18:50:33 +00003644 print(' %s : %s%s %s%s' % (padding + branch_display, color, url,
3645 status_str, reset))
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003646
vapiera7fbd5a2016-06-16 09:17:49 -07003647 print()
Daniel McArdlea23bf592019-02-12 00:25:12 +00003648 print('Current branch: %s' % current_branch)
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003649 for cl in changes:
Daniel McArdlea23bf592019-02-12 00:25:12 +00003650 if cl.GetBranch() == current_branch:
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003651 break
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003652 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07003653 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003654 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07003655 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00003656 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07003657 print('Issue description:')
Edward Lemur6c6827c2020-02-06 21:15:18 +00003658 print(cl.FetchDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003659 return 0
3660
3661
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003662def colorize_CMDstatus_doc():
3663 """To be called once in main() to add colors to git cl status help."""
3664 colors = [i for i in dir(Fore) if i[0].isupper()]
3665
3666 def colorize_line(line):
3667 for color in colors:
3668 if color in line.upper():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003669 # Extract whitespace first and the leading '-'.
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003670 indent = len(line) - len(line.lstrip(' ')) + 1
3671 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
3672 return line
3673
3674 lines = CMDstatus.__doc__.splitlines()
3675 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
3676
3677
phajdan.jre328cf92016-08-22 04:12:17 -07003678def write_json(path, contents):
Stefan Zager1306bd02017-06-22 19:26:46 -07003679 if path == '-':
3680 json.dump(contents, sys.stdout)
3681 else:
3682 with open(path, 'w') as f:
3683 json.dump(contents, f)
phajdan.jre328cf92016-08-22 04:12:17 -07003684
3685
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003686@subcommand.usage('[issue_number]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003687@metrics.collector.collect_metrics('git cl issue')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003688def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003689 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003690
3691 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003692 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00003693 parser.add_option('-r', '--reverse', action='store_true',
3694 help='Lookup the branch(es) for the specified issues. If '
3695 'no issues are specified, all branches with mapped '
3696 'issues will be listed.')
Stefan Zager1306bd02017-06-22 19:26:46 -07003697 parser.add_option('--json',
3698 help='Path to JSON output file, or "-" for stdout.')
dnj@chromium.org406c4402015-03-03 17:22:28 +00003699 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003700
dnj@chromium.org406c4402015-03-03 17:22:28 +00003701 if options.reverse:
3702 branches = RunGit(['for-each-ref', 'refs/heads',
Aaron Gablead64abd2017-12-04 09:49:13 -08003703 '--format=%(refname)']).splitlines()
dnj@chromium.org406c4402015-03-03 17:22:28 +00003704 # Reverse issue lookup.
3705 issue_branch_map = {}
Daniel Bratellb56a43a2018-09-06 15:49:03 +00003706
3707 git_config = {}
3708 for config in RunGit(['config', '--get-regexp',
3709 r'branch\..*issue']).splitlines():
3710 name, _space, val = config.partition(' ')
3711 git_config[name] = val
3712
dnj@chromium.org406c4402015-03-03 17:22:28 +00003713 for branch in branches:
Edward Lesmes50da7702020-03-30 19:23:43 +00003714 issue = git_config.get(
3715 'branch.%s.%s' % (scm.GIT.ShortBranchName(branch), ISSUE_CONFIG_KEY))
Edward Lemur52969c92020-02-06 18:15:28 +00003716 if issue:
3717 issue_branch_map.setdefault(int(issue), []).append(branch)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003718 if not args:
Carlos Caballero81923d62020-07-06 18:22:27 +00003719 args = sorted(issue_branch_map.keys())
phajdan.jre328cf92016-08-22 04:12:17 -07003720 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00003721 for issue in args:
Lei Zhang5a368d42019-03-25 23:18:19 +00003722 try:
3723 issue_num = int(issue)
3724 except ValueError:
3725 print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003726 continue
Lei Zhang5a368d42019-03-25 23:18:19 +00003727 result[issue_num] = issue_branch_map.get(issue_num)
vapiera7fbd5a2016-06-16 09:17:49 -07003728 print('Branch for issue number %s: %s' % (
Lei Zhang5a368d42019-03-25 23:18:19 +00003729 issue, ', '.join(issue_branch_map.get(issue_num) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07003730 if options.json:
3731 write_json(options.json, result)
Aaron Gable78753da2017-06-15 10:35:49 -07003732 return 0
3733
3734 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003735 issue = ParseIssueNumberArgument(args[0])
Aaron Gable78753da2017-06-15 10:35:49 -07003736 if not issue.valid:
3737 DieWithError('Pass a url or number to set the issue, 0 to unset it, '
3738 'or no argument to list it.\n'
3739 'Maybe you want to run git cl status?')
Edward Lemurf38bc172019-09-03 21:02:13 +00003740 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003741 cl.SetIssue(issue.issue)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003742 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003743 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003744 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
3745 if options.json:
3746 write_json(options.json, {
3747 'issue': cl.GetIssue(),
3748 'issue_url': cl.GetIssueURL(),
3749 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003750 return 0
3751
3752
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003753@metrics.collector.collect_metrics('git cl comments')
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003754def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003755 """Shows or posts review comments for any changelist."""
3756 parser.add_option('-a', '--add-comment', dest='comment',
3757 help='comment to add to an issue')
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003758 parser.add_option('-p', '--publish', action='store_true',
3759 help='marks CL as ready and sends comment to reviewers')
Andrii Shyshkalov0d6b46e2017-03-17 22:23:22 +01003760 parser.add_option('-i', '--issue', dest='issue',
Edward Lemurf38bc172019-09-03 21:02:13 +00003761 help='review issue id (defaults to current issue).')
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003762 parser.add_option('-m', '--machine-readable', dest='readable',
3763 action='store_false', default=True,
3764 help='output comments in a format compatible with '
3765 'editor parsing')
smut@google.comc85ac942015-09-15 16:34:43 +00003766 parser.add_option('-j', '--json-file',
Stefan Zager1306bd02017-06-22 19:26:46 -07003767 help='File to write JSON summary to, or "-" for stdout')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003768 options, args = parser.parse_args(args)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003769
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003770 issue = None
3771 if options.issue:
3772 try:
3773 issue = int(options.issue)
3774 except ValueError:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003775 DieWithError('A review issue ID is expected to be a number.')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003776
Edward Lemur934836a2019-09-09 20:16:54 +00003777 cl = Changelist(issue=issue)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003778
3779 if options.comment:
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003780 cl.AddComment(options.comment, options.publish)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003781 return 0
3782
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003783 summary = sorted(cl.GetCommentsSummary(readable=options.readable),
3784 key=lambda c: c.date)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003785 for comment in summary:
3786 if comment.disapproval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003787 color = Fore.RED
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003788 elif comment.approval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003789 color = Fore.GREEN
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003790 elif comment.sender == cl.GetIssueOwner():
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003791 color = Fore.MAGENTA
Quinten Yearsley0e617c02019-02-20 00:37:03 +00003792 elif comment.autogenerated:
3793 color = Fore.CYAN
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003794 else:
3795 color = Fore.BLUE
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003796 print('\n%s%s %s%s\n%s' % (
3797 color,
3798 comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'),
3799 comment.sender,
3800 Fore.RESET,
3801 '\n'.join(' ' + l for l in comment.message.strip().splitlines())))
3802
smut@google.comc85ac942015-09-15 16:34:43 +00003803 if options.json_file:
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003804 def pre_serialize(c):
Edward Lemur79d4f992019-11-11 23:49:02 +00003805 dct = c._asdict().copy()
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003806 dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f')
3807 return dct
Edward Lemur79d4f992019-11-11 23:49:02 +00003808 write_json(options.json_file, [pre_serialize(x) for x in summary])
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003809 return 0
3810
3811
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003812@subcommand.usage('[codereview url or issue id]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003813@metrics.collector.collect_metrics('git cl description')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003814def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003815 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00003816 parser.add_option('-d', '--display', action='store_true',
3817 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003818 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07003819 help='New description to set for this issue (- for stdin, '
3820 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07003821 parser.add_option('-f', '--force', action='store_true',
3822 help='Delete any unpublished Gerrit edits for this issue '
3823 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003824
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003825 options, args = parser.parse_args(args)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003826
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003827 target_issue_arg = None
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003828 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003829 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003830 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003831 parser.error('Invalid issue ID or URL.')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003832
Edward Lemur934836a2019-09-09 20:16:54 +00003833 kwargs = {}
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003834 if target_issue_arg:
3835 kwargs['issue'] = target_issue_arg.issue
3836 kwargs['codereview_host'] = target_issue_arg.hostname
martiniss6eda05f2016-06-30 10:18:35 -07003837
3838 cl = Changelist(**kwargs)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003839 if not cl.GetIssue():
3840 DieWithError('This branch has no associated changelist.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02003841
Edward Lemur678a6842019-10-03 22:25:05 +00003842 if args and not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00003843 logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02003844
Edward Lemur6c6827c2020-02-06 21:15:18 +00003845 description = ChangeDescription(cl.FetchDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003846
smut@google.com34fb6b12015-07-13 20:03:26 +00003847 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07003848 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00003849 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003850
3851 if options.new_description:
3852 text = options.new_description
3853 if text == '-':
3854 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07003855 elif text == '+':
3856 base_branch = cl.GetCommonAncestorWithUpstream()
Edward Lemura12175c2020-03-09 16:58:26 +00003857 text = _create_description_from_log([base_branch])
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003858
3859 description.set_description(text)
3860 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003861 description.prompt()
Edward Lemur6c6827c2020-02-06 21:15:18 +00003862 if cl.FetchDescription().strip() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07003863 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003864 return 0
3865
3866
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003867@metrics.collector.collect_metrics('git cl lint')
thestig@chromium.org44202a22014-03-11 19:22:18 +00003868def CMDlint(parser, args):
3869 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00003870 parser.add_option('--filter', action='append', metavar='-x,+y',
3871 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003872 options, args = parser.parse_args(args)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003873
3874 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003875 # pylint: disable=protected-access
thestig@chromium.org44202a22014-03-11 19:22:18 +00003876 try:
3877 import cpplint
3878 import cpplint_chromium
3879 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07003880 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00003881 return 1
3882
3883 # Change the current working directory before calling lint so that it
3884 # shows the correct base.
3885 previous_cwd = os.getcwd()
3886 os.chdir(settings.GetRoot())
3887 try:
Edward Lemur934836a2019-09-09 20:16:54 +00003888 cl = Changelist()
Edward Lemur2c62b332020-03-12 22:12:33 +00003889 files = cl.GetAffectedFiles(cl.GetCommonAncestorWithUpstream())
thestig@chromium.org5839eb52014-05-30 16:20:51 +00003890 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07003891 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00003892 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00003893
Lei Zhangb8c62cf2020-07-15 20:09:37 +00003894 # Process cpplint arguments, if any.
3895 filters = presubmit_canned_checks.GetCppLintFilters(options.filter)
3896 command = ['--filter=' + ','.join(filters)] + args + files
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00003897 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003898
Lei Zhang379d1ad2020-07-15 19:40:06 +00003899 include_regex = re.compile(settings.GetLintRegex())
3900 ignore_regex = re.compile(settings.GetLintIgnoreRegex())
thestig@chromium.org44202a22014-03-11 19:22:18 +00003901 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
3902 for filename in filenames:
Lei Zhang379d1ad2020-07-15 19:40:06 +00003903 if not include_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07003904 print('Skipping file %s' % filename)
Lei Zhang379d1ad2020-07-15 19:40:06 +00003905 continue
3906
3907 if ignore_regex.match(filename):
3908 print('Ignoring file %s' % filename)
3909 continue
3910
3911 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
3912 extra_check_functions)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003913 finally:
3914 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07003915 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003916 if cpplint._cpplint_state.error_count != 0:
3917 return 1
3918 return 0
3919
3920
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003921@metrics.collector.collect_metrics('git cl presubmit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003922def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003923 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00003924 parser.add_option('-u', '--upload', action='store_true',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08003925 help='Run upload hook instead of the push hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00003926 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00003927 help='Run checks even if tree is dirty')
Aaron Gable8076c282017-11-29 14:39:41 -08003928 parser.add_option('--all', action='store_true',
3929 help='Run checks against all files, not just modified ones')
Edward Lesmes8e282792018-04-03 18:50:29 -04003930 parser.add_option('--parallel', action='store_true',
3931 help='Run all tests specified by input_api.RunTests in all '
3932 'PRESUBMIT files in parallel.')
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00003933 parser.add_option('--resultdb', action='store_true',
3934 help='Run presubmit checks in the ResultSink environment '
3935 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00003936 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003937 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003938
sbc@chromium.org71437c02015-04-09 19:29:40 +00003939 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07003940 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003941 return 1
3942
Edward Lemur934836a2019-09-09 20:16:54 +00003943 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003944 if args:
3945 base_branch = args[0]
3946 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00003947 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00003948 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003949
Gregory Nisbet29d5cf82020-02-27 08:16:58 +00003950 if cl.GetIssue():
3951 description = cl.FetchDescription()
Aaron Gable8076c282017-11-29 14:39:41 -08003952 else:
Edward Lemura12175c2020-03-09 16:58:26 +00003953 description = _create_description_from_log([base_branch])
Aaron Gable8076c282017-11-29 14:39:41 -08003954
ilevy@chromium.org051ad0e2013-03-04 21:57:34 +00003955 cl.RunHook(
3956 committing=not options.upload,
3957 may_prompt=False,
3958 verbose=options.verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00003959 parallel=options.parallel,
3960 upstream=base_branch,
3961 description=description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00003962 all_files=options.all,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00003963 resultdb=options.resultdb,
3964 realm=options.realm)
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00003965 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003966
3967
tandrii@chromium.org65874e12016-03-04 12:03:02 +00003968def GenerateGerritChangeId(message):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003969 """Returns the Change ID footer value (Ixxxxxx...xxx).
tandrii@chromium.org65874e12016-03-04 12:03:02 +00003970
3971 Works the same way as
3972 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
3973 but can be called on demand on all platforms.
3974
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003975 The basic idea is to generate git hash of a state of the tree, original
3976 commit message, author/committer info and timestamps.
tandrii@chromium.org65874e12016-03-04 12:03:02 +00003977 """
3978 lines = []
3979 tree_hash = RunGitSilent(['write-tree'])
3980 lines.append('tree %s' % tree_hash.strip())
3981 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
3982 if code == 0:
3983 lines.append('parent %s' % parent.strip())
3984 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
3985 lines.append('author %s' % author.strip())
3986 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
3987 lines.append('committer %s' % committer.strip())
3988 lines.append('')
3989 # Note: Gerrit's commit-hook actually cleans message of some lines and
3990 # whitespace. This code is not doing this, but it clearly won't decrease
3991 # entropy.
3992 lines.append(message)
3993 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
Raul Tambreb946b232019-03-26 14:48:46 +00003994 stdin=('\n'.join(lines)).encode())
tandrii@chromium.org65874e12016-03-04 12:03:02 +00003995 return 'I%s' % change_hash.strip()
3996
3997
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01003998def GetTargetRef(remote, remote_branch, target_branch):
wittman@chromium.org455dc922015-01-26 20:15:50 +00003999 """Computes the remote branch ref to use for the CL.
4000
4001 Args:
4002 remote (str): The git remote for the CL.
4003 remote_branch (str): The git remote branch for the CL.
4004 target_branch (str): The target branch specified by the user.
wittman@chromium.org455dc922015-01-26 20:15:50 +00004005 """
4006 if not (remote and remote_branch):
4007 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004008
wittman@chromium.org455dc922015-01-26 20:15:50 +00004009 if target_branch:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004010 # Canonicalize branch references to the equivalent local full symbolic
wittman@chromium.org455dc922015-01-26 20:15:50 +00004011 # refs, which are then translated into the remote full symbolic refs
4012 # below.
4013 if '/' not in target_branch:
4014 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4015 else:
4016 prefix_replacements = (
4017 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4018 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4019 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4020 )
4021 match = None
4022 for regex, replacement in prefix_replacements:
4023 match = re.search(regex, target_branch)
4024 if match:
4025 remote_branch = target_branch.replace(match.group(0), replacement)
4026 break
4027 if not match:
4028 # This is a branch path but not one we recognize; use as-is.
4029 remote_branch = target_branch
rmistry@google.comc68112d2015-03-03 12:48:06 +00004030 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
4031 # Handle the refs that need to land in different refs.
4032 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004033
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004034 # Migration to new default branch, only if available on remote.
4035 allow_push_on_master = bool(os.environ.get("ALLOW_PUSH_TO_MASTER", None))
4036 if remote_branch == DEFAULT_OLD_BRANCH and not allow_push_on_master:
4037 if RunGit(['show-branch', DEFAULT_NEW_BRANCH], error_ok=True,
4038 stderr=subprocess2.PIPE):
4039 # TODO(crbug.com/ID): Print location to local git migration script.
4040 print("WARNING: Using new branch name %s instead of %s" % (
4041 DEFAULT_NEW_BRANCH, DEFAULT_OLD_BRANCH))
4042 remote_branch = DEFAULT_NEW_BRANCH
4043
wittman@chromium.org455dc922015-01-26 20:15:50 +00004044 # Create the true path to the remote branch.
4045 # Does the following translation:
4046 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004047 # * refs/remotes/origin/main -> refs/heads/main
wittman@chromium.org455dc922015-01-26 20:15:50 +00004048 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4049 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4050 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4051 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4052 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4053 'refs/heads/')
4054 elif remote_branch.startswith('refs/remotes/branch-heads'):
4055 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +01004056
wittman@chromium.org455dc922015-01-26 20:15:50 +00004057 return remote_branch
4058
4059
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004060def cleanup_list(l):
4061 """Fixes a list so that comma separated items are put as individual items.
4062
4063 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4064 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4065 """
4066 items = sum((i.split(',') for i in l), [])
4067 stripped_items = (i.strip() for i in items)
4068 return sorted(filter(None, stripped_items))
4069
4070
Aaron Gable4db38df2017-11-03 14:59:07 -07004071@subcommand.usage('[flags]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004072@metrics.collector.collect_metrics('git cl upload')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004073def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004074 """Uploads the current changelist to codereview.
4075
4076 Can skip dependency patchset uploads for a branch by running:
4077 git config branch.branch_name.skip-deps-uploads True
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004078 To unset, run:
rmistry@google.com78948ed2015-07-08 23:09:57 +00004079 git config --unset branch.branch_name.skip-deps-uploads
4080 Can also set the above globally by using the --global flag.
Dominic Battre7d1c4842017-10-27 09:17:28 +02004081
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004082 If the name of the checked out branch starts with "bug-" or "fix-" followed
4083 by a bug number, this bug number is automatically populated in the CL
Dominic Battre7d1c4842017-10-27 09:17:28 +02004084 description.
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004085
4086 If subject contains text in square brackets or has "<text>: " prefix, such
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004087 text(s) is treated as Gerrit hashtags. For example, CLs with subjects:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004088 [git-cl] add support for hashtags
4089 Foo bar: implement foo
4090 will be hashtagged with "git-cl" and "foo-bar" respectively.
rmistry@google.com78948ed2015-07-08 23:09:57 +00004091 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004092 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4093 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004094 parser.add_option('--bypass-watchlists', action='store_true',
4095 dest='bypass_watchlists',
4096 help='bypass watchlists auto CC-ing reviewers')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004097 parser.add_option('-f', '--force', action='store_true', dest='force',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004098 help="force yes to questions (don't prompt)")
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004099 parser.add_option('--message', '-m', dest='message',
4100 help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004101 parser.add_option('-b', '--bug',
4102 help='pre-populate the bug number(s) for this issue. '
4103 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004104 parser.add_option('--message-file', dest='message_file',
4105 help='file which contains message for patchset')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004106 parser.add_option('--title', '-t', dest='title',
4107 help='title for patchset')
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004108 parser.add_option('-T', '--skip-title', action='store_true',
4109 dest='skip_title',
4110 help='Use the most recent commit message as the title of '
4111 'the patchset')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004112 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004113 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004114 help='reviewer email addresses')
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004115 parser.add_option('--tbrs',
4116 action='append', default=[],
4117 help='TBR email addresses')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004118 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004119 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004120 help='cc email addresses')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004121 parser.add_option('--hashtag', dest='hashtags',
4122 action='append', default=[],
4123 help=('Gerrit hashtag for new CL; '
4124 'can be applied multiple times'))
adamk@chromium.org36f47302013-04-05 01:08:31 +00004125 parser.add_option('-s', '--send-mail', action='store_true',
Aaron Gable59f48512017-01-12 10:54:46 -08004126 help='send email to reviewer(s) and cc(s) immediately')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004127 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004128 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004129 metavar='TARGET',
4130 help='Apply CL to remote ref TARGET. ' +
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004131 'Default: remote branch head, or main')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004132 parser.add_option('--squash', action='store_true',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004133 help='Squash multiple commits into one')
Mike Frysingera989d552019-08-14 20:51:23 +00004134 parser.add_option('--no-squash', action='store_false', dest='squash',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004135 help='Don\'t squash multiple commits into one')
rmistry9eadede2016-09-19 11:22:43 -07004136 parser.add_option('--topic', default=None,
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004137 help='Topic to specify when uploading')
Robert Iannuccif2708bd2017-04-17 15:49:02 -07004138 parser.add_option('--tbr-owners', dest='add_owners_to', action='store_const',
4139 const='TBR', help='add a set of OWNERS to TBR')
4140 parser.add_option('--r-owners', dest='add_owners_to', action='store_const',
4141 const='R', help='add a set of OWNERS to R')
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004142 parser.add_option('-c', '--use-commit-queue', action='store_true',
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004143 default=False,
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004144 help='tell the CQ to commit this patchset; '
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004145 'implies --send-mail')
4146 parser.add_option('-d', '--cq-dry-run',
4147 action='store_true', default=False,
rmistry@google.comef966222015-04-07 11:15:01 +00004148 help='Send the patchset to do a CQ dry run right after '
4149 'upload.')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00004150 parser.add_option('--set-bot-commit', action='store_true',
4151 help=optparse.SUPPRESS_HELP)
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00004152 parser.add_option('--preserve-tryjobs', action='store_true',
4153 help='instruct the CQ to let tryjobs running even after '
4154 'new patchsets are uploaded instead of canceling '
4155 'prior patchset\' tryjobs')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004156 parser.add_option('--dependencies', action='store_true',
4157 help='Uploads CLs of all the local branches that depend on '
4158 'the current branch')
Ravi Mistry31e7d562018-04-02 12:53:57 -04004159 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4160 help='Sends your change to the CQ after an approval. Only '
4161 'works on repos that have the Auto-Submit label '
4162 'enabled')
Edward Lesmes8e282792018-04-03 18:50:29 -04004163 parser.add_option('--parallel', action='store_true',
4164 help='Run all tests specified by input_api.RunTests in all '
4165 'PRESUBMIT files in parallel.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004166 parser.add_option('--no-autocc', action='store_true',
4167 help='Disables automatic addition of CC emails')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004168 parser.add_option('--private', action='store_true',
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004169 help='Set the review private. This implies --no-autocc.')
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004170 parser.add_option('-R', '--retry-failed', action='store_true',
4171 help='Retry failed tryjobs from old patchset immediately '
4172 'after uploading new patchset. Cannot be used with '
4173 '--use-commit-queue or --cq-dry-run.')
4174 parser.add_option('--buildbucket-host', default='cr-buildbucket.appspot.com',
4175 help='Host of buildbucket. The default host is %default.')
Dan Beamd8b04ca2019-10-10 21:23:26 +00004176 parser.add_option('--fixed', '-x',
4177 help='List of bugs that will be commented on and marked '
4178 'fixed (pre-populates "Fixed:" tag). Same format as '
4179 '-b option / "Bug:" tag. If fixing several issues, '
4180 'separate with commas.')
Josipe827b0f2020-01-30 00:07:20 +00004181 parser.add_option('--edit-description', action='store_true', default=False,
4182 help='Modify description before upload. Cannot be used '
4183 'with --force. It is a noop when --no-squash is set '
4184 'or a new commit is created.')
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004185 parser.add_option('--git-completion-helper', action="store_true",
4186 help=optparse.SUPPRESS_HELP)
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004187 parser.add_option('--resultdb', action='store_true',
4188 help='Run presubmit checks in the ResultSink environment '
4189 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004190 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004191
rmistry@google.com2dd99862015-06-22 12:22:18 +00004192 orig_args = args
ukai@chromium.orge8077812012-02-03 03:41:46 +00004193 (options, args) = parser.parse_args(args)
4194
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004195 if options.git_completion_helper:
Edward Lesmesb7db1832020-06-22 20:22:27 +00004196 print(' '.join(opt.get_opt_string() for opt in parser.option_list
4197 if opt.help != optparse.SUPPRESS_HELP))
4198 return
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004199
sbc@chromium.org71437c02015-04-09 19:29:40 +00004200 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004201 return 1
4202
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004203 options.reviewers = cleanup_list(options.reviewers)
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004204 options.tbrs = cleanup_list(options.tbrs)
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004205 options.cc = cleanup_list(options.cc)
4206
Josipe827b0f2020-01-30 00:07:20 +00004207 if options.edit_description and options.force:
4208 parser.error('Only one of --force and --edit-description allowed')
4209
tandriib80458a2016-06-23 12:20:07 -07004210 if options.message_file:
4211 if options.message:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004212 parser.error('Only one of --message and --message-file allowed.')
tandriib80458a2016-06-23 12:20:07 -07004213 options.message = gclient_utils.FileRead(options.message_file)
tandriib80458a2016-06-23 12:20:07 -07004214
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004215 if ([options.cq_dry_run,
4216 options.use_commit_queue,
4217 options.retry_failed].count(True) > 1):
4218 parser.error('Only one of --use-commit-queue, --cq-dry-run, or '
4219 '--retry-failed is allowed.')
tandrii4d0545a2016-07-06 03:56:49 -07004220
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004221 if options.skip_title and options.title:
4222 parser.error('Only one of --title and --skip-title allowed.')
4223
Aaron Gableedbc4132017-09-11 13:22:28 -07004224 if options.use_commit_queue:
4225 options.send_mail = True
4226
Edward Lesmes0dd54822020-03-26 18:24:25 +00004227 if options.squash is None:
4228 # Load default for user, repo, squash=true, in this order.
4229 options.squash = settings.GetSquashGerritUploads()
4230
Edward Lemur934836a2019-09-09 20:16:54 +00004231 cl = Changelist()
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004232 # Warm change details cache now to avoid RPCs later, reducing latency for
4233 # developers.
4234 if cl.GetIssue():
4235 cl._GetChangeDetail(
4236 ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS'])
4237
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004238 if options.retry_failed and not cl.GetIssue():
4239 print('No previous patchsets, so --retry-failed has no effect.')
4240 options.retry_failed = False
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004241
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004242 # cl.GetMostRecentPatchset uses cached information, and can return the last
4243 # patchset before upload. Calling it here makes it clear that it's the
4244 # last patchset before upload. Note that GetMostRecentPatchset will fail
4245 # if no CL has been uploaded yet.
4246 if options.retry_failed:
4247 patchset = cl.GetMostRecentPatchset()
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00004248
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004249 ret = cl.CMDUpload(options, args, orig_args)
4250
4251 if options.retry_failed:
4252 if ret != 0:
4253 print('Upload failed, so --retry-failed has no effect.')
4254 return ret
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +00004255 builds, _ = _fetch_latest_builds(
Edward Lemur5b929a42019-10-21 17:57:39 +00004256 cl, options.buildbucket_host, latest_patchset=patchset)
Edward Lemur45768512020-03-02 19:03:14 +00004257 jobs = _filter_failed_for_retry(builds)
4258 if len(jobs) == 0:
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004259 print('No failed tryjobs, so --retry-failed has no effect.')
4260 return ret
Quinten Yearsley777660f2020-03-04 23:37:06 +00004261 _trigger_tryjobs(cl, jobs, options, patchset + 1)
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004262
4263 return ret
ukai@chromium.orge8077812012-02-03 03:41:46 +00004264
4265
Francois Dorayd42c6812017-05-30 15:10:20 -04004266@subcommand.usage('--description=<description file>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004267@metrics.collector.collect_metrics('git cl split')
Francois Dorayd42c6812017-05-30 15:10:20 -04004268def CMDsplit(parser, args):
4269 """Splits a branch into smaller branches and uploads CLs.
4270
4271 Creates a branch and uploads a CL for each group of files modified in the
4272 current branch that share a common OWNERS file. In the CL description and
Edward Lemurac5c55f2020-02-29 00:17:16 +00004273 comment, the string '$directory', is replaced with the directory containing
4274 the shared OWNERS file.
Francois Dorayd42c6812017-05-30 15:10:20 -04004275 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004276 parser.add_option('-d', '--description', dest='description_file',
4277 help='A text file containing a CL description in which '
4278 '$directory will be replaced by each CL\'s directory.')
4279 parser.add_option('-c', '--comment', dest='comment_file',
4280 help='A text file containing a CL comment.')
4281 parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true',
Chris Watkinsba28e462017-12-13 11:22:17 +11004282 default=False,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004283 help='List the files and reviewers for each CL that would '
4284 'be created, but don\'t create branches or CLs.')
4285 parser.add_option('--cq-dry-run', action='store_true',
4286 help='If set, will do a cq dry run for each uploaded CL. '
4287 'Please be careful when doing this; more than ~10 CLs '
4288 'has the potential to overload our build '
4289 'infrastructure. Try to upload these not during high '
4290 'load times (usually 11-3 Mountain View time). Email '
4291 'infra-dev@chromium.org with any questions.')
Takuto Ikuta51eca592019-02-14 19:40:52 +00004292 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4293 default=True,
4294 help='Sends your change to the CQ after an approval. Only '
4295 'works on repos that have the Auto-Submit label '
4296 'enabled')
Francois Dorayd42c6812017-05-30 15:10:20 -04004297 options, _ = parser.parse_args(args)
4298
4299 if not options.description_file:
4300 parser.error('No --description flag specified.')
4301
4302 def WrappedCMDupload(args):
4303 return CMDupload(OptionParser(), args)
4304
Edward Lemur2c62b332020-03-12 22:12:33 +00004305 return split_cl.SplitCl(
4306 options.description_file, options.comment_file, Changelist,
4307 WrappedCMDupload, options.dry_run, options.cq_dry_run,
4308 options.enable_auto_submit, settings.GetRoot())
Francois Dorayd42c6812017-05-30 15:10:20 -04004309
4310
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004311@subcommand.usage('DEPRECATED')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004312@metrics.collector.collect_metrics('git cl commit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004313def CMDdcommit(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004314 """DEPRECATED: Used to commit the current changelist via git-svn."""
4315 message = ('git-cl no longer supports committing to SVN repositories via '
4316 'git-svn. You probably want to use `git cl land` instead.')
4317 print(message)
4318 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004319
4320
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004321@subcommand.usage('[upstream branch to apply against]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004322@metrics.collector.collect_metrics('git cl land')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004323def CMDland(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004324 """Commits the current changelist via git.
4325
4326 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4327 upstream and closes the issue automatically and atomically.
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004328 """
4329 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4330 help='bypass upload presubmit hook')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004331 parser.add_option('-f', '--force', action='store_true', dest='force',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004332 help="force yes to questions (don't prompt)")
Edward Lesmes67b3faa2018-04-13 17:50:52 -04004333 parser.add_option('--parallel', action='store_true',
4334 help='Run all tests specified by input_api.RunTests in all '
4335 'PRESUBMIT files in parallel.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004336 parser.add_option('--resultdb', action='store_true',
4337 help='Run presubmit checks in the ResultSink environment '
4338 'and send results to the ResultDB database.')
4339 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004340 (options, args) = parser.parse_args(args)
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004341
Edward Lemur934836a2019-09-09 20:16:54 +00004342 cl = Changelist()
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004343
Robert Iannucci2e73d432018-03-14 01:10:47 -07004344 if not cl.GetIssue():
4345 DieWithError('You must upload the change first to Gerrit.\n'
4346 ' If you would rather have `git cl land` upload '
4347 'automatically for you, see http://crbug.com/642759')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004348 return cl.CMDLand(options.force, options.bypass_hooks, options.verbose,
4349 options.parallel, options.resultdb, options.realm)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004350
4351
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004352@subcommand.usage('<patch url or issue id or issue url>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004353@metrics.collector.collect_metrics('git cl patch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004354def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004355 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004356 parser.add_option('-b', dest='newbranch',
4357 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004358 parser.add_option('-f', '--force', action='store_true',
Aaron Gable62619a32017-06-16 08:22:09 -07004359 help='overwrite state on the current or chosen branch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004360 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
Edward Lemurf38bc172019-09-03 21:02:13 +00004361 help='don\'t commit after patch applies.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004362
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004363 group = optparse.OptionGroup(
4364 parser,
4365 'Options for continuing work on the current issue uploaded from a '
4366 'different clone (e.g. different machine). Must be used independently '
4367 'from the other options. No issue number should be specified, and the '
4368 'branch must have an issue number associated with it')
4369 group.add_option('--reapply', action='store_true', dest='reapply',
4370 help='Reset the branch and reapply the issue.\n'
4371 'CAUTION: This will undo any local changes in this '
4372 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004373
4374 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004375 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004376 parser.add_option_group(group)
4377
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004378 (options, args) = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004379
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004380 if options.reapply:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004381 if options.newbranch:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004382 parser.error('--reapply works on the current branch only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004383 if len(args) > 0:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004384 parser.error('--reapply implies no additional arguments.')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004385
Edward Lemur934836a2019-09-09 20:16:54 +00004386 cl = Changelist()
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004387 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004388 parser.error('Current branch must have an associated issue.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004389
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004390 upstream = cl.GetUpstreamBranch()
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004391 if upstream is None:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004392 parser.error('No upstream branch specified. Cannot reset branch.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004393
4394 RunGit(['reset', '--hard', upstream])
4395 if options.pull:
4396 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004397
Edward Lemur678a6842019-10-03 22:25:05 +00004398 target_issue_arg = ParseIssueNumberArgument(cl.GetIssue())
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004399 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, False,
4400 False)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004401
4402 if len(args) != 1 or not args[0]:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004403 parser.error('Must specify issue number or URL.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004404
Edward Lemurf38bc172019-09-03 21:02:13 +00004405 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004406 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004407 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004408
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004409 # We don't want uncommitted changes mixed up with the patch.
4410 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004411 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004412
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004413 if options.newbranch:
4414 if options.force:
4415 RunGit(['branch', '-D', options.newbranch],
4416 stderr=subprocess2.PIPE, error_ok=True)
Edward Lemur84101642020-02-21 21:40:34 +00004417 git_new_branch.create_new_branch(options.newbranch)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004418
Edward Lemur678a6842019-10-03 22:25:05 +00004419 cl = Changelist(
4420 codereview_host=target_issue_arg.hostname, issue=target_issue_arg.issue)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004421
Edward Lemur678a6842019-10-03 22:25:05 +00004422 if not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004423 print('canonical issue/change URL: %s\n' % cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004424
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004425 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit,
4426 options.force, options.newbranch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004427
4428
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004429def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004430 """Fetches the tree status and returns either 'open', 'closed',
4431 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004432 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004433 if url:
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004434 status = str(urllib.request.urlopen(url).read().lower())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004435 if status.find('closed') != -1 or status == '0':
4436 return 'closed'
4437 elif status.find('open') != -1 or status == '1':
4438 return 'open'
4439 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004440 return 'unset'
4441
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004442
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004443def GetTreeStatusReason():
4444 """Fetches the tree status from a json url and returns the message
4445 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004446 url = settings.GetTreeStatusUrl()
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004447 json_url = urllib.parse.urljoin(url, '/current?format=json')
Edward Lemur79d4f992019-11-11 23:49:02 +00004448 connection = urllib.request.urlopen(json_url)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004449 status = json.loads(connection.read())
4450 connection.close()
4451 return status['message']
4452
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004453
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004454@metrics.collector.collect_metrics('git cl tree')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004455def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004456 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004457 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004458 status = GetTreeStatus()
4459 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004460 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004461 return 2
4462
vapiera7fbd5a2016-06-16 09:17:49 -07004463 print('The tree is %s' % status)
4464 print()
4465 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004466 if status != 'open':
4467 return 1
4468 return 0
4469
4470
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004471@metrics.collector.collect_metrics('git cl try')
maruel@chromium.org15192402012-09-06 12:38:29 +00004472def CMDtry(parser, args):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004473 """Triggers tryjobs using either Buildbucket or CQ dry run."""
4474 group = optparse.OptionGroup(parser, 'Tryjob options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004475 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004476 '-b', '--bot', action='append',
4477 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4478 'times to specify multiple builders. ex: '
4479 '"-b win_rel -b win_layout". See '
4480 'the try server waterfall for the builders name and the tests '
4481 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004482 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004483 '-B', '--bucket', default='',
4484 help=('Buildbucket bucket to send the try requests.'))
4485 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004486 '-r', '--revision',
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004487 help='Revision to use for the tryjob; default: the revision will '
tandriif7b29d42016-10-07 08:45:41 -07004488 'be determined by the try recipe that builder runs, which usually '
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004489 'defaults to HEAD of origin/master or origin/main')
maruel@chromium.org15192402012-09-06 12:38:29 +00004490 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004491 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004492 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004493 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004494 group.add_option(
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004495 '--category', default='git_cl_try', help='Specify custom build category.')
4496 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004497 '--project',
4498 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004499 'in recipe to determine to which repository or directory to '
4500 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004501 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004502 '-p', '--property', dest='properties', action='append', default=[],
4503 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004504 'key2=value2 etc. The value will be treated as '
4505 'json if decodable, or as string otherwise. '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004506 'NOTE: using this may make your tryjob not usable for CQ, '
4507 'which will then schedule another tryjob with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004508 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004509 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4510 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004511 parser.add_option_group(group)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004512 parser.add_option(
4513 '-R', '--retry-failed', action='store_true', default=False,
4514 help='Retry failed jobs from the latest set of tryjobs. '
4515 'Not allowed with --bucket and --bot options.')
Edward Lemur52969c92020-02-06 18:15:28 +00004516 parser.add_option(
4517 '-i', '--issue', type=int,
4518 help='Operate on this issue instead of the current branch\'s implicit '
4519 'issue.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004520 options, args = parser.parse_args(args)
4521
machenbach@chromium.org45453142015-09-15 08:45:22 +00004522 # Make sure that all properties are prop=value pairs.
4523 bad_params = [x for x in options.properties if '=' not in x]
4524 if bad_params:
4525 parser.error('Got properties with missing "=": %s' % bad_params)
4526
maruel@chromium.org15192402012-09-06 12:38:29 +00004527 if args:
4528 parser.error('Unknown arguments: %s' % args)
4529
Edward Lemur934836a2019-09-09 20:16:54 +00004530 cl = Changelist(issue=options.issue)
maruel@chromium.org15192402012-09-06 12:38:29 +00004531 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004532 parser.error('Need to upload first.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004533
Edward Lemurf38bc172019-09-03 21:02:13 +00004534 # HACK: warm up Gerrit change detail cache to save on RPCs.
Edward Lemur125d60a2019-09-13 18:25:41 +00004535 cl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS'])
Andrii Shyshkaloveadad922017-01-26 09:38:30 +01004536
tandriie113dfd2016-10-11 10:20:12 -07004537 error_message = cl.CannotTriggerTryJobReason()
4538 if error_message:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004539 parser.error('Can\'t trigger tryjobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004540
Edward Lemur45768512020-03-02 19:03:14 +00004541 if options.bot:
4542 if options.retry_failed:
4543 parser.error('--bot is not compatible with --retry-failed.')
4544 if not options.bucket:
4545 parser.error('A bucket (e.g. "chromium/try") is required.')
4546
4547 triggered = [b for b in options.bot if 'triggered' in b]
4548 if triggered:
4549 parser.error(
4550 'Cannot schedule builds on triggered bots: %s.\n'
4551 'This type of bot requires an initial job from a parent (usually a '
4552 'builder). Schedule a job on the parent instead.\n' % triggered)
4553
4554 if options.bucket.startswith('.master'):
4555 parser.error('Buildbot masters are not supported.')
4556
4557 project, bucket = _parse_bucket(options.bucket)
4558 if project is None or bucket is None:
4559 parser.error('Invalid bucket: %s.' % options.bucket)
4560 jobs = sorted((project, bucket, bot) for bot in options.bot)
4561 elif options.retry_failed:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004562 print('Searching for failed tryjobs...')
Edward Lemur5b929a42019-10-21 17:57:39 +00004563 builds, patchset = _fetch_latest_builds(cl, options.buildbucket_host)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004564 if options.verbose:
4565 print('Got %d builds in patchset #%d' % (len(builds), patchset))
Edward Lemur45768512020-03-02 19:03:14 +00004566 jobs = _filter_failed_for_retry(builds)
4567 if not jobs:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004568 print('There are no failed jobs in the latest set of jobs '
4569 '(patchset #%d), doing nothing.' % patchset)
4570 return 0
Edward Lemur45768512020-03-02 19:03:14 +00004571 num_builders = len(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004572 if num_builders > 10:
4573 confirm_or_exit('There are %d builders with failed builds.'
4574 % num_builders, action='continue')
4575 else:
qyearsley1fdfcb62016-10-24 13:22:03 -07004576 if options.verbose:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07004577 print('git cl try with no bots now defaults to CQ dry run.')
4578 print('Scheduling CQ dry run on: %s' % cl.GetIssueURL())
4579 return cl.SetCQState(_CQState.DRY_RUN)
stip@chromium.org43064fd2013-12-18 20:07:44 +00004580
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004581 patchset = cl.GetMostRecentPatchset()
Edward Lemur2c210a42019-09-16 23:58:35 +00004582 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004583 _trigger_tryjobs(cl, jobs, options, patchset)
Edward Lemur2c210a42019-09-16 23:58:35 +00004584 except BuildbucketResponseException as ex:
4585 print('ERROR: %s' % ex)
4586 return 1
4587 return 0
maruel@chromium.org15192402012-09-06 12:38:29 +00004588
4589
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004590@metrics.collector.collect_metrics('git cl try-results')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004591def CMDtry_results(parser, args):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004592 """Prints info about results for tryjobs associated with the current CL."""
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004593 group = optparse.OptionGroup(parser, 'Tryjob results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004594 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004595 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004596 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004597 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004598 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004599 '--color', action='store_true', default=setup_color.IS_TTY,
4600 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004601 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004602 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4603 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004604 group.add_option(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004605 '--json', help=('Path of JSON output file to write tryjob results to,'
Stefan Zager1306bd02017-06-22 19:26:46 -07004606 'or "-" for stdout.'))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004607 parser.add_option_group(group)
Edward Lemur52969c92020-02-06 18:15:28 +00004608 parser.add_option(
4609 '-i', '--issue', type=int,
4610 help='Operate on this issue instead of the current branch\'s implicit '
4611 'issue.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004612 options, args = parser.parse_args(args)
4613 if args:
4614 parser.error('Unrecognized args: %s' % ' '.join(args))
4615
Edward Lemur934836a2019-09-09 20:16:54 +00004616 cl = Changelist(issue=options.issue)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004617 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004618 parser.error('Need to upload first.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004619
tandrii221ab252016-10-06 08:12:04 -07004620 patchset = options.patchset
4621 if not patchset:
Gavin Make61ccc52020-11-13 00:12:57 +00004622 patchset = cl.GetMostRecentDryRunPatchset()
tandrii221ab252016-10-06 08:12:04 -07004623 if not patchset:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004624 parser.error('Code review host doesn\'t know about issue %s. '
tandrii221ab252016-10-06 08:12:04 -07004625 'No access to issue or wrong issue number?\n'
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004626 'Either upload first, or pass --patchset explicitly.' %
tandrii221ab252016-10-06 08:12:04 -07004627 cl.GetIssue())
4628
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004629 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004630 jobs = _fetch_tryjobs(cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004631 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004632 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004633 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004634 if options.json:
Edward Lemurbaaf6be2019-10-09 18:00:44 +00004635 write_json(options.json, jobs)
qyearsley53f48a12016-09-01 10:45:13 -07004636 else:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004637 _print_tryjobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004638 return 0
4639
4640
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004641@subcommand.usage('[new upstream branch]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004642@metrics.collector.collect_metrics('git cl upstream')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004643def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004644 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004645 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004646 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004647 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004648
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004649 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004650 if args:
4651 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004652 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07004653 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004654 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07004655 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004656
4657 # Clear configured merge-base, if there is one.
4658 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004659 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004660 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004661 return 0
4662
4663
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004664@metrics.collector.collect_metrics('git cl web')
thestig@chromium.org00858c82013-12-02 23:08:03 +00004665def CMDweb(parser, args):
4666 """Opens the current CL in the web browser."""
4667 _, args = parser.parse_args(args)
4668 if args:
4669 parser.error('Unrecognized args: %s' % ' '.join(args))
4670
4671 issue_url = Changelist().GetIssueURL()
4672 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07004673 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004674 return 1
4675
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004676 # Redirect I/O before invoking browser to hide its output. For example, this
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004677 # allows us to hide the "Created new window in existing browser session."
4678 # message from Chrome. Based on https://stackoverflow.com/a/2323563.
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004679 saved_stdout = os.dup(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004680 saved_stderr = os.dup(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004681 os.close(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004682 os.close(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004683 os.open(os.devnull, os.O_RDWR)
4684 try:
4685 webbrowser.open(issue_url)
4686 finally:
4687 os.dup2(saved_stdout, 1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004688 os.dup2(saved_stderr, 2)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004689 return 0
4690
4691
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004692@metrics.collector.collect_metrics('git cl set-commit')
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004693def CMDset_commit(parser, args):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004694 """Sets the commit bit to trigger the CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004695 parser.add_option('-d', '--dry-run', action='store_true',
4696 help='trigger in dry run mode')
4697 parser.add_option('-c', '--clear', action='store_true',
4698 help='stop CQ run, if any')
Edward Lemur52969c92020-02-06 18:15:28 +00004699 parser.add_option(
4700 '-i', '--issue', type=int,
4701 help='Operate on this issue instead of the current branch\'s implicit '
4702 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004703 options, args = parser.parse_args(args)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004704 if args:
4705 parser.error('Unrecognized args: %s' % ' '.join(args))
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004706 if options.dry_run and options.clear:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004707 parser.error('Only one of --dry-run and --clear are allowed.')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004708
Edward Lemur934836a2019-09-09 20:16:54 +00004709 cl = Changelist(issue=options.issue)
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004710 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07004711 state = _CQState.NONE
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004712 elif options.dry_run:
4713 state = _CQState.DRY_RUN
4714 else:
4715 state = _CQState.COMMIT
4716 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004717 parser.error('Must upload the issue first.')
tandrii9de9ec62016-07-13 03:01:59 -07004718 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004719 return 0
4720
4721
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004722@metrics.collector.collect_metrics('git cl set-close')
groby@chromium.org411034a2013-02-26 15:12:01 +00004723def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004724 """Closes the issue."""
Edward Lemur52969c92020-02-06 18:15:28 +00004725 parser.add_option(
4726 '-i', '--issue', type=int,
4727 help='Operate on this issue instead of the current branch\'s implicit '
4728 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004729 options, args = parser.parse_args(args)
groby@chromium.org411034a2013-02-26 15:12:01 +00004730 if args:
4731 parser.error('Unrecognized args: %s' % ' '.join(args))
Edward Lemur934836a2019-09-09 20:16:54 +00004732 cl = Changelist(issue=options.issue)
groby@chromium.org411034a2013-02-26 15:12:01 +00004733 # Ensure there actually is an issue to close.
Aaron Gable7139a4e2017-09-05 17:53:09 -07004734 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004735 DieWithError('ERROR: No issue to close.')
groby@chromium.org411034a2013-02-26 15:12:01 +00004736 cl.CloseIssue()
4737 return 0
4738
4739
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004740@metrics.collector.collect_metrics('git cl diff')
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004741def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00004742 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07004743 parser.add_option(
4744 '--stat',
4745 action='store_true',
4746 dest='stat',
4747 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004748 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004749 if args:
4750 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00004751
Edward Lemur934836a2019-09-09 20:16:54 +00004752 cl = Changelist()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004753 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004754 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004755 if not issue:
4756 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004757
Aaron Gablea718c3e2017-08-28 17:47:28 -07004758 base = cl._GitGetBranchConfigValue('last-upload-hash')
4759 if not base:
4760 base = cl._GitGetBranchConfigValue('gerritsquashhash')
4761 if not base:
4762 detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
4763 revision_info = detail['revisions'][detail['current_revision']]
4764 fetch_info = revision_info['fetch']['http']
4765 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
4766 base = 'FETCH_HEAD'
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004767
Aaron Gablea718c3e2017-08-28 17:47:28 -07004768 cmd = ['git', 'diff']
4769 if options.stat:
4770 cmd.append('--stat')
4771 cmd.append(base)
4772 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004773
4774 return 0
4775
4776
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004777@metrics.collector.collect_metrics('git cl owners')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004778def CMDowners(parser, args):
Dirk Prankebf980882017-09-02 15:08:00 -07004779 """Finds potential owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004780 parser.add_option(
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004781 '--ignore-current',
4782 action='store_true',
4783 help='Ignore the CL\'s current reviewers and start from scratch.')
4784 parser.add_option(
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004785 '--ignore-self',
4786 action='store_true',
4787 help='Do not consider CL\'s author as an owners.')
4788 parser.add_option(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004789 '--no-color',
4790 action='store_true',
4791 help='Use this option to disable color output')
Dirk Prankebf980882017-09-02 15:08:00 -07004792 parser.add_option(
4793 '--batch',
4794 action='store_true',
4795 help='Do not run interactively, just suggest some')
Yang Guo6e269a02019-06-26 11:17:02 +00004796 # TODO: Consider moving this to another command, since other
4797 # git-cl owners commands deal with owners for a given CL.
4798 parser.add_option(
4799 '--show-all',
4800 action='store_true',
4801 help='Show all owners for a particular file')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004802 options, args = parser.parse_args(args)
4803
Edward Lemur934836a2019-09-09 20:16:54 +00004804 cl = Changelist()
Edward Lesmes50da7702020-03-30 19:23:43 +00004805 author = cl.GetAuthor()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004806
Yang Guo6e269a02019-06-26 11:17:02 +00004807 if options.show_all:
Bruce Dawson97ed44a2020-05-06 17:04:03 +00004808 if len(args) == 0:
4809 print('No files specified for --show-all. Nothing to do.')
4810 return 0
Edward Lesmese1576912021-02-16 21:53:34 +00004811 owners_by_path = cl.owners_client.BatchListOwners(args)
Edward Lesmes0e4e5ae2021-01-08 18:28:46 +00004812 for path in args:
4813 print('Owners for %s:' % path)
4814 print('\n'.join(
4815 ' - %s' % owner
4816 for owner in owners_by_path.get(path, ['No owners found'])))
Yang Guo6e269a02019-06-26 11:17:02 +00004817 return 0
4818
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004819 if args:
4820 if len(args) > 1:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004821 parser.error('Unknown args.')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004822 base_branch = args[0]
4823 else:
4824 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004825 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004826
Edward Lemur2c62b332020-03-12 22:12:33 +00004827 affected_files = cl.GetAffectedFiles(base_branch)
Dirk Prankebf980882017-09-02 15:08:00 -07004828
4829 if options.batch:
Edward Lesmese1576912021-02-16 21:53:34 +00004830 owners = cl.owners_client.SuggestOwners(affected_files, exclude=[author])
4831 print('\n'.join(owners))
Dirk Prankebf980882017-09-02 15:08:00 -07004832 return 0
4833
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004834 return owners_finder.OwnersFinder(
Dirk Prankebf980882017-09-02 15:08:00 -07004835 affected_files,
Edward Lemur707d70b2018-02-07 00:50:14 +01004836 author,
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004837 [] if options.ignore_current else cl.GetReviewers(),
Edward Lesmes5cd75472021-02-19 00:34:25 +00004838 cl.owners_client,
Jochen Eisingerd0573ec2017-04-13 10:55:06 +02004839 disable_color=options.no_color,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004840 ignore_author=options.ignore_self).run()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004841
4842
Aiden Bennerc08566e2018-10-03 17:52:42 +00004843def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004844 """Generates a diff command."""
4845 # Generate diff for the current branch's changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +00004846 diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff']
4847
Aiden Benner6c18a1a2018-11-23 20:18:23 +00004848 if allow_prefix:
4849 # explicitly setting --src-prefix and --dst-prefix is necessary in the
4850 # case that diff.noprefix is set in the user's git config.
4851 diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/']
4852 else:
Aiden Bennerc08566e2018-10-03 17:52:42 +00004853 diff_cmd += ['--no-prefix']
4854
4855 diff_cmd += [diff_type, upstream_commit, '--']
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004856
4857 if args:
4858 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00004859 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004860 diff_cmd.append(arg)
4861 else:
4862 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004863
4864 return diff_cmd
4865
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004866
Jamie Madill5e96ad12020-01-13 16:08:35 +00004867def _RunClangFormatDiff(opts, clang_diff_files, top_dir, upstream_commit):
4868 """Runs clang-format-diff and sets a return value if necessary."""
4869
4870 if not clang_diff_files:
4871 return 0
4872
4873 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
4874 # formatted. This is used to block during the presubmit.
4875 return_value = 0
4876
4877 # Locate the clang-format binary in the checkout
4878 try:
4879 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
4880 except clang_format.NotFoundError as e:
4881 DieWithError(e)
4882
4883 if opts.full or settings.GetFormatFullByDefault():
4884 cmd = [clang_format_tool]
4885 if not opts.dry_run and not opts.diff:
4886 cmd.append('-i')
4887 if opts.dry_run:
4888 for diff_file in clang_diff_files:
4889 with open(diff_file, 'r') as myfile:
4890 code = myfile.read().replace('\r\n', '\n')
4891 stdout = RunCommand(cmd + [diff_file], cwd=top_dir)
4892 stdout = stdout.replace('\r\n', '\n')
4893 if opts.diff:
4894 sys.stdout.write(stdout)
4895 if code != stdout:
4896 return_value = 2
4897 else:
4898 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
4899 if opts.diff:
4900 sys.stdout.write(stdout)
4901 else:
Jamie Madill5e96ad12020-01-13 16:08:35 +00004902 try:
4903 script = clang_format.FindClangFormatScriptInChromiumTree(
4904 'clang-format-diff.py')
4905 except clang_format.NotFoundError as e:
4906 DieWithError(e)
4907
Edward Lesmes89624cd2020-04-06 17:51:56 +00004908 cmd = ['vpython', script, '-p0']
Jamie Madill5e96ad12020-01-13 16:08:35 +00004909 if not opts.dry_run and not opts.diff:
4910 cmd.append('-i')
4911
4912 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
Edward Lemur1a83da12020-03-04 21:18:36 +00004913 diff_output = RunGit(diff_cmd).encode('utf-8')
Jamie Madill5e96ad12020-01-13 16:08:35 +00004914
Edward Lesmes89624cd2020-04-06 17:51:56 +00004915 env = os.environ.copy()
4916 env['PATH'] = (
4917 str(os.path.dirname(clang_format_tool)) + os.pathsep + env['PATH'])
4918 stdout = RunCommand(
4919 cmd, stdin=diff_output, cwd=top_dir, env=env,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00004920 shell=sys.platform.startswith('win32'))
Jamie Madill5e96ad12020-01-13 16:08:35 +00004921 if opts.diff:
4922 sys.stdout.write(stdout)
4923 if opts.dry_run and len(stdout) > 0:
4924 return_value = 2
4925
4926 return return_value
4927
4928
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00004929def MatchingFileType(file_name, extensions):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004930 """Returns True if the file name ends with one of the given extensions."""
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00004931 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004932
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004933
enne@chromium.org555cfe42014-01-29 18:21:39 +00004934@subcommand.usage('[files or directories to diff]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004935@metrics.collector.collect_metrics('git cl format')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00004936def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00004937 """Runs auto-formatting tools (clang-format etc.) on the diff."""
Christopher Lamc5ba6922017-01-24 11:19:14 +11004938 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07004939 GN_EXTS = ['.gn', '.gni', '.typemap']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00004940 parser.add_option('--full', action='store_true',
4941 help='Reformat the full content of all touched files')
4942 parser.add_option('--dry-run', action='store_true',
4943 help='Don\'t modify any file on disk.')
Aiden Benner99b0ccb2018-11-20 19:53:31 +00004944 parser.add_option(
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00004945 '--no-clang-format',
4946 dest='clang_format',
4947 action='store_false',
4948 default=True,
4949 help='Disables formatting of various file types using clang-format.')
4950 parser.add_option(
Aiden Benner99b0ccb2018-11-20 19:53:31 +00004951 '--python',
4952 action='store_true',
4953 default=None,
4954 help='Enables python formatting on all python files.')
4955 parser.add_option(
4956 '--no-python',
4957 action='store_true',
Garrett Beaty91a6f332020-01-06 16:57:24 +00004958 default=False,
Aiden Benner99b0ccb2018-11-20 19:53:31 +00004959 help='Disables python formatting on all python files. '
Garrett Beaty91a6f332020-01-06 16:57:24 +00004960 'If neither --python or --no-python are set, python files that have a '
4961 '.style.yapf file in an ancestor directory will be formatted. '
4962 'It is an error to set both.')
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00004963 parser.add_option(
4964 '--js',
4965 action='store_true',
4966 help='Format javascript code with clang-format. '
4967 'Has no effect if --no-clang-format is set.')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00004968 parser.add_option('--diff', action='store_true',
4969 help='Print diff to stdout rather than modifying files.')
Ilya Shermane081cbe2017-08-15 17:51:04 -07004970 parser.add_option('--presubmit', action='store_true',
4971 help='Used when running the script from a presubmit.')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00004972 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00004973
Garrett Beaty91a6f332020-01-06 16:57:24 +00004974 if opts.python is not None and opts.no_python:
4975 raise parser.error('Cannot set both --python and --no-python')
4976 if opts.no_python:
4977 opts.python = False
4978
Daniel Chengc55eecf2016-12-30 03:11:02 -08004979 # Normalize any remaining args against the current path, so paths relative to
4980 # the current directory are still resolved as expected.
4981 args = [os.path.join(os.getcwd(), arg) for arg in args]
4982
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00004983 # git diff generates paths against the root of the repository. Change
4984 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004985 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00004986 if rel_base_path:
4987 os.chdir(rel_base_path)
4988
digit@chromium.org29e47272013-05-17 17:01:46 +00004989 # Grab the merge-base commit, i.e. the upstream commit of the current
4990 # branch when it was created or the last time it was rebased. This is
4991 # to cover the case where the user may have called "git fetch origin",
4992 # moving the origin branch to a newer commit, but hasn't rebased yet.
4993 upstream_commit = None
4994 cl = Changelist()
4995 upstream_branch = cl.GetUpstreamBranch()
4996 if upstream_branch:
4997 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
4998 upstream_commit = upstream_commit.strip()
4999
5000 if not upstream_commit:
5001 DieWithError('Could not find base commit for this branch. '
5002 'Are you in detached state?')
5003
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005004 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5005 diff_output = RunGit(changed_files_cmd)
5006 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005007 # Filter out files deleted by this CL
5008 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005009
Andreas Haas417d89c2020-02-06 10:24:27 +00005010 if opts.js:
Deepanjan Roy605dd312018-07-02 17:48:54 +00005011 CLANG_EXTS.extend(['.js', '.ts'])
Christopher Lamc5ba6922017-01-24 11:19:14 +11005012
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005013 clang_diff_files = []
5014 if opts.clang_format:
5015 clang_diff_files = [
5016 x for x in diff_files if MatchingFileType(x, CLANG_EXTS)
5017 ]
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005018 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005019 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005020
Edward Lesmes50da7702020-03-30 19:23:43 +00005021 top_dir = settings.GetRoot()
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005022
Jamie Madill5e96ad12020-01-13 16:08:35 +00005023 return_value = _RunClangFormatDiff(opts, clang_diff_files, top_dir,
5024 upstream_commit)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005025
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005026 # Similar code to above, but using yapf on .py files rather than clang-format
5027 # on C/C++ files
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005028 py_explicitly_disabled = opts.python is not None and not opts.python
5029 if python_diff_files and not py_explicitly_disabled:
Aiden Bennere47ac152018-11-20 16:44:03 +00005030 depot_tools_path = os.path.dirname(os.path.abspath(__file__))
5031 yapf_tool = os.path.join(depot_tools_path, 'yapf')
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005032
Aiden Bennerc08566e2018-10-03 17:52:42 +00005033 # Used for caching.
5034 yapf_configs = {}
5035 for f in python_diff_files:
5036 # Find the yapf style config for the current file, defaults to depot
5037 # tools default.
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005038 _FindYapfConfigFile(f, yapf_configs, top_dir)
5039
5040 # Turn on python formatting by default if a yapf config is specified.
5041 # This breaks in the case of this repo though since the specified
5042 # style file is also the global default.
5043 if opts.python is None:
5044 filtered_py_files = []
5045 for f in python_diff_files:
5046 if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None:
5047 filtered_py_files.append(f)
5048 else:
5049 filtered_py_files = python_diff_files
5050
5051 # Note: yapf still seems to fix indentation of the entire file
5052 # even if line ranges are specified.
5053 # See https://github.com/google/yapf/issues/499
5054 if not opts.full and filtered_py_files:
5055 py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit)
5056
Brian Sheedyb4307d52019-12-02 19:18:17 +00005057 yapfignore_patterns = _GetYapfIgnorePatterns(top_dir)
5058 filtered_py_files = _FilterYapfIgnoredFiles(filtered_py_files,
5059 yapfignore_patterns)
Brian Sheedy59b06a82019-10-14 17:03:29 +00005060
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005061 for f in filtered_py_files:
Andrew Grievefa40bfa2020-01-07 02:32:57 +00005062 yapf_style = _FindYapfConfigFile(f, yapf_configs, top_dir)
5063 # Default to pep8 if not .style.yapf is found.
5064 if not yapf_style:
5065 yapf_style = 'pep8'
Aiden Bennerc08566e2018-10-03 17:52:42 +00005066
Peter Wend9399922020-06-17 17:33:49 +00005067 with open(f, 'r') as py_f:
5068 if 'python3' in py_f.readline():
5069 vpython_script = 'vpython3'
5070 else:
5071 vpython_script = 'vpython'
5072
5073 cmd = [vpython_script, yapf_tool, '--style', yapf_style, f]
Aiden Bennerc08566e2018-10-03 17:52:42 +00005074
5075 has_formattable_lines = False
5076 if not opts.full:
5077 # Only run yapf over changed line ranges.
5078 for diff_start, diff_len in py_line_diffs[f]:
5079 diff_end = diff_start + diff_len - 1
5080 # Yapf errors out if diff_end < diff_start but this
5081 # is a valid line range diff for a removal.
5082 if diff_end >= diff_start:
5083 has_formattable_lines = True
5084 cmd += ['-l', '{}-{}'.format(diff_start, diff_end)]
5085 # If all line diffs were removals we have nothing to format.
5086 if not has_formattable_lines:
5087 continue
5088
5089 if opts.diff or opts.dry_run:
5090 cmd += ['--diff']
5091 # Will return non-zero exit code if non-empty diff.
Edward Lesmesb7db1832020-06-22 20:22:27 +00005092 stdout = RunCommand(cmd,
5093 error_ok=True,
5094 cwd=top_dir,
5095 shell=sys.platform.startswith('win32'))
Aiden Bennerc08566e2018-10-03 17:52:42 +00005096 if opts.diff:
5097 sys.stdout.write(stdout)
5098 elif len(stdout) > 0:
5099 return_value = 2
5100 else:
5101 cmd += ['-i']
Edward Lesmesb7db1832020-06-22 20:22:27 +00005102 RunCommand(cmd, cwd=top_dir, shell=sys.platform.startswith('win32'))
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005103
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005104 # Format GN build files. Always run on full build files for canonical form.
5105 if gn_diff_files:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005106 cmd = ['gn', 'format']
brettw4b8ed592016-08-05 16:19:12 -07005107 if opts.dry_run or opts.diff:
5108 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005109 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005110 gn_ret = subprocess2.call(cmd + [gn_diff_file],
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005111 shell=sys.platform.startswith('win'),
brettw4b8ed592016-08-05 16:19:12 -07005112 cwd=top_dir)
5113 if opts.dry_run and gn_ret == 2:
5114 return_value = 2 # Not formatted.
5115 elif opts.diff and gn_ret == 2:
5116 # TODO this should compute and print the actual diff.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005117 print('This change has GN build file diff for ' + gn_diff_file)
brettw4b8ed592016-08-05 16:19:12 -07005118 elif gn_ret != 0:
5119 # For non-dry run cases (and non-2 return values for dry-run), a
5120 # nonzero error code indicates a failure, probably because the file
5121 # doesn't parse.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005122 DieWithError('gn format failed on ' + gn_diff_file +
5123 '\nTry running `gn format` on this file manually.')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005124
Ilya Shermane081cbe2017-08-15 17:51:04 -07005125 # Skip the metrics formatting from the global presubmit hook. These files have
5126 # a separate presubmit hook that issues an error if the files need formatting,
5127 # whereas the top-level presubmit script merely issues a warning. Formatting
5128 # these files is somewhat slow, so it's important not to duplicate the work.
5129 if not opts.presubmit:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005130 for diff_xml in GetDiffXMLs(diff_files):
5131 xml_dir = GetMetricsDir(diff_xml)
5132 if not xml_dir:
5133 continue
5134
Ilya Shermane081cbe2017-08-15 17:51:04 -07005135 tool_dir = os.path.join(top_dir, xml_dir)
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005136 pretty_print_tool = os.path.join(tool_dir, 'pretty_print.py')
5137 cmd = ['vpython', pretty_print_tool, '--non-interactive']
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005138
5139 # If the XML file is histograms.xml or enums.xml, add the xml path to the
5140 # command as histograms/pretty_print.py now needs a relative path argument
5141 # after splitting the histograms into multiple directories.
5142 # For example, in tools/metrics/ukm, pretty-print could be run using:
5143 # $ python pretty_print.py
5144 # But in tools/metrics/histogrmas, pretty-print should be run with an
5145 # additional relative path argument, like:
5146 # $ python pretty_print.py histograms_xml/UMA/histograms.xml
5147 # $ python pretty_print.py enums.xml
5148
5149 # TODO (crbug/1116488): Remove this check after ensuring that the updated
5150 # version of histograms/pretty_print.py is released.
5151 filepath_required = os.path.exists(
5152 os.path.join(tool_dir, 'validate_prefix.py'))
5153
Weilun Shib92c4b72020-08-27 17:45:11 +00005154 if (diff_xml.endswith('histograms.xml') or diff_xml.endswith('enums.xml')
5155 or diff_xml.endswith('histogram_suffixes_list.xml')
5156 ) and filepath_required:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005157 cmd.append(diff_xml)
5158
Ilya Shermane081cbe2017-08-15 17:51:04 -07005159 if opts.dry_run or opts.diff:
5160 cmd.append('--diff')
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005161
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005162 # TODO(isherman): Once this file runs only on Python 3.3+, drop the
5163 # `shell` param and instead replace `'vpython'` with
5164 # `shutil.which('frob')` above: https://stackoverflow.com/a/32799942
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005165 stdout = RunCommand(cmd,
5166 cwd=top_dir,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005167 shell=sys.platform.startswith('win32'))
Ilya Shermane081cbe2017-08-15 17:51:04 -07005168 if opts.diff:
5169 sys.stdout.write(stdout)
5170 if opts.dry_run and stdout:
5171 return_value = 2 # Not formatted.
Alexei Svitkinef3cac412017-02-06 11:08:50 -05005172
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005173 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005174
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005175
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005176def GetDiffXMLs(diff_files):
5177 return [
5178 os.path.normpath(x) for x in diff_files if MatchingFileType(x, ['.xml'])
5179 ]
5180
5181
5182def GetMetricsDir(diff_xml):
Steven Holte2e664bf2017-04-21 13:10:47 -07005183 metrics_xml_dirs = [
5184 os.path.join('tools', 'metrics', 'actions'),
5185 os.path.join('tools', 'metrics', 'histograms'),
5186 os.path.join('tools', 'metrics', 'rappor'),
Ilya Shermanb67e60c2020-05-20 22:27:03 +00005187 os.path.join('tools', 'metrics', 'structured'),
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005188 os.path.join('tools', 'metrics', 'ukm'),
5189 ]
Steven Holte2e664bf2017-04-21 13:10:47 -07005190 for xml_dir in metrics_xml_dirs:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005191 if diff_xml.startswith(xml_dir):
5192 return xml_dir
5193 return None
Steven Holte2e664bf2017-04-21 13:10:47 -07005194
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005195
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005196@subcommand.usage('<codereview url or issue id>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005197@metrics.collector.collect_metrics('git cl checkout')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005198def CMDcheckout(parser, args):
Edward Lemurf38bc172019-09-03 21:02:13 +00005199 """Checks out a branch associated with a given Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005200 _, args = parser.parse_args(args)
5201
5202 if len(args) != 1:
5203 parser.print_help()
5204 return 1
5205
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005206 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005207 if not issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005208 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02005209
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005210 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005211
Edward Lemur52969c92020-02-06 18:15:28 +00005212 output = RunGit(['config', '--local', '--get-regexp',
Edward Lesmes50da7702020-03-30 19:23:43 +00005213 r'branch\..*\.' + ISSUE_CONFIG_KEY],
Edward Lemur52969c92020-02-06 18:15:28 +00005214 error_ok=True)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005215
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005216 branches = []
Edward Lemur52969c92020-02-06 18:15:28 +00005217 for key, issue in [x.split() for x in output.splitlines()]:
5218 if issue == target_issue:
Edward Lesmes50da7702020-03-30 19:23:43 +00005219 branches.append(re.sub(r'branch\.(.*)\.' + ISSUE_CONFIG_KEY, r'\1', key))
Edward Lemur52969c92020-02-06 18:15:28 +00005220
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005221 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005222 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005223 return 1
5224 if len(branches) == 1:
5225 RunGit(['checkout', branches[0]])
5226 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005227 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005228 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005229 print('%d: %s' % (i, branches[i]))
Edward Lesmesae3586b2020-03-23 21:21:14 +00005230 which = gclient_utils.AskForData('Choose by index: ')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005231 try:
5232 RunGit(['checkout', branches[int(which)]])
5233 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005234 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005235 return 1
5236
5237 return 0
5238
5239
maruel@chromium.org29404b52014-09-08 22:58:00 +00005240def CMDlol(parser, args):
5241 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005242 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005243 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5244 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5245 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
Gavin Mak18f45d22020-12-04 21:45:10 +00005246 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')).decode('utf-8'))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005247 return 0
5248
5249
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005250class OptionParser(optparse.OptionParser):
5251 """Creates the option parse and add --verbose support."""
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00005252
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005253 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005254 optparse.OptionParser.__init__(
5255 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005256 self.add_option(
5257 '-v', '--verbose', action='count', default=0,
5258 help='Use 2 times for more debugging info')
5259
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005260 def parse_args(self, args=None, _values=None):
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005261 try:
5262 return self._parse_args(args)
5263 finally:
5264 # Regardless of success or failure of args parsing, we want to report
5265 # metrics, but only after logging has been initialized (if parsing
5266 # succeeded).
5267 global settings
5268 settings = Settings()
5269
5270 if not metrics.DISABLE_METRICS_COLLECTION:
5271 # GetViewVCUrl ultimately calls logging method.
5272 project_url = settings.GetViewVCUrl().strip('/+')
5273 if project_url in metrics_utils.KNOWN_PROJECT_URLS:
5274 metrics.collector.add('project_urls', [project_url])
5275
5276 def _parse_args(self, args=None):
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005277 # Create an optparse.Values object that will store only the actual passed
5278 # options, without the defaults.
5279 actual_options = optparse.Values()
5280 _, args = optparse.OptionParser.parse_args(self, args, actual_options)
5281 # Create an optparse.Values object with the default options.
5282 options = optparse.Values(self.get_default_values().__dict__)
5283 # Update it with the options passed by the user.
5284 options._update_careful(actual_options.__dict__)
5285 # Store the options passed by the user in an _actual_options attribute.
5286 # We store only the keys, and not the values, since the values can contain
5287 # arbitrary information, which might be PII.
Edward Lemur79d4f992019-11-11 23:49:02 +00005288 metrics.collector.add('arguments', list(actual_options.__dict__.keys()))
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005289
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005290 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
Andrii Shyshkalov5b04a572017-01-23 17:44:41 +01005291 logging.basicConfig(
5292 level=levels[min(options.verbose, len(levels) - 1)],
5293 format='[%(levelname).1s%(asctime)s %(process)d %(thread)d '
5294 '%(filename)s] %(message)s')
Edward Lemur83bd7f42018-10-10 00:14:21 +00005295
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005296 return options, args
5297
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005298
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005299def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005300 if sys.hexversion < 0x02060000:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005301 print('\nYour Python version %s is unsupported, please upgrade.\n' %
vapiera7fbd5a2016-06-16 09:17:49 -07005302 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005303 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005304
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005305 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005306 dispatcher = subcommand.CommandDispatcher(__name__)
5307 try:
5308 return dispatcher.execute(OptionParser(), argv)
Edward Lemur5b929a42019-10-21 17:57:39 +00005309 except auth.LoginRequiredError as e:
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005310 DieWithError(str(e))
Edward Lemur79d4f992019-11-11 23:49:02 +00005311 except urllib.error.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005312 if e.code != 500:
5313 raise
5314 DieWithError(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005315 ('App Engine is misbehaving and returned HTTP %d, again. Keep faith '
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005316 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005317 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005318
5319
5320if __name__ == '__main__':
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005321 # These affect sys.stdout, so do it outside of main() to simplify mocks in
5322 # the unit tests.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005323 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005324 setup_color.init()
Edward Lemur6f812e12018-07-31 22:45:57 +00005325 with metrics.collector.print_notice_and_exit():
sbc@chromium.org013731e2015-02-26 18:28:43 +00005326 sys.exit(main(sys.argv[1:]))