blob: d70db71806971d147be096bf2acf91b7c7a172ed [file] [log] [blame]
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00001# Copyright 2013 The Chromium Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5"""Interactive tool for finding reviewers/owners for a change."""
6
Raul Tambre80ee78e2019-05-06 22:41:05 +00007from __future__ import print_function
8
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +00009import os
10import copy
11import owners as owners_module
Bruce Dawson37740e22019-11-14 00:27:44 +000012import random
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000013
14
Edward Lesmesae3586b2020-03-23 21:21:14 +000015import gclient_utils
16
17
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000018def first(iterable):
19 for element in iterable:
20 return element
21
22
23class OwnersFinder(object):
24 COLOR_LINK = '\033[4m'
25 COLOR_BOLD = '\033[1;32m'
26 COLOR_GREY = '\033[0;37m'
27 COLOR_RESET = '\033[0m'
28
29 indentation = 0
30
Edward Lemur707d70b2018-02-07 00:50:14 +010031 def __init__(self, files, local_root, author, reviewers,
dtu944b6052016-07-14 14:48:21 -070032 fopen, os_path,
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000033 email_postfix='@chromium.org',
Jochen Eisingerd0573ec2017-04-13 10:55:06 +020034 disable_color=False,
Sylvain Defresneb1f865d2019-02-12 12:38:22 +000035 override_files=None,
36 ignore_author=False):
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000037 self.email_postfix = email_postfix
38
39 if os.name == 'nt' or disable_color:
40 self.COLOR_LINK = ''
41 self.COLOR_BOLD = ''
42 self.COLOR_GREY = ''
43 self.COLOR_RESET = ''
44
Jochen Eisingereb744762017-04-05 11:00:05 +020045 self.db = owners_module.Database(local_root, fopen, os_path)
Jochen Eisingerd0573ec2017-04-13 10:55:06 +020046 self.db.override_files = override_files or {}
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000047 self.db.load_data_needed_for(files)
48
49 self.os_path = os_path
50
51 self.author = author
52
53 filtered_files = files
54
Edward Lemur707d70b2018-02-07 00:50:14 +010055 reviewers = list(reviewers)
Sylvain Defresneb1f865d2019-02-12 12:38:22 +000056 if author and not ignore_author:
Edward Lemur707d70b2018-02-07 00:50:14 +010057 reviewers.append(author)
58
59 # Eliminate files that existing reviewers can review.
dtu944b6052016-07-14 14:48:21 -070060 filtered_files = list(self.db.files_not_covered_by(
Edward Lemur707d70b2018-02-07 00:50:14 +010061 filtered_files, reviewers))
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000062
63 # If some files are eliminated.
64 if len(filtered_files) != len(files):
65 files = filtered_files
66 # Reload the database.
Jochen Eisingereb744762017-04-05 11:00:05 +020067 self.db = owners_module.Database(local_root, fopen, os_path)
Jochen Eisingerd0573ec2017-04-13 10:55:06 +020068 self.db.override_files = override_files or {}
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000069 self.db.load_data_needed_for(files)
70
71 self.all_possible_owners = self.db.all_possible_owners(files, None)
Sylvain Defresneb1f865d2019-02-12 12:38:22 +000072 if author and author in self.all_possible_owners:
73 del self.all_possible_owners[author]
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +000074
75 self.owners_to_files = {}
76 self._map_owners_to_files(files)
77
78 self.files_to_owners = {}
79 self._map_files_to_owners()
80
81 self.owners_score = self.db.total_costs_by_owner(
82 self.all_possible_owners, files)
83
84 self.original_files_to_owners = copy.deepcopy(self.files_to_owners)
85 self.comments = self.db.comments
86
87 # This is the queue that will be shown in the interactive questions.
88 # It is initially sorted by the score in descending order. In the
89 # interactive questions a user can choose to "defer" its decision, then the
90 # owner will be put to the end of the queue and shown later.
91 self.owners_queue = []
92
93 self.unreviewed_files = set()
94 self.reviewed_by = {}
95 self.selected_owners = set()
96 self.deselected_owners = set()
97 self.reset()
98
99 def run(self):
100 self.reset()
101 while self.owners_queue and self.unreviewed_files:
102 owner = self.owners_queue[0]
103
104 if (owner in self.selected_owners) or (owner in self.deselected_owners):
105 continue
106
107 if not any((file_name in self.unreviewed_files)
108 for file_name in self.owners_to_files[owner]):
109 self.deselect_owner(owner)
110 continue
111
112 self.print_info(owner)
113
114 while True:
115 inp = self.input_command(owner)
116 if inp == 'y' or inp == 'yes':
117 self.select_owner(owner)
118 break
119 elif inp == 'n' or inp == 'no':
120 self.deselect_owner(owner)
121 break
122 elif inp == '' or inp == 'd' or inp == 'defer':
123 self.owners_queue.append(self.owners_queue.pop(0))
124 break
125 elif inp == 'f' or inp == 'files':
126 self.list_files()
127 break
128 elif inp == 'o' or inp == 'owners':
129 self.list_owners(self.owners_queue)
130 break
131 elif inp == 'p' or inp == 'pick':
Edward Lesmesae3586b2020-03-23 21:21:14 +0000132 self.pick_owner(gclient_utils.AskForData('Pick an owner: '))
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +0000133 break
134 elif inp.startswith('p ') or inp.startswith('pick '):
135 self.pick_owner(inp.split(' ', 2)[1].strip())
136 break
137 elif inp == 'r' or inp == 'restart':
138 self.reset()
139 break
140 elif inp == 'q' or inp == 'quit':
141 # Exit with error
142 return 1
143
144 self.print_result()
145 return 0
146
147 def _map_owners_to_files(self, files):
148 for owner in self.all_possible_owners:
149 for dir_name, _ in self.all_possible_owners[owner]:
150 for file_name in files:
151 if file_name.startswith(dir_name):
152 self.owners_to_files.setdefault(owner, set())
153 self.owners_to_files[owner].add(file_name)
154
155 def _map_files_to_owners(self):
156 for owner in self.owners_to_files:
157 for file_name in self.owners_to_files[owner]:
158 self.files_to_owners.setdefault(file_name, set())
159 self.files_to_owners[file_name].add(owner)
160
161 def reset(self):
162 self.files_to_owners = copy.deepcopy(self.original_files_to_owners)
163 self.unreviewed_files = set(self.files_to_owners.keys())
164 self.reviewed_by = {}
165 self.selected_owners = set()
166 self.deselected_owners = set()
167
Bruce Dawson37740e22019-11-14 00:27:44 +0000168 # Randomize owners' names so that if many reviewers have identical scores
169 # they will be randomly ordered to avoid bias.
170 owners = list(self.owners_to_files.keys())
171 random.shuffle(owners)
172 self.owners_queue = sorted(owners,
173 key=lambda owner: self.owners_score[owner])
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +0000174 self.find_mandatory_owners()
175
176 def select_owner(self, owner, findMandatoryOwners=True):
177 if owner in self.selected_owners or owner in self.deselected_owners\
178 or not (owner in self.owners_queue):
179 return
180 self.writeln('Selected: ' + owner)
181 self.owners_queue.remove(owner)
182 self.selected_owners.add(owner)
183 for file_name in filter(
184 lambda file_name: file_name in self.unreviewed_files,
185 self.owners_to_files[owner]):
186 self.unreviewed_files.remove(file_name)
187 self.reviewed_by[file_name] = owner
188 if findMandatoryOwners:
189 self.find_mandatory_owners()
190
191 def deselect_owner(self, owner, findMandatoryOwners=True):
192 if owner in self.selected_owners or owner in self.deselected_owners\
193 or not (owner in self.owners_queue):
194 return
195 self.writeln('Deselected: ' + owner)
196 self.owners_queue.remove(owner)
197 self.deselected_owners.add(owner)
198 for file_name in self.owners_to_files[owner] & self.unreviewed_files:
199 self.files_to_owners[file_name].remove(owner)
200 if findMandatoryOwners:
201 self.find_mandatory_owners()
202
203 def find_mandatory_owners(self):
204 continues = True
205 for owner in self.owners_queue:
206 if owner in self.selected_owners:
207 continue
208 if owner in self.deselected_owners:
209 continue
210 if len(self.owners_to_files[owner] & self.unreviewed_files) == 0:
211 self.deselect_owner(owner, False)
212
213 while continues:
214 continues = False
215 for file_name in filter(
216 lambda file_name: len(self.files_to_owners[file_name]) == 1,
217 self.unreviewed_files):
218 owner = first(self.files_to_owners[file_name])
219 self.select_owner(owner, False)
220 continues = True
221 break
222
223 def print_comments(self, owner):
224 if owner not in self.comments:
225 self.writeln(self.bold_name(owner))
226 else:
227 self.writeln(self.bold_name(owner) + ' is commented as:')
228 self.indent()
Jochen Eisinger72606f82017-04-04 10:44:18 +0200229 if owners_module.GLOBAL_STATUS in self.comments[owner]:
230 self.writeln(
231 self.greyed(self.comments[owner][owners_module.GLOBAL_STATUS]) +
232 ' (global status)')
233 if len(self.comments[owner]) == 1:
234 self.unindent()
235 return
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +0000236 for path in self.comments[owner]:
Jochen Eisinger72606f82017-04-04 10:44:18 +0200237 if path == owners_module.GLOBAL_STATUS:
238 continue
239 elif len(self.comments[owner][path]) > 0:
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +0000240 self.writeln(self.greyed(self.comments[owner][path]) +
241 ' (at ' + self.bold(path or '<root>') + ')')
242 else:
243 self.writeln(self.greyed('[No comment] ') + ' (at ' +
244 self.bold(path or '<root>') + ')')
245 self.unindent()
246
247 def print_file_info(self, file_name, except_owner=''):
248 if file_name not in self.unreviewed_files:
249 self.writeln(self.greyed(file_name +
250 ' (by ' +
251 self.bold_name(self.reviewed_by[file_name]) +
252 ')'))
253 else:
254 if len(self.files_to_owners[file_name]) <= 3:
255 other_owners = []
256 for ow in self.files_to_owners[file_name]:
257 if ow != except_owner:
258 other_owners.append(self.bold_name(ow))
259 self.writeln(file_name +
260 ' [' + (', '.join(other_owners)) + ']')
261 else:
262 self.writeln(file_name + ' [' +
263 self.bold(str(len(self.files_to_owners[file_name]))) +
264 ']')
265
266 def print_file_info_detailed(self, file_name):
267 self.writeln(file_name)
268 self.indent()
269 for ow in sorted(self.files_to_owners[file_name]):
270 if ow in self.deselected_owners:
271 self.writeln(self.bold_name(self.greyed(ow)))
272 elif ow in self.selected_owners:
273 self.writeln(self.bold_name(self.greyed(ow)))
274 else:
275 self.writeln(self.bold_name(ow))
276 self.unindent()
277
278 def print_owned_files_for(self, owner):
279 # Print owned files
280 self.print_comments(owner)
281 self.writeln(self.bold_name(owner) + ' owns ' +
282 str(len(self.owners_to_files[owner])) + ' file(s):')
283 self.indent()
284 for file_name in sorted(self.owners_to_files[owner]):
285 self.print_file_info(file_name, owner)
286 self.unindent()
287 self.writeln()
288
289 def list_owners(self, owners_queue):
290 if (len(self.owners_to_files) - len(self.deselected_owners) -
291 len(self.selected_owners)) > 3:
292 for ow in owners_queue:
293 if ow not in self.deselected_owners and ow not in self.selected_owners:
294 self.print_comments(ow)
295 else:
296 for ow in owners_queue:
297 if ow not in self.deselected_owners and ow not in self.selected_owners:
298 self.writeln()
299 self.print_owned_files_for(ow)
300
301 def list_files(self):
302 self.indent()
303 if len(self.unreviewed_files) > 5:
304 for file_name in sorted(self.unreviewed_files):
305 self.print_file_info(file_name)
306 else:
307 for file_name in self.unreviewed_files:
308 self.print_file_info_detailed(file_name)
309 self.unindent()
310
311 def pick_owner(self, ow):
312 # Allowing to omit domain suffixes
313 if ow not in self.owners_to_files:
314 if ow + self.email_postfix in self.owners_to_files:
315 ow += self.email_postfix
316
317 if ow not in self.owners_to_files:
318 self.writeln('You cannot pick ' + self.bold_name(ow) + ' manually. ' +
319 'It\'s an invalid name or not related to the change list.')
320 return False
321 elif ow in self.selected_owners:
322 self.writeln('You cannot pick ' + self.bold_name(ow) + ' manually. ' +
323 'It\'s already selected.')
324 return False
325 elif ow in self.deselected_owners:
326 self.writeln('You cannot pick ' + self.bold_name(ow) + ' manually.' +
327 'It\'s already unselected.')
328 return False
329
330 self.select_owner(ow)
331 return True
332
333 def print_result(self):
334 # Print results
335 self.writeln()
336 self.writeln()
337 self.writeln('** You selected these owners **')
338 self.writeln()
339 for owner in self.selected_owners:
340 self.writeln(self.bold_name(owner) + ':')
341 self.indent()
342 for file_name in sorted(self.owners_to_files[owner]):
343 self.writeln(file_name)
344 self.unindent()
345
346 def bold(self, text):
347 return self.COLOR_BOLD + text + self.COLOR_RESET
348
349 def bold_name(self, name):
350 return (self.COLOR_BOLD +
351 name.replace(self.email_postfix, '') + self.COLOR_RESET)
352
353 def greyed(self, text):
354 return self.COLOR_GREY + text + self.COLOR_RESET
355
356 def indent(self):
357 self.indentation += 1
358
359 def unindent(self):
360 self.indentation -= 1
361
362 def print_indent(self):
363 return ' ' * self.indentation
364
365 def writeln(self, text=''):
Raul Tambre80ee78e2019-05-06 22:41:05 +0000366 print(self.print_indent() + text)
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +0000367
368 def hr(self):
369 self.writeln('=====================')
370
371 def print_info(self, owner):
372 self.hr()
373 self.writeln(
374 self.bold(str(len(self.unreviewed_files))) + ' file(s) left.')
375 self.print_owned_files_for(owner)
376
377 def input_command(self, owner):
378 self.writeln('Add ' + self.bold_name(owner) + ' as your reviewer? ')
Edward Lesmesae3586b2020-03-23 21:21:14 +0000379 return gclient_utils.AskForData(
ikarienator@chromium.orgfaf3fdf2013-09-20 02:11:48 +0000380 '[yes/no/Defer/pick/files/owners/quit/restart]: ').lower()