paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 00:18:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

bots: Add mypy annotations for bots framework.

Browse Source 
This commit adds mypy annotations for both the main
bots and the bots testing runner. It involves a change
to the BotHandlerApi send_message and update_message
funtions, which is compatible with every bot.

Tweaked by tabbott to use more expressive annotations.
This commit is contained in:
derAnfaenger
2017-05-26 06:58:19 +02:00
committed by Tim Abbott
parent c12023840d
commit 024101be6b
5 changed files with 54 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
contrib_bots/bots_test_lib.py
View File

@@ -16,20 +16,27 @@ from six.moves import zip
from unittest import TestCase
from typing import List, Dict, Any
from types import ModuleType
current_dir = os.path.dirname(os.path.abspath(__file__))
class BotTestCase(TestCase):
bot_name = None
bot_name = '' # type: str
def assert_bot_output(self, request, response):
# type: (str, str) -> None
# type: (Dict[str, Any], str) -> None
bot_module = os.path.join(current_dir, "bots",
self.bot_name, self.bot_name + ".py")
self.bot_test(messages=[request], bot_module=bot_module,
bot_response=[response])
def mock_test(self, messages, message_handler, bot_response):
# type: (List[Dict[str, str]], Function) -> None
# 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.
# type: (List[Dict[str, Any]], Any, List[str]) -> None
# Mocking BotHandlerApi
with patch('contrib_bots.bot_lib.BotHandlerApi') as MockClass:
instance = MockClass.return_value
@@ -43,11 +50,13 @@ class BotTestCase(TestCase):
instance.send_reply.assert_called_with(message, response)
def bot_to_run(self, bot_module):
# type: None -> Function
# Returning Any, same argument as in mock_test function.
# type: (str) -> Any
lib_module = get_lib_module(bot_module)
message_handler = lib_module.handler_class()
return message_handler
def bot_test(self, messages, bot_module, bot_response):
# type: (List[Dict[str, Any]], str, List[str]) -> None
message_handler = self.bot_to_run(bot_module)
self.mock_test(messages=messages, message_handler=message_handler, bot_response=bot_response)