annotate sat/test/test_core_xmpp.py @ 3254:6cf4bd6972c2

core, frontends: avatar refactoring: /!\ huge commit Avatar logic has been reworked around the IDENTITY plugin: plugins able to handle avatar or other identity related metadata (like nicknames) register to IDENTITY plugin in the same way as for other features like download/upload. Once registered, IDENTITY plugin will call them when suitable in order of priority, and handle caching. Methods to manage those metadata from frontend now use serialised data. For now `avatar` and `nicknames` are handled: - `avatar` is now a dict with `path` + metadata like `media_type`, instead of just a string path - `nicknames` is now a list of nicknames in order of priority. This list is never empty, and `nicknames[0]` should be the preferred nickname to use by frontends in most cases. In addition to contact specified nicknames, user set nickname (the one set in roster) is used in priority when available. Among the side changes done with this commit, there are: - a new `contactGet` bridge method to get roster metadata for a single contact - SatPresenceProtocol.send returns a Deferred to check when it has actually been sent - memory's methods to handle entities data now use `client` as first argument - metadata filter can be specified with `getIdentity` - `getAvatar` and `setAvatar` are now part of the IDENTITY plugin instead of XEP-0054 (and there signature has changed) - `isRoom` and `getBareOrFull` are now part of XEP-0045 plugin - jp avatar/get command uses `xdg-open` first when available for `--show` flag - `--no-cache` has been added to jp avatar/get and identity/get - jp identity/set has been simplified, explicit options (`--nickname` only for now) are used instead of `--field`. `--field` may come back in the future if necessary for extra data. - QuickContactList `SetContact` now handle None as a value, and doesn't use it to delete the metadata anymore - improved cache handling for `metadata` and `nicknames` in quick frontend - new `default` argument in QuickContactList `getCache`
author Goffi <goffi@goffi.org>
date Tue, 14 Apr 2020 21:00:33 +0200
parents 559a625a236b
children 467d6c709f1d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
1 #!/usr/bin/env python3
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
335
Goffi <goffi@goffi.org>
parents:
diff changeset
3
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
4 # SAT: a jabber client
3136
9d0df638c8b4 dates update
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
5 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
6
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
10 # (at your option) any later version.
335
Goffi <goffi@goffi.org>
parents:
diff changeset
11
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
15 # GNU Affero General Public License for more details.
335
Goffi <goffi@goffi.org>
parents:
diff changeset
16
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 591
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
335
Goffi <goffi@goffi.org>
parents:
diff changeset
19
Goffi <goffi@goffi.org>
parents:
diff changeset
20 from sat.test import helpers
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
21 from .constants import Const
335
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from twisted.trial import unittest
Goffi <goffi@goffi.org>
parents:
diff changeset
23 from sat.core import xmpp
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from twisted.words.protocols.jabber.jid import JID
Goffi <goffi@goffi.org>
parents:
diff changeset
25 from wokkel.generic import parseXml
Goffi <goffi@goffi.org>
parents:
diff changeset
26 from wokkel.xmppim import RosterItem
Goffi <goffi@goffi.org>
parents:
diff changeset
27
Goffi <goffi@goffi.org>
parents:
diff changeset
28
Goffi <goffi@goffi.org>
parents:
diff changeset
29 class SatXMPPClientTest(unittest.TestCase):
Goffi <goffi@goffi.org>
parents:
diff changeset
30
Goffi <goffi@goffi.org>
parents:
diff changeset
31 def setUp(self):
Goffi <goffi@goffi.org>
parents:
diff changeset
32 self.host = helpers.FakeSAT()
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
33 self.client = xmpp.SatXMPPClient(self.host, Const.PROFILE[0], JID("test@example.org"), "test")
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
34
335
Goffi <goffi@goffi.org>
parents:
diff changeset
35 def test_init(self):
Goffi <goffi@goffi.org>
parents:
diff changeset
36 """Check that init values are correctly initialised"""
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
37 self.assertEqual(self.client.profile, Const.PROFILE[0])
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
38 print(self.client.host)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
39 self.assertEqual(self.client.host_app, self.host)
Goffi <goffi@goffi.org>
parents:
diff changeset
40
591
65821b3fa7ab Fix pep8 support in src/test.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
41
335
Goffi <goffi@goffi.org>
parents:
diff changeset
42 class SatMessageProtocolTest(unittest.TestCase):
Goffi <goffi@goffi.org>
parents:
diff changeset
43
Goffi <goffi@goffi.org>
parents:
diff changeset
44 def setUp(self):
Goffi <goffi@goffi.org>
parents:
diff changeset
45 self.host = helpers.FakeSAT()
Goffi <goffi@goffi.org>
parents:
diff changeset
46 self.message = xmpp.SatMessageProtocol(self.host)
649
e20c823f23e2 tests: helpers improvments:
Goffi <goffi@goffi.org>
parents: 648
diff changeset
47 self.message.parent = helpers.FakeClient(self.host)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
48
Goffi <goffi@goffi.org>
parents:
diff changeset
49 def test_onMessage(self):
Goffi <goffi@goffi.org>
parents:
diff changeset
50 xml = """
Goffi <goffi@goffi.org>
parents:
diff changeset
51 <message type="chat" from="sender@example.net/house" to="test@example.org/SàT" id="test_1">
Goffi <goffi@goffi.org>
parents:
diff changeset
52 <body>test</body>
Goffi <goffi@goffi.org>
parents:
diff changeset
53 </message>
Goffi <goffi@goffi.org>
parents:
diff changeset
54 """
Goffi <goffi@goffi.org>
parents:
diff changeset
55 stanza = parseXml(xml)
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
56 self.host.bridge.expectCall("messageNew", "sender@example.net/house", "test", "chat", "test@example.org/SàT", {}, profile=Const.PROFILE[0])
335
Goffi <goffi@goffi.org>
parents:
diff changeset
57 self.message.onMessage(stanza)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
58
591
65821b3fa7ab Fix pep8 support in src/test.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
59
335
Goffi <goffi@goffi.org>
parents:
diff changeset
60 class SatRosterProtocolTest(unittest.TestCase):
Goffi <goffi@goffi.org>
parents:
diff changeset
61
Goffi <goffi@goffi.org>
parents:
diff changeset
62 def setUp(self):
Goffi <goffi@goffi.org>
parents:
diff changeset
63 self.host = helpers.FakeSAT()
Goffi <goffi@goffi.org>
parents:
diff changeset
64 self.roster = xmpp.SatRosterProtocol(self.host)
649
e20c823f23e2 tests: helpers improvments:
Goffi <goffi@goffi.org>
parents: 648
diff changeset
65 self.roster.parent = helpers.FakeClient(self.host)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
66
1412
979210da778a test: fix the tests
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
67 def test__registerItem(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
68 roster_item = RosterItem(Const.JID[0])
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
69 roster_item.name = "Test Man"
335
Goffi <goffi@goffi.org>
parents:
diff changeset
70 roster_item.subscriptionTo = True
Goffi <goffi@goffi.org>
parents:
diff changeset
71 roster_item.subscriptionFrom = True
Goffi <goffi@goffi.org>
parents:
diff changeset
72 roster_item.ask = False
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
73 roster_item.groups = set(["Test Group 1", "Test Group 2", "Test Group 3"])
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
74 self.host.bridge.expectCall("newContact", Const.JID_STR[0], {'to': 'True', 'from': 'True', 'ask': 'False', 'name': 'Test Man'}, set(["Test Group 1", "Test Group 2", "Test Group 3"]), Const.PROFILE[0])
1412
979210da778a test: fix the tests
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
75 self.roster._registerItem(roster_item)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
76
591
65821b3fa7ab Fix pep8 support in src/test.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
77
335
Goffi <goffi@goffi.org>
parents:
diff changeset
78 class SatPresenceProtocolTest(unittest.TestCase):
Goffi <goffi@goffi.org>
parents:
diff changeset
79
Goffi <goffi@goffi.org>
parents:
diff changeset
80 def setUp(self):
Goffi <goffi@goffi.org>
parents:
diff changeset
81 self.host = helpers.FakeSAT()
Goffi <goffi@goffi.org>
parents:
diff changeset
82 self.presence = xmpp.SatPresenceProtocol(self.host)
649
e20c823f23e2 tests: helpers improvments:
Goffi <goffi@goffi.org>
parents: 648
diff changeset
83 self.presence.parent = helpers.FakeClient(self.host)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
84
Goffi <goffi@goffi.org>
parents:
diff changeset
85 def test_availableReceived(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
86 self.host.bridge.expectCall("presenceUpdate", Const.JID_STR[0], "xa", 15, {'default': "test status", 'fr': 'statut de test'}, Const.PROFILE[0])
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
87 self.presence.availableReceived(Const.JID[0], 'xa', {None: "test status", 'fr': 'statut de test'}, 15)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
88
Goffi <goffi@goffi.org>
parents:
diff changeset
89 def test_availableReceived_empty_statuses(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
90 self.host.bridge.expectCall("presenceUpdate", Const.JID_STR[0], "xa", 15, {}, Const.PROFILE[0])
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
91 self.presence.availableReceived(Const.JID[0], 'xa', None, 15)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
92
Goffi <goffi@goffi.org>
parents:
diff changeset
93 def test_unavailableReceived(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
94 self.host.bridge.expectCall("presenceUpdate", Const.JID_STR[0], "unavailable", 0, {}, Const.PROFILE[0])
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
95 self.presence.unavailableReceived(Const.JID[0], None)
335
Goffi <goffi@goffi.org>
parents:
diff changeset
96
Goffi <goffi@goffi.org>
parents:
diff changeset
97 def test_subscribedReceived(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
98 self.host.bridge.expectCall("subscribe", "subscribed", Const.JID[0].userhost(), Const.PROFILE[0])
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
99 self.presence.subscribedReceived(Const.JID[0])
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
100
335
Goffi <goffi@goffi.org>
parents:
diff changeset
101 def test_unsubscribedReceived(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
102 self.host.bridge.expectCall("subscribe", "unsubscribed", Const.JID[0].userhost(), Const.PROFILE[0])
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
103 self.presence.unsubscribedReceived(Const.JID[0])
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
104
335
Goffi <goffi@goffi.org>
parents:
diff changeset
105 def test_subscribeReceived(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
106 self.host.bridge.expectCall("subscribe", "subscribe", Const.JID[0].userhost(), Const.PROFILE[0])
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
107 self.presence.subscribeReceived(Const.JID[0])
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
108
335
Goffi <goffi@goffi.org>
parents:
diff changeset
109 def test_unsubscribeReceived(self):
792
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
110 self.host.bridge.expectCall("subscribe", "unsubscribe", Const.JID[0].userhost(), Const.PROFILE[0])
2136be5a44a8 test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents: 780
diff changeset
111 self.presence.unsubscribeReceived(Const.JID[0])