forked from python-telegram-bot/python-telegram-bot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_dictpersistence.py
More file actions
388 lines (330 loc) · 16 KB
/
test_dictpersistence.py
File metadata and controls
388 lines (330 loc) · 16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2022
# Leandro Toledo de Souza <[email protected]>
#
# 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 json
import pytest
from telegram.ext import DictPersistence
@pytest.fixture(autouse=True)
def reset_callback_data_cache(bot):
yield
bot.callback_data_cache.clear_callback_data()
bot.callback_data_cache.clear_callback_queries()
bot.arbitrary_callback_data = False
@pytest.fixture(scope="function")
def bot_data():
return {"test1": "test2", "test3": {"test4": "test5"}}
@pytest.fixture(scope="function")
def chat_data():
return {-12345: {"test1": "test2", "test3": {"test4": "test5"}}, -67890: {3: "test4"}}
@pytest.fixture(scope="function")
def user_data():
return {12345: {"test1": "test2", "test3": {"test4": "test5"}}, 67890: {3: "test4"}}
@pytest.fixture(scope="function")
def callback_data():
return [("test1", 1000, {"button1": "test0", "button2": "test1"})], {"test1": "test2"}
@pytest.fixture(scope="function")
def conversations():
return {
"name1": {(123, 123): 3, (456, 654): 4},
"name2": {(123, 321): 1, (890, 890): 2},
"name3": {(123, 321): 1, (890, 890): 2},
}
@pytest.fixture(scope="function")
def user_data_json(user_data):
return json.dumps(user_data)
@pytest.fixture(scope="function")
def chat_data_json(chat_data):
return json.dumps(chat_data)
@pytest.fixture(scope="function")
def bot_data_json(bot_data):
return json.dumps(bot_data)
@pytest.fixture(scope="function")
def callback_data_json(callback_data):
return json.dumps(callback_data)
@pytest.fixture(scope="function")
def conversations_json(conversations):
return """{"name1": {"[123, 123]": 3, "[456, 654]": 4}, "name2":
{"[123, 321]": 1, "[890, 890]": 2}, "name3":
{"[123, 321]": 1, "[890, 890]": 2}}"""
class TestDictPersistence:
"""Just tests the DictPersistence interface. Integration of persistence into Applictation
is tested in TestBasePersistence!"""
async def test_slot_behaviour(self, mro_slots, recwarn):
inst = DictPersistence()
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
async def test_no_json_given(self):
dict_persistence = DictPersistence()
assert await dict_persistence.get_user_data() == {}
assert await dict_persistence.get_chat_data() == {}
assert await dict_persistence.get_bot_data() == {}
assert await dict_persistence.get_callback_data() is None
assert await dict_persistence.get_conversations("noname") == {}
async def test_bad_json_string_given(self):
bad_user_data = "thisisnojson99900()))("
bad_chat_data = "thisisnojson99900()))("
bad_bot_data = "thisisnojson99900()))("
bad_callback_data = "thisisnojson99900()))("
bad_conversations = "thisisnojson99900()))("
with pytest.raises(TypeError, match="user_data"):
DictPersistence(user_data_json=bad_user_data)
with pytest.raises(TypeError, match="chat_data"):
DictPersistence(chat_data_json=bad_chat_data)
with pytest.raises(TypeError, match="bot_data"):
DictPersistence(bot_data_json=bad_bot_data)
with pytest.raises(TypeError, match="callback_data"):
DictPersistence(callback_data_json=bad_callback_data)
with pytest.raises(TypeError, match="conversations"):
DictPersistence(conversations_json=bad_conversations)
async def test_invalid_json_string_given(self):
bad_user_data = '["this", "is", "json"]'
bad_chat_data = '["this", "is", "json"]'
bad_bot_data = '["this", "is", "json"]'
bad_conversations = '["this", "is", "json"]'
bad_callback_data_1 = '[[["str", 3.14, {"di": "ct"}]], "is"]'
bad_callback_data_2 = '[[["str", "non-float", {"di": "ct"}]], {"di": "ct"}]'
bad_callback_data_3 = '[[[{"not": "a str"}, 3.14, {"di": "ct"}]], {"di": "ct"}]'
bad_callback_data_4 = '[[["wrong", "length"]], {"di": "ct"}]'
bad_callback_data_5 = '["this", "is", "json"]'
with pytest.raises(TypeError, match="user_data"):
DictPersistence(user_data_json=bad_user_data)
with pytest.raises(TypeError, match="chat_data"):
DictPersistence(chat_data_json=bad_chat_data)
with pytest.raises(TypeError, match="bot_data"):
DictPersistence(bot_data_json=bad_bot_data)
for bad_callback_data in [
bad_callback_data_1,
bad_callback_data_2,
bad_callback_data_3,
bad_callback_data_4,
bad_callback_data_5,
]:
with pytest.raises(TypeError, match="callback_data"):
DictPersistence(callback_data_json=bad_callback_data)
with pytest.raises(TypeError, match="conversations"):
DictPersistence(conversations_json=bad_conversations)
async def test_good_json_input(
self, user_data_json, chat_data_json, bot_data_json, conversations_json, callback_data_json
):
dict_persistence = DictPersistence(
user_data_json=user_data_json,
chat_data_json=chat_data_json,
bot_data_json=bot_data_json,
conversations_json=conversations_json,
callback_data_json=callback_data_json,
)
user_data = await dict_persistence.get_user_data()
assert isinstance(user_data, dict)
assert user_data[12345]["test1"] == "test2"
assert user_data[67890][3] == "test4"
chat_data = await dict_persistence.get_chat_data()
assert isinstance(chat_data, dict)
assert chat_data[-12345]["test1"] == "test2"
assert chat_data[-67890][3] == "test4"
bot_data = await dict_persistence.get_bot_data()
assert isinstance(bot_data, dict)
assert bot_data["test1"] == "test2"
assert bot_data["test3"]["test4"] == "test5"
assert "test6" not in bot_data
callback_data = await dict_persistence.get_callback_data()
assert isinstance(callback_data, tuple)
assert callback_data[0] == [("test1", 1000, {"button1": "test0", "button2": "test1"})]
assert callback_data[1] == {"test1": "test2"}
conversation1 = await dict_persistence.get_conversations("name1")
assert isinstance(conversation1, dict)
assert conversation1[(123, 123)] == 3
assert conversation1[(456, 654)] == 4
with pytest.raises(KeyError):
conversation1[(890, 890)]
conversation2 = await dict_persistence.get_conversations("name2")
assert isinstance(conversation1, dict)
assert conversation2[(123, 321)] == 1
assert conversation2[(890, 890)] == 2
with pytest.raises(KeyError):
conversation2[(123, 123)]
async def test_good_json_input_callback_data_none(self):
dict_persistence = DictPersistence(callback_data_json="null")
assert dict_persistence.callback_data is None
assert dict_persistence.callback_data_json == "null"
async def test_dict_outputs(
self,
user_data,
user_data_json,
chat_data,
chat_data_json,
bot_data,
bot_data_json,
callback_data_json,
conversations,
conversations_json,
):
dict_persistence = DictPersistence(
user_data_json=user_data_json,
chat_data_json=chat_data_json,
bot_data_json=bot_data_json,
callback_data_json=callback_data_json,
conversations_json=conversations_json,
)
assert dict_persistence.user_data == user_data
assert dict_persistence.chat_data == chat_data
assert dict_persistence.bot_data == bot_data
assert dict_persistence.bot_data == bot_data
assert dict_persistence.conversations == conversations
async def test_json_outputs(
self, user_data_json, chat_data_json, bot_data_json, callback_data_json, conversations_json
):
dict_persistence = DictPersistence(
user_data_json=user_data_json,
chat_data_json=chat_data_json,
bot_data_json=bot_data_json,
callback_data_json=callback_data_json,
conversations_json=conversations_json,
)
assert dict_persistence.user_data_json == user_data_json
assert dict_persistence.chat_data_json == chat_data_json
assert dict_persistence.callback_data_json == callback_data_json
assert dict_persistence.conversations_json == conversations_json
async def test_updating(
self,
user_data_json,
chat_data_json,
bot_data_json,
callback_data,
callback_data_json,
conversations,
conversations_json,
):
dict_persistence = DictPersistence(
user_data_json=user_data_json,
chat_data_json=chat_data_json,
bot_data_json=bot_data_json,
callback_data_json=callback_data_json,
conversations_json=conversations_json,
)
user_data = await dict_persistence.get_user_data()
user_data[12345]["test3"]["test4"] = "test6"
assert dict_persistence.user_data != user_data
assert dict_persistence.user_data_json != json.dumps(user_data)
await dict_persistence.update_user_data(12345, user_data[12345])
assert dict_persistence.user_data == user_data
assert dict_persistence.user_data_json == json.dumps(user_data)
await dict_persistence.drop_user_data(67890)
assert 67890 not in dict_persistence.user_data
dict_persistence._user_data = None
await dict_persistence.drop_user_data(123)
assert isinstance(await dict_persistence.get_user_data(), dict)
chat_data = await dict_persistence.get_chat_data()
chat_data[-12345]["test3"]["test4"] = "test6"
assert dict_persistence.chat_data != chat_data
assert dict_persistence.chat_data_json != json.dumps(chat_data)
await dict_persistence.update_chat_data(-12345, chat_data[-12345])
assert dict_persistence.chat_data == chat_data
assert dict_persistence.chat_data_json == json.dumps(chat_data)
await dict_persistence.drop_chat_data(-67890)
assert -67890 not in dict_persistence.chat_data
dict_persistence._chat_data = None
await dict_persistence.drop_chat_data(123)
assert isinstance(await dict_persistence.get_chat_data(), dict)
bot_data = await dict_persistence.get_bot_data()
bot_data["test3"]["test4"] = "test6"
assert dict_persistence.bot_data != bot_data
assert dict_persistence.bot_data_json != json.dumps(bot_data)
await dict_persistence.update_bot_data(bot_data)
assert dict_persistence.bot_data == bot_data
assert dict_persistence.bot_data_json == json.dumps(bot_data)
callback_data = await dict_persistence.get_callback_data()
callback_data[1]["test3"] = "test4"
callback_data[0][0][2]["button2"] = "test41"
assert dict_persistence.callback_data != callback_data
assert dict_persistence.callback_data_json != json.dumps(callback_data)
await dict_persistence.update_callback_data(callback_data)
assert dict_persistence.callback_data == callback_data
assert dict_persistence.callback_data_json == json.dumps(callback_data)
conversation1 = await dict_persistence.get_conversations("name1")
conversation1[(123, 123)] = 5
assert not dict_persistence.conversations["name1"] == conversation1
await dict_persistence.update_conversation("name1", (123, 123), 5)
assert dict_persistence.conversations["name1"] == conversation1
conversations["name1"][(123, 123)] = 5
assert (
dict_persistence.conversations_json
== DictPersistence._encode_conversations_to_json(conversations)
)
assert await dict_persistence.get_conversations("name1") == conversation1
dict_persistence._conversations = None
await dict_persistence.update_conversation("name1", (123, 123), 5)
assert dict_persistence.conversations["name1"] == {(123, 123): 5}
assert await dict_persistence.get_conversations("name1") == {(123, 123): 5}
assert (
dict_persistence.conversations_json
== DictPersistence._encode_conversations_to_json({"name1": {(123, 123): 5}})
)
async def test_no_data_on_init(
self, bot_data, user_data, chat_data, conversations, callback_data
):
dict_persistence = DictPersistence()
assert dict_persistence.user_data is None
assert dict_persistence.chat_data is None
assert dict_persistence.bot_data is None
assert dict_persistence.conversations is None
assert dict_persistence.callback_data is None
assert dict_persistence.user_data_json == "null"
assert dict_persistence.chat_data_json == "null"
assert dict_persistence.bot_data_json == "null"
assert dict_persistence.conversations_json == "null"
assert dict_persistence.callback_data_json == "null"
await dict_persistence.update_bot_data(bot_data)
await dict_persistence.update_user_data(12345, user_data[12345])
await dict_persistence.update_chat_data(-12345, chat_data[-12345])
await dict_persistence.update_conversation("name", (1, 1), "new_state")
await dict_persistence.update_callback_data(callback_data)
assert dict_persistence.user_data[12345] == user_data[12345]
assert dict_persistence.chat_data[-12345] == chat_data[-12345]
assert dict_persistence.bot_data == bot_data
assert dict_persistence.conversations["name"] == {(1, 1): "new_state"}
assert dict_persistence.callback_data == callback_data
async def test_no_json_dumping_if_data_did_not_change(
self, bot_data, user_data, chat_data, conversations, callback_data, monkeypatch
):
dict_persistence = DictPersistence()
await dict_persistence.update_bot_data(bot_data)
await dict_persistence.update_user_data(12345, user_data[12345])
await dict_persistence.update_chat_data(-12345, chat_data[-12345])
await dict_persistence.update_conversation("name", (1, 1), "new_state")
await dict_persistence.update_callback_data(callback_data)
assert dict_persistence.user_data_json == json.dumps({12345: user_data[12345]})
assert dict_persistence.chat_data_json == json.dumps({-12345: chat_data[-12345]})
assert dict_persistence.bot_data_json == json.dumps(bot_data)
assert (
dict_persistence.conversations_json
== DictPersistence._encode_conversations_to_json({"name": {(1, 1): "new_state"}})
)
assert dict_persistence.callback_data_json == json.dumps(callback_data)
flag = False
def dumps(*args, **kwargs):
nonlocal flag
flag = True
# Since the data doesn't change, json.dumps shoduln't be called beyond this point!
monkeypatch.setattr(json, "dumps", dumps)
await dict_persistence.update_bot_data(bot_data)
await dict_persistence.update_user_data(12345, user_data[12345])
await dict_persistence.update_chat_data(-12345, chat_data[-12345])
await dict_persistence.update_conversation("name", (1, 1), "new_state")
await dict_persistence.update_callback_data(callback_data)
assert not flag