gajim-plural/test/unit/test_sessions.py

import unittest

import time

import lib
lib.setup_env()


import notify

from gajim.common import app
from gajim.common import nec
from gajim.common import ged
from gajim.common.nec import NetworkEvent
from gajim.common.modules.message import MessageReceivedEvent
from gajim.common.modules.message import DecryptedMessageReceivedEvent
import nbxmpp

from gajim.session import ChatControlSession
from gajim.roster_window import RosterWindow

from gajim_mocks import *
from data import account1

app.interface = MockInterface()


# name to use for the test account
account_name = account1


class TestChatControlSession(unittest.TestCase):
    ''' Testclass for session.py '''

    @classmethod
    def setUpClass(cls):
        app.nec = nec.NetworkEventsController()
        cls.conn = MockConnection(account_name, {'send_stanza': None})
        app.logger = MockLogger()
        app.default_session_type = ChatControlSession

    def setUp(self):
        app.notification = notify.Notification()

        # no notifications have been sent
        self.assertEqual(0, len(notify.notifications))

    def tearDown(self):
        app.notification.clean()

    def receive_chat_msg(self, jid, msgtxt):
        '''simulate receiving a chat message from jid'''
        msg = nbxmpp.Message()
        msg.setBody(msgtxt)
        msg.setType('chat')

        tim = time.localtime()
        encrypted = False
        xml = """<message from='%s' id='1' type='chat'><body>%s</body>
            <thread>123</thread></message>""" % (jid, msgtxt)
        stanza = nbxmpp.protocol.Message(node=nbxmpp.simplexml.XML2Node(xml))
        self.conn._messageCB(None, stanza)

    # ----- custom assertions -----
    def assert_new_message_notification(self):
        '''a new_message notification has been sent'''
        self.assertEqual(1, len(notify.notifications))
        notif = notify.notifications[-1]
        self.assertEqual('New Message', notif.popup_event_type)

    def assert_first_message_notification(self):
        '''this message was treated as a first message'''
        self.assert_new_message_notification()
        notif = notify.notifications[-1]
        first = notif.first_unread
        self.assertTrue(first,
            'message should have been treated as a first message')

    def assert_not_first_message_notification(self):
        '''this message was not treated as a first message'''
        self.assert_new_message_notification()
        notif = notify.notifications[-1]
        first = notif.first_unread
        self.assertTrue(not first,
            'message was unexpectedly treated as a first message')

    # ----- tests -----
    def test_receive_1nocontrol(self):
        '''test receiving a message in a blank state'''
        jid = 'bct@necronomicorp.com'
        fjid = 'bct@necronomicorp.com/Gajim'
        msgtxt = 'testing one'

        self.receive_chat_msg(fjid, msgtxt)

        # session is created
        self.assertTrue((jid in self.conn.sessions) and (
            '123' in self.conn.sessions[jid]), 'session is not created')
        sess = self.conn.sessions[jid]['123']

        # message was logged
        calls = app.logger.mockGetNamedCalls('insert_into_logs')
        self.assertEqual(1, len(calls))

        # no ChatControl was open and autopopup was off
        # so the message goes into the event queue
        self.assertEqual(1, len(app.events.get_events(account_name)))

        self.assert_first_message_notification()

        # no control is attached to the session
        self.assertEqual(None, sess.control)

    def test_receive_2already_has_control(self):
        '''test receiving a message with a session already attached to a
        control'''
        jid = 'bct@necronomicorp.com'
        fjid = 'bct@necronomicorp.com/Gajim'
        msgtxt = 'testing two'
        app.interface.roster = RosterWindow(app.app)

        sess = self.conn.sessions[jid]['123']
        sess.control = MockChatControl(fjid, account_name)

        self.receive_chat_msg(fjid, msgtxt)

        # message was logged
        calls = app.logger.mockGetNamedCalls('insert_into_logs')
        self.assertEqual(2, len(calls))

        # the message does not go into the event queue
        self.assertEqual(1, len(app.events.get_events(account_name)))

        self.assert_not_first_message_notification()

        # message was printed to the control
        calls = sess.control.mockGetNamedCalls('print_conversation')
        self.assertEqual(1, len(calls))
        app.interface.roster.window.destroy()

    #def test_received_3orphaned_control(self):
        #'''test receiving a message when a control that doesn't have a session
        #attached exists'''

        #jid = 'bct@necronomicorp.com'
        #fjid = jid + '/Gajim'
        #msgtxt = 'testing three'

        #ctrl = MockChatControl(jid, account_name)
        #gajim.interface.msg_win_mgr = Mock({'get_control': ctrl})
        #gajim.interface.msg_win_mgr.mockSetExpectation('get_control',
                #expectParams(jid, account_name))

        #self.receive_chat_msg(fjid, msgtxt)

        ## message was logged
        #calls = gajim.logger.mockGetNamedCalls('insert_into_logs')
        #self.assertEqual(1, len(calls))

        ## the message does not go into the event queue
        #self.assertEqual(0, len(gajim.events.get_events(account_name)))

        #self.assert_not_first_message_notification()

        ## this session is now attached to that control
        #self.assertEqual(self.sess, ctrl.session)
        #self.assertEqual(ctrl, self.sess.control, 'foo')

        ## message was printed to the control
        #calls = ctrl.mockGetNamedCalls('print_conversation')
        #self.assertEqual(1, len(calls))

