python-telegram-bot/tests/test_commandhandler.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2018
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with this program.  If not, see [http://www.gnu.org/licenses/].
import re
from queue import Queue

import pytest
from telegram.utils.deprecate import TelegramDeprecationWarning

from telegram import (Message, Update, Chat, Bot, User, CallbackQuery, InlineQuery,
                      ChosenInlineResult, ShippingQuery, PreCheckoutQuery, MessageEntity)
from telegram.ext import CommandHandler, Filters, BaseFilter, CallbackContext, JobQueue, \
    PrefixHandler

message = Message(1, User(1, '', False), None, Chat(1, ''), text='test')

params = [
    {'callback_query': CallbackQuery(1, User(1, '', False), 'chat', message=message)},
    {'channel_post': message},
    {'edited_channel_post': message},
    {'inline_query': InlineQuery(1, User(1, '', False), '', '')},
    {'chosen_inline_result': ChosenInlineResult('id', User(1, '', False), '')},
    {'shipping_query': ShippingQuery('id', User(1, '', False), '', None)},
    {'pre_checkout_query': PreCheckoutQuery('id', User(1, '', False), '', 0, '')},
    {'callback_query': CallbackQuery(1, User(1, '', False), 'chat')}
]

ids = ('callback_query', 'channel_post', 'edited_channel_post', 'inline_query',
       'chosen_inline_result', 'shipping_query', 'pre_checkout_query',
       'callback_query_without_message',)


@pytest.fixture(scope='class', params=params, ids=ids)
def false_update(request):
    return Update(update_id=1, **request.param)


@pytest.fixture(scope='function')
def message(bot):
    return Message(message_id=1,
                   from_user=User(id=1, first_name='', is_bot=False),
                   date=None,
                   chat=Chat(id=1, type=''),
                   message='/test',
                   bot=bot,
                   entities=[MessageEntity(type=MessageEntity.BOT_COMMAND,
                                           offset=0,
                                           length=len('/test'))])


class TestCommandHandler(object):
    test_flag = False
    SRE_TYPE = type(re.match("", ""))

    @pytest.fixture(autouse=True)
    def reset(self):
        self.test_flag = False

    def callback_basic(self, bot, update):
        test_bot = isinstance(bot, Bot)
        test_update = isinstance(update, Update)
        self.test_flag = test_bot and test_update

    def callback_data_1(self, bot, update, user_data=None, chat_data=None):
        self.test_flag = (user_data is not None) or (chat_data is not None)

    def callback_data_2(self, bot, update, user_data=None, chat_data=None):
        self.test_flag = (user_data is not None) and (chat_data is not None)

    def callback_queue_1(self, bot, update, job_queue=None, update_queue=None):
        self.test_flag = (job_queue is not None) or (update_queue is not None)

    def callback_queue_2(self, bot, update, job_queue=None, update_queue=None):
        self.test_flag = (job_queue is not None) and (update_queue is not None)

    def ch_callback_args(self, bot, update, args):
        if update.message.text == '/test':
            self.test_flag = len(args) == 0
        elif update.message.text == '/test@{}'.format(bot.username):
            self.test_flag = len(args) == 0
        else:
            self.test_flag = args == ['one', 'two']

    def callback_context(self, update, context):
        self.test_flag = (isinstance(context, CallbackContext)
                          and isinstance(context.bot, Bot)
                          and isinstance(update, Update)
                          and isinstance(context.update_queue, Queue)
                          and isinstance(context.job_queue, JobQueue)
                          and isinstance(context.user_data, dict)
                          and isinstance(context.chat_data, dict)
                          and isinstance(update.message, Message))

    def callback_context_args(self, update, context):
        self.test_flag = context.args == ['one', 'two']

    def callback_context_regex1(self, update, context):
        if context.matches:
            types = all([type(res) == self.SRE_TYPE for res in context.matches])
            num = len(context.matches) == 1
            self.test_flag = types and num

    def callback_context_regex2(self, update, context):
        if context.matches:
            types = all([type(res) == self.SRE_TYPE for res in context.matches])
            num = len(context.matches) == 2
            self.test_flag = types and num

    def test_basic(self, dp, message):
        handler = CommandHandler('test', self.callback_basic)
        dp.add_handler(handler)

        message.text = '/test'
        dp.process_update(Update(0, message))
        assert self.test_flag

        message.text = '/nottest'
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

        message.text = 'test'
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

        message.text = 'not /test at start'
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

        message.entities = []
        message.text = '/test'
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

    @pytest.mark.parametrize('command',
                             ['way_too_longcommand1234567yes_way_toooooooLong', 'ïñválídletters',
                              'invalid #&* chars'],
                             ids=['too long', 'invalid letter', 'invalid characters'])
    def test_invalid_commands(self, command):
        with pytest.raises(ValueError, match='not a valid bot command'):
            CommandHandler(command, self.callback_basic)

    def test_command_list(self, message):
        handler = CommandHandler(['test', 'star'], self.callback_basic)

        message.text = '/test'
        check = handler.check_update(Update(0, message))

        message.text = '/star'
        check = handler.check_update(Update(0, message))

        message.text = '/stop'
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

    def test_deprecation_warning(self):
        with pytest.warns(TelegramDeprecationWarning, match='See https://git.io/fxJuV'):
            CommandHandler('test', self.callback_basic, allow_edited=True)

    def test_no_edited(self, message):
        handler = CommandHandler('test', self.callback_basic)
        message.text = '/test'
        check = handler.check_update(Update(0, message))
        assert check is not None and check is not False

        check = handler.check_update(Update(0, edited_message=message))
        assert check is not None and check is not False

        handler = CommandHandler('test', self.callback_basic,
                                 filters=~Filters.update.edited_message)
        check = handler.check_update(Update(0, message))
        assert check is not None and check is not False

        check = handler.check_update(Update(0, edited_message=message))
        assert check is None or check is False

    def test_edited_deprecated(self, message):
        handler = CommandHandler('test', self.callback_basic,
                                 allow_edited=False)
        message.text = '/test'
        check = handler.check_update(Update(0, message))
        assert check is not None and check is not False

        check = handler.check_update(Update(0, edited_message=message))
        assert check is None or check is False

        handler = CommandHandler('test', self.callback_basic,
                                 allow_edited=True)
        check = handler.check_update(Update(0, message))
        assert check is not None and check is not False

        check = handler.check_update(Update(0, edited_message=message))
        assert check is not None and check is not False

    def test_directed_commands(self, message):
        handler = CommandHandler('test', self.callback_basic)

        message.text = '/test@{}'.format(message.bot.username)
        message.entities[0].length = len(message.text)
        check = handler.check_update(Update(0, message))
        assert check is not None and check is not False

        message.text = '/test@otherbot'
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

    def test_with_filter(self, message):
        handler = CommandHandler('test', self.callback_basic, Filters.group)

        message.chat = Chat(-23, 'group')
        message.text = '/test'
        check = handler.check_update(Update(0, message))
        assert check is not None and check is not False

        message.chat = Chat(23, 'private')
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

    def test_pass_args(self, dp, message):
        handler = CommandHandler('test', self.ch_callback_args, pass_args=True)
        dp.add_handler(handler)

        message.text = '/test'
        dp.process_update(Update(0, message=message))
        assert self.test_flag

        self.test_flag = False
        message.text = '/test@{}'.format(message.bot.username)
        message.entities[0].length = len(message.text)
        dp.process_update(Update(0, message=message))
        assert self.test_flag

        self.test_flag = False
        message.text = '/test@{} one two'.format(message.bot.username)
        dp.process_update(Update(0, message=message))
        assert self.test_flag

        self.test_flag = False
        message.text = '/test one two'
        message.entities[0].length = len('/test')
        dp.process_update(Update(0, message=message))
        assert self.test_flag

    def test_newline(self, dp, message):
        handler = CommandHandler('test', self.callback_basic)
        dp.add_handler(handler)

        message.text = '/test\nfoobar'
        check = handler.check_update(Update(0, message))
        assert check is not None and check is not False

        dp.process_update(Update(0, message))
        assert self.test_flag

    def test_pass_user_or_chat_data(self, dp, message):
        handler = CommandHandler('test', self.callback_data_1,
                                 pass_user_data=True)
        dp.add_handler(handler)

        message.text = '/test'
        dp.process_update(Update(0, message=message))
        assert self.test_flag

        dp.remove_handler(handler)
        handler = CommandHandler('test', self.callback_data_1,
                                 pass_chat_data=True)
        dp.add_handler(handler)

        self.test_flag = False
        dp.process_update(Update(0, message=message))
        assert self.test_flag

        dp.remove_handler(handler)
        handler = CommandHandler('test', self.callback_data_2,
                                 pass_chat_data=True,
                                 pass_user_data=True)
        dp.add_handler(handler)

        self.test_flag = False
        dp.process_update(Update(0, message=message))
        assert self.test_flag

    def test_pass_job_or_update_queue(self, dp, message):
        handler = CommandHandler('test', self.callback_queue_1,
                                 pass_job_queue=True)
        dp.add_handler(handler)

        message.text = '/test'
        dp.process_update(Update(0, message=message))
        assert self.test_flag

        dp.remove_handler(handler)
        handler = CommandHandler('test', self.callback_queue_1,
                                 pass_update_queue=True)
        dp.add_handler(handler)

        self.test_flag = False
        dp.process_update(Update(0, message=message))
        assert self.test_flag

        dp.remove_handler(handler)
        handler = CommandHandler('test', self.callback_queue_2,
                                 pass_job_queue=True,
                                 pass_update_queue=True)
        dp.add_handler(handler)

        self.test_flag = False
        dp.process_update(Update(0, message=message))
        assert self.test_flag

    def test_other_update_types(self, false_update):
        handler = CommandHandler('test', self.callback_basic)
        check = handler.check_update(false_update)
        assert check is None or check is False

    def test_filters_for_wrong_command(self, message):
        """Filters should not be executed if the command does not match the handler"""

        class TestFilter(BaseFilter):
            def __init__(self):
                self.tested = False

            def filter(self, message):
                self.tested = True

        test_filter = TestFilter()

        handler = CommandHandler('test', self.callback_basic,
                                 filters=test_filter)
        message.text = '/star'

        check = handler.check_update(Update(0, message=message))
        assert check is None or check is False

        assert not test_filter.tested

    def test_context(self, cdp, message):
        handler = CommandHandler('test', self.callback_context)
        cdp.add_handler(handler)

        message.text = '/test'
        cdp.process_update(Update(0, message))
        assert self.test_flag

    def test_context_args(self, cdp, message):
        handler = CommandHandler('test', self.callback_context_args)
        cdp.add_handler(handler)

        message.text = '/test'
        cdp.process_update(Update(0, message))
        assert not self.test_flag

        message.text = '/test one two'
        cdp.process_update(Update(0, message))
        assert self.test_flag

    def test_context_regex(self, cdp, message):
        handler = CommandHandler('test', self.callback_context_regex1, Filters.regex('one two'))
        cdp.add_handler(handler)

        message.text = '/test'
        cdp.process_update(Update(0, message))
        assert not self.test_flag

        message.text += ' one two'
        cdp.process_update(Update(0, message))
        assert self.test_flag

    def test_context_multiple_regex(self, cdp, message):
        handler = CommandHandler('test', self.callback_context_regex2,
                                 Filters.regex('one') & Filters.regex('two'))
        cdp.add_handler(handler)

        message.text = '/test'
        cdp.process_update(Update(0, message))
        assert not self.test_flag

        message.text += ' one two'
        cdp.process_update(Update(0, message))
        assert self.test_flag


par = ['!help', '!test', '#help', '#test', 'mytrig-help', 'mytrig-test']


@pytest.fixture(scope='function', params=par)
def prefixmessage(bot, request):
    return Message(message_id=1,
                   from_user=User(id=1, first_name='', is_bot=False),
                   date=None,
                   chat=Chat(id=1, type=''),
                   text=request.param,
                   bot=bot)


class TestPrefixHandler(object):
    test_flag = False
    SRE_TYPE = type(re.match("", ""))

    @pytest.fixture(autouse=True)
    def reset(self):
        self.test_flag = False

    def callback_basic(self, bot, update):
        test_bot = isinstance(bot, Bot)
        test_update = isinstance(update, Update)
        self.test_flag = test_bot and test_update

    def callback_data_1(self, bot, update, user_data=None, chat_data=None):
        self.test_flag = (user_data is not None) or (chat_data is not None)

    def callback_data_2(self, bot, update, user_data=None, chat_data=None):
        self.test_flag = (user_data is not None) and (chat_data is not None)

    def callback_queue_1(self, bot, update, job_queue=None, update_queue=None):
        self.test_flag = (job_queue is not None) or (update_queue is not None)

    def callback_queue_2(self, bot, update, job_queue=None, update_queue=None):
        self.test_flag = (job_queue is not None) and (update_queue is not None)

    def ch_callback_args(self, bot, update, args):
        if update.message.text in par:
            self.test_flag = len(args) == 0
        else:
            self.test_flag = args == ['one', 'two']

    def callback_context(self, update, context):
        self.test_flag = (isinstance(context, CallbackContext)
                          and isinstance(context.bot, Bot)
                          and isinstance(update, Update)
                          and isinstance(context.update_queue, Queue)
                          and isinstance(context.job_queue, JobQueue)
                          and isinstance(context.user_data, dict)
                          and isinstance(context.chat_data, dict)
                          and isinstance(update.message, Message))

    def callback_context_args(self, update, context):
        self.test_flag = context.args == ['one', 'two']

    def callback_context_regex1(self, update, context):
        if context.matches:
            types = all([type(res) == self.SRE_TYPE for res in context.matches])
            num = len(context.matches) == 1
            self.test_flag = types and num

    def callback_context_regex2(self, update, context):
        if context.matches:
            types = all([type(res) == self.SRE_TYPE for res in context.matches])
            num = len(context.matches) == 2
            self.test_flag = types and num

    def test_basic(self, dp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_basic)
        dp.add_handler(handler)

        dp.process_update(Update(0, prefixmessage))
        assert self.test_flag

        prefixmessage.text = 'test'
        check = handler.check_update(Update(0, prefixmessage))
        assert check is None or check is False

        prefixmessage.text = '#nocom'
        check = handler.check_update(Update(0, prefixmessage))
        assert check is None or check is False

        message.text = 'not !test at start'
        check = handler.check_update(Update(0, message))
        assert check is None or check is False

    def test_single_prefix_single_command(self, prefixmessage):
        handler = PrefixHandler('!', 'test', self.callback_basic)

        check = handler.check_update(Update(0, prefixmessage))
        if prefixmessage.text in ['!test']:
            assert check is not None and check is not False
        else:
            assert check is None or check is False

    def test_single_prefix_multi_command(self, prefixmessage):
        handler = PrefixHandler('!', ['test', 'help'], self.callback_basic)

        check = handler.check_update(Update(0, prefixmessage))
        if prefixmessage.text in ['!test', '!help']:
            assert check is not None and check is not False
        else:
            assert check is None or check is False

    def test_multi_prefix_single_command(self, prefixmessage):
        handler = PrefixHandler(['!', '#'], 'test', self.callback_basic)

        check = handler.check_update(Update(0, prefixmessage))
        if prefixmessage.text in ['!test', '#test']:
            assert check is not None and check is not False
        else:
            assert check is None or check is False

    def test_no_edited(self, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_basic)
        check = handler.check_update(Update(0, prefixmessage))
        assert check is not None and check is not False

        check = handler.check_update(Update(0, edited_message=prefixmessage))
        assert check is not None and check is not False

        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_basic,
                                filters=~Filters.update.edited_message)
        check = handler.check_update(Update(0, prefixmessage))
        assert check is not None and check is not False

        check = handler.check_update(Update(0, edited_message=prefixmessage))
        assert check is None or check is False

    def test_with_filter(self, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_basic,
                                filters=Filters.group)

        prefixmessage.chat = Chat(-23, 'group')
        check = handler.check_update(Update(0, prefixmessage))
        assert check is not None and check is not False

        prefixmessage.chat = Chat(23, 'private')
        check = handler.check_update(Update(0, prefixmessage))
        assert check is None or check is False

    def test_pass_args(self, dp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.ch_callback_args,
                                pass_args=True)
        dp.add_handler(handler)

        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

        self.test_flag = False
        prefixmessage.text += ' one two'
        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

    def test_pass_user_or_chat_data(self, dp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_data_1,
                                pass_user_data=True)
        dp.add_handler(handler)

        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

        dp.remove_handler(handler)
        self.test_flag = False
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_data_1,
                                pass_chat_data=True)
        dp.add_handler(handler)
        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

        dp.remove_handler(handler)
        self.test_flag = False
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_data_2,
                                pass_chat_data=True, pass_user_data=True)
        dp.add_handler(handler)
        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

    def test_pass_job_or_update_queue(self, dp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_queue_1,
                                pass_job_queue=True)
        dp.add_handler(handler)

        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

        dp.remove_handler(handler)
        self.test_flag = False
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_queue_1,
                                pass_update_queue=True)
        dp.add_handler(handler)
        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

        dp.remove_handler(handler)
        self.test_flag = False
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_queue_2,
                                pass_job_queue=True, pass_update_queue=True)
        dp.add_handler(handler)
        dp.process_update(Update(0, message=prefixmessage))
        assert self.test_flag

    def test_other_update_types(self, false_update):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_basic)
        check = handler.check_update(false_update)
        assert check is None or check is False

    def test_filters_for_wrong_command(self, prefixmessage):
        """Filters should not be executed if the command does not match the handler"""

        class TestFilter(BaseFilter):
            def __init__(self):
                self.tested = False

            def filter(self, message):
                self.tested = True

        test_filter = TestFilter()

        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_basic,
                                filters=test_filter)

        prefixmessage.text = '/star'

        check = handler.check_update(Update(0, message=prefixmessage))
        assert check is None or check is False

        assert not test_filter.tested

    def test_context(self, cdp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'], self.callback_context)
        cdp.add_handler(handler)

        cdp.process_update(Update(0, prefixmessage))
        assert self.test_flag

    def test_context_args(self, cdp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'],
                                self.callback_context_args)
        cdp.add_handler(handler)

        cdp.process_update(Update(0, prefixmessage))
        assert not self.test_flag

        prefixmessage.text += ' one two'
        cdp.process_update(Update(0, prefixmessage))
        assert self.test_flag

    def test_context_regex(self, cdp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'],
                                self.callback_context_regex1, Filters.regex('one two'))
        cdp.add_handler(handler)

        cdp.process_update(Update(0, prefixmessage))
        assert not self.test_flag

        prefixmessage.text += ' one two'
        cdp.process_update(Update(0, prefixmessage))
        assert self.test_flag

    def test_context_multiple_regex(self, cdp, prefixmessage):
        handler = PrefixHandler(['!', '#', 'mytrig-'], ['help', 'test'],
                                self.callback_context_regex2,
                                Filters.regex('one') & Filters.regex('two'))
        cdp.add_handler(handler)

        cdp.process_update(Update(0, prefixmessage))
        assert not self.test_flag

        prefixmessage.text += ' one two'
        cdp.process_update(Update(0, prefixmessage))
        assert self.test_flag