1#!/usr/bin/env python3 2 3# 4# Copyright (C) 2018 The Android Open Source Project 5# 6# Licensed under the Apache License, Version 2.0 (the "License"); 7# you may not use this file except in compliance with the License. 8# You may obtain a copy of the License at 9# 10# http://www.apache.org/licenses/LICENSE-2.0 11# 12# Unless required by applicable law or agreed to in writing, software 13# distributed under the License is distributed on an "AS IS" BASIS, 14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15# See the License for the specific language governing permissions and 16# limitations under the License. 17# 18 19"""A command line utility to post review votes to multiple CLs on Gerrit.""" 20 21from __future__ import print_function 22 23import argparse 24import json 25import os 26import sys 27 28try: 29 from urllib.error import HTTPError # PY3 30except ImportError: 31 from urllib2 import HTTPError # PY2 32 33from gerrit import ( 34 abandon, add_common_parse_args, add_reviewers, create_url_opener_from_args, 35 delete_reviewer, delete_topic, find_gerrit_name, normalize_gerrit_name, 36 query_change_lists, restore, set_hashtags, set_review, set_topic, submit 37) 38 39 40def _get_labels_from_args(args): 41 """Collect and check labels from args.""" 42 if not args.label: 43 return None 44 labels = {} 45 for (name, value) in args.label: 46 try: 47 labels[name] = int(value) 48 except ValueError: 49 print('error: Label {} takes integer, but {} is specified' 50 .format(name, value), file=sys.stderr) 51 return labels 52 53 54# pylint: disable=redefined-builtin 55def _print_change_lists(change_lists, file=sys.stdout): 56 """Print matching change lists for each projects.""" 57 change_lists = sorted( 58 change_lists, key=lambda change: (change['project'], change['_number'])) 59 60 prev_project = None 61 print('Change Lists:', file=file) 62 for change in change_lists: 63 project = change['project'] 64 if project != prev_project: 65 print(' ', project, file=file) 66 prev_project = project 67 68 change_id = change['change_id'] 69 revision_sha1 = change['current_revision'] 70 revision = change['revisions'][revision_sha1] 71 subject = revision['commit']['subject'] 72 print(' ', change_id, '--', subject, file=file) 73 74 75def _confirm(question): 76 """Confirm before proceeding.""" 77 try: 78 if input(question + ' [yn] ').lower() not in {'y', 'yes'}: 79 print('Cancelled', file=sys.stderr) 80 sys.exit(1) 81 except KeyboardInterrupt: 82 print('Cancelled', file=sys.stderr) 83 sys.exit(1) 84 85 86def _parse_args(): 87 """Parse command line options.""" 88 parser = argparse.ArgumentParser() 89 add_common_parse_args(parser) 90 91 parser.add_argument('-l', '--label', nargs=2, action='append', 92 help='Labels to be added') 93 parser.add_argument('-m', '--message', help='Review message') 94 95 parser.add_argument('--submit', action='store_true', help='Submit a CL') 96 97 parser.add_argument('--abandon', help='Abandon a CL with a message') 98 parser.add_argument('--restore', action='store_true', help='Restore a CL') 99 100 parser.add_argument('--add-hashtag', action='append', help='Add hashtag') 101 parser.add_argument('--remove-hashtag', action='append', 102 help='Remove hashtag') 103 parser.add_argument('--delete-hashtag', action='append', 104 help='Remove hashtag', dest='remove_hashtag') 105 106 parser.add_argument('--set-topic', help='Set topic name') 107 parser.add_argument('--delete-topic', action='store_true', 108 help='Delete topic name') 109 parser.add_argument('--remove-topic', action='store_true', 110 help='Delete topic name', dest='delete_topic') 111 parser.add_argument('--add-reviewer', action='append', default=[], 112 help='Add reviewer') 113 parser.add_argument('--delete-reviewer', action='append', default=[], 114 help='Delete reviewer') 115 116 return parser.parse_args() 117 118 119def _has_task(args): 120 """Determine whether a task has been specified in the arguments.""" 121 if args.label is not None or args.message is not None: 122 return True 123 if args.submit: 124 return True 125 if args.abandon is not None: 126 return True 127 if args.restore: 128 return True 129 if args.add_hashtag or args.remove_hashtag: 130 return True 131 if args.set_topic or args.delete_topic: 132 return True 133 if args.add_reviewer or args.delete_reviewer: 134 return True 135 return False 136 137 138_SEP_SPLIT = '=' * 79 139_SEP = '-' * 79 140 141 142def _print_error(change, res_code, res_body, res_json): 143 """Print the error message""" 144 145 change_id = change['change_id'] 146 project = change['project'] 147 revision_sha1 = change['current_revision'] 148 revision = change['revisions'][revision_sha1] 149 subject = revision['commit']['subject'] 150 151 print(_SEP_SPLIT, file=sys.stderr) 152 print('Project:', project, file=sys.stderr) 153 print('Change-Id:', change_id, file=sys.stderr) 154 print('Subject:', subject, file=sys.stderr) 155 print('HTTP status code:', res_code, file=sys.stderr) 156 if res_json: 157 print(_SEP, file=sys.stderr) 158 json.dump(res_json, sys.stderr, indent=4, 159 separators=(', ', ': ')) 160 print(file=sys.stderr) 161 elif res_body: 162 print(_SEP, file=sys.stderr) 163 print(res_body.decode('utf-8'), file=sys.stderr) 164 print(_SEP_SPLIT, file=sys.stderr) 165 166 167def _do_task(change, func, *args, **kwargs): 168 """Process a task and report errors when necessary.""" 169 170 res_code, res_body, res_json = func(*args) 171 172 if res_code != kwargs.get('expected_http_code', 200): 173 _print_error(change, res_code, res_body, res_json) 174 175 errors = kwargs.get('errors') 176 if errors is not None: 177 errors['num_errors'] += 1 178 179 180def main(): 181 """Set review labels to selected change lists""" 182 183 # Parse and check the command line options 184 args = _parse_args() 185 186 if args.gerrit: 187 args.gerrit = normalize_gerrit_name(args.gerrit) 188 else: 189 try: 190 args.gerrit = find_gerrit_name() 191 # pylint: disable=bare-except 192 except: 193 print('gerrit instance not found, use [-g GERRIT]') 194 sys.exit(1) 195 196 if not _has_task(args): 197 print('error: Either --label, --message, --submit, --abandon, --restore, ' 198 '--add-hashtag, --remove-hashtag, --set-topic, --delete-topic, ' 199 '--add-reviewer or --delete-reviewer must be specified', 200 file=sys.stderr) 201 sys.exit(1) 202 203 # Convert label arguments 204 labels = _get_labels_from_args(args) 205 206 # Convert reviewer arguments 207 new_reviewers = [{'reviewer': name} for name in args.add_reviewer] 208 209 # Load authentication credentials 210 url_opener = create_url_opener_from_args(args) 211 212 # Retrieve change lists 213 change_lists = query_change_lists( 214 url_opener, args.gerrit, args.query, args.start, args.limits) 215 if not change_lists: 216 print('error: No matching change lists.', file=sys.stderr) 217 sys.exit(1) 218 219 # Print matching lists 220 _print_change_lists(change_lists, file=sys.stdout) 221 222 # Confirm 223 _confirm('Do you want to continue?') 224 225 # Post review votes 226 errors = {'num_errors': 0} 227 for change in change_lists: 228 if args.label or args.message: 229 _do_task(change, set_review, url_opener, args.gerrit, change['id'], 230 labels, args.message, errors=errors) 231 if args.add_hashtag or args.remove_hashtag: 232 _do_task(change, set_hashtags, url_opener, args.gerrit, 233 change['id'], args.add_hashtag, args.remove_hashtag, 234 errors=errors) 235 if args.set_topic: 236 _do_task(change, set_topic, url_opener, args.gerrit, change['id'], 237 args.set_topic, errors=errors) 238 if args.delete_topic: 239 _do_task(change, delete_topic, url_opener, args.gerrit, 240 change['id'], expected_http_code=204, errors=errors) 241 if args.submit: 242 _do_task(change, submit, url_opener, args.gerrit, change['id'], 243 errors=errors) 244 if args.abandon: 245 _do_task(change, abandon, url_opener, args.gerrit, change['id'], 246 args.abandon, errors=errors) 247 if args.restore: 248 _do_task(change, restore, url_opener, args.gerrit, change['id'], 249 errors=errors) 250 if args.add_reviewer: 251 _do_task(change, add_reviewers, url_opener, args.gerrit, 252 change['id'], new_reviewers, errors=errors) 253 for name in args.delete_reviewer: 254 _do_task(change, delete_reviewer, url_opener, args.gerrit, 255 change['id'], name, expected_http_code=204, errors=errors) 256 257 258 if errors['num_errors']: 259 sys.exit(1) 260 261 262if __name__ == '__main__': 263 main() 264