2017-01-20 20:13:58 +01:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2022-01-03 08:15:18 +01:00
|
|
|
# Copyright (C) 2015-2022
|
2017-01-20 20:13:58 +01:00
|
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
2017-08-11 23:58:41 +02:00
|
|
|
# it under the terms of the GNU Lesser Public License as published by
|
2017-01-20 20:13:58 +01:00
|
|
|
# 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
|
2017-08-11 23:58:41 +02:00
|
|
|
# GNU Lesser Public License for more details.
|
2017-01-20 20:13:58 +01:00
|
|
|
#
|
2017-08-11 23:58:41 +02:00
|
|
|
# You should have received a copy of the GNU Lesser Public License
|
2017-01-20 20:13:58 +01:00
|
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
2021-09-22 16:49:10 +02:00
|
|
|
import re
|
2019-11-15 21:51:22 +01:00
|
|
|
|
2019-09-13 21:09:05 +02:00
|
|
|
import pytest
|
2017-01-20 20:13:58 +01:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram import Message, MessageEntity, Update, helpers
|
2021-10-19 18:28:19 +02:00
|
|
|
from telegram.constants import MessageType
|
2021-01-30 14:15:39 +01:00
|
|
|
|
|
|
|
|
2020-06-15 18:20:51 +02:00
|
|
|
class TestHelpers:
|
2017-01-20 20:13:58 +01:00
|
|
|
def test_escape_markdown(self):
|
2022-05-05 17:40:22 +02:00
|
|
|
test_str = "*bold*, _italic_, `code`, [text_link](http://github.com/)"
|
|
|
|
expected_str = r"\*bold\*, \_italic\_, \`code\`, \[text\_link](http://github.com/)"
|
2017-01-20 20:13:58 +01:00
|
|
|
|
2017-08-11 23:58:41 +02:00
|
|
|
assert expected_str == helpers.escape_markdown(test_str)
|
2018-02-15 10:21:19 +01:00
|
|
|
|
2020-03-28 16:37:26 +01:00
|
|
|
def test_escape_markdown_v2(self):
|
2022-05-21 16:54:11 +02:00
|
|
|
test_str = r"a_b*c[d]e (fg) h~I`>JK#L+MN -O=|p{qr}s.t!\ \u"
|
|
|
|
expected_str = r"a\_b\*c\[d\]e \(fg\) h\~I\`\>JK\#L\+MN \-O\=\|p\{qr\}s\.t\!\\ \\u"
|
2020-03-28 16:37:26 +01:00
|
|
|
|
|
|
|
assert expected_str == helpers.escape_markdown(test_str, version=2)
|
|
|
|
|
|
|
|
def test_escape_markdown_v2_monospaced(self):
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
test_str = r"mono/pre: `abc` \int (`\some \`stuff)"
|
|
|
|
expected_str = "mono/pre: \\`abc\\` \\\\int (\\`\\\\some \\\\\\`stuff)"
|
2020-03-28 16:37:26 +01:00
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
assert expected_str == helpers.escape_markdown(
|
|
|
|
test_str, version=2, entity_type=MessageEntity.PRE
|
|
|
|
)
|
|
|
|
assert expected_str == helpers.escape_markdown(
|
|
|
|
test_str, version=2, entity_type=MessageEntity.CODE
|
|
|
|
)
|
2020-03-28 16:37:26 +01:00
|
|
|
|
|
|
|
def test_escape_markdown_v2_text_link(self):
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
test_str = "https://url.containing/funny)cha)\\ra\\)cter\\s"
|
|
|
|
expected_str = "https://url.containing/funny\\)cha\\)\\\\ra\\\\\\)cter\\\\s"
|
2020-03-28 16:37:26 +01:00
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
assert expected_str == helpers.escape_markdown(
|
|
|
|
test_str, version=2, entity_type=MessageEntity.TEXT_LINK
|
|
|
|
)
|
2020-03-28 16:37:26 +01:00
|
|
|
|
|
|
|
def test_markdown_invalid_version(self):
|
|
|
|
with pytest.raises(ValueError):
|
2022-05-05 17:40:22 +02:00
|
|
|
helpers.escape_markdown("abc", version=-1)
|
2020-03-28 16:37:26 +01:00
|
|
|
|
2019-09-13 21:09:05 +02:00
|
|
|
def test_create_deep_linked_url(self):
|
2022-05-05 17:40:22 +02:00
|
|
|
username = "JamesTheMock"
|
2019-09-13 21:09:05 +02:00
|
|
|
|
|
|
|
payload = "hello"
|
2020-11-23 22:09:29 +01:00
|
|
|
expected = f"https://t.me/{username}?start={payload}"
|
2019-09-13 21:09:05 +02:00
|
|
|
actual = helpers.create_deep_linked_url(username, payload)
|
|
|
|
assert expected == actual
|
|
|
|
|
2020-11-23 22:09:29 +01:00
|
|
|
expected = f"https://t.me/{username}?startgroup={payload}"
|
2019-09-13 21:09:05 +02:00
|
|
|
actual = helpers.create_deep_linked_url(username, payload, group=True)
|
|
|
|
assert expected == actual
|
|
|
|
|
|
|
|
payload = ""
|
2020-11-23 22:09:29 +01:00
|
|
|
expected = f"https://t.me/{username}"
|
2019-09-13 21:09:05 +02:00
|
|
|
assert expected == helpers.create_deep_linked_url(username)
|
|
|
|
assert expected == helpers.create_deep_linked_url(username, payload)
|
|
|
|
payload = None
|
|
|
|
assert expected == helpers.create_deep_linked_url(username, payload)
|
|
|
|
|
|
|
|
with pytest.raises(ValueError):
|
2022-05-05 17:40:22 +02:00
|
|
|
helpers.create_deep_linked_url(username, "text with spaces")
|
2019-09-13 21:09:05 +02:00
|
|
|
|
|
|
|
with pytest.raises(ValueError):
|
2022-05-05 17:40:22 +02:00
|
|
|
helpers.create_deep_linked_url(username, "0" * 65)
|
2019-09-13 21:09:05 +02:00
|
|
|
|
|
|
|
with pytest.raises(ValueError):
|
|
|
|
helpers.create_deep_linked_url(None, None)
|
|
|
|
with pytest.raises(ValueError): # too short username (4 is minimum)
|
|
|
|
helpers.create_deep_linked_url("abc", None)
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
@pytest.mark.parametrize("message_type", list(MessageType))
|
|
|
|
@pytest.mark.parametrize("entity_type", [Update, Message])
|
2021-10-19 18:28:19 +02:00
|
|
|
def test_effective_message_type(self, message_type, entity_type):
|
|
|
|
def build_test_message(kwargs):
|
2019-02-08 11:02:54 +01:00
|
|
|
config = dict(
|
|
|
|
message_id=1,
|
|
|
|
from_user=None,
|
|
|
|
date=None,
|
|
|
|
chat=None,
|
|
|
|
)
|
|
|
|
config.update(**kwargs)
|
|
|
|
return Message(**config)
|
|
|
|
|
2021-10-19 18:28:19 +02:00
|
|
|
message = build_test_message({message_type: True})
|
|
|
|
entity = message if entity_type is Message else Update(1, message=message)
|
|
|
|
assert helpers.effective_message_type(entity) == message_type
|
2018-02-15 10:21:19 +01:00
|
|
|
|
|
|
|
empty_update = Update(2)
|
|
|
|
assert helpers.effective_message_type(empty_update) is None
|
2018-05-28 22:51:39 +02:00
|
|
|
|
2021-09-22 16:49:10 +02:00
|
|
|
def test_effective_message_type_wrong_type(self):
|
|
|
|
entity = dict()
|
|
|
|
with pytest.raises(
|
2022-05-05 17:40:22 +02:00
|
|
|
TypeError, match=re.escape(f"neither Message nor Update (got: {type(entity)})")
|
2021-09-22 16:49:10 +02:00
|
|
|
):
|
|
|
|
helpers.effective_message_type(entity)
|
|
|
|
|
2018-05-28 22:51:39 +02:00
|
|
|
def test_mention_html(self):
|
|
|
|
expected = '<a href="tg://user?id=1">the name</a>'
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
assert expected == helpers.mention_html(1, "the name")
|
2018-05-28 22:51:39 +02:00
|
|
|
|
|
|
|
def test_mention_markdown(self):
|
2022-05-05 17:40:22 +02:00
|
|
|
expected = "[the name](tg://user?id=1)"
|
2018-05-28 22:51:39 +02:00
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
assert expected == helpers.mention_markdown(1, "the name")
|
2020-03-28 16:37:26 +01:00
|
|
|
|
|
|
|
def test_mention_markdown_2(self):
|
2022-05-05 17:40:22 +02:00
|
|
|
expected = r"[the\_name](tg://user?id=1)"
|
2020-03-28 16:37:26 +01:00
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
assert expected == helpers.mention_markdown(1, "the_name")
|