integrations: restructure code and added better coverage.

rhodecode/integrations/types/handlers/__init__.py

@@ -0,0 +1,17 b''
+# Copyright (C) 2012-2023 RhodeCode GmbH
+#
+# 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/

rhodecode/integrations/types/handlers/slack.py

@@ -0,0 +1,242 b''
+# Copyright (C) 2012-2023 RhodeCode GmbH
+#
+# 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 re
+import textwrap
+import dataclasses
+import logging
+import typing
+
+from mako.template import Template
+
+from rhodecode import events
+from rhodecode.integrations.types.base import CommitParsingDataHandler, render_with_traceback
+
+log = logging.getLogger(__name__)
+
+
[e-mail]
+class SlackData:
+    title: str
+    text: str
+    fields: list[dict] | None = None
+    overrides: dict | None = None
+
+
+def html_to_slack_links(message):
+    return re.compile(r'<a .*?href=["\'](.+?)".*?>(.+?)</a>').sub(r'<\1|\2>', message)
+
+
+REPO_PUSH_TEMPLATE = Template('''
+<%
+    def branch_text(branch):
+        if branch:
+            return 'on branch: <{}|{}>'.format(branch_commits['branch']['url'], branch_commits['branch']['name'])
+        else:
+            ## case for SVN no branch push...
+            return 'to trunk'
+%> \
+
+% for branch, branch_commits in branches_commits.items():
+${len(branch_commits['commits'])} ${'commit' if len(branch_commits['commits']) == 1 else 'commits'} ${branch_text(branch)}
+% for commit in branch_commits['commits']:
+`<${commit['url']}|${commit['short_id']}>` - ${commit['message_html']|html_to_slack_links}
+% endfor
+% endfor
+''')
+
+
+class SlackDataHandler(CommitParsingDataHandler):
+    name = 'slack'
+
+    def __init__(self):
+        pass
+
+    def __call__(self, event: events.RhodecodeEvent, data):
+        if not isinstance(event, events.RhodecodeEvent):
+            raise TypeError(f"event {event} is not subtype of events.RhodecodeEvent")
+
+        actor = data["actor"]["username"]
+        default_title = f'*{actor}* caused a *{event.name}* event'
+        default_text = f'*{actor}* caused a *{event.name}* event'
+
+        default_slack_data = SlackData(title=default_title, text=default_text)
+
+        if isinstance(event, events.PullRequestCommentEvent):
+            return self.format_pull_request_comment_event(
+                event, data, default_slack_data
+            )
+        elif isinstance(event, events.PullRequestCommentEditEvent):
+            return self.format_pull_request_comment_event(
+                event, data, default_slack_data
+            )
+        elif isinstance(event, events.PullRequestReviewEvent):
+            return self.format_pull_request_review_event(event, data, default_slack_data)
+        elif isinstance(event, events.PullRequestEvent):
+            return self.format_pull_request_event(event, data, default_slack_data)
+        elif isinstance(event, events.RepoPushEvent):
+            return self.format_repo_push_event(event, data, default_slack_data)
+        elif isinstance(event, events.RepoCreateEvent):
+            return self.format_repo_create_event(event, data, default_slack_data)
+        else:
+            raise ValueError(
+                f'event type `{event.__class__}` has no handler defined')
+
+    def format_pull_request_comment_event(self, event, data, slack_data):
+        comment_text = data['comment']['text']
+        if len(comment_text) > 200:
+            comment_text = '<{comment_url}|{comment_text}...>'.format(
+                comment_text=comment_text[:200],
+                comment_url=data['comment']['url'],
+            )
+
+        fields = None
+        overrides = None
+        status_text = None
+
+        if data['comment']['status']:
+            status_color = {
+                'approved': '#0ac878',
+                'rejected': '#e85e4d'}.get(data['comment']['status'])
+
+            if status_color:
+                overrides = {"color": status_color}
+
+            status_text = data['comment']['status']
+
+        if data['comment']['file']:
+            fields = [
+                {
+                    "title": "file",
+                    "value": data['comment']['file']
+                },
+                {
+                    "title": "line",
+                    "value": data['comment']['line']
+                }
+            ]
+
+        template = Template(textwrap.dedent(r'''
+        *${data['actor']['username']}* left ${data['comment']['type']} on pull request <${data['pullrequest']['url']}|#${data['pullrequest']['pull_request_id']}>:
+        '''))
+        title = render_with_traceback(
+            template, data=data, comment=event.comment)
+
+        template = Template(textwrap.dedent(r'''
+        *pull request title*: ${pr_title}
+        % if status_text:
+        *submitted status*: `${status_text}`
+        % endif
+        >>> ${comment_text}
+        '''))
+        text = render_with_traceback(
+            template,
+            comment_text=comment_text,
+            pr_title=data['pullrequest']['title'],
+            status_text=status_text)
+
+        slack_data.title = title
+        slack_data.text = text
+        slack_data.fields = fields
+        slack_data.overrides = overrides
+
+        return slack_data
+
+    def format_pull_request_review_event(self, event, data, slack_data) -> SlackData:
+        template = Template(textwrap.dedent(r'''
+        *${data['actor']['username']}* changed status of pull request <${data['pullrequest']['url']}|#${data['pullrequest']['pull_request_id']} to `${data['pullrequest']['status']}`>:
+        '''))
+        title = render_with_traceback(template, data=data)
+
+        template = Template(textwrap.dedent(r'''
+        *pull request title*: ${pr_title}
+        '''))
+        text = render_with_traceback(
+            template,
+            pr_title=data['pullrequest']['title'])
+
+        slack_data.title = title
+        slack_data.text = text
+
+        return slack_data
+
+    def format_pull_request_event(self, event, data, slack_data) -> SlackData:
+        action = {
+            events.PullRequestCloseEvent: 'closed',
+            events.PullRequestMergeEvent: 'merged',
+            events.PullRequestUpdateEvent: 'updated',
+            events.PullRequestCreateEvent: 'created',
+        }.get(event.__class__, str(event.__class__))
+
+        template = Template(textwrap.dedent(r'''
+        *${data['actor']['username']}* `${action}` pull request <${data['pullrequest']['url']}|#${data['pullrequest']['pull_request_id']}>:
+        '''))
+        title = render_with_traceback(template, data=data, action=action)
+
+        template = Template(textwrap.dedent(r'''
+        *pull request title*: ${pr_title}
+        %if data['pullrequest']['commits']:
+        *commits*: ${len(data['pullrequest']['commits'])}
+        %endif
+        '''))
+        text = render_with_traceback(
+            template,
+            pr_title=data['pullrequest']['title'],
+            data=data)
+
+        slack_data.title = title
+        slack_data.text = text
+
+        return slack_data
+
+    def format_repo_push_event(self, event, data, slack_data) -> SlackData:
+        branches_commits = self.aggregate_branch_data(
+            data['push']['branches'], data['push']['commits'])
+
+        template = Template(r'''
+        *${data['actor']['username']}* pushed to repo <${data['repo']['url']}|${data['repo']['repo_name']}>:
+        ''')
+        title = render_with_traceback(template, data=data)
+
+        text = render_with_traceback(
+            REPO_PUSH_TEMPLATE,
+            data=data,
+            branches_commits=branches_commits,
+            html_to_slack_links=html_to_slack_links,
+        )
+
+        slack_data.title = title
+        slack_data.text = text
+
+        return slack_data
+
+    def format_repo_create_event(self, event, data, slack_data) -> SlackData:
+        template = Template(r'''
+        *${data['actor']['username']}* created new repository ${data['repo']['repo_name']}:
+        ''')
+        title = render_with_traceback(template, data=data)
+
+        template = Template(textwrap.dedent(r'''
+        repo_url: ${data['repo']['url']}
+        repo_type: ${data['repo']['repo_type']}
+        '''))
+        text = render_with_traceback(template, data=data)
+
+        slack_data.title = title
+        slack_data.text = text
+
+        return slack_data
  No newline at end of file

rhodecode/integrations/types/handlers/webhook.py

@@ -0,0 +1,175 b''
+# Copyright (C) 2012-2023 RhodeCode GmbH
+#
+# 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 logging
+
+from rhodecode import events
+from rhodecode.integrations.types.base import CommitParsingDataHandler, UrlTmpl
+
+
+log = logging.getLogger(__name__)
+
+
+class WebhookDataHandler(CommitParsingDataHandler):
+    name = 'webhook'
+
+    def __init__(self, template_url, headers):
+        self.template_url = template_url
+        self.headers = headers
+
+    def get_base_parsed_template(self, data):
+        """
+        initially parses the passed in template with some common variables
+        available on ALL calls
+        """
+        # note: make sure to update the `WEBHOOK_URL_VARS` if this changes
+        common_vars = {
+            'repo_name': data['repo']['repo_name'],
+            'repo_type': data['repo']['repo_type'],
+            'repo_id': data['repo']['repo_id'],
+            'repo_url': data['repo']['url'],
+            'username': data['actor']['username'],
+            'user_id': data['actor']['user_id'],
+            'event_name': data['name']
+        }
+
+        extra_vars = {}
+        for extra_key, extra_val in data['repo']['extra_fields'].items():
+            extra_vars[f'extra__{extra_key}'] = extra_val
+        common_vars.update(extra_vars)
+
+        template_url = self.template_url.replace('${extra:', '${extra__')
+        for k, v in common_vars.items():
+            template_url = UrlTmpl(template_url).safe_substitute(**{k: v})
+        return template_url
+
+    def repo_push_event_handler(self, event, data):
+        url = self.get_base_parsed_template(data)
+        url_calls = []
+
+        branches_commits = self.aggregate_branch_data(
+            data['push']['branches'], data['push']['commits'])
+        if '${branch}' in url or '${branch_head}' in url or '${commit_id}' in url:
+            # call it multiple times, for each branch if used in variables
+            for branch, commit_ids in branches_commits.items():
+                branch_url = UrlTmpl(url).safe_substitute(branch=branch)
+
+                if '${branch_head}' in branch_url:
+                    # last commit in the aggregate is the head of the branch
+                    branch_head = commit_ids['branch_head']
+                    branch_url = UrlTmpl(branch_url).safe_substitute(branch_head=branch_head)
+
+                # call further down for each commit if used
+                if '${commit_id}' in branch_url:
+                    for commit_data in commit_ids['commits']:
+                        commit_id = commit_data['raw_id']
+                        commit_url = UrlTmpl(branch_url).safe_substitute(commit_id=commit_id)
+                        # register per-commit call
+                        log.debug(
+                            'register %s call(%s) to url %s',
+                            self.name, event, commit_url)
+                        url_calls.append(
+                            (commit_url, self.headers, data))
+
+                else:
+                    # register per-branch call
+                    log.debug('register %s call(%s) to url %s',
+                              self.name, event, branch_url)
+                    url_calls.append((branch_url, self.headers, data))
+
+        else:
+            log.debug('register %s call(%s) to url %s', self.name, event, url)
+            url_calls.append((url, self.headers, data))
+
+        return url_calls
+
+    def repo_commit_comment_handler(self, event, data):
+        url = self.get_base_parsed_template(data)
+        log.debug('register %s call(%s) to url %s', self.name, event, url)
+        comment_vars = [
+            ('commit_comment_id', data['comment']['comment_id']),
+            ('commit_comment_text', data['comment']['comment_text']),
+            ('commit_comment_type', data['comment']['comment_type']),
+
+            ('commit_comment_f_path', data['comment']['comment_f_path']),
+            ('commit_comment_line_no', data['comment']['comment_line_no']),
+
+            ('commit_comment_commit_id', data['commit']['commit_id']),
+            ('commit_comment_commit_branch', data['commit']['commit_branch']),
+            ('commit_comment_commit_message', data['commit']['commit_message']),
+        ]
+        for k, v in comment_vars:
+            url = UrlTmpl(url).safe_substitute(**{k: v})
+
+        return [(url, self.headers, data)]
+
+    def repo_commit_comment_edit_handler(self, event, data):
+        url = self.get_base_parsed_template(data)
+        log.debug('register %s call(%s) to url %s', self.name, event, url)
+        comment_vars = [
+            ('commit_comment_id', data['comment']['comment_id']),
+            ('commit_comment_text', data['comment']['comment_text']),
+            ('commit_comment_type', data['comment']['comment_type']),
+
+            ('commit_comment_f_path', data['comment']['comment_f_path']),
+            ('commit_comment_line_no', data['comment']['comment_line_no']),
+
+            ('commit_comment_commit_id', data['commit']['commit_id']),
+            ('commit_comment_commit_branch', data['commit']['commit_branch']),
+            ('commit_comment_commit_message', data['commit']['commit_message']),
+        ]
+        for k, v in comment_vars:
+            url = UrlTmpl(url).safe_substitute(**{k: v})
+
+        return [(url, self.headers, data)]
+
+    def repo_create_event_handler(self, event, data):
+        url = self.get_base_parsed_template(data)
+        log.debug('register %s call(%s) to url %s', self.name, event, url)
+        return [(url, self.headers, data)]
+
+    def pull_request_event_handler(self, event, data):
+        url = self.get_base_parsed_template(data)
+        log.debug('register %s call(%s) to url %s', self.name, event, url)
+        pr_vars = [
+            ('pull_request_id', data['pullrequest']['pull_request_id']),
+            ('pull_request_title', data['pullrequest']['title']),
+            ('pull_request_url', data['pullrequest']['url']),
+            ('pull_request_shadow_url', data['pullrequest']['shadow_url']),
+            ('pull_request_commits_uid', data['pullrequest']['commits_uid']),
+        ]
+        for k, v in pr_vars:
+            url = UrlTmpl(url).safe_substitute(**{k: v})
+
+        return [(url, self.headers, data)]
+
+    def __call__(self, event, data):
+
+        if isinstance(event, events.RepoPushEvent):
+            return self.repo_push_event_handler(event, data)
+        elif isinstance(event, events.RepoCreateEvent):
+            return self.repo_create_event_handler(event, data)
+        elif isinstance(event, events.RepoCommitCommentEvent):
+            return self.repo_commit_comment_handler(event, data)
+        elif isinstance(event, events.RepoCommitCommentEditEvent):
+            return self.repo_commit_comment_edit_handler(event, data)
+        elif isinstance(event, events.PullRequestEvent):
+            return self.pull_request_event_handler(event, data)
+        else:
+            raise ValueError(
+                f'event type `{event.__class__}` has no handler defined')

