plugin XEP-0313: first draft:

- you can already test it with d-feet but it will bug unless you apply the changeset 60dfa2f5d61f which is waiting in the branch "frontends_multi_profiles" (actually just one "assert" to comment in plugin_xep_0085.py)
This commit is contained in:
souliane 2014-12-19 14:43:42 +01:00
commit 4a4760b80b
2 changed files with 505 additions and 1 deletions

View file

@ -25,12 +25,14 @@ log_config.satConfigure()
from sat.core import exceptions
from constants import Const as C
from wokkel.xmppim import RosterItem
from wokkel.generic import parseXml
from sat.core.xmpp import SatRosterProtocol
from sat.memory.memory import Params, Memory
from twisted.trial.unittest import FailTest
from twisted.trial import unittest
from twisted.internet import defer
from twisted.words.protocols.jabber.jid import JID
from twisted.words.xish import domish
from xml.etree import cElementTree as etree
from collections import Counter
import re
@ -355,10 +357,25 @@ class FakeXmlStream(object):
self.sent = []
def send(self, obj):
"""Save the sent messages to compare them later"""
"""Save the sent messages to compare them later.
@param obj (domish.Element, str or unicode): message to send
"""
if not isinstance(obj, domish.Element):
assert(isinstance(obj, str) or isinstance(obj, unicode))
obj = parseXml(obj)
if obj.name == 'iq':
# IQ request expects an answer, return the request itself so
# you can check if it has been well built by your plugin.
self.iqDeferreds[obj['id']].callback(obj)
self.sent.append(obj)
return defer.succeed(None)
def addObserver(self, *argv):
pass
class FakeClient(object):
"""Tests involving more than one profile need one instance of this class per profile"""

View file

@ -0,0 +1,238 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# SAT: a jabber client
# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org)
# Copyright (C) 2013, 2014 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 XEP-0313 """
from constants import Const as C
from sat.test import helpers
from sat.plugins.plugin_xep_0313 import XEP_0313
from twisted.words.protocols.jabber.jid import JID
from twisted.words.xish import domish
from dateutil.tz import tzutc
import datetime
from wokkel.rsm import RSMRequest
NS_PUBSUB = 'http://jabber.org/protocol/pubsub'
class XEP_0313Test(helpers.SatTestCase):
def setUp(self):
self.host = helpers.FakeSAT()
self.plugin = XEP_0313(self.host)
def test_queryArchive(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0'/>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
d = self.plugin.queryArchive(profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryArchivePubsub(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0' node='fdp/submitted/capulet.lit/sonnets' />
</iq>
""" % ("H_%d" % domish.Element._idCounter)
d = self.plugin.queryArchive(node="fdp/submitted/capulet.lit/sonnets", profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryArchiveWith(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0'>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:mam:0</value>
</field>
<field var='with' type='jid-single'>
<value>juliet@capulet.lit</value>
</field>
</x>
</query>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
form = self.plugin.buildForm(with_jid=JID('juliet@capulet.lit'))
d = self.plugin.queryArchive(form, profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryArchiveStartEnd(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0'>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:mam:0</value>
</field>
<field var='start' type='text-single'>
<value>2010-06-07T00:00:00Z</value>
</field>
<field var='end' type='text-single'>
<value>2010-07-07T13:23:54Z</value>
</field>
</x>
</query>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
start = datetime.datetime(2010, 6, 7, 0, 0, 0, tzinfo=tzutc())
end = datetime.datetime(2010, 7, 7, 13, 23, 54, tzinfo=tzutc())
form = self.plugin.buildForm(start=start, end=end)
d = self.plugin.queryArchive(form, profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryArchiveStart(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0'>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:mam:0</value>
</field>
<field var='start' type='text-single'>
<value>2010-08-07T00:00:00Z</value>
</field>
</x>
</query>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc())
form = self.plugin.buildForm(start=start)
d = self.plugin.queryArchive(form, profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryArchiveRSM(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0'>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:mam:0</value>
</field>
<field var='start' type='text-single'>
<value>2010-08-07T00:00:00Z</value>
</field>
</x>
<set xmlns='http://jabber.org/protocol/rsm'>
<max>10</max>
</set>
</query>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc())
form = self.plugin.buildForm(start=start)
rsm = RSMRequest(max=10)
d = self.plugin.queryArchive(form=form, rsm=rsm, profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryArchiveRSMPaging(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0'>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'><value>urn:xmpp:mam:0</value></field>
<field var='start' type='text-single'><value>2010-08-07T00:00:00Z</value></field>
</x>
<set xmlns='http://jabber.org/protocol/rsm'>
<max>10</max>
<after>09af3-cc343-b409f</after>
</set>
</query>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
start = datetime.datetime(2010, 8, 7, 0, 0, 0, tzinfo=tzutc())
form = self.plugin.buildForm(start=start)
rsm = RSMRequest(max=10, after=u'09af3-cc343-b409f')
d = self.plugin.queryArchive(form=form, rsm=rsm, profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryFields(self):
xml = """
<iq type='get' id="%s">
<query xmlns='urn:xmpp:mam:0'/>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
d = self.plugin.queryFields(C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryArchiveFields(self):
xml = """
<iq type='set' id='%s'>
<query xmlns='urn:xmpp:mam:0'>
<x xmlns='jabber:x:data' type='submit'>
<field type='hidden' var='FORM_TYPE'>
<value>urn:xmpp:mam:0</value>
</field>
<field type='text-single' var='urn:example:xmpp:free-text-search'>
<value>Where arth thou, my Juliet?</value>
</field>
<field type='text-single' var='urn:example:xmpp:stanza-content'>
<value>{http://jabber.org/protocol/mood}mood/lonely</value>
</field>
</x>
</query>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
extra = (('text-single', 'urn:example:xmpp:free-text-search',
'Where arth thou, my Juliet?'),
('text-single', 'urn:example:xmpp:stanza-content',
'{http://jabber.org/protocol/mood}mood/lonely'))
form = self.plugin.buildForm(extra=extra)
d = self.plugin.queryArchive(form=form, profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_queryPrefs(self):
xml = """
<iq type='get' id='%s'>
<prefs xmlns='urn:xmpp:mam:0'/>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
d = self.plugin.queryPrefs(profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d
def test_setPrefs(self):
xml = """
<iq type='set' id='%s'>
<prefs xmlns='urn:xmpp:mam:0' default='roster'>
<always>
<jid>romeo@montague.lit</jid>
</always>
<never>
<jid>montague@montague.lit</jid>
</never>
</prefs>
</iq>
""" % ("H_%d" % domish.Element._idCounter)
always = [JID('romeo@montague.lit')]
never = [JID('montague@montague.lit')]
d = self.plugin.setPrefs(always=always, never=never, profile_key=C.PROFILE[0])
d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), xml, True))
return d