Mercurial > libervia-backend
annotate src/test/test_plugin_xep_0033.py @ 942:598fc223cf59
core: more organisation in constants.py
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 28 Mar 2014 18:07:13 +0100 |
| parents | 861593a5652b |
| children | e1842ebcb2f3 |
| rev | line source |
|---|---|
| 787 | 1 #!/usr/bin/python |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # SAT: a jabber client | |
| 811 | 5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org) |
| 6 # Copyright (C) 2013, 2014 Adrien Cossa (souliane@mailoo.org) | |
| 787 | 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 extended addressing stanzas """ | |
| 22 | |
| 23 from constants import Const | |
| 24 from sat.test import helpers | |
| 25 from sat.plugins import plugin_xep_0033 as plugin | |
| 26 from sat.core.sat_main import AbortSendMessage, MessageSentAndStored | |
| 27 from copy import deepcopy | |
| 28 from twisted.internet import defer | |
| 29 from wokkel.generic import parseXml | |
| 30 from twisted.words.protocols.jabber.jid import JID | |
|
793
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
31 import logging |
| 787 | 32 |
| 33 | |
| 34 class XEP_0033Test(helpers.SatTestCase): | |
| 35 | |
| 36 def setUp(self): | |
| 37 self.host = helpers.FakeSAT() | |
| 38 self.plugin = plugin.XEP_0033(self.host) | |
| 39 | |
| 40 def test_messageReceived(self): | |
| 41 self.host.memory.init() | |
| 42 xml = u""" | |
| 43 <message type="chat" from="%s" to="%s" id="test_1"> | |
| 44 <body>test</body> | |
| 45 <addresses xmlns='http://jabber.org/protocol/address'> | |
| 46 <address type='to' jid='%s'/> | |
| 47 <address type='cc' jid='%s'/> | |
| 48 <address type='bcc' jid='%s'/> | |
| 49 </addresses> | |
| 50 </message> | |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
51 """ % (Const.JID_STR[1], self.host.getClientHostJid(Const.PROFILE[0]), |
|
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
52 Const.JID_STR[0], Const.JID_STR[1], Const.JID_STR[2]) |
| 787 | 53 stanza = parseXml(xml.encode("utf-8")) |
| 54 treatments = defer.Deferred() | |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
55 self.plugin.messageReceivedTrigger(stanza, treatments, Const.PROFILE[0]) |
| 787 | 56 data = {'extra': {}} |
| 57 | |
|
789
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
58 def cb(data): |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
59 expected = ('to', Const.JID_STR[0], 'cc', Const.JID_STR[1], 'bcc', Const.JID_STR[2]) |
|
789
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
60 msg = 'Expected: %s\nGot: %s' % (expected, data['extra']['addresses']) |
|
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
61 self.assertEqual(data['extra']['addresses'], '%s:%s\n%s:%s\n%s:%s\n' % expected, msg) |
| 787 | 62 |
|
789
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
63 treatments.addCallback(cb) |
| 787 | 64 treatments.callback(data) |
| 65 | |
| 66 def test_sendMessageTrigger(self): | |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
67 mess_data = {"to": self.host.getClientHostJid(Const.PROFILE[0]), |
| 787 | 68 "type": "chat", |
| 69 "message": "content", | |
| 70 "extra": {} | |
| 71 } | |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
72 addresses = ('to', Const.JID_STR[0], 'cc', Const.JID_STR[1], 'bcc', Const.JID_STR[2]) |
| 787 | 73 mess_data["extra"]["address"] = '%s:%s\n%s:%s\n%s:%s\n' % addresses |
| 74 original_stanza = u""" | |
| 75 <message type="chat" from="%s" to="%s" id="test_1"> | |
| 76 <body>content</body> | |
| 77 </message> | |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
78 """ % (Const.JID_STR[1], self.host.getClientHostJid(Const.PROFILE[0])) |
| 787 | 79 mess_data['xml'] = parseXml(original_stanza.encode("utf-8")) |
| 80 expected = deepcopy(mess_data['xml']) | |
| 81 addresses_extra = """ | |
| 82 <addresses xmlns='http://jabber.org/protocol/address'> | |
| 83 <address type='%s' jid='%s'/> | |
| 84 <address type='%s' jid='%s'/> | |
| 85 <address type='%s' jid='%s'/> | |
| 86 </addresses>""" % addresses | |
| 87 addresses_element = parseXml(addresses_extra.encode('utf-8')) | |
| 88 expected.addChild(addresses_element) | |
| 89 | |
|
789
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
90 def assertAddresses(mess_data): |
|
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
91 """The mess_data that we got here has been modified by self.plugin.sendMessageTrigger, |
| 787 | 92 check that the addresses element has been added to the stanza.""" |
| 93 self.assertEqualXML(mess_data['xml'].toXml().encode("utf-8"), expected.toXml().encode("utf-8")) | |
| 94 | |
|
789
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
95 def sendMessageErrback(failure, exception_class): |
| 787 | 96 """If the failure does encapsulate the expected exception, it will be silently |
| 97 trapped, otherwise it will be re-raised and will make the test fail""" | |
| 98 if exception_class == MessageSentAndStored: | |
|
789
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
99 assertAddresses(failure.value.mess_data) |
| 787 | 100 failure.trap(exception_class) |
| 101 | |
| 102 def checkSentAndStored(): | |
| 103 """Check that all the recipients got their messages and that the history has been filled. | |
| 104 /!\ see the comments in XEP_0033.sendAndStoreMessage""" | |
| 105 sent = [] | |
| 106 stored = [] | |
| 107 cache = set() | |
| 108 for to_s in [addresses[1], addresses[3], addresses[5]]: | |
| 109 to_jid = JID(to_s) | |
| 110 host = JID(to_jid.host) | |
|
793
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
111 logger = logging.getLogger() |
|
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
112 level = logger.getEffectiveLevel() |
|
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
113 logger.setLevel(logging.ERROR) # remove warning pollution |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
114 if self.host.memory.hasServerFeature(plugin.NS_ADDRESS, host, Const.PROFILE[0]): |
| 787 | 115 if host not in cache: |
| 116 sent.append(host) | |
| 117 stored.append(host) | |
| 118 cache.add(host) | |
| 119 stored.append(to_jid) | |
| 120 else: | |
| 121 sent.append(to_jid) | |
| 122 stored.append(to_jid) | |
|
793
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
123 logger.setLevel(level) |
|
789
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
124 msg = "/!\ see the comments in XEP_0033.sendAndStoreMessage" |
|
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
125 self.assertEqualUnsortedList(self.host.sent_messages, sent, msg) |
|
0cb423500fbb
test: use the SatTestCase methods instead of builtin "assert" in tests for memory, plugin xep-0033
souliane <souliane@mailoo.org>
parents:
787
diff
changeset
|
126 self.assertEqualUnsortedList(self.host.stored_messages, stored, msg) |
| 787 | 127 |
|
924
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
128 def trigger(data, exception): |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
129 """Execute self.plugin.sendMessageTrigger with a different logging |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
130 level to not pollute the output, then check that the plugin did its |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
131 job. It should abort sending the message or add the extended |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
132 addressing information to the stanza. |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
133 @param data: the data to be processed by self.plugin.sendMessageTrigger |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
134 @param exception: AbortSendMessage or MessageSentAndStored |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
135 """ |
|
793
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
136 logger = logging.getLogger() |
|
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
137 level = logger.getEffectiveLevel() |
|
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
138 logger.setLevel(logging.ERROR) # remove warning pollution |
|
924
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
139 pre_treatments = defer.Deferred() |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
140 post_treatments = defer.Deferred() |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
141 self.plugin.sendMessageTrigger(data, pre_treatments, post_treatments, Const.PROFILE[0]) |
|
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
142 post_treatments.callback(data) |
|
793
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
143 logger.setLevel(level) |
|
924
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
144 post_treatments.addCallbacks(assertAddresses, lambda failure: sendMessageErrback(failure, exception)) |
|
793
cb2db0d85029
test: silent info/warning that were polluting the output
souliane <souliane@mailoo.org>
parents:
792
diff
changeset
|
145 |
| 787 | 146 # feature is not supported, abort the message |
| 147 self.host.memory.init() | |
| 148 data = deepcopy(mess_data) | |
|
924
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
149 trigger(data, AbortSendMessage) |
| 787 | 150 |
| 151 # feature is supported | |
| 152 self.host.init() | |
| 153 self.host.memory.init() | |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
154 self.host.memory.addServerFeature(plugin.NS_ADDRESS, self.host.getClientHostJid(Const.PROFILE[0]), Const.PROFILE[0]) |
| 787 | 155 data = deepcopy(mess_data) |
|
924
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
156 trigger(data, MessageSentAndStored) |
| 787 | 157 checkSentAndStored() |
| 158 | |
| 159 # check that a wrong recipient entity is fixed by the backend | |
| 160 self.host.init() | |
| 161 self.host.memory.init() | |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
162 self.host.memory.addServerFeature(plugin.NS_ADDRESS, self.host.getClientHostJid(Const.PROFILE[0]), Const.PROFILE[0]) |
| 787 | 163 data = deepcopy(mess_data) |
|
792
2136be5a44a8
test: define the constants JIDs and profiles as lists
souliane <souliane@mailoo.org>
parents:
789
diff
changeset
|
164 data["to"] = Const.JID[0] |
|
924
861593a5652b
test: fix tests fo plugins XEP-0033 and XEP-0085
souliane <souliane@mailoo.org>
parents:
915
diff
changeset
|
165 trigger(data, MessageSentAndStored) |
| 787 | 166 checkSentAndStored() |