rhodecode/events/__init__.py

@@ -1,85 +1,88 b''
 # Copyright (C) 2016-2023 RhodeCode GmbH
 #
 # 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 logging
 
-from rhodecode.events.base import RhodeCodeIntegrationEvent
+from rhodecode.events.base import (
+    RhodeCodeIntegrationEvent,
+    RhodecodeEvent
+)
 
 from rhodecode.events.base import (  # pragma: no cover
     FtsBuild
 )
 
 from rhodecode.events.user import (  # pragma: no cover
     UserPreCreate,
     UserPostCreate,
     UserPreUpdate,
     UserRegistered,
     UserPermissionsChange,
 )
 
 from rhodecode.events.repo import (  # pragma: no cover
     RepoEvent,
     RepoCommitCommentEvent, RepoCommitCommentEditEvent,
     RepoPreCreateEvent, RepoCreateEvent,
     RepoPreDeleteEvent, RepoDeleteEvent,
     RepoPrePushEvent,   RepoPushEvent,
     RepoPrePullEvent,   RepoPullEvent,
 )
 
 from rhodecode.events.repo_group import (  # pragma: no cover
     RepoGroupEvent,
     RepoGroupCreateEvent,
     RepoGroupUpdateEvent,
     RepoGroupDeleteEvent,
 )
 
 from rhodecode.events.pullrequest import (  # pragma: no cover
     PullRequestEvent,
     PullRequestCreateEvent,
     PullRequestUpdateEvent,
     PullRequestCommentEvent,
     PullRequestCommentEditEvent,
     PullRequestReviewEvent,
     PullRequestMergeEvent,
     PullRequestCloseEvent,
 )
 
 
 log = logging.getLogger(__name__)
 
 
 def trigger(event, registry=None):
     """
     Helper method to send an event. This wraps the pyramid logic to send an
     event.
     """
     # For the first step we are using pyramids thread locals here. If the
     # event mechanism works out as a good solution we should think about
     # passing the registry as an argument to get rid of it.
     from pyramid.threadlocal import get_current_registry
 
     event_name = event.__class__
     log.debug('event %s sent for execution', event_name)
     registry = registry or get_current_registry()
     registry.notify(event)
     log.debug('event %s triggered using registry %s', event_name, registry)
 
     # Send the events to integrations directly
     from rhodecode.integrations import integrations_event_handler
     if isinstance(event, RhodeCodeIntegrationEvent):
         integrations_event_handler(event)

rhodecode/events/base.py

@@ -1,130 +1,131 b''
 # Copyright (C) 2016-2023 RhodeCode GmbH
 #
 # 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 logging
 import datetime
+import typing
 
 from zope.cachedescriptors.property import Lazy as LazyProperty
 from pyramid.threadlocal import get_current_request
 
 from rhodecode.lib.utils2 import AttributeDict
 
 
 # this is a user object to be used for events caused by the system (eg. shell)
 SYSTEM_USER = AttributeDict(dict(
     username='__SYSTEM__',
     user_id='__SYSTEM_ID__'
 ))
 
 log = logging.getLogger(__name__)
 
 
 class RhodecodeEvent(object):
     """
     Base event class for all RhodeCode events
     """
     name = "RhodeCodeEvent"
     no_url_set = '<no server_url available>'
 
     def __init__(self, request=None):
         self._request = request
         self.utc_timestamp = datetime.datetime.utcnow()
 
     def __repr__(self):
         return '<{}:({})>'.format(self.__class__.__name__, self.name)
 
     def get_request(self):
         if self._request:
             return self._request
         return get_current_request()
 
     @LazyProperty
     def request(self):
         return self.get_request()
 
     @property
     def auth_user(self):
         if not self.request:
             return
 
         user = getattr(self.request, 'user', None)
         if user:
             return user
 
         api_user = getattr(self.request, 'rpc_user', None)
         if api_user:
             return api_user
 
     @property
     def actor(self):
         auth_user = self.auth_user
         if auth_user:
             instance = auth_user.get_instance()
             if not instance:
                 return AttributeDict(dict(
                     username=auth_user.username,
                     user_id=auth_user.user_id,
                 ))
             return instance
 
         return SYSTEM_USER
 
     @property
     def actor_ip(self):
         auth_user = self.auth_user
         if auth_user:
             return auth_user.ip_addr
         return '<no ip available>'
 
     @property
     def server_url(self):
         if self.request:
             try:
                 return self.request.route_url('home')
             except Exception:
                 log.exception('Failed to fetch URL for server')
                 return self.no_url_set
 
         return self.no_url_set
 
     def as_dict(self):
         data = {
             'name': self.name,
             'utc_timestamp': self.utc_timestamp,
             'actor_ip': self.actor_ip,
             'actor': {
                 'username': self.actor.username,
                 'user_id': self.actor.user_id
             },
             'server_url': self.server_url
         }
         return data
 
 
 class RhodeCodeIntegrationEvent(RhodecodeEvent):
     """
     Special subclass for Integration events
     """
     description = ''
 
 
 class FtsBuild(RhodecodeEvent):
     """
     This event will be triggered when FTS Build is triggered
     """
     name = 'fts-build'
     display_name = 'Start FTS Build'

rhodecode/integrations/__init__.py

@@ -1,72 +1,70 b''
 # Copyright (C) 2012-2023 RhodeCode GmbH
 #
 # 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 sys
 import logging
 
 from rhodecode.integrations.registry import IntegrationTypeRegistry
-from rhodecode.integrations.types import webhook, slack, hipchat, email, base
+from rhodecode.integrations.types import webhook, slack, email, base
 from rhodecode.lib.exc_tracking import store_exception
 
 log = logging.getLogger(__name__)
 
 
 # TODO: dan: This is currently global until we figure out what to do about
 # VCS's not having a pyramid context - move it to pyramid app configuration
 # includeme level later to allow per instance integration setup
 integration_type_registry = IntegrationTypeRegistry()
 
 integration_type_registry.register_integration_type(
     webhook.WebhookIntegrationType)
 integration_type_registry.register_integration_type(
     slack.SlackIntegrationType)
 integration_type_registry.register_integration_type(
-    hipchat.HipchatIntegrationType)
-integration_type_registry.register_integration_type(
     email.EmailIntegrationType)
 
 
 # dummy EE integration to show users what we have in EE edition
 integration_type_registry.register_integration_type(
     base.EEIntegration('Jira Issues integration', 'jira'))
 integration_type_registry.register_integration_type(
     base.EEIntegration('Redmine Tracker integration', 'redmine'))
 integration_type_registry.register_integration_type(
     base.EEIntegration('Jenkins CI integration', 'jenkins'))
 
 
 def integrations_event_handler(event):
     """
     Takes an event and passes it to all enabled integrations
     """
     from rhodecode.model.integration import IntegrationModel
 
     integration_model = IntegrationModel()
     integrations = integration_model.get_for_event(event)
     for integration in integrations:
         try:
             integration_model.send_event(integration, event)
         except Exception:
             exc_info = sys.exc_info()
             store_exception(id(exc_info), exc_info)
             log.exception(
                 'failure occurred when sending event %s to integration %s',
                 event, integration)
 
 
 def includeme(config):
     config.include('rhodecode.integrations.routes')

rhodecode/integrations/types/base.py

@@ -1,450 +1,300 b''
 # Copyright (C) 2012-2023 RhodeCode GmbH
 #
 # 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 colander
 import string
 import collections
 import logging
+
 import requests
 import urllib.request
 import urllib.parse
 import urllib.error
 from requests.adapters import HTTPAdapter
-from requests.packages.urllib3.util.retry import Retry
+from requests.packages.urllib3.util import Retry
 
 from mako import exceptions
 
-from rhodecode.lib.utils2 import safe_str
-from rhodecode.translation import _
+
+from rhodecode.lib.str_utils import safe_str
 
 
 log = logging.getLogger(__name__)
 
 
 class UrlTmpl(string.Template):
 
     def safe_substitute(self, **kws):
         # url encode the kw for usage in url
         kws = {k: urllib.parse.quote(safe_str(v)) for k, v in kws.items()}
         return super().safe_substitute(**kws)
 
 
 class IntegrationTypeBase(object):
     """ Base class for IntegrationType plugins """
     is_dummy = False
     description = ''
 
     @classmethod
     def icon(cls):
         return '''
         <?xml version="1.0" encoding="UTF-8" standalone="no"?>
         <svg
            xmlns:dc="http://purl.org/dc/elements/1.1/"
            xmlns:cc="http://creativecommons.org/ns#"
            xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
            xmlns:svg="http://www.w3.org/2000/svg"
            xmlns="http://www.w3.org/2000/svg"
            xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
            xmlns:inkscape="http://setwww.inkscape.org/namespaces/inkscape"
            viewBox="0 -256 1792 1792"
            id="svg3025"
            version="1.1"
            inkscape:version="0.48.3.1 r9886"
            width="100%"
            height="100%"
            sodipodi:docname="cog_font_awesome.svg">
           <metadata
              id="metadata3035">
             <rdf:RDF>
               <cc:Work
                  rdf:about="">
                 <dc:format>image/svg+xml</dc:format>
                 <dc:type
                    rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
               </cc:Work>
             </rdf:RDF>
           </metadata>
           <defs
              id="defs3033" />
           <sodipodi:namedview
              pagecolor="#ffffff"
              bordercolor="#666666"
              borderopacity="1"
              objecttolerance="10"
              gridtolerance="10"
              guidetolerance="10"
              inkscape:pageopacity="0"
              inkscape:pageshadow="2"
              inkscape:window-width="640"
              inkscape:window-height="480"
              id="namedview3031"
              showgrid="false"
              inkscape:zoom="0.13169643"
              inkscape:cx="896"
              inkscape:cy="896"
              inkscape:window-x="0"
              inkscape:window-y="25"
              inkscape:window-maximized="0"
              inkscape:current-layer="svg3025" />
           <g
              transform="matrix(1,0,0,-1,121.49153,1285.4237)"
              id="g3027">
             <path
                d="m 1024,640 q 0,106 -75,181 -75,75 -181,75 -106,0 -181,-75 -75,-75 -75,-181 0,-106 75,-181 75,-75 181,-75 106,0 181,75 75,75 75,181 z m 512,109 V 527 q 0,-12 -8,-23 -8,-11 -20,-13 l -185,-28 q -19,-54 -39,-91 35,-50 107,-138 10,-12 10,-25 0,-13 -9,-23 -27,-37 -99,-108 -72,-71 -94,-71 -12,0 -26,9 l -138,108 q -44,-23 -91,-38 -16,-136 -29,-186 -7,-28 -36,-28 H 657 q -14,0 -24.5,8.5 Q 622,-111 621,-98 L 593,86 q -49,16 -90,37 L 362,16 Q 352,7 337,7 323,7 312,18 186,132 147,186 q -7,10 -7,23 0,12 8,23 15,21 51,66.5 36,45.5 54,70.5 -27,50 -41,99 L 29,495 Q 16,497 8,507.5 0,518 0,531 v 222 q 0,12 8,23 8,11 19,13 l 186,28 q 14,46 39,92 -40,57 -107,138 -10,12 -10,24 0,10 9,23 26,36 98.5,107.5 72.5,71.5 94.5,71.5 13,0 26,-10 l 138,-107 q 44,23 91,38 16,136 29,186 7,28 36,28 h 222 q 14,0 24.5,-8.5 Q 914,1391 915,1378 l 28,-184 q 49,-16 90,-37 l 142,107 q 9,9 24,9 13,0 25,-10 129,-119 165,-170 7,-8 7,-22 0,-12 -8,-23 -15,-21 -51,-66.5 -36,-45.5 -54,-70.5 26,-50 41,-98 l 183,-28 q 13,-2 21,-12.5 8,-10.5 8,-23.5 z"
                id="path3029"
                inkscape:connector-curvature="0"
                style="fill:currentColor" />
           </g>
         </svg>
         '''
 
     def __init__(self, settings):
         """
         :param settings: dict of settings to be used for the integration
         """
         self.settings = settings
 
     def settings_schema(self):
         """
         A colander schema of settings for the integration type
         """
         return colander.Schema()
 
     def event_enabled(self, event):
         """
         Checks if submitted event is enabled based on the plugin settings
         :param event:
         :return: bool
         """
         allowed_events = self.settings.get('events') or []
         if event.name not in allowed_events:
             log.debug('event ignored: %r event %s not in allowed set of events %s',
                       event, event.name, allowed_events)
             return False
         return True
 
 
 class EEIntegration(IntegrationTypeBase):
     description = 'Integration available in RhodeCode EE edition.'
     is_dummy = True
 
     def __init__(self, name, key, settings=None):
         self.display_name = name
         self.key = key
         super(EEIntegration, self).__init__(settings)
 
 
 # Helpers #
 # updating this required to update the `common_vars` as well.
 WEBHOOK_URL_VARS = [
     # GENERAL
     ('General', [
         ('event_name', 'Unique name of the event type, e.g pullrequest-update'),
         ('repo_name', 'Full name of the repository'),
         ('repo_type', 'VCS type of repository'),
         ('repo_id', 'Unique id of repository'),
         ('repo_url', 'Repository url'),
         ]
     ),
     # extra repo fields
     ('Repository', [
         ('extra:<extra_key_name>', 'Extra repo variables, read from its settings.'),
         ]
     ),
     # special attrs below that we handle, using multi-call
     ('Commit push - Multicalls', [
         ('branch', 'Name of each branch submitted, if any.'),
         ('branch_head', 'Head ID of pushed branch (full sha of last commit), if any.'),
         ('commit_id', 'ID (full sha) of each commit submitted, if any.'),
         ]
     ),
     # pr events vars
     ('Pull request', [
         ('pull_request_id', 'Unique ID of the pull request.'),
         ('pull_request_title', 'Title of the pull request.'),
         ('pull_request_url', 'Pull request url.'),
         ('pull_request_shadow_url', 'Pull request shadow repo clone url.'),
         ('pull_request_commits_uid', 'Calculated UID of all commits inside the PR. '
                                      'Changes after PR update'),
         ]
     ),
     # commit comment event vars
     ('Commit comment', [
         ('commit_comment_id', 'Unique ID of the comment made on a commit.'),
         ('commit_comment_text', 'Text of commit comment.'),
         ('commit_comment_type', 'Type of comment, e.g note/todo.'),
 
         ('commit_comment_f_path', 'Optionally path of file for inline comments.'),
         ('commit_comment_line_no', 'Line number of the file: eg o10, or n200'),
 
         ('commit_comment_commit_id', 'Commit id that comment was left at.'),
         ('commit_comment_commit_branch', 'Commit branch that comment was left at'),
         ('commit_comment_commit_message', 'Commit message that comment was left at'),
         ]
     ),
     # user who triggers the call
     ('Caller', [
         ('username', 'User who triggered the call.'),
         ('user_id', 'User id who triggered the call.'),
         ]
     ),
 ]
 
 # common vars for url template used for CI plugins. Shared with webhook
 CI_URL_VARS = WEBHOOK_URL_VARS
 
 
 class CommitParsingDataHandler(object):
 
     def aggregate_branch_data(self, branches, commits):
         branch_data = collections.OrderedDict()
         for obj in branches:
             branch_data[obj['name']] = obj
 
         branches_commits = collections.OrderedDict()
         for commit in commits:
             if commit.get('git_ref_change'):
                 # special case for GIT that allows creating tags,
                 # deleting branches without associated commit
                 continue
             commit_branch = commit['branch']
 
             if commit_branch not in branches_commits:
                 _branch = branch_data[commit_branch] \
                     if commit_branch else commit_branch
                 branch_commits = {'branch': _branch,
                                   'branch_head': '',
                                   'commits': []}
                 branches_commits[commit_branch] = branch_commits
 
             branch_commits = branches_commits[commit_branch]
             branch_commits['commits'].append(commit)
             branch_commits['branch_head'] = commit['raw_id']
         return branches_commits
 
 
