summaryrefslogtreecommitdiff
path: root/tests/test_stream_roster.py
blob: e1aa1766dce5f500a2b208212564984fb0677743 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# -*- encoding:utf-8 -*-

from __future__ import unicode_literals

from sleekxmpp.test import *
import time
import threading


class TestStreamRoster(SleekTest):
    """
    Test handling roster updates.
    """

    def tearDown(self):
        self.stream_close()

    def testGetRoster(self):
        """Test handling roster requests."""
        self.stream_start(mode='client')
        self.failUnless(self.xmpp.roster == {}, "Initial roster not empty.")

        events = []

        def roster_received(iq):
            events.append('roster_received')

        self.xmpp.add_event_handler('roster_received', roster_received)

        # Since get_roster blocks, we need to run it in a thread.
        t = threading.Thread(name='get_roster', target=self.xmpp.get_roster)
        t.start()

        self.send("""
          <iq type="get" id="1">
            <query xmlns="jabber:iq:roster" />
          </iq>
        """)
        self.recv("""
          <iq type="result" id="1">
            <query xmlns="jabber:iq:roster">
              <item jid="user@localhost"
                    name="User"
                    subscription="both">
                <group>Friends</group>
                <group>Examples</group>
              </item>
            </query>
          </iq>
        """)

        # Wait for get_roster to return.
        t.join()

        # Give the event queue time to process.
        time.sleep(.1)

        roster = {'user@localhost': {'name': 'User',
                                     'subscription': 'both',
                                     'groups': ['Friends', 'Examples'],
                                     'presence': {},
                                     'in_roster': True}}
        self.failUnless(self.xmpp.roster == roster,
                "Unexpected roster values: %s" % self.xmpp.roster)
        self.failUnless('roster_received' in events,
                "Roster received event not triggered: %s" % events)

    def testRosterSet(self):
        """Test handling pushed roster updates."""
        self.stream_start(mode='client')
        self.failUnless(self.xmpp.roster == {}, "Initial roster not empty.")
        events = []

        def roster_update(e):
            events.append('roster_update')

        self.xmpp.add_event_handler('roster_update', roster_update)


        self.recv("""
          <iq type="set" id="1">
            <query xmlns="jabber:iq:roster">
              <item jid="user@localhost"
                    name="User"
                    subscription="both">
                <group>Friends</group>
                <group>Examples</group>
              </item>
            </query>
          </iq>
        """)
        self.send("""
          <iq type="result" id="1">
            <query xmlns="jabber:iq:roster" />
          </iq>
        """)

        # Give the event queue time to process.
        time.sleep(.1)

        roster = {'user@localhost': {'name': 'User',
                                     'subscription': 'both',
                                     'groups': ['Friends', 'Examples'],
                                     'presence': {},
                                     'in_roster': True}}
        self.failUnless(self.xmpp.roster == roster,
                "Unexpected roster values: %s" % self.xmpp.roster)
        self.failUnless('roster_update' in events,
                "Roster updated event not triggered: %s" % events)

    def testRosterTimeout(self):
        """Test handling a timed out roster request."""
        self.stream_start()
        events = []

        def roster_timeout(event):
            events.append('roster_timeout')

        self.xmpp.add_event_handler('roster_timeout', roster_timeout)
        self.xmpp.get_roster(timeout=0)

        # Give the event queue time to process.
        time.sleep(.1)

        self.failUnless(events == ['roster_timeout'],
                 "Roster timeout event not triggered: %s." % events)

    def testRosterCallback(self):
        """Test handling a roster request callback."""
        self.stream_start()
        events = []

        def roster_callback(iq):
            events.append('roster_callback')

        # Since get_roster blocks, we need to run it in a thread.
        t = threading.Thread(name='get_roster',
                             target=self.xmpp.get_roster,
                             kwargs={str('callback'): roster_callback})
        t.start()

        self.send("""
          <iq type="get" id="1">
            <query xmlns="jabber:iq:roster" />
          </iq>
        """)
        self.recv("""
          <iq type="result" id="1">
            <query xmlns="jabber:iq:roster">
              <item jid="user@localhost"
                    name="User"
                    subscription="both">
                <group>Friends</group>
                <group>Examples</group>
              </item>
            </query>
          </iq>
        """)

        # Wait for get_roster to return.
        t.join()

        # Give the event queue time to process.
        time.sleep(.1)

        self.failUnless(events == ['roster_callback'],
                 "Roster timeout event not triggered: %s." % events)

    def testRosterUnicode(self):
        """Test that JIDs with Unicode values are handled properly."""
        self.stream_start()
        self.recv("""
          <iq to="tester@localhost" type="set" id="1">
            <query xmlns="jabber:iq:roster">
              <item jid="andré@foo" subscription="both">
                <group>Unicode</group>
              </item>
            </query>
          </iq>
        """)

        # Give the event queue time to process.
        time.sleep(.1)

        roster = {'andré@foo': {
                    'name': '',
                    'subscription': 'both',
                    'groups': ['Unicode'],
                    'presence': {},
                    'in_roster': True}}
        self.failUnless(self.xmpp.roster == roster,
                "Unexpected roster values: %s" % self.xmpp.roster)

        self.recv("""
          <presence to="tester@localhost" from="andré@foo/bar">
            <show>away</show>
            <status>Testing</status>
          </presence>
        """)

        # Give the event queue time to process.
        time.sleep(.1)

        roster = {'andré@foo': {
                    'name': '',
                    'subscription': 'both',
                    'groups': ['Unicode'],
                    'presence': {
                        'bar':{'priority':0,
                               'status':'Testing',
                               'show':'away'}},
                    'in_roster': True}}
        self.failUnless(self.xmpp.roster == roster,
                "Unexpected roster values: %s" % self.xmpp.roster)



suite = unittest.TestLoader().loadTestsFromTestCase(TestStreamRoster)