view src/test/test_plugin_xep_0297.py @ 2144:1d3f73e065e1

core, jp: component handling + client handling refactoring: - SàT can now handle components - plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only. - components are really similar to clients, but with some changes in behaviour: * component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected * trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow * for clients, only triggers of plugins handling client mode are launched * for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode. * component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history * for convenience, "client" is still used in method even if it can now be a component * a new "component" boolean attribute tells if we have a component or a client * components have to add themselve Message protocol * roster and presence protocols are not added for components * component default port is 5347 (which is Prosody's default port) - asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge - createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point - jp: added --component argument to profile/create - disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished - new PI_* constants for PLUGIN_INFO values (not used everywhere yet) - client/component connection workflow has been moved to their classes instead of being a host methods - host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData. - identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge) - profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
author Goffi <goffi@goffi.org>
date Sun, 12 Feb 2017 17:55:43 +0100
parents 2daf7b4c6756
children 8b37a62336c3
line wrap: on
line source

#!/usr/bin/env python2
# -*- coding: utf-8 -*-

# SAT: a jabber client
# Copyright (C) 2009-2016 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 XEP-0297 """

from constants import Const as C
from sat.test import helpers
from sat.plugins.plugin_xep_0203 import XEP_0203
from sat.plugins.plugin_xep_0297 import XEP_0297
from twisted.words.protocols.jabber.jid import JID
from dateutil.tz import tzutc
import datetime
from wokkel.generic import parseXml


NS_PUBSUB = 'http://jabber.org/protocol/pubsub'


class XEP_0297Test(helpers.SatTestCase):

    def setUp(self):
        self.host = helpers.FakeSAT()
        self.plugin = XEP_0297(self.host)
        self.host.plugins['XEP-0203'] = XEP_0203(self.host)

    def test_delay(self):
        stanza = parseXml("""
          <message from='juliet@capulet.lit/orchard'
                   id='0202197'
                   to='romeo@montague.lit'
                   type='chat'>
            <body>Yet I should kill thee with much cherishing.</body>
            <mood xmlns='http://jabber.org/protocol/mood'>
                <amorous/>
            </mood>
          </message>
        """.encode('utf-8'))
        output = """
          <message to='mercutio@verona.lit' type='chat'>
            <body>A most courteous exposition!</body>
            <forwarded xmlns='urn:xmpp:forward:0'>
              <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
              <message from='juliet@capulet.lit/orchard'
                       id='0202197'
                       to='romeo@montague.lit'
                       type='chat'
                       xmlns='jabber:client'>
                  <body>Yet I should kill thee with much cherishing.</body>
                  <mood xmlns='http://jabber.org/protocol/mood'>
                      <amorous/>
                  </mood>
              </message>
            </forwarded>
          </message>
        """
        stamp = datetime.datetime(2010, 7, 10, 23, 8, 25, tzinfo=tzutc())
        d = self.plugin.forward(stanza, JID('mercutio@verona.lit'), stamp,
                                body='A most courteous exposition!',
                                profile_key=C.PROFILE[0])
        d.addCallback(lambda dummy: self.assertEqualXML(self.host.getSentMessageXml(0), output, True))
        return d