blob: 91ef86cf61681bf63062598267f991dd3b9f7c36 [file] [log] [blame]
Edward Lesmes98eda3f2019-08-12 21:09:53 +00001#!/usr/bin/env python
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
calamity@chromium.orgffde55c2015-03-12 00:44:17 +000013from multiprocessing.pool import ThreadPool
thakis@chromium.org3421c992014-11-02 02:20:32 +000014import base64
rmistry@google.com2dd99862015-06-22 12:22:18 +000015import collections
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +010016import contextlib
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +010017import datetime
sheyang@google.com6ebaf782015-05-12 19:17:54 +000018import httplib
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +010019import itertools
maruel@chromium.org4f6852c2012-04-20 20:39:20 +000020import json
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000021import logging
calamity@chromium.orgcf197482016-04-29 20:15:53 +000022import multiprocessing
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000023import optparse
24import os
25import re
Andrii Shyshkalov353637c2017-03-14 16:52:18 +010026import shutil
ukai@chromium.org78c4b982012-02-14 02:20:26 +000027import stat
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000028import sys
Aaron Gable9a03ae02017-11-03 11:31:07 -070029import tempfile
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000030import textwrap
Edward Lemurfec80c42018-11-01 23:14:14 +000031import time
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000032import urllib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000033import urllib2
maruel@chromium.org967c0a82013-06-17 22:52:24 +000034import urlparse
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +000035import uuid
thestig@chromium.org00858c82013-12-02 23:08:03 +000036import webbrowser
thakis@chromium.org3421c992014-11-02 02:20:32 +000037import zlib
chase@chromium.orgcc51cd02010-12-23 00:48:39 +000038
maruel@chromium.org2e23ce32013-05-07 12:42:28 +000039from third_party import colorama
sheyang@google.com6ebaf782015-05-12 19:17:54 +000040from third_party import httplib2
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +000041import auth
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +000042import clang_format
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +000043import dart_format
maruel@chromium.org6f09cd92011-04-01 16:38:12 +000044import fix_encoding
maruel@chromium.org0e0436a2011-10-25 13:32:41 +000045import gclient_utils
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +000046import gerrit_util
iannucci@chromium.org9e849272014-04-04 00:31:55 +000047import git_common
tandrii@chromium.org09d7a6a2016-03-04 15:44:48 +000048import git_footers
Edward Lemur5ba1e9c2018-07-23 18:19:02 +000049import metrics
Edward Lesmes93277a72018-10-18 22:04:26 +000050import metrics_utils
piman@chromium.org336f9122014-09-04 02:16:55 +000051import owners
iannucci@chromium.org9e849272014-04-04 00:31:55 +000052import owners_finder
maruel@chromium.org2a74d372011-03-29 19:05:50 +000053import presubmit_support
54import scm
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +000055import setup_color
Francois Dorayd42c6812017-05-30 15:10:20 -040056import split_cl
maruel@chromium.org0633fb42013-08-16 20:06:14 +000057import subcommand
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +000058import subprocess2
maruel@chromium.org2a74d372011-03-29 19:05:50 +000059import watchlists
60
tandrii7400cf02016-06-21 08:48:07 -070061__version__ = '2.0'
maruel@chromium.org2a74d372011-03-29 19:05:50 +000062
Edward Lemur0f58ae42019-04-30 17:24:12 +000063# Traces for git push will be stored in a traces directory inside the
64# depot_tools checkout.
65DEPOT_TOOLS = os.path.dirname(os.path.abspath(__file__))
66TRACES_DIR = os.path.join(DEPOT_TOOLS, 'traces')
67
68# When collecting traces, Git hashes will be reduced to 6 characters to reduce
69# the size after compression.
70GIT_HASH_RE = re.compile(r'\b([a-f0-9]{6})[a-f0-9]{34}\b', flags=re.I)
71# Used to redact the cookies from the gitcookies file.
72GITCOOKIES_REDACT_RE = re.compile(r'1/.*')
73
Edward Lemur1b52d872019-05-09 21:12:12 +000074# The maximum number of traces we will keep. Multiplied by 3 since we store
75# 3 files per trace.
76MAX_TRACES = 3 * 10
Edward Lemur5737f022019-05-17 01:24:00 +000077# Message to be displayed to the user to inform where to find the traces for a
78# git-cl upload execution.
Edward Lemur0f58ae42019-04-30 17:24:12 +000079TRACES_MESSAGE = (
Edward Lemur1b52d872019-05-09 21:12:12 +000080'\n'
Edward Lemur5737f022019-05-17 01:24:00 +000081'The traces of this git-cl execution have been recorded at:\n'
Edward Lemur1b52d872019-05-09 21:12:12 +000082' %(trace_name)s-traces.zip\n'
Edward Lemur5737f022019-05-17 01:24:00 +000083'Copies of your gitcookies file and git config have been recorded at:\n'
84' %(trace_name)s-git-info.zip\n')
Edward Lemur1b52d872019-05-09 21:12:12 +000085# Format of the message to be stored as part of the traces to give developers a
86# better context when they go through traces.
87TRACES_README_FORMAT = (
88'Date: %(now)s\n'
89'\n'
90'Change: https://%(gerrit_host)s/q/%(change_id)s\n'
91'Title: %(title)s\n'
92'\n'
93'%(description)s\n'
94'\n'
95'Execution time: %(execution_time)s\n'
96'Exit code: %(exit_code)s\n') + TRACES_MESSAGE
Edward Lemur0f58ae42019-04-30 17:24:12 +000097
tandrii9d2c7a32016-06-22 03:42:45 -070098COMMIT_BOT_EMAIL = 'commit-bot@chromium.org'
Aaron Gable1bc7bfe2016-12-19 10:08:14 -080099POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000100DESCRIPTION_BACKUP_FILE = '~/.git_cl_description_backup'
rmistry@google.comc68112d2015-03-03 12:48:06 +0000101REFS_THAT_ALIAS_TO_OTHER_REFS = {
102 'refs/remotes/origin/lkgr': 'refs/remotes/origin/master',
103 'refs/remotes/origin/lkcr': 'refs/remotes/origin/master',
104}
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000105
thestig@chromium.org44202a22014-03-11 19:22:18 +0000106# Valid extensions for files we want to lint.
107DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)"
108DEFAULT_LINT_IGNORE_REGEX = r"$^"
109
Aiden Bennerc08566e2018-10-03 17:52:42 +0000110# File name for yapf style config files.
111YAPF_CONFIG_FILENAME = '.style.yapf'
112
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000113# Shortcut since it quickly becomes repetitive.
maruel@chromium.org2e23ce32013-05-07 12:42:28 +0000114Fore = colorama.Fore
maruel@chromium.org90541732011-04-01 17:54:18 +0000115
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000116# Initialized in main()
117settings = None
118
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100119# Used by tests/git_cl_test.py to add extra logging.
120# Inside the weirdly failing test, add this:
121# >>> self.mock(git_cl, '_IS_BEING_TESTED', True)
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700122# And scroll up to see the stack trace printed.
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +0100123_IS_BEING_TESTED = False
124
maruel@chromium.orgddd59412011-11-30 14:20:38 +0000125
Christopher Lamf732cd52017-01-24 12:40:11 +1100126def DieWithError(message, change_desc=None):
127 if change_desc:
128 SaveDescriptionBackup(change_desc)
129
vapiera7fbd5a2016-06-16 09:17:49 -0700130 print(message, file=sys.stderr)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000131 sys.exit(1)
132
133
Christopher Lamf732cd52017-01-24 12:40:11 +1100134def SaveDescriptionBackup(change_desc):
135 backup_path = os.path.expanduser(DESCRIPTION_BACKUP_FILE)
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +0000136 print('\nsaving CL description to %s\n' % backup_path)
Christopher Lamf732cd52017-01-24 12:40:11 +1100137 backup_file = open(backup_path, 'w')
138 backup_file.write(change_desc.description)
139 backup_file.close()
140
141
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000142def GetNoGitPagerEnv():
143 env = os.environ.copy()
144 # 'cat' is a magical git string that disables pagers on all platforms.
145 env['GIT_PAGER'] = 'cat'
146 return env
147
vadimsh@chromium.org566a02a2014-08-22 01:34:13 +0000148
bsep@chromium.org627d9002016-04-29 00:00:52 +0000149def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000150 try:
bsep@chromium.org627d9002016-04-29 00:00:52 +0000151 return subprocess2.check_output(args, shell=shell, **kwargs)
maruel@chromium.org78936cb2013-04-11 00:17:52 +0000152 except subprocess2.CalledProcessError as e:
153 logging.debug('Failed running %s', args)
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000154 if not error_ok:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000155 DieWithError(
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000156 'Command "%s" failed.\n%s' % (
157 ' '.join(args), error_message or e.stdout or ''))
158 return e.stdout
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000159
160
161def RunGit(args, **kwargs):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000162 """Returns stdout."""
bratell@opera.com82b91cd2013-07-09 06:33:41 +0000163 return RunCommand(['git'] + args, **kwargs)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000164
165
enne@chromium.org3b7e15c2014-01-21 17:44:47 +0000166def RunGitWithCode(args, suppress_stderr=False):
maruel@chromium.org32f9f5e2011-09-14 13:41:47 +0000167 """Returns return code and stdout."""
tandrii5d48c322016-08-18 16:19:37 -0700168 if suppress_stderr:
169 stderr = subprocess2.VOID
170 else:
171 stderr = sys.stderr
szager@chromium.org9bb85e22012-06-13 20:28:23 +0000172 try:
tandrii5d48c322016-08-18 16:19:37 -0700173 (out, _), code = subprocess2.communicate(['git'] + args,
174 env=GetNoGitPagerEnv(),
175 stdout=subprocess2.PIPE,
176 stderr=stderr)
177 return code, out
178 except subprocess2.CalledProcessError as e:
Yoshisato Yanagisawa81e3ff52017-09-26 15:33:34 +0900179 logging.debug('Failed running %s', ['git'] + args)
tandrii5d48c322016-08-18 16:19:37 -0700180 return e.returncode, e.stdout
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000181
182
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000183def RunGitSilent(args):
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +0000184 """Returns stdout, suppresses stderr and ignores the return code."""
bauerb@chromium.org27386dd2015-02-16 10:45:39 +0000185 return RunGitWithCode(args, suppress_stderr=True)[1]
186
187
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000188def IsGitVersionAtLeast(min_version):
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000189 prefix = 'git version '
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000190 version = RunGit(['--version']).strip()
ilevy@chromium.orgcc56ee42013-07-10 22:16:29 +0000191 return (version.startswith(prefix) and
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000192 LooseVersion(version[len(prefix):]) >= LooseVersion(min_version))
tapted@chromium.org6a0b07c2013-07-10 01:29:19 +0000193
194
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +0000195def BranchExists(branch):
196 """Return True if specified branch exists."""
197 code, _ = RunGitWithCode(['rev-parse', '--verify', branch],
198 suppress_stderr=True)
199 return not code
200
201
tandrii2a16b952016-10-19 07:09:44 -0700202def time_sleep(seconds):
203 # Use this so that it can be mocked in tests without interfering with python
204 # system machinery.
tandrii2a16b952016-10-19 07:09:44 -0700205 return time.sleep(seconds)
206
207
Edward Lemur01f4a4f2018-11-03 00:40:38 +0000208def time_time():
209 # Use this so that it can be mocked in tests without interfering with python
210 # system machinery.
211 return time.time()
212
213
Edward Lemur1b52d872019-05-09 21:12:12 +0000214def datetime_now():
215 # Use this so that it can be mocked in tests without interfering with python
216 # system machinery.
217 return datetime.datetime.now()
218
219
maruel@chromium.org90541732011-04-01 17:54:18 +0000220def ask_for_data(prompt):
221 try:
222 return raw_input(prompt)
223 except KeyboardInterrupt:
224 # Hide the exception.
225 sys.exit(1)
226
227
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100228def confirm_or_exit(prefix='', action='confirm'):
229 """Asks user to press enter to continue or press Ctrl+C to abort."""
230 if not prefix or prefix.endswith('\n'):
231 mid = 'Press'
Andrii Shyshkalov353637c2017-03-14 16:52:18 +0100232 elif prefix.endswith('.') or prefix.endswith('?'):
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100233 mid = ' Press'
234 elif prefix.endswith(' '):
235 mid = 'press'
236 else:
237 mid = ' press'
238 ask_for_data('%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action))
239
240
241def ask_for_explicit_yes(prompt):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000242 """Returns whether user typed 'y' or 'yes' to confirm the given prompt."""
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +0100243 result = ask_for_data(prompt + ' [Yes/No]: ').lower()
244 while True:
245 if 'yes'.startswith(result):
246 return True
247 if 'no'.startswith(result):
248 return False
249 result = ask_for_data('Please, type yes or no: ').lower()
250
251
tandrii5d48c322016-08-18 16:19:37 -0700252def _git_branch_config_key(branch, key):
253 """Helper method to return Git config key for a branch."""
254 assert branch, 'branch name is required to set git config for it'
255 return 'branch.%s.%s' % (branch, key)
256
257
258def _git_get_branch_config_value(key, default=None, value_type=str,
259 branch=False):
260 """Returns git config value of given or current branch if any.
261
262 Returns default in all other cases.
263 """
264 assert value_type in (int, str, bool)
265 if branch is False: # Distinguishing default arg value from None.
266 branch = GetCurrentBranch()
267
rogerta@chromium.orgcaa16552013-03-18 20:45:05 +0000268 if not branch:
tandrii5d48c322016-08-18 16:19:37 -0700269 return default
rogerta@chromium.orgcaa16552013-03-18 20:45:05 +0000270
tandrii5d48c322016-08-18 16:19:37 -0700271 args = ['config']
tandrii33a46ff2016-08-23 05:53:40 -0700272 if value_type == bool:
tandrii5d48c322016-08-18 16:19:37 -0700273 args.append('--bool')
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000274 # `git config` also has --int, but apparently git config suffers from integer
tandrii33a46ff2016-08-23 05:53:40 -0700275 # overflows (http://crbug.com/640115), so don't use it.
tandrii5d48c322016-08-18 16:19:37 -0700276 args.append(_git_branch_config_key(branch, key))
277 code, out = RunGitWithCode(args)
278 if code == 0:
279 value = out.strip()
280 if value_type == int:
281 return int(value)
282 if value_type == bool:
283 return bool(value.lower() == 'true')
284 return value
iannucci@chromium.org79540052012-10-19 23:15:26 +0000285 return default
286
287
tandrii5d48c322016-08-18 16:19:37 -0700288def _git_set_branch_config_value(key, value, branch=None, **kwargs):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000289 """Sets or unsets the git branch config value.
tandrii5d48c322016-08-18 16:19:37 -0700290
Quinten Yearsleyd242ed72019-07-25 17:17:55 +0000291 If value is None, the key will be unset, otherwise it will be set.
292 If no branch is given, the currently checked out branch is used.
tandrii5d48c322016-08-18 16:19:37 -0700293 """
294 if not branch:
295 branch = GetCurrentBranch()
296 assert branch, 'a branch name OR currently checked out branch is required'
297 args = ['config']
qyearsley12fa6ff2016-08-24 09:18:40 -0700298 # Check for boolean first, because bool is int, but int is not bool.
tandrii5d48c322016-08-18 16:19:37 -0700299 if value is None:
300 args.append('--unset')
301 elif isinstance(value, bool):
302 args.append('--bool')
303 value = str(value).lower()
tandrii5d48c322016-08-18 16:19:37 -0700304 else:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000305 # `git config` also has --int, but apparently git config suffers from
306 # integer overflows (http://crbug.com/640115), so don't use it.
tandrii5d48c322016-08-18 16:19:37 -0700307 value = str(value)
308 args.append(_git_branch_config_key(branch, key))
309 if value is not None:
310 args.append(value)
311 RunGit(args, **kwargs)
312
313
Andrii Shyshkalova6695812016-12-06 17:47:09 +0100314def _get_committer_timestamp(commit):
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700315 """Returns Unix timestamp as integer of a committer in a commit.
Andrii Shyshkalova6695812016-12-06 17:47:09 +0100316
317 Commit can be whatever git show would recognize, such as HEAD, sha1 or ref.
318 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000319 # Git also stores timezone offset, but it only affects visual display;
Andrii Shyshkalova6695812016-12-06 17:47:09 +0100320 # actual point in time is defined by this timestamp only.
321 return int(RunGit(['show', '-s', '--format=%ct', commit]).strip())
322
323
324def _git_amend_head(message, committer_timestamp):
325 """Amends commit with new message and desired committer_timestamp.
326
327 Sets committer timezone to UTC.
328 """
329 env = os.environ.copy()
330 env['GIT_COMMITTER_DATE'] = '%d+0000' % committer_timestamp
331 return RunGit(['commit', '--amend', '-m', message], env=env)
332
333
machenbach@chromium.org45453142015-09-15 08:45:22 +0000334def _get_properties_from_options(options):
335 properties = dict(x.split('=', 1) for x in options.properties)
336 for key, val in properties.iteritems():
337 try:
338 properties[key] = json.loads(val)
339 except ValueError:
340 pass # If a value couldn't be evaluated, treat it as a string.
341 return properties
342
343
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000344def _buildbucket_retry(operation_name, http, *args, **kwargs):
345 """Retries requests to buildbucket service and returns parsed json content."""
346 try_count = 0
347 while True:
348 response, content = http.request(*args, **kwargs)
349 try:
350 content_json = json.loads(content)
351 except ValueError:
352 content_json = None
353
354 # Buildbucket could return an error even if status==200.
355 if content_json and content_json.get('error'):
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000356 error = content_json.get('error')
357 if error.get('code') == 403:
358 raise BuildbucketResponseException(
359 'Access denied: %s' % error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000360 msg = 'Error in response. Reason: %s. Message: %s.' % (
nodir@chromium.orgbaff4e12016-03-08 00:33:57 +0000361 error.get('reason', ''), error.get('message', ''))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000362 raise BuildbucketResponseException(msg)
363
364 if response.status == 200:
Nodir Turakulov23d75d22018-06-04 12:37:32 -0700365 if content_json is None:
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000366 raise BuildbucketResponseException(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000367 'Buildbucket returned invalid JSON content: %s.\n'
Nodir Turakulov9ac59792018-06-04 12:34:14 -0700368 'Please file bugs at http://crbug.com, '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000369 'component "Infra>Platform>Buildbucket".' %
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000370 content)
371 return content_json
372 if response.status < 500 or try_count >= 2:
373 raise httplib2.HttpLib2Error(content)
374
375 # status >= 500 means transient failures.
376 logging.debug('Transient errors when %s. Will retry.', operation_name)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000377 time_sleep(0.5 + (1.5 * try_count))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000378 try_count += 1
379 assert False, 'unreachable'
380
381
qyearsley1fdfcb62016-10-24 13:22:03 -0700382def _get_bucket_map(changelist, options, option_parser):
qyearsleydd49f942016-10-28 11:57:22 -0700383 """Returns a dict mapping bucket names to builders and tests,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000384 for triggering tryjobs.
qyearsley1fdfcb62016-10-24 13:22:03 -0700385 """
qyearsleydd49f942016-10-28 11:57:22 -0700386 # If no bots are listed, we try to get a set of builders and tests based
387 # on GetPreferredTryMasters functions in PRESUBMIT.py files.
qyearsley1fdfcb62016-10-24 13:22:03 -0700388 if not options.bot:
389 change = changelist.GetChange(
390 changelist.GetCommonAncestorWithUpstream(), None)
qyearsley136b49f2016-10-31 09:02:26 -0700391 # Get try masters from PRESUBMIT.py files.
nodire4f0fe02016-11-04 16:23:30 -0700392 masters = presubmit_support.DoGetTryMasters(
qyearsley1fdfcb62016-10-24 13:22:03 -0700393 change=change,
394 changed_files=change.LocalPaths(),
395 repository_root=settings.GetRoot(),
396 default_presubmit=None,
397 project=None,
398 verbose=options.verbose,
399 output_stream=sys.stdout)
nodire4f0fe02016-11-04 16:23:30 -0700400 if masters is None:
401 return None
Edward Lemurc8b67ed2019-09-12 20:28:58 +0000402 return {m: b for m, b in masters.iteritems()}
qyearsley1fdfcb62016-10-24 13:22:03 -0700403
qyearsley1fdfcb62016-10-24 13:22:03 -0700404 if options.bucket:
405 return {options.bucket: {b: [] for b in options.bot}}
Andrii Shyshkalov75424372019-08-30 22:48:15 +0000406 option_parser.error(
407 'Please specify the bucket, e.g. "-B luci.chromium.try".')
qyearsley1fdfcb62016-10-24 13:22:03 -0700408
409
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -0800410def _trigger_try_jobs(auth_config, changelist, buckets, options, patchset):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000411 """Sends a request to Buildbucket to trigger tryjobs for a changelist.
qyearsley1fdfcb62016-10-24 13:22:03 -0700412
413 Args:
Aaron Gablefb28d482018-04-02 13:08:06 -0700414 auth_config: AuthConfig for Buildbucket.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000415 changelist: Changelist that the tryjobs are associated with.
qyearsley1fdfcb62016-10-24 13:22:03 -0700416 buckets: A nested dict mapping bucket names to builders to tests.
417 options: Command-line options.
418 """
tandriide281ae2016-10-12 06:02:30 -0700419 assert changelist.GetIssue(), 'CL must be uploaded first'
420 codereview_url = changelist.GetCodereviewServer()
421 assert codereview_url, 'CL must be uploaded first'
422 patchset = patchset or changelist.GetMostRecentPatchset()
423 assert patchset, 'CL must be uploaded first'
424
425 codereview_host = urlparse.urlparse(codereview_url).hostname
Aaron Gablefb28d482018-04-02 13:08:06 -0700426 # Cache the buildbucket credentials under the codereview host key, so that
427 # users can use different credentials for different buckets.
tandriide281ae2016-10-12 06:02:30 -0700428 authenticator = auth.get_authenticator_for_host(codereview_host, auth_config)
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000429 http = authenticator.authorize(httplib2.Http())
430 http.force_exception_to_status_code = True
tandriide281ae2016-10-12 06:02:30 -0700431
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000432 buildbucket_put_url = (
433 'https://{hostname}/_ah/api/buildbucket/v1/builds/batch'.format(
sheyang@chromium.orgdb375572015-08-17 19:22:23 +0000434 hostname=options.buildbucket_host))
Andrii Shyshkalov03da1502018-10-15 03:42:34 +0000435 buildset = 'patch/gerrit/{hostname}/{issue}/{patch}'.format(
tandriide281ae2016-10-12 06:02:30 -0700436 hostname=codereview_host,
437 issue=changelist.GetIssue(),
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000438 patch=patchset)
tandrii8c5a3532016-11-04 07:52:02 -0700439
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700440 shared_parameters_properties = changelist.GetTryJobProperties(patchset)
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -0800441 shared_parameters_properties['category'] = options.category
tandrii8c5a3532016-11-04 07:52:02 -0700442 if options.clobber:
443 shared_parameters_properties['clobber'] = True
tandriide281ae2016-10-12 06:02:30 -0700444 extra_properties = _get_properties_from_options(options)
tandrii8c5a3532016-11-04 07:52:02 -0700445 if extra_properties:
446 shared_parameters_properties.update(extra_properties)
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000447
448 batch_req_body = {'builds': []}
449 print_text = []
450 print_text.append('Tried jobs on:')
borenet6c0efe62016-10-19 08:13:29 -0700451 for bucket, builders_and_tests in sorted(buckets.iteritems()):
452 print_text.append('Bucket: %s' % bucket)
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000453 for builder, tests in sorted(builders_and_tests.iteritems()):
454 print_text.append(' %s: %s' % (builder, tests))
455 parameters = {
456 'builder_name': builder,
nodir@chromium.orgd2217312015-09-21 15:51:21 +0000457 'changes': [{
Andrii Shyshkaloveadad922017-01-26 09:38:30 +0100458 'author': {'email': changelist.GetIssueOwner()},
nodir@chromium.orgd2217312015-09-21 15:51:21 +0000459 'revision': options.revision,
460 }],
tandrii8c5a3532016-11-04 07:52:02 -0700461 'properties': shared_parameters_properties.copy(),
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000462 }
machenbach@chromium.org2403e802016-04-29 12:34:42 +0000463 if 'presubmit' in builder.lower():
464 parameters['properties']['dry_run'] = 'true'
tandrii@chromium.org3764fa22015-10-21 16:40:40 +0000465 if tests:
466 parameters['properties']['testfilter'] = tests
borenet6c0efe62016-10-19 08:13:29 -0700467
468 tags = [
469 'builder:%s' % builder,
470 'buildset:%s' % buildset,
471 'user_agent:git_cl_try',
472 ]
borenet6c0efe62016-10-19 08:13:29 -0700473
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000474 batch_req_body['builds'].append(
475 {
476 'bucket': bucket,
477 'parameters_json': json.dumps(parameters),
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000478 'client_operation_id': str(uuid.uuid4()),
borenet6c0efe62016-10-19 08:13:29 -0700479 'tags': tags,
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000480 }
481 )
482
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000483 _buildbucket_retry(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000484 'triggering tryjobs',
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000485 http,
486 buildbucket_put_url,
487 'PUT',
488 body=json.dumps(batch_req_body),
489 headers={'Content-Type': 'application/json'}
490 )
tandrii@chromium.org35c61452016-02-26 15:24:57 +0000491 print_text.append('To see results here, run: git cl try-results')
492 print_text.append('To see results in browser, run: git cl web')
vapiera7fbd5a2016-06-16 09:17:49 -0700493 print('\n'.join(print_text))
kjellander@chromium.org44424542015-06-02 18:35:29 +0000494
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000495
tandrii221ab252016-10-06 08:12:04 -0700496def fetch_try_jobs(auth_config, changelist, buildbucket_host,
497 patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000498 """Fetches tryjobs from buildbucket.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000499
qyearsley53f48a12016-09-01 10:45:13 -0700500 Returns a map from build id to build info as a dictionary.
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000501 """
tandrii221ab252016-10-06 08:12:04 -0700502 assert buildbucket_host
503 assert changelist.GetIssue(), 'CL must be uploaded first'
504 assert changelist.GetCodereviewServer(), 'CL must be uploaded first'
505 patchset = patchset or changelist.GetMostRecentPatchset()
506 assert patchset, 'CL must be uploaded first'
507
508 codereview_url = changelist.GetCodereviewServer()
509 codereview_host = urlparse.urlparse(codereview_url).hostname
510 authenticator = auth.get_authenticator_for_host(codereview_host, auth_config)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000511 if authenticator.has_cached_credentials():
512 http = authenticator.authorize(httplib2.Http())
513 else:
vapiera7fbd5a2016-06-16 09:17:49 -0700514 print('Warning: Some results might be missing because %s' %
515 # Get the message on how to login.
tandrii221ab252016-10-06 08:12:04 -0700516 (auth.LoginRequiredError(codereview_host).message,))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000517 http = httplib2.Http()
518
519 http.force_exception_to_status_code = True
520
Andrii Shyshkalov03da1502018-10-15 03:42:34 +0000521 buildset = 'patch/gerrit/{hostname}/{issue}/{patch}'.format(
tandrii221ab252016-10-06 08:12:04 -0700522 hostname=codereview_host,
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000523 issue=changelist.GetIssue(),
tandrii221ab252016-10-06 08:12:04 -0700524 patch=patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000525 params = {'tag': 'buildset:%s' % buildset}
526
527 builds = {}
528 while True:
529 url = 'https://{hostname}/_ah/api/buildbucket/v1/search?{params}'.format(
tandrii221ab252016-10-06 08:12:04 -0700530 hostname=buildbucket_host,
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000531 params=urllib.urlencode(params))
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000532 content = _buildbucket_retry('fetching tryjobs', http, url, 'GET')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000533 for build in content.get('builds', []):
534 builds[build['id']] = build
535 if 'next_cursor' in content:
536 params['start_cursor'] = content['next_cursor']
537 else:
538 break
539 return builds
540
541
qyearsleyeab3c042016-08-24 09:18:28 -0700542def print_try_jobs(options, builds):
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000543 """Prints nicely result of fetch_try_jobs."""
544 if not builds:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000545 print('No tryjobs scheduled.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000546 return
547
548 # Make a copy, because we'll be modifying builds dictionary.
549 builds = builds.copy()
550 builder_names_cache = {}
551
552 def get_builder(b):
553 try:
554 return builder_names_cache[b['id']]
555 except KeyError:
556 try:
557 parameters = json.loads(b['parameters_json'])
558 name = parameters['builder_name']
559 except (ValueError, KeyError) as error:
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700560 print('WARNING: Failed to get builder name for build %s: %s' % (
vapiera7fbd5a2016-06-16 09:17:49 -0700561 b['id'], error))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000562 name = None
563 builder_names_cache[b['id']] = name
564 return name
565
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000566 if options.print_master:
567 name_fmt = '%%-%ds %%-%ds' % (
Edward Lemurc8b67ed2019-09-12 20:28:58 +0000568 max(len(str(b['bucket'])) for b in builds.itervalues()),
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000569 max(len(str(get_builder(b))) for b in builds.itervalues()))
570 def get_name(b):
Edward Lemurc8b67ed2019-09-12 20:28:58 +0000571 return name_fmt % (b['bucket'], get_builder(b))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000572 else:
573 name_fmt = '%%-%ds' % (
574 max(len(str(get_builder(b))) for b in builds.itervalues()))
575 def get_name(b):
576 return name_fmt % get_builder(b)
577
578 def sort_key(b):
579 return b['status'], b.get('result'), get_name(b), b.get('url')
580
581 def pop(title, f, color=None, **kwargs):
582 """Pop matching builds from `builds` dict and print them."""
583
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +0000584 if not options.color or color is None:
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000585 colorize = str
586 else:
587 colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET)
588
589 result = []
590 for b in builds.values():
591 if all(b.get(k) == v for k, v in kwargs.iteritems()):
592 builds.pop(b['id'])
593 result.append(b)
594 if result:
vapiera7fbd5a2016-06-16 09:17:49 -0700595 print(colorize(title))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000596 for b in sorted(result, key=sort_key):
vapiera7fbd5a2016-06-16 09:17:49 -0700597 print(' ', colorize('\t'.join(map(str, f(b)))))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000598
599 total = len(builds)
600 pop(status='COMPLETED', result='SUCCESS',
601 title='Successes:', color=Fore.GREEN,
602 f=lambda b: (get_name(b), b.get('url')))
603 pop(status='COMPLETED', result='FAILURE', failure_reason='INFRA_FAILURE',
604 title='Infra Failures:', color=Fore.MAGENTA,
605 f=lambda b: (get_name(b), b.get('url')))
606 pop(status='COMPLETED', result='FAILURE', failure_reason='BUILD_FAILURE',
607 title='Failures:', color=Fore.RED,
608 f=lambda b: (get_name(b), b.get('url')))
609 pop(status='COMPLETED', result='CANCELED',
610 title='Canceled:', color=Fore.MAGENTA,
611 f=lambda b: (get_name(b),))
612 pop(status='COMPLETED', result='FAILURE',
613 failure_reason='INVALID_BUILD_DEFINITION',
614 title='Wrong master/builder name:', color=Fore.MAGENTA,
615 f=lambda b: (get_name(b),))
616 pop(status='COMPLETED', result='FAILURE',
617 title='Other failures:',
618 f=lambda b: (get_name(b), b.get('failure_reason'), b.get('url')))
619 pop(status='COMPLETED',
620 title='Other finished:',
621 f=lambda b: (get_name(b), b.get('result'), b.get('url')))
622 pop(status='STARTED',
623 title='Started:', color=Fore.YELLOW,
624 f=lambda b: (get_name(b), b.get('url')))
625 pop(status='SCHEDULED',
626 title='Scheduled:',
627 f=lambda b: (get_name(b), 'id=%s' % b['id']))
628 # The last section is just in case buildbucket API changes OR there is a bug.
629 pop(title='Other:',
630 f=lambda b: (get_name(b), 'id=%s' % b['id']))
631 assert len(builds) == 0
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000632 print('Total: %d tryjobs' % total)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +0000633
634
Aiden Bennerc08566e2018-10-03 17:52:42 +0000635def _ComputeDiffLineRanges(files, upstream_commit):
636 """Gets the changed line ranges for each file since upstream_commit.
637
638 Parses a git diff on provided files and returns a dict that maps a file name
639 to an ordered list of range tuples in the form (start_line, count).
640 Ranges are in the same format as a git diff.
641 """
642 # If files is empty then diff_output will be a full diff.
643 if len(files) == 0:
644 return {}
645
Aiden Benner6c18a1a2018-11-23 20:18:23 +0000646 # Take the git diff and find the line ranges where there are changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000647 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True)
648 diff_output = RunGit(diff_cmd)
649
650 pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)'
651 # 2 capture groups
652 # 0 == fname of diff file
653 # 1 == 'diff_start,diff_count' or 'diff_start'
654 # will match each of
655 # diff --git a/foo.foo b/foo.py
656 # @@ -12,2 +14,3 @@
657 # @@ -12,2 +17 @@
658 # running re.findall on the above string with pattern will give
659 # [('foo.py', ''), ('', '14,3'), ('', '17')]
660
661 curr_file = None
662 line_diffs = {}
663 for match in re.findall(pattern, diff_output, flags=re.MULTILINE):
664 if match[0] != '':
665 # Will match the second filename in diff --git a/a.py b/b.py.
666 curr_file = match[0]
667 line_diffs[curr_file] = []
668 else:
669 # Matches +14,3
670 if ',' in match[1]:
671 diff_start, diff_count = match[1].split(',')
672 else:
673 # Single line changes are of the form +12 instead of +12,1.
674 diff_start = match[1]
675 diff_count = 1
676
677 diff_start = int(diff_start)
678 diff_count = int(diff_count)
679
680 # If diff_count == 0 this is a removal we can ignore.
681 line_diffs[curr_file].append((diff_start, diff_count))
682
683 return line_diffs
684
685
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000686def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000687 """Checks if a yapf file is in any parent directory of fpath until top_dir.
688
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000689 Recursively checks parent directories to find yapf file and if no yapf file
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000690 is found returns None. Uses yapf_config_cache as a cache for previously found
691 configs.
Aiden Bennerc08566e2018-10-03 17:52:42 +0000692 """
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000693 fpath = os.path.abspath(fpath)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000694 # Return result if we've already computed it.
695 if fpath in yapf_config_cache:
696 return yapf_config_cache[fpath]
697
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000698 parent_dir = os.path.dirname(fpath)
699 if os.path.isfile(fpath):
700 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000701 else:
Aiden Benner99b0ccb2018-11-20 19:53:31 +0000702 # Otherwise fpath is a directory
703 yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME)
704 if os.path.isfile(yapf_file):
705 ret = yapf_file
706 elif fpath == top_dir or parent_dir == fpath:
707 # If we're at the top level directory, or if we're at root
708 # there is no provided style.
709 ret = None
710 else:
711 # Otherwise recurse on the current directory.
712 ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir)
Aiden Bennerc08566e2018-10-03 17:52:42 +0000713 yapf_config_cache[fpath] = ret
714 return ret
715
716
qyearsley53f48a12016-09-01 10:45:13 -0700717def write_try_results_json(output_file, builds):
718 """Writes a subset of the data from fetch_try_jobs to a file as JSON.
719
720 The input |builds| dict is assumed to be generated by Buildbucket.
721 Buildbucket documentation: http://goo.gl/G0s101
722 """
723
724 def convert_build_dict(build):
Quinten Yearsleya563d722017-12-11 16:36:54 -0800725 """Extracts some of the information from one build dict."""
726 parameters = json.loads(build.get('parameters_json', '{}')) or {}
qyearsley53f48a12016-09-01 10:45:13 -0700727 return {
728 'buildbucket_id': build.get('id'),
qyearsley53f48a12016-09-01 10:45:13 -0700729 'bucket': build.get('bucket'),
Quinten Yearsleya563d722017-12-11 16:36:54 -0800730 'builder_name': parameters.get('builder_name'),
731 'created_ts': build.get('created_ts'),
732 'experimental': build.get('experimental'),
qyearsley53f48a12016-09-01 10:45:13 -0700733 'failure_reason': build.get('failure_reason'),
Quinten Yearsleya563d722017-12-11 16:36:54 -0800734 'result': build.get('result'),
735 'status': build.get('status'),
736 'tags': build.get('tags'),
qyearsley53f48a12016-09-01 10:45:13 -0700737 'url': build.get('url'),
738 }
739
740 converted = []
741 for _, build in sorted(builds.items()):
Aiden Bennerc08566e2018-10-03 17:52:42 +0000742 converted.append(convert_build_dict(build))
qyearsley53f48a12016-09-01 10:45:13 -0700743 write_json(output_file, converted)
744
745
Aaron Gable13101a62018-02-09 13:20:41 -0800746def print_stats(args):
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000747 """Prints statistics about the change to the user."""
748 # --no-ext-diff is broken in some versions of Git, so try to work around
749 # this by overriding the environment (but there is still a problem if the
750 # git config key "diff.external" is used).
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000751 env = GetNoGitPagerEnv()
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000752 if 'GIT_EXTERNAL_DIFF' in env:
753 del env['GIT_EXTERNAL_DIFF']
iannucci@chromium.org79540052012-10-19 23:15:26 +0000754
szager@chromium.orgd057f9a2014-05-29 21:09:36 +0000755 try:
756 stdout = sys.stdout.fileno()
757 except AttributeError:
758 stdout = None
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000759 return subprocess2.call(
Aaron Gable13101a62018-02-09 13:20:41 -0800760 ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args,
szager@chromium.orgd057f9a2014-05-29 21:09:36 +0000761 stdout=stdout, env=env)
maruel@chromium.org49e3d802012-07-18 23:54:45 +0000762
763
sheyang@google.com6ebaf782015-05-12 19:17:54 +0000764class BuildbucketResponseException(Exception):
765 pass
766
767
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000768class Settings(object):
769 def __init__(self):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000770 self.cc = None
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000771 self.root = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000772 self.tree_status_url = None
773 self.viewvc_url = None
774 self.updated = False
ukai@chromium.orge8077812012-02-03 03:41:46 +0000775 self.is_gerrit = None
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000776 self.squash_gerrit_uploads = None
tandrii@chromium.org28253532016-04-14 13:46:56 +0000777 self.gerrit_skip_ensure_authenticated = None
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000778 self.git_editor = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000779
780 def LazyUpdateIfNeeded(self):
781 """Updates the settings from a codereview.settings file, if available."""
782 if not self.updated:
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000783 # The only value that actually changes the behavior is
784 # autoupdate = "false". Everything else means "true".
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +0000785 autoupdate = RunGit(['config', 'rietveld.autoupdate'],
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000786 error_ok=True
787 ).strip().lower()
788
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000789 cr_settings_file = FindCodereviewSettingsFile()
pgervais@chromium.org87884cc2014-01-03 22:23:41 +0000790 if autoupdate != 'false' and cr_settings_file:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000791 LoadCodereviewSettingsFromFile(cr_settings_file)
792 self.updated = True
793
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000794 @staticmethod
795 def GetRelativeRoot():
796 return RunGit(['rev-parse', '--show-cdup']).strip()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +0000797
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000798 def GetRoot(self):
thestig@chromium.org7a54e812014-02-11 19:57:22 +0000799 if self.root is None:
800 self.root = os.path.abspath(self.GetRelativeRoot())
801 return self.root
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000802
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000803 def GetTreeStatusUrl(self, error_ok=False):
804 if not self.tree_status_url:
805 error_message = ('You must configure your tree status URL by running '
806 '"git cl config".')
Edward Lemur61ea3072018-12-01 00:34:36 +0000807 self.tree_status_url = self._GetConfig(
808 'rietveld.tree-status-url', error_ok=error_ok,
809 error_message=error_message)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000810 return self.tree_status_url
811
812 def GetViewVCUrl(self):
813 if not self.viewvc_url:
Edward Lemur61ea3072018-12-01 00:34:36 +0000814 self.viewvc_url = self._GetConfig('rietveld.viewvc-url', error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000815 return self.viewvc_url
816
rmistry@google.com90752582014-01-14 21:04:50 +0000817 def GetBugPrefix(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000818 return self._GetConfig('rietveld.bug-prefix', error_ok=True)
rmistry@google.com78948ed2015-07-08 23:09:57 +0000819
rmistry@google.com5626a922015-02-26 14:03:30 +0000820 def GetRunPostUploadHook(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000821 run_post_upload_hook = self._GetConfig(
822 'rietveld.run-post-upload-hook', error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +0000823 return run_post_upload_hook == "True"
824
bauerb@chromium.orgae6df352011-04-06 17:40:39 +0000825 def GetDefaultCCList(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000826 return self._GetConfig('rietveld.cc', error_ok=True)
tyoshino@chromium.orgc1737d02013-05-29 14:17:28 +0000827
ukai@chromium.orge8077812012-02-03 03:41:46 +0000828 def GetIsGerrit(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000829 """Returns True if this repo is associated with Gerrit."""
ukai@chromium.orge8077812012-02-03 03:41:46 +0000830 if self.is_gerrit is None:
Aaron Gable9b465272017-05-12 10:53:51 -0700831 self.is_gerrit = (
832 self._GetConfig('gerrit.host', error_ok=True).lower() == 'true')
ukai@chromium.orge8077812012-02-03 03:41:46 +0000833 return self.is_gerrit
834
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000835 def GetSquashGerritUploads(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000836 """Returns True if uploads to Gerrit should be squashed by default."""
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000837 if self.squash_gerrit_uploads is None:
tandriia60502f2016-06-20 02:01:53 -0700838 self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride()
839 if self.squash_gerrit_uploads is None:
840 # Default is squash now (http://crbug.com/611892#c23).
841 self.squash_gerrit_uploads = not (
842 RunGit(['config', '--bool', 'gerrit.squash-uploads'],
843 error_ok=True).strip() == 'false')
bauerb@chromium.org54b400c2016-01-14 10:08:25 +0000844 return self.squash_gerrit_uploads
845
tandriia60502f2016-06-20 02:01:53 -0700846 def GetSquashGerritUploadsOverride(self):
847 """Return True or False if codereview.settings should be overridden.
848
849 Returns None if no override has been defined.
850 """
851 # See also http://crbug.com/611892#c23
852 result = RunGit(['config', '--bool', 'gerrit.override-squash-uploads'],
853 error_ok=True).strip()
854 if result == 'true':
855 return True
856 if result == 'false':
857 return False
858 return None
859
tandrii@chromium.org28253532016-04-14 13:46:56 +0000860 def GetGerritSkipEnsureAuthenticated(self):
861 """Return True if EnsureAuthenticated should not be done for Gerrit
862 uploads."""
863 if self.gerrit_skip_ensure_authenticated is None:
864 self.gerrit_skip_ensure_authenticated = (
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +0000865 RunGit(['config', '--bool', 'gerrit.skip-ensure-authenticated'],
tandrii@chromium.org28253532016-04-14 13:46:56 +0000866 error_ok=True).strip() == 'true')
867 return self.gerrit_skip_ensure_authenticated
868
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000869 def GetGitEditor(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000870 """Returns the editor specified in the git config, or None if none is."""
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000871 if self.git_editor is None:
Raul Tambre5a525872019-02-12 19:08:08 +0000872 # Git requires single quotes for paths with spaces. We need to replace
873 # them with double quotes for Windows to treat such paths as a single
874 # path.
875 self.git_editor = self._GetConfig(
876 'core.editor', error_ok=True).replace('\'', '"')
jbroman@chromium.org615a2622013-05-03 13:20:14 +0000877 return self.git_editor or None
878
thestig@chromium.org44202a22014-03-11 19:22:18 +0000879 def GetLintRegex(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000880 return (self._GetConfig('rietveld.cpplint-regex', error_ok=True) or
thestig@chromium.org44202a22014-03-11 19:22:18 +0000881 DEFAULT_LINT_REGEX)
882
883 def GetLintIgnoreRegex(self):
Edward Lemur61ea3072018-12-01 00:34:36 +0000884 return (self._GetConfig('rietveld.cpplint-ignore-regex', error_ok=True) or
thestig@chromium.org44202a22014-03-11 19:22:18 +0000885 DEFAULT_LINT_IGNORE_REGEX)
886
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000887 def _GetConfig(self, param, **kwargs):
888 self.LazyUpdateIfNeeded()
889 return RunGit(['config', param], **kwargs).strip()
890
891
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +0100892@contextlib.contextmanager
893def _get_gerrit_project_config_file(remote_url):
894 """Context manager to fetch and store Gerrit's project.config from
895 refs/meta/config branch and store it in temp file.
896
897 Provides a temporary filename or None if there was error.
898 """
899 error, _ = RunGitWithCode([
900 'fetch', remote_url,
901 '+refs/meta/config:refs/git_cl/meta/config'])
902 if error:
903 # Ref doesn't exist or isn't accessible to current user.
Quinten Yearsley0c62da92017-05-31 13:39:42 -0700904 print('WARNING: Failed to fetch project config for %s: %s' %
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +0100905 (remote_url, error))
906 yield None
907 return
908
909 error, project_config_data = RunGitWithCode(
910 ['show', 'refs/git_cl/meta/config:project.config'])
911 if error:
912 print('WARNING: project.config file not found')
913 yield None
914 return
915
916 with gclient_utils.temporary_directory() as tempdir:
917 project_config_file = os.path.join(tempdir, 'project.config')
918 gclient_utils.FileWrite(project_config_file, project_config_data)
919 yield project_config_file
920
921
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000922def ShortBranchName(branch):
923 """Convert a name like 'refs/heads/foo' to just 'foo'."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +0000924 return branch.replace('refs/heads/', '', 1)
925
926
927def GetCurrentBranchRef():
928 """Returns branch ref (e.g., refs/heads/master) or None."""
929 return RunGit(['symbolic-ref', 'HEAD'],
930 stderr=subprocess2.VOID, error_ok=True).strip() or None
931
932
933def GetCurrentBranch():
934 """Returns current branch or None.
935
936 For refs/heads/* branches, returns just last part. For others, full ref.
937 """
938 branchref = GetCurrentBranchRef()
939 if branchref:
940 return ShortBranchName(branchref)
941 return None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +0000942
943
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000944class _CQState(object):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +0000945 """Enum for states of CL with respect to CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +0000946 NONE = 'none'
947 DRY_RUN = 'dry_run'
948 COMMIT = 'commit'
949
950 ALL_STATES = [NONE, DRY_RUN, COMMIT]
951
952
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000953class _ParsedIssueNumberArgument(object):
Edward Lemurf38bc172019-09-03 21:02:13 +0000954 def __init__(self, issue=None, patchset=None, hostname=None):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000955 self.issue = issue
956 self.patchset = patchset
957 self.hostname = hostname
958
959 @property
960 def valid(self):
961 return self.issue is not None
962
963
Edward Lemurf38bc172019-09-03 21:02:13 +0000964def ParseIssueNumberArgument(arg):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000965 """Parses the issue argument and returns _ParsedIssueNumberArgument."""
966 fail_result = _ParsedIssueNumberArgument()
967
968 if arg.isdigit():
Edward Lemurf38bc172019-09-03 21:02:13 +0000969 return _ParsedIssueNumberArgument(issue=int(arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000970 if not arg.startswith('http'):
971 return fail_result
Aaron Gableaee6c852017-06-26 12:49:01 -0700972
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000973 url = gclient_utils.UpgradeToHttps(arg)
974 try:
975 parsed_url = urlparse.urlparse(url)
976 except ValueError:
977 return fail_result
Andrii Shyshkalov28d840e2017-04-10 15:45:09 +0200978
Andrii Shyshkalov0a264d82018-11-21 00:36:16 +0000979 return _GerritChangelistImpl.ParseIssueURL(parsed_url) or fail_result
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +0000980
981
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +0000982def _create_description_from_log(args):
983 """Pulls out the commit log to use as a base for the CL description."""
984 log_args = []
985 if len(args) == 1 and not args[0].endswith('.'):
986 log_args = [args[0] + '..']
987 elif len(args) == 1 and args[0].endswith('...'):
988 log_args = [args[0][:-1]]
989 elif len(args) == 2:
990 log_args = [args[0] + '..' + args[1]]
991 else:
992 log_args = args[:] # Hope for the best!
993 return RunGit(['log', '--pretty=format:%s\n\n%b'] + log_args)
994
995
Aaron Gablea45ee112016-11-22 15:14:38 -0800996class GerritChangeNotExists(Exception):
tandriic2405f52016-10-10 08:13:15 -0700997 def __init__(self, issue, url):
998 self.issue = issue
999 self.url = url
Aaron Gablea45ee112016-11-22 15:14:38 -08001000 super(GerritChangeNotExists, self).__init__()
tandriic2405f52016-10-10 08:13:15 -07001001
1002 def __str__(self):
Aaron Gablea45ee112016-11-22 15:14:38 -08001003 return 'change %s at %s does not exist or you have no access to it' % (
tandriic2405f52016-10-10 08:13:15 -07001004 self.issue, self.url)
1005
1006
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001007_CommentSummary = collections.namedtuple(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00001008 '_CommentSummary', ['date', 'message', 'sender', 'autogenerated',
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001009 # TODO(tandrii): these two aren't known in Gerrit.
1010 'approval', 'disapproval'])
1011
1012
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001013class Changelist(object):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001014 """Changelist works with one changelist in local branch.
1015
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00001016 Notes:
1017 * Not safe for concurrent multi-{thread,process} use.
1018 * Caches values from current branch. Therefore, re-use after branch change
tandrii5d48c322016-08-18 16:19:37 -07001019 with great care.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001020 """
1021
Edward Lemurf38bc172019-09-03 21:02:13 +00001022 def __init__(self, branchref=None, issue=None, **kwargs):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001023 """Create a new ChangeList instance.
1024
Edward Lemurf38bc172019-09-03 21:02:13 +00001025 **kwargs will be passed directly to Gerrit implementation.
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001026 """
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001027 # Poke settings so we get the "configure your server" message if necessary.
maruel@chromium.org379d07a2011-11-30 14:58:10 +00001028 global settings
1029 if not settings:
1030 # Happens when git_cl.py is used as a utility library.
1031 settings = Settings()
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001032
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001033 self.branchref = branchref
1034 if self.branchref:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00001035 assert branchref.startswith('refs/heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001036 self.branch = ShortBranchName(self.branchref)
1037 else:
1038 self.branch = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001039 self.upstream_branch = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001040 self.lookedup_issue = False
1041 self.issue = issue or None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001042 self.has_description = False
1043 self.description = None
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001044 self.lookedup_patchset = False
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001045 self.patchset = None
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001046 self.cc = None
Daniel Cheng7227d212017-11-17 08:12:37 -08001047 self.more_cc = []
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001048 self._remote = None
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001049 self._cached_remote_url = (False, None) # (is_cached, value)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00001050
Edward Lemurf38bc172019-09-03 21:02:13 +00001051 self._codereview_impl = _GerritChangelistImpl(self, **kwargs)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001052
1053 def GetCCList(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001054 """Returns the users cc'd on this CL.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001055
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001056 The return value is a string suitable for passing to git cl with the --cc
1057 flag.
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001058 """
1059 if self.cc is None:
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001060 base_cc = settings.GetDefaultCCList()
Daniel Cheng7227d212017-11-17 08:12:37 -08001061 more_cc = ','.join(self.more_cc)
bauerb@chromium.orgae6df352011-04-06 17:40:39 +00001062 self.cc = ','.join(filter(None, (base_cc, more_cc))) or ''
1063 return self.cc
1064
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001065 def GetCCListWithoutDefault(self):
1066 """Return the users cc'd on this CL excluding default ones."""
1067 if self.cc is None:
Daniel Cheng7227d212017-11-17 08:12:37 -08001068 self.cc = ','.join(self.more_cc)
tyoshino@chromium.org99918ab2013-09-30 06:17:28 +00001069 return self.cc
1070
Daniel Cheng7227d212017-11-17 08:12:37 -08001071 def ExtendCC(self, more_cc):
1072 """Extends the list of users to cc on this CL based on the changed files."""
1073 self.more_cc.extend(more_cc)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001074
1075 def GetBranch(self):
1076 """Returns the short branch name, e.g. 'master'."""
1077 if not self.branch:
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001078 branchref = GetCurrentBranchRef()
szager@chromium.orgd62c61f2014-10-20 22:33:21 +00001079 if not branchref:
1080 return None
1081 self.branchref = branchref
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001082 self.branch = ShortBranchName(self.branchref)
1083 return self.branch
1084
1085 def GetBranchRef(self):
1086 """Returns the full branch name, e.g. 'refs/heads/master'."""
1087 self.GetBranch() # Poke the lazy loader.
1088 return self.branchref
1089
tandrii@chromium.org534f67a2016-04-07 18:47:05 +00001090 def ClearBranch(self):
1091 """Clears cached branch data of this object."""
1092 self.branch = self.branchref = None
1093
tandrii5d48c322016-08-18 16:19:37 -07001094 def _GitGetBranchConfigValue(self, key, default=None, **kwargs):
1095 assert 'branch' not in kwargs, 'this CL branch is used automatically'
1096 kwargs['branch'] = self.GetBranch()
1097 return _git_get_branch_config_value(key, default, **kwargs)
1098
1099 def _GitSetBranchConfigValue(self, key, value, **kwargs):
1100 assert 'branch' not in kwargs, 'this CL branch is used automatically'
1101 assert self.GetBranch(), (
1102 'this CL must have an associated branch to %sset %s%s' %
1103 ('un' if value is None else '',
1104 key,
1105 '' if value is None else ' to %r' % value))
1106 kwargs['branch'] = self.GetBranch()
1107 return _git_set_branch_config_value(key, value, **kwargs)
1108
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001109 @staticmethod
1110 def FetchUpstreamTuple(branch):
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001111 """Returns a tuple containing remote and remote ref,
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001112 e.g. 'origin', 'refs/heads/master'
1113 """
1114 remote = '.'
tandrii5d48c322016-08-18 16:19:37 -07001115 upstream_branch = _git_get_branch_config_value('merge', branch=branch)
1116
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001117 if upstream_branch:
tandrii5d48c322016-08-18 16:19:37 -07001118 remote = _git_get_branch_config_value('remote', branch=branch)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001119 else:
bauerb@chromium.orgade368c2011-03-01 08:57:50 +00001120 upstream_branch = RunGit(['config', 'rietveld.upstream-branch'],
1121 error_ok=True).strip()
1122 if upstream_branch:
1123 remote = RunGit(['config', 'rietveld.upstream-remote']).strip()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001124 else:
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001125 # Else, try to guess the origin remote.
1126 remote_branches = RunGit(['branch', '-r']).split()
1127 if 'origin/master' in remote_branches:
1128 # Fall back on origin/master if it exits.
1129 remote = 'origin'
1130 upstream_branch = 'refs/heads/master'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001131 else:
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001132 DieWithError(
1133 'Unable to determine default branch to diff against.\n'
1134 'Either pass complete "git diff"-style arguments, like\n'
1135 ' git cl upload origin/master\n'
1136 'or verify this branch is set up to track another \n'
1137 '(via the --track argument to "git checkout -b ...").')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001138
1139 return remote, upstream_branch
1140
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001141 def GetCommonAncestorWithUpstream(self):
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001142 upstream_branch = self.GetUpstreamBranch()
1143 if not BranchExists(upstream_branch):
1144 DieWithError('The upstream for the current branch (%s) does not exist '
1145 'anymore.\nPlease fix it and try again.' % self.GetBranch())
iannucci@chromium.org9e849272014-04-04 00:31:55 +00001146 return git_common.get_or_create_merge_base(self.GetBranch(),
pgervais@chromium.org8ba38ff2015-06-11 21:41:25 +00001147 upstream_branch)
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001148
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001149 def GetUpstreamBranch(self):
1150 if self.upstream_branch is None:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001151 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Raul Tambrefe1dbe12019-05-02 04:43:57 +00001152 if remote != '.':
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001153 upstream_branch = upstream_branch.replace('refs/heads/',
1154 'refs/remotes/%s/' % remote)
1155 upstream_branch = upstream_branch.replace('refs/branch-heads/',
1156 'refs/remotes/branch-heads/')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001157 self.upstream_branch = upstream_branch
1158 return self.upstream_branch
1159
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001160 def GetRemoteBranch(self):
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001161 if not self._remote:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001162 remote, branch = None, self.GetBranch()
1163 seen_branches = set()
1164 while branch not in seen_branches:
1165 seen_branches.add(branch)
1166 remote, branch = self.FetchUpstreamTuple(branch)
1167 branch = ShortBranchName(branch)
1168 if remote != '.' or branch.startswith('refs/remotes'):
1169 break
1170 else:
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001171 remotes = RunGit(['remote'], error_ok=True).split()
1172 if len(remotes) == 1:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001173 remote, = remotes
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001174 elif 'origin' in remotes:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001175 remote = 'origin'
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001176 logging.warn('Could not determine which remote this change is '
1177 'associated with, so defaulting to "%s".' % self._remote)
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001178 else:
1179 logging.warn('Could not determine which remote this change is '
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08001180 'associated with.')
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001181 branch = 'HEAD'
1182 if branch.startswith('refs/remotes'):
1183 self._remote = (remote, branch)
mmoss@chromium.orge7585452014-08-24 01:41:11 +00001184 elif branch.startswith('refs/branch-heads/'):
1185 self._remote = (remote, branch.replace('refs/', 'refs/remotes/'))
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001186 else:
1187 self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch))
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001188 return self._remote
1189
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001190 def GitSanityChecks(self, upstream_git_obj):
1191 """Checks git repo status and ensures diff is from local commits."""
1192
sbc@chromium.org79706062015-01-14 21:18:12 +00001193 if upstream_git_obj is None:
1194 if self.GetBranch() is None:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001195 print('ERROR: Unable to determine current branch (detached HEAD?)',
vapiera7fbd5a2016-06-16 09:17:49 -07001196 file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001197 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001198 print('ERROR: No upstream branch.', file=sys.stderr)
sbc@chromium.org79706062015-01-14 21:18:12 +00001199 return False
1200
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001201 # Verify the commit we're diffing against is in our current branch.
1202 upstream_sha = RunGit(['rev-parse', '--verify', upstream_git_obj]).strip()
1203 common_ancestor = RunGit(['merge-base', upstream_sha, 'HEAD']).strip()
1204 if upstream_sha != common_ancestor:
vapiera7fbd5a2016-06-16 09:17:49 -07001205 print('ERROR: %s is not in the current branch. You may need to rebase '
1206 'your tracking branch' % upstream_sha, file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001207 return False
1208
1209 # List the commits inside the diff, and verify they are all local.
1210 commits_in_diff = RunGit(
1211 ['rev-list', '^%s' % upstream_sha, 'HEAD']).splitlines()
1212 code, remote_branch = RunGitWithCode(['config', 'gitcl.remotebranch'])
1213 remote_branch = remote_branch.strip()
1214 if code != 0:
1215 _, remote_branch = self.GetRemoteBranch()
1216
1217 commits_in_remote = RunGit(
1218 ['rev-list', '^%s' % upstream_sha, remote_branch]).splitlines()
1219
1220 common_commits = set(commits_in_diff) & set(commits_in_remote)
1221 if common_commits:
vapiera7fbd5a2016-06-16 09:17:49 -07001222 print('ERROR: Your diff contains %d commits already in %s.\n'
1223 'Run "git log --oneline %s..HEAD" to get a list of commits in '
1224 'the diff. If you are using a custom git flow, you can override'
1225 ' the reference used for this check with "git config '
1226 'gitcl.remotebranch <git-ref>".' % (
1227 len(common_commits), remote_branch, upstream_git_obj),
1228 file=sys.stderr)
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001229 return False
1230 return True
1231
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001232 def GetGitBaseUrlFromConfig(self):
sheyang@chromium.orga656e702014-05-15 20:43:05 +00001233 """Return the configured base URL from branch.<branchname>.baseurl.
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00001234
1235 Returns None if it is not set.
1236 """
tandrii5d48c322016-08-18 16:19:37 -07001237 return self._GitGetBranchConfigValue('base-url')
jmbaker@chromium.orga2cbbbb2012-03-22 20:40:40 +00001238
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001239 def GetRemoteUrl(self):
1240 """Return the configured remote URL, e.g. 'git://example.org/foo.git/'.
1241
1242 Returns None if there is no remote.
1243 """
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001244 is_cached, value = self._cached_remote_url
1245 if is_cached:
1246 return value
1247
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001248 remote, _ = self.GetRemoteBranch()
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001249 url = RunGit(['config', 'remote.%s.url' % remote], error_ok=True).strip()
1250
Edward Lemur298f2cf2019-02-22 21:40:39 +00001251 # Check if the remote url can be parsed as an URL.
1252 host = urlparse.urlparse(url).netloc
1253 if host:
1254 self._cached_remote_url = (True, url)
1255 return url
1256
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001257 # If it cannot be parsed as an url, assume it is a local directory,
1258 # probably a git cache.
Edward Lemur298f2cf2019-02-22 21:40:39 +00001259 logging.warning('"%s" doesn\'t appear to point to a git host. '
1260 'Interpreting it as a local directory.', url)
1261 if not os.path.isdir(url):
1262 logging.error(
1263 'Remote "%s" for branch "%s" points to "%s", but it doesn\'t exist.',
1264 remote, url, self.GetBranch())
1265 return None
1266
1267 cache_path = url
1268 url = RunGit(['config', 'remote.%s.url' % remote],
1269 error_ok=True,
1270 cwd=url).strip()
1271
1272 host = urlparse.urlparse(url).netloc
1273 if not host:
1274 logging.error(
1275 'Remote "%(remote)s" for branch "%(branch)s" points to '
1276 '"%(cache_path)s", but it is misconfigured.\n'
1277 '"%(cache_path)s" must be a git repo and must have a remote named '
1278 '"%(remote)s" pointing to the git host.', {
1279 'remote': remote,
1280 'cache_path': cache_path,
1281 'branch': self.GetBranch()})
1282 return None
1283
Andrii Shyshkalov81db1d52018-08-23 02:17:41 +00001284 self._cached_remote_url = (True, url)
dyen@chromium.org2a13d4f2014-06-13 00:06:37 +00001285 return url
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001286
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001287 def GetIssue(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001288 """Returns the issue number as a int or None if not set."""
tandrii@chromium.org87985d22016-03-24 17:33:33 +00001289 if self.issue is None and not self.lookedup_issue:
tandrii5d48c322016-08-18 16:19:37 -07001290 self.issue = self._GitGetBranchConfigValue(
1291 self._codereview_impl.IssueConfigKey(), value_type=int)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001292 self.lookedup_issue = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001293 return self.issue
1294
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001295 def GetIssueURL(self):
1296 """Get the URL for a particular issue."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001297 issue = self.GetIssue()
1298 if not issue:
dbeam@chromium.org015fd3d2013-06-18 19:02:50 +00001299 return None
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001300 return '%s/%s' % (self._codereview_impl.GetCodereviewServer(), issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001301
Andrii Shyshkalov31863012017-02-08 11:35:12 +01001302 def GetDescription(self, pretty=False, force=False):
1303 if not self.has_description or force:
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001304 if self.GetIssue():
Kenneth Russell61e2ed42017-02-15 11:47:13 -08001305 self.description = self._codereview_impl.FetchDescription(force=force)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001306 self.has_description = True
1307 if pretty:
Asanka Herath7c61dcb2016-12-14 13:01:58 -05001308 # Set width to 72 columns + 2 space indent.
1309 wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001310 wrapper.initial_indent = wrapper.subsequent_indent = ' '
Asanka Herath7c61dcb2016-12-14 13:01:58 -05001311 lines = self.description.splitlines()
1312 return '\n'.join([wrapper.fill(line) for line in lines])
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001313 return self.description
1314
Robert Iannucci09f1f3d2017-03-28 16:54:32 -07001315 def GetDescriptionFooters(self):
1316 """Returns (non_footer_lines, footers) for the commit message.
1317
1318 Returns:
1319 non_footer_lines (list(str)) - Simple list of description lines without
1320 any footer. The lines do not contain newlines, nor does the list contain
1321 the empty line between the message and the footers.
1322 footers (list(tuple(KEY, VALUE))) - List of parsed footers, e.g.
1323 [("Change-Id", "Ideadbeef...."), ...]
1324 """
1325 raw_description = self.GetDescription()
1326 msg_lines, _, footers = git_footers.split_footers(raw_description)
1327 if footers:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001328 msg_lines = msg_lines[:len(msg_lines) - 1]
Robert Iannucci09f1f3d2017-03-28 16:54:32 -07001329 return msg_lines, footers
1330
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001331 def GetPatchset(self):
maruel@chromium.org52424302012-08-29 15:14:30 +00001332 """Returns the patchset number as a int or None if not set."""
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001333 if self.patchset is None and not self.lookedup_patchset:
tandrii5d48c322016-08-18 16:19:37 -07001334 self.patchset = self._GitGetBranchConfigValue(
1335 self._codereview_impl.PatchsetConfigKey(), value_type=int)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001336 self.lookedup_patchset = True
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001337 return self.patchset
1338
1339 def SetPatchset(self, patchset):
tandrii5d48c322016-08-18 16:19:37 -07001340 """Set this branch's patchset. If patchset=0, clears the patchset."""
1341 assert self.GetBranch()
1342 if not patchset:
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001343 self.patchset = None
tandrii5d48c322016-08-18 16:19:37 -07001344 else:
1345 self.patchset = int(patchset)
1346 self._GitSetBranchConfigValue(
1347 self._codereview_impl.PatchsetConfigKey(), self.patchset)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001348
tandrii@chromium.orga342c922016-03-16 07:08:25 +00001349 def SetIssue(self, issue=None):
tandrii5d48c322016-08-18 16:19:37 -07001350 """Set this branch's issue. If issue isn't given, clears the issue."""
1351 assert self.GetBranch()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001352 if issue:
tandrii5d48c322016-08-18 16:19:37 -07001353 issue = int(issue)
1354 self._GitSetBranchConfigValue(
1355 self._codereview_impl.IssueConfigKey(), issue)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001356 self.issue = issue
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001357 codereview_server = self._codereview_impl.GetCodereviewServer()
1358 if codereview_server:
tandrii5d48c322016-08-18 16:19:37 -07001359 self._GitSetBranchConfigValue(
1360 self._codereview_impl.CodereviewServerConfigKey(),
1361 codereview_server)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001362 else:
tandrii5d48c322016-08-18 16:19:37 -07001363 # Reset all of these just to be clean.
1364 reset_suffixes = [
1365 'last-upload-hash',
1366 self._codereview_impl.IssueConfigKey(),
1367 self._codereview_impl.PatchsetConfigKey(),
1368 self._codereview_impl.CodereviewServerConfigKey(),
1369 ] + self._PostUnsetIssueProperties()
1370 for prop in reset_suffixes:
1371 self._GitSetBranchConfigValue(prop, None, error_ok=True)
Aaron Gableca01e2c2017-07-19 11:16:02 -07001372 msg = RunGit(['log', '-1', '--format=%B']).strip()
1373 if msg and git_footers.get_footer_change_id(msg):
1374 print('WARNING: The change patched into this branch has a Change-Id. '
1375 'Removing it.')
1376 RunGit(['commit', '--amend', '-m',
1377 git_footers.remove_footer(msg, 'Change-Id')])
Edward Lemurf38bc172019-09-03 21:02:13 +00001378 self.lookedup_issue = True
maruel@chromium.org1033efd2013-07-23 23:25:09 +00001379 self.issue = None
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001380 self.patchset = None
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00001381
dnjba1b0f32016-09-02 12:37:42 -07001382 def GetChange(self, upstream_branch, author, local_description=False):
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00001383 if not self.GitSanityChecks(upstream_branch):
1384 DieWithError('\nGit sanity check failure')
1385
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001386 root = settings.GetRelativeRoot()
bratell@opera.comf267b0e2013-05-02 09:11:43 +00001387 if not root:
1388 root = '.'
bauerb@chromium.org512f1ef2011-04-20 15:17:57 +00001389 absroot = os.path.abspath(root)
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001390
1391 # We use the sha1 of HEAD as a name of this change.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001392 name = RunGitWithCode(['rev-parse', 'HEAD'])[1].strip()
bauerb@chromium.org512f1ef2011-04-20 15:17:57 +00001393 # Need to pass a relative path for msysgit.
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001394 try:
maruel@chromium.org80a9ef12011-12-13 20:44:10 +00001395 files = scm.GIT.CaptureStatus([root], '.', upstream_branch)
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001396 except subprocess2.CalledProcessError:
1397 DieWithError(
pgervais@chromium.orgd6617f32013-11-19 00:34:54 +00001398 ('\nFailed to diff against upstream branch %s\n\n'
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001399 'This branch probably doesn\'t exist anymore. To reset the\n'
1400 'tracking branch, please run\n'
stip7a3dd352016-09-22 17:32:28 -07001401 ' git branch --set-upstream-to origin/master %s\n'
1402 'or replace origin/master with the relevant branch') %
maruel@chromium.org2b38e9c2011-10-19 00:04:35 +00001403 (upstream_branch, self.GetBranch()))
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001404
maruel@chromium.org52424302012-08-29 15:14:30 +00001405 issue = self.GetIssue()
1406 patchset = self.GetPatchset()
dnjba1b0f32016-09-02 12:37:42 -07001407 if issue and not local_description:
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001408 description = self.GetDescription()
1409 else:
1410 # If the change was never uploaded, use the log messages of all commits
1411 # up to the branch point, as git cl upload will prefill the description
1412 # with these log messages.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00001413 args = ['log', '--pretty=format:%s%n%n%b', '%s...' % (upstream_branch)]
1414 description = RunGitWithCode(args)[1].strip()
maruel@chromium.org03b3bdc2011-06-14 13:04:12 +00001415
1416 if not author:
maruel@chromium.org13f623c2011-07-22 16:02:23 +00001417 author = RunGit(['config', 'user.email']).strip() or None
asvitkine@chromium.org15169952011-09-27 14:30:53 +00001418 return presubmit_support.GitChange(
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001419 name,
1420 description,
1421 absroot,
1422 files,
1423 issue,
1424 patchset,
agable@chromium.orgea84ef12014-04-30 19:55:12 +00001425 author,
1426 upstream=upstream_branch)
bauerb@chromium.org6fb99c62011-04-18 15:57:28 +00001427
dsansomee2d6fd92016-09-08 00:10:47 -07001428 def UpdateDescription(self, description, force=False):
Andrii Shyshkalov83051152017-02-07 23:47:29 +01001429 self._codereview_impl.UpdateDescriptionRemote(description, force=force)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001430 self.description = description
Andrii Shyshkalov83051152017-02-07 23:47:29 +01001431 self.has_description = True
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001432
Robert Iannucci09f1f3d2017-03-28 16:54:32 -07001433 def UpdateDescriptionFooters(self, description_lines, footers, force=False):
1434 """Sets the description for this CL remotely.
1435
1436 You can get description_lines and footers with GetDescriptionFooters.
1437
1438 Args:
1439 description_lines (list(str)) - List of CL description lines without
1440 newline characters.
1441 footers (list(tuple(KEY, VALUE))) - List of footers, as returned by
1442 GetDescriptionFooters. Key must conform to the git footers format (i.e.
1443 `List-Of-Tokens`). It will be case-normalized so that each token is
1444 title-cased.
1445 """
1446 new_description = '\n'.join(description_lines)
1447 if footers:
1448 new_description += '\n'
1449 for k, v in footers:
1450 foot = '%s: %s' % (git_footers.normalize_name(k), v)
1451 if not git_footers.FOOTER_PATTERN.match(foot):
1452 raise ValueError('Invalid footer %r' % foot)
1453 new_description += foot + '\n'
1454 self.UpdateDescription(new_description, force)
1455
Edward Lesmes8e282792018-04-03 18:50:29 -04001456 def RunHook(self, committing, may_prompt, verbose, change, parallel):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001457 """Calls sys.exit() if the hook fails; returns a HookResults otherwise."""
1458 try:
Edward Lemur2c48f242019-06-04 16:14:09 +00001459 start = time_time()
1460 result = presubmit_support.DoPresubmitChecks(change, committing,
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001461 verbose=verbose, output_stream=sys.stdout, input_stream=sys.stdin,
1462 default_presubmit=None, may_prompt=may_prompt,
Edward Lesmes8e282792018-04-03 18:50:29 -04001463 gerrit_obj=self._codereview_impl.GetGerritObjForPresubmit(),
1464 parallel=parallel)
Edward Lemur2c48f242019-06-04 16:14:09 +00001465 metrics.collector.add_repeated('sub_commands', {
1466 'command': 'presubmit',
1467 'execution_time': time_time() - start,
1468 'exit_code': 0 if result.should_continue() else 1,
1469 })
1470 return result
vapierfd77ac72016-06-16 08:33:57 -07001471 except presubmit_support.PresubmitFailure as e:
Aaron Gable5d5f22c2018-02-02 09:12:41 -08001472 DieWithError('%s\nMaybe your depot_tools is out of date?' % e)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001473
Edward Lemurf38bc172019-09-03 21:02:13 +00001474 def CMDPatchIssue(self, issue_arg, nocommit):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001475 """Fetches and applies the issue patch from codereview to local branch."""
tandrii@chromium.orgef7c68c2016-04-07 09:39:39 +00001476 if isinstance(issue_arg, (int, long)) or issue_arg.isdigit():
1477 parsed_issue_arg = _ParsedIssueNumberArgument(int(issue_arg))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001478 else:
1479 # Assume url.
1480 parsed_issue_arg = self._codereview_impl.ParseIssueURL(
1481 urlparse.urlparse(issue_arg))
1482 if not parsed_issue_arg or not parsed_issue_arg.valid:
1483 DieWithError('Failed to parse issue argument "%s". '
1484 'Must be an issue number or a valid URL.' % issue_arg)
1485 return self._codereview_impl.CMDPatchWithParsedIssue(
Edward Lemurf38bc172019-09-03 21:02:13 +00001486 parsed_issue_arg, nocommit, False)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001487
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001488 def CMDUpload(self, options, git_diff_args, orig_args):
1489 """Uploads a change to codereview."""
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001490 custom_cl_base = None
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001491 if git_diff_args:
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001492 custom_cl_base = base_branch = git_diff_args[0]
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001493 else:
1494 if self.GetBranch() is None:
1495 DieWithError('Can\'t upload from detached HEAD state. Get on a branch!')
1496
1497 # Default to diffing against common ancestor of upstream branch
1498 base_branch = self.GetCommonAncestorWithUpstream()
1499 git_diff_args = [base_branch, 'HEAD']
1500
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001501 # Fast best-effort checks to abort before running potentially expensive
1502 # hooks if uploading is likely to fail anyway. Passing these checks does
1503 # not guarantee that uploading will not fail.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001504 self._codereview_impl.EnsureAuthenticated(force=options.force)
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001505 self._codereview_impl.EnsureCanUploadPatchset(force=options.force)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001506
1507 # Apply watchlists on upload.
1508 change = self.GetChange(base_branch, None)
1509 watchlist = watchlists.Watchlists(change.RepositoryRoot())
1510 files = [f.LocalPath() for f in change.AffectedFiles()]
1511 if not options.bypass_watchlists:
Daniel Cheng7227d212017-11-17 08:12:37 -08001512 self.ExtendCC(watchlist.GetWatchersForPaths(files))
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001513
1514 if not options.bypass_hooks:
Robert Iannucci6c98dc62017-04-18 11:38:00 -07001515 if options.reviewers or options.tbrs or options.add_owners_to:
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001516 # Set the reviewer list now so that presubmit checks can access it.
1517 change_description = ChangeDescription(change.FullDescriptionText())
1518 change_description.update_reviewers(options.reviewers,
Robert Iannucci6c98dc62017-04-18 11:38:00 -07001519 options.tbrs,
Robert Iannuccif2708bd2017-04-17 15:49:02 -07001520 options.add_owners_to,
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001521 change)
1522 change.SetDescriptionText(change_description.description)
1523 hook_results = self.RunHook(committing=False,
Edward Lesmes8e282792018-04-03 18:50:29 -04001524 may_prompt=not options.force,
1525 verbose=options.verbose,
1526 change=change, parallel=options.parallel)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001527 if not hook_results.should_continue():
1528 return 1
1529 if not options.reviewers and hook_results.reviewers:
1530 options.reviewers = hook_results.reviewers.split(',')
Daniel Cheng7227d212017-11-17 08:12:37 -08001531 self.ExtendCC(hook_results.more_cc)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001532
Aaron Gable13101a62018-02-09 13:20:41 -08001533 print_stats(git_diff_args)
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001534 ret = self.CMDUploadChange(options, git_diff_args, custom_cl_base, change)
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001535 if not ret:
tandrii5d48c322016-08-18 16:19:37 -07001536 _git_set_branch_config_value('last-upload-hash',
1537 RunGit(['rev-parse', 'HEAD']).strip())
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001538 # Run post upload hooks, if specified.
1539 if settings.GetRunPostUploadHook():
1540 presubmit_support.DoPostUploadExecuter(
1541 change,
1542 self,
1543 settings.GetRoot(),
1544 options.verbose,
1545 sys.stdout)
1546
1547 # Upload all dependencies if specified.
1548 if options.dependencies:
vapiera7fbd5a2016-06-16 09:17:49 -07001549 print()
1550 print('--dependencies has been specified.')
1551 print('All dependent local branches will be re-uploaded.')
1552 print()
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001553 # Remove the dependencies flag from args so that we do not end up in a
1554 # loop.
1555 orig_args.remove('--dependencies')
1556 ret = upload_branch_deps(self, orig_args)
1557 return ret
1558
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001559 def SetCQState(self, new_state):
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001560 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001561
1562 Issue must have been already uploaded and known.
1563 """
1564 assert new_state in _CQState.ALL_STATES
1565 assert self.GetIssue()
qyearsley1fdfcb62016-10-24 13:22:03 -07001566 try:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001567 self._codereview_impl.SetCQState(new_state)
qyearsley1fdfcb62016-10-24 13:22:03 -07001568 return 0
1569 except KeyboardInterrupt:
1570 raise
1571 except:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001572 print('WARNING: Failed to %s.\n'
qyearsley1fdfcb62016-10-24 13:22:03 -07001573 'Either:\n'
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07001574 ' * Your project has no CQ,\n'
1575 ' * You don\'t have permission to change the CQ state,\n'
1576 ' * There\'s a bug in this code (see stack trace below).\n'
1577 'Consider specifying which bots to trigger manually or asking your '
1578 'project owners for permissions or contacting Chrome Infra at:\n'
1579 'https://www.chromium.org/infra\n\n' %
1580 ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ'))
qyearsley1fdfcb62016-10-24 13:22:03 -07001581 # Still raise exception so that stack trace is printed.
1582 raise
1583
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001584 # Forward methods to codereview specific implementation.
1585
Aaron Gable636b13f2017-07-14 10:42:48 -07001586 def AddComment(self, message, publish=None):
1587 return self._codereview_impl.AddComment(message, publish=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001588
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001589 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001590 """Returns list of _CommentSummary for each comment.
1591
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001592 args:
1593 readable: determines whether the output is designed for a human or a machine
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001594 """
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001595 return self._codereview_impl.GetCommentsSummary(readable)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001596
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001597 def CloseIssue(self):
1598 return self._codereview_impl.CloseIssue()
1599
1600 def GetStatus(self):
1601 return self._codereview_impl.GetStatus()
1602
1603 def GetCodereviewServer(self):
1604 return self._codereview_impl.GetCodereviewServer()
1605
tandriide281ae2016-10-12 06:02:30 -07001606 def GetIssueOwner(self):
1607 """Get owner from codereview, which may differ from this checkout."""
1608 return self._codereview_impl.GetIssueOwner()
1609
Edward Lemur707d70b2018-02-07 00:50:14 +01001610 def GetReviewers(self):
1611 return self._codereview_impl.GetReviewers()
1612
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001613 def GetMostRecentPatchset(self):
1614 return self._codereview_impl.GetMostRecentPatchset()
1615
tandriide281ae2016-10-12 06:02:30 -07001616 def CannotTriggerTryJobReason(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001617 """Returns reason (str) if unable trigger tryjobs on this CL or None."""
tandriide281ae2016-10-12 06:02:30 -07001618 return self._codereview_impl.CannotTriggerTryJobReason()
1619
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001620 def GetTryJobProperties(self, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001621 """Returns dictionary of properties to launch tryjob."""
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001622 return self._codereview_impl.GetTryJobProperties(patchset=patchset)
tandrii8c5a3532016-11-04 07:52:02 -07001623
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001624 def __getattr__(self, attr):
1625 # This is because lots of untested code accesses Rietveld-specific stuff
1626 # directly, and it's hard to fix for sure. So, just let it work, and fix
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00001627 # on a case by case basis.
tandrii4d895502016-08-18 08:26:19 -07001628 # Note that child method defines __getattr__ as well, and forwards it here,
1629 # because _RietveldChangelistImpl is not cleaned up yet, and given
1630 # deprecation of Rietveld, it should probably be just removed.
1631 # Until that time, avoid infinite recursion by bypassing __getattr__
1632 # of implementation class.
1633 return self._codereview_impl.__getattribute__(attr)
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001634
1635
1636class _ChangelistCodereviewBase(object):
1637 """Abstract base class encapsulating codereview specifics of a changelist."""
1638 def __init__(self, changelist):
1639 self._changelist = changelist # instance of Changelist
1640
1641 def __getattr__(self, attr):
1642 # Forward methods to changelist.
1643 # TODO(tandrii): maybe clean up _GerritChangelistImpl and
1644 # _RietveldChangelistImpl to avoid this hack?
1645 return getattr(self._changelist, attr)
1646
1647 def GetStatus(self):
1648 """Apply a rough heuristic to give a simple summary of an issue's review
1649 or CQ status, assuming adherence to a common workflow.
1650
1651 Returns None if no issue for this branch, or specific string keywords.
1652 """
1653 raise NotImplementedError()
1654
1655 def GetCodereviewServer(self):
1656 """Returns server URL without end slash, like "https://codereview.com"."""
1657 raise NotImplementedError()
1658
Kenneth Russell61e2ed42017-02-15 11:47:13 -08001659 def FetchDescription(self, force=False):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001660 """Fetches and returns description from the codereview server."""
1661 raise NotImplementedError()
1662
tandrii5d48c322016-08-18 16:19:37 -07001663 @classmethod
1664 def IssueConfigKey(cls):
1665 """Returns branch setting storing issue number."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001666 raise NotImplementedError()
1667
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001668 @classmethod
tandrii5d48c322016-08-18 16:19:37 -07001669 def PatchsetConfigKey(cls):
1670 """Returns branch setting storing patchset number."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001671 raise NotImplementedError()
1672
tandrii5d48c322016-08-18 16:19:37 -07001673 @classmethod
1674 def CodereviewServerConfigKey(cls):
1675 """Returns branch setting storing codereview server."""
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001676 raise NotImplementedError()
1677
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001678 def _PostUnsetIssueProperties(self):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001679 """Which branch-specific properties to erase when unsetting issue."""
tandrii5d48c322016-08-18 16:19:37 -07001680 return []
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001681
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001682 def GetGerritObjForPresubmit(self):
1683 # None is valid return value, otherwise presubmit_support.GerritAccessor.
1684 return None
1685
dsansomee2d6fd92016-09-08 00:10:47 -07001686 def UpdateDescriptionRemote(self, description, force=False):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001687 """Update the description on codereview site."""
1688 raise NotImplementedError()
1689
Aaron Gable636b13f2017-07-14 10:42:48 -07001690 def AddComment(self, message, publish=None):
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01001691 """Posts a comment to the codereview site."""
1692 raise NotImplementedError()
1693
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07001694 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01001695 raise NotImplementedError()
1696
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001697 def CloseIssue(self):
1698 """Closes the issue."""
1699 raise NotImplementedError()
1700
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001701 def GetMostRecentPatchset(self):
1702 """Returns the most recent patchset number from the codereview site."""
1703 raise NotImplementedError()
1704
Edward Lemurf38bc172019-09-03 21:02:13 +00001705 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001706 """Fetches and applies the issue.
1707
1708 Arguments:
1709 parsed_issue_arg: instance of _ParsedIssueNumberArgument.
Edward Lemurf38bc172019-09-03 21:02:13 +00001710 nocommit: do not commit the patch, thus leave the tree dirty.
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00001711 """
1712 raise NotImplementedError()
1713
1714 @staticmethod
1715 def ParseIssueURL(parsed_url):
1716 """Parses url and returns instance of _ParsedIssueNumberArgument or None if
1717 failed."""
1718 raise NotImplementedError()
1719
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001720 def EnsureAuthenticated(self, force, refresh=False):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001721 """Best effort check that user is authenticated with codereview server.
1722
1723 Arguments:
1724 force: whether to skip confirmation questions.
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001725 refresh: whether to attempt to refresh credentials. Ignored if not
1726 applicable.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001727 """
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001728 raise NotImplementedError()
1729
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001730 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001731 """Best effort check that uploading isn't supposed to fail for predictable
1732 reasons.
1733
1734 This method should raise informative exception if uploading shouldn't
1735 proceed.
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001736
1737 Arguments:
1738 force: whether to skip confirmation questions.
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001739 """
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001740 raise NotImplementedError()
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001741
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02001742 def CMDUploadChange(self, options, git_diff_args, custom_cl_base, change):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00001743 """Uploads a change to codereview."""
1744 raise NotImplementedError()
1745
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001746 def SetCQState(self, new_state):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001747 """Updates the CQ state for the latest patchset.
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00001748
1749 Issue must have been already uploaded and known.
1750 """
1751 raise NotImplementedError()
1752
tandriie113dfd2016-10-11 10:20:12 -07001753 def CannotTriggerTryJobReason(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001754 """Returns reason (str) if unable trigger tryjobs on this CL or None."""
tandriie113dfd2016-10-11 10:20:12 -07001755 raise NotImplementedError()
1756
tandriide281ae2016-10-12 06:02:30 -07001757 def GetIssueOwner(self):
1758 raise NotImplementedError()
1759
Edward Lemur707d70b2018-02-07 00:50:14 +01001760 def GetReviewers(self):
1761 raise NotImplementedError()
1762
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001763 def GetTryJobProperties(self, patchset=None):
tandriide281ae2016-10-12 06:02:30 -07001764 raise NotImplementedError()
1765
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001766
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001767class _GerritChangelistImpl(_ChangelistCodereviewBase):
Edward Lemur934836a2019-09-09 20:16:54 +00001768 def __init__(self, changelist, codereview_host=None):
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001769 super(_GerritChangelistImpl, self).__init__(changelist)
1770 self._change_id = None
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001771 # Lazily cached values.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001772 self._gerrit_host = None # e.g. chromium-review.googlesource.com
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001773 self._gerrit_server = None # e.g. https://chromium-review.googlesource.com
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01001774 # Map from change number (issue) to its detail cache.
1775 self._detail_cache = {}
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001776
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01001777 if codereview_host is not None:
1778 assert not codereview_host.startswith('https://'), codereview_host
1779 self._gerrit_host = codereview_host
1780 self._gerrit_server = 'https://%s' % codereview_host
1781
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001782 def _GetGerritHost(self):
1783 # Lazy load of configs.
1784 self.GetCodereviewServer()
tandriie32e3ea2016-06-22 02:52:48 -07001785 if self._gerrit_host and '.' not in self._gerrit_host:
1786 # Abbreviated domain like "chromium" instead of chromium.googlesource.com.
1787 # This happens for internal stuff http://crbug.com/614312.
1788 parsed = urlparse.urlparse(self.GetRemoteUrl())
1789 if parsed.scheme == 'sso':
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001790 print('WARNING: using non-https URLs for remote is likely broken\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001791 ' Your current remote is: %s' % self.GetRemoteUrl())
tandriie32e3ea2016-06-22 02:52:48 -07001792 self._gerrit_host = '%s.googlesource.com' % self._gerrit_host
1793 self._gerrit_server = 'https://%s' % self._gerrit_host
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001794 return self._gerrit_host
1795
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001796 def _GetGitHost(self):
1797 """Returns git host to be used when uploading change to Gerrit."""
Edward Lemur298f2cf2019-02-22 21:40:39 +00001798 remote_url = self.GetRemoteUrl()
1799 if not remote_url:
1800 return None
1801 return urlparse.urlparse(remote_url).netloc
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001802
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001803 def GetCodereviewServer(self):
1804 if not self._gerrit_server:
1805 # If we're on a branch then get the server potentially associated
1806 # with that branch.
1807 if self.GetIssue():
tandrii5d48c322016-08-18 16:19:37 -07001808 self._gerrit_server = self._GitGetBranchConfigValue(
1809 self.CodereviewServerConfigKey())
1810 if self._gerrit_server:
1811 self._gerrit_host = urlparse.urlparse(self._gerrit_server).netloc
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001812 if not self._gerrit_server:
1813 # We assume repo to be hosted on Gerrit, and hence Gerrit server
1814 # has "-review" suffix for lowest level subdomain.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001815 parts = self._GetGitHost().split('.')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001816 parts[0] = parts[0] + '-review'
1817 self._gerrit_host = '.'.join(parts)
1818 self._gerrit_server = 'https://%s' % self._gerrit_host
1819 return self._gerrit_server
1820
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001821 def _GetGerritProject(self):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001822 """Returns Gerrit project name based on remote git URL."""
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001823 remote_url = self.GetRemoteUrl()
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001824 if remote_url is None:
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001825 logging.warn('can\'t detect Gerrit project.')
1826 return None
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001827 project = urlparse.urlparse(remote_url).path.strip('/')
1828 if project.endswith('.git'):
1829 project = project[:-len('.git')]
Andrii Shyshkalov1e828672018-08-23 22:34:37 +00001830 # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with
1831 # 'a/' prefix, because 'a/' prefix is used to force authentication in
1832 # gitiles/git-over-https protocol. E.g.,
1833 # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project
1834 # as
1835 # https://chromium.googlesource.com/v8/v8
1836 if project.startswith('a/'):
1837 project = project[len('a/'):]
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00001838 return project
1839
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001840 def _GerritChangeIdentifier(self):
1841 """Handy method for gerrit_util.ChangeIdentifier for a given CL.
1842
1843 Not to be confused by value of "Change-Id:" footer.
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001844 If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC.
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001845 """
Andrii Shyshkalov2d0e03c2018-08-25 04:18:09 +00001846 project = self._GetGerritProject()
1847 if project:
1848 return gerrit_util.ChangeIdentifier(project, self.GetIssue())
1849 # Fall back on still unique, but less efficient change number.
1850 return str(self.GetIssue())
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00001851
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001852 @classmethod
tandrii5d48c322016-08-18 16:19:37 -07001853 def IssueConfigKey(cls):
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00001854 return 'gerritissue'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001855
tandrii5d48c322016-08-18 16:19:37 -07001856 @classmethod
1857 def PatchsetConfigKey(cls):
1858 return 'gerritpatchset'
1859
1860 @classmethod
1861 def CodereviewServerConfigKey(cls):
1862 return 'gerritserver'
1863
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01001864 def EnsureAuthenticated(self, force, refresh=None):
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00001865 """Best effort check that user is authenticated with Gerrit server."""
tandrii@chromium.org28253532016-04-14 13:46:56 +00001866 if settings.GetGerritSkipEnsureAuthenticated():
1867 # For projects with unusual authentication schemes.
1868 # See http://crbug.com/603378.
1869 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001870
1871 # Check presence of cookies only if using cookies-based auth method.
1872 cookie_auth = gerrit_util.Authenticator.get()
1873 if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001874 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001875
Daniel Chengcf6269b2019-05-18 01:02:12 +00001876 if urlparse.urlparse(self.GetRemoteUrl()).scheme != 'https':
1877 print('WARNING: Ignoring branch %s with non-https remote %s' %
1878 (self._changelist.branch, self.GetRemoteUrl()))
1879 return
1880
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001881 # Lazy-loader to identify Gerrit and Git hosts.
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001882 self.GetCodereviewServer()
1883 git_host = self._GetGitHost()
Edward Lemur298f2cf2019-02-22 21:40:39 +00001884 assert self._gerrit_server and self._gerrit_host and git_host
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001885
1886 gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host)
1887 git_auth = cookie_auth.get_auth_header(git_host)
1888 if gerrit_auth and git_auth:
1889 if gerrit_auth == git_auth:
1890 return
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001891 all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com')
Raul Tambre80ee78e2019-05-06 22:41:05 +00001892 print(
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001893 'WARNING: You have different credentials for Gerrit and git hosts:\n'
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001894 ' %s\n'
1895 ' %s\n'
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001896 ' Consider running the following command:\n'
1897 ' git cl creds-check\n'
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001898 ' %s\n'
Raul Tambre80ee78e2019-05-06 22:41:05 +00001899 ' %s' %
Andrii Shyshkalov51acef92017-04-11 17:19:59 +02001900 (git_host, self._gerrit_host,
Andrii Shyshkalov354e1d22017-06-09 19:31:33 +02001901 ('Hint: delete creds for .googlesource.com' if all_gsrc else ''),
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001902 cookie_auth.get_new_password_message(git_host)))
1903 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01001904 confirm_or_exit('If you know what you are doing', action='continue')
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001905 return
1906 else:
1907 missing = (
Anna Henningsen4e891442017-07-06 21:40:58 +02001908 ([] if gerrit_auth else [self._gerrit_host]) +
1909 ([] if git_auth else [git_host]))
tandrii@chromium.orgfe30f182016-04-13 12:15:04 +00001910 DieWithError('Credentials for the following hosts are required:\n'
1911 ' %s\n'
1912 'These are read from %s (or legacy %s)\n'
1913 '%s' % (
1914 '\n '.join(missing),
1915 cookie_auth.get_gitcookies_path(),
1916 cookie_auth.get_netrc_path(),
1917 cookie_auth.get_new_password_message(git_host)))
1918
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001919 def EnsureCanUploadPatchset(self, force):
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001920 if not self.GetIssue():
1921 return
1922
1923 # Warm change details cache now to avoid RPCs later, reducing latency for
1924 # developers.
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001925 self._GetChangeDetail(
Andrii Shyshkalovc4a73562018-09-25 18:40:17 +00001926 ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS'])
Andrii Shyshkalov3e631422017-02-16 17:46:44 +01001927
1928 status = self._GetChangeDetail()['status']
1929 if status in ('MERGED', 'ABANDONED'):
1930 DieWithError('Change %s has been %s, new uploads are not allowed' %
1931 (self.GetIssueURL(),
1932 'submitted' if status == 'MERGED' else 'abandoned'))
1933
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001934 # TODO(vadimsh): For some reason the chunk of code below was skipped if
1935 # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'.
1936 # Apparently this check is not very important? Otherwise get_auth_email
1937 # could have been added to other implementations of Authenticator.
1938 cookies_auth = gerrit_util.Authenticator.get()
1939 if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator):
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001940 return
Vadim Shtayurab250ec12018-10-04 00:21:08 +00001941
1942 cookies_user = cookies_auth.get_auth_email(self._GetGerritHost())
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001943 if self.GetIssueOwner() == cookies_user:
1944 return
1945 logging.debug('change %s owner is %s, cookies user is %s',
1946 self.GetIssue(), self.GetIssueOwner(), cookies_user)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001947 # Maybe user has linked accounts or something like that,
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001948 # so ask what Gerrit thinks of this user.
1949 details = gerrit_util.GetAccountDetails(self._GetGerritHost(), 'self')
1950 if details['email'] == self.GetIssueOwner():
1951 return
1952 if not force:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07001953 print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit '
Andrii Shyshkalovbb86fbb2017-03-24 14:59:28 +01001954 'as %s.\n'
1955 'Uploading may fail due to lack of permissions.' %
1956 (self.GetIssue(), self.GetIssueOwner(), details['email']))
1957 confirm_or_exit(action='upload')
1958
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001959 def _PostUnsetIssueProperties(self):
1960 """Which branch-specific properties to erase when unsetting issue."""
tandrii5d48c322016-08-18 16:19:37 -07001961 return ['gerritsquashhash']
tandrii@chromium.org9b7fd712016-06-01 13:45:20 +00001962
tandrii@chromium.org37b07a72016-04-29 16:42:28 +00001963 def GetGerritObjForPresubmit(self):
1964 return presubmit_support.GerritAccessor(self._GetGerritHost())
1965
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00001966 def GetStatus(self):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00001967 """Applies a rough heuristic to give a simple summary of an issue's review
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001968 or CQ status, assuming adherence to a common workflow.
1969
1970 Returns None if no issue for this branch, or one of the following keywords:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001971 * 'error' - error from review tool (including deleted issues)
1972 * 'unsent' - no reviewers added
1973 * 'waiting' - waiting for review
1974 * 'reply' - waiting for uploader to reply to review
1975 * 'lgtm' - Code-Review label has been set
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00001976 * 'dry-run' - dry-running in the CQ
1977 * 'commit' - in the CQ
Aaron Gable9ab38c62017-04-06 14:36:33 -07001978 * 'closed' - successfully submitted or abandoned
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001979 """
1980 if not self.GetIssue():
1981 return None
1982
1983 try:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001984 data = self._GetChangeDetail([
1985 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE'])
Aaron Gablea45ee112016-11-22 15:14:38 -08001986 except (httplib.HTTPException, GerritChangeNotExists):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001987 return 'error'
1988
tandrii@chromium.org5e1bf382016-05-17 08:43:24 +00001989 if data['status'] in ('ABANDONED', 'MERGED'):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00001990 return 'closed'
1991
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001992 cq_label = data['labels'].get('Commit-Queue', {})
1993 max_cq_vote = 0
1994 for vote in cq_label.get('all', []):
1995 max_cq_vote = max(max_cq_vote, vote.get('value', 0))
1996 if max_cq_vote == 2:
Aaron Gable9ab38c62017-04-06 14:36:33 -07001997 return 'commit'
Andrii Shyshkalovb8268ca2019-04-03 23:33:44 +00001998 if max_cq_vote == 1:
1999 return 'dry-run'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002000
Aaron Gable9ab38c62017-04-06 14:36:33 -07002001 if data['labels'].get('Code-Review', {}).get('approved'):
2002 return 'lgtm'
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002003
2004 if not data.get('reviewers', {}).get('REVIEWER', []):
2005 return 'unsent'
2006
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01002007 owner = data['owner'].get('_account_id')
Aaron Gable9ab38c62017-04-06 14:36:33 -07002008 messages = sorted(data.get('messages', []), key=lambda m: m.get('updated'))
2009 last_message_author = messages.pop().get('author', {})
2010 while last_message_author:
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01002011 if last_message_author.get('email') == COMMIT_BOT_EMAIL:
2012 # Ignore replies from CQ.
Aaron Gable9ab38c62017-04-06 14:36:33 -07002013 last_message_author = messages.pop().get('author', {})
Andrii Shyshkalov33e88a42017-01-27 14:45:30 +01002014 continue
Aaron Gable9ab38c62017-04-06 14:36:33 -07002015 if last_message_author.get('_account_id') == owner:
2016 # Most recent message was by owner.
2017 return 'waiting'
2018 else:
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002019 # Some reply from non-owner.
2020 return 'reply'
Aaron Gable9ab38c62017-04-06 14:36:33 -07002021
2022 # Somehow there are no messages even though there are reviewers.
2023 return 'unsent'
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002024
2025 def GetMostRecentPatchset(self):
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002026 data = self._GetChangeDetail(['CURRENT_REVISION'])
Aaron Gablee8856ee2017-12-07 12:41:46 -08002027 patchset = data['revisions'][data['current_revision']]['_number']
2028 self.SetPatchset(patchset)
2029 return patchset
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002030
Kenneth Russell61e2ed42017-02-15 11:47:13 -08002031 def FetchDescription(self, force=False):
2032 data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'],
2033 no_cache=force)
tandrii@chromium.org2d3da632016-04-25 19:23:27 +00002034 current_rev = data['current_revision']
Dan Beamcf6df902018-11-08 01:48:37 +00002035 return data['revisions'][current_rev]['commit']['message'].encode(
2036 'utf-8', 'ignore')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002037
dsansomee2d6fd92016-09-08 00:10:47 -07002038 def UpdateDescriptionRemote(self, description, force=False):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002039 if gerrit_util.HasPendingChangeEdit(
2040 self._GetGerritHost(), self._GerritChangeIdentifier()):
dsansomee2d6fd92016-09-08 00:10:47 -07002041 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002042 confirm_or_exit(
dsansomee2d6fd92016-09-08 00:10:47 -07002043 'The description cannot be modified while the issue has a pending '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002044 'unpublished edit. Either publish the edit in the Gerrit web UI '
2045 'or delete it.\n\n', action='delete the unpublished edit')
dsansomee2d6fd92016-09-08 00:10:47 -07002046
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002047 gerrit_util.DeletePendingChangeEdit(
2048 self._GetGerritHost(), self._GerritChangeIdentifier())
2049 gerrit_util.SetCommitMessage(
2050 self._GetGerritHost(), self._GerritChangeIdentifier(),
2051 description, notify='NONE')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002052
Aaron Gable636b13f2017-07-14 10:42:48 -07002053 def AddComment(self, message, publish=None):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002054 gerrit_util.SetReview(
2055 self._GetGerritHost(), self._GerritChangeIdentifier(),
2056 msg=message, ready=publish)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01002057
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07002058 def GetCommentsSummary(self, readable=True):
Andrii Shyshkalov5a0cf202017-03-17 16:14:59 +01002059 # DETAILED_ACCOUNTS is to get emails in accounts.
Quinten Yearsley0e617c02019-02-20 00:37:03 +00002060 # CURRENT_REVISION is included to get the latest patchset so that
2061 # only the robot comments from the latest patchset can be shown.
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07002062 messages = self._GetChangeDetail(
Quinten Yearsley0e617c02019-02-20 00:37:03 +00002063 options=['MESSAGES', 'DETAILED_ACCOUNTS',
2064 'CURRENT_REVISION']).get('messages', [])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07002065 file_comments = gerrit_util.GetChangeComments(
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002066 self._GetGerritHost(), self._GerritChangeIdentifier())
Quinten Yearsley0e617c02019-02-20 00:37:03 +00002067 robot_file_comments = gerrit_util.GetChangeRobotComments(
2068 self._GetGerritHost(), self._GerritChangeIdentifier())
2069
2070 # Add the robot comments onto the list of comments, but only
2071 # keep those that are from the latest pachset.
2072 latest_patch_set = self.GetMostRecentPatchset()
2073 for path, robot_comments in robot_file_comments.iteritems():
2074 line_comments = file_comments.setdefault(path, [])
2075 line_comments.extend(
2076 [c for c in robot_comments if c['patch_set'] == latest_patch_set])
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07002077
2078 # Build dictionary of file comments for easy access and sorting later.
2079 # {author+date: {path: {patchset: {line: url+message}}}}
2080 comments = collections.defaultdict(
2081 lambda: collections.defaultdict(lambda: collections.defaultdict(dict)))
2082 for path, line_comments in file_comments.iteritems():
2083 for comment in line_comments:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00002084 tag = comment.get('tag', '')
2085 if tag.startswith('autogenerated') and 'robot_id' not in comment:
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07002086 continue
2087 key = (comment['author']['email'], comment['updated'])
2088 if comment.get('side', 'REVISION') == 'PARENT':
2089 patchset = 'Base'
2090 else:
2091 patchset = 'PS%d' % comment['patch_set']
2092 line = comment.get('line', 0)
2093 url = ('https://%s/c/%s/%s/%s#%s%s' %
2094 (self._GetGerritHost(), self.GetIssue(), comment['patch_set'], path,
2095 'b' if comment.get('side') == 'PARENT' else '',
2096 str(line) if line else ''))
2097 comments[key][path][patchset][line] = (url, comment['message'])
2098
Quinten Yearsley0e617c02019-02-20 00:37:03 +00002099 summaries = []
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07002100 for msg in messages:
Quinten Yearsley0e617c02019-02-20 00:37:03 +00002101 summary = self._BuildCommentSummary(msg, comments, readable)
2102 if summary:
2103 summaries.append(summary)
2104 return summaries
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07002105
Quinten Yearsley0e617c02019-02-20 00:37:03 +00002106 @staticmethod
2107 def _BuildCommentSummary(msg, comments, readable):
2108 key = (msg['author']['email'], msg['date'])
2109 # Don't bother showing autogenerated messages that don't have associated
2110 # file or line comments. this will filter out most autogenerated
2111 # messages, but will keep robot comments like those from Tricium.
2112 is_autogenerated = msg.get('tag', '').startswith('autogenerated')
2113 if is_autogenerated and not comments.get(key):
2114 return None
2115 message = msg['message']
2116 # Gerrit spits out nanoseconds.
2117 assert len(msg['date'].split('.')[-1]) == 9
2118 date = datetime.datetime.strptime(msg['date'][:-3],
2119 '%Y-%m-%d %H:%M:%S.%f')
2120 if key in comments:
2121 message += '\n'
2122 for path, patchsets in sorted(comments.get(key, {}).items()):
2123 if readable:
2124 message += '\n%s' % path
2125 for patchset, lines in sorted(patchsets.items()):
2126 for line, (url, content) in sorted(lines.items()):
2127 if line:
2128 line_str = 'Line %d' % line
2129 path_str = '%s:%d:' % (path, line)
2130 else:
2131 line_str = 'File comment'
2132 path_str = '%s:0:' % path
2133 if readable:
2134 message += '\n %s, %s: %s' % (patchset, line_str, url)
2135 message += '\n %s\n' % content
2136 else:
2137 message += '\n%s ' % path_str
2138 message += '\n%s\n' % content
2139
2140 return _CommentSummary(
2141 date=date,
2142 message=message,
2143 sender=msg['author']['email'],
2144 autogenerated=is_autogenerated,
2145 # These could be inferred from the text messages and correlated with
2146 # Code-Review label maximum, however this is not reliable.
2147 # Leaving as is until the need arises.
2148 approval=False,
2149 disapproval=False,
2150 )
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01002151
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002152 def CloseIssue(self):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002153 gerrit_util.AbandonChange(
2154 self._GetGerritHost(), self._GerritChangeIdentifier(), msg='')
tandrii@chromium.orgaa5ced12016-03-29 09:41:14 +00002155
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002156 def SubmitIssue(self, wait_for_merge=True):
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002157 gerrit_util.SubmitChange(
2158 self._GetGerritHost(), self._GerritChangeIdentifier(),
2159 wait_for_merge=wait_for_merge)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00002160
Andrii Shyshkalovb7214602018-08-22 23:20:26 +00002161 def _GetChangeDetail(self, options=None, no_cache=False):
2162 """Returns details of associated Gerrit change and caching results.
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002163
2164 If fresh data is needed, set no_cache=True which will clear cache and
2165 thus new data will be fetched from Gerrit.
2166 """
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002167 options = options or []
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002168 assert self.GetIssue(), 'issue is required to query Gerrit'
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002169
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01002170 # Optimization to avoid multiple RPCs:
2171 if (('CURRENT_REVISION' in options or 'ALL_REVISIONS' in options) and
2172 'CURRENT_COMMIT' not in options):
2173 options.append('CURRENT_COMMIT')
2174
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002175 # Normalize issue and options for consistent keys in cache.
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002176 cache_key = str(self.GetIssue())
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002177 options = [o.upper() for o in options]
2178
2179 # Check in cache first unless no_cache is True.
2180 if no_cache:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002181 self._detail_cache.pop(cache_key, None)
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002182 else:
2183 options_set = frozenset(options)
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002184 for cached_options_set, data in self._detail_cache.get(cache_key, []):
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002185 # Assumption: data fetched before with extra options is suitable
2186 # for return for a smaller set of options.
2187 # For example, if we cached data for
2188 # options=[CURRENT_REVISION, DETAILED_FOOTERS]
2189 # and request is for options=[CURRENT_REVISION],
2190 # THEN we can return prior cached data.
2191 if options_set.issubset(cached_options_set):
2192 return data
2193
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002194 try:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002195 data = gerrit_util.GetChangeDetail(
2196 self._GetGerritHost(), self._GerritChangeIdentifier(), options)
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002197 except gerrit_util.GerritError as e:
2198 if e.http_status == 404:
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002199 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Andrii Shyshkalovc6c8b4c2016-11-09 20:51:20 +01002200 raise
Andrii Shyshkalov258e0a62017-01-24 16:50:57 +01002201
Andrii Shyshkalov03e0ed22018-08-28 19:39:30 +00002202 self._detail_cache.setdefault(cache_key, []).append(
2203 (frozenset(options), data))
tandriic2405f52016-10-10 08:13:15 -07002204 return data
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002205
Andrii Shyshkalovcc5f17e2018-08-22 23:35:59 +00002206 def _GetChangeCommit(self):
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002207 assert self.GetIssue(), 'issue must be set to query Gerrit'
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002208 try:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002209 data = gerrit_util.GetChangeCommit(
2210 self._GetGerritHost(), self._GerritChangeIdentifier())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002211 except gerrit_util.GerritError as e:
2212 if e.http_status == 404:
Andrii Shyshkalove2633162018-08-27 23:50:31 +00002213 raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer())
Aaron Gable6f5a8d92017-04-18 14:49:05 -07002214 raise
agable32978d92016-11-01 12:55:02 -07002215 return data
2216
Karen Qian40c19422019-03-13 21:28:29 +00002217 def _IsCqConfigured(self):
2218 detail = self._GetChangeDetail(['LABELS'])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002219 if u'Commit-Queue' not in detail.get('labels', {}):
Karen Qian40c19422019-03-13 21:28:29 +00002220 return False
2221 # TODO(crbug/753213): Remove temporary hack
2222 if ('https://chromium.googlesource.com/chromium/src' ==
2223 self._changelist.GetRemoteUrl() and
2224 detail['branch'].startswith('refs/branch-heads/')):
2225 return False
2226 return True
2227
Olivier Robin75ee7252018-04-13 10:02:56 +02002228 def CMDLand(self, force, bypass_hooks, verbose, parallel):
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002229 if git_common.is_dirty_git_tree('land'):
2230 return 1
Karen Qian40c19422019-03-13 21:28:29 +00002231
tandriid60367b2016-06-22 05:25:12 -07002232 detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS'])
Karen Qian40c19422019-03-13 21:28:29 +00002233 if not force and self._IsCqConfigured():
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00002234 confirm_or_exit('\nIt seems this repository has a CQ, '
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002235 'which can test and land changes for you. '
2236 'Are you sure you wish to bypass it?\n',
2237 action='bypass CQ')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002238 differs = True
tandriic4344b52016-08-29 06:04:54 -07002239 last_upload = self._GitGetBranchConfigValue('gerritsquashhash')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002240 # Note: git diff outputs nothing if there is no diff.
2241 if not last_upload or RunGit(['diff', last_upload]).strip():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002242 print('WARNING: Some changes from local branch haven\'t been uploaded.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002243 else:
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002244 if detail['current_revision'] == last_upload:
2245 differs = False
2246 else:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002247 print('WARNING: Local branch contents differ from latest uploaded '
2248 'patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002249 if differs:
2250 if not force:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002251 confirm_or_exit(
2252 'Do you want to submit latest Gerrit patchset and bypass hooks?\n',
2253 action='submit')
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002254 print('WARNING: Bypassing hooks and submitting latest uploaded patchset.')
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002255 elif not bypass_hooks:
2256 hook_results = self.RunHook(
2257 committing=True,
2258 may_prompt=not force,
2259 verbose=verbose,
Olivier Robin75ee7252018-04-13 10:02:56 +02002260 change=self.GetChange(self.GetCommonAncestorWithUpstream(), None),
2261 parallel=parallel)
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002262 if not hook_results.should_continue():
2263 return 1
2264
2265 self.SubmitIssue(wait_for_merge=True)
2266 print('Issue %s has been submitted.' % self.GetIssueURL())
agable32978d92016-11-01 12:55:02 -07002267 links = self._GetChangeCommit().get('web_links', [])
2268 for link in links:
Aaron Gable02cdbb42016-12-13 16:24:25 -08002269 if link.get('name') == 'gitiles' and link.get('url'):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002270 print('Landed as: %s' % link.get('url'))
agable32978d92016-11-01 12:55:02 -07002271 break
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002272 return 0
2273
Edward Lemurf38bc172019-09-03 21:02:13 +00002274 def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force):
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002275 assert parsed_issue_arg.valid
2276
2277 self._changelist.issue = parsed_issue_arg.issue
2278
2279 if parsed_issue_arg.hostname:
2280 self._gerrit_host = parsed_issue_arg.hostname
2281 self._gerrit_server = 'https://%s' % self._gerrit_host
2282
tandriic2405f52016-10-10 08:13:15 -07002283 try:
2284 detail = self._GetChangeDetail(['ALL_REVISIONS'])
Aaron Gablea45ee112016-11-22 15:14:38 -08002285 except GerritChangeNotExists as e:
tandriic2405f52016-10-10 08:13:15 -07002286 DieWithError(str(e))
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002287
2288 if not parsed_issue_arg.patchset:
2289 # Use current revision by default.
2290 revision_info = detail['revisions'][detail['current_revision']]
2291 patchset = int(revision_info['_number'])
2292 else:
2293 patchset = parsed_issue_arg.patchset
2294 for revision_info in detail['revisions'].itervalues():
2295 if int(revision_info['_number']) == parsed_issue_arg.patchset:
2296 break
2297 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002298 DieWithError('Couldn\'t find patchset %i in change %i' %
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002299 (parsed_issue_arg.patchset, self.GetIssue()))
2300
Aaron Gable697a91b2018-01-19 15:20:15 -08002301 remote_url = self._changelist.GetRemoteUrl()
2302 if remote_url.endswith('.git'):
2303 remote_url = remote_url[:-len('.git')]
erikchen0d14d0d2018-08-28 18:57:09 +00002304 remote_url = remote_url.rstrip('/')
2305
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002306 fetch_info = revision_info['fetch']['http']
erikchen0d14d0d2018-08-28 18:57:09 +00002307 fetch_info['url'] = fetch_info['url'].rstrip('/')
Aaron Gable697a91b2018-01-19 15:20:15 -08002308
2309 if remote_url != fetch_info['url']:
2310 DieWithError('Trying to patch a change from %s but this repo appears '
2311 'to be %s.' % (fetch_info['url'], remote_url))
2312
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002313 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
Aaron Gable9387b4f2017-06-08 10:50:03 -07002314
Aaron Gable62619a32017-06-16 08:22:09 -07002315 if force:
2316 RunGit(['reset', '--hard', 'FETCH_HEAD'])
2317 print('Checked out commit for change %i patchset %i locally' %
2318 (parsed_issue_arg.issue, patchset))
Stefan Zager2d5f0392017-10-10 15:17:53 -07002319 elif nocommit:
2320 RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD'])
2321 print('Patch applied to index.')
Aaron Gable62619a32017-06-16 08:22:09 -07002322 else:
Aaron Gable9387b4f2017-06-08 10:50:03 -07002323 RunGit(['cherry-pick', 'FETCH_HEAD'])
2324 print('Committed patch for change %i patchset %i locally.' %
Aaron Gable62619a32017-06-16 08:22:09 -07002325 (parsed_issue_arg.issue, patchset))
2326 print('Note: this created a local commit which does not have '
2327 'the same hash as the one uploaded for review. This will make '
2328 'uploading changes based on top of this branch difficult.\n'
2329 'If you want to do that, use "git cl patch --force" instead.')
2330
Stefan Zagerd08043c2017-10-12 12:07:02 -07002331 if self.GetBranch():
2332 self.SetIssue(parsed_issue_arg.issue)
2333 self.SetPatchset(patchset)
2334 fetched_hash = RunGit(['rev-parse', 'FETCH_HEAD']).strip()
2335 self._GitSetBranchConfigValue('last-upload-hash', fetched_hash)
2336 self._GitSetBranchConfigValue('gerritsquashhash', fetched_hash)
2337 else:
2338 print('WARNING: You are in detached HEAD state.\n'
2339 'The patch has been applied to your checkout, but you will not be '
2340 'able to upload a new patch set to the gerrit issue.\n'
2341 'Try using the \'-b\' option if you would like to work on a '
2342 'branch and/or upload a new patch set.')
2343
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002344 return 0
2345
2346 @staticmethod
2347 def ParseIssueURL(parsed_url):
2348 if not parsed_url.scheme or not parsed_url.scheme.startswith('http'):
2349 return None
Aaron Gable01b91062017-08-24 17:48:40 -07002350 # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]]
2351 # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]]
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002352 # Short urls like https://domain/<issue_number> can be used, but don't allow
2353 # specifying the patchset (you'd 404), but we allow that here.
2354 if parsed_url.path == '/':
2355 part = parsed_url.fragment
2356 else:
2357 part = parsed_url.path
Bruce Dawson9c062012019-05-02 19:20:28 +00002358 match = re.match(r'(/c(/.*/\+)?)?/(\d+)(/(\d+)?/?)?$', part)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002359 if match:
2360 return _ParsedIssueNumberArgument(
Aaron Gable01b91062017-08-24 17:48:40 -07002361 issue=int(match.group(3)),
2362 patchset=int(match.group(5)) if match.group(5) else None,
Edward Lemurf38bc172019-09-03 21:02:13 +00002363 hostname=parsed_url.netloc)
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00002364 return None
2365
tandrii16e0b4e2016-06-07 10:34:28 -07002366 def _GerritCommitMsgHookCheck(self, offer_removal):
2367 hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
2368 if not os.path.exists(hook):
2369 return
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002370 # Crude attempt to distinguish Gerrit Codereview hook from a potentially
2371 # custom developer-made one.
tandrii16e0b4e2016-06-07 10:34:28 -07002372 data = gclient_utils.FileRead(hook)
2373 if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data):
2374 return
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002375 print('WARNING: You have Gerrit commit-msg hook installed.\n'
qyearsley12fa6ff2016-08-24 09:18:40 -07002376 'It is not necessary for uploading with git cl in squash mode, '
tandrii16e0b4e2016-06-07 10:34:28 -07002377 'and may interfere with it in subtle ways.\n'
2378 'We recommend you remove the commit-msg hook.')
2379 if offer_removal:
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002380 if ask_for_explicit_yes('Do you want to remove it now?'):
tandrii16e0b4e2016-06-07 10:34:28 -07002381 gclient_utils.rm_file_or_tree(hook)
2382 print('Gerrit commit-msg hook removed.')
2383 else:
2384 print('OK, will keep Gerrit commit-msg hook in place.')
2385
Edward Lemur1b52d872019-05-09 21:12:12 +00002386 def _CleanUpOldTraces(self):
2387 """Keep only the last |MAX_TRACES| traces."""
2388 try:
2389 traces = sorted([
2390 os.path.join(TRACES_DIR, f)
2391 for f in os.listdir(TRACES_DIR)
2392 if (os.path.isfile(os.path.join(TRACES_DIR, f))
2393 and not f.startswith('tmp'))
2394 ])
2395 traces_to_delete = traces[:-MAX_TRACES]
2396 for trace in traces_to_delete:
Daniel Chengcf6269b2019-05-18 01:02:12 +00002397 os.remove(trace)
Edward Lemur1b52d872019-05-09 21:12:12 +00002398 except OSError:
2399 print('WARNING: Failed to remove old git traces from\n'
2400 ' %s'
2401 'Consider removing them manually.' % TRACES_DIR)
Edward Lemurdc8e23d2019-05-07 00:45:48 +00002402
Edward Lemur5737f022019-05-17 01:24:00 +00002403 def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata):
Edward Lemur1b52d872019-05-09 21:12:12 +00002404 """Zip and write the git push traces stored in traces_dir."""
2405 gclient_utils.safe_makedirs(TRACES_DIR)
Edward Lemur1b52d872019-05-09 21:12:12 +00002406 traces_zip = trace_name + '-traces'
2407 traces_readme = trace_name + '-README'
Michael Mosse7f0b4c2019-05-08 04:36:24 +00002408 # Create a temporary dir to store git config and gitcookies in. It will be
2409 # compressed and stored next to the traces.
2410 git_info_dir = tempfile.mkdtemp()
Edward Lemur1b52d872019-05-09 21:12:12 +00002411 git_info_zip = trace_name + '-git-info'
2412
Edward Lemur5737f022019-05-17 01:24:00 +00002413 git_push_metadata['now'] = datetime_now().strftime('%c')
Eric Boren67c48202019-05-30 16:52:51 +00002414 if sys.stdin.encoding and sys.stdin.encoding != 'utf-8':
sangwoo.ko7a614332019-05-22 02:46:19 +00002415 git_push_metadata['now'] = git_push_metadata['now'].decode(
2416 sys.stdin.encoding)
2417
Edward Lemur1b52d872019-05-09 21:12:12 +00002418 git_push_metadata['trace_name'] = trace_name
2419 gclient_utils.FileWrite(
2420 traces_readme, TRACES_README_FORMAT % git_push_metadata)
2421
2422 # Keep only the first 6 characters of the git hashes on the packet
2423 # trace. This greatly decreases size after compression.
2424 packet_traces = os.path.join(traces_dir, 'trace-packet')
2425 if os.path.isfile(packet_traces):
2426 contents = gclient_utils.FileRead(packet_traces)
2427 gclient_utils.FileWrite(
2428 packet_traces, GIT_HASH_RE.sub(r'\1', contents))
2429 shutil.make_archive(traces_zip, 'zip', traces_dir)
2430
2431 # Collect and compress the git config and gitcookies.
2432 git_config = RunGit(['config', '-l'])
2433 gclient_utils.FileWrite(
2434 os.path.join(git_info_dir, 'git-config'),
2435 git_config)
2436
2437 cookie_auth = gerrit_util.Authenticator.get()
2438 if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator):
2439 gitcookies_path = cookie_auth.get_gitcookies_path()
2440 if os.path.isfile(gitcookies_path):
2441 gitcookies = gclient_utils.FileRead(gitcookies_path)
2442 gclient_utils.FileWrite(
2443 os.path.join(git_info_dir, 'gitcookies'),
2444 GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies))
2445 shutil.make_archive(git_info_zip, 'zip', git_info_dir)
2446
Edward Lemur1b52d872019-05-09 21:12:12 +00002447 gclient_utils.rmtree(git_info_dir)
2448
2449 def _RunGitPushWithTraces(
2450 self, change_desc, refspec, refspec_opts, git_push_metadata):
2451 """Run git push and collect the traces resulting from the execution."""
2452 # Create a temporary directory to store traces in. Traces will be compressed
2453 # and stored in a 'traces' dir inside depot_tools.
2454 traces_dir = tempfile.mkdtemp()
Edward Lemur5737f022019-05-17 01:24:00 +00002455 trace_name = os.path.join(
2456 TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f'))
Edward Lemur0f58ae42019-04-30 17:24:12 +00002457
2458 env = os.environ.copy()
2459 env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy'
2460 env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Jonathan Nieder9779b142019-05-29 23:19:29 +00002461 env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event')
Edward Lemur0f58ae42019-04-30 17:24:12 +00002462 env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl')
2463 env['GIT_TRACE_CURL_NO_DATA'] = '1'
2464 env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet')
2465
2466 try:
2467 push_returncode = 0
Edward Lemur1b52d872019-05-09 21:12:12 +00002468 remote_url = self.GetRemoteUrl()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002469 before_push = time_time()
2470 push_stdout = gclient_utils.CheckCallAndFilter(
Edward Lemur1b52d872019-05-09 21:12:12 +00002471 ['git', 'push', remote_url, refspec],
Edward Lemur0f58ae42019-04-30 17:24:12 +00002472 env=env,
2473 print_stdout=True,
2474 # Flush after every line: useful for seeing progress when running as
2475 # recipe.
2476 filter_fn=lambda _: sys.stdout.flush())
2477 except subprocess2.CalledProcessError as e:
2478 push_returncode = e.returncode
2479 DieWithError('Failed to create a change. Please examine output above '
2480 'for the reason of the failure.\n'
2481 'Hint: run command below to diagnose common Git/Gerrit '
2482 'credential problems:\n'
Edward Lemur5737f022019-05-17 01:24:00 +00002483 ' git cl creds-check\n'
2484 '\n'
2485 'If git-cl is not working correctly, file a bug under the '
2486 'Infra>SDK component including the files below.\n'
2487 'Review the files before upload, since they might contain '
2488 'sensitive information.\n'
2489 'Set the Restrict-View-Google label so that they are not '
2490 'publicly accessible.\n'
2491 + TRACES_MESSAGE % {'trace_name': trace_name},
Edward Lemur0f58ae42019-04-30 17:24:12 +00002492 change_desc)
2493 finally:
2494 execution_time = time_time() - before_push
2495 metrics.collector.add_repeated('sub_commands', {
2496 'command': 'git push',
2497 'execution_time': execution_time,
2498 'exit_code': push_returncode,
2499 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts),
2500 })
2501
Edward Lemur1b52d872019-05-09 21:12:12 +00002502 git_push_metadata['execution_time'] = execution_time
2503 git_push_metadata['exit_code'] = push_returncode
Edward Lemur5737f022019-05-17 01:24:00 +00002504 self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata)
Edward Lemur0f58ae42019-04-30 17:24:12 +00002505
Edward Lemur1b52d872019-05-09 21:12:12 +00002506 self._CleanUpOldTraces()
Edward Lemur0f58ae42019-04-30 17:24:12 +00002507 gclient_utils.rmtree(traces_dir)
2508
2509 return push_stdout
2510
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002511 def CMDUploadChange(self, options, git_diff_args, custom_cl_base, change):
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002512 """Upload the current branch to Gerrit."""
Mike Frysingera989d552019-08-14 20:51:23 +00002513 if options.squash is None:
tandriia60502f2016-06-20 02:01:53 -07002514 # Load default for user, repo, squash=true, in this order.
2515 options.squash = settings.GetSquashGerritUploads()
tandrii26f3e4e2016-06-10 08:37:04 -07002516
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002517 remote, remote_branch = self.GetRemoteBranch()
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01002518 branch = GetTargetRef(remote, remote_branch, options.target_branch)
Aaron Gableb56ad332017-01-06 15:24:31 -08002519 # This may be None; default fallback value is determined in logic below.
2520 title = options.title
2521
Dominic Battre7d1c4842017-10-27 09:17:28 +02002522 # Extract bug number from branch name.
2523 bug = options.bug
2524 match = re.match(r'(?:bug|fix)[_-]?(\d+)', self.GetBranch())
2525 if not bug and match:
2526 bug = match.group(1)
2527
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002528 if options.squash:
tandrii16e0b4e2016-06-07 10:34:28 -07002529 self._GerritCommitMsgHookCheck(offer_removal=not options.force)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002530 if self.GetIssue():
2531 # Try to get the message from a previous upload.
2532 message = self.GetDescription()
2533 if not message:
2534 DieWithError(
Aaron Gablea45ee112016-11-22 15:14:38 -08002535 'failed to fetch description from current Gerrit change %d\n'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002536 '%s' % (self.GetIssue(), self.GetIssueURL()))
Aaron Gableb56ad332017-01-06 15:24:31 -08002537 if not title:
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002538 if options.message:
Aaron Gable7303dcb2017-06-07 14:17:32 -07002539 # When uploading a subsequent patchset, -m|--message is taken
2540 # as the patchset title if --title was not provided.
2541 title = options.message.strip()
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002542 else:
2543 default_title = RunGit(
2544 ['show', '-s', '--format=%s', 'HEAD']).strip()
Aaron Gable7303dcb2017-06-07 14:17:32 -07002545 if options.force:
2546 title = default_title
2547 else:
2548 title = ask_for_data(
2549 'Title for patchset [%s]: ' % default_title) or default_title
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002550 change_id = self._GetChangeDetail()['change_id']
2551 while True:
2552 footer_change_ids = git_footers.get_footer_change_id(message)
2553 if footer_change_ids == [change_id]:
2554 break
2555 if not footer_change_ids:
2556 message = git_footers.add_footer_change_id(message, change_id)
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002557 print('WARNING: appended missing Change-Id to change description.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002558 continue
2559 # There is already a valid footer but with different or several ids.
2560 # Doing this automatically is non-trivial as we don't want to lose
2561 # existing other footers, yet we want to append just 1 desired
2562 # Change-Id. Thus, just create a new footer, but let user verify the
2563 # new description.
2564 message = '%s\n\nChange-Id: %s' % (message, change_id)
2565 print(
Aaron Gablea45ee112016-11-22 15:14:38 -08002566 'WARNING: change %s has Change-Id footer(s):\n'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002567 ' %s\n'
Aaron Gablea45ee112016-11-22 15:14:38 -08002568 'but change has Change-Id %s, according to Gerrit.\n'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002569 'Please, check the proposed correction to the description, '
2570 'and edit it if necessary but keep the "Change-Id: %s" footer\n'
2571 % (self.GetIssue(), '\n '.join(footer_change_ids), change_id,
2572 change_id))
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002573 confirm_or_exit(action='edit')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002574 if not options.force:
2575 change_desc = ChangeDescription(message)
Dominic Battre7d1c4842017-10-27 09:17:28 +02002576 change_desc.prompt(bug=bug)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002577 message = change_desc.description
2578 if not message:
2579 DieWithError("Description is empty. Aborting...")
2580 # Continue the while loop.
2581 # Sanity check of this code - we should end up with proper message
2582 # footer.
2583 assert [change_id] == git_footers.get_footer_change_id(message)
2584 change_desc = ChangeDescription(message)
Aaron Gableb56ad332017-01-06 15:24:31 -08002585 else: # if not self.GetIssue()
2586 if options.message:
2587 message = options.message
2588 else:
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002589 message = _create_description_from_log(git_diff_args)
Aaron Gableb56ad332017-01-06 15:24:31 -08002590 if options.title:
2591 message = options.title + '\n\n' + message
2592 change_desc = ChangeDescription(message)
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002593
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002594 if not options.force:
Dominic Battre7d1c4842017-10-27 09:17:28 +02002595 change_desc.prompt(bug=bug)
Aaron Gableb56ad332017-01-06 15:24:31 -08002596 # On first upload, patchset title is always this string, while
2597 # --title flag gets converted to first line of message.
2598 title = 'Initial upload'
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002599 if not change_desc.description:
2600 DieWithError("Description is empty. Aborting...")
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002601 change_ids = git_footers.get_footer_change_id(change_desc.description)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002602 if len(change_ids) > 1:
2603 DieWithError('too many Change-Id footers, at most 1 allowed.')
2604 if not change_ids:
2605 # Generate the Change-Id automatically.
Andrii Shyshkalov8c90d032017-04-19 21:27:26 +02002606 change_desc.set_description(git_footers.add_footer_change_id(
2607 change_desc.description,
2608 GenerateGerritChangeId(change_desc.description)))
2609 change_ids = git_footers.get_footer_change_id(change_desc.description)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002610 assert len(change_ids) == 1
2611 change_id = change_ids[0]
2612
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002613 if options.reviewers or options.tbrs or options.add_owners_to:
2614 change_desc.update_reviewers(options.reviewers, options.tbrs,
2615 options.add_owners_to, change)
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00002616 if options.preserve_tryjobs:
2617 change_desc.set_preserve_tryjobs()
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002618
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002619 remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch())
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002620 parent = self._ComputeParent(remote, upstream_branch, custom_cl_base,
2621 options.force, change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002622 tree = RunGit(['rev-parse', 'HEAD:']).strip()
Aaron Gable9a03ae02017-11-03 11:31:07 -07002623 with tempfile.NamedTemporaryFile(delete=False) as desc_tempfile:
2624 desc_tempfile.write(change_desc.description)
2625 desc_tempfile.close()
2626 ref_to_push = RunGit(['commit-tree', tree, '-p', parent,
2627 '-F', desc_tempfile.name]).strip()
2628 os.remove(desc_tempfile.name)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002629 else:
2630 change_desc = ChangeDescription(
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002631 options.message or _create_description_from_log(git_diff_args))
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002632 if not change_desc.description:
2633 DieWithError("Description is empty. Aborting...")
2634
2635 if not git_footers.get_footer_change_id(change_desc.description):
2636 DownloadGerritHook(False)
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002637 change_desc.set_description(
2638 self._AddChangeIdToCommitMessage(options, git_diff_args))
Robert Iannuccidb02dd02017-04-19 12:18:20 -07002639 if options.reviewers or options.tbrs or options.add_owners_to:
2640 change_desc.update_reviewers(options.reviewers, options.tbrs,
2641 options.add_owners_to, change)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002642 ref_to_push = 'HEAD'
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002643 # For no-squash mode, we assume the remote called "origin" is the one we
2644 # want. It is not worthwhile to support different workflows for
2645 # no-squash mode.
2646 parent = 'origin/%s' % branch
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002647 change_id = git_footers.get_footer_change_id(change_desc.description)[0]
2648
2649 assert change_desc
Andrii Shyshkalovd9fdc1f2018-09-27 02:13:09 +00002650 SaveDescriptionBackup(change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002651 commits = RunGitSilent(['rev-list', '%s..%s' % (parent,
2652 ref_to_push)]).splitlines()
2653 if len(commits) > 1:
2654 print('WARNING: This will upload %d commits. Run the following command '
2655 'to see which commits will be uploaded: ' % len(commits))
2656 print('git log %s..%s' % (parent, ref_to_push))
2657 print('You can also use `git squash-branch` to squash these into a '
2658 'single commit.')
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01002659 confirm_or_exit(action='upload')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002660
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002661 if options.reviewers or options.tbrs or options.add_owners_to:
2662 change_desc.update_reviewers(options.reviewers, options.tbrs,
2663 options.add_owners_to, change)
2664
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002665 reviewers = sorted(change_desc.get_reviewers())
2666 # Add cc's from the CC_LIST and --cc flag (if any).
2667 if not options.private and not options.no_autocc:
2668 cc = self.GetCCList().split(',')
2669 else:
2670 cc = []
2671 if options.cc:
2672 cc.extend(options.cc)
2673 cc = filter(None, [email.strip() for email in cc])
2674 if change_desc.get_cced():
2675 cc.extend(change_desc.get_cced())
Andrii Shyshkalov0da5e8f2018-10-30 17:29:18 +00002676 if self._GetGerritHost() == 'chromium-review.googlesource.com':
2677 valid_accounts = set(reviewers + cc)
2678 # TODO(crbug/877717): relax this for all hosts.
2679 else:
2680 valid_accounts = gerrit_util.ValidAccounts(
2681 self._GetGerritHost(), reviewers + cc)
Andrii Shyshkalovf170af42018-10-30 07:00:44 +00002682 logging.info('accounts %s are recognized, %s invalid',
2683 sorted(valid_accounts),
2684 set(reviewers + cc).difference(set(valid_accounts)))
Andrii Shyshkalov76988a82018-10-15 03:12:25 +00002685
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002686 # Extra options that can be specified at push time. Doc:
2687 # https://gerrit-review.googlesource.com/Documentation/user-upload.html
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002688 refspec_opts = []
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002689
Aaron Gable844cf292017-06-28 11:32:59 -07002690 # By default, new changes are started in WIP mode, and subsequent patchsets
2691 # don't send email. At any time, passing --send-mail will mark the change
2692 # ready and send email for that particular patch.
Aaron Gableafd52772017-06-27 16:40:10 -07002693 if options.send_mail:
2694 refspec_opts.append('ready')
Aaron Gable844cf292017-06-28 11:32:59 -07002695 refspec_opts.append('notify=ALL')
Jamie Madill276da0b2018-04-27 14:41:20 -04002696 elif not self.GetIssue() and options.squash:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002697 refspec_opts.append('wip')
Aaron Gableafd52772017-06-27 16:40:10 -07002698 else:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002699 refspec_opts.append('notify=NONE')
Aaron Gable70f4e242017-06-26 10:45:59 -07002700
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002701 # TODO(tandrii): options.message should be posted as a comment
Aaron Gablee5adf612017-07-14 10:43:58 -07002702 # if --send-mail is set on non-initial upload as Rietveld used to do it.
Andrii Shyshkalov2d8a2072017-04-10 15:02:18 +02002703
Aaron Gable9b713dd2016-12-14 16:04:21 -08002704 if title:
Nick Carter8692b182017-11-06 16:30:38 -08002705 # Punctuation and whitespace in |title| must be percent-encoded.
2706 refspec_opts.append('m=' + gerrit_util.PercentEncodeForGitRef(title))
tandrii@chromium.orgbf766ba2016-04-13 12:51:23 +00002707
agablec6787972016-09-09 16:13:34 -07002708 if options.private:
Aaron Gableb02daf02017-05-23 11:53:46 -07002709 refspec_opts.append('private')
agablec6787972016-09-09 16:13:34 -07002710
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002711 for r in sorted(reviewers):
2712 if r in valid_accounts:
2713 refspec_opts.append('r=%s' % r)
2714 reviewers.remove(r)
2715 else:
2716 # TODO(tandrii): this should probably be a hard failure.
2717 print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping'
2718 % r)
2719 for c in sorted(cc):
2720 # refspec option will be rejected if cc doesn't correspond to an
2721 # account, even though REST call to add such arbitrary cc may succeed.
2722 if c in valid_accounts:
2723 refspec_opts.append('cc=%s' % c)
2724 cc.remove(c)
2725
rmistry9eadede2016-09-19 11:22:43 -07002726 if options.topic:
2727 # Documentation on Gerrit topics is here:
2728 # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002729 refspec_opts.append('topic=%s' % options.topic)
rmistry9eadede2016-09-19 11:22:43 -07002730
Edward Lemur687ca902018-12-05 02:30:30 +00002731 if options.enable_auto_submit:
2732 refspec_opts.append('l=Auto-Submit+1')
2733 if options.use_commit_queue:
2734 refspec_opts.append('l=Commit-Queue+2')
2735 elif options.cq_dry_run:
2736 refspec_opts.append('l=Commit-Queue+1')
2737
2738 if change_desc.get_reviewers(tbr_only=True):
2739 score = gerrit_util.GetCodeReviewTbrScore(
2740 self._GetGerritHost(),
2741 self._GetGerritProject())
2742 refspec_opts.append('l=Code-Review+%s' % score)
Andrii Shyshkalove7a7fc42018-10-30 17:35:09 +00002743
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002744 # Gerrit sorts hashtags, so order is not important.
Nodir Turakulov23b82142017-11-16 11:04:25 -08002745 hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags}
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002746 if not self.GetIssue():
Nodir Turakulov23b82142017-11-16 11:04:25 -08002747 hashtags.update(change_desc.get_hash_tags())
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08002748 refspec_opts += ['hashtag=%s' % t for t in sorted(hashtags)]
2749
Andrii Shyshkalovfebbae92017-04-05 15:05:20 +00002750 refspec_suffix = ''
2751 if refspec_opts:
2752 refspec_suffix = '%' + ','.join(refspec_opts)
2753 assert ' ' not in refspec_suffix, (
2754 'spaces not allowed in refspec: "%s"' % refspec_suffix)
2755 refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix)
2756
Edward Lemur1b52d872019-05-09 21:12:12 +00002757 git_push_metadata = {
2758 'gerrit_host': self._GetGerritHost(),
2759 'title': title or '<untitled>',
2760 'change_id': change_id,
2761 'description': change_desc.description,
2762 }
2763 push_stdout = self._RunGitPushWithTraces(
2764 change_desc, refspec, refspec_opts, git_push_metadata)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002765
2766 if options.squash:
Aaron Gable289b4312017-09-13 14:06:16 -07002767 regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002768 change_numbers = [m.group(1)
2769 for m in map(regex.match, push_stdout.splitlines())
2770 if m]
2771 if len(change_numbers) != 1:
2772 DieWithError(
2773 ('Created|Updated %d issues on Gerrit, but only 1 expected.\n'
Christopher Lamf732cd52017-01-24 12:40:11 +11002774 'Change-Id: %s') % (len(change_numbers), change_id), change_desc)
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002775 self.SetIssue(change_numbers[0])
tandrii5d48c322016-08-18 16:19:37 -07002776 self._GitSetBranchConfigValue('gerritsquashhash', ref_to_push)
tandrii88189772016-09-29 04:29:57 -07002777
Andrii Shyshkalov2f727912018-10-15 17:02:33 +00002778 if self.GetIssue() and (reviewers or cc):
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002779 # GetIssue() is not set in case of non-squash uploads according to tests.
2780 # TODO(agable): non-squash uploads in git cl should be removed.
2781 gerrit_util.AddReviewers(
2782 self._GetGerritHost(),
Andrii Shyshkalovd06cc782018-08-23 17:24:19 +00002783 self._GerritChangeIdentifier(),
Andrii Shyshkalov0ec9d152018-08-23 00:22:58 +00002784 reviewers, cc,
2785 notify=bool(options.send_mail))
Aaron Gable6dadfbf2017-05-09 14:27:58 -07002786
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002787 return 0
2788
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002789 def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force,
2790 change_desc):
2791 """Computes parent of the generated commit to be uploaded to Gerrit.
2792
2793 Returns revision or a ref name.
2794 """
2795 if custom_cl_base:
2796 # Try to avoid creating additional unintended CLs when uploading, unless
2797 # user wants to take this risk.
2798 local_ref_of_target_remote = self.GetRemoteBranch()[1]
2799 code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base,
2800 local_ref_of_target_remote])
2801 if code == 1:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002802 print('\nWARNING: Manually specified base of this CL `%s` '
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002803 'doesn\'t seem to belong to target remote branch `%s`.\n\n'
2804 'If you proceed with upload, more than 1 CL may be created by '
2805 'Gerrit as a result, in turn confusing or crashing git cl.\n\n'
2806 'If you are certain that specified base `%s` has already been '
2807 'uploaded to Gerrit as another CL, you may proceed.\n' %
2808 (custom_cl_base, local_ref_of_target_remote, custom_cl_base))
2809 if not force:
2810 confirm_or_exit(
2811 'Do you take responsibility for cleaning up potential mess '
2812 'resulting from proceeding with upload?',
2813 action='upload')
2814 return custom_cl_base
2815
Aaron Gablef97e33d2017-03-30 15:44:27 -07002816 if remote != '.':
2817 return self.GetCommonAncestorWithUpstream()
2818
2819 # If our upstream branch is local, we base our squashed commit on its
2820 # squashed version.
2821 upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch)
2822
Aaron Gablef97e33d2017-03-30 15:44:27 -07002823 if upstream_branch_name == 'master':
Aaron Gable0bbd1c22017-05-08 14:37:08 -07002824 return self.GetCommonAncestorWithUpstream()
Aaron Gablef97e33d2017-03-30 15:44:27 -07002825
2826 # Check the squashed hash of the parent.
Andrii Shyshkalov550e9242017-04-12 17:14:49 +02002827 # TODO(tandrii): consider checking parent change in Gerrit and using its
2828 # hash if tree hash of latest parent revision (patchset) in Gerrit matches
2829 # the tree hash of the parent branch. The upside is less likely bogus
2830 # requests to reupload parent change just because it's uploadhash is
2831 # missing, yet the downside likely exists, too (albeit unknown to me yet).
Aaron Gablef97e33d2017-03-30 15:44:27 -07002832 parent = RunGit(['config',
2833 'branch.%s.gerritsquashhash' % upstream_branch_name],
2834 error_ok=True).strip()
2835 # Verify that the upstream branch has been uploaded too, otherwise
2836 # Gerrit will create additional CLs when uploading.
2837 if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) !=
2838 RunGitSilent(['rev-parse', parent + ':'])):
2839 DieWithError(
2840 '\nUpload upstream branch %s first.\n'
2841 'It is likely that this branch has been rebased since its last '
2842 'upload, so you just need to upload it again.\n'
2843 '(If you uploaded it with --no-squash, then branch dependencies '
2844 'are not supported, and you should reupload with --squash.)'
2845 % upstream_branch_name,
2846 change_desc)
2847 return parent
2848
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002849 def _AddChangeIdToCommitMessage(self, options, args):
2850 """Re-commits using the current message, assumes the commit hook is in
2851 place.
2852 """
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002853 log_desc = options.message or _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002854 git_command = ['commit', '--amend', '-m', log_desc]
2855 RunGit(git_command)
Andrii Shyshkalovb07575f2018-10-16 06:16:21 +00002856 new_log_desc = _create_description_from_log(args)
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002857 if git_footers.get_footer_change_id(new_log_desc):
vapiera7fbd5a2016-06-16 09:17:49 -07002858 print('git-cl: Added Change-Id to commit message.')
tandrii@chromium.org8930b3d2016-04-13 14:47:02 +00002859 return new_log_desc
2860 else:
tandrii@chromium.orgb067ec52016-05-31 15:24:44 +00002861 DieWithError('ERROR: Gerrit commit-msg hook not installed.')
tandrii@chromium.orgaa6235b2016-04-11 21:35:29 +00002862
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002863 def SetCQState(self, new_state):
2864 """Sets the Commit-Queue label assuming canonical CQ config for Gerrit."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002865 vote_map = {
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002866 _CQState.NONE: 0,
2867 _CQState.DRY_RUN: 1,
2868 _CQState.COMMIT: 2,
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002869 }
Aaron Gablefc62f762017-07-17 11:12:07 -07002870 labels = {'Commit-Queue': vote_map[new_state]}
2871 notify = False if new_state == _CQState.DRY_RUN else None
Andrii Shyshkalov889677c2018-08-28 20:43:06 +00002872 gerrit_util.SetReview(
2873 self._GetGerritHost(), self._GerritChangeIdentifier(),
2874 labels=labels, notify=notify)
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00002875
tandriie113dfd2016-10-11 10:20:12 -07002876 def CannotTriggerTryJobReason(self):
tandrii8c5a3532016-11-04 07:52:02 -07002877 try:
2878 data = self._GetChangeDetail()
Aaron Gablea45ee112016-11-22 15:14:38 -08002879 except GerritChangeNotExists:
2880 return 'Gerrit doesn\'t know about your change %s' % self.GetIssue()
tandrii8c5a3532016-11-04 07:52:02 -07002881
2882 if data['status'] in ('ABANDONED', 'MERGED'):
2883 return 'CL %s is closed' % self.GetIssue()
2884
Quinten Yearsley0c62da92017-05-31 13:39:42 -07002885 def GetTryJobProperties(self, patchset=None):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00002886 """Returns dictionary of properties to launch a tryjob."""
tandrii8c5a3532016-11-04 07:52:02 -07002887 data = self._GetChangeDetail(['ALL_REVISIONS'])
2888 patchset = int(patchset or self.GetPatchset())
2889 assert patchset
2890 revision_data = None # Pylint wants it to be defined.
2891 for revision_data in data['revisions'].itervalues():
2892 if int(revision_data['_number']) == patchset:
2893 break
2894 else:
Aaron Gablea45ee112016-11-22 15:14:38 -08002895 raise Exception('Patchset %d is not known in Gerrit change %d' %
tandrii8c5a3532016-11-04 07:52:02 -07002896 (patchset, self.GetIssue()))
2897 return {
2898 'patch_issue': self.GetIssue(),
2899 'patch_set': patchset or self.GetPatchset(),
2900 'patch_project': data['project'],
2901 'patch_storage': 'gerrit',
2902 'patch_ref': revision_data['fetch']['http']['ref'],
2903 'patch_repository_url': revision_data['fetch']['http']['url'],
2904 'patch_gerrit_url': self.GetCodereviewServer(),
2905 }
tandriie113dfd2016-10-11 10:20:12 -07002906
tandriide281ae2016-10-12 06:02:30 -07002907 def GetIssueOwner(self):
tandrii8c5a3532016-11-04 07:52:02 -07002908 return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email']
tandriide281ae2016-10-12 06:02:30 -07002909
Edward Lemur707d70b2018-02-07 00:50:14 +01002910 def GetReviewers(self):
2911 details = self._GetChangeDetail(['DETAILED_ACCOUNTS'])
Mohamed Heikal171c0742018-11-09 20:38:51 +00002912 return [r['email'] for r in details['reviewers'].get('REVIEWER', [])]
Edward Lemur707d70b2018-02-07 00:50:14 +01002913
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002914
2915_CODEREVIEW_IMPLEMENTATIONS = {
tandrii@chromium.orgd68b62b2016-03-31 16:09:29 +00002916 'gerrit': _GerritChangelistImpl,
2917}
2918
tandrii@chromium.org013a2802016-03-29 09:52:33 +00002919
iannuccie53c9352016-08-17 14:40:40 -07002920def _add_codereview_issue_select_options(parser, extra=""):
2921 _add_codereview_select_options(parser)
2922
2923 text = ('Operate on this issue number instead of the current branch\'s '
2924 'implicit issue.')
2925 if extra:
2926 text += ' '+extra
2927 parser.add_option('-i', '--issue', type=int, help=text)
2928
2929
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002930def _add_codereview_select_options(parser):
Edward Lemurf38bc172019-09-03 21:02:13 +00002931 """Appends --gerrit option to force specific codereview."""
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002932 parser.codereview_group = optparse.OptionGroup(
Edward Lemurf38bc172019-09-03 21:02:13 +00002933 parser, 'DEPRECATED! Codereview override options')
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002934 parser.add_option_group(parser.codereview_group)
2935 parser.codereview_group.add_option(
2936 '--gerrit', action='store_true',
Edward Lemurf38bc172019-09-03 21:02:13 +00002937 help='Deprecated. Noop. Do not use.')
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002938
2939
2940def _process_codereview_select_options(parser, options):
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002941 options.forced_codereview = None
2942 if options.gerrit:
2943 options.forced_codereview = 'gerrit'
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00002944
2945
tandriif9aefb72016-07-01 09:06:51 -07002946def _get_bug_line_values(default_project, bugs):
2947 """Given default_project and comma separated list of bugs, yields bug line
2948 values.
2949
2950 Each bug can be either:
2951 * a number, which is combined with default_project
2952 * string, which is left as is.
2953
2954 This function may produce more than one line, because bugdroid expects one
2955 project per line.
2956
2957 >>> list(_get_bug_line_values('v8', '123,chromium:789'))
2958 ['v8:123', 'chromium:789']
2959 """
2960 default_bugs = []
2961 others = []
2962 for bug in bugs.split(','):
2963 bug = bug.strip()
2964 if bug:
2965 try:
2966 default_bugs.append(int(bug))
2967 except ValueError:
2968 others.append(bug)
2969
2970 if default_bugs:
2971 default_bugs = ','.join(map(str, default_bugs))
2972 if default_project:
2973 yield '%s:%s' % (default_project, default_bugs)
2974 else:
2975 yield default_bugs
2976 for other in sorted(others):
2977 # Don't bother finding common prefixes, CLs with >2 bugs are very very rare.
2978 yield other
2979
2980
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002981class ChangeDescription(object):
2982 """Contains a parsed form of the change description."""
maruel@chromium.orgc6f60e82013-04-19 17:01:57 +00002983 R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$'
bradnelsond975b302016-10-23 12:20:23 -07002984 CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$'
Aaron Gable3a16ed12017-03-23 10:51:55 -07002985 BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$'
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01002986 CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$'
Nodir Turakulov23b82142017-11-16 11:04:25 -08002987 STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*'
2988 BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]'
2989 COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):'
2990 BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+'
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00002991
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002992 def __init__(self, description):
agable@chromium.org42c20792013-09-12 17:34:49 +00002993 self._description_lines = (description or '').strip().splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00002994
agable@chromium.org42c20792013-09-12 17:34:49 +00002995 @property # www.logilab.org/ticket/89786
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08002996 def description(self): # pylint: disable=method-hidden
agable@chromium.org42c20792013-09-12 17:34:49 +00002997 return '\n'.join(self._description_lines)
2998
2999 def set_description(self, desc):
3000 if isinstance(desc, basestring):
3001 lines = desc.splitlines()
3002 else:
3003 lines = [line.rstrip() for line in desc]
3004 while lines and not lines[0]:
3005 lines.pop(0)
3006 while lines and not lines[-1]:
3007 lines.pop(-1)
3008 self._description_lines = lines
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003009
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003010 def update_reviewers(self, reviewers, tbrs, add_owners_to=None, change=None):
3011 """Rewrites the R=/TBR= line(s) as a single line each.
3012
3013 Args:
3014 reviewers (list(str)) - list of additional emails to use for reviewers.
3015 tbrs (list(str)) - list of additional emails to use for TBRs.
3016 add_owners_to (None|'R'|'TBR') - Pass to do an OWNERS lookup for files in
3017 the change that are missing OWNER coverage. If this is not None, you
3018 must also pass a value for `change`.
3019 change (Change) - The Change that should be used for OWNERS lookups.
3020 """
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003021 assert isinstance(reviewers, list), reviewers
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003022 assert isinstance(tbrs, list), tbrs
3023
Robert Iannuccif2708bd2017-04-17 15:49:02 -07003024 assert add_owners_to in (None, 'TBR', 'R'), add_owners_to
Robert Iannuccia28592e2017-04-18 13:14:49 -07003025 assert not add_owners_to or change, add_owners_to
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003026
3027 if not reviewers and not tbrs and not add_owners_to:
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003028 return
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003029
3030 reviewers = set(reviewers)
3031 tbrs = set(tbrs)
3032 LOOKUP = {
3033 'TBR': tbrs,
3034 'R': reviewers,
3035 }
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003036
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003037 # Get the set of R= and TBR= lines and remove them from the description.
agable@chromium.org42c20792013-09-12 17:34:49 +00003038 regexp = re.compile(self.R_LINE)
3039 matches = [regexp.match(line) for line in self._description_lines]
3040 new_desc = [l for i, l in enumerate(self._description_lines)
3041 if not matches[i]]
3042 self.set_description(new_desc)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003043
agable@chromium.org42c20792013-09-12 17:34:49 +00003044 # Construct new unified R= and TBR= lines.
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003045
3046 # First, update tbrs/reviewers with names from the R=/TBR= lines (if any).
agable@chromium.org42c20792013-09-12 17:34:49 +00003047 for match in matches:
3048 if not match:
3049 continue
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003050 LOOKUP[match.group(1)].update(cleanup_list([match.group(2).strip()]))
3051
3052 # Next, maybe fill in OWNERS coverage gaps to either tbrs/reviewers.
Robert Iannuccif2708bd2017-04-17 15:49:02 -07003053 if add_owners_to:
piman@chromium.org336f9122014-09-04 02:16:55 +00003054 owners_db = owners.Database(change.RepositoryRoot(),
Jochen Eisinger72606f82017-04-04 10:44:18 +02003055 fopen=file, os_path=os.path)
piman@chromium.org336f9122014-09-04 02:16:55 +00003056 missing_files = owners_db.files_not_covered_by(change.LocalPaths(),
Robert Iannucci100aa212017-04-18 17:28:26 -07003057 (tbrs | reviewers))
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003058 LOOKUP[add_owners_to].update(
3059 owners_db.reviewers_for(missing_files, change.author_email))
Robert Iannuccif2708bd2017-04-17 15:49:02 -07003060
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003061 # If any folks ended up in both groups, remove them from tbrs.
3062 tbrs -= reviewers
Robert Iannuccif2708bd2017-04-17 15:49:02 -07003063
Robert Iannucci6c98dc62017-04-18 11:38:00 -07003064 new_r_line = 'R=' + ', '.join(sorted(reviewers)) if reviewers else None
3065 new_tbr_line = 'TBR=' + ', '.join(sorted(tbrs)) if tbrs else None
agable@chromium.org42c20792013-09-12 17:34:49 +00003066
3067 # Put the new lines in the description where the old first R= line was.
3068 line_loc = next((i for i, match in enumerate(matches) if match), -1)
3069 if 0 <= line_loc < len(self._description_lines):
3070 if new_tbr_line:
3071 self._description_lines.insert(line_loc, new_tbr_line)
3072 if new_r_line:
3073 self._description_lines.insert(line_loc, new_r_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003074 else:
agable@chromium.org42c20792013-09-12 17:34:49 +00003075 if new_r_line:
3076 self.append_footer(new_r_line)
3077 if new_tbr_line:
3078 self.append_footer(new_tbr_line)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003079
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00003080 def set_preserve_tryjobs(self):
3081 """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'."""
3082 footers = git_footers.parse_footers(self.description)
3083 for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []):
3084 if v.lower() == 'true':
3085 return
3086 self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true')
3087
Aaron Gable3a16ed12017-03-23 10:51:55 -07003088 def prompt(self, bug=None, git_footer=True):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003089 """Asks the user to update the description."""
agable@chromium.org42c20792013-09-12 17:34:49 +00003090 self.set_description([
3091 '# Enter a description of the change.',
3092 '# This will be displayed on the codereview site.',
3093 '# The first line will also be used as the subject of the review.',
alancutter@chromium.orgbd1073e2013-06-01 00:34:38 +00003094 '#--------------------This line is 72 characters long'
agable@chromium.org42c20792013-09-12 17:34:49 +00003095 '--------------------',
3096 ] + self._description_lines)
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003097
agable@chromium.org42c20792013-09-12 17:34:49 +00003098 regexp = re.compile(self.BUG_LINE)
Jonas Termansend0f79112019-03-22 15:28:26 +00003099 prefix = settings.GetBugPrefix()
agable@chromium.org42c20792013-09-12 17:34:49 +00003100 if not any((regexp.match(line) for line in self._description_lines)):
tandriif9aefb72016-07-01 09:06:51 -07003101 values = list(_get_bug_line_values(prefix, bug or '')) or [prefix]
Aaron Gable3a16ed12017-03-23 10:51:55 -07003102 if git_footer:
3103 self.append_footer('Bug: %s' % ', '.join(values))
3104 else:
3105 for value in values:
3106 self.append_footer('BUG=%s' % value)
tandriif9aefb72016-07-01 09:06:51 -07003107
agable@chromium.org42c20792013-09-12 17:34:49 +00003108 content = gclient_utils.RunEditor(self.description, True,
jbroman@chromium.org615a2622013-05-03 13:20:14 +00003109 git_editor=settings.GetGitEditor())
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00003110 if not content:
3111 DieWithError('Running editor failed')
agable@chromium.org42c20792013-09-12 17:34:49 +00003112 lines = content.splitlines()
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003113
Bruce Dawson2377b012018-01-11 16:46:49 -08003114 # Strip off comments and default inserted "Bug:" line.
3115 clean_lines = [line.rstrip() for line in lines if not
Jonas Termansend0f79112019-03-22 15:28:26 +00003116 (line.startswith('#') or
3117 line.rstrip() == "Bug:" or
3118 line.rstrip() == "Bug: " + prefix)]
agable@chromium.org42c20792013-09-12 17:34:49 +00003119 if not clean_lines:
maruel@chromium.org0e0436a2011-10-25 13:32:41 +00003120 DieWithError('No CL description, aborting')
agable@chromium.org42c20792013-09-12 17:34:49 +00003121 self.set_description(clean_lines)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003122
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003123 def append_footer(self, line):
tandrii@chromium.org601e1d12016-06-03 13:03:54 +00003124 """Adds a footer line to the description.
3125
3126 Differentiates legacy "KEY=xxx" footers (used to be called tags) and
3127 Gerrit's footers in the form of "Footer-Key: footer any value" and ensures
3128 that Gerrit footers are always at the end.
3129 """
3130 parsed_footer_line = git_footers.parse_footer(line)
3131 if parsed_footer_line:
3132 # Line is a gerrit footer in the form: Footer-Key: any value.
3133 # Thus, must be appended observing Gerrit footer rules.
3134 self.set_description(
3135 git_footers.add_footer(self.description,
3136 key=parsed_footer_line[0],
3137 value=parsed_footer_line[1]))
3138 return
3139
3140 if not self._description_lines:
3141 self._description_lines.append(line)
3142 return
3143
3144 top_lines, gerrit_footers, _ = git_footers.split_footers(self.description)
3145 if gerrit_footers:
3146 # git_footers.split_footers ensures that there is an empty line before
3147 # actual (gerrit) footers, if any. We have to keep it that way.
3148 assert top_lines and top_lines[-1] == ''
3149 top_lines, separator = top_lines[:-1], top_lines[-1:]
3150 else:
3151 separator = [] # No need for separator if there are no gerrit_footers.
3152
3153 prev_line = top_lines[-1] if top_lines else ''
3154 if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or
3155 not presubmit_support.Change.TAG_LINE_RE.match(line)):
3156 top_lines.append('')
3157 top_lines.append(line)
3158 self._description_lines = top_lines + separator + gerrit_footers
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003159
tandrii99a72f22016-08-17 14:33:24 -07003160 def get_reviewers(self, tbr_only=False):
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003161 """Retrieves the list of reviewers."""
agable@chromium.org42c20792013-09-12 17:34:49 +00003162 matches = [re.match(self.R_LINE, line) for line in self._description_lines]
tandrii99a72f22016-08-17 14:33:24 -07003163 reviewers = [match.group(2).strip()
3164 for match in matches
3165 if match and (not tbr_only or match.group(1).upper() == 'TBR')]
maruel@chromium.org78936cb2013-04-11 00:17:52 +00003166 return cleanup_list(reviewers)
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003167
bradnelsond975b302016-10-23 12:20:23 -07003168 def get_cced(self):
3169 """Retrieves the list of reviewers."""
3170 matches = [re.match(self.CC_LINE, line) for line in self._description_lines]
3171 cced = [match.group(2).strip() for match in matches if match]
3172 return cleanup_list(cced)
3173
Nodir Turakulov23b82142017-11-16 11:04:25 -08003174 def get_hash_tags(self):
3175 """Extracts and sanitizes a list of Gerrit hashtags."""
3176 subject = (self._description_lines or ('',))[0]
3177 subject = re.sub(
3178 self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE)
3179
3180 tags = []
3181 start = 0
3182 bracket_exp = re.compile(self.BRACKET_HASH_TAG)
3183 while True:
3184 m = bracket_exp.match(subject, start)
3185 if not m:
3186 break
3187 tags.append(self.sanitize_hash_tag(m.group(1)))
3188 start = m.end()
3189
3190 if not tags:
3191 # Try "Tag: " prefix.
3192 m = re.match(self.COLON_SEPARATED_HASH_TAG, subject)
3193 if m:
3194 tags.append(self.sanitize_hash_tag(m.group(1)))
3195 return tags
3196
3197 @classmethod
3198 def sanitize_hash_tag(cls, tag):
3199 """Returns a sanitized Gerrit hash tag.
3200
3201 A sanitized hashtag can be used as a git push refspec parameter value.
3202 """
3203 return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower()
3204
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003205 def update_with_git_number_footers(self, parent_hash, parent_msg, dest_ref):
3206 """Updates this commit description given the parent.
3207
3208 This is essentially what Gnumbd used to do.
3209 Consult https://goo.gl/WMmpDe for more details.
3210 """
3211 assert parent_msg # No, orphan branch creation isn't supported.
3212 assert parent_hash
3213 assert dest_ref
3214 parent_footer_map = git_footers.parse_footers(parent_msg)
3215 # This will also happily parse svn-position, which GnumbD is no longer
3216 # supporting. While we'd generate correct footers, the verifier plugin
3217 # installed in Gerrit will block such commit (ie git push below will fail).
3218 parent_position = git_footers.get_position(parent_footer_map)
3219
3220 # Cherry-picks may have last line obscuring their prior footers,
3221 # from git_footers perspective. This is also what Gnumbd did.
3222 cp_line = None
3223 if (self._description_lines and
3224 re.match(self.CHERRY_PICK_LINE, self._description_lines[-1])):
3225 cp_line = self._description_lines.pop()
3226
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003227 top_lines, footer_lines, _ = git_footers.split_footers(self.description)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003228
3229 # Original-ify all Cr- footers, to avoid re-lands, cherry-picks, or just
3230 # user interference with actual footers we'd insert below.
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003231 for i, line in enumerate(footer_lines):
3232 k, v = git_footers.parse_footer(line) or (None, None)
3233 if k and k.startswith('Cr-'):
3234 footer_lines[i] = '%s: %s' % ('Cr-Original-' + k[len('Cr-'):], v)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003235
3236 # Add Position and Lineage footers based on the parent.
Andrii Shyshkalovb5effa12016-12-14 19:35:12 +01003237 lineage = list(reversed(parent_footer_map.get('Cr-Branched-From', [])))
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003238 if parent_position[0] == dest_ref:
3239 # Same branch as parent.
3240 number = int(parent_position[1]) + 1
3241 else:
3242 number = 1 # New branch, and extra lineage.
3243 lineage.insert(0, '%s-%s@{#%d}' % (parent_hash, parent_position[0],
3244 int(parent_position[1])))
3245
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003246 footer_lines.append('Cr-Commit-Position: %s@{#%d}' % (dest_ref, number))
3247 footer_lines.extend('Cr-Branched-From: %s' % v for v in lineage)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003248
3249 self._description_lines = top_lines
3250 if cp_line:
3251 self._description_lines.append(cp_line)
3252 if self._description_lines[-1] != '':
3253 self._description_lines.append('') # Ensure footer separator.
Andrii Shyshkalovde37c012017-07-06 21:06:50 +02003254 self._description_lines.extend(footer_lines)
Andrii Shyshkalov15e50cc2016-12-02 14:34:08 +01003255
dpranke@chromium.org20254fc2011-03-22 18:28:59 +00003256
Aaron Gablea1bab272017-04-11 16:38:18 -07003257def get_approving_reviewers(props, disapproval=False):
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003258 """Retrieves the reviewers that approved a CL from the issue properties with
3259 messages.
3260
3261 Note that the list may contain reviewers that are not committer, thus are not
3262 considered by the CQ.
Aaron Gablea1bab272017-04-11 16:38:18 -07003263
3264 If disapproval is True, instead returns reviewers who 'not lgtm'd the CL.
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003265 """
Aaron Gablea1bab272017-04-11 16:38:18 -07003266 approval_type = 'disapproval' if disapproval else 'approval'
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003267 return sorted(
3268 set(
3269 message['sender']
3270 for message in props['messages']
Aaron Gablea1bab272017-04-11 16:38:18 -07003271 if message[approval_type] and message['sender'] in props['reviewers']
maruel@chromium.orge52678e2013-04-26 18:34:44 +00003272 )
3273 )
3274
3275
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003276def FindCodereviewSettingsFile(filename='codereview.settings'):
3277 """Finds the given file starting in the cwd and going up.
3278
3279 Only looks up to the top of the repository unless an
3280 'inherit-review-settings-ok' file exists in the root of the repository.
3281 """
3282 inherit_ok_file = 'inherit-review-settings-ok'
3283 cwd = os.getcwd()
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00003284 root = settings.GetRoot()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003285 if os.path.isfile(os.path.join(root, inherit_ok_file)):
3286 root = '/'
3287 while True:
3288 if filename in os.listdir(cwd):
3289 if os.path.isfile(os.path.join(cwd, filename)):
3290 return open(os.path.join(cwd, filename))
3291 if cwd == root:
3292 break
3293 cwd = os.path.dirname(cwd)
3294
3295
3296def LoadCodereviewSettingsFromFile(fileobj):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003297 """Parses a codereview.settings file and updates hooks."""
maruel@chromium.org99ac1c52012-01-16 14:52:12 +00003298 keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003299
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003300 def SetProperty(name, setting, unset_error_ok=False):
3301 fullname = 'rietveld.' + name
3302 if setting in keyvals:
3303 RunGit(['config', fullname, keyvals[setting]])
3304 else:
3305 RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok)
3306
tandrii48df5812016-10-17 03:55:37 -07003307 if not keyvals.get('GERRIT_HOST', False):
3308 SetProperty('server', 'CODE_REVIEW_SERVER')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003309 # Only server setting is required. Other settings can be absent.
3310 # In that case, we ignore errors raised during option deletion attempt.
3311 SetProperty('cc', 'CC_LIST', unset_error_ok=True)
3312 SetProperty('tree-status-url', 'STATUS', unset_error_ok=True)
3313 SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True)
rmistry@google.com90752582014-01-14 21:04:50 +00003314 SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True)
thestig@chromium.org44202a22014-03-11 19:22:18 +00003315 SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True)
3316 SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True)
rmistry@google.com5626a922015-02-26 14:03:30 +00003317 SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK',
3318 unset_error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003319
ukai@chromium.org7044efc2013-11-28 01:51:21 +00003320 if 'GERRIT_HOST' in keyvals:
ukai@chromium.orge8077812012-02-03 03:41:46 +00003321 RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']])
ukai@chromium.orge8077812012-02-03 03:41:46 +00003322
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003323 if 'GERRIT_SQUASH_UPLOADS' in keyvals:
tandrii8dd81ea2016-06-16 13:24:23 -07003324 RunGit(['config', 'gerrit.squash-uploads',
3325 keyvals['GERRIT_SQUASH_UPLOADS']])
bauerb@chromium.org54b400c2016-01-14 10:08:25 +00003326
tandrii@chromium.org28253532016-04-14 13:46:56 +00003327 if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals:
shinyak@chromium.org00dbccd2016-04-15 07:24:43 +00003328 RunGit(['config', 'gerrit.skip-ensure-authenticated',
tandrii@chromium.org28253532016-04-14 13:46:56 +00003329 keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']])
3330
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003331 if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01003332 # should be of the form
3333 # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof
3334 # ORIGIN_URL_CONFIG: http://src.chromium.org/git
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003335 RunGit(['config', keyvals['PUSH_URL_CONFIG'],
3336 keyvals['ORIGIN_URL_CONFIG']])
3337
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003338
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003339def urlretrieve(source, destination):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003340 """Downloads a network object to a local file, like urllib.urlretrieve.
3341
3342 This is necessary because urllib is broken for SSL connections via a proxy.
3343 """
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003344 with open(destination, 'w') as f:
3345 f.write(urllib2.urlopen(source).read())
3346
3347
ukai@chromium.org712d6102013-11-27 00:52:58 +00003348def hasSheBang(fname):
3349 """Checks fname is a #! script."""
3350 with open(fname) as f:
3351 return f.read(2).startswith('#!')
3352
3353
bpastene@chromium.org917f0ff2016-04-05 00:45:30 +00003354# TODO(bpastene) Remove once a cleaner fix to crbug.com/600473 presents itself.
3355def DownloadHooks(*args, **kwargs):
3356 pass
3357
3358
tandrii@chromium.org18630d62016-03-04 12:06:02 +00003359def DownloadGerritHook(force):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003360 """Downloads and installs a Gerrit commit-msg hook.
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003361
3362 Args:
3363 force: True to update hooks. False to install hooks if not present.
3364 """
3365 if not settings.GetIsGerrit():
3366 return
ukai@chromium.org712d6102013-11-27 00:52:58 +00003367 src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg'
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003368 dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg')
3369 if not os.access(dst, os.X_OK):
3370 if os.path.exists(dst):
3371 if not force:
3372 return
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003373 try:
joshua.lock@intel.com426f69b2012-08-02 23:41:49 +00003374 urlretrieve(src, dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003375 if not hasSheBang(dst):
3376 DieWithError('Not a script: %s\n'
3377 'You need to download from\n%s\n'
3378 'into .git/hooks/commit-msg and '
3379 'chmod +x .git/hooks/commit-msg' % (dst, src))
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003380 os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
3381 except Exception:
3382 if os.path.exists(dst):
3383 os.remove(dst)
ukai@chromium.org712d6102013-11-27 00:52:58 +00003384 DieWithError('\nFailed to download hooks.\n'
3385 'You need to download from\n%s\n'
3386 'into .git/hooks/commit-msg and '
3387 'chmod +x .git/hooks/commit-msg' % src)
ukai@chromium.org78c4b982012-02-14 02:20:26 +00003388
3389
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003390class _GitCookiesChecker(object):
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003391 """Provides facilities for validating and suggesting fixes to .gitcookies."""
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003392
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003393 _GOOGLESOURCE = 'googlesource.com'
3394
3395 def __init__(self):
3396 # Cached list of [host, identity, source], where source is either
3397 # .gitcookies or .netrc.
3398 self._all_hosts = None
3399
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003400 def ensure_configured_gitcookies(self):
3401 """Runs checks and suggests fixes to make git use .gitcookies from default
3402 path."""
3403 default = gerrit_util.CookiesAuthenticator.get_gitcookies_path()
3404 configured_path = RunGitSilent(
3405 ['config', '--global', 'http.cookiefile']).strip()
Andrii Shyshkalov1e250cd2017-05-10 15:39:31 +02003406 configured_path = os.path.expanduser(configured_path)
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003407 if configured_path:
3408 self._ensure_default_gitcookies_path(configured_path, default)
3409 else:
3410 self._configure_gitcookies_path(default)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003411
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003412 @staticmethod
3413 def _ensure_default_gitcookies_path(configured_path, default_path):
3414 assert configured_path
3415 if configured_path == default_path:
3416 print('git is already configured to use your .gitcookies from %s' %
3417 configured_path)
3418 return
3419
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003420 print('WARNING: You have configured custom path to .gitcookies: %s\n'
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003421 'Gerrit and other depot_tools expect .gitcookies at %s\n' %
3422 (configured_path, default_path))
3423
3424 if not os.path.exists(configured_path):
3425 print('However, your configured .gitcookies file is missing.')
3426 confirm_or_exit('Reconfigure git to use default .gitcookies?',
3427 action='reconfigure')
3428 RunGit(['config', '--global', 'http.cookiefile', default_path])
3429 return
3430
3431 if os.path.exists(default_path):
3432 print('WARNING: default .gitcookies file already exists %s' %
3433 default_path)
3434 DieWithError('Please delete %s manually and re-run git cl creds-check' %
3435 default_path)
3436
3437 confirm_or_exit('Move existing .gitcookies to default location?',
3438 action='move')
3439 shutil.move(configured_path, default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003440 RunGit(['config', '--global', 'http.cookiefile', default_path])
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003441 print('Moved and reconfigured git to use .gitcookies from %s' %
3442 default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003443
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003444 @staticmethod
3445 def _configure_gitcookies_path(default_path):
3446 netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path()
3447 if os.path.exists(netrc_path):
3448 print('You seem to be using outdated .netrc for git credentials: %s' %
3449 netrc_path)
3450 print('This tool will guide you through setting up recommended '
3451 '.gitcookies store for git credentials.\n'
3452 '\n'
3453 'IMPORTANT: If something goes wrong and you decide to go back, do:\n'
3454 ' git config --global --unset http.cookiefile\n'
3455 ' mv %s %s.backup\n\n' % (default_path, default_path))
3456 confirm_or_exit(action='setup .gitcookies')
3457 RunGit(['config', '--global', 'http.cookiefile', default_path])
3458 print('Configured git to use .gitcookies from %s' % default_path)
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003459
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003460 def get_hosts_with_creds(self, include_netrc=False):
3461 if self._all_hosts is None:
3462 a = gerrit_util.CookiesAuthenticator()
3463 self._all_hosts = [
3464 (h, u, s)
3465 for h, u, s in itertools.chain(
3466 ((h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.iteritems()),
3467 ((h, u, '.gitcookies') for h, (u, _) in a.gitcookies.iteritems())
3468 )
3469 if h.endswith(self._GOOGLESOURCE)
3470 ]
3471
3472 if include_netrc:
3473 return self._all_hosts
3474 return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc']
3475
3476 def print_current_creds(self, include_netrc=False):
3477 hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc))
3478 if not hosts:
3479 print('No Git/Gerrit credentials found')
3480 return
3481 lengths = [max(map(len, (row[i] for row in hosts))) for i in xrange(3)]
3482 header = [('Host', 'User', 'Which file'),
3483 ['=' * l for l in lengths]]
3484 for row in (header + hosts):
3485 print('\t'.join((('%%+%ds' % l) % s)
3486 for l, s in zip(lengths, row)))
3487
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003488 @staticmethod
3489 def _parse_identity(identity):
Lei Zhangd3f769a2017-12-15 15:16:14 -08003490 """Parses identity "git-<username>.domain" into <username> and domain."""
3491 # Special case: usernames that contain ".", which are generally not
Andrii Shyshkalov0d2dea02017-07-17 15:17:55 +02003492 # distinguishable from sub-domains. But we do know typical domains:
3493 if identity.endswith('.chromium.org'):
3494 domain = 'chromium.org'
3495 username = identity[:-len('.chromium.org')]
3496 else:
3497 username, domain = identity.split('.', 1)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003498 if username.startswith('git-'):
3499 username = username[len('git-'):]
3500 return username, domain
3501
3502 def _get_usernames_of_domain(self, domain):
3503 """Returns list of usernames referenced by .gitcookies in a given domain."""
3504 identities_by_domain = {}
3505 for _, identity, _ in self.get_hosts_with_creds():
3506 username, domain = self._parse_identity(identity)
3507 identities_by_domain.setdefault(domain, []).append(username)
3508 return identities_by_domain.get(domain)
3509
3510 def _canonical_git_googlesource_host(self, host):
3511 """Normalizes Gerrit hosts (with '-review') to Git host."""
3512 assert host.endswith(self._GOOGLESOURCE)
3513 # Prefix doesn't include '.' at the end.
3514 prefix = host[:-(1 + len(self._GOOGLESOURCE))]
3515 if prefix.endswith('-review'):
3516 prefix = prefix[:-len('-review')]
3517 return prefix + '.' + self._GOOGLESOURCE
3518
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003519 def _canonical_gerrit_googlesource_host(self, host):
3520 git_host = self._canonical_git_googlesource_host(host)
3521 prefix = git_host.split('.', 1)[0]
3522 return prefix + '-review.' + self._GOOGLESOURCE
3523
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003524 def _get_counterpart_host(self, host):
3525 assert host.endswith(self._GOOGLESOURCE)
3526 git = self._canonical_git_googlesource_host(host)
3527 gerrit = self._canonical_gerrit_googlesource_host(git)
3528 return git if gerrit == host else gerrit
3529
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003530 def has_generic_host(self):
3531 """Returns whether generic .googlesource.com has been configured.
3532
3533 Chrome Infra recommends to use explicit ${host}.googlesource.com instead.
3534 """
3535 for host, _, _ in self.get_hosts_with_creds(include_netrc=False):
3536 if host == '.' + self._GOOGLESOURCE:
3537 return True
3538 return False
3539
3540 def _get_git_gerrit_identity_pairs(self):
3541 """Returns map from canonic host to pair of identities (Git, Gerrit).
3542
3543 One of identities might be None, meaning not configured.
3544 """
3545 host_to_identity_pairs = {}
3546 for host, identity, _ in self.get_hosts_with_creds():
3547 canonical = self._canonical_git_googlesource_host(host)
3548 pair = host_to_identity_pairs.setdefault(canonical, [None, None])
3549 idx = 0 if canonical == host else 1
3550 pair[idx] = identity
3551 return host_to_identity_pairs
3552
3553 def get_partially_configured_hosts(self):
3554 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003555 (host if i1 else self._canonical_gerrit_googlesource_host(host))
3556 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().iteritems()
3557 if None in (i1, i2) and host != '.' + self._GOOGLESOURCE)
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003558
3559 def get_conflicting_hosts(self):
3560 return set(
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003561 host
3562 for host, (i1, i2) in self._get_git_gerrit_identity_pairs().iteritems()
Andrii Shyshkalov97800502017-03-16 16:04:32 +01003563 if None not in (i1, i2) and i1 != i2)
3564
3565 def get_duplicated_hosts(self):
3566 counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds())
3567 return set(host for host, count in counters.iteritems() if count > 1)
3568
3569 _EXPECTED_HOST_IDENTITY_DOMAINS = {
3570 'chromium.googlesource.com': 'chromium.org',
3571 'chrome-internal.googlesource.com': 'google.com',
3572 }
3573
3574 def get_hosts_with_wrong_identities(self):
3575 """Finds hosts which **likely** reference wrong identities.
3576
3577 Note: skips hosts which have conflicting identities for Git and Gerrit.
3578 """
3579 hosts = set()
3580 for host, expected in self._EXPECTED_HOST_IDENTITY_DOMAINS.iteritems():
3581 pair = self._get_git_gerrit_identity_pairs().get(host)
3582 if pair and pair[0] == pair[1]:
3583 _, domain = self._parse_identity(pair[0])
3584 if domain != expected:
3585 hosts.add(host)
3586 return hosts
3587
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003588 @staticmethod
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003589 def _format_hosts(hosts, extra_column_func=None):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003590 hosts = sorted(hosts)
3591 assert hosts
3592 if extra_column_func is None:
3593 extras = [''] * len(hosts)
3594 else:
3595 extras = [extra_column_func(host) for host in hosts]
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003596 tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras)))
3597 lines = []
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003598 for he in zip(hosts, extras):
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003599 lines.append(tmpl % he)
3600 return lines
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003601
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003602 def _find_problems(self):
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003603 if self.has_generic_host():
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003604 yield ('.googlesource.com wildcard record detected',
3605 ['Chrome Infrastructure team recommends to list full host names '
3606 'explicitly.'],
3607 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003608
3609 dups = self.get_duplicated_hosts()
3610 if dups:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003611 yield ('The following hosts were defined twice',
3612 self._format_hosts(dups),
3613 None)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003614
3615 partial = self.get_partially_configured_hosts()
3616 if partial:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003617 yield ('Credentials should come in pairs for Git and Gerrit hosts. '
3618 'These hosts are missing',
3619 self._format_hosts(partial, lambda host: 'but %s defined' %
3620 self._get_counterpart_host(host)),
3621 partial)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003622
3623 conflicting = self.get_conflicting_hosts()
3624 if conflicting:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003625 yield ('The following Git hosts have differing credentials from their '
3626 'Gerrit counterparts',
3627 self._format_hosts(conflicting, lambda host: '%s vs %s' %
3628 tuple(self._get_git_gerrit_identity_pairs()[host])),
3629 conflicting)
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003630
3631 wrong = self.get_hosts_with_wrong_identities()
3632 if wrong:
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003633 yield ('These hosts likely use wrong identity',
3634 self._format_hosts(wrong, lambda host: '%s but %s recommended' %
3635 (self._get_git_gerrit_identity_pairs()[host][0],
3636 self._EXPECTED_HOST_IDENTITY_DOMAINS[host])),
3637 wrong)
3638
3639 def find_and_report_problems(self):
3640 """Returns True if there was at least one problem, else False."""
3641 found = False
3642 bad_hosts = set()
3643 for title, sublines, hosts in self._find_problems():
3644 if not found:
3645 found = True
3646 print('\n\n.gitcookies problem report:\n')
3647 bad_hosts.update(hosts or [])
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003648 print(' %s%s' % (title, (':' if sublines else '')))
Andrii Shyshkalovc8173822017-07-10 12:10:53 +02003649 if sublines:
3650 print()
3651 print(' %s' % '\n '.join(sublines))
3652 print()
3653
3654 if bad_hosts:
3655 assert found
3656 print(' You can manually remove corresponding lines in your %s file and '
3657 'visit the following URLs with correct account to generate '
3658 'correct credential lines:\n' %
3659 gerrit_util.CookiesAuthenticator.get_gitcookies_path())
3660 print(' %s' % '\n '.join(sorted(set(
3661 gerrit_util.CookiesAuthenticator().get_new_password_url(
3662 self._canonical_git_googlesource_host(host))
3663 for host in bad_hosts
3664 ))))
3665 return found
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003666
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003667
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003668@metrics.collector.collect_metrics('git cl creds-check')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003669def CMDcreds_check(parser, args):
3670 """Checks credentials and suggests changes."""
3671 _, _ = parser.parse_args(args)
3672
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003673 # Code below checks .gitcookies. Abort if using something else.
3674 authn = gerrit_util.Authenticator.get()
3675 if not isinstance(authn, gerrit_util.CookiesAuthenticator):
3676 if isinstance(authn, gerrit_util.GceAuthenticator):
3677 DieWithError(
3678 'This command is not designed for GCE, are you on a bot?\n'
3679 'If you need to run this on GCE, export SKIP_GCE_AUTH_FOR_GIT=1 '
3680 'in your env.')
Aaron Gabled10ca0e2017-09-11 11:24:10 -07003681 DieWithError(
Vadim Shtayurab250ec12018-10-04 00:21:08 +00003682 'This command is not designed for bot environment. It checks '
3683 '~/.gitcookies file not generally used on bots.')
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003684
Andrii Shyshkalov517948b2017-03-15 15:51:59 +01003685 checker = _GitCookiesChecker()
3686 checker.ensure_configured_gitcookies()
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003687
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003688 print('Your .netrc and .gitcookies have credentials for these hosts:')
Andrii Shyshkalov34924cd2017-03-15 17:08:32 +01003689 checker.print_current_creds(include_netrc=True)
3690
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003691 if not checker.find_and_report_problems():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07003692 print('\nNo problems detected in your .gitcookies file.')
Andrii Shyshkalov0a0b0672017-03-16 16:27:48 +01003693 return 0
3694 return 1
Andrii Shyshkalov353637c2017-03-14 16:52:18 +01003695
3696
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003697@metrics.collector.collect_metrics('git cl baseurl')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003698def CMDbaseurl(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003699 """Gets or sets base-url for this branch."""
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003700 branchref = RunGit(['symbolic-ref', 'HEAD']).strip()
3701 branch = ShortBranchName(branchref)
3702 _, args = parser.parse_args(args)
3703 if not args:
vapiera7fbd5a2016-06-16 09:17:49 -07003704 print('Current base-url:')
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003705 return RunGit(['config', 'branch.%s.base-url' % branch],
3706 error_ok=False).strip()
3707 else:
vapiera7fbd5a2016-06-16 09:17:49 -07003708 print('Setting base-url to %s' % args[0])
kalmard@homejinni.com6b0051e2012-04-03 15:45:08 +00003709 return RunGit(['config', 'branch.%s.base-url' % branch, args[0]],
3710 error_ok=False).strip()
3711
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003712
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003713def color_for_status(status):
3714 """Maps a Changelist status to color, for CMDstatus and other tools."""
3715 return {
Aaron Gable9ab38c62017-04-06 14:36:33 -07003716 'unsent': Fore.YELLOW,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003717 'waiting': Fore.BLUE,
3718 'reply': Fore.YELLOW,
Aaron Gable9ab38c62017-04-06 14:36:33 -07003719 'not lgtm': Fore.RED,
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003720 'lgtm': Fore.GREEN,
3721 'commit': Fore.MAGENTA,
3722 'closed': Fore.CYAN,
3723 'error': Fore.WHITE,
3724 }.get(status, Fore.WHITE)
3725
tandrii@chromium.org04ea8462016-04-25 19:51:21 +00003726
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003727def get_cl_statuses(changes, fine_grained, max_processes=None):
3728 """Returns a blocking iterable of (cl, status) for given branches.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003729
3730 If fine_grained is true, this will fetch CL statuses from the server.
3731 Otherwise, simply indicate if there's a matching url for the given branches.
3732
3733 If max_processes is specified, it is used as the maximum number of processes
3734 to spawn to fetch CL status from the server. Otherwise 1 process per branch is
3735 spawned.
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003736
3737 See GetStatus() for a list of possible statuses.
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003738 """
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003739 if not changes:
3740 raise StopIteration()
calamity@chromium.orgcf197482016-04-29 20:15:53 +00003741
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003742 if not fine_grained:
3743 # Fast path which doesn't involve querying codereview servers.
Aaron Gablea1bab272017-04-11 16:38:18 -07003744 # Do not use get_approving_reviewers(), since it requires an HTTP request.
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00003745 for cl in changes:
3746 yield (cl, 'waiting' if cl.GetIssueURL() else 'error')
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003747 return
3748
3749 # First, sort out authentication issues.
3750 logging.debug('ensuring credentials exist')
3751 for cl in changes:
3752 cl.EnsureAuthenticated(force=False, refresh=True)
3753
3754 def fetch(cl):
3755 try:
3756 return (cl, cl.GetStatus())
3757 except:
3758 # See http://crbug.com/629863.
Andrii Shyshkalov98824232018-04-19 11:37:15 -07003759 logging.exception('failed to fetch status for cl %s:', cl.GetIssue())
Andrii Shyshkalov2f8e9242017-01-23 19:20:19 +01003760 raise
3761
3762 threads_count = len(changes)
3763 if max_processes:
3764 threads_count = max(1, min(threads_count, max_processes))
3765 logging.debug('querying %d CLs using %d threads', len(changes), threads_count)
3766
3767 pool = ThreadPool(threads_count)
3768 fetched_cls = set()
3769 try:
3770 it = pool.imap_unordered(fetch, changes).__iter__()
3771 while True:
3772 try:
3773 cl, status = it.next(timeout=5)
3774 except multiprocessing.TimeoutError:
3775 break
3776 fetched_cls.add(cl)
3777 yield cl, status
3778 finally:
3779 pool.close()
3780
3781 # Add any branches that failed to fetch.
3782 for cl in set(changes) - fetched_cls:
3783 yield (cl, 'error')
jsbell@chromium.orgb99fbd92014-09-11 17:29:28 +00003784
rmistry@google.com2dd99862015-06-22 12:22:18 +00003785
3786def upload_branch_deps(cl, args):
3787 """Uploads CLs of local branches that are dependents of the current branch.
3788
3789 If the local branch dependency tree looks like:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003790
3791 test1 -> test2.1 -> test3.1
3792 -> test3.2
3793 -> test2.2 -> test3.3
rmistry@google.com2dd99862015-06-22 12:22:18 +00003794
3795 and you run "git cl upload --dependencies" from test1 then "git cl upload" is
3796 run on the dependent branches in this order:
3797 test2.1, test3.1, test3.2, test2.2, test3.3
3798
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003799 Note: This function does not rebase your local dependent branches. Use it
3800 when you make a change to the parent branch that will not conflict
3801 with its dependent branches, and you would like their dependencies
3802 updated in Rietveld.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003803 """
3804 if git_common.is_dirty_git_tree('upload-branch-deps'):
3805 return 1
3806
3807 root_branch = cl.GetBranch()
3808 if root_branch is None:
3809 DieWithError('Can\'t find dependent branches from detached HEAD state. '
3810 'Get on a branch!')
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00003811 if not cl.GetIssue():
rmistry@google.com2dd99862015-06-22 12:22:18 +00003812 DieWithError('Current branch does not have an uploaded CL. We cannot set '
3813 'patchset dependencies without an uploaded CL.')
3814
3815 branches = RunGit(['for-each-ref',
3816 '--format=%(refname:short) %(upstream:short)',
3817 'refs/heads'])
3818 if not branches:
3819 print('No local branches found.')
3820 return 0
3821
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003822 # Create a dictionary of all local branches to the branches that are
3823 # dependent on it.
rmistry@google.com2dd99862015-06-22 12:22:18 +00003824 tracked_to_dependents = collections.defaultdict(list)
3825 for b in branches.splitlines():
3826 tokens = b.split()
3827 if len(tokens) == 2:
3828 branch_name, tracked = tokens
3829 tracked_to_dependents[tracked].append(branch_name)
3830
vapiera7fbd5a2016-06-16 09:17:49 -07003831 print()
3832 print('The dependent local branches of %s are:' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003833 dependents = []
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003834
rmistry@google.com2dd99862015-06-22 12:22:18 +00003835 def traverse_dependents_preorder(branch, padding=''):
3836 dependents_to_process = tracked_to_dependents.get(branch, [])
3837 padding += ' '
3838 for dependent in dependents_to_process:
vapiera7fbd5a2016-06-16 09:17:49 -07003839 print('%s%s' % (padding, dependent))
rmistry@google.com2dd99862015-06-22 12:22:18 +00003840 dependents.append(dependent)
3841 traverse_dependents_preorder(dependent, padding)
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00003842
rmistry@google.com2dd99862015-06-22 12:22:18 +00003843 traverse_dependents_preorder(root_branch)
vapiera7fbd5a2016-06-16 09:17:49 -07003844 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003845
3846 if not dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003847 print('There are no dependent local branches for %s' % root_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003848 return 0
3849
Andrii Shyshkalovabc26ac2017-03-14 14:49:38 +01003850 confirm_or_exit('This command will checkout all dependent branches and run '
3851 '"git cl upload".', action='continue')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003852
rmistry@google.com2dd99862015-06-22 12:22:18 +00003853 # Record all dependents that failed to upload.
3854 failures = {}
3855 # Go through all dependents, checkout the branch and upload.
3856 try:
3857 for dependent_branch in dependents:
vapiera7fbd5a2016-06-16 09:17:49 -07003858 print()
3859 print('--------------------------------------')
3860 print('Running "git cl upload" from %s:' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003861 RunGit(['checkout', '-q', dependent_branch])
vapiera7fbd5a2016-06-16 09:17:49 -07003862 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003863 try:
3864 if CMDupload(OptionParser(), args) != 0:
vapiera7fbd5a2016-06-16 09:17:49 -07003865 print('Upload failed for %s!' % dependent_branch)
rmistry@google.com2dd99862015-06-22 12:22:18 +00003866 failures[dependent_branch] = 1
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08003867 except: # pylint: disable=bare-except
rmistry@google.com2dd99862015-06-22 12:22:18 +00003868 failures[dependent_branch] = 1
vapiera7fbd5a2016-06-16 09:17:49 -07003869 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003870 finally:
3871 # Swap back to the original root branch.
3872 RunGit(['checkout', '-q', root_branch])
3873
vapiera7fbd5a2016-06-16 09:17:49 -07003874 print()
3875 print('Upload complete for dependent branches!')
rmistry@google.com2dd99862015-06-22 12:22:18 +00003876 for dependent_branch in dependents:
3877 upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded'
vapiera7fbd5a2016-06-16 09:17:49 -07003878 print(' %s : %s' % (dependent_branch, upload_status))
3879 print()
rmistry@google.com2dd99862015-06-22 12:22:18 +00003880
3881 return 0
3882
3883
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003884@metrics.collector.collect_metrics('git cl archive')
kmarshall3bff56b2016-06-06 18:31:47 -07003885def CMDarchive(parser, args):
3886 """Archives and deletes branches associated with closed changelists."""
3887 parser.add_option(
3888 '-j', '--maxjobs', action='store', type=int,
kmarshall9249e012016-08-23 12:02:16 -07003889 help='The maximum number of jobs to use when retrieving review status.')
kmarshall3bff56b2016-06-06 18:31:47 -07003890 parser.add_option(
3891 '-f', '--force', action='store_true',
3892 help='Bypasses the confirmation prompt.')
kmarshall9249e012016-08-23 12:02:16 -07003893 parser.add_option(
3894 '-d', '--dry-run', action='store_true',
3895 help='Skip the branch tagging and removal steps.')
3896 parser.add_option(
3897 '-t', '--notags', action='store_true',
3898 help='Do not tag archived branches. '
3899 'Note: local commit history may be lost.')
kmarshall3bff56b2016-06-06 18:31:47 -07003900
kmarshall3bff56b2016-06-06 18:31:47 -07003901 options, args = parser.parse_args(args)
3902 if args:
3903 parser.error('Unsupported args: %s' % ' '.join(args))
kmarshall3bff56b2016-06-06 18:31:47 -07003904
3905 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
3906 if not branches:
3907 return 0
3908
vapiera7fbd5a2016-06-16 09:17:49 -07003909 print('Finding all branches associated with closed issues...')
Edward Lemur934836a2019-09-09 20:16:54 +00003910 changes = [Changelist(branchref=b)
3911 for b in branches.splitlines()]
kmarshall3bff56b2016-06-06 18:31:47 -07003912 alignment = max(5, max(len(c.GetBranch()) for c in changes))
3913 statuses = get_cl_statuses(changes,
3914 fine_grained=True,
3915 max_processes=options.maxjobs)
3916 proposal = [(cl.GetBranch(),
3917 'git-cl-archived-%s-%s' % (cl.GetIssue(), cl.GetBranch()))
3918 for cl, status in statuses
Andrii Shyshkalov51bdf8c2018-10-18 01:07:58 +00003919 if status in ('closed', 'rietveld-not-supported')]
kmarshall3bff56b2016-06-06 18:31:47 -07003920 proposal.sort()
3921
3922 if not proposal:
vapiera7fbd5a2016-06-16 09:17:49 -07003923 print('No branches with closed codereview issues found.')
kmarshall3bff56b2016-06-06 18:31:47 -07003924 return 0
3925
3926 current_branch = GetCurrentBranch()
3927
vapiera7fbd5a2016-06-16 09:17:49 -07003928 print('\nBranches with closed issues that will be archived:\n')
kmarshall9249e012016-08-23 12:02:16 -07003929 if options.notags:
3930 for next_item in proposal:
3931 print(' ' + next_item[0])
3932 else:
3933 print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name'))
3934 for next_item in proposal:
3935 print('%*s %s' % (alignment, next_item[0], next_item[1]))
kmarshall3bff56b2016-06-06 18:31:47 -07003936
kmarshall9249e012016-08-23 12:02:16 -07003937 # Quit now on precondition failure or if instructed by the user, either
3938 # via an interactive prompt or by command line flags.
3939 if options.dry_run:
3940 print('\nNo changes were made (dry run).\n')
3941 return 0
3942 elif any(branch == current_branch for branch, _ in proposal):
kmarshall3bff56b2016-06-06 18:31:47 -07003943 print('You are currently on a branch \'%s\' which is associated with a '
3944 'closed codereview issue, so archive cannot proceed. Please '
3945 'checkout another branch and run this command again.' %
3946 current_branch)
3947 return 1
kmarshall9249e012016-08-23 12:02:16 -07003948 elif not options.force:
sergiyb4a5ecbe2016-06-20 09:46:00 -07003949 answer = ask_for_data('\nProceed with deletion (Y/n)? ').lower()
3950 if answer not in ('y', ''):
vapiera7fbd5a2016-06-16 09:17:49 -07003951 print('Aborted.')
kmarshall3bff56b2016-06-06 18:31:47 -07003952 return 1
3953
3954 for branch, tagname in proposal:
kmarshall9249e012016-08-23 12:02:16 -07003955 if not options.notags:
3956 RunGit(['tag', tagname, branch])
kmarshall3bff56b2016-06-06 18:31:47 -07003957 RunGit(['branch', '-D', branch])
kmarshall9249e012016-08-23 12:02:16 -07003958
vapiera7fbd5a2016-06-16 09:17:49 -07003959 print('\nJob\'s done!')
kmarshall3bff56b2016-06-06 18:31:47 -07003960
3961 return 0
3962
3963
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00003964@metrics.collector.collect_metrics('git cl status')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003965def CMDstatus(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003966 """Show status of changelists.
3967
3968 Colors are used to tell the state of the CL unless --fast is used:
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003969 - Blue waiting for review
Aaron Gable9ab38c62017-04-06 14:36:33 -07003970 - Yellow waiting for you to reply to review, or not yet sent
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003971 - Green LGTM'ed
Aaron Gable9ab38c62017-04-06 14:36:33 -07003972 - Red 'not LGTM'ed
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00003973 - Magenta in the CQ
jsbell@chromium.orgaeab41a2013-12-10 20:01:22 +00003974 - Cyan was committed, branch can be deleted
Aaron Gable9ab38c62017-04-06 14:36:33 -07003975 - White error, or unknown status
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00003976
3977 Also see 'git cl comments'.
3978 """
Alan Cuttera3be9a52019-03-04 18:50:33 +00003979 parser.add_option(
3980 '--no-branch-color',
3981 action='store_true',
3982 help='Disable colorized branch names')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003983 parser.add_option('--field',
phajdan.jr289d03e2016-08-16 08:21:06 -07003984 help='print only specific field (desc|id|patch|status|url)')
maruel@chromium.org1033efd2013-07-23 23:25:09 +00003985 parser.add_option('-f', '--fast', action='store_true',
3986 help='Do not retrieve review status')
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00003987 parser.add_option(
3988 '-j', '--maxjobs', action='store', type=int,
3989 help='The maximum number of jobs to use when retrieving review status')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003990
iannuccie53c9352016-08-17 14:40:40 -07003991 _add_codereview_issue_select_options(
3992 parser, 'Must be in conjunction with --field.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00003993 options, args = parser.parse_args(args)
Edward Lemurf38bc172019-09-03 21:02:13 +00003994 _process_codereview_select_options(parser, options)
maruel@chromium.org39c0b222013-08-17 16:57:01 +00003995 if args:
3996 parser.error('Unsupported args: %s' % args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00003997
iannuccie53c9352016-08-17 14:40:40 -07003998 if options.issue is not None and not options.field:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00003999 parser.error('--field must be specified with --issue.')
iannucci3c972b92016-08-17 13:24:10 -07004000
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004001 if options.field:
Edward Lemur934836a2019-09-09 20:16:54 +00004002 cl = Changelist(issue=options.issue)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004003 if options.field.startswith('desc'):
vapiera7fbd5a2016-06-16 09:17:49 -07004004 print(cl.GetDescription())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004005 elif options.field == 'id':
4006 issueid = cl.GetIssue()
4007 if issueid:
vapiera7fbd5a2016-06-16 09:17:49 -07004008 print(issueid)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004009 elif options.field == 'patch':
Aaron Gablee8856ee2017-12-07 12:41:46 -08004010 patchset = cl.GetMostRecentPatchset()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004011 if patchset:
vapiera7fbd5a2016-06-16 09:17:49 -07004012 print(patchset)
phajdan.jr289d03e2016-08-16 08:21:06 -07004013 elif options.field == 'status':
4014 print(cl.GetStatus())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004015 elif options.field == 'url':
4016 url = cl.GetIssueURL()
4017 if url:
vapiera7fbd5a2016-06-16 09:17:49 -07004018 print(url)
maruel@chromium.orge25c75b2013-07-23 18:30:56 +00004019 return 0
4020
4021 branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads'])
4022 if not branches:
4023 print('No local branch found.')
4024 return 0
4025
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00004026 changes = [
Edward Lemur934836a2019-09-09 20:16:54 +00004027 Changelist(branchref=b)
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00004028 for b in branches.splitlines()]
vapiera7fbd5a2016-06-16 09:17:49 -07004029 print('Branches associated with reviews:')
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00004030 output = get_cl_statuses(changes,
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00004031 fine_grained=not options.fast,
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00004032 max_processes=options.maxjobs)
maruel@chromium.org1033efd2013-07-23 23:25:09 +00004033
Daniel McArdlea23bf592019-02-12 00:25:12 +00004034 current_branch = GetCurrentBranch()
4035
4036 def FormatBranchName(branch, colorize=False):
4037 """Simulates 'git branch' behavior. Colorizes and prefixes branch name with
4038 an asterisk when it is the current branch."""
4039
4040 asterisk = ""
4041 color = Fore.RESET
4042 if branch == current_branch:
4043 asterisk = "* "
4044 color = Fore.GREEN
4045 branch_name = ShortBranchName(branch)
4046
4047 if colorize:
4048 return asterisk + color + branch_name + Fore.RESET
Daniel McArdle452a49f2019-02-14 17:28:31 +00004049 return asterisk + branch_name
4050
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00004051 branch_statuses = {}
Daniel McArdlea23bf592019-02-12 00:25:12 +00004052
4053 alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes))
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00004054 for cl in sorted(changes, key=lambda c: c.GetBranch()):
4055 branch = cl.GetBranch()
calamity@chromium.orgffde55c2015-03-12 00:44:17 +00004056 while branch not in branch_statuses:
clemensh@chromium.orgcbd7dc32016-05-31 10:33:50 +00004057 c, status = output.next()
4058 branch_statuses[c.GetBranch()] = status
4059 status = branch_statuses.pop(branch)
4060 url = cl.GetIssueURL()
4061 if url and (not status or status == 'error'):
4062 # The issue probably doesn't exist anymore.
4063 url += ' (broken)'
4064
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00004065 color = color_for_status(status)
maruel@chromium.org885f6512013-07-27 02:17:26 +00004066 reset = Fore.RESET
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00004067 if not setup_color.IS_TTY:
maruel@chromium.org885f6512013-07-27 02:17:26 +00004068 color = ''
4069 reset = ''
nodir@chromium.orga6de1f42015-06-10 04:23:17 +00004070 status_str = '(%s)' % status if status else ''
Daniel McArdle452a49f2019-02-14 17:28:31 +00004071
Alan Cuttera3be9a52019-03-04 18:50:33 +00004072 branch_display = FormatBranchName(branch)
4073 padding = ' ' * (alignment - len(branch_display))
4074 if not options.no_branch_color:
4075 branch_display = FormatBranchName(branch, colorize=True)
Daniel McArdle452a49f2019-02-14 17:28:31 +00004076
Alan Cuttera3be9a52019-03-04 18:50:33 +00004077 print(' %s : %s%s %s%s' % (padding + branch_display, color, url,
4078 status_str, reset))
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01004079
vapiera7fbd5a2016-06-16 09:17:49 -07004080 print()
Daniel McArdlea23bf592019-02-12 00:25:12 +00004081 print('Current branch: %s' % current_branch)
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01004082 for cl in changes:
Daniel McArdlea23bf592019-02-12 00:25:12 +00004083 if cl.GetBranch() == current_branch:
Andrii Shyshkalovd0e1d9d2017-01-24 17:10:51 +01004084 break
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00004085 if not cl.GetIssue():
vapiera7fbd5a2016-06-16 09:17:49 -07004086 print('No issue assigned.')
dpranke@chromium.orgee87f582015-07-31 18:46:25 +00004087 return 0
vapiera7fbd5a2016-06-16 09:17:49 -07004088 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
maruel@chromium.org85616e02014-07-28 15:37:55 +00004089 if not options.fast:
vapiera7fbd5a2016-06-16 09:17:49 -07004090 print('Issue description:')
4091 print(cl.GetDescription(pretty=True))
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004092 return 0
4093
4094
maruel@chromium.org39c0b222013-08-17 16:57:01 +00004095def colorize_CMDstatus_doc():
4096 """To be called once in main() to add colors to git cl status help."""
4097 colors = [i for i in dir(Fore) if i[0].isupper()]
4098
4099 def colorize_line(line):
4100 for color in colors:
4101 if color in line.upper():
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004102 # Extract whitespace first and the leading '-'.
maruel@chromium.org39c0b222013-08-17 16:57:01 +00004103 indent = len(line) - len(line.lstrip(' ')) + 1
4104 return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET
4105 return line
4106
4107 lines = CMDstatus.__doc__.splitlines()
4108 CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines)
4109
4110
phajdan.jre328cf92016-08-22 04:12:17 -07004111def write_json(path, contents):
Stefan Zager1306bd02017-06-22 19:26:46 -07004112 if path == '-':
4113 json.dump(contents, sys.stdout)
4114 else:
4115 with open(path, 'w') as f:
4116 json.dump(contents, f)
phajdan.jre328cf92016-08-22 04:12:17 -07004117
4118
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004119@subcommand.usage('[issue_number]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004120@metrics.collector.collect_metrics('git cl issue')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004121def CMDissue(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004122 """Sets or displays the current code review issue number.
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004123
4124 Pass issue number 0 to clear the current issue.
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004125 """
dnj@chromium.org406c4402015-03-03 17:22:28 +00004126 parser.add_option('-r', '--reverse', action='store_true',
4127 help='Lookup the branch(es) for the specified issues. If '
4128 'no issues are specified, all branches with mapped '
4129 'issues will be listed.')
Stefan Zager1306bd02017-06-22 19:26:46 -07004130 parser.add_option('--json',
4131 help='Path to JSON output file, or "-" for stdout.')
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004132 _add_codereview_select_options(parser)
dnj@chromium.org406c4402015-03-03 17:22:28 +00004133 options, args = parser.parse_args(args)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004134 _process_codereview_select_options(parser, options)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004135
dnj@chromium.org406c4402015-03-03 17:22:28 +00004136 if options.reverse:
4137 branches = RunGit(['for-each-ref', 'refs/heads',
Aaron Gablead64abd2017-12-04 09:49:13 -08004138 '--format=%(refname)']).splitlines()
dnj@chromium.org406c4402015-03-03 17:22:28 +00004139 # Reverse issue lookup.
4140 issue_branch_map = {}
Daniel Bratellb56a43a2018-09-06 15:49:03 +00004141
4142 git_config = {}
4143 for config in RunGit(['config', '--get-regexp',
4144 r'branch\..*issue']).splitlines():
4145 name, _space, val = config.partition(' ')
4146 git_config[name] = val
4147
dnj@chromium.org406c4402015-03-03 17:22:28 +00004148 for branch in branches:
Daniel Bratellb56a43a2018-09-06 15:49:03 +00004149 for cls in _CODEREVIEW_IMPLEMENTATIONS.values():
4150 config_key = _git_branch_config_key(ShortBranchName(branch),
4151 cls.IssueConfigKey())
4152 issue = git_config.get(config_key)
4153 if issue:
4154 issue_branch_map.setdefault(int(issue), []).append(branch)
dnj@chromium.org406c4402015-03-03 17:22:28 +00004155 if not args:
4156 args = sorted(issue_branch_map.iterkeys())
phajdan.jre328cf92016-08-22 04:12:17 -07004157 result = {}
dnj@chromium.org406c4402015-03-03 17:22:28 +00004158 for issue in args:
Lei Zhang5a368d42019-03-25 23:18:19 +00004159 try:
4160 issue_num = int(issue)
4161 except ValueError:
4162 print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr)
dnj@chromium.org406c4402015-03-03 17:22:28 +00004163 continue
Lei Zhang5a368d42019-03-25 23:18:19 +00004164 result[issue_num] = issue_branch_map.get(issue_num)
vapiera7fbd5a2016-06-16 09:17:49 -07004165 print('Branch for issue number %s: %s' % (
Lei Zhang5a368d42019-03-25 23:18:19 +00004166 issue, ', '.join(issue_branch_map.get(issue_num) or ('None',))))
phajdan.jre328cf92016-08-22 04:12:17 -07004167 if options.json:
4168 write_json(options.json, result)
Aaron Gable78753da2017-06-15 10:35:49 -07004169 return 0
4170
4171 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00004172 issue = ParseIssueNumberArgument(args[0])
Aaron Gable78753da2017-06-15 10:35:49 -07004173 if not issue.valid:
4174 DieWithError('Pass a url or number to set the issue, 0 to unset it, '
4175 'or no argument to list it.\n'
4176 'Maybe you want to run git cl status?')
Edward Lemurf38bc172019-09-03 21:02:13 +00004177 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07004178 cl.SetIssue(issue.issue)
dnj@chromium.org406c4402015-03-03 17:22:28 +00004179 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00004180 cl = Changelist()
Aaron Gable78753da2017-06-15 10:35:49 -07004181 print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL()))
4182 if options.json:
4183 write_json(options.json, {
4184 'issue': cl.GetIssue(),
4185 'issue_url': cl.GetIssueURL(),
4186 })
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004187 return 0
4188
4189
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004190@metrics.collector.collect_metrics('git cl comments')
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00004191def CMDcomments(parser, args):
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004192 """Shows or posts review comments for any changelist."""
4193 parser.add_option('-a', '--add-comment', dest='comment',
4194 help='comment to add to an issue')
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00004195 parser.add_option('-p', '--publish', action='store_true',
4196 help='marks CL as ready and sends comment to reviewers')
Andrii Shyshkalov0d6b46e2017-03-17 22:23:22 +01004197 parser.add_option('-i', '--issue', dest='issue',
Edward Lemurf38bc172019-09-03 21:02:13 +00004198 help='review issue id (defaults to current issue).')
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07004199 parser.add_option('-m', '--machine-readable', dest='readable',
4200 action='store_false', default=True,
4201 help='output comments in a format compatible with '
4202 'editor parsing')
smut@google.comc85ac942015-09-15 16:34:43 +00004203 parser.add_option('-j', '--json-file',
Stefan Zager1306bd02017-06-22 19:26:46 -07004204 help='File to write JSON summary to, or "-" for stdout')
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01004205 _add_codereview_select_options(parser)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004206 options, args = parser.parse_args(args)
Andrii Shyshkalov625986d2017-03-16 00:24:37 +01004207 _process_codereview_select_options(parser, options)
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00004208
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004209 issue = None
4210 if options.issue:
4211 try:
4212 issue = int(options.issue)
4213 except ValueError:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004214 DieWithError('A review issue ID is expected to be a number.')
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004215
Edward Lemur934836a2019-09-09 20:16:54 +00004216 cl = Changelist(issue=issue)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004217
4218 if options.comment:
Sergiy Byelozyorovcb629a42018-10-28 19:20:39 +00004219 cl.AddComment(options.comment, options.publish)
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004220 return 0
4221
Aaron Gable0ffdf2d2017-06-05 13:01:17 -07004222 summary = sorted(cl.GetCommentsSummary(readable=options.readable),
4223 key=lambda c: c.date)
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004224 for comment in summary:
4225 if comment.disapproval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004226 color = Fore.RED
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004227 elif comment.approval:
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004228 color = Fore.GREEN
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004229 elif comment.sender == cl.GetIssueOwner():
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004230 color = Fore.MAGENTA
Quinten Yearsley0e617c02019-02-20 00:37:03 +00004231 elif comment.autogenerated:
4232 color = Fore.CYAN
apavlov@chromium.orge4efd512014-11-05 09:05:29 +00004233 else:
4234 color = Fore.BLUE
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004235 print('\n%s%s %s%s\n%s' % (
4236 color,
4237 comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'),
4238 comment.sender,
4239 Fore.RESET,
4240 '\n'.join(' ' + l for l in comment.message.strip().splitlines())))
4241
smut@google.comc85ac942015-09-15 16:34:43 +00004242 if options.json_file:
Andrii Shyshkalovd8aa49f2017-03-17 16:05:49 +01004243 def pre_serialize(c):
4244 dct = c.__dict__.copy()
4245 dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f')
4246 return dct
Leszek Swirski45b20c42018-09-17 17:05:26 +00004247 write_json(options.json_file, map(pre_serialize, summary))
maruel@chromium.org9977a2e2012-06-06 22:30:56 +00004248 return 0
4249
4250
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004251@subcommand.usage('[codereview url or issue id]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004252@metrics.collector.collect_metrics('git cl description')
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004253def CMDdescription(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004254 """Brings up the editor for the current CL's description."""
smut@google.com34fb6b12015-07-13 20:03:26 +00004255 parser.add_option('-d', '--display', action='store_true',
4256 help='Display the description instead of opening an editor')
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004257 parser.add_option('-n', '--new-description',
dnjba1b0f32016-09-02 12:37:42 -07004258 help='New description to set for this issue (- for stdin, '
4259 '+ to load from local commit HEAD)')
dsansomee2d6fd92016-09-08 00:10:47 -07004260 parser.add_option('-f', '--force', action='store_true',
4261 help='Delete any unpublished Gerrit edits for this issue '
4262 'without prompting')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004263
4264 _add_codereview_select_options(parser)
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004265 options, args = parser.parse_args(args)
4266 _process_codereview_select_options(parser, options)
4267
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004268 target_issue_arg = None
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004269 if len(args) > 0:
Edward Lemurf38bc172019-09-03 21:02:13 +00004270 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004271 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004272 parser.error('Invalid issue ID or URL.')
martiniss@chromium.org2b55fe32016-04-26 20:28:54 +00004273
Edward Lemur934836a2019-09-09 20:16:54 +00004274 kwargs = {}
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004275 detected_codereview_from_url = False
Andrii Shyshkalov8039be72017-01-26 09:38:18 +01004276 if target_issue_arg:
4277 kwargs['issue'] = target_issue_arg.issue
4278 kwargs['codereview_host'] = target_issue_arg.hostname
Edward Lemurf38bc172019-09-03 21:02:13 +00004279 if not args[0].isdigit() and not options.forced_codereview:
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004280 detected_codereview_from_url = True
martiniss6eda05f2016-06-30 10:18:35 -07004281
4282 cl = Changelist(**kwargs)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004283 if not cl.GetIssue():
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004284 assert not detected_codereview_from_url
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004285 DieWithError('This branch has no associated changelist.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004286
4287 if detected_codereview_from_url:
Edward Lemurf38bc172019-09-03 21:02:13 +00004288 logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004289
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004290 description = ChangeDescription(cl.GetDescription())
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004291
smut@google.com34fb6b12015-07-13 20:03:26 +00004292 if options.display:
vapiera7fbd5a2016-06-16 09:17:49 -07004293 print(description.description)
smut@google.com34fb6b12015-07-13 20:03:26 +00004294 return 0
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004295
4296 if options.new_description:
4297 text = options.new_description
4298 if text == '-':
4299 text = '\n'.join(l.rstrip() for l in sys.stdin)
dnjba1b0f32016-09-02 12:37:42 -07004300 elif text == '+':
4301 base_branch = cl.GetCommonAncestorWithUpstream()
4302 change = cl.GetChange(base_branch, None, local_description=True)
4303 text = change.FullDescriptionText()
martiniss@chromium.orgd6648e22016-04-29 19:22:16 +00004304
4305 description.set_description(text)
4306 else:
Edward Lemurf38bc172019-09-03 21:02:13 +00004307 description.prompt()
Andrii Shyshkalov680253d2017-03-15 21:07:36 +01004308 if cl.GetDescription().strip() != description.description:
dsansomee2d6fd92016-09-08 00:10:47 -07004309 cl.UpdateDescription(description.description, force=options.force)
rsesek@chromium.orgeec76592013-05-20 16:27:57 +00004310 return 0
4311
4312
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004313@metrics.collector.collect_metrics('git cl lint')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004314def CMDlint(parser, args):
4315 """Runs cpplint on the current changelist."""
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004316 parser.add_option('--filter', action='append', metavar='-x,+y',
4317 help='Comma-separated list of cpplint\'s category-filters')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004318 options, args = parser.parse_args(args)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004319
4320 # Access to a protected member _XX of a client class
Quinten Yearsleyb2cc4a92016-12-15 13:53:26 -08004321 # pylint: disable=protected-access
thestig@chromium.org44202a22014-03-11 19:22:18 +00004322 try:
4323 import cpplint
4324 import cpplint_chromium
4325 except ImportError:
vapiera7fbd5a2016-06-16 09:17:49 -07004326 print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.')
thestig@chromium.org44202a22014-03-11 19:22:18 +00004327 return 1
4328
4329 # Change the current working directory before calling lint so that it
4330 # shows the correct base.
4331 previous_cwd = os.getcwd()
4332 os.chdir(settings.GetRoot())
4333 try:
Edward Lemur934836a2019-09-09 20:16:54 +00004334 cl = Changelist()
thestig@chromium.org44202a22014-03-11 19:22:18 +00004335 change = cl.GetChange(cl.GetCommonAncestorWithUpstream(), None)
4336 files = [f.LocalPath() for f in change.AffectedFiles()]
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004337 if not files:
vapiera7fbd5a2016-06-16 09:17:49 -07004338 print('Cannot lint an empty CL')
thestig@chromium.org5839eb52014-05-30 16:20:51 +00004339 return 1
thestig@chromium.org44202a22014-03-11 19:22:18 +00004340
4341 # Process cpplints arguments if any.
tzik@chromium.orgf204d4b2014-03-13 07:40:55 +00004342 command = args + files
4343 if options.filter:
4344 command = ['--filter=' + ','.join(options.filter)] + command
4345 filenames = cpplint.ParseArguments(command)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004346
4347 white_regex = re.compile(settings.GetLintRegex())
4348 black_regex = re.compile(settings.GetLintIgnoreRegex())
4349 extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace]
4350 for filename in filenames:
4351 if white_regex.match(filename):
4352 if black_regex.match(filename):
vapiera7fbd5a2016-06-16 09:17:49 -07004353 print('Ignoring file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004354 else:
4355 cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level,
4356 extra_check_functions)
4357 else:
vapiera7fbd5a2016-06-16 09:17:49 -07004358 print('Skipping file %s' % filename)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004359 finally:
4360 os.chdir(previous_cwd)
vapiera7fbd5a2016-06-16 09:17:49 -07004361 print('Total errors found: %d\n' % cpplint._cpplint_state.error_count)
thestig@chromium.org44202a22014-03-11 19:22:18 +00004362 if cpplint._cpplint_state.error_count != 0:
4363 return 1
4364 return 0
4365
4366
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004367@metrics.collector.collect_metrics('git cl presubmit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004368def CMDpresubmit(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004369 """Runs presubmit tests on the current changelist."""
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004370 parser.add_option('-u', '--upload', action='store_true',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004371 help='Run upload hook instead of the push hook')
ilevy@chromium.org375a9022013-01-07 01:12:05 +00004372 parser.add_option('-f', '--force', action='store_true',
sbc@chromium.org495ad152012-09-04 23:07:42 +00004373 help='Run checks even if tree is dirty')
Aaron Gable8076c282017-11-29 14:39:41 -08004374 parser.add_option('--all', action='store_true',
4375 help='Run checks against all files, not just modified ones')
Edward Lesmes8e282792018-04-03 18:50:29 -04004376 parser.add_option('--parallel', action='store_true',
4377 help='Run all tests specified by input_api.RunTests in all '
4378 'PRESUBMIT files in parallel.')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004379 options, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004380
sbc@chromium.org71437c02015-04-09 19:29:40 +00004381 if not options.force and git_common.is_dirty_git_tree('presubmit'):
vapiera7fbd5a2016-06-16 09:17:49 -07004382 print('use --force to check even if tree is dirty.')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004383 return 1
4384
Edward Lemur934836a2019-09-09 20:16:54 +00004385 cl = Changelist()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004386 if args:
4387 base_branch = args[0]
4388 else:
ilevy@chromium.org0f58fa82012-11-05 01:45:20 +00004389 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00004390 base_branch = cl.GetCommonAncestorWithUpstream()
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004391
Aaron Gable8076c282017-11-29 14:39:41 -08004392 if options.all:
4393 base_change = cl.GetChange(base_branch, None)
4394 files = [('M', f) for f in base_change.AllFiles()]
4395 change = presubmit_support.GitChange(
4396 base_change.Name(),
4397 base_change.FullDescriptionText(),
4398 base_change.RepositoryRoot(),
4399 files,
4400 base_change.issue,
4401 base_change.patchset,
4402 base_change.author_email,
4403 base_change._upstream)
4404 else:
4405 change = cl.GetChange(base_branch, None)
4406
ilevy@chromium.org051ad0e2013-03-04 21:57:34 +00004407 cl.RunHook(
4408 committing=not options.upload,
4409 may_prompt=False,
4410 verbose=options.verbose,
Edward Lesmes8e282792018-04-03 18:50:29 -04004411 change=change,
4412 parallel=options.parallel)
dpranke@chromium.org0a2bb372011-03-25 01:16:22 +00004413 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004414
4415
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004416def GenerateGerritChangeId(message):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004417 """Returns the Change ID footer value (Ixxxxxx...xxx).
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004418
4419 Works the same way as
4420 https://gerrit-review.googlesource.com/tools/hooks/commit-msg
4421 but can be called on demand on all platforms.
4422
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004423 The basic idea is to generate git hash of a state of the tree, original
4424 commit message, author/committer info and timestamps.
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004425 """
4426 lines = []
4427 tree_hash = RunGitSilent(['write-tree'])
4428 lines.append('tree %s' % tree_hash.strip())
4429 code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False)
4430 if code == 0:
4431 lines.append('parent %s' % parent.strip())
4432 author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT'])
4433 lines.append('author %s' % author.strip())
4434 committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT'])
4435 lines.append('committer %s' % committer.strip())
4436 lines.append('')
4437 # Note: Gerrit's commit-hook actually cleans message of some lines and
4438 # whitespace. This code is not doing this, but it clearly won't decrease
4439 # entropy.
4440 lines.append(message)
4441 change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'],
Raul Tambreb946b232019-03-26 14:48:46 +00004442 stdin=('\n'.join(lines)).encode())
tandrii@chromium.org65874e12016-03-04 12:03:02 +00004443 return 'I%s' % change_hash.strip()
4444
4445
Andrii Shyshkalovf3a20ae2017-01-24 21:23:57 +01004446def GetTargetRef(remote, remote_branch, target_branch):
wittman@chromium.org455dc922015-01-26 20:15:50 +00004447 """Computes the remote branch ref to use for the CL.
4448
4449 Args:
4450 remote (str): The git remote for the CL.
4451 remote_branch (str): The git remote branch for the CL.
4452 target_branch (str): The target branch specified by the user.
wittman@chromium.org455dc922015-01-26 20:15:50 +00004453 """
4454 if not (remote and remote_branch):
4455 return None
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004456
wittman@chromium.org455dc922015-01-26 20:15:50 +00004457 if target_branch:
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004458 # Canonicalize branch references to the equivalent local full symbolic
wittman@chromium.org455dc922015-01-26 20:15:50 +00004459 # refs, which are then translated into the remote full symbolic refs
4460 # below.
4461 if '/' not in target_branch:
4462 remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch)
4463 else:
4464 prefix_replacements = (
4465 ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'),
4466 ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote),
4467 ('^(refs/)?heads/', 'refs/remotes/%s/' % remote),
4468 )
4469 match = None
4470 for regex, replacement in prefix_replacements:
4471 match = re.search(regex, target_branch)
4472 if match:
4473 remote_branch = target_branch.replace(match.group(0), replacement)
4474 break
4475 if not match:
4476 # This is a branch path but not one we recognize; use as-is.
4477 remote_branch = target_branch
rmistry@google.comc68112d2015-03-03 12:48:06 +00004478 elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS:
4479 # Handle the refs that need to land in different refs.
4480 remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch]
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004481
wittman@chromium.org455dc922015-01-26 20:15:50 +00004482 # Create the true path to the remote branch.
4483 # Does the following translation:
4484 # * refs/remotes/origin/refs/diff/test -> refs/diff/test
4485 # * refs/remotes/origin/master -> refs/heads/master
4486 # * refs/remotes/branch-heads/test -> refs/branch-heads/test
4487 if remote_branch.startswith('refs/remotes/%s/refs/' % remote):
4488 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '')
4489 elif remote_branch.startswith('refs/remotes/%s/' % remote):
4490 remote_branch = remote_branch.replace('refs/remotes/%s/' % remote,
4491 'refs/heads/')
4492 elif remote_branch.startswith('refs/remotes/branch-heads'):
4493 remote_branch = remote_branch.replace('refs/remotes/', 'refs/')
Andrii Shyshkalov768f1d82016-12-08 15:10:13 +01004494
wittman@chromium.org455dc922015-01-26 20:15:50 +00004495 return remote_branch
4496
4497
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004498def cleanup_list(l):
4499 """Fixes a list so that comma separated items are put as individual items.
4500
4501 So that "--reviewers joe@c,john@c --reviewers joa@c" results in
4502 options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']).
4503 """
4504 items = sum((i.split(',') for i in l), [])
4505 stripped_items = (i.strip() for i in items)
4506 return sorted(filter(None, stripped_items))
4507
4508
Aaron Gable4db38df2017-11-03 14:59:07 -07004509@subcommand.usage('[flags]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004510@metrics.collector.collect_metrics('git cl upload')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004511def CMDupload(parser, args):
rmistry@google.com78948ed2015-07-08 23:09:57 +00004512 """Uploads the current changelist to codereview.
4513
4514 Can skip dependency patchset uploads for a branch by running:
4515 git config branch.branch_name.skip-deps-uploads True
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004516 To unset, run:
rmistry@google.com78948ed2015-07-08 23:09:57 +00004517 git config --unset branch.branch_name.skip-deps-uploads
4518 Can also set the above globally by using the --global flag.
Dominic Battre7d1c4842017-10-27 09:17:28 +02004519
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004520 If the name of the checked out branch starts with "bug-" or "fix-" followed
4521 by a bug number, this bug number is automatically populated in the CL
Dominic Battre7d1c4842017-10-27 09:17:28 +02004522 description.
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004523
4524 If subject contains text in square brackets or has "<text>: " prefix, such
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004525 text(s) is treated as Gerrit hashtags. For example, CLs with subjects:
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004526 [git-cl] add support for hashtags
4527 Foo bar: implement foo
4528 will be hashtagged with "git-cl" and "foo-bar" respectively.
rmistry@google.com78948ed2015-07-08 23:09:57 +00004529 """
ukai@chromium.orge8077812012-02-03 03:41:46 +00004530 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4531 help='bypass upload presubmit hook')
brettw@chromium.orgb65c43c2013-06-10 22:04:49 +00004532 parser.add_option('--bypass-watchlists', action='store_true',
4533 dest='bypass_watchlists',
4534 help='bypass watchlists auto CC-ing reviewers')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004535 parser.add_option('-f', '--force', action='store_true', dest='force',
ukai@chromium.orge8077812012-02-03 03:41:46 +00004536 help="force yes to questions (don't prompt)")
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004537 parser.add_option('--message', '-m', dest='message',
4538 help='message for patchset')
tandriif9aefb72016-07-01 09:06:51 -07004539 parser.add_option('-b', '--bug',
4540 help='pre-populate the bug number(s) for this issue. '
4541 'If several, separate with commas')
tandriib80458a2016-06-23 12:20:07 -07004542 parser.add_option('--message-file', dest='message_file',
4543 help='file which contains message for patchset')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004544 parser.add_option('--title', '-t', dest='title',
4545 help='title for patchset')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004546 parser.add_option('-r', '--reviewers',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004547 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004548 help='reviewer email addresses')
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004549 parser.add_option('--tbrs',
4550 action='append', default=[],
4551 help='TBR email addresses')
ukai@chromium.orge8077812012-02-03 03:41:46 +00004552 parser.add_option('--cc',
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004553 action='append', default=[],
ukai@chromium.orge8077812012-02-03 03:41:46 +00004554 help='cc email addresses')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004555 parser.add_option('--hashtag', dest='hashtags',
4556 action='append', default=[],
4557 help=('Gerrit hashtag for new CL; '
4558 'can be applied multiple times'))
adamk@chromium.org36f47302013-04-05 01:08:31 +00004559 parser.add_option('-s', '--send-mail', action='store_true',
Aaron Gable59f48512017-01-12 10:54:46 -08004560 help='send email to reviewer(s) and cc(s) immediately')
ukai@chromium.org8ef7ab22012-11-28 04:24:52 +00004561 parser.add_option('--target_branch',
pgervais@chromium.orgb9f27512014-08-08 15:52:33 +00004562 '--target-branch',
wittman@chromium.org455dc922015-01-26 20:15:50 +00004563 metavar='TARGET',
4564 help='Apply CL to remote ref TARGET. ' +
4565 'Default: remote branch head, or master')
bauerb@chromium.org27386dd2015-02-16 10:45:39 +00004566 parser.add_option('--squash', action='store_true',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004567 help='Squash multiple commits into one')
Mike Frysingera989d552019-08-14 20:51:23 +00004568 parser.add_option('--no-squash', action='store_false', dest='squash',
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004569 help='Don\'t squash multiple commits into one')
rmistry9eadede2016-09-19 11:22:43 -07004570 parser.add_option('--topic', default=None,
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004571 help='Topic to specify when uploading')
Robert Iannuccif2708bd2017-04-17 15:49:02 -07004572 parser.add_option('--tbr-owners', dest='add_owners_to', action='store_const',
4573 const='TBR', help='add a set of OWNERS to TBR')
4574 parser.add_option('--r-owners', dest='add_owners_to', action='store_const',
4575 const='R', help='add a set of OWNERS to R')
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00004576 parser.add_option('-c', '--use-commit-queue', action='store_true',
4577 help='tell the CQ to commit this patchset; '
4578 'implies --send-mail')
tandrii@chromium.orgd50452a2015-11-23 16:38:15 +00004579 parser.add_option('-d', '--cq-dry-run', dest='cq_dry_run',
4580 action='store_true',
rmistry@google.comef966222015-04-07 11:15:01 +00004581 help='Send the patchset to do a CQ dry run right after '
4582 'upload.')
Andrii Shyshkalov71f0da32019-07-15 22:45:18 +00004583 parser.add_option('--preserve-tryjobs', action='store_true',
4584 help='instruct the CQ to let tryjobs running even after '
4585 'new patchsets are uploaded instead of canceling '
4586 'prior patchset\' tryjobs')
rmistry@google.com2dd99862015-06-22 12:22:18 +00004587 parser.add_option('--dependencies', action='store_true',
4588 help='Uploads CLs of all the local branches that depend on '
4589 'the current branch')
Ravi Mistry31e7d562018-04-02 12:53:57 -04004590 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4591 help='Sends your change to the CQ after an approval. Only '
4592 'works on repos that have the Auto-Submit label '
4593 'enabled')
Edward Lesmes8e282792018-04-03 18:50:29 -04004594 parser.add_option('--parallel', action='store_true',
4595 help='Run all tests specified by input_api.RunTests in all '
4596 'PRESUBMIT files in parallel.')
pgervais@chromium.org91141372014-01-09 23:27:20 +00004597
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004598 parser.add_option('--no-autocc', action='store_true',
4599 help='Disables automatic addition of CC emails')
Nodir Turakulovd0e2cd22017-11-15 10:22:06 -08004600 parser.add_option('--private', action='store_true',
Sergiy Byelozyorov1aa405f2018-09-18 17:38:43 +00004601 help='Set the review private. This implies --no-autocc.')
4602
rmistry@google.com2dd99862015-06-22 12:22:18 +00004603 orig_args = args
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004604 _add_codereview_select_options(parser)
ukai@chromium.orge8077812012-02-03 03:41:46 +00004605 (options, args) = parser.parse_args(args)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004606 _process_codereview_select_options(parser, options)
ukai@chromium.orge8077812012-02-03 03:41:46 +00004607
sbc@chromium.org71437c02015-04-09 19:29:40 +00004608 if git_common.is_dirty_git_tree('upload'):
ukai@chromium.orge8077812012-02-03 03:41:46 +00004609 return 1
4610
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004611 options.reviewers = cleanup_list(options.reviewers)
Robert Iannucci6c98dc62017-04-18 11:38:00 -07004612 options.tbrs = cleanup_list(options.tbrs)
maruel@chromium.orgeb52a5c2013-04-10 23:17:09 +00004613 options.cc = cleanup_list(options.cc)
4614
tandriib80458a2016-06-23 12:20:07 -07004615 if options.message_file:
4616 if options.message:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004617 parser.error('Only one of --message and --message-file allowed.')
tandriib80458a2016-06-23 12:20:07 -07004618 options.message = gclient_utils.FileRead(options.message_file)
4619 options.message_file = None
4620
tandrii4d0545a2016-07-06 03:56:49 -07004621 if options.cq_dry_run and options.use_commit_queue:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004622 parser.error('Only one of --use-commit-queue and --cq-dry-run allowed.')
tandrii4d0545a2016-07-06 03:56:49 -07004623
Aaron Gableedbc4132017-09-11 13:22:28 -07004624 if options.use_commit_queue:
4625 options.send_mail = True
4626
tandrii@chromium.org512d79c2016-03-31 12:55:28 +00004627 # For sanity of test expectations, do this otherwise lazy-loading *now*.
4628 settings.GetIsGerrit()
4629
Edward Lemur934836a2019-09-09 20:16:54 +00004630 cl = Changelist()
Andrii Shyshkalov9f274432018-10-15 16:40:23 +00004631
tandrii@chromium.org9e6c3a52016-04-12 14:13:08 +00004632 return cl.CMDUpload(options, args, orig_args)
ukai@chromium.orge8077812012-02-03 03:41:46 +00004633
4634
Francois Dorayd42c6812017-05-30 15:10:20 -04004635@subcommand.usage('--description=<description file>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004636@metrics.collector.collect_metrics('git cl split')
Francois Dorayd42c6812017-05-30 15:10:20 -04004637def CMDsplit(parser, args):
4638 """Splits a branch into smaller branches and uploads CLs.
4639
4640 Creates a branch and uploads a CL for each group of files modified in the
4641 current branch that share a common OWNERS file. In the CL description and
Quinten Yearsley0c62da92017-05-31 13:39:42 -07004642 comment, the string '$directory', is replaced with the directory containing
Francois Dorayd42c6812017-05-30 15:10:20 -04004643 the shared OWNERS file.
4644 """
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004645 parser.add_option('-d', '--description', dest='description_file',
4646 help='A text file containing a CL description in which '
4647 '$directory will be replaced by each CL\'s directory.')
4648 parser.add_option('-c', '--comment', dest='comment_file',
4649 help='A text file containing a CL comment.')
4650 parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true',
Chris Watkinsba28e462017-12-13 11:22:17 +11004651 default=False,
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004652 help='List the files and reviewers for each CL that would '
4653 'be created, but don\'t create branches or CLs.')
4654 parser.add_option('--cq-dry-run', action='store_true',
4655 help='If set, will do a cq dry run for each uploaded CL. '
4656 'Please be careful when doing this; more than ~10 CLs '
4657 'has the potential to overload our build '
4658 'infrastructure. Try to upload these not during high '
4659 'load times (usually 11-3 Mountain View time). Email '
4660 'infra-dev@chromium.org with any questions.')
Takuto Ikuta51eca592019-02-14 19:40:52 +00004661 parser.add_option('-a', '--enable-auto-submit', action='store_true',
4662 default=True,
4663 help='Sends your change to the CQ after an approval. Only '
4664 'works on repos that have the Auto-Submit label '
4665 'enabled')
Francois Dorayd42c6812017-05-30 15:10:20 -04004666 options, _ = parser.parse_args(args)
4667
4668 if not options.description_file:
4669 parser.error('No --description flag specified.')
4670
4671 def WrappedCMDupload(args):
4672 return CMDupload(OptionParser(), args)
4673
4674 return split_cl.SplitCl(options.description_file, options.comment_file,
Stephen Martiniscb326682018-08-29 21:06:30 +00004675 Changelist, WrappedCMDupload, options.dry_run,
Takuto Ikuta51eca592019-02-14 19:40:52 +00004676 options.cq_dry_run, options.enable_auto_submit)
Francois Dorayd42c6812017-05-30 15:10:20 -04004677
4678
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004679@subcommand.usage('DEPRECATED')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004680@metrics.collector.collect_metrics('git cl commit')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004681def CMDdcommit(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004682 """DEPRECATED: Used to commit the current changelist via git-svn."""
4683 message = ('git-cl no longer supports committing to SVN repositories via '
4684 'git-svn. You probably want to use `git cl land` instead.')
4685 print(message)
4686 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004687
4688
Andrii Shyshkalovaa31b972017-03-24 16:16:33 +01004689# Two special branches used by git cl land.
4690MERGE_BRANCH = 'git-cl-commit'
4691CHERRY_PICK_BRANCH = 'git-cl-cherry-pick'
4692
4693
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004694@subcommand.usage('[upstream branch to apply against]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004695@metrics.collector.collect_metrics('git cl land')
pgervais@chromium.orgcee6dc42014-05-07 17:04:03 +00004696def CMDland(parser, args):
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004697 """Commits the current changelist via git.
4698
4699 In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes
4700 upstream and closes the issue automatically and atomically.
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004701 """
4702 parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks',
4703 help='bypass upload presubmit hook')
Aaron Gablef7543cd2017-07-20 14:26:31 -07004704 parser.add_option('-f', '--force', action='store_true', dest='force',
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004705 help="force yes to questions (don't prompt)")
Edward Lesmes67b3faa2018-04-13 17:50:52 -04004706 parser.add_option('--parallel', action='store_true',
4707 help='Run all tests specified by input_api.RunTests in all '
4708 'PRESUBMIT files in parallel.')
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004709 (options, args) = parser.parse_args(args)
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004710
Edward Lemur934836a2019-09-09 20:16:54 +00004711 cl = Changelist()
Aaron Gable1bc7bfe2016-12-19 10:08:14 -08004712
Robert Iannucci2e73d432018-03-14 01:10:47 -07004713 if not cl.GetIssue():
4714 DieWithError('You must upload the change first to Gerrit.\n'
4715 ' If you would rather have `git cl land` upload '
4716 'automatically for you, see http://crbug.com/642759')
4717 return cl._codereview_impl.CMDLand(options.force, options.bypass_hooks,
Olivier Robin75ee7252018-04-13 10:02:56 +02004718 options.verbose, options.parallel)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004719
4720
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004721@subcommand.usage('<patch url or issue id or issue url>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004722@metrics.collector.collect_metrics('git cl patch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004723def CMDpatch(parser, args):
marq@chromium.orge5e59002013-10-02 23:21:25 +00004724 """Patches in a code review."""
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004725 parser.add_option('-b', dest='newbranch',
4726 help='create a new branch off trunk for the patch')
qsr@chromium.org1ef44af2013-10-16 16:24:32 +00004727 parser.add_option('-f', '--force', action='store_true',
Aaron Gable62619a32017-06-16 08:22:09 -07004728 help='overwrite state on the current or chosen branch')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004729 parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit',
Edward Lemurf38bc172019-09-03 21:02:13 +00004730 help='don\'t commit after patch applies.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004731
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004732 group = optparse.OptionGroup(
4733 parser,
4734 'Options for continuing work on the current issue uploaded from a '
4735 'different clone (e.g. different machine). Must be used independently '
4736 'from the other options. No issue number should be specified, and the '
4737 'branch must have an issue number associated with it')
4738 group.add_option('--reapply', action='store_true', dest='reapply',
4739 help='Reset the branch and reapply the issue.\n'
4740 'CAUTION: This will undo any local changes in this '
4741 'branch')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004742
4743 group.add_option('--pull', action='store_true', dest='pull',
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00004744 help='Performs a pull before reapplying.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004745 parser.add_option_group(group)
4746
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004747 _add_codereview_select_options(parser)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004748 (options, args) = parser.parse_args(args)
tandrii@chromium.orgdde64622016-04-13 17:11:21 +00004749 _process_codereview_select_options(parser, options)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004750
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004751 if options.reapply:
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004752 if options.newbranch:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004753 parser.error('--reapply works on the current branch only.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004754 if len(args) > 0:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004755 parser.error('--reapply implies no additional arguments.')
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004756
Edward Lemur934836a2019-09-09 20:16:54 +00004757 cl = Changelist()
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004758 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004759 parser.error('Current branch must have an associated issue.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004760
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004761 upstream = cl.GetUpstreamBranch()
Andrii Shyshkalov18975322017-01-25 16:44:13 +01004762 if upstream is None:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004763 parser.error('No upstream branch specified. Cannot reset branch.')
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004764
4765 RunGit(['reset', '--hard', upstream])
4766 if options.pull:
4767 RunGit(['pull'])
mtrofin@chromium.org1d88dd32016-02-04 16:25:12 +00004768
Edward Lemurf38bc172019-09-03 21:02:13 +00004769 return cl.CMDPatchIssue(cl.GetIssue(), options.nocommit)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004770
4771 if len(args) != 1 or not args[0]:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004772 parser.error('Must specify issue number or URL.')
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004773
Edward Lemurf38bc172019-09-03 21:02:13 +00004774 target_issue_arg = ParseIssueNumberArgument(args[0])
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004775 if not target_issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004776 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004777
4778 cl_kwargs = {
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004779 'codereview_host': target_issue_arg.hostname,
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004780 }
4781 detected_codereview_from_url = False
Edward Lemurf38bc172019-09-03 21:02:13 +00004782 if not args[0].isdigit() and not options.forced_codereview:
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004783 detected_codereview_from_url = True
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004784 cl_kwargs['issue'] = target_issue_arg.issue
4785
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004786 # We don't want uncommitted changes mixed up with the patch.
4787 if git_common.is_dirty_git_tree('patch'):
dsinclair@chromium.orgfbed6562015-09-25 21:22:36 +00004788 return 1
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004789
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004790 if options.newbranch:
4791 if options.force:
4792 RunGit(['branch', '-D', options.newbranch],
4793 stderr=subprocess2.PIPE, error_ok=True)
4794 RunGit(['new-branch', options.newbranch])
4795
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004796 cl = Changelist(**cl_kwargs)
tandrii@chromium.orgc2786d92016-05-31 19:53:50 +00004797
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004798 if detected_codereview_from_url:
Edward Lemurf38bc172019-09-03 21:02:13 +00004799 print('canonical issue/change URL: %s\n' % cl.GetIssueURL())
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02004800
Edward Lemurf38bc172019-09-03 21:02:13 +00004801 return cl.CMDPatchWithParsedIssue(
4802 target_issue_arg, options.nocommit, options.force)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004803
4804
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004805def GetTreeStatus(url=None):
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004806 """Fetches the tree status and returns either 'open', 'closed',
4807 'unknown' or 'unset'."""
jochen@chromium.org3ec0d542014-01-14 20:00:03 +00004808 url = url or settings.GetTreeStatusUrl(error_ok=True)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004809 if url:
4810 status = urllib2.urlopen(url).read().lower()
4811 if status.find('closed') != -1 or status == '0':
4812 return 'closed'
4813 elif status.find('open') != -1 or status == '1':
4814 return 'open'
4815 return 'unknown'
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004816 return 'unset'
4817
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004818
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004819def GetTreeStatusReason():
4820 """Fetches the tree status from a json url and returns the message
4821 with the reason for the tree to be opened or closed."""
msb@chromium.orgbf1a7ba2011-02-01 16:21:46 +00004822 url = settings.GetTreeStatusUrl()
4823 json_url = urlparse.urljoin(url, '/current?format=json')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004824 connection = urllib2.urlopen(json_url)
4825 status = json.loads(connection.read())
4826 connection.close()
4827 return status['message']
4828
dpranke@chromium.org970c5222011-03-12 00:32:24 +00004829
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004830@metrics.collector.collect_metrics('git cl tree')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004831def CMDtree(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004832 """Shows the status of the tree."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004833 _, args = parser.parse_args(args)
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004834 status = GetTreeStatus()
4835 if 'unset' == status:
vapiera7fbd5a2016-06-16 09:17:49 -07004836 print('You must configure your tree status URL by running "git cl config".')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004837 return 2
4838
vapiera7fbd5a2016-06-16 09:17:49 -07004839 print('The tree is %s' % status)
4840 print()
4841 print(GetTreeStatusReason())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004842 if status != 'open':
4843 return 1
4844 return 0
4845
4846
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004847@metrics.collector.collect_metrics('git cl try')
maruel@chromium.org15192402012-09-06 12:38:29 +00004848def CMDtry(parser, args):
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004849 """Triggers tryjobs using either Buildbucket or CQ dry run."""
4850 group = optparse.OptionGroup(parser, 'Tryjob options')
maruel@chromium.org15192402012-09-06 12:38:29 +00004851 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004852 '-b', '--bot', action='append',
4853 help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple '
4854 'times to specify multiple builders. ex: '
4855 '"-b win_rel -b win_layout". See '
4856 'the try server waterfall for the builders name and the tests '
4857 'available.'))
maruel@chromium.org15192402012-09-06 12:38:29 +00004858 group.add_option(
borenet6c0efe62016-10-19 08:13:29 -07004859 '-B', '--bucket', default='',
4860 help=('Buildbucket bucket to send the try requests.'))
4861 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004862 '-r', '--revision',
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004863 help='Revision to use for the tryjob; default: the revision will '
tandriif7b29d42016-10-07 08:45:41 -07004864 'be determined by the try recipe that builder runs, which usually '
4865 'defaults to HEAD of origin/master')
maruel@chromium.org15192402012-09-06 12:38:29 +00004866 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004867 '-c', '--clobber', action='store_true', default=False,
tandriif7b29d42016-10-07 08:45:41 -07004868 help='Force a clobber before building; that is don\'t do an '
tandrii1838bad2016-10-06 00:10:52 -07004869 'incremental build')
maruel@chromium.org15192402012-09-06 12:38:29 +00004870 group.add_option(
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004871 '--category', default='git_cl_try', help='Specify custom build category.')
4872 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004873 '--project',
4874 help='Override which project to use. Projects are defined '
tandriif7b29d42016-10-07 08:45:41 -07004875 'in recipe to determine to which repository or directory to '
4876 'apply the patch')
maruel@chromium.org15192402012-09-06 12:38:29 +00004877 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004878 '-p', '--property', dest='properties', action='append', default=[],
4879 help='Specify generic properties in the form -p key1=value1 -p '
tandriif7b29d42016-10-07 08:45:41 -07004880 'key2=value2 etc. The value will be treated as '
4881 'json if decodable, or as string otherwise. '
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004882 'NOTE: using this may make your tryjob not usable for CQ, '
4883 'which will then schedule another tryjob with default properties')
sheyang@chromium.orgdb375572015-08-17 19:22:23 +00004884 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004885 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4886 help='Host of buildbucket. The default host is %default.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004887 parser.add_option_group(group)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004888 auth.add_auth_options(parser)
Koji Ishii31c14782018-01-08 17:17:33 +09004889 _add_codereview_issue_select_options(parser)
maruel@chromium.org15192402012-09-06 12:38:29 +00004890 options, args = parser.parse_args(args)
Edward Lemurf38bc172019-09-03 21:02:13 +00004891 _process_codereview_select_options(parser, options)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00004892 auth_config = auth.extract_auth_config_from_options(options)
maruel@chromium.org15192402012-09-06 12:38:29 +00004893
machenbach@chromium.org45453142015-09-15 08:45:22 +00004894 # Make sure that all properties are prop=value pairs.
4895 bad_params = [x for x in options.properties if '=' not in x]
4896 if bad_params:
4897 parser.error('Got properties with missing "=": %s' % bad_params)
4898
maruel@chromium.org15192402012-09-06 12:38:29 +00004899 if args:
4900 parser.error('Unknown arguments: %s' % args)
4901
Edward Lemur934836a2019-09-09 20:16:54 +00004902 cl = Changelist(issue=options.issue)
maruel@chromium.org15192402012-09-06 12:38:29 +00004903 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004904 parser.error('Need to upload first.')
maruel@chromium.org15192402012-09-06 12:38:29 +00004905
Edward Lemurf38bc172019-09-03 21:02:13 +00004906 # HACK: warm up Gerrit change detail cache to save on RPCs.
4907 cl._codereview_impl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS'])
Andrii Shyshkaloveadad922017-01-26 09:38:30 +01004908
tandriie113dfd2016-10-11 10:20:12 -07004909 error_message = cl.CannotTriggerTryJobReason()
4910 if error_message:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004911 parser.error('Can\'t trigger tryjobs: %s' % error_message)
jrobbins@chromium.org16f10f72014-06-24 22:14:36 +00004912
qyearsley1fdfcb62016-10-24 13:22:03 -07004913 buckets = _get_bucket_map(cl, options, parser)
Edward Lemurc8b67ed2019-09-12 20:28:58 +00004914 if buckets and any(b.startswith('master.') for b in buckets):
4915 print('ERROR: Buildbot masters are not supported.')
4916 return 1
phajdan.jr@chromium.org8da7f272014-03-14 01:28:39 +00004917
qyearsleydd49f942016-10-28 11:57:22 -07004918 # If no bots are listed and we couldn't get a list based on PRESUBMIT files,
4919 # then we default to triggering a CQ dry run (see http://crbug.com/625697).
qyearsley1fdfcb62016-10-24 13:22:03 -07004920 if not buckets:
qyearsley1fdfcb62016-10-24 13:22:03 -07004921 if options.verbose:
Quinten Yearsleyfc5fd922017-05-31 11:50:52 -07004922 print('git cl try with no bots now defaults to CQ dry run.')
4923 print('Scheduling CQ dry run on: %s' % cl.GetIssueURL())
4924 return cl.SetCQState(_CQState.DRY_RUN)
stip@chromium.org43064fd2013-12-18 20:07:44 +00004925
borenet6c0efe62016-10-19 08:13:29 -07004926 for builders in buckets.itervalues():
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00004927 if any('triggered' in b for b in builders):
vapiera7fbd5a2016-06-16 09:17:49 -07004928 print('ERROR You are trying to send a job to a triggered bot. This type '
tandriide281ae2016-10-12 06:02:30 -07004929 'of bot requires an initial job from a parent (usually a builder). '
4930 'Instead send your job to the parent.\n'
vapiera7fbd5a2016-06-16 09:17:49 -07004931 'Bot list: %s' % builders, file=sys.stderr)
machenbach@chromium.org58a69cb2014-03-01 02:08:29 +00004932 return 1
ilevy@chromium.orgf3b21232012-09-24 20:48:55 +00004933
ilevy@chromium.org36e420b2013-08-06 23:21:12 +00004934 patchset = cl.GetMostRecentPatchset()
tandrii568043b2016-10-11 07:49:18 -07004935 try:
Andrii Shyshkalovf9648b52018-02-21 22:32:42 -08004936 _trigger_try_jobs(auth_config, cl, buckets, options, patchset)
tandrii568043b2016-10-11 07:49:18 -07004937 except BuildbucketResponseException as ex:
4938 print('ERROR: %s' % ex)
4939 return 1
maruel@chromium.org15192402012-09-06 12:38:29 +00004940 return 0
4941
4942
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004943@metrics.collector.collect_metrics('git cl try-results')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004944def CMDtry_results(parser, args):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00004945 """Prints info about results for tryjobs associated with the current CL."""
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004946 group = optparse.OptionGroup(parser, 'Tryjob results options')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004947 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004948 '-p', '--patchset', type=int, help='patchset number if not current.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004949 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004950 '--print-master', action='store_true', help='print master name as well.')
tandrii@chromium.org6cf98c82016-03-15 11:56:00 +00004951 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004952 '--color', action='store_true', default=setup_color.IS_TTY,
4953 help='force color output, useful when piping output.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004954 group.add_option(
tandrii1838bad2016-10-06 00:10:52 -07004955 '--buildbucket-host', default='cr-buildbucket.appspot.com',
4956 help='Host of buildbucket. The default host is %default.')
qyearsley53f48a12016-09-01 10:45:13 -07004957 group.add_option(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00004958 '--json', help=('Path of JSON output file to write tryjob results to,'
Stefan Zager1306bd02017-06-22 19:26:46 -07004959 'or "-" for stdout.'))
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004960 parser.add_option_group(group)
4961 auth.add_auth_options(parser)
Stefan Zager27db3f22017-10-10 15:15:01 -07004962 _add_codereview_issue_select_options(parser)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004963 options, args = parser.parse_args(args)
Edward Lemurf38bc172019-09-03 21:02:13 +00004964 _process_codereview_select_options(parser, options)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004965 if args:
4966 parser.error('Unrecognized args: %s' % ' '.join(args))
4967
4968 auth_config = auth.extract_auth_config_from_options(options)
Edward Lemur934836a2019-09-09 20:16:54 +00004969 cl = Changelist(issue=options.issue)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004970 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004971 parser.error('Need to upload first.')
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004972
tandrii221ab252016-10-06 08:12:04 -07004973 patchset = options.patchset
4974 if not patchset:
4975 patchset = cl.GetMostRecentPatchset()
4976 if not patchset:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004977 parser.error('Code review host doesn\'t know about issue %s. '
tandrii221ab252016-10-06 08:12:04 -07004978 'No access to issue or wrong issue number?\n'
Quinten Yearsleyc4202212019-07-22 23:34:40 +00004979 'Either upload first, or pass --patchset explicitly.' %
tandrii221ab252016-10-06 08:12:04 -07004980 cl.GetIssue())
4981
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004982 try:
tandrii221ab252016-10-06 08:12:04 -07004983 jobs = fetch_try_jobs(auth_config, cl, options.buildbucket_host, patchset)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004984 except BuildbucketResponseException as ex:
vapiera7fbd5a2016-06-16 09:17:49 -07004985 print('Buildbucket error: %s' % ex)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004986 return 1
qyearsley53f48a12016-09-01 10:45:13 -07004987 if options.json:
4988 write_try_results_json(options.json, jobs)
4989 else:
4990 print_try_jobs(options, jobs)
tandrii@chromium.orgb015fac2016-02-26 14:52:01 +00004991 return 0
4992
4993
maruel@chromium.org0633fb42013-08-16 20:06:14 +00004994@subcommand.usage('[new upstream branch]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00004995@metrics.collector.collect_metrics('git cl upstream')
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00004996def CMDupstream(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00004997 """Prints or sets the name of the upstream branch, if any."""
dpranke@chromium.org97ae58e2011-03-18 00:29:20 +00004998 _, args = parser.parse_args(args)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00004999 if len(args) > 1:
maruel@chromium.org27bb3872011-05-30 20:33:19 +00005000 parser.error('Unrecognized args: %s' % ' '.join(args))
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00005001
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005002 cl = Changelist()
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00005003 if args:
5004 # One arg means set upstream branch.
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00005005 branch = cl.GetBranch()
stip7a3dd352016-09-22 17:32:28 -07005006 RunGit(['branch', '--set-upstream-to', args[0], branch])
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00005007 cl = Changelist()
vapiera7fbd5a2016-06-16 09:17:49 -07005008 print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),))
bauerb@chromium.orgc9cf90a2014-04-28 20:32:31 +00005009
5010 # Clear configured merge-base, if there is one.
5011 git_common.remove_merge_base(branch)
brettw@chromium.orgac0ba332012-08-09 23:42:53 +00005012 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005013 print(cl.GetUpstreamBranch())
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005014 return 0
5015
5016
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005017@metrics.collector.collect_metrics('git cl web')
thestig@chromium.org00858c82013-12-02 23:08:03 +00005018def CMDweb(parser, args):
5019 """Opens the current CL in the web browser."""
5020 _, args = parser.parse_args(args)
5021 if args:
5022 parser.error('Unrecognized args: %s' % ' '.join(args))
5023
5024 issue_url = Changelist().GetIssueURL()
5025 if not issue_url:
vapiera7fbd5a2016-06-16 09:17:49 -07005026 print('ERROR No issue to open', file=sys.stderr)
thestig@chromium.org00858c82013-12-02 23:08:03 +00005027 return 1
5028
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00005029 # Redirect I/O before invoking browser to hide its output. For example, this
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005030 # allows us to hide the "Created new window in existing browser session."
5031 # message from Chrome. Based on https://stackoverflow.com/a/2323563.
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00005032 saved_stdout = os.dup(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00005033 saved_stderr = os.dup(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00005034 os.close(1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00005035 os.close(2)
Sergiy Byelozyorov2b718322018-10-24 17:43:31 +00005036 os.open(os.devnull, os.O_RDWR)
5037 try:
5038 webbrowser.open(issue_url)
5039 finally:
5040 os.dup2(saved_stdout, 1)
Sergiy Belozorov06684032019-03-06 16:53:08 +00005041 os.dup2(saved_stderr, 2)
thestig@chromium.org00858c82013-12-02 23:08:03 +00005042 return 0
5043
5044
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005045@metrics.collector.collect_metrics('git cl set-commit')
maruel@chromium.org27bb3872011-05-30 20:33:19 +00005046def CMDset_commit(parser, args):
Andrii Shyshkalov0e889b72019-07-15 22:28:48 +00005047 """Sets the commit bit to trigger the CQ."""
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005048 parser.add_option('-d', '--dry-run', action='store_true',
5049 help='trigger in dry run mode')
5050 parser.add_option('-c', '--clear', action='store_true',
5051 help='stop CQ run, if any')
iannuccie53c9352016-08-17 14:40:40 -07005052 _add_codereview_issue_select_options(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005053 options, args = parser.parse_args(args)
Edward Lemurf38bc172019-09-03 21:02:13 +00005054 _process_codereview_select_options(parser, options)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00005055 if args:
5056 parser.error('Unrecognized args: %s' % ' '.join(args))
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005057 if options.dry_run and options.clear:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005058 parser.error('Only one of --dry-run and --clear are allowed.')
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005059
Edward Lemur934836a2019-09-09 20:16:54 +00005060 cl = Changelist(issue=options.issue)
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005061 if options.clear:
tandriid9e5ce52016-07-13 02:32:59 -07005062 state = _CQState.NONE
tandrii@chromium.orgfa330e82016-04-13 17:09:52 +00005063 elif options.dry_run:
5064 state = _CQState.DRY_RUN
5065 else:
5066 state = _CQState.COMMIT
5067 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005068 parser.error('Must upload the issue first.')
tandrii9de9ec62016-07-13 03:01:59 -07005069 cl.SetCQState(state)
maruel@chromium.org27bb3872011-05-30 20:33:19 +00005070 return 0
5071
5072
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005073@metrics.collector.collect_metrics('git cl set-close')
groby@chromium.org411034a2013-02-26 15:12:01 +00005074def CMDset_close(parser, args):
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005075 """Closes the issue."""
iannuccie53c9352016-08-17 14:40:40 -07005076 _add_codereview_issue_select_options(parser)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005077 options, args = parser.parse_args(args)
Edward Lemurf38bc172019-09-03 21:02:13 +00005078 _process_codereview_select_options(parser, options)
groby@chromium.org411034a2013-02-26 15:12:01 +00005079 if args:
5080 parser.error('Unrecognized args: %s' % ' '.join(args))
Edward Lemur934836a2019-09-09 20:16:54 +00005081 cl = Changelist(issue=options.issue)
groby@chromium.org411034a2013-02-26 15:12:01 +00005082 # Ensure there actually is an issue to close.
Aaron Gable7139a4e2017-09-05 17:53:09 -07005083 if not cl.GetIssue():
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005084 DieWithError('ERROR: No issue to close.')
groby@chromium.org411034a2013-02-26 15:12:01 +00005085 cl.CloseIssue()
5086 return 0
5087
5088
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005089@metrics.collector.collect_metrics('git cl diff')
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005090def CMDdiff(parser, args):
wychen@chromium.org37b2ec02015-04-03 00:49:15 +00005091 """Shows differences between local tree and last upload."""
thomasanderson074beb22016-08-29 14:03:20 -07005092 parser.add_option(
5093 '--stat',
5094 action='store_true',
5095 dest='stat',
5096 help='Generate a diffstat')
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005097 options, args = parser.parse_args(args)
vadimsh@chromium.orgcf6a5d22015-04-09 22:02:00 +00005098 if args:
5099 parser.error('Unrecognized args: %s' % ' '.join(args))
wychen@chromium.org46309bf2015-04-03 21:04:49 +00005100
Edward Lemur934836a2019-09-09 20:16:54 +00005101 cl = Changelist()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00005102 issue = cl.GetIssue()
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005103 branch = cl.GetBranch()
sbc@chromium.org78dc9842013-11-25 18:43:44 +00005104 if not issue:
5105 DieWithError('No issue found for current branch (%s)' % branch)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005106
Aaron Gablea718c3e2017-08-28 17:47:28 -07005107 base = cl._GitGetBranchConfigValue('last-upload-hash')
5108 if not base:
5109 base = cl._GitGetBranchConfigValue('gerritsquashhash')
5110 if not base:
5111 detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT'])
5112 revision_info = detail['revisions'][detail['current_revision']]
5113 fetch_info = revision_info['fetch']['http']
5114 RunGit(['fetch', fetch_info['url'], fetch_info['ref']])
5115 base = 'FETCH_HEAD'
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005116
Aaron Gablea718c3e2017-08-28 17:47:28 -07005117 cmd = ['git', 'diff']
5118 if options.stat:
5119 cmd.append('--stat')
5120 cmd.append(base)
5121 subprocess2.check_call(cmd)
sbc@chromium.org87b9bf02013-09-26 20:35:15 +00005122
5123 return 0
5124
5125
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005126@metrics.collector.collect_metrics('git cl owners')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005127def CMDowners(parser, args):
Dirk Prankebf980882017-09-02 15:08:00 -07005128 """Finds potential owners for reviewing."""
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005129 parser.add_option(
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00005130 '--ignore-current',
5131 action='store_true',
5132 help='Ignore the CL\'s current reviewers and start from scratch.')
5133 parser.add_option(
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00005134 '--ignore-self',
5135 action='store_true',
5136 help='Do not consider CL\'s author as an owners.')
5137 parser.add_option(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005138 '--no-color',
5139 action='store_true',
5140 help='Use this option to disable color output')
Dirk Prankebf980882017-09-02 15:08:00 -07005141 parser.add_option(
5142 '--batch',
5143 action='store_true',
5144 help='Do not run interactively, just suggest some')
Yang Guo6e269a02019-06-26 11:17:02 +00005145 # TODO: Consider moving this to another command, since other
5146 # git-cl owners commands deal with owners for a given CL.
5147 parser.add_option(
5148 '--show-all',
5149 action='store_true',
5150 help='Show all owners for a particular file')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005151 options, args = parser.parse_args(args)
5152
5153 author = RunGit(['config', 'user.email']).strip() or None
5154
Edward Lemur934836a2019-09-09 20:16:54 +00005155 cl = Changelist()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005156
Yang Guo6e269a02019-06-26 11:17:02 +00005157 if options.show_all:
5158 for arg in args:
5159 base_branch = cl.GetCommonAncestorWithUpstream()
5160 change = cl.GetChange(base_branch, None)
5161 database = owners.Database(change.RepositoryRoot(), file, os.path)
5162 database.load_data_needed_for([arg])
5163 print('Owners for %s:' % arg)
5164 for owner in sorted(database.all_possible_owners([arg], None)):
5165 print(' - %s' % owner)
5166 return 0
5167
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005168 if args:
5169 if len(args) > 1:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005170 parser.error('Unknown args.')
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005171 base_branch = args[0]
5172 else:
5173 # Default to diffing against the common ancestor of the upstream branch.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005174 base_branch = cl.GetCommonAncestorWithUpstream()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005175
5176 change = cl.GetChange(base_branch, None)
Dirk Prankebf980882017-09-02 15:08:00 -07005177 affected_files = [f.LocalPath() for f in change.AffectedFiles()]
5178
5179 if options.batch:
5180 db = owners.Database(change.RepositoryRoot(), file, os.path)
5181 print('\n'.join(db.reviewers_for(affected_files, author)))
5182 return 0
5183
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005184 return owners_finder.OwnersFinder(
Dirk Prankebf980882017-09-02 15:08:00 -07005185 affected_files,
Jochen Eisinger72606f82017-04-04 10:44:18 +02005186 change.RepositoryRoot(),
Edward Lemur707d70b2018-02-07 00:50:14 +01005187 author,
Sidney San Martín8e6f58c2018-06-08 01:02:56 +00005188 [] if options.ignore_current else cl.GetReviewers(),
Edward Lemur707d70b2018-02-07 00:50:14 +01005189 fopen=file, os_path=os.path,
Jochen Eisingerd0573ec2017-04-13 10:55:06 +02005190 disable_color=options.no_color,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +00005191 override_files=change.OriginalOwnersFiles(),
5192 ignore_author=options.ignore_self).run()
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00005193
5194
Aiden Bennerc08566e2018-10-03 17:52:42 +00005195def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005196 """Generates a diff command."""
5197 # Generate diff for the current branch's changes.
Aiden Bennerc08566e2018-10-03 17:52:42 +00005198 diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff']
5199
Aiden Benner6c18a1a2018-11-23 20:18:23 +00005200 if allow_prefix:
5201 # explicitly setting --src-prefix and --dst-prefix is necessary in the
5202 # case that diff.noprefix is set in the user's git config.
5203 diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/']
5204 else:
Aiden Bennerc08566e2018-10-03 17:52:42 +00005205 diff_cmd += ['--no-prefix']
5206
5207 diff_cmd += [diff_type, upstream_commit, '--']
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005208
5209 if args:
5210 for arg in args:
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005211 if os.path.isdir(arg) or os.path.isfile(arg):
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005212 diff_cmd.append(arg)
5213 else:
5214 DieWithError('Argument "%s" is not a file or a directory' % arg)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005215
5216 return diff_cmd
5217
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005218
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005219def MatchingFileType(file_name, extensions):
Quinten Yearsleyd242ed72019-07-25 17:17:55 +00005220 """Returns True if the file name ends with one of the given extensions."""
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005221 return bool([ext for ext in extensions if file_name.lower().endswith(ext)])
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005222
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005223
enne@chromium.org555cfe42014-01-29 18:21:39 +00005224@subcommand.usage('[files or directories to diff]')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005225@metrics.collector.collect_metrics('git cl format')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005226def CMDformat(parser, args):
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005227 """Runs auto-formatting tools (clang-format etc.) on the diff."""
Christopher Lamc5ba6922017-01-24 11:19:14 +11005228 CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java']
kylechar58edce22016-06-17 06:07:51 -07005229 GN_EXTS = ['.gn', '.gni', '.typemap']
enne@chromium.org3b7e15c2014-01-21 17:44:47 +00005230 parser.add_option('--full', action='store_true',
5231 help='Reformat the full content of all touched files')
5232 parser.add_option('--dry-run', action='store_true',
5233 help='Don\'t modify any file on disk.')
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005234 parser.add_option(
5235 '--python',
5236 action='store_true',
5237 default=None,
5238 help='Enables python formatting on all python files.')
5239 parser.add_option(
5240 '--no-python',
5241 action='store_true',
5242 dest='python',
5243 help='Disables python formatting on all python files. '
5244 'Takes precedence over --python. '
5245 'If neither --python or --no-python are set, python '
5246 'files that have a .style.yapf file in an ancestor '
5247 'directory will be formatted.')
Christopher Lamc5ba6922017-01-24 11:19:14 +11005248 parser.add_option('--js', action='store_true',
5249 help='Format javascript code with clang-format.')
wittman@chromium.org04d5a222014-03-07 18:30:42 +00005250 parser.add_option('--diff', action='store_true',
5251 help='Print diff to stdout rather than modifying files.')
Ilya Shermane081cbe2017-08-15 17:51:04 -07005252 parser.add_option('--presubmit', action='store_true',
5253 help='Used when running the script from a presubmit.')
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005254 opts, args = parser.parse_args(args)
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005255
Daniel Chengc55eecf2016-12-30 03:11:02 -08005256 # Normalize any remaining args against the current path, so paths relative to
5257 # the current directory are still resolved as expected.
5258 args = [os.path.join(os.getcwd(), arg) for arg in args]
5259
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005260 # git diff generates paths against the root of the repository. Change
5261 # to that directory so clang-format can find files even within subdirs.
thestig@chromium.org8b0553c2014-02-11 00:33:37 +00005262 rel_base_path = settings.GetRelativeRoot()
enne@chromium.orgff7a1fb2013-12-10 19:21:41 +00005263 if rel_base_path:
5264 os.chdir(rel_base_path)
5265
digit@chromium.org29e47272013-05-17 17:01:46 +00005266 # Grab the merge-base commit, i.e. the upstream commit of the current
5267 # branch when it was created or the last time it was rebased. This is
5268 # to cover the case where the user may have called "git fetch origin",
5269 # moving the origin branch to a newer commit, but hasn't rebased yet.
5270 upstream_commit = None
5271 cl = Changelist()
5272 upstream_branch = cl.GetUpstreamBranch()
5273 if upstream_branch:
5274 upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch])
5275 upstream_commit = upstream_commit.strip()
5276
5277 if not upstream_commit:
5278 DieWithError('Could not find base commit for this branch. '
5279 'Are you in detached state?')
5280
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005281 changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args)
5282 diff_output = RunGit(changed_files_cmd)
5283 diff_files = diff_output.splitlines()
jkarlin@chromium.orgad21b922016-01-28 17:48:42 +00005284 # Filter out files deleted by this CL
5285 diff_files = [x for x in diff_files if os.path.isfile(x)]
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005286
Christopher Lamc5ba6922017-01-24 11:19:14 +11005287 if opts.js:
Deepanjan Roy605dd312018-07-02 17:48:54 +00005288 CLANG_EXTS.extend(['.js', '.ts'])
Christopher Lamc5ba6922017-01-24 11:19:14 +11005289
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005290 clang_diff_files = [x for x in diff_files if MatchingFileType(x, CLANG_EXTS)]
5291 python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])]
5292 dart_diff_files = [x for x in diff_files if MatchingFileType(x, ['.dart'])]
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005293 gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)]
digit@chromium.org29e47272013-05-17 17:01:46 +00005294
nick@chromium.org3ac1c4e2014-01-16 02:44:42 +00005295 top_dir = os.path.normpath(
5296 RunGit(["rev-parse", "--show-toplevel"]).rstrip('\n'))
5297
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005298 # Set to 2 to signal to CheckPatchFormatted() that this patch isn't
5299 # formatted. This is used to block during the presubmit.
5300 return_value = 0
5301
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005302 if clang_diff_files:
techtonik@gmail.com5573df12016-04-12 18:34:10 +00005303 # Locate the clang-format binary in the checkout
5304 try:
5305 clang_format_tool = clang_format.FindClangFormatToolInChromiumTree()
vapierfd77ac72016-06-16 08:33:57 -07005306 except clang_format.NotFoundError as e:
techtonik@gmail.com5573df12016-04-12 18:34:10 +00005307 DieWithError(e)
5308
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005309 if opts.full:
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005310 cmd = [clang_format_tool]
5311 if not opts.dry_run and not opts.diff:
5312 cmd.append('-i')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005313 stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005314 if opts.diff:
5315 sys.stdout.write(stdout)
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005316 else:
5317 env = os.environ.copy()
5318 env['PATH'] = str(os.path.dirname(clang_format_tool))
5319 try:
5320 script = clang_format.FindClangFormatScriptInChromiumTree(
5321 'clang-format-diff.py')
vapierfd77ac72016-06-16 08:33:57 -07005322 except clang_format.NotFoundError as e:
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005323 DieWithError(e)
digit@chromium.orgd6ddc1c2013-10-25 15:36:32 +00005324
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005325 cmd = [sys.executable, script, '-p0']
5326 if not opts.dry_run and not opts.diff:
5327 cmd.append('-i')
digit@chromium.orgd6ddc1c2013-10-25 15:36:32 +00005328
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005329 diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files)
5330 diff_output = RunGit(diff_cmd)
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005331
sammc@chromium.org0b35f5d2016-02-25 22:39:23 +00005332 stdout = RunCommand(cmd, stdin=diff_output, cwd=top_dir, env=env)
5333 if opts.diff:
5334 sys.stdout.write(stdout)
5335 if opts.dry_run and len(stdout) > 0:
5336 return_value = 2
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005337
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005338 # Similar code to above, but using yapf on .py files rather than clang-format
5339 # on C/C++ files
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005340 py_explicitly_disabled = opts.python is not None and not opts.python
5341 if python_diff_files and not py_explicitly_disabled:
Aiden Bennere47ac152018-11-20 16:44:03 +00005342 depot_tools_path = os.path.dirname(os.path.abspath(__file__))
5343 yapf_tool = os.path.join(depot_tools_path, 'yapf')
5344 if sys.platform.startswith('win'):
5345 yapf_tool += '.bat'
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005346
Aiden Bennerc08566e2018-10-03 17:52:42 +00005347 # If we couldn't find a yapf file we'll default to the chromium style
5348 # specified in depot_tools.
Aiden Bennerc08566e2018-10-03 17:52:42 +00005349 chromium_default_yapf_style = os.path.join(depot_tools_path,
5350 YAPF_CONFIG_FILENAME)
Aiden Bennerc08566e2018-10-03 17:52:42 +00005351 # Used for caching.
5352 yapf_configs = {}
5353 for f in python_diff_files:
5354 # Find the yapf style config for the current file, defaults to depot
5355 # tools default.
Aiden Benner99b0ccb2018-11-20 19:53:31 +00005356 _FindYapfConfigFile(f, yapf_configs, top_dir)
5357
5358 # Turn on python formatting by default if a yapf config is specified.
5359 # This breaks in the case of this repo though since the specified
5360 # style file is also the global default.
5361 if opts.python is None:
5362 filtered_py_files = []
5363 for f in python_diff_files:
5364 if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None:
5365 filtered_py_files.append(f)
5366 else:
5367 filtered_py_files = python_diff_files
5368
5369 # Note: yapf still seems to fix indentation of the entire file
5370 # even if line ranges are specified.
5371 # See https://github.com/google/yapf/issues/499
5372 if not opts.full and filtered_py_files:
5373 py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit)
5374
5375 for f in filtered_py_files:
5376 yapf_config = _FindYapfConfigFile(f, yapf_configs, top_dir)
5377 if yapf_config is None:
5378 yapf_config = chromium_default_yapf_style
Aiden Bennerc08566e2018-10-03 17:52:42 +00005379
5380 cmd = [yapf_tool, '--style', yapf_config, f]
5381
5382 has_formattable_lines = False
5383 if not opts.full:
5384 # Only run yapf over changed line ranges.
5385 for diff_start, diff_len in py_line_diffs[f]:
5386 diff_end = diff_start + diff_len - 1
5387 # Yapf errors out if diff_end < diff_start but this
5388 # is a valid line range diff for a removal.
5389 if diff_end >= diff_start:
5390 has_formattable_lines = True
5391 cmd += ['-l', '{}-{}'.format(diff_start, diff_end)]
5392 # If all line diffs were removals we have nothing to format.
5393 if not has_formattable_lines:
5394 continue
5395
5396 if opts.diff or opts.dry_run:
5397 cmd += ['--diff']
5398 # Will return non-zero exit code if non-empty diff.
5399 stdout = RunCommand(cmd, error_ok=True, cwd=top_dir)
5400 if opts.diff:
5401 sys.stdout.write(stdout)
5402 elif len(stdout) > 0:
5403 return_value = 2
5404 else:
5405 cmd += ['-i']
5406 RunCommand(cmd, cwd=top_dir)
sbc@chromium.org9d0644d2015-06-05 23:16:54 +00005407
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005408 # Dart's formatter does not have the nice property of only operating on
5409 # modified chunks, so hard code full.
5410 if dart_diff_files:
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005411 try:
5412 command = [dart_format.FindDartFmtToolInChromiumTree()]
5413 if not opts.dry_run and not opts.diff:
5414 command.append('-w')
jkarlin@chromium.org6f7fa5e2016-01-20 19:32:21 +00005415 command.extend(dart_diff_files)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005416
ppi@chromium.org6593d932016-03-03 15:41:15 +00005417 stdout = RunCommand(command, cwd=top_dir)
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005418 if opts.dry_run and stdout:
5419 return_value = 2
5420 except dart_format.NotFoundError as e:
vapiera7fbd5a2016-06-16 09:17:49 -07005421 print('Warning: Unable to check Dart code formatting. Dart SDK not '
5422 'found in this checkout. Files in other languages are still '
5423 'formatted.')
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005424
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005425 # Format GN build files. Always run on full build files for canonical form.
5426 if gn_diff_files:
Andrii Shyshkalov18975322017-01-25 16:44:13 +01005427 cmd = ['gn', 'format']
brettw4b8ed592016-08-05 16:19:12 -07005428 if opts.dry_run or opts.diff:
5429 cmd.append('--dry-run')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005430 for gn_diff_file in gn_diff_files:
brettw4b8ed592016-08-05 16:19:12 -07005431 gn_ret = subprocess2.call(cmd + [gn_diff_file],
5432 shell=sys.platform == 'win32',
5433 cwd=top_dir)
5434 if opts.dry_run and gn_ret == 2:
5435 return_value = 2 # Not formatted.
5436 elif opts.diff and gn_ret == 2:
5437 # TODO this should compute and print the actual diff.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005438 print('This change has GN build file diff for ' + gn_diff_file)
brettw4b8ed592016-08-05 16:19:12 -07005439 elif gn_ret != 0:
5440 # For non-dry run cases (and non-2 return values for dry-run), a
5441 # nonzero error code indicates a failure, probably because the file
5442 # doesn't parse.
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005443 DieWithError('gn format failed on ' + gn_diff_file +
5444 '\nTry running `gn format` on this file manually.')
kylechar@chromium.org8b61f112016-02-05 13:28:58 +00005445
Ilya Shermane081cbe2017-08-15 17:51:04 -07005446 # Skip the metrics formatting from the global presubmit hook. These files have
5447 # a separate presubmit hook that issues an error if the files need formatting,
5448 # whereas the top-level presubmit script merely issues a warning. Formatting
5449 # these files is somewhat slow, so it's important not to duplicate the work.
5450 if not opts.presubmit:
5451 for xml_dir in GetDirtyMetricsDirs(diff_files):
5452 tool_dir = os.path.join(top_dir, xml_dir)
5453 cmd = [os.path.join(tool_dir, 'pretty_print.py'), '--non-interactive']
5454 if opts.dry_run or opts.diff:
5455 cmd.append('--diff')
Ilya Sherman235b70d2017-08-22 17:46:38 -07005456 stdout = RunCommand(cmd, cwd=top_dir)
Ilya Shermane081cbe2017-08-15 17:51:04 -07005457 if opts.diff:
5458 sys.stdout.write(stdout)
5459 if opts.dry_run and stdout:
5460 return_value = 2 # Not formatted.
Alexei Svitkinef3cac412017-02-06 11:08:50 -05005461
erg@chromium.orge0a7c5d2015-02-23 20:30:08 +00005462 return return_value
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005463
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005464
Steven Holte2e664bf2017-04-21 13:10:47 -07005465def GetDirtyMetricsDirs(diff_files):
5466 xml_diff_files = [x for x in diff_files if MatchingFileType(x, ['.xml'])]
5467 metrics_xml_dirs = [
5468 os.path.join('tools', 'metrics', 'actions'),
5469 os.path.join('tools', 'metrics', 'histograms'),
5470 os.path.join('tools', 'metrics', 'rappor'),
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005471 os.path.join('tools', 'metrics', 'ukm'),
5472 ]
Steven Holte2e664bf2017-04-21 13:10:47 -07005473 for xml_dir in metrics_xml_dirs:
5474 if any(file.startswith(xml_dir) for file in xml_diff_files):
5475 yield xml_dir
5476
agable@chromium.orgfab8f822013-05-06 17:43:09 +00005477
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005478@subcommand.usage('<codereview url or issue id>')
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005479@metrics.collector.collect_metrics('git cl checkout')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005480def CMDcheckout(parser, args):
Edward Lemurf38bc172019-09-03 21:02:13 +00005481 """Checks out a branch associated with a given Gerrit issue."""
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005482 _, args = parser.parse_args(args)
5483
5484 if len(args) != 1:
5485 parser.print_help()
5486 return 1
5487
tandrii@chromium.orgf86c7d32016-04-01 19:27:30 +00005488 issue_arg = ParseIssueNumberArgument(args[0])
tandrii@chromium.orgde6c9a12016-04-11 15:33:53 +00005489 if not issue_arg.valid:
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005490 parser.error('Invalid issue ID or URL.')
Andrii Shyshkalovc9712392017-04-11 13:35:21 +02005491
tandrii@chromium.orgabd27e52016-04-11 15:43:32 +00005492 target_issue = str(issue_arg.issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005493
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005494 def find_issues(issueprefix):
tandrii@chromium.org26c8fd22016-04-11 21:33:21 +00005495 output = RunGit(['config', '--local', '--get-regexp',
5496 r'branch\..*\.%s' % issueprefix],
5497 error_ok=True)
5498 for key, issue in [x.split() for x in output.splitlines()]:
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005499 if issue == target_issue:
5500 yield re.sub(r'branch\.(.*)\.%s' % issueprefix, r'\1', key)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005501
tandrii@chromium.org5df290f2016-04-11 16:12:29 +00005502 branches = []
5503 for cls in _CODEREVIEW_IMPLEMENTATIONS.values():
tandrii5d48c322016-08-18 16:19:37 -07005504 branches.extend(find_issues(cls.IssueConfigKey()))
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005505 if len(branches) == 0:
vapiera7fbd5a2016-06-16 09:17:49 -07005506 print('No branch found for issue %s.' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005507 return 1
5508 if len(branches) == 1:
5509 RunGit(['checkout', branches[0]])
5510 else:
vapiera7fbd5a2016-06-16 09:17:49 -07005511 print('Multiple branches match issue %s:' % target_issue)
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005512 for i in range(len(branches)):
vapiera7fbd5a2016-06-16 09:17:49 -07005513 print('%d: %s' % (i, branches[i]))
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005514 which = raw_input('Choose by index: ')
5515 try:
5516 RunGit(['checkout', branches[int(which)]])
5517 except (IndexError, ValueError):
vapiera7fbd5a2016-06-16 09:17:49 -07005518 print('Invalid selection, not checking out any branch.')
scottmg@chromium.org84a80c42015-09-22 20:40:37 +00005519 return 1
5520
5521 return 0
5522
5523
maruel@chromium.org29404b52014-09-08 22:58:00 +00005524def CMDlol(parser, args):
5525 # This command is intentionally undocumented.
vapiera7fbd5a2016-06-16 09:17:49 -07005526 print(zlib.decompress(base64.b64decode(
thakis@chromium.org3421c992014-11-02 02:20:32 +00005527 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE'
5528 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9'
5529 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W'
vapiera7fbd5a2016-06-16 09:17:49 -07005530 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')))
maruel@chromium.org29404b52014-09-08 22:58:00 +00005531 return 0
5532
5533
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005534class OptionParser(optparse.OptionParser):
5535 """Creates the option parse and add --verbose support."""
5536 def __init__(self, *args, **kwargs):
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005537 optparse.OptionParser.__init__(
5538 self, *args, prog='git cl', version=__version__, **kwargs)
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005539 self.add_option(
5540 '-v', '--verbose', action='count', default=0,
5541 help='Use 2 times for more debugging info')
5542
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005543 def parse_args(self, args=None, _values=None):
Andrii Shyshkalov46f20cd2018-10-30 06:42:54 +00005544 try:
5545 return self._parse_args(args)
5546 finally:
5547 # Regardless of success or failure of args parsing, we want to report
5548 # metrics, but only after logging has been initialized (if parsing
5549 # succeeded).
5550 global settings
5551 settings = Settings()
5552
5553 if not metrics.DISABLE_METRICS_COLLECTION:
5554 # GetViewVCUrl ultimately calls logging method.
5555 project_url = settings.GetViewVCUrl().strip('/+')
5556 if project_url in metrics_utils.KNOWN_PROJECT_URLS:
5557 metrics.collector.add('project_urls', [project_url])
5558
5559 def _parse_args(self, args=None):
Edward Lemur5ba1e9c2018-07-23 18:19:02 +00005560 # Create an optparse.Values object that will store only the actual passed
5561 # options, without the defaults.
5562 actual_options = optparse.Values()
5563 _, args = optparse.OptionParser.parse_args(self, args, actual_options)
5564 # Create an optparse.Values object with the default options.
5565 options = optparse.Values(self.get_default_values().__dict__)
5566 # Update it with the options passed by the user.
5567 options._update_careful(actual_options.__dict__)
5568 # Store the options passed by the user in an _actual_options attribute.
5569 # We store only the keys, and not the values, since the values can contain
5570 # arbitrary information, which might be PII.
5571 metrics.collector.add('arguments', actual_options.__dict__.keys())
5572
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005573 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
Andrii Shyshkalov5b04a572017-01-23 17:44:41 +01005574 logging.basicConfig(
5575 level=levels[min(options.verbose, len(levels) - 1)],
5576 format='[%(levelname).1s%(asctime)s %(process)d %(thread)d '
5577 '%(filename)s] %(message)s')
Edward Lemur83bd7f42018-10-10 00:14:21 +00005578
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005579 return options, args
5580
iannucci@chromium.orgd9c1b202013-07-24 23:52:11 +00005581
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005582def main(argv):
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005583 if sys.hexversion < 0x02060000:
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005584 print('\nYour Python version %s is unsupported, please upgrade.\n' %
vapiera7fbd5a2016-06-16 09:17:49 -07005585 (sys.version.split(' ', 1)[0],), file=sys.stderr)
maruel@chromium.org82798cb2012-02-23 18:16:12 +00005586 return 2
maruel@chromium.org2e23ce32013-05-07 12:42:28 +00005587
maruel@chromium.org39c0b222013-08-17 16:57:01 +00005588 colorize_CMDstatus_doc()
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005589 dispatcher = subcommand.CommandDispatcher(__name__)
5590 try:
5591 return dispatcher.execute(OptionParser(), argv)
vadimsh@chromium.orgeed4df32015-04-10 21:30:20 +00005592 except auth.AuthenticationError as e:
5593 DieWithError(str(e))
vapierfd77ac72016-06-16 08:33:57 -07005594 except urllib2.HTTPError as e:
maruel@chromium.org0633fb42013-08-16 20:06:14 +00005595 if e.code != 500:
5596 raise
5597 DieWithError(
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005598 ('App Engine is misbehaving and returned HTTP %d, again. Keep faith '
Quinten Yearsleyc4202212019-07-22 23:34:40 +00005599 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e)))
sbc@chromium.org013731e2015-02-26 18:28:43 +00005600 return 0
chase@chromium.orgcc51cd02010-12-23 00:48:39 +00005601
5602
5603if __name__ == '__main__':
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +00005604 # These affect sys.stdout, so do it outside of main() to simplify mocks in
5605 # the unit tests.
maruel@chromium.org6f09cd92011-04-01 16:38:12 +00005606 fix_encoding.fix_encoding()
iannucci@chromium.org596cd5c2016-04-04 21:34:39 +00005607 setup_color.init()
Edward Lemur6f812e12018-07-31 22:45:57 +00005608 with metrics.collector.print_notice_and_exit():
sbc@chromium.org013731e2015-02-26 18:28:43 +00005609 sys.exit(main(sys.argv[1:]))