if __name__ == '__main__':
    unittest.main()
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00			`import unittest`

split mock objects into their own module 2008-06-04 01:54:22 +02:00			`import time`

moved testing libraries into their own directory 2008-08-09 02:24:08 +02:00			`import lib`
			`lib.setup_env()`
split off test initialization code 2008-06-12 05:56:30 +02:00
Organize tests into unit and integration tests. Integration tests can depend on UI, network or both. Unittests use neither. 2009-11-05 09:06:46 +01:00
			`import notify`

Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`from gajim.common import app`
Fix test imports 2017-08-12 02:39:55 +02:00			`from gajim.common import nec`
			`from gajim.common import ged`
			`from gajim.common.nec import NetworkEvent`
Move message handler into own module 2018-07-19 21:26:45 +02:00			`from gajim.common.modules.message import MessageReceivedEvent`
Tests: fix imports 2018-08-18 19:11:26 +02:00			`from gajim.common.modules.message import DecryptedMessageReceivedEvent`
re-enable test suite 2013-04-07 23:41:15 +02:00			`import nbxmpp`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
Fix test imports 2017-08-12 02:39:55 +02:00			`from gajim.session import ChatControlSession`
			`from gajim.roster_window import RosterWindow`
Organize tests into unit and integration tests. Integration tests can depend on UI, network or both. Unittests use neither. 2009-11-05 09:06:46 +01:00
Improve code coverage of our testsuites and do some refactoring. * resolver does not depend on GTK anymore * renamed a few modules for consistency * moved all mocks to lib/ * let client_nb test work again. Was broken here There are many failing tests, help appreciated :-) 2009-01-11 14:49:03 +01:00			`from gajim_mocks import *`
Fix running make test 2017-09-15 15:11:55 +02:00			`from data import account1`
split mock objects into their own module 2008-06-04 01:54:22 +02:00
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`app.interface = MockInterface()`
Organize tests into unit and integration tests. Integration tests can depend on UI, network or both. Unittests use neither. 2009-11-05 09:06:46 +01:00
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
			`# name to use for the test account`
Fix running make test 2017-09-15 15:11:55 +02:00			`account_name = account1`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00

			`class TestChatControlSession(unittest.TestCase):`
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`''' Testclass for session.py '''`
Organize tests into unit and integration tests. Integration tests can depend on UI, network or both. Unittests use neither. 2009-11-05 09:06:46 +01:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`@classmethod`
			`def setUpClass(cls):`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`app.nec = nec.NetworkEventsController()`
re-enable test suite 2013-04-07 23:41:15 +02:00			`cls.conn = MockConnection(account_name, {'send_stanza': None})`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`app.logger = MockLogger()`
			`app.default_session_type = ChatControlSession`
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`def setUp(self):`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`app.notification = notify.Notification()`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# no notifications have been sent`
			`self.assertEqual(0, len(notify.notifications))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`def tearDown(self):`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`app.notification.clean()`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`def receive_chat_msg(self, jid, msgtxt):`
			`'''simulate receiving a chat message from jid'''`
re-enable test suite 2013-04-07 23:41:15 +02:00			`msg = nbxmpp.Message()`
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`msg.setBody(msgtxt)`
			`msg.setType('chat')`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`tim = time.localtime()`
			`encrypted = False`
re-enable test suite 2013-04-07 23:41:15 +02:00			`xml = """<message from='%s' id='1' type='chat'><body>%s</body>`
			`<thread>123</thread></message>""" % (jid, msgtxt)`
			`stanza = nbxmpp.protocol.Message(node=nbxmpp.simplexml.XML2Node(xml))`
			`self.conn._messageCB(None, stanza)`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# ----- custom assertions -----`
			`def assert_new_message_notification(self):`
			`'''a new_message notification has been sent'''`
			`self.assertEqual(1, len(notify.notifications))`
re-enable test suite 2013-04-07 23:41:15 +02:00			`notif = notify.notifications[-1]`
			`self.assertEqual('New Message', notif.popup_event_type)`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`def assert_first_message_notification(self):`
			`'''this message was treated as a first message'''`
			`self.assert_new_message_notification()`
re-enable test suite 2013-04-07 23:41:15 +02:00			`notif = notify.notifications[-1]`
			`first = notif.first_unread`
Unittest: replace deprecated functions 2017-09-10 12:21:10 +02:00			`self.assertTrue(first,`
re-enable test suite 2013-04-07 23:41:15 +02:00			`'message should have been treated as a first message')`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`def assert_not_first_message_notification(self):`
			`'''this message was not treated as a first message'''`
			`self.assert_new_message_notification()`
