Get started on tests

Bibo-Joshi · Bibo-Joshi · commit 810bc305ef1c · 2021-01-23T22:55:39.000+01:00
diff --git a/telegram/ext/callbackqueryhandler.py b/telegram/ext/callbackqueryhandler.py
@@ -49,13 +49,19 @@ class CallbackQueryHandler(Handler[Update]):
     Read the documentation of the ``re`` module for more information.
 
     Note:
-        :attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a ``dict`` you
-        can use to keep any data in will be sent to the :attr:`callback` function. Related to
-        either the user or the chat that the update was sent in. For each update from the same user
-        or in the same chat, it will be the same ``dict``.
-
-        Note that this is DEPRECATED, and you should use context based callbacks. See
-        https://git.io/fxJuV for more info.
+        * :attr:`pass_user_data` and :attr:`pass_chat_data` determine whether a ``dict`` you
+          can use to keep any data in will be sent to the :attr:`callback` function. Related to
+          either the user or the chat that the update was sent in. For each update from the same
+          user or in the same chat, it will be the same ``dict``.
+
+          Note that this is DEPRECATED, and you should use context based callbacks. See
+          https://git.io/fxJuV for more info.
+        * If your bot allows arbitrary objects as ``callback_data``, it may happen that the
+          original ``callback_data`` for the incoming :class:`telegram.CallbackQuery`` can not be
+          found. This is the case when either a malicious client tempered with the
+          ``callback_data`` or the data was simply dropped from cache or not persisted. In these
+          cases, an instance of :class:`telegram.ext.utils.callbackdatacache.InvalidCallbackData`
+          will be set as ``callback_data``.
 
     Warning:
         When setting ``run_async`` to :obj:`True`, you cannot rely on adding custom
diff --git a/telegram/ext/dictpersistence.py b/telegram/ext/dictpersistence.py
@@ -19,7 +19,7 @@
 """This module contains the DictPersistence class."""
 from copy import deepcopy
 
-from typing import Any, DefaultDict, Dict, Optional, Tuple
+from typing import Any, DefaultDict, Dict, Optional, Tuple, cast
 from collections import defaultdict
 
 from telegram.utils.helpers import (
@@ -135,7 +135,11 @@ def __init__(
                 raise TypeError("bot_data_json must be serialized dict")
         if callback_data_json:
             try:
-                self._callback_data = json.loads(callback_data_json)
+                data = json.loads(callback_data_json)
+                if data:
+                    self._callback_data = cast(CDCData, ([tuple(d) for d in data[0]], data[1]))
+                else:
+                    self._callback_data = None
                 self._callback_data_json = callback_data_json
             except (ValueError, AttributeError) as exc:
                 raise TypeError(
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -30,7 +30,6 @@
 import pytz
 
 from telegram import (
-    Bot,
     Message,
     User,
     Chat,
@@ -42,7 +41,7 @@
     PreCheckoutQuery,
     ChosenInlineResult,
 )
-from telegram.ext import Dispatcher, JobQueue, Updater, MessageFilter, Defaults, UpdateFilter
+from telegram.ext import Dispatcher, JobQueue, Updater, MessageFilter, Defaults, UpdateFilter, Bot
 from telegram.error import BadRequest
 from tests.bots import get_bot
 
@@ -195,6 +194,9 @@ def pytest_configure(config):
 
 
 def make_bot(bot_info, **kwargs):
+    """
+    Tests are executed on tg.ext.Bot, as that class only extends the functionality of tg.bot
+    """
     return Bot(bot_info['token'], private_key=PRIVATE_KEY, **kwargs)
 
 
diff --git a/tests/test_bot.py b/tests/test_bot.py
@@ -16,7 +16,6 @@
 #
 # 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 logging
 import time
 import datetime as dtm
 from pathlib import Path
@@ -49,7 +48,9 @@
     Chat,
 )
 from telegram.constants import MAX_INLINE_QUERY_RESULTS
+from telegram.ext import Bot as ExtBot
 from telegram.error import BadRequest, InvalidToken, NetworkError, RetryAfter
+from telegram.ext.utils.callbackdatacache import InvalidCallbackData
 from telegram.utils.helpers import (
     from_timestamp,
     escape_markdown,
@@ -103,6 +104,10 @@ def inline_results():
 
 
 class TestBot:
+    """
+    Most are executed on tg.ext.Bot, as that class only extends the functionality of tg.bot
+    """
+
     @pytest.mark.parametrize(
         'token',
         argvalues=[
@@ -124,7 +129,7 @@ def test_invalid_token(self, token):
         [(True, 1024, True), (False, 1024, False), (0, 0, True), (None, None, True)],
     )
     def test_callback_data_maxsize(self, bot, acd_in, maxsize, acd):
-        bot = Bot(bot.token, arbitrary_callback_data=acd_in)
+        bot = ExtBot(bot.token, arbitrary_callback_data=acd_in)
         assert bot.arbitrary_callback_data == acd
         assert bot.callback_data.maxsize == maxsize
 
@@ -1110,7 +1115,7 @@ def test_get_updates(self, bot):
         if updates:
             assert isinstance(updates[0], Update)
 
-    def test_get_updates_invalid_callback_data(self, bot, monkeypatch, caplog):
+    def test_get_updates_invalid_callback_data(self, bot, monkeypatch):
         def post(*args, **kwargs):
             return [
                 Update(
@@ -1135,15 +1140,11 @@ def post(*args, **kwargs):
         try:
             monkeypatch.setattr(bot.request, 'post', post)
             bot.delete_webhook()  # make sure there is no webhook set if webhook tests failed
-            with caplog.at_level(logging.DEBUG):
-                updates = bot.get_updates(timeout=1)
+            updates = bot.get_updates(timeout=1)
 
-            assert any(
-                "Skipping CallbackQuery with invalid data: {'update_id': 17" in record.getMessage()
-                for record in caplog.records
-            )
             assert isinstance(updates, list)
-            assert len(updates) == 0
+            assert len(updates) == 1
+            assert isinstance(updates[0].callback_query.data, InvalidCallbackData)
 
         finally:
             # Reset b/c bots scope is session
@@ -1881,10 +1882,15 @@ def test_replace_callback_data_send_message(self, bot, chat_id):
 
             assert inline_keyboard[0][1] == no_replace_button
             assert inline_keyboard[0][0] != replace_button
-            assert bot.callback_data.pop(inline_keyboard[0][0].callback_data) == 'replace_test'
+            keyboard, button = (
+                inline_keyboard[0][0].callback_data[:32],
+                inline_keyboard[0][0].callback_data[32:],
+            )
+            assert bot.callback_data._keyboard_data[keyboard].button_data[button] == 'replace_test'
         finally:
             bot.arbitrary_callback_data = False
-            bot.callback_data.clear()
+            bot.callback_data.clear_callback_data()
+            bot.callback_data.clear_callback_queries()
 
     def test_replace_callback_data_stop_poll(self, bot, chat_id):
         poll_message = bot.send_poll(chat_id=chat_id, question='test', options=['1', '2'])
@@ -1907,10 +1913,15 @@ def test_replace_callback_data_stop_poll(self, bot, chat_id):
 
             assert inline_keyboard[0][1] == no_replace_button
             assert inline_keyboard[0][0] != replace_button
-            assert bot.callback_data.pop(inline_keyboard[0][0].callback_data) == 'replace_test'
+            keyboard, button = (
+                inline_keyboard[0][0].callback_data[:32],
+                inline_keyboard[0][0].callback_data[32:],
+            )
+            assert bot.callback_data._keyboard_data[keyboard].button_data[button] == 'replace_test'
         finally:
             bot.arbitrary_callback_data = False
-            bot.callback_data.clear()
+            bot.callback_data.clear_callback_data()
+            bot.callback_data.clear_callback_queries()
 
     def test_replace_callback_data_copy_message(self, bot, chat_id):
         original_message = bot.send_message(chat_id=chat_id, text='original')
@@ -1932,13 +1943,15 @@ def test_replace_callback_data_copy_message(self, bot, chat_id):
             )
             message = helper_message.reply_to_message
             inline_keyboard = message.reply_markup.inline_keyboard
-
-            assert inline_keyboard[0][1] == no_replace_button
-            assert inline_keyboard[0][0] != replace_button
-            assert bot.callback_data.pop(inline_keyboard[0][0].callback_data) == 'replace_test'
+            keyboard, button = (
+                inline_keyboard[0][0].callback_data[:32],
+                inline_keyboard[0][0].callback_data[32:],
+            )
+            assert bot.callback_data._keyboard_data[keyboard].button_data[button] == 'replace_test'
         finally:
             bot.arbitrary_callback_data = False
-            bot.callback_data.clear()
+            bot.callback_data.clear_callback_data()
+            bot.callback_data.clear_callback_queries()
 
     # TODO: Needs improvement. We need incoming inline query to test answer.
     def test_replace_callback_data_answer_inline_query(self, monkeypatch, bot, chat_id):
@@ -1954,8 +1967,12 @@ def make_assertion(
             ).inline_keyboard
             assertion_1 = inline_keyboard[0][1] == no_replace_button
             assertion_2 = inline_keyboard[0][0] != replace_button
+            keyboard, button = (
+                inline_keyboard[0][0].callback_data[:32],
+                inline_keyboard[0][0].callback_data[32:],
+            )
             assertion_3 = (
-                bot.callback_data.pop(inline_keyboard[0][0].callback_data) == 'replace_test'
+                bot.callback_data._keyboard_data[keyboard].button_data[button] == 'replace_test'
             )
             return assertion_1 and assertion_2 and assertion_3
 
@@ -1984,4 +2001,5 @@ def make_assertion(
 
         finally:
             bot.arbitrary_callback_data = False
-            bot.callback_data.clear()
+            bot.callback_data.clear_callback_data()
+            bot.callback_data.clear_callback_queries()
diff --git a/tests/test_callbackquery.py b/tests/test_callbackquery.py
@@ -20,7 +20,6 @@
 import pytest
 
 from telegram import CallbackQuery, User, Message, Chat, Audio, Bot
-from telegram.error import InvalidCallbackData
 from tests.conftest import check_shortcut_signature, check_shortcut_call
 
 
@@ -83,29 +82,6 @@ def test_de_json(self, bot):
         assert callback_query.inline_message_id == self.inline_message_id
         assert callback_query.game_short_name == self.game_short_name
 
-    def test_de_json_arbitrary_callback_data(self, bot):
-        bot.arbitrary_callback_data = True
-        try:
-            bot.callback_data.clear()
-            bot.callback_data._data['callback_data'] = (0, 'test')
-            bot.callback_data._deque.appendleft('callback_data')
-            json_dict = {
-                'id': self.id_,
-                'from': self.from_user.to_dict(),
-                'chat_instance': self.chat_instance,
-                'message': self.message.to_dict(),
-                'data': 'callback_data',
-                'inline_message_id': self.inline_message_id,
-                'game_short_name': self.game_short_name,
-                'default_quote': True,
-            }
-            assert CallbackQuery.de_json(json_dict, bot).data == 'test'
-            with pytest.raises(InvalidCallbackData):
-                CallbackQuery.de_json(json_dict, bot)
-        finally:
-            bot.arbitrary_callback_data = False
-            bot.callback_data.clear()
-
     def test_to_dict(self, callback_query):
         callback_query_dict = callback_query.to_dict()
 
diff --git a/tests/test_error.py b/tests/test_error.py
@@ -31,8 +31,8 @@
     ChatMigrated,
     RetryAfter,
     Conflict,
-    InvalidCallbackData,
 )
+from telegram.ext.utils.callbackdatacache import InvalidCallbackData
 
 
 class TestErrors:
@@ -113,7 +113,6 @@ def test_conflict(self):
             (RetryAfter(12), ["message", "retry_after"]),
             (Conflict("test message"), ["message"]),
             (TelegramDecryptionError("test message"), ["message"]),
-            (InvalidCallbackData(789), ['update_id']),
         ],
     )
     def test_errors_pickling(self, exception, attributes):
diff --git a/tests/test_inlinekeyboardmarkup.py b/tests/test_inlinekeyboardmarkup.py
@@ -136,22 +136,6 @@ def test_de_json(self):
         assert keyboard[0][0].text == 'start'
         assert keyboard[0][0].url == 'http://google.com'
 
-    def test_replace_callback_data(self, bot):
-        try:
-            button_1 = InlineKeyboardButton(text='no_callback_data', url='http://google.com')
-            obj = {1: 'test'}
-            button_2 = InlineKeyboardButton(text='callback_data', callback_data=obj)
-            keyboard = InlineKeyboardMarkup([[button_1, button_2]])
-
-            parsed_keyboard = keyboard.replace_callback_data(bot=bot)
-            assert parsed_keyboard.inline_keyboard[0][0] is button_1
-            assert parsed_keyboard.inline_keyboard[0][1] is not button_2
-            assert parsed_keyboard.inline_keyboard[0][1].text == button_2.text
-            uuid = parsed_keyboard.inline_keyboard[0][1].callback_data
-            assert bot.callback_data.pop(uuid=uuid) is obj
-        finally:
-            bot.callback_data.clear()
-
     def test_equality(self):
         a = InlineKeyboardMarkup.from_column(
             [
diff --git a/tests/test_persistence.py b/tests/test_persistence.py
