libervia-backend/sat/test/test_plugin_xep_0085.py
Goffi 6a6f15707a massive refactoring to switch from camelCase to snake_case:
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.

However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.

To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.

This is a massive change, and may result in some bugs.
2023-04-08 13:54:42 +02:00

104 lines
3.7 KiB
Python

#!/usr/bin/env python3
# SAT: a jabber client
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
# Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General 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 Affero General Public License for more details.
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
""" Plugin chat states notification tests """
from .constants import Const
from sat.test import helpers
from sat.core.constants import Const as C
from sat.plugins import plugin_xep_0085 as plugin
from copy import deepcopy
from twisted.internet import defer
from wokkel.generic import parseXml
class XEP_0085Test(helpers.SatTestCase):
def setUp(self):
self.host = helpers.FakeSAT()
self.plugin = plugin.XEP_0085(self.host)
self.host.memory.param_set(
plugin.PARAM_NAME,
True,
plugin.PARAM_KEY,
C.NO_SECURITY_LIMIT,
Const.PROFILE[0],
)
def test_message_received(self):
for state in plugin.CHAT_STATES:
xml = """
<message type="chat" from="%s" to="%s" id="test_1">
%s
<%s xmlns='%s'/>
</message>
""" % (
Const.JID_STR[1],
Const.JID_STR[0],
"<body>test</body>" if state == "active" else "",
state,
plugin.NS_CHAT_STATES,
)
stanza = parseXml(xml.encode("utf-8"))
self.host.bridge.expect_call(
"chat_state_received", Const.JID_STR[1], state, Const.PROFILE[0]
)
self.plugin.message_received_trigger(
self.host.get_client(Const.PROFILE[0]), stanza, None
)
def test_message_send_trigger(self):
def cb(data):
xml = data["xml"].toXml().encode("utf-8")
self.assert_equal_xml(xml, expected.toXml().encode("utf-8"))
d_list = []
for state in plugin.CHAT_STATES:
mess_data = {
"to": Const.JID[0],
"type": "chat",
"message": "content",
"extra": {} if state == "active" else {"chat_state": state},
}
stanza = """
<message type="chat" from="%s" to="%s" id="test_1">
%s
</message>
""" % (
Const.JID_STR[1],
Const.JID_STR[0],
("<body>%s</body>" % mess_data["message"]) if state == "active" else "",
)
mess_data["xml"] = parseXml(stanza.encode("utf-8"))
expected = deepcopy(mess_data["xml"])
expected.addElement(state, plugin.NS_CHAT_STATES)
post_treatments = defer.Deferred()
self.plugin.messageSendTrigger(
self.host.get_client(Const.PROFILE[0]), mess_data, None, post_treatments
)
post_treatments.addCallback(cb)
post_treatments.callback(mess_data)
d_list.append(post_treatments)
def cb_list(__): # cancel the timer to not block the process
self.plugin.map[Const.PROFILE[0]][Const.JID[0]].timer.cancel()
return defer.DeferredList(d_list).addCallback(cb_list)