libervia-backend/tests/unit/conftest.py
Goffi c5396f0acf backend: Tor integration:
- Add the `txtorcon` optional dependency, used with `tor` extra.
- Add settings for Tor.
- Use Tor endpoint when an `.onion` XMPP domain is used, of when Tor is explicitely
  enabled in conf.
- Disable WebRTC, for now it's the safer option as WebRTC can leak IP. It should be
  possible to use it over Tor by forcing the use of a .onion relay, but this is to be
  explored later (A/V should be to slow to be usable, but that stay relevant for file
  transfer or other WebRTC powered things).
- A new `treq` instance using Tor WebAgent is used when Tor is enabled. Properties has
  been added to SatXMPPEntity to conveniently get the right instance.
- Another `tor_mode` property has been added with corresponding bridge methods, to see if
  Tor is activated and in which mode for a given profile. For now there are only two modes
  (disabled, and enabled with WebRTC disabled), but in the future it may be possible to
  activate WebRTC over Tor, or to use Tor only to connect to XMPP server, while using
  clearnet for other connections.
- Tor dedicated models have been added, and bridge methods have been added to build and
  get them.
- Fix tests.

rel 473
2025-12-15 11:35:19 +01:00

107 lines
3.3 KiB
Python

#!/usr/bin/env python3
# Libervia: an XMPP client
# Copyright (C) 2009-2025 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 contextlib import contextmanager
from unittest.mock import MagicMock, AsyncMock
from pytest import fixture
from twisted.internet import defer
from twisted.words.protocols.jabber import jid
from libervia.backend import G
from wokkel.data_form import NS_X_DATA
from libervia.backend.core.main import LiberviaBackend
from libervia.backend.models.tor import TorMode
from libervia.backend.tools import async_trigger as trigger
from libervia.backend.core import xmpp
@fixture(scope="session")
def bridge():
bridge = AsyncMock()
bridge.add_signal = MagicMock()
bridge.add_method = MagicMock()
return bridge
@fixture(scope="session")
def storage():
return AsyncMock()
class MockLiberviaBackend(LiberviaBackend):
def __init__(self, bridge, storage):
G.set_host(self)
self._cb_map = {}
self._menus = {}
self._menus_paths = {}
self._test_config = {}
self.profiles = {}
self.plugins = {}
# map for short name to whole namespace,
# extended by plugins with register_namespace
self.ns_map = {
"x-data": NS_X_DATA,
"disco#info": xmpp.NS_DISCO_INFO,
}
self.memory = MagicMock()
self.memory.storage = storage
self.memory.config_get.side_effect = self.get_test_config
self.trigger = trigger.TriggerManager()
self.bridge = bridge
defer.ensureDeferred(self._post_init())
self.common_cache = AsyncMock()
self._import_plugins()
self._add_base_menus()
self.initialised = defer.Deferred()
self.initialised.callback(None)
def get_local_path(self, *args, **kwargs):
return MagicMock()
def get_test_config(self, section, name, default=None):
return self._test_config.get((section or None, name), default)
def register_namespace(self, short_name, namespace):
# Plugin classes may be instantiated several times in tests, so we do nothing in
# this method to avoid ConflictError.
pass
def _init(self):
pass
async def _post_init(self):
pass
@fixture(scope="session")
def host(bridge, storage):
host = MockLiberviaBackend(bridge=bridge, storage=storage)
return host
@fixture
def client():
client = MagicMock()
client.jid = jid.JID("test_user@test.example/123")
client.server_jid = jid.JID("test.example")
client.pubsub_service = jid.JID("pubsub.test.example")
client.pubsub_client = AsyncMock()
client.tor = None
client.tor_mode = TorMode.DISABLED
return client