-class WebhookDataHandler(CommitParsingDataHandler):
-    name = 'webhook'
-
-    def __init__(self, template_url, headers):
-        self.template_url = template_url
-        self.headers = headers
-
-    def get_base_parsed_template(self, data):
-        """
-        initially parses the passed in template with some common variables
-        available on ALL calls
-        """
-        # note: make sure to update the `WEBHOOK_URL_VARS` if this changes
-        common_vars = {
-            'repo_name': data['repo']['repo_name'],
-            'repo_type': data['repo']['repo_type'],
-            'repo_id': data['repo']['repo_id'],
-            'repo_url': data['repo']['url'],
-            'username': data['actor']['username'],
-            'user_id': data['actor']['user_id'],
-            'event_name': data['name']
-        }
-
-        extra_vars = {}
-        for extra_key, extra_val in data['repo']['extra_fields'].items():
-            extra_vars[f'extra__{extra_key}'] = extra_val
-        common_vars.update(extra_vars)
-
-        template_url = self.template_url.replace('${extra:', '${extra__')
-        for k, v in common_vars.items():
-            template_url = UrlTmpl(template_url).safe_substitute(**{k: v})
-        return template_url
-
-    def repo_push_event_handler(self, event, data):
-        url = self.get_base_parsed_template(data)
-        url_calls = []
-
-        branches_commits = self.aggregate_branch_data(
-            data['push']['branches'], data['push']['commits'])
-        if '${branch}' in url or '${branch_head}' in url or '${commit_id}' in url:
-            # call it multiple times, for each branch if used in variables
-            for branch, commit_ids in branches_commits.items():
-                branch_url = UrlTmpl(url).safe_substitute(branch=branch)
-
-                if '${branch_head}' in branch_url:
-                    # last commit in the aggregate is the head of the branch
-                    branch_head = commit_ids['branch_head']
-                    branch_url = UrlTmpl(branch_url).safe_substitute(branch_head=branch_head)
-
-                # call further down for each commit if used
-                if '${commit_id}' in branch_url:
-                    for commit_data in commit_ids['commits']:
-                        commit_id = commit_data['raw_id']
-                        commit_url = UrlTmpl(branch_url).safe_substitute(commit_id=commit_id)
-                        # register per-commit call
-                        log.debug(
-                            'register %s call(%s) to url %s',
-                            self.name, event, commit_url)
-                        url_calls.append(
-                            (commit_url, self.headers, data))
-
-                else:
-                    # register per-branch call
-                    log.debug('register %s call(%s) to url %s',
-                              self.name, event, branch_url)
-                    url_calls.append((branch_url, self.headers, data))
-
-        else:
-            log.debug('register %s call(%s) to url %s', self.name, event, url)
-            url_calls.append((url, self.headers, data))
-
-        return url_calls
-
-    def repo_commit_comment_handler(self, event, data):
-        url = self.get_base_parsed_template(data)
-        log.debug('register %s call(%s) to url %s', self.name, event, url)
-        comment_vars = [
-            ('commit_comment_id', data['comment']['comment_id']),
-            ('commit_comment_text', data['comment']['comment_text']),
-            ('commit_comment_type', data['comment']['comment_type']),
-
-            ('commit_comment_f_path', data['comment']['comment_f_path']),
-            ('commit_comment_line_no', data['comment']['comment_line_no']),
-
-            ('commit_comment_commit_id', data['commit']['commit_id']),
-            ('commit_comment_commit_branch', data['commit']['commit_branch']),
-            ('commit_comment_commit_message', data['commit']['commit_message']),
-        ]
-        for k, v in comment_vars:
-            url = UrlTmpl(url).safe_substitute(**{k: v})
-
-        return [(url, self.headers, data)]
-
-    def repo_commit_comment_edit_handler(self, event, data):
-        url = self.get_base_parsed_template(data)
-        log.debug('register %s call(%s) to url %s', self.name, event, url)
-        comment_vars = [
-            ('commit_comment_id', data['comment']['comment_id']),
-            ('commit_comment_text', data['comment']['comment_text']),
-            ('commit_comment_type', data['comment']['comment_type']),
-
-            ('commit_comment_f_path', data['comment']['comment_f_path']),
-            ('commit_comment_line_no', data['comment']['comment_line_no']),
-
-            ('commit_comment_commit_id', data['commit']['commit_id']),
-            ('commit_comment_commit_branch', data['commit']['commit_branch']),
-            ('commit_comment_commit_message', data['commit']['commit_message']),
-        ]
-        for k, v in comment_vars:
-            url = UrlTmpl(url).safe_substitute(**{k: v})
-
-        return [(url, self.headers, data)]
-
-    def repo_create_event_handler(self, event, data):
-        url = self.get_base_parsed_template(data)
-        log.debug('register %s call(%s) to url %s', self.name, event, url)
-        return [(url, self.headers, data)]
-
-    def pull_request_event_handler(self, event, data):
-        url = self.get_base_parsed_template(data)
-        log.debug('register %s call(%s) to url %s', self.name, event, url)
-        pr_vars = [
-            ('pull_request_id', data['pullrequest']['pull_request_id']),
-            ('pull_request_title', data['pullrequest']['title']),
-            ('pull_request_url', data['pullrequest']['url']),
-            ('pull_request_shadow_url', data['pullrequest']['shadow_url']),
-            ('pull_request_commits_uid', data['pullrequest']['commits_uid']),
-        ]
-        for k, v in pr_vars:
-            url = UrlTmpl(url).safe_substitute(**{k: v})
-
-        return [(url, self.headers, data)]
-
-    def __call__(self, event, data):
-        from rhodecode import events
-
-        if isinstance(event, events.RepoPushEvent):
-            return self.repo_push_event_handler(event, data)
-        elif isinstance(event, events.RepoCreateEvent):
-            return self.repo_create_event_handler(event, data)
-        elif isinstance(event, events.RepoCommitCommentEvent):
-            return self.repo_commit_comment_handler(event, data)
-        elif isinstance(event, events.RepoCommitCommentEditEvent):
-            return self.repo_commit_comment_edit_handler(event, data)
-        elif isinstance(event, events.PullRequestEvent):
-            return self.pull_request_event_handler(event, data)
-        else:
-            raise ValueError(
-                f'event type `{event.__class__}` has no handler defined')
-
-
 def get_auth(settings):
     from requests.auth import HTTPBasicAuth
     username = settings.get('username')
     password = settings.get('password')
     if username and password:
         return HTTPBasicAuth(username, password)
     return None
 
 
 def get_web_token(settings):
     return settings['secret_token']
 
 
 def get_url_vars(url_vars):
     items = []
 
     for section, section_items in url_vars:
         items.append(f'\n*{section}*')
         for key, explanation in section_items:
             items.append('  {} - {}'.format('${' + key + '}', explanation))
     return '\n'.join(items)
 
 
 def render_with_traceback(template, *args, **kwargs):
     try:
         return template.render(*args, **kwargs)
     except Exception:
         log.error(exceptions.text_error_template().render())
         raise
 
 
 STATUS_400 = (400, 401, 403)
 STATUS_500 = (500, 502, 504)
 
 
 def requests_retry_call(
         retries=3, backoff_factor=0.3, status_forcelist=STATUS_400+STATUS_500,
         session=None):
     """
     session = requests_retry_session()
     response = session.get('http://example.com')
 
     :param retries:
     :param backoff_factor:
     :param status_forcelist:
     :param session:
     """
     session = session or requests.Session()
     retry = Retry(
         total=retries,
         read=retries,
         connect=retries,
         backoff_factor=backoff_factor,
         status_forcelist=status_forcelist,
     )
     adapter = HTTPAdapter(max_retries=retry)
     session.mount('http://', adapter)
     session.mount('https://', adapter)
     return session

rhodecode/integrations/types/slack.py

@@ -1,352 +1,185 b''
 # Copyright (C) 2012-2023 RhodeCode GmbH
 #
 # 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 re
+
 import time
-import textwrap
 import logging
 
-import deform
-import requests
+import deform # noqa
+import deform.widget
 import colander
-from mako.template import Template
 
 from rhodecode import events
 from rhodecode.model.validation_schema.widgets import CheckboxChoiceWidgetDesc
 from rhodecode.translation import _
 from rhodecode.lib import helpers as h
 from rhodecode.lib.celerylib import run_task, async_task, RequestContextTask
 from rhodecode.lib.colander_utils import strip_whitespace
 from rhodecode.integrations.types.base import (
-    IntegrationTypeBase, CommitParsingDataHandler, render_with_traceback,
-    requests_retry_call)
-
-log = logging.getLogger(__name__)
+    IntegrationTypeBase,
+    requests_retry_call,
+)
 
