blob: 4aa1155136ae23d8e408c614ebc05109b0bfc2aa [file] [log] [blame]
Josip Sokcevic4de5dea2022-03-23 21:15:14 +00001#!/usr/bin/env vpython3
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
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +000049import rustfmt
maruel@chromium.org2a74d372011-03-29 19:05:50 +000050import scm
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +000051import setup_color
Francois Dorayd42c6812017-05-30 15:10:20 -040052import split_cl
maruel@chromium.org0633fb42013-08-16 20:06:14 +000053import subcommand
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +000054import subprocess2
Olivier Robin0a6b5442022-04-07 07:25:04 +000055import swift_format
maruel@chromium.org2a74d372011-03-29 19:05:50 +000056import watchlists
57
Edward Lemur79d4f992019-11-11 23:49:02 +000058from third_party import six
59from six.moves import urllib
60
61
62if sys.version_info.major == 3:
63 basestring = (str,) # pylint: disable=redefined-builtin
64
Edward Lemurb9830242019-10-30 22:19:20 +000065
tandrii7400cf02016-06-21 08:48:07 -070066__version__ = '2.0'
maruel@chromium.org2a74d372011-03-29 19:05:50 +000067
Edward Lemur0f58ae42019-04-30 17:24:12 +000068# Traces for git push will be stored in a traces directory inside the
69# depot_tools checkout.
70DEPOT_TOOLS = os.path.dirname(os.path.abspath(__file__))
71TRACES_DIR = os.path.join(DEPOT_TOOLS, 'traces')
Edward Lemur227d5102020-02-25 23:45:35 +000072PRESUBMIT_SUPPORT = os.path.join(DEPOT_TOOLS, 'presubmit_support.py')
Edward Lemur0f58ae42019-04-30 17:24:12 +000073
74# When collecting traces, Git hashes will be reduced to 6 characters to reduce
75# the size after compression.
76GIT_HASH_RE = re.compile(r'\b([a-f0-9]{6})[a-f0-9]{34}\b', flags=re.I)
77# Used to redact the cookies from the gitcookies file.
78GITCOOKIES_REDACT_RE = re.compile(r'1/.*')
79
Edward Lemurd4d1ba42019-09-20 21:46:37 +000080MAX_ATTEMPTS = 3
81
Edward Lemur1b52d872019-05-09 21:12:12 +000082# The maximum number of traces we will keep. Multiplied by 3 since we store
83# 3 files per trace.
84MAX_TRACES = 3 * 10
Edward Lemur5737f022019-05-17 01:24:00 +000085# Message to be displayed to the user to inform where to find the traces for a
86# git-cl upload execution.
Edward Lemur0f58ae42019-04-30 17:24:12 +000087TRACES_MESSAGE = (
Edward Lemur1b52d872019-05-09 21:12:12 +000088'\n'
Edward Lemur5737f022019-05-17 01:24:00 +000089'The traces of this git-cl execution have been recorded at:\n'
Edward Lemur1b52d872019-05-09 21:12:12 +000090' %(trace_name)s-traces.zip\n'
Edward Lemur5737f022019-05-17 01:24:00 +000091'Copies of your gitcookies file and git config have been recorded at:\n'
92' %(trace_name)s-git-info.zip\n')
Edward Lemur1b52d872019-05-09 21:12:12 +000093# Format of the message to be stored as part of the traces to give developers a
94# better context when they go through traces.
95TRACES_README_FORMAT = (
96'Date: %(now)s\n'
97'\n'
98'Change: https://%(gerrit_host)s/q/%(change_id)s\n'
99'Title: %(title)s\n'
100'\n'
101'%(description)s\n'
102'\n'
103'Execution time: %(execution_time)s\n'
104'Exit code: %(exit_code)s\n') + TRACES_MESSAGE
Edward Lemur0f58ae42019-04-30 17:24:12 +0000105
Aaron Gable1bc7bfe2016-12-19 10:08:14 -0800106POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land'
Henrique Ferreiroff249622019-11-28 23:19:29 +0000107DESCRIPTION_BACKUP_FILE = '.git_cl_description_backup'
rmistry@google.comc68112d2015-03-03 12:48:06 +0000108REFS_THAT_ALIAS_TO_OTHER_REFS = {
Josip Sokcevic7e133ff2021-07-13 17:44:53 +0000109 'refs/remotes/origin/lkgr': 'refs/remotes/origin/main',
110 'refs/remotes/origin/lkcr': 'refs/remotes/origin/main',
rmistry@google.comc68112d2015-03-03 12:48:06 +0000111}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000112
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000113DEFAULT_OLD_BRANCH = 'refs/remotes/origin/master'
114DEFAULT_NEW_BRANCH = 'refs/remotes/origin/main'
115
thestig@chromium.org44202a22014-03-11 19:22:18 +0000116# Valid extensions for files we want to lint.
117DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
118DEFAULT_LINT_IGNORE_REGEX = r"$^"
119
Aiden Bennerc08566e2018-10-03 17:52:42 +0000120# File name for yapf style config files.
121YAPF_CONFIG_FILENAME = '.style.yapf'
122
Edward Lesmes50da7702020-03-30 19:23:43 +0000123# The issue, patchset and codereview server are stored on git config for each
124# branch under branch.<branch-name>.<config-key>.
125ISSUE_CONFIG_KEY = 'gerritissue'
126PATCHSET_CONFIG_KEY = 'gerritpatchset'
127CODEREVIEW_SERVER_CONFIG_KEY = 'gerritserver'
128
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000129# Shortcut since it quickly becomes repetitive.
maruel@chromium.org2e23ce32013-05-07 12:42:28 +0000130Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +0000131
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000132# Initialized in main()
133settings = None
134
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100135# Used by tests/git_cl_test.py to add extra logging.
136# Inside the weirdly failing test, add this:
137# >>> self.mock(git_cl, '_IS_BEING_TESTED', True)
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700138# And scroll up to see the stack trace printed.
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100139_IS_BEING_TESTED = False
140
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000141
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000142_KNOWN_GERRIT_TO_SHORT_URLS = {
143 'https://chrome-internal-review.googlesource.com': 'https://crrev.com/i',
144 'https://chromium-review.googlesource.com': 'https://crrev.com/c',
145}
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000146assert len(_KNOWN_GERRIT_TO_SHORT_URLS) == len(
147 set(_KNOWN_GERRIT_TO_SHORT_URLS.values())), 'must have unique values'
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000148
149
Josip Sokcevicf736cab2020-10-20 23:41:38 +0000150class GitPushError(Exception):
151 pass
152
153
Christopher Lamf732cd52017-01-24 12:40:11 +1100154def DieWithError(message, change_desc=None):
155 if change_desc:
156 SaveDescriptionBackup(change_desc)
Josip Sokcevic953278a2020-02-28 19:46:36 +0000157 print('\n ** Content of CL description **\n' +
158 '='*72 + '\n' +
159 change_desc.description + '\n' +
160 '='*72 + '\n')
Christopher Lamf732cd52017-01-24 12:40:11 +1100161
vapiera7fbd5a2016-06-16 09:17:49 -0700162 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000163 sys.exit(1)
164
165
Christopher Lamf732cd52017-01-24 12:40:11 +1100166def SaveDescriptionBackup(change_desc):
Henrique Ferreiro5ae48172019-11-29 16:14:42 +0000167 backup_path = os.path.join(DEPOT_TOOLS, DESCRIPTION_BACKUP_FILE)
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +0000168 print('\nsaving CL description to %s\n' % backup_path)
sokcevic07152802021-08-18 00:06:34 +0000169 with open(backup_path, 'wb') as backup_file:
170 backup_file.write(change_desc.description.encode('utf-8'))
Christopher Lamf732cd52017-01-24 12:40:11 +1100171
172
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000173def GetNoGitPagerEnv():
174 env = os.environ.copy()
175 # 'cat' is a magical git string that disables pagers on all platforms.
176 env['GIT_PAGER'] = 'cat'
177 return env
178
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000179
bsep@chromium.org627d9002016-04-29 00:00:52 +0000180def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000181 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000182 stdout = subprocess2.check_output(args, shell=shell, **kwargs)
183 return stdout.decode('utf-8', 'replace')
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000184 except subprocess2.CalledProcessError as e:
185 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000186 if not error_ok:
Alan Cutter594fd332020-07-21 23:55:27 +0000187 message = error_message or e.stdout.decode('utf-8', 'replace') or ''
188 DieWithError('Command "%s" failed.\n%s' % (' '.join(args), message))
Josip Sokcevic673e8ed2021-10-27 23:46:18 +0000189 out = e.stdout.decode('utf-8', 'replace')
190 if e.stderr:
191 out += e.stderr.decode('utf-8', 'replace')
192 return out
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000193
194
195def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000196 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000197 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000198
199
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000200def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000201 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700202 if suppress_stderr:
Edward Lesmescf06cad2020-12-14 22:03:23 +0000203 stderr = subprocess2.DEVNULL
tandrii5d48c322016-08-18 16:19:37 -0700204 else:
205 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000206 try:
tandrii5d48c322016-08-18 16:19:37 -0700207 (out, _), code = subprocess2.communicate(['git'] + args,
208 env=GetNoGitPagerEnv(),
209 stdout=subprocess2.PIPE,
210 stderr=stderr)
Edward Lemur79d4f992019-11-11 23:49:02 +0000211 return code, out.decode('utf-8', 'replace')
tandrii5d48c322016-08-18 16:19:37 -0700212 except subprocess2.CalledProcessError as e:
Yoshisato Yanagisawa81e3ff52017-09-26 15:33:34 +0900213 logging.debug('Failed running %s', ['git'] + args)
Edward Lemur79d4f992019-11-11 23:49:02 +0000214 return e.returncode, e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000215
216
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000217def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000218 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000219 return RunGitWithCode(args, suppress_stderr=True)[1]
220
221
tandrii2a16b952016-10-19 07:09:44 -0700222def time_sleep(seconds):
223 # Use this so that it can be mocked in tests without interfering with python
224 # system machinery.
tandrii2a16b952016-10-19 07:09:44 -0700225 return time.sleep(seconds)
226
227
Edward Lemur01f4a4f2018-11-03 00:40:38 +0000228def time_time():
229 # Use this so that it can be mocked in tests without interfering with python
230 # system machinery.
231 return time.time()
232
233
Edward Lemur1b52d872019-05-09 21:12:12 +0000234def datetime_now():
235 # Use this so that it can be mocked in tests without interfering with python
236 # system machinery.
237 return datetime.datetime.now()
238
239
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100240def confirm_or_exit(prefix='', action='confirm'):
241 """Asks user to press enter to continue or press Ctrl+C to abort."""
242 if not prefix or prefix.endswith('\n'):
243 mid = 'Press'
Andrii Shyshkalov353637c2017-03-14 16:52:18 +0100244 elif prefix.endswith('.') or prefix.endswith('?'):
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100245 mid = ' Press'
246 elif prefix.endswith(' '):
247 mid = 'press'
248 else:
249 mid = ' press'
Edward Lesmesae3586b2020-03-23 21:21:14 +0000250 gclient_utils.AskForData(
251 '%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action))
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100252
253
254def ask_for_explicit_yes(prompt):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000255 """Returns whether user typed 'y' or 'yes' to confirm the given prompt."""
Edward Lesmesae3586b2020-03-23 21:21:14 +0000256 result = gclient_utils.AskForData(prompt + ' [Yes/No]: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100257 while True:
258 if 'yes'.startswith(result):
259 return True
260 if 'no'.startswith(result):
261 return False
Edward Lesmesae3586b2020-03-23 21:21:14 +0000262 result = gclient_utils.AskForData('Please, type yes or no: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100263
264
machenbach@chromium.org45453142015-09-15 08:45:22 +0000265def _get_properties_from_options(options):
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000266 prop_list = getattr(options, 'properties', [])
267 properties = dict(x.split('=', 1) for x in prop_list)
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000268 for key, val in properties.items():
machenbach@chromium.org45453142015-09-15 08:45:22 +0000269 try:
270 properties[key] = json.loads(val)
271 except ValueError:
272 pass # If a value couldn't be evaluated, treat it as a string.
273 return properties
274
275
Edward Lemur4c707a22019-09-24 21:13:43 +0000276def _call_buildbucket(http, buildbucket_host, method, request):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000277 """Calls a buildbucket v2 method and returns the parsed json response."""
278 headers = {
279 'Accept': 'application/json',
280 'Content-Type': 'application/json',
281 }
282 request = json.dumps(request)
283 url = 'https://%s/prpc/buildbucket.v2.Builds/%s' % (buildbucket_host, method)
284
285 logging.info('POST %s with %s' % (url, request))
286
287 attempts = 1
288 time_to_sleep = 1
289 while True:
290 response, content = http.request(url, 'POST', body=request, headers=headers)
291 if response.status == 200:
292 return json.loads(content[4:])
293 if attempts >= MAX_ATTEMPTS or 400 <= response.status < 500:
294 msg = '%s error when calling POST %s with %s: %s' % (
295 response.status, url, request, content)
296 raise BuildbucketResponseException(msg)
297 logging.debug(
298 '%s error when calling POST %s with %s. '
299 'Sleeping for %d seconds and retrying...' % (
300 response.status, url, request, time_to_sleep))
301 time.sleep(time_to_sleep)
302 time_to_sleep *= 2
303 attempts += 1
304
305 assert False, 'unreachable'
306
307
Edward Lemur6215c792019-10-03 21:59:05 +0000308def _parse_bucket(raw_bucket):
309 legacy = True
310 project = bucket = None
311 if '/' in raw_bucket:
312 legacy = False
313 project, bucket = raw_bucket.split('/', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000314 # Assume luci.<project>.<bucket>.
Edward Lemur6215c792019-10-03 21:59:05 +0000315 elif raw_bucket.startswith('luci.'):
316 project, bucket = raw_bucket[len('luci.'):].split('.', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000317 # Otherwise, assume prefix is also the project name.
Edward Lemur6215c792019-10-03 21:59:05 +0000318 elif '.' in raw_bucket:
319 project = raw_bucket.split('.')[0]
320 bucket = raw_bucket
321 # Legacy buckets.
Edward Lemur45768512020-03-02 19:03:14 +0000322 if legacy and project and bucket:
Edward Lemur6215c792019-10-03 21:59:05 +0000323 print('WARNING Please use %s/%s to specify the bucket.' % (project, bucket))
324 return project, bucket
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000325
326
Quinten Yearsley777660f2020-03-04 23:37:06 +0000327def _trigger_tryjobs(changelist, jobs, options, patchset):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000328 """Sends a request to Buildbucket to trigger tryjobs for a changelist.
qyearsley1fdfcb62016-10-24 13:22:03 -0700329
330 Args:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000331 changelist: Changelist that the tryjobs are associated with.
Edward Lemur45768512020-03-02 19:03:14 +0000332 jobs: A list of (project, bucket, builder).
qyearsley1fdfcb62016-10-24 13:22:03 -0700333 options: Command-line options.
334 """
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000335 print('Scheduling jobs on:')
Edward Lemur45768512020-03-02 19:03:14 +0000336 for project, bucket, builder in jobs:
337 print(' %s/%s: %s' % (project, bucket, builder))
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000338 print('To see results here, run: git cl try-results')
339 print('To see results in browser, run: git cl web')
tandriide281ae2016-10-12 06:02:30 -0700340
Quinten Yearsley777660f2020-03-04 23:37:06 +0000341 requests = _make_tryjob_schedule_requests(changelist, jobs, options, patchset)
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000342 if not requests:
343 return
344
Edward Lemur5b929a42019-10-21 17:57:39 +0000345 http = auth.Authenticator().authorize(httplib2.Http())
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000346 http.force_exception_to_status_code = True
347
348 batch_request = {'requests': requests}
349 batch_response = _call_buildbucket(
350 http, options.buildbucket_host, 'Batch', batch_request)
351
352 errors = [
353 ' ' + response['error']['message']
354 for response in batch_response.get('responses', [])
355 if 'error' in response
356 ]
357 if errors:
358 raise BuildbucketResponseException(
359 'Failed to schedule builds for some bots:\n%s' % '\n'.join(errors))
360
361
Quinten Yearsley777660f2020-03-04 23:37:06 +0000362def _make_tryjob_schedule_requests(changelist, jobs, options, patchset):
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000363 """Constructs requests for Buildbucket to trigger tryjobs."""
Edward Lemurf0faf482019-09-25 20:40:17 +0000364 gerrit_changes = [changelist.GetGerritChange(patchset)]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000365 shared_properties = {
366 'category': options.ensure_value('category', 'git_cl_try')
367 }
368 if options.ensure_value('clobber', False):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000369 shared_properties['clobber'] = True
370 shared_properties.update(_get_properties_from_options(options) or {})
371
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000372 shared_tags = [{'key': 'user_agent', 'value': 'git_cl_try'}]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000373 if options.ensure_value('retry_failed', False):
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000374 shared_tags.append({'key': 'retry_failed',
375 'value': '1'})
376
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000377 requests = []
Edward Lemur45768512020-03-02 19:03:14 +0000378 for (project, bucket, builder) in jobs:
379 properties = shared_properties.copy()
380 if 'presubmit' in builder.lower():
381 properties['dry_run'] = 'true'
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000382
Edward Lemur45768512020-03-02 19:03:14 +0000383 requests.append({
384 'scheduleBuild': {
385 'requestId': str(uuid.uuid4()),
386 'builder': {
387 'project': getattr(options, 'project', None) or project,
388 'bucket': bucket,
389 'builder': builder,
390 },
391 'gerritChanges': gerrit_changes,
392 'properties': properties,
393 'tags': [
394 {'key': 'builder', 'value': builder},
395 ] + shared_tags,
396 }
397 })
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000398
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000399 if options.ensure_value('revision', None):
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000400 remote, remote_branch = changelist.GetRemoteBranch()
Edward Lemur45768512020-03-02 19:03:14 +0000401 requests[-1]['scheduleBuild']['gitilesCommit'] = {
402 'host': gerrit_changes[0]['host'],
403 'project': gerrit_changes[0]['project'],
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000404 'id': options.revision,
405 'ref': GetTargetRef(remote, remote_branch, None)
Edward Lemur45768512020-03-02 19:03:14 +0000406 }
Anthony Polito1a5fe232020-01-24 23:17:52 +0000407
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000408 return requests
kjellander@chromium.org44424542015-06-02 18:35:29 +0000409
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000410
Quinten Yearsley777660f2020-03-04 23:37:06 +0000411def _fetch_tryjobs(changelist, buildbucket_host, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000412 """Fetches tryjobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000413
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000414 Returns list of buildbucket.v2.Build with the try jobs for the changelist.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000415 """
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000416 fields = ['id', 'builder', 'status', 'createTime', 'tags']
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000417 request = {
418 'predicate': {
419 'gerritChanges': [changelist.GetGerritChange(patchset)],
420 },
421 'fields': ','.join('builds.*.' + field for field in fields),
422 }
tandrii221ab252016-10-06 08:12:04 -0700423
Edward Lemur5b929a42019-10-21 17:57:39 +0000424 authenticator = auth.Authenticator()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000425 if authenticator.has_cached_credentials():
426 http = authenticator.authorize(httplib2.Http())
427 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700428 print('Warning: Some results might be missing because %s' %
429 # Get the message on how to login.
Andrii Shyshkalov2517afd2021-01-19 17:07:43 +0000430 (str(auth.LoginRequiredError()),))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000431 http = httplib2.Http()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000432 http.force_exception_to_status_code = True
433
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000434 response = _call_buildbucket(http, buildbucket_host, 'SearchBuilds', request)
435 return response.get('builds', [])
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000436
Edward Lemur45768512020-03-02 19:03:14 +0000437
Edward Lemur5b929a42019-10-21 17:57:39 +0000438def _fetch_latest_builds(changelist, buildbucket_host, latest_patchset=None):
Quinten Yearsley983111f2019-09-26 17:18:48 +0000439 """Fetches builds from the latest patchset that has builds (within
440 the last few patchsets).
441
442 Args:
Quinten Yearsley983111f2019-09-26 17:18:48 +0000443 changelist (Changelist): The CL to fetch builds for
444 buildbucket_host (str): Buildbucket host, e.g. "cr-buildbucket.appspot.com"
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000445 lastest_patchset(int|NoneType): the patchset to start fetching builds from.
446 If None (default), starts with the latest available patchset.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000447 Returns:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000448 A tuple (builds, patchset) where builds is a list of buildbucket.v2.Build,
449 and patchset is the patchset number where those builds came from.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000450 """
451 assert buildbucket_host
452 assert changelist.GetIssue(), 'CL must be uploaded first'
453 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000454 if latest_patchset is None:
455 assert changelist.GetMostRecentPatchset()
456 ps = changelist.GetMostRecentPatchset()
457 else:
458 assert latest_patchset > 0, latest_patchset
459 ps = latest_patchset
460
Quinten Yearsley983111f2019-09-26 17:18:48 +0000461 min_ps = max(1, ps - 5)
462 while ps >= min_ps:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000463 builds = _fetch_tryjobs(changelist, buildbucket_host, patchset=ps)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000464 if len(builds):
465 return builds, ps
466 ps -= 1
467 return [], 0
468
469
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000470def _filter_failed_for_retry(all_builds):
471 """Returns a list of buckets/builders that are worth retrying.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000472
473 Args:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000474 all_builds (list): Builds, in the format returned by _fetch_tryjobs,
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000475 i.e. a list of buildbucket.v2.Builds which includes status and builder
476 info.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000477
478 Returns:
Edward Lemur45768512020-03-02 19:03:14 +0000479 A dict {(proj, bucket): [builders]}. This is the same format accepted by
Quinten Yearsley777660f2020-03-04 23:37:06 +0000480 _trigger_tryjobs.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000481 """
Edward Lemur45768512020-03-02 19:03:14 +0000482 grouped = {}
483 for build in all_builds:
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000484 builder = build['builder']
Edward Lemur45768512020-03-02 19:03:14 +0000485 key = (builder['project'], builder['bucket'], builder['builder'])
486 grouped.setdefault(key, []).append(build)
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000487
Edward Lemur45768512020-03-02 19:03:14 +0000488 jobs = []
489 for (project, bucket, builder), builds in grouped.items():
490 if 'triggered' in builder:
491 print('WARNING: Not scheduling %s. Triggered bots require an initial job '
492 'from a parent. Please schedule a manual job for the parent '
493 'instead.')
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000494 continue
495 if any(b['status'] in ('STARTED', 'SCHEDULED') for b in builds):
496 # Don't retry if any are running.
497 continue
Edward Lemur45768512020-03-02 19:03:14 +0000498 # If builder had several builds, retry only if the last one failed.
499 # This is a bit different from CQ, which would re-use *any* SUCCESS-full
500 # build, but in case of retrying failed jobs retrying a flaky one makes
501 # sense.
502 builds = sorted(builds, key=lambda b: b['createTime'])
503 if builds[-1]['status'] not in ('FAILURE', 'INFRA_FAILURE'):
504 continue
505 # Don't retry experimental build previously triggered by CQ.
506 if any(t['key'] == 'cq_experimental' and t['value'] == 'true'
507 for t in builds[-1]['tags']):
508 continue
509 jobs.append((project, bucket, builder))
510
511 # Sort the jobs to make testing easier.
512 return sorted(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000513
514
Quinten Yearsley777660f2020-03-04 23:37:06 +0000515def _print_tryjobs(options, builds):
516 """Prints nicely result of _fetch_tryjobs."""
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000517 if not builds:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000518 print('No tryjobs scheduled.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000519 return
520
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000521 longest_builder = max(len(b['builder']['builder']) for b in builds)
522 name_fmt = '{builder:<%d}' % longest_builder
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000523 if options.print_master:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000524 longest_bucket = max(len(b['builder']['bucket']) for b in builds)
525 name_fmt = ('{bucket:>%d} ' % longest_bucket) + name_fmt
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000526
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000527 builds_by_status = {}
528 for b in builds:
529 builds_by_status.setdefault(b['status'], []).append({
530 'id': b['id'],
531 'name': name_fmt.format(
532 builder=b['builder']['builder'], bucket=b['builder']['bucket']),
533 })
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000534
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000535 sort_key = lambda b: (b['name'], b['id'])
536
537 def print_builds(title, builds, fmt=None, color=None):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000538 """Pop matching builds from `builds` dict and print them."""
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000539 if not builds:
540 return
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000541
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000542 fmt = fmt or '{name} https://ci.chromium.org/b/{id}'
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000543 if not options.color or color is None:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000544 colorize = lambda x: x
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000545 else:
546 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
547
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000548 print(colorize(title))
549 for b in sorted(builds, key=sort_key):
550 print(' ', colorize(fmt.format(**b)))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000551
552 total = len(builds)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000553 print_builds(
554 'Successes:', builds_by_status.pop('SUCCESS', []), color=Fore.GREEN)
555 print_builds(
556 'Infra Failures:', builds_by_status.pop('INFRA_FAILURE', []),
557 color=Fore.MAGENTA)
558 print_builds('Failures:', builds_by_status.pop('FAILURE', []), color=Fore.RED)
559 print_builds('Canceled:', builds_by_status.pop('CANCELED', []), fmt='{name}',
560 color=Fore.MAGENTA)
Andrii Shyshkalov792630c2020-10-19 16:47:44 +0000561 print_builds('Started:', builds_by_status.pop('STARTED', []),
562 color=Fore.YELLOW)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000563 print_builds(
564 'Scheduled:', builds_by_status.pop('SCHEDULED', []), fmt='{name} id={id}')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000565 # The last section is just in case buildbucket API changes OR there is a bug.
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000566 print_builds(
567 'Other:', sum(builds_by_status.values(), []), fmt='{name} id={id}')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000568 print('Total: %d tryjobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000569
570
Aiden Bennerc08566e2018-10-03 17:52:42 +0000571def _ComputeDiffLineRanges(files, upstream_commit):
572 """Gets the changed line ranges for each file since upstream_commit.
573
574 Parses a git diff on provided files and returns a dict that maps a file name
575 to an ordered list of range tuples in the form (start_line, count).
576 Ranges are in the same format as a git diff.
577 """
578 # If files is empty then diff_output will be a full diff.
579 if len(files) == 0:
580 return {}
581
Aiden Benner6c18a1a2018-11-23 20:18:23 +0000582 # Take the git diff and find the line ranges where there are changes.
Jamie Madill3671a6a2019-10-24 15:13:21 +0000583 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000584 diff_output = RunGit(diff_cmd)
585
586 pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)'
587 # 2 capture groups
588 # 0 == fname of diff file
589 # 1 == 'diff_start,diff_count' or 'diff_start'
590 # will match each of
591 # diff --git a/foo.foo b/foo.py
592 # @@ -12,2 +14,3 @@
593 # @@ -12,2 +17 @@
594 # running re.findall on the above string with pattern will give
595 # [('foo.py', ''), ('', '14,3'), ('', '17')]
596
597 curr_file = None
598 line_diffs = {}
599 for match in re.findall(pattern, diff_output, flags=re.MULTILINE):
600 if match[0] != '':
601 # Will match the second filename in diff --git a/a.py b/b.py.
602 curr_file = match[0]
603 line_diffs[curr_file] = []
604 else:
605 # Matches +14,3
606 if ',' in match[1]:
607 diff_start, diff_count = match[1].split(',')
608 else:
609 # Single line changes are of the form +12 instead of +12,1.
610 diff_start = match[1]
611 diff_count = 1
612
613 diff_start = int(diff_start)
614 diff_count = int(diff_count)
615
616 # If diff_count == 0 this is a removal we can ignore.
617 line_diffs[curr_file].append((diff_start, diff_count))
618
619 return line_diffs
620
621
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000622def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000623 """Checks if a yapf file is in any parent directory of fpath until top_dir.
624
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000625 Recursively checks parent directories to find yapf file and if no yapf file
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000626 is found returns None. Uses yapf_config_cache as a cache for previously found
627 configs.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000628 """
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000629 fpath = os.path.abspath(fpath)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000630 # Return result if we've already computed it.
631 if fpath in yapf_config_cache:
632 return yapf_config_cache[fpath]
633
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000634 parent_dir = os.path.dirname(fpath)
635 if os.path.isfile(fpath):
636 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000637 else:
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000638 # Otherwise fpath is a directory
639 yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME)
640 if os.path.isfile(yapf_file):
641 ret = yapf_file
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +0000642 elif fpath in (top_dir, parent_dir):
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000643 # If we're at the top level directory, or if we're at root
644 # there is no provided style.
645 ret = None
646 else:
647 # Otherwise recurse on the current directory.
648 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000649 yapf_config_cache[fpath] = ret
650 return ret
651
652
Brian Sheedyb4307d52019-12-02 19:18:17 +0000653def _GetYapfIgnorePatterns(top_dir):
654 """Returns all patterns in the .yapfignore file.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000655
656 yapf is supposed to handle the ignoring of files listed in .yapfignore itself,
657 but this functionality appears to break when explicitly passing files to
658 yapf for formatting. According to
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000659 https://github.com/google/yapf/blob/HEAD/README.rst#excluding-files-from-formatting-yapfignore,
Brian Sheedy59b06a82019-10-14 17:03:29 +0000660 the .yapfignore file should be in the directory that yapf is invoked from,
661 which we assume to be the top level directory in this case.
662
663 Args:
664 top_dir: The top level directory for the repository being formatted.
665
666 Returns:
Brian Sheedyb4307d52019-12-02 19:18:17 +0000667 A set of all fnmatch patterns to be ignored.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000668 """
669 yapfignore_file = os.path.join(top_dir, '.yapfignore')
Brian Sheedyb4307d52019-12-02 19:18:17 +0000670 ignore_patterns = set()
Brian Sheedy59b06a82019-10-14 17:03:29 +0000671 if not os.path.exists(yapfignore_file):
Brian Sheedyb4307d52019-12-02 19:18:17 +0000672 return ignore_patterns
Brian Sheedy59b06a82019-10-14 17:03:29 +0000673
Anthony Politoc64e3902021-04-30 21:55:25 +0000674 for line in gclient_utils.FileRead(yapfignore_file).split('\n'):
675 stripped_line = line.strip()
676 # Comments and blank lines should be ignored.
677 if stripped_line.startswith('#') or stripped_line == '':
678 continue
679 ignore_patterns.add(stripped_line)
Brian Sheedyb4307d52019-12-02 19:18:17 +0000680 return ignore_patterns
681
682
683def _FilterYapfIgnoredFiles(filepaths, patterns):
684 """Filters out any filepaths that match any of the given patterns.
685
686 Args:
687 filepaths: An iterable of strings containing filepaths to filter.
688 patterns: An iterable of strings containing fnmatch patterns to filter on.
689
690 Returns:
691 A list of strings containing all the elements of |filepaths| that did not
692 match any of the patterns in |patterns|.
693 """
694 # Not inlined so that tests can use the same implementation.
695 return [f for f in filepaths
696 if not any(fnmatch.fnmatch(f, p) for p in patterns)]
Brian Sheedy59b06a82019-10-14 17:03:29 +0000697
698
Aaron Gable13101a62018-02-09 13:20:41 -0800699def print_stats(args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000700 """Prints statistics about the change to the user."""
701 # --no-ext-diff is broken in some versions of Git, so try to work around
702 # this by overriding the environment (but there is still a problem if the
703 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000704 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000705 if 'GIT_EXTERNAL_DIFF' in env:
706 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000707
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000708 return subprocess2.call(
Aaron Gable13101a62018-02-09 13:20:41 -0800709 ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args,
Edward Lemur0db01f02019-11-12 22:01:51 +0000710 env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000711
712
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000713class BuildbucketResponseException(Exception):
714 pass
715
716
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000717class Settings(object):
718 def __init__(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000719 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000720 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000721 self.tree_status_url = None
722 self.viewvc_url = None
723 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000724 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000725 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000726 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000727 self.git_editor = None
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000728 self.format_full_by_default = None
Sigurd Schneider1bfda8e2021-06-30 14:46:25 +0000729 self.is_status_commit_order_by_date = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000730
Edward Lemur26964072020-02-19 19:18:51 +0000731 def _LazyUpdateIfNeeded(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000732 """Updates the settings from a codereview.settings file, if available."""
Edward Lemur26964072020-02-19 19:18:51 +0000733 if self.updated:
734 return
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000735
Edward Lemur26964072020-02-19 19:18:51 +0000736 # The only value that actually changes the behavior is
737 # autoupdate = "false". Everything else means "true".
738 autoupdate = (
739 scm.GIT.GetConfig(self.GetRoot(), 'rietveld.autoupdate', '').lower())
740
741 cr_settings_file = FindCodereviewSettingsFile()
742 if autoupdate != 'false' and cr_settings_file:
743 LoadCodereviewSettingsFromFile(cr_settings_file)
744 cr_settings_file.close()
745
746 self.updated = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000747
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000748 @staticmethod
749 def GetRelativeRoot():
Edward Lesmes50da7702020-03-30 19:23:43 +0000750 return scm.GIT.GetCheckoutRoot('.')
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000751
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000752 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000753 if self.root is None:
754 self.root = os.path.abspath(self.GetRelativeRoot())
755 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000756
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000757 def GetTreeStatusUrl(self, error_ok=False):
758 if not self.tree_status_url:
Edward Lemur26964072020-02-19 19:18:51 +0000759 self.tree_status_url = self._GetConfig('rietveld.tree-status-url')
760 if self.tree_status_url is None and not error_ok:
761 DieWithError(
762 'You must configure your tree status URL by running '
763 '"git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000764 return self.tree_status_url
765
766 def GetViewVCUrl(self):
767 if not self.viewvc_url:
Edward Lemur26964072020-02-19 19:18:51 +0000768 self.viewvc_url = self._GetConfig('rietveld.viewvc-url')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000769 return self.viewvc_url
770
rmistry@google.com90752582014-01-14 21:04:50 +0000771 def GetBugPrefix(self):
Edward Lemur26964072020-02-19 19:18:51 +0000772 return self._GetConfig('rietveld.bug-prefix')
rmistry@google.com78948ed2015-07-08 23:09:57 +0000773
rmistry@google.com5626a922015-02-26 14:03:30 +0000774 def GetRunPostUploadHook(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000775 run_post_upload_hook = self._GetConfig(
Edward Lemur26964072020-02-19 19:18:51 +0000776 'rietveld.run-post-upload-hook')
rmistry@google.com5626a922015-02-26 14:03:30 +0000777 return run_post_upload_hook == "True"
778
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000779 def GetDefaultCCList(self):
Edward Lemur26964072020-02-19 19:18:51 +0000780 return self._GetConfig('rietveld.cc')
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000781
Dirk Pranke6f0df682021-06-25 00:42:33 +0000782 def GetUsePython3(self):
783 return self._GetConfig('rietveld.use-python3')
784
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000785 def GetSquashGerritUploads(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000786 """Returns True if uploads to Gerrit should be squashed by default."""
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000787 if self.squash_gerrit_uploads is None:
Edward Lesmes4de54132020-05-05 19:41:33 +0000788 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
789 if self.squash_gerrit_uploads is None:
Edward Lemur26964072020-02-19 19:18:51 +0000790 # Default is squash now (http://crbug.com/611892#c23).
791 self.squash_gerrit_uploads = self._GetConfig(
792 'gerrit.squash-uploads').lower() != 'false'
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000793 return self.squash_gerrit_uploads
794
Edward Lesmes4de54132020-05-05 19:41:33 +0000795 def GetSquashGerritUploadsOverride(self):
796 """Return True or False if codereview.settings should be overridden.
797
798 Returns None if no override has been defined.
799 """
800 # See also http://crbug.com/611892#c23
801 result = self._GetConfig('gerrit.override-squash-uploads').lower()
802 if result == 'true':
803 return True
804 if result == 'false':
805 return False
806 return None
807
Aleksey Khoroshilov35ef5ad2022-06-03 18:29:25 +0000808 def GetIsGerrit(self):
809 """Return True if gerrit.host is set."""
810 if self.is_gerrit is None:
811 self.is_gerrit = bool(self._GetConfig('gerrit.host', False))
812 return self.is_gerrit
813
tandrii@chromium.org28253532016-04-14 13:46:56 +0000814 def GetGerritSkipEnsureAuthenticated(self):
815 """Return True if EnsureAuthenticated should not be done for Gerrit
816 uploads."""
817 if self.gerrit_skip_ensure_authenticated is None:
Edward Lemur26964072020-02-19 19:18:51 +0000818 self.gerrit_skip_ensure_authenticated = self._GetConfig(
819 'gerrit.skip-ensure-authenticated').lower() == 'true'
tandrii@chromium.org28253532016-04-14 13:46:56 +0000820 return self.gerrit_skip_ensure_authenticated
821
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000822 def GetGitEditor(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000823 """Returns the editor specified in the git config, or None if none is."""
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000824 if self.git_editor is None:
Raul Tambre5a525872019-02-12 19:08:08 +0000825 # Git requires single quotes for paths with spaces. We need to replace
826 # them with double quotes for Windows to treat such paths as a single
827 # path.
Edward Lemur26964072020-02-19 19:18:51 +0000828 self.git_editor = self._GetConfig('core.editor').replace('\'', '"')
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000829 return self.git_editor or None
830
thestig@chromium.org44202a22014-03-11 19:22:18 +0000831 def GetLintRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000832 return self._GetConfig('rietveld.cpplint-regex', DEFAULT_LINT_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000833
834 def GetLintIgnoreRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000835 return self._GetConfig(
836 'rietveld.cpplint-ignore-regex', DEFAULT_LINT_IGNORE_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000837
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000838 def GetFormatFullByDefault(self):
839 if self.format_full_by_default is None:
Jamie Madillac6f6232021-07-07 20:54:08 +0000840 self._LazyUpdateIfNeeded()
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000841 result = (
842 RunGit(['config', '--bool', 'rietveld.format-full-by-default'],
843 error_ok=True).strip())
844 self.format_full_by_default = (result == 'true')
845 return self.format_full_by_default
846
Sigurd Schneider1bfda8e2021-06-30 14:46:25 +0000847 def IsStatusCommitOrderByDate(self):
848 if self.is_status_commit_order_by_date is None:
849 result = (RunGit(['config', '--bool', 'cl.date-order'],
850 error_ok=True).strip())
851 self.is_status_commit_order_by_date = (result == 'true')
852 return self.is_status_commit_order_by_date
853
Edward Lemur26964072020-02-19 19:18:51 +0000854 def _GetConfig(self, key, default=''):
855 self._LazyUpdateIfNeeded()
856 return scm.GIT.GetConfig(self.GetRoot(), key, default)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000857
858
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000859class _CQState(object):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +0000860 """Enum for states of CL with respect to CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000861 NONE = 'none'
Greg Gutermanbe5fccd2021-06-14 17:58:20 +0000862 QUICK_RUN = 'quick_run'
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000863 DRY_RUN = 'dry_run'
864 COMMIT = 'commit'
865
Greg Gutermanbe5fccd2021-06-14 17:58:20 +0000866 ALL_STATES = [NONE, QUICK_RUN, DRY_RUN, COMMIT]
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000867
868
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000869class _ParsedIssueNumberArgument(object):
Edward Lemurf38bc172019-09-03 21:02:13 +0000870 def __init__(self, issue=None, patchset=None, hostname=None):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000871 self.issue = issue
872 self.patchset = patchset
873 self.hostname = hostname
874
875 @property
876 def valid(self):
877 return self.issue is not None
878
879
Edward Lemurf38bc172019-09-03 21:02:13 +0000880def ParseIssueNumberArgument(arg):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000881 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
882 fail_result = _ParsedIssueNumberArgument()
883
Edward Lemur678a6842019-10-03 22:25:05 +0000884 if isinstance(arg, int):
885 return _ParsedIssueNumberArgument(issue=arg)
886 if not isinstance(arg, basestring):
887 return fail_result
888
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000889 if arg.isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +0000890 return _ParsedIssueNumberArgument(issue=int(arg))
Aaron Gableaee6c852017-06-26 12:49:01 -0700891
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000892 url = gclient_utils.UpgradeToHttps(arg)
Alex Turner30ae6372022-01-04 02:32:52 +0000893 if not url.startswith('http'):
894 return fail_result
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000895 for gerrit_url, short_url in _KNOWN_GERRIT_TO_SHORT_URLS.items():
896 if url.startswith(short_url):
897 url = gerrit_url + url[len(short_url):]
898 break
899
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000900 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000901 parsed_url = urllib.parse.urlparse(url)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000902 except ValueError:
903 return fail_result
Andrii Shyshkalov28d840e2017-04-10 15:45:09 +0200904
Alex Turner30ae6372022-01-04 02:32:52 +0000905 # If "https://" was automatically added, fail if `arg` looks unlikely to be a
906 # URL.
907 if not arg.startswith('http') and '.' not in parsed_url.netloc:
908 return fail_result
909
Edward Lemur678a6842019-10-03 22:25:05 +0000910 # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]]
911 # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]]
912 # Short urls like https://domain/<issue_number> can be used, but don't allow
913 # specifying the patchset (you'd 404), but we allow that here.
914 if parsed_url.path == '/':
915 part = parsed_url.fragment
916 else:
917 part = parsed_url.path
918
919 match = re.match(
920 r'(/c(/.*/\+)?)?/(?P<issue>\d+)(/(?P<patchset>\d+)?/?)?$', part)
921 if not match:
922 return fail_result
923
924 issue = int(match.group('issue'))
925 patchset = match.group('patchset')
926 return _ParsedIssueNumberArgument(
927 issue=issue,
928 patchset=int(patchset) if patchset else None,
929 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000930
931
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000932def _create_description_from_log(args):
933 """Pulls out the commit log to use as a base for the CL description."""
934 log_args = []
Bruce Dawson13acea32022-05-03 22:13:08 +0000935 if len(args) == 1 and args[0] == None:
936 # Handle the case where None is passed as the branch.
937 return ''
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000938 if len(args) == 1 and not args[0].endswith('.'):
939 log_args = [args[0] + '..']
940 elif len(args) == 1 and args[0].endswith('...'):
941 log_args = [args[0][:-1]]
942 elif len(args) == 2:
943 log_args = [args[0] + '..' + args[1]]
944 else:
945 log_args = args[:] # Hope for the best!
Manh Nguyene3644862020-08-05 18:25:46 +0000946 return RunGit(['log', '--pretty=format:%B%n'] + log_args)
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000947
948
Aaron Gablea45ee112016-11-22 15:14:38 -0800949class GerritChangeNotExists(Exception):
tandriic2405f52016-10-10 08:13:15 -0700950 def __init__(self, issue, url):
951 self.issue = issue
952 self.url = url
Aaron Gablea45ee112016-11-22 15:14:38 -0800953 super(GerritChangeNotExists, self).__init__()
tandriic2405f52016-10-10 08:13:15 -0700954
955 def __str__(self):
Aaron Gablea45ee112016-11-22 15:14:38 -0800956 return 'change %s at %s does not exist or you have no access to it' % (
tandriic2405f52016-10-10 08:13:15 -0700957 self.issue, self.url)
958
959
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100960_CommentSummary = collections.namedtuple(
Quinten Yearsley0e617c02019-02-20 00:37:03 +0000961 '_CommentSummary', ['date', 'message', 'sender', 'autogenerated',
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100962 # TODO(tandrii): these two aren't known in Gerrit.
963 'approval', 'disapproval'])
964
965
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000966class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000967 """Changelist works with one changelist in local branch.
968
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +0000969 Notes:
970 * Not safe for concurrent multi-{thread,process} use.
971 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -0700972 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000973 """
974
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000975 def __init__(self,
976 branchref=None,
977 issue=None,
978 codereview_host=None,
979 commit_date=None):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000980 """Create a new ChangeList instance.
981
Edward Lemurf38bc172019-09-03 21:02:13 +0000982 **kwargs will be passed directly to Gerrit implementation.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000983 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000984 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +0000985 global settings
986 if not settings:
987 # Happens when git_cl.py is used as a utility library.
988 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000989
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000990 self.branchref = branchref
991 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000992 assert branchref.startswith('refs/heads/')
Edward Lemur85153282020-02-14 22:06:29 +0000993 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000994 else:
995 self.branch = None
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000996 self.commit_date = commit_date
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000997 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +0000998 self.lookedup_issue = False
999 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001000 self.description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001001 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001002 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001003 self.cc = None
Daniel Cheng7227d212017-11-17 08:12:37 -08001004 self.more_cc = []
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001005 self._remote = None
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001006 self._cached_remote_url = (False, None) # (is_cached, value)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001007
Edward Lemur125d60a2019-09-13 18:25:41 +00001008 # Lazily cached values.
1009 self._gerrit_host = None # e.g. chromium-review.googlesource.com
1010 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
Edward Lesmese1576912021-02-16 21:53:34 +00001011 self._owners_client = None
Edward Lemur125d60a2019-09-13 18:25:41 +00001012 # Map from change number (issue) to its detail cache.
1013 self._detail_cache = {}
1014
1015 if codereview_host is not None:
1016 assert not codereview_host.startswith('https://'), codereview_host
1017 self._gerrit_host = codereview_host
1018 self._gerrit_server = 'https://%s' % codereview_host
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001019
Edward Lesmese1576912021-02-16 21:53:34 +00001020 @property
1021 def owners_client(self):
1022 if self._owners_client is None:
1023 remote, remote_branch = self.GetRemoteBranch()
1024 branch = GetTargetRef(remote, remote_branch, None)
1025 self._owners_client = owners_client.GetCodeOwnersClient(
Edward Lesmese1576912021-02-16 21:53:34 +00001026 host=self.GetGerritHost(),
1027 project=self.GetGerritProject(),
1028 branch=branch)
1029 return self._owners_client
1030
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001031 def GetCCList(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001032 """Returns the users cc'd on this CL.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001033
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001034 The return value is a string suitable for passing to git cl with the --cc
1035 flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001036 """
1037 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001038 base_cc = settings.GetDefaultCCList()
Daniel Cheng7227d212017-11-17 08:12:37 -08001039 more_cc = ','.join(self.more_cc)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001040 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1041 return self.cc
1042
Daniel Cheng7227d212017-11-17 08:12:37 -08001043 def ExtendCC(self, more_cc):
1044 """Extends the list of users to cc on this CL based on the changed files."""
1045 self.more_cc.extend(more_cc)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001046
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00001047 def GetCommitDate(self):
1048 """Returns the commit date as provided in the constructor"""
1049 return self.commit_date
1050
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001051 def GetBranch(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001052 """Returns the short branch name, e.g. 'main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001053 if not self.branch:
Edward Lemur85153282020-02-14 22:06:29 +00001054 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001055 if not branchref:
1056 return None
1057 self.branchref = branchref
Edward Lemur85153282020-02-14 22:06:29 +00001058 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001059 return self.branch
1060
1061 def GetBranchRef(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001062 """Returns the full branch name, e.g. 'refs/heads/main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001063 self.GetBranch() # Poke the lazy loader.
1064 return self.branchref
1065
Edward Lemur85153282020-02-14 22:06:29 +00001066 def _GitGetBranchConfigValue(self, key, default=None):
1067 return scm.GIT.GetBranchConfig(
1068 settings.GetRoot(), self.GetBranch(), key, default)
tandrii5d48c322016-08-18 16:19:37 -07001069
Edward Lemur85153282020-02-14 22:06:29 +00001070 def _GitSetBranchConfigValue(self, key, value):
1071 action = 'set %s to %r' % (key, value)
1072 if not value:
1073 action = 'unset %s' % key
1074 assert self.GetBranch(), 'a branch is needed to ' + action
1075 return scm.GIT.SetBranchConfig(
1076 settings.GetRoot(), self.GetBranch(), key, value)
tandrii5d48c322016-08-18 16:19:37 -07001077
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001078 @staticmethod
1079 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001080 """Returns a tuple containing remote and remote ref,
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001081 e.g. 'origin', 'refs/heads/main'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001082 """
Edward Lemur15a9b8c2020-02-13 00:52:30 +00001083 remote, upstream_branch = scm.GIT.FetchUpstreamTuple(
1084 settings.GetRoot(), branch)
1085 if not remote or not upstream_branch:
1086 DieWithError(
1087 'Unable to determine default branch to diff against.\n'
Josip Sokcevicb038f722021-01-06 18:28:11 +00001088 'Verify this branch is set up to track another \n'
1089 '(via the --track argument to "git checkout -b ..."). \n'
1090 'or pass complete "git diff"-style arguments if supported, like\n'
1091 ' git cl upload origin/main\n')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001092
1093 return remote, upstream_branch
1094
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001095 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001096 upstream_branch = self.GetUpstreamBranch()
Edward Lesmes50da7702020-03-30 19:23:43 +00001097 if not scm.GIT.IsValidRevision(settings.GetRoot(), upstream_branch):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001098 DieWithError('The upstream for the current branch (%s) does not exist '
1099 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001100 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001101 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001102
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001103 def GetUpstreamBranch(self):
1104 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001105 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Raul Tambrefe1dbe12019-05-02 04:43:57 +00001106 if remote != '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001107 upstream_branch = upstream_branch.replace('refs/heads/',
1108 'refs/remotes/%s/' % remote)
1109 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1110 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001111 self.upstream_branch = upstream_branch
1112 return self.upstream_branch
1113
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001114 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001115 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001116 remote, branch = None, self.GetBranch()
1117 seen_branches = set()
1118 while branch not in seen_branches:
1119 seen_branches.add(branch)
1120 remote, branch = self.FetchUpstreamTuple(branch)
Edward Lemur85153282020-02-14 22:06:29 +00001121 branch = scm.GIT.ShortBranchName(branch)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001122 if remote != '.' or branch.startswith('refs/remotes'):
1123 break
1124 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001125 remotes = RunGit(['remote'], error_ok=True).split()
1126 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001127 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001128 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001129 remote = 'origin'
Gavin Make6a62332020-12-04 21:57:10 +00001130 logging.warning('Could not determine which remote this change is '
1131 'associated with, so defaulting to "%s".' %
1132 self._remote)
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001133 else:
Gavin Make6a62332020-12-04 21:57:10 +00001134 logging.warning('Could not determine which remote this change is '
1135 'associated with.')
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001136 branch = 'HEAD'
1137 if branch.startswith('refs/remotes'):
1138 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001139 elif branch.startswith('refs/branch-heads/'):
1140 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001141 else:
1142 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001143 return self._remote
1144
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001145 def GetRemoteUrl(self):
1146 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1147
1148 Returns None if there is no remote.
1149 """
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001150 is_cached, value = self._cached_remote_url
1151 if is_cached:
1152 return value
1153
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001154 remote, _ = self.GetRemoteBranch()
Edward Lemur26964072020-02-19 19:18:51 +00001155 url = scm.GIT.GetConfig(settings.GetRoot(), 'remote.%s.url' % remote, '')
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001156
Edward Lemur298f2cf2019-02-22 21:40:39 +00001157 # Check if the remote url can be parsed as an URL.
Edward Lemur79d4f992019-11-11 23:49:02 +00001158 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001159 if host:
1160 self._cached_remote_url = (True, url)
1161 return url
1162
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001163 # If it cannot be parsed as an url, assume it is a local directory,
1164 # probably a git cache.
Edward Lemur298f2cf2019-02-22 21:40:39 +00001165 logging.warning('"%s" doesn\'t appear to point to a git host. '
1166 'Interpreting it as a local directory.', url)
1167 if not os.path.isdir(url):
1168 logging.error(
Josip906bfde2020-01-31 22:38:49 +00001169 'Remote "%(remote)s" for branch "%(branch)s" points to "%(url)s", '
1170 'but it doesn\'t exist.',
1171 {'remote': remote, 'branch': self.GetBranch(), 'url': url})
Edward Lemur298f2cf2019-02-22 21:40:39 +00001172 return None
1173
1174 cache_path = url
Edward Lemur26964072020-02-19 19:18:51 +00001175 url = scm.GIT.GetConfig(url, 'remote.%s.url' % remote, '')
Edward Lemur298f2cf2019-02-22 21:40:39 +00001176
Edward Lemur79d4f992019-11-11 23:49:02 +00001177 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001178 if not host:
1179 logging.error(
1180 'Remote "%(remote)s" for branch "%(branch)s" points to '
1181 '"%(cache_path)s", but it is misconfigured.\n'
1182 '"%(cache_path)s" must be a git repo and must have a remote named '
1183 '"%(remote)s" pointing to the git host.', {
1184 'remote': remote,
1185 'cache_path': cache_path,
1186 'branch': self.GetBranch()})
1187 return None
1188
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001189 self._cached_remote_url = (True, url)
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001190 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001191
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001192 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001193 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001194 if self.issue is None and not self.lookedup_issue:
Bruce Dawson13acea32022-05-03 22:13:08 +00001195 if self.GetBranch():
1196 self.issue = self._GitGetBranchConfigValue(ISSUE_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001197 if self.issue is not None:
1198 self.issue = int(self.issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001199 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001200 return self.issue
1201
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001202 def GetIssueURL(self, short=False):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001203 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001204 issue = self.GetIssue()
1205 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001206 return None
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001207 server = self.GetCodereviewServer()
1208 if short:
1209 server = _KNOWN_GERRIT_TO_SHORT_URLS.get(server, server)
1210 return '%s/%s' % (server, issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001211
Dirk Pranke6f0df682021-06-25 00:42:33 +00001212 def GetUsePython3(self):
Josip Sokcevic340edc32021-07-08 17:01:46 +00001213 return settings.GetUsePython3()
Dirk Pranke6f0df682021-06-25 00:42:33 +00001214
Edward Lemur6c6827c2020-02-06 21:15:18 +00001215 def FetchDescription(self, pretty=False):
1216 assert self.GetIssue(), 'issue is required to query Gerrit'
1217
Edward Lemur9aa1a962020-02-25 00:58:38 +00001218 if self.description is None:
Edward Lemur6c6827c2020-02-06 21:15:18 +00001219 data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
1220 current_rev = data['current_revision']
1221 self.description = data['revisions'][current_rev]['commit']['message']
Edward Lemur6c6827c2020-02-06 21:15:18 +00001222
1223 if not pretty:
1224 return self.description
1225
1226 # Set width to 72 columns + 2 space indent.
1227 wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True)
1228 wrapper.initial_indent = wrapper.subsequent_indent = ' '
1229 lines = self.description.splitlines()
1230 return '\n'.join([wrapper.fill(line) for line in lines])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001231
1232 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001233 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001234 if self.patchset is None and not self.lookedup_patchset:
Bruce Dawson13acea32022-05-03 22:13:08 +00001235 if self.GetBranch():
1236 self.patchset = self._GitGetBranchConfigValue(PATCHSET_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001237 if self.patchset is not None:
1238 self.patchset = int(self.patchset)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001239 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001240 return self.patchset
1241
Edward Lemur9aa1a962020-02-25 00:58:38 +00001242 def GetAuthor(self):
1243 return scm.GIT.GetConfig(settings.GetRoot(), 'user.email')
1244
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001245 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001246 """Set this branch's patchset. If patchset=0, clears the patchset."""
1247 assert self.GetBranch()
1248 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001249 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001250 else:
1251 self.patchset = int(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00001252 self._GitSetBranchConfigValue(PATCHSET_CONFIG_KEY, str(self.patchset))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001253
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001254 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001255 """Set this branch's issue. If issue isn't given, clears the issue."""
1256 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001257 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001258 issue = int(issue)
Edward Lesmes50da7702020-03-30 19:23:43 +00001259 self._GitSetBranchConfigValue(ISSUE_CONFIG_KEY, str(issue))
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001260 self.issue = issue
Edward Lemur125d60a2019-09-13 18:25:41 +00001261 codereview_server = self.GetCodereviewServer()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001262 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001263 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001264 CODEREVIEW_SERVER_CONFIG_KEY, codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001265 else:
tandrii5d48c322016-08-18 16:19:37 -07001266 # Reset all of these just to be clean.
1267 reset_suffixes = [
1268 'last-upload-hash',
Edward Lesmes50da7702020-03-30 19:23:43 +00001269 ISSUE_CONFIG_KEY,
1270 PATCHSET_CONFIG_KEY,
1271 CODEREVIEW_SERVER_CONFIG_KEY,
1272 'gerritsquashhash',
1273 ]
tandrii5d48c322016-08-18 16:19:37 -07001274 for prop in reset_suffixes:
Edward Lemur85153282020-02-14 22:06:29 +00001275 try:
1276 self._GitSetBranchConfigValue(prop, None)
1277 except subprocess2.CalledProcessError:
1278 pass
Aaron Gableca01e2c2017-07-19 11:16:02 -07001279 msg = RunGit(['log', '-1', '--format=%B']).strip()
1280 if msg and git_footers.get_footer_change_id(msg):
1281 print('WARNING: The change patched into this branch has a Change-Id. '
1282 'Removing it.')
1283 RunGit(['commit', '--amend', '-m',
1284 git_footers.remove_footer(msg, 'Change-Id')])
Edward Lemurf38bc172019-09-03 21:02:13 +00001285 self.lookedup_issue = True
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001286 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001287 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001288
Edward Lemur2c62b332020-03-12 22:12:33 +00001289 def GetAffectedFiles(self, upstream):
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001290 try:
Edward Lemur2c62b332020-03-12 22:12:33 +00001291 return [f for _, f in scm.GIT.CaptureStatus(settings.GetRoot(), upstream)]
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001292 except subprocess2.CalledProcessError:
1293 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001294 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001295 'This branch probably doesn\'t exist anymore. To reset the\n'
1296 'tracking branch, please run\n'
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001297 ' git branch --set-upstream-to origin/main %s\n'
1298 'or replace origin/main with the relevant branch') %
Edward Lemur2c62b332020-03-12 22:12:33 +00001299 (upstream, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001300
dsansomee2d6fd92016-09-08 00:10:47 -07001301 def UpdateDescription(self, description, force=False):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001302 assert self.GetIssue(), 'issue is required to update description'
1303
1304 if gerrit_util.HasPendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001305 self.GetGerritHost(), self._GerritChangeIdentifier()):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001306 if not force:
1307 confirm_or_exit(
1308 'The description cannot be modified while the issue has a pending '
1309 'unpublished edit. Either publish the edit in the Gerrit web UI '
1310 'or delete it.\n\n', action='delete the unpublished edit')
1311
1312 gerrit_util.DeletePendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001313 self.GetGerritHost(), self._GerritChangeIdentifier())
Edward Lemur6c6827c2020-02-06 21:15:18 +00001314 gerrit_util.SetCommitMessage(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001315 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur6c6827c2020-02-06 21:15:18 +00001316 description, notify='NONE')
1317
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001318 self.description = description
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001319
Edward Lemur75526302020-02-27 22:31:05 +00001320 def _GetCommonPresubmitArgs(self, verbose, upstream):
Edward Lemur227d5102020-02-25 23:45:35 +00001321 args = [
Edward Lemur227d5102020-02-25 23:45:35 +00001322 '--root', settings.GetRoot(),
1323 '--upstream', upstream,
1324 ]
1325
1326 args.extend(['--verbose'] * verbose)
1327
Edward Lesmeseb1bd622021-03-01 19:54:07 +00001328 remote, remote_branch = self.GetRemoteBranch()
1329 target_ref = GetTargetRef(remote, remote_branch, None)
Aleksey Khoroshilov35ef5ad2022-06-03 18:29:25 +00001330 if settings.GetIsGerrit():
1331 args.extend(['--gerrit_url', self.GetCodereviewServer()])
1332 args.extend(['--gerrit_project', self.GetGerritProject()])
1333 args.extend(['--gerrit_branch', target_ref])
Edward Lesmeseb1bd622021-03-01 19:54:07 +00001334
Edward Lemur99df04e2020-03-05 19:39:43 +00001335 author = self.GetAuthor()
Edward Lemur227d5102020-02-25 23:45:35 +00001336 issue = self.GetIssue()
1337 patchset = self.GetPatchset()
Edward Lemur99df04e2020-03-05 19:39:43 +00001338 if author:
1339 args.extend(['--author', author])
Edward Lemur227d5102020-02-25 23:45:35 +00001340 if issue:
1341 args.extend(['--issue', str(issue)])
1342 if patchset:
1343 args.extend(['--patchset', str(patchset)])
Edward Lemur227d5102020-02-25 23:45:35 +00001344
Edward Lemur75526302020-02-27 22:31:05 +00001345 return args
1346
Josip Sokcevic017544d2022-03-31 23:47:53 +00001347 def RunHook(self,
1348 committing,
1349 may_prompt,
1350 verbose,
1351 parallel,
1352 upstream,
1353 description,
1354 all_files,
1355 files=None,
1356 resultdb=False,
1357 realm=None):
Edward Lemur75526302020-02-27 22:31:05 +00001358 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1359 args = self._GetCommonPresubmitArgs(verbose, upstream)
1360 args.append('--commit' if committing else '--upload')
Edward Lemur227d5102020-02-25 23:45:35 +00001361 if may_prompt:
1362 args.append('--may_prompt')
1363 if parallel:
1364 args.append('--parallel')
1365 if all_files:
1366 args.append('--all_files')
Josip Sokcevic017544d2022-03-31 23:47:53 +00001367 if files:
1368 args.extend(files.split(';'))
1369 args.append('--source_controlled_only')
Bruce Dawson09c0c072022-05-26 20:28:58 +00001370 if files or all_files:
1371 args.append('--no_diffs')
Edward Lemur227d5102020-02-25 23:45:35 +00001372
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001373 if resultdb and not realm:
1374 # TODO (crbug.com/1113463): store realm somewhere and look it up so
1375 # it is not required to pass the realm flag
1376 print('Note: ResultDB reporting will NOT be performed because --realm'
1377 ' was not specified. To enable ResultDB, please run the command'
1378 ' again with the --realm argument to specify the LUCI realm.')
1379
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001380 py3_results = self._RunPresubmit(args, resultdb, realm, description,
1381 use_python3=True)
Josip Sokcevic632bbc02022-05-19 05:32:50 +00001382 if py3_results.get('skipped_presubmits', 1) == 0:
1383 print('No more presubmits to run - skipping Python 2 presubmits.')
1384 return py3_results
1385
1386 py2_results = self._RunPresubmit(args, resultdb, realm, description,
1387 use_python3=False)
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001388 return self._MergePresubmitResults(py2_results, py3_results)
1389
1390 def _RunPresubmit(self, args, resultdb, realm, description, use_python3):
1391 args = args[:]
1392 vpython = 'vpython3' if use_python3 else 'vpython'
1393
Edward Lemur227d5102020-02-25 23:45:35 +00001394 with gclient_utils.temporary_file() as description_file:
1395 with gclient_utils.temporary_file() as json_output:
Edward Lemur1a83da12020-03-04 21:18:36 +00001396 gclient_utils.FileWrite(description_file, description)
Edward Lemur227d5102020-02-25 23:45:35 +00001397 args.extend(['--json_output', json_output])
1398 args.extend(['--description_file', description_file])
Dirk Pranke6f0df682021-06-25 00:42:33 +00001399 if self.GetUsePython3():
1400 args.append('--use-python3')
Edward Lemur227d5102020-02-25 23:45:35 +00001401 start = time_time()
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001402 cmd = [vpython, PRESUBMIT_SUPPORT] + args
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001403 if resultdb and realm:
1404 cmd = ['rdb', 'stream', '-new', '-realm', realm, '--'] + cmd
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001405
1406 p = subprocess2.Popen(cmd)
Edward Lemur227d5102020-02-25 23:45:35 +00001407 exit_code = p.wait()
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001408
Edward Lemur227d5102020-02-25 23:45:35 +00001409 metrics.collector.add_repeated('sub_commands', {
1410 'command': 'presubmit',
1411 'execution_time': time_time() - start,
1412 'exit_code': exit_code,
1413 })
1414
1415 if exit_code:
1416 sys.exit(exit_code)
1417
1418 json_results = gclient_utils.FileRead(json_output)
1419 return json.loads(json_results)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001420
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001421 def _MergePresubmitResults(self, py2_results, py3_results):
1422 return {
1423 'more_cc': sorted(set(py2_results.get('more_cc', []) +
1424 py3_results.get('more_cc', []))),
1425 'errors': (
1426 py2_results.get('errors', []) + py3_results.get('errors', [])),
1427 'notifications': (
1428 py2_results.get('notifications', []) +
1429 py3_results.get('notifications', [])),
1430 'warnings': (
1431 py2_results.get('warnings', []) + py3_results.get('warnings', []))
1432 }
1433
Edward Lemur75526302020-02-27 22:31:05 +00001434 def RunPostUploadHook(self, verbose, upstream, description):
1435 args = self._GetCommonPresubmitArgs(verbose, upstream)
1436 args.append('--post_upload')
1437
1438 with gclient_utils.temporary_file() as description_file:
Edward Lemur1a83da12020-03-04 21:18:36 +00001439 gclient_utils.FileWrite(description_file, description)
Edward Lemur75526302020-02-27 22:31:05 +00001440 args.extend(['--description_file', description_file])
Josip Sokcevice293d3d2022-02-16 22:52:15 +00001441 p_py2 = subprocess2.Popen(['vpython', PRESUBMIT_SUPPORT] + args)
1442 p_py3 = subprocess2.Popen(['vpython3', PRESUBMIT_SUPPORT] + args +
1443 ['--use-python3'])
1444 p_py2.wait()
1445 p_py3.wait()
Edward Lemur75526302020-02-27 22:31:05 +00001446
Edward Lemur5a644f82020-03-18 16:44:57 +00001447 def _GetDescriptionForUpload(self, options, git_diff_args, files):
1448 # Get description message for upload.
1449 if self.GetIssue():
1450 description = self.FetchDescription()
1451 elif options.message:
1452 description = options.message
1453 else:
1454 description = _create_description_from_log(git_diff_args)
1455 if options.title and options.squash:
Edward Lesmes0dd54822020-03-26 18:24:25 +00001456 description = options.title + '\n\n' + description
Edward Lemur5a644f82020-03-18 16:44:57 +00001457
Edward Lemur5a644f82020-03-18 16:44:57 +00001458 bug = options.bug
1459 fixed = options.fixed
Josip Sokcevic340edc32021-07-08 17:01:46 +00001460 if not self.GetIssue():
1461 # Extract bug number from branch name, but only if issue is being created.
1462 # It must start with bug or fix, followed by _ or - and number.
1463 # Optionally, it may contain _ or - after number with arbitrary text.
1464 # Examples:
1465 # bug-123
1466 # bug_123
1467 # fix-123
1468 # fix-123-some-description
1469 match = re.match(
1470 r'^(?P<type>bug|fix(?:e[sd])?)[_-]?(?P<bugnum>\d+)([-_]|$)',
1471 self.GetBranch())
1472 if not bug and not fixed and match:
1473 if match.group('type') == 'bug':
1474 bug = match.group('bugnum')
1475 else:
1476 fixed = match.group('bugnum')
Edward Lemur5a644f82020-03-18 16:44:57 +00001477
1478 change_description = ChangeDescription(description, bug, fixed)
1479
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001480 # Fill gaps in OWNERS coverage to tbrs/reviewers if requested.
1481 if options.add_owners_to:
1482 assert options.add_owners_to in ('TBR', 'R'), options.add_owners_to
Edward Lesmese1576912021-02-16 21:53:34 +00001483 status = self.owners_client.GetFilesApprovalStatus(
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001484 files, [], options.tbrs + options.reviewers)
1485 missing_files = [
1486 f for f in files
Edward Lesmese1576912021-02-16 21:53:34 +00001487 if status[f] == self._owners_client.INSUFFICIENT_REVIEWERS
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001488 ]
Edward Lesmese1576912021-02-16 21:53:34 +00001489 owners = self.owners_client.SuggestOwners(
1490 missing_files, exclude=[self.GetAuthor()])
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001491 if options.add_owners_to == 'TBR':
1492 assert isinstance(options.tbrs, list), options.tbrs
1493 options.tbrs.extend(owners)
1494 else:
1495 assert isinstance(options.reviewers, list), options.reviewers
1496 options.reviewers.extend(owners)
1497
Edward Lemur5a644f82020-03-18 16:44:57 +00001498 # Set the reviewer list now so that presubmit checks can access it.
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001499 if options.reviewers or options.tbrs:
1500 change_description.update_reviewers(options.reviewers, options.tbrs)
Edward Lemur5a644f82020-03-18 16:44:57 +00001501
1502 return change_description
1503
1504 def _GetTitleForUpload(self, options):
manukh566e9d02022-06-30 19:49:53 +00001505 # When not squashing or options.title is provided, just return
1506 # options.title.
1507 if not options.squash or options.title:
Edward Lemur5a644f82020-03-18 16:44:57 +00001508 return options.title
1509
1510 # On first upload, patchset title is always this string, while options.title
1511 # gets converted to first line of message.
1512 if not self.GetIssue():
1513 return 'Initial upload'
1514
1515 # When uploading subsequent patchsets, options.message is taken as the title
1516 # if options.title is not provided.
Edward Lemur5a644f82020-03-18 16:44:57 +00001517 if options.message:
1518 return options.message.strip()
1519
1520 # Use the subject of the last commit as title by default.
Edward Lesmes50da7702020-03-30 19:23:43 +00001521 title = RunGit(['show', '-s', '--format=%s', 'HEAD']).strip()
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00001522 if options.force or options.skip_title:
Edward Lemur5a644f82020-03-18 16:44:57 +00001523 return title
Edward Lesmesae3586b2020-03-23 21:21:14 +00001524 user_title = gclient_utils.AskForData('Title for patchset [%s]: ' % title)
mlcui3da91712021-05-05 10:00:30 +00001525
1526 # Use the default title if the user confirms the default with a 'y'.
1527 if user_title.lower() == 'y':
1528 return title
Edward Lesmesae3586b2020-03-23 21:21:14 +00001529 return user_title or title
Edward Lemur5a644f82020-03-18 16:44:57 +00001530
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001531 def CMDUpload(self, options, git_diff_args, orig_args):
1532 """Uploads a change to codereview."""
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001533 custom_cl_base = None
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001534 if git_diff_args:
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001535 custom_cl_base = base_branch = git_diff_args[0]
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001536 else:
1537 if self.GetBranch() is None:
1538 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1539
1540 # Default to diffing against common ancestor of upstream branch
1541 base_branch = self.GetCommonAncestorWithUpstream()
1542 git_diff_args = [base_branch, 'HEAD']
1543
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001544 # Fast best-effort checks to abort before running potentially expensive
1545 # hooks if uploading is likely to fail anyway. Passing these checks does
1546 # not guarantee that uploading will not fail.
Edward Lemur125d60a2019-09-13 18:25:41 +00001547 self.EnsureAuthenticated(force=options.force)
1548 self.EnsureCanUploadPatchset(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001549
1550 # Apply watchlists on upload.
Edward Lemur2c62b332020-03-12 22:12:33 +00001551 watchlist = watchlists.Watchlists(settings.GetRoot())
1552 files = self.GetAffectedFiles(base_branch)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001553 if not options.bypass_watchlists:
Daniel Cheng7227d212017-11-17 08:12:37 -08001554 self.ExtendCC(watchlist.GetWatchersForPaths(files))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001555
Edward Lemur5a644f82020-03-18 16:44:57 +00001556 change_desc = self._GetDescriptionForUpload(options, git_diff_args, files)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001557 if not options.bypass_hooks:
Edward Lemur2c62b332020-03-12 22:12:33 +00001558 hook_results = self.RunHook(
1559 committing=False,
1560 may_prompt=not options.force,
1561 verbose=options.verbose,
1562 parallel=options.parallel,
1563 upstream=base_branch,
Edward Lemur5a644f82020-03-18 16:44:57 +00001564 description=change_desc.description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001565 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001566 resultdb=options.resultdb,
1567 realm=options.realm)
Edward Lemur227d5102020-02-25 23:45:35 +00001568 self.ExtendCC(hook_results['more_cc'])
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001569
Aaron Gable13101a62018-02-09 13:20:41 -08001570 print_stats(git_diff_args)
Edward Lemura12175c2020-03-09 16:58:26 +00001571 ret = self.CMDUploadChange(
Edward Lemur5a644f82020-03-18 16:44:57 +00001572 options, git_diff_args, custom_cl_base, change_desc)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001573 if not ret:
Edward Lemur85153282020-02-14 22:06:29 +00001574 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001575 'last-upload-hash', scm.GIT.ResolveCommit(settings.GetRoot(), 'HEAD'))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001576 # Run post upload hooks, if specified.
1577 if settings.GetRunPostUploadHook():
Edward Lemur5a644f82020-03-18 16:44:57 +00001578 self.RunPostUploadHook(
1579 options.verbose, base_branch, change_desc.description)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001580
1581 # Upload all dependencies if specified.
1582 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001583 print()
1584 print('--dependencies has been specified.')
1585 print('All dependent local branches will be re-uploaded.')
1586 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001587 # Remove the dependencies flag from args so that we do not end up in a
1588 # loop.
1589 orig_args.remove('--dependencies')
Jose Lopes3863fc52020-04-07 17:00:25 +00001590 ret = upload_branch_deps(self, orig_args, options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001591 return ret
1592
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001593 def SetCQState(self, new_state):
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001594 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001595
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00001596 Issue must have been already uploaded and known. Optionally allows for
1597 updating Quick-Run (QR) state.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001598 """
1599 assert new_state in _CQState.ALL_STATES
1600 assert self.GetIssue()
qyearsley1fdfcb62016-10-24 13:22:03 -07001601 try:
Edward Lemur125d60a2019-09-13 18:25:41 +00001602 vote_map = {
1603 _CQState.NONE: 0,
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00001604 _CQState.QUICK_RUN: 1,
Edward Lemur125d60a2019-09-13 18:25:41 +00001605 _CQState.DRY_RUN: 1,
1606 _CQState.COMMIT: 2,
1607 }
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00001608 if new_state == _CQState.QUICK_RUN:
1609 labels = {
1610 'Commit-Queue': vote_map[_CQState.DRY_RUN],
1611 'Quick-Run': vote_map[_CQState.QUICK_RUN],
1612 }
1613 else:
1614 labels = {'Commit-Queue': vote_map[new_state]}
Edward Lemur125d60a2019-09-13 18:25:41 +00001615 notify = False if new_state == _CQState.DRY_RUN else None
1616 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001617 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur125d60a2019-09-13 18:25:41 +00001618 labels=labels, notify=notify)
qyearsley1fdfcb62016-10-24 13:22:03 -07001619 return 0
1620 except KeyboardInterrupt:
1621 raise
1622 except:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001623 print('WARNING: Failed to %s.\n'
qyearsley1fdfcb62016-10-24 13:22:03 -07001624 'Either:\n'
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001625 ' * Your project has no CQ,\n'
1626 ' * You don\'t have permission to change the CQ state,\n'
1627 ' * There\'s a bug in this code (see stack trace below).\n'
1628 'Consider specifying which bots to trigger manually or asking your '
1629 'project owners for permissions or contacting Chrome Infra at:\n'
1630 'https://www.chromium.org/infra\n\n' %
1631 ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ'))
qyearsley1fdfcb62016-10-24 13:22:03 -07001632 # Still raise exception so that stack trace is printed.
1633 raise
1634
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001635 def GetGerritHost(self):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001636 # Lazy load of configs.
1637 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07001638 if self._gerrit_host and '.' not in self._gerrit_host:
1639 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
1640 # This happens for internal stuff http://crbug.com/614312.
Edward Lemur79d4f992019-11-11 23:49:02 +00001641 parsed = urllib.parse.urlparse(self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001642 if parsed.scheme == 'sso':
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001643 print('WARNING: using non-https URLs for remote is likely broken\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001644 ' Your current remote is: %s' % self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001645 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
1646 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001647 return self._gerrit_host
1648
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001649 def _GetGitHost(self):
1650 """Returns git host to be used when uploading change to Gerrit."""
Edward Lemur298f2cf2019-02-22 21:40:39 +00001651 remote_url = self.GetRemoteUrl()
1652 if not remote_url:
1653 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001654 return urllib.parse.urlparse(remote_url).netloc
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001655
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001656 def GetCodereviewServer(self):
1657 if not self._gerrit_server:
1658 # If we're on a branch then get the server potentially associated
1659 # with that branch.
Edward Lemur85153282020-02-14 22:06:29 +00001660 if self.GetIssue() and self.GetBranch():
tandrii5d48c322016-08-18 16:19:37 -07001661 self._gerrit_server = self._GitGetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001662 CODEREVIEW_SERVER_CONFIG_KEY)
tandrii5d48c322016-08-18 16:19:37 -07001663 if self._gerrit_server:
Edward Lemur79d4f992019-11-11 23:49:02 +00001664 self._gerrit_host = urllib.parse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001665 if not self._gerrit_server:
1666 # We assume repo to be hosted on Gerrit, and hence Gerrit server
1667 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001668 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001669 parts[0] = parts[0] + '-review'
1670 self._gerrit_host = '.'.join(parts)
1671 self._gerrit_server = 'https://%s' % self._gerrit_host
1672 return self._gerrit_server
1673
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001674 def GetGerritProject(self):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001675 """Returns Gerrit project name based on remote git URL."""
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001676 remote_url = self.GetRemoteUrl()
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001677 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001678 logging.warning('can\'t detect Gerrit project.')
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001679 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001680 project = urllib.parse.urlparse(remote_url).path.strip('/')
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001681 if project.endswith('.git'):
1682 project = project[:-len('.git')]
Andrii Shyshkalov1e828672018-08-23 22:34:37 +00001683 # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with
1684 # 'a/' prefix, because 'a/' prefix is used to force authentication in
1685 # gitiles/git-over-https protocol. E.g.,
1686 # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project
1687 # as
1688 # https://chromium.googlesource.com/v8/v8
1689 if project.startswith('a/'):
1690 project = project[len('a/'):]
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001691 return project
1692
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001693 def _GerritChangeIdentifier(self):
1694 """Handy method for gerrit_util.ChangeIdentifier for a given CL.
1695
1696 Not to be confused by value of "Change-Id:" footer.
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001697 If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC.
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001698 """
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001699 project = self.GetGerritProject()
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001700 if project:
1701 return gerrit_util.ChangeIdentifier(project, self.GetIssue())
1702 # Fall back on still unique, but less efficient change number.
1703 return str(self.GetIssue())
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001704
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001705 def EnsureAuthenticated(self, force, refresh=None):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001706 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00001707 if settings.GetGerritSkipEnsureAuthenticated():
1708 # For projects with unusual authentication schemes.
1709 # See http://crbug.com/603378.
1710 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001711
1712 # Check presence of cookies only if using cookies-based auth method.
1713 cookie_auth = gerrit_util.Authenticator.get()
1714 if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001715 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001716
Florian Mayerae510e82020-01-30 21:04:48 +00001717 remote_url = self.GetRemoteUrl()
1718 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001719 logging.warning('invalid remote')
Florian Mayerae510e82020-01-30 21:04:48 +00001720 return
Joanna Wang46ffd1b2022-09-16 20:44:44 +00001721 if urllib.parse.urlparse(remote_url).scheme not in ['https', 'sso']:
1722 logging.warning(
1723 'Ignoring branch %(branch)s with non-https/sso remote '
1724 '%(remote)s', {
1725 'branch': self.branch,
1726 'remote': self.GetRemoteUrl()
1727 })
Daniel Chengcf6269b2019-05-18 01:02:12 +00001728 return
1729
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001730 # Lazy-loader to identify Gerrit and Git hosts.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001731 self.GetCodereviewServer()
1732 git_host = self._GetGitHost()
Edward Lemur298f2cf2019-02-22 21:40:39 +00001733 assert self._gerrit_server and self._gerrit_host and git_host
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001734
1735 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
1736 git_auth = cookie_auth.get_auth_header(git_host)
1737 if gerrit_auth and git_auth:
1738 if gerrit_auth == git_auth:
1739 return
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001740 all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com')
Raul Tambre80ee78e2019-05-06 22:41:05 +00001741 print(
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001742 'WARNING: You have different credentials for Gerrit and git hosts:\n'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001743 ' %s\n'
1744 ' %s\n'
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001745 ' Consider running the following command:\n'
1746 ' git cl creds-check\n'
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001747 ' %s\n'
Raul Tambre80ee78e2019-05-06 22:41:05 +00001748 ' %s' %
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001749 (git_host, self._gerrit_host,
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001750 ('Hint: delete creds for .googlesource.com' if all_gsrc else ''),
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001751 cookie_auth.get_new_password_message(git_host)))
1752 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001753 confirm_or_exit('If you know what you are doing', action='continue')
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001754 return
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00001755
1756 missing = (
1757 ([] if gerrit_auth else [self._gerrit_host]) +
1758 ([] if git_auth else [git_host]))
1759 DieWithError('Credentials for the following hosts are required:\n'
1760 ' %s\n'
1761 'These are read from %s (or legacy %s)\n'
1762 '%s' % (
1763 '\n '.join(missing),
1764 cookie_auth.get_gitcookies_path(),
1765 cookie_auth.get_netrc_path(),
1766 cookie_auth.get_new_password_message(git_host)))
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001767
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001768 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001769 if not self.GetIssue():
1770 return
1771
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001772 status = self._GetChangeDetail()['status']
Joanna Wang583ca662022-04-27 21:17:17 +00001773 if status == 'ABANDONED':
Bruce Dawsoneb8426e2022-08-05 23:58:15 +00001774 DieWithError(
1775 'Change %s has been abandoned, new uploads are not allowed' %
1776 (self.GetIssueURL()))
Joanna Wang583ca662022-04-27 21:17:17 +00001777 if status == 'MERGED':
1778 answer = gclient_utils.AskForData(
1779 'Change %s has been submitted, new uploads are not allowed. '
1780 'Would you like to start a new change (Y/n)?' % self.GetIssueURL()
1781 ).lower()
1782 if answer not in ('y', ''):
1783 DieWithError('New uploads are not allowed.')
1784 self.SetIssue()
1785 return
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001786
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001787 # TODO(vadimsh): For some reason the chunk of code below was skipped if
1788 # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'.
1789 # Apparently this check is not very important? Otherwise get_auth_email
1790 # could have been added to other implementations of Authenticator.
1791 cookies_auth = gerrit_util.Authenticator.get()
1792 if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator):
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001793 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001794
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001795 cookies_user = cookies_auth.get_auth_email(self.GetGerritHost())
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001796 if self.GetIssueOwner() == cookies_user:
1797 return
1798 logging.debug('change %s owner is %s, cookies user is %s',
1799 self.GetIssue(), self.GetIssueOwner(), cookies_user)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001800 # Maybe user has linked accounts or something like that,
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001801 # so ask what Gerrit thinks of this user.
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001802 details = gerrit_util.GetAccountDetails(self.GetGerritHost(), 'self')
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001803 if details['email'] == self.GetIssueOwner():
1804 return
1805 if not force:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001806 print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit '
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001807 'as %s.\n'
1808 'Uploading may fail due to lack of permissions.' %
1809 (self.GetIssue(), self.GetIssueOwner(), details['email']))
1810 confirm_or_exit(action='upload')
1811
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001812 def GetStatus(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001813 """Applies a rough heuristic to give a simple summary of an issue's review
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001814 or CQ status, assuming adherence to a common workflow.
1815
1816 Returns None if no issue for this branch, or one of the following keywords:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001817 * 'error' - error from review tool (including deleted issues)
1818 * 'unsent' - no reviewers added
1819 * 'waiting' - waiting for review
1820 * 'reply' - waiting for uploader to reply to review
1821 * 'lgtm' - Code-Review label has been set
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001822 * 'dry-run' - dry-running in the CQ
1823 * 'commit' - in the CQ
Aaron Gable9ab38c62017-04-06 14:36:33 -07001824 * 'closed' - successfully submitted or abandoned
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001825 """
1826 if not self.GetIssue():
1827 return None
1828
1829 try:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001830 data = self._GetChangeDetail([
1831 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE'])
Edward Lemur79d4f992019-11-11 23:49:02 +00001832 except GerritChangeNotExists:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001833 return 'error'
1834
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00001835 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001836 return 'closed'
1837
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001838 cq_label = data['labels'].get('Commit-Queue', {})
1839 max_cq_vote = 0
1840 for vote in cq_label.get('all', []):
1841 max_cq_vote = max(max_cq_vote, vote.get('value', 0))
1842 if max_cq_vote == 2:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001843 return 'commit'
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001844 if max_cq_vote == 1:
1845 return 'dry-run'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001846
Aaron Gable9ab38c62017-04-06 14:36:33 -07001847 if data['labels'].get('Code-Review', {}).get('approved'):
1848 return 'lgtm'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001849
1850 if not data.get('reviewers', {}).get('REVIEWER', []):
1851 return 'unsent'
1852
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001853 owner = data['owner'].get('_account_id')
Edward Lemur79d4f992019-11-11 23:49:02 +00001854 messages = sorted(data.get('messages', []), key=lambda m: m.get('date'))
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001855 while messages:
1856 m = messages.pop()
Andrii Shyshkalov899785a2021-07-09 12:45:37 +00001857 if (m.get('tag', '').startswith('autogenerated:cq') or
1858 m.get('tag', '').startswith('autogenerated:cv')):
1859 # Ignore replies from LUCI CV/CQ.
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001860 continue
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001861 if m.get('author', {}).get('_account_id') == owner:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001862 # Most recent message was by owner.
1863 return 'waiting'
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00001864
1865 # Some reply from non-owner.
1866 return 'reply'
Aaron Gable9ab38c62017-04-06 14:36:33 -07001867
1868 # Somehow there are no messages even though there are reviewers.
1869 return 'unsent'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001870
1871 def GetMostRecentPatchset(self):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001872 if not self.GetIssue():
1873 return None
1874
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001875 data = self._GetChangeDetail(['CURRENT_REVISION'])
Aaron Gablee8856ee2017-12-07 12:41:46 -08001876 patchset = data['revisions'][data['current_revision']]['_number']
1877 self.SetPatchset(patchset)
1878 return patchset
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001879
Gavin Make61ccc52020-11-13 00:12:57 +00001880 def GetMostRecentDryRunPatchset(self):
1881 """Get patchsets equivalent to the most recent patchset and return
1882 the patchset with the latest dry run. If none have been dry run, return
1883 the latest patchset."""
1884 if not self.GetIssue():
1885 return None
1886
1887 data = self._GetChangeDetail(['ALL_REVISIONS'])
1888 patchset = data['revisions'][data['current_revision']]['_number']
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00001889 dry_run = {int(m['_revision_number'])
1890 for m in data.get('messages', [])
1891 if m.get('tag', '').endswith('dry-run')}
Gavin Make61ccc52020-11-13 00:12:57 +00001892
1893 for revision_info in sorted(data.get('revisions', {}).values(),
1894 key=lambda c: c['_number'], reverse=True):
1895 if revision_info['_number'] in dry_run:
1896 patchset = revision_info['_number']
1897 break
1898 if revision_info.get('kind', '') not in \
1899 ('NO_CHANGE', 'NO_CODE_CHANGE', 'TRIVIAL_REBASE'):
1900 break
1901 self.SetPatchset(patchset)
1902 return patchset
1903
Aaron Gable636b13f2017-07-14 10:42:48 -07001904 def AddComment(self, message, publish=None):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001905 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001906 self.GetGerritHost(), self._GerritChangeIdentifier(),
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001907 msg=message, ready=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001908
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001909 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalov5a0cf202017-03-17 16:14:59 +01001910 # DETAILED_ACCOUNTS is to get emails in accounts.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001911 # CURRENT_REVISION is included to get the latest patchset so that
1912 # only the robot comments from the latest patchset can be shown.
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001913 messages = self._GetChangeDetail(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001914 options=['MESSAGES', 'DETAILED_ACCOUNTS',
1915 'CURRENT_REVISION']).get('messages', [])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001916 file_comments = gerrit_util.GetChangeComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001917 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001918 robot_file_comments = gerrit_util.GetChangeRobotComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001919 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001920
1921 # Add the robot comments onto the list of comments, but only
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +00001922 # keep those that are from the latest patchset.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001923 latest_patch_set = self.GetMostRecentPatchset()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001924 for path, robot_comments in robot_file_comments.items():
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001925 line_comments = file_comments.setdefault(path, [])
1926 line_comments.extend(
1927 [c for c in robot_comments if c['patch_set'] == latest_patch_set])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001928
1929 # Build dictionary of file comments for easy access and sorting later.
1930 # {author+date: {path: {patchset: {line: url+message}}}}
1931 comments = collections.defaultdict(
1932 lambda: collections.defaultdict(lambda: collections.defaultdict(dict)))
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001933
1934 server = self.GetCodereviewServer()
1935 if server in _KNOWN_GERRIT_TO_SHORT_URLS:
1936 # /c/ is automatically added by short URL server.
1937 url_prefix = '%s/%s' % (_KNOWN_GERRIT_TO_SHORT_URLS[server],
1938 self.GetIssue())
1939 else:
1940 url_prefix = '%s/c/%s' % (server, self.GetIssue())
1941
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001942 for path, line_comments in file_comments.items():
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001943 for comment in line_comments:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001944 tag = comment.get('tag', '')
1945 if tag.startswith('autogenerated') and 'robot_id' not in comment:
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001946 continue
1947 key = (comment['author']['email'], comment['updated'])
1948 if comment.get('side', 'REVISION') == 'PARENT':
1949 patchset = 'Base'
1950 else:
1951 patchset = 'PS%d' % comment['patch_set']
1952 line = comment.get('line', 0)
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001953 url = ('%s/%s/%s#%s%s' %
1954 (url_prefix, comment['patch_set'], path,
1955 'b' if comment.get('side') == 'PARENT' else '',
1956 str(line) if line else ''))
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001957 comments[key][path][patchset][line] = (url, comment['message'])
1958
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001959 summaries = []
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001960 for msg in messages:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001961 summary = self._BuildCommentSummary(msg, comments, readable)
1962 if summary:
1963 summaries.append(summary)
1964 return summaries
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001965
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001966 @staticmethod
1967 def _BuildCommentSummary(msg, comments, readable):
Josip Sokcevic266129c2021-11-09 00:22:00 +00001968 if 'email' not in msg['author']:
1969 # Some bot accounts may not have an email associated.
1970 return None
1971
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001972 key = (msg['author']['email'], msg['date'])
1973 # Don't bother showing autogenerated messages that don't have associated
1974 # file or line comments. this will filter out most autogenerated
1975 # messages, but will keep robot comments like those from Tricium.
1976 is_autogenerated = msg.get('tag', '').startswith('autogenerated')
1977 if is_autogenerated and not comments.get(key):
1978 return None
1979 message = msg['message']
1980 # Gerrit spits out nanoseconds.
1981 assert len(msg['date'].split('.')[-1]) == 9
1982 date = datetime.datetime.strptime(msg['date'][:-3],
1983 '%Y-%m-%d %H:%M:%S.%f')
1984 if key in comments:
1985 message += '\n'
1986 for path, patchsets in sorted(comments.get(key, {}).items()):
1987 if readable:
1988 message += '\n%s' % path
1989 for patchset, lines in sorted(patchsets.items()):
1990 for line, (url, content) in sorted(lines.items()):
1991 if line:
1992 line_str = 'Line %d' % line
1993 path_str = '%s:%d:' % (path, line)
1994 else:
1995 line_str = 'File comment'
1996 path_str = '%s:0:' % path
1997 if readable:
1998 message += '\n %s, %s: %s' % (patchset, line_str, url)
1999 message += '\n %s\n' % content
2000 else:
2001 message += '\n%s ' % path_str
2002 message += '\n%s\n' % content
2003
2004 return _CommentSummary(
2005 date=date,
2006 message=message,
2007 sender=msg['author']['email'],
2008 autogenerated=is_autogenerated,
2009 # These could be inferred from the text messages and correlated with
2010 # Code-Review label maximum, however this is not reliable.
2011 # Leaving as is until the need arises.
2012 approval=False,
2013 disapproval=False,
2014 )
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01002015
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002016 def CloseIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002017 gerrit_util.AbandonChange(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002018 self.GetGerritHost(), self._GerritChangeIdentifier(), msg='')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002019
Xinan Lin1bd4ffa2021-07-28 00:54:22 +00002020 def SubmitIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002021 gerrit_util.SubmitChange(
Xinan Lin1bd4ffa2021-07-28 00:54:22 +00002022 self.GetGerritHost(), self._GerritChangeIdentifier())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002023
Edward Lesmes7677e5c2020-02-19 20:39:03 +00002024 def _GetChangeDetail(self, options=None):
2025 """Returns details of associated Gerrit change and caching results."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002026 options = options or []
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002027 assert self.GetIssue(), 'issue is required to query Gerrit'
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002028
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01002029 # Optimization to avoid multiple RPCs:
Edward Lesmes7677e5c2020-02-19 20:39:03 +00002030 if 'CURRENT_REVISION' in options or 'ALL_REVISIONS' in options:
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01002031 options.append('CURRENT_COMMIT')
2032
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002033 # Normalize issue and options for consistent keys in cache.
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002034 cache_key = str(self.GetIssue())
Edward Lesmes7677e5c2020-02-19 20:39:03 +00002035 options_set = frozenset(o.upper() for o in options)
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002036
Edward Lesmes7677e5c2020-02-19 20:39:03 +00002037 for cached_options_set, data in self._detail_cache.get(cache_key, []):
2038 # Assumption: data fetched before with extra options is suitable
2039 # for return for a smaller set of options.
2040 # For example, if we cached data for
2041 # options=[CURRENT_REVISION, DETAILED_FOOTERS]
2042 # and request is for options=[CURRENT_REVISION],
2043 # THEN we can return prior cached data.
2044 if options_set.issubset(cached_options_set):
2045 return data
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002046
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002047 try:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002048 data = gerrit_util.GetChangeDetail(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002049 self.GetGerritHost(), self._GerritChangeIdentifier(), options_set)
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002050 except gerrit_util.GerritError as e:
2051 if e.http_status == 404:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002052 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002053 raise
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002054
Edward Lesmes7677e5c2020-02-19 20:39:03 +00002055 self._detail_cache.setdefault(cache_key, []).append((options_set, data))
tandriic2405f52016-10-10 08:13:15 -07002056 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002057
Andrii Shyshkalovcc5f17e2018-08-22 23:35:59 +00002058 def _GetChangeCommit(self):
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002059 assert self.GetIssue(), 'issue must be set to query Gerrit'
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002060 try:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002061 data = gerrit_util.GetChangeCommit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002062 self.GetGerritHost(), self._GerritChangeIdentifier())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002063 except gerrit_util.GerritError as e:
2064 if e.http_status == 404:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002065 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002066 raise
agable32978d92016-11-01 12:55:02 -07002067 return data
2068
Karen Qian40c19422019-03-13 21:28:29 +00002069 def _IsCqConfigured(self):
2070 detail = self._GetChangeDetail(['LABELS'])
Andrii Shyshkalov8effa4d2020-01-21 13:23:36 +00002071 return u'Commit-Queue' in detail.get('labels', {})
Karen Qian40c19422019-03-13 21:28:29 +00002072
Saagar Sanghavi03b15132020-08-10 16:43:41 +00002073 def CMDLand(self, force, bypass_hooks, verbose, parallel, resultdb, realm):
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002074 if git_common.is_dirty_git_tree('land'):
2075 return 1
Karen Qian40c19422019-03-13 21:28:29 +00002076
tandriid60367b2016-06-22 05:25:12 -07002077 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
Karen Qian40c19422019-03-13 21:28:29 +00002078 if not force and self._IsCqConfigured():
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00002079 confirm_or_exit('\nIt seems this repository has a CQ, '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002080 'which can test and land changes for you. '
2081 'Are you sure you wish to bypass it?\n',
2082 action='bypass CQ')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002083 differs = True
tandriic4344b52016-08-29 06:04:54 -07002084 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002085 # Note: git diff outputs nothing if there is no diff.
2086 if not last_upload or RunGit(['diff', last_upload]).strip():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002087 print('WARNING: Some changes from local branch haven\'t been uploaded.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002088 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002089 if detail['current_revision'] == last_upload:
2090 differs = False
2091 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002092 print('WARNING: Local branch contents differ from latest uploaded '
2093 'patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002094 if differs:
2095 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002096 confirm_or_exit(
2097 'Do you want to submit latest Gerrit patchset and bypass hooks?\n',
2098 action='submit')
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002099 print('WARNING: Bypassing hooks and submitting latest uploaded patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002100 elif not bypass_hooks:
Edward Lemur227d5102020-02-25 23:45:35 +00002101 upstream = self.GetCommonAncestorWithUpstream()
2102 if self.GetIssue():
2103 description = self.FetchDescription()
2104 else:
Edward Lemura12175c2020-03-09 16:58:26 +00002105 description = _create_description_from_log([upstream])
Edward Lemur227d5102020-02-25 23:45:35 +00002106 self.RunHook(
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002107 committing=True,
2108 may_prompt=not force,
2109 verbose=verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00002110 parallel=parallel,
2111 upstream=upstream,
2112 description=description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00002113 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00002114 resultdb=resultdb,
2115 realm=realm)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002116
Xinan Lin1bd4ffa2021-07-28 00:54:22 +00002117 self.SubmitIssue()
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002118 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002119 links = self._GetChangeCommit().get('web_links', [])
2120 for link in links:
Michael Mosse371c642021-09-29 16:41:04 +00002121 if link.get('name') in ['gitiles', 'browse'] and link.get('url'):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002122 print('Landed as: %s' % link.get('url'))
agable32978d92016-11-01 12:55:02 -07002123 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002124 return 0
2125
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002126 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force,
2127 newbranch):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002128 assert parsed_issue_arg.valid
2129
Edward Lemur125d60a2019-09-13 18:25:41 +00002130 self.issue = parsed_issue_arg.issue
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002131
2132 if parsed_issue_arg.hostname:
2133 self._gerrit_host = parsed_issue_arg.hostname
2134 self._gerrit_server = 'https://%s' % self._gerrit_host
2135
tandriic2405f52016-10-10 08:13:15 -07002136 try:
2137 detail = self._GetChangeDetail(['ALL_REVISIONS'])
Aaron Gablea45ee112016-11-22 15:14:38 -08002138 except GerritChangeNotExists as e:
tandriic2405f52016-10-10 08:13:15 -07002139 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002140
2141 if not parsed_issue_arg.patchset:
2142 # Use current revision by default.
2143 revision_info = detail['revisions'][detail['current_revision']]
2144 patchset = int(revision_info['_number'])
2145 else:
2146 patchset = parsed_issue_arg.patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002147 for revision_info in detail['revisions'].values():
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002148 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2149 break
2150 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002151 DieWithError('Couldn\'t find patchset %i in change %i' %
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002152 (parsed_issue_arg.patchset, self.GetIssue()))
2153
Edward Lemur125d60a2019-09-13 18:25:41 +00002154 remote_url = self.GetRemoteUrl()
Aaron Gable697a91b2018-01-19 15:20:15 -08002155 if remote_url.endswith('.git'):
2156 remote_url = remote_url[:-len('.git')]
erikchen0d14d0d2018-08-28 18:57:09 +00002157 remote_url = remote_url.rstrip('/')
2158
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002159 fetch_info = revision_info['fetch']['http']
erikchen0d14d0d2018-08-28 18:57:09 +00002160 fetch_info['url'] = fetch_info['url'].rstrip('/')
Aaron Gable697a91b2018-01-19 15:20:15 -08002161
2162 if remote_url != fetch_info['url']:
2163 DieWithError('Trying to patch a change from %s but this repo appears '
2164 'to be %s.' % (fetch_info['url'], remote_url))
2165
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002166 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
Aaron Gable9387b4f2017-06-08 10:50:03 -07002167
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002168 # If we have created a new branch then do the "set issue" immediately in
2169 # case the cherry-pick fails, which happens when resolving conflicts.
2170 if newbranch:
2171 self.SetIssue(parsed_issue_arg.issue)
2172
Aaron Gable62619a32017-06-16 08:22:09 -07002173 if force:
2174 RunGit(['reset', '--hard', 'FETCH_HEAD'])
2175 print('Checked out commit for change %i patchset %i locally' %
2176 (parsed_issue_arg.issue, patchset))
Stefan Zager2d5f0392017-10-10 15:17:53 -07002177 elif nocommit:
2178 RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD'])
2179 print('Patch applied to index.')
Aaron Gable62619a32017-06-16 08:22:09 -07002180 else:
Aaron Gable9387b4f2017-06-08 10:50:03 -07002181 RunGit(['cherry-pick', 'FETCH_HEAD'])
2182 print('Committed patch for change %i patchset %i locally.' %
Aaron Gable62619a32017-06-16 08:22:09 -07002183 (parsed_issue_arg.issue, patchset))
2184 print('Note: this created a local commit which does not have '
2185 'the same hash as the one uploaded for review. This will make '
2186 'uploading changes based on top of this branch difficult.\n'
2187 'If you want to do that, use "git cl patch --force" instead.')
2188
Stefan Zagerd08043c2017-10-12 12:07:02 -07002189 if self.GetBranch():
2190 self.SetIssue(parsed_issue_arg.issue)
2191 self.SetPatchset(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00002192 fetched_hash = scm.GIT.ResolveCommit(settings.GetRoot(), 'FETCH_HEAD')
Stefan Zagerd08043c2017-10-12 12:07:02 -07002193 self._GitSetBranchConfigValue('last-upload-hash', fetched_hash)
2194 self._GitSetBranchConfigValue('gerritsquashhash', fetched_hash)
2195 else:
2196 print('WARNING: You are in detached HEAD state.\n'
2197 'The patch has been applied to your checkout, but you will not be '
2198 'able to upload a new patch set to the gerrit issue.\n'
2199 'Try using the \'-b\' option if you would like to work on a '
2200 'branch and/or upload a new patch set.')
2201
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002202 return 0
2203
tandrii16e0b4e2016-06-07 10:34:28 -07002204 def _GerritCommitMsgHookCheck(self, offer_removal):
2205 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2206 if not os.path.exists(hook):
2207 return
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002208 # Crude attempt to distinguish Gerrit Codereview hook from a potentially
2209 # custom developer-made one.
tandrii16e0b4e2016-06-07 10:34:28 -07002210 data = gclient_utils.FileRead(hook)
2211 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2212 return
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002213 print('WARNING: You have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002214 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002215 'and may interfere with it in subtle ways.\n'
2216 'We recommend you remove the commit-msg hook.')
2217 if offer_removal:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002218 if ask_for_explicit_yes('Do you want to remove it now?'):
tandrii16e0b4e2016-06-07 10:34:28 -07002219 gclient_utils.rm_file_or_tree(hook)
2220 print('Gerrit commit-msg hook removed.')
2221 else:
2222 print('OK, will keep Gerrit commit-msg hook in place.')
2223
Edward Lemur1b52d872019-05-09 21:12:12 +00002224 def _CleanUpOldTraces(self):
2225 """Keep only the last |MAX_TRACES| traces."""
2226 try:
2227 traces = sorted([
2228 os.path.join(TRACES_DIR, f)
2229 for f in os.listdir(TRACES_DIR)
2230 if (os.path.isfile(os.path.join(TRACES_DIR, f))
2231 and not f.startswith('tmp'))
2232 ])
2233 traces_to_delete = traces[:-MAX_TRACES]
2234 for trace in traces_to_delete:
Daniel Chengcf6269b2019-05-18 01:02:12 +00002235 os.remove(trace)
Edward Lemur1b52d872019-05-09 21:12:12 +00002236 except OSError:
2237 print('WARNING: Failed to remove old git traces from\n'
2238 ' %s'
2239 'Consider removing them manually.' % TRACES_DIR)
Edward Lemurdc8e23d2019-05-07 00:45:48 +00002240
Edward Lemur5737f022019-05-17 01:24:00 +00002241 def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002242 """Zip and write the git push traces stored in traces_dir."""
2243 gclient_utils.safe_makedirs(TRACES_DIR)
Edward Lemur1b52d872019-05-09 21:12:12 +00002244 traces_zip = trace_name + '-traces'
2245 traces_readme = trace_name + '-README'
Michael Mosse7f0b4c2019-05-08 04:36:24 +00002246 # Create a temporary dir to store git config and gitcookies in. It will be
2247 # compressed and stored next to the traces.
2248 git_info_dir = tempfile.mkdtemp()
Edward Lemur1b52d872019-05-09 21:12:12 +00002249 git_info_zip = trace_name + '-git-info'
2250
Josip Sokcevic5e18b602020-04-23 21:47:00 +00002251 git_push_metadata['now'] = datetime_now().strftime('%Y-%m-%dT%H:%M:%S.%f')
sangwoo.ko7a614332019-05-22 02:46:19 +00002252
Edward Lemur1b52d872019-05-09 21:12:12 +00002253 git_push_metadata['trace_name'] = trace_name
2254 gclient_utils.FileWrite(
2255 traces_readme, TRACES_README_FORMAT % git_push_metadata)
2256
2257 # Keep only the first 6 characters of the git hashes on the packet
2258 # trace. This greatly decreases size after compression.
2259 packet_traces = os.path.join(traces_dir, 'trace-packet')
2260 if os.path.isfile(packet_traces):
2261 contents = gclient_utils.FileRead(packet_traces)
2262 gclient_utils.FileWrite(
2263 packet_traces, GIT_HASH_RE.sub(r'\1', contents))
2264 shutil.make_archive(traces_zip, 'zip', traces_dir)
2265
2266 # Collect and compress the git config and gitcookies.
2267 git_config = RunGit(['config', '-l'])
2268 gclient_utils.FileWrite(
2269 os.path.join(git_info_dir, 'git-config'),
2270 git_config)
2271
2272 cookie_auth = gerrit_util.Authenticator.get()
2273 if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
2274 gitcookies_path = cookie_auth.get_gitcookies_path()
2275 if os.path.isfile(gitcookies_path):
2276 gitcookies = gclient_utils.FileRead(gitcookies_path)
2277 gclient_utils.FileWrite(
2278 os.path.join(git_info_dir, 'gitcookies'),
2279 GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies))
2280 shutil.make_archive(git_info_zip, 'zip', git_info_dir)
2281
Edward Lemur1b52d872019-05-09 21:12:12 +00002282 gclient_utils.rmtree(git_info_dir)
2283
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002284 def _RunGitPushWithTraces(self,
2285 refspec,
2286 refspec_opts,
2287 git_push_metadata,
2288 git_push_options=None):
Edward Lemur1b52d872019-05-09 21:12:12 +00002289 """Run git push and collect the traces resulting from the execution."""
2290 # Create a temporary directory to store traces in. Traces will be compressed
2291 # and stored in a 'traces' dir inside depot_tools.
2292 traces_dir = tempfile.mkdtemp()
Edward Lemur5737f022019-05-17 01:24:00 +00002293 trace_name = os.path.join(
2294 TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f'))
Edward Lemur0f58ae42019-04-30 17:24:12 +00002295
2296 env = os.environ.copy()
2297 env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy'
2298 env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Jonathan Nieder9779b142019-05-29 23:19:29 +00002299 env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002300 env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl')
2301 env['GIT_TRACE_CURL_NO_DATA'] = '1'
2302 env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet')
2303
2304 try:
2305 push_returncode = 0
Edward Lemur1b52d872019-05-09 21:12:12 +00002306 remote_url = self.GetRemoteUrl()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002307 before_push = time_time()
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002308 push_cmd = ['git', 'push', remote_url, refspec]
2309 if git_push_options:
2310 for opt in git_push_options:
2311 push_cmd.extend(['-o', opt])
2312
Edward Lemur0f58ae42019-04-30 17:24:12 +00002313 push_stdout = gclient_utils.CheckCallAndFilter(
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002314 push_cmd,
Edward Lemur0f58ae42019-04-30 17:24:12 +00002315 env=env,
2316 print_stdout=True,
2317 # Flush after every line: useful for seeing progress when running as
2318 # recipe.
2319 filter_fn=lambda _: sys.stdout.flush())
Edward Lemur79d4f992019-11-11 23:49:02 +00002320 push_stdout = push_stdout.decode('utf-8', 'replace')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002321 except subprocess2.CalledProcessError as e:
2322 push_returncode = e.returncode
Josip Sokcevic740825e2021-05-12 18:28:34 +00002323 if 'blocked keyword' in str(e.stdout):
2324 raise GitPushError(
2325 'Failed to create a change, very likely due to blocked keyword. '
2326 'Please examine output above for the reason of the failure.\n'
2327 'If this is a false positive, you can try to bypass blocked '
2328 'keyword by using push option '
2329 '-o uploadvalidator~skip, e.g.:\n'
2330 'git cl upload -o uploadvalidator~skip\n\n'
2331 'If git-cl is not working correctly, file a bug under the '
2332 'Infra>SDK component.')
Josip Sokcevic54e30e72022-02-10 22:32:24 +00002333 if 'git push -o nokeycheck' in str(e.stdout):
2334 raise GitPushError(
2335 'Failed to create a change, very likely due to a private key being '
2336 'detected. Please examine output above for the reason of the '
2337 'failure.\n'
2338 'If this is a false positive, you can try to bypass private key '
2339 'detection by using push option '
2340 '-o nokeycheck, e.g.:\n'
2341 'git cl upload -o nokeycheck\n\n'
2342 'If git-cl is not working correctly, file a bug under the '
2343 'Infra>SDK component.')
Josip Sokcevic740825e2021-05-12 18:28:34 +00002344
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002345 raise GitPushError(
2346 'Failed to create a change. Please examine output above for the '
2347 'reason of the failure.\n'
Josip Sokcevic7386a1e2021-02-12 19:00:34 +00002348 'For emergencies, Googlers can escalate to '
2349 'go/gob-support or go/notify#gob\n'
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002350 'Hint: run command below to diagnose common Git/Gerrit '
2351 'credential problems:\n'
2352 ' git cl creds-check\n'
2353 '\n'
2354 'If git-cl is not working correctly, file a bug under the Infra>SDK '
2355 'component including the files below.\n'
2356 'Review the files before upload, since they might contain sensitive '
2357 'information.\n'
2358 'Set the Restrict-View-Google label so that they are not publicly '
2359 'accessible.\n' + TRACES_MESSAGE % {'trace_name': trace_name})
Edward Lemur0f58ae42019-04-30 17:24:12 +00002360 finally:
2361 execution_time = time_time() - before_push
2362 metrics.collector.add_repeated('sub_commands', {
2363 'command': 'git push',
2364 'execution_time': execution_time,
2365 'exit_code': push_returncode,
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002366 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts),
Edward Lemur0f58ae42019-04-30 17:24:12 +00002367 })
2368
Edward Lemur1b52d872019-05-09 21:12:12 +00002369 git_push_metadata['execution_time'] = execution_time
2370 git_push_metadata['exit_code'] = push_returncode
Edward Lemur5737f022019-05-17 01:24:00 +00002371 self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata)
Edward Lemur0f58ae42019-04-30 17:24:12 +00002372
Edward Lemur1b52d872019-05-09 21:12:12 +00002373 self._CleanUpOldTraces()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002374 gclient_utils.rmtree(traces_dir)
2375
2376 return push_stdout
2377
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002378 def CMDUploadChange(self, options, git_diff_args, custom_cl_base,
2379 change_desc):
2380 """Upload the current branch to Gerrit, retry if new remote HEAD is
2381 found. options and change_desc may be mutated."""
Josip Sokcevicb631a882021-01-06 18:18:10 +00002382 remote, remote_branch = self.GetRemoteBranch()
2383 branch = GetTargetRef(remote, remote_branch, options.target_branch)
2384
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002385 try:
2386 return self._CMDUploadChange(options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002387 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002388 except GitPushError as e:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002389 # Repository might be in the middle of transition to main branch as
2390 # default, and uploads to old default might be blocked.
2391 if remote_branch not in [DEFAULT_OLD_BRANCH, DEFAULT_NEW_BRANCH]:
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002392 DieWithError(str(e), change_desc)
2393
Josip Sokcevicb631a882021-01-06 18:18:10 +00002394 project_head = gerrit_util.GetProjectHead(self._gerrit_host,
2395 self.GetGerritProject())
2396 if project_head == branch:
2397 DieWithError(str(e), change_desc)
2398 branch = project_head
2399
2400 print("WARNING: Fetching remote state and retrying upload to default "
2401 "branch...")
2402 RunGit(['fetch', '--prune', remote])
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002403 options.edit_description = False
2404 options.force = True
2405 try:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002406 self._CMDUploadChange(options, git_diff_args, custom_cl_base,
2407 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002408 except GitPushError as e:
2409 DieWithError(str(e), change_desc)
2410
2411 def _CMDUploadChange(self, options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002412 change_desc, branch):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002413 """Upload the current branch to Gerrit."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002414 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002415 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002416 if self.GetIssue():
Josipe827b0f2020-01-30 00:07:20 +00002417 # User requested to change description
2418 if options.edit_description:
Josipe827b0f2020-01-30 00:07:20 +00002419 change_desc.prompt()
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002420 change_id = self._GetChangeDetail()['change_id']
Edward Lemur5a644f82020-03-18 16:44:57 +00002421 change_desc.ensure_change_id(change_id)
Aaron Gableb56ad332017-01-06 15:24:31 -08002422 else: # if not self.GetIssue()
Gavin Mak68e6cf32021-01-25 18:24:08 +00002423 if not options.force and not options.message_file:
Anthony Polito8b955342019-09-24 19:01:36 +00002424 change_desc.prompt()
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002425 change_ids = git_footers.get_footer_change_id(change_desc.description)
Edward Lemur5a644f82020-03-18 16:44:57 +00002426 if len(change_ids) == 1:
2427 change_id = change_ids[0]
2428 else:
2429 change_id = GenerateGerritChangeId(change_desc.description)
2430 change_desc.ensure_change_id(change_id)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002431
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002432 if options.preserve_tryjobs:
2433 change_desc.set_preserve_tryjobs()
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002434
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002435 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Edward Lemur5a644f82020-03-18 16:44:57 +00002436 parent = self._ComputeParent(
2437 remote, upstream_branch, custom_cl_base, options.force, change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002438 tree = RunGit(['rev-parse', 'HEAD:']).strip()
Edward Lemur1773f372020-02-22 00:27:14 +00002439 with gclient_utils.temporary_file() as desc_tempfile:
2440 gclient_utils.FileWrite(desc_tempfile, change_desc.description)
2441 ref_to_push = RunGit(
2442 ['commit-tree', tree, '-p', parent, '-F', desc_tempfile]).strip()
Anthony Polito8b955342019-09-24 19:01:36 +00002443 else: # if not options.squash
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00002444 if options.no_add_changeid:
2445 pass
2446 else: # adding Change-Ids is okay.
2447 if not git_footers.get_footer_change_id(change_desc.description):
2448 DownloadGerritHook(False)
2449 change_desc.set_description(
2450 self._AddChangeIdToCommitMessage(change_desc.description,
2451 git_diff_args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002452 ref_to_push = 'HEAD'
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002453 # For no-squash mode, we assume the remote called "origin" is the one we
2454 # want. It is not worthwhile to support different workflows for
2455 # no-squash mode.
2456 parent = 'origin/%s' % branch
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00002457 # attempt to extract the changeid from the current description
2458 # fail informatively if not possible.
2459 change_id_candidates = git_footers.get_footer_change_id(
2460 change_desc.description)
2461 if not change_id_candidates:
2462 DieWithError("Unable to extract change-id from message.")
2463 change_id = change_id_candidates[0]
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002464
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +00002465 SaveDescriptionBackup(change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002466 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2467 ref_to_push)]).splitlines()
2468 if len(commits) > 1:
2469 print('WARNING: This will upload %d commits. Run the following command '
2470 'to see which commits will be uploaded: ' % len(commits))
2471 print('git log %s..%s' % (parent, ref_to_push))
2472 print('You can also use `git squash-branch` to squash these into a '
2473 'single commit.')
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002474 confirm_or_exit(action='upload')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002475
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002476 reviewers = sorted(change_desc.get_reviewers())
Edward Lemur4508b422019-10-03 21:56:35 +00002477 cc = []
2478 # Add CCs from WATCHLISTS and rietveld.cc git config unless this is
2479 # the initial upload, the CL is private, or auto-CCing has ben disabled.
2480 if not (self.GetIssue() or options.private or options.no_autocc):
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002481 cc = self.GetCCList().split(',')
Gavin Makb1c08f62021-04-01 18:05:58 +00002482 if len(cc) > 100:
2483 lsc = ('https://chromium.googlesource.com/chromium/src/+/HEAD/docs/'
2484 'process/lsc/lsc_workflow.md')
2485 print('WARNING: This will auto-CC %s users.' % len(cc))
2486 print('LSC may be more appropriate: %s' % lsc)
2487 print('You can also use the --no-autocc flag to disable auto-CC.')
2488 confirm_or_exit(action='continue')
Edward Lemur4508b422019-10-03 21:56:35 +00002489 # Add cc's from the --cc flag.
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002490 if options.cc:
2491 cc.extend(options.cc)
Edward Lemur79d4f992019-11-11 23:49:02 +00002492 cc = [email.strip() for email in cc if email.strip()]
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002493 if change_desc.get_cced():
2494 cc.extend(change_desc.get_cced())
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002495 if self.GetGerritHost() == 'chromium-review.googlesource.com':
Andrii Shyshkalov0da5e8f2018-10-30 17:29:18 +00002496 valid_accounts = set(reviewers + cc)
2497 # TODO(crbug/877717): relax this for all hosts.
2498 else:
2499 valid_accounts = gerrit_util.ValidAccounts(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002500 self.GetGerritHost(), reviewers + cc)
Andrii Shyshkalovf170af42018-10-30 07:00:44 +00002501 logging.info('accounts %s are recognized, %s invalid',
2502 sorted(valid_accounts),
2503 set(reviewers + cc).difference(set(valid_accounts)))
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002504
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002505 # Extra options that can be specified at push time. Doc:
2506 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002507 refspec_opts = []
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002508
Aaron Gable844cf292017-06-28 11:32:59 -07002509 # By default, new changes are started in WIP mode, and subsequent patchsets
Thiago Perrottab0fb8d52022-08-30 21:26:19 +00002510 # don't send email. At any time, passing --send-mail or --send-email will
2511 # mark the change ready and send email for that particular patch.
Aaron Gableafd52772017-06-27 16:40:10 -07002512 if options.send_mail:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002513 refspec_opts.append('ready')
2514 refspec_opts.append('notify=ALL')
Jamie Madill276da0b2018-04-27 14:41:20 -04002515 elif not self.GetIssue() and options.squash:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002516 refspec_opts.append('wip')
Aaron Gableafd52772017-06-27 16:40:10 -07002517 else:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002518 refspec_opts.append('notify=NONE')
Aaron Gable70f4e242017-06-26 10:45:59 -07002519
Thiago Perrottab0fb8d52022-08-30 21:26:19 +00002520 # TODO(tandrii): options.message should be posted as a comment if
2521 # --send-mail or --send-email is set on non-initial upload as Rietveld used
2522 # to do it.
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002523
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002524 # Set options.title in case user was prompted in _GetTitleForUpload and
2525 # _CMDUploadChange needs to be called again.
2526 options.title = self._GetTitleForUpload(options)
2527 if options.title:
Nick Carter8692b182017-11-06 16:30:38 -08002528 # Punctuation and whitespace in |title| must be percent-encoded.
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002529 refspec_opts.append(
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002530 'm=' + gerrit_util.PercentEncodeForGitRef(options.title))
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002531
agablec6787972016-09-09 16:13:34 -07002532 if options.private:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002533 refspec_opts.append('private')
agablec6787972016-09-09 16:13:34 -07002534
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002535 for r in sorted(reviewers):
2536 if r in valid_accounts:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002537 refspec_opts.append('r=%s' % r)
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002538 reviewers.remove(r)
2539 else:
2540 # TODO(tandrii): this should probably be a hard failure.
2541 print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping'
2542 % r)
2543 for c in sorted(cc):
2544 # refspec option will be rejected if cc doesn't correspond to an
2545 # account, even though REST call to add such arbitrary cc may succeed.
2546 if c in valid_accounts:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002547 refspec_opts.append('cc=%s' % c)
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002548 cc.remove(c)
2549
rmistry9eadede2016-09-19 11:22:43 -07002550 if options.topic:
2551 # Documentation on Gerrit topics is here:
2552 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002553 refspec_opts.append('topic=%s' % options.topic)
rmistry9eadede2016-09-19 11:22:43 -07002554
Edward Lemur687ca902018-12-05 02:30:30 +00002555 if options.enable_auto_submit:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002556 refspec_opts.append('l=Auto-Submit+1')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00002557 if options.set_bot_commit:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002558 refspec_opts.append('l=Bot-Commit+1')
Edward Lemur687ca902018-12-05 02:30:30 +00002559 if options.use_commit_queue:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002560 refspec_opts.append('l=Commit-Queue+2')
Edward Lemur687ca902018-12-05 02:30:30 +00002561 elif options.cq_dry_run:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002562 refspec_opts.append('l=Commit-Queue+1')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00002563 elif options.cq_quick_run:
2564 refspec_opts.append('l=Commit-Queue+1')
2565 refspec_opts.append('l=Quick-Run+1')
Edward Lemur687ca902018-12-05 02:30:30 +00002566
2567 if change_desc.get_reviewers(tbr_only=True):
2568 score = gerrit_util.GetCodeReviewTbrScore(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002569 self.GetGerritHost(),
2570 self.GetGerritProject())
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002571 refspec_opts.append('l=Code-Review+%s' % score)
Andrii Shyshkalove7a7fc42018-10-30 17:35:09 +00002572
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002573 # Gerrit sorts hashtags, so order is not important.
Nodir Turakulov23b82142017-11-16 11:04:25 -08002574 hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags}
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002575 if not self.GetIssue():
Nodir Turakulov23b82142017-11-16 11:04:25 -08002576 hashtags.update(change_desc.get_hash_tags())
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002577 refspec_opts += ['hashtag=%s' % t for t in sorted(hashtags)]
2578
2579 refspec_suffix = ''
2580 if refspec_opts:
2581 refspec_suffix = '%' + ','.join(refspec_opts)
2582 assert ' ' not in refspec_suffix, (
2583 'spaces not allowed in refspec: "%s"' % refspec_suffix)
2584 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002585
Edward Lemur1b52d872019-05-09 21:12:12 +00002586 git_push_metadata = {
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002587 'gerrit_host': self.GetGerritHost(),
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002588 'title': options.title or '<untitled>',
Edward Lemur1b52d872019-05-09 21:12:12 +00002589 'change_id': change_id,
2590 'description': change_desc.description,
2591 }
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002592
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002593 push_stdout = self._RunGitPushWithTraces(refspec, refspec_opts,
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002594 git_push_metadata,
2595 options.push_options)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002596
2597 if options.squash:
Aaron Gable289b4312017-09-13 14:06:16 -07002598 regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002599 change_numbers = [m.group(1)
2600 for m in map(regex.match, push_stdout.splitlines())
2601 if m]
2602 if len(change_numbers) != 1:
2603 DieWithError(
2604 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
Christopher Lamf732cd52017-01-24 12:40:11 +11002605 'Change-Id: %s') % (len(change_numbers), change_id), change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002606 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002607 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002608
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002609 if self.GetIssue() and (reviewers or cc):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002610 # GetIssue() is not set in case of non-squash uploads according to tests.
Aaron Gable6e7ddb62020-05-27 22:23:29 +00002611 # TODO(crbug.com/751901): non-squash uploads in git cl should be removed.
Thiago Perrottab0fb8d52022-08-30 21:26:19 +00002612 gerrit_util.AddReviewers(self.GetGerritHost(),
2613 self._GerritChangeIdentifier(),
2614 reviewers,
2615 cc,
2616 notify=bool(options.send_mail))
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002617
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002618 return 0
2619
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002620 def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force,
2621 change_desc):
2622 """Computes parent of the generated commit to be uploaded to Gerrit.
2623
2624 Returns revision or a ref name.
2625 """
2626 if custom_cl_base:
2627 # Try to avoid creating additional unintended CLs when uploading, unless
2628 # user wants to take this risk.
2629 local_ref_of_target_remote = self.GetRemoteBranch()[1]
2630 code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base,
2631 local_ref_of_target_remote])
2632 if code == 1:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002633 print('\nWARNING: Manually specified base of this CL `%s` '
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002634 'doesn\'t seem to belong to target remote branch `%s`.\n\n'
2635 'If you proceed with upload, more than 1 CL may be created by '
2636 'Gerrit as a result, in turn confusing or crashing git cl.\n\n'
2637 'If you are certain that specified base `%s` has already been '
2638 'uploaded to Gerrit as another CL, you may proceed.\n' %
2639 (custom_cl_base, local_ref_of_target_remote, custom_cl_base))
2640 if not force:
2641 confirm_or_exit(
2642 'Do you take responsibility for cleaning up potential mess '
2643 'resulting from proceeding with upload?',
2644 action='upload')
2645 return custom_cl_base
2646
Aaron Gablef97e33d2017-03-30 15:44:27 -07002647 if remote != '.':
2648 return self.GetCommonAncestorWithUpstream()
2649
2650 # If our upstream branch is local, we base our squashed commit on its
2651 # squashed version.
2652 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2653
Aaron Gablef97e33d2017-03-30 15:44:27 -07002654 if upstream_branch_name == 'master':
Aaron Gable0bbd1c22017-05-08 14:37:08 -07002655 return self.GetCommonAncestorWithUpstream()
Glen Robertson7d98e222020-08-27 17:53:11 +00002656 if upstream_branch_name == 'main':
2657 return self.GetCommonAncestorWithUpstream()
Aaron Gablef97e33d2017-03-30 15:44:27 -07002658
2659 # Check the squashed hash of the parent.
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002660 # TODO(tandrii): consider checking parent change in Gerrit and using its
2661 # hash if tree hash of latest parent revision (patchset) in Gerrit matches
2662 # the tree hash of the parent branch. The upside is less likely bogus
2663 # requests to reupload parent change just because it's uploadhash is
2664 # missing, yet the downside likely exists, too (albeit unknown to me yet).
Edward Lesmesa680c232020-03-31 18:26:44 +00002665 parent = scm.GIT.GetBranchConfig(
2666 settings.GetRoot(), upstream_branch_name, 'gerritsquashhash')
Aaron Gablef97e33d2017-03-30 15:44:27 -07002667 # Verify that the upstream branch has been uploaded too, otherwise
2668 # Gerrit will create additional CLs when uploading.
2669 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2670 RunGitSilent(['rev-parse', parent + ':'])):
2671 DieWithError(
2672 '\nUpload upstream branch %s first.\n'
2673 'It is likely that this branch has been rebased since its last '
2674 'upload, so you just need to upload it again.\n'
2675 '(If you uploaded it with --no-squash, then branch dependencies '
2676 'are not supported, and you should reupload with --squash.)'
2677 % upstream_branch_name,
2678 change_desc)
2679 return parent
2680
Edward Lemura12175c2020-03-09 16:58:26 +00002681 def _AddChangeIdToCommitMessage(self, log_desc, args):
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002682 """Re-commits using the current message, assumes the commit hook is in
2683 place.
2684 """
Edward Lemura12175c2020-03-09 16:58:26 +00002685 RunGit(['commit', '--amend', '-m', log_desc])
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002686 new_log_desc = _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002687 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002688 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002689 return new_log_desc
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00002690
2691 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002692
tandriie113dfd2016-10-11 10:20:12 -07002693 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002694 try:
2695 data = self._GetChangeDetail()
Aaron Gablea45ee112016-11-22 15:14:38 -08002696 except GerritChangeNotExists:
2697 return 'Gerrit doesn\'t know about your change %s' % self.GetIssue()
tandrii8c5a3532016-11-04 07:52:02 -07002698
2699 if data['status'] in ('ABANDONED', 'MERGED'):
2700 return 'CL %s is closed' % self.GetIssue()
2701
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002702 def GetGerritChange(self, patchset=None):
2703 """Returns a buildbucket.v2.GerritChange message for the current issue."""
Edward Lemur79d4f992019-11-11 23:49:02 +00002704 host = urllib.parse.urlparse(self.GetCodereviewServer()).hostname
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002705 issue = self.GetIssue()
Edward Lemur2c210a42019-09-16 23:58:35 +00002706 patchset = int(patchset or self.GetPatchset())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002707 data = self._GetChangeDetail(['ALL_REVISIONS'])
2708
2709 assert host and issue and patchset, 'CL must be uploaded first'
2710
2711 has_patchset = any(
2712 int(revision_data['_number']) == patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002713 for revision_data in data['revisions'].values())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002714 if not has_patchset:
Aaron Gablea45ee112016-11-22 15:14:38 -08002715 raise Exception('Patchset %d is not known in Gerrit change %d' %
tandrii8c5a3532016-11-04 07:52:02 -07002716 (patchset, self.GetIssue()))
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002717
tandrii8c5a3532016-11-04 07:52:02 -07002718 return {
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002719 'host': host,
2720 'change': issue,
2721 'project': data['project'],
2722 'patchset': patchset,
tandrii8c5a3532016-11-04 07:52:02 -07002723 }
tandriie113dfd2016-10-11 10:20:12 -07002724
tandriide281ae2016-10-12 06:02:30 -07002725 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002726 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002727
Edward Lemur707d70b2018-02-07 00:50:14 +01002728 def GetReviewers(self):
2729 details = self._GetChangeDetail(['DETAILED_ACCOUNTS'])
Mohamed Heikal171c0742018-11-09 20:38:51 +00002730 return [r['email'] for r in details['reviewers'].get('REVIEWER', [])]
Edward Lemur707d70b2018-02-07 00:50:14 +01002731
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002732
Lei Zhang8a0efc12020-08-05 19:58:45 +00002733def _get_bug_line_values(default_project_prefix, bugs):
2734 """Given default_project_prefix and comma separated list of bugs, yields bug
2735 line values.
tandriif9aefb72016-07-01 09:06:51 -07002736
2737 Each bug can be either:
Lei Zhang8a0efc12020-08-05 19:58:45 +00002738 * a number, which is combined with default_project_prefix
tandriif9aefb72016-07-01 09:06:51 -07002739 * string, which is left as is.
2740
2741 This function may produce more than one line, because bugdroid expects one
2742 project per line.
2743
Lei Zhang8a0efc12020-08-05 19:58:45 +00002744 >>> list(_get_bug_line_values('v8:', '123,chromium:789'))
tandriif9aefb72016-07-01 09:06:51 -07002745 ['v8:123', 'chromium:789']
2746 """
2747 default_bugs = []
2748 others = []
2749 for bug in bugs.split(','):
2750 bug = bug.strip()
2751 if bug:
2752 try:
2753 default_bugs.append(int(bug))
2754 except ValueError:
2755 others.append(bug)
2756
2757 if default_bugs:
2758 default_bugs = ','.join(map(str, default_bugs))
Lei Zhang8a0efc12020-08-05 19:58:45 +00002759 if default_project_prefix:
2760 if not default_project_prefix.endswith(':'):
2761 default_project_prefix += ':'
2762 yield '%s%s' % (default_project_prefix, default_bugs)
tandriif9aefb72016-07-01 09:06:51 -07002763 else:
2764 yield default_bugs
2765 for other in sorted(others):
2766 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2767 yield other
2768
2769
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002770class ChangeDescription(object):
2771 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002772 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002773 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
Aaron Gable3a16ed12017-03-23 10:51:55 -07002774 BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$'
Dan Beamd8b04ca2019-10-10 21:23:26 +00002775 FIXED_LINE = r'^[ \t]*Fixed[ \t]*:[ \t]*(.*?)[ \t]*$'
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002776 CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002777 STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*'
2778 BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]'
Anthony Polito02b5af32019-12-02 19:49:47 +00002779 COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):($|[^:])'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002780 BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002781
Dan Beamd8b04ca2019-10-10 21:23:26 +00002782 def __init__(self, description, bug=None, fixed=None):
agable@chromium.org42c20792013-09-12 17:34:49 +00002783 self._description_lines = (description or '').strip().splitlines()
Anthony Polito8b955342019-09-24 19:01:36 +00002784 if bug:
2785 regexp = re.compile(self.BUG_LINE)
2786 prefix = settings.GetBugPrefix()
2787 if not any((regexp.match(line) for line in self._description_lines)):
2788 values = list(_get_bug_line_values(prefix, bug))
2789 self.append_footer('Bug: %s' % ', '.join(values))
Dan Beamd8b04ca2019-10-10 21:23:26 +00002790 if fixed:
2791 regexp = re.compile(self.FIXED_LINE)
2792 prefix = settings.GetBugPrefix()
2793 if not any((regexp.match(line) for line in self._description_lines)):
2794 values = list(_get_bug_line_values(prefix, fixed))
2795 self.append_footer('Fixed: %s' % ', '.join(values))
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002796
agable@chromium.org42c20792013-09-12 17:34:49 +00002797 @property # www.logilab.org/ticket/89786
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08002798 def description(self): # pylint: disable=method-hidden
agable@chromium.org42c20792013-09-12 17:34:49 +00002799 return '\n'.join(self._description_lines)
2800
2801 def set_description(self, desc):
2802 if isinstance(desc, basestring):
2803 lines = desc.splitlines()
2804 else:
2805 lines = [line.rstrip() for line in desc]
2806 while lines and not lines[0]:
2807 lines.pop(0)
2808 while lines and not lines[-1]:
2809 lines.pop(-1)
2810 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002811
Edward Lemur5a644f82020-03-18 16:44:57 +00002812 def ensure_change_id(self, change_id):
2813 description = self.description
2814 footer_change_ids = git_footers.get_footer_change_id(description)
2815 # Make sure that the Change-Id in the description matches the given one.
2816 if footer_change_ids != [change_id]:
2817 if footer_change_ids:
2818 # Remove any existing Change-Id footers since they don't match the
2819 # expected change_id footer.
2820 description = git_footers.remove_footer(description, 'Change-Id')
2821 print('WARNING: Change-Id has been set to %s. Use `git cl issue 0` '
2822 'if you want to set a new one.')
2823 # Add the expected Change-Id footer.
2824 description = git_footers.add_footer_change_id(description, change_id)
2825 self.set_description(description)
2826
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002827 def update_reviewers(self, reviewers, tbrs):
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002828 """Rewrites the R=/TBR= line(s) as a single line each.
2829
2830 Args:
2831 reviewers (list(str)) - list of additional emails to use for reviewers.
2832 tbrs (list(str)) - list of additional emails to use for TBRs.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002833 """
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002834 if not reviewers and not tbrs:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002835 return
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002836
2837 reviewers = set(reviewers)
2838 tbrs = set(tbrs)
2839 LOOKUP = {
2840 'TBR': tbrs,
2841 'R': reviewers,
2842 }
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002843
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002844 # Get the set of R= and TBR= lines and remove them from the description.
agable@chromium.org42c20792013-09-12 17:34:49 +00002845 regexp = re.compile(self.R_LINE)
2846 matches = [regexp.match(line) for line in self._description_lines]
2847 new_desc = [l for i, l in enumerate(self._description_lines)
2848 if not matches[i]]
2849 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002850
agable@chromium.org42c20792013-09-12 17:34:49 +00002851 # Construct new unified R= and TBR= lines.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002852
2853 # First, update tbrs/reviewers with names from the R=/TBR= lines (if any).
agable@chromium.org42c20792013-09-12 17:34:49 +00002854 for match in matches:
2855 if not match:
2856 continue
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002857 LOOKUP[match.group(1)].update(cleanup_list([match.group(2).strip()]))
2858
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002859 # If any folks ended up in both groups, remove them from tbrs.
2860 tbrs -= reviewers
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002861
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002862 new_r_line = 'R=' + ', '.join(sorted(reviewers)) if reviewers else None
2863 new_tbr_line = 'TBR=' + ', '.join(sorted(tbrs)) if tbrs else None
agable@chromium.org42c20792013-09-12 17:34:49 +00002864
2865 # Put the new lines in the description where the old first R= line was.
2866 line_loc = next((i for i, match in enumerate(matches) if match), -1)
2867 if 0 <= line_loc < len(self._description_lines):
2868 if new_tbr_line:
2869 self._description_lines.insert(line_loc, new_tbr_line)
2870 if new_r_line:
2871 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002872 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00002873 if new_r_line:
2874 self.append_footer(new_r_line)
2875 if new_tbr_line:
2876 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002877
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002878 def set_preserve_tryjobs(self):
2879 """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'."""
2880 footers = git_footers.parse_footers(self.description)
2881 for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []):
2882 if v.lower() == 'true':
2883 return
2884 self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true')
2885
Anthony Polito8b955342019-09-24 19:01:36 +00002886 def prompt(self):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002887 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002888 self.set_description([
2889 '# Enter a description of the change.',
2890 '# This will be displayed on the codereview site.',
2891 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00002892 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00002893 '--------------------',
2894 ] + self._description_lines)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002895 bug_regexp = re.compile(self.BUG_LINE)
2896 fixed_regexp = re.compile(self.FIXED_LINE)
Jonas Termansend0f79112019-03-22 15:28:26 +00002897 prefix = settings.GetBugPrefix()
Sigurd Schneider8630bb12020-11-11 14:02:49 +00002898 has_issue = lambda l: bug_regexp.match(l) or fixed_regexp.match(l)
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00002899
Dan Beamd8b04ca2019-10-10 21:23:26 +00002900 if not any((has_issue(line) for line in self._description_lines)):
Anthony Polito8b955342019-09-24 19:01:36 +00002901 self.append_footer('Bug: %s' % prefix)
tandriif9aefb72016-07-01 09:06:51 -07002902
Bruce Dawsonfc487042020-10-27 19:11:37 +00002903 print('Waiting for editor...')
agable@chromium.org42c20792013-09-12 17:34:49 +00002904 content = gclient_utils.RunEditor(self.description, True,
Edward Lemur79d4f992019-11-11 23:49:02 +00002905 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002906 if not content:
2907 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00002908 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002909
Bruce Dawson2377b012018-01-11 16:46:49 -08002910 # Strip off comments and default inserted "Bug:" line.
2911 clean_lines = [line.rstrip() for line in lines if not
Jonas Termansend0f79112019-03-22 15:28:26 +00002912 (line.startswith('#') or
2913 line.rstrip() == "Bug:" or
2914 line.rstrip() == "Bug: " + prefix)]
agable@chromium.org42c20792013-09-12 17:34:49 +00002915 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002916 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00002917 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002918
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002919 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00002920 """Adds a footer line to the description.
2921
2922 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
2923 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
2924 that Gerrit footers are always at the end.
2925 """
2926 parsed_footer_line = git_footers.parse_footer(line)
2927 if parsed_footer_line:
2928 # Line is a gerrit footer in the form: Footer-Key: any value.
2929 # Thus, must be appended observing Gerrit footer rules.
2930 self.set_description(
2931 git_footers.add_footer(self.description,
2932 key=parsed_footer_line[0],
2933 value=parsed_footer_line[1]))
2934 return
2935
2936 if not self._description_lines:
2937 self._description_lines.append(line)
2938 return
2939
2940 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
2941 if gerrit_footers:
2942 # git_footers.split_footers ensures that there is an empty line before
2943 # actual (gerrit) footers, if any. We have to keep it that way.
2944 assert top_lines and top_lines[-1] == ''
2945 top_lines, separator = top_lines[:-1], top_lines[-1:]
2946 else:
2947 separator = [] # No need for separator if there are no gerrit_footers.
2948
2949 prev_line = top_lines[-1] if top_lines else ''
2950 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
2951 not presubmit_support.Change.TAG_LINE_RE.match(line)):
2952 top_lines.append('')
2953 top_lines.append(line)
2954 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002955
tandrii99a72f22016-08-17 14:33:24 -07002956 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002957 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002958 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07002959 reviewers = [match.group(2).strip()
2960 for match in matches
2961 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002962 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002963
bradnelsond975b302016-10-23 12:20:23 -07002964 def get_cced(self):
2965 """Retrieves the list of reviewers."""
2966 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
2967 cced = [match.group(2).strip() for match in matches if match]
2968 return cleanup_list(cced)
2969
Nodir Turakulov23b82142017-11-16 11:04:25 -08002970 def get_hash_tags(self):
2971 """Extracts and sanitizes a list of Gerrit hashtags."""
2972 subject = (self._description_lines or ('',))[0]
2973 subject = re.sub(
2974 self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE)
2975
2976 tags = []
2977 start = 0
2978 bracket_exp = re.compile(self.BRACKET_HASH_TAG)
2979 while True:
2980 m = bracket_exp.match(subject, start)
2981 if not m:
2982 break
2983 tags.append(self.sanitize_hash_tag(m.group(1)))
2984 start = m.end()
2985
2986 if not tags:
2987 # Try "Tag: " prefix.
2988 m = re.match(self.COLON_SEPARATED_HASH_TAG, subject)
2989 if m:
2990 tags.append(self.sanitize_hash_tag(m.group(1)))
2991 return tags
2992
2993 @classmethod
2994 def sanitize_hash_tag(cls, tag):
2995 """Returns a sanitized Gerrit hash tag.
2996
2997 A sanitized hashtag can be used as a git push refspec parameter value.
2998 """
2999 return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower()
3000
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003001
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003002def FindCodereviewSettingsFile(filename='codereview.settings'):
3003 """Finds the given file starting in the cwd and going up.
3004
3005 Only looks up to the top of the repository unless an
3006 'inherit-review-settings-ok' file exists in the root of the repository.
3007 """
3008 inherit_ok_file = 'inherit-review-settings-ok'
3009 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00003010 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003011 if os.path.isfile(os.path.join(root, inherit_ok_file)):
Aleksey Khoroshilov2a229712022-06-02 16:24:11 +00003012 root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003013 while True:
Aleksey Khoroshilov2a229712022-06-02 16:24:11 +00003014 if os.path.isfile(os.path.join(cwd, filename)):
3015 return open(os.path.join(cwd, filename))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003016 if cwd == root:
3017 break
Aleksey Khoroshilov2a229712022-06-02 16:24:11 +00003018 parent_dir = os.path.dirname(cwd)
3019 if parent_dir == cwd:
3020 # We hit the system root directory.
3021 break
3022 cwd = parent_dir
3023 return None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003024
3025
3026def LoadCodereviewSettingsFromFile(fileobj):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003027 """Parses a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00003028 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003029
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003030 def SetProperty(name, setting, unset_error_ok=False):
3031 fullname = 'rietveld.' + name
3032 if setting in keyvals:
3033 RunGit(['config', fullname, keyvals[setting]])
3034 else:
3035 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
3036
tandrii48df5812016-10-17 03:55:37 -07003037 if not keyvals.get('GERRIT_HOST', False):
3038 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003039 # Only server setting is required. Other settings can be absent.
3040 # In that case, we ignore errors raised during option deletion attempt.
3041 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
3042 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
3043 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00003044 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003045 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
3046 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00003047 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
3048 unset_error_ok=True)
Jamie Madilldc4d19e2019-10-24 21:50:02 +00003049 SetProperty(
3050 'format-full-by-default', 'FORMAT_FULL_BY_DEFAULT', unset_error_ok=True)
Dirk Pranke6f0df682021-06-25 00:42:33 +00003051 SetProperty('use-python3', 'USE_PYTHON3', unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003052
ukai@chromium.org7044efc2013-11-28 01:51:21 +00003053 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00003054 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00003055
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003056 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
Edward Lesmes4de54132020-05-05 19:41:33 +00003057 RunGit(['config', 'gerrit.squash-uploads',
3058 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003059
tandrii@chromium.org28253532016-04-14 13:46:56 +00003060 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00003061 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00003062 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
3063
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003064 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01003065 # should be of the form
3066 # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
3067 # ORIGIN_URL_CONFIG: http://src.chromium.org/git
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003068 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
3069 keyvals['ORIGIN_URL_CONFIG']])
3070
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003071
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003072def urlretrieve(source, destination):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003073 """Downloads a network object to a local file, like urllib.urlretrieve.
3074
3075 This is necessary because urllib is broken for SSL connections via a proxy.
3076 """
Vadim Shtayuraf7b8f8f2021-11-15 19:10:05 +00003077 with open(destination, 'wb') as f:
Edward Lemur79d4f992019-11-11 23:49:02 +00003078 f.write(urllib.request.urlopen(source).read())
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003079
3080
ukai@chromium.org712d6102013-11-27 00:52:58 +00003081def hasSheBang(fname):
3082 """Checks fname is a #! script."""
3083 with open(fname) as f:
3084 return f.read(2).startswith('#!')
3085
3086
tandrii@chromium.org18630d62016-03-04 12:06:02 +00003087def DownloadGerritHook(force):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003088 """Downloads and installs a Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003089
3090 Args:
3091 force: True to update hooks. False to install hooks if not present.
3092 """
ukai@chromium.org712d6102013-11-27 00:52:58 +00003093 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003094 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
3095 if not os.access(dst, os.X_OK):
3096 if os.path.exists(dst):
3097 if not force:
3098 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003099 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003100 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003101 if not hasSheBang(dst):
3102 DieWithError('Not a script: %s\n'
3103 'You need to download from\n%s\n'
3104 'into .git/hooks/commit-msg and '
3105 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003106 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
3107 except Exception:
3108 if os.path.exists(dst):
3109 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003110 DieWithError('\nFailed to download hooks.\n'
3111 'You need to download from\n%s\n'
3112 'into .git/hooks/commit-msg and '
3113 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003114
3115
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003116class _GitCookiesChecker(object):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003117 """Provides facilities for validating and suggesting fixes to .gitcookies."""
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003118
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003119 _GOOGLESOURCE = 'googlesource.com'
3120
3121 def __init__(self):
3122 # Cached list of [host, identity, source], where source is either
3123 # .gitcookies or .netrc.
3124 self._all_hosts = None
3125
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003126 def ensure_configured_gitcookies(self):
3127 """Runs checks and suggests fixes to make git use .gitcookies from default
3128 path."""
3129 default = gerrit_util.CookiesAuthenticator.get_gitcookies_path()
3130 configured_path = RunGitSilent(
3131 ['config', '--global', 'http.cookiefile']).strip()
Andrii Shyshkalov1e250cd2017-05-10 15:39:31 +02003132 configured_path = os.path.expanduser(configured_path)
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003133 if configured_path:
3134 self._ensure_default_gitcookies_path(configured_path, default)
3135 else:
3136 self._configure_gitcookies_path(default)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003137
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003138 @staticmethod
3139 def _ensure_default_gitcookies_path(configured_path, default_path):
3140 assert configured_path
3141 if configured_path == default_path:
3142 print('git is already configured to use your .gitcookies from %s' %
3143 configured_path)
3144 return
3145
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003146 print('WARNING: You have configured custom path to .gitcookies: %s\n'
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003147 'Gerrit and other depot_tools expect .gitcookies at %s\n' %
3148 (configured_path, default_path))
3149
3150 if not os.path.exists(configured_path):
3151 print('However, your configured .gitcookies file is missing.')
3152 confirm_or_exit('Reconfigure git to use default .gitcookies?',
3153 action='reconfigure')
3154 RunGit(['config', '--global', 'http.cookiefile', default_path])
3155 return
3156
3157 if os.path.exists(default_path):
3158 print('WARNING: default .gitcookies file already exists %s' %
3159 default_path)
3160 DieWithError('Please delete %s manually and re-run git cl creds-check' %
3161 default_path)
3162
3163 confirm_or_exit('Move existing .gitcookies to default location?',
3164 action='move')
3165 shutil.move(configured_path, default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003166 RunGit(['config', '--global', 'http.cookiefile', default_path])
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003167 print('Moved and reconfigured git to use .gitcookies from %s' %
3168 default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003169
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003170 @staticmethod
3171 def _configure_gitcookies_path(default_path):
3172 netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path()
3173 if os.path.exists(netrc_path):
3174 print('You seem to be using outdated .netrc for git credentials: %s' %
3175 netrc_path)
3176 print('This tool will guide you through setting up recommended '
3177 '.gitcookies store for git credentials.\n'
3178 '\n'
3179 'IMPORTANT: If something goes wrong and you decide to go back, do:\n'
3180 ' git config --global --unset http.cookiefile\n'
3181 ' mv %s %s.backup\n\n' % (default_path, default_path))
3182 confirm_or_exit(action='setup .gitcookies')
3183 RunGit(['config', '--global', 'http.cookiefile', default_path])
3184 print('Configured git to use .gitcookies from %s' % default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003185
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003186 def get_hosts_with_creds(self, include_netrc=False):
3187 if self._all_hosts is None:
3188 a = gerrit_util.CookiesAuthenticator()
3189 self._all_hosts = [
3190 (h, u, s)
3191 for h, u, s in itertools.chain(
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003192 ((h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.items()),
3193 ((h, u, '.gitcookies') for h, (u, _) in a.gitcookies.items())
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003194 )
3195 if h.endswith(self._GOOGLESOURCE)
3196 ]
3197
3198 if include_netrc:
3199 return self._all_hosts
3200 return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc']
3201
3202 def print_current_creds(self, include_netrc=False):
3203 hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc))
3204 if not hosts:
3205 print('No Git/Gerrit credentials found')
3206 return
Edward Lemur79d4f992019-11-11 23:49:02 +00003207 lengths = [max(map(len, (row[i] for row in hosts))) for i in range(3)]
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003208 header = [('Host', 'User', 'Which file'),
3209 ['=' * l for l in lengths]]
3210 for row in (header + hosts):
3211 print('\t'.join((('%%+%ds' % l) % s)
3212 for l, s in zip(lengths, row)))
3213
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003214 @staticmethod
3215 def _parse_identity(identity):
Lei Zhangd3f769a2017-12-15 15:16:14 -08003216 """Parses identity "git-<username>.domain" into <username> and domain."""
3217 # Special case: usernames that contain ".", which are generally not
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02003218 # distinguishable from sub-domains. But we do know typical domains:
3219 if identity.endswith('.chromium.org'):
3220 domain = 'chromium.org'
3221 username = identity[:-len('.chromium.org')]
3222 else:
3223 username, domain = identity.split('.', 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003224 if username.startswith('git-'):
3225 username = username[len('git-'):]
3226 return username, domain
3227
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003228 def _canonical_git_googlesource_host(self, host):
3229 """Normalizes Gerrit hosts (with '-review') to Git host."""
3230 assert host.endswith(self._GOOGLESOURCE)
3231 # Prefix doesn't include '.' at the end.
3232 prefix = host[:-(1 + len(self._GOOGLESOURCE))]
3233 if prefix.endswith('-review'):
3234 prefix = prefix[:-len('-review')]
3235 return prefix + '.' + self._GOOGLESOURCE
3236
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003237 def _canonical_gerrit_googlesource_host(self, host):
3238 git_host = self._canonical_git_googlesource_host(host)
3239 prefix = git_host.split('.', 1)[0]
3240 return prefix + '-review.' + self._GOOGLESOURCE
3241
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003242 def _get_counterpart_host(self, host):
3243 assert host.endswith(self._GOOGLESOURCE)
3244 git = self._canonical_git_googlesource_host(host)
3245 gerrit = self._canonical_gerrit_googlesource_host(git)
3246 return git if gerrit == host else gerrit
3247
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003248 def has_generic_host(self):
3249 """Returns whether generic .googlesource.com has been configured.
3250
3251 Chrome Infra recommends to use explicit ${host}.googlesource.com instead.
3252 """
3253 for host, _, _ in self.get_hosts_with_creds(include_netrc=False):
3254 if host == '.' + self._GOOGLESOURCE:
3255 return True
3256 return False
3257
3258 def _get_git_gerrit_identity_pairs(self):
3259 """Returns map from canonic host to pair of identities (Git, Gerrit).
3260
3261 One of identities might be None, meaning not configured.
3262 """
3263 host_to_identity_pairs = {}
3264 for host, identity, _ in self.get_hosts_with_creds():
3265 canonical = self._canonical_git_googlesource_host(host)
3266 pair = host_to_identity_pairs.setdefault(canonical, [None, None])
3267 idx = 0 if canonical == host else 1
3268 pair[idx] = identity
3269 return host_to_identity_pairs
3270
3271 def get_partially_configured_hosts(self):
3272 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003273 (host if i1 else self._canonical_gerrit_googlesource_host(host))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003274 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003275 if None in (i1, i2) and host != '.' + self._GOOGLESOURCE)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003276
3277 def get_conflicting_hosts(self):
3278 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003279 host
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003280 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003281 if None not in (i1, i2) and i1 != i2)
3282
3283 def get_duplicated_hosts(self):
3284 counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds())
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003285 return set(host for host, count in counters.items() if count > 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003286
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003287
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003288 @staticmethod
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003289 def _format_hosts(hosts, extra_column_func=None):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003290 hosts = sorted(hosts)
3291 assert hosts
3292 if extra_column_func is None:
3293 extras = [''] * len(hosts)
3294 else:
3295 extras = [extra_column_func(host) for host in hosts]
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003296 tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras)))
3297 lines = []
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003298 for he in zip(hosts, extras):
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003299 lines.append(tmpl % he)
3300 return lines
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003301
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003302 def _find_problems(self):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003303 if self.has_generic_host():
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003304 yield ('.googlesource.com wildcard record detected',
3305 ['Chrome Infrastructure team recommends to list full host names '
3306 'explicitly.'],
3307 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003308
3309 dups = self.get_duplicated_hosts()
3310 if dups:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003311 yield ('The following hosts were defined twice',
3312 self._format_hosts(dups),
3313 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003314
3315 partial = self.get_partially_configured_hosts()
3316 if partial:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003317 yield ('Credentials should come in pairs for Git and Gerrit hosts. '
3318 'These hosts are missing',
3319 self._format_hosts(partial, lambda host: 'but %s defined' %
3320 self._get_counterpart_host(host)),
3321 partial)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003322
3323 conflicting = self.get_conflicting_hosts()
3324 if conflicting:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003325 yield ('The following Git hosts have differing credentials from their '
3326 'Gerrit counterparts',
3327 self._format_hosts(conflicting, lambda host: '%s vs %s' %
3328 tuple(self._get_git_gerrit_identity_pairs()[host])),
3329 conflicting)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003330
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003331 def find_and_report_problems(self):
3332 """Returns True if there was at least one problem, else False."""
3333 found = False
3334 bad_hosts = set()
3335 for title, sublines, hosts in self._find_problems():
3336 if not found:
3337 found = True
3338 print('\n\n.gitcookies problem report:\n')
3339 bad_hosts.update(hosts or [])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003340 print(' %s%s' % (title, (':' if sublines else '')))
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003341 if sublines:
3342 print()
3343 print(' %s' % '\n '.join(sublines))
3344 print()
3345
3346 if bad_hosts:
3347 assert found
3348 print(' You can manually remove corresponding lines in your %s file and '
3349 'visit the following URLs with correct account to generate '
3350 'correct credential lines:\n' %
3351 gerrit_util.CookiesAuthenticator.get_gitcookies_path())
3352 print(' %s' % '\n '.join(sorted(set(
3353 gerrit_util.CookiesAuthenticator().get_new_password_url(
3354 self._canonical_git_googlesource_host(host))
3355 for host in bad_hosts
3356 ))))
3357 return found
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003358
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003359
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003360@metrics.collector.collect_metrics('git cl creds-check')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003361def CMDcreds_check(parser, args):
3362 """Checks credentials and suggests changes."""
3363 _, _ = parser.parse_args(args)
3364
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003365 # Code below checks .gitcookies. Abort if using something else.
3366 authn = gerrit_util.Authenticator.get()
3367 if not isinstance(authn, gerrit_util.CookiesAuthenticator):
Edward Lemur57d47422020-03-06 20:43:07 +00003368 message = (
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003369 'This command is not designed for bot environment. It checks '
3370 '~/.gitcookies file not generally used on bots.')
Edward Lemur57d47422020-03-06 20:43:07 +00003371 # TODO(crbug.com/1059384): Automatically detect when running on cloudtop.
3372 if isinstance(authn, gerrit_util.GceAuthenticator):
3373 message += (
3374 '\n'
3375 'If you need to run this on GCE or a cloudtop instance, '
3376 'export SKIP_GCE_AUTH_FOR_GIT=1 in your env.')
3377 DieWithError(message)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003378
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003379 checker = _GitCookiesChecker()
3380 checker.ensure_configured_gitcookies()
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003381
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003382 print('Your .netrc and .gitcookies have credentials for these hosts:')
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003383 checker.print_current_creds(include_netrc=True)
3384
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003385 if not checker.find_and_report_problems():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003386 print('\nNo problems detected in your .gitcookies file.')
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003387 return 0
3388 return 1
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003389
3390
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003391@metrics.collector.collect_metrics('git cl baseurl')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003392def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003393 """Gets or sets base-url for this branch."""
Thiago Perrotta16d08f02022-07-20 18:18:50 +00003394 _, args = parser.parse_args(args)
Edward Lesmes50da7702020-03-30 19:23:43 +00003395 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
Edward Lemur85153282020-02-14 22:06:29 +00003396 branch = scm.GIT.ShortBranchName(branchref)
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003397 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003398 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003399 return RunGit(['config', 'branch.%s.base-url' % branch],
3400 error_ok=False).strip()
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00003401
3402 print('Setting base-url to %s' % args[0])
3403 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3404 error_ok=False).strip()
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003405
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003406
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003407def color_for_status(status):
3408 """Maps a Changelist status to color, for CMDstatus and other tools."""
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003409 BOLD = '\033[1m'
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003410 return {
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003411 'unsent': BOLD + Fore.YELLOW,
3412 'waiting': BOLD + Fore.RED,
3413 'reply': BOLD + Fore.YELLOW,
3414 'not lgtm': BOLD + Fore.RED,
3415 'lgtm': BOLD + Fore.GREEN,
3416 'commit': BOLD + Fore.MAGENTA,
3417 'closed': BOLD + Fore.CYAN,
3418 'error': BOLD + Fore.WHITE,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003419 }.get(status, Fore.WHITE)
3420
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003421
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003422def get_cl_statuses(changes, fine_grained, max_processes=None):
3423 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003424
3425 If fine_grained is true, this will fetch CL statuses from the server.
3426 Otherwise, simply indicate if there's a matching url for the given branches.
3427
3428 If max_processes is specified, it is used as the maximum number of processes
3429 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3430 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003431
3432 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003433 """
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003434 if not changes:
Edward Lemur61bf4172020-02-24 23:22:37 +00003435 return
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003436
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003437 if not fine_grained:
3438 # Fast path which doesn't involve querying codereview servers.
Aaron Gablea1bab272017-04-11 16:38:18 -07003439 # Do not use get_approving_reviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003440 for cl in changes:
3441 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003442 return
3443
3444 # First, sort out authentication issues.
3445 logging.debug('ensuring credentials exist')
3446 for cl in changes:
3447 cl.EnsureAuthenticated(force=False, refresh=True)
3448
3449 def fetch(cl):
3450 try:
3451 return (cl, cl.GetStatus())
3452 except:
3453 # See http://crbug.com/629863.
Andrii Shyshkalov98824232018-04-19 11:37:15 -07003454 logging.exception('failed to fetch status for cl %s:', cl.GetIssue())
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003455 raise
3456
3457 threads_count = len(changes)
3458 if max_processes:
3459 threads_count = max(1, min(threads_count, max_processes))
3460 logging.debug('querying %d CLs using %d threads', len(changes), threads_count)
3461
Edward Lemur61bf4172020-02-24 23:22:37 +00003462 pool = multiprocessing.pool.ThreadPool(threads_count)
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003463 fetched_cls = set()
3464 try:
3465 it = pool.imap_unordered(fetch, changes).__iter__()
3466 while True:
3467 try:
3468 cl, status = it.next(timeout=5)
Edward Lemur61bf4172020-02-24 23:22:37 +00003469 except (multiprocessing.TimeoutError, StopIteration):
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003470 break
3471 fetched_cls.add(cl)
3472 yield cl, status
3473 finally:
3474 pool.close()
3475
3476 # Add any branches that failed to fetch.
3477 for cl in set(changes) - fetched_cls:
3478 yield (cl, 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003479
rmistry@google.com2dd99862015-06-22 12:22:18 +00003480
Jose Lopes3863fc52020-04-07 17:00:25 +00003481def upload_branch_deps(cl, args, force=False):
rmistry@google.com2dd99862015-06-22 12:22:18 +00003482 """Uploads CLs of local branches that are dependents of the current branch.
3483
3484 If the local branch dependency tree looks like:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003485
3486 test1 -> test2.1 -> test3.1
3487 -> test3.2
3488 -> test2.2 -> test3.3
rmistry@google.com2dd99862015-06-22 12:22:18 +00003489
3490 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3491 run on the dependent branches in this order:
3492 test2.1, test3.1, test3.2, test2.2, test3.3
3493
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003494 Note: This function does not rebase your local dependent branches. Use it
3495 when you make a change to the parent branch that will not conflict
3496 with its dependent branches, and you would like their dependencies
3497 updated in Rietveld.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003498 """
3499 if git_common.is_dirty_git_tree('upload-branch-deps'):
3500 return 1
3501
3502 root_branch = cl.GetBranch()
3503 if root_branch is None:
3504 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3505 'Get on a branch!')
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00003506 if not cl.GetIssue():
rmistry@google.com2dd99862015-06-22 12:22:18 +00003507 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3508 'patchset dependencies without an uploaded CL.')
3509
3510 branches = RunGit(['for-each-ref',
3511 '--format=%(refname:short) %(upstream:short)',
3512 'refs/heads'])
3513 if not branches:
3514 print('No local branches found.')
3515 return 0
3516
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003517 # Create a dictionary of all local branches to the branches that are
3518 # dependent on it.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003519 tracked_to_dependents = collections.defaultdict(list)
3520 for b in branches.splitlines():
3521 tokens = b.split()
3522 if len(tokens) == 2:
3523 branch_name, tracked = tokens
3524 tracked_to_dependents[tracked].append(branch_name)
3525
vapiera7fbd5a2016-06-16 09:17:49 -07003526 print()
3527 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003528 dependents = []
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003529
rmistry@google.com2dd99862015-06-22 12:22:18 +00003530 def traverse_dependents_preorder(branch, padding=''):
3531 dependents_to_process = tracked_to_dependents.get(branch, [])
3532 padding += ' '
3533 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003534 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003535 dependents.append(dependent)
3536 traverse_dependents_preorder(dependent, padding)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003537
rmistry@google.com2dd99862015-06-22 12:22:18 +00003538 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003539 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003540
3541 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003542 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003543 return 0
3544
Jose Lopes3863fc52020-04-07 17:00:25 +00003545 if not force:
3546 confirm_or_exit('This command will checkout all dependent branches and run '
3547 '"git cl upload".', action='continue')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003548
rmistry@google.com2dd99862015-06-22 12:22:18 +00003549 # Record all dependents that failed to upload.
3550 failures = {}
3551 # Go through all dependents, checkout the branch and upload.
3552 try:
3553 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003554 print()
3555 print('--------------------------------------')
3556 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003557 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003558 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003559 try:
3560 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003561 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003562 failures[dependent_branch] = 1
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003563 except: # pylint: disable=bare-except
rmistry@google.com2dd99862015-06-22 12:22:18 +00003564 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003565 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003566 finally:
3567 # Swap back to the original root branch.
3568 RunGit(['checkout', '-q', root_branch])
3569
vapiera7fbd5a2016-06-16 09:17:49 -07003570 print()
3571 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003572 for dependent_branch in dependents:
3573 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003574 print(' %s : %s' % (dependent_branch, upload_status))
3575 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003576
3577 return 0
3578
3579
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003580def GetArchiveTagForBranch(issue_num, branch_name, existing_tags, pattern):
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003581 """Given a proposed tag name, returns a tag name that is guaranteed to be
3582 unique. If 'foo' is proposed but already exists, then 'foo-2' is used,
3583 or 'foo-3', and so on."""
3584
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003585 proposed_tag = pattern.format(**{'issue': issue_num, 'branch': branch_name})
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003586 for suffix_num in itertools.count(1):
3587 if suffix_num == 1:
3588 to_check = proposed_tag
3589 else:
3590 to_check = '%s-%d' % (proposed_tag, suffix_num)
3591
3592 if to_check not in existing_tags:
3593 return to_check
3594
3595
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003596@metrics.collector.collect_metrics('git cl archive')
kmarshall3bff56b2016-06-06 18:31:47 -07003597def CMDarchive(parser, args):
3598 """Archives and deletes branches associated with closed changelists."""
3599 parser.add_option(
3600 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003601 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003602 parser.add_option(
3603 '-f', '--force', action='store_true',
3604 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003605 parser.add_option(
3606 '-d', '--dry-run', action='store_true',
3607 help='Skip the branch tagging and removal steps.')
3608 parser.add_option(
3609 '-t', '--notags', action='store_true',
3610 help='Do not tag archived branches. '
3611 'Note: local commit history may be lost.')
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003612 parser.add_option(
3613 '-p',
3614 '--pattern',
3615 default='git-cl-archived-{issue}-{branch}',
3616 help='Format string for archive tags. '
3617 'E.g. \'archived-{issue}-{branch}\'.')
kmarshall3bff56b2016-06-06 18:31:47 -07003618
kmarshall3bff56b2016-06-06 18:31:47 -07003619 options, args = parser.parse_args(args)
3620 if args:
3621 parser.error('Unsupported args: %s' % ' '.join(args))
kmarshall3bff56b2016-06-06 18:31:47 -07003622
3623 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3624 if not branches:
3625 return 0
3626
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003627 tags = RunGit(['for-each-ref', '--format=%(refname)',
3628 'refs/tags']).splitlines() or []
3629 tags = [t.split('/')[-1] for t in tags]
3630
vapiera7fbd5a2016-06-16 09:17:49 -07003631 print('Finding all branches associated with closed issues...')
Edward Lemur934836a2019-09-09 20:16:54 +00003632 changes = [Changelist(branchref=b)
3633 for b in branches.splitlines()]
kmarshall3bff56b2016-06-06 18:31:47 -07003634 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3635 statuses = get_cl_statuses(changes,
3636 fine_grained=True,
3637 max_processes=options.maxjobs)
3638 proposal = [(cl.GetBranch(),
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003639 GetArchiveTagForBranch(cl.GetIssue(), cl.GetBranch(), tags,
3640 options.pattern))
kmarshall3bff56b2016-06-06 18:31:47 -07003641 for cl, status in statuses
Andrii Shyshkalov51bdf8c2018-10-18 01:07:58 +00003642 if status in ('closed', 'rietveld-not-supported')]
kmarshall3bff56b2016-06-06 18:31:47 -07003643 proposal.sort()
3644
3645 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003646 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003647 return 0
3648
Edward Lemur85153282020-02-14 22:06:29 +00003649 current_branch = scm.GIT.GetBranch(settings.GetRoot())
kmarshall3bff56b2016-06-06 18:31:47 -07003650
vapiera7fbd5a2016-06-16 09:17:49 -07003651 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003652 if options.notags:
3653 for next_item in proposal:
3654 print(' ' + next_item[0])
3655 else:
3656 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3657 for next_item in proposal:
3658 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003659
kmarshall9249e012016-08-23 12:02:16 -07003660 # Quit now on precondition failure or if instructed by the user, either
3661 # via an interactive prompt or by command line flags.
3662 if options.dry_run:
3663 print('\nNo changes were made (dry run).\n')
3664 return 0
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00003665
3666 if any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003667 print('You are currently on a branch \'%s\' which is associated with a '
3668 'closed codereview issue, so archive cannot proceed. Please '
3669 'checkout another branch and run this command again.' %
3670 current_branch)
3671 return 1
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00003672
3673 if not options.force:
Edward Lesmesae3586b2020-03-23 21:21:14 +00003674 answer = gclient_utils.AskForData('\nProceed with deletion (Y/n)? ').lower()
sergiyb4a5ecbe2016-06-20 09:46:00 -07003675 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003676 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003677 return 1
3678
3679 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003680 if not options.notags:
3681 RunGit(['tag', tagname, branch])
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003682
3683 if RunGitWithCode(['branch', '-D', branch])[0] != 0:
3684 # Clean up the tag if we failed to delete the branch.
3685 RunGit(['tag', '-d', tagname])
kmarshall9249e012016-08-23 12:02:16 -07003686
vapiera7fbd5a2016-06-16 09:17:49 -07003687 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003688
3689 return 0
3690
3691
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003692@metrics.collector.collect_metrics('git cl status')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003693def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003694 """Show status of changelists.
3695
3696 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003697 - Blue waiting for review
Aaron Gable9ab38c62017-04-06 14:36:33 -07003698 - Yellow waiting for you to reply to review, or not yet sent
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003699 - Green LGTM'ed
Aaron Gable9ab38c62017-04-06 14:36:33 -07003700 - Red 'not LGTM'ed
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00003701 - Magenta in the CQ
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003702 - Cyan was committed, branch can be deleted
Aaron Gable9ab38c62017-04-06 14:36:33 -07003703 - White error, or unknown status
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003704
3705 Also see 'git cl comments'.
3706 """
Alan Cuttera3be9a52019-03-04 18:50:33 +00003707 parser.add_option(
3708 '--no-branch-color',
3709 action='store_true',
3710 help='Disable colorized branch names')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003711 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003712 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003713 parser.add_option('-f', '--fast', action='store_true',
3714 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003715 parser.add_option(
3716 '-j', '--maxjobs', action='store', type=int,
3717 help='The maximum number of jobs to use when retrieving review status')
Edward Lemur52969c92020-02-06 18:15:28 +00003718 parser.add_option(
3719 '-i', '--issue', type=int,
3720 help='Operate on this issue instead of the current branch\'s implicit '
3721 'issue. Requires --field to be set.')
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003722 parser.add_option('-d',
3723 '--date-order',
3724 action='store_true',
3725 help='Order branches by committer date.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003726 options, args = parser.parse_args(args)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003727 if args:
3728 parser.error('Unsupported args: %s' % args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003729
iannuccie53c9352016-08-17 14:40:40 -07003730 if options.issue is not None and not options.field:
Edward Lemur6c6827c2020-02-06 21:15:18 +00003731 parser.error('--field must be given when --issue is set.')
iannucci3c972b92016-08-17 13:24:10 -07003732
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003733 if options.field:
Edward Lemur934836a2019-09-09 20:16:54 +00003734 cl = Changelist(issue=options.issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003735 if options.field.startswith('desc'):
Edward Lemur6c6827c2020-02-06 21:15:18 +00003736 if cl.GetIssue():
3737 print(cl.FetchDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003738 elif options.field == 'id':
3739 issueid = cl.GetIssue()
3740 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07003741 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003742 elif options.field == 'patch':
Aaron Gablee8856ee2017-12-07 12:41:46 -08003743 patchset = cl.GetMostRecentPatchset()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003744 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07003745 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07003746 elif options.field == 'status':
3747 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003748 elif options.field == 'url':
3749 url = cl.GetIssueURL()
3750 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07003751 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003752 return 0
3753
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003754 branches = RunGit([
3755 'for-each-ref', '--format=%(refname) %(committerdate:unix)', 'refs/heads'
3756 ])
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003757 if not branches:
3758 print('No local branch found.')
3759 return 0
3760
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003761 changes = [
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003762 Changelist(branchref=b, commit_date=ct)
3763 for b, ct in map(lambda line: line.split(' '), branches.splitlines())
3764 ]
vapiera7fbd5a2016-06-16 09:17:49 -07003765 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003766 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003767 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003768 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003769
Edward Lemur85153282020-02-14 22:06:29 +00003770 current_branch = scm.GIT.GetBranch(settings.GetRoot())
Daniel McArdlea23bf592019-02-12 00:25:12 +00003771
3772 def FormatBranchName(branch, colorize=False):
3773 """Simulates 'git branch' behavior. Colorizes and prefixes branch name with
3774 an asterisk when it is the current branch."""
3775
3776 asterisk = ""
3777 color = Fore.RESET
3778 if branch == current_branch:
3779 asterisk = "* "
3780 color = Fore.GREEN
Edward Lemur85153282020-02-14 22:06:29 +00003781 branch_name = scm.GIT.ShortBranchName(branch)
Daniel McArdlea23bf592019-02-12 00:25:12 +00003782
3783 if colorize:
3784 return asterisk + color + branch_name + Fore.RESET
Daniel McArdle452a49f2019-02-14 17:28:31 +00003785 return asterisk + branch_name
3786
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003787 branch_statuses = {}
Daniel McArdlea23bf592019-02-12 00:25:12 +00003788
3789 alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes))
Sigurd Schneider1bfda8e2021-06-30 14:46:25 +00003790
3791 if options.date_order or settings.IsStatusCommitOrderByDate():
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003792 sorted_changes = sorted(changes,
3793 key=lambda c: c.GetCommitDate(),
3794 reverse=True)
3795 else:
3796 sorted_changes = sorted(changes, key=lambda c: c.GetBranch())
3797 for cl in sorted_changes:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003798 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003799 while branch not in branch_statuses:
Edward Lemur79d4f992019-11-11 23:49:02 +00003800 c, status = next(output)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003801 branch_statuses[c.GetBranch()] = status
3802 status = branch_statuses.pop(branch)
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00003803 url = cl.GetIssueURL(short=True)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003804 if url and (not status or status == 'error'):
3805 # The issue probably doesn't exist anymore.
3806 url += ' (broken)'
3807
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003808 color = color_for_status(status)
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003809 # Turn off bold as well as colors.
3810 END = '\033[0m'
3811 reset = Fore.RESET + END
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00003812 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00003813 color = ''
3814 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003815 status_str = '(%s)' % status if status else ''
Daniel McArdle452a49f2019-02-14 17:28:31 +00003816
Alan Cuttera3be9a52019-03-04 18:50:33 +00003817 branch_display = FormatBranchName(branch)
3818 padding = ' ' * (alignment - len(branch_display))
3819 if not options.no_branch_color:
3820 branch_display = FormatBranchName(branch, colorize=True)
Daniel McArdle452a49f2019-02-14 17:28:31 +00003821
Alan Cuttera3be9a52019-03-04 18:50:33 +00003822 print(' %s : %s%s %s%s' % (padding + branch_display, color, url,
3823 status_str, reset))
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003824
vapiera7fbd5a2016-06-16 09:17:49 -07003825 print()
Daniel McArdlea23bf592019-02-12 00:25:12 +00003826 print('Current branch: %s' % current_branch)
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003827 for cl in changes:
Daniel McArdlea23bf592019-02-12 00:25:12 +00003828 if cl.GetBranch() == current_branch:
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003829 break
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003830 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07003831 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003832 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07003833 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00003834 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07003835 print('Issue description:')
Edward Lemur6c6827c2020-02-06 21:15:18 +00003836 print(cl.FetchDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003837 return 0
3838
3839
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003840def colorize_CMDstatus_doc():
3841 """To be called once in main() to add colors to git cl status help."""
3842 colors = [i for i in dir(Fore) if i[0].isupper()]
3843
3844 def colorize_line(line):
3845 for color in colors:
3846 if color in line.upper():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003847 # Extract whitespace first and the leading '-'.
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003848 indent = len(line) - len(line.lstrip(' ')) + 1
3849 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
3850 return line
3851
3852 lines = CMDstatus.__doc__.splitlines()
3853 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
3854
3855
phajdan.jre328cf92016-08-22 04:12:17 -07003856def write_json(path, contents):
Stefan Zager1306bd02017-06-22 19:26:46 -07003857 if path == '-':
3858 json.dump(contents, sys.stdout)
3859 else:
3860 with open(path, 'w') as f:
3861 json.dump(contents, f)
phajdan.jre328cf92016-08-22 04:12:17 -07003862
3863
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003864@subcommand.usage('[issue_number]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003865@metrics.collector.collect_metrics('git cl issue')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003866def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003867 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003868
3869 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003870 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00003871 parser.add_option('-r', '--reverse', action='store_true',
3872 help='Lookup the branch(es) for the specified issues. If '
3873 'no issues are specified, all branches with mapped '
3874 'issues will be listed.')
Stefan Zager1306bd02017-06-22 19:26:46 -07003875 parser.add_option('--json',
3876 help='Path to JSON output file, or "-" for stdout.')
dnj@chromium.org406c4402015-03-03 17:22:28 +00003877 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003878
dnj@chromium.org406c4402015-03-03 17:22:28 +00003879 if options.reverse:
3880 branches = RunGit(['for-each-ref', 'refs/heads',
Aaron Gablead64abd2017-12-04 09:49:13 -08003881 '--format=%(refname)']).splitlines()
dnj@chromium.org406c4402015-03-03 17:22:28 +00003882 # Reverse issue lookup.
3883 issue_branch_map = {}
Daniel Bratellb56a43a2018-09-06 15:49:03 +00003884
3885 git_config = {}
3886 for config in RunGit(['config', '--get-regexp',
3887 r'branch\..*issue']).splitlines():
3888 name, _space, val = config.partition(' ')
3889 git_config[name] = val
3890
dnj@chromium.org406c4402015-03-03 17:22:28 +00003891 for branch in branches:
Edward Lesmes50da7702020-03-30 19:23:43 +00003892 issue = git_config.get(
3893 'branch.%s.%s' % (scm.GIT.ShortBranchName(branch), ISSUE_CONFIG_KEY))
Edward Lemur52969c92020-02-06 18:15:28 +00003894 if issue:
3895 issue_branch_map.setdefault(int(issue), []).append(branch)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003896 if not args:
Carlos Caballero81923d62020-07-06 18:22:27 +00003897 args = sorted(issue_branch_map.keys())
phajdan.jre328cf92016-08-22 04:12:17 -07003898 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00003899 for issue in args:
Lei Zhang5a368d42019-03-25 23:18:19 +00003900 try:
3901 issue_num = int(issue)
3902 except ValueError:
3903 print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003904 continue
Lei Zhang5a368d42019-03-25 23:18:19 +00003905 result[issue_num] = issue_branch_map.get(issue_num)
vapiera7fbd5a2016-06-16 09:17:49 -07003906 print('Branch for issue number %s: %s' % (
Lei Zhang5a368d42019-03-25 23:18:19 +00003907 issue, ', '.join(issue_branch_map.get(issue_num) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07003908 if options.json:
3909 write_json(options.json, result)
Aaron Gable78753da2017-06-15 10:35:49 -07003910 return 0
3911
3912 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003913 issue = ParseIssueNumberArgument(args[0])
Aaron Gable78753da2017-06-15 10:35:49 -07003914 if not issue.valid:
3915 DieWithError('Pass a url or number to set the issue, 0 to unset it, '
3916 'or no argument to list it.\n'
3917 'Maybe you want to run git cl status?')
Edward Lemurf38bc172019-09-03 21:02:13 +00003918 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003919 cl.SetIssue(issue.issue)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003920 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003921 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003922 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
3923 if options.json:
3924 write_json(options.json, {
Nodir Turakulov27379632021-03-17 18:53:29 +00003925 'gerrit_host': cl.GetGerritHost(),
3926 'gerrit_project': cl.GetGerritProject(),
Aaron Gable78753da2017-06-15 10:35:49 -07003927 'issue_url': cl.GetIssueURL(),
Nodir Turakulov27379632021-03-17 18:53:29 +00003928 'issue': cl.GetIssue(),
Aaron Gable78753da2017-06-15 10:35:49 -07003929 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003930 return 0
3931
3932
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003933@metrics.collector.collect_metrics('git cl comments')
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003934def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003935 """Shows or posts review comments for any changelist."""
3936 parser.add_option('-a', '--add-comment', dest='comment',
3937 help='comment to add to an issue')
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003938 parser.add_option('-p', '--publish', action='store_true',
3939 help='marks CL as ready and sends comment to reviewers')
Andrii Shyshkalov0d6b46e2017-03-17 22:23:22 +01003940 parser.add_option('-i', '--issue', dest='issue',
Edward Lemurf38bc172019-09-03 21:02:13 +00003941 help='review issue id (defaults to current issue).')
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003942 parser.add_option('-m', '--machine-readable', dest='readable',
3943 action='store_false', default=True,
3944 help='output comments in a format compatible with '
3945 'editor parsing')
smut@google.comc85ac942015-09-15 16:34:43 +00003946 parser.add_option('-j', '--json-file',
Stefan Zager1306bd02017-06-22 19:26:46 -07003947 help='File to write JSON summary to, or "-" for stdout')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003948 options, args = parser.parse_args(args)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003949
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003950 issue = None
3951 if options.issue:
3952 try:
3953 issue = int(options.issue)
3954 except ValueError:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003955 DieWithError('A review issue ID is expected to be a number.')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003956
Edward Lemur934836a2019-09-09 20:16:54 +00003957 cl = Changelist(issue=issue)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003958
3959 if options.comment:
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003960 cl.AddComment(options.comment, options.publish)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003961 return 0
3962
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003963 summary = sorted(cl.GetCommentsSummary(readable=options.readable),
3964 key=lambda c: c.date)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003965 for comment in summary:
3966 if comment.disapproval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003967 color = Fore.RED
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003968 elif comment.approval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003969 color = Fore.GREEN
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003970 elif comment.sender == cl.GetIssueOwner():
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003971 color = Fore.MAGENTA
Quinten Yearsley0e617c02019-02-20 00:37:03 +00003972 elif comment.autogenerated:
3973 color = Fore.CYAN
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003974 else:
3975 color = Fore.BLUE
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003976 print('\n%s%s %s%s\n%s' % (
3977 color,
3978 comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'),
3979 comment.sender,
3980 Fore.RESET,
3981 '\n'.join(' ' + l for l in comment.message.strip().splitlines())))
3982
smut@google.comc85ac942015-09-15 16:34:43 +00003983 if options.json_file:
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003984 def pre_serialize(c):
Edward Lemur79d4f992019-11-11 23:49:02 +00003985 dct = c._asdict().copy()
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003986 dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f')
3987 return dct
Edward Lemur79d4f992019-11-11 23:49:02 +00003988 write_json(options.json_file, [pre_serialize(x) for x in summary])
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003989 return 0
3990
3991
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003992@subcommand.usage('[codereview url or issue id]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003993@metrics.collector.collect_metrics('git cl description')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003994def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003995 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00003996 parser.add_option('-d', '--display', action='store_true',
3997 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003998 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07003999 help='New description to set for this issue (- for stdin, '
4000 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07004001 parser.add_option('-f', '--force', action='store_true',
4002 help='Delete any unpublished Gerrit edits for this issue '
4003 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004004
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004005 options, args = parser.parse_args(args)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004006
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004007 target_issue_arg = None
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004008 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00004009 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004010 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004011 parser.error('Invalid issue ID or URL.')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004012
Edward Lemur934836a2019-09-09 20:16:54 +00004013 kwargs = {}
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004014 if target_issue_arg:
4015 kwargs['issue'] = target_issue_arg.issue
4016 kwargs['codereview_host'] = target_issue_arg.hostname
martiniss6eda05f2016-06-30 10:18:35 -07004017
4018 cl = Changelist(**kwargs)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004019 if not cl.GetIssue():
4020 DieWithError('This branch has no associated changelist.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004021
Edward Lemur678a6842019-10-03 22:25:05 +00004022 if args and not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004023 logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004024
Edward Lemur6c6827c2020-02-06 21:15:18 +00004025 description = ChangeDescription(cl.FetchDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004026
smut@google.com34fb6b12015-07-13 20:03:26 +00004027 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07004028 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00004029 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004030
4031 if options.new_description:
4032 text = options.new_description
4033 if text == '-':
4034 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07004035 elif text == '+':
4036 base_branch = cl.GetCommonAncestorWithUpstream()
Edward Lemura12175c2020-03-09 16:58:26 +00004037 text = _create_description_from_log([base_branch])
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004038
4039 description.set_description(text)
4040 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00004041 description.prompt()
Edward Lemur6c6827c2020-02-06 21:15:18 +00004042 if cl.FetchDescription().strip() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07004043 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004044 return 0
4045
4046
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004047@metrics.collector.collect_metrics('git cl lint')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004048def CMDlint(parser, args):
4049 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004050 parser.add_option('--filter', action='append', metavar='-x,+y',
4051 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004052 options, args = parser.parse_args(args)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004053
4054 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08004055 # pylint: disable=protected-access
thestig@chromium.org44202a22014-03-11 19:22:18 +00004056 try:
4057 import cpplint
4058 import cpplint_chromium
4059 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07004060 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004061 return 1
4062
4063 # Change the current working directory before calling lint so that it
4064 # shows the correct base.
4065 previous_cwd = os.getcwd()
4066 os.chdir(settings.GetRoot())
4067 try:
Edward Lemur934836a2019-09-09 20:16:54 +00004068 cl = Changelist()
Edward Lemur2c62b332020-03-12 22:12:33 +00004069 files = cl.GetAffectedFiles(cl.GetCommonAncestorWithUpstream())
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004070 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07004071 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004072 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00004073
Lei Zhangb8c62cf2020-07-15 20:09:37 +00004074 # Process cpplint arguments, if any.
4075 filters = presubmit_canned_checks.GetCppLintFilters(options.filter)
4076 command = ['--filter=' + ','.join(filters)] + args + files
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004077 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004078
Lei Zhang379d1ad2020-07-15 19:40:06 +00004079 include_regex = re.compile(settings.GetLintRegex())
4080 ignore_regex = re.compile(settings.GetLintIgnoreRegex())
thestig@chromium.org44202a22014-03-11 19:22:18 +00004081 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
4082 for filename in filenames:
Lei Zhang379d1ad2020-07-15 19:40:06 +00004083 if not include_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07004084 print('Skipping file %s' % filename)
Lei Zhang379d1ad2020-07-15 19:40:06 +00004085 continue
4086
4087 if ignore_regex.match(filename):
4088 print('Ignoring file %s' % filename)
4089 continue
4090
4091 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
4092 extra_check_functions)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004093 finally:
4094 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07004095 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004096 if cpplint._cpplint_state.error_count != 0:
4097 return 1
4098 return 0
4099
4100
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004101@metrics.collector.collect_metrics('git cl presubmit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004102def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004103 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004104 parser.add_option('-u', '--upload', action='store_true',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004105 help='Run upload hook instead of the push hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004106 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00004107 help='Run checks even if tree is dirty')
Aaron Gable8076c282017-11-29 14:39:41 -08004108 parser.add_option('--all', action='store_true',
4109 help='Run checks against all files, not just modified ones')
Josip Sokcevic017544d2022-03-31 23:47:53 +00004110 parser.add_option('--files',
4111 nargs=1,
4112 help='Semicolon-separated list of files to be marked as '
4113 'modified when executing presubmit or post-upload hooks. '
4114 'fnmatch wildcards can also be used.')
Edward Lesmes8e282792018-04-03 18:50:29 -04004115 parser.add_option('--parallel', action='store_true',
4116 help='Run all tests specified by input_api.RunTests in all '
4117 'PRESUBMIT files in parallel.')
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004118 parser.add_option('--resultdb', action='store_true',
4119 help='Run presubmit checks in the ResultSink environment '
4120 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004121 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004122 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004123
sbc@chromium.org71437c02015-04-09 19:29:40 +00004124 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07004125 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004126 return 1
4127
Edward Lemur934836a2019-09-09 20:16:54 +00004128 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004129 if args:
4130 base_branch = args[0]
4131 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004132 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004133 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004134
Bruce Dawsoneb8426e2022-08-05 23:58:15 +00004135 start = time.time()
4136 try:
4137 if not 'PRESUBMIT_SKIP_NETWORK' in os.environ and cl.GetIssue():
4138 description = cl.FetchDescription()
4139 else:
4140 description = _create_description_from_log([base_branch])
4141 except Exception as e:
4142 print('Failed to fetch CL description - %s' % str(e))
Edward Lemura12175c2020-03-09 16:58:26 +00004143 description = _create_description_from_log([base_branch])
Bruce Dawsoneb8426e2022-08-05 23:58:15 +00004144 elapsed = time.time() - start
4145 if elapsed > 5:
4146 print('%.1f s to get CL description.' % elapsed)
Aaron Gable8076c282017-11-29 14:39:41 -08004147
Bruce Dawson13acea32022-05-03 22:13:08 +00004148 if not base_branch:
4149 if not options.force:
4150 print('use --force to check even when not on a branch.')
4151 return 1
4152 base_branch = 'HEAD'
4153
Josip Sokcevic017544d2022-03-31 23:47:53 +00004154 cl.RunHook(committing=not options.upload,
4155 may_prompt=False,
4156 verbose=options.verbose,
4157 parallel=options.parallel,
4158 upstream=base_branch,
4159 description=description,
4160 all_files=options.all,
4161 files=options.files,
4162 resultdb=options.resultdb,
4163 realm=options.realm)
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00004164 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004165
4166
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004167def GenerateGerritChangeId(message):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004168 """Returns the Change ID footer value (Ixxxxxx...xxx).
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004169
4170 Works the same way as
4171 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
4172 but can be called on demand on all platforms.
4173
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004174 The basic idea is to generate git hash of a state of the tree, original
4175 commit message, author/committer info and timestamps.
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004176 """
4177 lines = []
4178 tree_hash = RunGitSilent(['write-tree'])
4179 lines.append('tree %s' % tree_hash.strip())
4180 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
4181 if code == 0:
4182 lines.append('parent %s' % parent.strip())
4183 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
4184 lines.append('author %s' % author.strip())
4185 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
4186 lines.append('committer %s' % committer.strip())
4187 lines.append('')
4188 # Note: Gerrit's commit-hook actually cleans message of some lines and
4189 # whitespace. This code is not doing this, but it clearly won't decrease
4190 # entropy.
4191 lines.append(message)
4192 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
Raul Tambreb946b232019-03-26 14:48:46 +00004193 stdin=('\n'.join(lines)).encode())
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004194 return 'I%s' % change_hash.strip()
4195
4196
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01004197def GetTargetRef(remote, remote_branch, target_branch):
wittman@chromium.org455dc922015-01-26 20:15:50 +00004198 """Computes the remote branch ref to use for the CL.
4199
4200 Args:
4201 remote (str): The git remote for the CL.
4202 remote_branch (str): The git remote branch for the CL.
4203 target_branch (str): The target branch specified by the user.
wittman@chromium.org455dc922015-01-26 20:15:50 +00004204 """
4205 if not (remote and remote_branch):
4206 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004207
wittman@chromium.org455dc922015-01-26 20:15:50 +00004208 if target_branch:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004209 # Canonicalize branch references to the equivalent local full symbolic
wittman@chromium.org455dc922015-01-26 20:15:50 +00004210 # refs, which are then translated into the remote full symbolic refs
4211 # below.
4212 if '/' not in target_branch:
4213 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4214 else:
4215 prefix_replacements = (
4216 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4217 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4218 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4219 )
4220 match = None
4221 for regex, replacement in prefix_replacements:
4222 match = re.search(regex, target_branch)
4223 if match:
4224 remote_branch = target_branch.replace(match.group(0), replacement)
4225 break
4226 if not match:
4227 # This is a branch path but not one we recognize; use as-is.
4228 remote_branch = target_branch
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00004229 # pylint: disable=consider-using-get
rmistry@google.comc68112d2015-03-03 12:48:06 +00004230 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00004231 # pylint: enable=consider-using-get
rmistry@google.comc68112d2015-03-03 12:48:06 +00004232 # Handle the refs that need to land in different refs.
4233 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004234
wittman@chromium.org455dc922015-01-26 20:15:50 +00004235 # Create the true path to the remote branch.
4236 # Does the following translation:
4237 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004238 # * refs/remotes/origin/main -> refs/heads/main
wittman@chromium.org455dc922015-01-26 20:15:50 +00004239 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4240 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4241 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4242 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4243 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4244 'refs/heads/')
4245 elif remote_branch.startswith('refs/remotes/branch-heads'):
4246 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +01004247
wittman@chromium.org455dc922015-01-26 20:15:50 +00004248 return remote_branch
4249
4250
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004251def cleanup_list(l):
4252 """Fixes a list so that comma separated items are put as individual items.
4253
4254 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4255 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4256 """
4257 items = sum((i.split(',') for i in l), [])
4258 stripped_items = (i.strip() for i in items)
4259 return sorted(filter(None, stripped_items))
4260
4261
Aaron Gable4db38df2017-11-03 14:59:07 -07004262@subcommand.usage('[flags]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004263@metrics.collector.collect_metrics('git cl upload')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004264def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004265 """Uploads the current changelist to codereview.
4266
4267 Can skip dependency patchset uploads for a branch by running:
4268 git config branch.branch_name.skip-deps-uploads True
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004269 To unset, run:
rmistry@google.com78948ed2015-07-08 23:09:57 +00004270 git config --unset branch.branch_name.skip-deps-uploads
4271 Can also set the above globally by using the --global flag.
Dominic Battre7d1c4842017-10-27 09:17:28 +02004272
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004273 If the name of the checked out branch starts with "bug-" or "fix-" followed
4274 by a bug number, this bug number is automatically populated in the CL
Dominic Battre7d1c4842017-10-27 09:17:28 +02004275 description.
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004276
4277 If subject contains text in square brackets or has "<text>: " prefix, such
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004278 text(s) is treated as Gerrit hashtags. For example, CLs with subjects:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004279 [git-cl] add support for hashtags
4280 Foo bar: implement foo
4281 will be hashtagged with "git-cl" and "foo-bar" respectively.
rmistry@google.com78948ed2015-07-08 23:09:57 +00004282 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004283 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4284 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004285 parser.add_option('--bypass-watchlists', action='store_true',
4286 dest='bypass_watchlists',
4287 help='bypass watchlists auto CC-ing reviewers')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004288 parser.add_option('-f', '--force', action='store_true', dest='force',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004289 help="force yes to questions (don't prompt)")
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004290 parser.add_option('--message', '-m', dest='message',
4291 help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004292 parser.add_option('-b', '--bug',
4293 help='pre-populate the bug number(s) for this issue. '
4294 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004295 parser.add_option('--message-file', dest='message_file',
4296 help='file which contains message for patchset')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004297 parser.add_option('--title', '-t', dest='title',
4298 help='title for patchset')
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004299 parser.add_option('-T', '--skip-title', action='store_true',
4300 dest='skip_title',
4301 help='Use the most recent commit message as the title of '
4302 'the patchset')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004303 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004304 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004305 help='reviewer email addresses')
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004306 parser.add_option('--tbrs',
4307 action='append', default=[],
4308 help='TBR email addresses')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004309 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004310 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004311 help='cc email addresses')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004312 parser.add_option('--hashtag', dest='hashtags',
4313 action='append', default=[],
4314 help=('Gerrit hashtag for new CL; '
4315 'can be applied multiple times'))
Thiago Perrottab0fb8d52022-08-30 21:26:19 +00004316 parser.add_option('-s',
4317 '--send-mail',
4318 '--send-email',
4319 dest='send_mail',
4320 action='store_true',
Aaron Gable59f48512017-01-12 10:54:46 -08004321 help='send email to reviewer(s) and cc(s) immediately')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004322 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004323 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004324 metavar='TARGET',
4325 help='Apply CL to remote ref TARGET. ' +
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004326 'Default: remote branch head, or main')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004327 parser.add_option('--squash', action='store_true',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004328 help='Squash multiple commits into one')
Mike Frysingera989d552019-08-14 20:51:23 +00004329 parser.add_option('--no-squash', action='store_false', dest='squash',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004330 help='Don\'t squash multiple commits into one')
rmistry9eadede2016-09-19 11:22:43 -07004331 parser.add_option('--topic', default=None,
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004332 help='Topic to specify when uploading')
Robert Iannuccif2708bd2017-04-17 15:49:02 -07004333 parser.add_option('--tbr-owners', dest='add_owners_to', action='store_const',
4334 const='TBR', help='add a set of OWNERS to TBR')
4335 parser.add_option('--r-owners', dest='add_owners_to', action='store_const',
4336 const='R', help='add a set of OWNERS to R')
Thiago Perrottab0fb8d52022-08-30 21:26:19 +00004337 parser.add_option('-c',
4338 '--use-commit-queue',
4339 action='store_true',
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004340 default=False,
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004341 help='tell the CQ to commit this patchset; '
Thiago Perrottab0fb8d52022-08-30 21:26:19 +00004342 'implies --send-mail')
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004343 parser.add_option('-d', '--cq-dry-run',
4344 action='store_true', default=False,
rmistry@google.comef966222015-04-07 11:15:01 +00004345 help='Send the patchset to do a CQ dry run right after '
4346 'upload.')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004347 parser.add_option(
4348 '-q',
4349 '--cq-quick-run',
4350 action='store_true',
4351 default=False,
4352 help='Send the patchset to do a CQ quick run right after '
4353 'upload (https://source.chromium.org/chromium/chromium/src/+/main:do'
4354 'cs/cq_quick_run.md) (chromium only).')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00004355 parser.add_option('--set-bot-commit', action='store_true',
4356 help=optparse.SUPPRESS_HELP)
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00004357 parser.add_option('--preserve-tryjobs', action='store_true',
4358 help='instruct the CQ to let tryjobs running even after '
4359 'new patchsets are uploaded instead of canceling '
4360 'prior patchset\' tryjobs')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004361 parser.add_option('--dependencies', action='store_true',
4362 help='Uploads CLs of all the local branches that depend on '
4363 'the current branch')
Ravi Mistry31e7d562018-04-02 12:53:57 -04004364 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4365 help='Sends your change to the CQ after an approval. Only '
4366 'works on repos that have the Auto-Submit label '
4367 'enabled')
Edward Lesmes8e282792018-04-03 18:50:29 -04004368 parser.add_option('--parallel', action='store_true',
4369 help='Run all tests specified by input_api.RunTests in all '
4370 'PRESUBMIT files in parallel.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004371 parser.add_option('--no-autocc', action='store_true',
4372 help='Disables automatic addition of CC emails')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004373 parser.add_option('--private', action='store_true',
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004374 help='Set the review private. This implies --no-autocc.')
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004375 parser.add_option('-R', '--retry-failed', action='store_true',
4376 help='Retry failed tryjobs from old patchset immediately '
4377 'after uploading new patchset. Cannot be used with '
4378 '--use-commit-queue or --cq-dry-run.')
4379 parser.add_option('--buildbucket-host', default='cr-buildbucket.appspot.com',
4380 help='Host of buildbucket. The default host is %default.')
Dan Beamd8b04ca2019-10-10 21:23:26 +00004381 parser.add_option('--fixed', '-x',
4382 help='List of bugs that will be commented on and marked '
4383 'fixed (pre-populates "Fixed:" tag). Same format as '
4384 '-b option / "Bug:" tag. If fixing several issues, '
4385 'separate with commas.')
Josipe827b0f2020-01-30 00:07:20 +00004386 parser.add_option('--edit-description', action='store_true', default=False,
4387 help='Modify description before upload. Cannot be used '
4388 'with --force. It is a noop when --no-squash is set '
4389 'or a new commit is created.')
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004390 parser.add_option('--git-completion-helper', action="store_true",
4391 help=optparse.SUPPRESS_HELP)
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004392 parser.add_option('--resultdb', action='store_true',
4393 help='Run presubmit checks in the ResultSink environment '
4394 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004395 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00004396 parser.add_option('-o',
4397 '--push-options',
4398 action='append',
4399 default=[],
4400 help='Transmit the given string to the server when '
4401 'performing git push (pass-through). See git-push '
4402 'documentation for more details.')
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00004403 parser.add_option('--no-add-changeid',
4404 action='store_true',
4405 dest='no_add_changeid',
4406 help='Do not add change-ids to messages.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004407
rmistry@google.com2dd99862015-06-22 12:22:18 +00004408 orig_args = args
ukai@chromium.orge8077812012-02-03 03:41:46 +00004409 (options, args) = parser.parse_args(args)
4410
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004411 if options.git_completion_helper:
Edward Lesmesb7db1832020-06-22 20:22:27 +00004412 print(' '.join(opt.get_opt_string() for opt in parser.option_list
4413 if opt.help != optparse.SUPPRESS_HELP))
4414 return
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004415
sbc@chromium.org71437c02015-04-09 19:29:40 +00004416 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004417 return 1
4418
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004419 options.reviewers = cleanup_list(options.reviewers)
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004420 options.tbrs = cleanup_list(options.tbrs)
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004421 options.cc = cleanup_list(options.cc)
4422
Josipe827b0f2020-01-30 00:07:20 +00004423 if options.edit_description and options.force:
4424 parser.error('Only one of --force and --edit-description allowed')
4425
tandriib80458a2016-06-23 12:20:07 -07004426 if options.message_file:
4427 if options.message:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004428 parser.error('Only one of --message and --message-file allowed.')
tandriib80458a2016-06-23 12:20:07 -07004429 options.message = gclient_utils.FileRead(options.message_file)
tandriib80458a2016-06-23 12:20:07 -07004430
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004431 if ([options.cq_dry_run,
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004432 options.cq_quick_run,
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004433 options.use_commit_queue,
4434 options.retry_failed].count(True) > 1):
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004435 parser.error('Only one of --use-commit-queue, --cq-dry-run, --cq-quick-run '
4436 'or --retry-failed is allowed.')
tandrii4d0545a2016-07-06 03:56:49 -07004437
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004438 if options.skip_title and options.title:
4439 parser.error('Only one of --title and --skip-title allowed.')
4440
Aaron Gableedbc4132017-09-11 13:22:28 -07004441 if options.use_commit_queue:
4442 options.send_mail = True
4443
Edward Lesmes0dd54822020-03-26 18:24:25 +00004444 if options.squash is None:
4445 # Load default for user, repo, squash=true, in this order.
4446 options.squash = settings.GetSquashGerritUploads()
4447
Josip Sokcevic1cabb172021-04-08 19:15:35 +00004448 cl = Changelist(branchref=options.target_branch)
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004449 # Warm change details cache now to avoid RPCs later, reducing latency for
4450 # developers.
4451 if cl.GetIssue():
4452 cl._GetChangeDetail(
4453 ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS'])
4454
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004455 if options.retry_failed and not cl.GetIssue():
4456 print('No previous patchsets, so --retry-failed has no effect.')
4457 options.retry_failed = False
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004458
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004459 # cl.GetMostRecentPatchset uses cached information, and can return the last
4460 # patchset before upload. Calling it here makes it clear that it's the
4461 # last patchset before upload. Note that GetMostRecentPatchset will fail
4462 # if no CL has been uploaded yet.
4463 if options.retry_failed:
4464 patchset = cl.GetMostRecentPatchset()
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00004465
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004466 ret = cl.CMDUpload(options, args, orig_args)
4467
4468 if options.retry_failed:
4469 if ret != 0:
4470 print('Upload failed, so --retry-failed has no effect.')
4471 return ret
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +00004472 builds, _ = _fetch_latest_builds(
Edward Lemur5b929a42019-10-21 17:57:39 +00004473 cl, options.buildbucket_host, latest_patchset=patchset)
Edward Lemur45768512020-03-02 19:03:14 +00004474 jobs = _filter_failed_for_retry(builds)
4475 if len(jobs) == 0:
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004476 print('No failed tryjobs, so --retry-failed has no effect.')
4477 return ret
Quinten Yearsley777660f2020-03-04 23:37:06 +00004478 _trigger_tryjobs(cl, jobs, options, patchset + 1)
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004479
4480 return ret
ukai@chromium.orge8077812012-02-03 03:41:46 +00004481
4482
Francois Dorayd42c6812017-05-30 15:10:20 -04004483@subcommand.usage('--description=<description file>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004484@metrics.collector.collect_metrics('git cl split')
Francois Dorayd42c6812017-05-30 15:10:20 -04004485def CMDsplit(parser, args):
4486 """Splits a branch into smaller branches and uploads CLs.
4487
4488 Creates a branch and uploads a CL for each group of files modified in the
4489 current branch that share a common OWNERS file. In the CL description and
Edward Lemurac5c55f2020-02-29 00:17:16 +00004490 comment, the string '$directory', is replaced with the directory containing
4491 the shared OWNERS file.
Francois Dorayd42c6812017-05-30 15:10:20 -04004492 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004493 parser.add_option('-d', '--description', dest='description_file',
4494 help='A text file containing a CL description in which '
4495 '$directory will be replaced by each CL\'s directory.')
4496 parser.add_option('-c', '--comment', dest='comment_file',
4497 help='A text file containing a CL comment.')
4498 parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true',
Chris Watkinsba28e462017-12-13 11:22:17 +11004499 default=False,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004500 help='List the files and reviewers for each CL that would '
4501 'be created, but don\'t create branches or CLs.')
4502 parser.add_option('--cq-dry-run', action='store_true',
4503 help='If set, will do a cq dry run for each uploaded CL. '
4504 'Please be careful when doing this; more than ~10 CLs '
4505 'has the potential to overload our build '
4506 'infrastructure. Try to upload these not during high '
4507 'load times (usually 11-3 Mountain View time). Email '
4508 'infra-dev@chromium.org with any questions.')
Takuto Ikuta51eca592019-02-14 19:40:52 +00004509 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4510 default=True,
4511 help='Sends your change to the CQ after an approval. Only '
4512 'works on repos that have the Auto-Submit label '
4513 'enabled')
Francois Dorayd42c6812017-05-30 15:10:20 -04004514 options, _ = parser.parse_args(args)
4515
4516 if not options.description_file:
4517 parser.error('No --description flag specified.')
4518
4519 def WrappedCMDupload(args):
4520 return CMDupload(OptionParser(), args)
4521
Edward Lemur2c62b332020-03-12 22:12:33 +00004522 return split_cl.SplitCl(
4523 options.description_file, options.comment_file, Changelist,
4524 WrappedCMDupload, options.dry_run, options.cq_dry_run,
4525 options.enable_auto_submit, settings.GetRoot())
Francois Dorayd42c6812017-05-30 15:10:20 -04004526
4527
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004528@subcommand.usage('DEPRECATED')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004529@metrics.collector.collect_metrics('git cl commit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004530def CMDdcommit(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004531 """DEPRECATED: Used to commit the current changelist via git-svn."""
4532 message = ('git-cl no longer supports committing to SVN repositories via '
4533 'git-svn. You probably want to use `git cl land` instead.')
4534 print(message)
4535 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004536
4537
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004538@subcommand.usage('[upstream branch to apply against]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004539@metrics.collector.collect_metrics('git cl land')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004540def CMDland(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004541 """Commits the current changelist via git.
4542
4543 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4544 upstream and closes the issue automatically and atomically.
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004545 """
4546 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4547 help='bypass upload presubmit hook')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004548 parser.add_option('-f', '--force', action='store_true', dest='force',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004549 help="force yes to questions (don't prompt)")
Edward Lesmes67b3faa2018-04-13 17:50:52 -04004550 parser.add_option('--parallel', action='store_true',
4551 help='Run all tests specified by input_api.RunTests in all '
4552 'PRESUBMIT files in parallel.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004553 parser.add_option('--resultdb', action='store_true',
4554 help='Run presubmit checks in the ResultSink environment '
4555 'and send results to the ResultDB database.')
4556 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004557 (options, args) = parser.parse_args(args)
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004558
Edward Lemur934836a2019-09-09 20:16:54 +00004559 cl = Changelist()
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004560
Robert Iannucci2e73d432018-03-14 01:10:47 -07004561 if not cl.GetIssue():
4562 DieWithError('You must upload the change first to Gerrit.\n'
4563 ' If you would rather have `git cl land` upload '
4564 'automatically for you, see http://crbug.com/642759')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004565 return cl.CMDLand(options.force, options.bypass_hooks, options.verbose,
4566 options.parallel, options.resultdb, options.realm)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004567
4568
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004569@subcommand.usage('<patch url or issue id or issue url>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004570@metrics.collector.collect_metrics('git cl patch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004571def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004572 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004573 parser.add_option('-b', dest='newbranch',
4574 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004575 parser.add_option('-f', '--force', action='store_true',
Aaron Gable62619a32017-06-16 08:22:09 -07004576 help='overwrite state on the current or chosen branch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004577 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
Edward Lemurf38bc172019-09-03 21:02:13 +00004578 help='don\'t commit after patch applies.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004579
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004580 group = optparse.OptionGroup(
4581 parser,
4582 'Options for continuing work on the current issue uploaded from a '
4583 'different clone (e.g. different machine). Must be used independently '
4584 'from the other options. No issue number should be specified, and the '
4585 'branch must have an issue number associated with it')
4586 group.add_option('--reapply', action='store_true', dest='reapply',
4587 help='Reset the branch and reapply the issue.\n'
4588 'CAUTION: This will undo any local changes in this '
4589 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004590
4591 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004592 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004593 parser.add_option_group(group)
4594
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004595 (options, args) = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004596
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004597 if options.reapply:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004598 if options.newbranch:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004599 parser.error('--reapply works on the current branch only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004600 if len(args) > 0:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004601 parser.error('--reapply implies no additional arguments.')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004602
Edward Lemur934836a2019-09-09 20:16:54 +00004603 cl = Changelist()
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004604 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004605 parser.error('Current branch must have an associated issue.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004606
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004607 upstream = cl.GetUpstreamBranch()
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004608 if upstream is None:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004609 parser.error('No upstream branch specified. Cannot reset branch.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004610
4611 RunGit(['reset', '--hard', upstream])
4612 if options.pull:
4613 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004614
Edward Lemur678a6842019-10-03 22:25:05 +00004615 target_issue_arg = ParseIssueNumberArgument(cl.GetIssue())
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004616 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, False,
4617 False)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004618
4619 if len(args) != 1 or not args[0]:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004620 parser.error('Must specify issue number or URL.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004621
Edward Lemurf38bc172019-09-03 21:02:13 +00004622 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004623 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004624 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004625
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004626 # We don't want uncommitted changes mixed up with the patch.
4627 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004628 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004629
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004630 if options.newbranch:
4631 if options.force:
4632 RunGit(['branch', '-D', options.newbranch],
4633 stderr=subprocess2.PIPE, error_ok=True)
Edward Lemur84101642020-02-21 21:40:34 +00004634 git_new_branch.create_new_branch(options.newbranch)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004635
Edward Lemur678a6842019-10-03 22:25:05 +00004636 cl = Changelist(
4637 codereview_host=target_issue_arg.hostname, issue=target_issue_arg.issue)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004638
Edward Lemur678a6842019-10-03 22:25:05 +00004639 if not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004640 print('canonical issue/change URL: %s\n' % cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004641
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004642 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit,
4643 options.force, options.newbranch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004644
4645
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004646def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004647 """Fetches the tree status and returns either 'open', 'closed',
4648 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004649 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004650 if url:
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004651 status = str(urllib.request.urlopen(url).read().lower())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004652 if status.find('closed') != -1 or status == '0':
4653 return 'closed'
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00004654
4655 if status.find('open') != -1 or status == '1':
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004656 return 'open'
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00004657
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004658 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004659 return 'unset'
4660
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004661
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004662def GetTreeStatusReason():
4663 """Fetches the tree status from a json url and returns the message
4664 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004665 url = settings.GetTreeStatusUrl()
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004666 json_url = urllib.parse.urljoin(url, '/current?format=json')
Edward Lemur79d4f992019-11-11 23:49:02 +00004667 connection = urllib.request.urlopen(json_url)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004668 status = json.loads(connection.read())
4669 connection.close()
4670 return status['message']
4671
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004672
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004673@metrics.collector.collect_metrics('git cl tree')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004674def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004675 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004676 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004677 status = GetTreeStatus()
4678 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004679 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004680 return 2
4681
vapiera7fbd5a2016-06-16 09:17:49 -07004682 print('The tree is %s' % status)
4683 print()
4684 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004685 if status != 'open':
4686 return 1
4687 return 0
4688
4689
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004690@metrics.collector.collect_metrics('git cl try')
maruel@chromium.org15192402012-09-06 12:38:29 +00004691def CMDtry(parser, args):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004692 """Triggers tryjobs using either Buildbucket or CQ dry run."""
4693 group = optparse.OptionGroup(parser, 'Tryjob options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004694 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004695 '-b', '--bot', action='append',
4696 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4697 'times to specify multiple builders. ex: '
4698 '"-b win_rel -b win_layout". See '
4699 'the try server waterfall for the builders name and the tests '
4700 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004701 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004702 '-B', '--bucket', default='',
Ben Pastene08a30b22022-05-04 17:46:38 +00004703 help=('Buildbucket bucket to send the try requests. Format: '
4704 '"luci.$LUCI_PROJECT.$LUCI_BUCKET". eg: "luci.chromium.try"'))
borenet6c0efe62016-10-19 08:13:29 -07004705 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004706 '-r', '--revision',
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004707 help='Revision to use for the tryjob; default: the revision will '
tandriif7b29d42016-10-07 08:45:41 -07004708 'be determined by the try recipe that builder runs, which usually '
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004709 'defaults to HEAD of origin/master or origin/main')
maruel@chromium.org15192402012-09-06 12:38:29 +00004710 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004711 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004712 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004713 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004714 group.add_option(
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004715 '-q',
4716 '--quick-run',
4717 action='store_true',
4718 default=False,
4719 help='trigger in quick run mode '
4720 '(https://source.chromium.org/chromium/chromium/src/+/main:docs/cq_q'
4721 'uick_run.md) (chromium only).')
4722 group.add_option(
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004723 '--category', default='git_cl_try', help='Specify custom build category.')
4724 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004725 '--project',
4726 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004727 'in recipe to determine to which repository or directory to '
4728 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004729 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004730 '-p', '--property', dest='properties', action='append', default=[],
4731 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004732 'key2=value2 etc. The value will be treated as '
4733 'json if decodable, or as string otherwise. '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004734 'NOTE: using this may make your tryjob not usable for CQ, '
4735 'which will then schedule another tryjob with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004736 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004737 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4738 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004739 parser.add_option_group(group)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004740 parser.add_option(
4741 '-R', '--retry-failed', action='store_true', default=False,
4742 help='Retry failed jobs from the latest set of tryjobs. '
4743 'Not allowed with --bucket and --bot options.')
Edward Lemur52969c92020-02-06 18:15:28 +00004744 parser.add_option(
4745 '-i', '--issue', type=int,
4746 help='Operate on this issue instead of the current branch\'s implicit '
4747 'issue.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004748 options, args = parser.parse_args(args)
4749
machenbach@chromium.org45453142015-09-15 08:45:22 +00004750 # Make sure that all properties are prop=value pairs.
4751 bad_params = [x for x in options.properties if '=' not in x]
4752 if bad_params:
4753 parser.error('Got properties with missing "=": %s' % bad_params)
4754
maruel@chromium.org15192402012-09-06 12:38:29 +00004755 if args:
4756 parser.error('Unknown arguments: %s' % args)
4757
Edward Lemur934836a2019-09-09 20:16:54 +00004758 cl = Changelist(issue=options.issue)
maruel@chromium.org15192402012-09-06 12:38:29 +00004759 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004760 parser.error('Need to upload first.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004761
Edward Lemurf38bc172019-09-03 21:02:13 +00004762 # HACK: warm up Gerrit change detail cache to save on RPCs.
Edward Lemur125d60a2019-09-13 18:25:41 +00004763 cl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS'])
Andrii Shyshkaloveadad922017-01-26 09:38:30 +01004764
tandriie113dfd2016-10-11 10:20:12 -07004765 error_message = cl.CannotTriggerTryJobReason()
4766 if error_message:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004767 parser.error('Can\'t trigger tryjobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004768
Edward Lemur45768512020-03-02 19:03:14 +00004769 if options.bot:
4770 if options.retry_failed:
4771 parser.error('--bot is not compatible with --retry-failed.')
4772 if not options.bucket:
4773 parser.error('A bucket (e.g. "chromium/try") is required.')
4774
4775 triggered = [b for b in options.bot if 'triggered' in b]
4776 if triggered:
4777 parser.error(
4778 'Cannot schedule builds on triggered bots: %s.\n'
4779 'This type of bot requires an initial job from a parent (usually a '
4780 'builder). Schedule a job on the parent instead.\n' % triggered)
4781
4782 if options.bucket.startswith('.master'):
4783 parser.error('Buildbot masters are not supported.')
4784
4785 project, bucket = _parse_bucket(options.bucket)
4786 if project is None or bucket is None:
4787 parser.error('Invalid bucket: %s.' % options.bucket)
4788 jobs = sorted((project, bucket, bot) for bot in options.bot)
4789 elif options.retry_failed:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004790 print('Searching for failed tryjobs...')
Edward Lemur5b929a42019-10-21 17:57:39 +00004791 builds, patchset = _fetch_latest_builds(cl, options.buildbucket_host)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004792 if options.verbose:
4793 print('Got %d builds in patchset #%d' % (len(builds), patchset))
Edward Lemur45768512020-03-02 19:03:14 +00004794 jobs = _filter_failed_for_retry(builds)
4795 if not jobs:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004796 print('There are no failed jobs in the latest set of jobs '
4797 '(patchset #%d), doing nothing.' % patchset)
4798 return 0
Edward Lemur45768512020-03-02 19:03:14 +00004799 num_builders = len(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004800 if num_builders > 10:
4801 confirm_or_exit('There are %d builders with failed builds.'
4802 % num_builders, action='continue')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004803 elif options.quick_run:
4804 print('Scheduling CQ quick run on: %s' % cl.GetIssueURL())
4805 return cl.SetCQState(_CQState.QUICK_RUN)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004806 else:
qyearsley1fdfcb62016-10-24 13:22:03 -07004807 if options.verbose:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07004808 print('git cl try with no bots now defaults to CQ dry run.')
4809 print('Scheduling CQ dry run on: %s' % cl.GetIssueURL())
4810 return cl.SetCQState(_CQState.DRY_RUN)
stip@chromium.org43064fd2013-12-18 20:07:44 +00004811
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004812 patchset = cl.GetMostRecentPatchset()
Edward Lemur2c210a42019-09-16 23:58:35 +00004813 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004814 _trigger_tryjobs(cl, jobs, options, patchset)
Edward Lemur2c210a42019-09-16 23:58:35 +00004815 except BuildbucketResponseException as ex:
4816 print('ERROR: %s' % ex)
4817 return 1
4818 return 0
maruel@chromium.org15192402012-09-06 12:38:29 +00004819
4820
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004821@metrics.collector.collect_metrics('git cl try-results')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004822def CMDtry_results(parser, args):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004823 """Prints info about results for tryjobs associated with the current CL."""
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004824 group = optparse.OptionGroup(parser, 'Tryjob results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004825 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004826 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004827 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004828 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004829 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004830 '--color', action='store_true', default=setup_color.IS_TTY,
4831 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004832 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004833 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4834 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004835 group.add_option(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004836 '--json', help=('Path of JSON output file to write tryjob results to,'
Stefan Zager1306bd02017-06-22 19:26:46 -07004837 'or "-" for stdout.'))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004838 parser.add_option_group(group)
Edward Lemur52969c92020-02-06 18:15:28 +00004839 parser.add_option(
4840 '-i', '--issue', type=int,
4841 help='Operate on this issue instead of the current branch\'s implicit '
4842 'issue.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004843 options, args = parser.parse_args(args)
4844 if args:
4845 parser.error('Unrecognized args: %s' % ' '.join(args))
4846
Edward Lemur934836a2019-09-09 20:16:54 +00004847 cl = Changelist(issue=options.issue)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004848 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004849 parser.error('Need to upload first.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004850
tandrii221ab252016-10-06 08:12:04 -07004851 patchset = options.patchset
4852 if not patchset:
Gavin Make61ccc52020-11-13 00:12:57 +00004853 patchset = cl.GetMostRecentDryRunPatchset()
tandrii221ab252016-10-06 08:12:04 -07004854 if not patchset:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004855 parser.error('Code review host doesn\'t know about issue %s. '
tandrii221ab252016-10-06 08:12:04 -07004856 'No access to issue or wrong issue number?\n'
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004857 'Either upload first, or pass --patchset explicitly.' %
tandrii221ab252016-10-06 08:12:04 -07004858 cl.GetIssue())
4859
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004860 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004861 jobs = _fetch_tryjobs(cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004862 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004863 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004864 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004865 if options.json:
Edward Lemurbaaf6be2019-10-09 18:00:44 +00004866 write_json(options.json, jobs)
qyearsley53f48a12016-09-01 10:45:13 -07004867 else:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004868 _print_tryjobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004869 return 0
4870
4871
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004872@subcommand.usage('[new upstream branch]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004873@metrics.collector.collect_metrics('git cl upstream')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004874def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004875 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004876 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004877 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004878 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004879
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004880 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004881 if args:
4882 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004883 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07004884 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004885 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07004886 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004887
4888 # Clear configured merge-base, if there is one.
4889 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004890 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004891 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004892 return 0
4893
4894
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004895@metrics.collector.collect_metrics('git cl web')
thestig@chromium.org00858c82013-12-02 23:08:03 +00004896def CMDweb(parser, args):
4897 """Opens the current CL in the web browser."""
4898 _, args = parser.parse_args(args)
4899 if args:
4900 parser.error('Unrecognized args: %s' % ' '.join(args))
4901
4902 issue_url = Changelist().GetIssueURL()
4903 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07004904 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004905 return 1
4906
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004907 # Redirect I/O before invoking browser to hide its output. For example, this
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004908 # allows us to hide the "Created new window in existing browser session."
4909 # message from Chrome. Based on https://stackoverflow.com/a/2323563.
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004910 saved_stdout = os.dup(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004911 saved_stderr = os.dup(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004912 os.close(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004913 os.close(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004914 os.open(os.devnull, os.O_RDWR)
4915 try:
4916 webbrowser.open(issue_url)
4917 finally:
4918 os.dup2(saved_stdout, 1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004919 os.dup2(saved_stderr, 2)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004920 return 0
4921
4922
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004923@metrics.collector.collect_metrics('git cl set-commit')
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004924def CMDset_commit(parser, args):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004925 """Sets the commit bit to trigger the CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004926 parser.add_option('-d', '--dry-run', action='store_true',
4927 help='trigger in dry run mode')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004928 parser.add_option(
4929 '-q',
4930 '--quick-run',
4931 action='store_true',
4932 help='trigger in quick run mode '
4933 '(https://source.chromium.org/chromium/chromium/src/+/main:docs/cq_qu'
4934 'ick_run.md) (chromium only).')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004935 parser.add_option('-c', '--clear', action='store_true',
4936 help='stop CQ run, if any')
Edward Lemur52969c92020-02-06 18:15:28 +00004937 parser.add_option(
4938 '-i', '--issue', type=int,
4939 help='Operate on this issue instead of the current branch\'s implicit '
4940 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004941 options, args = parser.parse_args(args)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004942 if args:
4943 parser.error('Unrecognized args: %s' % ' '.join(args))
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004944 if [options.dry_run, options.quick_run, options.clear].count(True) > 1:
4945 parser.error('Only one of --dry-run, --quick-run, and --clear are allowed.')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004946
Edward Lemur934836a2019-09-09 20:16:54 +00004947 cl = Changelist(issue=options.issue)
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004948 if not cl.GetIssue():
4949 parser.error('Must upload the issue first.')
4950
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004951 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07004952 state = _CQState.NONE
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004953 elif options.quick_run:
4954 state = _CQState.QUICK_RUN
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004955 elif options.dry_run:
4956 state = _CQState.DRY_RUN
4957 else:
4958 state = _CQState.COMMIT
tandrii9de9ec62016-07-13 03:01:59 -07004959 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004960 return 0
4961
4962
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004963@metrics.collector.collect_metrics('git cl set-close')
groby@chromium.org411034a2013-02-26 15:12:01 +00004964def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004965 """Closes the issue."""
Edward Lemur52969c92020-02-06 18:15:28 +00004966 parser.add_option(
4967 '-i', '--issue', type=int,
4968 help='Operate on this issue instead of the current branch\'s implicit '
4969 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004970 options, args = parser.parse_args(args)
groby@chromium.org411034a2013-02-26 15:12:01 +00004971 if args:
4972 parser.error('Unrecognized args: %s' % ' '.join(args))
Edward Lemur934836a2019-09-09 20:16:54 +00004973 cl = Changelist(issue=options.issue)
groby@chromium.org411034a2013-02-26 15:12:01 +00004974 # Ensure there actually is an issue to close.
Aaron Gable7139a4e2017-09-05 17:53:09 -07004975 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004976 DieWithError('ERROR: No issue to close.')
groby@chromium.org411034a2013-02-26 15:12:01 +00004977 cl.CloseIssue()
4978 return 0
4979
4980
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004981@metrics.collector.collect_metrics('git cl diff')
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004982def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00004983 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07004984 parser.add_option(
4985 '--stat',
4986 action='store_true',
4987 dest='stat',
4988 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004989 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004990 if args:
4991 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00004992
Edward Lemur934836a2019-09-09 20:16:54 +00004993 cl = Changelist()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004994 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004995 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004996 if not issue:
4997 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004998
Aaron Gablea718c3e2017-08-28 17:47:28 -07004999 base = cl._GitGetBranchConfigValue('last-upload-hash')
5000 if not base:
5001 base = cl._GitGetBranchConfigValue('gerritsquashhash')
5002 if not base:
5003 detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
5004 revision_info = detail['revisions'][detail['current_revision']]
5005 fetch_info = revision_info['fetch']['http']
5006 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
5007 base = 'FETCH_HEAD'
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005008
Aaron Gablea718c3e2017-08-28 17:47:28 -07005009 cmd = ['git', 'diff']
5010 if options.stat:
5011 cmd.append('--stat')
5012 cmd.append(base)
5013 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005014
5015 return 0
5016
5017
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005018@metrics.collector.collect_metrics('git cl owners')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005019def CMDowners(parser, args):
Dirk Prankebf980882017-09-02 15:08:00 -07005020 """Finds potential owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005021 parser.add_option(
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00005022 '--ignore-current',
5023 action='store_true',
5024 help='Ignore the CL\'s current reviewers and start from scratch.')
5025 parser.add_option(
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00005026 '--ignore-self',
5027 action='store_true',
5028 help='Do not consider CL\'s author as an owners.')
5029 parser.add_option(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005030 '--no-color',
5031 action='store_true',
5032 help='Use this option to disable color output')
Dirk Prankebf980882017-09-02 15:08:00 -07005033 parser.add_option(
5034 '--batch',
5035 action='store_true',
5036 help='Do not run interactively, just suggest some')
Yang Guo6e269a02019-06-26 11:17:02 +00005037 # TODO: Consider moving this to another command, since other
5038 # git-cl owners commands deal with owners for a given CL.
5039 parser.add_option(
5040 '--show-all',
5041 action='store_true',
5042 help='Show all owners for a particular file')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005043 options, args = parser.parse_args(args)
5044
Edward Lemur934836a2019-09-09 20:16:54 +00005045 cl = Changelist()
Edward Lesmes50da7702020-03-30 19:23:43 +00005046 author = cl.GetAuthor()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005047
Yang Guo6e269a02019-06-26 11:17:02 +00005048 if options.show_all:
Bruce Dawson97ed44a2020-05-06 17:04:03 +00005049 if len(args) == 0:
5050 print('No files specified for --show-all. Nothing to do.')
5051 return 0
Edward Lesmese1576912021-02-16 21:53:34 +00005052 owners_by_path = cl.owners_client.BatchListOwners(args)
Edward Lesmes0e4e5ae2021-01-08 18:28:46 +00005053 for path in args:
5054 print('Owners for %s:' % path)
5055 print('\n'.join(
5056 ' - %s' % owner
5057 for owner in owners_by_path.get(path, ['No owners found'])))
Yang Guo6e269a02019-06-26 11:17:02 +00005058 return 0
5059
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005060 if args:
5061 if len(args) > 1:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005062 parser.error('Unknown args.')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005063 base_branch = args[0]
5064 else:
5065 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005066 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005067
Edward Lemur2c62b332020-03-12 22:12:33 +00005068 affected_files = cl.GetAffectedFiles(base_branch)
Dirk Prankebf980882017-09-02 15:08:00 -07005069
5070 if options.batch:
Edward Lesmese1576912021-02-16 21:53:34 +00005071 owners = cl.owners_client.SuggestOwners(affected_files, exclude=[author])
5072 print('\n'.join(owners))
Dirk Prankebf980882017-09-02 15:08:00 -07005073 return 0
5074
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005075 return owners_finder.OwnersFinder(
Dirk Prankebf980882017-09-02 15:08:00 -07005076 affected_files,
Edward Lemur707d70b2018-02-07 00:50:14 +01005077 author,
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00005078 [] if options.ignore_current else cl.GetReviewers(),
Edward Lesmes5cd75472021-02-19 00:34:25 +00005079 cl.owners_client,
Jochen Eisingerd0573ec2017-04-13 10:55:06 +02005080 disable_color=options.no_color,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00005081 ignore_author=options.ignore_self).run()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005082
5083
Aiden Bennerc08566e2018-10-03 17:52:42 +00005084def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005085 """Generates a diff command."""
5086 # Generate diff for the current branch's changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +00005087 diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff']
5088
Aiden Benner6c18a1a2018-11-23 20:18:23 +00005089 if allow_prefix:
5090 # explicitly setting --src-prefix and --dst-prefix is necessary in the
5091 # case that diff.noprefix is set in the user's git config.
5092 diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/']
5093 else:
Aiden Bennerc08566e2018-10-03 17:52:42 +00005094 diff_cmd += ['--no-prefix']
5095
5096 diff_cmd += [diff_type, upstream_commit, '--']
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005097
5098 if args:
5099 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005100 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005101 diff_cmd.append(arg)
5102 else:
5103 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005104
5105 return diff_cmd
5106
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005107
Jamie Madill5e96ad12020-01-13 16:08:35 +00005108def _RunClangFormatDiff(opts, clang_diff_files, top_dir, upstream_commit):
5109 """Runs clang-format-diff and sets a return value if necessary."""
5110
5111 if not clang_diff_files:
5112 return 0
5113
5114 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
5115 # formatted. This is used to block during the presubmit.
5116 return_value = 0
5117
5118 # Locate the clang-format binary in the checkout
5119 try:
5120 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
5121 except clang_format.NotFoundError as e:
5122 DieWithError(e)
5123
5124 if opts.full or settings.GetFormatFullByDefault():
5125 cmd = [clang_format_tool]
5126 if not opts.dry_run and not opts.diff:
5127 cmd.append('-i')
5128 if opts.dry_run:
5129 for diff_file in clang_diff_files:
5130 with open(diff_file, 'r') as myfile:
5131 code = myfile.read().replace('\r\n', '\n')
5132 stdout = RunCommand(cmd + [diff_file], cwd=top_dir)
5133 stdout = stdout.replace('\r\n', '\n')
5134 if opts.diff:
5135 sys.stdout.write(stdout)
5136 if code != stdout:
5137 return_value = 2
5138 else:
5139 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
5140 if opts.diff:
5141 sys.stdout.write(stdout)
5142 else:
Jamie Madill5e96ad12020-01-13 16:08:35 +00005143 try:
5144 script = clang_format.FindClangFormatScriptInChromiumTree(
5145 'clang-format-diff.py')
5146 except clang_format.NotFoundError as e:
5147 DieWithError(e)
5148
Josip Sokcevic2a827fc2022-03-04 17:51:47 +00005149 cmd = ['vpython3', script, '-p0']
Jamie Madill5e96ad12020-01-13 16:08:35 +00005150 if not opts.dry_run and not opts.diff:
5151 cmd.append('-i')
5152
5153 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
Edward Lemur1a83da12020-03-04 21:18:36 +00005154 diff_output = RunGit(diff_cmd).encode('utf-8')
Jamie Madill5e96ad12020-01-13 16:08:35 +00005155
Edward Lesmes89624cd2020-04-06 17:51:56 +00005156 env = os.environ.copy()
5157 env['PATH'] = (
5158 str(os.path.dirname(clang_format_tool)) + os.pathsep + env['PATH'])
5159 stdout = RunCommand(
5160 cmd, stdin=diff_output, cwd=top_dir, env=env,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005161 shell=sys.platform.startswith('win32'))
Jamie Madill5e96ad12020-01-13 16:08:35 +00005162 if opts.diff:
5163 sys.stdout.write(stdout)
5164 if opts.dry_run and len(stdout) > 0:
5165 return_value = 2
5166
5167 return return_value
5168
5169
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005170def _RunRustFmt(opts, rust_diff_files, top_dir, upstream_commit):
5171 """Runs rustfmt. Just like _RunClangFormatDiff returns 2 to indicate that
5172 presubmit checks have failed (and returns 0 otherwise)."""
5173
5174 if not rust_diff_files:
5175 return 0
5176
5177 # Locate the rustfmt binary.
5178 try:
5179 rustfmt_tool = rustfmt.FindRustfmtToolInChromiumTree()
5180 except rustfmt.NotFoundError as e:
5181 DieWithError(e)
5182
5183 # TODO(crbug.com/1231317): Support formatting only the changed lines
5184 # if `opts.full or settings.GetFormatFullByDefault()` is False. See also:
5185 # https://github.com/emilio/rustfmt-format-diff
5186 cmd = [rustfmt_tool]
5187 if opts.dry_run:
5188 cmd.append('--check')
5189 cmd += rust_diff_files
5190 rustfmt_exitcode = subprocess2.call(cmd)
5191
5192 if opts.presubmit and rustfmt_exitcode != 0:
5193 return 2
Aravind Vasudevanc5f0cbb2022-01-24 23:56:57 +00005194
5195 return 0
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005196
5197
Olivier Robin0a6b5442022-04-07 07:25:04 +00005198def _RunSwiftFormat(opts, swift_diff_files, top_dir, upstream_commit):
5199 """Runs swift-format. Just like _RunClangFormatDiff returns 2 to indicate
5200 that presubmit checks have failed (and returns 0 otherwise)."""
5201
5202 if not swift_diff_files:
5203 return 0
5204
5205 # Locate the swift-format binary.
5206 try:
5207 swift_format_tool = swift_format.FindSwiftFormatToolInChromiumTree()
5208 except swift_format.NotFoundError as e:
5209 DieWithError(e)
5210
5211 cmd = [swift_format_tool]
5212 if opts.dry_run:
Olivier Robin7f39e3d2022-04-28 08:20:49 +00005213 cmd += ['lint', '-s']
Olivier Robin0a6b5442022-04-07 07:25:04 +00005214 else:
5215 cmd += ['format', '-i']
5216 cmd += swift_diff_files
5217 swift_format_exitcode = subprocess2.call(cmd)
5218
5219 if opts.presubmit and swift_format_exitcode != 0:
5220 return 2
5221
5222 return 0
5223
5224
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005225def MatchingFileType(file_name, extensions):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00005226 """Returns True if the file name ends with one of the given extensions."""
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005227 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005228
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005229
enne@chromium.org555cfe42014-01-29 18:21:39 +00005230@subcommand.usage('[files or directories to diff]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005231@metrics.collector.collect_metrics('git cl format')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005232def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005233 """Runs auto-formatting tools (clang-format etc.) on the diff."""
Christopher Lamc5ba6922017-01-24 11:19:14 +11005234 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07005235 GN_EXTS = ['.gn', '.gni', '.typemap']
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005236 RUST_EXTS = ['.rs']
Olivier Robin0a6b5442022-04-07 07:25:04 +00005237 SWIFT_EXTS = ['.swift']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005238 parser.add_option('--full', action='store_true',
5239 help='Reformat the full content of all touched files')
Tomasz Åšniatowski58194462021-08-27 17:36:16 +00005240 parser.add_option('--upstream', help='Branch to check against')
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005241 parser.add_option('--dry-run', action='store_true',
5242 help='Don\'t modify any file on disk.')
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005243 parser.add_option(
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005244 '--no-clang-format',
5245 dest='clang_format',
5246 action='store_false',
5247 default=True,
5248 help='Disables formatting of various file types using clang-format.')
5249 parser.add_option(
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005250 '--python',
5251 action='store_true',
5252 default=None,
5253 help='Enables python formatting on all python files.')
5254 parser.add_option(
5255 '--no-python',
5256 action='store_true',
Garrett Beaty91a6f332020-01-06 16:57:24 +00005257 default=False,
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005258 help='Disables python formatting on all python files. '
Garrett Beaty91a6f332020-01-06 16:57:24 +00005259 'If neither --python or --no-python are set, python files that have a '
5260 '.style.yapf file in an ancestor directory will be formatted. '
5261 'It is an error to set both.')
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005262 parser.add_option(
5263 '--js',
5264 action='store_true',
5265 help='Format javascript code with clang-format. '
5266 'Has no effect if --no-clang-format is set.')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00005267 parser.add_option('--diff', action='store_true',
5268 help='Print diff to stdout rather than modifying files.')
Ilya Shermane081cbe2017-08-15 17:51:04 -07005269 parser.add_option('--presubmit', action='store_true',
5270 help='Used when running the script from a presubmit.')
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005271
5272 parser.add_option('--rust-fmt',
5273 dest='use_rust_fmt',
5274 action='store_true',
5275 default=rustfmt.IsRustfmtSupported(),
5276 help='Enables formatting of Rust file types using rustfmt.')
5277 parser.add_option(
5278 '--no-rust-fmt',
5279 dest='use_rust_fmt',
5280 action='store_false',
5281 help='Disables formatting of Rust file types using rustfmt.')
5282
Olivier Robin0a6b5442022-04-07 07:25:04 +00005283 parser.add_option(
5284 '--swift-format',
5285 dest='use_swift_format',
5286 action='store_true',
Olivier Robin7f39e3d2022-04-28 08:20:49 +00005287 default=swift_format.IsSwiftFormatSupported(),
Olivier Robin0a6b5442022-04-07 07:25:04 +00005288 help='Enables formatting of Swift file types using swift-format '
5289 '(macOS host only).')
5290 parser.add_option(
5291 '--no-swift-format',
5292 dest='use_swift_format',
5293 action='store_false',
5294 help='Disables formatting of Swift file types using swift-format.')
5295
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005296 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005297
Garrett Beaty91a6f332020-01-06 16:57:24 +00005298 if opts.python is not None and opts.no_python:
5299 raise parser.error('Cannot set both --python and --no-python')
5300 if opts.no_python:
5301 opts.python = False
5302
Daniel Chengc55eecf2016-12-30 03:11:02 -08005303 # Normalize any remaining args against the current path, so paths relative to
5304 # the current directory are still resolved as expected.
5305 args = [os.path.join(os.getcwd(), arg) for arg in args]
5306
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005307 # git diff generates paths against the root of the repository. Change
5308 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005309 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005310 if rel_base_path:
5311 os.chdir(rel_base_path)
5312
digit@chromium.org29e47272013-05-17 17:01:46 +00005313 # Grab the merge-base commit, i.e. the upstream commit of the current
5314 # branch when it was created or the last time it was rebased. This is
5315 # to cover the case where the user may have called "git fetch origin",
5316 # moving the origin branch to a newer commit, but hasn't rebased yet.
5317 upstream_commit = None
Tomasz Åšniatowski58194462021-08-27 17:36:16 +00005318 upstream_branch = opts.upstream
5319 if not upstream_branch:
5320 cl = Changelist()
5321 upstream_branch = cl.GetUpstreamBranch()
digit@chromium.org29e47272013-05-17 17:01:46 +00005322 if upstream_branch:
5323 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
5324 upstream_commit = upstream_commit.strip()
5325
5326 if not upstream_commit:
5327 DieWithError('Could not find base commit for this branch. '
5328 'Are you in detached state?')
5329
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005330 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5331 diff_output = RunGit(changed_files_cmd)
5332 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005333 # Filter out files deleted by this CL
5334 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005335
Andreas Haas417d89c2020-02-06 10:24:27 +00005336 if opts.js:
Deepanjan Roy605dd312018-07-02 17:48:54 +00005337 CLANG_EXTS.extend(['.js', '.ts'])
Christopher Lamc5ba6922017-01-24 11:19:14 +11005338
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005339 clang_diff_files = []
5340 if opts.clang_format:
5341 clang_diff_files = [
5342 x for x in diff_files if MatchingFileType(x, CLANG_EXTS)
5343 ]
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005344 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005345 rust_diff_files = [x for x in diff_files if MatchingFileType(x, RUST_EXTS)]
Olivier Robin0a6b5442022-04-07 07:25:04 +00005346 swift_diff_files = [x for x in diff_files if MatchingFileType(x, SWIFT_EXTS)]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005347 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005348
Edward Lesmes50da7702020-03-30 19:23:43 +00005349 top_dir = settings.GetRoot()
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005350
Jamie Madill5e96ad12020-01-13 16:08:35 +00005351 return_value = _RunClangFormatDiff(opts, clang_diff_files, top_dir,
5352 upstream_commit)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005353
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005354 if opts.use_rust_fmt:
5355 rust_fmt_return_value = _RunRustFmt(opts, rust_diff_files, top_dir,
5356 upstream_commit)
5357 if rust_fmt_return_value == 2:
5358 return_value = 2
5359
Olivier Robin0a6b5442022-04-07 07:25:04 +00005360 if opts.use_swift_format:
5361 if sys.platform != 'darwin':
5362 DieWithError('swift-format is only supported on macOS.')
5363 swift_format_return_value = _RunSwiftFormat(opts, swift_diff_files, top_dir,
5364 upstream_commit)
5365 if swift_format_return_value == 2:
5366 return_value = 2
5367
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005368 # Similar code to above, but using yapf on .py files rather than clang-format
5369 # on C/C++ files
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005370 py_explicitly_disabled = opts.python is not None and not opts.python
5371 if python_diff_files and not py_explicitly_disabled:
Aiden Bennere47ac152018-11-20 16:44:03 +00005372 depot_tools_path = os.path.dirname(os.path.abspath(__file__))
5373 yapf_tool = os.path.join(depot_tools_path, 'yapf')
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005374
Aiden Bennerc08566e2018-10-03 17:52:42 +00005375 # Used for caching.
5376 yapf_configs = {}
5377 for f in python_diff_files:
5378 # Find the yapf style config for the current file, defaults to depot
5379 # tools default.
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005380 _FindYapfConfigFile(f, yapf_configs, top_dir)
5381
5382 # Turn on python formatting by default if a yapf config is specified.
5383 # This breaks in the case of this repo though since the specified
5384 # style file is also the global default.
5385 if opts.python is None:
5386 filtered_py_files = []
5387 for f in python_diff_files:
5388 if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None:
5389 filtered_py_files.append(f)
5390 else:
5391 filtered_py_files = python_diff_files
5392
5393 # Note: yapf still seems to fix indentation of the entire file
5394 # even if line ranges are specified.
5395 # See https://github.com/google/yapf/issues/499
5396 if not opts.full and filtered_py_files:
5397 py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit)
5398
Brian Sheedyb4307d52019-12-02 19:18:17 +00005399 yapfignore_patterns = _GetYapfIgnorePatterns(top_dir)
5400 filtered_py_files = _FilterYapfIgnoredFiles(filtered_py_files,
5401 yapfignore_patterns)
Brian Sheedy59b06a82019-10-14 17:03:29 +00005402
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005403 for f in filtered_py_files:
Andrew Grievefa40bfa2020-01-07 02:32:57 +00005404 yapf_style = _FindYapfConfigFile(f, yapf_configs, top_dir)
5405 # Default to pep8 if not .style.yapf is found.
5406 if not yapf_style:
5407 yapf_style = 'pep8'
Aiden Bennerc08566e2018-10-03 17:52:42 +00005408
Peter Wend9399922020-06-17 17:33:49 +00005409 with open(f, 'r') as py_f:
Andrew Grieveb9e694c2021-11-15 19:04:46 +00005410 if 'python2' in py_f.readline():
Peter Wend9399922020-06-17 17:33:49 +00005411 vpython_script = 'vpython'
Andrew Grieveb9e694c2021-11-15 19:04:46 +00005412 else:
5413 vpython_script = 'vpython3'
Peter Wend9399922020-06-17 17:33:49 +00005414
5415 cmd = [vpython_script, yapf_tool, '--style', yapf_style, f]
Aiden Bennerc08566e2018-10-03 17:52:42 +00005416
5417 has_formattable_lines = False
5418 if not opts.full:
5419 # Only run yapf over changed line ranges.
5420 for diff_start, diff_len in py_line_diffs[f]:
5421 diff_end = diff_start + diff_len - 1
5422 # Yapf errors out if diff_end < diff_start but this
5423 # is a valid line range diff for a removal.
5424 if diff_end >= diff_start:
5425 has_formattable_lines = True
5426 cmd += ['-l', '{}-{}'.format(diff_start, diff_end)]
5427 # If all line diffs were removals we have nothing to format.
5428 if not has_formattable_lines:
5429 continue
5430
5431 if opts.diff or opts.dry_run:
5432 cmd += ['--diff']
5433 # Will return non-zero exit code if non-empty diff.
Edward Lesmesb7db1832020-06-22 20:22:27 +00005434 stdout = RunCommand(cmd,
5435 error_ok=True,
Josip Sokcevic673e8ed2021-10-27 23:46:18 +00005436 stderr=subprocess2.PIPE,
Edward Lesmesb7db1832020-06-22 20:22:27 +00005437 cwd=top_dir,
5438 shell=sys.platform.startswith('win32'))
Aiden Bennerc08566e2018-10-03 17:52:42 +00005439 if opts.diff:
5440 sys.stdout.write(stdout)
5441 elif len(stdout) > 0:
5442 return_value = 2
5443 else:
5444 cmd += ['-i']
Edward Lesmesb7db1832020-06-22 20:22:27 +00005445 RunCommand(cmd, cwd=top_dir, shell=sys.platform.startswith('win32'))
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005446
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005447 # Format GN build files. Always run on full build files for canonical form.
5448 if gn_diff_files:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005449 cmd = ['gn', 'format']
brettw4b8ed592016-08-05 16:19:12 -07005450 if opts.dry_run or opts.diff:
5451 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005452 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005453 gn_ret = subprocess2.call(cmd + [gn_diff_file],
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005454 shell=sys.platform.startswith('win'),
brettw4b8ed592016-08-05 16:19:12 -07005455 cwd=top_dir)
5456 if opts.dry_run and gn_ret == 2:
5457 return_value = 2 # Not formatted.
5458 elif opts.diff and gn_ret == 2:
5459 # TODO this should compute and print the actual diff.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005460 print('This change has GN build file diff for ' + gn_diff_file)
brettw4b8ed592016-08-05 16:19:12 -07005461 elif gn_ret != 0:
5462 # For non-dry run cases (and non-2 return values for dry-run), a
5463 # nonzero error code indicates a failure, probably because the file
5464 # doesn't parse.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005465 DieWithError('gn format failed on ' + gn_diff_file +
5466 '\nTry running `gn format` on this file manually.')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005467
Ilya Shermane081cbe2017-08-15 17:51:04 -07005468 # Skip the metrics formatting from the global presubmit hook. These files have
5469 # a separate presubmit hook that issues an error if the files need formatting,
5470 # whereas the top-level presubmit script merely issues a warning. Formatting
5471 # these files is somewhat slow, so it's important not to duplicate the work.
5472 if not opts.presubmit:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005473 for diff_xml in GetDiffXMLs(diff_files):
5474 xml_dir = GetMetricsDir(diff_xml)
5475 if not xml_dir:
5476 continue
5477
Ilya Shermane081cbe2017-08-15 17:51:04 -07005478 tool_dir = os.path.join(top_dir, xml_dir)
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005479 pretty_print_tool = os.path.join(tool_dir, 'pretty_print.py')
Fabrice de Gansecfab092022-09-15 20:59:01 +00005480 cmd = ['vpython3', pretty_print_tool, '--non-interactive']
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005481
5482 # If the XML file is histograms.xml or enums.xml, add the xml path to the
5483 # command as histograms/pretty_print.py now needs a relative path argument
5484 # after splitting the histograms into multiple directories.
5485 # For example, in tools/metrics/ukm, pretty-print could be run using:
5486 # $ python pretty_print.py
5487 # But in tools/metrics/histogrmas, pretty-print should be run with an
5488 # additional relative path argument, like:
Peter Kastingee088882021-08-03 17:57:00 +00005489 # $ python pretty_print.py metadata/UMA/histograms.xml
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005490 # $ python pretty_print.py enums.xml
5491
5492 # TODO (crbug/1116488): Remove this check after ensuring that the updated
5493 # version of histograms/pretty_print.py is released.
5494 filepath_required = os.path.exists(
5495 os.path.join(tool_dir, 'validate_prefix.py'))
5496
Weilun Shib92c4b72020-08-27 17:45:11 +00005497 if (diff_xml.endswith('histograms.xml') or diff_xml.endswith('enums.xml')
5498 or diff_xml.endswith('histogram_suffixes_list.xml')
5499 ) and filepath_required:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005500 cmd.append(diff_xml)
5501
Ilya Shermane081cbe2017-08-15 17:51:04 -07005502 if opts.dry_run or opts.diff:
5503 cmd.append('--diff')
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005504
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005505 # TODO(isherman): Once this file runs only on Python 3.3+, drop the
5506 # `shell` param and instead replace `'vpython'` with
5507 # `shutil.which('frob')` above: https://stackoverflow.com/a/32799942
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005508 stdout = RunCommand(cmd,
5509 cwd=top_dir,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005510 shell=sys.platform.startswith('win32'))
Ilya Shermane081cbe2017-08-15 17:51:04 -07005511 if opts.diff:
5512 sys.stdout.write(stdout)
5513 if opts.dry_run and stdout:
5514 return_value = 2 # Not formatted.
Alexei Svitkinef3cac412017-02-06 11:08:50 -05005515
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005516 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005517
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005518
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005519def GetDiffXMLs(diff_files):
5520 return [
5521 os.path.normpath(x) for x in diff_files if MatchingFileType(x, ['.xml'])
5522 ]
5523
5524
5525def GetMetricsDir(diff_xml):
Steven Holte2e664bf2017-04-21 13:10:47 -07005526 metrics_xml_dirs = [
5527 os.path.join('tools', 'metrics', 'actions'),
5528 os.path.join('tools', 'metrics', 'histograms'),
5529 os.path.join('tools', 'metrics', 'rappor'),
Ilya Shermanb67e60c2020-05-20 22:27:03 +00005530 os.path.join('tools', 'metrics', 'structured'),
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005531 os.path.join('tools', 'metrics', 'ukm'),
5532 ]
Steven Holte2e664bf2017-04-21 13:10:47 -07005533 for xml_dir in metrics_xml_dirs:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005534 if diff_xml.startswith(xml_dir):
5535 return xml_dir
5536 return None
Steven Holte2e664bf2017-04-21 13:10:47 -07005537
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005538
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005539@subcommand.usage('<codereview url or issue id>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005540@metrics.collector.collect_metrics('git cl checkout')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005541def CMDcheckout(parser, args):
Edward Lemurf38bc172019-09-03 21:02:13 +00005542 """Checks out a branch associated with a given Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005543 _, args = parser.parse_args(args)
5544
5545 if len(args) != 1:
5546 parser.print_help()
5547 return 1
5548
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005549 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005550 if not issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005551 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02005552
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005553 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005554
Edward Lemur52969c92020-02-06 18:15:28 +00005555 output = RunGit(['config', '--local', '--get-regexp',
Edward Lesmes50da7702020-03-30 19:23:43 +00005556 r'branch\..*\.' + ISSUE_CONFIG_KEY],
Edward Lemur52969c92020-02-06 18:15:28 +00005557 error_ok=True)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005558
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005559 branches = []
Edward Lemur52969c92020-02-06 18:15:28 +00005560 for key, issue in [x.split() for x in output.splitlines()]:
5561 if issue == target_issue:
Edward Lesmes50da7702020-03-30 19:23:43 +00005562 branches.append(re.sub(r'branch\.(.*)\.' + ISSUE_CONFIG_KEY, r'\1', key))
Edward Lemur52969c92020-02-06 18:15:28 +00005563
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005564 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005565 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005566 return 1
5567 if len(branches) == 1:
5568 RunGit(['checkout', branches[0]])
5569 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005570 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005571 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005572 print('%d: %s' % (i, branches[i]))
Edward Lesmesae3586b2020-03-23 21:21:14 +00005573 which = gclient_utils.AskForData('Choose by index: ')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005574 try:
5575 RunGit(['checkout', branches[int(which)]])
5576 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005577 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005578 return 1
5579
5580 return 0
5581
5582
maruel@chromium.org29404b52014-09-08 22:58:00 +00005583def CMDlol(parser, args):
5584 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005585 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005586 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5587 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5588 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
Gavin Mak18f45d22020-12-04 21:45:10 +00005589 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')).decode('utf-8'))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005590 return 0
5591
5592
Josip Sokcevic0399e172022-03-21 23:11:51 +00005593def CMDversion(parser, args):
5594 import utils
5595 print(utils.depot_tools_version())
5596
5597
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005598class OptionParser(optparse.OptionParser):
5599 """Creates the option parse and add --verbose support."""
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00005600
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005601 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005602 optparse.OptionParser.__init__(
5603 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005604 self.add_option(
5605 '-v', '--verbose', action='count', default=0,
5606 help='Use 2 times for more debugging info')
5607
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005608 def parse_args(self, args=None, _values=None):
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005609 try:
5610 return self._parse_args(args)
5611 finally:
5612 # Regardless of success or failure of args parsing, we want to report
5613 # metrics, but only after logging has been initialized (if parsing
5614 # succeeded).
5615 global settings
5616 settings = Settings()
5617
Edward Lesmes9c349062021-05-06 20:02:39 +00005618 if metrics.collector.config.should_collect_metrics:
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005619 # GetViewVCUrl ultimately calls logging method.
5620 project_url = settings.GetViewVCUrl().strip('/+')
5621 if project_url in metrics_utils.KNOWN_PROJECT_URLS:
5622 metrics.collector.add('project_urls', [project_url])
5623
5624 def _parse_args(self, args=None):
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005625 # Create an optparse.Values object that will store only the actual passed
5626 # options, without the defaults.
5627 actual_options = optparse.Values()
5628 _, args = optparse.OptionParser.parse_args(self, args, actual_options)
5629 # Create an optparse.Values object with the default options.
5630 options = optparse.Values(self.get_default_values().__dict__)
5631 # Update it with the options passed by the user.
5632 options._update_careful(actual_options.__dict__)
5633 # Store the options passed by the user in an _actual_options attribute.
5634 # We store only the keys, and not the values, since the values can contain
5635 # arbitrary information, which might be PII.
Edward Lemur79d4f992019-11-11 23:49:02 +00005636 metrics.collector.add('arguments', list(actual_options.__dict__.keys()))
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005637
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005638 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
Andrii Shyshkalov5b04a572017-01-23 17:44:41 +01005639 logging.basicConfig(
5640 level=levels[min(options.verbose, len(levels) - 1)],
5641 format='[%(levelname).1s%(asctime)s %(process)d %(thread)d '
5642 '%(filename)s] %(message)s')
Edward Lemur83bd7f42018-10-10 00:14:21 +00005643
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005644 return options, args
5645
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005646
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005647def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005648 if sys.hexversion < 0x02060000:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005649 print('\nYour Python version %s is unsupported, please upgrade.\n' %
vapiera7fbd5a2016-06-16 09:17:49 -07005650 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005651 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005652
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005653 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005654 dispatcher = subcommand.CommandDispatcher(__name__)
5655 try:
5656 return dispatcher.execute(OptionParser(), argv)
Edward Lemur5b929a42019-10-21 17:57:39 +00005657 except auth.LoginRequiredError as e:
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005658 DieWithError(str(e))
Edward Lemur79d4f992019-11-11 23:49:02 +00005659 except urllib.error.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005660 if e.code != 500:
5661 raise
5662 DieWithError(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005663 ('App Engine is misbehaving and returned HTTP %d, again. Keep faith '
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005664 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005665 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005666
5667
5668if __name__ == '__main__':
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005669 # These affect sys.stdout, so do it outside of main() to simplify mocks in
5670 # the unit tests.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005671 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005672 setup_color.init()
Edward Lemur6f812e12018-07-31 22:45:57 +00005673 with metrics.collector.print_notice_and_exit():
sbc@chromium.org013731e2015-02-26 18:28:43 +00005674 sys.exit(main(sys.argv[1:]))