blob: 1ae46c6862d48db9cd1d75108715aad2a8bebe72 [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
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +000049import rustfmt
maruel@chromium.org2a74d372011-03-29 19:05:50 +000050import scm
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +000051import setup_color
Francois Dorayd42c6812017-05-30 15:10:20 -040052import split_cl
maruel@chromium.org0633fb42013-08-16 20:06:14 +000053import subcommand
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +000054import subprocess2
maruel@chromium.org2a74d372011-03-29 19:05:50 +000055import watchlists
56
Edward Lemur79d4f992019-11-11 23:49:02 +000057from third_party import six
58from six.moves import urllib
59
60
61if sys.version_info.major == 3:
62 basestring = (str,) # pylint: disable=redefined-builtin
63
Edward Lemurb9830242019-10-30 22:19:20 +000064
tandrii7400cf02016-06-21 08:48:07 -070065__version__ = '2.0'
maruel@chromium.org2a74d372011-03-29 19:05:50 +000066
Edward Lemur0f58ae42019-04-30 17:24:12 +000067# Traces for git push will be stored in a traces directory inside the
68# depot_tools checkout.
69DEPOT_TOOLS = os.path.dirname(os.path.abspath(__file__))
70TRACES_DIR = os.path.join(DEPOT_TOOLS, 'traces')
Edward Lemur227d5102020-02-25 23:45:35 +000071PRESUBMIT_SUPPORT = os.path.join(DEPOT_TOOLS, 'presubmit_support.py')
Edward Lemur0f58ae42019-04-30 17:24:12 +000072
73# When collecting traces, Git hashes will be reduced to 6 characters to reduce
74# the size after compression.
75GIT_HASH_RE = re.compile(r'\b([a-f0-9]{6})[a-f0-9]{34}\b', flags=re.I)
76# Used to redact the cookies from the gitcookies file.
77GITCOOKIES_REDACT_RE = re.compile(r'1/.*')
78
Edward Lemurd4d1ba42019-09-20 21:46:37 +000079MAX_ATTEMPTS = 3
80
Edward Lemur1b52d872019-05-09 21:12:12 +000081# The maximum number of traces we will keep. Multiplied by 3 since we store
82# 3 files per trace.
83MAX_TRACES = 3 * 10
Edward Lemur5737f022019-05-17 01:24:00 +000084# Message to be displayed to the user to inform where to find the traces for a
85# git-cl upload execution.
Edward Lemur0f58ae42019-04-30 17:24:12 +000086TRACES_MESSAGE = (
Edward Lemur1b52d872019-05-09 21:12:12 +000087'\n'
Edward Lemur5737f022019-05-17 01:24:00 +000088'The traces of this git-cl execution have been recorded at:\n'
Edward Lemur1b52d872019-05-09 21:12:12 +000089' %(trace_name)s-traces.zip\n'
Edward Lemur5737f022019-05-17 01:24:00 +000090'Copies of your gitcookies file and git config have been recorded at:\n'
91' %(trace_name)s-git-info.zip\n')
Edward Lemur1b52d872019-05-09 21:12:12 +000092# Format of the message to be stored as part of the traces to give developers a
93# better context when they go through traces.
94TRACES_README_FORMAT = (
95'Date: %(now)s\n'
96'\n'
97'Change: https://%(gerrit_host)s/q/%(change_id)s\n'
98'Title: %(title)s\n'
99'\n'
100'%(description)s\n'
101'\n'
102'Execution time: %(execution_time)s\n'
103'Exit code: %(exit_code)s\n') + TRACES_MESSAGE
Edward Lemur0f58ae42019-04-30 17:24:12 +0000104
Aaron Gable1bc7bfe2016-12-19 10:08:14 -0800105POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land'
Henrique Ferreiroff249622019-11-28 23:19:29 +0000106DESCRIPTION_BACKUP_FILE = '.git_cl_description_backup'
rmistry@google.comc68112d2015-03-03 12:48:06 +0000107REFS_THAT_ALIAS_TO_OTHER_REFS = {
Josip Sokcevic7e133ff2021-07-13 17:44:53 +0000108 'refs/remotes/origin/lkgr': 'refs/remotes/origin/main',
109 'refs/remotes/origin/lkcr': 'refs/remotes/origin/main',
rmistry@google.comc68112d2015-03-03 12:48:06 +0000110}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000111
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000112DEFAULT_OLD_BRANCH = 'refs/remotes/origin/master'
113DEFAULT_NEW_BRANCH = 'refs/remotes/origin/main'
114
thestig@chromium.org44202a22014-03-11 19:22:18 +0000115# Valid extensions for files we want to lint.
116DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
117DEFAULT_LINT_IGNORE_REGEX = r"$^"
118
Aiden Bennerc08566e2018-10-03 17:52:42 +0000119# File name for yapf style config files.
120YAPF_CONFIG_FILENAME = '.style.yapf'
121
Edward Lesmes50da7702020-03-30 19:23:43 +0000122# The issue, patchset and codereview server are stored on git config for each
123# branch under branch.<branch-name>.<config-key>.
124ISSUE_CONFIG_KEY = 'gerritissue'
125PATCHSET_CONFIG_KEY = 'gerritpatchset'
126CODEREVIEW_SERVER_CONFIG_KEY = 'gerritserver'
127
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000128# Shortcut since it quickly becomes repetitive.
maruel@chromium.org2e23ce32013-05-07 12:42:28 +0000129Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +0000130
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000131# Initialized in main()
132settings = None
133
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100134# Used by tests/git_cl_test.py to add extra logging.
135# Inside the weirdly failing test, add this:
136# >>> self.mock(git_cl, '_IS_BEING_TESTED', True)
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700137# And scroll up to see the stack trace printed.
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100138_IS_BEING_TESTED = False
139
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000140
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000141_KNOWN_GERRIT_TO_SHORT_URLS = {
142 'https://chrome-internal-review.googlesource.com': 'https://crrev.com/i',
143 'https://chromium-review.googlesource.com': 'https://crrev.com/c',
144}
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000145assert len(_KNOWN_GERRIT_TO_SHORT_URLS) == len(
146 set(_KNOWN_GERRIT_TO_SHORT_URLS.values())), 'must have unique values'
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +0000147
148
Josip Sokcevicf736cab2020-10-20 23:41:38 +0000149class GitPushError(Exception):
150 pass
151
152
Christopher Lamf732cd52017-01-24 12:40:11 +1100153def DieWithError(message, change_desc=None):
154 if change_desc:
155 SaveDescriptionBackup(change_desc)
Josip Sokcevic953278a2020-02-28 19:46:36 +0000156 print('\n ** Content of CL description **\n' +
157 '='*72 + '\n' +
158 change_desc.description + '\n' +
159 '='*72 + '\n')
Christopher Lamf732cd52017-01-24 12:40:11 +1100160
vapiera7fbd5a2016-06-16 09:17:49 -0700161 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000162 sys.exit(1)
163
164
Christopher Lamf732cd52017-01-24 12:40:11 +1100165def SaveDescriptionBackup(change_desc):
Henrique Ferreiro5ae48172019-11-29 16:14:42 +0000166 backup_path = os.path.join(DEPOT_TOOLS, DESCRIPTION_BACKUP_FILE)
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +0000167 print('\nsaving CL description to %s\n' % backup_path)
sokcevic07152802021-08-18 00:06:34 +0000168 with open(backup_path, 'wb') as backup_file:
169 backup_file.write(change_desc.description.encode('utf-8'))
Christopher Lamf732cd52017-01-24 12:40:11 +1100170
171
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000172def GetNoGitPagerEnv():
173 env = os.environ.copy()
174 # 'cat' is a magical git string that disables pagers on all platforms.
175 env['GIT_PAGER'] = 'cat'
176 return env
177
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000178
bsep@chromium.org627d9002016-04-29 00:00:52 +0000179def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000180 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000181 stdout = subprocess2.check_output(args, shell=shell, **kwargs)
182 return stdout.decode('utf-8', 'replace')
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000183 except subprocess2.CalledProcessError as e:
184 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000185 if not error_ok:
Alan Cutter594fd332020-07-21 23:55:27 +0000186 message = error_message or e.stdout.decode('utf-8', 'replace') or ''
187 DieWithError('Command "%s" failed.\n%s' % (' '.join(args), message))
Josip Sokcevic673e8ed2021-10-27 23:46:18 +0000188 out = e.stdout.decode('utf-8', 'replace')
189 if e.stderr:
190 out += e.stderr.decode('utf-8', 'replace')
191 return out
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000192
193
194def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000195 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000196 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000197
198
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000199def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000200 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700201 if suppress_stderr:
Edward Lesmescf06cad2020-12-14 22:03:23 +0000202 stderr = subprocess2.DEVNULL
tandrii5d48c322016-08-18 16:19:37 -0700203 else:
204 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000205 try:
tandrii5d48c322016-08-18 16:19:37 -0700206 (out, _), code = subprocess2.communicate(['git'] + args,
207 env=GetNoGitPagerEnv(),
208 stdout=subprocess2.PIPE,
209 stderr=stderr)
Edward Lemur79d4f992019-11-11 23:49:02 +0000210 return code, out.decode('utf-8', 'replace')
tandrii5d48c322016-08-18 16:19:37 -0700211 except subprocess2.CalledProcessError as e:
Yoshisato Yanagisawa81e3ff52017-09-26 15:33:34 +0900212 logging.debug('Failed running %s', ['git'] + args)
Edward Lemur79d4f992019-11-11 23:49:02 +0000213 return e.returncode, e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000214
215
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000216def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000217 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000218 return RunGitWithCode(args, suppress_stderr=True)[1]
219
220
tandrii2a16b952016-10-19 07:09:44 -0700221def time_sleep(seconds):
222 # Use this so that it can be mocked in tests without interfering with python
223 # system machinery.
tandrii2a16b952016-10-19 07:09:44 -0700224 return time.sleep(seconds)
225
226
Edward Lemur01f4a4f2018-11-03 00:40:38 +0000227def time_time():
228 # Use this so that it can be mocked in tests without interfering with python
229 # system machinery.
230 return time.time()
231
232
Edward Lemur1b52d872019-05-09 21:12:12 +0000233def datetime_now():
234 # Use this so that it can be mocked in tests without interfering with python
235 # system machinery.
236 return datetime.datetime.now()
237
238
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100239def confirm_or_exit(prefix='', action='confirm'):
240 """Asks user to press enter to continue or press Ctrl+C to abort."""
241 if not prefix or prefix.endswith('\n'):
242 mid = 'Press'
Andrii Shyshkalov353637c2017-03-14 16:52:18 +0100243 elif prefix.endswith('.') or prefix.endswith('?'):
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100244 mid = ' Press'
245 elif prefix.endswith(' '):
246 mid = 'press'
247 else:
248 mid = ' press'
Edward Lesmesae3586b2020-03-23 21:21:14 +0000249 gclient_utils.AskForData(
250 '%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action))
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100251
252
253def ask_for_explicit_yes(prompt):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000254 """Returns whether user typed 'y' or 'yes' to confirm the given prompt."""
Edward Lesmesae3586b2020-03-23 21:21:14 +0000255 result = gclient_utils.AskForData(prompt + ' [Yes/No]: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100256 while True:
257 if 'yes'.startswith(result):
258 return True
259 if 'no'.startswith(result):
260 return False
Edward Lesmesae3586b2020-03-23 21:21:14 +0000261 result = gclient_utils.AskForData('Please, type yes or no: ').lower()
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100262
263
machenbach@chromium.org45453142015-09-15 08:45:22 +0000264def _get_properties_from_options(options):
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000265 prop_list = getattr(options, 'properties', [])
266 properties = dict(x.split('=', 1) for x in prop_list)
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000267 for key, val in properties.items():
machenbach@chromium.org45453142015-09-15 08:45:22 +0000268 try:
269 properties[key] = json.loads(val)
270 except ValueError:
271 pass # If a value couldn't be evaluated, treat it as a string.
272 return properties
273
274
Edward Lemur4c707a22019-09-24 21:13:43 +0000275def _call_buildbucket(http, buildbucket_host, method, request):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000276 """Calls a buildbucket v2 method and returns the parsed json response."""
277 headers = {
278 'Accept': 'application/json',
279 'Content-Type': 'application/json',
280 }
281 request = json.dumps(request)
282 url = 'https://%s/prpc/buildbucket.v2.Builds/%s' % (buildbucket_host, method)
283
284 logging.info('POST %s with %s' % (url, request))
285
286 attempts = 1
287 time_to_sleep = 1
288 while True:
289 response, content = http.request(url, 'POST', body=request, headers=headers)
290 if response.status == 200:
291 return json.loads(content[4:])
292 if attempts >= MAX_ATTEMPTS or 400 <= response.status < 500:
293 msg = '%s error when calling POST %s with %s: %s' % (
294 response.status, url, request, content)
295 raise BuildbucketResponseException(msg)
296 logging.debug(
297 '%s error when calling POST %s with %s. '
298 'Sleeping for %d seconds and retrying...' % (
299 response.status, url, request, time_to_sleep))
300 time.sleep(time_to_sleep)
301 time_to_sleep *= 2
302 attempts += 1
303
304 assert False, 'unreachable'
305
306
Edward Lemur6215c792019-10-03 21:59:05 +0000307def _parse_bucket(raw_bucket):
308 legacy = True
309 project = bucket = None
310 if '/' in raw_bucket:
311 legacy = False
312 project, bucket = raw_bucket.split('/', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000313 # Assume luci.<project>.<bucket>.
Edward Lemur6215c792019-10-03 21:59:05 +0000314 elif raw_bucket.startswith('luci.'):
315 project, bucket = raw_bucket[len('luci.'):].split('.', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000316 # Otherwise, assume prefix is also the project name.
Edward Lemur6215c792019-10-03 21:59:05 +0000317 elif '.' in raw_bucket:
318 project = raw_bucket.split('.')[0]
319 bucket = raw_bucket
320 # Legacy buckets.
Edward Lemur45768512020-03-02 19:03:14 +0000321 if legacy and project and bucket:
Edward Lemur6215c792019-10-03 21:59:05 +0000322 print('WARNING Please use %s/%s to specify the bucket.' % (project, bucket))
323 return project, bucket
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000324
325
Quinten Yearsley777660f2020-03-04 23:37:06 +0000326def _trigger_tryjobs(changelist, jobs, options, patchset):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000327 """Sends a request to Buildbucket to trigger tryjobs for a changelist.
qyearsley1fdfcb62016-10-24 13:22:03 -0700328
329 Args:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000330 changelist: Changelist that the tryjobs are associated with.
Edward Lemur45768512020-03-02 19:03:14 +0000331 jobs: A list of (project, bucket, builder).
qyearsley1fdfcb62016-10-24 13:22:03 -0700332 options: Command-line options.
333 """
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000334 print('Scheduling jobs on:')
Edward Lemur45768512020-03-02 19:03:14 +0000335 for project, bucket, builder in jobs:
336 print(' %s/%s: %s' % (project, bucket, builder))
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000337 print('To see results here, run: git cl try-results')
338 print('To see results in browser, run: git cl web')
tandriide281ae2016-10-12 06:02:30 -0700339
Quinten Yearsley777660f2020-03-04 23:37:06 +0000340 requests = _make_tryjob_schedule_requests(changelist, jobs, options, patchset)
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000341 if not requests:
342 return
343
Edward Lemur5b929a42019-10-21 17:57:39 +0000344 http = auth.Authenticator().authorize(httplib2.Http())
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000345 http.force_exception_to_status_code = True
346
347 batch_request = {'requests': requests}
348 batch_response = _call_buildbucket(
349 http, options.buildbucket_host, 'Batch', batch_request)
350
351 errors = [
352 ' ' + response['error']['message']
353 for response in batch_response.get('responses', [])
354 if 'error' in response
355 ]
356 if errors:
357 raise BuildbucketResponseException(
358 'Failed to schedule builds for some bots:\n%s' % '\n'.join(errors))
359
360
Quinten Yearsley777660f2020-03-04 23:37:06 +0000361def _make_tryjob_schedule_requests(changelist, jobs, options, patchset):
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000362 """Constructs requests for Buildbucket to trigger tryjobs."""
Edward Lemurf0faf482019-09-25 20:40:17 +0000363 gerrit_changes = [changelist.GetGerritChange(patchset)]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000364 shared_properties = {
365 'category': options.ensure_value('category', 'git_cl_try')
366 }
367 if options.ensure_value('clobber', False):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000368 shared_properties['clobber'] = True
369 shared_properties.update(_get_properties_from_options(options) or {})
370
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000371 shared_tags = [{'key': 'user_agent', 'value': 'git_cl_try'}]
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000372 if options.ensure_value('retry_failed', False):
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000373 shared_tags.append({'key': 'retry_failed',
374 'value': '1'})
375
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000376 requests = []
Edward Lemur45768512020-03-02 19:03:14 +0000377 for (project, bucket, builder) in jobs:
378 properties = shared_properties.copy()
379 if 'presubmit' in builder.lower():
380 properties['dry_run'] = 'true'
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000381
Edward Lemur45768512020-03-02 19:03:14 +0000382 requests.append({
383 'scheduleBuild': {
384 'requestId': str(uuid.uuid4()),
385 'builder': {
386 'project': getattr(options, 'project', None) or project,
387 'bucket': bucket,
388 'builder': builder,
389 },
390 'gerritChanges': gerrit_changes,
391 'properties': properties,
392 'tags': [
393 {'key': 'builder', 'value': builder},
394 ] + shared_tags,
395 }
396 })
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000397
Quinten Yearsleyee8be8a2020-03-05 21:48:32 +0000398 if options.ensure_value('revision', None):
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000399 remote, remote_branch = changelist.GetRemoteBranch()
Edward Lemur45768512020-03-02 19:03:14 +0000400 requests[-1]['scheduleBuild']['gitilesCommit'] = {
401 'host': gerrit_changes[0]['host'],
402 'project': gerrit_changes[0]['project'],
Josip Sokcevic9011a5b2021-02-12 18:59:44 +0000403 'id': options.revision,
404 'ref': GetTargetRef(remote, remote_branch, None)
Edward Lemur45768512020-03-02 19:03:14 +0000405 }
Anthony Polito1a5fe232020-01-24 23:17:52 +0000406
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000407 return requests
kjellander@chromium.org44424542015-06-02 18:35:29 +0000408
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000409
Quinten Yearsley777660f2020-03-04 23:37:06 +0000410def _fetch_tryjobs(changelist, buildbucket_host, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000411 """Fetches tryjobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000412
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000413 Returns list of buildbucket.v2.Build with the try jobs for the changelist.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000414 """
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000415 fields = ['id', 'builder', 'status', 'createTime', 'tags']
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000416 request = {
417 'predicate': {
418 'gerritChanges': [changelist.GetGerritChange(patchset)],
419 },
420 'fields': ','.join('builds.*.' + field for field in fields),
421 }
tandrii221ab252016-10-06 08:12:04 -0700422
Edward Lemur5b929a42019-10-21 17:57:39 +0000423 authenticator = auth.Authenticator()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000424 if authenticator.has_cached_credentials():
425 http = authenticator.authorize(httplib2.Http())
426 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700427 print('Warning: Some results might be missing because %s' %
428 # Get the message on how to login.
Andrii Shyshkalov2517afd2021-01-19 17:07:43 +0000429 (str(auth.LoginRequiredError()),))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000430 http = httplib2.Http()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000431 http.force_exception_to_status_code = True
432
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000433 response = _call_buildbucket(http, buildbucket_host, 'SearchBuilds', request)
434 return response.get('builds', [])
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000435
Edward Lemur45768512020-03-02 19:03:14 +0000436
Edward Lemur5b929a42019-10-21 17:57:39 +0000437def _fetch_latest_builds(changelist, buildbucket_host, latest_patchset=None):
Quinten Yearsley983111f2019-09-26 17:18:48 +0000438 """Fetches builds from the latest patchset that has builds (within
439 the last few patchsets).
440
441 Args:
Quinten Yearsley983111f2019-09-26 17:18:48 +0000442 changelist (Changelist): The CL to fetch builds for
443 buildbucket_host (str): Buildbucket host, e.g. "cr-buildbucket.appspot.com"
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000444 lastest_patchset(int|NoneType): the patchset to start fetching builds from.
445 If None (default), starts with the latest available patchset.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000446 Returns:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000447 A tuple (builds, patchset) where builds is a list of buildbucket.v2.Build,
448 and patchset is the patchset number where those builds came from.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000449 """
450 assert buildbucket_host
451 assert changelist.GetIssue(), 'CL must be uploaded first'
452 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000453 if latest_patchset is None:
454 assert changelist.GetMostRecentPatchset()
455 ps = changelist.GetMostRecentPatchset()
456 else:
457 assert latest_patchset > 0, latest_patchset
458 ps = latest_patchset
459
Quinten Yearsley983111f2019-09-26 17:18:48 +0000460 min_ps = max(1, ps - 5)
461 while ps >= min_ps:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000462 builds = _fetch_tryjobs(changelist, buildbucket_host, patchset=ps)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000463 if len(builds):
464 return builds, ps
465 ps -= 1
466 return [], 0
467
468
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000469def _filter_failed_for_retry(all_builds):
470 """Returns a list of buckets/builders that are worth retrying.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000471
472 Args:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000473 all_builds (list): Builds, in the format returned by _fetch_tryjobs,
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000474 i.e. a list of buildbucket.v2.Builds which includes status and builder
475 info.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000476
477 Returns:
Edward Lemur45768512020-03-02 19:03:14 +0000478 A dict {(proj, bucket): [builders]}. This is the same format accepted by
Quinten Yearsley777660f2020-03-04 23:37:06 +0000479 _trigger_tryjobs.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000480 """
Edward Lemur45768512020-03-02 19:03:14 +0000481 grouped = {}
482 for build in all_builds:
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000483 builder = build['builder']
Edward Lemur45768512020-03-02 19:03:14 +0000484 key = (builder['project'], builder['bucket'], builder['builder'])
485 grouped.setdefault(key, []).append(build)
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000486
Edward Lemur45768512020-03-02 19:03:14 +0000487 jobs = []
488 for (project, bucket, builder), builds in grouped.items():
489 if 'triggered' in builder:
490 print('WARNING: Not scheduling %s. Triggered bots require an initial job '
491 'from a parent. Please schedule a manual job for the parent '
492 'instead.')
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000493 continue
494 if any(b['status'] in ('STARTED', 'SCHEDULED') for b in builds):
495 # Don't retry if any are running.
496 continue
Edward Lemur45768512020-03-02 19:03:14 +0000497 # If builder had several builds, retry only if the last one failed.
498 # This is a bit different from CQ, which would re-use *any* SUCCESS-full
499 # build, but in case of retrying failed jobs retrying a flaky one makes
500 # sense.
501 builds = sorted(builds, key=lambda b: b['createTime'])
502 if builds[-1]['status'] not in ('FAILURE', 'INFRA_FAILURE'):
503 continue
504 # Don't retry experimental build previously triggered by CQ.
505 if any(t['key'] == 'cq_experimental' and t['value'] == 'true'
506 for t in builds[-1]['tags']):
507 continue
508 jobs.append((project, bucket, builder))
509
510 # Sort the jobs to make testing easier.
511 return sorted(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000512
513
Quinten Yearsley777660f2020-03-04 23:37:06 +0000514def _print_tryjobs(options, builds):
515 """Prints nicely result of _fetch_tryjobs."""
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000516 if not builds:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000517 print('No tryjobs scheduled.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000518 return
519
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000520 longest_builder = max(len(b['builder']['builder']) for b in builds)
521 name_fmt = '{builder:<%d}' % longest_builder
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000522 if options.print_master:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000523 longest_bucket = max(len(b['builder']['bucket']) for b in builds)
524 name_fmt = ('{bucket:>%d} ' % longest_bucket) + name_fmt
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000525
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000526 builds_by_status = {}
527 for b in builds:
528 builds_by_status.setdefault(b['status'], []).append({
529 'id': b['id'],
530 'name': name_fmt.format(
531 builder=b['builder']['builder'], bucket=b['builder']['bucket']),
532 })
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000533
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000534 sort_key = lambda b: (b['name'], b['id'])
535
536 def print_builds(title, builds, fmt=None, color=None):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000537 """Pop matching builds from `builds` dict and print them."""
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000538 if not builds:
539 return
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000540
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000541 fmt = fmt or '{name} https://ci.chromium.org/b/{id}'
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000542 if not options.color or color is None:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000543 colorize = lambda x: x
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000544 else:
545 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
546
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000547 print(colorize(title))
548 for b in sorted(builds, key=sort_key):
549 print(' ', colorize(fmt.format(**b)))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000550
551 total = len(builds)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000552 print_builds(
553 'Successes:', builds_by_status.pop('SUCCESS', []), color=Fore.GREEN)
554 print_builds(
555 'Infra Failures:', builds_by_status.pop('INFRA_FAILURE', []),
556 color=Fore.MAGENTA)
557 print_builds('Failures:', builds_by_status.pop('FAILURE', []), color=Fore.RED)
558 print_builds('Canceled:', builds_by_status.pop('CANCELED', []), fmt='{name}',
559 color=Fore.MAGENTA)
Andrii Shyshkalov792630c2020-10-19 16:47:44 +0000560 print_builds('Started:', builds_by_status.pop('STARTED', []),
561 color=Fore.YELLOW)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000562 print_builds(
563 'Scheduled:', builds_by_status.pop('SCHEDULED', []), fmt='{name} id={id}')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000564 # The last section is just in case buildbucket API changes OR there is a bug.
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000565 print_builds(
566 'Other:', sum(builds_by_status.values(), []), fmt='{name} id={id}')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000567 print('Total: %d tryjobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000568
569
Aiden Bennerc08566e2018-10-03 17:52:42 +0000570def _ComputeDiffLineRanges(files, upstream_commit):
571 """Gets the changed line ranges for each file since upstream_commit.
572
573 Parses a git diff on provided files and returns a dict that maps a file name
574 to an ordered list of range tuples in the form (start_line, count).
575 Ranges are in the same format as a git diff.
576 """
577 # If files is empty then diff_output will be a full diff.
578 if len(files) == 0:
579 return {}
580
Aiden Benner6c18a1a2018-11-23 20:18:23 +0000581 # Take the git diff and find the line ranges where there are changes.
Jamie Madill3671a6a2019-10-24 15:13:21 +0000582 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000583 diff_output = RunGit(diff_cmd)
584
585 pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)'
586 # 2 capture groups
587 # 0 == fname of diff file
588 # 1 == 'diff_start,diff_count' or 'diff_start'
589 # will match each of
590 # diff --git a/foo.foo b/foo.py
591 # @@ -12,2 +14,3 @@
592 # @@ -12,2 +17 @@
593 # running re.findall on the above string with pattern will give
594 # [('foo.py', ''), ('', '14,3'), ('', '17')]
595
596 curr_file = None
597 line_diffs = {}
598 for match in re.findall(pattern, diff_output, flags=re.MULTILINE):
599 if match[0] != '':
600 # Will match the second filename in diff --git a/a.py b/b.py.
601 curr_file = match[0]
602 line_diffs[curr_file] = []
603 else:
604 # Matches +14,3
605 if ',' in match[1]:
606 diff_start, diff_count = match[1].split(',')
607 else:
608 # Single line changes are of the form +12 instead of +12,1.
609 diff_start = match[1]
610 diff_count = 1
611
612 diff_start = int(diff_start)
613 diff_count = int(diff_count)
614
615 # If diff_count == 0 this is a removal we can ignore.
616 line_diffs[curr_file].append((diff_start, diff_count))
617
618 return line_diffs
619
620
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000621def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000622 """Checks if a yapf file is in any parent directory of fpath until top_dir.
623
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000624 Recursively checks parent directories to find yapf file and if no yapf file
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000625 is found returns None. Uses yapf_config_cache as a cache for previously found
626 configs.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000627 """
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000628 fpath = os.path.abspath(fpath)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000629 # Return result if we've already computed it.
630 if fpath in yapf_config_cache:
631 return yapf_config_cache[fpath]
632
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000633 parent_dir = os.path.dirname(fpath)
634 if os.path.isfile(fpath):
635 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000636 else:
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000637 # Otherwise fpath is a directory
638 yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME)
639 if os.path.isfile(yapf_file):
640 ret = yapf_file
641 elif fpath == top_dir or parent_dir == fpath:
642 # If we're at the top level directory, or if we're at root
643 # there is no provided style.
644 ret = None
645 else:
646 # Otherwise recurse on the current directory.
647 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000648 yapf_config_cache[fpath] = ret
649 return ret
650
651
Brian Sheedyb4307d52019-12-02 19:18:17 +0000652def _GetYapfIgnorePatterns(top_dir):
653 """Returns all patterns in the .yapfignore file.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000654
655 yapf is supposed to handle the ignoring of files listed in .yapfignore itself,
656 but this functionality appears to break when explicitly passing files to
657 yapf for formatting. According to
Josip Sokcevicc39ab992020-09-24 20:09:15 +0000658 https://github.com/google/yapf/blob/HEAD/README.rst#excluding-files-from-formatting-yapfignore,
Brian Sheedy59b06a82019-10-14 17:03:29 +0000659 the .yapfignore file should be in the directory that yapf is invoked from,
660 which we assume to be the top level directory in this case.
661
662 Args:
663 top_dir: The top level directory for the repository being formatted.
664
665 Returns:
Brian Sheedyb4307d52019-12-02 19:18:17 +0000666 A set of all fnmatch patterns to be ignored.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000667 """
668 yapfignore_file = os.path.join(top_dir, '.yapfignore')
Brian Sheedyb4307d52019-12-02 19:18:17 +0000669 ignore_patterns = set()
Brian Sheedy59b06a82019-10-14 17:03:29 +0000670 if not os.path.exists(yapfignore_file):
Brian Sheedyb4307d52019-12-02 19:18:17 +0000671 return ignore_patterns
Brian Sheedy59b06a82019-10-14 17:03:29 +0000672
Anthony Politoc64e3902021-04-30 21:55:25 +0000673 for line in gclient_utils.FileRead(yapfignore_file).split('\n'):
674 stripped_line = line.strip()
675 # Comments and blank lines should be ignored.
676 if stripped_line.startswith('#') or stripped_line == '':
677 continue
678 ignore_patterns.add(stripped_line)
Brian Sheedyb4307d52019-12-02 19:18:17 +0000679 return ignore_patterns
680
681
682def _FilterYapfIgnoredFiles(filepaths, patterns):
683 """Filters out any filepaths that match any of the given patterns.
684
685 Args:
686 filepaths: An iterable of strings containing filepaths to filter.
687 patterns: An iterable of strings containing fnmatch patterns to filter on.
688
689 Returns:
690 A list of strings containing all the elements of |filepaths| that did not
691 match any of the patterns in |patterns|.
692 """
693 # Not inlined so that tests can use the same implementation.
694 return [f for f in filepaths
695 if not any(fnmatch.fnmatch(f, p) for p in patterns)]
Brian Sheedy59b06a82019-10-14 17:03:29 +0000696
697
Aaron Gable13101a62018-02-09 13:20:41 -0800698def print_stats(args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000699 """Prints statistics about the change to the user."""
700 # --no-ext-diff is broken in some versions of Git, so try to work around
701 # this by overriding the environment (but there is still a problem if the
702 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000703 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000704 if 'GIT_EXTERNAL_DIFF' in env:
705 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000706
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000707 return subprocess2.call(
Aaron Gable13101a62018-02-09 13:20:41 -0800708 ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args,
Edward Lemur0db01f02019-11-12 22:01:51 +0000709 env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000710
711
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000712class BuildbucketResponseException(Exception):
713 pass
714
715
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000716class Settings(object):
717 def __init__(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000718 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000719 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000720 self.tree_status_url = None
721 self.viewvc_url = None
722 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000723 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000724 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000725 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000726 self.git_editor = None
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000727 self.format_full_by_default = None
Sigurd Schneider1bfda8e2021-06-30 14:46:25 +0000728 self.is_status_commit_order_by_date = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000729
Edward Lemur26964072020-02-19 19:18:51 +0000730 def _LazyUpdateIfNeeded(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000731 """Updates the settings from a codereview.settings file, if available."""
Edward Lemur26964072020-02-19 19:18:51 +0000732 if self.updated:
733 return
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000734
Edward Lemur26964072020-02-19 19:18:51 +0000735 # The only value that actually changes the behavior is
736 # autoupdate = "false". Everything else means "true".
737 autoupdate = (
738 scm.GIT.GetConfig(self.GetRoot(), 'rietveld.autoupdate', '').lower())
739
740 cr_settings_file = FindCodereviewSettingsFile()
741 if autoupdate != 'false' and cr_settings_file:
742 LoadCodereviewSettingsFromFile(cr_settings_file)
743 cr_settings_file.close()
744
745 self.updated = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000746
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000747 @staticmethod
748 def GetRelativeRoot():
Edward Lesmes50da7702020-03-30 19:23:43 +0000749 return scm.GIT.GetCheckoutRoot('.')
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000750
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000751 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000752 if self.root is None:
753 self.root = os.path.abspath(self.GetRelativeRoot())
754 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000755
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000756 def GetTreeStatusUrl(self, error_ok=False):
757 if not self.tree_status_url:
Edward Lemur26964072020-02-19 19:18:51 +0000758 self.tree_status_url = self._GetConfig('rietveld.tree-status-url')
759 if self.tree_status_url is None and not error_ok:
760 DieWithError(
761 'You must configure your tree status URL by running '
762 '"git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000763 return self.tree_status_url
764
765 def GetViewVCUrl(self):
766 if not self.viewvc_url:
Edward Lemur26964072020-02-19 19:18:51 +0000767 self.viewvc_url = self._GetConfig('rietveld.viewvc-url')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000768 return self.viewvc_url
769
rmistry@google.com90752582014-01-14 21:04:50 +0000770 def GetBugPrefix(self):
Edward Lemur26964072020-02-19 19:18:51 +0000771 return self._GetConfig('rietveld.bug-prefix')
rmistry@google.com78948ed2015-07-08 23:09:57 +0000772
rmistry@google.com5626a922015-02-26 14:03:30 +0000773 def GetRunPostUploadHook(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000774 run_post_upload_hook = self._GetConfig(
Edward Lemur26964072020-02-19 19:18:51 +0000775 'rietveld.run-post-upload-hook')
rmistry@google.com5626a922015-02-26 14:03:30 +0000776 return run_post_upload_hook == "True"
777
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000778 def GetDefaultCCList(self):
Edward Lemur26964072020-02-19 19:18:51 +0000779 return self._GetConfig('rietveld.cc')
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000780
Dirk Pranke6f0df682021-06-25 00:42:33 +0000781 def GetUsePython3(self):
782 return self._GetConfig('rietveld.use-python3')
783
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000784 def GetSquashGerritUploads(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000785 """Returns True if uploads to Gerrit should be squashed by default."""
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000786 if self.squash_gerrit_uploads is None:
Edward Lesmes4de54132020-05-05 19:41:33 +0000787 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
788 if self.squash_gerrit_uploads is None:
Edward Lemur26964072020-02-19 19:18:51 +0000789 # Default is squash now (http://crbug.com/611892#c23).
790 self.squash_gerrit_uploads = self._GetConfig(
791 'gerrit.squash-uploads').lower() != 'false'
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000792 return self.squash_gerrit_uploads
793
Edward Lesmes4de54132020-05-05 19:41:33 +0000794 def GetSquashGerritUploadsOverride(self):
795 """Return True or False if codereview.settings should be overridden.
796
797 Returns None if no override has been defined.
798 """
799 # See also http://crbug.com/611892#c23
800 result = self._GetConfig('gerrit.override-squash-uploads').lower()
801 if result == 'true':
802 return True
803 if result == 'false':
804 return False
805 return None
806
tandrii@chromium.org28253532016-04-14 13:46:56 +0000807 def GetGerritSkipEnsureAuthenticated(self):
808 """Return True if EnsureAuthenticated should not be done for Gerrit
809 uploads."""
810 if self.gerrit_skip_ensure_authenticated is None:
Edward Lemur26964072020-02-19 19:18:51 +0000811 self.gerrit_skip_ensure_authenticated = self._GetConfig(
812 'gerrit.skip-ensure-authenticated').lower() == 'true'
tandrii@chromium.org28253532016-04-14 13:46:56 +0000813 return self.gerrit_skip_ensure_authenticated
814
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000815 def GetGitEditor(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000816 """Returns the editor specified in the git config, or None if none is."""
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000817 if self.git_editor is None:
Raul Tambre5a525872019-02-12 19:08:08 +0000818 # Git requires single quotes for paths with spaces. We need to replace
819 # them with double quotes for Windows to treat such paths as a single
820 # path.
Edward Lemur26964072020-02-19 19:18:51 +0000821 self.git_editor = self._GetConfig('core.editor').replace('\'', '"')
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000822 return self.git_editor or None
823
thestig@chromium.org44202a22014-03-11 19:22:18 +0000824 def GetLintRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000825 return self._GetConfig('rietveld.cpplint-regex', DEFAULT_LINT_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000826
827 def GetLintIgnoreRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000828 return self._GetConfig(
829 'rietveld.cpplint-ignore-regex', DEFAULT_LINT_IGNORE_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000830
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000831 def GetFormatFullByDefault(self):
832 if self.format_full_by_default is None:
Jamie Madillac6f6232021-07-07 20:54:08 +0000833 self._LazyUpdateIfNeeded()
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000834 result = (
835 RunGit(['config', '--bool', 'rietveld.format-full-by-default'],
836 error_ok=True).strip())
837 self.format_full_by_default = (result == 'true')
838 return self.format_full_by_default
839
Sigurd Schneider1bfda8e2021-06-30 14:46:25 +0000840 def IsStatusCommitOrderByDate(self):
841 if self.is_status_commit_order_by_date is None:
842 result = (RunGit(['config', '--bool', 'cl.date-order'],
843 error_ok=True).strip())
844 self.is_status_commit_order_by_date = (result == 'true')
845 return self.is_status_commit_order_by_date
846
Edward Lemur26964072020-02-19 19:18:51 +0000847 def _GetConfig(self, key, default=''):
848 self._LazyUpdateIfNeeded()
849 return scm.GIT.GetConfig(self.GetRoot(), key, default)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000850
851
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000852class _CQState(object):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +0000853 """Enum for states of CL with respect to CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000854 NONE = 'none'
Greg Gutermanbe5fccd2021-06-14 17:58:20 +0000855 QUICK_RUN = 'quick_run'
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000856 DRY_RUN = 'dry_run'
857 COMMIT = 'commit'
858
Greg Gutermanbe5fccd2021-06-14 17:58:20 +0000859 ALL_STATES = [NONE, QUICK_RUN, DRY_RUN, COMMIT]
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000860
861
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000862class _ParsedIssueNumberArgument(object):
Edward Lemurf38bc172019-09-03 21:02:13 +0000863 def __init__(self, issue=None, patchset=None, hostname=None):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000864 self.issue = issue
865 self.patchset = patchset
866 self.hostname = hostname
867
868 @property
869 def valid(self):
870 return self.issue is not None
871
872
Edward Lemurf38bc172019-09-03 21:02:13 +0000873def ParseIssueNumberArgument(arg):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000874 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
875 fail_result = _ParsedIssueNumberArgument()
876
Edward Lemur678a6842019-10-03 22:25:05 +0000877 if isinstance(arg, int):
878 return _ParsedIssueNumberArgument(issue=arg)
879 if not isinstance(arg, basestring):
880 return fail_result
881
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000882 if arg.isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +0000883 return _ParsedIssueNumberArgument(issue=int(arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000884 if not arg.startswith('http'):
885 return fail_result
Aaron Gableaee6c852017-06-26 12:49:01 -0700886
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000887 url = gclient_utils.UpgradeToHttps(arg)
Andrii Shyshkalov8aebb602020-04-16 22:10:27 +0000888 for gerrit_url, short_url in _KNOWN_GERRIT_TO_SHORT_URLS.items():
889 if url.startswith(short_url):
890 url = gerrit_url + url[len(short_url):]
891 break
892
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000893 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000894 parsed_url = urllib.parse.urlparse(url)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000895 except ValueError:
896 return fail_result
Andrii Shyshkalov28d840e2017-04-10 15:45:09 +0200897
Edward Lemur678a6842019-10-03 22:25:05 +0000898 # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]]
899 # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]]
900 # Short urls like https://domain/<issue_number> can be used, but don't allow
901 # specifying the patchset (you'd 404), but we allow that here.
902 if parsed_url.path == '/':
903 part = parsed_url.fragment
904 else:
905 part = parsed_url.path
906
907 match = re.match(
908 r'(/c(/.*/\+)?)?/(?P<issue>\d+)(/(?P<patchset>\d+)?/?)?$', part)
909 if not match:
910 return fail_result
911
912 issue = int(match.group('issue'))
913 patchset = match.group('patchset')
914 return _ParsedIssueNumberArgument(
915 issue=issue,
916 patchset=int(patchset) if patchset else None,
917 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000918
919
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000920def _create_description_from_log(args):
921 """Pulls out the commit log to use as a base for the CL description."""
922 log_args = []
923 if len(args) == 1 and not args[0].endswith('.'):
924 log_args = [args[0] + '..']
925 elif len(args) == 1 and args[0].endswith('...'):
926 log_args = [args[0][:-1]]
927 elif len(args) == 2:
928 log_args = [args[0] + '..' + args[1]]
929 else:
930 log_args = args[:] # Hope for the best!
Manh Nguyene3644862020-08-05 18:25:46 +0000931 return RunGit(['log', '--pretty=format:%B%n'] + log_args)
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000932
933
Aaron Gablea45ee112016-11-22 15:14:38 -0800934class GerritChangeNotExists(Exception):
tandriic2405f52016-10-10 08:13:15 -0700935 def __init__(self, issue, url):
936 self.issue = issue
937 self.url = url
Aaron Gablea45ee112016-11-22 15:14:38 -0800938 super(GerritChangeNotExists, self).__init__()
tandriic2405f52016-10-10 08:13:15 -0700939
940 def __str__(self):
Aaron Gablea45ee112016-11-22 15:14:38 -0800941 return 'change %s at %s does not exist or you have no access to it' % (
tandriic2405f52016-10-10 08:13:15 -0700942 self.issue, self.url)
943
944
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100945_CommentSummary = collections.namedtuple(
Quinten Yearsley0e617c02019-02-20 00:37:03 +0000946 '_CommentSummary', ['date', 'message', 'sender', 'autogenerated',
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100947 # TODO(tandrii): these two aren't known in Gerrit.
948 'approval', 'disapproval'])
949
950
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000951class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000952 """Changelist works with one changelist in local branch.
953
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +0000954 Notes:
955 * Not safe for concurrent multi-{thread,process} use.
956 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -0700957 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000958 """
959
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000960 def __init__(self,
961 branchref=None,
962 issue=None,
963 codereview_host=None,
964 commit_date=None):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000965 """Create a new ChangeList instance.
966
Edward Lemurf38bc172019-09-03 21:02:13 +0000967 **kwargs will be passed directly to Gerrit implementation.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000968 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000969 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +0000970 global settings
971 if not settings:
972 # Happens when git_cl.py is used as a utility library.
973 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000974
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000975 self.branchref = branchref
976 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000977 assert branchref.startswith('refs/heads/')
Edward Lemur85153282020-02-14 22:06:29 +0000978 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000979 else:
980 self.branch = None
Sigurd Schneider9abde8c2020-11-17 08:44:52 +0000981 self.commit_date = commit_date
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000982 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +0000983 self.lookedup_issue = False
984 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000985 self.description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +0000986 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000987 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000988 self.cc = None
Daniel Cheng7227d212017-11-17 08:12:37 -0800989 self.more_cc = []
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000990 self._remote = None
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +0000991 self._cached_remote_url = (False, None) # (is_cached, value)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +0000992
Edward Lemur125d60a2019-09-13 18:25:41 +0000993 # Lazily cached values.
994 self._gerrit_host = None # e.g. chromium-review.googlesource.com
995 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
Edward Lesmese1576912021-02-16 21:53:34 +0000996 self._owners_client = None
Edward Lemur125d60a2019-09-13 18:25:41 +0000997 # Map from change number (issue) to its detail cache.
998 self._detail_cache = {}
999
1000 if codereview_host is not None:
1001 assert not codereview_host.startswith('https://'), codereview_host
1002 self._gerrit_host = codereview_host
1003 self._gerrit_server = 'https://%s' % codereview_host
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001004
Edward Lesmese1576912021-02-16 21:53:34 +00001005 @property
1006 def owners_client(self):
1007 if self._owners_client is None:
1008 remote, remote_branch = self.GetRemoteBranch()
1009 branch = GetTargetRef(remote, remote_branch, None)
1010 self._owners_client = owners_client.GetCodeOwnersClient(
1011 root=settings.GetRoot(),
Edward Lesmes1eaaab52021-03-02 23:52:54 +00001012 upstream=self.GetCommonAncestorWithUpstream(),
Edward Lesmese1576912021-02-16 21:53:34 +00001013 host=self.GetGerritHost(),
1014 project=self.GetGerritProject(),
1015 branch=branch)
1016 return self._owners_client
1017
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001018 def GetCCList(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001019 """Returns the users cc'd on this CL.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001020
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001021 The return value is a string suitable for passing to git cl with the --cc
1022 flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001023 """
1024 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001025 base_cc = settings.GetDefaultCCList()
Daniel Cheng7227d212017-11-17 08:12:37 -08001026 more_cc = ','.join(self.more_cc)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001027 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1028 return self.cc
1029
Daniel Cheng7227d212017-11-17 08:12:37 -08001030 def ExtendCC(self, more_cc):
1031 """Extends the list of users to cc on this CL based on the changed files."""
1032 self.more_cc.extend(more_cc)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001033
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00001034 def GetCommitDate(self):
1035 """Returns the commit date as provided in the constructor"""
1036 return self.commit_date
1037
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001038 def GetBranch(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001039 """Returns the short branch name, e.g. 'main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001040 if not self.branch:
Edward Lemur85153282020-02-14 22:06:29 +00001041 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001042 if not branchref:
1043 return None
1044 self.branchref = branchref
Edward Lemur85153282020-02-14 22:06:29 +00001045 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001046 return self.branch
1047
1048 def GetBranchRef(self):
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001049 """Returns the full branch name, e.g. 'refs/heads/main'."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001050 self.GetBranch() # Poke the lazy loader.
1051 return self.branchref
1052
Edward Lemur85153282020-02-14 22:06:29 +00001053 def _GitGetBranchConfigValue(self, key, default=None):
1054 return scm.GIT.GetBranchConfig(
1055 settings.GetRoot(), self.GetBranch(), key, default)
tandrii5d48c322016-08-18 16:19:37 -07001056
Edward Lemur85153282020-02-14 22:06:29 +00001057 def _GitSetBranchConfigValue(self, key, value):
1058 action = 'set %s to %r' % (key, value)
1059 if not value:
1060 action = 'unset %s' % key
1061 assert self.GetBranch(), 'a branch is needed to ' + action
1062 return scm.GIT.SetBranchConfig(
1063 settings.GetRoot(), self.GetBranch(), key, value)
tandrii5d48c322016-08-18 16:19:37 -07001064
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001065 @staticmethod
1066 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001067 """Returns a tuple containing remote and remote ref,
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001068 e.g. 'origin', 'refs/heads/main'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001069 """
Edward Lemur15a9b8c2020-02-13 00:52:30 +00001070 remote, upstream_branch = scm.GIT.FetchUpstreamTuple(
1071 settings.GetRoot(), branch)
1072 if not remote or not upstream_branch:
1073 DieWithError(
1074 'Unable to determine default branch to diff against.\n'
Josip Sokcevicb038f722021-01-06 18:28:11 +00001075 'Verify this branch is set up to track another \n'
1076 '(via the --track argument to "git checkout -b ..."). \n'
1077 'or pass complete "git diff"-style arguments if supported, like\n'
1078 ' git cl upload origin/main\n')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001079
1080 return remote, upstream_branch
1081
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001082 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001083 upstream_branch = self.GetUpstreamBranch()
Edward Lesmes50da7702020-03-30 19:23:43 +00001084 if not scm.GIT.IsValidRevision(settings.GetRoot(), upstream_branch):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001085 DieWithError('The upstream for the current branch (%s) does not exist '
1086 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001087 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001088 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001089
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001090 def GetUpstreamBranch(self):
1091 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001092 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Raul Tambrefe1dbe12019-05-02 04:43:57 +00001093 if remote != '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001094 upstream_branch = upstream_branch.replace('refs/heads/',
1095 'refs/remotes/%s/' % remote)
1096 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1097 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001098 self.upstream_branch = upstream_branch
1099 return self.upstream_branch
1100
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001101 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001102 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001103 remote, branch = None, self.GetBranch()
1104 seen_branches = set()
1105 while branch not in seen_branches:
1106 seen_branches.add(branch)
1107 remote, branch = self.FetchUpstreamTuple(branch)
Edward Lemur85153282020-02-14 22:06:29 +00001108 branch = scm.GIT.ShortBranchName(branch)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001109 if remote != '.' or branch.startswith('refs/remotes'):
1110 break
1111 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001112 remotes = RunGit(['remote'], error_ok=True).split()
1113 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001114 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001115 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001116 remote = 'origin'
Gavin Make6a62332020-12-04 21:57:10 +00001117 logging.warning('Could not determine which remote this change is '
1118 'associated with, so defaulting to "%s".' %
1119 self._remote)
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001120 else:
Gavin Make6a62332020-12-04 21:57:10 +00001121 logging.warning('Could not determine which remote this change is '
1122 'associated with.')
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001123 branch = 'HEAD'
1124 if branch.startswith('refs/remotes'):
1125 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001126 elif branch.startswith('refs/branch-heads/'):
1127 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001128 else:
1129 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001130 return self._remote
1131
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001132 def GetRemoteUrl(self):
1133 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1134
1135 Returns None if there is no remote.
1136 """
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001137 is_cached, value = self._cached_remote_url
1138 if is_cached:
1139 return value
1140
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001141 remote, _ = self.GetRemoteBranch()
Edward Lemur26964072020-02-19 19:18:51 +00001142 url = scm.GIT.GetConfig(settings.GetRoot(), 'remote.%s.url' % remote, '')
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001143
Edward Lemur298f2cf2019-02-22 21:40:39 +00001144 # Check if the remote url can be parsed as an URL.
Edward Lemur79d4f992019-11-11 23:49:02 +00001145 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001146 if host:
1147 self._cached_remote_url = (True, url)
1148 return url
1149
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001150 # If it cannot be parsed as an url, assume it is a local directory,
1151 # probably a git cache.
Edward Lemur298f2cf2019-02-22 21:40:39 +00001152 logging.warning('"%s" doesn\'t appear to point to a git host. '
1153 'Interpreting it as a local directory.', url)
1154 if not os.path.isdir(url):
1155 logging.error(
Josip906bfde2020-01-31 22:38:49 +00001156 'Remote "%(remote)s" for branch "%(branch)s" points to "%(url)s", '
1157 'but it doesn\'t exist.',
1158 {'remote': remote, 'branch': self.GetBranch(), 'url': url})
Edward Lemur298f2cf2019-02-22 21:40:39 +00001159 return None
1160
1161 cache_path = url
Edward Lemur26964072020-02-19 19:18:51 +00001162 url = scm.GIT.GetConfig(url, 'remote.%s.url' % remote, '')
Edward Lemur298f2cf2019-02-22 21:40:39 +00001163
Edward Lemur79d4f992019-11-11 23:49:02 +00001164 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001165 if not host:
1166 logging.error(
1167 'Remote "%(remote)s" for branch "%(branch)s" points to '
1168 '"%(cache_path)s", but it is misconfigured.\n'
1169 '"%(cache_path)s" must be a git repo and must have a remote named '
1170 '"%(remote)s" pointing to the git host.', {
1171 'remote': remote,
1172 'cache_path': cache_path,
1173 'branch': self.GetBranch()})
1174 return None
1175
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001176 self._cached_remote_url = (True, url)
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001177 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001178
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001179 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001180 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001181 if self.issue is None and not self.lookedup_issue:
Edward Lesmes50da7702020-03-30 19:23:43 +00001182 self.issue = self._GitGetBranchConfigValue(ISSUE_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001183 if self.issue is not None:
1184 self.issue = int(self.issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001185 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001186 return self.issue
1187
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001188 def GetIssueURL(self, short=False):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001189 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001190 issue = self.GetIssue()
1191 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001192 return None
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00001193 server = self.GetCodereviewServer()
1194 if short:
1195 server = _KNOWN_GERRIT_TO_SHORT_URLS.get(server, server)
1196 return '%s/%s' % (server, issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001197
Dirk Pranke6f0df682021-06-25 00:42:33 +00001198 def GetUsePython3(self):
Josip Sokcevic340edc32021-07-08 17:01:46 +00001199 return settings.GetUsePython3()
Dirk Pranke6f0df682021-06-25 00:42:33 +00001200
Edward Lemur6c6827c2020-02-06 21:15:18 +00001201 def FetchDescription(self, pretty=False):
1202 assert self.GetIssue(), 'issue is required to query Gerrit'
1203
Edward Lemur9aa1a962020-02-25 00:58:38 +00001204 if self.description is None:
Edward Lemur6c6827c2020-02-06 21:15:18 +00001205 data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
1206 current_rev = data['current_revision']
1207 self.description = data['revisions'][current_rev]['commit']['message']
Edward Lemur6c6827c2020-02-06 21:15:18 +00001208
1209 if not pretty:
1210 return self.description
1211
1212 # Set width to 72 columns + 2 space indent.
1213 wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True)
1214 wrapper.initial_indent = wrapper.subsequent_indent = ' '
1215 lines = self.description.splitlines()
1216 return '\n'.join([wrapper.fill(line) for line in lines])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001217
1218 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001219 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001220 if self.patchset is None and not self.lookedup_patchset:
Edward Lesmes50da7702020-03-30 19:23:43 +00001221 self.patchset = self._GitGetBranchConfigValue(PATCHSET_CONFIG_KEY)
Edward Lemur85153282020-02-14 22:06:29 +00001222 if self.patchset is not None:
1223 self.patchset = int(self.patchset)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001224 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001225 return self.patchset
1226
Edward Lemur9aa1a962020-02-25 00:58:38 +00001227 def GetAuthor(self):
1228 return scm.GIT.GetConfig(settings.GetRoot(), 'user.email')
1229
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001230 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001231 """Set this branch's patchset. If patchset=0, clears the patchset."""
1232 assert self.GetBranch()
1233 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001234 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001235 else:
1236 self.patchset = int(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00001237 self._GitSetBranchConfigValue(PATCHSET_CONFIG_KEY, str(self.patchset))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001238
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001239 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001240 """Set this branch's issue. If issue isn't given, clears the issue."""
1241 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001242 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001243 issue = int(issue)
Edward Lesmes50da7702020-03-30 19:23:43 +00001244 self._GitSetBranchConfigValue(ISSUE_CONFIG_KEY, str(issue))
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001245 self.issue = issue
Edward Lemur125d60a2019-09-13 18:25:41 +00001246 codereview_server = self.GetCodereviewServer()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001247 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001248 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001249 CODEREVIEW_SERVER_CONFIG_KEY, codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001250 else:
tandrii5d48c322016-08-18 16:19:37 -07001251 # Reset all of these just to be clean.
1252 reset_suffixes = [
1253 'last-upload-hash',
Edward Lesmes50da7702020-03-30 19:23:43 +00001254 ISSUE_CONFIG_KEY,
1255 PATCHSET_CONFIG_KEY,
1256 CODEREVIEW_SERVER_CONFIG_KEY,
1257 'gerritsquashhash',
1258 ]
tandrii5d48c322016-08-18 16:19:37 -07001259 for prop in reset_suffixes:
Edward Lemur85153282020-02-14 22:06:29 +00001260 try:
1261 self._GitSetBranchConfigValue(prop, None)
1262 except subprocess2.CalledProcessError:
1263 pass
Aaron Gableca01e2c2017-07-19 11:16:02 -07001264 msg = RunGit(['log', '-1', '--format=%B']).strip()
1265 if msg and git_footers.get_footer_change_id(msg):
1266 print('WARNING: The change patched into this branch has a Change-Id. '
1267 'Removing it.')
1268 RunGit(['commit', '--amend', '-m',
1269 git_footers.remove_footer(msg, 'Change-Id')])
Edward Lemurf38bc172019-09-03 21:02:13 +00001270 self.lookedup_issue = True
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001271 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001272 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001273
Edward Lemur2c62b332020-03-12 22:12:33 +00001274 def GetAffectedFiles(self, upstream):
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001275 try:
Edward Lemur2c62b332020-03-12 22:12:33 +00001276 return [f for _, f in scm.GIT.CaptureStatus(settings.GetRoot(), upstream)]
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001277 except subprocess2.CalledProcessError:
1278 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001279 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001280 'This branch probably doesn\'t exist anymore. To reset the\n'
1281 'tracking branch, please run\n'
Josip Sokcevicc39ab992020-09-24 20:09:15 +00001282 ' git branch --set-upstream-to origin/main %s\n'
1283 'or replace origin/main with the relevant branch') %
Edward Lemur2c62b332020-03-12 22:12:33 +00001284 (upstream, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001285
dsansomee2d6fd92016-09-08 00:10:47 -07001286 def UpdateDescription(self, description, force=False):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001287 assert self.GetIssue(), 'issue is required to update description'
1288
1289 if gerrit_util.HasPendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001290 self.GetGerritHost(), self._GerritChangeIdentifier()):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001291 if not force:
1292 confirm_or_exit(
1293 'The description cannot be modified while the issue has a pending '
1294 'unpublished edit. Either publish the edit in the Gerrit web UI '
1295 'or delete it.\n\n', action='delete the unpublished edit')
1296
1297 gerrit_util.DeletePendingChangeEdit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001298 self.GetGerritHost(), self._GerritChangeIdentifier())
Edward Lemur6c6827c2020-02-06 21:15:18 +00001299 gerrit_util.SetCommitMessage(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001300 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur6c6827c2020-02-06 21:15:18 +00001301 description, notify='NONE')
1302
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001303 self.description = description
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001304
Edward Lemur75526302020-02-27 22:31:05 +00001305 def _GetCommonPresubmitArgs(self, verbose, upstream):
Edward Lemur227d5102020-02-25 23:45:35 +00001306 args = [
Edward Lemur227d5102020-02-25 23:45:35 +00001307 '--root', settings.GetRoot(),
1308 '--upstream', upstream,
1309 ]
1310
1311 args.extend(['--verbose'] * verbose)
1312
Edward Lesmeseb1bd622021-03-01 19:54:07 +00001313 remote, remote_branch = self.GetRemoteBranch()
1314 target_ref = GetTargetRef(remote, remote_branch, None)
1315 args.extend(['--gerrit_url', self.GetCodereviewServer()])
1316 args.extend(['--gerrit_project', self.GetGerritProject()])
1317 args.extend(['--gerrit_branch', target_ref])
1318
Edward Lemur99df04e2020-03-05 19:39:43 +00001319 author = self.GetAuthor()
Edward Lemur227d5102020-02-25 23:45:35 +00001320 issue = self.GetIssue()
1321 patchset = self.GetPatchset()
Edward Lemur99df04e2020-03-05 19:39:43 +00001322 if author:
1323 args.extend(['--author', author])
Edward Lemur227d5102020-02-25 23:45:35 +00001324 if issue:
1325 args.extend(['--issue', str(issue)])
1326 if patchset:
1327 args.extend(['--patchset', str(patchset)])
Edward Lemur227d5102020-02-25 23:45:35 +00001328
Edward Lemur75526302020-02-27 22:31:05 +00001329 return args
1330
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001331 def RunHook(self, committing, may_prompt, verbose, parallel, upstream,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001332 description, all_files, resultdb=False, realm=None):
Edward Lemur75526302020-02-27 22:31:05 +00001333 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1334 args = self._GetCommonPresubmitArgs(verbose, upstream)
1335 args.append('--commit' if committing else '--upload')
Edward Lemur227d5102020-02-25 23:45:35 +00001336 if may_prompt:
1337 args.append('--may_prompt')
1338 if parallel:
1339 args.append('--parallel')
1340 if all_files:
1341 args.append('--all_files')
1342
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001343 if resultdb and not realm:
1344 # TODO (crbug.com/1113463): store realm somewhere and look it up so
1345 # it is not required to pass the realm flag
1346 print('Note: ResultDB reporting will NOT be performed because --realm'
1347 ' was not specified. To enable ResultDB, please run the command'
1348 ' again with the --realm argument to specify the LUCI realm.')
1349
1350 py2_results = self._RunPresubmit(args, resultdb, realm, description,
1351 use_python3=False)
1352 py3_results = self._RunPresubmit(args, resultdb, realm, description,
1353 use_python3=True)
1354 return self._MergePresubmitResults(py2_results, py3_results)
1355
1356 def _RunPresubmit(self, args, resultdb, realm, description, use_python3):
1357 args = args[:]
1358 vpython = 'vpython3' if use_python3 else 'vpython'
1359
Edward Lemur227d5102020-02-25 23:45:35 +00001360 with gclient_utils.temporary_file() as description_file:
1361 with gclient_utils.temporary_file() as json_output:
Edward Lemur1a83da12020-03-04 21:18:36 +00001362 gclient_utils.FileWrite(description_file, description)
Edward Lemur227d5102020-02-25 23:45:35 +00001363 args.extend(['--json_output', json_output])
1364 args.extend(['--description_file', description_file])
Dirk Pranke6f0df682021-06-25 00:42:33 +00001365 if self.GetUsePython3():
1366 args.append('--use-python3')
Edward Lemur227d5102020-02-25 23:45:35 +00001367 start = time_time()
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001368 cmd = [vpython, PRESUBMIT_SUPPORT] + args
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001369 if resultdb and realm:
1370 cmd = ['rdb', 'stream', '-new', '-realm', realm, '--'] + cmd
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001371
1372 p = subprocess2.Popen(cmd)
Edward Lemur227d5102020-02-25 23:45:35 +00001373 exit_code = p.wait()
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001374
Edward Lemur227d5102020-02-25 23:45:35 +00001375 metrics.collector.add_repeated('sub_commands', {
1376 'command': 'presubmit',
1377 'execution_time': time_time() - start,
1378 'exit_code': exit_code,
1379 })
1380
1381 if exit_code:
1382 sys.exit(exit_code)
1383
1384 json_results = gclient_utils.FileRead(json_output)
1385 return json.loads(json_results)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001386
Dirk Pranke61bf6e82021-04-23 00:50:21 +00001387 def _MergePresubmitResults(self, py2_results, py3_results):
1388 return {
1389 'more_cc': sorted(set(py2_results.get('more_cc', []) +
1390 py3_results.get('more_cc', []))),
1391 'errors': (
1392 py2_results.get('errors', []) + py3_results.get('errors', [])),
1393 'notifications': (
1394 py2_results.get('notifications', []) +
1395 py3_results.get('notifications', [])),
1396 'warnings': (
1397 py2_results.get('warnings', []) + py3_results.get('warnings', []))
1398 }
1399
Edward Lemur75526302020-02-27 22:31:05 +00001400 def RunPostUploadHook(self, verbose, upstream, description):
1401 args = self._GetCommonPresubmitArgs(verbose, upstream)
1402 args.append('--post_upload')
1403
1404 with gclient_utils.temporary_file() as description_file:
Edward Lemur1a83da12020-03-04 21:18:36 +00001405 gclient_utils.FileWrite(description_file, description)
Edward Lemur75526302020-02-27 22:31:05 +00001406 args.extend(['--description_file', description_file])
1407 p = subprocess2.Popen(['vpython', PRESUBMIT_SUPPORT] + args)
1408 p.wait()
1409
Edward Lemur5a644f82020-03-18 16:44:57 +00001410 def _GetDescriptionForUpload(self, options, git_diff_args, files):
1411 # Get description message for upload.
1412 if self.GetIssue():
1413 description = self.FetchDescription()
1414 elif options.message:
1415 description = options.message
1416 else:
1417 description = _create_description_from_log(git_diff_args)
1418 if options.title and options.squash:
Edward Lesmes0dd54822020-03-26 18:24:25 +00001419 description = options.title + '\n\n' + description
Edward Lemur5a644f82020-03-18 16:44:57 +00001420
Edward Lemur5a644f82020-03-18 16:44:57 +00001421 bug = options.bug
1422 fixed = options.fixed
Josip Sokcevic340edc32021-07-08 17:01:46 +00001423 if not self.GetIssue():
1424 # Extract bug number from branch name, but only if issue is being created.
1425 # It must start with bug or fix, followed by _ or - and number.
1426 # Optionally, it may contain _ or - after number with arbitrary text.
1427 # Examples:
1428 # bug-123
1429 # bug_123
1430 # fix-123
1431 # fix-123-some-description
1432 match = re.match(
1433 r'^(?P<type>bug|fix(?:e[sd])?)[_-]?(?P<bugnum>\d+)([-_]|$)',
1434 self.GetBranch())
1435 if not bug and not fixed and match:
1436 if match.group('type') == 'bug':
1437 bug = match.group('bugnum')
1438 else:
1439 fixed = match.group('bugnum')
Edward Lemur5a644f82020-03-18 16:44:57 +00001440
1441 change_description = ChangeDescription(description, bug, fixed)
1442
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001443 # Fill gaps in OWNERS coverage to tbrs/reviewers if requested.
1444 if options.add_owners_to:
1445 assert options.add_owners_to in ('TBR', 'R'), options.add_owners_to
Edward Lesmese1576912021-02-16 21:53:34 +00001446 status = self.owners_client.GetFilesApprovalStatus(
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001447 files, [], options.tbrs + options.reviewers)
1448 missing_files = [
1449 f for f in files
Edward Lesmese1576912021-02-16 21:53:34 +00001450 if status[f] == self._owners_client.INSUFFICIENT_REVIEWERS
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001451 ]
Edward Lesmese1576912021-02-16 21:53:34 +00001452 owners = self.owners_client.SuggestOwners(
1453 missing_files, exclude=[self.GetAuthor()])
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001454 if options.add_owners_to == 'TBR':
1455 assert isinstance(options.tbrs, list), options.tbrs
1456 options.tbrs.extend(owners)
1457 else:
1458 assert isinstance(options.reviewers, list), options.reviewers
1459 options.reviewers.extend(owners)
1460
Edward Lemur5a644f82020-03-18 16:44:57 +00001461 # Set the reviewer list now so that presubmit checks can access it.
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00001462 if options.reviewers or options.tbrs:
1463 change_description.update_reviewers(options.reviewers, options.tbrs)
Edward Lemur5a644f82020-03-18 16:44:57 +00001464
1465 return change_description
1466
1467 def _GetTitleForUpload(self, options):
1468 # When not squashing, just return options.title.
1469 if not options.squash:
1470 return options.title
1471
1472 # On first upload, patchset title is always this string, while options.title
1473 # gets converted to first line of message.
1474 if not self.GetIssue():
1475 return 'Initial upload'
1476
1477 # When uploading subsequent patchsets, options.message is taken as the title
1478 # if options.title is not provided.
1479 if options.title:
1480 return options.title
1481 if options.message:
1482 return options.message.strip()
1483
1484 # Use the subject of the last commit as title by default.
Edward Lesmes50da7702020-03-30 19:23:43 +00001485 title = RunGit(['show', '-s', '--format=%s', 'HEAD']).strip()
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00001486 if options.force or options.skip_title:
Edward Lemur5a644f82020-03-18 16:44:57 +00001487 return title
Edward Lesmesae3586b2020-03-23 21:21:14 +00001488 user_title = gclient_utils.AskForData('Title for patchset [%s]: ' % title)
mlcui3da91712021-05-05 10:00:30 +00001489
1490 # Use the default title if the user confirms the default with a 'y'.
1491 if user_title.lower() == 'y':
1492 return title
Edward Lesmesae3586b2020-03-23 21:21:14 +00001493 return user_title or title
Edward Lemur5a644f82020-03-18 16:44:57 +00001494
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001495 def CMDUpload(self, options, git_diff_args, orig_args):
1496 """Uploads a change to codereview."""
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001497 custom_cl_base = None
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001498 if git_diff_args:
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001499 custom_cl_base = base_branch = git_diff_args[0]
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001500 else:
1501 if self.GetBranch() is None:
1502 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1503
1504 # Default to diffing against common ancestor of upstream branch
1505 base_branch = self.GetCommonAncestorWithUpstream()
1506 git_diff_args = [base_branch, 'HEAD']
1507
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001508 # Fast best-effort checks to abort before running potentially expensive
1509 # hooks if uploading is likely to fail anyway. Passing these checks does
1510 # not guarantee that uploading will not fail.
Edward Lemur125d60a2019-09-13 18:25:41 +00001511 self.EnsureAuthenticated(force=options.force)
1512 self.EnsureCanUploadPatchset(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001513
1514 # Apply watchlists on upload.
Edward Lemur2c62b332020-03-12 22:12:33 +00001515 watchlist = watchlists.Watchlists(settings.GetRoot())
1516 files = self.GetAffectedFiles(base_branch)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001517 if not options.bypass_watchlists:
Daniel Cheng7227d212017-11-17 08:12:37 -08001518 self.ExtendCC(watchlist.GetWatchersForPaths(files))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001519
Edward Lemur5a644f82020-03-18 16:44:57 +00001520 change_desc = self._GetDescriptionForUpload(options, git_diff_args, files)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001521 if not options.bypass_hooks:
Edward Lemur2c62b332020-03-12 22:12:33 +00001522 hook_results = self.RunHook(
1523 committing=False,
1524 may_prompt=not options.force,
1525 verbose=options.verbose,
1526 parallel=options.parallel,
1527 upstream=base_branch,
Edward Lemur5a644f82020-03-18 16:44:57 +00001528 description=change_desc.description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00001529 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00001530 resultdb=options.resultdb,
1531 realm=options.realm)
Edward Lemur227d5102020-02-25 23:45:35 +00001532 self.ExtendCC(hook_results['more_cc'])
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001533
Aaron Gable13101a62018-02-09 13:20:41 -08001534 print_stats(git_diff_args)
Edward Lemura12175c2020-03-09 16:58:26 +00001535 ret = self.CMDUploadChange(
Edward Lemur5a644f82020-03-18 16:44:57 +00001536 options, git_diff_args, custom_cl_base, change_desc)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001537 if not ret:
Edward Lemur85153282020-02-14 22:06:29 +00001538 self._GitSetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001539 'last-upload-hash', scm.GIT.ResolveCommit(settings.GetRoot(), 'HEAD'))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001540 # Run post upload hooks, if specified.
1541 if settings.GetRunPostUploadHook():
Edward Lemur5a644f82020-03-18 16:44:57 +00001542 self.RunPostUploadHook(
1543 options.verbose, base_branch, change_desc.description)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001544
1545 # Upload all dependencies if specified.
1546 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001547 print()
1548 print('--dependencies has been specified.')
1549 print('All dependent local branches will be re-uploaded.')
1550 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001551 # Remove the dependencies flag from args so that we do not end up in a
1552 # loop.
1553 orig_args.remove('--dependencies')
Jose Lopes3863fc52020-04-07 17:00:25 +00001554 ret = upload_branch_deps(self, orig_args, options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001555 return ret
1556
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001557 def SetCQState(self, new_state):
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001558 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001559
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00001560 Issue must have been already uploaded and known. Optionally allows for
1561 updating Quick-Run (QR) state.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001562 """
1563 assert new_state in _CQState.ALL_STATES
1564 assert self.GetIssue()
qyearsley1fdfcb62016-10-24 13:22:03 -07001565 try:
Edward Lemur125d60a2019-09-13 18:25:41 +00001566 vote_map = {
1567 _CQState.NONE: 0,
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00001568 _CQState.QUICK_RUN: 1,
Edward Lemur125d60a2019-09-13 18:25:41 +00001569 _CQState.DRY_RUN: 1,
1570 _CQState.COMMIT: 2,
1571 }
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00001572 if new_state == _CQState.QUICK_RUN:
1573 labels = {
1574 'Commit-Queue': vote_map[_CQState.DRY_RUN],
1575 'Quick-Run': vote_map[_CQState.QUICK_RUN],
1576 }
1577 else:
1578 labels = {'Commit-Queue': vote_map[new_state]}
Edward Lemur125d60a2019-09-13 18:25:41 +00001579 notify = False if new_state == _CQState.DRY_RUN else None
1580 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001581 self.GetGerritHost(), self._GerritChangeIdentifier(),
Edward Lemur125d60a2019-09-13 18:25:41 +00001582 labels=labels, notify=notify)
qyearsley1fdfcb62016-10-24 13:22:03 -07001583 return 0
1584 except KeyboardInterrupt:
1585 raise
1586 except:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001587 print('WARNING: Failed to %s.\n'
qyearsley1fdfcb62016-10-24 13:22:03 -07001588 'Either:\n'
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001589 ' * Your project has no CQ,\n'
1590 ' * You don\'t have permission to change the CQ state,\n'
1591 ' * There\'s a bug in this code (see stack trace below).\n'
1592 'Consider specifying which bots to trigger manually or asking your '
1593 'project owners for permissions or contacting Chrome Infra at:\n'
1594 'https://www.chromium.org/infra\n\n' %
1595 ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ'))
qyearsley1fdfcb62016-10-24 13:22:03 -07001596 # Still raise exception so that stack trace is printed.
1597 raise
1598
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001599 def GetGerritHost(self):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001600 # Lazy load of configs.
1601 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07001602 if self._gerrit_host and '.' not in self._gerrit_host:
1603 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
1604 # This happens for internal stuff http://crbug.com/614312.
Edward Lemur79d4f992019-11-11 23:49:02 +00001605 parsed = urllib.parse.urlparse(self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001606 if parsed.scheme == 'sso':
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001607 print('WARNING: using non-https URLs for remote is likely broken\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001608 ' Your current remote is: %s' % self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001609 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
1610 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001611 return self._gerrit_host
1612
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001613 def _GetGitHost(self):
1614 """Returns git host to be used when uploading change to Gerrit."""
Edward Lemur298f2cf2019-02-22 21:40:39 +00001615 remote_url = self.GetRemoteUrl()
1616 if not remote_url:
1617 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001618 return urllib.parse.urlparse(remote_url).netloc
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001619
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001620 def GetCodereviewServer(self):
1621 if not self._gerrit_server:
1622 # If we're on a branch then get the server potentially associated
1623 # with that branch.
Edward Lemur85153282020-02-14 22:06:29 +00001624 if self.GetIssue() and self.GetBranch():
tandrii5d48c322016-08-18 16:19:37 -07001625 self._gerrit_server = self._GitGetBranchConfigValue(
Edward Lesmes50da7702020-03-30 19:23:43 +00001626 CODEREVIEW_SERVER_CONFIG_KEY)
tandrii5d48c322016-08-18 16:19:37 -07001627 if self._gerrit_server:
Edward Lemur79d4f992019-11-11 23:49:02 +00001628 self._gerrit_host = urllib.parse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001629 if not self._gerrit_server:
1630 # We assume repo to be hosted on Gerrit, and hence Gerrit server
1631 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001632 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001633 parts[0] = parts[0] + '-review'
1634 self._gerrit_host = '.'.join(parts)
1635 self._gerrit_server = 'https://%s' % self._gerrit_host
1636 return self._gerrit_server
1637
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001638 def GetGerritProject(self):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001639 """Returns Gerrit project name based on remote git URL."""
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001640 remote_url = self.GetRemoteUrl()
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001641 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001642 logging.warning('can\'t detect Gerrit project.')
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001643 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001644 project = urllib.parse.urlparse(remote_url).path.strip('/')
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001645 if project.endswith('.git'):
1646 project = project[:-len('.git')]
Andrii Shyshkalov1e828672018-08-23 22:34:37 +00001647 # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with
1648 # 'a/' prefix, because 'a/' prefix is used to force authentication in
1649 # gitiles/git-over-https protocol. E.g.,
1650 # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project
1651 # as
1652 # https://chromium.googlesource.com/v8/v8
1653 if project.startswith('a/'):
1654 project = project[len('a/'):]
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001655 return project
1656
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001657 def _GerritChangeIdentifier(self):
1658 """Handy method for gerrit_util.ChangeIdentifier for a given CL.
1659
1660 Not to be confused by value of "Change-Id:" footer.
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001661 If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC.
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001662 """
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001663 project = self.GetGerritProject()
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001664 if project:
1665 return gerrit_util.ChangeIdentifier(project, self.GetIssue())
1666 # Fall back on still unique, but less efficient change number.
1667 return str(self.GetIssue())
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001668
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001669 def EnsureAuthenticated(self, force, refresh=None):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001670 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00001671 if settings.GetGerritSkipEnsureAuthenticated():
1672 # For projects with unusual authentication schemes.
1673 # See http://crbug.com/603378.
1674 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001675
1676 # Check presence of cookies only if using cookies-based auth method.
1677 cookie_auth = gerrit_util.Authenticator.get()
1678 if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001679 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001680
Florian Mayerae510e82020-01-30 21:04:48 +00001681 remote_url = self.GetRemoteUrl()
1682 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001683 logging.warning('invalid remote')
Florian Mayerae510e82020-01-30 21:04:48 +00001684 return
1685 if urllib.parse.urlparse(remote_url).scheme != 'https':
Josip906bfde2020-01-31 22:38:49 +00001686 logging.warning('Ignoring branch %(branch)s with non-https remote '
1687 '%(remote)s', {
1688 'branch': self.branch,
1689 'remote': self.GetRemoteUrl()
1690 })
Daniel Chengcf6269b2019-05-18 01:02:12 +00001691 return
1692
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001693 # Lazy-loader to identify Gerrit and Git hosts.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001694 self.GetCodereviewServer()
1695 git_host = self._GetGitHost()
Edward Lemur298f2cf2019-02-22 21:40:39 +00001696 assert self._gerrit_server and self._gerrit_host and git_host
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001697
1698 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
1699 git_auth = cookie_auth.get_auth_header(git_host)
1700 if gerrit_auth and git_auth:
1701 if gerrit_auth == git_auth:
1702 return
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001703 all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com')
Raul Tambre80ee78e2019-05-06 22:41:05 +00001704 print(
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001705 'WARNING: You have different credentials for Gerrit and git hosts:\n'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001706 ' %s\n'
1707 ' %s\n'
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001708 ' Consider running the following command:\n'
1709 ' git cl creds-check\n'
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001710 ' %s\n'
Raul Tambre80ee78e2019-05-06 22:41:05 +00001711 ' %s' %
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001712 (git_host, self._gerrit_host,
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001713 ('Hint: delete creds for .googlesource.com' if all_gsrc else ''),
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001714 cookie_auth.get_new_password_message(git_host)))
1715 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001716 confirm_or_exit('If you know what you are doing', action='continue')
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001717 return
1718 else:
1719 missing = (
Anna Henningsen4e891442017-07-06 21:40:58 +02001720 ([] if gerrit_auth else [self._gerrit_host]) +
1721 ([] if git_auth else [git_host]))
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001722 DieWithError('Credentials for the following hosts are required:\n'
1723 ' %s\n'
1724 'These are read from %s (or legacy %s)\n'
1725 '%s' % (
1726 '\n '.join(missing),
1727 cookie_auth.get_gitcookies_path(),
1728 cookie_auth.get_netrc_path(),
1729 cookie_auth.get_new_password_message(git_host)))
1730
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001731 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001732 if not self.GetIssue():
1733 return
1734
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001735 status = self._GetChangeDetail()['status']
1736 if status in ('MERGED', 'ABANDONED'):
1737 DieWithError('Change %s has been %s, new uploads are not allowed' %
1738 (self.GetIssueURL(),
1739 'submitted' if status == 'MERGED' else 'abandoned'))
1740
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001741 # TODO(vadimsh): For some reason the chunk of code below was skipped if
1742 # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'.
1743 # Apparently this check is not very important? Otherwise get_auth_email
1744 # could have been added to other implementations of Authenticator.
1745 cookies_auth = gerrit_util.Authenticator.get()
1746 if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator):
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001747 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001748
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001749 cookies_user = cookies_auth.get_auth_email(self.GetGerritHost())
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001750 if self.GetIssueOwner() == cookies_user:
1751 return
1752 logging.debug('change %s owner is %s, cookies user is %s',
1753 self.GetIssue(), self.GetIssueOwner(), cookies_user)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001754 # Maybe user has linked accounts or something like that,
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001755 # so ask what Gerrit thinks of this user.
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001756 details = gerrit_util.GetAccountDetails(self.GetGerritHost(), 'self')
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001757 if details['email'] == self.GetIssueOwner():
1758 return
1759 if not force:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001760 print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit '
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001761 'as %s.\n'
1762 'Uploading may fail due to lack of permissions.' %
1763 (self.GetIssue(), self.GetIssueOwner(), details['email']))
1764 confirm_or_exit(action='upload')
1765
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001766 def GetStatus(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001767 """Applies a rough heuristic to give a simple summary of an issue's review
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001768 or CQ status, assuming adherence to a common workflow.
1769
1770 Returns None if no issue for this branch, or one of the following keywords:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001771 * 'error' - error from review tool (including deleted issues)
1772 * 'unsent' - no reviewers added
1773 * 'waiting' - waiting for review
1774 * 'reply' - waiting for uploader to reply to review
1775 * 'lgtm' - Code-Review label has been set
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001776 * 'dry-run' - dry-running in the CQ
1777 * 'commit' - in the CQ
Aaron Gable9ab38c62017-04-06 14:36:33 -07001778 * 'closed' - successfully submitted or abandoned
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001779 """
1780 if not self.GetIssue():
1781 return None
1782
1783 try:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001784 data = self._GetChangeDetail([
1785 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE'])
Edward Lemur79d4f992019-11-11 23:49:02 +00001786 except GerritChangeNotExists:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001787 return 'error'
1788
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00001789 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001790 return 'closed'
1791
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001792 cq_label = data['labels'].get('Commit-Queue', {})
1793 max_cq_vote = 0
1794 for vote in cq_label.get('all', []):
1795 max_cq_vote = max(max_cq_vote, vote.get('value', 0))
1796 if max_cq_vote == 2:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001797 return 'commit'
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001798 if max_cq_vote == 1:
1799 return 'dry-run'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001800
Aaron Gable9ab38c62017-04-06 14:36:33 -07001801 if data['labels'].get('Code-Review', {}).get('approved'):
1802 return 'lgtm'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001803
1804 if not data.get('reviewers', {}).get('REVIEWER', []):
1805 return 'unsent'
1806
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001807 owner = data['owner'].get('_account_id')
Edward Lemur79d4f992019-11-11 23:49:02 +00001808 messages = sorted(data.get('messages', []), key=lambda m: m.get('date'))
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001809 while messages:
1810 m = messages.pop()
Andrii Shyshkalov899785a2021-07-09 12:45:37 +00001811 if (m.get('tag', '').startswith('autogenerated:cq') or
1812 m.get('tag', '').startswith('autogenerated:cv')):
1813 # Ignore replies from LUCI CV/CQ.
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001814 continue
Andrii Shyshkalov8aa9d622020-03-10 19:15:35 +00001815 if m.get('author', {}).get('_account_id') == owner:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001816 # Most recent message was by owner.
1817 return 'waiting'
1818 else:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001819 # Some reply from non-owner.
1820 return 'reply'
Aaron Gable9ab38c62017-04-06 14:36:33 -07001821
1822 # Somehow there are no messages even though there are reviewers.
1823 return 'unsent'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001824
1825 def GetMostRecentPatchset(self):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001826 if not self.GetIssue():
1827 return None
1828
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001829 data = self._GetChangeDetail(['CURRENT_REVISION'])
Aaron Gablee8856ee2017-12-07 12:41:46 -08001830 patchset = data['revisions'][data['current_revision']]['_number']
1831 self.SetPatchset(patchset)
1832 return patchset
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001833
Gavin Make61ccc52020-11-13 00:12:57 +00001834 def GetMostRecentDryRunPatchset(self):
1835 """Get patchsets equivalent to the most recent patchset and return
1836 the patchset with the latest dry run. If none have been dry run, return
1837 the latest patchset."""
1838 if not self.GetIssue():
1839 return None
1840
1841 data = self._GetChangeDetail(['ALL_REVISIONS'])
1842 patchset = data['revisions'][data['current_revision']]['_number']
1843 dry_run = set([int(m['_revision_number'])
1844 for m in data.get('messages', [])
1845 if m.get('tag', '').endswith('dry-run')])
1846
1847 for revision_info in sorted(data.get('revisions', {}).values(),
1848 key=lambda c: c['_number'], reverse=True):
1849 if revision_info['_number'] in dry_run:
1850 patchset = revision_info['_number']
1851 break
1852 if revision_info.get('kind', '') not in \
1853 ('NO_CHANGE', 'NO_CODE_CHANGE', 'TRIVIAL_REBASE'):
1854 break
1855 self.SetPatchset(patchset)
1856 return patchset
1857
Aaron Gable636b13f2017-07-14 10:42:48 -07001858 def AddComment(self, message, publish=None):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001859 gerrit_util.SetReview(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001860 self.GetGerritHost(), self._GerritChangeIdentifier(),
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001861 msg=message, ready=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001862
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001863 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalov5a0cf202017-03-17 16:14:59 +01001864 # DETAILED_ACCOUNTS is to get emails in accounts.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001865 # CURRENT_REVISION is included to get the latest patchset so that
1866 # only the robot comments from the latest patchset can be shown.
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001867 messages = self._GetChangeDetail(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001868 options=['MESSAGES', 'DETAILED_ACCOUNTS',
1869 'CURRENT_REVISION']).get('messages', [])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001870 file_comments = gerrit_util.GetChangeComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001871 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001872 robot_file_comments = gerrit_util.GetChangeRobotComments(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001873 self.GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001874
1875 # Add the robot comments onto the list of comments, but only
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +00001876 # keep those that are from the latest patchset.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001877 latest_patch_set = self.GetMostRecentPatchset()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001878 for path, robot_comments in robot_file_comments.items():
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001879 line_comments = file_comments.setdefault(path, [])
1880 line_comments.extend(
1881 [c for c in robot_comments if c['patch_set'] == latest_patch_set])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001882
1883 # Build dictionary of file comments for easy access and sorting later.
1884 # {author+date: {path: {patchset: {line: url+message}}}}
1885 comments = collections.defaultdict(
1886 lambda: collections.defaultdict(lambda: collections.defaultdict(dict)))
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001887
1888 server = self.GetCodereviewServer()
1889 if server in _KNOWN_GERRIT_TO_SHORT_URLS:
1890 # /c/ is automatically added by short URL server.
1891 url_prefix = '%s/%s' % (_KNOWN_GERRIT_TO_SHORT_URLS[server],
1892 self.GetIssue())
1893 else:
1894 url_prefix = '%s/c/%s' % (server, self.GetIssue())
1895
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001896 for path, line_comments in file_comments.items():
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001897 for comment in line_comments:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001898 tag = comment.get('tag', '')
1899 if tag.startswith('autogenerated') and 'robot_id' not in comment:
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001900 continue
1901 key = (comment['author']['email'], comment['updated'])
1902 if comment.get('side', 'REVISION') == 'PARENT':
1903 patchset = 'Base'
1904 else:
1905 patchset = 'PS%d' % comment['patch_set']
1906 line = comment.get('line', 0)
Andrii Shyshkalova3762a92020-11-25 10:20:42 +00001907 url = ('%s/%s/%s#%s%s' %
1908 (url_prefix, comment['patch_set'], path,
1909 'b' if comment.get('side') == 'PARENT' else '',
1910 str(line) if line else ''))
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001911 comments[key][path][patchset][line] = (url, comment['message'])
1912
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001913 summaries = []
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001914 for msg in messages:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001915 summary = self._BuildCommentSummary(msg, comments, readable)
1916 if summary:
1917 summaries.append(summary)
1918 return summaries
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001919
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001920 @staticmethod
1921 def _BuildCommentSummary(msg, comments, readable):
Josip Sokcevic266129c2021-11-09 00:22:00 +00001922 if 'email' not in msg['author']:
1923 # Some bot accounts may not have an email associated.
1924 return None
1925
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001926 key = (msg['author']['email'], msg['date'])
1927 # Don't bother showing autogenerated messages that don't have associated
1928 # file or line comments. this will filter out most autogenerated
1929 # messages, but will keep robot comments like those from Tricium.
1930 is_autogenerated = msg.get('tag', '').startswith('autogenerated')
1931 if is_autogenerated and not comments.get(key):
1932 return None
1933 message = msg['message']
1934 # Gerrit spits out nanoseconds.
1935 assert len(msg['date'].split('.')[-1]) == 9
1936 date = datetime.datetime.strptime(msg['date'][:-3],
1937 '%Y-%m-%d %H:%M:%S.%f')
1938 if key in comments:
1939 message += '\n'
1940 for path, patchsets in sorted(comments.get(key, {}).items()):
1941 if readable:
1942 message += '\n%s' % path
1943 for patchset, lines in sorted(patchsets.items()):
1944 for line, (url, content) in sorted(lines.items()):
1945 if line:
1946 line_str = 'Line %d' % line
1947 path_str = '%s:%d:' % (path, line)
1948 else:
1949 line_str = 'File comment'
1950 path_str = '%s:0:' % path
1951 if readable:
1952 message += '\n %s, %s: %s' % (patchset, line_str, url)
1953 message += '\n %s\n' % content
1954 else:
1955 message += '\n%s ' % path_str
1956 message += '\n%s\n' % content
1957
1958 return _CommentSummary(
1959 date=date,
1960 message=message,
1961 sender=msg['author']['email'],
1962 autogenerated=is_autogenerated,
1963 # These could be inferred from the text messages and correlated with
1964 # Code-Review label maximum, however this is not reliable.
1965 # Leaving as is until the need arises.
1966 approval=False,
1967 disapproval=False,
1968 )
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001969
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001970 def CloseIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001971 gerrit_util.AbandonChange(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00001972 self.GetGerritHost(), self._GerritChangeIdentifier(), msg='')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001973
Xinan Lin1bd4ffa2021-07-28 00:54:22 +00001974 def SubmitIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001975 gerrit_util.SubmitChange(
Xinan Lin1bd4ffa2021-07-28 00:54:22 +00001976 self.GetGerritHost(), self._GerritChangeIdentifier())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001977
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001978 def _GetChangeDetail(self, options=None):
1979 """Returns details of associated Gerrit change and caching results."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00001980 options = options or []
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001981 assert self.GetIssue(), 'issue is required to query Gerrit'
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001982
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001983 # Optimization to avoid multiple RPCs:
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001984 if 'CURRENT_REVISION' in options or 'ALL_REVISIONS' in options:
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001985 options.append('CURRENT_COMMIT')
1986
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001987 # Normalize issue and options for consistent keys in cache.
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001988 cache_key = str(self.GetIssue())
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001989 options_set = frozenset(o.upper() for o in options)
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001990
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001991 for cached_options_set, data in self._detail_cache.get(cache_key, []):
1992 # Assumption: data fetched before with extra options is suitable
1993 # for return for a smaller set of options.
1994 # For example, if we cached data for
1995 # options=[CURRENT_REVISION, DETAILED_FOOTERS]
1996 # and request is for options=[CURRENT_REVISION],
1997 # THEN we can return prior cached data.
1998 if options_set.issubset(cached_options_set):
1999 return data
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002000
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002001 try:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002002 data = gerrit_util.GetChangeDetail(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002003 self.GetGerritHost(), self._GerritChangeIdentifier(), options_set)
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002004 except gerrit_util.GerritError as e:
2005 if e.http_status == 404:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002006 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002007 raise
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002008
Edward Lesmes7677e5c2020-02-19 20:39:03 +00002009 self._detail_cache.setdefault(cache_key, []).append((options_set, data))
tandriic2405f52016-10-10 08:13:15 -07002010 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002011
Andrii Shyshkalovcc5f17e2018-08-22 23:35:59 +00002012 def _GetChangeCommit(self):
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002013 assert self.GetIssue(), 'issue must be set to query Gerrit'
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002014 try:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002015 data = gerrit_util.GetChangeCommit(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002016 self.GetGerritHost(), self._GerritChangeIdentifier())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002017 except gerrit_util.GerritError as e:
2018 if e.http_status == 404:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002019 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002020 raise
agable32978d92016-11-01 12:55:02 -07002021 return data
2022
Karen Qian40c19422019-03-13 21:28:29 +00002023 def _IsCqConfigured(self):
2024 detail = self._GetChangeDetail(['LABELS'])
Andrii Shyshkalov8effa4d2020-01-21 13:23:36 +00002025 return u'Commit-Queue' in detail.get('labels', {})
Karen Qian40c19422019-03-13 21:28:29 +00002026
Saagar Sanghavi03b15132020-08-10 16:43:41 +00002027 def CMDLand(self, force, bypass_hooks, verbose, parallel, resultdb, realm):
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002028 if git_common.is_dirty_git_tree('land'):
2029 return 1
Karen Qian40c19422019-03-13 21:28:29 +00002030
tandriid60367b2016-06-22 05:25:12 -07002031 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
Karen Qian40c19422019-03-13 21:28:29 +00002032 if not force and self._IsCqConfigured():
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00002033 confirm_or_exit('\nIt seems this repository has a CQ, '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002034 'which can test and land changes for you. '
2035 'Are you sure you wish to bypass it?\n',
2036 action='bypass CQ')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002037 differs = True
tandriic4344b52016-08-29 06:04:54 -07002038 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002039 # Note: git diff outputs nothing if there is no diff.
2040 if not last_upload or RunGit(['diff', last_upload]).strip():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002041 print('WARNING: Some changes from local branch haven\'t been uploaded.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002042 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002043 if detail['current_revision'] == last_upload:
2044 differs = False
2045 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002046 print('WARNING: Local branch contents differ from latest uploaded '
2047 'patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002048 if differs:
2049 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002050 confirm_or_exit(
2051 'Do you want to submit latest Gerrit patchset and bypass hooks?\n',
2052 action='submit')
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002053 print('WARNING: Bypassing hooks and submitting latest uploaded patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002054 elif not bypass_hooks:
Edward Lemur227d5102020-02-25 23:45:35 +00002055 upstream = self.GetCommonAncestorWithUpstream()
2056 if self.GetIssue():
2057 description = self.FetchDescription()
2058 else:
Edward Lemura12175c2020-03-09 16:58:26 +00002059 description = _create_description_from_log([upstream])
Edward Lemur227d5102020-02-25 23:45:35 +00002060 self.RunHook(
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002061 committing=True,
2062 may_prompt=not force,
2063 verbose=verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00002064 parallel=parallel,
2065 upstream=upstream,
2066 description=description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00002067 all_files=False,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00002068 resultdb=resultdb,
2069 realm=realm)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002070
Xinan Lin1bd4ffa2021-07-28 00:54:22 +00002071 self.SubmitIssue()
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002072 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002073 links = self._GetChangeCommit().get('web_links', [])
2074 for link in links:
Michael Mosse371c642021-09-29 16:41:04 +00002075 if link.get('name') in ['gitiles', 'browse'] and link.get('url'):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002076 print('Landed as: %s' % link.get('url'))
agable32978d92016-11-01 12:55:02 -07002077 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002078 return 0
2079
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002080 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force,
2081 newbranch):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002082 assert parsed_issue_arg.valid
2083
Edward Lemur125d60a2019-09-13 18:25:41 +00002084 self.issue = parsed_issue_arg.issue
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002085
2086 if parsed_issue_arg.hostname:
2087 self._gerrit_host = parsed_issue_arg.hostname
2088 self._gerrit_server = 'https://%s' % self._gerrit_host
2089
tandriic2405f52016-10-10 08:13:15 -07002090 try:
2091 detail = self._GetChangeDetail(['ALL_REVISIONS'])
Aaron Gablea45ee112016-11-22 15:14:38 -08002092 except GerritChangeNotExists as e:
tandriic2405f52016-10-10 08:13:15 -07002093 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002094
2095 if not parsed_issue_arg.patchset:
2096 # Use current revision by default.
2097 revision_info = detail['revisions'][detail['current_revision']]
2098 patchset = int(revision_info['_number'])
2099 else:
2100 patchset = parsed_issue_arg.patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002101 for revision_info in detail['revisions'].values():
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002102 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2103 break
2104 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002105 DieWithError('Couldn\'t find patchset %i in change %i' %
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002106 (parsed_issue_arg.patchset, self.GetIssue()))
2107
Edward Lemur125d60a2019-09-13 18:25:41 +00002108 remote_url = self.GetRemoteUrl()
Aaron Gable697a91b2018-01-19 15:20:15 -08002109 if remote_url.endswith('.git'):
2110 remote_url = remote_url[:-len('.git')]
erikchen0d14d0d2018-08-28 18:57:09 +00002111 remote_url = remote_url.rstrip('/')
2112
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002113 fetch_info = revision_info['fetch']['http']
erikchen0d14d0d2018-08-28 18:57:09 +00002114 fetch_info['url'] = fetch_info['url'].rstrip('/')
Aaron Gable697a91b2018-01-19 15:20:15 -08002115
2116 if remote_url != fetch_info['url']:
2117 DieWithError('Trying to patch a change from %s but this repo appears '
2118 'to be %s.' % (fetch_info['url'], remote_url))
2119
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002120 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
Aaron Gable9387b4f2017-06-08 10:50:03 -07002121
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00002122 # If we have created a new branch then do the "set issue" immediately in
2123 # case the cherry-pick fails, which happens when resolving conflicts.
2124 if newbranch:
2125 self.SetIssue(parsed_issue_arg.issue)
2126
Aaron Gable62619a32017-06-16 08:22:09 -07002127 if force:
2128 RunGit(['reset', '--hard', 'FETCH_HEAD'])
2129 print('Checked out commit for change %i patchset %i locally' %
2130 (parsed_issue_arg.issue, patchset))
Stefan Zager2d5f0392017-10-10 15:17:53 -07002131 elif nocommit:
2132 RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD'])
2133 print('Patch applied to index.')
Aaron Gable62619a32017-06-16 08:22:09 -07002134 else:
Aaron Gable9387b4f2017-06-08 10:50:03 -07002135 RunGit(['cherry-pick', 'FETCH_HEAD'])
2136 print('Committed patch for change %i patchset %i locally.' %
Aaron Gable62619a32017-06-16 08:22:09 -07002137 (parsed_issue_arg.issue, patchset))
2138 print('Note: this created a local commit which does not have '
2139 'the same hash as the one uploaded for review. This will make '
2140 'uploading changes based on top of this branch difficult.\n'
2141 'If you want to do that, use "git cl patch --force" instead.')
2142
Stefan Zagerd08043c2017-10-12 12:07:02 -07002143 if self.GetBranch():
2144 self.SetIssue(parsed_issue_arg.issue)
2145 self.SetPatchset(patchset)
Edward Lesmes50da7702020-03-30 19:23:43 +00002146 fetched_hash = scm.GIT.ResolveCommit(settings.GetRoot(), 'FETCH_HEAD')
Stefan Zagerd08043c2017-10-12 12:07:02 -07002147 self._GitSetBranchConfigValue('last-upload-hash', fetched_hash)
2148 self._GitSetBranchConfigValue('gerritsquashhash', fetched_hash)
2149 else:
2150 print('WARNING: You are in detached HEAD state.\n'
2151 'The patch has been applied to your checkout, but you will not be '
2152 'able to upload a new patch set to the gerrit issue.\n'
2153 'Try using the \'-b\' option if you would like to work on a '
2154 'branch and/or upload a new patch set.')
2155
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002156 return 0
2157
tandrii16e0b4e2016-06-07 10:34:28 -07002158 def _GerritCommitMsgHookCheck(self, offer_removal):
2159 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2160 if not os.path.exists(hook):
2161 return
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002162 # Crude attempt to distinguish Gerrit Codereview hook from a potentially
2163 # custom developer-made one.
tandrii16e0b4e2016-06-07 10:34:28 -07002164 data = gclient_utils.FileRead(hook)
2165 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2166 return
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002167 print('WARNING: You have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002168 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002169 'and may interfere with it in subtle ways.\n'
2170 'We recommend you remove the commit-msg hook.')
2171 if offer_removal:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002172 if ask_for_explicit_yes('Do you want to remove it now?'):
tandrii16e0b4e2016-06-07 10:34:28 -07002173 gclient_utils.rm_file_or_tree(hook)
2174 print('Gerrit commit-msg hook removed.')
2175 else:
2176 print('OK, will keep Gerrit commit-msg hook in place.')
2177
Edward Lemur1b52d872019-05-09 21:12:12 +00002178 def _CleanUpOldTraces(self):
2179 """Keep only the last |MAX_TRACES| traces."""
2180 try:
2181 traces = sorted([
2182 os.path.join(TRACES_DIR, f)
2183 for f in os.listdir(TRACES_DIR)
2184 if (os.path.isfile(os.path.join(TRACES_DIR, f))
2185 and not f.startswith('tmp'))
2186 ])
2187 traces_to_delete = traces[:-MAX_TRACES]
2188 for trace in traces_to_delete:
Daniel Chengcf6269b2019-05-18 01:02:12 +00002189 os.remove(trace)
Edward Lemur1b52d872019-05-09 21:12:12 +00002190 except OSError:
2191 print('WARNING: Failed to remove old git traces from\n'
2192 ' %s'
2193 'Consider removing them manually.' % TRACES_DIR)
Edward Lemurdc8e23d2019-05-07 00:45:48 +00002194
Edward Lemur5737f022019-05-17 01:24:00 +00002195 def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002196 """Zip and write the git push traces stored in traces_dir."""
2197 gclient_utils.safe_makedirs(TRACES_DIR)
Edward Lemur1b52d872019-05-09 21:12:12 +00002198 traces_zip = trace_name + '-traces'
2199 traces_readme = trace_name + '-README'
Michael Mosse7f0b4c2019-05-08 04:36:24 +00002200 # Create a temporary dir to store git config and gitcookies in. It will be
2201 # compressed and stored next to the traces.
2202 git_info_dir = tempfile.mkdtemp()
Edward Lemur1b52d872019-05-09 21:12:12 +00002203 git_info_zip = trace_name + '-git-info'
2204
Josip Sokcevic5e18b602020-04-23 21:47:00 +00002205 git_push_metadata['now'] = datetime_now().strftime('%Y-%m-%dT%H:%M:%S.%f')
sangwoo.ko7a614332019-05-22 02:46:19 +00002206
Edward Lemur1b52d872019-05-09 21:12:12 +00002207 git_push_metadata['trace_name'] = trace_name
2208 gclient_utils.FileWrite(
2209 traces_readme, TRACES_README_FORMAT % git_push_metadata)
2210
2211 # Keep only the first 6 characters of the git hashes on the packet
2212 # trace. This greatly decreases size after compression.
2213 packet_traces = os.path.join(traces_dir, 'trace-packet')
2214 if os.path.isfile(packet_traces):
2215 contents = gclient_utils.FileRead(packet_traces)
2216 gclient_utils.FileWrite(
2217 packet_traces, GIT_HASH_RE.sub(r'\1', contents))
2218 shutil.make_archive(traces_zip, 'zip', traces_dir)
2219
2220 # Collect and compress the git config and gitcookies.
2221 git_config = RunGit(['config', '-l'])
2222 gclient_utils.FileWrite(
2223 os.path.join(git_info_dir, 'git-config'),
2224 git_config)
2225
2226 cookie_auth = gerrit_util.Authenticator.get()
2227 if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
2228 gitcookies_path = cookie_auth.get_gitcookies_path()
2229 if os.path.isfile(gitcookies_path):
2230 gitcookies = gclient_utils.FileRead(gitcookies_path)
2231 gclient_utils.FileWrite(
2232 os.path.join(git_info_dir, 'gitcookies'),
2233 GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies))
2234 shutil.make_archive(git_info_zip, 'zip', git_info_dir)
2235
Edward Lemur1b52d872019-05-09 21:12:12 +00002236 gclient_utils.rmtree(git_info_dir)
2237
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002238 def _RunGitPushWithTraces(self,
2239 refspec,
2240 refspec_opts,
2241 git_push_metadata,
2242 git_push_options=None):
Edward Lemur1b52d872019-05-09 21:12:12 +00002243 """Run git push and collect the traces resulting from the execution."""
2244 # Create a temporary directory to store traces in. Traces will be compressed
2245 # and stored in a 'traces' dir inside depot_tools.
2246 traces_dir = tempfile.mkdtemp()
Edward Lemur5737f022019-05-17 01:24:00 +00002247 trace_name = os.path.join(
2248 TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f'))
Edward Lemur0f58ae42019-04-30 17:24:12 +00002249
2250 env = os.environ.copy()
2251 env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy'
2252 env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Jonathan Nieder9779b142019-05-29 23:19:29 +00002253 env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002254 env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl')
2255 env['GIT_TRACE_CURL_NO_DATA'] = '1'
2256 env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet')
2257
2258 try:
2259 push_returncode = 0
Edward Lemur1b52d872019-05-09 21:12:12 +00002260 remote_url = self.GetRemoteUrl()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002261 before_push = time_time()
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002262 push_cmd = ['git', 'push', remote_url, refspec]
2263 if git_push_options:
2264 for opt in git_push_options:
2265 push_cmd.extend(['-o', opt])
2266
Edward Lemur0f58ae42019-04-30 17:24:12 +00002267 push_stdout = gclient_utils.CheckCallAndFilter(
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002268 push_cmd,
Edward Lemur0f58ae42019-04-30 17:24:12 +00002269 env=env,
2270 print_stdout=True,
2271 # Flush after every line: useful for seeing progress when running as
2272 # recipe.
2273 filter_fn=lambda _: sys.stdout.flush())
Edward Lemur79d4f992019-11-11 23:49:02 +00002274 push_stdout = push_stdout.decode('utf-8', 'replace')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002275 except subprocess2.CalledProcessError as e:
2276 push_returncode = e.returncode
Josip Sokcevic740825e2021-05-12 18:28:34 +00002277 if 'blocked keyword' in str(e.stdout):
2278 raise GitPushError(
2279 'Failed to create a change, very likely due to blocked keyword. '
2280 'Please examine output above for the reason of the failure.\n'
2281 'If this is a false positive, you can try to bypass blocked '
2282 'keyword by using push option '
2283 '-o uploadvalidator~skip, e.g.:\n'
2284 'git cl upload -o uploadvalidator~skip\n\n'
2285 'If git-cl is not working correctly, file a bug under the '
2286 'Infra>SDK component.')
2287
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002288 raise GitPushError(
2289 'Failed to create a change. Please examine output above for the '
2290 'reason of the failure.\n'
Josip Sokcevic7386a1e2021-02-12 19:00:34 +00002291 'For emergencies, Googlers can escalate to '
2292 'go/gob-support or go/notify#gob\n'
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002293 'Hint: run command below to diagnose common Git/Gerrit '
2294 'credential problems:\n'
2295 ' git cl creds-check\n'
2296 '\n'
2297 'If git-cl is not working correctly, file a bug under the Infra>SDK '
2298 'component including the files below.\n'
2299 'Review the files before upload, since they might contain sensitive '
2300 'information.\n'
2301 'Set the Restrict-View-Google label so that they are not publicly '
2302 'accessible.\n' + TRACES_MESSAGE % {'trace_name': trace_name})
Edward Lemur0f58ae42019-04-30 17:24:12 +00002303 finally:
2304 execution_time = time_time() - before_push
2305 metrics.collector.add_repeated('sub_commands', {
2306 'command': 'git push',
2307 'execution_time': execution_time,
2308 'exit_code': push_returncode,
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002309 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts),
Edward Lemur0f58ae42019-04-30 17:24:12 +00002310 })
2311
Edward Lemur1b52d872019-05-09 21:12:12 +00002312 git_push_metadata['execution_time'] = execution_time
2313 git_push_metadata['exit_code'] = push_returncode
Edward Lemur5737f022019-05-17 01:24:00 +00002314 self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata)
Edward Lemur0f58ae42019-04-30 17:24:12 +00002315
Edward Lemur1b52d872019-05-09 21:12:12 +00002316 self._CleanUpOldTraces()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002317 gclient_utils.rmtree(traces_dir)
2318
2319 return push_stdout
2320
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002321 def CMDUploadChange(self, options, git_diff_args, custom_cl_base,
2322 change_desc):
2323 """Upload the current branch to Gerrit, retry if new remote HEAD is
2324 found. options and change_desc may be mutated."""
Josip Sokcevicb631a882021-01-06 18:18:10 +00002325 remote, remote_branch = self.GetRemoteBranch()
2326 branch = GetTargetRef(remote, remote_branch, options.target_branch)
2327
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002328 try:
2329 return self._CMDUploadChange(options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002330 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002331 except GitPushError as e:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002332 # Repository might be in the middle of transition to main branch as
2333 # default, and uploads to old default might be blocked.
2334 if remote_branch not in [DEFAULT_OLD_BRANCH, DEFAULT_NEW_BRANCH]:
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002335 DieWithError(str(e), change_desc)
2336
Josip Sokcevicb631a882021-01-06 18:18:10 +00002337 project_head = gerrit_util.GetProjectHead(self._gerrit_host,
2338 self.GetGerritProject())
2339 if project_head == branch:
2340 DieWithError(str(e), change_desc)
2341 branch = project_head
2342
2343 print("WARNING: Fetching remote state and retrying upload to default "
2344 "branch...")
2345 RunGit(['fetch', '--prune', remote])
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002346 options.edit_description = False
2347 options.force = True
2348 try:
Josip Sokcevicb631a882021-01-06 18:18:10 +00002349 self._CMDUploadChange(options, git_diff_args, custom_cl_base,
2350 change_desc, branch)
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002351 except GitPushError as e:
2352 DieWithError(str(e), change_desc)
2353
2354 def _CMDUploadChange(self, options, git_diff_args, custom_cl_base,
Josip Sokcevicb631a882021-01-06 18:18:10 +00002355 change_desc, branch):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002356 """Upload the current branch to Gerrit."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002357 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002358 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002359 if self.GetIssue():
Josipe827b0f2020-01-30 00:07:20 +00002360 # User requested to change description
2361 if options.edit_description:
Josipe827b0f2020-01-30 00:07:20 +00002362 change_desc.prompt()
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002363 change_id = self._GetChangeDetail()['change_id']
Edward Lemur5a644f82020-03-18 16:44:57 +00002364 change_desc.ensure_change_id(change_id)
Aaron Gableb56ad332017-01-06 15:24:31 -08002365 else: # if not self.GetIssue()
Gavin Mak68e6cf32021-01-25 18:24:08 +00002366 if not options.force and not options.message_file:
Anthony Polito8b955342019-09-24 19:01:36 +00002367 change_desc.prompt()
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002368 change_ids = git_footers.get_footer_change_id(change_desc.description)
Edward Lemur5a644f82020-03-18 16:44:57 +00002369 if len(change_ids) == 1:
2370 change_id = change_ids[0]
2371 else:
2372 change_id = GenerateGerritChangeId(change_desc.description)
2373 change_desc.ensure_change_id(change_id)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002374
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002375 if options.preserve_tryjobs:
2376 change_desc.set_preserve_tryjobs()
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002377
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002378 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Edward Lemur5a644f82020-03-18 16:44:57 +00002379 parent = self._ComputeParent(
2380 remote, upstream_branch, custom_cl_base, options.force, change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002381 tree = RunGit(['rev-parse', 'HEAD:']).strip()
Edward Lemur1773f372020-02-22 00:27:14 +00002382 with gclient_utils.temporary_file() as desc_tempfile:
2383 gclient_utils.FileWrite(desc_tempfile, change_desc.description)
2384 ref_to_push = RunGit(
2385 ['commit-tree', tree, '-p', parent, '-F', desc_tempfile]).strip()
Anthony Polito8b955342019-09-24 19:01:36 +00002386 else: # if not options.squash
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00002387 if options.no_add_changeid:
2388 pass
2389 else: # adding Change-Ids is okay.
2390 if not git_footers.get_footer_change_id(change_desc.description):
2391 DownloadGerritHook(False)
2392 change_desc.set_description(
2393 self._AddChangeIdToCommitMessage(change_desc.description,
2394 git_diff_args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002395 ref_to_push = 'HEAD'
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002396 # For no-squash mode, we assume the remote called "origin" is the one we
2397 # want. It is not worthwhile to support different workflows for
2398 # no-squash mode.
2399 parent = 'origin/%s' % branch
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00002400 # attempt to extract the changeid from the current description
2401 # fail informatively if not possible.
2402 change_id_candidates = git_footers.get_footer_change_id(
2403 change_desc.description)
2404 if not change_id_candidates:
2405 DieWithError("Unable to extract change-id from message.")
2406 change_id = change_id_candidates[0]
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002407
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +00002408 SaveDescriptionBackup(change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002409 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2410 ref_to_push)]).splitlines()
2411 if len(commits) > 1:
2412 print('WARNING: This will upload %d commits. Run the following command '
2413 'to see which commits will be uploaded: ' % len(commits))
2414 print('git log %s..%s' % (parent, ref_to_push))
2415 print('You can also use `git squash-branch` to squash these into a '
2416 'single commit.')
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002417 confirm_or_exit(action='upload')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002418
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002419 reviewers = sorted(change_desc.get_reviewers())
Edward Lemur4508b422019-10-03 21:56:35 +00002420 cc = []
2421 # Add CCs from WATCHLISTS and rietveld.cc git config unless this is
2422 # the initial upload, the CL is private, or auto-CCing has ben disabled.
2423 if not (self.GetIssue() or options.private or options.no_autocc):
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002424 cc = self.GetCCList().split(',')
Gavin Makb1c08f62021-04-01 18:05:58 +00002425 if len(cc) > 100:
2426 lsc = ('https://chromium.googlesource.com/chromium/src/+/HEAD/docs/'
2427 'process/lsc/lsc_workflow.md')
2428 print('WARNING: This will auto-CC %s users.' % len(cc))
2429 print('LSC may be more appropriate: %s' % lsc)
2430 print('You can also use the --no-autocc flag to disable auto-CC.')
2431 confirm_or_exit(action='continue')
Edward Lemur4508b422019-10-03 21:56:35 +00002432 # Add cc's from the --cc flag.
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002433 if options.cc:
2434 cc.extend(options.cc)
Edward Lemur79d4f992019-11-11 23:49:02 +00002435 cc = [email.strip() for email in cc if email.strip()]
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002436 if change_desc.get_cced():
2437 cc.extend(change_desc.get_cced())
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002438 if self.GetGerritHost() == 'chromium-review.googlesource.com':
Andrii Shyshkalov0da5e8f2018-10-30 17:29:18 +00002439 valid_accounts = set(reviewers + cc)
2440 # TODO(crbug/877717): relax this for all hosts.
2441 else:
2442 valid_accounts = gerrit_util.ValidAccounts(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002443 self.GetGerritHost(), reviewers + cc)
Andrii Shyshkalovf170af42018-10-30 07:00:44 +00002444 logging.info('accounts %s are recognized, %s invalid',
2445 sorted(valid_accounts),
2446 set(reviewers + cc).difference(set(valid_accounts)))
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002447
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002448 # Extra options that can be specified at push time. Doc:
2449 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002450 refspec_opts = []
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002451
Aaron Gable844cf292017-06-28 11:32:59 -07002452 # By default, new changes are started in WIP mode, and subsequent patchsets
2453 # don't send email. At any time, passing --send-mail will mark the change
2454 # ready and send email for that particular patch.
Aaron Gableafd52772017-06-27 16:40:10 -07002455 if options.send_mail:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002456 refspec_opts.append('ready')
2457 refspec_opts.append('notify=ALL')
Jamie Madill276da0b2018-04-27 14:41:20 -04002458 elif not self.GetIssue() and options.squash:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002459 refspec_opts.append('wip')
Aaron Gableafd52772017-06-27 16:40:10 -07002460 else:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002461 refspec_opts.append('notify=NONE')
Aaron Gable70f4e242017-06-26 10:45:59 -07002462
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002463 # TODO(tandrii): options.message should be posted as a comment
Aaron Gablee5adf612017-07-14 10:43:58 -07002464 # if --send-mail is set on non-initial upload as Rietveld used to do it.
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002465
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002466 # Set options.title in case user was prompted in _GetTitleForUpload and
2467 # _CMDUploadChange needs to be called again.
2468 options.title = self._GetTitleForUpload(options)
2469 if options.title:
Nick Carter8692b182017-11-06 16:30:38 -08002470 # Punctuation and whitespace in |title| must be percent-encoded.
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002471 refspec_opts.append(
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002472 'm=' + gerrit_util.PercentEncodeForGitRef(options.title))
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002473
agablec6787972016-09-09 16:13:34 -07002474 if options.private:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002475 refspec_opts.append('private')
agablec6787972016-09-09 16:13:34 -07002476
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002477 for r in sorted(reviewers):
2478 if r in valid_accounts:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002479 refspec_opts.append('r=%s' % r)
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002480 reviewers.remove(r)
2481 else:
2482 # TODO(tandrii): this should probably be a hard failure.
2483 print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping'
2484 % r)
2485 for c in sorted(cc):
2486 # refspec option will be rejected if cc doesn't correspond to an
2487 # account, even though REST call to add such arbitrary cc may succeed.
2488 if c in valid_accounts:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002489 refspec_opts.append('cc=%s' % c)
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002490 cc.remove(c)
2491
rmistry9eadede2016-09-19 11:22:43 -07002492 if options.topic:
2493 # Documentation on Gerrit topics is here:
2494 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002495 refspec_opts.append('topic=%s' % options.topic)
rmistry9eadede2016-09-19 11:22:43 -07002496
Edward Lemur687ca902018-12-05 02:30:30 +00002497 if options.enable_auto_submit:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002498 refspec_opts.append('l=Auto-Submit+1')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00002499 if options.set_bot_commit:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002500 refspec_opts.append('l=Bot-Commit+1')
Edward Lemur687ca902018-12-05 02:30:30 +00002501 if options.use_commit_queue:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002502 refspec_opts.append('l=Commit-Queue+2')
Edward Lemur687ca902018-12-05 02:30:30 +00002503 elif options.cq_dry_run:
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002504 refspec_opts.append('l=Commit-Queue+1')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00002505 elif options.cq_quick_run:
2506 refspec_opts.append('l=Commit-Queue+1')
2507 refspec_opts.append('l=Quick-Run+1')
Edward Lemur687ca902018-12-05 02:30:30 +00002508
2509 if change_desc.get_reviewers(tbr_only=True):
2510 score = gerrit_util.GetCodeReviewTbrScore(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002511 self.GetGerritHost(),
2512 self.GetGerritProject())
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002513 refspec_opts.append('l=Code-Review+%s' % score)
Andrii Shyshkalove7a7fc42018-10-30 17:35:09 +00002514
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002515 # Gerrit sorts hashtags, so order is not important.
Nodir Turakulov23b82142017-11-16 11:04:25 -08002516 hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags}
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002517 if not self.GetIssue():
Nodir Turakulov23b82142017-11-16 11:04:25 -08002518 hashtags.update(change_desc.get_hash_tags())
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002519 refspec_opts += ['hashtag=%s' % t for t in sorted(hashtags)]
2520
2521 refspec_suffix = ''
2522 if refspec_opts:
2523 refspec_suffix = '%' + ','.join(refspec_opts)
2524 assert ' ' not in refspec_suffix, (
2525 'spaces not allowed in refspec: "%s"' % refspec_suffix)
2526 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002527
Edward Lemur1b52d872019-05-09 21:12:12 +00002528 git_push_metadata = {
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002529 'gerrit_host': self.GetGerritHost(),
Josip Sokcevicf736cab2020-10-20 23:41:38 +00002530 'title': options.title or '<untitled>',
Edward Lemur1b52d872019-05-09 21:12:12 +00002531 'change_id': change_id,
2532 'description': change_desc.description,
2533 }
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002534
Josip Sokcevicd0ba91f2021-03-29 20:12:09 +00002535 push_stdout = self._RunGitPushWithTraces(refspec, refspec_opts,
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00002536 git_push_metadata,
2537 options.push_options)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002538
2539 if options.squash:
Aaron Gable289b4312017-09-13 14:06:16 -07002540 regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002541 change_numbers = [m.group(1)
2542 for m in map(regex.match, push_stdout.splitlines())
2543 if m]
2544 if len(change_numbers) != 1:
2545 DieWithError(
2546 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
Christopher Lamf732cd52017-01-24 12:40:11 +11002547 'Change-Id: %s') % (len(change_numbers), change_id), change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002548 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002549 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002550
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002551 if self.GetIssue() and (reviewers or cc):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002552 # GetIssue() is not set in case of non-squash uploads according to tests.
Aaron Gable6e7ddb62020-05-27 22:23:29 +00002553 # TODO(crbug.com/751901): non-squash uploads in git cl should be removed.
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002554 gerrit_util.AddReviewers(
Edward Lesmeseeca9c62020-11-20 00:00:17 +00002555 self.GetGerritHost(),
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00002556 self._GerritChangeIdentifier(),
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002557 reviewers, cc,
2558 notify=bool(options.send_mail))
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002559
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002560 return 0
2561
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002562 def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force,
2563 change_desc):
2564 """Computes parent of the generated commit to be uploaded to Gerrit.
2565
2566 Returns revision or a ref name.
2567 """
2568 if custom_cl_base:
2569 # Try to avoid creating additional unintended CLs when uploading, unless
2570 # user wants to take this risk.
2571 local_ref_of_target_remote = self.GetRemoteBranch()[1]
2572 code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base,
2573 local_ref_of_target_remote])
2574 if code == 1:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002575 print('\nWARNING: Manually specified base of this CL `%s` '
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002576 'doesn\'t seem to belong to target remote branch `%s`.\n\n'
2577 'If you proceed with upload, more than 1 CL may be created by '
2578 'Gerrit as a result, in turn confusing or crashing git cl.\n\n'
2579 'If you are certain that specified base `%s` has already been '
2580 'uploaded to Gerrit as another CL, you may proceed.\n' %
2581 (custom_cl_base, local_ref_of_target_remote, custom_cl_base))
2582 if not force:
2583 confirm_or_exit(
2584 'Do you take responsibility for cleaning up potential mess '
2585 'resulting from proceeding with upload?',
2586 action='upload')
2587 return custom_cl_base
2588
Aaron Gablef97e33d2017-03-30 15:44:27 -07002589 if remote != '.':
2590 return self.GetCommonAncestorWithUpstream()
2591
2592 # If our upstream branch is local, we base our squashed commit on its
2593 # squashed version.
2594 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2595
Aaron Gablef97e33d2017-03-30 15:44:27 -07002596 if upstream_branch_name == 'master':
Aaron Gable0bbd1c22017-05-08 14:37:08 -07002597 return self.GetCommonAncestorWithUpstream()
Glen Robertson7d98e222020-08-27 17:53:11 +00002598 if upstream_branch_name == 'main':
2599 return self.GetCommonAncestorWithUpstream()
Aaron Gablef97e33d2017-03-30 15:44:27 -07002600
2601 # Check the squashed hash of the parent.
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002602 # TODO(tandrii): consider checking parent change in Gerrit and using its
2603 # hash if tree hash of latest parent revision (patchset) in Gerrit matches
2604 # the tree hash of the parent branch. The upside is less likely bogus
2605 # requests to reupload parent change just because it's uploadhash is
2606 # missing, yet the downside likely exists, too (albeit unknown to me yet).
Edward Lesmesa680c232020-03-31 18:26:44 +00002607 parent = scm.GIT.GetBranchConfig(
2608 settings.GetRoot(), upstream_branch_name, 'gerritsquashhash')
Aaron Gablef97e33d2017-03-30 15:44:27 -07002609 # Verify that the upstream branch has been uploaded too, otherwise
2610 # Gerrit will create additional CLs when uploading.
2611 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2612 RunGitSilent(['rev-parse', parent + ':'])):
2613 DieWithError(
2614 '\nUpload upstream branch %s first.\n'
2615 'It is likely that this branch has been rebased since its last '
2616 'upload, so you just need to upload it again.\n'
2617 '(If you uploaded it with --no-squash, then branch dependencies '
2618 'are not supported, and you should reupload with --squash.)'
2619 % upstream_branch_name,
2620 change_desc)
2621 return parent
2622
Edward Lemura12175c2020-03-09 16:58:26 +00002623 def _AddChangeIdToCommitMessage(self, log_desc, args):
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002624 """Re-commits using the current message, assumes the commit hook is in
2625 place.
2626 """
Edward Lemura12175c2020-03-09 16:58:26 +00002627 RunGit(['commit', '--amend', '-m', log_desc])
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002628 new_log_desc = _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002629 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002630 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002631 return new_log_desc
2632 else:
tandrii@chromium.orgb067ec52016-05-31 15:24:44 +00002633 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002634
tandriie113dfd2016-10-11 10:20:12 -07002635 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002636 try:
2637 data = self._GetChangeDetail()
Aaron Gablea45ee112016-11-22 15:14:38 -08002638 except GerritChangeNotExists:
2639 return 'Gerrit doesn\'t know about your change %s' % self.GetIssue()
tandrii8c5a3532016-11-04 07:52:02 -07002640
2641 if data['status'] in ('ABANDONED', 'MERGED'):
2642 return 'CL %s is closed' % self.GetIssue()
2643
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002644 def GetGerritChange(self, patchset=None):
2645 """Returns a buildbucket.v2.GerritChange message for the current issue."""
Edward Lemur79d4f992019-11-11 23:49:02 +00002646 host = urllib.parse.urlparse(self.GetCodereviewServer()).hostname
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002647 issue = self.GetIssue()
Edward Lemur2c210a42019-09-16 23:58:35 +00002648 patchset = int(patchset or self.GetPatchset())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002649 data = self._GetChangeDetail(['ALL_REVISIONS'])
2650
2651 assert host and issue and patchset, 'CL must be uploaded first'
2652
2653 has_patchset = any(
2654 int(revision_data['_number']) == patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002655 for revision_data in data['revisions'].values())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002656 if not has_patchset:
Aaron Gablea45ee112016-11-22 15:14:38 -08002657 raise Exception('Patchset %d is not known in Gerrit change %d' %
tandrii8c5a3532016-11-04 07:52:02 -07002658 (patchset, self.GetIssue()))
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002659
tandrii8c5a3532016-11-04 07:52:02 -07002660 return {
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002661 'host': host,
2662 'change': issue,
2663 'project': data['project'],
2664 'patchset': patchset,
tandrii8c5a3532016-11-04 07:52:02 -07002665 }
tandriie113dfd2016-10-11 10:20:12 -07002666
tandriide281ae2016-10-12 06:02:30 -07002667 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002668 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002669
Edward Lemur707d70b2018-02-07 00:50:14 +01002670 def GetReviewers(self):
2671 details = self._GetChangeDetail(['DETAILED_ACCOUNTS'])
Mohamed Heikal171c0742018-11-09 20:38:51 +00002672 return [r['email'] for r in details['reviewers'].get('REVIEWER', [])]
Edward Lemur707d70b2018-02-07 00:50:14 +01002673
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002674
Lei Zhang8a0efc12020-08-05 19:58:45 +00002675def _get_bug_line_values(default_project_prefix, bugs):
2676 """Given default_project_prefix and comma separated list of bugs, yields bug
2677 line values.
tandriif9aefb72016-07-01 09:06:51 -07002678
2679 Each bug can be either:
Lei Zhang8a0efc12020-08-05 19:58:45 +00002680 * a number, which is combined with default_project_prefix
tandriif9aefb72016-07-01 09:06:51 -07002681 * string, which is left as is.
2682
2683 This function may produce more than one line, because bugdroid expects one
2684 project per line.
2685
Lei Zhang8a0efc12020-08-05 19:58:45 +00002686 >>> list(_get_bug_line_values('v8:', '123,chromium:789'))
tandriif9aefb72016-07-01 09:06:51 -07002687 ['v8:123', 'chromium:789']
2688 """
2689 default_bugs = []
2690 others = []
2691 for bug in bugs.split(','):
2692 bug = bug.strip()
2693 if bug:
2694 try:
2695 default_bugs.append(int(bug))
2696 except ValueError:
2697 others.append(bug)
2698
2699 if default_bugs:
2700 default_bugs = ','.join(map(str, default_bugs))
Lei Zhang8a0efc12020-08-05 19:58:45 +00002701 if default_project_prefix:
2702 if not default_project_prefix.endswith(':'):
2703 default_project_prefix += ':'
2704 yield '%s%s' % (default_project_prefix, default_bugs)
tandriif9aefb72016-07-01 09:06:51 -07002705 else:
2706 yield default_bugs
2707 for other in sorted(others):
2708 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2709 yield other
2710
2711
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002712class ChangeDescription(object):
2713 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002714 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002715 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
Aaron Gable3a16ed12017-03-23 10:51:55 -07002716 BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$'
Dan Beamd8b04ca2019-10-10 21:23:26 +00002717 FIXED_LINE = r'^[ \t]*Fixed[ \t]*:[ \t]*(.*?)[ \t]*$'
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002718 CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002719 STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*'
2720 BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]'
Anthony Polito02b5af32019-12-02 19:49:47 +00002721 COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):($|[^:])'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002722 BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002723
Dan Beamd8b04ca2019-10-10 21:23:26 +00002724 def __init__(self, description, bug=None, fixed=None):
agable@chromium.org42c20792013-09-12 17:34:49 +00002725 self._description_lines = (description or '').strip().splitlines()
Anthony Polito8b955342019-09-24 19:01:36 +00002726 if bug:
2727 regexp = re.compile(self.BUG_LINE)
2728 prefix = settings.GetBugPrefix()
2729 if not any((regexp.match(line) for line in self._description_lines)):
2730 values = list(_get_bug_line_values(prefix, bug))
2731 self.append_footer('Bug: %s' % ', '.join(values))
Dan Beamd8b04ca2019-10-10 21:23:26 +00002732 if fixed:
2733 regexp = re.compile(self.FIXED_LINE)
2734 prefix = settings.GetBugPrefix()
2735 if not any((regexp.match(line) for line in self._description_lines)):
2736 values = list(_get_bug_line_values(prefix, fixed))
2737 self.append_footer('Fixed: %s' % ', '.join(values))
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002738
agable@chromium.org42c20792013-09-12 17:34:49 +00002739 @property # www.logilab.org/ticket/89786
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08002740 def description(self): # pylint: disable=method-hidden
agable@chromium.org42c20792013-09-12 17:34:49 +00002741 return '\n'.join(self._description_lines)
2742
2743 def set_description(self, desc):
2744 if isinstance(desc, basestring):
2745 lines = desc.splitlines()
2746 else:
2747 lines = [line.rstrip() for line in desc]
2748 while lines and not lines[0]:
2749 lines.pop(0)
2750 while lines and not lines[-1]:
2751 lines.pop(-1)
2752 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002753
Edward Lemur5a644f82020-03-18 16:44:57 +00002754 def ensure_change_id(self, change_id):
2755 description = self.description
2756 footer_change_ids = git_footers.get_footer_change_id(description)
2757 # Make sure that the Change-Id in the description matches the given one.
2758 if footer_change_ids != [change_id]:
2759 if footer_change_ids:
2760 # Remove any existing Change-Id footers since they don't match the
2761 # expected change_id footer.
2762 description = git_footers.remove_footer(description, 'Change-Id')
2763 print('WARNING: Change-Id has been set to %s. Use `git cl issue 0` '
2764 'if you want to set a new one.')
2765 # Add the expected Change-Id footer.
2766 description = git_footers.add_footer_change_id(description, change_id)
2767 self.set_description(description)
2768
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002769 def update_reviewers(self, reviewers, tbrs):
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002770 """Rewrites the R=/TBR= line(s) as a single line each.
2771
2772 Args:
2773 reviewers (list(str)) - list of additional emails to use for reviewers.
2774 tbrs (list(str)) - list of additional emails to use for TBRs.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002775 """
Edward Lesmes8c43c3f2021-01-20 00:20:26 +00002776 if not reviewers and not tbrs:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002777 return
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002778
2779 reviewers = set(reviewers)
2780 tbrs = set(tbrs)
2781 LOOKUP = {
2782 'TBR': tbrs,
2783 'R': reviewers,
2784 }
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002785
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002786 # Get the set of R= and TBR= lines and remove them from the description.
agable@chromium.org42c20792013-09-12 17:34:49 +00002787 regexp = re.compile(self.R_LINE)
2788 matches = [regexp.match(line) for line in self._description_lines]
2789 new_desc = [l for i, l in enumerate(self._description_lines)
2790 if not matches[i]]
2791 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002792
agable@chromium.org42c20792013-09-12 17:34:49 +00002793 # Construct new unified R= and TBR= lines.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002794
2795 # First, update tbrs/reviewers with names from the R=/TBR= lines (if any).
agable@chromium.org42c20792013-09-12 17:34:49 +00002796 for match in matches:
2797 if not match:
2798 continue
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002799 LOOKUP[match.group(1)].update(cleanup_list([match.group(2).strip()]))
2800
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002801 # If any folks ended up in both groups, remove them from tbrs.
2802 tbrs -= reviewers
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002803
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002804 new_r_line = 'R=' + ', '.join(sorted(reviewers)) if reviewers else None
2805 new_tbr_line = 'TBR=' + ', '.join(sorted(tbrs)) if tbrs else None
agable@chromium.org42c20792013-09-12 17:34:49 +00002806
2807 # Put the new lines in the description where the old first R= line was.
2808 line_loc = next((i for i, match in enumerate(matches) if match), -1)
2809 if 0 <= line_loc < len(self._description_lines):
2810 if new_tbr_line:
2811 self._description_lines.insert(line_loc, new_tbr_line)
2812 if new_r_line:
2813 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002814 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00002815 if new_r_line:
2816 self.append_footer(new_r_line)
2817 if new_tbr_line:
2818 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002819
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002820 def set_preserve_tryjobs(self):
2821 """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'."""
2822 footers = git_footers.parse_footers(self.description)
2823 for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []):
2824 if v.lower() == 'true':
2825 return
2826 self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true')
2827
Anthony Polito8b955342019-09-24 19:01:36 +00002828 def prompt(self):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002829 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002830 self.set_description([
2831 '# Enter a description of the change.',
2832 '# This will be displayed on the codereview site.',
2833 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00002834 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00002835 '--------------------',
2836 ] + self._description_lines)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002837 bug_regexp = re.compile(self.BUG_LINE)
2838 fixed_regexp = re.compile(self.FIXED_LINE)
Jonas Termansend0f79112019-03-22 15:28:26 +00002839 prefix = settings.GetBugPrefix()
Sigurd Schneider8630bb12020-11-11 14:02:49 +00002840 has_issue = lambda l: bug_regexp.match(l) or fixed_regexp.match(l)
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00002841
Dan Beamd8b04ca2019-10-10 21:23:26 +00002842 if not any((has_issue(line) for line in self._description_lines)):
Anthony Polito8b955342019-09-24 19:01:36 +00002843 self.append_footer('Bug: %s' % prefix)
tandriif9aefb72016-07-01 09:06:51 -07002844
Bruce Dawsonfc487042020-10-27 19:11:37 +00002845 print('Waiting for editor...')
agable@chromium.org42c20792013-09-12 17:34:49 +00002846 content = gclient_utils.RunEditor(self.description, True,
Edward Lemur79d4f992019-11-11 23:49:02 +00002847 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002848 if not content:
2849 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00002850 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002851
Bruce Dawson2377b012018-01-11 16:46:49 -08002852 # Strip off comments and default inserted "Bug:" line.
2853 clean_lines = [line.rstrip() for line in lines if not
Jonas Termansend0f79112019-03-22 15:28:26 +00002854 (line.startswith('#') or
2855 line.rstrip() == "Bug:" or
2856 line.rstrip() == "Bug: " + prefix)]
agable@chromium.org42c20792013-09-12 17:34:49 +00002857 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002858 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00002859 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002860
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002861 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00002862 """Adds a footer line to the description.
2863
2864 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
2865 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
2866 that Gerrit footers are always at the end.
2867 """
2868 parsed_footer_line = git_footers.parse_footer(line)
2869 if parsed_footer_line:
2870 # Line is a gerrit footer in the form: Footer-Key: any value.
2871 # Thus, must be appended observing Gerrit footer rules.
2872 self.set_description(
2873 git_footers.add_footer(self.description,
2874 key=parsed_footer_line[0],
2875 value=parsed_footer_line[1]))
2876 return
2877
2878 if not self._description_lines:
2879 self._description_lines.append(line)
2880 return
2881
2882 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
2883 if gerrit_footers:
2884 # git_footers.split_footers ensures that there is an empty line before
2885 # actual (gerrit) footers, if any. We have to keep it that way.
2886 assert top_lines and top_lines[-1] == ''
2887 top_lines, separator = top_lines[:-1], top_lines[-1:]
2888 else:
2889 separator = [] # No need for separator if there are no gerrit_footers.
2890
2891 prev_line = top_lines[-1] if top_lines else ''
2892 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
2893 not presubmit_support.Change.TAG_LINE_RE.match(line)):
2894 top_lines.append('')
2895 top_lines.append(line)
2896 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002897
tandrii99a72f22016-08-17 14:33:24 -07002898 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002899 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002900 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07002901 reviewers = [match.group(2).strip()
2902 for match in matches
2903 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002904 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002905
bradnelsond975b302016-10-23 12:20:23 -07002906 def get_cced(self):
2907 """Retrieves the list of reviewers."""
2908 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
2909 cced = [match.group(2).strip() for match in matches if match]
2910 return cleanup_list(cced)
2911
Nodir Turakulov23b82142017-11-16 11:04:25 -08002912 def get_hash_tags(self):
2913 """Extracts and sanitizes a list of Gerrit hashtags."""
2914 subject = (self._description_lines or ('',))[0]
2915 subject = re.sub(
2916 self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE)
2917
2918 tags = []
2919 start = 0
2920 bracket_exp = re.compile(self.BRACKET_HASH_TAG)
2921 while True:
2922 m = bracket_exp.match(subject, start)
2923 if not m:
2924 break
2925 tags.append(self.sanitize_hash_tag(m.group(1)))
2926 start = m.end()
2927
2928 if not tags:
2929 # Try "Tag: " prefix.
2930 m = re.match(self.COLON_SEPARATED_HASH_TAG, subject)
2931 if m:
2932 tags.append(self.sanitize_hash_tag(m.group(1)))
2933 return tags
2934
2935 @classmethod
2936 def sanitize_hash_tag(cls, tag):
2937 """Returns a sanitized Gerrit hash tag.
2938
2939 A sanitized hashtag can be used as a git push refspec parameter value.
2940 """
2941 return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower()
2942
maruel@chromium.orge52678e2013-04-26 18:34:44 +00002943
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002944def FindCodereviewSettingsFile(filename='codereview.settings'):
2945 """Finds the given file starting in the cwd and going up.
2946
2947 Only looks up to the top of the repository unless an
2948 'inherit-review-settings-ok' file exists in the root of the repository.
2949 """
2950 inherit_ok_file = 'inherit-review-settings-ok'
2951 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00002952 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002953 if os.path.isfile(os.path.join(root, inherit_ok_file)):
2954 root = '/'
2955 while True:
2956 if filename in os.listdir(cwd):
2957 if os.path.isfile(os.path.join(cwd, filename)):
2958 return open(os.path.join(cwd, filename))
2959 if cwd == root:
2960 break
2961 cwd = os.path.dirname(cwd)
2962
2963
2964def LoadCodereviewSettingsFromFile(fileobj):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002965 """Parses a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00002966 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002967
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002968 def SetProperty(name, setting, unset_error_ok=False):
2969 fullname = 'rietveld.' + name
2970 if setting in keyvals:
2971 RunGit(['config', fullname, keyvals[setting]])
2972 else:
2973 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
2974
tandrii48df5812016-10-17 03:55:37 -07002975 if not keyvals.get('GERRIT_HOST', False):
2976 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002977 # Only server setting is required. Other settings can be absent.
2978 # In that case, we ignore errors raised during option deletion attempt.
2979 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
2980 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
2981 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00002982 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00002983 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
2984 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00002985 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
2986 unset_error_ok=True)
Jamie Madilldc4d19e2019-10-24 21:50:02 +00002987 SetProperty(
2988 'format-full-by-default', 'FORMAT_FULL_BY_DEFAULT', unset_error_ok=True)
Dirk Pranke6f0df682021-06-25 00:42:33 +00002989 SetProperty('use-python3', 'USE_PYTHON3', unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002990
ukai@chromium.org7044efc2013-11-28 01:51:21 +00002991 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00002992 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00002993
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00002994 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
Edward Lesmes4de54132020-05-05 19:41:33 +00002995 RunGit(['config', 'gerrit.squash-uploads',
2996 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00002997
tandrii@chromium.org28253532016-04-14 13:46:56 +00002998 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00002999 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00003000 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
3001
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003002 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01003003 # should be of the form
3004 # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
3005 # ORIGIN_URL_CONFIG: http://src.chromium.org/git
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003006 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
3007 keyvals['ORIGIN_URL_CONFIG']])
3008
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003009
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003010def urlretrieve(source, destination):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003011 """Downloads a network object to a local file, like urllib.urlretrieve.
3012
3013 This is necessary because urllib is broken for SSL connections via a proxy.
3014 """
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003015 with open(destination, 'w') as f:
Edward Lemur79d4f992019-11-11 23:49:02 +00003016 f.write(urllib.request.urlopen(source).read())
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003017
3018
ukai@chromium.org712d6102013-11-27 00:52:58 +00003019def hasSheBang(fname):
3020 """Checks fname is a #! script."""
3021 with open(fname) as f:
3022 return f.read(2).startswith('#!')
3023
3024
tandrii@chromium.org18630d62016-03-04 12:06:02 +00003025def DownloadGerritHook(force):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003026 """Downloads and installs a Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003027
3028 Args:
3029 force: True to update hooks. False to install hooks if not present.
3030 """
ukai@chromium.org712d6102013-11-27 00:52:58 +00003031 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003032 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
3033 if not os.access(dst, os.X_OK):
3034 if os.path.exists(dst):
3035 if not force:
3036 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003037 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003038 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003039 if not hasSheBang(dst):
3040 DieWithError('Not a script: %s\n'
3041 'You need to download from\n%s\n'
3042 'into .git/hooks/commit-msg and '
3043 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003044 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
3045 except Exception:
3046 if os.path.exists(dst):
3047 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003048 DieWithError('\nFailed to download hooks.\n'
3049 'You need to download from\n%s\n'
3050 'into .git/hooks/commit-msg and '
3051 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003052
3053
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003054class _GitCookiesChecker(object):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003055 """Provides facilities for validating and suggesting fixes to .gitcookies."""
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003056
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003057 _GOOGLESOURCE = 'googlesource.com'
3058
3059 def __init__(self):
3060 # Cached list of [host, identity, source], where source is either
3061 # .gitcookies or .netrc.
3062 self._all_hosts = None
3063
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003064 def ensure_configured_gitcookies(self):
3065 """Runs checks and suggests fixes to make git use .gitcookies from default
3066 path."""
3067 default = gerrit_util.CookiesAuthenticator.get_gitcookies_path()
3068 configured_path = RunGitSilent(
3069 ['config', '--global', 'http.cookiefile']).strip()
Andrii Shyshkalov1e250cd2017-05-10 15:39:31 +02003070 configured_path = os.path.expanduser(configured_path)
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003071 if configured_path:
3072 self._ensure_default_gitcookies_path(configured_path, default)
3073 else:
3074 self._configure_gitcookies_path(default)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003075
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003076 @staticmethod
3077 def _ensure_default_gitcookies_path(configured_path, default_path):
3078 assert configured_path
3079 if configured_path == default_path:
3080 print('git is already configured to use your .gitcookies from %s' %
3081 configured_path)
3082 return
3083
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003084 print('WARNING: You have configured custom path to .gitcookies: %s\n'
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003085 'Gerrit and other depot_tools expect .gitcookies at %s\n' %
3086 (configured_path, default_path))
3087
3088 if not os.path.exists(configured_path):
3089 print('However, your configured .gitcookies file is missing.')
3090 confirm_or_exit('Reconfigure git to use default .gitcookies?',
3091 action='reconfigure')
3092 RunGit(['config', '--global', 'http.cookiefile', default_path])
3093 return
3094
3095 if os.path.exists(default_path):
3096 print('WARNING: default .gitcookies file already exists %s' %
3097 default_path)
3098 DieWithError('Please delete %s manually and re-run git cl creds-check' %
3099 default_path)
3100
3101 confirm_or_exit('Move existing .gitcookies to default location?',
3102 action='move')
3103 shutil.move(configured_path, default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003104 RunGit(['config', '--global', 'http.cookiefile', default_path])
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003105 print('Moved and reconfigured git to use .gitcookies from %s' %
3106 default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003107
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003108 @staticmethod
3109 def _configure_gitcookies_path(default_path):
3110 netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path()
3111 if os.path.exists(netrc_path):
3112 print('You seem to be using outdated .netrc for git credentials: %s' %
3113 netrc_path)
3114 print('This tool will guide you through setting up recommended '
3115 '.gitcookies store for git credentials.\n'
3116 '\n'
3117 'IMPORTANT: If something goes wrong and you decide to go back, do:\n'
3118 ' git config --global --unset http.cookiefile\n'
3119 ' mv %s %s.backup\n\n' % (default_path, default_path))
3120 confirm_or_exit(action='setup .gitcookies')
3121 RunGit(['config', '--global', 'http.cookiefile', default_path])
3122 print('Configured git to use .gitcookies from %s' % default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003123
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003124 def get_hosts_with_creds(self, include_netrc=False):
3125 if self._all_hosts is None:
3126 a = gerrit_util.CookiesAuthenticator()
3127 self._all_hosts = [
3128 (h, u, s)
3129 for h, u, s in itertools.chain(
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003130 ((h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.items()),
3131 ((h, u, '.gitcookies') for h, (u, _) in a.gitcookies.items())
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003132 )
3133 if h.endswith(self._GOOGLESOURCE)
3134 ]
3135
3136 if include_netrc:
3137 return self._all_hosts
3138 return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc']
3139
3140 def print_current_creds(self, include_netrc=False):
3141 hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc))
3142 if not hosts:
3143 print('No Git/Gerrit credentials found')
3144 return
Edward Lemur79d4f992019-11-11 23:49:02 +00003145 lengths = [max(map(len, (row[i] for row in hosts))) for i in range(3)]
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003146 header = [('Host', 'User', 'Which file'),
3147 ['=' * l for l in lengths]]
3148 for row in (header + hosts):
3149 print('\t'.join((('%%+%ds' % l) % s)
3150 for l, s in zip(lengths, row)))
3151
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003152 @staticmethod
3153 def _parse_identity(identity):
Lei Zhangd3f769a2017-12-15 15:16:14 -08003154 """Parses identity "git-<username>.domain" into <username> and domain."""
3155 # Special case: usernames that contain ".", which are generally not
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02003156 # distinguishable from sub-domains. But we do know typical domains:
3157 if identity.endswith('.chromium.org'):
3158 domain = 'chromium.org'
3159 username = identity[:-len('.chromium.org')]
3160 else:
3161 username, domain = identity.split('.', 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003162 if username.startswith('git-'):
3163 username = username[len('git-'):]
3164 return username, domain
3165
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003166 def _canonical_git_googlesource_host(self, host):
3167 """Normalizes Gerrit hosts (with '-review') to Git host."""
3168 assert host.endswith(self._GOOGLESOURCE)
3169 # Prefix doesn't include '.' at the end.
3170 prefix = host[:-(1 + len(self._GOOGLESOURCE))]
3171 if prefix.endswith('-review'):
3172 prefix = prefix[:-len('-review')]
3173 return prefix + '.' + self._GOOGLESOURCE
3174
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003175 def _canonical_gerrit_googlesource_host(self, host):
3176 git_host = self._canonical_git_googlesource_host(host)
3177 prefix = git_host.split('.', 1)[0]
3178 return prefix + '-review.' + self._GOOGLESOURCE
3179
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003180 def _get_counterpart_host(self, host):
3181 assert host.endswith(self._GOOGLESOURCE)
3182 git = self._canonical_git_googlesource_host(host)
3183 gerrit = self._canonical_gerrit_googlesource_host(git)
3184 return git if gerrit == host else gerrit
3185
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003186 def has_generic_host(self):
3187 """Returns whether generic .googlesource.com has been configured.
3188
3189 Chrome Infra recommends to use explicit ${host}.googlesource.com instead.
3190 """
3191 for host, _, _ in self.get_hosts_with_creds(include_netrc=False):
3192 if host == '.' + self._GOOGLESOURCE:
3193 return True
3194 return False
3195
3196 def _get_git_gerrit_identity_pairs(self):
3197 """Returns map from canonic host to pair of identities (Git, Gerrit).
3198
3199 One of identities might be None, meaning not configured.
3200 """
3201 host_to_identity_pairs = {}
3202 for host, identity, _ in self.get_hosts_with_creds():
3203 canonical = self._canonical_git_googlesource_host(host)
3204 pair = host_to_identity_pairs.setdefault(canonical, [None, None])
3205 idx = 0 if canonical == host else 1
3206 pair[idx] = identity
3207 return host_to_identity_pairs
3208
3209 def get_partially_configured_hosts(self):
3210 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003211 (host if i1 else self._canonical_gerrit_googlesource_host(host))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003212 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003213 if None in (i1, i2) and host != '.' + self._GOOGLESOURCE)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003214
3215 def get_conflicting_hosts(self):
3216 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003217 host
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003218 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003219 if None not in (i1, i2) and i1 != i2)
3220
3221 def get_duplicated_hosts(self):
3222 counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds())
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003223 return set(host for host, count in counters.items() if count > 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003224
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003225
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003226 @staticmethod
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003227 def _format_hosts(hosts, extra_column_func=None):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003228 hosts = sorted(hosts)
3229 assert hosts
3230 if extra_column_func is None:
3231 extras = [''] * len(hosts)
3232 else:
3233 extras = [extra_column_func(host) for host in hosts]
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003234 tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras)))
3235 lines = []
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003236 for he in zip(hosts, extras):
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003237 lines.append(tmpl % he)
3238 return lines
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003239
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003240 def _find_problems(self):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003241 if self.has_generic_host():
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003242 yield ('.googlesource.com wildcard record detected',
3243 ['Chrome Infrastructure team recommends to list full host names '
3244 'explicitly.'],
3245 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003246
3247 dups = self.get_duplicated_hosts()
3248 if dups:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003249 yield ('The following hosts were defined twice',
3250 self._format_hosts(dups),
3251 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003252
3253 partial = self.get_partially_configured_hosts()
3254 if partial:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003255 yield ('Credentials should come in pairs for Git and Gerrit hosts. '
3256 'These hosts are missing',
3257 self._format_hosts(partial, lambda host: 'but %s defined' %
3258 self._get_counterpart_host(host)),
3259 partial)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003260
3261 conflicting = self.get_conflicting_hosts()
3262 if conflicting:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003263 yield ('The following Git hosts have differing credentials from their '
3264 'Gerrit counterparts',
3265 self._format_hosts(conflicting, lambda host: '%s vs %s' %
3266 tuple(self._get_git_gerrit_identity_pairs()[host])),
3267 conflicting)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003268
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003269 def find_and_report_problems(self):
3270 """Returns True if there was at least one problem, else False."""
3271 found = False
3272 bad_hosts = set()
3273 for title, sublines, hosts in self._find_problems():
3274 if not found:
3275 found = True
3276 print('\n\n.gitcookies problem report:\n')
3277 bad_hosts.update(hosts or [])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003278 print(' %s%s' % (title, (':' if sublines else '')))
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003279 if sublines:
3280 print()
3281 print(' %s' % '\n '.join(sublines))
3282 print()
3283
3284 if bad_hosts:
3285 assert found
3286 print(' You can manually remove corresponding lines in your %s file and '
3287 'visit the following URLs with correct account to generate '
3288 'correct credential lines:\n' %
3289 gerrit_util.CookiesAuthenticator.get_gitcookies_path())
3290 print(' %s' % '\n '.join(sorted(set(
3291 gerrit_util.CookiesAuthenticator().get_new_password_url(
3292 self._canonical_git_googlesource_host(host))
3293 for host in bad_hosts
3294 ))))
3295 return found
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003296
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003297
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003298@metrics.collector.collect_metrics('git cl creds-check')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003299def CMDcreds_check(parser, args):
3300 """Checks credentials and suggests changes."""
3301 _, _ = parser.parse_args(args)
3302
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003303 # Code below checks .gitcookies. Abort if using something else.
3304 authn = gerrit_util.Authenticator.get()
3305 if not isinstance(authn, gerrit_util.CookiesAuthenticator):
Edward Lemur57d47422020-03-06 20:43:07 +00003306 message = (
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003307 'This command is not designed for bot environment. It checks '
3308 '~/.gitcookies file not generally used on bots.')
Edward Lemur57d47422020-03-06 20:43:07 +00003309 # TODO(crbug.com/1059384): Automatically detect when running on cloudtop.
3310 if isinstance(authn, gerrit_util.GceAuthenticator):
3311 message += (
3312 '\n'
3313 'If you need to run this on GCE or a cloudtop instance, '
3314 'export SKIP_GCE_AUTH_FOR_GIT=1 in your env.')
3315 DieWithError(message)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003316
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003317 checker = _GitCookiesChecker()
3318 checker.ensure_configured_gitcookies()
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003319
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003320 print('Your .netrc and .gitcookies have credentials for these hosts:')
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003321 checker.print_current_creds(include_netrc=True)
3322
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003323 if not checker.find_and_report_problems():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003324 print('\nNo problems detected in your .gitcookies file.')
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003325 return 0
3326 return 1
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003327
3328
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003329@metrics.collector.collect_metrics('git cl baseurl')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003330def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003331 """Gets or sets base-url for this branch."""
Edward Lesmes50da7702020-03-30 19:23:43 +00003332 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
Edward Lemur85153282020-02-14 22:06:29 +00003333 branch = scm.GIT.ShortBranchName(branchref)
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003334 _, args = parser.parse_args(args)
3335 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003336 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003337 return RunGit(['config', 'branch.%s.base-url' % branch],
3338 error_ok=False).strip()
3339 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003340 print('Setting base-url to %s' % args[0])
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003341 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3342 error_ok=False).strip()
3343
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003344
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003345def color_for_status(status):
3346 """Maps a Changelist status to color, for CMDstatus and other tools."""
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003347 BOLD = '\033[1m'
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003348 return {
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003349 'unsent': BOLD + Fore.YELLOW,
3350 'waiting': BOLD + Fore.RED,
3351 'reply': BOLD + Fore.YELLOW,
3352 'not lgtm': BOLD + Fore.RED,
3353 'lgtm': BOLD + Fore.GREEN,
3354 'commit': BOLD + Fore.MAGENTA,
3355 'closed': BOLD + Fore.CYAN,
3356 'error': BOLD + Fore.WHITE,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003357 }.get(status, Fore.WHITE)
3358
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003359
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003360def get_cl_statuses(changes, fine_grained, max_processes=None):
3361 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003362
3363 If fine_grained is true, this will fetch CL statuses from the server.
3364 Otherwise, simply indicate if there's a matching url for the given branches.
3365
3366 If max_processes is specified, it is used as the maximum number of processes
3367 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3368 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003369
3370 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003371 """
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003372 if not changes:
Edward Lemur61bf4172020-02-24 23:22:37 +00003373 return
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003374
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003375 if not fine_grained:
3376 # Fast path which doesn't involve querying codereview servers.
Aaron Gablea1bab272017-04-11 16:38:18 -07003377 # Do not use get_approving_reviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003378 for cl in changes:
3379 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003380 return
3381
3382 # First, sort out authentication issues.
3383 logging.debug('ensuring credentials exist')
3384 for cl in changes:
3385 cl.EnsureAuthenticated(force=False, refresh=True)
3386
3387 def fetch(cl):
3388 try:
3389 return (cl, cl.GetStatus())
3390 except:
3391 # See http://crbug.com/629863.
Andrii Shyshkalov98824232018-04-19 11:37:15 -07003392 logging.exception('failed to fetch status for cl %s:', cl.GetIssue())
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003393 raise
3394
3395 threads_count = len(changes)
3396 if max_processes:
3397 threads_count = max(1, min(threads_count, max_processes))
3398 logging.debug('querying %d CLs using %d threads', len(changes), threads_count)
3399
Edward Lemur61bf4172020-02-24 23:22:37 +00003400 pool = multiprocessing.pool.ThreadPool(threads_count)
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003401 fetched_cls = set()
3402 try:
3403 it = pool.imap_unordered(fetch, changes).__iter__()
3404 while True:
3405 try:
3406 cl, status = it.next(timeout=5)
Edward Lemur61bf4172020-02-24 23:22:37 +00003407 except (multiprocessing.TimeoutError, StopIteration):
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003408 break
3409 fetched_cls.add(cl)
3410 yield cl, status
3411 finally:
3412 pool.close()
3413
3414 # Add any branches that failed to fetch.
3415 for cl in set(changes) - fetched_cls:
3416 yield (cl, 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003417
rmistry@google.com2dd99862015-06-22 12:22:18 +00003418
Jose Lopes3863fc52020-04-07 17:00:25 +00003419def upload_branch_deps(cl, args, force=False):
rmistry@google.com2dd99862015-06-22 12:22:18 +00003420 """Uploads CLs of local branches that are dependents of the current branch.
3421
3422 If the local branch dependency tree looks like:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003423
3424 test1 -> test2.1 -> test3.1
3425 -> test3.2
3426 -> test2.2 -> test3.3
rmistry@google.com2dd99862015-06-22 12:22:18 +00003427
3428 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3429 run on the dependent branches in this order:
3430 test2.1, test3.1, test3.2, test2.2, test3.3
3431
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003432 Note: This function does not rebase your local dependent branches. Use it
3433 when you make a change to the parent branch that will not conflict
3434 with its dependent branches, and you would like their dependencies
3435 updated in Rietveld.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003436 """
3437 if git_common.is_dirty_git_tree('upload-branch-deps'):
3438 return 1
3439
3440 root_branch = cl.GetBranch()
3441 if root_branch is None:
3442 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3443 'Get on a branch!')
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00003444 if not cl.GetIssue():
rmistry@google.com2dd99862015-06-22 12:22:18 +00003445 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3446 'patchset dependencies without an uploaded CL.')
3447
3448 branches = RunGit(['for-each-ref',
3449 '--format=%(refname:short) %(upstream:short)',
3450 'refs/heads'])
3451 if not branches:
3452 print('No local branches found.')
3453 return 0
3454
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003455 # Create a dictionary of all local branches to the branches that are
3456 # dependent on it.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003457 tracked_to_dependents = collections.defaultdict(list)
3458 for b in branches.splitlines():
3459 tokens = b.split()
3460 if len(tokens) == 2:
3461 branch_name, tracked = tokens
3462 tracked_to_dependents[tracked].append(branch_name)
3463
vapiera7fbd5a2016-06-16 09:17:49 -07003464 print()
3465 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003466 dependents = []
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003467
rmistry@google.com2dd99862015-06-22 12:22:18 +00003468 def traverse_dependents_preorder(branch, padding=''):
3469 dependents_to_process = tracked_to_dependents.get(branch, [])
3470 padding += ' '
3471 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003472 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003473 dependents.append(dependent)
3474 traverse_dependents_preorder(dependent, padding)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003475
rmistry@google.com2dd99862015-06-22 12:22:18 +00003476 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003477 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003478
3479 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003480 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003481 return 0
3482
Jose Lopes3863fc52020-04-07 17:00:25 +00003483 if not force:
3484 confirm_or_exit('This command will checkout all dependent branches and run '
3485 '"git cl upload".', action='continue')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003486
rmistry@google.com2dd99862015-06-22 12:22:18 +00003487 # Record all dependents that failed to upload.
3488 failures = {}
3489 # Go through all dependents, checkout the branch and upload.
3490 try:
3491 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003492 print()
3493 print('--------------------------------------')
3494 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003495 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003496 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003497 try:
3498 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003499 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003500 failures[dependent_branch] = 1
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003501 except: # pylint: disable=bare-except
rmistry@google.com2dd99862015-06-22 12:22:18 +00003502 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003503 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003504 finally:
3505 # Swap back to the original root branch.
3506 RunGit(['checkout', '-q', root_branch])
3507
vapiera7fbd5a2016-06-16 09:17:49 -07003508 print()
3509 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003510 for dependent_branch in dependents:
3511 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003512 print(' %s : %s' % (dependent_branch, upload_status))
3513 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003514
3515 return 0
3516
3517
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003518def GetArchiveTagForBranch(issue_num, branch_name, existing_tags, pattern):
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003519 """Given a proposed tag name, returns a tag name that is guaranteed to be
3520 unique. If 'foo' is proposed but already exists, then 'foo-2' is used,
3521 or 'foo-3', and so on."""
3522
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003523 proposed_tag = pattern.format(**{'issue': issue_num, 'branch': branch_name})
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003524 for suffix_num in itertools.count(1):
3525 if suffix_num == 1:
3526 to_check = proposed_tag
3527 else:
3528 to_check = '%s-%d' % (proposed_tag, suffix_num)
3529
3530 if to_check not in existing_tags:
3531 return to_check
3532
3533
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003534@metrics.collector.collect_metrics('git cl archive')
kmarshall3bff56b2016-06-06 18:31:47 -07003535def CMDarchive(parser, args):
3536 """Archives and deletes branches associated with closed changelists."""
3537 parser.add_option(
3538 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003539 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003540 parser.add_option(
3541 '-f', '--force', action='store_true',
3542 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003543 parser.add_option(
3544 '-d', '--dry-run', action='store_true',
3545 help='Skip the branch tagging and removal steps.')
3546 parser.add_option(
3547 '-t', '--notags', action='store_true',
3548 help='Do not tag archived branches. '
3549 'Note: local commit history may be lost.')
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003550 parser.add_option(
3551 '-p',
3552 '--pattern',
3553 default='git-cl-archived-{issue}-{branch}',
3554 help='Format string for archive tags. '
3555 'E.g. \'archived-{issue}-{branch}\'.')
kmarshall3bff56b2016-06-06 18:31:47 -07003556
kmarshall3bff56b2016-06-06 18:31:47 -07003557 options, args = parser.parse_args(args)
3558 if args:
3559 parser.error('Unsupported args: %s' % ' '.join(args))
kmarshall3bff56b2016-06-06 18:31:47 -07003560
3561 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3562 if not branches:
3563 return 0
3564
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003565 tags = RunGit(['for-each-ref', '--format=%(refname)',
3566 'refs/tags']).splitlines() or []
3567 tags = [t.split('/')[-1] for t in tags]
3568
vapiera7fbd5a2016-06-16 09:17:49 -07003569 print('Finding all branches associated with closed issues...')
Edward Lemur934836a2019-09-09 20:16:54 +00003570 changes = [Changelist(branchref=b)
3571 for b in branches.splitlines()]
kmarshall3bff56b2016-06-06 18:31:47 -07003572 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3573 statuses = get_cl_statuses(changes,
3574 fine_grained=True,
3575 max_processes=options.maxjobs)
3576 proposal = [(cl.GetBranch(),
Tibor Goldschwendt7c5efb22020-03-25 01:23:54 +00003577 GetArchiveTagForBranch(cl.GetIssue(), cl.GetBranch(), tags,
3578 options.pattern))
kmarshall3bff56b2016-06-06 18:31:47 -07003579 for cl, status in statuses
Andrii Shyshkalov51bdf8c2018-10-18 01:07:58 +00003580 if status in ('closed', 'rietveld-not-supported')]
kmarshall3bff56b2016-06-06 18:31:47 -07003581 proposal.sort()
3582
3583 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003584 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003585 return 0
3586
Edward Lemur85153282020-02-14 22:06:29 +00003587 current_branch = scm.GIT.GetBranch(settings.GetRoot())
kmarshall3bff56b2016-06-06 18:31:47 -07003588
vapiera7fbd5a2016-06-16 09:17:49 -07003589 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003590 if options.notags:
3591 for next_item in proposal:
3592 print(' ' + next_item[0])
3593 else:
3594 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3595 for next_item in proposal:
3596 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003597
kmarshall9249e012016-08-23 12:02:16 -07003598 # Quit now on precondition failure or if instructed by the user, either
3599 # via an interactive prompt or by command line flags.
3600 if options.dry_run:
3601 print('\nNo changes were made (dry run).\n')
3602 return 0
3603 elif any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003604 print('You are currently on a branch \'%s\' which is associated with a '
3605 'closed codereview issue, so archive cannot proceed. Please '
3606 'checkout another branch and run this command again.' %
3607 current_branch)
3608 return 1
kmarshall9249e012016-08-23 12:02:16 -07003609 elif not options.force:
Edward Lesmesae3586b2020-03-23 21:21:14 +00003610 answer = gclient_utils.AskForData('\nProceed with deletion (Y/n)? ').lower()
sergiyb4a5ecbe2016-06-20 09:46:00 -07003611 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003612 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003613 return 1
3614
3615 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003616 if not options.notags:
3617 RunGit(['tag', tagname, branch])
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003618
3619 if RunGitWithCode(['branch', '-D', branch])[0] != 0:
3620 # Clean up the tag if we failed to delete the branch.
3621 RunGit(['tag', '-d', tagname])
kmarshall9249e012016-08-23 12:02:16 -07003622
vapiera7fbd5a2016-06-16 09:17:49 -07003623 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003624
3625 return 0
3626
3627
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003628@metrics.collector.collect_metrics('git cl status')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003629def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003630 """Show status of changelists.
3631
3632 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003633 - Blue waiting for review
Aaron Gable9ab38c62017-04-06 14:36:33 -07003634 - Yellow waiting for you to reply to review, or not yet sent
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003635 - Green LGTM'ed
Aaron Gable9ab38c62017-04-06 14:36:33 -07003636 - Red 'not LGTM'ed
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00003637 - Magenta in the CQ
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003638 - Cyan was committed, branch can be deleted
Aaron Gable9ab38c62017-04-06 14:36:33 -07003639 - White error, or unknown status
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003640
3641 Also see 'git cl comments'.
3642 """
Alan Cuttera3be9a52019-03-04 18:50:33 +00003643 parser.add_option(
3644 '--no-branch-color',
3645 action='store_true',
3646 help='Disable colorized branch names')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003647 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003648 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003649 parser.add_option('-f', '--fast', action='store_true',
3650 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003651 parser.add_option(
3652 '-j', '--maxjobs', action='store', type=int,
3653 help='The maximum number of jobs to use when retrieving review status')
Edward Lemur52969c92020-02-06 18:15:28 +00003654 parser.add_option(
3655 '-i', '--issue', type=int,
3656 help='Operate on this issue instead of the current branch\'s implicit '
3657 'issue. Requires --field to be set.')
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003658 parser.add_option('-d',
3659 '--date-order',
3660 action='store_true',
3661 help='Order branches by committer date.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003662 options, args = parser.parse_args(args)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003663 if args:
3664 parser.error('Unsupported args: %s' % args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003665
iannuccie53c9352016-08-17 14:40:40 -07003666 if options.issue is not None and not options.field:
Edward Lemur6c6827c2020-02-06 21:15:18 +00003667 parser.error('--field must be given when --issue is set.')
iannucci3c972b92016-08-17 13:24:10 -07003668
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003669 if options.field:
Edward Lemur934836a2019-09-09 20:16:54 +00003670 cl = Changelist(issue=options.issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003671 if options.field.startswith('desc'):
Edward Lemur6c6827c2020-02-06 21:15:18 +00003672 if cl.GetIssue():
3673 print(cl.FetchDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003674 elif options.field == 'id':
3675 issueid = cl.GetIssue()
3676 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07003677 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003678 elif options.field == 'patch':
Aaron Gablee8856ee2017-12-07 12:41:46 -08003679 patchset = cl.GetMostRecentPatchset()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003680 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07003681 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07003682 elif options.field == 'status':
3683 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003684 elif options.field == 'url':
3685 url = cl.GetIssueURL()
3686 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07003687 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003688 return 0
3689
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003690 branches = RunGit([
3691 'for-each-ref', '--format=%(refname) %(committerdate:unix)', 'refs/heads'
3692 ])
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003693 if not branches:
3694 print('No local branch found.')
3695 return 0
3696
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003697 changes = [
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003698 Changelist(branchref=b, commit_date=ct)
3699 for b, ct in map(lambda line: line.split(' '), branches.splitlines())
3700 ]
vapiera7fbd5a2016-06-16 09:17:49 -07003701 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003702 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003703 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003704 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003705
Edward Lemur85153282020-02-14 22:06:29 +00003706 current_branch = scm.GIT.GetBranch(settings.GetRoot())
Daniel McArdlea23bf592019-02-12 00:25:12 +00003707
3708 def FormatBranchName(branch, colorize=False):
3709 """Simulates 'git branch' behavior. Colorizes and prefixes branch name with
3710 an asterisk when it is the current branch."""
3711
3712 asterisk = ""
3713 color = Fore.RESET
3714 if branch == current_branch:
3715 asterisk = "* "
3716 color = Fore.GREEN
Edward Lemur85153282020-02-14 22:06:29 +00003717 branch_name = scm.GIT.ShortBranchName(branch)
Daniel McArdlea23bf592019-02-12 00:25:12 +00003718
3719 if colorize:
3720 return asterisk + color + branch_name + Fore.RESET
Daniel McArdle452a49f2019-02-14 17:28:31 +00003721 return asterisk + branch_name
3722
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003723 branch_statuses = {}
Daniel McArdlea23bf592019-02-12 00:25:12 +00003724
3725 alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes))
Sigurd Schneider1bfda8e2021-06-30 14:46:25 +00003726
3727 if options.date_order or settings.IsStatusCommitOrderByDate():
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00003728 sorted_changes = sorted(changes,
3729 key=lambda c: c.GetCommitDate(),
3730 reverse=True)
3731 else:
3732 sorted_changes = sorted(changes, key=lambda c: c.GetBranch())
3733 for cl in sorted_changes:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003734 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003735 while branch not in branch_statuses:
Edward Lemur79d4f992019-11-11 23:49:02 +00003736 c, status = next(output)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003737 branch_statuses[c.GetBranch()] = status
3738 status = branch_statuses.pop(branch)
Andrii Shyshkalov1ee78cd2020-03-12 01:31:53 +00003739 url = cl.GetIssueURL(short=True)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003740 if url and (not status or status == 'error'):
3741 # The issue probably doesn't exist anymore.
3742 url += ' (broken)'
3743
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003744 color = color_for_status(status)
Bruce Dawsonb73f8a92020-03-27 22:03:08 +00003745 # Turn off bold as well as colors.
3746 END = '\033[0m'
3747 reset = Fore.RESET + END
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00003748 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00003749 color = ''
3750 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003751 status_str = '(%s)' % status if status else ''
Daniel McArdle452a49f2019-02-14 17:28:31 +00003752
Alan Cuttera3be9a52019-03-04 18:50:33 +00003753 branch_display = FormatBranchName(branch)
3754 padding = ' ' * (alignment - len(branch_display))
3755 if not options.no_branch_color:
3756 branch_display = FormatBranchName(branch, colorize=True)
Daniel McArdle452a49f2019-02-14 17:28:31 +00003757
Alan Cuttera3be9a52019-03-04 18:50:33 +00003758 print(' %s : %s%s %s%s' % (padding + branch_display, color, url,
3759 status_str, reset))
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003760
vapiera7fbd5a2016-06-16 09:17:49 -07003761 print()
Daniel McArdlea23bf592019-02-12 00:25:12 +00003762 print('Current branch: %s' % current_branch)
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003763 for cl in changes:
Daniel McArdlea23bf592019-02-12 00:25:12 +00003764 if cl.GetBranch() == current_branch:
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003765 break
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003766 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07003767 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003768 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07003769 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00003770 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07003771 print('Issue description:')
Edward Lemur6c6827c2020-02-06 21:15:18 +00003772 print(cl.FetchDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003773 return 0
3774
3775
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003776def colorize_CMDstatus_doc():
3777 """To be called once in main() to add colors to git cl status help."""
3778 colors = [i for i in dir(Fore) if i[0].isupper()]
3779
3780 def colorize_line(line):
3781 for color in colors:
3782 if color in line.upper():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003783 # Extract whitespace first and the leading '-'.
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003784 indent = len(line) - len(line.lstrip(' ')) + 1
3785 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
3786 return line
3787
3788 lines = CMDstatus.__doc__.splitlines()
3789 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
3790
3791
phajdan.jre328cf92016-08-22 04:12:17 -07003792def write_json(path, contents):
Stefan Zager1306bd02017-06-22 19:26:46 -07003793 if path == '-':
3794 json.dump(contents, sys.stdout)
3795 else:
3796 with open(path, 'w') as f:
3797 json.dump(contents, f)
phajdan.jre328cf92016-08-22 04:12:17 -07003798
3799
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003800@subcommand.usage('[issue_number]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003801@metrics.collector.collect_metrics('git cl issue')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003802def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003803 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003804
3805 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003806 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00003807 parser.add_option('-r', '--reverse', action='store_true',
3808 help='Lookup the branch(es) for the specified issues. If '
3809 'no issues are specified, all branches with mapped '
3810 'issues will be listed.')
Stefan Zager1306bd02017-06-22 19:26:46 -07003811 parser.add_option('--json',
3812 help='Path to JSON output file, or "-" for stdout.')
dnj@chromium.org406c4402015-03-03 17:22:28 +00003813 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003814
dnj@chromium.org406c4402015-03-03 17:22:28 +00003815 if options.reverse:
3816 branches = RunGit(['for-each-ref', 'refs/heads',
Aaron Gablead64abd2017-12-04 09:49:13 -08003817 '--format=%(refname)']).splitlines()
dnj@chromium.org406c4402015-03-03 17:22:28 +00003818 # Reverse issue lookup.
3819 issue_branch_map = {}
Daniel Bratellb56a43a2018-09-06 15:49:03 +00003820
3821 git_config = {}
3822 for config in RunGit(['config', '--get-regexp',
3823 r'branch\..*issue']).splitlines():
3824 name, _space, val = config.partition(' ')
3825 git_config[name] = val
3826
dnj@chromium.org406c4402015-03-03 17:22:28 +00003827 for branch in branches:
Edward Lesmes50da7702020-03-30 19:23:43 +00003828 issue = git_config.get(
3829 'branch.%s.%s' % (scm.GIT.ShortBranchName(branch), ISSUE_CONFIG_KEY))
Edward Lemur52969c92020-02-06 18:15:28 +00003830 if issue:
3831 issue_branch_map.setdefault(int(issue), []).append(branch)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003832 if not args:
Carlos Caballero81923d62020-07-06 18:22:27 +00003833 args = sorted(issue_branch_map.keys())
phajdan.jre328cf92016-08-22 04:12:17 -07003834 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00003835 for issue in args:
Lei Zhang5a368d42019-03-25 23:18:19 +00003836 try:
3837 issue_num = int(issue)
3838 except ValueError:
3839 print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003840 continue
Lei Zhang5a368d42019-03-25 23:18:19 +00003841 result[issue_num] = issue_branch_map.get(issue_num)
vapiera7fbd5a2016-06-16 09:17:49 -07003842 print('Branch for issue number %s: %s' % (
Lei Zhang5a368d42019-03-25 23:18:19 +00003843 issue, ', '.join(issue_branch_map.get(issue_num) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07003844 if options.json:
3845 write_json(options.json, result)
Aaron Gable78753da2017-06-15 10:35:49 -07003846 return 0
3847
3848 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003849 issue = ParseIssueNumberArgument(args[0])
Aaron Gable78753da2017-06-15 10:35:49 -07003850 if not issue.valid:
3851 DieWithError('Pass a url or number to set the issue, 0 to unset it, '
3852 'or no argument to list it.\n'
3853 'Maybe you want to run git cl status?')
Edward Lemurf38bc172019-09-03 21:02:13 +00003854 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003855 cl.SetIssue(issue.issue)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003856 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003857 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003858 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
3859 if options.json:
3860 write_json(options.json, {
Nodir Turakulov27379632021-03-17 18:53:29 +00003861 'gerrit_host': cl.GetGerritHost(),
3862 'gerrit_project': cl.GetGerritProject(),
Aaron Gable78753da2017-06-15 10:35:49 -07003863 'issue_url': cl.GetIssueURL(),
Nodir Turakulov27379632021-03-17 18:53:29 +00003864 'issue': cl.GetIssue(),
Aaron Gable78753da2017-06-15 10:35:49 -07003865 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003866 return 0
3867
3868
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003869@metrics.collector.collect_metrics('git cl comments')
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003870def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003871 """Shows or posts review comments for any changelist."""
3872 parser.add_option('-a', '--add-comment', dest='comment',
3873 help='comment to add to an issue')
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003874 parser.add_option('-p', '--publish', action='store_true',
3875 help='marks CL as ready and sends comment to reviewers')
Andrii Shyshkalov0d6b46e2017-03-17 22:23:22 +01003876 parser.add_option('-i', '--issue', dest='issue',
Edward Lemurf38bc172019-09-03 21:02:13 +00003877 help='review issue id (defaults to current issue).')
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003878 parser.add_option('-m', '--machine-readable', dest='readable',
3879 action='store_false', default=True,
3880 help='output comments in a format compatible with '
3881 'editor parsing')
smut@google.comc85ac942015-09-15 16:34:43 +00003882 parser.add_option('-j', '--json-file',
Stefan Zager1306bd02017-06-22 19:26:46 -07003883 help='File to write JSON summary to, or "-" for stdout')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003884 options, args = parser.parse_args(args)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003885
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003886 issue = None
3887 if options.issue:
3888 try:
3889 issue = int(options.issue)
3890 except ValueError:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003891 DieWithError('A review issue ID is expected to be a number.')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003892
Edward Lemur934836a2019-09-09 20:16:54 +00003893 cl = Changelist(issue=issue)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003894
3895 if options.comment:
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003896 cl.AddComment(options.comment, options.publish)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003897 return 0
3898
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003899 summary = sorted(cl.GetCommentsSummary(readable=options.readable),
3900 key=lambda c: c.date)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003901 for comment in summary:
3902 if comment.disapproval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003903 color = Fore.RED
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003904 elif comment.approval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003905 color = Fore.GREEN
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003906 elif comment.sender == cl.GetIssueOwner():
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003907 color = Fore.MAGENTA
Quinten Yearsley0e617c02019-02-20 00:37:03 +00003908 elif comment.autogenerated:
3909 color = Fore.CYAN
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003910 else:
3911 color = Fore.BLUE
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003912 print('\n%s%s %s%s\n%s' % (
3913 color,
3914 comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'),
3915 comment.sender,
3916 Fore.RESET,
3917 '\n'.join(' ' + l for l in comment.message.strip().splitlines())))
3918
smut@google.comc85ac942015-09-15 16:34:43 +00003919 if options.json_file:
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003920 def pre_serialize(c):
Edward Lemur79d4f992019-11-11 23:49:02 +00003921 dct = c._asdict().copy()
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003922 dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f')
3923 return dct
Edward Lemur79d4f992019-11-11 23:49:02 +00003924 write_json(options.json_file, [pre_serialize(x) for x in summary])
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003925 return 0
3926
3927
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003928@subcommand.usage('[codereview url or issue id]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003929@metrics.collector.collect_metrics('git cl description')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003930def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003931 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00003932 parser.add_option('-d', '--display', action='store_true',
3933 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003934 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07003935 help='New description to set for this issue (- for stdin, '
3936 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07003937 parser.add_option('-f', '--force', action='store_true',
3938 help='Delete any unpublished Gerrit edits for this issue '
3939 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003940
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003941 options, args = parser.parse_args(args)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003942
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003943 target_issue_arg = None
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003944 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003945 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003946 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003947 parser.error('Invalid issue ID or URL.')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003948
Edward Lemur934836a2019-09-09 20:16:54 +00003949 kwargs = {}
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01003950 if target_issue_arg:
3951 kwargs['issue'] = target_issue_arg.issue
3952 kwargs['codereview_host'] = target_issue_arg.hostname
martiniss6eda05f2016-06-30 10:18:35 -07003953
3954 cl = Changelist(**kwargs)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003955 if not cl.GetIssue():
3956 DieWithError('This branch has no associated changelist.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02003957
Edward Lemur678a6842019-10-03 22:25:05 +00003958 if args and not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00003959 logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02003960
Edward Lemur6c6827c2020-02-06 21:15:18 +00003961 description = ChangeDescription(cl.FetchDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003962
smut@google.com34fb6b12015-07-13 20:03:26 +00003963 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07003964 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00003965 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003966
3967 if options.new_description:
3968 text = options.new_description
3969 if text == '-':
3970 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07003971 elif text == '+':
3972 base_branch = cl.GetCommonAncestorWithUpstream()
Edward Lemura12175c2020-03-09 16:58:26 +00003973 text = _create_description_from_log([base_branch])
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003974
3975 description.set_description(text)
3976 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003977 description.prompt()
Edward Lemur6c6827c2020-02-06 21:15:18 +00003978 if cl.FetchDescription().strip() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07003979 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003980 return 0
3981
3982
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003983@metrics.collector.collect_metrics('git cl lint')
thestig@chromium.org44202a22014-03-11 19:22:18 +00003984def CMDlint(parser, args):
3985 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00003986 parser.add_option('--filter', action='append', metavar='-x,+y',
3987 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003988 options, args = parser.parse_args(args)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003989
3990 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003991 # pylint: disable=protected-access
thestig@chromium.org44202a22014-03-11 19:22:18 +00003992 try:
3993 import cpplint
3994 import cpplint_chromium
3995 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07003996 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00003997 return 1
3998
3999 # Change the current working directory before calling lint so that it
4000 # shows the correct base.
4001 previous_cwd = os.getcwd()
4002 os.chdir(settings.GetRoot())
4003 try:
Edward Lemur934836a2019-09-09 20:16:54 +00004004 cl = Changelist()
Edward Lemur2c62b332020-03-12 22:12:33 +00004005 files = cl.GetAffectedFiles(cl.GetCommonAncestorWithUpstream())
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004006 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07004007 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004008 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00004009
Lei Zhangb8c62cf2020-07-15 20:09:37 +00004010 # Process cpplint arguments, if any.
4011 filters = presubmit_canned_checks.GetCppLintFilters(options.filter)
4012 command = ['--filter=' + ','.join(filters)] + args + files
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004013 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004014
Lei Zhang379d1ad2020-07-15 19:40:06 +00004015 include_regex = re.compile(settings.GetLintRegex())
4016 ignore_regex = re.compile(settings.GetLintIgnoreRegex())
thestig@chromium.org44202a22014-03-11 19:22:18 +00004017 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
4018 for filename in filenames:
Lei Zhang379d1ad2020-07-15 19:40:06 +00004019 if not include_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07004020 print('Skipping file %s' % filename)
Lei Zhang379d1ad2020-07-15 19:40:06 +00004021 continue
4022
4023 if ignore_regex.match(filename):
4024 print('Ignoring file %s' % filename)
4025 continue
4026
4027 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
4028 extra_check_functions)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004029 finally:
4030 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07004031 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004032 if cpplint._cpplint_state.error_count != 0:
4033 return 1
4034 return 0
4035
4036
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004037@metrics.collector.collect_metrics('git cl presubmit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004038def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004039 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004040 parser.add_option('-u', '--upload', action='store_true',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004041 help='Run upload hook instead of the push hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004042 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00004043 help='Run checks even if tree is dirty')
Aaron Gable8076c282017-11-29 14:39:41 -08004044 parser.add_option('--all', action='store_true',
4045 help='Run checks against all files, not just modified ones')
Edward Lesmes8e282792018-04-03 18:50:29 -04004046 parser.add_option('--parallel', action='store_true',
4047 help='Run all tests specified by input_api.RunTests in all '
4048 'PRESUBMIT files in parallel.')
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004049 parser.add_option('--resultdb', action='store_true',
4050 help='Run presubmit checks in the ResultSink environment '
4051 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004052 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004053 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004054
sbc@chromium.org71437c02015-04-09 19:29:40 +00004055 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07004056 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004057 return 1
4058
Edward Lemur934836a2019-09-09 20:16:54 +00004059 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004060 if args:
4061 base_branch = args[0]
4062 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004063 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004064 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004065
Gregory Nisbet29d5cf82020-02-27 08:16:58 +00004066 if cl.GetIssue():
4067 description = cl.FetchDescription()
Aaron Gable8076c282017-11-29 14:39:41 -08004068 else:
Edward Lemura12175c2020-03-09 16:58:26 +00004069 description = _create_description_from_log([base_branch])
Aaron Gable8076c282017-11-29 14:39:41 -08004070
ilevy@chromium.org051ad0e2013-03-04 21:57:34 +00004071 cl.RunHook(
4072 committing=not options.upload,
4073 may_prompt=False,
4074 verbose=options.verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00004075 parallel=options.parallel,
4076 upstream=base_branch,
4077 description=description,
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004078 all_files=options.all,
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004079 resultdb=options.resultdb,
4080 realm=options.realm)
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00004081 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004082
4083
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004084def GenerateGerritChangeId(message):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004085 """Returns the Change ID footer value (Ixxxxxx...xxx).
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004086
4087 Works the same way as
4088 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
4089 but can be called on demand on all platforms.
4090
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004091 The basic idea is to generate git hash of a state of the tree, original
4092 commit message, author/committer info and timestamps.
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004093 """
4094 lines = []
4095 tree_hash = RunGitSilent(['write-tree'])
4096 lines.append('tree %s' % tree_hash.strip())
4097 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
4098 if code == 0:
4099 lines.append('parent %s' % parent.strip())
4100 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
4101 lines.append('author %s' % author.strip())
4102 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
4103 lines.append('committer %s' % committer.strip())
4104 lines.append('')
4105 # Note: Gerrit's commit-hook actually cleans message of some lines and
4106 # whitespace. This code is not doing this, but it clearly won't decrease
4107 # entropy.
4108 lines.append(message)
4109 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
Raul Tambreb946b232019-03-26 14:48:46 +00004110 stdin=('\n'.join(lines)).encode())
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004111 return 'I%s' % change_hash.strip()
4112
4113
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01004114def GetTargetRef(remote, remote_branch, target_branch):
wittman@chromium.org455dc922015-01-26 20:15:50 +00004115 """Computes the remote branch ref to use for the CL.
4116
4117 Args:
4118 remote (str): The git remote for the CL.
4119 remote_branch (str): The git remote branch for the CL.
4120 target_branch (str): The target branch specified by the user.
wittman@chromium.org455dc922015-01-26 20:15:50 +00004121 """
4122 if not (remote and remote_branch):
4123 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004124
wittman@chromium.org455dc922015-01-26 20:15:50 +00004125 if target_branch:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004126 # Canonicalize branch references to the equivalent local full symbolic
wittman@chromium.org455dc922015-01-26 20:15:50 +00004127 # refs, which are then translated into the remote full symbolic refs
4128 # below.
4129 if '/' not in target_branch:
4130 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4131 else:
4132 prefix_replacements = (
4133 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4134 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4135 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4136 )
4137 match = None
4138 for regex, replacement in prefix_replacements:
4139 match = re.search(regex, target_branch)
4140 if match:
4141 remote_branch = target_branch.replace(match.group(0), replacement)
4142 break
4143 if not match:
4144 # This is a branch path but not one we recognize; use as-is.
4145 remote_branch = target_branch
rmistry@google.comc68112d2015-03-03 12:48:06 +00004146 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
4147 # Handle the refs that need to land in different refs.
4148 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004149
wittman@chromium.org455dc922015-01-26 20:15:50 +00004150 # Create the true path to the remote branch.
4151 # Does the following translation:
4152 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004153 # * refs/remotes/origin/main -> refs/heads/main
wittman@chromium.org455dc922015-01-26 20:15:50 +00004154 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4155 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4156 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4157 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4158 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4159 'refs/heads/')
4160 elif remote_branch.startswith('refs/remotes/branch-heads'):
4161 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +01004162
wittman@chromium.org455dc922015-01-26 20:15:50 +00004163 return remote_branch
4164
4165
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004166def cleanup_list(l):
4167 """Fixes a list so that comma separated items are put as individual items.
4168
4169 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4170 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4171 """
4172 items = sum((i.split(',') for i in l), [])
4173 stripped_items = (i.strip() for i in items)
4174 return sorted(filter(None, stripped_items))
4175
4176
Aaron Gable4db38df2017-11-03 14:59:07 -07004177@subcommand.usage('[flags]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004178@metrics.collector.collect_metrics('git cl upload')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004179def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004180 """Uploads the current changelist to codereview.
4181
4182 Can skip dependency patchset uploads for a branch by running:
4183 git config branch.branch_name.skip-deps-uploads True
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004184 To unset, run:
rmistry@google.com78948ed2015-07-08 23:09:57 +00004185 git config --unset branch.branch_name.skip-deps-uploads
4186 Can also set the above globally by using the --global flag.
Dominic Battre7d1c4842017-10-27 09:17:28 +02004187
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004188 If the name of the checked out branch starts with "bug-" or "fix-" followed
4189 by a bug number, this bug number is automatically populated in the CL
Dominic Battre7d1c4842017-10-27 09:17:28 +02004190 description.
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004191
4192 If subject contains text in square brackets or has "<text>: " prefix, such
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004193 text(s) is treated as Gerrit hashtags. For example, CLs with subjects:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004194 [git-cl] add support for hashtags
4195 Foo bar: implement foo
4196 will be hashtagged with "git-cl" and "foo-bar" respectively.
rmistry@google.com78948ed2015-07-08 23:09:57 +00004197 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004198 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4199 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004200 parser.add_option('--bypass-watchlists', action='store_true',
4201 dest='bypass_watchlists',
4202 help='bypass watchlists auto CC-ing reviewers')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004203 parser.add_option('-f', '--force', action='store_true', dest='force',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004204 help="force yes to questions (don't prompt)")
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004205 parser.add_option('--message', '-m', dest='message',
4206 help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004207 parser.add_option('-b', '--bug',
4208 help='pre-populate the bug number(s) for this issue. '
4209 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004210 parser.add_option('--message-file', dest='message_file',
4211 help='file which contains message for patchset')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004212 parser.add_option('--title', '-t', dest='title',
4213 help='title for patchset')
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004214 parser.add_option('-T', '--skip-title', action='store_true',
4215 dest='skip_title',
4216 help='Use the most recent commit message as the title of '
4217 'the patchset')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004218 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004219 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004220 help='reviewer email addresses')
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004221 parser.add_option('--tbrs',
4222 action='append', default=[],
4223 help='TBR email addresses')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004224 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004225 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004226 help='cc email addresses')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004227 parser.add_option('--hashtag', dest='hashtags',
4228 action='append', default=[],
4229 help=('Gerrit hashtag for new CL; '
4230 'can be applied multiple times'))
adamk@chromium.org36f47302013-04-05 01:08:31 +00004231 parser.add_option('-s', '--send-mail', action='store_true',
Aaron Gable59f48512017-01-12 10:54:46 -08004232 help='send email to reviewer(s) and cc(s) immediately')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004233 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004234 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004235 metavar='TARGET',
4236 help='Apply CL to remote ref TARGET. ' +
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004237 'Default: remote branch head, or main')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004238 parser.add_option('--squash', action='store_true',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004239 help='Squash multiple commits into one')
Mike Frysingera989d552019-08-14 20:51:23 +00004240 parser.add_option('--no-squash', action='store_false', dest='squash',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004241 help='Don\'t squash multiple commits into one')
rmistry9eadede2016-09-19 11:22:43 -07004242 parser.add_option('--topic', default=None,
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004243 help='Topic to specify when uploading')
Robert Iannuccif2708bd2017-04-17 15:49:02 -07004244 parser.add_option('--tbr-owners', dest='add_owners_to', action='store_const',
4245 const='TBR', help='add a set of OWNERS to TBR')
4246 parser.add_option('--r-owners', dest='add_owners_to', action='store_const',
4247 const='R', help='add a set of OWNERS to R')
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004248 parser.add_option('-c', '--use-commit-queue', action='store_true',
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004249 default=False,
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004250 help='tell the CQ to commit this patchset; '
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004251 'implies --send-mail')
4252 parser.add_option('-d', '--cq-dry-run',
4253 action='store_true', default=False,
rmistry@google.comef966222015-04-07 11:15:01 +00004254 help='Send the patchset to do a CQ dry run right after '
4255 'upload.')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004256 parser.add_option(
4257 '-q',
4258 '--cq-quick-run',
4259 action='store_true',
4260 default=False,
4261 help='Send the patchset to do a CQ quick run right after '
4262 'upload (https://source.chromium.org/chromium/chromium/src/+/main:do'
4263 'cs/cq_quick_run.md) (chromium only).')
Edward Lesmes10c3dd62021-02-08 21:13:57 +00004264 parser.add_option('--set-bot-commit', action='store_true',
4265 help=optparse.SUPPRESS_HELP)
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00004266 parser.add_option('--preserve-tryjobs', action='store_true',
4267 help='instruct the CQ to let tryjobs running even after '
4268 'new patchsets are uploaded instead of canceling '
4269 'prior patchset\' tryjobs')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004270 parser.add_option('--dependencies', action='store_true',
4271 help='Uploads CLs of all the local branches that depend on '
4272 'the current branch')
Ravi Mistry31e7d562018-04-02 12:53:57 -04004273 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4274 help='Sends your change to the CQ after an approval. Only '
4275 'works on repos that have the Auto-Submit label '
4276 'enabled')
Edward Lesmes8e282792018-04-03 18:50:29 -04004277 parser.add_option('--parallel', action='store_true',
4278 help='Run all tests specified by input_api.RunTests in all '
4279 'PRESUBMIT files in parallel.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004280 parser.add_option('--no-autocc', action='store_true',
4281 help='Disables automatic addition of CC emails')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004282 parser.add_option('--private', action='store_true',
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004283 help='Set the review private. This implies --no-autocc.')
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004284 parser.add_option('-R', '--retry-failed', action='store_true',
4285 help='Retry failed tryjobs from old patchset immediately '
4286 'after uploading new patchset. Cannot be used with '
4287 '--use-commit-queue or --cq-dry-run.')
4288 parser.add_option('--buildbucket-host', default='cr-buildbucket.appspot.com',
4289 help='Host of buildbucket. The default host is %default.')
Dan Beamd8b04ca2019-10-10 21:23:26 +00004290 parser.add_option('--fixed', '-x',
4291 help='List of bugs that will be commented on and marked '
4292 'fixed (pre-populates "Fixed:" tag). Same format as '
4293 '-b option / "Bug:" tag. If fixing several issues, '
4294 'separate with commas.')
Josipe827b0f2020-01-30 00:07:20 +00004295 parser.add_option('--edit-description', action='store_true', default=False,
4296 help='Modify description before upload. Cannot be used '
4297 'with --force. It is a noop when --no-squash is set '
4298 'or a new commit is created.')
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004299 parser.add_option('--git-completion-helper', action="store_true",
4300 help=optparse.SUPPRESS_HELP)
Saagar Sanghavi9949ab72020-07-20 20:56:40 +00004301 parser.add_option('--resultdb', action='store_true',
4302 help='Run presubmit checks in the ResultSink environment '
4303 'and send results to the ResultDB database.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004304 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Josip Sokcevicf2cfd3d2021-03-30 18:39:18 +00004305 parser.add_option('-o',
4306 '--push-options',
4307 action='append',
4308 default=[],
4309 help='Transmit the given string to the server when '
4310 'performing git push (pass-through). See git-push '
4311 'documentation for more details.')
Gregory Nisbet48d9e1e2021-04-15 23:35:54 +00004312 parser.add_option('--no-add-changeid',
4313 action='store_true',
4314 dest='no_add_changeid',
4315 help='Do not add change-ids to messages.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004316
rmistry@google.com2dd99862015-06-22 12:22:18 +00004317 orig_args = args
ukai@chromium.orge8077812012-02-03 03:41:46 +00004318 (options, args) = parser.parse_args(args)
4319
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004320 if options.git_completion_helper:
Edward Lesmesb7db1832020-06-22 20:22:27 +00004321 print(' '.join(opt.get_opt_string() for opt in parser.option_list
4322 if opt.help != optparse.SUPPRESS_HELP))
4323 return
Ng Zhi Ancdaf0be2020-05-27 20:57:28 +00004324
sbc@chromium.org71437c02015-04-09 19:29:40 +00004325 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004326 return 1
4327
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004328 options.reviewers = cleanup_list(options.reviewers)
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004329 options.tbrs = cleanup_list(options.tbrs)
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004330 options.cc = cleanup_list(options.cc)
4331
Josipe827b0f2020-01-30 00:07:20 +00004332 if options.edit_description and options.force:
4333 parser.error('Only one of --force and --edit-description allowed')
4334
tandriib80458a2016-06-23 12:20:07 -07004335 if options.message_file:
4336 if options.message:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004337 parser.error('Only one of --message and --message-file allowed.')
tandriib80458a2016-06-23 12:20:07 -07004338 options.message = gclient_utils.FileRead(options.message_file)
tandriib80458a2016-06-23 12:20:07 -07004339
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004340 if ([options.cq_dry_run,
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004341 options.cq_quick_run,
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004342 options.use_commit_queue,
4343 options.retry_failed].count(True) > 1):
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004344 parser.error('Only one of --use-commit-queue, --cq-dry-run, --cq-quick-run '
4345 'or --retry-failed is allowed.')
tandrii4d0545a2016-07-06 03:56:49 -07004346
Mario Bianuccicebfb4e2020-07-22 23:08:16 +00004347 if options.skip_title and options.title:
4348 parser.error('Only one of --title and --skip-title allowed.')
4349
Aaron Gableedbc4132017-09-11 13:22:28 -07004350 if options.use_commit_queue:
4351 options.send_mail = True
4352
Edward Lesmes0dd54822020-03-26 18:24:25 +00004353 if options.squash is None:
4354 # Load default for user, repo, squash=true, in this order.
4355 options.squash = settings.GetSquashGerritUploads()
4356
Josip Sokcevic1cabb172021-04-08 19:15:35 +00004357 cl = Changelist(branchref=options.target_branch)
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004358 # Warm change details cache now to avoid RPCs later, reducing latency for
4359 # developers.
4360 if cl.GetIssue():
4361 cl._GetChangeDetail(
4362 ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS'])
4363
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004364 if options.retry_failed and not cl.GetIssue():
4365 print('No previous patchsets, so --retry-failed has no effect.')
4366 options.retry_failed = False
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004367
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004368 # cl.GetMostRecentPatchset uses cached information, and can return the last
4369 # patchset before upload. Calling it here makes it clear that it's the
4370 # last patchset before upload. Note that GetMostRecentPatchset will fail
4371 # if no CL has been uploaded yet.
4372 if options.retry_failed:
4373 patchset = cl.GetMostRecentPatchset()
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00004374
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004375 ret = cl.CMDUpload(options, args, orig_args)
4376
4377 if options.retry_failed:
4378 if ret != 0:
4379 print('Upload failed, so --retry-failed has no effect.')
4380 return ret
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +00004381 builds, _ = _fetch_latest_builds(
Edward Lemur5b929a42019-10-21 17:57:39 +00004382 cl, options.buildbucket_host, latest_patchset=patchset)
Edward Lemur45768512020-03-02 19:03:14 +00004383 jobs = _filter_failed_for_retry(builds)
4384 if len(jobs) == 0:
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004385 print('No failed tryjobs, so --retry-failed has no effect.')
4386 return ret
Quinten Yearsley777660f2020-03-04 23:37:06 +00004387 _trigger_tryjobs(cl, jobs, options, patchset + 1)
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004388
4389 return ret
ukai@chromium.orge8077812012-02-03 03:41:46 +00004390
4391
Francois Dorayd42c6812017-05-30 15:10:20 -04004392@subcommand.usage('--description=<description file>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004393@metrics.collector.collect_metrics('git cl split')
Francois Dorayd42c6812017-05-30 15:10:20 -04004394def CMDsplit(parser, args):
4395 """Splits a branch into smaller branches and uploads CLs.
4396
4397 Creates a branch and uploads a CL for each group of files modified in the
4398 current branch that share a common OWNERS file. In the CL description and
Edward Lemurac5c55f2020-02-29 00:17:16 +00004399 comment, the string '$directory', is replaced with the directory containing
4400 the shared OWNERS file.
Francois Dorayd42c6812017-05-30 15:10:20 -04004401 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004402 parser.add_option('-d', '--description', dest='description_file',
4403 help='A text file containing a CL description in which '
4404 '$directory will be replaced by each CL\'s directory.')
4405 parser.add_option('-c', '--comment', dest='comment_file',
4406 help='A text file containing a CL comment.')
4407 parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true',
Chris Watkinsba28e462017-12-13 11:22:17 +11004408 default=False,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004409 help='List the files and reviewers for each CL that would '
4410 'be created, but don\'t create branches or CLs.')
4411 parser.add_option('--cq-dry-run', action='store_true',
4412 help='If set, will do a cq dry run for each uploaded CL. '
4413 'Please be careful when doing this; more than ~10 CLs '
4414 'has the potential to overload our build '
4415 'infrastructure. Try to upload these not during high '
4416 'load times (usually 11-3 Mountain View time). Email '
4417 'infra-dev@chromium.org with any questions.')
Takuto Ikuta51eca592019-02-14 19:40:52 +00004418 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4419 default=True,
4420 help='Sends your change to the CQ after an approval. Only '
4421 'works on repos that have the Auto-Submit label '
4422 'enabled')
Francois Dorayd42c6812017-05-30 15:10:20 -04004423 options, _ = parser.parse_args(args)
4424
4425 if not options.description_file:
4426 parser.error('No --description flag specified.')
4427
4428 def WrappedCMDupload(args):
4429 return CMDupload(OptionParser(), args)
4430
Edward Lemur2c62b332020-03-12 22:12:33 +00004431 return split_cl.SplitCl(
4432 options.description_file, options.comment_file, Changelist,
4433 WrappedCMDupload, options.dry_run, options.cq_dry_run,
4434 options.enable_auto_submit, settings.GetRoot())
Francois Dorayd42c6812017-05-30 15:10:20 -04004435
4436
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004437@subcommand.usage('DEPRECATED')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004438@metrics.collector.collect_metrics('git cl commit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004439def CMDdcommit(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004440 """DEPRECATED: Used to commit the current changelist via git-svn."""
4441 message = ('git-cl no longer supports committing to SVN repositories via '
4442 'git-svn. You probably want to use `git cl land` instead.')
4443 print(message)
4444 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004445
4446
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004447@subcommand.usage('[upstream branch to apply against]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004448@metrics.collector.collect_metrics('git cl land')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004449def CMDland(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004450 """Commits the current changelist via git.
4451
4452 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4453 upstream and closes the issue automatically and atomically.
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004454 """
4455 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4456 help='bypass upload presubmit hook')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004457 parser.add_option('-f', '--force', action='store_true', dest='force',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004458 help="force yes to questions (don't prompt)")
Edward Lesmes67b3faa2018-04-13 17:50:52 -04004459 parser.add_option('--parallel', action='store_true',
4460 help='Run all tests specified by input_api.RunTests in all '
4461 'PRESUBMIT files in parallel.')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004462 parser.add_option('--resultdb', action='store_true',
4463 help='Run presubmit checks in the ResultSink environment '
4464 'and send results to the ResultDB database.')
4465 parser.add_option('--realm', help='LUCI realm if reporting to ResultDB')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004466 (options, args) = parser.parse_args(args)
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004467
Edward Lemur934836a2019-09-09 20:16:54 +00004468 cl = Changelist()
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004469
Robert Iannucci2e73d432018-03-14 01:10:47 -07004470 if not cl.GetIssue():
4471 DieWithError('You must upload the change first to Gerrit.\n'
4472 ' If you would rather have `git cl land` upload '
4473 'automatically for you, see http://crbug.com/642759')
Saagar Sanghavi03b15132020-08-10 16:43:41 +00004474 return cl.CMDLand(options.force, options.bypass_hooks, options.verbose,
4475 options.parallel, options.resultdb, options.realm)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004476
4477
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004478@subcommand.usage('<patch url or issue id or issue url>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004479@metrics.collector.collect_metrics('git cl patch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004480def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004481 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004482 parser.add_option('-b', dest='newbranch',
4483 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004484 parser.add_option('-f', '--force', action='store_true',
Aaron Gable62619a32017-06-16 08:22:09 -07004485 help='overwrite state on the current or chosen branch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004486 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
Edward Lemurf38bc172019-09-03 21:02:13 +00004487 help='don\'t commit after patch applies.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004488
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004489 group = optparse.OptionGroup(
4490 parser,
4491 'Options for continuing work on the current issue uploaded from a '
4492 'different clone (e.g. different machine). Must be used independently '
4493 'from the other options. No issue number should be specified, and the '
4494 'branch must have an issue number associated with it')
4495 group.add_option('--reapply', action='store_true', dest='reapply',
4496 help='Reset the branch and reapply the issue.\n'
4497 'CAUTION: This will undo any local changes in this '
4498 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004499
4500 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004501 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004502 parser.add_option_group(group)
4503
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004504 (options, args) = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004505
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004506 if options.reapply:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004507 if options.newbranch:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004508 parser.error('--reapply works on the current branch only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004509 if len(args) > 0:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004510 parser.error('--reapply implies no additional arguments.')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004511
Edward Lemur934836a2019-09-09 20:16:54 +00004512 cl = Changelist()
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004513 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004514 parser.error('Current branch must have an associated issue.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004515
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004516 upstream = cl.GetUpstreamBranch()
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004517 if upstream is None:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004518 parser.error('No upstream branch specified. Cannot reset branch.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004519
4520 RunGit(['reset', '--hard', upstream])
4521 if options.pull:
4522 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004523
Edward Lemur678a6842019-10-03 22:25:05 +00004524 target_issue_arg = ParseIssueNumberArgument(cl.GetIssue())
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004525 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, False,
4526 False)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004527
4528 if len(args) != 1 or not args[0]:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004529 parser.error('Must specify issue number or URL.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004530
Edward Lemurf38bc172019-09-03 21:02:13 +00004531 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004532 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004533 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004534
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004535 # We don't want uncommitted changes mixed up with the patch.
4536 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004537 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004538
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004539 if options.newbranch:
4540 if options.force:
4541 RunGit(['branch', '-D', options.newbranch],
4542 stderr=subprocess2.PIPE, error_ok=True)
Edward Lemur84101642020-02-21 21:40:34 +00004543 git_new_branch.create_new_branch(options.newbranch)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004544
Edward Lemur678a6842019-10-03 22:25:05 +00004545 cl = Changelist(
4546 codereview_host=target_issue_arg.hostname, issue=target_issue_arg.issue)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004547
Edward Lemur678a6842019-10-03 22:25:05 +00004548 if not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004549 print('canonical issue/change URL: %s\n' % cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004550
Bruce Dawsonf362f6f2021-02-18 23:15:17 +00004551 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit,
4552 options.force, options.newbranch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004553
4554
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004555def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004556 """Fetches the tree status and returns either 'open', 'closed',
4557 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004558 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004559 if url:
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004560 status = str(urllib.request.urlopen(url).read().lower())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004561 if status.find('closed') != -1 or status == '0':
4562 return 'closed'
4563 elif status.find('open') != -1 or status == '1':
4564 return 'open'
4565 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004566 return 'unset'
4567
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004568
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004569def GetTreeStatusReason():
4570 """Fetches the tree status from a json url and returns the message
4571 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004572 url = settings.GetTreeStatusUrl()
Daniel McArdle8b4eeff2020-07-20 17:02:47 +00004573 json_url = urllib.parse.urljoin(url, '/current?format=json')
Edward Lemur79d4f992019-11-11 23:49:02 +00004574 connection = urllib.request.urlopen(json_url)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004575 status = json.loads(connection.read())
4576 connection.close()
4577 return status['message']
4578
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004579
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004580@metrics.collector.collect_metrics('git cl tree')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004581def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004582 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004583 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004584 status = GetTreeStatus()
4585 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004586 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004587 return 2
4588
vapiera7fbd5a2016-06-16 09:17:49 -07004589 print('The tree is %s' % status)
4590 print()
4591 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004592 if status != 'open':
4593 return 1
4594 return 0
4595
4596
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004597@metrics.collector.collect_metrics('git cl try')
maruel@chromium.org15192402012-09-06 12:38:29 +00004598def CMDtry(parser, args):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004599 """Triggers tryjobs using either Buildbucket or CQ dry run."""
4600 group = optparse.OptionGroup(parser, 'Tryjob options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004601 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004602 '-b', '--bot', action='append',
4603 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4604 'times to specify multiple builders. ex: '
4605 '"-b win_rel -b win_layout". See '
4606 'the try server waterfall for the builders name and the tests '
4607 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004608 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004609 '-B', '--bucket', default='',
4610 help=('Buildbucket bucket to send the try requests.'))
4611 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004612 '-r', '--revision',
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004613 help='Revision to use for the tryjob; default: the revision will '
tandriif7b29d42016-10-07 08:45:41 -07004614 'be determined by the try recipe that builder runs, which usually '
Josip Sokcevicc39ab992020-09-24 20:09:15 +00004615 'defaults to HEAD of origin/master or origin/main')
maruel@chromium.org15192402012-09-06 12:38:29 +00004616 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004617 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004618 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004619 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004620 group.add_option(
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004621 '-q',
4622 '--quick-run',
4623 action='store_true',
4624 default=False,
4625 help='trigger in quick run mode '
4626 '(https://source.chromium.org/chromium/chromium/src/+/main:docs/cq_q'
4627 'uick_run.md) (chromium only).')
4628 group.add_option(
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004629 '--category', default='git_cl_try', help='Specify custom build category.')
4630 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004631 '--project',
4632 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004633 'in recipe to determine to which repository or directory to '
4634 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004635 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004636 '-p', '--property', dest='properties', action='append', default=[],
4637 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004638 'key2=value2 etc. The value will be treated as '
4639 'json if decodable, or as string otherwise. '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004640 'NOTE: using this may make your tryjob not usable for CQ, '
4641 'which will then schedule another tryjob with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004642 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004643 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4644 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004645 parser.add_option_group(group)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004646 parser.add_option(
4647 '-R', '--retry-failed', action='store_true', default=False,
4648 help='Retry failed jobs from the latest set of tryjobs. '
4649 'Not allowed with --bucket and --bot options.')
Edward Lemur52969c92020-02-06 18:15:28 +00004650 parser.add_option(
4651 '-i', '--issue', type=int,
4652 help='Operate on this issue instead of the current branch\'s implicit '
4653 'issue.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004654 options, args = parser.parse_args(args)
4655
machenbach@chromium.org45453142015-09-15 08:45:22 +00004656 # Make sure that all properties are prop=value pairs.
4657 bad_params = [x for x in options.properties if '=' not in x]
4658 if bad_params:
4659 parser.error('Got properties with missing "=": %s' % bad_params)
4660
maruel@chromium.org15192402012-09-06 12:38:29 +00004661 if args:
4662 parser.error('Unknown arguments: %s' % args)
4663
Edward Lemur934836a2019-09-09 20:16:54 +00004664 cl = Changelist(issue=options.issue)
maruel@chromium.org15192402012-09-06 12:38:29 +00004665 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004666 parser.error('Need to upload first.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004667
Edward Lemurf38bc172019-09-03 21:02:13 +00004668 # HACK: warm up Gerrit change detail cache to save on RPCs.
Edward Lemur125d60a2019-09-13 18:25:41 +00004669 cl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS'])
Andrii Shyshkaloveadad922017-01-26 09:38:30 +01004670
tandriie113dfd2016-10-11 10:20:12 -07004671 error_message = cl.CannotTriggerTryJobReason()
4672 if error_message:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004673 parser.error('Can\'t trigger tryjobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004674
Edward Lemur45768512020-03-02 19:03:14 +00004675 if options.bot:
4676 if options.retry_failed:
4677 parser.error('--bot is not compatible with --retry-failed.')
4678 if not options.bucket:
4679 parser.error('A bucket (e.g. "chromium/try") is required.')
4680
4681 triggered = [b for b in options.bot if 'triggered' in b]
4682 if triggered:
4683 parser.error(
4684 'Cannot schedule builds on triggered bots: %s.\n'
4685 'This type of bot requires an initial job from a parent (usually a '
4686 'builder). Schedule a job on the parent instead.\n' % triggered)
4687
4688 if options.bucket.startswith('.master'):
4689 parser.error('Buildbot masters are not supported.')
4690
4691 project, bucket = _parse_bucket(options.bucket)
4692 if project is None or bucket is None:
4693 parser.error('Invalid bucket: %s.' % options.bucket)
4694 jobs = sorted((project, bucket, bot) for bot in options.bot)
4695 elif options.retry_failed:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004696 print('Searching for failed tryjobs...')
Edward Lemur5b929a42019-10-21 17:57:39 +00004697 builds, patchset = _fetch_latest_builds(cl, options.buildbucket_host)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004698 if options.verbose:
4699 print('Got %d builds in patchset #%d' % (len(builds), patchset))
Edward Lemur45768512020-03-02 19:03:14 +00004700 jobs = _filter_failed_for_retry(builds)
4701 if not jobs:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004702 print('There are no failed jobs in the latest set of jobs '
4703 '(patchset #%d), doing nothing.' % patchset)
4704 return 0
Edward Lemur45768512020-03-02 19:03:14 +00004705 num_builders = len(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004706 if num_builders > 10:
4707 confirm_or_exit('There are %d builders with failed builds.'
4708 % num_builders, action='continue')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004709 elif options.quick_run:
4710 print('Scheduling CQ quick run on: %s' % cl.GetIssueURL())
4711 return cl.SetCQState(_CQState.QUICK_RUN)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004712 else:
qyearsley1fdfcb62016-10-24 13:22:03 -07004713 if options.verbose:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07004714 print('git cl try with no bots now defaults to CQ dry run.')
4715 print('Scheduling CQ dry run on: %s' % cl.GetIssueURL())
4716 return cl.SetCQState(_CQState.DRY_RUN)
stip@chromium.org43064fd2013-12-18 20:07:44 +00004717
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004718 patchset = cl.GetMostRecentPatchset()
Edward Lemur2c210a42019-09-16 23:58:35 +00004719 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004720 _trigger_tryjobs(cl, jobs, options, patchset)
Edward Lemur2c210a42019-09-16 23:58:35 +00004721 except BuildbucketResponseException as ex:
4722 print('ERROR: %s' % ex)
4723 return 1
4724 return 0
maruel@chromium.org15192402012-09-06 12:38:29 +00004725
4726
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004727@metrics.collector.collect_metrics('git cl try-results')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004728def CMDtry_results(parser, args):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004729 """Prints info about results for tryjobs associated with the current CL."""
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004730 group = optparse.OptionGroup(parser, 'Tryjob results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004731 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004732 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004733 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004734 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004735 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004736 '--color', action='store_true', default=setup_color.IS_TTY,
4737 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004738 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004739 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4740 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004741 group.add_option(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004742 '--json', help=('Path of JSON output file to write tryjob results to,'
Stefan Zager1306bd02017-06-22 19:26:46 -07004743 'or "-" for stdout.'))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004744 parser.add_option_group(group)
Edward Lemur52969c92020-02-06 18:15:28 +00004745 parser.add_option(
4746 '-i', '--issue', type=int,
4747 help='Operate on this issue instead of the current branch\'s implicit '
4748 'issue.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004749 options, args = parser.parse_args(args)
4750 if args:
4751 parser.error('Unrecognized args: %s' % ' '.join(args))
4752
Edward Lemur934836a2019-09-09 20:16:54 +00004753 cl = Changelist(issue=options.issue)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004754 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004755 parser.error('Need to upload first.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004756
tandrii221ab252016-10-06 08:12:04 -07004757 patchset = options.patchset
4758 if not patchset:
Gavin Make61ccc52020-11-13 00:12:57 +00004759 patchset = cl.GetMostRecentDryRunPatchset()
tandrii221ab252016-10-06 08:12:04 -07004760 if not patchset:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004761 parser.error('Code review host doesn\'t know about issue %s. '
tandrii221ab252016-10-06 08:12:04 -07004762 'No access to issue or wrong issue number?\n'
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004763 'Either upload first, or pass --patchset explicitly.' %
tandrii221ab252016-10-06 08:12:04 -07004764 cl.GetIssue())
4765
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004766 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004767 jobs = _fetch_tryjobs(cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004768 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004769 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004770 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004771 if options.json:
Edward Lemurbaaf6be2019-10-09 18:00:44 +00004772 write_json(options.json, jobs)
qyearsley53f48a12016-09-01 10:45:13 -07004773 else:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004774 _print_tryjobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004775 return 0
4776
4777
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004778@subcommand.usage('[new upstream branch]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004779@metrics.collector.collect_metrics('git cl upstream')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004780def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004781 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004782 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004783 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004784 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004785
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004786 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004787 if args:
4788 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004789 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07004790 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004791 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07004792 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004793
4794 # Clear configured merge-base, if there is one.
4795 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004796 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004797 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004798 return 0
4799
4800
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004801@metrics.collector.collect_metrics('git cl web')
thestig@chromium.org00858c82013-12-02 23:08:03 +00004802def CMDweb(parser, args):
4803 """Opens the current CL in the web browser."""
4804 _, args = parser.parse_args(args)
4805 if args:
4806 parser.error('Unrecognized args: %s' % ' '.join(args))
4807
4808 issue_url = Changelist().GetIssueURL()
4809 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07004810 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004811 return 1
4812
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004813 # Redirect I/O before invoking browser to hide its output. For example, this
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004814 # allows us to hide the "Created new window in existing browser session."
4815 # message from Chrome. Based on https://stackoverflow.com/a/2323563.
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004816 saved_stdout = os.dup(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004817 saved_stderr = os.dup(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004818 os.close(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004819 os.close(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004820 os.open(os.devnull, os.O_RDWR)
4821 try:
4822 webbrowser.open(issue_url)
4823 finally:
4824 os.dup2(saved_stdout, 1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004825 os.dup2(saved_stderr, 2)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004826 return 0
4827
4828
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004829@metrics.collector.collect_metrics('git cl set-commit')
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004830def CMDset_commit(parser, args):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004831 """Sets the commit bit to trigger the CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004832 parser.add_option('-d', '--dry-run', action='store_true',
4833 help='trigger in dry run mode')
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004834 parser.add_option(
4835 '-q',
4836 '--quick-run',
4837 action='store_true',
4838 help='trigger in quick run mode '
4839 '(https://source.chromium.org/chromium/chromium/src/+/main:docs/cq_qu'
4840 'ick_run.md) (chromium only).')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004841 parser.add_option('-c', '--clear', action='store_true',
4842 help='stop CQ run, if any')
Edward Lemur52969c92020-02-06 18:15:28 +00004843 parser.add_option(
4844 '-i', '--issue', type=int,
4845 help='Operate on this issue instead of the current branch\'s implicit '
4846 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004847 options, args = parser.parse_args(args)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004848 if args:
4849 parser.error('Unrecognized args: %s' % ' '.join(args))
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004850 if [options.dry_run, options.quick_run, options.clear].count(True) > 1:
4851 parser.error('Only one of --dry-run, --quick-run, and --clear are allowed.')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004852
Edward Lemur934836a2019-09-09 20:16:54 +00004853 cl = Changelist(issue=options.issue)
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004854 if not cl.GetIssue():
4855 parser.error('Must upload the issue first.')
4856
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004857 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07004858 state = _CQState.NONE
Greg Gutermanbe5fccd2021-06-14 17:58:20 +00004859 elif options.quick_run:
4860 state = _CQState.QUICK_RUN
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004861 elif options.dry_run:
4862 state = _CQState.DRY_RUN
4863 else:
4864 state = _CQState.COMMIT
tandrii9de9ec62016-07-13 03:01:59 -07004865 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004866 return 0
4867
4868
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004869@metrics.collector.collect_metrics('git cl set-close')
groby@chromium.org411034a2013-02-26 15:12:01 +00004870def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004871 """Closes the issue."""
Edward Lemur52969c92020-02-06 18:15:28 +00004872 parser.add_option(
4873 '-i', '--issue', type=int,
4874 help='Operate on this issue instead of the current branch\'s implicit '
4875 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004876 options, args = parser.parse_args(args)
groby@chromium.org411034a2013-02-26 15:12:01 +00004877 if args:
4878 parser.error('Unrecognized args: %s' % ' '.join(args))
Edward Lemur934836a2019-09-09 20:16:54 +00004879 cl = Changelist(issue=options.issue)
groby@chromium.org411034a2013-02-26 15:12:01 +00004880 # Ensure there actually is an issue to close.
Aaron Gable7139a4e2017-09-05 17:53:09 -07004881 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004882 DieWithError('ERROR: No issue to close.')
groby@chromium.org411034a2013-02-26 15:12:01 +00004883 cl.CloseIssue()
4884 return 0
4885
4886
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004887@metrics.collector.collect_metrics('git cl diff')
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004888def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00004889 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07004890 parser.add_option(
4891 '--stat',
4892 action='store_true',
4893 dest='stat',
4894 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004895 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004896 if args:
4897 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00004898
Edward Lemur934836a2019-09-09 20:16:54 +00004899 cl = Changelist()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004900 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004901 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004902 if not issue:
4903 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004904
Aaron Gablea718c3e2017-08-28 17:47:28 -07004905 base = cl._GitGetBranchConfigValue('last-upload-hash')
4906 if not base:
4907 base = cl._GitGetBranchConfigValue('gerritsquashhash')
4908 if not base:
4909 detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
4910 revision_info = detail['revisions'][detail['current_revision']]
4911 fetch_info = revision_info['fetch']['http']
4912 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
4913 base = 'FETCH_HEAD'
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004914
Aaron Gablea718c3e2017-08-28 17:47:28 -07004915 cmd = ['git', 'diff']
4916 if options.stat:
4917 cmd.append('--stat')
4918 cmd.append(base)
4919 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004920
4921 return 0
4922
4923
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004924@metrics.collector.collect_metrics('git cl owners')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004925def CMDowners(parser, args):
Dirk Prankebf980882017-09-02 15:08:00 -07004926 """Finds potential owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004927 parser.add_option(
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004928 '--ignore-current',
4929 action='store_true',
4930 help='Ignore the CL\'s current reviewers and start from scratch.')
4931 parser.add_option(
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004932 '--ignore-self',
4933 action='store_true',
4934 help='Do not consider CL\'s author as an owners.')
4935 parser.add_option(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004936 '--no-color',
4937 action='store_true',
4938 help='Use this option to disable color output')
Dirk Prankebf980882017-09-02 15:08:00 -07004939 parser.add_option(
4940 '--batch',
4941 action='store_true',
4942 help='Do not run interactively, just suggest some')
Yang Guo6e269a02019-06-26 11:17:02 +00004943 # TODO: Consider moving this to another command, since other
4944 # git-cl owners commands deal with owners for a given CL.
4945 parser.add_option(
4946 '--show-all',
4947 action='store_true',
4948 help='Show all owners for a particular file')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004949 options, args = parser.parse_args(args)
4950
Edward Lemur934836a2019-09-09 20:16:54 +00004951 cl = Changelist()
Edward Lesmes50da7702020-03-30 19:23:43 +00004952 author = cl.GetAuthor()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004953
Yang Guo6e269a02019-06-26 11:17:02 +00004954 if options.show_all:
Bruce Dawson97ed44a2020-05-06 17:04:03 +00004955 if len(args) == 0:
4956 print('No files specified for --show-all. Nothing to do.')
4957 return 0
Edward Lesmese1576912021-02-16 21:53:34 +00004958 owners_by_path = cl.owners_client.BatchListOwners(args)
Edward Lesmes0e4e5ae2021-01-08 18:28:46 +00004959 for path in args:
4960 print('Owners for %s:' % path)
4961 print('\n'.join(
4962 ' - %s' % owner
4963 for owner in owners_by_path.get(path, ['No owners found'])))
Yang Guo6e269a02019-06-26 11:17:02 +00004964 return 0
4965
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004966 if args:
4967 if len(args) > 1:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004968 parser.error('Unknown args.')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004969 base_branch = args[0]
4970 else:
4971 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004972 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004973
Edward Lemur2c62b332020-03-12 22:12:33 +00004974 affected_files = cl.GetAffectedFiles(base_branch)
Dirk Prankebf980882017-09-02 15:08:00 -07004975
4976 if options.batch:
Edward Lesmese1576912021-02-16 21:53:34 +00004977 owners = cl.owners_client.SuggestOwners(affected_files, exclude=[author])
4978 print('\n'.join(owners))
Dirk Prankebf980882017-09-02 15:08:00 -07004979 return 0
4980
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004981 return owners_finder.OwnersFinder(
Dirk Prankebf980882017-09-02 15:08:00 -07004982 affected_files,
Edward Lemur707d70b2018-02-07 00:50:14 +01004983 author,
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004984 [] if options.ignore_current else cl.GetReviewers(),
Edward Lesmes5cd75472021-02-19 00:34:25 +00004985 cl.owners_client,
Jochen Eisingerd0573ec2017-04-13 10:55:06 +02004986 disable_color=options.no_color,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004987 ignore_author=options.ignore_self).run()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004988
4989
Aiden Bennerc08566e2018-10-03 17:52:42 +00004990def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004991 """Generates a diff command."""
4992 # Generate diff for the current branch's changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +00004993 diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff']
4994
Aiden Benner6c18a1a2018-11-23 20:18:23 +00004995 if allow_prefix:
4996 # explicitly setting --src-prefix and --dst-prefix is necessary in the
4997 # case that diff.noprefix is set in the user's git config.
4998 diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/']
4999 else:
Aiden Bennerc08566e2018-10-03 17:52:42 +00005000 diff_cmd += ['--no-prefix']
5001
5002 diff_cmd += [diff_type, upstream_commit, '--']
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005003
5004 if args:
5005 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005006 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005007 diff_cmd.append(arg)
5008 else:
5009 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005010
5011 return diff_cmd
5012
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005013
Jamie Madill5e96ad12020-01-13 16:08:35 +00005014def _RunClangFormatDiff(opts, clang_diff_files, top_dir, upstream_commit):
5015 """Runs clang-format-diff and sets a return value if necessary."""
5016
5017 if not clang_diff_files:
5018 return 0
5019
5020 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
5021 # formatted. This is used to block during the presubmit.
5022 return_value = 0
5023
5024 # Locate the clang-format binary in the checkout
5025 try:
5026 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
5027 except clang_format.NotFoundError as e:
5028 DieWithError(e)
5029
5030 if opts.full or settings.GetFormatFullByDefault():
5031 cmd = [clang_format_tool]
5032 if not opts.dry_run and not opts.diff:
5033 cmd.append('-i')
5034 if opts.dry_run:
5035 for diff_file in clang_diff_files:
5036 with open(diff_file, 'r') as myfile:
5037 code = myfile.read().replace('\r\n', '\n')
5038 stdout = RunCommand(cmd + [diff_file], cwd=top_dir)
5039 stdout = stdout.replace('\r\n', '\n')
5040 if opts.diff:
5041 sys.stdout.write(stdout)
5042 if code != stdout:
5043 return_value = 2
5044 else:
5045 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
5046 if opts.diff:
5047 sys.stdout.write(stdout)
5048 else:
Jamie Madill5e96ad12020-01-13 16:08:35 +00005049 try:
5050 script = clang_format.FindClangFormatScriptInChromiumTree(
5051 'clang-format-diff.py')
5052 except clang_format.NotFoundError as e:
5053 DieWithError(e)
5054
Edward Lesmes89624cd2020-04-06 17:51:56 +00005055 cmd = ['vpython', script, '-p0']
Jamie Madill5e96ad12020-01-13 16:08:35 +00005056 if not opts.dry_run and not opts.diff:
5057 cmd.append('-i')
5058
5059 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
Edward Lemur1a83da12020-03-04 21:18:36 +00005060 diff_output = RunGit(diff_cmd).encode('utf-8')
Jamie Madill5e96ad12020-01-13 16:08:35 +00005061
Edward Lesmes89624cd2020-04-06 17:51:56 +00005062 env = os.environ.copy()
5063 env['PATH'] = (
5064 str(os.path.dirname(clang_format_tool)) + os.pathsep + env['PATH'])
5065 stdout = RunCommand(
5066 cmd, stdin=diff_output, cwd=top_dir, env=env,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005067 shell=sys.platform.startswith('win32'))
Jamie Madill5e96ad12020-01-13 16:08:35 +00005068 if opts.diff:
5069 sys.stdout.write(stdout)
5070 if opts.dry_run and len(stdout) > 0:
5071 return_value = 2
5072
5073 return return_value
5074
5075
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005076def _RunRustFmt(opts, rust_diff_files, top_dir, upstream_commit):
5077 """Runs rustfmt. Just like _RunClangFormatDiff returns 2 to indicate that
5078 presubmit checks have failed (and returns 0 otherwise)."""
5079
5080 if not rust_diff_files:
5081 return 0
5082
5083 # Locate the rustfmt binary.
5084 try:
5085 rustfmt_tool = rustfmt.FindRustfmtToolInChromiumTree()
5086 except rustfmt.NotFoundError as e:
5087 DieWithError(e)
5088
5089 # TODO(crbug.com/1231317): Support formatting only the changed lines
5090 # if `opts.full or settings.GetFormatFullByDefault()` is False. See also:
5091 # https://github.com/emilio/rustfmt-format-diff
5092 cmd = [rustfmt_tool]
5093 if opts.dry_run:
5094 cmd.append('--check')
5095 cmd += rust_diff_files
5096 rustfmt_exitcode = subprocess2.call(cmd)
5097
5098 if opts.presubmit and rustfmt_exitcode != 0:
5099 return 2
5100 else:
5101 return 0
5102
5103
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005104def MatchingFileType(file_name, extensions):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00005105 """Returns True if the file name ends with one of the given extensions."""
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005106 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005107
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005108
enne@chromium.org555cfe42014-01-29 18:21:39 +00005109@subcommand.usage('[files or directories to diff]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005110@metrics.collector.collect_metrics('git cl format')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005111def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005112 """Runs auto-formatting tools (clang-format etc.) on the diff."""
Christopher Lamc5ba6922017-01-24 11:19:14 +11005113 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07005114 GN_EXTS = ['.gn', '.gni', '.typemap']
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005115 RUST_EXTS = ['.rs']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005116 parser.add_option('--full', action='store_true',
5117 help='Reformat the full content of all touched files')
Tomasz Åšniatowski58194462021-08-27 17:36:16 +00005118 parser.add_option('--upstream', help='Branch to check against')
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005119 parser.add_option('--dry-run', action='store_true',
5120 help='Don\'t modify any file on disk.')
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005121 parser.add_option(
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005122 '--no-clang-format',
5123 dest='clang_format',
5124 action='store_false',
5125 default=True,
5126 help='Disables formatting of various file types using clang-format.')
5127 parser.add_option(
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005128 '--python',
5129 action='store_true',
5130 default=None,
5131 help='Enables python formatting on all python files.')
5132 parser.add_option(
5133 '--no-python',
5134 action='store_true',
Garrett Beaty91a6f332020-01-06 16:57:24 +00005135 default=False,
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005136 help='Disables python formatting on all python files. '
Garrett Beaty91a6f332020-01-06 16:57:24 +00005137 'If neither --python or --no-python are set, python files that have a '
5138 '.style.yapf file in an ancestor directory will be formatted. '
5139 'It is an error to set both.')
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005140 parser.add_option(
5141 '--js',
5142 action='store_true',
5143 help='Format javascript code with clang-format. '
5144 'Has no effect if --no-clang-format is set.')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00005145 parser.add_option('--diff', action='store_true',
5146 help='Print diff to stdout rather than modifying files.')
Ilya Shermane081cbe2017-08-15 17:51:04 -07005147 parser.add_option('--presubmit', action='store_true',
5148 help='Used when running the script from a presubmit.')
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005149
5150 parser.add_option('--rust-fmt',
5151 dest='use_rust_fmt',
5152 action='store_true',
5153 default=rustfmt.IsRustfmtSupported(),
5154 help='Enables formatting of Rust file types using rustfmt.')
5155 parser.add_option(
5156 '--no-rust-fmt',
5157 dest='use_rust_fmt',
5158 action='store_false',
5159 help='Disables formatting of Rust file types using rustfmt.')
5160
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005161 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005162
Garrett Beaty91a6f332020-01-06 16:57:24 +00005163 if opts.python is not None and opts.no_python:
5164 raise parser.error('Cannot set both --python and --no-python')
5165 if opts.no_python:
5166 opts.python = False
5167
Daniel Chengc55eecf2016-12-30 03:11:02 -08005168 # Normalize any remaining args against the current path, so paths relative to
5169 # the current directory are still resolved as expected.
5170 args = [os.path.join(os.getcwd(), arg) for arg in args]
5171
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005172 # git diff generates paths against the root of the repository. Change
5173 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005174 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005175 if rel_base_path:
5176 os.chdir(rel_base_path)
5177
digit@chromium.org29e47272013-05-17 17:01:46 +00005178 # Grab the merge-base commit, i.e. the upstream commit of the current
5179 # branch when it was created or the last time it was rebased. This is
5180 # to cover the case where the user may have called "git fetch origin",
5181 # moving the origin branch to a newer commit, but hasn't rebased yet.
5182 upstream_commit = None
Tomasz Åšniatowski58194462021-08-27 17:36:16 +00005183 upstream_branch = opts.upstream
5184 if not upstream_branch:
5185 cl = Changelist()
5186 upstream_branch = cl.GetUpstreamBranch()
digit@chromium.org29e47272013-05-17 17:01:46 +00005187 if upstream_branch:
5188 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
5189 upstream_commit = upstream_commit.strip()
5190
5191 if not upstream_commit:
5192 DieWithError('Could not find base commit for this branch. '
5193 'Are you in detached state?')
5194
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005195 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5196 diff_output = RunGit(changed_files_cmd)
5197 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005198 # Filter out files deleted by this CL
5199 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005200
Andreas Haas417d89c2020-02-06 10:24:27 +00005201 if opts.js:
Deepanjan Roy605dd312018-07-02 17:48:54 +00005202 CLANG_EXTS.extend(['.js', '.ts'])
Christopher Lamc5ba6922017-01-24 11:19:14 +11005203
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005204 clang_diff_files = []
5205 if opts.clang_format:
5206 clang_diff_files = [
5207 x for x in diff_files if MatchingFileType(x, CLANG_EXTS)
5208 ]
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005209 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005210 rust_diff_files = [x for x in diff_files if MatchingFileType(x, RUST_EXTS)]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005211 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005212
Edward Lesmes50da7702020-03-30 19:23:43 +00005213 top_dir = settings.GetRoot()
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005214
Jamie Madill5e96ad12020-01-13 16:08:35 +00005215 return_value = _RunClangFormatDiff(opts, clang_diff_files, top_dir,
5216 upstream_commit)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005217
Lukasz Anforowiczb4d39542021-09-30 23:39:25 +00005218 if opts.use_rust_fmt:
5219 rust_fmt_return_value = _RunRustFmt(opts, rust_diff_files, top_dir,
5220 upstream_commit)
5221 if rust_fmt_return_value == 2:
5222 return_value = 2
5223
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005224 # Similar code to above, but using yapf on .py files rather than clang-format
5225 # on C/C++ files
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005226 py_explicitly_disabled = opts.python is not None and not opts.python
5227 if python_diff_files and not py_explicitly_disabled:
Aiden Bennere47ac152018-11-20 16:44:03 +00005228 depot_tools_path = os.path.dirname(os.path.abspath(__file__))
5229 yapf_tool = os.path.join(depot_tools_path, 'yapf')
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005230
Aiden Bennerc08566e2018-10-03 17:52:42 +00005231 # Used for caching.
5232 yapf_configs = {}
5233 for f in python_diff_files:
5234 # Find the yapf style config for the current file, defaults to depot
5235 # tools default.
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005236 _FindYapfConfigFile(f, yapf_configs, top_dir)
5237
5238 # Turn on python formatting by default if a yapf config is specified.
5239 # This breaks in the case of this repo though since the specified
5240 # style file is also the global default.
5241 if opts.python is None:
5242 filtered_py_files = []
5243 for f in python_diff_files:
5244 if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None:
5245 filtered_py_files.append(f)
5246 else:
5247 filtered_py_files = python_diff_files
5248
5249 # Note: yapf still seems to fix indentation of the entire file
5250 # even if line ranges are specified.
5251 # See https://github.com/google/yapf/issues/499
5252 if not opts.full and filtered_py_files:
5253 py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit)
5254
Brian Sheedyb4307d52019-12-02 19:18:17 +00005255 yapfignore_patterns = _GetYapfIgnorePatterns(top_dir)
5256 filtered_py_files = _FilterYapfIgnoredFiles(filtered_py_files,
5257 yapfignore_patterns)
Brian Sheedy59b06a82019-10-14 17:03:29 +00005258
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005259 for f in filtered_py_files:
Andrew Grievefa40bfa2020-01-07 02:32:57 +00005260 yapf_style = _FindYapfConfigFile(f, yapf_configs, top_dir)
5261 # Default to pep8 if not .style.yapf is found.
5262 if not yapf_style:
5263 yapf_style = 'pep8'
Aiden Bennerc08566e2018-10-03 17:52:42 +00005264
Peter Wend9399922020-06-17 17:33:49 +00005265 with open(f, 'r') as py_f:
5266 if 'python3' in py_f.readline():
5267 vpython_script = 'vpython3'
5268 else:
5269 vpython_script = 'vpython'
5270
5271 cmd = [vpython_script, yapf_tool, '--style', yapf_style, f]
Aiden Bennerc08566e2018-10-03 17:52:42 +00005272
5273 has_formattable_lines = False
5274 if not opts.full:
5275 # Only run yapf over changed line ranges.
5276 for diff_start, diff_len in py_line_diffs[f]:
5277 diff_end = diff_start + diff_len - 1
5278 # Yapf errors out if diff_end < diff_start but this
5279 # is a valid line range diff for a removal.
5280 if diff_end >= diff_start:
5281 has_formattable_lines = True
5282 cmd += ['-l', '{}-{}'.format(diff_start, diff_end)]
5283 # If all line diffs were removals we have nothing to format.
5284 if not has_formattable_lines:
5285 continue
5286
5287 if opts.diff or opts.dry_run:
5288 cmd += ['--diff']
5289 # Will return non-zero exit code if non-empty diff.
Edward Lesmesb7db1832020-06-22 20:22:27 +00005290 stdout = RunCommand(cmd,
5291 error_ok=True,
Josip Sokcevic673e8ed2021-10-27 23:46:18 +00005292 stderr=subprocess2.PIPE,
Edward Lesmesb7db1832020-06-22 20:22:27 +00005293 cwd=top_dir,
5294 shell=sys.platform.startswith('win32'))
Aiden Bennerc08566e2018-10-03 17:52:42 +00005295 if opts.diff:
5296 sys.stdout.write(stdout)
5297 elif len(stdout) > 0:
5298 return_value = 2
5299 else:
5300 cmd += ['-i']
Edward Lesmesb7db1832020-06-22 20:22:27 +00005301 RunCommand(cmd, cwd=top_dir, shell=sys.platform.startswith('win32'))
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005302
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005303 # Format GN build files. Always run on full build files for canonical form.
5304 if gn_diff_files:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005305 cmd = ['gn', 'format']
brettw4b8ed592016-08-05 16:19:12 -07005306 if opts.dry_run or opts.diff:
5307 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005308 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005309 gn_ret = subprocess2.call(cmd + [gn_diff_file],
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005310 shell=sys.platform.startswith('win'),
brettw4b8ed592016-08-05 16:19:12 -07005311 cwd=top_dir)
5312 if opts.dry_run and gn_ret == 2:
5313 return_value = 2 # Not formatted.
5314 elif opts.diff and gn_ret == 2:
5315 # TODO this should compute and print the actual diff.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005316 print('This change has GN build file diff for ' + gn_diff_file)
brettw4b8ed592016-08-05 16:19:12 -07005317 elif gn_ret != 0:
5318 # For non-dry run cases (and non-2 return values for dry-run), a
5319 # nonzero error code indicates a failure, probably because the file
5320 # doesn't parse.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005321 DieWithError('gn format failed on ' + gn_diff_file +
5322 '\nTry running `gn format` on this file manually.')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005323
Ilya Shermane081cbe2017-08-15 17:51:04 -07005324 # Skip the metrics formatting from the global presubmit hook. These files have
5325 # a separate presubmit hook that issues an error if the files need formatting,
5326 # whereas the top-level presubmit script merely issues a warning. Formatting
5327 # these files is somewhat slow, so it's important not to duplicate the work.
5328 if not opts.presubmit:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005329 for diff_xml in GetDiffXMLs(diff_files):
5330 xml_dir = GetMetricsDir(diff_xml)
5331 if not xml_dir:
5332 continue
5333
Ilya Shermane081cbe2017-08-15 17:51:04 -07005334 tool_dir = os.path.join(top_dir, xml_dir)
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005335 pretty_print_tool = os.path.join(tool_dir, 'pretty_print.py')
5336 cmd = ['vpython', pretty_print_tool, '--non-interactive']
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005337
5338 # If the XML file is histograms.xml or enums.xml, add the xml path to the
5339 # command as histograms/pretty_print.py now needs a relative path argument
5340 # after splitting the histograms into multiple directories.
5341 # For example, in tools/metrics/ukm, pretty-print could be run using:
5342 # $ python pretty_print.py
5343 # But in tools/metrics/histogrmas, pretty-print should be run with an
5344 # additional relative path argument, like:
Peter Kastingee088882021-08-03 17:57:00 +00005345 # $ python pretty_print.py metadata/UMA/histograms.xml
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005346 # $ python pretty_print.py enums.xml
5347
5348 # TODO (crbug/1116488): Remove this check after ensuring that the updated
5349 # version of histograms/pretty_print.py is released.
5350 filepath_required = os.path.exists(
5351 os.path.join(tool_dir, 'validate_prefix.py'))
5352
Weilun Shib92c4b72020-08-27 17:45:11 +00005353 if (diff_xml.endswith('histograms.xml') or diff_xml.endswith('enums.xml')
5354 or diff_xml.endswith('histogram_suffixes_list.xml')
5355 ) and filepath_required:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005356 cmd.append(diff_xml)
5357
Ilya Shermane081cbe2017-08-15 17:51:04 -07005358 if opts.dry_run or opts.diff:
5359 cmd.append('--diff')
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005360
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005361 # TODO(isherman): Once this file runs only on Python 3.3+, drop the
5362 # `shell` param and instead replace `'vpython'` with
5363 # `shutil.which('frob')` above: https://stackoverflow.com/a/32799942
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005364 stdout = RunCommand(cmd,
5365 cwd=top_dir,
Ilya Sherman7aed4bb2020-05-20 22:34:14 +00005366 shell=sys.platform.startswith('win32'))
Ilya Shermane081cbe2017-08-15 17:51:04 -07005367 if opts.diff:
5368 sys.stdout.write(stdout)
5369 if opts.dry_run and stdout:
5370 return_value = 2 # Not formatted.
Alexei Svitkinef3cac412017-02-06 11:08:50 -05005371
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005372 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005373
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005374
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005375def GetDiffXMLs(diff_files):
5376 return [
5377 os.path.normpath(x) for x in diff_files if MatchingFileType(x, ['.xml'])
5378 ]
5379
5380
5381def GetMetricsDir(diff_xml):
Steven Holte2e664bf2017-04-21 13:10:47 -07005382 metrics_xml_dirs = [
5383 os.path.join('tools', 'metrics', 'actions'),
5384 os.path.join('tools', 'metrics', 'histograms'),
5385 os.path.join('tools', 'metrics', 'rappor'),
Ilya Shermanb67e60c2020-05-20 22:27:03 +00005386 os.path.join('tools', 'metrics', 'structured'),
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005387 os.path.join('tools', 'metrics', 'ukm'),
5388 ]
Steven Holte2e664bf2017-04-21 13:10:47 -07005389 for xml_dir in metrics_xml_dirs:
Wenhan (Han) Zhang3bd3c992020-08-14 16:27:39 +00005390 if diff_xml.startswith(xml_dir):
5391 return xml_dir
5392 return None
Steven Holte2e664bf2017-04-21 13:10:47 -07005393
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005394
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005395@subcommand.usage('<codereview url or issue id>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005396@metrics.collector.collect_metrics('git cl checkout')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005397def CMDcheckout(parser, args):
Edward Lemurf38bc172019-09-03 21:02:13 +00005398 """Checks out a branch associated with a given Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005399 _, args = parser.parse_args(args)
5400
5401 if len(args) != 1:
5402 parser.print_help()
5403 return 1
5404
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005405 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005406 if not issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005407 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02005408
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005409 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005410
Edward Lemur52969c92020-02-06 18:15:28 +00005411 output = RunGit(['config', '--local', '--get-regexp',
Edward Lesmes50da7702020-03-30 19:23:43 +00005412 r'branch\..*\.' + ISSUE_CONFIG_KEY],
Edward Lemur52969c92020-02-06 18:15:28 +00005413 error_ok=True)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005414
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005415 branches = []
Edward Lemur52969c92020-02-06 18:15:28 +00005416 for key, issue in [x.split() for x in output.splitlines()]:
5417 if issue == target_issue:
Edward Lesmes50da7702020-03-30 19:23:43 +00005418 branches.append(re.sub(r'branch\.(.*)\.' + ISSUE_CONFIG_KEY, r'\1', key))
Edward Lemur52969c92020-02-06 18:15:28 +00005419
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005420 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005421 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005422 return 1
5423 if len(branches) == 1:
5424 RunGit(['checkout', branches[0]])
5425 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005426 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005427 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005428 print('%d: %s' % (i, branches[i]))
Edward Lesmesae3586b2020-03-23 21:21:14 +00005429 which = gclient_utils.AskForData('Choose by index: ')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005430 try:
5431 RunGit(['checkout', branches[int(which)]])
5432 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005433 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005434 return 1
5435
5436 return 0
5437
5438
maruel@chromium.org29404b52014-09-08 22:58:00 +00005439def CMDlol(parser, args):
5440 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005441 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005442 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5443 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5444 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
Gavin Mak18f45d22020-12-04 21:45:10 +00005445 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')).decode('utf-8'))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005446 return 0
5447
5448
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005449class OptionParser(optparse.OptionParser):
5450 """Creates the option parse and add --verbose support."""
Sigurd Schneider9abde8c2020-11-17 08:44:52 +00005451
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005452 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005453 optparse.OptionParser.__init__(
5454 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005455 self.add_option(
5456 '-v', '--verbose', action='count', default=0,
5457 help='Use 2 times for more debugging info')
5458
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005459 def parse_args(self, args=None, _values=None):
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005460 try:
5461 return self._parse_args(args)
5462 finally:
5463 # Regardless of success or failure of args parsing, we want to report
5464 # metrics, but only after logging has been initialized (if parsing
5465 # succeeded).
5466 global settings
5467 settings = Settings()
5468
Edward Lesmes9c349062021-05-06 20:02:39 +00005469 if metrics.collector.config.should_collect_metrics:
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005470 # GetViewVCUrl ultimately calls logging method.
5471 project_url = settings.GetViewVCUrl().strip('/+')
5472 if project_url in metrics_utils.KNOWN_PROJECT_URLS:
5473 metrics.collector.add('project_urls', [project_url])
5474
5475 def _parse_args(self, args=None):
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005476 # Create an optparse.Values object that will store only the actual passed
5477 # options, without the defaults.
5478 actual_options = optparse.Values()
5479 _, args = optparse.OptionParser.parse_args(self, args, actual_options)
5480 # Create an optparse.Values object with the default options.
5481 options = optparse.Values(self.get_default_values().__dict__)
5482 # Update it with the options passed by the user.
5483 options._update_careful(actual_options.__dict__)
5484 # Store the options passed by the user in an _actual_options attribute.
5485 # We store only the keys, and not the values, since the values can contain
5486 # arbitrary information, which might be PII.
Edward Lemur79d4f992019-11-11 23:49:02 +00005487 metrics.collector.add('arguments', list(actual_options.__dict__.keys()))
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005488
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005489 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
Andrii Shyshkalov5b04a572017-01-23 17:44:41 +01005490 logging.basicConfig(
5491 level=levels[min(options.verbose, len(levels) - 1)],
5492 format='[%(levelname).1s%(asctime)s %(process)d %(thread)d '
5493 '%(filename)s] %(message)s')
Edward Lemur83bd7f42018-10-10 00:14:21 +00005494
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005495 return options, args
5496
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005497
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005498def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005499 if sys.hexversion < 0x02060000:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005500 print('\nYour Python version %s is unsupported, please upgrade.\n' %
vapiera7fbd5a2016-06-16 09:17:49 -07005501 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005502 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005503
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005504 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005505 dispatcher = subcommand.CommandDispatcher(__name__)
5506 try:
5507 return dispatcher.execute(OptionParser(), argv)
Edward Lemur5b929a42019-10-21 17:57:39 +00005508 except auth.LoginRequiredError as e:
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005509 DieWithError(str(e))
Edward Lemur79d4f992019-11-11 23:49:02 +00005510 except urllib.error.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005511 if e.code != 500:
5512 raise
5513 DieWithError(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005514 ('App Engine is misbehaving and returned HTTP %d, again. Keep faith '
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005515 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005516 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005517
5518
5519if __name__ == '__main__':
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005520 # These affect sys.stdout, so do it outside of main() to simplify mocks in
5521 # the unit tests.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005522 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005523 setup_color.init()
Edward Lemur6f812e12018-07-31 22:45:57 +00005524 with metrics.collector.print_notice_and_exit():
sbc@chromium.org013731e2015-02-26 18:28:43 +00005525 sys.exit(main(sys.argv[1:]))