-
-def html_to_slack_links(message):
-    return re.compile(r'<a .*?href=["\'](.+?)".*?>(.+?)</a>').sub(
-        r'<\1|\2>', message)
+from rhodecode.integrations.types.handlers.slack import SlackDataHandler, SlackData
 
 
-REPO_PUSH_TEMPLATE = Template('''
-<%
-    def branch_text(branch):
-        if branch:
-            return 'on branch: <{}|{}>'.format(branch_commits['branch']['url'], branch_commits['branch']['name'])
-        else:
-            ## case for SVN no branch push...
-            return 'to trunk'
-%> \
-
-% for branch, branch_commits in branches_commits.items():
-${len(branch_commits['commits'])} ${'commit' if len(branch_commits['commits']) == 1 else 'commits'} ${branch_text(branch)}
-% for commit in branch_commits['commits']:
-`<${commit['url']}|${commit['short_id']}>` - ${commit['message_html']|html_to_slack_links}
-% endfor
-% endfor
-''')
+log = logging.getLogger(__name__)
 
 
 class SlackSettingsSchema(colander.Schema):
     service = colander.SchemaNode(
         colander.String(),
         title=_('Slack service URL'),
         description=h.literal(_(
             'This can be setup at the '
             '<a href="https://my.slack.com/services/new/incoming-webhook/">'
             'slack app manager</a>')),
         default='',
         preparer=strip_whitespace,
         validator=colander.url,
         widget=deform.widget.TextInputWidget(
             placeholder='https://hooks.slack.com/services/...',
         ),
     )
     username = colander.SchemaNode(
         colander.String(),
         title=_('Username'),
         description=_('Username to show notifications coming from.'),
         missing='Rhodecode',
         preparer=strip_whitespace,
         widget=deform.widget.TextInputWidget(
             placeholder='Rhodecode'
         ),
     )
     channel = colander.SchemaNode(
         colander.String(),
         title=_('Channel'),
         description=_('Channel to send notifications to.'),
         missing='',
         preparer=strip_whitespace,
         widget=deform.widget.TextInputWidget(
             placeholder='#general'
         ),
     )
     icon_emoji = colander.SchemaNode(
         colander.String(),
         title=_('Emoji'),
         description=_('Emoji to use eg. :studio_microphone:'),
         missing='',
         preparer=strip_whitespace,
         widget=deform.widget.TextInputWidget(
             placeholder=':studio_microphone:'
         ),
     )
 
 
-class SlackIntegrationType(IntegrationTypeBase, CommitParsingDataHandler):
+class SlackIntegrationType(IntegrationTypeBase):
     key = 'slack'
     display_name = _('Slack')
     description = _('Send events such as repo pushes and pull requests to '
                     'your slack channel.')
 
     @classmethod
     def icon(cls):
         return '''<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid"><g><path d="M165.963541,15.8384262 C162.07318,3.86308197 149.212328,-2.69009836 137.239082,1.20236066 C125.263738,5.09272131 118.710557,17.9535738 122.603016,29.9268197 L181.550164,211.292328 C185.597902,222.478689 197.682361,228.765377 209.282098,225.426885 C221.381246,221.943607 228.756984,209.093246 224.896,197.21023 C224.749115,196.756984 165.963541,15.8384262 165.963541,15.8384262" fill="#DFA22F"></path><path d="M74.6260984,45.515541 C70.7336393,33.5422951 57.8727869,26.9891148 45.899541,30.8794754 C33.9241967,34.7698361 27.3710164,47.6306885 31.2634754,59.6060328 L90.210623,240.971541 C94.2583607,252.157902 106.34282,258.44459 117.942557,255.104 C130.041705,251.62282 137.417443,238.772459 133.556459,226.887344 C133.409574,226.436197 74.6260984,45.515541 74.6260984,45.515541" fill="#3CB187"></path><path d="M240.161574,166.045377 C252.136918,162.155016 258.688,149.294164 254.797639,137.31882 C250.907279,125.345574 238.046426,118.792393 226.07318,122.682754 L44.7076721,181.632 C33.5213115,185.677639 27.234623,197.762098 30.5731148,209.361836 C34.0563934,221.460984 46.9067541,228.836721 58.7897705,224.975738 C59.2430164,224.828852 240.161574,166.045377 240.161574,166.045377" fill="#CE1E5B"></path><path d="M82.507541,217.270557 C94.312918,213.434754 109.528131,208.491016 125.855475,203.186361 C122.019672,191.380984 117.075934,176.163672 111.76918,159.83423 L68.4191475,173.924721 L82.507541,217.270557" fill="#392538"></path><path d="M173.847082,187.591344 C190.235279,182.267803 205.467279,177.31777 217.195016,173.507148 C213.359213,161.70177 208.413377,146.480262 203.106623,130.146623 L159.75659,144.237115 L173.847082,187.591344" fill="#BB242A"></path><path d="M210.484459,74.7058361 C222.457705,70.8154754 229.010885,57.954623 225.120525,45.9792787 C221.230164,34.0060328 208.369311,27.4528525 196.393967,31.3432131 L15.028459,90.292459 C3.84209836,94.3380984 -2.44459016,106.422557 0.896,118.022295 C4.37718033,130.121443 17.227541,137.49718 29.1126557,133.636197 C29.5638033,133.489311 210.484459,74.7058361 210.484459,74.7058361" fill="#72C5CD"></path><path d="M52.8220328,125.933115 C64.6274098,122.097311 79.8468197,117.151475 96.1762623,111.84682 C90.8527213,95.4565246 85.9026885,80.2245246 82.0920656,68.4946885 L38.731541,82.5872787 L52.8220328,125.933115" fill="#248C73"></path><path d="M144.159475,96.256 C160.551869,90.9303607 175.785967,85.9803279 187.515803,82.1676066 C182.190164,65.7752131 177.240131,50.5390164 173.42741,38.807082 L130.068984,52.8996721 L144.159475,96.256" fill="#62803A"></path></g></svg>'''
 
     valid_events = [
         events.PullRequestCloseEvent,
         events.PullRequestMergeEvent,
         events.PullRequestUpdateEvent,
         events.PullRequestCommentEvent,
         events.PullRequestReviewEvent,
         events.PullRequestCreateEvent,
         events.RepoPushEvent,
         events.RepoCreateEvent,
     ]
 
-    def send_event(self, event):
-        log.debug('handling event %s with integration %s', event.name, self)
-
-        if event.__class__ not in self.valid_events:
-            log.debug('event %r not present in valid event list (%s)', event, self.valid_events)
-            return
-
-        if not self.event_enabled(event):
-            return
-
-        data = event.as_dict()
-
-        # defaults
-        title = '*%s* caused a *%s* event' % (
-            data['actor']['username'], event.name)
-        text = '*%s* caused a *%s* event' % (
-            data['actor']['username'], event.name)
-        fields = None
-        overrides = None
-
-        if isinstance(event, events.PullRequestCommentEvent):
-            (title, text, fields, overrides) \
-                = self.format_pull_request_comment_event(event, data)
-        elif isinstance(event, events.PullRequestCommentEditEvent):
-            (title, text, fields, overrides) \
-                = self.format_pull_request_comment_event(event, data)
-        elif isinstance(event, events.PullRequestReviewEvent):
-            title, text = self.format_pull_request_review_event(event, data)
-        elif isinstance(event, events.PullRequestEvent):
-            title, text = self.format_pull_request_event(event, data)
-        elif isinstance(event, events.RepoPushEvent):
-            title, text = self.format_repo_push_event(data)
-        elif isinstance(event, events.RepoCreateEvent):
-            title, text = self.format_repo_create_event(data)
-        else:
-            log.error('unhandled event type: %r', event)
-
-        run_task(post_text_to_slack, self.settings, title, text, fields, overrides)
-
     def settings_schema(self):
         schema = SlackSettingsSchema()
         schema.add(colander.SchemaNode(
             colander.Set(),
             widget=CheckboxChoiceWidgetDesc(
                 values=sorted(
                     [(e.name, e.display_name, e.description) for e in self.valid_events]
                 ),
             ),
             description="List of events activated for this integration",
             name='events'
         ))
 
         return schema
 
-    def format_pull_request_comment_event(self, event, data):
-        comment_text = data['comment']['text']
-        if len(comment_text) > 200:
-            comment_text = '<{comment_url}|{comment_text}...>'.format(
-                comment_text=comment_text[:200],
-                comment_url=data['comment']['url'],
-            )
-
-        fields = None
-        overrides = None
-        status_text = None
-
-        if data['comment']['status']:
-            status_color = {
-                'approved': '#0ac878',
-                'rejected': '#e85e4d'}.get(data['comment']['status'])
-
-            if status_color:
-                overrides = {"color": status_color}
-
-            status_text = data['comment']['status']
+    def send_event(self, event):
+        log.debug('handling event %s with integration %s', event.name, self)
 
-        if data['comment']['file']:
-            fields = [
-                {
-                    "title": "file",
-                    "value": data['comment']['file']
-                },
-                {
-                    "title": "line",
-                    "value": data['comment']['line']
-                }
-            ]
-
-        template = Template(textwrap.dedent(r'''
-        *${data['actor']['username']}* left ${data['comment']['type']} on pull request <${data['pullrequest']['url']}|#${data['pullrequest']['pull_request_id']}>:
-        '''))
-        title = render_with_traceback(
-            template, data=data, comment=event.comment)
-
-        template = Template(textwrap.dedent(r'''
-        *pull request title*: ${pr_title}
-        % if status_text:
-        *submitted status*: `${status_text}`
-        % endif
-        >>> ${comment_text}
-        '''))
-        text = render_with_traceback(
-            template,
-            comment_text=comment_text,
-            pr_title=data['pullrequest']['title'],
-            status_text=status_text)
-
-        return title, text, fields, overrides
-
-    def format_pull_request_review_event(self, event, data):
-        template = Template(textwrap.dedent(r'''
-        *${data['actor']['username']}* changed status of pull request <${data['pullrequest']['url']}|#${data['pullrequest']['pull_request_id']} to `${data['pullrequest']['status']}`>:
-        '''))
-        title = render_with_traceback(template, data=data)
+        if event.__class__ not in self.valid_events:
+            log.debug('event %r not present in valid event list (%s)', event, self.valid_events)
+            return
 
-        template = Template(textwrap.dedent(r'''
-        *pull request title*: ${pr_title}
-        '''))
-        text = render_with_traceback(
-            template,
-            pr_title=data['pullrequest']['title'])
-
-        return title, text
+        if not self.event_enabled(event):
+            return
 
-    def format_pull_request_event(self, event, data):
-        action = {
-            events.PullRequestCloseEvent: 'closed',
-            events.PullRequestMergeEvent: 'merged',
-            events.PullRequestUpdateEvent: 'updated',
-            events.PullRequestCreateEvent: 'created',
-        }.get(event.__class__, str(event.__class__))
-
-        template = Template(textwrap.dedent(r'''
-        *${data['actor']['username']}* `${action}` pull request <${data['pullrequest']['url']}|#${data['pullrequest']['pull_request_id']}>:
-        '''))
-        title = render_with_traceback(template, data=data, action=action)
-
-        template = Template(textwrap.dedent(r'''
-        *pull request title*: ${pr_title}
-        %if data['pullrequest']['commits']:
-        *commits*: ${len(data['pullrequest']['commits'])}
-        %endif
-        '''))
-        text = render_with_traceback(
-            template,
-            pr_title=data['pullrequest']['title'],
-            data=data)
+        data = event.as_dict()
 
-        return title, text
-
-    def format_repo_push_event(self, data):
-        branches_commits = self.aggregate_branch_data(
-            data['push']['branches'], data['push']['commits'])
-
-        template = Template(r'''
-        *${data['actor']['username']}* pushed to repo <${data['repo']['url']}|${data['repo']['repo_name']}>:
-        ''')
-        title = render_with_traceback(template, data=data)
-
-        text = render_with_traceback(
-            REPO_PUSH_TEMPLATE,
-            data=data,
-            branches_commits=branches_commits,
-            html_to_slack_links=html_to_slack_links,
-        )
-
-        return title, text
-
-    def format_repo_create_event(self, data):
-        template = Template(r'''
-        *${data['actor']['username']}* created new repository ${data['repo']['repo_name']}:
-        ''')
-        title = render_with_traceback(template, data=data)
-
-        template = Template(textwrap.dedent(r'''
-        repo_url: ${data['repo']['url']}
-        repo_type: ${data['repo']['repo_type']}
-        '''))
-        text = render_with_traceback(template, data=data)
-
-        return title, text
+        handler = SlackDataHandler()
+        slack_data = handler(event, data)
+        # title, text, fields, overrides
+        run_task(post_text_to_slack, self.settings, slack_data)
 
 
 @async_task(ignore_result=True, base=RequestContextTask)
-def post_text_to_slack(settings, title, text, fields=None, overrides=None):
+def post_text_to_slack(settings, slack_data: SlackData):
+    title = slack_data.title
+    text = slack_data.text
+    fields = slack_data.fields
+    overrides = slack_data.overrides
+
     log.debug('sending %s (%s) to slack %s', title, text, settings['service'])
 
     fields = fields or []
     overrides = overrides or {}
 
     message_data = {
                 "fallback": text,
                 "color": "#427cc9",
                 "pretext": title,
                 #"author_name": "Bobby Tables",
                 #"author_link": "http://flickr.com/bobby/",
                 #"author_icon": "http://flickr.com/icons/bobby.jpg",
                 #"title": "Slack API Documentation",
                 #"title_link": "https://api.slack.com/",
                 "text": text,
                 "fields": fields,
                 #"image_url": "http://my-website.com/path/to/image.jpg",
                 #"thumb_url": "http://example.com/path/to/thumb.png",
                 "footer": "RhodeCode",
                 #"footer_icon": "",
                 "ts": time.time(),
                 "mrkdwn_in": ["pretext", "text"]
     }
     message_data.update(overrides)
     json_message = {
         "icon_emoji": settings.get('icon_emoji', ':studio_microphone:'),
         "channel": settings.get('channel', ''),
         "username": settings.get('username', 'Rhodecode'),
         "attachments": [message_data]
     }
     req_session = requests_retry_call()
     resp = req_session.post(settings['service'], json=json_message, timeout=60)
     resp.raise_for_status()  # raise exception on a failed request

