events: add pull request events

rhodecode/events/pullrequest.py

@@ -0,0 +1,72 b''
+# Copyright (C) 2016-2016  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/
+
+from rhodecode.events.repo import RepoEvent
+
+
+class PullRequestEvent(RepoEvent):
+    """
+    Base class for events acting on a repository.
+
+    :param repo: a :class:`Repository` instance
+    """
+    def __init__(self, pullrequest):
+        super(PullRequestEvent, self).__init__(pullrequest.target_repo)
+        self.pullrequest = pullrequest
+
+
+class PullRequestCreateEvent(PullRequestEvent):
+    """
+    An instance of this class is emitted as an :term:`event` after a pull
+    request is created.
+    """
+    name = 'pullrequest-create'
+
+
+class PullRequestCloseEvent(PullRequestEvent):
+    """
+    An instance of this class is emitted as an :term:`event` after a pull
+    request is closed.
+    """
+    name = 'pullrequest-close'
+
+
+class PullRequestUpdateEvent(PullRequestEvent):
+    """
+    An instance of this class is emitted as an :term:`event` after a pull
+    request is updated.
+    """
+    name = 'pullrequest-update'
+
+
+class PullRequestMergeEvent(PullRequestEvent):
+    """
+    An instance of this class is emitted as an :term:`event` after a pull
+    request is merged.
+    """
+    name = 'pullrequest-merge'
+
+
+class PullRequestReviewEvent(PullRequestEvent):
+    """
+    An instance of this class is emitted as an :term:`event` after a pull
+    request is reviewed.
+    """
+    name = 'pullrequest-review'
+
+

rhodecode/tests/events/test_pullrequest.py

@@ -0,0 +1,61 b''
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2010-2016  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.tests.events.conftest import EventCatcher
+
+from rhodecode.model.pull_request import PullRequestModel
+from rhodecode.events import (
+    PullRequestCreateEvent,
+    PullRequestUpdateEvent,
+    PullRequestReviewEvent,
+    PullRequestMergeEvent,
+    PullRequestCloseEvent,
+)
+
+
[e-mail]("git", "hg")
+def test_create_pull_request_events(pr_util):
+    with EventCatcher() as event_catcher:
+        pr_util.create_pull_request()
+
+    assert PullRequestCreateEvent in event_catcher.events_types
+
+
[e-mail]("git", "hg")
+def test_close_pull_request_events(pr_util, user_admin):
+    pr = pr_util.create_pull_request()
+
+    with EventCatcher() as event_catcher:
+        PullRequestModel().close_pull_request(pr, user_admin)
+
+    assert PullRequestCloseEvent in event_catcher.events_types
+
+
[e-mail]("git", "hg")
+def test_close_pull_request_with_comment_events(pr_util, user_admin):
+    pr = pr_util.create_pull_request()
+
+    with EventCatcher() as event_catcher:
+        PullRequestModel().close_pull_request_with_comment(
+            pr, user_admin, pr.target_repo)
+
+    assert PullRequestCloseEvent in event_catcher.events_types

rhodecode/events/__init__.py

