Mike Frysinger | e58c0e2 | 2017-10-04 15:43:30 -0400 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 2 | # Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
| 3 | # Use of this source code is governed by a BSD-style license that can be |
| 4 | # found in the LICENSE file. |
| 5 | |
Mike Frysinger | 0873751 | 2014-02-07 22:58:26 -0500 | [diff] [blame] | 6 | """A command line interface to Gerrit-on-borg instances. |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 7 | |
| 8 | Internal Note: |
| 9 | To expose a function directly to the command line interface, name your function |
| 10 | with the prefix "UserAct". |
| 11 | """ |
| 12 | |
Mike Frysinger | 31ff6f9 | 2014-02-08 04:33:03 -0500 | [diff] [blame] | 13 | from __future__ import print_function |
| 14 | |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 15 | import collections |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 16 | import inspect |
Mike Frysinger | 87c74ce | 2017-04-04 16:12:31 -0400 | [diff] [blame] | 17 | import json |
Vadim Bendebury | dcfe232 | 2013-05-23 10:54:49 -0700 | [diff] [blame] | 18 | import re |
Mike Frysinger | 87c74ce | 2017-04-04 16:12:31 -0400 | [diff] [blame] | 19 | import sys |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 20 | |
Aviv Keshet | b7519e1 | 2016-10-04 00:50:00 -0700 | [diff] [blame] | 21 | from chromite.lib import config_lib |
| 22 | from chromite.lib import constants |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 23 | from chromite.lib import commandline |
| 24 | from chromite.lib import cros_build_lib |
Ralph Nathan | 446aee9 | 2015-03-23 14:44:56 -0700 | [diff] [blame] | 25 | from chromite.lib import cros_logging as logging |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 26 | from chromite.lib import gerrit |
Mike Frysinger | c85d816 | 2014-02-08 00:45:21 -0500 | [diff] [blame] | 27 | from chromite.lib import gob_util |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 28 | from chromite.lib import parallel |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 29 | from chromite.lib import terminal |
Mike Frysinger | 479f119 | 2017-09-14 22:36:30 -0400 | [diff] [blame] | 30 | from chromite.lib import uri_lib |
Alex Klein | 337fee4 | 2019-07-08 11:38:26 -0600 | [diff] [blame] | 31 | from chromite.utils import memoize |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 32 | |
| 33 | |
Mike Frysinger | 108eda2 | 2018-06-06 18:45:12 -0400 | [diff] [blame] | 34 | # Locate actions that are exposed to the user. All functions that start |
| 35 | # with "UserAct" are fair game. |
| 36 | ACTION_PREFIX = 'UserAct' |
| 37 | |
| 38 | |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 39 | # How many connections we'll use in parallel. We don't want this to be too high |
| 40 | # so we don't go over our per-user quota. Pick 10 somewhat arbitrarily as that |
| 41 | # seems to be good enough for users. |
| 42 | CONNECTION_LIMIT = 10 |
| 43 | |
| 44 | |
Mike Frysinger | 031ad0b | 2013-05-14 18:15:34 -0400 | [diff] [blame] | 45 | COLOR = None |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 46 | |
| 47 | # Map the internal names to the ones we normally show on the web ui. |
| 48 | GERRIT_APPROVAL_MAP = { |
Vadim Bendebury | 5057183 | 2013-11-12 10:43:19 -0800 | [diff] [blame] | 49 | 'COMR': ['CQ', 'Commit Queue ',], |
| 50 | 'CRVW': ['CR', 'Code Review ',], |
| 51 | 'SUBM': ['S ', 'Submitted ',], |
Vadim Bendebury | 5057183 | 2013-11-12 10:43:19 -0800 | [diff] [blame] | 52 | 'VRIF': ['V ', 'Verified ',], |
Jason D. Clinton | 729f81f | 2019-05-02 20:24:33 -0600 | [diff] [blame] | 53 | 'LCQ': ['L ', 'Legacy ',], |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 54 | } |
| 55 | |
| 56 | # Order is important -- matches the web ui. This also controls the short |
| 57 | # entries that we summarize in non-verbose mode. |
| 58 | GERRIT_SUMMARY_CATS = ('CR', 'CQ', 'V',) |
| 59 | |
Mike Frysinger | 4aea5dc | 2019-07-17 13:39:56 -0400 | [diff] [blame] | 60 | # Shorter strings for CL status messages. |
| 61 | GERRIT_SUMMARY_MAP = { |
| 62 | 'ABANDONED': 'ABD', |
| 63 | 'MERGED': 'MRG', |
| 64 | 'NEW': 'NEW', |
| 65 | 'WIP': 'WIP', |
| 66 | } |
| 67 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 68 | |
| 69 | def red(s): |
| 70 | return COLOR.Color(terminal.Color.RED, s) |
| 71 | |
| 72 | |
| 73 | def green(s): |
| 74 | return COLOR.Color(terminal.Color.GREEN, s) |
| 75 | |
| 76 | |
| 77 | def blue(s): |
| 78 | return COLOR.Color(terminal.Color.BLUE, s) |
| 79 | |
| 80 | |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 81 | def _run_parallel_tasks(task, *args): |
| 82 | """Small wrapper around BackgroundTaskRunner to enforce job count.""" |
| 83 | with parallel.BackgroundTaskRunner(task, processes=CONNECTION_LIMIT) as q: |
| 84 | for arg in args: |
| 85 | q.put([arg]) |
| 86 | |
| 87 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 88 | def limits(cls): |
| 89 | """Given a dict of fields, calculate the longest string lengths |
| 90 | |
| 91 | This allows you to easily format the output of many results so that the |
| 92 | various cols all line up correctly. |
| 93 | """ |
| 94 | lims = {} |
| 95 | for cl in cls: |
| 96 | for k in cl.keys(): |
Mike Frysinger | f16b8f0 | 2013-10-21 22:24:46 -0400 | [diff] [blame] | 97 | # Use %s rather than str() to avoid codec issues. |
| 98 | # We also do this so we can format integers. |
| 99 | lims[k] = max(lims.get(k, 0), len('%s' % cl[k])) |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 100 | return lims |
| 101 | |
| 102 | |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 103 | # TODO: This func really needs to be merged into the core gerrit logic. |
| 104 | def GetGerrit(opts, cl=None): |
| 105 | """Auto pick the right gerrit instance based on the |cl| |
| 106 | |
| 107 | Args: |
| 108 | opts: The general options object. |
| 109 | cl: A CL taking one of the forms: 1234 *1234 chromium:1234 |
| 110 | |
| 111 | Returns: |
| 112 | A tuple of a gerrit object and a sanitized CL #. |
| 113 | """ |
| 114 | gob = opts.gob |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 115 | if cl is not None: |
Jason D. Clinton | eb1073d | 2019-04-13 02:33:20 -0600 | [diff] [blame] | 116 | if cl.startswith('*') or cl.startswith('chrome-internal:'): |
Alex Klein | 2ab29cc | 2018-07-19 12:01:00 -0600 | [diff] [blame] | 117 | gob = config_lib.GetSiteParams().INTERNAL_GOB_INSTANCE |
Jason D. Clinton | eb1073d | 2019-04-13 02:33:20 -0600 | [diff] [blame] | 118 | if cl.startswith('*'): |
| 119 | cl = cl[1:] |
| 120 | else: |
| 121 | cl = cl[16:] |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 122 | elif ':' in cl: |
| 123 | gob, cl = cl.split(':', 1) |
| 124 | |
| 125 | if not gob in opts.gerrit: |
| 126 | opts.gerrit[gob] = gerrit.GetGerritHelper(gob=gob, print_cmd=opts.debug) |
| 127 | |
| 128 | return (opts.gerrit[gob], cl) |
| 129 | |
| 130 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 131 | def GetApprovalSummary(_opts, cls): |
| 132 | """Return a dict of the most important approvals""" |
| 133 | approvs = dict([(x, '') for x in GERRIT_SUMMARY_CATS]) |
Aviv Keshet | ad30cec | 2018-09-27 18:12:15 -0700 | [diff] [blame] | 134 | for approver in cls.get('currentPatchSet', {}).get('approvals', []): |
| 135 | cats = GERRIT_APPROVAL_MAP.get(approver['type']) |
| 136 | if not cats: |
| 137 | logging.warning('unknown gerrit approval type: %s', approver['type']) |
| 138 | continue |
| 139 | cat = cats[0].strip() |
| 140 | val = int(approver['value']) |
| 141 | if not cat in approvs: |
| 142 | # Ignore the extended categories in the summary view. |
| 143 | continue |
| 144 | elif approvs[cat] == '': |
| 145 | approvs[cat] = val |
| 146 | elif val < 0: |
| 147 | approvs[cat] = min(approvs[cat], val) |
| 148 | else: |
| 149 | approvs[cat] = max(approvs[cat], val) |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 150 | return approvs |
| 151 | |
| 152 | |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 153 | def PrettyPrintCl(opts, cl, lims=None, show_approvals=True): |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 154 | """Pretty print a single result""" |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 155 | if lims is None: |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 156 | lims = {'url': 0, 'project': 0} |
| 157 | |
| 158 | status = '' |
Mike Frysinger | 4aea5dc | 2019-07-17 13:39:56 -0400 | [diff] [blame] | 159 | |
| 160 | if opts.verbose: |
| 161 | status += '%s ' % (cl['status'],) |
| 162 | else: |
| 163 | status += '%s ' % (GERRIT_SUMMARY_MAP.get(cl['status'], cl['status']),) |
| 164 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 165 | if show_approvals and not opts.verbose: |
Mike Frysinger | b4a3e3c | 2017-04-05 16:06:53 -0400 | [diff] [blame] | 166 | approvs = GetApprovalSummary(opts, cl) |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 167 | for cat in GERRIT_SUMMARY_CATS: |
Mike Frysinger | a0313d0 | 2017-07-10 16:44:43 -0400 | [diff] [blame] | 168 | if approvs[cat] in ('', 0): |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 169 | functor = lambda x: x |
| 170 | elif approvs[cat] < 0: |
| 171 | functor = red |
| 172 | else: |
| 173 | functor = green |
| 174 | status += functor('%s:%2s ' % (cat, approvs[cat])) |
| 175 | |
Mike Frysinger | b4a3e3c | 2017-04-05 16:06:53 -0400 | [diff] [blame] | 176 | print('%s %s%-*s %s' % (blue('%-*s' % (lims['url'], cl['url'])), status, |
| 177 | lims['project'], cl['project'], cl['subject'])) |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 178 | |
| 179 | if show_approvals and opts.verbose: |
Mike Frysinger | b4a3e3c | 2017-04-05 16:06:53 -0400 | [diff] [blame] | 180 | for approver in cl['currentPatchSet'].get('approvals', []): |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 181 | functor = red if int(approver['value']) < 0 else green |
| 182 | n = functor('%2s' % approver['value']) |
| 183 | t = GERRIT_APPROVAL_MAP.get(approver['type'], [approver['type'], |
| 184 | approver['type']])[1] |
Mike Frysinger | 31ff6f9 | 2014-02-08 04:33:03 -0500 | [diff] [blame] | 185 | print(' %s %s %s' % (n, t, approver['by']['email'])) |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 186 | |
| 187 | |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 188 | def PrintCls(opts, cls, lims=None, show_approvals=True): |
Mike Frysinger | 87c74ce | 2017-04-04 16:12:31 -0400 | [diff] [blame] | 189 | """Print all results based on the requested format.""" |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 190 | if opts.raw: |
Alex Klein | 2ab29cc | 2018-07-19 12:01:00 -0600 | [diff] [blame] | 191 | site_params = config_lib.GetSiteParams() |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 192 | pfx = '' |
| 193 | # Special case internal Chrome GoB as that is what most devs use. |
| 194 | # They can always redirect the list elsewhere via the -g option. |
Alex Klein | 2ab29cc | 2018-07-19 12:01:00 -0600 | [diff] [blame] | 195 | if opts.gob == site_params.INTERNAL_GOB_INSTANCE: |
| 196 | pfx = site_params.INTERNAL_CHANGE_PREFIX |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 197 | for cl in cls: |
| 198 | print('%s%s' % (pfx, cl['number'])) |
| 199 | |
Mike Frysinger | 87c74ce | 2017-04-04 16:12:31 -0400 | [diff] [blame] | 200 | elif opts.json: |
| 201 | json.dump(cls, sys.stdout) |
| 202 | |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 203 | else: |
| 204 | if lims is None: |
| 205 | lims = limits(cls) |
| 206 | |
| 207 | for cl in cls: |
| 208 | PrettyPrintCl(opts, cl, lims=lims, show_approvals=show_approvals) |
| 209 | |
| 210 | |
Mike Frysinger | 5f938ca | 2017-07-19 18:29:02 -0400 | [diff] [blame] | 211 | def _Query(opts, query, raw=True, helper=None): |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 212 | """Queries Gerrit with a query string built from the commandline options""" |
Vadim Bendebury | 6e057b3 | 2014-12-29 09:41:36 -0800 | [diff] [blame] | 213 | if opts.branch is not None: |
| 214 | query += ' branch:%s' % opts.branch |
Mathieu Olivari | edc45b8 | 2015-01-12 19:43:20 -0800 | [diff] [blame] | 215 | if opts.project is not None: |
| 216 | query += ' project: %s' % opts.project |
Mathieu Olivari | 14645a1 | 2015-01-16 15:41:32 -0800 | [diff] [blame] | 217 | if opts.topic is not None: |
| 218 | query += ' topic: %s' % opts.topic |
Vadim Bendebury | 6e057b3 | 2014-12-29 09:41:36 -0800 | [diff] [blame] | 219 | |
Mike Frysinger | 5f938ca | 2017-07-19 18:29:02 -0400 | [diff] [blame] | 220 | if helper is None: |
| 221 | helper, _ = GetGerrit(opts) |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 222 | return helper.Query(query, raw=raw, bypass_cache=False) |
| 223 | |
| 224 | |
Mike Frysinger | 5f938ca | 2017-07-19 18:29:02 -0400 | [diff] [blame] | 225 | def FilteredQuery(opts, query, helper=None): |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 226 | """Query gerrit and filter/clean up the results""" |
| 227 | ret = [] |
| 228 | |
Mike Frysinger | 2cd5602 | 2017-01-12 20:56:27 -0500 | [diff] [blame] | 229 | logging.debug('Running query: %s', query) |
Mike Frysinger | 5f938ca | 2017-07-19 18:29:02 -0400 | [diff] [blame] | 230 | for cl in _Query(opts, query, raw=True, helper=helper): |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 231 | # Gerrit likes to return a stats record too. |
| 232 | if not 'project' in cl: |
| 233 | continue |
| 234 | |
| 235 | # Strip off common leading names since the result is still |
| 236 | # unique over the whole tree. |
| 237 | if not opts.verbose: |
Mike Frysinger | 1d50828 | 2018-06-07 16:59:44 -0400 | [diff] [blame] | 238 | for pfx in ('aosp', 'chromeos', 'chromiumos', 'external', 'overlays', |
| 239 | 'platform', 'third_party'): |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 240 | if cl['project'].startswith('%s/' % pfx): |
| 241 | cl['project'] = cl['project'][len(pfx) + 1:] |
| 242 | |
Mike Frysinger | 479f119 | 2017-09-14 22:36:30 -0400 | [diff] [blame] | 243 | cl['url'] = uri_lib.ShortenUri(cl['url']) |
| 244 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 245 | ret.append(cl) |
| 246 | |
Mike Frysinger | b62313a | 2017-06-30 16:38:58 -0400 | [diff] [blame] | 247 | if opts.sort == 'unsorted': |
| 248 | return ret |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 249 | if opts.sort == 'number': |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 250 | key = lambda x: int(x[opts.sort]) |
| 251 | else: |
| 252 | key = lambda x: x[opts.sort] |
| 253 | return sorted(ret, key=key) |
| 254 | |
| 255 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 256 | def UserActTodo(opts): |
| 257 | """List CLs needing your review""" |
Mike Frysinger | 8769055 | 2018-12-30 22:56:06 -0500 | [diff] [blame] | 258 | cls = FilteredQuery(opts, ('reviewer:self status:open NOT owner:self ' |
Mike Frysinger | ed3d7ea | 2017-07-10 13:14:02 -0400 | [diff] [blame] | 259 | 'label:Code-Review=0,user=self ' |
| 260 | 'NOT label:Verified<0')) |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 261 | PrintCls(opts, cls) |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 262 | |
| 263 | |
Mike Frysinger | a1db2c4 | 2014-06-15 00:42:48 -0700 | [diff] [blame] | 264 | def UserActSearch(opts, query): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 265 | """List CLs matching the search query""" |
Mike Frysinger | a1db2c4 | 2014-06-15 00:42:48 -0700 | [diff] [blame] | 266 | cls = FilteredQuery(opts, query) |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 267 | PrintCls(opts, cls) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 268 | UserActSearch.usage = '<query>' |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 269 | |
| 270 | |
Mike Frysinger | a1db2c4 | 2014-06-15 00:42:48 -0700 | [diff] [blame] | 271 | def UserActMine(opts): |
| 272 | """List your CLs with review statuses""" |
Vadim Bendebury | 0278a7e | 2015-09-05 15:23:13 -0700 | [diff] [blame] | 273 | if opts.draft: |
| 274 | rule = 'is:draft' |
| 275 | else: |
| 276 | rule = 'status:new' |
Mike Frysinger | 2cd5602 | 2017-01-12 20:56:27 -0500 | [diff] [blame] | 277 | UserActSearch(opts, 'owner:self %s' % (rule,)) |
Mike Frysinger | a1db2c4 | 2014-06-15 00:42:48 -0700 | [diff] [blame] | 278 | |
| 279 | |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 280 | def _BreadthFirstSearch(to_visit, children, visited_key=lambda x: x): |
| 281 | """Runs breadth first search starting from the nodes in |to_visit| |
| 282 | |
| 283 | Args: |
| 284 | to_visit: the starting nodes |
| 285 | children: a function which takes a node and returns the nodes adjacent to it |
| 286 | visited_key: a function for deduplicating node visits. Defaults to the |
| 287 | identity function (lambda x: x) |
| 288 | |
| 289 | Returns: |
| 290 | A list of nodes which are reachable from any node in |to_visit| by calling |
| 291 | |children| any number of times. |
| 292 | """ |
| 293 | to_visit = list(to_visit) |
Mike Frysinger | 66ce413 | 2019-07-17 22:52:52 -0400 | [diff] [blame] | 294 | seen = set(visited_key(x) for x in to_visit) |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 295 | for node in to_visit: |
| 296 | for child in children(node): |
| 297 | key = visited_key(child) |
| 298 | if key not in seen: |
| 299 | seen.add(key) |
| 300 | to_visit.append(child) |
| 301 | return to_visit |
| 302 | |
| 303 | |
| 304 | def UserActDeps(opts, query): |
| 305 | """List CLs matching a query, and all transitive dependencies of those CLs""" |
| 306 | cls = _Query(opts, query, raw=False) |
| 307 | |
Mike Frysinger | 1066629 | 2018-07-12 01:03:38 -0400 | [diff] [blame] | 308 | @memoize.Memoize |
Mike Frysinger | b3300c4 | 2017-07-20 01:41:17 -0400 | [diff] [blame] | 309 | def _QueryChange(cl, helper=None): |
| 310 | return _Query(opts, cl, raw=False, helper=helper) |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 311 | |
Mike Frysinger | 5726da9 | 2017-09-20 22:14:25 -0400 | [diff] [blame] | 312 | def _ProcessDeps(cl, deps, required): |
| 313 | """Yields matching dependencies for a patch""" |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 314 | # We need to query the change to guarantee that we have a .gerrit_number |
Mike Frysinger | 5726da9 | 2017-09-20 22:14:25 -0400 | [diff] [blame] | 315 | for dep in deps: |
Mike Frysinger | b3300c4 | 2017-07-20 01:41:17 -0400 | [diff] [blame] | 316 | if not dep.remote in opts.gerrit: |
| 317 | opts.gerrit[dep.remote] = gerrit.GetGerritHelper( |
| 318 | remote=dep.remote, print_cmd=opts.debug) |
| 319 | helper = opts.gerrit[dep.remote] |
| 320 | |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 321 | # TODO(phobbs) this should maybe catch network errors. |
Mike Frysinger | 5726da9 | 2017-09-20 22:14:25 -0400 | [diff] [blame] | 322 | changes = _QueryChange(dep.ToGerritQueryText(), helper=helper) |
| 323 | |
| 324 | # Handle empty results. If we found a commit that was pushed directly |
| 325 | # (e.g. a bot commit), then gerrit won't know about it. |
| 326 | if not changes: |
| 327 | if required: |
| 328 | logging.error('CL %s depends on %s which cannot be found', |
| 329 | cl, dep.ToGerritQueryText()) |
| 330 | continue |
| 331 | |
| 332 | # Our query might have matched more than one result. This can come up |
| 333 | # when CQ-DEPEND uses a Gerrit Change-Id, but that Change-Id shows up |
| 334 | # across multiple repos/branches. We blindly check all of them in the |
| 335 | # hopes that all open ones are what the user wants, but then again the |
| 336 | # CQ-DEPEND syntax itself is unable to differeniate. *shrug* |
| 337 | if len(changes) > 1: |
| 338 | logging.warning('CL %s has an ambiguous CQ dependency %s', |
| 339 | cl, dep.ToGerritQueryText()) |
| 340 | for change in changes: |
| 341 | if change.status == 'NEW': |
| 342 | yield change |
| 343 | |
| 344 | def _Children(cl): |
| 345 | """Yields the Gerrit and CQ-Depends dependencies of a patch""" |
| 346 | for change in _ProcessDeps(cl, cl.PaladinDependencies(None), True): |
| 347 | yield change |
| 348 | for change in _ProcessDeps(cl, cl.GerritDependencies(), False): |
| 349 | yield change |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 350 | |
| 351 | transitives = _BreadthFirstSearch( |
| 352 | cls, _Children, |
| 353 | visited_key=lambda cl: cl.gerrit_number) |
| 354 | |
| 355 | transitives_raw = [cl.patch_dict for cl in transitives] |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 356 | PrintCls(opts, transitives_raw) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 357 | UserActDeps.usage = '<query>' |
Paul Hobbs | 8976523 | 2015-06-24 14:07:49 -0700 | [diff] [blame] | 358 | |
| 359 | |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 360 | def UserActInspect(opts, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 361 | """Show the details of one or more CLs""" |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 362 | cls = [] |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 363 | for arg in args: |
Mike Frysinger | 5f938ca | 2017-07-19 18:29:02 -0400 | [diff] [blame] | 364 | helper, cl = GetGerrit(opts, arg) |
| 365 | change = FilteredQuery(opts, 'change:%s' % cl, helper=helper) |
| 366 | if change: |
| 367 | cls.extend(change) |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 368 | else: |
Mike Frysinger | a1b4b27 | 2017-04-05 16:11:00 -0400 | [diff] [blame] | 369 | logging.warning('no results found for CL %s', arg) |
| 370 | PrintCls(opts, cls) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 371 | UserActInspect.usage = '<CLs...>' |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 372 | |
| 373 | |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 374 | def UserActLabel_as(opts, *args): |
| 375 | """Change the Auto-Submit label""" |
Jack Rosenthal | 8a1fb54 | 2019-08-07 10:23:56 -0600 | [diff] [blame] | 376 | num = args[-1] |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 377 | def task(arg): |
Jack Rosenthal | 8a1fb54 | 2019-08-07 10:23:56 -0600 | [diff] [blame] | 378 | helper, cl = GetGerrit(opts, arg) |
| 379 | helper.SetReview(cl, labels={'Auto-Submit': num}, |
| 380 | dryrun=opts.dryrun, notify=opts.notify) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 381 | _run_parallel_tasks(task, *args[:-1]) |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 382 | UserActLabel_as.arg_min = 2 |
| 383 | UserActLabel_as.usage = '<CLs...> <0|1>' |
Jack Rosenthal | 8a1fb54 | 2019-08-07 10:23:56 -0600 | [diff] [blame] | 384 | |
| 385 | |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 386 | def UserActLabel_cr(opts, *args): |
| 387 | """Change the Code-Review label (1=LGTM 2=LGTM+Approved)""" |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 388 | num = args[-1] |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 389 | def task(arg): |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 390 | helper, cl = GetGerrit(opts, arg) |
Vadim Bendebury | 2e3f82d | 2019-02-11 17:53:03 -0800 | [diff] [blame] | 391 | helper.SetReview(cl, labels={'Code-Review': num}, |
| 392 | dryrun=opts.dryrun, notify=opts.notify) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 393 | _run_parallel_tasks(task, *args[:-1]) |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 394 | UserActLabel_cr.arg_min = 2 |
| 395 | UserActLabel_cr.usage = '<CLs...> <-2|-1|0|1|2>' |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 396 | |
| 397 | |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 398 | def UserActLabel_v(opts, *args): |
| 399 | """Change the Verified label""" |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 400 | num = args[-1] |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 401 | def task(arg): |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 402 | helper, cl = GetGerrit(opts, arg) |
Vadim Bendebury | 2e3f82d | 2019-02-11 17:53:03 -0800 | [diff] [blame] | 403 | helper.SetReview(cl, labels={'Verified': num}, |
| 404 | dryrun=opts.dryrun, notify=opts.notify) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 405 | _run_parallel_tasks(task, *args[:-1]) |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 406 | UserActLabel_v.arg_min = 2 |
| 407 | UserActLabel_v.usage = '<CLs...> <-1|0|1>' |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 408 | |
| 409 | |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 410 | def UserActLabel_cq(opts, *args): |
| 411 | """Change the Commit-Queue label (1=dry-run 2=commit)""" |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 412 | num = args[-1] |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 413 | def task(arg): |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 414 | helper, cl = GetGerrit(opts, arg) |
Vadim Bendebury | 2e3f82d | 2019-02-11 17:53:03 -0800 | [diff] [blame] | 415 | helper.SetReview(cl, labels={'Commit-Queue': num}, |
| 416 | dryrun=opts.dryrun, notify=opts.notify) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 417 | _run_parallel_tasks(task, *args[:-1]) |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 418 | UserActLabel_cq.arg_min = 2 |
| 419 | UserActLabel_cq.usage = '<CLs...> <0|1|2>' |
Mike Frysinger | 15b23e4 | 2014-12-05 17:00:05 -0500 | [diff] [blame] | 420 | |
| 421 | |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 422 | def UserActSubmit(opts, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 423 | """Submit CLs""" |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 424 | def task(arg): |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 425 | helper, cl = GetGerrit(opts, arg) |
| 426 | helper.SubmitChange(cl, dryrun=opts.dryrun) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 427 | _run_parallel_tasks(task, *args) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 428 | UserActSubmit.usage = '<CLs...>' |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 429 | |
| 430 | |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 431 | def UserActAbandon(opts, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 432 | """Abandon CLs""" |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 433 | def task(arg): |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 434 | helper, cl = GetGerrit(opts, arg) |
| 435 | helper.AbandonChange(cl, dryrun=opts.dryrun) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 436 | _run_parallel_tasks(task, *args) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 437 | UserActAbandon.usage = '<CLs...>' |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 438 | |
| 439 | |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 440 | def UserActRestore(opts, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 441 | """Restore CLs that were abandoned""" |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 442 | def task(arg): |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 443 | helper, cl = GetGerrit(opts, arg) |
| 444 | helper.RestoreChange(cl, dryrun=opts.dryrun) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 445 | _run_parallel_tasks(task, *args) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 446 | UserActRestore.usage = '<CLs...>' |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 447 | |
| 448 | |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 449 | def UserActReviewers(opts, cl, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 450 | """Add/remove reviewers' emails for a CL (prepend with '~' to remove)""" |
Mike Frysinger | c15efa5 | 2013-12-12 01:13:56 -0500 | [diff] [blame] | 451 | emails = args |
Vadim Bendebury | dcfe232 | 2013-05-23 10:54:49 -0700 | [diff] [blame] | 452 | # Allow for optional leading '~'. |
| 453 | email_validator = re.compile(r'^[~]?%s$' % constants.EMAIL_REGEX) |
| 454 | add_list, remove_list, invalid_list = [], [], [] |
| 455 | |
| 456 | for x in emails: |
| 457 | if not email_validator.match(x): |
| 458 | invalid_list.append(x) |
| 459 | elif x[0] == '~': |
| 460 | remove_list.append(x[1:]) |
| 461 | else: |
| 462 | add_list.append(x) |
| 463 | |
| 464 | if invalid_list: |
| 465 | cros_build_lib.Die( |
| 466 | 'Invalid email address(es): %s' % ', '.join(invalid_list)) |
| 467 | |
| 468 | if add_list or remove_list: |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 469 | helper, cl = GetGerrit(opts, cl) |
| 470 | helper.SetReviewers(cl, add=add_list, remove=remove_list, |
| 471 | dryrun=opts.dryrun) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 472 | UserActReviewers.usage = '<CL> <emails...>' |
Vadim Bendebury | dcfe232 | 2013-05-23 10:54:49 -0700 | [diff] [blame] | 473 | |
| 474 | |
Allen Li | 38abdaa | 2017-03-16 13:25:02 -0700 | [diff] [blame] | 475 | def UserActAssign(opts, cl, assignee): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 476 | """Set the assignee for a CL""" |
Allen Li | 38abdaa | 2017-03-16 13:25:02 -0700 | [diff] [blame] | 477 | helper, cl = GetGerrit(opts, cl) |
| 478 | helper.SetAssignee(cl, assignee, dryrun=opts.dryrun) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 479 | UserActAssign.usage = '<CL> <assignee>' |
Allen Li | 38abdaa | 2017-03-16 13:25:02 -0700 | [diff] [blame] | 480 | |
| 481 | |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 482 | def UserActMessage(opts, cl, message): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 483 | """Add a message to a CL""" |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 484 | helper, cl = GetGerrit(opts, cl) |
| 485 | helper.SetReview(cl, msg=message, dryrun=opts.dryrun) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 486 | UserActMessage.usage = '<CL> <message>' |
Doug Anderson | 8119df0 | 2013-07-20 21:00:24 +0530 | [diff] [blame] | 487 | |
| 488 | |
Mathieu Olivari | 02f89b3 | 2015-01-09 13:53:38 -0800 | [diff] [blame] | 489 | def UserActTopic(opts, topic, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 490 | """Set a topic for one or more CLs""" |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 491 | def task(arg): |
Mathieu Olivari | 02f89b3 | 2015-01-09 13:53:38 -0800 | [diff] [blame] | 492 | helper, arg = GetGerrit(opts, arg) |
| 493 | helper.SetTopic(arg, topic, dryrun=opts.dryrun) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 494 | _run_parallel_tasks(task, *args) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 495 | UserActTopic.usage = '<topic> <CLs...>' |
| 496 | |
Mathieu Olivari | 02f89b3 | 2015-01-09 13:53:38 -0800 | [diff] [blame] | 497 | |
Prathmesh Prabhu | 871e777 | 2018-03-28 17:11:29 -0700 | [diff] [blame] | 498 | def UserActPrivate(opts, cl, private_str): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 499 | """Set the private bit on a CL to private""" |
Prathmesh Prabhu | 871e777 | 2018-03-28 17:11:29 -0700 | [diff] [blame] | 500 | try: |
| 501 | private = cros_build_lib.BooleanShellValue(private_str, False) |
| 502 | except ValueError: |
| 503 | raise RuntimeError('Unknown "boolean" value: %s' % private_str) |
| 504 | |
| 505 | helper, cl = GetGerrit(opts, cl) |
Mike Frysinger | c1bbdfd | 2020-02-06 23:54:48 -0500 | [diff] [blame] | 506 | helper.SetPrivate(cl, private, dryrun=opts.dryrun) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 507 | UserActPrivate.usage = '<CL> <private str>' |
Prathmesh Prabhu | 871e777 | 2018-03-28 17:11:29 -0700 | [diff] [blame] | 508 | |
Mathieu Olivari | 02f89b3 | 2015-01-09 13:53:38 -0800 | [diff] [blame] | 509 | |
Wei-Han Chen | b4c9af5 | 2017-02-09 14:43:22 +0800 | [diff] [blame] | 510 | def UserActSethashtags(opts, cl, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 511 | """Add/remove hashtags on a CL (prepend with '~' to remove)""" |
Wei-Han Chen | b4c9af5 | 2017-02-09 14:43:22 +0800 | [diff] [blame] | 512 | hashtags = args |
| 513 | add = [] |
| 514 | remove = [] |
| 515 | for hashtag in hashtags: |
| 516 | if hashtag.startswith('~'): |
| 517 | remove.append(hashtag[1:]) |
| 518 | else: |
| 519 | add.append(hashtag) |
| 520 | helper, cl = GetGerrit(opts, cl) |
| 521 | helper.SetHashtags(cl, add, remove, dryrun=opts.dryrun) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 522 | UserActSethashtags.usage = '<CL> <hashtags...>' |
Wei-Han Chen | b4c9af5 | 2017-02-09 14:43:22 +0800 | [diff] [blame] | 523 | |
| 524 | |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 525 | def UserActDeletedraft(opts, *args): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 526 | """Delete draft CLs""" |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 527 | def task(arg): |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 528 | helper, cl = GetGerrit(opts, arg) |
| 529 | helper.DeleteDraft(cl, dryrun=opts.dryrun) |
Mike Frysinger | 254f33f | 2019-12-11 13:54:29 -0500 | [diff] [blame] | 530 | _run_parallel_tasks(task, *args) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 531 | UserActDeletedraft.usage = '<CLs...>' |
Jon Salz | a427fb0 | 2014-03-07 18:13:17 +0800 | [diff] [blame] | 532 | |
| 533 | |
Mike Frysinger | 6f04dd4 | 2020-02-06 16:48:18 -0500 | [diff] [blame] | 534 | def UserActReviewed(opts, *args): |
| 535 | """Mark CLs as reviewed""" |
| 536 | def task(arg): |
| 537 | helper, cl = GetGerrit(opts, arg) |
| 538 | helper.ReviewedChange(cl, dryrun=opts.dryrun) |
| 539 | _run_parallel_tasks(task, *args) |
| 540 | UserActReviewed.usage = '<CLs...>' |
| 541 | |
| 542 | |
| 543 | def UserActUnreviewed(opts, *args): |
| 544 | """Mark CLs as unreviewed""" |
| 545 | def task(arg): |
| 546 | helper, cl = GetGerrit(opts, arg) |
| 547 | helper.UnreviewedChange(cl, dryrun=opts.dryrun) |
| 548 | _run_parallel_tasks(task, *args) |
| 549 | UserActUnreviewed.usage = '<CLs...>' |
| 550 | |
| 551 | |
| 552 | def UserActIgnore(opts, *args): |
| 553 | """Ignore CLs (suppress notifications/dashboard/etc...)""" |
| 554 | def task(arg): |
| 555 | helper, cl = GetGerrit(opts, arg) |
| 556 | helper.IgnoreChange(cl, dryrun=opts.dryrun) |
| 557 | _run_parallel_tasks(task, *args) |
| 558 | UserActIgnore.usage = '<CLs...>' |
| 559 | |
| 560 | |
| 561 | def UserActUnignore(opts, *args): |
| 562 | """Unignore CLs (enable notifications/dashboard/etc...)""" |
| 563 | def task(arg): |
| 564 | helper, cl = GetGerrit(opts, arg) |
| 565 | helper.UnignoreChange(cl, dryrun=opts.dryrun) |
| 566 | _run_parallel_tasks(task, *args) |
| 567 | UserActUnignore.usage = '<CLs...>' |
| 568 | |
| 569 | |
Yu-Ju Hong | c20d7b3 | 2014-11-18 07:51:11 -0800 | [diff] [blame] | 570 | def UserActAccount(opts): |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 571 | """Get the current user account information""" |
Yu-Ju Hong | c20d7b3 | 2014-11-18 07:51:11 -0800 | [diff] [blame] | 572 | helper, _ = GetGerrit(opts) |
Mike Frysinger | 87c74ce | 2017-04-04 16:12:31 -0400 | [diff] [blame] | 573 | acct = helper.GetAccount() |
| 574 | if opts.json: |
| 575 | json.dump(acct, sys.stdout) |
| 576 | else: |
| 577 | print('account_id:%i %s <%s>' % |
| 578 | (acct['_account_id'], acct['name'], acct['email'])) |
Yu-Ju Hong | c20d7b3 | 2014-11-18 07:51:11 -0800 | [diff] [blame] | 579 | |
| 580 | |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 581 | @memoize.Memoize |
| 582 | def _GetActions(): |
| 583 | """Get all the possible actions we support. |
| 584 | |
| 585 | Returns: |
| 586 | An ordered dictionary mapping the user subcommand (e.g. "foo") to the |
| 587 | function that implements that command (e.g. UserActFoo). |
| 588 | """ |
| 589 | ret = collections.OrderedDict() |
| 590 | for funcname in sorted(globals()): |
| 591 | if not funcname.startswith(ACTION_PREFIX): |
| 592 | continue |
| 593 | |
| 594 | # Turn "UserActFoo" into just "Foo" for further checking below. |
| 595 | funcname_chopped = funcname[len(ACTION_PREFIX):] |
| 596 | |
| 597 | # Sanity check names for devs adding new commands. Should be quick. |
| 598 | expected_funcname = funcname_chopped.lower().capitalize() |
| 599 | if funcname_chopped != expected_funcname: |
| 600 | raise RuntimeError('callback "%s" is misnamed; should be "%s"' % |
| 601 | (funcname_chopped, expected_funcname)) |
| 602 | |
| 603 | # Turn "Foo_bar" into "foo-bar". |
| 604 | cmdname = funcname_chopped.lower().replace('_', '-') |
| 605 | func = globals()[funcname] |
| 606 | ret[cmdname] = func |
| 607 | |
| 608 | return ret |
| 609 | |
| 610 | |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 611 | def _GetActionUsages(): |
| 612 | """Formats a one-line usage and doc message for each action.""" |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 613 | actions = _GetActions() |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 614 | |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 615 | cmds = list(actions.keys()) |
| 616 | functions = list(actions.values()) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 617 | usages = [getattr(x, 'usage', '') for x in functions] |
| 618 | docs = [x.__doc__ for x in functions] |
| 619 | |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 620 | cmd_indent = len(max(cmds, key=len)) |
| 621 | usage_indent = len(max(usages, key=len)) |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 622 | return '\n'.join( |
| 623 | ' %-*s %-*s : %s' % (cmd_indent, cmd, usage_indent, usage, doc) |
| 624 | for cmd, usage, doc in zip(cmds, usages, docs) |
| 625 | ) |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 626 | |
| 627 | |
Mike Frysinger | 108eda2 | 2018-06-06 18:45:12 -0400 | [diff] [blame] | 628 | def GetParser(): |
| 629 | """Returns the parser to use for this module.""" |
Mike Frysinger | ddf86eb | 2014-02-07 22:51:41 -0500 | [diff] [blame] | 630 | usage = """%(prog)s [options] <action> [action args] |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 631 | |
| 632 | There is no support for doing line-by-line code review via the command line. |
| 633 | This helps you manage various bits and CL status. |
| 634 | |
Mike Frysinger | a1db2c4 | 2014-06-15 00:42:48 -0700 | [diff] [blame] | 635 | For general Gerrit documentation, see: |
| 636 | https://gerrit-review.googlesource.com/Documentation/ |
| 637 | The Searching Changes page covers the search query syntax: |
| 638 | https://gerrit-review.googlesource.com/Documentation/user-search.html |
| 639 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 640 | Example: |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 641 | $ gerrit todo # List all the CLs that await your review. |
| 642 | $ gerrit mine # List all of your open CLs. |
| 643 | $ gerrit inspect 28123 # Inspect CL 28123 on the public gerrit. |
| 644 | $ gerrit inspect *28123 # Inspect CL 28123 on the internal gerrit. |
| 645 | $ gerrit label-v 28123 1 # Mark CL 28123 as verified (+1). |
Harry Cutts | de9b32c | 2019-02-21 15:25:35 -0800 | [diff] [blame] | 646 | $ gerrit reviewers 28123 foo@chromium.org # Add foo@ as a reviewer on CL \ |
| 647 | 28123. |
| 648 | $ gerrit reviewers 28123 ~foo@chromium.org # Remove foo@ as a reviewer on \ |
| 649 | CL 28123. |
Mike Frysinger | d8f841c | 2014-06-15 00:48:26 -0700 | [diff] [blame] | 650 | Scripting: |
Mike Frysinger | 48b5e01 | 2020-02-06 17:04:12 -0500 | [diff] [blame] | 651 | $ gerrit label-cq `gerrit --raw mine` 1 # Mark *ALL* of your public CLs \ |
| 652 | with Commit-Queue=1. |
| 653 | $ gerrit label-cq `gerrit --raw -i mine` 1 # Mark *ALL* of your internal \ |
| 654 | CLs with Commit-Queue=1. |
| 655 | $ gerrit --json search 'assignee:self' # Dump all pending CLs in JSON. |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 656 | |
Harry Cutts | 26076b3 | 2019-02-26 15:01:29 -0800 | [diff] [blame] | 657 | Actions: |
| 658 | """ |
| 659 | usage += _GetActionUsages() |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 660 | |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 661 | actions = _GetActions() |
| 662 | |
Alex Klein | 2ab29cc | 2018-07-19 12:01:00 -0600 | [diff] [blame] | 663 | site_params = config_lib.GetSiteParams() |
Mike Frysinger | ddf86eb | 2014-02-07 22:51:41 -0500 | [diff] [blame] | 664 | parser = commandline.ArgumentParser(usage=usage) |
Mike Frysinger | 0873751 | 2014-02-07 22:58:26 -0500 | [diff] [blame] | 665 | parser.add_argument('-i', '--internal', dest='gob', action='store_const', |
Alex Klein | 2ab29cc | 2018-07-19 12:01:00 -0600 | [diff] [blame] | 666 | default=site_params.EXTERNAL_GOB_INSTANCE, |
| 667 | const=site_params.INTERNAL_GOB_INSTANCE, |
Mike Frysinger | 0873751 | 2014-02-07 22:58:26 -0500 | [diff] [blame] | 668 | help='Query internal Chromium Gerrit instance') |
| 669 | parser.add_argument('-g', '--gob', |
Alex Klein | 2ab29cc | 2018-07-19 12:01:00 -0600 | [diff] [blame] | 670 | default=site_params.EXTERNAL_GOB_INSTANCE, |
Mike Frysinger | d6e2df0 | 2014-11-26 02:55:04 -0500 | [diff] [blame] | 671 | help=('Gerrit (on borg) instance to query (default: %s)' % |
Alex Klein | 2ab29cc | 2018-07-19 12:01:00 -0600 | [diff] [blame] | 672 | (site_params.EXTERNAL_GOB_INSTANCE))) |
Mike Frysinger | ddf86eb | 2014-02-07 22:51:41 -0500 | [diff] [blame] | 673 | parser.add_argument('--sort', default='number', |
Mike Frysinger | b62313a | 2017-06-30 16:38:58 -0400 | [diff] [blame] | 674 | help='Key to sort on (number, project); use "unsorted" ' |
| 675 | 'to disable') |
Mike Frysinger | f70bdc7 | 2014-06-15 00:44:06 -0700 | [diff] [blame] | 676 | parser.add_argument('--raw', default=False, action='store_true', |
| 677 | help='Return raw results (suitable for scripting)') |
Mike Frysinger | 87c74ce | 2017-04-04 16:12:31 -0400 | [diff] [blame] | 678 | parser.add_argument('--json', default=False, action='store_true', |
| 679 | help='Return results in JSON (suitable for scripting)') |
Mike Frysinger | 550d9aa | 2014-06-15 00:55:31 -0700 | [diff] [blame] | 680 | parser.add_argument('-n', '--dry-run', default=False, action='store_true', |
| 681 | dest='dryrun', |
| 682 | help='Show what would be done, but do not make changes') |
Vadim Bendebury | 2e3f82d | 2019-02-11 17:53:03 -0800 | [diff] [blame] | 683 | parser.add_argument('--ne', '--no-emails', default=True, action='store_false', |
| 684 | dest='send_email', |
| 685 | help='Do not send email for some operations ' |
| 686 | '(e.g. ready/review/trybotready/verify)') |
Mike Frysinger | ddf86eb | 2014-02-07 22:51:41 -0500 | [diff] [blame] | 687 | parser.add_argument('-v', '--verbose', default=False, action='store_true', |
| 688 | help='Be more verbose in output') |
Vadim Bendebury | 6e057b3 | 2014-12-29 09:41:36 -0800 | [diff] [blame] | 689 | parser.add_argument('-b', '--branch', |
| 690 | help='Limit output to the specific branch') |
Vadim Bendebury | 0278a7e | 2015-09-05 15:23:13 -0700 | [diff] [blame] | 691 | parser.add_argument('--draft', default=False, action='store_true', |
| 692 | help="Show draft changes (applicable to 'mine' only)") |
Mathieu Olivari | edc45b8 | 2015-01-12 19:43:20 -0800 | [diff] [blame] | 693 | parser.add_argument('-p', '--project', |
| 694 | help='Limit output to the specific project') |
Mathieu Olivari | 14645a1 | 2015-01-16 15:41:32 -0800 | [diff] [blame] | 695 | parser.add_argument('-t', '--topic', |
| 696 | help='Limit output to the specific topic') |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 697 | parser.add_argument('action', choices=list(actions.keys()), |
| 698 | help='The gerrit action to perform') |
Mike Frysinger | 0805c4a | 2017-02-14 17:38:17 -0500 | [diff] [blame] | 699 | parser.add_argument('args', nargs='*', help='Action arguments') |
Mike Frysinger | 108eda2 | 2018-06-06 18:45:12 -0400 | [diff] [blame] | 700 | |
| 701 | return parser |
| 702 | |
| 703 | |
| 704 | def main(argv): |
| 705 | parser = GetParser() |
Mike Frysinger | ddf86eb | 2014-02-07 22:51:41 -0500 | [diff] [blame] | 706 | opts = parser.parse_args(argv) |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 707 | |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 708 | # A cache of gerrit helpers we'll load on demand. |
| 709 | opts.gerrit = {} |
Vadim Bendebury | 2e3f82d | 2019-02-11 17:53:03 -0800 | [diff] [blame] | 710 | |
| 711 | # Convert user friendly command line option into a gerrit parameter. |
| 712 | opts.notify = 'ALL' if opts.send_email else 'NONE' |
Mike Frysinger | 88f2729 | 2014-06-17 09:40:45 -0700 | [diff] [blame] | 713 | opts.Freeze() |
| 714 | |
Mike Frysinger | 27e21b7 | 2018-07-12 14:20:21 -0400 | [diff] [blame] | 715 | # pylint: disable=global-statement |
Mike Frysinger | 031ad0b | 2013-05-14 18:15:34 -0400 | [diff] [blame] | 716 | global COLOR |
| 717 | COLOR = terminal.Color(enabled=opts.color) |
| 718 | |
Mike Frysinger | 13f23a4 | 2013-05-13 17:32:01 -0400 | [diff] [blame] | 719 | # Now look up the requested user action and run it. |
Mike Frysinger | 65fc863 | 2020-02-06 18:11:12 -0500 | [diff] [blame^] | 720 | actions = _GetActions() |
| 721 | functor = actions[opts.action] |
| 722 | argspec = inspect.getargspec(functor) |
| 723 | if argspec.varargs: |
| 724 | arg_min = getattr(functor, 'arg_min', len(argspec.args)) |
| 725 | if len(opts.args) < arg_min: |
| 726 | parser.error('incorrect number of args: %s expects at least %s' % |
| 727 | (opts.action, arg_min)) |
| 728 | elif len(argspec.args) - 1 != len(opts.args): |
| 729 | parser.error('incorrect number of args: %s expects %s' % |
| 730 | (opts.action, len(argspec.args) - 1)) |
| 731 | try: |
| 732 | functor(opts, *opts.args) |
| 733 | except (cros_build_lib.RunCommandError, gerrit.GerritException, |
| 734 | gob_util.GOBError) as e: |
| 735 | cros_build_lib.Die(e) |