view 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
line wrap: on
line source

#!/usr/bin/env python3

# Libervia: an XMPP client
# Copyright (C) 2009-2023 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from twisted.words.xish import domish

from libervia.backend.plugins.plugin_xep_0320 import NS_JINGLE_DTLS, XEP_0320
from libervia.backend.tools import xml_tools


class TestXEP0320:
    def test_parse_transport_trigger(self, host):
        """<transport> element is parsed correctly in trigger"""
        xep_0320 = XEP_0320(host)

        transport_elt = xml_tools.parse(
            f"<transport><fingerprint xmlns='{NS_JINGLE_DTLS}' hash='sha-256' "
            "setup='active'>6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:FB:"
            "2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6</fingerprint></transport>"
        )

        ice_data = {}
        result = xep_0320._parse_transport_trigger(transport_elt, ice_data)

        expected_ice_data = {
            "fingerprint": {
                "hash": "sha-256",
                "setup": "active",
                "fingerprint":
                "6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:"
                "FB:2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6",
            },
        }

        assert ice_data == expected_ice_data
        assert result

    def test_build_transport(self, host):
        """<transport> element is buid correctly in trigger"""
        xep_0320 = XEP_0320(host)

        transport_elt = domish.Element((None, "transport"))

        ice_data = {
            "fingerprint": {
                "hash": "sha-256",
                "setup": "active",
                "fingerprint":
                "6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:"
                "FB:2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6",
            },
        }

        result = xep_0320._build_transport_trigger(transport_elt, ice_data)

        expected_transport_elt = xml_tools.parse(
            f"<transport><fingerprint xmlns='{NS_JINGLE_DTLS}' hash='sha-256' "
            "setup='active'>6D:8F:6A:53:A3:7E:10:B2:58:16:AB:A3:92:6F:8A:5B:2D:55:1C:FB:"
            "2F:E3:6E:94:FE:4F:4E:FE:D4:77:49:B6</fingerprint></transport>"""
        )

        assert transport_elt.toXml() == expected_transport_elt.toXml()
        assert result