##// END OF EJS Templates
pull-requests: fixed a bug in removal of multiple reviewers
marcink -
r3575:a4085180 stable
parent child Browse files
Show More
@@ -1,1717 +1,1728 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2012-2019 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 21
22 22 """
23 23 pull request model for RhodeCode
24 24 """
25 25
26 26
27 27 import json
28 28 import logging
29 29 import datetime
30 30 import urllib
31 31 import collections
32 32
33 33 from pyramid import compat
34 34 from pyramid.threadlocal import get_current_request
35 35
36 36 from rhodecode import events
37 37 from rhodecode.translation import lazy_ugettext
38 38 from rhodecode.lib import helpers as h, hooks_utils, diffs
39 39 from rhodecode.lib import audit_logger
40 40 from rhodecode.lib.compat import OrderedDict
41 41 from rhodecode.lib.hooks_daemon import prepare_callback_daemon
42 42 from rhodecode.lib.markup_renderer import (
43 43 DEFAULT_COMMENTS_RENDERER, RstTemplateRenderer)
44 44 from rhodecode.lib.utils2 import safe_unicode, safe_str, md5_safe
45 45 from rhodecode.lib.vcs.backends.base import (
46 46 Reference, MergeResponse, MergeFailureReason, UpdateFailureReason)
47 47 from rhodecode.lib.vcs.conf import settings as vcs_settings
48 48 from rhodecode.lib.vcs.exceptions import (
49 49 CommitDoesNotExistError, EmptyRepositoryError)
50 50 from rhodecode.model import BaseModel
51 51 from rhodecode.model.changeset_status import ChangesetStatusModel
52 52 from rhodecode.model.comment import CommentsModel
53 53 from rhodecode.model.db import (
54 54 or_, PullRequest, PullRequestReviewers, ChangesetStatus,
55 55 PullRequestVersion, ChangesetComment, Repository, RepoReviewRule)
56 56 from rhodecode.model.meta import Session
57 57 from rhodecode.model.notification import NotificationModel, \
58 58 EmailNotificationModel
59 59 from rhodecode.model.scm import ScmModel
60 60 from rhodecode.model.settings import VcsSettingsModel
61 61
62 62
63 63 log = logging.getLogger(__name__)
64 64
65 65
66 66 # Data structure to hold the response data when updating commits during a pull
67 67 # request update.
68 68 UpdateResponse = collections.namedtuple('UpdateResponse', [
69 69 'executed', 'reason', 'new', 'old', 'changes',
70 70 'source_changed', 'target_changed'])
71 71
72 72
73 73 class PullRequestModel(BaseModel):
74 74
75 75 cls = PullRequest
76 76
77 77 DIFF_CONTEXT = diffs.DEFAULT_CONTEXT
78 78
79 79 UPDATE_STATUS_MESSAGES = {
80 80 UpdateFailureReason.NONE: lazy_ugettext(
81 81 'Pull request update successful.'),
82 82 UpdateFailureReason.UNKNOWN: lazy_ugettext(
83 83 'Pull request update failed because of an unknown error.'),
84 84 UpdateFailureReason.NO_CHANGE: lazy_ugettext(
85 85 'No update needed because the source and target have not changed.'),
86 86 UpdateFailureReason.WRONG_REF_TYPE: lazy_ugettext(
87 87 'Pull request cannot be updated because the reference type is '
88 88 'not supported for an update. Only Branch, Tag or Bookmark is allowed.'),
89 89 UpdateFailureReason.MISSING_TARGET_REF: lazy_ugettext(
90 90 'This pull request cannot be updated because the target '
91 91 'reference is missing.'),
92 92 UpdateFailureReason.MISSING_SOURCE_REF: lazy_ugettext(
93 93 'This pull request cannot be updated because the source '
94 94 'reference is missing.'),
95 95 }
96 96 REF_TYPES = ['bookmark', 'book', 'tag', 'branch']
97 97 UPDATABLE_REF_TYPES = ['bookmark', 'book', 'branch']
98 98
99 99 def __get_pull_request(self, pull_request):
100 100 return self._get_instance((
101 101 PullRequest, PullRequestVersion), pull_request)
102 102
103 103 def _check_perms(self, perms, pull_request, user, api=False):
104 104 if not api:
105 105 return h.HasRepoPermissionAny(*perms)(
106 106 user=user, repo_name=pull_request.target_repo.repo_name)
107 107 else:
108 108 return h.HasRepoPermissionAnyApi(*perms)(
109 109 user=user, repo_name=pull_request.target_repo.repo_name)
110 110
111 111 def check_user_read(self, pull_request, user, api=False):
112 112 _perms = ('repository.admin', 'repository.write', 'repository.read',)
113 113 return self._check_perms(_perms, pull_request, user, api)
114 114
115 115 def check_user_merge(self, pull_request, user, api=False):
116 116 _perms = ('repository.admin', 'repository.write', 'hg.admin',)
117 117 return self._check_perms(_perms, pull_request, user, api)
118 118
119 119 def check_user_update(self, pull_request, user, api=False):
120 120 owner = user.user_id == pull_request.user_id
121 121 return self.check_user_merge(pull_request, user, api) or owner
122 122
123 123 def check_user_delete(self, pull_request, user):
124 124 owner = user.user_id == pull_request.user_id
125 125 _perms = ('repository.admin',)
126 126 return self._check_perms(_perms, pull_request, user) or owner
127 127
128 128 def check_user_change_status(self, pull_request, user, api=False):
129 129 reviewer = user.user_id in [x.user_id for x in
130 130 pull_request.reviewers]
131 131 return self.check_user_update(pull_request, user, api) or reviewer
132 132
133 133 def check_user_comment(self, pull_request, user):
134 134 owner = user.user_id == pull_request.user_id
135 135 return self.check_user_read(pull_request, user) or owner
136 136
137 137 def get(self, pull_request):
138 138 return self.__get_pull_request(pull_request)
139 139
140 140 def _prepare_get_all_query(self, repo_name, source=False, statuses=None,
141 141 opened_by=None, order_by=None,
142 142 order_dir='desc', only_created=True):
143 143 repo = None
144 144 if repo_name:
145 145 repo = self._get_repo(repo_name)
146 146
147 147 q = PullRequest.query()
148 148
149 149 # source or target
150 150 if repo and source:
151 151 q = q.filter(PullRequest.source_repo == repo)
152 152 elif repo:
153 153 q = q.filter(PullRequest.target_repo == repo)
154 154
155 155 # closed,opened
156 156 if statuses:
157 157 q = q.filter(PullRequest.status.in_(statuses))
158 158
159 159 # opened by filter
160 160 if opened_by:
161 161 q = q.filter(PullRequest.user_id.in_(opened_by))
162 162
163 163 # only get those that are in "created" state
164 164 if only_created:
165 165 q = q.filter(PullRequest.pull_request_state == PullRequest.STATE_CREATED)
166 166
167 167 if order_by:
168 168 order_map = {
169 169 'name_raw': PullRequest.pull_request_id,
170 170 'id': PullRequest.pull_request_id,
171 171 'title': PullRequest.title,
172 172 'updated_on_raw': PullRequest.updated_on,
173 173 'target_repo': PullRequest.target_repo_id
174 174 }
175 175 if order_dir == 'asc':
176 176 q = q.order_by(order_map[order_by].asc())
177 177 else:
178 178 q = q.order_by(order_map[order_by].desc())
179 179
180 180 return q
181 181
182 182 def count_all(self, repo_name, source=False, statuses=None,
183 183 opened_by=None):
184 184 """
185 185 Count the number of pull requests for a specific repository.
186 186
187 187 :param repo_name: target or source repo
188 188 :param source: boolean flag to specify if repo_name refers to source
189 189 :param statuses: list of pull request statuses
190 190 :param opened_by: author user of the pull request
191 191 :returns: int number of pull requests
192 192 """
193 193 q = self._prepare_get_all_query(
194 194 repo_name, source=source, statuses=statuses, opened_by=opened_by)
195 195
196 196 return q.count()
197 197
198 198 def get_all(self, repo_name, source=False, statuses=None, opened_by=None,
199 199 offset=0, length=None, order_by=None, order_dir='desc'):
200 200 """
201 201 Get all pull requests for a specific repository.
202 202
203 203 :param repo_name: target or source repo
204 204 :param source: boolean flag to specify if repo_name refers to source
205 205 :param statuses: list of pull request statuses
206 206 :param opened_by: author user of the pull request
207 207 :param offset: pagination offset
208 208 :param length: length of returned list
209 209 :param order_by: order of the returned list
210 210 :param order_dir: 'asc' or 'desc' ordering direction
211 211 :returns: list of pull requests
212 212 """
213 213 q = self._prepare_get_all_query(
214 214 repo_name, source=source, statuses=statuses, opened_by=opened_by,
215 215 order_by=order_by, order_dir=order_dir)
216 216
217 217 if length:
218 218 pull_requests = q.limit(length).offset(offset).all()
219 219 else:
220 220 pull_requests = q.all()
221 221
222 222 return pull_requests
223 223
224 224 def count_awaiting_review(self, repo_name, source=False, statuses=None,
225 225 opened_by=None):
226 226 """
227 227 Count the number of pull requests for a specific repository that are
228 228 awaiting review.
229 229
230 230 :param repo_name: target or source repo
231 231 :param source: boolean flag to specify if repo_name refers to source
232 232 :param statuses: list of pull request statuses
233 233 :param opened_by: author user of the pull request
234 234 :returns: int number of pull requests
235 235 """
236 236 pull_requests = self.get_awaiting_review(
237 237 repo_name, source=source, statuses=statuses, opened_by=opened_by)
238 238
239 239 return len(pull_requests)
240 240
241 241 def get_awaiting_review(self, repo_name, source=False, statuses=None,
242 242 opened_by=None, offset=0, length=None,
243 243 order_by=None, order_dir='desc'):
244 244 """
245 245 Get all pull requests for a specific repository that are awaiting
246 246 review.
247 247
248 248 :param repo_name: target or source repo
249 249 :param source: boolean flag to specify if repo_name refers to source
250 250 :param statuses: list of pull request statuses
251 251 :param opened_by: author user of the pull request
252 252 :param offset: pagination offset
253 253 :param length: length of returned list
254 254 :param order_by: order of the returned list
255 255 :param order_dir: 'asc' or 'desc' ordering direction
256 256 :returns: list of pull requests
257 257 """
258 258 pull_requests = self.get_all(
259 259 repo_name, source=source, statuses=statuses, opened_by=opened_by,
260 260 order_by=order_by, order_dir=order_dir)
261 261
262 262 _filtered_pull_requests = []
263 263 for pr in pull_requests:
264 264 status = pr.calculated_review_status()
265 265 if status in [ChangesetStatus.STATUS_NOT_REVIEWED,
266 266 ChangesetStatus.STATUS_UNDER_REVIEW]:
267 267 _filtered_pull_requests.append(pr)
268 268 if length:
269 269 return _filtered_pull_requests[offset:offset+length]
270 270 else:
271 271 return _filtered_pull_requests
272 272
273 273 def count_awaiting_my_review(self, repo_name, source=False, statuses=None,
274 274 opened_by=None, user_id=None):
275 275 """
276 276 Count the number of pull requests for a specific repository that are
277 277 awaiting review from a specific user.
278 278
279 279 :param repo_name: target or source repo
280 280 :param source: boolean flag to specify if repo_name refers to source
281 281 :param statuses: list of pull request statuses
282 282 :param opened_by: author user of the pull request
283 283 :param user_id: reviewer user of the pull request
284 284 :returns: int number of pull requests
285 285 """
286 286 pull_requests = self.get_awaiting_my_review(
287 287 repo_name, source=source, statuses=statuses, opened_by=opened_by,
288 288 user_id=user_id)
289 289
290 290 return len(pull_requests)
291 291
292 292 def get_awaiting_my_review(self, repo_name, source=False, statuses=None,
293 293 opened_by=None, user_id=None, offset=0,
294 294 length=None, order_by=None, order_dir='desc'):
295 295 """
296 296 Get all pull requests for a specific repository that are awaiting
297 297 review from a specific user.
298 298
299 299 :param repo_name: target or source repo
300 300 :param source: boolean flag to specify if repo_name refers to source
301 301 :param statuses: list of pull request statuses
302 302 :param opened_by: author user of the pull request
303 303 :param user_id: reviewer user of the pull request
304 304 :param offset: pagination offset
305 305 :param length: length of returned list
306 306 :param order_by: order of the returned list
307 307 :param order_dir: 'asc' or 'desc' ordering direction
308 308 :returns: list of pull requests
309 309 """
310 310 pull_requests = self.get_all(
311 311 repo_name, source=source, statuses=statuses, opened_by=opened_by,
312 312 order_by=order_by, order_dir=order_dir)
313 313
314 314 _my = PullRequestModel().get_not_reviewed(user_id)
315 315 my_participation = []
316 316 for pr in pull_requests:
317 317 if pr in _my:
318 318 my_participation.append(pr)
319 319 _filtered_pull_requests = my_participation
320 320 if length:
321 321 return _filtered_pull_requests[offset:offset+length]
322 322 else:
323 323 return _filtered_pull_requests
324 324
325 325 def get_not_reviewed(self, user_id):
326 326 return [
327 327 x.pull_request for x in PullRequestReviewers.query().filter(
328 328 PullRequestReviewers.user_id == user_id).all()
329 329 ]
330 330
331 331 def _prepare_participating_query(self, user_id=None, statuses=None,
332 332 order_by=None, order_dir='desc'):
333 333 q = PullRequest.query()
334 334 if user_id:
335 335 reviewers_subquery = Session().query(
336 336 PullRequestReviewers.pull_request_id).filter(
337 337 PullRequestReviewers.user_id == user_id).subquery()
338 338 user_filter = or_(
339 339 PullRequest.user_id == user_id,
340 340 PullRequest.pull_request_id.in_(reviewers_subquery)
341 341 )
342 342 q = PullRequest.query().filter(user_filter)
343 343
344 344 # closed,opened
345 345 if statuses:
346 346 q = q.filter(PullRequest.status.in_(statuses))
347 347
348 348 if order_by:
349 349 order_map = {
350 350 'name_raw': PullRequest.pull_request_id,
351 351 'title': PullRequest.title,
352 352 'updated_on_raw': PullRequest.updated_on,
353 353 'target_repo': PullRequest.target_repo_id
354 354 }
355 355 if order_dir == 'asc':
356 356 q = q.order_by(order_map[order_by].asc())
357 357 else:
358 358 q = q.order_by(order_map[order_by].desc())
359 359
360 360 return q
361 361
362 362 def count_im_participating_in(self, user_id=None, statuses=None):
363 363 q = self._prepare_participating_query(user_id, statuses=statuses)
364 364 return q.count()
365 365
366 366 def get_im_participating_in(
367 367 self, user_id=None, statuses=None, offset=0,
368 368 length=None, order_by=None, order_dir='desc'):
369 369 """
370 370 Get all Pull requests that i'm participating in, or i have opened
371 371 """
372 372
373 373 q = self._prepare_participating_query(
374 374 user_id, statuses=statuses, order_by=order_by,
375 375 order_dir=order_dir)
376 376
377 377 if length:
378 378 pull_requests = q.limit(length).offset(offset).all()
379 379 else:
380 380 pull_requests = q.all()
381 381
382 382 return pull_requests
383 383
384 384 def get_versions(self, pull_request):
385 385 """
386 386 returns version of pull request sorted by ID descending
387 387 """
388 388 return PullRequestVersion.query()\
389 389 .filter(PullRequestVersion.pull_request == pull_request)\
390 390 .order_by(PullRequestVersion.pull_request_version_id.asc())\
391 391 .all()
392 392
393 393 def get_pr_version(self, pull_request_id, version=None):
394 394 at_version = None
395 395
396 396 if version and version == 'latest':
397 397 pull_request_ver = PullRequest.get(pull_request_id)
398 398 pull_request_obj = pull_request_ver
399 399 _org_pull_request_obj = pull_request_obj
400 400 at_version = 'latest'
401 401 elif version:
402 402 pull_request_ver = PullRequestVersion.get_or_404(version)
403 403 pull_request_obj = pull_request_ver
404 404 _org_pull_request_obj = pull_request_ver.pull_request
405 405 at_version = pull_request_ver.pull_request_version_id
406 406 else:
407 407 _org_pull_request_obj = pull_request_obj = PullRequest.get_or_404(
408 408 pull_request_id)
409 409
410 410 pull_request_display_obj = PullRequest.get_pr_display_object(
411 411 pull_request_obj, _org_pull_request_obj)
412 412
413 413 return _org_pull_request_obj, pull_request_obj, \
414 414 pull_request_display_obj, at_version
415 415
416 416 def create(self, created_by, source_repo, source_ref, target_repo,
417 417 target_ref, revisions, reviewers, title, description=None,
418 418 description_renderer=None,
419 419 reviewer_data=None, translator=None, auth_user=None):
420 420 translator = translator or get_current_request().translate
421 421
422 422 created_by_user = self._get_user(created_by)
423 423 auth_user = auth_user or created_by_user.AuthUser()
424 424 source_repo = self._get_repo(source_repo)
425 425 target_repo = self._get_repo(target_repo)
426 426
427 427 pull_request = PullRequest()
428 428 pull_request.source_repo = source_repo
429 429 pull_request.source_ref = source_ref
430 430 pull_request.target_repo = target_repo
431 431 pull_request.target_ref = target_ref
432 432 pull_request.revisions = revisions
433 433 pull_request.title = title
434 434 pull_request.description = description
435 435 pull_request.description_renderer = description_renderer
436 436 pull_request.author = created_by_user
437 437 pull_request.reviewer_data = reviewer_data
438 438 pull_request.pull_request_state = pull_request.STATE_CREATING
439 439 Session().add(pull_request)
440 440 Session().flush()
441 441
442 442 reviewer_ids = set()
443 443 # members / reviewers
444 444 for reviewer_object in reviewers:
445 445 user_id, reasons, mandatory, rules = reviewer_object
446 446 user = self._get_user(user_id)
447 447
448 448 # skip duplicates
449 449 if user.user_id in reviewer_ids:
450 450 continue
451 451
452 452 reviewer_ids.add(user.user_id)
453 453
454 454 reviewer = PullRequestReviewers()
455 455 reviewer.user = user
456 456 reviewer.pull_request = pull_request
457 457 reviewer.reasons = reasons
458 458 reviewer.mandatory = mandatory
459 459
460 460 # NOTE(marcink): pick only first rule for now
461 461 rule_id = list(rules)[0] if rules else None
462 462 rule = RepoReviewRule.get(rule_id) if rule_id else None
463 463 if rule:
464 464 review_group = rule.user_group_vote_rule(user_id)
465 465 # we check if this particular reviewer is member of a voting group
466 466 if review_group:
467 467 # NOTE(marcink):
468 468 # can be that user is member of more but we pick the first same,
469 469 # same as default reviewers algo
470 470 review_group = review_group[0]
471 471
472 472 rule_data = {
473 473 'rule_name':
474 474 rule.review_rule_name,
475 475 'rule_user_group_entry_id':
476 476 review_group.repo_review_rule_users_group_id,
477 477 'rule_user_group_name':
478 478 review_group.users_group.users_group_name,
479 479 'rule_user_group_members':
480 480 [x.user.username for x in review_group.users_group.members],
481 481 'rule_user_group_members_id':
482 482 [x.user.user_id for x in review_group.users_group.members],
483 483 }
484 484 # e.g {'vote_rule': -1, 'mandatory': True}
485 485 rule_data.update(review_group.rule_data())
486 486
487 487 reviewer.rule_data = rule_data
488 488
489 489 Session().add(reviewer)
490 490 Session().flush()
491 491
492 492 # Set approval status to "Under Review" for all commits which are
493 493 # part of this pull request.
494 494 ChangesetStatusModel().set_status(
495 495 repo=target_repo,
496 496 status=ChangesetStatus.STATUS_UNDER_REVIEW,
497 497 user=created_by_user,
498 498 pull_request=pull_request
499 499 )
500 500 # we commit early at this point. This has to do with a fact
501 501 # that before queries do some row-locking. And because of that
502 502 # we need to commit and finish transaction before below validate call
503 503 # that for large repos could be long resulting in long row locks
504 504 Session().commit()
505 505
506 506 # prepare workspace, and run initial merge simulation. Set state during that
507 507 # operation
508 508 pull_request = PullRequest.get(pull_request.pull_request_id)
509 509
510 510 # set as merging, for simulation, and if finished to created so we mark
511 511 # simulation is working fine
512 512 with pull_request.set_state(PullRequest.STATE_MERGING,
513 513 final_state=PullRequest.STATE_CREATED):
514 514 MergeCheck.validate(
515 515 pull_request, auth_user=auth_user, translator=translator)
516 516
517 517 self.notify_reviewers(pull_request, reviewer_ids)
518 518 self.trigger_pull_request_hook(
519 519 pull_request, created_by_user, 'create')
520 520
521 521 creation_data = pull_request.get_api_data(with_merge_state=False)
522 522 self._log_audit_action(
523 523 'repo.pull_request.create', {'data': creation_data},
524 524 auth_user, pull_request)
525 525
526 526 return pull_request
527 527
528 528 def trigger_pull_request_hook(self, pull_request, user, action, data=None):
529 529 pull_request = self.__get_pull_request(pull_request)
530 530 target_scm = pull_request.target_repo.scm_instance()
531 531 if action == 'create':
532 532 trigger_hook = hooks_utils.trigger_log_create_pull_request_hook
533 533 elif action == 'merge':
534 534 trigger_hook = hooks_utils.trigger_log_merge_pull_request_hook
535 535 elif action == 'close':
536 536 trigger_hook = hooks_utils.trigger_log_close_pull_request_hook
537 537 elif action == 'review_status_change':
538 538 trigger_hook = hooks_utils.trigger_log_review_pull_request_hook
539 539 elif action == 'update':
540 540 trigger_hook = hooks_utils.trigger_log_update_pull_request_hook
541 541 elif action == 'comment':
542 542 # dummy hook ! for comment. We want this function to handle all cases
543 543 def trigger_hook(*args, **kwargs):
544 544 pass
545 545 comment = data['comment']
546 546 events.trigger(events.PullRequestCommentEvent(pull_request, comment))
547 547 else:
548 548 return
549 549
550 550 trigger_hook(
551 551 username=user.username,
552 552 repo_name=pull_request.target_repo.repo_name,
553 553 repo_alias=target_scm.alias,
554 554 pull_request=pull_request,
555 555 data=data)
556 556
557 557 def _get_commit_ids(self, pull_request):
558 558 """
559 559 Return the commit ids of the merged pull request.
560 560
561 561 This method is not dealing correctly yet with the lack of autoupdates
562 562 nor with the implicit target updates.
563 563 For example: if a commit in the source repo is already in the target it
564 564 will be reported anyways.
565 565 """
566 566 merge_rev = pull_request.merge_rev
567 567 if merge_rev is None:
568 568 raise ValueError('This pull request was not merged yet')
569 569
570 570 commit_ids = list(pull_request.revisions)
571 571 if merge_rev not in commit_ids:
572 572 commit_ids.append(merge_rev)
573 573
574 574 return commit_ids
575 575
576 576 def merge_repo(self, pull_request, user, extras):
577 577 log.debug("Merging pull request %s", pull_request.pull_request_id)
578 578 extras['user_agent'] = 'internal-merge'
579 579 merge_state = self._merge_pull_request(pull_request, user, extras)
580 580 if merge_state.executed:
581 581 log.debug("Merge was successful, updating the pull request comments.")
582 582 self._comment_and_close_pr(pull_request, user, merge_state)
583 583
584 584 self._log_audit_action(
585 585 'repo.pull_request.merge',
586 586 {'merge_state': merge_state.__dict__},
587 587 user, pull_request)
588 588
589 589 else:
590 590 log.warn("Merge failed, not updating the pull request.")
591 591 return merge_state
592 592
593 593 def _merge_pull_request(self, pull_request, user, extras, merge_msg=None):
594 594 target_vcs = pull_request.target_repo.scm_instance()
595 595 source_vcs = pull_request.source_repo.scm_instance()
596 596
597 597 message = safe_unicode(merge_msg or vcs_settings.MERGE_MESSAGE_TMPL).format(
598 598 pr_id=pull_request.pull_request_id,
599 599 pr_title=pull_request.title,
600 600 source_repo=source_vcs.name,
601 601 source_ref_name=pull_request.source_ref_parts.name,
602 602 target_repo=target_vcs.name,
603 603 target_ref_name=pull_request.target_ref_parts.name,
604 604 )
605 605
606 606 workspace_id = self._workspace_id(pull_request)
607 607 repo_id = pull_request.target_repo.repo_id
608 608 use_rebase = self._use_rebase_for_merging(pull_request)
609 609 close_branch = self._close_branch_before_merging(pull_request)
610 610
611 611 target_ref = self._refresh_reference(
612 612 pull_request.target_ref_parts, target_vcs)
613 613
614 614 callback_daemon, extras = prepare_callback_daemon(
615 615 extras, protocol=vcs_settings.HOOKS_PROTOCOL,
616 616 host=vcs_settings.HOOKS_HOST,
617 617 use_direct_calls=vcs_settings.HOOKS_DIRECT_CALLS)
618 618
619 619 with callback_daemon:
620 620 # TODO: johbo: Implement a clean way to run a config_override
621 621 # for a single call.
622 622 target_vcs.config.set(
623 623 'rhodecode', 'RC_SCM_DATA', json.dumps(extras))
624 624
625 625 user_name = user.short_contact
626 626 merge_state = target_vcs.merge(
627 627 repo_id, workspace_id, target_ref, source_vcs,
628 628 pull_request.source_ref_parts,
629 629 user_name=user_name, user_email=user.email,
630 630 message=message, use_rebase=use_rebase,
631 631 close_branch=close_branch)
632 632 return merge_state
633 633
634 634 def _comment_and_close_pr(self, pull_request, user, merge_state, close_msg=None):
635 635 pull_request.merge_rev = merge_state.merge_ref.commit_id
636 636 pull_request.updated_on = datetime.datetime.now()
637 637 close_msg = close_msg or 'Pull request merged and closed'
638 638
639 639 CommentsModel().create(
640 640 text=safe_unicode(close_msg),
641 641 repo=pull_request.target_repo.repo_id,
642 642 user=user.user_id,
643 643 pull_request=pull_request.pull_request_id,
644 644 f_path=None,
645 645 line_no=None,
646 646 closing_pr=True
647 647 )
648 648
649 649 Session().add(pull_request)
650 650 Session().flush()
651 651 # TODO: paris: replace invalidation with less radical solution
652 652 ScmModel().mark_for_invalidation(
653 653 pull_request.target_repo.repo_name)
654 654 self.trigger_pull_request_hook(pull_request, user, 'merge')
655 655
656 656 def has_valid_update_type(self, pull_request):
657 657 source_ref_type = pull_request.source_ref_parts.type
658 658 return source_ref_type in self.REF_TYPES
659 659
660 660 def update_commits(self, pull_request):
661 661 """
662 662 Get the updated list of commits for the pull request
663 663 and return the new pull request version and the list
664 664 of commits processed by this update action
665 665 """
666 666 pull_request = self.__get_pull_request(pull_request)
667 667 source_ref_type = pull_request.source_ref_parts.type
668 668 source_ref_name = pull_request.source_ref_parts.name
669 669 source_ref_id = pull_request.source_ref_parts.commit_id
670 670
671 671 target_ref_type = pull_request.target_ref_parts.type
672 672 target_ref_name = pull_request.target_ref_parts.name
673 673 target_ref_id = pull_request.target_ref_parts.commit_id
674 674
675 675 if not self.has_valid_update_type(pull_request):
676 676 log.debug("Skipping update of pull request %s due to ref type: %s",
677 677 pull_request, source_ref_type)
678 678 return UpdateResponse(
679 679 executed=False,
680 680 reason=UpdateFailureReason.WRONG_REF_TYPE,
681 681 old=pull_request, new=None, changes=None,
682 682 source_changed=False, target_changed=False)
683 683
684 684 # source repo
685 685 source_repo = pull_request.source_repo.scm_instance()
686 686 try:
687 687 source_commit = source_repo.get_commit(commit_id=source_ref_name)
688 688 except CommitDoesNotExistError:
689 689 return UpdateResponse(
690 690 executed=False,
691 691 reason=UpdateFailureReason.MISSING_SOURCE_REF,
692 692 old=pull_request, new=None, changes=None,
693 693 source_changed=False, target_changed=False)
694 694
695 695 source_changed = source_ref_id != source_commit.raw_id
696 696
697 697 # target repo
698 698 target_repo = pull_request.target_repo.scm_instance()
699 699 try:
700 700 target_commit = target_repo.get_commit(commit_id=target_ref_name)
701 701 except CommitDoesNotExistError:
702 702 return UpdateResponse(
703 703 executed=False,
704 704 reason=UpdateFailureReason.MISSING_TARGET_REF,
705 705 old=pull_request, new=None, changes=None,
706 706 source_changed=False, target_changed=False)
707 707 target_changed = target_ref_id != target_commit.raw_id
708 708
709 709 if not (source_changed or target_changed):
710 710 log.debug("Nothing changed in pull request %s", pull_request)
711 711 return UpdateResponse(
712 712 executed=False,
713 713 reason=UpdateFailureReason.NO_CHANGE,
714 714 old=pull_request, new=None, changes=None,
715 715 source_changed=target_changed, target_changed=source_changed)
716 716
717 717 change_in_found = 'target repo' if target_changed else 'source repo'
718 718 log.debug('Updating pull request because of change in %s detected',
719 719 change_in_found)
720 720
721 721 # Finally there is a need for an update, in case of source change
722 722 # we create a new version, else just an update
723 723 if source_changed:
724 724 pull_request_version = self._create_version_from_snapshot(pull_request)
725 725 self._link_comments_to_version(pull_request_version)
726 726 else:
727 727 try:
728 728 ver = pull_request.versions[-1]
729 729 except IndexError:
730 730 ver = None
731 731
732 732 pull_request.pull_request_version_id = \
733 733 ver.pull_request_version_id if ver else None
734 734 pull_request_version = pull_request
735 735
736 736 try:
737 737 if target_ref_type in self.REF_TYPES:
738 738 target_commit = target_repo.get_commit(target_ref_name)
739 739 else:
740 740 target_commit = target_repo.get_commit(target_ref_id)
741 741 except CommitDoesNotExistError:
742 742 return UpdateResponse(
743 743 executed=False,
744 744 reason=UpdateFailureReason.MISSING_TARGET_REF,
745 745 old=pull_request, new=None, changes=None,
746 746 source_changed=source_changed, target_changed=target_changed)
747 747
748 748 # re-compute commit ids
749 749 old_commit_ids = pull_request.revisions
750 750 pre_load = ["author", "branch", "date", "message"]
751 751 commit_ranges = target_repo.compare(
752 752 target_commit.raw_id, source_commit.raw_id, source_repo, merge=True,
753 753 pre_load=pre_load)
754 754
755 755 ancestor = target_repo.get_common_ancestor(
756 756 target_commit.raw_id, source_commit.raw_id, source_repo)
757 757
758 758 pull_request.source_ref = '%s:%s:%s' % (
759 759 source_ref_type, source_ref_name, source_commit.raw_id)
760 760 pull_request.target_ref = '%s:%s:%s' % (
761 761 target_ref_type, target_ref_name, ancestor)
762 762
763 763 pull_request.revisions = [
764 764 commit.raw_id for commit in reversed(commit_ranges)]
765 765 pull_request.updated_on = datetime.datetime.now()
766 766 Session().add(pull_request)
767 767 new_commit_ids = pull_request.revisions
768 768
769 769 old_diff_data, new_diff_data = self._generate_update_diffs(
770 770 pull_request, pull_request_version)
771 771
772 772 # calculate commit and file changes
773 773 changes = self._calculate_commit_id_changes(
774 774 old_commit_ids, new_commit_ids)
775 775 file_changes = self._calculate_file_changes(
776 776 old_diff_data, new_diff_data)
777 777
778 778 # set comments as outdated if DIFFS changed
779 779 CommentsModel().outdate_comments(
780 780 pull_request, old_diff_data=old_diff_data,
781 781 new_diff_data=new_diff_data)
782 782
783 783 commit_changes = (changes.added or changes.removed)
784 784 file_node_changes = (
785 785 file_changes.added or file_changes.modified or file_changes.removed)
786 786 pr_has_changes = commit_changes or file_node_changes
787 787
788 788 # Add an automatic comment to the pull request, in case
789 789 # anything has changed
790 790 if pr_has_changes:
791 791 update_comment = CommentsModel().create(
792 792 text=self._render_update_message(changes, file_changes),
793 793 repo=pull_request.target_repo,
794 794 user=pull_request.author,
795 795 pull_request=pull_request,
796 796 send_email=False, renderer=DEFAULT_COMMENTS_RENDERER)
797 797
798 798 # Update status to "Under Review" for added commits
799 799 for commit_id in changes.added:
800 800 ChangesetStatusModel().set_status(
801 801 repo=pull_request.source_repo,
802 802 status=ChangesetStatus.STATUS_UNDER_REVIEW,
803 803 comment=update_comment,
804 804 user=pull_request.author,
805 805 pull_request=pull_request,
806 806 revision=commit_id)
807 807
808 808 log.debug(
809 809 'Updated pull request %s, added_ids: %s, common_ids: %s, '
810 810 'removed_ids: %s', pull_request.pull_request_id,
811 811 changes.added, changes.common, changes.removed)
812 812 log.debug(
813 813 'Updated pull request with the following file changes: %s',
814 814 file_changes)
815 815
816 816 log.info(
817 817 "Updated pull request %s from commit %s to commit %s, "
818 818 "stored new version %s of this pull request.",
819 819 pull_request.pull_request_id, source_ref_id,
820 820 pull_request.source_ref_parts.commit_id,
821 821 pull_request_version.pull_request_version_id)
822 822 Session().commit()
823 823 self.trigger_pull_request_hook(pull_request, pull_request.author, 'update')
824 824
825 825 return UpdateResponse(
826 826 executed=True, reason=UpdateFailureReason.NONE,
827 827 old=pull_request, new=pull_request_version, changes=changes,
828 828 source_changed=source_changed, target_changed=target_changed)
829 829
830 830 def _create_version_from_snapshot(self, pull_request):
831 831 version = PullRequestVersion()
832 832 version.title = pull_request.title
833 833 version.description = pull_request.description
834 834 version.status = pull_request.status
835 835 version.pull_request_state = pull_request.pull_request_state
836 836 version.created_on = datetime.datetime.now()
837 837 version.updated_on = pull_request.updated_on
838 838 version.user_id = pull_request.user_id
839 839 version.source_repo = pull_request.source_repo
840 840 version.source_ref = pull_request.source_ref
841 841 version.target_repo = pull_request.target_repo
842 842 version.target_ref = pull_request.target_ref
843 843
844 844 version._last_merge_source_rev = pull_request._last_merge_source_rev
845 845 version._last_merge_target_rev = pull_request._last_merge_target_rev
846 846 version.last_merge_status = pull_request.last_merge_status
847 847 version.shadow_merge_ref = pull_request.shadow_merge_ref
848 848 version.merge_rev = pull_request.merge_rev
849 849 version.reviewer_data = pull_request.reviewer_data
850 850
851 851 version.revisions = pull_request.revisions
852 852 version.pull_request = pull_request
853 853 Session().add(version)
854 854 Session().flush()
855 855
856 856 return version
857 857
858 858 def _generate_update_diffs(self, pull_request, pull_request_version):
859 859
860 860 diff_context = (
861 861 self.DIFF_CONTEXT +
862 862 CommentsModel.needed_extra_diff_context())
863 863 hide_whitespace_changes = False
864 864 source_repo = pull_request_version.source_repo
865 865 source_ref_id = pull_request_version.source_ref_parts.commit_id
866 866 target_ref_id = pull_request_version.target_ref_parts.commit_id
867 867 old_diff = self._get_diff_from_pr_or_version(
868 868 source_repo, source_ref_id, target_ref_id,
869 869 hide_whitespace_changes=hide_whitespace_changes, diff_context=diff_context)
870 870
871 871 source_repo = pull_request.source_repo
872 872 source_ref_id = pull_request.source_ref_parts.commit_id
873 873 target_ref_id = pull_request.target_ref_parts.commit_id
874 874
875 875 new_diff = self._get_diff_from_pr_or_version(
876 876 source_repo, source_ref_id, target_ref_id,
877 877 hide_whitespace_changes=hide_whitespace_changes, diff_context=diff_context)
878 878
879 879 old_diff_data = diffs.DiffProcessor(old_diff)
880 880 old_diff_data.prepare()
881 881 new_diff_data = diffs.DiffProcessor(new_diff)
882 882 new_diff_data.prepare()
883 883
884 884 return old_diff_data, new_diff_data
885 885
886 886 def _link_comments_to_version(self, pull_request_version):
887 887 """
888 888 Link all unlinked comments of this pull request to the given version.
889 889
890 890 :param pull_request_version: The `PullRequestVersion` to which
891 891 the comments shall be linked.
892 892
893 893 """
894 894 pull_request = pull_request_version.pull_request
895 895 comments = ChangesetComment.query()\
896 896 .filter(
897 897 # TODO: johbo: Should we query for the repo at all here?
898 898 # Pending decision on how comments of PRs are to be related
899 899 # to either the source repo, the target repo or no repo at all.
900 900 ChangesetComment.repo_id == pull_request.target_repo.repo_id,
901 901 ChangesetComment.pull_request == pull_request,
902 902 ChangesetComment.pull_request_version == None)\
903 903 .order_by(ChangesetComment.comment_id.asc())
904 904
905 905 # TODO: johbo: Find out why this breaks if it is done in a bulk
906 906 # operation.
907 907 for comment in comments:
908 908 comment.pull_request_version_id = (
909 909 pull_request_version.pull_request_version_id)
910 910 Session().add(comment)
911 911
912 912 def _calculate_commit_id_changes(self, old_ids, new_ids):
913 913 added = [x for x in new_ids if x not in old_ids]
914 914 common = [x for x in new_ids if x in old_ids]
915 915 removed = [x for x in old_ids if x not in new_ids]
916 916 total = new_ids
917 917 return ChangeTuple(added, common, removed, total)
918 918
919 919 def _calculate_file_changes(self, old_diff_data, new_diff_data):
920 920
921 921 old_files = OrderedDict()
922 922 for diff_data in old_diff_data.parsed_diff:
923 923 old_files[diff_data['filename']] = md5_safe(diff_data['raw_diff'])
924 924
925 925 added_files = []
926 926 modified_files = []
927 927 removed_files = []
928 928 for diff_data in new_diff_data.parsed_diff:
929 929 new_filename = diff_data['filename']
930 930 new_hash = md5_safe(diff_data['raw_diff'])
931 931
932 932 old_hash = old_files.get(new_filename)
933 933 if not old_hash:
934 934 # file is not present in old diff, means it's added
935 935 added_files.append(new_filename)
936 936 else:
937 937 if new_hash != old_hash:
938 938 modified_files.append(new_filename)
939 939 # now remove a file from old, since we have seen it already
940 940 del old_files[new_filename]
941 941
942 942 # removed files is when there are present in old, but not in NEW,
943 943 # since we remove old files that are present in new diff, left-overs
944 944 # if any should be the removed files
945 945 removed_files.extend(old_files.keys())
946 946
947 947 return FileChangeTuple(added_files, modified_files, removed_files)
948 948
949 949 def _render_update_message(self, changes, file_changes):
950 950 """
951 951 render the message using DEFAULT_COMMENTS_RENDERER (RST renderer),
952 952 so it's always looking the same disregarding on which default
953 953 renderer system is using.
954 954
955 955 :param changes: changes named tuple
956 956 :param file_changes: file changes named tuple
957 957
958 958 """
959 959 new_status = ChangesetStatus.get_status_lbl(
960 960 ChangesetStatus.STATUS_UNDER_REVIEW)
961 961
962 962 changed_files = (
963 963 file_changes.added + file_changes.modified + file_changes.removed)
964 964
965 965 params = {
966 966 'under_review_label': new_status,
967 967 'added_commits': changes.added,
968 968 'removed_commits': changes.removed,
969 969 'changed_files': changed_files,
970 970 'added_files': file_changes.added,
971 971 'modified_files': file_changes.modified,
972 972 'removed_files': file_changes.removed,
973 973 }
974 974 renderer = RstTemplateRenderer()
975 975 return renderer.render('pull_request_update.mako', **params)
976 976
977 977 def edit(self, pull_request, title, description, description_renderer, user):
978 978 pull_request = self.__get_pull_request(pull_request)
979 979 old_data = pull_request.get_api_data(with_merge_state=False)
980 980 if pull_request.is_closed():
981 981 raise ValueError('This pull request is closed')
982 982 if title:
983 983 pull_request.title = title
984 984 pull_request.description = description
985 985 pull_request.updated_on = datetime.datetime.now()
986 986 pull_request.description_renderer = description_renderer
987 987 Session().add(pull_request)
988 988 self._log_audit_action(
989 989 'repo.pull_request.edit', {'old_data': old_data},
990 990 user, pull_request)
991 991
992 992 def update_reviewers(self, pull_request, reviewer_data, user):
993 993 """
994 994 Update the reviewers in the pull request
995 995
996 996 :param pull_request: the pr to update
997 997 :param reviewer_data: list of tuples
998 998 [(user, ['reason1', 'reason2'], mandatory_flag, [rules])]
999 999 """
1000 1000 pull_request = self.__get_pull_request(pull_request)
1001 1001 if pull_request.is_closed():
1002 1002 raise ValueError('This pull request is closed')
1003 1003
1004 1004 reviewers = {}
1005 1005 for user_id, reasons, mandatory, rules in reviewer_data:
1006 1006 if isinstance(user_id, (int, compat.string_types)):
1007 1007 user_id = self._get_user(user_id).user_id
1008 1008 reviewers[user_id] = {
1009 1009 'reasons': reasons, 'mandatory': mandatory}
1010 1010
1011 1011 reviewers_ids = set(reviewers.keys())
1012 1012 current_reviewers = PullRequestReviewers.query()\
1013 1013 .filter(PullRequestReviewers.pull_request ==
1014 1014 pull_request).all()
1015 1015 current_reviewers_ids = set([x.user.user_id for x in current_reviewers])
1016 1016
1017 1017 ids_to_add = reviewers_ids.difference(current_reviewers_ids)
1018 1018 ids_to_remove = current_reviewers_ids.difference(reviewers_ids)
1019 1019
1020 1020 log.debug("Adding %s reviewers", ids_to_add)
1021 1021 log.debug("Removing %s reviewers", ids_to_remove)
1022 1022 changed = False
1023 added_audit_reviewers = []
1024 removed_audit_reviewers = []
1025
1023 1026 for uid in ids_to_add:
1024 1027 changed = True
1025 1028 _usr = self._get_user(uid)
1026 1029 reviewer = PullRequestReviewers()
1027 1030 reviewer.user = _usr
1028 1031 reviewer.pull_request = pull_request
1029 1032 reviewer.reasons = reviewers[uid]['reasons']
1030 1033 # NOTE(marcink): mandatory shouldn't be changed now
1031 1034 # reviewer.mandatory = reviewers[uid]['reasons']
1032 1035 Session().add(reviewer)
1033 self._log_audit_action(
1034 'repo.pull_request.reviewer.add', {'data': reviewer.get_dict()},
1035 user, pull_request)
1036 added_audit_reviewers.append(reviewer.get_dict())
1036 1037
1037 1038 for uid in ids_to_remove:
1038 1039 changed = True
1040 # NOTE(marcink): we fetch "ALL" reviewers using .all(). This is an edge case
1041 # that prevents and fixes cases that we added the same reviewer twice.
1042 # this CAN happen due to the lack of DB checks
1039 1043 reviewers = PullRequestReviewers.query()\
1040 1044 .filter(PullRequestReviewers.user_id == uid,
1041 1045 PullRequestReviewers.pull_request == pull_request)\
1042 1046 .all()
1043 # use .all() in case we accidentally added the same person twice
1044 # this CAN happen due to the lack of DB checks
1047
1045 1048 for obj in reviewers:
1046 old_data = obj.get_dict()
1049 added_audit_reviewers.append(obj.get_dict())
1047 1050 Session().delete(obj)
1048 self._log_audit_action(
1049 'repo.pull_request.reviewer.delete',
1050 {'old_data': old_data}, user, pull_request)
1051 1051
1052 1052 if changed:
1053 Session().expire_all()
1053 1054 pull_request.updated_on = datetime.datetime.now()
1054 1055 Session().add(pull_request)
1055 1056
1057 # finally store audit logs
1058 for user_data in added_audit_reviewers:
1059 self._log_audit_action(
1060 'repo.pull_request.reviewer.add', {'data': user_data},
1061 user, pull_request)
1062 for user_data in removed_audit_reviewers:
1063 self._log_audit_action(
1064 'repo.pull_request.reviewer.delete', {'old_data': user_data},
1065 user, pull_request)
1066
1056 1067 self.notify_reviewers(pull_request, ids_to_add)
1057 1068 return ids_to_add, ids_to_remove
1058 1069
1059 1070 def get_url(self, pull_request, request=None, permalink=False):
1060 1071 if not request:
1061 1072 request = get_current_request()
1062 1073
1063 1074 if permalink:
1064 1075 return request.route_url(
1065 1076 'pull_requests_global',
1066 1077 pull_request_id=pull_request.pull_request_id,)
1067 1078 else:
1068 1079 return request.route_url('pullrequest_show',
1069 1080 repo_name=safe_str(pull_request.target_repo.repo_name),
1070 1081 pull_request_id=pull_request.pull_request_id,)
1071 1082
1072 1083 def get_shadow_clone_url(self, pull_request, request=None):
1073 1084 """
1074 1085 Returns qualified url pointing to the shadow repository. If this pull
1075 1086 request is closed there is no shadow repository and ``None`` will be
1076 1087 returned.
1077 1088 """
1078 1089 if pull_request.is_closed():
1079 1090 return None
1080 1091 else:
1081 1092 pr_url = urllib.unquote(self.get_url(pull_request, request=request))
1082 1093 return safe_unicode('{pr_url}/repository'.format(pr_url=pr_url))
1083 1094
1084 1095 def notify_reviewers(self, pull_request, reviewers_ids):
1085 1096 # notification to reviewers
1086 1097 if not reviewers_ids:
1087 1098 return
1088 1099
1089 1100 pull_request_obj = pull_request
1090 1101 # get the current participants of this pull request
1091 1102 recipients = reviewers_ids
1092 1103 notification_type = EmailNotificationModel.TYPE_PULL_REQUEST
1093 1104
1094 1105 pr_source_repo = pull_request_obj.source_repo
1095 1106 pr_target_repo = pull_request_obj.target_repo
1096 1107
1097 1108 pr_url = h.route_url('pullrequest_show',
1098 1109 repo_name=pr_target_repo.repo_name,
1099 1110 pull_request_id=pull_request_obj.pull_request_id,)
1100 1111
1101 1112 # set some variables for email notification
1102 1113 pr_target_repo_url = h.route_url(
1103 1114 'repo_summary', repo_name=pr_target_repo.repo_name)
1104 1115
1105 1116 pr_source_repo_url = h.route_url(
1106 1117 'repo_summary', repo_name=pr_source_repo.repo_name)
1107 1118
1108 1119 # pull request specifics
1109 1120 pull_request_commits = [
1110 1121 (x.raw_id, x.message)
1111 1122 for x in map(pr_source_repo.get_commit, pull_request.revisions)]
1112 1123
1113 1124 kwargs = {
1114 1125 'user': pull_request.author,
1115 1126 'pull_request': pull_request_obj,
1116 1127 'pull_request_commits': pull_request_commits,
1117 1128
1118 1129 'pull_request_target_repo': pr_target_repo,
1119 1130 'pull_request_target_repo_url': pr_target_repo_url,
1120 1131
1121 1132 'pull_request_source_repo': pr_source_repo,
1122 1133 'pull_request_source_repo_url': pr_source_repo_url,
1123 1134
1124 1135 'pull_request_url': pr_url,
1125 1136 }
1126 1137
1127 1138 # pre-generate the subject for notification itself
1128 1139 (subject,
1129 1140 _h, _e, # we don't care about those
1130 1141 body_plaintext) = EmailNotificationModel().render_email(
1131 1142 notification_type, **kwargs)
1132 1143
1133 1144 # create notification objects, and emails
1134 1145 NotificationModel().create(
1135 1146 created_by=pull_request.author,
1136 1147 notification_subject=subject,
1137 1148 notification_body=body_plaintext,
1138 1149 notification_type=notification_type,
1139 1150 recipients=recipients,
1140 1151 email_kwargs=kwargs,
1141 1152 )
1142 1153
1143 1154 def delete(self, pull_request, user):
1144 1155 pull_request = self.__get_pull_request(pull_request)
1145 1156 old_data = pull_request.get_api_data(with_merge_state=False)
1146 1157 self._cleanup_merge_workspace(pull_request)
1147 1158 self._log_audit_action(
1148 1159 'repo.pull_request.delete', {'old_data': old_data},
1149 1160 user, pull_request)
1150 1161 Session().delete(pull_request)
1151 1162
1152 1163 def close_pull_request(self, pull_request, user):
1153 1164 pull_request = self.__get_pull_request(pull_request)
1154 1165 self._cleanup_merge_workspace(pull_request)
1155 1166 pull_request.status = PullRequest.STATUS_CLOSED
1156 1167 pull_request.updated_on = datetime.datetime.now()
1157 1168 Session().add(pull_request)
1158 1169 self.trigger_pull_request_hook(
1159 1170 pull_request, pull_request.author, 'close')
1160 1171
1161 1172 pr_data = pull_request.get_api_data(with_merge_state=False)
1162 1173 self._log_audit_action(
1163 1174 'repo.pull_request.close', {'data': pr_data}, user, pull_request)
1164 1175
1165 1176 def close_pull_request_with_comment(
1166 1177 self, pull_request, user, repo, message=None, auth_user=None):
1167 1178
1168 1179 pull_request_review_status = pull_request.calculated_review_status()
1169 1180
1170 1181 if pull_request_review_status == ChangesetStatus.STATUS_APPROVED:
1171 1182 # approved only if we have voting consent
1172 1183 status = ChangesetStatus.STATUS_APPROVED
1173 1184 else:
1174 1185 status = ChangesetStatus.STATUS_REJECTED
1175 1186 status_lbl = ChangesetStatus.get_status_lbl(status)
1176 1187
1177 1188 default_message = (
1178 1189 'Closing with status change {transition_icon} {status}.'
1179 1190 ).format(transition_icon='>', status=status_lbl)
1180 1191 text = message or default_message
1181 1192
1182 1193 # create a comment, and link it to new status
1183 1194 comment = CommentsModel().create(
1184 1195 text=text,
1185 1196 repo=repo.repo_id,
1186 1197 user=user.user_id,
1187 1198 pull_request=pull_request.pull_request_id,
1188 1199 status_change=status_lbl,
1189 1200 status_change_type=status,
1190 1201 closing_pr=True,
1191 1202 auth_user=auth_user,
1192 1203 )
1193 1204
1194 1205 # calculate old status before we change it
1195 1206 old_calculated_status = pull_request.calculated_review_status()
1196 1207 ChangesetStatusModel().set_status(
1197 1208 repo.repo_id,
1198 1209 status,
1199 1210 user.user_id,
1200 1211 comment=comment,
1201 1212 pull_request=pull_request.pull_request_id
1202 1213 )
1203 1214
1204 1215 Session().flush()
1205 1216 events.trigger(events.PullRequestCommentEvent(pull_request, comment))
1206 1217 # we now calculate the status of pull request again, and based on that
1207 1218 # calculation trigger status change. This might happen in cases
1208 1219 # that non-reviewer admin closes a pr, which means his vote doesn't
1209 1220 # change the status, while if he's a reviewer this might change it.
1210 1221 calculated_status = pull_request.calculated_review_status()
1211 1222 if old_calculated_status != calculated_status:
1212 1223 self.trigger_pull_request_hook(
1213 1224 pull_request, user, 'review_status_change',
1214 1225 data={'status': calculated_status})
1215 1226
1216 1227 # finally close the PR
1217 1228 PullRequestModel().close_pull_request(
1218 1229 pull_request.pull_request_id, user)
1219 1230
1220 1231 return comment, status
1221 1232
1222 1233 def merge_status(self, pull_request, translator=None,
1223 1234 force_shadow_repo_refresh=False):
1224 1235 _ = translator or get_current_request().translate
1225 1236
1226 1237 if not self._is_merge_enabled(pull_request):
1227 1238 return False, _('Server-side pull request merging is disabled.')
1228 1239 if pull_request.is_closed():
1229 1240 return False, _('This pull request is closed.')
1230 1241 merge_possible, msg = self._check_repo_requirements(
1231 1242 target=pull_request.target_repo, source=pull_request.source_repo,
1232 1243 translator=_)
1233 1244 if not merge_possible:
1234 1245 return merge_possible, msg
1235 1246
1236 1247 try:
1237 1248 resp = self._try_merge(
1238 1249 pull_request,
1239 1250 force_shadow_repo_refresh=force_shadow_repo_refresh)
1240 1251 log.debug("Merge response: %s", resp)
1241 1252 status = resp.possible, resp.merge_status_message
1242 1253 except NotImplementedError:
1243 1254 status = False, _('Pull request merging is not supported.')
1244 1255
1245 1256 return status
1246 1257
1247 1258 def _check_repo_requirements(self, target, source, translator):
1248 1259 """
1249 1260 Check if `target` and `source` have compatible requirements.
1250 1261
1251 1262 Currently this is just checking for largefiles.
1252 1263 """
1253 1264 _ = translator
1254 1265 target_has_largefiles = self._has_largefiles(target)
1255 1266 source_has_largefiles = self._has_largefiles(source)
1256 1267 merge_possible = True
1257 1268 message = u''
1258 1269
1259 1270 if target_has_largefiles != source_has_largefiles:
1260 1271 merge_possible = False
1261 1272 if source_has_largefiles:
1262 1273 message = _(
1263 1274 'Target repository large files support is disabled.')
1264 1275 else:
1265 1276 message = _(
1266 1277 'Source repository large files support is disabled.')
1267 1278
1268 1279 return merge_possible, message
1269 1280
1270 1281 def _has_largefiles(self, repo):
1271 1282 largefiles_ui = VcsSettingsModel(repo=repo).get_ui_settings(
1272 1283 'extensions', 'largefiles')
1273 1284 return largefiles_ui and largefiles_ui[0].active
1274 1285
1275 1286 def _try_merge(self, pull_request, force_shadow_repo_refresh=False):
1276 1287 """
1277 1288 Try to merge the pull request and return the merge status.
1278 1289 """
1279 1290 log.debug(
1280 1291 "Trying out if the pull request %s can be merged. Force_refresh=%s",
1281 1292 pull_request.pull_request_id, force_shadow_repo_refresh)
1282 1293 target_vcs = pull_request.target_repo.scm_instance()
1283 1294 # Refresh the target reference.
1284 1295 try:
1285 1296 target_ref = self._refresh_reference(
1286 1297 pull_request.target_ref_parts, target_vcs)
1287 1298 except CommitDoesNotExistError:
1288 1299 merge_state = MergeResponse(
1289 1300 False, False, None, MergeFailureReason.MISSING_TARGET_REF,
1290 1301 metadata={'target_ref': pull_request.target_ref_parts})
1291 1302 return merge_state
1292 1303
1293 1304 target_locked = pull_request.target_repo.locked
1294 1305 if target_locked and target_locked[0]:
1295 1306 locked_by = 'user:{}'.format(target_locked[0])
1296 1307 log.debug("The target repository is locked by %s.", locked_by)
1297 1308 merge_state = MergeResponse(
1298 1309 False, False, None, MergeFailureReason.TARGET_IS_LOCKED,
1299 1310 metadata={'locked_by': locked_by})
1300 1311 elif force_shadow_repo_refresh or self._needs_merge_state_refresh(
1301 1312 pull_request, target_ref):
1302 1313 log.debug("Refreshing the merge status of the repository.")
1303 1314 merge_state = self._refresh_merge_state(
1304 1315 pull_request, target_vcs, target_ref)
1305 1316 else:
1306 1317 possible = pull_request.\
1307 1318 last_merge_status == MergeFailureReason.NONE
1308 1319 merge_state = MergeResponse(
1309 1320 possible, False, None, pull_request.last_merge_status)
1310 1321
1311 1322 return merge_state
1312 1323
1313 1324 def _refresh_reference(self, reference, vcs_repository):
1314 1325 if reference.type in self.UPDATABLE_REF_TYPES:
1315 1326 name_or_id = reference.name
1316 1327 else:
1317 1328 name_or_id = reference.commit_id
1318 1329 refreshed_commit = vcs_repository.get_commit(name_or_id)
1319 1330 refreshed_reference = Reference(
1320 1331 reference.type, reference.name, refreshed_commit.raw_id)
1321 1332 return refreshed_reference
1322 1333
1323 1334 def _needs_merge_state_refresh(self, pull_request, target_reference):
1324 1335 return not(
1325 1336 pull_request.revisions and
1326 1337 pull_request.revisions[0] == pull_request._last_merge_source_rev and
1327 1338 target_reference.commit_id == pull_request._last_merge_target_rev)
1328 1339
1329 1340 def _refresh_merge_state(self, pull_request, target_vcs, target_reference):
1330 1341 workspace_id = self._workspace_id(pull_request)
1331 1342 source_vcs = pull_request.source_repo.scm_instance()
1332 1343 repo_id = pull_request.target_repo.repo_id
1333 1344 use_rebase = self._use_rebase_for_merging(pull_request)
1334 1345 close_branch = self._close_branch_before_merging(pull_request)
1335 1346 merge_state = target_vcs.merge(
1336 1347 repo_id, workspace_id,
1337 1348 target_reference, source_vcs, pull_request.source_ref_parts,
1338 1349 dry_run=True, use_rebase=use_rebase,
1339 1350 close_branch=close_branch)
1340 1351
1341 1352 # Do not store the response if there was an unknown error.
1342 1353 if merge_state.failure_reason != MergeFailureReason.UNKNOWN:
1343 1354 pull_request._last_merge_source_rev = \
1344 1355 pull_request.source_ref_parts.commit_id
1345 1356 pull_request._last_merge_target_rev = target_reference.commit_id
1346 1357 pull_request.last_merge_status = merge_state.failure_reason
1347 1358 pull_request.shadow_merge_ref = merge_state.merge_ref
1348 1359 Session().add(pull_request)
1349 1360 Session().commit()
1350 1361
1351 1362 return merge_state
1352 1363
1353 1364 def _workspace_id(self, pull_request):
1354 1365 workspace_id = 'pr-%s' % pull_request.pull_request_id
1355 1366 return workspace_id
1356 1367
1357 1368 def generate_repo_data(self, repo, commit_id=None, branch=None,
1358 1369 bookmark=None, translator=None):
1359 1370 from rhodecode.model.repo import RepoModel
1360 1371
1361 1372 all_refs, selected_ref = \
1362 1373 self._get_repo_pullrequest_sources(
1363 1374 repo.scm_instance(), commit_id=commit_id,
1364 1375 branch=branch, bookmark=bookmark, translator=translator)
1365 1376
1366 1377 refs_select2 = []
1367 1378 for element in all_refs:
1368 1379 children = [{'id': x[0], 'text': x[1]} for x in element[0]]
1369 1380 refs_select2.append({'text': element[1], 'children': children})
1370 1381
1371 1382 return {
1372 1383 'user': {
1373 1384 'user_id': repo.user.user_id,
1374 1385 'username': repo.user.username,
1375 1386 'firstname': repo.user.first_name,
1376 1387 'lastname': repo.user.last_name,
1377 1388 'gravatar_link': h.gravatar_url(repo.user.email, 14),
1378 1389 },
1379 1390 'name': repo.repo_name,
1380 1391 'link': RepoModel().get_url(repo),
1381 1392 'description': h.chop_at_smart(repo.description_safe, '\n'),
1382 1393 'refs': {
1383 1394 'all_refs': all_refs,
1384 1395 'selected_ref': selected_ref,
1385 1396 'select2_refs': refs_select2
1386 1397 }
1387 1398 }
1388 1399
1389 1400 def generate_pullrequest_title(self, source, source_ref, target):
1390 1401 return u'{source}#{at_ref} to {target}'.format(
1391 1402 source=source,
1392 1403 at_ref=source_ref,
1393 1404 target=target,
1394 1405 )
1395 1406
1396 1407 def _cleanup_merge_workspace(self, pull_request):
1397 1408 # Merging related cleanup
1398 1409 repo_id = pull_request.target_repo.repo_id
1399 1410 target_scm = pull_request.target_repo.scm_instance()
1400 1411 workspace_id = self._workspace_id(pull_request)
1401 1412
1402 1413 try:
1403 1414 target_scm.cleanup_merge_workspace(repo_id, workspace_id)
1404 1415 except NotImplementedError:
1405 1416 pass
1406 1417
1407 1418 def _get_repo_pullrequest_sources(
1408 1419 self, repo, commit_id=None, branch=None, bookmark=None,
1409 1420 translator=None):
1410 1421 """
1411 1422 Return a structure with repo's interesting commits, suitable for
1412 1423 the selectors in pullrequest controller
1413 1424
1414 1425 :param commit_id: a commit that must be in the list somehow
1415 1426 and selected by default
1416 1427 :param branch: a branch that must be in the list and selected
1417 1428 by default - even if closed
1418 1429 :param bookmark: a bookmark that must be in the list and selected
1419 1430 """
1420 1431 _ = translator or get_current_request().translate
1421 1432
1422 1433 commit_id = safe_str(commit_id) if commit_id else None
1423 1434 branch = safe_unicode(branch) if branch else None
1424 1435 bookmark = safe_unicode(bookmark) if bookmark else None
1425 1436
1426 1437 selected = None
1427 1438
1428 1439 # order matters: first source that has commit_id in it will be selected
1429 1440 sources = []
1430 1441 sources.append(('book', repo.bookmarks.items(), _('Bookmarks'), bookmark))
1431 1442 sources.append(('branch', repo.branches.items(), _('Branches'), branch))
1432 1443
1433 1444 if commit_id:
1434 1445 ref_commit = (h.short_id(commit_id), commit_id)
1435 1446 sources.append(('rev', [ref_commit], _('Commit IDs'), commit_id))
1436 1447
1437 1448 sources.append(
1438 1449 ('branch', repo.branches_closed.items(), _('Closed Branches'), branch),
1439 1450 )
1440 1451
1441 1452 groups = []
1442 1453
1443 1454 for group_key, ref_list, group_name, match in sources:
1444 1455 group_refs = []
1445 1456 for ref_name, ref_id in ref_list:
1446 1457 ref_key = u'{}:{}:{}'.format(group_key, ref_name, ref_id)
1447 1458 group_refs.append((ref_key, ref_name))
1448 1459
1449 1460 if not selected:
1450 1461 if set([commit_id, match]) & set([ref_id, ref_name]):
1451 1462 selected = ref_key
1452 1463
1453 1464 if group_refs:
1454 1465 groups.append((group_refs, group_name))
1455 1466
1456 1467 if not selected:
1457 1468 ref = commit_id or branch or bookmark
1458 1469 if ref:
1459 1470 raise CommitDoesNotExistError(
1460 1471 u'No commit refs could be found matching: {}'.format(ref))
1461 1472 elif repo.DEFAULT_BRANCH_NAME in repo.branches:
1462 1473 selected = u'branch:{}:{}'.format(
1463 1474 safe_unicode(repo.DEFAULT_BRANCH_NAME),
1464 1475 safe_unicode(repo.branches[repo.DEFAULT_BRANCH_NAME])
1465 1476 )
1466 1477 elif repo.commit_ids:
1467 1478 # make the user select in this case
1468 1479 selected = None
1469 1480 else:
1470 1481 raise EmptyRepositoryError()
1471 1482 return groups, selected
1472 1483
1473 1484 def get_diff(self, source_repo, source_ref_id, target_ref_id,
1474 1485 hide_whitespace_changes, diff_context):
1475 1486
1476 1487 return self._get_diff_from_pr_or_version(
1477 1488 source_repo, source_ref_id, target_ref_id,
1478 1489 hide_whitespace_changes=hide_whitespace_changes, diff_context=diff_context)
1479 1490
1480 1491 def _get_diff_from_pr_or_version(
1481 1492 self, source_repo, source_ref_id, target_ref_id,
1482 1493 hide_whitespace_changes, diff_context):
1483 1494
1484 1495 target_commit = source_repo.get_commit(
1485 1496 commit_id=safe_str(target_ref_id))
1486 1497 source_commit = source_repo.get_commit(
1487 1498 commit_id=safe_str(source_ref_id))
1488 1499 if isinstance(source_repo, Repository):
1489 1500 vcs_repo = source_repo.scm_instance()
1490 1501 else:
1491 1502 vcs_repo = source_repo
1492 1503
1493 1504 # TODO: johbo: In the context of an update, we cannot reach
1494 1505 # the old commit anymore with our normal mechanisms. It needs
1495 1506 # some sort of special support in the vcs layer to avoid this
1496 1507 # workaround.
1497 1508 if (source_commit.raw_id == vcs_repo.EMPTY_COMMIT_ID and
1498 1509 vcs_repo.alias == 'git'):
1499 1510 source_commit.raw_id = safe_str(source_ref_id)
1500 1511
1501 1512 log.debug('calculating diff between '
1502 1513 'source_ref:%s and target_ref:%s for repo `%s`',
1503 1514 target_ref_id, source_ref_id,
1504 1515 safe_unicode(vcs_repo.path))
1505 1516
1506 1517 vcs_diff = vcs_repo.get_diff(
1507 1518 commit1=target_commit, commit2=source_commit,
1508 1519 ignore_whitespace=hide_whitespace_changes, context=diff_context)
1509 1520 return vcs_diff
1510 1521
1511 1522 def _is_merge_enabled(self, pull_request):
1512 1523 return self._get_general_setting(
1513 1524 pull_request, 'rhodecode_pr_merge_enabled')
1514 1525
1515 1526 def _use_rebase_for_merging(self, pull_request):
1516 1527 repo_type = pull_request.target_repo.repo_type
1517 1528 if repo_type == 'hg':
1518 1529 return self._get_general_setting(
1519 1530 pull_request, 'rhodecode_hg_use_rebase_for_merging')
1520 1531 elif repo_type == 'git':
1521 1532 return self._get_general_setting(
1522 1533 pull_request, 'rhodecode_git_use_rebase_for_merging')
1523 1534
1524 1535 return False
1525 1536
1526 1537 def _close_branch_before_merging(self, pull_request):
1527 1538 repo_type = pull_request.target_repo.repo_type
1528 1539 if repo_type == 'hg':
1529 1540 return self._get_general_setting(
1530 1541 pull_request, 'rhodecode_hg_close_branch_before_merging')
1531 1542 elif repo_type == 'git':
1532 1543 return self._get_general_setting(
1533 1544 pull_request, 'rhodecode_git_close_branch_before_merging')
1534 1545
1535 1546 return False
1536 1547
1537 1548 def _get_general_setting(self, pull_request, settings_key, default=False):
1538 1549 settings_model = VcsSettingsModel(repo=pull_request.target_repo)
1539 1550 settings = settings_model.get_general_settings()
1540 1551 return settings.get(settings_key, default)
1541 1552
1542 1553 def _log_audit_action(self, action, action_data, user, pull_request):
1543 1554 audit_logger.store(
1544 1555 action=action,
1545 1556 action_data=action_data,
1546 1557 user=user,
1547 1558 repo=pull_request.target_repo)
1548 1559
1549 1560 def get_reviewer_functions(self):
1550 1561 """
1551 1562 Fetches functions for validation and fetching default reviewers.
1552 1563 If available we use the EE package, else we fallback to CE
1553 1564 package functions
1554 1565 """
1555 1566 try:
1556 1567 from rc_reviewers.utils import get_default_reviewers_data
1557 1568 from rc_reviewers.utils import validate_default_reviewers
1558 1569 except ImportError:
1559 1570 from rhodecode.apps.repository.utils import get_default_reviewers_data
1560 1571 from rhodecode.apps.repository.utils import validate_default_reviewers
1561 1572
1562 1573 return get_default_reviewers_data, validate_default_reviewers
1563 1574
1564 1575
1565 1576 class MergeCheck(object):
1566 1577 """
1567 1578 Perform Merge Checks and returns a check object which stores information
1568 1579 about merge errors, and merge conditions
1569 1580 """
1570 1581 TODO_CHECK = 'todo'
1571 1582 PERM_CHECK = 'perm'
1572 1583 REVIEW_CHECK = 'review'
1573 1584 MERGE_CHECK = 'merge'
1574 1585
1575 1586 def __init__(self):
1576 1587 self.review_status = None
1577 1588 self.merge_possible = None
1578 1589 self.merge_msg = ''
1579 1590 self.failed = None
1580 1591 self.errors = []
1581 1592 self.error_details = OrderedDict()
1582 1593
1583 1594 def push_error(self, error_type, message, error_key, details):
1584 1595 self.failed = True
1585 1596 self.errors.append([error_type, message])
1586 1597 self.error_details[error_key] = dict(
1587 1598 details=details,
1588 1599 error_type=error_type,
1589 1600 message=message
1590 1601 )
1591 1602
1592 1603 @classmethod
1593 1604 def validate(cls, pull_request, auth_user, translator, fail_early=False,
1594 1605 force_shadow_repo_refresh=False):
1595 1606 _ = translator
1596 1607 merge_check = cls()
1597 1608
1598 1609 # permissions to merge
1599 1610 user_allowed_to_merge = PullRequestModel().check_user_merge(
1600 1611 pull_request, auth_user)
1601 1612 if not user_allowed_to_merge:
1602 1613 log.debug("MergeCheck: cannot merge, approval is pending.")
1603 1614
1604 1615 msg = _('User `{}` not allowed to perform merge.').format(auth_user.username)
1605 1616 merge_check.push_error('error', msg, cls.PERM_CHECK, auth_user.username)
1606 1617 if fail_early:
1607 1618 return merge_check
1608 1619
1609 1620 # permission to merge into the target branch
1610 1621 target_commit_id = pull_request.target_ref_parts.commit_id
1611 1622 if pull_request.target_ref_parts.type == 'branch':
1612 1623 branch_name = pull_request.target_ref_parts.name
1613 1624 else:
1614 1625 # for mercurial we can always figure out the branch from the commit
1615 1626 # in case of bookmark
1616 1627 target_commit = pull_request.target_repo.get_commit(target_commit_id)
1617 1628 branch_name = target_commit.branch
1618 1629
1619 1630 rule, branch_perm = auth_user.get_rule_and_branch_permission(
1620 1631 pull_request.target_repo.repo_name, branch_name)
1621 1632 if branch_perm and branch_perm == 'branch.none':
1622 1633 msg = _('Target branch `{}` changes rejected by rule {}.').format(
1623 1634 branch_name, rule)
1624 1635 merge_check.push_error('error', msg, cls.PERM_CHECK, auth_user.username)
1625 1636 if fail_early:
1626 1637 return merge_check
1627 1638
1628 1639 # review status, must be always present
1629 1640 review_status = pull_request.calculated_review_status()
1630 1641 merge_check.review_status = review_status
1631 1642
1632 1643 status_approved = review_status == ChangesetStatus.STATUS_APPROVED
1633 1644 if not status_approved:
1634 1645 log.debug("MergeCheck: cannot merge, approval is pending.")
1635 1646
1636 1647 msg = _('Pull request reviewer approval is pending.')
1637 1648
1638 1649 merge_check.push_error('warning', msg, cls.REVIEW_CHECK, review_status)
1639 1650
1640 1651 if fail_early:
1641 1652 return merge_check
1642 1653
1643 1654 # left over TODOs
1644 1655 todos = CommentsModel().get_pull_request_unresolved_todos(pull_request)
1645 1656 if todos:
1646 1657 log.debug("MergeCheck: cannot merge, {} "
1647 1658 "unresolved TODOs left.".format(len(todos)))
1648 1659
1649 1660 if len(todos) == 1:
1650 1661 msg = _('Cannot merge, {} TODO still not resolved.').format(
1651 1662 len(todos))
1652 1663 else:
1653 1664 msg = _('Cannot merge, {} TODOs still not resolved.').format(
1654 1665 len(todos))
1655 1666
1656 1667 merge_check.push_error('warning', msg, cls.TODO_CHECK, todos)
1657 1668
1658 1669 if fail_early:
1659 1670 return merge_check
1660 1671
1661 1672 # merge possible, here is the filesystem simulation + shadow repo
1662 1673 merge_status, msg = PullRequestModel().merge_status(
1663 1674 pull_request, translator=translator,
1664 1675 force_shadow_repo_refresh=force_shadow_repo_refresh)
1665 1676 merge_check.merge_possible = merge_status
1666 1677 merge_check.merge_msg = msg
1667 1678 if not merge_status:
1668 1679 log.debug("MergeCheck: cannot merge, pull request merge not possible.")
1669 1680 merge_check.push_error('warning', msg, cls.MERGE_CHECK, None)
1670 1681
1671 1682 if fail_early:
1672 1683 return merge_check
1673 1684
1674 1685 log.debug('MergeCheck: is failed: %s', merge_check.failed)
1675 1686 return merge_check
1676 1687
1677 1688 @classmethod
1678 1689 def get_merge_conditions(cls, pull_request, translator):
1679 1690 _ = translator
1680 1691 merge_details = {}
1681 1692
1682 1693 model = PullRequestModel()
1683 1694 use_rebase = model._use_rebase_for_merging(pull_request)
1684 1695
1685 1696 if use_rebase:
1686 1697 merge_details['merge_strategy'] = dict(
1687 1698 details={},
1688 1699 message=_('Merge strategy: rebase')
1689 1700 )
1690 1701 else:
1691 1702 merge_details['merge_strategy'] = dict(
1692 1703 details={},
1693 1704 message=_('Merge strategy: explicit merge commit')
1694 1705 )
1695 1706
1696 1707 close_branch = model._close_branch_before_merging(pull_request)
1697 1708 if close_branch:
1698 1709 repo_type = pull_request.target_repo.repo_type
1699 1710 close_msg = ''
1700 1711 if repo_type == 'hg':
1701 1712 close_msg = _('Source branch will be closed after merge.')
1702 1713 elif repo_type == 'git':
1703 1714 close_msg = _('Source branch will be deleted after merge.')
1704 1715
1705 1716 merge_details['close_branch'] = dict(
1706 1717 details={},
1707 1718 message=close_msg
1708 1719 )
1709 1720
1710 1721 return merge_details
1711 1722
1712 1723
1713 1724 ChangeTuple = collections.namedtuple(
1714 1725 'ChangeTuple', ['added', 'common', 'removed', 'total'])
1715 1726
1716 1727 FileChangeTuple = collections.namedtuple(
1717 1728 'FileChangeTuple', ['added', 'modified', 'removed'])
General Comments 0
You need to be logged in to leave comments. Login now