annotate tests/unit/test_plugin_xep_0320.py @ 4231:e11b13418ba6

plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Implement XEP-0343: Signaling WebRTC Data Channels in Jingle. The current version of the XEP (0.3.1) has no implementation and contains some flaws. After discussing this on xsf@, Daniel (from Conversations) mentioned that they had a sprint with Larma (from Dino) to work on another version and provided me with this link: https://gist.github.com/iNPUTmice/6c56f3e948cca517c5fb129016d99e74 . I have used it for my implementation. This implementation reuses work done on Jingle A/V call (notably XEP-0176 and XEP-0167 plugins), with adaptations. When used, XEP-0234 will not handle the file itself as it normally does. This is because WebRTC has several implementations (browser for web interface, GStreamer for others), and file/data must be handled directly by the frontend. This is particularly important for web frontends, as the file is not sent from the backend but from the end-user's browser device. Among the changes, there are: - XEP-0343 implementation. - `file_send` bridge method now use serialised dict as output. - New `BaseTransportHandler.is_usable` method which get content data and returns a boolean (default to `True`) to tell if this transport can actually be used in this context (when we are initiator). Used in webRTC case to see if call data are available. - Support of `application` media type, and everything necessary to handle data channels. - Better confirmation message, with file name, size and description when available. - When file is accepted in preflight, it is specified in following `action_new` signal for actual file transfer. This way, frontend can avoid the display or 2 confirmation messages. - XEP-0166: when not specified, default `content` name is now its index number instead of a UUID. This follows the behaviour of browsers. - XEP-0353: better handling of events such as call taken by another device. - various other updates. rel 441
author Goffi <goffi@goffi.org>
date Sat, 06 Apr 2024 12:57:23 +0200
parents 4b842c1fb686
children f1d0cde61af7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4049
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/env python3
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
2
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 # Libervia: an XMPP client
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # Copyright (C) 2009-2023 Jérôme Poisson (goffi@goffi.org)
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
5
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
6 # This program is free software: you can redistribute it and/or modify
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # it under the terms of the GNU Affero General Public License as published by
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # the Free Software Foundation, either version 3 of the License, or
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # (at your option) any later version.
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
10
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
11 # This program is distributed in the hope that it will be useful,
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # GNU Affero General Public License for more details.
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
18
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 from twisted.words.xish import domish
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
20
4071
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4049
diff changeset
21 from libervia.backend.plugins.plugin_xep_0320 import NS_JINGLE_DTLS, XEP_0320
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4049
diff changeset
22 from libervia.backend.tools import xml_tools
4049
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
23
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
24
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
25 class TestXEP0320:
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
26 def test_parse_transport_trigger(self, host):
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
27 """<transport> element is parsed correctly in trigger"""
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
28 xep_0320 = XEP_0320(host)
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
29
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
30 transport_elt = xml_tools.parse(
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 f"<transport><fingerprint xmlns='{NS_JINGLE_DTLS}' hash='sha-256' "
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
32 "setup='active'>6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:FB:"
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
33 "2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6</fingerprint></transport>"
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 )
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
35
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
36 ice_data = {}
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
37 result = xep_0320._parse_transport_trigger(transport_elt, ice_data)
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
38
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 expected_ice_data = {
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 "fingerprint": {
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 "hash": "sha-256",
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 "setup": "active",
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
43 "fingerprint":
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
44 "6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:"
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
45 "FB:2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6",
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
46 },
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
47 }
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
48
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 assert ice_data == expected_ice_data
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
50 assert result
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
51
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
52 def test_build_transport(self, host):
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
53 """<transport> element is buid correctly in trigger"""
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
54 xep_0320 = XEP_0320(host)
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
55
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
56 transport_elt = domish.Element((None, "transport"))
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
57
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
58 ice_data = {
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
59 "fingerprint": {
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
60 "hash": "sha-256",
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
61 "setup": "active",
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
62 "fingerprint":
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
63 "6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:"
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
64 "FB:2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6",
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
65 },
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
66 }
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
67
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
68 result = xep_0320._build_transport_trigger(transport_elt, ice_data)
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
69
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
70 expected_transport_elt = xml_tools.parse(
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
71 f"<transport><fingerprint xmlns='{NS_JINGLE_DTLS}' hash='sha-256' "
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
72 "setup='active'>6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:FB:"
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
73 "2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6</fingerprint></transport>"""
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
74 )
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
75
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
76 assert transport_elt.toXml() == expected_transport_elt.toXml()
b56bf0c6c064 tests (unit): XEP-0320 tests:
Goffi <goffi@goffi.org>
parents:
diff changeset
77 assert result