blob: ccf78b56a15731a5ebfb6ef7a32d87bb6f148ad0 [file] [log] [blame]
dimu833c94c2017-01-18 17:36:15 -08001#!/usr/bin/python
2# Copyright 2017 The Chromium 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
6"""Simple client for the Gerrit REST API.
7
8Example usage:
9 ./gerrit_client.py [command] [args]""
10"""
11
12from __future__ import print_function
13
14import json
15import logging
16import optparse
17import subcommand
18import sys
19import urllib
20import urlparse
21
dimu833c94c2017-01-18 17:36:15 -080022import fix_encoding
23import gerrit_util
24import setup_color
25
26__version__ = '0.1'
dimu833c94c2017-01-18 17:36:15 -080027
28
29def write_result(result, opt):
30 if opt.json_file:
31 with open(opt.json_file, 'w') as json_file:
32 json_file.write(json.dumps(result))
33
34
35@subcommand.usage('[args ...]')
36def CMDbranchinfo(parser, args):
37 parser.add_option('--branch', dest='branch', help='branch name')
38
39 (opt, args) = parser.parse_args(args)
40 host = urlparse.urlparse(opt.host).netloc
41 project = urllib.quote_plus(opt.project)
42 branch = urllib.quote_plus(opt.branch)
43 result = gerrit_util.GetGerritBranch(host, project, branch)
44 logging.info(result)
45 write_result(result, opt)
46
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +000047
dimu833c94c2017-01-18 17:36:15 -080048@subcommand.usage('[args ...]')
49def CMDbranch(parser, args):
50 parser.add_option('--branch', dest='branch', help='branch name')
51 parser.add_option('--commit', dest='commit', help='commit hash')
52
53 (opt, args) = parser.parse_args(args)
54
55 project = urllib.quote_plus(opt.project)
56 host = urlparse.urlparse(opt.host).netloc
57 branch = urllib.quote_plus(opt.branch)
58 commit = urllib.quote_plus(opt.commit)
59 result = gerrit_util.CreateGerritBranch(host, project, branch, commit)
60 logging.info(result)
61 write_result(result, opt)
62
63
Michael Achenbach6fbf12f2017-07-06 10:54:11 +020064@subcommand.usage('[args ...]')
65def CMDchanges(parser, args):
66 parser.add_option('-p', '--param', dest='params', action='append',
67 help='repeatable query parameter, format: -p key=value')
Paweł Hajdan, Jr24025d32017-07-11 16:38:21 +020068 parser.add_option('-o', '--o-param', dest='o_params', action='append',
69 help='gerrit output parameters, e.g. ALL_REVISIONS')
Michael Achenbach6fbf12f2017-07-06 10:54:11 +020070 parser.add_option('--limit', dest='limit', type=int,
71 help='maximum number of results to return')
72 parser.add_option('--start', dest='start', type=int,
73 help='how many changes to skip '
74 '(starting with the most recent)')
75
76 (opt, args) = parser.parse_args(args)
77
78 result = gerrit_util.QueryChanges(
79 urlparse.urlparse(opt.host).netloc,
80 list(tuple(p.split('=', 1)) for p in opt.params),
Paweł Hajdan, Jr24025d32017-07-11 16:38:21 +020081 start=opt.start, # Default: None
82 limit=opt.limit, # Default: None
83 o_params=opt.o_params, # Default: None
Michael Achenbach6fbf12f2017-07-06 10:54:11 +020084 )
85 logging.info('Change query returned %d changes.', len(result))
86 write_result(result, opt)
87
88
Sergiy Belozorovfe347232019-02-27 15:07:33 +000089@subcommand.usage('')
90def CMDabandon(parser, args):
91 parser.add_option('-c', '--change', type=int, help='change number')
92 parser.add_option('-m', '--message', default='', help='reason for abandoning')
93
94 (opt, args) = parser.parse_args(args)
95 result = gerrit_util.AbandonChange(
96 urlparse.urlparse(opt.host).netloc,
97 opt.change, opt.message)
98 logging.info(result)
99 write_result(result, opt)
100
101
dimu833c94c2017-01-18 17:36:15 -0800102class OptionParser(optparse.OptionParser):
103 """Creates the option parse and add --verbose support."""
104 def __init__(self, *args, **kwargs):
105 optparse.OptionParser.__init__(
106 self, *args, prog='git cl', version=__version__, **kwargs)
107 self.add_option(
108 '--verbose', action='count', default=0,
109 help='Use 2 times for more debugging info')
110 self.add_option('--host', dest='host', help='Url of host.')
111 self.add_option('--project', dest='project', help='project name')
112 self.add_option(
113 '--json_file', dest='json_file', help='output json filepath')
114
115 def parse_args(self, args=None, values=None):
116 options, args = optparse.OptionParser.parse_args(self, args, values)
117 levels = [logging.WARNING, logging.INFO, logging.DEBUG]
118 logging.basicConfig(level=levels[min(options.verbose, len(levels) - 1)])
119 return options, args
120
121
122def main(argv):
123 if sys.hexversion < 0x02060000:
124 print('\nYour python version %s is unsupported, please upgrade.\n'
Quinten Yearsleyd9cbe7a2019-09-03 16:49:11 +0000125 % (sys.version.split(' ', 1)[0],),
dimu833c94c2017-01-18 17:36:15 -0800126 file=sys.stderr)
127 return 2
128 dispatcher = subcommand.CommandDispatcher(__name__)
129 return dispatcher.execute(OptionParser(), argv)
130
131
132if __name__ == '__main__':
133 # These affect sys.stdout so do it outside of main() to simplify mocks in
134 # unit testing.
135 fix_encoding.fix_encoding()
136 setup_color.init()
137 try:
138 sys.exit(main(sys.argv[1:]))
139 except KeyboardInterrupt:
140 sys.stderr.write('interrupted\n')
Michael Achenbach6fbf12f2017-07-06 10:54:11 +0200141 sys.exit(1)