Josip Sokcevic | 4de5dea | 2022-03-23 21:15:14 +0000 | [diff] [blame] | 1 | #!/usr/bin/env vpython3 |
Andrii Shyshkalov | 0d2dea0 | 2017-07-17 15:17:55 +0200 | [diff] [blame] | 2 | # Copyright (c) 2013 The Chromium Authors. All rights reserved. |
maruel@chromium.org | 725f1c3 | 2011-04-01 20:24:54 +0000 | [diff] [blame] | 3 | # Use of this source code is governed by a BSD-style license that can be |
| 4 | # found in the LICENSE file. |
| 5 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 6 | # Copyright (C) 2008 Evan Martin <martine@danga.com> |
| 7 | |
Andrii Shyshkalov | 03da150 | 2018-10-15 03:42:34 +0000 | [diff] [blame] | 8 | """A git-command for integrating reviews on Gerrit.""" |
maruel@chromium.org | 725f1c3 | 2011-04-01 20:24:54 +0000 | [diff] [blame] | 9 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 10 | from __future__ import print_function |
| 11 | |
thakis@chromium.org | 3421c99 | 2014-11-02 02:20:32 +0000 | [diff] [blame] | 12 | import base64 |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 13 | import collections |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 14 | import datetime |
Brian Sheedy | b4307d5 | 2019-12-02 19:18:17 +0000 | [diff] [blame] | 15 | import fnmatch |
Edward Lemur | 202c559 | 2019-10-21 22:44:52 +0000 | [diff] [blame] | 16 | import httplib2 |
Andrii Shyshkalov | 34924cd | 2017-03-15 17:08:32 +0100 | [diff] [blame] | 17 | import itertools |
maruel@chromium.org | 4f6852c | 2012-04-20 20:39:20 +0000 | [diff] [blame] | 18 | import json |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 19 | import logging |
calamity@chromium.org | cf19748 | 2016-04-29 20:15:53 +0000 | [diff] [blame] | 20 | import multiprocessing |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 21 | import optparse |
| 22 | import os |
| 23 | import re |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 24 | import shutil |
ukai@chromium.org | 78c4b98 | 2012-02-14 02:20:26 +0000 | [diff] [blame] | 25 | import stat |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 26 | import sys |
Aaron Gable | 9a03ae0 | 2017-11-03 11:31:07 -0700 | [diff] [blame] | 27 | import tempfile |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 28 | import textwrap |
Edward Lemur | fec80c4 | 2018-11-01 23:14:14 +0000 | [diff] [blame] | 29 | import time |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 30 | import uuid |
thestig@chromium.org | 00858c8 | 2013-12-02 23:08:03 +0000 | [diff] [blame] | 31 | import webbrowser |
thakis@chromium.org | 3421c99 | 2014-11-02 02:20:32 +0000 | [diff] [blame] | 32 | import zlib |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 33 | |
maruel@chromium.org | 2e23ce3 | 2013-05-07 12:42:28 +0000 | [diff] [blame] | 34 | from third_party import colorama |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 35 | import auth |
nick@chromium.org | 3ac1c4e | 2014-01-16 02:44:42 +0000 | [diff] [blame] | 36 | import clang_format |
maruel@chromium.org | 6f09cd9 | 2011-04-01 16:38:12 +0000 | [diff] [blame] | 37 | import fix_encoding |
maruel@chromium.org | 0e0436a | 2011-10-25 13:32:41 +0000 | [diff] [blame] | 38 | import gclient_utils |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 39 | import gerrit_util |
iannucci@chromium.org | 9e84927 | 2014-04-04 00:31:55 +0000 | [diff] [blame] | 40 | import git_common |
tandrii@chromium.org | 09d7a6a | 2016-03-04 15:44:48 +0000 | [diff] [blame] | 41 | import git_footers |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 42 | import git_new_branch |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 43 | import metrics |
Edward Lesmes | 93277a7 | 2018-10-18 22:04:26 +0000 | [diff] [blame] | 44 | import metrics_utils |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 45 | import owners_client |
iannucci@chromium.org | 9e84927 | 2014-04-04 00:31:55 +0000 | [diff] [blame] | 46 | import owners_finder |
Lei Zhang | b8c62cf | 2020-07-15 20:09:37 +0000 | [diff] [blame] | 47 | import presubmit_canned_checks |
maruel@chromium.org | 2a74d37 | 2011-03-29 19:05:50 +0000 | [diff] [blame] | 48 | import presubmit_support |
Lukasz Anforowicz | b4d3954 | 2021-09-30 23:39:25 +0000 | [diff] [blame] | 49 | import rustfmt |
maruel@chromium.org | 2a74d37 | 2011-03-29 19:05:50 +0000 | [diff] [blame] | 50 | import scm |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 51 | import setup_color |
Francois Doray | d42c681 | 2017-05-30 15:10:20 -0400 | [diff] [blame] | 52 | import split_cl |
maruel@chromium.org | 0633fb4 | 2013-08-16 20:06:14 +0000 | [diff] [blame] | 53 | import subcommand |
maruel@chromium.org | 32f9f5e | 2011-09-14 13:41:47 +0000 | [diff] [blame] | 54 | import subprocess2 |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 55 | import swift_format |
maruel@chromium.org | 2a74d37 | 2011-03-29 19:05:50 +0000 | [diff] [blame] | 56 | import watchlists |
| 57 | |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 58 | from third_party import six |
| 59 | from six.moves import urllib |
| 60 | |
| 61 | |
| 62 | if sys.version_info.major == 3: |
| 63 | basestring = (str,) # pylint: disable=redefined-builtin |
| 64 | |
Edward Lemur | b983024 | 2019-10-30 22:19:20 +0000 | [diff] [blame] | 65 | |
tandrii | 7400cf0 | 2016-06-21 08:48:07 -0700 | [diff] [blame] | 66 | __version__ = '2.0' |
maruel@chromium.org | 2a74d37 | 2011-03-29 19:05:50 +0000 | [diff] [blame] | 67 | |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 68 | # Traces for git push will be stored in a traces directory inside the |
| 69 | # depot_tools checkout. |
| 70 | DEPOT_TOOLS = os.path.dirname(os.path.abspath(__file__)) |
| 71 | TRACES_DIR = os.path.join(DEPOT_TOOLS, 'traces') |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 72 | PRESUBMIT_SUPPORT = os.path.join(DEPOT_TOOLS, 'presubmit_support.py') |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 73 | |
| 74 | # When collecting traces, Git hashes will be reduced to 6 characters to reduce |
| 75 | # the size after compression. |
| 76 | GIT_HASH_RE = re.compile(r'\b([a-f0-9]{6})[a-f0-9]{34}\b', flags=re.I) |
| 77 | # Used to redact the cookies from the gitcookies file. |
| 78 | GITCOOKIES_REDACT_RE = re.compile(r'1/.*') |
| 79 | |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 80 | MAX_ATTEMPTS = 3 |
| 81 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 82 | # The maximum number of traces we will keep. Multiplied by 3 since we store |
| 83 | # 3 files per trace. |
| 84 | MAX_TRACES = 3 * 10 |
Edward Lemur | 5737f02 | 2019-05-17 01:24:00 +0000 | [diff] [blame] | 85 | # Message to be displayed to the user to inform where to find the traces for a |
| 86 | # git-cl upload execution. |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 87 | TRACES_MESSAGE = ( |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 88 | '\n' |
Edward Lemur | 5737f02 | 2019-05-17 01:24:00 +0000 | [diff] [blame] | 89 | 'The traces of this git-cl execution have been recorded at:\n' |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 90 | ' %(trace_name)s-traces.zip\n' |
Edward Lemur | 5737f02 | 2019-05-17 01:24:00 +0000 | [diff] [blame] | 91 | 'Copies of your gitcookies file and git config have been recorded at:\n' |
| 92 | ' %(trace_name)s-git-info.zip\n') |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 93 | # Format of the message to be stored as part of the traces to give developers a |
| 94 | # better context when they go through traces. |
| 95 | TRACES_README_FORMAT = ( |
| 96 | 'Date: %(now)s\n' |
| 97 | '\n' |
| 98 | 'Change: https://%(gerrit_host)s/q/%(change_id)s\n' |
| 99 | 'Title: %(title)s\n' |
| 100 | '\n' |
| 101 | '%(description)s\n' |
| 102 | '\n' |
| 103 | 'Execution time: %(execution_time)s\n' |
| 104 | 'Exit code: %(exit_code)s\n') + TRACES_MESSAGE |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 105 | |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 106 | POSTUPSTREAM_HOOK = '.git/hooks/post-cl-land' |
Henrique Ferreiro | ff24962 | 2019-11-28 23:19:29 +0000 | [diff] [blame] | 107 | DESCRIPTION_BACKUP_FILE = '.git_cl_description_backup' |
rmistry@google.com | c68112d | 2015-03-03 12:48:06 +0000 | [diff] [blame] | 108 | REFS_THAT_ALIAS_TO_OTHER_REFS = { |
Josip Sokcevic | 7e133ff | 2021-07-13 17:44:53 +0000 | [diff] [blame] | 109 | 'refs/remotes/origin/lkgr': 'refs/remotes/origin/main', |
| 110 | 'refs/remotes/origin/lkcr': 'refs/remotes/origin/main', |
rmistry@google.com | c68112d | 2015-03-03 12:48:06 +0000 | [diff] [blame] | 111 | } |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 112 | |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 113 | DEFAULT_OLD_BRANCH = 'refs/remotes/origin/master' |
| 114 | DEFAULT_NEW_BRANCH = 'refs/remotes/origin/main' |
| 115 | |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 116 | DEFAULT_BUILDBUCKET_HOST = 'cr-buildbucket.appspot.com' |
| 117 | |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 118 | # Valid extensions for files we want to lint. |
| 119 | DEFAULT_LINT_REGEX = r"(.*\.cpp|.*\.cc|.*\.h)" |
| 120 | DEFAULT_LINT_IGNORE_REGEX = r"$^" |
| 121 | |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 122 | # File name for yapf style config files. |
| 123 | YAPF_CONFIG_FILENAME = '.style.yapf' |
| 124 | |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 125 | # The issue, patchset and codereview server are stored on git config for each |
| 126 | # branch under branch.<branch-name>.<config-key>. |
| 127 | ISSUE_CONFIG_KEY = 'gerritissue' |
| 128 | PATCHSET_CONFIG_KEY = 'gerritpatchset' |
| 129 | CODEREVIEW_SERVER_CONFIG_KEY = 'gerritserver' |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 130 | # When using squash workflow, _CMDUploadChange doesn't simply push the commit(s) |
| 131 | # you make to Gerrit. Instead, it creates a new commit object that contains all |
| 132 | # changes you've made, diffed against a parent/merge base. |
| 133 | # This is the hash of the new squashed commit and you can find this on Gerrit. |
| 134 | GERRIT_SQUASH_HASH_CONFIG_KEY = 'gerritsquashhash' |
| 135 | # This is the latest uploaded local commit hash. |
| 136 | LAST_UPLOAD_HASH_CONFIG_KEY = 'last-upload-hash' |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 137 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 138 | # Shortcut since it quickly becomes repetitive. |
maruel@chromium.org | 2e23ce3 | 2013-05-07 12:42:28 +0000 | [diff] [blame] | 139 | Fore = colorama.Fore |
maruel@chromium.org | 9054173 | 2011-04-01 17:54:18 +0000 | [diff] [blame] | 140 | |
maruel@chromium.org | ddd5941 | 2011-11-30 14:20:38 +0000 | [diff] [blame] | 141 | # Initialized in main() |
| 142 | settings = None |
| 143 | |
Andrii Shyshkalov | 768f1d8 | 2016-12-08 15:10:13 +0100 | [diff] [blame] | 144 | # Used by tests/git_cl_test.py to add extra logging. |
| 145 | # Inside the weirdly failing test, add this: |
| 146 | # >>> self.mock(git_cl, '_IS_BEING_TESTED', True) |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 147 | # And scroll up to see the stack trace printed. |
Andrii Shyshkalov | 768f1d8 | 2016-12-08 15:10:13 +0100 | [diff] [blame] | 148 | _IS_BEING_TESTED = False |
| 149 | |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 150 | _GOOGLESOURCE = 'googlesource.com' |
maruel@chromium.org | ddd5941 | 2011-11-30 14:20:38 +0000 | [diff] [blame] | 151 | |
Andrii Shyshkalov | 1ee78cd | 2020-03-12 01:31:53 +0000 | [diff] [blame] | 152 | _KNOWN_GERRIT_TO_SHORT_URLS = { |
| 153 | 'https://chrome-internal-review.googlesource.com': 'https://crrev.com/i', |
| 154 | 'https://chromium-review.googlesource.com': 'https://crrev.com/c', |
| 155 | } |
Andrii Shyshkalov | 8aebb60 | 2020-04-16 22:10:27 +0000 | [diff] [blame] | 156 | assert len(_KNOWN_GERRIT_TO_SHORT_URLS) == len( |
| 157 | set(_KNOWN_GERRIT_TO_SHORT_URLS.values())), 'must have unique values' |
Andrii Shyshkalov | 1ee78cd | 2020-03-12 01:31:53 +0000 | [diff] [blame] | 158 | |
| 159 | |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 160 | # Maximum number of branches in a stack that can be traversed and uploaded |
| 161 | # at once. Picked arbitrarily. |
| 162 | _MAX_STACKED_BRANCHES_UPLOAD = 20 |
| 163 | |
| 164 | |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 165 | class GitPushError(Exception): |
| 166 | pass |
| 167 | |
| 168 | |
Christopher Lam | f732cd5 | 2017-01-24 12:40:11 +1100 | [diff] [blame] | 169 | def DieWithError(message, change_desc=None): |
| 170 | if change_desc: |
| 171 | SaveDescriptionBackup(change_desc) |
Josip Sokcevic | 953278a | 2020-02-28 19:46:36 +0000 | [diff] [blame] | 172 | print('\n ** Content of CL description **\n' + |
| 173 | '='*72 + '\n' + |
| 174 | change_desc.description + '\n' + |
| 175 | '='*72 + '\n') |
Christopher Lam | f732cd5 | 2017-01-24 12:40:11 +1100 | [diff] [blame] | 176 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 177 | print(message, file=sys.stderr) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 178 | sys.exit(1) |
| 179 | |
| 180 | |
Christopher Lam | f732cd5 | 2017-01-24 12:40:11 +1100 | [diff] [blame] | 181 | def SaveDescriptionBackup(change_desc): |
Henrique Ferreiro | 5ae4817 | 2019-11-29 16:14:42 +0000 | [diff] [blame] | 182 | backup_path = os.path.join(DEPOT_TOOLS, DESCRIPTION_BACKUP_FILE) |
Andrii Shyshkalov | d9fdc1f | 2018-09-27 02:13:09 +0000 | [diff] [blame] | 183 | print('\nsaving CL description to %s\n' % backup_path) |
sokcevic | 0715280 | 2021-08-18 00:06:34 +0000 | [diff] [blame] | 184 | with open(backup_path, 'wb') as backup_file: |
| 185 | backup_file.write(change_desc.description.encode('utf-8')) |
Christopher Lam | f732cd5 | 2017-01-24 12:40:11 +1100 | [diff] [blame] | 186 | |
| 187 | |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 188 | def GetNoGitPagerEnv(): |
| 189 | env = os.environ.copy() |
| 190 | # 'cat' is a magical git string that disables pagers on all platforms. |
| 191 | env['GIT_PAGER'] = 'cat' |
| 192 | return env |
| 193 | |
vadimsh@chromium.org | 566a02a | 2014-08-22 01:34:13 +0000 | [diff] [blame] | 194 | |
bsep@chromium.org | 627d900 | 2016-04-29 00:00:52 +0000 | [diff] [blame] | 195 | def RunCommand(args, error_ok=False, error_message=None, shell=False, **kwargs): |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 196 | try: |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 197 | stdout = subprocess2.check_output(args, shell=shell, **kwargs) |
| 198 | return stdout.decode('utf-8', 'replace') |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 199 | except subprocess2.CalledProcessError as e: |
| 200 | logging.debug('Failed running %s', args) |
maruel@chromium.org | 32f9f5e | 2011-09-14 13:41:47 +0000 | [diff] [blame] | 201 | if not error_ok: |
Alan Cutter | 594fd33 | 2020-07-21 23:55:27 +0000 | [diff] [blame] | 202 | message = error_message or e.stdout.decode('utf-8', 'replace') or '' |
| 203 | DieWithError('Command "%s" failed.\n%s' % (' '.join(args), message)) |
Josip Sokcevic | 673e8ed | 2021-10-27 23:46:18 +0000 | [diff] [blame] | 204 | out = e.stdout.decode('utf-8', 'replace') |
| 205 | if e.stderr: |
| 206 | out += e.stderr.decode('utf-8', 'replace') |
| 207 | return out |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 208 | |
| 209 | |
| 210 | def RunGit(args, **kwargs): |
maruel@chromium.org | 32f9f5e | 2011-09-14 13:41:47 +0000 | [diff] [blame] | 211 | """Returns stdout.""" |
bratell@opera.com | 82b91cd | 2013-07-09 06:33:41 +0000 | [diff] [blame] | 212 | return RunCommand(['git'] + args, **kwargs) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 213 | |
| 214 | |
enne@chromium.org | 3b7e15c | 2014-01-21 17:44:47 +0000 | [diff] [blame] | 215 | def RunGitWithCode(args, suppress_stderr=False): |
maruel@chromium.org | 32f9f5e | 2011-09-14 13:41:47 +0000 | [diff] [blame] | 216 | """Returns return code and stdout.""" |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 217 | if suppress_stderr: |
Edward Lesmes | cf06cad | 2020-12-14 22:03:23 +0000 | [diff] [blame] | 218 | stderr = subprocess2.DEVNULL |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 219 | else: |
| 220 | stderr = sys.stderr |
szager@chromium.org | 9bb85e2 | 2012-06-13 20:28:23 +0000 | [diff] [blame] | 221 | try: |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 222 | (out, _), code = subprocess2.communicate(['git'] + args, |
| 223 | env=GetNoGitPagerEnv(), |
| 224 | stdout=subprocess2.PIPE, |
| 225 | stderr=stderr) |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 226 | return code, out.decode('utf-8', 'replace') |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 227 | except subprocess2.CalledProcessError as e: |
Yoshisato Yanagisawa | 81e3ff5 | 2017-09-26 15:33:34 +0900 | [diff] [blame] | 228 | logging.debug('Failed running %s', ['git'] + args) |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 229 | return e.returncode, e.stdout.decode('utf-8', 'replace') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 230 | |
| 231 | |
bauerb@chromium.org | 27386dd | 2015-02-16 10:45:39 +0000 | [diff] [blame] | 232 | def RunGitSilent(args): |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 233 | """Returns stdout, suppresses stderr and ignores the return code.""" |
bauerb@chromium.org | 27386dd | 2015-02-16 10:45:39 +0000 | [diff] [blame] | 234 | return RunGitWithCode(args, suppress_stderr=True)[1] |
| 235 | |
| 236 | |
tandrii | 2a16b95 | 2016-10-19 07:09:44 -0700 | [diff] [blame] | 237 | def time_sleep(seconds): |
| 238 | # Use this so that it can be mocked in tests without interfering with python |
| 239 | # system machinery. |
tandrii | 2a16b95 | 2016-10-19 07:09:44 -0700 | [diff] [blame] | 240 | return time.sleep(seconds) |
| 241 | |
| 242 | |
Edward Lemur | 01f4a4f | 2018-11-03 00:40:38 +0000 | [diff] [blame] | 243 | def time_time(): |
| 244 | # Use this so that it can be mocked in tests without interfering with python |
| 245 | # system machinery. |
| 246 | return time.time() |
| 247 | |
| 248 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 249 | def datetime_now(): |
| 250 | # Use this so that it can be mocked in tests without interfering with python |
| 251 | # system machinery. |
| 252 | return datetime.datetime.now() |
| 253 | |
| 254 | |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 255 | def confirm_or_exit(prefix='', action='confirm'): |
| 256 | """Asks user to press enter to continue or press Ctrl+C to abort.""" |
| 257 | if not prefix or prefix.endswith('\n'): |
| 258 | mid = 'Press' |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 259 | elif prefix.endswith('.') or prefix.endswith('?'): |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 260 | mid = ' Press' |
| 261 | elif prefix.endswith(' '): |
| 262 | mid = 'press' |
| 263 | else: |
| 264 | mid = ' press' |
Edward Lesmes | ae3586b | 2020-03-23 21:21:14 +0000 | [diff] [blame] | 265 | gclient_utils.AskForData( |
| 266 | '%s%s Enter to %s, or Ctrl+C to abort' % (prefix, mid, action)) |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 267 | |
| 268 | |
| 269 | def ask_for_explicit_yes(prompt): |
Quinten Yearsley | d242ed7 | 2019-07-25 17:17:55 +0000 | [diff] [blame] | 270 | """Returns whether user typed 'y' or 'yes' to confirm the given prompt.""" |
Edward Lesmes | ae3586b | 2020-03-23 21:21:14 +0000 | [diff] [blame] | 271 | result = gclient_utils.AskForData(prompt + ' [Yes/No]: ').lower() |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 272 | while True: |
| 273 | if 'yes'.startswith(result): |
| 274 | return True |
| 275 | if 'no'.startswith(result): |
| 276 | return False |
Edward Lesmes | ae3586b | 2020-03-23 21:21:14 +0000 | [diff] [blame] | 277 | result = gclient_utils.AskForData('Please, type yes or no: ').lower() |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 278 | |
| 279 | |
machenbach@chromium.org | 4545314 | 2015-09-15 08:45:22 +0000 | [diff] [blame] | 280 | def _get_properties_from_options(options): |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 281 | prop_list = getattr(options, 'properties', []) |
| 282 | properties = dict(x.split('=', 1) for x in prop_list) |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 283 | for key, val in properties.items(): |
machenbach@chromium.org | 4545314 | 2015-09-15 08:45:22 +0000 | [diff] [blame] | 284 | try: |
| 285 | properties[key] = json.loads(val) |
| 286 | except ValueError: |
| 287 | pass # If a value couldn't be evaluated, treat it as a string. |
| 288 | return properties |
| 289 | |
| 290 | |
Edward Lemur | 4c707a2 | 2019-09-24 21:13:43 +0000 | [diff] [blame] | 291 | def _call_buildbucket(http, buildbucket_host, method, request): |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 292 | """Calls a buildbucket v2 method and returns the parsed json response.""" |
| 293 | headers = { |
| 294 | 'Accept': 'application/json', |
| 295 | 'Content-Type': 'application/json', |
| 296 | } |
| 297 | request = json.dumps(request) |
| 298 | url = 'https://%s/prpc/buildbucket.v2.Builds/%s' % (buildbucket_host, method) |
| 299 | |
| 300 | logging.info('POST %s with %s' % (url, request)) |
| 301 | |
| 302 | attempts = 1 |
| 303 | time_to_sleep = 1 |
| 304 | while True: |
| 305 | response, content = http.request(url, 'POST', body=request, headers=headers) |
| 306 | if response.status == 200: |
| 307 | return json.loads(content[4:]) |
| 308 | if attempts >= MAX_ATTEMPTS or 400 <= response.status < 500: |
| 309 | msg = '%s error when calling POST %s with %s: %s' % ( |
| 310 | response.status, url, request, content) |
| 311 | raise BuildbucketResponseException(msg) |
| 312 | logging.debug( |
| 313 | '%s error when calling POST %s with %s. ' |
| 314 | 'Sleeping for %d seconds and retrying...' % ( |
| 315 | response.status, url, request, time_to_sleep)) |
| 316 | time.sleep(time_to_sleep) |
| 317 | time_to_sleep *= 2 |
| 318 | attempts += 1 |
| 319 | |
| 320 | assert False, 'unreachable' |
| 321 | |
| 322 | |
Edward Lemur | 6215c79 | 2019-10-03 21:59:05 +0000 | [diff] [blame] | 323 | def _parse_bucket(raw_bucket): |
| 324 | legacy = True |
| 325 | project = bucket = None |
| 326 | if '/' in raw_bucket: |
| 327 | legacy = False |
| 328 | project, bucket = raw_bucket.split('/', 1) |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 329 | # Assume luci.<project>.<bucket>. |
Edward Lemur | 6215c79 | 2019-10-03 21:59:05 +0000 | [diff] [blame] | 330 | elif raw_bucket.startswith('luci.'): |
| 331 | project, bucket = raw_bucket[len('luci.'):].split('.', 1) |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 332 | # Otherwise, assume prefix is also the project name. |
Edward Lemur | 6215c79 | 2019-10-03 21:59:05 +0000 | [diff] [blame] | 333 | elif '.' in raw_bucket: |
| 334 | project = raw_bucket.split('.')[0] |
| 335 | bucket = raw_bucket |
| 336 | # Legacy buckets. |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 337 | if legacy and project and bucket: |
Edward Lemur | 6215c79 | 2019-10-03 21:59:05 +0000 | [diff] [blame] | 338 | print('WARNING Please use %s/%s to specify the bucket.' % (project, bucket)) |
| 339 | return project, bucket |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 340 | |
| 341 | |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 342 | def _canonical_git_googlesource_host(host): |
| 343 | """Normalizes Gerrit hosts (with '-review') to Git host.""" |
| 344 | assert host.endswith(_GOOGLESOURCE) |
| 345 | # Prefix doesn't include '.' at the end. |
| 346 | prefix = host[:-(1 + len(_GOOGLESOURCE))] |
| 347 | if prefix.endswith('-review'): |
| 348 | prefix = prefix[:-len('-review')] |
| 349 | return prefix + '.' + _GOOGLESOURCE |
| 350 | |
| 351 | |
| 352 | def _canonical_gerrit_googlesource_host(host): |
| 353 | git_host = _canonical_git_googlesource_host(host) |
| 354 | prefix = git_host.split('.', 1)[0] |
| 355 | return prefix + '-review.' + _GOOGLESOURCE |
| 356 | |
| 357 | |
| 358 | def _get_counterpart_host(host): |
| 359 | assert host.endswith(_GOOGLESOURCE) |
| 360 | git = _canonical_git_googlesource_host(host) |
| 361 | gerrit = _canonical_gerrit_googlesource_host(git) |
| 362 | return git if gerrit == host else gerrit |
| 363 | |
| 364 | |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 365 | def _trigger_tryjobs(changelist, jobs, options, patchset): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 366 | """Sends a request to Buildbucket to trigger tryjobs for a changelist. |
qyearsley | 1fdfcb6 | 2016-10-24 13:22:03 -0700 | [diff] [blame] | 367 | |
| 368 | Args: |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 369 | changelist: Changelist that the tryjobs are associated with. |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 370 | jobs: A list of (project, bucket, builder). |
qyearsley | 1fdfcb6 | 2016-10-24 13:22:03 -0700 | [diff] [blame] | 371 | options: Command-line options. |
| 372 | """ |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 373 | print('Scheduling jobs on:') |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 374 | for project, bucket, builder in jobs: |
| 375 | print(' %s/%s: %s' % (project, bucket, builder)) |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 376 | print('To see results here, run: git cl try-results') |
| 377 | print('To see results in browser, run: git cl web') |
tandrii | de281ae | 2016-10-12 06:02:30 -0700 | [diff] [blame] | 378 | |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 379 | requests = _make_tryjob_schedule_requests(changelist, jobs, options, patchset) |
Andrii Shyshkalov | aeee6a8 | 2019-10-09 21:56:25 +0000 | [diff] [blame] | 380 | if not requests: |
| 381 | return |
| 382 | |
Edward Lemur | 5b929a4 | 2019-10-21 17:57:39 +0000 | [diff] [blame] | 383 | http = auth.Authenticator().authorize(httplib2.Http()) |
Andrii Shyshkalov | aeee6a8 | 2019-10-09 21:56:25 +0000 | [diff] [blame] | 384 | http.force_exception_to_status_code = True |
| 385 | |
| 386 | batch_request = {'requests': requests} |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 387 | batch_response = _call_buildbucket(http, DEFAULT_BUILDBUCKET_HOST, 'Batch', |
| 388 | batch_request) |
Andrii Shyshkalov | aeee6a8 | 2019-10-09 21:56:25 +0000 | [diff] [blame] | 389 | |
| 390 | errors = [ |
| 391 | ' ' + response['error']['message'] |
| 392 | for response in batch_response.get('responses', []) |
| 393 | if 'error' in response |
| 394 | ] |
| 395 | if errors: |
| 396 | raise BuildbucketResponseException( |
| 397 | 'Failed to schedule builds for some bots:\n%s' % '\n'.join(errors)) |
| 398 | |
| 399 | |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 400 | def _make_tryjob_schedule_requests(changelist, jobs, options, patchset): |
Quinten Yearsley | ee8be8a | 2020-03-05 21:48:32 +0000 | [diff] [blame] | 401 | """Constructs requests for Buildbucket to trigger tryjobs.""" |
Edward Lemur | f0faf48 | 2019-09-25 20:40:17 +0000 | [diff] [blame] | 402 | gerrit_changes = [changelist.GetGerritChange(patchset)] |
Quinten Yearsley | ee8be8a | 2020-03-05 21:48:32 +0000 | [diff] [blame] | 403 | shared_properties = { |
| 404 | 'category': options.ensure_value('category', 'git_cl_try') |
| 405 | } |
| 406 | if options.ensure_value('clobber', False): |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 407 | shared_properties['clobber'] = True |
| 408 | shared_properties.update(_get_properties_from_options(options) or {}) |
| 409 | |
Andrii Shyshkalov | aeee6a8 | 2019-10-09 21:56:25 +0000 | [diff] [blame] | 410 | shared_tags = [{'key': 'user_agent', 'value': 'git_cl_try'}] |
Quinten Yearsley | ee8be8a | 2020-03-05 21:48:32 +0000 | [diff] [blame] | 411 | if options.ensure_value('retry_failed', False): |
Andrii Shyshkalov | aeee6a8 | 2019-10-09 21:56:25 +0000 | [diff] [blame] | 412 | shared_tags.append({'key': 'retry_failed', |
| 413 | 'value': '1'}) |
| 414 | |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 415 | requests = [] |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 416 | for (project, bucket, builder) in jobs: |
| 417 | properties = shared_properties.copy() |
| 418 | if 'presubmit' in builder.lower(): |
| 419 | properties['dry_run'] = 'true' |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 420 | |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 421 | requests.append({ |
| 422 | 'scheduleBuild': { |
| 423 | 'requestId': str(uuid.uuid4()), |
| 424 | 'builder': { |
| 425 | 'project': getattr(options, 'project', None) or project, |
| 426 | 'bucket': bucket, |
| 427 | 'builder': builder, |
| 428 | }, |
| 429 | 'gerritChanges': gerrit_changes, |
| 430 | 'properties': properties, |
| 431 | 'tags': [ |
| 432 | {'key': 'builder', 'value': builder}, |
| 433 | ] + shared_tags, |
| 434 | } |
| 435 | }) |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 436 | |
Quinten Yearsley | ee8be8a | 2020-03-05 21:48:32 +0000 | [diff] [blame] | 437 | if options.ensure_value('revision', None): |
Josip Sokcevic | 9011a5b | 2021-02-12 18:59:44 +0000 | [diff] [blame] | 438 | remote, remote_branch = changelist.GetRemoteBranch() |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 439 | requests[-1]['scheduleBuild']['gitilesCommit'] = { |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 440 | 'host': _canonical_git_googlesource_host(gerrit_changes[0]['host']), |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 441 | 'project': gerrit_changes[0]['project'], |
Josip Sokcevic | 9011a5b | 2021-02-12 18:59:44 +0000 | [diff] [blame] | 442 | 'id': options.revision, |
| 443 | 'ref': GetTargetRef(remote, remote_branch, None) |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 444 | } |
Anthony Polito | 1a5fe23 | 2020-01-24 23:17:52 +0000 | [diff] [blame] | 445 | |
Andrii Shyshkalov | aeee6a8 | 2019-10-09 21:56:25 +0000 | [diff] [blame] | 446 | return requests |
kjellander@chromium.org | 4442454 | 2015-06-02 18:35:29 +0000 | [diff] [blame] | 447 | |
sheyang@google.com | 6ebaf78 | 2015-05-12 19:17:54 +0000 | [diff] [blame] | 448 | |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 449 | def _fetch_tryjobs(changelist, buildbucket_host, patchset=None): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 450 | """Fetches tryjobs from buildbucket. |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 451 | |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 452 | Returns list of buildbucket.v2.Build with the try jobs for the changelist. |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 453 | """ |
Andrii Shyshkalov | 2cbae8a | 2019-10-11 21:30:27 +0000 | [diff] [blame] | 454 | fields = ['id', 'builder', 'status', 'createTime', 'tags'] |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 455 | request = { |
| 456 | 'predicate': { |
| 457 | 'gerritChanges': [changelist.GetGerritChange(patchset)], |
| 458 | }, |
| 459 | 'fields': ','.join('builds.*.' + field for field in fields), |
| 460 | } |
tandrii | 221ab25 | 2016-10-06 08:12:04 -0700 | [diff] [blame] | 461 | |
Edward Lemur | 5b929a4 | 2019-10-21 17:57:39 +0000 | [diff] [blame] | 462 | authenticator = auth.Authenticator() |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 463 | if authenticator.has_cached_credentials(): |
| 464 | http = authenticator.authorize(httplib2.Http()) |
| 465 | else: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 466 | print('Warning: Some results might be missing because %s' % |
| 467 | # Get the message on how to login. |
Andrii Shyshkalov | 2517afd | 2021-01-19 17:07:43 +0000 | [diff] [blame] | 468 | (str(auth.LoginRequiredError()),)) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 469 | http = httplib2.Http() |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 470 | http.force_exception_to_status_code = True |
| 471 | |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 472 | response = _call_buildbucket(http, buildbucket_host, 'SearchBuilds', request) |
| 473 | return response.get('builds', []) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 474 | |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 475 | |
Edward Lemur | 5b929a4 | 2019-10-21 17:57:39 +0000 | [diff] [blame] | 476 | def _fetch_latest_builds(changelist, buildbucket_host, latest_patchset=None): |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 477 | """Fetches builds from the latest patchset that has builds (within |
| 478 | the last few patchsets). |
| 479 | |
| 480 | Args: |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 481 | changelist (Changelist): The CL to fetch builds for |
| 482 | buildbucket_host (str): Buildbucket host, e.g. "cr-buildbucket.appspot.com" |
Andrii Shyshkalov | 1ad5811 | 2019-10-08 01:46:14 +0000 | [diff] [blame] | 483 | lastest_patchset(int|NoneType): the patchset to start fetching builds from. |
| 484 | If None (default), starts with the latest available patchset. |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 485 | Returns: |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 486 | A tuple (builds, patchset) where builds is a list of buildbucket.v2.Build, |
| 487 | and patchset is the patchset number where those builds came from. |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 488 | """ |
| 489 | assert buildbucket_host |
| 490 | assert changelist.GetIssue(), 'CL must be uploaded first' |
| 491 | assert changelist.GetCodereviewServer(), 'CL must be uploaded first' |
Andrii Shyshkalov | 1ad5811 | 2019-10-08 01:46:14 +0000 | [diff] [blame] | 492 | if latest_patchset is None: |
| 493 | assert changelist.GetMostRecentPatchset() |
| 494 | ps = changelist.GetMostRecentPatchset() |
| 495 | else: |
| 496 | assert latest_patchset > 0, latest_patchset |
| 497 | ps = latest_patchset |
| 498 | |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 499 | min_ps = max(1, ps - 5) |
| 500 | while ps >= min_ps: |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 501 | builds = _fetch_tryjobs(changelist, buildbucket_host, patchset=ps) |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 502 | if len(builds): |
| 503 | return builds, ps |
| 504 | ps -= 1 |
| 505 | return [], 0 |
| 506 | |
| 507 | |
Andrii Shyshkalov | 2cbae8a | 2019-10-11 21:30:27 +0000 | [diff] [blame] | 508 | def _filter_failed_for_retry(all_builds): |
| 509 | """Returns a list of buckets/builders that are worth retrying. |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 510 | |
| 511 | Args: |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 512 | all_builds (list): Builds, in the format returned by _fetch_tryjobs, |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 513 | i.e. a list of buildbucket.v2.Builds which includes status and builder |
| 514 | info. |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 515 | |
| 516 | Returns: |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 517 | A dict {(proj, bucket): [builders]}. This is the same format accepted by |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 518 | _trigger_tryjobs. |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 519 | """ |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 520 | grouped = {} |
| 521 | for build in all_builds: |
Andrii Shyshkalov | 2cbae8a | 2019-10-11 21:30:27 +0000 | [diff] [blame] | 522 | builder = build['builder'] |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 523 | key = (builder['project'], builder['bucket'], builder['builder']) |
| 524 | grouped.setdefault(key, []).append(build) |
Andrii Shyshkalov | 2cbae8a | 2019-10-11 21:30:27 +0000 | [diff] [blame] | 525 | |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 526 | jobs = [] |
| 527 | for (project, bucket, builder), builds in grouped.items(): |
| 528 | if 'triggered' in builder: |
| 529 | print('WARNING: Not scheduling %s. Triggered bots require an initial job ' |
| 530 | 'from a parent. Please schedule a manual job for the parent ' |
| 531 | 'instead.') |
Andrii Shyshkalov | 2cbae8a | 2019-10-11 21:30:27 +0000 | [diff] [blame] | 532 | continue |
| 533 | if any(b['status'] in ('STARTED', 'SCHEDULED') for b in builds): |
| 534 | # Don't retry if any are running. |
| 535 | continue |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 536 | # If builder had several builds, retry only if the last one failed. |
| 537 | # This is a bit different from CQ, which would re-use *any* SUCCESS-full |
| 538 | # build, but in case of retrying failed jobs retrying a flaky one makes |
| 539 | # sense. |
| 540 | builds = sorted(builds, key=lambda b: b['createTime']) |
| 541 | if builds[-1]['status'] not in ('FAILURE', 'INFRA_FAILURE'): |
| 542 | continue |
| 543 | # Don't retry experimental build previously triggered by CQ. |
| 544 | if any(t['key'] == 'cq_experimental' and t['value'] == 'true' |
| 545 | for t in builds[-1]['tags']): |
| 546 | continue |
| 547 | jobs.append((project, bucket, builder)) |
| 548 | |
| 549 | # Sort the jobs to make testing easier. |
| 550 | return sorted(jobs) |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 551 | |
| 552 | |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 553 | def _print_tryjobs(options, builds): |
| 554 | """Prints nicely result of _fetch_tryjobs.""" |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 555 | if not builds: |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 556 | print('No tryjobs scheduled.') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 557 | return |
| 558 | |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 559 | longest_builder = max(len(b['builder']['builder']) for b in builds) |
| 560 | name_fmt = '{builder:<%d}' % longest_builder |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 561 | if options.print_master: |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 562 | longest_bucket = max(len(b['builder']['bucket']) for b in builds) |
| 563 | name_fmt = ('{bucket:>%d} ' % longest_bucket) + name_fmt |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 564 | |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 565 | builds_by_status = {} |
| 566 | for b in builds: |
| 567 | builds_by_status.setdefault(b['status'], []).append({ |
| 568 | 'id': b['id'], |
| 569 | 'name': name_fmt.format( |
| 570 | builder=b['builder']['builder'], bucket=b['builder']['bucket']), |
| 571 | }) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 572 | |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 573 | sort_key = lambda b: (b['name'], b['id']) |
| 574 | |
| 575 | def print_builds(title, builds, fmt=None, color=None): |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 576 | """Pop matching builds from `builds` dict and print them.""" |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 577 | if not builds: |
| 578 | return |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 579 | |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 580 | fmt = fmt or '{name} https://ci.chromium.org/b/{id}' |
tandrii@chromium.org | 6cf98c8 | 2016-03-15 11:56:00 +0000 | [diff] [blame] | 581 | if not options.color or color is None: |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 582 | colorize = lambda x: x |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 583 | else: |
| 584 | colorize = lambda x: '%s%s%s' % (color, x, Fore.RESET) |
| 585 | |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 586 | print(colorize(title)) |
| 587 | for b in sorted(builds, key=sort_key): |
| 588 | print(' ', colorize(fmt.format(**b))) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 589 | |
| 590 | total = len(builds) |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 591 | print_builds( |
| 592 | 'Successes:', builds_by_status.pop('SUCCESS', []), color=Fore.GREEN) |
| 593 | print_builds( |
| 594 | 'Infra Failures:', builds_by_status.pop('INFRA_FAILURE', []), |
| 595 | color=Fore.MAGENTA) |
| 596 | print_builds('Failures:', builds_by_status.pop('FAILURE', []), color=Fore.RED) |
| 597 | print_builds('Canceled:', builds_by_status.pop('CANCELED', []), fmt='{name}', |
| 598 | color=Fore.MAGENTA) |
Andrii Shyshkalov | 792630c | 2020-10-19 16:47:44 +0000 | [diff] [blame] | 599 | print_builds('Started:', builds_by_status.pop('STARTED', []), |
| 600 | color=Fore.YELLOW) |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 601 | print_builds( |
| 602 | 'Scheduled:', builds_by_status.pop('SCHEDULED', []), fmt='{name} id={id}') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 603 | # The last section is just in case buildbucket API changes OR there is a bug. |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 604 | print_builds( |
| 605 | 'Other:', sum(builds_by_status.values(), []), fmt='{name} id={id}') |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 606 | print('Total: %d tryjobs' % total) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 607 | |
| 608 | |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 609 | def _ComputeDiffLineRanges(files, upstream_commit): |
| 610 | """Gets the changed line ranges for each file since upstream_commit. |
| 611 | |
| 612 | Parses a git diff on provided files and returns a dict that maps a file name |
| 613 | to an ordered list of range tuples in the form (start_line, count). |
| 614 | Ranges are in the same format as a git diff. |
| 615 | """ |
| 616 | # If files is empty then diff_output will be a full diff. |
| 617 | if len(files) == 0: |
| 618 | return {} |
| 619 | |
Aiden Benner | 6c18a1a | 2018-11-23 20:18:23 +0000 | [diff] [blame] | 620 | # Take the git diff and find the line ranges where there are changes. |
Jamie Madill | 3671a6a | 2019-10-24 15:13:21 +0000 | [diff] [blame] | 621 | diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, files, allow_prefix=True) |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 622 | diff_output = RunGit(diff_cmd) |
| 623 | |
| 624 | pattern = r'(?:^diff --git a/(?:.*) b/(.*))|(?:^@@.*\+(.*) @@)' |
| 625 | # 2 capture groups |
| 626 | # 0 == fname of diff file |
| 627 | # 1 == 'diff_start,diff_count' or 'diff_start' |
| 628 | # will match each of |
| 629 | # diff --git a/foo.foo b/foo.py |
| 630 | # @@ -12,2 +14,3 @@ |
| 631 | # @@ -12,2 +17 @@ |
| 632 | # running re.findall on the above string with pattern will give |
| 633 | # [('foo.py', ''), ('', '14,3'), ('', '17')] |
| 634 | |
| 635 | curr_file = None |
| 636 | line_diffs = {} |
| 637 | for match in re.findall(pattern, diff_output, flags=re.MULTILINE): |
| 638 | if match[0] != '': |
| 639 | # Will match the second filename in diff --git a/a.py b/b.py. |
| 640 | curr_file = match[0] |
| 641 | line_diffs[curr_file] = [] |
| 642 | else: |
| 643 | # Matches +14,3 |
| 644 | if ',' in match[1]: |
| 645 | diff_start, diff_count = match[1].split(',') |
| 646 | else: |
| 647 | # Single line changes are of the form +12 instead of +12,1. |
| 648 | diff_start = match[1] |
| 649 | diff_count = 1 |
| 650 | |
| 651 | diff_start = int(diff_start) |
| 652 | diff_count = int(diff_count) |
| 653 | |
| 654 | # If diff_count == 0 this is a removal we can ignore. |
| 655 | line_diffs[curr_file].append((diff_start, diff_count)) |
| 656 | |
| 657 | return line_diffs |
| 658 | |
| 659 | |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 660 | def _FindYapfConfigFile(fpath, yapf_config_cache, top_dir=None): |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 661 | """Checks if a yapf file is in any parent directory of fpath until top_dir. |
| 662 | |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 663 | Recursively checks parent directories to find yapf file and if no yapf file |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 664 | is found returns None. Uses yapf_config_cache as a cache for previously found |
| 665 | configs. |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 666 | """ |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 667 | fpath = os.path.abspath(fpath) |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 668 | # Return result if we've already computed it. |
| 669 | if fpath in yapf_config_cache: |
| 670 | return yapf_config_cache[fpath] |
| 671 | |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 672 | parent_dir = os.path.dirname(fpath) |
| 673 | if os.path.isfile(fpath): |
| 674 | ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir) |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 675 | else: |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 676 | # Otherwise fpath is a directory |
| 677 | yapf_file = os.path.join(fpath, YAPF_CONFIG_FILENAME) |
| 678 | if os.path.isfile(yapf_file): |
| 679 | ret = yapf_file |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 680 | elif fpath in (top_dir, parent_dir): |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 681 | # If we're at the top level directory, or if we're at root |
| 682 | # there is no provided style. |
| 683 | ret = None |
| 684 | else: |
| 685 | # Otherwise recurse on the current directory. |
| 686 | ret = _FindYapfConfigFile(parent_dir, yapf_config_cache, top_dir) |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 687 | yapf_config_cache[fpath] = ret |
| 688 | return ret |
| 689 | |
| 690 | |
Brian Sheedy | b4307d5 | 2019-12-02 19:18:17 +0000 | [diff] [blame] | 691 | def _GetYapfIgnorePatterns(top_dir): |
| 692 | """Returns all patterns in the .yapfignore file. |
Brian Sheedy | 59b06a8 | 2019-10-14 17:03:29 +0000 | [diff] [blame] | 693 | |
| 694 | yapf is supposed to handle the ignoring of files listed in .yapfignore itself, |
| 695 | but this functionality appears to break when explicitly passing files to |
| 696 | yapf for formatting. According to |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 697 | https://github.com/google/yapf/blob/HEAD/README.rst#excluding-files-from-formatting-yapfignore, |
Brian Sheedy | 59b06a8 | 2019-10-14 17:03:29 +0000 | [diff] [blame] | 698 | the .yapfignore file should be in the directory that yapf is invoked from, |
| 699 | which we assume to be the top level directory in this case. |
| 700 | |
| 701 | Args: |
| 702 | top_dir: The top level directory for the repository being formatted. |
| 703 | |
| 704 | Returns: |
Brian Sheedy | b4307d5 | 2019-12-02 19:18:17 +0000 | [diff] [blame] | 705 | A set of all fnmatch patterns to be ignored. |
Brian Sheedy | 59b06a8 | 2019-10-14 17:03:29 +0000 | [diff] [blame] | 706 | """ |
| 707 | yapfignore_file = os.path.join(top_dir, '.yapfignore') |
Brian Sheedy | b4307d5 | 2019-12-02 19:18:17 +0000 | [diff] [blame] | 708 | ignore_patterns = set() |
Brian Sheedy | 59b06a8 | 2019-10-14 17:03:29 +0000 | [diff] [blame] | 709 | if not os.path.exists(yapfignore_file): |
Brian Sheedy | b4307d5 | 2019-12-02 19:18:17 +0000 | [diff] [blame] | 710 | return ignore_patterns |
Brian Sheedy | 59b06a8 | 2019-10-14 17:03:29 +0000 | [diff] [blame] | 711 | |
Anthony Polito | c64e390 | 2021-04-30 21:55:25 +0000 | [diff] [blame] | 712 | for line in gclient_utils.FileRead(yapfignore_file).split('\n'): |
| 713 | stripped_line = line.strip() |
| 714 | # Comments and blank lines should be ignored. |
| 715 | if stripped_line.startswith('#') or stripped_line == '': |
| 716 | continue |
| 717 | ignore_patterns.add(stripped_line) |
Brian Sheedy | b4307d5 | 2019-12-02 19:18:17 +0000 | [diff] [blame] | 718 | return ignore_patterns |
| 719 | |
| 720 | |
| 721 | def _FilterYapfIgnoredFiles(filepaths, patterns): |
| 722 | """Filters out any filepaths that match any of the given patterns. |
| 723 | |
| 724 | Args: |
| 725 | filepaths: An iterable of strings containing filepaths to filter. |
| 726 | patterns: An iterable of strings containing fnmatch patterns to filter on. |
| 727 | |
| 728 | Returns: |
| 729 | A list of strings containing all the elements of |filepaths| that did not |
| 730 | match any of the patterns in |patterns|. |
| 731 | """ |
| 732 | # Not inlined so that tests can use the same implementation. |
| 733 | return [f for f in filepaths |
| 734 | if not any(fnmatch.fnmatch(f, p) for p in patterns)] |
Brian Sheedy | 59b06a8 | 2019-10-14 17:03:29 +0000 | [diff] [blame] | 735 | |
| 736 | |
Aaron Gable | 13101a6 | 2018-02-09 13:20:41 -0800 | [diff] [blame] | 737 | def print_stats(args): |
maruel@chromium.org | 49e3d80 | 2012-07-18 23:54:45 +0000 | [diff] [blame] | 738 | """Prints statistics about the change to the user.""" |
| 739 | # --no-ext-diff is broken in some versions of Git, so try to work around |
| 740 | # this by overriding the environment (but there is still a problem if the |
| 741 | # git config key "diff.external" is used). |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 742 | env = GetNoGitPagerEnv() |
maruel@chromium.org | 49e3d80 | 2012-07-18 23:54:45 +0000 | [diff] [blame] | 743 | if 'GIT_EXTERNAL_DIFF' in env: |
| 744 | del env['GIT_EXTERNAL_DIFF'] |
iannucci@chromium.org | 7954005 | 2012-10-19 23:15:26 +0000 | [diff] [blame] | 745 | |
maruel@chromium.org | 49e3d80 | 2012-07-18 23:54:45 +0000 | [diff] [blame] | 746 | return subprocess2.call( |
Aaron Gable | 13101a6 | 2018-02-09 13:20:41 -0800 | [diff] [blame] | 747 | ['git', 'diff', '--no-ext-diff', '--stat', '-l100000', '-C50'] + args, |
Edward Lemur | 0db01f0 | 2019-11-12 22:01:51 +0000 | [diff] [blame] | 748 | env=env) |
maruel@chromium.org | 49e3d80 | 2012-07-18 23:54:45 +0000 | [diff] [blame] | 749 | |
| 750 | |
sheyang@google.com | 6ebaf78 | 2015-05-12 19:17:54 +0000 | [diff] [blame] | 751 | class BuildbucketResponseException(Exception): |
| 752 | pass |
| 753 | |
| 754 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 755 | class Settings(object): |
| 756 | def __init__(self): |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 757 | self.cc = None |
thestig@chromium.org | 7a54e81 | 2014-02-11 19:57:22 +0000 | [diff] [blame] | 758 | self.root = None |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 759 | self.tree_status_url = None |
| 760 | self.viewvc_url = None |
| 761 | self.updated = False |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 762 | self.is_gerrit = None |
bauerb@chromium.org | 54b400c | 2016-01-14 10:08:25 +0000 | [diff] [blame] | 763 | self.squash_gerrit_uploads = None |
tandrii@chromium.org | 2825353 | 2016-04-14 13:46:56 +0000 | [diff] [blame] | 764 | self.gerrit_skip_ensure_authenticated = None |
jbroman@chromium.org | 615a262 | 2013-05-03 13:20:14 +0000 | [diff] [blame] | 765 | self.git_editor = None |
Jamie Madill | dc4d19e | 2019-10-24 21:50:02 +0000 | [diff] [blame] | 766 | self.format_full_by_default = None |
Sigurd Schneider | 1bfda8e | 2021-06-30 14:46:25 +0000 | [diff] [blame] | 767 | self.is_status_commit_order_by_date = None |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 768 | |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 769 | def _LazyUpdateIfNeeded(self): |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 770 | """Updates the settings from a codereview.settings file, if available.""" |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 771 | if self.updated: |
| 772 | return |
pgervais@chromium.org | 87884cc | 2014-01-03 22:23:41 +0000 | [diff] [blame] | 773 | |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 774 | # The only value that actually changes the behavior is |
| 775 | # autoupdate = "false". Everything else means "true". |
| 776 | autoupdate = ( |
| 777 | scm.GIT.GetConfig(self.GetRoot(), 'rietveld.autoupdate', '').lower()) |
| 778 | |
| 779 | cr_settings_file = FindCodereviewSettingsFile() |
| 780 | if autoupdate != 'false' and cr_settings_file: |
| 781 | LoadCodereviewSettingsFromFile(cr_settings_file) |
| 782 | cr_settings_file.close() |
| 783 | |
| 784 | self.updated = True |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 785 | |
thestig@chromium.org | 7a54e81 | 2014-02-11 19:57:22 +0000 | [diff] [blame] | 786 | @staticmethod |
| 787 | def GetRelativeRoot(): |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 788 | return scm.GIT.GetCheckoutRoot('.') |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 789 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 790 | def GetRoot(self): |
thestig@chromium.org | 7a54e81 | 2014-02-11 19:57:22 +0000 | [diff] [blame] | 791 | if self.root is None: |
| 792 | self.root = os.path.abspath(self.GetRelativeRoot()) |
| 793 | return self.root |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 794 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 795 | def GetTreeStatusUrl(self, error_ok=False): |
| 796 | if not self.tree_status_url: |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 797 | self.tree_status_url = self._GetConfig('rietveld.tree-status-url') |
| 798 | if self.tree_status_url is None and not error_ok: |
| 799 | DieWithError( |
| 800 | 'You must configure your tree status URL by running ' |
| 801 | '"git cl config".') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 802 | return self.tree_status_url |
| 803 | |
| 804 | def GetViewVCUrl(self): |
| 805 | if not self.viewvc_url: |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 806 | self.viewvc_url = self._GetConfig('rietveld.viewvc-url') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 807 | return self.viewvc_url |
| 808 | |
rmistry@google.com | 9075258 | 2014-01-14 21:04:50 +0000 | [diff] [blame] | 809 | def GetBugPrefix(self): |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 810 | return self._GetConfig('rietveld.bug-prefix') |
rmistry@google.com | 78948ed | 2015-07-08 23:09:57 +0000 | [diff] [blame] | 811 | |
rmistry@google.com | 5626a92 | 2015-02-26 14:03:30 +0000 | [diff] [blame] | 812 | def GetRunPostUploadHook(self): |
Edward Lemur | 61ea307 | 2018-12-01 00:34:36 +0000 | [diff] [blame] | 813 | run_post_upload_hook = self._GetConfig( |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 814 | 'rietveld.run-post-upload-hook') |
rmistry@google.com | 5626a92 | 2015-02-26 14:03:30 +0000 | [diff] [blame] | 815 | return run_post_upload_hook == "True" |
| 816 | |
Joanna Wang | c8f23e2 | 2023-01-19 21:18:10 +0000 | [diff] [blame] | 817 | def GetDefaultCCList(self): |
| 818 | return self._GetConfig('rietveld.cc') |
| 819 | |
Dirk Pranke | 6f0df68 | 2021-06-25 00:42:33 +0000 | [diff] [blame] | 820 | def GetUsePython3(self): |
| 821 | return self._GetConfig('rietveld.use-python3') |
| 822 | |
bauerb@chromium.org | 54b400c | 2016-01-14 10:08:25 +0000 | [diff] [blame] | 823 | def GetSquashGerritUploads(self): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 824 | """Returns True if uploads to Gerrit should be squashed by default.""" |
bauerb@chromium.org | 54b400c | 2016-01-14 10:08:25 +0000 | [diff] [blame] | 825 | if self.squash_gerrit_uploads is None: |
Edward Lesmes | 4de5413 | 2020-05-05 19:41:33 +0000 | [diff] [blame] | 826 | self.squash_gerrit_uploads = self.GetSquashGerritUploadsOverride() |
| 827 | if self.squash_gerrit_uploads is None: |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 828 | # Default is squash now (http://crbug.com/611892#c23). |
| 829 | self.squash_gerrit_uploads = self._GetConfig( |
| 830 | 'gerrit.squash-uploads').lower() != 'false' |
bauerb@chromium.org | 54b400c | 2016-01-14 10:08:25 +0000 | [diff] [blame] | 831 | return self.squash_gerrit_uploads |
| 832 | |
Edward Lesmes | 4de5413 | 2020-05-05 19:41:33 +0000 | [diff] [blame] | 833 | def GetSquashGerritUploadsOverride(self): |
| 834 | """Return True or False if codereview.settings should be overridden. |
| 835 | |
| 836 | Returns None if no override has been defined. |
| 837 | """ |
| 838 | # See also http://crbug.com/611892#c23 |
| 839 | result = self._GetConfig('gerrit.override-squash-uploads').lower() |
| 840 | if result == 'true': |
| 841 | return True |
| 842 | if result == 'false': |
| 843 | return False |
| 844 | return None |
| 845 | |
Aleksey Khoroshilov | 35ef5ad | 2022-06-03 18:29:25 +0000 | [diff] [blame] | 846 | def GetIsGerrit(self): |
| 847 | """Return True if gerrit.host is set.""" |
| 848 | if self.is_gerrit is None: |
| 849 | self.is_gerrit = bool(self._GetConfig('gerrit.host', False)) |
| 850 | return self.is_gerrit |
| 851 | |
tandrii@chromium.org | 2825353 | 2016-04-14 13:46:56 +0000 | [diff] [blame] | 852 | def GetGerritSkipEnsureAuthenticated(self): |
| 853 | """Return True if EnsureAuthenticated should not be done for Gerrit |
| 854 | uploads.""" |
| 855 | if self.gerrit_skip_ensure_authenticated is None: |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 856 | self.gerrit_skip_ensure_authenticated = self._GetConfig( |
| 857 | 'gerrit.skip-ensure-authenticated').lower() == 'true' |
tandrii@chromium.org | 2825353 | 2016-04-14 13:46:56 +0000 | [diff] [blame] | 858 | return self.gerrit_skip_ensure_authenticated |
| 859 | |
jbroman@chromium.org | 615a262 | 2013-05-03 13:20:14 +0000 | [diff] [blame] | 860 | def GetGitEditor(self): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 861 | """Returns the editor specified in the git config, or None if none is.""" |
jbroman@chromium.org | 615a262 | 2013-05-03 13:20:14 +0000 | [diff] [blame] | 862 | if self.git_editor is None: |
Raul Tambre | 5a52587 | 2019-02-12 19:08:08 +0000 | [diff] [blame] | 863 | # Git requires single quotes for paths with spaces. We need to replace |
| 864 | # them with double quotes for Windows to treat such paths as a single |
| 865 | # path. |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 866 | self.git_editor = self._GetConfig('core.editor').replace('\'', '"') |
jbroman@chromium.org | 615a262 | 2013-05-03 13:20:14 +0000 | [diff] [blame] | 867 | return self.git_editor or None |
| 868 | |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 869 | def GetLintRegex(self): |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 870 | return self._GetConfig('rietveld.cpplint-regex', DEFAULT_LINT_REGEX) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 871 | |
| 872 | def GetLintIgnoreRegex(self): |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 873 | return self._GetConfig( |
| 874 | 'rietveld.cpplint-ignore-regex', DEFAULT_LINT_IGNORE_REGEX) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 875 | |
Jamie Madill | dc4d19e | 2019-10-24 21:50:02 +0000 | [diff] [blame] | 876 | def GetFormatFullByDefault(self): |
| 877 | if self.format_full_by_default is None: |
Jamie Madill | ac6f623 | 2021-07-07 20:54:08 +0000 | [diff] [blame] | 878 | self._LazyUpdateIfNeeded() |
Jamie Madill | dc4d19e | 2019-10-24 21:50:02 +0000 | [diff] [blame] | 879 | result = ( |
| 880 | RunGit(['config', '--bool', 'rietveld.format-full-by-default'], |
| 881 | error_ok=True).strip()) |
| 882 | self.format_full_by_default = (result == 'true') |
| 883 | return self.format_full_by_default |
| 884 | |
Sigurd Schneider | 1bfda8e | 2021-06-30 14:46:25 +0000 | [diff] [blame] | 885 | def IsStatusCommitOrderByDate(self): |
| 886 | if self.is_status_commit_order_by_date is None: |
| 887 | result = (RunGit(['config', '--bool', 'cl.date-order'], |
| 888 | error_ok=True).strip()) |
| 889 | self.is_status_commit_order_by_date = (result == 'true') |
| 890 | return self.is_status_commit_order_by_date |
| 891 | |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 892 | def _GetConfig(self, key, default=''): |
| 893 | self._LazyUpdateIfNeeded() |
| 894 | return scm.GIT.GetConfig(self.GetRoot(), key, default) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 895 | |
| 896 | |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 897 | class _CQState(object): |
Andrii Shyshkalov | 0e889b7 | 2019-07-15 22:28:48 +0000 | [diff] [blame] | 898 | """Enum for states of CL with respect to CQ.""" |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 899 | NONE = 'none' |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 900 | QUICK_RUN = 'quick_run' |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 901 | DRY_RUN = 'dry_run' |
| 902 | COMMIT = 'commit' |
| 903 | |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 904 | ALL_STATES = [NONE, QUICK_RUN, DRY_RUN, COMMIT] |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 905 | |
| 906 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 907 | class _ParsedIssueNumberArgument(object): |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 908 | def __init__(self, issue=None, patchset=None, hostname=None): |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 909 | self.issue = issue |
| 910 | self.patchset = patchset |
| 911 | self.hostname = hostname |
| 912 | |
| 913 | @property |
| 914 | def valid(self): |
| 915 | return self.issue is not None |
| 916 | |
| 917 | |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 918 | def ParseIssueNumberArgument(arg): |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 919 | """Parses the issue argument and returns _ParsedIssueNumberArgument.""" |
| 920 | fail_result = _ParsedIssueNumberArgument() |
| 921 | |
Edward Lemur | 678a684 | 2019-10-03 22:25:05 +0000 | [diff] [blame] | 922 | if isinstance(arg, int): |
| 923 | return _ParsedIssueNumberArgument(issue=arg) |
| 924 | if not isinstance(arg, basestring): |
| 925 | return fail_result |
| 926 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 927 | if arg.isdigit(): |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 928 | return _ParsedIssueNumberArgument(issue=int(arg)) |
Aaron Gable | aee6c85 | 2017-06-26 12:49:01 -0700 | [diff] [blame] | 929 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 930 | url = gclient_utils.UpgradeToHttps(arg) |
Alex Turner | 30ae637 | 2022-01-04 02:32:52 +0000 | [diff] [blame] | 931 | if not url.startswith('http'): |
| 932 | return fail_result |
Andrii Shyshkalov | 8aebb60 | 2020-04-16 22:10:27 +0000 | [diff] [blame] | 933 | for gerrit_url, short_url in _KNOWN_GERRIT_TO_SHORT_URLS.items(): |
| 934 | if url.startswith(short_url): |
| 935 | url = gerrit_url + url[len(short_url):] |
| 936 | break |
| 937 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 938 | try: |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 939 | parsed_url = urllib.parse.urlparse(url) |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 940 | except ValueError: |
| 941 | return fail_result |
Andrii Shyshkalov | 28d840e | 2017-04-10 15:45:09 +0200 | [diff] [blame] | 942 | |
Alex Turner | 30ae637 | 2022-01-04 02:32:52 +0000 | [diff] [blame] | 943 | # If "https://" was automatically added, fail if `arg` looks unlikely to be a |
| 944 | # URL. |
| 945 | if not arg.startswith('http') and '.' not in parsed_url.netloc: |
| 946 | return fail_result |
| 947 | |
Edward Lemur | 678a684 | 2019-10-03 22:25:05 +0000 | [diff] [blame] | 948 | # Gerrit's new UI is https://domain/c/project/+/<issue_number>[/[patchset]] |
| 949 | # But old GWT UI is https://domain/#/c/project/+/<issue_number>[/[patchset]] |
| 950 | # Short urls like https://domain/<issue_number> can be used, but don't allow |
| 951 | # specifying the patchset (you'd 404), but we allow that here. |
| 952 | if parsed_url.path == '/': |
| 953 | part = parsed_url.fragment |
| 954 | else: |
| 955 | part = parsed_url.path |
| 956 | |
| 957 | match = re.match( |
| 958 | r'(/c(/.*/\+)?)?/(?P<issue>\d+)(/(?P<patchset>\d+)?/?)?$', part) |
| 959 | if not match: |
| 960 | return fail_result |
| 961 | |
| 962 | issue = int(match.group('issue')) |
| 963 | patchset = match.group('patchset') |
| 964 | return _ParsedIssueNumberArgument( |
| 965 | issue=issue, |
| 966 | patchset=int(patchset) if patchset else None, |
| 967 | hostname=parsed_url.netloc) |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 968 | |
| 969 | |
Andrii Shyshkalov | b07575f | 2018-10-16 06:16:21 +0000 | [diff] [blame] | 970 | def _create_description_from_log(args): |
| 971 | """Pulls out the commit log to use as a base for the CL description.""" |
| 972 | log_args = [] |
Bruce Dawson | 13acea3 | 2022-05-03 22:13:08 +0000 | [diff] [blame] | 973 | if len(args) == 1 and args[0] == None: |
| 974 | # Handle the case where None is passed as the branch. |
| 975 | return '' |
Andrii Shyshkalov | b07575f | 2018-10-16 06:16:21 +0000 | [diff] [blame] | 976 | if len(args) == 1 and not args[0].endswith('.'): |
| 977 | log_args = [args[0] + '..'] |
| 978 | elif len(args) == 1 and args[0].endswith('...'): |
| 979 | log_args = [args[0][:-1]] |
| 980 | elif len(args) == 2: |
| 981 | log_args = [args[0] + '..' + args[1]] |
| 982 | else: |
| 983 | log_args = args[:] # Hope for the best! |
Manh Nguyen | e364486 | 2020-08-05 18:25:46 +0000 | [diff] [blame] | 984 | return RunGit(['log', '--pretty=format:%B%n'] + log_args) |
Andrii Shyshkalov | b07575f | 2018-10-16 06:16:21 +0000 | [diff] [blame] | 985 | |
| 986 | |
Aaron Gable | a45ee11 | 2016-11-22 15:14:38 -0800 | [diff] [blame] | 987 | class GerritChangeNotExists(Exception): |
tandrii | c2405f5 | 2016-10-10 08:13:15 -0700 | [diff] [blame] | 988 | def __init__(self, issue, url): |
| 989 | self.issue = issue |
| 990 | self.url = url |
Aaron Gable | a45ee11 | 2016-11-22 15:14:38 -0800 | [diff] [blame] | 991 | super(GerritChangeNotExists, self).__init__() |
tandrii | c2405f5 | 2016-10-10 08:13:15 -0700 | [diff] [blame] | 992 | |
| 993 | def __str__(self): |
Aaron Gable | a45ee11 | 2016-11-22 15:14:38 -0800 | [diff] [blame] | 994 | return 'change %s at %s does not exist or you have no access to it' % ( |
tandrii | c2405f5 | 2016-10-10 08:13:15 -0700 | [diff] [blame] | 995 | self.issue, self.url) |
| 996 | |
| 997 | |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 998 | _CommentSummary = collections.namedtuple( |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 999 | '_CommentSummary', ['date', 'message', 'sender', 'autogenerated', |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 1000 | # TODO(tandrii): these two aren't known in Gerrit. |
| 1001 | 'approval', 'disapproval']) |
| 1002 | |
| 1003 | |
Joanna Wang | e852391 | 2023-01-21 02:05:40 +0000 | [diff] [blame] | 1004 | _NewUpload = collections.namedtuple('NewUpload', [ |
Joanna Wang | 4049791 | 2023-01-24 21:18:16 +0000 | [diff] [blame] | 1005 | 'reviewers', 'ccs', 'commit_to_push', 'new_last_uploaded_commit', 'parent', |
Joanna Wang | e852391 | 2023-01-21 02:05:40 +0000 | [diff] [blame] | 1006 | 'change_desc' |
| 1007 | ]) |
| 1008 | |
| 1009 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1010 | class Changelist(object): |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1011 | """Changelist works with one changelist in local branch. |
| 1012 | |
tandrii@chromium.org | 8930b3d | 2016-04-13 14:47:02 +0000 | [diff] [blame] | 1013 | Notes: |
| 1014 | * Not safe for concurrent multi-{thread,process} use. |
| 1015 | * Caches values from current branch. Therefore, re-use after branch change |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1016 | with great care. |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1017 | """ |
| 1018 | |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 1019 | def __init__(self, |
| 1020 | branchref=None, |
| 1021 | issue=None, |
| 1022 | codereview_host=None, |
| 1023 | commit_date=None): |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1024 | """Create a new ChangeList instance. |
| 1025 | |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 1026 | **kwargs will be passed directly to Gerrit implementation. |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1027 | """ |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1028 | # Poke settings so we get the "configure your server" message if necessary. |
maruel@chromium.org | 379d07a | 2011-11-30 14:58:10 +0000 | [diff] [blame] | 1029 | global settings |
| 1030 | if not settings: |
| 1031 | # Happens when git_cl.py is used as a utility library. |
| 1032 | settings = Settings() |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1033 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1034 | self.branchref = branchref |
| 1035 | if self.branchref: |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 1036 | assert branchref.startswith('refs/heads/') |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1037 | self.branch = scm.GIT.ShortBranchName(self.branchref) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1038 | else: |
| 1039 | self.branch = None |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 1040 | self.commit_date = commit_date |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1041 | self.upstream_branch = None |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1042 | self.lookedup_issue = False |
| 1043 | self.issue = issue or None |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1044 | self.description = None |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1045 | self.lookedup_patchset = False |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1046 | self.patchset = None |
bauerb@chromium.org | ae6df35 | 2011-04-06 17:40:39 +0000 | [diff] [blame] | 1047 | self.cc = None |
Daniel Cheng | 7227d21 | 2017-11-17 08:12:37 -0800 | [diff] [blame] | 1048 | self.more_cc = [] |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 1049 | self._remote = None |
Andrii Shyshkalov | 81db1d5 | 2018-08-23 02:17:41 +0000 | [diff] [blame] | 1050 | self._cached_remote_url = (False, None) # (is_cached, value) |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 1051 | |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1052 | # Lazily cached values. |
| 1053 | self._gerrit_host = None # e.g. chromium-review.googlesource.com |
| 1054 | self._gerrit_server = None # e.g. https://chromium-review.googlesource.com |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 1055 | self._owners_client = None |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1056 | # Map from change number (issue) to its detail cache. |
| 1057 | self._detail_cache = {} |
| 1058 | |
| 1059 | if codereview_host is not None: |
| 1060 | assert not codereview_host.startswith('https://'), codereview_host |
| 1061 | self._gerrit_host = codereview_host |
| 1062 | self._gerrit_server = 'https://%s' % codereview_host |
bauerb@chromium.org | ae6df35 | 2011-04-06 17:40:39 +0000 | [diff] [blame] | 1063 | |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 1064 | @property |
| 1065 | def owners_client(self): |
| 1066 | if self._owners_client is None: |
| 1067 | remote, remote_branch = self.GetRemoteBranch() |
| 1068 | branch = GetTargetRef(remote, remote_branch, None) |
| 1069 | self._owners_client = owners_client.GetCodeOwnersClient( |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 1070 | host=self.GetGerritHost(), |
| 1071 | project=self.GetGerritProject(), |
| 1072 | branch=branch) |
| 1073 | return self._owners_client |
| 1074 | |
bauerb@chromium.org | ae6df35 | 2011-04-06 17:40:39 +0000 | [diff] [blame] | 1075 | def GetCCList(self): |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 1076 | """Returns the users cc'd on this CL. |
bauerb@chromium.org | ae6df35 | 2011-04-06 17:40:39 +0000 | [diff] [blame] | 1077 | |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 1078 | The return value is a string suitable for passing to git cl with the --cc |
| 1079 | flag. |
bauerb@chromium.org | ae6df35 | 2011-04-06 17:40:39 +0000 | [diff] [blame] | 1080 | """ |
| 1081 | if self.cc is None: |
Joanna Wang | c8f23e2 | 2023-01-19 21:18:10 +0000 | [diff] [blame] | 1082 | base_cc = settings.GetDefaultCCList() |
| 1083 | more_cc = ','.join(self.more_cc) |
| 1084 | self.cc = ','.join(filter(None, (base_cc, more_cc))) or '' |
bauerb@chromium.org | ae6df35 | 2011-04-06 17:40:39 +0000 | [diff] [blame] | 1085 | return self.cc |
| 1086 | |
Daniel Cheng | 7227d21 | 2017-11-17 08:12:37 -0800 | [diff] [blame] | 1087 | def ExtendCC(self, more_cc): |
| 1088 | """Extends the list of users to cc on this CL based on the changed files.""" |
| 1089 | self.more_cc.extend(more_cc) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1090 | |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 1091 | def GetCommitDate(self): |
| 1092 | """Returns the commit date as provided in the constructor""" |
| 1093 | return self.commit_date |
| 1094 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1095 | def GetBranch(self): |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 1096 | """Returns the short branch name, e.g. 'main'.""" |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1097 | if not self.branch: |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1098 | branchref = scm.GIT.GetBranchRef(settings.GetRoot()) |
szager@chromium.org | d62c61f | 2014-10-20 22:33:21 +0000 | [diff] [blame] | 1099 | if not branchref: |
| 1100 | return None |
| 1101 | self.branchref = branchref |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1102 | self.branch = scm.GIT.ShortBranchName(self.branchref) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1103 | return self.branch |
| 1104 | |
| 1105 | def GetBranchRef(self): |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 1106 | """Returns the full branch name, e.g. 'refs/heads/main'.""" |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1107 | self.GetBranch() # Poke the lazy loader. |
| 1108 | return self.branchref |
| 1109 | |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1110 | def _GitGetBranchConfigValue(self, key, default=None): |
| 1111 | return scm.GIT.GetBranchConfig( |
| 1112 | settings.GetRoot(), self.GetBranch(), key, default) |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1113 | |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1114 | def _GitSetBranchConfigValue(self, key, value): |
| 1115 | action = 'set %s to %r' % (key, value) |
| 1116 | if not value: |
| 1117 | action = 'unset %s' % key |
| 1118 | assert self.GetBranch(), 'a branch is needed to ' + action |
| 1119 | return scm.GIT.SetBranchConfig( |
| 1120 | settings.GetRoot(), self.GetBranch(), key, value) |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1121 | |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1122 | @staticmethod |
| 1123 | def FetchUpstreamTuple(branch): |
pgervais@chromium.org | d6617f3 | 2013-11-19 00:34:54 +0000 | [diff] [blame] | 1124 | """Returns a tuple containing remote and remote ref, |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 1125 | e.g. 'origin', 'refs/heads/main' |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1126 | """ |
Edward Lemur | 15a9b8c | 2020-02-13 00:52:30 +0000 | [diff] [blame] | 1127 | remote, upstream_branch = scm.GIT.FetchUpstreamTuple( |
| 1128 | settings.GetRoot(), branch) |
| 1129 | if not remote or not upstream_branch: |
| 1130 | DieWithError( |
| 1131 | 'Unable to determine default branch to diff against.\n' |
Josip Sokcevic | b038f72 | 2021-01-06 18:28:11 +0000 | [diff] [blame] | 1132 | 'Verify this branch is set up to track another \n' |
| 1133 | '(via the --track argument to "git checkout -b ..."). \n' |
| 1134 | 'or pass complete "git diff"-style arguments if supported, like\n' |
| 1135 | ' git cl upload origin/main\n') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1136 | |
| 1137 | return remote, upstream_branch |
| 1138 | |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 1139 | def GetCommonAncestorWithUpstream(self): |
pgervais@chromium.org | 8ba38ff | 2015-06-11 21:41:25 +0000 | [diff] [blame] | 1140 | upstream_branch = self.GetUpstreamBranch() |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1141 | if not scm.GIT.IsValidRevision(settings.GetRoot(), upstream_branch): |
pgervais@chromium.org | 8ba38ff | 2015-06-11 21:41:25 +0000 | [diff] [blame] | 1142 | DieWithError('The upstream for the current branch (%s) does not exist ' |
| 1143 | 'anymore.\nPlease fix it and try again.' % self.GetBranch()) |
iannucci@chromium.org | 9e84927 | 2014-04-04 00:31:55 +0000 | [diff] [blame] | 1144 | return git_common.get_or_create_merge_base(self.GetBranch(), |
pgervais@chromium.org | 8ba38ff | 2015-06-11 21:41:25 +0000 | [diff] [blame] | 1145 | upstream_branch) |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 1146 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1147 | def GetUpstreamBranch(self): |
| 1148 | if self.upstream_branch is None: |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1149 | remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch()) |
Raul Tambre | fe1dbe1 | 2019-05-02 04:43:57 +0000 | [diff] [blame] | 1150 | if remote != '.': |
mmoss@chromium.org | e758545 | 2014-08-24 01:41:11 +0000 | [diff] [blame] | 1151 | upstream_branch = upstream_branch.replace('refs/heads/', |
| 1152 | 'refs/remotes/%s/' % remote) |
| 1153 | upstream_branch = upstream_branch.replace('refs/branch-heads/', |
| 1154 | 'refs/remotes/branch-heads/') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1155 | self.upstream_branch = upstream_branch |
| 1156 | return self.upstream_branch |
| 1157 | |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1158 | def GetRemoteBranch(self): |
jmbaker@chromium.org | a2cbbbb | 2012-03-22 20:40:40 +0000 | [diff] [blame] | 1159 | if not self._remote: |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1160 | remote, branch = None, self.GetBranch() |
| 1161 | seen_branches = set() |
| 1162 | while branch not in seen_branches: |
| 1163 | seen_branches.add(branch) |
| 1164 | remote, branch = self.FetchUpstreamTuple(branch) |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1165 | branch = scm.GIT.ShortBranchName(branch) |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1166 | if remote != '.' or branch.startswith('refs/remotes'): |
| 1167 | break |
| 1168 | else: |
jmbaker@chromium.org | a2cbbbb | 2012-03-22 20:40:40 +0000 | [diff] [blame] | 1169 | remotes = RunGit(['remote'], error_ok=True).split() |
| 1170 | if len(remotes) == 1: |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1171 | remote, = remotes |
jmbaker@chromium.org | a2cbbbb | 2012-03-22 20:40:40 +0000 | [diff] [blame] | 1172 | elif 'origin' in remotes: |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1173 | remote = 'origin' |
Gavin Mak | e6a6233 | 2020-12-04 21:57:10 +0000 | [diff] [blame] | 1174 | logging.warning('Could not determine which remote this change is ' |
| 1175 | 'associated with, so defaulting to "%s".' % |
| 1176 | self._remote) |
jmbaker@chromium.org | a2cbbbb | 2012-03-22 20:40:40 +0000 | [diff] [blame] | 1177 | else: |
Gavin Mak | e6a6233 | 2020-12-04 21:57:10 +0000 | [diff] [blame] | 1178 | logging.warning('Could not determine which remote this change is ' |
| 1179 | 'associated with.') |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1180 | branch = 'HEAD' |
| 1181 | if branch.startswith('refs/remotes'): |
| 1182 | self._remote = (remote, branch) |
mmoss@chromium.org | e758545 | 2014-08-24 01:41:11 +0000 | [diff] [blame] | 1183 | elif branch.startswith('refs/branch-heads/'): |
| 1184 | self._remote = (remote, branch.replace('refs/', 'refs/remotes/')) |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1185 | else: |
| 1186 | self._remote = (remote, 'refs/remotes/%s/%s' % (remote, branch)) |
jmbaker@chromium.org | a2cbbbb | 2012-03-22 20:40:40 +0000 | [diff] [blame] | 1187 | return self._remote |
| 1188 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1189 | def GetRemoteUrl(self): |
| 1190 | """Return the configured remote URL, e.g. 'git://example.org/foo.git/'. |
| 1191 | |
| 1192 | Returns None if there is no remote. |
| 1193 | """ |
Andrii Shyshkalov | 81db1d5 | 2018-08-23 02:17:41 +0000 | [diff] [blame] | 1194 | is_cached, value = self._cached_remote_url |
| 1195 | if is_cached: |
| 1196 | return value |
| 1197 | |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 1198 | remote, _ = self.GetRemoteBranch() |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 1199 | url = scm.GIT.GetConfig(settings.GetRoot(), 'remote.%s.url' % remote, '') |
dyen@chromium.org | 2a13d4f | 2014-06-13 00:06:37 +0000 | [diff] [blame] | 1200 | |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 1201 | # Check if the remote url can be parsed as an URL. |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 1202 | host = urllib.parse.urlparse(url).netloc |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 1203 | if host: |
| 1204 | self._cached_remote_url = (True, url) |
| 1205 | return url |
| 1206 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 1207 | # If it cannot be parsed as an url, assume it is a local directory, |
| 1208 | # probably a git cache. |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 1209 | logging.warning('"%s" doesn\'t appear to point to a git host. ' |
| 1210 | 'Interpreting it as a local directory.', url) |
| 1211 | if not os.path.isdir(url): |
| 1212 | logging.error( |
Josip | 906bfde | 2020-01-31 22:38:49 +0000 | [diff] [blame] | 1213 | 'Remote "%(remote)s" for branch "%(branch)s" points to "%(url)s", ' |
| 1214 | 'but it doesn\'t exist.', |
| 1215 | {'remote': remote, 'branch': self.GetBranch(), 'url': url}) |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 1216 | return None |
| 1217 | |
| 1218 | cache_path = url |
Edward Lemur | 2696407 | 2020-02-19 19:18:51 +0000 | [diff] [blame] | 1219 | url = scm.GIT.GetConfig(url, 'remote.%s.url' % remote, '') |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 1220 | |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 1221 | host = urllib.parse.urlparse(url).netloc |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 1222 | if not host: |
| 1223 | logging.error( |
| 1224 | 'Remote "%(remote)s" for branch "%(branch)s" points to ' |
| 1225 | '"%(cache_path)s", but it is misconfigured.\n' |
| 1226 | '"%(cache_path)s" must be a git repo and must have a remote named ' |
| 1227 | '"%(remote)s" pointing to the git host.', { |
| 1228 | 'remote': remote, |
| 1229 | 'cache_path': cache_path, |
| 1230 | 'branch': self.GetBranch()}) |
| 1231 | return None |
| 1232 | |
Andrii Shyshkalov | 81db1d5 | 2018-08-23 02:17:41 +0000 | [diff] [blame] | 1233 | self._cached_remote_url = (True, url) |
dyen@chromium.org | 2a13d4f | 2014-06-13 00:06:37 +0000 | [diff] [blame] | 1234 | return url |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1235 | |
tandrii@chromium.org | 87985d2 | 2016-03-24 17:33:33 +0000 | [diff] [blame] | 1236 | def GetIssue(self): |
maruel@chromium.org | 5242430 | 2012-08-29 15:14:30 +0000 | [diff] [blame] | 1237 | """Returns the issue number as a int or None if not set.""" |
tandrii@chromium.org | 87985d2 | 2016-03-24 17:33:33 +0000 | [diff] [blame] | 1238 | if self.issue is None and not self.lookedup_issue: |
Bruce Dawson | 13acea3 | 2022-05-03 22:13:08 +0000 | [diff] [blame] | 1239 | if self.GetBranch(): |
| 1240 | self.issue = self._GitGetBranchConfigValue(ISSUE_CONFIG_KEY) |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1241 | if self.issue is not None: |
| 1242 | self.issue = int(self.issue) |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1243 | self.lookedup_issue = True |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1244 | return self.issue |
| 1245 | |
Andrii Shyshkalov | 1ee78cd | 2020-03-12 01:31:53 +0000 | [diff] [blame] | 1246 | def GetIssueURL(self, short=False): |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1247 | """Get the URL for a particular issue.""" |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1248 | issue = self.GetIssue() |
| 1249 | if not issue: |
dbeam@chromium.org | 015fd3d | 2013-06-18 19:02:50 +0000 | [diff] [blame] | 1250 | return None |
Andrii Shyshkalov | 1ee78cd | 2020-03-12 01:31:53 +0000 | [diff] [blame] | 1251 | server = self.GetCodereviewServer() |
| 1252 | if short: |
| 1253 | server = _KNOWN_GERRIT_TO_SHORT_URLS.get(server, server) |
| 1254 | return '%s/%s' % (server, issue) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1255 | |
Dirk Pranke | 6f0df68 | 2021-06-25 00:42:33 +0000 | [diff] [blame] | 1256 | def GetUsePython3(self): |
Josip Sokcevic | 340edc3 | 2021-07-08 17:01:46 +0000 | [diff] [blame] | 1257 | return settings.GetUsePython3() |
Dirk Pranke | 6f0df68 | 2021-06-25 00:42:33 +0000 | [diff] [blame] | 1258 | |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 1259 | def FetchDescription(self, pretty=False): |
| 1260 | assert self.GetIssue(), 'issue is required to query Gerrit' |
| 1261 | |
Edward Lemur | 9aa1a96 | 2020-02-25 00:58:38 +0000 | [diff] [blame] | 1262 | if self.description is None: |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 1263 | data = self._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT']) |
| 1264 | current_rev = data['current_revision'] |
| 1265 | self.description = data['revisions'][current_rev]['commit']['message'] |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 1266 | |
| 1267 | if not pretty: |
| 1268 | return self.description |
| 1269 | |
| 1270 | # Set width to 72 columns + 2 space indent. |
| 1271 | wrapper = textwrap.TextWrapper(width=74, replace_whitespace=True) |
| 1272 | wrapper.initial_indent = wrapper.subsequent_indent = ' ' |
| 1273 | lines = self.description.splitlines() |
| 1274 | return '\n'.join([wrapper.fill(line) for line in lines]) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1275 | |
| 1276 | def GetPatchset(self): |
maruel@chromium.org | 5242430 | 2012-08-29 15:14:30 +0000 | [diff] [blame] | 1277 | """Returns the patchset number as a int or None if not set.""" |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1278 | if self.patchset is None and not self.lookedup_patchset: |
Bruce Dawson | 13acea3 | 2022-05-03 22:13:08 +0000 | [diff] [blame] | 1279 | if self.GetBranch(): |
| 1280 | self.patchset = self._GitGetBranchConfigValue(PATCHSET_CONFIG_KEY) |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1281 | if self.patchset is not None: |
| 1282 | self.patchset = int(self.patchset) |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1283 | self.lookedup_patchset = True |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1284 | return self.patchset |
| 1285 | |
Edward Lemur | 9aa1a96 | 2020-02-25 00:58:38 +0000 | [diff] [blame] | 1286 | def GetAuthor(self): |
| 1287 | return scm.GIT.GetConfig(settings.GetRoot(), 'user.email') |
| 1288 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1289 | def SetPatchset(self, patchset): |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1290 | """Set this branch's patchset. If patchset=0, clears the patchset.""" |
| 1291 | assert self.GetBranch() |
| 1292 | if not patchset: |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1293 | self.patchset = None |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1294 | else: |
| 1295 | self.patchset = int(patchset) |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1296 | self._GitSetBranchConfigValue(PATCHSET_CONFIG_KEY, str(self.patchset)) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1297 | |
tandrii@chromium.org | a342c92 | 2016-03-16 07:08:25 +0000 | [diff] [blame] | 1298 | def SetIssue(self, issue=None): |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1299 | """Set this branch's issue. If issue isn't given, clears the issue.""" |
| 1300 | assert self.GetBranch() |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1301 | if issue: |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1302 | issue = int(issue) |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1303 | self._GitSetBranchConfigValue(ISSUE_CONFIG_KEY, str(issue)) |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1304 | self.issue = issue |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1305 | codereview_server = self.GetCodereviewServer() |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1306 | if codereview_server: |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1307 | self._GitSetBranchConfigValue( |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1308 | CODEREVIEW_SERVER_CONFIG_KEY, codereview_server) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1309 | else: |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1310 | # Reset all of these just to be clean. |
| 1311 | reset_suffixes = [ |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 1312 | LAST_UPLOAD_HASH_CONFIG_KEY, |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1313 | ISSUE_CONFIG_KEY, |
| 1314 | PATCHSET_CONFIG_KEY, |
| 1315 | CODEREVIEW_SERVER_CONFIG_KEY, |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 1316 | GERRIT_SQUASH_HASH_CONFIG_KEY, |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1317 | ] |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1318 | for prop in reset_suffixes: |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1319 | try: |
| 1320 | self._GitSetBranchConfigValue(prop, None) |
| 1321 | except subprocess2.CalledProcessError: |
| 1322 | pass |
Aaron Gable | ca01e2c | 2017-07-19 11:16:02 -0700 | [diff] [blame] | 1323 | msg = RunGit(['log', '-1', '--format=%B']).strip() |
| 1324 | if msg and git_footers.get_footer_change_id(msg): |
| 1325 | print('WARNING: The change patched into this branch has a Change-Id. ' |
| 1326 | 'Removing it.') |
| 1327 | RunGit(['commit', '--amend', '-m', |
| 1328 | git_footers.remove_footer(msg, 'Change-Id')]) |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 1329 | self.lookedup_issue = True |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 1330 | self.issue = None |
tandrii@chromium.org | 9b7fd71 | 2016-06-01 13:45:20 +0000 | [diff] [blame] | 1331 | self.patchset = None |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 1332 | |
Joanna Wang | b46232e | 2023-01-21 01:58:46 +0000 | [diff] [blame] | 1333 | def GetAffectedFiles(self, upstream, end_commit=None): |
| 1334 | # type: (str, Optional[str]) -> Sequence[str] |
| 1335 | """Returns the list of affected files for the given commit range.""" |
maruel@chromium.org | 2b38e9c | 2011-10-19 00:04:35 +0000 | [diff] [blame] | 1336 | try: |
Joanna Wang | b46232e | 2023-01-21 01:58:46 +0000 | [diff] [blame] | 1337 | return [ |
| 1338 | f for _, f in scm.GIT.CaptureStatus( |
| 1339 | settings.GetRoot(), upstream, end_commit=end_commit) |
| 1340 | ] |
maruel@chromium.org | 2b38e9c | 2011-10-19 00:04:35 +0000 | [diff] [blame] | 1341 | except subprocess2.CalledProcessError: |
| 1342 | DieWithError( |
pgervais@chromium.org | d6617f3 | 2013-11-19 00:34:54 +0000 | [diff] [blame] | 1343 | ('\nFailed to diff against upstream branch %s\n\n' |
maruel@chromium.org | 2b38e9c | 2011-10-19 00:04:35 +0000 | [diff] [blame] | 1344 | 'This branch probably doesn\'t exist anymore. To reset the\n' |
| 1345 | 'tracking branch, please run\n' |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 1346 | ' git branch --set-upstream-to origin/main %s\n' |
| 1347 | 'or replace origin/main with the relevant branch') % |
Edward Lemur | 2c62b33 | 2020-03-12 22:12:33 +0000 | [diff] [blame] | 1348 | (upstream, self.GetBranch())) |
bauerb@chromium.org | 6fb99c6 | 2011-04-18 15:57:28 +0000 | [diff] [blame] | 1349 | |
dsansome | e2d6fd9 | 2016-09-08 00:10:47 -0700 | [diff] [blame] | 1350 | def UpdateDescription(self, description, force=False): |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 1351 | assert self.GetIssue(), 'issue is required to update description' |
| 1352 | |
| 1353 | if gerrit_util.HasPendingChangeEdit( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 1354 | self.GetGerritHost(), self._GerritChangeIdentifier()): |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 1355 | if not force: |
| 1356 | confirm_or_exit( |
| 1357 | 'The description cannot be modified while the issue has a pending ' |
| 1358 | 'unpublished edit. Either publish the edit in the Gerrit web UI ' |
| 1359 | 'or delete it.\n\n', action='delete the unpublished edit') |
| 1360 | |
| 1361 | gerrit_util.DeletePendingChangeEdit( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 1362 | self.GetGerritHost(), self._GerritChangeIdentifier()) |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 1363 | gerrit_util.SetCommitMessage( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 1364 | self.GetGerritHost(), self._GerritChangeIdentifier(), |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 1365 | description, notify='NONE') |
| 1366 | |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1367 | self.description = description |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1368 | |
Edward Lemur | 7552630 | 2020-02-27 22:31:05 +0000 | [diff] [blame] | 1369 | def _GetCommonPresubmitArgs(self, verbose, upstream): |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1370 | args = [ |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1371 | '--root', settings.GetRoot(), |
| 1372 | '--upstream', upstream, |
| 1373 | ] |
| 1374 | |
| 1375 | args.extend(['--verbose'] * verbose) |
| 1376 | |
Edward Lesmes | eb1bd62 | 2021-03-01 19:54:07 +0000 | [diff] [blame] | 1377 | remote, remote_branch = self.GetRemoteBranch() |
| 1378 | target_ref = GetTargetRef(remote, remote_branch, None) |
Aleksey Khoroshilov | 35ef5ad | 2022-06-03 18:29:25 +0000 | [diff] [blame] | 1379 | if settings.GetIsGerrit(): |
| 1380 | args.extend(['--gerrit_url', self.GetCodereviewServer()]) |
| 1381 | args.extend(['--gerrit_project', self.GetGerritProject()]) |
| 1382 | args.extend(['--gerrit_branch', target_ref]) |
Edward Lesmes | eb1bd62 | 2021-03-01 19:54:07 +0000 | [diff] [blame] | 1383 | |
Edward Lemur | 99df04e | 2020-03-05 19:39:43 +0000 | [diff] [blame] | 1384 | author = self.GetAuthor() |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1385 | issue = self.GetIssue() |
| 1386 | patchset = self.GetPatchset() |
Edward Lemur | 99df04e | 2020-03-05 19:39:43 +0000 | [diff] [blame] | 1387 | if author: |
| 1388 | args.extend(['--author', author]) |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1389 | if issue: |
| 1390 | args.extend(['--issue', str(issue)]) |
| 1391 | if patchset: |
| 1392 | args.extend(['--patchset', str(patchset)]) |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1393 | |
Edward Lemur | 7552630 | 2020-02-27 22:31:05 +0000 | [diff] [blame] | 1394 | return args |
| 1395 | |
Josip Sokcevic | 017544d | 2022-03-31 23:47:53 +0000 | [diff] [blame] | 1396 | def RunHook(self, |
| 1397 | committing, |
| 1398 | may_prompt, |
| 1399 | verbose, |
| 1400 | parallel, |
| 1401 | upstream, |
| 1402 | description, |
| 1403 | all_files, |
| 1404 | files=None, |
| 1405 | resultdb=False, |
| 1406 | realm=None): |
Edward Lemur | 7552630 | 2020-02-27 22:31:05 +0000 | [diff] [blame] | 1407 | """Calls sys.exit() if the hook fails; returns a HookResults otherwise.""" |
| 1408 | args = self._GetCommonPresubmitArgs(verbose, upstream) |
| 1409 | args.append('--commit' if committing else '--upload') |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1410 | if may_prompt: |
| 1411 | args.append('--may_prompt') |
| 1412 | if parallel: |
| 1413 | args.append('--parallel') |
| 1414 | if all_files: |
| 1415 | args.append('--all_files') |
Josip Sokcevic | 017544d | 2022-03-31 23:47:53 +0000 | [diff] [blame] | 1416 | if files: |
| 1417 | args.extend(files.split(';')) |
| 1418 | args.append('--source_controlled_only') |
Bruce Dawson | 09c0c07 | 2022-05-26 20:28:58 +0000 | [diff] [blame] | 1419 | if files or all_files: |
| 1420 | args.append('--no_diffs') |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1421 | |
Dirk Pranke | 61bf6e8 | 2021-04-23 00:50:21 +0000 | [diff] [blame] | 1422 | if resultdb and not realm: |
| 1423 | # TODO (crbug.com/1113463): store realm somewhere and look it up so |
| 1424 | # it is not required to pass the realm flag |
| 1425 | print('Note: ResultDB reporting will NOT be performed because --realm' |
| 1426 | ' was not specified. To enable ResultDB, please run the command' |
| 1427 | ' again with the --realm argument to specify the LUCI realm.') |
| 1428 | |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 1429 | py3_results = self._RunPresubmit(args, |
| 1430 | description, |
| 1431 | use_python3=True, |
| 1432 | resultdb=resultdb, |
| 1433 | realm=realm) |
Josip Sokcevic | 632bbc0 | 2022-05-19 05:32:50 +0000 | [diff] [blame] | 1434 | if py3_results.get('skipped_presubmits', 1) == 0: |
| 1435 | print('No more presubmits to run - skipping Python 2 presubmits.') |
| 1436 | return py3_results |
| 1437 | |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 1438 | py2_results = self._RunPresubmit(args, |
| 1439 | description, |
| 1440 | use_python3=False, |
| 1441 | resultdb=resultdb, |
| 1442 | realm=realm) |
Dirk Pranke | 61bf6e8 | 2021-04-23 00:50:21 +0000 | [diff] [blame] | 1443 | return self._MergePresubmitResults(py2_results, py3_results) |
| 1444 | |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 1445 | def _RunPresubmit(self, |
| 1446 | args, |
| 1447 | description, |
| 1448 | use_python3, |
| 1449 | resultdb=None, |
| 1450 | realm=None): |
| 1451 | # type: (Sequence[str], str, bool, Optional[bool], Optional[str] |
| 1452 | # ) -> Mapping[str, Any] |
Dirk Pranke | 61bf6e8 | 2021-04-23 00:50:21 +0000 | [diff] [blame] | 1453 | args = args[:] |
| 1454 | vpython = 'vpython3' if use_python3 else 'vpython' |
| 1455 | |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1456 | with gclient_utils.temporary_file() as description_file: |
| 1457 | with gclient_utils.temporary_file() as json_output: |
Edward Lemur | 1a83da1 | 2020-03-04 21:18:36 +0000 | [diff] [blame] | 1458 | gclient_utils.FileWrite(description_file, description) |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1459 | args.extend(['--json_output', json_output]) |
| 1460 | args.extend(['--description_file', description_file]) |
Dirk Pranke | 6f0df68 | 2021-06-25 00:42:33 +0000 | [diff] [blame] | 1461 | if self.GetUsePython3(): |
| 1462 | args.append('--use-python3') |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1463 | start = time_time() |
Dirk Pranke | 61bf6e8 | 2021-04-23 00:50:21 +0000 | [diff] [blame] | 1464 | cmd = [vpython, PRESUBMIT_SUPPORT] + args |
Saagar Sanghavi | 03b1513 | 2020-08-10 16:43:41 +0000 | [diff] [blame] | 1465 | if resultdb and realm: |
| 1466 | cmd = ['rdb', 'stream', '-new', '-realm', realm, '--'] + cmd |
Saagar Sanghavi | 9949ab7 | 2020-07-20 20:56:40 +0000 | [diff] [blame] | 1467 | |
| 1468 | p = subprocess2.Popen(cmd) |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1469 | exit_code = p.wait() |
Saagar Sanghavi | 9949ab7 | 2020-07-20 20:56:40 +0000 | [diff] [blame] | 1470 | |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1471 | metrics.collector.add_repeated('sub_commands', { |
| 1472 | 'command': 'presubmit', |
| 1473 | 'execution_time': time_time() - start, |
| 1474 | 'exit_code': exit_code, |
| 1475 | }) |
| 1476 | |
| 1477 | if exit_code: |
| 1478 | sys.exit(exit_code) |
| 1479 | |
| 1480 | json_results = gclient_utils.FileRead(json_output) |
| 1481 | return json.loads(json_results) |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1482 | |
Dirk Pranke | 61bf6e8 | 2021-04-23 00:50:21 +0000 | [diff] [blame] | 1483 | def _MergePresubmitResults(self, py2_results, py3_results): |
| 1484 | return { |
| 1485 | 'more_cc': sorted(set(py2_results.get('more_cc', []) + |
| 1486 | py3_results.get('more_cc', []))), |
| 1487 | 'errors': ( |
| 1488 | py2_results.get('errors', []) + py3_results.get('errors', [])), |
| 1489 | 'notifications': ( |
| 1490 | py2_results.get('notifications', []) + |
| 1491 | py3_results.get('notifications', [])), |
| 1492 | 'warnings': ( |
| 1493 | py2_results.get('warnings', []) + py3_results.get('warnings', [])) |
| 1494 | } |
| 1495 | |
Brian Sheedy | 7326ca2 | 2022-11-02 18:36:17 +0000 | [diff] [blame] | 1496 | def RunPostUploadHook(self, verbose, upstream, description, py3_only): |
Edward Lemur | 7552630 | 2020-02-27 22:31:05 +0000 | [diff] [blame] | 1497 | args = self._GetCommonPresubmitArgs(verbose, upstream) |
| 1498 | args.append('--post_upload') |
| 1499 | |
| 1500 | with gclient_utils.temporary_file() as description_file: |
Edward Lemur | 1a83da1 | 2020-03-04 21:18:36 +0000 | [diff] [blame] | 1501 | gclient_utils.FileWrite(description_file, description) |
Edward Lemur | 7552630 | 2020-02-27 22:31:05 +0000 | [diff] [blame] | 1502 | args.extend(['--description_file', description_file]) |
Brian Sheedy | 7326ca2 | 2022-11-02 18:36:17 +0000 | [diff] [blame] | 1503 | if not py3_only: |
| 1504 | p_py2 = subprocess2.Popen(['vpython', PRESUBMIT_SUPPORT] + args) |
Josip Sokcevic | e293d3d | 2022-02-16 22:52:15 +0000 | [diff] [blame] | 1505 | p_py3 = subprocess2.Popen(['vpython3', PRESUBMIT_SUPPORT] + args + |
| 1506 | ['--use-python3']) |
Brian Sheedy | 7326ca2 | 2022-11-02 18:36:17 +0000 | [diff] [blame] | 1507 | if not py3_only: |
| 1508 | p_py2.wait() |
Josip Sokcevic | e293d3d | 2022-02-16 22:52:15 +0000 | [diff] [blame] | 1509 | p_py3.wait() |
Edward Lemur | 7552630 | 2020-02-27 22:31:05 +0000 | [diff] [blame] | 1510 | |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1511 | def _GetDescriptionForUpload(self, options, git_diff_args, files): |
Joanna Wang | b46232e | 2023-01-21 01:58:46 +0000 | [diff] [blame] | 1512 | # type: (optparse.Values, Sequence[str], Sequence[str] |
| 1513 | # ) -> ChangeDescription |
| 1514 | """Get description message for upload.""" |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1515 | if self.GetIssue(): |
| 1516 | description = self.FetchDescription() |
| 1517 | elif options.message: |
| 1518 | description = options.message |
| 1519 | else: |
| 1520 | description = _create_description_from_log(git_diff_args) |
| 1521 | if options.title and options.squash: |
Edward Lesmes | 0dd5482 | 2020-03-26 18:24:25 +0000 | [diff] [blame] | 1522 | description = options.title + '\n\n' + description |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1523 | |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1524 | bug = options.bug |
| 1525 | fixed = options.fixed |
Josip Sokcevic | 340edc3 | 2021-07-08 17:01:46 +0000 | [diff] [blame] | 1526 | if not self.GetIssue(): |
| 1527 | # Extract bug number from branch name, but only if issue is being created. |
| 1528 | # It must start with bug or fix, followed by _ or - and number. |
| 1529 | # Optionally, it may contain _ or - after number with arbitrary text. |
| 1530 | # Examples: |
| 1531 | # bug-123 |
| 1532 | # bug_123 |
| 1533 | # fix-123 |
| 1534 | # fix-123-some-description |
mlcui | 7a0b4cb | 2023-01-23 23:14:55 +0000 | [diff] [blame] | 1535 | branch = self.GetBranch() |
| 1536 | if branch is not None: |
| 1537 | match = re.match( |
| 1538 | r'^(?P<type>bug|fix(?:e[sd])?)[_-]?(?P<bugnum>\d+)([-_]|$)', branch) |
| 1539 | if not bug and not fixed and match: |
| 1540 | if match.group('type') == 'bug': |
| 1541 | bug = match.group('bugnum') |
| 1542 | else: |
| 1543 | fixed = match.group('bugnum') |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1544 | |
| 1545 | change_description = ChangeDescription(description, bug, fixed) |
| 1546 | |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 1547 | # Fill gaps in OWNERS coverage to reviewers if requested. |
Edward Lesmes | 8c43c3f | 2021-01-20 00:20:26 +0000 | [diff] [blame] | 1548 | if options.add_owners_to: |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 1549 | assert options.add_owners_to in ('R'), options.add_owners_to |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 1550 | status = self.owners_client.GetFilesApprovalStatus( |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 1551 | files, [], options.reviewers) |
Edward Lesmes | 8c43c3f | 2021-01-20 00:20:26 +0000 | [diff] [blame] | 1552 | missing_files = [ |
| 1553 | f for f in files |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 1554 | if status[f] == self._owners_client.INSUFFICIENT_REVIEWERS |
Edward Lesmes | 8c43c3f | 2021-01-20 00:20:26 +0000 | [diff] [blame] | 1555 | ] |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 1556 | owners = self.owners_client.SuggestOwners( |
| 1557 | missing_files, exclude=[self.GetAuthor()]) |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 1558 | assert isinstance(options.reviewers, list), options.reviewers |
| 1559 | options.reviewers.extend(owners) |
Edward Lesmes | 8c43c3f | 2021-01-20 00:20:26 +0000 | [diff] [blame] | 1560 | |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1561 | # Set the reviewer list now so that presubmit checks can access it. |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 1562 | if options.reviewers: |
| 1563 | change_description.update_reviewers(options.reviewers) |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1564 | |
| 1565 | return change_description |
| 1566 | |
Joanna Wang | a1abbed | 2023-01-24 01:41:05 +0000 | [diff] [blame] | 1567 | def _GetTitleForUpload(self, options, multi_change_upload=False): |
| 1568 | # type: (optparse.Values, Optional[bool]) -> str |
| 1569 | |
| 1570 | # Getting titles for multipl commits is not supported so we return the |
| 1571 | # default. |
| 1572 | if not options.squash or multi_change_upload or options.title: |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1573 | return options.title |
| 1574 | |
| 1575 | # On first upload, patchset title is always this string, while options.title |
| 1576 | # gets converted to first line of message. |
| 1577 | if not self.GetIssue(): |
| 1578 | return 'Initial upload' |
| 1579 | |
| 1580 | # When uploading subsequent patchsets, options.message is taken as the title |
| 1581 | # if options.title is not provided. |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1582 | if options.message: |
| 1583 | return options.message.strip() |
| 1584 | |
| 1585 | # Use the subject of the last commit as title by default. |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1586 | title = RunGit(['show', '-s', '--format=%s', 'HEAD']).strip() |
Mario Bianucci | cebfb4e | 2020-07-22 23:08:16 +0000 | [diff] [blame] | 1587 | if options.force or options.skip_title: |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1588 | return title |
Edward Lesmes | ae3586b | 2020-03-23 21:21:14 +0000 | [diff] [blame] | 1589 | user_title = gclient_utils.AskForData('Title for patchset [%s]: ' % title) |
mlcui | 3da9171 | 2021-05-05 10:00:30 +0000 | [diff] [blame] | 1590 | |
| 1591 | # Use the default title if the user confirms the default with a 'y'. |
| 1592 | if user_title.lower() == 'y': |
| 1593 | return title |
Edward Lesmes | ae3586b | 2020-03-23 21:21:14 +0000 | [diff] [blame] | 1594 | return user_title or title |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1595 | |
Joanna Wang | 562481d | 2023-01-26 21:57:14 +0000 | [diff] [blame] | 1596 | def _GetRefSpecOptions(self, |
| 1597 | options, |
| 1598 | change_desc, |
| 1599 | multi_change_upload=False, |
| 1600 | dogfood_path=False): |
| 1601 | # type: (optparse.Values, Sequence[Changelist], Optional[bool], |
| 1602 | # Optional[bool]) -> Sequence[str] |
Joanna Wang | a1abbed | 2023-01-24 01:41:05 +0000 | [diff] [blame] | 1603 | |
| 1604 | # Extra options that can be specified at push time. Doc: |
| 1605 | # https://gerrit-review.googlesource.com/Documentation/user-upload.html |
| 1606 | refspec_opts = [] |
| 1607 | |
| 1608 | # By default, new changes are started in WIP mode, and subsequent patchsets |
| 1609 | # don't send email. At any time, passing --send-mail or --send-email will |
| 1610 | # mark the change ready and send email for that particular patch. |
| 1611 | if options.send_mail: |
| 1612 | refspec_opts.append('ready') |
| 1613 | refspec_opts.append('notify=ALL') |
Joanna Wang | 562481d | 2023-01-26 21:57:14 +0000 | [diff] [blame] | 1614 | elif (not self.GetIssue() and options.squash and not dogfood_path): |
Joanna Wang | a1abbed | 2023-01-24 01:41:05 +0000 | [diff] [blame] | 1615 | refspec_opts.append('wip') |
| 1616 | else: |
| 1617 | refspec_opts.append('notify=NONE') |
| 1618 | |
| 1619 | # TODO(tandrii): options.message should be posted as a comment if |
| 1620 | # --send-mail or --send-email is set on non-initial upload as Rietveld used |
| 1621 | # to do it. |
| 1622 | |
| 1623 | # Set options.title in case user was prompted in _GetTitleForUpload and |
| 1624 | # _CMDUploadChange needs to be called again. |
| 1625 | options.title = self._GetTitleForUpload( |
| 1626 | options, multi_change_upload=multi_change_upload) |
| 1627 | |
| 1628 | if options.title: |
| 1629 | # Punctuation and whitespace in |title| must be percent-encoded. |
| 1630 | refspec_opts.append('m=' + |
| 1631 | gerrit_util.PercentEncodeForGitRef(options.title)) |
| 1632 | |
| 1633 | if options.private: |
| 1634 | refspec_opts.append('private') |
| 1635 | |
| 1636 | if options.topic: |
| 1637 | # Documentation on Gerrit topics is here: |
| 1638 | # https://gerrit-review.googlesource.com/Documentation/user-upload.html#topic |
| 1639 | refspec_opts.append('topic=%s' % options.topic) |
| 1640 | |
| 1641 | if options.enable_auto_submit: |
| 1642 | refspec_opts.append('l=Auto-Submit+1') |
| 1643 | if options.set_bot_commit: |
| 1644 | refspec_opts.append('l=Bot-Commit+1') |
| 1645 | if options.use_commit_queue: |
| 1646 | refspec_opts.append('l=Commit-Queue+2') |
| 1647 | elif options.cq_dry_run: |
| 1648 | refspec_opts.append('l=Commit-Queue+1') |
| 1649 | elif options.cq_quick_run: |
| 1650 | refspec_opts.append('l=Commit-Queue+1') |
| 1651 | refspec_opts.append('l=Quick-Run+1') |
| 1652 | |
| 1653 | if change_desc.get_reviewers(tbr_only=True): |
| 1654 | score = gerrit_util.GetCodeReviewTbrScore(self.GetGerritHost(), |
| 1655 | self.GetGerritProject()) |
| 1656 | refspec_opts.append('l=Code-Review+%s' % score) |
| 1657 | |
Joanna Wang | 4049791 | 2023-01-24 21:18:16 +0000 | [diff] [blame] | 1658 | # Gerrit sorts hashtags, so order is not important. |
| 1659 | hashtags = {change_desc.sanitize_hash_tag(t) for t in options.hashtags} |
| 1660 | # We check GetIssue because we only add hashtags from the |
| 1661 | # description on the first upload. |
Joanna Wang | 562481d | 2023-01-26 21:57:14 +0000 | [diff] [blame] | 1662 | # TODO(b/265929888): When we fully launch the new path: |
| 1663 | # 1) remove fetching hashtags from description alltogether |
| 1664 | # 2) Or use descrtiption hashtags for: |
| 1665 | # `not (self.GetIssue() and multi_change_upload)` |
| 1666 | # 3) Or enabled change description tags for multi and single changes |
| 1667 | # by adding them post `git push`. |
| 1668 | if not (self.GetIssue() and dogfood_path): |
Joanna Wang | 4049791 | 2023-01-24 21:18:16 +0000 | [diff] [blame] | 1669 | hashtags.update(change_desc.get_hash_tags()) |
| 1670 | refspec_opts.extend(['hashtag=%s' % t for t in hashtags]) |
Joanna Wang | 4049791 | 2023-01-24 21:18:16 +0000 | [diff] [blame] | 1671 | |
| 1672 | # Note: Reviewers, and ccs are handled individually for each |
Joanna Wang | a1abbed | 2023-01-24 01:41:05 +0000 | [diff] [blame] | 1673 | # branch/change. |
| 1674 | return refspec_opts |
| 1675 | |
Joanna Wang | b88a434 | 2023-01-24 01:28:22 +0000 | [diff] [blame] | 1676 | def PrepareSquashedCommit(self, options, parent=None, end_commit=None): |
| 1677 | # type: (optparse.Values, Optional[str], Optional[str]) -> _NewUpload() |
| 1678 | """Create a squashed commit to upload.""" |
| 1679 | if parent is None: |
| 1680 | origin, upstream_branch_ref = self.FetchUpstreamTuple(self.GetBranch()) |
| 1681 | upstream_branch = scm.GIT.ShortBranchName(upstream_branch_ref) |
| 1682 | if origin == '.': |
| 1683 | # upstream is another local branch. |
| 1684 | # Assume we want to upload from upstream's last upload. |
| 1685 | parent = scm.GIT.GetBranchConfig(settings.GetRoot(), upstream_branch, |
| 1686 | GERRIT_SQUASH_HASH_CONFIG_KEY) |
| 1687 | assert parent, ('upstream branch %s not configured correctly. ' |
| 1688 | 'Could not fetch latest gerrit upload from git ' |
| 1689 | 'config.') |
| 1690 | else: |
| 1691 | # upstream is the root of the tree. |
| 1692 | parent = self.GetCommonAncestorWithUpstream() |
| 1693 | |
| 1694 | if end_commit is None: |
| 1695 | end_commit = RunGit(['rev-parse', self.branchref]).strip() |
| 1696 | |
| 1697 | reviewers, ccs, change_desc = self._PrepareChange(options, parent, |
| 1698 | end_commit) |
| 1699 | latest_tree = RunGit(['rev-parse', end_commit + ':']).strip() |
| 1700 | with gclient_utils.temporary_file() as desc_tempfile: |
| 1701 | gclient_utils.FileWrite(desc_tempfile, change_desc.description) |
| 1702 | commit_to_push = RunGit( |
| 1703 | ['commit-tree', latest_tree, '-p', parent, '-F', |
| 1704 | desc_tempfile]).strip() |
| 1705 | |
Joanna Wang | 4049791 | 2023-01-24 21:18:16 +0000 | [diff] [blame] | 1706 | return _NewUpload(reviewers, ccs, commit_to_push, end_commit, parent, |
| 1707 | change_desc) |
Joanna Wang | b88a434 | 2023-01-24 01:28:22 +0000 | [diff] [blame] | 1708 | |
Joanna Wang | e852391 | 2023-01-21 02:05:40 +0000 | [diff] [blame] | 1709 | def PrepareCherryPickSquashedCommit(self, options): |
| 1710 | # type: (optparse.Values) -> _NewUpload() |
| 1711 | """Create a commit cherry-picked on parent to push.""" |
| 1712 | |
| 1713 | parent = self.GetCommonAncestorWithUpstream() |
| 1714 | reviewers, ccs, change_desc = self._PrepareChange(options, parent, |
| 1715 | self.branchref) |
| 1716 | |
| 1717 | new_upload_hash = RunGit(['rev-parse', self.branchref]).strip() |
| 1718 | latest_tree = RunGit(['rev-parse', self.branchref + ':']).strip() |
| 1719 | with gclient_utils.temporary_file() as desc_tempfile: |
| 1720 | gclient_utils.FileWrite(desc_tempfile, change_desc.description) |
| 1721 | commit_to_cp = RunGit( |
| 1722 | ['commit-tree', latest_tree, '-p', parent, '-F', |
| 1723 | desc_tempfile]).strip() |
| 1724 | |
| 1725 | _, upstream_branch_ref = self.FetchUpstreamTuple(self.GetBranch()) |
| 1726 | |
| 1727 | upstream_branch = scm.GIT.ShortBranchName(upstream_branch_ref) |
| 1728 | upstream_squashed_upload = scm.GIT.GetBranchConfig( |
| 1729 | settings.GetRoot(), upstream_branch, GERRIT_SQUASH_HASH_CONFIG_KEY) |
| 1730 | |
| 1731 | RunGit(['checkout', '-q', upstream_squashed_upload]) |
| 1732 | ret, _out = RunGitWithCode(['cherry-pick', commit_to_cp]) |
| 1733 | if ret: |
| 1734 | RunGit(['cherry-pick', '--abort']) |
| 1735 | RunGit(['checkout', '-q', self.branch]) |
| 1736 | DieWithError('Could not cleanly cherry-pick') |
| 1737 | |
| 1738 | commit_to_push = RunGit(['rev-parse', 'HEAD']) |
| 1739 | RunGit(['checkout', '-q', self.branch]) |
| 1740 | |
Joanna Wang | 4049791 | 2023-01-24 21:18:16 +0000 | [diff] [blame] | 1741 | return _NewUpload(reviewers, ccs, commit_to_push, new_upload_hash, parent, |
Joanna Wang | e852391 | 2023-01-21 02:05:40 +0000 | [diff] [blame] | 1742 | change_desc) |
| 1743 | |
Joanna Wang | b46232e | 2023-01-21 01:58:46 +0000 | [diff] [blame] | 1744 | def _PrepareChange(self, options, parent, end_commit): |
| 1745 | # type: (optparse.Values, str, str) -> |
| 1746 | # Tuple[Sequence[str], Sequence[str], ChangeDescription] |
| 1747 | """Prepares the change to be uploaded.""" |
| 1748 | self.EnsureCanUploadPatchset(options.force) |
| 1749 | |
| 1750 | files = self.GetAffectedFiles(parent, end_commit=end_commit) |
| 1751 | change_desc = self._GetDescriptionForUpload(options, [parent, end_commit], |
| 1752 | files) |
| 1753 | |
| 1754 | watchlist = watchlists.Watchlists(settings.GetRoot()) |
| 1755 | self.ExtendCC(watchlist.GetWatchersForPaths(files)) |
| 1756 | if not options.bypass_hooks: |
| 1757 | hook_results = self.RunHook(committing=False, |
| 1758 | may_prompt=not options.force, |
| 1759 | verbose=options.verbose, |
| 1760 | parallel=options.parallel, |
| 1761 | upstream=parent, |
| 1762 | description=change_desc.description, |
| 1763 | all_files=False) |
| 1764 | self.ExtendCC(hook_results['more_cc']) |
| 1765 | |
| 1766 | # Update the change description and ensure we have a Change Id. |
| 1767 | if self.GetIssue(): |
| 1768 | if options.edit_description: |
| 1769 | change_desc.prompt() |
| 1770 | change_detail = self._GetChangeDetail(['CURRENT_REVISION']) |
| 1771 | change_id = change_detail['change_id'] |
| 1772 | change_desc.ensure_change_id(change_id) |
| 1773 | |
| 1774 | # TODO(b/265929888): Pull in external changes for the current branch |
| 1775 | # only. No clear way to pull in external changes for upstream branches |
| 1776 | # yet. Potentially offer a separate command to pull in external changes. |
| 1777 | else: # No change issue. First time uploading |
| 1778 | if not options.force and not options.message_file: |
| 1779 | change_desc.prompt() |
| 1780 | |
| 1781 | # Check if user added a change_id in the descripiton. |
| 1782 | change_ids = git_footers.get_footer_change_id(change_desc.description) |
| 1783 | if len(change_ids) == 1: |
| 1784 | change_id = change_ids[0] |
| 1785 | else: |
| 1786 | change_id = GenerateGerritChangeId(change_desc.description) |
| 1787 | change_desc.ensure_change_id(change_id) |
| 1788 | |
| 1789 | if options.preserve_tryjobs: |
| 1790 | change_desc.set_preserve_tryjobs() |
| 1791 | |
| 1792 | SaveDescriptionBackup(change_desc) |
| 1793 | |
| 1794 | # Add ccs |
| 1795 | ccs = [] |
Joanna Wang | c4ac302 | 2023-01-31 21:19:57 +0000 | [diff] [blame^] | 1796 | # Add default, watchlist, presubmit ccs if this is the initial upload |
Joanna Wang | b46232e | 2023-01-21 01:58:46 +0000 | [diff] [blame] | 1797 | # and CL is not private and auto-ccing has not been disabled. |
Joanna Wang | c4ac302 | 2023-01-31 21:19:57 +0000 | [diff] [blame^] | 1798 | if not options.private and not options.no_autocc and not self.GetIssue(): |
Joanna Wang | b46232e | 2023-01-21 01:58:46 +0000 | [diff] [blame] | 1799 | ccs = self.GetCCList().split(',') |
| 1800 | if len(ccs) > 100: |
| 1801 | lsc = ('https://chromium.googlesource.com/chromium/src/+/HEAD/docs/' |
| 1802 | 'process/lsc/lsc_workflow.md') |
| 1803 | print('WARNING: This will auto-CC %s users.' % len(ccs)) |
| 1804 | print('LSC may be more appropriate: %s' % lsc) |
| 1805 | print('You can also use the --no-autocc flag to disable auto-CC.') |
| 1806 | confirm_or_exit(action='continue') |
| 1807 | |
| 1808 | # Add ccs from the --cc flag. |
| 1809 | if options.cc: |
| 1810 | ccs.extend(options.cc) |
| 1811 | |
| 1812 | ccs = [email.strip() for email in ccs if email.strip()] |
| 1813 | if change_desc.get_cced(): |
| 1814 | ccs.extend(change_desc.get_cced()) |
| 1815 | |
| 1816 | return change_desc.get_reviewers(), ccs, change_desc |
| 1817 | |
Joanna Wang | 4049791 | 2023-01-24 21:18:16 +0000 | [diff] [blame] | 1818 | def PostUploadUpdates(self, options, new_upload, change_number): |
| 1819 | # type: (optparse.Values, _NewUpload, change_number) -> None |
| 1820 | """Makes necessary post upload changes to the local and remote cl.""" |
| 1821 | if not self.GetIssue(): |
| 1822 | self.SetIssue(change_number) |
| 1823 | |
| 1824 | self._GitSetBranchConfigValue(GERRIT_SQUASH_HASH_CONFIG_KEY, |
| 1825 | new_upload.commit_to_push) |
| 1826 | self._GitSetBranchConfigValue(LAST_UPLOAD_HASH_CONFIG_KEY, |
| 1827 | new_upload.new_last_uploaded_commit) |
| 1828 | |
| 1829 | if settings.GetRunPostUploadHook(): |
| 1830 | self.RunPostUploadHook(options.verbose, new_upload.parent, |
| 1831 | new_upload.change_desc.description, |
| 1832 | options.no_python2_post_upload_hooks) |
| 1833 | |
| 1834 | if new_upload.reviewers or new_upload.ccs: |
| 1835 | gerrit_util.AddReviewers(self.GetGerritHost(), |
| 1836 | self._GerritChangeIdentifier(), |
| 1837 | reviewers=new_upload.reviewers, |
| 1838 | ccs=new_upload.ccs, |
| 1839 | notify=bool(options.send_mail)) |
| 1840 | |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1841 | def CMDUpload(self, options, git_diff_args, orig_args): |
| 1842 | """Uploads a change to codereview.""" |
Andrii Shyshkalov | 550e924 | 2017-04-12 17:14:49 +0200 | [diff] [blame] | 1843 | custom_cl_base = None |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1844 | if git_diff_args: |
Andrii Shyshkalov | 550e924 | 2017-04-12 17:14:49 +0200 | [diff] [blame] | 1845 | custom_cl_base = base_branch = git_diff_args[0] |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1846 | else: |
| 1847 | if self.GetBranch() is None: |
| 1848 | DieWithError('Can\'t upload from detached HEAD state. Get on a branch!') |
| 1849 | |
| 1850 | # Default to diffing against common ancestor of upstream branch |
| 1851 | base_branch = self.GetCommonAncestorWithUpstream() |
| 1852 | git_diff_args = [base_branch, 'HEAD'] |
| 1853 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 1854 | # Fast best-effort checks to abort before running potentially expensive |
| 1855 | # hooks if uploading is likely to fail anyway. Passing these checks does |
| 1856 | # not guarantee that uploading will not fail. |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1857 | self.EnsureAuthenticated(force=options.force) |
| 1858 | self.EnsureCanUploadPatchset(force=options.force) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1859 | |
| 1860 | # Apply watchlists on upload. |
Edward Lemur | 2c62b33 | 2020-03-12 22:12:33 +0000 | [diff] [blame] | 1861 | watchlist = watchlists.Watchlists(settings.GetRoot()) |
| 1862 | files = self.GetAffectedFiles(base_branch) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1863 | if not options.bypass_watchlists: |
Daniel Cheng | 7227d21 | 2017-11-17 08:12:37 -0800 | [diff] [blame] | 1864 | self.ExtendCC(watchlist.GetWatchersForPaths(files)) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1865 | |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1866 | change_desc = self._GetDescriptionForUpload(options, git_diff_args, files) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1867 | if not options.bypass_hooks: |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 1868 | hook_results = self.RunHook(committing=False, |
| 1869 | may_prompt=not options.force, |
| 1870 | verbose=options.verbose, |
| 1871 | parallel=options.parallel, |
| 1872 | upstream=base_branch, |
| 1873 | description=change_desc.description, |
| 1874 | all_files=False) |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 1875 | self.ExtendCC(hook_results['more_cc']) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1876 | |
Aaron Gable | 13101a6 | 2018-02-09 13:20:41 -0800 | [diff] [blame] | 1877 | print_stats(git_diff_args) |
Edward Lemur | a12175c | 2020-03-09 16:58:26 +0000 | [diff] [blame] | 1878 | ret = self.CMDUploadChange( |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 1879 | options, git_diff_args, custom_cl_base, change_desc) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1880 | if not ret: |
mlcui | 7a0b4cb | 2023-01-23 23:14:55 +0000 | [diff] [blame] | 1881 | if self.GetBranch() is not None: |
| 1882 | self._GitSetBranchConfigValue( |
| 1883 | LAST_UPLOAD_HASH_CONFIG_KEY, |
| 1884 | scm.GIT.ResolveCommit(settings.GetRoot(), 'HEAD')) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1885 | # Run post upload hooks, if specified. |
| 1886 | if settings.GetRunPostUploadHook(): |
Brian Sheedy | 7326ca2 | 2022-11-02 18:36:17 +0000 | [diff] [blame] | 1887 | self.RunPostUploadHook(options.verbose, base_branch, |
| 1888 | change_desc.description, |
| 1889 | options.no_python2_post_upload_hooks) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1890 | |
| 1891 | # Upload all dependencies if specified. |
| 1892 | if options.dependencies: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 1893 | print() |
| 1894 | print('--dependencies has been specified.') |
| 1895 | print('All dependent local branches will be re-uploaded.') |
| 1896 | print() |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1897 | # Remove the dependencies flag from args so that we do not end up in a |
| 1898 | # loop. |
| 1899 | orig_args.remove('--dependencies') |
Jose Lopes | 3863fc5 | 2020-04-07 17:00:25 +0000 | [diff] [blame] | 1900 | ret = upload_branch_deps(self, orig_args, options.force) |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 1901 | return ret |
| 1902 | |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 1903 | def SetCQState(self, new_state): |
Quinten Yearsley | fc5fd92 | 2017-05-31 11:50:52 -0700 | [diff] [blame] | 1904 | """Updates the CQ state for the latest patchset. |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 1905 | |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 1906 | Issue must have been already uploaded and known. Optionally allows for |
| 1907 | updating Quick-Run (QR) state. |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 1908 | """ |
| 1909 | assert new_state in _CQState.ALL_STATES |
| 1910 | assert self.GetIssue() |
qyearsley | 1fdfcb6 | 2016-10-24 13:22:03 -0700 | [diff] [blame] | 1911 | try: |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1912 | vote_map = { |
| 1913 | _CQState.NONE: 0, |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 1914 | _CQState.QUICK_RUN: 1, |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1915 | _CQState.DRY_RUN: 1, |
| 1916 | _CQState.COMMIT: 2, |
| 1917 | } |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 1918 | if new_state == _CQState.QUICK_RUN: |
| 1919 | labels = { |
| 1920 | 'Commit-Queue': vote_map[_CQState.DRY_RUN], |
| 1921 | 'Quick-Run': vote_map[_CQState.QUICK_RUN], |
| 1922 | } |
| 1923 | else: |
| 1924 | labels = {'Commit-Queue': vote_map[new_state]} |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1925 | notify = False if new_state == _CQState.DRY_RUN else None |
| 1926 | gerrit_util.SetReview( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 1927 | self.GetGerritHost(), self._GerritChangeIdentifier(), |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 1928 | labels=labels, notify=notify) |
qyearsley | 1fdfcb6 | 2016-10-24 13:22:03 -0700 | [diff] [blame] | 1929 | return 0 |
| 1930 | except KeyboardInterrupt: |
| 1931 | raise |
| 1932 | except: |
Quinten Yearsley | fc5fd92 | 2017-05-31 11:50:52 -0700 | [diff] [blame] | 1933 | print('WARNING: Failed to %s.\n' |
qyearsley | 1fdfcb6 | 2016-10-24 13:22:03 -0700 | [diff] [blame] | 1934 | 'Either:\n' |
Quinten Yearsley | fc5fd92 | 2017-05-31 11:50:52 -0700 | [diff] [blame] | 1935 | ' * Your project has no CQ,\n' |
| 1936 | ' * You don\'t have permission to change the CQ state,\n' |
| 1937 | ' * There\'s a bug in this code (see stack trace below).\n' |
| 1938 | 'Consider specifying which bots to trigger manually or asking your ' |
| 1939 | 'project owners for permissions or contacting Chrome Infra at:\n' |
| 1940 | 'https://www.chromium.org/infra\n\n' % |
| 1941 | ('cancel CQ' if new_state == _CQState.NONE else 'trigger CQ')) |
qyearsley | 1fdfcb6 | 2016-10-24 13:22:03 -0700 | [diff] [blame] | 1942 | # Still raise exception so that stack trace is printed. |
| 1943 | raise |
| 1944 | |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 1945 | def GetGerritHost(self): |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1946 | # Lazy load of configs. |
| 1947 | self.GetCodereviewServer() |
tandrii | e32e3ea | 2016-06-22 02:52:48 -0700 | [diff] [blame] | 1948 | if self._gerrit_host and '.' not in self._gerrit_host: |
| 1949 | # Abbreviated domain like "chromium" instead of chromium.googlesource.com. |
| 1950 | # This happens for internal stuff http://crbug.com/614312. |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 1951 | parsed = urllib.parse.urlparse(self.GetRemoteUrl()) |
tandrii | e32e3ea | 2016-06-22 02:52:48 -0700 | [diff] [blame] | 1952 | if parsed.scheme == 'sso': |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 1953 | print('WARNING: using non-https URLs for remote is likely broken\n' |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 1954 | ' Your current remote is: %s' % self.GetRemoteUrl()) |
tandrii | e32e3ea | 2016-06-22 02:52:48 -0700 | [diff] [blame] | 1955 | self._gerrit_host = '%s.googlesource.com' % self._gerrit_host |
| 1956 | self._gerrit_server = 'https://%s' % self._gerrit_host |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1957 | return self._gerrit_host |
| 1958 | |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 1959 | def _GetGitHost(self): |
| 1960 | """Returns git host to be used when uploading change to Gerrit.""" |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 1961 | remote_url = self.GetRemoteUrl() |
| 1962 | if not remote_url: |
| 1963 | return None |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 1964 | return urllib.parse.urlparse(remote_url).netloc |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 1965 | |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1966 | def GetCodereviewServer(self): |
| 1967 | if not self._gerrit_server: |
| 1968 | # If we're on a branch then get the server potentially associated |
| 1969 | # with that branch. |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 1970 | if self.GetIssue() and self.GetBranch(): |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1971 | self._gerrit_server = self._GitGetBranchConfigValue( |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 1972 | CODEREVIEW_SERVER_CONFIG_KEY) |
tandrii | 5d48c32 | 2016-08-18 16:19:37 -0700 | [diff] [blame] | 1973 | if self._gerrit_server: |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 1974 | self._gerrit_host = urllib.parse.urlparse(self._gerrit_server).netloc |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1975 | if not self._gerrit_server: |
| 1976 | # We assume repo to be hosted on Gerrit, and hence Gerrit server |
| 1977 | # has "-review" suffix for lowest level subdomain. |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 1978 | parts = self._GetGitHost().split('.') |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 1979 | parts[0] = parts[0] + '-review' |
| 1980 | self._gerrit_host = '.'.join(parts) |
| 1981 | self._gerrit_server = 'https://%s' % self._gerrit_host |
| 1982 | return self._gerrit_server |
| 1983 | |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 1984 | def GetGerritProject(self): |
Andrii Shyshkalov | 0ec9d15 | 2018-08-23 00:22:58 +0000 | [diff] [blame] | 1985 | """Returns Gerrit project name based on remote git URL.""" |
Andrii Shyshkalov | 2d0e03c | 2018-08-25 04:18:09 +0000 | [diff] [blame] | 1986 | remote_url = self.GetRemoteUrl() |
Andrii Shyshkalov | 0ec9d15 | 2018-08-23 00:22:58 +0000 | [diff] [blame] | 1987 | if remote_url is None: |
Josip | 906bfde | 2020-01-31 22:38:49 +0000 | [diff] [blame] | 1988 | logging.warning('can\'t detect Gerrit project.') |
Andrii Shyshkalov | 2d0e03c | 2018-08-25 04:18:09 +0000 | [diff] [blame] | 1989 | return None |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 1990 | project = urllib.parse.urlparse(remote_url).path.strip('/') |
Andrii Shyshkalov | 0ec9d15 | 2018-08-23 00:22:58 +0000 | [diff] [blame] | 1991 | if project.endswith('.git'): |
| 1992 | project = project[:-len('.git')] |
Andrii Shyshkalov | 1e82867 | 2018-08-23 22:34:37 +0000 | [diff] [blame] | 1993 | # *.googlesource.com hosts ensure that Git/Gerrit projects don't start with |
| 1994 | # 'a/' prefix, because 'a/' prefix is used to force authentication in |
| 1995 | # gitiles/git-over-https protocol. E.g., |
| 1996 | # https://chromium.googlesource.com/a/v8/v8 refers to the same repo/project |
| 1997 | # as |
| 1998 | # https://chromium.googlesource.com/v8/v8 |
| 1999 | if project.startswith('a/'): |
| 2000 | project = project[len('a/'):] |
Andrii Shyshkalov | 0ec9d15 | 2018-08-23 00:22:58 +0000 | [diff] [blame] | 2001 | return project |
| 2002 | |
Andrii Shyshkalov | d06cc78 | 2018-08-23 17:24:19 +0000 | [diff] [blame] | 2003 | def _GerritChangeIdentifier(self): |
| 2004 | """Handy method for gerrit_util.ChangeIdentifier for a given CL. |
| 2005 | |
| 2006 | Not to be confused by value of "Change-Id:" footer. |
Andrii Shyshkalov | 2d0e03c | 2018-08-25 04:18:09 +0000 | [diff] [blame] | 2007 | If Gerrit project can be determined, this will speed up Gerrit HTTP API RPC. |
Andrii Shyshkalov | d06cc78 | 2018-08-23 17:24:19 +0000 | [diff] [blame] | 2008 | """ |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2009 | project = self.GetGerritProject() |
Andrii Shyshkalov | 2d0e03c | 2018-08-25 04:18:09 +0000 | [diff] [blame] | 2010 | if project: |
| 2011 | return gerrit_util.ChangeIdentifier(project, self.GetIssue()) |
| 2012 | # Fall back on still unique, but less efficient change number. |
| 2013 | return str(self.GetIssue()) |
Andrii Shyshkalov | d06cc78 | 2018-08-23 17:24:19 +0000 | [diff] [blame] | 2014 | |
Andrii Shyshkalov | 2f8e924 | 2017-01-23 19:20:19 +0100 | [diff] [blame] | 2015 | def EnsureAuthenticated(self, force, refresh=None): |
tandrii@chromium.org | 9e6c3a5 | 2016-04-12 14:13:08 +0000 | [diff] [blame] | 2016 | """Best effort check that user is authenticated with Gerrit server.""" |
tandrii@chromium.org | 2825353 | 2016-04-14 13:46:56 +0000 | [diff] [blame] | 2017 | if settings.GetGerritSkipEnsureAuthenticated(): |
| 2018 | # For projects with unusual authentication schemes. |
| 2019 | # See http://crbug.com/603378. |
| 2020 | return |
Vadim Shtayura | b250ec1 | 2018-10-04 00:21:08 +0000 | [diff] [blame] | 2021 | |
| 2022 | # Check presence of cookies only if using cookies-based auth method. |
| 2023 | cookie_auth = gerrit_util.Authenticator.get() |
| 2024 | if not isinstance(cookie_auth, gerrit_util.CookiesAuthenticator): |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 2025 | return |
Vadim Shtayura | b250ec1 | 2018-10-04 00:21:08 +0000 | [diff] [blame] | 2026 | |
Florian Mayer | ae510e8 | 2020-01-30 21:04:48 +0000 | [diff] [blame] | 2027 | remote_url = self.GetRemoteUrl() |
| 2028 | if remote_url is None: |
Josip | 906bfde | 2020-01-31 22:38:49 +0000 | [diff] [blame] | 2029 | logging.warning('invalid remote') |
Florian Mayer | ae510e8 | 2020-01-30 21:04:48 +0000 | [diff] [blame] | 2030 | return |
Joanna Wang | 46ffd1b | 2022-09-16 20:44:44 +0000 | [diff] [blame] | 2031 | if urllib.parse.urlparse(remote_url).scheme not in ['https', 'sso']: |
| 2032 | logging.warning( |
| 2033 | 'Ignoring branch %(branch)s with non-https/sso remote ' |
| 2034 | '%(remote)s', { |
| 2035 | 'branch': self.branch, |
| 2036 | 'remote': self.GetRemoteUrl() |
| 2037 | }) |
Daniel Cheng | cf6269b | 2019-05-18 01:02:12 +0000 | [diff] [blame] | 2038 | return |
| 2039 | |
Vadim Shtayura | b250ec1 | 2018-10-04 00:21:08 +0000 | [diff] [blame] | 2040 | # Lazy-loader to identify Gerrit and Git hosts. |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 2041 | self.GetCodereviewServer() |
| 2042 | git_host = self._GetGitHost() |
Edward Lemur | 298f2cf | 2019-02-22 21:40:39 +0000 | [diff] [blame] | 2043 | assert self._gerrit_server and self._gerrit_host and git_host |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 2044 | |
| 2045 | gerrit_auth = cookie_auth.get_auth_header(self._gerrit_host) |
| 2046 | git_auth = cookie_auth.get_auth_header(git_host) |
| 2047 | if gerrit_auth and git_auth: |
| 2048 | if gerrit_auth == git_auth: |
| 2049 | return |
Andrii Shyshkalov | 354e1d2 | 2017-06-09 19:31:33 +0200 | [diff] [blame] | 2050 | all_gsrc = cookie_auth.get_auth_header('d0esN0tEx1st.googlesource.com') |
Raul Tambre | 80ee78e | 2019-05-06 22:41:05 +0000 | [diff] [blame] | 2051 | print( |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2052 | 'WARNING: You have different credentials for Gerrit and git hosts:\n' |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 2053 | ' %s\n' |
| 2054 | ' %s\n' |
Andrii Shyshkalov | 51acef9 | 2017-04-11 17:19:59 +0200 | [diff] [blame] | 2055 | ' Consider running the following command:\n' |
| 2056 | ' git cl creds-check\n' |
Andrii Shyshkalov | 354e1d2 | 2017-06-09 19:31:33 +0200 | [diff] [blame] | 2057 | ' %s\n' |
Raul Tambre | 80ee78e | 2019-05-06 22:41:05 +0000 | [diff] [blame] | 2058 | ' %s' % |
Andrii Shyshkalov | 51acef9 | 2017-04-11 17:19:59 +0200 | [diff] [blame] | 2059 | (git_host, self._gerrit_host, |
Andrii Shyshkalov | 354e1d2 | 2017-06-09 19:31:33 +0200 | [diff] [blame] | 2060 | ('Hint: delete creds for .googlesource.com' if all_gsrc else ''), |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 2061 | cookie_auth.get_new_password_message(git_host))) |
| 2062 | if not force: |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 2063 | confirm_or_exit('If you know what you are doing', action='continue') |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 2064 | return |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 2065 | |
| 2066 | missing = ( |
| 2067 | ([] if gerrit_auth else [self._gerrit_host]) + |
| 2068 | ([] if git_auth else [git_host])) |
| 2069 | DieWithError('Credentials for the following hosts are required:\n' |
| 2070 | ' %s\n' |
| 2071 | 'These are read from %s (or legacy %s)\n' |
| 2072 | '%s' % ( |
| 2073 | '\n '.join(missing), |
| 2074 | cookie_auth.get_gitcookies_path(), |
| 2075 | cookie_auth.get_netrc_path(), |
| 2076 | cookie_auth.get_new_password_message(git_host))) |
tandrii@chromium.org | fe30f18 | 2016-04-13 12:15:04 +0000 | [diff] [blame] | 2077 | |
Andrii Shyshkalov | bb86fbb | 2017-03-24 14:59:28 +0100 | [diff] [blame] | 2078 | def EnsureCanUploadPatchset(self, force): |
Andrii Shyshkalov | 3e63142 | 2017-02-16 17:46:44 +0100 | [diff] [blame] | 2079 | if not self.GetIssue(): |
| 2080 | return |
| 2081 | |
Andrii Shyshkalov | 3e63142 | 2017-02-16 17:46:44 +0100 | [diff] [blame] | 2082 | status = self._GetChangeDetail()['status'] |
Joanna Wang | 583ca66 | 2022-04-27 21:17:17 +0000 | [diff] [blame] | 2083 | if status == 'ABANDONED': |
Bruce Dawson | eb8426e | 2022-08-05 23:58:15 +0000 | [diff] [blame] | 2084 | DieWithError( |
| 2085 | 'Change %s has been abandoned, new uploads are not allowed' % |
| 2086 | (self.GetIssueURL())) |
Joanna Wang | 583ca66 | 2022-04-27 21:17:17 +0000 | [diff] [blame] | 2087 | if status == 'MERGED': |
| 2088 | answer = gclient_utils.AskForData( |
| 2089 | 'Change %s has been submitted, new uploads are not allowed. ' |
| 2090 | 'Would you like to start a new change (Y/n)?' % self.GetIssueURL() |
| 2091 | ).lower() |
| 2092 | if answer not in ('y', ''): |
| 2093 | DieWithError('New uploads are not allowed.') |
| 2094 | self.SetIssue() |
| 2095 | return |
Andrii Shyshkalov | 3e63142 | 2017-02-16 17:46:44 +0100 | [diff] [blame] | 2096 | |
Vadim Shtayura | b250ec1 | 2018-10-04 00:21:08 +0000 | [diff] [blame] | 2097 | # TODO(vadimsh): For some reason the chunk of code below was skipped if |
| 2098 | # 'is_gce' is True. I'm just refactoring it to be 'skip if not cookies'. |
| 2099 | # Apparently this check is not very important? Otherwise get_auth_email |
| 2100 | # could have been added to other implementations of Authenticator. |
| 2101 | cookies_auth = gerrit_util.Authenticator.get() |
| 2102 | if not isinstance(cookies_auth, gerrit_util.CookiesAuthenticator): |
Andrii Shyshkalov | bb86fbb | 2017-03-24 14:59:28 +0100 | [diff] [blame] | 2103 | return |
Vadim Shtayura | b250ec1 | 2018-10-04 00:21:08 +0000 | [diff] [blame] | 2104 | |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2105 | cookies_user = cookies_auth.get_auth_email(self.GetGerritHost()) |
Andrii Shyshkalov | bb86fbb | 2017-03-24 14:59:28 +0100 | [diff] [blame] | 2106 | if self.GetIssueOwner() == cookies_user: |
| 2107 | return |
| 2108 | logging.debug('change %s owner is %s, cookies user is %s', |
| 2109 | self.GetIssue(), self.GetIssueOwner(), cookies_user) |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2110 | # Maybe user has linked accounts or something like that, |
Andrii Shyshkalov | bb86fbb | 2017-03-24 14:59:28 +0100 | [diff] [blame] | 2111 | # so ask what Gerrit thinks of this user. |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2112 | details = gerrit_util.GetAccountDetails(self.GetGerritHost(), 'self') |
Andrii Shyshkalov | bb86fbb | 2017-03-24 14:59:28 +0100 | [diff] [blame] | 2113 | if details['email'] == self.GetIssueOwner(): |
| 2114 | return |
| 2115 | if not force: |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2116 | print('WARNING: Change %s is owned by %s, but you authenticate to Gerrit ' |
Andrii Shyshkalov | bb86fbb | 2017-03-24 14:59:28 +0100 | [diff] [blame] | 2117 | 'as %s.\n' |
| 2118 | 'Uploading may fail due to lack of permissions.' % |
| 2119 | (self.GetIssue(), self.GetIssueOwner(), details['email'])) |
| 2120 | confirm_or_exit(action='upload') |
| 2121 | |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 2122 | def GetStatus(self): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 2123 | """Applies a rough heuristic to give a simple summary of an issue's review |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2124 | or CQ status, assuming adherence to a common workflow. |
| 2125 | |
| 2126 | Returns None if no issue for this branch, or one of the following keywords: |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 2127 | * 'error' - error from review tool (including deleted issues) |
| 2128 | * 'unsent' - no reviewers added |
| 2129 | * 'waiting' - waiting for review |
| 2130 | * 'reply' - waiting for uploader to reply to review |
| 2131 | * 'lgtm' - Code-Review label has been set |
Andrii Shyshkalov | 0e889b7 | 2019-07-15 22:28:48 +0000 | [diff] [blame] | 2132 | * 'dry-run' - dry-running in the CQ |
| 2133 | * 'commit' - in the CQ |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 2134 | * 'closed' - successfully submitted or abandoned |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2135 | """ |
| 2136 | if not self.GetIssue(): |
| 2137 | return None |
| 2138 | |
| 2139 | try: |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 2140 | data = self._GetChangeDetail([ |
| 2141 | 'DETAILED_LABELS', 'CURRENT_REVISION', 'SUBMITTABLE']) |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 2142 | except GerritChangeNotExists: |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2143 | return 'error' |
| 2144 | |
tandrii@chromium.org | 5e1bf38 | 2016-05-17 08:43:24 +0000 | [diff] [blame] | 2145 | if data['status'] in ('ABANDONED', 'MERGED'): |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2146 | return 'closed' |
| 2147 | |
Andrii Shyshkalov | b8268ca | 2019-04-03 23:33:44 +0000 | [diff] [blame] | 2148 | cq_label = data['labels'].get('Commit-Queue', {}) |
| 2149 | max_cq_vote = 0 |
| 2150 | for vote in cq_label.get('all', []): |
| 2151 | max_cq_vote = max(max_cq_vote, vote.get('value', 0)) |
| 2152 | if max_cq_vote == 2: |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 2153 | return 'commit' |
Andrii Shyshkalov | b8268ca | 2019-04-03 23:33:44 +0000 | [diff] [blame] | 2154 | if max_cq_vote == 1: |
| 2155 | return 'dry-run' |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2156 | |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 2157 | if data['labels'].get('Code-Review', {}).get('approved'): |
| 2158 | return 'lgtm' |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2159 | |
| 2160 | if not data.get('reviewers', {}).get('REVIEWER', []): |
| 2161 | return 'unsent' |
| 2162 | |
Andrii Shyshkalov | 33e88a4 | 2017-01-27 14:45:30 +0100 | [diff] [blame] | 2163 | owner = data['owner'].get('_account_id') |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 2164 | messages = sorted(data.get('messages', []), key=lambda m: m.get('date')) |
Andrii Shyshkalov | 8aa9d62 | 2020-03-10 19:15:35 +0000 | [diff] [blame] | 2165 | while messages: |
| 2166 | m = messages.pop() |
Andrii Shyshkalov | 899785a | 2021-07-09 12:45:37 +0000 | [diff] [blame] | 2167 | if (m.get('tag', '').startswith('autogenerated:cq') or |
| 2168 | m.get('tag', '').startswith('autogenerated:cv')): |
| 2169 | # Ignore replies from LUCI CV/CQ. |
Andrii Shyshkalov | 33e88a4 | 2017-01-27 14:45:30 +0100 | [diff] [blame] | 2170 | continue |
Andrii Shyshkalov | 8aa9d62 | 2020-03-10 19:15:35 +0000 | [diff] [blame] | 2171 | if m.get('author', {}).get('_account_id') == owner: |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 2172 | # Most recent message was by owner. |
| 2173 | return 'waiting' |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 2174 | |
| 2175 | # Some reply from non-owner. |
| 2176 | return 'reply' |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 2177 | |
| 2178 | # Somehow there are no messages even though there are reviewers. |
| 2179 | return 'unsent' |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 2180 | |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2181 | def GetMostRecentPatchset(self, update=True): |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 2182 | if not self.GetIssue(): |
| 2183 | return None |
| 2184 | |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2185 | data = self._GetChangeDetail(['CURRENT_REVISION']) |
Aaron Gable | e8856ee | 2017-12-07 12:41:46 -0800 | [diff] [blame] | 2186 | patchset = data['revisions'][data['current_revision']]['_number'] |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2187 | if update: |
| 2188 | self.SetPatchset(patchset) |
Aaron Gable | e8856ee | 2017-12-07 12:41:46 -0800 | [diff] [blame] | 2189 | return patchset |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 2190 | |
Gavin Mak | f35a9eb | 2022-11-17 18:34:36 +0000 | [diff] [blame] | 2191 | def _IsPatchsetRangeSignificant(self, lower, upper): |
| 2192 | """Returns True if the inclusive range of patchsets contains any reworks or |
| 2193 | rebases.""" |
| 2194 | if not self.GetIssue(): |
| 2195 | return False |
| 2196 | |
| 2197 | data = self._GetChangeDetail(['ALL_REVISIONS']) |
| 2198 | ps_kind = {} |
| 2199 | for rev_info in data.get('revisions', {}).values(): |
| 2200 | ps_kind[rev_info['_number']] = rev_info.get('kind', '') |
| 2201 | |
| 2202 | for ps in range(lower, upper + 1): |
| 2203 | assert ps in ps_kind, 'expected patchset %d in change detail' % ps |
| 2204 | if ps_kind[ps] not in ('NO_CHANGE', 'NO_CODE_CHANGE'): |
| 2205 | return True |
| 2206 | return False |
| 2207 | |
Gavin Mak | e61ccc5 | 2020-11-13 00:12:57 +0000 | [diff] [blame] | 2208 | def GetMostRecentDryRunPatchset(self): |
| 2209 | """Get patchsets equivalent to the most recent patchset and return |
| 2210 | the patchset with the latest dry run. If none have been dry run, return |
| 2211 | the latest patchset.""" |
| 2212 | if not self.GetIssue(): |
| 2213 | return None |
| 2214 | |
| 2215 | data = self._GetChangeDetail(['ALL_REVISIONS']) |
| 2216 | patchset = data['revisions'][data['current_revision']]['_number'] |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 2217 | dry_run = {int(m['_revision_number']) |
| 2218 | for m in data.get('messages', []) |
| 2219 | if m.get('tag', '').endswith('dry-run')} |
Gavin Mak | e61ccc5 | 2020-11-13 00:12:57 +0000 | [diff] [blame] | 2220 | |
| 2221 | for revision_info in sorted(data.get('revisions', {}).values(), |
| 2222 | key=lambda c: c['_number'], reverse=True): |
| 2223 | if revision_info['_number'] in dry_run: |
| 2224 | patchset = revision_info['_number'] |
| 2225 | break |
| 2226 | if revision_info.get('kind', '') not in \ |
| 2227 | ('NO_CHANGE', 'NO_CODE_CHANGE', 'TRIVIAL_REBASE'): |
| 2228 | break |
| 2229 | self.SetPatchset(patchset) |
| 2230 | return patchset |
| 2231 | |
Aaron Gable | 636b13f | 2017-07-14 10:42:48 -0700 | [diff] [blame] | 2232 | def AddComment(self, message, publish=None): |
Andrii Shyshkalov | 889677c | 2018-08-28 20:43:06 +0000 | [diff] [blame] | 2233 | gerrit_util.SetReview( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2234 | self.GetGerritHost(), self._GerritChangeIdentifier(), |
Andrii Shyshkalov | 889677c | 2018-08-28 20:43:06 +0000 | [diff] [blame] | 2235 | msg=message, ready=publish) |
Andrii Shyshkalov | 625986d | 2017-03-16 00:24:37 +0100 | [diff] [blame] | 2236 | |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2237 | def GetCommentsSummary(self, readable=True): |
Andrii Shyshkalov | 5a0cf20 | 2017-03-17 16:14:59 +0100 | [diff] [blame] | 2238 | # DETAILED_ACCOUNTS is to get emails in accounts. |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2239 | # CURRENT_REVISION is included to get the latest patchset so that |
| 2240 | # only the robot comments from the latest patchset can be shown. |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2241 | messages = self._GetChangeDetail( |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2242 | options=['MESSAGES', 'DETAILED_ACCOUNTS', |
| 2243 | 'CURRENT_REVISION']).get('messages', []) |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2244 | file_comments = gerrit_util.GetChangeComments( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2245 | self.GetGerritHost(), self._GerritChangeIdentifier()) |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2246 | robot_file_comments = gerrit_util.GetChangeRobotComments( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2247 | self.GetGerritHost(), self._GerritChangeIdentifier()) |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2248 | |
| 2249 | # Add the robot comments onto the list of comments, but only |
Andrii Shyshkalov | aeee6a8 | 2019-10-09 21:56:25 +0000 | [diff] [blame] | 2250 | # keep those that are from the latest patchset. |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2251 | latest_patch_set = self.GetMostRecentPatchset() |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 2252 | for path, robot_comments in robot_file_comments.items(): |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2253 | line_comments = file_comments.setdefault(path, []) |
| 2254 | line_comments.extend( |
| 2255 | [c for c in robot_comments if c['patch_set'] == latest_patch_set]) |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2256 | |
| 2257 | # Build dictionary of file comments for easy access and sorting later. |
| 2258 | # {author+date: {path: {patchset: {line: url+message}}}} |
| 2259 | comments = collections.defaultdict( |
| 2260 | lambda: collections.defaultdict(lambda: collections.defaultdict(dict))) |
Andrii Shyshkalov | a3762a9 | 2020-11-25 10:20:42 +0000 | [diff] [blame] | 2261 | |
| 2262 | server = self.GetCodereviewServer() |
| 2263 | if server in _KNOWN_GERRIT_TO_SHORT_URLS: |
| 2264 | # /c/ is automatically added by short URL server. |
| 2265 | url_prefix = '%s/%s' % (_KNOWN_GERRIT_TO_SHORT_URLS[server], |
| 2266 | self.GetIssue()) |
| 2267 | else: |
| 2268 | url_prefix = '%s/c/%s' % (server, self.GetIssue()) |
| 2269 | |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 2270 | for path, line_comments in file_comments.items(): |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2271 | for comment in line_comments: |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2272 | tag = comment.get('tag', '') |
| 2273 | if tag.startswith('autogenerated') and 'robot_id' not in comment: |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2274 | continue |
| 2275 | key = (comment['author']['email'], comment['updated']) |
| 2276 | if comment.get('side', 'REVISION') == 'PARENT': |
| 2277 | patchset = 'Base' |
| 2278 | else: |
| 2279 | patchset = 'PS%d' % comment['patch_set'] |
| 2280 | line = comment.get('line', 0) |
Andrii Shyshkalov | a3762a9 | 2020-11-25 10:20:42 +0000 | [diff] [blame] | 2281 | url = ('%s/%s/%s#%s%s' % |
| 2282 | (url_prefix, comment['patch_set'], path, |
| 2283 | 'b' if comment.get('side') == 'PARENT' else '', |
| 2284 | str(line) if line else '')) |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2285 | comments[key][path][patchset][line] = (url, comment['message']) |
| 2286 | |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2287 | summaries = [] |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2288 | for msg in messages: |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2289 | summary = self._BuildCommentSummary(msg, comments, readable) |
| 2290 | if summary: |
| 2291 | summaries.append(summary) |
| 2292 | return summaries |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 2293 | |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2294 | @staticmethod |
| 2295 | def _BuildCommentSummary(msg, comments, readable): |
Josip Sokcevic | 266129c | 2021-11-09 00:22:00 +0000 | [diff] [blame] | 2296 | if 'email' not in msg['author']: |
| 2297 | # Some bot accounts may not have an email associated. |
| 2298 | return None |
| 2299 | |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 2300 | key = (msg['author']['email'], msg['date']) |
| 2301 | # Don't bother showing autogenerated messages that don't have associated |
| 2302 | # file or line comments. this will filter out most autogenerated |
| 2303 | # messages, but will keep robot comments like those from Tricium. |
| 2304 | is_autogenerated = msg.get('tag', '').startswith('autogenerated') |
| 2305 | if is_autogenerated and not comments.get(key): |
| 2306 | return None |
| 2307 | message = msg['message'] |
| 2308 | # Gerrit spits out nanoseconds. |
| 2309 | assert len(msg['date'].split('.')[-1]) == 9 |
| 2310 | date = datetime.datetime.strptime(msg['date'][:-3], |
| 2311 | '%Y-%m-%d %H:%M:%S.%f') |
| 2312 | if key in comments: |
| 2313 | message += '\n' |
| 2314 | for path, patchsets in sorted(comments.get(key, {}).items()): |
| 2315 | if readable: |
| 2316 | message += '\n%s' % path |
| 2317 | for patchset, lines in sorted(patchsets.items()): |
| 2318 | for line, (url, content) in sorted(lines.items()): |
| 2319 | if line: |
| 2320 | line_str = 'Line %d' % line |
| 2321 | path_str = '%s:%d:' % (path, line) |
| 2322 | else: |
| 2323 | line_str = 'File comment' |
| 2324 | path_str = '%s:0:' % path |
| 2325 | if readable: |
| 2326 | message += '\n %s, %s: %s' % (patchset, line_str, url) |
| 2327 | message += '\n %s\n' % content |
| 2328 | else: |
| 2329 | message += '\n%s ' % path_str |
| 2330 | message += '\n%s\n' % content |
| 2331 | |
| 2332 | return _CommentSummary( |
| 2333 | date=date, |
| 2334 | message=message, |
| 2335 | sender=msg['author']['email'], |
| 2336 | autogenerated=is_autogenerated, |
| 2337 | # These could be inferred from the text messages and correlated with |
| 2338 | # Code-Review label maximum, however this is not reliable. |
| 2339 | # Leaving as is until the need arises. |
| 2340 | approval=False, |
| 2341 | disapproval=False, |
| 2342 | ) |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 2343 | |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 2344 | def CloseIssue(self): |
Andrii Shyshkalov | 889677c | 2018-08-28 20:43:06 +0000 | [diff] [blame] | 2345 | gerrit_util.AbandonChange( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2346 | self.GetGerritHost(), self._GerritChangeIdentifier(), msg='') |
tandrii@chromium.org | aa5ced1 | 2016-03-29 09:41:14 +0000 | [diff] [blame] | 2347 | |
Xinan Lin | 1bd4ffa | 2021-07-28 00:54:22 +0000 | [diff] [blame] | 2348 | def SubmitIssue(self): |
Andrii Shyshkalov | 889677c | 2018-08-28 20:43:06 +0000 | [diff] [blame] | 2349 | gerrit_util.SubmitChange( |
Xinan Lin | 1bd4ffa | 2021-07-28 00:54:22 +0000 | [diff] [blame] | 2350 | self.GetGerritHost(), self._GerritChangeIdentifier()) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 2351 | |
Edward Lesmes | 7677e5c | 2020-02-19 20:39:03 +0000 | [diff] [blame] | 2352 | def _GetChangeDetail(self, options=None): |
| 2353 | """Returns details of associated Gerrit change and caching results.""" |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2354 | options = options or [] |
Andrii Shyshkalov | 03e0ed2 | 2018-08-28 19:39:30 +0000 | [diff] [blame] | 2355 | assert self.GetIssue(), 'issue is required to query Gerrit' |
Andrii Shyshkalov | 258e0a6 | 2017-01-24 16:50:57 +0100 | [diff] [blame] | 2356 | |
Andrii Shyshkalov | 8039be7 | 2017-01-26 09:38:18 +0100 | [diff] [blame] | 2357 | # Optimization to avoid multiple RPCs: |
Edward Lesmes | 7677e5c | 2020-02-19 20:39:03 +0000 | [diff] [blame] | 2358 | if 'CURRENT_REVISION' in options or 'ALL_REVISIONS' in options: |
Andrii Shyshkalov | 8039be7 | 2017-01-26 09:38:18 +0100 | [diff] [blame] | 2359 | options.append('CURRENT_COMMIT') |
| 2360 | |
Andrii Shyshkalov | 258e0a6 | 2017-01-24 16:50:57 +0100 | [diff] [blame] | 2361 | # Normalize issue and options for consistent keys in cache. |
Andrii Shyshkalov | 03e0ed2 | 2018-08-28 19:39:30 +0000 | [diff] [blame] | 2362 | cache_key = str(self.GetIssue()) |
Edward Lesmes | 7677e5c | 2020-02-19 20:39:03 +0000 | [diff] [blame] | 2363 | options_set = frozenset(o.upper() for o in options) |
Andrii Shyshkalov | 258e0a6 | 2017-01-24 16:50:57 +0100 | [diff] [blame] | 2364 | |
Edward Lesmes | 7677e5c | 2020-02-19 20:39:03 +0000 | [diff] [blame] | 2365 | for cached_options_set, data in self._detail_cache.get(cache_key, []): |
| 2366 | # Assumption: data fetched before with extra options is suitable |
| 2367 | # for return for a smaller set of options. |
| 2368 | # For example, if we cached data for |
| 2369 | # options=[CURRENT_REVISION, DETAILED_FOOTERS] |
| 2370 | # and request is for options=[CURRENT_REVISION], |
| 2371 | # THEN we can return prior cached data. |
| 2372 | if options_set.issubset(cached_options_set): |
| 2373 | return data |
Andrii Shyshkalov | 258e0a6 | 2017-01-24 16:50:57 +0100 | [diff] [blame] | 2374 | |
Andrii Shyshkalov | c6c8b4c | 2016-11-09 20:51:20 +0100 | [diff] [blame] | 2375 | try: |
Andrii Shyshkalov | 03e0ed2 | 2018-08-28 19:39:30 +0000 | [diff] [blame] | 2376 | data = gerrit_util.GetChangeDetail( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2377 | self.GetGerritHost(), self._GerritChangeIdentifier(), options_set) |
Andrii Shyshkalov | c6c8b4c | 2016-11-09 20:51:20 +0100 | [diff] [blame] | 2378 | except gerrit_util.GerritError as e: |
| 2379 | if e.http_status == 404: |
Andrii Shyshkalov | 03e0ed2 | 2018-08-28 19:39:30 +0000 | [diff] [blame] | 2380 | raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer()) |
Andrii Shyshkalov | c6c8b4c | 2016-11-09 20:51:20 +0100 | [diff] [blame] | 2381 | raise |
Andrii Shyshkalov | 258e0a6 | 2017-01-24 16:50:57 +0100 | [diff] [blame] | 2382 | |
Edward Lesmes | 7677e5c | 2020-02-19 20:39:03 +0000 | [diff] [blame] | 2383 | self._detail_cache.setdefault(cache_key, []).append((options_set, data)) |
tandrii | c2405f5 | 2016-10-10 08:13:15 -0700 | [diff] [blame] | 2384 | return data |
tandrii@chromium.org | 013a280 | 2016-03-29 09:52:33 +0000 | [diff] [blame] | 2385 | |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2386 | def _GetChangeCommit(self, revision='current'): |
Andrii Shyshkalov | e263316 | 2018-08-27 23:50:31 +0000 | [diff] [blame] | 2387 | assert self.GetIssue(), 'issue must be set to query Gerrit' |
Aaron Gable | 6f5a8d9 | 2017-04-18 14:49:05 -0700 | [diff] [blame] | 2388 | try: |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2389 | data = gerrit_util.GetChangeCommit(self.GetGerritHost(), |
| 2390 | self._GerritChangeIdentifier(), |
| 2391 | revision) |
Aaron Gable | 6f5a8d9 | 2017-04-18 14:49:05 -0700 | [diff] [blame] | 2392 | except gerrit_util.GerritError as e: |
| 2393 | if e.http_status == 404: |
Andrii Shyshkalov | e263316 | 2018-08-27 23:50:31 +0000 | [diff] [blame] | 2394 | raise GerritChangeNotExists(self.GetIssue(), self.GetCodereviewServer()) |
Aaron Gable | 6f5a8d9 | 2017-04-18 14:49:05 -0700 | [diff] [blame] | 2395 | raise |
agable | 32978d9 | 2016-11-01 12:55:02 -0700 | [diff] [blame] | 2396 | return data |
| 2397 | |
Karen Qian | 40c1942 | 2019-03-13 21:28:29 +0000 | [diff] [blame] | 2398 | def _IsCqConfigured(self): |
| 2399 | detail = self._GetChangeDetail(['LABELS']) |
Andrii Shyshkalov | 8effa4d | 2020-01-21 13:23:36 +0000 | [diff] [blame] | 2400 | return u'Commit-Queue' in detail.get('labels', {}) |
Karen Qian | 40c1942 | 2019-03-13 21:28:29 +0000 | [diff] [blame] | 2401 | |
Saagar Sanghavi | 03b1513 | 2020-08-10 16:43:41 +0000 | [diff] [blame] | 2402 | def CMDLand(self, force, bypass_hooks, verbose, parallel, resultdb, realm): |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2403 | if git_common.is_dirty_git_tree('land'): |
| 2404 | return 1 |
Karen Qian | 40c1942 | 2019-03-13 21:28:29 +0000 | [diff] [blame] | 2405 | |
tandrii | d60367b | 2016-06-22 05:25:12 -0700 | [diff] [blame] | 2406 | detail = self._GetChangeDetail(['CURRENT_REVISION', 'LABELS']) |
Karen Qian | 40c1942 | 2019-03-13 21:28:29 +0000 | [diff] [blame] | 2407 | if not force and self._IsCqConfigured(): |
Andrii Shyshkalov | 0e889b7 | 2019-07-15 22:28:48 +0000 | [diff] [blame] | 2408 | confirm_or_exit('\nIt seems this repository has a CQ, ' |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 2409 | 'which can test and land changes for you. ' |
| 2410 | 'Are you sure you wish to bypass it?\n', |
| 2411 | action='bypass CQ') |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2412 | differs = True |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 2413 | last_upload = self._GitGetBranchConfigValue(GERRIT_SQUASH_HASH_CONFIG_KEY) |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2414 | # Note: git diff outputs nothing if there is no diff. |
| 2415 | if not last_upload or RunGit(['diff', last_upload]).strip(): |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2416 | print('WARNING: Some changes from local branch haven\'t been uploaded.') |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2417 | else: |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2418 | if detail['current_revision'] == last_upload: |
| 2419 | differs = False |
| 2420 | else: |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2421 | print('WARNING: Local branch contents differ from latest uploaded ' |
| 2422 | 'patchset.') |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2423 | if differs: |
| 2424 | if not force: |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 2425 | confirm_or_exit( |
| 2426 | 'Do you want to submit latest Gerrit patchset and bypass hooks?\n', |
| 2427 | action='submit') |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2428 | print('WARNING: Bypassing hooks and submitting latest uploaded patchset.') |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2429 | elif not bypass_hooks: |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 2430 | upstream = self.GetCommonAncestorWithUpstream() |
| 2431 | if self.GetIssue(): |
| 2432 | description = self.FetchDescription() |
| 2433 | else: |
Edward Lemur | a12175c | 2020-03-09 16:58:26 +0000 | [diff] [blame] | 2434 | description = _create_description_from_log([upstream]) |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 2435 | self.RunHook( |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2436 | committing=True, |
| 2437 | may_prompt=not force, |
| 2438 | verbose=verbose, |
Edward Lemur | 227d510 | 2020-02-25 23:45:35 +0000 | [diff] [blame] | 2439 | parallel=parallel, |
| 2440 | upstream=upstream, |
| 2441 | description=description, |
Saagar Sanghavi | 9949ab7 | 2020-07-20 20:56:40 +0000 | [diff] [blame] | 2442 | all_files=False, |
Saagar Sanghavi | 03b1513 | 2020-08-10 16:43:41 +0000 | [diff] [blame] | 2443 | resultdb=resultdb, |
| 2444 | realm=realm) |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2445 | |
Xinan Lin | 1bd4ffa | 2021-07-28 00:54:22 +0000 | [diff] [blame] | 2446 | self.SubmitIssue() |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2447 | print('Issue %s has been submitted.' % self.GetIssueURL()) |
agable | 32978d9 | 2016-11-01 12:55:02 -0700 | [diff] [blame] | 2448 | links = self._GetChangeCommit().get('web_links', []) |
| 2449 | for link in links: |
Michael Moss | e371c64 | 2021-09-29 16:41:04 +0000 | [diff] [blame] | 2450 | if link.get('name') in ['gitiles', 'browse'] and link.get('url'): |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2451 | print('Landed as: %s' % link.get('url')) |
agable | 32978d9 | 2016-11-01 12:55:02 -0700 | [diff] [blame] | 2452 | break |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 2453 | return 0 |
| 2454 | |
Bruce Dawson | f362f6f | 2021-02-18 23:15:17 +0000 | [diff] [blame] | 2455 | def CMDPatchWithParsedIssue(self, parsed_issue_arg, nocommit, force, |
| 2456 | newbranch): |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2457 | assert parsed_issue_arg.valid |
| 2458 | |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 2459 | self.issue = parsed_issue_arg.issue |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2460 | |
| 2461 | if parsed_issue_arg.hostname: |
| 2462 | self._gerrit_host = parsed_issue_arg.hostname |
| 2463 | self._gerrit_server = 'https://%s' % self._gerrit_host |
| 2464 | |
tandrii | c2405f5 | 2016-10-10 08:13:15 -0700 | [diff] [blame] | 2465 | try: |
| 2466 | detail = self._GetChangeDetail(['ALL_REVISIONS']) |
Aaron Gable | a45ee11 | 2016-11-22 15:14:38 -0800 | [diff] [blame] | 2467 | except GerritChangeNotExists as e: |
tandrii | c2405f5 | 2016-10-10 08:13:15 -0700 | [diff] [blame] | 2468 | DieWithError(str(e)) |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2469 | |
| 2470 | if not parsed_issue_arg.patchset: |
| 2471 | # Use current revision by default. |
| 2472 | revision_info = detail['revisions'][detail['current_revision']] |
| 2473 | patchset = int(revision_info['_number']) |
| 2474 | else: |
| 2475 | patchset = parsed_issue_arg.patchset |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 2476 | for revision_info in detail['revisions'].values(): |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2477 | if int(revision_info['_number']) == parsed_issue_arg.patchset: |
| 2478 | break |
| 2479 | else: |
Aaron Gable | a45ee11 | 2016-11-22 15:14:38 -0800 | [diff] [blame] | 2480 | DieWithError('Couldn\'t find patchset %i in change %i' % |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2481 | (parsed_issue_arg.patchset, self.GetIssue())) |
| 2482 | |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 2483 | remote_url = self.GetRemoteUrl() |
Aaron Gable | 697a91b | 2018-01-19 15:20:15 -0800 | [diff] [blame] | 2484 | if remote_url.endswith('.git'): |
| 2485 | remote_url = remote_url[:-len('.git')] |
erikchen | 0d14d0d | 2018-08-28 18:57:09 +0000 | [diff] [blame] | 2486 | remote_url = remote_url.rstrip('/') |
| 2487 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2488 | fetch_info = revision_info['fetch']['http'] |
erikchen | 0d14d0d | 2018-08-28 18:57:09 +0000 | [diff] [blame] | 2489 | fetch_info['url'] = fetch_info['url'].rstrip('/') |
Aaron Gable | 697a91b | 2018-01-19 15:20:15 -0800 | [diff] [blame] | 2490 | |
| 2491 | if remote_url != fetch_info['url']: |
| 2492 | DieWithError('Trying to patch a change from %s but this repo appears ' |
| 2493 | 'to be %s.' % (fetch_info['url'], remote_url)) |
| 2494 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2495 | RunGit(['fetch', fetch_info['url'], fetch_info['ref']]) |
Aaron Gable | 9387b4f | 2017-06-08 10:50:03 -0700 | [diff] [blame] | 2496 | |
Joanna Wang | c023a63 | 2023-01-26 17:59:25 +0000 | [diff] [blame] | 2497 | # Set issue immediately in case the cherry-pick fails, which happens |
| 2498 | # when resolving conflicts. |
| 2499 | if self.GetBranch(): |
Bruce Dawson | f362f6f | 2021-02-18 23:15:17 +0000 | [diff] [blame] | 2500 | self.SetIssue(parsed_issue_arg.issue) |
| 2501 | |
Aaron Gable | 62619a3 | 2017-06-16 08:22:09 -0700 | [diff] [blame] | 2502 | if force: |
| 2503 | RunGit(['reset', '--hard', 'FETCH_HEAD']) |
| 2504 | print('Checked out commit for change %i patchset %i locally' % |
| 2505 | (parsed_issue_arg.issue, patchset)) |
Stefan Zager | 2d5f039 | 2017-10-10 15:17:53 -0700 | [diff] [blame] | 2506 | elif nocommit: |
| 2507 | RunGit(['cherry-pick', '--no-commit', 'FETCH_HEAD']) |
| 2508 | print('Patch applied to index.') |
Aaron Gable | 62619a3 | 2017-06-16 08:22:09 -0700 | [diff] [blame] | 2509 | else: |
Aaron Gable | 9387b4f | 2017-06-08 10:50:03 -0700 | [diff] [blame] | 2510 | RunGit(['cherry-pick', 'FETCH_HEAD']) |
| 2511 | print('Committed patch for change %i patchset %i locally.' % |
Aaron Gable | 62619a3 | 2017-06-16 08:22:09 -0700 | [diff] [blame] | 2512 | (parsed_issue_arg.issue, patchset)) |
| 2513 | print('Note: this created a local commit which does not have ' |
| 2514 | 'the same hash as the one uploaded for review. This will make ' |
| 2515 | 'uploading changes based on top of this branch difficult.\n' |
| 2516 | 'If you want to do that, use "git cl patch --force" instead.') |
| 2517 | |
Stefan Zager | d08043c | 2017-10-12 12:07:02 -0700 | [diff] [blame] | 2518 | if self.GetBranch(): |
Stefan Zager | d08043c | 2017-10-12 12:07:02 -0700 | [diff] [blame] | 2519 | self.SetPatchset(patchset) |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 2520 | fetched_hash = scm.GIT.ResolveCommit(settings.GetRoot(), 'FETCH_HEAD') |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 2521 | self._GitSetBranchConfigValue(LAST_UPLOAD_HASH_CONFIG_KEY, fetched_hash) |
| 2522 | self._GitSetBranchConfigValue(GERRIT_SQUASH_HASH_CONFIG_KEY, fetched_hash) |
Stefan Zager | d08043c | 2017-10-12 12:07:02 -0700 | [diff] [blame] | 2523 | else: |
| 2524 | print('WARNING: You are in detached HEAD state.\n' |
| 2525 | 'The patch has been applied to your checkout, but you will not be ' |
| 2526 | 'able to upload a new patch set to the gerrit issue.\n' |
| 2527 | 'Try using the \'-b\' option if you would like to work on a ' |
| 2528 | 'branch and/or upload a new patch set.') |
| 2529 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 2530 | return 0 |
| 2531 | |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 2532 | @staticmethod |
| 2533 | def _GerritCommitMsgHookCheck(offer_removal): |
| 2534 | # type: (bool) -> None |
| 2535 | """Checks for the gerrit's commit-msg hook and removes it if necessary.""" |
tandrii | 16e0b4e | 2016-06-07 10:34:28 -0700 | [diff] [blame] | 2536 | hook = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg') |
| 2537 | if not os.path.exists(hook): |
| 2538 | return |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 2539 | # Crude attempt to distinguish Gerrit Codereview hook from a potentially |
| 2540 | # custom developer-made one. |
tandrii | 16e0b4e | 2016-06-07 10:34:28 -0700 | [diff] [blame] | 2541 | data = gclient_utils.FileRead(hook) |
| 2542 | if not('From Gerrit Code Review' in data and 'add_ChangeId()' in data): |
| 2543 | return |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2544 | print('WARNING: You have Gerrit commit-msg hook installed.\n' |
qyearsley | 12fa6ff | 2016-08-24 09:18:40 -0700 | [diff] [blame] | 2545 | 'It is not necessary for uploading with git cl in squash mode, ' |
tandrii | 16e0b4e | 2016-06-07 10:34:28 -0700 | [diff] [blame] | 2546 | 'and may interfere with it in subtle ways.\n' |
| 2547 | 'We recommend you remove the commit-msg hook.') |
| 2548 | if offer_removal: |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 2549 | if ask_for_explicit_yes('Do you want to remove it now?'): |
tandrii | 16e0b4e | 2016-06-07 10:34:28 -0700 | [diff] [blame] | 2550 | gclient_utils.rm_file_or_tree(hook) |
| 2551 | print('Gerrit commit-msg hook removed.') |
| 2552 | else: |
| 2553 | print('OK, will keep Gerrit commit-msg hook in place.') |
| 2554 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2555 | def _CleanUpOldTraces(self): |
| 2556 | """Keep only the last |MAX_TRACES| traces.""" |
| 2557 | try: |
| 2558 | traces = sorted([ |
| 2559 | os.path.join(TRACES_DIR, f) |
| 2560 | for f in os.listdir(TRACES_DIR) |
| 2561 | if (os.path.isfile(os.path.join(TRACES_DIR, f)) |
| 2562 | and not f.startswith('tmp')) |
| 2563 | ]) |
| 2564 | traces_to_delete = traces[:-MAX_TRACES] |
| 2565 | for trace in traces_to_delete: |
Daniel Cheng | cf6269b | 2019-05-18 01:02:12 +0000 | [diff] [blame] | 2566 | os.remove(trace) |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2567 | except OSError: |
| 2568 | print('WARNING: Failed to remove old git traces from\n' |
| 2569 | ' %s' |
| 2570 | 'Consider removing them manually.' % TRACES_DIR) |
Edward Lemur | dc8e23d | 2019-05-07 00:45:48 +0000 | [diff] [blame] | 2571 | |
Edward Lemur | 5737f02 | 2019-05-17 01:24:00 +0000 | [diff] [blame] | 2572 | def _WriteGitPushTraces(self, trace_name, traces_dir, git_push_metadata): |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2573 | """Zip and write the git push traces stored in traces_dir.""" |
| 2574 | gclient_utils.safe_makedirs(TRACES_DIR) |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2575 | traces_zip = trace_name + '-traces' |
| 2576 | traces_readme = trace_name + '-README' |
Michael Moss | e7f0b4c | 2019-05-08 04:36:24 +0000 | [diff] [blame] | 2577 | # Create a temporary dir to store git config and gitcookies in. It will be |
| 2578 | # compressed and stored next to the traces. |
| 2579 | git_info_dir = tempfile.mkdtemp() |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2580 | git_info_zip = trace_name + '-git-info' |
| 2581 | |
Josip Sokcevic | 5e18b60 | 2020-04-23 21:47:00 +0000 | [diff] [blame] | 2582 | git_push_metadata['now'] = datetime_now().strftime('%Y-%m-%dT%H:%M:%S.%f') |
sangwoo.ko | 7a61433 | 2019-05-22 02:46:19 +0000 | [diff] [blame] | 2583 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2584 | git_push_metadata['trace_name'] = trace_name |
| 2585 | gclient_utils.FileWrite( |
| 2586 | traces_readme, TRACES_README_FORMAT % git_push_metadata) |
| 2587 | |
| 2588 | # Keep only the first 6 characters of the git hashes on the packet |
| 2589 | # trace. This greatly decreases size after compression. |
| 2590 | packet_traces = os.path.join(traces_dir, 'trace-packet') |
| 2591 | if os.path.isfile(packet_traces): |
| 2592 | contents = gclient_utils.FileRead(packet_traces) |
| 2593 | gclient_utils.FileWrite( |
| 2594 | packet_traces, GIT_HASH_RE.sub(r'\1', contents)) |
| 2595 | shutil.make_archive(traces_zip, 'zip', traces_dir) |
| 2596 | |
| 2597 | # Collect and compress the git config and gitcookies. |
| 2598 | git_config = RunGit(['config', '-l']) |
| 2599 | gclient_utils.FileWrite( |
| 2600 | os.path.join(git_info_dir, 'git-config'), |
| 2601 | git_config) |
| 2602 | |
| 2603 | cookie_auth = gerrit_util.Authenticator.get() |
| 2604 | if isinstance(cookie_auth, gerrit_util.CookiesAuthenticator): |
| 2605 | gitcookies_path = cookie_auth.get_gitcookies_path() |
| 2606 | if os.path.isfile(gitcookies_path): |
| 2607 | gitcookies = gclient_utils.FileRead(gitcookies_path) |
| 2608 | gclient_utils.FileWrite( |
| 2609 | os.path.join(git_info_dir, 'gitcookies'), |
| 2610 | GITCOOKIES_REDACT_RE.sub('REDACTED', gitcookies)) |
| 2611 | shutil.make_archive(git_info_zip, 'zip', git_info_dir) |
| 2612 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2613 | gclient_utils.rmtree(git_info_dir) |
| 2614 | |
Josip Sokcevic | f2cfd3d | 2021-03-30 18:39:18 +0000 | [diff] [blame] | 2615 | def _RunGitPushWithTraces(self, |
| 2616 | refspec, |
| 2617 | refspec_opts, |
| 2618 | git_push_metadata, |
| 2619 | git_push_options=None): |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2620 | """Run git push and collect the traces resulting from the execution.""" |
| 2621 | # Create a temporary directory to store traces in. Traces will be compressed |
| 2622 | # and stored in a 'traces' dir inside depot_tools. |
| 2623 | traces_dir = tempfile.mkdtemp() |
Edward Lemur | 5737f02 | 2019-05-17 01:24:00 +0000 | [diff] [blame] | 2624 | trace_name = os.path.join( |
| 2625 | TRACES_DIR, datetime_now().strftime('%Y%m%dT%H%M%S.%f')) |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2626 | |
| 2627 | env = os.environ.copy() |
| 2628 | env['GIT_REDACT_COOKIES'] = 'o,SSO,GSSO_Uberproxy' |
| 2629 | env['GIT_TR2_EVENT'] = os.path.join(traces_dir, 'tr2-event') |
Jonathan Nieder | 9779b14 | 2019-05-29 23:19:29 +0000 | [diff] [blame] | 2630 | env['GIT_TRACE2_EVENT'] = os.path.join(traces_dir, 'tr2-event') |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2631 | env['GIT_TRACE_CURL'] = os.path.join(traces_dir, 'trace-curl') |
| 2632 | env['GIT_TRACE_CURL_NO_DATA'] = '1' |
| 2633 | env['GIT_TRACE_PACKET'] = os.path.join(traces_dir, 'trace-packet') |
| 2634 | |
| 2635 | try: |
| 2636 | push_returncode = 0 |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2637 | remote_url = self.GetRemoteUrl() |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2638 | before_push = time_time() |
Josip Sokcevic | f2cfd3d | 2021-03-30 18:39:18 +0000 | [diff] [blame] | 2639 | push_cmd = ['git', 'push', remote_url, refspec] |
| 2640 | if git_push_options: |
| 2641 | for opt in git_push_options: |
| 2642 | push_cmd.extend(['-o', opt]) |
| 2643 | |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2644 | push_stdout = gclient_utils.CheckCallAndFilter( |
Josip Sokcevic | f2cfd3d | 2021-03-30 18:39:18 +0000 | [diff] [blame] | 2645 | push_cmd, |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2646 | env=env, |
| 2647 | print_stdout=True, |
| 2648 | # Flush after every line: useful for seeing progress when running as |
| 2649 | # recipe. |
| 2650 | filter_fn=lambda _: sys.stdout.flush()) |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 2651 | push_stdout = push_stdout.decode('utf-8', 'replace') |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2652 | except subprocess2.CalledProcessError as e: |
| 2653 | push_returncode = e.returncode |
Aravind Vasudevan | c950858 | 2022-10-18 03:07:41 +0000 | [diff] [blame] | 2654 | if 'blocked keyword' in str(e.stdout) or 'banned word' in str(e.stdout): |
Josip Sokcevic | 740825e | 2021-05-12 18:28:34 +0000 | [diff] [blame] | 2655 | raise GitPushError( |
| 2656 | 'Failed to create a change, very likely due to blocked keyword. ' |
| 2657 | 'Please examine output above for the reason of the failure.\n' |
| 2658 | 'If this is a false positive, you can try to bypass blocked ' |
| 2659 | 'keyword by using push option ' |
| 2660 | '-o uploadvalidator~skip, e.g.:\n' |
| 2661 | 'git cl upload -o uploadvalidator~skip\n\n' |
| 2662 | 'If git-cl is not working correctly, file a bug under the ' |
| 2663 | 'Infra>SDK component.') |
Josip Sokcevic | 54e30e7 | 2022-02-10 22:32:24 +0000 | [diff] [blame] | 2664 | if 'git push -o nokeycheck' in str(e.stdout): |
| 2665 | raise GitPushError( |
| 2666 | 'Failed to create a change, very likely due to a private key being ' |
| 2667 | 'detected. Please examine output above for the reason of the ' |
| 2668 | 'failure.\n' |
| 2669 | 'If this is a false positive, you can try to bypass private key ' |
| 2670 | 'detection by using push option ' |
| 2671 | '-o nokeycheck, e.g.:\n' |
| 2672 | 'git cl upload -o nokeycheck\n\n' |
| 2673 | 'If git-cl is not working correctly, file a bug under the ' |
| 2674 | 'Infra>SDK component.') |
Josip Sokcevic | 740825e | 2021-05-12 18:28:34 +0000 | [diff] [blame] | 2675 | |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2676 | raise GitPushError( |
| 2677 | 'Failed to create a change. Please examine output above for the ' |
| 2678 | 'reason of the failure.\n' |
Josip Sokcevic | 7386a1e | 2021-02-12 19:00:34 +0000 | [diff] [blame] | 2679 | 'For emergencies, Googlers can escalate to ' |
| 2680 | 'go/gob-support or go/notify#gob\n' |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2681 | 'Hint: run command below to diagnose common Git/Gerrit ' |
| 2682 | 'credential problems:\n' |
| 2683 | ' git cl creds-check\n' |
| 2684 | '\n' |
| 2685 | 'If git-cl is not working correctly, file a bug under the Infra>SDK ' |
| 2686 | 'component including the files below.\n' |
| 2687 | 'Review the files before upload, since they might contain sensitive ' |
| 2688 | 'information.\n' |
| 2689 | 'Set the Restrict-View-Google label so that they are not publicly ' |
| 2690 | 'accessible.\n' + TRACES_MESSAGE % {'trace_name': trace_name}) |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2691 | finally: |
| 2692 | execution_time = time_time() - before_push |
| 2693 | metrics.collector.add_repeated('sub_commands', { |
| 2694 | 'command': 'git push', |
| 2695 | 'execution_time': execution_time, |
| 2696 | 'exit_code': push_returncode, |
Josip Sokcevic | d0ba91f | 2021-03-29 20:12:09 +0000 | [diff] [blame] | 2697 | 'arguments': metrics_utils.extract_known_subcommand_args(refspec_opts), |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2698 | }) |
| 2699 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2700 | git_push_metadata['execution_time'] = execution_time |
| 2701 | git_push_metadata['exit_code'] = push_returncode |
Edward Lemur | 5737f02 | 2019-05-17 01:24:00 +0000 | [diff] [blame] | 2702 | self._WriteGitPushTraces(trace_name, traces_dir, git_push_metadata) |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2703 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2704 | self._CleanUpOldTraces() |
Edward Lemur | 0f58ae4 | 2019-04-30 17:24:12 +0000 | [diff] [blame] | 2705 | gclient_utils.rmtree(traces_dir) |
| 2706 | |
| 2707 | return push_stdout |
| 2708 | |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2709 | def CMDUploadChange(self, options, git_diff_args, custom_cl_base, |
| 2710 | change_desc): |
| 2711 | """Upload the current branch to Gerrit, retry if new remote HEAD is |
| 2712 | found. options and change_desc may be mutated.""" |
Josip Sokcevic | b631a88 | 2021-01-06 18:18:10 +0000 | [diff] [blame] | 2713 | remote, remote_branch = self.GetRemoteBranch() |
| 2714 | branch = GetTargetRef(remote, remote_branch, options.target_branch) |
| 2715 | |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2716 | try: |
| 2717 | return self._CMDUploadChange(options, git_diff_args, custom_cl_base, |
Josip Sokcevic | b631a88 | 2021-01-06 18:18:10 +0000 | [diff] [blame] | 2718 | change_desc, branch) |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2719 | except GitPushError as e: |
Josip Sokcevic | b631a88 | 2021-01-06 18:18:10 +0000 | [diff] [blame] | 2720 | # Repository might be in the middle of transition to main branch as |
| 2721 | # default, and uploads to old default might be blocked. |
| 2722 | if remote_branch not in [DEFAULT_OLD_BRANCH, DEFAULT_NEW_BRANCH]: |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2723 | DieWithError(str(e), change_desc) |
| 2724 | |
Josip Sokcevic | b631a88 | 2021-01-06 18:18:10 +0000 | [diff] [blame] | 2725 | project_head = gerrit_util.GetProjectHead(self._gerrit_host, |
| 2726 | self.GetGerritProject()) |
| 2727 | if project_head == branch: |
| 2728 | DieWithError(str(e), change_desc) |
| 2729 | branch = project_head |
| 2730 | |
| 2731 | print("WARNING: Fetching remote state and retrying upload to default " |
| 2732 | "branch...") |
| 2733 | RunGit(['fetch', '--prune', remote]) |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2734 | options.edit_description = False |
| 2735 | options.force = True |
| 2736 | try: |
Josip Sokcevic | b631a88 | 2021-01-06 18:18:10 +0000 | [diff] [blame] | 2737 | self._CMDUploadChange(options, git_diff_args, custom_cl_base, |
| 2738 | change_desc, branch) |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2739 | except GitPushError as e: |
| 2740 | DieWithError(str(e), change_desc) |
| 2741 | |
| 2742 | def _CMDUploadChange(self, options, git_diff_args, custom_cl_base, |
Josip Sokcevic | b631a88 | 2021-01-06 18:18:10 +0000 | [diff] [blame] | 2743 | change_desc, branch): |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2744 | """Upload the current branch to Gerrit.""" |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2745 | if options.squash: |
Joanna Wang | c4ac302 | 2023-01-31 21:19:57 +0000 | [diff] [blame^] | 2746 | Changelist._GerritCommitMsgHookCheck(offer_removal=not options.force) |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2747 | external_parent = None |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2748 | if self.GetIssue(): |
Josip | e827b0f | 2020-01-30 00:07:20 +0000 | [diff] [blame] | 2749 | # User requested to change description |
| 2750 | if options.edit_description: |
Josip | e827b0f | 2020-01-30 00:07:20 +0000 | [diff] [blame] | 2751 | change_desc.prompt() |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2752 | change_detail = self._GetChangeDetail(['CURRENT_REVISION']) |
| 2753 | change_id = change_detail['change_id'] |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 2754 | change_desc.ensure_change_id(change_id) |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2755 | |
| 2756 | # Check if changes outside of this workspace have been uploaded. |
| 2757 | current_rev = change_detail['current_revision'] |
| 2758 | last_uploaded_rev = self._GitGetBranchConfigValue( |
| 2759 | GERRIT_SQUASH_HASH_CONFIG_KEY) |
| 2760 | if last_uploaded_rev and current_rev != last_uploaded_rev: |
| 2761 | external_parent = self._UpdateWithExternalChanges() |
Aaron Gable | b56ad33 | 2017-01-06 15:24:31 -0800 | [diff] [blame] | 2762 | else: # if not self.GetIssue() |
Gavin Mak | 68e6cf3 | 2021-01-25 18:24:08 +0000 | [diff] [blame] | 2763 | if not options.force and not options.message_file: |
Anthony Polito | 8b95534 | 2019-09-24 19:01:36 +0000 | [diff] [blame] | 2764 | change_desc.prompt() |
Andrii Shyshkalov | 8c90d03 | 2017-04-19 21:27:26 +0200 | [diff] [blame] | 2765 | change_ids = git_footers.get_footer_change_id(change_desc.description) |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 2766 | if len(change_ids) == 1: |
| 2767 | change_id = change_ids[0] |
| 2768 | else: |
| 2769 | change_id = GenerateGerritChangeId(change_desc.description) |
| 2770 | change_desc.ensure_change_id(change_id) |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2771 | |
Andrii Shyshkalov | 71f0da3 | 2019-07-15 22:45:18 +0000 | [diff] [blame] | 2772 | if options.preserve_tryjobs: |
| 2773 | change_desc.set_preserve_tryjobs() |
Robert Iannucci | db02dd0 | 2017-04-19 12:18:20 -0700 | [diff] [blame] | 2774 | |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2775 | remote, upstream_branch = self.FetchUpstreamTuple(self.GetBranch()) |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2776 | parent = external_parent or self._ComputeParent( |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 2777 | remote, upstream_branch, custom_cl_base, options.force, change_desc) |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2778 | tree = RunGit(['rev-parse', 'HEAD:']).strip() |
Edward Lemur | 1773f37 | 2020-02-22 00:27:14 +0000 | [diff] [blame] | 2779 | with gclient_utils.temporary_file() as desc_tempfile: |
| 2780 | gclient_utils.FileWrite(desc_tempfile, change_desc.description) |
| 2781 | ref_to_push = RunGit( |
| 2782 | ['commit-tree', tree, '-p', parent, '-F', desc_tempfile]).strip() |
Anthony Polito | 8b95534 | 2019-09-24 19:01:36 +0000 | [diff] [blame] | 2783 | else: # if not options.squash |
Gregory Nisbet | 48d9e1e | 2021-04-15 23:35:54 +0000 | [diff] [blame] | 2784 | if options.no_add_changeid: |
| 2785 | pass |
| 2786 | else: # adding Change-Ids is okay. |
| 2787 | if not git_footers.get_footer_change_id(change_desc.description): |
| 2788 | DownloadGerritHook(False) |
| 2789 | change_desc.set_description( |
| 2790 | self._AddChangeIdToCommitMessage(change_desc.description, |
| 2791 | git_diff_args)) |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2792 | ref_to_push = 'HEAD' |
Andrii Shyshkalov | 550e924 | 2017-04-12 17:14:49 +0200 | [diff] [blame] | 2793 | # For no-squash mode, we assume the remote called "origin" is the one we |
| 2794 | # want. It is not worthwhile to support different workflows for |
| 2795 | # no-squash mode. |
| 2796 | parent = 'origin/%s' % branch |
Gregory Nisbet | 48d9e1e | 2021-04-15 23:35:54 +0000 | [diff] [blame] | 2797 | # attempt to extract the changeid from the current description |
| 2798 | # fail informatively if not possible. |
| 2799 | change_id_candidates = git_footers.get_footer_change_id( |
| 2800 | change_desc.description) |
| 2801 | if not change_id_candidates: |
| 2802 | DieWithError("Unable to extract change-id from message.") |
| 2803 | change_id = change_id_candidates[0] |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2804 | |
Andrii Shyshkalov | d9fdc1f | 2018-09-27 02:13:09 +0000 | [diff] [blame] | 2805 | SaveDescriptionBackup(change_desc) |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2806 | commits = RunGitSilent(['rev-list', '%s..%s' % (parent, |
| 2807 | ref_to_push)]).splitlines() |
| 2808 | if len(commits) > 1: |
| 2809 | print('WARNING: This will upload %d commits. Run the following command ' |
| 2810 | 'to see which commits will be uploaded: ' % len(commits)) |
| 2811 | print('git log %s..%s' % (parent, ref_to_push)) |
| 2812 | print('You can also use `git squash-branch` to squash these into a ' |
| 2813 | 'single commit.') |
Andrii Shyshkalov | abc26ac | 2017-03-14 14:49:38 +0100 | [diff] [blame] | 2814 | confirm_or_exit(action='upload') |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2815 | |
Andrii Shyshkalov | 76988a8 | 2018-10-15 03:12:25 +0000 | [diff] [blame] | 2816 | reviewers = sorted(change_desc.get_reviewers()) |
Edward Lemur | 4508b42 | 2019-10-03 21:56:35 +0000 | [diff] [blame] | 2817 | cc = [] |
Joanna Wang | c4ac302 | 2023-01-31 21:19:57 +0000 | [diff] [blame^] | 2818 | # Add default, watchlist, presubmit ccs if this is the initial upload |
| 2819 | # and CL is not private and auto-ccing has not been disabled. |
| 2820 | if not options.private and not options.no_autocc and not self.GetIssue(): |
Andrii Shyshkalov | 76988a8 | 2018-10-15 03:12:25 +0000 | [diff] [blame] | 2821 | cc = self.GetCCList().split(',') |
Gavin Mak | b1c08f6 | 2021-04-01 18:05:58 +0000 | [diff] [blame] | 2822 | if len(cc) > 100: |
| 2823 | lsc = ('https://chromium.googlesource.com/chromium/src/+/HEAD/docs/' |
| 2824 | 'process/lsc/lsc_workflow.md') |
| 2825 | print('WARNING: This will auto-CC %s users.' % len(cc)) |
| 2826 | print('LSC may be more appropriate: %s' % lsc) |
| 2827 | print('You can also use the --no-autocc flag to disable auto-CC.') |
| 2828 | confirm_or_exit(action='continue') |
Edward Lemur | 4508b42 | 2019-10-03 21:56:35 +0000 | [diff] [blame] | 2829 | # Add cc's from the --cc flag. |
Andrii Shyshkalov | 76988a8 | 2018-10-15 03:12:25 +0000 | [diff] [blame] | 2830 | if options.cc: |
| 2831 | cc.extend(options.cc) |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 2832 | cc = [email.strip() for email in cc if email.strip()] |
Andrii Shyshkalov | 76988a8 | 2018-10-15 03:12:25 +0000 | [diff] [blame] | 2833 | if change_desc.get_cced(): |
| 2834 | cc.extend(change_desc.get_cced()) |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2835 | if self.GetGerritHost() == 'chromium-review.googlesource.com': |
Andrii Shyshkalov | 0da5e8f | 2018-10-30 17:29:18 +0000 | [diff] [blame] | 2836 | valid_accounts = set(reviewers + cc) |
| 2837 | # TODO(crbug/877717): relax this for all hosts. |
| 2838 | else: |
| 2839 | valid_accounts = gerrit_util.ValidAccounts( |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2840 | self.GetGerritHost(), reviewers + cc) |
Andrii Shyshkalov | f170af4 | 2018-10-30 07:00:44 +0000 | [diff] [blame] | 2841 | logging.info('accounts %s are recognized, %s invalid', |
| 2842 | sorted(valid_accounts), |
| 2843 | set(reviewers + cc).difference(set(valid_accounts))) |
Andrii Shyshkalov | 76988a8 | 2018-10-15 03:12:25 +0000 | [diff] [blame] | 2844 | |
tandrii@chromium.org | bf766ba | 2016-04-13 12:51:23 +0000 | [diff] [blame] | 2845 | # Extra options that can be specified at push time. Doc: |
| 2846 | # https://gerrit-review.googlesource.com/Documentation/user-upload.html |
Joanna Wang | a1abbed | 2023-01-24 01:41:05 +0000 | [diff] [blame] | 2847 | refspec_opts = self._GetRefSpecOptions(options, change_desc) |
agable | c678797 | 2016-09-09 16:13:34 -0700 | [diff] [blame] | 2848 | |
Andrii Shyshkalov | 2f72791 | 2018-10-15 17:02:33 +0000 | [diff] [blame] | 2849 | for r in sorted(reviewers): |
| 2850 | if r in valid_accounts: |
Josip Sokcevic | d0ba91f | 2021-03-29 20:12:09 +0000 | [diff] [blame] | 2851 | refspec_opts.append('r=%s' % r) |
Andrii Shyshkalov | 2f72791 | 2018-10-15 17:02:33 +0000 | [diff] [blame] | 2852 | reviewers.remove(r) |
| 2853 | else: |
| 2854 | # TODO(tandrii): this should probably be a hard failure. |
| 2855 | print('WARNING: reviewer %s doesn\'t have a Gerrit account, skipping' |
| 2856 | % r) |
| 2857 | for c in sorted(cc): |
| 2858 | # refspec option will be rejected if cc doesn't correspond to an |
| 2859 | # account, even though REST call to add such arbitrary cc may succeed. |
| 2860 | if c in valid_accounts: |
Josip Sokcevic | d0ba91f | 2021-03-29 20:12:09 +0000 | [diff] [blame] | 2861 | refspec_opts.append('cc=%s' % c) |
Andrii Shyshkalov | 2f72791 | 2018-10-15 17:02:33 +0000 | [diff] [blame] | 2862 | cc.remove(c) |
| 2863 | |
Josip Sokcevic | d0ba91f | 2021-03-29 20:12:09 +0000 | [diff] [blame] | 2864 | refspec_suffix = '' |
| 2865 | if refspec_opts: |
| 2866 | refspec_suffix = '%' + ','.join(refspec_opts) |
| 2867 | assert ' ' not in refspec_suffix, ( |
| 2868 | 'spaces not allowed in refspec: "%s"' % refspec_suffix) |
| 2869 | refspec = '%s:refs/for/%s%s' % (ref_to_push, branch, refspec_suffix) |
Andrii Shyshkalov | febbae9 | 2017-04-05 15:05:20 +0000 | [diff] [blame] | 2870 | |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2871 | git_push_metadata = { |
Edward Lesmes | eeca9c6 | 2020-11-20 00:00:17 +0000 | [diff] [blame] | 2872 | 'gerrit_host': self.GetGerritHost(), |
Josip Sokcevic | f736cab | 2020-10-20 23:41:38 +0000 | [diff] [blame] | 2873 | 'title': options.title or '<untitled>', |
Edward Lemur | 1b52d87 | 2019-05-09 21:12:12 +0000 | [diff] [blame] | 2874 | 'change_id': change_id, |
| 2875 | 'description': change_desc.description, |
| 2876 | } |
Josip Sokcevic | f2cfd3d | 2021-03-30 18:39:18 +0000 | [diff] [blame] | 2877 | |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2878 | # Gerrit may or may not update fast enough to return the correct patchset |
| 2879 | # number after we push. Get the pre-upload patchset and increment later. |
| 2880 | latest_ps = self.GetMostRecentPatchset(update=False) or 0 |
| 2881 | |
Josip Sokcevic | d0ba91f | 2021-03-29 20:12:09 +0000 | [diff] [blame] | 2882 | push_stdout = self._RunGitPushWithTraces(refspec, refspec_opts, |
Josip Sokcevic | f2cfd3d | 2021-03-30 18:39:18 +0000 | [diff] [blame] | 2883 | git_push_metadata, |
| 2884 | options.push_options) |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2885 | |
| 2886 | if options.squash: |
Aaron Gable | 289b431 | 2017-09-13 14:06:16 -0700 | [diff] [blame] | 2887 | regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*') |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2888 | change_numbers = [m.group(1) |
| 2889 | for m in map(regex.match, push_stdout.splitlines()) |
| 2890 | if m] |
| 2891 | if len(change_numbers) != 1: |
| 2892 | DieWithError( |
| 2893 | ('Created|Updated %d issues on Gerrit, but only 1 expected.\n' |
Christopher Lam | f732cd5 | 2017-01-24 12:40:11 +1100 | [diff] [blame] | 2894 | 'Change-Id: %s') % (len(change_numbers), change_id), change_desc) |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2895 | self.SetIssue(change_numbers[0]) |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2896 | self.SetPatchset(latest_ps + 1) |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 2897 | self._GitSetBranchConfigValue(GERRIT_SQUASH_HASH_CONFIG_KEY, ref_to_push) |
tandrii | 8818977 | 2016-09-29 04:29:57 -0700 | [diff] [blame] | 2898 | |
Andrii Shyshkalov | 2f72791 | 2018-10-15 17:02:33 +0000 | [diff] [blame] | 2899 | if self.GetIssue() and (reviewers or cc): |
Andrii Shyshkalov | 0ec9d15 | 2018-08-23 00:22:58 +0000 | [diff] [blame] | 2900 | # GetIssue() is not set in case of non-squash uploads according to tests. |
Aaron Gable | 6e7ddb6 | 2020-05-27 22:23:29 +0000 | [diff] [blame] | 2901 | # TODO(crbug.com/751901): non-squash uploads in git cl should be removed. |
Thiago Perrotta | b0fb8d5 | 2022-08-30 21:26:19 +0000 | [diff] [blame] | 2902 | gerrit_util.AddReviewers(self.GetGerritHost(), |
| 2903 | self._GerritChangeIdentifier(), |
| 2904 | reviewers, |
| 2905 | cc, |
| 2906 | notify=bool(options.send_mail)) |
Aaron Gable | 6dadfbf | 2017-05-09 14:27:58 -0700 | [diff] [blame] | 2907 | |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 2908 | return 0 |
| 2909 | |
Andrii Shyshkalov | 550e924 | 2017-04-12 17:14:49 +0200 | [diff] [blame] | 2910 | def _ComputeParent(self, remote, upstream_branch, custom_cl_base, force, |
| 2911 | change_desc): |
| 2912 | """Computes parent of the generated commit to be uploaded to Gerrit. |
| 2913 | |
| 2914 | Returns revision or a ref name. |
| 2915 | """ |
| 2916 | if custom_cl_base: |
| 2917 | # Try to avoid creating additional unintended CLs when uploading, unless |
| 2918 | # user wants to take this risk. |
| 2919 | local_ref_of_target_remote = self.GetRemoteBranch()[1] |
| 2920 | code, _ = RunGitWithCode(['merge-base', '--is-ancestor', custom_cl_base, |
| 2921 | local_ref_of_target_remote]) |
| 2922 | if code == 1: |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 2923 | print('\nWARNING: Manually specified base of this CL `%s` ' |
Andrii Shyshkalov | 550e924 | 2017-04-12 17:14:49 +0200 | [diff] [blame] | 2924 | 'doesn\'t seem to belong to target remote branch `%s`.\n\n' |
| 2925 | 'If you proceed with upload, more than 1 CL may be created by ' |
| 2926 | 'Gerrit as a result, in turn confusing or crashing git cl.\n\n' |
| 2927 | 'If you are certain that specified base `%s` has already been ' |
| 2928 | 'uploaded to Gerrit as another CL, you may proceed.\n' % |
| 2929 | (custom_cl_base, local_ref_of_target_remote, custom_cl_base)) |
| 2930 | if not force: |
| 2931 | confirm_or_exit( |
| 2932 | 'Do you take responsibility for cleaning up potential mess ' |
| 2933 | 'resulting from proceeding with upload?', |
| 2934 | action='upload') |
| 2935 | return custom_cl_base |
| 2936 | |
Aaron Gable | f97e33d | 2017-03-30 15:44:27 -0700 | [diff] [blame] | 2937 | if remote != '.': |
| 2938 | return self.GetCommonAncestorWithUpstream() |
| 2939 | |
| 2940 | # If our upstream branch is local, we base our squashed commit on its |
| 2941 | # squashed version. |
| 2942 | upstream_branch_name = scm.GIT.ShortBranchName(upstream_branch) |
| 2943 | |
Aaron Gable | f97e33d | 2017-03-30 15:44:27 -0700 | [diff] [blame] | 2944 | if upstream_branch_name == 'master': |
Aaron Gable | 0bbd1c2 | 2017-05-08 14:37:08 -0700 | [diff] [blame] | 2945 | return self.GetCommonAncestorWithUpstream() |
Glen Robertson | 7d98e22 | 2020-08-27 17:53:11 +0000 | [diff] [blame] | 2946 | if upstream_branch_name == 'main': |
| 2947 | return self.GetCommonAncestorWithUpstream() |
Aaron Gable | f97e33d | 2017-03-30 15:44:27 -0700 | [diff] [blame] | 2948 | |
| 2949 | # Check the squashed hash of the parent. |
Andrii Shyshkalov | 550e924 | 2017-04-12 17:14:49 +0200 | [diff] [blame] | 2950 | # TODO(tandrii): consider checking parent change in Gerrit and using its |
| 2951 | # hash if tree hash of latest parent revision (patchset) in Gerrit matches |
| 2952 | # the tree hash of the parent branch. The upside is less likely bogus |
| 2953 | # requests to reupload parent change just because it's uploadhash is |
| 2954 | # missing, yet the downside likely exists, too (albeit unknown to me yet). |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 2955 | parent = scm.GIT.GetBranchConfig(settings.GetRoot(), upstream_branch_name, |
| 2956 | GERRIT_SQUASH_HASH_CONFIG_KEY) |
Aaron Gable | f97e33d | 2017-03-30 15:44:27 -0700 | [diff] [blame] | 2957 | # Verify that the upstream branch has been uploaded too, otherwise |
| 2958 | # Gerrit will create additional CLs when uploading. |
| 2959 | if not parent or (RunGitSilent(['rev-parse', upstream_branch + ':']) != |
| 2960 | RunGitSilent(['rev-parse', parent + ':'])): |
| 2961 | DieWithError( |
| 2962 | '\nUpload upstream branch %s first.\n' |
| 2963 | 'It is likely that this branch has been rebased since its last ' |
| 2964 | 'upload, so you just need to upload it again.\n' |
| 2965 | '(If you uploaded it with --no-squash, then branch dependencies ' |
| 2966 | 'are not supported, and you should reupload with --squash.)' |
| 2967 | % upstream_branch_name, |
| 2968 | change_desc) |
| 2969 | return parent |
| 2970 | |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2971 | def _UpdateWithExternalChanges(self): |
| 2972 | """Updates workspace with external changes. |
| 2973 | |
| 2974 | Returns the commit hash that should be used as the merge base on upload. |
| 2975 | """ |
| 2976 | local_ps = self.GetPatchset() |
| 2977 | if local_ps is None: |
| 2978 | return |
| 2979 | |
| 2980 | external_ps = self.GetMostRecentPatchset(update=False) |
Gavin Mak | f35a9eb | 2022-11-17 18:34:36 +0000 | [diff] [blame] | 2981 | if external_ps is None or local_ps == external_ps or \ |
| 2982 | not self._IsPatchsetRangeSignificant(local_ps + 1, external_ps): |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 2983 | return |
| 2984 | |
| 2985 | num_changes = external_ps - local_ps |
Gavin Mak | 6f90547 | 2023-01-06 21:01:36 +0000 | [diff] [blame] | 2986 | if num_changes > 1: |
| 2987 | change_words = 'changes were' |
| 2988 | else: |
| 2989 | change_words = 'change was' |
| 2990 | print('\n%d external %s published to %s:\n' % |
| 2991 | (num_changes, change_words, self.GetIssueURL(short=True))) |
| 2992 | |
| 2993 | # Print an overview of external changes. |
| 2994 | ps_to_commit = {} |
| 2995 | ps_to_info = {} |
| 2996 | revisions = self._GetChangeDetail(['ALL_REVISIONS']) |
| 2997 | for commit_id, revision_info in revisions.get('revisions', {}).items(): |
| 2998 | ps_num = revision_info['_number'] |
| 2999 | ps_to_commit[ps_num] = commit_id |
| 3000 | ps_to_info[ps_num] = revision_info |
| 3001 | |
| 3002 | for ps in range(external_ps, local_ps, -1): |
| 3003 | commit = ps_to_commit[ps][:8] |
| 3004 | desc = ps_to_info[ps].get('description', '') |
| 3005 | print('Patchset %d [%s] %s' % (ps, commit, desc)) |
| 3006 | |
| 3007 | if not ask_for_explicit_yes('\nUploading as-is will override them. ' |
| 3008 | 'Get the latest changes and apply?'): |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 3009 | return |
| 3010 | |
| 3011 | # Get latest Gerrit merge base. Use the first parent even if multiple exist. |
| 3012 | external_parent = self._GetChangeCommit(revision=external_ps)['parents'][0] |
| 3013 | external_base = external_parent['commit'] |
| 3014 | |
| 3015 | branch = git_common.current_branch() |
| 3016 | local_base = self.GetCommonAncestorWithUpstream() |
| 3017 | if local_base != external_base: |
| 3018 | print('\nLocal merge base %s is different from Gerrit %s.\n' % |
| 3019 | (local_base, external_base)) |
| 3020 | if git_common.upstream(branch): |
| 3021 | DieWithError('Upstream branch set. Consider using `git rebase-update` ' |
| 3022 | 'to make these the same.') |
| 3023 | print('No upstream branch set. Consider setting it and using ' |
| 3024 | '`git rebase-update`.\nContinuing upload with Gerrit merge base.') |
| 3025 | |
| 3026 | # Fetch Gerrit's CL base if it doesn't exist locally. |
| 3027 | remote, _ = self.GetRemoteBranch() |
| 3028 | if not scm.GIT.IsValidRevision(settings.GetRoot(), external_base): |
| 3029 | RunGitSilent(['fetch', remote, external_base]) |
| 3030 | |
| 3031 | # Get the diff between local_ps and external_ps. |
| 3032 | issue = self.GetIssue() |
Gavin Mak | 591ebaf | 2022-12-06 18:05:07 +0000 | [diff] [blame] | 3033 | changes_ref = 'refs/changes/%02d/%d/' % (issue % 100, issue) |
Gavin Mak | 4e5e399 | 2022-11-14 22:40:12 +0000 | [diff] [blame] | 3034 | RunGitSilent(['fetch', remote, changes_ref + str(local_ps)]) |
| 3035 | last_uploaded = RunGitSilent(['rev-parse', 'FETCH_HEAD']).strip() |
| 3036 | RunGitSilent(['fetch', remote, changes_ref + str(external_ps)]) |
| 3037 | latest_external = RunGitSilent(['rev-parse', 'FETCH_HEAD']).strip() |
| 3038 | diff = RunGitSilent(['diff', '%s..%s' % (last_uploaded, latest_external)]) |
| 3039 | |
| 3040 | # Diff can be empty in the case of trivial rebases. |
| 3041 | if not diff: |
| 3042 | return external_base |
| 3043 | |
| 3044 | # Apply the diff. |
| 3045 | with gclient_utils.temporary_file() as diff_tempfile: |
| 3046 | gclient_utils.FileWrite(diff_tempfile, diff) |
| 3047 | clean_patch = RunGitWithCode(['apply', '--check', diff_tempfile])[0] == 0 |
| 3048 | RunGitSilent(['apply', '-3', '--intent-to-add', diff_tempfile]) |
| 3049 | if not clean_patch: |
| 3050 | # Normally patchset is set after upload. But because we exit, that never |
| 3051 | # happens. Updating here makes sure that subsequent uploads don't need |
| 3052 | # to fetch/apply the same diff again. |
| 3053 | self.SetPatchset(external_ps) |
| 3054 | DieWithError('\nPatch did not apply cleanly. Please resolve any ' |
| 3055 | 'conflicts and reupload.') |
| 3056 | |
| 3057 | message = 'Incorporate external changes from ' |
| 3058 | if num_changes == 1: |
| 3059 | message += 'patchset %d' % external_ps |
| 3060 | else: |
| 3061 | message += 'patchsets %d to %d' % (local_ps + 1, external_ps) |
| 3062 | RunGitSilent(['commit', '-am', message]) |
| 3063 | # TODO(crbug.com/1382528): Use the previous commit's message as a default |
| 3064 | # patchset title instead of this 'Incorporate' message. |
| 3065 | return external_base |
| 3066 | |
Edward Lemur | a12175c | 2020-03-09 16:58:26 +0000 | [diff] [blame] | 3067 | def _AddChangeIdToCommitMessage(self, log_desc, args): |
tandrii@chromium.org | 8930b3d | 2016-04-13 14:47:02 +0000 | [diff] [blame] | 3068 | """Re-commits using the current message, assumes the commit hook is in |
| 3069 | place. |
| 3070 | """ |
Edward Lemur | a12175c | 2020-03-09 16:58:26 +0000 | [diff] [blame] | 3071 | RunGit(['commit', '--amend', '-m', log_desc]) |
Andrii Shyshkalov | b07575f | 2018-10-16 06:16:21 +0000 | [diff] [blame] | 3072 | new_log_desc = _create_description_from_log(args) |
tandrii@chromium.org | 8930b3d | 2016-04-13 14:47:02 +0000 | [diff] [blame] | 3073 | if git_footers.get_footer_change_id(new_log_desc): |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3074 | print('git-cl: Added Change-Id to commit message.') |
tandrii@chromium.org | 8930b3d | 2016-04-13 14:47:02 +0000 | [diff] [blame] | 3075 | return new_log_desc |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 3076 | |
| 3077 | DieWithError('ERROR: Gerrit commit-msg hook not installed.') |
tandrii@chromium.org | aa6235b | 2016-04-11 21:35:29 +0000 | [diff] [blame] | 3078 | |
tandrii | e113dfd | 2016-10-11 10:20:12 -0700 | [diff] [blame] | 3079 | def CannotTriggerTryJobReason(self): |
tandrii | 8c5a353 | 2016-11-04 07:52:02 -0700 | [diff] [blame] | 3080 | try: |
| 3081 | data = self._GetChangeDetail() |
Aaron Gable | a45ee11 | 2016-11-22 15:14:38 -0800 | [diff] [blame] | 3082 | except GerritChangeNotExists: |
| 3083 | return 'Gerrit doesn\'t know about your change %s' % self.GetIssue() |
tandrii | 8c5a353 | 2016-11-04 07:52:02 -0700 | [diff] [blame] | 3084 | |
| 3085 | if data['status'] in ('ABANDONED', 'MERGED'): |
| 3086 | return 'CL %s is closed' % self.GetIssue() |
| 3087 | |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 3088 | def GetGerritChange(self, patchset=None): |
| 3089 | """Returns a buildbucket.v2.GerritChange message for the current issue.""" |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 3090 | host = urllib.parse.urlparse(self.GetCodereviewServer()).hostname |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 3091 | issue = self.GetIssue() |
Edward Lemur | 2c210a4 | 2019-09-16 23:58:35 +0000 | [diff] [blame] | 3092 | patchset = int(patchset or self.GetPatchset()) |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 3093 | data = self._GetChangeDetail(['ALL_REVISIONS']) |
| 3094 | |
| 3095 | assert host and issue and patchset, 'CL must be uploaded first' |
| 3096 | |
| 3097 | has_patchset = any( |
| 3098 | int(revision_data['_number']) == patchset |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 3099 | for revision_data in data['revisions'].values()) |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 3100 | if not has_patchset: |
Aaron Gable | a45ee11 | 2016-11-22 15:14:38 -0800 | [diff] [blame] | 3101 | raise Exception('Patchset %d is not known in Gerrit change %d' % |
tandrii | 8c5a353 | 2016-11-04 07:52:02 -0700 | [diff] [blame] | 3102 | (patchset, self.GetIssue())) |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 3103 | |
tandrii | 8c5a353 | 2016-11-04 07:52:02 -0700 | [diff] [blame] | 3104 | return { |
Edward Lemur | d4d1ba4 | 2019-09-20 21:46:37 +0000 | [diff] [blame] | 3105 | 'host': host, |
| 3106 | 'change': issue, |
| 3107 | 'project': data['project'], |
| 3108 | 'patchset': patchset, |
tandrii | 8c5a353 | 2016-11-04 07:52:02 -0700 | [diff] [blame] | 3109 | } |
tandrii | e113dfd | 2016-10-11 10:20:12 -0700 | [diff] [blame] | 3110 | |
tandrii | de281ae | 2016-10-12 06:02:30 -0700 | [diff] [blame] | 3111 | def GetIssueOwner(self): |
tandrii | 8c5a353 | 2016-11-04 07:52:02 -0700 | [diff] [blame] | 3112 | return self._GetChangeDetail(['DETAILED_ACCOUNTS'])['owner']['email'] |
tandrii | de281ae | 2016-10-12 06:02:30 -0700 | [diff] [blame] | 3113 | |
Edward Lemur | 707d70b | 2018-02-07 00:50:14 +0100 | [diff] [blame] | 3114 | def GetReviewers(self): |
| 3115 | details = self._GetChangeDetail(['DETAILED_ACCOUNTS']) |
Mohamed Heikal | 171c074 | 2018-11-09 20:38:51 +0000 | [diff] [blame] | 3116 | return [r['email'] for r in details['reviewers'].get('REVIEWER', [])] |
Edward Lemur | 707d70b | 2018-02-07 00:50:14 +0100 | [diff] [blame] | 3117 | |
tandrii@chromium.org | d68b62b | 2016-03-31 16:09:29 +0000 | [diff] [blame] | 3118 | |
Lei Zhang | 8a0efc1 | 2020-08-05 19:58:45 +0000 | [diff] [blame] | 3119 | def _get_bug_line_values(default_project_prefix, bugs): |
| 3120 | """Given default_project_prefix and comma separated list of bugs, yields bug |
| 3121 | line values. |
tandrii | f9aefb7 | 2016-07-01 09:06:51 -0700 | [diff] [blame] | 3122 | |
| 3123 | Each bug can be either: |
Lei Zhang | 8a0efc1 | 2020-08-05 19:58:45 +0000 | [diff] [blame] | 3124 | * a number, which is combined with default_project_prefix |
tandrii | f9aefb7 | 2016-07-01 09:06:51 -0700 | [diff] [blame] | 3125 | * string, which is left as is. |
| 3126 | |
| 3127 | This function may produce more than one line, because bugdroid expects one |
| 3128 | project per line. |
| 3129 | |
Lei Zhang | 8a0efc1 | 2020-08-05 19:58:45 +0000 | [diff] [blame] | 3130 | >>> list(_get_bug_line_values('v8:', '123,chromium:789')) |
tandrii | f9aefb7 | 2016-07-01 09:06:51 -0700 | [diff] [blame] | 3131 | ['v8:123', 'chromium:789'] |
| 3132 | """ |
| 3133 | default_bugs = [] |
| 3134 | others = [] |
| 3135 | for bug in bugs.split(','): |
| 3136 | bug = bug.strip() |
| 3137 | if bug: |
| 3138 | try: |
| 3139 | default_bugs.append(int(bug)) |
| 3140 | except ValueError: |
| 3141 | others.append(bug) |
| 3142 | |
| 3143 | if default_bugs: |
| 3144 | default_bugs = ','.join(map(str, default_bugs)) |
Lei Zhang | 8a0efc1 | 2020-08-05 19:58:45 +0000 | [diff] [blame] | 3145 | if default_project_prefix: |
| 3146 | if not default_project_prefix.endswith(':'): |
| 3147 | default_project_prefix += ':' |
| 3148 | yield '%s%s' % (default_project_prefix, default_bugs) |
tandrii | f9aefb7 | 2016-07-01 09:06:51 -0700 | [diff] [blame] | 3149 | else: |
| 3150 | yield default_bugs |
| 3151 | for other in sorted(others): |
| 3152 | # Don't bother finding common prefixes, CLs with >2 bugs are very very rare. |
| 3153 | yield other |
| 3154 | |
| 3155 | |
dpranke@chromium.org | 20254fc | 2011-03-22 18:28:59 +0000 | [diff] [blame] | 3156 | class ChangeDescription(object): |
| 3157 | """Contains a parsed form of the change description.""" |
maruel@chromium.org | c6f60e8 | 2013-04-19 17:01:57 +0000 | [diff] [blame] | 3158 | R_LINE = r'^[ \t]*(TBR|R)[ \t]*=[ \t]*(.*?)[ \t]*$' |
bradnelson | d975b30 | 2016-10-23 12:20:23 -0700 | [diff] [blame] | 3159 | CC_LINE = r'^[ \t]*(CC)[ \t]*=[ \t]*(.*?)[ \t]*$' |
Aaron Gable | 3a16ed1 | 2017-03-23 10:51:55 -0700 | [diff] [blame] | 3160 | BUG_LINE = r'^[ \t]*(?:(BUG)[ \t]*=|Bug:)[ \t]*(.*?)[ \t]*$' |
Dan Beam | d8b04ca | 2019-10-10 21:23:26 +0000 | [diff] [blame] | 3161 | FIXED_LINE = r'^[ \t]*Fixed[ \t]*:[ \t]*(.*?)[ \t]*$' |
Andrii Shyshkalov | 15e50cc | 2016-12-02 14:34:08 +0100 | [diff] [blame] | 3162 | CHERRY_PICK_LINE = r'^\(cherry picked from commit [a-fA-F0-9]{40}\)$' |
Nodir Turakulov | 23b8214 | 2017-11-16 11:04:25 -0800 | [diff] [blame] | 3163 | STRIP_HASH_TAG_PREFIX = r'^(\s*(revert|reland)( "|:)?\s*)*' |
| 3164 | BRACKET_HASH_TAG = r'\s*\[([^\[\]]+)\]' |
Anthony Polito | 02b5af3 | 2019-12-02 19:49:47 +0000 | [diff] [blame] | 3165 | COLON_SEPARATED_HASH_TAG = r'^([a-zA-Z0-9_\- ]+):($|[^:])' |
Nodir Turakulov | 23b8214 | 2017-11-16 11:04:25 -0800 | [diff] [blame] | 3166 | BAD_HASH_TAG_CHUNK = r'[^a-zA-Z0-9]+' |
dpranke@chromium.org | 20254fc | 2011-03-22 18:28:59 +0000 | [diff] [blame] | 3167 | |
Dan Beam | d8b04ca | 2019-10-10 21:23:26 +0000 | [diff] [blame] | 3168 | def __init__(self, description, bug=None, fixed=None): |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3169 | self._description_lines = (description or '').strip().splitlines() |
Anthony Polito | 8b95534 | 2019-09-24 19:01:36 +0000 | [diff] [blame] | 3170 | if bug: |
| 3171 | regexp = re.compile(self.BUG_LINE) |
| 3172 | prefix = settings.GetBugPrefix() |
| 3173 | if not any((regexp.match(line) for line in self._description_lines)): |
| 3174 | values = list(_get_bug_line_values(prefix, bug)) |
| 3175 | self.append_footer('Bug: %s' % ', '.join(values)) |
Dan Beam | d8b04ca | 2019-10-10 21:23:26 +0000 | [diff] [blame] | 3176 | if fixed: |
| 3177 | regexp = re.compile(self.FIXED_LINE) |
| 3178 | prefix = settings.GetBugPrefix() |
| 3179 | if not any((regexp.match(line) for line in self._description_lines)): |
| 3180 | values = list(_get_bug_line_values(prefix, fixed)) |
| 3181 | self.append_footer('Fixed: %s' % ', '.join(values)) |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3182 | |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3183 | @property # www.logilab.org/ticket/89786 |
Quinten Yearsley | b2cc4a9 | 2016-12-15 13:53:26 -0800 | [diff] [blame] | 3184 | def description(self): # pylint: disable=method-hidden |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3185 | return '\n'.join(self._description_lines) |
| 3186 | |
| 3187 | def set_description(self, desc): |
| 3188 | if isinstance(desc, basestring): |
| 3189 | lines = desc.splitlines() |
| 3190 | else: |
| 3191 | lines = [line.rstrip() for line in desc] |
| 3192 | while lines and not lines[0]: |
| 3193 | lines.pop(0) |
| 3194 | while lines and not lines[-1]: |
| 3195 | lines.pop(-1) |
| 3196 | self._description_lines = lines |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3197 | |
Edward Lemur | 5a644f8 | 2020-03-18 16:44:57 +0000 | [diff] [blame] | 3198 | def ensure_change_id(self, change_id): |
| 3199 | description = self.description |
| 3200 | footer_change_ids = git_footers.get_footer_change_id(description) |
| 3201 | # Make sure that the Change-Id in the description matches the given one. |
| 3202 | if footer_change_ids != [change_id]: |
| 3203 | if footer_change_ids: |
| 3204 | # Remove any existing Change-Id footers since they don't match the |
| 3205 | # expected change_id footer. |
| 3206 | description = git_footers.remove_footer(description, 'Change-Id') |
| 3207 | print('WARNING: Change-Id has been set to %s. Use `git cl issue 0` ' |
| 3208 | 'if you want to set a new one.') |
| 3209 | # Add the expected Change-Id footer. |
| 3210 | description = git_footers.add_footer_change_id(description, change_id) |
| 3211 | self.set_description(description) |
| 3212 | |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3213 | def update_reviewers(self, reviewers): |
| 3214 | """Rewrites the R= line(s) as a single line each. |
Robert Iannucci | 6c98dc6 | 2017-04-18 11:38:00 -0700 | [diff] [blame] | 3215 | |
| 3216 | Args: |
| 3217 | reviewers (list(str)) - list of additional emails to use for reviewers. |
Robert Iannucci | 6c98dc6 | 2017-04-18 11:38:00 -0700 | [diff] [blame] | 3218 | """ |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3219 | if not reviewers: |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3220 | return |
Robert Iannucci | 6c98dc6 | 2017-04-18 11:38:00 -0700 | [diff] [blame] | 3221 | |
| 3222 | reviewers = set(reviewers) |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3223 | |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3224 | # Get the set of R= lines and remove them from the description. |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3225 | regexp = re.compile(self.R_LINE) |
| 3226 | matches = [regexp.match(line) for line in self._description_lines] |
| 3227 | new_desc = [l for i, l in enumerate(self._description_lines) |
| 3228 | if not matches[i]] |
| 3229 | self.set_description(new_desc) |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3230 | |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3231 | # Construct new unified R= lines. |
Robert Iannucci | 6c98dc6 | 2017-04-18 11:38:00 -0700 | [diff] [blame] | 3232 | |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3233 | # First, update reviewers with names from the R= lines (if any). |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3234 | for match in matches: |
| 3235 | if not match: |
| 3236 | continue |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3237 | reviewers.update(cleanup_list([match.group(2).strip()])) |
Robert Iannucci | 6c98dc6 | 2017-04-18 11:38:00 -0700 | [diff] [blame] | 3238 | |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3239 | new_r_line = 'R=' + ', '.join(sorted(reviewers)) |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3240 | |
| 3241 | # Put the new lines in the description where the old first R= line was. |
| 3242 | line_loc = next((i for i, match in enumerate(matches) if match), -1) |
| 3243 | if 0 <= line_loc < len(self._description_lines): |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3244 | self._description_lines.insert(line_loc, new_r_line) |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3245 | else: |
Joanna Wang | 39811b1 | 2023-01-20 23:09:48 +0000 | [diff] [blame] | 3246 | self.append_footer(new_r_line) |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3247 | |
Andrii Shyshkalov | 71f0da3 | 2019-07-15 22:45:18 +0000 | [diff] [blame] | 3248 | def set_preserve_tryjobs(self): |
| 3249 | """Ensures description footer contains 'Cq-Do-Not-Cancel-Tryjobs: true'.""" |
| 3250 | footers = git_footers.parse_footers(self.description) |
| 3251 | for v in footers.get('Cq-Do-Not-Cancel-Tryjobs', []): |
| 3252 | if v.lower() == 'true': |
| 3253 | return |
| 3254 | self.append_footer('Cq-Do-Not-Cancel-Tryjobs: true') |
| 3255 | |
Anthony Polito | 8b95534 | 2019-09-24 19:01:36 +0000 | [diff] [blame] | 3256 | def prompt(self): |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3257 | """Asks the user to update the description.""" |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3258 | self.set_description([ |
| 3259 | '# Enter a description of the change.', |
| 3260 | '# This will be displayed on the codereview site.', |
| 3261 | '# The first line will also be used as the subject of the review.', |
alancutter@chromium.org | bd1073e | 2013-06-01 00:34:38 +0000 | [diff] [blame] | 3262 | '#--------------------This line is 72 characters long' |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3263 | '--------------------', |
| 3264 | ] + self._description_lines) |
Dan Beam | d8b04ca | 2019-10-10 21:23:26 +0000 | [diff] [blame] | 3265 | bug_regexp = re.compile(self.BUG_LINE) |
| 3266 | fixed_regexp = re.compile(self.FIXED_LINE) |
Jonas Termansen | d0f7911 | 2019-03-22 15:28:26 +0000 | [diff] [blame] | 3267 | prefix = settings.GetBugPrefix() |
Sigurd Schneider | 8630bb1 | 2020-11-11 14:02:49 +0000 | [diff] [blame] | 3268 | has_issue = lambda l: bug_regexp.match(l) or fixed_regexp.match(l) |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 3269 | |
Dan Beam | d8b04ca | 2019-10-10 21:23:26 +0000 | [diff] [blame] | 3270 | if not any((has_issue(line) for line in self._description_lines)): |
Anthony Polito | 8b95534 | 2019-09-24 19:01:36 +0000 | [diff] [blame] | 3271 | self.append_footer('Bug: %s' % prefix) |
tandrii | f9aefb7 | 2016-07-01 09:06:51 -0700 | [diff] [blame] | 3272 | |
Bruce Dawson | fc48704 | 2020-10-27 19:11:37 +0000 | [diff] [blame] | 3273 | print('Waiting for editor...') |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3274 | content = gclient_utils.RunEditor(self.description, True, |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 3275 | git_editor=settings.GetGitEditor()) |
maruel@chromium.org | 0e0436a | 2011-10-25 13:32:41 +0000 | [diff] [blame] | 3276 | if not content: |
| 3277 | DieWithError('Running editor failed') |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3278 | lines = content.splitlines() |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3279 | |
Bruce Dawson | 2377b01 | 2018-01-11 16:46:49 -0800 | [diff] [blame] | 3280 | # Strip off comments and default inserted "Bug:" line. |
| 3281 | clean_lines = [line.rstrip() for line in lines if not |
Jonas Termansen | d0f7911 | 2019-03-22 15:28:26 +0000 | [diff] [blame] | 3282 | (line.startswith('#') or |
| 3283 | line.rstrip() == "Bug:" or |
| 3284 | line.rstrip() == "Bug: " + prefix)] |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3285 | if not clean_lines: |
maruel@chromium.org | 0e0436a | 2011-10-25 13:32:41 +0000 | [diff] [blame] | 3286 | DieWithError('No CL description, aborting') |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3287 | self.set_description(clean_lines) |
dpranke@chromium.org | 20254fc | 2011-03-22 18:28:59 +0000 | [diff] [blame] | 3288 | |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3289 | def append_footer(self, line): |
tandrii@chromium.org | 601e1d1 | 2016-06-03 13:03:54 +0000 | [diff] [blame] | 3290 | """Adds a footer line to the description. |
| 3291 | |
| 3292 | Differentiates legacy "KEY=xxx" footers (used to be called tags) and |
| 3293 | Gerrit's footers in the form of "Footer-Key: footer any value" and ensures |
| 3294 | that Gerrit footers are always at the end. |
| 3295 | """ |
| 3296 | parsed_footer_line = git_footers.parse_footer(line) |
| 3297 | if parsed_footer_line: |
| 3298 | # Line is a gerrit footer in the form: Footer-Key: any value. |
| 3299 | # Thus, must be appended observing Gerrit footer rules. |
| 3300 | self.set_description( |
| 3301 | git_footers.add_footer(self.description, |
| 3302 | key=parsed_footer_line[0], |
| 3303 | value=parsed_footer_line[1])) |
| 3304 | return |
| 3305 | |
| 3306 | if not self._description_lines: |
| 3307 | self._description_lines.append(line) |
| 3308 | return |
| 3309 | |
| 3310 | top_lines, gerrit_footers, _ = git_footers.split_footers(self.description) |
| 3311 | if gerrit_footers: |
| 3312 | # git_footers.split_footers ensures that there is an empty line before |
| 3313 | # actual (gerrit) footers, if any. We have to keep it that way. |
| 3314 | assert top_lines and top_lines[-1] == '' |
| 3315 | top_lines, separator = top_lines[:-1], top_lines[-1:] |
| 3316 | else: |
| 3317 | separator = [] # No need for separator if there are no gerrit_footers. |
| 3318 | |
| 3319 | prev_line = top_lines[-1] if top_lines else '' |
| 3320 | if (not presubmit_support.Change.TAG_LINE_RE.match(prev_line) or |
| 3321 | not presubmit_support.Change.TAG_LINE_RE.match(line)): |
| 3322 | top_lines.append('') |
| 3323 | top_lines.append(line) |
| 3324 | self._description_lines = top_lines + separator + gerrit_footers |
dpranke@chromium.org | 20254fc | 2011-03-22 18:28:59 +0000 | [diff] [blame] | 3325 | |
tandrii | 99a72f2 | 2016-08-17 14:33:24 -0700 | [diff] [blame] | 3326 | def get_reviewers(self, tbr_only=False): |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3327 | """Retrieves the list of reviewers.""" |
agable@chromium.org | 42c2079 | 2013-09-12 17:34:49 +0000 | [diff] [blame] | 3328 | matches = [re.match(self.R_LINE, line) for line in self._description_lines] |
tandrii | 99a72f2 | 2016-08-17 14:33:24 -0700 | [diff] [blame] | 3329 | reviewers = [match.group(2).strip() |
| 3330 | for match in matches |
| 3331 | if match and (not tbr_only or match.group(1).upper() == 'TBR')] |
maruel@chromium.org | 78936cb | 2013-04-11 00:17:52 +0000 | [diff] [blame] | 3332 | return cleanup_list(reviewers) |
dpranke@chromium.org | 20254fc | 2011-03-22 18:28:59 +0000 | [diff] [blame] | 3333 | |
bradnelson | d975b30 | 2016-10-23 12:20:23 -0700 | [diff] [blame] | 3334 | def get_cced(self): |
| 3335 | """Retrieves the list of reviewers.""" |
| 3336 | matches = [re.match(self.CC_LINE, line) for line in self._description_lines] |
| 3337 | cced = [match.group(2).strip() for match in matches if match] |
| 3338 | return cleanup_list(cced) |
| 3339 | |
Nodir Turakulov | 23b8214 | 2017-11-16 11:04:25 -0800 | [diff] [blame] | 3340 | def get_hash_tags(self): |
| 3341 | """Extracts and sanitizes a list of Gerrit hashtags.""" |
| 3342 | subject = (self._description_lines or ('',))[0] |
| 3343 | subject = re.sub( |
| 3344 | self.STRIP_HASH_TAG_PREFIX, '', subject, flags=re.IGNORECASE) |
| 3345 | |
| 3346 | tags = [] |
| 3347 | start = 0 |
| 3348 | bracket_exp = re.compile(self.BRACKET_HASH_TAG) |
| 3349 | while True: |
| 3350 | m = bracket_exp.match(subject, start) |
| 3351 | if not m: |
| 3352 | break |
| 3353 | tags.append(self.sanitize_hash_tag(m.group(1))) |
| 3354 | start = m.end() |
| 3355 | |
| 3356 | if not tags: |
| 3357 | # Try "Tag: " prefix. |
| 3358 | m = re.match(self.COLON_SEPARATED_HASH_TAG, subject) |
| 3359 | if m: |
| 3360 | tags.append(self.sanitize_hash_tag(m.group(1))) |
| 3361 | return tags |
| 3362 | |
| 3363 | @classmethod |
| 3364 | def sanitize_hash_tag(cls, tag): |
| 3365 | """Returns a sanitized Gerrit hash tag. |
| 3366 | |
| 3367 | A sanitized hashtag can be used as a git push refspec parameter value. |
| 3368 | """ |
| 3369 | return re.sub(cls.BAD_HASH_TAG_CHUNK, '-', tag).strip('-').lower() |
| 3370 | |
maruel@chromium.org | e52678e | 2013-04-26 18:34:44 +0000 | [diff] [blame] | 3371 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3372 | def FindCodereviewSettingsFile(filename='codereview.settings'): |
| 3373 | """Finds the given file starting in the cwd and going up. |
| 3374 | |
| 3375 | Only looks up to the top of the repository unless an |
| 3376 | 'inherit-review-settings-ok' file exists in the root of the repository. |
| 3377 | """ |
| 3378 | inherit_ok_file = 'inherit-review-settings-ok' |
| 3379 | cwd = os.getcwd() |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 3380 | root = settings.GetRoot() |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3381 | if os.path.isfile(os.path.join(root, inherit_ok_file)): |
Aleksey Khoroshilov | 2a22971 | 2022-06-02 16:24:11 +0000 | [diff] [blame] | 3382 | root = None |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3383 | while True: |
Aleksey Khoroshilov | 2a22971 | 2022-06-02 16:24:11 +0000 | [diff] [blame] | 3384 | if os.path.isfile(os.path.join(cwd, filename)): |
| 3385 | return open(os.path.join(cwd, filename)) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3386 | if cwd == root: |
| 3387 | break |
Aleksey Khoroshilov | 2a22971 | 2022-06-02 16:24:11 +0000 | [diff] [blame] | 3388 | parent_dir = os.path.dirname(cwd) |
| 3389 | if parent_dir == cwd: |
| 3390 | # We hit the system root directory. |
| 3391 | break |
| 3392 | cwd = parent_dir |
| 3393 | return None |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3394 | |
| 3395 | |
| 3396 | def LoadCodereviewSettingsFromFile(fileobj): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3397 | """Parses a codereview.settings file and updates hooks.""" |
maruel@chromium.org | 99ac1c5 | 2012-01-16 14:52:12 +0000 | [diff] [blame] | 3398 | keyvals = gclient_utils.ParseCodereviewSettingsContent(fileobj.read()) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3399 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3400 | def SetProperty(name, setting, unset_error_ok=False): |
| 3401 | fullname = 'rietveld.' + name |
| 3402 | if setting in keyvals: |
| 3403 | RunGit(['config', fullname, keyvals[setting]]) |
| 3404 | else: |
| 3405 | RunGit(['config', '--unset-all', fullname], error_ok=unset_error_ok) |
| 3406 | |
tandrii | 48df581 | 2016-10-17 03:55:37 -0700 | [diff] [blame] | 3407 | if not keyvals.get('GERRIT_HOST', False): |
| 3408 | SetProperty('server', 'CODE_REVIEW_SERVER') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3409 | # Only server setting is required. Other settings can be absent. |
| 3410 | # In that case, we ignore errors raised during option deletion attempt. |
Joanna Wang | c8f23e2 | 2023-01-19 21:18:10 +0000 | [diff] [blame] | 3411 | SetProperty('cc', 'CC_LIST', unset_error_ok=True) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3412 | SetProperty('tree-status-url', 'STATUS', unset_error_ok=True) |
| 3413 | SetProperty('viewvc-url', 'VIEW_VC', unset_error_ok=True) |
rmistry@google.com | 9075258 | 2014-01-14 21:04:50 +0000 | [diff] [blame] | 3414 | SetProperty('bug-prefix', 'BUG_PREFIX', unset_error_ok=True) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 3415 | SetProperty('cpplint-regex', 'LINT_REGEX', unset_error_ok=True) |
| 3416 | SetProperty('cpplint-ignore-regex', 'LINT_IGNORE_REGEX', unset_error_ok=True) |
rmistry@google.com | 5626a92 | 2015-02-26 14:03:30 +0000 | [diff] [blame] | 3417 | SetProperty('run-post-upload-hook', 'RUN_POST_UPLOAD_HOOK', |
| 3418 | unset_error_ok=True) |
Jamie Madill | dc4d19e | 2019-10-24 21:50:02 +0000 | [diff] [blame] | 3419 | SetProperty( |
| 3420 | 'format-full-by-default', 'FORMAT_FULL_BY_DEFAULT', unset_error_ok=True) |
Dirk Pranke | 6f0df68 | 2021-06-25 00:42:33 +0000 | [diff] [blame] | 3421 | SetProperty('use-python3', 'USE_PYTHON3', unset_error_ok=True) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3422 | |
ukai@chromium.org | 7044efc | 2013-11-28 01:51:21 +0000 | [diff] [blame] | 3423 | if 'GERRIT_HOST' in keyvals: |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 3424 | RunGit(['config', 'gerrit.host', keyvals['GERRIT_HOST']]) |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 3425 | |
bauerb@chromium.org | 54b400c | 2016-01-14 10:08:25 +0000 | [diff] [blame] | 3426 | if 'GERRIT_SQUASH_UPLOADS' in keyvals: |
Edward Lesmes | 4de5413 | 2020-05-05 19:41:33 +0000 | [diff] [blame] | 3427 | RunGit(['config', 'gerrit.squash-uploads', |
| 3428 | keyvals['GERRIT_SQUASH_UPLOADS']]) |
bauerb@chromium.org | 54b400c | 2016-01-14 10:08:25 +0000 | [diff] [blame] | 3429 | |
tandrii@chromium.org | 2825353 | 2016-04-14 13:46:56 +0000 | [diff] [blame] | 3430 | if 'GERRIT_SKIP_ENSURE_AUTHENTICATED' in keyvals: |
shinyak@chromium.org | 00dbccd | 2016-04-15 07:24:43 +0000 | [diff] [blame] | 3431 | RunGit(['config', 'gerrit.skip-ensure-authenticated', |
tandrii@chromium.org | 2825353 | 2016-04-14 13:46:56 +0000 | [diff] [blame] | 3432 | keyvals['GERRIT_SKIP_ENSURE_AUTHENTICATED']]) |
| 3433 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3434 | if 'PUSH_URL_CONFIG' in keyvals and 'ORIGIN_URL_CONFIG' in keyvals: |
Andrii Shyshkalov | 1897532 | 2017-01-25 16:44:13 +0100 | [diff] [blame] | 3435 | # should be of the form |
| 3436 | # PUSH_URL_CONFIG: url.ssh://gitrw.chromium.org.pushinsteadof |
| 3437 | # ORIGIN_URL_CONFIG: http://src.chromium.org/git |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3438 | RunGit(['config', keyvals['PUSH_URL_CONFIG'], |
| 3439 | keyvals['ORIGIN_URL_CONFIG']]) |
| 3440 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 3441 | |
joshua.lock@intel.com | 426f69b | 2012-08-02 23:41:49 +0000 | [diff] [blame] | 3442 | def urlretrieve(source, destination): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3443 | """Downloads a network object to a local file, like urllib.urlretrieve. |
| 3444 | |
| 3445 | This is necessary because urllib is broken for SSL connections via a proxy. |
| 3446 | """ |
Vadim Shtayura | f7b8f8f | 2021-11-15 19:10:05 +0000 | [diff] [blame] | 3447 | with open(destination, 'wb') as f: |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 3448 | f.write(urllib.request.urlopen(source).read()) |
joshua.lock@intel.com | 426f69b | 2012-08-02 23:41:49 +0000 | [diff] [blame] | 3449 | |
| 3450 | |
ukai@chromium.org | 712d610 | 2013-11-27 00:52:58 +0000 | [diff] [blame] | 3451 | def hasSheBang(fname): |
| 3452 | """Checks fname is a #! script.""" |
| 3453 | with open(fname) as f: |
| 3454 | return f.read(2).startswith('#!') |
| 3455 | |
| 3456 | |
tandrii@chromium.org | 18630d6 | 2016-03-04 12:06:02 +0000 | [diff] [blame] | 3457 | def DownloadGerritHook(force): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3458 | """Downloads and installs a Gerrit commit-msg hook. |
ukai@chromium.org | 78c4b98 | 2012-02-14 02:20:26 +0000 | [diff] [blame] | 3459 | |
| 3460 | Args: |
| 3461 | force: True to update hooks. False to install hooks if not present. |
| 3462 | """ |
ukai@chromium.org | 712d610 | 2013-11-27 00:52:58 +0000 | [diff] [blame] | 3463 | src = 'https://gerrit-review.googlesource.com/tools/hooks/commit-msg' |
ukai@chromium.org | 78c4b98 | 2012-02-14 02:20:26 +0000 | [diff] [blame] | 3464 | dst = os.path.join(settings.GetRoot(), '.git', 'hooks', 'commit-msg') |
| 3465 | if not os.access(dst, os.X_OK): |
| 3466 | if os.path.exists(dst): |
| 3467 | if not force: |
| 3468 | return |
ukai@chromium.org | 78c4b98 | 2012-02-14 02:20:26 +0000 | [diff] [blame] | 3469 | try: |
joshua.lock@intel.com | 426f69b | 2012-08-02 23:41:49 +0000 | [diff] [blame] | 3470 | urlretrieve(src, dst) |
ukai@chromium.org | 712d610 | 2013-11-27 00:52:58 +0000 | [diff] [blame] | 3471 | if not hasSheBang(dst): |
| 3472 | DieWithError('Not a script: %s\n' |
| 3473 | 'You need to download from\n%s\n' |
| 3474 | 'into .git/hooks/commit-msg and ' |
| 3475 | 'chmod +x .git/hooks/commit-msg' % (dst, src)) |
ukai@chromium.org | 78c4b98 | 2012-02-14 02:20:26 +0000 | [diff] [blame] | 3476 | os.chmod(dst, stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR) |
| 3477 | except Exception: |
| 3478 | if os.path.exists(dst): |
| 3479 | os.remove(dst) |
ukai@chromium.org | 712d610 | 2013-11-27 00:52:58 +0000 | [diff] [blame] | 3480 | DieWithError('\nFailed to download hooks.\n' |
| 3481 | 'You need to download from\n%s\n' |
| 3482 | 'into .git/hooks/commit-msg and ' |
| 3483 | 'chmod +x .git/hooks/commit-msg' % src) |
ukai@chromium.org | 78c4b98 | 2012-02-14 02:20:26 +0000 | [diff] [blame] | 3484 | |
| 3485 | |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3486 | class _GitCookiesChecker(object): |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 3487 | """Provides facilities for validating and suggesting fixes to .gitcookies.""" |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3488 | |
Andrii Shyshkalov | 34924cd | 2017-03-15 17:08:32 +0100 | [diff] [blame] | 3489 | def __init__(self): |
| 3490 | # Cached list of [host, identity, source], where source is either |
| 3491 | # .gitcookies or .netrc. |
| 3492 | self._all_hosts = None |
| 3493 | |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3494 | def ensure_configured_gitcookies(self): |
| 3495 | """Runs checks and suggests fixes to make git use .gitcookies from default |
| 3496 | path.""" |
| 3497 | default = gerrit_util.CookiesAuthenticator.get_gitcookies_path() |
| 3498 | configured_path = RunGitSilent( |
| 3499 | ['config', '--global', 'http.cookiefile']).strip() |
Andrii Shyshkalov | 1e250cd | 2017-05-10 15:39:31 +0200 | [diff] [blame] | 3500 | configured_path = os.path.expanduser(configured_path) |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3501 | if configured_path: |
| 3502 | self._ensure_default_gitcookies_path(configured_path, default) |
| 3503 | else: |
| 3504 | self._configure_gitcookies_path(default) |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3505 | |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3506 | @staticmethod |
| 3507 | def _ensure_default_gitcookies_path(configured_path, default_path): |
| 3508 | assert configured_path |
| 3509 | if configured_path == default_path: |
| 3510 | print('git is already configured to use your .gitcookies from %s' % |
| 3511 | configured_path) |
| 3512 | return |
| 3513 | |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 3514 | print('WARNING: You have configured custom path to .gitcookies: %s\n' |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3515 | 'Gerrit and other depot_tools expect .gitcookies at %s\n' % |
| 3516 | (configured_path, default_path)) |
| 3517 | |
| 3518 | if not os.path.exists(configured_path): |
| 3519 | print('However, your configured .gitcookies file is missing.') |
| 3520 | confirm_or_exit('Reconfigure git to use default .gitcookies?', |
| 3521 | action='reconfigure') |
| 3522 | RunGit(['config', '--global', 'http.cookiefile', default_path]) |
| 3523 | return |
| 3524 | |
| 3525 | if os.path.exists(default_path): |
| 3526 | print('WARNING: default .gitcookies file already exists %s' % |
| 3527 | default_path) |
| 3528 | DieWithError('Please delete %s manually and re-run git cl creds-check' % |
| 3529 | default_path) |
| 3530 | |
| 3531 | confirm_or_exit('Move existing .gitcookies to default location?', |
| 3532 | action='move') |
| 3533 | shutil.move(configured_path, default_path) |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3534 | RunGit(['config', '--global', 'http.cookiefile', default_path]) |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3535 | print('Moved and reconfigured git to use .gitcookies from %s' % |
| 3536 | default_path) |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3537 | |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3538 | @staticmethod |
| 3539 | def _configure_gitcookies_path(default_path): |
| 3540 | netrc_path = gerrit_util.CookiesAuthenticator.get_netrc_path() |
| 3541 | if os.path.exists(netrc_path): |
| 3542 | print('You seem to be using outdated .netrc for git credentials: %s' % |
| 3543 | netrc_path) |
| 3544 | print('This tool will guide you through setting up recommended ' |
| 3545 | '.gitcookies store for git credentials.\n' |
| 3546 | '\n' |
| 3547 | 'IMPORTANT: If something goes wrong and you decide to go back, do:\n' |
| 3548 | ' git config --global --unset http.cookiefile\n' |
| 3549 | ' mv %s %s.backup\n\n' % (default_path, default_path)) |
| 3550 | confirm_or_exit(action='setup .gitcookies') |
| 3551 | RunGit(['config', '--global', 'http.cookiefile', default_path]) |
| 3552 | print('Configured git to use .gitcookies from %s' % default_path) |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3553 | |
Andrii Shyshkalov | 34924cd | 2017-03-15 17:08:32 +0100 | [diff] [blame] | 3554 | def get_hosts_with_creds(self, include_netrc=False): |
| 3555 | if self._all_hosts is None: |
| 3556 | a = gerrit_util.CookiesAuthenticator() |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 3557 | self._all_hosts = [(h, u, s) for h, u, s in itertools.chain(( |
| 3558 | (h, u, '.netrc') for h, (u, _, _) in a.netrc.hosts.items()), ( |
| 3559 | (h, u, '.gitcookies') for h, (u, _) in a.gitcookies.items())) |
| 3560 | if h.endswith(_GOOGLESOURCE)] |
Andrii Shyshkalov | 34924cd | 2017-03-15 17:08:32 +0100 | [diff] [blame] | 3561 | |
| 3562 | if include_netrc: |
| 3563 | return self._all_hosts |
| 3564 | return [(h, u, s) for h, u, s in self._all_hosts if s != '.netrc'] |
| 3565 | |
| 3566 | def print_current_creds(self, include_netrc=False): |
| 3567 | hosts = sorted(self.get_hosts_with_creds(include_netrc=include_netrc)) |
| 3568 | if not hosts: |
| 3569 | print('No Git/Gerrit credentials found') |
| 3570 | return |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 3571 | lengths = [max(map(len, (row[i] for row in hosts))) for i in range(3)] |
Andrii Shyshkalov | 34924cd | 2017-03-15 17:08:32 +0100 | [diff] [blame] | 3572 | header = [('Host', 'User', 'Which file'), |
| 3573 | ['=' * l for l in lengths]] |
| 3574 | for row in (header + hosts): |
| 3575 | print('\t'.join((('%%+%ds' % l) % s) |
| 3576 | for l, s in zip(lengths, row))) |
| 3577 | |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3578 | @staticmethod |
| 3579 | def _parse_identity(identity): |
Lei Zhang | d3f769a | 2017-12-15 15:16:14 -0800 | [diff] [blame] | 3580 | """Parses identity "git-<username>.domain" into <username> and domain.""" |
| 3581 | # Special case: usernames that contain ".", which are generally not |
Andrii Shyshkalov | 0d2dea0 | 2017-07-17 15:17:55 +0200 | [diff] [blame] | 3582 | # distinguishable from sub-domains. But we do know typical domains: |
| 3583 | if identity.endswith('.chromium.org'): |
| 3584 | domain = 'chromium.org' |
| 3585 | username = identity[:-len('.chromium.org')] |
| 3586 | else: |
| 3587 | username, domain = identity.split('.', 1) |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3588 | if username.startswith('git-'): |
| 3589 | username = username[len('git-'):] |
| 3590 | return username, domain |
| 3591 | |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3592 | def has_generic_host(self): |
| 3593 | """Returns whether generic .googlesource.com has been configured. |
| 3594 | |
| 3595 | Chrome Infra recommends to use explicit ${host}.googlesource.com instead. |
| 3596 | """ |
| 3597 | for host, _, _ in self.get_hosts_with_creds(include_netrc=False): |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 3598 | if host == '.' + _GOOGLESOURCE: |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3599 | return True |
| 3600 | return False |
| 3601 | |
| 3602 | def _get_git_gerrit_identity_pairs(self): |
| 3603 | """Returns map from canonic host to pair of identities (Git, Gerrit). |
| 3604 | |
| 3605 | One of identities might be None, meaning not configured. |
| 3606 | """ |
| 3607 | host_to_identity_pairs = {} |
| 3608 | for host, identity, _ in self.get_hosts_with_creds(): |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 3609 | canonical = _canonical_git_googlesource_host(host) |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3610 | pair = host_to_identity_pairs.setdefault(canonical, [None, None]) |
| 3611 | idx = 0 if canonical == host else 1 |
| 3612 | pair[idx] = identity |
| 3613 | return host_to_identity_pairs |
| 3614 | |
| 3615 | def get_partially_configured_hosts(self): |
| 3616 | return set( |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 3617 | (host if i1 else _canonical_gerrit_googlesource_host(host)) |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 3618 | for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items() |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 3619 | if None in (i1, i2) and host != '.' + _GOOGLESOURCE) |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3620 | |
| 3621 | def get_conflicting_hosts(self): |
| 3622 | return set( |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3623 | host |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 3624 | for host, (i1, i2) in self._get_git_gerrit_identity_pairs().items() |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3625 | if None not in (i1, i2) and i1 != i2) |
| 3626 | |
| 3627 | def get_duplicated_hosts(self): |
| 3628 | counters = collections.Counter(h for h, _, _ in self.get_hosts_with_creds()) |
Marc-Antoine Ruel | 8e57b4b | 2019-10-11 01:01:36 +0000 | [diff] [blame] | 3629 | return set(host for host, count in counters.items() if count > 1) |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3630 | |
Andrii Shyshkalov | 9780050 | 2017-03-16 16:04:32 +0100 | [diff] [blame] | 3631 | |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3632 | @staticmethod |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3633 | def _format_hosts(hosts, extra_column_func=None): |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3634 | hosts = sorted(hosts) |
| 3635 | assert hosts |
| 3636 | if extra_column_func is None: |
| 3637 | extras = [''] * len(hosts) |
| 3638 | else: |
| 3639 | extras = [extra_column_func(host) for host in hosts] |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3640 | tmpl = '%%-%ds %%-%ds' % (max(map(len, hosts)), max(map(len, extras))) |
| 3641 | lines = [] |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3642 | for he in zip(hosts, extras): |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3643 | lines.append(tmpl % he) |
| 3644 | return lines |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3645 | |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3646 | def _find_problems(self): |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3647 | if self.has_generic_host(): |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3648 | yield ('.googlesource.com wildcard record detected', |
| 3649 | ['Chrome Infrastructure team recommends to list full host names ' |
| 3650 | 'explicitly.'], |
| 3651 | None) |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3652 | |
| 3653 | dups = self.get_duplicated_hosts() |
| 3654 | if dups: |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3655 | yield ('The following hosts were defined twice', |
| 3656 | self._format_hosts(dups), |
| 3657 | None) |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3658 | |
| 3659 | partial = self.get_partially_configured_hosts() |
| 3660 | if partial: |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3661 | yield ('Credentials should come in pairs for Git and Gerrit hosts. ' |
| 3662 | 'These hosts are missing', |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 3663 | self._format_hosts( |
| 3664 | partial, lambda host: 'but %s defined' % _get_counterpart_host( |
| 3665 | host)), partial) |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3666 | |
| 3667 | conflicting = self.get_conflicting_hosts() |
| 3668 | if conflicting: |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3669 | yield ('The following Git hosts have differing credentials from their ' |
| 3670 | 'Gerrit counterparts', |
| 3671 | self._format_hosts(conflicting, lambda host: '%s vs %s' % |
| 3672 | tuple(self._get_git_gerrit_identity_pairs()[host])), |
| 3673 | conflicting) |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3674 | |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3675 | def find_and_report_problems(self): |
| 3676 | """Returns True if there was at least one problem, else False.""" |
| 3677 | found = False |
| 3678 | bad_hosts = set() |
| 3679 | for title, sublines, hosts in self._find_problems(): |
| 3680 | if not found: |
| 3681 | found = True |
| 3682 | print('\n\n.gitcookies problem report:\n') |
| 3683 | bad_hosts.update(hosts or []) |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3684 | print(' %s%s' % (title, (':' if sublines else ''))) |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3685 | if sublines: |
| 3686 | print() |
| 3687 | print(' %s' % '\n '.join(sublines)) |
| 3688 | print() |
| 3689 | |
| 3690 | if bad_hosts: |
| 3691 | assert found |
| 3692 | print(' You can manually remove corresponding lines in your %s file and ' |
| 3693 | 'visit the following URLs with correct account to generate ' |
| 3694 | 'correct credential lines:\n' % |
| 3695 | gerrit_util.CookiesAuthenticator.get_gitcookies_path()) |
Garrett Beaty | 08bb5c4 | 2022-09-21 17:34:20 +0000 | [diff] [blame] | 3696 | print(' %s' % '\n '.join( |
| 3697 | sorted( |
| 3698 | set(gerrit_util.CookiesAuthenticator().get_new_password_url( |
| 3699 | _canonical_git_googlesource_host(host)) |
| 3700 | for host in bad_hosts)))) |
Andrii Shyshkalov | c817382 | 2017-07-10 12:10:53 +0200 | [diff] [blame] | 3701 | return found |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3702 | |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3703 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 3704 | @metrics.collector.collect_metrics('git cl creds-check') |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3705 | def CMDcreds_check(parser, args): |
| 3706 | """Checks credentials and suggests changes.""" |
| 3707 | _, _ = parser.parse_args(args) |
| 3708 | |
Vadim Shtayura | b250ec1 | 2018-10-04 00:21:08 +0000 | [diff] [blame] | 3709 | # Code below checks .gitcookies. Abort if using something else. |
| 3710 | authn = gerrit_util.Authenticator.get() |
| 3711 | if not isinstance(authn, gerrit_util.CookiesAuthenticator): |
Edward Lemur | 57d4742 | 2020-03-06 20:43:07 +0000 | [diff] [blame] | 3712 | message = ( |
Vadim Shtayura | b250ec1 | 2018-10-04 00:21:08 +0000 | [diff] [blame] | 3713 | 'This command is not designed for bot environment. It checks ' |
| 3714 | '~/.gitcookies file not generally used on bots.') |
Edward Lemur | 57d4742 | 2020-03-06 20:43:07 +0000 | [diff] [blame] | 3715 | # TODO(crbug.com/1059384): Automatically detect when running on cloudtop. |
| 3716 | if isinstance(authn, gerrit_util.GceAuthenticator): |
| 3717 | message += ( |
| 3718 | '\n' |
| 3719 | 'If you need to run this on GCE or a cloudtop instance, ' |
| 3720 | 'export SKIP_GCE_AUTH_FOR_GIT=1 in your env.') |
| 3721 | DieWithError(message) |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3722 | |
Andrii Shyshkalov | 517948b | 2017-03-15 15:51:59 +0100 | [diff] [blame] | 3723 | checker = _GitCookiesChecker() |
| 3724 | checker.ensure_configured_gitcookies() |
Andrii Shyshkalov | 34924cd | 2017-03-15 17:08:32 +0100 | [diff] [blame] | 3725 | |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3726 | print('Your .netrc and .gitcookies have credentials for these hosts:') |
Andrii Shyshkalov | 34924cd | 2017-03-15 17:08:32 +0100 | [diff] [blame] | 3727 | checker.print_current_creds(include_netrc=True) |
| 3728 | |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3729 | if not checker.find_and_report_problems(): |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 3730 | print('\nNo problems detected in your .gitcookies file.') |
Andrii Shyshkalov | 0a0b067 | 2017-03-16 16:27:48 +0100 | [diff] [blame] | 3731 | return 0 |
| 3732 | return 1 |
Andrii Shyshkalov | 353637c | 2017-03-14 16:52:18 +0100 | [diff] [blame] | 3733 | |
| 3734 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 3735 | @metrics.collector.collect_metrics('git cl baseurl') |
kalmard@homejinni.com | 6b0051e | 2012-04-03 15:45:08 +0000 | [diff] [blame] | 3736 | def CMDbaseurl(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 3737 | """Gets or sets base-url for this branch.""" |
Thiago Perrotta | 16d08f0 | 2022-07-20 18:18:50 +0000 | [diff] [blame] | 3738 | _, args = parser.parse_args(args) |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 3739 | branchref = scm.GIT.GetBranchRef(settings.GetRoot()) |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 3740 | branch = scm.GIT.ShortBranchName(branchref) |
kalmard@homejinni.com | 6b0051e | 2012-04-03 15:45:08 +0000 | [diff] [blame] | 3741 | if not args: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3742 | print('Current base-url:') |
kalmard@homejinni.com | 6b0051e | 2012-04-03 15:45:08 +0000 | [diff] [blame] | 3743 | return RunGit(['config', 'branch.%s.base-url' % branch], |
| 3744 | error_ok=False).strip() |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 3745 | |
| 3746 | print('Setting base-url to %s' % args[0]) |
| 3747 | return RunGit(['config', 'branch.%s.base-url' % branch, args[0]], |
| 3748 | error_ok=False).strip() |
kalmard@homejinni.com | 6b0051e | 2012-04-03 15:45:08 +0000 | [diff] [blame] | 3749 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3750 | |
jsbell@chromium.org | b99fbd9 | 2014-09-11 17:29:28 +0000 | [diff] [blame] | 3751 | def color_for_status(status): |
| 3752 | """Maps a Changelist status to color, for CMDstatus and other tools.""" |
Bruce Dawson | b73f8a9 | 2020-03-27 22:03:08 +0000 | [diff] [blame] | 3753 | BOLD = '\033[1m' |
jsbell@chromium.org | b99fbd9 | 2014-09-11 17:29:28 +0000 | [diff] [blame] | 3754 | return { |
Bruce Dawson | b73f8a9 | 2020-03-27 22:03:08 +0000 | [diff] [blame] | 3755 | 'unsent': BOLD + Fore.YELLOW, |
| 3756 | 'waiting': BOLD + Fore.RED, |
| 3757 | 'reply': BOLD + Fore.YELLOW, |
| 3758 | 'not lgtm': BOLD + Fore.RED, |
| 3759 | 'lgtm': BOLD + Fore.GREEN, |
| 3760 | 'commit': BOLD + Fore.MAGENTA, |
| 3761 | 'closed': BOLD + Fore.CYAN, |
| 3762 | 'error': BOLD + Fore.WHITE, |
jsbell@chromium.org | b99fbd9 | 2014-09-11 17:29:28 +0000 | [diff] [blame] | 3763 | }.get(status, Fore.WHITE) |
| 3764 | |
tandrii@chromium.org | 04ea846 | 2016-04-25 19:51:21 +0000 | [diff] [blame] | 3765 | |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 3766 | def get_cl_statuses(changes, fine_grained, max_processes=None): |
| 3767 | """Returns a blocking iterable of (cl, status) for given branches. |
calamity@chromium.org | ffde55c | 2015-03-12 00:44:17 +0000 | [diff] [blame] | 3768 | |
| 3769 | If fine_grained is true, this will fetch CL statuses from the server. |
| 3770 | Otherwise, simply indicate if there's a matching url for the given branches. |
| 3771 | |
| 3772 | If max_processes is specified, it is used as the maximum number of processes |
| 3773 | to spawn to fetch CL status from the server. Otherwise 1 process per branch is |
| 3774 | spawned. |
calamity@chromium.org | cf19748 | 2016-04-29 20:15:53 +0000 | [diff] [blame] | 3775 | |
| 3776 | See GetStatus() for a list of possible statuses. |
calamity@chromium.org | ffde55c | 2015-03-12 00:44:17 +0000 | [diff] [blame] | 3777 | """ |
Andrii Shyshkalov | 2f8e924 | 2017-01-23 19:20:19 +0100 | [diff] [blame] | 3778 | if not changes: |
Edward Lemur | 61bf417 | 2020-02-24 23:22:37 +0000 | [diff] [blame] | 3779 | return |
calamity@chromium.org | cf19748 | 2016-04-29 20:15:53 +0000 | [diff] [blame] | 3780 | |
Andrii Shyshkalov | 2f8e924 | 2017-01-23 19:20:19 +0100 | [diff] [blame] | 3781 | if not fine_grained: |
| 3782 | # Fast path which doesn't involve querying codereview servers. |
Aaron Gable | a1bab27 | 2017-04-11 16:38:18 -0700 | [diff] [blame] | 3783 | # Do not use get_approving_reviewers(), since it requires an HTTP request. |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 3784 | for cl in changes: |
| 3785 | yield (cl, 'waiting' if cl.GetIssueURL() else 'error') |
Andrii Shyshkalov | 2f8e924 | 2017-01-23 19:20:19 +0100 | [diff] [blame] | 3786 | return |
| 3787 | |
| 3788 | # First, sort out authentication issues. |
| 3789 | logging.debug('ensuring credentials exist') |
| 3790 | for cl in changes: |
| 3791 | cl.EnsureAuthenticated(force=False, refresh=True) |
| 3792 | |
| 3793 | def fetch(cl): |
| 3794 | try: |
| 3795 | return (cl, cl.GetStatus()) |
| 3796 | except: |
| 3797 | # See http://crbug.com/629863. |
Andrii Shyshkalov | 9882423 | 2018-04-19 11:37:15 -0700 | [diff] [blame] | 3798 | logging.exception('failed to fetch status for cl %s:', cl.GetIssue()) |
Andrii Shyshkalov | 2f8e924 | 2017-01-23 19:20:19 +0100 | [diff] [blame] | 3799 | raise |
| 3800 | |
| 3801 | threads_count = len(changes) |
| 3802 | if max_processes: |
| 3803 | threads_count = max(1, min(threads_count, max_processes)) |
| 3804 | logging.debug('querying %d CLs using %d threads', len(changes), threads_count) |
| 3805 | |
Edward Lemur | 61bf417 | 2020-02-24 23:22:37 +0000 | [diff] [blame] | 3806 | pool = multiprocessing.pool.ThreadPool(threads_count) |
Andrii Shyshkalov | 2f8e924 | 2017-01-23 19:20:19 +0100 | [diff] [blame] | 3807 | fetched_cls = set() |
| 3808 | try: |
| 3809 | it = pool.imap_unordered(fetch, changes).__iter__() |
| 3810 | while True: |
| 3811 | try: |
| 3812 | cl, status = it.next(timeout=5) |
Edward Lemur | 61bf417 | 2020-02-24 23:22:37 +0000 | [diff] [blame] | 3813 | except (multiprocessing.TimeoutError, StopIteration): |
Andrii Shyshkalov | 2f8e924 | 2017-01-23 19:20:19 +0100 | [diff] [blame] | 3814 | break |
| 3815 | fetched_cls.add(cl) |
| 3816 | yield cl, status |
| 3817 | finally: |
| 3818 | pool.close() |
| 3819 | |
| 3820 | # Add any branches that failed to fetch. |
| 3821 | for cl in set(changes) - fetched_cls: |
| 3822 | yield (cl, 'error') |
jsbell@chromium.org | b99fbd9 | 2014-09-11 17:29:28 +0000 | [diff] [blame] | 3823 | |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3824 | |
Jose Lopes | 3863fc5 | 2020-04-07 17:00:25 +0000 | [diff] [blame] | 3825 | def upload_branch_deps(cl, args, force=False): |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3826 | """Uploads CLs of local branches that are dependents of the current branch. |
| 3827 | |
| 3828 | If the local branch dependency tree looks like: |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3829 | |
| 3830 | test1 -> test2.1 -> test3.1 |
| 3831 | -> test3.2 |
| 3832 | -> test2.2 -> test3.3 |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3833 | |
| 3834 | and you run "git cl upload --dependencies" from test1 then "git cl upload" is |
| 3835 | run on the dependent branches in this order: |
| 3836 | test2.1, test3.1, test3.2, test2.2, test3.3 |
| 3837 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3838 | Note: This function does not rebase your local dependent branches. Use it |
| 3839 | when you make a change to the parent branch that will not conflict |
| 3840 | with its dependent branches, and you would like their dependencies |
| 3841 | updated in Rietveld. |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3842 | """ |
| 3843 | if git_common.is_dirty_git_tree('upload-branch-deps'): |
| 3844 | return 1 |
| 3845 | |
| 3846 | root_branch = cl.GetBranch() |
| 3847 | if root_branch is None: |
| 3848 | DieWithError('Can\'t find dependent branches from detached HEAD state. ' |
| 3849 | 'Get on a branch!') |
Andrii Shyshkalov | 9f27443 | 2018-10-15 16:40:23 +0000 | [diff] [blame] | 3850 | if not cl.GetIssue(): |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3851 | DieWithError('Current branch does not have an uploaded CL. We cannot set ' |
| 3852 | 'patchset dependencies without an uploaded CL.') |
| 3853 | |
| 3854 | branches = RunGit(['for-each-ref', |
| 3855 | '--format=%(refname:short) %(upstream:short)', |
| 3856 | 'refs/heads']) |
| 3857 | if not branches: |
| 3858 | print('No local branches found.') |
| 3859 | return 0 |
| 3860 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3861 | # Create a dictionary of all local branches to the branches that are |
| 3862 | # dependent on it. |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3863 | tracked_to_dependents = collections.defaultdict(list) |
| 3864 | for b in branches.splitlines(): |
| 3865 | tokens = b.split() |
| 3866 | if len(tokens) == 2: |
| 3867 | branch_name, tracked = tokens |
| 3868 | tracked_to_dependents[tracked].append(branch_name) |
| 3869 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3870 | print() |
| 3871 | print('The dependent local branches of %s are:' % root_branch) |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3872 | dependents = [] |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3873 | |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3874 | def traverse_dependents_preorder(branch, padding=''): |
| 3875 | dependents_to_process = tracked_to_dependents.get(branch, []) |
| 3876 | padding += ' ' |
| 3877 | for dependent in dependents_to_process: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3878 | print('%s%s' % (padding, dependent)) |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3879 | dependents.append(dependent) |
| 3880 | traverse_dependents_preorder(dependent, padding) |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 3881 | |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3882 | traverse_dependents_preorder(root_branch) |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3883 | print() |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3884 | |
| 3885 | if not dependents: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3886 | print('There are no dependent local branches for %s' % root_branch) |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3887 | return 0 |
| 3888 | |
Jose Lopes | 3863fc5 | 2020-04-07 17:00:25 +0000 | [diff] [blame] | 3889 | if not force: |
| 3890 | confirm_or_exit('This command will checkout all dependent branches and run ' |
| 3891 | '"git cl upload".', action='continue') |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3892 | |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3893 | # Record all dependents that failed to upload. |
| 3894 | failures = {} |
| 3895 | # Go through all dependents, checkout the branch and upload. |
| 3896 | try: |
| 3897 | for dependent_branch in dependents: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3898 | print() |
| 3899 | print('--------------------------------------') |
| 3900 | print('Running "git cl upload" from %s:' % dependent_branch) |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3901 | RunGit(['checkout', '-q', dependent_branch]) |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3902 | print() |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3903 | try: |
| 3904 | if CMDupload(OptionParser(), args) != 0: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3905 | print('Upload failed for %s!' % dependent_branch) |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3906 | failures[dependent_branch] = 1 |
Quinten Yearsley | b2cc4a9 | 2016-12-15 13:53:26 -0800 | [diff] [blame] | 3907 | except: # pylint: disable=bare-except |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3908 | failures[dependent_branch] = 1 |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3909 | print() |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3910 | finally: |
| 3911 | # Swap back to the original root branch. |
| 3912 | RunGit(['checkout', '-q', root_branch]) |
| 3913 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3914 | print() |
| 3915 | print('Upload complete for dependent branches!') |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3916 | for dependent_branch in dependents: |
| 3917 | upload_status = 'failed' if failures.get(dependent_branch) else 'succeeded' |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3918 | print(' %s : %s' % (dependent_branch, upload_status)) |
| 3919 | print() |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 3920 | |
| 3921 | return 0 |
| 3922 | |
| 3923 | |
Tibor Goldschwendt | 7c5efb2 | 2020-03-25 01:23:54 +0000 | [diff] [blame] | 3924 | def GetArchiveTagForBranch(issue_num, branch_name, existing_tags, pattern): |
Kevin Marshall | 0e60ecd | 2019-12-04 17:44:13 +0000 | [diff] [blame] | 3925 | """Given a proposed tag name, returns a tag name that is guaranteed to be |
| 3926 | unique. If 'foo' is proposed but already exists, then 'foo-2' is used, |
| 3927 | or 'foo-3', and so on.""" |
| 3928 | |
Tibor Goldschwendt | 7c5efb2 | 2020-03-25 01:23:54 +0000 | [diff] [blame] | 3929 | proposed_tag = pattern.format(**{'issue': issue_num, 'branch': branch_name}) |
Kevin Marshall | 0e60ecd | 2019-12-04 17:44:13 +0000 | [diff] [blame] | 3930 | for suffix_num in itertools.count(1): |
| 3931 | if suffix_num == 1: |
| 3932 | to_check = proposed_tag |
| 3933 | else: |
| 3934 | to_check = '%s-%d' % (proposed_tag, suffix_num) |
| 3935 | |
| 3936 | if to_check not in existing_tags: |
| 3937 | return to_check |
| 3938 | |
| 3939 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 3940 | @metrics.collector.collect_metrics('git cl archive') |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3941 | def CMDarchive(parser, args): |
| 3942 | """Archives and deletes branches associated with closed changelists.""" |
| 3943 | parser.add_option( |
| 3944 | '-j', '--maxjobs', action='store', type=int, |
kmarshall | 9249e01 | 2016-08-23 12:02:16 -0700 | [diff] [blame] | 3945 | help='The maximum number of jobs to use when retrieving review status.') |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3946 | parser.add_option( |
| 3947 | '-f', '--force', action='store_true', |
| 3948 | help='Bypasses the confirmation prompt.') |
kmarshall | 9249e01 | 2016-08-23 12:02:16 -0700 | [diff] [blame] | 3949 | parser.add_option( |
| 3950 | '-d', '--dry-run', action='store_true', |
| 3951 | help='Skip the branch tagging and removal steps.') |
| 3952 | parser.add_option( |
| 3953 | '-t', '--notags', action='store_true', |
| 3954 | help='Do not tag archived branches. ' |
| 3955 | 'Note: local commit history may be lost.') |
Tibor Goldschwendt | 7c5efb2 | 2020-03-25 01:23:54 +0000 | [diff] [blame] | 3956 | parser.add_option( |
| 3957 | '-p', |
| 3958 | '--pattern', |
| 3959 | default='git-cl-archived-{issue}-{branch}', |
| 3960 | help='Format string for archive tags. ' |
| 3961 | 'E.g. \'archived-{issue}-{branch}\'.') |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3962 | |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3963 | options, args = parser.parse_args(args) |
| 3964 | if args: |
| 3965 | parser.error('Unsupported args: %s' % ' '.join(args)) |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3966 | |
| 3967 | branches = RunGit(['for-each-ref', '--format=%(refname)', 'refs/heads']) |
| 3968 | if not branches: |
| 3969 | return 0 |
| 3970 | |
Kevin Marshall | 0e60ecd | 2019-12-04 17:44:13 +0000 | [diff] [blame] | 3971 | tags = RunGit(['for-each-ref', '--format=%(refname)', |
| 3972 | 'refs/tags']).splitlines() or [] |
| 3973 | tags = [t.split('/')[-1] for t in tags] |
| 3974 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3975 | print('Finding all branches associated with closed issues...') |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 3976 | changes = [Changelist(branchref=b) |
| 3977 | for b in branches.splitlines()] |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3978 | alignment = max(5, max(len(c.GetBranch()) for c in changes)) |
| 3979 | statuses = get_cl_statuses(changes, |
| 3980 | fine_grained=True, |
| 3981 | max_processes=options.maxjobs) |
| 3982 | proposal = [(cl.GetBranch(), |
Tibor Goldschwendt | 7c5efb2 | 2020-03-25 01:23:54 +0000 | [diff] [blame] | 3983 | GetArchiveTagForBranch(cl.GetIssue(), cl.GetBranch(), tags, |
| 3984 | options.pattern)) |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3985 | for cl, status in statuses |
Andrii Shyshkalov | 51bdf8c | 2018-10-18 01:07:58 +0000 | [diff] [blame] | 3986 | if status in ('closed', 'rietveld-not-supported')] |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3987 | proposal.sort() |
| 3988 | |
| 3989 | if not proposal: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3990 | print('No branches with closed codereview issues found.') |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3991 | return 0 |
| 3992 | |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 3993 | current_branch = scm.GIT.GetBranch(settings.GetRoot()) |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 3994 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 3995 | print('\nBranches with closed issues that will be archived:\n') |
kmarshall | 9249e01 | 2016-08-23 12:02:16 -0700 | [diff] [blame] | 3996 | if options.notags: |
| 3997 | for next_item in proposal: |
| 3998 | print(' ' + next_item[0]) |
| 3999 | else: |
| 4000 | print('%*s | %s' % (alignment, 'Branch name', 'Archival tag name')) |
| 4001 | for next_item in proposal: |
| 4002 | print('%*s %s' % (alignment, next_item[0], next_item[1])) |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 4003 | |
kmarshall | 9249e01 | 2016-08-23 12:02:16 -0700 | [diff] [blame] | 4004 | # Quit now on precondition failure or if instructed by the user, either |
| 4005 | # via an interactive prompt or by command line flags. |
| 4006 | if options.dry_run: |
| 4007 | print('\nNo changes were made (dry run).\n') |
| 4008 | return 0 |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 4009 | |
| 4010 | if any(branch == current_branch for branch, _ in proposal): |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 4011 | print('You are currently on a branch \'%s\' which is associated with a ' |
| 4012 | 'closed codereview issue, so archive cannot proceed. Please ' |
| 4013 | 'checkout another branch and run this command again.' % |
| 4014 | current_branch) |
| 4015 | return 1 |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 4016 | |
| 4017 | if not options.force: |
Edward Lesmes | ae3586b | 2020-03-23 21:21:14 +0000 | [diff] [blame] | 4018 | answer = gclient_utils.AskForData('\nProceed with deletion (Y/n)? ').lower() |
sergiyb | 4a5ecbe | 2016-06-20 09:46:00 -0700 | [diff] [blame] | 4019 | if answer not in ('y', ''): |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4020 | print('Aborted.') |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 4021 | return 1 |
| 4022 | |
| 4023 | for branch, tagname in proposal: |
kmarshall | 9249e01 | 2016-08-23 12:02:16 -0700 | [diff] [blame] | 4024 | if not options.notags: |
| 4025 | RunGit(['tag', tagname, branch]) |
Kevin Marshall | 0e60ecd | 2019-12-04 17:44:13 +0000 | [diff] [blame] | 4026 | |
| 4027 | if RunGitWithCode(['branch', '-D', branch])[0] != 0: |
| 4028 | # Clean up the tag if we failed to delete the branch. |
| 4029 | RunGit(['tag', '-d', tagname]) |
kmarshall | 9249e01 | 2016-08-23 12:02:16 -0700 | [diff] [blame] | 4030 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4031 | print('\nJob\'s done!') |
kmarshall | 3bff56b | 2016-06-06 18:31:47 -0700 | [diff] [blame] | 4032 | |
| 4033 | return 0 |
| 4034 | |
| 4035 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4036 | @metrics.collector.collect_metrics('git cl status') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4037 | def CMDstatus(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 4038 | """Show status of changelists. |
| 4039 | |
| 4040 | Colors are used to tell the state of the CL unless --fast is used: |
jsbell@chromium.org | aeab41a | 2013-12-10 20:01:22 +0000 | [diff] [blame] | 4041 | - Blue waiting for review |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 4042 | - Yellow waiting for you to reply to review, or not yet sent |
jsbell@chromium.org | aeab41a | 2013-12-10 20:01:22 +0000 | [diff] [blame] | 4043 | - Green LGTM'ed |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 4044 | - Red 'not LGTM'ed |
Andrii Shyshkalov | 0e889b7 | 2019-07-15 22:28:48 +0000 | [diff] [blame] | 4045 | - Magenta in the CQ |
jsbell@chromium.org | aeab41a | 2013-12-10 20:01:22 +0000 | [diff] [blame] | 4046 | - Cyan was committed, branch can be deleted |
Aaron Gable | 9ab38c6 | 2017-04-06 14:36:33 -0700 | [diff] [blame] | 4047 | - White error, or unknown status |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 4048 | |
| 4049 | Also see 'git cl comments'. |
| 4050 | """ |
Alan Cutter | a3be9a5 | 2019-03-04 18:50:33 +0000 | [diff] [blame] | 4051 | parser.add_option( |
| 4052 | '--no-branch-color', |
| 4053 | action='store_true', |
| 4054 | help='Disable colorized branch names') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4055 | parser.add_option('--field', |
phajdan.jr | 289d03e | 2016-08-16 08:21:06 -0700 | [diff] [blame] | 4056 | help='print only specific field (desc|id|patch|status|url)') |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 4057 | parser.add_option('-f', '--fast', action='store_true', |
| 4058 | help='Do not retrieve review status') |
calamity@chromium.org | ffde55c | 2015-03-12 00:44:17 +0000 | [diff] [blame] | 4059 | parser.add_option( |
| 4060 | '-j', '--maxjobs', action='store', type=int, |
| 4061 | help='The maximum number of jobs to use when retrieving review status') |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 4062 | parser.add_option( |
| 4063 | '-i', '--issue', type=int, |
| 4064 | help='Operate on this issue instead of the current branch\'s implicit ' |
| 4065 | 'issue. Requires --field to be set.') |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 4066 | parser.add_option('-d', |
| 4067 | '--date-order', |
| 4068 | action='store_true', |
| 4069 | help='Order branches by committer date.') |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 4070 | options, args = parser.parse_args(args) |
maruel@chromium.org | 39c0b22 | 2013-08-17 16:57:01 +0000 | [diff] [blame] | 4071 | if args: |
| 4072 | parser.error('Unsupported args: %s' % args) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4073 | |
iannucci | e53c935 | 2016-08-17 14:40:40 -0700 | [diff] [blame] | 4074 | if options.issue is not None and not options.field: |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 4075 | parser.error('--field must be given when --issue is set.') |
iannucci | 3c972b9 | 2016-08-17 13:24:10 -0700 | [diff] [blame] | 4076 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4077 | if options.field: |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 4078 | cl = Changelist(issue=options.issue) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4079 | if options.field.startswith('desc'): |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 4080 | if cl.GetIssue(): |
| 4081 | print(cl.FetchDescription()) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4082 | elif options.field == 'id': |
| 4083 | issueid = cl.GetIssue() |
| 4084 | if issueid: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4085 | print(issueid) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4086 | elif options.field == 'patch': |
Aaron Gable | e8856ee | 2017-12-07 12:41:46 -0800 | [diff] [blame] | 4087 | patchset = cl.GetMostRecentPatchset() |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4088 | if patchset: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4089 | print(patchset) |
phajdan.jr | 289d03e | 2016-08-16 08:21:06 -0700 | [diff] [blame] | 4090 | elif options.field == 'status': |
| 4091 | print(cl.GetStatus()) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4092 | elif options.field == 'url': |
| 4093 | url = cl.GetIssueURL() |
| 4094 | if url: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4095 | print(url) |
maruel@chromium.org | e25c75b | 2013-07-23 18:30:56 +0000 | [diff] [blame] | 4096 | return 0 |
| 4097 | |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 4098 | branches = RunGit([ |
| 4099 | 'for-each-ref', '--format=%(refname) %(committerdate:unix)', 'refs/heads' |
| 4100 | ]) |
maruel@chromium.org | e25c75b | 2013-07-23 18:30:56 +0000 | [diff] [blame] | 4101 | if not branches: |
| 4102 | print('No local branch found.') |
| 4103 | return 0 |
| 4104 | |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 4105 | changes = [ |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 4106 | Changelist(branchref=b, commit_date=ct) |
| 4107 | for b, ct in map(lambda line: line.split(' '), branches.splitlines()) |
| 4108 | ] |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4109 | print('Branches associated with reviews:') |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 4110 | output = get_cl_statuses(changes, |
calamity@chromium.org | ffde55c | 2015-03-12 00:44:17 +0000 | [diff] [blame] | 4111 | fine_grained=not options.fast, |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 4112 | max_processes=options.maxjobs) |
maruel@chromium.org | 1033efd | 2013-07-23 23:25:09 +0000 | [diff] [blame] | 4113 | |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 4114 | current_branch = scm.GIT.GetBranch(settings.GetRoot()) |
Daniel McArdle | a23bf59 | 2019-02-12 00:25:12 +0000 | [diff] [blame] | 4115 | |
| 4116 | def FormatBranchName(branch, colorize=False): |
| 4117 | """Simulates 'git branch' behavior. Colorizes and prefixes branch name with |
| 4118 | an asterisk when it is the current branch.""" |
| 4119 | |
| 4120 | asterisk = "" |
| 4121 | color = Fore.RESET |
| 4122 | if branch == current_branch: |
| 4123 | asterisk = "* " |
| 4124 | color = Fore.GREEN |
Edward Lemur | 8515328 | 2020-02-14 22:06:29 +0000 | [diff] [blame] | 4125 | branch_name = scm.GIT.ShortBranchName(branch) |
Daniel McArdle | a23bf59 | 2019-02-12 00:25:12 +0000 | [diff] [blame] | 4126 | |
| 4127 | if colorize: |
| 4128 | return asterisk + color + branch_name + Fore.RESET |
Daniel McArdle | 452a49f | 2019-02-14 17:28:31 +0000 | [diff] [blame] | 4129 | return asterisk + branch_name |
| 4130 | |
calamity@chromium.org | ffde55c | 2015-03-12 00:44:17 +0000 | [diff] [blame] | 4131 | branch_statuses = {} |
Daniel McArdle | a23bf59 | 2019-02-12 00:25:12 +0000 | [diff] [blame] | 4132 | |
| 4133 | alignment = max(5, max(len(FormatBranchName(c.GetBranch())) for c in changes)) |
Sigurd Schneider | 1bfda8e | 2021-06-30 14:46:25 +0000 | [diff] [blame] | 4134 | |
| 4135 | if options.date_order or settings.IsStatusCommitOrderByDate(): |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 4136 | sorted_changes = sorted(changes, |
| 4137 | key=lambda c: c.GetCommitDate(), |
| 4138 | reverse=True) |
| 4139 | else: |
| 4140 | sorted_changes = sorted(changes, key=lambda c: c.GetBranch()) |
| 4141 | for cl in sorted_changes: |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 4142 | branch = cl.GetBranch() |
calamity@chromium.org | ffde55c | 2015-03-12 00:44:17 +0000 | [diff] [blame] | 4143 | while branch not in branch_statuses: |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 4144 | c, status = next(output) |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 4145 | branch_statuses[c.GetBranch()] = status |
| 4146 | status = branch_statuses.pop(branch) |
Andrii Shyshkalov | 1ee78cd | 2020-03-12 01:31:53 +0000 | [diff] [blame] | 4147 | url = cl.GetIssueURL(short=True) |
clemensh@chromium.org | cbd7dc3 | 2016-05-31 10:33:50 +0000 | [diff] [blame] | 4148 | if url and (not status or status == 'error'): |
| 4149 | # The issue probably doesn't exist anymore. |
| 4150 | url += ' (broken)' |
| 4151 | |
nodir@chromium.org | a6de1f4 | 2015-06-10 04:23:17 +0000 | [diff] [blame] | 4152 | color = color_for_status(status) |
Bruce Dawson | b73f8a9 | 2020-03-27 22:03:08 +0000 | [diff] [blame] | 4153 | # Turn off bold as well as colors. |
| 4154 | END = '\033[0m' |
| 4155 | reset = Fore.RESET + END |
iannucci@chromium.org | 596cd5c | 2016-04-04 21:34:39 +0000 | [diff] [blame] | 4156 | if not setup_color.IS_TTY: |
maruel@chromium.org | 885f651 | 2013-07-27 02:17:26 +0000 | [diff] [blame] | 4157 | color = '' |
| 4158 | reset = '' |
nodir@chromium.org | a6de1f4 | 2015-06-10 04:23:17 +0000 | [diff] [blame] | 4159 | status_str = '(%s)' % status if status else '' |
Daniel McArdle | 452a49f | 2019-02-14 17:28:31 +0000 | [diff] [blame] | 4160 | |
Alan Cutter | a3be9a5 | 2019-03-04 18:50:33 +0000 | [diff] [blame] | 4161 | branch_display = FormatBranchName(branch) |
| 4162 | padding = ' ' * (alignment - len(branch_display)) |
| 4163 | if not options.no_branch_color: |
| 4164 | branch_display = FormatBranchName(branch, colorize=True) |
Daniel McArdle | 452a49f | 2019-02-14 17:28:31 +0000 | [diff] [blame] | 4165 | |
Alan Cutter | a3be9a5 | 2019-03-04 18:50:33 +0000 | [diff] [blame] | 4166 | print(' %s : %s%s %s%s' % (padding + branch_display, color, url, |
| 4167 | status_str, reset)) |
Andrii Shyshkalov | d0e1d9d | 2017-01-24 17:10:51 +0100 | [diff] [blame] | 4168 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4169 | print() |
Daniel McArdle | a23bf59 | 2019-02-12 00:25:12 +0000 | [diff] [blame] | 4170 | print('Current branch: %s' % current_branch) |
Andrii Shyshkalov | d0e1d9d | 2017-01-24 17:10:51 +0100 | [diff] [blame] | 4171 | for cl in changes: |
Daniel McArdle | a23bf59 | 2019-02-12 00:25:12 +0000 | [diff] [blame] | 4172 | if cl.GetBranch() == current_branch: |
Andrii Shyshkalov | d0e1d9d | 2017-01-24 17:10:51 +0100 | [diff] [blame] | 4173 | break |
dpranke@chromium.org | ee87f58 | 2015-07-31 18:46:25 +0000 | [diff] [blame] | 4174 | if not cl.GetIssue(): |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4175 | print('No issue assigned.') |
dpranke@chromium.org | ee87f58 | 2015-07-31 18:46:25 +0000 | [diff] [blame] | 4176 | return 0 |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4177 | print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL())) |
maruel@chromium.org | 85616e0 | 2014-07-28 15:37:55 +0000 | [diff] [blame] | 4178 | if not options.fast: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4179 | print('Issue description:') |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 4180 | print(cl.FetchDescription(pretty=True)) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4181 | return 0 |
| 4182 | |
| 4183 | |
maruel@chromium.org | 39c0b22 | 2013-08-17 16:57:01 +0000 | [diff] [blame] | 4184 | def colorize_CMDstatus_doc(): |
| 4185 | """To be called once in main() to add colors to git cl status help.""" |
| 4186 | colors = [i for i in dir(Fore) if i[0].isupper()] |
| 4187 | |
| 4188 | def colorize_line(line): |
| 4189 | for color in colors: |
| 4190 | if color in line.upper(): |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 4191 | # Extract whitespace first and the leading '-'. |
maruel@chromium.org | 39c0b22 | 2013-08-17 16:57:01 +0000 | [diff] [blame] | 4192 | indent = len(line) - len(line.lstrip(' ')) + 1 |
| 4193 | return line[:indent] + getattr(Fore, color) + line[indent:] + Fore.RESET |
| 4194 | return line |
| 4195 | |
| 4196 | lines = CMDstatus.__doc__.splitlines() |
| 4197 | CMDstatus.__doc__ = '\n'.join(colorize_line(l) for l in lines) |
| 4198 | |
| 4199 | |
phajdan.jr | e328cf9 | 2016-08-22 04:12:17 -0700 | [diff] [blame] | 4200 | def write_json(path, contents): |
Stefan Zager | 1306bd0 | 2017-06-22 19:26:46 -0700 | [diff] [blame] | 4201 | if path == '-': |
| 4202 | json.dump(contents, sys.stdout) |
| 4203 | else: |
| 4204 | with open(path, 'w') as f: |
| 4205 | json.dump(contents, f) |
phajdan.jr | e328cf9 | 2016-08-22 04:12:17 -0700 | [diff] [blame] | 4206 | |
| 4207 | |
maruel@chromium.org | 0633fb4 | 2013-08-16 20:06:14 +0000 | [diff] [blame] | 4208 | @subcommand.usage('[issue_number]') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4209 | @metrics.collector.collect_metrics('git cl issue') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4210 | def CMDissue(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 4211 | """Sets or displays the current code review issue number. |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4212 | |
| 4213 | Pass issue number 0 to clear the current issue. |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 4214 | """ |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4215 | parser.add_option('-r', '--reverse', action='store_true', |
| 4216 | help='Lookup the branch(es) for the specified issues. If ' |
| 4217 | 'no issues are specified, all branches with mapped ' |
| 4218 | 'issues will be listed.') |
Stefan Zager | 1306bd0 | 2017-06-22 19:26:46 -0700 | [diff] [blame] | 4219 | parser.add_option('--json', |
| 4220 | help='Path to JSON output file, or "-" for stdout.') |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4221 | options, args = parser.parse_args(args) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4222 | |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4223 | if options.reverse: |
| 4224 | branches = RunGit(['for-each-ref', 'refs/heads', |
Aaron Gable | ad64abd | 2017-12-04 09:49:13 -0800 | [diff] [blame] | 4225 | '--format=%(refname)']).splitlines() |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4226 | # Reverse issue lookup. |
| 4227 | issue_branch_map = {} |
Daniel Bratell | b56a43a | 2018-09-06 15:49:03 +0000 | [diff] [blame] | 4228 | |
| 4229 | git_config = {} |
| 4230 | for config in RunGit(['config', '--get-regexp', |
| 4231 | r'branch\..*issue']).splitlines(): |
| 4232 | name, _space, val = config.partition(' ') |
| 4233 | git_config[name] = val |
| 4234 | |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4235 | for branch in branches: |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 4236 | issue = git_config.get( |
| 4237 | 'branch.%s.%s' % (scm.GIT.ShortBranchName(branch), ISSUE_CONFIG_KEY)) |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 4238 | if issue: |
| 4239 | issue_branch_map.setdefault(int(issue), []).append(branch) |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4240 | if not args: |
Carlos Caballero | 81923d6 | 2020-07-06 18:22:27 +0000 | [diff] [blame] | 4241 | args = sorted(issue_branch_map.keys()) |
phajdan.jr | e328cf9 | 2016-08-22 04:12:17 -0700 | [diff] [blame] | 4242 | result = {} |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4243 | for issue in args: |
Lei Zhang | 5a368d4 | 2019-03-25 23:18:19 +0000 | [diff] [blame] | 4244 | try: |
| 4245 | issue_num = int(issue) |
| 4246 | except ValueError: |
| 4247 | print('ERROR cannot parse issue number: %s' % issue, file=sys.stderr) |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4248 | continue |
Lei Zhang | 5a368d4 | 2019-03-25 23:18:19 +0000 | [diff] [blame] | 4249 | result[issue_num] = issue_branch_map.get(issue_num) |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4250 | print('Branch for issue number %s: %s' % ( |
Lei Zhang | 5a368d4 | 2019-03-25 23:18:19 +0000 | [diff] [blame] | 4251 | issue, ', '.join(issue_branch_map.get(issue_num) or ('None',)))) |
phajdan.jr | e328cf9 | 2016-08-22 04:12:17 -0700 | [diff] [blame] | 4252 | if options.json: |
| 4253 | write_json(options.json, result) |
Aaron Gable | 78753da | 2017-06-15 10:35:49 -0700 | [diff] [blame] | 4254 | return 0 |
| 4255 | |
| 4256 | if len(args) > 0: |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 4257 | issue = ParseIssueNumberArgument(args[0]) |
Aaron Gable | 78753da | 2017-06-15 10:35:49 -0700 | [diff] [blame] | 4258 | if not issue.valid: |
| 4259 | DieWithError('Pass a url or number to set the issue, 0 to unset it, ' |
| 4260 | 'or no argument to list it.\n' |
| 4261 | 'Maybe you want to run git cl status?') |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 4262 | cl = Changelist() |
Aaron Gable | 78753da | 2017-06-15 10:35:49 -0700 | [diff] [blame] | 4263 | cl.SetIssue(issue.issue) |
dnj@chromium.org | 406c440 | 2015-03-03 17:22:28 +0000 | [diff] [blame] | 4264 | else: |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 4265 | cl = Changelist() |
Aaron Gable | 78753da | 2017-06-15 10:35:49 -0700 | [diff] [blame] | 4266 | print('Issue number: %s (%s)' % (cl.GetIssue(), cl.GetIssueURL())) |
| 4267 | if options.json: |
| 4268 | write_json(options.json, { |
Nodir Turakulov | 2737963 | 2021-03-17 18:53:29 +0000 | [diff] [blame] | 4269 | 'gerrit_host': cl.GetGerritHost(), |
| 4270 | 'gerrit_project': cl.GetGerritProject(), |
Aaron Gable | 78753da | 2017-06-15 10:35:49 -0700 | [diff] [blame] | 4271 | 'issue_url': cl.GetIssueURL(), |
Nodir Turakulov | 2737963 | 2021-03-17 18:53:29 +0000 | [diff] [blame] | 4272 | 'issue': cl.GetIssue(), |
Aaron Gable | 78753da | 2017-06-15 10:35:49 -0700 | [diff] [blame] | 4273 | }) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4274 | return 0 |
| 4275 | |
| 4276 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4277 | @metrics.collector.collect_metrics('git cl comments') |
maruel@chromium.org | 9977a2e | 2012-06-06 22:30:56 +0000 | [diff] [blame] | 4278 | def CMDcomments(parser, args): |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4279 | """Shows or posts review comments for any changelist.""" |
| 4280 | parser.add_option('-a', '--add-comment', dest='comment', |
| 4281 | help='comment to add to an issue') |
Sergiy Byelozyorov | cb629a4 | 2018-10-28 19:20:39 +0000 | [diff] [blame] | 4282 | parser.add_option('-p', '--publish', action='store_true', |
| 4283 | help='marks CL as ready and sends comment to reviewers') |
Andrii Shyshkalov | 0d6b46e | 2017-03-17 22:23:22 +0100 | [diff] [blame] | 4284 | parser.add_option('-i', '--issue', dest='issue', |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 4285 | help='review issue id (defaults to current issue).') |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 4286 | parser.add_option('-m', '--machine-readable', dest='readable', |
| 4287 | action='store_false', default=True, |
| 4288 | help='output comments in a format compatible with ' |
| 4289 | 'editor parsing') |
smut@google.com | c85ac94 | 2015-09-15 16:34:43 +0000 | [diff] [blame] | 4290 | parser.add_option('-j', '--json-file', |
Stefan Zager | 1306bd0 | 2017-06-22 19:26:46 -0700 | [diff] [blame] | 4291 | help='File to write JSON summary to, or "-" for stdout') |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4292 | options, args = parser.parse_args(args) |
maruel@chromium.org | 9977a2e | 2012-06-06 22:30:56 +0000 | [diff] [blame] | 4293 | |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4294 | issue = None |
| 4295 | if options.issue: |
| 4296 | try: |
| 4297 | issue = int(options.issue) |
| 4298 | except ValueError: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 4299 | DieWithError('A review issue ID is expected to be a number.') |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4300 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 4301 | cl = Changelist(issue=issue) |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4302 | |
| 4303 | if options.comment: |
Sergiy Byelozyorov | cb629a4 | 2018-10-28 19:20:39 +0000 | [diff] [blame] | 4304 | cl.AddComment(options.comment, options.publish) |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4305 | return 0 |
| 4306 | |
Aaron Gable | 0ffdf2d | 2017-06-05 13:01:17 -0700 | [diff] [blame] | 4307 | summary = sorted(cl.GetCommentsSummary(readable=options.readable), |
| 4308 | key=lambda c: c.date) |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 4309 | for comment in summary: |
| 4310 | if comment.disapproval: |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4311 | color = Fore.RED |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 4312 | elif comment.approval: |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4313 | color = Fore.GREEN |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 4314 | elif comment.sender == cl.GetIssueOwner(): |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4315 | color = Fore.MAGENTA |
Quinten Yearsley | 0e617c0 | 2019-02-20 00:37:03 +0000 | [diff] [blame] | 4316 | elif comment.autogenerated: |
| 4317 | color = Fore.CYAN |
apavlov@chromium.org | e4efd51 | 2014-11-05 09:05:29 +0000 | [diff] [blame] | 4318 | else: |
| 4319 | color = Fore.BLUE |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 4320 | print('\n%s%s %s%s\n%s' % ( |
| 4321 | color, |
| 4322 | comment.date.strftime('%Y-%m-%d %H:%M:%S UTC'), |
| 4323 | comment.sender, |
| 4324 | Fore.RESET, |
| 4325 | '\n'.join(' ' + l for l in comment.message.strip().splitlines()))) |
| 4326 | |
smut@google.com | c85ac94 | 2015-09-15 16:34:43 +0000 | [diff] [blame] | 4327 | if options.json_file: |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 4328 | def pre_serialize(c): |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 4329 | dct = c._asdict().copy() |
Andrii Shyshkalov | d8aa49f | 2017-03-17 16:05:49 +0100 | [diff] [blame] | 4330 | dct['date'] = dct['date'].strftime('%Y-%m-%d %H:%M:%S.%f') |
| 4331 | return dct |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 4332 | write_json(options.json_file, [pre_serialize(x) for x in summary]) |
maruel@chromium.org | 9977a2e | 2012-06-06 22:30:56 +0000 | [diff] [blame] | 4333 | return 0 |
| 4334 | |
| 4335 | |
martiniss@chromium.org | 2b55fe3 | 2016-04-26 20:28:54 +0000 | [diff] [blame] | 4336 | @subcommand.usage('[codereview url or issue id]') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4337 | @metrics.collector.collect_metrics('git cl description') |
rsesek@chromium.org | eec7659 | 2013-05-20 16:27:57 +0000 | [diff] [blame] | 4338 | def CMDdescription(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 4339 | """Brings up the editor for the current CL's description.""" |
smut@google.com | 34fb6b1 | 2015-07-13 20:03:26 +0000 | [diff] [blame] | 4340 | parser.add_option('-d', '--display', action='store_true', |
| 4341 | help='Display the description instead of opening an editor') |
martiniss@chromium.org | d6648e2 | 2016-04-29 19:22:16 +0000 | [diff] [blame] | 4342 | parser.add_option('-n', '--new-description', |
dnj | ba1b0f3 | 2016-09-02 12:37:42 -0700 | [diff] [blame] | 4343 | help='New description to set for this issue (- for stdin, ' |
| 4344 | '+ to load from local commit HEAD)') |
dsansome | e2d6fd9 | 2016-09-08 00:10:47 -0700 | [diff] [blame] | 4345 | parser.add_option('-f', '--force', action='store_true', |
| 4346 | help='Delete any unpublished Gerrit edits for this issue ' |
| 4347 | 'without prompting') |
martiniss@chromium.org | 2b55fe3 | 2016-04-26 20:28:54 +0000 | [diff] [blame] | 4348 | |
martiniss@chromium.org | 2b55fe3 | 2016-04-26 20:28:54 +0000 | [diff] [blame] | 4349 | options, args = parser.parse_args(args) |
martiniss@chromium.org | 2b55fe3 | 2016-04-26 20:28:54 +0000 | [diff] [blame] | 4350 | |
Andrii Shyshkalov | 8039be7 | 2017-01-26 09:38:18 +0100 | [diff] [blame] | 4351 | target_issue_arg = None |
martiniss@chromium.org | 2b55fe3 | 2016-04-26 20:28:54 +0000 | [diff] [blame] | 4352 | if len(args) > 0: |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 4353 | target_issue_arg = ParseIssueNumberArgument(args[0]) |
Andrii Shyshkalov | 8039be7 | 2017-01-26 09:38:18 +0100 | [diff] [blame] | 4354 | if not target_issue_arg.valid: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 4355 | parser.error('Invalid issue ID or URL.') |
martiniss@chromium.org | 2b55fe3 | 2016-04-26 20:28:54 +0000 | [diff] [blame] | 4356 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 4357 | kwargs = {} |
Andrii Shyshkalov | 8039be7 | 2017-01-26 09:38:18 +0100 | [diff] [blame] | 4358 | if target_issue_arg: |
| 4359 | kwargs['issue'] = target_issue_arg.issue |
| 4360 | kwargs['codereview_host'] = target_issue_arg.hostname |
martiniss | 6eda05f | 2016-06-30 10:18:35 -0700 | [diff] [blame] | 4361 | |
| 4362 | cl = Changelist(**kwargs) |
rsesek@chromium.org | eec7659 | 2013-05-20 16:27:57 +0000 | [diff] [blame] | 4363 | if not cl.GetIssue(): |
| 4364 | DieWithError('This branch has no associated changelist.') |
Andrii Shyshkalov | c971239 | 2017-04-11 13:35:21 +0200 | [diff] [blame] | 4365 | |
Edward Lemur | 678a684 | 2019-10-03 22:25:05 +0000 | [diff] [blame] | 4366 | if args and not args[0].isdigit(): |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 4367 | logging.info('canonical issue/change URL: %s\n', cl.GetIssueURL()) |
Andrii Shyshkalov | c971239 | 2017-04-11 13:35:21 +0200 | [diff] [blame] | 4368 | |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 4369 | description = ChangeDescription(cl.FetchDescription()) |
martiniss@chromium.org | d6648e2 | 2016-04-29 19:22:16 +0000 | [diff] [blame] | 4370 | |
smut@google.com | 34fb6b1 | 2015-07-13 20:03:26 +0000 | [diff] [blame] | 4371 | if options.display: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4372 | print(description.description) |
smut@google.com | 34fb6b1 | 2015-07-13 20:03:26 +0000 | [diff] [blame] | 4373 | return 0 |
martiniss@chromium.org | d6648e2 | 2016-04-29 19:22:16 +0000 | [diff] [blame] | 4374 | |
| 4375 | if options.new_description: |
| 4376 | text = options.new_description |
| 4377 | if text == '-': |
| 4378 | text = '\n'.join(l.rstrip() for l in sys.stdin) |
dnj | ba1b0f3 | 2016-09-02 12:37:42 -0700 | [diff] [blame] | 4379 | elif text == '+': |
| 4380 | base_branch = cl.GetCommonAncestorWithUpstream() |
Edward Lemur | a12175c | 2020-03-09 16:58:26 +0000 | [diff] [blame] | 4381 | text = _create_description_from_log([base_branch]) |
martiniss@chromium.org | d6648e2 | 2016-04-29 19:22:16 +0000 | [diff] [blame] | 4382 | |
| 4383 | description.set_description(text) |
| 4384 | else: |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 4385 | description.prompt() |
Edward Lemur | 6c6827c | 2020-02-06 21:15:18 +0000 | [diff] [blame] | 4386 | if cl.FetchDescription().strip() != description.description: |
dsansome | e2d6fd9 | 2016-09-08 00:10:47 -0700 | [diff] [blame] | 4387 | cl.UpdateDescription(description.description, force=options.force) |
rsesek@chromium.org | eec7659 | 2013-05-20 16:27:57 +0000 | [diff] [blame] | 4388 | return 0 |
| 4389 | |
| 4390 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4391 | @metrics.collector.collect_metrics('git cl lint') |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4392 | def CMDlint(parser, args): |
| 4393 | """Runs cpplint on the current changelist.""" |
tzik@chromium.org | f204d4b | 2014-03-13 07:40:55 +0000 | [diff] [blame] | 4394 | parser.add_option('--filter', action='append', metavar='-x,+y', |
| 4395 | help='Comma-separated list of cpplint\'s category-filters') |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 4396 | options, args = parser.parse_args(args) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4397 | |
| 4398 | # Access to a protected member _XX of a client class |
Quinten Yearsley | b2cc4a9 | 2016-12-15 13:53:26 -0800 | [diff] [blame] | 4399 | # pylint: disable=protected-access |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4400 | try: |
| 4401 | import cpplint |
| 4402 | import cpplint_chromium |
| 4403 | except ImportError: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4404 | print('Your depot_tools is missing cpplint.py and/or cpplint_chromium.py.') |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4405 | return 1 |
| 4406 | |
| 4407 | # Change the current working directory before calling lint so that it |
| 4408 | # shows the correct base. |
| 4409 | previous_cwd = os.getcwd() |
| 4410 | os.chdir(settings.GetRoot()) |
| 4411 | try: |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 4412 | cl = Changelist() |
Edward Lemur | 2c62b33 | 2020-03-12 22:12:33 +0000 | [diff] [blame] | 4413 | files = cl.GetAffectedFiles(cl.GetCommonAncestorWithUpstream()) |
thestig@chromium.org | 5839eb5 | 2014-05-30 16:20:51 +0000 | [diff] [blame] | 4414 | if not files: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4415 | print('Cannot lint an empty CL') |
thestig@chromium.org | 5839eb5 | 2014-05-30 16:20:51 +0000 | [diff] [blame] | 4416 | return 1 |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4417 | |
Lei Zhang | b8c62cf | 2020-07-15 20:09:37 +0000 | [diff] [blame] | 4418 | # Process cpplint arguments, if any. |
| 4419 | filters = presubmit_canned_checks.GetCppLintFilters(options.filter) |
| 4420 | command = ['--filter=' + ','.join(filters)] + args + files |
tzik@chromium.org | f204d4b | 2014-03-13 07:40:55 +0000 | [diff] [blame] | 4421 | filenames = cpplint.ParseArguments(command) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4422 | |
Lei Zhang | 379d1ad | 2020-07-15 19:40:06 +0000 | [diff] [blame] | 4423 | include_regex = re.compile(settings.GetLintRegex()) |
| 4424 | ignore_regex = re.compile(settings.GetLintIgnoreRegex()) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4425 | extra_check_functions = [cpplint_chromium.CheckPointerDeclarationWhitespace] |
| 4426 | for filename in filenames: |
Lei Zhang | 379d1ad | 2020-07-15 19:40:06 +0000 | [diff] [blame] | 4427 | if not include_regex.match(filename): |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4428 | print('Skipping file %s' % filename) |
Lei Zhang | 379d1ad | 2020-07-15 19:40:06 +0000 | [diff] [blame] | 4429 | continue |
| 4430 | |
| 4431 | if ignore_regex.match(filename): |
| 4432 | print('Ignoring file %s' % filename) |
| 4433 | continue |
| 4434 | |
| 4435 | cpplint.ProcessFile(filename, cpplint._cpplint_state.verbose_level, |
| 4436 | extra_check_functions) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4437 | finally: |
| 4438 | os.chdir(previous_cwd) |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4439 | print('Total errors found: %d\n' % cpplint._cpplint_state.error_count) |
thestig@chromium.org | 44202a2 | 2014-03-11 19:22:18 +0000 | [diff] [blame] | 4440 | if cpplint._cpplint_state.error_count != 0: |
| 4441 | return 1 |
| 4442 | return 0 |
| 4443 | |
| 4444 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4445 | @metrics.collector.collect_metrics('git cl presubmit') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4446 | def CMDpresubmit(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 4447 | """Runs presubmit tests on the current changelist.""" |
ilevy@chromium.org | 375a902 | 2013-01-07 01:12:05 +0000 | [diff] [blame] | 4448 | parser.add_option('-u', '--upload', action='store_true', |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 4449 | help='Run upload hook instead of the push hook') |
ilevy@chromium.org | 375a902 | 2013-01-07 01:12:05 +0000 | [diff] [blame] | 4450 | parser.add_option('-f', '--force', action='store_true', |
sbc@chromium.org | 495ad15 | 2012-09-04 23:07:42 +0000 | [diff] [blame] | 4451 | help='Run checks even if tree is dirty') |
Aaron Gable | 8076c28 | 2017-11-29 14:39:41 -0800 | [diff] [blame] | 4452 | parser.add_option('--all', action='store_true', |
| 4453 | help='Run checks against all files, not just modified ones') |
Josip Sokcevic | 017544d | 2022-03-31 23:47:53 +0000 | [diff] [blame] | 4454 | parser.add_option('--files', |
| 4455 | nargs=1, |
| 4456 | help='Semicolon-separated list of files to be marked as ' |
| 4457 | 'modified when executing presubmit or post-upload hooks. ' |
| 4458 | 'fnmatch wildcards can also be used.') |
Edward Lesmes | 8e28279 | 2018-04-03 18:50:29 -0400 | [diff] [blame] | 4459 | parser.add_option('--parallel', action='store_true', |
| 4460 | help='Run all tests specified by input_api.RunTests in all ' |
| 4461 | 'PRESUBMIT files in parallel.') |
Saagar Sanghavi | 9949ab7 | 2020-07-20 20:56:40 +0000 | [diff] [blame] | 4462 | parser.add_option('--resultdb', action='store_true', |
| 4463 | help='Run presubmit checks in the ResultSink environment ' |
| 4464 | 'and send results to the ResultDB database.') |
Saagar Sanghavi | 03b1513 | 2020-08-10 16:43:41 +0000 | [diff] [blame] | 4465 | parser.add_option('--realm', help='LUCI realm if reporting to ResultDB') |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 4466 | options, args = parser.parse_args(args) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4467 | |
sbc@chromium.org | 71437c0 | 2015-04-09 19:29:40 +0000 | [diff] [blame] | 4468 | if not options.force and git_common.is_dirty_git_tree('presubmit'): |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 4469 | print('use --force to check even if tree is dirty.') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4470 | return 1 |
| 4471 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 4472 | cl = Changelist() |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4473 | if args: |
| 4474 | base_branch = args[0] |
| 4475 | else: |
ilevy@chromium.org | 0f58fa8 | 2012-11-05 01:45:20 +0000 | [diff] [blame] | 4476 | # Default to diffing against the common ancestor of the upstream branch. |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 4477 | base_branch = cl.GetCommonAncestorWithUpstream() |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4478 | |
Bruce Dawson | eb8426e | 2022-08-05 23:58:15 +0000 | [diff] [blame] | 4479 | start = time.time() |
| 4480 | try: |
| 4481 | if not 'PRESUBMIT_SKIP_NETWORK' in os.environ and cl.GetIssue(): |
| 4482 | description = cl.FetchDescription() |
| 4483 | else: |
| 4484 | description = _create_description_from_log([base_branch]) |
| 4485 | except Exception as e: |
| 4486 | print('Failed to fetch CL description - %s' % str(e)) |
Edward Lemur | a12175c | 2020-03-09 16:58:26 +0000 | [diff] [blame] | 4487 | description = _create_description_from_log([base_branch]) |
Bruce Dawson | eb8426e | 2022-08-05 23:58:15 +0000 | [diff] [blame] | 4488 | elapsed = time.time() - start |
| 4489 | if elapsed > 5: |
| 4490 | print('%.1f s to get CL description.' % elapsed) |
Aaron Gable | 8076c28 | 2017-11-29 14:39:41 -0800 | [diff] [blame] | 4491 | |
Bruce Dawson | 13acea3 | 2022-05-03 22:13:08 +0000 | [diff] [blame] | 4492 | if not base_branch: |
| 4493 | if not options.force: |
| 4494 | print('use --force to check even when not on a branch.') |
| 4495 | return 1 |
| 4496 | base_branch = 'HEAD' |
| 4497 | |
Josip Sokcevic | 017544d | 2022-03-31 23:47:53 +0000 | [diff] [blame] | 4498 | cl.RunHook(committing=not options.upload, |
| 4499 | may_prompt=False, |
| 4500 | verbose=options.verbose, |
| 4501 | parallel=options.parallel, |
| 4502 | upstream=base_branch, |
| 4503 | description=description, |
| 4504 | all_files=options.all, |
| 4505 | files=options.files, |
| 4506 | resultdb=options.resultdb, |
| 4507 | realm=options.realm) |
dpranke@chromium.org | 0a2bb37 | 2011-03-25 01:16:22 +0000 | [diff] [blame] | 4508 | return 0 |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 4509 | |
| 4510 | |
tandrii@chromium.org | 65874e1 | 2016-03-04 12:03:02 +0000 | [diff] [blame] | 4511 | def GenerateGerritChangeId(message): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 4512 | """Returns the Change ID footer value (Ixxxxxx...xxx). |
tandrii@chromium.org | 65874e1 | 2016-03-04 12:03:02 +0000 | [diff] [blame] | 4513 | |
| 4514 | Works the same way as |
| 4515 | https://gerrit-review.googlesource.com/tools/hooks/commit-msg |
| 4516 | but can be called on demand on all platforms. |
| 4517 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 4518 | The basic idea is to generate git hash of a state of the tree, original |
| 4519 | commit message, author/committer info and timestamps. |
tandrii@chromium.org | 65874e1 | 2016-03-04 12:03:02 +0000 | [diff] [blame] | 4520 | """ |
| 4521 | lines = [] |
| 4522 | tree_hash = RunGitSilent(['write-tree']) |
| 4523 | lines.append('tree %s' % tree_hash.strip()) |
| 4524 | code, parent = RunGitWithCode(['rev-parse', 'HEAD~0'], suppress_stderr=False) |
| 4525 | if code == 0: |
| 4526 | lines.append('parent %s' % parent.strip()) |
| 4527 | author = RunGitSilent(['var', 'GIT_AUTHOR_IDENT']) |
| 4528 | lines.append('author %s' % author.strip()) |
| 4529 | committer = RunGitSilent(['var', 'GIT_COMMITTER_IDENT']) |
| 4530 | lines.append('committer %s' % committer.strip()) |
| 4531 | lines.append('') |
| 4532 | # Note: Gerrit's commit-hook actually cleans message of some lines and |
| 4533 | # whitespace. This code is not doing this, but it clearly won't decrease |
| 4534 | # entropy. |
| 4535 | lines.append(message) |
| 4536 | change_hash = RunCommand(['git', 'hash-object', '-t', 'commit', '--stdin'], |
Raul Tambre | b946b23 | 2019-03-26 14:48:46 +0000 | [diff] [blame] | 4537 | stdin=('\n'.join(lines)).encode()) |
tandrii@chromium.org | 65874e1 | 2016-03-04 12:03:02 +0000 | [diff] [blame] | 4538 | return 'I%s' % change_hash.strip() |
| 4539 | |
| 4540 | |
Andrii Shyshkalov | f3a20ae | 2017-01-24 21:23:57 +0100 | [diff] [blame] | 4541 | def GetTargetRef(remote, remote_branch, target_branch): |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4542 | """Computes the remote branch ref to use for the CL. |
| 4543 | |
| 4544 | Args: |
| 4545 | remote (str): The git remote for the CL. |
| 4546 | remote_branch (str): The git remote branch for the CL. |
| 4547 | target_branch (str): The target branch specified by the user. |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4548 | """ |
| 4549 | if not (remote and remote_branch): |
| 4550 | return None |
bauerb@chromium.org | 27386dd | 2015-02-16 10:45:39 +0000 | [diff] [blame] | 4551 | |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4552 | if target_branch: |
Quinten Yearsley | 0c62da9 | 2017-05-31 13:39:42 -0700 | [diff] [blame] | 4553 | # Canonicalize branch references to the equivalent local full symbolic |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4554 | # refs, which are then translated into the remote full symbolic refs |
| 4555 | # below. |
| 4556 | if '/' not in target_branch: |
| 4557 | remote_branch = 'refs/remotes/%s/%s' % (remote, target_branch) |
| 4558 | else: |
| 4559 | prefix_replacements = ( |
| 4560 | ('^((refs/)?remotes/)?branch-heads/', 'refs/remotes/branch-heads/'), |
| 4561 | ('^((refs/)?remotes/)?%s/' % remote, 'refs/remotes/%s/' % remote), |
| 4562 | ('^(refs/)?heads/', 'refs/remotes/%s/' % remote), |
| 4563 | ) |
| 4564 | match = None |
| 4565 | for regex, replacement in prefix_replacements: |
| 4566 | match = re.search(regex, target_branch) |
| 4567 | if match: |
| 4568 | remote_branch = target_branch.replace(match.group(0), replacement) |
| 4569 | break |
| 4570 | if not match: |
| 4571 | # This is a branch path but not one we recognize; use as-is. |
| 4572 | remote_branch = target_branch |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 4573 | # pylint: disable=consider-using-get |
rmistry@google.com | c68112d | 2015-03-03 12:48:06 +0000 | [diff] [blame] | 4574 | elif remote_branch in REFS_THAT_ALIAS_TO_OTHER_REFS: |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 4575 | # pylint: enable=consider-using-get |
rmistry@google.com | c68112d | 2015-03-03 12:48:06 +0000 | [diff] [blame] | 4576 | # Handle the refs that need to land in different refs. |
| 4577 | remote_branch = REFS_THAT_ALIAS_TO_OTHER_REFS[remote_branch] |
bauerb@chromium.org | 27386dd | 2015-02-16 10:45:39 +0000 | [diff] [blame] | 4578 | |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4579 | # Create the true path to the remote branch. |
| 4580 | # Does the following translation: |
| 4581 | # * refs/remotes/origin/refs/diff/test -> refs/diff/test |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 4582 | # * refs/remotes/origin/main -> refs/heads/main |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4583 | # * refs/remotes/branch-heads/test -> refs/branch-heads/test |
| 4584 | if remote_branch.startswith('refs/remotes/%s/refs/' % remote): |
| 4585 | remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, '') |
| 4586 | elif remote_branch.startswith('refs/remotes/%s/' % remote): |
| 4587 | remote_branch = remote_branch.replace('refs/remotes/%s/' % remote, |
| 4588 | 'refs/heads/') |
| 4589 | elif remote_branch.startswith('refs/remotes/branch-heads'): |
| 4590 | remote_branch = remote_branch.replace('refs/remotes/', 'refs/') |
Andrii Shyshkalov | 768f1d8 | 2016-12-08 15:10:13 +0100 | [diff] [blame] | 4591 | |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4592 | return remote_branch |
| 4593 | |
| 4594 | |
maruel@chromium.org | eb52a5c | 2013-04-10 23:17:09 +0000 | [diff] [blame] | 4595 | def cleanup_list(l): |
| 4596 | """Fixes a list so that comma separated items are put as individual items. |
| 4597 | |
| 4598 | So that "--reviewers joe@c,john@c --reviewers joa@c" results in |
| 4599 | options.reviewers == sorted(['joe@c', 'john@c', 'joa@c']). |
| 4600 | """ |
| 4601 | items = sum((i.split(',') for i in l), []) |
| 4602 | stripped_items = (i.strip() for i in items) |
| 4603 | return sorted(filter(None, stripped_items)) |
| 4604 | |
| 4605 | |
Aaron Gable | 4db38df | 2017-11-03 14:59:07 -0700 | [diff] [blame] | 4606 | @subcommand.usage('[flags]') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4607 | @metrics.collector.collect_metrics('git cl upload') |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4608 | def CMDupload(parser, args): |
rmistry@google.com | 78948ed | 2015-07-08 23:09:57 +0000 | [diff] [blame] | 4609 | """Uploads the current changelist to codereview. |
| 4610 | |
| 4611 | Can skip dependency patchset uploads for a branch by running: |
| 4612 | git config branch.branch_name.skip-deps-uploads True |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 4613 | To unset, run: |
rmistry@google.com | 78948ed | 2015-07-08 23:09:57 +0000 | [diff] [blame] | 4614 | git config --unset branch.branch_name.skip-deps-uploads |
| 4615 | Can also set the above globally by using the --global flag. |
Dominic Battre | 7d1c484 | 2017-10-27 09:17:28 +0200 | [diff] [blame] | 4616 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 4617 | If the name of the checked out branch starts with "bug-" or "fix-" followed |
| 4618 | by a bug number, this bug number is automatically populated in the CL |
Dominic Battre | 7d1c484 | 2017-10-27 09:17:28 +0200 | [diff] [blame] | 4619 | description. |
Nodir Turakulov | d0e2cd2 | 2017-11-15 10:22:06 -0800 | [diff] [blame] | 4620 | |
| 4621 | If subject contains text in square brackets or has "<text>: " prefix, such |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 4622 | text(s) is treated as Gerrit hashtags. For example, CLs with subjects: |
Nodir Turakulov | d0e2cd2 | 2017-11-15 10:22:06 -0800 | [diff] [blame] | 4623 | [git-cl] add support for hashtags |
| 4624 | Foo bar: implement foo |
| 4625 | will be hashtagged with "git-cl" and "foo-bar" respectively. |
rmistry@google.com | 78948ed | 2015-07-08 23:09:57 +0000 | [diff] [blame] | 4626 | """ |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4627 | parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks', |
| 4628 | help='bypass upload presubmit hook') |
brettw@chromium.org | b65c43c | 2013-06-10 22:04:49 +0000 | [diff] [blame] | 4629 | parser.add_option('--bypass-watchlists', action='store_true', |
| 4630 | dest='bypass_watchlists', |
| 4631 | help='bypass watchlists auto CC-ing reviewers') |
Aaron Gable | f7543cd | 2017-07-20 14:26:31 -0700 | [diff] [blame] | 4632 | parser.add_option('-f', '--force', action='store_true', dest='force', |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4633 | help="force yes to questions (don't prompt)") |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 4634 | parser.add_option('--message', '-m', dest='message', |
| 4635 | help='message for patchset') |
tandrii | f9aefb7 | 2016-07-01 09:06:51 -0700 | [diff] [blame] | 4636 | parser.add_option('-b', '--bug', |
| 4637 | help='pre-populate the bug number(s) for this issue. ' |
| 4638 | 'If several, separate with commas') |
tandrii | b80458a | 2016-06-23 12:20:07 -0700 | [diff] [blame] | 4639 | parser.add_option('--message-file', dest='message_file', |
| 4640 | help='file which contains message for patchset') |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 4641 | parser.add_option('--title', '-t', dest='title', |
| 4642 | help='title for patchset') |
Mario Bianucci | cebfb4e | 2020-07-22 23:08:16 +0000 | [diff] [blame] | 4643 | parser.add_option('-T', '--skip-title', action='store_true', |
| 4644 | dest='skip_title', |
| 4645 | help='Use the most recent commit message as the title of ' |
| 4646 | 'the patchset') |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4647 | parser.add_option('-r', '--reviewers', |
maruel@chromium.org | eb52a5c | 2013-04-10 23:17:09 +0000 | [diff] [blame] | 4648 | action='append', default=[], |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4649 | help='reviewer email addresses') |
| 4650 | parser.add_option('--cc', |
maruel@chromium.org | eb52a5c | 2013-04-10 23:17:09 +0000 | [diff] [blame] | 4651 | action='append', default=[], |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4652 | help='cc email addresses') |
Nodir Turakulov | d0e2cd2 | 2017-11-15 10:22:06 -0800 | [diff] [blame] | 4653 | parser.add_option('--hashtag', dest='hashtags', |
| 4654 | action='append', default=[], |
| 4655 | help=('Gerrit hashtag for new CL; ' |
| 4656 | 'can be applied multiple times')) |
Thiago Perrotta | b0fb8d5 | 2022-08-30 21:26:19 +0000 | [diff] [blame] | 4657 | parser.add_option('-s', |
| 4658 | '--send-mail', |
| 4659 | '--send-email', |
| 4660 | dest='send_mail', |
| 4661 | action='store_true', |
Aaron Gable | 59f4851 | 2017-01-12 10:54:46 -0800 | [diff] [blame] | 4662 | help='send email to reviewer(s) and cc(s) immediately') |
ukai@chromium.org | 8ef7ab2 | 2012-11-28 04:24:52 +0000 | [diff] [blame] | 4663 | parser.add_option('--target_branch', |
pgervais@chromium.org | b9f2751 | 2014-08-08 15:52:33 +0000 | [diff] [blame] | 4664 | '--target-branch', |
wittman@chromium.org | 455dc92 | 2015-01-26 20:15:50 +0000 | [diff] [blame] | 4665 | metavar='TARGET', |
| 4666 | help='Apply CL to remote ref TARGET. ' + |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 4667 | 'Default: remote branch head, or main') |
bauerb@chromium.org | 27386dd | 2015-02-16 10:45:39 +0000 | [diff] [blame] | 4668 | parser.add_option('--squash', action='store_true', |
Nodir Turakulov | d0e2cd2 | 2017-11-15 10:22:06 -0800 | [diff] [blame] | 4669 | help='Squash multiple commits into one') |
Mike Frysinger | a989d55 | 2019-08-14 20:51:23 +0000 | [diff] [blame] | 4670 | parser.add_option('--no-squash', action='store_false', dest='squash', |
Nodir Turakulov | d0e2cd2 | 2017-11-15 10:22:06 -0800 | [diff] [blame] | 4671 | help='Don\'t squash multiple commits into one') |
rmistry | 9eadede | 2016-09-19 11:22:43 -0700 | [diff] [blame] | 4672 | parser.add_option('--topic', default=None, |
Nodir Turakulov | d0e2cd2 | 2017-11-15 10:22:06 -0800 | [diff] [blame] | 4673 | help='Topic to specify when uploading') |
Robert Iannucci | f2708bd | 2017-04-17 15:49:02 -0700 | [diff] [blame] | 4674 | parser.add_option('--r-owners', dest='add_owners_to', action='store_const', |
| 4675 | const='R', help='add a set of OWNERS to R') |
Thiago Perrotta | b0fb8d5 | 2022-08-30 21:26:19 +0000 | [diff] [blame] | 4676 | parser.add_option('-c', |
| 4677 | '--use-commit-queue', |
| 4678 | action='store_true', |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4679 | default=False, |
Andrii Shyshkalov | 0e889b7 | 2019-07-15 22:28:48 +0000 | [diff] [blame] | 4680 | help='tell the CQ to commit this patchset; ' |
Thiago Perrotta | b0fb8d5 | 2022-08-30 21:26:19 +0000 | [diff] [blame] | 4681 | 'implies --send-mail') |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4682 | parser.add_option('-d', '--cq-dry-run', |
| 4683 | action='store_true', default=False, |
rmistry@google.com | ef96622 | 2015-04-07 11:15:01 +0000 | [diff] [blame] | 4684 | help='Send the patchset to do a CQ dry run right after ' |
| 4685 | 'upload.') |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 4686 | parser.add_option( |
| 4687 | '-q', |
| 4688 | '--cq-quick-run', |
| 4689 | action='store_true', |
| 4690 | default=False, |
| 4691 | help='Send the patchset to do a CQ quick run right after ' |
| 4692 | 'upload (https://source.chromium.org/chromium/chromium/src/+/main:do' |
| 4693 | 'cs/cq_quick_run.md) (chromium only).') |
Edward Lesmes | 10c3dd6 | 2021-02-08 21:13:57 +0000 | [diff] [blame] | 4694 | parser.add_option('--set-bot-commit', action='store_true', |
| 4695 | help=optparse.SUPPRESS_HELP) |
Andrii Shyshkalov | 71f0da3 | 2019-07-15 22:45:18 +0000 | [diff] [blame] | 4696 | parser.add_option('--preserve-tryjobs', action='store_true', |
| 4697 | help='instruct the CQ to let tryjobs running even after ' |
| 4698 | 'new patchsets are uploaded instead of canceling ' |
| 4699 | 'prior patchset\' tryjobs') |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 4700 | parser.add_option('--dependencies', action='store_true', |
| 4701 | help='Uploads CLs of all the local branches that depend on ' |
| 4702 | 'the current branch') |
Ravi Mistry | 31e7d56 | 2018-04-02 12:53:57 -0400 | [diff] [blame] | 4703 | parser.add_option('-a', '--enable-auto-submit', action='store_true', |
| 4704 | help='Sends your change to the CQ after an approval. Only ' |
| 4705 | 'works on repos that have the Auto-Submit label ' |
| 4706 | 'enabled') |
Edward Lesmes | 8e28279 | 2018-04-03 18:50:29 -0400 | [diff] [blame] | 4707 | parser.add_option('--parallel', action='store_true', |
| 4708 | help='Run all tests specified by input_api.RunTests in all ' |
| 4709 | 'PRESUBMIT files in parallel.') |
Sergiy Byelozyorov | 1aa405f | 2018-09-18 17:38:43 +0000 | [diff] [blame] | 4710 | parser.add_option('--no-autocc', action='store_true', |
| 4711 | help='Disables automatic addition of CC emails') |
Nodir Turakulov | d0e2cd2 | 2017-11-15 10:22:06 -0800 | [diff] [blame] | 4712 | parser.add_option('--private', action='store_true', |
Sergiy Byelozyorov | 1aa405f | 2018-09-18 17:38:43 +0000 | [diff] [blame] | 4713 | help='Set the review private. This implies --no-autocc.') |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4714 | parser.add_option('-R', '--retry-failed', action='store_true', |
| 4715 | help='Retry failed tryjobs from old patchset immediately ' |
| 4716 | 'after uploading new patchset. Cannot be used with ' |
| 4717 | '--use-commit-queue or --cq-dry-run.') |
Dan Beam | d8b04ca | 2019-10-10 21:23:26 +0000 | [diff] [blame] | 4718 | parser.add_option('--fixed', '-x', |
| 4719 | help='List of bugs that will be commented on and marked ' |
| 4720 | 'fixed (pre-populates "Fixed:" tag). Same format as ' |
| 4721 | '-b option / "Bug:" tag. If fixing several issues, ' |
| 4722 | 'separate with commas.') |
Josip | e827b0f | 2020-01-30 00:07:20 +0000 | [diff] [blame] | 4723 | parser.add_option('--edit-description', action='store_true', default=False, |
| 4724 | help='Modify description before upload. Cannot be used ' |
| 4725 | 'with --force. It is a noop when --no-squash is set ' |
| 4726 | 'or a new commit is created.') |
Ng Zhi An | cdaf0be | 2020-05-27 20:57:28 +0000 | [diff] [blame] | 4727 | parser.add_option('--git-completion-helper', action="store_true", |
| 4728 | help=optparse.SUPPRESS_HELP) |
Josip Sokcevic | f2cfd3d | 2021-03-30 18:39:18 +0000 | [diff] [blame] | 4729 | parser.add_option('-o', |
| 4730 | '--push-options', |
| 4731 | action='append', |
| 4732 | default=[], |
| 4733 | help='Transmit the given string to the server when ' |
| 4734 | 'performing git push (pass-through). See git-push ' |
| 4735 | 'documentation for more details.') |
Gregory Nisbet | 48d9e1e | 2021-04-15 23:35:54 +0000 | [diff] [blame] | 4736 | parser.add_option('--no-add-changeid', |
| 4737 | action='store_true', |
| 4738 | dest='no_add_changeid', |
| 4739 | help='Do not add change-ids to messages.') |
Brian Sheedy | 7326ca2 | 2022-11-02 18:36:17 +0000 | [diff] [blame] | 4740 | parser.add_option('--no-python2-post-upload-hooks', |
| 4741 | action='store_true', |
| 4742 | help='Only run post-upload hooks in Python 3.') |
Joanna Wang | a1abbed | 2023-01-24 01:41:05 +0000 | [diff] [blame] | 4743 | # TODO(b/265929888): Add --wip option of --cl-status option. |
Sergiy Byelozyorov | 1aa405f | 2018-09-18 17:38:43 +0000 | [diff] [blame] | 4744 | |
rmistry@google.com | 2dd9986 | 2015-06-22 12:22:18 +0000 | [diff] [blame] | 4745 | orig_args = args |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4746 | (options, args) = parser.parse_args(args) |
| 4747 | |
Ng Zhi An | cdaf0be | 2020-05-27 20:57:28 +0000 | [diff] [blame] | 4748 | if options.git_completion_helper: |
Edward Lesmes | b7db183 | 2020-06-22 20:22:27 +0000 | [diff] [blame] | 4749 | print(' '.join(opt.get_opt_string() for opt in parser.option_list |
| 4750 | if opt.help != optparse.SUPPRESS_HELP)) |
| 4751 | return |
Ng Zhi An | cdaf0be | 2020-05-27 20:57:28 +0000 | [diff] [blame] | 4752 | |
sbc@chromium.org | 71437c0 | 2015-04-09 19:29:40 +0000 | [diff] [blame] | 4753 | if git_common.is_dirty_git_tree('upload'): |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4754 | return 1 |
| 4755 | |
maruel@chromium.org | eb52a5c | 2013-04-10 23:17:09 +0000 | [diff] [blame] | 4756 | options.reviewers = cleanup_list(options.reviewers) |
| 4757 | options.cc = cleanup_list(options.cc) |
| 4758 | |
Josip | e827b0f | 2020-01-30 00:07:20 +0000 | [diff] [blame] | 4759 | if options.edit_description and options.force: |
| 4760 | parser.error('Only one of --force and --edit-description allowed') |
| 4761 | |
tandrii | b80458a | 2016-06-23 12:20:07 -0700 | [diff] [blame] | 4762 | if options.message_file: |
| 4763 | if options.message: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 4764 | parser.error('Only one of --message and --message-file allowed.') |
tandrii | b80458a | 2016-06-23 12:20:07 -0700 | [diff] [blame] | 4765 | options.message = gclient_utils.FileRead(options.message_file) |
tandrii | b80458a | 2016-06-23 12:20:07 -0700 | [diff] [blame] | 4766 | |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4767 | if ([options.cq_dry_run, |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 4768 | options.cq_quick_run, |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4769 | options.use_commit_queue, |
| 4770 | options.retry_failed].count(True) > 1): |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 4771 | parser.error('Only one of --use-commit-queue, --cq-dry-run, --cq-quick-run ' |
| 4772 | 'or --retry-failed is allowed.') |
tandrii | 4d0545a | 2016-07-06 03:56:49 -0700 | [diff] [blame] | 4773 | |
Mario Bianucci | cebfb4e | 2020-07-22 23:08:16 +0000 | [diff] [blame] | 4774 | if options.skip_title and options.title: |
| 4775 | parser.error('Only one of --title and --skip-title allowed.') |
| 4776 | |
Aaron Gable | edbc413 | 2017-09-11 13:22:28 -0700 | [diff] [blame] | 4777 | if options.use_commit_queue: |
| 4778 | options.send_mail = True |
| 4779 | |
Edward Lesmes | 0dd5482 | 2020-03-26 18:24:25 +0000 | [diff] [blame] | 4780 | if options.squash is None: |
| 4781 | # Load default for user, repo, squash=true, in this order. |
| 4782 | options.squash = settings.GetSquashGerritUploads() |
| 4783 | |
Joanna Wang | dd12deb | 2023-01-26 20:43:28 +0000 | [diff] [blame] | 4784 | if os.environ.get('DOGFOOD_STACKED_CHANGES') == '1': |
| 4785 | if options.dependencies: |
| 4786 | parser.error('--dependencies is not available for this workflow.') |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 4787 | |
| 4788 | UploadAllSquashed(options, orig_args) |
| 4789 | return 0 |
| 4790 | |
Josip Sokcevic | 1cabb17 | 2021-04-08 19:15:35 +0000 | [diff] [blame] | 4791 | cl = Changelist(branchref=options.target_branch) |
Edward Lesmes | 7677e5c | 2020-02-19 20:39:03 +0000 | [diff] [blame] | 4792 | # Warm change details cache now to avoid RPCs later, reducing latency for |
| 4793 | # developers. |
| 4794 | if cl.GetIssue(): |
| 4795 | cl._GetChangeDetail( |
| 4796 | ['DETAILED_ACCOUNTS', 'CURRENT_REVISION', 'CURRENT_COMMIT', 'LABELS']) |
| 4797 | |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4798 | if options.retry_failed and not cl.GetIssue(): |
| 4799 | print('No previous patchsets, so --retry-failed has no effect.') |
| 4800 | options.retry_failed = False |
Edward Lesmes | 7677e5c | 2020-02-19 20:39:03 +0000 | [diff] [blame] | 4801 | |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4802 | # cl.GetMostRecentPatchset uses cached information, and can return the last |
| 4803 | # patchset before upload. Calling it here makes it clear that it's the |
| 4804 | # last patchset before upload. Note that GetMostRecentPatchset will fail |
| 4805 | # if no CL has been uploaded yet. |
| 4806 | if options.retry_failed: |
| 4807 | patchset = cl.GetMostRecentPatchset() |
Andrii Shyshkalov | 9f27443 | 2018-10-15 16:40:23 +0000 | [diff] [blame] | 4808 | |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4809 | ret = cl.CMDUpload(options, args, orig_args) |
| 4810 | |
| 4811 | if options.retry_failed: |
| 4812 | if ret != 0: |
| 4813 | print('Upload failed, so --retry-failed has no effect.') |
| 4814 | return ret |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 4815 | builds, _ = _fetch_latest_builds(cl, |
| 4816 | DEFAULT_BUILDBUCKET_HOST, |
| 4817 | latest_patchset=patchset) |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 4818 | jobs = _filter_failed_for_retry(builds) |
| 4819 | if len(jobs) == 0: |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4820 | print('No failed tryjobs, so --retry-failed has no effect.') |
| 4821 | return ret |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 4822 | _trigger_tryjobs(cl, jobs, options, patchset + 1) |
Quinten Yearsley | a19d353 | 2019-09-30 21:54:39 +0000 | [diff] [blame] | 4823 | |
| 4824 | return ret |
ukai@chromium.org | e807781 | 2012-02-03 03:41:46 +0000 | [diff] [blame] | 4825 | |
| 4826 | |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 4827 | def UploadAllSquashed(options, orig_args): |
| 4828 | # type: (optparse.Values, Sequence[str]) -> Tuple[Sequence[Changelist], bool] |
| 4829 | """Uploads the current and upstream branches (if necessary).""" |
Joanna Wang | c710e2d | 2023-01-25 14:53:22 +0000 | [diff] [blame] | 4830 | cls, cherry_pick_current = _UploadAllPrecheck(options, orig_args) |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 4831 | |
Joanna Wang | c710e2d | 2023-01-25 14:53:22 +0000 | [diff] [blame] | 4832 | # Create commits. |
| 4833 | uploads_by_cl = [] #type: Sequence[Tuple[Changelist, _NewUpload]] |
| 4834 | if cherry_pick_current: |
| 4835 | parent = cls[1]._GitGetBranchConfigValue(GERRIT_SQUASH_HASH_CONFIG_KEY) |
| 4836 | new_upload = cls[0].PrepareCherryPickSquashedCommit(options, parent) |
| 4837 | uploads_by_cl.append((cls[0], new_upload)) |
| 4838 | else: |
| 4839 | parent = None |
| 4840 | ordered_cls = list(reversed(cls)) |
| 4841 | |
| 4842 | for i, cl in enumerate(ordered_cls): |
| 4843 | # If we're in the middle of the stack, set end_commit to downstream's |
| 4844 | # direct ancestor. |
| 4845 | if i + 1 < len(ordered_cls): |
| 4846 | child_base_commit = ordered_cls[i + 1].GetCommonAncestorWithUpstream() |
| 4847 | else: |
| 4848 | child_base_commit = None |
| 4849 | new_upload = cl.PrepareSquashedCommit(options, |
| 4850 | parent=parent, |
| 4851 | end_commit=child_base_commit) |
| 4852 | uploads_by_cl.append((cl, new_upload)) |
| 4853 | |
| 4854 | parent = new_upload.commit_to_push |
| 4855 | |
| 4856 | # Create refspec options |
| 4857 | cl, new_upload = uploads_by_cl[-1] |
| 4858 | refspec_opts = cl._GetRefSpecOptions( |
| 4859 | options, |
| 4860 | new_upload.change_desc, |
Joanna Wang | 562481d | 2023-01-26 21:57:14 +0000 | [diff] [blame] | 4861 | multi_change_upload=len(uploads_by_cl) > 1, |
| 4862 | dogfood_path=True) |
Joanna Wang | c710e2d | 2023-01-25 14:53:22 +0000 | [diff] [blame] | 4863 | refspec_suffix = '' |
| 4864 | if refspec_opts: |
| 4865 | refspec_suffix = '%' + ','.join(refspec_opts) |
| 4866 | assert ' ' not in refspec_suffix, ('spaces not allowed in refspec: "%s"' % |
| 4867 | refspec_suffix) |
| 4868 | |
| 4869 | remote, remote_branch = cl.GetRemoteBranch() |
| 4870 | branch = GetTargetRef(remote, remote_branch, options.target_branch) |
| 4871 | refspec = '%s:refs/for/%s%s' % (new_upload.commit_to_push, branch, |
| 4872 | refspec_suffix) |
| 4873 | |
| 4874 | # Git push |
| 4875 | git_push_metadata = { |
| 4876 | 'gerrit_host': |
| 4877 | cl.GetGerritHost(), |
| 4878 | 'title': |
| 4879 | options.title or '<untitled>', |
| 4880 | 'change_id': |
| 4881 | git_footers.get_footer_change_id(new_upload.change_desc.description), |
| 4882 | 'description': |
| 4883 | new_upload.change_desc.description, |
| 4884 | } |
| 4885 | push_stdout = cl._RunGitPushWithTraces(refspec, refspec_opts, |
| 4886 | git_push_metadata) |
| 4887 | |
| 4888 | # Post push updates |
| 4889 | regex = re.compile(r'remote:\s+https?://[\w\-\.\+\/#]*/(\d+)\s.*') |
| 4890 | change_numbers = [ |
| 4891 | m.group(1) for m in map(regex.match, push_stdout.splitlines()) if m |
| 4892 | ] |
| 4893 | |
| 4894 | for i, (cl, new_upload) in enumerate(uploads_by_cl): |
| 4895 | cl.PostUploadUpdates(options, new_upload, change_numbers[i]) |
| 4896 | |
| 4897 | return 0 |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 4898 | |
| 4899 | |
| 4900 | def _UploadAllPrecheck(options, orig_args): |
| 4901 | # type: (optparse.Values, Sequence[str]) -> Tuple[Sequence[Changelist], bool] |
| 4902 | """Checks the state of the tree and gives the user uploading options |
| 4903 | |
| 4904 | Returns: A tuple of the ordered list of changes that have new commits |
| 4905 | since their last upload and a boolean of whether the user wants to |
| 4906 | cherry-pick and upload the current branch instead of uploading all cls. |
| 4907 | """ |
| 4908 | branch_ref = None |
| 4909 | cls = [] |
| 4910 | must_upload_upstream = False |
| 4911 | |
| 4912 | Changelist._GerritCommitMsgHookCheck(offer_removal=not options.force) |
| 4913 | |
| 4914 | while True: |
| 4915 | if len(cls) > _MAX_STACKED_BRANCHES_UPLOAD: |
| 4916 | DieWithError( |
| 4917 | 'More than %s branches in the stack have not been uploaded.\n' |
| 4918 | 'Are your branches in a misconfigured state?\n' |
| 4919 | 'If not, please upload some upstream changes first.' % |
| 4920 | (_MAX_STACKED_BRANCHES_UPLOAD)) |
| 4921 | |
| 4922 | cl = Changelist(branchref=branch_ref) |
| 4923 | cls.append(cl) |
| 4924 | |
| 4925 | origin, upstream_branch_ref = Changelist.FetchUpstreamTuple(cl.GetBranch()) |
| 4926 | upstream_branch = scm.GIT.ShortBranchName(upstream_branch_ref) |
| 4927 | branch_ref = upstream_branch_ref # set branch for next run. |
| 4928 | |
| 4929 | # Case 1: We've reached the beginning of the tree. |
| 4930 | if origin != '.': |
| 4931 | break |
| 4932 | |
| 4933 | upstream_last_upload = scm.GIT.GetBranchConfig(settings.GetRoot(), |
| 4934 | upstream_branch, |
| 4935 | LAST_UPLOAD_HASH_CONFIG_KEY) |
| 4936 | |
| 4937 | # Case 2: If any upstream branches have never been uploaded, |
| 4938 | # the user MUST upload them. |
| 4939 | if not upstream_last_upload: |
| 4940 | must_upload_upstream = True |
| 4941 | continue |
| 4942 | |
| 4943 | base_commit = cl.GetCommonAncestorWithUpstream() |
| 4944 | |
| 4945 | # Case 3: If upstream's last_upload == cl.base_commit we do |
| 4946 | # not need to upload any more upstreams from this point on. |
| 4947 | # (Even if there may be diverged branches higher up the tree) |
| 4948 | if base_commit == upstream_last_upload: |
| 4949 | break |
| 4950 | |
| 4951 | # Case 4: If upstream's last_upload < cl.base_commit we are |
| 4952 | # uploading cl and upstream_cl. |
| 4953 | # Continue up the tree to check other branch relations. |
Joanna Wang | ab9c6ba | 2023-01-21 01:46:36 +0000 | [diff] [blame] | 4954 | if scm.GIT.IsAncestor(upstream_last_upload, base_commit): |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 4955 | continue |
| 4956 | |
| 4957 | # Case 5: If cl.base_commit < upstream's last_upload the user |
| 4958 | # must rebase before uploading. |
Joanna Wang | ab9c6ba | 2023-01-21 01:46:36 +0000 | [diff] [blame] | 4959 | if scm.GIT.IsAncestor(base_commit, upstream_last_upload): |
Joanna Wang | 18de1f6 | 2023-01-21 01:24:24 +0000 | [diff] [blame] | 4960 | DieWithError( |
| 4961 | 'At least one branch in the stack has diverged from its upstream ' |
| 4962 | 'branch and does not contain its upstream\'s last upload.\n' |
| 4963 | 'Please rebase the stack with `git rebase-update` before uploading.') |
| 4964 | |
| 4965 | # The tree went through a rebase. LAST_UPLOAD_HASH_CONFIG_KEY no longer has |
| 4966 | # any relation to commits in the tree. Continue up the tree until we hit |
| 4967 | # the root. |
| 4968 | |
| 4969 | # We assume all cls in the stack have the same auth requirements and only |
| 4970 | # check this once. |
| 4971 | cls[0].EnsureAuthenticated(force=options.force) |
| 4972 | |
| 4973 | cherry_pick = False |
| 4974 | if len(cls) > 1: |
| 4975 | message = '' |
| 4976 | if len(orig_args): |
| 4977 | message = ('options %s will be used for all uploads.\n' % orig_args) |
| 4978 | if must_upload_upstream: |
| 4979 | confirm_or_exit('\n' + message + |
| 4980 | 'There are upstream branches that must be uploaded.\n') |
| 4981 | else: |
| 4982 | answer = gclient_utils.AskForData( |
| 4983 | '\n' + message + |
| 4984 | 'Press enter to update branches %s.\nOr type `n` to upload only ' |
| 4985 | '`%s` cherry-picked on %s\'s last upload:' % |
| 4986 | ([cl.branch for cl in cls], cls[0].branch, cls[1].branch)) |
| 4987 | if answer.lower() == 'n': |
| 4988 | cherry_pick = True |
| 4989 | return cls, cherry_pick |
| 4990 | |
| 4991 | |
Francois Doray | d42c681 | 2017-05-30 15:10:20 -0400 | [diff] [blame] | 4992 | @subcommand.usage('--description=<description file>') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 4993 | @metrics.collector.collect_metrics('git cl split') |
Francois Doray | d42c681 | 2017-05-30 15:10:20 -0400 | [diff] [blame] | 4994 | def CMDsplit(parser, args): |
| 4995 | """Splits a branch into smaller branches and uploads CLs. |
| 4996 | |
| 4997 | Creates a branch and uploads a CL for each group of files modified in the |
| 4998 | current branch that share a common OWNERS file. In the CL description and |
Edward Lemur | ac5c55f | 2020-02-29 00:17:16 +0000 | [diff] [blame] | 4999 | comment, the string '$directory', is replaced with the directory containing |
| 5000 | the shared OWNERS file. |
Francois Doray | d42c681 | 2017-05-30 15:10:20 -0400 | [diff] [blame] | 5001 | """ |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5002 | parser.add_option('-d', '--description', dest='description_file', |
| 5003 | help='A text file containing a CL description in which ' |
| 5004 | '$directory will be replaced by each CL\'s directory.') |
| 5005 | parser.add_option('-c', '--comment', dest='comment_file', |
| 5006 | help='A text file containing a CL comment.') |
| 5007 | parser.add_option('-n', '--dry-run', dest='dry_run', action='store_true', |
Chris Watkins | ba28e46 | 2017-12-13 11:22:17 +1100 | [diff] [blame] | 5008 | default=False, |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5009 | help='List the files and reviewers for each CL that would ' |
| 5010 | 'be created, but don\'t create branches or CLs.') |
| 5011 | parser.add_option('--cq-dry-run', action='store_true', |
| 5012 | help='If set, will do a cq dry run for each uploaded CL. ' |
| 5013 | 'Please be careful when doing this; more than ~10 CLs ' |
| 5014 | 'has the potential to overload our build ' |
| 5015 | 'infrastructure. Try to upload these not during high ' |
| 5016 | 'load times (usually 11-3 Mountain View time). Email ' |
| 5017 | 'infra-dev@chromium.org with any questions.') |
Takuto Ikuta | 51eca59 | 2019-02-14 19:40:52 +0000 | [diff] [blame] | 5018 | parser.add_option('-a', '--enable-auto-submit', action='store_true', |
| 5019 | default=True, |
| 5020 | help='Sends your change to the CQ after an approval. Only ' |
| 5021 | 'works on repos that have the Auto-Submit label ' |
| 5022 | 'enabled') |
Daniel Cheng | 403c44e | 2022-10-05 22:24:58 +0000 | [diff] [blame] | 5023 | parser.add_option('--max-depth', |
| 5024 | type='int', |
| 5025 | default=0, |
| 5026 | help='The max depth to look for OWNERS files. Useful for ' |
| 5027 | 'controlling the granularity of the split CLs, e.g. ' |
| 5028 | '--max-depth=1 will only split by top-level ' |
| 5029 | 'directory. Specifying a value less than 1 means no ' |
| 5030 | 'limit on max depth.') |
Francois Doray | d42c681 | 2017-05-30 15:10:20 -0400 | [diff] [blame] | 5031 | options, _ = parser.parse_args(args) |
| 5032 | |
| 5033 | if not options.description_file: |
| 5034 | parser.error('No --description flag specified.') |
| 5035 | |
| 5036 | def WrappedCMDupload(args): |
| 5037 | return CMDupload(OptionParser(), args) |
| 5038 | |
Daniel Cheng | 403c44e | 2022-10-05 22:24:58 +0000 | [diff] [blame] | 5039 | return split_cl.SplitCl(options.description_file, options.comment_file, |
| 5040 | Changelist, WrappedCMDupload, options.dry_run, |
| 5041 | options.cq_dry_run, options.enable_auto_submit, |
| 5042 | options.max_depth, settings.GetRoot()) |
Francois Doray | d42c681 | 2017-05-30 15:10:20 -0400 | [diff] [blame] | 5043 | |
| 5044 | |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5045 | @subcommand.usage('DEPRECATED') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5046 | @metrics.collector.collect_metrics('git cl commit') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5047 | def CMDdcommit(parser, args): |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5048 | """DEPRECATED: Used to commit the current changelist via git-svn.""" |
| 5049 | message = ('git-cl no longer supports committing to SVN repositories via ' |
| 5050 | 'git-svn. You probably want to use `git cl land` instead.') |
| 5051 | print(message) |
| 5052 | return 1 |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5053 | |
| 5054 | |
maruel@chromium.org | 0633fb4 | 2013-08-16 20:06:14 +0000 | [diff] [blame] | 5055 | @subcommand.usage('[upstream branch to apply against]') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5056 | @metrics.collector.collect_metrics('git cl land') |
pgervais@chromium.org | cee6dc4 | 2014-05-07 17:04:03 +0000 | [diff] [blame] | 5057 | def CMDland(parser, args): |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5058 | """Commits the current changelist via git. |
| 5059 | |
| 5060 | In case of Gerrit, uses Gerrit REST api to "submit" the issue, which pushes |
| 5061 | upstream and closes the issue automatically and atomically. |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5062 | """ |
| 5063 | parser.add_option('--bypass-hooks', action='store_true', dest='bypass_hooks', |
| 5064 | help='bypass upload presubmit hook') |
Aaron Gable | f7543cd | 2017-07-20 14:26:31 -0700 | [diff] [blame] | 5065 | parser.add_option('-f', '--force', action='store_true', dest='force', |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5066 | help="force yes to questions (don't prompt)") |
Edward Lesmes | 67b3faa | 2018-04-13 17:50:52 -0400 | [diff] [blame] | 5067 | parser.add_option('--parallel', action='store_true', |
| 5068 | help='Run all tests specified by input_api.RunTests in all ' |
| 5069 | 'PRESUBMIT files in parallel.') |
Saagar Sanghavi | 03b1513 | 2020-08-10 16:43:41 +0000 | [diff] [blame] | 5070 | parser.add_option('--resultdb', action='store_true', |
| 5071 | help='Run presubmit checks in the ResultSink environment ' |
| 5072 | 'and send results to the ResultDB database.') |
| 5073 | parser.add_option('--realm', help='LUCI realm if reporting to ResultDB') |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5074 | (options, args) = parser.parse_args(args) |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5075 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5076 | cl = Changelist() |
Aaron Gable | 1bc7bfe | 2016-12-19 10:08:14 -0800 | [diff] [blame] | 5077 | |
Robert Iannucci | 2e73d43 | 2018-03-14 01:10:47 -0700 | [diff] [blame] | 5078 | if not cl.GetIssue(): |
| 5079 | DieWithError('You must upload the change first to Gerrit.\n' |
| 5080 | ' If you would rather have `git cl land` upload ' |
| 5081 | 'automatically for you, see http://crbug.com/642759') |
Saagar Sanghavi | 03b1513 | 2020-08-10 16:43:41 +0000 | [diff] [blame] | 5082 | return cl.CMDLand(options.force, options.bypass_hooks, options.verbose, |
| 5083 | options.parallel, options.resultdb, options.realm) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5084 | |
| 5085 | |
dsinclair@chromium.org | fbed656 | 2015-09-25 21:22:36 +0000 | [diff] [blame] | 5086 | @subcommand.usage('<patch url or issue id or issue url>') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5087 | @metrics.collector.collect_metrics('git cl patch') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5088 | def CMDpatch(parser, args): |
marq@chromium.org | e5e5900 | 2013-10-02 23:21:25 +0000 | [diff] [blame] | 5089 | """Patches in a code review.""" |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5090 | parser.add_option('-b', dest='newbranch', |
| 5091 | help='create a new branch off trunk for the patch') |
qsr@chromium.org | 1ef44af | 2013-10-16 16:24:32 +0000 | [diff] [blame] | 5092 | parser.add_option('-f', '--force', action='store_true', |
Aaron Gable | 62619a3 | 2017-06-16 08:22:09 -0700 | [diff] [blame] | 5093 | help='overwrite state on the current or chosen branch') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5094 | parser.add_option('-n', '--no-commit', action='store_true', dest='nocommit', |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 5095 | help='don\'t commit after patch applies.') |
mtrofin@chromium.org | 1d88dd3 | 2016-02-04 16:25:12 +0000 | [diff] [blame] | 5096 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 5097 | group = optparse.OptionGroup( |
| 5098 | parser, |
| 5099 | 'Options for continuing work on the current issue uploaded from a ' |
| 5100 | 'different clone (e.g. different machine). Must be used independently ' |
| 5101 | 'from the other options. No issue number should be specified, and the ' |
| 5102 | 'branch must have an issue number associated with it') |
| 5103 | group.add_option('--reapply', action='store_true', dest='reapply', |
| 5104 | help='Reset the branch and reapply the issue.\n' |
| 5105 | 'CAUTION: This will undo any local changes in this ' |
| 5106 | 'branch') |
mtrofin@chromium.org | 1d88dd3 | 2016-02-04 16:25:12 +0000 | [diff] [blame] | 5107 | |
| 5108 | group.add_option('--pull', action='store_true', dest='pull', |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 5109 | help='Performs a pull before reapplying.') |
mtrofin@chromium.org | 1d88dd3 | 2016-02-04 16:25:12 +0000 | [diff] [blame] | 5110 | parser.add_option_group(group) |
| 5111 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5112 | (options, args) = parser.parse_args(args) |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 5113 | |
Andrii Shyshkalov | 1897532 | 2017-01-25 16:44:13 +0100 | [diff] [blame] | 5114 | if options.reapply: |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5115 | if options.newbranch: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5116 | parser.error('--reapply works on the current branch only.') |
mtrofin@chromium.org | 1d88dd3 | 2016-02-04 16:25:12 +0000 | [diff] [blame] | 5117 | if len(args) > 0: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5118 | parser.error('--reapply implies no additional arguments.') |
dsinclair@chromium.org | fbed656 | 2015-09-25 21:22:36 +0000 | [diff] [blame] | 5119 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5120 | cl = Changelist() |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5121 | if not cl.GetIssue(): |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5122 | parser.error('Current branch must have an associated issue.') |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5123 | |
mtrofin@chromium.org | 1d88dd3 | 2016-02-04 16:25:12 +0000 | [diff] [blame] | 5124 | upstream = cl.GetUpstreamBranch() |
Andrii Shyshkalov | 1897532 | 2017-01-25 16:44:13 +0100 | [diff] [blame] | 5125 | if upstream is None: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5126 | parser.error('No upstream branch specified. Cannot reset branch.') |
mtrofin@chromium.org | 1d88dd3 | 2016-02-04 16:25:12 +0000 | [diff] [blame] | 5127 | |
| 5128 | RunGit(['reset', '--hard', upstream]) |
| 5129 | if options.pull: |
| 5130 | RunGit(['pull']) |
mtrofin@chromium.org | 1d88dd3 | 2016-02-04 16:25:12 +0000 | [diff] [blame] | 5131 | |
Edward Lemur | 678a684 | 2019-10-03 22:25:05 +0000 | [diff] [blame] | 5132 | target_issue_arg = ParseIssueNumberArgument(cl.GetIssue()) |
Joanna Wang | 44e9bee | 2023-01-25 21:51:42 +0000 | [diff] [blame] | 5133 | return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, |
| 5134 | options.force, False) |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5135 | |
| 5136 | if len(args) != 1 or not args[0]: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5137 | parser.error('Must specify issue number or URL.') |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5138 | |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 5139 | target_issue_arg = ParseIssueNumberArgument(args[0]) |
Andrii Shyshkalov | c971239 | 2017-04-11 13:35:21 +0200 | [diff] [blame] | 5140 | if not target_issue_arg.valid: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5141 | parser.error('Invalid issue ID or URL.') |
Andrii Shyshkalov | c971239 | 2017-04-11 13:35:21 +0200 | [diff] [blame] | 5142 | |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5143 | # We don't want uncommitted changes mixed up with the patch. |
| 5144 | if git_common.is_dirty_git_tree('patch'): |
dsinclair@chromium.org | fbed656 | 2015-09-25 21:22:36 +0000 | [diff] [blame] | 5145 | return 1 |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5146 | |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5147 | if options.newbranch: |
| 5148 | if options.force: |
| 5149 | RunGit(['branch', '-D', options.newbranch], |
| 5150 | stderr=subprocess2.PIPE, error_ok=True) |
Edward Lemur | 8410164 | 2020-02-21 21:40:34 +0000 | [diff] [blame] | 5151 | git_new_branch.create_new_branch(options.newbranch) |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5152 | |
Edward Lemur | 678a684 | 2019-10-03 22:25:05 +0000 | [diff] [blame] | 5153 | cl = Changelist( |
| 5154 | codereview_host=target_issue_arg.hostname, issue=target_issue_arg.issue) |
tandrii@chromium.org | c2786d9 | 2016-05-31 19:53:50 +0000 | [diff] [blame] | 5155 | |
Edward Lemur | 678a684 | 2019-10-03 22:25:05 +0000 | [diff] [blame] | 5156 | if not args[0].isdigit(): |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 5157 | print('canonical issue/change URL: %s\n' % cl.GetIssueURL()) |
Andrii Shyshkalov | c971239 | 2017-04-11 13:35:21 +0200 | [diff] [blame] | 5158 | |
Bruce Dawson | f362f6f | 2021-02-18 23:15:17 +0000 | [diff] [blame] | 5159 | return cl.CMDPatchWithParsedIssue(target_issue_arg, options.nocommit, |
| 5160 | options.force, options.newbranch) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5161 | |
| 5162 | |
jochen@chromium.org | 3ec0d54 | 2014-01-14 20:00:03 +0000 | [diff] [blame] | 5163 | def GetTreeStatus(url=None): |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5164 | """Fetches the tree status and returns either 'open', 'closed', |
| 5165 | 'unknown' or 'unset'.""" |
jochen@chromium.org | 3ec0d54 | 2014-01-14 20:00:03 +0000 | [diff] [blame] | 5166 | url = url or settings.GetTreeStatusUrl(error_ok=True) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5167 | if url: |
Daniel McArdle | 8b4eeff | 2020-07-20 17:02:47 +0000 | [diff] [blame] | 5168 | status = str(urllib.request.urlopen(url).read().lower()) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5169 | if status.find('closed') != -1 or status == '0': |
| 5170 | return 'closed' |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 5171 | |
| 5172 | if status.find('open') != -1 or status == '1': |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5173 | return 'open' |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 5174 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5175 | return 'unknown' |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5176 | return 'unset' |
| 5177 | |
dpranke@chromium.org | 970c522 | 2011-03-12 00:32:24 +0000 | [diff] [blame] | 5178 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5179 | def GetTreeStatusReason(): |
| 5180 | """Fetches the tree status from a json url and returns the message |
| 5181 | with the reason for the tree to be opened or closed.""" |
msb@chromium.org | bf1a7ba | 2011-02-01 16:21:46 +0000 | [diff] [blame] | 5182 | url = settings.GetTreeStatusUrl() |
Daniel McArdle | 8b4eeff | 2020-07-20 17:02:47 +0000 | [diff] [blame] | 5183 | json_url = urllib.parse.urljoin(url, '/current?format=json') |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 5184 | connection = urllib.request.urlopen(json_url) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5185 | status = json.loads(connection.read()) |
| 5186 | connection.close() |
| 5187 | return status['message'] |
| 5188 | |
dpranke@chromium.org | 970c522 | 2011-03-12 00:32:24 +0000 | [diff] [blame] | 5189 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5190 | @metrics.collector.collect_metrics('git cl tree') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5191 | def CMDtree(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 5192 | """Shows the status of the tree.""" |
dpranke@chromium.org | 97ae58e | 2011-03-18 00:29:20 +0000 | [diff] [blame] | 5193 | _, args = parser.parse_args(args) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5194 | status = GetTreeStatus() |
| 5195 | if 'unset' == status: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 5196 | print('You must configure your tree status URL by running "git cl config".') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5197 | return 2 |
| 5198 | |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 5199 | print('The tree is %s' % status) |
| 5200 | print() |
| 5201 | print(GetTreeStatusReason()) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5202 | if status != 'open': |
| 5203 | return 1 |
| 5204 | return 0 |
| 5205 | |
| 5206 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5207 | @metrics.collector.collect_metrics('git cl try') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5208 | def CMDtry(parser, args): |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5209 | """Triggers tryjobs using either Buildbucket or CQ dry run.""" |
| 5210 | group = optparse.OptionGroup(parser, 'Tryjob options') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5211 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5212 | '-b', '--bot', action='append', |
| 5213 | help=('IMPORTANT: specify ONE builder per --bot flag. Use it multiple ' |
| 5214 | 'times to specify multiple builders. ex: ' |
| 5215 | '"-b win_rel -b win_layout". See ' |
| 5216 | 'the try server waterfall for the builders name and the tests ' |
| 5217 | 'available.')) |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5218 | group.add_option( |
borenet | 6c0efe6 | 2016-10-19 08:13:29 -0700 | [diff] [blame] | 5219 | '-B', '--bucket', default='', |
Ben Pastene | 08a30b2 | 2022-05-04 17:46:38 +0000 | [diff] [blame] | 5220 | help=('Buildbucket bucket to send the try requests. Format: ' |
| 5221 | '"luci.$LUCI_PROJECT.$LUCI_BUCKET". eg: "luci.chromium.try"')) |
borenet | 6c0efe6 | 2016-10-19 08:13:29 -0700 | [diff] [blame] | 5222 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5223 | '-r', '--revision', |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5224 | help='Revision to use for the tryjob; default: the revision will ' |
tandrii | f7b29d4 | 2016-10-07 08:45:41 -0700 | [diff] [blame] | 5225 | 'be determined by the try recipe that builder runs, which usually ' |
Josip Sokcevic | c39ab99 | 2020-09-24 20:09:15 +0000 | [diff] [blame] | 5226 | 'defaults to HEAD of origin/master or origin/main') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5227 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5228 | '-c', '--clobber', action='store_true', default=False, |
tandrii | f7b29d4 | 2016-10-07 08:45:41 -0700 | [diff] [blame] | 5229 | help='Force a clobber before building; that is don\'t do an ' |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5230 | 'incremental build') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5231 | group.add_option( |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 5232 | '-q', |
| 5233 | '--quick-run', |
| 5234 | action='store_true', |
| 5235 | default=False, |
| 5236 | help='trigger in quick run mode ' |
| 5237 | '(https://source.chromium.org/chromium/chromium/src/+/main:docs/cq_q' |
| 5238 | 'uick_run.md) (chromium only).') |
| 5239 | group.add_option( |
Andrii Shyshkalov | f9648b5 | 2018-02-21 22:32:42 -0800 | [diff] [blame] | 5240 | '--category', default='git_cl_try', help='Specify custom build category.') |
| 5241 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5242 | '--project', |
| 5243 | help='Override which project to use. Projects are defined ' |
tandrii | f7b29d4 | 2016-10-07 08:45:41 -0700 | [diff] [blame] | 5244 | 'in recipe to determine to which repository or directory to ' |
| 5245 | 'apply the patch') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5246 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5247 | '-p', '--property', dest='properties', action='append', default=[], |
| 5248 | help='Specify generic properties in the form -p key1=value1 -p ' |
tandrii | f7b29d4 | 2016-10-07 08:45:41 -0700 | [diff] [blame] | 5249 | 'key2=value2 etc. The value will be treated as ' |
| 5250 | 'json if decodable, or as string otherwise. ' |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5251 | 'NOTE: using this may make your tryjob not usable for CQ, ' |
| 5252 | 'which will then schedule another tryjob with default properties') |
sheyang@chromium.org | db37557 | 2015-08-17 19:22:23 +0000 | [diff] [blame] | 5253 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5254 | '--buildbucket-host', default='cr-buildbucket.appspot.com', |
| 5255 | help='Host of buildbucket. The default host is %default.') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5256 | parser.add_option_group(group) |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 5257 | parser.add_option( |
| 5258 | '-R', '--retry-failed', action='store_true', default=False, |
| 5259 | help='Retry failed jobs from the latest set of tryjobs. ' |
| 5260 | 'Not allowed with --bucket and --bot options.') |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 5261 | parser.add_option( |
| 5262 | '-i', '--issue', type=int, |
| 5263 | help='Operate on this issue instead of the current branch\'s implicit ' |
| 5264 | 'issue.') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5265 | options, args = parser.parse_args(args) |
| 5266 | |
machenbach@chromium.org | 4545314 | 2015-09-15 08:45:22 +0000 | [diff] [blame] | 5267 | # Make sure that all properties are prop=value pairs. |
| 5268 | bad_params = [x for x in options.properties if '=' not in x] |
| 5269 | if bad_params: |
| 5270 | parser.error('Got properties with missing "=": %s' % bad_params) |
| 5271 | |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5272 | if args: |
| 5273 | parser.error('Unknown arguments: %s' % args) |
| 5274 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5275 | cl = Changelist(issue=options.issue) |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5276 | if not cl.GetIssue(): |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5277 | parser.error('Need to upload first.') |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5278 | |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 5279 | # HACK: warm up Gerrit change detail cache to save on RPCs. |
Edward Lemur | 125d60a | 2019-09-13 18:25:41 +0000 | [diff] [blame] | 5280 | cl._GetChangeDetail(['DETAILED_ACCOUNTS', 'ALL_REVISIONS']) |
Andrii Shyshkalov | eadad92 | 2017-01-26 09:38:30 +0100 | [diff] [blame] | 5281 | |
tandrii | e113dfd | 2016-10-11 10:20:12 -0700 | [diff] [blame] | 5282 | error_message = cl.CannotTriggerTryJobReason() |
| 5283 | if error_message: |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5284 | parser.error('Can\'t trigger tryjobs: %s' % error_message) |
jrobbins@chromium.org | 16f10f7 | 2014-06-24 22:14:36 +0000 | [diff] [blame] | 5285 | |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 5286 | if options.bot: |
| 5287 | if options.retry_failed: |
| 5288 | parser.error('--bot is not compatible with --retry-failed.') |
| 5289 | if not options.bucket: |
| 5290 | parser.error('A bucket (e.g. "chromium/try") is required.') |
| 5291 | |
| 5292 | triggered = [b for b in options.bot if 'triggered' in b] |
| 5293 | if triggered: |
| 5294 | parser.error( |
| 5295 | 'Cannot schedule builds on triggered bots: %s.\n' |
| 5296 | 'This type of bot requires an initial job from a parent (usually a ' |
| 5297 | 'builder). Schedule a job on the parent instead.\n' % triggered) |
| 5298 | |
| 5299 | if options.bucket.startswith('.master'): |
| 5300 | parser.error('Buildbot masters are not supported.') |
| 5301 | |
| 5302 | project, bucket = _parse_bucket(options.bucket) |
| 5303 | if project is None or bucket is None: |
| 5304 | parser.error('Invalid bucket: %s.' % options.bucket) |
| 5305 | jobs = sorted((project, bucket, bot) for bot in options.bot) |
| 5306 | elif options.retry_failed: |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 5307 | print('Searching for failed tryjobs...') |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 5308 | builds, patchset = _fetch_latest_builds(cl, DEFAULT_BUILDBUCKET_HOST) |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 5309 | if options.verbose: |
| 5310 | print('Got %d builds in patchset #%d' % (len(builds), patchset)) |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 5311 | jobs = _filter_failed_for_retry(builds) |
| 5312 | if not jobs: |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 5313 | print('There are no failed jobs in the latest set of jobs ' |
| 5314 | '(patchset #%d), doing nothing.' % patchset) |
| 5315 | return 0 |
Edward Lemur | 4576851 | 2020-03-02 19:03:14 +0000 | [diff] [blame] | 5316 | num_builders = len(jobs) |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 5317 | if num_builders > 10: |
| 5318 | confirm_or_exit('There are %d builders with failed builds.' |
| 5319 | % num_builders, action='continue') |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 5320 | elif options.quick_run: |
| 5321 | print('Scheduling CQ quick run on: %s' % cl.GetIssueURL()) |
| 5322 | return cl.SetCQState(_CQState.QUICK_RUN) |
Quinten Yearsley | 983111f | 2019-09-26 17:18:48 +0000 | [diff] [blame] | 5323 | else: |
qyearsley | 1fdfcb6 | 2016-10-24 13:22:03 -0700 | [diff] [blame] | 5324 | if options.verbose: |
Quinten Yearsley | fc5fd92 | 2017-05-31 11:50:52 -0700 | [diff] [blame] | 5325 | print('git cl try with no bots now defaults to CQ dry run.') |
| 5326 | print('Scheduling CQ dry run on: %s' % cl.GetIssueURL()) |
| 5327 | return cl.SetCQState(_CQState.DRY_RUN) |
stip@chromium.org | 43064fd | 2013-12-18 20:07:44 +0000 | [diff] [blame] | 5328 | |
ilevy@chromium.org | 36e420b | 2013-08-06 23:21:12 +0000 | [diff] [blame] | 5329 | patchset = cl.GetMostRecentPatchset() |
Edward Lemur | 2c210a4 | 2019-09-16 23:58:35 +0000 | [diff] [blame] | 5330 | try: |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 5331 | _trigger_tryjobs(cl, jobs, options, patchset) |
Edward Lemur | 2c210a4 | 2019-09-16 23:58:35 +0000 | [diff] [blame] | 5332 | except BuildbucketResponseException as ex: |
| 5333 | print('ERROR: %s' % ex) |
| 5334 | return 1 |
| 5335 | return 0 |
maruel@chromium.org | 1519240 | 2012-09-06 12:38:29 +0000 | [diff] [blame] | 5336 | |
| 5337 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5338 | @metrics.collector.collect_metrics('git cl try-results') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5339 | def CMDtry_results(parser, args): |
Quinten Yearsley | d242ed7 | 2019-07-25 17:17:55 +0000 | [diff] [blame] | 5340 | """Prints info about results for tryjobs associated with the current CL.""" |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5341 | group = optparse.OptionGroup(parser, 'Tryjob results options') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5342 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5343 | '-p', '--patchset', type=int, help='patchset number if not current.') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5344 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5345 | '--print-master', action='store_true', help='print master name as well.') |
tandrii@chromium.org | 6cf98c8 | 2016-03-15 11:56:00 +0000 | [diff] [blame] | 5346 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5347 | '--color', action='store_true', default=setup_color.IS_TTY, |
| 5348 | help='force color output, useful when piping output.') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5349 | group.add_option( |
tandrii | 1838bad | 2016-10-06 00:10:52 -0700 | [diff] [blame] | 5350 | '--buildbucket-host', default='cr-buildbucket.appspot.com', |
| 5351 | help='Host of buildbucket. The default host is %default.') |
qyearsley | 53f48a1 | 2016-09-01 10:45:13 -0700 | [diff] [blame] | 5352 | group.add_option( |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5353 | '--json', help=('Path of JSON output file to write tryjob results to,' |
Stefan Zager | 1306bd0 | 2017-06-22 19:26:46 -0700 | [diff] [blame] | 5354 | 'or "-" for stdout.')) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5355 | parser.add_option_group(group) |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 5356 | parser.add_option( |
| 5357 | '-i', '--issue', type=int, |
| 5358 | help='Operate on this issue instead of the current branch\'s implicit ' |
| 5359 | 'issue.') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5360 | options, args = parser.parse_args(args) |
| 5361 | if args: |
| 5362 | parser.error('Unrecognized args: %s' % ' '.join(args)) |
| 5363 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5364 | cl = Changelist(issue=options.issue) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5365 | if not cl.GetIssue(): |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5366 | parser.error('Need to upload first.') |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5367 | |
tandrii | 221ab25 | 2016-10-06 08:12:04 -0700 | [diff] [blame] | 5368 | patchset = options.patchset |
| 5369 | if not patchset: |
Gavin Mak | e61ccc5 | 2020-11-13 00:12:57 +0000 | [diff] [blame] | 5370 | patchset = cl.GetMostRecentDryRunPatchset() |
tandrii | 221ab25 | 2016-10-06 08:12:04 -0700 | [diff] [blame] | 5371 | if not patchset: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5372 | parser.error('Code review host doesn\'t know about issue %s. ' |
tandrii | 221ab25 | 2016-10-06 08:12:04 -0700 | [diff] [blame] | 5373 | 'No access to issue or wrong issue number?\n' |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5374 | 'Either upload first, or pass --patchset explicitly.' % |
tandrii | 221ab25 | 2016-10-06 08:12:04 -0700 | [diff] [blame] | 5375 | cl.GetIssue()) |
| 5376 | |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5377 | try: |
Joanna Wang | a8db0cb | 2023-01-24 15:43:17 +0000 | [diff] [blame] | 5378 | jobs = _fetch_tryjobs(cl, DEFAULT_BUILDBUCKET_HOST, patchset) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5379 | except BuildbucketResponseException as ex: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 5380 | print('Buildbucket error: %s' % ex) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5381 | return 1 |
qyearsley | 53f48a1 | 2016-09-01 10:45:13 -0700 | [diff] [blame] | 5382 | if options.json: |
Edward Lemur | baaf6be | 2019-10-09 18:00:44 +0000 | [diff] [blame] | 5383 | write_json(options.json, jobs) |
qyearsley | 53f48a1 | 2016-09-01 10:45:13 -0700 | [diff] [blame] | 5384 | else: |
Quinten Yearsley | 777660f | 2020-03-04 23:37:06 +0000 | [diff] [blame] | 5385 | _print_tryjobs(options, jobs) |
tandrii@chromium.org | b015fac | 2016-02-26 14:52:01 +0000 | [diff] [blame] | 5386 | return 0 |
| 5387 | |
| 5388 | |
maruel@chromium.org | 0633fb4 | 2013-08-16 20:06:14 +0000 | [diff] [blame] | 5389 | @subcommand.usage('[new upstream branch]') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5390 | @metrics.collector.collect_metrics('git cl upstream') |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5391 | def CMDupstream(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 5392 | """Prints or sets the name of the upstream branch, if any.""" |
dpranke@chromium.org | 97ae58e | 2011-03-18 00:29:20 +0000 | [diff] [blame] | 5393 | _, args = parser.parse_args(args) |
brettw@chromium.org | ac0ba33 | 2012-08-09 23:42:53 +0000 | [diff] [blame] | 5394 | if len(args) > 1: |
maruel@chromium.org | 27bb387 | 2011-05-30 20:33:19 +0000 | [diff] [blame] | 5395 | parser.error('Unrecognized args: %s' % ' '.join(args)) |
brettw@chromium.org | ac0ba33 | 2012-08-09 23:42:53 +0000 | [diff] [blame] | 5396 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5397 | cl = Changelist() |
brettw@chromium.org | ac0ba33 | 2012-08-09 23:42:53 +0000 | [diff] [blame] | 5398 | if args: |
| 5399 | # One arg means set upstream branch. |
bauerb@chromium.org | c9cf90a | 2014-04-28 20:32:31 +0000 | [diff] [blame] | 5400 | branch = cl.GetBranch() |
stip | 7a3dd35 | 2016-09-22 17:32:28 -0700 | [diff] [blame] | 5401 | RunGit(['branch', '--set-upstream-to', args[0], branch]) |
brettw@chromium.org | ac0ba33 | 2012-08-09 23:42:53 +0000 | [diff] [blame] | 5402 | cl = Changelist() |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 5403 | print('Upstream branch set to %s' % (cl.GetUpstreamBranch(),)) |
bauerb@chromium.org | c9cf90a | 2014-04-28 20:32:31 +0000 | [diff] [blame] | 5404 | |
| 5405 | # Clear configured merge-base, if there is one. |
| 5406 | git_common.remove_merge_base(branch) |
brettw@chromium.org | ac0ba33 | 2012-08-09 23:42:53 +0000 | [diff] [blame] | 5407 | else: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 5408 | print(cl.GetUpstreamBranch()) |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 5409 | return 0 |
| 5410 | |
| 5411 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5412 | @metrics.collector.collect_metrics('git cl web') |
thestig@chromium.org | 00858c8 | 2013-12-02 23:08:03 +0000 | [diff] [blame] | 5413 | def CMDweb(parser, args): |
| 5414 | """Opens the current CL in the web browser.""" |
Orr Bernstein | 0b96058 | 2022-12-22 20:16:18 +0000 | [diff] [blame] | 5415 | parser.add_option('-p', |
| 5416 | '--print-only', |
| 5417 | action='store_true', |
| 5418 | dest='print_only', |
| 5419 | help='Only print the Gerrit URL, don\'t open it in the ' |
| 5420 | 'browser.') |
| 5421 | (options, args) = parser.parse_args(args) |
thestig@chromium.org | 00858c8 | 2013-12-02 23:08:03 +0000 | [diff] [blame] | 5422 | if args: |
| 5423 | parser.error('Unrecognized args: %s' % ' '.join(args)) |
| 5424 | |
| 5425 | issue_url = Changelist().GetIssueURL() |
| 5426 | if not issue_url: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 5427 | print('ERROR No issue to open', file=sys.stderr) |
thestig@chromium.org | 00858c8 | 2013-12-02 23:08:03 +0000 | [diff] [blame] | 5428 | return 1 |
| 5429 | |
Orr Bernstein | 0b96058 | 2022-12-22 20:16:18 +0000 | [diff] [blame] | 5430 | if options.print_only: |
| 5431 | print(issue_url) |
| 5432 | return 0 |
| 5433 | |
Sergiy Byelozyorov | 2b71832 | 2018-10-24 17:43:31 +0000 | [diff] [blame] | 5434 | # Redirect I/O before invoking browser to hide its output. For example, this |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5435 | # allows us to hide the "Created new window in existing browser session." |
| 5436 | # message from Chrome. Based on https://stackoverflow.com/a/2323563. |
Sergiy Byelozyorov | 2b71832 | 2018-10-24 17:43:31 +0000 | [diff] [blame] | 5437 | saved_stdout = os.dup(1) |
Sergiy Belozorov | 0668403 | 2019-03-06 16:53:08 +0000 | [diff] [blame] | 5438 | saved_stderr = os.dup(2) |
Sergiy Byelozyorov | 2b71832 | 2018-10-24 17:43:31 +0000 | [diff] [blame] | 5439 | os.close(1) |
Sergiy Belozorov | 0668403 | 2019-03-06 16:53:08 +0000 | [diff] [blame] | 5440 | os.close(2) |
Sergiy Byelozyorov | 2b71832 | 2018-10-24 17:43:31 +0000 | [diff] [blame] | 5441 | os.open(os.devnull, os.O_RDWR) |
| 5442 | try: |
| 5443 | webbrowser.open(issue_url) |
| 5444 | finally: |
| 5445 | os.dup2(saved_stdout, 1) |
Sergiy Belozorov | 0668403 | 2019-03-06 16:53:08 +0000 | [diff] [blame] | 5446 | os.dup2(saved_stderr, 2) |
thestig@chromium.org | 00858c8 | 2013-12-02 23:08:03 +0000 | [diff] [blame] | 5447 | return 0 |
| 5448 | |
| 5449 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5450 | @metrics.collector.collect_metrics('git cl set-commit') |
maruel@chromium.org | 27bb387 | 2011-05-30 20:33:19 +0000 | [diff] [blame] | 5451 | def CMDset_commit(parser, args): |
Andrii Shyshkalov | 0e889b7 | 2019-07-15 22:28:48 +0000 | [diff] [blame] | 5452 | """Sets the commit bit to trigger the CQ.""" |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 5453 | parser.add_option('-d', '--dry-run', action='store_true', |
| 5454 | help='trigger in dry run mode') |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 5455 | parser.add_option( |
| 5456 | '-q', |
| 5457 | '--quick-run', |
| 5458 | action='store_true', |
| 5459 | help='trigger in quick run mode ' |
| 5460 | '(https://source.chromium.org/chromium/chromium/src/+/main:docs/cq_qu' |
| 5461 | 'ick_run.md) (chromium only).') |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 5462 | parser.add_option('-c', '--clear', action='store_true', |
| 5463 | help='stop CQ run, if any') |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 5464 | parser.add_option( |
| 5465 | '-i', '--issue', type=int, |
| 5466 | help='Operate on this issue instead of the current branch\'s implicit ' |
| 5467 | 'issue.') |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 5468 | options, args = parser.parse_args(args) |
maruel@chromium.org | 27bb387 | 2011-05-30 20:33:19 +0000 | [diff] [blame] | 5469 | if args: |
| 5470 | parser.error('Unrecognized args: %s' % ' '.join(args)) |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 5471 | if [options.dry_run, options.quick_run, options.clear].count(True) > 1: |
| 5472 | parser.error('Only one of --dry-run, --quick-run, and --clear are allowed.') |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 5473 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5474 | cl = Changelist(issue=options.issue) |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 5475 | if not cl.GetIssue(): |
| 5476 | parser.error('Must upload the issue first.') |
| 5477 | |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 5478 | if options.clear: |
tandrii | d9e5ce5 | 2016-07-13 02:32:59 -0700 | [diff] [blame] | 5479 | state = _CQState.NONE |
Greg Guterman | be5fccd | 2021-06-14 17:58:20 +0000 | [diff] [blame] | 5480 | elif options.quick_run: |
| 5481 | state = _CQState.QUICK_RUN |
tandrii@chromium.org | fa330e8 | 2016-04-13 17:09:52 +0000 | [diff] [blame] | 5482 | elif options.dry_run: |
| 5483 | state = _CQState.DRY_RUN |
| 5484 | else: |
| 5485 | state = _CQState.COMMIT |
tandrii | 9de9ec6 | 2016-07-13 03:01:59 -0700 | [diff] [blame] | 5486 | cl.SetCQState(state) |
maruel@chromium.org | 27bb387 | 2011-05-30 20:33:19 +0000 | [diff] [blame] | 5487 | return 0 |
| 5488 | |
| 5489 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5490 | @metrics.collector.collect_metrics('git cl set-close') |
groby@chromium.org | 411034a | 2013-02-26 15:12:01 +0000 | [diff] [blame] | 5491 | def CMDset_close(parser, args): |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 5492 | """Closes the issue.""" |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 5493 | parser.add_option( |
| 5494 | '-i', '--issue', type=int, |
| 5495 | help='Operate on this issue instead of the current branch\'s implicit ' |
| 5496 | 'issue.') |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 5497 | options, args = parser.parse_args(args) |
groby@chromium.org | 411034a | 2013-02-26 15:12:01 +0000 | [diff] [blame] | 5498 | if args: |
| 5499 | parser.error('Unrecognized args: %s' % ' '.join(args)) |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5500 | cl = Changelist(issue=options.issue) |
groby@chromium.org | 411034a | 2013-02-26 15:12:01 +0000 | [diff] [blame] | 5501 | # Ensure there actually is an issue to close. |
Aaron Gable | 7139a4e | 2017-09-05 17:53:09 -0700 | [diff] [blame] | 5502 | if not cl.GetIssue(): |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5503 | DieWithError('ERROR: No issue to close.') |
groby@chromium.org | 411034a | 2013-02-26 15:12:01 +0000 | [diff] [blame] | 5504 | cl.CloseIssue() |
| 5505 | return 0 |
| 5506 | |
| 5507 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5508 | @metrics.collector.collect_metrics('git cl diff') |
sbc@chromium.org | 87b9bf0 | 2013-09-26 20:35:15 +0000 | [diff] [blame] | 5509 | def CMDdiff(parser, args): |
wychen@chromium.org | 37b2ec0 | 2015-04-03 00:49:15 +0000 | [diff] [blame] | 5510 | """Shows differences between local tree and last upload.""" |
thomasanderson | 074beb2 | 2016-08-29 14:03:20 -0700 | [diff] [blame] | 5511 | parser.add_option( |
| 5512 | '--stat', |
| 5513 | action='store_true', |
| 5514 | dest='stat', |
| 5515 | help='Generate a diffstat') |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 5516 | options, args = parser.parse_args(args) |
vadimsh@chromium.org | cf6a5d2 | 2015-04-09 22:02:00 +0000 | [diff] [blame] | 5517 | if args: |
| 5518 | parser.error('Unrecognized args: %s' % ' '.join(args)) |
wychen@chromium.org | 46309bf | 2015-04-03 21:04:49 +0000 | [diff] [blame] | 5519 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5520 | cl = Changelist() |
sbc@chromium.org | 78dc984 | 2013-11-25 18:43:44 +0000 | [diff] [blame] | 5521 | issue = cl.GetIssue() |
sbc@chromium.org | 87b9bf0 | 2013-09-26 20:35:15 +0000 | [diff] [blame] | 5522 | branch = cl.GetBranch() |
sbc@chromium.org | 78dc984 | 2013-11-25 18:43:44 +0000 | [diff] [blame] | 5523 | if not issue: |
| 5524 | DieWithError('No issue found for current branch (%s)' % branch) |
sbc@chromium.org | 87b9bf0 | 2013-09-26 20:35:15 +0000 | [diff] [blame] | 5525 | |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 5526 | base = cl._GitGetBranchConfigValue(LAST_UPLOAD_HASH_CONFIG_KEY) |
Aaron Gable | a718c3e | 2017-08-28 17:47:28 -0700 | [diff] [blame] | 5527 | if not base: |
Gavin Mak | be2e926 | 2022-11-08 23:41:55 +0000 | [diff] [blame] | 5528 | base = cl._GitGetBranchConfigValue(GERRIT_SQUASH_HASH_CONFIG_KEY) |
Aaron Gable | a718c3e | 2017-08-28 17:47:28 -0700 | [diff] [blame] | 5529 | if not base: |
| 5530 | detail = cl._GetChangeDetail(['CURRENT_REVISION', 'CURRENT_COMMIT']) |
| 5531 | revision_info = detail['revisions'][detail['current_revision']] |
| 5532 | fetch_info = revision_info['fetch']['http'] |
| 5533 | RunGit(['fetch', fetch_info['url'], fetch_info['ref']]) |
| 5534 | base = 'FETCH_HEAD' |
sbc@chromium.org | 87b9bf0 | 2013-09-26 20:35:15 +0000 | [diff] [blame] | 5535 | |
Aaron Gable | a718c3e | 2017-08-28 17:47:28 -0700 | [diff] [blame] | 5536 | cmd = ['git', 'diff'] |
| 5537 | if options.stat: |
| 5538 | cmd.append('--stat') |
| 5539 | cmd.append(base) |
| 5540 | subprocess2.check_call(cmd) |
sbc@chromium.org | 87b9bf0 | 2013-09-26 20:35:15 +0000 | [diff] [blame] | 5541 | |
| 5542 | return 0 |
| 5543 | |
| 5544 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5545 | @metrics.collector.collect_metrics('git cl owners') |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5546 | def CMDowners(parser, args): |
Dirk Pranke | bf98088 | 2017-09-02 15:08:00 -0700 | [diff] [blame] | 5547 | """Finds potential owners for reviewing.""" |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5548 | parser.add_option( |
Sidney San MartÃn | 8e6f58c | 2018-06-08 01:02:56 +0000 | [diff] [blame] | 5549 | '--ignore-current', |
| 5550 | action='store_true', |
| 5551 | help='Ignore the CL\'s current reviewers and start from scratch.') |
| 5552 | parser.add_option( |
Sylvain Defresne | b1f865d | 2019-02-12 12:38:22 +0000 | [diff] [blame] | 5553 | '--ignore-self', |
| 5554 | action='store_true', |
| 5555 | help='Do not consider CL\'s author as an owners.') |
| 5556 | parser.add_option( |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5557 | '--no-color', |
| 5558 | action='store_true', |
| 5559 | help='Use this option to disable color output') |
Dirk Pranke | bf98088 | 2017-09-02 15:08:00 -0700 | [diff] [blame] | 5560 | parser.add_option( |
| 5561 | '--batch', |
| 5562 | action='store_true', |
| 5563 | help='Do not run interactively, just suggest some') |
Yang Guo | 6e269a0 | 2019-06-26 11:17:02 +0000 | [diff] [blame] | 5564 | # TODO: Consider moving this to another command, since other |
| 5565 | # git-cl owners commands deal with owners for a given CL. |
| 5566 | parser.add_option( |
| 5567 | '--show-all', |
| 5568 | action='store_true', |
| 5569 | help='Show all owners for a particular file') |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5570 | options, args = parser.parse_args(args) |
| 5571 | |
Edward Lemur | 934836a | 2019-09-09 20:16:54 +0000 | [diff] [blame] | 5572 | cl = Changelist() |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 5573 | author = cl.GetAuthor() |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5574 | |
Yang Guo | 6e269a0 | 2019-06-26 11:17:02 +0000 | [diff] [blame] | 5575 | if options.show_all: |
Bruce Dawson | 97ed44a | 2020-05-06 17:04:03 +0000 | [diff] [blame] | 5576 | if len(args) == 0: |
| 5577 | print('No files specified for --show-all. Nothing to do.') |
| 5578 | return 0 |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 5579 | owners_by_path = cl.owners_client.BatchListOwners(args) |
Edward Lesmes | 0e4e5ae | 2021-01-08 18:28:46 +0000 | [diff] [blame] | 5580 | for path in args: |
| 5581 | print('Owners for %s:' % path) |
| 5582 | print('\n'.join( |
| 5583 | ' - %s' % owner |
| 5584 | for owner in owners_by_path.get(path, ['No owners found']))) |
Yang Guo | 6e269a0 | 2019-06-26 11:17:02 +0000 | [diff] [blame] | 5585 | return 0 |
| 5586 | |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5587 | if args: |
| 5588 | if len(args) > 1: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 5589 | parser.error('Unknown args.') |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5590 | base_branch = args[0] |
| 5591 | else: |
| 5592 | # Default to diffing against the common ancestor of the upstream branch. |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 5593 | base_branch = cl.GetCommonAncestorWithUpstream() |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5594 | |
Edward Lemur | 2c62b33 | 2020-03-12 22:12:33 +0000 | [diff] [blame] | 5595 | affected_files = cl.GetAffectedFiles(base_branch) |
Dirk Pranke | bf98088 | 2017-09-02 15:08:00 -0700 | [diff] [blame] | 5596 | |
| 5597 | if options.batch: |
Edward Lesmes | e157691 | 2021-02-16 21:53:34 +0000 | [diff] [blame] | 5598 | owners = cl.owners_client.SuggestOwners(affected_files, exclude=[author]) |
| 5599 | print('\n'.join(owners)) |
Dirk Pranke | bf98088 | 2017-09-02 15:08:00 -0700 | [diff] [blame] | 5600 | return 0 |
| 5601 | |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5602 | return owners_finder.OwnersFinder( |
Dirk Pranke | bf98088 | 2017-09-02 15:08:00 -0700 | [diff] [blame] | 5603 | affected_files, |
Edward Lemur | 707d70b | 2018-02-07 00:50:14 +0100 | [diff] [blame] | 5604 | author, |
Sidney San MartÃn | 8e6f58c | 2018-06-08 01:02:56 +0000 | [diff] [blame] | 5605 | [] if options.ignore_current else cl.GetReviewers(), |
Edward Lesmes | 5cd7547 | 2021-02-19 00:34:25 +0000 | [diff] [blame] | 5606 | cl.owners_client, |
Jochen Eisinger | d0573ec | 2017-04-13 10:55:06 +0200 | [diff] [blame] | 5607 | disable_color=options.no_color, |
Sylvain Defresne | b1f865d | 2019-02-12 12:38:22 +0000 | [diff] [blame] | 5608 | ignore_author=options.ignore_self).run() |
ikarienator@chromium.org | faf3fdf | 2013-09-20 02:11:48 +0000 | [diff] [blame] | 5609 | |
| 5610 | |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 5611 | def BuildGitDiffCmd(diff_type, upstream_commit, args, allow_prefix=False): |
erg@chromium.org | e0a7c5d | 2015-02-23 20:30:08 +0000 | [diff] [blame] | 5612 | """Generates a diff command.""" |
| 5613 | # Generate diff for the current branch's changes. |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 5614 | diff_cmd = ['-c', 'core.quotePath=false', 'diff', '--no-ext-diff'] |
| 5615 | |
Aiden Benner | 6c18a1a | 2018-11-23 20:18:23 +0000 | [diff] [blame] | 5616 | if allow_prefix: |
| 5617 | # explicitly setting --src-prefix and --dst-prefix is necessary in the |
| 5618 | # case that diff.noprefix is set in the user's git config. |
| 5619 | diff_cmd += ['--src-prefix=a/', '--dst-prefix=b/'] |
| 5620 | else: |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 5621 | diff_cmd += ['--no-prefix'] |
| 5622 | |
| 5623 | diff_cmd += [diff_type, upstream_commit, '--'] |
erg@chromium.org | e0a7c5d | 2015-02-23 20:30:08 +0000 | [diff] [blame] | 5624 | |
| 5625 | if args: |
| 5626 | for arg in args: |
jkarlin@chromium.org | 6f7fa5e | 2016-01-20 19:32:21 +0000 | [diff] [blame] | 5627 | if os.path.isdir(arg) or os.path.isfile(arg): |
erg@chromium.org | e0a7c5d | 2015-02-23 20:30:08 +0000 | [diff] [blame] | 5628 | diff_cmd.append(arg) |
| 5629 | else: |
| 5630 | DieWithError('Argument "%s" is not a file or a directory' % arg) |
erg@chromium.org | e0a7c5d | 2015-02-23 20:30:08 +0000 | [diff] [blame] | 5631 | |
| 5632 | return diff_cmd |
| 5633 | |
Andrii Shyshkalov | 1897532 | 2017-01-25 16:44:13 +0100 | [diff] [blame] | 5634 | |
Jamie Madill | 5e96ad1 | 2020-01-13 16:08:35 +0000 | [diff] [blame] | 5635 | def _RunClangFormatDiff(opts, clang_diff_files, top_dir, upstream_commit): |
| 5636 | """Runs clang-format-diff and sets a return value if necessary.""" |
| 5637 | |
| 5638 | if not clang_diff_files: |
| 5639 | return 0 |
| 5640 | |
| 5641 | # Set to 2 to signal to CheckPatchFormatted() that this patch isn't |
| 5642 | # formatted. This is used to block during the presubmit. |
| 5643 | return_value = 0 |
| 5644 | |
| 5645 | # Locate the clang-format binary in the checkout |
| 5646 | try: |
| 5647 | clang_format_tool = clang_format.FindClangFormatToolInChromiumTree() |
| 5648 | except clang_format.NotFoundError as e: |
| 5649 | DieWithError(e) |
| 5650 | |
| 5651 | if opts.full or settings.GetFormatFullByDefault(): |
| 5652 | cmd = [clang_format_tool] |
| 5653 | if not opts.dry_run and not opts.diff: |
| 5654 | cmd.append('-i') |
| 5655 | if opts.dry_run: |
| 5656 | for diff_file in clang_diff_files: |
| 5657 | with open(diff_file, 'r') as myfile: |
| 5658 | code = myfile.read().replace('\r\n', '\n') |
| 5659 | stdout = RunCommand(cmd + [diff_file], cwd=top_dir) |
| 5660 | stdout = stdout.replace('\r\n', '\n') |
| 5661 | if opts.diff: |
| 5662 | sys.stdout.write(stdout) |
| 5663 | if code != stdout: |
| 5664 | return_value = 2 |
| 5665 | else: |
| 5666 | stdout = RunCommand(cmd + clang_diff_files, cwd=top_dir) |
| 5667 | if opts.diff: |
| 5668 | sys.stdout.write(stdout) |
| 5669 | else: |
Jamie Madill | 5e96ad1 | 2020-01-13 16:08:35 +0000 | [diff] [blame] | 5670 | try: |
| 5671 | script = clang_format.FindClangFormatScriptInChromiumTree( |
| 5672 | 'clang-format-diff.py') |
| 5673 | except clang_format.NotFoundError as e: |
| 5674 | DieWithError(e) |
| 5675 | |
Josip Sokcevic | 2a827fc | 2022-03-04 17:51:47 +0000 | [diff] [blame] | 5676 | cmd = ['vpython3', script, '-p0'] |
Jamie Madill | 5e96ad1 | 2020-01-13 16:08:35 +0000 | [diff] [blame] | 5677 | if not opts.dry_run and not opts.diff: |
| 5678 | cmd.append('-i') |
| 5679 | |
| 5680 | diff_cmd = BuildGitDiffCmd('-U0', upstream_commit, clang_diff_files) |
Edward Lemur | 1a83da1 | 2020-03-04 21:18:36 +0000 | [diff] [blame] | 5681 | diff_output = RunGit(diff_cmd).encode('utf-8') |
Jamie Madill | 5e96ad1 | 2020-01-13 16:08:35 +0000 | [diff] [blame] | 5682 | |
Edward Lesmes | 89624cd | 2020-04-06 17:51:56 +0000 | [diff] [blame] | 5683 | env = os.environ.copy() |
| 5684 | env['PATH'] = ( |
| 5685 | str(os.path.dirname(clang_format_tool)) + os.pathsep + env['PATH']) |
| 5686 | stdout = RunCommand( |
| 5687 | cmd, stdin=diff_output, cwd=top_dir, env=env, |
Ilya Sherman | 7aed4bb | 2020-05-20 22:34:14 +0000 | [diff] [blame] | 5688 | shell=sys.platform.startswith('win32')) |
Jamie Madill | 5e96ad1 | 2020-01-13 16:08:35 +0000 | [diff] [blame] | 5689 | if opts.diff: |
| 5690 | sys.stdout.write(stdout) |
| 5691 | if opts.dry_run and len(stdout) > 0: |
| 5692 | return_value = 2 |
| 5693 | |
| 5694 | return return_value |
| 5695 | |
| 5696 | |
Lukasz Anforowicz | b4d3954 | 2021-09-30 23:39:25 +0000 | [diff] [blame] | 5697 | def _RunRustFmt(opts, rust_diff_files, top_dir, upstream_commit): |
| 5698 | """Runs rustfmt. Just like _RunClangFormatDiff returns 2 to indicate that |
| 5699 | presubmit checks have failed (and returns 0 otherwise).""" |
| 5700 | |
| 5701 | if not rust_diff_files: |
| 5702 | return 0 |
| 5703 | |
| 5704 | # Locate the rustfmt binary. |
| 5705 | try: |
| 5706 | rustfmt_tool = rustfmt.FindRustfmtToolInChromiumTree() |
| 5707 | except rustfmt.NotFoundError as e: |
| 5708 | DieWithError(e) |
| 5709 | |
| 5710 | # TODO(crbug.com/1231317): Support formatting only the changed lines |
| 5711 | # if `opts.full or settings.GetFormatFullByDefault()` is False. See also: |
| 5712 | # https://github.com/emilio/rustfmt-format-diff |
| 5713 | cmd = [rustfmt_tool] |
| 5714 | if opts.dry_run: |
| 5715 | cmd.append('--check') |
| 5716 | cmd += rust_diff_files |
| 5717 | rustfmt_exitcode = subprocess2.call(cmd) |
| 5718 | |
| 5719 | if opts.presubmit and rustfmt_exitcode != 0: |
| 5720 | return 2 |
Aravind Vasudevan | c5f0cbb | 2022-01-24 23:56:57 +0000 | [diff] [blame] | 5721 | |
| 5722 | return 0 |
Lukasz Anforowicz | b4d3954 | 2021-09-30 23:39:25 +0000 | [diff] [blame] | 5723 | |
| 5724 | |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 5725 | def _RunSwiftFormat(opts, swift_diff_files, top_dir, upstream_commit): |
| 5726 | """Runs swift-format. Just like _RunClangFormatDiff returns 2 to indicate |
| 5727 | that presubmit checks have failed (and returns 0 otherwise).""" |
| 5728 | |
| 5729 | if not swift_diff_files: |
| 5730 | return 0 |
| 5731 | |
| 5732 | # Locate the swift-format binary. |
| 5733 | try: |
| 5734 | swift_format_tool = swift_format.FindSwiftFormatToolInChromiumTree() |
| 5735 | except swift_format.NotFoundError as e: |
| 5736 | DieWithError(e) |
| 5737 | |
| 5738 | cmd = [swift_format_tool] |
| 5739 | if opts.dry_run: |
Olivier Robin | 7f39e3d | 2022-04-28 08:20:49 +0000 | [diff] [blame] | 5740 | cmd += ['lint', '-s'] |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 5741 | else: |
| 5742 | cmd += ['format', '-i'] |
| 5743 | cmd += swift_diff_files |
| 5744 | swift_format_exitcode = subprocess2.call(cmd) |
| 5745 | |
| 5746 | if opts.presubmit and swift_format_exitcode != 0: |
| 5747 | return 2 |
| 5748 | |
| 5749 | return 0 |
| 5750 | |
| 5751 | |
jkarlin@chromium.org | 6f7fa5e | 2016-01-20 19:32:21 +0000 | [diff] [blame] | 5752 | def MatchingFileType(file_name, extensions): |
Quinten Yearsley | d242ed7 | 2019-07-25 17:17:55 +0000 | [diff] [blame] | 5753 | """Returns True if the file name ends with one of the given extensions.""" |
jkarlin@chromium.org | 6f7fa5e | 2016-01-20 19:32:21 +0000 | [diff] [blame] | 5754 | return bool([ext for ext in extensions if file_name.lower().endswith(ext)]) |
erg@chromium.org | e0a7c5d | 2015-02-23 20:30:08 +0000 | [diff] [blame] | 5755 | |
Andrii Shyshkalov | 1897532 | 2017-01-25 16:44:13 +0100 | [diff] [blame] | 5756 | |
enne@chromium.org | 555cfe4 | 2014-01-29 18:21:39 +0000 | [diff] [blame] | 5757 | @subcommand.usage('[files or directories to diff]') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 5758 | @metrics.collector.collect_metrics('git cl format') |
agable@chromium.org | fab8f82 | 2013-05-06 17:43:09 +0000 | [diff] [blame] | 5759 | def CMDformat(parser, args): |
sbc@chromium.org | 9d0644d | 2015-06-05 23:16:54 +0000 | [diff] [blame] | 5760 | """Runs auto-formatting tools (clang-format etc.) on the diff.""" |
Christopher Lam | c5ba692 | 2017-01-24 11:19:14 +1100 | [diff] [blame] | 5761 | CLANG_EXTS = ['.cc', '.cpp', '.h', '.m', '.mm', '.proto', '.java'] |
kylechar | 58edce2 | 2016-06-17 06:07:51 -0700 | [diff] [blame] | 5762 | GN_EXTS = ['.gn', '.gni', '.typemap'] |
Lukasz Anforowicz | b4d3954 | 2021-09-30 23:39:25 +0000 | [diff] [blame] | 5763 | RUST_EXTS = ['.rs'] |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 5764 | SWIFT_EXTS = ['.swift'] |
enne@chromium.org | 3b7e15c | 2014-01-21 17:44:47 +0000 | [diff] [blame] | 5765 | parser.add_option('--full', action='store_true', |
| 5766 | help='Reformat the full content of all touched files') |
Tomasz Åšniatowski | 5819446 | 2021-08-27 17:36:16 +0000 | [diff] [blame] | 5767 | parser.add_option('--upstream', help='Branch to check against') |
enne@chromium.org | 3b7e15c | 2014-01-21 17:44:47 +0000 | [diff] [blame] | 5768 | parser.add_option('--dry-run', action='store_true', |
| 5769 | help='Don\'t modify any file on disk.') |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 5770 | parser.add_option( |
Garrett Beaty | ed0cc5f | 2020-01-06 17:26:13 +0000 | [diff] [blame] | 5771 | '--no-clang-format', |
| 5772 | dest='clang_format', |
| 5773 | action='store_false', |
| 5774 | default=True, |
| 5775 | help='Disables formatting of various file types using clang-format.') |
| 5776 | parser.add_option( |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 5777 | '--python', |
| 5778 | action='store_true', |
| 5779 | default=None, |
| 5780 | help='Enables python formatting on all python files.') |
| 5781 | parser.add_option( |
| 5782 | '--no-python', |
| 5783 | action='store_true', |
Garrett Beaty | 91a6f33 | 2020-01-06 16:57:24 +0000 | [diff] [blame] | 5784 | default=False, |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 5785 | help='Disables python formatting on all python files. ' |
Garrett Beaty | 91a6f33 | 2020-01-06 16:57:24 +0000 | [diff] [blame] | 5786 | 'If neither --python or --no-python are set, python files that have a ' |
| 5787 | '.style.yapf file in an ancestor directory will be formatted. ' |
| 5788 | 'It is an error to set both.') |
Garrett Beaty | ed0cc5f | 2020-01-06 17:26:13 +0000 | [diff] [blame] | 5789 | parser.add_option( |
| 5790 | '--js', |
| 5791 | action='store_true', |
| 5792 | help='Format javascript code with clang-format. ' |
| 5793 | 'Has no effect if --no-clang-format is set.') |
wittman@chromium.org | 04d5a22 | 2014-03-07 18:30:42 +0000 | [diff] [blame] | 5794 | parser.add_option('--diff', action='store_true', |
| 5795 | help='Print diff to stdout rather than modifying files.') |
Ilya Sherman | e081cbe | 2017-08-15 17:51:04 -0700 | [diff] [blame] | 5796 | parser.add_option('--presubmit', action='store_true', |
| 5797 | help='Used when running the script from a presubmit.') |
Lukasz Anforowicz | b4d3954 | 2021-09-30 23:39:25 +0000 | [diff] [blame] | 5798 | |
| 5799 | parser.add_option('--rust-fmt', |
| 5800 | dest='use_rust_fmt', |
| 5801 | action='store_true', |
| 5802 | default=rustfmt.IsRustfmtSupported(), |
| 5803 | help='Enables formatting of Rust file types using rustfmt.') |
| 5804 | parser.add_option( |
| 5805 | '--no-rust-fmt', |
| 5806 | dest='use_rust_fmt', |
| 5807 | action='store_false', |
| 5808 | help='Disables formatting of Rust file types using rustfmt.') |
| 5809 | |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 5810 | parser.add_option( |
| 5811 | '--swift-format', |
| 5812 | dest='use_swift_format', |
| 5813 | action='store_true', |
Olivier Robin | 7f39e3d | 2022-04-28 08:20:49 +0000 | [diff] [blame] | 5814 | default=swift_format.IsSwiftFormatSupported(), |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 5815 | help='Enables formatting of Swift file types using swift-format ' |
| 5816 | '(macOS host only).') |
| 5817 | parser.add_option( |
| 5818 | '--no-swift-format', |
| 5819 | dest='use_swift_format', |
| 5820 | action='store_false', |
| 5821 | help='Disables formatting of Swift file types using swift-format.') |
| 5822 | |
agable@chromium.org | fab8f82 | 2013-05-06 17:43:09 +0000 | [diff] [blame] | 5823 | opts, args = parser.parse_args(args) |
agable@chromium.org | fab8f82 | 2013-05-06 17:43:09 +0000 | [diff] [blame] | 5824 | |
Garrett Beaty | 91a6f33 | 2020-01-06 16:57:24 +0000 | [diff] [blame] | 5825 | if opts.python is not None and opts.no_python: |
| 5826 | raise parser.error('Cannot set both --python and --no-python') |
| 5827 | if opts.no_python: |
| 5828 | opts.python = False |
| 5829 | |
Daniel Cheng | c55eecf | 2016-12-30 03:11:02 -0800 | [diff] [blame] | 5830 | # Normalize any remaining args against the current path, so paths relative to |
| 5831 | # the current directory are still resolved as expected. |
| 5832 | args = [os.path.join(os.getcwd(), arg) for arg in args] |
| 5833 | |
enne@chromium.org | ff7a1fb | 2013-12-10 19:21:41 +0000 | [diff] [blame] | 5834 | # git diff generates paths against the root of the repository. Change |
| 5835 | # to that directory so clang-format can find files even within subdirs. |
thestig@chromium.org | 8b0553c | 2014-02-11 00:33:37 +0000 | [diff] [blame] | 5836 | rel_base_path = settings.GetRelativeRoot() |
enne@chromium.org | ff7a1fb | 2013-12-10 19:21:41 +0000 | [diff] [blame] | 5837 | if rel_base_path: |
| 5838 | os.chdir(rel_base_path) |
| 5839 | |
digit@chromium.org | 29e4727 | 2013-05-17 17:01:46 +0000 | [diff] [blame] | 5840 | # Grab the merge-base commit, i.e. the upstream commit of the current |
| 5841 | # branch when it was created or the last time it was rebased. This is |
| 5842 | # to cover the case where the user may have called "git fetch origin", |
| 5843 | # moving the origin branch to a newer commit, but hasn't rebased yet. |
| 5844 | upstream_commit = None |
Tomasz Åšniatowski | 5819446 | 2021-08-27 17:36:16 +0000 | [diff] [blame] | 5845 | upstream_branch = opts.upstream |
| 5846 | if not upstream_branch: |
| 5847 | cl = Changelist() |
| 5848 | upstream_branch = cl.GetUpstreamBranch() |
digit@chromium.org | 29e4727 | 2013-05-17 17:01:46 +0000 | [diff] [blame] | 5849 | if upstream_branch: |
| 5850 | upstream_commit = RunGit(['merge-base', 'HEAD', upstream_branch]) |
| 5851 | upstream_commit = upstream_commit.strip() |
| 5852 | |
| 5853 | if not upstream_commit: |
| 5854 | DieWithError('Could not find base commit for this branch. ' |
| 5855 | 'Are you in detached state?') |
| 5856 | |
jkarlin@chromium.org | 6f7fa5e | 2016-01-20 19:32:21 +0000 | [diff] [blame] | 5857 | changed_files_cmd = BuildGitDiffCmd('--name-only', upstream_commit, args) |
| 5858 | diff_output = RunGit(changed_files_cmd) |
| 5859 | diff_files = diff_output.splitlines() |
jkarlin@chromium.org | ad21b92 | 2016-01-28 17:48:42 +0000 | [diff] [blame] | 5860 | # Filter out files deleted by this CL |
| 5861 | diff_files = [x for x in diff_files if os.path.isfile(x)] |
erg@chromium.org | e0a7c5d | 2015-02-23 20:30:08 +0000 | [diff] [blame] | 5862 | |
Andreas Haas | 417d89c | 2020-02-06 10:24:27 +0000 | [diff] [blame] | 5863 | if opts.js: |
Deepanjan Roy | 605dd31 | 2018-07-02 17:48:54 +0000 | [diff] [blame] | 5864 | CLANG_EXTS.extend(['.js', '.ts']) |
Christopher Lam | c5ba692 | 2017-01-24 11:19:14 +1100 | [diff] [blame] | 5865 | |
Garrett Beaty | ed0cc5f | 2020-01-06 17:26:13 +0000 | [diff] [blame] | 5866 | clang_diff_files = [] |
| 5867 | if opts.clang_format: |
| 5868 | clang_diff_files = [ |
| 5869 | x for x in diff_files if MatchingFileType(x, CLANG_EXTS) |
| 5870 | ] |
jkarlin@chromium.org | 6f7fa5e | 2016-01-20 19:32:21 +0000 | [diff] [blame] | 5871 | python_diff_files = [x for x in diff_files if MatchingFileType(x, ['.py'])] |
Lukasz Anforowicz | b4d3954 | 2021-09-30 23:39:25 +0000 | [diff] [blame] | 5872 | rust_diff_files = [x for x in diff_files if MatchingFileType(x, RUST_EXTS)] |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 5873 | swift_diff_files = [x for x in diff_files if MatchingFileType(x, SWIFT_EXTS)] |
kylechar@chromium.org | 8b61f11 | 2016-02-05 13:28:58 +0000 | [diff] [blame] | 5874 | gn_diff_files = [x for x in diff_files if MatchingFileType(x, GN_EXTS)] |
digit@chromium.org | 29e4727 | 2013-05-17 17:01:46 +0000 | [diff] [blame] | 5875 | |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 5876 | top_dir = settings.GetRoot() |
nick@chromium.org | 3ac1c4e | 2014-01-16 02:44:42 +0000 | [diff] [blame] | 5877 | |
Jamie Madill | 5e96ad1 | 2020-01-13 16:08:35 +0000 | [diff] [blame] | 5878 | return_value = _RunClangFormatDiff(opts, clang_diff_files, top_dir, |
| 5879 | upstream_commit) |
agable@chromium.org | fab8f82 | 2013-05-06 17:43:09 +0000 | [diff] [blame] | 5880 | |
Lukasz Anforowicz | b4d3954 | 2021-09-30 23:39:25 +0000 | [diff] [blame] | 5881 | if opts.use_rust_fmt: |
| 5882 | rust_fmt_return_value = _RunRustFmt(opts, rust_diff_files, top_dir, |
| 5883 | upstream_commit) |
| 5884 | if rust_fmt_return_value == 2: |
| 5885 | return_value = 2 |
| 5886 | |
Olivier Robin | 0a6b544 | 2022-04-07 07:25:04 +0000 | [diff] [blame] | 5887 | if opts.use_swift_format: |
| 5888 | if sys.platform != 'darwin': |
| 5889 | DieWithError('swift-format is only supported on macOS.') |
| 5890 | swift_format_return_value = _RunSwiftFormat(opts, swift_diff_files, top_dir, |
| 5891 | upstream_commit) |
| 5892 | if swift_format_return_value == 2: |
| 5893 | return_value = 2 |
| 5894 | |
sbc@chromium.org | 9d0644d | 2015-06-05 23:16:54 +0000 | [diff] [blame] | 5895 | # Similar code to above, but using yapf on .py files rather than clang-format |
| 5896 | # on C/C++ files |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 5897 | py_explicitly_disabled = opts.python is not None and not opts.python |
| 5898 | if python_diff_files and not py_explicitly_disabled: |
Aiden Benner | e47ac15 | 2018-11-20 16:44:03 +0000 | [diff] [blame] | 5899 | depot_tools_path = os.path.dirname(os.path.abspath(__file__)) |
| 5900 | yapf_tool = os.path.join(depot_tools_path, 'yapf') |
sbc@chromium.org | 9d0644d | 2015-06-05 23:16:54 +0000 | [diff] [blame] | 5901 | |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 5902 | # Used for caching. |
| 5903 | yapf_configs = {} |
| 5904 | for f in python_diff_files: |
| 5905 | # Find the yapf style config for the current file, defaults to depot |
| 5906 | # tools default. |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 5907 | _FindYapfConfigFile(f, yapf_configs, top_dir) |
| 5908 | |
| 5909 | # Turn on python formatting by default if a yapf config is specified. |
| 5910 | # This breaks in the case of this repo though since the specified |
| 5911 | # style file is also the global default. |
| 5912 | if opts.python is None: |
| 5913 | filtered_py_files = [] |
| 5914 | for f in python_diff_files: |
| 5915 | if _FindYapfConfigFile(f, yapf_configs, top_dir) is not None: |
| 5916 | filtered_py_files.append(f) |
| 5917 | else: |
| 5918 | filtered_py_files = python_diff_files |
| 5919 | |
| 5920 | # Note: yapf still seems to fix indentation of the entire file |
| 5921 | # even if line ranges are specified. |
| 5922 | # See https://github.com/google/yapf/issues/499 |
| 5923 | if not opts.full and filtered_py_files: |
| 5924 | py_line_diffs = _ComputeDiffLineRanges(filtered_py_files, upstream_commit) |
| 5925 | |
Brian Sheedy | b4307d5 | 2019-12-02 19:18:17 +0000 | [diff] [blame] | 5926 | yapfignore_patterns = _GetYapfIgnorePatterns(top_dir) |
| 5927 | filtered_py_files = _FilterYapfIgnoredFiles(filtered_py_files, |
| 5928 | yapfignore_patterns) |
Brian Sheedy | 59b06a8 | 2019-10-14 17:03:29 +0000 | [diff] [blame] | 5929 | |
Aiden Benner | 99b0ccb | 2018-11-20 19:53:31 +0000 | [diff] [blame] | 5930 | for f in filtered_py_files: |
Andrew Grieve | fa40bfa | 2020-01-07 02:32:57 +0000 | [diff] [blame] | 5931 | yapf_style = _FindYapfConfigFile(f, yapf_configs, top_dir) |
| 5932 | # Default to pep8 if not .style.yapf is found. |
| 5933 | if not yapf_style: |
| 5934 | yapf_style = 'pep8' |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 5935 | |
Peter Wen | d939992 | 2020-06-17 17:33:49 +0000 | [diff] [blame] | 5936 | with open(f, 'r') as py_f: |
Andrew Grieve | b9e694c | 2021-11-15 19:04:46 +0000 | [diff] [blame] | 5937 | if 'python2' in py_f.readline(): |
Peter Wen | d939992 | 2020-06-17 17:33:49 +0000 | [diff] [blame] | 5938 | vpython_script = 'vpython' |
Andrew Grieve | b9e694c | 2021-11-15 19:04:46 +0000 | [diff] [blame] | 5939 | else: |
| 5940 | vpython_script = 'vpython3' |
Peter Wen | d939992 | 2020-06-17 17:33:49 +0000 | [diff] [blame] | 5941 | |
| 5942 | cmd = [vpython_script, yapf_tool, '--style', yapf_style, f] |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 5943 | |
| 5944 | has_formattable_lines = False |
| 5945 | if not opts.full: |
| 5946 | # Only run yapf over changed line ranges. |
| 5947 | for diff_start, diff_len in py_line_diffs[f]: |
| 5948 | diff_end = diff_start + diff_len - 1 |
| 5949 | # Yapf errors out if diff_end < diff_start but this |
| 5950 | # is a valid line range diff for a removal. |
| 5951 | if diff_end >= diff_start: |
| 5952 | has_formattable_lines = True |
| 5953 | cmd += ['-l', '{}-{}'.format(diff_start, diff_end)] |
| 5954 | # If all line diffs were removals we have nothing to format. |
| 5955 | if not has_formattable_lines: |
| 5956 | continue |
| 5957 | |
| 5958 | if opts.diff or opts.dry_run: |
| 5959 | cmd += ['--diff'] |
| 5960 | # Will return non-zero exit code if non-empty diff. |
Edward Lesmes | b7db183 | 2020-06-22 20:22:27 +0000 | [diff] [blame] | 5961 | stdout = RunCommand(cmd, |
| 5962 | error_ok=True, |
Josip Sokcevic | 673e8ed | 2021-10-27 23:46:18 +0000 | [diff] [blame] | 5963 | stderr=subprocess2.PIPE, |
Edward Lesmes | b7db183 | 2020-06-22 20:22:27 +0000 | [diff] [blame] | 5964 | cwd=top_dir, |
| 5965 | shell=sys.platform.startswith('win32')) |
Aiden Benner | c08566e | 2018-10-03 17:52:42 +0000 | [diff] [blame] | 5966 | if opts.diff: |
| 5967 | sys.stdout.write(stdout) |
| 5968 | elif len(stdout) > 0: |
| 5969 | return_value = 2 |
| 5970 | else: |
| 5971 | cmd += ['-i'] |
Edward Lesmes | b7db183 | 2020-06-22 20:22:27 +0000 | [diff] [blame] | 5972 | RunCommand(cmd, cwd=top_dir, shell=sys.platform.startswith('win32')) |
sbc@chromium.org | 9d0644d | 2015-06-05 23:16:54 +0000 | [diff] [blame] | 5973 | |
kylechar@chromium.org | 8b61f11 | 2016-02-05 13:28:58 +0000 | [diff] [blame] | 5974 | # Format GN build files. Always run on full build files for canonical form. |
| 5975 | if gn_diff_files: |
Andrii Shyshkalov | 1897532 | 2017-01-25 16:44:13 +0100 | [diff] [blame] | 5976 | cmd = ['gn', 'format'] |
brettw | 4b8ed59 | 2016-08-05 16:19:12 -0700 | [diff] [blame] | 5977 | if opts.dry_run or opts.diff: |
| 5978 | cmd.append('--dry-run') |
kylechar@chromium.org | 8b61f11 | 2016-02-05 13:28:58 +0000 | [diff] [blame] | 5979 | for gn_diff_file in gn_diff_files: |
brettw | 4b8ed59 | 2016-08-05 16:19:12 -0700 | [diff] [blame] | 5980 | gn_ret = subprocess2.call(cmd + [gn_diff_file], |
Ilya Sherman | 7aed4bb | 2020-05-20 22:34:14 +0000 | [diff] [blame] | 5981 | shell=sys.platform.startswith('win'), |
brettw | 4b8ed59 | 2016-08-05 16:19:12 -0700 | [diff] [blame] | 5982 | cwd=top_dir) |
| 5983 | if opts.dry_run and gn_ret == 2: |
| 5984 | return_value = 2 # Not formatted. |
| 5985 | elif opts.diff and gn_ret == 2: |
| 5986 | # TODO this should compute and print the actual diff. |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5987 | print('This change has GN build file diff for ' + gn_diff_file) |
brettw | 4b8ed59 | 2016-08-05 16:19:12 -0700 | [diff] [blame] | 5988 | elif gn_ret != 0: |
| 5989 | # For non-dry run cases (and non-2 return values for dry-run), a |
| 5990 | # nonzero error code indicates a failure, probably because the file |
| 5991 | # doesn't parse. |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 5992 | DieWithError('gn format failed on ' + gn_diff_file + |
| 5993 | '\nTry running `gn format` on this file manually.') |
kylechar@chromium.org | 8b61f11 | 2016-02-05 13:28:58 +0000 | [diff] [blame] | 5994 | |
Ilya Sherman | e081cbe | 2017-08-15 17:51:04 -0700 | [diff] [blame] | 5995 | # Skip the metrics formatting from the global presubmit hook. These files have |
| 5996 | # a separate presubmit hook that issues an error if the files need formatting, |
| 5997 | # whereas the top-level presubmit script merely issues a warning. Formatting |
| 5998 | # these files is somewhat slow, so it's important not to duplicate the work. |
| 5999 | if not opts.presubmit: |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6000 | for diff_xml in GetDiffXMLs(diff_files): |
| 6001 | xml_dir = GetMetricsDir(diff_xml) |
| 6002 | if not xml_dir: |
| 6003 | continue |
| 6004 | |
Ilya Sherman | e081cbe | 2017-08-15 17:51:04 -0700 | [diff] [blame] | 6005 | tool_dir = os.path.join(top_dir, xml_dir) |
Ilya Sherman | 7aed4bb | 2020-05-20 22:34:14 +0000 | [diff] [blame] | 6006 | pretty_print_tool = os.path.join(tool_dir, 'pretty_print.py') |
Fabrice de Gans | ecfab09 | 2022-09-15 20:59:01 +0000 | [diff] [blame] | 6007 | cmd = ['vpython3', pretty_print_tool, '--non-interactive'] |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6008 | |
| 6009 | # If the XML file is histograms.xml or enums.xml, add the xml path to the |
| 6010 | # command as histograms/pretty_print.py now needs a relative path argument |
| 6011 | # after splitting the histograms into multiple directories. |
| 6012 | # For example, in tools/metrics/ukm, pretty-print could be run using: |
| 6013 | # $ python pretty_print.py |
| 6014 | # But in tools/metrics/histogrmas, pretty-print should be run with an |
| 6015 | # additional relative path argument, like: |
Peter Kasting | ee08888 | 2021-08-03 17:57:00 +0000 | [diff] [blame] | 6016 | # $ python pretty_print.py metadata/UMA/histograms.xml |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6017 | # $ python pretty_print.py enums.xml |
| 6018 | |
Weilun Shi | b92c4b7 | 2020-08-27 17:45:11 +0000 | [diff] [blame] | 6019 | if (diff_xml.endswith('histograms.xml') or diff_xml.endswith('enums.xml') |
Weilun Shi | 4f50adb | 2023-01-17 20:43:17 +0000 | [diff] [blame] | 6020 | or diff_xml.endswith('histogram_suffixes_list.xml')): |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6021 | cmd.append(diff_xml) |
| 6022 | |
Ilya Sherman | e081cbe | 2017-08-15 17:51:04 -0700 | [diff] [blame] | 6023 | if opts.dry_run or opts.diff: |
| 6024 | cmd.append('--diff') |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6025 | |
Ilya Sherman | 7aed4bb | 2020-05-20 22:34:14 +0000 | [diff] [blame] | 6026 | # TODO(isherman): Once this file runs only on Python 3.3+, drop the |
| 6027 | # `shell` param and instead replace `'vpython'` with |
| 6028 | # `shutil.which('frob')` above: https://stackoverflow.com/a/32799942 |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6029 | stdout = RunCommand(cmd, |
| 6030 | cwd=top_dir, |
Ilya Sherman | 7aed4bb | 2020-05-20 22:34:14 +0000 | [diff] [blame] | 6031 | shell=sys.platform.startswith('win32')) |
Ilya Sherman | e081cbe | 2017-08-15 17:51:04 -0700 | [diff] [blame] | 6032 | if opts.diff: |
| 6033 | sys.stdout.write(stdout) |
| 6034 | if opts.dry_run and stdout: |
| 6035 | return_value = 2 # Not formatted. |
Alexei Svitkine | f3cac41 | 2017-02-06 11:08:50 -0500 | [diff] [blame] | 6036 | |
erg@chromium.org | e0a7c5d | 2015-02-23 20:30:08 +0000 | [diff] [blame] | 6037 | return return_value |
agable@chromium.org | fab8f82 | 2013-05-06 17:43:09 +0000 | [diff] [blame] | 6038 | |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 6039 | |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6040 | def GetDiffXMLs(diff_files): |
| 6041 | return [ |
| 6042 | os.path.normpath(x) for x in diff_files if MatchingFileType(x, ['.xml']) |
| 6043 | ] |
| 6044 | |
| 6045 | |
| 6046 | def GetMetricsDir(diff_xml): |
Steven Holte | 2e664bf | 2017-04-21 13:10:47 -0700 | [diff] [blame] | 6047 | metrics_xml_dirs = [ |
| 6048 | os.path.join('tools', 'metrics', 'actions'), |
| 6049 | os.path.join('tools', 'metrics', 'histograms'), |
| 6050 | os.path.join('tools', 'metrics', 'rappor'), |
Ilya Sherman | b67e60c | 2020-05-20 22:27:03 +0000 | [diff] [blame] | 6051 | os.path.join('tools', 'metrics', 'structured'), |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 6052 | os.path.join('tools', 'metrics', 'ukm'), |
| 6053 | ] |
Steven Holte | 2e664bf | 2017-04-21 13:10:47 -0700 | [diff] [blame] | 6054 | for xml_dir in metrics_xml_dirs: |
Wenhan (Han) Zhang | 3bd3c99 | 2020-08-14 16:27:39 +0000 | [diff] [blame] | 6055 | if diff_xml.startswith(xml_dir): |
| 6056 | return xml_dir |
| 6057 | return None |
Steven Holte | 2e664bf | 2017-04-21 13:10:47 -0700 | [diff] [blame] | 6058 | |
agable@chromium.org | fab8f82 | 2013-05-06 17:43:09 +0000 | [diff] [blame] | 6059 | |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6060 | @subcommand.usage('<codereview url or issue id>') |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 6061 | @metrics.collector.collect_metrics('git cl checkout') |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6062 | def CMDcheckout(parser, args): |
Edward Lemur | f38bc17 | 2019-09-03 21:02:13 +0000 | [diff] [blame] | 6063 | """Checks out a branch associated with a given Gerrit issue.""" |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6064 | _, args = parser.parse_args(args) |
| 6065 | |
| 6066 | if len(args) != 1: |
| 6067 | parser.print_help() |
| 6068 | return 1 |
| 6069 | |
tandrii@chromium.org | f86c7d3 | 2016-04-01 19:27:30 +0000 | [diff] [blame] | 6070 | issue_arg = ParseIssueNumberArgument(args[0]) |
tandrii@chromium.org | de6c9a1 | 2016-04-11 15:33:53 +0000 | [diff] [blame] | 6071 | if not issue_arg.valid: |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 6072 | parser.error('Invalid issue ID or URL.') |
Andrii Shyshkalov | c971239 | 2017-04-11 13:35:21 +0200 | [diff] [blame] | 6073 | |
tandrii@chromium.org | abd27e5 | 2016-04-11 15:43:32 +0000 | [diff] [blame] | 6074 | target_issue = str(issue_arg.issue) |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6075 | |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 6076 | output = RunGit(['config', '--local', '--get-regexp', |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 6077 | r'branch\..*\.' + ISSUE_CONFIG_KEY], |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 6078 | error_ok=True) |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6079 | |
tandrii@chromium.org | 5df290f | 2016-04-11 16:12:29 +0000 | [diff] [blame] | 6080 | branches = [] |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 6081 | for key, issue in [x.split() for x in output.splitlines()]: |
| 6082 | if issue == target_issue: |
Edward Lesmes | 50da770 | 2020-03-30 19:23:43 +0000 | [diff] [blame] | 6083 | branches.append(re.sub(r'branch\.(.*)\.' + ISSUE_CONFIG_KEY, r'\1', key)) |
Edward Lemur | 52969c9 | 2020-02-06 18:15:28 +0000 | [diff] [blame] | 6084 | |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6085 | if len(branches) == 0: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 6086 | print('No branch found for issue %s.' % target_issue) |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6087 | return 1 |
| 6088 | if len(branches) == 1: |
| 6089 | RunGit(['checkout', branches[0]]) |
| 6090 | else: |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 6091 | print('Multiple branches match issue %s:' % target_issue) |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6092 | for i in range(len(branches)): |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 6093 | print('%d: %s' % (i, branches[i])) |
Edward Lesmes | ae3586b | 2020-03-23 21:21:14 +0000 | [diff] [blame] | 6094 | which = gclient_utils.AskForData('Choose by index: ') |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6095 | try: |
| 6096 | RunGit(['checkout', branches[int(which)]]) |
| 6097 | except (IndexError, ValueError): |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 6098 | print('Invalid selection, not checking out any branch.') |
scottmg@chromium.org | 84a80c4 | 2015-09-22 20:40:37 +0000 | [diff] [blame] | 6099 | return 1 |
| 6100 | |
| 6101 | return 0 |
| 6102 | |
| 6103 | |
maruel@chromium.org | 29404b5 | 2014-09-08 22:58:00 +0000 | [diff] [blame] | 6104 | def CMDlol(parser, args): |
| 6105 | # This command is intentionally undocumented. |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 6106 | print(zlib.decompress(base64.b64decode( |
thakis@chromium.org | 3421c99 | 2014-11-02 02:20:32 +0000 | [diff] [blame] | 6107 | 'eNptkLEOwyAMRHe+wupCIqW57v0Vq84WqWtXyrcXnCBsmgMJ+/SSAxMZgRB6NzE' |
| 6108 | 'E2ObgCKJooYdu4uAQVffUEoE1sRQLxAcqzd7uK2gmStrll1ucV3uZyaY5sXyDd9' |
| 6109 | 'JAnN+lAXsOMJ90GANAi43mq5/VeeacylKVgi8o6F1SC63FxnagHfJUTfUYdCR/W' |
Gavin Mak | 18f45d2 | 2020-12-04 21:45:10 +0000 | [diff] [blame] | 6110 | 'Ofe+0dHL7PicpytKP750Fh1q2qnLVof4w8OZWNY')).decode('utf-8')) |
maruel@chromium.org | 29404b5 | 2014-09-08 22:58:00 +0000 | [diff] [blame] | 6111 | return 0 |
| 6112 | |
| 6113 | |
Josip Sokcevic | 0399e17 | 2022-03-21 23:11:51 +0000 | [diff] [blame] | 6114 | def CMDversion(parser, args): |
| 6115 | import utils |
| 6116 | print(utils.depot_tools_version()) |
| 6117 | |
| 6118 | |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 6119 | class OptionParser(optparse.OptionParser): |
| 6120 | """Creates the option parse and add --verbose support.""" |
Sigurd Schneider | 9abde8c | 2020-11-17 08:44:52 +0000 | [diff] [blame] | 6121 | |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 6122 | def __init__(self, *args, **kwargs): |
maruel@chromium.org | 0633fb4 | 2013-08-16 20:06:14 +0000 | [diff] [blame] | 6123 | optparse.OptionParser.__init__( |
| 6124 | self, *args, prog='git cl', version=__version__, **kwargs) |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 6125 | self.add_option( |
| 6126 | '-v', '--verbose', action='count', default=0, |
| 6127 | help='Use 2 times for more debugging info') |
| 6128 | |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 6129 | def parse_args(self, args=None, _values=None): |
Andrii Shyshkalov | 46f20cd | 2018-10-30 06:42:54 +0000 | [diff] [blame] | 6130 | try: |
| 6131 | return self._parse_args(args) |
| 6132 | finally: |
| 6133 | # Regardless of success or failure of args parsing, we want to report |
| 6134 | # metrics, but only after logging has been initialized (if parsing |
| 6135 | # succeeded). |
| 6136 | global settings |
| 6137 | settings = Settings() |
| 6138 | |
Edward Lesmes | 9c34906 | 2021-05-06 20:02:39 +0000 | [diff] [blame] | 6139 | if metrics.collector.config.should_collect_metrics: |
Andrii Shyshkalov | 46f20cd | 2018-10-30 06:42:54 +0000 | [diff] [blame] | 6140 | # GetViewVCUrl ultimately calls logging method. |
| 6141 | project_url = settings.GetViewVCUrl().strip('/+') |
| 6142 | if project_url in metrics_utils.KNOWN_PROJECT_URLS: |
| 6143 | metrics.collector.add('project_urls', [project_url]) |
| 6144 | |
| 6145 | def _parse_args(self, args=None): |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 6146 | # Create an optparse.Values object that will store only the actual passed |
| 6147 | # options, without the defaults. |
| 6148 | actual_options = optparse.Values() |
| 6149 | _, args = optparse.OptionParser.parse_args(self, args, actual_options) |
| 6150 | # Create an optparse.Values object with the default options. |
| 6151 | options = optparse.Values(self.get_default_values().__dict__) |
| 6152 | # Update it with the options passed by the user. |
| 6153 | options._update_careful(actual_options.__dict__) |
| 6154 | # Store the options passed by the user in an _actual_options attribute. |
| 6155 | # We store only the keys, and not the values, since the values can contain |
| 6156 | # arbitrary information, which might be PII. |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 6157 | metrics.collector.add('arguments', list(actual_options.__dict__.keys())) |
Edward Lemur | 5ba1e9c | 2018-07-23 18:19:02 +0000 | [diff] [blame] | 6158 | |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 6159 | levels = [logging.WARNING, logging.INFO, logging.DEBUG] |
Andrii Shyshkalov | 5b04a57 | 2017-01-23 17:44:41 +0100 | [diff] [blame] | 6160 | logging.basicConfig( |
| 6161 | level=levels[min(options.verbose, len(levels) - 1)], |
| 6162 | format='[%(levelname).1s%(asctime)s %(process)d %(thread)d ' |
| 6163 | '%(filename)s] %(message)s') |
Edward Lemur | 83bd7f4 | 2018-10-10 00:14:21 +0000 | [diff] [blame] | 6164 | |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 6165 | return options, args |
| 6166 | |
iannucci@chromium.org | d9c1b20 | 2013-07-24 23:52:11 +0000 | [diff] [blame] | 6167 | |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 6168 | def main(argv): |
maruel@chromium.org | 82798cb | 2012-02-23 18:16:12 +0000 | [diff] [blame] | 6169 | if sys.hexversion < 0x02060000: |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 6170 | print('\nYour Python version %s is unsupported, please upgrade.\n' % |
vapier | a7fbd5a | 2016-06-16 09:17:49 -0700 | [diff] [blame] | 6171 | (sys.version.split(' ', 1)[0],), file=sys.stderr) |
maruel@chromium.org | 82798cb | 2012-02-23 18:16:12 +0000 | [diff] [blame] | 6172 | return 2 |
maruel@chromium.org | 2e23ce3 | 2013-05-07 12:42:28 +0000 | [diff] [blame] | 6173 | |
maruel@chromium.org | 39c0b22 | 2013-08-17 16:57:01 +0000 | [diff] [blame] | 6174 | colorize_CMDstatus_doc() |
maruel@chromium.org | 0633fb4 | 2013-08-16 20:06:14 +0000 | [diff] [blame] | 6175 | dispatcher = subcommand.CommandDispatcher(__name__) |
| 6176 | try: |
| 6177 | return dispatcher.execute(OptionParser(), argv) |
Edward Lemur | 5b929a4 | 2019-10-21 17:57:39 +0000 | [diff] [blame] | 6178 | except auth.LoginRequiredError as e: |
vadimsh@chromium.org | eed4df3 | 2015-04-10 21:30:20 +0000 | [diff] [blame] | 6179 | DieWithError(str(e)) |
Edward Lemur | 79d4f99 | 2019-11-11 23:49:02 +0000 | [diff] [blame] | 6180 | except urllib.error.HTTPError as e: |
maruel@chromium.org | 0633fb4 | 2013-08-16 20:06:14 +0000 | [diff] [blame] | 6181 | if e.code != 500: |
| 6182 | raise |
| 6183 | DieWithError( |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 6184 | ('App Engine is misbehaving and returned HTTP %d, again. Keep faith ' |
Quinten Yearsley | c420221 | 2019-07-22 23:34:40 +0000 | [diff] [blame] | 6185 | 'and retry or visit go/isgaeup.\n%s') % (e.code, str(e))) |
sbc@chromium.org | 013731e | 2015-02-26 18:28:43 +0000 | [diff] [blame] | 6186 | return 0 |
chase@chromium.org | cc51cd0 | 2010-12-23 00:48:39 +0000 | [diff] [blame] | 6187 | |
| 6188 | |
| 6189 | if __name__ == '__main__': |
Quinten Yearsley | d9cbe7a | 2019-09-03 16:49:11 +0000 | [diff] [blame] | 6190 | # These affect sys.stdout, so do it outside of main() to simplify mocks in |
| 6191 | # the unit tests. |
maruel@chromium.org | 6f09cd9 | 2011-04-01 16:38:12 +0000 | [diff] [blame] | 6192 | fix_encoding.fix_encoding() |
iannucci@chromium.org | 596cd5c | 2016-04-04 21:34:39 +0000 | [diff] [blame] | 6193 | setup_color.init() |
Edward Lemur | 6f812e1 | 2018-07-31 22:45:57 +0000 | [diff] [blame] | 6194 | with metrics.collector.print_notice_and_exit(): |
sbc@chromium.org | 013731e | 2015-02-26 18:28:43 +0000 | [diff] [blame] | 6195 | sys.exit(main(sys.argv[1:])) |