File: test_manager.py

package info (click to toggle)
python-socketio 5.12.1-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,140 kB
  • sloc: python: 11,460; makefile: 13; sh: 7
file content (351 lines) | stat: -rw-r--r-- 15,643 bytes parent folder | download | duplicates (2)
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
from unittest import mock

import pytest

from socketio import manager
from socketio import packet


class TestBaseManager:
    def setup_method(self):
        id = 0

        def generate_id():
            nonlocal id
            id += 1
            return str(id)

        mock_server = mock.MagicMock()
        mock_server.eio.generate_id = generate_id
        mock_server.packet_class = packet.Packet
        self.bm = manager.Manager()
        self.bm.set_server(mock_server)
        self.bm.initialize()

    def test_connect(self):
        sid = self.bm.connect('123', '/foo')
        assert None in self.bm.rooms['/foo']
        assert sid in self.bm.rooms['/foo']
        assert sid in self.bm.rooms['/foo'][None]
        assert sid in self.bm.rooms['/foo'][sid]
        assert dict(self.bm.rooms['/foo'][None]) == {sid: '123'}
        assert dict(self.bm.rooms['/foo'][sid]) == {sid: '123'}
        assert self.bm.sid_from_eio_sid('123', '/foo') == sid
        assert self.bm.sid_from_eio_sid('1234', '/foo') is None
        assert self.bm.sid_from_eio_sid('123', '/bar') is None
        assert self.bm.eio_sid_from_sid(sid, '/foo') == '123'
        assert self.bm.eio_sid_from_sid('x', '/foo') is None
        assert self.bm.eio_sid_from_sid(sid, '/bar') is None

    def test_pre_disconnect(self):
        sid1 = self.bm.connect('123', '/foo')
        sid2 = self.bm.connect('456', '/foo')
        assert self.bm.is_connected(sid1, '/foo')
        assert self.bm.pre_disconnect(sid1, '/foo') == '123'
        assert self.bm.pending_disconnect == {'/foo': [sid1]}
        assert not self.bm.is_connected(sid1, '/foo')
        assert self.bm.pre_disconnect(sid2, '/foo') == '456'
        assert self.bm.pending_disconnect == {'/foo': [sid1, sid2]}
        assert not self.bm.is_connected(sid2, '/foo')
        self.bm.disconnect(sid1, '/foo')
        assert self.bm.pending_disconnect == {'/foo': [sid2]}
        self.bm.disconnect(sid2, '/foo')
        assert self.bm.pending_disconnect == {}

    def test_disconnect(self):
        sid1 = self.bm.connect('123', '/foo')
        sid2 = self.bm.connect('456', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        self.bm.enter_room(sid2, '/foo', 'baz')
        self.bm.disconnect(sid1, '/foo')
        assert dict(self.bm.rooms['/foo'][None]) == {sid2: '456'}
        assert dict(self.bm.rooms['/foo'][sid2]) == {sid2: '456'}
        assert dict(self.bm.rooms['/foo']['baz']) == {sid2: '456'}

    def test_disconnect_default_namespace(self):
        sid1 = self.bm.connect('123', '/')
        sid2 = self.bm.connect('123', '/foo')
        sid3 = self.bm.connect('456', '/')
        sid4 = self.bm.connect('456', '/foo')
        assert self.bm.is_connected(sid1, '/')
        assert self.bm.is_connected(sid2, '/foo')
        assert not self.bm.is_connected(sid2, '/')
        assert not self.bm.is_connected(sid1, '/foo')
        self.bm.disconnect(sid1, '/')
        assert not self.bm.is_connected(sid1, '/')
        assert self.bm.is_connected(sid2, '/foo')
        self.bm.disconnect(sid2, '/foo')
        assert not self.bm.is_connected(sid2, '/foo')
        assert dict(self.bm.rooms['/'][None]) == {sid3: '456'}
        assert dict(self.bm.rooms['/'][sid3]) == {sid3: '456'}
        assert dict(self.bm.rooms['/foo'][None]) == {sid4: '456'}
        assert dict(self.bm.rooms['/foo'][sid4]) == {sid4: '456'}

    def test_disconnect_twice(self):
        sid1 = self.bm.connect('123', '/')
        sid2 = self.bm.connect('123', '/foo')
        sid3 = self.bm.connect('456', '/')
        sid4 = self.bm.connect('456', '/foo')
        self.bm.disconnect(sid1, '/')
        self.bm.disconnect(sid2, '/foo')
        self.bm.disconnect(sid1, '/')
        self.bm.disconnect(sid2, '/foo')
        assert dict(self.bm.rooms['/'][None]) == {sid3: '456'}
        assert dict(self.bm.rooms['/'][sid3]) == {sid3: '456'}
        assert dict(self.bm.rooms['/foo'][None]) == {sid4: '456'}
        assert dict(self.bm.rooms['/foo'][sid4]) == {sid4: '456'}

    def test_disconnect_all(self):
        sid1 = self.bm.connect('123', '/foo')
        sid2 = self.bm.connect('456', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        self.bm.enter_room(sid2, '/foo', 'baz')
        self.bm.disconnect(sid1, '/foo')
        self.bm.disconnect(sid2, '/foo')
        assert self.bm.rooms == {}

    def test_disconnect_with_callbacks(self):
        sid1 = self.bm.connect('123', '/')
        sid2 = self.bm.connect('123', '/foo')
        sid3 = self.bm.connect('456', '/foo')
        self.bm._generate_ack_id(sid1, 'f')
        self.bm._generate_ack_id(sid2, 'g')
        self.bm._generate_ack_id(sid3, 'h')
        self.bm.disconnect(sid2, '/foo')
        assert sid2 not in self.bm.callbacks
        self.bm.disconnect(sid1, '/')
        assert sid1 not in self.bm.callbacks
        assert sid3 in self.bm.callbacks

    def test_disconnect_bad_namespace(self):
        self.bm.connect('123', '/')
        self.bm.connect('123', '/foo')
        self.bm.disconnect('123', '/bar')  # should not assert

    def test_enter_room_bad_namespace(self):
        sid = self.bm.connect('123', '/')
        with pytest.raises(ValueError):
            self.bm.enter_room(sid, '/foo', 'bar')

    def test_trigger_callback(self):
        sid1 = self.bm.connect('123', '/')
        sid2 = self.bm.connect('123', '/foo')
        cb = mock.MagicMock()
        id1 = self.bm._generate_ack_id(sid1, cb)
        id2 = self.bm._generate_ack_id(sid2, cb)
        id3 = self.bm._generate_ack_id(sid1, cb)
        self.bm.trigger_callback(sid1, id1, ['foo'])
        self.bm.trigger_callback(sid1, id3, ['bar'])
        self.bm.trigger_callback(sid2, id2, ['bar', 'baz'])
        assert cb.call_count == 3
        cb.assert_any_call('foo')
        cb.assert_any_call('bar')
        cb.assert_any_call('bar', 'baz')

    def test_invalid_callback(self):
        sid = self.bm.connect('123', '/')
        cb = mock.MagicMock()
        id = self.bm._generate_ack_id(sid, cb)

        # these should not raise an exception
        self.bm.trigger_callback('xxx', id, ['foo'])
        self.bm.trigger_callback(sid, id + 1, ['foo'])
        assert cb.call_count == 0

    def test_get_namespaces(self):
        assert list(self.bm.get_namespaces()) == []
        self.bm.connect('123', '/')
        self.bm.connect('123', '/foo')
        namespaces = list(self.bm.get_namespaces())
        assert len(namespaces) == 2
        assert '/' in namespaces
        assert '/foo' in namespaces

    def test_get_participants(self):
        sid1 = self.bm.connect('123', '/')
        sid2 = self.bm.connect('456', '/')
        sid3 = self.bm.connect('789', '/')
        self.bm.disconnect(sid3, '/')
        assert sid3 not in self.bm.rooms['/'][None]
        participants = list(self.bm.get_participants('/', None))
        assert len(participants) == 2
        assert (sid1, '123') in participants
        assert (sid2, '456') in participants
        assert (sid3, '789') not in participants

    def test_leave_invalid_room(self):
        sid = self.bm.connect('123', '/foo')
        self.bm.leave_room(sid, '/foo', 'baz')
        self.bm.leave_room(sid, '/bar', 'baz')

    def test_no_room(self):
        rooms = self.bm.get_rooms('123', '/foo')
        assert [] == rooms

    def test_close_room(self):
        sid1 = self.bm.connect('123', '/foo')
        self.bm.connect('456', '/foo')
        self.bm.connect('789', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        self.bm.enter_room(sid1, '/foo', 'bar')
        self.bm.close_room('bar', '/foo')
        assert 'bar' not in self.bm.rooms['/foo']

    def test_close_invalid_room(self):
        self.bm.close_room('bar', '/foo')

    def test_rooms(self):
        sid = self.bm.connect('123', '/foo')
        self.bm.enter_room(sid, '/foo', 'bar')
        r = self.bm.get_rooms(sid, '/foo')
        assert len(r) == 2
        assert sid in r
        assert 'bar' in r

    def test_emit_to_sid(self):
        sid = self.bm.connect('123', '/foo')
        self.bm.connect('456', '/foo')
        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo', to=sid)
        assert self.bm.server._send_eio_packet.call_count == 1
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt.encode() == '42/foo,["my event",{"foo":"bar"}]'

    def test_emit_to_room(self):
        sid1 = self.bm.connect('123', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        sid2 = self.bm.connect('456', '/foo')
        self.bm.enter_room(sid2, '/foo', 'bar')
        self.bm.connect('789', '/foo')
        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo', room='bar')
        assert self.bm.server._send_eio_packet.call_count == 2
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        assert self.bm.server._send_eio_packet.call_args_list[1][0][0] == '456'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt == self.bm.server._send_eio_packet.call_args_list[1][0][1]
        assert pkt.encode() == '42/foo,["my event",{"foo":"bar"}]'

    def test_emit_to_rooms(self):
        sid1 = self.bm.connect('123', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        sid2 = self.bm.connect('456', '/foo')
        self.bm.enter_room(sid2, '/foo', 'bar')
        self.bm.enter_room(sid2, '/foo', 'baz')
        sid3 = self.bm.connect('789', '/foo')
        self.bm.enter_room(sid3, '/foo', 'baz')
        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo',
                     room=['bar', 'baz'])
        assert self.bm.server._send_eio_packet.call_count == 3
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        assert self.bm.server._send_eio_packet.call_args_list[1][0][0] == '456'
        assert self.bm.server._send_eio_packet.call_args_list[2][0][0] == '789'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt == self.bm.server._send_eio_packet.call_args_list[1][0][1]
        assert pkt == self.bm.server._send_eio_packet.call_args_list[2][0][1]
        assert pkt.encode() == '42/foo,["my event",{"foo":"bar"}]'

    def test_emit_to_all(self):
        sid1 = self.bm.connect('123', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        sid2 = self.bm.connect('456', '/foo')
        self.bm.enter_room(sid2, '/foo', 'bar')
        self.bm.connect('789', '/foo')
        self.bm.connect('abc', '/bar')
        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo')
        assert self.bm.server._send_eio_packet.call_count == 3
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        assert self.bm.server._send_eio_packet.call_args_list[1][0][0] == '456'
        assert self.bm.server._send_eio_packet.call_args_list[2][0][0] == '789'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt == self.bm.server._send_eio_packet.call_args_list[1][0][1]
        assert pkt == self.bm.server._send_eio_packet.call_args_list[2][0][1]
        assert pkt.encode() == '42/foo,["my event",{"foo":"bar"}]'

    def test_emit_to_all_skip_one(self):
        sid1 = self.bm.connect('123', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        sid2 = self.bm.connect('456', '/foo')
        self.bm.enter_room(sid2, '/foo', 'bar')
        self.bm.connect('789', '/foo')
        self.bm.connect('abc', '/bar')
        self.bm.emit(
            'my event', {'foo': 'bar'}, namespace='/foo', skip_sid=sid2
        )
        assert self.bm.server._send_eio_packet.call_count == 2
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        assert self.bm.server._send_eio_packet.call_args_list[1][0][0] == '789'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt == self.bm.server._send_eio_packet.call_args_list[1][0][1]
        assert pkt.encode() == '42/foo,["my event",{"foo":"bar"}]'

    def test_emit_to_all_skip_two(self):
        sid1 = self.bm.connect('123', '/foo')
        self.bm.enter_room(sid1, '/foo', 'bar')
        sid2 = self.bm.connect('456', '/foo')
        self.bm.enter_room(sid2, '/foo', 'bar')
        sid3 = self.bm.connect('789', '/foo')
        self.bm.connect('abc', '/bar')
        self.bm.emit(
            'my event',
            {'foo': 'bar'},
            namespace='/foo',
            skip_sid=[sid1, sid3],
        )
        assert self.bm.server._send_eio_packet.call_count == 1
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '456'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt.encode() == '42/foo,["my event",{"foo":"bar"}]'

    def test_emit_with_callback(self):
        sid = self.bm.connect('123', '/foo')
        self.bm._generate_ack_id = mock.MagicMock()
        self.bm._generate_ack_id.return_value = 11
        self.bm.emit(
            'my event', {'foo': 'bar'}, namespace='/foo', callback='cb'
        )
        self.bm._generate_ack_id.assert_called_once_with(sid, 'cb')
        assert self.bm.server._send_packet.call_count == 1
        assert self.bm.server._send_packet.call_args_list[0][0][0] == '123'
        pkt = self.bm.server._send_packet.call_args_list[0][0][1]
        assert pkt.encode() == '2/foo,11["my event",{"foo":"bar"}]'

    def test_emit_to_invalid_room(self):
        self.bm.emit('my event', {'foo': 'bar'}, namespace='/', room='123')

    def test_emit_to_invalid_namespace(self):
        self.bm.emit('my event', {'foo': 'bar'}, namespace='/foo')

    def test_emit_with_tuple(self):
        sid = self.bm.connect('123', '/foo')
        self.bm.emit('my event', ('foo', 'bar'), namespace='/foo', room=sid)
        assert self.bm.server._send_eio_packet.call_count == 1
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt.encode() == '42/foo,["my event","foo","bar"]'

    def test_emit_with_list(self):
        sid = self.bm.connect('123', '/foo')
        self.bm.emit('my event', ['foo', 'bar'], namespace='/foo', room=sid)
        assert self.bm.server._send_eio_packet.call_count == 1
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt.encode() == '42/foo,["my event",["foo","bar"]]'

    def test_emit_with_none(self):
        sid = self.bm.connect('123', '/foo')
        self.bm.emit('my event', None, namespace='/foo', room=sid)
        assert self.bm.server._send_eio_packet.call_count == 1
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt.encode() == '42/foo,["my event"]'

    def test_emit_binary(self):
        sid = self.bm.connect('123', '/')
        self.bm.emit('my event', b'my binary data', namespace='/', room=sid)
        assert self.bm.server._send_eio_packet.call_count == 2
        assert self.bm.server._send_eio_packet.call_args_list[0][0][0] == '123'
        pkt = self.bm.server._send_eio_packet.call_args_list[0][0][1]
        assert pkt.encode() == '451-["my event",{"_placeholder":true,"num":0}]'
        assert self.bm.server._send_eio_packet.call_args_list[1][0][0] == '123'
        pkt = self.bm.server._send_eio_packet.call_args_list[1][0][1]
        assert pkt.encode() == b'my binary data'