#!/usr/bin/env python # # A library that provides a Python interface to the Telegram Bot API # Copyright (C) 2015-2021 # Leandro Toledo de Souza # # 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 pytest from telegram import Update, User, Bot from telegram.utils.helpers import escape_markdown from tests.conftest import check_shortcut_signature, check_shortcut_call, check_defaults_handling @pytest.fixture(scope='function') def json_dict(): return { 'id': TestUser.id_, 'is_bot': TestUser.is_bot, 'first_name': TestUser.first_name, 'last_name': TestUser.last_name, 'username': TestUser.username, 'language_code': TestUser.language_code, 'can_join_groups': TestUser.can_join_groups, 'can_read_all_group_messages': TestUser.can_read_all_group_messages, 'supports_inline_queries': TestUser.supports_inline_queries, } @pytest.fixture(scope='function') def user(bot): return User( id=TestUser.id_, first_name=TestUser.first_name, is_bot=TestUser.is_bot, last_name=TestUser.last_name, username=TestUser.username, language_code=TestUser.language_code, can_join_groups=TestUser.can_join_groups, can_read_all_group_messages=TestUser.can_read_all_group_messages, supports_inline_queries=TestUser.supports_inline_queries, bot=bot, ) class TestUser: id_ = 1 is_bot = True first_name = 'first\u2022name' last_name = 'last\u2022name' username = 'username' language_code = 'en_us' can_join_groups = True can_read_all_group_messages = True supports_inline_queries = False def test_de_json(self, json_dict, bot): user = User.de_json(json_dict, bot) assert user.id == self.id_ assert user.is_bot == self.is_bot assert user.first_name == self.first_name assert user.last_name == self.last_name assert user.username == self.username assert user.language_code == self.language_code assert user.can_join_groups == self.can_join_groups assert user.can_read_all_group_messages == self.can_read_all_group_messages assert user.supports_inline_queries == self.supports_inline_queries def test_de_json_without_username(self, json_dict, bot): del json_dict['username'] user = User.de_json(json_dict, bot) assert user.id == self.id_ assert user.is_bot == self.is_bot assert user.first_name == self.first_name assert user.last_name == self.last_name assert user.username is None assert user.language_code == self.language_code assert user.can_join_groups == self.can_join_groups assert user.can_read_all_group_messages == self.can_read_all_group_messages assert user.supports_inline_queries == self.supports_inline_queries def test_de_json_without_username_and_last_name(self, json_dict, bot): del json_dict['username'] del json_dict['last_name'] user = User.de_json(json_dict, bot) assert user.id == self.id_ assert user.is_bot == self.is_bot assert user.first_name == self.first_name assert user.last_name is None assert user.username is None assert user.language_code == self.language_code assert user.can_join_groups == self.can_join_groups assert user.can_read_all_group_messages == self.can_read_all_group_messages assert user.supports_inline_queries == self.supports_inline_queries def test_name(self, user): assert user.name == '@username' user.username = None assert user.name == 'first\u2022name last\u2022name' user.last_name = None assert user.name == 'first\u2022name' user.username = self.username assert user.name == '@username' def test_full_name(self, user): assert user.full_name == 'first\u2022name last\u2022name' user.last_name = None assert user.full_name == 'first\u2022name' def test_link(self, user): assert user.link == f'https://t.me/{user.username}' user.username = None assert user.link is None def test_instance_method_get_profile_photos(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['user_id'] == user.id assert check_shortcut_signature( User.get_profile_photos, Bot.get_user_profile_photos, ['user_id'], [] ) assert check_shortcut_call(user.get_profile_photos, user.bot, 'get_user_profile_photos') assert check_defaults_handling(user.get_profile_photos, user.bot) monkeypatch.setattr(user.bot, 'get_user_profile_photos', make_assertion) assert user.get_profile_photos() def test_instance_method_pin_message(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id assert check_shortcut_signature(User.pin_message, Bot.pin_chat_message, ['chat_id'], []) assert check_shortcut_call(user.pin_message, user.bot, 'pin_chat_message') assert check_defaults_handling(user.pin_message, user.bot) monkeypatch.setattr(user.bot, 'pin_chat_message', make_assertion) assert user.pin_message(1) def test_instance_method_unpin_message(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id assert check_shortcut_signature( User.unpin_message, Bot.unpin_chat_message, ['chat_id'], [] ) assert check_shortcut_call(user.unpin_message, user.bot, 'unpin_chat_message') assert check_defaults_handling(user.unpin_message, user.bot) monkeypatch.setattr(user.bot, 'unpin_chat_message', make_assertion) assert user.unpin_message() def test_instance_method_unpin_all_messages(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id assert check_shortcut_signature( User.unpin_all_messages, Bot.unpin_all_chat_messages, ['chat_id'], [] ) assert check_shortcut_call(user.unpin_all_messages, user.bot, 'unpin_all_chat_messages') assert check_defaults_handling(user.unpin_all_messages, user.bot) monkeypatch.setattr(user.bot, 'unpin_all_chat_messages', make_assertion) assert user.unpin_all_messages() def test_instance_method_send_message(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['text'] == 'test' assert check_shortcut_signature(User.send_message, Bot.send_message, ['chat_id'], []) assert check_shortcut_call(user.send_message, user.bot, 'send_message') assert check_defaults_handling(user.send_message, user.bot) monkeypatch.setattr(user.bot, 'send_message', make_assertion) assert user.send_message('test') def test_instance_method_send_photo(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['photo'] == 'test_photo' assert check_shortcut_signature(User.send_photo, Bot.send_photo, ['chat_id'], []) assert check_shortcut_call(user.send_photo, user.bot, 'send_photo') assert check_defaults_handling(user.send_photo, user.bot) monkeypatch.setattr(user.bot, 'send_photo', make_assertion) assert user.send_photo('test_photo') def test_instance_method_send_media_group(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['media'] == 'test_media_group' assert check_shortcut_signature( User.send_media_group, Bot.send_media_group, ['chat_id'], [] ) assert check_shortcut_call(user.send_media_group, user.bot, 'send_media_group') assert check_defaults_handling(user.send_media_group, user.bot) monkeypatch.setattr(user.bot, 'send_media_group', make_assertion) assert user.send_media_group('test_media_group') def test_instance_method_send_audio(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['audio'] == 'test_audio' assert check_shortcut_signature(User.send_audio, Bot.send_audio, ['chat_id'], []) assert check_shortcut_call(user.send_audio, user.bot, 'send_audio') assert check_defaults_handling(user.send_audio, user.bot) monkeypatch.setattr(user.bot, 'send_audio', make_assertion) assert user.send_audio('test_audio') def test_instance_method_send_chat_action(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['action'] == 'test_chat_action' assert check_shortcut_signature( User.send_chat_action, Bot.send_chat_action, ['chat_id'], [] ) assert check_shortcut_call(user.send_chat_action, user.bot, 'send_chat_action') assert check_defaults_handling(user.send_chat_action, user.bot) monkeypatch.setattr(user.bot, 'send_chat_action', make_assertion) assert user.send_chat_action('test_chat_action') def test_instance_method_send_contact(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['phone_number'] == 'test_contact' assert check_shortcut_signature(User.send_contact, Bot.send_contact, ['chat_id'], []) assert check_shortcut_call(user.send_contact, user.bot, 'send_contact') assert check_defaults_handling(user.send_contact, user.bot) monkeypatch.setattr(user.bot, 'send_contact', make_assertion) assert user.send_contact(phone_number='test_contact') def test_instance_method_send_dice(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['emoji'] == 'test_dice' assert check_shortcut_signature(User.send_dice, Bot.send_dice, ['chat_id'], []) assert check_shortcut_call(user.send_dice, user.bot, 'send_dice') assert check_defaults_handling(user.send_dice, user.bot) monkeypatch.setattr(user.bot, 'send_dice', make_assertion) assert user.send_dice(emoji='test_dice') def test_instance_method_send_document(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['document'] == 'test_document' assert check_shortcut_signature(User.send_document, Bot.send_document, ['chat_id'], []) assert check_shortcut_call(user.send_document, user.bot, 'send_document') assert check_defaults_handling(user.send_document, user.bot) monkeypatch.setattr(user.bot, 'send_document', make_assertion) assert user.send_document('test_document') def test_instance_method_send_game(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['game_short_name'] == 'test_game' assert check_shortcut_signature(User.send_game, Bot.send_game, ['chat_id'], []) assert check_shortcut_call(user.send_game, user.bot, 'send_game') assert check_defaults_handling(user.send_game, user.bot) monkeypatch.setattr(user.bot, 'send_game', make_assertion) assert user.send_game(game_short_name='test_game') def test_instance_method_send_invoice(self, monkeypatch, user): def make_assertion(*_, **kwargs): title = kwargs['title'] == 'title' description = kwargs['description'] == 'description' payload = kwargs['payload'] == 'payload' provider_token = kwargs['provider_token'] == 'provider_token' start_parameter = kwargs['start_parameter'] == 'start_parameter' currency = kwargs['currency'] == 'currency' prices = kwargs['prices'] == 'prices' args = ( title and description and payload and provider_token and start_parameter and currency and prices ) return kwargs['chat_id'] == user.id and args assert check_shortcut_signature(User.send_invoice, Bot.send_invoice, ['chat_id'], []) assert check_shortcut_call(user.send_invoice, user.bot, 'send_invoice') assert check_defaults_handling(user.send_invoice, user.bot) monkeypatch.setattr(user.bot, 'send_invoice', make_assertion) assert user.send_invoice( 'title', 'description', 'payload', 'provider_token', 'start_parameter', 'currency', 'prices', ) def test_instance_method_send_location(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['latitude'] == 'test_location' assert check_shortcut_signature(User.send_location, Bot.send_location, ['chat_id'], []) assert check_shortcut_call(user.send_location, user.bot, 'send_location') assert check_defaults_handling(user.send_location, user.bot) monkeypatch.setattr(user.bot, 'send_location', make_assertion) assert user.send_location('test_location') def test_instance_method_send_sticker(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['sticker'] == 'test_sticker' assert check_shortcut_signature(User.send_sticker, Bot.send_sticker, ['chat_id'], []) assert check_shortcut_call(user.send_sticker, user.bot, 'send_sticker') assert check_defaults_handling(user.send_sticker, user.bot) monkeypatch.setattr(user.bot, 'send_sticker', make_assertion) assert user.send_sticker('test_sticker') def test_instance_method_send_video(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['video'] == 'test_video' assert check_shortcut_signature(User.send_video, Bot.send_video, ['chat_id'], []) assert check_shortcut_call(user.send_video, user.bot, 'send_video') assert check_defaults_handling(user.send_video, user.bot) monkeypatch.setattr(user.bot, 'send_video', make_assertion) assert user.send_video('test_video') def test_instance_method_send_venue(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['title'] == 'test_venue' assert check_shortcut_signature(User.send_venue, Bot.send_venue, ['chat_id'], []) assert check_shortcut_call(user.send_venue, user.bot, 'send_venue') assert check_defaults_handling(user.send_venue, user.bot) monkeypatch.setattr(user.bot, 'send_venue', make_assertion) assert user.send_venue(title='test_venue') def test_instance_method_send_video_note(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['video_note'] == 'test_video_note' assert check_shortcut_signature(User.send_video_note, Bot.send_video_note, ['chat_id'], []) assert check_shortcut_call(user.send_video_note, user.bot, 'send_video_note') assert check_defaults_handling(user.send_video_note, user.bot) monkeypatch.setattr(user.bot, 'send_video_note', make_assertion) assert user.send_video_note('test_video_note') def test_instance_method_send_voice(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['voice'] == 'test_voice' assert check_shortcut_signature(User.send_voice, Bot.send_voice, ['chat_id'], []) assert check_shortcut_call(user.send_voice, user.bot, 'send_voice') assert check_defaults_handling(user.send_voice, user.bot) monkeypatch.setattr(user.bot, 'send_voice', make_assertion) assert user.send_voice('test_voice') def test_instance_method_send_animation(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['animation'] == 'test_animation' assert check_shortcut_signature(User.send_animation, Bot.send_animation, ['chat_id'], []) assert check_shortcut_call(user.send_animation, user.bot, 'send_animation') assert check_defaults_handling(user.send_animation, user.bot) monkeypatch.setattr(user.bot, 'send_animation', make_assertion) assert user.send_animation('test_animation') def test_instance_method_send_poll(self, monkeypatch, user): def make_assertion(*_, **kwargs): return kwargs['chat_id'] == user.id and kwargs['question'] == 'test_poll' assert check_shortcut_signature(User.send_poll, Bot.send_poll, ['chat_id'], []) assert check_shortcut_call(user.send_poll, user.bot, 'send_poll') assert check_defaults_handling(user.send_poll, user.bot) monkeypatch.setattr(user.bot, 'send_poll', make_assertion) assert user.send_poll(question='test_poll', options=[1, 2]) def test_instance_method_send_copy(self, monkeypatch, user): def make_assertion(*_, **kwargs): user_id = kwargs['chat_id'] == user.id message_id = kwargs['message_id'] == 'message_id' from_chat_id = kwargs['from_chat_id'] == 'from_chat_id' return from_chat_id and message_id and user_id assert check_shortcut_signature(User.send_copy, Bot.copy_message, ['chat_id'], []) assert check_shortcut_call(user.copy_message, user.bot, 'copy_message') assert check_defaults_handling(user.copy_message, user.bot) monkeypatch.setattr(user.bot, 'copy_message', make_assertion) assert user.send_copy(from_chat_id='from_chat_id', message_id='message_id') def test_instance_method_copy_message(self, monkeypatch, user): def make_assertion(*_, **kwargs): chat_id = kwargs['chat_id'] == 'chat_id' message_id = kwargs['message_id'] == 'message_id' user_id = kwargs['from_chat_id'] == user.id return chat_id and message_id and user_id assert check_shortcut_signature(User.copy_message, Bot.copy_message, ['from_chat_id'], []) assert check_shortcut_call(user.copy_message, user.bot, 'copy_message') assert check_defaults_handling(user.copy_message, user.bot) monkeypatch.setattr(user.bot, 'copy_message', make_assertion) assert user.copy_message(chat_id='chat_id', message_id='message_id') def test_mention_html(self, user): expected = '{}' assert user.mention_html() == expected.format(user.id, user.full_name) assert user.mention_html('thename\u2022') == expected.format( user.id, 'the<b>name\u2022' ) assert user.mention_html(user.username) == expected.format(user.id, user.username) def test_mention_markdown(self, user): expected = '[{}](tg://user?id={})' assert user.mention_markdown() == expected.format(user.full_name, user.id) assert user.mention_markdown('the_name*\u2022') == expected.format( 'the\\_name\\*\u2022', user.id ) assert user.mention_markdown(user.username) == expected.format(user.username, user.id) def test_mention_markdown_v2(self, user): user.first_name = 'first{name' user.last_name = 'last_name' expected = '[{}](tg://user?id={})' assert user.mention_markdown_v2() == expected.format( escape_markdown(user.full_name, version=2), user.id ) assert user.mention_markdown_v2('the{name>\u2022') == expected.format( 'the\\{name\\>\u2022', user.id ) assert user.mention_markdown_v2(user.username) == expected.format(user.username, user.id) def test_equality(self): a = User(self.id_, self.first_name, self.is_bot, self.last_name) b = User(self.id_, self.first_name, self.is_bot, self.last_name) c = User(self.id_, self.first_name, self.is_bot) d = User(0, self.first_name, self.is_bot, self.last_name) e = Update(self.id_) assert a == b assert hash(a) == hash(b) assert a is not b assert a == c assert hash(a) == hash(c) assert a != d assert hash(a) != hash(d) assert a != e assert hash(a) != hash(e)