Files
@ 6952e88f8ded
Branch filter:
Location: kallithea/kallithea/model/comment.py
6952e88f8ded
11.9 KiB
text/x-python
tests: add basic tests for comment model
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 | # -*- coding: utf-8 -*-
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# 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 General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
kallithea.model.comment
~~~~~~~~~~~~~~~~~~~~~~~
comments model for Kallithea
This file was forked by the Kallithea project in July 2014.
Original author and date, and relevant copyright and licensing information is below:
:created_on: Nov 11, 2011
:author: marcink
:copyright: (c) 2013 RhodeCode GmbH, and others.
:license: GPLv3, see LICENSE.md for more details.
"""
import logging
from tg.i18n import ugettext as _
from collections import defaultdict
from kallithea.lib.utils2 import extract_mentioned_users, safe_unicode
from kallithea.lib import helpers as h
from kallithea.model.db import ChangesetComment, User, \
PullRequest, Repository
from kallithea.model.notification import NotificationModel
from kallithea.model.meta import Session
log = logging.getLogger(__name__)
def _list_changeset_commenters(revision):
return (Session().query(User)
.join(ChangesetComment.author)
.filter(ChangesetComment.revision == revision)
.all())
def _list_pull_request_commenters(pull_request):
return (Session().query(User)
.join(ChangesetComment.author)
.filter(ChangesetComment.pull_request_id == pull_request.pull_request_id)
.all())
class ChangesetCommentsModel(object):
def _get_notification_data(self, repo, comment, author, comment_text,
line_no=None, revision=None, pull_request=None,
status_change=None, closing_pr=False):
"""
:returns: tuple (subj,body,recipients,notification_type,email_kwargs)
"""
# make notification
body = comment_text # text of the comment
line = ''
if line_no:
line = _('on line %s') % line_no
# changeset
if revision:
notification_type = NotificationModel.TYPE_CHANGESET_COMMENT
cs = repo.scm_instance.get_changeset(revision)
desc = cs.short_id
threading = ['%s-rev-%s@%s' % (repo.repo_name, revision, h.canonical_hostname())]
if line_no: # TODO: url to file _and_ line number
threading.append('%s-rev-%s-line-%s@%s' % (repo.repo_name, revision, line_no,
h.canonical_hostname()))
comment_url = h.canonical_url('changeset_home',
repo_name=repo.repo_name,
revision=revision,
anchor='comment-%s' % comment.comment_id)
subj = safe_unicode(
h.link_to('Re changeset: %(desc)s %(line)s' % \
{'desc': desc, 'line': line},
comment_url)
)
# get the current participants of this changeset
recipients = _list_changeset_commenters(revision)
# add changeset author if it's known locally
cs_author = User.get_from_cs_author(cs.author)
if not cs_author:
# use repo owner if we cannot extract the author correctly
# FIXME: just use committer name even if not a user
cs_author = repo.owner
recipients.append(cs_author)
email_kwargs = {
'status_change': status_change,
'cs_comment_user': author.full_name_and_username,
'cs_target_repo': h.canonical_url('summary_home', repo_name=repo.repo_name),
'cs_comment_url': comment_url,
'cs_url': h.canonical_url('changeset_home', repo_name=repo.repo_name, revision=revision),
'raw_id': revision,
'message': cs.message,
'message_short': h.shorter(cs.message, 50, firstline=True),
'cs_author': cs_author,
'repo_name': repo.repo_name,
'short_id': h.short_id(revision),
'branch': cs.branch,
'comment_username': author.username,
'threading': threading,
}
# pull request
elif pull_request:
notification_type = NotificationModel.TYPE_PULL_REQUEST_COMMENT
desc = comment.pull_request.title
_org_ref_type, org_ref_name, _org_rev = comment.pull_request.org_ref.split(':')
_other_ref_type, other_ref_name, _other_rev = comment.pull_request.other_ref.split(':')
threading = ['%s-pr-%s@%s' % (pull_request.other_repo.repo_name,
pull_request.pull_request_id,
h.canonical_hostname())]
if line_no: # TODO: url to file _and_ line number
threading.append('%s-pr-%s-line-%s@%s' % (pull_request.other_repo.repo_name,
pull_request.pull_request_id, line_no,
h.canonical_hostname()))
comment_url = pull_request.url(canonical=True,
anchor='comment-%s' % comment.comment_id)
subj = safe_unicode(
h.link_to('Re pull request %(pr_nice_id)s: %(desc)s %(line)s' %
{'desc': desc,
'pr_nice_id': comment.pull_request.nice_id(),
'line': line},
comment_url)
)
# get the current participants of this pull request
recipients = _list_pull_request_commenters(pull_request)
recipients.append(pull_request.owner)
recipients += pull_request.get_reviewer_users()
# set some variables for email notification
email_kwargs = {
'pr_title': pull_request.title,
'pr_title_short': h.shorter(pull_request.title, 50),
'pr_nice_id': pull_request.nice_id(),
'status_change': status_change,
'closing_pr': closing_pr,
'pr_comment_url': comment_url,
'pr_url': pull_request.url(canonical=True),
'pr_comment_user': author.full_name_and_username,
'pr_target_repo': h.canonical_url('summary_home',
repo_name=pull_request.other_repo.repo_name),
'pr_target_branch': other_ref_name,
'pr_source_repo': h.canonical_url('summary_home',
repo_name=pull_request.org_repo.repo_name),
'pr_source_branch': org_ref_name,
'pr_owner': pull_request.owner,
'pr_owner_username': pull_request.owner.username,
'repo_name': pull_request.other_repo.repo_name,
'comment_username': author.username,
'threading': threading,
}
return subj, body, recipients, notification_type, email_kwargs
def create(self, text, repo, author, revision=None, pull_request=None,
f_path=None, line_no=None, status_change=None, closing_pr=False,
send_email=True):
"""
Creates a new comment for either a changeset or a pull request.
status_change and closing_pr is only for the optional email.
Returns the created comment.
"""
if not status_change and not text:
log.warning('Missing text for comment, skipping...')
return None
repo = Repository.guess_instance(repo)
author = User.guess_instance(author)
comment = ChangesetComment()
comment.repo = repo
comment.author = author
comment.text = text
comment.f_path = f_path
comment.line_no = line_no
if revision is not None:
comment.revision = revision
elif pull_request is not None:
pull_request = PullRequest.guess_instance(pull_request)
comment.pull_request = pull_request
else:
raise Exception('Please specify revision or pull_request_id')
Session().add(comment)
Session().flush()
if send_email:
(subj, body, recipients, notification_type,
email_kwargs) = self._get_notification_data(
repo, comment, author,
comment_text=text,
line_no=line_no,
revision=revision,
pull_request=pull_request,
status_change=status_change,
closing_pr=closing_pr)
email_kwargs['is_mention'] = False
# create notification objects, and emails
NotificationModel().create(
created_by=author, subject=subj, body=body,
recipients=recipients, type_=notification_type,
email_kwargs=email_kwargs,
)
mention_recipients = extract_mentioned_users(body).difference(recipients)
if mention_recipients:
email_kwargs['is_mention'] = True
subj = _('[Mention]') + ' ' + subj
# FIXME: this subject is wrong and unused!
NotificationModel().create(
created_by=author, subject=subj, body=body,
recipients=mention_recipients,
type_=notification_type,
email_kwargs=email_kwargs
)
return comment
def delete(self, comment):
comment = ChangesetComment.guess_instance(comment)
Session().delete(comment)
return comment
def get_comments(self, repo_id, revision=None, pull_request=None):
"""
Gets general comments for either revision or pull_request.
Returns a list, ordered by creation date.
"""
return self._get_comments(repo_id, revision=revision, pull_request=pull_request,
inline=False)
def get_inline_comments(self, repo_id, revision=None, pull_request=None):
"""
Gets inline comments for either revision or pull_request.
Returns a list of tuples with file path and list of comments per line number.
"""
comments = self._get_comments(repo_id, revision=revision, pull_request=pull_request,
inline=True)
paths = defaultdict(lambda: defaultdict(list))
for co in comments:
paths[co.f_path][co.line_no].append(co)
return paths.items()
def _get_comments(self, repo_id, revision=None, pull_request=None, inline=False):
"""
Gets comments for either revision or pull_request_id, either inline or general.
"""
q = Session().query(ChangesetComment)
if inline:
q = q.filter(ChangesetComment.line_no != None) \
.filter(ChangesetComment.f_path != None)
else:
q = q.filter(ChangesetComment.line_no == None) \
.filter(ChangesetComment.f_path == None)
if revision is not None:
q = q.filter(ChangesetComment.revision == revision) \
.filter(ChangesetComment.repo_id == repo_id)
elif pull_request is not None:
pull_request = PullRequest.guess_instance(pull_request)
q = q.filter(ChangesetComment.pull_request == pull_request)
else:
raise Exception('Please specify either revision or pull_request')
return q.order_by(ChangesetComment.created_on).all()
|