blob: 2144791d4599a54051cd6bf35d6450a4eaf6e331 [file] [log] [blame]
Edward Lemur1f3bafb2019-10-08 17:56:33 +00001#!/usr/bin/env vpython
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02002# Copyright (c) 2013 The Chromium Authors. All rights reserved.
maruel@chromium.org725f1c32011-04-01 20:24:54 +00003# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00006# Copyright (C) 2008 Evan Martin <martine@danga.com>
7
Andrii Shyshkalov03da1502018-10-15 03:42:34 +00008"""A git-command for integrating reviews on Gerrit."""
maruel@chromium.org725f1c32011-04-01 20:24:54 +00009
vapiera7fbd5a2016-06-16 09:17:49 -070010from __future__ import print_function
11
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +000012from distutils.version import LooseVersion
thakis@chromium.org3421c992014-11-02 02:20:32 +000013import base64
rmistry@google.com2dd99862015-06-22 12:22:18 +000014import collections
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +010015import datetime
Brian Sheedyb4307d52019-12-02 19:18:17 +000016import fnmatch
Edward Lemur202c5592019-10-21 22:44:52 +000017import httplib2
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +010018import itertools
maruel@chromium.org4f6852c2012-04-20 20:39:20 +000019import json
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000020import logging
calamity@chromium.orgcf197482016-04-29 20:15:53 +000021import multiprocessing
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000022import optparse
23import os
24import re
Andrii Shyshkalov353637c2017-03-14 16:52:18 +010025import shutil
ukai@chromium.org78c4b982012-02-14 02:20:26 +000026import stat
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000027import sys
Aaron Gable9a03ae02017-11-03 11:31:07 -070028import tempfile
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000029import textwrap
Edward Lemurfec80c42018-11-01 23:14:14 +000030import time
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000031import uuid
thestig@chromium.org00858c82013-12-02 23:08:03 +000032import webbrowser
thakis@chromium.org3421c992014-11-02 02:20:32 +000033import zlib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000034
maruel@chromium.org2e23ce32013-05-07 12:42:28 +000035from third_party import colorama
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000036import auth
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +000037import clang_format
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +000038import dart_format
maruel@chromium.org6f09cd92011-04-01 16:38:12 +000039import fix_encoding
maruel@chromium.org0e0436a2011-10-25 13:32:41 +000040import gclient_utils
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +000041import gerrit_util
iannucci@chromium.org9e849272014-04-04 00:31:55 +000042import git_common
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +000043import git_footers
Edward Lemur85153282020-02-14 22:06:29 +000044import git_new_branch
Edward Lemur5ba1e9c2018-07-23 18:19:02 +000045import metrics
Edward Lesmes93277a72018-10-18 22:04:26 +000046import metrics_utils
piman@chromium.org336f9122014-09-04 02:16:55 +000047import owners
iannucci@chromium.org9e849272014-04-04 00:31:55 +000048import owners_finder
maruel@chromium.org2a74d372011-03-29 19:05:50 +000049import presubmit_support
50import 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
tandrii9d2c7a32016-06-22 03:42:45 -0700105COMMIT_BOT_EMAIL = 'commit-bot@chromium.org'
Aaron Gable1bc7bfe2016-12-19 10:08:14 -0800106POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land'
Henrique Ferreiroff249622019-11-28 23:19:29 +0000107DESCRIPTION_BACKUP_FILE = '.git_cl_description_backup'
rmistry@google.comc68112d2015-03-03 12:48:06 +0000108REFS_THAT_ALIAS_TO_OTHER_REFS = {
109 'refs/remotes/origin/lkgr': 'refs/remotes/origin/master',
110 'refs/remotes/origin/lkcr': 'refs/remotes/origin/master',
111}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000112
thestig@chromium.org44202a22014-03-11 19:22:18 +0000113# Valid extensions for files we want to lint.
114DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
115DEFAULT_LINT_IGNORE_REGEX = r"$^"
116
Aiden Bennerc08566e2018-10-03 17:52:42 +0000117# File name for yapf style config files.
118YAPF_CONFIG_FILENAME = '.style.yapf'
119
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000120# Shortcut since it quickly becomes repetitive.
maruel@chromium.org2e23ce32013-05-07 12:42:28 +0000121Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +0000122
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000123# Initialized in main()
124settings = None
125
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100126# Used by tests/git_cl_test.py to add extra logging.
127# Inside the weirdly failing test, add this:
128# >>> self.mock(git_cl, '_IS_BEING_TESTED', True)
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700129# And scroll up to see the stack trace printed.
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100130_IS_BEING_TESTED = False
131
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000132
Christopher Lamf732cd52017-01-24 12:40:11 +1100133def DieWithError(message, change_desc=None):
134 if change_desc:
135 SaveDescriptionBackup(change_desc)
Josip Sokcevic953278a2020-02-28 19:46:36 +0000136 print('\n ** Content of CL description **\n' +
137 '='*72 + '\n' +
138 change_desc.description + '\n' +
139 '='*72 + '\n')
Christopher Lamf732cd52017-01-24 12:40:11 +1100140
vapiera7fbd5a2016-06-16 09:17:49 -0700141 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000142 sys.exit(1)
143
144
Christopher Lamf732cd52017-01-24 12:40:11 +1100145def SaveDescriptionBackup(change_desc):
Henrique Ferreiro5ae48172019-11-29 16:14:42 +0000146 backup_path = os.path.join(DEPOT_TOOLS, DESCRIPTION_BACKUP_FILE)
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +0000147 print('\nsaving CL description to %s\n' % backup_path)
Josip906bfde2020-01-31 22:38:49 +0000148 with open(backup_path, 'w') as backup_file:
149 backup_file.write(change_desc.description)
Christopher Lamf732cd52017-01-24 12:40:11 +1100150
151
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000152def GetNoGitPagerEnv():
153 env = os.environ.copy()
154 # 'cat' is a magical git string that disables pagers on all platforms.
155 env['GIT_PAGER'] = 'cat'
156 return env
157
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000158
bsep@chromium.org627d9002016-04-29 00:00:52 +0000159def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000160 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000161 stdout = subprocess2.check_output(args, shell=shell, **kwargs)
162 return stdout.decode('utf-8', 'replace')
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000163 except subprocess2.CalledProcessError as e:
164 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000165 if not error_ok:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000166 DieWithError(
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000167 'Command "%s" failed.\n%s' % (
168 ' '.join(args), error_message or e.stdout or ''))
Edward Lemur79d4f992019-11-11 23:49:02 +0000169 return e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000170
171
172def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000173 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000174 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000175
176
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000177def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000178 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700179 if suppress_stderr:
180 stderr = subprocess2.VOID
181 else:
182 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000183 try:
tandrii5d48c322016-08-18 16:19:37 -0700184 (out, _), code = subprocess2.communicate(['git'] + args,
185 env=GetNoGitPagerEnv(),
186 stdout=subprocess2.PIPE,
187 stderr=stderr)
Edward Lemur79d4f992019-11-11 23:49:02 +0000188 return code, out.decode('utf-8', 'replace')
tandrii5d48c322016-08-18 16:19:37 -0700189 except subprocess2.CalledProcessError as e:
Yoshisato Yanagisawa81e3ff52017-09-26 15:33:34 +0900190 logging.debug('Failed running %s', ['git'] + args)
Edward Lemur79d4f992019-11-11 23:49:02 +0000191 return e.returncode, e.stdout.decode('utf-8', 'replace')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000192
193
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000194def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000195 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000196 return RunGitWithCode(args, suppress_stderr=True)[1]
197
198
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000199def IsGitVersionAtLeast(min_version):
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000200 prefix = 'git version '
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000201 version = RunGit(['--version']).strip()
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000202 return (version.startswith(prefix) and
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000203 LooseVersion(version[len(prefix):]) >= LooseVersion(min_version))
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000204
205
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +0000206def BranchExists(branch):
207 """Return True if specified branch exists."""
208 code, _ = RunGitWithCode(['rev-parse', '--verify', branch],
209 suppress_stderr=True)
210 return not code
211
212
tandrii2a16b952016-10-19 07:09:44 -0700213def time_sleep(seconds):
214 # Use this so that it can be mocked in tests without interfering with python
215 # system machinery.
tandrii2a16b952016-10-19 07:09:44 -0700216 return time.sleep(seconds)
217
218
Edward Lemur01f4a4f2018-11-03 00:40:38 +0000219def time_time():
220 # Use this so that it can be mocked in tests without interfering with python
221 # system machinery.
222 return time.time()
223
224
Edward Lemur1b52d872019-05-09 21:12:12 +0000225def datetime_now():
226 # Use this so that it can be mocked in tests without interfering with python
227 # system machinery.
228 return datetime.datetime.now()
229
230
Edward Lemur1a83da12020-03-04 21:18:36 +0000231def _raw_input(message):
232 # Use this so that it can be mocked in tests on Python 2 and 3.
233 if sys.version_info.major == 2:
234 return raw_input(message)
235 return input(message)
236
237
maruel@chromium.org90541732011-04-01 17:54:18 +0000238def ask_for_data(prompt):
239 try:
Edward Lemur1a83da12020-03-04 21:18:36 +0000240 return _raw_input(prompt)
maruel@chromium.org90541732011-04-01 17:54:18 +0000241 except KeyboardInterrupt:
242 # Hide the exception.
243 sys.exit(1)
244
245
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100246def confirm_or_exit(prefix='', action='confirm'):
247 """Asks user to press enter to continue or press Ctrl+C to abort."""
248 if not prefix or prefix.endswith('\n'):
249 mid = 'Press'
Andrii Shyshkalov353637c2017-03-14 16:52:18 +0100250 elif prefix.endswith('.') or prefix.endswith('?'):
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100251 mid = ' Press'
252 elif prefix.endswith(' '):
253 mid = 'press'
254 else:
255 mid = ' press'
256 ask_for_data('%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action))
257
258
259def ask_for_explicit_yes(prompt):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000260 """Returns whether user typed 'y' or 'yes' to confirm the given prompt."""
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100261 result = ask_for_data(prompt + ' [Yes/No]: ').lower()
262 while True:
263 if 'yes'.startswith(result):
264 return True
265 if 'no'.startswith(result):
266 return False
267 result = ask_for_data('Please, type yes or no: ').lower()
268
269
tandrii5d48c322016-08-18 16:19:37 -0700270def _git_branch_config_key(branch, key):
271 """Helper method to return Git config key for a branch."""
272 assert branch, 'branch name is required to set git config for it'
273 return 'branch.%s.%s' % (branch, key)
274
275
machenbach@chromium.org45453142015-09-15 08:45:22 +0000276def _get_properties_from_options(options):
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000277 prop_list = getattr(options, 'properties', [])
278 properties = dict(x.split('=', 1) for x in prop_list)
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +0000279 for key, val in properties.items():
machenbach@chromium.org45453142015-09-15 08:45:22 +0000280 try:
281 properties[key] = json.loads(val)
282 except ValueError:
283 pass # If a value couldn't be evaluated, treat it as a string.
284 return properties
285
286
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000287# TODO(crbug.com/976104): Remove this function once git-cl try-results has
288# migrated to use buildbucket v2
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000289def _buildbucket_retry(operation_name, http, *args, **kwargs):
290 """Retries requests to buildbucket service and returns parsed json content."""
291 try_count = 0
292 while True:
293 response, content = http.request(*args, **kwargs)
294 try:
295 content_json = json.loads(content)
296 except ValueError:
297 content_json = None
298
299 # Buildbucket could return an error even if status==200.
300 if content_json and content_json.get('error'):
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000301 error = content_json.get('error')
302 if error.get('code') == 403:
303 raise BuildbucketResponseException(
304 'Access denied: %s' % error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000305 msg = 'Error in response. Reason: %s. Message: %s.' % (
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000306 error.get('reason', ''), error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000307 raise BuildbucketResponseException(msg)
308
309 if response.status == 200:
Nodir Turakulov23d75d22018-06-04 12:37:32 -0700310 if content_json is None:
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000311 raise BuildbucketResponseException(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000312 'Buildbucket returned invalid JSON content: %s.\n'
Nodir Turakulov9ac59792018-06-04 12:34:14 -0700313 'Please file bugs at http://crbug.com, '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000314 'component "Infra>Platform>Buildbucket".' %
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000315 content)
316 return content_json
317 if response.status < 500 or try_count >= 2:
318 raise httplib2.HttpLib2Error(content)
319
320 # status >= 500 means transient failures.
321 logging.debug('Transient errors when %s. Will retry.', operation_name)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000322 time_sleep(0.5 + (1.5 * try_count))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000323 try_count += 1
324 assert False, 'unreachable'
325
326
Edward Lemur4c707a22019-09-24 21:13:43 +0000327def _call_buildbucket(http, buildbucket_host, method, request):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000328 """Calls a buildbucket v2 method and returns the parsed json response."""
329 headers = {
330 'Accept': 'application/json',
331 'Content-Type': 'application/json',
332 }
333 request = json.dumps(request)
334 url = 'https://%s/prpc/buildbucket.v2.Builds/%s' % (buildbucket_host, method)
335
336 logging.info('POST %s with %s' % (url, request))
337
338 attempts = 1
339 time_to_sleep = 1
340 while True:
341 response, content = http.request(url, 'POST', body=request, headers=headers)
342 if response.status == 200:
343 return json.loads(content[4:])
344 if attempts >= MAX_ATTEMPTS or 400 <= response.status < 500:
345 msg = '%s error when calling POST %s with %s: %s' % (
346 response.status, url, request, content)
347 raise BuildbucketResponseException(msg)
348 logging.debug(
349 '%s error when calling POST %s with %s. '
350 'Sleeping for %d seconds and retrying...' % (
351 response.status, url, request, time_to_sleep))
352 time.sleep(time_to_sleep)
353 time_to_sleep *= 2
354 attempts += 1
355
356 assert False, 'unreachable'
357
358
Edward Lemur6215c792019-10-03 21:59:05 +0000359def _parse_bucket(raw_bucket):
360 legacy = True
361 project = bucket = None
362 if '/' in raw_bucket:
363 legacy = False
364 project, bucket = raw_bucket.split('/', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000365 # Assume luci.<project>.<bucket>.
Edward Lemur6215c792019-10-03 21:59:05 +0000366 elif raw_bucket.startswith('luci.'):
367 project, bucket = raw_bucket[len('luci.'):].split('.', 1)
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000368 # Otherwise, assume prefix is also the project name.
Edward Lemur6215c792019-10-03 21:59:05 +0000369 elif '.' in raw_bucket:
370 project = raw_bucket.split('.')[0]
371 bucket = raw_bucket
372 # Legacy buckets.
Edward Lemur45768512020-03-02 19:03:14 +0000373 if legacy and project and bucket:
Edward Lemur6215c792019-10-03 21:59:05 +0000374 print('WARNING Please use %s/%s to specify the bucket.' % (project, bucket))
375 return project, bucket
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000376
377
Quinten Yearsley777660f2020-03-04 23:37:06 +0000378def _trigger_tryjobs(changelist, jobs, options, patchset):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000379 """Sends a request to Buildbucket to trigger tryjobs for a changelist.
qyearsley1fdfcb62016-10-24 13:22:03 -0700380
381 Args:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000382 changelist: Changelist that the tryjobs are associated with.
Edward Lemur45768512020-03-02 19:03:14 +0000383 jobs: A list of (project, bucket, builder).
qyearsley1fdfcb62016-10-24 13:22:03 -0700384 options: Command-line options.
385 """
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000386 print('Scheduling jobs on:')
Edward Lemur45768512020-03-02 19:03:14 +0000387 for project, bucket, builder in jobs:
388 print(' %s/%s: %s' % (project, bucket, builder))
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000389 print('To see results here, run: git cl try-results')
390 print('To see results in browser, run: git cl web')
tandriide281ae2016-10-12 06:02:30 -0700391
Quinten Yearsley777660f2020-03-04 23:37:06 +0000392 requests = _make_tryjob_schedule_requests(changelist, jobs, options, patchset)
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000393 if not requests:
394 return
395
Edward Lemur5b929a42019-10-21 17:57:39 +0000396 http = auth.Authenticator().authorize(httplib2.Http())
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000397 http.force_exception_to_status_code = True
398
399 batch_request = {'requests': requests}
400 batch_response = _call_buildbucket(
401 http, options.buildbucket_host, 'Batch', batch_request)
402
403 errors = [
404 ' ' + response['error']['message']
405 for response in batch_response.get('responses', [])
406 if 'error' in response
407 ]
408 if errors:
409 raise BuildbucketResponseException(
410 'Failed to schedule builds for some bots:\n%s' % '\n'.join(errors))
411
412
Quinten Yearsley777660f2020-03-04 23:37:06 +0000413def _make_tryjob_schedule_requests(changelist, jobs, options, patchset):
Edward Lemurf0faf482019-09-25 20:40:17 +0000414 gerrit_changes = [changelist.GetGerritChange(patchset)]
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000415 shared_properties = {'category': getattr(options, 'category', 'git_cl_try')}
Quinten Yearsleya19d3532019-09-30 21:54:39 +0000416 if getattr(options, 'clobber', False):
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000417 shared_properties['clobber'] = True
418 shared_properties.update(_get_properties_from_options(options) or {})
419
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000420 shared_tags = [{'key': 'user_agent', 'value': 'git_cl_try'}]
421 if options.retry_failed:
422 shared_tags.append({'key': 'retry_failed',
423 'value': '1'})
424
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000425 requests = []
Edward Lemur45768512020-03-02 19:03:14 +0000426 for (project, bucket, builder) in jobs:
427 properties = shared_properties.copy()
428 if 'presubmit' in builder.lower():
429 properties['dry_run'] = 'true'
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000430
Edward Lemur45768512020-03-02 19:03:14 +0000431 requests.append({
432 'scheduleBuild': {
433 'requestId': str(uuid.uuid4()),
434 'builder': {
435 'project': getattr(options, 'project', None) or project,
436 'bucket': bucket,
437 'builder': builder,
438 },
439 'gerritChanges': gerrit_changes,
440 'properties': properties,
441 'tags': [
442 {'key': 'builder', 'value': builder},
443 ] + shared_tags,
444 }
445 })
Edward Lemurd4d1ba42019-09-20 21:46:37 +0000446
Edward Lemur45768512020-03-02 19:03:14 +0000447 if options.revision:
448 requests[-1]['scheduleBuild']['gitilesCommit'] = {
449 'host': gerrit_changes[0]['host'],
450 'project': gerrit_changes[0]['project'],
451 'id': options.revision
452 }
Anthony Polito1a5fe232020-01-24 23:17:52 +0000453
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +0000454 return requests
kjellander@chromium.org44424542015-06-02 18:35:29 +0000455
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000456
Quinten Yearsley777660f2020-03-04 23:37:06 +0000457def _fetch_tryjobs(changelist, buildbucket_host, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000458 """Fetches tryjobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000459
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000460 Returns list of buildbucket.v2.Build with the try jobs for the changelist.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000461 """
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000462 fields = ['id', 'builder', 'status', 'createTime', 'tags']
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000463 request = {
464 'predicate': {
465 'gerritChanges': [changelist.GetGerritChange(patchset)],
466 },
467 'fields': ','.join('builds.*.' + field for field in fields),
468 }
tandrii221ab252016-10-06 08:12:04 -0700469
Edward Lemur5b929a42019-10-21 17:57:39 +0000470 authenticator = auth.Authenticator()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000471 if authenticator.has_cached_credentials():
472 http = authenticator.authorize(httplib2.Http())
473 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700474 print('Warning: Some results might be missing because %s' %
475 # Get the message on how to login.
Edward Lemurba5bc992019-09-23 22:59:17 +0000476 (auth.LoginRequiredError().message,))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000477 http = httplib2.Http()
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000478 http.force_exception_to_status_code = True
479
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000480 response = _call_buildbucket(http, buildbucket_host, 'SearchBuilds', request)
481 return response.get('builds', [])
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000482
Edward Lemur45768512020-03-02 19:03:14 +0000483
Edward Lemur5b929a42019-10-21 17:57:39 +0000484def _fetch_latest_builds(changelist, buildbucket_host, latest_patchset=None):
Quinten Yearsley983111f2019-09-26 17:18:48 +0000485 """Fetches builds from the latest patchset that has builds (within
486 the last few patchsets).
487
488 Args:
Quinten Yearsley983111f2019-09-26 17:18:48 +0000489 changelist (Changelist): The CL to fetch builds for
490 buildbucket_host (str): Buildbucket host, e.g. "cr-buildbucket.appspot.com"
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000491 lastest_patchset(int|NoneType): the patchset to start fetching builds from.
492 If None (default), starts with the latest available patchset.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000493 Returns:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000494 A tuple (builds, patchset) where builds is a list of buildbucket.v2.Build,
495 and patchset is the patchset number where those builds came from.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000496 """
497 assert buildbucket_host
498 assert changelist.GetIssue(), 'CL must be uploaded first'
499 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +0000500 if latest_patchset is None:
501 assert changelist.GetMostRecentPatchset()
502 ps = changelist.GetMostRecentPatchset()
503 else:
504 assert latest_patchset > 0, latest_patchset
505 ps = latest_patchset
506
Quinten Yearsley983111f2019-09-26 17:18:48 +0000507 min_ps = max(1, ps - 5)
508 while ps >= min_ps:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000509 builds = _fetch_tryjobs(changelist, buildbucket_host, patchset=ps)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000510 if len(builds):
511 return builds, ps
512 ps -= 1
513 return [], 0
514
515
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000516def _filter_failed_for_retry(all_builds):
517 """Returns a list of buckets/builders that are worth retrying.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000518
519 Args:
Quinten Yearsley777660f2020-03-04 23:37:06 +0000520 all_builds (list): Builds, in the format returned by _fetch_tryjobs,
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000521 i.e. a list of buildbucket.v2.Builds which includes status and builder
522 info.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000523
524 Returns:
Edward Lemur45768512020-03-02 19:03:14 +0000525 A dict {(proj, bucket): [builders]}. This is the same format accepted by
Quinten Yearsley777660f2020-03-04 23:37:06 +0000526 _trigger_tryjobs.
Quinten Yearsley983111f2019-09-26 17:18:48 +0000527 """
Edward Lemur45768512020-03-02 19:03:14 +0000528 grouped = {}
529 for build in all_builds:
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000530 builder = build['builder']
Edward Lemur45768512020-03-02 19:03:14 +0000531 key = (builder['project'], builder['bucket'], builder['builder'])
532 grouped.setdefault(key, []).append(build)
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000533
Edward Lemur45768512020-03-02 19:03:14 +0000534 jobs = []
535 for (project, bucket, builder), builds in grouped.items():
536 if 'triggered' in builder:
537 print('WARNING: Not scheduling %s. Triggered bots require an initial job '
538 'from a parent. Please schedule a manual job for the parent '
539 'instead.')
Andrii Shyshkalov2cbae8a2019-10-11 21:30:27 +0000540 continue
541 if any(b['status'] in ('STARTED', 'SCHEDULED') for b in builds):
542 # Don't retry if any are running.
543 continue
Edward Lemur45768512020-03-02 19:03:14 +0000544 # If builder had several builds, retry only if the last one failed.
545 # This is a bit different from CQ, which would re-use *any* SUCCESS-full
546 # build, but in case of retrying failed jobs retrying a flaky one makes
547 # sense.
548 builds = sorted(builds, key=lambda b: b['createTime'])
549 if builds[-1]['status'] not in ('FAILURE', 'INFRA_FAILURE'):
550 continue
551 # Don't retry experimental build previously triggered by CQ.
552 if any(t['key'] == 'cq_experimental' and t['value'] == 'true'
553 for t in builds[-1]['tags']):
554 continue
555 jobs.append((project, bucket, builder))
556
557 # Sort the jobs to make testing easier.
558 return sorted(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +0000559
560
Quinten Yearsley777660f2020-03-04 23:37:06 +0000561def _print_tryjobs(options, builds):
562 """Prints nicely result of _fetch_tryjobs."""
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000563 if not builds:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000564 print('No tryjobs scheduled.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000565 return
566
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000567 longest_builder = max(len(b['builder']['builder']) for b in builds)
568 name_fmt = '{builder:<%d}' % longest_builder
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000569 if options.print_master:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000570 longest_bucket = max(len(b['builder']['bucket']) for b in builds)
571 name_fmt = ('{bucket:>%d} ' % longest_bucket) + name_fmt
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000572
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000573 builds_by_status = {}
574 for b in builds:
575 builds_by_status.setdefault(b['status'], []).append({
576 'id': b['id'],
577 'name': name_fmt.format(
578 builder=b['builder']['builder'], bucket=b['builder']['bucket']),
579 })
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000580
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000581 sort_key = lambda b: (b['name'], b['id'])
582
583 def print_builds(title, builds, fmt=None, color=None):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000584 """Pop matching builds from `builds` dict and print them."""
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000585 if not builds:
586 return
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000587
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000588 fmt = fmt or '{name} https://ci.chromium.org/b/{id}'
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000589 if not options.color or color is None:
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000590 colorize = lambda x: x
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000591 else:
592 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
593
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000594 print(colorize(title))
595 for b in sorted(builds, key=sort_key):
596 print(' ', colorize(fmt.format(**b)))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000597
598 total = len(builds)
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000599 print_builds(
600 'Successes:', builds_by_status.pop('SUCCESS', []), color=Fore.GREEN)
601 print_builds(
602 'Infra Failures:', builds_by_status.pop('INFRA_FAILURE', []),
603 color=Fore.MAGENTA)
604 print_builds('Failures:', builds_by_status.pop('FAILURE', []), color=Fore.RED)
605 print_builds('Canceled:', builds_by_status.pop('CANCELED', []), fmt='{name}',
606 color=Fore.MAGENTA)
607 print_builds('Started:', builds_by_status.pop('STARTED', []))
608 print_builds(
609 'Scheduled:', builds_by_status.pop('SCHEDULED', []), fmt='{name} id={id}')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000610 # The last section is just in case buildbucket API changes OR there is a bug.
Edward Lemurbaaf6be2019-10-09 18:00:44 +0000611 print_builds(
612 'Other:', sum(builds_by_status.values(), []), fmt='{name} id={id}')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000613 print('Total: %d tryjobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000614
615
Aiden Bennerc08566e2018-10-03 17:52:42 +0000616def _ComputeDiffLineRanges(files, upstream_commit):
617 """Gets the changed line ranges for each file since upstream_commit.
618
619 Parses a git diff on provided files and returns a dict that maps a file name
620 to an ordered list of range tuples in the form (start_line, count).
621 Ranges are in the same format as a git diff.
622 """
623 # If files is empty then diff_output will be a full diff.
624 if len(files) == 0:
625 return {}
626
Aiden Benner6c18a1a2018-11-23 20:18:23 +0000627 # Take the git diff and find the line ranges where there are changes.
Jamie Madill3671a6a2019-10-24 15:13:21 +0000628 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000629 diff_output = RunGit(diff_cmd)
630
631 pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)'
632 # 2 capture groups
633 # 0 == fname of diff file
634 # 1 == 'diff_start,diff_count' or 'diff_start'
635 # will match each of
636 # diff --git a/foo.foo b/foo.py
637 # @@ -12,2 +14,3 @@
638 # @@ -12,2 +17 @@
639 # running re.findall on the above string with pattern will give
640 # [('foo.py', ''), ('', '14,3'), ('', '17')]
641
642 curr_file = None
643 line_diffs = {}
644 for match in re.findall(pattern, diff_output, flags=re.MULTILINE):
645 if match[0] != '':
646 # Will match the second filename in diff --git a/a.py b/b.py.
647 curr_file = match[0]
648 line_diffs[curr_file] = []
649 else:
650 # Matches +14,3
651 if ',' in match[1]:
652 diff_start, diff_count = match[1].split(',')
653 else:
654 # Single line changes are of the form +12 instead of +12,1.
655 diff_start = match[1]
656 diff_count = 1
657
658 diff_start = int(diff_start)
659 diff_count = int(diff_count)
660
661 # If diff_count == 0 this is a removal we can ignore.
662 line_diffs[curr_file].append((diff_start, diff_count))
663
664 return line_diffs
665
666
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000667def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000668 """Checks if a yapf file is in any parent directory of fpath until top_dir.
669
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000670 Recursively checks parent directories to find yapf file and if no yapf file
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000671 is found returns None. Uses yapf_config_cache as a cache for previously found
672 configs.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000673 """
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000674 fpath = os.path.abspath(fpath)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000675 # Return result if we've already computed it.
676 if fpath in yapf_config_cache:
677 return yapf_config_cache[fpath]
678
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000679 parent_dir = os.path.dirname(fpath)
680 if os.path.isfile(fpath):
681 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000682 else:
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000683 # Otherwise fpath is a directory
684 yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME)
685 if os.path.isfile(yapf_file):
686 ret = yapf_file
687 elif fpath == top_dir or parent_dir == fpath:
688 # If we're at the top level directory, or if we're at root
689 # there is no provided style.
690 ret = None
691 else:
692 # Otherwise recurse on the current directory.
693 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000694 yapf_config_cache[fpath] = ret
695 return ret
696
697
Brian Sheedyb4307d52019-12-02 19:18:17 +0000698def _GetYapfIgnorePatterns(top_dir):
699 """Returns all patterns in the .yapfignore file.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000700
701 yapf is supposed to handle the ignoring of files listed in .yapfignore itself,
702 but this functionality appears to break when explicitly passing files to
703 yapf for formatting. According to
704 https://github.com/google/yapf/blob/master/README.rst#excluding-files-from-formatting-yapfignore,
705 the .yapfignore file should be in the directory that yapf is invoked from,
706 which we assume to be the top level directory in this case.
707
708 Args:
709 top_dir: The top level directory for the repository being formatted.
710
711 Returns:
Brian Sheedyb4307d52019-12-02 19:18:17 +0000712 A set of all fnmatch patterns to be ignored.
Brian Sheedy59b06a82019-10-14 17:03:29 +0000713 """
714 yapfignore_file = os.path.join(top_dir, '.yapfignore')
Brian Sheedyb4307d52019-12-02 19:18:17 +0000715 ignore_patterns = set()
Brian Sheedy59b06a82019-10-14 17:03:29 +0000716 if not os.path.exists(yapfignore_file):
Brian Sheedyb4307d52019-12-02 19:18:17 +0000717 return ignore_patterns
Brian Sheedy59b06a82019-10-14 17:03:29 +0000718
Brian Sheedyb4307d52019-12-02 19:18:17 +0000719 with open(yapfignore_file) as f:
720 for line in f.readlines():
721 stripped_line = line.strip()
722 # Comments and blank lines should be ignored.
723 if stripped_line.startswith('#') or stripped_line == '':
724 continue
725 ignore_patterns.add(stripped_line)
726 return ignore_patterns
727
728
729def _FilterYapfIgnoredFiles(filepaths, patterns):
730 """Filters out any filepaths that match any of the given patterns.
731
732 Args:
733 filepaths: An iterable of strings containing filepaths to filter.
734 patterns: An iterable of strings containing fnmatch patterns to filter on.
735
736 Returns:
737 A list of strings containing all the elements of |filepaths| that did not
738 match any of the patterns in |patterns|.
739 """
740 # Not inlined so that tests can use the same implementation.
741 return [f for f in filepaths
742 if not any(fnmatch.fnmatch(f, p) for p in patterns)]
Brian Sheedy59b06a82019-10-14 17:03:29 +0000743
744
Aaron Gable13101a62018-02-09 13:20:41 -0800745def print_stats(args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000746 """Prints statistics about the change to the user."""
747 # --no-ext-diff is broken in some versions of Git, so try to work around
748 # this by overriding the environment (but there is still a problem if the
749 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000750 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000751 if 'GIT_EXTERNAL_DIFF' in env:
752 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000753
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000754 return subprocess2.call(
Aaron Gable13101a62018-02-09 13:20:41 -0800755 ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args,
Edward Lemur0db01f02019-11-12 22:01:51 +0000756 env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000757
758
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000759class BuildbucketResponseException(Exception):
760 pass
761
762
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000763class Settings(object):
764 def __init__(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000765 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000766 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000767 self.tree_status_url = None
768 self.viewvc_url = None
769 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000770 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000771 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000772 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000773 self.git_editor = None
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000774 self.format_full_by_default = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000775
Edward Lemur26964072020-02-19 19:18:51 +0000776 def _LazyUpdateIfNeeded(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000777 """Updates the settings from a codereview.settings file, if available."""
Edward Lemur26964072020-02-19 19:18:51 +0000778 if self.updated:
779 return
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000780
Edward Lemur26964072020-02-19 19:18:51 +0000781 # The only value that actually changes the behavior is
782 # autoupdate = "false". Everything else means "true".
783 autoupdate = (
784 scm.GIT.GetConfig(self.GetRoot(), 'rietveld.autoupdate', '').lower())
785
786 cr_settings_file = FindCodereviewSettingsFile()
787 if autoupdate != 'false' and cr_settings_file:
788 LoadCodereviewSettingsFromFile(cr_settings_file)
789 cr_settings_file.close()
790
791 self.updated = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000792
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000793 @staticmethod
794 def GetRelativeRoot():
795 return RunGit(['rev-parse', '--show-cdup']).strip()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000796
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000797 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000798 if self.root is None:
799 self.root = os.path.abspath(self.GetRelativeRoot())
800 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000801
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000802 def GetTreeStatusUrl(self, error_ok=False):
803 if not self.tree_status_url:
Edward Lemur26964072020-02-19 19:18:51 +0000804 self.tree_status_url = self._GetConfig('rietveld.tree-status-url')
805 if self.tree_status_url is None and not error_ok:
806 DieWithError(
807 'You must configure your tree status URL by running '
808 '"git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000809 return self.tree_status_url
810
811 def GetViewVCUrl(self):
812 if not self.viewvc_url:
Edward Lemur26964072020-02-19 19:18:51 +0000813 self.viewvc_url = self._GetConfig('rietveld.viewvc-url')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000814 return self.viewvc_url
815
rmistry@google.com90752582014-01-14 21:04:50 +0000816 def GetBugPrefix(self):
Edward Lemur26964072020-02-19 19:18:51 +0000817 return self._GetConfig('rietveld.bug-prefix')
rmistry@google.com78948ed2015-07-08 23:09:57 +0000818
rmistry@google.com5626a922015-02-26 14:03:30 +0000819 def GetRunPostUploadHook(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000820 run_post_upload_hook = self._GetConfig(
Edward Lemur26964072020-02-19 19:18:51 +0000821 'rietveld.run-post-upload-hook')
rmistry@google.com5626a922015-02-26 14:03:30 +0000822 return run_post_upload_hook == "True"
823
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000824 def GetDefaultCCList(self):
Edward Lemur26964072020-02-19 19:18:51 +0000825 return self._GetConfig('rietveld.cc')
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000826
ukai@chromium.orge8077812012-02-03 03:41:46 +0000827 def GetIsGerrit(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000828 """Returns True if this repo is associated with Gerrit."""
ukai@chromium.orge8077812012-02-03 03:41:46 +0000829 if self.is_gerrit is None:
Edward Lemur26964072020-02-19 19:18:51 +0000830 self.is_gerrit = self._GetConfig('gerrit.host').lower() == 'true'
ukai@chromium.orge8077812012-02-03 03:41:46 +0000831 return self.is_gerrit
832
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000833 def GetSquashGerritUploads(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000834 """Returns True if uploads to Gerrit should be squashed by default."""
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000835 if self.squash_gerrit_uploads is None:
tandriia60502f2016-06-20 02:01:53 -0700836 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
Edward Lemur26964072020-02-19 19:18:51 +0000837 if self.squash_gerrit_uploads is None:
838 # Default is squash now (http://crbug.com/611892#c23).
839 self.squash_gerrit_uploads = self._GetConfig(
840 'gerrit.squash-uploads').lower() != 'false'
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000841 return self.squash_gerrit_uploads
842
tandriia60502f2016-06-20 02:01:53 -0700843 def GetSquashGerritUploadsOverride(self):
844 """Return True or False if codereview.settings should be overridden.
845
846 Returns None if no override has been defined.
847 """
848 # See also http://crbug.com/611892#c23
Edward Lemur26964072020-02-19 19:18:51 +0000849 result = self._GetConfig('gerrit.override-squash-uploads').lower()
tandriia60502f2016-06-20 02:01:53 -0700850 if result == 'true':
851 return True
852 if result == 'false':
853 return False
854 return None
855
tandrii@chromium.org28253532016-04-14 13:46:56 +0000856 def GetGerritSkipEnsureAuthenticated(self):
857 """Return True if EnsureAuthenticated should not be done for Gerrit
858 uploads."""
859 if self.gerrit_skip_ensure_authenticated is None:
Edward Lemur26964072020-02-19 19:18:51 +0000860 self.gerrit_skip_ensure_authenticated = self._GetConfig(
861 'gerrit.skip-ensure-authenticated').lower() == 'true'
tandrii@chromium.org28253532016-04-14 13:46:56 +0000862 return self.gerrit_skip_ensure_authenticated
863
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000864 def GetGitEditor(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000865 """Returns the editor specified in the git config, or None if none is."""
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000866 if self.git_editor is None:
Raul Tambre5a525872019-02-12 19:08:08 +0000867 # Git requires single quotes for paths with spaces. We need to replace
868 # them with double quotes for Windows to treat such paths as a single
869 # path.
Edward Lemur26964072020-02-19 19:18:51 +0000870 self.git_editor = self._GetConfig('core.editor').replace('\'', '"')
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000871 return self.git_editor or None
872
thestig@chromium.org44202a22014-03-11 19:22:18 +0000873 def GetLintRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000874 return self._GetConfig('rietveld.cpplint-regex', DEFAULT_LINT_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000875
876 def GetLintIgnoreRegex(self):
Edward Lemur26964072020-02-19 19:18:51 +0000877 return self._GetConfig(
878 'rietveld.cpplint-ignore-regex', DEFAULT_LINT_IGNORE_REGEX)
thestig@chromium.org44202a22014-03-11 19:22:18 +0000879
Jamie Madilldc4d19e2019-10-24 21:50:02 +0000880 def GetFormatFullByDefault(self):
881 if self.format_full_by_default is None:
882 result = (
883 RunGit(['config', '--bool', 'rietveld.format-full-by-default'],
884 error_ok=True).strip())
885 self.format_full_by_default = (result == 'true')
886 return self.format_full_by_default
887
Edward Lemur26964072020-02-19 19:18:51 +0000888 def _GetConfig(self, key, default=''):
889 self._LazyUpdateIfNeeded()
890 return scm.GIT.GetConfig(self.GetRoot(), key, default)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000891
892
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000893class _CQState(object):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +0000894 """Enum for states of CL with respect to CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000895 NONE = 'none'
896 DRY_RUN = 'dry_run'
897 COMMIT = 'commit'
898
899 ALL_STATES = [NONE, DRY_RUN, COMMIT]
900
901
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000902class _ParsedIssueNumberArgument(object):
Edward Lemurf38bc172019-09-03 21:02:13 +0000903 def __init__(self, issue=None, patchset=None, hostname=None):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000904 self.issue = issue
905 self.patchset = patchset
906 self.hostname = hostname
907
908 @property
909 def valid(self):
910 return self.issue is not None
911
912
Edward Lemurf38bc172019-09-03 21:02:13 +0000913def ParseIssueNumberArgument(arg):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000914 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
915 fail_result = _ParsedIssueNumberArgument()
916
Edward Lemur678a6842019-10-03 22:25:05 +0000917 if isinstance(arg, int):
918 return _ParsedIssueNumberArgument(issue=arg)
919 if not isinstance(arg, basestring):
920 return fail_result
921
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000922 if arg.isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +0000923 return _ParsedIssueNumberArgument(issue=int(arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000924 if not arg.startswith('http'):
925 return fail_result
Aaron Gableaee6c852017-06-26 12:49:01 -0700926
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000927 url = gclient_utils.UpgradeToHttps(arg)
928 try:
Edward Lemur79d4f992019-11-11 23:49:02 +0000929 parsed_url = urllib.parse.urlparse(url)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000930 except ValueError:
931 return fail_result
Andrii Shyshkalov28d840e2017-04-10 15:45:09 +0200932
Edward Lemur678a6842019-10-03 22:25:05 +0000933 # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]]
934 # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]]
935 # Short urls like https://domain/<issue_number> can be used, but don't allow
936 # specifying the patchset (you'd 404), but we allow that here.
937 if parsed_url.path == '/':
938 part = parsed_url.fragment
939 else:
940 part = parsed_url.path
941
942 match = re.match(
943 r'(/c(/.*/\+)?)?/(?P<issue>\d+)(/(?P<patchset>\d+)?/?)?$', part)
944 if not match:
945 return fail_result
946
947 issue = int(match.group('issue'))
948 patchset = match.group('patchset')
949 return _ParsedIssueNumberArgument(
950 issue=issue,
951 patchset=int(patchset) if patchset else None,
952 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000953
954
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000955def _create_description_from_log(args):
956 """Pulls out the commit log to use as a base for the CL description."""
957 log_args = []
958 if len(args) == 1 and not args[0].endswith('.'):
959 log_args = [args[0] + '..']
960 elif len(args) == 1 and args[0].endswith('...'):
961 log_args = [args[0][:-1]]
962 elif len(args) == 2:
963 log_args = [args[0] + '..' + args[1]]
964 else:
965 log_args = args[:] # Hope for the best!
966 return RunGit(['log', '--pretty=format:%s\n\n%b'] + log_args)
967
968
Aaron Gablea45ee112016-11-22 15:14:38 -0800969class GerritChangeNotExists(Exception):
tandriic2405f52016-10-10 08:13:15 -0700970 def __init__(self, issue, url):
971 self.issue = issue
972 self.url = url
Aaron Gablea45ee112016-11-22 15:14:38 -0800973 super(GerritChangeNotExists, self).__init__()
tandriic2405f52016-10-10 08:13:15 -0700974
975 def __str__(self):
Aaron Gablea45ee112016-11-22 15:14:38 -0800976 return 'change %s at %s does not exist or you have no access to it' % (
tandriic2405f52016-10-10 08:13:15 -0700977 self.issue, self.url)
978
979
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100980_CommentSummary = collections.namedtuple(
Quinten Yearsley0e617c02019-02-20 00:37:03 +0000981 '_CommentSummary', ['date', 'message', 'sender', 'autogenerated',
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +0100982 # TODO(tandrii): these two aren't known in Gerrit.
983 'approval', 'disapproval'])
984
985
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000986class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000987 """Changelist works with one changelist in local branch.
988
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +0000989 Notes:
990 * Not safe for concurrent multi-{thread,process} use.
991 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -0700992 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000993 """
994
Edward Lemur125d60a2019-09-13 18:25:41 +0000995 def __init__(self, branchref=None, issue=None, codereview_host=None):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000996 """Create a new ChangeList instance.
997
Edward Lemurf38bc172019-09-03 21:02:13 +0000998 **kwargs will be passed directly to Gerrit implementation.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000999 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001000 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +00001001 global settings
1002 if not settings:
1003 # Happens when git_cl.py is used as a utility library.
1004 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001005
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001006 self.branchref = branchref
1007 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00001008 assert branchref.startswith('refs/heads/')
Edward Lemur85153282020-02-14 22:06:29 +00001009 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001010 else:
1011 self.branch = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001012 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001013 self.lookedup_issue = False
1014 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001015 self.description = None
Edward Lemur9aa1a962020-02-25 00:58:38 +00001016 self.local_description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001017 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001018 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001019 self.cc = None
Daniel Cheng7227d212017-11-17 08:12:37 -08001020 self.more_cc = []
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001021 self._remote = None
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001022 self._cached_remote_url = (False, None) # (is_cached, value)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001023
Edward Lemur125d60a2019-09-13 18:25:41 +00001024 # Lazily cached values.
1025 self._gerrit_host = None # e.g. chromium-review.googlesource.com
1026 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
1027 # Map from change number (issue) to its detail cache.
1028 self._detail_cache = {}
1029
1030 if codereview_host is not None:
1031 assert not codereview_host.startswith('https://'), codereview_host
1032 self._gerrit_host = codereview_host
1033 self._gerrit_server = 'https://%s' % codereview_host
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001034
1035 def GetCCList(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001036 """Returns the users cc'd on this CL.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001037
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001038 The return value is a string suitable for passing to git cl with the --cc
1039 flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001040 """
1041 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001042 base_cc = settings.GetDefaultCCList()
Daniel Cheng7227d212017-11-17 08:12:37 -08001043 more_cc = ','.join(self.more_cc)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001044 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1045 return self.cc
1046
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001047 def GetCCListWithoutDefault(self):
1048 """Return the users cc'd on this CL excluding default ones."""
1049 if self.cc is None:
Daniel Cheng7227d212017-11-17 08:12:37 -08001050 self.cc = ','.join(self.more_cc)
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001051 return self.cc
1052
Daniel Cheng7227d212017-11-17 08:12:37 -08001053 def ExtendCC(self, more_cc):
1054 """Extends the list of users to cc on this CL based on the changed files."""
1055 self.more_cc.extend(more_cc)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001056
1057 def GetBranch(self):
1058 """Returns the short branch name, e.g. 'master'."""
1059 if not self.branch:
Edward Lemur85153282020-02-14 22:06:29 +00001060 branchref = scm.GIT.GetBranchRef(settings.GetRoot())
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001061 if not branchref:
1062 return None
1063 self.branchref = branchref
Edward Lemur85153282020-02-14 22:06:29 +00001064 self.branch = scm.GIT.ShortBranchName(self.branchref)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001065 return self.branch
1066
1067 def GetBranchRef(self):
1068 """Returns the full branch name, e.g. 'refs/heads/master'."""
1069 self.GetBranch() # Poke the lazy loader.
1070 return self.branchref
1071
tandrii@chromium.org534f67a2016-04-07 18:47:05 +00001072 def ClearBranch(self):
1073 """Clears cached branch data of this object."""
1074 self.branch = self.branchref = None
1075
Edward Lemur85153282020-02-14 22:06:29 +00001076 def _GitGetBranchConfigValue(self, key, default=None):
1077 return scm.GIT.GetBranchConfig(
1078 settings.GetRoot(), self.GetBranch(), key, default)
tandrii5d48c322016-08-18 16:19:37 -07001079
Edward Lemur85153282020-02-14 22:06:29 +00001080 def _GitSetBranchConfigValue(self, key, value):
1081 action = 'set %s to %r' % (key, value)
1082 if not value:
1083 action = 'unset %s' % key
1084 assert self.GetBranch(), 'a branch is needed to ' + action
1085 return scm.GIT.SetBranchConfig(
1086 settings.GetRoot(), self.GetBranch(), key, value)
tandrii5d48c322016-08-18 16:19:37 -07001087
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001088 @staticmethod
1089 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001090 """Returns a tuple containing remote and remote ref,
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001091 e.g. 'origin', 'refs/heads/master'
1092 """
Edward Lemur15a9b8c2020-02-13 00:52:30 +00001093 remote, upstream_branch = scm.GIT.FetchUpstreamTuple(
1094 settings.GetRoot(), branch)
1095 if not remote or not upstream_branch:
1096 DieWithError(
1097 'Unable to determine default branch to diff against.\n'
1098 'Either pass complete "git diff"-style arguments, like\n'
1099 ' git cl upload origin/master\n'
1100 'or verify this branch is set up to track another \n'
1101 '(via the --track argument to "git checkout -b ...").')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001102
1103 return remote, upstream_branch
1104
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001105 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001106 upstream_branch = self.GetUpstreamBranch()
1107 if not BranchExists(upstream_branch):
1108 DieWithError('The upstream for the current branch (%s) does not exist '
1109 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001110 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001111 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001112
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001113 def GetUpstreamBranch(self):
1114 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001115 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Raul Tambrefe1dbe12019-05-02 04:43:57 +00001116 if remote != '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001117 upstream_branch = upstream_branch.replace('refs/heads/',
1118 'refs/remotes/%s/' % remote)
1119 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1120 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001121 self.upstream_branch = upstream_branch
1122 return self.upstream_branch
1123
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001124 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001125 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001126 remote, branch = None, self.GetBranch()
1127 seen_branches = set()
1128 while branch not in seen_branches:
1129 seen_branches.add(branch)
1130 remote, branch = self.FetchUpstreamTuple(branch)
Edward Lemur85153282020-02-14 22:06:29 +00001131 branch = scm.GIT.ShortBranchName(branch)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001132 if remote != '.' or branch.startswith('refs/remotes'):
1133 break
1134 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001135 remotes = RunGit(['remote'], error_ok=True).split()
1136 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001137 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001138 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001139 remote = 'origin'
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001140 logging.warn('Could not determine which remote this change is '
1141 'associated with, so defaulting to "%s".' % self._remote)
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001142 else:
1143 logging.warn('Could not determine which remote this change is '
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001144 'associated with.')
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001145 branch = 'HEAD'
1146 if branch.startswith('refs/remotes'):
1147 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001148 elif branch.startswith('refs/branch-heads/'):
1149 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001150 else:
1151 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001152 return self._remote
1153
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001154 def GitSanityChecks(self, upstream_git_obj):
1155 """Checks git repo status and ensures diff is from local commits."""
1156
sbc@chromium.org79706062015-01-14 21:18:12 +00001157 if upstream_git_obj is None:
1158 if self.GetBranch() is None:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001159 print('ERROR: Unable to determine current branch (detached HEAD?)',
vapiera7fbd5a2016-06-16 09:17:49 -07001160 file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001161 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001162 print('ERROR: No upstream branch.', file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001163 return False
1164
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001165 # Verify the commit we're diffing against is in our current branch.
1166 upstream_sha = RunGit(['rev-parse', '--verify', upstream_git_obj]).strip()
1167 common_ancestor = RunGit(['merge-base', upstream_sha, 'HEAD']).strip()
1168 if upstream_sha != common_ancestor:
vapiera7fbd5a2016-06-16 09:17:49 -07001169 print('ERROR: %s is not in the current branch. You may need to rebase '
1170 'your tracking branch' % upstream_sha, file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001171 return False
1172
1173 # List the commits inside the diff, and verify they are all local.
1174 commits_in_diff = RunGit(
1175 ['rev-list', '^%s' % upstream_sha, 'HEAD']).splitlines()
1176 code, remote_branch = RunGitWithCode(['config', 'gitcl.remotebranch'])
1177 remote_branch = remote_branch.strip()
1178 if code != 0:
1179 _, remote_branch = self.GetRemoteBranch()
1180
1181 commits_in_remote = RunGit(
1182 ['rev-list', '^%s' % upstream_sha, remote_branch]).splitlines()
1183
1184 common_commits = set(commits_in_diff) & set(commits_in_remote)
1185 if common_commits:
vapiera7fbd5a2016-06-16 09:17:49 -07001186 print('ERROR: Your diff contains %d commits already in %s.\n'
1187 'Run "git log --oneline %s..HEAD" to get a list of commits in '
1188 'the diff. If you are using a custom git flow, you can override'
1189 ' the reference used for this check with "git config '
1190 'gitcl.remotebranch <git-ref>".' % (
1191 len(common_commits), remote_branch, upstream_git_obj),
1192 file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001193 return False
1194 return True
1195
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001196 def GetGitBaseUrlFromConfig(self):
sheyang@chromium.orga656e702014-05-15 20:43:05 +00001197 """Return the configured base URL from branch.<branchname>.baseurl.
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001198
1199 Returns None if it is not set.
1200 """
tandrii5d48c322016-08-18 16:19:37 -07001201 return self._GitGetBranchConfigValue('base-url')
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001202
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001203 def GetRemoteUrl(self):
1204 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1205
1206 Returns None if there is no remote.
1207 """
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001208 is_cached, value = self._cached_remote_url
1209 if is_cached:
1210 return value
1211
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001212 remote, _ = self.GetRemoteBranch()
Edward Lemur26964072020-02-19 19:18:51 +00001213 url = scm.GIT.GetConfig(settings.GetRoot(), 'remote.%s.url' % remote, '')
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001214
Edward Lemur298f2cf2019-02-22 21:40:39 +00001215 # Check if the remote url can be parsed as an URL.
Edward Lemur79d4f992019-11-11 23:49:02 +00001216 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001217 if host:
1218 self._cached_remote_url = (True, url)
1219 return url
1220
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001221 # If it cannot be parsed as an url, assume it is a local directory,
1222 # probably a git cache.
Edward Lemur298f2cf2019-02-22 21:40:39 +00001223 logging.warning('"%s" doesn\'t appear to point to a git host. '
1224 'Interpreting it as a local directory.', url)
1225 if not os.path.isdir(url):
1226 logging.error(
Josip906bfde2020-01-31 22:38:49 +00001227 'Remote "%(remote)s" for branch "%(branch)s" points to "%(url)s", '
1228 'but it doesn\'t exist.',
1229 {'remote': remote, 'branch': self.GetBranch(), 'url': url})
Edward Lemur298f2cf2019-02-22 21:40:39 +00001230 return None
1231
1232 cache_path = url
Edward Lemur26964072020-02-19 19:18:51 +00001233 url = scm.GIT.GetConfig(url, 'remote.%s.url' % remote, '')
Edward Lemur298f2cf2019-02-22 21:40:39 +00001234
Edward Lemur79d4f992019-11-11 23:49:02 +00001235 host = urllib.parse.urlparse(url).netloc
Edward Lemur298f2cf2019-02-22 21:40:39 +00001236 if not host:
1237 logging.error(
1238 'Remote "%(remote)s" for branch "%(branch)s" points to '
1239 '"%(cache_path)s", but it is misconfigured.\n'
1240 '"%(cache_path)s" must be a git repo and must have a remote named '
1241 '"%(remote)s" pointing to the git host.', {
1242 'remote': remote,
1243 'cache_path': cache_path,
1244 'branch': self.GetBranch()})
1245 return None
1246
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001247 self._cached_remote_url = (True, url)
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001248 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001249
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001250 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001251 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001252 if self.issue is None and not self.lookedup_issue:
Edward Lemur85153282020-02-14 22:06:29 +00001253 self.issue = self._GitGetBranchConfigValue(self.IssueConfigKey())
1254 if self.issue is not None:
1255 self.issue = int(self.issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001256 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001257 return self.issue
1258
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001259 def GetIssueURL(self):
1260 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001261 issue = self.GetIssue()
1262 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001263 return None
Edward Lemur125d60a2019-09-13 18:25:41 +00001264 return '%s/%s' % (self.GetCodereviewServer(), issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001265
Edward Lemur7f6dec02020-02-06 20:23:58 +00001266 def GetLocalDescription(self, upstream_branch):
1267 """Return the log messages of all commits up to the branch point."""
Edward Lemur9aa1a962020-02-25 00:58:38 +00001268 if self.local_description is None:
1269 args = ['log', '--pretty=format:%s%n%n%b', '%s...' % (upstream_branch)]
1270 self.local_description = RunGitWithCode(args)[1].strip()
1271 return self.local_description
Edward Lemur7f6dec02020-02-06 20:23:58 +00001272
Edward Lemur6c6827c2020-02-06 21:15:18 +00001273 def FetchDescription(self, pretty=False):
1274 assert self.GetIssue(), 'issue is required to query Gerrit'
1275
Edward Lemur9aa1a962020-02-25 00:58:38 +00001276 if self.description is None:
Edward Lemur6c6827c2020-02-06 21:15:18 +00001277 data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
1278 current_rev = data['current_revision']
1279 self.description = data['revisions'][current_rev]['commit']['message']
Edward Lemur6c6827c2020-02-06 21:15:18 +00001280
1281 if not pretty:
1282 return self.description
1283
1284 # Set width to 72 columns + 2 space indent.
1285 wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True)
1286 wrapper.initial_indent = wrapper.subsequent_indent = ' '
1287 lines = self.description.splitlines()
1288 return '\n'.join([wrapper.fill(line) for line in lines])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001289
1290 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001291 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001292 if self.patchset is None and not self.lookedup_patchset:
Edward Lemur85153282020-02-14 22:06:29 +00001293 self.patchset = self._GitGetBranchConfigValue(self.PatchsetConfigKey())
1294 if self.patchset is not None:
1295 self.patchset = int(self.patchset)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001296 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001297 return self.patchset
1298
Edward Lemur9aa1a962020-02-25 00:58:38 +00001299 def GetAuthor(self):
1300 return scm.GIT.GetConfig(settings.GetRoot(), 'user.email')
1301
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001302 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001303 """Set this branch's patchset. If patchset=0, clears the patchset."""
1304 assert self.GetBranch()
1305 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001306 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001307 else:
1308 self.patchset = int(patchset)
1309 self._GitSetBranchConfigValue(
Edward Lemur85153282020-02-14 22:06:29 +00001310 self.PatchsetConfigKey(), str(self.patchset))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001311
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001312 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001313 """Set this branch's issue. If issue isn't given, clears the issue."""
1314 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001315 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001316 issue = int(issue)
1317 self._GitSetBranchConfigValue(
Edward Lemur85153282020-02-14 22:06:29 +00001318 self.IssueConfigKey(), str(issue))
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001319 self.issue = issue
Edward Lemur125d60a2019-09-13 18:25:41 +00001320 codereview_server = self.GetCodereviewServer()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001321 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001322 self._GitSetBranchConfigValue(
Edward Lemur125d60a2019-09-13 18:25:41 +00001323 self.CodereviewServerConfigKey(),
tandrii5d48c322016-08-18 16:19:37 -07001324 codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001325 else:
tandrii5d48c322016-08-18 16:19:37 -07001326 # Reset all of these just to be clean.
1327 reset_suffixes = [
1328 'last-upload-hash',
Edward Lemur125d60a2019-09-13 18:25:41 +00001329 self.IssueConfigKey(),
1330 self.PatchsetConfigKey(),
1331 self.CodereviewServerConfigKey(),
tandrii5d48c322016-08-18 16:19:37 -07001332 ] + self._PostUnsetIssueProperties()
1333 for prop in reset_suffixes:
Edward Lemur85153282020-02-14 22:06:29 +00001334 try:
1335 self._GitSetBranchConfigValue(prop, None)
1336 except subprocess2.CalledProcessError:
1337 pass
Aaron Gableca01e2c2017-07-19 11:16:02 -07001338 msg = RunGit(['log', '-1', '--format=%B']).strip()
1339 if msg and git_footers.get_footer_change_id(msg):
1340 print('WARNING: The change patched into this branch has a Change-Id. '
1341 'Removing it.')
1342 RunGit(['commit', '--amend', '-m',
1343 git_footers.remove_footer(msg, 'Change-Id')])
Edward Lemurf38bc172019-09-03 21:02:13 +00001344 self.lookedup_issue = True
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001345 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001346 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001347
Edward Lemur7f6dec02020-02-06 20:23:58 +00001348 def GetChange(self, upstream_branch):
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001349 if not self.GitSanityChecks(upstream_branch):
1350 DieWithError('\nGit sanity check failure')
1351
Edward Lemur7f6dec02020-02-06 20:23:58 +00001352 root = settings.GetRoot()
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001353 # We use the sha1 of HEAD as a name of this change.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001354 name = RunGitWithCode(['rev-parse', 'HEAD'])[1].strip()
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001355 try:
Edward Lemur7f6dec02020-02-06 20:23:58 +00001356 files = scm.GIT.CaptureStatus(root, upstream_branch)
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001357 except subprocess2.CalledProcessError:
1358 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001359 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001360 'This branch probably doesn\'t exist anymore. To reset the\n'
1361 'tracking branch, please run\n'
stip7a3dd352016-09-22 17:32:28 -07001362 ' git branch --set-upstream-to origin/master %s\n'
1363 'or replace origin/master with the relevant branch') %
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001364 (upstream_branch, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001365
maruel@chromium.org52424302012-08-29 15:14:30 +00001366 issue = self.GetIssue()
1367 patchset = self.GetPatchset()
Edward Lemur7f6dec02020-02-06 20:23:58 +00001368 if issue:
Edward Lemur6c6827c2020-02-06 21:15:18 +00001369 description = self.FetchDescription()
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001370 else:
1371 # If the change was never uploaded, use the log messages of all commits
1372 # up to the branch point, as git cl upload will prefill the description
1373 # with these log messages.
Edward Lemur7f6dec02020-02-06 20:23:58 +00001374 description = self.GetLocalDescription(upstream_branch)
maruel@chromium.org03b3bdc2011-06-14 13:04:12 +00001375
Edward Lemur9aa1a962020-02-25 00:58:38 +00001376 author = self.GetAuthor()
asvitkine@chromium.org15169952011-09-27 14:30:53 +00001377 return presubmit_support.GitChange(
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001378 name,
1379 description,
Edward Lemur7f6dec02020-02-06 20:23:58 +00001380 root,
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001381 files,
1382 issue,
1383 patchset,
agable@chromium.orgea84ef12014-04-30 19:55:12 +00001384 author,
1385 upstream=upstream_branch)
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001386
dsansomee2d6fd92016-09-08 00:10:47 -07001387 def UpdateDescription(self, description, force=False):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001388 assert self.GetIssue(), 'issue is required to update description'
1389
1390 if gerrit_util.HasPendingChangeEdit(
1391 self._GetGerritHost(), self._GerritChangeIdentifier()):
1392 if not force:
1393 confirm_or_exit(
1394 'The description cannot be modified while the issue has a pending '
1395 'unpublished edit. Either publish the edit in the Gerrit web UI '
1396 'or delete it.\n\n', action='delete the unpublished edit')
1397
1398 gerrit_util.DeletePendingChangeEdit(
1399 self._GetGerritHost(), self._GerritChangeIdentifier())
1400 gerrit_util.SetCommitMessage(
1401 self._GetGerritHost(), self._GerritChangeIdentifier(),
1402 description, notify='NONE')
1403
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001404 self.description = description
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001405
Edward Lemur75526302020-02-27 22:31:05 +00001406 def _GetCommonPresubmitArgs(self, verbose, upstream):
Edward Lemur227d5102020-02-25 23:45:35 +00001407 args = [
Edward Lemur227d5102020-02-25 23:45:35 +00001408 '--author', self.GetAuthor(),
1409 '--root', settings.GetRoot(),
1410 '--upstream', upstream,
1411 ]
1412
1413 args.extend(['--verbose'] * verbose)
1414
1415 issue = self.GetIssue()
1416 patchset = self.GetPatchset()
1417 gerrit_url = self.GetCodereviewServer()
1418 if issue:
1419 args.extend(['--issue', str(issue)])
1420 if patchset:
1421 args.extend(['--patchset', str(patchset)])
1422 if gerrit_url:
1423 args.extend(['--gerrit_url', gerrit_url])
1424
Edward Lemur75526302020-02-27 22:31:05 +00001425 return args
1426
1427 def RunHook(
1428 self, committing, may_prompt, verbose, parallel, upstream, description,
1429 all_files):
1430 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1431 args = self._GetCommonPresubmitArgs(verbose, upstream)
1432 args.append('--commit' if committing else '--upload')
Edward Lemur227d5102020-02-25 23:45:35 +00001433 if may_prompt:
1434 args.append('--may_prompt')
1435 if parallel:
1436 args.append('--parallel')
1437 if all_files:
1438 args.append('--all_files')
1439
1440 with gclient_utils.temporary_file() as description_file:
1441 with gclient_utils.temporary_file() as json_output:
Edward Lemur1a83da12020-03-04 21:18:36 +00001442
1443 gclient_utils.FileWrite(description_file, description)
Edward Lemur227d5102020-02-25 23:45:35 +00001444 args.extend(['--json_output', json_output])
1445 args.extend(['--description_file', description_file])
1446
1447 start = time_time()
1448 p = subprocess2.Popen(['vpython', PRESUBMIT_SUPPORT] + args)
1449 exit_code = p.wait()
1450 metrics.collector.add_repeated('sub_commands', {
1451 'command': 'presubmit',
1452 'execution_time': time_time() - start,
1453 'exit_code': exit_code,
1454 })
1455
1456 if exit_code:
1457 sys.exit(exit_code)
1458
1459 json_results = gclient_utils.FileRead(json_output)
1460 return json.loads(json_results)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001461
Edward Lemur75526302020-02-27 22:31:05 +00001462 def RunPostUploadHook(self, verbose, upstream, description):
1463 args = self._GetCommonPresubmitArgs(verbose, upstream)
1464 args.append('--post_upload')
1465
1466 with gclient_utils.temporary_file() as description_file:
Edward Lemur1a83da12020-03-04 21:18:36 +00001467 gclient_utils.FileWrite(description_file, description)
Edward Lemur75526302020-02-27 22:31:05 +00001468 args.extend(['--description_file', description_file])
1469 p = subprocess2.Popen(['vpython', PRESUBMIT_SUPPORT] + args)
1470 p.wait()
1471
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001472 def CMDUpload(self, options, git_diff_args, orig_args):
1473 """Uploads a change to codereview."""
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001474 custom_cl_base = None
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001475 if git_diff_args:
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001476 custom_cl_base = base_branch = git_diff_args[0]
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001477 else:
1478 if self.GetBranch() is None:
1479 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1480
1481 # Default to diffing against common ancestor of upstream branch
1482 base_branch = self.GetCommonAncestorWithUpstream()
1483 git_diff_args = [base_branch, 'HEAD']
1484
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001485 # Fast best-effort checks to abort before running potentially expensive
1486 # hooks if uploading is likely to fail anyway. Passing these checks does
1487 # not guarantee that uploading will not fail.
Edward Lemur125d60a2019-09-13 18:25:41 +00001488 self.EnsureAuthenticated(force=options.force)
1489 self.EnsureCanUploadPatchset(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001490
1491 # Apply watchlists on upload.
Edward Lemur7f6dec02020-02-06 20:23:58 +00001492 change = self.GetChange(base_branch)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001493 watchlist = watchlists.Watchlists(change.RepositoryRoot())
1494 files = [f.LocalPath() for f in change.AffectedFiles()]
1495 if not options.bypass_watchlists:
Daniel Cheng7227d212017-11-17 08:12:37 -08001496 self.ExtendCC(watchlist.GetWatchersForPaths(files))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001497
Edward Lemur1a83da12020-03-04 21:18:36 +00001498 if self.GetIssue():
1499 description = self.FetchDescription()
1500 else:
1501 description = self.GetLocalDescription(base_branch)
Edward Lemur75526302020-02-27 22:31:05 +00001502 if options.reviewers or options.tbrs or options.add_owners_to:
1503 # Set the reviewer list now so that presubmit checks can access it.
1504 change_description = ChangeDescription(description)
1505 change_description.update_reviewers(options.reviewers,
1506 options.tbrs,
1507 options.add_owners_to,
1508 change)
1509 description = change_description.description
1510
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001511 if not options.bypass_hooks:
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001512 hook_results = self.RunHook(committing=False,
Edward Lesmes8e282792018-04-03 18:50:29 -04001513 may_prompt=not options.force,
1514 verbose=options.verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00001515 parallel=options.parallel,
1516 upstream=base_branch,
1517 description=description,
1518 all_files=False)
1519 self.ExtendCC(hook_results['more_cc'])
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001520
Aaron Gable13101a62018-02-09 13:20:41 -08001521 print_stats(git_diff_args)
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001522 ret = self.CMDUploadChange(options, git_diff_args, custom_cl_base, change)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001523 if not ret:
Edward Lemur85153282020-02-14 22:06:29 +00001524 self._GitSetBranchConfigValue(
1525 'last-upload-hash', RunGit(['rev-parse', 'HEAD']).strip())
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001526 # Run post upload hooks, if specified.
1527 if settings.GetRunPostUploadHook():
Edward Lemur75526302020-02-27 22:31:05 +00001528 self.RunPostUploadHook(options.verbose, base_branch, description)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001529
1530 # Upload all dependencies if specified.
1531 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001532 print()
1533 print('--dependencies has been specified.')
1534 print('All dependent local branches will be re-uploaded.')
1535 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001536 # Remove the dependencies flag from args so that we do not end up in a
1537 # loop.
1538 orig_args.remove('--dependencies')
1539 ret = upload_branch_deps(self, orig_args)
1540 return ret
1541
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001542 def SetCQState(self, new_state):
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001543 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001544
1545 Issue must have been already uploaded and known.
1546 """
1547 assert new_state in _CQState.ALL_STATES
1548 assert self.GetIssue()
qyearsley1fdfcb62016-10-24 13:22:03 -07001549 try:
Edward Lemur125d60a2019-09-13 18:25:41 +00001550 vote_map = {
1551 _CQState.NONE: 0,
1552 _CQState.DRY_RUN: 1,
1553 _CQState.COMMIT: 2,
1554 }
1555 labels = {'Commit-Queue': vote_map[new_state]}
1556 notify = False if new_state == _CQState.DRY_RUN else None
1557 gerrit_util.SetReview(
1558 self._GetGerritHost(), self._GerritChangeIdentifier(),
1559 labels=labels, notify=notify)
qyearsley1fdfcb62016-10-24 13:22:03 -07001560 return 0
1561 except KeyboardInterrupt:
1562 raise
1563 except:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001564 print('WARNING: Failed to %s.\n'
qyearsley1fdfcb62016-10-24 13:22:03 -07001565 'Either:\n'
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001566 ' * Your project has no CQ,\n'
1567 ' * You don\'t have permission to change the CQ state,\n'
1568 ' * There\'s a bug in this code (see stack trace below).\n'
1569 'Consider specifying which bots to trigger manually or asking your '
1570 'project owners for permissions or contacting Chrome Infra at:\n'
1571 'https://www.chromium.org/infra\n\n' %
1572 ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ'))
qyearsley1fdfcb62016-10-24 13:22:03 -07001573 # Still raise exception so that stack trace is printed.
1574 raise
1575
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001576 def _GetGerritHost(self):
1577 # Lazy load of configs.
1578 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07001579 if self._gerrit_host and '.' not in self._gerrit_host:
1580 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
1581 # This happens for internal stuff http://crbug.com/614312.
Edward Lemur79d4f992019-11-11 23:49:02 +00001582 parsed = urllib.parse.urlparse(self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001583 if parsed.scheme == 'sso':
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001584 print('WARNING: using non-https URLs for remote is likely broken\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001585 ' Your current remote is: %s' % self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001586 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
1587 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001588 return self._gerrit_host
1589
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001590 def _GetGitHost(self):
1591 """Returns git host to be used when uploading change to Gerrit."""
Edward Lemur298f2cf2019-02-22 21:40:39 +00001592 remote_url = self.GetRemoteUrl()
1593 if not remote_url:
1594 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001595 return urllib.parse.urlparse(remote_url).netloc
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001596
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001597 def GetCodereviewServer(self):
1598 if not self._gerrit_server:
1599 # If we're on a branch then get the server potentially associated
1600 # with that branch.
Edward Lemur85153282020-02-14 22:06:29 +00001601 if self.GetIssue() and self.GetBranch():
tandrii5d48c322016-08-18 16:19:37 -07001602 self._gerrit_server = self._GitGetBranchConfigValue(
1603 self.CodereviewServerConfigKey())
1604 if self._gerrit_server:
Edward Lemur79d4f992019-11-11 23:49:02 +00001605 self._gerrit_host = urllib.parse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001606 if not self._gerrit_server:
1607 # We assume repo to be hosted on Gerrit, and hence Gerrit server
1608 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001609 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001610 parts[0] = parts[0] + '-review'
1611 self._gerrit_host = '.'.join(parts)
1612 self._gerrit_server = 'https://%s' % self._gerrit_host
1613 return self._gerrit_server
1614
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001615 def _GetGerritProject(self):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001616 """Returns Gerrit project name based on remote git URL."""
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001617 remote_url = self.GetRemoteUrl()
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001618 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001619 logging.warning('can\'t detect Gerrit project.')
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001620 return None
Edward Lemur79d4f992019-11-11 23:49:02 +00001621 project = urllib.parse.urlparse(remote_url).path.strip('/')
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001622 if project.endswith('.git'):
1623 project = project[:-len('.git')]
Andrii Shyshkalov1e828672018-08-23 22:34:37 +00001624 # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with
1625 # 'a/' prefix, because 'a/' prefix is used to force authentication in
1626 # gitiles/git-over-https protocol. E.g.,
1627 # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project
1628 # as
1629 # https://chromium.googlesource.com/v8/v8
1630 if project.startswith('a/'):
1631 project = project[len('a/'):]
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001632 return project
1633
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001634 def _GerritChangeIdentifier(self):
1635 """Handy method for gerrit_util.ChangeIdentifier for a given CL.
1636
1637 Not to be confused by value of "Change-Id:" footer.
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001638 If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC.
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001639 """
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001640 project = self._GetGerritProject()
1641 if project:
1642 return gerrit_util.ChangeIdentifier(project, self.GetIssue())
1643 # Fall back on still unique, but less efficient change number.
1644 return str(self.GetIssue())
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001645
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001646 @classmethod
tandrii5d48c322016-08-18 16:19:37 -07001647 def IssueConfigKey(cls):
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001648 return 'gerritissue'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001649
tandrii5d48c322016-08-18 16:19:37 -07001650 @classmethod
1651 def PatchsetConfigKey(cls):
1652 return 'gerritpatchset'
1653
1654 @classmethod
1655 def CodereviewServerConfigKey(cls):
1656 return 'gerritserver'
1657
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001658 def EnsureAuthenticated(self, force, refresh=None):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001659 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00001660 if settings.GetGerritSkipEnsureAuthenticated():
1661 # For projects with unusual authentication schemes.
1662 # See http://crbug.com/603378.
1663 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001664
1665 # Check presence of cookies only if using cookies-based auth method.
1666 cookie_auth = gerrit_util.Authenticator.get()
1667 if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001668 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001669
Florian Mayerae510e82020-01-30 21:04:48 +00001670 remote_url = self.GetRemoteUrl()
1671 if remote_url is None:
Josip906bfde2020-01-31 22:38:49 +00001672 logging.warning('invalid remote')
Florian Mayerae510e82020-01-30 21:04:48 +00001673 return
1674 if urllib.parse.urlparse(remote_url).scheme != 'https':
Josip906bfde2020-01-31 22:38:49 +00001675 logging.warning('Ignoring branch %(branch)s with non-https remote '
1676 '%(remote)s', {
1677 'branch': self.branch,
1678 'remote': self.GetRemoteUrl()
1679 })
Daniel Chengcf6269b2019-05-18 01:02:12 +00001680 return
1681
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001682 # Lazy-loader to identify Gerrit and Git hosts.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001683 self.GetCodereviewServer()
1684 git_host = self._GetGitHost()
Edward Lemur298f2cf2019-02-22 21:40:39 +00001685 assert self._gerrit_server and self._gerrit_host and git_host
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001686
1687 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
1688 git_auth = cookie_auth.get_auth_header(git_host)
1689 if gerrit_auth and git_auth:
1690 if gerrit_auth == git_auth:
1691 return
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001692 all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com')
Raul Tambre80ee78e2019-05-06 22:41:05 +00001693 print(
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001694 'WARNING: You have different credentials for Gerrit and git hosts:\n'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001695 ' %s\n'
1696 ' %s\n'
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001697 ' Consider running the following command:\n'
1698 ' git cl creds-check\n'
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001699 ' %s\n'
Raul Tambre80ee78e2019-05-06 22:41:05 +00001700 ' %s' %
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001701 (git_host, self._gerrit_host,
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001702 ('Hint: delete creds for .googlesource.com' if all_gsrc else ''),
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001703 cookie_auth.get_new_password_message(git_host)))
1704 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001705 confirm_or_exit('If you know what you are doing', action='continue')
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001706 return
1707 else:
1708 missing = (
Anna Henningsen4e891442017-07-06 21:40:58 +02001709 ([] if gerrit_auth else [self._gerrit_host]) +
1710 ([] if git_auth else [git_host]))
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001711 DieWithError('Credentials for the following hosts are required:\n'
1712 ' %s\n'
1713 'These are read from %s (or legacy %s)\n'
1714 '%s' % (
1715 '\n '.join(missing),
1716 cookie_auth.get_gitcookies_path(),
1717 cookie_auth.get_netrc_path(),
1718 cookie_auth.get_new_password_message(git_host)))
1719
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001720 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001721 if not self.GetIssue():
1722 return
1723
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001724 status = self._GetChangeDetail()['status']
1725 if status in ('MERGED', 'ABANDONED'):
1726 DieWithError('Change %s has been %s, new uploads are not allowed' %
1727 (self.GetIssueURL(),
1728 'submitted' if status == 'MERGED' else 'abandoned'))
1729
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001730 # TODO(vadimsh): For some reason the chunk of code below was skipped if
1731 # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'.
1732 # Apparently this check is not very important? Otherwise get_auth_email
1733 # could have been added to other implementations of Authenticator.
1734 cookies_auth = gerrit_util.Authenticator.get()
1735 if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator):
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001736 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001737
1738 cookies_user = cookies_auth.get_auth_email(self._GetGerritHost())
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001739 if self.GetIssueOwner() == cookies_user:
1740 return
1741 logging.debug('change %s owner is %s, cookies user is %s',
1742 self.GetIssue(), self.GetIssueOwner(), cookies_user)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001743 # Maybe user has linked accounts or something like that,
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001744 # so ask what Gerrit thinks of this user.
1745 details = gerrit_util.GetAccountDetails(self._GetGerritHost(), 'self')
1746 if details['email'] == self.GetIssueOwner():
1747 return
1748 if not force:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001749 print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit '
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001750 'as %s.\n'
1751 'Uploading may fail due to lack of permissions.' %
1752 (self.GetIssue(), self.GetIssueOwner(), details['email']))
1753 confirm_or_exit(action='upload')
1754
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001755 def _PostUnsetIssueProperties(self):
1756 """Which branch-specific properties to erase when unsetting issue."""
tandrii5d48c322016-08-18 16:19:37 -07001757 return ['gerritsquashhash']
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001758
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001759 def GetGerritObjForPresubmit(self):
1760 return presubmit_support.GerritAccessor(self._GetGerritHost())
1761
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001762 def GetStatus(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001763 """Applies a rough heuristic to give a simple summary of an issue's review
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001764 or CQ status, assuming adherence to a common workflow.
1765
1766 Returns None if no issue for this branch, or one of the following keywords:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001767 * 'error' - error from review tool (including deleted issues)
1768 * 'unsent' - no reviewers added
1769 * 'waiting' - waiting for review
1770 * 'reply' - waiting for uploader to reply to review
1771 * 'lgtm' - Code-Review label has been set
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001772 * 'dry-run' - dry-running in the CQ
1773 * 'commit' - in the CQ
Aaron Gable9ab38c62017-04-06 14:36:33 -07001774 * 'closed' - successfully submitted or abandoned
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001775 """
1776 if not self.GetIssue():
1777 return None
1778
1779 try:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001780 data = self._GetChangeDetail([
1781 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE'])
Edward Lemur79d4f992019-11-11 23:49:02 +00001782 except GerritChangeNotExists:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001783 return 'error'
1784
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00001785 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001786 return 'closed'
1787
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001788 cq_label = data['labels'].get('Commit-Queue', {})
1789 max_cq_vote = 0
1790 for vote in cq_label.get('all', []):
1791 max_cq_vote = max(max_cq_vote, vote.get('value', 0))
1792 if max_cq_vote == 2:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001793 return 'commit'
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001794 if max_cq_vote == 1:
1795 return 'dry-run'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001796
Aaron Gable9ab38c62017-04-06 14:36:33 -07001797 if data['labels'].get('Code-Review', {}).get('approved'):
1798 return 'lgtm'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001799
1800 if not data.get('reviewers', {}).get('REVIEWER', []):
1801 return 'unsent'
1802
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001803 owner = data['owner'].get('_account_id')
Edward Lemur79d4f992019-11-11 23:49:02 +00001804 messages = sorted(data.get('messages', []), key=lambda m: m.get('date'))
Aaron Gable9ab38c62017-04-06 14:36:33 -07001805 last_message_author = messages.pop().get('author', {})
1806 while last_message_author:
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001807 if last_message_author.get('email') == COMMIT_BOT_EMAIL:
1808 # Ignore replies from CQ.
Aaron Gable9ab38c62017-04-06 14:36:33 -07001809 last_message_author = messages.pop().get('author', {})
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01001810 continue
Aaron Gable9ab38c62017-04-06 14:36:33 -07001811 if last_message_author.get('_account_id') == owner:
1812 # Most recent message was by owner.
1813 return 'waiting'
1814 else:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001815 # Some reply from non-owner.
1816 return 'reply'
Aaron Gable9ab38c62017-04-06 14:36:33 -07001817
1818 # Somehow there are no messages even though there are reviewers.
1819 return 'unsent'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001820
1821 def GetMostRecentPatchset(self):
Edward Lemur6c6827c2020-02-06 21:15:18 +00001822 if not self.GetIssue():
1823 return None
1824
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001825 data = self._GetChangeDetail(['CURRENT_REVISION'])
Aaron Gablee8856ee2017-12-07 12:41:46 -08001826 patchset = data['revisions'][data['current_revision']]['_number']
1827 self.SetPatchset(patchset)
1828 return patchset
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001829
Aaron Gable636b13f2017-07-14 10:42:48 -07001830 def AddComment(self, message, publish=None):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001831 gerrit_util.SetReview(
1832 self._GetGerritHost(), self._GerritChangeIdentifier(),
1833 msg=message, ready=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001834
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001835 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalov5a0cf202017-03-17 16:14:59 +01001836 # DETAILED_ACCOUNTS is to get emails in accounts.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001837 # CURRENT_REVISION is included to get the latest patchset so that
1838 # only the robot comments from the latest patchset can be shown.
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001839 messages = self._GetChangeDetail(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001840 options=['MESSAGES', 'DETAILED_ACCOUNTS',
1841 'CURRENT_REVISION']).get('messages', [])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001842 file_comments = gerrit_util.GetChangeComments(
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001843 self._GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001844 robot_file_comments = gerrit_util.GetChangeRobotComments(
1845 self._GetGerritHost(), self._GerritChangeIdentifier())
1846
1847 # Add the robot comments onto the list of comments, but only
Andrii Shyshkalovaeee6a82019-10-09 21:56:25 +00001848 # keep those that are from the latest patchset.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001849 latest_patch_set = self.GetMostRecentPatchset()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001850 for path, robot_comments in robot_file_comments.items():
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001851 line_comments = file_comments.setdefault(path, [])
1852 line_comments.extend(
1853 [c for c in robot_comments if c['patch_set'] == latest_patch_set])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001854
1855 # Build dictionary of file comments for easy access and sorting later.
1856 # {author+date: {path: {patchset: {line: url+message}}}}
1857 comments = collections.defaultdict(
1858 lambda: collections.defaultdict(lambda: collections.defaultdict(dict)))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00001859 for path, line_comments in file_comments.items():
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001860 for comment in line_comments:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001861 tag = comment.get('tag', '')
1862 if tag.startswith('autogenerated') and 'robot_id' not in comment:
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001863 continue
1864 key = (comment['author']['email'], comment['updated'])
1865 if comment.get('side', 'REVISION') == 'PARENT':
1866 patchset = 'Base'
1867 else:
1868 patchset = 'PS%d' % comment['patch_set']
1869 line = comment.get('line', 0)
1870 url = ('https://%s/c/%s/%s/%s#%s%s' %
1871 (self._GetGerritHost(), self.GetIssue(), comment['patch_set'], path,
1872 'b' if comment.get('side') == 'PARENT' else '',
1873 str(line) if line else ''))
1874 comments[key][path][patchset][line] = (url, comment['message'])
1875
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001876 summaries = []
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001877 for msg in messages:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001878 summary = self._BuildCommentSummary(msg, comments, readable)
1879 if summary:
1880 summaries.append(summary)
1881 return summaries
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001882
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001883 @staticmethod
1884 def _BuildCommentSummary(msg, comments, readable):
1885 key = (msg['author']['email'], msg['date'])
1886 # Don't bother showing autogenerated messages that don't have associated
1887 # file or line comments. this will filter out most autogenerated
1888 # messages, but will keep robot comments like those from Tricium.
1889 is_autogenerated = msg.get('tag', '').startswith('autogenerated')
1890 if is_autogenerated and not comments.get(key):
1891 return None
1892 message = msg['message']
1893 # Gerrit spits out nanoseconds.
1894 assert len(msg['date'].split('.')[-1]) == 9
1895 date = datetime.datetime.strptime(msg['date'][:-3],
1896 '%Y-%m-%d %H:%M:%S.%f')
1897 if key in comments:
1898 message += '\n'
1899 for path, patchsets in sorted(comments.get(key, {}).items()):
1900 if readable:
1901 message += '\n%s' % path
1902 for patchset, lines in sorted(patchsets.items()):
1903 for line, (url, content) in sorted(lines.items()):
1904 if line:
1905 line_str = 'Line %d' % line
1906 path_str = '%s:%d:' % (path, line)
1907 else:
1908 line_str = 'File comment'
1909 path_str = '%s:0:' % path
1910 if readable:
1911 message += '\n %s, %s: %s' % (patchset, line_str, url)
1912 message += '\n %s\n' % content
1913 else:
1914 message += '\n%s ' % path_str
1915 message += '\n%s\n' % content
1916
1917 return _CommentSummary(
1918 date=date,
1919 message=message,
1920 sender=msg['author']['email'],
1921 autogenerated=is_autogenerated,
1922 # These could be inferred from the text messages and correlated with
1923 # Code-Review label maximum, however this is not reliable.
1924 # Leaving as is until the need arises.
1925 approval=False,
1926 disapproval=False,
1927 )
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001928
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001929 def CloseIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001930 gerrit_util.AbandonChange(
1931 self._GetGerritHost(), self._GerritChangeIdentifier(), msg='')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001932
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001933 def SubmitIssue(self, wait_for_merge=True):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00001934 gerrit_util.SubmitChange(
1935 self._GetGerritHost(), self._GerritChangeIdentifier(),
1936 wait_for_merge=wait_for_merge)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001937
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001938 def _GetChangeDetail(self, options=None):
1939 """Returns details of associated Gerrit change and caching results."""
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00001940 options = options or []
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001941 assert self.GetIssue(), 'issue is required to query Gerrit'
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001942
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001943 # Optimization to avoid multiple RPCs:
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001944 if 'CURRENT_REVISION' in options or 'ALL_REVISIONS' in options:
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001945 options.append('CURRENT_COMMIT')
1946
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001947 # Normalize issue and options for consistent keys in cache.
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001948 cache_key = str(self.GetIssue())
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001949 options_set = frozenset(o.upper() for o in options)
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001950
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001951 for cached_options_set, data in self._detail_cache.get(cache_key, []):
1952 # Assumption: data fetched before with extra options is suitable
1953 # for return for a smaller set of options.
1954 # For example, if we cached data for
1955 # options=[CURRENT_REVISION, DETAILED_FOOTERS]
1956 # and request is for options=[CURRENT_REVISION],
1957 # THEN we can return prior cached data.
1958 if options_set.issubset(cached_options_set):
1959 return data
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001960
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001961 try:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001962 data = gerrit_util.GetChangeDetail(
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001963 self._GetGerritHost(), self._GerritChangeIdentifier(), options_set)
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001964 except gerrit_util.GerritError as e:
1965 if e.http_status == 404:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00001966 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01001967 raise
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001968
Edward Lesmes7677e5c2020-02-19 20:39:03 +00001969 self._detail_cache.setdefault(cache_key, []).append((options_set, data))
tandriic2405f52016-10-10 08:13:15 -07001970 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001971
Andrii Shyshkalovcc5f17e2018-08-22 23:35:59 +00001972 def _GetChangeCommit(self):
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001973 assert self.GetIssue(), 'issue must be set to query Gerrit'
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001974 try:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001975 data = gerrit_util.GetChangeCommit(
1976 self._GetGerritHost(), self._GerritChangeIdentifier())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001977 except gerrit_util.GerritError as e:
1978 if e.http_status == 404:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00001979 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07001980 raise
agable32978d92016-11-01 12:55:02 -07001981 return data
1982
Karen Qian40c19422019-03-13 21:28:29 +00001983 def _IsCqConfigured(self):
1984 detail = self._GetChangeDetail(['LABELS'])
Andrii Shyshkalov8effa4d2020-01-21 13:23:36 +00001985 return u'Commit-Queue' in detail.get('labels', {})
Karen Qian40c19422019-03-13 21:28:29 +00001986
Olivier Robin75ee7252018-04-13 10:02:56 +02001987 def CMDLand(self, force, bypass_hooks, verbose, parallel):
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001988 if git_common.is_dirty_git_tree('land'):
1989 return 1
Karen Qian40c19422019-03-13 21:28:29 +00001990
tandriid60367b2016-06-22 05:25:12 -07001991 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
Karen Qian40c19422019-03-13 21:28:29 +00001992 if not force and self._IsCqConfigured():
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001993 confirm_or_exit('\nIt seems this repository has a CQ, '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001994 'which can test and land changes for you. '
1995 'Are you sure you wish to bypass it?\n',
1996 action='bypass CQ')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001997 differs = True
tandriic4344b52016-08-29 06:04:54 -07001998 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00001999 # Note: git diff outputs nothing if there is no diff.
2000 if not last_upload or RunGit(['diff', last_upload]).strip():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002001 print('WARNING: Some changes from local branch haven\'t been uploaded.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002002 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002003 if detail['current_revision'] == last_upload:
2004 differs = False
2005 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002006 print('WARNING: Local branch contents differ from latest uploaded '
2007 'patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002008 if differs:
2009 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002010 confirm_or_exit(
2011 'Do you want to submit latest Gerrit patchset and bypass hooks?\n',
2012 action='submit')
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002013 print('WARNING: Bypassing hooks and submitting latest uploaded patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002014 elif not bypass_hooks:
Edward Lemur227d5102020-02-25 23:45:35 +00002015 upstream = self.GetCommonAncestorWithUpstream()
2016 if self.GetIssue():
2017 description = self.FetchDescription()
2018 else:
Gregory Nisbet29d5cf82020-02-27 08:16:58 +00002019 description = self.GetLocalDescription(upstream)
Edward Lemur227d5102020-02-25 23:45:35 +00002020 self.RunHook(
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002021 committing=True,
2022 may_prompt=not force,
2023 verbose=verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00002024 parallel=parallel,
2025 upstream=upstream,
2026 description=description,
2027 all_files=False)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002028
2029 self.SubmitIssue(wait_for_merge=True)
2030 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002031 links = self._GetChangeCommit().get('web_links', [])
2032 for link in links:
Aaron Gable02cdbb42016-12-13 16:24:25 -08002033 if link.get('name') == 'gitiles' and link.get('url'):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002034 print('Landed as: %s' % link.get('url'))
agable32978d92016-11-01 12:55:02 -07002035 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002036 return 0
2037
Edward Lemurf38bc172019-09-03 21:02:13 +00002038 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002039 assert parsed_issue_arg.valid
2040
Edward Lemur125d60a2019-09-13 18:25:41 +00002041 self.issue = parsed_issue_arg.issue
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002042
2043 if parsed_issue_arg.hostname:
2044 self._gerrit_host = parsed_issue_arg.hostname
2045 self._gerrit_server = 'https://%s' % self._gerrit_host
2046
tandriic2405f52016-10-10 08:13:15 -07002047 try:
2048 detail = self._GetChangeDetail(['ALL_REVISIONS'])
Aaron Gablea45ee112016-11-22 15:14:38 -08002049 except GerritChangeNotExists as e:
tandriic2405f52016-10-10 08:13:15 -07002050 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002051
2052 if not parsed_issue_arg.patchset:
2053 # Use current revision by default.
2054 revision_info = detail['revisions'][detail['current_revision']]
2055 patchset = int(revision_info['_number'])
2056 else:
2057 patchset = parsed_issue_arg.patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002058 for revision_info in detail['revisions'].values():
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002059 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2060 break
2061 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002062 DieWithError('Couldn\'t find patchset %i in change %i' %
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002063 (parsed_issue_arg.patchset, self.GetIssue()))
2064
Edward Lemur125d60a2019-09-13 18:25:41 +00002065 remote_url = self.GetRemoteUrl()
Aaron Gable697a91b2018-01-19 15:20:15 -08002066 if remote_url.endswith('.git'):
2067 remote_url = remote_url[:-len('.git')]
erikchen0d14d0d2018-08-28 18:57:09 +00002068 remote_url = remote_url.rstrip('/')
2069
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002070 fetch_info = revision_info['fetch']['http']
erikchen0d14d0d2018-08-28 18:57:09 +00002071 fetch_info['url'] = fetch_info['url'].rstrip('/')
Aaron Gable697a91b2018-01-19 15:20:15 -08002072
2073 if remote_url != fetch_info['url']:
2074 DieWithError('Trying to patch a change from %s but this repo appears '
2075 'to be %s.' % (fetch_info['url'], remote_url))
2076
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002077 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
Aaron Gable9387b4f2017-06-08 10:50:03 -07002078
Aaron Gable62619a32017-06-16 08:22:09 -07002079 if force:
2080 RunGit(['reset', '--hard', 'FETCH_HEAD'])
2081 print('Checked out commit for change %i patchset %i locally' %
2082 (parsed_issue_arg.issue, patchset))
Stefan Zager2d5f0392017-10-10 15:17:53 -07002083 elif nocommit:
2084 RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD'])
2085 print('Patch applied to index.')
Aaron Gable62619a32017-06-16 08:22:09 -07002086 else:
Aaron Gable9387b4f2017-06-08 10:50:03 -07002087 RunGit(['cherry-pick', 'FETCH_HEAD'])
2088 print('Committed patch for change %i patchset %i locally.' %
Aaron Gable62619a32017-06-16 08:22:09 -07002089 (parsed_issue_arg.issue, patchset))
2090 print('Note: this created a local commit which does not have '
2091 'the same hash as the one uploaded for review. This will make '
2092 'uploading changes based on top of this branch difficult.\n'
2093 'If you want to do that, use "git cl patch --force" instead.')
2094
Stefan Zagerd08043c2017-10-12 12:07:02 -07002095 if self.GetBranch():
2096 self.SetIssue(parsed_issue_arg.issue)
2097 self.SetPatchset(patchset)
2098 fetched_hash = RunGit(['rev-parse', 'FETCH_HEAD']).strip()
2099 self._GitSetBranchConfigValue('last-upload-hash', fetched_hash)
2100 self._GitSetBranchConfigValue('gerritsquashhash', fetched_hash)
2101 else:
2102 print('WARNING: You are in detached HEAD state.\n'
2103 'The patch has been applied to your checkout, but you will not be '
2104 'able to upload a new patch set to the gerrit issue.\n'
2105 'Try using the \'-b\' option if you would like to work on a '
2106 'branch and/or upload a new patch set.')
2107
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002108 return 0
2109
tandrii16e0b4e2016-06-07 10:34:28 -07002110 def _GerritCommitMsgHookCheck(self, offer_removal):
2111 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2112 if not os.path.exists(hook):
2113 return
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002114 # Crude attempt to distinguish Gerrit Codereview hook from a potentially
2115 # custom developer-made one.
tandrii16e0b4e2016-06-07 10:34:28 -07002116 data = gclient_utils.FileRead(hook)
2117 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2118 return
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002119 print('WARNING: You have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002120 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002121 'and may interfere with it in subtle ways.\n'
2122 'We recommend you remove the commit-msg hook.')
2123 if offer_removal:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002124 if ask_for_explicit_yes('Do you want to remove it now?'):
tandrii16e0b4e2016-06-07 10:34:28 -07002125 gclient_utils.rm_file_or_tree(hook)
2126 print('Gerrit commit-msg hook removed.')
2127 else:
2128 print('OK, will keep Gerrit commit-msg hook in place.')
2129
Edward Lemur1b52d872019-05-09 21:12:12 +00002130 def _CleanUpOldTraces(self):
2131 """Keep only the last |MAX_TRACES| traces."""
2132 try:
2133 traces = sorted([
2134 os.path.join(TRACES_DIR, f)
2135 for f in os.listdir(TRACES_DIR)
2136 if (os.path.isfile(os.path.join(TRACES_DIR, f))
2137 and not f.startswith('tmp'))
2138 ])
2139 traces_to_delete = traces[:-MAX_TRACES]
2140 for trace in traces_to_delete:
Daniel Chengcf6269b2019-05-18 01:02:12 +00002141 os.remove(trace)
Edward Lemur1b52d872019-05-09 21:12:12 +00002142 except OSError:
2143 print('WARNING: Failed to remove old git traces from\n'
2144 ' %s'
2145 'Consider removing them manually.' % TRACES_DIR)
Edward Lemurdc8e23d2019-05-07 00:45:48 +00002146
Edward Lemur5737f022019-05-17 01:24:00 +00002147 def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002148 """Zip and write the git push traces stored in traces_dir."""
2149 gclient_utils.safe_makedirs(TRACES_DIR)
Edward Lemur1b52d872019-05-09 21:12:12 +00002150 traces_zip = trace_name + '-traces'
2151 traces_readme = trace_name + '-README'
Michael Mosse7f0b4c2019-05-08 04:36:24 +00002152 # Create a temporary dir to store git config and gitcookies in. It will be
2153 # compressed and stored next to the traces.
2154 git_info_dir = tempfile.mkdtemp()
Edward Lemur1b52d872019-05-09 21:12:12 +00002155 git_info_zip = trace_name + '-git-info'
2156
Edward Lemur5737f022019-05-17 01:24:00 +00002157 git_push_metadata['now'] = datetime_now().strftime('%c')
Eric Boren67c48202019-05-30 16:52:51 +00002158 if sys.stdin.encoding and sys.stdin.encoding != 'utf-8':
sangwoo.ko7a614332019-05-22 02:46:19 +00002159 git_push_metadata['now'] = git_push_metadata['now'].decode(
2160 sys.stdin.encoding)
2161
Edward Lemur1b52d872019-05-09 21:12:12 +00002162 git_push_metadata['trace_name'] = trace_name
2163 gclient_utils.FileWrite(
2164 traces_readme, TRACES_README_FORMAT % git_push_metadata)
2165
2166 # Keep only the first 6 characters of the git hashes on the packet
2167 # trace. This greatly decreases size after compression.
2168 packet_traces = os.path.join(traces_dir, 'trace-packet')
2169 if os.path.isfile(packet_traces):
2170 contents = gclient_utils.FileRead(packet_traces)
2171 gclient_utils.FileWrite(
2172 packet_traces, GIT_HASH_RE.sub(r'\1', contents))
2173 shutil.make_archive(traces_zip, 'zip', traces_dir)
2174
2175 # Collect and compress the git config and gitcookies.
2176 git_config = RunGit(['config', '-l'])
2177 gclient_utils.FileWrite(
2178 os.path.join(git_info_dir, 'git-config'),
2179 git_config)
2180
2181 cookie_auth = gerrit_util.Authenticator.get()
2182 if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
2183 gitcookies_path = cookie_auth.get_gitcookies_path()
2184 if os.path.isfile(gitcookies_path):
2185 gitcookies = gclient_utils.FileRead(gitcookies_path)
2186 gclient_utils.FileWrite(
2187 os.path.join(git_info_dir, 'gitcookies'),
2188 GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies))
2189 shutil.make_archive(git_info_zip, 'zip', git_info_dir)
2190
Edward Lemur1b52d872019-05-09 21:12:12 +00002191 gclient_utils.rmtree(git_info_dir)
2192
2193 def _RunGitPushWithTraces(
2194 self, change_desc, refspec, refspec_opts, git_push_metadata):
2195 """Run git push and collect the traces resulting from the execution."""
2196 # Create a temporary directory to store traces in. Traces will be compressed
2197 # and stored in a 'traces' dir inside depot_tools.
2198 traces_dir = tempfile.mkdtemp()
Edward Lemur5737f022019-05-17 01:24:00 +00002199 trace_name = os.path.join(
2200 TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f'))
Edward Lemur0f58ae42019-04-30 17:24:12 +00002201
2202 env = os.environ.copy()
2203 env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy'
2204 env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Jonathan Nieder9779b142019-05-29 23:19:29 +00002205 env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002206 env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl')
2207 env['GIT_TRACE_CURL_NO_DATA'] = '1'
2208 env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet')
2209
2210 try:
2211 push_returncode = 0
Edward Lemur1b52d872019-05-09 21:12:12 +00002212 remote_url = self.GetRemoteUrl()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002213 before_push = time_time()
2214 push_stdout = gclient_utils.CheckCallAndFilter(
Edward Lemur1b52d872019-05-09 21:12:12 +00002215 ['git', 'push', remote_url, refspec],
Edward Lemur0f58ae42019-04-30 17:24:12 +00002216 env=env,
2217 print_stdout=True,
2218 # Flush after every line: useful for seeing progress when running as
2219 # recipe.
2220 filter_fn=lambda _: sys.stdout.flush())
Edward Lemur79d4f992019-11-11 23:49:02 +00002221 push_stdout = push_stdout.decode('utf-8', 'replace')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002222 except subprocess2.CalledProcessError as e:
2223 push_returncode = e.returncode
2224 DieWithError('Failed to create a change. Please examine output above '
2225 'for the reason of the failure.\n'
2226 'Hint: run command below to diagnose common Git/Gerrit '
2227 'credential problems:\n'
Edward Lemur5737f022019-05-17 01:24:00 +00002228 ' git cl creds-check\n'
2229 '\n'
2230 'If git-cl is not working correctly, file a bug under the '
2231 'Infra>SDK component including the files below.\n'
2232 'Review the files before upload, since they might contain '
2233 'sensitive information.\n'
2234 'Set the Restrict-View-Google label so that they are not '
2235 'publicly accessible.\n'
2236 + TRACES_MESSAGE % {'trace_name': trace_name},
Edward Lemur0f58ae42019-04-30 17:24:12 +00002237 change_desc)
2238 finally:
2239 execution_time = time_time() - before_push
2240 metrics.collector.add_repeated('sub_commands', {
2241 'command': 'git push',
2242 'execution_time': execution_time,
2243 'exit_code': push_returncode,
2244 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts),
2245 })
2246
Edward Lemur1b52d872019-05-09 21:12:12 +00002247 git_push_metadata['execution_time'] = execution_time
2248 git_push_metadata['exit_code'] = push_returncode
Edward Lemur5737f022019-05-17 01:24:00 +00002249 self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata)
Edward Lemur0f58ae42019-04-30 17:24:12 +00002250
Edward Lemur1b52d872019-05-09 21:12:12 +00002251 self._CleanUpOldTraces()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002252 gclient_utils.rmtree(traces_dir)
2253
2254 return push_stdout
2255
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002256 def CMDUploadChange(self, options, git_diff_args, custom_cl_base, change):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002257 """Upload the current branch to Gerrit."""
Mike Frysingera989d552019-08-14 20:51:23 +00002258 if options.squash is None:
tandriia60502f2016-06-20 02:01:53 -07002259 # Load default for user, repo, squash=true, in this order.
2260 options.squash = settings.GetSquashGerritUploads()
tandrii26f3e4e2016-06-10 08:37:04 -07002261
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002262 remote, remote_branch = self.GetRemoteBranch()
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01002263 branch = GetTargetRef(remote, remote_branch, options.target_branch)
Aaron Gableb56ad332017-01-06 15:24:31 -08002264 # This may be None; default fallback value is determined in logic below.
2265 title = options.title
2266
Dominic Battre7d1c4842017-10-27 09:17:28 +02002267 # Extract bug number from branch name.
2268 bug = options.bug
Dan Beamd8b04ca2019-10-10 21:23:26 +00002269 fixed = options.fixed
2270 match = re.match(r'(?P<type>bug|fix(?:e[sd])?)[_-]?(?P<bugnum>\d+)',
2271 self.GetBranch())
2272 if not bug and not fixed and match:
2273 if match.group('type') == 'bug':
2274 bug = match.group('bugnum')
2275 else:
2276 fixed = match.group('bugnum')
Dominic Battre7d1c4842017-10-27 09:17:28 +02002277
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002278 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002279 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002280 if self.GetIssue():
2281 # Try to get the message from a previous upload.
Edward Lemur6c6827c2020-02-06 21:15:18 +00002282 message = self.FetchDescription()
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002283 if not message:
2284 DieWithError(
Aaron Gablea45ee112016-11-22 15:14:38 -08002285 'failed to fetch description from current Gerrit change %d\n'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002286 '%s' % (self.GetIssue(), self.GetIssueURL()))
Aaron Gableb56ad332017-01-06 15:24:31 -08002287 if not title:
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002288 if options.message:
Aaron Gable7303dcb2017-06-07 14:17:32 -07002289 # When uploading a subsequent patchset, -m|--message is taken
2290 # as the patchset title if --title was not provided.
2291 title = options.message.strip()
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002292 else:
2293 default_title = RunGit(
2294 ['show', '-s', '--format=%s', 'HEAD']).strip()
Aaron Gable7303dcb2017-06-07 14:17:32 -07002295 if options.force:
2296 title = default_title
2297 else:
2298 title = ask_for_data(
2299 'Title for patchset [%s]: ' % default_title) or default_title
Josipe827b0f2020-01-30 00:07:20 +00002300
2301 # User requested to change description
2302 if options.edit_description:
2303 change_desc = ChangeDescription(message, bug=bug, fixed=fixed)
2304 change_desc.prompt()
2305 message = change_desc.description
2306
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002307 change_id = self._GetChangeDetail()['change_id']
2308 while True:
2309 footer_change_ids = git_footers.get_footer_change_id(message)
2310 if footer_change_ids == [change_id]:
2311 break
2312 if not footer_change_ids:
2313 message = git_footers.add_footer_change_id(message, change_id)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002314 print('WARNING: appended missing Change-Id to change description.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002315 continue
2316 # There is already a valid footer but with different or several ids.
2317 # Doing this automatically is non-trivial as we don't want to lose
2318 # existing other footers, yet we want to append just 1 desired
2319 # Change-Id. Thus, just create a new footer, but let user verify the
2320 # new description.
2321 message = '%s\n\nChange-Id: %s' % (message, change_id)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002322 change_desc = ChangeDescription(message, bug=bug, fixed=fixed)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002323 if not options.force:
Anthony Polito8b955342019-09-24 19:01:36 +00002324 print(
2325 'WARNING: change %s has Change-Id footer(s):\n'
2326 ' %s\n'
2327 'but change has Change-Id %s, according to Gerrit.\n'
2328 'Please, check the proposed correction to the description, '
2329 'and edit it if necessary but keep the "Change-Id: %s" footer\n'
2330 % (self.GetIssue(), '\n '.join(footer_change_ids), change_id,
2331 change_id))
2332 confirm_or_exit(action='edit')
2333 change_desc.prompt()
2334
2335 message = change_desc.description
2336 if not message:
2337 DieWithError("Description is empty. Aborting...")
2338
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002339 # Continue the while loop.
2340 # Sanity check of this code - we should end up with proper message
2341 # footer.
2342 assert [change_id] == git_footers.get_footer_change_id(message)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002343 change_desc = ChangeDescription(message, bug=bug, fixed=fixed)
Aaron Gableb56ad332017-01-06 15:24:31 -08002344 else: # if not self.GetIssue()
2345 if options.message:
2346 message = options.message
2347 else:
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002348 message = _create_description_from_log(git_diff_args)
Aaron Gableb56ad332017-01-06 15:24:31 -08002349 if options.title:
2350 message = options.title + '\n\n' + message
Dan Beamd8b04ca2019-10-10 21:23:26 +00002351 change_desc = ChangeDescription(message, bug=bug, fixed=fixed)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002352 if not options.force:
Anthony Polito8b955342019-09-24 19:01:36 +00002353 change_desc.prompt()
2354
Aaron Gableb56ad332017-01-06 15:24:31 -08002355 # On first upload, patchset title is always this string, while
2356 # --title flag gets converted to first line of message.
2357 title = 'Initial upload'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002358 if not change_desc.description:
2359 DieWithError("Description is empty. Aborting...")
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002360 change_ids = git_footers.get_footer_change_id(change_desc.description)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002361 if len(change_ids) > 1:
2362 DieWithError('too many Change-Id footers, at most 1 allowed.')
2363 if not change_ids:
2364 # Generate the Change-Id automatically.
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002365 change_desc.set_description(git_footers.add_footer_change_id(
2366 change_desc.description,
2367 GenerateGerritChangeId(change_desc.description)))
2368 change_ids = git_footers.get_footer_change_id(change_desc.description)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002369 assert len(change_ids) == 1
2370 change_id = change_ids[0]
2371
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002372 if options.reviewers or options.tbrs or options.add_owners_to:
2373 change_desc.update_reviewers(options.reviewers, options.tbrs,
2374 options.add_owners_to, change)
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())
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002379 parent = self._ComputeParent(remote, upstream_branch, custom_cl_base,
2380 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
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002387 change_desc = ChangeDescription(
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002388 options.message or _create_description_from_log(git_diff_args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002389 if not change_desc.description:
2390 DieWithError("Description is empty. Aborting...")
2391
2392 if not git_footers.get_footer_change_id(change_desc.description):
2393 DownloadGerritHook(False)
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002394 change_desc.set_description(
2395 self._AddChangeIdToCommitMessage(options, git_diff_args))
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002396 if options.reviewers or options.tbrs or options.add_owners_to:
2397 change_desc.update_reviewers(options.reviewers, options.tbrs,
2398 options.add_owners_to, change)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002399 ref_to_push = 'HEAD'
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002400 # For no-squash mode, we assume the remote called "origin" is the one we
2401 # want. It is not worthwhile to support different workflows for
2402 # no-squash mode.
2403 parent = 'origin/%s' % branch
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002404 change_id = git_footers.get_footer_change_id(change_desc.description)[0]
2405
2406 assert change_desc
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +00002407 SaveDescriptionBackup(change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002408 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2409 ref_to_push)]).splitlines()
2410 if len(commits) > 1:
2411 print('WARNING: This will upload %d commits. Run the following command '
2412 'to see which commits will be uploaded: ' % len(commits))
2413 print('git log %s..%s' % (parent, ref_to_push))
2414 print('You can also use `git squash-branch` to squash these into a '
2415 'single commit.')
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002416 confirm_or_exit(action='upload')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002417
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002418 if options.reviewers or options.tbrs or options.add_owners_to:
2419 change_desc.update_reviewers(options.reviewers, options.tbrs,
2420 options.add_owners_to, change)
2421
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002422 reviewers = sorted(change_desc.get_reviewers())
Edward Lemur4508b422019-10-03 21:56:35 +00002423 cc = []
2424 # Add CCs from WATCHLISTS and rietveld.cc git config unless this is
2425 # the initial upload, the CL is private, or auto-CCing has ben disabled.
2426 if not (self.GetIssue() or options.private or options.no_autocc):
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002427 cc = self.GetCCList().split(',')
Edward Lemur4508b422019-10-03 21:56:35 +00002428 # Add cc's from the --cc flag.
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002429 if options.cc:
2430 cc.extend(options.cc)
Edward Lemur79d4f992019-11-11 23:49:02 +00002431 cc = [email.strip() for email in cc if email.strip()]
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002432 if change_desc.get_cced():
2433 cc.extend(change_desc.get_cced())
Andrii Shyshkalov0da5e8f2018-10-30 17:29:18 +00002434 if self._GetGerritHost() == 'chromium-review.googlesource.com':
2435 valid_accounts = set(reviewers + cc)
2436 # TODO(crbug/877717): relax this for all hosts.
2437 else:
2438 valid_accounts = gerrit_util.ValidAccounts(
2439 self._GetGerritHost(), reviewers + cc)
Andrii Shyshkalovf170af42018-10-30 07:00:44 +00002440 logging.info('accounts %s are recognized, %s invalid',
2441 sorted(valid_accounts),
2442 set(reviewers + cc).difference(set(valid_accounts)))
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002443
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002444 # Extra options that can be specified at push time. Doc:
2445 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002446 refspec_opts = []
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002447
Aaron Gable844cf292017-06-28 11:32:59 -07002448 # By default, new changes are started in WIP mode, and subsequent patchsets
2449 # don't send email. At any time, passing --send-mail will mark the change
2450 # ready and send email for that particular patch.
Aaron Gableafd52772017-06-27 16:40:10 -07002451 if options.send_mail:
2452 refspec_opts.append('ready')
Aaron Gable844cf292017-06-28 11:32:59 -07002453 refspec_opts.append('notify=ALL')
Jamie Madill276da0b2018-04-27 14:41:20 -04002454 elif not self.GetIssue() and options.squash:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002455 refspec_opts.append('wip')
Aaron Gableafd52772017-06-27 16:40:10 -07002456 else:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002457 refspec_opts.append('notify=NONE')
Aaron Gable70f4e242017-06-26 10:45:59 -07002458
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002459 # TODO(tandrii): options.message should be posted as a comment
Aaron Gablee5adf612017-07-14 10:43:58 -07002460 # if --send-mail is set on non-initial upload as Rietveld used to do it.
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002461
Aaron Gable9b713dd2016-12-14 16:04:21 -08002462 if title:
Nick Carter8692b182017-11-06 16:30:38 -08002463 # Punctuation and whitespace in |title| must be percent-encoded.
2464 refspec_opts.append('m=' + gerrit_util.PercentEncodeForGitRef(title))
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002465
agablec6787972016-09-09 16:13:34 -07002466 if options.private:
Aaron Gableb02daf02017-05-23 11:53:46 -07002467 refspec_opts.append('private')
agablec6787972016-09-09 16:13:34 -07002468
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002469 for r in sorted(reviewers):
2470 if r in valid_accounts:
2471 refspec_opts.append('r=%s' % r)
2472 reviewers.remove(r)
2473 else:
2474 # TODO(tandrii): this should probably be a hard failure.
2475 print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping'
2476 % r)
2477 for c in sorted(cc):
2478 # refspec option will be rejected if cc doesn't correspond to an
2479 # account, even though REST call to add such arbitrary cc may succeed.
2480 if c in valid_accounts:
2481 refspec_opts.append('cc=%s' % c)
2482 cc.remove(c)
2483
rmistry9eadede2016-09-19 11:22:43 -07002484 if options.topic:
2485 # Documentation on Gerrit topics is here:
2486 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002487 refspec_opts.append('topic=%s' % options.topic)
rmistry9eadede2016-09-19 11:22:43 -07002488
Edward Lemur687ca902018-12-05 02:30:30 +00002489 if options.enable_auto_submit:
2490 refspec_opts.append('l=Auto-Submit+1')
2491 if options.use_commit_queue:
2492 refspec_opts.append('l=Commit-Queue+2')
2493 elif options.cq_dry_run:
2494 refspec_opts.append('l=Commit-Queue+1')
2495
2496 if change_desc.get_reviewers(tbr_only=True):
2497 score = gerrit_util.GetCodeReviewTbrScore(
2498 self._GetGerritHost(),
2499 self._GetGerritProject())
2500 refspec_opts.append('l=Code-Review+%s' % score)
Andrii Shyshkalove7a7fc42018-10-30 17:35:09 +00002501
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002502 # Gerrit sorts hashtags, so order is not important.
Nodir Turakulov23b82142017-11-16 11:04:25 -08002503 hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags}
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002504 if not self.GetIssue():
Nodir Turakulov23b82142017-11-16 11:04:25 -08002505 hashtags.update(change_desc.get_hash_tags())
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002506 refspec_opts += ['hashtag=%s' % t for t in sorted(hashtags)]
2507
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002508 refspec_suffix = ''
2509 if refspec_opts:
2510 refspec_suffix = '%' + ','.join(refspec_opts)
2511 assert ' ' not in refspec_suffix, (
2512 'spaces not allowed in refspec: "%s"' % refspec_suffix)
2513 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
2514
Edward Lemur1b52d872019-05-09 21:12:12 +00002515 git_push_metadata = {
2516 'gerrit_host': self._GetGerritHost(),
2517 'title': title or '<untitled>',
2518 'change_id': change_id,
2519 'description': change_desc.description,
2520 }
2521 push_stdout = self._RunGitPushWithTraces(
2522 change_desc, refspec, refspec_opts, git_push_metadata)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002523
2524 if options.squash:
Aaron Gable289b4312017-09-13 14:06:16 -07002525 regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002526 change_numbers = [m.group(1)
2527 for m in map(regex.match, push_stdout.splitlines())
2528 if m]
2529 if len(change_numbers) != 1:
2530 DieWithError(
2531 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
Christopher Lamf732cd52017-01-24 12:40:11 +11002532 'Change-Id: %s') % (len(change_numbers), change_id), change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002533 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002534 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002535
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002536 if self.GetIssue() and (reviewers or cc):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002537 # GetIssue() is not set in case of non-squash uploads according to tests.
2538 # TODO(agable): non-squash uploads in git cl should be removed.
2539 gerrit_util.AddReviewers(
2540 self._GetGerritHost(),
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00002541 self._GerritChangeIdentifier(),
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002542 reviewers, cc,
2543 notify=bool(options.send_mail))
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002544
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002545 return 0
2546
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002547 def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force,
2548 change_desc):
2549 """Computes parent of the generated commit to be uploaded to Gerrit.
2550
2551 Returns revision or a ref name.
2552 """
2553 if custom_cl_base:
2554 # Try to avoid creating additional unintended CLs when uploading, unless
2555 # user wants to take this risk.
2556 local_ref_of_target_remote = self.GetRemoteBranch()[1]
2557 code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base,
2558 local_ref_of_target_remote])
2559 if code == 1:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002560 print('\nWARNING: Manually specified base of this CL `%s` '
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002561 'doesn\'t seem to belong to target remote branch `%s`.\n\n'
2562 'If you proceed with upload, more than 1 CL may be created by '
2563 'Gerrit as a result, in turn confusing or crashing git cl.\n\n'
2564 'If you are certain that specified base `%s` has already been '
2565 'uploaded to Gerrit as another CL, you may proceed.\n' %
2566 (custom_cl_base, local_ref_of_target_remote, custom_cl_base))
2567 if not force:
2568 confirm_or_exit(
2569 'Do you take responsibility for cleaning up potential mess '
2570 'resulting from proceeding with upload?',
2571 action='upload')
2572 return custom_cl_base
2573
Aaron Gablef97e33d2017-03-30 15:44:27 -07002574 if remote != '.':
2575 return self.GetCommonAncestorWithUpstream()
2576
2577 # If our upstream branch is local, we base our squashed commit on its
2578 # squashed version.
2579 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2580
Aaron Gablef97e33d2017-03-30 15:44:27 -07002581 if upstream_branch_name == 'master':
Aaron Gable0bbd1c22017-05-08 14:37:08 -07002582 return self.GetCommonAncestorWithUpstream()
Aaron Gablef97e33d2017-03-30 15:44:27 -07002583
2584 # Check the squashed hash of the parent.
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002585 # TODO(tandrii): consider checking parent change in Gerrit and using its
2586 # hash if tree hash of latest parent revision (patchset) in Gerrit matches
2587 # the tree hash of the parent branch. The upside is less likely bogus
2588 # requests to reupload parent change just because it's uploadhash is
2589 # missing, yet the downside likely exists, too (albeit unknown to me yet).
Aaron Gablef97e33d2017-03-30 15:44:27 -07002590 parent = RunGit(['config',
2591 'branch.%s.gerritsquashhash' % upstream_branch_name],
2592 error_ok=True).strip()
2593 # Verify that the upstream branch has been uploaded too, otherwise
2594 # Gerrit will create additional CLs when uploading.
2595 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2596 RunGitSilent(['rev-parse', parent + ':'])):
2597 DieWithError(
2598 '\nUpload upstream branch %s first.\n'
2599 'It is likely that this branch has been rebased since its last '
2600 'upload, so you just need to upload it again.\n'
2601 '(If you uploaded it with --no-squash, then branch dependencies '
2602 'are not supported, and you should reupload with --squash.)'
2603 % upstream_branch_name,
2604 change_desc)
2605 return parent
2606
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002607 def _AddChangeIdToCommitMessage(self, options, args):
2608 """Re-commits using the current message, assumes the commit hook is in
2609 place.
2610 """
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002611 log_desc = options.message or _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002612 git_command = ['commit', '--amend', '-m', log_desc]
2613 RunGit(git_command)
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002614 new_log_desc = _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002615 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002616 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002617 return new_log_desc
2618 else:
tandrii@chromium.orgb067ec52016-05-31 15:24:44 +00002619 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002620
tandriie113dfd2016-10-11 10:20:12 -07002621 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002622 try:
2623 data = self._GetChangeDetail()
Aaron Gablea45ee112016-11-22 15:14:38 -08002624 except GerritChangeNotExists:
2625 return 'Gerrit doesn\'t know about your change %s' % self.GetIssue()
tandrii8c5a3532016-11-04 07:52:02 -07002626
2627 if data['status'] in ('ABANDONED', 'MERGED'):
2628 return 'CL %s is closed' % self.GetIssue()
2629
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002630 def GetGerritChange(self, patchset=None):
2631 """Returns a buildbucket.v2.GerritChange message for the current issue."""
Edward Lemur79d4f992019-11-11 23:49:02 +00002632 host = urllib.parse.urlparse(self.GetCodereviewServer()).hostname
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002633 issue = self.GetIssue()
Edward Lemur2c210a42019-09-16 23:58:35 +00002634 patchset = int(patchset or self.GetPatchset())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002635 data = self._GetChangeDetail(['ALL_REVISIONS'])
2636
2637 assert host and issue and patchset, 'CL must be uploaded first'
2638
2639 has_patchset = any(
2640 int(revision_data['_number']) == patchset
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00002641 for revision_data in data['revisions'].values())
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002642 if not has_patchset:
Aaron Gablea45ee112016-11-22 15:14:38 -08002643 raise Exception('Patchset %d is not known in Gerrit change %d' %
tandrii8c5a3532016-11-04 07:52:02 -07002644 (patchset, self.GetIssue()))
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002645
tandrii8c5a3532016-11-04 07:52:02 -07002646 return {
Edward Lemurd4d1ba42019-09-20 21:46:37 +00002647 'host': host,
2648 'change': issue,
2649 'project': data['project'],
2650 'patchset': patchset,
tandrii8c5a3532016-11-04 07:52:02 -07002651 }
tandriie113dfd2016-10-11 10:20:12 -07002652
tandriide281ae2016-10-12 06:02:30 -07002653 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002654 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002655
Edward Lemur707d70b2018-02-07 00:50:14 +01002656 def GetReviewers(self):
2657 details = self._GetChangeDetail(['DETAILED_ACCOUNTS'])
Mohamed Heikal171c0742018-11-09 20:38:51 +00002658 return [r['email'] for r in details['reviewers'].get('REVIEWER', [])]
Edward Lemur707d70b2018-02-07 00:50:14 +01002659
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002660
tandriif9aefb72016-07-01 09:06:51 -07002661def _get_bug_line_values(default_project, bugs):
2662 """Given default_project and comma separated list of bugs, yields bug line
2663 values.
2664
2665 Each bug can be either:
2666 * a number, which is combined with default_project
2667 * string, which is left as is.
2668
2669 This function may produce more than one line, because bugdroid expects one
2670 project per line.
2671
2672 >>> list(_get_bug_line_values('v8', '123,chromium:789'))
2673 ['v8:123', 'chromium:789']
2674 """
2675 default_bugs = []
2676 others = []
2677 for bug in bugs.split(','):
2678 bug = bug.strip()
2679 if bug:
2680 try:
2681 default_bugs.append(int(bug))
2682 except ValueError:
2683 others.append(bug)
2684
2685 if default_bugs:
2686 default_bugs = ','.join(map(str, default_bugs))
2687 if default_project:
2688 yield '%s:%s' % (default_project, default_bugs)
2689 else:
2690 yield default_bugs
2691 for other in sorted(others):
2692 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2693 yield other
2694
2695
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002696class ChangeDescription(object):
2697 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002698 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002699 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
Aaron Gable3a16ed12017-03-23 10:51:55 -07002700 BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$'
Dan Beamd8b04ca2019-10-10 21:23:26 +00002701 FIXED_LINE = r'^[ \t]*Fixed[ \t]*:[ \t]*(.*?)[ \t]*$'
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002702 CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002703 STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*'
2704 BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]'
Anthony Polito02b5af32019-12-02 19:49:47 +00002705 COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):($|[^:])'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002706 BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002707
Dan Beamd8b04ca2019-10-10 21:23:26 +00002708 def __init__(self, description, bug=None, fixed=None):
agable@chromium.org42c20792013-09-12 17:34:49 +00002709 self._description_lines = (description or '').strip().splitlines()
Anthony Polito8b955342019-09-24 19:01:36 +00002710 if bug:
2711 regexp = re.compile(self.BUG_LINE)
2712 prefix = settings.GetBugPrefix()
2713 if not any((regexp.match(line) for line in self._description_lines)):
2714 values = list(_get_bug_line_values(prefix, bug))
2715 self.append_footer('Bug: %s' % ', '.join(values))
Dan Beamd8b04ca2019-10-10 21:23:26 +00002716 if fixed:
2717 regexp = re.compile(self.FIXED_LINE)
2718 prefix = settings.GetBugPrefix()
2719 if not any((regexp.match(line) for line in self._description_lines)):
2720 values = list(_get_bug_line_values(prefix, fixed))
2721 self.append_footer('Fixed: %s' % ', '.join(values))
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002722
agable@chromium.org42c20792013-09-12 17:34:49 +00002723 @property # www.logilab.org/ticket/89786
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08002724 def description(self): # pylint: disable=method-hidden
agable@chromium.org42c20792013-09-12 17:34:49 +00002725 return '\n'.join(self._description_lines)
2726
2727 def set_description(self, desc):
2728 if isinstance(desc, basestring):
2729 lines = desc.splitlines()
2730 else:
2731 lines = [line.rstrip() for line in desc]
2732 while lines and not lines[0]:
2733 lines.pop(0)
2734 while lines and not lines[-1]:
2735 lines.pop(-1)
2736 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002737
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002738 def update_reviewers(self, reviewers, tbrs, add_owners_to=None, change=None):
2739 """Rewrites the R=/TBR= line(s) as a single line each.
2740
2741 Args:
2742 reviewers (list(str)) - list of additional emails to use for reviewers.
2743 tbrs (list(str)) - list of additional emails to use for TBRs.
2744 add_owners_to (None|'R'|'TBR') - Pass to do an OWNERS lookup for files in
2745 the change that are missing OWNER coverage. If this is not None, you
2746 must also pass a value for `change`.
2747 change (Change) - The Change that should be used for OWNERS lookups.
2748 """
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002749 assert isinstance(reviewers, list), reviewers
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002750 assert isinstance(tbrs, list), tbrs
2751
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002752 assert add_owners_to in (None, 'TBR', 'R'), add_owners_to
Robert Iannuccia28592e2017-04-18 13:14:49 -07002753 assert not add_owners_to or change, add_owners_to
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002754
2755 if not reviewers and not tbrs and not add_owners_to:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002756 return
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002757
2758 reviewers = set(reviewers)
2759 tbrs = set(tbrs)
2760 LOOKUP = {
2761 'TBR': tbrs,
2762 'R': reviewers,
2763 }
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002764
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002765 # Get the set of R= and TBR= lines and remove them from the description.
agable@chromium.org42c20792013-09-12 17:34:49 +00002766 regexp = re.compile(self.R_LINE)
2767 matches = [regexp.match(line) for line in self._description_lines]
2768 new_desc = [l for i, l in enumerate(self._description_lines)
2769 if not matches[i]]
2770 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002771
agable@chromium.org42c20792013-09-12 17:34:49 +00002772 # Construct new unified R= and TBR= lines.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002773
2774 # First, update tbrs/reviewers with names from the R=/TBR= lines (if any).
agable@chromium.org42c20792013-09-12 17:34:49 +00002775 for match in matches:
2776 if not match:
2777 continue
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002778 LOOKUP[match.group(1)].update(cleanup_list([match.group(2).strip()]))
2779
2780 # Next, maybe fill in OWNERS coverage gaps to either tbrs/reviewers.
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002781 if add_owners_to:
piman@chromium.org336f9122014-09-04 02:16:55 +00002782 owners_db = owners.Database(change.RepositoryRoot(),
Edward Lemurb7f759f2020-03-04 21:20:56 +00002783 fopen=open, os_path=os.path)
piman@chromium.org336f9122014-09-04 02:16:55 +00002784 missing_files = owners_db.files_not_covered_by(change.LocalPaths(),
Robert Iannucci100aa212017-04-18 17:28:26 -07002785 (tbrs | reviewers))
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002786 LOOKUP[add_owners_to].update(
2787 owners_db.reviewers_for(missing_files, change.author_email))
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002788
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002789 # If any folks ended up in both groups, remove them from tbrs.
2790 tbrs -= reviewers
Robert Iannuccif2708bd2017-04-17 15:49:02 -07002791
Robert Iannucci6c98dc62017-04-18 11:38:00 -07002792 new_r_line = 'R=' + ', '.join(sorted(reviewers)) if reviewers else None
2793 new_tbr_line = 'TBR=' + ', '.join(sorted(tbrs)) if tbrs else None
agable@chromium.org42c20792013-09-12 17:34:49 +00002794
2795 # Put the new lines in the description where the old first R= line was.
2796 line_loc = next((i for i, match in enumerate(matches) if match), -1)
2797 if 0 <= line_loc < len(self._description_lines):
2798 if new_tbr_line:
2799 self._description_lines.insert(line_loc, new_tbr_line)
2800 if new_r_line:
2801 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002802 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00002803 if new_r_line:
2804 self.append_footer(new_r_line)
2805 if new_tbr_line:
2806 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002807
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002808 def set_preserve_tryjobs(self):
2809 """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'."""
2810 footers = git_footers.parse_footers(self.description)
2811 for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []):
2812 if v.lower() == 'true':
2813 return
2814 self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true')
2815
Anthony Polito8b955342019-09-24 19:01:36 +00002816 def prompt(self):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002817 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002818 self.set_description([
2819 '# Enter a description of the change.',
2820 '# This will be displayed on the codereview site.',
2821 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00002822 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00002823 '--------------------',
2824 ] + self._description_lines)
Dan Beamd8b04ca2019-10-10 21:23:26 +00002825 bug_regexp = re.compile(self.BUG_LINE)
2826 fixed_regexp = re.compile(self.FIXED_LINE)
Jonas Termansend0f79112019-03-22 15:28:26 +00002827 prefix = settings.GetBugPrefix()
Dan Beamd8b04ca2019-10-10 21:23:26 +00002828 has_issue = lambda l: bug_regexp.match(l) or fixed_regexp.match(l)
2829 if not any((has_issue(line) for line in self._description_lines)):
Anthony Polito8b955342019-09-24 19:01:36 +00002830 self.append_footer('Bug: %s' % prefix)
tandriif9aefb72016-07-01 09:06:51 -07002831
agable@chromium.org42c20792013-09-12 17:34:49 +00002832 content = gclient_utils.RunEditor(self.description, True,
Edward Lemur79d4f992019-11-11 23:49:02 +00002833 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002834 if not content:
2835 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00002836 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002837
Bruce Dawson2377b012018-01-11 16:46:49 -08002838 # Strip off comments and default inserted "Bug:" line.
2839 clean_lines = [line.rstrip() for line in lines if not
Jonas Termansend0f79112019-03-22 15:28:26 +00002840 (line.startswith('#') or
2841 line.rstrip() == "Bug:" or
2842 line.rstrip() == "Bug: " + prefix)]
agable@chromium.org42c20792013-09-12 17:34:49 +00002843 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00002844 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00002845 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002846
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002847 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00002848 """Adds a footer line to the description.
2849
2850 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
2851 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
2852 that Gerrit footers are always at the end.
2853 """
2854 parsed_footer_line = git_footers.parse_footer(line)
2855 if parsed_footer_line:
2856 # Line is a gerrit footer in the form: Footer-Key: any value.
2857 # Thus, must be appended observing Gerrit footer rules.
2858 self.set_description(
2859 git_footers.add_footer(self.description,
2860 key=parsed_footer_line[0],
2861 value=parsed_footer_line[1]))
2862 return
2863
2864 if not self._description_lines:
2865 self._description_lines.append(line)
2866 return
2867
2868 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
2869 if gerrit_footers:
2870 # git_footers.split_footers ensures that there is an empty line before
2871 # actual (gerrit) footers, if any. We have to keep it that way.
2872 assert top_lines and top_lines[-1] == ''
2873 top_lines, separator = top_lines[:-1], top_lines[-1:]
2874 else:
2875 separator = [] # No need for separator if there are no gerrit_footers.
2876
2877 prev_line = top_lines[-1] if top_lines else ''
2878 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
2879 not presubmit_support.Change.TAG_LINE_RE.match(line)):
2880 top_lines.append('')
2881 top_lines.append(line)
2882 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002883
tandrii99a72f22016-08-17 14:33:24 -07002884 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002885 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00002886 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07002887 reviewers = [match.group(2).strip()
2888 for match in matches
2889 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002890 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002891
bradnelsond975b302016-10-23 12:20:23 -07002892 def get_cced(self):
2893 """Retrieves the list of reviewers."""
2894 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
2895 cced = [match.group(2).strip() for match in matches if match]
2896 return cleanup_list(cced)
2897
Nodir Turakulov23b82142017-11-16 11:04:25 -08002898 def get_hash_tags(self):
2899 """Extracts and sanitizes a list of Gerrit hashtags."""
2900 subject = (self._description_lines or ('',))[0]
2901 subject = re.sub(
2902 self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE)
2903
2904 tags = []
2905 start = 0
2906 bracket_exp = re.compile(self.BRACKET_HASH_TAG)
2907 while True:
2908 m = bracket_exp.match(subject, start)
2909 if not m:
2910 break
2911 tags.append(self.sanitize_hash_tag(m.group(1)))
2912 start = m.end()
2913
2914 if not tags:
2915 # Try "Tag: " prefix.
2916 m = re.match(self.COLON_SEPARATED_HASH_TAG, subject)
2917 if m:
2918 tags.append(self.sanitize_hash_tag(m.group(1)))
2919 return tags
2920
2921 @classmethod
2922 def sanitize_hash_tag(cls, tag):
2923 """Returns a sanitized Gerrit hash tag.
2924
2925 A sanitized hashtag can be used as a git push refspec parameter value.
2926 """
2927 return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower()
2928
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002929 def update_with_git_number_footers(self, parent_hash, parent_msg, dest_ref):
2930 """Updates this commit description given the parent.
2931
2932 This is essentially what Gnumbd used to do.
2933 Consult https://goo.gl/WMmpDe for more details.
2934 """
2935 assert parent_msg # No, orphan branch creation isn't supported.
2936 assert parent_hash
2937 assert dest_ref
2938 parent_footer_map = git_footers.parse_footers(parent_msg)
2939 # This will also happily parse svn-position, which GnumbD is no longer
2940 # supporting. While we'd generate correct footers, the verifier plugin
2941 # installed in Gerrit will block such commit (ie git push below will fail).
2942 parent_position = git_footers.get_position(parent_footer_map)
2943
2944 # Cherry-picks may have last line obscuring their prior footers,
2945 # from git_footers perspective. This is also what Gnumbd did.
2946 cp_line = None
2947 if (self._description_lines and
2948 re.match(self.CHERRY_PICK_LINE, self._description_lines[-1])):
2949 cp_line = self._description_lines.pop()
2950
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02002951 top_lines, footer_lines, _ = git_footers.split_footers(self.description)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002952
2953 # Original-ify all Cr- footers, to avoid re-lands, cherry-picks, or just
2954 # user interference with actual footers we'd insert below.
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02002955 for i, line in enumerate(footer_lines):
2956 k, v = git_footers.parse_footer(line) or (None, None)
2957 if k and k.startswith('Cr-'):
2958 footer_lines[i] = '%s: %s' % ('Cr-Original-' + k[len('Cr-'):], v)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002959
2960 # Add Position and Lineage footers based on the parent.
Andrii Shyshkalovb5effa12016-12-14 19:35:12 +01002961 lineage = list(reversed(parent_footer_map.get('Cr-Branched-From', [])))
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002962 if parent_position[0] == dest_ref:
2963 # Same branch as parent.
2964 number = int(parent_position[1]) + 1
2965 else:
2966 number = 1 # New branch, and extra lineage.
2967 lineage.insert(0, '%s-%s@{#%d}' % (parent_hash, parent_position[0],
2968 int(parent_position[1])))
2969
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02002970 footer_lines.append('Cr-Commit-Position: %s@{#%d}' % (dest_ref, number))
2971 footer_lines.extend('Cr-Branched-From: %s' % v for v in lineage)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002972
2973 self._description_lines = top_lines
2974 if cp_line:
2975 self._description_lines.append(cp_line)
2976 if self._description_lines[-1] != '':
2977 self._description_lines.append('') # Ensure footer separator.
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02002978 self._description_lines.extend(footer_lines)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002979
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002980
Aaron Gablea1bab272017-04-11 16:38:18 -07002981def get_approving_reviewers(props, disapproval=False):
maruel@chromium.orge52678e2013-04-26 18:34:44 +00002982 """Retrieves the reviewers that approved a CL from the issue properties with
2983 messages.
2984
2985 Note that the list may contain reviewers that are not committer, thus are not
2986 considered by the CQ.
Aaron Gablea1bab272017-04-11 16:38:18 -07002987
2988 If disapproval is True, instead returns reviewers who 'not lgtm'd the CL.
maruel@chromium.orge52678e2013-04-26 18:34:44 +00002989 """
Aaron Gablea1bab272017-04-11 16:38:18 -07002990 approval_type = 'disapproval' if disapproval else 'approval'
maruel@chromium.orge52678e2013-04-26 18:34:44 +00002991 return sorted(
2992 set(
2993 message['sender']
2994 for message in props['messages']
Aaron Gablea1bab272017-04-11 16:38:18 -07002995 if message[approval_type] and message['sender'] in props['reviewers']
maruel@chromium.orge52678e2013-04-26 18:34:44 +00002996 )
2997 )
2998
2999
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003000def FindCodereviewSettingsFile(filename='codereview.settings'):
3001 """Finds the given file starting in the cwd and going up.
3002
3003 Only looks up to the top of the repository unless an
3004 'inherit-review-settings-ok' file exists in the root of the repository.
3005 """
3006 inherit_ok_file = 'inherit-review-settings-ok'
3007 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00003008 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003009 if os.path.isfile(os.path.join(root, inherit_ok_file)):
3010 root = '/'
3011 while True:
3012 if filename in os.listdir(cwd):
3013 if os.path.isfile(os.path.join(cwd, filename)):
3014 return open(os.path.join(cwd, filename))
3015 if cwd == root:
3016 break
3017 cwd = os.path.dirname(cwd)
3018
3019
3020def LoadCodereviewSettingsFromFile(fileobj):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003021 """Parses a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00003022 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003023
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003024 def SetProperty(name, setting, unset_error_ok=False):
3025 fullname = 'rietveld.' + name
3026 if setting in keyvals:
3027 RunGit(['config', fullname, keyvals[setting]])
3028 else:
3029 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
3030
tandrii48df5812016-10-17 03:55:37 -07003031 if not keyvals.get('GERRIT_HOST', False):
3032 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003033 # Only server setting is required. Other settings can be absent.
3034 # In that case, we ignore errors raised during option deletion attempt.
3035 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
3036 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
3037 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00003038 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003039 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
3040 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00003041 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
3042 unset_error_ok=True)
Jamie Madilldc4d19e2019-10-24 21:50:02 +00003043 SetProperty(
3044 'format-full-by-default', 'FORMAT_FULL_BY_DEFAULT', unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003045
ukai@chromium.org7044efc2013-11-28 01:51:21 +00003046 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00003047 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00003048
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003049 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
tandrii8dd81ea2016-06-16 13:24:23 -07003050 RunGit(['config', 'gerrit.squash-uploads',
3051 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003052
tandrii@chromium.org28253532016-04-14 13:46:56 +00003053 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00003054 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00003055 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
3056
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003057 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01003058 # should be of the form
3059 # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
3060 # ORIGIN_URL_CONFIG: http://src.chromium.org/git
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003061 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
3062 keyvals['ORIGIN_URL_CONFIG']])
3063
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003064
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003065def urlretrieve(source, destination):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003066 """Downloads a network object to a local file, like urllib.urlretrieve.
3067
3068 This is necessary because urllib is broken for SSL connections via a proxy.
3069 """
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003070 with open(destination, 'w') as f:
Edward Lemur79d4f992019-11-11 23:49:02 +00003071 f.write(urllib.request.urlopen(source).read())
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003072
3073
ukai@chromium.org712d6102013-11-27 00:52:58 +00003074def hasSheBang(fname):
3075 """Checks fname is a #! script."""
3076 with open(fname) as f:
3077 return f.read(2).startswith('#!')
3078
3079
bpastene@chromium.org917f0ff2016-04-05 00:45:30 +00003080# TODO(bpastene) Remove once a cleaner fix to crbug.com/600473 presents itself.
3081def DownloadHooks(*args, **kwargs):
3082 pass
3083
3084
tandrii@chromium.org18630d62016-03-04 12:06:02 +00003085def DownloadGerritHook(force):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003086 """Downloads and installs a Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003087
3088 Args:
3089 force: True to update hooks. False to install hooks if not present.
3090 """
3091 if not settings.GetIsGerrit():
3092 return
ukai@chromium.org712d6102013-11-27 00:52:58 +00003093 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003094 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
3095 if not os.access(dst, os.X_OK):
3096 if os.path.exists(dst):
3097 if not force:
3098 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003099 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003100 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003101 if not hasSheBang(dst):
3102 DieWithError('Not a script: %s\n'
3103 'You need to download from\n%s\n'
3104 'into .git/hooks/commit-msg and '
3105 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003106 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
3107 except Exception:
3108 if os.path.exists(dst):
3109 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003110 DieWithError('\nFailed to download hooks.\n'
3111 'You need to download from\n%s\n'
3112 'into .git/hooks/commit-msg and '
3113 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003114
3115
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003116class _GitCookiesChecker(object):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003117 """Provides facilities for validating and suggesting fixes to .gitcookies."""
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003118
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003119 _GOOGLESOURCE = 'googlesource.com'
3120
3121 def __init__(self):
3122 # Cached list of [host, identity, source], where source is either
3123 # .gitcookies or .netrc.
3124 self._all_hosts = None
3125
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003126 def ensure_configured_gitcookies(self):
3127 """Runs checks and suggests fixes to make git use .gitcookies from default
3128 path."""
3129 default = gerrit_util.CookiesAuthenticator.get_gitcookies_path()
3130 configured_path = RunGitSilent(
3131 ['config', '--global', 'http.cookiefile']).strip()
Andrii Shyshkalov1e250cd2017-05-10 15:39:31 +02003132 configured_path = os.path.expanduser(configured_path)
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003133 if configured_path:
3134 self._ensure_default_gitcookies_path(configured_path, default)
3135 else:
3136 self._configure_gitcookies_path(default)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003137
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003138 @staticmethod
3139 def _ensure_default_gitcookies_path(configured_path, default_path):
3140 assert configured_path
3141 if configured_path == default_path:
3142 print('git is already configured to use your .gitcookies from %s' %
3143 configured_path)
3144 return
3145
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003146 print('WARNING: You have configured custom path to .gitcookies: %s\n'
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003147 'Gerrit and other depot_tools expect .gitcookies at %s\n' %
3148 (configured_path, default_path))
3149
3150 if not os.path.exists(configured_path):
3151 print('However, your configured .gitcookies file is missing.')
3152 confirm_or_exit('Reconfigure git to use default .gitcookies?',
3153 action='reconfigure')
3154 RunGit(['config', '--global', 'http.cookiefile', default_path])
3155 return
3156
3157 if os.path.exists(default_path):
3158 print('WARNING: default .gitcookies file already exists %s' %
3159 default_path)
3160 DieWithError('Please delete %s manually and re-run git cl creds-check' %
3161 default_path)
3162
3163 confirm_or_exit('Move existing .gitcookies to default location?',
3164 action='move')
3165 shutil.move(configured_path, default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003166 RunGit(['config', '--global', 'http.cookiefile', default_path])
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003167 print('Moved and reconfigured git to use .gitcookies from %s' %
3168 default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003169
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003170 @staticmethod
3171 def _configure_gitcookies_path(default_path):
3172 netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path()
3173 if os.path.exists(netrc_path):
3174 print('You seem to be using outdated .netrc for git credentials: %s' %
3175 netrc_path)
3176 print('This tool will guide you through setting up recommended '
3177 '.gitcookies store for git credentials.\n'
3178 '\n'
3179 'IMPORTANT: If something goes wrong and you decide to go back, do:\n'
3180 ' git config --global --unset http.cookiefile\n'
3181 ' mv %s %s.backup\n\n' % (default_path, default_path))
3182 confirm_or_exit(action='setup .gitcookies')
3183 RunGit(['config', '--global', 'http.cookiefile', default_path])
3184 print('Configured git to use .gitcookies from %s' % default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003185
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003186 def get_hosts_with_creds(self, include_netrc=False):
3187 if self._all_hosts is None:
3188 a = gerrit_util.CookiesAuthenticator()
3189 self._all_hosts = [
3190 (h, u, s)
3191 for h, u, s in itertools.chain(
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003192 ((h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.items()),
3193 ((h, u, '.gitcookies') for h, (u, _) in a.gitcookies.items())
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003194 )
3195 if h.endswith(self._GOOGLESOURCE)
3196 ]
3197
3198 if include_netrc:
3199 return self._all_hosts
3200 return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc']
3201
3202 def print_current_creds(self, include_netrc=False):
3203 hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc))
3204 if not hosts:
3205 print('No Git/Gerrit credentials found')
3206 return
Edward Lemur79d4f992019-11-11 23:49:02 +00003207 lengths = [max(map(len, (row[i] for row in hosts))) for i in range(3)]
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003208 header = [('Host', 'User', 'Which file'),
3209 ['=' * l for l in lengths]]
3210 for row in (header + hosts):
3211 print('\t'.join((('%%+%ds' % l) % s)
3212 for l, s in zip(lengths, row)))
3213
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003214 @staticmethod
3215 def _parse_identity(identity):
Lei Zhangd3f769a2017-12-15 15:16:14 -08003216 """Parses identity "git-<username>.domain" into <username> and domain."""
3217 # Special case: usernames that contain ".", which are generally not
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02003218 # distinguishable from sub-domains. But we do know typical domains:
3219 if identity.endswith('.chromium.org'):
3220 domain = 'chromium.org'
3221 username = identity[:-len('.chromium.org')]
3222 else:
3223 username, domain = identity.split('.', 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003224 if username.startswith('git-'):
3225 username = username[len('git-'):]
3226 return username, domain
3227
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003228 def _canonical_git_googlesource_host(self, host):
3229 """Normalizes Gerrit hosts (with '-review') to Git host."""
3230 assert host.endswith(self._GOOGLESOURCE)
3231 # Prefix doesn't include '.' at the end.
3232 prefix = host[:-(1 + len(self._GOOGLESOURCE))]
3233 if prefix.endswith('-review'):
3234 prefix = prefix[:-len('-review')]
3235 return prefix + '.' + self._GOOGLESOURCE
3236
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003237 def _canonical_gerrit_googlesource_host(self, host):
3238 git_host = self._canonical_git_googlesource_host(host)
3239 prefix = git_host.split('.', 1)[0]
3240 return prefix + '-review.' + self._GOOGLESOURCE
3241
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003242 def _get_counterpart_host(self, host):
3243 assert host.endswith(self._GOOGLESOURCE)
3244 git = self._canonical_git_googlesource_host(host)
3245 gerrit = self._canonical_gerrit_googlesource_host(git)
3246 return git if gerrit == host else gerrit
3247
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003248 def has_generic_host(self):
3249 """Returns whether generic .googlesource.com has been configured.
3250
3251 Chrome Infra recommends to use explicit ${host}.googlesource.com instead.
3252 """
3253 for host, _, _ in self.get_hosts_with_creds(include_netrc=False):
3254 if host == '.' + self._GOOGLESOURCE:
3255 return True
3256 return False
3257
3258 def _get_git_gerrit_identity_pairs(self):
3259 """Returns map from canonic host to pair of identities (Git, Gerrit).
3260
3261 One of identities might be None, meaning not configured.
3262 """
3263 host_to_identity_pairs = {}
3264 for host, identity, _ in self.get_hosts_with_creds():
3265 canonical = self._canonical_git_googlesource_host(host)
3266 pair = host_to_identity_pairs.setdefault(canonical, [None, None])
3267 idx = 0 if canonical == host else 1
3268 pair[idx] = identity
3269 return host_to_identity_pairs
3270
3271 def get_partially_configured_hosts(self):
3272 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003273 (host if i1 else self._canonical_gerrit_googlesource_host(host))
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003274 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003275 if None in (i1, i2) and host != '.' + self._GOOGLESOURCE)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003276
3277 def get_conflicting_hosts(self):
3278 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003279 host
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003280 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items()
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003281 if None not in (i1, i2) and i1 != i2)
3282
3283 def get_duplicated_hosts(self):
3284 counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds())
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003285 return set(host for host, count in counters.items() if count > 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003286
3287 _EXPECTED_HOST_IDENTITY_DOMAINS = {
3288 'chromium.googlesource.com': 'chromium.org',
3289 'chrome-internal.googlesource.com': 'google.com',
3290 }
3291
3292 def get_hosts_with_wrong_identities(self):
3293 """Finds hosts which **likely** reference wrong identities.
3294
3295 Note: skips hosts which have conflicting identities for Git and Gerrit.
3296 """
3297 hosts = set()
Marc-Antoine Ruel8e57b4b2019-10-11 01:01:36 +00003298 for host, expected in self._EXPECTED_HOST_IDENTITY_DOMAINS.items():
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003299 pair = self._get_git_gerrit_identity_pairs().get(host)
3300 if pair and pair[0] == pair[1]:
3301 _, domain = self._parse_identity(pair[0])
3302 if domain != expected:
3303 hosts.add(host)
3304 return hosts
3305
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003306 @staticmethod
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003307 def _format_hosts(hosts, extra_column_func=None):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003308 hosts = sorted(hosts)
3309 assert hosts
3310 if extra_column_func is None:
3311 extras = [''] * len(hosts)
3312 else:
3313 extras = [extra_column_func(host) for host in hosts]
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003314 tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras)))
3315 lines = []
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003316 for he in zip(hosts, extras):
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003317 lines.append(tmpl % he)
3318 return lines
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003319
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003320 def _find_problems(self):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003321 if self.has_generic_host():
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003322 yield ('.googlesource.com wildcard record detected',
3323 ['Chrome Infrastructure team recommends to list full host names '
3324 'explicitly.'],
3325 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003326
3327 dups = self.get_duplicated_hosts()
3328 if dups:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003329 yield ('The following hosts were defined twice',
3330 self._format_hosts(dups),
3331 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003332
3333 partial = self.get_partially_configured_hosts()
3334 if partial:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003335 yield ('Credentials should come in pairs for Git and Gerrit hosts. '
3336 'These hosts are missing',
3337 self._format_hosts(partial, lambda host: 'but %s defined' %
3338 self._get_counterpart_host(host)),
3339 partial)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003340
3341 conflicting = self.get_conflicting_hosts()
3342 if conflicting:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003343 yield ('The following Git hosts have differing credentials from their '
3344 'Gerrit counterparts',
3345 self._format_hosts(conflicting, lambda host: '%s vs %s' %
3346 tuple(self._get_git_gerrit_identity_pairs()[host])),
3347 conflicting)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003348
3349 wrong = self.get_hosts_with_wrong_identities()
3350 if wrong:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003351 yield ('These hosts likely use wrong identity',
3352 self._format_hosts(wrong, lambda host: '%s but %s recommended' %
3353 (self._get_git_gerrit_identity_pairs()[host][0],
3354 self._EXPECTED_HOST_IDENTITY_DOMAINS[host])),
3355 wrong)
3356
3357 def find_and_report_problems(self):
3358 """Returns True if there was at least one problem, else False."""
3359 found = False
3360 bad_hosts = set()
3361 for title, sublines, hosts in self._find_problems():
3362 if not found:
3363 found = True
3364 print('\n\n.gitcookies problem report:\n')
3365 bad_hosts.update(hosts or [])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003366 print(' %s%s' % (title, (':' if sublines else '')))
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003367 if sublines:
3368 print()
3369 print(' %s' % '\n '.join(sublines))
3370 print()
3371
3372 if bad_hosts:
3373 assert found
3374 print(' You can manually remove corresponding lines in your %s file and '
3375 'visit the following URLs with correct account to generate '
3376 'correct credential lines:\n' %
3377 gerrit_util.CookiesAuthenticator.get_gitcookies_path())
3378 print(' %s' % '\n '.join(sorted(set(
3379 gerrit_util.CookiesAuthenticator().get_new_password_url(
3380 self._canonical_git_googlesource_host(host))
3381 for host in bad_hosts
3382 ))))
3383 return found
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003384
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003385
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003386@metrics.collector.collect_metrics('git cl creds-check')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003387def CMDcreds_check(parser, args):
3388 """Checks credentials and suggests changes."""
3389 _, _ = parser.parse_args(args)
3390
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003391 # Code below checks .gitcookies. Abort if using something else.
3392 authn = gerrit_util.Authenticator.get()
3393 if not isinstance(authn, gerrit_util.CookiesAuthenticator):
3394 if isinstance(authn, gerrit_util.GceAuthenticator):
3395 DieWithError(
3396 'This command is not designed for GCE, are you on a bot?\n'
3397 'If you need to run this on GCE, export SKIP_GCE_AUTH_FOR_GIT=1 '
3398 'in your env.')
Aaron Gabled10ca0e2017-09-11 11:24:10 -07003399 DieWithError(
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003400 'This command is not designed for bot environment. It checks '
3401 '~/.gitcookies file not generally used on bots.')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003402
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003403 checker = _GitCookiesChecker()
3404 checker.ensure_configured_gitcookies()
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003405
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003406 print('Your .netrc and .gitcookies have credentials for these hosts:')
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003407 checker.print_current_creds(include_netrc=True)
3408
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003409 if not checker.find_and_report_problems():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003410 print('\nNo problems detected in your .gitcookies file.')
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003411 return 0
3412 return 1
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003413
3414
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003415@metrics.collector.collect_metrics('git cl baseurl')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003416def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003417 """Gets or sets base-url for this branch."""
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003418 branchref = RunGit(['symbolic-ref', 'HEAD']).strip()
Edward Lemur85153282020-02-14 22:06:29 +00003419 branch = scm.GIT.ShortBranchName(branchref)
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003420 _, args = parser.parse_args(args)
3421 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003422 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003423 return RunGit(['config', 'branch.%s.base-url' % branch],
3424 error_ok=False).strip()
3425 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003426 print('Setting base-url to %s' % args[0])
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003427 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3428 error_ok=False).strip()
3429
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003430
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003431def color_for_status(status):
3432 """Maps a Changelist status to color, for CMDstatus and other tools."""
3433 return {
Aaron Gable9ab38c62017-04-06 14:36:33 -07003434 'unsent': Fore.YELLOW,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003435 'waiting': Fore.BLUE,
3436 'reply': Fore.YELLOW,
Aaron Gable9ab38c62017-04-06 14:36:33 -07003437 'not lgtm': Fore.RED,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003438 'lgtm': Fore.GREEN,
3439 'commit': Fore.MAGENTA,
3440 'closed': Fore.CYAN,
3441 'error': Fore.WHITE,
3442 }.get(status, Fore.WHITE)
3443
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003444
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003445def get_cl_statuses(changes, fine_grained, max_processes=None):
3446 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003447
3448 If fine_grained is true, this will fetch CL statuses from the server.
3449 Otherwise, simply indicate if there's a matching url for the given branches.
3450
3451 If max_processes is specified, it is used as the maximum number of processes
3452 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3453 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003454
3455 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003456 """
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003457 if not changes:
Edward Lemur61bf4172020-02-24 23:22:37 +00003458 return
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003459
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003460 if not fine_grained:
3461 # Fast path which doesn't involve querying codereview servers.
Aaron Gablea1bab272017-04-11 16:38:18 -07003462 # Do not use get_approving_reviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003463 for cl in changes:
3464 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003465 return
3466
3467 # First, sort out authentication issues.
3468 logging.debug('ensuring credentials exist')
3469 for cl in changes:
3470 cl.EnsureAuthenticated(force=False, refresh=True)
3471
3472 def fetch(cl):
3473 try:
3474 return (cl, cl.GetStatus())
3475 except:
3476 # See http://crbug.com/629863.
Andrii Shyshkalov98824232018-04-19 11:37:15 -07003477 logging.exception('failed to fetch status for cl %s:', cl.GetIssue())
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003478 raise
3479
3480 threads_count = len(changes)
3481 if max_processes:
3482 threads_count = max(1, min(threads_count, max_processes))
3483 logging.debug('querying %d CLs using %d threads', len(changes), threads_count)
3484
Edward Lemur61bf4172020-02-24 23:22:37 +00003485 pool = multiprocessing.pool.ThreadPool(threads_count)
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003486 fetched_cls = set()
3487 try:
3488 it = pool.imap_unordered(fetch, changes).__iter__()
3489 while True:
3490 try:
3491 cl, status = it.next(timeout=5)
Edward Lemur61bf4172020-02-24 23:22:37 +00003492 except (multiprocessing.TimeoutError, StopIteration):
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003493 break
3494 fetched_cls.add(cl)
3495 yield cl, status
3496 finally:
3497 pool.close()
3498
3499 # Add any branches that failed to fetch.
3500 for cl in set(changes) - fetched_cls:
3501 yield (cl, 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003502
rmistry@google.com2dd99862015-06-22 12:22:18 +00003503
3504def upload_branch_deps(cl, args):
3505 """Uploads CLs of local branches that are dependents of the current branch.
3506
3507 If the local branch dependency tree looks like:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003508
3509 test1 -> test2.1 -> test3.1
3510 -> test3.2
3511 -> test2.2 -> test3.3
rmistry@google.com2dd99862015-06-22 12:22:18 +00003512
3513 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3514 run on the dependent branches in this order:
3515 test2.1, test3.1, test3.2, test2.2, test3.3
3516
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003517 Note: This function does not rebase your local dependent branches. Use it
3518 when you make a change to the parent branch that will not conflict
3519 with its dependent branches, and you would like their dependencies
3520 updated in Rietveld.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003521 """
3522 if git_common.is_dirty_git_tree('upload-branch-deps'):
3523 return 1
3524
3525 root_branch = cl.GetBranch()
3526 if root_branch is None:
3527 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3528 'Get on a branch!')
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00003529 if not cl.GetIssue():
rmistry@google.com2dd99862015-06-22 12:22:18 +00003530 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3531 'patchset dependencies without an uploaded CL.')
3532
3533 branches = RunGit(['for-each-ref',
3534 '--format=%(refname:short) %(upstream:short)',
3535 'refs/heads'])
3536 if not branches:
3537 print('No local branches found.')
3538 return 0
3539
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003540 # Create a dictionary of all local branches to the branches that are
3541 # dependent on it.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003542 tracked_to_dependents = collections.defaultdict(list)
3543 for b in branches.splitlines():
3544 tokens = b.split()
3545 if len(tokens) == 2:
3546 branch_name, tracked = tokens
3547 tracked_to_dependents[tracked].append(branch_name)
3548
vapiera7fbd5a2016-06-16 09:17:49 -07003549 print()
3550 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003551 dependents = []
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003552
rmistry@google.com2dd99862015-06-22 12:22:18 +00003553 def traverse_dependents_preorder(branch, padding=''):
3554 dependents_to_process = tracked_to_dependents.get(branch, [])
3555 padding += ' '
3556 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003557 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003558 dependents.append(dependent)
3559 traverse_dependents_preorder(dependent, padding)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003560
rmistry@google.com2dd99862015-06-22 12:22:18 +00003561 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003562 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003563
3564 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003565 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003566 return 0
3567
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01003568 confirm_or_exit('This command will checkout all dependent branches and run '
3569 '"git cl upload".', action='continue')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003570
rmistry@google.com2dd99862015-06-22 12:22:18 +00003571 # Record all dependents that failed to upload.
3572 failures = {}
3573 # Go through all dependents, checkout the branch and upload.
3574 try:
3575 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003576 print()
3577 print('--------------------------------------')
3578 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003579 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003580 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003581 try:
3582 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003583 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003584 failures[dependent_branch] = 1
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003585 except: # pylint: disable=bare-except
rmistry@google.com2dd99862015-06-22 12:22:18 +00003586 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003587 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003588 finally:
3589 # Swap back to the original root branch.
3590 RunGit(['checkout', '-q', root_branch])
3591
vapiera7fbd5a2016-06-16 09:17:49 -07003592 print()
3593 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003594 for dependent_branch in dependents:
3595 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003596 print(' %s : %s' % (dependent_branch, upload_status))
3597 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003598
3599 return 0
3600
3601
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003602def GetArchiveTagForBranch(issue_num, branch_name, existing_tags):
3603 """Given a proposed tag name, returns a tag name that is guaranteed to be
3604 unique. If 'foo' is proposed but already exists, then 'foo-2' is used,
3605 or 'foo-3', and so on."""
3606
3607 proposed_tag = 'git-cl-archived-%s-%s' % (issue_num, branch_name)
3608 for suffix_num in itertools.count(1):
3609 if suffix_num == 1:
3610 to_check = proposed_tag
3611 else:
3612 to_check = '%s-%d' % (proposed_tag, suffix_num)
3613
3614 if to_check not in existing_tags:
3615 return to_check
3616
3617
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003618@metrics.collector.collect_metrics('git cl archive')
kmarshall3bff56b2016-06-06 18:31:47 -07003619def CMDarchive(parser, args):
3620 """Archives and deletes branches associated with closed changelists."""
3621 parser.add_option(
3622 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003623 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003624 parser.add_option(
3625 '-f', '--force', action='store_true',
3626 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003627 parser.add_option(
3628 '-d', '--dry-run', action='store_true',
3629 help='Skip the branch tagging and removal steps.')
3630 parser.add_option(
3631 '-t', '--notags', action='store_true',
3632 help='Do not tag archived branches. '
3633 'Note: local commit history may be lost.')
kmarshall3bff56b2016-06-06 18:31:47 -07003634
kmarshall3bff56b2016-06-06 18:31:47 -07003635 options, args = parser.parse_args(args)
3636 if args:
3637 parser.error('Unsupported args: %s' % ' '.join(args))
kmarshall3bff56b2016-06-06 18:31:47 -07003638
3639 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3640 if not branches:
3641 return 0
3642
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003643 tags = RunGit(['for-each-ref', '--format=%(refname)',
3644 'refs/tags']).splitlines() or []
3645 tags = [t.split('/')[-1] for t in tags]
3646
vapiera7fbd5a2016-06-16 09:17:49 -07003647 print('Finding all branches associated with closed issues...')
Edward Lemur934836a2019-09-09 20:16:54 +00003648 changes = [Changelist(branchref=b)
3649 for b in branches.splitlines()]
kmarshall3bff56b2016-06-06 18:31:47 -07003650 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3651 statuses = get_cl_statuses(changes,
3652 fine_grained=True,
3653 max_processes=options.maxjobs)
3654 proposal = [(cl.GetBranch(),
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003655 GetArchiveTagForBranch(cl.GetIssue(), cl.GetBranch(),
3656 tags))
kmarshall3bff56b2016-06-06 18:31:47 -07003657 for cl, status in statuses
Andrii Shyshkalov51bdf8c2018-10-18 01:07:58 +00003658 if status in ('closed', 'rietveld-not-supported')]
kmarshall3bff56b2016-06-06 18:31:47 -07003659 proposal.sort()
3660
3661 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003662 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003663 return 0
3664
Edward Lemur85153282020-02-14 22:06:29 +00003665 current_branch = scm.GIT.GetBranch(settings.GetRoot())
kmarshall3bff56b2016-06-06 18:31:47 -07003666
vapiera7fbd5a2016-06-16 09:17:49 -07003667 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003668 if options.notags:
3669 for next_item in proposal:
3670 print(' ' + next_item[0])
3671 else:
3672 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3673 for next_item in proposal:
3674 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003675
kmarshall9249e012016-08-23 12:02:16 -07003676 # Quit now on precondition failure or if instructed by the user, either
3677 # via an interactive prompt or by command line flags.
3678 if options.dry_run:
3679 print('\nNo changes were made (dry run).\n')
3680 return 0
3681 elif any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003682 print('You are currently on a branch \'%s\' which is associated with a '
3683 'closed codereview issue, so archive cannot proceed. Please '
3684 'checkout another branch and run this command again.' %
3685 current_branch)
3686 return 1
kmarshall9249e012016-08-23 12:02:16 -07003687 elif not options.force:
sergiyb4a5ecbe2016-06-20 09:46:00 -07003688 answer = ask_for_data('\nProceed with deletion (Y/n)? ').lower()
3689 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003690 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003691 return 1
3692
3693 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003694 if not options.notags:
3695 RunGit(['tag', tagname, branch])
Kevin Marshall0e60ecd2019-12-04 17:44:13 +00003696
3697 if RunGitWithCode(['branch', '-D', branch])[0] != 0:
3698 # Clean up the tag if we failed to delete the branch.
3699 RunGit(['tag', '-d', tagname])
kmarshall9249e012016-08-23 12:02:16 -07003700
vapiera7fbd5a2016-06-16 09:17:49 -07003701 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003702
3703 return 0
3704
3705
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003706@metrics.collector.collect_metrics('git cl status')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003707def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003708 """Show status of changelists.
3709
3710 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003711 - Blue waiting for review
Aaron Gable9ab38c62017-04-06 14:36:33 -07003712 - Yellow waiting for you to reply to review, or not yet sent
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003713 - Green LGTM'ed
Aaron Gable9ab38c62017-04-06 14:36:33 -07003714 - Red 'not LGTM'ed
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00003715 - Magenta in the CQ
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003716 - Cyan was committed, branch can be deleted
Aaron Gable9ab38c62017-04-06 14:36:33 -07003717 - White error, or unknown status
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003718
3719 Also see 'git cl comments'.
3720 """
Alan Cuttera3be9a52019-03-04 18:50:33 +00003721 parser.add_option(
3722 '--no-branch-color',
3723 action='store_true',
3724 help='Disable colorized branch names')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003725 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003726 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003727 parser.add_option('-f', '--fast', action='store_true',
3728 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003729 parser.add_option(
3730 '-j', '--maxjobs', action='store', type=int,
3731 help='The maximum number of jobs to use when retrieving review status')
Edward Lemur52969c92020-02-06 18:15:28 +00003732 parser.add_option(
3733 '-i', '--issue', type=int,
3734 help='Operate on this issue instead of the current branch\'s implicit '
3735 'issue. Requires --field to be set.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003736 options, args = parser.parse_args(args)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003737 if args:
3738 parser.error('Unsupported args: %s' % args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003739
iannuccie53c9352016-08-17 14:40:40 -07003740 if options.issue is not None and not options.field:
Edward Lemur6c6827c2020-02-06 21:15:18 +00003741 parser.error('--field must be given when --issue is set.')
iannucci3c972b92016-08-17 13:24:10 -07003742
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003743 if options.field:
Edward Lemur934836a2019-09-09 20:16:54 +00003744 cl = Changelist(issue=options.issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003745 if options.field.startswith('desc'):
Edward Lemur6c6827c2020-02-06 21:15:18 +00003746 if cl.GetIssue():
3747 print(cl.FetchDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003748 elif options.field == 'id':
3749 issueid = cl.GetIssue()
3750 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07003751 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003752 elif options.field == 'patch':
Aaron Gablee8856ee2017-12-07 12:41:46 -08003753 patchset = cl.GetMostRecentPatchset()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003754 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07003755 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07003756 elif options.field == 'status':
3757 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003758 elif options.field == 'url':
3759 url = cl.GetIssueURL()
3760 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07003761 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00003762 return 0
3763
3764 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3765 if not branches:
3766 print('No local branch found.')
3767 return 0
3768
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003769 changes = [
Edward Lemur934836a2019-09-09 20:16:54 +00003770 Changelist(branchref=b)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003771 for b in branches.splitlines()]
vapiera7fbd5a2016-06-16 09:17:49 -07003772 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003773 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003774 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003775 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003776
Edward Lemur85153282020-02-14 22:06:29 +00003777 current_branch = scm.GIT.GetBranch(settings.GetRoot())
Daniel McArdlea23bf592019-02-12 00:25:12 +00003778
3779 def FormatBranchName(branch, colorize=False):
3780 """Simulates 'git branch' behavior. Colorizes and prefixes branch name with
3781 an asterisk when it is the current branch."""
3782
3783 asterisk = ""
3784 color = Fore.RESET
3785 if branch == current_branch:
3786 asterisk = "* "
3787 color = Fore.GREEN
Edward Lemur85153282020-02-14 22:06:29 +00003788 branch_name = scm.GIT.ShortBranchName(branch)
Daniel McArdlea23bf592019-02-12 00:25:12 +00003789
3790 if colorize:
3791 return asterisk + color + branch_name + Fore.RESET
Daniel McArdle452a49f2019-02-14 17:28:31 +00003792 return asterisk + branch_name
3793
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003794 branch_statuses = {}
Daniel McArdlea23bf592019-02-12 00:25:12 +00003795
3796 alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes))
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003797 for cl in sorted(changes, key=lambda c: c.GetBranch()):
3798 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003799 while branch not in branch_statuses:
Edward Lemur79d4f992019-11-11 23:49:02 +00003800 c, status = next(output)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003801 branch_statuses[c.GetBranch()] = status
3802 status = branch_statuses.pop(branch)
3803 url = cl.GetIssueURL()
3804 if url and (not status or status == 'error'):
3805 # The issue probably doesn't exist anymore.
3806 url += ' (broken)'
3807
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003808 color = color_for_status(status)
maruel@chromium.org885f6512013-07-27 02:17:26 +00003809 reset = Fore.RESET
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00003810 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00003811 color = ''
3812 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00003813 status_str = '(%s)' % status if status else ''
Daniel McArdle452a49f2019-02-14 17:28:31 +00003814
Alan Cuttera3be9a52019-03-04 18:50:33 +00003815 branch_display = FormatBranchName(branch)
3816 padding = ' ' * (alignment - len(branch_display))
3817 if not options.no_branch_color:
3818 branch_display = FormatBranchName(branch, colorize=True)
Daniel McArdle452a49f2019-02-14 17:28:31 +00003819
Alan Cuttera3be9a52019-03-04 18:50:33 +00003820 print(' %s : %s%s %s%s' % (padding + branch_display, color, url,
3821 status_str, reset))
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003822
vapiera7fbd5a2016-06-16 09:17:49 -07003823 print()
Daniel McArdlea23bf592019-02-12 00:25:12 +00003824 print('Current branch: %s' % current_branch)
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003825 for cl in changes:
Daniel McArdlea23bf592019-02-12 00:25:12 +00003826 if cl.GetBranch() == current_branch:
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01003827 break
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003828 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07003829 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00003830 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07003831 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00003832 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07003833 print('Issue description:')
Edward Lemur6c6827c2020-02-06 21:15:18 +00003834 print(cl.FetchDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003835 return 0
3836
3837
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003838def colorize_CMDstatus_doc():
3839 """To be called once in main() to add colors to git cl status help."""
3840 colors = [i for i in dir(Fore) if i[0].isupper()]
3841
3842 def colorize_line(line):
3843 for color in colors:
3844 if color in line.upper():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003845 # Extract whitespace first and the leading '-'.
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003846 indent = len(line) - len(line.lstrip(' ')) + 1
3847 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
3848 return line
3849
3850 lines = CMDstatus.__doc__.splitlines()
3851 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
3852
3853
phajdan.jre328cf92016-08-22 04:12:17 -07003854def write_json(path, contents):
Stefan Zager1306bd02017-06-22 19:26:46 -07003855 if path == '-':
3856 json.dump(contents, sys.stdout)
3857 else:
3858 with open(path, 'w') as f:
3859 json.dump(contents, f)
phajdan.jre328cf92016-08-22 04:12:17 -07003860
3861
maruel@chromium.org0633fb42013-08-16 20:06:14 +00003862@subcommand.usage('[issue_number]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003863@metrics.collector.collect_metrics('git cl issue')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003864def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003865 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003866
3867 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003868 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00003869 parser.add_option('-r', '--reverse', action='store_true',
3870 help='Lookup the branch(es) for the specified issues. If '
3871 'no issues are specified, all branches with mapped '
3872 'issues will be listed.')
Stefan Zager1306bd02017-06-22 19:26:46 -07003873 parser.add_option('--json',
3874 help='Path to JSON output file, or "-" for stdout.')
dnj@chromium.org406c4402015-03-03 17:22:28 +00003875 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003876
dnj@chromium.org406c4402015-03-03 17:22:28 +00003877 if options.reverse:
3878 branches = RunGit(['for-each-ref', 'refs/heads',
Aaron Gablead64abd2017-12-04 09:49:13 -08003879 '--format=%(refname)']).splitlines()
dnj@chromium.org406c4402015-03-03 17:22:28 +00003880 # Reverse issue lookup.
3881 issue_branch_map = {}
Daniel Bratellb56a43a2018-09-06 15:49:03 +00003882
3883 git_config = {}
3884 for config in RunGit(['config', '--get-regexp',
3885 r'branch\..*issue']).splitlines():
3886 name, _space, val = config.partition(' ')
3887 git_config[name] = val
3888
dnj@chromium.org406c4402015-03-03 17:22:28 +00003889 for branch in branches:
Edward Lemur85153282020-02-14 22:06:29 +00003890 config_key = _git_branch_config_key(scm.GIT.ShortBranchName(branch),
Edward Lemur52969c92020-02-06 18:15:28 +00003891 Changelist.IssueConfigKey())
3892 issue = git_config.get(config_key)
3893 if issue:
3894 issue_branch_map.setdefault(int(issue), []).append(branch)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003895 if not args:
3896 args = sorted(issue_branch_map.iterkeys())
phajdan.jre328cf92016-08-22 04:12:17 -07003897 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00003898 for issue in args:
Lei Zhang5a368d42019-03-25 23:18:19 +00003899 try:
3900 issue_num = int(issue)
3901 except ValueError:
3902 print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003903 continue
Lei Zhang5a368d42019-03-25 23:18:19 +00003904 result[issue_num] = issue_branch_map.get(issue_num)
vapiera7fbd5a2016-06-16 09:17:49 -07003905 print('Branch for issue number %s: %s' % (
Lei Zhang5a368d42019-03-25 23:18:19 +00003906 issue, ', '.join(issue_branch_map.get(issue_num) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07003907 if options.json:
3908 write_json(options.json, result)
Aaron Gable78753da2017-06-15 10:35:49 -07003909 return 0
3910
3911 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00003912 issue = ParseIssueNumberArgument(args[0])
Aaron Gable78753da2017-06-15 10:35:49 -07003913 if not issue.valid:
3914 DieWithError('Pass a url or number to set the issue, 0 to unset it, '
3915 'or no argument to list it.\n'
3916 'Maybe you want to run git cl status?')
Edward Lemurf38bc172019-09-03 21:02:13 +00003917 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003918 cl.SetIssue(issue.issue)
dnj@chromium.org406c4402015-03-03 17:22:28 +00003919 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00003920 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07003921 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
3922 if options.json:
3923 write_json(options.json, {
3924 'issue': cl.GetIssue(),
3925 'issue_url': cl.GetIssueURL(),
3926 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003927 return 0
3928
3929
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003930@metrics.collector.collect_metrics('git cl comments')
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003931def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003932 """Shows or posts review comments for any changelist."""
3933 parser.add_option('-a', '--add-comment', dest='comment',
3934 help='comment to add to an issue')
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003935 parser.add_option('-p', '--publish', action='store_true',
3936 help='marks CL as ready and sends comment to reviewers')
Andrii Shyshkalov0d6b46e2017-03-17 22:23:22 +01003937 parser.add_option('-i', '--issue', dest='issue',
Edward Lemurf38bc172019-09-03 21:02:13 +00003938 help='review issue id (defaults to current issue).')
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003939 parser.add_option('-m', '--machine-readable', dest='readable',
3940 action='store_false', default=True,
3941 help='output comments in a format compatible with '
3942 'editor parsing')
smut@google.comc85ac942015-09-15 16:34:43 +00003943 parser.add_option('-j', '--json-file',
Stefan Zager1306bd02017-06-22 19:26:46 -07003944 help='File to write JSON summary to, or "-" for stdout')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003945 options, args = parser.parse_args(args)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003946
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003947 issue = None
3948 if options.issue:
3949 try:
3950 issue = int(options.issue)
3951 except ValueError:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003952 DieWithError('A review issue ID is expected to be a number.')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003953
Edward Lemur934836a2019-09-09 20:16:54 +00003954 cl = Changelist(issue=issue)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003955
3956 if options.comment:
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00003957 cl.AddComment(options.comment, options.publish)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003958 return 0
3959
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07003960 summary = sorted(cl.GetCommentsSummary(readable=options.readable),
3961 key=lambda c: c.date)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003962 for comment in summary:
3963 if comment.disapproval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003964 color = Fore.RED
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003965 elif comment.approval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003966 color = Fore.GREEN
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003967 elif comment.sender == cl.GetIssueOwner():
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003968 color = Fore.MAGENTA
Quinten Yearsley0e617c02019-02-20 00:37:03 +00003969 elif comment.autogenerated:
3970 color = Fore.CYAN
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00003971 else:
3972 color = Fore.BLUE
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003973 print('\n%s%s %s%s\n%s' % (
3974 color,
3975 comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'),
3976 comment.sender,
3977 Fore.RESET,
3978 '\n'.join(' ' + l for l in comment.message.strip().splitlines())))
3979
smut@google.comc85ac942015-09-15 16:34:43 +00003980 if options.json_file:
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003981 def pre_serialize(c):
Edward Lemur79d4f992019-11-11 23:49:02 +00003982 dct = c._asdict().copy()
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01003983 dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f')
3984 return dct
Edward Lemur79d4f992019-11-11 23:49:02 +00003985 write_json(options.json_file, [pre_serialize(x) for x in summary])
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00003986 return 0
3987
3988
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00003989@subcommand.usage('[codereview url or issue id]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003990@metrics.collector.collect_metrics('git cl description')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00003991def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003992 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00003993 parser.add_option('-d', '--display', action='store_true',
3994 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00003995 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07003996 help='New description to set for this issue (- for stdin, '
3997 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07003998 parser.add_option('-f', '--force', action='store_true',
3999 help='Delete any unpublished Gerrit edits for this issue '
4000 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004001
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004002 options, args = parser.parse_args(args)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004003
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004004 target_issue_arg = None
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004005 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00004006 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004007 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004008 parser.error('Invalid issue ID or URL.')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004009
Edward Lemur934836a2019-09-09 20:16:54 +00004010 kwargs = {}
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004011 if target_issue_arg:
4012 kwargs['issue'] = target_issue_arg.issue
4013 kwargs['codereview_host'] = target_issue_arg.hostname
martiniss6eda05f2016-06-30 10:18:35 -07004014
4015 cl = Changelist(**kwargs)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004016 if not cl.GetIssue():
4017 DieWithError('This branch has no associated changelist.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004018
Edward Lemur678a6842019-10-03 22:25:05 +00004019 if args and not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004020 logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004021
Edward Lemur6c6827c2020-02-06 21:15:18 +00004022 description = ChangeDescription(cl.FetchDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004023
smut@google.com34fb6b12015-07-13 20:03:26 +00004024 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07004025 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00004026 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004027
4028 if options.new_description:
4029 text = options.new_description
4030 if text == '-':
4031 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07004032 elif text == '+':
4033 base_branch = cl.GetCommonAncestorWithUpstream()
Edward Lemur7f6dec02020-02-06 20:23:58 +00004034 text = cl.GetLocalDescription(base_branch)
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004035
4036 description.set_description(text)
4037 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00004038 description.prompt()
Edward Lemur6c6827c2020-02-06 21:15:18 +00004039 if cl.FetchDescription().strip() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07004040 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004041 return 0
4042
4043
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004044@metrics.collector.collect_metrics('git cl lint')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004045def CMDlint(parser, args):
4046 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004047 parser.add_option('--filter', action='append', metavar='-x,+y',
4048 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004049 options, args = parser.parse_args(args)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004050
4051 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08004052 # pylint: disable=protected-access
thestig@chromium.org44202a22014-03-11 19:22:18 +00004053 try:
4054 import cpplint
4055 import cpplint_chromium
4056 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07004057 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004058 return 1
4059
4060 # Change the current working directory before calling lint so that it
4061 # shows the correct base.
4062 previous_cwd = os.getcwd()
4063 os.chdir(settings.GetRoot())
4064 try:
Edward Lemur934836a2019-09-09 20:16:54 +00004065 cl = Changelist()
Edward Lemur7f6dec02020-02-06 20:23:58 +00004066 change = cl.GetChange(cl.GetCommonAncestorWithUpstream())
thestig@chromium.org44202a22014-03-11 19:22:18 +00004067 files = [f.LocalPath() for f in change.AffectedFiles()]
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004068 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07004069 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004070 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00004071
4072 # Process cpplints arguments if any.
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004073 command = args + files
4074 if options.filter:
4075 command = ['--filter=' + ','.join(options.filter)] + command
4076 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004077
4078 white_regex = re.compile(settings.GetLintRegex())
4079 black_regex = re.compile(settings.GetLintIgnoreRegex())
4080 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
4081 for filename in filenames:
4082 if white_regex.match(filename):
4083 if black_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07004084 print('Ignoring file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004085 else:
4086 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
4087 extra_check_functions)
4088 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004089 print('Skipping file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004090 finally:
4091 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07004092 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004093 if cpplint._cpplint_state.error_count != 0:
4094 return 1
4095 return 0
4096
4097
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004098@metrics.collector.collect_metrics('git cl presubmit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004099def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004100 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004101 parser.add_option('-u', '--upload', action='store_true',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004102 help='Run upload hook instead of the push hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004103 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00004104 help='Run checks even if tree is dirty')
Aaron Gable8076c282017-11-29 14:39:41 -08004105 parser.add_option('--all', action='store_true',
4106 help='Run checks against all files, not just modified ones')
Edward Lesmes8e282792018-04-03 18:50:29 -04004107 parser.add_option('--parallel', action='store_true',
4108 help='Run all tests specified by input_api.RunTests in all '
4109 'PRESUBMIT files in parallel.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004110 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004111
sbc@chromium.org71437c02015-04-09 19:29:40 +00004112 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07004113 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004114 return 1
4115
Edward Lemur934836a2019-09-09 20:16:54 +00004116 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004117 if args:
4118 base_branch = args[0]
4119 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004120 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004121 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004122
Gregory Nisbet29d5cf82020-02-27 08:16:58 +00004123 if cl.GetIssue():
4124 description = cl.FetchDescription()
Aaron Gable8076c282017-11-29 14:39:41 -08004125 else:
Gregory Nisbet29d5cf82020-02-27 08:16:58 +00004126 description = cl.GetLocalDescription(base_branch)
Aaron Gable8076c282017-11-29 14:39:41 -08004127
ilevy@chromium.org051ad0e2013-03-04 21:57:34 +00004128 cl.RunHook(
4129 committing=not options.upload,
4130 may_prompt=False,
4131 verbose=options.verbose,
Edward Lemur227d5102020-02-25 23:45:35 +00004132 parallel=options.parallel,
4133 upstream=base_branch,
4134 description=description,
4135 all_files=options.all)
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00004136 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004137
4138
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004139def GenerateGerritChangeId(message):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004140 """Returns the Change ID footer value (Ixxxxxx...xxx).
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004141
4142 Works the same way as
4143 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
4144 but can be called on demand on all platforms.
4145
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004146 The basic idea is to generate git hash of a state of the tree, original
4147 commit message, author/committer info and timestamps.
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004148 """
4149 lines = []
4150 tree_hash = RunGitSilent(['write-tree'])
4151 lines.append('tree %s' % tree_hash.strip())
4152 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
4153 if code == 0:
4154 lines.append('parent %s' % parent.strip())
4155 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
4156 lines.append('author %s' % author.strip())
4157 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
4158 lines.append('committer %s' % committer.strip())
4159 lines.append('')
4160 # Note: Gerrit's commit-hook actually cleans message of some lines and
4161 # whitespace. This code is not doing this, but it clearly won't decrease
4162 # entropy.
4163 lines.append(message)
4164 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
Raul Tambreb946b232019-03-26 14:48:46 +00004165 stdin=('\n'.join(lines)).encode())
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004166 return 'I%s' % change_hash.strip()
4167
4168
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01004169def GetTargetRef(remote, remote_branch, target_branch):
wittman@chromium.org455dc922015-01-26 20:15:50 +00004170 """Computes the remote branch ref to use for the CL.
4171
4172 Args:
4173 remote (str): The git remote for the CL.
4174 remote_branch (str): The git remote branch for the CL.
4175 target_branch (str): The target branch specified by the user.
wittman@chromium.org455dc922015-01-26 20:15:50 +00004176 """
4177 if not (remote and remote_branch):
4178 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004179
wittman@chromium.org455dc922015-01-26 20:15:50 +00004180 if target_branch:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004181 # Canonicalize branch references to the equivalent local full symbolic
wittman@chromium.org455dc922015-01-26 20:15:50 +00004182 # refs, which are then translated into the remote full symbolic refs
4183 # below.
4184 if '/' not in target_branch:
4185 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4186 else:
4187 prefix_replacements = (
4188 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4189 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4190 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4191 )
4192 match = None
4193 for regex, replacement in prefix_replacements:
4194 match = re.search(regex, target_branch)
4195 if match:
4196 remote_branch = target_branch.replace(match.group(0), replacement)
4197 break
4198 if not match:
4199 # This is a branch path but not one we recognize; use as-is.
4200 remote_branch = target_branch
rmistry@google.comc68112d2015-03-03 12:48:06 +00004201 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
4202 # Handle the refs that need to land in different refs.
4203 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004204
wittman@chromium.org455dc922015-01-26 20:15:50 +00004205 # Create the true path to the remote branch.
4206 # Does the following translation:
4207 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
4208 # * refs/remotes/origin/master -> refs/heads/master
4209 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4210 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4211 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4212 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4213 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4214 'refs/heads/')
4215 elif remote_branch.startswith('refs/remotes/branch-heads'):
4216 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +01004217
wittman@chromium.org455dc922015-01-26 20:15:50 +00004218 return remote_branch
4219
4220
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004221def cleanup_list(l):
4222 """Fixes a list so that comma separated items are put as individual items.
4223
4224 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4225 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4226 """
4227 items = sum((i.split(',') for i in l), [])
4228 stripped_items = (i.strip() for i in items)
4229 return sorted(filter(None, stripped_items))
4230
4231
Aaron Gable4db38df2017-11-03 14:59:07 -07004232@subcommand.usage('[flags]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004233@metrics.collector.collect_metrics('git cl upload')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004234def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004235 """Uploads the current changelist to codereview.
4236
4237 Can skip dependency patchset uploads for a branch by running:
4238 git config branch.branch_name.skip-deps-uploads True
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004239 To unset, run:
rmistry@google.com78948ed2015-07-08 23:09:57 +00004240 git config --unset branch.branch_name.skip-deps-uploads
4241 Can also set the above globally by using the --global flag.
Dominic Battre7d1c4842017-10-27 09:17:28 +02004242
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004243 If the name of the checked out branch starts with "bug-" or "fix-" followed
4244 by a bug number, this bug number is automatically populated in the CL
Dominic Battre7d1c4842017-10-27 09:17:28 +02004245 description.
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004246
4247 If subject contains text in square brackets or has "<text>: " prefix, such
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004248 text(s) is treated as Gerrit hashtags. For example, CLs with subjects:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004249 [git-cl] add support for hashtags
4250 Foo bar: implement foo
4251 will be hashtagged with "git-cl" and "foo-bar" respectively.
rmistry@google.com78948ed2015-07-08 23:09:57 +00004252 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004253 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4254 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004255 parser.add_option('--bypass-watchlists', action='store_true',
4256 dest='bypass_watchlists',
4257 help='bypass watchlists auto CC-ing reviewers')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004258 parser.add_option('-f', '--force', action='store_true', dest='force',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004259 help="force yes to questions (don't prompt)")
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004260 parser.add_option('--message', '-m', dest='message',
4261 help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004262 parser.add_option('-b', '--bug',
4263 help='pre-populate the bug number(s) for this issue. '
4264 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004265 parser.add_option('--message-file', dest='message_file',
4266 help='file which contains message for patchset')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004267 parser.add_option('--title', '-t', dest='title',
4268 help='title for patchset')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004269 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004270 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004271 help='reviewer email addresses')
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004272 parser.add_option('--tbrs',
4273 action='append', default=[],
4274 help='TBR email addresses')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004275 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004276 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004277 help='cc email addresses')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004278 parser.add_option('--hashtag', dest='hashtags',
4279 action='append', default=[],
4280 help=('Gerrit hashtag for new CL; '
4281 'can be applied multiple times'))
adamk@chromium.org36f47302013-04-05 01:08:31 +00004282 parser.add_option('-s', '--send-mail', action='store_true',
Aaron Gable59f48512017-01-12 10:54:46 -08004283 help='send email to reviewer(s) and cc(s) immediately')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004284 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004285 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004286 metavar='TARGET',
4287 help='Apply CL to remote ref TARGET. ' +
4288 'Default: remote branch head, or master')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004289 parser.add_option('--squash', action='store_true',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004290 help='Squash multiple commits into one')
Mike Frysingera989d552019-08-14 20:51:23 +00004291 parser.add_option('--no-squash', action='store_false', dest='squash',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004292 help='Don\'t squash multiple commits into one')
rmistry9eadede2016-09-19 11:22:43 -07004293 parser.add_option('--topic', default=None,
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004294 help='Topic to specify when uploading')
Robert Iannuccif2708bd2017-04-17 15:49:02 -07004295 parser.add_option('--tbr-owners', dest='add_owners_to', action='store_const',
4296 const='TBR', help='add a set of OWNERS to TBR')
4297 parser.add_option('--r-owners', dest='add_owners_to', action='store_const',
4298 const='R', help='add a set of OWNERS to R')
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004299 parser.add_option('-c', '--use-commit-queue', action='store_true',
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004300 default=False,
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004301 help='tell the CQ to commit this patchset; '
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004302 'implies --send-mail')
4303 parser.add_option('-d', '--cq-dry-run',
4304 action='store_true', default=False,
rmistry@google.comef966222015-04-07 11:15:01 +00004305 help='Send the patchset to do a CQ dry run right after '
4306 'upload.')
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00004307 parser.add_option('--preserve-tryjobs', action='store_true',
4308 help='instruct the CQ to let tryjobs running even after '
4309 'new patchsets are uploaded instead of canceling '
4310 'prior patchset\' tryjobs')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004311 parser.add_option('--dependencies', action='store_true',
4312 help='Uploads CLs of all the local branches that depend on '
4313 'the current branch')
Ravi Mistry31e7d562018-04-02 12:53:57 -04004314 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4315 help='Sends your change to the CQ after an approval. Only '
4316 'works on repos that have the Auto-Submit label '
4317 'enabled')
Edward Lesmes8e282792018-04-03 18:50:29 -04004318 parser.add_option('--parallel', action='store_true',
4319 help='Run all tests specified by input_api.RunTests in all '
4320 'PRESUBMIT files in parallel.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004321 parser.add_option('--no-autocc', action='store_true',
4322 help='Disables automatic addition of CC emails')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004323 parser.add_option('--private', action='store_true',
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004324 help='Set the review private. This implies --no-autocc.')
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004325 parser.add_option('-R', '--retry-failed', action='store_true',
4326 help='Retry failed tryjobs from old patchset immediately '
4327 'after uploading new patchset. Cannot be used with '
4328 '--use-commit-queue or --cq-dry-run.')
4329 parser.add_option('--buildbucket-host', default='cr-buildbucket.appspot.com',
4330 help='Host of buildbucket. The default host is %default.')
Dan Beamd8b04ca2019-10-10 21:23:26 +00004331 parser.add_option('--fixed', '-x',
4332 help='List of bugs that will be commented on and marked '
4333 'fixed (pre-populates "Fixed:" tag). Same format as '
4334 '-b option / "Bug:" tag. If fixing several issues, '
4335 'separate with commas.')
Josipe827b0f2020-01-30 00:07:20 +00004336 parser.add_option('--edit-description', action='store_true', default=False,
4337 help='Modify description before upload. Cannot be used '
4338 'with --force. It is a noop when --no-squash is set '
4339 'or a new commit is created.')
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004340
rmistry@google.com2dd99862015-06-22 12:22:18 +00004341 orig_args = args
ukai@chromium.orge8077812012-02-03 03:41:46 +00004342 (options, args) = parser.parse_args(args)
4343
sbc@chromium.org71437c02015-04-09 19:29:40 +00004344 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004345 return 1
4346
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004347 options.reviewers = cleanup_list(options.reviewers)
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004348 options.tbrs = cleanup_list(options.tbrs)
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004349 options.cc = cleanup_list(options.cc)
4350
Josipe827b0f2020-01-30 00:07:20 +00004351 if options.edit_description and options.force:
4352 parser.error('Only one of --force and --edit-description allowed')
4353
tandriib80458a2016-06-23 12:20:07 -07004354 if options.message_file:
4355 if options.message:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004356 parser.error('Only one of --message and --message-file allowed.')
tandriib80458a2016-06-23 12:20:07 -07004357 options.message = gclient_utils.FileRead(options.message_file)
4358 options.message_file = None
4359
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004360 if ([options.cq_dry_run,
4361 options.use_commit_queue,
4362 options.retry_failed].count(True) > 1):
4363 parser.error('Only one of --use-commit-queue, --cq-dry-run, or '
4364 '--retry-failed is allowed.')
tandrii4d0545a2016-07-06 03:56:49 -07004365
Aaron Gableedbc4132017-09-11 13:22:28 -07004366 if options.use_commit_queue:
4367 options.send_mail = True
4368
tandrii@chromium.org512d79c2016-03-31 12:55:28 +00004369 # For sanity of test expectations, do this otherwise lazy-loading *now*.
4370 settings.GetIsGerrit()
4371
Edward Lemur934836a2019-09-09 20:16:54 +00004372 cl = Changelist()
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004373 # Warm change details cache now to avoid RPCs later, reducing latency for
4374 # developers.
4375 if cl.GetIssue():
4376 cl._GetChangeDetail(
4377 ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS'])
4378
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004379 if options.retry_failed and not cl.GetIssue():
4380 print('No previous patchsets, so --retry-failed has no effect.')
4381 options.retry_failed = False
Edward Lesmes7677e5c2020-02-19 20:39:03 +00004382
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004383 # cl.GetMostRecentPatchset uses cached information, and can return the last
4384 # patchset before upload. Calling it here makes it clear that it's the
4385 # last patchset before upload. Note that GetMostRecentPatchset will fail
4386 # if no CL has been uploaded yet.
4387 if options.retry_failed:
4388 patchset = cl.GetMostRecentPatchset()
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00004389
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004390 ret = cl.CMDUpload(options, args, orig_args)
4391
4392 if options.retry_failed:
4393 if ret != 0:
4394 print('Upload failed, so --retry-failed has no effect.')
4395 return ret
Andrii Shyshkalov1ad58112019-10-08 01:46:14 +00004396 builds, _ = _fetch_latest_builds(
Edward Lemur5b929a42019-10-21 17:57:39 +00004397 cl, options.buildbucket_host, latest_patchset=patchset)
Edward Lemur45768512020-03-02 19:03:14 +00004398 jobs = _filter_failed_for_retry(builds)
4399 if len(jobs) == 0:
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004400 print('No failed tryjobs, so --retry-failed has no effect.')
4401 return ret
Quinten Yearsley777660f2020-03-04 23:37:06 +00004402 _trigger_tryjobs(cl, jobs, options, patchset + 1)
Quinten Yearsleya19d3532019-09-30 21:54:39 +00004403
4404 return ret
ukai@chromium.orge8077812012-02-03 03:41:46 +00004405
4406
Francois Dorayd42c6812017-05-30 15:10:20 -04004407@subcommand.usage('--description=<description file>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004408@metrics.collector.collect_metrics('git cl split')
Francois Dorayd42c6812017-05-30 15:10:20 -04004409def CMDsplit(parser, args):
4410 """Splits a branch into smaller branches and uploads CLs.
4411
4412 Creates a branch and uploads a CL for each group of files modified in the
4413 current branch that share a common OWNERS file. In the CL description and
Edward Lemurac5c55f2020-02-29 00:17:16 +00004414 comment, the string '$directory', is replaced with the directory containing
4415 the shared OWNERS file.
Francois Dorayd42c6812017-05-30 15:10:20 -04004416 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004417 parser.add_option('-d', '--description', dest='description_file',
4418 help='A text file containing a CL description in which '
4419 '$directory will be replaced by each CL\'s directory.')
4420 parser.add_option('-c', '--comment', dest='comment_file',
4421 help='A text file containing a CL comment.')
4422 parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true',
Chris Watkinsba28e462017-12-13 11:22:17 +11004423 default=False,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004424 help='List the files and reviewers for each CL that would '
4425 'be created, but don\'t create branches or CLs.')
4426 parser.add_option('--cq-dry-run', action='store_true',
4427 help='If set, will do a cq dry run for each uploaded CL. '
4428 'Please be careful when doing this; more than ~10 CLs '
4429 'has the potential to overload our build '
4430 'infrastructure. Try to upload these not during high '
4431 'load times (usually 11-3 Mountain View time). Email '
4432 'infra-dev@chromium.org with any questions.')
Takuto Ikuta51eca592019-02-14 19:40:52 +00004433 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4434 default=True,
4435 help='Sends your change to the CQ after an approval. Only '
4436 'works on repos that have the Auto-Submit label '
4437 'enabled')
Francois Dorayd42c6812017-05-30 15:10:20 -04004438 options, _ = parser.parse_args(args)
4439
4440 if not options.description_file:
4441 parser.error('No --description flag specified.')
4442
4443 def WrappedCMDupload(args):
4444 return CMDupload(OptionParser(), args)
4445
4446 return split_cl.SplitCl(options.description_file, options.comment_file,
Stephen Martiniscb326682018-08-29 21:06:30 +00004447 Changelist, WrappedCMDupload, options.dry_run,
Takuto Ikuta51eca592019-02-14 19:40:52 +00004448 options.cq_dry_run, options.enable_auto_submit)
Francois Dorayd42c6812017-05-30 15:10:20 -04004449
4450
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004451@subcommand.usage('DEPRECATED')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004452@metrics.collector.collect_metrics('git cl commit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004453def CMDdcommit(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004454 """DEPRECATED: Used to commit the current changelist via git-svn."""
4455 message = ('git-cl no longer supports committing to SVN repositories via '
4456 'git-svn. You probably want to use `git cl land` instead.')
4457 print(message)
4458 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004459
4460
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004461@subcommand.usage('[upstream branch to apply against]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004462@metrics.collector.collect_metrics('git cl land')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004463def CMDland(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004464 """Commits the current changelist via git.
4465
4466 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4467 upstream and closes the issue automatically and atomically.
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004468 """
4469 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4470 help='bypass upload presubmit hook')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004471 parser.add_option('-f', '--force', action='store_true', dest='force',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004472 help="force yes to questions (don't prompt)")
Edward Lesmes67b3faa2018-04-13 17:50:52 -04004473 parser.add_option('--parallel', action='store_true',
4474 help='Run all tests specified by input_api.RunTests in all '
4475 'PRESUBMIT files in parallel.')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004476 (options, args) = parser.parse_args(args)
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004477
Edward Lemur934836a2019-09-09 20:16:54 +00004478 cl = Changelist()
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004479
Robert Iannucci2e73d432018-03-14 01:10:47 -07004480 if not cl.GetIssue():
4481 DieWithError('You must upload the change first to Gerrit.\n'
4482 ' If you would rather have `git cl land` upload '
4483 'automatically for you, see http://crbug.com/642759')
Edward Lemur125d60a2019-09-13 18:25:41 +00004484 return cl.CMDLand(options.force, options.bypass_hooks,
Olivier Robin75ee7252018-04-13 10:02:56 +02004485 options.verbose, options.parallel)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004486
4487
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004488@subcommand.usage('<patch url or issue id or issue url>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004489@metrics.collector.collect_metrics('git cl patch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004490def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004491 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004492 parser.add_option('-b', dest='newbranch',
4493 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004494 parser.add_option('-f', '--force', action='store_true',
Aaron Gable62619a32017-06-16 08:22:09 -07004495 help='overwrite state on the current or chosen branch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004496 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
Edward Lemurf38bc172019-09-03 21:02:13 +00004497 help='don\'t commit after patch applies.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004498
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004499 group = optparse.OptionGroup(
4500 parser,
4501 'Options for continuing work on the current issue uploaded from a '
4502 'different clone (e.g. different machine). Must be used independently '
4503 'from the other options. No issue number should be specified, and the '
4504 'branch must have an issue number associated with it')
4505 group.add_option('--reapply', action='store_true', dest='reapply',
4506 help='Reset the branch and reapply the issue.\n'
4507 'CAUTION: This will undo any local changes in this '
4508 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004509
4510 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004511 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004512 parser.add_option_group(group)
4513
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004514 (options, args) = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004515
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004516 if options.reapply:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004517 if options.newbranch:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004518 parser.error('--reapply works on the current branch only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004519 if len(args) > 0:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004520 parser.error('--reapply implies no additional arguments.')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004521
Edward Lemur934836a2019-09-09 20:16:54 +00004522 cl = Changelist()
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004523 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004524 parser.error('Current branch must have an associated issue.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004525
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004526 upstream = cl.GetUpstreamBranch()
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004527 if upstream is None:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004528 parser.error('No upstream branch specified. Cannot reset branch.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004529
4530 RunGit(['reset', '--hard', upstream])
4531 if options.pull:
4532 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004533
Edward Lemur678a6842019-10-03 22:25:05 +00004534 target_issue_arg = ParseIssueNumberArgument(cl.GetIssue())
4535 return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, False)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004536
4537 if len(args) != 1 or not args[0]:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004538 parser.error('Must specify issue number or URL.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004539
Edward Lemurf38bc172019-09-03 21:02:13 +00004540 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004541 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004542 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004543
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004544 # We don't want uncommitted changes mixed up with the patch.
4545 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004546 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004547
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004548 if options.newbranch:
4549 if options.force:
4550 RunGit(['branch', '-D', options.newbranch],
4551 stderr=subprocess2.PIPE, error_ok=True)
Edward Lemur84101642020-02-21 21:40:34 +00004552 git_new_branch.create_new_branch(options.newbranch)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004553
Edward Lemur678a6842019-10-03 22:25:05 +00004554 cl = Changelist(
4555 codereview_host=target_issue_arg.hostname, issue=target_issue_arg.issue)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004556
Edward Lemur678a6842019-10-03 22:25:05 +00004557 if not args[0].isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +00004558 print('canonical issue/change URL: %s\n' % cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004559
Edward Lemurf38bc172019-09-03 21:02:13 +00004560 return cl.CMDPatchWithParsedIssue(
4561 target_issue_arg, options.nocommit, options.force)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004562
4563
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004564def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004565 """Fetches the tree status and returns either 'open', 'closed',
4566 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004567 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004568 if url:
Edward Lemur79d4f992019-11-11 23:49:02 +00004569 status = urllib.request.urlopen(url).read().lower()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004570 if status.find('closed') != -1 or status == '0':
4571 return 'closed'
4572 elif status.find('open') != -1 or status == '1':
4573 return 'open'
4574 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004575 return 'unset'
4576
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004577
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004578def GetTreeStatusReason():
4579 """Fetches the tree status from a json url and returns the message
4580 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004581 url = settings.GetTreeStatusUrl()
4582 json_url = urlparse.urljoin(url, '/current?format=json')
Edward Lemur79d4f992019-11-11 23:49:02 +00004583 connection = urllib.request.urlopen(json_url)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004584 status = json.loads(connection.read())
4585 connection.close()
4586 return status['message']
4587
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004588
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004589@metrics.collector.collect_metrics('git cl tree')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004590def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004591 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004592 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004593 status = GetTreeStatus()
4594 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004595 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004596 return 2
4597
vapiera7fbd5a2016-06-16 09:17:49 -07004598 print('The tree is %s' % status)
4599 print()
4600 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004601 if status != 'open':
4602 return 1
4603 return 0
4604
4605
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004606@metrics.collector.collect_metrics('git cl try')
maruel@chromium.org15192402012-09-06 12:38:29 +00004607def CMDtry(parser, args):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004608 """Triggers tryjobs using either Buildbucket or CQ dry run."""
4609 group = optparse.OptionGroup(parser, 'Tryjob options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004610 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004611 '-b', '--bot', action='append',
4612 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4613 'times to specify multiple builders. ex: '
4614 '"-b win_rel -b win_layout". See '
4615 'the try server waterfall for the builders name and the tests '
4616 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004617 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004618 '-B', '--bucket', default='',
4619 help=('Buildbucket bucket to send the try requests.'))
4620 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004621 '-r', '--revision',
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004622 help='Revision to use for the tryjob; default: the revision will '
tandriif7b29d42016-10-07 08:45:41 -07004623 'be determined by the try recipe that builder runs, which usually '
4624 'defaults to HEAD of origin/master')
maruel@chromium.org15192402012-09-06 12:38:29 +00004625 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004626 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004627 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004628 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004629 group.add_option(
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004630 '--category', default='git_cl_try', help='Specify custom build category.')
4631 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004632 '--project',
4633 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004634 'in recipe to determine to which repository or directory to '
4635 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004636 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004637 '-p', '--property', dest='properties', action='append', default=[],
4638 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004639 'key2=value2 etc. The value will be treated as '
4640 'json if decodable, or as string otherwise. '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004641 'NOTE: using this may make your tryjob not usable for CQ, '
4642 'which will then schedule another tryjob with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004643 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004644 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4645 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004646 parser.add_option_group(group)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004647 parser.add_option(
4648 '-R', '--retry-failed', action='store_true', default=False,
4649 help='Retry failed jobs from the latest set of tryjobs. '
4650 'Not allowed with --bucket and --bot options.')
Edward Lemur52969c92020-02-06 18:15:28 +00004651 parser.add_option(
4652 '-i', '--issue', type=int,
4653 help='Operate on this issue instead of the current branch\'s implicit '
4654 'issue.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004655 options, args = parser.parse_args(args)
4656
machenbach@chromium.org45453142015-09-15 08:45:22 +00004657 # Make sure that all properties are prop=value pairs.
4658 bad_params = [x for x in options.properties if '=' not in x]
4659 if bad_params:
4660 parser.error('Got properties with missing "=": %s' % bad_params)
4661
maruel@chromium.org15192402012-09-06 12:38:29 +00004662 if args:
4663 parser.error('Unknown arguments: %s' % args)
4664
Edward Lemur934836a2019-09-09 20:16:54 +00004665 cl = Changelist(issue=options.issue)
maruel@chromium.org15192402012-09-06 12:38:29 +00004666 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004667 parser.error('Need to upload first.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004668
Edward Lemurf38bc172019-09-03 21:02:13 +00004669 # HACK: warm up Gerrit change detail cache to save on RPCs.
Edward Lemur125d60a2019-09-13 18:25:41 +00004670 cl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS'])
Andrii Shyshkaloveadad922017-01-26 09:38:30 +01004671
tandriie113dfd2016-10-11 10:20:12 -07004672 error_message = cl.CannotTriggerTryJobReason()
4673 if error_message:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004674 parser.error('Can\'t trigger tryjobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004675
Edward Lemur45768512020-03-02 19:03:14 +00004676 if options.bot:
4677 if options.retry_failed:
4678 parser.error('--bot is not compatible with --retry-failed.')
4679 if not options.bucket:
4680 parser.error('A bucket (e.g. "chromium/try") is required.')
4681
4682 triggered = [b for b in options.bot if 'triggered' in b]
4683 if triggered:
4684 parser.error(
4685 'Cannot schedule builds on triggered bots: %s.\n'
4686 'This type of bot requires an initial job from a parent (usually a '
4687 'builder). Schedule a job on the parent instead.\n' % triggered)
4688
4689 if options.bucket.startswith('.master'):
4690 parser.error('Buildbot masters are not supported.')
4691
4692 project, bucket = _parse_bucket(options.bucket)
4693 if project is None or bucket is None:
4694 parser.error('Invalid bucket: %s.' % options.bucket)
4695 jobs = sorted((project, bucket, bot) for bot in options.bot)
4696 elif options.retry_failed:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004697 print('Searching for failed tryjobs...')
Edward Lemur5b929a42019-10-21 17:57:39 +00004698 builds, patchset = _fetch_latest_builds(cl, options.buildbucket_host)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004699 if options.verbose:
4700 print('Got %d builds in patchset #%d' % (len(builds), patchset))
Edward Lemur45768512020-03-02 19:03:14 +00004701 jobs = _filter_failed_for_retry(builds)
4702 if not jobs:
Quinten Yearsley983111f2019-09-26 17:18:48 +00004703 print('There are no failed jobs in the latest set of jobs '
4704 '(patchset #%d), doing nothing.' % patchset)
4705 return 0
Edward Lemur45768512020-03-02 19:03:14 +00004706 num_builders = len(jobs)
Quinten Yearsley983111f2019-09-26 17:18:48 +00004707 if num_builders > 10:
4708 confirm_or_exit('There are %d builders with failed builds.'
4709 % num_builders, action='continue')
4710 else:
qyearsley1fdfcb62016-10-24 13:22:03 -07004711 if options.verbose:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07004712 print('git cl try with no bots now defaults to CQ dry run.')
4713 print('Scheduling CQ dry run on: %s' % cl.GetIssueURL())
4714 return cl.SetCQState(_CQState.DRY_RUN)
stip@chromium.org43064fd2013-12-18 20:07:44 +00004715
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004716 patchset = cl.GetMostRecentPatchset()
Edward Lemur2c210a42019-09-16 23:58:35 +00004717 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004718 _trigger_tryjobs(cl, jobs, options, patchset)
Edward Lemur2c210a42019-09-16 23:58:35 +00004719 except BuildbucketResponseException as ex:
4720 print('ERROR: %s' % ex)
4721 return 1
4722 return 0
maruel@chromium.org15192402012-09-06 12:38:29 +00004723
4724
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004725@metrics.collector.collect_metrics('git cl try-results')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004726def CMDtry_results(parser, args):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004727 """Prints info about results for tryjobs associated with the current CL."""
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004728 group = optparse.OptionGroup(parser, 'Tryjob results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004729 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004730 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004731 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004732 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004733 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004734 '--color', action='store_true', default=setup_color.IS_TTY,
4735 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004736 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004737 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4738 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004739 group.add_option(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004740 '--json', help=('Path of JSON output file to write tryjob results to,'
Stefan Zager1306bd02017-06-22 19:26:46 -07004741 'or "-" for stdout.'))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004742 parser.add_option_group(group)
Edward Lemur52969c92020-02-06 18:15:28 +00004743 parser.add_option(
4744 '-i', '--issue', type=int,
4745 help='Operate on this issue instead of the current branch\'s implicit '
4746 'issue.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004747 options, args = parser.parse_args(args)
4748 if args:
4749 parser.error('Unrecognized args: %s' % ' '.join(args))
4750
Edward Lemur934836a2019-09-09 20:16:54 +00004751 cl = Changelist(issue=options.issue)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004752 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004753 parser.error('Need to upload first.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004754
tandrii221ab252016-10-06 08:12:04 -07004755 patchset = options.patchset
4756 if not patchset:
4757 patchset = cl.GetMostRecentPatchset()
4758 if not patchset:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004759 parser.error('Code review host doesn\'t know about issue %s. '
tandrii221ab252016-10-06 08:12:04 -07004760 'No access to issue or wrong issue number?\n'
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004761 'Either upload first, or pass --patchset explicitly.' %
tandrii221ab252016-10-06 08:12:04 -07004762 cl.GetIssue())
4763
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004764 try:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004765 jobs = _fetch_tryjobs(cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004766 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004767 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004768 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004769 if options.json:
Edward Lemurbaaf6be2019-10-09 18:00:44 +00004770 write_json(options.json, jobs)
qyearsley53f48a12016-09-01 10:45:13 -07004771 else:
Quinten Yearsley777660f2020-03-04 23:37:06 +00004772 _print_tryjobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004773 return 0
4774
4775
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004776@subcommand.usage('[new upstream branch]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004777@metrics.collector.collect_metrics('git cl upstream')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004778def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004779 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004780 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004781 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004782 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004783
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004784 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004785 if args:
4786 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004787 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07004788 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004789 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07004790 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00004791
4792 # Clear configured merge-base, if there is one.
4793 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004794 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004795 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004796 return 0
4797
4798
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004799@metrics.collector.collect_metrics('git cl web')
thestig@chromium.org00858c82013-12-02 23:08:03 +00004800def CMDweb(parser, args):
4801 """Opens the current CL in the web browser."""
4802 _, args = parser.parse_args(args)
4803 if args:
4804 parser.error('Unrecognized args: %s' % ' '.join(args))
4805
4806 issue_url = Changelist().GetIssueURL()
4807 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07004808 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004809 return 1
4810
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004811 # Redirect I/O before invoking browser to hide its output. For example, this
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004812 # allows us to hide the "Created new window in existing browser session."
4813 # message from Chrome. Based on https://stackoverflow.com/a/2323563.
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004814 saved_stdout = os.dup(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004815 saved_stderr = os.dup(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004816 os.close(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004817 os.close(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00004818 os.open(os.devnull, os.O_RDWR)
4819 try:
4820 webbrowser.open(issue_url)
4821 finally:
4822 os.dup2(saved_stdout, 1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00004823 os.dup2(saved_stderr, 2)
thestig@chromium.org00858c82013-12-02 23:08:03 +00004824 return 0
4825
4826
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004827@metrics.collector.collect_metrics('git cl set-commit')
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004828def CMDset_commit(parser, args):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004829 """Sets the commit bit to trigger the CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004830 parser.add_option('-d', '--dry-run', action='store_true',
4831 help='trigger in dry run mode')
4832 parser.add_option('-c', '--clear', action='store_true',
4833 help='stop CQ run, if any')
Edward Lemur52969c92020-02-06 18:15:28 +00004834 parser.add_option(
4835 '-i', '--issue', type=int,
4836 help='Operate on this issue instead of the current branch\'s implicit '
4837 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004838 options, args = parser.parse_args(args)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004839 if args:
4840 parser.error('Unrecognized args: %s' % ' '.join(args))
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004841 if options.dry_run and options.clear:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004842 parser.error('Only one of --dry-run and --clear are allowed.')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004843
Edward Lemur934836a2019-09-09 20:16:54 +00004844 cl = Changelist(issue=options.issue)
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004845 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07004846 state = _CQState.NONE
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00004847 elif options.dry_run:
4848 state = _CQState.DRY_RUN
4849 else:
4850 state = _CQState.COMMIT
4851 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004852 parser.error('Must upload the issue first.')
tandrii9de9ec62016-07-13 03:01:59 -07004853 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00004854 return 0
4855
4856
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004857@metrics.collector.collect_metrics('git cl set-close')
groby@chromium.org411034a2013-02-26 15:12:01 +00004858def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004859 """Closes the issue."""
Edward Lemur52969c92020-02-06 18:15:28 +00004860 parser.add_option(
4861 '-i', '--issue', type=int,
4862 help='Operate on this issue instead of the current branch\'s implicit '
4863 'issue.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004864 options, args = parser.parse_args(args)
groby@chromium.org411034a2013-02-26 15:12:01 +00004865 if args:
4866 parser.error('Unrecognized args: %s' % ' '.join(args))
Edward Lemur934836a2019-09-09 20:16:54 +00004867 cl = Changelist(issue=options.issue)
groby@chromium.org411034a2013-02-26 15:12:01 +00004868 # Ensure there actually is an issue to close.
Aaron Gable7139a4e2017-09-05 17:53:09 -07004869 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004870 DieWithError('ERROR: No issue to close.')
groby@chromium.org411034a2013-02-26 15:12:01 +00004871 cl.CloseIssue()
4872 return 0
4873
4874
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004875@metrics.collector.collect_metrics('git cl diff')
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004876def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00004877 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07004878 parser.add_option(
4879 '--stat',
4880 action='store_true',
4881 dest='stat',
4882 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004883 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004884 if args:
4885 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00004886
Edward Lemur934836a2019-09-09 20:16:54 +00004887 cl = Changelist()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004888 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004889 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00004890 if not issue:
4891 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004892
Aaron Gablea718c3e2017-08-28 17:47:28 -07004893 base = cl._GitGetBranchConfigValue('last-upload-hash')
4894 if not base:
4895 base = cl._GitGetBranchConfigValue('gerritsquashhash')
4896 if not base:
4897 detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
4898 revision_info = detail['revisions'][detail['current_revision']]
4899 fetch_info = revision_info['fetch']['http']
4900 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
4901 base = 'FETCH_HEAD'
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004902
Aaron Gablea718c3e2017-08-28 17:47:28 -07004903 cmd = ['git', 'diff']
4904 if options.stat:
4905 cmd.append('--stat')
4906 cmd.append(base)
4907 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00004908
4909 return 0
4910
4911
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004912@metrics.collector.collect_metrics('git cl owners')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004913def CMDowners(parser, args):
Dirk Prankebf980882017-09-02 15:08:00 -07004914 """Finds potential owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004915 parser.add_option(
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004916 '--ignore-current',
4917 action='store_true',
4918 help='Ignore the CL\'s current reviewers and start from scratch.')
4919 parser.add_option(
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004920 '--ignore-self',
4921 action='store_true',
4922 help='Do not consider CL\'s author as an owners.')
4923 parser.add_option(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004924 '--no-color',
4925 action='store_true',
4926 help='Use this option to disable color output')
Dirk Prankebf980882017-09-02 15:08:00 -07004927 parser.add_option(
4928 '--batch',
4929 action='store_true',
4930 help='Do not run interactively, just suggest some')
Yang Guo6e269a02019-06-26 11:17:02 +00004931 # TODO: Consider moving this to another command, since other
4932 # git-cl owners commands deal with owners for a given CL.
4933 parser.add_option(
4934 '--show-all',
4935 action='store_true',
4936 help='Show all owners for a particular file')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004937 options, args = parser.parse_args(args)
4938
4939 author = RunGit(['config', 'user.email']).strip() or None
4940
Edward Lemur934836a2019-09-09 20:16:54 +00004941 cl = Changelist()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004942
Yang Guo6e269a02019-06-26 11:17:02 +00004943 if options.show_all:
4944 for arg in args:
4945 base_branch = cl.GetCommonAncestorWithUpstream()
Edward Lemurb7f759f2020-03-04 21:20:56 +00004946 database = owners.Database(settings.GetRoot(), open, os.path)
Yang Guo6e269a02019-06-26 11:17:02 +00004947 database.load_data_needed_for([arg])
4948 print('Owners for %s:' % arg)
4949 for owner in sorted(database.all_possible_owners([arg], None)):
4950 print(' - %s' % owner)
4951 return 0
4952
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004953 if args:
4954 if len(args) > 1:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004955 parser.error('Unknown args.')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004956 base_branch = args[0]
4957 else:
4958 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004959 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004960
Edward Lemur7f6dec02020-02-06 20:23:58 +00004961 change = cl.GetChange(base_branch)
Dirk Prankebf980882017-09-02 15:08:00 -07004962 affected_files = [f.LocalPath() for f in change.AffectedFiles()]
4963
4964 if options.batch:
Edward Lemurb7f759f2020-03-04 21:20:56 +00004965 db = owners.Database(change.RepositoryRoot(), open, os.path)
Dirk Prankebf980882017-09-02 15:08:00 -07004966 print('\n'.join(db.reviewers_for(affected_files, author)))
4967 return 0
4968
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004969 return owners_finder.OwnersFinder(
Dirk Prankebf980882017-09-02 15:08:00 -07004970 affected_files,
Jochen Eisinger72606f82017-04-04 10:44:18 +02004971 change.RepositoryRoot(),
Edward Lemur707d70b2018-02-07 00:50:14 +01004972 author,
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00004973 [] if options.ignore_current else cl.GetReviewers(),
Edward Lemurb7f759f2020-03-04 21:20:56 +00004974 fopen=open, os_path=os.path,
Jochen Eisingerd0573ec2017-04-13 10:55:06 +02004975 disable_color=options.no_color,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00004976 override_files=change.OriginalOwnersFiles(),
4977 ignore_author=options.ignore_self).run()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00004978
4979
Aiden Bennerc08566e2018-10-03 17:52:42 +00004980def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004981 """Generates a diff command."""
4982 # Generate diff for the current branch's changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +00004983 diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff']
4984
Aiden Benner6c18a1a2018-11-23 20:18:23 +00004985 if allow_prefix:
4986 # explicitly setting --src-prefix and --dst-prefix is necessary in the
4987 # case that diff.noprefix is set in the user's git config.
4988 diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/']
4989 else:
Aiden Bennerc08566e2018-10-03 17:52:42 +00004990 diff_cmd += ['--no-prefix']
4991
4992 diff_cmd += [diff_type, upstream_commit, '--']
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004993
4994 if args:
4995 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00004996 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00004997 diff_cmd.append(arg)
4998 else:
4999 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005000
5001 return diff_cmd
5002
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005003
Jamie Madill5e96ad12020-01-13 16:08:35 +00005004def _RunClangFormatDiff(opts, clang_diff_files, top_dir, upstream_commit):
5005 """Runs clang-format-diff and sets a return value if necessary."""
5006
5007 if not clang_diff_files:
5008 return 0
5009
5010 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
5011 # formatted. This is used to block during the presubmit.
5012 return_value = 0
5013
5014 # Locate the clang-format binary in the checkout
5015 try:
5016 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
5017 except clang_format.NotFoundError as e:
5018 DieWithError(e)
5019
5020 if opts.full or settings.GetFormatFullByDefault():
5021 cmd = [clang_format_tool]
5022 if not opts.dry_run and not opts.diff:
5023 cmd.append('-i')
5024 if opts.dry_run:
5025 for diff_file in clang_diff_files:
5026 with open(diff_file, 'r') as myfile:
5027 code = myfile.read().replace('\r\n', '\n')
5028 stdout = RunCommand(cmd + [diff_file], cwd=top_dir)
5029 stdout = stdout.replace('\r\n', '\n')
5030 if opts.diff:
5031 sys.stdout.write(stdout)
5032 if code != stdout:
5033 return_value = 2
5034 else:
5035 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
5036 if opts.diff:
5037 sys.stdout.write(stdout)
5038 else:
5039 env = os.environ.copy()
5040 env['PATH'] = str(os.path.dirname(clang_format_tool))
5041 try:
5042 script = clang_format.FindClangFormatScriptInChromiumTree(
5043 'clang-format-diff.py')
5044 except clang_format.NotFoundError as e:
5045 DieWithError(e)
5046
5047 cmd = [sys.executable, script, '-p0']
5048 if not opts.dry_run and not opts.diff:
5049 cmd.append('-i')
5050
5051 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
Edward Lemur1a83da12020-03-04 21:18:36 +00005052 diff_output = RunGit(diff_cmd).encode('utf-8')
Jamie Madill5e96ad12020-01-13 16:08:35 +00005053
5054 stdout = RunCommand(cmd, stdin=diff_output, cwd=top_dir, env=env)
5055 if opts.diff:
5056 sys.stdout.write(stdout)
5057 if opts.dry_run and len(stdout) > 0:
5058 return_value = 2
5059
5060 return return_value
5061
5062
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005063def MatchingFileType(file_name, extensions):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00005064 """Returns True if the file name ends with one of the given extensions."""
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005065 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005066
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005067
enne@chromium.org555cfe42014-01-29 18:21:39 +00005068@subcommand.usage('[files or directories to diff]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005069@metrics.collector.collect_metrics('git cl format')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005070def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005071 """Runs auto-formatting tools (clang-format etc.) on the diff."""
Christopher Lamc5ba6922017-01-24 11:19:14 +11005072 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07005073 GN_EXTS = ['.gn', '.gni', '.typemap']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005074 parser.add_option('--full', action='store_true',
5075 help='Reformat the full content of all touched files')
5076 parser.add_option('--dry-run', action='store_true',
5077 help='Don\'t modify any file on disk.')
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005078 parser.add_option(
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005079 '--no-clang-format',
5080 dest='clang_format',
5081 action='store_false',
5082 default=True,
5083 help='Disables formatting of various file types using clang-format.')
5084 parser.add_option(
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005085 '--python',
5086 action='store_true',
5087 default=None,
5088 help='Enables python formatting on all python files.')
5089 parser.add_option(
5090 '--no-python',
5091 action='store_true',
Garrett Beaty91a6f332020-01-06 16:57:24 +00005092 default=False,
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005093 help='Disables python formatting on all python files. '
Garrett Beaty91a6f332020-01-06 16:57:24 +00005094 'If neither --python or --no-python are set, python files that have a '
5095 '.style.yapf file in an ancestor directory will be formatted. '
5096 'It is an error to set both.')
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005097 parser.add_option(
5098 '--js',
5099 action='store_true',
5100 help='Format javascript code with clang-format. '
5101 'Has no effect if --no-clang-format is set.')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00005102 parser.add_option('--diff', action='store_true',
5103 help='Print diff to stdout rather than modifying files.')
Ilya Shermane081cbe2017-08-15 17:51:04 -07005104 parser.add_option('--presubmit', action='store_true',
5105 help='Used when running the script from a presubmit.')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005106 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005107
Garrett Beaty91a6f332020-01-06 16:57:24 +00005108 if opts.python is not None and opts.no_python:
5109 raise parser.error('Cannot set both --python and --no-python')
5110 if opts.no_python:
5111 opts.python = False
5112
Daniel Chengc55eecf2016-12-30 03:11:02 -08005113 # Normalize any remaining args against the current path, so paths relative to
5114 # the current directory are still resolved as expected.
5115 args = [os.path.join(os.getcwd(), arg) for arg in args]
5116
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005117 # git diff generates paths against the root of the repository. Change
5118 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005119 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005120 if rel_base_path:
5121 os.chdir(rel_base_path)
5122
digit@chromium.org29e47272013-05-17 17:01:46 +00005123 # Grab the merge-base commit, i.e. the upstream commit of the current
5124 # branch when it was created or the last time it was rebased. This is
5125 # to cover the case where the user may have called "git fetch origin",
5126 # moving the origin branch to a newer commit, but hasn't rebased yet.
5127 upstream_commit = None
5128 cl = Changelist()
5129 upstream_branch = cl.GetUpstreamBranch()
5130 if upstream_branch:
5131 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
5132 upstream_commit = upstream_commit.strip()
5133
5134 if not upstream_commit:
5135 DieWithError('Could not find base commit for this branch. '
5136 'Are you in detached state?')
5137
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005138 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5139 diff_output = RunGit(changed_files_cmd)
5140 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005141 # Filter out files deleted by this CL
5142 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005143
Andreas Haas417d89c2020-02-06 10:24:27 +00005144 if opts.js:
Deepanjan Roy605dd312018-07-02 17:48:54 +00005145 CLANG_EXTS.extend(['.js', '.ts'])
Christopher Lamc5ba6922017-01-24 11:19:14 +11005146
Garrett Beatyed0cc5f2020-01-06 17:26:13 +00005147 clang_diff_files = []
5148 if opts.clang_format:
5149 clang_diff_files = [
5150 x for x in diff_files if MatchingFileType(x, CLANG_EXTS)
5151 ]
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005152 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
5153 dart_diff_files = [x for x in diff_files if MatchingFileType(x, ['.dart'])]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005154 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005155
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005156 top_dir = os.path.normpath(
5157 RunGit(["rev-parse", "--show-toplevel"]).rstrip('\n'))
5158
Jamie Madill5e96ad12020-01-13 16:08:35 +00005159 return_value = _RunClangFormatDiff(opts, clang_diff_files, top_dir,
5160 upstream_commit)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005161
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005162 # Similar code to above, but using yapf on .py files rather than clang-format
5163 # on C/C++ files
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005164 py_explicitly_disabled = opts.python is not None and not opts.python
5165 if python_diff_files and not py_explicitly_disabled:
Aiden Bennere47ac152018-11-20 16:44:03 +00005166 depot_tools_path = os.path.dirname(os.path.abspath(__file__))
5167 yapf_tool = os.path.join(depot_tools_path, 'yapf')
5168 if sys.platform.startswith('win'):
5169 yapf_tool += '.bat'
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005170
Aiden Bennerc08566e2018-10-03 17:52:42 +00005171 # Used for caching.
5172 yapf_configs = {}
5173 for f in python_diff_files:
5174 # Find the yapf style config for the current file, defaults to depot
5175 # tools default.
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005176 _FindYapfConfigFile(f, yapf_configs, top_dir)
5177
5178 # Turn on python formatting by default if a yapf config is specified.
5179 # This breaks in the case of this repo though since the specified
5180 # style file is also the global default.
5181 if opts.python is None:
5182 filtered_py_files = []
5183 for f in python_diff_files:
5184 if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None:
5185 filtered_py_files.append(f)
5186 else:
5187 filtered_py_files = python_diff_files
5188
5189 # Note: yapf still seems to fix indentation of the entire file
5190 # even if line ranges are specified.
5191 # See https://github.com/google/yapf/issues/499
5192 if not opts.full and filtered_py_files:
5193 py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit)
5194
Brian Sheedyb4307d52019-12-02 19:18:17 +00005195 yapfignore_patterns = _GetYapfIgnorePatterns(top_dir)
5196 filtered_py_files = _FilterYapfIgnoredFiles(filtered_py_files,
5197 yapfignore_patterns)
Brian Sheedy59b06a82019-10-14 17:03:29 +00005198
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005199 for f in filtered_py_files:
Andrew Grievefa40bfa2020-01-07 02:32:57 +00005200 yapf_style = _FindYapfConfigFile(f, yapf_configs, top_dir)
5201 # Default to pep8 if not .style.yapf is found.
5202 if not yapf_style:
5203 yapf_style = 'pep8'
Aiden Bennerc08566e2018-10-03 17:52:42 +00005204
Andrew Grievefa40bfa2020-01-07 02:32:57 +00005205 cmd = [yapf_tool, '--style', yapf_style, f]
Aiden Bennerc08566e2018-10-03 17:52:42 +00005206
5207 has_formattable_lines = False
5208 if not opts.full:
5209 # Only run yapf over changed line ranges.
5210 for diff_start, diff_len in py_line_diffs[f]:
5211 diff_end = diff_start + diff_len - 1
5212 # Yapf errors out if diff_end < diff_start but this
5213 # is a valid line range diff for a removal.
5214 if diff_end >= diff_start:
5215 has_formattable_lines = True
5216 cmd += ['-l', '{}-{}'.format(diff_start, diff_end)]
5217 # If all line diffs were removals we have nothing to format.
5218 if not has_formattable_lines:
5219 continue
5220
5221 if opts.diff or opts.dry_run:
5222 cmd += ['--diff']
5223 # Will return non-zero exit code if non-empty diff.
5224 stdout = RunCommand(cmd, error_ok=True, cwd=top_dir)
5225 if opts.diff:
5226 sys.stdout.write(stdout)
5227 elif len(stdout) > 0:
5228 return_value = 2
5229 else:
5230 cmd += ['-i']
5231 RunCommand(cmd, cwd=top_dir)
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005232
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005233 # Dart's formatter does not have the nice property of only operating on
5234 # modified chunks, so hard code full.
5235 if dart_diff_files:
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005236 try:
5237 command = [dart_format.FindDartFmtToolInChromiumTree()]
5238 if not opts.dry_run and not opts.diff:
5239 command.append('-w')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005240 command.extend(dart_diff_files)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005241
ppi@chromium.org6593d932016-03-03 15:41:15 +00005242 stdout = RunCommand(command, cwd=top_dir)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005243 if opts.dry_run and stdout:
5244 return_value = 2
Jamie Madill5e96ad12020-01-13 16:08:35 +00005245 except dart_format.NotFoundError:
vapiera7fbd5a2016-06-16 09:17:49 -07005246 print('Warning: Unable to check Dart code formatting. Dart SDK not '
5247 'found in this checkout. Files in other languages are still '
5248 'formatted.')
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005249
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005250 # Format GN build files. Always run on full build files for canonical form.
5251 if gn_diff_files:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005252 cmd = ['gn', 'format']
brettw4b8ed592016-08-05 16:19:12 -07005253 if opts.dry_run or opts.diff:
5254 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005255 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005256 gn_ret = subprocess2.call(cmd + [gn_diff_file],
5257 shell=sys.platform == 'win32',
5258 cwd=top_dir)
5259 if opts.dry_run and gn_ret == 2:
5260 return_value = 2 # Not formatted.
5261 elif opts.diff and gn_ret == 2:
5262 # TODO this should compute and print the actual diff.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005263 print('This change has GN build file diff for ' + gn_diff_file)
brettw4b8ed592016-08-05 16:19:12 -07005264 elif gn_ret != 0:
5265 # For non-dry run cases (and non-2 return values for dry-run), a
5266 # nonzero error code indicates a failure, probably because the file
5267 # doesn't parse.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005268 DieWithError('gn format failed on ' + gn_diff_file +
5269 '\nTry running `gn format` on this file manually.')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005270
Ilya Shermane081cbe2017-08-15 17:51:04 -07005271 # Skip the metrics formatting from the global presubmit hook. These files have
5272 # a separate presubmit hook that issues an error if the files need formatting,
5273 # whereas the top-level presubmit script merely issues a warning. Formatting
5274 # these files is somewhat slow, so it's important not to duplicate the work.
5275 if not opts.presubmit:
5276 for xml_dir in GetDirtyMetricsDirs(diff_files):
5277 tool_dir = os.path.join(top_dir, xml_dir)
5278 cmd = [os.path.join(tool_dir, 'pretty_print.py'), '--non-interactive']
5279 if opts.dry_run or opts.diff:
5280 cmd.append('--diff')
Ilya Sherman235b70d2017-08-22 17:46:38 -07005281 stdout = RunCommand(cmd, cwd=top_dir)
Ilya Shermane081cbe2017-08-15 17:51:04 -07005282 if opts.diff:
5283 sys.stdout.write(stdout)
5284 if opts.dry_run and stdout:
5285 return_value = 2 # Not formatted.
Alexei Svitkinef3cac412017-02-06 11:08:50 -05005286
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005287 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005288
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005289
Steven Holte2e664bf2017-04-21 13:10:47 -07005290def GetDirtyMetricsDirs(diff_files):
5291 xml_diff_files = [x for x in diff_files if MatchingFileType(x, ['.xml'])]
5292 metrics_xml_dirs = [
5293 os.path.join('tools', 'metrics', 'actions'),
5294 os.path.join('tools', 'metrics', 'histograms'),
5295 os.path.join('tools', 'metrics', 'rappor'),
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005296 os.path.join('tools', 'metrics', 'ukm'),
5297 ]
Steven Holte2e664bf2017-04-21 13:10:47 -07005298 for xml_dir in metrics_xml_dirs:
5299 if any(file.startswith(xml_dir) for file in xml_diff_files):
5300 yield xml_dir
5301
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005302
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005303@subcommand.usage('<codereview url or issue id>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005304@metrics.collector.collect_metrics('git cl checkout')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005305def CMDcheckout(parser, args):
Edward Lemurf38bc172019-09-03 21:02:13 +00005306 """Checks out a branch associated with a given Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005307 _, args = parser.parse_args(args)
5308
5309 if len(args) != 1:
5310 parser.print_help()
5311 return 1
5312
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005313 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005314 if not issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005315 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02005316
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005317 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005318
Edward Lemur52969c92020-02-06 18:15:28 +00005319 issueprefix = Changelist.IssueConfigKey()
5320 output = RunGit(['config', '--local', '--get-regexp',
5321 r'branch\..*\.%s' % issueprefix],
5322 error_ok=True)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005323
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005324 branches = []
Edward Lemur52969c92020-02-06 18:15:28 +00005325 for key, issue in [x.split() for x in output.splitlines()]:
5326 if issue == target_issue:
5327 branches.append(re.sub(r'branch\.(.*)\.%s' % issueprefix, r'\1', key))
5328
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005329 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005330 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005331 return 1
5332 if len(branches) == 1:
5333 RunGit(['checkout', branches[0]])
5334 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005335 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005336 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005337 print('%d: %s' % (i, branches[i]))
Edward Lemur1a83da12020-03-04 21:18:36 +00005338 which = ask_for_data('Choose by index: ')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005339 try:
5340 RunGit(['checkout', branches[int(which)]])
5341 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005342 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005343 return 1
5344
5345 return 0
5346
5347
maruel@chromium.org29404b52014-09-08 22:58:00 +00005348def CMDlol(parser, args):
5349 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005350 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005351 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5352 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5353 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
vapiera7fbd5a2016-06-16 09:17:49 -07005354 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005355 return 0
5356
5357
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005358class OptionParser(optparse.OptionParser):
5359 """Creates the option parse and add --verbose support."""
5360 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005361 optparse.OptionParser.__init__(
5362 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005363 self.add_option(
5364 '-v', '--verbose', action='count', default=0,
5365 help='Use 2 times for more debugging info')
5366
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005367 def parse_args(self, args=None, _values=None):
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005368 try:
5369 return self._parse_args(args)
5370 finally:
5371 # Regardless of success or failure of args parsing, we want to report
5372 # metrics, but only after logging has been initialized (if parsing
5373 # succeeded).
5374 global settings
5375 settings = Settings()
5376
5377 if not metrics.DISABLE_METRICS_COLLECTION:
5378 # GetViewVCUrl ultimately calls logging method.
5379 project_url = settings.GetViewVCUrl().strip('/+')
5380 if project_url in metrics_utils.KNOWN_PROJECT_URLS:
5381 metrics.collector.add('project_urls', [project_url])
5382
5383 def _parse_args(self, args=None):
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005384 # Create an optparse.Values object that will store only the actual passed
5385 # options, without the defaults.
5386 actual_options = optparse.Values()
5387 _, args = optparse.OptionParser.parse_args(self, args, actual_options)
5388 # Create an optparse.Values object with the default options.
5389 options = optparse.Values(self.get_default_values().__dict__)
5390 # Update it with the options passed by the user.
5391 options._update_careful(actual_options.__dict__)
5392 # Store the options passed by the user in an _actual_options attribute.
5393 # We store only the keys, and not the values, since the values can contain
5394 # arbitrary information, which might be PII.
Edward Lemur79d4f992019-11-11 23:49:02 +00005395 metrics.collector.add('arguments', list(actual_options.__dict__.keys()))
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005396
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005397 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
Andrii Shyshkalov5b04a572017-01-23 17:44:41 +01005398 logging.basicConfig(
5399 level=levels[min(options.verbose, len(levels) - 1)],
5400 format='[%(levelname).1s%(asctime)s %(process)d %(thread)d '
5401 '%(filename)s] %(message)s')
Edward Lemur83bd7f42018-10-10 00:14:21 +00005402
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005403 return options, args
5404
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005405
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005406def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005407 if sys.hexversion < 0x02060000:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005408 print('\nYour Python version %s is unsupported, please upgrade.\n' %
vapiera7fbd5a2016-06-16 09:17:49 -07005409 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005410 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005411
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005412 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005413 dispatcher = subcommand.CommandDispatcher(__name__)
5414 try:
5415 return dispatcher.execute(OptionParser(), argv)
Edward Lemur5b929a42019-10-21 17:57:39 +00005416 except auth.LoginRequiredError as e:
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005417 DieWithError(str(e))
Edward Lemur79d4f992019-11-11 23:49:02 +00005418 except urllib.error.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005419 if e.code != 500:
5420 raise
5421 DieWithError(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005422 ('App Engine is misbehaving and returned HTTP %d, again. Keep faith '
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005423 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005424 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005425
5426
5427if __name__ == '__main__':
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005428 # These affect sys.stdout, so do it outside of main() to simplify mocks in
5429 # the unit tests.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005430 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005431 setup_color.init()
Edward Lemur6f812e12018-07-31 22:45:57 +00005432 with metrics.collector.print_notice_and_exit():
sbc@chromium.org013731e2015-02-26 18:28:43 +00005433 sys.exit(main(sys.argv[1:]))