def test_ask(self):
logging.info("******** ask")
class MyBot(FakeBot):
def say(self, message, **kwargs):
self.engine.set('said', message)
self.bot = MyBot(engine=self.engine)
self.bot.subscriber = self.engine.bus.subscribe('*id')
self.bot.publisher = self.engine.publisher
machine = Input(bot=self.bot,
question="What's up, Doc?")
machine.listen = mock.Mock()
machine.ask()
self.assertEqual(self.engine.get('said'), machine.question)
machine.listen.assert_called_with()
machine = Input(bot=self.bot,
question_content="What's *up*, Doc?")
machine.listen = mock.Mock()
machine.ask()
self.assertEqual(self.engine.get('said'), ' ')
machine.listen.assert_called_with()
def test_delayed(self):
logging.info("******** delayed")
store = MemoryStore()
class MyBot(FakeBot):
def say(self, message):
self.engine.set('said', message)
self.bot = MyBot(engine=self.engine, store=store)
self.bot.subscriber = self.engine.bus.subscribe('*id')
self.bot.publisher = self.engine.publisher
machine = Input(bot=self.bot,
question="What's up, Doc?",
key='my.input')
machine.RETRY_DELAY = 0.01
p = machine.start(tick=0.001)
time.sleep(0.03)
self.bot.fan.put('here we go')
p.join()
self.assertEqual(self.bot.recall('input'), {u'my.input': u'here we go'})
self.assertEqual(self.engine.get('said'), machine.ANSWER_MESSAGE)
def test_on_input(self):
logging.info("******** on_input")
machine = Input(bot=self.bot,
question="What's up, Doc?")
machine.on_input(value='ok!')
def test_listen(self):
logging.info("******** listen")
machine = Input(bot=self.bot,
question="What's up, Doc?")
self.engine.set('general.switch', 'off')
p = machine.listen()
p.join()
def get_machine(self, bot):
return Input(bot=bot,
question="PO number please?",
mask="9999A",
on_retry="PO number should have 4 digits and a letter",
on_answer="Ok, PO number has been noted: {}",
on_cancel="Ok, forget about the PO number",
key='order.id')
def test_elapsed(self):
logging.info("******** elapsed")
machine = Input(bot=self.bot,
question="What's up, Doc?")
time.sleep(0.01)
self.assertTrue(machine.elapsed > 0.01)
def test_cancelled(self):
logging.info("******** cancelled")
class MyBot(FakeBot):
def say(self, message):
self.engine.set('said', message)
self.bot = MyBot(engine=self.engine)
self.bot.subscriber = self.engine.bus.subscribe('*id')
self.bot.publisher = self.engine.publisher
self.engine.set('my.input', '*void')
machine = Input(bot=self.bot,
question="What's up, Doc?",
key='my.input')
machine.CANCEL_DELAY = 0.02
machine.RETRY_DELAY = 0.01
machine.TICK_DURATION = 0.001
p = machine.start()
p.join()
self.assertEqual(self.engine.get('my.input'), '*void')
self.assertEqual(self.engine.get('said'), machine.CANCEL_MESSAGE)
def test_cancel(self):
logging.info("******** cancel")
machine = Input(bot=self.bot,
question="What's up, Doc?")
machine.say_cancel = mock.Mock()
machine.stop = mock.Mock()
machine.cancel()
self.assertTrue(machine.say_cancel.called)
self.assertTrue(machine.stop.called)
def test_filter(self):
logging.info("******** filter")
machine = Input(bot=self.bot,
question="What's up, Doc?")
self.assertEqual(machine.filter('hello world'), 'hello world')
machine.mask = '999A'
self.assertEqual(machine.filter('hello world'), None)
self.assertEqual(machine.filter('PO: 1324'), '1324')
def test_say_answer(self):
logging.info("******** say_answer")
class MyBot(FakeBot):
def on_init(self):
self.said = []
def say(self, message, content=None, file=None):
if message:
self.said.append(message)
if content:
self.said.append(content)
if file:
self.said.append(file)
self.bot = MyBot(engine=self.engine)
self.bot.subscriber = self.engine.bus.subscribe('*id')
self.bot.publisher = self.engine.publisher
machine = Input(bot=self.bot,
question="What's up, Doc?")
self.bot.said = []
machine.say_answer('*test')
self.assertEqual(
self.bot.said,
[machine.ANSWER_MESSAGE])
machine = Input(bot=self.bot,
question="What's up, Doc?",
on_answer="ok for {}",
on_answer_content="*ok* for {}",
on_answer_file="/file/to/upload.pdf",
)
self.bot.said = []
machine.say_answer('*test')
self.assertEqual(
self.bot.said,
['ok for *test', ' ', '*ok* for *test', '/file/to/upload.pdf'])
def test_say_cancel(self):
logging.info("******** say_cancel")
class MyBot(FakeBot):
def on_init(self):
self.said = []
def say(self, message, content=None, file=None):
if message:
self.said.append(message)
if content:
self.said.append(content)
if file:
self.said.append(file)
self.bot = MyBot(engine=self.engine)
self.bot.subscriber = self.engine.bus.subscribe('*id')
self.bot.publisher = self.engine.publisher
machine = Input(bot=self.bot,
question="What's up, Doc?")
self.bot.said = []
machine.say_cancel()
self.assertEqual(
self.bot.said,
[machine.CANCEL_MESSAGE])
machine = Input(bot=self.bot,
question="What's up, Doc?",
on_cancel="Ok, forget about it",
on_cancel_content="*cancelled*",
on_cancel_file="/file/to/upload.pdf",
)
self.bot.said = []
machine.say_cancel()
self.assertEqual(
self.bot.said,
['Ok, forget about it', ' ', '*cancelled*', '/file/to/upload.pdf'])
def test_say_retry(self):
logging.info("******** say_retry")
class MyBot(FakeBot):
def on_init(self):
self.said = []
def say(self, message, content=None, file=None):
if message:
self.said.append(message)
if content:
self.said.append(content)
if file:
self.said.append(file)
self.bot = MyBot(engine=self.engine)
machine = Input(bot=self.bot,
question="What's up, Doc?")
self.bot.said = []
machine.say_retry()
self.assertEqual(
self.bot.said,
[machine.RETRY_MESSAGE])
machine = Input(bot=self.bot,
question="What's up, Doc?",
on_retry="please retry",
on_retry_content="please *retry*",
on_retry_file="/file/to/upload.pdf",
)
self.bot.said = []
machine.say_retry()
self.assertEqual(
self.bot.said,
['please retry', ' ', 'please *retry*', '/file/to/upload.pdf'])
from shellbot import Engine, Context
from shellbot.machines import Input, Sequence
if __name__ == '__main__':
Context.set_logger()
engine = Engine(type='local', command='shellbot.commands.input')
engine.configure() # ensure that all components are ready
bot = engine.get_bot() # get generic group channel for this bot
order_id = Input( # use a mask to validate input
bot=bot,
question="PO number please?",
mask="9999A",
on_answer="Ok, PO number has been noted: {}",
on_retry="PO number should have 4 digits and a letter",
on_cancel="Ok, forget about the PO number",
key='order.id')
description = Input( # free form
bot=bot,
question="Issue description please?",
on_answer="Ok, description noted: {}",
on_retry="Please enter a one-line description of the issue",
on_cancel="Ok, forget about the description",
key='description')
sequence = Sequence(machines=[order_id, description])
sequence.start()
def test_init(self):
logging.info("******** init")
with self.assertRaises(AssertionError):
machine = Input(bot=self.bot) # missing question
with self.assertRaises(AssertionError):
machine = Input(bot=self.bot, # too many args
question="What's up, Doc?",
mask="*mask",
regex="*regex")
machine = Input(bot=self.bot,
question="What's up, Doc?")
self.assertEqual(machine.bot, self.bot)
self.assertEqual(machine.question, "What's up, Doc?")
self.assertEqual(machine.question_content, None)
self.assertEqual(machine.on_answer, None)
self.assertEqual(machine.on_answer_content, None)
self.assertEqual(machine.on_answer_file, None)
self.assertEqual(machine.on_retry, None)
self.assertEqual(machine.on_retry_content, None)
self.assertEqual(machine.on_retry_file, None)
self.assertEqual(machine.on_cancel, None)
self.assertEqual(machine.on_cancel_content, None)
self.assertEqual(machine.on_cancel_file, None)
self.assertEqual(machine.is_mandatory, False)
self.assertEqual(machine.key, None)
self.assertEqual(sorted(machine._states.keys()),
['begin', 'delayed', 'end', 'waiting'])
self.assertEqual(sorted(machine._transitions.keys()),
['begin', 'delayed', 'waiting'])
machine = Input(bot=self.bot,
question_content="What's *up*, Doc?")
self.assertEqual(machine.question, None)
self.assertEqual(machine.question_content, "What's *up*, Doc?")
machine = Input(bot=self.bot,
question="What's up, Doc?",
mask="*mask")
self.assertEqual(machine.mask, "*mask")
machine = Input(bot=self.bot,
question="What's up, Doc?",
regex="*regex",
on_answer="ok for {}",
on_answer_content="*ok* for {}",
on_answer_file="/file/to/upload.pdf",
on_retry="please retry",
on_retry_content="please *retry*",
on_retry_file="/file/to/upload.pdf",
on_cancel="Ok, forget about it",
on_cancel_content="*cancelled*",
on_cancel_file="/file/to/upload.pdf",
is_mandatory=True,
retry_delay=9,
cancel_delay=99,
key='rabbit.input')
self.assertEqual(machine.bot, self.bot)
self.assertEqual(machine.question, "What's up, Doc?")
self.assertEqual(machine.mask, None)
self.assertEqual(machine.regex, "*regex")
self.assertEqual(machine.on_answer, "ok for {}")
self.assertEqual(machine.on_answer_content, "*ok* for {}")
self.assertEqual(machine.on_answer_file, "/file/to/upload.pdf")
self.assertEqual(machine.on_retry, "please retry")
self.assertEqual(machine.on_retry_content, "please *retry*")
self.assertEqual(machine.on_retry_file, "/file/to/upload.pdf")
self.assertEqual(machine.on_cancel, "Ok, forget about it")
self.assertEqual(machine.on_cancel_content, "*cancelled*")
self.assertEqual(machine.on_cancel_file, "/file/to/upload.pdf")
self.assertEqual(machine.is_mandatory, True)
self.assertEqual(machine.RETRY_DELAY, 9)
self.assertEqual(machine.CANCEL_DELAY, 99)
self.assertEqual(machine.key, 'rabbit.input')
def test_execute(self):
logging.info("******** execute")
bot = FakeBot(engine=self.engine)
bot.store = mock.Mock()
bot.say = mock.Mock()
bot.subscriber = self.engine.bus.subscribe('*id')
bot.publisher = self.engine.publisher
machine = Input(bot=bot,
question="What's up, Doc?",
key='my.key')
self.assertEqual(machine.get('answer'), None)
machine.step() # send the question
machine.step = mock.Mock()
machine.execute(arguments=None)
bot.say.assert_called_with(machine.RETRY_MESSAGE)
self.assertEqual(machine.get('answer'), None)
self.assertFalse(machine.step.called)
machine.execute(arguments='')
bot.say.assert_called_with(machine.RETRY_MESSAGE)
self.assertEqual(machine.get('answer'), None)
self.assertFalse(machine.step.called)
machine.execute(arguments='something at least')
bot.say.assert_called_with(machine.ANSWER_MESSAGE)
self.assertTrue(machine.step.called)
machine.filter = mock.Mock(return_value=None)
machine.step = mock.Mock()
machine.execute(arguments='something else')
bot.say.assert_called_with(machine.RETRY_MESSAGE)
self.assertFalse(machine.step.called)
def test_search_expression(self):
logging.info("******** search_expression")
machine = Input(bot=self.bot,
question="What's up, Doc?")
with self.assertRaises(AssertionError):
machine.search_expression(None, 'hello world')
with self.assertRaises(AssertionError):
machine.search_expression('', 'hello world')
id = r'ID-\d\w\d+' # match with a direct pattern
with self.assertRaises(AssertionError):
machine.search_expression(id, None)
with self.assertRaises(AssertionError):
machine.search_expression(id, '')
self.assertEqual(
machine.search_expression(id, 'hello world'), None)
self.assertEqual(
machine.search_expression(id, 'The id is ID-1W27 I believe'),
'ID-1W27')
email_domain = r'@([\w.]+)' # match with a group
with self.assertRaises(AssertionError):
machine.search_expression(email_domain, None)
with self.assertRaises(AssertionError):
machine.search_expression(email_domain, '')
self.assertEqual(
machine.search_expression(email_domain, 'hello world'), None)
self.assertEqual(
machine.search_expression(
email_domain, 'my address is [email protected]'), 'acme.com')
def test_search_mask(self):
logging.info("******** search_mask")
machine = Input(bot=self.bot,
question="What's up, Doc?")
with self.assertRaises(AssertionError):
machine.search_mask(None, 'hello world')
with self.assertRaises(AssertionError):
machine.search_mask('', 'hello world')
with self.assertRaises(AssertionError):
machine.search_mask('999A', None)
with self.assertRaises(AssertionError):
machine.search_mask('999A', '')
self.assertEqual(machine.search_mask('999A', 'hello world'), None)
self.assertEqual(machine.search_mask('999A', 'PO: 1324'), '1324')