You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
338 lines
10 KiB
Python
338 lines
10 KiB
Python
#!/usr/bin/env python
|
|
# Copyright 2017 The Chromium Authors. All rights reserved.
|
|
# Use of this source code is governed by a BSD-style license that can be
|
|
# found in the LICENSE file.
|
|
|
|
"""Simple client for the Gerrit REST API.
|
|
|
|
Example usage:
|
|
./gerrit_client.py [command] [args]""
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
|
|
import json
|
|
import logging
|
|
import optparse
|
|
import subcommand
|
|
import sys
|
|
|
|
if sys.version_info.major == 2:
|
|
import urlparse
|
|
from urllib import quote_plus
|
|
else:
|
|
from urllib.parse import quote_plus
|
|
import urllib.parse as urlparse
|
|
|
|
import fix_encoding
|
|
import gerrit_util
|
|
import setup_color
|
|
|
|
__version__ = '0.1'
|
|
|
|
|
|
def write_result(result, opt):
|
|
if opt.json_file:
|
|
with open(opt.json_file, 'w') as json_file:
|
|
json_file.write(json.dumps(result))
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDmovechanges(parser, args):
|
|
parser.add_option('-p', '--param', dest='params', action='append',
|
|
help='repeatable query parameter, format: -p key=value')
|
|
parser.add_option('--destination_branch', dest='destination_branch',
|
|
help='where to move changes to')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
assert opt.destination_branch, "--destination_branch not defined"
|
|
for p in opt.params:
|
|
assert '=' in p, '--param is key=value, not "%s"' % p
|
|
host = urlparse.urlparse(opt.host).netloc
|
|
|
|
limit = 100
|
|
while True:
|
|
result = gerrit_util.QueryChanges(
|
|
host,
|
|
list(tuple(p.split('=', 1)) for p in opt.params),
|
|
limit=limit,
|
|
)
|
|
for change in result:
|
|
gerrit_util.MoveChange(host, change['id'], opt.destination_branch)
|
|
|
|
if len(result) < limit:
|
|
break
|
|
logging.info("Done")
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDbranchinfo(parser, args):
|
|
parser.add_option('--branch', dest='branch', help='branch name')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
host = urlparse.urlparse(opt.host).netloc
|
|
project = quote_plus(opt.project)
|
|
branch = quote_plus(opt.branch)
|
|
result = gerrit_util.GetGerritBranch(host, project, branch)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDbranch(parser, args):
|
|
parser.add_option('--branch', dest='branch', help='branch name')
|
|
parser.add_option('--commit', dest='commit', help='commit hash')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
assert opt.project, "--project not defined"
|
|
assert opt.branch, "--branch not defined"
|
|
assert opt.commit, "--commit not defined"
|
|
|
|
project = quote_plus(opt.project)
|
|
host = urlparse.urlparse(opt.host).netloc
|
|
branch = quote_plus(opt.branch)
|
|
commit = quote_plus(opt.commit)
|
|
result = gerrit_util.CreateGerritBranch(host, project, branch, commit)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDhead(parser, args):
|
|
parser.add_option('--branch', dest='branch', help='branch name')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
assert opt.project, "--project not defined"
|
|
assert opt.branch, "--branch not defined"
|
|
|
|
project = quote_plus(opt.project)
|
|
host = urlparse.urlparse(opt.host).netloc
|
|
branch = quote_plus(opt.branch)
|
|
result = gerrit_util.UpdateHead(host, project, branch)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDheadinfo(parser, args):
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
assert opt.project, "--project not defined"
|
|
|
|
project = quote_plus(opt.project)
|
|
host = urlparse.urlparse(opt.host).netloc
|
|
result = gerrit_util.GetHead(host, project)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDchanges(parser, args):
|
|
parser.add_option('-p', '--param', dest='params', action='append',
|
|
help='repeatable query parameter, format: -p key=value')
|
|
parser.add_option('-o', '--o-param', dest='o_params', action='append',
|
|
help='gerrit output parameters, e.g. ALL_REVISIONS')
|
|
parser.add_option('--limit', dest='limit', type=int,
|
|
help='maximum number of results to return')
|
|
parser.add_option('--start', dest='start', type=int,
|
|
help='how many changes to skip '
|
|
'(starting with the most recent)')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
for p in opt.params:
|
|
assert '=' in p, '--param is key=value, not "%s"' % p
|
|
|
|
result = gerrit_util.QueryChanges(
|
|
urlparse.urlparse(opt.host).netloc,
|
|
list(tuple(p.split('=', 1)) for p in opt.params),
|
|
start=opt.start, # Default: None
|
|
limit=opt.limit, # Default: None
|
|
o_params=opt.o_params, # Default: None
|
|
)
|
|
logging.info('Change query returned %d changes.', len(result))
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDcreatechange(parser, args):
|
|
parser.add_option('-s', '--subject', help='subject for change')
|
|
parser.add_option('-b',
|
|
'--branch',
|
|
default='main',
|
|
help='target branch for change')
|
|
parser.add_option(
|
|
'-p',
|
|
'--param',
|
|
dest='params',
|
|
action='append',
|
|
help='repeatable field value parameter, format: -p key=value')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
for p in opt.params:
|
|
assert '=' in p, '--param is key=value, not "%s"' % p
|
|
|
|
result = gerrit_util.CreateChange(
|
|
urlparse.urlparse(opt.host).netloc,
|
|
opt.project,
|
|
branch=opt.branch,
|
|
subject=opt.subject,
|
|
params=list(tuple(p.split('=', 1)) for p in opt.params),
|
|
)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDchangeedit(parser, args):
|
|
parser.add_option('-c', '--change', type=int, help='change number')
|
|
parser.add_option('--path', help='path for file')
|
|
parser.add_option('--file', help='file to place at |path|')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
|
|
with open(opt.file) as f:
|
|
data = f.read()
|
|
result = gerrit_util.ChangeEdit(
|
|
urlparse.urlparse(opt.host).netloc, opt.change, opt.path, data)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('[args ...]')
|
|
def CMDpublishchangeedit(parser, args):
|
|
parser.add_option('-c', '--change', type=int, help='change number')
|
|
parser.add_option('--notify', help='whether to notify')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
|
|
result = gerrit_util.PublishChangeEdit(
|
|
urlparse.urlparse(opt.host).netloc, opt.change, opt.notify)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('')
|
|
def CMDabandon(parser, args):
|
|
parser.add_option('-c', '--change', type=int, help='change number')
|
|
parser.add_option('-m', '--message', default='', help='reason for abandoning')
|
|
|
|
(opt, args) = parser.parse_args(args)
|
|
assert opt.change, "-c not defined"
|
|
result = gerrit_util.AbandonChange(
|
|
urlparse.urlparse(opt.host).netloc,
|
|
opt.change, opt.message)
|
|
logging.info(result)
|
|
write_result(result, opt)
|
|
|
|
|
|
@subcommand.usage('''Mass abandon changes
|
|
|
|
Mass abandon abandons CLs that match search criteria provided by user. Before
|
|
any change is actually abandoned, user is presented with a list of CLs that
|
|
will be affected if user confirms. User can skip confirmation by passing --force
|
|
parameter.
|
|
|
|
The script can abandon up to 100 CLs per invocation.
|
|
|
|
Examples:
|
|
gerrit_client.py mass-abandon --host https://HOST -p 'project=repo2'
|
|
gerrit_client.py mass-abandon --host https://HOST -p 'message=testing'
|
|
gerrit_client.py mass-abandon --host https://HOST -p 'is=wip' -p 'age:1y'
|
|
''')
|
|
def CMDmass_abandon(parser, args):
|
|
parser.add_option('-p',
|
|
'--param',
|
|
dest='params',
|
|
action='append',
|
|
default=[],
|
|
help='repeatable query parameter, format: -p key=value')
|
|
parser.add_option('-m', '--message', default='', help='reason for abandoning')
|
|
parser.add_option('-f',
|
|
'--force',
|
|
action='store_true',
|
|
help='Don\'t prompt for confirmation')
|
|
|
|
opt, args = parser.parse_args(args)
|
|
|
|
for p in opt.params:
|
|
assert '=' in p, '--param is key=value, not "%s"' % p
|
|
search_query = list(tuple(p.split('=', 1)) for p in opt.params)
|
|
if not any(t for t in search_query if t[0] == 'owner'):
|
|
# owner should always be present when abandoning changes
|
|
search_query.append(('owner', 'me'))
|
|
search_query.append(('status', 'open'))
|
|
logging.info("Searching for: %s" % search_query)
|
|
|
|
host = urlparse.urlparse(opt.host).netloc
|
|
|
|
result = gerrit_util.QueryChanges(
|
|
host,
|
|
search_query,
|
|
# abandon at most 100 changes as not all Gerrit instances support
|
|
# unlimited results.
|
|
limit=100,
|
|
)
|
|
if len(result) == 0:
|
|
logging.warn("Nothing to abandon")
|
|
return
|
|
|
|
logging.warn("%s CLs match search query: " % len(result))
|
|
for change in result:
|
|
logging.warn("[ID: %d] %s" % (change['_number'], change['subject']))
|
|
|
|
if not opt.force:
|
|
q = raw_input(
|
|
'Do you want to move forward with abandoning? [y to confirm] ').strip()
|
|
if q not in ['y', 'Y']:
|
|
logging.warn("Aborting...")
|
|
return
|
|
|
|
for change in result:
|
|
logging.warning("Abandoning: %s" % change['subject'])
|
|
gerrit_util.AbandonChange(host, change['id'], opt.message)
|
|
|
|
logging.warning("Done")
|
|
|
|
|
|
class OptionParser(optparse.OptionParser):
|
|
"""Creates the option parse and add --verbose support."""
|
|
def __init__(self, *args, **kwargs):
|
|
optparse.OptionParser.__init__(self, *args, version=__version__, **kwargs)
|
|
self.add_option(
|
|
'--verbose', action='count', default=0,
|
|
help='Use 2 times for more debugging info')
|
|
self.add_option('--host', dest='host', help='Url of host.')
|
|
self.add_option('--project', dest='project', help='project name')
|
|
self.add_option(
|
|
'--json_file', dest='json_file', help='output json filepath')
|
|
|
|
def parse_args(self, args=None, values=None):
|
|
options, args = optparse.OptionParser.parse_args(self, args, values)
|
|
# Host is always required
|
|
assert options.host, "--host not defined."
|
|
levels = [logging.WARNING, logging.INFO, logging.DEBUG]
|
|
logging.basicConfig(level=levels[min(options.verbose, len(levels) - 1)])
|
|
return options, args
|
|
|
|
|
|
def main(argv):
|
|
if sys.hexversion < 0x02060000:
|
|
print('\nYour python version %s is unsupported, please upgrade.\n'
|
|
% (sys.version.split(' ', 1)[0],),
|
|
file=sys.stderr)
|
|
return 2
|
|
dispatcher = subcommand.CommandDispatcher(__name__)
|
|
return dispatcher.execute(OptionParser(), argv)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
# These affect sys.stdout so do it outside of main() to simplify mocks in
|
|
# unit testing.
|
|
fix_encoding.fix_encoding()
|
|
setup_color.init()
|
|
try:
|
|
sys.exit(main(sys.argv[1:]))
|
|
except KeyboardInterrupt:
|
|
sys.stderr.write('interrupted\n')
|
|
sys.exit(1)
|