@@ -1,51 +1,59 b''
 # Copyright (C) 2016-2016  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/
 
 from pyramid.threadlocal import get_current_registry
 
 
 class RhodecodeEvent(object):
     """
     Base event class for all Rhodecode events
     """
 
 
 def trigger(event):
     """
     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.
     registry = get_current_registry()
     registry.notify(event)
 
 
 from rhodecode.events.user import (
     UserPreCreate,
     UserPreUpdate,
     UserRegistered
 )
 
 from rhodecode.events.repo import (
     RepoPreCreateEvent, RepoCreatedEvent,
     RepoPreDeleteEvent, RepoDeletedEvent,
     RepoPrePushEvent,   RepoPushEvent,
     RepoPrePullEvent,   RepoPullEvent,
 )
+
+from rhodecode.events.pullrequest import (
+    PullRequestCreateEvent,
+    PullRequestUpdateEvent,
+    PullRequestReviewEvent,
+    PullRequestMergeEvent,
+    PullRequestCloseEvent,
+)
  No newline at end of file

rhodecode/lib/hooks_utils.py

@@ -1,156 +1,162 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2016  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 pylons
 import webob
 
+from rhodecode import events
 from rhodecode.lib import hooks_base
 from rhodecode.lib import utils2
 
 
 def _get_rc_scm_extras(username, repo_name, repo_alias, action):
     # TODO: johbo: Replace by vcs_operation_context and remove fully
     from rhodecode.lib.base import vcs_operation_context
     check_locking = action in ('pull', 'push')
 
     try:
         environ = pylons.request.environ
     except TypeError:
         # we might use this outside of request context, let's fake the
         # environ data
         environ = webob.Request.blank('').environ
 
     extras = vcs_operation_context(
         environ, repo_name, username, action, repo_alias, check_locking)
     return utils2.AttributeDict(extras)
 
 
 def trigger_post_push_hook(
         username, action, repo_name, repo_alias, commit_ids):
     """
     Triggers push action hooks
 
     :param username: username who pushes
     :param action: push/push_local/push_remote
     :param repo_name: name of repo
     :param repo_alias: the type of SCM repo
     :param commit_ids: list of commit ids that we pushed
     """
     if repo_alias not in ('hg', 'git'):
         return
 
     extras = _get_rc_scm_extras(username, repo_name, repo_alias, action)
     extras.commit_ids = commit_ids
     hooks_base.post_push(extras)
 
 
 def trigger_log_create_pull_request_hook(username, repo_name, repo_alias,
                                          pull_request):
     """
     Triggers create pull request action hooks
 
     :param username: username who creates the pull request
     :param repo_name: name of target repo
     :param repo_alias: the type of SCM target repo
     :param pull_request: the pull request that was created
     """
     if repo_alias not in ('hg', 'git'):
         return
 
     extras = _get_rc_scm_extras(username, repo_name, repo_alias,
                                 'create_pull_request')
+    events.trigger(events.PullRequestCreateEvent(pull_request))
     extras.update(pull_request.get_api_data())
     hooks_base.log_create_pull_request(**extras)
 
 
 def trigger_log_merge_pull_request_hook(username, repo_name, repo_alias,
                                         pull_request):
     """
     Triggers merge pull request action hooks
 
     :param username: username who creates the pull request
     :param repo_name: name of target repo
     :param repo_alias: the type of SCM target repo
     :param pull_request: the pull request that was merged
     """
     if repo_alias not in ('hg', 'git'):
         return
 
     extras = _get_rc_scm_extras(username, repo_name, repo_alias,
                                 'merge_pull_request')
+    events.trigger(events.PullRequestMergeEvent(pull_request))
     extras.update(pull_request.get_api_data())
     hooks_base.log_merge_pull_request(**extras)
 
 
 def trigger_log_close_pull_request_hook(username, repo_name, repo_alias,
                                         pull_request):
     """
     Triggers close pull request action hooks
 
     :param username: username who creates the pull request
     :param repo_name: name of target repo
     :param repo_alias: the type of SCM target repo
     :param pull_request: the pull request that was closed
     """
     if repo_alias not in ('hg', 'git'):
         return
 
     extras = _get_rc_scm_extras(username, repo_name, repo_alias,
                                 'close_pull_request')
+    events.trigger(events.PullRequestCloseEvent(pull_request))
     extras.update(pull_request.get_api_data())
     hooks_base.log_close_pull_request(**extras)
 
 
 def trigger_log_review_pull_request_hook(username, repo_name, repo_alias,
                                          pull_request):
     """
     Triggers review status change pull request action hooks
 
     :param username: username who creates the pull request
     :param repo_name: name of target repo
     :param repo_alias: the type of SCM target repo
     :param pull_request: the pull request that review status changed
     """
     if repo_alias not in ('hg', 'git'):
         return
 
     extras = _get_rc_scm_extras(username, repo_name, repo_alias,
                                 'review_pull_request')
+    events.trigger(events.PullRequestReviewEvent(pull_request))
     extras.update(pull_request.get_api_data())
     hooks_base.log_review_pull_request(**extras)
 
 
 def trigger_log_update_pull_request_hook(username, repo_name, repo_alias,
                                          pull_request):
     """
     Triggers update pull request action hooks
 
     :param username: username who creates the pull request
     :param repo_name: name of target repo
     :param repo_alias: the type of SCM target repo
     :param pull_request: the pull request that was updated
     """
     if repo_alias not in ('hg', 'git'):
         return
 
     extras = _get_rc_scm_extras(username, repo_name, repo_alias,
                                 'update_pull_request')
+    events.trigger(events.PullRequestUpdateEvent(pull_request))
     extras.update(pull_request.get_api_data())
     hooks_base.log_update_pull_request(**extras)