summaryrefslogtreecommitdiff
path: root/tests/twisted/cm/protocols.py
blob: 1e8d3a7891ab2b15b11be69f5b5feeaa13e3bd37 (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
219
220
221
222
"""
Test Protocol objects.
"""

import dbus

import constants as cs
from servicetest import (assertEquals, tp_path_prefix, assertContains,
        assertDoesNotContain, call_async)
from hazetest import exec_test

def test(q, bus, conn, stream):
    # Ignore conn here, we're only dealing with the CM and Protocol objects.
    cm = bus.get_object(cs.CM + '.haze',
        tp_path_prefix + '/ConnectionManager/haze')
    cm_iface = dbus.Interface(cm, cs.CM)
    cm_props = dbus.Interface(cm, cs.PROPERTIES_IFACE)

    protocols = cm_props.Get(cs.CM, 'Protocols')
    protocol_names = cm_iface.ListProtocols()
    assertEquals(set(protocols.iterkeys()), set(protocol_names))

    for name in protocol_names:
        props = protocols[name]
        protocol = bus.get_object(cm.bus_name,
            cm.object_path + '/' + name.replace('-', '_'))
        protocol_iface = dbus.Interface(protocol, cs.PROTOCOL)
        protocol_props = dbus.Interface(protocol, cs.PROPERTIES_IFACE)
        flat_props = protocol_props.GetAll(cs.PROTOCOL)
        protocol_avatar_props = protocol_props.GetAll(cs.PROTOCOL_IFACE_AVATARS)

        # Protocol is supposed to implement Interface.Avatars iff the
        # connection implements Avatars as well.
        if cs.CONN_IFACE_AVATARS in flat_props['ConnectionInterfaces']:
            assertContains(cs.PROTOCOL_IFACE_AVATARS, props[cs.PROTOCOL + '.Interfaces'])
        else:
            assertDoesNotContain(cs.PROTOCOL_IFACE_AVATARS, props[cs.PROTOCOL + '.Interfaces'])

        parameters = cm_iface.GetParameters(name)
        assertEquals(parameters, props[cs.PROTOCOL + '.Parameters'])
        assertEquals(parameters, flat_props['Parameters'])
        assertEquals(parameters, protocol_props.Get(cs.PROTOCOL, 'Parameters'))

        assertEquals(flat_props['VCardField'],
                props[cs.PROTOCOL + '.VCardField'])
        assertEquals(flat_props['Interfaces'],
                props[cs.PROTOCOL + '.Interfaces'])
        assertEquals(flat_props['EnglishName'],
                props[cs.PROTOCOL + '.EnglishName'])
        assertEquals(flat_props['Icon'], props[cs.PROTOCOL + '.Icon'])
        assertEquals(flat_props['ConnectionInterfaces'],
            props[cs.PROTOCOL + '.ConnectionInterfaces'])
        assertEquals(flat_props['RequestableChannelClasses'],
            props[cs.PROTOCOL + '.RequestableChannelClasses'])

        param_map = {}
        param_flags = {}
        param_type = {}
        param_def = {}

        for p in parameters:
            param_map[p[0]] = tuple(p[1:])
            param_flags[p[0]] = p[1]
            param_type[p[0]] = p[2]
            param_def[p[0]] = p[3]

        # We use special cases to rename these; make sure they don't come back
        assertDoesNotContain(name, ('meanwhile', 'simple'))
        assertDoesNotContain('encoding', param_map)
        assertDoesNotContain('local_charset', param_map)

        if name not in ('local-xmpp', 'irc'):
            # it would be more correct for these protocols not to have this
            # parameter
            assertEquals((cs.PARAM_REQUIRED, 's', ''), param_map['account'])

        # a random selection of checks for known parameters...

        if name == 'gadugadu':
            assertEquals('x-gadugadu', flat_props['VCardField'])
            assertEquals('im-gadugadu', flat_props['Icon'])
            assertEquals((cs.PARAM_SECRET, 's', ''),
                    param_map['password'])
            assertEquals('s', param_type['nick'])
            assertEquals('s', param_type['gg-server'])
        elif name == 'silc':
            assertEquals('x-silc', flat_props['VCardField'])
            assertEquals('im-silc', flat_props['Icon'])
            assertEquals((cs.PARAM_SECRET, 's', ''), param_map['password'])
            assertEquals('s', param_type['server'])
        elif name == 'irc':
            assertEquals('x-irc', flat_props['VCardField'])
            assertEquals('im-irc', flat_props['Icon'])
            assertEquals((cs.PARAM_SECRET, 's', ''), param_map['password'])
            assertEquals('s', param_type['charset'])
            assertEquals('s', param_type['username'])
            assertEquals('s', param_type['realname'])
            assertEquals('s', param_type['server'])
            assertEquals(cs.PARAM_HAS_DEFAULT, param_flags['server'])

            assertEquals('smcv@irc.debian.org',
                    protocol_iface.IdentifyAccount({
                        'account': 'smcv',
                        'server': 'irc.debian.org'}))

            assertDoesNotContain(cs.CONN_IFACE_AVATARS, flat_props['ConnectionInterfaces'])
            assertDoesNotContain(cs.CONN_IFACE_CONTACT_BLOCKING, flat_props['ConnectionInterfaces'])
            assertDoesNotContain(cs.CONN_IFACE_MAIL_NOTIFICATION + '.DRAFT', flat_props['ConnectionInterfaces'])

            # Avatar not supported
            assertEquals(0, protocol_avatar_props['MaximumAvatarBytes'])
            assertEquals(0, protocol_avatar_props['MaximumAvatarHeight'])
            assertEquals(0, protocol_avatar_props['MaximumAvatarWidth'])
            assertEquals(0, protocol_avatar_props['MinimumAvatarHeight'])
            assertEquals(0, protocol_avatar_props['MinimumAvatarWidth'])
            assertEquals(0, protocol_avatar_props['RecommendedAvatarHeight'])
            assertEquals(0, protocol_avatar_props['RecommendedAvatarWidth'])
            assertEquals([], protocol_avatar_props['SupportedAvatarMIMETypes'])
        elif name == 'myspace':
            assertEquals('x-myspace', flat_props['VCardField'])
            assertEquals('im-myspace', flat_props['Icon'])
            assertEquals('s', param_type['server'])
        elif name == 'yahoo':
            assertEquals('x-yahoo', flat_props['VCardField'])
            assertEquals('im-yahoo', flat_props['Icon'])
            assertEquals('s', param_type['charset'])
        elif name == 'yahoojp':
            assertEquals('x-yahoo', flat_props['VCardField'])
            assertEquals('im-yahoojp', flat_props['Icon'])
            assertEquals('s', param_type['charset'])
        elif name == 'aim':
            assertEquals('x-aim', flat_props['VCardField'])
            assertEquals('im-aim', flat_props['Icon'])
            assertEquals('s', param_type['server'])
        elif name == 'msn':
            assertEquals('x-msn', flat_props['VCardField'])
            assertEquals('im-msn', flat_props['Icon'])
            assertEquals('s', param_type['server'])
        elif name == 'jabber':
            assertEquals('x-jabber', flat_props['VCardField'])
            assertEquals('im-jabber', flat_props['Icon'])
            assertDoesNotContain('require_tls', param_map)
            assertDoesNotContain('connect_server', param_map)
            assertEquals((cs.PARAM_SECRET, 's', ''), param_map['password'])
            assertEquals((cs.PARAM_HAS_DEFAULT, 'b', True),
                    param_map['require-encryption'])

            assertEquals('billg@example.com',
                    protocol_iface.IdentifyAccount({
                        'account': 'billg@example.com',
                        'password': 'letmein'}))
            assertEquals(r'billg@example.com',
                    protocol_iface.IdentifyAccount({
                        'account': 'billg@example.com',
                        'server': r'corp.example.com',
                        'password': 'letmein'}))

            # this contains an unsupported parameter
            call_async(q, protocol_iface, 'IdentifyAccount',
                    { 'account': 'billg@example.com',
                        'embrace-and-extend': r'WORKGROUP\Bill',
                        'password': 'letmein'})
            q.expect('dbus-error', name=cs.INVALID_ARGUMENT)

            assertContains(cs.CONN_IFACE_AVATARS, flat_props['ConnectionInterfaces'])
            assertContains(cs.CONN_IFACE_CONTACT_BLOCKING, flat_props['ConnectionInterfaces'])
            assertContains(cs.CONN_IFACE_MAIL_NOTIFICATION + '.DRAFT', flat_props['ConnectionInterfaces'])

            # libpurple currently says there's no max size
            assertEquals(0, protocol_avatar_props['MaximumAvatarBytes'])
            assertEquals(96, protocol_avatar_props['MaximumAvatarHeight'])
            assertEquals(96, protocol_avatar_props['MaximumAvatarWidth'])
            assertEquals(32, protocol_avatar_props['MinimumAvatarHeight'])
            assertEquals(32, protocol_avatar_props['MinimumAvatarWidth'])
            assertEquals(0, protocol_avatar_props['RecommendedAvatarHeight'])
            assertEquals(0, protocol_avatar_props['RecommendedAvatarWidth'])
            assertEquals(['image/png'], protocol_avatar_props['SupportedAvatarMIMETypes'])
        elif name == 'qq':
            assertEquals('x-qq', flat_props['VCardField'])
            assertEquals('im-qq', flat_props['Icon'])
        elif name == 'sametime':
            assertEquals('x-sametime', flat_props['VCardField'])
            assertEquals('im-sametime', flat_props['Icon'])
        elif name == 'zephyr':
            assertEquals('x-zephyr', flat_props['VCardField'])
            assertEquals('im-zephyr', flat_props['Icon'])
            assertEquals('s', param_type['realm'])
            assertEquals('s', param_type['charset'])
        elif name == 'local-xmpp':
            # makes very little sense in an address book
            assertEquals('', flat_props['VCardField'])
            assertEquals('im-local-xmpp', flat_props['Icon'])
            assertEquals((cs.PARAM_REQUIRED, 's', ''), param_map['first-name'])
            assertDoesNotContain('first', param_map)
            assertEquals((cs.PARAM_REQUIRED, 's', ''), param_map['last-name'])
            assertDoesNotContain('last', param_map)
            assertEquals((0, 's', ''), param_map['email'])
            assertEquals((0, 's', ''), param_map['jid'])
        elif name == 'icq':
            assertEquals('x-icq', flat_props['VCardField'])
            assertEquals('im-icq', flat_props['Icon'])
        elif name == 'groupwise':
            assertEquals('x-groupwise', flat_props['VCardField'])
            assertEquals('im-groupwise', flat_props['Icon'])
        elif name == 'sipe':
            assertEquals('im-sipe', flat_props['Icon'])
            assertDoesNotContain('usersplit1', param_map)
            assertEquals((cs.PARAM_HAS_DEFAULT, 's', ''), param_map['login'])

            assertEquals('billg@example.com,',
                    protocol_iface.IdentifyAccount({
                        'account': 'billg@example.com',
                        'password': 'letmein'}))
            assertEquals(r'billg@example.com,WORKGROUP\Bill',
                    protocol_iface.IdentifyAccount({
                        'account': 'billg@example.com',
                        'login': r'WORKGROUP\Bill',
                        'password': 'letmein'}))

if __name__ == '__main__':
    exec_test(test)