File: test_xso.py

package info (click to toggle)
python-aioxmpp 0.13.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 6,244 kB
  • sloc: python: 97,761; xml: 215; makefile: 155; sh: 63
file content (385 lines) | stat: -rw-r--r-- 11,183 bytes parent folder | download | duplicates (3)
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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
########################################################################
# File name: test_xso.py
# This file is part of: aioxmpp
#
# LICENSE
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program.  If not, see
# <http://www.gnu.org/licenses/>.
#
########################################################################
import io
import unittest
import unittest.mock

import multidict

import aioxmpp.xso
import aioxmpp.xml

from aioxmpp.utils import namespaces

import aioxmpp.httpupload.xso as httpupload_xso


class TestNamespace(unittest.TestCase):
    def test_namespace(self):
        self.assertEqual(namespaces.xep0363_http_upload,
                         "urn:xmpp:http:upload:0")


class TestRequest(unittest.TestCase):
    def test_is_xso(self):
        self.assertTrue(issubclass(
            httpupload_xso.Request,
            aioxmpp.xso.XSO,
        ))

    def test_tag(self):
        self.assertEqual(httpupload_xso.Request.TAG,
                         (namespaces.xep0363_http_upload, "request"))

    def test_is_iq_payload(self):
        self.assertIn(
            httpupload_xso.Request.TAG,
            aioxmpp.IQ.CHILD_MAP,
        )

    def test_filename(self):
        self.assertIsInstance(
            httpupload_xso.Request.filename,
            aioxmpp.xso.Attr,
        )
        self.assertEqual(
            httpupload_xso.Request.filename.tag,
            (None, "filename"),
        )
        self.assertIsInstance(
            httpupload_xso.Request.filename.type_,
            aioxmpp.xso.String,
        )
        self.assertIs(httpupload_xso.Request.filename.default,
                      aioxmpp.xso.NO_DEFAULT)

    def test_size(self):
        self.assertIsInstance(
            httpupload_xso.Request.size,
            aioxmpp.xso.Attr,
        )
        self.assertEqual(
            httpupload_xso.Request.size.tag,
            (None, "size"),
        )
        self.assertIsInstance(
            httpupload_xso.Request.size.type_,
            aioxmpp.xso.Integer,
        )
        self.assertIs(httpupload_xso.Request.filename.default,
                      aioxmpp.xso.NO_DEFAULT)

    def test_content_type(self):
        self.assertIsInstance(
            httpupload_xso.Request.content_type,
            aioxmpp.xso.Attr,
        )
        self.assertEqual(
            httpupload_xso.Request.content_type.tag,
            (None, "content-type"),
        )
        self.assertIsInstance(
            httpupload_xso.Request.content_type.type_,
            aioxmpp.xso.String,
        )
        self.assertIs(httpupload_xso.Request.filename.default,
                      aioxmpp.xso.NO_DEFAULT)

    def test_init_requires_arguments(self):
        with self.assertRaisesRegex(TypeError, r"argument"):
            httpupload_xso.Request()

    def test_init(self):
        r = httpupload_xso.Request(
            "filename",
            1234,
            "content type",
        )

        self.assertEqual(r.filename, "filename")
        self.assertEqual(r.size, 1234)
        self.assertEqual(r.content_type, "content type")


class TestHeader(unittest.TestCase):
    def test_is_xso(self):
        self.assertTrue(issubclass(
            httpupload_xso.Header,
            aioxmpp.xso.XSO,
        ))

    def test_tag(self):
        self.assertEqual(httpupload_xso.Header.TAG,
                         (namespaces.xep0363_http_upload, "header"))

    def test_name(self):
        self.assertIsInstance(
            httpupload_xso.Header.name,
            aioxmpp.xso.Attr,
        )
        self.assertEqual(
            httpupload_xso.Header.name.tag,
            (None, "name"),
        )
        self.assertIsInstance(
            httpupload_xso.Header.name.type_,
            aioxmpp.xso.String,
        )
        self.assertIs(httpupload_xso.Header.name.default,
                      aioxmpp.xso.NO_DEFAULT)

    def test_value(self):
        self.assertIsInstance(
            httpupload_xso.Header.value,
            aioxmpp.xso.Text,
        )
        self.assertIsInstance(
            httpupload_xso.Header.name.type_,
            aioxmpp.xso.String,
        )


class TestHeaderType(unittest.TestCase):
    def test_is_element_type(self):
        self.assertTrue(issubclass(
            httpupload_xso.HeaderType,
            aioxmpp.xso.AbstractElementType,
        ))

    def test_get_xso_types(self):
        self.assertCountEqual(
            httpupload_xso.HeaderType.get_xso_types(),
            [httpupload_xso.Header]
        )

    def test_unpack(self):
        t = httpupload_xso.HeaderType
        el = unittest.mock.Mock(spec=httpupload_xso.Header)
        el.name = unittest.mock.sentinel.name
        el.value = unittest.mock.sentinel.value
        self.assertEqual(
            t.unpack(el),
            (unittest.mock.sentinel.name, unittest.mock.sentinel.value)
        )

    def test_pack(self):
        t = httpupload_xso.HeaderType
        with unittest.mock.patch("aioxmpp.httpupload.xso.Header") as Header:
            result = t.pack((unittest.mock.sentinel.name,
                             unittest.mock.sentinel.value))

        Header.assert_called_once_with()
        self.assertEqual(result, Header())

        self.assertEqual(result.name, unittest.mock.sentinel.name)
        self.assertEqual(result.value, unittest.mock.sentinel.value)


