#!/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 os from pathlib import Path import pytest from flaky import flaky from telegram import Audio, Voice, TelegramError, MessageEntity, Bot from telegram.error import BadRequest from telegram.utils.helpers import escape_markdown from tests.conftest import check_shortcut_call, check_shortcut_signature, check_defaults_handling @pytest.fixture(scope='function') def voice_file(): f = open('tests/data/telegram.ogg', 'rb') yield f f.close() @pytest.fixture(scope='class') def voice(bot, chat_id): with open('tests/data/telegram.ogg', 'rb') as f: return bot.send_voice(chat_id, voice=f, timeout=50).voice class TestVoice: duration = 3 mime_type = 'audio/ogg' file_size = 9199 caption = 'Test *voice*' voice_file_url = 'https://python-telegram-bot.org/static/testfiles/telegram.ogg' voice_file_id = '5a3128a4d2a04750b5b58397f3b5e812' voice_file_unique_id = 'adc3145fd2e84d95b64d68eaa22aa33e' def test_creation(self, voice): # Make sure file has been uploaded. assert isinstance(voice, Voice) assert isinstance(voice.file_id, str) assert isinstance(voice.file_unique_id, str) assert voice.file_id != '' assert voice.file_unique_id != '' def test_expected_values(self, voice): assert voice.duration == self.duration assert voice.mime_type == self.mime_type assert voice.file_size == self.file_size @flaky(3, 1) @pytest.mark.timeout(10) def test_send_all_args(self, bot, chat_id, voice_file, voice): message = bot.send_voice( chat_id, voice_file, duration=self.duration, caption=self.caption, disable_notification=False, parse_mode='Markdown', ) assert isinstance(message.voice, Voice) assert isinstance(message.voice.file_id, str) assert isinstance(message.voice.file_unique_id, str) assert message.voice.file_id != '' assert message.voice.file_unique_id != '' assert message.voice.duration == voice.duration assert message.voice.mime_type == voice.mime_type assert message.voice.file_size == voice.file_size assert message.caption == self.caption.replace('*', '') @flaky(3, 1) @pytest.mark.timeout(10) def test_send_voice_custom_filename(self, bot, chat_id, voice_file, monkeypatch): def make_assertion(url, data, **kwargs): return data['voice'].filename == 'custom_filename' monkeypatch.setattr(bot.request, 'post', make_assertion) assert bot.send_voice(chat_id, voice_file, filename='custom_filename') @flaky(3, 1) @pytest.mark.timeout(10) def test_get_and_download(self, bot, voice): new_file = bot.get_file(voice.file_id) assert new_file.file_size == voice.file_size assert new_file.file_id == voice.file_id assert new_file.file_unique_id == voice.file_unique_id assert new_file.file_path.startswith('https://') new_file.download('telegram.ogg') assert os.path.isfile('telegram.ogg') @flaky(3, 1) @pytest.mark.timeout(10) def test_send_ogg_url_file(self, bot, chat_id, voice): message = bot.sendVoice(chat_id, self.voice_file_url, duration=self.duration) assert isinstance(message.voice, Voice) assert isinstance(message.voice.file_id, str) assert isinstance(message.voice.file_unique_id, str) assert message.voice.file_id != '' assert message.voice.file_unique_id != '' assert message.voice.duration == voice.duration assert message.voice.mime_type == voice.mime_type assert message.voice.file_size == voice.file_size @flaky(3, 1) @pytest.mark.timeout(10) def test_resend(self, bot, chat_id, voice): message = bot.sendVoice(chat_id, voice.file_id) assert message.voice == voice def test_send_with_voice(self, monkeypatch, bot, chat_id, voice): def test(url, data, **kwargs): return data['voice'] == voice.file_id monkeypatch.setattr(bot.request, 'post', test) message = bot.send_voice(chat_id, voice=voice) assert message @flaky(3, 1) @pytest.mark.timeout(10) def test_send_voice_caption_entities(self, bot, chat_id, voice_file): test_string = 'Italic Bold Code' entities = [ MessageEntity(MessageEntity.ITALIC, 0, 6), MessageEntity(MessageEntity.ITALIC, 7, 4), MessageEntity(MessageEntity.ITALIC, 12, 4), ] message = bot.send_voice( chat_id, voice_file, caption=test_string, caption_entities=entities ) assert message.caption == test_string assert message.caption_entities == entities @flaky(3, 1) @pytest.mark.timeout(10) @pytest.mark.parametrize('default_bot', [{'parse_mode': 'Markdown'}], indirect=True) def test_send_voice_default_parse_mode_1(self, default_bot, chat_id, voice): test_string = 'Italic Bold Code' test_markdown_string = '_Italic_ *Bold* `Code`' message = default_bot.send_voice(chat_id, voice, caption=test_markdown_string) assert message.caption_markdown == test_markdown_string assert message.caption == test_string @flaky(3, 1) @pytest.mark.timeout(10) @pytest.mark.parametrize('default_bot', [{'parse_mode': 'Markdown'}], indirect=True) def test_send_voice_default_parse_mode_2(self, default_bot, chat_id, voice): test_markdown_string = '_Italic_ *Bold* `Code`' message = default_bot.send_voice( chat_id, voice, caption=test_markdown_string, parse_mode=None ) assert message.caption == test_markdown_string assert message.caption_markdown == escape_markdown(test_markdown_string) @flaky(3, 1) @pytest.mark.timeout(10) @pytest.mark.parametrize('default_bot', [{'parse_mode': 'Markdown'}], indirect=True) def test_send_voice_default_parse_mode_3(self, default_bot, chat_id, voice): test_markdown_string = '_Italic_ *Bold* `Code`' message = default_bot.send_voice( chat_id, voice, caption=test_markdown_string, parse_mode='HTML' ) assert message.caption == test_markdown_string assert message.caption_markdown == escape_markdown(test_markdown_string) def test_send_voice_local_files(self, monkeypatch, bot, chat_id): # For just test that the correct paths are passed as we have no local bot API set up test_flag = False expected = (Path.cwd() / 'tests/data/telegram.jpg/').as_uri() file = 'tests/data/telegram.jpg' def make_assertion(_, data, *args, **kwargs): nonlocal test_flag test_flag = data.get('voice') == expected monkeypatch.setattr(bot, '_post', make_assertion) bot.send_voice(chat_id, file) assert test_flag @flaky(3, 1) @pytest.mark.timeout(10) @pytest.mark.parametrize( 'default_bot,custom', [ ({'allow_sending_without_reply': True}, None), ({'allow_sending_without_reply': False}, None), ({'allow_sending_without_reply': False}, True), ], indirect=['default_bot'], ) def test_send_voice_default_allow_sending_without_reply( self, default_bot, chat_id, voice, custom ): reply_to_message = default_bot.send_message(chat_id, 'test') reply_to_message.delete() if custom is not None: message = default_bot.send_voice( chat_id, voice, allow_sending_without_reply=custom, reply_to_message_id=reply_to_message.message_id, ) assert message.reply_to_message is None elif default_bot.defaults.allow_sending_without_reply: message = default_bot.send_voice( chat_id, voice, reply_to_message_id=reply_to_message.message_id ) assert message.reply_to_message is None else: with pytest.raises(BadRequest, match='message not found'): default_bot.send_voice( chat_id, voice, reply_to_message_id=reply_to_message.message_id ) def test_de_json(self, bot): json_dict = { 'file_id': self.voice_file_id, 'file_unique_id': self.voice_file_unique_id, 'duration': self.duration, 'caption': self.caption, 'mime_type': self.mime_type, 'file_size': self.file_size, } json_voice = Voice.de_json(json_dict, bot) assert json_voice.file_id == self.voice_file_id assert json_voice.file_unique_id == self.voice_file_unique_id assert json_voice.duration == self.duration assert json_voice.mime_type == self.mime_type assert json_voice.file_size == self.file_size def test_to_dict(self, voice): voice_dict = voice.to_dict() assert isinstance(voice_dict, dict) assert voice_dict['file_id'] == voice.file_id assert voice_dict['file_unique_id'] == voice.file_unique_id assert voice_dict['duration'] == voice.duration assert voice_dict['mime_type'] == voice.mime_type assert voice_dict['file_size'] == voice.file_size @flaky(3, 1) @pytest.mark.timeout(10) def test_error_send_empty_file(self, bot, chat_id): with pytest.raises(TelegramError): bot.sendVoice(chat_id, open(os.devnull, 'rb')) @flaky(3, 1) @pytest.mark.timeout(10) def test_error_send_empty_file_id(self, bot, chat_id): with pytest.raises(TelegramError): bot.sendVoice(chat_id, '') def test_error_without_required_args(self, bot, chat_id): with pytest.raises(TypeError): bot.sendVoice(chat_id) def test_get_file_instance_method(self, monkeypatch, voice): def make_assertion(*_, **kwargs): return kwargs['file_id'] == voice.file_id assert check_shortcut_signature(Voice.get_file, Bot.get_file, ['file_id'], []) assert check_shortcut_call(voice.get_file, voice.bot, 'get_file') assert check_defaults_handling(voice.get_file, voice.bot) monkeypatch.setattr(voice.bot, 'get_file', make_assertion) assert voice.get_file() def test_equality(self, voice): a = Voice(voice.file_id, voice.file_unique_id, self.duration) b = Voice('', voice.file_unique_id, self.duration) c = Voice(voice.file_id, voice.file_unique_id, 0) d = Voice('', '', self.duration) e = Audio(voice.file_id, voice.file_unique_id, self.duration) 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)