blob: 5ad4947903c24c84f0728fa40bdf1b9946ee808a [file] [log] [blame]
Edward Lemur1f3bafb2019-10-08 17:56:33 +00001#!/usr/bin/env vpython
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02002# Copyright (c) 2013 The Chromium Authors. All rights reserved.
maruel@chromium.org725f1c32011-04-01 20:24:54 +00003# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00006# Copyright (C) 2008 Evan Martin <martine@danga.com>
7
Andrii Shyshkalov03da1502018-10-15 03:42:34 +00008"""A git-command for integrating reviews on Gerrit."""
maruel@chromium.org725f1c32011-04-01 20:24:54 +00009
vapiera7fbd5a2016-06-16 09:17:49 -070010from __future__ import print_function
11
thakis@chromium.org3421c992014-11-02 02:20:32 +000012import base64
rmistry@google.com2dd99862015-06-22 12:22:18 +000013import collections
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +010014import datetime
Brian Sheedyb4307d52019-12-02 19:18:17 +000015import fnmatch
Edward Lemur202c5592019-10-21 22:44:52 +000016import httplib2
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +010017import itertools
maruel@chromium.org4f6852c2012-04-20 20:39:20 +000018import json
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000019import logging
calamity@chromium.orgcf197482016-04-29 20:15:53 +000020import multiprocessing
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000021import optparse
22import os
23import re
Andrii Shyshkalov353637c2017-03-14 16:52:18 +010024import shutil
ukai@chromium.org78c4b982012-02-14 02:20:26 +000025import stat
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000026import sys
Aaron Gable9a03ae02017-11-03 11:31:07 -070027import tempfile
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000028import textwrap
Edward Lemurfec80c42018-11-01 23:14:14 +000029import time
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000030import uuid
thestig@chromium.org00858c82013-12-02 23:08:03 +000031import webbrowser
thakis@chromium.org3421c992014-11-02 02:20:32 +000032import zlib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000033
maruel@chromium.org2e23ce32013-05-07 12:42:28 +000034from third_party import colorama
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000035import auth
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +000036import clang_format
maruel@chromium.org6f09cd92011-04-01 16:38:12 +000037import fix_encoding
maruel@chromium.org0e0436a2011-10-25 13:32:41 +000038import gclient_utils
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +000039import gerrit_util
iannucci@chromium.org9e849272014-04-04 00:31:55 +000040import git_common
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +000041import git_footers
Edward Lemur85153282020-02-14 22:06:29 +000042import git_new_branch
Edward Lemur5ba1e9c2018-07-23 18:19:02 +000043import metrics
Edward Lesmes93277a72018-10-18 22:04:26 +000044import metrics_utils
Edward Lesmeseeca9c62020-11-20 00:00:17 +000045import owners_client
iannucci@chromium.org9e849272014-04-04 00:31:55 +000046import owners_finder
Lei Zhangb8c62cf2020-07-15 20:09:37 +000047import presubmit_canned_checks
maruel@chromium.org2a74d372011-03-29 19:05:50 +000048import presubmit_support
49import scm
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +000050import setup_color
Francois Dorayd42c6812017-05-30 15:10:20 -040051import split_cl
maruel@chromium.org0633fb42013-08-16 20:06:14 +000052import subcommand
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +000053import subprocess2
maruel@chromium.org2a74d372011-03-29 19:05:50 +000054import watchlists
55
Edward Lemur79d4f992019-11-11 23:49:02 +000056from third_party import six
57from six.moves import urllib
58
59
60if sys.version_info.major == 3:
61 basestring = (str,) # pylint: disable=redefined-builtin
62
Edward Lemurb9830242019-10-30 22:19:20 +000063
tandrii7400cf02016-06-21 08:48:07 -070064__version__ = '2.0'
maruel@chromium.org2a74d372011-03-29 19:05:50 +000065
Edward Lemur0f58ae42019-04-30 17:24:12 +000066# Traces for git push will be stored in a traces directory inside the
67# depot_tools checkout.
68DEPOT_TOOLS = os.path.dirname(os.path.abspath(__file__))
69TRACES_DIR = os.path.join(DEPOT_TOOLS, 'traces')
Edward Lemur227d5102020-02-25 23:45:35 +000070PRESUBMIT_SUPPORT = os.path.join(DEPOT_TOOLS, 'presubmit_support.py')
Edward Lemur0f58ae42019-04-30 17:24:12 +000071
72# When collecting traces, Git hashes will be reduced to 6 characters to reduce
73# the size after compression.
74GIT_HASH_RE = re.compile(r'\b([a-f0-9]{6})[a-f0-9]{34}\b', flags=re.I)
75# Used to redact the cookies from the gitcookies file.
76GITCOOKIES_REDACT_RE = re.compile(r'1/.*')
77
Edward Lemurd4d1ba42019-09-20 21:46:37 +000078MAX_ATTEMPTS = 3
79
Edward Lemur1b52d872019-05-09 21:12:12 +000080# The maximum number of traces we will keep. Multiplied by 3 since we store
81# 3 files per trace.
82MAX_TRACES = 3 * 10
Edward Lemur5737f022019-05-17 01:24:00 +000083# Message to be displayed to the user to inform where to find the traces for a
84# git-cl upload execution.
Edward Lemur0f58ae42019-04-30 17:24:12 +000085TRACES_MESSAGE = (
Edward Lemur1b52d872019-05-09 21:12:12 +000086'\n'
Edward Lemur5737f022019-05-17 01:24:00 +000087'The traces of this git-cl execution have been recorded at:\n'
Edward Lemur1b52d872019-05-09 21:12:12 +000088' %(trace_name)s-traces.zip\n'
Edward Lemur5737f022019-05-17 01:24:00 +000089'Copies of your gitcookies file and git config have been recorded at:\n'
90' %(trace_name)s-git-info.zip\n')
Edward Lemur1b52d872019-05-09 21:12:12 +000091# Format of the message to be stored as part of the traces to give developers a
92# better context when they go through traces.
93TRACES_README_FORMAT = (
94'Date: %(now)s\n'
95'\n'
96'Change: https://%(gerrit_host)s/q/%(change_id)s\n'
97'Title: %(title)s\n'
98'\n'
99'%(description)s\n'
100'\n'
101'Execution time: %(execution_time)s\n'
102'Exit code: %(exit_code)s\n') + TRACES_MESSAGE
Edward Lemur0f58ae42019-04-30 17:24:12 +0000103
Aaron Gable1bc7bfe2016-12-19 10:08:14 -0800104POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land'
Henrique Ferreiroff249622019-11-28 23:19:29 +0000105DESCRIPTION_BACKUP_FILE = '.git_cl_description_backup'
rmistry@google.comc68112d2015-03-03 12:48:06 +0000106REFS_THAT_ALIAS_TO_OTHER_REFS = {
107 'refs/remotes/origin/lkgr': 'refs/remotes/origin/master',
108 'refs/remotes/origin/lkcr': 'refs/remotes/origin/master',
109}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000110
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000111DEFAULT_OLD_BRANCH = 'refs/remotes/origin/master'
112DEFAULT_NEW_BRANCH = 'refs/remotes/origin/main'
113
thestig@chromium.org44202a22014-03-11 19:22:18 +0000114# Valid extensions for files we want to lint.
115DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
116DEFAULT_LINT_IGNORE_REGEX = r"$^"
117
Aiden Bennerc08566e2018-10-03 17:52:42 +0000118# File name for yapf style config files.
119YAPF_CONFIG_FILENAME = '.style.yapf'
120
Edward Lesmes50da7702020-03-30 19:23:43 +0000121# The issue, patchset and codereview server are stored on git config for each
122# branch under branch.<branch-name>.<config-key>.
123ISSUE_CONFIG_KEY = 'gerritissue'
124PATCHSET_CONFIG_KEY = 'gerritpatchset'
125CODEREVIEW_SERVER_CONFIG_KEY = 'gerritserver'
126
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000127# Shortcut since it quickly becomes repetitive.
maruel@chromium.org2e23ce32013-05-07 12:42:28 +0000128Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +0000129
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000130# Initialized in main()
131settings = None
132
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100133# Used by tests/git_cl_test.py to add extra logging.
134# Inside the weirdly failing test, add this:
135# >>> self.mock(git_cl, '_IS_BEING_TESTED', True)
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700136# And scroll up to see the stack trace printed.
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100137_IS_BEING_TESTED = False
138
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000139
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000140_KNOWN_GERRIT_TO_SHORT_URLS = {
141 'https://chrome-internal-review.googlesource.com': 'https://crrev.com/i',
142 'https://chromium-review.googlesource.com': 'https://crrev.com/c',
143}
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000144assert len(_KNOWN_GERRIT_TO_SHORT_URLS) == len(
145 set(_KNOWN_GERRIT_TO_SHORT_URLS.values())), 'must have unique values'
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000146
147
Josip Sokcevicf736cab2020-10-20 23:41:38 +0000148class GitPushError(Exception):
149 pass
150
151
Christopher Lamf732cd52017-01-24 12:40:11 +1100152def DieWithError(message, change_desc=None):
153 if change_desc:
154 SaveDescriptionBackup(change_desc)
Josip Sokcevic953278a2020-02-28 19:46:36 +0000155 print('\n ** Content of CL description **\n' +
156 '='*72 + '\n' +
157 change_desc.description + '\n' +
158 '='*72 + '\n')
Christopher Lamf732cd52017-01-24 12:40:11 +1100159
vapiera7fbd5a2016-06-16 09:17:49 -0700160 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000161 sys.exit(1)
162
163
Christopher Lamf732cd52017-01-24 12:40:11 +1100164def SaveDescriptionBackup(change_desc):
Henrique Ferreiro5ae48172019-11-29 16:14:42 +0000165 backup_path = os.path.join(DEPOT_TOOLS, DESCRIPTION_BACKUP_FILE)
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +0000166 print('\nsaving CL description to %s\n' % backup_path)
Josip906bfde2020-01-31 22:38:49 +0000167 with open(backup_path, 'w') as backup_file:
168 backup_file.write(change_desc.description)
Christopher Lamf732cd52017-01-24 12:40:11 +1100169
170
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000171def GetNoGitPagerEnv():
172 env = os.environ.copy()
173 # 'cat' is a magical git string that disables pagers on all platforms.
174 env['GIT_PAGER'] = 'cat'
175 return env
176
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000177
bsep@chromium.org627d9002016-04-29 00:00:52 +0000178def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000179 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000180 stdout = subprocess2.check_output(args, shell=shell, **kwargs)
181 return stdout.decode('utf-8', 'replace')
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000182 except subprocess2.CalledProcessError as e:
183 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000184 if not error_ok:
Alan Cutter594fd332020-07-21 23:55:27 +0000185 message = error_message or e.stdout.decode('utf-8', 'replace') or ''
186 DieWithError('Command "%s" failed.\n%s' % (' '.join(args), message))
Edward Lemur79d4f992019-11-11 23:49:02 +0000187 return e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000188
189
190def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000191 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000192 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000193
194
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000195def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000196 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700197 if suppress_stderr:
Edward Lesmescf06cad2020-12-14 22:03:23 +0000198 stderr = subprocess2.DEVNULL
tandrii5d48c322016-08-18 16:19:37 -0700199 else:
200 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000201 try:
tandrii5d48c322016-08-18 16:19:37 -0700202 (out, _), code = subprocess2.communicate(['git'] + args,
203 env=GetNoGitPagerEnv(),
204 stdout=subprocess2.PIPE,
205 stderr=stderr)
Edward Lemur79d4f992019-11-11 23:49:02 +0000206 return code, out.decode('utf-8', 'replace')
tandrii5d48c322016-08-18 16:19:37 -0700207 except subprocess2.CalledProcessError as e:
Yoshisato Yanagisawa81e3ff52017-09-26 15:33:34 +0900208 logging.debug('Failed running %s', ['git'] + args)
Edward Lemur79d4f992019-11-11 23:49:02 +0000209 return e.returncode, e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000210
211
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000212def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000213 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000214 return RunGitWithCode(args, suppress_stderr=True)[1]
215
216
tandrii2a16b952016-10-19 07:09:44 -0700217def time_sleep(seconds):
218 # Use this so that it can be mocked in tests without interfering with python
219 # system machinery.
tandrii2a16b952016-10-19 07:09:44 -0700220 return time.sleep(seconds)
221
222
Edward Lemur01f4a4f2018-11-03 00:40:38 +0000223def time_time():
224 # Use this so that it can be mocked in tests without interfering with python
225 # system machinery.
226 return time.time()
227
228
Edward Lemur1b52d872019-05-09 21:12:12 +0000229def datetime_now():
230 # Use this so that it can be mocked in tests without interfering with python
231 # system machinery.
232 return datetime.datetime.now()
233
234
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100235def confirm_or_exit(prefix='', action='confirm'):
236 """Asks user to press enter to continue or press Ctrl+C to abort."""
237 if not prefix or prefix.endswith('\n'):
238 mid = 'Press'
Andrii Shyshkalov353637c2017-03-14 16:52:18 +0100239 elif prefix.endswith('.') or prefix.endswith('?'):
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100240 mid = ' Press'
241 elif prefix.endswith(' '):
242 mid = 'press'
243 else:
244 mid = ' press'
Edward Lesmesae3586b2020-03-23 21:21:14 +0000245 gclient_utils.AskForData(
246 '%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action))
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100247
248
249def ask_for_explicit_yes(prompt):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000250 """Returns whether user typed 'y' or 'yes' to confirm the given prompt."""
Edward Lesmesae3586b2020-03-23 21:21:14 +0000251 result = gclient_utils.AskForData(prompt + ' [Yes/No]: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100252 while True:
253 if 'yes'.startswith(result):
254 return True
255 if 'no'.startswith(result):
256 return False
Edward Lesmesae3586b2020-03-23 21:21:14 +0000257 result = gclient_utils.AskForData('Please, type yes or no: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100258
259
machenbach@chromium.org45453142015-09-15 08:45:22 +0000260def _get_properties_from_options(options):
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000261 prop_list = getattr(options, 'properties', [])
262 properties = dict(x.split('=', 1) for x in prop_list)
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000263 for key, val in properties.items():
machenbach@chromium.org45453142015-09-15 08:45:22 +0000264 try:
265 properties[key] = json.loads(val)
266 except ValueError:
267 pass # If a value couldn't be evaluated, treat it as a string.
268 return properties
269
270
Edward Lemur4c707a22019-09-24 21:13:43 +0000271def _call_buildbucket(http, buildbucket_host, method, request):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000272 """Calls a buildbucket v2 method and returns the parsed json response."""
273 headers = {
274 'Accept': 'application/json',
275 'Content-Type': 'application/json',
276 }
277 request = json.dumps(request)
278 url = 'https://%s/prpc/buildbucket.v2.Builds/%s' % (buildbucket_host, method)
279
280 logging.info('POST %s with %s' % (url, request))
281
282 attempts = 1
283 time_to_sleep = 1
284 while True:
285 response, content = http.request(url, 'POST', body=request, headers=headers)
286 if response.status == 200:
287 return json.loads(content[4:])
288 if attempts >= MAX_ATTEMPTS or 400 <= response.status < 500:
289 msg = '%s error when calling POST %s with %s: %s' % (
290 response.status, url, request, content)
291 raise BuildbucketResponseException(msg)
292 logging.debug(
293 '%s error when calling POST %s with %s. '
294 'Sleeping for %d seconds and retrying...' % (
295 response.status, url, request, time_to_sleep))
296 time.sleep(time_to_sleep)
297 time_to_sleep *= 2
298 attempts += 1
299
300 assert False, 'unreachable'
301
302
Edward Lemur6215c792019-10-03 21:59:05 +0000303def _parse_bucket(raw_bucket):
304 legacy = True
305 project = bucket = None
306 if '/' in raw_bucket:
307 legacy = False
308 project, bucket = raw_bucket.split('/', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000309 # Assume luci.<project>.<bucket>.
Edward Lemur6215c792019-10-03 21:59:05 +0000310 elif raw_bucket.startswith('luci.'):
311 project, bucket = raw_bucket[len('luci.'):].split('.', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000312 # Otherwise, assume prefix is also the project name.
Edward Lemur6215c792019-10-03 21:59:05 +0000313 elif '.' in raw_bucket:
314 project = raw_bucket.split('.')[0]
315 bucket = raw_bucket
316 # Legacy buckets.
Edward Lemur45768512020-03-02 19:03:14 +0000317 if legacy and project and bucket:
Edward Lemur6215c792019-10-03 21:59:05 +0000318 print('WARNING Please use %s/%s to specify the bucket.' % (project, bucket))
319 return project, bucket
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000320
321
Quinten Yearsley777660f2020-03-04 23:37:06 +0000322def _trigger_tryjobs(changelist, jobs, options, patchset):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000323 """Sends a request to Buildbucket to trigger tryjobs for a changelist.
qyearsley1fdfcb62016-10-24 13:22:03 -0700324
325 Args:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000326 changelist: Changelist that the tryjobs are associated with.
Edward Lemur45768512020-03-02 19:03:14 +0000327 jobs: A list of (project, bucket, builder).
qyearsley1fdfcb62016-10-24 13:22:03 -0700328 options: Command-line options.
329 """
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000330 print('Scheduling jobs on:')
Edward Lemur45768512020-03-02 19:03:14 +0000331 for project, bucket, builder in jobs:
332 print(' %s/%s: %s' % (project, bucket, builder))
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000333 print('To see results here, run: git cl try-results')
334 print('To see results in browser, run: git cl web')
tandriide281ae2016-10-12 06:02:30 -0700335
Quinten Yearsley777660f2020-03-04 23:37:06 +0000336 requests = _make_tryjob_schedule_requests(changelist, jobs, options, patchset)
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000337 if not requests:
338 return
339
Edward Lemur5b929a42019-10-21 17:57:39 +0000340 http = auth.Authenticator().authorize(httplib2.Http())
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000341 http.force_exception_to_status_code = True
342
343 batch_request = {'requests': requests}
344 batch_response = _call_buildbucket(
345 http, options.buildbucket_host, 'Batch', batch_request)
346
347 errors = [
348 ' ' + response['error']['message']
349 for response in batch_response.get('responses', [])
350 if 'error' in response
351 ]
352 if errors:
353 raise BuildbucketResponseException(
354 'Failed to schedule builds for some bots:\n%s' % '\n'.join(errors))
355
356
Quinten Yearsley777660f2020-03-04 23:37:06 +0000357def _make_tryjob_schedule_requests(changelist, jobs, options, patchset):
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000358 """Constructs requests for Buildbucket to trigger tryjobs."""
Edward Lemurf0faf482019-09-25 20:40:17 +0000359 gerrit_changes = [changelist.GetGerritChange(patchset)]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000360 shared_properties = {
361 'category': options.ensure_value('category', 'git_cl_try')
362 }
363 if options.ensure_value('clobber', False):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000364 shared_properties['clobber'] = True
365 shared_properties.update(_get_properties_from_options(options) or {})
366
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000367 shared_tags = [{'key': 'user_agent', 'value': 'git_cl_try'}]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000368 if options.ensure_value('retry_failed', False):
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000369 shared_tags.append({'key': 'retry_failed',
370 'value': '1'})
371
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000372 requests = []
Edward Lemur45768512020-03-02 19:03:14 +0000373 for (project, bucket, builder) in jobs:
374 properties = shared_properties.copy()
375 if 'presubmit' in builder.lower():
376 properties['dry_run'] = 'true'
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000377
Edward Lemur45768512020-03-02 19:03:14 +0000378 requests.append({
379 'scheduleBuild': {
380 'requestId': str(uuid.uuid4()),
381 'builder': {
382 'project': getattr(options, 'project', None) or project,
383 'bucket': bucket,
384 'builder': builder,
385 },
386 'gerritChanges': gerrit_changes,
387 'properties': properties,
388 'tags': [
389 {'key': 'builder', 'value': builder},
390 ] + shared_tags,
391 }
392 })
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000393
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000394 if options.ensure_value('revision', None):
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000395 remote, remote_branch = changelist.GetRemoteBranch()
Edward Lemur45768512020-03-02 19:03:14 +0000396 requests[-1]['scheduleBuild']['gitilesCommit'] = {
397 'host': gerrit_changes[0]['host'],
398 'project': gerrit_changes[0]['project'],
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000399 'id': options.revision,
400 'ref': GetTargetRef(remote, remote_branch, None)
Edward Lemur45768512020-03-02 19:03:14 +0000401 }
Anthony Polito1a5fe232020-01-24 23:17:52 +0000402
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000403 return requests
kjellander@chromium.org44424542015-06-02 18:35:29 +0000404
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000405
Quinten Yearsley777660f2020-03-04 23:37:06 +0000406def _fetch_tryjobs(changelist, buildbucket_host, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000407 """Fetches tryjobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000408
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000409 Returns list of buildbucket.v2.Build with the try jobs for the changelist.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000410 """
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000411 fields = ['id', 'builder', 'status', 'createTime', 'tags']
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000412 request = {
413 'predicate': {
414 'gerritChanges': [changelist.GetGerritChange(patchset)],
415 },
416 'fields': ','.join('builds.*.' + field for field in fields),
417 }
tandrii221ab252016-10-06 08:12:04 -0700418
Edward Lemur5b929a42019-10-21 17:57:39 +0000419 authenticator = auth.Authenticator()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000420 if authenticator.has_cached_credentials():
421 http = authenticator.authorize(httplib2.Http())
422 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700423 print('Warning: Some results might be missing because %s' %
424 # Get the message on how to login.
Andrii Shyshkalov2517afd2021-01-19 17:07:43 +0000425 (str(auth.LoginRequiredError()),))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000426 http = httplib2.Http()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000427 http.force_exception_to_status_code = True
428
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000429 response = _call_buildbucket(http, buildbucket_host, 'SearchBuilds', request)
430 return response.get('builds', [])
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000431
Edward Lemur45768512020-03-02 19:03:14 +0000432
Edward Lemur5b929a42019-10-21 17:57:39 +0000433def _fetch_latest_builds(changelist, buildbucket_host, latest_patchset=None):
Quinten Yearsley983111f2019-09-26 17:18:48 +0000434 """Fetches builds from the latest patchset that has builds (within
435 the last few patchsets).
436
437 Args:
Quinten Yearsley983111f2019-09-26 17:18:48 +0000438 changelist (Changelist): The CL to fetch builds for
439 buildbucket_host (str): Buildbucket host, e.g. "cr-buildbucket.appspot.com"
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000440 lastest_patchset(int|NoneType): the patchset to start fetching builds from.
441 If None (default), starts with the latest available patchset.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000442 Returns:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000443 A tuple (builds, patchset) where builds is a list of buildbucket.v2.Build,
444 and patchset is the patchset number where those builds came from.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000445 """
446 assert buildbucket_host
447 assert changelist.GetIssue(), 'CL must be uploaded first'
448 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000449 if latest_patchset is None:
450 assert changelist.GetMostRecentPatchset()
451 ps = changelist.GetMostRecentPatchset()
452 else:
453 assert latest_patchset > 0, latest_patchset
454 ps = latest_patchset
455
Quinten Yearsley983111f2019-09-26 17:18:48 +0000456 min_ps = max(1, ps - 5)
457 while ps >= min_ps:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000458 builds = _fetch_tryjobs(changelist, buildbucket_host, patchset=ps)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000459 if len(builds):
460 return builds, ps
461 ps -= 1
462 return [], 0
463
464
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000465def _filter_failed_for_retry(all_builds):
466 """Returns a list of buckets/builders that are worth retrying.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000467
468 Args:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000469 all_builds (list): Builds, in the format returned by _fetch_tryjobs,
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000470 i.e. a list of buildbucket.v2.Builds which includes status and builder
471 info.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000472
473 Returns:
Edward Lemur45768512020-03-02 19:03:14 +0000474 A dict {(proj, bucket): [builders]}. This is the same format accepted by
Quinten Yearsley777660f2020-03-04 23:37:06 +0000475 _trigger_tryjobs.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000476 """
Edward Lemur45768512020-03-02 19:03:14 +0000477 grouped = {}
478 for build in all_builds:
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000479 builder = build['builder']
Edward Lemur45768512020-03-02 19:03:14 +0000480 key = (builder['project'], builder['bucket'], builder['builder'])
481 grouped.setdefault(key, []).append(build)
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000482
Edward Lemur45768512020-03-02 19:03:14 +0000483 jobs = []
484 for (project, bucket, builder), builds in grouped.items():
485 if 'triggered' in builder:
486 print('WARNING: Not scheduling %s. Triggered bots require an initial job '
487 'from a parent. Please schedule a manual job for the parent '
488 'instead.')
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000489 continue
490 if any(b['status'] in ('STARTED', 'SCHEDULED') for b in builds):
491 # Don't retry if any are running.
492 continue
Edward Lemur45768512020-03-02 19:03:14 +0000493 # If builder had several builds, retry only if the last one failed.
494 # This is a bit different from CQ, which would re-use *any* SUCCESS-full
495 # build, but in case of retrying failed jobs retrying a flaky one makes
496 # sense.
497 builds = sorted(builds, key=lambda b: b['createTime'])
498 if builds[-1]['status'] not in ('FAILURE', 'INFRA_FAILURE'):
499 continue
500 # Don't retry experimental build previously triggered by CQ.
501 if any(t['key'] == 'cq_experimental' and t['value'] == 'true'
502 for t in builds[-1]['tags']):
503 continue
504 jobs.append((project, bucket, builder))
505
506 # Sort the jobs to make testing easier.
507 return sorted(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000508
509
Quinten Yearsley777660f2020-03-04 23:37:06 +0000510def _print_tryjobs(options, builds):
511 """Prints nicely result of _fetch_tryjobs."""
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000512 if not builds:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000513 print('No tryjobs scheduled.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000514 return
515
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000516 longest_builder = max(len(b['builder']['builder']) for b in builds)
517 name_fmt = '{builder:<%d}' % longest_builder
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000518 if options.print_master:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000519 longest_bucket = max(len(b['builder']['bucket']) for b in builds)
520 name_fmt = ('{bucket:>%d} ' % longest_bucket) + name_fmt
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000521
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000522 builds_by_status = {}
523 for b in builds:
524 builds_by_status.setdefault(b['status'], []).append({
525 'id': b['id'],
526 'name': name_fmt.format(
527 builder=b['builder']['builder'], bucket=b['builder']['bucket']),
528 })
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000529
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000530 sort_key = lambda b: (b['name'], b['id'])
531
532 def print_builds(title, builds, fmt=None, color=None):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000533 """Pop matching builds from `builds` dict and print them."""
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000534 if not builds:
535 return
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000536
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000537 fmt = fmt or '{name} https://ci.chromium.org/b/{id}'
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000538 if not options.color or color is None:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000539 colorize = lambda x: x
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000540 else:
541 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
542
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000543 print(colorize(title))
544 for b in sorted(builds, key=sort_key):
545 print(' ', colorize(fmt.format(**b)))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000546
547 total = len(builds)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000548 print_builds(
549 'Successes:', builds_by_status.pop('SUCCESS', []), color=Fore.GREEN)
550 print_builds(
551 'Infra Failures:', builds_by_status.pop('INFRA_FAILURE', []),
552 color=Fore.MAGENTA)
553 print_builds('Failures:', builds_by_status.pop('FAILURE', []), color=Fore.RED)
554 print_builds('Canceled:', builds_by_status.pop('CANCELED', []), fmt='{name}',
555 color=Fore.MAGENTA)
Andrii Shyshkalov792630c2020-10-19 16:47:44 +0000556 print_builds('Started:', builds_by_status.pop('STARTED', []),
557 color=Fore.YELLOW)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000558 print_builds(
559 'Scheduled:', builds_by_status.pop('SCHEDULED', []), fmt='{name} id={id}')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000560 # The last section is just in case buildbucket API changes OR there is a bug.
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000561 print_builds(
562 'Other:', sum(builds_by_status.values(), []), fmt='{name} id={id}')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000563 print('Total: %d tryjobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000564
565
Aiden Bennerc08566e2018-10-03 17:52:42 +0000566def _ComputeDiffLineRanges(files, upstream_commit):
567 """Gets the changed line ranges for each file since upstream_commit.
568
569 Parses a git diff on provided files and returns a dict that maps a file name
570 to an ordered list of range tuples in the form (start_line, count).
571 Ranges are in the same format as a git diff.
572 """
573 # If files is empty then diff_output will be a full diff.
574 if len(files) == 0:
575 return {}
576
Aiden Benner6c18a1a2018-11-23 20:18:23 +0000577 # Take the git diff and find the line ranges where there are changes.
Jamie Madill3671a6a2019-10-24 15:13:21 +0000578 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000579 diff_output = RunGit(diff_cmd)
580
581 pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)'
582 # 2 capture groups
583 # 0 == fname of diff file
584 # 1 == 'diff_start,diff_count' or 'diff_start'
585 # will match each of
586 # diff --git a/foo.foo b/foo.py
587 # @@ -12,2 +14,3 @@
588 # @@ -12,2 +17 @@
589 # running re.findall on the above string with pattern will give
590 # [('foo.py', ''), ('', '14,3'), ('', '17')]
591
592 curr_file = None
593 line_diffs = {}
594 for match in re.findall(pattern, diff_output, flags=re.MULTILINE):
595 if match[0] != '':
596 # Will match the second filename in diff --git a/a.py b/b.py.
597 curr_file = match[0]
598 line_diffs[curr_file] = []
599 else:
600 # Matches +14,3
601 if ',' in match[1]:
602 diff_start, diff_count = match[1].split(',')
603 else:
604 # Single line changes are of the form +12 instead of +12,1.
605 diff_start = match[1]
606 diff_count = 1
607
608 diff_start = int(diff_start)
609 diff_count = int(diff_count)
610
611 # If diff_count == 0 this is a removal we can ignore.
612 line_diffs[curr_file].append((diff_start, diff_count))
613
614 return line_diffs
615
616
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000617def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000618 """Checks if a yapf file is in any parent directory of fpath until top_dir.
619
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000620 Recursively checks parent directories to find yapf file and if no yapf file
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000621 is found returns None. Uses yapf_config_cache as a cache for previously found
622 configs.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000623 """
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000624 fpath = os.path.abspath(fpath)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000625 # Return result if we've already computed it.
626 if fpath in yapf_config_cache:
627 return yapf_config_cache[fpath]
628
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000629 parent_dir = os.path.dirname(fpath)
630 if os.path.isfile(fpath):
631 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000632 else:
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000633 # Otherwise fpath is a directory
634 yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME)
635 if os.path.isfile(yapf_file):
636 ret = yapf_file
637 elif fpath == top_dir or parent_dir == fpath:
638 # If we're at the top level directory, or if we're at root
639 # there is no provided style.
640 ret = None
641 else:
642 # Otherwise recurse on the current directory.
643 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000644 yapf_config_cache[fpath] = ret
645 return ret
646
647
Brian Sheedyb4307d52019-12-02 19:18:17 +0000648def _GetYapfIgnorePatterns(top_dir):
649 """Returns all patterns in the .yapfignore file.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000650
651 yapf is supposed to handle the ignoring of files listed in .yapfignore itself,
652 but this functionality appears to break when explicitly passing files to
653 yapf for formatting. According to
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000654 https://github.com/google/yapf/blob/HEAD/README.rst#excluding-files-from-formatting-yapfignore,
Brian Sheedy59b06a82019-10-14 17:03:29 +0000655 the .yapfignore file should be in the directory that yapf is invoked from,
656 which we assume to be the top level directory in this case.
657
658 Args:
659 top_dir: The top level directory for the repository being formatted.
660
661 Returns:
Brian Sheedyb4307d52019-12-02 19:18:17 +0000662 A set of all fnmatch patterns to be ignored.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000663 """
664 yapfignore_file = os.path.join(top_dir, '.yapfignore')
Brian Sheedyb4307d52019-12-02 19:18:17 +0000665 ignore_patterns = set()
Brian Sheedy59b06a82019-10-14 17:03:29 +0000666 if not os.path.exists(yapfignore_file):
Brian Sheedyb4307d52019-12-02 19:18:17 +0000667 return ignore_patterns
Brian Sheedy59b06a82019-10-14 17:03:29 +0000668
Anthony Politoc64e3902021-04-30 21:55:25 +0000669 for line in gclient_utils.FileRead(yapfignore_file).split('\n'):
670 stripped_line = line.strip()
671 # Comments and blank lines should be ignored.
672 if stripped_line.startswith('#') or stripped_line == '':
673 continue
674 ignore_patterns.add(stripped_line)
Brian Sheedyb4307d52019-12-02 19:18:17 +0000675 return ignore_patterns
676
677
678def _FilterYapfIgnoredFiles(filepaths, patterns):
679 """Filters out any filepaths that match any of the given patterns.
680
681 Args:
682 filepaths: An iterable of strings containing filepaths to filter.
683 patterns: An iterable of strings containing fnmatch patterns to filter on.
684
685 Returns:
686 A list of strings containing all the elements of |filepaths| that did not
687 match any of the patterns in |patterns|.
688 """
689 # Not inlined so that tests can use the same implementation.
690 return [f for f in filepaths
691 if not any(fnmatch.fnmatch(f, p) for p in patterns)]
Brian Sheedy59b06a82019-10-14 17:03:29 +0000692
693
Aaron Gable13101a62018-02-09 13:20:41 -0800694def print_stats(args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000695 """Prints statistics about the change to the user."""
696 # --no-ext-diff is broken in some versions of Git, so try to work around
697 # this by overriding the environment (but there is still a problem if the
698 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000699 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000700 if 'GIT_EXTERNAL_DIFF' in env:
701 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000702
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000703 return subprocess2.call(
Aaron Gable13101a62018-02-09 13:20:41 -0800704 ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args,
Edward Lemur0db01f02019-11-12 22:01:51 +0000705 env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000706
707
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000708class BuildbucketResponseException(Exception):
709 pass
710
711
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000712class Settings(object):
713 def __init__(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000714 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000715 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000716 self.tree_status_url = None
717 self.viewvc_url = None
718 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000719 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000720 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000721 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000722 self.git_editor = None
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000723 self.format_full_by_default = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000724
Edward Lemur26964072020-02-19 19:18:51 +0000725 def _LazyUpdateIfNeeded(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000726 """Updates the settings from a codereview.settings file, if available."""
Edward Lemur26964072020-02-19 19:18:51 +0000727 if self.updated:
728 return
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000729
Edward Lemur26964072020-02-19 19:18:51 +0000730 # The only value that actually changes the behavior is
731 # autoupdate = "false". Everything else means "true".
732 autoupdate = (
733 scm.GIT.GetConfig(self.GetRoot(), 'rietveld.autoupdate', '').lower())
734
735 cr_settings_file = FindCodereviewSettingsFile()
736 if autoupdate != 'false' and cr_settings_file:
737 LoadCodereviewSettingsFromFile(cr_settings_file)
738 cr_settings_file.close()
739
740 self.updated = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000741
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000742 @staticmethod
743 def GetRelativeRoot():
Edward Lesmes50da7702020-03-30 19:23:43 +0000744 return scm.GIT.GetCheckoutRoot('.')
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000745
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000746 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000747 if self.root is None:
748 self.root = os.path.abspath(self.GetRelativeRoot())
749 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000750
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000751 def GetTreeStatusUrl(self, error_ok=False):
752 if not self.tree_status_url:
Edward Lemur26964072020-02-19 19:18:51 +0000753 self.tree_status_url = self._GetConfig('rietveld.tree-status-url')
754 if self.tree_status_url is None and not error_ok:
755 DieWithError(
756 'You must configure your tree status URL by running '
757 '"git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000758 return self.tree_status_url
759
760 def GetViewVCUrl(self):
761 if not self.viewvc_url:
Edward Lemur26964072020-02-19 19:18:51 +0000762 self.viewvc_url = self._GetConfig('rietveld.viewvc-url')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000763 return self.viewvc_url
764
rmistry@google.com90752582014-01-14 21:04:50 +0000765 def GetBugPrefix(self):
Edward Lemur26964072020-02-19 19:18:51 +0000766 return self._GetConfig('rietveld.bug-prefix')
rmistry@google.com78948ed2015-07-08 23:09:57 +0000767
rmistry@google.com5626a922015-02-26 14:03:30 +0000768 def GetRunPostUploadHook(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000769 run_post_upload_hook = self._GetConfig(
Edward Lemur26964072020-02-19 19:18:51 +0000770 'rietveld.run-post-upload-hook')
rmistry@google.com5626a922015-02-26 14:03:30 +0000771 return run_post_upload_hook == "True"
772
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000773 def GetDefaultCCList(self):
Edward Lemur26964072020-02-19 19:18:51 +0000774 return self._GetConfig('rietveld.cc')
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000775
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000776 def GetSquashGerritUploads(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000777 """Returns True if uploads to Gerrit should be squashed by default."""
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000778 if self.squash_gerrit_uploads is None:
Edward Lesmes4de54132020-05-05 19:41:33 +0000779 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
780 if self.squash_gerrit_uploads is None:
Edward Lemur26964072020-02-19 19:18:51 +0000781 # Default is squash now (http://crbug.com/611892#c23).
782 self.squash_gerrit_uploads = self._GetConfig(
783 'gerrit.squash-uploads').lower() != 'false'
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000784 return self.squash_gerrit_uploads
785
Edward Lesmes4de54132020-05-05 19:41:33 +0000786 def GetSquashGerritUploadsOverride(self):
787 """Return True or False if codereview.settings should be overridden.
788
789 Returns None if no override has been defined.
790 """
791 # See also http://crbug.com/611892#c23
792 result = self._GetConfig('gerrit.override-squash-uploads').lower()
793 if result == 'true':
794 return True
795 if result == 'false':
796 return False
797 return None
798
tandrii@chromium.org28253532016-04-14 13:46:56 +0000799 def GetGerritSkipEnsureAuthenticated(self):
800 """Return True if EnsureAuthenticated should not be done for Gerrit
801 uploads."""
802 if self.gerrit_skip_ensure_authenticated is None:
Edward Lemur26964072020-02-19 19:18:51 +0000803 self.gerrit_skip_ensure_authenticated = self._GetConfig(
804 'gerrit.skip-ensure-authenticated').lower() == 'true'
tandrii@chromium.org28253532016-04-14 13:46:56 +0000805 return self.gerrit_skip_ensure_authenticated
806
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000807 def GetGitEditor(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000808 """Returns the editor specified in the git config, or None if none is."""
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000809 if self.git_editor is None:
Raul Tambre5a525872019-02-12 19:08:08 +0000810 # Git requires single quotes for paths with spaces. We need to replace
811 # them with double quotes for Windows to treat such paths as a single
812 # path.
Edward Lemur26964072020-02-19 19:18:51 +0000813 self.git_editor = self._GetConfig('core.editor').replace('\'', '"')
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000814 return self.git_editor or None
815
thestig@chromium.org44202a22014-03-11 19:22:18 +0000816 def GetLintRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000817 return self._GetConfig('rietveld.cpplint-regex', DEFAULT_LINT_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000818
819 def GetLintIgnoreRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000820 return self._GetConfig(
821 'rietveld.cpplint-ignore-regex', DEFAULT_LINT_IGNORE_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000822
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000823 def GetFormatFullByDefault(self):
824 if self.format_full_by_default is None:
825 result = (
826 RunGit(['config', '--bool', 'rietveld.format-full-by-default'],
827 error_ok=True).strip())
828 self.format_full_by_default = (result == 'true')
829 return self.format_full_by_default
830
Edward Lemur26964072020-02-19 19:18:51 +0000831 def _GetConfig(self, key, default=''):
832 self._LazyUpdateIfNeeded()
833 return scm.GIT.GetConfig(self.GetRoot(), key, default)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000834
835
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000836class _CQState(object):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +0000837 """Enum for states of CL with respect to CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000838 NONE = 'none'
839 DRY_RUN = 'dry_run'
840 COMMIT = 'commit'
841
842 ALL_STATES = [NONE, DRY_RUN, COMMIT]
843
844
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000845class _ParsedIssueNumberArgument(object):
Edward Lemurf38bc172019-09-03 21:02:13 +0000846 def __init__(self, issue=None, patchset=None, hostname=None):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000847 self.issue = issue
848 self.patchset = patchset
849 self.hostname = hostname
850
851 @property
852 def valid(self):
853 return self.issue is not None
854
855
Edward Lemurf38bc172019-09-03 21:02:13 +0000856def ParseIssueNumberArgument(arg):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000857 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
858 fail_result = _ParsedIssueNumberArgument()
859
Edward Lemur678a6842019-10-03 22:25:05 +0000860 if isinstance(arg, int):
861 return _ParsedIssueNumberArgument(issue=arg)
862 if not isinstance(arg, basestring):
863 return fail_result
864
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000865 if arg.isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +0000866 return _ParsedIssueNumberArgument(issue=int(arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000867 if not arg.startswith('http'):
868 return fail_result
Aaron Gableaee6c852017-06-26 12:49:01 -0700869
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000870 url = gclient_utils.UpgradeToHttps(arg)
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000871 for gerrit_url, short_url in _KNOWN_GERRIT_TO_SHORT_URLS.items():
872 if url.startswith(short_url):
873 url = gerrit_url + url[len(short_url):]
874 break
875
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000876 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000877 parsed_url = urllib.parse.urlparse(url)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000878 except ValueError:
879 return fail_result
Andrii Shyshkalov28d840e2017-04-10 15:45:09 +0200880
Edward Lemur678a6842019-10-03 22:25:05 +0000881 # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]]
882 # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]]
883 # Short urls like https://domain/<issue_number> can be used, but don't allow
884 # specifying the patchset (you'd 404), but we allow that here.
885 if parsed_url.path == '/':
886 part = parsed_url.fragment
887 else:
888 part = parsed_url.path
889
890 match = re.match(
891 r'(/c(/.*/\+)?)?/(?P<issue>\d+)(/(?P<patchset>\d+)?/?)?$', part)
892 if not match:
893 return fail_result
894
895 issue = int(match.group('issue'))
896 patchset = match.group('patchset')
897 return _ParsedIssueNumberArgument(
898 issue=issue,
899 patchset=int(patchset) if patchset else None,
900 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000901
902
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000903def _create_description_from_log(args):
904 """Pulls out the commit log to use as a base for the CL description."""
905 log_args = []
906 if len(args) == 1 and not args[0].endswith('.'):
907 log_args = [args[0] + '..']
908 elif len(args) == 1 and args[0].endswith('...'):
909 log_args = [args[0][:-1]]
910 elif len(args) == 2:
911 log_args = [args[0] + '..' + args[1]]
912 else:
913 log_args = args[:] # Hope for the best!
Manh Nguyene3644862020-08-05 18:25:46 +0000914 return RunGit(['log', '--pretty=format:%B%n'] + log_args)
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000915
916
Aaron Gablea45ee112016-11-22 15:14:38 -0800917class GerritChangeNotExists(Exception):
tandriic2405f52016-10-10 08:13:15 -0700918 def __init__(self, issue, url):
919 self.issue = issue
920 self.url = url
Aaron Gablea45ee112016-11-22 15:14:38 -0800921 super(GerritChangeNotExists, self).__init__()
tandriic2405f52016-10-10 08:13:15 -0700922
923 def __str__(self):
Aaron Gablea45ee112016-11-22 15:14:38 -0800924 return 'change %s at %s does not exist or you have no access to it' % (
tandriic2405f52016-10-10 08:13:15 -0700925 self.issue, self.url)
926
927
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100928_CommentSummary = collections.namedtuple(
Quinten Yearsley0e617c02019-02-20 00:37:03 +0000929 '_CommentSummary', ['date', 'message', 'sender', 'autogenerated',
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100930 # TODO(tandrii): these two aren't known in Gerrit.
931 'approval', 'disapproval'])
932
933
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000934class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000935 """Changelist works with one changelist in local branch.
936
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +0000937 Notes:
938 * Not safe for concurrent multi-{thread,process} use.
939 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -0700940 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000941 """
942
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000943 def __init__(self,
944 branchref=None,
945 issue=None,
946 codereview_host=None,
947 commit_date=None):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000948 """Create a new ChangeList instance.
949
Edward Lemurf38bc172019-09-03 21:02:13 +0000950 **kwargs will be passed directly to Gerrit implementation.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000951 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000952 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +0000953 global settings
954 if not settings:
955 # Happens when git_cl.py is used as a utility library.
956 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000957
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000958 self.branchref = branchref
959 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000960 assert branchref.startswith('refs/heads/')
Edward Lemur85153282020-02-14 22:06:29 +0000961 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000962 else:
963 self.branch = None
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000964 self.commit_date = commit_date
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000965 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +0000966 self.lookedup_issue = False
967 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000968 self.description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +0000969 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000970 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000971 self.cc = None
Daniel Cheng7227d212017-11-17 08:12:37 -0800972 self.more_cc = []
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000973 self._remote = None
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +0000974 self._cached_remote_url = (False, None) # (is_cached, value)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000975
Edward Lemur125d60a2019-09-13 18:25:41 +0000976 # Lazily cached values.
977 self._gerrit_host = None # e.g. chromium-review.googlesource.com
978 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
Edward Lesmese1576912021-02-16 21:53:34 +0000979 self._owners_client = None
Edward Lemur125d60a2019-09-13 18:25:41 +0000980 # Map from change number (issue) to its detail cache.
981 self._detail_cache = {}
982
983 if codereview_host is not None:
984 assert not codereview_host.startswith('https://'), codereview_host
985 self._gerrit_host = codereview_host
986 self._gerrit_server = 'https://%s' % codereview_host
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000987
Edward Lesmese1576912021-02-16 21:53:34 +0000988 @property
989 def owners_client(self):
990 if self._owners_client is None:
991 remote, remote_branch = self.GetRemoteBranch()
992 branch = GetTargetRef(remote, remote_branch, None)
993 self._owners_client = owners_client.GetCodeOwnersClient(
994 root=settings.GetRoot(),
Edward Lesmes1eaaab52021-03-02 23:52:54 +0000995 upstream=self.GetCommonAncestorWithUpstream(),
Edward Lesmese1576912021-02-16 21:53:34 +0000996 host=self.GetGerritHost(),
997 project=self.GetGerritProject(),
998 branch=branch)
999 return self._owners_client
1000
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001001 def GetCCList(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001002 """Returns the users cc'd on this CL.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001003
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001004 The return value is a string suitable for passing to git cl with the --cc
1005 flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001006 """
1007 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001008 base_cc = settings.GetDefaultCCList()
Daniel Cheng7227d212017-11-17 08:12:37 -08001009 more_cc = ','.join(self.more_cc)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001010 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1011 return self.cc
1012
Daniel Cheng7227d212017-11-17 08:12:37 -08001013 def ExtendCC(self, more_cc):
1014 """Extends the list of users to cc on this CL based on the changed files."""
1015 self.more_cc.extend(more_cc)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001016
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00001017 def GetCommitDate(self):
1018 """Returns the commit date as provided in the constructor"""
1019 return self.commit_date
1020
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001021 def GetBranch(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001022 """Returns the short branch name, e.g. 'main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001023 if not self.branch:
Edward Lemur85153282020-02-14 22:06:29 +00001024 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001025 if not branchref:
1026 return None
1027 self.branchref = branchref
Edward Lemur85153282020-02-14 22:06:29 +00001028 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001029 return self.branch
1030
1031 def GetBranchRef(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001032 """Returns the full branch name, e.g. 'refs/heads/main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001033 self.GetBranch() # Poke the lazy loader.
1034 return self.branchref
1035
Edward Lemur85153282020-02-14 22:06:29 +00001036 def _GitGetBranchConfigValue(self, key, default=None):
1037 return scm.GIT.GetBranchConfig(
1038 settings.GetRoot(), self.GetBranch(), key, default)
tandrii5d48c322016-08-18 16:19:37 -07001039
Edward Lemur85153282020-02-14 22:06:29 +00001040 def _GitSetBranchConfigValue(self, key, value):
1041 action = 'set %s to %r' % (key, value)
1042 if not value:
1043 action = 'unset %s' % key
1044 assert self.GetBranch(), 'a branch is needed to ' + action
1045 return scm.GIT.SetBranchConfig(
1046 settings.GetRoot(), self.GetBranch(), key, value)
tandrii5d48c322016-08-18 16:19:37 -07001047
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001048 @staticmethod
1049 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001050 """Returns a tuple containing remote and remote ref,
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001051 e.g. 'origin', 'refs/heads/main'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001052 """
Edward Lemur15a9b8c2020-02-13 00:52:30 +00001053 remote, upstream_branch = scm.GIT.FetchUpstreamTuple(
1054 settings.GetRoot(), branch)
1055 if not remote or not upstream_branch:
1056 DieWithError(
1057 'Unable to determine default branch to diff against.\n'
Josip Sokcevicb038f722021-01-06 18:28:11 +00001058 'Verify this branch is set up to track another \n'
1059 '(via the --track argument to "git checkout -b ..."). \n'
1060 'or pass complete "git diff"-style arguments if supported, like\n'
1061 ' git cl upload origin/main\n')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001062
1063 return remote, upstream_branch
1064
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001065 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001066 upstream_branch = self.GetUpstreamBranch()
Edward Lesmes50da7702020-03-30 19:23:43 +00001067 if not scm.GIT.IsValidRevision(settings.GetRoot(), upstream_branch):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001068 DieWithError('The upstream for the current branch (%s) does not exist '
1069 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001070 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001071 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001072
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001073 def GetUpstreamBranch(self):
1074 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001075 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Raul Tambrefe1dbe12019-05-02 04:43:57 +00001076 if remote != '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001077 upstream_branch = upstream_branch.replace('refs/heads/',
1078 'refs/remotes/%s/' % remote)
1079 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1080 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001081 self.upstream_branch = upstream_branch
1082 return self.upstream_branch
1083
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001084 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001085 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001086 remote, branch = None, self.GetBranch()
1087 seen_branches = set()
1088 while branch not in seen_branches:
1089 seen_branches.add(branch)
1090 remote, branch = self.FetchUpstreamTuple(branch)
Edward Lemur85153282020-02-14 22:06:29 +00001091 branch = scm.GIT.ShortBranchName(branch)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001092 if remote != '.' or branch.startswith('refs/remotes'):
1093 break
1094 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001095 remotes = RunGit(['remote'], error_ok=True).split()
1096 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001097 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001098 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001099 remote = 'origin'
Gavin Make6a62332020-12-04 21:57:10 +00001100 logging.warning('Could not determine which remote this change is '
1101 'associated with, so defaulting to "%s".' %
1102 self._remote)
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001103 else:
Gavin Make6a62332020-12-04 21:57:10 +00001104 logging.warning('Could not determine which remote this change is '
1105 'associated with.')
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001106 branch = 'HEAD'
1107 if branch.startswith('refs/remotes'):
1108 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001109 elif branch.startswith('refs/branch-heads/'):
1110 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001111 else:
1112 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001113 return self._remote
1114
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001115 def GetRemoteUrl(self):
1116 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1117
1118 Returns None if there is no remote.
1119 """
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001120 is_cached, value = self._cached_remote_url
1121 if is_cached:
1122 return value
1123
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001124 remote, _ = self.GetRemoteBranch()
Edward Lemur26964072020-02-19 19:18:51 +00001125 url = scm.GIT.GetConfig(settings.GetRoot(), 'remote.%s.url' % remote, '')
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001126
Edward Lemur298f2cf2019-02-22 21:40:39 +00001127 # Check if the remote url can be parsed as an URL.
Edward Lemur79d4f992019-11-11 23:49:02 +00001128 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001129 if host:
1130 self._cached_remote_url = (True, url)
1131 return url
1132
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001133 # If it cannot be parsed as an url, assume it is a local directory,
1134 # probably a git cache.
Edward Lemur298f2cf2019-02-22 21:40:39 +00001135 logging.warning('"%s" doesn\'t appear to point to a git host. '
1136 'Interpreting it as a local directory.', url)
1137 if not os.path.isdir(url):
1138 logging.error(
Josip906bfde2020-01-31 22:38:49 +00001139 'Remote "%(remote)s" for branch "%(branch)s" points to "%(url)s", '
1140 'but it doesn\'t exist.',
1141 {'remote': remote, 'branch': self.GetBranch(), 'url': url})
Edward Lemur298f2cf2019-02-22 21:40:39 +00001142 return None
1143
1144 cache_path = url
Edward Lemur26964072020-02-19 19:18:51 +00001145 url = scm.GIT.GetConfig(url, 'remote.%s.url' % remote, '')
Edward Lemur298f2cf2019-02-22 21:40:39 +00001146
Edward Lemur79d4f992019-11-11 23:49:02 +00001147 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001148 if not host:
1149 logging.error(
1150 'Remote "%(remote)s" for branch "%(branch)s" points to '
1151 '"%(cache_path)s", but it is misconfigured.\n'
1152 '"%(cache_path)s" must be a git repo and must have a remote named '
1153 '"%(remote)s" pointing to the git host.', {
1154 'remote': remote,
1155 'cache_path': cache_path,
1156 'branch': self.GetBranch()})
1157 return None
1158
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001159 self._cached_remote_url = (True, url)
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001160 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001161
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001162 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001163 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001164 if self.issue is None and not self.lookedup_issue:
Edward Lesmes50da7702020-03-30 19:23:43 +00001165 self.issue = self._GitGetBranchConfigValue(ISSUE_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001166 if self.issue is not None:
1167 self.issue = int(self.issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001168 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001169 return self.issue
1170
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001171 def GetIssueURL(self, short=False):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001172 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001173 issue = self.GetIssue()
1174 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001175 return None
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001176 server = self.GetCodereviewServer()
1177 if short:
1178 server = _KNOWN_GERRIT_TO_SHORT_URLS.get(server, server)
1179 return '%s/%s' % (server, issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001180
Edward Lemur6c6827c2020-02-06 21:15:18 +00001181 def FetchDescription(self, pretty=False):
1182 assert self.GetIssue(), 'issue is required to query Gerrit'
1183
Edward Lemur9aa1a962020-02-25 00:58:38 +00001184 if self.description is None:
Edward Lemur6c6827c2020-02-06 21:15:18 +00001185 data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
1186 current_rev = data['current_revision']
1187 self.description = data['revisions'][current_rev]['commit']['message']
Edward Lemur6c6827c2020-02-06 21:15:18 +00001188
1189 if not pretty:
1190 return self.description
1191
1192 # Set width to 72 columns + 2 space indent.
1193 wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True)
1194 wrapper.initial_indent = wrapper.subsequent_indent = ' '
1195 lines = self.description.splitlines()
1196 return '\n'.join([wrapper.fill(line) for line in lines])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001197
1198 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001199 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001200 if self.patchset is None and not self.lookedup_patchset:
Edward Lesmes50da7702020-03-30 19:23:43 +00001201 self.patchset = self._GitGetBranchConfigValue(PATCHSET_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001202 if self.patchset is not None:
1203 self.patchset = int(self.patchset)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001204 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001205 return self.patchset
1206
Edward Lemur9aa1a962020-02-25 00:58:38 +00001207 def GetAuthor(self):
1208 return scm.GIT.GetConfig(settings.GetRoot(), 'user.email')
1209
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001210 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001211 """Set this branch's patchset. If patchset=0, clears the patchset."""
1212 assert self.GetBranch()
1213 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001214 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001215 else:
1216 self.patchset = int(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00001217 self._GitSetBranchConfigValue(PATCHSET_CONFIG_KEY, str(self.patchset))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001218
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001219 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001220 """Set this branch's issue. If issue isn't given, clears the issue."""
1221 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001222 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001223 issue = int(issue)
Edward Lesmes50da7702020-03-30 19:23:43 +00001224 self._GitSetBranchConfigValue(ISSUE_CONFIG_KEY, str(issue))
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001225 self.issue = issue
Edward Lemur125d60a2019-09-13 18:25:41 +00001226 codereview_server = self.GetCodereviewServer()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001227 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001228 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001229 CODEREVIEW_SERVER_CONFIG_KEY, codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001230 else:
tandrii5d48c322016-08-18 16:19:37 -07001231 # Reset all of these just to be clean.
1232 reset_suffixes = [
1233 'last-upload-hash',
Edward Lesmes50da7702020-03-30 19:23:43 +00001234 ISSUE_CONFIG_KEY,
1235 PATCHSET_CONFIG_KEY,
1236 CODEREVIEW_SERVER_CONFIG_KEY,
1237 'gerritsquashhash',
1238 ]
tandrii5d48c322016-08-18 16:19:37 -07001239 for prop in reset_suffixes:
Edward Lemur85153282020-02-14 22:06:29 +00001240 try:
1241 self._GitSetBranchConfigValue(prop, None)
1242 except subprocess2.CalledProcessError:
1243 pass
Aaron Gableca01e2c2017-07-19 11:16:02 -07001244 msg = RunGit(['log', '-1', '--format=%B']).strip()
1245 if msg and git_footers.get_footer_change_id(msg):
1246 print('WARNING: The change patched into this branch has a Change-Id. '
1247 'Removing it.')
1248 RunGit(['commit', '--amend', '-m',
1249 git_footers.remove_footer(msg, 'Change-Id')])
Edward Lemurf38bc172019-09-03 21:02:13 +00001250 self.lookedup_issue = True
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001251 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001252 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001253
Edward Lemur2c62b332020-03-12 22:12:33 +00001254 def GetAffectedFiles(self, upstream):
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001255 try:
Edward Lemur2c62b332020-03-12 22:12:33 +00001256 return [f for _, f in scm.GIT.CaptureStatus(settings.GetRoot(), upstream)]
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001257 except subprocess2.CalledProcessError:
1258 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001259 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001260 'This branch probably doesn\'t exist anymore. To reset the\n'
1261 'tracking branch, please run\n'
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001262 ' git branch --set-upstream-to origin/main %s\n'
1263 'or replace origin/main with the relevant branch') %
Edward Lemur2c62b332020-03-12 22:12:33 +00001264 (upstream, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001265
dsansomee2d6fd92016-09-08 00:10:47 -07001266 def UpdateDescription(self, description, force=False):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001267 assert self.GetIssue(), 'issue is required to update description'
1268
1269 if gerrit_util.HasPendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001270 self.GetGerritHost(), self._GerritChangeIdentifier()):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001271 if not force:
1272 confirm_or_exit(
1273 'The description cannot be modified while the issue has a pending '
1274 'unpublished edit. Either publish the edit in the Gerrit web UI '
1275 'or delete it.\n\n', action='delete the unpublished edit')
1276
1277 gerrit_util.DeletePendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001278 self.GetGerritHost(), self._GerritChangeIdentifier())
Edward Lemur6c6827c2020-02-06 21:15:18 +00001279 gerrit_util.SetCommitMessage(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001280 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur6c6827c2020-02-06 21:15:18 +00001281 description, notify='NONE')
1282
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001283 self.description = description
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001284
Edward Lemur75526302020-02-27 22:31:05 +00001285 def _GetCommonPresubmitArgs(self, verbose, upstream):
Edward Lemur227d5102020-02-25 23:45:35 +00001286 args = [
Edward Lemur227d5102020-02-25 23:45:35 +00001287 '--root', settings.GetRoot(),
1288 '--upstream', upstream,
1289 ]
1290
1291 args.extend(['--verbose'] * verbose)
1292
Edward Lesmeseb1bd622021-03-01 19:54:07 +00001293 remote, remote_branch = self.GetRemoteBranch()
1294 target_ref = GetTargetRef(remote, remote_branch, None)
1295 args.extend(['--gerrit_url', self.GetCodereviewServer()])
1296 args.extend(['--gerrit_project', self.GetGerritProject()])
1297 args.extend(['--gerrit_branch', target_ref])
1298
Edward Lemur99df04e2020-03-05 19:39:43 +00001299 author = self.GetAuthor()
Edward Lemur227d5102020-02-25 23:45:35 +00001300 issue = self.GetIssue()
1301 patchset = self.GetPatchset()
Edward Lemur99df04e2020-03-05 19:39:43 +00001302 if author:
1303 args.extend(['--author', author])
Edward Lemur227d5102020-02-25 23:45:35 +00001304 if issue:
1305 args.extend(['--issue', str(issue)])
1306 if patchset:
1307 args.extend(['--patchset', str(patchset)])
Edward Lemur227d5102020-02-25 23:45:35 +00001308
Edward Lemur75526302020-02-27 22:31:05 +00001309 return args
1310
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001311 def RunHook(self, committing, may_prompt, verbose, parallel, upstream,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001312 description, all_files, resultdb=False, realm=None):
Edward Lemur75526302020-02-27 22:31:05 +00001313 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1314 args = self._GetCommonPresubmitArgs(verbose, upstream)
1315 args.append('--commit' if committing else '--upload')
Edward Lemur227d5102020-02-25 23:45:35 +00001316 if may_prompt:
1317 args.append('--may_prompt')
1318 if parallel:
1319 args.append('--parallel')
1320 if all_files:
1321 args.append('--all_files')
1322
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001323 if resultdb and not realm:
1324 # TODO (crbug.com/1113463): store realm somewhere and look it up so
1325 # it is not required to pass the realm flag
1326 print('Note: ResultDB reporting will NOT be performed because --realm'
1327 ' was not specified. To enable ResultDB, please run the command'
1328 ' again with the --realm argument to specify the LUCI realm.')
1329
1330 py2_results = self._RunPresubmit(args, resultdb, realm, description,
1331 use_python3=False)
1332 py3_results = self._RunPresubmit(args, resultdb, realm, description,
1333 use_python3=True)
1334 return self._MergePresubmitResults(py2_results, py3_results)
1335
1336 def _RunPresubmit(self, args, resultdb, realm, description, use_python3):
1337 args = args[:]
1338 vpython = 'vpython3' if use_python3 else 'vpython'
1339
Edward Lemur227d5102020-02-25 23:45:35 +00001340 with gclient_utils.temporary_file() as description_file:
1341 with gclient_utils.temporary_file() as json_output:
Edward Lemur1a83da12020-03-04 21:18:36 +00001342 gclient_utils.FileWrite(description_file, description)
Edward Lemur227d5102020-02-25 23:45:35 +00001343 args.extend(['--json_output', json_output])
1344 args.extend(['--description_file', description_file])
1345
1346 start = time_time()
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001347 cmd = [vpython, PRESUBMIT_SUPPORT] + args
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001348 if resultdb and realm:
1349 cmd = ['rdb', 'stream', '-new', '-realm', realm, '--'] + cmd
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001350
1351 p = subprocess2.Popen(cmd)
Edward Lemur227d5102020-02-25 23:45:35 +00001352 exit_code = p.wait()
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001353
Edward Lemur227d5102020-02-25 23:45:35 +00001354 metrics.collector.add_repeated('sub_commands', {
1355 'command': 'presubmit',
1356 'execution_time': time_time() - start,
1357 'exit_code': exit_code,
1358 })
1359
1360 if exit_code:
1361 sys.exit(exit_code)
1362
1363 json_results = gclient_utils.FileRead(json_output)
1364 return json.loads(json_results)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001365
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001366 def _MergePresubmitResults(self, py2_results, py3_results):
1367 return {
1368 'more_cc': sorted(set(py2_results.get('more_cc', []) +
1369 py3_results.get('more_cc', []))),
1370 'errors': (
1371 py2_results.get('errors', []) + py3_results.get('errors', [])),
1372 'notifications': (
1373 py2_results.get('notifications', []) +
1374 py3_results.get('notifications', [])),
1375 'warnings': (
1376 py2_results.get('warnings', []) + py3_results.get('warnings', []))
1377 }
1378
Edward Lemur75526302020-02-27 22:31:05 +00001379 def RunPostUploadHook(self, verbose, upstream, description):
1380 args = self._GetCommonPresubmitArgs(verbose, upstream)
1381 args.append('--post_upload')
1382
1383 with gclient_utils.temporary_file() as description_file:
Edward Lemur1a83da12020-03-04 21:18:36 +00001384 gclient_utils.FileWrite(description_file, description)
Edward Lemur75526302020-02-27 22:31:05 +00001385 args.extend(['--description_file', description_file])
1386 p = subprocess2.Popen(['vpython', PRESUBMIT_SUPPORT] + args)
1387 p.wait()
1388
Edward Lemur5a644f82020-03-18 16:44:57 +00001389 def _GetDescriptionForUpload(self, options, git_diff_args, files):
1390 # Get description message for upload.
1391 if self.GetIssue():
1392 description = self.FetchDescription()
1393 elif options.message:
1394 description = options.message
1395 else:
1396 description = _create_description_from_log(git_diff_args)
1397 if options.title and options.squash:
Edward Lesmes0dd54822020-03-26 18:24:25 +00001398 description = options.title + '\n\n' + description
Edward Lemur5a644f82020-03-18 16:44:57 +00001399
1400 # Extract bug number from branch name.
1401 bug = options.bug
1402 fixed = options.fixed
1403 match = re.match(r'(?P<type>bug|fix(?:e[sd])?)[_-]?(?P<bugnum>\d+)',
1404 self.GetBranch())
1405 if not bug and not fixed and match:
1406 if match.group('type') == 'bug':
1407 bug = match.group('bugnum')
1408 else:
1409 fixed = match.group('bugnum')
1410
1411 change_description = ChangeDescription(description, bug, fixed)
1412
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001413 # Fill gaps in OWNERS coverage to tbrs/reviewers if requested.
1414 if options.add_owners_to:
1415 assert options.add_owners_to in ('TBR', 'R'), options.add_owners_to
Edward Lesmese1576912021-02-16 21:53:34 +00001416 status = self.owners_client.GetFilesApprovalStatus(
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001417 files, [], options.tbrs + options.reviewers)
1418 missing_files = [
1419 f for f in files
Edward Lesmese1576912021-02-16 21:53:34 +00001420 if status[f] == self._owners_client.INSUFFICIENT_REVIEWERS
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001421 ]
Edward Lesmese1576912021-02-16 21:53:34 +00001422 owners = self.owners_client.SuggestOwners(
1423 missing_files, exclude=[self.GetAuthor()])
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001424 if options.add_owners_to == 'TBR':
1425 assert isinstance(options.tbrs, list), options.tbrs
1426 options.tbrs.extend(owners)
1427 else:
1428 assert isinstance(options.reviewers, list), options.reviewers
1429 options.reviewers.extend(owners)
1430
Edward Lemur5a644f82020-03-18 16:44:57 +00001431 # Set the reviewer list now so that presubmit checks can access it.
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001432 if options.reviewers or options.tbrs:
1433 change_description.update_reviewers(options.reviewers, options.tbrs)
Edward Lemur5a644f82020-03-18 16:44:57 +00001434
1435 return change_description
1436
1437 def _GetTitleForUpload(self, options):
1438 # When not squashing, just return options.title.
1439 if not options.squash:
1440 return options.title
1441
1442 # On first upload, patchset title is always this string, while options.title
1443 # gets converted to first line of message.
1444 if not self.GetIssue():
1445 return 'Initial upload'
1446
1447 # When uploading subsequent patchsets, options.message is taken as the title
1448 # if options.title is not provided.
1449 if options.title:
1450 return options.title
1451 if options.message:
1452 return options.message.strip()
1453
1454 # Use the subject of the last commit as title by default.
Edward Lesmes50da7702020-03-30 19:23:43 +00001455 title = RunGit(['show', '-s', '--format=%s', 'HEAD']).strip()
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00001456 if options.force or options.skip_title:
Edward Lemur5a644f82020-03-18 16:44:57 +00001457 return title
Edward Lesmesae3586b2020-03-23 21:21:14 +00001458 user_title = gclient_utils.AskForData('Title for patchset [%s]: ' % title)
mlcui3da91712021-05-05 10:00:30 +00001459
1460 # Use the default title if the user confirms the default with a 'y'.
1461 if user_title.lower() == 'y':
1462 return title
Edward Lesmesae3586b2020-03-23 21:21:14 +00001463 return user_title or title
Edward Lemur5a644f82020-03-18 16:44:57 +00001464
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001465 def CMDUpload(self, options, git_diff_args, orig_args):
1466 """Uploads a change to codereview."""
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001467 custom_cl_base = None
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001468 if git_diff_args:
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001469 custom_cl_base = base_branch = git_diff_args[0]
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001470 else:
1471 if self.GetBranch() is None:
1472 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1473
1474 # Default to diffing against common ancestor of upstream branch
1475 base_branch = self.GetCommonAncestorWithUpstream()
1476 git_diff_args = [base_branch, 'HEAD']
1477
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001478 # Fast best-effort checks to abort before running potentially expensive
1479 # hooks if uploading is likely to fail anyway. Passing these checks does
1480 # not guarantee that uploading will not fail.
Edward Lemur125d60a2019-09-13 18:25:41 +00001481 self.EnsureAuthenticated(force=options.force)
1482 self.EnsureCanUploadPatchset(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001483
1484 # Apply watchlists on upload.
Edward Lemur2c62b332020-03-12 22:12:33 +00001485 watchlist = watchlists.Watchlists(settings.GetRoot())
1486 files = self.GetAffectedFiles(base_branch)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001487 if not options.bypass_watchlists:
Daniel Cheng7227d212017-11-17 08:12:37 -08001488 self.ExtendCC(watchlist.GetWatchersForPaths(files))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001489
Edward Lemur5a644f82020-03-18 16:44:57 +00001490 change_desc = self._GetDescriptionForUpload(options, git_diff_args, files)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001491 if not options.bypass_hooks:
Edward Lemur2c62b332020-03-12 22:12:33 +00001492 hook_results = self.RunHook(
1493 committing=False,
1494 may_prompt=not options.force,
1495 verbose=options.verbose,
1496 parallel=options.parallel,
1497 upstream=base_branch,
Edward Lemur5a644f82020-03-18 16:44:57 +00001498 description=change_desc.description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001499 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001500 resultdb=options.resultdb,
1501 realm=options.realm)
Edward Lemur227d5102020-02-25 23:45:35 +00001502 self.ExtendCC(hook_results['more_cc'])
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001503
Aaron Gable13101a62018-02-09 13:20:41 -08001504 print_stats(git_diff_args)
Edward Lemura12175c2020-03-09 16:58:26 +00001505 ret = self.CMDUploadChange(
Edward Lemur5a644f82020-03-18 16:44:57 +00001506 options, git_diff_args, custom_cl_base, change_desc)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001507 if not ret:
Edward Lemur85153282020-02-14 22:06:29 +00001508 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001509 'last-upload-hash', scm.GIT.ResolveCommit(settings.GetRoot(), 'HEAD'))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001510 # Run post upload hooks, if specified.
1511 if settings.GetRunPostUploadHook():
Edward Lemur5a644f82020-03-18 16:44:57 +00001512 self.RunPostUploadHook(
1513 options.verbose, base_branch, change_desc.description)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001514
1515 # Upload all dependencies if specified.
1516 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001517 print()
1518 print('--dependencies has been specified.')
1519 print('All dependent local branches will be re-uploaded.')
1520 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001521 # Remove the dependencies flag from args so that we do not end up in a
1522 # loop.
1523 orig_args.remove('--dependencies')
Jose Lopes3863fc52020-04-07 17:00:25 +00001524 ret = upload_branch_deps(self, orig_args, options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001525 return ret
1526
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001527 def SetCQState(self, new_state):
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001528 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001529
1530 Issue must have been already uploaded and known.
1531 """
1532 assert new_state in _CQState.ALL_STATES
1533 assert self.GetIssue()
qyearsley1fdfcb62016-10-24 13:22:03 -07001534 try:
Edward Lemur125d60a2019-09-13 18:25:41 +00001535 vote_map = {
1536 _CQState.NONE: 0,
1537 _CQState.DRY_RUN: 1,
1538 _CQState.COMMIT: 2,
1539 }
1540 labels = {'Commit-Queue': vote_map[new_state]}
1541 notify = False if new_state == _CQState.DRY_RUN else None
1542 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001543 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur125d60a2019-09-13 18:25:41 +00001544 labels=labels, notify=notify)
qyearsley1fdfcb62016-10-24 13:22:03 -07001545 return 0
1546 except KeyboardInterrupt:
1547 raise
1548 except:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001549 print('WARNING: Failed to %s.\n'
qyearsley1fdfcb62016-10-24 13:22:03 -07001550 'Either:\n'
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001551 ' * Your project has no CQ,\n'
1552 ' * You don\'t have permission to change the CQ state,\n'
1553 ' * There\'s a bug in this code (see stack trace below).\n'
1554 'Consider specifying which bots to trigger manually or asking your '
1555 'project owners for permissions or contacting Chrome Infra at:\n'
1556 'https://www.chromium.org/infra\n\n' %
1557 ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ'))
qyearsley1fdfcb62016-10-24 13:22:03 -07001558 # Still raise exception so that stack trace is printed.
1559 raise
1560
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001561 def GetGerritHost(self):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001562 # Lazy load of configs.
1563 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07001564 if self._gerrit_host and '.' not in self._gerrit_host:
1565 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
1566 # This happens for internal stuff http://crbug.com/614312.
Edward Lemur79d4f992019-11-11 23:49:02 +00001567 parsed = urllib.parse.urlparse(self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001568 if parsed.scheme == 'sso':
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001569 print('WARNING: using non-https URLs for remote is likely broken\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001570 ' Your current remote is: %s' % self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001571 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
1572 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001573 return self._gerrit_host
1574
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001575 def _GetGitHost(self):
1576 """Returns git host to be used when uploading change to Gerrit."""
Edward Lemur298f2cf2019-02-22 21:40:39 +00001577 remote_url = self.GetRemoteUrl()
1578 if not remote_url:
1579 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001580 return urllib.parse.urlparse(remote_url).netloc
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001581
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001582 def GetCodereviewServer(self):
1583 if not self._gerrit_server:
1584 # If we're on a branch then get the server potentially associated
1585 # with that branch.
Edward Lemur85153282020-02-14 22:06:29 +00001586 if self.GetIssue() and self.GetBranch():
tandrii5d48c322016-08-18 16:19:37 -07001587 self._gerrit_server = self._GitGetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001588 CODEREVIEW_SERVER_CONFIG_KEY)
tandrii5d48c322016-08-18 16:19:37 -07001589 if self._gerrit_server:
Edward Lemur79d4f992019-11-11 23:49:02 +00001590 self._gerrit_host = urllib.parse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001591 if not self._gerrit_server:
1592 # We assume repo to be hosted on Gerrit, and hence Gerrit server
1593 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001594 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001595 parts[0] = parts[0] + '-review'
1596 self._gerrit_host = '.'.join(parts)
1597 self._gerrit_server = 'https://%s' % self._gerrit_host
1598 return self._gerrit_server
1599
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001600 def GetGerritProject(self):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001601 """Returns Gerrit project name based on remote git URL."""
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001602 remote_url = self.GetRemoteUrl()
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001603 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001604 logging.warning('can\'t detect Gerrit project.')
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001605 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001606 project = urllib.parse.urlparse(remote_url).path.strip('/')
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001607 if project.endswith('.git'):
1608 project = project[:-len('.git')]
Andrii Shyshkalov1e828672018-08-23 22:34:37 +00001609 # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with
1610 # 'a/' prefix, because 'a/' prefix is used to force authentication in
1611 # gitiles/git-over-https protocol. E.g.,
1612 # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project
1613 # as
1614 # https://chromium.googlesource.com/v8/v8
1615 if project.startswith('a/'):
1616 project = project[len('a/'):]
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001617 return project
1618
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001619 def _GerritChangeIdentifier(self):
1620 """Handy method for gerrit_util.ChangeIdentifier for a given CL.
1621
1622 Not to be confused by value of "Change-Id:" footer.
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001623 If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC.
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001624 """
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001625 project = self.GetGerritProject()
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001626 if project:
1627 return gerrit_util.ChangeIdentifier(project, self.GetIssue())
1628 # Fall back on still unique, but less efficient change number.
1629 return str(self.GetIssue())
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001630
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001631 def EnsureAuthenticated(self, force, refresh=None):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001632 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00001633 if settings.GetGerritSkipEnsureAuthenticated():
1634 # For projects with unusual authentication schemes.
1635 # See http://crbug.com/603378.
1636 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001637
1638 # Check presence of cookies only if using cookies-based auth method.
1639 cookie_auth = gerrit_util.Authenticator.get()
1640 if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001641 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001642
Florian Mayerae510e82020-01-30 21:04:48 +00001643 remote_url = self.GetRemoteUrl()
1644 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001645 logging.warning('invalid remote')
Florian Mayerae510e82020-01-30 21:04:48 +00001646 return
1647 if urllib.parse.urlparse(remote_url).scheme != 'https':
Josip906bfde2020-01-31 22:38:49 +00001648 logging.warning('Ignoring branch %(branch)s with non-https remote '
1649 '%(remote)s', {
1650 'branch': self.branch,
1651 'remote': self.GetRemoteUrl()
1652 })
Daniel Chengcf6269b2019-05-18 01:02:12 +00001653 return
1654
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001655 # Lazy-loader to identify Gerrit and Git hosts.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001656 self.GetCodereviewServer()
1657 git_host = self._GetGitHost()
Edward Lemur298f2cf2019-02-22 21:40:39 +00001658 assert self._gerrit_server and self._gerrit_host and git_host
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001659
1660 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
1661 git_auth = cookie_auth.get_auth_header(git_host)
1662 if gerrit_auth and git_auth:
1663 if gerrit_auth == git_auth:
1664 return
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001665 all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com')
Raul Tambre80ee78e2019-05-06 22:41:05 +00001666 print(
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001667 'WARNING: You have different credentials for Gerrit and git hosts:\n'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001668 ' %s\n'
1669 ' %s\n'
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001670 ' Consider running the following command:\n'
1671 ' git cl creds-check\n'
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001672 ' %s\n'
Raul Tambre80ee78e2019-05-06 22:41:05 +00001673 ' %s' %
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001674 (git_host, self._gerrit_host,
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001675 ('Hint: delete creds for .googlesource.com' if all_gsrc else ''),
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001676 cookie_auth.get_new_password_message(git_host)))
1677 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001678 confirm_or_exit('If you know what you are doing', action='continue')
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001679 return
1680 else:
1681 missing = (
Anna Henningsen4e891442017-07-06 21:40:58 +02001682 ([] if gerrit_auth else [self._gerrit_host]) +
1683 ([] if git_auth else [git_host]))
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001684 DieWithError('Credentials for the following hosts are required:\n'
1685 ' %s\n'
1686 'These are read from %s (or legacy %s)\n'
1687 '%s' % (
1688 '\n '.join(missing),
1689 cookie_auth.get_gitcookies_path(),
1690 cookie_auth.get_netrc_path(),
1691 cookie_auth.get_new_password_message(git_host)))
1692
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001693 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001694 if not self.GetIssue():
1695 return
1696
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001697 status = self._GetChangeDetail()['status']
1698 if status in ('MERGED', 'ABANDONED'):
1699 DieWithError('Change %s has been %s, new uploads are not allowed' %
1700 (self.GetIssueURL(),
1701 'submitted' if status == 'MERGED' else 'abandoned'))
1702
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001703 # TODO(vadimsh): For some reason the chunk of code below was skipped if
1704 # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'.
1705 # Apparently this check is not very important? Otherwise get_auth_email
1706 # could have been added to other implementations of Authenticator.
1707 cookies_auth = gerrit_util.Authenticator.get()
1708 if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator):
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001709 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001710
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001711 cookies_user = cookies_auth.get_auth_email(self.GetGerritHost())
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001712 if self.GetIssueOwner() == cookies_user:
1713 return
1714 logging.debug('change %s owner is %s, cookies user is %s',
1715 self.GetIssue(), self.GetIssueOwner(), cookies_user)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001716 # Maybe user has linked accounts or something like that,
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001717 # so ask what Gerrit thinks of this user.
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001718 details = gerrit_util.GetAccountDetails(self.GetGerritHost(), 'self')
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001719 if details['email'] == self.GetIssueOwner():
1720 return
1721 if not force:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001722 print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit '
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001723 'as %s.\n'
1724 'Uploading may fail due to lack of permissions.' %
1725 (self.GetIssue(), self.GetIssueOwner(), details['email']))
1726 confirm_or_exit(action='upload')
1727
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001728 def GetStatus(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001729 """Applies a rough heuristic to give a simple summary of an issue's review
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001730 or CQ status, assuming adherence to a common workflow.
1731
1732 Returns None if no issue for this branch, or one of the following keywords:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001733 * 'error' - error from review tool (including deleted issues)
1734 * 'unsent' - no reviewers added
1735 * 'waiting' - waiting for review
1736 * 'reply' - waiting for uploader to reply to review
1737 * 'lgtm' - Code-Review label has been set
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001738 * 'dry-run' - dry-running in the CQ
1739 * 'commit' - in the CQ
Aaron Gable9ab38c62017-04-06 14:36:33 -07001740 * 'closed' - successfully submitted or abandoned
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001741 """
1742 if not self.GetIssue():
1743 return None
1744
1745 try:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001746 data = self._GetChangeDetail([
1747 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE'])
Edward Lemur79d4f992019-11-11 23:49:02 +00001748 except GerritChangeNotExists:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001749 return 'error'
1750
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00001751 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001752 return 'closed'
1753
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001754 cq_label = data['labels'].get('Commit-Queue', {})
1755 max_cq_vote = 0
1756 for vote in cq_label.get('all', []):
1757 max_cq_vote = max(max_cq_vote, vote.get('value', 0))
1758 if max_cq_vote == 2:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001759 return 'commit'
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001760 if max_cq_vote == 1:
1761 return 'dry-run'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001762
Aaron Gable9ab38c62017-04-06 14:36:33 -07001763 if data['labels'].get('Code-Review', {}).get('approved'):
1764 return 'lgtm'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001765
1766 if not data.get('reviewers', {}).get('REVIEWER', []):
1767 return 'unsent'
1768
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001769 owner = data['owner'].get('_account_id')
Edward Lemur79d4f992019-11-11 23:49:02 +00001770 messages = sorted(data.get('messages', []), key=lambda m: m.get('date'))
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001771 while messages:
1772 m = messages.pop()
1773 if m.get('tag', '').startswith('autogenerated:cq:'):
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001774 # Ignore replies from CQ.
1775 continue
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001776 if m.get('author', {}).get('_account_id') == owner:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001777 # Most recent message was by owner.
1778 return 'waiting'
1779 else:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001780 # Some reply from non-owner.
1781 return 'reply'
Aaron Gable9ab38c62017-04-06 14:36:33 -07001782
1783 # Somehow there are no messages even though there are reviewers.
1784 return 'unsent'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001785
1786 def GetMostRecentPatchset(self):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001787 if not self.GetIssue():
1788 return None
1789
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001790 data = self._GetChangeDetail(['CURRENT_REVISION'])
Aaron Gablee8856ee2017-12-07 12:41:46 -08001791 patchset = data['revisions'][data['current_revision']]['_number']
1792 self.SetPatchset(patchset)
1793 return patchset
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001794
Gavin Make61ccc52020-11-13 00:12:57 +00001795 def GetMostRecentDryRunPatchset(self):
1796 """Get patchsets equivalent to the most recent patchset and return
1797 the patchset with the latest dry run. If none have been dry run, return
1798 the latest patchset."""
1799 if not self.GetIssue():
1800 return None
1801
1802 data = self._GetChangeDetail(['ALL_REVISIONS'])
1803 patchset = data['revisions'][data['current_revision']]['_number']
1804 dry_run = set([int(m['_revision_number'])
1805 for m in data.get('messages', [])
1806 if m.get('tag', '').endswith('dry-run')])
1807
1808 for revision_info in sorted(data.get('revisions', {}).values(),
1809 key=lambda c: c['_number'], reverse=True):
1810 if revision_info['_number'] in dry_run:
1811 patchset = revision_info['_number']
1812 break
1813 if revision_info.get('kind', '') not in \
1814 ('NO_CHANGE', 'NO_CODE_CHANGE', 'TRIVIAL_REBASE'):
1815 break
1816 self.SetPatchset(patchset)
1817 return patchset
1818
Aaron Gable636b13f2017-07-14 10:42:48 -07001819 def AddComment(self, message, publish=None):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001820 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001821 self.GetGerritHost(), self._GerritChangeIdentifier(),
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001822 msg=message, ready=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001823
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001824 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalov5a0cf202017-03-17 16:14:59 +01001825 # DETAILED_ACCOUNTS is to get emails in accounts.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001826 # CURRENT_REVISION is included to get the latest patchset so that
1827 # only the robot comments from the latest patchset can be shown.
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001828 messages = self._GetChangeDetail(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001829 options=['MESSAGES', 'DETAILED_ACCOUNTS',
1830 'CURRENT_REVISION']).get('messages', [])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001831 file_comments = gerrit_util.GetChangeComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001832 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001833 robot_file_comments = gerrit_util.GetChangeRobotComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001834 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001835
1836 # Add the robot comments onto the list of comments, but only
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +00001837 # keep those that are from the latest patchset.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001838 latest_patch_set = self.GetMostRecentPatchset()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001839 for path, robot_comments in robot_file_comments.items():
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001840 line_comments = file_comments.setdefault(path, [])
1841 line_comments.extend(
1842 [c for c in robot_comments if c['patch_set'] == latest_patch_set])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001843
1844 # Build dictionary of file comments for easy access and sorting later.
1845 # {author+date: {path: {patchset: {line: url+message}}}}
1846 comments = collections.defaultdict(
1847 lambda: collections.defaultdict(lambda: collections.defaultdict(dict)))
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001848
1849 server = self.GetCodereviewServer()
1850 if server in _KNOWN_GERRIT_TO_SHORT_URLS:
1851 # /c/ is automatically added by short URL server.
1852 url_prefix = '%s/%s' % (_KNOWN_GERRIT_TO_SHORT_URLS[server],
1853 self.GetIssue())
1854 else:
1855 url_prefix = '%s/c/%s' % (server, self.GetIssue())
1856
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001857 for path, line_comments in file_comments.items():
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001858 for comment in line_comments:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001859 tag = comment.get('tag', '')
1860 if tag.startswith('autogenerated') and 'robot_id' not in comment:
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001861 continue
1862 key = (comment['author']['email'], comment['updated'])
1863 if comment.get('side', 'REVISION') == 'PARENT':
1864 patchset = 'Base'
1865 else:
1866 patchset = 'PS%d' % comment['patch_set']
1867 line = comment.get('line', 0)
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001868 url = ('%s/%s/%s#%s%s' %
1869 (url_prefix, comment['patch_set'], path,
1870 'b' if comment.get('side') == 'PARENT' else '',
1871 str(line) if line else ''))
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001872 comments[key][path][patchset][line] = (url, comment['message'])
1873
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001874 summaries = []
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001875 for msg in messages:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001876 summary = self._BuildCommentSummary(msg, comments, readable)
1877 if summary:
1878 summaries.append(summary)
1879 return summaries
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001880
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001881 @staticmethod
1882 def _BuildCommentSummary(msg, comments, readable):
1883 key = (msg['author']['email'], msg['date'])
1884 # Don't bother showing autogenerated messages that don't have associated
1885 # file or line comments. this will filter out most autogenerated
1886 # messages, but will keep robot comments like those from Tricium.
1887 is_autogenerated = msg.get('tag', '').startswith('autogenerated')
1888 if is_autogenerated and not comments.get(key):
1889 return None
1890 message = msg['message']
1891 # Gerrit spits out nanoseconds.
1892 assert len(msg['date'].split('.')[-1]) == 9
1893 date = datetime.datetime.strptime(msg['date'][:-3],
1894 '%Y-%m-%d %H:%M:%S.%f')
1895 if key in comments:
1896 message += '\n'
1897 for path, patchsets in sorted(comments.get(key, {}).items()):
1898 if readable:
1899 message += '\n%s' % path
1900 for patchset, lines in sorted(patchsets.items()):
1901 for line, (url, content) in sorted(lines.items()):
1902 if line:
1903 line_str = 'Line %d' % line
1904 path_str = '%s:%d:' % (path, line)
1905 else:
1906 line_str = 'File comment'
1907 path_str = '%s:0:' % path
1908 if readable:
1909 message += '\n %s, %s: %s' % (patchset, line_str, url)
1910 message += '\n %s\n' % content
1911 else:
1912 message += '\n%s ' % path_str
1913 message += '\n%s\n' % content
1914
1915 return _CommentSummary(
1916 date=date,
1917 message=message,
1918 sender=msg['author']['email'],
1919 autogenerated=is_autogenerated,
1920 # These could be inferred from the text messages and correlated with
1921 # Code-Review label maximum, however this is not reliable.
1922 # Leaving as is until the need arises.
1923 approval=False,
1924 disapproval=False,
1925 )
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001926
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001927 def CloseIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001928 gerrit_util.AbandonChange(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001929 self.GetGerritHost(), self._GerritChangeIdentifier(), msg='')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001930
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001931 def SubmitIssue(self, wait_for_merge=True):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001932 gerrit_util.SubmitChange(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001933 self.GetGerritHost(), self._GerritChangeIdentifier(),
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001934 wait_for_merge=wait_for_merge)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001935
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001936 def _GetChangeDetail(self, options=None):
1937 """Returns details of associated Gerrit change and caching results."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00001938 options = options or []
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001939 assert self.GetIssue(), 'issue is required to query Gerrit'
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001940
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001941 # Optimization to avoid multiple RPCs:
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001942 if 'CURRENT_REVISION' in options or 'ALL_REVISIONS' in options:
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001943 options.append('CURRENT_COMMIT')
1944
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001945 # Normalize issue and options for consistent keys in cache.
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001946 cache_key = str(self.GetIssue())
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001947 options_set = frozenset(o.upper() for o in options)
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001948
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001949 for cached_options_set, data in self._detail_cache.get(cache_key, []):
1950 # Assumption: data fetched before with extra options is suitable
1951 # for return for a smaller set of options.
1952 # For example, if we cached data for
1953 # options=[CURRENT_REVISION, DETAILED_FOOTERS]
1954 # and request is for options=[CURRENT_REVISION],
1955 # THEN we can return prior cached data.
1956 if options_set.issubset(cached_options_set):
1957 return data
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001958
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001959 try:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001960 data = gerrit_util.GetChangeDetail(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001961 self.GetGerritHost(), self._GerritChangeIdentifier(), options_set)
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001962 except gerrit_util.GerritError as e:
1963 if e.http_status == 404:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001964 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001965 raise
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001966
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001967 self._detail_cache.setdefault(cache_key, []).append((options_set, data))
tandriic2405f52016-10-10 08:13:15 -07001968 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001969
Andrii Shyshkalovcc5f17e2018-08-22 23:35:59 +00001970 def _GetChangeCommit(self):
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001971 assert self.GetIssue(), 'issue must be set to query Gerrit'
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001972 try:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001973 data = gerrit_util.GetChangeCommit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001974 self.GetGerritHost(), self._GerritChangeIdentifier())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001975 except gerrit_util.GerritError as e:
1976 if e.http_status == 404:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001977 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001978 raise
agable32978d92016-11-01 12:55:02 -07001979 return data
1980
Karen Qian40c19422019-03-13 21:28:29 +00001981 def _IsCqConfigured(self):
1982 detail = self._GetChangeDetail(['LABELS'])
Andrii Shyshkalov8effa4d2020-01-21 13:23:36 +00001983 return u'Commit-Queue' in detail.get('labels', {})
Karen Qian40c19422019-03-13 21:28:29 +00001984
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001985 def CMDLand(self, force, bypass_hooks, verbose, parallel, resultdb, realm):
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001986 if git_common.is_dirty_git_tree('land'):
1987 return 1
Karen Qian40c19422019-03-13 21:28:29 +00001988
tandriid60367b2016-06-22 05:25:12 -07001989 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
Karen Qian40c19422019-03-13 21:28:29 +00001990 if not force and self._IsCqConfigured():
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001991 confirm_or_exit('\nIt seems this repository has a CQ, '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001992 'which can test and land changes for you. '
1993 'Are you sure you wish to bypass it?\n',
1994 action='bypass CQ')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001995 differs = True
tandriic4344b52016-08-29 06:04:54 -07001996 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001997 # Note: git diff outputs nothing if there is no diff.
1998 if not last_upload or RunGit(['diff', last_upload]).strip():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001999 print('WARNING: Some changes from local branch haven\'t been uploaded.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002000 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002001 if detail['current_revision'] == last_upload:
2002 differs = False
2003 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002004 print('WARNING: Local branch contents differ from latest uploaded '
2005 'patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002006 if differs:
2007 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002008 confirm_or_exit(
2009 'Do you want to submit latest Gerrit patchset and bypass hooks?\n',
2010 action='submit')
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002011 print('WARNING: Bypassing hooks and submitting latest uploaded patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002012 elif not bypass_hooks:
Edward Lemur227d5102020-02-25 23:45:35 +00002013 upstream = self.GetCommonAncestorWithUpstream()
2014 if self.GetIssue():
2015 description = self.FetchDescription()
2016 else:
Edward Lemura12175c2020-03-09 16:58:26 +00002017 description = _create_description_from_log([upstream])
Edward Lemur227d5102020-02-25 23:45:35 +00002018 self.RunHook(
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002019 committing=True,
2020 may_prompt=not force,
2021 verbose=verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00002022 parallel=parallel,
2023 upstream=upstream,
2024 description=description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00002025 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00002026 resultdb=resultdb,
2027 realm=realm)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002028
2029 self.SubmitIssue(wait_for_merge=True)
2030 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002031 links = self._GetChangeCommit().get('web_links', [])
2032 for link in links:
Aaron Gable02cdbb42016-12-13 16:24:25 -08002033 if link.get('name') == 'gitiles' and link.get('url'):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002034 print('Landed as: %s' % link.get('url'))
agable32978d92016-11-01 12:55:02 -07002035 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002036 return 0
2037
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002038 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force,
2039 newbranch):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002040 assert parsed_issue_arg.valid
2041
Edward Lemur125d60a2019-09-13 18:25:41 +00002042 self.issue = parsed_issue_arg.issue
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002043
2044 if parsed_issue_arg.hostname:
2045 self._gerrit_host = parsed_issue_arg.hostname
2046 self._gerrit_server = 'https://%s' % self._gerrit_host
2047
tandriic2405f52016-10-10 08:13:15 -07002048 try:
2049 detail = self._GetChangeDetail(['ALL_REVISIONS'])
Aaron Gablea45ee112016-11-22 15:14:38 -08002050 except GerritChangeNotExists as e:
tandriic2405f52016-10-10 08:13:15 -07002051 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002052
2053 if not parsed_issue_arg.patchset:
2054 # Use current revision by default.
2055 revision_info = detail['revisions'][detail['current_revision']]
2056 patchset = int(revision_info['_number'])
2057 else:
2058 patchset = parsed_issue_arg.patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002059 for revision_info in detail['revisions'].values():
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002060 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2061 break
2062 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002063 DieWithError('Couldn\'t find patchset %i in change %i' %
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002064 (parsed_issue_arg.patchset, self.GetIssue()))
2065
Edward Lemur125d60a2019-09-13 18:25:41 +00002066 remote_url = self.GetRemoteUrl()
Aaron Gable697a91b2018-01-19 15:20:15 -08002067 if remote_url.endswith('.git'):
2068 remote_url = remote_url[:-len('.git')]
erikchen0d14d0d2018-08-28 18:57:09 +00002069 remote_url = remote_url.rstrip('/')
2070
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002071 fetch_info = revision_info['fetch']['http']
erikchen0d14d0d2018-08-28 18:57:09 +00002072 fetch_info['url'] = fetch_info['url'].rstrip('/')
Aaron Gable697a91b2018-01-19 15:20:15 -08002073
2074 if remote_url != fetch_info['url']:
2075 DieWithError('Trying to patch a change from %s but this repo appears '
2076 'to be %s.' % (fetch_info['url'], remote_url))
2077
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002078 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
Aaron Gable9387b4f2017-06-08 10:50:03 -07002079
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002080 # If we have created a new branch then do the "set issue" immediately in
2081 # case the cherry-pick fails, which happens when resolving conflicts.
2082 if newbranch:
2083 self.SetIssue(parsed_issue_arg.issue)
2084
Aaron Gable62619a32017-06-16 08:22:09 -07002085 if force:
2086 RunGit(['reset', '--hard', 'FETCH_HEAD'])
2087 print('Checked out commit for change %i patchset %i locally' %
2088 (parsed_issue_arg.issue, patchset))
Stefan Zager2d5f0392017-10-10 15:17:53 -07002089 elif nocommit:
2090 RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD'])
2091 print('Patch applied to index.')
Aaron Gable62619a32017-06-16 08:22:09 -07002092 else:
Aaron Gable9387b4f2017-06-08 10:50:03 -07002093 RunGit(['cherry-pick', 'FETCH_HEAD'])
2094 print('Committed patch for change %i patchset %i locally.' %
Aaron Gable62619a32017-06-16 08:22:09 -07002095 (parsed_issue_arg.issue, patchset))
2096 print('Note: this created a local commit which does not have '
2097 'the same hash as the one uploaded for review. This will make '
2098 'uploading changes based on top of this branch difficult.\n'
2099 'If you want to do that, use "git cl patch --force" instead.')
2100
Stefan Zagerd08043c2017-10-12 12:07:02 -07002101 if self.GetBranch():
2102 self.SetIssue(parsed_issue_arg.issue)
2103 self.SetPatchset(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00002104 fetched_hash = scm.GIT.ResolveCommit(settings.GetRoot(), 'FETCH_HEAD')
Stefan Zagerd08043c2017-10-12 12:07:02 -07002105 self._GitSetBranchConfigValue('last-upload-hash', fetched_hash)
2106 self._GitSetBranchConfigValue('gerritsquashhash', fetched_hash)
2107 else:
2108 print('WARNING: You are in detached HEAD state.\n'
2109 'The patch has been applied to your checkout, but you will not be '
2110 'able to upload a new patch set to the gerrit issue.\n'
2111 'Try using the \'-b\' option if you would like to work on a '
2112 'branch and/or upload a new patch set.')
2113
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002114 return 0
2115
tandrii16e0b4e2016-06-07 10:34:28 -07002116 def _GerritCommitMsgHookCheck(self, offer_removal):
2117 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2118 if not os.path.exists(hook):
2119 return
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002120 # Crude attempt to distinguish Gerrit Codereview hook from a potentially
2121 # custom developer-made one.
tandrii16e0b4e2016-06-07 10:34:28 -07002122 data = gclient_utils.FileRead(hook)
2123 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2124 return
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002125 print('WARNING: You have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002126 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002127 'and may interfere with it in subtle ways.\n'
2128 'We recommend you remove the commit-msg hook.')
2129 if offer_removal:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002130 if ask_for_explicit_yes('Do you want to remove it now?'):
tandrii16e0b4e2016-06-07 10:34:28 -07002131 gclient_utils.rm_file_or_tree(hook)
2132 print('Gerrit commit-msg hook removed.')
2133 else:
2134 print('OK, will keep Gerrit commit-msg hook in place.')
2135
Edward Lemur1b52d872019-05-09 21:12:12 +00002136 def _CleanUpOldTraces(self):
2137 """Keep only the last |MAX_TRACES| traces."""
2138 try:
2139 traces = sorted([
2140 os.path.join(TRACES_DIR, f)
2141 for f in os.listdir(TRACES_DIR)
2142 if (os.path.isfile(os.path.join(TRACES_DIR, f))
2143 and not f.startswith('tmp'))
2144 ])
2145 traces_to_delete = traces[:-MAX_TRACES]
2146 for trace in traces_to_delete:
Daniel Chengcf6269b2019-05-18 01:02:12 +00002147 os.remove(trace)
Edward Lemur1b52d872019-05-09 21:12:12 +00002148 except OSError:
2149 print('WARNING: Failed to remove old git traces from\n'
2150 ' %s'
2151 'Consider removing them manually.' % TRACES_DIR)
Edward Lemurdc8e23d2019-05-07 00:45:48 +00002152
Edward Lemur5737f022019-05-17 01:24:00 +00002153 def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002154 """Zip and write the git push traces stored in traces_dir."""
2155 gclient_utils.safe_makedirs(TRACES_DIR)
Edward Lemur1b52d872019-05-09 21:12:12 +00002156 traces_zip = trace_name + '-traces'
2157 traces_readme = trace_name + '-README'
Michael Mosse7f0b4c2019-05-08 04:36:24 +00002158 # Create a temporary dir to store git config and gitcookies in. It will be
2159 # compressed and stored next to the traces.
2160 git_info_dir = tempfile.mkdtemp()
Edward Lemur1b52d872019-05-09 21:12:12 +00002161 git_info_zip = trace_name + '-git-info'
2162
Josip Sokcevic5e18b602020-04-23 21:47:00 +00002163 git_push_metadata['now'] = datetime_now().strftime('%Y-%m-%dT%H:%M:%S.%f')
sangwoo.ko7a614332019-05-22 02:46:19 +00002164
Edward Lemur1b52d872019-05-09 21:12:12 +00002165 git_push_metadata['trace_name'] = trace_name
2166 gclient_utils.FileWrite(
2167 traces_readme, TRACES_README_FORMAT % git_push_metadata)
2168
2169 # Keep only the first 6 characters of the git hashes on the packet
2170 # trace. This greatly decreases size after compression.
2171 packet_traces = os.path.join(traces_dir, 'trace-packet')
2172 if os.path.isfile(packet_traces):
2173 contents = gclient_utils.FileRead(packet_traces)
2174 gclient_utils.FileWrite(
2175 packet_traces, GIT_HASH_RE.sub(r'\1', contents))
2176 shutil.make_archive(traces_zip, 'zip', traces_dir)
2177
2178 # Collect and compress the git config and gitcookies.
2179 git_config = RunGit(['config', '-l'])
2180 gclient_utils.FileWrite(
2181 os.path.join(git_info_dir, 'git-config'),
2182 git_config)
2183
2184 cookie_auth = gerrit_util.Authenticator.get()
2185 if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
2186 gitcookies_path = cookie_auth.get_gitcookies_path()
2187 if os.path.isfile(gitcookies_path):
2188 gitcookies = gclient_utils.FileRead(gitcookies_path)
2189 gclient_utils.FileWrite(
2190 os.path.join(git_info_dir, 'gitcookies'),
2191 GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies))
2192 shutil.make_archive(git_info_zip, 'zip', git_info_dir)
2193
Edward Lemur1b52d872019-05-09 21:12:12 +00002194 gclient_utils.rmtree(git_info_dir)
2195
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002196 def _RunGitPushWithTraces(self,
2197 refspec,
2198 refspec_opts,
2199 git_push_metadata,
2200 git_push_options=None):
Edward Lemur1b52d872019-05-09 21:12:12 +00002201 """Run git push and collect the traces resulting from the execution."""
2202 # Create a temporary directory to store traces in. Traces will be compressed
2203 # and stored in a 'traces' dir inside depot_tools.
2204 traces_dir = tempfile.mkdtemp()
Edward Lemur5737f022019-05-17 01:24:00 +00002205 trace_name = os.path.join(
2206 TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f'))
Edward Lemur0f58ae42019-04-30 17:24:12 +00002207
2208 env = os.environ.copy()
2209 env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy'
2210 env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Jonathan Nieder9779b142019-05-29 23:19:29 +00002211 env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002212 env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl')
2213 env['GIT_TRACE_CURL_NO_DATA'] = '1'
2214 env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet')
2215
2216 try:
2217 push_returncode = 0
Edward Lemur1b52d872019-05-09 21:12:12 +00002218 remote_url = self.GetRemoteUrl()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002219 before_push = time_time()
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002220 push_cmd = ['git', 'push', remote_url, refspec]
2221 if git_push_options:
2222 for opt in git_push_options:
2223 push_cmd.extend(['-o', opt])
2224
Edward Lemur0f58ae42019-04-30 17:24:12 +00002225 push_stdout = gclient_utils.CheckCallAndFilter(
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002226 push_cmd,
Edward Lemur0f58ae42019-04-30 17:24:12 +00002227 env=env,
2228 print_stdout=True,
2229 # Flush after every line: useful for seeing progress when running as
2230 # recipe.
2231 filter_fn=lambda _: sys.stdout.flush())
Edward Lemur79d4f992019-11-11 23:49:02 +00002232 push_stdout = push_stdout.decode('utf-8', 'replace')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002233 except subprocess2.CalledProcessError as e:
2234 push_returncode = e.returncode
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002235 raise GitPushError(
2236 'Failed to create a change. Please examine output above for the '
2237 'reason of the failure.\n'
Josip Sokcevic7386a1e2021-02-12 19:00:34 +00002238 'For emergencies, Googlers can escalate to '
2239 'go/gob-support or go/notify#gob\n'
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002240 'Hint: run command below to diagnose common Git/Gerrit '
2241 'credential problems:\n'
2242 ' git cl creds-check\n'
2243 '\n'
2244 'If git-cl is not working correctly, file a bug under the Infra>SDK '
2245 'component including the files below.\n'
2246 'Review the files before upload, since they might contain sensitive '
2247 'information.\n'
2248 'Set the Restrict-View-Google label so that they are not publicly '
2249 'accessible.\n' + TRACES_MESSAGE % {'trace_name': trace_name})
Edward Lemur0f58ae42019-04-30 17:24:12 +00002250 finally:
2251 execution_time = time_time() - before_push
2252 metrics.collector.add_repeated('sub_commands', {
2253 'command': 'git push',
2254 'execution_time': execution_time,
2255 'exit_code': push_returncode,
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002256 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts),
Edward Lemur0f58ae42019-04-30 17:24:12 +00002257 })
2258
Edward Lemur1b52d872019-05-09 21:12:12 +00002259 git_push_metadata['execution_time'] = execution_time
2260 git_push_metadata['exit_code'] = push_returncode
Edward Lemur5737f022019-05-17 01:24:00 +00002261 self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata)
Edward Lemur0f58ae42019-04-30 17:24:12 +00002262
Edward Lemur1b52d872019-05-09 21:12:12 +00002263 self._CleanUpOldTraces()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002264 gclient_utils.rmtree(traces_dir)
2265
2266 return push_stdout
2267
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002268 def CMDUploadChange(self, options, git_diff_args, custom_cl_base,
2269 change_desc):
2270 """Upload the current branch to Gerrit, retry if new remote HEAD is
2271 found. options and change_desc may be mutated."""
Josip Sokcevicb631a882021-01-06 18:18:10 +00002272 remote, remote_branch = self.GetRemoteBranch()
2273 branch = GetTargetRef(remote, remote_branch, options.target_branch)
2274
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002275 try:
2276 return self._CMDUploadChange(options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002277 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002278 except GitPushError as e:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002279 # Repository might be in the middle of transition to main branch as
2280 # default, and uploads to old default might be blocked.
2281 if remote_branch not in [DEFAULT_OLD_BRANCH, DEFAULT_NEW_BRANCH]:
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002282 DieWithError(str(e), change_desc)
2283
Josip Sokcevicb631a882021-01-06 18:18:10 +00002284 project_head = gerrit_util.GetProjectHead(self._gerrit_host,
2285 self.GetGerritProject())
2286 if project_head == branch:
2287 DieWithError(str(e), change_desc)
2288 branch = project_head
2289
2290 print("WARNING: Fetching remote state and retrying upload to default "
2291 "branch...")
2292 RunGit(['fetch', '--prune', remote])
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002293 options.edit_description = False
2294 options.force = True
2295 try:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002296 self._CMDUploadChange(options, git_diff_args, custom_cl_base,
2297 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002298 except GitPushError as e:
2299 DieWithError(str(e), change_desc)
2300
2301 def _CMDUploadChange(self, options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002302 change_desc, branch):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002303 """Upload the current branch to Gerrit."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002304 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002305 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002306 if self.GetIssue():
Josipe827b0f2020-01-30 00:07:20 +00002307 # User requested to change description
2308 if options.edit_description:
Josipe827b0f2020-01-30 00:07:20 +00002309 change_desc.prompt()
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002310 change_id = self._GetChangeDetail()['change_id']
Edward Lemur5a644f82020-03-18 16:44:57 +00002311 change_desc.ensure_change_id(change_id)
Aaron Gableb56ad332017-01-06 15:24:31 -08002312 else: # if not self.GetIssue()
Gavin Mak68e6cf32021-01-25 18:24:08 +00002313 if not options.force and not options.message_file:
Anthony Polito8b955342019-09-24 19:01:36 +00002314 change_desc.prompt()
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002315 change_ids = git_footers.get_footer_change_id(change_desc.description)
Edward Lemur5a644f82020-03-18 16:44:57 +00002316 if len(change_ids) == 1:
2317 change_id = change_ids[0]
2318 else:
2319 change_id = GenerateGerritChangeId(change_desc.description)
2320 change_desc.ensure_change_id(change_id)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002321
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002322 if options.preserve_tryjobs:
2323 change_desc.set_preserve_tryjobs()
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002324
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002325 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Edward Lemur5a644f82020-03-18 16:44:57 +00002326 parent = self._ComputeParent(
2327 remote, upstream_branch, custom_cl_base, options.force, change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002328 tree = RunGit(['rev-parse', 'HEAD:']).strip()
Edward Lemur1773f372020-02-22 00:27:14 +00002329 with gclient_utils.temporary_file() as desc_tempfile:
2330 gclient_utils.FileWrite(desc_tempfile, change_desc.description)
2331 ref_to_push = RunGit(
2332 ['commit-tree', tree, '-p', parent, '-F', desc_tempfile]).strip()
Anthony Polito8b955342019-09-24 19:01:36 +00002333 else: # if not options.squash
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00002334 if options.no_add_changeid:
2335 pass
2336 else: # adding Change-Ids is okay.
2337 if not git_footers.get_footer_change_id(change_desc.description):
2338 DownloadGerritHook(False)
2339 change_desc.set_description(
2340 self._AddChangeIdToCommitMessage(change_desc.description,
2341 git_diff_args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002342 ref_to_push = 'HEAD'
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002343 # For no-squash mode, we assume the remote called "origin" is the one we
2344 # want. It is not worthwhile to support different workflows for
2345 # no-squash mode.
2346 parent = 'origin/%s' % branch
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00002347 # attempt to extract the changeid from the current description
2348 # fail informatively if not possible.
2349 change_id_candidates = git_footers.get_footer_change_id(
2350 change_desc.description)
2351 if not change_id_candidates:
2352 DieWithError("Unable to extract change-id from message.")
2353 change_id = change_id_candidates[0]
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002354
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +00002355 SaveDescriptionBackup(change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002356 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2357 ref_to_push)]).splitlines()
2358 if len(commits) > 1:
2359 print('WARNING: This will upload %d commits. Run the following command '
2360 'to see which commits will be uploaded: ' % len(commits))
2361 print('git log %s..%s' % (parent, ref_to_push))
2362 print('You can also use `git squash-branch` to squash these into a '
2363 'single commit.')
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002364 confirm_or_exit(action='upload')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002365
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002366 reviewers = sorted(change_desc.get_reviewers())
Edward Lemur4508b422019-10-03 21:56:35 +00002367 cc = []
2368 # Add CCs from WATCHLISTS and rietveld.cc git config unless this is
2369 # the initial upload, the CL is private, or auto-CCing has ben disabled.
2370 if not (self.GetIssue() or options.private or options.no_autocc):
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002371 cc = self.GetCCList().split(',')
Gavin Makb1c08f62021-04-01 18:05:58 +00002372 if len(cc) > 100:
2373 lsc = ('https://chromium.googlesource.com/chromium/src/+/HEAD/docs/'
2374 'process/lsc/lsc_workflow.md')
2375 print('WARNING: This will auto-CC %s users.' % len(cc))
2376 print('LSC may be more appropriate: %s' % lsc)
2377 print('You can also use the --no-autocc flag to disable auto-CC.')
2378 confirm_or_exit(action='continue')
Edward Lemur4508b422019-10-03 21:56:35 +00002379 # Add cc's from the --cc flag.
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002380 if options.cc:
2381 cc.extend(options.cc)
Edward Lemur79d4f992019-11-11 23:49:02 +00002382 cc = [email.strip() for email in cc if email.strip()]
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002383 if change_desc.get_cced():
2384 cc.extend(change_desc.get_cced())
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002385 if self.GetGerritHost() == 'chromium-review.googlesource.com':
Andrii Shyshkalov0da5e8f2018-10-30 17:29:18 +00002386 valid_accounts = set(reviewers + cc)
2387 # TODO(crbug/877717): relax this for all hosts.
2388 else:
2389 valid_accounts = gerrit_util.ValidAccounts(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002390 self.GetGerritHost(), reviewers + cc)
Andrii Shyshkalovf170af42018-10-30 07:00:44 +00002391 logging.info('accounts %s are recognized, %s invalid',
2392 sorted(valid_accounts),
2393 set(reviewers + cc).difference(set(valid_accounts)))
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002394
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002395 # Extra options that can be specified at push time. Doc:
2396 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002397 refspec_opts = []
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002398
Aaron Gable844cf292017-06-28 11:32:59 -07002399 # By default, new changes are started in WIP mode, and subsequent patchsets
2400 # don't send email. At any time, passing --send-mail will mark the change
2401 # ready and send email for that particular patch.
Aaron Gableafd52772017-06-27 16:40:10 -07002402 if options.send_mail:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002403 refspec_opts.append('ready')
2404 refspec_opts.append('notify=ALL')
Jamie Madill276da0b2018-04-27 14:41:20 -04002405 elif not self.GetIssue() and options.squash:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002406 refspec_opts.append('wip')
Aaron Gableafd52772017-06-27 16:40:10 -07002407 else:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002408 refspec_opts.append('notify=NONE')
Aaron Gable70f4e242017-06-26 10:45:59 -07002409
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002410 # TODO(tandrii): options.message should be posted as a comment
Aaron Gablee5adf612017-07-14 10:43:58 -07002411 # if --send-mail is set on non-initial upload as Rietveld used to do it.
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002412
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002413 # Set options.title in case user was prompted in _GetTitleForUpload and
2414 # _CMDUploadChange needs to be called again.
2415 options.title = self._GetTitleForUpload(options)
2416 if options.title:
Nick Carter8692b182017-11-06 16:30:38 -08002417 # Punctuation and whitespace in |title| must be percent-encoded.
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002418 refspec_opts.append(
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002419 'm=' + gerrit_util.PercentEncodeForGitRef(options.title))
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002420
agablec6787972016-09-09 16:13:34 -07002421 if options.private:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002422 refspec_opts.append('private')
agablec6787972016-09-09 16:13:34 -07002423
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002424 for r in sorted(reviewers):
2425 if r in valid_accounts:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002426 refspec_opts.append('r=%s' % r)
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002427 reviewers.remove(r)
2428 else:
2429 # TODO(tandrii): this should probably be a hard failure.
2430 print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping'
2431 % r)
2432 for c in sorted(cc):
2433 # refspec option will be rejected if cc doesn't correspond to an
2434 # account, even though REST call to add such arbitrary cc may succeed.
2435 if c in valid_accounts:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002436 refspec_opts.append('cc=%s' % c)
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002437 cc.remove(c)
2438
rmistry9eadede2016-09-19 11:22:43 -07002439 if options.topic:
2440 # Documentation on Gerrit topics is here:
2441 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002442 refspec_opts.append('topic=%s' % options.topic)
rmistry9eadede2016-09-19 11:22:43 -07002443
Edward Lemur687ca902018-12-05 02:30:30 +00002444 if options.enable_auto_submit:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002445 refspec_opts.append('l=Auto-Submit+1')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00002446 if options.set_bot_commit:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002447 refspec_opts.append('l=Bot-Commit+1')
Edward Lemur687ca902018-12-05 02:30:30 +00002448 if options.use_commit_queue:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002449 refspec_opts.append('l=Commit-Queue+2')
Edward Lemur687ca902018-12-05 02:30:30 +00002450 elif options.cq_dry_run:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002451 refspec_opts.append('l=Commit-Queue+1')
Edward Lemur687ca902018-12-05 02:30:30 +00002452
2453 if change_desc.get_reviewers(tbr_only=True):
2454 score = gerrit_util.GetCodeReviewTbrScore(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002455 self.GetGerritHost(),
2456 self.GetGerritProject())
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002457 refspec_opts.append('l=Code-Review+%s' % score)
Andrii Shyshkalove7a7fc42018-10-30 17:35:09 +00002458
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002459 # Gerrit sorts hashtags, so order is not important.
Nodir Turakulov23b82142017-11-16 11:04:25 -08002460 hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags}
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002461 if not self.GetIssue():
Nodir Turakulov23b82142017-11-16 11:04:25 -08002462 hashtags.update(change_desc.get_hash_tags())
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002463 refspec_opts += ['hashtag=%s' % t for t in sorted(hashtags)]
2464
2465 refspec_suffix = ''
2466 if refspec_opts:
2467 refspec_suffix = '%' + ','.join(refspec_opts)
2468 assert ' ' not in refspec_suffix, (
2469 'spaces not allowed in refspec: "%s"' % refspec_suffix)
2470 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002471
Edward Lemur1b52d872019-05-09 21:12:12 +00002472 git_push_metadata = {
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002473 'gerrit_host': self.GetGerritHost(),
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002474 'title': options.title or '<untitled>',
Edward Lemur1b52d872019-05-09 21:12:12 +00002475 'change_id': change_id,
2476 'description': change_desc.description,
2477 }
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002478
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002479 push_stdout = self._RunGitPushWithTraces(refspec, refspec_opts,
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002480 git_push_metadata,
2481 options.push_options)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002482
2483 if options.squash:
Aaron Gable289b4312017-09-13 14:06:16 -07002484 regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002485 change_numbers = [m.group(1)
2486 for m in map(regex.match, push_stdout.splitlines())
2487 if m]
2488 if len(change_numbers) != 1:
2489 DieWithError(
2490 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
Christopher Lamf732cd52017-01-24 12:40:11 +11002491 'Change-Id: %s') % (len(change_numbers), change_id), change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002492 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002493 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002494
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002495 if self.GetIssue() and (reviewers or cc):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002496 # GetIssue() is not set in case of non-squash uploads according to tests.
Aaron Gable6e7ddb62020-05-27 22:23:29 +00002497 # TODO(crbug.com/751901): non-squash uploads in git cl should be removed.
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002498 gerrit_util.AddReviewers(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002499 self.GetGerritHost(),
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00002500 self._GerritChangeIdentifier(),
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002501 reviewers, cc,
2502 notify=bool(options.send_mail))
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002503
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002504 return 0
2505
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002506 def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force,
2507 change_desc):
2508 """Computes parent of the generated commit to be uploaded to Gerrit.
2509
2510 Returns revision or a ref name.
2511 """
2512 if custom_cl_base:
2513 # Try to avoid creating additional unintended CLs when uploading, unless
2514 # user wants to take this risk.
2515 local_ref_of_target_remote = self.GetRemoteBranch()[1]
2516 code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base,
2517 local_ref_of_target_remote])
2518 if code == 1:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002519 print('\nWARNING: Manually specified base of this CL `%s` '
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002520 'doesn\'t seem to belong to target remote branch `%s`.\n\n'
2521 'If you proceed with upload, more than 1 CL may be created by '
2522 'Gerrit as a result, in turn confusing or crashing git cl.\n\n'
2523 'If you are certain that specified base `%s` has already been '
2524 'uploaded to Gerrit as another CL, you may proceed.\n' %
2525 (custom_cl_base, local_ref_of_target_remote, custom_cl_base))
2526 if not force:
2527 confirm_or_exit(
2528 'Do you take responsibility for cleaning up potential mess '
2529 'resulting from proceeding with upload?',
2530 action='upload')
2531 return custom_cl_base
2532
Aaron Gablef97e33d2017-03-30 15:44:27 -07002533 if remote != '.':
2534 return self.GetCommonAncestorWithUpstream()
2535
2536 # If our upstream branch is local, we base our squashed commit on its
2537 # squashed version.
2538 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2539
Aaron Gablef97e33d2017-03-30 15:44:27 -07002540 if upstream_branch_name == 'master':
Aaron Gable0bbd1c22017-05-08 14:37:08 -07002541 return self.GetCommonAncestorWithUpstream()
Glen Robertson7d98e222020-08-27 17:53:11 +00002542 if upstream_branch_name == 'main':
2543 return self.GetCommonAncestorWithUpstream()
Aaron Gablef97e33d2017-03-30 15:44:27 -07002544
2545 # Check the squashed hash of the parent.
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002546 # TODO(tandrii): consider checking parent change in Gerrit and using its
2547 # hash if tree hash of latest parent revision (patchset) in Gerrit matches
2548 # the tree hash of the parent branch. The upside is less likely bogus
2549 # requests to reupload parent change just because it's uploadhash is
2550 # missing, yet the downside likely exists, too (albeit unknown to me yet).
Edward Lesmesa680c232020-03-31 18:26:44 +00002551 parent = scm.GIT.GetBranchConfig(
2552 settings.GetRoot(), upstream_branch_name, 'gerritsquashhash')
Aaron Gablef97e33d2017-03-30 15:44:27 -07002553 # Verify that the upstream branch has been uploaded too, otherwise
2554 # Gerrit will create additional CLs when uploading.
2555 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2556 RunGitSilent(['rev-parse', parent + ':'])):
2557 DieWithError(
2558 '\nUpload upstream branch %s first.\n'
2559 'It is likely that this branch has been rebased since its last '
2560 'upload, so you just need to upload it again.\n'
2561 '(If you uploaded it with --no-squash, then branch dependencies '
2562 'are not supported, and you should reupload with --squash.)'
2563 % upstream_branch_name,
2564 change_desc)
2565 return parent
2566
Edward Lemura12175c2020-03-09 16:58:26 +00002567 def _AddChangeIdToCommitMessage(self, log_desc, args):
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002568 """Re-commits using the current message, assumes the commit hook is in
2569 place.
2570 """
Edward Lemura12175c2020-03-09 16:58:26 +00002571 RunGit(['commit', '--amend', '-m', log_desc])
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002572 new_log_desc = _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002573 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002574 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002575 return new_log_desc
2576 else:
tandrii@chromium.orgb067ec52016-05-31 15:24:44 +00002577 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002578
tandriie113dfd2016-10-11 10:20:12 -07002579 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002580 try:
2581 data = self._GetChangeDetail()
Aaron Gablea45ee112016-11-22 15:14:38 -08002582 except GerritChangeNotExists:
2583 return 'Gerrit doesn\'t know about your change %s' % self.GetIssue()
tandrii8c5a3532016-11-04 07:52:02 -07002584
2585 if data['status'] in ('ABANDONED', 'MERGED'):
2586 return 'CL %s is closed' % self.GetIssue()
2587
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002588 def GetGerritChange(self, patchset=None):
2589 """Returns a buildbucket.v2.GerritChange message for the current issue."""
Edward Lemur79d4f992019-11-11 23:49:02 +00002590 host = urllib.parse.urlparse(self.GetCodereviewServer()).hostname
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002591 issue = self.GetIssue()
Edward Lemur2c210a42019-09-16 23:58:35 +00002592 patchset = int(patchset or self.GetPatchset())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002593 data = self._GetChangeDetail(['ALL_REVISIONS'])
2594
2595 assert host and issue and patchset, 'CL must be uploaded first'
2596
2597 has_patchset = any(
2598 int(revision_data['_number']) == patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002599 for revision_data in data['revisions'].values())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002600 if not has_patchset:
Aaron Gablea45ee112016-11-22 15:14:38 -08002601 raise Exception('Patchset %d is not known in Gerrit change %d' %
tandrii8c5a3532016-11-04 07:52:02 -07002602 (patchset, self.GetIssue()))
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002603
tandrii8c5a3532016-11-04 07:52:02 -07002604 return {
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002605 'host': host,
2606 'change': issue,
2607 'project': data['project'],
2608 'patchset': patchset,
tandrii8c5a3532016-11-04 07:52:02 -07002609 }
tandriie113dfd2016-10-11 10:20:12 -07002610
tandriide281ae2016-10-12 06:02:30 -07002611 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002612 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002613
Edward Lemur707d70b2018-02-07 00:50:14 +01002614 def GetReviewers(self):
2615 details = self._GetChangeDetail(['DETAILED_ACCOUNTS'])
Mohamed Heikal171c0742018-11-09 20:38:51 +00002616 return [r['email'] for r in details['reviewers'].get('REVIEWER', [])]
Edward Lemur707d70b2018-02-07 00:50:14 +01002617
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002618
Lei Zhang8a0efc12020-08-05 19:58:45 +00002619def _get_bug_line_values(default_project_prefix, bugs):
2620 """Given default_project_prefix and comma separated list of bugs, yields bug
2621 line values.
tandriif9aefb72016-07-01 09:06:51 -07002622
2623 Each bug can be either:
Lei Zhang8a0efc12020-08-05 19:58:45 +00002624 * a number, which is combined with default_project_prefix
tandriif9aefb72016-07-01 09:06:51 -07002625 * string, which is left as is.
2626
2627 This function may produce more than one line, because bugdroid expects one
2628 project per line.
2629
Lei Zhang8a0efc12020-08-05 19:58:45 +00002630 >>> list(_get_bug_line_values('v8:', '123,chromium:789'))
tandriif9aefb72016-07-01 09:06:51 -07002631 ['v8:123', 'chromium:789']
2632 """
2633 default_bugs = []
2634 others = []
2635 for bug in bugs.split(','):
2636 bug = bug.strip()
2637 if bug:
2638 try:
2639 default_bugs.append(int(bug))
2640 except ValueError:
2641 others.append(bug)
2642
2643 if default_bugs:
2644 default_bugs = ','.join(map(str, default_bugs))
Lei Zhang8a0efc12020-08-05 19:58:45 +00002645 if default_project_prefix:
2646 if not default_project_prefix.endswith(':'):
2647 default_project_prefix += ':'
2648 yield '%s%s' % (default_project_prefix, default_bugs)
tandriif9aefb72016-07-01 09:06:51 -07002649 else:
2650 yield default_bugs
2651 for other in sorted(others):
2652 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2653 yield other
2654
2655
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002656class ChangeDescription(object):
2657 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002658 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002659 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
Aaron Gable3a16ed12017-03-23 10:51:55 -07002660 BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$'
Dan Beamd8b04ca2019-10-10 21:23:26 +00002661 FIXED_LINE = r'^[ \t]*Fixed[ \t]*:[ \t]*(.*?)[ \t]*$'
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002662 CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002663 STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*'
2664 BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]'
Anthony Polito02b5af32019-12-02 19:49:47 +00002665 COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):($|[^:])'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002666 BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002667
Dan Beamd8b04ca2019-10-10 21:23:26 +00002668 def __init__(self, description, bug=None, fixed=None):
agable@chromium.org42c20792013-09-12 17:34:49 +00002669 self._description_lines = (description or '').strip().splitlines()
Anthony Polito8b955342019-09-24 19:01:36 +00002670 if bug:
2671 regexp = re.compile(self.BUG_LINE)
2672 prefix = settings.GetBugPrefix()
2673 if not any((regexp.match(line) for line in self._description_lines)):
2674 values = list(_get_bug_line_values(prefix, bug))
2675 self.append_footer('Bug: %s' % ', '.join(values))
Dan Beamd8b04ca2019-10-10 21:23:26 +00002676 if fixed:
2677 regexp = re.compile(self.FIXED_LINE)
2678 prefix = settings.GetBugPrefix()
2679 if not any((regexp.match(line) for line in self._description_lines)):
2680 values = list(_get_bug_line_values(prefix, fixed))
2681 self.append_footer('Fixed: %s' % ', '.join(values))
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002682
agable@chromium.org42c20792013-09-12 17:34:49 +00002683 @property # www.logilab.org/ticket/89786
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08002684 def description(self): # pylint: disable=method-hidden
agable@chromium.org42c20792013-09-12 17:34:49 +00002685 return '\n'.join(self._description_lines)
2686
2687 def set_description(self, desc):
2688 if isinstance(desc, basestring):
2689 lines = desc.splitlines()
2690 else:
2691 lines = [line.rstrip() for line in desc]
2692 while lines and not lines[0]:
2693 lines.pop(0)
2694 while lines and not lines[-1]:
2695 lines.pop(-1)
2696 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002697
Edward Lemur5a644f82020-03-18 16:44:57 +00002698 def ensure_change_id(self, change_id):
2699 description = self.description
2700 footer_change_ids = git_footers.get_footer_change_id(description)
2701 # Make sure that the Change-Id in the description matches the given one.
2702 if footer_change_ids != [change_id]:
2703 if footer_change_ids:
2704 # Remove any existing Change-Id footers since they don't match the
2705 # expected change_id footer.
2706 description = git_footers.remove_footer(description, 'Change-Id')
2707 print('WARNING: Change-Id has been set to %s. Use `git cl issue 0` '
2708 'if you want to set a new one.')
2709 # Add the expected Change-Id footer.
2710 description = git_footers.add_footer_change_id(description, change_id)
2711 self.set_description(description)
2712
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002713 def update_reviewers(self, reviewers, tbrs):
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002714 """Rewrites the R=/TBR= line(s) as a single line each.
2715
2716 Args:
2717 reviewers (list(str)) - list of additional emails to use for reviewers.
2718 tbrs (list(str)) - list of additional emails to use for TBRs.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002719 """
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002720 if not reviewers and not tbrs:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002721 return
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002722
2723 reviewers = set(reviewers)
2724 tbrs = set(tbrs)
2725 LOOKUP = {
2726 'TBR': tbrs,
2727 'R': reviewers,
2728 }
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002729
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002730 # Get the set of R= and TBR= lines and remove them from the description.
agable@chromium.org42c20792013-09-12 17:34:49 +00002731 regexp = re.compile(self.R_LINE)
2732 matches = [regexp.match(line) for line in self._description_lines]
2733 new_desc = [l for i, l in enumerate(self._description_lines)
2734 if not matches[i]]
2735 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002736
agable@chromium.org42c20792013-09-12 17:34:49 +00002737 # Construct new unified R= and TBR= lines.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002738
2739 # First, update tbrs/reviewers with names from the R=/TBR= lines (if any).
agable@chromium.org42c20792013-09-12 17:34:49 +00002740 for match in matches:
2741 if not match:
2742 continue
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002743 LOOKUP[match.group(1)].update(cleanup_list([match.group(2).strip()]))
2744
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002745 # If any folks ended up in both groups, remove them from tbrs.
2746 tbrs -= reviewers
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002747
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002748 new_r_line = 'R=' + ', '.join(sorted(reviewers)) if reviewers else None
2749 new_tbr_line = 'TBR=' + ', '.join(sorted(tbrs)) if tbrs else None
agable@chromium.org42c20792013-09-12 17:34:49 +00002750
2751 # Put the new lines in the description where the old first R= line was.
2752 line_loc = next((i for i, match in enumerate(matches) if match), -1)
2753 if 0 <= line_loc < len(self._description_lines):
2754 if new_tbr_line:
2755 self._description_lines.insert(line_loc, new_tbr_line)
2756 if new_r_line:
2757 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002758 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00002759 if new_r_line:
2760 self.append_footer(new_r_line)
2761 if new_tbr_line:
2762 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002763
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002764 def set_preserve_tryjobs(self):
2765 """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'."""
2766 footers = git_footers.parse_footers(self.description)
2767 for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []):
2768 if v.lower() == 'true':
2769 return
2770 self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true')
2771
Anthony Polito8b955342019-09-24 19:01:36 +00002772 def prompt(self):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002773 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002774 self.set_description([
2775 '# Enter a description of the change.',
2776 '# This will be displayed on the codereview site.',
2777 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00002778 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00002779 '--------------------',
2780 ] + self._description_lines)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002781 bug_regexp = re.compile(self.BUG_LINE)
2782 fixed_regexp = re.compile(self.FIXED_LINE)
Jonas Termansend0f79112019-03-22 15:28:26 +00002783 prefix = settings.GetBugPrefix()
Sigurd Schneider8630bb12020-11-11 14:02:49 +00002784 has_issue = lambda l: bug_regexp.match(l) or fixed_regexp.match(l)
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00002785
Dan Beamd8b04ca2019-10-10 21:23:26 +00002786 if not any((has_issue(line) for line in self._description_lines)):
Anthony Polito8b955342019-09-24 19:01:36 +00002787 self.append_footer('Bug: %s' % prefix)
tandriif9aefb72016-07-01 09:06:51 -07002788
Bruce Dawsonfc487042020-10-27 19:11:37 +00002789 print('Waiting for editor...')
agable@chromium.org42c20792013-09-12 17:34:49 +00002790 content = gclient_utils.RunEditor(self.description, True,
Edward Lemur79d4f992019-11-11 23:49:02 +00002791 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002792 if not content:
2793 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00002794 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002795
Bruce Dawson2377b012018-01-11 16:46:49 -08002796 # Strip off comments and default inserted "Bug:" line.
2797 clean_lines = [line.rstrip() for line in lines if not
Jonas Termansend0f79112019-03-22 15:28:26 +00002798 (line.startswith('#') or
2799 line.rstrip() == "Bug:" or
2800 line.rstrip() == "Bug: " + prefix)]
agable@chromium.org42c20792013-09-12 17:34:49 +00002801 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002802 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00002803 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002804
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002805 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00002806 """Adds a footer line to the description.
2807
2808 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
2809 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
2810 that Gerrit footers are always at the end.
2811 """
2812 parsed_footer_line = git_footers.parse_footer(line)
2813 if parsed_footer_line:
2814 # Line is a gerrit footer in the form: Footer-Key: any value.
2815 # Thus, must be appended observing Gerrit footer rules.
2816 self.set_description(
2817 git_footers.add_footer(self.description,
2818 key=parsed_footer_line[0],
2819 value=parsed_footer_line[1]))
2820 return
2821
2822 if not self._description_lines:
2823 self._description_lines.append(line)
2824 return
2825
2826 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
2827 if gerrit_footers:
2828 # git_footers.split_footers ensures that there is an empty line before
2829 # actual (gerrit) footers, if any. We have to keep it that way.
2830 assert top_lines and top_lines[-1] == ''
2831 top_lines, separator = top_lines[:-1], top_lines[-1:]
2832 else:
2833 separator = [] # No need for separator if there are no gerrit_footers.
2834
2835 prev_line = top_lines[-1] if top_lines else ''
2836 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
2837 not presubmit_support.Change.TAG_LINE_RE.match(line)):
2838 top_lines.append('')
2839 top_lines.append(line)
2840 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002841
tandrii99a72f22016-08-17 14:33:24 -07002842 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002843 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002844 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07002845 reviewers = [match.group(2).strip()
2846 for match in matches
2847 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002848 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002849
bradnelsond975b302016-10-23 12:20:23 -07002850 def get_cced(self):
2851 """Retrieves the list of reviewers."""
2852 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
2853 cced = [match.group(2).strip() for match in matches if match]
2854 return cleanup_list(cced)
2855
Nodir Turakulov23b82142017-11-16 11:04:25 -08002856 def get_hash_tags(self):
2857 """Extracts and sanitizes a list of Gerrit hashtags."""
2858 subject = (self._description_lines or ('',))[0]
2859 subject = re.sub(
2860 self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE)
2861
2862 tags = []
2863 start = 0
2864 bracket_exp = re.compile(self.BRACKET_HASH_TAG)
2865 while True:
2866 m = bracket_exp.match(subject, start)
2867 if not m:
2868 break
2869 tags.append(self.sanitize_hash_tag(m.group(1)))
2870 start = m.end()
2871
2872 if not tags:
2873 # Try "Tag: " prefix.
2874 m = re.match(self.COLON_SEPARATED_HASH_TAG, subject)
2875 if m:
2876 tags.append(self.sanitize_hash_tag(m.group(1)))
2877 return tags
2878
2879 @classmethod
2880 def sanitize_hash_tag(cls, tag):
2881 """Returns a sanitized Gerrit hash tag.
2882
2883 A sanitized hashtag can be used as a git push refspec parameter value.
2884 """
2885 return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower()
2886
maruel@chromium.orge52678e2013-04-26 18:34:44 +00002887
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002888def FindCodereviewSettingsFile(filename='codereview.settings'):
2889 """Finds the given file starting in the cwd and going up.
2890
2891 Only looks up to the top of the repository unless an
2892 'inherit-review-settings-ok' file exists in the root of the repository.
2893 """
2894 inherit_ok_file = 'inherit-review-settings-ok'
2895 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00002896 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002897 if os.path.isfile(os.path.join(root, inherit_ok_file)):
2898 root = '/'
2899 while True:
2900 if filename in os.listdir(cwd):
2901 if os.path.isfile(os.path.join(cwd, filename)):
2902 return open(os.path.join(cwd, filename))
2903 if cwd == root:
2904 break
2905 cwd = os.path.dirname(cwd)
2906
2907
2908def LoadCodereviewSettingsFromFile(fileobj):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002909 """Parses a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00002910 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002911
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002912 def SetProperty(name, setting, unset_error_ok=False):
2913 fullname = 'rietveld.' + name
2914 if setting in keyvals:
2915 RunGit(['config', fullname, keyvals[setting]])
2916 else:
2917 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
2918
tandrii48df5812016-10-17 03:55:37 -07002919 if not keyvals.get('GERRIT_HOST', False):
2920 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002921 # Only server setting is required. Other settings can be absent.
2922 # In that case, we ignore errors raised during option deletion attempt.
2923 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
2924 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
2925 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00002926 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00002927 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
2928 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00002929 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
2930 unset_error_ok=True)
Jamie Madilldc4d19e2019-10-24 21:50:02 +00002931 SetProperty(
2932 'format-full-by-default', 'FORMAT_FULL_BY_DEFAULT', unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002933
ukai@chromium.org7044efc2013-11-28 01:51:21 +00002934 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00002935 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00002936
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00002937 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
Edward Lesmes4de54132020-05-05 19:41:33 +00002938 RunGit(['config', 'gerrit.squash-uploads',
2939 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00002940
tandrii@chromium.org28253532016-04-14 13:46:56 +00002941 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00002942 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00002943 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
2944
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002945 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01002946 # should be of the form
2947 # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
2948 # ORIGIN_URL_CONFIG: http://src.chromium.org/git
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002949 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
2950 keyvals['ORIGIN_URL_CONFIG']])
2951
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002952
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002953def urlretrieve(source, destination):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002954 """Downloads a network object to a local file, like urllib.urlretrieve.
2955
2956 This is necessary because urllib is broken for SSL connections via a proxy.
2957 """
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002958 with open(destination, 'w') as f:
Edward Lemur79d4f992019-11-11 23:49:02 +00002959 f.write(urllib.request.urlopen(source).read())
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002960
2961
ukai@chromium.org712d6102013-11-27 00:52:58 +00002962def hasSheBang(fname):
2963 """Checks fname is a #! script."""
2964 with open(fname) as f:
2965 return f.read(2).startswith('#!')
2966
2967
tandrii@chromium.org18630d62016-03-04 12:06:02 +00002968def DownloadGerritHook(force):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002969 """Downloads and installs a Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002970
2971 Args:
2972 force: True to update hooks. False to install hooks if not present.
2973 """
ukai@chromium.org712d6102013-11-27 00:52:58 +00002974 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002975 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2976 if not os.access(dst, os.X_OK):
2977 if os.path.exists(dst):
2978 if not force:
2979 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002980 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00002981 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00002982 if not hasSheBang(dst):
2983 DieWithError('Not a script: %s\n'
2984 'You need to download from\n%s\n'
2985 'into .git/hooks/commit-msg and '
2986 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002987 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
2988 except Exception:
2989 if os.path.exists(dst):
2990 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00002991 DieWithError('\nFailed to download hooks.\n'
2992 'You need to download from\n%s\n'
2993 'into .git/hooks/commit-msg and '
2994 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00002995
2996
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01002997class _GitCookiesChecker(object):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002998 """Provides facilities for validating and suggesting fixes to .gitcookies."""
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01002999
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003000 _GOOGLESOURCE = 'googlesource.com'
3001
3002 def __init__(self):
3003 # Cached list of [host, identity, source], where source is either
3004 # .gitcookies or .netrc.
3005 self._all_hosts = None
3006
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003007 def ensure_configured_gitcookies(self):
3008 """Runs checks and suggests fixes to make git use .gitcookies from default
3009 path."""
3010 default = gerrit_util.CookiesAuthenticator.get_gitcookies_path()
3011 configured_path = RunGitSilent(
3012 ['config', '--global', 'http.cookiefile']).strip()
Andrii Shyshkalov1e250cd2017-05-10 15:39:31 +02003013 configured_path = os.path.expanduser(configured_path)
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003014 if configured_path:
3015 self._ensure_default_gitcookies_path(configured_path, default)
3016 else:
3017 self._configure_gitcookies_path(default)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003018
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003019 @staticmethod
3020 def _ensure_default_gitcookies_path(configured_path, default_path):
3021 assert configured_path
3022 if configured_path == default_path:
3023 print('git is already configured to use your .gitcookies from %s' %
3024 configured_path)
3025 return
3026
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003027 print('WARNING: You have configured custom path to .gitcookies: %s\n'
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003028 'Gerrit and other depot_tools expect .gitcookies at %s\n' %
3029 (configured_path, default_path))
3030
3031 if not os.path.exists(configured_path):
3032 print('However, your configured .gitcookies file is missing.')
3033 confirm_or_exit('Reconfigure git to use default .gitcookies?',
3034 action='reconfigure')
3035 RunGit(['config', '--global', 'http.cookiefile', default_path])
3036 return
3037
3038 if os.path.exists(default_path):
3039 print('WARNING: default .gitcookies file already exists %s' %
3040 default_path)
3041 DieWithError('Please delete %s manually and re-run git cl creds-check' %
3042 default_path)
3043
3044 confirm_or_exit('Move existing .gitcookies to default location?',
3045 action='move')
3046 shutil.move(configured_path, default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003047 RunGit(['config', '--global', 'http.cookiefile', default_path])
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003048 print('Moved and reconfigured git to use .gitcookies from %s' %
3049 default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003050
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003051 @staticmethod
3052 def _configure_gitcookies_path(default_path):
3053 netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path()
3054 if os.path.exists(netrc_path):
3055 print('You seem to be using outdated .netrc for git credentials: %s' %
3056 netrc_path)
3057 print('This tool will guide you through setting up recommended '
3058 '.gitcookies store for git credentials.\n'
3059 '\n'
3060 'IMPORTANT: If something goes wrong and you decide to go back, do:\n'
3061 ' git config --global --unset http.cookiefile\n'
3062 ' mv %s %s.backup\n\n' % (default_path, default_path))
3063 confirm_or_exit(action='setup .gitcookies')
3064 RunGit(['config', '--global', 'http.cookiefile', default_path])
3065 print('Configured git to use .gitcookies from %s' % default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003066
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003067 def get_hosts_with_creds(self, include_netrc=False):
3068 if self._all_hosts is None:
3069 a = gerrit_util.CookiesAuthenticator()
3070 self._all_hosts = [
3071 (h, u, s)
3072 for h, u, s in itertools.chain(
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003073 ((h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.items()),
3074 ((h, u, '.gitcookies') for h, (u, _) in a.gitcookies.items())
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003075 )
3076 if h.endswith(self._GOOGLESOURCE)
3077 ]
3078
3079 if include_netrc:
3080 return self._all_hosts
3081 return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc']
3082
3083 def print_current_creds(self, include_netrc=False):
3084 hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc))
3085 if not hosts:
3086 print('No Git/Gerrit credentials found')
3087 return
Edward Lemur79d4f992019-11-11 23:49:02 +00003088 lengths = [max(map(len, (row[i] for row in hosts))) for i in range(3)]
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003089 header = [('Host', 'User', 'Which file'),
3090 ['=' * l for l in lengths]]
3091 for row in (header + hosts):
3092 print('\t'.join((('%%+%ds' % l) % s)
3093 for l, s in zip(lengths, row)))
3094
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003095 @staticmethod
3096 def _parse_identity(identity):
Lei Zhangd3f769a2017-12-15 15:16:14 -08003097 """Parses identity "git-<username>.domain" into <username> and domain."""
3098 # Special case: usernames that contain ".", which are generally not
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02003099 # distinguishable from sub-domains. But we do know typical domains:
3100 if identity.endswith('.chromium.org'):
3101 domain = 'chromium.org'
3102 username = identity[:-len('.chromium.org')]
3103 else:
3104 username, domain = identity.split('.', 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003105 if username.startswith('git-'):
3106 username = username[len('git-'):]
3107 return username, domain
3108
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003109 def _canonical_git_googlesource_host(self, host):
3110 """Normalizes Gerrit hosts (with '-review') to Git host."""
3111 assert host.endswith(self._GOOGLESOURCE)
3112 # Prefix doesn't include '.' at the end.
3113 prefix = host[:-(1 + len(self._GOOGLESOURCE))]
3114 if prefix.endswith('-review'):
3115 prefix = prefix[:-len('-review')]
3116 return prefix + '.' + self._GOOGLESOURCE
3117
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003118 def _canonical_gerrit_googlesource_host(self, host):
3119 git_host = self._canonical_git_googlesource_host(host)
3120 prefix = git_host.split('.', 1)[0]
3121 return prefix + '-review.' + self._GOOGLESOURCE
3122
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003123 def _get_counterpart_host(self, host):
3124 assert host.endswith(self._GOOGLESOURCE)
3125 git = self._canonical_git_googlesource_host(host)
3126 gerrit = self._canonical_gerrit_googlesource_host(git)
3127 return git if gerrit == host else gerrit
3128
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003129 def has_generic_host(self):
3130 """Returns whether generic .googlesource.com has been configured.
3131
3132 Chrome Infra recommends to use explicit ${host}.googlesource.com instead.
3133 """
3134 for host, _, _ in self.get_hosts_with_creds(include_netrc=False):
3135 if host == '.' + self._GOOGLESOURCE:
3136 return True
3137 return False
3138
3139 def _get_git_gerrit_identity_pairs(self):
3140 """Returns map from canonic host to pair of identities (Git, Gerrit).
3141
3142 One of identities might be None, meaning not configured.
3143 """
3144 host_to_identity_pairs = {}
3145 for host, identity, _ in self.get_hosts_with_creds():
3146 canonical = self._canonical_git_googlesource_host(host)
3147 pair = host_to_identity_pairs.setdefault(canonical, [None, None])
3148 idx = 0 if canonical == host else 1
3149 pair[idx] = identity
3150 return host_to_identity_pairs
3151
3152 def get_partially_configured_hosts(self):
3153 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003154 (host if i1 else self._canonical_gerrit_googlesource_host(host))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003155 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003156 if None in (i1, i2) and host != '.' + self._GOOGLESOURCE)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003157
3158 def get_conflicting_hosts(self):
3159 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003160 host
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003161 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003162 if None not in (i1, i2) and i1 != i2)
3163
3164 def get_duplicated_hosts(self):
3165 counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds())
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003166 return set(host for host, count in counters.items() if count > 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003167
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003168
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003169 @staticmethod
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003170 def _format_hosts(hosts, extra_column_func=None):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003171 hosts = sorted(hosts)
3172 assert hosts
3173 if extra_column_func is None:
3174 extras = [''] * len(hosts)
3175 else:
3176 extras = [extra_column_func(host) for host in hosts]
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003177 tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras)))
3178 lines = []
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003179 for he in zip(hosts, extras):
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003180 lines.append(tmpl % he)
3181 return lines
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003182
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003183 def _find_problems(self):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003184 if self.has_generic_host():
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003185 yield ('.googlesource.com wildcard record detected',
3186 ['Chrome Infrastructure team recommends to list full host names '
3187 'explicitly.'],
3188 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003189
3190 dups = self.get_duplicated_hosts()
3191 if dups:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003192 yield ('The following hosts were defined twice',
3193 self._format_hosts(dups),
3194 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003195
3196 partial = self.get_partially_configured_hosts()
3197 if partial:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003198 yield ('Credentials should come in pairs for Git and Gerrit hosts. '
3199 'These hosts are missing',
3200 self._format_hosts(partial, lambda host: 'but %s defined' %
3201 self._get_counterpart_host(host)),
3202 partial)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003203
3204 conflicting = self.get_conflicting_hosts()
3205 if conflicting:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003206 yield ('The following Git hosts have differing credentials from their '
3207 'Gerrit counterparts',
3208 self._format_hosts(conflicting, lambda host: '%s vs %s' %
3209 tuple(self._get_git_gerrit_identity_pairs()[host])),
3210 conflicting)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003211
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003212 def find_and_report_problems(self):
3213 """Returns True if there was at least one problem, else False."""
3214 found = False
3215 bad_hosts = set()
3216 for title, sublines, hosts in self._find_problems():
3217 if not found:
3218 found = True
3219 print('\n\n.gitcookies problem report:\n')
3220 bad_hosts.update(hosts or [])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003221 print(' %s%s' % (title, (':' if sublines else '')))
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003222 if sublines:
3223 print()
3224 print(' %s' % '\n '.join(sublines))
3225 print()
3226
3227 if bad_hosts:
3228 assert found
3229 print(' You can manually remove corresponding lines in your %s file and '
3230 'visit the following URLs with correct account to generate '
3231 'correct credential lines:\n' %
3232 gerrit_util.CookiesAuthenticator.get_gitcookies_path())
3233 print(' %s' % '\n '.join(sorted(set(
3234 gerrit_util.CookiesAuthenticator().get_new_password_url(
3235 self._canonical_git_googlesource_host(host))
3236 for host in bad_hosts
3237 ))))
3238 return found
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003239
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003240
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003241@metrics.collector.collect_metrics('git cl creds-check')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003242def CMDcreds_check(parser, args):
3243 """Checks credentials and suggests changes."""
3244 _, _ = parser.parse_args(args)
3245
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003246 # Code below checks .gitcookies. Abort if using something else.
3247 authn = gerrit_util.Authenticator.get()
3248 if not isinstance(authn, gerrit_util.CookiesAuthenticator):
Edward Lemur57d47422020-03-06 20:43:07 +00003249 message = (
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003250 'This command is not designed for bot environment. It checks '
3251 '~/.gitcookies file not generally used on bots.')
Edward Lemur57d47422020-03-06 20:43:07 +00003252 # TODO(crbug.com/1059384): Automatically detect when running on cloudtop.
3253 if isinstance(authn, gerrit_util.GceAuthenticator):
3254 message += (
3255 '\n'
3256 'If you need to run this on GCE or a cloudtop instance, '
3257 'export SKIP_GCE_AUTH_FOR_GIT=1 in your env.')
3258 DieWithError(message)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003259
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003260 checker = _GitCookiesChecker()
3261 checker.ensure_configured_gitcookies()
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003262
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003263 print('Your .netrc and .gitcookies have credentials for these hosts:')
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003264 checker.print_current_creds(include_netrc=True)
3265
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003266 if not checker.find_and_report_problems():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003267 print('\nNo problems detected in your .gitcookies file.')
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003268 return 0
3269 return 1
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003270
3271
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003272@metrics.collector.collect_metrics('git cl baseurl')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003273def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003274 """Gets or sets base-url for this branch."""
Edward Lesmes50da7702020-03-30 19:23:43 +00003275 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
Edward Lemur85153282020-02-14 22:06:29 +00003276 branch = scm.GIT.ShortBranchName(branchref)
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003277 _, args = parser.parse_args(args)
3278 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003279 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003280 return RunGit(['config', 'branch.%s.base-url' % branch],
3281 error_ok=False).strip()
3282 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003283 print('Setting base-url to %s' % args[0])
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003284 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3285 error_ok=False).strip()
3286
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003287
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003288def color_for_status(status):
3289 """Maps a Changelist status to color, for CMDstatus and other tools."""
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003290 BOLD = '\033[1m'
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003291 return {
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003292 'unsent': BOLD + Fore.YELLOW,
3293 'waiting': BOLD + Fore.RED,
3294 'reply': BOLD + Fore.YELLOW,
3295 'not lgtm': BOLD + Fore.RED,
3296 'lgtm': BOLD + Fore.GREEN,
3297 'commit': BOLD + Fore.MAGENTA,
3298 'closed': BOLD + Fore.CYAN,
3299 'error': BOLD + Fore.WHITE,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003300 }.get(status, Fore.WHITE)
3301
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003302
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003303def get_cl_statuses(changes, fine_grained, max_processes=None):
3304 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003305
3306 If fine_grained is true, this will fetch CL statuses from the server.
3307 Otherwise, simply indicate if there's a matching url for the given branches.
3308
3309 If max_processes is specified, it is used as the maximum number of processes
3310 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3311 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003312
3313 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003314 """
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003315 if not changes:
Edward Lemur61bf4172020-02-24 23:22:37 +00003316 return
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003317
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003318 if not fine_grained:
3319 # Fast path which doesn't involve querying codereview servers.
Aaron Gablea1bab272017-04-11 16:38:18 -07003320 # Do not use get_approving_reviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003321 for cl in changes:
3322 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003323 return
3324
3325 # First, sort out authentication issues.
3326 logging.debug('ensuring credentials exist')
3327 for cl in changes:
3328 cl.EnsureAuthenticated(force=False, refresh=True)
3329
3330 def fetch(cl):
3331 try:
3332 return (cl, cl.GetStatus())
3333 except:
3334 # See http://crbug.com/629863.
Andrii Shyshkalov98824232018-04-19 11:37:15 -07003335 logging.exception('failed to fetch status for cl %s:', cl.GetIssue())
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003336 raise
3337
3338 threads_count = len(changes)
3339 if max_processes:
3340 threads_count = max(1, min(threads_count, max_processes))
3341 logging.debug('querying %d CLs using %d threads', len(changes), threads_count)
3342
Edward Lemur61bf4172020-02-24 23:22:37 +00003343 pool = multiprocessing.pool.ThreadPool(threads_count)
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003344 fetched_cls = set()
3345 try:
3346 it = pool.imap_unordered(fetch, changes).__iter__()
3347 while True:
3348 try:
3349 cl, status = it.next(timeout=5)
Edward Lemur61bf4172020-02-24 23:22:37 +00003350 except (multiprocessing.TimeoutError, StopIteration):
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003351 break
3352 fetched_cls.add(cl)
3353 yield cl, status
3354 finally:
3355 pool.close()
3356
3357 # Add any branches that failed to fetch.
3358 for cl in set(changes) - fetched_cls:
3359 yield (cl, 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003360
rmistry@google.com2dd99862015-06-22 12:22:18 +00003361
Jose Lopes3863fc52020-04-07 17:00:25 +00003362def upload_branch_deps(cl, args, force=False):
rmistry@google.com2dd99862015-06-22 12:22:18 +00003363 """Uploads CLs of local branches that are dependents of the current branch.
3364
3365 If the local branch dependency tree looks like:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003366
3367 test1 -> test2.1 -> test3.1
3368 -> test3.2
3369 -> test2.2 -> test3.3
rmistry@google.com2dd99862015-06-22 12:22:18 +00003370
3371 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3372 run on the dependent branches in this order:
3373 test2.1, test3.1, test3.2, test2.2, test3.3
3374
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003375 Note: This function does not rebase your local dependent branches. Use it
3376 when you make a change to the parent branch that will not conflict
3377 with its dependent branches, and you would like their dependencies
3378 updated in Rietveld.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003379 """
3380 if git_common.is_dirty_git_tree('upload-branch-deps'):
3381 return 1
3382
3383 root_branch = cl.GetBranch()
3384 if root_branch is None:
3385 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3386 'Get on a branch!')
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00003387 if not cl.GetIssue():
rmistry@google.com2dd99862015-06-22 12:22:18 +00003388 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3389 'patchset dependencies without an uploaded CL.')
3390
3391 branches = RunGit(['for-each-ref',
3392 '--format=%(refname:short) %(upstream:short)',
3393 'refs/heads'])
3394 if not branches:
3395 print('No local branches found.')
3396 return 0
3397
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003398 # Create a dictionary of all local branches to the branches that are
3399 # dependent on it.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003400 tracked_to_dependents = collections.defaultdict(list)
3401 for b in branches.splitlines():
3402 tokens = b.split()
3403 if len(tokens) == 2:
3404 branch_name, tracked = tokens
3405 tracked_to_dependents[tracked].append(branch_name)
3406
vapiera7fbd5a2016-06-16 09:17:49 -07003407 print()
3408 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003409 dependents = []
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003410
rmistry@google.com2dd99862015-06-22 12:22:18 +00003411 def traverse_dependents_preorder(branch, padding=''):
3412 dependents_to_process = tracked_to_dependents.get(branch, [])
3413 padding += ' '
3414 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003415 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003416 dependents.append(dependent)
3417 traverse_dependents_preorder(dependent, padding)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003418
rmistry@google.com2dd99862015-06-22 12:22:18 +00003419 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003420 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003421
3422 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003423 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003424 return 0
3425
Jose Lopes3863fc52020-04-07 17:00:25 +00003426 if not force:
3427 confirm_or_exit('This command will checkout all dependent branches and run '
3428 '"git cl upload".', action='continue')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003429
rmistry@google.com2dd99862015-06-22 12:22:18 +00003430 # Record all dependents that failed to upload.
3431 failures = {}
3432 # Go through all dependents, checkout the branch and upload.
3433 try:
3434 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003435 print()
3436 print('--------------------------------------')
3437 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003438 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003439 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003440 try:
3441 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003442 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003443 failures[dependent_branch] = 1
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003444 except: # pylint: disable=bare-except
rmistry@google.com2dd99862015-06-22 12:22:18 +00003445 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003446 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003447 finally:
3448 # Swap back to the original root branch.
3449 RunGit(['checkout', '-q', root_branch])
3450
vapiera7fbd5a2016-06-16 09:17:49 -07003451 print()
3452 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003453 for dependent_branch in dependents:
3454 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003455 print(' %s : %s' % (dependent_branch, upload_status))
3456 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003457
3458 return 0
3459
3460
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003461def GetArchiveTagForBranch(issue_num, branch_name, existing_tags, pattern):
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003462 """Given a proposed tag name, returns a tag name that is guaranteed to be
3463 unique. If 'foo' is proposed but already exists, then 'foo-2' is used,
3464 or 'foo-3', and so on."""
3465
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003466 proposed_tag = pattern.format(**{'issue': issue_num, 'branch': branch_name})
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003467 for suffix_num in itertools.count(1):
3468 if suffix_num == 1:
3469 to_check = proposed_tag
3470 else:
3471 to_check = '%s-%d' % (proposed_tag, suffix_num)
3472
3473 if to_check not in existing_tags:
3474 return to_check
3475
3476
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003477@metrics.collector.collect_metrics('git cl archive')
kmarshall3bff56b2016-06-06 18:31:47 -07003478def CMDarchive(parser, args):
3479 """Archives and deletes branches associated with closed changelists."""
3480 parser.add_option(
3481 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003482 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003483 parser.add_option(
3484 '-f', '--force', action='store_true',
3485 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003486 parser.add_option(
3487 '-d', '--dry-run', action='store_true',
3488 help='Skip the branch tagging and removal steps.')
3489 parser.add_option(
3490 '-t', '--notags', action='store_true',
3491 help='Do not tag archived branches. '
3492 'Note: local commit history may be lost.')
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003493 parser.add_option(
3494 '-p',
3495 '--pattern',
3496 default='git-cl-archived-{issue}-{branch}',
3497 help='Format string for archive tags. '
3498 'E.g. \'archived-{issue}-{branch}\'.')
kmarshall3bff56b2016-06-06 18:31:47 -07003499
kmarshall3bff56b2016-06-06 18:31:47 -07003500 options, args = parser.parse_args(args)
3501 if args:
3502 parser.error('Unsupported args: %s' % ' '.join(args))
kmarshall3bff56b2016-06-06 18:31:47 -07003503
3504 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3505 if not branches:
3506 return 0
3507
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003508 tags = RunGit(['for-each-ref', '--format=%(refname)',
3509 'refs/tags']).splitlines() or []
3510 tags = [t.split('/')[-1] for t in tags]
3511
vapiera7fbd5a2016-06-16 09:17:49 -07003512 print('Finding all branches associated with closed issues...')
Edward Lemur934836a2019-09-09 20:16:54 +00003513 changes = [Changelist(branchref=b)
3514 for b in branches.splitlines()]
kmarshall3bff56b2016-06-06 18:31:47 -07003515 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3516 statuses = get_cl_statuses(changes,
3517 fine_grained=True,
3518 max_processes=options.maxjobs)
3519 proposal = [(cl.GetBranch(),
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003520 GetArchiveTagForBranch(cl.GetIssue(), cl.GetBranch(), tags,
3521 options.pattern))
kmarshall3bff56b2016-06-06 18:31:47 -07003522 for cl, status in statuses
Andrii Shyshkalov51bdf8c2018-10-18 01:07:58 +00003523 if status in ('closed', 'rietveld-not-supported')]
kmarshall3bff56b2016-06-06 18:31:47 -07003524 proposal.sort()
3525
3526 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003527 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003528 return 0
3529
Edward Lemur85153282020-02-14 22:06:29 +00003530 current_branch = scm.GIT.GetBranch(settings.GetRoot())
kmarshall3bff56b2016-06-06 18:31:47 -07003531
vapiera7fbd5a2016-06-16 09:17:49 -07003532 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003533 if options.notags:
3534 for next_item in proposal:
3535 print(' ' + next_item[0])
3536 else:
3537 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3538 for next_item in proposal:
3539 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003540
kmarshall9249e012016-08-23 12:02:16 -07003541 # Quit now on precondition failure or if instructed by the user, either
3542 # via an interactive prompt or by command line flags.
3543 if options.dry_run:
3544 print('\nNo changes were made (dry run).\n')
3545 return 0
3546 elif any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003547 print('You are currently on a branch \'%s\' which is associated with a '
3548 'closed codereview issue, so archive cannot proceed. Please '
3549 'checkout another branch and run this command again.' %
3550 current_branch)
3551 return 1
kmarshall9249e012016-08-23 12:02:16 -07003552 elif not options.force:
Edward Lesmesae3586b2020-03-23 21:21:14 +00003553 answer = gclient_utils.AskForData('\nProceed with deletion (Y/n)? ').lower()
sergiyb4a5ecbe2016-06-20 09:46:00 -07003554 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003555 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003556 return 1
3557
3558 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003559 if not options.notags:
3560 RunGit(['tag', tagname, branch])
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003561
3562 if RunGitWithCode(['branch', '-D', branch])[0] != 0:
3563 # Clean up the tag if we failed to delete the branch.
3564 RunGit(['tag', '-d', tagname])
kmarshall9249e012016-08-23 12:02:16 -07003565
vapiera7fbd5a2016-06-16 09:17:49 -07003566 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003567
3568 return 0
3569
3570
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003571@metrics.collector.collect_metrics('git cl status')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003572def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003573 """Show status of changelists.
3574
3575 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003576 - Blue waiting for review
Aaron Gable9ab38c62017-04-06 14:36:33 -07003577 - Yellow waiting for you to reply to review, or not yet sent
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003578 - Green LGTM'ed
Aaron Gable9ab38c62017-04-06 14:36:33 -07003579 - Red 'not LGTM'ed
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00003580 - Magenta in the CQ
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003581 - Cyan was committed, branch can be deleted
Aaron Gable9ab38c62017-04-06 14:36:33 -07003582 - White error, or unknown status
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003583
3584 Also see 'git cl comments'.
3585 """
Alan Cuttera3be9a52019-03-04 18:50:33 +00003586 parser.add_option(
3587 '--no-branch-color',
3588 action='store_true',
3589 help='Disable colorized branch names')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003590 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003591 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003592 parser.add_option('-f', '--fast', action='store_true',
3593 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003594 parser.add_option(
3595 '-j', '--maxjobs', action='store', type=int,
3596 help='The maximum number of jobs to use when retrieving review status')
Edward Lemur52969c92020-02-06 18:15:28 +00003597 parser.add_option(
3598 '-i', '--issue', type=int,
3599 help='Operate on this issue instead of the current branch\'s implicit '
3600 'issue. Requires --field to be set.')
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003601 parser.add_option('-d',
3602 '--date-order',
3603 action='store_true',
3604 help='Order branches by committer date.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003605 options, args = parser.parse_args(args)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003606 if args:
3607 parser.error('Unsupported args: %s' % args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003608
iannuccie53c9352016-08-17 14:40:40 -07003609 if options.issue is not None and not options.field:
Edward Lemur6c6827c2020-02-06 21:15:18 +00003610 parser.error('--field must be given when --issue is set.')
iannucci3c972b92016-08-17 13:24:10 -07003611
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003612 if options.field:
Edward Lemur934836a2019-09-09 20:16:54 +00003613 cl = Changelist(issue=options.issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003614 if options.field.startswith('desc'):
Edward Lemur6c6827c2020-02-06 21:15:18 +00003615 if cl.GetIssue():
3616 print(cl.FetchDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003617 elif options.field == 'id':
3618 issueid = cl.GetIssue()
3619 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07003620 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003621 elif options.field == 'patch':
Aaron Gablee8856ee2017-12-07 12:41:46 -08003622 patchset = cl.GetMostRecentPatchset()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003623 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07003624 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07003625 elif options.field == 'status':
3626 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003627 elif options.field == 'url':
3628 url = cl.GetIssueURL()
3629 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07003630 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003631 return 0
3632
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003633 branches = RunGit([
3634 'for-each-ref', '--format=%(refname) %(committerdate:unix)', 'refs/heads'
3635 ])
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003636 if not branches:
3637 print('No local branch found.')
3638 return 0
3639
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003640 changes = [
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003641 Changelist(branchref=b, commit_date=ct)
3642 for b, ct in map(lambda line: line.split(' '), branches.splitlines())
3643 ]
vapiera7fbd5a2016-06-16 09:17:49 -07003644 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003645 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003646 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003647 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003648
Edward Lemur85153282020-02-14 22:06:29 +00003649 current_branch = scm.GIT.GetBranch(settings.GetRoot())
Daniel McArdlea23bf592019-02-12 00:25:12 +00003650
3651 def FormatBranchName(branch, colorize=False):
3652 """Simulates 'git branch' behavior. Colorizes and prefixes branch name with
3653 an asterisk when it is the current branch."""
3654
3655 asterisk = ""
3656 color = Fore.RESET
3657 if branch == current_branch:
3658 asterisk = "* "
3659 color = Fore.GREEN
Edward Lemur85153282020-02-14 22:06:29 +00003660 branch_name = scm.GIT.ShortBranchName(branch)
Daniel McArdlea23bf592019-02-12 00:25:12 +00003661
3662 if colorize:
3663 return asterisk + color + branch_name + Fore.RESET
Daniel McArdle452a49f2019-02-14 17:28:31 +00003664 return asterisk + branch_name
3665
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003666 branch_statuses = {}
Daniel McArdlea23bf592019-02-12 00:25:12 +00003667
3668 alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes))
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003669 if options.date_order:
3670 sorted_changes = sorted(changes,
3671 key=lambda c: c.GetCommitDate(),
3672 reverse=True)
3673 else:
3674 sorted_changes = sorted(changes, key=lambda c: c.GetBranch())
3675 for cl in sorted_changes:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003676 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003677 while branch not in branch_statuses:
Edward Lemur79d4f992019-11-11 23:49:02 +00003678 c, status = next(output)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003679 branch_statuses[c.GetBranch()] = status
3680 status = branch_statuses.pop(branch)
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00003681 url = cl.GetIssueURL(short=True)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003682 if url and (not status or status == 'error'):
3683 # The issue probably doesn't exist anymore.
3684 url += ' (broken)'
3685
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003686 color = color_for_status(status)
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003687 # Turn off bold as well as colors.
3688 END = '\033[0m'
3689 reset = Fore.RESET + END
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00003690 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00003691 color = ''
3692 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003693 status_str = '(%s)' % status if status else ''
Daniel McArdle452a49f2019-02-14 17:28:31 +00003694
Alan Cuttera3be9a52019-03-04 18:50:33 +00003695 branch_display = FormatBranchName(branch)
3696 padding = ' ' * (alignment - len(branch_display))
3697 if not options.no_branch_color:
3698 branch_display = FormatBranchName(branch, colorize=True)
Daniel McArdle452a49f2019-02-14 17:28:31 +00003699
Alan Cuttera3be9a52019-03-04 18:50:33 +00003700 print(' %s : %s%s %s%s' % (padding + branch_display, color, url,
3701 status_str, reset))
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003702
vapiera7fbd5a2016-06-16 09:17:49 -07003703 print()
Daniel McArdlea23bf592019-02-12 00:25:12 +00003704 print('Current branch: %s' % current_branch)
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003705 for cl in changes:
Daniel McArdlea23bf592019-02-12 00:25:12 +00003706 if cl.GetBranch() == current_branch:
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003707 break
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003708 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07003709 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003710 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07003711 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00003712 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07003713 print('Issue description:')
Edward Lemur6c6827c2020-02-06 21:15:18 +00003714 print(cl.FetchDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003715 return 0
3716
3717
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003718def colorize_CMDstatus_doc():
3719 """To be called once in main() to add colors to git cl status help."""
3720 colors = [i for i in dir(Fore) if i[0].isupper()]
3721
3722 def colorize_line(line):
3723 for color in colors:
3724 if color in line.upper():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003725 # Extract whitespace first and the leading '-'.
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003726 indent = len(line) - len(line.lstrip(' ')) + 1
3727 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
3728 return line
3729
3730 lines = CMDstatus.__doc__.splitlines()
3731 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
3732
3733
phajdan.jre328cf92016-08-22 04:12:17 -07003734def write_json(path, contents):
Stefan Zager1306bd02017-06-22 19:26:46 -07003735 if path == '-':
3736 json.dump(contents, sys.stdout)
3737 else:
3738 with open(path, 'w') as f:
3739 json.dump(contents, f)
phajdan.jre328cf92016-08-22 04:12:17 -07003740
3741
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003742@subcommand.usage('[issue_number]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003743@metrics.collector.collect_metrics('git cl issue')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003744def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003745 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003746
3747 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003748 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00003749 parser.add_option('-r', '--reverse', action='store_true',
3750 help='Lookup the branch(es) for the specified issues. If '
3751 'no issues are specified, all branches with mapped '
3752 'issues will be listed.')
Stefan Zager1306bd02017-06-22 19:26:46 -07003753 parser.add_option('--json',
3754 help='Path to JSON output file, or "-" for stdout.')
dnj@chromium.org406c4402015-03-03 17:22:28 +00003755 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003756
dnj@chromium.org406c4402015-03-03 17:22:28 +00003757 if options.reverse:
3758 branches = RunGit(['for-each-ref', 'refs/heads',
Aaron Gablead64abd2017-12-04 09:49:13 -08003759 '--format=%(refname)']).splitlines()
dnj@chromium.org406c4402015-03-03 17:22:28 +00003760 # Reverse issue lookup.
3761 issue_branch_map = {}
Daniel Bratellb56a43a2018-09-06 15:49:03 +00003762
3763 git_config = {}
3764 for config in RunGit(['config', '--get-regexp',
3765 r'branch\..*issue']).splitlines():
3766 name, _space, val = config.partition(' ')
3767 git_config[name] = val
3768
dnj@chromium.org406c4402015-03-03 17:22:28 +00003769 for branch in branches:
Edward Lesmes50da7702020-03-30 19:23:43 +00003770 issue = git_config.get(
3771 'branch.%s.%s' % (scm.GIT.ShortBranchName(branch), ISSUE_CONFIG_KEY))
Edward Lemur52969c92020-02-06 18:15:28 +00003772 if issue:
3773 issue_branch_map.setdefault(int(issue), []).append(branch)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003774 if not args:
Carlos Caballero81923d62020-07-06 18:22:27 +00003775 args = sorted(issue_branch_map.keys())
phajdan.jre328cf92016-08-22 04:12:17 -07003776 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00003777 for issue in args:
Lei Zhang5a368d42019-03-25 23:18:19 +00003778 try:
3779 issue_num = int(issue)
3780 except ValueError:
3781 print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003782 continue
Lei Zhang5a368d42019-03-25 23:18:19 +00003783 result[issue_num] = issue_branch_map.get(issue_num)
vapiera7fbd5a2016-06-16 09:17:49 -07003784 print('Branch for issue number %s: %s' % (
Lei Zhang5a368d42019-03-25 23:18:19 +00003785 issue, ', '.join(issue_branch_map.get(issue_num) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07003786 if options.json:
3787 write_json(options.json, result)
Aaron Gable78753da2017-06-15 10:35:49 -07003788 return 0
3789
3790 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003791 issue = ParseIssueNumberArgument(args[0])
Aaron Gable78753da2017-06-15 10:35:49 -07003792 if not issue.valid:
3793 DieWithError('Pass a url or number to set the issue, 0 to unset it, '
3794 'or no argument to list it.\n'
3795 'Maybe you want to run git cl status?')
Edward Lemurf38bc172019-09-03 21:02:13 +00003796 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003797 cl.SetIssue(issue.issue)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003798 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003799 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003800 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
3801 if options.json:
3802 write_json(options.json, {
Nodir Turakulov27379632021-03-17 18:53:29 +00003803 'gerrit_host': cl.GetGerritHost(),
3804 'gerrit_project': cl.GetGerritProject(),
Aaron Gable78753da2017-06-15 10:35:49 -07003805 'issue_url': cl.GetIssueURL(),
Nodir Turakulov27379632021-03-17 18:53:29 +00003806 'issue': cl.GetIssue(),
Aaron Gable78753da2017-06-15 10:35:49 -07003807 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003808 return 0
3809
3810
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003811@metrics.collector.collect_metrics('git cl comments')
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003812def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003813 """Shows or posts review comments for any changelist."""
3814 parser.add_option('-a', '--add-comment', dest='comment',
3815 help='comment to add to an issue')
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003816 parser.add_option('-p', '--publish', action='store_true',
3817 help='marks CL as ready and sends comment to reviewers')
Andrii Shyshkalov0d6b46e2017-03-17 22:23:22 +01003818 parser.add_option('-i', '--issue', dest='issue',
Edward Lemurf38bc172019-09-03 21:02:13 +00003819 help='review issue id (defaults to current issue).')
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003820 parser.add_option('-m', '--machine-readable', dest='readable',
3821 action='store_false', default=True,
3822 help='output comments in a format compatible with '
3823 'editor parsing')
smut@google.comc85ac942015-09-15 16:34:43 +00003824 parser.add_option('-j', '--json-file',
Stefan Zager1306bd02017-06-22 19:26:46 -07003825 help='File to write JSON summary to, or "-" for stdout')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003826 options, args = parser.parse_args(args)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003827
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003828 issue = None
3829 if options.issue:
3830 try:
3831 issue = int(options.issue)
3832 except ValueError:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003833 DieWithError('A review issue ID is expected to be a number.')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003834
Edward Lemur934836a2019-09-09 20:16:54 +00003835 cl = Changelist(issue=issue)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003836
3837 if options.comment:
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003838 cl.AddComment(options.comment, options.publish)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003839 return 0
3840
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003841 summary = sorted(cl.GetCommentsSummary(readable=options.readable),
3842 key=lambda c: c.date)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003843 for comment in summary:
3844 if comment.disapproval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003845 color = Fore.RED
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003846 elif comment.approval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003847 color = Fore.GREEN
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003848 elif comment.sender == cl.GetIssueOwner():
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003849 color = Fore.MAGENTA
Quinten Yearsley0e617c02019-02-20 00:37:03 +00003850 elif comment.autogenerated:
3851 color = Fore.CYAN
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003852 else:
3853 color = Fore.BLUE
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003854 print('\n%s%s %s%s\n%s' % (
3855 color,
3856 comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'),
3857 comment.sender,
3858 Fore.RESET,
3859 '\n'.join(' ' + l for l in comment.message.strip().splitlines())))
3860
smut@google.comc85ac942015-09-15 16:34:43 +00003861 if options.json_file:
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003862 def pre_serialize(c):
Edward Lemur79d4f992019-11-11 23:49:02 +00003863 dct = c._asdict().copy()
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003864 dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f')
3865 return dct
Edward Lemur79d4f992019-11-11 23:49:02 +00003866 write_json(options.json_file, [pre_serialize(x) for x in summary])
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003867 return 0
3868
3869
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003870@subcommand.usage('[codereview url or issue id]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003871@metrics.collector.collect_metrics('git cl description')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003872def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003873 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00003874 parser.add_option('-d', '--display', action='store_true',
3875 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003876 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07003877 help='New description to set for this issue (- for stdin, '
3878 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07003879 parser.add_option('-f', '--force', action='store_true',
3880 help='Delete any unpublished Gerrit edits for this issue '
3881 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003882
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003883 options, args = parser.parse_args(args)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003884
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003885 target_issue_arg = None
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003886 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003887 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003888 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003889 parser.error('Invalid issue ID or URL.')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003890
Edward Lemur934836a2019-09-09 20:16:54 +00003891 kwargs = {}
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003892 if target_issue_arg:
3893 kwargs['issue'] = target_issue_arg.issue
3894 kwargs['codereview_host'] = target_issue_arg.hostname
martiniss6eda05f2016-06-30 10:18:35 -07003895
3896 cl = Changelist(**kwargs)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003897 if not cl.GetIssue():
3898 DieWithError('This branch has no associated changelist.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02003899
Edward Lemur678a6842019-10-03 22:25:05 +00003900 if args and not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00003901 logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02003902
Edward Lemur6c6827c2020-02-06 21:15:18 +00003903 description = ChangeDescription(cl.FetchDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003904
smut@google.com34fb6b12015-07-13 20:03:26 +00003905 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07003906 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00003907 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003908
3909 if options.new_description:
3910 text = options.new_description
3911 if text == '-':
3912 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07003913 elif text == '+':
3914 base_branch = cl.GetCommonAncestorWithUpstream()
Edward Lemura12175c2020-03-09 16:58:26 +00003915 text = _create_description_from_log([base_branch])
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003916
3917 description.set_description(text)
3918 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003919 description.prompt()
Edward Lemur6c6827c2020-02-06 21:15:18 +00003920 if cl.FetchDescription().strip() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07003921 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003922 return 0
3923
3924
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003925@metrics.collector.collect_metrics('git cl lint')
thestig@chromium.org44202a22014-03-11 19:22:18 +00003926def CMDlint(parser, args):
3927 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00003928 parser.add_option('--filter', action='append', metavar='-x,+y',
3929 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003930 options, args = parser.parse_args(args)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003931
3932 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003933 # pylint: disable=protected-access
thestig@chromium.org44202a22014-03-11 19:22:18 +00003934 try:
3935 import cpplint
3936 import cpplint_chromium
3937 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07003938 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00003939 return 1
3940
3941 # Change the current working directory before calling lint so that it
3942 # shows the correct base.
3943 previous_cwd = os.getcwd()
3944 os.chdir(settings.GetRoot())
3945 try:
Edward Lemur934836a2019-09-09 20:16:54 +00003946 cl = Changelist()
Edward Lemur2c62b332020-03-12 22:12:33 +00003947 files = cl.GetAffectedFiles(cl.GetCommonAncestorWithUpstream())
thestig@chromium.org5839eb52014-05-30 16:20:51 +00003948 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07003949 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00003950 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00003951
Lei Zhangb8c62cf2020-07-15 20:09:37 +00003952 # Process cpplint arguments, if any.
3953 filters = presubmit_canned_checks.GetCppLintFilters(options.filter)
3954 command = ['--filter=' + ','.join(filters)] + args + files
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00003955 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003956
Lei Zhang379d1ad2020-07-15 19:40:06 +00003957 include_regex = re.compile(settings.GetLintRegex())
3958 ignore_regex = re.compile(settings.GetLintIgnoreRegex())
thestig@chromium.org44202a22014-03-11 19:22:18 +00003959 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
3960 for filename in filenames:
Lei Zhang379d1ad2020-07-15 19:40:06 +00003961 if not include_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07003962 print('Skipping file %s' % filename)
Lei Zhang379d1ad2020-07-15 19:40:06 +00003963 continue
3964
3965 if ignore_regex.match(filename):
3966 print('Ignoring file %s' % filename)
3967 continue
3968
3969 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
3970 extra_check_functions)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003971 finally:
3972 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07003973 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003974 if cpplint._cpplint_state.error_count != 0:
3975 return 1
3976 return 0
3977
3978
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003979@metrics.collector.collect_metrics('git cl presubmit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003980def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003981 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00003982 parser.add_option('-u', '--upload', action='store_true',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08003983 help='Run upload hook instead of the push hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00003984 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00003985 help='Run checks even if tree is dirty')
Aaron Gable8076c282017-11-29 14:39:41 -08003986 parser.add_option('--all', action='store_true',
3987 help='Run checks against all files, not just modified ones')
Edward Lesmes8e282792018-04-03 18:50:29 -04003988 parser.add_option('--parallel', action='store_true',
3989 help='Run all tests specified by input_api.RunTests in all '
3990 'PRESUBMIT files in parallel.')
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00003991 parser.add_option('--resultdb', action='store_true',
3992 help='Run presubmit checks in the ResultSink environment '
3993 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00003994 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003995 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003996
sbc@chromium.org71437c02015-04-09 19:29:40 +00003997 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07003998 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003999 return 1
4000
Edward Lemur934836a2019-09-09 20:16:54 +00004001 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004002 if args:
4003 base_branch = args[0]
4004 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004005 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004006 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004007
Gregory Nisbet29d5cf82020-02-27 08:16:58 +00004008 if cl.GetIssue():
4009 description = cl.FetchDescription()
Aaron Gable8076c282017-11-29 14:39:41 -08004010 else:
Edward Lemura12175c2020-03-09 16:58:26 +00004011 description = _create_description_from_log([base_branch])
Aaron Gable8076c282017-11-29 14:39:41 -08004012
ilevy@chromium.org051ad0e2013-03-04 21:57:34 +00004013 cl.RunHook(
4014 committing=not options.upload,
4015 may_prompt=False,
4016 verbose=options.verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00004017 parallel=options.parallel,
4018 upstream=base_branch,
4019 description=description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004020 all_files=options.all,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004021 resultdb=options.resultdb,
4022 realm=options.realm)
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00004023 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004024
4025
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004026def GenerateGerritChangeId(message):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004027 """Returns the Change ID footer value (Ixxxxxx...xxx).
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004028
4029 Works the same way as
4030 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
4031 but can be called on demand on all platforms.
4032
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004033 The basic idea is to generate git hash of a state of the tree, original
4034 commit message, author/committer info and timestamps.
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004035 """
4036 lines = []
4037 tree_hash = RunGitSilent(['write-tree'])
4038 lines.append('tree %s' % tree_hash.strip())
4039 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
4040 if code == 0:
4041 lines.append('parent %s' % parent.strip())
4042 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
4043 lines.append('author %s' % author.strip())
4044 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
4045 lines.append('committer %s' % committer.strip())
4046 lines.append('')
4047 # Note: Gerrit's commit-hook actually cleans message of some lines and
4048 # whitespace. This code is not doing this, but it clearly won't decrease
4049 # entropy.
4050 lines.append(message)
4051 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
Raul Tambreb946b232019-03-26 14:48:46 +00004052 stdin=('\n'.join(lines)).encode())
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004053 return 'I%s' % change_hash.strip()
4054
4055
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01004056def GetTargetRef(remote, remote_branch, target_branch):
wittman@chromium.org455dc922015-01-26 20:15:50 +00004057 """Computes the remote branch ref to use for the CL.
4058
4059 Args:
4060 remote (str): The git remote for the CL.
4061 remote_branch (str): The git remote branch for the CL.
4062 target_branch (str): The target branch specified by the user.
wittman@chromium.org455dc922015-01-26 20:15:50 +00004063 """
4064 if not (remote and remote_branch):
4065 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004066
wittman@chromium.org455dc922015-01-26 20:15:50 +00004067 if target_branch:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004068 # Canonicalize branch references to the equivalent local full symbolic
wittman@chromium.org455dc922015-01-26 20:15:50 +00004069 # refs, which are then translated into the remote full symbolic refs
4070 # below.
4071 if '/' not in target_branch:
4072 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4073 else:
4074 prefix_replacements = (
4075 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4076 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4077 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4078 )
4079 match = None
4080 for regex, replacement in prefix_replacements:
4081 match = re.search(regex, target_branch)
4082 if match:
4083 remote_branch = target_branch.replace(match.group(0), replacement)
4084 break
4085 if not match:
4086 # This is a branch path but not one we recognize; use as-is.
4087 remote_branch = target_branch
rmistry@google.comc68112d2015-03-03 12:48:06 +00004088 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
4089 # Handle the refs that need to land in different refs.
4090 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004091
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004092 # Migration to new default branch, only if available on remote.
4093 allow_push_on_master = bool(os.environ.get("ALLOW_PUSH_TO_MASTER", None))
4094 if remote_branch == DEFAULT_OLD_BRANCH and not allow_push_on_master:
4095 if RunGit(['show-branch', DEFAULT_NEW_BRANCH], error_ok=True,
4096 stderr=subprocess2.PIPE):
4097 # TODO(crbug.com/ID): Print location to local git migration script.
4098 print("WARNING: Using new branch name %s instead of %s" % (
4099 DEFAULT_NEW_BRANCH, DEFAULT_OLD_BRANCH))
4100 remote_branch = DEFAULT_NEW_BRANCH
4101
wittman@chromium.org455dc922015-01-26 20:15:50 +00004102 # Create the true path to the remote branch.
4103 # Does the following translation:
4104 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004105 # * refs/remotes/origin/main -> refs/heads/main
wittman@chromium.org455dc922015-01-26 20:15:50 +00004106 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4107 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4108 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4109 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4110 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4111 'refs/heads/')
4112 elif remote_branch.startswith('refs/remotes/branch-heads'):
4113 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +01004114
wittman@chromium.org455dc922015-01-26 20:15:50 +00004115 return remote_branch
4116
4117
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004118def cleanup_list(l):
4119 """Fixes a list so that comma separated items are put as individual items.
4120
4121 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4122 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4123 """
4124 items = sum((i.split(',') for i in l), [])
4125 stripped_items = (i.strip() for i in items)
4126 return sorted(filter(None, stripped_items))
4127
4128
Aaron Gable4db38df2017-11-03 14:59:07 -07004129@subcommand.usage('[flags]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004130@metrics.collector.collect_metrics('git cl upload')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004131def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004132 """Uploads the current changelist to codereview.
4133
4134 Can skip dependency patchset uploads for a branch by running:
4135 git config branch.branch_name.skip-deps-uploads True
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004136 To unset, run:
rmistry@google.com78948ed2015-07-08 23:09:57 +00004137 git config --unset branch.branch_name.skip-deps-uploads
4138 Can also set the above globally by using the --global flag.
Dominic Battre7d1c4842017-10-27 09:17:28 +02004139
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004140 If the name of the checked out branch starts with "bug-" or "fix-" followed
4141 by a bug number, this bug number is automatically populated in the CL
Dominic Battre7d1c4842017-10-27 09:17:28 +02004142 description.
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004143
4144 If subject contains text in square brackets or has "<text>: " prefix, such
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004145 text(s) is treated as Gerrit hashtags. For example, CLs with subjects:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004146 [git-cl] add support for hashtags
4147 Foo bar: implement foo
4148 will be hashtagged with "git-cl" and "foo-bar" respectively.
rmistry@google.com78948ed2015-07-08 23:09:57 +00004149 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004150 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4151 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004152 parser.add_option('--bypass-watchlists', action='store_true',
4153 dest='bypass_watchlists',
4154 help='bypass watchlists auto CC-ing reviewers')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004155 parser.add_option('-f', '--force', action='store_true', dest='force',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004156 help="force yes to questions (don't prompt)")
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004157 parser.add_option('--message', '-m', dest='message',
4158 help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004159 parser.add_option('-b', '--bug',
4160 help='pre-populate the bug number(s) for this issue. '
4161 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004162 parser.add_option('--message-file', dest='message_file',
4163 help='file which contains message for patchset')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004164 parser.add_option('--title', '-t', dest='title',
4165 help='title for patchset')
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004166 parser.add_option('-T', '--skip-title', action='store_true',
4167 dest='skip_title',
4168 help='Use the most recent commit message as the title of '
4169 'the patchset')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004170 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004171 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004172 help='reviewer email addresses')
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004173 parser.add_option('--tbrs',
4174 action='append', default=[],
4175 help='TBR email addresses')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004176 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004177 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004178 help='cc email addresses')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004179 parser.add_option('--hashtag', dest='hashtags',
4180 action='append', default=[],
4181 help=('Gerrit hashtag for new CL; '
4182 'can be applied multiple times'))
adamk@chromium.org36f47302013-04-05 01:08:31 +00004183 parser.add_option('-s', '--send-mail', action='store_true',
Aaron Gable59f48512017-01-12 10:54:46 -08004184 help='send email to reviewer(s) and cc(s) immediately')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004185 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004186 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004187 metavar='TARGET',
4188 help='Apply CL to remote ref TARGET. ' +
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004189 'Default: remote branch head, or main')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004190 parser.add_option('--squash', action='store_true',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004191 help='Squash multiple commits into one')
Mike Frysingera989d552019-08-14 20:51:23 +00004192 parser.add_option('--no-squash', action='store_false', dest='squash',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004193 help='Don\'t squash multiple commits into one')
rmistry9eadede2016-09-19 11:22:43 -07004194 parser.add_option('--topic', default=None,
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004195 help='Topic to specify when uploading')
Robert Iannuccif2708bd2017-04-17 15:49:02 -07004196 parser.add_option('--tbr-owners', dest='add_owners_to', action='store_const',
4197 const='TBR', help='add a set of OWNERS to TBR')
4198 parser.add_option('--r-owners', dest='add_owners_to', action='store_const',
4199 const='R', help='add a set of OWNERS to R')
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004200 parser.add_option('-c', '--use-commit-queue', action='store_true',
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004201 default=False,
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004202 help='tell the CQ to commit this patchset; '
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004203 'implies --send-mail')
4204 parser.add_option('-d', '--cq-dry-run',
4205 action='store_true', default=False,
rmistry@google.comef966222015-04-07 11:15:01 +00004206 help='Send the patchset to do a CQ dry run right after '
4207 'upload.')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00004208 parser.add_option('--set-bot-commit', action='store_true',
4209 help=optparse.SUPPRESS_HELP)
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00004210 parser.add_option('--preserve-tryjobs', action='store_true',
4211 help='instruct the CQ to let tryjobs running even after '
4212 'new patchsets are uploaded instead of canceling '
4213 'prior patchset\' tryjobs')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004214 parser.add_option('--dependencies', action='store_true',
4215 help='Uploads CLs of all the local branches that depend on '
4216 'the current branch')
Ravi Mistry31e7d562018-04-02 12:53:57 -04004217 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4218 help='Sends your change to the CQ after an approval. Only '
4219 'works on repos that have the Auto-Submit label '
4220 'enabled')
Edward Lesmes8e282792018-04-03 18:50:29 -04004221 parser.add_option('--parallel', action='store_true',
4222 help='Run all tests specified by input_api.RunTests in all '
4223 'PRESUBMIT files in parallel.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004224 parser.add_option('--no-autocc', action='store_true',
4225 help='Disables automatic addition of CC emails')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004226 parser.add_option('--private', action='store_true',
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004227 help='Set the review private. This implies --no-autocc.')
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004228 parser.add_option('-R', '--retry-failed', action='store_true',
4229 help='Retry failed tryjobs from old patchset immediately '
4230 'after uploading new patchset. Cannot be used with '
4231 '--use-commit-queue or --cq-dry-run.')
4232 parser.add_option('--buildbucket-host', default='cr-buildbucket.appspot.com',
4233 help='Host of buildbucket. The default host is %default.')
Dan Beamd8b04ca2019-10-10 21:23:26 +00004234 parser.add_option('--fixed', '-x',
4235 help='List of bugs that will be commented on and marked '
4236 'fixed (pre-populates "Fixed:" tag). Same format as '
4237 '-b option / "Bug:" tag. If fixing several issues, '
4238 'separate with commas.')
Josipe827b0f2020-01-30 00:07:20 +00004239 parser.add_option('--edit-description', action='store_true', default=False,
4240 help='Modify description before upload. Cannot be used '
4241 'with --force. It is a noop when --no-squash is set '
4242 'or a new commit is created.')
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004243 parser.add_option('--git-completion-helper', action="store_true",
4244 help=optparse.SUPPRESS_HELP)
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004245 parser.add_option('--resultdb', action='store_true',
4246 help='Run presubmit checks in the ResultSink environment '
4247 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004248 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00004249 parser.add_option('-o',
4250 '--push-options',
4251 action='append',
4252 default=[],
4253 help='Transmit the given string to the server when '
4254 'performing git push (pass-through). See git-push '
4255 'documentation for more details.')
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00004256 parser.add_option('--no-add-changeid',
4257 action='store_true',
4258 dest='no_add_changeid',
4259 help='Do not add change-ids to messages.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004260
rmistry@google.com2dd99862015-06-22 12:22:18 +00004261 orig_args = args
ukai@chromium.orge8077812012-02-03 03:41:46 +00004262 (options, args) = parser.parse_args(args)
4263
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004264 if options.git_completion_helper:
Edward Lesmesb7db1832020-06-22 20:22:27 +00004265 print(' '.join(opt.get_opt_string() for opt in parser.option_list
4266 if opt.help != optparse.SUPPRESS_HELP))
4267 return
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004268
sbc@chromium.org71437c02015-04-09 19:29:40 +00004269 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004270 return 1
4271
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004272 options.reviewers = cleanup_list(options.reviewers)
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004273 options.tbrs = cleanup_list(options.tbrs)
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004274 options.cc = cleanup_list(options.cc)
4275
Josipe827b0f2020-01-30 00:07:20 +00004276 if options.edit_description and options.force:
4277 parser.error('Only one of --force and --edit-description allowed')
4278
tandriib80458a2016-06-23 12:20:07 -07004279 if options.message_file:
4280 if options.message:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004281 parser.error('Only one of --message and --message-file allowed.')
tandriib80458a2016-06-23 12:20:07 -07004282 options.message = gclient_utils.FileRead(options.message_file)
tandriib80458a2016-06-23 12:20:07 -07004283
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004284 if ([options.cq_dry_run,
4285 options.use_commit_queue,
4286 options.retry_failed].count(True) > 1):
4287 parser.error('Only one of --use-commit-queue, --cq-dry-run, or '
4288 '--retry-failed is allowed.')
tandrii4d0545a2016-07-06 03:56:49 -07004289
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004290 if options.skip_title and options.title:
4291 parser.error('Only one of --title and --skip-title allowed.')
4292
Aaron Gableedbc4132017-09-11 13:22:28 -07004293 if options.use_commit_queue:
4294 options.send_mail = True
4295
Edward Lesmes0dd54822020-03-26 18:24:25 +00004296 if options.squash is None:
4297 # Load default for user, repo, squash=true, in this order.
4298 options.squash = settings.GetSquashGerritUploads()
4299
Josip Sokcevic1cabb172021-04-08 19:15:35 +00004300 cl = Changelist(branchref=options.target_branch)
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004301 # Warm change details cache now to avoid RPCs later, reducing latency for
4302 # developers.
4303 if cl.GetIssue():
4304 cl._GetChangeDetail(
4305 ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS'])
4306
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004307 if options.retry_failed and not cl.GetIssue():
4308 print('No previous patchsets, so --retry-failed has no effect.')
4309 options.retry_failed = False
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004310
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004311 # cl.GetMostRecentPatchset uses cached information, and can return the last
4312 # patchset before upload. Calling it here makes it clear that it's the
4313 # last patchset before upload. Note that GetMostRecentPatchset will fail
4314 # if no CL has been uploaded yet.
4315 if options.retry_failed:
4316 patchset = cl.GetMostRecentPatchset()
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00004317
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004318 ret = cl.CMDUpload(options, args, orig_args)
4319
4320 if options.retry_failed:
4321 if ret != 0:
4322 print('Upload failed, so --retry-failed has no effect.')
4323 return ret
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +00004324 builds, _ = _fetch_latest_builds(
Edward Lemur5b929a42019-10-21 17:57:39 +00004325 cl, options.buildbucket_host, latest_patchset=patchset)
Edward Lemur45768512020-03-02 19:03:14 +00004326 jobs = _filter_failed_for_retry(builds)
4327 if len(jobs) == 0:
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004328 print('No failed tryjobs, so --retry-failed has no effect.')
4329 return ret
Quinten Yearsley777660f2020-03-04 23:37:06 +00004330 _trigger_tryjobs(cl, jobs, options, patchset + 1)
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004331
4332 return ret
ukai@chromium.orge8077812012-02-03 03:41:46 +00004333
4334
Francois Dorayd42c6812017-05-30 15:10:20 -04004335@subcommand.usage('--description=<description file>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004336@metrics.collector.collect_metrics('git cl split')
Francois Dorayd42c6812017-05-30 15:10:20 -04004337def CMDsplit(parser, args):
4338 """Splits a branch into smaller branches and uploads CLs.
4339
4340 Creates a branch and uploads a CL for each group of files modified in the
4341 current branch that share a common OWNERS file. In the CL description and
Edward Lemurac5c55f2020-02-29 00:17:16 +00004342 comment, the string '$directory', is replaced with the directory containing
4343 the shared OWNERS file.
Francois Dorayd42c6812017-05-30 15:10:20 -04004344 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004345 parser.add_option('-d', '--description', dest='description_file',
4346 help='A text file containing a CL description in which '
4347 '$directory will be replaced by each CL\'s directory.')
4348 parser.add_option('-c', '--comment', dest='comment_file',
4349 help='A text file containing a CL comment.')
4350 parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true',
Chris Watkinsba28e462017-12-13 11:22:17 +11004351 default=False,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004352 help='List the files and reviewers for each CL that would '
4353 'be created, but don\'t create branches or CLs.')
4354 parser.add_option('--cq-dry-run', action='store_true',
4355 help='If set, will do a cq dry run for each uploaded CL. '
4356 'Please be careful when doing this; more than ~10 CLs '
4357 'has the potential to overload our build '
4358 'infrastructure. Try to upload these not during high '
4359 'load times (usually 11-3 Mountain View time). Email '
4360 'infra-dev@chromium.org with any questions.')
Takuto Ikuta51eca592019-02-14 19:40:52 +00004361 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4362 default=True,
4363 help='Sends your change to the CQ after an approval. Only '
4364 'works on repos that have the Auto-Submit label '
4365 'enabled')
Francois Dorayd42c6812017-05-30 15:10:20 -04004366 options, _ = parser.parse_args(args)
4367
4368 if not options.description_file:
4369 parser.error('No --description flag specified.')
4370
4371 def WrappedCMDupload(args):
4372 return CMDupload(OptionParser(), args)
4373
Edward Lemur2c62b332020-03-12 22:12:33 +00004374 return split_cl.SplitCl(
4375 options.description_file, options.comment_file, Changelist,
4376 WrappedCMDupload, options.dry_run, options.cq_dry_run,
4377 options.enable_auto_submit, settings.GetRoot())
Francois Dorayd42c6812017-05-30 15:10:20 -04004378
4379
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004380@subcommand.usage('DEPRECATED')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004381@metrics.collector.collect_metrics('git cl commit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004382def CMDdcommit(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004383 """DEPRECATED: Used to commit the current changelist via git-svn."""
4384 message = ('git-cl no longer supports committing to SVN repositories via '
4385 'git-svn. You probably want to use `git cl land` instead.')
4386 print(message)
4387 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004388
4389
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004390@subcommand.usage('[upstream branch to apply against]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004391@metrics.collector.collect_metrics('git cl land')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004392def CMDland(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004393 """Commits the current changelist via git.
4394
4395 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4396 upstream and closes the issue automatically and atomically.
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004397 """
4398 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4399 help='bypass upload presubmit hook')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004400 parser.add_option('-f', '--force', action='store_true', dest='force',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004401 help="force yes to questions (don't prompt)")
Edward Lesmes67b3faa2018-04-13 17:50:52 -04004402 parser.add_option('--parallel', action='store_true',
4403 help='Run all tests specified by input_api.RunTests in all '
4404 'PRESUBMIT files in parallel.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004405 parser.add_option('--resultdb', action='store_true',
4406 help='Run presubmit checks in the ResultSink environment '
4407 'and send results to the ResultDB database.')
4408 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004409 (options, args) = parser.parse_args(args)
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004410
Edward Lemur934836a2019-09-09 20:16:54 +00004411 cl = Changelist()
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004412
Robert Iannucci2e73d432018-03-14 01:10:47 -07004413 if not cl.GetIssue():
4414 DieWithError('You must upload the change first to Gerrit.\n'
4415 ' If you would rather have `git cl land` upload '
4416 'automatically for you, see http://crbug.com/642759')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004417 return cl.CMDLand(options.force, options.bypass_hooks, options.verbose,
4418 options.parallel, options.resultdb, options.realm)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004419
4420
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004421@subcommand.usage('<patch url or issue id or issue url>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004422@metrics.collector.collect_metrics('git cl patch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004423def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004424 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004425 parser.add_option('-b', dest='newbranch',
4426 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004427 parser.add_option('-f', '--force', action='store_true',
Aaron Gable62619a32017-06-16 08:22:09 -07004428 help='overwrite state on the current or chosen branch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004429 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
Edward Lemurf38bc172019-09-03 21:02:13 +00004430 help='don\'t commit after patch applies.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004431
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004432 group = optparse.OptionGroup(
4433 parser,
4434 'Options for continuing work on the current issue uploaded from a '
4435 'different clone (e.g. different machine). Must be used independently '
4436 'from the other options. No issue number should be specified, and the '
4437 'branch must have an issue number associated with it')
4438 group.add_option('--reapply', action='store_true', dest='reapply',
4439 help='Reset the branch and reapply the issue.\n'
4440 'CAUTION: This will undo any local changes in this '
4441 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004442
4443 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004444 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004445 parser.add_option_group(group)
4446
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004447 (options, args) = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004448
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004449 if options.reapply:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004450 if options.newbranch:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004451 parser.error('--reapply works on the current branch only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004452 if len(args) > 0:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004453 parser.error('--reapply implies no additional arguments.')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004454
Edward Lemur934836a2019-09-09 20:16:54 +00004455 cl = Changelist()
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004456 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004457 parser.error('Current branch must have an associated issue.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004458
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004459 upstream = cl.GetUpstreamBranch()
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004460 if upstream is None:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004461 parser.error('No upstream branch specified. Cannot reset branch.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004462
4463 RunGit(['reset', '--hard', upstream])
4464 if options.pull:
4465 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004466
Edward Lemur678a6842019-10-03 22:25:05 +00004467 target_issue_arg = ParseIssueNumberArgument(cl.GetIssue())
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004468 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, False,
4469 False)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004470
4471 if len(args) != 1 or not args[0]:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004472 parser.error('Must specify issue number or URL.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004473
Edward Lemurf38bc172019-09-03 21:02:13 +00004474 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004475 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004476 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004477
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004478 # We don't want uncommitted changes mixed up with the patch.
4479 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004480 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004481
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004482 if options.newbranch:
4483 if options.force:
4484 RunGit(['branch', '-D', options.newbranch],
4485 stderr=subprocess2.PIPE, error_ok=True)
Edward Lemur84101642020-02-21 21:40:34 +00004486 git_new_branch.create_new_branch(options.newbranch)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004487
Edward Lemur678a6842019-10-03 22:25:05 +00004488 cl = Changelist(
4489 codereview_host=target_issue_arg.hostname, issue=target_issue_arg.issue)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004490
Edward Lemur678a6842019-10-03 22:25:05 +00004491 if not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004492 print('canonical issue/change URL: %s\n' % cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004493
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004494 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit,
4495 options.force, options.newbranch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004496
4497
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004498def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004499 """Fetches the tree status and returns either 'open', 'closed',
4500 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004501 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004502 if url:
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004503 status = str(urllib.request.urlopen(url).read().lower())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004504 if status.find('closed') != -1 or status == '0':
4505 return 'closed'
4506 elif status.find('open') != -1 or status == '1':
4507 return 'open'
4508 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004509 return 'unset'
4510
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004511
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004512def GetTreeStatusReason():
4513 """Fetches the tree status from a json url and returns the message
4514 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004515 url = settings.GetTreeStatusUrl()
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004516 json_url = urllib.parse.urljoin(url, '/current?format=json')
Edward Lemur79d4f992019-11-11 23:49:02 +00004517 connection = urllib.request.urlopen(json_url)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004518 status = json.loads(connection.read())
4519 connection.close()
4520 return status['message']
4521
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004522
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004523@metrics.collector.collect_metrics('git cl tree')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004524def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004525 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004526 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004527 status = GetTreeStatus()
4528 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004529 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004530 return 2
4531
vapiera7fbd5a2016-06-16 09:17:49 -07004532 print('The tree is %s' % status)
4533 print()
4534 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004535 if status != 'open':
4536 return 1
4537 return 0
4538
4539
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004540@metrics.collector.collect_metrics('git cl try')
maruel@chromium.org15192402012-09-06 12:38:29 +00004541def CMDtry(parser, args):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004542 """Triggers tryjobs using either Buildbucket or CQ dry run."""
4543 group = optparse.OptionGroup(parser, 'Tryjob options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004544 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004545 '-b', '--bot', action='append',
4546 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4547 'times to specify multiple builders. ex: '
4548 '"-b win_rel -b win_layout". See '
4549 'the try server waterfall for the builders name and the tests '
4550 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004551 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004552 '-B', '--bucket', default='',
4553 help=('Buildbucket bucket to send the try requests.'))
4554 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004555 '-r', '--revision',
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004556 help='Revision to use for the tryjob; default: the revision will '
tandriif7b29d42016-10-07 08:45:41 -07004557 'be determined by the try recipe that builder runs, which usually '
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004558 'defaults to HEAD of origin/master or origin/main')
maruel@chromium.org15192402012-09-06 12:38:29 +00004559 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004560 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004561 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004562 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004563 group.add_option(
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004564 '--category', default='git_cl_try', help='Specify custom build category.')
4565 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004566 '--project',
4567 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004568 'in recipe to determine to which repository or directory to '
4569 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004570 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004571 '-p', '--property', dest='properties', action='append', default=[],
4572 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004573 'key2=value2 etc. The value will be treated as '
4574 'json if decodable, or as string otherwise. '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004575 'NOTE: using this may make your tryjob not usable for CQ, '
4576 'which will then schedule another tryjob with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004577 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004578 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4579 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004580 parser.add_option_group(group)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004581 parser.add_option(
4582 '-R', '--retry-failed', action='store_true', default=False,
4583 help='Retry failed jobs from the latest set of tryjobs. '
4584 'Not allowed with --bucket and --bot options.')
Edward Lemur52969c92020-02-06 18:15:28 +00004585 parser.add_option(
4586 '-i', '--issue', type=int,
4587 help='Operate on this issue instead of the current branch\'s implicit '
4588 'issue.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004589 options, args = parser.parse_args(args)
4590
machenbach@chromium.org45453142015-09-15 08:45:22 +00004591 # Make sure that all properties are prop=value pairs.
4592 bad_params = [x for x in options.properties if '=' not in x]
4593 if bad_params:
4594 parser.error('Got properties with missing "=": %s' % bad_params)
4595
maruel@chromium.org15192402012-09-06 12:38:29 +00004596 if args:
4597 parser.error('Unknown arguments: %s' % args)
4598
Edward Lemur934836a2019-09-09 20:16:54 +00004599 cl = Changelist(issue=options.issue)
maruel@chromium.org15192402012-09-06 12:38:29 +00004600 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004601 parser.error('Need to upload first.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004602
Edward Lemurf38bc172019-09-03 21:02:13 +00004603 # HACK: warm up Gerrit change detail cache to save on RPCs.
Edward Lemur125d60a2019-09-13 18:25:41 +00004604 cl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS'])
Andrii Shyshkaloveadad922017-01-26 09:38:30 +01004605
tandriie113dfd2016-10-11 10:20:12 -07004606 error_message = cl.CannotTriggerTryJobReason()
4607 if error_message:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004608 parser.error('Can\'t trigger tryjobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004609
Edward Lemur45768512020-03-02 19:03:14 +00004610 if options.bot:
4611 if options.retry_failed:
4612 parser.error('--bot is not compatible with --retry-failed.')
4613 if not options.bucket:
4614 parser.error('A bucket (e.g. "chromium/try") is required.')
4615
4616 triggered = [b for b in options.bot if 'triggered' in b]
4617 if triggered:
4618 parser.error(
4619 'Cannot schedule builds on triggered bots: %s.\n'
4620 'This type of bot requires an initial job from a parent (usually a '
4621 'builder). Schedule a job on the parent instead.\n' % triggered)
4622
4623 if options.bucket.startswith('.master'):
4624 parser.error('Buildbot masters are not supported.')
4625
4626 project, bucket = _parse_bucket(options.bucket)
4627 if project is None or bucket is None:
4628 parser.error('Invalid bucket: %s.' % options.bucket)
4629 jobs = sorted((project, bucket, bot) for bot in options.bot)
4630 elif options.retry_failed:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004631 print('Searching for failed tryjobs...')
Edward Lemur5b929a42019-10-21 17:57:39 +00004632 builds, patchset = _fetch_latest_builds(cl, options.buildbucket_host)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004633 if options.verbose:
4634 print('Got %d builds in patchset #%d' % (len(builds), patchset))
Edward Lemur45768512020-03-02 19:03:14 +00004635 jobs = _filter_failed_for_retry(builds)
4636 if not jobs:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004637 print('There are no failed jobs in the latest set of jobs '
4638 '(patchset #%d), doing nothing.' % patchset)
4639 return 0
Edward Lemur45768512020-03-02 19:03:14 +00004640 num_builders = len(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004641 if num_builders > 10:
4642 confirm_or_exit('There are %d builders with failed builds.'
4643 % num_builders, action='continue')
4644 else:
qyearsley1fdfcb62016-10-24 13:22:03 -07004645 if options.verbose:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07004646 print('git cl try with no bots now defaults to CQ dry run.')
4647 print('Scheduling CQ dry run on: %s' % cl.GetIssueURL())
4648 return cl.SetCQState(_CQState.DRY_RUN)
stip@chromium.org43064fd2013-12-18 20:07:44 +00004649
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004650 patchset = cl.GetMostRecentPatchset()
Edward Lemur2c210a42019-09-16 23:58:35 +00004651 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004652 _trigger_tryjobs(cl, jobs, options, patchset)
Edward Lemur2c210a42019-09-16 23:58:35 +00004653 except BuildbucketResponseException as ex:
4654 print('ERROR: %s' % ex)
4655 return 1
4656 return 0
maruel@chromium.org15192402012-09-06 12:38:29 +00004657
4658
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004659@metrics.collector.collect_metrics('git cl try-results')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004660def CMDtry_results(parser, args):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004661 """Prints info about results for tryjobs associated with the current CL."""
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004662 group = optparse.OptionGroup(parser, 'Tryjob results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004663 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004664 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004665 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004666 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004667 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004668 '--color', action='store_true', default=setup_color.IS_TTY,
4669 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004670 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004671 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4672 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004673 group.add_option(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004674 '--json', help=('Path of JSON output file to write tryjob results to,'
Stefan Zager1306bd02017-06-22 19:26:46 -07004675 'or "-" for stdout.'))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004676 parser.add_option_group(group)
Edward Lemur52969c92020-02-06 18:15:28 +00004677 parser.add_option(
4678 '-i', '--issue', type=int,
4679 help='Operate on this issue instead of the current branch\'s implicit '
4680 'issue.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004681 options, args = parser.parse_args(args)
4682 if args:
4683 parser.error('Unrecognized args: %s' % ' '.join(args))
4684
Edward Lemur934836a2019-09-09 20:16:54 +00004685 cl = Changelist(issue=options.issue)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004686 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004687 parser.error('Need to upload first.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004688
tandrii221ab252016-10-06 08:12:04 -07004689 patchset = options.patchset
4690 if not patchset:
Gavin Make61ccc52020-11-13 00:12:57 +00004691 patchset = cl.GetMostRecentDryRunPatchset()
tandrii221ab252016-10-06 08:12:04 -07004692 if not patchset:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004693 parser.error('Code review host doesn\'t know about issue %s. '
tandrii221ab252016-10-06 08:12:04 -07004694 'No access to issue or wrong issue number?\n'
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004695 'Either upload first, or pass --patchset explicitly.' %
tandrii221ab252016-10-06 08:12:04 -07004696 cl.GetIssue())
4697
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004698 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004699 jobs = _fetch_tryjobs(cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004700 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004701 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004702 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004703 if options.json:
Edward Lemurbaaf6be2019-10-09 18:00:44 +00004704 write_json(options.json, jobs)
qyearsley53f48a12016-09-01 10:45:13 -07004705 else:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004706 _print_tryjobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004707 return 0
4708
4709
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004710@subcommand.usage('[new upstream branch]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004711@metrics.collector.collect_metrics('git cl upstream')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004712def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004713 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004714 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004715 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004716 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004717
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004718 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004719 if args:
4720 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004721 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07004722 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004723 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07004724 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004725
4726 # Clear configured merge-base, if there is one.
4727 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004728 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004729 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004730 return 0
4731
4732
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004733@metrics.collector.collect_metrics('git cl web')
thestig@chromium.org00858c82013-12-02 23:08:03 +00004734def CMDweb(parser, args):
4735 """Opens the current CL in the web browser."""
4736 _, args = parser.parse_args(args)
4737 if args:
4738 parser.error('Unrecognized args: %s' % ' '.join(args))
4739
4740 issue_url = Changelist().GetIssueURL()
4741 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07004742 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004743 return 1
4744
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004745 # Redirect I/O before invoking browser to hide its output. For example, this
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004746 # allows us to hide the "Created new window in existing browser session."
4747 # message from Chrome. Based on https://stackoverflow.com/a/2323563.
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004748 saved_stdout = os.dup(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004749 saved_stderr = os.dup(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004750 os.close(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004751 os.close(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004752 os.open(os.devnull, os.O_RDWR)
4753 try:
4754 webbrowser.open(issue_url)
4755 finally:
4756 os.dup2(saved_stdout, 1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004757 os.dup2(saved_stderr, 2)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004758 return 0
4759
4760
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004761@metrics.collector.collect_metrics('git cl set-commit')
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004762def CMDset_commit(parser, args):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004763 """Sets the commit bit to trigger the CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004764 parser.add_option('-d', '--dry-run', action='store_true',
4765 help='trigger in dry run mode')
4766 parser.add_option('-c', '--clear', action='store_true',
4767 help='stop CQ run, if any')
Edward Lemur52969c92020-02-06 18:15:28 +00004768 parser.add_option(
4769 '-i', '--issue', type=int,
4770 help='Operate on this issue instead of the current branch\'s implicit '
4771 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004772 options, args = parser.parse_args(args)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004773 if args:
4774 parser.error('Unrecognized args: %s' % ' '.join(args))
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004775 if options.dry_run and options.clear:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004776 parser.error('Only one of --dry-run and --clear are allowed.')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004777
Edward Lemur934836a2019-09-09 20:16:54 +00004778 cl = Changelist(issue=options.issue)
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004779 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07004780 state = _CQState.NONE
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004781 elif options.dry_run:
4782 state = _CQState.DRY_RUN
4783 else:
4784 state = _CQState.COMMIT
4785 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004786 parser.error('Must upload the issue first.')
tandrii9de9ec62016-07-13 03:01:59 -07004787 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004788 return 0
4789
4790
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004791@metrics.collector.collect_metrics('git cl set-close')
groby@chromium.org411034a2013-02-26 15:12:01 +00004792def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004793 """Closes the issue."""
Edward Lemur52969c92020-02-06 18:15:28 +00004794 parser.add_option(
4795 '-i', '--issue', type=int,
4796 help='Operate on this issue instead of the current branch\'s implicit '
4797 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004798 options, args = parser.parse_args(args)
groby@chromium.org411034a2013-02-26 15:12:01 +00004799 if args:
4800 parser.error('Unrecognized args: %s' % ' '.join(args))
Edward Lemur934836a2019-09-09 20:16:54 +00004801 cl = Changelist(issue=options.issue)
groby@chromium.org411034a2013-02-26 15:12:01 +00004802 # Ensure there actually is an issue to close.
Aaron Gable7139a4e2017-09-05 17:53:09 -07004803 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004804 DieWithError('ERROR: No issue to close.')
groby@chromium.org411034a2013-02-26 15:12:01 +00004805 cl.CloseIssue()
4806 return 0
4807
4808
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004809@metrics.collector.collect_metrics('git cl diff')
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004810def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00004811 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07004812 parser.add_option(
4813 '--stat',
4814 action='store_true',
4815 dest='stat',
4816 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004817 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004818 if args:
4819 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00004820
Edward Lemur934836a2019-09-09 20:16:54 +00004821 cl = Changelist()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004822 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004823 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004824 if not issue:
4825 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004826
Aaron Gablea718c3e2017-08-28 17:47:28 -07004827 base = cl._GitGetBranchConfigValue('last-upload-hash')
4828 if not base:
4829 base = cl._GitGetBranchConfigValue('gerritsquashhash')
4830 if not base:
4831 detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
4832 revision_info = detail['revisions'][detail['current_revision']]
4833 fetch_info = revision_info['fetch']['http']
4834 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
4835 base = 'FETCH_HEAD'
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004836
Aaron Gablea718c3e2017-08-28 17:47:28 -07004837 cmd = ['git', 'diff']
4838 if options.stat:
4839 cmd.append('--stat')
4840 cmd.append(base)
4841 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004842
4843 return 0
4844
4845
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004846@metrics.collector.collect_metrics('git cl owners')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004847def CMDowners(parser, args):
Dirk Prankebf980882017-09-02 15:08:00 -07004848 """Finds potential owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004849 parser.add_option(
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004850 '--ignore-current',
4851 action='store_true',
4852 help='Ignore the CL\'s current reviewers and start from scratch.')
4853 parser.add_option(
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004854 '--ignore-self',
4855 action='store_true',
4856 help='Do not consider CL\'s author as an owners.')
4857 parser.add_option(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004858 '--no-color',
4859 action='store_true',
4860 help='Use this option to disable color output')
Dirk Prankebf980882017-09-02 15:08:00 -07004861 parser.add_option(
4862 '--batch',
4863 action='store_true',
4864 help='Do not run interactively, just suggest some')
Yang Guo6e269a02019-06-26 11:17:02 +00004865 # TODO: Consider moving this to another command, since other
4866 # git-cl owners commands deal with owners for a given CL.
4867 parser.add_option(
4868 '--show-all',
4869 action='store_true',
4870 help='Show all owners for a particular file')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004871 options, args = parser.parse_args(args)
4872
Edward Lemur934836a2019-09-09 20:16:54 +00004873 cl = Changelist()
Edward Lesmes50da7702020-03-30 19:23:43 +00004874 author = cl.GetAuthor()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004875
Yang Guo6e269a02019-06-26 11:17:02 +00004876 if options.show_all:
Bruce Dawson97ed44a2020-05-06 17:04:03 +00004877 if len(args) == 0:
4878 print('No files specified for --show-all. Nothing to do.')
4879 return 0
Edward Lesmese1576912021-02-16 21:53:34 +00004880 owners_by_path = cl.owners_client.BatchListOwners(args)
Edward Lesmes0e4e5ae2021-01-08 18:28:46 +00004881 for path in args:
4882 print('Owners for %s:' % path)
4883 print('\n'.join(
4884 ' - %s' % owner
4885 for owner in owners_by_path.get(path, ['No owners found'])))
Yang Guo6e269a02019-06-26 11:17:02 +00004886 return 0
4887
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004888 if args:
4889 if len(args) > 1:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004890 parser.error('Unknown args.')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004891 base_branch = args[0]
4892 else:
4893 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004894 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004895
Edward Lemur2c62b332020-03-12 22:12:33 +00004896 affected_files = cl.GetAffectedFiles(base_branch)
Dirk Prankebf980882017-09-02 15:08:00 -07004897
4898 if options.batch:
Edward Lesmese1576912021-02-16 21:53:34 +00004899 owners = cl.owners_client.SuggestOwners(affected_files, exclude=[author])
4900 print('\n'.join(owners))
Dirk Prankebf980882017-09-02 15:08:00 -07004901 return 0
4902
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004903 return owners_finder.OwnersFinder(
Dirk Prankebf980882017-09-02 15:08:00 -07004904 affected_files,
Edward Lemur707d70b2018-02-07 00:50:14 +01004905 author,
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004906 [] if options.ignore_current else cl.GetReviewers(),
Edward Lesmes5cd75472021-02-19 00:34:25 +00004907 cl.owners_client,
Jochen Eisingerd0573ec2017-04-13 10:55:06 +02004908 disable_color=options.no_color,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004909 ignore_author=options.ignore_self).run()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004910
4911
Aiden Bennerc08566e2018-10-03 17:52:42 +00004912def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004913 """Generates a diff command."""
4914 # Generate diff for the current branch's changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +00004915 diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff']
4916
Aiden Benner6c18a1a2018-11-23 20:18:23 +00004917 if allow_prefix:
4918 # explicitly setting --src-prefix and --dst-prefix is necessary in the
4919 # case that diff.noprefix is set in the user's git config.
4920 diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/']
4921 else:
Aiden Bennerc08566e2018-10-03 17:52:42 +00004922 diff_cmd += ['--no-prefix']
4923
4924 diff_cmd += [diff_type, upstream_commit, '--']
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004925
4926 if args:
4927 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00004928 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004929 diff_cmd.append(arg)
4930 else:
4931 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004932
4933 return diff_cmd
4934
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004935
Jamie Madill5e96ad12020-01-13 16:08:35 +00004936def _RunClangFormatDiff(opts, clang_diff_files, top_dir, upstream_commit):
4937 """Runs clang-format-diff and sets a return value if necessary."""
4938
4939 if not clang_diff_files:
4940 return 0
4941
4942 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
4943 # formatted. This is used to block during the presubmit.
4944 return_value = 0
4945
4946 # Locate the clang-format binary in the checkout
4947 try:
4948 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
4949 except clang_format.NotFoundError as e:
4950 DieWithError(e)
4951
4952 if opts.full or settings.GetFormatFullByDefault():
4953 cmd = [clang_format_tool]
4954 if not opts.dry_run and not opts.diff:
4955 cmd.append('-i')
4956 if opts.dry_run:
4957 for diff_file in clang_diff_files:
4958 with open(diff_file, 'r') as myfile:
4959 code = myfile.read().replace('\r\n', '\n')
4960 stdout = RunCommand(cmd + [diff_file], cwd=top_dir)
4961 stdout = stdout.replace('\r\n', '\n')
4962 if opts.diff:
4963 sys.stdout.write(stdout)
4964 if code != stdout:
4965 return_value = 2
4966 else:
4967 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
4968 if opts.diff:
4969 sys.stdout.write(stdout)
4970 else:
Jamie Madill5e96ad12020-01-13 16:08:35 +00004971 try:
4972 script = clang_format.FindClangFormatScriptInChromiumTree(
4973 'clang-format-diff.py')
4974 except clang_format.NotFoundError as e:
4975 DieWithError(e)
4976
Edward Lesmes89624cd2020-04-06 17:51:56 +00004977 cmd = ['vpython', script, '-p0']
Jamie Madill5e96ad12020-01-13 16:08:35 +00004978 if not opts.dry_run and not opts.diff:
4979 cmd.append('-i')
4980
4981 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
Edward Lemur1a83da12020-03-04 21:18:36 +00004982 diff_output = RunGit(diff_cmd).encode('utf-8')
Jamie Madill5e96ad12020-01-13 16:08:35 +00004983
Edward Lesmes89624cd2020-04-06 17:51:56 +00004984 env = os.environ.copy()
4985 env['PATH'] = (
4986 str(os.path.dirname(clang_format_tool)) + os.pathsep + env['PATH'])
4987 stdout = RunCommand(
4988 cmd, stdin=diff_output, cwd=top_dir, env=env,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00004989 shell=sys.platform.startswith('win32'))
Jamie Madill5e96ad12020-01-13 16:08:35 +00004990 if opts.diff:
4991 sys.stdout.write(stdout)
4992 if opts.dry_run and len(stdout) > 0:
4993 return_value = 2
4994
4995 return return_value
4996
4997
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00004998def MatchingFileType(file_name, extensions):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004999 """Returns True if the file name ends with one of the given extensions."""
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005000 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005001
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005002
enne@chromium.org555cfe42014-01-29 18:21:39 +00005003@subcommand.usage('[files or directories to diff]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005004@metrics.collector.collect_metrics('git cl format')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005005def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005006 """Runs auto-formatting tools (clang-format etc.) on the diff."""
Christopher Lamc5ba6922017-01-24 11:19:14 +11005007 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07005008 GN_EXTS = ['.gn', '.gni', '.typemap']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005009 parser.add_option('--full', action='store_true',
5010 help='Reformat the full content of all touched files')
5011 parser.add_option('--dry-run', action='store_true',
5012 help='Don\'t modify any file on disk.')
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005013 parser.add_option(
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005014 '--no-clang-format',
5015 dest='clang_format',
5016 action='store_false',
5017 default=True,
5018 help='Disables formatting of various file types using clang-format.')
5019 parser.add_option(
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005020 '--python',
5021 action='store_true',
5022 default=None,
5023 help='Enables python formatting on all python files.')
5024 parser.add_option(
5025 '--no-python',
5026 action='store_true',
Garrett Beaty91a6f332020-01-06 16:57:24 +00005027 default=False,
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005028 help='Disables python formatting on all python files. '
Garrett Beaty91a6f332020-01-06 16:57:24 +00005029 'If neither --python or --no-python are set, python files that have a '
5030 '.style.yapf file in an ancestor directory will be formatted. '
5031 'It is an error to set both.')
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005032 parser.add_option(
5033 '--js',
5034 action='store_true',
5035 help='Format javascript code with clang-format. '
5036 'Has no effect if --no-clang-format is set.')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00005037 parser.add_option('--diff', action='store_true',
5038 help='Print diff to stdout rather than modifying files.')
Ilya Shermane081cbe2017-08-15 17:51:04 -07005039 parser.add_option('--presubmit', action='store_true',
5040 help='Used when running the script from a presubmit.')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005041 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005042
Garrett Beaty91a6f332020-01-06 16:57:24 +00005043 if opts.python is not None and opts.no_python:
5044 raise parser.error('Cannot set both --python and --no-python')
5045 if opts.no_python:
5046 opts.python = False
5047
Daniel Chengc55eecf2016-12-30 03:11:02 -08005048 # Normalize any remaining args against the current path, so paths relative to
5049 # the current directory are still resolved as expected.
5050 args = [os.path.join(os.getcwd(), arg) for arg in args]
5051
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005052 # git diff generates paths against the root of the repository. Change
5053 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005054 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005055 if rel_base_path:
5056 os.chdir(rel_base_path)
5057
digit@chromium.org29e47272013-05-17 17:01:46 +00005058 # Grab the merge-base commit, i.e. the upstream commit of the current
5059 # branch when it was created or the last time it was rebased. This is
5060 # to cover the case where the user may have called "git fetch origin",
5061 # moving the origin branch to a newer commit, but hasn't rebased yet.
5062 upstream_commit = None
5063 cl = Changelist()
5064 upstream_branch = cl.GetUpstreamBranch()
5065 if upstream_branch:
5066 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
5067 upstream_commit = upstream_commit.strip()
5068
5069 if not upstream_commit:
5070 DieWithError('Could not find base commit for this branch. '
5071 'Are you in detached state?')
5072
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005073 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5074 diff_output = RunGit(changed_files_cmd)
5075 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005076 # Filter out files deleted by this CL
5077 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005078
Andreas Haas417d89c2020-02-06 10:24:27 +00005079 if opts.js:
Deepanjan Roy605dd312018-07-02 17:48:54 +00005080 CLANG_EXTS.extend(['.js', '.ts'])
Christopher Lamc5ba6922017-01-24 11:19:14 +11005081
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005082 clang_diff_files = []
5083 if opts.clang_format:
5084 clang_diff_files = [
5085 x for x in diff_files if MatchingFileType(x, CLANG_EXTS)
5086 ]
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005087 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005088 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005089
Edward Lesmes50da7702020-03-30 19:23:43 +00005090 top_dir = settings.GetRoot()
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005091
Jamie Madill5e96ad12020-01-13 16:08:35 +00005092 return_value = _RunClangFormatDiff(opts, clang_diff_files, top_dir,
5093 upstream_commit)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005094
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005095 # Similar code to above, but using yapf on .py files rather than clang-format
5096 # on C/C++ files
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005097 py_explicitly_disabled = opts.python is not None and not opts.python
5098 if python_diff_files and not py_explicitly_disabled:
Aiden Bennere47ac152018-11-20 16:44:03 +00005099 depot_tools_path = os.path.dirname(os.path.abspath(__file__))
5100 yapf_tool = os.path.join(depot_tools_path, 'yapf')
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005101
Aiden Bennerc08566e2018-10-03 17:52:42 +00005102 # Used for caching.
5103 yapf_configs = {}
5104 for f in python_diff_files:
5105 # Find the yapf style config for the current file, defaults to depot
5106 # tools default.
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005107 _FindYapfConfigFile(f, yapf_configs, top_dir)
5108
5109 # Turn on python formatting by default if a yapf config is specified.
5110 # This breaks in the case of this repo though since the specified
5111 # style file is also the global default.
5112 if opts.python is None:
5113 filtered_py_files = []
5114 for f in python_diff_files:
5115 if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None:
5116 filtered_py_files.append(f)
5117 else:
5118 filtered_py_files = python_diff_files
5119
5120 # Note: yapf still seems to fix indentation of the entire file
5121 # even if line ranges are specified.
5122 # See https://github.com/google/yapf/issues/499
5123 if not opts.full and filtered_py_files:
5124 py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit)
5125
Brian Sheedyb4307d52019-12-02 19:18:17 +00005126 yapfignore_patterns = _GetYapfIgnorePatterns(top_dir)
5127 filtered_py_files = _FilterYapfIgnoredFiles(filtered_py_files,
5128 yapfignore_patterns)
Brian Sheedy59b06a82019-10-14 17:03:29 +00005129
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005130 for f in filtered_py_files:
Andrew Grievefa40bfa2020-01-07 02:32:57 +00005131 yapf_style = _FindYapfConfigFile(f, yapf_configs, top_dir)
5132 # Default to pep8 if not .style.yapf is found.
5133 if not yapf_style:
5134 yapf_style = 'pep8'
Aiden Bennerc08566e2018-10-03 17:52:42 +00005135
Peter Wend9399922020-06-17 17:33:49 +00005136 with open(f, 'r') as py_f:
5137 if 'python3' in py_f.readline():
5138 vpython_script = 'vpython3'
5139 else:
5140 vpython_script = 'vpython'
5141
5142 cmd = [vpython_script, yapf_tool, '--style', yapf_style, f]
Aiden Bennerc08566e2018-10-03 17:52:42 +00005143
5144 has_formattable_lines = False
5145 if not opts.full:
5146 # Only run yapf over changed line ranges.
5147 for diff_start, diff_len in py_line_diffs[f]:
5148 diff_end = diff_start + diff_len - 1
5149 # Yapf errors out if diff_end < diff_start but this
5150 # is a valid line range diff for a removal.
5151 if diff_end >= diff_start:
5152 has_formattable_lines = True
5153 cmd += ['-l', '{}-{}'.format(diff_start, diff_end)]
5154 # If all line diffs were removals we have nothing to format.
5155 if not has_formattable_lines:
5156 continue
5157
5158 if opts.diff or opts.dry_run:
5159 cmd += ['--diff']
5160 # Will return non-zero exit code if non-empty diff.
Edward Lesmesb7db1832020-06-22 20:22:27 +00005161 stdout = RunCommand(cmd,
5162 error_ok=True,
5163 cwd=top_dir,
5164 shell=sys.platform.startswith('win32'))
Aiden Bennerc08566e2018-10-03 17:52:42 +00005165 if opts.diff:
5166 sys.stdout.write(stdout)
5167 elif len(stdout) > 0:
5168 return_value = 2
5169 else:
5170 cmd += ['-i']
Edward Lesmesb7db1832020-06-22 20:22:27 +00005171 RunCommand(cmd, cwd=top_dir, shell=sys.platform.startswith('win32'))
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005172
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005173 # Format GN build files. Always run on full build files for canonical form.
5174 if gn_diff_files:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005175 cmd = ['gn', 'format']
brettw4b8ed592016-08-05 16:19:12 -07005176 if opts.dry_run or opts.diff:
5177 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005178 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005179 gn_ret = subprocess2.call(cmd + [gn_diff_file],
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005180 shell=sys.platform.startswith('win'),
brettw4b8ed592016-08-05 16:19:12 -07005181 cwd=top_dir)
5182 if opts.dry_run and gn_ret == 2:
5183 return_value = 2 # Not formatted.
5184 elif opts.diff and gn_ret == 2:
5185 # TODO this should compute and print the actual diff.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005186 print('This change has GN build file diff for ' + gn_diff_file)
brettw4b8ed592016-08-05 16:19:12 -07005187 elif gn_ret != 0:
5188 # For non-dry run cases (and non-2 return values for dry-run), a
5189 # nonzero error code indicates a failure, probably because the file
5190 # doesn't parse.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005191 DieWithError('gn format failed on ' + gn_diff_file +
5192 '\nTry running `gn format` on this file manually.')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005193
Ilya Shermane081cbe2017-08-15 17:51:04 -07005194 # Skip the metrics formatting from the global presubmit hook. These files have
5195 # a separate presubmit hook that issues an error if the files need formatting,
5196 # whereas the top-level presubmit script merely issues a warning. Formatting
5197 # these files is somewhat slow, so it's important not to duplicate the work.
5198 if not opts.presubmit:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005199 for diff_xml in GetDiffXMLs(diff_files):
5200 xml_dir = GetMetricsDir(diff_xml)
5201 if not xml_dir:
5202 continue
5203
Ilya Shermane081cbe2017-08-15 17:51:04 -07005204 tool_dir = os.path.join(top_dir, xml_dir)
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005205 pretty_print_tool = os.path.join(tool_dir, 'pretty_print.py')
5206 cmd = ['vpython', pretty_print_tool, '--non-interactive']
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005207
5208 # If the XML file is histograms.xml or enums.xml, add the xml path to the
5209 # command as histograms/pretty_print.py now needs a relative path argument
5210 # after splitting the histograms into multiple directories.
5211 # For example, in tools/metrics/ukm, pretty-print could be run using:
5212 # $ python pretty_print.py
5213 # But in tools/metrics/histogrmas, pretty-print should be run with an
5214 # additional relative path argument, like:
5215 # $ python pretty_print.py histograms_xml/UMA/histograms.xml
5216 # $ python pretty_print.py enums.xml
5217
5218 # TODO (crbug/1116488): Remove this check after ensuring that the updated
5219 # version of histograms/pretty_print.py is released.
5220 filepath_required = os.path.exists(
5221 os.path.join(tool_dir, 'validate_prefix.py'))
5222
Weilun Shib92c4b72020-08-27 17:45:11 +00005223 if (diff_xml.endswith('histograms.xml') or diff_xml.endswith('enums.xml')
5224 or diff_xml.endswith('histogram_suffixes_list.xml')
5225 ) and filepath_required:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005226 cmd.append(diff_xml)
5227
Ilya Shermane081cbe2017-08-15 17:51:04 -07005228 if opts.dry_run or opts.diff:
5229 cmd.append('--diff')
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005230
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005231 # TODO(isherman): Once this file runs only on Python 3.3+, drop the
5232 # `shell` param and instead replace `'vpython'` with
5233 # `shutil.which('frob')` above: https://stackoverflow.com/a/32799942
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005234 stdout = RunCommand(cmd,
5235 cwd=top_dir,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005236 shell=sys.platform.startswith('win32'))
Ilya Shermane081cbe2017-08-15 17:51:04 -07005237 if opts.diff:
5238 sys.stdout.write(stdout)
5239 if opts.dry_run and stdout:
5240 return_value = 2 # Not formatted.
Alexei Svitkinef3cac412017-02-06 11:08:50 -05005241
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005242 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005243
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005244
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005245def GetDiffXMLs(diff_files):
5246 return [
5247 os.path.normpath(x) for x in diff_files if MatchingFileType(x, ['.xml'])
5248 ]
5249
5250
5251def GetMetricsDir(diff_xml):
Steven Holte2e664bf2017-04-21 13:10:47 -07005252 metrics_xml_dirs = [
5253 os.path.join('tools', 'metrics', 'actions'),
5254 os.path.join('tools', 'metrics', 'histograms'),
5255 os.path.join('tools', 'metrics', 'rappor'),
Ilya Shermanb67e60c2020-05-20 22:27:03 +00005256 os.path.join('tools', 'metrics', 'structured'),
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005257 os.path.join('tools', 'metrics', 'ukm'),
5258 ]
Steven Holte2e664bf2017-04-21 13:10:47 -07005259 for xml_dir in metrics_xml_dirs:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005260 if diff_xml.startswith(xml_dir):
5261 return xml_dir
5262 return None
Steven Holte2e664bf2017-04-21 13:10:47 -07005263
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005264
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005265@subcommand.usage('<codereview url or issue id>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005266@metrics.collector.collect_metrics('git cl checkout')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005267def CMDcheckout(parser, args):
Edward Lemurf38bc172019-09-03 21:02:13 +00005268 """Checks out a branch associated with a given Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005269 _, args = parser.parse_args(args)
5270
5271 if len(args) != 1:
5272 parser.print_help()
5273 return 1
5274
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005275 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005276 if not issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005277 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02005278
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005279 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005280
Edward Lemur52969c92020-02-06 18:15:28 +00005281 output = RunGit(['config', '--local', '--get-regexp',
Edward Lesmes50da7702020-03-30 19:23:43 +00005282 r'branch\..*\.' + ISSUE_CONFIG_KEY],
Edward Lemur52969c92020-02-06 18:15:28 +00005283 error_ok=True)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005284
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005285 branches = []
Edward Lemur52969c92020-02-06 18:15:28 +00005286 for key, issue in [x.split() for x in output.splitlines()]:
5287 if issue == target_issue:
Edward Lesmes50da7702020-03-30 19:23:43 +00005288 branches.append(re.sub(r'branch\.(.*)\.' + ISSUE_CONFIG_KEY, r'\1', key))
Edward Lemur52969c92020-02-06 18:15:28 +00005289
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005290 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005291 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005292 return 1
5293 if len(branches) == 1:
5294 RunGit(['checkout', branches[0]])
5295 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005296 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005297 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005298 print('%d: %s' % (i, branches[i]))
Edward Lesmesae3586b2020-03-23 21:21:14 +00005299 which = gclient_utils.AskForData('Choose by index: ')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005300 try:
5301 RunGit(['checkout', branches[int(which)]])
5302 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005303 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005304 return 1
5305
5306 return 0
5307
5308
maruel@chromium.org29404b52014-09-08 22:58:00 +00005309def CMDlol(parser, args):
5310 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005311 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005312 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5313 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5314 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
Gavin Mak18f45d22020-12-04 21:45:10 +00005315 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')).decode('utf-8'))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005316 return 0
5317
5318
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005319class OptionParser(optparse.OptionParser):
5320 """Creates the option parse and add --verbose support."""
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00005321
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005322 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005323 optparse.OptionParser.__init__(
5324 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005325 self.add_option(
5326 '-v', '--verbose', action='count', default=0,
5327 help='Use 2 times for more debugging info')
5328
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005329 def parse_args(self, args=None, _values=None):
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005330 try:
5331 return self._parse_args(args)
5332 finally:
5333 # Regardless of success or failure of args parsing, we want to report
5334 # metrics, but only after logging has been initialized (if parsing
5335 # succeeded).
5336 global settings
5337 settings = Settings()
5338
5339 if not metrics.DISABLE_METRICS_COLLECTION:
5340 # GetViewVCUrl ultimately calls logging method.
5341 project_url = settings.GetViewVCUrl().strip('/+')
5342 if project_url in metrics_utils.KNOWN_PROJECT_URLS:
5343 metrics.collector.add('project_urls', [project_url])
5344
5345 def _parse_args(self, args=None):
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005346 # Create an optparse.Values object that will store only the actual passed
5347 # options, without the defaults.
5348 actual_options = optparse.Values()
5349 _, args = optparse.OptionParser.parse_args(self, args, actual_options)
5350 # Create an optparse.Values object with the default options.
5351 options = optparse.Values(self.get_default_values().__dict__)
5352 # Update it with the options passed by the user.
5353 options._update_careful(actual_options.__dict__)
5354 # Store the options passed by the user in an _actual_options attribute.
5355 # We store only the keys, and not the values, since the values can contain
5356 # arbitrary information, which might be PII.
Edward Lemur79d4f992019-11-11 23:49:02 +00005357 metrics.collector.add('arguments', list(actual_options.__dict__.keys()))
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005358
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005359 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
Andrii Shyshkalov5b04a572017-01-23 17:44:41 +01005360 logging.basicConfig(
5361 level=levels[min(options.verbose, len(levels) - 1)],
5362 format='[%(levelname).1s%(asctime)s %(process)d %(thread)d '
5363 '%(filename)s] %(message)s')
Edward Lemur83bd7f42018-10-10 00:14:21 +00005364
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005365 return options, args
5366
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005367
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005368def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005369 if sys.hexversion < 0x02060000:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005370 print('\nYour Python version %s is unsupported, please upgrade.\n' %
vapiera7fbd5a2016-06-16 09:17:49 -07005371 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005372 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005373
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005374 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005375 dispatcher = subcommand.CommandDispatcher(__name__)
5376 try:
5377 return dispatcher.execute(OptionParser(), argv)
Edward Lemur5b929a42019-10-21 17:57:39 +00005378 except auth.LoginRequiredError as e:
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005379 DieWithError(str(e))
Edward Lemur79d4f992019-11-11 23:49:02 +00005380 except urllib.error.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005381 if e.code != 500:
5382 raise
5383 DieWithError(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005384 ('App Engine is misbehaving and returned HTTP %d, again. Keep faith '
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005385 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005386 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005387
5388
5389if __name__ == '__main__':
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005390 # These affect sys.stdout, so do it outside of main() to simplify mocks in
5391 # the unit tests.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005392 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005393 setup_color.init()
Edward Lemur6f812e12018-07-31 22:45:57 +00005394 with metrics.collector.print_notice_and_exit():
sbc@chromium.org013731e2015-02-26 18:28:43 +00005395 sys.exit(main(sys.argv[1:]))