rhodecode/integrations/types/webhook.py

@@ -1,264 +1,270 b''
 # Copyright (C) 2012-2023 RhodeCode GmbH
 #
 # 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 deform # noqa
 import deform.widget
 import logging
 import colander
 
 import rhodecode
 from rhodecode import events
 from rhodecode.lib.colander_utils import strip_whitespace
 from rhodecode.model.validation_schema.widgets import CheckboxChoiceWidgetDesc
 from rhodecode.translation import _
 from rhodecode.integrations.types.base import (
-    IntegrationTypeBase, get_auth, get_web_token, get_url_vars,
-    WebhookDataHandler, WEBHOOK_URL_VARS, requests_retry_call)
+    IntegrationTypeBase,
+    get_auth,
+    get_web_token,
+    get_url_vars,
+    WEBHOOK_URL_VARS,
+    requests_retry_call,
+)
+from rhodecode.integrations.types.handlers.webhook import WebhookDataHandler
 from rhodecode.lib.celerylib import run_task, async_task, RequestContextTask
 from rhodecode.model.validation_schema import widgets
 
 log = logging.getLogger(__name__)
 
 
 # updating this required to update the `common_vars` passed in url calling func
 
 URL_VARS = get_url_vars(WEBHOOK_URL_VARS)
 
 
 class WebhookSettingsSchema(colander.Schema):
     url = colander.SchemaNode(
         colander.String(),
         title=_('Webhook URL'),
         description=
             _('URL to which Webhook should submit data. If used some of the '
               'variables would trigger multiple calls, like ${branch} or '
               '${commit_id}. Webhook will be called as many times as unique '
               'objects in data in such cases.'),
         missing=colander.required,
         required=True,
         preparer=strip_whitespace,
         validator=colander.url,
         widget=widgets.CodeMirrorWidget(
             help_block_collapsable_name='Show url variables',
             help_block_collapsable=(
-                'E.g http://my-serv.com/trigger_job/${{event_name}}'
+                'E.g https://my-serv.com/trigger_job/${{event_name}}'
                 '?PR_ID=${{pull_request_id}}'
                 '\nFull list of vars:\n{}'.format(URL_VARS)),
             codemirror_mode='text',
             codemirror_options='{"lineNumbers": false, "lineWrapping": true}'),
     )
     secret_token = colander.SchemaNode(
         colander.String(),
         title=_('Secret Token'),
         description=_('Optional string used to validate received payloads. '
                       'It will be sent together with event data in JSON'),
         default='',
         missing='',
         widget=deform.widget.TextInputWidget(
             placeholder='e.g. secret_token'
         ),
     )
     username = colander.SchemaNode(
         colander.String(),
         title=_('Username'),
         description=_('Optional username to authenticate the call.'),
         default='',
         missing='',
         widget=deform.widget.TextInputWidget(
             placeholder='e.g. admin'
         ),
     )
     password = colander.SchemaNode(
         colander.String(),
         title=_('Password'),
         description=_('Optional password to authenticate the call.'),
         default='',
         missing='',
         widget=deform.widget.PasswordWidget(
             placeholder='e.g. secret.',
             redisplay=True,
         ),
     )
     custom_header_key = colander.SchemaNode(
         colander.String(),
         title=_('Custom Header Key'),
         description=_('Custom Header name to be set when calling endpoint.'),
         default='',
         missing='',
         widget=deform.widget.TextInputWidget(
             placeholder='e.g: Authorization'
         ),
     )
     custom_header_val = colander.SchemaNode(
         colander.String(),
         title=_('Custom Header Value'),
         description=_('Custom Header value to be set when calling endpoint.'),
         default='',
         missing='',
         widget=deform.widget.TextInputWidget(
             placeholder='e.g. Basic XxXxXx'
         ),
     )
     method_type = colander.SchemaNode(
         colander.String(),
         title=_('Call Method'),
         description=_('Select a HTTP method to use when calling the Webhook.'),
         default='post',
         missing='',
         widget=deform.widget.RadioChoiceWidget(
             values=[('get', 'GET'), ('post', 'POST'), ('put', 'PUT')],
             inline=True
         ),
     )
 
 
 class WebhookIntegrationType(IntegrationTypeBase):
     key = 'webhook'
     display_name = _('Webhook')
     description = _('send JSON data to a url endpoint')
 
     @classmethod
     def icon(cls):
         return '''<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg viewBox="0 0 256 239" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid"><g><path d="M119.540432,100.502743 C108.930124,118.338815 98.7646301,135.611455 88.3876025,152.753617 C85.7226696,157.154315 84.4040417,160.738531 86.5332204,166.333309 C92.4107024,181.787152 84.1193605,196.825836 68.5350381,200.908244 C53.8383677,204.759349 39.5192953,195.099955 36.6032893,179.365384 C34.0194114,165.437749 44.8274148,151.78491 60.1824106,149.608284 C61.4694072,149.424428 62.7821041,149.402681 64.944891,149.240571 C72.469175,136.623655 80.1773157,123.700312 88.3025935,110.073173 C73.611854,95.4654658 64.8677898,78.3885437 66.803227,57.2292132 C68.1712787,42.2715849 74.0527146,29.3462646 84.8033863,18.7517722 C105.393354,-1.53572199 136.805164,-4.82141828 161.048542,10.7510424 C184.333097,25.7086706 194.996783,54.8450075 185.906752,79.7822957 C179.052655,77.9239597 172.151111,76.049808 164.563565,73.9917997 C167.418285,60.1274266 165.306899,47.6765751 155.95591,37.0109123 C149.777932,29.9690049 141.850349,26.2780332 132.835442,24.9178894 C114.764113,22.1877169 97.0209573,33.7983633 91.7563309,51.5355878 C85.7800012,71.6669027 94.8245623,88.1111998 119.540432,100.502743 L119.540432,100.502743 Z" fill="#C73A63"></path><path d="M149.841194,79.4106285 C157.316054,92.5969067 164.905578,105.982857 172.427885,119.246236 C210.44865,107.483365 239.114472,128.530009 249.398582,151.063322 C261.81978,178.282014 253.328765,210.520191 228.933162,227.312431 C203.893073,244.551464 172.226236,241.605803 150.040866,219.46195 C155.694953,214.729124 161.376716,209.974552 167.44794,204.895759 C189.360489,219.088306 208.525074,218.420096 222.753207,201.614016 C234.885769,187.277151 234.622834,165.900356 222.138374,151.863988 C207.730339,135.66681 188.431321,135.172572 165.103273,150.721309 C155.426087,133.553447 145.58086,116.521995 136.210101,99.2295848 C133.05093,93.4015266 129.561608,90.0209366 122.440622,88.7873178 C110.547271,86.7253555 102.868785,76.5124151 102.408155,65.0698097 C101.955433,53.7537294 108.621719,43.5249733 119.04224,39.5394355 C129.363912,35.5914599 141.476705,38.7783085 148.419765,47.554004 C154.093621,54.7244134 155.896602,62.7943365 152.911402,71.6372484 C152.081082,74.1025091 151.00562,76.4886916 149.841194,79.4106285 L149.841194,79.4106285 Z" fill="#4B4B4B"></path><path d="M167.706921,187.209935 L121.936499,187.209935 C117.54964,205.253587 108.074103,219.821756 91.7464461,229.085759 C79.0544063,236.285822 65.3738898,238.72736 50.8136292,236.376762 C24.0061432,232.053165 2.08568567,207.920497 0.156179306,180.745298 C-2.02835403,149.962159 19.1309765,122.599149 47.3341915,116.452801 C49.2814904,123.524363 51.2485589,130.663141 53.1958579,137.716911 C27.3195169,150.919004 18.3639187,167.553089 25.6054984,188.352614 C31.9811726,206.657224 50.0900643,216.690262 69.7528413,212.809503 C89.8327554,208.847688 99.9567329,192.160226 98.7211371,165.37844 C117.75722,165.37844 136.809118,165.180745 155.847178,165.475311 C163.280522,165.591951 169.019617,164.820939 174.620326,158.267339 C183.840836,147.48306 200.811003,148.455721 210.741239,158.640984 C220.88894,169.049642 220.402609,185.79839 209.663799,195.768166 C199.302587,205.38802 182.933414,204.874012 173.240413,194.508846 C171.247644,192.37176 169.677943,189.835329 167.706921,187.209935 L167.706921,187.209935 Z" fill="#4A4A4A"></path></g></svg>'''
 
     valid_events = [
         events.PullRequestCloseEvent,
         events.PullRequestMergeEvent,
         events.PullRequestUpdateEvent,
         events.PullRequestCommentEvent,
         events.PullRequestCommentEditEvent,
         events.PullRequestReviewEvent,
         events.PullRequestCreateEvent,
         events.RepoPushEvent,
         events.RepoCreateEvent,
         events.RepoCommitCommentEvent,
         events.RepoCommitCommentEditEvent,
     ]
 
     def settings_schema(self):
         schema = WebhookSettingsSchema()
         schema.add(colander.SchemaNode(
             colander.Set(),
             widget=CheckboxChoiceWidgetDesc(
                 values=sorted(
                     [(e.name, e.display_name, e.description) for e in self.valid_events]
                 ),
             ),
             description="List of events activated for this integration",
             name='events'
         ))
         return schema
 
     def send_event(self, event):
         log.debug('handling event %s with integration %s', event.name, self)
 
         if event.__class__ not in self.valid_events:
             log.debug('event %r not present in valid event list (%s)', event, self.valid_events)
             return
 
         if not self.event_enabled(event):
             return
 
         data = event.as_dict()
         template_url = self.settings['url']
 
         headers = {}
         head_key = self.settings.get('custom_header_key')
         head_val = self.settings.get('custom_header_val')
         if head_key and head_val:
             headers = {head_key: head_val}
 
         handler = WebhookDataHandler(template_url, headers)
 
         url_calls = handler(event, data)
         log.debug('Webhook: calling following urls: %s', [x[0] for x in url_calls])
 
-        run_task(post_to_webhook, url_calls, self.settings)
+        run_task(post_to_webhook, self.settings, url_calls)
 
 
 @async_task(ignore_result=True, base=RequestContextTask)
-def post_to_webhook(url_calls, settings):
+def post_to_webhook(settings, url_calls):
     """
     Example data::
 
         {'actor': {'user_id': 2, 'username': u'admin'},
          'actor_ip': u'192.168.157.1',
          'name': 'repo-push',
          'push': {'branches': [{'name': u'default',
                                 'url': 'http://rc.local:8080/hg-repo/changelog?branch=default'}],
                   'commits': [{'author': u'Marcin Kuzminski <[e-mail]>',
                                'branch': u'default',
                                'date': datetime.datetime(2017, 11, 30, 12, 59, 48),
                                'issues': [],
                                'mentions': [],
                                'message': u'commit Thu 30 Nov 2017 13:59:48 CET',
                                'message_html': u'commit Thu 30 Nov 2017 13:59:48 CET',
                                'message_html_title': u'commit Thu 30 Nov 2017 13:59:48 CET',
                                'parents': [{'raw_id': '431b772a5353dad9974b810dd3707d79e3a7f6e0'}],
                                'permalink_url': u'http://rc.local:8080/_7/changeset/a815cc738b9651eb5ffbcfb1ce6ccd7c701a5ddf',
                                'raw_id': 'a815cc738b9651eb5ffbcfb1ce6ccd7c701a5ddf',
                                'refs': {'bookmarks': [],
                                         'branches': [u'default'],
                                         'tags': [u'tip']},
                                'reviewers': [],
                                'revision': 9L,
                                'short_id': 'a815cc738b96',
                                'url': u'http://rc.local:8080/hg-repo/changeset/a815cc738b9651eb5ffbcfb1ce6ccd7c701a5ddf'}],
                   'issues': {}},
          'repo': {'extra_fields': '',
                   'permalink_url': u'http://rc.local:8080/_7',
                   'repo_id': 7,
                   'repo_name': u'hg-repo',
                   'repo_type': u'hg',
                   'url': u'http://rc.local:8080/hg-repo'},
          'server_url': u'http://rc.local:8080',
          'utc_timestamp': datetime.datetime(2017, 11, 30, 13, 0, 1, 569276)
          }
     """
 
     call_headers = {
         'User-Agent': f'RhodeCode-webhook-caller/{rhodecode.__version__}'
     }  # updated below with custom ones, allows override
 
     auth = get_auth(settings)
     token = get_web_token(settings)
 
     for url, headers, data in url_calls:
         req_session = requests_retry_call()
 
         method = settings.get('method_type') or 'post'
         call_method = getattr(req_session, method)
 
         headers = headers or {}
         call_headers.update(headers)
 
         log.debug('calling Webhook with method: %s, and auth:%s', call_method, auth)
         if settings.get('log_data'):
             log.debug('calling webhook with data: %s', data)
         resp = call_method(url, json={
             'token': token,
             'event': data
         }, headers=call_headers, auth=auth, timeout=60)
         log.debug('Got Webhook response: %s', resp)
 
         try:
             resp.raise_for_status()  # raise exception on a failed request
         except Exception:
             log.error(resp.text)
             raise

rhodecode/tests/integrations/conftest.py

