Mercurial > libervia-backend
annotate libervia/backend/test/test_plugin_xep_0334.py @ 4306:94e0968987cd
plugin XEP-0033: code modernisation, improve delivery, data validation:
- Code has been rewritten using Pydantic models and `async` coroutines for data validation
and cleaner element parsing/generation.
- Delivery has been completely rewritten. It now works even if server doesn't support
multicast, and send to local multicast service first. Delivering to local multicast
service first is due to bad support of XEP-0033 in server (notably Prosody which has an
incomplete implementation), and the current impossibility to detect if a sub-domain
service handles fully multicast or only for local domains. This is a workaround to have
a good balance between backward compatilibity and use of bandwith, and to make it work
with the incoming email gateway implementation (the gateway will only deliver to
entities of its own domain).
- disco feature checking now uses `async` corountines. `host` implementation still use
Deferred return values for compatibility with legacy code.
rel 450
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Thu, 26 Sep 2024 16:12:01 +0200 |
| parents | 0d7bb4df2343 |
| children |
| rev | line source |
|---|---|
| 3028 | 1 #!/usr/bin/env python3 |
| 3137 | 2 |
| 1279 | 3 |
| 4 # SAT: a jabber client | |
| 3479 | 5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org) |
| 1766 | 6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org) |
| 1279 | 7 |
| 8 # This program is free software: you can redistribute it and/or modify | |
| 9 # it under the terms of the GNU Affero General Public License as published by | |
| 10 # the Free Software Foundation, either version 3 of the License, or | |
| 11 # (at your option) any later version. | |
| 12 | |
| 13 # This program is distributed in the hope that it will be useful, | |
| 14 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 # GNU Affero General Public License for more details. | |
| 17 | |
| 18 # You should have received a copy of the GNU Affero General Public License | |
| 19 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 20 | |
| 21 """ Plugin XEP-0334 """ | |
| 22 | |
| 3028 | 23 from .constants import Const as C |
|
4071
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
24 from libervia.backend.test import helpers |
|
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
25 from libervia.backend.plugins.plugin_xep_0334 import XEP_0334 |
| 1279 | 26 from twisted.internet import defer |
| 27 from wokkel.generic import parseXml | |
|
4071
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
28 from libervia.backend.core import exceptions |
| 1279 | 29 |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
30 HINTS = ("no-permanent-storage", "no-storage", "no-copy") |
| 1279 | 31 |
| 32 | |
| 33 class XEP_0334Test(helpers.SatTestCase): | |
| 34 def setUp(self): | |
| 35 self.host = helpers.FakeSAT() | |
| 36 self.plugin = XEP_0334(self.host) | |
| 37 | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
38 def test_message_send_trigger(self): |
| 1279 | 39 template_xml = """ |
| 40 <message | |
| 41 from='romeo@montague.net/orchard' | |
| 42 to='juliet@capulet.com' | |
| 43 type='chat'> | |
| 44 <body>text</body> | |
| 45 %s | |
| 46 </message> | |
| 47 """ | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
48 original_xml = template_xml % "" |
| 1279 | 49 |
| 50 d_list = [] | |
| 51 | |
| 52 def cb(data, expected_xml): | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
53 result_xml = data["xml"].toXml().encode("utf-8") |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
54 self.assert_equal_xml(result_xml, expected_xml, True) |
| 1279 | 55 |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
56 for key in HINTS + ("", "dummy_hint"): |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
57 mess_data = { |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
58 "xml": parseXml(original_xml.encode("utf-8")), |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
59 "extra": {key: True}, |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
60 } |
| 1279 | 61 treatments = defer.Deferred() |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
62 self.plugin.messageSendTrigger( |
|
4270
0d7bb4df2343
Reformatted code base using black.
Goffi <goffi@goffi.org>
parents:
4071
diff
changeset
|
63 self.host.get_client(C.PROFILE[0]), |
|
0d7bb4df2343
Reformatted code base using black.
Goffi <goffi@goffi.org>
parents:
4071
diff
changeset
|
64 mess_data, |
|
0d7bb4df2343
Reformatted code base using black.
Goffi <goffi@goffi.org>
parents:
4071
diff
changeset
|
65 defer.Deferred(), |
|
0d7bb4df2343
Reformatted code base using black.
Goffi <goffi@goffi.org>
parents:
4071
diff
changeset
|
66 treatments, |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
67 ) |
| 1279 | 68 if treatments.callbacks: # the trigger added a callback |
| 69 expected_xml = template_xml % ('<%s xmlns="urn:xmpp:hints"/>' % key) | |
| 70 treatments.addCallback(cb, expected_xml) | |
| 71 treatments.callback(mess_data) | |
| 72 d_list.append(treatments) | |
| 73 | |
| 74 return defer.DeferredList(d_list) | |
| 75 | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
76 def test_message_received_trigger(self): |
| 1279 | 77 template_xml = """ |
| 78 <message | |
| 79 from='romeo@montague.net/orchard' | |
| 80 to='juliet@capulet.com' | |
| 81 type='chat'> | |
| 82 <body>text</body> | |
| 83 %s | |
| 84 </message> | |
| 85 """ | |
| 86 | |
|
2765
378188abe941
misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext)
Goffi <goffi@goffi.org>
parents:
2624
diff
changeset
|
87 def cb(__): |
| 1279 | 88 raise Exception("Errback should not be ran instead of callback!") |
| 89 | |
| 90 def eb(failure): | |
| 91 failure.trap(exceptions.SkipHistory) | |
| 92 | |
| 93 d_list = [] | |
| 94 | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
95 for key in HINTS + ("dummy_hint",): |
| 1279 | 96 message = parseXml(template_xml % ('<%s xmlns="urn:xmpp:hints"/>' % key)) |
| 97 post_treat = defer.Deferred() | |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
98 self.plugin.message_received_trigger( |
|
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
99 self.host.get_client(C.PROFILE[0]), message, post_treat |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
100 ) |
| 1279 | 101 if post_treat.callbacks: |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
102 assert key in ("no-permanent-storage", "no-storage") |
| 1279 | 103 post_treat.addCallbacks(cb, eb) |
| 104 post_treat.callback(None) | |
| 105 d_list.append(post_treat) | |
| 106 else: | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
107 assert key not in ("no-permanent-storage", "no-storage") |
| 1279 | 108 |
| 109 return defer.DeferredList(d_list) |