xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

bot testing: Set check_expected_responses to test one source at a time.

Browse source 
When testing bots with state and using type="all", it is expected that
the passed-in state will be applied for each source individually.
This commit moves away from alternating between sources for each test,
to running all the tests on each source with a copy of state_handler.
This commit is contained in:
neiljp (Neil Pilgrim) 2017-07-27 18:27:56 -07:00 committed by Tim Abbott
parent 2bd81eaff1
commit bef80129bd
1 changed files with 27 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
zulip_bots/zulip_bots/test_lib.py
View file

@ -24,6 +24,7 @@ from unittest import TestCase
from typing import List, Dict, Any, Optional, Callable from typing import List, Dict, Any, Optional, Callable
from types import ModuleType from types import ModuleType
from copy import deepcopy
class BotTestCase(TestCase): class BotTestCase(TestCase):
bot_name = '' # type: str bot_name = '' # type: str
@ -59,29 +60,37 @@ class BotTestCase(TestCase):
# type: (Union[Sequence[Tuple[str, Any]], Dict[str, Any]], str, str, str, str, int, str, str, Optional[StateHandler]) -> None # type: (Union[Sequence[Tuple[str, Any]], Dict[str, Any]], str, str, str, str, int, str, str, Optional[StateHandler]) -> None
# To test send_message, Any would be a Dict type, # To test send_message, Any would be a Dict type,
# to test send_reply, Any would be a str 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'")
if isinstance(expectations, dict): if isinstance(expectations, dict):
expected = [(k, v) for k, v in expectations.items()] expected = [(k, v) for k, v in expectations.items()]
else: else:
expected = expectations expected = expectations
for m, r in expected:
# For calls with send_reply, r is a string (the content of a message), if type not in ["private", "stream", "all"]:
# so we need to add it to a Dict as the value of 'content'. logging.exception("check_expected_response expects type to be 'private', 'stream' or 'all'")
# For calls with send_message, r is already a Dict. private = {'type': "private", 'display_recipient': recipient,
response = {'content': r} if expected_method == 'send_reply' else r 'sender_email': email, 'sender_id': sender_id,
if type != "stream": 'sender_full_name': sender_full_name}
message = {'content': m, 'type': "private", 'display_recipient': recipient, stream = {'type': "stream", 'display_recipient': recipient,
'sender_email': email, 'sender_id': sender_id, 'subject': subject, 'sender_email': email, 'sender_id': sender_id,
'sender_full_name': sender_full_name} 'sender_full_name': sender_full_name}
sources = []
if type != "stream":
sources.append(private)
if type != "private":
sources.append(stream)
for source in sources:
# A new (copy of) the state_handler is used for each source message.
# This avoids type="all" failing if state is created in the first iteration.
state_h = None if state_handler is None else deepcopy(state_handler)
for m, r in expected:
# 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.
message = dict(source, content = m)
response = {'content': r} if expected_method == 'send_reply' else r
self.assert_bot_response(message=message, response=response, self.assert_bot_response(message=message, response=response,
expected_method=expected_method, state_handler=state_handler) expected_method=expected_method, state_handler=state_h)
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, state_handler=state_handler)
def call_request(self, message, expected_method, response, state_handler): def call_request(self, message, expected_method, response, state_handler):
# type: (Dict[str, Any], str, Dict[str, Any], Optional[StateHandler]) -> None # type: (Dict[str, Any], str, Dict[str, Any], Optional[StateHandler]) -> None