@@ -1,54 +1,58 b''
 
 # Copyright (C) 2010-2023 RhodeCode GmbH
 #
 # 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 pytest
 from rhodecode import events
 from rhodecode.lib.utils2 import AttributeDict
 
 
 @pytest.fixture()
 def repo_push_event(backend, user_regular):
     commits = [
         {'message': 'ancestor commit fixes #15'},
         {'message': 'quick fixes'},
         {'message': 'change that fixes #41, #2'},
         {'message': 'this is because 5b23c3532 broke stuff'},
         {'message': 'last commit'},
     ]
-    commit_ids = backend.create_master_repo(commits).values()
-    repo = backend.create_repo()
+    r = backend.create_repo(commits)
+
+    commit_ids = list(backend.commit_ids.values())
+    repo_name = backend.repo_name
+    alias = backend.alias
+
     scm_extras = AttributeDict({
         'ip': '127.0.0.1',
         'username': user_regular.username,
         'user_id': user_regular.user_id,
         'action': '',
-        'repository': repo.repo_name,
-        'scm': repo.scm_instance().alias,
+        'repository': repo_name,
+        'scm': alias,
         'config': '',
         'repo_store': '',
-        'server_url': 'http://example.com',
+        'server_url': 'http://httpbin:9090',
         'make_lock': None,
         'locked_by': [None],
         'commit_ids': commit_ids,
     })
 
-    return events.RepoPushEvent(repo_name=repo.repo_name,
+    return events.RepoPushEvent(repo_name=repo_name,
                                 pushed_commit_ids=commit_ids,
                                 extras=scm_extras)

rhodecode/tests/integrations/test_integration.py

@@ -1,224 +1,223 b''
-
 # Copyright (C) 2010-2023 RhodeCode GmbH
 #
 # 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 time
 import pytest
 
 from rhodecode import events
 from rhodecode.tests.fixture import Fixture
 from rhodecode.model.db import Session, Integration
 from rhodecode.model.integration import IntegrationModel
 
 
 class TestDeleteScopesDeletesIntegrations(object):
     def test_delete_repo_with_integration_deletes_integration(
             self, repo_integration_stub):
 
         Session().delete(repo_integration_stub.repo)
         Session().commit()
         Session().expire_all()
         integration = Integration.get(repo_integration_stub.integration_id)
         assert integration is None
 
     def test_delete_repo_group_with_integration_deletes_integration(
             self, repogroup_integration_stub):
 
         Session().delete(repogroup_integration_stub.repo_group)
         Session().commit()
         Session().expire_all()
         integration = Integration.get(repogroup_integration_stub.integration_id)
         assert integration is None
 
 
 count = 1
 
 
 def counter():
     global count
     val = count
     count += 1
     return '{}_{}'.format(val, time.time())
 
 
 @pytest.fixture()
 def integration_repos(request, StubIntegrationType, stub_integration_settings):
     """
     Create repositories and integrations for testing, and destroy them after
 
     Structure:
         root_repo
         parent_group/
             parent_repo
             child_group/
                 child_repo
         other_group/
             other_repo
     """
     fixture = Fixture()
 
     parent_group_id = 'int_test_parent_group_{}'.format(counter())
     parent_group = fixture.create_repo_group(parent_group_id)
 
     other_group_id = 'int_test_other_group_{}'.format(counter())
     other_group = fixture.create_repo_group(other_group_id)
 
     child_group_id = (
         parent_group_id + '/' + 'int_test_child_group_{}'.format(counter()))
     child_group = fixture.create_repo_group(child_group_id)
 
     parent_repo_id = 'int_test_parent_repo_{}'.format(counter())
     parent_repo = fixture.create_repo(parent_repo_id, repo_group=parent_group)
 
     child_repo_id = 'int_test_child_repo_{}'.format(counter())
     child_repo = fixture.create_repo(child_repo_id, repo_group=child_group)
 
     other_repo_id = 'int_test_other_repo_{}'.format(counter())
     other_repo = fixture.create_repo(other_repo_id, repo_group=other_group)
 
     root_repo_id = 'int_test_repo_root_{}'.format(counter())
     root_repo = fixture.create_repo(root_repo_id)
 
     integrations = {}
     for name, repo, repo_group, child_repos_only in [
             ('global', None, None, None),
             ('root_repos', None, None, True),
             ('parent_repo', parent_repo, None, None),
             ('child_repo', child_repo, None, None),
             ('other_repo', other_repo, None, None),
             ('root_repo', root_repo, None, None),
             ('parent_group', None, parent_group, True),
             ('parent_group_recursive', None, parent_group, False),
             ('child_group', None, child_group, True),
             ('child_group_recursive', None, child_group, False),
             ('other_group', None, other_group, True),
             ('other_group_recursive', None, other_group, False),
         ]:
         integrations[name] = IntegrationModel().create(
             StubIntegrationType, settings=stub_integration_settings,
             enabled=True, name='test %s integration' % name,
             repo=repo, repo_group=repo_group, child_repos_only=child_repos_only)
 
     Session().commit()
 
     def _cleanup():
         for integration in integrations.values():
             Session.delete(integration)
 
         fixture.destroy_repo(root_repo)
         fixture.destroy_repo(child_repo)
         fixture.destroy_repo(parent_repo)
         fixture.destroy_repo(other_repo)
         fixture.destroy_repo_group(child_group)
         fixture.destroy_repo_group(parent_group)
         fixture.destroy_repo_group(other_group)
 
     request.addfinalizer(_cleanup)
 
     return {
         'integrations': integrations,
         'repos': {
             'root_repo': root_repo,
             'other_repo': other_repo,
             'parent_repo': parent_repo,
             'child_repo': child_repo,
         }
     }
 
 
 def test_enabled_integration_repo_scopes(integration_repos):
     integrations = integration_repos['integrations']
     repos = integration_repos['repos']
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['root_repo']))
 
     assert triggered_integrations == [
         integrations['global'],
         integrations['root_repos'],
         integrations['root_repo'],
     ]
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['other_repo']))
 
     assert triggered_integrations == [
         integrations['global'],
         integrations['other_group'],
         integrations['other_group_recursive'],
         integrations['other_repo'],
     ]
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['parent_repo']))
 
     assert triggered_integrations == [
         integrations['global'],
         integrations['parent_group'],
         integrations['parent_group_recursive'],
         integrations['parent_repo'],
     ]
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['child_repo']))
 
     assert triggered_integrations == [
         integrations['global'],
         integrations['child_group'],
         integrations['parent_group_recursive'],
         integrations['child_group_recursive'],
         integrations['child_repo'],
     ]
 
 
 def test_disabled_integration_repo_scopes(integration_repos):
     integrations = integration_repos['integrations']
     repos = integration_repos['repos']
 
     for integration in integrations.values():
         integration.enabled = False
     Session().commit()
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['root_repo']))
 
     assert triggered_integrations == []
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['parent_repo']))
 
     assert triggered_integrations == []
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['child_repo']))
 
     assert triggered_integrations == []
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.RepoEvent(repos['other_repo']))
 
     assert triggered_integrations == []
 
 
 def test_enabled_non_repo_integrations(integration_repos):
     integrations = integration_repos['integrations']
 
     triggered_integrations = IntegrationModel().get_for_event(
         events.UserPreCreate({}))
 
     assert triggered_integrations == [integrations['global']]

rhodecode/tests/integrations/test_slack.py

@@ -1,65 +1,148 b''
-
 # Copyright (C) 2010-2023 RhodeCode GmbH
 #
 # 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 pytest
+import mock
 from mock import patch
 
 from rhodecode import events
+from rhodecode.integrations.types.handlers.slack import SlackDataHandler
 from rhodecode.model.db import Session, Integration
 from rhodecode.integrations.types.slack import SlackIntegrationType
+from rhodecode.tests import GIT_REPO
+
+
[e-mail]()
+def base_slack_data():
+    return {
+        "pullrequest": {
+            "url": "https://example.com/pr1",
+            "pull_request_id": "1",
+            "title": "started pr",
+            "status": "new",
+            "commits": ["1", "2"],
+            "shadow_url": "http://shadow-url",
+        },
+        "actor": {"username": "foo-user"},
+        "comment": {
+            "comment_id": 1,
+            "text": "test-comment",
+            "status": "approved",
+            "file": "text.py",
+            "line": "1",
+            "type": "note",
+        },
+        "push": {"branches": "", "commits": []},
+        "repo": {
+            "url": "https://example.com/repo1",
+            "repo_name": GIT_REPO,
+            "repo_type": "git",
+        },
+    }
 
 
 @pytest.fixture()
 def slack_settings():
     return {
         "service": "mock://slackintegration",
         "events": [
            "pullrequest-create",
            "repo-push",
         ],
         "channel": "#testing",
         "icon_emoji": ":recycle:",
         "username": "rhodecode-test"
     }
 
 
 @pytest.fixture()
 def slack_integration(request, app, slack_settings):
     integration = Integration()
     integration.name = 'test slack integration'
     integration.enabled = True
     integration.integration_type = SlackIntegrationType.key
     integration.settings = slack_settings
     Session().add(integration)
     Session().commit()
     request.addfinalizer(lambda: Session().delete(integration))
     return integration
 
 
[e-mail]()
+def slack_integration_empty(request, app, slack_settings):
+    slack_settings['events'] = []
+    integration = Integration()
+    integration.name = 'test slack integration'
+    integration.enabled = True
+    integration.integration_type = SlackIntegrationType.key
+    integration.settings = slack_settings
+    Session().add(integration)
+    Session().commit()
+    request.addfinalizer(lambda: Session().delete(integration))
+    return integration
+
+
 def test_slack_push(slack_integration, repo_push_event):
+
     with patch('rhodecode.integrations.types.slack.post_text_to_slack') as call:
         events.trigger(repo_push_event)
-    assert 'pushed to' in call.call_args[0][1]
+
+    assert 'pushed to' in call.call_args[0][1].title
+    # specific commit was parsed and serialized
+    assert 'change that fixes #41' in call.call_args[0][1].text
 
-    slack_integration.settings['events'] = []
-    Session().commit()
+
+def test_slack_push_no_events(slack_integration_empty, repo_push_event):
+
+    assert Integration.get(slack_integration_empty.integration_id).settings['events'] == []
 
     with patch('rhodecode.integrations.types.slack.post_text_to_slack') as call:
         events.trigger(repo_push_event)
     assert not call.call_args
+
+
+def test_slack_data_handler_wrong_event():
+    handler = SlackDataHandler()
+    data = {"actor": {"username": "foo-user"}}
+    with pytest.raises(ValueError):
+        handler(events.RhodecodeEvent(), data)
+
+
[e-mail]("event_type, args", [
+    (
+        events.PullRequestCommentEvent,
+        (mock.MagicMock(name="pull-request"), mock.MagicMock(name="comment")),
+    ),
+    (
+        events.PullRequestCommentEditEvent,
+        (mock.MagicMock(name="pull-request"), mock.MagicMock(name="comment")),
+    ),
+    (
+        events.PullRequestReviewEvent,
+        (mock.MagicMock(name="pull-request"), mock.MagicMock(name="status")),
+    ),
+    (
+        events.RepoPushEvent,
+        (GIT_REPO, mock.MagicMock(name="pushed_commit_ids"), mock.MagicMock(name="extras")),
+    ),
+    (events.PullRequestEvent, (mock.MagicMock(), )),
+    (events.RepoCreateEvent, (mock.MagicMock(), )),
+])
+def test_slack_data_handler(app, event_type: events.RhodecodeEvent, args, base_slack_data):
+    handler = SlackDataHandler()
+    handler(event_type(*args), base_slack_data)

rhodecode/tests/integrations/test_webhook.py

@@ -1,133 +1,196 b''
 
 # Copyright (C) 2010-2023 RhodeCode GmbH
 #
 # 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 pytest
+import mock
+from mock import patch
 
 from rhodecode import events
 from rhodecode.lib.utils2 import AttributeDict
 from rhodecode.integrations.types.webhook import WebhookDataHandler
