python-telegram-bot/tests/test_user.py
Bibo-Joshi fc5844c13d
Add missing shortcuts (#2043)
* Add all the methods

* Add tests and fix some typos

* A few more minor changes

* Address review
2020-08-13 13:39:43 +02:00

302 lines
12 KiB
Python

#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2020
# 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 pytest
from telegram import Update, User
from telegram.utils.helpers import escape_markdown
@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 = u'first\u2022name'
last_name = u'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 == u'first\u2022name last\u2022name'
user.last_name = None
assert user.name == u'first\u2022name'
user.username = self.username
assert user.name == '@username'
def test_full_name(self, user):
assert user.full_name == u'first\u2022name last\u2022name'
user.last_name = None
assert user.full_name == u'first\u2022name'
def test_link(self, user):
assert user.link == 'https://t.me/{}'.format(user.username)
user.username = None
assert user.link is None
def test_get_profile_photos(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id
monkeypatch.setattr(user.bot, 'get_user_profile_photos', test)
assert user.get_profile_photos()
def test_instance_method_send_message(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test'
monkeypatch.setattr(user.bot, 'send_message', test)
assert user.send_message('test')
def test_instance_method_send_photo(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_photo'
monkeypatch.setattr(user.bot, 'send_photo', test)
assert user.send_photo('test_photo')
def test_instance_method_send_media_group(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_media_group'
monkeypatch.setattr(user.bot, 'send_media_group', test)
assert user.send_media_group('test_media_group')
def test_instance_method_send_audio(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_audio'
monkeypatch.setattr(user.bot, 'send_audio', test)
assert user.send_audio('test_audio')
def test_instance_method_send_chat_action(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_chat_action'
monkeypatch.setattr(user.bot, 'send_chat_action', test)
assert user.send_chat_action('test_chat_action')
def test_instance_method_send_contact(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_contact'
monkeypatch.setattr(user.bot, 'send_contact', test)
assert user.send_contact('test_contact')
def test_instance_method_send_dice(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_dice'
monkeypatch.setattr(user.bot, 'send_dice', test)
assert user.send_dice('test_dice')
def test_instance_method_send_document(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_document'
monkeypatch.setattr(user.bot, 'send_document', test)
assert user.send_document('test_document')
def test_instance_method_send_game(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_game'
monkeypatch.setattr(user.bot, 'send_game', test)
assert user.send_game('test_game')
def test_instance_method_send_invoice(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_invoice'
monkeypatch.setattr(user.bot, 'send_invoice', test)
assert user.send_invoice('test_invoice')
def test_instance_method_send_location(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_location'
monkeypatch.setattr(user.bot, 'send_location', test)
assert user.send_location('test_location')
def test_instance_method_send_sticker(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_sticker'
monkeypatch.setattr(user.bot, 'send_sticker', test)
assert user.send_sticker('test_sticker')
def test_instance_method_send_video(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_video'
monkeypatch.setattr(user.bot, 'send_video', test)
assert user.send_video('test_video')
def test_instance_method_send_venue(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_venue'
monkeypatch.setattr(user.bot, 'send_venue', test)
assert user.send_venue('test_venue')
def test_instance_method_send_video_note(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_video_note'
monkeypatch.setattr(user.bot, 'send_video_note', test)
assert user.send_video_note('test_video_note')
def test_instance_method_send_voice(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_voice'
monkeypatch.setattr(user.bot, 'send_voice', test)
assert user.send_voice('test_voice')
def test_instance_method_send_animation(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_animation'
monkeypatch.setattr(user.bot, 'send_animation', test)
assert user.send_animation('test_animation')
def test_instance_method_send_poll(self, monkeypatch, user):
def test(*args, **kwargs):
return args[0] == user.id and args[1] == 'test_poll'
monkeypatch.setattr(user.bot, 'send_poll', test)
assert user.send_poll('test_poll')
def test_mention_html(self, user):
expected = u'<a href="tg://user?id={}">{}</a>'
assert user.mention_html() == expected.format(user.id, user.full_name)
assert user.mention_html('the<b>name\u2022') == expected.format(user.id,
'the&lt;b&gt;name\u2022')
assert user.mention_html(user.username) == expected.format(user.id, user.username)
def test_mention_markdown(self, user):
expected = u'[{}](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 = u'[{}](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)