bots: Move all bots and the bots API to separate package.

zulip_bots/zulip_bots/test_lib.py

@@ -0,0 +1,134 @@
+#!/usr/bin/env python
+
+from __future__ import absolute_import
+from __future__ import print_function
+
+import os
+
+import json
+import logging
+import mock
+import requests
+import unittest
+
+from mock import MagicMock, patch
+
+from zulip_bots.lib import StateHandler
+import zulip_bots.lib
+from six.moves import zip
+
+from contextlib import contextmanager
+from importlib import import_module
+from unittest import TestCase
+
+from typing import List, Dict, Any, Optional, Callable
+from types import ModuleType
+
+
+class BotTestCase(TestCase):
+    bot_name = ''  # type: str
+
+    def get_bot_message_handler(self):
+        # type: () -> Any
+        # message_handler is of type 'Any', since it can contain any bot's
+        # handler class. Eventually, we want bot's handler classes to
+        # inherit from a common prototype specifying the handle_message
+        # function.
+        lib_module = import_module('zulip_bots.bots.{bot}.{bot}'.format(bot=self.bot_name))
+        return lib_module.handler_class()
+
+    def setUp(self):
+        # type: () -> None
+        # Mocking ExternalBotHandler
+        self.patcher = patch('zulip_bots.lib.ExternalBotHandler')
+        self.MockClass = self.patcher.start()
+        self.message_handler = self.get_bot_message_handler()
+
+    def tearDown(self):
+        # type: () -> None
+        self.patcher.stop()
+
+    def initialize_bot(self):
+        # type: () -> None
+        self.message_handler.initialize(self.MockClass())
+
+    def check_expected_responses(self, expectations, expected_method='send_reply',
+                                 email="foo_sender@zulip.com", recipient="foo", subject="foo",
+                                 sender_id=0, sender_full_name="Foo Bar", type="all"):
+        # type: (Dict[str, Any], str, str, str, str, int, str, str) -> None
+        # To test send_message, Any would be a Dict type,
+        # to test send_reply, Any would be a str type.
+        if type not in ["private", "stream", "all"]:
+            logging.exception("check_expected_response expects type to be 'private', 'stream' or 'all'")
+        for m, r in expectations.items():
+            # For calls with send_reply, r is a string (the content of a message),
+            # so we need to add it to a Dict as the value of 'content'.
+            # For calls with send_message, r is already a Dict.
+            response = {'content': r} if expected_method == 'send_reply' else r
+            if type != "stream":
+                message = {'content': m, 'type': "private", 'display_recipient': recipient,
+                           'sender_email': email, 'sender_id': sender_id,
+                           'sender_full_name': sender_full_name}
+                self.assert_bot_response(message=message, response=response, expected_method=expected_method)
+            if type != "private":
+                message = {'content': m, 'type': "stream", 'display_recipient': recipient,
+                           'subject': subject, 'sender_email': email, 'sender_id': sender_id,
+                           'sender_full_name': sender_full_name}
+                self.assert_bot_response(message=message, response=response, expected_method=expected_method)
+
+    def call_request(self, message, expected_method, response):
+        # type: (Dict[str, Any], str, Dict[str, Any]) -> None
+        # Send message to the concerned bot
+        self.message_handler.handle_message(message, self.MockClass(), StateHandler())
+
+        # Check if the bot is sending a message via `send_message` function.
+        # Where response is a dictionary here.
+        instance = self.MockClass.return_value
+        if expected_method == "send_message":
+            instance.send_message.assert_called_with(response)
+        else:
+            instance.send_reply.assert_called_with(message, response['content'])
+
+    @contextmanager
+    def mock_config_info(self, config_info):
+        # type: (Dict[str, str]) -> Any
+        self.MockClass.return_value.get_config_info.return_value = config_info
+        yield
+        self.MockClass.return_value.get_config_info.return_value = None
+
+    @contextmanager
+    def mock_http_conversation(self, test_name):
+        # type: (str) -> Any
+        """
+        Use this context manager to mock and verify a bot's HTTP
+        requests to the third-party API (and provide the correct
+        third-party API response. This allows us to test things
+        that would require the Internet without it).
+        """
+        assert test_name is not None
+        base_path = os.path.realpath(os.path.join(os.path.dirname(
+            os.path.abspath(__file__)), 'bots', self.bot_name, 'fixtures'))
+        http_data_path = os.path.join(base_path, '{}.json'.format(test_name))
+        with open(http_data_path, 'r') as http_data_file:
+            http_data = json.load(http_data_file)
+            http_request = http_data.get('request')
+            http_response = http_data.get('response')
+            http_headers = http_data.get('response-headers')
+            with patch('requests.get') as mock_get:
+                mock_result = mock.MagicMock()
+                mock_result.json.return_value = http_response
+                mock_result.status_code = http_headers.get('status', 200)
+                mock_result.ok.return_value = http_headers.get('ok', True)
+                mock_get.return_value = mock_result
+                yield
+                params = http_request.get('params', None)
+                if params is None:
+                    mock_get.assert_called_with(http_request['api_url'])
+                else:
+                    mock_get.assert_called_with(http_request['api_url'], params=params)
+
+    def assert_bot_response(self, message, response, expected_method):
+        # type: (Dict[str, Any], Dict[str, Any], str) -> None
+        # Strictly speaking, this function is not needed anymore,
+        # kept for now for legacy reasons.
+        self.call_request(message, expected_method, response)