+from rhodecode.tests import GIT_REPO
 
 
 @pytest.fixture()
 def base_data():
     return {
         'name': 'event',
         'repo': {
             'repo_name': 'foo',
             'repo_type': 'hg',
             'repo_id': '12',
             'url': 'http://repo.url/foo',
             'extra_fields': {},
         },
         'actor': {
             'username': 'actor_name',
             'user_id': 1
-        }
+        },
+        "pullrequest": {
+            "url": "https://example.com/pr1",
+            "pull_request_id": "1",
+            "title": "started pr",
+            "status": "new",
+            "commits_uid": ["1", "2"],
+            "shadow_url": "http://shadow-url",
+        },
+        "comment": {
+            "comment_id": 1,
+            "comment_text": "test-comment",
+            "status": "approved",
+            "comment_f_path": "text.py",
+            "comment_line_no": "1",
+            "comment_type": "note",
+        },
+        "commit": {
+            "commit_id": "efefef",
+            "commit_branch": "master",
+            "commit_message": "changed foo"
+        },
+        "push": {
+            "branches": "",
+            "commits": []
+        },
+
     }
 
 
 def test_webhook_parse_url_invalid_event():
     template_url = 'http://server.com/${repo_name}/build'
     handler = WebhookDataHandler(
         template_url, {'exmaple-header': 'header-values'})
     event = events.RepoDeleteEvent('')
     with pytest.raises(ValueError) as err:
         handler(event, {})
 
     err = str(err.value)
     assert err == "event type `<class 'rhodecode.events.repo.RepoDeleteEvent'>` has no handler defined"
 
 
 @pytest.mark.parametrize('template,expected_urls', [
     ('http://server.com/${repo_name}/build',
      ['http://server.com/foo/build']),
     ('http://server.com/${repo_name}/${repo_type}',
      ['http://server.com/foo/hg']),
     ('http://${server}.com/${repo_name}/${repo_id}',
      ['http://${server}.com/foo/12']),
     ('http://server.com/${branch}/build',
      ['http://server.com/${branch}/build']),
 ])
 def test_webook_parse_url_for_create_event(base_data, template, expected_urls):
     headers = {'exmaple-header': 'header-values'}
     handler = WebhookDataHandler(template, headers)
     urls = handler(events.RepoCreateEvent(''), base_data)
     assert urls == [
         (url, headers, base_data) for url in expected_urls]
 
 
 @pytest.mark.parametrize('template,expected_urls', [
     ('http://server.com/${repo_name}/${pull_request_id}',
      ['http://server.com/foo/999']),
     ('http://server.com/${repo_name}/${pull_request_url}',
      ['http://server.com/foo/http%3A//pr-url.com']),
     ('http://server.com/${repo_name}/${pull_request_url}/?TITLE=${pull_request_title}',
      ['http://server.com/foo/http%3A//pr-url.com/?TITLE=example-pr-title%20Ticket%20%23123']),
     ('http://server.com/${repo_name}/?SHADOW_URL=${pull_request_shadow_url}',
      ['http://server.com/foo/?SHADOW_URL=http%3A//pr-url.com/repository']),
 ])
 def test_webook_parse_url_for_pull_request_event(base_data, template, expected_urls):
 
     base_data['pullrequest'] = {
         'pull_request_id': 999,
         'url': 'http://pr-url.com',
         'title': 'example-pr-title Ticket #123',
         'commits_uid': 'abcdefg1234',
         'shadow_url': 'http://pr-url.com/repository'
     }
     headers = {'exmaple-header': 'header-values'}
     handler = WebhookDataHandler(template, headers)
     urls = handler(events.PullRequestCreateEvent(
         AttributeDict({'target_repo': 'foo'})), base_data)
     assert urls == [
         (url, headers, base_data) for url in expected_urls]
 
 
 @pytest.mark.parametrize('template,expected_urls', [
     ('http://server.com/${branch}/build',
         ['http://server.com/stable/build',
          'http://server.com/dev/build']),
     ('http://server.com/${branch}/${commit_id}',
         ['http://server.com/stable/stable-xxx',
          'http://server.com/stable/stable-yyy',
          'http://server.com/dev/dev-xxx',
          'http://server.com/dev/dev-yyy']),
     ('http://server.com/${branch_head}',
      ['http://server.com/stable-yyy',
       'http://server.com/dev-yyy']),
     ('http://server.com/${commit_id}',
      ['http://server.com/stable-xxx',
       'http://server.com/stable-yyy',
       'http://server.com/dev-xxx',
       'http://server.com/dev-yyy']),
 ])
 def test_webook_parse_url_for_push_event(
         baseapp, repo_push_event, base_data, template, expected_urls):
     base_data['push'] = {
         'branches': [{'name': 'stable'}, {'name': 'dev'}],
         'commits': [{'branch': 'stable', 'raw_id': 'stable-xxx'},
                     {'branch': 'stable', 'raw_id': 'stable-yyy'},
                     {'branch': 'dev', 'raw_id': 'dev-xxx'},
                     {'branch': 'dev', 'raw_id': 'dev-yyy'}]
     }
     headers = {'exmaple-header': 'header-values'}
     handler = WebhookDataHandler(template, headers)
     urls = handler(repo_push_event, base_data)
     assert urls == [
         (url, headers, base_data) for url in expected_urls]
+
+
[e-mail]("event_type, args", [
+    (
+        events.RepoPushEvent,
+        (GIT_REPO, mock.MagicMock(name="pushed_commit_ids"), mock.MagicMock(name="extras")),
+    ),
+    (
+        events.RepoCreateEvent,
+        (GIT_REPO,),
+    ),
+    (
+        events.RepoCommitCommentEvent,
+        (GIT_REPO, mock.MagicMock(name="commit"), mock.MagicMock(name="comment")),
+    ),
+    (
+        events.RepoCommitCommentEditEvent,
+        (GIT_REPO, mock.MagicMock(name="commit"), mock.MagicMock(name="comment")),
+    ),
+    (
+        events.PullRequestEvent,
+        (mock.MagicMock(), ),
+    ),
+])
+def test_webhook_data_handler(app, event_type: events.RhodecodeEvent, args, base_data):
+    handler = WebhookDataHandler(
+        template_url='http://server.com/${branch}/${commit_id}',
+        headers={'exmaple-header': 'header-values'}
+    )
+    handler(event_type(*args), base_data)
+
+
+
+

rhodecode/tests/vcs/test_commits.py

@@ -1,591 +1,591 b''
 
 # Copyright (C) 2010-2023 RhodeCode GmbH
 #
 # 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 datetime
 import time
 
 import pytest
 
 from rhodecode.lib.str_utils import safe_bytes
 from rhodecode.lib.vcs.backends.base import (
     CollectionGenerator, FILEMODE_DEFAULT, EmptyCommit)
 from rhodecode.lib.vcs.exceptions import (
     BranchDoesNotExistError, CommitDoesNotExistError,
     RepositoryError, EmptyRepositoryError)
 from rhodecode.lib.vcs.nodes import (
     FileNode, AddedFileNodesGenerator,
     ChangedFileNodesGenerator, RemovedFileNodesGenerator)
 from rhodecode.tests import get_new_dir
 from rhodecode.tests.vcs.conftest import BackendTestMixin
 
 
 class TestBaseChangeset(object):
 
     def test_is_deprecated(self):
         from rhodecode.lib.vcs.backends.base import BaseChangeset
         pytest.deprecated_call(BaseChangeset)
 
 
 class TestEmptyCommit(object):
 
     def test_branch_without_alias_returns_none(self):
         commit = EmptyCommit()
         assert commit.branch is None
 
 
 @pytest.mark.usefixtures("vcs_repository_support")
 class TestCommitsInNonEmptyRepo(BackendTestMixin):
     recreate_repo_per_test = True
 
     @classmethod
     def _get_commits(cls):
         start_date = datetime.datetime(2010, 1, 1, 20)
         for x in range(5):
             yield {
                 'message': 'Commit %d' % x,
                 'author': 'Joe Doe <[e-mail]>',
                 'date': start_date + datetime.timedelta(hours=12 * x),
                 'added': [
                     FileNode(b'file_%d.txt' % x,
                              content=b'Foobar %d' % x),
                 ],
             }
 
     def test_walk_returns_empty_list_in_case_of_file(self):
         result = list(self.tip.walk('file_0.txt'))
         assert result == []
 
     @pytest.mark.backends("git", "hg")
     def test_new_branch(self):
         self.imc.add(FileNode(b'docs/index.txt', content=b'Documentation\n'))
         foobar_tip = self.imc.commit(
             message='New branch: foobar',
             author='joe <[e-mail]>',
             branch='foobar',
         )
         assert 'foobar' in self.repo.branches
         assert foobar_tip.branch == 'foobar'
         # 'foobar' should be the only branch that contains the new commit
         branch = list(self.repo.branches.values())
         assert branch[0] != branch[1]
 
     @pytest.mark.backends("git", "hg")
     def test_new_head_in_default_branch(self):
         tip = self.repo.get_commit()
         self.imc.add(FileNode(b'docs/index.txt', content=b'Documentation\n'))
         foobar_tip = self.imc.commit(
             message='New branch: foobar',
             author='joe <[e-mail]>',
             branch='foobar',
             parents=[tip],
         )
         self.imc.change(FileNode(b'docs/index.txt', content=b'Documentation\nand more...\n'))
         newtip = self.imc.commit(
             message='At default branch',
             author='joe <[e-mail]>',
             branch=foobar_tip.branch,
             parents=[foobar_tip],
         )
 
         newest_tip = self.imc.commit(
             message='Merged with %s' % foobar_tip.raw_id,
             author='joe <[e-mail]>',
             branch=self.backend_class.DEFAULT_BRANCH_NAME,
             parents=[newtip, foobar_tip],
         )
 
         assert newest_tip.branch == self.backend_class.DEFAULT_BRANCH_NAME
 
     @pytest.mark.backends("git", "hg")
     def test_get_commits_respects_branch_name(self):
         """
         * e1930d0 (HEAD, master) Back in default branch
         | * e1930d0 (docs) New Branch: docs2
         | * dcc14fa New branch: docs
         |/
         * e63c41a Initial commit
         ...
         * 624d3db Commit 0
 
         :return:
         """
         DEFAULT_BRANCH = self.repo.DEFAULT_BRANCH_NAME
         TEST_BRANCH = 'docs'
         org_tip = self.repo.get_commit()
 
         self.imc.add(FileNode(b'readme.txt', content=b'Document\n'))
         initial = self.imc.commit(
             message='Initial commit',
             author='joe <[e-mail]>',
             parents=[org_tip],
             branch=DEFAULT_BRANCH,)
 
         self.imc.add(FileNode(b'newdoc.txt', content=b'foobar\n'))
         docs_branch_commit1 = self.imc.commit(
             message='New branch: docs',
             author='joe <[e-mail]>',
             parents=[initial],
             branch=TEST_BRANCH,)
 
         self.imc.add(FileNode(b'newdoc2.txt', content=b'foobar2\n'))
         docs_branch_commit2 = self.imc.commit(
             message='New branch: docs2',
             author='joe <[e-mail]>',
             parents=[docs_branch_commit1],
             branch=TEST_BRANCH,)
 
         self.imc.add(FileNode(b'newfile', content=b'hello world\n'))
         self.imc.commit(
             message='Back in default branch',
             author='joe <[e-mail]>',
             parents=[initial],
             branch=DEFAULT_BRANCH,)
 
         default_branch_commits = self.repo.get_commits(branch_name=DEFAULT_BRANCH)
         assert docs_branch_commit1 not in list(default_branch_commits)
         assert docs_branch_commit2 not in list(default_branch_commits)
 
         docs_branch_commits = self.repo.get_commits(
             start_id=self.repo.commit_ids[0], end_id=self.repo.commit_ids[-1],
             branch_name=TEST_BRANCH)
         assert docs_branch_commit1 in list(docs_branch_commits)
         assert docs_branch_commit2 in list(docs_branch_commits)
 
     @pytest.mark.backends("svn")
     def test_get_commits_respects_branch_name_svn(self, vcsbackend_svn):
         repo = vcsbackend_svn['svn-simple-layout']
         commits = repo.get_commits(branch_name='trunk')
         commit_indexes = [c.idx for c in commits]
         assert commit_indexes == [1, 2, 3, 7, 12, 15]
 
     def test_get_commit_by_index(self):
         for idx in [1, 2, 3, 4]:
             assert idx == self.repo.get_commit(commit_idx=idx).idx
 
     def test_get_commit_by_branch(self):
         for branch, commit_id in self.repo.branches.items():
             assert commit_id == self.repo.get_commit(branch).raw_id
 
     def test_get_commit_by_tag(self):
         for tag, commit_id in self.repo.tags.items():
             assert commit_id == self.repo.get_commit(tag).raw_id
 
     def test_get_commit_parents(self):
         repo = self.repo
         for test_idx in [1, 2, 3]:
             commit = repo.get_commit(commit_idx=test_idx - 1)
             assert [commit] == repo.get_commit(commit_idx=test_idx).parents
 
     def test_get_commit_children(self):
         repo = self.repo
         for test_idx in [1, 2, 3]:
             commit = repo.get_commit(commit_idx=test_idx + 1)
             assert [commit] == repo.get_commit(commit_idx=test_idx).children
 
 
 @pytest.mark.usefixtures("vcs_repository_support")
 class TestCommits(BackendTestMixin):
     recreate_repo_per_test = False
 
     @classmethod
     def _get_commits(cls):
         start_date = datetime.datetime(2010, 1, 1, 20)
         for x in range(5):
             yield {
                 'message': 'Commit %d' % x,
                 'author': 'Joe Doe <[e-mail]>',
                 'date': start_date + datetime.timedelta(hours=12 * x),
                 'added': [
                     FileNode(b'file_%d.txt' % x,
                              content=b'Foobar %d' % x)
                 ],
             }
 
     def test_simple(self):
         tip = self.repo.get_commit()
         assert tip.date, datetime.datetime(2010, 1, 3 == 20)
 
     def test_simple_serialized_commit(self):
         tip = self.repo.get_commit()
         # json.dumps(tip) uses .__json__() method
         data = tip.__json__()
         assert 'branch' in data
         assert data['revision']
 
     def test_retrieve_tip(self):
         tip = self.repo.get_commit('tip')
         assert tip == self.repo.get_commit()
 
     def test_invalid(self):
         with pytest.raises(CommitDoesNotExistError):
             self.repo.get_commit(commit_idx=123456789)
 
     def test_idx(self):
         commit = self.repo[0]
         assert commit.idx == 0
 
     def test_negative_idx(self):
         commit = self.repo.get_commit(commit_idx=-1)
         assert commit.idx >= 0
 
     def test_revision_is_deprecated(self):
         def get_revision(commit):
             return commit.revision
 
         commit = self.repo[0]
         pytest.deprecated_call(get_revision, commit)
 
     def test_size(self):
         tip = self.repo.get_commit()
         size = 5 * len('Foobar N')  # Size of 5 files
         assert tip.size == size
 
     def test_size_at_commit(self):
         tip = self.repo.get_commit()
         size = 5 * len('Foobar N')  # Size of 5 files
         assert self.repo.size_at_commit(tip.raw_id) == size
 
     def test_size_at_first_commit(self):
         commit = self.repo[0]
         size = len('Foobar N')  # Size of 1 file
         assert self.repo.size_at_commit(commit.raw_id) == size
 
     def test_author(self):
         tip = self.repo.get_commit()
         assert_text_equal(tip.author, 'Joe Doe <[e-mail]>')
 
     def test_author_name(self):
         tip = self.repo.get_commit()
         assert_text_equal(tip.author_name, 'Joe Doe')
 
     def test_author_email(self):
         tip = self.repo.get_commit()
         assert_text_equal(tip.author_email, '[e-mail]')
 
     def test_message(self):
         tip = self.repo.get_commit()
         assert_text_equal(tip.message, 'Commit 4')
 
     def test_diff(self):
         tip = self.repo.get_commit()
         diff = tip.diff()
         assert b"+Foobar 4" in diff.raw.tobytes()
 
     def test_prev(self):
         tip = self.repo.get_commit()
         prev_commit = tip.prev()
         assert prev_commit.message == 'Commit 3'
 
     def test_prev_raises_on_first_commit(self):
         commit = self.repo.get_commit(commit_idx=0)
         with pytest.raises(CommitDoesNotExistError):
             commit.prev()
 
     def test_prev_works_on_second_commit_issue_183(self):
         commit = self.repo.get_commit(commit_idx=1)
         prev_commit = commit.prev()
         assert prev_commit.idx == 0
 
     def test_next(self):
         commit = self.repo.get_commit(commit_idx=2)
         next_commit = commit.next()
         assert next_commit.message == 'Commit 3'
 
     def test_next_raises_on_tip(self):
         commit = self.repo.get_commit()
         with pytest.raises(CommitDoesNotExistError):
             commit.next()
 
     def test_get_path_commit(self):
         commit = self.repo.get_commit()
         commit.get_path_commit('file_4.txt')
         assert commit.message == 'Commit 4'
 
     def test_get_filenodes_generator(self):
         tip = self.repo.get_commit()
         filepaths = [node.path for node in tip.get_filenodes_generator()]
         assert filepaths == ['file_%d.txt' % x for x in range(5)]
 
     def test_get_file_annotate(self):
         file_added_commit = self.repo.get_commit(commit_idx=3)
         annotations = list(file_added_commit.get_file_annotate('file_3.txt'))
 
         line_no, commit_id, commit_loader, line = annotations[0]
 
         assert line_no == 1
         assert commit_id == file_added_commit.raw_id
         assert commit_loader() == file_added_commit