class TestPut(unittest.TestCase):
    def test_is_xso(self):
        self.assertTrue(issubclass(
            httpupload_xso.Put,
            aioxmpp.xso.XSO,
        ))

    def test_tag(self):
        self.assertEqual(httpupload_xso.Put.TAG,
                         (namespaces.xep0363_http_upload, "put"))

    def test_url(self):
        self.assertIsInstance(
            httpupload_xso.Put.url,
            aioxmpp.xso.Attr,
        )
        self.assertEqual(
            httpupload_xso.Put.url.tag,
            (None, "url"),
        )
        self.assertIsInstance(
            httpupload_xso.Put.url.type_,
            aioxmpp.xso.String,
        )
        self.assertIs(httpupload_xso.Put.url.default, aioxmpp.xso.NO_DEFAULT)

    def test_headers(self):
        self.assertIsInstance(
            httpupload_xso.Put.headers,
            aioxmpp.xso.ChildValueMultiMap,
        )
        self.assertIs(
            httpupload_xso.Put.headers.type_,
            httpupload_xso.HeaderType
        )
        self.assertIs(
            httpupload_xso.Put.headers.mapping_type,
            multidict.MultiDict,
        )

    def test_parses_multiple_headers_correctly(self):
        data = (
            "<put xmlns='{}' url='foo'>"
            "<header name='Authorization'>v1</header>"
            "<header name='Expires'>v2</header>"
            "<header name='Authorization'>v3</header>"
            "</put>"
        ).format(namespaces.xep0363_http_upload)
        buf = io.BytesIO(data.encode("utf-8"))
        result = aioxmpp.xml.read_single_xso(buf, httpupload_xso.Put)

        self.assertCountEqual(
            result.headers.items(),
            [
                ("Authorization", "v1"),
                ("Expires", "v2"),
                ("Authorization", "v3"),
            ]
        )

    def test_xso_after_load_keeps_valid_headers_intact(self):
        headers = {
            "Authorization": "xyz",
            "Cookie": "xyz",
            "Expires": "xyz",
        }

        p = httpupload_xso.Put()
        p.headers.update(headers)
        p.xso_after_load()

        self.assertCountEqual(
            p.headers.items(),
            headers.items(),
        )

    def test_xso_after_load_strips_newlines(self):
        headers = {
            "Authorization": "abc\ndef",
        }

        p = httpupload_xso.Put()
        p.headers.update(headers)
        p.xso_after_load()

        self.assertCountEqual(
            p.headers.items(),
            {
                "Authorization": "abcdef",
            }.items()
        )

    def test_xso_after_load_removes_non_whitelisted_headers(self):
        headers = {
            "foo": "bar"
        }

        p = httpupload_xso.Put()
        p.headers.update(headers)
        p.xso_after_load()

        self.assertCountEqual(
            p.headers.items(),
            {}.items()
        )


class TestGet(unittest.TestCase):
    def test_is_xso(self):
        self.assertTrue(issubclass(
            httpupload_xso.Get,
            aioxmpp.xso.XSO,
        ))

    def test_tag(self):
        self.assertEqual(httpupload_xso.Get.TAG,
                         (namespaces.xep0363_http_upload, "get"))

    def test_url(self):
        self.assertIsInstance(
            httpupload_xso.Get.url,
            aioxmpp.xso.Attr,
        )
        self.assertEqual(
            httpupload_xso.Get.url.tag,
            (None, "url"),
        )
        self.assertIsInstance(
            httpupload_xso.Get.url.type_,
            aioxmpp.xso.String,
        )
        self.assertIs(httpupload_xso.Get.url.default, aioxmpp.xso.NO_DEFAULT)


class TestSlot(unittest.TestCase):
    def test_is_xso(self):
        self.assertTrue(issubclass(
            httpupload_xso.Slot,
            aioxmpp.xso.XSO,
        ))

    def test_is_iq_payload(self):
        self.assertIn(
            httpupload_xso.Slot.TAG,
            aioxmpp.IQ.CHILD_MAP,
        )

    def test_tag(self):
        self.assertEqual(httpupload_xso.Slot.TAG,
                         (namespaces.xep0363_http_upload, "slot"))

    def test_put(self):
        self.assertIsInstance(
            httpupload_xso.Slot.put,
            aioxmpp.xso.Child,
        )
        self.assertCountEqual(
            httpupload_xso.Slot.put._classes,
            [httpupload_xso.Put]
        )

    def test_get(self):
        self.assertIsInstance(
            httpupload_xso.Slot.get,
            aioxmpp.xso.Child,
        )
        self.assertCountEqual(
            httpupload_xso.Slot.get._classes,
            [httpupload_xso.Get]
        )

    def test_validate_rejects_missing_put(self):
        s = httpupload_xso.Slot()
        s.get = unittest.mock.Mock(spec=httpupload_xso.Get)

        with self.assertRaisesRegex(ValueError, r"missing PUT information"):
            s.validate()

    def test_validate_rejects_missing_get(self):
        s = httpupload_xso.Slot()
        s.put = unittest.mock.Mock(spec=httpupload_xso.Put)

        with self.assertRaisesRegex(ValueError, r"missing GET information"):
            s.validate()

    def test_validate_passes_if_both_are_present(self):
        s = httpupload_xso.Slot()
        s.get = unittest.mock.Mock(spec=httpupload_xso.Get)
        s.put = unittest.mock.Mock(spec=httpupload_xso.Put)