Move WebhookTestCase class from test_hooks.py to test_helpers.py.

zerver/lib/test_helpers.py

@@ -559,6 +559,69 @@ class ZulipTestCase(TestCase):
                 mock.patch('zerver.lib.bugdown.log_bugdown_error'):
             yield
 
+class WebhookTestCase(ZulipTestCase):
+    """
+    Common for all webhooks tests
+
+    Override below class attributes and run send_and_test_message
+    If you create your url in uncommon way you can override build_webhook_url method
+    In case that you need modify body or create it without using fixture you can also override get_body method
+    """
+    STREAM_NAME = None # type: Optional[text_type]
+    TEST_USER_EMAIL = 'webhook-bot@zulip.com'
+    URL_TEMPLATE = None # type: Optional[text_type]
+    FIXTURE_DIR_NAME = None # type: Optional[text_type]
+
+    def setUp(self):
+        # type: () -> None
+        self.url = self.build_webhook_url()
+
+    def send_and_test_stream_message(self, fixture_name, expected_subject=None,
+                                     expected_message=None, content_type="application/json", **kwargs):
+        # type: (text_type, Optional[text_type], Optional[text_type], Optional[text_type], **Any) -> Message
+        payload = self.get_body(fixture_name)
+        if content_type is not None:
+            kwargs['content_type'] = content_type
+        msg = self.send_json_payload(self.TEST_USER_EMAIL, self.url, payload,
+                                     self.STREAM_NAME, **kwargs)
+        self.do_test_subject(msg, expected_subject)
+        self.do_test_message(msg, expected_message)
+
+        return msg
+
+    def send_and_test_private_message(self, fixture_name, expected_subject=None,
+                                      expected_message=None, content_type="application/json", **kwargs):
+        # type: (text_type, text_type, text_type, str, **Any) -> Message
+        payload = self.get_body(fixture_name)
+        if content_type is not None:
+            kwargs['content_type'] = content_type
+
+        msg = self.send_json_payload(self.TEST_USER_EMAIL, self.url, payload,
+                                     stream_name=None, **kwargs)
+        self.do_test_message(msg, expected_message)
+
+        return msg
+
+    def build_webhook_url(self):
+        # type: () -> text_type
+        api_key = self.get_api_key(self.TEST_USER_EMAIL)
+        return self.URL_TEMPLATE.format(stream=self.STREAM_NAME, api_key=api_key)
+
+    def get_body(self, fixture_name):
+        # type: (text_type) -> Union[text_type, Dict[str, text_type]]
+        """Can be implemented either as returning a dictionary containing the
+        post parameters or as string containing the body of the request."""
+        return ujson.dumps(ujson.loads(self.fixture_data(self.FIXTURE_DIR_NAME, fixture_name)))
+
+    def do_test_subject(self, msg, expected_subject):
+        # type: (Message, Optional[text_type]) -> None
+        if expected_subject is not None:
+            self.assertEqual(msg.topic_name(), expected_subject)
+
+    def do_test_message(self, msg, expected_message):
+        # type: (Message, Optional[text_type]) -> None
+        if expected_message is not None:
+            self.assertEqual(msg.content, expected_message)
 
 def get_all_templates():
     # type: () -> List[str]

zerver/tests/test_decorators.py

@@ -5,13 +5,11 @@ from django.test import TestCase
 from django.utils.translation import ugettext as _
 from django.http import HttpResponse
 
-from zerver.tests.test_hooks import WebhookTestCase
-
 from zerver.lib.actions import do_deactivate_realm, do_deactivate_user, \
     do_reactivate_user, do_reactivate_realm
 from zerver.lib.initial_password import initial_password
 from zerver.lib.test_helpers import (
-    ZulipTestCase
+    ZulipTestCase, WebhookTestCase
 )
 from zerver.lib.request import \
     REQ, has_request_variables, RequestVariableMissingError, \

zerver/tests/test_hooks.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from zerver.lib.test_helpers import ZulipTestCase
+from zerver.lib.test_helpers import WebhookTestCase
 from zerver.lib.test_runner import slow
 from zerver.models import Message, Recipient
 
@@ -8,70 +8,6 @@ from six import text_type
 from six.moves import urllib
 from typing import Any, Dict, List, Optional, Union
 
-class WebhookTestCase(ZulipTestCase):
-    """
-    Common for all webhooks tests
-
-    Override below class attributes and run send_and_test_message
-    If you create your url in uncommon way you can override build_webhook_url method
-    In case that you need modify body or create it without using fixture you can also override get_body method
-    """
-    STREAM_NAME = None # type: Optional[text_type]
-    TEST_USER_EMAIL = 'webhook-bot@zulip.com'
-    URL_TEMPLATE = None # type: Optional[text_type]
-    FIXTURE_DIR_NAME = None # type: Optional[text_type]
-
-    def setUp(self):
-        # type: () -> None
-        self.url = self.build_webhook_url()
-
-    def send_and_test_stream_message(self, fixture_name, expected_subject=None,
-                                     expected_message=None, content_type="application/json", **kwargs):
-        # type: (text_type, Optional[text_type], Optional[text_type], Optional[text_type], **Any) -> Message
-        payload = self.get_body(fixture_name)
-        if content_type is not None:
-            kwargs['content_type'] = content_type
-        msg = self.send_json_payload(self.TEST_USER_EMAIL, self.url, payload,
-                                     self.STREAM_NAME, **kwargs)
-        self.do_test_subject(msg, expected_subject)
-        self.do_test_message(msg, expected_message)
-
-        return msg
-
-    def send_and_test_private_message(self, fixture_name, expected_subject=None,
-                                      expected_message=None, content_type="application/json", **kwargs):
-        # type: (text_type, text_type, text_type, str, **Any) -> Message
-        payload = self.get_body(fixture_name)
-        if content_type is not None:
-            kwargs['content_type'] = content_type
-
-        msg = self.send_json_payload(self.TEST_USER_EMAIL, self.url, payload,
-                                     stream_name=None, **kwargs)
-        self.do_test_message(msg, expected_message)
-
-        return msg
-
-    def build_webhook_url(self):
-        # type: () -> text_type
-        api_key = self.get_api_key(self.TEST_USER_EMAIL)
-        return self.URL_TEMPLATE.format(stream=self.STREAM_NAME, api_key=api_key)
-
-    def get_body(self, fixture_name):
-        # type: (text_type) -> Union[text_type, Dict[str, text_type]]
-        """Can be implemented either as returning a dictionary containing the
-        post parameters or as string containing the body of the request."""
-        return ujson.dumps(ujson.loads(self.fixture_data(self.FIXTURE_DIR_NAME, fixture_name)))
-
-    def do_test_subject(self, msg, expected_subject):
-        # type: (Message, Optional[text_type]) -> None
-        if expected_subject is not None:
-            self.assertEqual(msg.topic_name(), expected_subject)
-
-    def do_test_message(self, msg, expected_message):
-        # type: (Message, Optional[text_type]) -> None
-        if expected_message is not None:
-            self.assertEqual(msg.content, expected_message)
-
 class JiraHookTests(WebhookTestCase):
     STREAM_NAME = 'jira'
     URL_TEMPLATE = u"/api/v1/external/jira?api_key={api_key}"