-        assert 'Foobar 3' in line
+        assert b'Foobar 3' in line
 
     def test_get_file_annotate_does_not_exist(self):
         file_added_commit = self.repo.get_commit(commit_idx=2)
         # TODO: Should use a specific exception class here?
         with pytest.raises(Exception):
             list(file_added_commit.get_file_annotate('file_3.txt'))
 
     def test_get_file_annotate_tip(self):
         tip = self.repo.get_commit()
         commit = self.repo.get_commit(commit_idx=3)
         expected_values = list(commit.get_file_annotate('file_3.txt'))
         annotations = list(tip.get_file_annotate('file_3.txt'))
 
         # Note: Skip index 2 because the loader function is not the same
         for idx in (0, 1, 3):
             assert annotations[0][idx] == expected_values[0][idx]
 
     def test_get_commits_is_ordered_by_date(self):
         commits = self.repo.get_commits()
         assert isinstance(commits, CollectionGenerator)
         assert len(commits) == 0 or len(commits) != 0
         commits = list(commits)
         ordered_by_date = sorted(commits, key=lambda commit: commit.date)
         assert commits == ordered_by_date
 
     def test_get_commits_respects_start(self):
         second_id = self.repo.commit_ids[1]
         commits = self.repo.get_commits(start_id=second_id)
         assert isinstance(commits, CollectionGenerator)
         commits = list(commits)
         assert len(commits) == 4
 
     def test_get_commits_includes_start_commit(self):
         second_id = self.repo.commit_ids[1]
         commits = self.repo.get_commits(start_id=second_id)
         assert isinstance(commits, CollectionGenerator)
         commits = list(commits)
         assert commits[0].raw_id == second_id
 
     def test_get_commits_respects_end(self):
         second_id = self.repo.commit_ids[1]
         commits = self.repo.get_commits(end_id=second_id)
         assert isinstance(commits, CollectionGenerator)
         commits = list(commits)
         assert commits[-1].raw_id == second_id
         assert len(commits) == 2
 
     def test_get_commits_respects_both_start_and_end(self):
         second_id = self.repo.commit_ids[1]
         third_id = self.repo.commit_ids[2]
         commits = self.repo.get_commits(start_id=second_id, end_id=third_id)
         assert isinstance(commits, CollectionGenerator)
         commits = list(commits)
         assert len(commits) == 2
 
     def test_get_commits_on_empty_repo_raises_EmptyRepository_error(self):
         repo_path = get_new_dir(str(time.time()))
         repo = self.Backend(repo_path, create=True)
 
         with pytest.raises(EmptyRepositoryError):
             list(repo.get_commits(start_id='foobar'))
 
     def test_get_commits_respects_hidden(self):
         commits = self.repo.get_commits(show_hidden=True)
         assert isinstance(commits, CollectionGenerator)
         assert len(commits) == 5
 
     def test_get_commits_includes_end_commit(self):
         second_id = self.repo.commit_ids[1]
         commits = self.repo.get_commits(end_id=second_id)
         assert isinstance(commits, CollectionGenerator)
         assert len(commits) == 2
         commits = list(commits)
         assert commits[-1].raw_id == second_id
 
     def test_get_commits_respects_start_date(self):
         start_date = datetime.datetime(2010, 1, 2)
         commits = self.repo.get_commits(start_date=start_date)
         assert isinstance(commits, CollectionGenerator)
         # Should be 4 commits after 2010-01-02 00:00:00
         assert len(commits) == 4
         for c in commits:
             assert c.date >= start_date
 
     def test_get_commits_respects_start_date_with_branch(self):
         start_date = datetime.datetime(2010, 1, 2)
         commits = self.repo.get_commits(
             start_date=start_date, branch_name=self.repo.DEFAULT_BRANCH_NAME)
         assert isinstance(commits, CollectionGenerator)
         # Should be 4 commits after 2010-01-02 00:00:00
         assert len(commits) == 4
         for c in commits:
             assert c.date >= start_date
 
     def test_get_commits_respects_start_date_and_end_date(self):
         start_date = datetime.datetime(2010, 1, 2)
         end_date = datetime.datetime(2010, 1, 3)
         commits = self.repo.get_commits(start_date=start_date,
                                         end_date=end_date)
         assert isinstance(commits, CollectionGenerator)
         assert len(commits) == 2
         for c in commits:
             assert c.date >= start_date
             assert c.date <= end_date
 
     def test_get_commits_respects_end_date(self):
         end_date = datetime.datetime(2010, 1, 2)
         commits = self.repo.get_commits(end_date=end_date)
         assert isinstance(commits, CollectionGenerator)
         assert len(commits) == 1
         for c in commits:
             assert c.date <= end_date
 
     def test_get_commits_respects_reverse(self):
         commits = self.repo.get_commits()  # no longer reverse support
         assert isinstance(commits, CollectionGenerator)
         assert len(commits) == 5
         commit_ids = reversed([c.raw_id for c in commits])
         assert list(commit_ids) == list(reversed(self.repo.commit_ids))
 
     def test_get_commits_slice_generator(self):
         commits = self.repo.get_commits(
             branch_name=self.repo.DEFAULT_BRANCH_NAME)
         assert isinstance(commits, CollectionGenerator)
         commit_slice = list(commits[1:3])
         assert len(commit_slice) == 2
 
     def test_get_commits_raise_commitdoesnotexist_for_wrong_start(self):
         with pytest.raises(CommitDoesNotExistError):
             list(self.repo.get_commits(start_id='foobar'))
 
     def test_get_commits_raise_commitdoesnotexist_for_wrong_end(self):
         with pytest.raises(CommitDoesNotExistError):
             list(self.repo.get_commits(end_id='foobar'))
 
     def test_get_commits_raise_branchdoesnotexist_for_wrong_branch_name(self):
         with pytest.raises(BranchDoesNotExistError):
             list(self.repo.get_commits(branch_name='foobar'))
 
     def test_get_commits_raise_repositoryerror_for_wrong_start_end(self):
         start_id = self.repo.commit_ids[-1]
         end_id = self.repo.commit_ids[0]
         with pytest.raises(RepositoryError):
             list(self.repo.get_commits(start_id=start_id, end_id=end_id))
 
     def test_get_commits_raises_for_numerical_ids(self):
         with pytest.raises(TypeError):
             self.repo.get_commits(start_id=1, end_id=2)
 
     def test_commit_equality(self):
         commit1 = self.repo.get_commit(self.repo.commit_ids[0])
         commit2 = self.repo.get_commit(self.repo.commit_ids[1])
 
         assert commit1 == commit1
         assert commit2 == commit2
         assert commit1 != commit2
         assert commit2 != commit1
         assert commit1 is not None
         assert commit2 is not None
         assert 1 != commit1
         assert 'string' != commit1
 
 
 @pytest.mark.parametrize("filename, expected", [
     ("README.rst", False),
     ("README", True),
 ])
 def test_commit_is_link(vcsbackend, filename, expected):
     commit = vcsbackend.repo.get_commit()
     link_status = commit.is_link(filename)
     assert link_status is expected
 
 
 @pytest.mark.usefixtures("vcs_repository_support")
 class TestCommitsChanges(BackendTestMixin):
     recreate_repo_per_test = False
 
     @classmethod
     def _get_commits(cls):
         return [
             {
                 'message': 'Initial',
                 'author': 'Joe Doe <[e-mail]>',
                 'date': datetime.datetime(2010, 1, 1, 20),
                 'added': [
                     FileNode(b'foo/bar', content=b'foo'),
                     FileNode(safe_bytes('foo/bał'), content=b'foo'),
                     FileNode(b'foobar', content=b'foo'),
                     FileNode(b'qwe', content=b'foo'),
                 ],
             },
             {
                 'message': 'Massive changes',
                 'author': 'Joe Doe <[e-mail]>',
                 'date': datetime.datetime(2010, 1, 1, 22),
                 'added': [FileNode(b'fallout', content=b'War never changes')],
                 'changed': [
                     FileNode(b'foo/bar', content=b'baz'),
                     FileNode(b'foobar', content=b'baz'),
                 ],
                 'removed': [FileNode(b'qwe')],
             },
         ]
 
     def test_initial_commit(self, local_dt_to_utc):
         commit = self.repo.get_commit(commit_idx=0)
         assert set(commit.added) == {
             commit.get_node('foo/bar'),
             commit.get_node('foo/bał'),
             commit.get_node('foobar'),
             commit.get_node('qwe')
         }
         assert set(commit.changed) == set()
         assert set(commit.removed) == set()
         assert set(commit.affected_files) == {'foo/bar', 'foo/bał', 'foobar', 'qwe'}
         assert commit.date == local_dt_to_utc(
             datetime.datetime(2010, 1, 1, 20, 0))
 
     def test_head_added(self):
         commit = self.repo.get_commit()
         assert isinstance(commit.added, AddedFileNodesGenerator)
         assert set(commit.added) == {commit.get_node('fallout')}
         assert isinstance(commit.changed, ChangedFileNodesGenerator)
         assert set(commit.changed) == {commit.get_node('foo/bar'), commit.get_node('foobar')}
         assert isinstance(commit.removed, RemovedFileNodesGenerator)
         assert len(commit.removed) == 1
         assert list(commit.removed)[0].path == 'qwe'
 
     def test_get_filemode(self):
         commit = self.repo.get_commit()
         assert FILEMODE_DEFAULT == commit.get_file_mode('foo/bar')
 
     def test_get_filemode_non_ascii(self):
         commit = self.repo.get_commit()
         assert FILEMODE_DEFAULT == commit.get_file_mode('foo/bał')
         assert FILEMODE_DEFAULT == commit.get_file_mode('foo/bał')
 
     def test_get_path_history(self):
         commit = self.repo.get_commit()
         history = commit.get_path_history('foo/bar')
         assert len(history) == 2
 
     def test_get_path_history_with_limit(self):
         commit = self.repo.get_commit()
         history = commit.get_path_history('foo/bar', limit=1)
         assert len(history) == 1
 
     def test_get_path_history_first_commit(self):
         commit = self.repo[0]
         history = commit.get_path_history('foo/bar')
         assert len(history) == 1
 
 
 def assert_text_equal(expected, given):
     assert expected == given
     assert isinstance(expected, str)
     assert isinstance(given, str)