##// END OF EJS Templates
fix(docs): fixed docs build
fix(docs): fixed docs build

File last commit:

r5180:0f2a8907 default
r5241:d4beb7f7 default
Show More
changeset_status.py
402 lines | 14.8 KiB | text/x-python | PythonLexer
copyrights: updated for 2023
r5088 # Copyright (C) 2010-2023 RhodeCode GmbH
project: added all source files and assets
r1 #
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/
import itertools
import logging
default-reviewers: introduce new voting rule logic that allows...
r2484 import collections
project: added all source files and assets
r1
from rhodecode.model import BaseModel
events: properly refresh comment object to load it's relationship....
r2470 from rhodecode.model.db import (
lint: use null() to compare to == None for linters to be happy
r5180 null, ChangesetStatus, ChangesetComment, PullRequest, PullRequestReviewers, Session)
project: added all source files and assets
r1 from rhodecode.lib.exceptions import StatusChangeOnClosedPullRequestError
from rhodecode.lib.markup_renderer import (
DEFAULT_COMMENTS_RENDERER, RstTemplateRenderer)
log = logging.getLogger(__name__)
class ChangesetStatusModel(BaseModel):
cls = ChangesetStatus
def __get_changeset_status(self, changeset_status):
return self._get_instance(ChangesetStatus, changeset_status)
def __get_pull_request(self, pull_request):
return self._get_instance(PullRequest, pull_request)
def _get_status_query(self, repo, revision, pull_request,
with_revisions=False):
repo = self._get_repo(repo)
q = ChangesetStatus.query()\
.filter(ChangesetStatus.repo == repo)
if not with_revisions:
q = q.filter(ChangesetStatus.version == 0)
if revision:
q = q.filter(ChangesetStatus.revision == revision)
elif pull_request:
pull_request = self.__get_pull_request(pull_request)
# TODO: johbo: Think about the impact of this join, there must
# be a reason why ChangesetStatus and ChanagesetComment is linked
# to the pull request. Might be that we want to do the same for
# the pull_request_version_id.
q = q.join(ChangesetComment).filter(
ChangesetStatus.pull_request == pull_request,
lint: use null() to compare to == None for linters to be happy
r5180 ChangesetComment.pull_request_version_id == null())
project: added all source files and assets
r1 else:
raise Exception('Please specify revision or pull_request')
q = q.order_by(ChangesetStatus.version.asc())
return q
default-reviewers: introduce new voting rule logic that allows...
r2484 def calculate_group_vote(self, group_id, group_statuses_by_reviewers,
trim_votes=True):
"""
Calculate status based on given group members, and voting rule
group1 - 4 members, 3 required for approval
user1 - approved
user2 - reject
user3 - approved
user4 - rejected
final_state: rejected, reasons not at least 3 votes
group1 - 4 members, 2 required for approval
user1 - approved
user2 - reject
user3 - approved
user4 - rejected
final_state: approved, reasons got at least 2 approvals
group1 - 4 members, ALL required for approval
user1 - approved
user2 - reject
user3 - approved
user4 - rejected
final_state: rejected, reasons not all approvals
group1 - 4 members, ALL required for approval
user1 - approved
user2 - approved
user3 - approved
user4 - approved
final_state: approved, reason all approvals received
group1 - 4 members, 5 required for approval
(approval should be shorted to number of actual members)
user1 - approved
user2 - approved
user3 - approved
user4 - approved
final_state: approved, reason all approvals received
"""
group_vote_data = {}
got_rule = False
members = collections.OrderedDict()
for review_obj, user, reasons, mandatory, statuses \
in group_statuses_by_reviewers:
if not got_rule:
group_vote_data = review_obj.rule_user_group_data()
got_rule = bool(group_vote_data)
members[user.user_id] = statuses
if not group_vote_data:
return []
required_votes = group_vote_data['vote_rule']
if required_votes == -1:
# -1 means all required, so we replace it with how many people
# are in the members
required_votes = len(members)
if trim_votes and required_votes > len(members):
# we require more votes than we have members in the group
# in this case we trim the required votes to the number of members
required_votes = len(members)
approvals = sum([
1 for statuses in members.values()
if statuses and
statuses[0][1].status == ChangesetStatus.STATUS_APPROVED])
calculated_votes = []
# we have all votes from users, now check if we have enough votes
# to fill other
fill_in = ChangesetStatus.STATUS_UNDER_REVIEW
if approvals >= required_votes:
fill_in = ChangesetStatus.STATUS_APPROVED
for member, statuses in members.items():
if statuses:
ver, latest = statuses[0]
if fill_in == ChangesetStatus.STATUS_APPROVED:
calculated_votes.append(fill_in)
else:
calculated_votes.append(latest.status)
else:
calculated_votes.append(fill_in)
return calculated_votes
project: added all source files and assets
r1 def calculate_status(self, statuses_by_reviewers):
"""
Given the approval statuses from reviewers, calculates final approval
status. There can only be 3 results, all approved, all rejected. If
there is no consensus the PR is under review.
:param statuses_by_reviewers:
"""
default-reviewers: introduce new voting rule logic that allows...
r2484
def group_rule(element):
models: major update for python3,...
r5070 _review_obj = element[0]
rule_data = _review_obj.rule_user_group_data()
default-reviewers: introduce new voting rule logic that allows...
r2484 if rule_data and rule_data['id']:
return rule_data['id']
models: major update for python3,...
r5070 # don't return None, as we cant compare this
return 0
default-reviewers: introduce new voting rule logic that allows...
r2484
models: major update for python3,...
r5070 voting_groups = itertools.groupby(sorted(statuses_by_reviewers, key=group_rule), group_rule)
default-reviewers: introduce new voting rule logic that allows...
r2484
voting_by_groups = [(x, list(y)) for x, y in voting_groups]
project: added all source files and assets
r1 reviewers_number = len(statuses_by_reviewers)
default-reviewers: introduce new voting rule logic that allows...
r2484 votes = collections.defaultdict(int)
for group, group_statuses_by_reviewers in voting_by_groups:
if group:
# calculate how the "group" voted
for vote_status in self.calculate_group_vote(
group, group_statuses_by_reviewers):
votes[vote_status] += 1
project: added all source files and assets
r1 else:
default-reviewers: introduce new voting rule logic that allows...
r2484
for review_obj, user, reasons, mandatory, statuses \
in group_statuses_by_reviewers:
# individual vote
if statuses:
ver, latest = statuses[0]
votes[latest.status] += 1
project: added all source files and assets
r1
default-reviewers: introduce new voting rule logic that allows...
r2484 approved_votes_count = votes[ChangesetStatus.STATUS_APPROVED]
rejected_votes_count = votes[ChangesetStatus.STATUS_REJECTED]
# TODO(marcink): with group voting, how does rejected work,
# do we ever get rejected state ?
sidebar: fixes to comment links, and new hovercard info about a comment.
r4488 if approved_votes_count and (approved_votes_count == reviewers_number):
project: added all source files and assets
r1 return ChangesetStatus.STATUS_APPROVED
sidebar: fixes to comment links, and new hovercard info about a comment.
r4488 if rejected_votes_count and (rejected_votes_count == reviewers_number):
project: added all source files and assets
r1 return ChangesetStatus.STATUS_REJECTED
return ChangesetStatus.STATUS_UNDER_REVIEW
def get_statuses(self, repo, revision=None, pull_request=None,
with_revisions=False):
q = self._get_status_query(repo, revision, pull_request,
with_revisions)
return q.all()
def get_status(self, repo, revision=None, pull_request=None, as_str=True):
"""
Returns latest status of changeset for given revision or for given
pull request. Statuses are versioned inside a table itself and
version == 0 is always the current one
:param repo:
:param revision: 40char hash or None
:param pull_request: pull_request reference
:param as_str: return status as string not object
"""
q = self._get_status_query(repo, revision, pull_request)
# need to use first here since there can be multiple statuses
# returned from pull_request
status = q.first()
if as_str:
status = status.status if status else status
st = status or ChangesetStatus.DEFAULT
return str(st)
return status
def _render_auto_status_message(
self, status, commit_id=None, pull_request=None):
"""
render the message using DEFAULT_COMMENTS_RENDERER (RST renderer),
so it's always looking the same disregarding on which default
renderer system is using.
:param status: status text to change into
:param commit_id: the commit_id we change the status for
:param pull_request: the pull request we change the status for
"""
new_status = ChangesetStatus.get_status_lbl(status)
params = {
'new_status_label': new_status,
'pull_request': pull_request,
'commit_id': commit_id,
}
renderer = RstTemplateRenderer()
return renderer.render('auto_status_change.mako', **params)
def set_status(self, repo, status, user, comment=None, revision=None,
pull_request=None, dont_allow_on_closed_pull_request=False):
"""
Creates new status for changeset or updates the old ones bumping their
version, leaving the current status at
:param repo:
:param revision:
:param status:
:param user:
:param comment:
:param dont_allow_on_closed_pull_request: don't allow a status change
if last status was for pull request and it's closed. We shouldn't
mess around this manually
"""
repo = self._get_repo(repo)
q = ChangesetStatus.query()
if revision:
q = q.filter(ChangesetStatus.repo == repo)
q = q.filter(ChangesetStatus.revision == revision)
elif pull_request:
pull_request = self.__get_pull_request(pull_request)
q = q.filter(ChangesetStatus.repo == pull_request.source_repo)
q = q.filter(ChangesetStatus.revision.in_(pull_request.revisions))
cur_statuses = q.all()
# if statuses exists and last is associated with a closed pull request
# we need to check if we can allow this status change
if (dont_allow_on_closed_pull_request and cur_statuses
and getattr(cur_statuses[0].pull_request, 'status', '')
== PullRequest.STATUS_CLOSED):
raise StatusChangeOnClosedPullRequestError(
'Changing status on closed pull request is not allowed'
)
# update all current statuses with older version
if cur_statuses:
for st in cur_statuses:
st.version += 1
events: properly refresh comment object to load it's relationship....
r2470 Session().add(st)
pull-requests: increase stability of concurrent pull requests creation by flushing prematurly the statuses of commits....
r3408 Session().flush()
project: added all source files and assets
r1
def _create_status(user, repo, status, comment, revision, pull_request):
new_status = ChangesetStatus()
new_status.author = self._get_user(user)
new_status.repo = self._get_repo(repo)
new_status.status = status
new_status.comment = comment
new_status.revision = revision
new_status.pull_request = pull_request
return new_status
if not comment:
comments: renamed ChangesetCommentsModel to CommentsModel to reflect what it actually does....
r1323 from rhodecode.model.comment import CommentsModel
comment = CommentsModel().create(
project: added all source files and assets
r1 text=self._render_auto_status_message(
status, commit_id=revision, pull_request=pull_request),
repo=repo,
user=user,
pull_request=pull_request,
send_email=False, renderer=DEFAULT_COMMENTS_RENDERER
)
if revision:
new_status = _create_status(
user=user, repo=repo, status=status, comment=comment,
revision=revision, pull_request=pull_request)
events: properly refresh comment object to load it's relationship....
r2470 Session().add(new_status)
project: added all source files and assets
r1 return new_status
elif pull_request:
# pull request can have more than one revision associated to it
# we need to create new version for each one
new_statuses = []
repo = pull_request.source_repo
for rev in pull_request.revisions:
new_status = _create_status(
user=user, repo=repo, status=status, comment=comment,
revision=rev, pull_request=pull_request)
new_statuses.append(new_status)
events: properly refresh comment object to load it's relationship....
r2470 Session().add(new_status)
project: added all source files and assets
r1 return new_statuses
pull-requests: added awaiting my review filter for users pull-requests....
r4690 def aggregate_votes_by_user(self, commit_statuses, reviewers_data, user=None):
commits/pr pages various fixes....
r4485
commit_statuses_map = collections.defaultdict(list)
for st in commit_statuses:
commit_statuses_map[st.author.username] += [st]
reviewers = []
def version(commit_status):
return commit_status.version
for obj in reviewers_data:
if not obj.user:
continue
pull-requests: added awaiting my review filter for users pull-requests....
r4690 if user and obj.user.username != user.username:
# single user filter
continue
commits/pr pages various fixes....
r4485 statuses = commit_statuses_map.get(obj.user.username, None)
if statuses:
status_groups = itertools.groupby(
sorted(statuses, key=version), version)
statuses = [(x, list(y)[0]) for x, y in status_groups]
reviewers.append((obj, obj.user, obj.reasons, obj.mandatory, statuses))
pull-requests: added awaiting my review filter for users pull-requests....
r4690 if user:
return reviewers[0] if reviewers else reviewers
else:
return reviewers
commits/pr pages various fixes....
r4485
pull-requests: added awaiting my review filter for users pull-requests....
r4690 def reviewers_statuses(self, pull_request, user=None):
project: added all source files and assets
r1 _commit_statuses = self.get_statuses(
pull_request.source_repo,
pull_request=pull_request,
with_revisions=True)
reviewers: added observers as another way to define reviewers....
r4500 reviewers = pull_request.get_pull_request_reviewers(
role=PullRequestReviewers.ROLE_REVIEWER)
pull-requests: added awaiting my review filter for users pull-requests....
r4690 return self.aggregate_votes_by_user(_commit_statuses, reviewers, user=user)
project: added all source files and assets
r1
reviewers: added observers as another way to define reviewers....
r4500 def calculated_review_status(self, pull_request):
project: added all source files and assets
r1 """
calculate pull request status based on reviewers, it should be a list
of two element lists.
"""
reviewers: added observers as another way to define reviewers....
r4500 reviewers = self.reviewers_statuses(pull_request)
project: added all source files and assets
r1 return self.calculate_status(reviewers)