re-enable test suite 2013-04-07 23:41:15 +02:00			`notif = notify.notifications[-1]`
			`first = notif.first_unread`
Unittest: replace deprecated functions 2017-09-10 12:21:10 +02:00			`self.assertTrue(not first,`
re-enable test suite 2013-04-07 23:41:15 +02:00			`'message was unexpectedly treated as a first message')`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# ----- tests -----`
re-enable test suite 2013-04-07 23:41:15 +02:00			`def test_receive_1nocontrol(self):`
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`'''test receiving a message in a blank state'''`
re-enable test suite 2013-04-07 23:41:15 +02:00			`jid = 'bct@necronomicorp.com'`
			`fjid = 'bct@necronomicorp.com/Gajim'`
			`msgtxt = 'testing one'`

			`self.receive_chat_msg(fjid, msgtxt)`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`# session is created`
Unittest: replace deprecated functions 2017-09-10 12:21:10 +02:00			`self.assertTrue((jid in self.conn.sessions) and (`
re-enable test suite 2013-04-07 23:41:15 +02:00			`'123' in self.conn.sessions[jid]), 'session is not created')`
			`sess = self.conn.sessions[jid]['123']`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# message was logged`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`calls = app.logger.mockGetNamedCalls('insert_into_logs')`
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`self.assertEqual(1, len(calls))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# no ChatControl was open and autopopup was off`
			`# so the message goes into the event queue`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`self.assertEqual(1, len(app.events.get_events(account_name)))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`self.assert_first_message_notification()`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# no control is attached to the session`
re-enable test suite 2013-04-07 23:41:15 +02:00			`self.assertEqual(None, sess.control)`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`def test_receive_2already_has_control(self):`
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`'''test receiving a message with a session already attached to a`
			`control'''`
re-enable test suite 2013-04-07 23:41:15 +02:00			`jid = 'bct@necronomicorp.com'`
			`fjid = 'bct@necronomicorp.com/Gajim'`
			`msgtxt = 'testing two'`
Fix running make test 2017-09-15 15:11:55 +02:00			`app.interface.roster = RosterWindow(app.app)`
split mock objects into their own module 2008-06-04 01:54:22 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`sess = self.conn.sessions[jid]['123']`
			`sess.control = MockChatControl(fjid, account_name)`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`self.receive_chat_msg(fjid, msgtxt)`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# message was logged`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`calls = app.logger.mockGetNamedCalls('insert_into_logs')`
re-enable test suite 2013-04-07 23:41:15 +02:00			`self.assertEqual(2, len(calls))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# the message does not go into the event queue`
Rename gajim.common.gajim to avoid name conflicts 2017-08-13 13:18:56 +02:00			`self.assertEqual(1, len(app.events.get_events(account_name)))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`self.assert_not_first_message_notification()`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`# message was printed to the control`
re-enable test suite 2013-04-07 23:41:15 +02:00			`calls = sess.control.mockGetNamedCalls('print_conversation')`
convert tabs to spaces in source code thanks to reindent.py holy diff batman! 2010-02-08 15:08:40 +01:00			`self.assertEqual(1, len(calls))`
Fix running make test 2017-09-15 15:11:55 +02:00			`app.interface.roster.window.destroy()`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`#def test_received_3orphaned_control(self):`
			`#'''test receiving a message when a control that doesn't have a session`
			`#attached exists'''`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`#jid = 'bct@necronomicorp.com'`
			`#fjid = jid + '/Gajim'`
			`#msgtxt = 'testing three'`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`#ctrl = MockChatControl(jid, account_name)`
			`#gajim.interface.msg_win_mgr = Mock({'get_control': ctrl})`
			`#gajim.interface.msg_win_mgr.mockSetExpectation('get_control',`
			`#expectParams(jid, account_name))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`#self.receive_chat_msg(fjid, msgtxt)`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`## message was logged`
Fix running tests 2017-08-09 15:34:58 +02:00			`#calls = gajim.logger.mockGetNamedCalls('insert_into_logs')`
re-enable test suite 2013-04-07 23:41:15 +02:00			`#self.assertEqual(1, len(calls))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`## the message does not go into the event queue`
			`#self.assertEqual(0, len(gajim.events.get_events(account_name)))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`#self.assert_not_first_message_notification()`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`## this session is now attached to that control`
			`#self.assertEqual(self.sess, ctrl.session)`
			`#self.assertEqual(ctrl, self.sess.control, 'foo')`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
re-enable test suite 2013-04-07 23:41:15 +02:00			`## message was printed to the control`
			`#calls = ctrl.mockGetNamedCalls('print_conversation')`
			`#self.assertEqual(1, len(calls))`
some basic session unit tests and support files 2008-05-29 04:49:03 +02:00
			`if __name__ == '__main__':`
			`unittest.main()`